includes/job/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, $params, $id = 0 ) {
  31                 parent::__construct( 'AssembleUploadChunks', $title, $params, $id );
  32                 $this->removeDuplicates = true;
  33         }
  34
  35         public function run() {
  36                 $scope = RequestContext::importScopedSession( $this->params['session'] );
  37                 $context = RequestContext::getMain();
  38                 try {
  39                         $user = $context->getUser();
  40                         if ( !$user->isLoggedIn() ) {
  41                                 $this->setLastError( "Could not load the author user from session." );
  42                                 return false;
  43                         }
  44
  45                         if ( count( $_SESSION ) === 0 ) {
  46                                 // Empty session probably indicates that we didn't associate
  47                                 // with the session correctly. Note that being able to load
  48                                 // the user does not necessarily mean the session was loaded.
  49                                 // Most likely cause by suhosin.session.encrypt = On.
  50                                 $this->setLastError( "Error associating with user session. Try setting suhosin.session.encrypt = Off" );
  51                                 return false;
  52                         }
  53
  54                         UploadBase::setSessionStatus(
  55                                 $this->params['filekey'],
  56                                 array( 'result' => 'Poll', 'stage' => 'assembling', 'status' => Status::newGood() )
  57                         );
  58
  59                         $upload = new UploadFromChunks( $user );
  60                         $upload->continueChunks(
  61                                 $this->params['filename'],
  62                                 $this->params['filekey'],
  63                                 $context->getRequest()
  64                         );
  65
  66                         // Combine all of the chunks into a local file and upload that to a new stash file
  67                         $status = $upload->concatenateChunks();
  68                         if ( !$status->isGood() ) {
  69                                 UploadBase::setSessionStatus(
  70                                         $this->params['filekey'],
  71                                         array( 'result' => 'Failure', 'stage' => 'assembling', 'status' => $status )
  72                                 );
  73                                 $this->setLastError( $status->getWikiText() );
  74                                 return false;
  75                         }
  76
  77                         // We have a new filekey for the fully concatenated file
  78                         $newFileKey = $upload->getLocalFile()->getFileKey();
  79
  80                         // Remove the old stash file row and first chunk file
  81                         $upload->stash->removeFileNoAuth( $this->params['filekey'] );
  82
  83                         // Build the image info array while we have the local reference handy
  84                         $apiMain = new ApiMain(); // dummy object (XXX)
  85                         $imageInfo = $upload->getImageInfo( $apiMain->getResult() );
  86
  87                         // Cleanup any temporary local file
  88                         $upload->cleanupTempFile();
  89
  90                         // Cache the info so the user doesn't have to wait forever to get the final info
  91                         UploadBase::setSessionStatus(
  92                                 $this->params['filekey'],
  93                                 array(
  94                                         'result' => 'Success',
  95                                         'stage' => 'assembling',
  96                                         'filekey' => $newFileKey,
  97                                         'imageinfo' => $imageInfo,
  98                                         'status' => Status::newGood()
  99                                 )
 100                         );
 101                 } catch ( MWException $e ) {
 102                         UploadBase::setSessionStatus(
 103                                 $this->params['filekey'],
 104                                 array(
 105                                         'result' => 'Failure',
 106                                         'stage' => 'assembling',
 107                                         'status' => Status::newFatal( 'api-error-stashfailed' )
 108                                 )
 109                         );
 110                         $this->setLastError( get_class( $e ) . ": " . $e->getText() );
 111                         return false;
 112                 }
 113                 return true;
 114         }
 115
 116         public function getDeduplicationInfo() {
 117                 $info = parent::getDeduplicationInfo();
 118                 if ( is_array( $info['params'] ) ) {
 119                         $info['params'] = array( 'filekey' => $info['params']['filekey'] );
 120                 }
 121                 return $info;
 122         }
 123
 124         public function allowRetries() {
 125                 return false;
 126         }
 127 }