MediaWiki  master
UploadFromStash Class Reference

Implements uploading from previously stored file. More...

Inheritance diagram for UploadFromStash:
Collaboration diagram for UploadFromStash:

Public Member Functions

 __construct (UserIdentity $user=null, $stash=false, $repo=false)
 
 getSourceType ()
 
 getTempFileSha1Base36 ()
 Get the base 36 SHA1 of the file. More...
 
 initialize ( $key, $name='upload_file', $initTempFile=true)
 
 initializeFromRequest (&$request)
 
 postProcessUpload ()
 Remove the database record after a successful upload. More...
 
 unsaveUploadedFile ()
 Remove a temporarily kept file stashed by saveTempUploadedFile(). More...
 
- Public Member Functions inherited from UploadBase
 __construct ()
 
 checkSvgScriptCallback ( $element, $attribs, $data=null)
 
 checkWarnings ( $user=null)
 Check for non fatal problems with the file. More...
 
 cleanupTempFile ()
 If we've modified the upload file we need to manually remove it on exit to clean up. More...
 
 convertVerifyErrorToStatus ( $error)
 
 fetchFile ()
 Fetch the file. More...
 
 getFileSize ()
 Return the file size. More...
 
 getImageInfo ( $result)
 Gets image info about the file just uploaded. More...
 
 getLocalFile ()
 Return the local file and initializes if necessary. More...
 
 getRealPath ( $srcPath)
 
 getStashFile ()
 
 getTempPath ()
 
 getTitle ()
 Returns the title of the file to be uploaded. More...
 
 getVerificationErrorCode ( $error)
 
 initializePathInfo ( $name, $tempPath, $fileSize, $removeTempFile=false)
 
 isEmptyFile ()
 Return true if the file is empty. More...
 
 performUpload ( $comment, $pageText, $watch, $user, $tags=[], ?string $watchlistExpiry=null)
 Really perform the upload. More...
 
 tryStashFile (User $user, $isPartial=false)
 Like stashFile(), but respects extensions' wishes to prevent the stashing. More...
 
 validateName ()
 Verify that the name is valid and, if necessary, that we can overwrite. More...
 
 verifyPermissions (Authority $performer)
 Alias for verifyTitlePermissions. More...
 
 verifyTitlePermissions (Authority $performer)
 Check whether the user can edit, upload and create the image. More...
 
 verifyUpload ()
 Verify whether the upload is sane. More...
 
 zipEntryCallback ( $entry)
 Callback for ZipDirectoryReader to detect Java class files. More...
 

Static Public Member Functions

static isValidKey ( $key)
 
static isValidRequest ( $request)
 
- Static Public Member Functions inherited from UploadBase
static checkFileExtension ( $ext, $list)
 Perform case-insensitive match against a list of file extensions. More...
 
static checkFileExtensionList ( $ext, $list)
 Perform case-insensitive match against a list of file extensions. More...
 
static checkSvgExternalDTD ( $type, $publicId, $systemId)
 Verify that DTD urls referenced are only the standard dtds. More...
 
static checkSvgPICallback ( $target, $data)
 Callback to filter SVG Processing Instructions. More...
 
static checkXMLEncodingMissmatch ( $file)
 Check a whitelist of xml encodings that are known not to be interpreted differently by the server's xml parser (expat) and some common browsers. More...
 
static createFromRequest (&$request, $type=null)
 Create a form of UploadBase depending on wpSourceType and initializes it. More...
 
static detectScript ( $file, $mime, $extension)
 Heuristic for detecting files that could contain JavaScript instructions or things that may look like HTML to a browser and are thus potentially harmful. More...
 
static detectVirus ( $file)
 Generic wrapper function for a virus scanner program. More...
 
static getExistsWarning ( $file)
 Helper function that does various existence checks for a file. More...
 
static getFilenamePrefixBlacklist ()
 Get a list of blacklisted filename prefixes from [[MediaWiki:Filename-prefix-blacklist]]. More...
 
static getMaxPhpUploadSize ()
 Get the PHP maximum uploaded file size, based on ini settings. More...
 
static getMaxUploadSize ( $forType=null)
 Get MediaWiki's maximum uploaded file size for given type of upload, based on $wgMaxUploadSize. More...
 
static getSessionStatus (UserIdentity $user, $statusKey)
 Get the current status of a chunked upload (used for polling) More...
 
static isAllowed (Authority $performer)
 Returns true if the user can use this upload module or else a string identifying the missing permission. More...
 
static isEnabled ()
 Returns true if uploads are enabled. More...
 
static isThrottled ( $user)
 Returns true if the user has surpassed the upload rate limit, false otherwise. More...
 
static isThumbName ( $filename)
 Helper function that checks whether the filename looks like a thumbnail. More...
 
static makeWarningsSerializable ( $warnings)
 Convert the warnings array returned by checkWarnings() to something that can be serialized. More...
 
static setSessionStatus (UserIdentity $user, $statusKey, $value)
 Set the current status of a chunked upload (used for polling) More...
 
static splitExtensions ( $filename)
 Split a file into a base name and all dot-delimited 'extensions' on the end. More...
 
static userCanReUpload (Authority $performer, File $img)
 Check if a user is the last uploader. More...
 
static verifyExtension ( $mime, $extension)
 Checks if the MIME type of the uploaded file matches the file extension. More...
 

Protected Attributes

 $mFileKey
 
 $mFileProps
 
 $mSourceType
 
 $mVirtualTempPath
 
- Protected Attributes inherited from UploadBase
string[] $mBlackListedExtensions
 
