MediaWiki\Upload\UploadStashFile Class Reference

Inherits MediaWiki\FileRepo\File\UnregisteredLocalFile.

Collaboration diagram for MediaWiki\Upload\UploadStashFile:

Public Member Functions
	__construct ( $repo, $path, $key, $sha1=null, $mime=false)
	A LocalFile wrapper around a file that has been temporarily stashed, so we can do things like create thumbnails for it.
	exists ()
	Returns true if file exists in the repository.Overridden by LocalFile to avoid unnecessary stat calls. Stability: stable to override Returns bool Whether file exists in the repository.
	getDescriptionUrl ()
	There is no description URL.
	getFileKey ()
	Get the file key.
	getSha1 ()
	Get the SHA-1 base 36 hash of the file. Stability: stable to override Returns string|false
	getThumbPath ( $thumbName=false)
	Get the path of the thumbnail directory, or a particular file if $suffix is specified. Stability: stable to override Parameters string | false $suffix If not false, the name of a thumbnail file Returns string
	getThumbUrl ( $thumbName=false)
	Get a URL to access the thumbnail This is required because the model of how files work requires that the thumbnail urls be predictable.
	getUrl ()
	Return the URL to the original file. Stability: stable to override Returns string
	getUrlName ()
	The basename for the URL, which we want to not be related to the filename.
	remove ()
	Remove the associated temporary file.
Public Member Functions inherited from MediaWiki\FileRepo\File\UnregisteredLocalFile
	__construct ( $title=false, $repo=false, $path=false, $mime=false)
	Create an UnregisteredLocalFile based on a path or a (title,repo) pair.
	getBitDepth ()
	getHeight ( $page=1)
	getMetadata ()
	getMetadataArray ()
	Get the unserialized handler-specific metadata STUB.
	getMimeType ()
	getSize ()
	getURL ()
	getWidth ( $page=1)
	setLocalReference (FSFile $fsFile)
	Optimize getLocalRefPath() by using an existing local reference.
