includes/jobqueue/jobs/AssembleUploadChunksJob.php

   1 <?php
   2 /**
   3  * Assemble the segments of a chunked upload.
   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  * Assemble the segments of a chunked upload.
  26  *
  27  * @ingroup Upload
  28  */
  29 class AssembleUploadChunksJob extends Job {
  30         public function __construct( Title $title, array $params ) {
  31                 parent::__construct( 'AssembleUploadChunks', $title, $params );
  32                 $this->removeDuplicates = true;
  33         }
  34
  35         public function run() {
  36                 $scope = RequestContext::importScopedSession( $this->params['session'] );
  37                 $this->addTeardownCallback( function () use ( &$scope ) {
  38                         ScopedCallback::consume( $scope ); // T126450
  39                 } );
  40
  41                 $context = RequestContext::getMain();
  42                 $user = $context->getUser();
  43                 try {
  44                         if ( !$user->isLoggedIn() ) {
  45                                 $this->setLastError( "Could not load the author user from session." );
  46
  47                                 return false;
  48                         }
  49
  50                         UploadBase::setSessionStatus(
  51                                 $user,
  52                                 $this->params['filekey'],
  53                                 [ 'result' => 'Poll', 'stage' => 'assembling', 'status' => Status::newGood() ]
  54                         );
  55
  56                         $upload = new UploadFromChunks( $user );
  57                         $upload->continueChunks(
  58                                 $this->params['filename'],
  59                                 $this->params['filekey'],
  60                                 new WebRequestUpload( $context->getRequest(), 'null' )
  61                         );
  62
  63                         // Combine all of the chunks into a local file and upload that to a new stash file
  64                         $status = $upload->concatenateChunks();
  65                         if ( !$status->isGood() ) {
  66                                 UploadBase::setSessionStatus(
  67                                         $user,
  68                                         $this->params['filekey'],
  69                                         [ 'result' => 'Failure', 'stage' => 'assembling', 'status' => $status ]
  70                                 );
  71                                 $this->setLastError( $status->getWikiText( false, false, 'en' ) );
  72
  73                                 return false;
  74                         }
  75
  76                         // We can only get warnings like 'duplicate' after concatenating the chunks
  77                         $status = Status::newGood();
  78                         $status->value = [ 'warnings' => $upload->checkWarnings() ];
  79
  80                         // We have a new filekey for the fully concatenated file
  81                         $newFileKey = $upload->getStashFile()->getFileKey();
  82
  83                         // Remove the old stash file row and first chunk file
  84                         $upload->stash->removeFileNoAuth( $this->params['filekey'] );
  85
  86                         // Build the image info array while we have the local reference handy
  87                         $apiMain = new ApiMain(); // dummy object (XXX)
  88                         $imageInfo = $upload->getImageInfo( $apiMain->getResult() );
  89
  90                         // Cleanup any temporary local file
  91                         $upload->cleanupTempFile();
  92
  93                         // Cache the info so the user doesn't have to wait forever to get the final info
  94                         UploadBase::setSessionStatus(
  95                                 $user,
  96                                 $this->params['filekey'],
  97                                 [
  98                                         'result' => 'Success',
  99                                         'stage' => 'assembling',
 100                                         'filekey' => $newFileKey,
 101                                         'imageinfo' => $imageInfo,
 102                                         'status' => $status
 103                                 ]
 104                         );
 105                 } catch ( Exception $e ) {
 106                         UploadBase::setSessionStatus(
 107                                 $user,
 108                                 $this->params['filekey'],
 109                                 [
 110                                         'result' => 'Failure',
 111                                         'stage' => 'assembling',
 112                                         'status' => Status::newFatal( 'api-error-stashfailed' )
 113                                 ]
 114                         );
 115                         $this->setLastError( get_class( $e ) . ": " . $e->getMessage() );
 116                         // To be extra robust.
 117                         MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 118
 119                         return false;
 120                 }
 121
 122                 return true;
 123         }
 124
 125         public function getDeduplicationInfo() {
 126                 $info = parent::getDeduplicationInfo();
 127                 if ( is_array( $info['params'] ) ) {
 128                         $info['params'] = [ 'filekey' => $info['params']['filekey'] ];
 129                 }
 130
 131                 return $info;
 132         }
 133
 134         public function allowRetries() {
 135                 return false;
 136         }
 137 }