MediaWiki master
UploadStashFile Class Reference

Inherits UnregisteredLocalFile.

Collaboration diagram for UploadStashFile:

Public Member Functions

 __construct ( $repo, $path, $key, $sha1=null)
 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.
 
 getDescriptionUrl ()
 A method needed by the file transforming and scaling routines in File.php We do not necessarily care about doing the description at this point However, we also can't return the empty string, as the rest of MediaWiki demands this (and calls to imagemagick convert require it to be there)
 
 getFileKey ()
 Getter for file key (the unique id by which this file's location & metadata is stored in the db)
 
 getFullUrl ()
 Parent classes use this method, for no obvious reason, to return the path (relative to wiki root, I assume).
 
 getSha1 ()
 Get the SHA-1 base 36 hash.
 
 getThumbPath ( $thumbName=false)
 Get the path for the thumbnail (actually any transformation of this file) The actual argument is the result of thumbName although we seem to have buggy code elsewhere that expects a boolean 'suffix'.
 
 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 of the file, if for some reason we wanted to download it We tend not to do this for the original file, but we do want thumb icons.
 
 getUrlName ()
 The basename for the URL, which we want to not be related to the filename.
 
 remove ()
 Remove the associated temporary file.
 
 thumbName ( $params, $flags=0)
 Return the file/url base name of a thumbnail with the specified parameters.
 
- Public Member Functions inherited from UnregisteredLocalFile
 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 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()
 
 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=null)
 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 ()
 
 getDisplayWidthHeight ( $maxWidth, $maxHeight, $page=1)
 Get the width and height to display image at.
 
 getExtension ()
 Get the file extension, e.g.
 
 getFilePageThumbUrl ( $url)
 Append a version parameter to the end of a file URL Only to be used on File pages.
 
 getHandler ()
 Get a MediaHandler instance for this file.
 
 getHandlerState (string $key)
 Get a value, or null if it does not exist.
 
 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 ()
 
 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 ()
 
 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.
 
 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.
 
 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.
 
 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 Attributes

string null $url
 Lazy set as in-memory cache.
 
- Protected Attributes inherited from UnregisteredLocalFile
string false $mime
 
array[] bool[] $pageDims
 Dimension data.
 
string $path
 
array null $sizeAndMetadata
 
Title $title
 
- Protected Attributes inherited from File
bool $canRender
 Whether the output of transform() for this file is likely to be valid.
 
string $extension
 File extension.
 
FSFile false $fsFile
 False if undefined.
 
MediaHandler $handler
 
string null $hashPath
 Relative path including trailing slash.
 
bool $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 $pageCount
 Number of pages of a multipage document, or false for documents which aren't multipage documents.
 
string $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 $transformScript
 URL of transformscript (for example thumb.php)
 
string $url
 The URL corresponding to one of the four basic zones.
 

Additional Inherited Members

- Static Public Member Functions inherited from UnregisteredLocalFile
static newFromPath ( $path, $mime)
 
static newFromTitle ( $title, $repo)
 
- Static Public Member Functions inherited from 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 UnregisteredLocalFile
MediaHandler $handler
 
- Public Attributes inherited from 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
 
- Protected Member Functions inherited from 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)
 

Detailed Description

Definition at line 26 of file UploadStashFile.php.

Constructor & Destructor Documentation

◆ __construct()

UploadStashFile::__construct ( $repo,
$path,
$key,
$sha1 = null )

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

Arguably UnregisteredLocalFile should be handling its own file repo but that class is a bit retarded currently.

Parameters
FileRepo$repoRepository where we should find the path
string$pathPath to file
string$keyKey to store the path and any stashed data under
string | null$sha1SHA1 of file. Will calculate if not set
Exceptions
UploadStashBadPathException
UploadStashFileNotFoundException

Reimplemented from UnregisteredLocalFile.

Definition at line 49 of file UploadStashFile.php.

References $path, File\$repo, FileRepo\fileExists(), FileRepo\getZonePath(), FileRepo\isVirtualUrl(), FileRepo\resolveVirtualUrl(), FileRepo\validateFilename(), wfDebug(), and wfMessage().

Member Function Documentation

◆ exists()

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 File.

Definition at line 230 of file UploadStashFile.php.

◆ getDescriptionUrl()

UploadStashFile::getDescriptionUrl ( )

A method needed by the file transforming and scaling routines in File.php We do not necessarily care about doing the description at this point However, we also can't return the empty string, as the rest of MediaWiki demands this (and calls to imagemagick convert require it to be there)

Returns
string Dummy value

Reimplemented from File.

Definition at line 106 of file UploadStashFile.php.

References getUrl().

◆ getFileKey()

UploadStashFile::getFileKey ( )

Getter for file key (the unique id by which this file's location & metadata is stored in the db)

Returns
string File key

Definition at line 213 of file UploadStashFile.php.

◆ getFullUrl()

UploadStashFile::getFullUrl ( )

Parent classes use this method, for no obvious reason, to return the path (relative to wiki root, I assume).

But with this class, the URL is unrelated to the path.

Returns
string Url

Reimplemented from File.

Definition at line 203 of file UploadStashFile.php.

References getUrl().

◆ getSha1()

UploadStashFile::getSha1 ( )

Get the SHA-1 base 36 hash.

This can be expensive on large files, so cache the value

Returns
string|false

Reimplemented from File.

Definition at line 91 of file UploadStashFile.php.

◆ getThumbPath()

UploadStashFile::getThumbPath ( $thumbName = false)

Get the path for the thumbnail (actually any transformation of this file) The actual argument is the result of thumbName although we seem to have buggy code elsewhere that expects a boolean 'suffix'.

Parameters
string | false$thumbNameName of thumbnail (e.g. "120px-123456.jpg" ), or false to just get the path
Returns
string Path thumbnail should take on filesystem, or containing directory if thumbname is false

Reimplemented from File.

Definition at line 120 of file UploadStashFile.php.

References $path.

◆ getThumbUrl()

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$thumbNameBasename 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 File.

Definition at line 162 of file UploadStashFile.php.

References getUrlName(), and wfDebug().

◆ getUrl()

UploadStashFile::getUrl ( )

Return the URL of the file, if for some reason we wanted to download it We tend not to do this for the original file, but we do want thumb icons.

Returns
string Url

Reimplemented from File.

Definition at line 188 of file UploadStashFile.php.

References $url, and getUrlName().

Referenced by getDescriptionUrl(), and getFullUrl().

◆ getUrlName()

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 '120px-123456.jpg'

Definition at line 174 of file UploadStashFile.php.

Referenced by getThumbUrl(), getUrl(), and thumbName().

◆ remove()

UploadStashFile::remove ( )

Remove the associated temporary file.

Returns
bool Success

Definition at line 221 of file UploadStashFile.php.

◆ thumbName()

UploadStashFile::thumbName ( $params,
$flags = 0 )

Return the file/url base name of a thumbnail with the specified parameters.

We override this because we want to use the pretty url name instead of the ugly file name.

Parameters
array$paramsHandler-specific parameters
int$flagsBitfield that supports THUMB_* constants
Returns
string|null Base name for URL, like '120px-12345.jpg', or null if there is no handler

Reimplemented from File.

Definition at line 138 of file UploadStashFile.php.

References $params, File\generateThumbName(), and getUrlName().

Member Data Documentation

◆ $url

string null UploadStashFile::$url
protected

Lazy set as in-memory cache.

Definition at line 32 of file UploadStashFile.php.


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