MarkupPlugin.inc.php

<?php
 
import('lib.pkp.classes.plugins.GenericPlugin');
 
class MarkupPlugin extends GenericPlugin {
   
   protected $_formatList = array('epub','xml','pdf');
 
   protected $_xmlConversionStages = array(WORKFLOW_STAGE_ID_SUBMISSION,WORKFLOW_STAGE_ID_INTERNAL_REVIEW,WORKFLOW_STAGE_ID_EXTERNAL_REVIEW,WORKFLOW_STAGE_ID_EDITING,WORKFLOW_STAGE_ID_PRODUCTION);
 
   public function getFormatList() {
      return $this->_formatList;
   }
 
   public function getXmlConversionStages() {
      return $this->_xmlConversionStages;
   }
 
   function getName() {
      return 'markupplugin';
   }
   
   function getDisplayName() {
      return __('plugins.generic.markup.displayName');
   }
   
   function getDescription() {
      return __('plugins.generic.markup.description');
   }
   
   
   function register($category, $path, $mainContextId = null) {
      
      if (parent::register($category, $path, $mainContextId)) {
         if ($this->getEnabled()) {
            $this->import('classes.MarkupJobInfoDAO');
 
            $markupJobInfoDao = new MarkupJobInfoDAO($this);
            DAORegistry::registerDAO('MarkupJobInfoDAO', $markupJobInfoDao);
 
            $request = $this->getRequest();
            $templateMgr = TemplateManager::getManager($request);
            $templateMgr->addStyleSheet(
               'markupBatchConvertStyle', 
               $this->getCssUrl($request).'/batch.css', 
               array('contexts' => 'backend')
            );
            $templateMgr->addJavaScript(
               'markupBatchConvertScript', 
               $this->getJsUrl($request).'/MarkupSubmissionsBatchConversionFormHandler.js',
               array('contexts' => 'backend')
            );
 
            // Register callbacks.
            HookRegistry::register('LoadHandler', array($this, 'callbackLoadMarkupHandler'));
            HookRegistry::register('LoadHandler', array($this, 'callbackLoadBatchHandler'));
            HookRegistry::register('TemplateManager::fetch', array($this, 'templateFetchCallback'));
            HookRegistry::register('PluginRegistry::loadCategory', array($this, 'callbackLoadCategory'));
            HookRegistry::register('Templates::Management::Settings::website', array($this, 'callbackShowWebsiteSettingsTabs'));
            HookRegistry::register('Templates::Management::Settings::website', array($this, 'callbackShowArticlesBatchConversionTabs'));
            HookRegistry::register('Templates::User::profile', array($this, 'callbackUserProfile'));
            HookRegistry::register('submissionfiledaodelegate::_deleteobject', array($this, 'callbackSubmissionFileDeleted'));
         }
         return true;
      }
      return false;
   }
   
   function callbackLoadCategory($hookName, $args) {
      $category = $args[0];
      $plugins =& $args[1];
      if ($category == 'gateways') {
         $this->import('MarkupGatewayPlugin');
         $gatewayPlugin = new MarkupGatewayPlugin($this->getName());
         $plugins[$gatewayPlugin->getSeq()][$gatewayPlugin->getPluginPath()] = $gatewayPlugin;
 
         // batch conversion
         $this->import('MarkupBatchGatewayPlugin');
         $batchGatewayPlugin = new MarkupBatchGatewayPlugin($this->getName());
         $plugins[$batchGatewayPlugin->getSeq()][$batchGatewayPlugin->getPluginPath()] = $batchGatewayPlugin;
      }
   }
   
   function getContextSpecificPluginSettingsFile() {
      return $this->getPluginPath() . '/settings.xml';
   }
   
   function getJsPath() {
      $baseDir = Core::getBaseDir();
      return $baseDir . '/' . parent::getPluginPath() . '/js/';
   }
   
   function getCssUrl($request) {
      return $request->getBaseUrl() . '/' . $this->getPluginPath() . '/css';
   }
   
   function getJsUrl($request) {
      return $request->getBaseUrl() . '/' . $this->getPluginPath() . '/js';
   }
 
   function getInstallSchemaFile() {
      return $this->getPluginPath() . '/schema.xml';
   }
 
   function getActions($request, $verb) {
      $dispatcher = $request->getDispatcher();
      import('lib.pkp.classes.linkAction.request.RedirectAction');
      return array_merge(
         $this->getEnabled()?array(
            new LinkAction(
               'settings',
               new RedirectAction($dispatcher->url(
                  $request, ROUTE_PAGE,
                  null, 'management', 'settings', 'website',
                  array('uid' => uniqid()), // Force reload
                  'markup' // Anchor for tab
               )),
               __('plugins.generic.markup.settings'),
               null
            ),
         ):array(),
         $this->getEnabled()?array(
            new LinkAction(
               'batch',
               new RedirectAction($dispatcher->url(
                  $request, ROUTE_PAGE,
                  null, 'management', 'settings', 'website',
                  array('uid' => uniqid()), // Force reload
                  'markupBatchConversion' // Anchor for tab
                  )),
               __('plugins.generic.markup.batch'),
               null
            ),
         ):array(),
         parent::getActions($request, $verb)
      );
   }
 