Public Member Functions inherited from MediaWiki\FileRepo\File\File
	__construct ( $title, $repo)
	Call this constructor from child classes.
	__get ( $name)
	addToShellboxCommand (BoxedCommand $command, string $boxedName)
	Add the file to a Shellbox command as an input file.
	allowInlineDisplay ()
	Alias for canRender()
	appendRequestProvenance (string $url, array $provenance)
	Add information about where a URL to an image was generated.
	canAnimateThumbIfAppropriate ()
	Will the thumbnail be animated if one would expect it to be.
	canRender ()
	Checks if the output of transform() for this file is likely to be valid.
	convertMetadataVersion ( $metadata, $version)
	get versioned metadata
	createThumb ( $width, $height=-1)
	Create a thumbnail of the image having the specified width/height.
	deleteFile ( $reason, UserIdentity $user, $suppress=false)
	Delete all versions of the file.
	formatMetadata ( $context=false)
	generateAndSaveThumb ( $tmpFile, $transformParams, $flags)
	Generates a thumbnail according to the given parameters and saves it to storage.
	generateThumbName ( $name, $params)
	Generate a thumbnail file name from a name and specified parameters.
	getArchivePath ( $suffix=false)
	Get the path of the archived file.
	getArchiveRel ( $suffix=false)
	Get the path of an archived file relative to the public zone root.
	getArchiveThumbPath ( $archiveName, $suffix=false)
	Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified.
	getArchiveThumbUrl ( $archiveName, $suffix=false)
	Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified.
	getArchiveUrl ( $suffix=false)
	Get the URL of the archive directory, or a particular file if $suffix is specified.
	getArchiveVirtualUrl ( $suffix=false)
	Get the public zone virtual URL for an archived version source file.
	getAvailableLanguages ()
	Gives a (possibly empty) list of IETF languages to render the file in.
	getCanonicalUrl ()
	getCommonMetaArray ()
	Like getMetadata but returns a handler independent array of common values.
	getContentHeaders ()
	getDefaultRenderLanguage ()
	In files that support multiple language, what is the default language to use if none specified.
	getDescription ( $audience=self::FOR_PUBLIC, ?Authority $performer=null)
	Get description of file revision STUB.
	getDescriptionShortUrl ()
	Get short description URL for a files based on the page ID.
	getDescriptionText (Language $lang)
	Get the HTML text of the description page, if available.
	getDescriptionTouched ()
	Returns the timestamp (in TS::MW format) of the last change of the description page.
	getDimensionsString (Language $lang)
	getDisplayWidthHeight ( $maxWidth, $maxHeight, $page=1)
	Get the width and height to display image at.
	getExtension ()
	Get the file extension, e.g.
	getFullUrl ()
	Return a fully-qualified URL to the file.
	getHandler (?Language $lang=null)
	Get a MediaHandler instance for this file.
	getHandlerState (string $key)
	Get a value, or null if it does not exist. Parameters string $key Returns mixed|null
	getHashPath ()
	Get the filename hash component of the directory including trailing slash, e.g.
	getHistory ( $limit=null, $start=null, $end=null, $inc=true)
	Return a fragment of the history of file.
	getLastError ()
	Get last thumbnailing error.
	getLength ()
	Get the duration of a media file in seconds.
	getLocalRefPath ()
	Get an FS copy or original of this file and return the path.
	getLongDesc (Language $lang)
	Long description.
	getMatchedLanguage ( $userPreferredLanguage)
	Get the IETF language code from the available languages for this file that matches the language requested by the user.
	getMediaType ()
	Return the type of the media in the file.
	getMetadataItem (string $itemName)
	Get a specific element of the unserialized handler-specific metadata.
	getMetadataItems (array $itemNames)
	Get multiple elements of the unserialized handler-specific metadata.
	getName ()
	Return the name of this file.
	getOriginalTitle ()
	Return the title used to find this file.
	getPath ()
	Return the storage path to the file.
	getRedirected ()
	getRel ()
	Get the path of the file relative to the public zone root.
	getRepo ()
	Returns the repository.
	getRepoName ()
	Returns the name of the repository.
	getShortDesc (Language $lang)
	Short description.
	getStorageKey ()
	Get the deletion archive key, "<sha1>.<ext>".
	getThumbDisposition ( $thumbName, $dispositionType='inline')
	getThumbnailBucket ( $desiredWidth, $page=1)
	Return the smallest bucket from $wgThumbnailBuckets which is at least $wgThumbnailMinimumBucketDistance larger than $desiredWidth.
	getThumbnailSource ( $params)
	Returns the most appropriate source image for the thumbnail, given a target thumbnail size.
	getThumbRel ( $suffix=false)
	Get the path, relative to the thumbnail zone root, of the thumbnail directory or a particular file if $suffix is specified.
	getThumbVirtualUrl ( $suffix=false)
	Get the virtual URL for a thumbnail file or directory.
	getTimestamp ()
	Get the 14-character timestamp of the file upload.
	getTitle ()
	Return the associated title object.
	getTranscodedPath ( $suffix=false)
	Get the path of the transcoded directory, or a particular file if $suffix is specified.
	getTranscodedUrl ( $suffix=false)
	Get the URL of the transcoded directory, or a particular file if $suffix is specified.
	getUnscaledThumb ( $handlerParams=[])
	Get a ThumbnailImage which is the same size as the source.
	getUploader (int $audience=self::FOR_PUBLIC, ?Authority $performer=null)
	Get the identity of the file uploader.
	getUrlRel ()
	Get urlencoded path of the file relative to the public zone root.
	getViewURL ()
	getVirtualUrl ( $suffix=false)
	Get the public zone virtual URL for a current version source file.
	getVisibility ()
	Return the deletion bitfield STUB.
	iconThumb ()
	Get a ThumbnailImage representing a file type icon.
	isCacheable ()
	Check if this file object is small and can be cached.
	isDeleted ( $field)
	Is this file a "deleted" file in a private archive? STUB.
	isExpensiveToThumbnail ()
	True if creating thumbnails from the file is large or otherwise resource-intensive.
	isLocal ()
	Returns true if the file comes from the local file repository.
	isMissing ()
	isMultipage ()
	Returns 'true' if this file is a type which supports multiple pages, e.g.
	isOld ()
	Returns true if the image is an old version STUB.
	isSafeFile ()
	Determines if this media file is in a format that is unlikely to contain viruses or malicious content.
	isTransformedLocally ()
	Whether the thumbnails created on the same server as this code is running.
	isVectorized ()
	Return true if the file is vectorized.
	isVisible ()
	Returns true if file exists in the repository and can be included in a page.
	load ( $flags=0)
	Load any lazy-loaded file object fields from source.
	modifyClientThumbUrl ( $url, $handlerParams)
	Append URL query parameters to a thumbnail URL that are intended to be processed by the browser viewing the final page, or by some proxy, but not by the media handler or the thumbnail server.
	move ( $target)
	Move file to the new title.
	mustRender ()
	Return true if the file is of a type that can't be directly rendered by typical browsers and needs to be re-rasterized.
	nextHistoryLine ()
	Return the history of this file, line by line.
	pageCount ()
	Returns the number of pages of a multipage document, or false for documents which aren't multipage documents.
	parseThumbName (string $name, int $flags=0)
	Invert thumbName(), extracting a parameter array from a string of the form "<params>-<source>" or "<params>-thumbnail.<ext>".
	publish ( $src, $flags=0, array $options=[])
	Move or copy a file to its public location.
	purgeCache ( $options=[])
	Purge shared caches such as thumbnails and DB data caching STUB Overridden by LocalFile.
	purgeDescription ()
	Purge the file description page, but don't go after pages using the file.
	purgeEverything ()
	Purge metadata and all affected pages when the file is created, deleted, or majorly updated.
	redirectedFrom (string $from)
	resetHistory ()
	Reset the history pointer to the first element of the history.
	restore ( $versions=[], $unsuppress=false)
	Restore all or specified deleted revisions to the given file.
	setHandlerState (string $key, $value)
	Set a value. Parameters string $key mixed $value
	thumbName ( $params, $flags=0)
	Return the file name of a thumbnail with the specified parameters.
	transform ( $params, $flags=0)
	Transform a media file.
	upgradeRow ()
	Upgrade the database row if there is one Called by ImagePage STUB.
	userCan ( $field, Authority $performer)
	Determine if the current user is allowed to view a particular field of this file, if it's marked as deleted.
	wasDeleted ()
	Was this file ever deleted from the wiki?

