<?php 
 
defined('C5_EXECUTE') or die("Access Denied.");
Loader::model('file');
Loader::model('file_version');
 
/**
 * @package Core
 * @category Concrete
 * @author Andrew Embler <andrew@concrete5.org>
 * @copyright  Copyright (c) 2003-2009 Concrete5. (http://www.concrete5.org)
 * @license   http://www.concrete5.org/license/...     MIT License
 *
 */
 
/**
 
 * @package Core
 * @author Andrew Embler <andrew@concrete5.org>
 * @category Concrete
 * @copyright  Copyright (c) 2003-2009 Concrete5. (http://www.concrete5.org)
 * @license   http://www.concrete5.org/license/...     MIT License
 *
 */
class Concrete5_Library_FileImporter {
 
   /** 
    * PHP error constants - these match those founds in $_FILES[$field]['error] if it exists
    */
   const E_PHP_FILE_ERROR_DEFAULT = 0;
   const E_PHP_FILE_EXCEEDS_UPLOAD_MAX_FILESIZE = 1;
   const E_PHP_FILE_EXCEEDS_HTML_MAX_FILE_SIZE = 2;
   const E_PHP_FILE_PARTIAL_UPLOAD = 3;
   const E_PHP_NO_FILE = 4;
 
   /** 
    * concrete5 internal error constants
    */
   const E_FILE_INVALID_EXTENSION = 10;
   const E_FILE_INVALID = 11; // pointer is invalid file, is a directory, etc...
   const E_FILE_UNABLE_TO_STORE = 12;
 
   /** 
    * Returns a text string explaining the error that was passed
    */
   public function getErrorMessage($code) {
      $msg = '';
      switch($code) {
         case FileImporter::E_PHP_NO_FILE:
         case FileImporter::E_FILE_INVALID:
            $msg = t('Invalid file.');
            break;
         case FileImporter::E_FILE_INVALID_EXTENSION:
            $msg = t('Invalid file extension.');
            break;
         case FileImporter::E_PHP_FILE_PARTIAL_UPLOAD:
            $msg = t('The file was only partially uploaded.');
            break;
         case FileImporter::E_PHP_FILE_EXCEEDS_HTML_MAX_FILE_SIZE:
         case FileImporter::E_PHP_FILE_EXCEEDS_UPLOAD_MAX_FILESIZE:
            $msg = t('Uploaded file is too large. The current value of upload_max_filesize is %s', ini_get('upload_max_filesize'));
            break;
         case FileImporter::E_FILE_UNABLE_TO_STORE:         
            $msg = t('Unable to copy file to storage directory. Please check permissions on your upload directory and ensure they can be written to by your web server.');
            break;
         case FileImporter::E_PHP_FILE_ERROR_DEFAULT:
         default:
            $msg = t("An unknown error occurred while uploading the file. Please check that file uploads are enabled, and that your file does not exceed the size of the post_max_size or upload_max_filesize variables.\n\nFile Uploads: %s\nMax Upload File Size: %s\nPost Max Size: %s", ini_get('file_uploads'), ini_get('upload_max_filesize'), ini_get('post_max_size'));         
            break;
      }
      return $msg;
   }
 
   private function generatePrefix() {
      $prefix = rand(10, 99) . time();
      return $prefix;   
   }
 
   private function storeFile($prefix, $pointer, $filename, $fr = false) {
      // assumes prefix are 12 digits
      $fi = Loader::helper('concrete/file');
      $path = false;
      if ($fr instanceof File) {
         if ($fr->getStorageLocationID() > 0) {
            Loader::model('file_storage_location');
            $fsl = FileStorageLocation::getByID($fr->getStorageLocationID());
            $path = $fi->mapSystemPath($prefix, $filename, true, $fsl->getDirectory());
         }
      }
 
      if ($path == false) {
         $path = $fi->mapSystemPath($prefix, $filename, true);
      }
      $r = @copy($pointer, $path);
      @chmod($path, FILE_PERMISSIONS_MODE);
      return $r;
   }
 
   /** 
    * Imports a local file into the system. The file must be added to this path
    * somehow. That's what happens in tools/files/importers/.
    * If a $fr (FileRecord) object is passed, we assign the newly imported FileVersion
    * object to that File. If not, we make a new filerecord.
    * @param string $pointer path to file
    * @param string $filename
    * @param FileRecord $fr
    * @return number Error Code | FileVersion
    */
   public function import($pointer, $filename = false, $fr = false) {
 
      if ($filename == false) {
         // determine filename from $pointer
         $filename = basename($pointer);
      }
 
      $fh = Loader::helper('validation/file');
      $fi = Loader::helper('file');
      $filename = $fi->sanitize($filename);
 
      // test if file is valid, else return FileImporter::E_FILE_INVALID
      if (!$fh->file($pointer)) {
         return FileImporter::E_FILE_INVALID;
      }
 
      if (!$fh->extension($filename)) {
         return FileImporter::E_FILE_INVALID_EXTENSION;
      }
 
 
      $prefix = $this->generatePrefix();
 
      // do save in the FileVersions table
 
      // move file to correct area in the filesystem based on prefix
      $response = $this->storeFile($prefix, $pointer, $filename, $fr);
      if (!$response) {
         return FileImporter::E_FILE_UNABLE_TO_STORE;
      }
 
      if (!($fr instanceof File)) {
         // we have to create a new file object for this file version
         $fv = File::add($filename, $prefix);
         $fv->refreshAttributes(true);
         $fr = $fv->getFile();
      } else {
         // We get a new version to modify
         $fv = $fr->getVersionToModify(true);
         $fv->updateFile($filename, $prefix);
         $fv->refreshAttributes();
      }
 
      $fr->refreshCache();
      return $fv;
   }
 
 
 
}