MediaWiki REL1_37
|
Class to represent a file in the oldimage table. More...
Public Member Functions | |
__construct ( $title, $repo, $time, $archiveName) | |
exists () | |
If archive name is an empty string, then file does not "exist". | |
getArchiveName () | |
getRel () | |
getUrlRel () | |
getVisibility () | |
Returns bitfield value. | |
isDeleted ( $field) | |
isOld () | |
isVisible () | |
loadFromRow ( $row, $prefix='img_') | |
Load file metadata from a DB result row. | |
upgradeRow () | |
uploadOld ( $srcPath, $timestamp, $comment, UserIdentity $user) | |
Upload a file directly into archive. | |
userCan ( $field, Authority $performer) | |
Determine if the current user is allowed to view a particular field of this image file, if it's marked as deleted. | |
Public Member Functions inherited from LocalFile | |
__construct ( $title, $repo) | |
Do not call this except from inside a repo class. | |
__destruct () | |
Clean up any dangling locks. | |
acquireFileLock () | |
deleteFile ( $reason, UserIdentity $user, $suppress=false) | |
Delete all versions of the file. | |
deleteOldFile ( $archiveName, $reason, UserIdentity $user, $suppress=false) | |
Delete an old version of the file. | |
getBitDepth () | |
getDescription ( $audience=self::FOR_PUBLIC, Authority $performer=null) | |
getDescriptionShortUrl () | |
Get short description URL for a file based on the page ID. | |
getDescriptionText (Language $lang=null) | |
Get the HTML text of the description page This is not used by ImagePage for local files, since (among other things) it skips the parser cache. | |
getDescriptionTouched () | |
getDescriptionUrl () | |
isMultipage inherited | |
getHeight ( $page=1) | |
Return the height of the image. | |
getHistory ( $limit=null, $start=null, $end=null, $inc=true) | |
purgeDescription inherited | |
getMediaType () | |
Returns the type of the media in the file. | |
getMetadata () | |
Get handler-specific metadata as a serialized string. | |
getMetadataArray () | |
Get unserialized handler-specific metadata. | |
getMetadataForDb (IDatabase $db) | |
Serialize the metadata array for insertion into img_metadata, oi_metadata or fa_metadata. | |
getMetadataItems (array $itemNames) | |
Get multiple elements of the unserialized handler-specific metadata. | |
getMimeType () | |
Returns the MIME type of the file. | |
getMutableCacheKeys (WANObjectCache $cache) | |
getRepo () | |
getSha1 () | |
getSize () | |
Returns the size of the image file, in bytes. | |
getTimestamp () | |
getUpgraded () | |
getUploader (int $audience=self::FOR_PUBLIC, Authority $performer=null) | |
getWidth ( $page=1) | |
Return the width of the image. | |
invalidateCache () | |
Purge the file object/metadata cache. | |
isCacheable () | |
isMissing () | |
splitMime inherited | |
load ( $flags=0) | |
Load file metadata from cache or DB, unless already loaded. | |
loadFromFile ( $path=null) | |
Load metadata from the file itself. | |
lock () | |
Start an atomic DB section and lock the image for update or increments a reference counter if the lock is already held. | |
maybeUpgradeRow () | |
Upgrade a row if it needs it. | |
move ( $target) | |
getLinksTo inherited | |
nextHistoryLine () | |
Returns the history of this file, line by line. | |
prerenderThumbnails () | |
Prerenders a configurable set of thumbnails. | |
publish ( $src, $flags=0, array $options=[]) | |
Move or copy a file to its public location. | |
purgeCache ( $options=[]) | |
Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN. | |
purgeOldThumbnails ( $archiveName) | |
Delete cached transformed files for an archived version only. | |
purgeThumbnails ( $options=[]) | |
Delete cached transformed files for the current version only. | |
recordUpload3 (string $oldver, string $comment, string $pageText, Authority $performer, $props=false, $timestamp=false, $tags=[], bool $createNullRevision=true, bool $revert=false) | |
Record a file upload in the upload log and the image table (version 3) | |
releaseFileLock () | |
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. | |
unlock () | |
Decrement the lock reference count and end the atomic section if it reaches zero. | |
upload ( $src, $comment, $pageText, $flags=0, $props=false, $timestamp=false, Authority $uploader=null, $tags=[], $createNullRevision=true, $revert=false) | |
getHashPath inherited | |
Public Member Functions inherited from File | |
__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. | |
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 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. | |
getDimensionsString () | |
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 () | |
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. | |
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 language code from the available languages for this file that matches the language requested by the user. | |
getMetadataItem (string $itemName) | |
Get a specific element 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 () | |
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. | |
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. | |
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. | |
getUrl () | |
Return the URL of the file. | |
getUser ( $type='text') | |
Returns ID or name of user who uploaded the file STUB. | |
getViewURL () | |
getVirtualUrl ( $suffix=false) | |
Get the public zone virtual URL for a current version source file. | |
iconThumb () | |
Get a ThumbnailImage representing a file type icon. | |
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. | |
isMultipage () | |
Returns 'true' if this file is a type which supports multiple pages, e.g. | |
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. | |
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. | |
pageCount () | |
Returns the number of pages of a multipage document, or false for documents which aren't multipage documents. | |
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 ( $from) | |
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. | |
wasDeleted () | |
Was this file ever deleted from the wiki? | |
Static Public Member Functions | |
static | getQueryInfo (array $options=[]) |
Return the tables, fields, and join conditions to be selected to create a new oldlocalfile object. | |
static | newFromArchiveName ( $title, $repo, $archiveName) |
static | newFromKey ( $sha1, $repo, $timestamp=false) |
Create a OldLocalFile from a SHA-1 key Do not call this except from inside a repo class. | |
static | newFromRow ( $row, $repo) |
static | newFromTitle ( $title, $repo, $time=null) |
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 ( $mime) |
Split an internet media type into its two components; if not a two-part name, set the minor type to 'unknown'. | |
Public Attributes | |
const | CACHE_VERSION = 1 |
Public Attributes inherited from File | |
FileRepo LocalRepo ForeignAPIRepo bool | $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 |
Public Attributes inherited from IDBAccessObject | |
const | READ_NONE = -1 |
Constants for object loading bitfield flags (higher => higher QoS) | |
Protected Member Functions | ||||
getCacheFields ( $prefix='img_') | ||||
Returns the list of object properties that are included as-is in the cache.
| ||||
getCacheKey () | ||||
loadExtraFromDB () | ||||
Load lazy file metadata from the DB. | ||||
loadFromDB ( $flags=0) | ||||
recordOldUpload ( $srcPath, $archiveName, $timestamp, $comment, $user) | ||||
Record a file upload in the oldimage table, without adding log entries. | ||||
reserializeMetadata () | ||||
Write the metadata back to the database with the current serialization format. | ||||
Protected Member Functions inherited from LocalFile | ||||
getLazyCacheFields ( $prefix='img_') | ||||
Returns the list of object properties that are included as-is in the cache, only when they're not too big, and are lazily loaded by self::loadExtraFromDB(). | ||||
getThumbnails ( $archiveName=false) | ||||
getTransformScript inherited | ||||
loadMetadataFromDbFieldValue (IDatabase $db, $metadataBlob) | ||||
Unserialize a metadata blob which came from the database and store it in $this. | ||||
loadMetadataFromString ( $metadataString) | ||||
Unserialize a metadata string which came from some non-DB source, or is the return value of IDatabase::decodeBlob(). | ||||
publishTo ( $src, $dstRel, $flags=0, array $options=[]) | ||||
Move or copy a file to a specified location. | ||||
purgeThumbList ( $dir, $files) | ||||
Delete a list of thumbnails visible at urls. | ||||
readOnlyFatalStatus () | ||||
setProps ( $info) | ||||
Set properties in this object to be equal to those given in the associative array $info. | ||||
unprefixRow ( $row, $prefix='img_') | ||||
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() | ||||
getImageSize ( $filePath) | ||||
Get an image size array like that returned by getImageSize(), or false if it can't be determined. | ||||
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. | ||||
migrateThumbFile ( $thumbName) | ||||
Hook into transform() to allow migration of thumbnail files STUB. | ||||
readOnlyError () | ||||
transformErrorOutput ( $thumbPath, $thumbUrl, $params, $flags) | ||||
Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors) | ||||
Protected Attributes | |
string | $archive_name |
Archive name. | |
string int | $requestedTime |
Timestamp. | |
Protected Attributes inherited from LocalFile | |
int | $bits |
Returned by getimagesize (loadFromXxx) | |
bool | $dataLoaded |
Whether or not core data has been loaded from the database (loadFromXxx) | |
int | $deleted |
Bitfield akin to rev_deleted. | |
bool | $extraDataLoaded |
Whether or not lazy-loaded data has been loaded from the database. | |
bool | $fileExists |
Does the file exist on disk? (loadFromXxx) | |
int | $height |
Image height. | |
string | $media_type |
MEDIATYPE_xxx (bitmap, drawing, audio...) | |
array | $metadataArray = [] |
Unserialized metadata. | |
string[] | $metadataBlobs = [] |
Map of metadata item name to blob address. | |
string null | $metadataSerializationFormat |
One of the MDS_* constants, giving the format of the metadata as stored in the DB, or null if the data was not loaded from the DB. | |
string | $mime |
MIME type, determined by MimeAnalyzer::guessMimeType. | |
string | $repoClass = LocalRepo::class |
string | $sha1 |
SHA-1 base 36 content hash. | |
int | $size |
Size in bytes (loadFromXxx) | |
string[] | $unloadedMetadataBlobs = [] |
Map of metadata item name to blob address for items that exist but have not yet been loaded into $this->metadataArray. | |
int | $width |
Image width. | |
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 bool | $fsFile |
False if undefined. | |
MediaHandler | $handler |
string | $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 | $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 |
Main part of the title, with underscores (Title::getDBkey) | |
Title | $redirectedTitle |
Title | $redirectTitle |
string | $repoClass = FileRepo::class |
Required Repository class type. | |
Title string bool | $title |
array | $tmpBucketedThumbCache = [] |
Cache of tmp filepaths pointing to generated bucket thumbnails, keyed by width. | |
string | $transformScript |
URL of transformscript (for example thumb.php) | |
string | $url |
The URL corresponding to one of the four basic zones. | |
Class to represent a file in the oldimage table.
Definition at line 35 of file OldLocalFile.php.
OldLocalFile::__construct | ( | $title, | |
$repo, | |||
$time, | |||
$archiveName | |||
) |
Title | $title | |
FileRepo | $repo | |
string | int | null | $time | Timestamp or null to load by archive name |
string | null | $archiveName | Archive name or null to load by timestamp |
MWException |
Definition at line 187 of file OldLocalFile.php.
References File\$repo, and File\$title.
OldLocalFile::exists | ( | ) |
If archive name is an empty string, then file does not "exist".
This is the case for a couple files on Wikimedia servers where the old version is "lost".
Reimplemented from LocalFile.
Definition at line 506 of file OldLocalFile.php.
OldLocalFile::getArchiveName | ( | ) |
Definition at line 217 of file OldLocalFile.php.
Referenced by RevDelFileItem\getApiData().
|
protected |
Returns the list of object properties that are included as-is in the cache.
string | $prefix | Must be the empty string |
Reimplemented from LocalFile.
Definition at line 321 of file OldLocalFile.php.
|
protected |
Reimplemented from LocalFile.
Definition at line 209 of file OldLocalFile.php.
|
static |
Return the tables, fields, and join conditions to be selected to create a new oldlocalfile object.
Since 1.34, oi_user and oi_user_text have not been present in the database, but they continue to be available in query results as aliases.
string[] | $options |
|
$table
to IDatabase->select()
$vars
to IDatabase->select()
$join_conds
to IDatabase->select()
Reimplemented from LocalFile.
Definition at line 137 of file OldLocalFile.php.
Referenced by ImageBuilder\buildOldImage(), LocalFileDeleteBatch\doDBInserts(), RevDelFileList\doQuery(), LocalRepo\findFiles(), LocalFile\getHistory(), LocalFile\loadExtraFieldsWithTimestamp(), and LocalFile\nextHistoryLine().
OldLocalFile::getRel | ( | ) |
Reimplemented from File.
Definition at line 333 of file OldLocalFile.php.
OldLocalFile::getUrlRel | ( | ) |
Reimplemented from File.
Definition at line 341 of file OldLocalFile.php.
OldLocalFile::getVisibility | ( | ) |
Returns bitfield value.
Reimplemented from File.
Definition at line 401 of file OldLocalFile.php.
OldLocalFile::isDeleted | ( | $field | ) |
int | $field | One of DELETED_* bitfield constants for file or revision rows |
Reimplemented from File.
Definition at line 391 of file OldLocalFile.php.
Referenced by RevDelArchivedFileItem\getApiData(), and RevDelFileItem\getApiData().
OldLocalFile::isOld | ( | ) |
OldLocalFile::isVisible | ( | ) |
Reimplemented from File.
Definition at line 235 of file OldLocalFile.php.
References File\DELETED_FILE.
|
protected |
Load lazy file metadata from the DB.
Reimplemented from LocalFile.
Definition at line 276 of file OldLocalFile.php.
References $dbr.
|
protected |
int | $flags |
Reimplemented from LocalFile.
Definition at line 243 of file OldLocalFile.php.
References $dbr.
OldLocalFile::loadFromRow | ( | $row, | |
$prefix = 'img_' |
|||
) |
Load file metadata from a DB result row.
Passing arbitrary fields in the row and expecting them to be translated to property names on $this is deprecated since 1.37. Instead, override loadFromRow(), and clone and unset the extra fields before passing them to the parent.
After the deprecation period has passed, extra fields will be ignored, and the deprecation warning will be removed.
stdClass | $row | |
string | $prefix |
Reimplemented from LocalFile.
Definition at line 196 of file OldLocalFile.php.
|
static |
Definition at line 69 of file OldLocalFile.php.
References File\$repo, and File\$title.
Referenced by ImportableUploadRevisionImporter\import(), LocalRepo\newFromArchiveName(), and RevertAction\onSubmit().
|
static |
Create a OldLocalFile from a SHA-1 key Do not call this except from inside a repo class.
string | $sha1 | Base-36 SHA-1 |
LocalRepo | $repo | |
string | bool | $timestamp | MW_timestamp (optional) |
Reimplemented from LocalFile.
Definition at line 100 of file OldLocalFile.php.
References $dbr, File\$repo, LocalFile\$sha1, and LocalFile\$timestamp.
|
static |
stdClass | $row | |
FileRepo | $repo |
Reimplemented from LocalFile.
Definition at line 80 of file OldLocalFile.php.
References $file, File\$repo, File\$title, and NS_FILE.
|
static |
MWException |
Reimplemented from LocalFile.
Definition at line 52 of file OldLocalFile.php.
References File\$repo, and File\$title.
|
protected |
Record a file upload in the oldimage table, without adding log entries.
string | $srcPath | File system path to the source file |
string | $archiveName | The archive name of the file |
string | $timestamp | |
string | $comment | Upload comment |
UserIdentity | $user | User who did this upload |
Definition at line 463 of file OldLocalFile.php.
|
protected |
Write the metadata back to the database with the current serialization format.
Reimplemented from LocalFile.
Definition at line 380 of file OldLocalFile.php.
OldLocalFile::upgradeRow | ( | ) |
Reimplemented from LocalFile.
Definition at line 348 of file OldLocalFile.php.
References wfDebug().
OldLocalFile::uploadOld | ( | $srcPath, | |
$timestamp, | |||
$comment, | |||
UserIdentity | $user | ||
) |
Upload a file directly into archive.
Generally for Special:Import.
string | $srcPath | File system path of the source file |
string | $timestamp | |
string | $comment | |
UserIdentity | $user |
Definition at line 434 of file OldLocalFile.php.
OldLocalFile::userCan | ( | $field, | |
Authority | $performer | ||
) |
Determine if the current user is allowed to view a particular field of this image file, if it's marked as deleted.
int | $field | |
Authority | $performer | User object to check |
Reimplemented from File.
Definition at line 415 of file OldLocalFile.php.
|
protected |
Archive name.
Definition at line 40 of file OldLocalFile.php.
|
protected |
Timestamp.
Definition at line 37 of file OldLocalFile.php.
const OldLocalFile::CACHE_VERSION = 1 |
Definition at line 42 of file OldLocalFile.php.