insideout10 / wordlift-plugin

src/includes/class-wordlift-post-to-jsonld-converter.php

Indentation +428 added lines, -428 removed lines

@@ -18,452 +18,452 @@
  */
 class Wordlift_Post_To_Jsonld_Converter extends Wordlift_Abstract_Post_To_Jsonld_Converter {
 
-	/**
-	 * @var Wordlift_Post_To_Jsonld_Converter
-	 */
-	private static $instance;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * @var false
-	 */
-	private $disable_convert_filters;
-
-	/**
-	 * Wordlift_Post_To_Jsonld_Converter constructor.
-	 *
-	 * @param Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 * @param Wordlift_User_Service        $user_service A {@link Wordlift_User_Service} instance.
-	 * @param Wordlift_Attachment_Service  $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since 3.10.0
-	 */
-	public function __construct( $entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false ) {
-		parent::__construct( $entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create() );
-		$this->disable_convert_filters = $disable_convert_filters;
-		// Set a reference to the logger.
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
-
-		self::$instance = $this;
-
-	}
-
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	public function new_instance_with_filters_disabled() {
-		return new static( $this->entity_type_service, $this->user_service, $this->attachment_service, true );
-	}
-
-	/**
-	 * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
-	 * found while processing the post is set in the $references array.
-	 *
-	 * @param int              $post_id The post id.
-	 * @param array<Reference> $references An array of entity references.
-	 * @param array            $references_infos
-	 *
-	 * @return array A JSON-LD array.
-	 * @since 3.10.0
-	 */
-	public function convert( $post_id, &$references = array(), &$references_infos = array(), $relations = null ) {
-
-		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
-			// Post not found.
-			return null;
-		}
-
-		// Get the base JSON-LD and the list of entities referenced by this entity.
-		$jsonld = parent::convert( $post_id, $references, $references_infos, $relations );
-
-		// Set WebPage by default.
-		if ( empty( $jsonld['@type'] ) ) {
-			$jsonld['@type'] = 'WebPage';
-		}
-
-		// Get the entity name.
-		$jsonld['headline'] = $post->post_title;
-
-		$custom_fields = $this->entity_type_service->get_custom_fields_for_post( $post_id );
-
-		if ( isset( $custom_fields ) ) {
-			$this->process_type_custom_fields( $jsonld, $custom_fields, $post, $references, $references_infos );
-		}
-
-		// Set the published and modified dates.
-		/*
+    /**
+     * @var Wordlift_Post_To_Jsonld_Converter
+     */
+    private static $instance;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * @var false
+     */
+    private $disable_convert_filters;
+
+    /**
+     * Wordlift_Post_To_Jsonld_Converter constructor.
+     *
+     * @param Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     * @param Wordlift_User_Service        $user_service A {@link Wordlift_User_Service} instance.
+     * @param Wordlift_Attachment_Service  $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since 3.10.0
+     */
+    public function __construct( $entity_type_service, $user_service, $attachment_service, $disable_convert_filters = false ) {
+        parent::__construct( $entity_type_service, $user_service, $attachment_service, Wordlift_Property_Getter_Factory::create() );
+        $this->disable_convert_filters = $disable_convert_filters;
+        // Set a reference to the logger.
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
+
+        self::$instance = $this;
+
+    }
+
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    public function new_instance_with_filters_disabled() {
+        return new static( $this->entity_type_service, $this->user_service, $this->attachment_service, true );
+    }
+
+    /**
+     * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
+     * found while processing the post is set in the $references array.
+     *
+     * @param int              $post_id The post id.
+     * @param array<Reference> $references An array of entity references.
+     * @param array            $references_infos
+     *
+     * @return array A JSON-LD array.
+     * @since 3.10.0
+     */
+    public function convert( $post_id, &$references = array(), &$references_infos = array(), $relations = null ) {
+
+        // Get the post instance.
+        $post = get_post( $post_id );
+        if ( null === $post ) {
+            // Post not found.
+            return null;
+        }
+
+        // Get the base JSON-LD and the list of entities referenced by this entity.
+        $jsonld = parent::convert( $post_id, $references, $references_infos, $relations );
+
+        // Set WebPage by default.
+        if ( empty( $jsonld['@type'] ) ) {
+            $jsonld['@type'] = 'WebPage';
+        }
+
+        // Get the entity name.
+        $jsonld['headline'] = $post->post_title;
+
+        $custom_fields = $this->entity_type_service->get_custom_fields_for_post( $post_id );
+
+        if ( isset( $custom_fields ) ) {
+            $this->process_type_custom_fields( $jsonld, $custom_fields, $post, $references, $references_infos );
+        }
+
+        // Set the published and modified dates.
+        /*
 		 * Set the `datePublished` and `dateModified` using the local timezone.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/887
 		 *
 		 * @since 3.20.0
 		 */
-		try {
-			$default_timezone = date_default_timezone_get();
-			$timezone         = get_option( 'timezone_string' );
-			if ( ! empty( $timezone ) ) {
-				date_default_timezone_set( $timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
-				date_default_timezone_set( $default_timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
-			} else {
-				$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-				$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
-			}
-		} catch ( Exception $e ) {
-			$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-			$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
-		}
-
-		// Get the word count for the post.
-		/*
+        try {
+            $default_timezone = date_default_timezone_get();
+            $timezone         = get_option( 'timezone_string' );
+            if ( ! empty( $timezone ) ) {
+                date_default_timezone_set( $timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+                $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
+                $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
+                date_default_timezone_set( $default_timezone ); //phpcs:ignore WordPress.DateTime.RestrictedFunctions.timezone_change_date_default_timezone_set
+            } else {
+                $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
+                $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+            }
+        } catch ( Exception $e ) {
+            $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
+            $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+        }
+
+        // Get the word count for the post.
+        /*
 		 * Do not display the `wordCount` on a `WebPage`.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/888
 		 *
 		 * @since 3.20.0
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter        = new Wordlift_Post_Adapter( $post_id );
-			$jsonld['wordCount'] = $post_adapter->word_count();
-		}
+        if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
+            $post_adapter        = new Wordlift_Post_Adapter( $post_id );
+            $jsonld['wordCount'] = $post_adapter->word_count();
+        }
 
-		/*
+        /*
 		 * Add keywords, articleSection, commentCount and inLanguage properties to `Article` JSON-LD
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/1140
 		 *
 		 * @since 3.27.2
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter    = new Wordlift_Post_Adapter( $post_id );
-			$keywords        = $post_adapter->keywords();
-			$article_section = $post_adapter->article_section();
-			$comment_count   = $post_adapter->comment_count();
-			$locale          = $post_adapter->locale();
-
-			if ( isset( $keywords ) ) {
-				$jsonld['keywords'] = $keywords;
-			}
-			if ( ! empty( $article_section ) ) {
-				$jsonld['articleSection'] = $article_section;
-			}
-			$jsonld['commentCount'] = $comment_count;
-			$jsonld['inLanguage']   = $locale;
-		}
-
-		// Set the publisher.
-		$this->set_publisher( $jsonld );
-
-		/**
-		 * Call the `wl_post_jsonld_author` filter.
-		 *
-		 * This filter checks if there are co-authors or a single author and
-		 * returns a JSON-LD fragment for the author(s).
-		 *
-		 * @param array $value {
-		 *
-		 * @type array $jsonld The JSON-LD structure.
-		 * @type int[] $references An array of post IDs.
-		 * }
-		 *
-		 * @param int $post_id The {@link WP_Post} `id`.
-		 *
-		 * @since 3.51.4
-		 *
-		 * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
-		 */
-		$ret_val = apply_filters(
-			'wl_jsonld_author',
-			array(
-				'author'     => $this->get_author( $post->post_author, $references ),
-				'references' => $references,
-			),
-			$post_id
-		);
-
-		// Set the values returned by the filter.
-		$jsonld['author'] = $ret_val['author'];
-		$references       = $ret_val['references'];
-
-		// Return the JSON-LD if filters are disabled by the client.
-		if ( $this->disable_convert_filters ) {
-			return $jsonld;
-		}
-
-		/**
-		 * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
-		 *
-		 * @param array $value {
-		 *
-		 * @type array $jsonld The JSON-LD structure.
-		 * @type int[] $references An array of post IDs.
-		 * @type Relations $relations A set of `Relation`s.
-		 * }
-		 * @since 3.25.0
-		 * @since 3.43.0 The filter provides a `Relations` instance.
-		 *
-		 * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
-		 *
-		 * @api
-		 */
-		$ret_val = apply_filters(
-			'wl_post_jsonld_array',
-			array(
-				'jsonld'           => $jsonld,
-				'references'       => $references, // This one is only an array of post IDs.
-				'references_infos' => $references_infos,
-				'relations'        => $relations,
-			),
-			$post_id
-		);
-
-		$jsonld     = $ret_val['jsonld'];
-		$references = $ret_val['references'];
-
-		/**
-		 * Call the `wl_post_jsonld` filter.
-		 *
-		 * @param array $jsonld The JSON-LD structure.
-		 * @param int $post_id The {@link WP_Post} `id`.
-		 * @param array $references The array of referenced entities.
-		 *
-		 * @since 3.14.0
-		 *
-		 * @api
-		 */
-		return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
-	}
-
-	/**
-	 * Get the author's JSON-LD fragment.
-	 *
-	 * The JSON-LD fragment is generated using the {@link WP_User}'s data or
-	 * the referenced entity if configured for the {@link WP_User}.
-	 *
-	 * @param int   $author_id The author {@link WP_User}'s `id`.
-	 * @param array $references An array of referenced entities.
-	 *
-	 * @return string|array A JSON-LD structure.
-	 * @since 3.14.0
-	 */
-	public function get_author( $author_id, &$references ) {
-
-		// Get the entity bound to this user.
-		$entity_id = $this->user_service->get_entity( $author_id );
-
-		// If there's no entity bound return a simple author structure.
-		if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
-
-			$author            = get_the_author_meta( 'display_name', $author_id );
-			$author_first_name = get_the_author_meta( 'first_name', $author_id );
-			$author_last_name  = get_the_author_meta( 'last_name', $author_id );
-			$author_uri        = $this->user_service->get_uri( $author_id );
-
-			return array(
-				'@type'      => 'Person',
-				'@id'        => $author_uri,
-				'name'       => $author,
-				'givenName'  => $author_first_name,
-				'familyName' => $author_last_name,
-				'url'        => get_author_posts_url( $author_id ),
-			);
-		}
-
-		// Add the author to the references.
-		$author_uri   = Wordlift_Entity_Service::get_instance()->get_uri( $entity_id );
-		$references[] = $entity_id;
-
-		// Return the JSON-LD for the referenced entity.
-		return array(
-			'@id' => $author_uri,
-		);
-	}
-
-	/**
-	 * Enrich the provided params array with publisher data, if available.
-	 *
-	 * @param array $params The parameters array.
-	 *
-	 * @since 3.10.0
-	 */
-	protected function set_publisher( &$params ) {
-
-		// If the publisher id isn't set don't do anything.
-		$publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
-		if ( empty( $publisher_id ) ) {
-			return;
-		}
-
-		// Get the post instance.
-		$post = get_post( $publisher_id );
-		if ( ! is_a( $post, '\WP_Post' ) ) {
-			// Publisher not found.
-			return;
-		}
-
-		// Get the item id.
-		$id = Wordlift_Entity_Service::get_instance()->get_uri( $publisher_id );
-
-		// Get the type.
-		$type = $this->entity_type_service->get( $publisher_id );
-
-		// Get the name.
-		$name = $post->post_title;
-
-		// Set the publisher data.
-		$params['publisher'] = array(
-			'@type' => $this->relative_to_context( $type['uri'] ),
-			'@id'   => $id,
-			'name'  => $name,
-		);
-
-		// Add the sameAs values associated with the publisher.
-		$storage_factory = Wordlift_Storage_Factory::get_instance();
-		$sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
-		if ( ! empty( $sameas ) ) {
-			$params['publisher']['sameAs'] = $sameas;
-		}
-
-		// Set the logo, only for http://schema.org/Organization as Person doesn't
-		// support the logo property.
-		//
-		// See http://schema.org/logo.
-		if ( 1 !== preg_match( '~Organization$~', $type['uri'] ) ) {
-			return;
-		}
-
-		// Get the publisher logo.
-		$publisher_logo = $this->get_publisher_logo( $post->ID );
-
-		// Bail out if the publisher logo isn't set.
-		if ( false === $publisher_logo ) {
-			return;
-		}
-
-		// Copy over some useful properties.
-		//
-		// See https://developers.google.com/search/docs/data-types/articles.
-		$params['publisher']['logo']['@type'] = 'ImageObject';
-		$params['publisher']['logo']['url']   = $publisher_logo['url'];
-
-		// If you specify a "width" or "height" value you should leave out
-		// 'px'. For example: "width":"4608px" should be "width":"4608".
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		$params['publisher']['logo']['width']  = $publisher_logo['width'];
-		$params['publisher']['logo']['height'] = $publisher_logo['height'];
-
-	}
-
-	/**
-	 * Get the publisher logo structure.
-	 *
-	 * The function returns false when the publisher logo cannot be determined, i.e.:
-	 *  - the post has no featured image.
-	 *  - the featured image has no file.
-	 *  - a wp_image_editor instance cannot be instantiated on the original file or on the publisher logo file.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|false Returns an array with the `url`, `width` and `height` for the publisher logo or false in case
-	 *  of errors.
-	 * @since 3.19.2
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
-	 */
-	private function get_publisher_logo( $post_id ) {
-
-		// Get the featured image for the post.
-		$thumbnail_id = get_post_thumbnail_id( $post_id );
-
-		// Bail out if thumbnail not available.
-		if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
-			$this->log->info( "Featured image not set for post $post_id." );
-
-			return false;
-		}
-
-		// Get the uploads base URL.
-		$uploads_dir = wp_upload_dir();
-
-		// Get the attachment metadata.
-		$metadata = wp_get_attachment_metadata( $thumbnail_id );
-
-		// Bail out if the file isn't set.
-		if ( ! isset( $metadata['file'] ) ) {
-			$this->log->warn( "Featured image file not found for post $post_id." );
-
-			return false;
-		}
-
-		// Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
-		$path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
-
-		// Use image src, if local file does not exist. @see https://github.com/insideout10/wordlift-plugin/issues/1149
-		if ( ! file_exists( $path ) ) {
-			$this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
-
-			$attachment_image_src = wp_get_attachment_image_src( $thumbnail_id, '' );
-			if ( $attachment_image_src ) {
-				return array(
-					'url'    => $attachment_image_src[0],
-					'width'  => $attachment_image_src[1],
-					'height' => $attachment_image_src[2],
-				);
-			}
-
-			// Bail out if we cant fetch wp_get_attachment_image_src
-			return false;
-
-		}
-
-		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$original_file_editor = wp_get_image_editor( $path );
-		if ( is_wp_error( $original_file_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
-
-			return false;
-		}
-
-		// Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
-		// and we don't actually know the end values.
-		$publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
-
-		// If the file doesn't exist yet, create it.
-		if ( ! file_exists( $publisher_logo_path ) ) {
-			$original_file_editor->resize( 600, 60 );
-			$original_file_editor->save( $publisher_logo_path );
-		}
-
-		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
-		if ( is_wp_error( $publisher_logo_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
-
-			return false;
-		}
-
-		// Get the actual size.
-		$size = $publisher_logo_editor->get_size();
-
-		// Finally return the array with data.
-		return array(
-			'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
-			'width'  => $size['width'],
-			'height' => $size['height'],
-		);
-	}
+        if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
+            $post_adapter    = new Wordlift_Post_Adapter( $post_id );
+            $keywords        = $post_adapter->keywords();
+            $article_section = $post_adapter->article_section();
+            $comment_count   = $post_adapter->comment_count();
+            $locale          = $post_adapter->locale();
+
+            if ( isset( $keywords ) ) {
+                $jsonld['keywords'] = $keywords;
+            }
+            if ( ! empty( $article_section ) ) {
+                $jsonld['articleSection'] = $article_section;
+            }
+            $jsonld['commentCount'] = $comment_count;
+            $jsonld['inLanguage']   = $locale;
+        }
+
+        // Set the publisher.
+        $this->set_publisher( $jsonld );
+
+        /**
+         * Call the `wl_post_jsonld_author` filter.
+         *
+         * This filter checks if there are co-authors or a single author and
+         * returns a JSON-LD fragment for the author(s).
+         *
+         * @param array $value {
+         *
+         * @type array $jsonld The JSON-LD structure.
+         * @type int[] $references An array of post IDs.
+         * }
+         *
+         * @param int $post_id The {@link WP_Post} `id`.
+         *
+         * @since 3.51.4
+         *
+         * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
+         */
+        $ret_val = apply_filters(
+            'wl_jsonld_author',
+            array(
+                'author'     => $this->get_author( $post->post_author, $references ),
+                'references' => $references,
+            ),
+            $post_id
+        );
+
+        // Set the values returned by the filter.
+        $jsonld['author'] = $ret_val['author'];
+        $references       = $ret_val['references'];
+
+        // Return the JSON-LD if filters are disabled by the client.
+        if ( $this->disable_convert_filters ) {
+            return $jsonld;
+        }
+
+        /**
+         * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
+         *
+         * @param array $value {
+         *
+         * @type array $jsonld The JSON-LD structure.
+         * @type int[] $references An array of post IDs.
+         * @type Relations $relations A set of `Relation`s.
+         * }
+         * @since 3.25.0
+         * @since 3.43.0 The filter provides a `Relations` instance.
+         *
+         * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
+         *
+         * @api
+         */
+        $ret_val = apply_filters(
+            'wl_post_jsonld_array',
+            array(
+                'jsonld'           => $jsonld,
+                'references'       => $references, // This one is only an array of post IDs.
+                'references_infos' => $references_infos,
+                'relations'        => $relations,
+            ),
+            $post_id
+        );
+
+        $jsonld     = $ret_val['jsonld'];
+        $references = $ret_val['references'];
+
+        /**
+         * Call the `wl_post_jsonld` filter.
+         *
+         * @param array $jsonld The JSON-LD structure.
+         * @param int $post_id The {@link WP_Post} `id`.
+         * @param array $references The array of referenced entities.
+         *
+         * @since 3.14.0
+         *
+         * @api
+         */
+        return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
+    }
+
+    /**
+     * Get the author's JSON-LD fragment.
+     *
+     * The JSON-LD fragment is generated using the {@link WP_User}'s data or
+     * the referenced entity if configured for the {@link WP_User}.
+     *
+     * @param int   $author_id The author {@link WP_User}'s `id`.
+     * @param array $references An array of referenced entities.
+     *
+     * @return string|array A JSON-LD structure.
+     * @since 3.14.0
+     */
+    public function get_author( $author_id, &$references ) {
+
+        // Get the entity bound to this user.
+        $entity_id = $this->user_service->get_entity( $author_id );
+
+        // If there's no entity bound return a simple author structure.
+        if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
+
+            $author            = get_the_author_meta( 'display_name', $author_id );
+            $author_first_name = get_the_author_meta( 'first_name', $author_id );
+            $author_last_name  = get_the_author_meta( 'last_name', $author_id );
+            $author_uri        = $this->user_service->get_uri( $author_id );
+
+            return array(
+                '@type'      => 'Person',
+                '@id'        => $author_uri,
+                'name'       => $author,
+                'givenName'  => $author_first_name,
+                'familyName' => $author_last_name,
+                'url'        => get_author_posts_url( $author_id ),
+            );
+        }
+
+        // Add the author to the references.
+        $author_uri   = Wordlift_Entity_Service::get_instance()->get_uri( $entity_id );
+        $references[] = $entity_id;
+
+        // Return the JSON-LD for the referenced entity.
+        return array(
+            '@id' => $author_uri,
+        );
+    }
+
+    /**
+     * Enrich the provided params array with publisher data, if available.
+     *
+     * @param array $params The parameters array.
+     *
+     * @since 3.10.0
+     */
+    protected function set_publisher( &$params ) {
+
+        // If the publisher id isn't set don't do anything.
+        $publisher_id = Wordlift_Configuration_Service::get_instance()->get_publisher_id();
+        if ( empty( $publisher_id ) ) {
+            return;
+        }
+
+        // Get the post instance.
+        $post = get_post( $publisher_id );
+        if ( ! is_a( $post, '\WP_Post' ) ) {
+            // Publisher not found.
+            return;
+        }
+
+        // Get the item id.
+        $id = Wordlift_Entity_Service::get_instance()->get_uri( $publisher_id );
+
+        // Get the type.
+        $type = $this->entity_type_service->get( $publisher_id );
+
+        // Get the name.
+        $name = $post->post_title;
+
+        // Set the publisher data.
+        $params['publisher'] = array(
+            '@type' => $this->relative_to_context( $type['uri'] ),
+            '@id'   => $id,
+            'name'  => $name,
+        );
+
+        // Add the sameAs values associated with the publisher.
+        $storage_factory = Wordlift_Storage_Factory::get_instance();
+        $sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
+        if ( ! empty( $sameas ) ) {
+            $params['publisher']['sameAs'] = $sameas;
+        }
+
+        // Set the logo, only for http://schema.org/Organization as Person doesn't
+        // support the logo property.
+        //
+        // See http://schema.org/logo.
+        if ( 1 !== preg_match( '~Organization$~', $type['uri'] ) ) {
+            return;
+        }
+
+        // Get the publisher logo.
+        $publisher_logo = $this->get_publisher_logo( $post->ID );
+
+        // Bail out if the publisher logo isn't set.
+        if ( false === $publisher_logo ) {
+            return;
+        }
+
+        // Copy over some useful properties.
+        //
+        // See https://developers.google.com/search/docs/data-types/articles.
+        $params['publisher']['logo']['@type'] = 'ImageObject';
+        $params['publisher']['logo']['url']   = $publisher_logo['url'];
+
+        // If you specify a "width" or "height" value you should leave out
+        // 'px'. For example: "width":"4608px" should be "width":"4608".
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/451.
+        $params['publisher']['logo']['width']  = $publisher_logo['width'];
+        $params['publisher']['logo']['height'] = $publisher_logo['height'];
+
+    }
+
+    /**
+     * Get the publisher logo structure.
+     *
+     * The function returns false when the publisher logo cannot be determined, i.e.:
+     *  - the post has no featured image.
+     *  - the featured image has no file.
+     *  - a wp_image_editor instance cannot be instantiated on the original file or on the publisher logo file.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|false Returns an array with the `url`, `width` and `height` for the publisher logo or false in case
+     *  of errors.
+     * @since 3.19.2
+     * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
+     */
+    private function get_publisher_logo( $post_id ) {
+
+        // Get the featured image for the post.
+        $thumbnail_id = get_post_thumbnail_id( $post_id );
+
+        // Bail out if thumbnail not available.
+        if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
+            $this->log->info( "Featured image not set for post $post_id." );
+
+            return false;
+        }
+
+        // Get the uploads base URL.
+        $uploads_dir = wp_upload_dir();
+
+        // Get the attachment metadata.
+        $metadata = wp_get_attachment_metadata( $thumbnail_id );
+
+        // Bail out if the file isn't set.
+        if ( ! isset( $metadata['file'] ) ) {
+            $this->log->warn( "Featured image file not found for post $post_id." );
+
+            return false;
+        }
+
+        // Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
+        $path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
+
+        // Use image src, if local file does not exist. @see https://github.com/insideout10/wordlift-plugin/issues/1149
+        if ( ! file_exists( $path ) ) {
+            $this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
+
+            $attachment_image_src = wp_get_attachment_image_src( $thumbnail_id, '' );
+            if ( $attachment_image_src ) {
+                return array(
+                    'url'    => $attachment_image_src[0],
+                    'width'  => $attachment_image_src[1],
+                    'height' => $attachment_image_src[2],
+                );
+            }
+
+            // Bail out if we cant fetch wp_get_attachment_image_src
+            return false;
+
+        }
+
+        // Try to get the image editor and bail out if the editor cannot be instantiated.
+        $original_file_editor = wp_get_image_editor( $path );
+        if ( is_wp_error( $original_file_editor ) ) {
+            $this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
+
+            return false;
+        }
+
+        // Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
+        // and we don't actually know the end values.
+        $publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
+
+        // If the file doesn't exist yet, create it.
+        if ( ! file_exists( $publisher_logo_path ) ) {
+            $original_file_editor->resize( 600, 60 );
+            $original_file_editor->save( $publisher_logo_path );
+        }
+
+        // Try to get the image editor and bail out if the editor cannot be instantiated.
+        $publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
+        if ( is_wp_error( $publisher_logo_editor ) ) {
+            $this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
+
+            return false;
+        }
+
+        // Get the actual size.
+        $size = $publisher_logo_editor->get_size();
+
+        // Finally return the array with data.
+        return array(
+            'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
+            'width'  => $size['width'],
+            'height' => $size['height'],
+        );
+    }
 
 }

