MediaWiki  1.23.0
LocalFile Class Reference

Class to represent a local file in the wiki's own database. More...

Inheritance diagram for LocalFile:
Collaboration diagram for LocalFile:

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

Detailed Description

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.

Constructor & Destructor Documentation

◆ __construct()

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().

◆ __destruct()

LocalFile::__destruct ( )

Clean up any dangling locks.

Definition at line 1859 of file LocalFile.php.

References unlock().

Member Function Documentation

◆ decodeRow()

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.

Parameters
$row
$prefixstring
Exceptions
MWException
Returns
array

Definition at line 438 of file LocalFile.php.

References TS_MW, unprefixRow(), and wfTimestamp().

Referenced by loadFromRow().

◆ delete()

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.

Parameters
string$reason
bool$suppress
Returns
FileRepoStatus

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().

◆ deleteOld()

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.

Parameters
string$archiveName
string$reason
bool$suppress
Exceptions
MWExceptionException on database or file store failure
Returns
FileRepoStatus

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().

◆ exists()

LocalFile::exists ( )

canRender inherited

mustRender inherited allowInlineDisplay inherited isSafeFile inherited isTrustedFile inherited Returns true if the file exists on disk.

Returns
bool Whether file exist on disk.

Reimplemented from File.

Definition at line 754 of file LocalFile.php.

References $fileExists, and load().

Referenced by OldLocalFile\isVisible().

◆ getBitDepth()

LocalFile::getBitDepth ( )
Returns
int

Reimplemented from File.

Definition at line 707 of file LocalFile.php.

References $bits, and load().

◆ getCacheFields()

LocalFile::getCacheFields (   $prefix = 'img_')
Parameters
$prefixstring
Returns
array

Reimplemented in OldLocalFile.

Definition at line 303 of file LocalFile.php.

References array(), and as.

Referenced by loadFromDB(), saveToCache(), and setProps().

◆ getCacheKey()

LocalFile::getCacheKey ( )

Get the memcached key for the main data for this file, or false if there is no access to the shared cache.

Returns
bool

Reimplemented in OldLocalFile.

Definition at line 204 of file LocalFile.php.

References File\getName().

Referenced by loadFromCache(), lock(), and saveToCache().

◆ getDescription()

LocalFile::getDescription (   $audience = self::FOR_PUBLIC,
User  $user = null 
)
Parameters
int$audience
User$user
Returns
string

Reimplemented from File.

Definition at line 1734 of file LocalFile.php.

References $description, $user, File\isDeleted(), load(), and File\userCan().

◆ getDescriptionText()

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.

Parameters
Language$langWhat language to get description in (Optional)
Returns
bool|mixed

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1715 of file LocalFile.php.

References Revision\newFromTitle(), IDBAccessObject\READ_NORMAL, and title.

◆ getDescriptionUrl()

LocalFile::getDescriptionUrl ( )

isMultipage inherited

pageCount inherited scaleHeight inherited getImageSize inherited Get the URL of the file description page.

Returns
string

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1703 of file LocalFile.php.

References title.

◆ getHeight()

LocalFile::getHeight (   $page = 1)

Return the height of the image.

Parameters
int$page
Returns
int

Reimplemented from File.

Definition at line 658 of file LocalFile.php.

References File\$handler, $height, File\getHandler(), MediaHandler\getPageDimensions(), File\isMultipage(), and load().

◆ getHistory()

LocalFile::getHistory (   $limit = null,
  $start = null,
  $end = null,
  $inc = true 
)

purgeDescription inherited

purgeEverything inherited

Parameters
int$limitOptional: Limit to number of results
int$startOptional: Timestamp, start from
int$endOptional: Timestamp, end at
bool$inc
Returns
array

Reimplemented from File.

Definition at line 981 of file LocalFile.php.

References $dbr, $limit, $res, $tables, array(), as, OldLocalFile\selectFields(), title, and wfRunHooks().

◆ getLazyCacheFields()

LocalFile::getLazyCacheFields (   $prefix = 'img_')
Parameters
string$prefix
Returns
array

Definition at line 328 of file LocalFile.php.

References array(), and as.

Referenced by OldLocalFile\loadExtraFromDB(), loadExtraFromDB(), loadFromCache(), and saveToCache().

◆ getMediaType()

LocalFile::getMediaType ( )

Returns the type of the media in the file.

Use the value returned by this function with the MEDIATYPE_xxx constants.

Returns
string

Reimplemented from File.

Definition at line 738 of file LocalFile.php.

References $media_type, and load().

◆ getMetadata()

LocalFile::getMetadata ( )

Get handler-specific metadata.

Returns
string

Reimplemented from File.

Definition at line 699 of file LocalFile.php.

References $metadata, and load().