Protected Member Functions
	getSourcePartOfThumbName ( $flags=0)
	Get the source part of the thumb name, which may either be the name of the file, or an abbreviation with the same extension.UploadStashFile overrides this to use the stash key. Parameters int $flags See thumbName() Returns string
	getTransformScript ()
	If a transform script is configured, it must be suppressed.
Protected Member Functions inherited from MediaWiki\FileRepo\File\File
	assertRepoDefined ()
	Assert that $this->repo is set to a valid FileRepo instance.
	assertTitleDefined ()
	Assert that $this->title is set to a Title.
	generateBucketsIfNeeded ( $params, $flags=0)
	Generates chained bucketed thumbnails if needed.
	getBucketThumbName ( $bucket)
	Returns the name of the thumb for a given bucket.
	getBucketThumbPath ( $bucket)
	Returns the repo path of the thumb for a given bucket.
	getCanRender ()
	Accessor for __get()
	getIsSafeFile ()
	Accessor for __get()
	getIsSafeFileUncached ()
	Uncached accessor.
	getRedirectedTitle ()
	getThumbnails ()
	Get all thumbnail names previously generated for this file STUB Overridden by LocalFile.
	isHashed ()
	isTrustedFile ()
	Returns true if the file is flagged as trusted.
	makeTransformTmpFile ( $thumbPath)
	Creates a temp FS file with the same extension and the thumbnail.
	readOnlyError ()
	transformErrorOutput ( $thumbPath, $thumbUrl, $params, $flags)
	Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)

Protected Attributes
string null	$url
	Lazy set as in-memory cache.
Protected Attributes inherited from MediaWiki\FileRepo\File\UnregisteredLocalFile
string null	$mime
array[] bool[]	$pageDims
	Dimension data.
string	$path
array null	$sizeAndMetadata
Title	$title
Protected Attributes inherited from MediaWiki\FileRepo\File\File
bool null	$canRender
	Whether the output of transform() for this file is likely to be valid.
string null	$extension
	File extension.
FSFile false null	$fsFile
	False if undefined.
MediaHandler null	$handler
string null	$hashPath
	Relative path including trailing slash.
bool null	$isSafeFile
	Whether this media file is in a format that is unlikely to contain viruses or malicious content.
