DOIPubIdPlugin.inc.php

<?php
 
import('classes.plugins.PubIdPlugin');
 
class DOIPubIdPlugin extends PubIdPlugin {
 
   public function register($category, $path, $mainContextId = null) {
      $success = parent::register($category, $path, $mainContextId);
      if (!Config::getVar('general', 'installed') || defined('RUNNING_UPGRADE')) return $success;
      if ($success && $this->getEnabled($mainContextId)) {
         HookRegistry::register('CitationStyleLanguage::citation', array($this, 'getCitationData'));
         HookRegistry::register('Publication::getProperties::summaryProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Publication::getProperties::fullProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Publication::validate', array($this, 'validatePublicationDoi'));
         HookRegistry::register('Issue::getProperties::summaryProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Issue::getProperties::fullProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Galley::getProperties::summaryProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Galley::getProperties::fullProperties', array($this, 'modifyObjectProperties'));
         HookRegistry::register('Publication::getProperties::values', array($this, 'modifyObjectPropertyValues'));
         HookRegistry::register('Issue::getProperties::values', array($this, 'modifyObjectPropertyValues'));
         HookRegistry::register('Galley::getProperties::values', array($this, 'modifyObjectPropertyValues'));
         HookRegistry::register('Form::config::before', array($this, 'addPublicationFormFields'));
         HookRegistry::register('Form::config::before', array($this, 'addPublishFormNotice'));
      }
      return $success;
   }
 
   //
   // Implement template methods from Plugin.
   //
   function getDisplayName() {
      return __('plugins.pubIds.doi.displayName');
   }
 
   function getDescription() {
      return __('plugins.pubIds.doi.description');
   }
 
 
   //
   // Implement template methods from PubIdPlugin.
   //
   function constructPubId($pubIdPrefix, $pubIdSuffix, $contextId) {
      return $pubIdPrefix . '/' . $pubIdSuffix;
   }
 
   function getPubIdType() {
      return 'doi';
   }
 
   function getPubIdDisplayType() {
      return 'DOI';
   }
 
   function getPubIdFullName() {
      return 'Digital Object Identifier';
   }
 
   function getResolvingURL($contextId, $pubId) {
      return 'https://doi.org/'.$this->_doiURLEncode($pubId);
   }
 
   function getPubIdMetadataFile() {
      return $this->getTemplateResource('doiSuffixEdit.tpl');
   }
 
   function getPubIdAssignFile() {
      return $this->getTemplateResource('doiAssign.tpl');
   }
 
   function instantiateSettingsForm($contextId) {
      $this->import('classes.form.DOISettingsForm');
      return new DOISettingsForm($this, $contextId);
   }
 
   function getFormFieldNames() {
      return array('doiSuffix');
   }
 
   function getAssignFormFieldName() {
      return 'assignDoi';
   }
 
   function getPrefixFieldName() {
      return 'doiPrefix';
   }
 
   function getSuffixFieldName() {
      return 'doiSuffix';
   }
 
   function getLinkActions($pubObject) {
      $linkActions = array();
      import('lib.pkp.classes.linkAction.request.RemoteActionConfirmationModal');
      $request = Application::get()->getRequest();
      $userVars = $request->getUserVars();
      $userVars['pubIdPlugIn'] = get_class($this);
      // Clear object pub id
      $linkActions['clearPubIdLinkActionDoi'] = new LinkAction(
         'clearPubId',
         new RemoteActionConfirmationModal(
            $request->getSession(),
            __('plugins.pubIds.doi.editor.clearObjectsDoi.confirm'),
            __('common.delete'),
            $request->url(null, null, 'clearPubId', null, $userVars),
            'modal_delete'
         ),
         __('plugins.pubIds.doi.editor.clearObjectsDoi'),
         'delete',
         __('plugins.pubIds.doi.editor.clearObjectsDoi')
      );
 
      if (is_a($pubObject, 'Issue')) {
         // Clear issue objects pub ids
         $linkActions['clearIssueObjectsPubIdsLinkActionDoi'] = new LinkAction(
            'clearObjectsPubIds',
            new RemoteActionConfirmationModal(
               $request->getSession(),
               __('plugins.pubIds.doi.editor.clearIssueObjectsDoi.confirm'),
               __('common.delete'),
               $request->url(null, null, 'clearIssueObjectsPubIds', null, $userVars),
               'modal_delete'
            ),
            __('plugins.pubIds.doi.editor.clearIssueObjectsDoi'),
            'delete',
            __('plugins.pubIds.doi.editor.clearIssueObjectsDoi')
         );
      }
 
      return $linkActions;
   }
 