Referenced by maybeUpgradeRow().

◆ getMimeType()

LocalFile::getMimeType ( )

Returns the mime type of the file.

Returns
string

Reimplemented from File.

Definition at line 727 of file LocalFile.php.

References $mime, and load().

◆ getSha1()

LocalFile::getSha1 ( )
Returns
string

Reimplemented from File.

Definition at line 1759 of file LocalFile.php.

References $sha1, array(), File\getName(), File\getPath(), load(), lock(), saveToCache(), unlock(), and wfReadOnly().

◆ getSize()

LocalFile::getSize ( )

Returns the size of the image file, in bytes.

Returns
int

Reimplemented from File.

Definition at line 717 of file LocalFile.php.

References $size, and load().

◆ getThumbnails()

LocalFile::getThumbnails (   $archiveName = false)

getHandler inherited

iconThumb inherited getLastError inherited Get all thumbnail names previously generated for this file

Parameters
string | bool$archiveNameName of an archive file, default false
Returns
array first element is the base dir, then files in that base dir.

Definition at line 808 of file LocalFile.php.

References $dir, $e, $file, $files, array(), as, File\getArchiveThumbPath(), and File\getThumbPath().

◆ getTimestamp()

LocalFile::getTimestamp ( )
Returns
bool|string

Reimplemented from File.

Definition at line 1750 of file LocalFile.php.

References $timestamp, and load().

◆ getUpgraded()

LocalFile::getUpgraded ( )

Definition at line 522 of file LocalFile.php.

References $upgraded.

◆ getUser()

LocalFile::getUser (   $type = 'text')

Returns ID or name of user who uploaded the file.

Parameters
string$type'text' or 'id'
Returns
int|string

Reimplemented from File.

Definition at line 685 of file LocalFile.php.

References $type, $user, $user_text, and load().

◆ getWidth()

LocalFile::getWidth (   $page = 1)

Return the width of the image.

Parameters
int$page
Returns
int

Reimplemented from File.

Definition at line 631 of file LocalFile.php.

References File\$handler, $width, File\getHandler(), MediaHandler\getPageDimensions(), File\isMultipage(), and load().

◆ isCacheable()

LocalFile::isCacheable ( )
Returns
bool Whether to cache in RepoGroup (this avoids OOMs)

Reimplemented from File.

Definition at line 1784 of file LocalFile.php.

References CACHE_FIELD_MAX_LEN, and load().

◆ isMissing()

LocalFile::isMissing ( )

splitMime inherited

getName inherited getTitle inherited getURL inherited getViewURL inherited getPath inherited isVisible inhereted

Returns
bool

Reimplemented from File.

Definition at line 616 of file LocalFile.php.

References $fileExists, $missing, File\getVirtualUrl(), and list.

◆ load()

◆ loadExtraFromDB()

LocalFile::loadExtraFromDB ( )
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().

◆ loadFromCache()

LocalFile::loadFromCache ( )

Try to load file metadata from memcached.

Returns true on success.

Returns
bool

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().

◆ loadFromDB()

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().

◆ loadFromFile()

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().

◆ loadFromRow()

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().

◆ lock()

LocalFile::lock ( )

Start a transaction and lock the image for update Increments a reference counter if the lock is already held.

Exceptions
MWException
Returns
bool True if the image exists, false otherwise

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().

◆ maybeUpgradeRow()

LocalFile::maybeUpgradeRow ( )

◆ migrateThumbFile()

LocalFile::migrateThumbFile (   $thumbName)

getTransformScript inherited

getUnscaledThumb inherited thumbName inherited createThumb inherited transform inherited Fix thumbnail files from 1.4 or before, with extreme prejudice

Todo:
Do we still care about this? Perhaps a maintenance script can be made instead.

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.

◆ move()

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

Parameters
Title$targetNew file name
Returns
FileRepoStatus

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().

◆ newFromKey()

static LocalFile::newFromKey (   $sha1,
  $repo,
  $timestamp = false 
)
static

Create a LocalFile from a SHA-1 key Do not call this except from inside a repo class.

Parameters
string$sha1base-36 SHA-1
LocalRepo$repo
string | bool$timestampMW_timestamp (optional)
Returns
bool|LocalFile

Reimplemented in OldLocalFile.

Definition at line 143 of file LocalFile.php.

References $dbr, File\$repo, $sha1, $timestamp, array(), and newFromRow().

◆ newFromRow()

static LocalFile::newFromRow (   $row,
  $repo 
)
static

Create a LocalFile from a title Do not call this except from inside a repo class.

Parameters
stdClass$row
FileRepo$repo
Returns
LocalFile

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().

◆ newFromTitle()

static LocalFile::newFromTitle (   $title,
  $repo,
  $unused = null 
)
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

