includes/upload/UploadFromUrl.php

   1 <?php
   2 /**
   3  * Implements uploading from a HTTP resource.
   4  *
   5  * @file
   6  * @ingroup upload
   7  * @author Bryan Tong Minh
   8  * @author Michael Dale
   9  */
  10
  11 class UploadFromUrl extends UploadBase {
  12         protected $mAsync, $mUrl;
  13         protected $mIgnoreWarnings = true;
  14
  15         /**
  16          * Checks if the user is allowed to use the upload-by-URL feature. If the
  17          * user is allowed, pass on permissions checking to the parent.
  18          */
  19         public static function isAllowed( $user ) {
  20                 if ( !$user->isAllowed( 'upload_by_url' ) )
  21                         return 'upload_by_url';
  22                 return parent::isAllowed( $user );
  23         }
  24
  25         /**
  26          * Checks if the upload from URL feature is enabled
  27          * @return bool
  28          */
  29         public static function isEnabled() {
  30                 global $wgAllowCopyUploads;
  31                 return $wgAllowCopyUploads && parent::isEnabled();
  32         }
  33
  34         /**
  35          * Entry point for API upload
  36          *
  37          * @param $name string
  38          * @param $url string
  39          * @param $async mixed Whether the download should be performed
  40          * asynchronous. False for synchronous, async or async-leavemessage for
  41          * asynchronous download.
  42          */
  43         public function initialize( $name, $url, $async = false ) {
  44                 global $wgAllowAsyncCopyUploads;
  45
  46                 $this->mUrl = $url;
  47                 $this->mAsync = $wgAllowAsyncCopyUploads ? $async : false;
  48
  49                 $tempPath = $this->mAsync ? null : $this->makeTemporaryFile();
  50                 # File size and removeTempFile will be filled in later
  51                 $this->initializePathInfo( $name, $tempPath, 0, false );
  52         }
  53
  54         /**
  55          * Entry point for SpecialUpload
  56          * @param $request Object: WebRequest object
  57          */
  58         public function initializeFromRequest( &$request ) {
  59                 $desiredDestName = $request->getText( 'wpDestFile' );
  60                 if ( !$desiredDestName )
  61                         $desiredDestName = $request->getText( 'wpUploadFileURL' );
  62                 return $this->initialize(
  63                         $desiredDestName,
  64                         $request->getVal( 'wpUploadFileURL' ),
  65                         false
  66                 );
  67         }
  68
  69         /**
  70          * @param $request Object: WebRequest object
  71          */
  72         public static function isValidRequest( $request ) {
  73                 global $wgUser;
  74
  75                 $url = $request->getVal( 'wpUploadFileURL' );
  76                 return !empty( $url )
  77                         && Http::isValidURI( $url )
  78                         && $wgUser->isAllowed( 'upload_by_url' );
  79         }
  80
  81
  82         public function fetchFile() {
  83                 if ( !Http::isValidURI( $this->mUrl ) ) {
  84                         return Status::newFatal( 'http-invalid-url' );
  85                 }
  86
  87                 if ( !$this->mAsync ) {
  88                         return $this->reallyFetchFile();
  89                 }
  90                 return Status::newGood();
  91         }
  92         /**
  93          * Create a new temporary file in the URL subdirectory of wfTempDir().
  94          *
  95          * @return string Path to the file
  96          */
  97         protected function makeTemporaryFile() {
  98                 return tempnam( wfTempDir(), 'URL' );
  99         }
 100         /**
 101          * Save the result of a HTTP request to the temporary file
 102          *
 103          * @param $req MWHttpRequest
 104          * @return Status
 105          */
 106         private function saveTempFile( $req ) {
 107                 if ( $this->mTempPath === false ) {
 108                         return Status::newFatal( 'tmp-create-error' );
 109                 }
 110                 if ( file_put_contents( $this->mTempPath, $req->getContent() ) === false ) {
 111                         return Status::newFatal( 'tmp-write-error' );
 112                 }
 113
 114                 $this->mFileSize = filesize( $this->mTempPath );
 115
 116                 return Status::newGood();
 117         }
 118         /**
 119          * Download the file, save it to the temporary file and update the file
 120          * size and set $mRemoveTempFile to true.
 121          */
 122         protected function reallyFetchFile() {
 123                 $req = MWHttpRequest::factory( $this->mUrl );
 124                 $status = $req->execute();
 125
 126                 if ( !$status->isOk() ) {
 127                         return $status;
 128                 }
 129
 130                 $status = $this->saveTempFile( $req );
 131                 if ( !$status->isGood() ) {
 132                         return $status;
 133                 }
 134                 $this->mRemoveTempFile = true;
 135
 136                 return $status;
 137         }
 138
 139         /**
 140          * Wrapper around the parent function in order to defer verifying the
 141          * upload until the file really has been fetched.
 142          */
 143         public function verifyUpload() {
 144                 if ( $this->mAsync ) {
 145                         return array( 'status' => self::OK );
 146                 }
 147                 return parent::verifyUpload();
 148         }
 149
 150         /**
 151          * Wrapper around the parent function in order to defer checking warnings
 152          * until the file really has been fetched.
 153          */
 154         public function checkWarnings() {
 155                 if ( $this->mAsync ) {
 156                         $this->mIgnoreWarnings = false;
 157                         return array();
 158                 }
 159                 return parent::checkWarnings();
 160         }
 161
 162         /**
 163          * Wrapper around the parent function in order to defer checking protection
 164          * until we are sure that the file can actually be uploaded
 165          */
 166         public function verifyPermissions( $user ) {
 167                 if ( $this->mAsync ) {
 168                         return true;
 169                 }
 170                 return parent::verifyPermissions( $user );
 171         }
 172
 173         /**
 174          * Wrapper around the parent function in order to defer uploading to the
 175          * job queue for asynchronous uploads
 176          */
 177         public function performUpload( $comment, $pageText, $watch, $user ) {
 178                 if ( $this->mAsync ) {
 179                         $sessionKey = $this->insertJob( $comment, $pageText, $watch, $user );
 180
 181                         $status = new Status;
 182                         $status->error( 'async', $sessionKey );
 183                         return $status;
 184                 }
 185
 186                 return parent::performUpload( $comment, $pageText, $watch, $user );
 187         }
 188
 189
 190         protected function insertJob( $comment, $pageText, $watch, $user ) {
 191                 $sessionKey = $this->getSessionKey();
 192                 $job = new UploadFromUrlJob( $this->getTitle(), array(
 193                         'url' => $this->mUrl,
 194                         'comment' => $comment,
 195                         'pageText' => $pageText,
 196                         'watch' => $watch,
 197                         'userName' => $user->getName(),
 198                         'leaveMessage' => $this->mAsync == 'async-leavemessage',
 199                         'ignoreWarnings' => $this->mIgnoreWarnings,
 200                         'sessionId' => session_id(),
 201                         'sessionKey' => $sessionKey,
 202                 ) );
 203                 $job->initializeSessionData();
 204                 $job->insert();
 205                 return $sessionKey;
 206         }
 207
 208
 209 }