Merge "Revert "Adding sanity check to Title::isRedirect().""
[lhc/web/wiklou.git] / includes / upload / UploadFromUrl.php
index b543070..c7e482e 100644 (file)
 <?php
+/**
+ * Backend for uploading files from a HTTP resource.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Upload
+ */
 
+/**
+ * Implements uploading from a HTTP resource.
+ *
+ * @ingroup Upload
+ * @author Bryan Tong Minh
+ * @author Michael Dale
+ */
 class UploadFromUrl extends UploadBase {
-       protected $mTempDownloadPath;
+       protected $mAsync, $mUrl;
+       protected $mIgnoreWarnings = true;
 
-       // by default do a SYNC_DOWNLOAD
-       protected $dl_mode =  Http::SYNC_DOWNLOAD;
+       protected $mTempPath, $mTmpHandle;
 
        /**
-        * Checks if the user is allowed to use the upload-by-URL feature
+        * Checks if the user is allowed to use the upload-by-URL feature. If the
+        * user is allowed, pass on permissions checking to the parent.
+        *
+        * @param $user User
+        *
+        * @return bool
         */
-       static function isAllowed( $user ) {
-               if( !$user->isAllowed( 'upload_by_url' ) )
+       public static function isAllowed( $user ) {
+               if ( !$user->isAllowed( 'upload_by_url' ) ) {
                        return 'upload_by_url';
+               }
                return parent::isAllowed( $user );
        }
 
        /**
         * Checks if the upload from URL feature is enabled
+        * @return bool
         */
-       static function isEnabled() {
+       public static function isEnabled() {
                global $wgAllowCopyUploads;
                return $wgAllowCopyUploads && parent::isEnabled();
        }
 
-       /* entry point for API upload:: ASYNC_DOWNLOAD (if possible) */
-       function initialize( $name, $url, $asyncdownload, $na = false ) {
-               global $wgTmpDirectory, $wgPhpCli;
-
-               // check for $asyncdownload request:
-               if( $asyncdownload !== false){
-                       if( $wgPhpCli && wfShellExecEnabled() ){
-                               $this->dl_mode = Http::ASYNC_DOWNLOAD;
-                       } else {
-                               $this->dl_mode = Http::SYNC_DOWNLOAD;
+       /**
+        * Checks whether the URL is for an allowed host
+        *
+        * @param $url string
+        * @return bool
+        */
+       public static function isAllowedHost( $url ) {
+               global $wgCopyUploadsDomains;
+               if ( !count( $wgCopyUploadsDomains ) ) {
+                       return true;
+               }
+               $parsedUrl = wfParseUrl( $url );
+               if ( !$parsedUrl ) {
+                       return false;
+               }
+               $valid = false;
+               foreach( $wgCopyUploadsDomains as $domain ) {
+                       if ( $parsedUrl['host'] === $domain ) {
+                               $valid = true;
+                               break;
                        }
                }
+               return $valid;
+       }
 
-               $local_file = tempnam( $wgTmpDirectory, 'WEBUPLOAD' );
-               parent::initialize( $name, $local_file, 0, true );
+       /**
+        * Entry point for API upload
+        *
+        * @param $name string
+        * @param $url string
+        * @param $async mixed Whether the download should be performed
+        * asynchronous. False for synchronous, async or async-leavemessage for
+        * asynchronous download.
+        */
+       public function initialize( $name, $url, $async = false ) {
+               global $wgAllowAsyncCopyUploads;
 
-               $this->mUrl = trim( $url );
-       }
+               $this->mUrl = $url;
+               $this->mAsync = $wgAllowAsyncCopyUploads ? $async : false;
+               if ( $async ) {
+                       throw new MWException( 'Asynchronous copy uploads are no longer possible as of r81612.' );
+               }
 
-       public function isAsync(){
-               return $this->dl_mode == Http::ASYNC_DOWNLOAD;
+               $tempPath = $this->mAsync ? null : $this->makeTemporaryFile();
+               # File size and removeTempFile will be filled in later
+               $this->initializePathInfo( $name, $tempPath, 0, false );
        }
 
        /**
-        * Entry point for SpecialUpload no ASYNC_DOWNLOAD possible
-        * @param $request Object: WebRequest object
+        * Entry point for SpecialUpload
+        * @param $request WebRequest object
         */
-       function initializeFromRequest( &$request ) {
-
-               // set dl mode if not set:
-               if( !$this->dl_mode )
-                       $this->dl_mode = Http::SYNC_DOWNLOAD;
-
+       public function initializeFromRequest( &$request ) {
                $desiredDestName = $request->getText( 'wpDestFile' );
-               if( !$desiredDestName )
-                       $desiredDestName = $request->getText( 'wpUploadFile' );
-               return $this->initialize(
+               if ( !$desiredDestName ) {
+                       $desiredDestName = $request->getText( 'wpUploadFileURL' );
+               }
+               $this->initialize(
                        $desiredDestName,
-                       $request->getVal( 'wpUploadFileURL' ),
+                       trim( $request->getVal( 'wpUploadFileURL' ) ),
                        false
                );
        }
 
        /**
-        * Do the real fetching stuff
+        * @param $request WebRequest object
+        * @return bool
+        */
+       public static function isValidRequest( $request ) {
+               global $wgUser;
+
+               $url = $request->getVal( 'wpUploadFileURL' );
+               return !empty( $url )
+                       && Http::isValidURI( $url )
+                       && $wgUser->isAllowed( 'upload_by_url' );
+       }
+
+       /**
+        * @return string
         */
-       function fetchFile() {
-               // entry point for SpecialUplaod
-               if( self::isValidURI( $this->mUrl ) === false ) {
-                       return Status::newFatal( 'upload-proto-error' );
+       public function getSourceType() { return 'url'; }
+
+       /**
+        * @return Status
+        */
+       public function fetchFile() {
+               if ( !Http::isValidURI( $this->mUrl ) ) {
+                       return Status::newFatal( 'http-invalid-url' );
                }
 
-               // now do the actual download to the target file:
-               $status = Http::doDownload( $this->mUrl, $this->mTempPath, $this->dl_mode );
+               if( !self::isAllowedHost( $this->mUrl ) ) {
+                       return Status::newFatal( 'upload-copy-upload-invalid-domain' );
+               }
+               if ( !$this->mAsync ) {
+                       return $this->reallyFetchFile();
+               }
+               return Status::newGood();
+       }
+       /**
+        * Create a new temporary file in the URL subdirectory of wfTempDir().
+        *
+        * @return string Path to the file
+        */
+       protected function makeTemporaryFile() {
+               return tempnam( wfTempDir(), 'URL' );
+       }
+
+       /**
+        * Callback: save a chunk of the result of a HTTP request to the temporary file
+        *
+        * @param $req mixed
+        * @param $buffer string
+        * @return int number of bytes handled
+        */
+       public function saveTempFileChunk( $req, $buffer ) {
+               $nbytes = fwrite( $this->mTmpHandle, $buffer );
 
-               // update the local filesize var:
-               $this->mFileSize = filesize( $this->mTempPath );
+               if ( $nbytes == strlen( $buffer ) ) {
+                       $this->mFileSize += $nbytes;
+               } else {
+                       // Well... that's not good!
+                       fclose( $this->mTmpHandle );
+                       $this->mTmpHandle = false;
+               }
+
+               return $nbytes;
+       }
+
+       /**
+        * Download the file, save it to the temporary file and update the file
+        * size and set $mRemoveTempFile to true.
+        * @return Status
+        */
+       protected function reallyFetchFile() {
+               if ( $this->mTempPath === false ) {
+                       return Status::newFatal( 'tmp-create-error' );
+               }
+
+               // Note the temporary file should already be created by makeTemporaryFile()
+               $this->mTmpHandle = fopen( $this->mTempPath, 'wb' );
+               if ( !$this->mTmpHandle ) {
+                       return Status::newFatal( 'tmp-create-error' );
+               }
+
+               $this->mRemoveTempFile = true;
+               $this->mFileSize = 0;
+
+               $req = MWHttpRequest::factory( $this->mUrl, array(
+                       'followRedirects' => true
+               ) );
+               $req->setCallback( array( $this, 'saveTempFileChunk' ) );
+               $status = $req->execute();
+
+               if ( $this->mTmpHandle ) {
+                       // File got written ok...
+                       fclose( $this->mTmpHandle );
+                       $this->mTmpHandle = null;
+               } else {
+                       // We encountered a write error during the download...
+                       return Status::newFatal( 'tmp-write-error' );
+               }
+
+               if ( !$status->isOk() ) {
+                       return $status;
+               }
 
                return $status;
        }
 
        /**
-        * @param $request Object: WebRequest object
+        * Wrapper around the parent function in order to defer verifying the
+        * upload until the file really has been fetched.
+        * @return array|mixed
         */
-       static function isValidRequest( $request ){
-               if( !$request->getVal( 'wpUploadFileURL' ) )
-                       return false;
-               // check that is a valid url:
-               return self::isValidURI( $request->getVal( 'wpUploadFileURL' ) );
+       public function verifyUpload() {
+               if ( $this->mAsync ) {
+                       return array( 'status' => UploadBase::OK );
+               }
+               return parent::verifyUpload();
        }
 
        /**
-        * Checks that the given URI is a valid one
-        * @param $uri Mixed: URI to check for validity
+        * Wrapper around the parent function in order to defer checking warnings
+        * until the file really has been fetched.
+        * @return Array
         */
-       static function isValidURI( $uri ){
-               return preg_match(
-                       '/(ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?/',
-                       $uri,
-                       $matches
-               );
+       public function checkWarnings() {
+               if ( $this->mAsync ) {
+                       $this->mIgnoreWarnings = false;
+                       return array();
+               }
+               return parent::checkWarnings();
+       }
+
+       /**
+        * Wrapper around the parent function in order to defer checking protection
+        * until we are sure that the file can actually be uploaded
+        * @return bool|mixed
+        */
+       public function verifyTitlePermissions( $user ) {
+               if ( $this->mAsync ) {
+                       return true;
+               }
+               return parent::verifyTitlePermissions( $user );
+       }
+
+       /**
+        * Wrapper around the parent function in order to defer uploading to the
+        * job queue for asynchronous uploads
+        * @return Status
+        */
+       public function performUpload( $comment, $pageText, $watch, $user ) {
+               if ( $this->mAsync ) {
+                       $sessionKey = $this->insertJob( $comment, $pageText, $watch, $user );
+
+                       return Status::newFatal( 'async', $sessionKey );
+               }
+
+               return parent::performUpload( $comment, $pageText, $watch, $user );
+       }
+
+       /**
+        * @param  $comment
+        * @param  $pageText
+        * @param  $watch
+        * @param  $user User
+        * @return
+        */
+       protected function insertJob( $comment, $pageText, $watch, $user ) {
+               $sessionKey = $this->stashSession();
+               $job = new UploadFromUrlJob( $this->getTitle(), array(
+                       'url' => $this->mUrl,
+                       'comment' => $comment,
+                       'pageText' => $pageText,
+                       'watch' => $watch,
+                       'userName' => $user->getName(),
+                       'leaveMessage' => $this->mAsync == 'async-leavemessage',
+                       'ignoreWarnings' => $this->mIgnoreWarnings,
+                       'sessionId' => session_id(),
+                       'sessionKey' => $sessionKey,
+               ) );
+               $job->initializeSessionData();
+               $job->insert();
+               return $sessionKey;
        }
 
-}
\ No newline at end of file
+}