3 * Job for asynchronous upload-by-url.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Job for asynchronous upload-by-url.
27 * This job is in fact an interface to UploadFromUrl, which is designed such
28 * that it does not require any globals. If it does, fix it elsewhere, do not
29 * add globals in here.
33 class UploadFromUrlJob
extends Job
{
34 const SESSION_KEYNAME
= 'wsUploadFromUrlJobData';
36 /** @var UploadFromUrl */
42 public function __construct( Title
$title, array $params ) {
43 parent
::__construct( 'uploadFromUrl', $title, $params );
46 public function run() {
47 global $wgCopyUploadAsyncTimeout;
48 # Initialize this object and the upload object
49 $this->upload
= new UploadFromUrl();
50 $this->upload
->initialize(
51 $this->title
->getText(),
55 $this->user
= User
::newFromName( $this->params
['userName'] );
59 if ( $wgCopyUploadAsyncTimeout ) {
60 $opts['timeout'] = $wgCopyUploadAsyncTimeout;
62 $status = $this->upload
->fetchFile( $opts );
63 if ( !$status->isOk() ) {
64 $this->leaveMessage( $status );
70 $result = $this->upload
->verifyUpload();
71 if ( $result['status'] != UploadBase
::OK
) {
72 $status = $this->upload
->convertVerifyErrorToStatus( $result );
73 $this->leaveMessage( $status );
79 if ( !$this->params
['ignoreWarnings'] ) {
80 $warnings = $this->upload
->checkWarnings();
84 $key = $this->upload
->stashFile( $this->user
);
86 // @todo FIXME: This has been broken for a while.
87 // User::leaveUserMessage() does not exist.
88 if ( $this->params
['leaveMessage'] ) {
89 $this->user
->leaveUserMessage(
90 wfMessage( 'upload-warning-subj' )->text(),
91 wfMessage( 'upload-warning-msg',
93 $this->params
['url'] )->text()
96 $session = MediaWiki\Session\SessionManager
::singleton()
97 ->getSessionById( $this->params
['sessionId'] );
98 $this->storeResultInSession( $session, 'Warning',
99 'warnings', $warnings );
107 $status = $this->upload
->performUpload(
108 $this->params
['comment'],
109 $this->params
['pageText'],
110 $this->params
['watch'],
113 $this->leaveMessage( $status );
119 * Leave a message on the user talk page or in the session according to
120 * $params['leaveMessage'].
122 * @param Status $status
124 protected function leaveMessage( $status ) {
125 if ( $this->params
['leaveMessage'] ) {
126 if ( $status->isGood() ) {
127 // @todo FIXME: user->leaveUserMessage does not exist.
128 $this->user
->leaveUserMessage( wfMessage( 'upload-success-subj' )->text(),
129 wfMessage( 'upload-success-msg',
130 $this->upload
->getTitle()->getText(),
134 // @todo FIXME: user->leaveUserMessage does not exist.
135 $this->user
->leaveUserMessage( wfMessage( 'upload-failure-subj' )->text(),
136 wfMessage( 'upload-failure-msg',
137 $status->getWikiText(),
142 $session = MediaWiki\Session\SessionManager
::singleton()
143 ->getSessionById( $this->params
['sessionId'] );
144 if ( $status->isOk() ) {
145 $this->storeResultInSession( $session, 'Success',
146 'filename', $this->upload
->getLocalFile()->getName() );
148 $this->storeResultInSession( $session, 'Failure',
149 'errors', $status->getErrorsArray() );
155 * Store a result in the session data. Note that the caller is responsible
156 * for appropriate session_start and session_write_close calls.
158 * @param MediaWiki\\Session\\Session $session Session to store result into
159 * @param string $result The result (Success|Warning|Failure)
160 * @param string $dataKey The key of the extra data
161 * @param mixed $dataValue The extra data itself
163 protected function storeResultInSession(
164 MediaWiki\Session\Session
$session, $result, $dataKey, $dataValue
166 $data = self
::getSessionData( $session, $this->params
['sessionKey'] );
167 $data['result'] = $result;
168 $data[$dataKey] = $dataValue;
169 self
::setSessionData( $session, $this->params
['sessionKey'], $data );
173 * Initialize the session data. Sets the initial result to queued.
175 public function initializeSessionData() {
176 $session = MediaWiki\Session\SessionManager
::getGlobalSession();
177 $data = self
::getSessionData( $session, $this->params
['sessionKey'] );
178 $data['result'] = 'Queued';
179 self
::setSessionData( $session, $this->params
['sessionKey'], $data );
183 * @param MediaWiki\\Session\\Session $session
187 public static function getSessionData( MediaWiki\Session\Session
$session, $key ) {
188 $data = $session->get( self
::SESSION_KEYNAME
);
189 if ( !is_array( $data ) ||
!isset( $data[$key] ) ) {
190 self
::setSessionData( $session, $key, array() );
197 * @param MediaWiki\\Session\\Session $session
199 * @param mixed $value
201 public static function setSessionData( MediaWiki\Session\Session
$session, $key, $value ) {
202 $data = $session->get( self
::SESSION_KEYNAME
, array() );
203 if ( !is_array( $data ) ) {
206 $data[$key] = $value;
207 $session->set( self
::SESSION_KEYNAME
, $data );