MediaWiki 1.17.0

[autoinstallsdev/mediawiki.git] / includes / job / UploadFromUrlJob.php

diff --git a/includes/job/UploadFromUrlJob.php b/includes/job/UploadFromUrlJob.php
new file mode 100644 (file)
index 0000000..63166ef
--- /dev/null
+++ b/includes/job/UploadFromUrlJob.php
@@ -0,0 +1,153 @@
+<?php
+/**
+ * Job for asynchronous upload-by-url.
+ *
+ * @file
+ * @ingroup JobQueue
+ */
+
+/**
+ * Job for asynchronous upload-by-url.
+ * 
+ * This job is in fact an interface to UploadFromUrl, which is designed such
+ * that it does not require any globals. If it does, fix it elsewhere, do not
+ * add globals in here.
+ *
+ * @ingroup JobQueue
+ */
+class UploadFromUrlJob extends Job {
+       const SESSION_KEYNAME = 'wsUploadFromUrlJobData';
+       
+       public $upload;
+       protected $user;
+
+       public function __construct( $title, $params, $id = 0 ) {
+               parent::__construct( 'uploadFromUrl', $title, $params, $id );
+       }
+
+       public function run() {
+               # Initialize this object and the upload object
+               $this->upload = new UploadFromUrl();
+               $this->upload->initialize( 
+                       $this->title->getText(), 
+                       $this->params['url'],
+                       false
+               );
+               $this->user = User::newFromName( $this->params['userName'] );
+               
+               # Fetch the file
+               $status = $this->upload->fetchFile();
+               if ( !$status->isOk() ) {
+                       $this->leaveMessage( $status );
+                       return true;
+               }
+               
+               # Verify upload
+               $result = $this->upload->verifyUpload();
+               if ( $result['status'] != UploadBase::OK ) {
+                       $status = $this->upload->convertVerifyErrorToStatus( $result );
+                       $this->leaveMessage( $status );
+                       return true;
+               }
+               
+               # Check warnings
+               if ( !$this->params['ignoreWarnings'] ) {
+                       $warnings = $this->upload->checkWarnings();
+                       if ( $warnings ) {              
+                               wfSetupSession( $this->params['sessionId'] );
+                                                               
+                               if ( $this->params['leaveMessage'] ) {
+                                       $this->user->leaveUserMessage( 
+                                               wfMsg( 'upload-warning-subj' ),
+                                               wfMsg( 'upload-warning-msg', 
+                                                       $this->params['sessionKey'],
+                                                       $this->params['url'] )
+                                       );
+                               } else {
+                                       $this->storeResultInSession( 'Warning',
+                                               'warnings', $warnings );
+                               }
+                               
+                               # Stash the upload in the session
+                               $this->upload->stashSession( $this->params['sessionKey'] );
+                               session_write_close();
+                               
+                               return true;
+                       }
+               }
+               
+               # Perform the upload
+               $status = $this->upload->performUpload( 
+                       $this->params['comment'],
+                       $this->params['pageText'],
+                       $this->params['watch'],
+                       $this->user
+               );
+               $this->leaveMessage( $status );
+               return true;
+               
+       }
+       
+       /**
+        * Leave a message on the user talk page or in the session according to
+        * $params['leaveMessage'].
+        * 
+        * @param $status Status
+        */
+       protected function leaveMessage( $status ) {
+               if ( $this->params['leaveMessage'] ) {
+                       if ( $status->isGood() ) {
+                               $this->user->leaveUserMessage( wfMsg( 'upload-success-subj' ),
+                                       wfMsg( 'upload-success-msg', 
+                                               $this->upload->getTitle()->getText(),
+                                               $this->params['url'] 
+                                       ) );
+                       } else {
+                               $this->user->leaveUserMessage( wfMsg( 'upload-failure-subj' ),
+                                       wfMsg( 'upload-failure-msg', 
+                                               $status->getWikiText(),
+                                               $this->params['url']
+                                       ) );
+                       }
+               } else {
+                       wfSetupSession( $this->params['sessionId'] );                   
+                       if ( $status->isOk() ) {
+                               $this->storeResultInSession( 'Success', 
+                                       'filename', $this->upload->getLocalFile()->getName() );
+                       } else {
+                               $this->storeResultInSession( 'Failure',
+                                       'errors', $status->getErrorsArray() );
+                       }
+                       session_write_close();                  
+               }
+       }
+
+       /**
+        * Store a result in the session data. Note that the caller is responsible
+        * for appropriate session_start and session_write_close calls.
+        * 
+        * @param $result String: the result (Success|Warning|Failure)
+        * @param $dataKey String: the key of the extra data
+        * @param $dataValue Mixed: the extra data itself
+        */
+       protected function storeResultInSession( $result, $dataKey, $dataValue ) {
+               $session =& self::getSessionData( $this->params['sessionKey'] );
+               $session['result'] = $result;
+               $session[$dataKey] = $dataValue;
+       }
+       
+       /**
+        * Initialize the session data. Sets the intial result to queued.
+        */
+       public function initializeSessionData() {
+               $session =& self::getSessionData( $this->params['sessionKey'] );
+               $$session['result'] = 'Queued';
+       }
+       
+       public static function &getSessionData( $key ) {
+               if ( !isset( $_SESSION[self::SESSION_KEYNAME][$key] ) ) {
+                       $_SESSION[self::SESSION_KEYNAME][$key] = array();
+               }
+               return $_SESSION[self::SESSION_KEYNAME][$key];
+       }
+}