src/classes/jsonld/class-jsonld-article-wrapper.php

Indentation +173 added lines, -173 removed lines

@@ -7,192 +7,192 @@
 
 class Jsonld_Article_Wrapper {
 
-	public static $article_types = array(
-		'Article',
-		'AdvertiserContentArticle',
-		'NewsArticle',
-		'AnalysisNewsArticle',
-		'AskPublicNewsArticle',
-		'BackgroundNewsArticle',
-		'OpinionNewsArticle',
-		'ReportageNewsArticle',
-		'ReviewNewsArticle',
-		'Report',
-		'SatiricalArticle',
-		'ScholarlyArticle',
-		'MedicalScholarlyArticle',
-		'SocialMediaPosting',
-		'BlogPosting',
-		'LiveBlogPosting',
-		'DiscussionForumPosting',
-		'TechArticle',
-		'APIReference',
-	);
-
-	/**
-	 * @var Wordlift_Post_To_Jsonld_Converter
-	 */
-	private $post_to_jsonld_converter;
-	/**
-	 * @var \Wordlift_Cached_Post_Converter
-	 */
-	private $cached_postid_to_jsonld_converter;
-	/**
-	 * @var \Wordlift_Entity_Uri_Service
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * Jsonld_Article_Wrapper constructor.
-	 *
-	 * @param Wordlift_Post_To_Jsonld_Converter $post_to_jsonld_converter
-	 * @param $cached_postid_to_jsonld_converter
-	 */
-	public function __construct( $post_to_jsonld_converter, $cached_postid_to_jsonld_converter ) {
-
-		$this->post_to_jsonld_converter = $post_to_jsonld_converter->new_instance_with_filters_disabled();
-
-		add_filter(
-			'wl_after_get_jsonld',
-			array(
-				$this,
-				'after_get_jsonld',
-			),
-			PHP_INT_MAX - 100,
-			3
-		);
-
-		$this->cached_postid_to_jsonld_converter = $cached_postid_to_jsonld_converter;
-
-		$this->entity_uri_service = \Wordlift_Entity_Uri_Service::get_instance();
-	}
-
-	public function after_get_jsonld( $jsonld, $post_id, $context ) {
-
-		// Invalid data structure
-		if ( ! is_array( $jsonld ) || ! isset( $jsonld[0] ) || ! is_array( $jsonld[0] ) ) {
-			return $jsonld;
-		}
-
-		if ( Jsonld_Context_Enum::PAGE !== $context
-			 // Returns true for "1", "true", "on" and "yes". Returns false otherwise.
-			 && ! filter_input( INPUT_GET, 'article_wrapper', FILTER_VALIDATE_BOOLEAN ) ) {
-			return $jsonld;
-		}
-
-		// Copy the 1st array element
-		$post_jsonld = $jsonld[0];
-
-		// Don't wrap in article if the json-ld is already about an Article (or its descendants). `@type` must be
-		// in the schema.org context, i.e. `Article`, not `http://schema.org/Article`.
-		if ( ! isset( $post_jsonld['@id'] ) || ! isset( $post_jsonld['@type'] ) || $this->is_article( $post_jsonld['@type'] ) ) {
-			return $jsonld;
-		}
-
-		$references      = array();
-		$reference_infos = array();
-
-		// Convert the post as Article.
-		$article_jsonld = $this->post_to_jsonld_converter->convert( $post_id, $references, $reference_infos, new Relations() );
-
-		$article_jsonld['@id'] = $post_jsonld['@id'] . '#article';
-		// Reset the type, since by default the type assigned via the Entity Type taxonomy is used.
-		$article_jsonld['@type'] = 'Article';
-		$article_jsonld['about'] = array( '@id' => $post_jsonld['@id'] );
-
-		// Copy over the URLs.
-		if ( isset( $post_jsonld['url'] ) ) {
-			$article_jsonld['url'] = $post_jsonld['url'];
-		}
-
-		array_unshift( $jsonld, $article_jsonld );
-
-		$author_jsonld = $this->get_author_linked_entity( $article_jsonld );
-
-		// Get primary author in case co-authors exist.
-		$primary_author = $this->get_primary_author( $article_jsonld['author'] );
-
-		/**
-		 * The author entities can be present in graph for some entity types
-		 * for Person and Organization, so check before we add it to graph.
-		 * reference : https://schema.org/author
-		 */
-
-		if ( $author_jsonld && ! $this->is_author_entity_present_in_graph( $jsonld, $primary_author['@id'] ) ) {
-			$jsonld[] = $author_jsonld;
-		}
-
-		return $jsonld;
-	}
-
-	private function is_article( $schema_types ) {
-
-		$array_intersect = array_intersect( self::$article_types, (array) $schema_types );
-
-		return ! empty( $array_intersect );
-	}
-
-	/**
-	 * Get primary author from author array.
-	 *
-	 * A helper function that checks the structure of the author array and returns the primary author.
-	 *
-	 * @param array|string $author The author array.
-	 *
-	 * @return array|string The primary author.
-	 *
-	 * @since 3.51.4
-	 */
-	private function get_primary_author( $author ) {
+    public static $article_types = array(
+        'Article',
+        'AdvertiserContentArticle',
+        'NewsArticle',
+        'AnalysisNewsArticle',
+        'AskPublicNewsArticle',
+        'BackgroundNewsArticle',
+        'OpinionNewsArticle',
+        'ReportageNewsArticle',
+        'ReviewNewsArticle',
+        'Report',
+        'SatiricalArticle',
+        'ScholarlyArticle',
+        'MedicalScholarlyArticle',
+        'SocialMediaPosting',
+        'BlogPosting',
+        'LiveBlogPosting',
+        'DiscussionForumPosting',
+        'TechArticle',
+        'APIReference',
+    );
+
+    /**
+     * @var Wordlift_Post_To_Jsonld_Converter
+     */
+    private $post_to_jsonld_converter;
+    /**
+     * @var \Wordlift_Cached_Post_Converter
+     */
+    private $cached_postid_to_jsonld_converter;
+    /**
+     * @var \Wordlift_Entity_Uri_Service
+     */
+    private $entity_uri_service;
+
+    /**
+     * Jsonld_Article_Wrapper constructor.
+     *
+     * @param Wordlift_Post_To_Jsonld_Converter $post_to_jsonld_converter
+     * @param $cached_postid_to_jsonld_converter
+     */
+    public function __construct( $post_to_jsonld_converter, $cached_postid_to_jsonld_converter ) {
+
+        $this->post_to_jsonld_converter = $post_to_jsonld_converter->new_instance_with_filters_disabled();
+
+        add_filter(
+            'wl_after_get_jsonld',
+            array(
+                $this,
+                'after_get_jsonld',
+            ),
+            PHP_INT_MAX - 100,
+            3
+        );
+
+        $this->cached_postid_to_jsonld_converter = $cached_postid_to_jsonld_converter;
+
+        $this->entity_uri_service = \Wordlift_Entity_Uri_Service::get_instance();
+    }
+
+    public function after_get_jsonld( $jsonld, $post_id, $context ) {
+
+        // Invalid data structure
+        if ( ! is_array( $jsonld ) || ! isset( $jsonld[0] ) || ! is_array( $jsonld[0] ) ) {
+            return $jsonld;
+        }
+
+        if ( Jsonld_Context_Enum::PAGE !== $context
+                // Returns true for "1", "true", "on" and "yes". Returns false otherwise.
+             && ! filter_input( INPUT_GET, 'article_wrapper', FILTER_VALIDATE_BOOLEAN ) ) {
+            return $jsonld;
+        }
+
+        // Copy the 1st array element
+        $post_jsonld = $jsonld[0];
+
+        // Don't wrap in article if the json-ld is already about an Article (or its descendants). `@type` must be
+        // in the schema.org context, i.e. `Article`, not `http://schema.org/Article`.
+        if ( ! isset( $post_jsonld['@id'] ) || ! isset( $post_jsonld['@type'] ) || $this->is_article( $post_jsonld['@type'] ) ) {
+            return $jsonld;
+        }
+
+        $references      = array();
+        $reference_infos = array();
+
+        // Convert the post as Article.
+        $article_jsonld = $this->post_to_jsonld_converter->convert( $post_id, $references, $reference_infos, new Relations() );
+
+        $article_jsonld['@id'] = $post_jsonld['@id'] . '#article';
+        // Reset the type, since by default the type assigned via the Entity Type taxonomy is used.
+        $article_jsonld['@type'] = 'Article';
+        $article_jsonld['about'] = array( '@id' => $post_jsonld['@id'] );
+
+        // Copy over the URLs.
+        if ( isset( $post_jsonld['url'] ) ) {
+            $article_jsonld['url'] = $post_jsonld['url'];
+        }
+
+        array_unshift( $jsonld, $article_jsonld );
+
+        $author_jsonld = $this->get_author_linked_entity( $article_jsonld );
+
+        // Get primary author in case co-authors exist.
+        $primary_author = $this->get_primary_author( $article_jsonld['author'] );
+
+        /**
+         * The author entities can be present in graph for some entity types
+         * for Person and Organization, so check before we add it to graph.
+         * reference : https://schema.org/author
+         */
+
+        if ( $author_jsonld && ! $this->is_author_entity_present_in_graph( $jsonld, $primary_author['@id'] ) ) {
+            $jsonld[] = $author_jsonld;
+        }
+
+        return $jsonld;
+    }
+
+    private function is_article( $schema_types ) {
+
+        $array_intersect = array_intersect( self::$article_types, (array) $schema_types );
+
+        return ! empty( $array_intersect );
+    }
+
+    /**
+     * Get primary author from author array.
+     *
+     * A helper function that checks the structure of the author array and returns the primary author.
+     *
+     * @param array|string $author The author array.
+     *
+     * @return array|string The primary author.
+     *
+     * @since 3.51.4
+     */
+    private function get_primary_author( $author ) {
 
-		// Nested array of co-authors. Return the primary author.
-		if ( is_array( $author ) && ! empty( $author ) && ! isset( $author['@id'] ) ) {
-			return $author[0];
-		}
+        // Nested array of co-authors. Return the primary author.
+        if ( is_array( $author ) && ! empty( $author ) && ! isset( $author['@id'] ) ) {
+            return $author[0];
+        }
 
-		return $author;
-	}
+        return $author;
+    }
 
-	private function get_author_linked_entity( $article_jsonld ) {
-		if ( ! array_key_exists( 'author', $article_jsonld ) ) {
-			return false;
-		}
+    private function get_author_linked_entity( $article_jsonld ) {
+        if ( ! array_key_exists( 'author', $article_jsonld ) ) {
+            return false;
+        }
 
-		$author = $this->get_primary_author( $article_jsonld['author'] );
+        $author = $this->get_primary_author( $article_jsonld['author'] );
 
-		if ( count( array_keys( $author ) ) !== 1 || ! array_key_exists( '@id', $author ) ) {
-			return false;
-		}
+        if ( count( array_keys( $author ) ) !== 1 || ! array_key_exists( '@id', $author ) ) {
+            return false;
+        }
 
-		$author_linked_entity_id = $author['@id'];
+        $author_linked_entity_id = $author['@id'];
 
-		$author_entity_post = $this->entity_uri_service->get_entity( $author_linked_entity_id );
+        $author_entity_post = $this->entity_uri_service->get_entity( $author_linked_entity_id );
 
-		if ( ! $author_entity_post instanceof \WP_Post ) {
-			return false;
-		}
+        if ( ! $author_entity_post instanceof \WP_Post ) {
+            return false;
+        }
 
-		$references      = array();
-		$reference_infos = array();
+        $references      = array();
+        $reference_infos = array();
 
-		return $this->cached_postid_to_jsonld_converter->convert(
-			$author_entity_post->ID,
-			$references,
-			$reference_infos,
-			new Relations()
-		);
+        return $this->cached_postid_to_jsonld_converter->convert(
+            $author_entity_post->ID,
+            $references,
+            $reference_infos,
+            new Relations()
+        );
 
-	}
+    }
 
-	private function is_author_entity_present_in_graph( $jsonld, $author_entity_id ) {
+    private function is_author_entity_present_in_graph( $jsonld, $author_entity_id ) {
 
-		foreach ( $jsonld as $item ) {
-			if ( $item && array_key_exists( '@id', $item ) && $item['@id'] === $author_entity_id ) {
-				return true;
-			}
-		}
+        foreach ( $jsonld as $item ) {
+            if ( $item && array_key_exists( '@id', $item ) && $item['@id'] === $author_entity_id ) {
+                return true;
+            }
+        }
 
-		return false;
-	}
+        return false;
+    }
 
 }

