SwordImportExportPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.ImportExportPlugin');
 
class SwordImportExportPlugin extends ImportExportPlugin {
   protected $_parentPlugin = null;
 
   public function __construct($parentPlugin) {
      parent::__construct();
      $this->_parentPlugin = $parentPlugin;
   }
 
   public function register($category, $path, $mainContextId = null) {
      $success = parent::register($category, $path, $mainContextId);
      $this->addLocaleData();
      return $success;
   }
 
   public function getSwordPlugin() {
      return $this->_parentPlugin;
   }
 
   public function getName() {
      return 'SwordImportExportPlugin';
   }
 
   function getPluginPath() {
      return $this->_parentPlugin->getPluginPath();
   }
 
   public function getDisplayName() {
      return __('plugins.importexport.sword.displayName');
   }
 
   public function getDescription() {
      return __('plugins.importexport.sword.description');
   }
 
   public function display($args, $request) {
      parent::display($args, $request);
      $templateMgr = TemplateManager::getManager($request);
      $context = $request->getContext();
      switch (array_shift($args)) {
         case 'index':
         case '':
            $this->getSwordPlugin()->import('classes.DepositPoint');
            $depositPointDao = DAORegistry::getDAO('DepositPointDAO');
            $depositPoints = $depositPointDao->getByContextId($context->getId(), null, SWORD_DEPOSIT_TYPE_MANAGER);
            $depositPointsData = array('' => __('common.select'));
            while ($depositPoint = $depositPoints->next()) {
               $depositPointsData[$depositPoint->getId()] = $depositPoint->getLocalizedName();
            }
            $dispatcher = $request->getDispatcher();
            $settingUrl = $dispatcher->url(
               $request, ROUTE_PAGE,
               null, 'management', 'settings', 'website',
               array(),
               'swordSettings'
            );
 
            $selectSubmissionsListPanel = new \PKP\components\listPanels\PKPSelectSubmissionsListPanel(
               'selectSubmissionsListPanel',
               'select submissions panel',
               [
                  'apiUrl' => $request->getDispatcher()->url(
                     $request,
                     ROUTE_API,
                     $context->getPath(),
                     '_submissions'
                  ),
                  'canSelect' => true,
                  'canSelectAll' => true,
                  'count' => 100,
                  'lazyLoad' => true,
                  'selectorName' => 'selectedSubmissions[]',
               ]
            );
            $templateMgr->assign(array(
               'selectedDepositPoint'     => $request->getUserVar('selectedDepositPoint'),
               'depositEditorial'      => $request->getUserVar('depositEditorial'),
               'depositGalleys'     => $request->getUserVar('depositGalleys'),
               'swordSettingsPageUrl'     => $settingUrl,
               'depositPoints'      => $depositPointsData,
               'pluginJavaScriptURL'      => $this->getSwordPlugin()->getJsUrl($request),
               'selectSubmissionsListData' => [
                  'components' => [
                     'selectSubmissionsListPanel' => $selectSubmissionsListPanel->getConfig()
                  ]
               ],
               'usingApi' => true,
               ));
 
            $script = '$(document).data("depositedIdMap", '. json_encode($depositedIds) .');';
            $templateMgr->addJavaScript('depositedIds', $script, ['inline' => true, 'contexts' => 'backend']);
            $templateMgr->addJavaScript(
               'disableDepositedIds',
               $this->getSwordPlugin()->getJsUrl($request) .'/SwordDisableDepositedItems.js',
               ['contexts' => 'backend']);
 
            $templateMgr->display($this->getTemplateResource('submissions.tpl'));
            break;
 
         case 'deposit':
            $context = $request->getContext();
            $submissionDao = Application::getSubmissionDAO();
            $this->getSwordPlugin()->import('classes.PKPSwordDeposit');
            $depositPointId = $request->getUserVar('depositPoint');
            $password = $request->getUserVar('swordPassword');
            if ($password == SWORD_PASSWORD_SLUG) {
               $depositPointDao = DAORegistry::getDAO('DepositPointDAO');
               $depositPoint = $depositPointDao->getById($depositPointId, $context->getId());
               if ($depositPoint) {
                  $password = $depositPoint->getSwordPassword();
               }
            }
 
            $swordDepositPoint = $request->getUserVar('swordDepositPoint');
            $depositEditorial = $request->getUserVar('depositEditorial');
            $depositGalleys = $request->getUserVar('depositGalleys');
            $username = $request->getUserVar('swordUsername');
            $depositIds = array();
 
            $backLink = $request->url(
               null, null, null,
               array('plugin', $this->getName()),
               array(
                  'selectedDepositPoint' => $depositPointId,
                  'depositEditorial' => $depositEditorial,
                  'depositGalleys' => $depositGalleys,
               )
            );
 
            $errors = array();
 
            $submissionIds = $request->getUserVar('selectedSubmissions');
            // select at least one submission
            if (empty($submissionIds)) {
               $errors[] = array(
                  'title' => __('plugins.importexport.sword.requiredFieldErrorTitle'),
                  'message' => __('plugins.importexport.sword.requiredFieldErrorMessage'),
               );
            }
            else {
               foreach ($submissionIds as $submissionId) {
                  $submission = $submissionDao->getById($submissionId);
                  if ($submission->getContextId() != $request->getContext()->getId()) {
                     continue;
                  }
                  try {
                     $deposit = new PKPSwordDeposit($submission);
                     $deposit->setMetadata($request);
                     if ($depositGalleys) $deposit->addGalleys();
                     if ($depositEditorial) $deposit->addEditorial();
                     $deposit->createPackage();
                     $response = $deposit->deposit(
                        $swordDepositPoint,
                        $username,
                        $password,
                        $request->getUserVar('swordApiKey'));
 
                     $stmt_link = array_shift(
                        array_filter($response->sac_links, function($link) {
                           return $link->sac_linkrel == 'http://purl.org/net/sword/terms/statement' || $link->sac_linkrel == 'http://purl.org/net/sword/terms/add';
                        }));
                     $stmt_href = $stmt_link->sac_linkhref->__toString();
                     $data = $submission->getAllData();
                     $ssi = [];
                     if (array_has($data, 'swordStatementIri')) {
                        $ssi = unserialize($data['swordStatementIri'], true);
                     }
                     $ssi[$depositPointId] = $stmt_href;
                     $submission->setData('swordStatementIri', serialize($ssi));
                     $submissionDao->updateDataObjectSettings(
                        'submission_settings', $submission, ['submission_id' => $submissionId]);
                     $deposit->cleanup();
                     $depositIds[] = $response->sac_id;
                  }
                  catch (Exception $e) {
                     $errors[] = array(
                        'title' => $submission->getLocalizedTitle(),
                        'message' => $e->getMessage(),
                     );
                  }
               }
            }
 
            if (!empty($errors)) {
               $errorMessage = '<dl>';
               foreach ($errors as $error) {
                  $errorMessage .= "<dt>" . htmlentities($error['title']) . "</dt>";
                  $errorMessage .= "<dd>" . htmlentities($error['message']) . "</dd>";
               }
               $errorMessage .= '</dl>';
               $templateMgr->assign(array(
                  'title' => __('plugins.importexport.sword.depositFailed'),
                  'messageTranslated' => $errorMessage,
                  'backLink' => $backLink,
                  'backLinkLabel' => 'common.back'
               ));
            }
            else {
               $templateMgr->assign(array(
                  'title' => __('plugins.importexport.sword.depositSuccessful'),
                  'message' => 'plugins.importexport.sword.depositSuccessfulDescription',
                  'backLink' => $backLink,
                  'backLinkLabel' => 'common.continue'
               ));
            }
            $messageTemplateFile = $this->getSwordPlugin()->getTemplateResource('message.tpl');
            $output = $templateMgr->fetch($messageTemplateFile);
            return new JSONMessage(true, $output);
            break;
         default:
            $dispatcher = $request->getDispatcher();
            $dispatcher->handle404();
      }
   }
 
   public function executeCLI($scriptName, &$args) {
      throw new Exception('SWORD plugin command-line import/export not yet implemented!');
   }
 
   public function usage($scriptName) {
   }
}