<?php
/**
 * Ideogram AI Class
 *
 * @package Page_Generator_Pro
 * @author WP Zinc
 */

/**
 * Ideogram AI Integration
 *
 * @package Page_Generator_Pro
 * @author  WP Zinc
 * @version 5.0.3
 */
class Page_Generator_Pro_Ideogram_AI extends Page_Generator_Pro_API {

	use Page_Generator_Pro_AI_Trait;
	use Page_Generator_Pro_Integration_Trait;
	use Page_Generator_Pro_Featured_Image_Trait;
	use Page_Generator_Pro_Shortcode_Image_Trait;

	/**
	 * Holds the base object.
	 *
	 * @since   5.0.3
	 *
	 * @var     object
	 */
	public $base;

	/**
	 * Holds the programmatic name of this integration.
	 *
	 * @since   5.0.3
	 *
	 * @var     string
	 */
	public $name = 'ideogram-ai';

	/**
	 * Holds the API endpoint
	 *
	 * @since   5.0.3
	 *
	 * @var     string
	 */
	public $api_endpoint = 'https://api.ideogram.ai';

	/**
	 * Holds the account URL where users can obtain their API key
	 *
	 * @since   5.0.3
	 *
	 * @var     string
	 */
	public $account_url = 'https://ideogram.ai/manage-api';

	/**
	 * Holds the referal URL to use for users wanting to sign up
	 * to the API service.
	 *
	 * @since   5.0.3
	 *
	 * @var     string
	 */
	public $referral_url = 'https://ideogram.ai/login';

	/**
	 * Holds the URL to the model documentation
	 *
	 * @since   5.1.2
	 *
	 * @var     string
	 */
	public $model_documentation_url = 'https://docs.ideogram.ai/using-ideogram/ideogram-features/available-models';

	/**
	 * Constructor
	 *
	 * @since   5.0.3
	 *
	 * @param   object $base    Base Plugin Class.
	 */
	public function __construct( $base ) {

		// Store base class.
		$this->base = $base;

		// Don't display the copy option on the Dynamic Element, as all images are stored
		// in the Media Library.
		$this->shortcode_supports_output_copy = false;

		// Register Settings Fields.
		add_filter( 'page_generator_pro_integrations_get', array( $this, 'register_integration' ) );
		add_filter( 'page_generator_pro_integrations_get_settings_fields', array( $this, 'ai_settings_fields' ) );

		// Register as a Dynamic Element.
		add_filter( 'page_generator_pro_shortcode_add_shortcodes', array( $this, 'add_shortcode' ) );

		// Register as a Featured Image source.
		add_filter( 'page_generator_pro_common_get_featured_image_sources', array( $this, 'add_featured_image_source' ) );
		add_filter( 'page_generator_pro_groups_get_defaults', array( $this, 'get_featured_image_default_values' ) );
		add_filter( 'page_generator_pro_common_get_featured_image_fields', array( $this, 'get_featured_image_fields' ), 10, 2 );
		add_filter( 'page_generator_pro_common_get_featured_image_tabs', array( $this, 'get_featured_image_tabs' ) );
		add_filter( 'page_generator_pro_generate_featured_image_' . $this->name, array( $this, 'get_featured_image' ), 10, 6 );

	}

	/**
	 * Returns this shortcode / block's title.
	 *
	 * @since   5.0.3
	 *
	 * @return  string
	 */
	public function get_title() {

		return __( 'Ideogram AI Image', 'page-generator-pro' );

	}