   function manage($args, $request) {
      
      $this->import('MarkupSettingsForm');
      $journal = $request->getJournal();
 
      switch ($request->getUserVar('verb')) {
         case 'settings':
            $context = $request->getContext();
            PKPLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON,  LOCALE_COMPONENT_PKP_MANAGER);
            $templateMgr = TemplateManager::getManager($request);
            $form = new MarkupSettingsForm($this, $context->getId());
            if ($request->getUserVar('save')) {
               $form->readInputData();
               if ($form->validate()) {
                  $form->execute();
                  $notificationManager = new NotificationManager();
                  $notificationManager->createTrivialNotification(
                     $request->getUser()->getId(),
                     NOTIFICATION_TYPE_SUCCESS,
                     array('contents' => __('plugins.generic.markup.settings.saved'))
                  );
                  return new JSONMessage(true);
               }
            } else {
               $form->initData();
            }
            return new JSONMessage(true, $form->fetch($request));
      }
      return parent::manage($args, $request);
   }
   
   public function callbackShowWebsiteSettingsTabs($hookName, $args) {
      $output =& $args[2];
      $request =& Registry::get('request');
      $dispatcher = $request->getDispatcher();
      $output .= '<li><a name="markup" href="' . $dispatcher->url($request, ROUTE_PAGE, null, 'markup', 'settings') . '">' . __('plugins.generic.markup.settings') . '</a></li>';
      return false;
   }
 
   public function callbackShowArticlesBatchConversionTabs($hookName, $args) {
      $output =& $args[2];
      $request =& Registry::get('request');
      $dispatcher = $request->getDispatcher();
      $output .= '<li><a name="markupBatchConversion" href="' . $dispatcher->url($request, ROUTE_PAGE, null, 'markup', 'batch') . '">' . __('plugins.generic.markup.batch') . '</a></li>';
      return false;
   }
 
   public function callbackLoadMarkupHandler($hookName, $args) {
      // Check the page.
      $page = $args[0];
      if ($page !== 'markup') return;
 
      // Check the operation.
      $op = $args[1];
 
      if ($op == 'settings') { // settings tab
         define('HANDLER_CLASS', 'MarkupSettingsTabHandler');
         $args[2] = $this->getPluginPath() . '/' . 'MarkupSettingsTabHandler.inc.php';
      }
      else {
         $publicOps = array(
            'convertToXml',
            'generateGalleyFiles',
            'profile',
            'triggerConversion',
            'fetchConversionJobStatus',
            'batch',
         );
 
         if (!in_array($op, $publicOps)) return;
 
         // Get the journal object from the context (optimized).
         $request = $this->getRequest();
         $router = $request->getRouter();
         $journal = $router->getContext($request); /* @var $journal Journal */
 
         // Looks as if our handler had been requested.
         define('HANDLER_CLASS', 'MarkupHandler');
 
         // set handler file path
         $args[2] = $this->getPluginPath() . '/' . 'MarkupHandler.inc.php';
      }
   }
 
   public function callbackLoadBatchHandler($hookName, $args) {
      // Check the page.
      $page = $args[0];
      if ($page !== 'batch') return;
 
      $op = $args[1];
      $publicOps = array('filesToConvert', 'startConversion', 'fetchConversionStatus', 'cancelConversion');
      if (!in_array($op, $publicOps)) return;
 
      define('HANDLER_CLASS', 'MarkupBatchConversionHandler');
      $args[2] = $this->getPluginPath() . '/' . 'MarkupBatchConversionHandler.inc.php';
   }
 
   public function templateFetchCallback($hookName, $params) {
      $request = $this->getRequest();
      $router = $request->getRouter();
      $dispatcher = $router->getDispatcher();
      $journal = $request->getJournal();
      $journalId = $journal->getId();
 
      $templateMgr = $params[0];
      $resourceName = $params[1];
      if ($resourceName == 'controllers/grid/gridRow.tpl') {
         $row = $templateMgr->get_template_vars('row');
         $data = $row->getData();
         if (is_array($data) && (isset($data['submissionFile']))) {
            $submissionFile = $data['submissionFile'];
            $fileExtension = strtolower($submissionFile->getExtension());
 
            // get stage ID
            $stage = $submissionFile->getFileStage();
            $stageId = (int) $request->getUserVar('stageId');
 
            if (in_array($fileExtension, array('doc','docx','odt','pdf', 'xml'))) {
 
               import('lib.pkp.classes.linkAction.request.AjaxModal');
 
               // get list of stages for "Convert to xml" feature.
               $xmlConversionStages = $this->getSetting($journalId, 'xmlConversionStages');
               if (in_array($stageId, $xmlConversionStages) && ($fileExtension != 'xml')) {
                  $row->addAction(new LinkAction(
                     'convert',
                     new AjaxModal(
                        $dispatcher->url($request, ROUTE_PAGE, null, 'markup', 'convertToXml', null, 
                              array(
                                 'submissionId' => $submissionFile->getSubmissionId(), 
                                 'fileId' => $submissionFile->getFileId(), 
                                 'stageId' => $stageId)
                              ),
                        __('plugins.generic.markup.modal.xmlConversion')
                     ),
                     __('plugins.generic.markup.links.convertToXml'),
                     null
                  ));
               }
 
               if ($stageId == WORKFLOW_STAGE_ID_PRODUCTION) {
                  $row->addAction(new LinkAction(
                     'generateGalleyFiles',
                     new AjaxModal(
                        $dispatcher->url($request, ROUTE_PAGE, null, 'markup', 'generateGalleyFiles', null, 
                              array(
                                 'submissionId' => $submissionFile->getSubmissionId(), 
                                 'fileId' => $submissionFile->getFileId(), 
                                 'stageId' => WORKFLOW_STAGE_ID_PRODUCTION)
                              ),
                        __('plugins.generic.markup.modal.galleyProduction')
                     ),
                     __('plugins.generic.markup.links.generateGalley'),
                     null
                  ));
               }
            }
         }
      }
   }
 
   public function fetchGateway($fileId, $stageId, $target) {
      $request = $this->getRequest();
      $user = $request->getUser();
 
      $router = $request->getRouter();
      $dispatcher = $router->getDispatcher();
      $journal = $request->getJournal();
 
      // Create an access key
      $this->import('classes.MarkupConversionHelper');
      $accessKey = MarkupConversionHelper::makeAccessToken($user);
      $jobId = MarkupConversionHelper::createConversionJobInfo($journal, $user, $fileId);
 
      $url = $request->url(null, 'gateway', 'plugin', 
         array('MarkupGatewayPlugin','fileId', $fileId, 'userId', $user->getId(), 
            'stageId', $stageId, 'jobId', $jobId, 'target', $target, 'accessKey', $accessKey)
      );
 
      $ch = curl_init();
      curl_setopt($ch, CURLOPT_URL, $url);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
      curl_setopt($ch, CURLOPT_TIMEOUT_MS, 1000);
      curl_exec($ch);
      curl_close($ch);
 
      return $jobId;
   }
 
   public function getOTSLoginParametersForJournal($journalId, $user = null) {
      // first we try to read from config file
      $this->import('classes.MarkupConversionHelper');
      $configCreds = MarkupConversionHelper::readCredentialsFromConfig();
      if (MarkupConversionHelper::canUseCredentialsFromConfig($configCreds)) {
         return $configCreds;
      }
 
      $authType = $this->getSetting($journalId, 'authType');
      switch ($authType) {
         case 'user':
            return array(
               'host' => $this->getSetting($journalId, 'markupHostURL'),
               'user' => isset($user) ? $user->getSetting('markupHostUser') : null,
               'password' => isset($user) ? $user->getSetting('markupHostPass') : null,
            );
 
         case 'site':
            return array(
               'host' => $this->getSetting($journalId, 'markupHostURL'),
               'user' => $this->getSetting($journalId, 'markupHostUser'),
               'password' => $this->getSetting($journalId, 'markupHostPass'),
            );
 
         default:
            return array(
               'host' => null,
               'user' => null,
               'password' => null,
            );
      }
   }
   
   public function callbackUserProfile($hookName, $params)
   {
      $request = $this->getRequest();
      $context = $request->getContext();
      $authType = $this->getSetting($context->getId(), 'authType');
 
      if ($authType == 'user') {
         $output =& $params[2];
         $dispatcher = $request->getDispatcher();
         $url = $dispatcher->url($request, ROUTE_PAGE, null, 'markup', 'profile');
 
         $output .= '<li><a name="otsServerCredentials" ' .
               'href="'.$url.'">' . __('plugins.generic.markup.tab.profile') . '</a></li>';
      }
 
      return false;
   }
 
   public function callbackSubmissionFileDeleted($hookName, $params)
   {
      if ((count($params) == 3) && isset($params[1]) 
            && is_array($params[1]) && count($params[1] == 2)) {
         $submissionFileId = $params[1][0];
         $markupJobInfoDao = DAORegistry::getDAO('MarkupJobInfoDAO');
         $markupJobInfoDao->deleteByFileId($submissionFileId);
      }
   }
}