* (bug 25248) API: paraminfo errors with certain modules
[lhc/web/wiklou.git] / includes / upload / UploadFromUrl.php
index af97d9f..42b3827 100644 (file)
@@ -1,28 +1,30 @@
 <?php
 /**
- * @file
- * @ingroup upload
- *
  * Implements uploading from a HTTP resource.
  *
+ * @file
+ * @ingroup upload
  * @author Bryan Tong Minh
  * @author Michael Dale
  */
+
 class UploadFromUrl extends UploadBase {
-       protected $mTempDownloadPath;
+       protected $mAsync, $mUrl;
+       protected $mIgnoreWarnings = true;
 
        /**
         * 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.
         */
        public static function isAllowed( $user ) {
-               if( !$user->isAllowed( 'upload_by_url' ) )
+               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
         */
        public static function isEnabled() {
                global $wgAllowCopyUploads;
@@ -31,14 +33,22 @@ class UploadFromUrl extends UploadBase {
 
        /**
         * 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, $na, $nb = false ) {
-               global $wgTmpDirectory;
-
-               $localFile = tempnam( $wgTmpDirectory, 'WEBUPLOAD' );
-               $this->initializePathInfo( $name, $localFile, 0, true );
-
-               $this->mUrl = trim( $url );
+       public function initialize( $name, $url, $async = false ) {
+               global $wgAllowAsyncCopyUploads;
+               
+               $this->mUrl = $url;
+               $this->mAsync = $wgAllowAsyncCopyUploads ? $async : false;
+               
+               $tempPath = $this->mAsync ? null : $this->makeTemporaryFile();
+               # File size and removeTempFile will be filled in later
+               $this->initializePathInfo( $name, $tempPath, 0, false );
        }
 
        /**
@@ -47,7 +57,7 @@ class UploadFromUrl extends UploadBase {
         */
        public function initializeFromRequest( &$request ) {
                $desiredDestName = $request->getText( 'wpDestFile' );
-               if( !$desiredDestName )
+               if ( !$desiredDestName )
                        $desiredDestName = $request->getText( 'wpUploadFileURL' );
                return $this->initialize(
                        $desiredDestName,
@@ -59,67 +69,141 @@ class UploadFromUrl extends UploadBase {
        /**
         * @param $request Object: WebRequest object
         */
-       public static function isValidRequest( $request ){
-               if( !$request->getVal( 'wpUploadFileURL' ) )
-                       return false;
-               // check that is a valid url:
-               return self::isValidUrl( $request->getVal( 'wpUploadFileURL' ) );
-       }
+       public static function isValidRequest( $request ) {
+               global $wgUser;
 
-       public static function isValidUrl( $url ) {
-               // Only allow HTTP or FTP for now
-               return (bool)preg_match( '!^(http://|ftp://)!', $url );
+               $url = $request->getVal( 'wpUploadFileURL' );
+               return !empty( $url )
+                       && Http::isValidURI( $url )
+                       && $wgUser->isAllowed( 'upload_by_url' );
        }
+       
 
+       public function fetchFile() {
+               if ( !Http::isValidURI( $this->mUrl ) ) {
+                       return Status::newFatal( 'http-invalid-url' );
+               }
+               
+               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' );
+       }
        /**
-        * Do the real fetching stuff
+        * Save the result of a HTTP request to the temporary file
+        * 
+        * @param $req HttpRequest 
+        * @return Status
         */
-       function fetchFile() {
-               if( !self::isValidUrl( $this->mUrl ) ) {
-                       return Status::newFatal( 'upload-proto-error' );
+       private function saveTempFile( $req ) {
+               if ( $this->mTempPath === false ) {
+                       return Status::newFatal( 'tmp-create-error' );
                }
-
-               # Open temporary file
-               $this->mCurlDestHandle = @fopen( $this->mTempPath, "wb" );
-               if( $this->mCurlDestHandle === false ) {
-                       # Could not open temporary file to write in
-                       return Status::newFatal( 'upload-file-error' );
+               if ( file_put_contents( $this->mTempPath, $req->getContent() ) === false ) {
+                       return Status::newFatal( 'tmp-write-error' );
                }
-               
-               $options = array(
-                       'method' => 'GET',
-                       'timeout' => 10,
-               );
-               $req = HttpRequest::factory( $this->mUrl, $options );
-               $req->setCallback( array( $this, 'uploadCurlCallback' ) );
+
+               $this->mFileSize = filesize( $this->mTempPath );
+
+               return Status::newGood();
+       }
+       /**
+        * Download the file, save it to the temporary file and update the file
+        * size and set $mRemoveTempFile to true.
+        */
+       protected function reallyFetchFile() {
+               $req = HttpRequest::factory( $this->mUrl );
                $status = $req->execute();
-               fclose( $this->mCurlDestHandle );
-               unset( $this->mCurlDestHandle );
-
-               global $wgMaxUploadSize;
-               if ( $this->mFileSize > $wgMaxUploadSize ) {
-                       # Just return an ok, so that the regular verifications can handle 
-                       # the file-too-large error
-                       return Status::newGood();
+
+               if ( !$status->isOk() ) {
+                       return $status;
+               }
+
+               $status = $this->saveTempFile( $req );
+               if ( !$status->isGood() ) {
+                       return $status;
                }
+               $this->mRemoveTempFile = true;
 
                return $status;
        }
 
        /**
-        * Callback function for CURL-based web transfer
-        * Write data to file unless we've passed the length limit;
-        * if so, abort immediately.
-        * @access private
+        * Wrapper around the parent function in order to defer verifying the 
+        * upload until the file really has been fetched.
         */
-       function uploadCurlCallback( $ch, $data ) {
-               global $wgMaxUploadSize;
-               $length = strlen( $data );
-               $this->mFileSize += $length;
-               if( $this->mFileSize > $wgMaxUploadSize ) {
-                       return 0;
+       public function verifyUpload() {
+               if ( $this->mAsync ) {
+                       return array( 'status' => self::OK );
                }
-               fwrite( $this->mCurlDestHandle, $data );
-               return $length;
+               return parent::verifyUpload();
        }
+
+       /**
+        * Wrapper around the parent function in order to defer checking warnings
+        * until the file really has been fetched.
+        */
+       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
+        */
+       public function verifyPermissions( $user ) {
+               if ( $this->mAsync ) {
+                       return true;
+               }
+               return parent::verifyPermissions( $user );
+       }
+       
+       /**
+        * Wrapper around the parent function in order to defer uploading to the
+        * job queue for asynchronous uploads
+        */
+       public function performUpload( $comment, $pageText, $watch, $user ) {
+               if ( $this->mAsync ) {
+                       $sessionKey = $this->insertJob( $comment, $pageText, $watch, $user );
+                       
+                       $status = new Status;
+                       $status->error( 'async', $sessionKey );
+                       return $status;
+               }
+               
+               return parent::performUpload( $comment, $pageText, $watch, $user );
+       }
+
+       
+       protected function insertJob( $comment, $pageText, $watch, $user ) {
+               $sessionKey = $this->getSessionKey();
+               $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;
+       }
+       
+
 }