merging latest master
[lhc/web/wiklou.git] / includes / upload / UploadFromStash.php
index 8392270..607965f 100644 (file)
@@ -1,12 +1,32 @@
 <?php
 /**
- * Implements uploading from previously stored file.
+ * Backend for uploading files from previously stored file.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
- * @ingroup upload
- * @author Bryan Tong Minh
+ * @ingroup Upload
  */
 
+/**
+ * Implements uploading from previously stored file.
+ *
+ * @ingroup Upload
+ * @author Bryan Tong Minh
+ */
 class UploadFromStash extends UploadBase {
        protected $mFileKey, $mVirtualTempPath, $mFileProps, $mSourceType;
 
@@ -42,8 +62,6 @@ class UploadFromStash extends UploadBase {
 
                        $this->stash = new UploadStash( $this->repo, $this->user );
                }
-
-               return true;
        }
 
        /**
@@ -101,7 +119,7 @@ class UploadFromStash extends UploadBase {
                // chooses one of wpDestFile, wpUploadFile, filename in that order.
                $desiredDestName = $request->getText( 'wpDestFile', $request->getText( 'wpUploadFile', $request->getText( 'filename' ) ) );
 
-               return $this->initialize( $fileKey, $desiredDestName );
+               $this->initialize( $fileKey, $desiredDestName );
        }
 
        /**
@@ -134,6 +152,7 @@ class UploadFromStash extends UploadBase {
 
        /**
         * This should return the key instead of the UploadStashFile instance, for backward compatibility.
+        * @return String
         */
        public function stashSession() {
                return $this->stashFile()->getFileKey();
@@ -141,7 +160,7 @@ class UploadFromStash extends UploadBase {
 
        /**
         * Remove a temporarily kept file stashed by saveTempUploadedFile().
-        * @return success
+        * @return bool success
         */
        public function unsaveUploadedFile() {
                return $this->stash->removeFile( $this->mFileKey );
@@ -160,37 +179,4 @@ class UploadFromStash extends UploadBase {
                $this->unsaveUploadedFile();
                return $rv;
        }
-
-       /**
-        * Append a chunk to the temporary file.
-        *
-        * @return Status
-        */
-       public function appendChunk($chunk, $chunkSize, $offset) {
-               //to use $this->getFileSize() here, db needs to be updated
-               //in appendToUploadFile for that
-               $fileSize = $this->stash->getFile( $this->mFileKey )->getSize();
-               if ( $fileSize + $chunkSize > $this->getMaxUploadSize()) {
-                       $status = Status::newFatal( 'file-too-large' );
-               } else {
-                       //append chunk
-                       if ( $fileSize == $offset ) {
-                               $status = $this->appendToUploadFile( $chunk,
-                                       $this->mVirtualTempPath );
-                       } else {
-                               $status = Status::newFatal( 'invalid-chunk-offset' );
-                       }
-               }
-               return $status;
-       }
-
-       /**
-        * Append the final chunk and ready file for parent::performUpload()
-        * @return void
-        */
-       public function finalizeFile() {
-               $this->appendFinish ( $this->mVirtualTempPath );
-               $this->cleanupTempFile();
-               $this->mTempPath = $this->getRealPath( $this->mVirtualTempPath );
-       }
 }