	/**
	 * Returns provider-specific fields for the Search Parameters section across
	 * the Dynamic Element and Featured Image.
	 *
	 * @since   5.0.3
	 *
	 * @param   bool $is_featured_image Fields are for Featured Image functionality.
	 * @return  array
	 */
	public function get_provider_search_fields( $is_featured_image = false ) {

		// Don't populate fields for performance if the request is for the frontend web site.
		// Populate fields for admin and CLI requests so that Generate via Browser and CLI
		// will see fields for this shortcode, which is required for correct operation with e.g. Elementor
		// registered shortcodes/elements.
		if ( ! $this->base->is_admin_or_frontend_editor() && ! $this->base->is_cli() && ! $this->base->is_cron() ) {
			return array();
		}

		$prefix_key = ( $is_featured_image ? $this->get_settings_prefix() . '_' : '' );

		// Return fields.
		return array(
			$prefix_key . 'topic'         => array(
				'label'         => __( 'Topic', 'page-generator-pro' ),
				'type'          => 'autocomplete_textarea',
				'values'        => $this->keywords,
				'placeholder'   => __( 'e.g. a person performing {service}', 'page-generator-pro' ),
				'default_value' => $this->get_default_value( 'topic' ),
				'description'   => __( 'Enter the prompt for the image.  For example, "plumber fixing a sink" or "a person performing {service}".', 'page-generator-pro' ),
			),
			$prefix_key . 'style'         => array(
				'label'         => __( 'Image Style', 'page-generator-pro' ),
				'type'          => 'select',
				'values'        => array(
					'RENDER_3D' => __( '3D Render', 'page-generator-pro' ),
					'ANIME'     => __( 'Anime', 'page-generator-pro' ),
					'AUTO'      => __( 'Auto', 'page-generator-pro' ),
					'DESIGN'    => __( 'Design', 'page-generator-pro' ),
					'GENERAL'   => __( 'General', 'page-generator-pro' ),
					'REALISTIC' => __( 'Realistic', 'page-generator-pro' ),
				),
				'default_value' => $this->get_default_value( 'style' ),
				'description'   => __( 'The image style to generate.', 'page-generator-pro' ),
			),
			$prefix_key . 'generate_size' => array(
				'label'         => __( 'Image Size', 'page-generator-pro' ),
				'type'          => 'select',
				'values'        => $this->get_image_sizes(),
				'default_value' => $this->get_default_value( 'generate_size' ),
				'description'   => __( 'The image size to generate.', 'page-generator-pro' ),
			),
		);

	}

	/**
	 * Returns provider-specific fields for the Output section across
	 * the Dynamic Element and Featured Image.
	 *
	 * @since   4.8.0
	 *
	 * @param   bool $is_featured_image Fields are for Featured Image functionality.
	 * @return  array
	 */
	public function get_provider_output_fields( $is_featured_image = false ) {

		$prefix_key = ( $is_featured_image ? $this->get_settings_prefix() . '_' : '' );

		return array();

	}

	/**
	 * Returns provider-specific attributes for the Dynamic Element.
	 *
	 * These are not used for Featured Images.
	 *
	 * @since   4.8.0
	 *
	 * @return  array
	 */
	public function get_provider_attributes() {

		return array(
			'topic'         => array(
				'type'    => 'string',
				'default' => $this->get_default_value( 'topic' ),
			),
			'style'         => array(
				'type'    => 'string',
				'default' => ( ! $this->get_default_value( 'style' ) ? '' : $this->get_default_value( 'style' ) ),
			),
			'generate_size' => array(
				'type'    => 'string',
				'default' => $this->get_default_value( 'generate_size' ),
			),
		);

	}

	/**
	 * Returns provider-specific default values across the Dynamic Element and Featured Image.
	 *
	 * @since   5.0.3
	 *
	 * @param   bool $is_featured_image Fields are for Featured Image functionality.
	 * @return  array
	 */
	public function get_provider_default_values( $is_featured_image = false ) {

		// We deliberately don't use this, for backward compat. for Featured Images, which don't prefix.
		$prefix_key = ( $is_featured_image ? $this->get_settings_prefix() . '_' : '' );

		return array(
			$prefix_key . 'topic'         => '',
			$prefix_key . 'style'         => 'REALISTIC',
			$prefix_key . 'generate_size' => 'RESOLUTION_1024_768',
		);

	}

	/**
	 * Returns this shortcode / block's description.
	 *
	 * @since   5.0.3
	 *
	 * @return string
	 */
	public function get_description() {

		return __( 'Generates an image using Ideogram.ai.', 'page-generator-pro' );

	}