src/modules/jsonld-author-filter/load.php

Indentation +20 added lines, -20 removed lines

@@ -20,33 +20,33 @@
  */
 function _wl_jsonld_author__author_filter( $args_arr, $post_id ) {
 
-	$author     = $args_arr['author'];
-	$references = $args_arr['references'];
+    $author     = $args_arr['author'];
+    $references = $args_arr['references'];
 
-	$coauthor_plugin_path = 'co-authors-plus/co-authors-plus.php';
+    $coauthor_plugin_path = 'co-authors-plus/co-authors-plus.php';
 
-	// If the co-authors plugin is active.
-	if ( is_plugin_active( $coauthor_plugin_path ) && function_exists( 'get_coauthors' ) ) {
+    // If the co-authors plugin is active.
+    if ( is_plugin_active( $coauthor_plugin_path ) && function_exists( 'get_coauthors' ) ) {
 
-		$coauthors = get_coauthors( $post_id );
+        $coauthors = get_coauthors( $post_id );
 
-		// And we have multiple authors on a post.
-		if ( count( $coauthors ) > 1 ) {
+        // And we have multiple authors on a post.
+        if ( count( $coauthors ) > 1 ) {
 
-			// Clear the existing author.
-			$author = array();
+            // Clear the existing author.
+            $author = array();
 
-			// Build array of authors.
-			foreach ( $coauthors as $coauthor ) {
-				$author[] = Wordlift_Post_To_Jsonld_Converter::get_instance()->get_author( $coauthor->ID, $references );
-			}
-		}
-	}
+            // Build array of authors.
+            foreach ( $coauthors as $coauthor ) {
+                $author[] = Wordlift_Post_To_Jsonld_Converter::get_instance()->get_author( $coauthor->ID, $references );
+            }
+        }
+    }
 
-	return array(
-		'author'     => $author,
-		'references' => $references,
-	);
+    return array(
+        'author'     => $author,
+        'references' => $references,
+    );
 }
 
 // Add the filter