Localisation updates for core and extension messages from translatewiki.net (2010...
[lhc/web/wiklou.git] / includes / upload / UploadFromUrl.php
index f9a7a3d..42b3827 100644 (file)
 <?php
+/**
+ * Implements uploading from a HTTP resource.
+ *
+ * @file
+ * @ingroup upload
+ * @author Bryan Tong Minh
+ * @author Michael Dale
+ */
 
 class UploadFromUrl extends UploadBase {
-       protected $mTempDownloadPath;
-
-       // by default do a SYNC_DOWNLOAD 
-       protected $dl_mode = null;
+       protected $mAsync, $mUrl;
+       protected $mIgnoreWarnings = true;
 
        /**
-        * 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.
         */
-       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 = false ) {
-               global $wgTmpDirectory, $wgPhpCliPath;
-
-               // check for $asyncdownload request: 
-               if( $asyncdownload !== false){
-                       if( $wgPhpCliPath && wfShellExecEnabled() ){
-                               $this->dl_mode = Http::ASYNC_DOWNLOAD;
-                       } else {
-                               $this->dl_mode = Http::SYNC_DOWNLOAD;
-                       }
-               }
-
-               $local_file = tempnam( $wgTmpDirectory, 'WEBUPLOAD' );
-               parent::initialize( $name, $local_file, 0, true );
-
-               $this->mUrl = trim( $url );
-       }
-
-       public function isAsync(){
-               return $this->dl_mode == Http::ASYNC_DOWNLOAD;
+       /**
+        * 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 = $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 );
        }
 
        /**
-        * Entry point for SpecialUpload no ASYNC_DOWNLOAD possible
+        * Entry point for SpecialUpload
         * @param $request Object: 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' );
+               if ( !$desiredDestName )
+                       $desiredDestName = $request->getText( 'wpUploadFileURL' );
                return $this->initialize(
                        $desiredDestName,
-                       $request->getVal( 'wpUploadFileURL' )
+                       $request->getVal( 'wpUploadFileURL' ),
+                       false
                );
        }
 
        /**
-        * Do the real fetching stuff
+        * @param $request Object: WebRequest object
         */
-       function fetchFile() {
-               // entry point for SpecialUplaod 
-               if( self::isValidURI( $this->mUrl ) === false ) {
-                       return Status::newFatal( 'upload-proto-error' );
-               }
+       public static function isValidRequest( $request ) {
+               global $wgUser;
 
-               // now do the actual download to the target file:
-               $status = Http::doDownload( $this->mUrl, $this->mTempPath, $this->dl_mode );
+               $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' );
+       }
+       /**
+        * Save the result of a HTTP request to the temporary file
+        * 
+        * @param $req HttpRequest 
+        * @return Status
+        */
+       private function saveTempFile( $req ) {
+               if ( $this->mTempPath === false ) {
+                       return Status::newFatal( 'tmp-create-error' );
+               }
+               if ( file_put_contents( $this->mTempPath, $req->getContent() ) === false ) {
+                       return Status::newFatal( 'tmp-write-error' );
+               }
 
-               // update the local filesize var: 
                $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();
+
+               if ( !$status->isOk() ) {
+                       return $status;
+               }
+
+               $status = $this->saveTempFile( $req );
+               if ( !$status->isGood() ) {
+                       return $status;
+               }
+               $this->mRemoveTempFile = true;
+
                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.
         */
-       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' => self::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.
         */
-       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
+        */
+       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;
        }
+       
 
-}
\ No newline at end of file
+}