SubmissionFile.inc.php

<?php
 
import('lib.pkp.classes.file.PKPFile');
 
// Define the file stage identifiers.
define('SUBMISSION_FILE_SUBMISSION', 2);
define('SUBMISSION_FILE_NOTE', 3);
define('SUBMISSION_FILE_REVIEW_FILE', 4);
define('SUBMISSION_FILE_REVIEW_ATTACHMENT', 5);
// SUBMISSION_FILE_REVIEW_REVISION defined below (FIXME: re-order before release)
define('SUBMISSION_FILE_FINAL', 6);
define('SUBMISSION_FILE_FAIR_COPY', 7);
define('SUBMISSION_FILE_EDITOR', 8);
define('SUBMISSION_FILE_COPYEDIT', 9);
define('SUBMISSION_FILE_PROOF', 10);
define('SUBMISSION_FILE_PRODUCTION_READY', 11);
define('SUBMISSION_FILE_ATTACHMENT', 13);
define('SUBMISSION_FILE_REVIEW_REVISION', 15);
define('SUBMISSION_FILE_DEPENDENT', 17);
define('SUBMISSION_FILE_QUERY', 18);
 
class SubmissionFile extends PKPFile {
 
   function &getLocalizedData($key, $preferredLocale = null) {
      if (is_null($preferredLocale)) $preferredLocale = AppLocale::getLocale();
      $localePrecedence = array($preferredLocale, $this->getSubmissionLocale());
      foreach ($localePrecedence as $locale) {
         if (empty($locale)) continue;
         $value =& $this->getData($key, $locale);
         if (!empty($value)) return $value;
         unset($value);
      }
 
      // Fallback: Get the first available piece of data.
      $data =& $this->getData($key, null);
      foreach ((array) $data as $dataValue) {
         if (!empty($dataValue)) return $dataValue;
      }
 
      // No data available; return null.
      unset($data);
      $data = null;
      return $data;
   }
 
   //
   // Getters and Setters
   //
   function getFileId() {
      // WARNING: Do not modernize getter/setters without considering
      // ID clash with subclasses ArticleGalley and ArticleNote!
      return $this->getData('fileId');
   }
 
   function setFileId($fileId) {
      // WARNING: Do not modernize getter/setters without considering
      // ID clash with subclasses ArticleGalley and ArticleNote!
      $this->setData('fileId', $fileId);
   }
 
   function getId() {
      // WARNING: Do not modernize getter/setters without considering
      // ID clash with subclasses ArticleGalley and ArticleNote!
      return $this->getData('fileId');
   }
 
   function setId($fileId) {
      // WARNING: Do not modernize getter/setters without considering
      // ID clash with subclasses ArticleGalley and ArticleNote!
      $this->setData('fileId', $fileId);
   }
 
   function getSubmissionLocale() {
      return $this->getData('submissionLocale');
   }
 
   function setSubmissionLocale($submissionLocale) {
      $this->setData('submissionLocale', $submissionLocale);
   }
 
   function getSourceFileId() {
      return $this->getData('sourceFileId');
   }
 
   function setSourceFileId($sourceFileId) {
      $this->setData('sourceFileId', $sourceFileId);
   }
 
   function getSourceRevision() {
      return $this->getData('sourceRevision');
   }
 
   function setSourceRevision($sourceRevision) {
      $this->setData('sourceRevision', $sourceRevision);
   }
 
   function getAssocId() {
      return $this->getData('assocId');
   }
 
   function setAssocId($assocId) {
      $this->setData('assocId', $assocId);
   }
 
   function getStoredPubId($pubIdType) {
      return $this->getData('pub-id::'.$pubIdType);
   }
 
   function setStoredPubId($pubIdType, $pubId) {
      $this->setData('pub-id::'.$pubIdType, $pubId);
   }
 
   function getDirectSalesPrice() {
      return $this->getData('directSalesPrice');
   }
 
   function setDirectSalesPrice($directSalesPrice) {
      $this->setData('directSalesPrice', $directSalesPrice);
   }
 
   function getSalesType() {
      return $this->getData('salesType');
   }
 
   function setSalesType($salesType) {
      $this->setData('salesType', $salesType);
   }
 
   function setName($name, $locale) {
      $this->setData('name', $name, $locale);
   }
 
   function getName($locale) {
      return $this->getData('name', $locale);
   }
 
   function getLocalizedName() {
      return $this->getLocalizedData('name');
   }
 
