includes/upload/UploadFromChunks.php

   1 <?php
   2 /**
   3  * @file
   4  * @ingroup upload
   5  *
   6  * First, destination checks are made, and, if ignorewarnings is not
   7  * checked, errors / warning is returned.
   8  *
   9  * 1. We return the uploadUrl.
  10  * 2. We then accept chunk uploads from the client.
  11  * 3. Return chunk id on each POSTED chunk.
  12  * 4. Once the client posts "done=1", the files are concatenated together.
  13  *
  14  * (More info at: http://firefogg.org/dev/chunk_post.html)
  15  */
  16 class UploadFromChunks extends UploadBase {
  17
  18         const INIT = 1;
  19         const CHUNK = 2;
  20         const DONE = 3;
  21
  22         protected $chunkMode; // INIT, CHUNK, DONE
  23         protected $sessionKey;
  24         protected $comment;
  25         protected $fileSize = 0;
  26         protected $repoPath;
  27         protected $pageText;
  28         protected $watch;
  29
  30         public $status;
  31
  32         // Parent class requires this function even though it is only
  33         // used from SpecialUpload.php and we don't do chunked uploading
  34         // from SpecialUpload -- best to raise an exception for
  35         // now.
  36         public function initializeFromRequest( &$request ) {
  37                 throw new MWException( 'not implemented' );
  38         }
  39
  40         public function initialize( $done, $filename, $sessionKey, $path,
  41                 $fileSize, $sessionData )
  42         {
  43                 $this->initFromSessionKey( $sessionKey, $sessionData );
  44
  45                 if ( !$this->sessionKey && !$done ) {
  46                         // session key not set, init the chunk upload system:
  47                         $this->chunkMode = self::INIT;
  48                         $this->mDesiredDestName = $filename;
  49                 } else if ( $this->sessionKey && !$done ) {
  50                         $this->chunkMode = self::CHUNK;
  51                 } else if ( $this->sessionKey && $done ) {
  52                         $this->chunkMode = self::DONE;
  53                 }
  54                 if ( $this->chunkMode == self::CHUNK || $this->chunkMode == self::DONE ) {
  55                         $this->mTempPath = $path;
  56                         $this->fileSize += $fileSize;
  57                 }
  58         }
  59
  60         /**
  61          * Set session information for chunked uploads and allocate a unique key.
  62          * @param $comment string
  63          * @param $pageText string
  64          * @param $watch boolean
  65          *
  66          * @returns string the session key for this chunked upload
  67          */
  68         protected function setupChunkSession( $comment, $pageText, $watch ) {
  69                 $this->sessionKey = $this->getSessionKey();
  70                 $_SESSION['wsUploadData'][$this->sessionKey] = array(
  71                         'comment' => $comment,
  72                         'pageText' => $pageText,
  73                         'watch' => $watch,
  74                         'mFilteredName' => $this->mFilteredName,
  75                         'repoPath' => null,
  76                         'mDesiredDestName' => $this->mDesiredDestName,
  77                         'version' => self::SESSION_VERSION,
  78                 );
  79                 return $this->sessionKey;
  80         }
  81
  82         /**
  83          * Initialize a continuation of a chunked upload from a session key
  84          * @param $sessionKey string
  85          * @param $request WebRequest
  86          *
  87          * @returns void
  88          */
  89         protected function initFromSessionKey( $sessionKey, $sessionData ) {
  90                 // testing against null because we don't want to cause obscure
  91                 // bugs when $sessionKey is full of "0"
  92                 if ( $sessionKey === null ) {
  93                         return;
  94                 }
  95                 $this->sessionKey = $sessionKey;
  96
  97                 if ( isset( $sessionData[$this->sessionKey]['version'] )
  98                         && $sessionData[$this->sessionKey]['version'] == self::SESSION_VERSION )
  99                 {
 100                         $this->comment = $sessionData[$this->sessionKey]['comment'];
 101                         $this->pageText = $sessionData[$this->sessionKey]['pageText'];
 102                         $this->watch = $sessionData[$this->sessionKey]['watch'];
 103                         $this->mFilteredName = $sessionData[$this->sessionKey]['mFilteredName'];
 104                         $this->repoPath = $sessionData[$this->sessionKey]['repoPath'];
 105                         $this->mDesiredDestName = $sessionData[$this->sessionKey]['mDesiredDestName'];
 106                 } else {
 107                         $this->status = Status::newFatal( 'invalid-session-key' );
 108                 }
 109         }
 110
 111         /**
 112          * Handle a chunk of the upload.  Overrides the parent method
 113          * because Chunked Uploading clients (i.e. Firefogg) require
 114          * specific API responses.
 115          * @see UploadBase::performUpload
 116          */
 117         public function performUpload( $comment, $pageText, $watch, $user ) {
 118                 wfDebug( "\n\n\performUpload(chunked): comment:" . $comment . ' pageText: ' . $pageText . ' watch:' . $watch );
 119                 global $wgUser, $wgOut;
 120
 121                 if ( $this->chunkMode == self::INIT ) {
 122                         // firefogg expects a specific result per:
 123                         // http://www.firefogg.org/dev/chunk_post.html
 124
 125                         // it's okay to return the token here because
 126                         // a) the user must have requested the token to get here and
 127                         // b) should only happen over POST
 128                         // c) we need the token to validate chunks are coming from a non-xss request
 129                         $token = urlencode( $wgUser->editToken() );
 130                         ob_clean();
 131                         echo FormatJson::encode( array(
 132                                 'uploadUrl' => wfExpandUrl( wfScript( 'api' ) ) . "?action=upload&" .
 133                                 "token={$token}&format=json&enablechunks=true&chunksessionkey=" .
 134                                 $this->setupChunkSession( $comment, $pageText, $watch ) ) );
 135                         $wgOut->disable();
 136                 } else if ( $this->chunkMode == self::CHUNK ) {
 137                         $status = $this->appendChunk();
 138                         if ( !$status->isOK() ) {
 139                                 return $status;
 140                         }
 141                         // return success:
 142                         // firefogg expects a specific result
 143                         // http://www.firefogg.org/dev/chunk_post.html
 144                         ob_clean();
 145                         echo FormatJson::encode(
 146                                 array( 'result' => 1, 'filesize' => $this->fileSize )
 147                         );
 148                         $wgOut->disable();
 149                 } else if ( $this->chunkMode == self::DONE ) {
 150                         if ( !$comment )
 151                                 $comment = $this->comment;
 152
 153                         if ( !$pageText )
 154                                 $pageText = $this->pageText;
 155
 156                         if ( !$watch )
 157                                 $watch = $this->watch;
 158
 159                         $status = parent::performUpload( $comment, $pageText, $watch, $user );
 160                         if ( !$status->isGood() ) {
 161                                 return $status;
 162                         }
 163                         $file = $this->getLocalFile();
 164
 165                         // firefogg expects a specific result
 166                         // http://www.firefogg.org/dev/chunk_post.html
 167                         ob_clean();
 168                         echo FormatJson::encode( array(
 169                                 'result' => 1,
 170                                 'done' => 1,
 171                                 'resultUrl' => $file->getDescriptionUrl() )
 172                         );
 173                         $wgOut->disable();
 174                 }
 175         }
 176
 177         /**
 178          * Append a chunk to the Repo file
 179          *
 180          * @param string $srcPath Path to file to append from
 181          * @param string $toAppendPath Path to file to append to
 182          * @return Status Status
 183          */
 184         protected function appendToUploadFile( $srcPath, $toAppendPath ) {
 185                 $repo = RepoGroup::singleton()->getLocalRepo();
 186                 $status = $repo->append( $srcPath, $toAppendPath );
 187                 return $status;
 188         }
 189
 190         /**
 191          * Append a chunk to the temporary file.
 192          *
 193          * @return void
 194          */
 195         protected function appendChunk() {
 196                 global $wgMaxUploadSize;
 197
 198                 if ( !$this->repoPath ) {
 199                         $this->status = $this->saveTempUploadedFile( $this->mDesiredDestName, $this->mTempPath );
 200
 201                         if ( $status->isOK() ) {
 202                                 $this->repoPath = $status->value;
 203                                 $_SESSION['wsUploadData'][$this->sessionKey]['repoPath'] = $this->repoPath;
 204                         }
 205                         return $status;
 206                 }
 207                 if ( $this->getRealPath( $this->repoPath ) ) {
 208                         $this->status = $this->appendToUploadFile( $this->repoPath, $this->mTempPath );
 209                 } else {
 210                         $this->status = Status::newFatal( 'filenotfound', $this->repoPath );
 211                 }
 212                 if ( $this->fileSize >  $wgMaxUploadSize )
 213                         $this->status = Status::newFatal( 'largefileserver' );
 214         }
 215
 216         public function verifyUpload() {
 217                 if ( $this->chunkMode != self::DONE ) {
 218                         return Status::newGood();
 219                 }
 220                 return parent::verifyUpload();
 221         }
 222
 223         public function checkWarnings() {
 224                 if ( $this->chunkMode != self::DONE ) {
 225                         return null;
 226                 }
 227                 return parent::checkWarnings();
 228         }
 229
 230         public function getImageInfo( $result ) {
 231                 if ( $this->chunkMode != self::DONE ) {
 232                         return null;
 233                 }
 234                 return parent::getImageInfo( $result );
 235         }
 236 }