Collaboration diagram for ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher:

Public Member Functions
	__construct (protected PublisherInterface $publisher, protected SettingsInterface $settings, protected ObjectHandler $object_handler, protected StatusRepository $status_repository, protected ExposedRecordRepository $exposed_record_repository, protected CopyrightSearchFactory $copyright_search_factory, protected LOMRepository $lom_repository, protected SimpleDCXMLWriter $xml_writer, protected ilLogger $logger)

	run (Result $result)

Protected Member Functions
	findHarvestableObjectIDs ()

	withdrawDeprecatedObjects (array $harvestable_obj_ids, array $currently_harvested_obj_ids)
	Returns number of deletions. More...

	publishObjects (array $harvestable_obj_ids, array $currently_harvested_obj_ids)
	Returns number of published/submitted objects. More...

	updatePublishedObjects ()
	Returns number of changed published records. More...

	cleanUpDeletedRecords ()

	logDebug (string $message)

	logError (string $message)

Detailed Description

Definition at line 35 of file AutomaticPublisher.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher::__construct	(	protected PublisherInterface	$publisher,
		protected SettingsInterface	$settings,
		protected ObjectHandler	$object_handler,
		protected StatusRepository	$status_repository,
		protected ExposedRecordRepository	$exposed_record_repository,
		protected CopyrightSearchFactory	$copyright_search_factory,
		protected LOMRepository	$lom_repository,
		protected SimpleDCXMLWriter	$xml_writer,
		protected ilLogger	$logger
	)

Definition at line 37 of file AutomaticPublisher.php.

47 {

48 }

Member Function Documentation

◆ cleanUpDeletedRecords()

ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher::cleanUpDeletedRecords ( )

protected

Definition at line 221 of file AutomaticPublisher.php.

                                              : void
    {
        $this->exposed_record_repository->deleteRecordsMarkedAsDeletedOlderThan(
            new \DateInterval('P30D')
        );
    }

◆ findHarvestableObjectIDs()

ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher::findHarvestableObjectIDs ( )

protected

Definition at line 88 of file AutomaticPublisher.php.

                                                 : array
    {
        $searcher = $this->copyright_search_factory->get()
                                                   ->withRestrictionToRepositoryObjects(true);
        foreach ($this->settings->getObjectTypesSelectedForPublishing() as $type) {
            $searcher = $searcher->withAdditionalTypeFilter($type);
        }
        $search_results = [];
        foreach ($searcher->search(
            $this->lom_repository,
            ...$this->settings->getCopyrightEntryIDsSelectedForPublishing()
        ) as $ressource_id) {
            $search_results[] = $ressource_id->objID();
        }
 
        $unblocked = $this->status_repository->filterOutBlockedObjects(...$search_results);
        $results = [];
        foreach ($unblocked as $obj_id) {
            if ($this->object_handler->isObjectDeleted($obj_id)) {
                continue;
            }
            $results[] = $obj_id;
        }
        return $results;
    }

References $results, and ILIAS\Repository\settings().

Referenced by ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher\run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logDebug()

ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher::logDebug ( string $message )

protected

Definition at line 228 of file AutomaticPublisher.php.

                                                : void
    {
        $this->logger->debug($message);
    }

References ILIAS\Repository\logger().

Referenced by ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher\withdrawDeprecatedObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logError()

ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher::logError ( string $message )

protected

Definition at line 233 of file AutomaticPublisher.php.

                                                : void
    {
        $this->logger->error($message);
    }

References ILIAS\Repository\logger().

Referenced by ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher\withdrawDeprecatedObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ publishObjects()

ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher::publishObjects	(	array	$harvestable_obj_ids,
		array	$currently_harvested_obj_ids
	)

protected

Returns number of published/submitted objects.

Parameters

int[]	$harvestable_obj_ids
int[]	$currently_harvested_obj_ids

Definition at line 152 of file AutomaticPublisher.php.

     : int {
        $count = 0;
 
        foreach ($harvestable_obj_ids as $obj_id) {
            if (in_array($obj_id, $currently_harvested_obj_ids)) {
                continue;
            }
 
            $this->logDebug('Publishing object with obj_id: ' . $obj_id);
            try {
                if ($this->settings->isEditorialStepEnabled()) {
                    $this->publisher->submit($obj_id);
                } else {
                    $type = $this->object_handler->getTypeOfObject($obj_id);
                    $this->publisher->publish($obj_id, $type);
                }
            } catch (\Exception $e) {
                $this->logError(
                    'Error when publishing object with obj_id ' .
                    $obj_id . ': ' . $e->getMessage()
                );
                continue;
            }
 
            $count++;
        }
        return $count;
    }