string	$lastError
	Text of last error.
string null	$name
	The name of a file from its title object.
int false null	$pageCount
	Number of pages of a multipage document, or false for documents which aren't multipage documents.
string null	$path
	The storage path corresponding to one of the zones.
string	$redirected
	The name that was used to access the file, before resolving redirects.
Title	$redirectedTitle
Title	$redirectTitle
string	$repoClass = FileRepo::class
	Required Repository class type.
Title string false	$title
array	$tmpBucketedThumbCache = []
	Cache of tmp filepaths pointing to generated bucket thumbnails, keyed by width.
string false null	$transformScript
	URL of transformscript (for example thumb.php)
string null	$url
	The URL corresponding to one of the four basic zones.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\FileRepo\File\UnregisteredLocalFile
static	newFromPath ( $path, $mime)
static	newFromTitle ( $title, $repo)
Static Public Member Functions inherited from MediaWiki\FileRepo\File\File
static	checkExtensionCompatibility (File $old, $new)
	Checks if file extensions are compatible.
static	compare (File $a, File $b)
	Callback for usort() to do file sorts by name.
static	normalizeExtension ( $extension)
	Normalize a file extension to the common form, making it lowercase and checking some synonyms, and ensure it's clean.
static	normalizeTitle ( $title, $exception=false)
	Given a string or Title object return either a valid Title object with namespace NS_FILE or null.
static	scaleHeight ( $srcWidth, $srcHeight, $dstWidth)
	Calculate the height of a thumbnail using the source and destination width.
static	splitMime (?string $mime)
	Split an internet media type into its two components; if not a two-part name, set the minor type to 'unknown'.
Public Attributes inherited from MediaWiki\FileRepo\File\UnregisteredLocalFile
MediaHandler	$handler
Public Attributes inherited from MediaWiki\FileRepo\File\File
FileRepo LocalRepo ForeignAPIRepo false	$repo
	Some member variables can be lazy-initialised using __get().
const	DELETE_SOURCE = 1
const	DELETED_COMMENT = 2
const	DELETED_FILE = 1
const	DELETED_RESTRICTED = 8
const	DELETED_USER = 4
const	FOR_PUBLIC = 1
const	FOR_THIS_USER = 2
const	RAW = 3
const	RENDER_FORCE = 2
	Force rendering even if thumbnail already exist and using RENDER_NOW I.e.
const	RENDER_NOW = 1
	Force rendering in the current process.
const	THUMB_FULL_NAME = 1

Detailed Description

Definition at line 19 of file UploadStashFile.php.

Constructor & Destructor Documentation

__construct()

MediaWiki\Upload\UploadStashFile::__construct	(		$repo,
			$path,
			$key,
			$sha1 = null,
			$mime = false )

A LocalFile wrapper around a file that has been temporarily stashed, so we can do things like create thumbnails for it.

Parameters

LocalRepo	$repo	Repository where we should find the path
string	$path	Path to file
string	$key	Key to store the path and any stashed data under
string | null	$sha1	SHA1 of file. Will calculate if not set
string | false	$mime	Mime type of file. Will calculate if not set

Exceptions

UploadStashBadPathException
UploadStashFileNotFoundException

Definition at line 40 of file UploadStashFile.php.

References MediaWiki\FileRepo\File\UnregisteredLocalFile\$mime, MediaWiki\FileRepo\File\UnregisteredLocalFile\$path, MediaWiki\FileRepo\File\File\$repo, MediaWiki\FileRepo\FileRepo\fileExists(), MediaWiki\FileRepo\FileRepo\getVirtualUrl(), MediaWiki\FileRepo\FileRepo\getZonePath(), MediaWiki\FileRepo\FileRepo\resolveVirtualUrl(), MediaWiki\FileRepo\FileRepo\validateFilename(), wfDebug(), wfDeprecatedMsg(), and wfMessage().

Member Function Documentation

exists()

MediaWiki\Upload\UploadStashFile::exists

(

)

Returns true if file exists in the repository.Overridden by LocalFile to avoid unnecessary stat calls.

Stability: stable

to override

Returns

bool Whether file exists in the repository.

Reimplemented from MediaWiki\FileRepo\File\File.

Definition at line 193 of file UploadStashFile.php.

