PKPSubmissionDAO.inc.php

<?php
 
import('lib.pkp.classes.submission.PKPSubmission');
import('lib.pkp.classes.db.SchemaDAO');
import('lib.pkp.classes.services.PKPSchemaService'); // SCHEMA_ constants
 
define('ORDERBY_DATE_PUBLISHED', 'datePublished');
define('ORDERBY_TITLE', 'title');
 
abstract class PKPSubmissionDAO extends SchemaDAO {
   var $cache;
   var $authorDao;
 
   public $schemaName = SCHEMA_SUBMISSION;
 
   public $tableName = 'submissions';
 
   public $settingsTableName = 'submission_settings';
 
   public $primaryKeyColumn = 'submission_id';
 
   public $primaryTableColumns = [
      'id' => 'submission_id',
      'contextId' => 'context_id',
      'currentPublicationId' => 'current_publication_id',
      'dateLastActivity' => 'date_last_activity',
      'dateSubmitted' => 'date_submitted',
      'lastModified' => 'last_modified',
      'stageId' => 'stage_id',
      'status' => 'status',
      'submissionProgress' => 'submission_progress',
   ];
 
   function __construct() {
      parent::__construct();
      $this->authorDao = DAORegistry::getDAO('AuthorDAO');
   }
 
   function _cacheMiss($cache, $id) {
      $submission = $this->getById($id, null, false);
      $cache->setCache($id, $submission);
      return $submission;
   }
 
   function _getCache() {
      if (!isset($this->cache)) {
         $cacheManager = CacheManager::getManager();
         $this->cache = $cacheManager->getObjectCache('submissions', 0, array(&$this, '_cacheMiss'));
      }
      return $this->cache;
   }
 
   function _fromRow($row) {
      $submission = parent::_fromRow($row);
      $submission->setData('publications', iterator_to_array(
         Services::get('publication')->getMany(['submissionIds' => $submission->getId()])
      ));
 
      return $submission;
   }
 
   function deleteObject($submission) {
      return $this->deleteById($submission->getId());
   }
 
   function deleteById($submissionId) {
      $submission = $this->getById($submissionId);
      if (!is_a($submission, 'Submission')) {
         throw new Exception('Could not delete submission. No submission with the id ' . (int) $submissionId . ' was found.');
      }
 
      parent::deleteById($submissionId);
 
      // Delete publications
      $publicationsIterator = Services::get('publication')->getMany(['submissionIds' => $submissionId]);
      $publicationDao = DAORegistry::getDAO('PublicationDAO'); /* @var $publicationDao PublicationDAO */
      foreach ($publicationsIterator as $publication) {
         $publicationDao->deleteObject($publication);
      }
 
      // Delete submission files.
      // 'deleteAllRevisionsBySubmissionId' has to be called before 'rmtree'
      // because SubmissionFileDaoDelegate::deleteObjects checks the file
      // and returns false if the file is not there, which makes the foreach loop in
      // SubmissionFileDAO::_deleteInternally not run till the end.
      $submissionFileDao = DAORegistry::getDAO('SubmissionFileDAO'); /* @var $submissionFileDao SubmissionFileDAO */
      $submissionFileDao->deleteAllRevisionsBySubmissionId($submissionId);
      import('lib.pkp.classes.file.SubmissionFileManager');
      $submissionFileManager = new SubmissionFileManager($submission->getContextId(), $submission->getId());
      $submissionFileManager->rmtree($submissionFileManager->getBasePath());
 
      $reviewRoundDao = DAORegistry::getDAO('ReviewRoundDAO'); /* @var $reviewRoundDao ReviewRoundDAO */
      $reviewRoundDao->deleteBySubmissionId($submissionId);
 
      $editDecisionDao = DAORegistry::getDAO('EditDecisionDAO'); /* @var $editDecisionDao EditDecisionDAO */
      $editDecisionDao->deleteDecisionsBySubmissionId($submissionId);
 
      $reviewAssignmentDao = DAORegistry::getDAO('ReviewAssignmentDAO'); /* @var $reviewAssignmentDao ReviewAssignmentDAO */
      $reviewAssignmentDao->deleteBySubmissionId($submissionId);
 
      // Delete the queries associated with a submission
      $queryDao = DAORegistry::getDAO('QueryDAO'); /* @var $queryDao QueryDAO */
      $queryDao->deleteByAssoc(ASSOC_TYPE_SUBMISSION, $submissionId);
 
      // Delete the stage assignments.
      $stageAssignmentDao = DAORegistry::getDAO('StageAssignmentDAO'); /* @var $stageAssignmentDao StageAssignmentDAO */
      $stageAssignments = $stageAssignmentDao->getBySubmissionAndStageId($submissionId);
      while ($stageAssignment = $stageAssignments->next()) {
         $stageAssignmentDao->deleteObject($stageAssignment);
      }
 
      $noteDao = DAORegistry::getDAO('NoteDAO'); /* @var $noteDao NoteDAO */
      $noteDao->deleteByAssoc(ASSOC_TYPE_SUBMISSION, $submissionId);
 
      $submissionCommentDao = DAORegistry::getDAO('SubmissionCommentDAO'); /* @var $submissionCommentDao SubmissionCommentDAO */
      $submissionCommentDao->deleteBySubmissionId($submissionId);
 
      // Delete any outstanding notifications for this submission
      $notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
      $notificationDao->deleteByAssoc(ASSOC_TYPE_SUBMISSION, $submissionId);
 
      $submissionEventLogDao = DAORegistry::getDAO('SubmissionEventLogDAO'); /* @var $submissionEventLogDao SubmissionEventLogDAO */
      $submissionEventLogDao->deleteByAssoc(ASSOC_TYPE_SUBMISSION, $submissionId);
 
      $submissionEmailLogDao = DAORegistry::getDAO('SubmissionEmailLogDAO'); /* @var $submissionEmailLogDao SubmissionEmailLogDAO */
      $submissionEmailLogDao->deleteByAssoc(ASSOC_TYPE_SUBMISSION, $submissionId);
   }
 