References Vendor\Package\$e, and ILIAS\Repository\settings().

Referenced by ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher\run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher::run ( Result $result )

Definition at line 50 of file AutomaticPublisher.php.

                                       : Result
    {
        try {
            $messages = [];
 
            $harvestable_obj_ids = $this->findHarvestableObjectIDs();
            $currently_harvested_obj_ids = iterator_to_array($this->status_repository->getAllHarvestedObjIDs());
 
            $deletion_count = $this->withdrawDeprecatedObjects(
                $harvestable_obj_ids,
                $currently_harvested_obj_ids
            );
            $messages[] = 'Withdrew ' . $deletion_count . ' deprecated objects.';
 
            $exposure_count = $this->updatePublishedObjects();
            $messages[] = 'Updated ' . $exposure_count . ' published objects.';
 
            $harvest_count = 0;
            if ($this->settings->isAutomaticPublishingEnabled()) {
                $harvest_count = $this->publishObjects(
                    $harvestable_obj_ids,
                    $currently_harvested_obj_ids
                );
                $messages[] = 'Published or submitted for review ' . $harvest_count . ' new objects.';
            }
 
            if ($deletion_count !== 0 || $harvest_count !== 0 || $exposure_count !== 0) {
                $result = $result->withStatus(JobResult::STATUS_OK);
            } else {
                $result = $result->withStatus(JobResult::STATUS_NO_ACTION);
            }
            return $result->withMessage(implode('<br>', $messages));
        } catch (\Exception $e) {
            return $result->withStatus(JobResult::STATUS_FAIL)
                          ->withMessage($e->getMessage());
        }
    }

References Vendor\Package\$e, ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher\findHarvestableObjectIDs(), ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher\publishObjects(), ILIAS\Repository\settings(), ILIAS\Cron\Job\JobResult\STATUS_FAIL, ILIAS\Cron\Job\JobResult\STATUS_NO_ACTION, ILIAS\Cron\Job\JobResult\STATUS_OK, ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher\updatePublishedObjects(), and ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher\withdrawDeprecatedObjects().

Here is the call graph for this function:

◆ updatePublishedObjects()

ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher::updatePublishedObjects ( )

protected

Returns number of changed published records.

Definition at line 187 of file AutomaticPublisher.php.

                                               : int
    {
        $count = 0;
 
        foreach ($this->exposed_record_repository->getRecords() as $record) {
            $obj_id = $record->infos()->objID();
            $ref_id = $this->status_repository->getHarvestRefID($obj_id);
 
            if (!$ref_id && $record->infos()->isDeleted()) {
                continue;
            }
 
            $simple_dc_xml = $this->xml_writer->writeSimpleDCMetaData(
                $obj_id,
                $ref_id,
                $this->object_handler->getTypeOfObject($obj_id)
            );
 
            if (
                $record->infos()->isDeleted() ||
                $simple_dc_xml->saveXML() !== $record->metadata()->saveXML()
            ) {
                // TODO should also be done by the publisher
                $this->logDebug('Updating exposed record for object with obj_id: ' . $obj_id);
                $this->exposed_record_repository->updateRecord($obj_id, false, $simple_dc_xml);
                $count++;
            }
        }
 
        $this->cleanUpDeletedRecords();
 
        return $count;
    }

References $ref_id.

Referenced by ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher\run().

Here is the caller graph for this function:

◆ withdrawDeprecatedObjects()

ILIAS\MetaData\OERHarvester\CronJob\AutomaticPublisher::withdrawDeprecatedObjects	(	array	$harvestable_obj_ids,
		array	$currently_harvested_obj_ids
	)

protected

Returns number of deletions.

Parameters

int[]	$harvestable_obj_ids
int[]	$currently_harvested_obj_ids

Definition at line 119 of file AutomaticPublisher.php.

     : int {
        $count = 0;
        foreach ($currently_harvested_obj_ids as $obj_id) {
            if (
                in_array($obj_id, $harvestable_obj_ids) &&
                $this->object_handler->doesReferenceExist($this->status_repository->getHarvestRefID($obj_id))
            ) {
                continue;
            }
 
            $this->logDebug('Withdrawing deprecated object with obj: ' . $obj_id);
            try {
                $this->publisher->withdraw($obj_id);
            } catch (\Exception $e) {
                $this->logError(
                    'Error when withdrawing from publishing object with obj_id ' .
                    $obj_id . ': ' . $e->getMessage()
                );
                continue;
            }
            $count++;
        }
        return $count;
    }