CrossrefInfoSender.inc.php

<?php
 
import('lib.pkp.classes.scheduledTask.ScheduledTask');
 
 
class CrossrefInfoSender extends ScheduledTask {
   var $_plugin;
 
   function __construct($args) {
      PluginRegistry::loadCategory('importexport');
      $plugin = PluginRegistry::getPlugin('importexport', 'CrossRefExportPlugin'); /* @var $plugin CrossRefExportPlugin */
      $this->_plugin = $plugin;
 
      if (is_a($plugin, 'CrossRefExportPlugin')) {
         $plugin->addLocaleData();
      }
 
      parent::__construct($args);
   }
 
   function getName() {
      return __('plugins.importexport.crossref.senderTask.name');
   }
 
   function executeActions() {
      if (!$this->_plugin) return false;
 
      $plugin = $this->_plugin;
      $journals = $this->_getJournals();
 
      foreach ($journals as $journal) {
         $notify = false;
 
         $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $journal->getId());
         $doiPubIdPlugin = $pubIdPlugins['doipubidplugin'];
 
         if ($doiPubIdPlugin->getSetting($journal->getId(), 'enablePublicationDoi')) {
            // Get unregistered articles
            $unregisteredArticles = $plugin->getUnregisteredArticles($journal);
            // If there are articles to be deposited
            if (count($unregisteredArticles)) {
               $this->_registerObjects($unregisteredArticles, 'article=>crossref-xml', $journal, 'articles');
            }
         }
      }
      return true;
   }
 
   function _getJournals() {
      $plugin = $this->_plugin;
      $contextDao = Application::getContextDAO(); /* @var $contextDao JournalDAO */
      $journalFactory = $contextDao->getAll(true);
 
      $journals = array();
      while($journal = $journalFactory->next()) {
         $journalId = $journal->getId();
         if (!$plugin->getSetting($journalId, 'username') || !$plugin->getSetting($journalId, 'password') || !$plugin->getSetting($journalId, 'automaticRegistration')) continue;
 
         $doiPrefix = null;
         $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true, $journalId);
         if (isset($pubIdPlugins['doipubidplugin'])) {
            $doiPubIdPlugin = $pubIdPlugins['doipubidplugin'];
            if (!$doiPubIdPlugin->getSetting($journalId, 'enabled')) continue;
            $doiPrefix = $doiPubIdPlugin->getSetting($journalId, 'doiPrefix');
         }
 
         if ($doiPrefix) {
            $journals[] = $journal;
         } else {
            $this->addExecutionLogEntry(__('plugins.importexport.common.senderTask.warning.noDOIprefix', array('path' => $journal->getPath())), SCHEDULED_TASK_MESSAGE_TYPE_WARNING);
         }
      }
      return $journals;
   }
 
   function _registerObjects($objects, $filter, $journal, $objectsFileNamePart) {
      $plugin = $this->_plugin;
      import('lib.pkp.classes.file.FileManager');
      $fileManager = new FileManager();
      // The new Crossref deposit API expects one request per object.
      // On contrary the export supports bulk/batch object export, thus
      // also the filter expects an array of objects.
      // Thus the foreach loop, but every object will be in an one item array for
      // the export and filter to work.
      foreach ($objects as $object) {
         // export XML
         $exportXml = $plugin->exportXML(array($object), $filter, $journal);
         // Write the XML to a file.
         // export file name example: crossref-20160723-160036-articles-1-1.xml
         $objectsFileNamePartId = $objectsFileNamePart . '-' . $object->getId();
         $exportFileName = $plugin->getExportFileName($plugin->getExportPath(), $objectsFileNamePartId, $journal, '.xml');
         $fileManager->writeFile($exportFileName, $exportXml);
         // Deposit the XML file.
         $result = $plugin->depositXML($object, $journal, $exportFileName);
         if ($result !== true) {
            $this->_addLogEntry($result);
         }
         // Remove all temporary files.
         $fileManager->deleteByPath($exportFileName);
      }
   }
 
   function _addLogEntry($result) {
      if (is_array($result)) {
         foreach($result as $error) {
            assert(is_array($error) && count($error) >= 1);
            $this->addExecutionLogEntry(
               __($error[0], array('param' => (isset($error[1]) ? $error[1] : null))),
               SCHEDULED_TASK_MESSAGE_TYPE_WARNING
            );
         }
      }
   }
 
}