	/**
	 * Returns this shortcode / block's icon.
	 *
	 * @since   5.0.3
	 *
	 * @return  string
	 */
	public function get_icon() {

		return 'assets/images/icons/ideogram-ai.svg';

	}

	/**
	 * Returns an array of supported models for Ideogram.
	 *
	 * @since   5.0.3
	 *
	 * @return  array
	 */
	public function get_models() {

		return array(
			'V_1'        => 'Version 1',
			'V_1_TURBO'  => 'Version 1 Turbo',
			'V_2'        => 'Version 2',
			'V_2_TURBO'  => 'Version 2 Turbo',
			'V_2A'       => 'Version 2A',
			'V_2A_TURBO' => 'Version 2A Turbo',
		);

	}

	/**
	 * Returns this shortcode / block's output
	 *
	 * @since   5.0.3
	 *
	 * @param  array $atts   Shortcode Attributes.
	 * @return string          Output
	 */
	public function render( $atts ) {

		// Parse attributes.
		$atts = $this->parse_atts( $atts );

		// Bail if Ideogram is not configured.
		if ( empty( $this->base->get_class( 'settings' )->get_setting( $this->base->plugin->name . '-research', $this->get_settings_prefix() . '_api_key' ) ) ) {
			return $this->add_dynamic_element_error_and_return(
				new WP_Error(
					'page_generator_pro_ideogram_ai_image_error',
					__( 'Ideogram: No API key is defined at Settings > Integrations', 'page-generator-pro' )
				),
				$atts
			);
		}

		// Send request to Ideogram.
		$result = $this->create_image(
			$atts['topic'],
			$atts['style'],
			$atts['generate_size']
		);

		// Handle errors.
		if ( is_wp_error( $result ) ) {
			return $this->add_dynamic_element_error_and_return( $result, $atts );
		}

		// Store image in Media Library.
		$image    = array(
			'url'   => $result->data[0]->url,
			'title' => $atts['title'],
		);
		$image_id = $this->import( $image, $atts );

		// Bail if an error occured.
		if ( is_wp_error( $image_id ) ) {
			return $this->add_dynamic_element_error_and_return( $image_id, $atts );
		}

		// Get HTML image tag, with the image matching the given WordPress registered image size.
		$html = $this->get_image_html( $image_id, $atts, $image );

		/**
		 * Filter the Ideogram HTML output, before returning.
		 *
		 * @since   5.0.3
		 *
		 * @param   string      $html       HTML Output.
		 * @param   array       $atts       Shortcode Attributes.
		 * @param   bool|int    $image_id   WordPress Media Library Image ID.
		 * @param   stdClass    $result     Ideogram Image Result.
		 */
		$html = apply_filters( 'page_generator_pro_shortcode_ideogram_image', $html, $atts, $image_id, $result );

		// Return.
		return $html;

	}

