ManageFileApiHandler.inc.php

<?php
 
// Import the base handler.
import('lib.pkp.controllers.api.file.PKPManageFileApiHandler');
import('lib.pkp.classes.core.JSONMessage');
 
class ManageFileApiHandler extends PKPManageFileApiHandler {
 
   function __construct() {
      parent::__construct();
      $this->addRoleAssignment(
         array(ROLE_ID_MANAGER, ROLE_ID_SUB_EDITOR, ROLE_ID_ASSISTANT, ROLE_ID_REVIEWER, ROLE_ID_AUTHOR),
         array('identifiers', 'updateIdentifiers', 'clearPubId',)
      );
   }
 
   function identifiers($args, $request) {
      $submissionFile = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION_FILE);
      $stageId = $request->getUserVar('stageId');
      import('controllers.tab.pubIds.form.PublicIdentifiersForm');
      $form = new PublicIdentifiersForm($submissionFile, $stageId);
      $form->initData();
      return new JSONMessage(true, $form->fetch($request));
   }
 
   function updateIdentifiers($args, $request) {
      $submissionFile = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION_FILE);
      $stageId = $request->getUserVar('stageId');
      import('controllers.tab.pubIds.form.PublicIdentifiersForm');
      $form = new PublicIdentifiersForm($submissionFile, $stageId);
      $form->readInputData();
      if ($form->validate()) {
         $form->execute();
         return DAO::getDataChangedEvent($submissionFile->getId());
      } else {
         return new JSONMessage(true, $form->fetch($request));
      }
   }
 
   function clearPubId($args, $request) {
      if (!$request->checkCSRF()) return new JSONMessage(false);
 
      $submissionFile = $this->getAuthorizedContextObject(ASSOC_TYPE_SUBMISSION_FILE);
      $stageId = $request->getUserVar('stageId');
      import('controllers.tab.pubIds.form.PublicIdentifiersForm');
      $form = new PublicIdentifiersForm($submissionFile, $stageId);
      $form->clearPubId($request->getUserVar('pubIdPlugIn'));
      return new JSONMessage(true);
   }
 
   //
   // Subclassed methods
   //
   function removeFileIndex($submission, $submissionFile) {
      // update the submission's search index if this was a proof file
      if ($submissionFile->getFileStage() == SUBMISSION_FILE_PROOF) {
         import('lib.pkp.classes.search.SubmissionSearch');
         $articleSearchIndex = Application::getSubmissionSearchIndex();
         $articleSearchIndex->deleteTextIndex($submission->getId(), SUBMISSION_SEARCH_GALLEY_FILE, $submissionFile->getFileId());
      }
   }
 
   function logDeletionEvent($request, $submission, $submissionFile, $user) {
      // log the deletion event.
      import('lib.pkp.classes.log.SubmissionFileLog');
      import('lib.pkp.classes.log.SubmissionFileEventLogEntry'); // constants
 
      if ($submissionFile->getRevision() > 1) {
         SubmissionFileLog::logEvent($request, $submissionFile, SUBMISSION_LOG_FILE_REVISION_DELETE, 'submission.event.revisionDeleted', array('fileStage' => $submissionFile->getFileStage(), 'sourceFileId' => $submissionFile->getSourceFileId(), 'fileId' => $submissionFile->getFileId(), 'fileRevision' => $submissionFile->getRevision(), 'originalFileName' => $submissionFile->getOriginalFileName(), 'submissionId' => $submissionFile->getSubmissionId(), 'username' => $user->getUsername()));
      } else {
         SubmissionFileLog::logEvent($request, $submissionFile, SUBMISSION_LOG_FILE_DELETE, 'submission.event.fileDeleted', array('fileStage' => $submissionFile->getFileStage(), 'sourceFileId' => $submissionFile->getSourceFileId(), 'fileId' => $submissionFile->getFileId(), 'fileRevision' => $submissionFile->getRevision(), 'originalFileName' => $submissionFile->getOriginalFileName(), 'submissionId' => $submissionFile->getSubmissionId(), 'username' => $user->getUsername()));
      }
 
      if ($submissionFile->getRevision() == 1 && $submissionFile->getSourceFileId() == null) {
         import('lib.pkp.classes.log.SubmissionLog');
         import('classes.log.SubmissionEventLogEntry'); // constants
         SubmissionLog::logEvent($request, $submission, SUBMISSION_LOG_LAST_REVISION_DELETED, 'submission.event.lastRevisionDeleted', array('title' => $submissionFile->getOriginalFileName(), 'submissionId' => $submissionFile->getSubmissionId(), 'username' => $user->getUsername()));
      }
 
   }
 
   function detachEntities($submissionFile, $submissionId, $stageId) {
      parent::detachEntities($submissionFile, $submissionId, $stageId);
 
      switch ($submissionFile->getFileStage()) {
         case SUBMISSION_FILE_PROOF:
            $galleyDao = DAORegistry::getDAO('ArticleGalleyDAO'); /* @var $galleyDao ArticleGalleyDAO */
            assert($submissionFile->getAssocType() == ASSOC_TYPE_REPRESENTATION);
            $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
            $allRevisions = $submissionFileDao->getAllRevisionsByAssocId(ASSOC_TYPE_REPRESENTATION, $submissionFile->getAssocId());
            $galley = $galleyDao->getById($submissionFile->getAssocId());
            if ($galley) {
               if (count($allRevisions) <= 1) {
                  $galley->_data['fileId'] = null; // Work around pkp/pkp-lib#5740
                  $galleyDao->updateObject($galley);
               }
            }
            break;
      }
   }
}