MediaWiki
1.23.2
|
Class to represent a local file in the wiki's own database. More...
Public Member Functions | |
__construct ( $title, $repo) | |
Constructor. More... | |
__destruct () | |
Clean up any dangling locks. More... | |
decodeRow ( $row, $prefix='img_') | |
Decode a row from the database (either object or array) to an array with timestamps and MIME types decoded, and the field prefix removed. More... | |
delete ( $reason, $suppress=false) | |
Delete all versions of the file. More... | |
deleteOld ( $archiveName, $reason, $suppress=false) | |
Delete an old version of the file. More... | |
exists () | |
canRender inherited More... | |
getBitDepth () | |
getCacheFields ( $prefix='img_') | |
getCacheKey () | |
Get the memcached key for the main data for this file, or false if there is no access to the shared cache. More... | |
getDescription ( $audience=self::FOR_PUBLIC, User $user=null) | |
getDescriptionText ( $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. More... | |
getDescriptionUrl () | |
isMultipage inherited More... | |
getHeight ( $page=1) | |
Return the height of the image. More... | |
getHistory ( $limit=null, $start=null, $end=null, $inc=true) | |
purgeDescription inherited More... | |
getLazyCacheFields ( $prefix='img_') | |
getMediaType () | |
Returns the type of the media in the file. More... | |
getMetadata () | |
Get handler-specific metadata. More... | |
getMimeType () | |
Returns the mime type of the file. More... | |
getSha1 () | |
getSize () | |
Returns the size of the image file, in bytes. More... | |
getThumbnails ( $archiveName=false) | |
getHandler inherited More... | |
getTimestamp () | |
getUpgraded () | |
getUser ( $type='text') | |
Returns ID or name of user who uploaded the file. More... | |
getWidth ( $page=1) | |
Return the width of the image. More... | |
isCacheable () | |
isMissing () | |
splitMime inherited More... | |
load ( $flags=0) | |
Load file metadata from cache or DB, unless already loaded. More... | |
loadFromCache () | |
Try to load file metadata from memcached. More... | |
loadFromDB () | |
Load file metadata from the DB. More... | |
loadFromFile () | |
Load metadata from the file itself. More... | |
loadFromRow ( $row, $prefix='img_') | |
Load file metadata from a DB result row. More... | |
lock () | |
Start a transaction and lock the image for update Increments a reference counter if the lock is already held. More... | |
maybeUpgradeRow () | |
Upgrade a row if it needs it. More... | |
migrateThumbFile ( $thumbName) | |
getTransformScript inherited More... | |
move ( $target) | |
getLinksTo inherited More... | |
nextHistoryLine () | |
Returns the history of this file, line by line. More... | |
publish ( $srcPath, $flags=0, array $options=array()) | |
Move or copy a file to its public location. More... | |
publishTo ( $srcPath, $dstRel, $flags=0, array $options=array()) | |
Move or copy a file to a specified location. More... | |
purgeCache ( $options=array()) | |
Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid. More... | |
purgeHistory () | |
Purge the shared history (OldLocalFile) cache. More... | |
purgeMetadataCache () | |
Refresh metadata in memcached, but don't touch thumbnails or squid. More... | |
purgeOldThumbnails ( $archiveName) | |
Delete cached transformed files for an archived version only. More... | |
purgeThumbnails ( $options=array()) | |
Delete cached transformed files for the current version only. More... | |
recordUpload ( $oldver, $desc, $license='', $copyStatus='', $source='', $watch=false, $timestamp=false, User $user=null) | |
Record a file upload in the upload log and the image table. More... | |
recordUpload2 ( $oldver, $comment, $pageText, $props=false, $timestamp=false, $user=null) | |
Record a file upload in the upload log and the image table. More... | |
resetHistory () | |
Reset the history pointer to the first element of the history. More... | |
restore ( $versions=array(), $unsuppress=false) | |
Restore all or specified deleted revisions to the given file. More... | |
saveToCache () | |
Save the file metadata to memcached. More... | |
setProps ( $info) | |
Set properties in this object to be equal to those given in the associative array $info. More... | |
unlock () | |
Decrement the lock reference count. More... | |
unlockAndRollback () | |
Roll back the DB transaction and mark the image unlocked. More... | |
upgradeRow () | |
Fix assorted version-related problems with the image row by reloading it from the file. More... | |
upload ( $srcPath, $comment, $pageText, $flags=0, $props=false, $timestamp=false, $user=null) | |
getHashPath inherited More... | |
Public Member Functions inherited from File | |
__get ( $name) | |
allowInlineDisplay () | |
Alias for canRender() More... | |
canAnimateThumbIfAppropriate () | |
Will the thumbnail be animated if one would expect it to be. More... | |
canRender () | |
Checks if the output of transform() for this file is likely to be valid. More... | |
convertMetadataVersion ( $metadata, $version) | |
get versioned metadata More... | |
createThumb ( $width, $height=-1) | |
Create a thumbnail of the image having the specified width/height. More... | |
formatMetadata () | |
generateThumbName ( $name, $params) | |
Generate a thumbnail file name from a name and specified parameters. More... | |
getArchivePath ( $suffix=false) | |
Get the path of the archived file. More... | |
getArchiveRel ( $suffix=false) | |
Get the path of an archived file relative to the public zone root. More... | |
getArchiveThumbPath ( $archiveName, $suffix=false) | |
Get the path of an archived file's thumbs, or a particular thumb if $suffix is specified. More... | |
getArchiveThumbRel ( $archiveName, $suffix=false) | |
Get the path, relative to the thumbnail zone root, for an archived file's thumbs directory or a specific thumb if the $suffix is given. More... | |
getArchiveThumbUrl ( $archiveName, $suffix=false) | |
Get the URL of the archived file's thumbs, or a particular thumb if $suffix is specified. More... | |
getArchiveUrl ( $suffix=false) | |
Get the URL of the archive directory, or a particular file if $suffix is specified. More... | |
getArchiveVirtualUrl ( $suffix=false) | |
Get the public zone virtual URL for an archived version source file. More... | |
getAvailableLanguages () | |
Gives a (possibly empty) list of languages to render the file in. More... | |
getCanonicalUrl () | |
getCommonMetaArray () | |
Like getMetadata but returns a handler independent array of common values. More... | |
getDefaultRenderLanguage () | |
In files that support multiple language, what is the default language to use if none specified. More... | |
getDimensionsString () | |
getExtension () | |
Get the file extension, e.g. More... | |
getFullUrl () | |
Return a fully-qualified URL to the file. More... | |
getHandler () | |
Get a MediaHandler instance for this file. More... | |
getHashPath () | |
Get the filename hash component of the directory including trailing slash, e.g. More... | |
getImageSize ( $fileName) | |
Get an image size array like that returned by getImageSize(), or false if it can't be determined. More... | |
getLastError () | |
Get last thumbnailing error. More... | |
getLength () | |
Get the duration of a media file in seconds. More... | |
getLocalRefPath () | |
Get an FS copy or original of this file and return the path. More... | |
getLongDesc () | |
getName () | |
Return the name of this file. More... | |
getOriginalTitle () | |
Return the title used to find this file. More... | |
getPath () | |
Return the storage path to the file. More... | |
getRedirected () | |
getRedirectedTitle () | |
getRel () | |
Get the path of the file relative to the public zone root. More... | |
getRepo () | |
Returns the repository. More... | |
getRepoName () | |
Returns the name of the repository. More... | |
getShortDesc () | |
getStorageKey () | |
Get the deletion archive key, "<sha1>.<ext>". More... | |
getStreamHeaders () | |
getThumbDisposition ( $thumbName, $dispositionType='inline') | |
getThumbnails () | |
Get all thumbnail names previously generated for this file STUB Overridden by LocalFile. More... | |
getThumbPath ( $suffix=false) | |
Get the path of the thumbnail directory, or a particular file if $suffix is specified. More... | |
getThumbRel ( $suffix=false) | |
Get the path, relative to the thumbnail zone root, of the thumbnail directory or a particular file if $suffix is specified. More... | |
getThumbUrl ( $suffix=false) | |
Get the URL of the thumbnail directory, or a particular file if $suffix is specified. More... | |
getThumbVirtualUrl ( $suffix=false) | |
Get the virtual URL for a thumbnail file or directory. More... | |
getTitle () | |
Return the associated title object. More... | |
getTranscodedPath ( $suffix=false) | |
Get the path of the transcoded directory, or a particular file if $suffix is specified. More... | |
getTranscodedUrl ( $suffix=false) | |
Get the URL of the transcoded directory, or a particular file if $suffix is specified. More... | |
getTransformScript () | |
getUnscaledThumb ( $handlerParams=array()) | |
Get a ThumbnailImage which is the same size as the source. More... | |
getUrl () | |
Return the URL of the file. More... | |
getUrlRel () | |
Get urlencoded path of the file relative to the public zone root. More... | |
getViewURL () | |
getVirtualUrl ( $suffix=false) | |
Get the public zone virtual URL for a current version source file. More... | |
getVisibility () | |
Return the deletion bitfield STUB. More... | |
getZoneUrl ( $zone, $suffix=false) | |
Get the URL of the zone directory, or a particular file if $suffix is specified. More... | |
iconThumb () | |
Get a ThumbnailImage representing a file type icon. More... | |
isDeleted ( $field) | |
Is this file a "deleted" file in a private archive? STUB. More... | |
isHashed () | |
isLocal () | |
Returns true if the file comes from the local file repository. More... | |
isMultipage () | |
Returns 'true' if this file is a type which supports multiple pages, e.g. More... | |
isOld () | |
Returns true if the image is an old version STUB. More... | |
isSafeFile () | |
Determines if this media file is in a format that is unlikely to contain viruses or malicious content. More... | |
isTrustedFile () | |
Returns true if the file is flagged as trusted. More... | |
isVectorized () | |
Return true if the file is vectorized. More... | |
isVisible () | |
Returns true if file exists in the repository and can be included in a page. More... | |
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. More... | |
pageCount () | |
Returns the number of pages of a multipage document, or false for documents which aren't multipage documents. More... | |
purgeDescription () | |
Purge the file description page, but don't go after pages using the file. More... | |
purgeEverything () | |
Purge metadata and all affected pages when the file is created, deleted, or majorly updated. More... | |
readOnlyError () | |
redirectedFrom ( $from) | |
thumbName ( $params, $flags=0) | |
Return the file name of a thumbnail with the specified parameters. More... | |
transform ( $params, $flags=0) | |
Transform a media file. More... | |
userCan ( $field, User $user=null) | |
Determine if the current user is allowed to view a particular field of this file, if it's marked as deleted. More... | |
wasDeleted () | |
Was this file ever deleted from the wiki? More... | |
Static Public Member Functions | |
static | newFromKey ( $sha1, $repo, $timestamp=false) |
Create a LocalFile from a SHA-1 key Do not call this except from inside a repo class. More... | |
static | newFromRow ( $row, $repo) |
Create a LocalFile from a title Do not call this except from inside a repo class. More... | |
static | newFromTitle ( $title, $repo, $unused=null) |
Create a LocalFile from a title Do not call this except from inside a repo class. More... | |
static | selectFields () |
Fields in the image table. More... | |
Static Public Member Functions inherited from File | |
static | checkExtensionCompatibility (File $old, $new) |
Checks if file extensions are compatible. More... | |
static | compare (File $a, File $b) |
Callback for usort() to do file sorts by name. More... | |
static | getPropsFromPath ( $path, $ext=true) |
Get an associative array containing information about a file in the local filesystem. More... | |
static | normalizeExtension ( $ext) |
Normalize a file extension to the common form, and ensure it's clean. More... | |
static | normalizeTitle ( $title, $exception=false) |
Given a string or Title object return either a valid Title object with namespace NS_FILE or null. More... | |
static | scaleHeight ( $srcWidth, $srcHeight, $dstWidth) |
Calculate the height of a thumbnail using the source and destination width. More... | |
static | sha1Base36 ( $path) |
Get a SHA-1 hash of a file in the local filesystem, in base-36 lower case encoding, zero padded to 31 digits. More... | |
static | splitMime ( $mime) |
Split an internet media type into its two components; if not a two-part name, set the minor type to 'unknown'. More... | |
Public Attributes | |
const | CACHE_FIELD_MAX_LEN = 1000 |
const | LOAD_ALL = 1 |
Public Attributes inherited from File | |
FileRepo LocalRepo ForeignAPIRepo bool | $repo |
Some member variables can be lazy-initialised using __get(). More... | |
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. More... | |
const | RENDER_NOW = 1 |
Force rendering in the current process. More... | |
const | THUMB_FULL_NAME = 1 |
Protected Member Functions | |
loadExtraFromDB () | |
Load lazy file metadata from the DB. More... | |
purgeThumbList ( $dir, $files) | |
Delete a list of thumbnails visible at urls. More... | |
readOnlyFatalStatus () | |
unprefixRow ( $row, $prefix='img_') | |
Protected Member Functions inherited from File | |
assertRepoDefined () | |
Assert that $this->repo is set to a valid FileRepo instance. More... | |
assertTitleDefined () | |
Assert that $this->title is set to a Title. More... | |
getCanRender () | |
Accessor for __get() More... | |
getIsSafeFile () | |
Accessor for __get() More... | |
getIsSafeFileUncached () | |
Uncached accessor. More... | |
transformErrorOutput ( $thumbPath, $thumbUrl, $params, $flags) | |
Return either a MediaTransformError or placeholder thumbnail (if $wgIgnoreImageErrors) More... | |
Protected Attributes | |
int | $bits |
Returned by getimagesize (loadFromXxx) *. More... | |
bool | $dataLoaded |
Whether or not core data has been loaded from the database (loadFromXxx) *. More... | |
int | $deleted |
Bitfield akin to rev_deleted *. More... | |
bool | $extraDataLoaded |
Whether or not lazy-loaded data has been loaded from the database *. More... | |
bool | $fileExists |
Does the file exist on disk? (loadFromXxx) *. More... | |
int | $height |
image height * More... | |
string | $media_type |
MEDIATYPE_xxx (bitmap, drawing, audio...) *. More... | |
string | $metadata |
Handler-specific metadata *. More... | |
string | $mime |
MIME type, determined by MimeMagic::guessMimeType *. More... | |
string | $repoClass = 'LocalRepo' |
string | $sha1 |
SHA-1 base 36 content hash *. More... | |
int | $size |
Size in bytes (loadFromXxx) *. More... | |
int | $width |
image width * More... | |
Protected Attributes inherited from File | |
bool | $canRender |
Wether the output of transform() for this file is likely to be valid. More... | |
string | $extension |
File extension *. More... | |
FSFile bool | $fsFile |
False if undefined *. More... | |
MediaHandler | $handler |
string | $hashPath |
Relative path including trailing slash *. More... | |
bool | $isSafeFile |
Wether this media file is in a format that is unlikely to contain viruses or malicious content. More... | |
string | $lastError |
Text of last error *. More... | |
string | $name |
The name of a file from its title object *. More... | |
string | $pageCount |
number of pages of a multipage document, or false for documents which aren't multipage documents More... | |
string | $path |
The storage path corresponding to one of the zones *. More... | |
string | $redirected |
Main part of the title, with underscores (Title::getDBkey) *. More... | |
Title | $redirectedTitle |
Title | $redirectTitle |
string | $repoClass = 'FileRepo' |
Required Repository class type *. More... | |
Title string bool | $title |
string | $transformScript |
URL of transformscript (for example thumb.php) *. More... | |
string | $url |
The URL corresponding to one of the four basic zones *. More... | |
Private Attributes | |
string | $description |
Description of current revision of the file *. More... | |
int | $historyLine |
Number of line to return by nextHistoryLine() (constructor) *. More... | |
int | $historyRes |
Result of the query for the file's history (nextHistoryLine) *. More... | |
bool | $locked |
True if the image row is locked *. More... | |
bool | $lockedOwnTrx |
True if the image row is locked with a lock initiated transaction *. More... | |
string | $major_mime |
Major mime type *. More... | |
string | $minor_mime |
Minor mime type *. More... | |
bool | $missing |
True if file is not present in file system. More... | |
string | $timestamp |
Upload timestamp *. More... | |
bool | $upgraded |
Whether the row was upgraded on load *. More... | |
int | $user |
User ID of uploader *. More... | |
string | $user_text |
User name of uploader *. More... | |
Class to represent a local file in the wiki's own database.
Provides methods to retrieve paths (physical, logical, URL), to generate image thumbnails or for uploading.
Note that only the repo object knows what its file class is called. You should never name a file class explictly outside of the repo class. Instead use the repo's factory functions to generate file objects, for example:
RepoGroup::singleton()->getLocalRepo()->newFile( $title );
The convenience functions wfLocalFile() and wfFindFile() should be sufficient in most cases.
Definition at line 46 of file LocalFile.php.
LocalFile::__construct | ( | $title, | |
$repo | |||
) |
Constructor.
Do not call this except from inside a repo class.
Reimplemented from File.
Definition at line 186 of file LocalFile.php.
References File\$repo, File\$title, File\assertRepoDefined(), and File\assertTitleDefined().
LocalFile::__destruct | ( | ) |
LocalFile::decodeRow | ( | $row, | |
$prefix = 'img_' |
|||
) |
Decode a row from the database (either object or array) to an array with timestamps and MIME types decoded, and the field prefix removed.
$row | |
$prefix | string |
MWException |
Definition at line 438 of file LocalFile.php.
References TS_MW, unprefixRow(), and wfTimestamp().
Referenced by loadFromRow().
LocalFile::delete | ( | $reason, | |
$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 | |
bool | $suppress |
Reimplemented from File.
Reimplemented in ForeignDBFile.
Definition at line 1573 of file LocalFile.php.
References $batch, $file, DeferredUpdates\addUpdate(), array(), as, SiteStatsUpdate\factory(), false, File\getRepo(), global, lock(), SquidUpdate\purge(), readOnlyFatalStatus(), and unlock().
LocalFile::deleteOld | ( | $archiveName, | |
$reason, | |||
$suppress = false |
|||
) |
Delete an old version of the file.
Moves the file into an archive directory (or deletes it) and removes the database row.
Cache purging is done; logging is caller's responsibility.
string | $archiveName | |
string | $reason | |
bool | $suppress |
MWException | Exception on database or file store failure |
Definition at line 1631 of file LocalFile.php.
References $batch, array(), File\getArchiveUrl(), File\getRepo(), global, lock(), SquidUpdate\purge(), File\purgeDescription(), purgeHistory(), purgeOldThumbnails(), readOnlyFatalStatus(), and unlock().
LocalFile::exists | ( | ) |
canRender inherited
mustRender inherited allowInlineDisplay inherited isSafeFile inherited isTrustedFile inherited Returns true if the file exists on disk.
Reimplemented from File.
Definition at line 754 of file LocalFile.php.
References $fileExists, and load().
Referenced by OldLocalFile\isVisible().
LocalFile::getBitDepth | ( | ) |
LocalFile::getCacheFields | ( | $prefix = 'img_' | ) |
$prefix | string |
Reimplemented in OldLocalFile.
Definition at line 303 of file LocalFile.php.
Referenced by loadFromDB(), saveToCache(), and setProps().
LocalFile::getCacheKey | ( | ) |
Get the memcached key for the main data for this file, or false if there is no access to the shared cache.
Reimplemented in OldLocalFile.
Definition at line 204 of file LocalFile.php.
References File\getName().
Referenced by loadFromCache(), lock(), and saveToCache().
LocalFile::getDescription | ( | $audience = self::FOR_PUBLIC , |
|
User | $user = null |
||
) |
int | $audience | |
User | $user |
Reimplemented from File.
Definition at line 1734 of file LocalFile.php.
References $description, $user, File\isDeleted(), load(), and File\userCan().
LocalFile::getDescriptionText | ( | $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.
Language | $lang | What language to get description in (Optional) |
Reimplemented from File.
Reimplemented in ForeignDBFile.
Definition at line 1715 of file LocalFile.php.
References Revision\newFromTitle(), IDBAccessObject\READ_NORMAL, and title.
LocalFile::getDescriptionUrl | ( | ) |
isMultipage inherited
pageCount inherited scaleHeight inherited getImageSize inherited Get the URL of the file description page.
Reimplemented from File.
Reimplemented in ForeignDBFile.
Definition at line 1703 of file LocalFile.php.
References title.
LocalFile::getHeight | ( | $page = 1 | ) |
Return the height of the image.
int | $page |
Reimplemented from File.
Definition at line 658 of file LocalFile.php.
References File\$handler, $height, File\getHandler(), MediaHandler\getPageDimensions(), File\isMultipage(), and load().
LocalFile::getHistory | ( | $limit = null , |
|
$start = null , |
|||
$end = null , |
|||
$inc = true |
|||
) |
purgeDescription inherited
purgeEverything inherited
int | $limit | Optional: Limit to number of results |
int | $start | Optional: Timestamp, start from |
int | $end | Optional: Timestamp, end at |
bool | $inc |
Reimplemented from File.
Definition at line 981 of file LocalFile.php.
References $dbr, $limit, $res, $tables, array(), as, OldLocalFile\selectFields(), title, and wfRunHooks().
LocalFile::getLazyCacheFields | ( | $prefix = 'img_' | ) |
string | $prefix |
Definition at line 328 of file LocalFile.php.
Referenced by OldLocalFile\loadExtraFromDB(), loadExtraFromDB(), loadFromCache(), and saveToCache().
LocalFile::getMediaType | ( | ) |
Returns the type of the media in the file.
Use the value returned by this function with the MEDIATYPE_xxx constants.
Reimplemented from File.
Definition at line 738 of file LocalFile.php.
References $media_type, and load().
LocalFile::getMetadata | ( | ) |
Get handler-specific metadata.
Reimplemented from File.
Definition at line 699 of file LocalFile.php.
References $metadata, and load().
Referenced by maybeUpgradeRow().
LocalFile::getMimeType | ( | ) |
Returns the mime type of the file.
Reimplemented from File.
Definition at line 727 of file LocalFile.php.
LocalFile::getSha1 | ( | ) |
Reimplemented from File.
Definition at line 1759 of file LocalFile.php.
References $sha1, array(), File\getName(), File\getPath(), load(), lock(), saveToCache(), unlock(), and wfReadOnly().
LocalFile::getSize | ( | ) |
Returns the size of the image file, in bytes.
Reimplemented from File.
Definition at line 717 of file LocalFile.php.
LocalFile::getThumbnails | ( | $archiveName = false | ) |
getHandler inherited
iconThumb inherited getLastError inherited Get all thumbnail names previously generated for this file
string | bool | $archiveName | Name of an archive file, default false |
Definition at line 808 of file LocalFile.php.
References $dir, $e, $file, $files, array(), as, File\getArchiveThumbPath(), and File\getThumbPath().
LocalFile::getTimestamp | ( | ) |
Reimplemented from File.
Definition at line 1750 of file LocalFile.php.
References $timestamp, and load().
LocalFile::getUpgraded | ( | ) |
Definition at line 522 of file LocalFile.php.
References $upgraded.
LocalFile::getUser | ( | $type = 'text' | ) |
Returns ID or name of user who uploaded the file.
string | $type | 'text' or 'id' |
Reimplemented from File.
Definition at line 685 of file LocalFile.php.
References $type, $user, $user_text, and load().
LocalFile::getWidth | ( | $page = 1 | ) |
Return the width of the image.
int | $page |
Reimplemented from File.
Definition at line 631 of file LocalFile.php.
References File\$handler, $width, File\getHandler(), MediaHandler\getPageDimensions(), File\isMultipage(), and load().
LocalFile::isCacheable | ( | ) |
Reimplemented from File.
Definition at line 1784 of file LocalFile.php.
References CACHE_FIELD_MAX_LEN, and load().
LocalFile::isMissing | ( | ) |
splitMime inherited
getName inherited getTitle inherited getURL inherited getViewURL inherited getPath inherited isVisible inhereted
Reimplemented from File.
Definition at line 616 of file LocalFile.php.
References $fileExists, $missing, File\getVirtualUrl(), and list.
LocalFile::load | ( | $flags = 0 | ) |
Load file metadata from cache or DB, unless already loaded.
integer | $flags |
Definition at line 481 of file LocalFile.php.
References $flags, loadExtraFromDB(), loadFromCache(), loadFromDB(), and saveToCache().
Referenced by exists(), OldLocalFile\getArchiveName(), getBitDepth(), getDescription(), getHeight(), getMediaType(), getMetadata(), getMimeType(), getSha1(), getSize(), getTimestamp(), getUser(), OldLocalFile\getVisibility(), getWidth(), isCacheable(), OldLocalFile\isDeleted(), saveToCache(), and OldLocalFile\userCan().
|
protected |
Load lazy file metadata from the DB.
This covers fields that are sometimes not cached.
Reimplemented in OldLocalFile.
Definition at line 376 of file LocalFile.php.
References $dbr, $fname, File\$name, $value, array(), as, getLazyCacheFields(), File\getName(), unprefixRow(), wfProfileIn(), and wfProfileOut().
Referenced by load().
LocalFile::loadFromCache | ( | ) |
Try to load file metadata from memcached.
Returns true on success.
Definition at line 214 of file LocalFile.php.
References $dataLoaded, $wgMemc, as, getCacheKey(), getLazyCacheFields(), global, MW_FILE_VERSION, setProps(), wfDebug(), wfIncrStats(), wfProfileIn(), and wfProfileOut().
Referenced by load().
LocalFile::loadFromDB | ( | ) |
Load file metadata from the DB.
Reimplemented in OldLocalFile.
Definition at line 350 of file LocalFile.php.
References $dbr, $fname, array(), getCacheFields(), File\getName(), loadFromRow(), wfProfileIn(), and wfProfileOut().
Referenced by load(), and purgeMetadataCache().
LocalFile::loadFromFile | ( | ) |
Load metadata from the file itself.
Definition at line 294 of file LocalFile.php.
References File\getVirtualUrl(), and setProps().
Referenced by OldLocalFile\upgradeRow(), and upgradeRow().
LocalFile::loadFromRow | ( | $row, | |
$prefix = 'img_' |
|||
) |
Load file metadata from a DB result row.
Definition at line 463 of file LocalFile.php.
References File\$name, $value, as, decodeRow(), and maybeUpgradeRow().
Referenced by OldLocalFile\loadFromDB(), and loadFromDB().
LocalFile::lock | ( | ) |
Start a transaction and lock the image for update Increments a reference counter if the lock is already held.
MWException |
Definition at line 1798 of file LocalFile.php.
References $cache, array(), getCacheKey(), File\getName(), and wfGetMainCache().
Referenced by delete(), deleteOld(), getSha1(), move(), publishTo(), restore(), upgradeRow(), upload(), and OldLocalFile\uploadOld().
LocalFile::maybeUpgradeRow | ( | ) |
Upgrade a row if it needs it.
Definition at line 497 of file LocalFile.php.
References File\$handler, File\getHandler(), getMetadata(), global, MediaHandler\isMetadataValid(), MediaHandler\METADATA_BAD, MediaHandler\METADATA_COMPATIBLE, upgradeRow(), and wfReadOnly().
Referenced by loadFromRow().
LocalFile::migrateThumbFile | ( | $thumbName | ) |
getTransformScript inherited
getUnscaledThumb inherited thumbName inherited createThumb inherited transform inherited Fix thumbnail files from 1.4 or before, with extreme prejudice
Enabling this code results in a serious RTT regression for wikis without 404 handling.
Reimplemented from File.
Definition at line 772 of file LocalFile.php.
LocalFile::move | ( | $target | ) |
getLinksTo inherited
getExifData inherited isLocal inherited wasDeleted inherited 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 from File.
Reimplemented in ForeignDBFile.
Definition at line 1519 of file LocalFile.php.
References $batch, as, File\getRepo(), lock(), name, readOnlyFatalStatus(), title, unlock(), wfDebugLog(), and wfLocalFile().
|
static |
Create a LocalFile 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 in OldLocalFile.
Definition at line 143 of file LocalFile.php.
References $dbr, File\$repo, $sha1, $timestamp, array(), and newFromRow().
|
static |
Create a LocalFile from a title Do not call this except from inside a repo class.
stdClass | $row | |
FileRepo | $repo |
Reimplemented in OldLocalFile, and ForeignDBFile.
Definition at line 126 of file LocalFile.php.
References $file, File\$repo, File\$title, Title\makeTitle(), and NS_FILE.
Referenced by newFromKey().
|
static |
Create a LocalFile from a title Do not call this except from inside a repo class.
Note: $unused param is only here to avoid an E_STRICT
Reimplemented in ForeignDBFile, and OldLocalFile.
Definition at line 113 of file LocalFile.php.
References File\$repo, and File\$title.
LocalFile::nextHistoryLine | ( | ) |
Returns the history of this file, line by line.
starts with current version, then old versions. uses $this->historyLine to check which line to return: 0 return line for current version 1 query for old versions, return first one 2, ... return next old version from above query
Reimplemented from File.
Definition at line 1032 of file LocalFile.php.
Move or copy a file to its public location.
If a file exists at the destination, move it to an archive. Returns a FileRepoStatus object with the archive name in the "value" member on success.
The archive name should be passed through to recordUpload for database registration.
string | $srcPath | 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 |
Reimplemented from File.
Reimplemented in ForeignDBFile.
Definition at line 1460 of file LocalFile.php.
References $flags, $options, File\getRel(), and publishTo().
Referenced by upload().
Move or copy a file to a specified location.
Returns a FileRepoStatus object with the archive name in the "value" member on success.
The archive name should be passed through to recordUpload for database registration.
string | $srcPath | Local filesystem path to the source image |
string | $dstRel | Target relative path |
int | $flags | A bitwise combination of: File::DELETE_SOURCE Delete the source file, i.e. move rather than copy |
array | $options | Optional additional parameters |
Definition at line 1479 of file LocalFile.php.
References $flags, $options, FileRepo\DELETE_SOURCE, File\DELETE_SOURCE, File\getHashPath(), File\getName(), File\getRepo(), lock(), readOnlyFatalStatus(), TS_MW, unlock(), and wfTimestamp().
Referenced by publish(), and OldLocalFile\uploadOld().
LocalFile::purgeCache | ( | $options = array() | ) |
Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid.
array | $options | An array potentially with the key forThumbRefresh. |
Reimplemented from File.
Definition at line 860 of file LocalFile.php.
References $options, array(), SquidUpdate\purge(), purgeMetadataCache(), purgeThumbnails(), wfProfileIn(), and wfProfileOut().
LocalFile::purgeHistory | ( | ) |
Purge the shared history (OldLocalFile) cache.
Definition at line 842 of file LocalFile.php.
References $wgMemc, File\getName(), and global.
Referenced by deleteOld(), and purgeMetadataCache().
LocalFile::purgeMetadataCache | ( | ) |
Refresh metadata in memcached, but don't touch thumbnails or squid.
Definition at line 831 of file LocalFile.php.
References loadFromDB(), purgeHistory(), and saveToCache().
Referenced by purgeCache().
LocalFile::purgeOldThumbnails | ( | $archiveName | ) |
Delete cached transformed files for an archived version only.
string | $archiveName | Name of the archived file |
Definition at line 877 of file LocalFile.php.
References $dir, $file, $files, array(), as, File\getArchiveThumbUrl(), File\getThumbnails(), global, SquidUpdate\purge(), purgeThumbList(), wfProfileIn(), wfProfileOut(), and wfRunHooks().
Referenced by deleteOld(), and PurgeChangedFiles\purgeFromArchiveTable().
|
protected |
Delete a list of thumbnails visible at urls.
string | $dir | Base dir of the files. |
array | $files | Array of strings: relative filenames (to $dir) |
Definition at line 947 of file LocalFile.php.
References $dir, $file, $files, array(), as, File\getName(), and wfDebug().
Referenced by purgeOldThumbnails(), and purgeThumbnails().
LocalFile::purgeThumbnails | ( | $options = array() | ) |
Delete cached transformed files for the current version only.
Definition at line 905 of file LocalFile.php.
References $dir, $file, $files, File\$handler, $options, array(), as, MediaHandler\filterThumbnailPurgeList(), File\getHandler(), File\getThumbnails(), File\getThumbUrl(), global, SquidUpdate\purge(), purgeThumbList(), wfProfileIn(), wfProfileOut(), and wfRunHooks().
Referenced by purgeCache(), and recordUpload2().
|
protected |
Definition at line 1851 of file LocalFile.php.
References File\getName(), and File\getRepo().
Referenced by delete(), deleteOld(), move(), publishTo(), restore(), and upload().
LocalFile::recordUpload | ( | $oldver, | |
$desc, | |||
$license = '' , |
|||
$copyStatus = '' , |
|||
$source = '' , |
|||
$watch = false , |
|||
$timestamp = false , |
|||
User | $user = null |
||
) |
Record a file upload in the upload log and the image table.
string | $oldver | |
string | $desc | |
string | $license | |
string | $copyStatus | |
string | $source | |
bool | $watch | |
string | bool | $timestamp | |
User | null | $user | User object or null to use $wgUser |
Reimplemented from File.
Reimplemented in ForeignDBFile.
Definition at line 1171 of file LocalFile.php.
References $license, $source, $timestamp, $user, $wgUser, SpecialUpload\getInitialPageText(), File\getTitle(), global, and recordUpload2().
LocalFile::recordUpload2 | ( | $oldver, | |
$comment, | |||
$pageText, | |||
$props = false , |
|||
$timestamp = false , |
|||
$user = null |
|||
) |
Record a file upload in the upload log and the image table.
string | $oldver | |
string | $comment | |
string | $pageText | |
bool | array | $props | |
string | bool | $timestamp | |
null | User | $user |
Definition at line 1201 of file LocalFile.php.
References $comment, $sha1, $timestamp, $user, $wgUser, DeferredUpdates\addUpdate(), array(), EDIT_NEW, EDIT_SUPPRESS_RC, SiteStatsUpdate\factory(), false, File\getName(), File\getRel(), File\getTitle(), File\getVirtualUrl(), global, ContentHandler\makeContent(), LogFormatter\newFromEntry(), Revision\newNullRevision(), SquidUpdate\purge(), purgeThumbnails(), LinksUpdate\queueRecursiveJobsForTable(), saveToCache(), setProps(), TS_MW, wfDebug(), wfProfileIn(), wfProfileOut(), wfRunHooks(), and wfTimestamp().
Referenced by recordUpload(), and upload().
LocalFile::resetHistory | ( | ) |
Reset the history pointer to the first element of the history.
Reimplemented from File.
Definition at line 1070 of file LocalFile.php.
Restore all or specified deleted revisions to the given file.
Permissions and logging are left to the caller.
May throw database exceptions on error.
array | $versions | set of record ids of deleted items to restore, or empty to restore all revisions. |
bool | $unsuppress |
Reimplemented from File.
Reimplemented in ForeignDBFile.
Definition at line 1669 of file LocalFile.php.
References $batch, File\getRepo(), lock(), readOnlyFatalStatus(), and unlock().
LocalFile::saveToCache | ( | ) |
Save the file metadata to memcached.
Definition at line 258 of file LocalFile.php.
References $cache, $fileExists, $wgMemc, array(), as, getCacheFields(), getCacheKey(), getLazyCacheFields(), global, load(), and MW_FILE_VERSION.
Referenced by getSha1(), load(), purgeMetadataCache(), recordUpload2(), and upgradeRow().
|
static |
Fields in the image table.
Reimplemented in OldLocalFile.
Definition at line 163 of file LocalFile.php.
References array().
Referenced by LocalRepo\findBySha1(), LocalRepo\findBySha1s(), LocalRepo\findFiles(), LocalRepo\findFilesByPrefix(), and ApiQueryAllImages\run().
LocalFile::setProps | ( | $info | ) |
Set properties in this object to be equal to those given in the associative array $info.
Only cacheable fields can be set. All fields must be set in $info except for getLazyCacheFields().
If 'mime' is given, it will be split into major_mime/minor_mime. If major_mime/minor_mime are given, $this->mime will also be set.
Definition at line 585 of file LocalFile.php.
References as, getCacheFields(), list, and File\splitMime().
Referenced by loadFromCache(), loadFromFile(), and recordUpload2().
LocalFile::unlock | ( | ) |
Decrement the lock reference count.
If the reference count is reduced to zero, commits the transaction and thereby releases the image lock.
Definition at line 1827 of file LocalFile.php.
References $locked.
Referenced by __destruct(), delete(), deleteOld(), getSha1(), move(), publishTo(), restore(), upgradeRow(), upload(), and OldLocalFile\uploadOld().
LocalFile::unlockAndRollback | ( | ) |
Roll back the DB transaction and mark the image unlocked.
Definition at line 1841 of file LocalFile.php.
|
protected |
array | $row | Row |
string | $prefix |
MWException |
Definition at line 413 of file LocalFile.php.
References File\$name, $value, array(), as, and key.
Referenced by decodeRow(), OldLocalFile\loadExtraFromDB(), and loadExtraFromDB().
LocalFile::upgradeRow | ( | ) |
Fix assorted version-related problems with the image row by reloading it from the file.
Reimplemented from File.
Reimplemented in OldLocalFile.
Definition at line 529 of file LocalFile.php.
References $sha1, array(), File\getName(), list, loadFromFile(), lock(), saveToCache(), File\splitMime(), unlock(), wfDebug(), wfProfileIn(), wfProfileOut(), and wfReadOnly().
Referenced by maybeUpgradeRow().
LocalFile::upload | ( | $srcPath, | |
$comment, | |||
$pageText, | |||
$flags = 0 , |
|||
$props = false , |
|||
$timestamp = false , |
|||
$user = null |
|||
) |
getHashPath inherited
getRel inherited getUrlRel inherited getArchiveRel inherited getArchivePath inherited getThumbPath inherited getArchiveUrl inherited getThumbUrl inherited getArchiveVirtualUrl inherited getThumbVirtualUrl inherited isHashed inherited Upload a file and record it in the DB
string | $srcPath | Source storage path, virtual URL, or filesystem path |
string | $comment | Upload description |
string | $pageText | Text to use for the new description page, if a new description page is created |
int | bool | $flags | Flags for publish() |
array | bool | $props | File properties, if known. This can be used to reduce the upload time when uploading virtual URLs for which the file info is already known |
string | bool | $timestamp | Timestamp for img_timestamp, or false to use the current time |
User | null | $user | User object or null to use $wgUser |
Definition at line 1107 of file LocalFile.php.
References $comment, $flags, File\$handler, $options, $timestamp, $user, $wgContLang, array(), MediaHandler\getHandler(), FSFile\getPropsFromPath(), File\getRepo(), MediaHandler\getStreamHeaders(), global, FileBackend\isStoragePath(), lock(), publish(), readOnlyFatalStatus(), recordUpload2(), unlock(), wfProfileIn(), and wfProfileOut().
|
protected |
Returned by getimagesize (loadFromXxx) *.
Definition at line 55 of file LocalFile.php.
Referenced by getBitDepth().
|
protected |
Whether or not core data has been loaded from the database (loadFromXxx) *.
Definition at line 67 of file LocalFile.php.
Referenced by loadFromCache().
|
protected |
Bitfield akin to rev_deleted *.
Definition at line 71 of file LocalFile.php.
Referenced by OldLocalFile\getVisibility().
|
private |
Description of current revision of the file *.
Definition at line 89 of file LocalFile.php.
Referenced by getDescription().
|
protected |
Whether or not lazy-loaded data has been loaded from the database *.
Definition at line 69 of file LocalFile.php.
|
protected |
Does the file exist on disk? (loadFromXxx) *.
Definition at line 49 of file LocalFile.php.
Referenced by exists(), isMissing(), and saveToCache().
|
protected |
|
private |
Number of line to return by nextHistoryLine() (constructor) *.
Definition at line 75 of file LocalFile.php.
|
private |
Result of the query for the file's history (nextHistoryLine) *.
Definition at line 77 of file LocalFile.php.
|
private |
True if the image row is locked *.
Definition at line 93 of file LocalFile.php.
Referenced by unlock().
|
private |
True if the image row is locked with a lock initiated transaction *.
Definition at line 95 of file LocalFile.php.
|
private |
Major mime type *.
Definition at line 79 of file LocalFile.php.
|
protected |
MEDIATYPE_xxx (bitmap, drawing, audio...) *.
Definition at line 57 of file LocalFile.php.
Referenced by getMediaType().
|
protected |
Handler-specific metadata *.
Definition at line 63 of file LocalFile.php.
Referenced by getMetadata().
|
protected |
MIME type, determined by MimeMagic::guessMimeType *.
Definition at line 59 of file LocalFile.php.
Referenced by getMimeType().
|
private |
Minor mime type *.
Definition at line 81 of file LocalFile.php.
|
private |
True if file is not present in file system.
Not to be cached in memcached *
Definition at line 97 of file LocalFile.php.
Referenced by isMissing().
|
protected |
Definition at line 73 of file LocalFile.php.
|
protected |
SHA-1 base 36 content hash *.
Definition at line 65 of file LocalFile.php.
Referenced by getSha1(), OldLocalFile\newFromKey(), newFromKey(), recordUpload2(), and upgradeRow().
|
protected |
Size in bytes (loadFromXxx) *.
Definition at line 61 of file LocalFile.php.
Referenced by getSize().
|
private |
Upload timestamp *.
Definition at line 83 of file LocalFile.php.
Referenced by getTimestamp(), OldLocalFile\newFromKey(), newFromKey(), OldLocalFile\recordOldUpload(), recordUpload(), recordUpload2(), upload(), and OldLocalFile\uploadOld().
|
private |
Whether the row was upgraded on load *.
Definition at line 91 of file LocalFile.php.
Referenced by getUpgraded().
|
private |
User ID of uploader *.
Definition at line 85 of file LocalFile.php.
Referenced by getDescription(), getUser(), OldLocalFile\recordOldUpload(), recordUpload(), recordUpload2(), upload(), OldLocalFile\uploadOld(), and OldLocalFile\userCan().
|
private |
|
protected |
const LocalFile::CACHE_FIELD_MAX_LEN = 1000 |
Definition at line 47 of file LocalFile.php.
Referenced by isCacheable().
const LocalFile::LOAD_ALL = 1 |
Definition at line 99 of file LocalFile.php.