	/**
	 * Defines the Featured Image for the given generated Post ID, if
	 * the Group Settings specify a Featured Image.
	 *
	 * @since   5.0.3
	 *
	 * @param   bool|int $image_id   Image ID.
	 * @param   int      $post_id    Generated Post ID.
	 * @param   int      $group_id   Group ID.
	 * @param   int      $index      Generation Index.
	 * @param   array    $settings   Group Settings.
	 * @param   array    $post_args  wp_insert_post() / wp_update_post() arguments.
	 * @return  WP_Error|bool|int
	 */
	public function get_featured_image( $image_id, $post_id, $group_id, $index, $settings, $post_args ) {

		// Bail if no Featured Image Term specified.
		if ( empty( $settings[ 'featured_image_' . $this->get_settings_prefix() . '_topic' ] ) ) {
			return new WP_Error( 'page_generator_pro_generate_featured_image', __( 'Featured Image: Ideogram: No Term was specified.', 'page-generator-pro' ) );
		}

		// Bail if Ideogram is not configured.
		if ( empty( $this->base->get_class( 'settings' )->get_setting( $this->base->plugin->name . '-research', $this->get_settings_prefix() . '_api_key' ) ) ) {
			return new WP_Error( 'page_generator_pro_generate_featured_image', __( 'Featured Image: Ideogram: No API Key is defined at Settings > Integrations.', 'page-generator-pro' ) );
		}

		// Send request to Ideogram.
		$result = $this->create_image(
			$settings[ 'featured_image_' . $this->get_settings_prefix() . '_topic' ],
			$settings[ 'featured_image_' . $this->get_settings_prefix() . '_style' ],
			$settings[ 'featured_image_' . $this->get_settings_prefix() . '_generate_size' ]
		);

		// Bail if an error occured.
		if ( is_wp_error( $result ) ) {
			return $result;
		}

		// Import Image into the Media Library.
		return $this->import_remote_image(
			$result->data[0]->url,
			$post_id,
			$group_id,
			$index,
			$settings['featured_image_filename'],
			$settings['featured_image_title'],
			$settings['featured_image_caption'],
			$settings['featured_image_alt_tag'],
			$settings['featured_image_description']
		);

	}

	/**
	 * Returns an array of supported image sizes.
	 *
	 * @since   5.0.3
	 *
	 * @return  array
	 */
	private function get_image_sizes() {

		return array(
			'RESOLUTION_512_1536'  => '512 x 1536',
			'RESOLUTION_576_1408'  => '576 x 1408',
			'RESOLUTION_576_1472'  => '576 x 1472',
			'RESOLUTION_576_1536'  => '576 x 1536',
			'RESOLUTION_640_1024'  => '640 x 1024',
			'RESOLUTION_640_1344'  => '640 x 1344',
			'RESOLUTION_640_1408'  => '640 x 1408',
			'RESOLUTION_640_1472'  => '640 x 1472',
			'RESOLUTION_640_1536'  => '640 x 1536',
			'RESOLUTION_704_1152'  => '704 x 1152',
			'RESOLUTION_704_1216'  => '704 x 1216',
			'RESOLUTION_704_1280'  => '704 x 1280',
			'RESOLUTION_704_1344'  => '704 x 1344',
			'RESOLUTION_704_1408'  => '704 x 1408',
			'RESOLUTION_704_1472'  => '704 x 1472',
			'RESOLUTION_720_1280'  => '720 x 1280',
			'RESOLUTION_736_1312'  => '736 x 1312',
			'RESOLUTION_768_1024'  => '768 x 1024',
			'RESOLUTION_768_1088'  => '768 x 1088',
			'RESOLUTION_768_1152'  => '768 x 1152',
			'RESOLUTION_768_1216'  => '768 x 1216',
			'RESOLUTION_768_1232'  => '768 x 1232',
			'RESOLUTION_768_1280'  => '768 x 1280',
			'RESOLUTION_768_1344'  => '768 x 1344',
			'RESOLUTION_832_960'   => '832 x 960',
			'RESOLUTION_832_1024'  => '832 x 1024',
			'RESOLUTION_832_1088'  => '832 x 1088',
			'RESOLUTION_832_1152'  => '832 x 1152',
			'RESOLUTION_832_1216'  => '832 x 1216',
			'RESOLUTION_832_1248'  => '832 x 1248',
			'RESOLUTION_864_1152'  => '864 x 1152',
			'RESOLUTION_896_960'   => '896 x 960',
			'RESOLUTION_896_1024'  => '896 x 1024',
			'RESOLUTION_896_1088'  => '896 x 1088',
			'RESOLUTION_896_1120'  => '896 x 1120',
			'RESOLUTION_896_1152'  => '896 x 1152',
			'RESOLUTION_960_832'   => '960 x 832',
			'RESOLUTION_960_896'   => '960 x 896',
			'RESOLUTION_960_1024'  => '960 x 1024',
			'RESOLUTION_960_1088'  => '960 x 1088',
			'RESOLUTION_1024_640'  => '1024 x 640',
			'RESOLUTION_1024_768'  => '1024 x 768',
			'RESOLUTION_1024_832'  => '1024 x 832',
			'RESOLUTION_1024_896'  => '1024 x 896',
			'RESOLUTION_1024_960'  => '1024 x 960',
			'RESOLUTION_1024_1024' => '1024 x 1024',
			'RESOLUTION_1088_768'  => '1088 x 768',
			'RESOLUTION_1088_832'  => '1088 x 832',
			'RESOLUTION_1088_896'  => '1088 x 896',
			'RESOLUTION_1088_960'  => '1088 x 960',
			'RESOLUTION_1120_896'  => '1120 x 896',
			'RESOLUTION_1152_704'  => '1152 x 704',
			'RESOLUTION_1152_768'  => '1152 x 768',
			'RESOLUTION_1152_832'  => '1152 x 832',
			'RESOLUTION_1152_864'  => '1152 x 864',
			'RESOLUTION_1152_896'  => '1152 x 896',
			'RESOLUTION_1216_704'  => '1216 x 704',
			'RESOLUTION_1216_768'  => '1216 x 768',
			'RESOLUTION_1216_832'  => '1216 x 832',
			'RESOLUTION_1232_768'  => '1232 x 768',
			'RESOLUTION_1248_832'  => '1248 x 832',
			'RESOLUTION_1280_704'  => '1280 x 704',
			'RESOLUTION_1280_720'  => '1280 x 720',
			'RESOLUTION_1280_768'  => '1280 x 768',
			'RESOLUTION_1280_800'  => '1280 x 800',
			'RESOLUTION_1312_736'  => '1312 x 736',
			'RESOLUTION_1344_640'  => '1344 x 640',
			'RESOLUTION_1344_704'  => '1344 x 704',
			'RESOLUTION_1344_768'  => '1344 x 768',
			'RESOLUTION_1408_576'  => '1408 x 576',
			'RESOLUTION_1408_640'  => '1408 x 640',
			'RESOLUTION_1408_704'  => '1408 x 704',
			'RESOLUTION_1472_576'  => '1472 x 576',
			'RESOLUTION_1472_640'  => '1472 x 640',
			'RESOLUTION_1472_704'  => '1472 x 704',
			'RESOLUTION_1536_512'  => '1536 x 512',
			'RESOLUTION_1536_576'  => '1536 x 576',
			'RESOLUTION_1536_640'  => '1536 x 640',
		);

	}

