DOIPubIdExportPlugin.inc.php

<?php
 
import('classes.plugins.PubObjectsExportPlugin');
 
// Configuration errors.
define('DOI_EXPORT_CONFIG_ERROR_DOIPREFIX', 0x01);
 
// The name of the setting used to save the registered DOI.
define('DOI_EXPORT_REGISTERED_DOI', 'registeredDoi');
 
abstract class DOIPubIdExportPlugin extends PubObjectsExportPlugin {
   function display($args, $request) {
      parent::display($args, $request);
      $context = $request->getContext();
      switch (array_shift($args)) {
         case 'index':
         case '':
            $templateMgr = TemplateManager::getManager($request);
            // Check for configuration errors:
            $configurationErrors = $templateMgr->getTemplateVars('configurationErrors');
            // missing DOI prefix
            $doiPrefix = null;
            $pubIdPlugins = PluginRegistry::loadCategory('pubIds', true);
            if (isset($pubIdPlugins['doipubidplugin'])) {
               $doiPlugin = $pubIdPlugins['doipubidplugin'];
               $doiPrefix = $doiPlugin->getSetting($context->getId(), $doiPlugin->getPrefixFieldName());
               $templateMgr->assign(array(
                  'exportArticles' => $doiPlugin->getSetting($context->getId(), 'enablePublicationDoi'),
                  'exportIssues' => $doiPlugin->getSetting($context->getId(), 'enableIssueDoi'),
                  'exportRepresentations' => $doiPlugin->getSetting($context->getId(), 'enableRepresentationDoi'),
               ));
            }
            if (empty($doiPrefix)) {
               $configurationErrors[] = DOI_EXPORT_CONFIG_ERROR_DOIPREFIX;
            }
            $templateMgr->display($this->getTemplateResource('index.tpl'));
            break;
      }
   }
 
   function getPubIdType() {
      return 'doi';
   }
 
   function getPubIdDisplayType() {
      return 'DOI';
   }
 
   function markRegistered($context, $objects) {
      foreach ($objects as $object) {
         $object->setData($this->getDepositStatusSettingName(), EXPORT_STATUS_MARKEDREGISTERED);
         $this->saveRegisteredDoi($context, $object);
      }
   }
 
   function saveRegisteredDoi($context, $object, $testPrefix = '10.1234') {
      $registeredDoi = $object->getStoredPubId('doi');
      assert(!empty($registeredDoi));
      if ($this->isTestMode($context)) {
         $registeredDoi = PKPString::regexp_replace('#^[^/]+/#', $testPrefix . '/', $registeredDoi);
      }
      $object->setData($this->getPluginSettingsPrefix() . '::' . DOI_EXPORT_REGISTERED_DOI, $registeredDoi);
      $this->updateObject($object);
   }
 
   protected function _getObjectAdditionalSettings() {
      return array_merge(parent::_getObjectAdditionalSettings(), array(
         $this->getPluginSettingsPrefix() . '::' . DOI_EXPORT_REGISTERED_DOI
      ));
   }
 
   function getUnregisteredArticles($context) {
      // Retrieve all published submissions that have not yet been registered.
      $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
      $articles = $submissionDao->getExportable(
         $context->getId(),
         $this->getPubIdType(),
         null,
         null,
         null,
         $this->getPluginSettingsPrefix(). '::' . DOI_EXPORT_REGISTERED_DOI,
         null,
         null
      );
      return $articles->toArray();
   }
 
   function getUnregisteredIssues($context) {
      // Retrieve all issues that have not yet been registered.
      $issueDao = DAORegistry::getDAO('IssueDAO'); /* @var $issueDao IssueDAO */
      $issuesFactory = $issueDao->getExportable(
         $context->getId(),
         $this->getPubIdType(),
         $this->getPluginSettingsPrefix(). '::' . DOI_EXPORT_REGISTERED_DOI,
         null,
         null
      );
      $issues = $issuesFactory->toArray();
      // Cache issues.
      $cache = $this->getCache();
      foreach ($issues as $issue) {
         $cache->add($issue, null);
         unset($issue);
      }
      return $issues;
   }
 
   function getUnregisteredGalleys($context) {
      // Retrieve all galleys that have not yet been registered.
      $galleyDao = DAORegistry::getDAO('ArticleGalleyDAO'); /* @var $galleyDao ArticleGalleyDAO */
      $galleys = $galleyDao->getExportable(
         $context?$context->getId():null,
         $this->getPubIdType(),
         null,
         null,
         null,
         $this->getPluginSettingsPrefix(). '::' . DOI_EXPORT_REGISTERED_DOI,
         null,
         null
      );
      return $galleys->toArray();
   }
 
   function getPublishedSubmissions($submissionIds, $context) {
      $submissions = array_map(function($submissionId) {
         return Services::get('submission')->get($submissionId);
      }, $submissionIds);
      return array_filter($submissions, function($submission) {
         return $submission->getData('status') === STATUS_PUBLISHED && !!$submission->getStoredPubId('doi');
      });
   }
 
   function getPublishedIssues($issueIds, $context) {
      $publishedIssues = array();
      $issueDao = DAORegistry::getDAO('IssueDAO'); /* @var $issueDao IssueDAO */
      foreach ($issueIds as $issueId) {
         $publishedIssue = $issueDao->getById($issueId, $context->getId());
         if ($publishedIssue && $publishedIssue->getStoredPubId('doi')) $publishedIssues[] = $publishedIssue;
      }
      return $publishedIssues;
   }
 
   function getArticleGalleys($galleyIds) {
      $galleys = array();
      $articleGalleyDao = DAORegistry::getDAO('ArticleGalleyDAO'); /* @var $articleGalleyDao ArticleGalleyDAO */
      foreach ($galleyIds as $galleyId) {
         $articleGalley = $articleGalleyDao->getById($galleyId);
         if ($articleGalley && $articleGalley->getStoredPubId('doi')) $galleys[] = $articleGalley;
      }
      return $galleys;
   }
}