includes/upload/UploadFromChunks.php

   1 <?php
   2 /**
   3  * Backend for uploading files from chunks.
   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 chunks
  26  *
  27  * @ingroup Upload
  28  * @author Michael Dale
  29  */
  30 class UploadFromChunks extends UploadFromFile {
  31         protected $mOffset;
  32         protected $mChunkIndex;
  33         protected $mFileKey;
  34         protected $mVirtualTempPath;
  35         /** @var LocalRepo */
  36         private $repo;
  37
  38         /**
  39          * Setup local pointers to stash, repo and user (similar to UploadFromStash)
  40          *
  41          * @param User|null $user Default: null
  42          * @param UploadStash|bool $stash Default: false
  43          * @param FileRepo|bool $repo Default: false
  44          */
  45         public function __construct( $user = null, $stash = false, $repo = false ) {
  46                 // user object. sometimes this won't exist, as when running from cron.
  47                 $this->user = $user;
  48
  49                 if ( $repo ) {
  50                         $this->repo = $repo;
  51                 } else {
  52                         $this->repo = RepoGroup::singleton()->getLocalRepo();
  53                 }
  54
  55                 if ( $stash ) {
  56                         $this->stash = $stash;
  57                 } else {
  58                         if ( $user ) {
  59                                 wfDebug( __METHOD__ . " creating new UploadFromChunks instance for " . $user->getId() . "\n" );
  60                         } else {
  61                                 wfDebug( __METHOD__ . " creating new UploadFromChunks instance with no user\n" );
  62                         }
  63                         $this->stash = new UploadStash( $this->repo, $this->user );
  64                 }
  65         }
  66
  67         /**
  68          * Calls the parent stashFile and updates the uploadsession table to handle "chunks"
  69          *
  70          * @param User|null $user
  71          * @return UploadStashFile Stashed file
  72          */
  73         public function stashFile( User $user = null ) {
  74                 // Stash file is the called on creating a new chunk session:
  75                 $this->mChunkIndex = 0;
  76                 $this->mOffset = 0;
  77
  78                 $this->verifyChunk();
  79                 // Create a local stash target
  80                 $this->mLocalFile = parent::stashFile( $user );
  81                 // Update the initial file offset (based on file size)
  82                 $this->mOffset = $this->mLocalFile->getSize();
  83                 $this->mFileKey = $this->mLocalFile->getFileKey();
  84
  85                 // Output a copy of this first to chunk 0 location:
  86                 $this->outputChunk( $this->mLocalFile->getPath() );
  87
  88                 // Update db table to reflect initial "chunk" state
  89                 $this->updateChunkStatus();
  90
  91                 return $this->mLocalFile;
  92         }
  93
  94         /**
  95          * Continue chunk uploading
  96          *
  97          * @param string $name
  98          * @param string $key
  99          * @param WebRequestUpload $webRequestUpload
 100          */
 101         public function continueChunks( $name, $key, $webRequestUpload ) {
 102                 $this->mFileKey = $key;
 103                 $this->mUpload = $webRequestUpload;
 104                 // Get the chunk status form the db:
 105                 $this->getChunkStatus();
 106
 107                 $metadata = $this->stash->getMetadata( $key );
 108                 $this->initializePathInfo( $name,
 109                         $this->getRealPath( $metadata['us_path'] ),
 110                         $metadata['us_size'],
 111                         false
 112                 );
 113         }
 114
 115         /**
 116          * Append the final chunk and ready file for parent::performUpload()
 117          * @return FileRepoStatus
 118          */
 119         public function concatenateChunks() {
 120                 $chunkIndex = $this->getChunkIndex();
 121                 wfDebug( __METHOD__ . " concatenate {$this->mChunkIndex} chunks:" .
 122                         $this->getOffset() . ' inx:' . $chunkIndex . "\n" );
 123
 124                 // Concatenate all the chunks to mVirtualTempPath
 125                 $fileList = [];
 126                 // The first chunk is stored at the mVirtualTempPath path so we start on "chunk 1"
 127                 for ( $i = 0; $i <= $chunkIndex; $i++ ) {
 128                         $fileList[] = $this->getVirtualChunkLocation( $i );
 129                 }
 130
 131                 // Get the file extension from the last chunk
 132                 $ext = FileBackend::extensionFromPath( $this->mVirtualTempPath );
 133                 // Get a 0-byte temp file to perform the concatenation at
 134                 $tmpFile = TempFSFile::factory( 'chunkedupload_', $ext );
 135                 $tmpPath = false; // fail in concatenate()
 136                 if ( $tmpFile ) {
 137                         // keep alive with $this
 138                         $tmpPath = $tmpFile->bind( $this )->getPath();
 139                 }
 140
 141                 // Concatenate the chunks at the temp file
 142                 $tStart = microtime( true );
 143                 $status = $this->repo->concatenate( $fileList, $tmpPath, FileRepo::DELETE_SOURCE );
 144                 $tAmount = microtime( true ) - $tStart;
 145                 if ( !$status->isOk() ) {
 146                         return $status;
 147                 }
 148                 wfDebugLog( 'fileconcatenate', "Combined $i chunks in $tAmount seconds." );
 149
 150                 // File system path of the actual full temp file
 151                 $this->setTempFile( $tmpPath );
 152
 153                 $ret = $this->verifyUpload();
 154                 if ( $ret['status'] !== UploadBase::OK ) {
 155                         wfDebugLog( 'fileconcatenate', "Verification failed for chunked upload" );
 156                         $status->fatal( $this->getVerificationErrorCode( $ret['status'] ) );
 157
 158                         return $status;
 159                 }
 160
 161                 // Update the mTempPath and mLocalFile
 162                 // (for FileUpload or normal Stash to take over)
 163                 $tStart = microtime( true );
 164                 $this->mLocalFile = parent::stashFile( $this->user );
 165                 $tAmount = microtime( true ) - $tStart;
 166                 $this->mLocalFile->setLocalReference( $tmpFile ); // reuse (e.g. for getImageInfo())
 167                 wfDebugLog( 'fileconcatenate', "Stashed combined file ($i chunks) in $tAmount seconds." );
 168
 169                 return $status;
 170         }
 171
 172         /**
 173          * Returns the virtual chunk location:
 174          * @param int $index
 175          * @return string
 176          */
 177         function getVirtualChunkLocation( $index ) {
 178                 return $this->repo->getVirtualUrl( 'temp' ) .
 179                         '/' .
 180                         $this->repo->getHashPath(
 181                                 $this->getChunkFileKey( $index )
 182                         ) .
 183                         $this->getChunkFileKey( $index );
 184         }
 185
 186         /**
 187          * Add a chunk to the temporary directory
 188          *
 189          * @param string $chunkPath Path to temporary chunk file
 190          * @param int $chunkSize Size of the current chunk
 191          * @param int $offset Offset of current chunk ( mutch match database chunk offset )
 192          * @return Status
 193          */
 194         public function addChunk( $chunkPath, $chunkSize, $offset ) {
 195                 // Get the offset before we add the chunk to the file system
 196                 $preAppendOffset = $this->getOffset();
 197
 198                 if ( $preAppendOffset + $chunkSize > $this->getMaxUploadSize() ) {
 199                         $status = Status::newFatal( 'file-too-large' );
 200                 } else {
 201                         // Make sure the client is uploading the correct chunk with a matching offset.
 202                         if ( $preAppendOffset == $offset ) {
 203                                 // Update local chunk index for the current chunk
 204                                 $this->mChunkIndex++;
 205                                 try {
 206                                         # For some reason mTempPath is set to first part
 207                                         $oldTemp = $this->mTempPath;
 208                                         $this->mTempPath = $chunkPath;
 209                                         $this->verifyChunk();
 210                                         $this->mTempPath = $oldTemp;
 211                                 } catch ( UploadChunkVerificationException $e ) {
 212                                         return Status::newFatal( $e->getMessage() );
 213                                 }
 214                                 $status = $this->outputChunk( $chunkPath );
 215                                 if ( $status->isGood() ) {
 216                                         // Update local offset:
 217                                         $this->mOffset = $preAppendOffset + $chunkSize;
 218                                         // Update chunk table status db
 219                                         $this->updateChunkStatus();
 220                                 }
 221                         } else {
 222                                 $status = Status::newFatal( 'invalid-chunk-offset' );
 223                         }
 224                 }
 225
 226                 return $status;
 227         }
 228
 229         /**
 230          * Update the chunk db table with the current status:
 231          */
 232         private function updateChunkStatus() {
 233                 wfDebug( __METHOD__ . " update chunk status for {$this->mFileKey} offset:" .
 234                         $this->getOffset() . ' inx:' . $this->getChunkIndex() . "\n" );
 235
 236                 $dbw = $this->repo->getMasterDb();
 237                 // Use a quick transaction since we will upload the full temp file into shared
 238                 // storage, which takes time for large files. We don't want to hold locks then.
 239                 $dbw->update(
 240                         'uploadstash',
 241                         [
 242                                 'us_status' => 'chunks',
 243                                 'us_chunk_inx' => $this->getChunkIndex(),
 244                                 'us_size' => $this->getOffset()
 245                         ],
 246                         [ 'us_key' => $this->mFileKey ],
 247                         __METHOD__
 248                 );
 249                 $dbw->commit( __METHOD__, 'flush' );
 250         }
 251
 252         /**
 253          * Get the chunk db state and populate update relevant local values
 254          */
 255         private function getChunkStatus() {
 256                 // get Master db to avoid race conditions.
 257                 // Otherwise, if chunk upload time < replag there will be spurious errors
 258                 $dbw = $this->repo->getMasterDb();
 259                 $row = $dbw->selectRow(
 260                         'uploadstash',
 261                         [
 262                                 'us_chunk_inx',
 263                                 'us_size',
 264                                 'us_path',
 265                         ],
 266                         [ 'us_key' => $this->mFileKey ],
 267                         __METHOD__
 268                 );
 269                 // Handle result:
 270                 if ( $row ) {
 271                         $this->mChunkIndex = $row->us_chunk_inx;
 272                         $this->mOffset = $row->us_size;
 273                         $this->mVirtualTempPath = $row->us_path;
 274                 }
 275         }
 276
 277         /**
 278          * Get the current Chunk index
 279          * @return int Index of the current chunk
 280          */
 281         private function getChunkIndex() {
 282                 if ( $this->mChunkIndex !== null ) {
 283                         return $this->mChunkIndex;
 284                 }
 285
 286                 return 0;
 287         }
 288
 289         /**
 290          * Get the offset at which the next uploaded chunk will be appended to
 291          * @return int Current byte offset of the chunk file set
 292          */
 293         public function getOffset() {
 294                 if ( $this->mOffset !== null ) {
 295                         return $this->mOffset;
 296                 }
 297
 298                 return 0;
 299         }
 300
 301         /**
 302          * Output the chunk to disk
 303          *
 304          * @param string $chunkPath
 305          * @throws UploadChunkFileException
 306          * @return FileRepoStatus
 307          */
 308         private function outputChunk( $chunkPath ) {
 309                 // Key is fileKey + chunk index
 310                 $fileKey = $this->getChunkFileKey();
 311
 312                 // Store the chunk per its indexed fileKey:
 313                 $hashPath = $this->repo->getHashPath( $fileKey );
 314                 $storeStatus = $this->repo->quickImport( $chunkPath,
 315                         $this->repo->getZonePath( 'temp' ) . "/{$hashPath}{$fileKey}" );
 316
 317                 // Check for error in stashing the chunk:
 318                 if ( !$storeStatus->isOK() ) {
 319                         $error = $storeStatus->getErrorsArray();
 320                         $error = reset( $error );
 321                         if ( !count( $error ) ) {
 322                                 $error = $storeStatus->getWarningsArray();
 323                                 $error = reset( $error );
 324                                 if ( !count( $error ) ) {
 325                                         $error = [ 'unknown', 'no error recorded' ];
 326                                 }
 327                         }
 328                         throw new UploadChunkFileException( "Error storing file in '$chunkPath': " .
 329                                 implode( '; ', $error ) );
 330                 }
 331
 332                 return $storeStatus;
 333         }
 334
 335         private function getChunkFileKey( $index = null ) {
 336                 if ( $index === null ) {
 337                         $index = $this->getChunkIndex();
 338                 }
 339
 340                 return $this->mFileKey . '.' . $index;
 341         }
 342
 343         /**
 344          * Verify that the chunk isn't really an evil html file
 345          *
 346          * @throws UploadChunkVerificationException
 347          */
 348         private function verifyChunk() {
 349                 // Rest mDesiredDestName here so we verify the name as if it were mFileKey
 350                 $oldDesiredDestName = $this->mDesiredDestName;
 351                 $this->mDesiredDestName = $this->mFileKey;
 352                 $this->mTitle = false;
 353                 $res = $this->verifyPartialFile();
 354                 $this->mDesiredDestName = $oldDesiredDestName;
 355                 $this->mTitle = false;
 356                 if ( is_array( $res ) ) {
 357                         throw new UploadChunkVerificationException( $res[0] );
 358                 }
 359         }
 360 }
 361
 362 class UploadChunkZeroLengthFileException extends MWException {
 363 }
 364
 365 class UploadChunkFileException extends MWException {
 366 }
 367
 368 class UploadChunkVerificationException extends MWException {
 369 }