Wordlift_Linked_Data_Service

Complexity

Total Complexity

19

Size/Duplication

Total Lines	330
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	20	1
A	get_instance()	0	4	1
B	push()	0	58	6
A	has_valid_uri()	0	18	3
A	remove()	0	15	2
A	insert()	0	14	1
A	get_delete_triples()	0	23	2
A	get_insert_triples()	0	36	3

<?php
/**
 * Services: Linked Data Service.
 *
 * A service to handle data to be pushed to the remote Linked Data store.
 *
 * @since      3.15.0
 * @package    Wordlift
 * @subpackage Wordlift/includes
 */

/**
 * Define the {@link Wordlift_Linked_Data_Service} class.
 *
 * @since      3.15.0
 * @package    Wordlift
 * @subpackage Wordlift/includes
 */
class Wordlift_Linked_Data_Service {

	//<editor-fold desc="## FIELDS">
	/**
	 * A {@link Wordlift_Log_Service} instance.
	 *
	 * @since  3.15.0
	 * @access private
	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
	 */
	private $log;

	/**
	 * The {@link Wordlift_Entity_Service} instance.
	 *
	 * @since  3.15.0
	 * @access private
	 * @var \Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
	 */
	private $entity_service;

	/**
	 * The {@link Wordlift_Entity_Type_Service} instance.
	 *
	 * @since  3.15.0
	 * @access private
	 * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
	 */
	private $entity_type_service;

	/**
	 * The {@link Wordlift_Schema_Service} instance.
	 *
	 * @since  3.15.0
	 * @access private
	 * @var \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
	 */
	private $schema_service;

	/**
	 * The {@link Wordlift_Sparql_Service} instance.
	 *
	 * @since  3.15.0
	 * @access private
	 * @var \Wordlift_Sparql_Service $sparql_service The {@link Wordlift_Sparql_Service} instance.
	 */
	private $sparql_service;

	/**
	 * The {@link Wordlift_Linked_Data_Service} singleton instance.
	 *
	 * @since  3.15.0
	 * @access private
	 * @var \Wordlift_Linked_Data_Service $instance The {@link Wordlift_Linked_Data_Service} singleton instance.
	 */
	private static $instance;
	//</editor-fold>

	/**
	 * Create a {@link Wordlift_Linked_Data_Service} instance.
	 *
	 * @param \Wordlift_Entity_Service $entity_service The {@link Wordlift_Entity_Service} instance.
	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
	 * @param \Wordlift_Schema_Service $schema_service The {@link Wordlift_Schema_Service} instance.
	 * @param \Wordlift_Sparql_Service $sparql_service The {@link Wordlift_Sparql_Service} instance.
	 *
	 * @since 3.15.0
	 *
	 */
	public function __construct( $entity_service, $entity_type_service, $schema_service, $sparql_service ) {

		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Linked_Data_Service' );

		$this->entity_service      = $entity_service;
		$this->entity_type_service = $entity_type_service;
		$this->schema_service      = $schema_service;
		$this->sparql_service      = $sparql_service;

		/*
		 * Allow callers to call the `push` and `remove` methods using WordPress' hooks.
		 *
		 * @since 3.27.6
		 */
		add_action( 'wl_legacy_linked_data__push', array( $this, 'push' ) );
		add_action( 'wl_legacy_linked_data__remove', array( $this, 'remove' ) );

		self::$instance = $this;

	}

	/**
	 * Get the singleton instance of {@link Wordlift_Linked_Data_Service}.
	 *
	 * @return Wordlift_Linked_Data_Service The singleton instance of <a href='psi_element://Wordlift_Linked_Data_Service'>Wordlift_Linked_Data_Service</a>.
	 * @since 3.15.0
	 *
	 */
	public static function get_instance() {

		return self::$instance;
	}

	//<editor-fold desc="## FUNCTIONS">

	/**
	 * Push a {@link WP_Post} to the Linked Data store.
	 *
	 * If the {@link WP_Post} is an entity and it's not of the `Article` type,
	 * then it is pushed to the remote Linked Data store.
	 *
	 * @param int $post_id The {@link WP_Post}'s id.
	 *
	 * @since 3.15.0
	 *
	 */
	public function push( $post_id ) {

		if ( null === Wordlift_Configuration_Service::get_instance()->get_dataset_uri() ) {
			$this->log->debug( "Post $post_id won't be published because the dataset URI isn't set." );

			return;
		}

		$this->log->debug( "Pushing post $post_id..." );

		// @since 3.18.0 we don't check anymore if the post is an entity, i.e.
		// we removed the following:
		//		if ( ! $this->entity_service->is_entity( $post_id ) ) {
		//			$this->log->debug( "Post $post_id is not an entity." );
		//
		//			return;
		//		}

		// Get the post and push it to the Linked Data store.

		$this->log->debug( "Doing post $post_id push..." );

		// Get the post.
		$post = get_post( $post_id );

		// Bail out if the post isn't found.
		if ( null === $post ) {
			$this->log->warn( "Post $post_id not found." );

			return;
		}

		// Bail out if the post isn't published.
		if ( 'publish' !== $post->post_status ) {
			$this->log->info( "Post $post_id not published." );

			return;
		}

		// Bail out if the URI isn't valid.
		if ( ! $this->has_valid_uri( $post_id ) ) {
			$this->log->warn( "Post $post_id URI invalid." );

			return;
		}

		// First remove the post data.
		$this->remove( $post_id );

		// Then execute the insert query.
		$this->insert( $post_id );

		// Reindex the triple store if buffering is turned off.
		if ( false === WL_ENABLE_SPARQL_UPDATE_QUERIES_BUFFERING ) {
			wordlift_reindex_triple_store();
		}

	}

