Base class for file repositories. More...

Inherited by ForeignAPIRepo, LocalRepo, NullRepo, and TempFileRepo.

Collaboration diagram for FileRepo:

[legend]

Public Member Functions
	__construct (array $info=null)

	backendSupportsUnicodePaths ()

	canTransformLocally ()
	Returns true if the repository can transform files locally.

	canTransformVia404 ()
	Returns true if the repository can transform files via a 404 handler.

	checkRedirect ( $title)
	Checks if there is a redirect named as $title.

	cleanDir ( $dir)
	Deletes a directory if empty.

	cleanupBatch (array $files, $flags=0)
	Deletes a batch of files.

	cleanupDeletedBatch (array $storageKeys)
	Delete files in the deleted directory if they are not referenced in the filearchive table.

	concatenate (array $srcPaths, $dstPath, $flags=0)
	Concatenate a list of temporary files into a target file location.

	delete ( $srcRel, $archiveRel)
	Move a file to the deletion archive.

	deleteBatch (array $sourceDestPairs)
	Move a group of files to the deletion archive.

	enumFiles ( $callback)
	Call a callback function for every public regular file in the repository.

	fileExists ( $file)
	Checks existence of a file.

	fileExistsBatch (array $files)
	Checks existence of an array of files.

	findBySha1 ( $hash)
	Get an array or iterator of file objects for files that have a given SHA-1 content hash.

	findBySha1s (array $hashes)
	Get an array of arrays or iterators of file objects for files that have the given SHA-1 content hashes.

	findFile ( $title, $options=[])
	Find an instance of the named file created at the specified time Returns false if the file does not exist.

	findFileFromKey ( $sha1, $options=[])
	Find an instance of the file with this key, created at the specified time Returns false if the file does not exist.

	findFiles (array $items, $flags=0)
	Find many files at once.

	findFilesByPrefix ( $prefix, $limit)
	Return an array of files where the name starts with $prefix.

	freeTemp ( $virtualUrl)
	Remove a temporary file or mark it for garbage collection.

	getBackend ()
	Get the file backend instance.

	getDeletedHashPath ( $key)
	Get a relative path for a deletion archive key, e.g.

	getDescriptionRenderUrl ( $name, $lang=null)
	Get the URL of the content-only fragment of the description page.

	getDescriptionStylesheetUrl ()
	Get the URL of the stylesheet to apply to description pages.

	getDescriptionUrl ( $name)
	Get the URL of an image description page.

	getDisplayName ()
	Get the human-readable name of the repo.

	getFileProps ( $virtualUrl)
	Get properties of a file with a given virtual URL/storage path.

	getFileSha1 ( $virtualUrl)
	Get the sha1 (base 36) of a file with a given virtual URL/storage path.

	getFileSize ( $virtualUrl)
	Get the size of a file with a given virtual URL/storage path.

	getFileTimestamp ( $virtualUrl)
	Get the timestamp of a file with a given virtual URL/storage path.

	getHashLevels ()
	Get the number of hash directory levels.

	getHashPath ( $name)
	Get a relative path including trailing slash, e.g.

	getInfo ()
	Return information about the repository.

	getLocalCacheKey ( $kClassSuffix,... $components)
	Get a site-local, repository-qualified, WAN cache key.

	getLocalCopy ( $virtualUrl)
	Get a local FS copy of a file with a given virtual URL/storage path.

	getLocalReference ( $virtualUrl)
	Get a local FS file with a given virtual URL/storage path.

	getName ()
	Get the name of this repository, as specified by $info['name]' to the constructor.

	getNameFromTitle ( $title)
	Get the name of a file from its title.

	getReadOnlyReason ()
	Get an explanatory message if this repo is read-only.

	getRootDirectory ()
	Get the public zone root storage directory of the repository.

	getSharedCacheKey ( $kClassSuffix,... $components)
	Get a global, repository-qualified, WAN cache key.

	getTempHashPath ( $suffix)
	Get a relative path including trailing slash, e.g.

	getTempRepo ()
	Get a temporary private FileRepo associated with this repo.

	getThumbProxySecret ()
	Get the secret key for the proxied thumb service.

	getThumbProxyUrl ()
	Get the URL thumb.php requests are being proxied to.

	getThumbScriptUrl ()
	Get the URL of thumb.php.

	getUploadStash (UserIdentity $user=null)
	Get an UploadStash associated with this repo.

	getVirtualUrl ( $suffix=false)
	Get a URL referring to this repository, with the private mwrepo protocol.

	getZonePath ( $zone)
	Get the storage path corresponding to one of the zones.

	getZoneUrl ( $zone, $ext=null)
	Get the URL corresponding to one of the four basic zones.

	hasSha1Storage ()
	Returns whether or not storage is SHA-1 based.

	invalidateImageRedirect ( $title)
	Invalidates image redirect cache related to that image Doesn't do anything for repositories that don't support image redirects.

	isLocal ()
	Returns true if this the local file repository.

	makeUrl ( $query='', $entry='index')
	Make an url to this repo.

	nameForThumb ( $name)
	Get the portion of the file that contains the origin file name.

	newFatal ( $message,... $parameters)
	Create a new fatal error.

	newFile ( $title, $time=false)
	Create a new File object from the local repository.

	newGood ( $value=null)
	Create a new good result.

	paranoidClean ( $param)
	Path disclosure protection function.

	passThrough ( $param)
	Path disclosure protection function.

	publish ( $src, $dstRel, $archiveRel, $flags=0, array $options=[])
	Copy or move a file either from a storage path, virtual URL, or file system path, into this repository at the specified destination location.

	publishBatch (array $ntuples, $flags=0)
	Publish a batch of files.

	quickCleanDir ( $dir)
	Deletes a directory if empty.

	quickImport ( $src, $dst, $options=null)
	Import a file from the local file system into the repo.

	quickImportBatch (array $triples)
	Import a batch of files from the local file system into the repo.

	quickPurge ( $path)
	Purge a file from the repo.

	quickPurgeBatch (array $paths)
	Purge a batch of files from the repo.

	resolveVirtualUrl ( $url)
	Get the backend storage path corresponding to a virtual URL.

	store ( $srcPath, $dstZone, $dstRel, $flags=0)
	Store a file to a given destination.

	storeBatch (array $triplets, $flags=0)
	Store a batch of files.

	storeTemp ( $originalName, $srcPath)
	Pick a random name in the temp zone and store a file to it.

	streamFileWithStatus ( $virtualUrl, $headers=[], $optHeaders=[])
	Attempt to stream a file with the given virtual URL/storage path.

	supportsSha1URLs ()
	Returns whether or not repo supports having originals SHA-1s in the thumb URLs.

	validateFilename ( $filename)
	Determine if a relative path is valid, i.e.

Static Public Member Functions
static	isVirtualUrl ( $url)
	Determine if a string is an mwrepo:// URL.

Public Attributes
int	$descriptionCacheExpiry

bool	$fetchDescription
	Whether to fetch commons image description pages and display them on the local wiki.

string	$name

const	DELETE_SOURCE = 1

const	NAME_AND_TIME_ONLY = 1

const	OVERWRITE = 2

const	OVERWRITE_SAME = 4

const	SKIP_LOCKING = 8

Protected Member Functions
	assertWritableRepo ()
	Throw an exception if this repo is read-only by design.

	enumFilesInStorage ( $callback)
	Call a callback function for every public file in the repository.

	getZoneLocation ( $zone)
	The storage container and base path of a zone.

	initDirectory ( $dir)
	Creates a directory with the appropriate zone permissions.

	initZones ( $doZones=[])
	Ensure that a single zone or list of zones is defined for usage.

	resolveToStoragePathIfVirtual ( $path)
	If a path is a virtual URL, resolve it to a storage path.

Static Protected Member Functions
static	getHashPathForLevel ( $name, $levels)

Protected Attributes
int	$abbrvThreshold
	File names over this size will use the short form of thumbnail names.

string	$articleUrl
	Equivalent to $wgArticlePath, e.g.

FileBackend	$backend

int	$deletedHashLevels
	The number of directory levels for hash-based division of deleted files.

string	$descBaseUrl
	URL of image description pages, e.g.

bool	$disableLocalTransform = false
	Disable local image scaling.

null string	$favicon = null
	The URL to a favicon (optional, may be a server-local path URL).

callable	$fileFactory = [ UnregisteredLocalFile::class, 'newFromTitle' ]
	Override these in the base class.

callable false	$fileFactoryKey = false
	Override these in the base class.

int	$hashLevels
	The number of directory levels for hash-based division of files.

bool	$hasSha1Storage = false

bool	$initialCapital
	Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE], determines whether filenames implicitly start with a capital letter.

