PKPLibraryFileManager.inc.php

<?php
 
import('lib.pkp.classes.context.LibraryFile');
import('lib.pkp.classes.file.PrivateFileManager');
 
class PKPLibraryFileManager extends PrivateFileManager {
   /* @var Context id for the current context */
   var $contextId;
 
   function __construct($contextId) {
      parent::__construct();
      $this->contextId = $contextId;
   }
 
   function getBasePath() {
      return parent::getBasePath() . '/contexts/' . $this->contextId . '/library/';
   }
 
   function deleteById($fileId) {
      $libraryFileDao = DAORegistry::getDAO('LibraryFileDAO'); /* @var $libraryFileDao LibraryFileDAO */
      $libraryFile = $libraryFileDao->getById($fileId);
 
      parent::deleteByPath($this->getBasePath() . $libraryFile->getServerFileName());
 
      $libraryFileDao->deleteById($fileId);
   }
 
   function generateFileName($type, $originalFileName) {
      $libraryFileDao = DAORegistry::getDAO('LibraryFileDAO'); /* @var $libraryFileDao LibraryFileDAO */
      $suffix = $this->getFileSuffixFromType($type);
      $ext = $this->getExtension($originalFileName);
      $truncated = $this->truncateFileName($originalFileName, 127 - PKPString::strlen($suffix) - 1);
      $baseName = PKPString::substr($truncated, 0, PKPString::strpos($originalFileName, $ext) - 1);
 
      // Try a simple syntax first
      $fileName = $baseName . '-' . $suffix . '.' . $ext;
      if (!$libraryFileDao->filenameExists($this->contextId, $fileName)) return $fileName;
 
      for ($i = 1; ; $i++) {
         $fullSuffix = $suffix . '-' . $i;
         //truncate more if necessary
         $truncated = $this->truncateFileName($originalFileName, 127 - PKPString::strlen($fullSuffix) - 1);
         // get the base name and append the suffix
         $baseName = PKPString::substr($truncated, 0, PKPString::strpos($originalFileName, $ext) - 1);
 
         //try the following
         $fileName = $baseName . '-' . $fullSuffix . '.' . $ext;
         if (!$libraryFileDao->filenameExists($this->contextId, $fileName)) {
            return $fileName;
         }
      }
   }
 
   function &copyFromTemporaryFile(&$temporaryFile, $libraryFileType) {
      $libraryFileDao = DAORegistry::getDAO('LibraryFileDAO'); /* @var $libraryFileDao LibraryFileDAO */
      $libraryFile = $libraryFileDao->newDataObject();
 
      $libraryFile->setDateUploaded($temporaryFile->getDateUploaded());
      $libraryFile->setDateModified($temporaryFile->getDateUploaded());
      $libraryFile->setFileType($temporaryFile->getFileType());
      $libraryFile->setFileSize($temporaryFile->getFileSize());
      $libraryFile->setServerFileName($this->generateFileName($libraryFileType, $temporaryFile->getOriginalFileName()));
      $libraryFile->setOriginalFileName($temporaryFile->getOriginalFileName());
      if (!$this->copyFile($temporaryFile->getFilePath(), $this->getBasePath() . $libraryFile->getServerFileName())) {
         return false;
      }
 
      return $libraryFile;
   }
 
   function getFileSuffixFromType($type) {
      $typeSuffixMap =& $this->getTypeSuffixMap();
      return $typeSuffixMap[$type];
   }
 
   function &getTypeSuffixMap() {
      static $map = array(
         LIBRARY_FILE_TYPE_MARKETING => 'MAR',
         LIBRARY_FILE_TYPE_PERMISSION => 'PER',
         LIBRARY_FILE_TYPE_REPORT => 'REP',
         LIBRARY_FILE_TYPE_OTHER => 'OTH'
      );
      return $map;
   }
 
   function getNameFromType($type) {
      $typeNameMap =& $this->getTypeNameMap();
      if (isset($typeNameMap[$type])) {
         return $typeNameMap[$type];
      } else {
         return false;
      }
   }
 
   function &getTypeTitleKeyMap() {
      static $map = array(
         LIBRARY_FILE_TYPE_MARKETING => 'settings.libraryFiles.category.marketing',
         LIBRARY_FILE_TYPE_PERMISSION => 'settings.libraryFiles.category.permissions',
         LIBRARY_FILE_TYPE_REPORT => 'settings.libraryFiles.category.reports',
         LIBRARY_FILE_TYPE_OTHER => 'settings.libraryFiles.category.other'
      );
      return $map;
   }
 
   function getTitleKeyFromType($type) {
      $typeTitleKeyMap =& $this->getTypeTitleKeyMap();
      return $typeTitleKeyMap[$type];
   }
 
   function &getTypeNameMap() {
      static $typeNameMap = array(
         LIBRARY_FILE_TYPE_MARKETING => 'marketing',
         LIBRARY_FILE_TYPE_PERMISSION => 'permissions',
         LIBRARY_FILE_TYPE_REPORT => 'reports',
         LIBRARY_FILE_TYPE_OTHER => 'other',
      );
      return $typeNameMap;
   }
}