<?php
/**
- * @file
- * @ingroup upload
+ * Backend for uploading files from a HTTP resource.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
*
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Upload
+ */
+
+/**
* Implements uploading from a HTTP resource.
*
+ * @ingroup Upload
* @author Bryan Tong Minh
* @author Michael Dale
*/
class UploadFromUrl extends UploadBase {
- protected $mTempDownloadPath;
- protected $comment, $watchList;
+ protected $mAsync, $mUrl;
+ protected $mIgnoreWarnings = true;
+
+ protected $mTempPath, $mTmpHandle;
/**
* 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.
+ *
+ * @param $user User
+ *
+ * @return bool
*/
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;
}
/**
- * Entry point for API upload
+ * Checks whether the URL is for an allowed host
+ *
+ * @param $url string
+ * @return bool
*/
- public function initialize( $name, $url, $comment, $watchlist ) {
- global $wgUser;
-
- if( !Http::isValidURI( $url ) ) {
- return Status::newFatal( 'http-invalid-url' );
+ public static function isAllowedHost( $url ) {
+ global $wgCopyUploadsDomains;
+ if ( !count( $wgCopyUploadsDomains ) ) {
+ return true;
}
- $params = array(
- "userName" => $wgUser->getName(),
- "userID" => $wgUser->getID(),
- "url" => trim( $url ),
- "timestamp" => wfTimestampNow(),
- "comment" => $comment,
- "watchlist" => $watchlist);
-
- $title = Title::newFromText( $name );
- /* // Check whether the user has the appropriate permissions to upload anyway */
- /* $permission = $this->isAllowed( $wgUser ); */
-
- /* if ( $permission !== true ) { */
- /* if ( !$wgUser->isLoggedIn() ) { */
- /* return Status::newFatal( 'uploadnologintext' ); */
- /* } else { */
- /* return Status::newFatal( 'badaccess-groups' ); */
- /* } */
- /* } */
-
- /* $permErrors = $this->verifyPermissions( $wgUser ); */
- /* if ( $permErrors !== true ) { */
- /* return Status::newFatal( 'badaccess-groups' ); */
- /* } */
-
-
- $job = new UploadFromUrlJob( $title, $params );
- $job->insert();
+ $parsedUrl = wfParseUrl( $url );
+ if ( !$parsedUrl ) {
+ return false;
+ }
+ $valid = false;
+ foreach( $wgCopyUploadsDomains as $domain ) {
+ if ( $parsedUrl['host'] === $domain ) {
+ $valid = true;
+ break;
+ }
+ }
+ return $valid;
}
/**
- * Initialize a queued download
- * @param $job Job
+ * 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 initializeFromJob( $job ) {
- $this->mUrl = $job->params['url'];
- $this->mTempPath = tempnam( $wgTmpDirectory, 'COPYUPLOAD' );
- $this->mDesiredDestName = $job->title;
- $this->comment = $job->params['comment'];
- $this->watchList = $job->params['watchlist'];
- $this->getTitle();
+ public function initialize( $name, $url, $async = false ) {
+ global $wgAllowAsyncCopyUploads;
+
+ $this->mUrl = $url;
+ $this->mAsync = $wgAllowAsyncCopyUploads ? $async : false;
+ if ( $async ) {
+ throw new MWException( 'Asynchronous copy uploads are no longer possible as of r81612.' );
+ }
+
+ $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
- * @param $request Object: WebRequest object
+ * @param $request WebRequest object
*/
public function initializeFromRequest( &$request ) {
$desiredDestName = $request->getText( 'wpDestFile' );
- if( !$desiredDestName )
+ if ( !$desiredDestName ) {
$desiredDestName = $request->getText( 'wpUploadFileURL' );
- return $this->initialize(
+ }
+ $this->initialize(
$desiredDestName,
- $request->getVal( 'wpUploadFileURL' ),
+ trim( $request->getVal( 'wpUploadFileURL' ) ),
false
);
}
/**
- * @param $request Object: WebRequest object
+ * @param $request WebRequest object
+ * @return bool
*/
- 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;
+
+ $url = $request->getVal( 'wpUploadFileURL' );
+ return !empty( $url )
+ && Http::isValidURI( $url )
+ && $wgUser->isAllowed( 'upload_by_url' );
}
- private function saveTempFile( $req ) {
- $filename = tempnam( wfTempDir(), 'URL' );
- if ( $filename === false ) {
- return Status::newFatal( 'tmp-create-error' );
- }
- if ( file_put_contents( $filename, $req->getContent() ) === false ) {
- return Status::newFatal( 'tmp-write-error' );
- }
+ /**
+ * @return string
+ */
+ public function getSourceType() { return 'url'; }
- $this->mTempPath = $filename;
- $this->mFileSize = filesize( $filename );
+ /**
+ * @return Status
+ */
+ public function fetchFile() {
+ if ( !Http::isValidURI( $this->mUrl ) ) {
+ return Status::newFatal( 'http-invalid-url' );
+ }
+ if( !self::isAllowedHost( $this->mUrl ) ) {
+ return Status::newFatal( 'upload-copy-upload-invalid-domain' );
+ }
+ 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' );
+ }
- public function doUpload() {
- global $wgUser;
+ /**
+ * Callback: save a chunk of the result of a HTTP request to the temporary file
+ *
+ * @param $req mixed
+ * @param $buffer string
+ * @return int number of bytes handled
+ */
+ public function saveTempFileChunk( $req, $buffer ) {
+ $nbytes = fwrite( $this->mTmpHandle, $buffer );
- $req = HttpRequest::factory($this->mUrl);
- $status = $req->execute();
+ if ( $nbytes == strlen( $buffer ) ) {
+ $this->mFileSize += $nbytes;
+ } else {
+ // Well... that's not good!
+ fclose( $this->mTmpHandle );
+ $this->mTmpHandle = false;
+ }
- if( !$status->isOk() ) {
- return $status;
+ return $nbytes;
+ }
+
+ /**
+ * Download the file, save it to the temporary file and update the file
+ * size and set $mRemoveTempFile to true.
+ * @return Status
+ */
+ protected function reallyFetchFile() {
+ if ( $this->mTempPath === false ) {
+ return Status::newFatal( 'tmp-create-error' );
+ }
+
+ // Note the temporary file should already be created by makeTemporaryFile()
+ $this->mTmpHandle = fopen( $this->mTempPath, 'wb' );
+ if ( !$this->mTmpHandle ) {
+ return Status::newFatal( 'tmp-create-error' );
}
- $status = $this->saveTempFile( $req );
$this->mRemoveTempFile = true;
+ $this->mFileSize = 0;
+
+ $req = MWHttpRequest::factory( $this->mUrl, array(
+ 'followRedirects' => true
+ ) );
+ $req->setCallback( array( $this, 'saveTempFileChunk' ) );
+ $status = $req->execute();
- if( !$status->isOk() ) {
+ if ( $this->mTmpHandle ) {
+ // File got written ok...
+ fclose( $this->mTmpHandle );
+ $this->mTmpHandle = null;
+ } else {
+ // We encountered a write error during the download...
+ return Status::newFatal( 'tmp-write-error' );
+ }
+
+ if ( !$status->isOk() ) {
return $status;
}
- $v = $this->verifyUpload();
- if( $v['status'] !== UploadBase::OK ) {
- return $this->convertVerifyErrorToStatus( $v['status'], $v['details'] );
+ return $status;
+ }
+
+ /**
+ * Wrapper around the parent function in order to defer verifying the
+ * upload until the file really has been fetched.
+ * @return array|mixed
+ */
+ public function verifyUpload() {
+ if ( $this->mAsync ) {
+ return array( 'status' => UploadBase::OK );
}
+ return parent::verifyUpload();
+ }
- // This has to come from API
- /* $warnings = $this->checkForWarnings(); */
- /* if( isset($warnings) ) return $warnings; */
+ /**
+ * Wrapper around the parent function in order to defer checking warnings
+ * until the file really has been fetched.
+ * @return Array
+ */
+ public function checkWarnings() {
+ if ( $this->mAsync ) {
+ $this->mIgnoreWarnings = false;
+ return array();
+ }
+ return parent::checkWarnings();
+ }
- // Use comment as initial page text by default
- if ( is_null( $this->mParams['text'] ) ) {
- $this->mParams['text'] = $this->mParams['comment'];
+ /**
+ * Wrapper around the parent function in order to defer checking protection
+ * until we are sure that the file can actually be uploaded
+ * @return bool|mixed
+ */
+ public function verifyTitlePermissions( $user ) {
+ if ( $this->mAsync ) {
+ return true;
}
+ return parent::verifyTitlePermissions( $user );
+ }
- $file = $this->getLocalFile();
- // This comes from ApiBase
- /* $watch = $this->getWatchlistValue( $this->mParams['watchlist'], $file->getTitle() ); */
+ /**
+ * Wrapper around the parent function in order to defer uploading to the
+ * job queue for asynchronous uploads
+ * @return Status
+ */
+ public function performUpload( $comment, $pageText, $watch, $user ) {
+ if ( $this->mAsync ) {
+ $sessionKey = $this->insertJob( $comment, $pageText, $watch, $user );
- if ( !$status->isGood() ) {
- return $status;
+ return Status::newFatal( 'async', $sessionKey );
}
- $status = $this->getLocalFile()->upload( $this->mTempPath, $this->comment,
- $this->pageText, File::DELETE_SOURCE, $this->mFileProps, false, $wgUser );
+ return parent::performUpload( $comment, $pageText, $watch, $user );
+ }
- return $status;
+ /**
+ * @param $comment
+ * @param $pageText
+ * @param $watch
+ * @param $user User
+ * @return
+ */
+ protected function insertJob( $comment, $pageText, $watch, $user ) {
+ $sessionKey = $this->stashSession();
+ $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;
}
+
}
dépôts / lhc / web / wiklou.git / blobdiff