Parameters
Title$title
FileRepo$repo
$unused
Returns
LocalFile

Reimplemented in ForeignDBFile, and OldLocalFile.

Definition at line 113 of file LocalFile.php.

References File\$repo, and File\$title.

◆ nextHistoryLine()

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

Returns
bool

Reimplemented from File.

Definition at line 1032 of file LocalFile.php.

References $dbr, $fname, array(), and title.

◆ publish()

LocalFile::publish (   $srcPath,
  $flags = 0,
array  $options = array() 
)

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.

Parameters
string$srcPathLocal filesystem path to the source image
int$flagsA bitwise combination of: File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
array$optionsOptional additional parameters
Returns
FileRepoStatus On success, the value member contains the archive name, or an empty string if it was a new file.

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1460 of file LocalFile.php.

References $flags, $options, File\getRel(), and publishTo().

Referenced by upload().

◆ publishTo()

LocalFile::publishTo (   $srcPath,
  $dstRel,
  $flags = 0,
array  $options = array() 
)

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.

Parameters
string$srcPathLocal filesystem path to the source image
string$dstRelTarget relative path
int$flagsA bitwise combination of: File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
array$optionsOptional additional parameters
Returns
FileRepoStatus On success, the value member contains the archive name, or an empty string if it was a new file.

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().

◆ purgeCache()

LocalFile::purgeCache (   $options = array())

Delete all previously generated thumbnails, refresh metadata in memcached and purge the squid.

Parameters
array$optionsAn array potentially with the key forThumbRefresh.
Note
This used to purge old thumbnails by default as well, but doesn't anymore.

Reimplemented from File.

Definition at line 860 of file LocalFile.php.

References $options, array(), SquidUpdate\purge(), purgeMetadataCache(), purgeThumbnails(), wfProfileIn(), and wfProfileOut().

◆ purgeHistory()

LocalFile::purgeHistory ( )

Purge the shared history (OldLocalFile) cache.

Note
This used to purge old thumbnails as well.

Definition at line 842 of file LocalFile.php.

References $wgMemc, File\getName(), and global.

Referenced by deleteOld(), and purgeMetadataCache().

◆ 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().

◆ purgeOldThumbnails()

LocalFile::purgeOldThumbnails (   $archiveName)

Delete cached transformed files for an archived version only.

Parameters
string$archiveNameName 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().

◆ purgeThumbList()

LocalFile::purgeThumbList (   $dir,
  $files 
)
protected

Delete a list of thumbnails visible at urls.

Parameters
string$dirBase dir of the files.
array$filesArray 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().

◆ purgeThumbnails()

LocalFile::purgeThumbnails (   $options = array())

◆ readOnlyFatalStatus()

LocalFile::readOnlyFatalStatus ( )
protected
Returns
Status

Definition at line 1851 of file LocalFile.php.

References File\getName(), and File\getRepo().

Referenced by delete(), deleteOld(), move(), publishTo(), restore(), and upload().

◆ recordUpload()

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.

Parameters
string$oldver
string$desc
string$license
string$copyStatus
string$source
bool$watch
string | bool$timestamp
User | null$userUser object or null to use $wgUser
Returns
bool

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().

◆ recordUpload2()

LocalFile::recordUpload2 (   $oldver,
  $comment,
  $pageText,
  $props = false,
  $timestamp = false,
  $user = null 
)

◆ resetHistory()

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()

