ENH: refs #0306. Clean up Httpupload component, and make the web api use it

Author: zachmullen

core/controllers/UploadController.php

@@ -256,9 +256,16 @@ function processjavauploadAction()
       echo '[ERROR]User id does not match upload token user id';
       throw new Zend_Exception('User id does not match upload token user id');
       }
-    $expectedParentId = $this->userSession->JavaUpload->parent ?
-      $this->userSession->JavaUpload->parent :
-      $this->userSession->Dao->getPrivatefolderId();
+
+    if($this->userSession->JavaUpload->parent)
+      {
+      $expectedParentId = $this->userSession->JavaUpload->parent;
+      }
+    else
+      {
+      $expectedParentId = $this->userSession->Dao->getPrivatefolderId();
+      }
+
     if($parentId != $expectedParentId)
       {
       echo '[ERROR]You are attempting to upload into the incorrect parent folder';

core/controllers/components/HttpuploadComponent.php

@@ -19,12 +19,9 @@ class HttpuploadComponent extends AppComponent
   {
 
   var $tmpDirectory = '';
-  var $tokenParamName = '';
+  var $tokenParamName = 'uploadtoken';
   var $testingEnable = false;
 
-  var $logFile = '';
-  var $logType = 0;
-
   /** Set the upload temporary directory */
   public function setTmpDirectory($dir)
     {
@@ -81,25 +78,20 @@ public function process($args)
     {
     $uploadOffset = (float)0; // bytes received
 
-    //check parameters
     if(!array_key_exists('filename', $args))
       {
-      error_log(__FILE__.":".__FUNCTION__.":".__LINE__." - "."Parameter filename is not defined", $this->logType, $this->logFile);
       throw new Exception('Parameter filename is not defined', -150);
       }
+    $filename = $args['filename'];
 
-    $filename = $args['filename']; // XXXX.ISP
-
-    if (!array_key_exists($this->tokenParamName, $args))
+    if(!array_key_exists($this->tokenParamName, $args))
       {
-      error_log(__FILE__.":".__FUNCTION__.":".__LINE__." - "."Parameter ".$this->tokenParamName." is not defined", $this->logType, $this->logFile);
       throw new Exception('Parameter '.$this->tokenParamName.' is not defined', -150);
       }
-    $uploadToken = $args[$this->tokenParamName]; //XXX123.TMP
+    $uploadToken = $args[$this->tokenParamName];
 
-    if (!array_key_exists('length', $args))
+    if(!array_key_exists('length', $args))
       {
-      error_log(__FILE__.":".__FUNCTION__.":".__LINE__." - "."Parameter length is not defined", $this->logType, $this->logFile);
       throw new Exception('Parameter length is not defined', -150);
       }
     $length = (float)($args['length']);
@@ -113,7 +105,6 @@ public function process($args)
     $pathTemporaryFilename = $this->tmpDirectory.'/'.$uploadToken;
     if(!file_exists($pathTemporaryFilename))
       {
-      error_log(__FILE__.':'.__FUNCTION__.':'.__LINE__.' - '.'Invalid upload token', $this->logType, $this->logFile);
       throw new Exception('Invalid upload token', -141);
       }
     else
@@ -125,28 +116,26 @@ public function process($args)
     $streamChecksum = $uploadOffset == 0;
 
     set_time_limit(0); // Timeout of the PHP script set to Infinite
-    ignore_user_abort(TRUE);
+    ignore_user_abort(true);
 
     $inputfile = 'php://input'; // Stream (Client -> Server) Mode: Read, Binary
-    if ($this->testingEnable && array_key_exists('localinput', $args))
+    if($this->testingEnable && array_key_exists('localinput', $args))
       {
       $inputfile = $localinput; // Stream (LocalServerFile -> Server) Mode: Read, Binary
       }
 
-     $in = fopen($inputfile, 'rb');    // Stream (LocalServerFile -> Server) Mode: Read, Binary
-     if($in === FALSE )
-        {
-        error_log(__FILE__.':'.__FUNCTION__.':'.__LINE__.' - '."Failed to open source:$inputfile", $this->logType, $this->logFile);
-        throw new Exception("Failed to open [$inputfile] source", -142);
-        }
+    $in = fopen($inputfile, 'rb'); // Stream (LocalServerFile -> Server) Mode: Read, Binary
+    if($in === false)
+      {
+      throw new Exception('Failed to open ['.$inputfile.'] source', -142);
+      }
 
     // open target output
     $out = fopen($pathTemporaryFilename, 'ab'); // Stream (Server -> TempFile) Mode: Append, Binary
-    if ($out === false)
-        {
-        error_log(__FILE__.':'.__FUNCTION__.':'.__LINE__.' - '."Failed to open output file:$pathTemporaryFilename", $this->logType, $this->logFile);
-        throw new Exception("Failed to open output file [$pathTemporaryFilename]", -143);
-        }
+    if($out === false)
+      {
+      throw new Exception('Failed to open output file ['.$pathTemporaryFilename.']', -143);
+      }
 
     if($streamChecksum)
       {
@@ -174,8 +163,7 @@ public function process($args)
 
     if($uploadOffset < $length)
       {
-      error_log(__FILE__.':'.__FUNCTION__.':'.__LINE__.' - '."Failed to upload file - {$uploadOffset}/{$length} bytes transferred", $this->logType, $this->logFile);
-      throw new Exception("Failed to upload file - {$uploadOffset}/{$length} bytes transferred", -105);
+      throw new Exception('Failed to upload file - '.$uploadOffset.'/'.$length.' bytes transferred', -105);
       }
 
     $data['filename'] = $filename;

modules/api/controllers/IndexController.php

@@ -23,7 +23,7 @@ class Api_IndexController extends Api_AppController
 
   // Config parameters
   var $apiEnable = '';
-  var $apiSetup  = array();
+  var $apiSetup = array();
 
   /** Before filter */
   function preDispatch()
@@ -32,9 +32,9 @@ function preDispatch()
     $this->apiEnable = true;
 
     // define api parameters
-    $this->apiSetup['testing']         = Zend_Registry::get('configGlobal')->environment == "testing";
-    $this->apiSetup['tmp_directory']   = $this->getTempDirectory();
     $modulesConfig = Zend_Registry::get('configsModules');
+    $this->apiSetup['testing'] = Zend_Registry::get('configGlobal')->environment == 'testing';
+    $this->apiSetup['tmpDirectory'] = $this->getTempDirectory();
     $this->apiSetup['apiMethodPrefix'] = $modulesConfig['api']->methodprefix;
 
     $this->action = $actionName = Zend_Controller_Front::getInstance()->getRequest()->getActionName();

modules/api/controllers/components/ApiComponent.php

@@ -258,8 +258,11 @@ function uploadGeneratetoken($args)
         }
       }
     //we don't already have this content, so create the token
-    $uploadApi = new KwUploadAPI($this->apiSetup);
-    return $uploadApi->generateToken($args, $userDao->getKey().'/'.$item->getKey());
+    $componentLoader = new MIDAS_ComponentLoader();
+    $uploadComponent = $componentLoader->loadComponent('Httpupload');
+    $uploadComponent->setTestingMode($this->apiSetup['testing']);
+    $uploadComponent->setTmpDirectory($this->apiSetup['tmpDirectory']);
+    return $uploadComponent->generateToken($args, $userDao->getKey().'/'.$item->getKey());
     }
 
   /**
@@ -269,8 +272,11 @@ function uploadGeneratetoken($args)
    */
   function uploadGetoffset($args)
     {
-    $uploadApi = new KwUploadAPI($this->apiSetup);
-    return $uploadApi->getOffset($args);
+    $componentLoader = new MIDAS_ComponentLoader();
+    $uploadComponent = $componentLoader->loadComponent('Httpupload');
+    $uploadComponent->setTestingMode($this->apiSetup['testing']);
+    $uploadComponent->setTmpDirectory($this->apiSetup['tmpDirectory']);
+    return $uploadComponent->getOffset($args);
     }
 
   /**
@@ -380,18 +386,22 @@ function uploadPerform($args)
       }
 
     $mode = array_key_exists('mode', $args) ? $args['mode'] : 'stream';
-    $uploadApi = new KwUploadAPI($this->apiSetup);
+
+    $componentLoader = new MIDAS_ComponentLoader();
+    $httpUploadComponent = $componentLoader->loadComponent('Httpupload');
+    $httpUploadComponent->setTestingMode($this->apiSetup['testing']);
+    $httpUploadComponent->setTmpDirectory($this->apiSetup['tmpDirectory']);
 
     if(array_key_exists('testingmode', $args))
       {
-      $uploadApi->testing_enable = true;
-      $args['localinput'] = $this->apiSetup['tmp_directory'].'/'.$args['filename'];
+      $httpUploadComponent->setTestingMode(true);
+      $args['localinput'] = $this->apiSetup['tmpDirectory'].'/'.$args['filename'];
       }
 
-    // Use KWUploadApi to handle the actual file upload
+    // Use the Httpupload component to handle the actual file upload
     if($mode == 'stream')
       {
-      $result = $uploadApi->process($args);
+      $result = $httpUploadComponent->process($args);
 
       $filename = $result['filename'];
       $filepath = $result['path'];
@@ -416,7 +426,6 @@ function uploadPerform($args)
       throw new Exception('Invalid upload mode', MIDAS_INVALID_PARAMETER);
       }
 
-    $componentLoader = new MIDAS_ComponentLoader();
     $uploadComponent = $componentLoader->loadComponent('Upload');
     if(isset($folder))
       {

modules/api/library/KwUploadAPI.php

@@ -47,12 +47,12 @@ function setTempDirectory($tmp_directory)
     $this->tmp_directory = $tmp_directory;
     }
 
-   /**
-    * Generate an upload token that will act as the authentication token for the upload.
-    * This token is the filename of a guaranteed unique file which will be placed under the
-    * directory specified by the dirname parameter, which should be used to ensure that
-    * the user can only write into a certain logical space.
-    */
+  /**
+   * Generate an upload token that will act as the authentication token for the upload.
+   * This token is the filename of a guaranteed unique file which will be placed under the
+   * directory specified by the dirname parameter, which should be used to ensure that
+   * the user can only write into a certain logical space.
+   */
   function generateToken($args, $dirname = '')
     {
     if(!array_key_exists('filename', $args))