   function supportsDependentFiles() {
      return !in_array($this->getFileStage(), array(SUBMISSION_FILE_DEPENDENT, SUBMISSION_FILE_QUERY)) && in_array($this->getFileType(), array(
         'text/html',
         'application/xml',
         'text/xml',
      ));
   }
 
   function getExtension() {
      import('lib.pkp.classes.file.FileManager');
      $fileManager = new FileManager();
      return $fileManager->parseFileExtension($this->getOriginalFileName());
   }
 
   function getDocumentType() {
      import('lib.pkp.classes.file.FileManager');
      $fileManager = new FileManager();
      return $fileManager->getDocumentType($this->getFileType());
   }
 
   function setGenreId($genreId) {
      $this->setData('genreId', $genreId);
   }
 
   function getGenreId() {
      return $this->getData('genreId');
   }
 
   function getRevision() {
      return $this->getData('revision');
   }
 
   function getBestId() {
      $publicFileId = $this->getStoredPubId('publisher-id');
      if (!empty($publicFileId)) return $publicFileId;
      return $this->getFileIdAndRevision();
   }
 
   function getFileIdAndRevision() {
      $id = $this->getFileId();
      $revision = $this->getRevision();
      $idAndRevision = $id;
      if ($revision) {
         $idAndRevision .= '-'.$revision;
      }
      return $idAndRevision;
   }
 
   function setRevision($revision) {
      $this->setData('revision', $revision);
   }
 
   function getSubmissionId() {
      return $this->getData('submissionId');
   }
 
   function setSubmissionId($submissionId) {
      $this->setData('submissionId', $submissionId);
   }
 
   function getFileStage() {
      return $this->getData('fileStage');
   }
 
   function setFileStage($fileStage) {
      $this->setData('fileStage', $fileStage);
   }
 
   function getDateModified() {
      return $this->getData('dateModified');
   }
 
   function setDateModified($dateModified) {
      return $this->setData('dateModified', $dateModified);
   }
 
   function getRound() {
      return $this->getData('round');
   }
 
   function setRound($round) {
      return $this->setData('round', $round);
   }
 
   function getViewable() {
      return $this->getData('viewable');
   }
 
 
   function setViewable($viewable) {
      return $this->setData('viewable', $viewable);
   }
 
   function setUploaderUserId($uploaderUserId) {
      $this->setData('uploaderUserId', $uploaderUserId);
   }
 
   function getUploaderUserId() {
      return $this->getData('uploaderUserId');
   }
 
   function getAssocType() {
      return $this->getData('assocType');
   }
 
   function setAssocType($assocType) {
      $this->setData('assocType', $assocType);
   }
 
   function getChapterId() {
      return $this->getData('chapterId');
   }
 
   function setChapterId($chapterId) {
      $this->setData('chapterId', $chapterId);
   }
 
   function getFilePath() {
      // Get the context ID
      $submissionDao = DAORegistry::getDAO('SubmissionDAO'); /* @var $submissionDao SubmissionDAO */
      $submission = $submissionDao->getById($this->getSubmissionId());
      if (!$submission) return null;
      $contextId = $submission->getContextId();
      unset($submission);
 
      // Construct the file path
      import('lib.pkp.classes.file.SubmissionFileManager');
      $submissionFileManager = new SubmissionFileManager($contextId, $this->getSubmissionId());
      return $submissionFileManager->getBasePath() . $this->_fileStageToPath($this->getFileStage()) . '/' . $this->getServerFileName();
   }
 
   function getFileLabel($locale = null) {
      // Retrieve the localized file name as basis for the label.
      if ($locale) {
         $fileLabel = $this->getName($locale);
      } else {
         $fileLabel = $this->getLocalizedName();
      }
 
      // If we have no file name then use a default name.
      if (empty($fileLabel)) $fileLabel = $this->getOriginalFileName();
 
      // Add the revision number to the label if we have more than one revision.
      if ($this->getRevision() > 1) $fileLabel .= ' (' . $this->getRevision() . ')';
 
      return $fileLabel;
   }
 
 
   function copyEditableMetadataFrom($submissionFile) {
      assert(is_a($submissionFile, 'SubmissionFile'));
      $this->setName($submissionFile->getName(null), null);
      $this->setChapterId($submissionFile->getChapterId());
   }
 
