Big oops - merged to wrong branch.

[lhc/web/wiklou.git] / includes / upload / UploadFromStash.php

diff --git a/includes/upload/UploadFromStash.php b/includes/upload/UploadFromStash.php
index 8cb22ce..d5cce14 100644 (file)
--- a/includes/upload/UploadFromStash.php
+++ b/includes/upload/UploadFromStash.php
@@ -1,21 +1,46 @@
 <?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;
-       
+
        // an instance of UploadStash
        private $stash;
-       
+
        //LocalFile repo
        private $repo;
-       
+
+       /**
+        * @param $user User
+        * @param $stash UploadStash
+        * @param $repo FileRepo
+        */
        public function __construct( $user = false, $stash = false, $repo = false ) {
                // user object. sometimes this won't exist, as when running from cron.
                $this->user = $user;
@@ -40,7 +65,11 @@ class UploadFromStash extends UploadBase {
 
                return true;
        }
-       
+
+       /**
+        * @param $key string
+        * @return bool
+        */
        public static function isValidKey( $key ) {
                // this is checked in more detail in UploadStash
                return (bool)preg_match( UploadStash::KEY_FORMAT_REGEX, $key );
@@ -58,13 +87,17 @@ class UploadFromStash extends UploadBase {
                return self::isValidKey( $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) ) );
        }
 
+       /**
+        * @param $key string
+        * @param $name string
+        */
        public function initialize( $key, $name = 'upload_file' ) {
                /**
                 * Confirming a temporarily stashed upload.
                 * We don't want path names to be forged, so we keep
                 * them in the session on the server and just give
                 * an opaque key to the user agent.
-                */             
+                */
                $metadata = $this->stash->getMetadata( $key );
                $this->initializePathInfo( $name,
                        $this->getRealPath ( $metadata['us_path'] ),
@@ -88,11 +121,14 @@ 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 );
        }
 
-       public function getSourceType() { 
-               return $this->mSourceType; 
+       /**
+        * @return string
+        */
+       public function getSourceType() {
+               return $this->mSourceType;
        }
 
        /**
@@ -106,6 +142,8 @@ class UploadFromStash extends UploadBase {
 
        /**
         * Stash the file.
+        *
+        * @return UploadStashFile
         */
        public function stashFile() {
                // replace mLocalFile with an instance of UploadStashFile, which adds some methods
@@ -115,15 +153,16 @@ class UploadFromStash extends UploadBase {
        }
 
        /**
-        * Alias for stashFile
+        * This should return the key instead of the UploadStashFile instance, for backward compatibility.
+        * @return String
         */
        public function stashSession() {
-               return $this->stashFile();
+               return $this->stashFile()->getFileKey();
        }
 
        /**
         * Remove a temporarily kept file stashed by saveTempUploadedFile().
-        * @return success
+        * @return bool success
         */
        public function unsaveUploadedFile() {
                return $this->stash->removeFile( $this->mFileKey );
@@ -131,43 +170,15 @@ class UploadFromStash extends UploadBase {
 
        /**
         * Perform the upload, then remove the database record afterward.
+        * @param $comment string
+        * @param $pageText string
+        * @param $watch bool
+        * @param $user User
+        * @return Status
         */
        public function performUpload( $comment, $pageText, $watch, $user ) {
                $rv = parent::performUpload( $comment, $pageText, $watch, $user );
                $this->unsaveUploadedFile();
                return $rv;
        }
-
-       /**
-        * Append a chunk to the temporary file.
-        *
-        * @return void
-        */
-       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 );
-       }
 }