   function getSuffixPatternsFieldNames() {
      return  array(
         'Issue' => 'doiIssueSuffixPattern',
         'Publication' => 'doiPublicationSuffixPattern',
         'Representation' => 'doiRepresentationSuffixPattern'
      );
   }
 
   function getDAOFieldNames() {
      return array('pub-id::doi');
   }
 
   function isObjectTypeEnabled($pubObjectType, $contextId) {
      return (boolean) $this->getSetting($contextId, "enable${pubObjectType}Doi");
   }
 
   function getNotUniqueErrorMsg() {
      return __('plugins.pubIds.doi.editor.doiSuffixCustomIdentifierNotUnique');
   }
 
   function validatePubId($pubId) {
      return preg_match('/^\d+(.\d+)+\//', $pubId);
   }
 
   /*
    * Public methods
    */
   public function getCitationData($hookname, $args) {
      $citationData = $args[0];
      $article = $args[2];
      $issue = $args[3];
      $journal = $args[4];
 
      if ($issue && $issue->getPublished()) {
         $pubId = $article->getStoredPubId($this->getPubIdType());
      } else {
         $pubId = $this->getPubId($article);
      }
 
      if (!$pubId) {
         return;
      }
 
      $citationData->DOI = $pubId;
   }
 
 
   /*
    * Private methods
    */
   function _doiURLEncode($pubId) {
      $search = array ('%', '"', '#', ' ', '<', '>', '{');
      $replace = array ('%25', '%22', '%23', '%20', '%3c', '%3e', '%7b');
      $pubId = str_replace($search, $replace, $pubId);
      return $pubId;
   }
 
   public function validatePublicationDoi($hookName, $args) {
      $errors =& $args[0];
      $action = $args[1];
      $props =& $args[2];
 
      if (empty($props['pub-id::doi'])) {
         return;
      }
 
      if ($action === VALIDATE_ACTION_ADD) {
         $submission = Services::get('submission')->get($props['submissionId']);
      } else {
         $publication = Services::get('publication')->get($props['id']);
         $submission = Services::get('submission')->get($publication->getData('submissionId'));
      }
 
      $contextId = $submission->getData('contextId');
      $doiPrefix = $this->getSetting($contextId, 'doiPrefix');
 
      $doiErrors = [];
      if (strpos($props['pub-id::doi'], $doiPrefix) !== 0) {
         $doiErrors[] = __('plugins.pubIds.doi.editor.missingPrefix', ['doiPrefix' => $doiPrefix]);
      }
      if (!$this->checkDuplicate($props['pub-id::doi'], 'Publication', $submission->getId(), $contextId)) {
         $doiErrors[] = $this->getNotUniqueErrorMsg();
      }
      if (!empty($doiErrors)) {
         $errors['pub-id::doi'] = $doiErrors;
      }
   }
 
   public function modifyObjectProperties($hookName, $args) {
      $props =& $args[0];
 
      $props[] = 'pub-id::doi';
   }
 
   public function modifyObjectPropertyValues($hookName, $args) {
      $values =& $args[0];
      $object = $args[1];
      $props = $args[2];
 
      // DOIs are not supported for IssueGalleys
      if (get_class($object) === 'IssueGalley') {
         return;
      }
 
      // DOIs are already added to property values for Publications and Galleys
      if (get_class($object) === 'Publication' || get_class($object) === 'ArticleGalley') {
         return;
      }
 
      if (in_array('pub-id::doi', $props)) {
         $pubId = $this->getPubId($object);
         $values['pub-id::doi'] = $pubId ? $pubId : null;
      }
   }
 
