Class to represent a file in the oldimage table. More...

Inheritance diagram for OldLocalFile:

Collaboration diagram for OldLocalFile:

[legend]

Public Member Functions
	__construct ( $title, $repo, $time, $archiveName)

	getArchiveName ()

	getCacheFields ( $prefix='img_')

	getCacheKey ()

	getRel ()

	getUrlRel ()

	getVisibility ()
	Returns bitfield value. More...

	isDeleted ( $field)

	isOld ()

	isVisible ()

	loadFromDB ()
	Load file metadata from the DB. More...

	recordOldUpload ( $srcPath, $archiveName, $timestamp, $comment, $user)
	Record a file upload in the oldimage table, without adding log entries. More...

	upgradeRow ()
	Fix assorted version-related problems with the image row by reloading it from the file. More...

	uploadOld ( $srcPath, $archiveName, $timestamp, $comment, $user, $flags=0)
	Upload a file directly into archive. More...

	userCan ( $field, User $user=null)
	Determine if the current user is allowed to view a particular field of this image file, if it's marked as deleted. More...

Public Member Functions inherited from LocalFile
	__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 ()

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

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

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

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

	getViewURL ()

	getVirtualUrl ( $suffix=false)
	Get the public zone virtual URL for a current version source file. 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...

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

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

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

	wasDeleted ()
	Was this file ever deleted from the wiki? More...

Static Public Member Functions
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. More...

static	newFromRow ( $row, $repo)

static	newFromTitle ( $title, $repo, $time=null)

static	selectFields ()
	Fields in the oldimage 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_VERSION = 1

const	MAX_CACHE_ROWS = 20

Public Attributes inherited from LocalFile
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...

Protected Member Functions inherited from LocalFile
	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
string	$archive_name
	Archive name *. More...

string	$requestedTime
	Timestamp *. More...

Protected Attributes inherited from LocalFile
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...

Detailed Description

Class to represent a file in the oldimage table.

Definition at line 29 of file OldLocalFile.php.

Constructor & Destructor Documentation

◆ __construct()

OldLocalFile::__construct	(	$title,
		$repo,
		$time,
		$archiveName
	)

Parameters

Title	$title
FileRepo	$repo
string	$time	Timestamp or null to load by archive name
string	$archiveName	archive name or null to load by timestamp

Exceptions

MWException

Definition at line 134 of file OldLocalFile.php.

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

Member Function Documentation

◆ getArchiveName()

OldLocalFile::getArchiveName ( )

Returns: string

Definition at line 153 of file OldLocalFile.php.

References $archive_name, and LocalFile\load().

Referenced by getRel(), and getUrlRel().

◆ getCacheFields()

OldLocalFile::getCacheFields ( $prefix = 'img_' )

Parameters

string $prefix

Returns: array

Reimplemented from LocalFile.

Definition at line 237 of file OldLocalFile.php.

Referenced by loadFromDB().

◆ getCacheKey()

OldLocalFile::getCacheKey ( )

Returns: bool

Reimplemented from LocalFile.

Definition at line 146 of file OldLocalFile.php.

◆ getRel()

OldLocalFile::getRel ( )

Returns: string

Reimplemented from File.

Definition at line 248 of file OldLocalFile.php.

References getArchiveName(), and File\getHashPath().

Referenced by recordOldUpload().

◆ getUrlRel()

OldLocalFile::getUrlRel ( )

Returns: string

Reimplemented from File.

Definition at line 255 of file OldLocalFile.php.

References getArchiveName(), and File\getHashPath().

◆ getVisibility()

OldLocalFile::getVisibility ( )

Returns bitfield value.

Returns: int

Reimplemented from File.

Definition at line 309 of file OldLocalFile.php.

References LocalFile\$deleted, and LocalFile\load().

◆ isDeleted()

OldLocalFile::isDeleted ( $field )

Parameters

int $field One of DELETED_* bitfield constants for file or revision rows

Returns: bool

Reimplemented from File.

Definition at line 299 of file OldLocalFile.php.

References LocalFile\load().

Referenced by isVisible().

◆ isOld()

OldLocalFile::isOld ( )

Returns: bool

Reimplemented from File.

Definition at line 164 of file OldLocalFile.php.

◆ isVisible()

OldLocalFile::isVisible ( )

Returns: bool

Reimplemented from File.

Definition at line 171 of file OldLocalFile.php.

References File\DELETED_FILE, LocalFile\exists(), and isDeleted().

◆ loadExtraFromDB()

OldLocalFile::loadExtraFromDB ( )

protected

Load lazy file metadata from the DB.

Reimplemented from LocalFile.

Definition at line 200 of file OldLocalFile.php.

References $archive_name, $dbr, File\$name, $value, array(), as, LocalFile\getLazyCacheFields(), File\getName(), LocalFile\unprefixRow(), wfProfileIn(), and wfProfileOut().

◆ loadFromDB()

OldLocalFile::loadFromDB ( )

Load file metadata from the DB.

Reimplemented from LocalFile.

Definition at line 175 of file OldLocalFile.php.

References $archive_name, $dbr, array(), getCacheFields(), File\getName(), LocalFile\loadFromRow(), wfProfileIn(), and wfProfileOut().

◆ newFromArchiveName()

static OldLocalFile::newFromArchiveName	(	$title,
		$repo,
		$archiveName
	)