string null $mDesiredDestName
 
string null $mDestName
 
array null $mFileProps
 
int null $mFileSize
 
string null $mFilteredName
 
string null $mFinalExtension
 
bool null $mJavaDetected
 
LocalFile null $mLocalFile
 
bool null $mRemoveTempFile
 
string null $mSourceType
 
UploadStashFile null $mStashFile
 
string null $mSVGNSError
 
string null $mTempPath
 Local file system path to the file to upload (or a local copy) More...
 
Title bool $mTitle = false
 
int $mTitleError = 0
 
TempFSFile null $tempFileObj
 Wrapper to handle deleting the temp file. More...
 

Private Attributes

FileRepo $repo
 
UploadStash $stash
 

Additional Inherited Members

- Public Attributes inherited from UploadBase
const EMPTY_FILE = 3
 
const FILE_TOO_LARGE = 12
 
const FILENAME_TOO_LONG = 14
 
const FILETYPE_BADTYPE = 9
 
const FILETYPE_MISSING = 8
 
const HOOK_ABORTED = 11
 
const ILLEGAL_FILENAME = 5
 
const MIN_LENGTH_PARTNAME = 4
 
const OK = 0
 
const OVERWRITE_EXISTING_FILE = 7
 
const SUCCESS = 0
 
const VERIFICATION_ERROR = 10
 
const WINDOWS_NONASCII_FILENAME = 13
 
- Protected Member Functions inherited from UploadBase
 detectScriptInSvg ( $filename, $partial)
 
 doStashFile (User $user=null)
 Implementation for stashFile() and tryStashFile(). More...
 
 runUploadStashFileHook (User $user)
 
 setTempFile ( $tempPath, $fileSize=null)
 
 verifyFile ()
 Verifies that it's ok to include the uploaded file. More...
 
 verifyMimeType ( $mime)
 Verify the MIME type. More...
 
 verifyPartialFile ()
 A verification routine suitable for partial files. More...
 
- Static Protected Attributes inherited from UploadBase
static $safeXmlEncodings
 

Detailed Description

Implements uploading from previously stored file.

Author
Bryan Tong Minh

Definition at line 33 of file UploadFromStash.php.

Constructor & Destructor Documentation

◆ __construct()

UploadFromStash::__construct ( UserIdentity  $user = null,
  $stash = false,
  $repo = false 
)
Parameters
UserIdentity | null$userDefault: null Sometimes this won't exist, as when running from cron.
UploadStash | bool$stashDefault: false
FileRepo | bool$repoDefault: false

Definition at line 50 of file UploadFromStash.php.

References $repo, $stash, and wfDebug().

Member Function Documentation

◆ getSourceType()

UploadFromStash::getSourceType ( )
Returns
string

Reimplemented from UploadBase.

Definition at line 135 of file UploadFromStash.php.

References $mSourceType.

◆ getTempFileSha1Base36()

UploadFromStash::getTempFileSha1Base36 ( )

Get the base 36 SHA1 of the file.

Returns
string

Reimplemented from UploadBase.

Definition at line 143 of file UploadFromStash.php.

◆ initialize()

UploadFromStash::initialize (   $key,
  $name = 'upload_file',
  $initTempFile = true 
)
Parameters
string$key
string$name
bool$initTempFile

Definition at line 95 of file UploadFromStash.php.

References UploadBase\getRealPath(), and UploadBase\initializePathInfo().

Referenced by initializeFromRequest().

◆ initializeFromRequest()

UploadFromStash::initializeFromRequest ( $request)
Parameters
WebRequest&$request

Reimplemented from UploadBase.

Definition at line 119 of file UploadFromStash.php.

References initialize().

◆ isValidKey()

static UploadFromStash::isValidKey (   $key)
static
Parameters
string$key
Returns
bool

Definition at line 74 of file UploadFromStash.php.

References UploadStash\KEY_FORMAT_REGEX.

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

◆ isValidRequest()

static UploadFromStash::isValidRequest (   $request)
static
Parameters
WebRequest$request
Returns
bool

Reimplemented from UploadBase.

Definition at line 83 of file UploadFromStash.php.

References isValidKey().

◆ postProcessUpload()

UploadFromStash::postProcessUpload ( )

Remove the database record after a successful upload.

Reimplemented from UploadBase.

Definition at line 158 of file UploadFromStash.php.

References unsaveUploadedFile().

◆ unsaveUploadedFile()

UploadFromStash::unsaveUploadedFile ( )

Remove a temporarily kept file stashed by saveTempUploadedFile().

Returns
bool Success

Definition at line 151 of file UploadFromStash.php.

Referenced by postProcessUpload().

Member Data Documentation

◆ $mFileKey

UploadFromStash::$mFileKey
protected

Definition at line 34 of file UploadFromStash.php.

◆ $mFileProps

UploadFromStash::$mFileProps
protected

Definition at line 36 of file UploadFromStash.php.

◆ $mSourceType

UploadFromStash::$mSourceType
protected

Definition at line 37 of file UploadFromStash.php.

Referenced by getSourceType().

◆ $mVirtualTempPath

UploadFromStash::$mVirtualTempPath
protected

Definition at line 35 of file UploadFromStash.php.

◆ $repo

FileRepo UploadFromStash::$repo
private

Definition at line 43 of file UploadFromStash.php.

Referenced by __construct().

◆ $stash

UploadStash UploadFromStash::$stash
private

Definition at line 40 of file UploadFromStash.php.

Referenced by __construct().


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