	/**
	 * Submits a new image request for the given prompt.
	 *
	 * @since   5.0.3
	 *
	 * @param   string $prompt        Prompt.
	 * @param   string $style         Image style (vivid,natural).
	 * @param   string $size          Image size ('256x256', '512x512', '1024x1024', '1024x1792', '1792x1024').
	 * @param   int    $limit         Number of images to generate.
	 * @param   string $model         Model to use.
	 * @return  WP_Error|string
	 */
	public function create_image( $prompt, $style = 'vivid', $size = '1024x1024', $limit = 1, $model = 'V_2A_TURBO' ) {

		// Fetch prompt.
		$prompt_text = $this->get_prompt(
			array(
				'license_key'  => $this->base->licensing->get_license_key(),
				'prompt'       => $prompt,
				'content_type' => 'image',
				'limit'        => $limit,
				'model'        => $model,
			)
		);

		// If an error occured, return it now.
		if ( is_wp_error( $prompt_text ) ) {
			return $prompt_text;
		}

		// Set Headers.
		$this->set_headers(
			array(
				'Api-Key'      => $this->base->get_class( 'settings' )->get_setting( $this->base->plugin->name . '-research', $this->get_settings_prefix() . '_api_key' ),
				'Content-Type' => 'application/json',
			)
		);

		// Send request to Ideogram.
		return $this->response(
			$this->post(
				'generate',
				array(
					'image_request' => array(
						'prompt'     => $prompt_text,
						'model'      => $model,
						'style_type' => $style,
						'num_images' => $limit,
						'resolution' => $size,
					),
				)
			)
		);

	}

}