static

Parameters

Title	$title
FileRepo	$repo
string	$archiveName

Returns: OldLocalFile

Definition at line 59 of file OldLocalFile.php.

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

Referenced by WikiRevision\importUpload(), and LocalRepo\newFromArchiveName().

◆ newFromKey()

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

static

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

Parameters

string	$sha1	base-36 SHA-1
LocalRepo	$repo
string \| bool	$timestamp	MW_timestamp (optional)

Returns: bool|OldLocalFile

Reimplemented from LocalFile.

Definition at line 86 of file OldLocalFile.php.

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

◆ newFromRow()

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

static

Parameters

stdClass	$row
FileRepo	$repo

Returns: OldLocalFile

Reimplemented from LocalFile.

Definition at line 68 of file OldLocalFile.php.

References $file, File\$repo, File\$title, Title\makeTitle(), and NS_FILE.

Referenced by newFromKey().

◆ newFromTitle()

static OldLocalFile::newFromTitle	(	$title,
		$repo,
		$time = `null`
	)

static

Parameters

Title	$title
FileRepo	$repo
null \| int	$time	Timestamp or null

Returns: OldLocalFile

Exceptions

MWException

Reimplemented from LocalFile.

Definition at line 44 of file OldLocalFile.php.

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

◆ recordOldUpload()

OldLocalFile::recordOldUpload	(	$srcPath,
		$archiveName,
		$timestamp,
		$comment,
		$user
	)

Record a file upload in the oldimage table, without adding log entries.

Parameters

string	$srcPath	File system path to the source file
string	$archiveName	The archive name of the file
string	$timestamp
string	$comment	Upload comment
User	$user	User who did this upload

Returns: bool

Definition at line 370 of file OldLocalFile.php.

References $comment, LocalFile\$timestamp, LocalFile\$user, array(), File\getName(), and getRel().

Referenced by uploadOld().

◆ selectFields()

static OldLocalFile::selectFields ( )

static

Fields in the oldimage table.

Returns: array

Reimplemented from LocalFile.

Definition at line 106 of file OldLocalFile.php.

References array().

Referenced by RevDel_FileList\doQuery(), LocalRepo\findFiles(), and LocalFile\getHistory().

◆ upgradeRow()

OldLocalFile::upgradeRow ( )

Fix assorted version-related problems with the image row by reloading it from the file.

Reimplemented from LocalFile.

Definition at line 259 of file OldLocalFile.php.

References array(), File\getName(), list, LocalFile\loadFromFile(), File\splitMime(), wfDebug(), wfProfileIn(), and wfProfileOut().

◆ uploadOld()

OldLocalFile::uploadOld	(	$srcPath,
		$archiveName,
		$timestamp,
		$comment,
		$user,
		$flags = `0`
	)

Upload a file directly into archive.

Generally for Special:Import.

Parameters

string	$srcPath	File system path of the source file
string	$archiveName	Full archive name of the file, in the form $timestamp!$filename, where $filename must match $this->getName()
string	$timestamp
string	$comment
User	$user
int	$flags

Returns: FileRepoStatus

Definition at line 341 of file OldLocalFile.php.

References $comment, $flags, LocalFile\$timestamp, LocalFile\$user, FileRepo\DELETE_SOURCE, File\DELETE_SOURCE, File\getHashPath(), LocalFile\lock(), LocalFile\publishTo(), recordOldUpload(), and LocalFile\unlock().

◆ userCan()

OldLocalFile::userCan	(		$field,
		User	$user = `null`
	)

Determine if the current user is allowed to view a particular field of this image file, if it's marked as deleted.

Parameters

int	$field
User \| null	$user	User object to check, or null to use $wgUser

Returns: bool

Reimplemented from File.

Definition at line 323 of file OldLocalFile.php.

References LocalFile\$user, LocalFile\load(), and Revision\userCanBitfield().

Member Data Documentation

◆ $archive_name

string OldLocalFile::$archive_name

protected

Archive name *.

Definition at line 32 of file OldLocalFile.php.

Referenced by getArchiveName(), loadExtraFromDB(), and loadFromDB().

◆ $requestedTime

string OldLocalFile::$requestedTime

protected

Timestamp *.

Definition at line 30 of file OldLocalFile.php.

◆ CACHE_VERSION

const OldLocalFile::CACHE_VERSION = 1

Definition at line 34 of file OldLocalFile.php.

◆ MAX_CACHE_ROWS

const OldLocalFile::MAX_CACHE_ROWS = 20

Definition at line 35 of file OldLocalFile.php.

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

includes/filerepo/file/OldLocalFile.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getArchiveName()

◆ getCacheFields()

◆ getCacheKey()

◆ getRel()

◆ getUrlRel()

◆ getVisibility()

◆ isDeleted()

◆ isOld()

◆ isVisible()

◆ loadExtraFromDB()

◆ loadFromDB()

◆ newFromArchiveName()

◆ newFromKey()

◆ newFromRow()

◆ newFromTitle()

◆ recordOldUpload()

◆ selectFields()

◆ upgradeRow()

◆ uploadOld()

◆ userCan()

Member Data Documentation

◆ $archive_name

◆ $requestedTime

◆ CACHE_VERSION

◆ MAX_CACHE_ROWS