bool	$isPrivate
	Whether all zones should be private (e.g.

callable false	$oldFileFactory = false
	Override these in the base class.

callable false	$oldFileFactoryKey = false
	Override these in the base class.

string	$pathDisclosureProtection = 'simple'
	May be 'paranoid' to remove all parameters from error messages, 'none' to leave the paths in unchanged, or 'simple' to replace paths with placeholders.

string	$scriptDirUrl
	URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.

bool	$supportsSha1URLs = false

string	$thumbProxySecret
	Secret key to pass as an X-Swift-Secret header to the proxied thumb service.

string	$thumbProxyUrl
	URL of where to proxy thumb.php requests to.

string	$thumbScriptUrl
	URL of thumb.php.

string false	$thumbUrl
	The base thumbnail URL.

bool	$transformVia404
	Whether to skip media file transformation on parse and rely on a 404 handler instead.

string false	$url
	Public zone URL.

WANObjectCache	$wanCache

array	$zones = []
	Map of zones to config.

Detailed Description

Base class for file repositories.

See the architecture doc for more information.

Definition at line 51 of file FileRepo.php.

Constructor & Destructor Documentation

◆ __construct()

FileRepo::__construct ( array $info = null )

See also: Documentation of info options at $wgLocalFileRepo

Parameters

array | null $info

Reimplemented in LocalRepo.

Definition at line 172 of file FileRepo.php.

References $hashLevels, NS_FILE, and supportsSha1URLs().

Member Function Documentation

◆ assertWritableRepo()

FileRepo::assertWritableRepo ( )

protected

Throw an exception if this repo is read-only by design.

This does not and should not check getReadOnlyReason().

Exceptions

LogicException

Reimplemented in ForeignAPIRepo, ForeignDBRepo, ForeignDBViaLBRepo, and NullRepo.

Definition at line 1958 of file FileRepo.php.

Referenced by LocalRepo\skipWriteOperationIfSha1().

◆ backendSupportsUnicodePaths()

FileRepo::backendSupportsUnicodePaths ( )

Returns: bool Whether non-ASCII path characters are allowed

Definition at line 345 of file FileRepo.php.

References FileBackend\ATTR_UNICODE_PATHS.

◆ canTransformLocally()

FileRepo::canTransformLocally ( )

Returns true if the repository can transform files locally.

Since: 1.36

Returns: bool

Definition at line 705 of file FileRepo.php.

◆ canTransformVia404()

FileRepo::canTransformVia404 ( )

Returns true if the repository can transform files via a 404 handler.

Returns: bool

Definition at line 695 of file FileRepo.php.

◆ checkRedirect()

FileRepo::checkRedirect ( $title )

Checks if there is a redirect named as $title.

If there is, return the title object. If not, return false. STUB

Parameters

PageIdentity | LinkTarget $title Title of image

Returns: Title|false

Reimplemented in LocalRepo.

Definition at line 1816 of file FileRepo.php.

◆ cleanDir()

FileRepo::cleanDir ( $dir )

Deletes a directory if empty.

Parameters

string $dir Virtual URL (or storage path) of directory to clean

Returns: Status

Definition at line 1415 of file FileRepo.php.

◆ cleanupBatch()

FileRepo::cleanupBatch	(	array	$files,
			$flags = 0 )

Deletes a batch of files.

Each file can be a (zone, rel) pair, virtual url, storage path. It will try to delete each file, but ignores any errors that may occur.

Parameters

string[]	$files	List of files to delete
int	$flags	Bitwise combination of the following flags: self::SKIP_LOCKING Skip any file locking when doing the deletions

Returns: Status

Reimplemented in LocalRepo.

Definition at line 1006 of file FileRepo.php.

References $path.

◆ cleanupDeletedBatch()

FileRepo::cleanupDeletedBatch ( array $storageKeys )

Delete files in the deleted directory if they are not referenced in the filearchive table.

STUB

Parameters

string[] $storageKeys

Reimplemented in LocalRepo.

Definition at line 1541 of file FileRepo.php.

◆ concatenate()

FileRepo::concatenate	(	array	$srcPaths,
			$dstPath,
			$flags = 0 )

Concatenate a list of temporary files into a target file location.

Parameters

string[]	$srcPaths	Ordered list of source virtual URLs/storage paths
string	$dstPath	Target file system path
int	$flags	Bitwise combination of the following flags: self::DELETE_SOURCE Delete the source files on success

Returns: Status

Definition at line 1205 of file FileRepo.php.

References $params, and $source.

◆ delete()

FileRepo::delete	(		$srcRel,
			$archiveRel )

Move a file to the deletion archive.

If no valid deletion archive exists, this may either delete the file or throw an exception, depending on the preference of the repository

Parameters

mixed	$srcRel	Relative path for the file to be deleted
mixed	$archiveRel	Relative path for the archive location. Relative to a private archive directory.

Returns: Status

Reimplemented in LocalRepo.

Definition at line 1466 of file FileRepo.php.

◆ deleteBatch()

FileRepo::deleteBatch ( array $sourceDestPairs )

Move a group of files to the deletion archive.

If no valid deletion archive is configured, this may either delete the file or throw an exception, depending on the preference of the repository.

The overwrite policy is determined by the repository – currently LocalRepo assumes a naming scheme in the deleted zone based on content hash, as opposed to the public zone which is assumed to be unique.

Parameters

array $sourceDestPairs Array of source/destination pairs. Each element is a two-element array containing the source file path relative to the public root in the first element, and the archive file path relative to the deleted zone root in the second element.

Returns: Status

Reimplemented in LocalRepo.

Definition at line 1488 of file FileRepo.php.

◆ enumFiles()

FileRepo::enumFiles ( $callback )

Call a callback function for every public regular file in the repository.

This only acts on the current version of files, not any old versions. May use either the database or the filesystem.

Parameters

callable $callback

Returns: void

Reimplemented in ForeignAPIRepo.

Definition at line 1697 of file FileRepo.php.

◆ enumFilesInStorage()

FileRepo::enumFilesInStorage ( $callback )

protected

Call a callback function for every public file in the repository.

May use either the database or the filesystem.

Parameters

callable $callback

Returns: void

Definition at line 1708 of file FileRepo.php.

References $path.

◆ fileExists()

FileRepo::fileExists ( $file )

Checks existence of a file.

Parameters

string $file Virtual URL (or storage path) of file to check

Returns: bool|null Whether the file exists, or null in case of I/O errors

Definition at line 1431 of file FileRepo.php.

Referenced by UploadStashFile\__construct(), and PurgeChangedFiles\purgeFromArchiveTable().

◆ fileExistsBatch()

FileRepo::fileExistsBatch ( array $files )

Checks existence of an array of files.

Parameters

string[] $files Virtual URLs (or storage paths) of files to check

Returns: array<string|int,bool|null> Map of files and either bool indicating whether the files exist, or null in case of I/O errors

Reimplemented in ForeignAPIRepo.

Definition at line 1444 of file FileRepo.php.

References $path.

◆ findBySha1()

FileRepo::findBySha1 ( $hash )

Get an array or iterator of file objects for files that have a given SHA-1 content hash.

STUB

Parameters

string $hash SHA-1 hash

Returns: File[]

Reimplemented in ForeignAPIRepo, and LocalRepo.

Definition at line 628 of file FileRepo.php.

◆ findBySha1s()

FileRepo::findBySha1s ( array $hashes )

Get an array of arrays or iterators of file objects for files that have the given SHA-1 content hashes.

Parameters

string[] $hashes An array of hashes

Returns: File[][] An Array of arrays or iterators of file objects and the hash as key

Reimplemented in LocalRepo.

Definition at line 639 of file FileRepo.php.

◆ findFile()

FileRepo::findFile	(		$title,
			$options = [] )

Find an instance of the named file created at the specified time Returns false if the file does not exist.

Repositories not supporting version control should return false if the time is specified.

Parameters

PageIdentity \| LinkTarget \| string	$title
array	$options	Associative array of options: time: requested time for a specific file version, or false for the current version. An image object will be returned which was created at the specified time (which may be archived or current). ignoreRedirect: If true, do not follow file redirects private: If an Authority object, return restricted (deleted) files if the performer is allowed to view them. Otherwise, such files will not be found. If set and not an Authority object, throws an exception. Authority is only accepted since 1.37, User was required before. latest: If true, load from the latest available data into File objects

Returns: File|false False on failure

Exceptions

InvalidArgumentException

Definition at line 456 of file FileRepo.php.

References NS_FILE.

◆ findFileFromKey()

FileRepo::findFileFromKey	(		$sha1,
			$options = [] )

Find an instance of the file with this key, created at the specified time Returns false if the file does not exist.

Repositories not supporting version control should return false if the time is specified.

Parameters

string	$sha1	Base 36 SHA-1 hash
array	$options	Option array, same as findFile().

Returns: File|false False on failure

Exceptions

InvalidArgumentException if the private option is set and not an Authority object

Definition at line 584 of file FileRepo.php.

◆ findFiles()

FileRepo::findFiles	(	array	$items,
			$flags = 0 )

Find many files at once.

Parameters

array $items An array of titles, or an array of findFile() options with the "title" option giving the title. Example:

$findItem = [ 'title' => $title, 'private' => true ]; $findBatch = [ $findItem ]; $repo->findFiles( $findBatch );

No title should appear in $items twice, as the result use titles as keys

Parameters

int

$flags

Supports:

FileRepo::NAME_AND_TIME_ONLY : return a (search title => (title,timestamp)) map. The search title uses the input titles; the other is the final post-redirect title. All titles are returned as string DB keys and the inner array is associative.

Returns: array Map of (file name => File objects) for matches or (search title => (title,timestamp))

Reimplemented in LocalRepo.

Definition at line 539 of file FileRepo.php.

◆ findFilesByPrefix()

FileRepo::findFilesByPrefix	(		$prefix,
			$limit )

Return an array of files where the name starts with $prefix.

STUB

Parameters

string	$prefix	The prefix to search for
int	$limit	The maximum amount of files to return

Returns: LocalFile[]

Reimplemented in LocalRepo.

Definition at line 659 of file FileRepo.php.

◆ freeTemp()

FileRepo::freeTemp ( $virtualUrl )

Remove a temporary file or mark it for garbage collection.

Parameters

string $virtualUrl The virtual URL returned by FileRepo::storeTemp()

Returns: bool True on success, false on failure

Definition at line 1183 of file FileRepo.php.

References wfDebug().

◆ getBackend()

FileRepo::getBackend ( )

Get the file backend instance.

Use this function wisely.

Returns: FileBackend

Definition at line 253 of file FileRepo.php.

References $backend.

Referenced by CleanupUploadStash\doOperations(), ForeignAPIRepo\getThumbUrlFromCache(), and PurgeChangedFiles\purgeFromArchiveTable().

◆ getDeletedHashPath()

FileRepo::getDeletedHashPath ( $key )

Get a relative path for a deletion archive key, e.g.

s/z/a/ for sza251lrxrc1jad41h5mgilp8nysje52.jpg

Parameters

string $key

Returns: string

Definition at line 1552 of file FileRepo.php.

References $path.

Referenced by LocalRepo\cleanupDeletedBatch(), and PurgeChangedFiles\getDeletedPath().

◆ getDescriptionRenderUrl()

FileRepo::getDescriptionRenderUrl	(		$name,
			$lang = null )

Get the URL of the content-only fragment of the description page.

For MediaWiki this means action=render. This should only be called by the repository's file class, since it may return invalid results. User code should use File::getDescriptionText().

Parameters

string	$name	Name of image to fetch
string \| null	$lang	Language to fetch it in, if any.

Returns: string|false

Definition at line 862 of file FileRepo.php.

References wfAppendQuery(), and wfUrlencode().

◆ getDescriptionStylesheetUrl()

FileRepo::getDescriptionStylesheetUrl ( )

Get the URL of the stylesheet to apply to description pages.

Returns: string|false False on failure

Definition at line 887 of file FileRepo.php.

◆ getDescriptionUrl()

FileRepo::getDescriptionUrl ( $name )

Get the URL of an image description page.

May return false if it is unknown or not applicable. In general this should only be called by the File class, since it may return invalid results for certain kinds of repositories. Use File::getDescriptionUrl() in user code.

In particular, it uses the article paths as specified to the repository constructor, whereas local repositories use the local Title functions.

Parameters

string $name

Returns: string|false

Definition at line 828 of file FileRepo.php.

References wfUrlencode().

◆ getDisplayName()

FileRepo::getDisplayName ( )

Get the human-readable name of the repo.

Returns: string

Definition at line 1835 of file FileRepo.php.

References wfMessageFallback().

Referenced by ForeignAPIRepo\getThumbError(), and ImagePage\printSharedImageText().

◆ getFileProps()

FileRepo::getFileProps ( $virtualUrl )

Get properties of a file with a given virtual URL/storage path.

Properties should ultimately be obtained via FSFile::getProps().

Parameters

string $virtualUrl

Returns: array

Reimplemented in ForeignAPIRepo.

Definition at line 1613 of file FileRepo.php.

◆ getFileSha1()

FileRepo::getFileSha1 ( $virtualUrl )

Get the sha1 (base 36) of a file with a given virtual URL/storage path.

Parameters

string $virtualUrl

Returns: string|false

Definition at line 1655 of file FileRepo.php.

References $path.

Referenced by PurgeChangedFiles\getDeletedPath().

◆ getFileSize()

FileRepo::getFileSize ( $virtualUrl )

Get the size of a file with a given virtual URL/storage path.

Parameters

string $virtualUrl

Returns: int|false

Definition at line 1643 of file FileRepo.php.

References $path.

◆ getFileTimestamp()

FileRepo::getFileTimestamp ( $virtualUrl )

Get the timestamp of a file with a given virtual URL/storage path.

Parameters

string $virtualUrl

Returns: string|false False on failure

Definition at line 1631 of file FileRepo.php.

References $path.

◆ getHashLevels()

FileRepo::getHashLevels ( )

Get the number of hash directory levels.

Returns: int

Definition at line 788 of file FileRepo.php.

◆ getHashPath()

FileRepo::getHashPath ( $name )

Get a relative path including trailing slash, e.g.

f/fa/ If the repo is not hashed, returns an empty string

Parameters

string $name Name of file

Returns: string

Definition at line 747 of file FileRepo.php.

Referenced by UnregisteredLocalFile\__construct(), and ForeignAPIRepo\getThumbUrlFromCache().

◆ getHashPathForLevel()

static FileRepo::getHashPathForLevel	(		$name,
			$levels )

staticprotected

Parameters

string	$name
int	$levels

Returns: string

Definition at line 769 of file FileRepo.php.

References $path.

◆ getInfo()

FileRepo::getInfo ( )

Return information about the repository.

Returns: array

Since: 1.22

Reimplemented in ForeignAPIRepo, and ForeignDBViaLBRepo.

Definition at line 1967 of file FileRepo.php.

Referenced by ApiQueryFileRepoInfo\execute(), LocalRepo\findFiles(), ForeignDBViaLBRepo\getInfo(), and ApiQueryFileRepoInfo\getProps().

◆ getLocalCacheKey()

FileRepo::getLocalCacheKey	(		$kClassSuffix,
			$components )

Get a site-local, repository-qualified, WAN cache key.

These cache keys are not shared among different site context and thus cannot be directly invalidated when repo objects are modified. These are useful when there is no accessible global cache or the values depend on the current site context.

Parameters

string	$kClassSuffix	Key collection name suffix (added to this repo class)
	mixed	...$components Additional key components

Returns: string

Definition at line 1897 of file FileRepo.php.

Referenced by LocalRepo\checkRedirect(), and ForeignAPIRepo\getThumbUrlFromCache().

◆ getLocalCopy()

FileRepo::getLocalCopy ( $virtualUrl )

Get a local FS copy of a file with a given virtual URL/storage path.

Temporary files may be purged when the file object falls out of scope.

Parameters

string $virtualUrl

Returns: TempFSFile|null|false Returns false for missing file, null on failure

Definition at line 1586 of file FileRepo.php.

References $path.

◆ getLocalReference()

FileRepo::getLocalReference ( $virtualUrl )

Get a local FS file with a given virtual URL/storage path.

The file is either an original or a copy. It should not be changed. Temporary files may be purged when the file object falls out of scope.

Parameters

string $virtualUrl

Returns: FSFile|null|false Returns false for missing file, null on failure.

Definition at line 1600 of file FileRepo.php.

References $path.

◆ getName()

FileRepo::getName ( )

Get the name of this repository, as specified by $info['name]' to the constructor.

Returns: string

Definition at line 797 of file FileRepo.php.

◆ getNameFromTitle()

FileRepo::getNameFromTitle ( $title )

Get the name of a file from its title.

Parameters

PageIdentity | LinkTarget $title

Returns: string

Definition at line 715 of file FileRepo.php.

References NS_FILE.

Referenced by UnregisteredLocalFile\__construct(), and LocalRepo\findFiles().

◆ getReadOnlyReason()

FileRepo::getReadOnlyReason ( )

Get an explanatory message if this repo is read-only.

This checks if an administrator disabled writes to the backend.

Returns: string|false Returns false if the repo is not read-only

Definition at line 263 of file FileRepo.php.

◆ getRootDirectory()

FileRepo::getRootDirectory ( )

Get the public zone root storage directory of the repository.

Returns: string

Definition at line 736 of file FileRepo.php.

Referenced by UnregisteredLocalFile\__construct().

◆ getSharedCacheKey()

FileRepo::getSharedCacheKey	(		$kClassSuffix,
			$components )

Get a global, repository-qualified, WAN cache key.

This might be called from either the site context of the wiki that owns the repo or the site context of another wiki that simply has access to the repo. This returns false if the repository's cache is not accessible from the current site context.

Parameters

string	$kClassSuffix	Key collection name suffix (added to this repo class)
	mixed	...$components Additional key components

Returns: string|false

Reimplemented in LocalRepo.

Definition at line 1882 of file FileRepo.php.

◆ getTempHashPath()

FileRepo::getTempHashPath ( $suffix )

Get a relative path including trailing slash, e.g.

f/fa/ If the repo is not hashed, returns an empty string

Parameters

string $suffix Basename of file from FileRepo::storeTemp()

Returns: string

Definition at line 758 of file FileRepo.php.

◆ getTempRepo()

FileRepo::getTempRepo ( )

Get a temporary private FileRepo associated with this repo.

Files will be created in the temp zone of this repo. It will have the same backend as this repo.

Returns: TempFileRepo

Reimplemented in TempFileRepo.

Definition at line 1913 of file FileRepo.php.

◆ getThumbProxySecret()

FileRepo::getThumbProxySecret ( )

Get the secret key for the proxied thumb service.

Returns: string

Definition at line 686 of file FileRepo.php.

◆ getThumbProxyUrl()

FileRepo::getThumbProxyUrl ( )

Get the URL thumb.php requests are being proxied to.

Returns: string

Definition at line 677 of file FileRepo.php.

◆ getThumbScriptUrl()

FileRepo::getThumbScriptUrl ( )

Get the URL of thumb.php.

Returns: string

Definition at line 668 of file FileRepo.php.

◆ getUploadStash()

FileRepo::getUploadStash ( UserIdentity $user = null )

Get an UploadStash associated with this repo.

Parameters

UserIdentity | null $user

Returns: UploadStash

Definition at line 1948 of file FileRepo.php.

◆ getVirtualUrl()

FileRepo::getVirtualUrl ( $suffix = false )

Get a URL referring to this repository, with the private mwrepo protocol.

The suffix, if supplied, is considered to be unencoded, and will be URL-encoded before being returned.

Parameters

string | false $suffix

Returns: string

Definition at line 299 of file FileRepo.php.

References $path.

◆ getZoneLocation()

FileRepo::getZoneLocation ( $zone )

protected

The storage container and base path of a zone.

Parameters

string $zone

Returns: array (container, base path) or (null, null)

Definition at line 383 of file FileRepo.php.

◆ getZonePath()

FileRepo::getZonePath ( $zone )

Get the storage path corresponding to one of the zones.

Parameters

string $zone

Returns: string|null Returns null if the zone is not defined

Reimplemented in ForeignAPIRepo.

Definition at line 397 of file FileRepo.php.

Referenced by UploadStashFile\__construct(), LocalRepo\cleanupDeletedBatch(), and initZones().

◆ getZoneUrl()

FileRepo::getZoneUrl	(		$zone,
			$ext = null )

Get the URL corresponding to one of the four basic zones.

Parameters

string	$zone	One of: public, deleted, temp, thumb
string \| null	$ext	Optional file extension

Returns: string|false

Reimplemented in ForeignAPIRepo.

Definition at line 315 of file FileRepo.php.

◆ hasSha1Storage()

FileRepo::hasSha1Storage ( )

Returns whether or not storage is SHA-1 based.

Returns: bool

Definition at line 2003 of file FileRepo.php.

Referenced by LocalRepo\__construct(), LocalRepo\cleanupDeletedBatch(), and LocalRepo\skipWriteOperationIfSha1().

◆ initDirectory()

FileRepo::initDirectory ( $dir )

protected

Creates a directory with the appropriate zone permissions.

Callers are responsible for doing read-only and "writable repo" checks.

Parameters

string $dir Virtual URL (or storage path) of directory to clean

Returns: Status Good status without value for success, fatal otherwise.

Definition at line 1392 of file FileRepo.php.

References $params, $path, and FileBackend\splitStoragePath().

◆ initZones()

FileRepo::initZones ( $doZones = [] )

protected

Ensure that a single zone or list of zones is defined for usage.

Parameters

string[] | string $doZones Only do a particular zones

Definition at line 272 of file FileRepo.php.

References getZonePath().

◆ invalidateImageRedirect()

FileRepo::invalidateImageRedirect ( $title )

Invalidates image redirect cache related to that image Doesn't do anything for repositories that don't support image redirects.

STUB

Parameters

PageIdentity | LinkTarget $title Title of image

Reimplemented in LocalRepo.

Definition at line 1827 of file FileRepo.php.

◆ isLocal()

FileRepo::isLocal ( )

Returns true if this the local file repository.

Returns: bool

Definition at line 1867 of file FileRepo.php.

◆ isVirtualUrl()

static FileRepo::isVirtualUrl ( $url )

static

Determine if a string is an mwrepo:// URL.

Parameters

string $url

Returns: bool

Definition at line 287 of file FileRepo.php.

Referenced by UploadStashFile\__construct(), RepoGroup\getFileProps(), UploadBase\getRealPath(), LocalFile\publishTo(), and LocalFile\upload().

◆ makeUrl()

FileRepo::makeUrl	(		$query = '',
			$entry = 'index' )

Make an url to this repo.

Parameters

string \| array	$query	Query string to append
string	$entry	Entry point; defaults to index

Returns: string|false False on failure

Definition at line 808 of file FileRepo.php.

References wfAppendQuery().

Referenced by ForeignAPIRepo\httpGetCached().

◆ nameForThumb()

FileRepo::nameForThumb ( $name )

Get the portion of the file that contains the origin file name.

If that name is too long, then the name "thumbnail.<ext>" will be given.

Parameters

string $name

Returns: string

Definition at line 1853 of file FileRepo.php.

References FileBackend\extensionFromPath().

◆ newFatal()

FileRepo::newFatal	(		$message,
			$parameters )

Create a new fatal error.

Parameters

string	$message
	mixed	...$parameters

Returns: Status

Definition at line 1788 of file FileRepo.php.

◆ newFile()

FileRepo::newFile	(		$title,
			$time = false )

Create a new File object from the local repository.

Parameters

PageIdentity \| LinkTarget \| string	$title
string \| false	$time	Time at which the image was uploaded. If this is specified, the returned object will be an instance of the repository's old file class instead of a current file. Repositories not supporting version control should return false if this parameter is set.

Returns: File|null A File, or null if passed an invalid Title

Reimplemented in ForeignAPIRepo.

Definition at line 421 of file FileRepo.php.

Referenced by FindOrphanedFiles\checkFiles(), and LocalRepo\findFiles().

◆ newGood()

FileRepo::newGood ( $value = null )

Create a new good result.

Parameters

null | mixed $value

Returns: Status

Definition at line 1801 of file FileRepo.php.

Referenced by LocalRepo\cleanupDeletedBatch().

◆ paranoidClean()

FileRepo::paranoidClean ( $param )

Path disclosure protection function.

Parameters

string $param

Returns: string

Definition at line 1767 of file FileRepo.php.

◆ passThrough()

FileRepo::passThrough ( $param )

Path disclosure protection function.

Parameters

string $param

Returns: string

Definition at line 1777 of file FileRepo.php.

◆ publish()

FileRepo::publish	(		$src,
			$dstRel,
			$archiveRel,
			$flags = 0,
		array	$options = [] )

Copy or move a file either from a storage path, virtual URL, or file system path, into this repository at the specified destination location.

Returns a Status object. On success, the value contains "new" or "archived", to indicate whether the file was new with that name.

Using FSFile/TempFSFile can improve performance via caching. Using TempFSFile can further improve performance by signalling that it is safe to touch the source file or write extended attribute metadata to it directly.

Options to $options include:

headers : name/value map of HTTP headers to use in response to GET/HEAD requests

Parameters

string \| FSFile	$src	The source file system path, storage path, or URL
string	$dstRel	The destination relative path
string	$archiveRel	The relative path where the existing file is to be archived, if there is one. Relative to the public zone root.
int	$flags	Bitfield, may be FileRepo::DELETE_SOURCE to indicate that the source file should be deleted if possible
array	$options	Optional additional parameters

Returns: Status

Reimplemented in LocalRepo.

Definition at line 1258 of file FileRepo.php.

◆ publishBatch()

FileRepo::publishBatch	(	array	$ntuples,
			$flags = 0 )

Publish a batch of files.

See also: FileRepo::publish()

Parameters

array	$ntuples	(source, dest, archive) triplets or (source, dest, archive, options) 4-tuples as per publish().
int	$flags	Bitfield, may be FileRepo::DELETE_SOURCE to indicate that the source files should be deleted if possible

Returns: Status

Reimplemented in LocalRepo.

Definition at line 1284 of file FileRepo.php.

References FileBackend\isStoragePath().

◆ quickCleanDir()

FileRepo::quickCleanDir ( $dir )

Deletes a directory if empty.

This function can be used to write to otherwise read-only foreign repos.

Parameters

string $dir Virtual URL (or storage path) of directory to clean

Returns: Status

Definition at line 1122 of file FileRepo.php.

◆ quickImport()

FileRepo::quickImport	(	$src,
		$dst,
		$options = null )

final

Import a file from the local file system into the repo.

This does no locking and overrides existing files. This function can be used to write to otherwise read-only foreign repos. This is intended for copying generated thumbnails into the repo.

Using FSFile/TempFSFile can improve performance via caching. Using TempFSFile can further improve performance by signalling that it is safe to touch the source file or write extended attribute metadata to it directly.

Parameters

string \| FSFile	$src	Source file system path, storage path, or virtual URL
string	$dst	Virtual URL or storage path
array \| string \| null	$options	An array consisting of a key named headers listing extra headers. If a string, taken as content-disposition header. (Support for array of options new in 1.23)

Returns: Status

Definition at line 1049 of file FileRepo.php.

◆ quickImportBatch()

FileRepo::quickImportBatch ( array $triples )

Import a batch of files from the local file system into the repo.

This does no locking and overrides existing files. This function can be used to write to otherwise read-only foreign repos. This is intended for copying generated thumbnails into the repo.

See also: FileRepo::quickImport()

All path parameters may be a file system path, storage path, or virtual URL. When "headers" are given they are used as HTTP headers if supported.

Parameters

array $triples List of (source path or FSFile, destination path, disposition)

Returns: Status

Definition at line 1067 of file FileRepo.php.

References FileBackend\isStoragePath().

◆ quickPurge()

FileRepo::quickPurge ( $path )

final

Purge a file from the repo.

This does no locking. This function can be used to write to otherwise read-only foreign repos. This is intended for purging thumbnails.

Parameters

string $path Virtual URL or storage path

Returns: Status

Definition at line 1111 of file FileRepo.php.

References $path.

◆ quickPurgeBatch()

FileRepo::quickPurgeBatch ( array $paths )

Purge a batch of files from the repo.

This function can be used to write to otherwise read-only foreign repos. This does no locking and is intended for purging thumbnails.

Parameters

string[] $paths List of virtual URLs or storage paths

Returns: Status

Definition at line 1138 of file FileRepo.php.

References $path.

◆ resolveToStoragePathIfVirtual()

FileRepo::resolveToStoragePathIfVirtual ( $path )

protected

If a path is a virtual URL, resolve it to a storage path.

Otherwise, just return the path as it is.

Parameters

string $path

Returns: string

Definition at line 1571 of file FileRepo.php.

References $path.

◆ resolveVirtualUrl()

FileRepo::resolveVirtualUrl ( $url )

Get the backend storage path corresponding to a virtual URL.

Callers are responsible of verifying that $url is a valid virtual URL. Use this function wisely.

Parameters

string $url

Returns: string

Definition at line 357 of file FileRepo.php.

Referenced by UploadStashFile\__construct().

◆ store()

FileRepo::store	(	$srcPath,
		$dstZone,
		$dstRel,
		$flags = 0 )

Store a file to a given destination.

Using FSFile/TempFSFile can improve performance via caching. Using TempFSFile can further improve performance by signalling that it is safe to touch the source file or write extended attribute metadata to it directly.

Parameters

string \| FSFile	$srcPath	Source file system path, storage path, or virtual URL
string	$dstZone	Destination zone
string	$dstRel	Destination relative path
int	$flags	Bitwise combination of the following flags: self::OVERWRITE Overwrite an existing destination file instead of failing self::OVERWRITE_SAME Overwrite the file if the destination exists and has the same contents as the source self::SKIP_LOCKING Skip any file locking when doing the store

Returns: Status

Reimplemented in LocalRepo.

Definition at line 914 of file FileRepo.php.

◆ storeBatch()

FileRepo::storeBatch	(	array	$triplets,
			$flags = 0 )

Store a batch of files.

See also: FileRepo::store()

Parameters

array	$triplets	(src, dest zone, dest rel) triplets as per store()
int	$flags	Bitwise combination of the following flags: self::OVERWRITE Overwrite an existing destination file instead of failing self::OVERWRITE_SAME Overwrite the file if the destination exists and has the same contents as the source self::SKIP_LOCKING Skip any file locking when doing the store

Returns: Status

Reimplemented in LocalRepo.

Definition at line 938 of file FileRepo.php.

References FileBackend\isStoragePath(), and wfDebug().

◆ storeTemp()

FileRepo::storeTemp	(		$originalName,
			$srcPath )

Pick a random name in the temp zone and store a file to it.

Returns a Status object with the file Virtual URL in the value, file can later be disposed using FileRepo::freeTemp().

Parameters

string	$originalName	The base name of the file as specified by the user. The file extension will be maintained.
string	$srcPath	The current location of the file.

Returns: Status Object with the URL in the value.

Definition at line 1163 of file FileRepo.php.

◆ streamFileWithStatus()

FileRepo::streamFileWithStatus	(	$virtualUrl,
		$headers = [],
		$optHeaders = [] )

Attempt to stream a file with the given virtual URL/storage path.

Parameters

string	$virtualUrl
array	$headers	Additional HTTP headers to send on success
array	$optHeaders	HTTP request headers (if-modified-since, range, ...)

Returns: Status

Since: 1.27

Definition at line 1670 of file FileRepo.php.

References $params, and $path.

◆ supportsSha1URLs()

FileRepo::supportsSha1URLs ( )

Returns whether or not repo supports having originals SHA-1s in the thumb URLs.

Returns: bool

Definition at line 2011 of file FileRepo.php.

Referenced by __construct().

◆ validateFilename()

FileRepo::validateFilename ( $filename )

Determine if a relative path is valid, i.e.

not blank or involving directory traversal

Parameters

string $filename

Returns: bool

Definition at line 1736 of file FileRepo.php.

References FileBackend\isPathTraversalFree().

Referenced by UploadStashFile\__construct(), and ForeignAPIRepo\getThumbUrlFromCache().

Member Data Documentation

◆ $abbrvThreshold

int FileRepo::$abbrvThreshold

protected

File names over this size will use the short form of thumbnail names.

Short thumbnail names only have the width, parameters, and the extension.

Definition at line 130 of file FileRepo.php.

◆ $articleUrl

string FileRepo::$articleUrl

protected

Equivalent to $wgArticlePath, e.g.

https://en.wikipedia.org/wiki/$1

Definition at line 98 of file FileRepo.php.

◆ $backend

FileBackend FileRepo::$backend

protected

Definition at line 74 of file FileRepo.php.

Referenced by LocalRepo\cleanupDeletedBatch(), getBackend(), and ForeignAPIRepo\getThumbUrlFromCache().

◆ $deletedHashLevels

int FileRepo::$deletedHashLevels

protected

The number of directory levels for hash-based division of deleted files.

Definition at line 124 of file FileRepo.php.

◆ $descBaseUrl

string FileRepo::$descBaseUrl

protected

URL of image description pages, e.g.

https://en.wikipedia.org/wiki/File:

Definition at line 90 of file FileRepo.php.

◆ $descriptionCacheExpiry

int FileRepo::$descriptionCacheExpiry

Definition at line 65 of file FileRepo.php.

◆ $disableLocalTransform

bool FileRepo::$disableLocalTransform = false

protected

Disable local image scaling.

Definition at line 155 of file FileRepo.php.

◆ $favicon

null string FileRepo::$favicon = null

protected

The URL to a favicon (optional, may be a server-local path URL).

Definition at line 133 of file FileRepo.php.

◆ $fetchDescription

bool FileRepo::$fetchDescription

Whether to fetch commons image description pages and display them on the local wiki.

Definition at line 62 of file FileRepo.php.

◆ $fileFactory

callable FileRepo::$fileFactory = [ UnregisteredLocalFile::class, 'newFromTitle' ]

protected

Override these in the base class.

Definition at line 139 of file FileRepo.php.

◆ $fileFactoryKey

callable false FileRepo::$fileFactoryKey = false

protected

Override these in the base class.

Definition at line 143 of file FileRepo.php.

◆ $hashLevels

int FileRepo::$hashLevels

protected

The number of directory levels for hash-based division of files.

Definition at line 121 of file FileRepo.php.

Referenced by __construct().

◆ $hasSha1Storage

bool FileRepo::$hasSha1Storage = false

protected

Definition at line 68 of file FileRepo.php.

◆ $initialCapital

bool FileRepo::$initialCapital

protected

Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE], determines whether filenames implicitly start with a capital letter.

The current implementation may give incorrect description page links when the local $wgCapitalLinks and initialCapital are mismatched.

Definition at line 105 of file FileRepo.php.

◆ $isPrivate

bool FileRepo::$isPrivate

protected

Whether all zones should be private (e.g.

private wiki repo)

Definition at line 136 of file FileRepo.php.

◆ $name

string FileRepo::$name

Note: Use $this->getName(). Public for back-compat only

Todo: make protected

Definition at line 165 of file FileRepo.php.

Referenced by ForeignAPIRepo\getThumbError(), and ForeignAPIRepo\getThumbUrlFromCache().

◆ $oldFileFactory

callable false FileRepo::$oldFileFactory = false

protected

Override these in the base class.

Definition at line 141 of file FileRepo.php.

◆ $oldFileFactoryKey

callable false FileRepo::$oldFileFactoryKey = false

protected

Override these in the base class.

Definition at line 145 of file FileRepo.php.

◆ $pathDisclosureProtection

string FileRepo::$pathDisclosureProtection = 'simple'

protected

May be 'paranoid' to remove all parameters from error messages, 'none' to leave the paths in unchanged, or 'simple' to replace paths with placeholders.

Default for LocalRepo is 'simple'.

Definition at line 112 of file FileRepo.php.

◆ $scriptDirUrl

string FileRepo::$scriptDirUrl

protected

URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g.

https://en.wikipedia.org/w

Definition at line 95 of file FileRepo.php.

◆ $supportsSha1URLs

bool FileRepo::$supportsSha1URLs = false

protected

Definition at line 71 of file FileRepo.php.

◆ $thumbProxySecret

string FileRepo::$thumbProxySecret

protected

Secret key to pass as an X-Swift-Secret header to the proxied thumb service.

Definition at line 152 of file FileRepo.php.

◆ $thumbProxyUrl

string FileRepo::$thumbProxyUrl

protected

URL of where to proxy thumb.php requests to.

Example: http://127.0.0.1:8888/wiki/dev/thumb/

Definition at line 150 of file FileRepo.php.

◆ $thumbScriptUrl

string FileRepo::$thumbScriptUrl

protected

URL of thumb.php.

Definition at line 80 of file FileRepo.php.

◆ $thumbUrl

string false FileRepo::$thumbUrl

protected

The base thumbnail URL.

Defaults to "<url>/thumb".

Definition at line 118 of file FileRepo.php.

Referenced by ForeignAPIRepo\getZoneUrl().

◆ $transformVia404

bool FileRepo::$transformVia404

protected

Whether to skip media file transformation on parse and rely on a 404 handler instead.

Definition at line 85 of file FileRepo.php.

◆ $url

string false FileRepo::$url

protected

Public zone URL.

Definition at line 115 of file FileRepo.php.

Referenced by ForeignAPIRepo\getZoneUrl(), ForeignAPIRepo\httpGet(), and ForeignAPIRepo\httpGetCached().

◆ $wanCache

WANObjectCache FileRepo::$wanCache

protected

Definition at line 158 of file FileRepo.php.

◆ $zones

array FileRepo::$zones = []

protected

Map of zones to config.

Definition at line 77 of file FileRepo.php.

◆ DELETE_SOURCE

const FileRepo::DELETE_SOURCE = 1

Definition at line 52 of file FileRepo.php.

◆ NAME_AND_TIME_ONLY

const FileRepo::NAME_AND_TIME_ONLY = 1

Definition at line 57 of file FileRepo.php.

Referenced by LocalRepo\findFiles().

◆ OVERWRITE

const FileRepo::OVERWRITE = 2

Definition at line 53 of file FileRepo.php.

◆ OVERWRITE_SAME

const FileRepo::OVERWRITE_SAME = 4

Definition at line 54 of file FileRepo.php.

Referenced by RevDelFileList\doPreCommitUpdates(), LocalFileMoveBatch\execute(), and LocalFileRestoreBatch\execute().

◆ SKIP_LOCKING

const FileRepo::SKIP_LOCKING = 8

Definition at line 55 of file FileRepo.php.

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

includes/filerepo/FileRepo.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assertWritableRepo()

◆ backendSupportsUnicodePaths()

◆ canTransformLocally()

◆ canTransformVia404()

◆ checkRedirect()

◆ cleanDir()

◆ cleanupBatch()

◆ cleanupDeletedBatch()

◆ concatenate()

◆ delete()

◆ deleteBatch()

◆ enumFiles()

◆ enumFilesInStorage()

◆ fileExists()

◆ fileExistsBatch()

◆ findBySha1()

◆ findBySha1s()

◆ findFile()

◆ findFileFromKey()

◆ findFiles()

◆ findFilesByPrefix()

◆ freeTemp()

◆ getBackend()

◆ getDeletedHashPath()

◆ getDescriptionRenderUrl()

◆ getDescriptionStylesheetUrl()

◆ getDescriptionUrl()

◆ getDisplayName()

◆ getFileProps()

◆ getFileSha1()

◆ getFileSize()

◆ getFileTimestamp()

◆ getHashLevels()

◆ getHashPath()

◆ getHashPathForLevel()

◆ getInfo()

◆ getLocalCacheKey()

◆ getLocalCopy()

◆ getLocalReference()

◆ getName()

◆ getNameFromTitle()

◆ getReadOnlyReason()

◆ getRootDirectory()

◆ getSharedCacheKey()

◆ getTempHashPath()

◆ getTempRepo()

◆ getThumbProxySecret()

◆ getThumbProxyUrl()

◆ getThumbScriptUrl()

◆ getUploadStash()

◆ getVirtualUrl()

◆ getZoneLocation()

◆ getZonePath()

◆ getZoneUrl()

◆ hasSha1Storage()

◆ initDirectory()

◆ initZones()

◆ invalidateImageRedirect()

◆ isLocal()

◆ isVirtualUrl()

◆ makeUrl()

◆ nameForThumb()

◆ newFatal()

◆ newFile()

◆ newGood()

◆ paranoidClean()

◆ passThrough()

◆ publish()

◆ publishBatch()

◆ quickCleanDir()