   public function addPublicationFormFields($hookName, $form) {
 
      if ($form->id !== 'publicationIdentifiers') {
         return;
      }
 
      if (!$this->getSetting($form->submissionContext->getId(), 'enablePublicationDoi')) {
         return;
      }
 
      $prefix = $this->getSetting($form->submissionContext->getId(), 'doiPrefix');
 
      $suffixType = $this->getSetting($form->submissionContext->getId(), 'doiSuffix');
      $pattern = '';
      if ($suffixType === 'default') {
         $pattern = '%j.v%vi%i.%a';
      } elseif ($suffixType === 'pattern') {
         $pattern = $this->getSetting($form->submissionContext->getId(), 'doiPublicationSuffixPattern');
      }
 
      // Add a text field to enter the DOI if no pattern exists
      if (!$pattern) {
         $form->addField(new \PKP\components\forms\FieldText('pub-id::doi', [
            'label' => __('metadata.property.displayName.doi'),
            'description' => __('plugins.pubIds.doi.editor.doi.description', ['prefix' => $prefix]),
            'value' => $form->publication->getData('pub-id::doi'),
         ]));
      } else {
         $fieldData = [
            'label' => __('metadata.property.displayName.doi'),
            'value' => $form->publication->getData('pub-id::doi'),
            'prefix' => $prefix,
            'pattern' => $pattern,
            'contextInitials' => PKPString::regexp_replace('/[^A-Za-z0-9]/', '', PKPString::strtolower($form->submissionContext->getData('acronym', $form->submissionContext->getData('primaryLocale')))) ?? '',
            'separator' => '/',
            'submissionId' => $form->publication->getData('submissionId'),
            'assignIdLabel' => __('plugins.pubIds.doi.editor.doi.assignDoi'),
            'clearIdLabel' => __('plugins.pubIds.doi.editor.clearObjectsDoi'),
         ];
         if ($form->publication->getData('pub-id::publisher-id')) {
            $fieldData['publisherId'] = $form->publication->getData('pub-id::publisher-id');
         }
         if ($form->publication->getData('pages')) {
            $fieldData['pages'] = $form->publication->getData('pages');
         }
         if ($form->publication->getData('issueId')) {
            $issue = Services::get('issue')->get($form->publication->getData('issueId'));
            if ($issue) {
               $fieldData['issueNumber'] = $issue->getNumber() ?? '';
               $fieldData['issueVolume'] = $issue->getVolume() ?? '';
               $fieldData['year'] = $issue->getYear() ?? '';
            }
         }
         if ($suffixType === 'default') {
            $fieldData['missingPartsLabel'] = __('plugins.pubIds.doi.editor.missingIssue');
         } else  {
            $fieldData['missingPartsLabel'] = __('plugins.pubIds.doi.editor.missingParts');
         }
         $form->addField(new \PKP\components\forms\FieldPubId('pub-id::doi', $fieldData));
      }
   }
 
   public function addPublishFormNotice($hookName, $form) {
 
      if ($form->id !== 'publish' || !empty($form->errors)) {
         return;
      }
 
      $submission = Services::get('submission')->get($form->publication->getData('submissionId'));
      $publicationDoiEnabled = $this->getSetting($submission->getData('contextId'), 'enablePublicationDoi');
      $galleyDoiEnabled = $this->getSetting($submission->getData('contextId'), 'enableRepresentationDoi');
      $warningIconHtml = '<span class="fa fa-exclamation-triangle pkpIcon--inline"></span>';
 
      if (!$publicationDoiEnabled && !$galleyDoiEnabled) {
         return;
 
      // Use a simplified view when only assigning to the publication
      } else if (!$galleyDoiEnabled) {
         if ($form->publication->getData('pub-id::doi')) {
            $msg = __('plugins.pubIds.doi.editor.preview.publication', ['doi' => $form->publication->getData('pub-id::doi')]);
         } else {
            $msg = '<div class="pkpNotification pkpNotification--warning">' . $warningIconHtml . __('plugins.pubIds.doi.editor.preview.publication.none') . '</div>';
         }
         $form->addField(new \PKP\components\forms\FieldHTML('doi', [
            'description' => $msg,
            'groupId' => 'default',
         ]));
         return;
 
      // Show a table if more than one DOI is going to be created
      } else {
         $doiTableRows = [];
         if ($publicationDoiEnabled) {
            if ($form->publication->getData('pub-id::doi')) {
               $doiTableRows[] = [$form->publication->getData('pub-id::doi'), 'Publication'];
            } else {
               $doiTableRows[] = [$warningIconHtml . __('submission.status.unassigned'), 'Publication'];
            }
         }
         if ($galleyDoiEnabled) {
            foreach ((array) $form->publication->getData('galleys') as $galley) {
               if ($galley->getStoredPubId('doi')) {
                  $doiTableRows[] = [$galley->getStoredPubId('doi'), __('plugins.pubIds.doi.editor.preview.galleys', ['galleyLabel' => $galley->getGalleyLabel()])];
               } else {
                  $doiTableRows[] = [$warningIconHtml . __('submission.status.unassigned'),__('plugins.pubIds.doi.editor.preview.galleys', ['galleyLabel' => $galley->getGalleyLabel()])];
               }
            }
         }
         if (!empty($doiTableRows)) {
            $table = '<table class="pkpTable"><thead><tr>' .
               '<th>' . __('plugins.pubIds.doi.editor.doi') . '</th>' .
               '<th>' . __('plugins.pubIds.doi.editor.preview.objects') . '</th>' .
               '</tr></thead><tbody>';
            foreach ($doiTableRows as $doiTableRow) {
               $table .= '<tr><td>' . $doiTableRow[0] . '</td><td>' . $doiTableRow[1] . '</td></tr>';
            }
            $table .= '</tbody></table>';
         }
         $form->addField(new \PKP\components\forms\FieldHTML('doi', [
            'description' => $table,
            'groupId' => 'default',
         ]));
      }
   }
}