includes/jobqueue/jobs/PublishStashedFileJob.php

   1 <?php
   2 /**
   3  * Upload a file from the upload stash into the local file repo.
   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  * Upload a file from the upload stash into the local file repo.
  26  *
  27  * @ingroup Upload
  28  */
  29 class PublishStashedFileJob extends Job {
  30         public function __construct( $title, $params ) {
  31                 parent::__construct( 'PublishStashedFile', $title, $params );
  32                 $this->removeDuplicates = true;
  33         }
  34
  35         public function run() {
  36                 $scope = RequestContext::importScopedSession( $this->params['session'] );
  37                 $context = RequestContext::getMain();
  38                 $user = $context->getUser();
  39                 try {
  40                         if ( !$user->isLoggedIn() ) {
  41                                 $this->setLastError( "Could not load the author user from session." );
  42
  43                                 return false;
  44                         }
  45
  46                         UploadBase::setSessionStatus(
  47                                 $user,
  48                                 $this->params['filekey'],
  49                                 array( 'result' => 'Poll', 'stage' => 'publish', 'status' => Status::newGood() )
  50                         );
  51
  52                         $upload = new UploadFromStash( $user );
  53                         // @todo initialize() causes a GET, ideally we could frontload the antivirus
  54                         // checks and anything else to the stash stage (which includes concatenation and
  55                         // the local file is thus already there). That way, instead of GET+PUT, there could
  56                         // just be a COPY operation from the stash to the public zone.
  57                         $upload->initialize( $this->params['filekey'], $this->params['filename'] );
  58
  59                         // Check if the local file checks out (this is generally a no-op)
  60                         $verification = $upload->verifyUpload();
  61                         if ( $verification['status'] !== UploadBase::OK ) {
  62                                 $status = Status::newFatal( 'verification-error' );
  63                                 $status->value = array( 'verification' => $verification );
  64                                 UploadBase::setSessionStatus(
  65                                         $user,
  66                                         $this->params['filekey'],
  67                                         array( 'result' => 'Failure', 'stage' => 'publish', 'status' => $status )
  68                                 );
  69                                 $this->setLastError( "Could not verify upload." );
  70
  71                                 return false;
  72                         }
  73
  74                         // Upload the stashed file to a permanent location
  75                         $status = $upload->performUpload(
  76                                 $this->params['comment'],
  77                                 $this->params['text'],
  78                                 $this->params['watch'],
  79                                 $user
  80                         );
  81                         if ( !$status->isGood() ) {
  82                                 UploadBase::setSessionStatus(
  83                                         $user,
  84                                         $this->params['filekey'],
  85                                         array( 'result' => 'Failure', 'stage' => 'publish', 'status' => $status )
  86                                 );
  87                                 $this->setLastError( $status->getWikiText() );
  88
  89                                 return false;
  90                         }
  91
  92                         // Build the image info array while we have the local reference handy
  93                         $apiMain = new ApiMain(); // dummy object (XXX)
  94                         $imageInfo = $upload->getImageInfo( $apiMain->getResult() );
  95
  96                         // Cleanup any temporary local file
  97                         $upload->cleanupTempFile();
  98
  99                         // Cache the info so the user doesn't have to wait forever to get the final info
 100                         UploadBase::setSessionStatus(
 101                                 $user,
 102                                 $this->params['filekey'],
 103                                 array(
 104                                         'result' => 'Success',
 105                                         'stage' => 'publish',
 106                                         'filename' => $upload->getLocalFile()->getName(),
 107                                         'imageinfo' => $imageInfo,
 108                                         'status' => Status::newGood()
 109                                 )
 110                         );
 111                 } catch ( Exception $e ) {
 112                         UploadBase::setSessionStatus(
 113                                 $user,
 114                                 $this->params['filekey'],
 115                                 array(
 116                                         'result' => 'Failure',
 117                                         'stage' => 'publish',
 118                                         'status' => Status::newFatal( 'api-error-publishfailed' )
 119                                 )
 120                         );
 121                         $this->setLastError( get_class( $e ) . ": " . $e->getText() );
 122                         // To prevent potential database referential integrity issues.
 123                         // See bug 32551.
 124                         MWExceptionHandler::rollbackMasterChangesAndLog( $e );
 125
 126                         return false;
 127                 }
 128
 129                 return true;
 130         }
 131
 132         public function getDeduplicationInfo() {
 133                 $info = parent::getDeduplicationInfo();
 134                 if ( is_array( $info['params'] ) ) {
 135                         $info['params'] = array( 'filekey' => $info['params']['filekey'] );
 136                 }
 137
 138                 return $info;
 139         }
 140
 141         public function allowRetries() {
 142                 return false;
 143         }
 144 }