includes/upload/UploadFromStash.php

   1 <?php
   2 /**
   3  * Backend for uploading files from previously stored file.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Upload
  22  */
  23
  24 /**
  25  * Implements uploading from previously stored file.
  26  *
  27  * @ingroup Upload
  28  * @author Bryan Tong Minh
  29  */
  30 class UploadFromStash extends UploadBase {
  31         protected $mFileKey, $mVirtualTempPath, $mFileProps, $mSourceType;
  32
  33         // an instance of UploadStash
  34         private $stash;
  35
  36         //LocalFile repo
  37         private $repo;
  38
  39         /**
  40          * @param $user User
  41          * @param $stash UploadStash
  42          * @param $repo FileRepo
  43          */
  44         public function __construct( $user = false, $stash = false, $repo = false ) {
  45                 // user object. sometimes this won't exist, as when running from cron.
  46                 $this->user = $user;
  47
  48                 if( $repo ) {
  49                         $this->repo = $repo;
  50                 } else {
  51                         $this->repo = RepoGroup::singleton()->getLocalRepo();
  52                 }
  53
  54                 if( $stash ) {
  55                         $this->stash = $stash;
  56                 } else {
  57                         if( $user ) {
  58                                 wfDebug( __METHOD__ . " creating new UploadStash instance for " . $user->getId() . "\n" );
  59                         } else {
  60                                 wfDebug( __METHOD__ . " creating new UploadStash instance with no user\n" );
  61                         }
  62
  63                         $this->stash = new UploadStash( $this->repo, $this->user );
  64                 }
  65         }
  66
  67         /**
  68          * @param $key string
  69          * @return bool
  70          */
  71         public static function isValidKey( $key ) {
  72                 // this is checked in more detail in UploadStash
  73                 return (bool)preg_match( UploadStash::KEY_FORMAT_REGEX, $key );
  74         }
  75
  76         /**
  77          * @param $request WebRequest
  78          *
  79          * @return Boolean
  80          */
  81         public static function isValidRequest( $request ) {
  82                 // this passes wpSessionKey to getText() as a default when wpFileKey isn't set.
  83                 // wpSessionKey has no default which guarantees failure if both are missing
  84                 // (though that should have been caught earlier)
  85                 return self::isValidKey( $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) ) );
  86         }
  87
  88         /**
  89          * @param $key string
  90          * @param $name string
  91          */
  92         public function initialize( $key, $name = 'upload_file', $initTempFile = true ) {
  93                 /**
  94                  * Confirming a temporarily stashed upload.
  95                  * We don't want path names to be forged, so we keep
  96                  * them in the session on the server and just give
  97                  * an opaque key to the user agent.
  98                  */
  99                 $metadata = $this->stash->getMetadata( $key );
 100                 $this->initializePathInfo( $name,
 101                         $initTempFile ? $this->getRealPath( $metadata['us_path'] ) : false,
 102                         $metadata['us_size'],
 103                         false
 104                 );
 105
 106                 $this->mFileKey = $key;
 107                 $this->mVirtualTempPath = $metadata['us_path'];
 108                 $this->mFileProps = $this->stash->getFileProps( $key );
 109                 $this->mSourceType = $metadata['us_source_type'];
 110         }
 111
 112         /**
 113          * @param $request WebRequest
 114          */
 115         public function initializeFromRequest( &$request ) {
 116                 // sends wpSessionKey as a default when wpFileKey is missing
 117                 $fileKey = $request->getText( 'wpFileKey', $request->getText( 'wpSessionKey' ) );
 118
 119                 // chooses one of wpDestFile, wpUploadFile, filename in that order.
 120                 $desiredDestName = $request->getText( 'wpDestFile', $request->getText( 'wpUploadFile', $request->getText( 'filename' ) ) );
 121
 122                 $this->initialize( $fileKey, $desiredDestName );
 123         }
 124
 125         /**
 126          * @return string
 127          */
 128         public function getSourceType() {
 129                 return $this->mSourceType;
 130         }
 131
 132         /**
 133          * Get the base 36 SHA1 of the file
 134          * @return string
 135          */
 136         public function getTempFileSha1Base36() {
 137                 return $this->mFileProps['sha1'];
 138         }
 139
 140         /**
 141          * File has been previously verified so no need to do so again.
 142          *
 143          * @return bool
 144          */
 145         protected function verifyFile() {
 146                 return true;
 147         }
 148
 149         /**
 150          * Stash the file.
 151          *
 152          * @param $user User
 153          * @return UploadStashFile
 154          */
 155         public function stashFile( User $user = null ) {
 156                 // replace mLocalFile with an instance of UploadStashFile, which adds some methods
 157                 // that are useful for stashed files.
 158                 $this->mLocalFile = parent::stashFile( $user );
 159                 return $this->mLocalFile;
 160         }
 161
 162         /**
 163          * This should return the key instead of the UploadStashFile instance, for backward compatibility.
 164          * @return String
 165          */
 166         public function stashSession() {
 167                 return $this->stashFile()->getFileKey();
 168         }
 169
 170         /**
 171          * Remove a temporarily kept file stashed by saveTempUploadedFile().
 172          * @return bool success
 173          */
 174         public function unsaveUploadedFile() {
 175                 return $this->stash->removeFile( $this->mFileKey );
 176         }
 177
 178         /**
 179          * Perform the upload, then remove the database record afterward.
 180          * @param $comment string
 181          * @param $pageText string
 182          * @param $watch bool
 183          * @param $user User
 184          * @return Status
 185          */
 186         public function performUpload( $comment, $pageText, $watch, $user ) {
 187                 $rv = parent::performUpload( $comment, $pageText, $watch, $user );
 188                 $this->unsaveUploadedFile();
 189                 return $rv;
 190         }
 191 }