   function getByPubId($pubIdType, $pubId, $contextId = null) {
 
      $params = [
         'pub-id::' . $pubIdType,
         $pubId,
      ];
      if ($contextId) {
         $params[] = $contextId;
      }
 
      $result = $this->retrieve(
         'SELECT s.submission_id
            FROM publication_settings ps
            INNER JOIN publications p ON p.publication_id = ps.publication_id
            INNER JOIN submissions s ON p.publication_id = s.current_publication_id
            WHERE ps.setting_name = ? AND ps.setting_value = ?'
            . ($contextId ? ' AND s.context_id = ?' : ''),
         $params
      );
 
      $submissionId = $result->fields[0];
 
      if (!$submissionId) {
         return null;
      }
 
      return $this->getById($submissionId);
   }
 
 
   function getInsertId() {
      return $this->_getInsertId('submissions', 'submission_id');
   }
 
   function flushCache() {
      $cache = $this->_getCache();
      $cache->flush();
   }
 
   function getByContextId($contextId) {
      $result = $this->retrieve(
         'SELECT * FROM ' . $this->tableName . ' WHERE context_id = ?',
         [(int) $contextId]
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
 
   /*
    * Delete all submissions by context ID.
    * @param $contextId int
    */
   function deleteByContextId($contextId) {
      $submissions = $this->getByContextId($contextId);
      while ($submission = $submissions->next()) {
         $this->deleteById($submission->getId());
      }
   }
 
   function resetPermissions($contextId) {
      $submissions = $this->getByContextId($contextId);
      while ($submission = $submissions->next()) {
         $publications = (array) $submission->getData('publications');
         if (empty($publications)) {
            continue;
         }
         $params = [
            'copyrightYear' => $submission->_getContextLicenseFieldValue(null, PERMISSIONS_FIELD_COPYRIGHT_YEAR),
            'copyrightHolder' => $submission->_getContextLicenseFieldValue(null, PERMISSIONS_FIELD_COPYRIGHT_HOLDER),
            'licenseUrl' => $submission->_getContextLicenseFieldValue(null, PERMISSIONS_FIELD_LICENSE_URL),
         ];
         foreach ($publications as $publication) {
            $publication = Services::get('publication')->edit($publication, $params, Application::get()->getRequest());
         }
      }
      $this->flushCache();
   }
 
   function getDefaultSortOption() {
      return $this->getSortOption(ORDERBY_DATE_PUBLISHED, SORT_DIRECTION_DESC);
   }
 
   function getSortSelectOptions() {
      return array(
         $this->getSortOption(ORDERBY_TITLE, SORT_DIRECTION_ASC) => __('catalog.sortBy.titleAsc'),
         $this->getSortOption(ORDERBY_TITLE, SORT_DIRECTION_DESC) => __('catalog.sortBy.titleDesc'),
         $this->getSortOption(ORDERBY_DATE_PUBLISHED, SORT_DIRECTION_ASC) => __('catalog.sortBy.datePublishedAsc'),
         $this->getSortOption(ORDERBY_DATE_PUBLISHED, SORT_DIRECTION_DESC) => __('catalog.sortBy.datePublishedDesc'),
      );
   }
 
   function getSortOption($sortBy, $sortDir) {
      return $sortBy .'-' . $sortDir;
   }
 
   function getSortBy($sortOption) {
      list($sortBy, $sortDir) = explode("-", $sortOption);
      return $sortBy;
   }
 
   function getSortDirection($sortOption) {
      list($sortBy, $sortDir) = explode("-", $sortOption);
      return $sortDir;
   }
 
   function getExportable($contextId, $pubIdType = null, $title = null, $author = null, $issueId = null, $pubIdSettingName = null, $pubIdSettingValue = null, $rangeInfo = null) {
      if ($pubIdSettingName) {
         $params[] = $pubIdSettingName;
      }
      $params[] = STATUS_PUBLISHED;
      $params[] = $contextId;
      if ($pubIdType) {
         $params[] = 'pub-id::'.$pubIdType;
      }
      if ($title) {
         $params[] = 'title';
         $params[] = '%' . $title . '%';
      }
      if ($author) {
         $params[] = $author;
         $params[] = $author;
      }
      if ($issueId) {
         $params[] = $issueId;
      }
      if ($pubIdSettingName && $pubIdSettingValue && $pubIdSettingValue != EXPORT_STATUS_NOT_DEPOSITED) {
         $params[] = $pubIdSettingValue;
      }
 
      $result = $this->retrieveRange(
         'SELECT  s.*
         FROM  submissions s
            LEFT JOIN publications p ON s.current_publication_id = p.publication_id
            LEFT JOIN publication_settings ps ON p.publication_id = ps.publication_id'
            . ($issueId ? ' LEFT JOIN publication_settings psi ON p.publication_id = psi.publication_id AND psi.setting_name = \'issueId\'' : '')
            . ($pubIdType != null?' LEFT JOIN publication_settings pspidt ON (p.publication_id = pspidt.publication_id)':'')
            . ($title != null?' LEFT JOIN publication_settings pst ON (p.publication_id = pst.publication_id)':'')
            . ($author != null?' LEFT JOIN authors au ON (p.publication_id = au.publication_id)
                  LEFT JOIN author_settings asgs ON (asgs.author_id = au.author_id AND asgs.setting_name = \''.IDENTITY_SETTING_GIVENNAME.'\')
                  LEFT JOIN author_settings asfs ON (asfs.author_id = au.author_id AND asfs.setting_name = \''.IDENTITY_SETTING_FAMILYNAME.'\')
               ':'')
            . ($pubIdSettingName != null?' LEFT JOIN submission_settings pss ON (s.submission_id = pss.submission_id AND pss.setting_name = ?)':'')
         . ' WHERE   s.status = ?
            AND s.context_id = ?'
            . ($pubIdType != null?' AND pspidt.setting_name = ? AND pspidt.setting_value IS NOT NULL':'')
            . ($title != null?' AND (pst.setting_name = ? AND pst.setting_value LIKE ?)':'')
            . ($author != null?' AND (asgs.setting_value LIKE ? OR asfs.setting_value LIKE ?)':'')
            . ($issueId != null?' AND psi.setting_value = ?':'')
            . (($pubIdSettingName != null && $pubIdSettingValue != null && $pubIdSettingValue == EXPORT_STATUS_NOT_DEPOSITED)?' AND pss.setting_value IS NULL':'')
            . (($pubIdSettingName != null && $pubIdSettingValue != null && $pubIdSettingValue != EXPORT_STATUS_NOT_DEPOSITED)?' AND pss.setting_value = ?':'')
            . (($pubIdSettingName != null && is_null($pubIdSettingValue))?' AND (pss.setting_value IS NULL OR pss.setting_value = \'\')':'')
         . ' GROUP BY s.submission_id
         ORDER BY MAX(p.date_published) DESC, s.submission_id DESC',
         $params,
         $rangeInfo
      );
 
      return new DAOResultFactory($result, $this, '_fromRow');
   }
}