LocalFile::restore (   $versions = array(),
  $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.

Parameters
array$versionsset of record ids of deleted items to restore, or empty to restore all revisions.
bool$unsuppress
Returns
FileRepoStatus

Reimplemented from File.

Reimplemented in ForeignDBFile.

Definition at line 1669 of file LocalFile.php.

References $batch, File\getRepo(), lock(), readOnlyFatalStatus(), and unlock().

◆ saveToCache()

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().

◆ selectFields()

static LocalFile::selectFields ( )
static

Fields in the image table.

Returns
array

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().

◆ setProps()

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().

◆ unlock()

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().

◆ unlockAndRollback()

LocalFile::unlockAndRollback ( )

Roll back the DB transaction and mark the image unlocked.

Definition at line 1841 of file LocalFile.php.

◆ unprefixRow()

LocalFile::unprefixRow (   $row,
  $prefix = 'img_' 
)
protected
Parameters
array$rowRow
string$prefix
Exceptions
MWException
Returns
array

Definition at line 413 of file LocalFile.php.

References File\$name, $value, array(), as, and key.

Referenced by decodeRow(), OldLocalFile\loadExtraFromDB(), and loadExtraFromDB().

◆ upgradeRow()

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().

◆ upload()

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

Parameters
string$srcPathSource storage path, virtual URL, or filesystem path
string$commentUpload description
string$pageTextText to use for the new description page, if a new description page is created
int | bool$flagsFlags for publish()
array | bool$propsFile 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$timestampTimestamp for img_timestamp, or false to use the current time
User | null$userUser object or null to use $wgUser
Returns
FileRepoStatus object. On success, the value member contains the archive name, or an empty string if it was a new file.

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().

Member Data Documentation

◆ $bits

int LocalFile::$bits
protected

Returned by getimagesize (loadFromXxx) *.

Definition at line 55 of file LocalFile.php.

Referenced by getBitDepth().

◆ $dataLoaded

bool LocalFile::$dataLoaded
protected

Whether or not core data has been loaded from the database (loadFromXxx) *.

Definition at line 67 of file LocalFile.php.

Referenced by loadFromCache().

◆ $deleted

int LocalFile::$deleted
protected

Bitfield akin to rev_deleted *.

Definition at line 71 of file LocalFile.php.

Referenced by OldLocalFile\getVisibility().

◆ $description

string LocalFile::$description
private

Description of current revision of the file *.

Definition at line 89 of file LocalFile.php.

Referenced by getDescription().

◆ $extraDataLoaded

bool LocalFile::$extraDataLoaded
protected

Whether or not lazy-loaded data has been loaded from the database *.

Definition at line 69 of file LocalFile.php.

◆ $fileExists

bool LocalFile::$fileExists
protected

Does the file exist on disk? (loadFromXxx) *.

Definition at line 49 of file LocalFile.php.

Referenced by exists(), isMissing(), and saveToCache().

◆ $height

int LocalFile::$height
protected

image height *

Definition at line 53 of file LocalFile.php.

Referenced by getHeight().

◆ $historyLine

int LocalFile::$historyLine
private

Number of line to return by nextHistoryLine() (constructor) *.

Definition at line 75 of file LocalFile.php.

◆ $historyRes

int LocalFile::$historyRes
private

Result of the query for the file's history (nextHistoryLine) *.

Definition at line 77 of file LocalFile.php.

◆ $locked

bool LocalFile::$locked
private

True if the image row is locked *.

Definition at line 93 of file LocalFile.php.

Referenced by unlock().

◆ $lockedOwnTrx

bool LocalFile::$lockedOwnTrx
private

True if the image row is locked with a lock initiated transaction *.

Definition at line 95 of file LocalFile.php.

◆ $major_mime

string LocalFile::$major_mime
private

Major mime type *.

Definition at line 79 of file LocalFile.php.

◆ $media_type

string LocalFile::$media_type
protected

MEDIATYPE_xxx (bitmap, drawing, audio...) *.

Definition at line 57 of file LocalFile.php.

Referenced by getMediaType().

◆ $metadata

string LocalFile::$metadata
protected

Handler-specific metadata *.

Definition at line 63 of file LocalFile.php.

Referenced by getMetadata().

◆ $mime

string LocalFile::$mime
protected

MIME type, determined by MimeMagic::guessMimeType *.

Definition at line 59 of file LocalFile.php.

Referenced by getMimeType().

◆ $minor_mime

string LocalFile::$minor_mime
private

Minor mime type *.

Definition at line 81 of file LocalFile.php.

◆ $missing

bool LocalFile::$missing
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().

◆ $repoClass

string LocalFile::$repoClass = 'LocalRepo'
protected

Definition at line 73 of file LocalFile.php.

◆ $sha1

string LocalFile::$sha1
protected

SHA-1 base 36 content hash *.

Definition at line 65 of file LocalFile.php.

Referenced by getSha1(), OldLocalFile\newFromKey(), newFromKey(), recordUpload2(), and upgradeRow().

◆ $size

int LocalFile::$size
protected

Size in bytes (loadFromXxx) *.

Definition at line 61 of file LocalFile.php.

Referenced by getSize().

◆ $timestamp

string LocalFile::$timestamp
private

◆ $upgraded

bool LocalFile::$upgraded
private

Whether the row was upgraded on load *.

Definition at line 91 of file LocalFile.php.

Referenced by getUpgraded().

◆ $user

int LocalFile::$user
private

◆ $user_text

string LocalFile::$user_text
private

User name of uploader *.

Definition at line 87 of file LocalFile.php.

Referenced by getUser().

◆ $width

int LocalFile::$width
protected

image width *

Definition at line 51 of file LocalFile.php.

Referenced by getWidth().

◆ CACHE_FIELD_MAX_LEN

const LocalFile::CACHE_FIELD_MAX_LEN = 1000

Definition at line 47 of file LocalFile.php.

Referenced by isCacheable().

◆ LOAD_ALL

const LocalFile::LOAD_ALL = 1

Definition at line 99 of file LocalFile.php.


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