   function getClientFileName() {
      // Generate a human readable time stamp.
      $timestamp = date('Ymd', strtotime($this->getDateUploaded()));
 
      $genreDao = DAORegistry::getDAO('GenreDAO'); /* @var $genreDao GenreDAO */
      $genre = $genreDao->getById($this->getGenreId());
 
      // Make the file name unique across all files and file revisions.
      // Also make sure that files can be ordered sensibly by file name.
      return   $this->getSubmissionId() . '-'.
         ($genre? ($genre->getLocalizedName() . '-'):'') .
         $this->getFileId() . '-' .
         $this->getRevision() . '-' .
         $this->getFileStage() . '-' .
         $timestamp .
         '.' .
         $this->getExtension();
   }
 
   //
   // Overridden public methods from PKPFile
   //
   function getServerFileName() {
      return $this->_generateFileName();
   }
 
   function setServerFileName($fileName) {
      assert(false);
   }
 
   function getViews() {
      $application = Application::get();
      return $application->getPrimaryMetricByAssoc(ASSOC_TYPE_SUBMISSION_FILE, $this->getFileId());
   }
 
   //
   // Private helper methods
   //
 
   function _generateFileName() {
      // Generate a human readable time stamp.
      $timestamp = date('Ymd', strtotime($this->getDateUploaded()));
 
      // Make the file name unique across all files and file revisions.
      // Also make sure that files can be ordered sensibly by file name.
      return   $this->getSubmissionId() . '-'.
         $this->getGenreId() . '-' .
         $this->getFileId() . '-' .
         $this->getRevision() . '-' .
         $this->getFileStage() . '-' .
         $timestamp .
         '.' .
         strtolower_codesafe($this->getExtension());
   }
 
   function _generateName($anonymous = false) {
      $genreDao = DAORegistry::getDAO('GenreDAO'); /* @var $genreDao GenreDAO */
      $genre = $genreDao->getById($this->getGenreId());
      $userDAO = DAORegistry::getDAO('UserDAO');
      $user = $userDAO->getById($this->getUploaderUserId());
 
      $submissionLocale = $this->getSubmissionLocale();
      AppLocale::requireComponents(LOCALE_COMPONENT_PKP_COMMON, $submissionLocale);
 
      $genreName = '';
      if ($genre) {
         $genreName = $genre->getName($submissionLocale) ? $genre->getName($submissionLocale) : $genre->getLocalizedName();
      }
 
      $localeKey = $anonymous ? 'common.file.anonymousNamingPattern' : 'common.file.namingPattern';
      return __($localeKey,
         array(
            'genre'            => $genreName,
            'docType'          => $this->getDocumentType(),
            'originalFilename' => $this->getOriginalFilename(),
            'username'         => $user->getUsername(),
         ),
         $submissionLocale
      );
   }
 
   function _fileStageToPath($fileStage) {
      static $fileStageToPath = array(
            0 => '', // Temporary files do not use stages
            SUBMISSION_FILE_SUBMISSION => 'submission',
            SUBMISSION_FILE_NOTE => 'note',
            SUBMISSION_FILE_REVIEW_FILE => 'submission/review',
            SUBMISSION_FILE_REVIEW_ATTACHMENT => 'submission/review/attachment',
            SUBMISSION_FILE_REVIEW_REVISION => 'submission/review/revision',
            SUBMISSION_FILE_FINAL => 'submission/final',
            SUBMISSION_FILE_FAIR_COPY => 'submission/fairCopy',
            SUBMISSION_FILE_EDITOR => 'submission/editor',
            SUBMISSION_FILE_COPYEDIT => 'submission/copyedit',
            SUBMISSION_FILE_DEPENDENT => 'submission/proof',
            SUBMISSION_FILE_PROOF => 'submission/proof',
            SUBMISSION_FILE_PRODUCTION_READY => 'submission/productionReady',
            SUBMISSION_FILE_ATTACHMENT => 'attachment',
            SUBMISSION_FILE_QUERY => 'submission/query',
      );
 
      assert(isset($fileStageToPath[$fileStage]));
      return $fileStageToPath[$fileStage];
   }
 
   //
   // Public methods
   //
   function getMetadataForm($stageId, $reviewRound) {
      import('lib.pkp.controllers.wizard.fileUpload.form.SubmissionFilesMetadataForm');
      return new SubmissionFilesMetadataForm($this, $stageId, $reviewRound);
   }
 
   function getDAO() {
      return DAORegistry::getDAO('SubmissionFileDAO');
   }
}