MediaWiki master
|
Implements some public methods and some protected utility functions which are required by multiple child classes. More...
Inherits MediaHandlerState.
Inherited by ForeignAPIFile, LocalFile, and UnregisteredLocalFile.
Public Member Functions | |
__construct ( $title, $repo) | |
Call this constructor from child classes. | |
__get ( $name) | |
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. | |
exists () | |
Returns true if file exists in the repository. | |
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. | |
getBitDepth () | |
Return the bit depth of the file Overridden by LocalFile STUB. | |
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. | |
getDescriptionUrl () | |
Get the URL of the image 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. | |
getFullUrl () | |
Return a fully-qualified URL to the file. | |
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. | |
getHeight ( $page=1) | |
Return the height of the image. | |
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. | |
getMetadata () | |
Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB. | |
getMetadataArray () | |
Get the unserialized handler-specific metadata STUB. | |
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. | |
getMimeType () | |
Returns the MIME type of the file. | |
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. | |
getSha1 () | |
Get the SHA-1 base 36 hash of the file. | |
getShortDesc () | |
getSize () | |
Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB. | |
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. | |
getThumbPath ( $suffix=false) | |
Get the path of the thumbnail directory, or a particular file if $suffix is specified. | |
getThumbRel ( $suffix=false) | |
Get the path, relative to the thumbnail zone root, of the thumbnail directory or a particular file if $suffix is specified. | |
getThumbUrl ( $suffix=false) | |
Get the URL 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. | |
getUrl () | |
Return the URL of the file. | |
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. | |
getWidth ( $page=1) | |
Return the width of the image. | |
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. | |
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? | |
Static Public Member Functions | |
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 | |
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 | |
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 | |
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. | |
Implements some public methods and some protected utility functions which are required by multiple child classes.
Contains stub functionality for unimplemented public methods.
Stub functions which should be overridden are marked with STUB. Some more concrete functions are also typically overridden by child classes.
Note that only the repo object knows what its file class is called. You should never name a file class explicitly outside of the repo class. Instead use the repo's factory functions to generate file objects, for example:
RepoGroup::singleton()->getLocalRepo()->newFile( $title );
Consider the services container below;
$services = MediaWikiServices::getInstance();
The convenience services $services->getRepoGroup()->getLocalRepo()->newFile() and $services->getRepoGroup()->findFile() should be sufficient in most cases.
@TODO: DI - Instead of using MediaWikiServices::getInstance(), a service should ideally accept a RepoGroup in its constructor and then, use $this->repoGroup->findFile() and $this->repoGroup->getLocalRepo()->newFile().
File::__construct | ( | $title, | |
$repo ) |
Call this constructor from child classes.
Both $title and $repo are optional, though some functions may return false or throw exceptions if they are not set. Most subclasses will want to call assertRepoDefined() here.
Title | string | false | $title | |
FileRepo | false | $repo |
Reimplemented in LocalFile.
File::allowInlineDisplay | ( | ) |
Alias for canRender()
Definition at line 910 of file File.php.
Referenced by canAnimateThumbIfAppropriate().
|
protected |
Assert that $this->repo is set to a valid FileRepo instance.
Definition at line 2471 of file File.php.
Referenced by LocalFile\__construct(), ForeignAPIFile\__construct(), UnregisteredLocalFile\__construct(), getLocalRefPath(), getName(), getPath(), and getUrl().
|
protected |
Assert that $this->title is set to a Title.
Definition at line 2480 of file File.php.
Referenced by LocalFile\__construct().
File::canAnimateThumbIfAppropriate | ( | ) |
Will the thumbnail be animated if one would expect it to be.
Currently used to add a warning to the image description page
Definition at line 719 of file File.php.
References allowInlineDisplay(), MediaHandler\canAnimateThumbnail(), getHandler(), and MediaHandler\isAnimatedImage().
File::canRender | ( | ) |
Checks if the output of transform() for this file is likely to be valid.
In other words, this will return true if a thumbnail can be provided for this image (e.g. if [[File:...|thumb]] produces a result on a wikitext page).
If this is false, various user elements will display a placeholder instead.
Definition at line 874 of file File.php.
Referenced by getViewURL(), and ForeignAPIFile\transform().
|
static |
Checks if file extensions are compatible.
File | $old | Old file |
string | $new | New name |
Definition at line 291 of file File.php.
References getMimeType().
File::convertMetadataVersion | ( | $metadata, | |
$version ) |
get versioned metadata
array | $metadata | Array of unserialized metadata |
int | string | $version | Version number. |
Definition at line 809 of file File.php.
References MediaHandler\convertMetadataVersion().
File::createThumb | ( | $width, | |
$height = -1 ) |
Create a thumbnail of the image having the specified width/height.
The thumbnail will not be created if the width is larger than the image's width. Let the browser do the scaling in this case. The thumbnail is stored on disk and is only computed if the thumbnail file does not exist OR if it is older than the image. Returns the URL.
Keeps aspect ratio of original image. If both width and height are specified, the generated image will be no bigger than width x height, and will also have correct aspect ratio.
int | $width | Maximum width of the generated thumbnail |
int | $height | Maximum height of the image (optional) |
Definition at line 1138 of file File.php.
References $params.
Referenced by getViewURL().
File::deleteFile | ( | $reason, | |
UserIdentity | $user, | ||
$suppress = false ) |
Delete all versions of the file.
Moves the files into an archive directory (or deletes them) and removes the database rows.
Cache purging is done; logging is caller's responsibility.
string | $reason | |
UserIdentity | $user | |
bool | $suppress | Hide content from sysops? |
Reimplemented in ForeignDBFile, and LocalFile.
File::exists | ( | ) |
Returns true if file exists in the repository.
Overridden by LocalFile to avoid unnecessary stat calls.
Reimplemented in ForeignAPIFile, LocalFile, OldLocalFile, and UploadStashFile.
Definition at line 1020 of file File.php.
Referenced by MediaWiki\Api\ApiDelete\canDeleteFile(), LocalRepo\findFiles(), MediaWiki\Rest\Handler\MediaFileHandler\hasRepresentation(), and MediaWiki\Output\OutputPage\setFileVersion().
File::formatMetadata | ( | $context = false | ) |
IContextSource | false | $context |
Definition at line 2026 of file File.php.
References MediaHandler\formatMetadata().
File::generateAndSaveThumb | ( | $tmpFile, | |
$transformParams, | |||
$flags ) |
Generates a thumbnail according to the given parameters and saves it to storage.
TempFSFile | $tmpFile | Temporary file where the rendered thumbnail will be saved |
array | $transformParams | |
int | $flags |
Definition at line 1287 of file File.php.
References MediaHandler\doTransform(), MediaHandler\getTransform(), MediaHandler\normaliseParams(), MediaHandler\supportsBucketing(), and wfMessage().
|
protected |
File::generateThumbName | ( | $name, | |
$params ) |
Generate a thumbnail file name from a name and specified parameters.
string | $name | |
array | $params | Parameters which will be passed to MediaHandler::makeParamString |
Definition at line 1099 of file File.php.
References $params.
Referenced by UploadStashFile\thumbName().
File::getArchivePath | ( | $suffix = false | ) |
File::getArchiveRel | ( | $suffix = false | ) |
File::getArchiveThumbPath | ( | $archiveName, | |
$suffix = false ) |
File::getArchiveThumbUrl | ( | $archiveName, | |
$suffix = false ) |
Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified.
string | $archiveName | The timestamped name of an archived image |
string | false | $suffix | If not false, the name of a thumbnail file |
Definition at line 1860 of file File.php.
References $path.
File::getArchiveUrl | ( | $suffix = false | ) |
File::getArchiveVirtualUrl | ( | $suffix = false | ) |
File::getAvailableLanguages | ( | ) |
Gives a (possibly empty) list of IETF languages to render the file in.
If the file doesn't have translations, or if the file format does not support that sort of thing, returns an empty array.
Definition at line 665 of file File.php.
References MediaHandler\getAvailableLanguages(), and getHandler().
File::getBitDepth | ( | ) |
Return the bit depth of the file Overridden by LocalFile STUB.
Reimplemented in LocalFile, and UnregisteredLocalFile.
|
protected |
|
protected |
File::getCanonicalUrl | ( | ) |
Definition at line 435 of file File.php.
References getUrl(), and PROTO_CANONICAL.
|
protected |
File::getCommonMetaArray | ( | ) |
Like getMetadata but returns a handler independent array of common values.
Definition at line 797 of file File.php.
References MediaHandler\getCommonMetaArray().
File::getContentHeaders | ( | ) |
Definition at line 2375 of file File.php.
References MediaHandler\getContentHeaders().
File::getDefaultRenderLanguage | ( | ) |
In files that support multiple language, what is the default language to use if none specified.
Definition at line 700 of file File.php.
References MediaHandler\getDefaultRenderLanguage(), and getHandler().
File::getDescription | ( | $audience = self::FOR_PUBLIC, | |
Authority | $performer = null ) |
Get description of file revision STUB.
int | $audience | One of: File::FOR_PUBLIC to be displayed to all users File::FOR_THIS_USER to be displayed to the given user File::RAW get the description regardless of permissions |
Authority | null | $performer | to check for, only if FOR_THIS_USER is passed to the $audience parameter |
Reimplemented in ForeignAPIFile, and LocalFile.
File::getDescriptionShortUrl | ( | ) |
Get short description URL for a files based on the page ID.
Reimplemented in ForeignAPIFile, ForeignDBFile, and LocalFile.
File::getDescriptionText | ( | Language | $lang = null | ) |
Get the HTML text of the description page, if available.
Language | null | $lang | Optional language to fetch description in |
Reimplemented in ForeignDBFile, and LocalFile.
File::getDescriptionTouched | ( | ) |
Returns the timestamp (in TS_MW format) of the last change of the description page.
Returns false if the file does not have a description page, or retrieving the timestamp would be expensive.
Reimplemented in LocalFile.
File::getDescriptionUrl | ( | ) |
Get the URL of the image description page.
May return false if it is unknown or not applicable.
Reimplemented in ForeignAPIFile, ForeignDBFile, LocalFile, and UploadStashFile.
Definition at line 2216 of file File.php.
Referenced by ForeignDBFile\getDescriptionUrl(), and ImagePage\imageDupes().
File::getDimensionsString | ( | ) |
Definition at line 2411 of file File.php.
References MediaHandler\getDimensionsString().
File::getDisplayWidthHeight | ( | $maxWidth, | |
$maxHeight, | |||
$page = 1 ) |
Get the width and height to display image at.
int | $maxWidth | Max width to display at |
int | $maxHeight | Max height to display at |
int | $page |
Definition at line 595 of file File.php.
References getHeight(), and getWidth().
File::getExtension | ( | ) |
File::getFilePageThumbUrl | ( | $url | ) |
Append a version parameter to the end of a file URL Only to be used on File pages.
string | $url | Unversioned URL |
Definition at line 1909 of file File.php.
References $url, getTimestamp(), and wfAppendQuery().
File::getFullUrl | ( | ) |
Return a fully-qualified URL to the file.
Upload URL paths may or may not be fully qualified, so we check. Local paths are assumed to belong on $wgServer.
Reimplemented in UploadStashFile.
Definition at line 426 of file File.php.
References getUrl(), and PROTO_RELATIVE.
File::getHandler | ( | ) |
Get a MediaHandler instance for this file.
Definition at line 1553 of file File.php.
Referenced by canAnimateThumbIfAppropriate(), getAvailableLanguages(), getDefaultRenderLanguage(), LocalFile\getHeight(), getLength(), getMatchedLanguage(), LocalFile\getWidth(), ThumbnailRenderJob\hitThumbUrl(), isVectorized(), LocalFile\maybeUpgradeRow(), and wfThumbIsStandard().
File::getHandlerState | ( | string | $key | ) |
Get a value, or null if it does not exist.
string | $key |
Implements MediaHandlerState.
File::getHashPath | ( | ) |
File::getHeight | ( | $page = 1 | ) |
Return the height of the image.
Returns false if the height is unknown or undefined
STUB Overridden by LocalFile, UnregisteredLocalFile
int | $page |
Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.
Definition at line 536 of file File.php.
Referenced by getDisplayWidthHeight().
File::getHistory | ( | $limit = null, | |
$start = null, | |||
$end = null, | |||
$inc = true ) |
Return a fragment of the history of file.
STUB
int | null | $limit | Limit of rows to return |
string | int | null | $start | Only revisions older than $start will be returned |
string | int | null | $end | Only revisions newer than $end will be returned |
bool | $inc | Include the endpoints of the time range |
Reimplemented in LocalFile.
|
protected |
|
protected |
Uncached accessor.
Definition at line 949 of file File.php.
References MEDIATYPE_UNKNOWN.
File::getLastError | ( | ) |
File::getLength | ( | ) |
Get the duration of a media file in seconds.
Definition at line 631 of file File.php.
References getHandler(), and MediaHandler\getLength().
File::getLocalRefPath | ( | ) |
Get an FS copy or original of this file and return the path.
Returns false on failure. Callers must not alter the file. Temporary files are cleared automatically.
Definition at line 488 of file File.php.
References assertRepoDefined(), and getPath().
Referenced by UnregisteredLocalFile\getMimeType().
File::getLongDesc | ( | ) |
File::getMatchedLanguage | ( | $userPreferredLanguage | ) |
Get the IETF language code from the available languages for this file that matches the language requested by the user.
string | $userPreferredLanguage |
Definition at line 681 of file File.php.
References MediaHandler\getAvailableLanguages(), getHandler(), and MediaHandler\getMatchedLanguage().
File::getMediaType | ( | ) |
Return the type of the media in the file.
Use the value returned by this function with the MEDIATYPE_xxx constants. Overridden by LocalFile, STUB
Reimplemented in ForeignAPIFile, and LocalFile.
Definition at line 860 of file File.php.
References MEDIATYPE_UNKNOWN.
File::getMetadata | ( | ) |
Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB.
Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.
File::getMetadataArray | ( | ) |
Get the unserialized handler-specific metadata STUB.
Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.
Definition at line 762 of file File.php.
Referenced by SvgHandler\getAvailableLanguages(), ExifBitmapHandler\getCommonMetaArray(), SvgHandler\getCommonMetaArray(), GIFHandler\getCommonMetaArray(), PNGHandler\getCommonMetaArray(), and WebPHandler\getCommonMetaArray().
File::getMetadataItem | ( | string | $itemName | ) |
File::getMetadataItems | ( | array | $itemNames | ) |
File::getMimeType | ( | ) |
Returns the MIME type of the file.
Overridden by LocalFile, UnregisteredLocalFile STUB
Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.
Definition at line 848 of file File.php.
Referenced by checkExtensionCompatibility(), and getViewURL().
File::getName | ( | ) |
Return the name of this file.
Definition at line 344 of file File.php.
References assertRepoDefined().
Referenced by compare(), LocalRepo\findFiles(), MediaWiki\FileRepo\ThumbnailEntryPoint\generateThumbnail(), LocalFile\getCacheKey(), ForeignDBFile\getDescriptionText(), getExtension(), getViewURL(), ImageHistoryList\imageHistoryLine(), LocalFile\loadFromDB(), PurgeChangedFiles\purgeFromArchiveTable(), ForeignAPIFile\transform(), and LocalFile\upgradeRow().
File::getOriginalTitle | ( | ) |
Return the title used to find this file.
Definition at line 383 of file File.php.
References getRedirectedTitle().
File::getPath | ( | ) |
Return the storage path to the file.
Note that this does not mean that a file actually exists under that location.
This path depends on whether directory hashing is active or not, i.e. whether the files are all found in the same directory, or in hashed paths like /images/3/3c.
Most callers don't check the return value, but ForeignAPIFile::getPath returns false.
Reimplemented in ForeignAPIFile.
Definition at line 472 of file File.php.
References $path, assertRepoDefined(), and getRel().
Referenced by PurgeChangedFiles\getDeletedPath(), and getLocalRefPath().
File::getRedirected | ( | ) |
Definition at line 2424 of file File.php.
Referenced by MediaWiki\Api\ApiDelete\canDeleteFile().
|
protected |
Definition at line 2431 of file File.php.
References NS_FILE.
Referenced by getOriginalTitle().
File::getRel | ( | ) |
Get the path of the file relative to the public zone root.
This function is overridden in OldLocalFile to be like getArchiveRel().
Reimplemented in OldLocalFile.
Definition at line 1713 of file File.php.
Referenced by getPath().
File::getRepo | ( | ) |
Returns the repository.
Reimplemented in ForeignAPIFile, ForeignDBFile, and LocalFile.
Definition at line 2055 of file File.php.
Referenced by MediaWiki\FileRepo\ThumbnailEntryPoint\generateThumbnail(), and ImagePage\imageDupes().
File::getRepoName | ( | ) |
File::getSha1 | ( | ) |
Get the SHA-1 base 36 hash of the file.
Reimplemented in ForeignAPIFile, LocalFile, and UploadStashFile.
Definition at line 2336 of file File.php.
Referenced by FormatMetadata\fetchExtendedMetadata(), MediaWiki\FileRepo\ThumbnailEntryPoint\generateThumbnail(), and DjVuHandler\getDimensionInfo().
File::getShortDesc | ( | ) |
File::getSize | ( | ) |
Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB.
Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.
File::getStorageKey | ( | ) |
File::getThumbDisposition | ( | $thumbName, | |
$dispositionType = 'inline' ) |
File::getThumbnailBucket | ( | $desiredWidth, | |
$page = 1 ) |
Return the smallest bucket from $wgThumbnailBuckets which is at least $wgThumbnailMinimumBucketDistance larger than $desiredWidth.
The returned bucket, if any, will always be bigger than $desiredWidth.
int | $desiredWidth | |
int | $page |
Definition at line 549 of file File.php.
References getWidth().
|
protected |
Get all thumbnail names previously generated for this file STUB Overridden by LocalFile.
Reimplemented in ForeignAPIFile.
File::getThumbnailSource | ( | $params | ) |
Returns the most appropriate source image for the thumbnail, given a target thumbnail size.
array | $params |
Definition at line 1437 of file File.php.
References $params, and MediaWiki\PoolCounter\PoolCounterWork\execute().
File::getThumbPath | ( | $suffix = false | ) |
Get the path of the thumbnail directory, or a particular file if $suffix is specified.
string | false | $suffix | If not false, the name of a thumbnail file |
Reimplemented in ForeignAPIFile, and UploadStashFile.
File::getThumbRel | ( | $suffix = false | ) |
Get the path, relative to the thumbnail zone root, of the thumbnail directory or a particular file if $suffix is specified.
string | false | $suffix | If not false, the name of a thumbnail file |
Definition at line 1744 of file File.php.
References $path.
File::getThumbUrl | ( | $suffix = false | ) |
Get the URL of the thumbnail directory, or a particular file if $suffix is specified.
string | false | $suffix | If not false, the name of a thumbnail file |
Reimplemented in UploadStashFile.
Definition at line 1897 of file File.php.
Referenced by ThumbnailRenderJob\hitThumbUrl().
File::getThumbVirtualUrl | ( | $suffix = false | ) |
File::getTimestamp | ( | ) |
Get the 14-character timestamp of the file upload.
Reimplemented in ForeignAPIFile, and LocalFile.
Definition at line 2312 of file File.php.
Referenced by LocalRepo\findFiles(), FormatMetadata\getExtendedMetadataFromFile(), and getTimestamp().
File::getTitle | ( | ) |
Return the associated title object.
Definition at line 374 of file File.php.
Referenced by LocalRepo\findFiles(), FormatMetadata\getExtendedMetadataFromFile(), ImagePage\imageDupes(), and PurgeChangedFiles\purgeFromArchiveTable().
File::getTranscodedPath | ( | $suffix = false | ) |
File::getTranscodedUrl | ( | $suffix = false | ) |
File::getUnscaledThumb | ( | $handlerParams = [] | ) |
Get a ThumbnailImage which is the same size as the source.
array | $handlerParams |
File::getUploader | ( | int | $audience = self::FOR_PUBLIC, |
Authority | $performer = null ) |
Get the identity of the file uploader.
int | $audience | One of: File::FOR_PUBLIC to be displayed to all users File::FOR_THIS_USER to be displayed to the given user File::RAW get the description regardless of permissions |
Authority | null | $performer | to check for, only if FOR_THIS_USER is passed to the $audience parameter |
Reimplemented in ForeignAPIFile, and LocalFile.
File::getUrl | ( | ) |
Return the URL of the file.
Reimplemented in ForeignAPIFile, and UploadStashFile.
Definition at line 397 of file File.php.
References $url, assertRepoDefined(), getExtension(), and getUrlRel().
Referenced by RevDelFileItem\getApiData(), getCanonicalUrl(), getFullUrl(), and getViewURL().
File::getUrlRel | ( | ) |
Get urlencoded path of the file relative to the public zone root.
This function is overridden in OldLocalFile to be like getArchiveUrl().
Reimplemented in OldLocalFile.
Definition at line 1760 of file File.php.
Referenced by getUrl().
File::getViewURL | ( | ) |
Definition at line 443 of file File.php.
References canRender(), createThumb(), getMimeType(), getName(), getUrl(), getWidth(), mustRender(), and wfDebug().
File::getVirtualUrl | ( | $suffix = false | ) |
Get the public zone virtual URL for a current version source file.
string | false | $suffix | If not false, the name of a thumbnail file |
Definition at line 1934 of file File.php.
References $path.
Referenced by LocalFile\isMissing(), and LocalFile\loadFromFile().
File::getVisibility | ( | ) |
Return the deletion bitfield STUB.
Reimplemented in OldLocalFile.
File::getWidth | ( | $page = 1 | ) |
Return the width of the image.
Returns false if the width is unknown or undefined.
STUB Overridden by LocalFile, UnregisteredLocalFile
int | $page |
Reimplemented in ForeignAPIFile, LocalFile, and UnregisteredLocalFile.
Definition at line 521 of file File.php.
Referenced by getDisplayWidthHeight(), getThumbnailBucket(), and getViewURL().
File::iconThumb | ( | ) |
Get a ThumbnailImage representing a file type icon.
File::isCacheable | ( | ) |
File::isDeleted | ( | $field | ) |
Is this file a "deleted" file in a private archive? STUB.
int | $field | One of DELETED_* bitfield constants |
Reimplemented in OldLocalFile.
Definition at line 2078 of file File.php.
Referenced by FormatMetadata\fetchExtendedMetadata(), and LocalRepo\findFiles().
File::isExpensiveToThumbnail | ( | ) |
True if creating thumbnails from the file is large or otherwise resource-intensive.
Definition at line 2490 of file File.php.
References MediaHandler\isExpensiveToThumbnail().
Referenced by MediaWiki\FileRepo\ThumbnailEntryPoint\generateThumbnail().
File::isLocal | ( | ) |
Returns true if the file comes from the local file repository.
Definition at line 2036 of file File.php.
Referenced by MediaWiki\Api\ApiDelete\canDeleteFile(), and ImagePage\imageDupes().
File::isMissing | ( | ) |
File::isMultipage | ( | ) |
Returns 'true' if this file is a type which supports multiple pages, e.g.
DJVU or PDF. Note that this may be true even if the file in question only has a single page.
Definition at line 2168 of file File.php.
Referenced by LocalFile\getHeight(), and LocalFile\getWidth().
File::isOld | ( | ) |
Returns true if the image is an old version STUB.
Reimplemented in OldLocalFile.
Definition at line 2066 of file File.php.
Referenced by LocalRepo\findFiles().
File::isSafeFile | ( | ) |
Determines if this media file is in a format that is unlikely to contain viruses or malicious content.
It uses the global $wgTrustedMediaFormats list to determine if the file is safe.
This is used to show a warning on the description page of non-safe files. It may also be used to disallow direct [[media:...]] links to such files.
Note that this function will always return true if allowInlineDisplay() or isTrustedFile() is true for this file.
File::isTransformedLocally | ( | ) |
Whether the thumbnails created on the same server as this code is running.
Reimplemented in ForeignAPIFile.
|
protected |
Returns true if the file is flagged as trusted.
Files flagged that way can be linked to directly, even if that is not allowed for this type of file normally.
This is a dummy function right now and always returns false. It could be implemented to extract a flag from the database. The trusted flag could be set on upload, if the user has sufficient privileges, to bypass script- and html-filters. It may even be coupled with cryptographic signatures or such.
File::isVectorized | ( | ) |
Return true if the file is vectorized.
Definition at line 645 of file File.php.
References getHandler(), and MediaHandler\isVectorized().
File::isVisible | ( | ) |
Returns true if file exists in the repository and can be included in a page.
It would be unsafe to include private images, making public thumbnails inadvertently
Reimplemented in OldLocalFile.
File::load | ( | $flags = 0 | ) |
|
protected |
File::move | ( | $target | ) |
Move file to the new title.
Move current, old version and all thumbnails to the new filename. Old file is deleted.
Cache purging is done; checks for validity and logging are caller's responsibility
Title | $target | New file name |
Reimplemented in ForeignDBFile, and LocalFile.
File::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.
This returns true for everything but the bitmap types supported by all browsers, i.e. JPEG; GIF and PNG. It will also return true for any non-image formats.
Definition at line 901 of file File.php.
Referenced by getViewURL().
File::nextHistoryLine | ( | ) |
|
static |
Normalize a file extension to the common form, making it lowercase and checking some synonyms, and ensure it's clean.
Extensions with non-alphanumeric characters will be discarded. Keep in sync with mw.Title.normalizeExtension() in JS.
string | $extension | File extension (without the leading dot) |
|
static |
Given a string or Title object return either a valid Title object with namespace NS_FILE or null.
PageIdentity | LinkTarget | string | $title | |
string | false | $exception | Use 'exception' to throw an error on bad titles |
Definition at line 217 of file File.php.
References $title, NS_FILE, and NS_MEDIA.
Referenced by UnregisteredLocalFile\__construct().
File::pageCount | ( | ) |
Returns the number of pages of a multipage document, or false for documents which aren't multipage documents.
Definition at line 2179 of file File.php.
Referenced by MediaHandler\getEntireText().
File::publish | ( | $src, | |
$flags = 0, | |||
array | $options = [] ) |
Move or copy a file to its public location.
If a file exists at the destination, move it to an archive. Returns a Status object with the archive name in the "value" member on success.
The archive name should be passed through to recordUpload3 for database registration.
Options to $options include:
string | FSFile | $src | Local filesystem path to the source image |
int | $flags | A bitwise combination of: File::DELETE_SOURCE Delete the source file, i.e. move rather than copy |
array | $options | Optional additional parameters |
STUB Overridden by LocalFile
Reimplemented in LocalFile, and ForeignDBFile.
File::purgeCache | ( | $options = [] | ) |
Purge shared caches such as thumbnails and DB data caching STUB Overridden by LocalFile.
array | $options | Options, which include: 'forThumbRefresh' : The purging is only to refresh thumbnails |
Reimplemented in ForeignAPIFile, and LocalFile.
File::purgeDescription | ( | ) |
Purge the file description page, but don't go after pages using the file.
Use when modifying file history but not the current data.
Definition at line 1621 of file File.php.
References getTitle().
File::purgeEverything | ( | ) |
Purge metadata and all affected pages when the file is created, deleted, or majorly updated.
Definition at line 1634 of file File.php.
References $job, and getTitle().
|
protected |
Definition at line 1992 of file File.php.
Referenced by ForeignDBFile\deleteFile(), ForeignDBFile\move(), ForeignDBFile\publish(), and ForeignDBFile\restore().
File::redirectedFrom | ( | string | $from | ) |
string | $from | The name that was used to access the file, before resolving redirects. |
Definition at line 2447 of file File.php.
Referenced by LocalRepo\findFiles().
File::resetHistory | ( | ) |
File::restore | ( | $versions = [], | |
$unsuppress = false ) |
Restore all or specified deleted revisions to the given file.
Permissions and logging are left to the caller.
May throw database exceptions on error.
int[] | $versions | Set of record ids of deleted items to restore, or empty to restore all revisions. |
bool | $unsuppress | Remove restrictions on content upon restoration? |
Reimplemented in ForeignDBFile, and LocalFile.
|
static |
File::setHandlerState | ( | string | $key, |
$value ) |
|
static |
File::thumbName | ( | $params, | |
$flags = 0 ) |
Return the file name of a thumbnail with the specified parameters.
Use File::THUMB_FULL_NAME to always get a name like "<params>-<source>". Otherwise, the format may be "<params>-<source>" or "<params>-thumbnail.<ext>".
array | $params | Handler-specific parameters |
int | $flags | Bitfield that supports THUMB_* constants |
Reimplemented in UploadStashFile.
Definition at line 1083 of file File.php.
References $params.
Referenced by ThumbnailRenderJob\hitThumbUrl().
File::transform | ( | $params, | |
$flags = 0 ) |
Transform a media file.
array | $params | An associative array of handler-specific parameters. Typical keys are width, height and page. |
int | $flags | A bitfield, may contain self::RENDER_NOW to force rendering |
Reimplemented in ForeignAPIFile.
Definition at line 1182 of file File.php.
References $params, MediaHandler\getScriptedTransform(), MediaHandler\getTransform(), MediaHandler\normaliseParams(), PROTO_CANONICAL, wfDebug(), and wfMessage().
Referenced by MediaWiki\FileRepo\ThumbnailEntryPoint\generateThumbnail().
|
protected |
Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors)
string | $thumbPath | Thumbnail storage path |
string | $thumbUrl | Thumbnail URL |
array | $params | |
int | $flags |
Definition at line 1160 of file File.php.
References $params, MediaHandler\getTransform(), and wfMessage().
File::upgradeRow | ( | ) |
Upgrade the database row if there is one Called by ImagePage STUB.
Reimplemented in LocalFile, and OldLocalFile.
File::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.
STUB
int | $field | |
Authority | $performer | user object to check |
Reimplemented in OldLocalFile.
Definition at line 2367 of file File.php.
Referenced by LocalRepo\findFiles().
File::wasDeleted | ( | ) |
Was this file ever deleted from the wiki?
Definition at line 2097 of file File.php.
References getTitle().
|
protected |
|
protected |
Definition at line 144 of file File.php.
Referenced by LocalFile\getHeight(), LocalFile\getWidth(), and LocalFile\maybeUpgradeRow().
|
protected |
|
protected |
|
protected |
The name of a file from its title object.
Definition at line 153 of file File.php.
Referenced by __get(), and LocalFile\unprefixRow().
|
protected |
|
protected |
|
protected |
FileRepo LocalRepo ForeignAPIRepo false File::$repo |
Some member variables can be lazy-initialised using __get().
The initialisation function for these variables is always a function named like getVar(), where Var is the variable name with upper-case first letter.
The following variables are initialised in this way in this base class: name, extension, handler, path, canRender, isSafeFile, transformScript, hashPath, pageCount, url
Code within this class should generally use the accessor function directly, since __get() isn't re-entrant and therefore causes bugs that depend on initialisation order. The following member variables are not lazy-initialised
Definition at line 123 of file File.php.
Referenced by UploadStashFile\__construct(), __construct(), LocalFile\__construct(), ForeignAPIFile\__construct(), OldLocalFile\__construct(), UnregisteredLocalFile\__construct(), ForeignAPIFile\getRepo(), ForeignDBFile\getRepo(), OldLocalFile\newFromArchiveName(), LocalFile\newFromKey(), OldLocalFile\newFromKey(), LocalFile\newFromRow(), OldLocalFile\newFromRow(), UnregisteredLocalFile\newFromTitle(), OldLocalFile\newFromTitle(), LocalFile\newFromTitle(), and ForeignAPIFile\newFromTitle().
|
protected |
|
protected |
Definition at line 126 of file File.php.
Referenced by __construct(), LocalFile\__construct(), ForeignAPIFile\__construct(), OldLocalFile\__construct(), OldLocalFile\newFromArchiveName(), LocalFile\newFromRow(), OldLocalFile\newFromRow(), OldLocalFile\newFromTitle(), LocalFile\newFromTitle(), ForeignAPIFile\newFromTitle(), and normalizeTitle().
|
protected |
|
protected |
|
protected |
The URL corresponding to one of the four basic zones.
Definition at line 147 of file File.php.
Referenced by ForeignDBFile\getDescriptionShortUrl().
const File::DELETE_SOURCE = 1 |
Definition at line 93 of file File.php.
Referenced by LocalFile\publishTo().
const File::DELETED_FILE = 1 |
Definition at line 80 of file File.php.
Referenced by OldLocalFile\isVisible().
const File::RENDER_FORCE = 2 |
const File::RENDER_NOW = 1 |