getDescriptionUrl()

MediaWiki\Upload\UploadStashFile::getDescriptionUrl

(

)

There is no description URL.

Don't put a comment in thumbnail EXIF.

Returns

false

Reimplemented from MediaWiki\FileRepo\File\File.

Definition at line 100 of file UploadStashFile.php.

getFileKey()

MediaWiki\Upload\UploadStashFile::getFileKey

(

)

Get the file key.

Returns

string File key

Definition at line 180 of file UploadStashFile.php.

getSha1()

MediaWiki\Upload\UploadStashFile::getSha1

(

)

Get the SHA-1 base 36 hash of the file.

Stability: stable

to override

Returns

string|false

Reimplemented from MediaWiki\FileRepo\File\File.

Definition at line 89 of file UploadStashFile.php.

getSourcePartOfThumbName()

MediaWiki\Upload\UploadStashFile::getSourcePartOfThumbName ( $flags = 0 )

protected

Get the source part of the thumb name, which may either be the name of the file, or an abbreviation with the same extension.UploadStashFile overrides this to use the stash key.

Parameters

int

$flags

See thumbName()

Returns

string

Reimplemented from MediaWiki\FileRepo\File\File.

Definition at line 115 of file UploadStashFile.php.

References MediaWiki\Upload\UploadStashFile\getUrlName().

getThumbPath()

MediaWiki\Upload\UploadStashFile::getThumbPath

(

$thumbName = false

)

Get the path of the thumbnail directory, or a particular file if $suffix is specified.

Stability: stable

to override

Parameters

string | false

$suffix

If not false, the name of a thumbnail file

Returns

string

Reimplemented from MediaWiki\FileRepo\File\File.

Definition at line 105 of file UploadStashFile.php.

References MediaWiki\FileRepo\File\UnregisteredLocalFile\$path.

getThumbUrl()

MediaWiki\Upload\UploadStashFile::getThumbUrl

(

$thumbName = false

)

Get a URL to access the thumbnail This is required because the model of how files work requires that the thumbnail urls be predictable.

However, in our model the URL is not based on the filename (that's hidden in the db)

Parameters

string | false

$thumbName

Basename of thumbnail file – however, we don't want to use the file exactly

Returns

string URL to access thumbnail, or URL with partial path

Reimplemented from MediaWiki\FileRepo\File\File.

Definition at line 140 of file UploadStashFile.php.

References MediaWiki\Upload\UploadStashFile\getUrlName(), and wfDebug().

getTransformScript()

MediaWiki\Upload\UploadStashFile::getTransformScript ( )

protected

If a transform script is configured, it must be suppressed.

Special:UploadStash is the transform script. (T439062)

Returns

string|false

Reimplemented from MediaWiki\FileRepo\File\File.

Definition at line 152 of file UploadStashFile.php.

getUrl()

MediaWiki\Upload\UploadStashFile::getUrl

(

)

Return the URL to the original file.

Stability: stable

to override

Returns

string

Reimplemented from MediaWiki\FileRepo\File\File.

Definition at line 167 of file UploadStashFile.php.

References MediaWiki\Upload\UploadStashFile\$url, and MediaWiki\Upload\UploadStashFile\getUrlName().

getUrlName()

MediaWiki\Upload\UploadStashFile::getUrlName

(

)

The basename for the URL, which we want to not be related to the filename.

Will also be used as the lookup key for a thumbnail file.

Returns

string Base url name, like '1cumins7kwkw.9xoht5.2158737.jpg'

Definition at line 162 of file UploadStashFile.php.

Referenced by MediaWiki\Upload\UploadStashFile\getSourcePartOfThumbName(), MediaWiki\Upload\UploadStashFile\getThumbUrl(), and MediaWiki\Upload\UploadStashFile\getUrl().

remove()

MediaWiki\Upload\UploadStashFile::remove

(

)

Remove the associated temporary file.

Returns

bool Success

Definition at line 188 of file UploadStashFile.php.

Member Data Documentation

$url

string null MediaWiki\Upload\UploadStashFile::$url

protected

Lazy set as in-memory cache.

Definition at line 23 of file UploadStashFile.php.

Referenced by MediaWiki\Upload\UploadStashFile\getUrl().

---

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

• includes/Upload/UploadStashFile.php