	/**
	 * Check if an entity's {@link WP_Post} has a valid URI.
	 *
	 * @param int $post_id The entity's {@link WP_Post}'s id.
	 *
	 * @return bool True if the URI is valid otherwise false.
	 * @since 3.15.0
	 *
	 */
	private function has_valid_uri( $post_id ) {

		// Get the entity's URI.
		$uri = $this->entity_service->get_uri( $post_id );

		// If the URI isn't found, return false.
		if ( null === $uri ) {
			return false;
		}

		// If the URI ends with a trailing slash, return false.
		if ( '/' === substr( $uri, - 1 ) ) {
			return false;
		}

		// URI is valid.
		return true;
	}

	/**
	 * Remove the specified {@link WP_Post} from the Linked Data.
	 *
	 * @param int $post_id The {@link WP_Post}'s id.
	 *
	 * @since 3.18.0
	 *
	 */
	public function remove( $post_id ) {
		$delete_query = '';

		// Get the delete statements.
		$triples = $this->get_delete_triples( $post_id );

		// Loop through all triples and add the statement to delete query.
		foreach ( $triples as $item ) {
			$delete_query .= "DELETE { $item } WHERE { $item }; \n";
		}

		$this->log->trace( "Delete Query generated [ $delete_query ]." );

		$this->sparql_service->execute( $delete_query );
	}

	/**
	 * Insert the specific {@link WP_Post} to Linked Data store.
	 *
	 * @param int $post_id The {@link WP_Post}'s id.
	 *
	 * @since 3.18.0
	 *
	 */
	private function insert( $post_id ) {
		// Get the insert statements.
		$insert_triples = $this->get_insert_triples( $post_id );

		// Convert all statements to single string.
		$insert_query_body = implode( "\n", $insert_triples );

		// Build the insert query.
		$insert_query = "INSERT DATA { $insert_query_body };";

		$this->log->trace( "Insert Query generated [ $insert_query ]." );

		$this->sparql_service->execute( $insert_query );
	}

	/**
	 * Get the delete statements.
	 *
	 * @param int $post_id The {@link WP_Post}'s id.
	 *
	 * @return array An array of delete statements.
	 * @since 3.18.0
	 *
	 */
	private function get_delete_triples( $post_id ) {
		$delete_triples = array();

		// Loop through all renditions and get the triples.
		foreach ( $this->schema_service->get_renditions() as $rendition ) {
			// Push the rendition delete triple to $delete_triples.
			$delete_triples = array_merge(
				$delete_triples,
				(array) $rendition->get_delete_triples( $post_id )
			);
		}

		/**
		 * Filter: 'wl_delete_triples' - Allow third parties to hook and add additional delete triples.
		 *
		 * @param array $delete_triples Delete triples.
		 * @param int $post_id The current post ID.
		 *
		 * @since 3.18.0
		 *
		 */
		return apply_filters( 'wl_delete_triples', array_unique( $delete_triples ), $post_id );
	}

	/**
	 * Get the SPARQL insert triples ( ?s ?p ?o ) for the specified {@link WP_Post}.
	 *
	 * @param int $post_id The {@link WP_Post}'s id.
	 *
	 * @return array An array of insert triples.
	 * @since 3.15.0
	 *
	 */
	private function get_insert_triples( $post_id ) {

		// Get the entity type.
		$type = $this->entity_type_service->get( $post_id );

		// Get the `linked_data` parameter.
		$properties = $type['linked_data'];

		// Accumulate the triples.
		$triples = array();

		/** @var Wordlift_Default_Sparql_Tuple_Rendition $property A {@link Wordlift_Sparql_Tuple_Rendition} instance. */
		foreach ( $properties as $property ) {
			foreach ( $property->get_insert_triples( $post_id ) as $triple ) {
				$triples[] = $triple;
			}
		}

		$this->log->trace( count( $properties ) . ' properties and ' . count( $triples ) . " triples found for post $post_id." );

		/**
		 * Get the INSERT triples properties.
		 *
		 * The `wl_insert_triples` filter allows 3rd parties to extend
		 * the list of triples for SPARQL INSERT statements.
		 *
		 * @param array $linked_data A {@link Wordlift_Sparql_Tuple_Rendition} instances.
		 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
		 * @param int $post_id The {@link WP_Post}'s id.
		 *
		 * @since 3.18.0 The hook has been renamed from `wl_insert_tuples_properties` to `wl_insert_triples`.
		 *
		 * @since 3.17.0
		 */
		return apply_filters( 'wl_insert_triples', $triples, $this->entity_service, $post_id );
	}
	//</editor-fold>

}