CrossrefReferenceLinkingInfoSender.inc.php

<?php

/**
 * @file CrossrefReferenceLinkingInfoSender.php
 *
 * Copyright (c) 2013-2021 Simon Fraser University
 * Copyright (c) 2003-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file LICENSE.
 *
 * @class CrossrefReferenceLinkingInfoSender
 * @ingroup plugins_generic_crossrefReferenceLinking
 *
 * @brief Scheduled task to check for found Crossref references DOIs.
 */

import('lib.pkp.classes.scheduledTask.ScheduledTask');


class CrossrefReferenceLinkingInfoSender extends ScheduledTask {
	/** @var $_plugin CrossrefReferenceLinkingPlugin */
	var $_plugin;

	/**
	 * Constructor.
	 * @param $args array task arguments
	 */
	function __construct($args) {
		PluginRegistry::loadCategory('generic');
		$plugin = PluginRegistry::getPlugin('generic', 'crossrefreferencelinkingplugin'); /** @var $plugin CrossrefReferenceLinkingPlugin */

		$this->_plugin = $plugin;

		if (is_a($plugin, 'CrossrefReferenceLinkingPlugin')) {
			$plugin->addLocaleData();
		}

		parent::__construct($args);
	}

	/**
	 * @copydoc ScheduledTask::getName()
	 */
	function getName() {
		return __('plugins.generic.crossrefReferenceLinking.senderTask.name');
	}

	/**
	 * @copydoc ScheduledTask::executeActions()
	 */
	function executeActions() {
		if (!$this->_plugin) return false;

		$plugin = $this->_plugin;
		$journals = $this->_getJournals();

		foreach ($journals as $journal) {
			// Call the plugin register function, in order to be able to save the new article and citation settings in the DB
			$plugin->register('generic', $plugin->getPluginPath(), $journal->getId());
			// Get published articles to check
			$submissionsToCheck = $plugin->getSubmissionsToCheck($journal);
			foreach ($submissionsToCheck as $submissionToCheck) { /** @var $submissionToCheck Submission */
				$plugin->getCrossrefReferencesDOIs($submissionToCheck->getCurrentPublication());
			}
		}
		return true;
	}

	/**
	 * Get all journals that meet the requirements to have
	 * their articles or issues DOIs sent to Crossref.
	 * @return array
	 */
	function _getJournals() {
		PluginRegistry::loadCategory('importexport');
		$crossrefExportPlugin = PluginRegistry::getPlugin('importexport', 'CrossRefExportPlugin');

		$contextDao = Application::getContextDAO(); /** @var $contextDao JournalDAO */
		$journalFactory = $contextDao->getAll(true);
		$journals = array();
		while($journal = $journalFactory->next()) {
			$journalId = $journal->getId();
			if ($this->_plugin->citationsEnabled($journalId) &&
				$crossrefExportPlugin->getSetting($journalId, 'username') &&
				$crossrefExportPlugin->getSetting($journalId, 'password')) {
					$journals[] = $journal;
			}
		}

		return $journals;
	}
}