3 * Backend for uploading files from a HTTP resource.
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 * Implements uploading from a HTTP resource.
28 * @author Bryan Tong Minh
29 * @author Michael Dale
31 class UploadFromUrl
extends UploadBase
{
32 protected $mAsync, $mUrl;
33 protected $mIgnoreWarnings = true;
35 protected $mTempPath, $mTmpHandle;
38 * Checks if the user is allowed to use the upload-by-URL feature. If the
39 * user is not allowed, return the name of the user right as a string. If
40 * the user is allowed, have the parent do further permissions checking.
46 public static function isAllowed( $user ) {
47 if ( !$user->isAllowed( 'upload_by_url' ) ) {
48 return 'upload_by_url';
50 return parent
::isAllowed( $user );
54 * Checks if the upload from URL feature is enabled
57 public static function isEnabled() {
58 global $wgAllowCopyUploads;
59 return $wgAllowCopyUploads && parent
::isEnabled();
63 * Checks whether the URL is for an allowed host
68 public static function isAllowedHost( $url ) {
69 global $wgCopyUploadsDomains;
70 if ( !count( $wgCopyUploadsDomains ) ) {
73 $parsedUrl = wfParseUrl( $url );
78 foreach( $wgCopyUploadsDomains as $domain ) {
79 if ( $parsedUrl['host'] === $domain ) {
88 * Entry point for API upload
92 * @param $async mixed Whether the download should be performed
93 * asynchronous. False for synchronous, async or async-leavemessage for
94 * asynchronous download.
97 public function initialize( $name, $url, $async = false ) {
98 global $wgAllowAsyncCopyUploads;
101 $this->mAsync
= $wgAllowAsyncCopyUploads ?
$async : false;
103 throw new MWException( 'Asynchronous copy uploads are no longer possible as of r81612.' );
106 $tempPath = $this->mAsync ?
null : $this->makeTemporaryFile();
107 # File size and removeTempFile will be filled in later
108 $this->initializePathInfo( $name, $tempPath, 0, false );
112 * Entry point for SpecialUpload
113 * @param $request WebRequest object
115 public function initializeFromRequest( &$request ) {
116 $desiredDestName = $request->getText( 'wpDestFile' );
117 if ( !$desiredDestName ) {
118 $desiredDestName = $request->getText( 'wpUploadFileURL' );
122 trim( $request->getVal( 'wpUploadFileURL' ) ),
128 * @param $request WebRequest object
131 public static function isValidRequest( $request ) {
134 $url = $request->getVal( 'wpUploadFileURL' );
135 return !empty( $url )
136 && Http
::isValidURI( $url )
137 && $wgUser->isAllowed( 'upload_by_url' );
143 public function getSourceType() { return 'url'; }
148 public function fetchFile() {
149 if ( !Http
::isValidURI( $this->mUrl
) ) {
150 return Status
::newFatal( 'http-invalid-url' );
153 if( !self
::isAllowedHost( $this->mUrl
) ) {
154 return Status
::newFatal( 'upload-copy-upload-invalid-domain' );
156 if ( !$this->mAsync
) {
157 return $this->reallyFetchFile();
159 return Status
::newGood();
162 * Create a new temporary file in the URL subdirectory of wfTempDir().
164 * @return string Path to the file
166 protected function makeTemporaryFile() {
167 return tempnam( wfTempDir(), 'URL' );
171 * Callback: save a chunk of the result of a HTTP request to the temporary file
174 * @param $buffer string
175 * @return int number of bytes handled
177 public function saveTempFileChunk( $req, $buffer ) {
178 $nbytes = fwrite( $this->mTmpHandle
, $buffer );
180 if ( $nbytes == strlen( $buffer ) ) {
181 $this->mFileSize +
= $nbytes;
183 // Well... that's not good!
184 fclose( $this->mTmpHandle
);
185 $this->mTmpHandle
= false;
192 * Download the file, save it to the temporary file and update the file
193 * size and set $mRemoveTempFile to true.
196 protected function reallyFetchFile() {
197 if ( $this->mTempPath
=== false ) {
198 return Status
::newFatal( 'tmp-create-error' );
201 // Note the temporary file should already be created by makeTemporaryFile()
202 $this->mTmpHandle
= fopen( $this->mTempPath
, 'wb' );
203 if ( !$this->mTmpHandle
) {
204 return Status
::newFatal( 'tmp-create-error' );
207 $this->mRemoveTempFile
= true;
208 $this->mFileSize
= 0;
210 $req = MWHttpRequest
::factory( $this->mUrl
, array(
211 'followRedirects' => true
213 $req->setCallback( array( $this, 'saveTempFileChunk' ) );
214 $status = $req->execute();
216 if ( $this->mTmpHandle
) {
217 // File got written ok...
218 fclose( $this->mTmpHandle
);
219 $this->mTmpHandle
= null;
221 // We encountered a write error during the download...
222 return Status
::newFatal( 'tmp-write-error' );
225 if ( !$status->isOk() ) {
233 * Wrapper around the parent function in order to defer verifying the
234 * upload until the file really has been fetched.
235 * @return array|mixed
237 public function verifyUpload() {
238 if ( $this->mAsync
) {
239 return array( 'status' => UploadBase
::OK
);
241 return parent
::verifyUpload();
245 * Wrapper around the parent function in order to defer checking warnings
246 * until the file really has been fetched.
249 public function checkWarnings() {
250 if ( $this->mAsync
) {
251 $this->mIgnoreWarnings
= false;
254 return parent
::checkWarnings();
258 * Wrapper around the parent function in order to defer checking protection
259 * until we are sure that the file can actually be uploaded
263 public function verifyTitlePermissions( $user ) {
264 if ( $this->mAsync
) {
267 return parent
::verifyTitlePermissions( $user );
271 * Wrapper around the parent function in order to defer uploading to the
272 * job queue for asynchronous uploads
273 * @param $comment string
274 * @param $pageText string
279 public function performUpload( $comment, $pageText, $watch, $user ) {
280 if ( $this->mAsync
) {
281 $sessionKey = $this->insertJob( $comment, $pageText, $watch, $user );
283 return Status
::newFatal( 'async', $sessionKey );
286 return parent
::performUpload( $comment, $pageText, $watch, $user );
296 protected function insertJob( $comment, $pageText, $watch, $user ) {
297 $sessionKey = $this->stashSession();
298 $job = new UploadFromUrlJob( $this->getTitle(), array(
299 'url' => $this->mUrl
,
300 'comment' => $comment,
301 'pageText' => $pageText,
303 'userName' => $user->getName(),
304 'leaveMessage' => $this->mAsync
== 'async-leavemessage',
305 'ignoreWarnings' => $this->mIgnoreWarnings
,
306 'sessionId' => session_id(),
307 'sessionKey' => $sessionKey,
309 $job->initializeSessionData();