Implements uploading from a HTTP resource. More...

Inheritance diagram for UploadFromUrl:

Collaboration diagram for UploadFromUrl:

Public Member Functions
	checkWarnings ()
	Wrapper around the parent function in order to defer checking warnings until the file really has been fetched.
	fetchFile ()
	getSourceType ()
	initialize ($name, $url, $async=false)
	Entry point for API upload.
	initializeFromRequest (&$request)
	Entry point for SpecialUpload.
	performUpload ($comment, $pageText, $watch, $user)
	Wrapper around the parent function in order to defer uploading to the job queue for asynchronous uploads.
	saveTempFileChunk ($req, $buffer)
	Callback: save a chunk of the result of a HTTP request to the temporary file.
	verifyTitlePermissions ($user)
	Wrapper around the parent function in order to defer checking protection until we are sure that the file can actually be uploaded.
	verifyUpload ()
	Wrapper around the parent function in order to defer verifying the upload until the file really has been fetched.
Static Public Member Functions
static	isAllowed ($user)
	Checks if the user is allowed to use the upload-by-URL feature.
static	isEnabled ()
	Checks if the upload from URL feature is enabled.
static	isValidRequest ($request)
Public Attributes
	$mTmpHandle
	$mUrl
Protected Member Functions
	insertJob ($comment, $pageText, $watch, $user)
	makeTemporaryFile ()
	Create a new temporary file in the URL subdirectory of wfTempDir().
	reallyFetchFile ()
	Download the file, save it to the temporary file and update the file size and set $mRemoveTempFile to true.
Protected Attributes
	$mAsync
	$mIgnoreWarnings = true
	$mTempPath

Detailed Description

Implements uploading from a HTTP resource.

Author:: Bryan Tong Minh; Michael Dale

Definition at line 9 of file UploadFromUrl.php.

Member Function Documentation

UploadFromUrl::checkWarnings ( )

Wrapper around the parent function in order to defer checking warnings until the file really has been fetched.

Reimplemented from UploadBase.

Definition at line 195 of file UploadFromUrl.php.

UploadFromUrl::fetchFile ( )

Returns:: Status

Reimplemented from UploadBase.

Definition at line 99 of file UploadFromUrl.php.

References Http\isValidURI(), Status\newFatal(), Status\newGood(), and reallyFetchFile().

Here is the call graph for this function:

UploadFromUrl::getSourceType ( )

Returns:: string

Reimplemented from UploadBase.

Definition at line 94 of file UploadFromUrl.php.

UploadFromUrl::initialize	(	$	name,
		$	url,
		$	async = `false`
	)

Entry point for API upload.

Parameters:

$name	string
$url	string
$async	mixed Whether the download should be performed asynchronous. False for synchronous, async or async-leavemessage for asynchronous download.

Definition at line 48 of file UploadFromUrl.php.

References $url, $wgAllowAsyncCopyUploads, UploadBase\initializePathInfo(), and makeTemporaryFile().

Referenced by initializeFromRequest(), and ApiUpload\selectUploadModule().

Here is the call graph for this function:

Here is the caller graph for this function:

UploadFromUrl::initializeFromRequest ( &$ request )

Entry point for SpecialUpload.

Parameters:

$request WebRequest object

Reimplemented from UploadBase.

Definition at line 66 of file UploadFromUrl.php.

References initialize().

Here is the call graph for this function:

UploadFromUrl::insertJob	(	$	comment,
		$	pageText,
		$	watch,
		$	user
	)		`[protected]`

Parameters:

$comment
$pageText
$watch
$user	User

Returns:

Definition at line 235 of file UploadFromUrl.php.

References $comment, $job, $user, UploadBase\getTitle(), and UploadBase\stashSession().

Referenced by performUpload().

Here is the call graph for this function:

Here is the caller graph for this function:

static UploadFromUrl::isAllowed ( $ user ) [static]

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.

Parameters:

$user User

Returns:: bool

Reimplemented from UploadBase.

Definition at line 23 of file UploadFromUrl.php.

References $user.

Referenced by UploadForm\getSourceSection().

Here is the caller graph for this function:

static UploadFromUrl::isEnabled ( ) [static]

Checks if the upload from URL feature is enabled.

Returns:: bool

Reimplemented from UploadBase.

Definition at line 34 of file UploadFromUrl.php.

References $wgAllowCopyUploads.

Referenced by UploadForm\getSourceSection(), and ApiUpload\selectUploadModule().

Here is the caller graph for this function:

static UploadFromUrl::isValidRequest ( $ request ) [static]

Parameters:

$request WebRequest object

Returns:: bool

Reimplemented from UploadBase.

Definition at line 82 of file UploadFromUrl.php.

References $url, $wgUser, and Http\isValidURI().

Here is the call graph for this function:

UploadFromUrl::makeTemporaryFile ( ) [protected]

Create a new temporary file in the URL subdirectory of wfTempDir().

Returns:: string Path to the file

Definition at line 114 of file UploadFromUrl.php.

References wfTempDir().

Referenced by initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

UploadFromUrl::performUpload	(	$	comment,
		$	pageText,
		$	watch,
		$	user
	)

Wrapper around the parent function in order to defer uploading to the job queue for asynchronous uploads.

Reimplemented from UploadBase.

Definition at line 218 of file UploadFromUrl.php.

References $comment, $user, insertJob(), and Status\newFatal().

Here is the call graph for this function:

UploadFromUrl::reallyFetchFile ( ) [protected]

Download the file, save it to the temporary file and update the file size and set $mRemoveTempFile to true.

Returns:: Status

Definition at line 144 of file UploadFromUrl.php.

References MWHttpRequest\factory(), and Status\newFatal().

Referenced by fetchFile().

Here is the call graph for this function:

Here is the caller graph for this function:

UploadFromUrl::saveTempFileChunk	(	$	req,
		$	buffer
	)

Callback: save a chunk of the result of a HTTP request to the temporary file.

Parameters:

$req	mixed
$buffer	string

Returns:: int number of bytes handled

Definition at line 125 of file UploadFromUrl.php.

UploadFromUrl::verifyTitlePermissions ( $ user )

Wrapper around the parent function in order to defer checking protection until we are sure that the file can actually be uploaded.

Reimplemented from UploadBase.

Definition at line 207 of file UploadFromUrl.php.

References $user.

UploadFromUrl::verifyUpload ( )

Wrapper around the parent function in order to defer verifying the upload until the file really has been fetched.

Reimplemented from UploadBase.

Definition at line 184 of file UploadFromUrl.php.

References UploadBase\OK.

Member Data Documentation

UploadFromUrl::$mAsync [protected]

Definition at line 10 of file UploadFromUrl.php.

UploadFromUrl::$mIgnoreWarnings = true [protected]

Definition at line 11 of file UploadFromUrl.php.

UploadFromUrl::$mTempPath [protected]

Reimplemented from UploadBase.

Definition at line 13 of file UploadFromUrl.php.

UploadFromUrl::$mTmpHandle

Definition at line 13 of file UploadFromUrl.php.

UploadFromUrl::$mUrl

Definition at line 10 of file UploadFromUrl.php.

The documentation for this class was generated from the following file:

includes/upload/UploadFromUrl.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation