Prioritized list of file repositories. More...

Collaboration diagram for RepoGroup:

[legend]

Public Member Functions
	__construct ( $localInfo, $foreignInfo)
	Construct a group of file repositories.

	checkRedirect (Title $title)
	Interface for FileRepo::checkRedirect()

	clearCache (Title $title=null)
	Clear RepoGroup process cache used for finding a file.

	findBySha1 ( $hash)
	Find all instances of files with this key.

	findBySha1s (array $hashes)
	Find all instances of files with this keys.

	findFile ( $title, $options=[])
	Search repositories for an image.

	findFileFromKey ( $hash, $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 $inputItems, $flags=0)
	Search repositories for many files at once.

	forEachForeignRepo ( $callback, $params=[])
	Call a function for each foreign repo, with the repo object as the first parameter.

	getFileProps ( $fileName)

	getLocalRepo ()
	Get the local repository, i.e.

	getRepo ( $index)
	Get the repo instance with a given key.

	getRepoByName ( $name)
	Get the repo instance by its name.

	hasForeignRepos ()
	Does the installation have any foreign repos set up?

	initialiseRepos ()
	Initialise the $repos array.

	splitVirtualUrl ( $url)
	Split a virtual URL into repo, zone and rel parts.

Static Public Member Functions
static	destroySingleton ()
	Destroy the singleton instance, so that a new one will be created next time singleton() is called.

static	setSingleton ( $instance)
	Set the singleton instance to a given object Used by extensions which hook into the Repo chain.

static	singleton ()
	Get a RepoGroup instance.

Public Attributes
const	MAX_CACHE_SIZE = 500
	Maximum number of cache items.

Protected Member Functions
	newRepo ( $info)
	Create a repo class based on an info structure.

Protected Attributes
ProcessCacheLRU	$cache

array	$foreignInfo

FileRepo[]	$foreignRepos

array	$localInfo

LocalRepo	$localRepo

bool	$reposInitialised = false

Static Protected Attributes
static RepoGroup	$instance

Detailed Description

Prioritized list of file repositories.

Definition at line 29 of file RepoGroup.php.

Constructor & Destructor Documentation

◆ __construct()

RepoGroup::__construct	(		$localInfo,
			$foreignInfo )

Construct a group of file repositories.

Parameters

array	$localInfo	Associative array for local repo's info
array	$foreignInfo	Array of repository info arrays. Each info array is an associative array with the 'class' member giving the class name. The entire array is passed to the repository constructor as the first parameter.

Definition at line 98 of file RepoGroup.php.

References $foreignInfo, $localInfo, and cache.

Member Function Documentation

◆ checkRedirect()

RepoGroup::checkRedirect ( Title $title )

Interface for FileRepo::checkRedirect()

Parameters

Title $title

Returns: bool|Title

Definition at line 227 of file RepoGroup.php.

References initialiseRepos().

◆ clearCache()

RepoGroup::clearCache ( Title $title = null )

Clear RepoGroup process cache used for finding a file.

Parameters

Title | null $title Title of the file or null to clear all files

Definition at line 465 of file RepoGroup.php.

References cache.

◆ destroySingleton()

static RepoGroup::destroySingleton ( )

static

Destroy the singleton instance, so that a new one will be created next time singleton() is called.

Definition at line 73 of file RepoGroup.php.

Referenced by UploadFromUrlTestSuite\setUp(), RepoGroupTest\setUpForeignRepo(), ParserTestRunner\staticSetup(), UploadFromUrlTestSuite\tearDown(), RepoGroupTest\testForEachForeignRepoNone(), and RepoGroupTest\testHasForeignRepoNegative().

◆ findBySha1()

RepoGroup::findBySha1 ( $hash )

Find all instances of files with this key.

Parameters

string $hash Base 36 SHA-1 hash

Returns: File[]

Definition at line 279 of file RepoGroup.php.

References $result, and initialiseRepos().

◆ findBySha1s()

RepoGroup::findBySha1s ( array $hashes )

Find all instances of files with this keys.

Parameters

array $hashes Base 36 SHA-1 hashes

Returns: array Array of array of File objects

Definition at line 299 of file RepoGroup.php.

References $hashes, $result, and initialiseRepos().

◆ findFile()

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

Search repositories for an image.

You can also use wfFindFile() to do this.

Parameters

Title \| string	$title	Title object or string
array	$options	Associative array of options: time: requested time for an archived image, or false for the current version. An image object will be returned which was created at the specified time. ignoreRedirect: If true, do not follow file redirects private: If true, return restricted (deleted) files if the current user is allowed to view them. Otherwise, such files will not be found. latest: If true, load from the latest available data into File objects

Returns: File|bool False if title is not found

Definition at line 120 of file RepoGroup.php.

References $image, $options, $time, cache, initialiseRepos(), and File\normalizeTitle().

◆ findFileFromKey()

RepoGroup::findFileFromKey	(		$hash,
			$options = [] )

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

Parameters

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

Returns: File|bool File object or false if it is not found

Definition at line 255 of file RepoGroup.php.

References $options, and initialiseRepos().

◆ findFiles()

RepoGroup::findFiles	(	array	$inputItems,
			$flags = 0 )

Search repositories for many files at once.

Parameters

array $inputItems 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

Definition at line 192 of file RepoGroup.php.

References $flags, $image, initialiseRepos(), and File\normalizeTitle().

◆ forEachForeignRepo()

RepoGroup::forEachForeignRepo	(		$callback,
			$params = [] )

Call a function for each foreign repo, with the repo object as the first parameter.

Parameters

callable	$callback	The function to call
array	$params	Optional additional parameters to pass to the function

Returns: bool

Definition at line 370 of file RepoGroup.php.

References $args, $params, and initialiseRepos().

◆ getFileProps()

RepoGroup::getFileProps ( $fileName )

Parameters

string $fileName

Returns: array

Definition at line 445 of file RepoGroup.php.

References getRepo(), FileRepo\isVirtualUrl(), list, MimeMagic\singleton(), and splitVirtualUrl().

◆ getLocalRepo()

RepoGroup::getLocalRepo ( )

Get the local repository, i.e.

the one corresponding to the local image table. Files are typically uploaded to the local repository.

Returns: LocalRepo

Definition at line 358 of file RepoGroup.php.

References getRepo().

◆ getRepo()

RepoGroup::getRepo ( $index )

Get the repo instance with a given key.

Parameters

string | int $index

Returns: bool|LocalRepo

Definition at line 321 of file RepoGroup.php.

References $localRepo, and initialiseRepos().

Referenced by getFileProps(), and getLocalRepo().

◆ getRepoByName()

RepoGroup::getRepoByName ( $name )

Get the repo instance by its name.

Parameters

string $name

Returns: FileRepo|bool

Definition at line 339 of file RepoGroup.php.

References initialiseRepos().

◆ hasForeignRepos()

RepoGroup::hasForeignRepos ( )

Does the installation have any foreign repos set up?

Returns: bool

Definition at line 388 of file RepoGroup.php.

References $foreignRepos, and initialiseRepos().

◆ initialiseRepos()

RepoGroup::initialiseRepos ( )

Initialise the $repos array.

Definition at line 398 of file RepoGroup.php.

References newRepo().

Referenced by checkRedirect(), findBySha1(), findBySha1s(), findFile(), findFileFromKey(), findFiles(), forEachForeignRepo(), getRepo(), getRepoByName(), and hasForeignRepos().

◆ newRepo()

RepoGroup::newRepo ( $info )

protected

Create a repo class based on an info structure.

Parameters

array $info

Returns: FileRepo

Definition at line 416 of file RepoGroup.php.

Referenced by initialiseRepos().

◆ setSingleton()

static RepoGroup::setSingleton ( $instance )

static

Set the singleton instance to a given object Used by extensions which hook into the Repo chain.

It's not enough to just create a superclass ... you have to get people to call into it even though all they know is RepoGroup::singleton()

Parameters

RepoGroup $instance

Definition at line 85 of file RepoGroup.php.

References $instance.

Referenced by ParserTestRunner\staticSetup().

◆ singleton()

static RepoGroup::singleton ( )

static

Get a RepoGroup instance.

At present only one instance of RepoGroup is needed in a MediaWiki invocation, this may change in the future.

Returns: RepoGroup

Definition at line 59 of file RepoGroup.php.

References $instance, $wgForeignFileRepos, and $wgLocalFileRepo.

Referenced by RevDelArchivedFileItem\__construct(), RevDelFileItem\__construct(), UploadFromStash\__construct(), ApiQueryAllImages\__construct(), UploadFromChunks\__construct(), ParserTestRunner\addArticle(), UploadBase\checkAgainstExistingDupes(), RevertAction\checkCanExecute(), ApiDelete\deleteFile(), ApiTestCaseUpload\deleteFileByContent(), ParserTestRunner\deleteFiles(), RevDelFileList\doPreCommitUpdates(), UploadBase\doStashFile(), MovePageForm\doSubmit(), SpecialUploadStash\execute(), ApiMove\execute(), ApiQueryImageInfo\execute(), ApiQueryStashImageInfo\execute(), FileDeleteForm\execute(), LocalFileRestoreBatch\execute(), CheckImages\execute(), UploadStashCleanup\execute(), DeleteArchivedFiles\execute(), FindMissingFiles\execute(), FindOrphanedFiles\execute(), RefreshFileHeaders\execute(), RefreshImageMetadata\execute(), Parser\fetchFileNoRegister(), ImageCleanup\filePath(), ImageListPager\formatValue(), UploadForm\getDescriptionSection(), FileDuplicateSearchPage\getDupes(), WikiFilePage\getDuplicates(), ApiQueryFileRepoInfo\getInitialisedRepoGroup(), UploadBase\getRealPath(), MigrateFileRepoLayout\getRepo(), ImageBuilder\getRepo(), UploadBase\getTitle(), WikiRevision\importUpload(), WantedFilesPage\likelyToHaveFalsePositives(), Linker\makeBrokenImageLinkObj(), MovePage\move(), WikiPage\onArticleDelete(), PurgeChangedFiles\purgeFromLogType(), ApiQueryDuplicateFiles\run(), EraseArchivedFile\scrubVersion(), DatabaseUpdater\setFileAccess(), ParserTestRunner\setupUploadBackend(), SpecialUndelete\showFile(), ParserTestRunner\teardownUploadBackend(), UploadStashTest\testBug29408(), RepoGroupTest\testForEachForeignRepo(), RepoGroupTest\testForEachForeignRepoNone(), RepoGroupTest\testHasForeignRepoNegative(), RepoGroupTest\testHasForeignRepoPositive(), SpecialUploadStash\tryClearStashedUploads(), SpecialRevisionDelete\tryShowFile(), WikiPage\updateRedirectOn(), ApiFileRevert\validateParameters(), wfExtractThumbRequestInfo(), wfFindFile(), wfLocalFile(), wfStreamThumb(), and wfThumbHandle404().

◆ splitVirtualUrl()

RepoGroup::splitVirtualUrl ( $url )

Split a virtual URL into repo, zone and rel parts.

Parameters

string $url

Exceptions

MWException

Returns: array Containing repo, zone and rel

Definition at line 428 of file RepoGroup.php.

Referenced by getFileProps().

Member Data Documentation

◆ $cache

ProcessCacheLRU RepoGroup::$cache

protected

Definition at line 46 of file RepoGroup.php.

◆ $foreignInfo

array RepoGroup::$foreignInfo

protected

Definition at line 43 of file RepoGroup.php.

Referenced by __construct().

◆ $foreignRepos

FileRepo [] RepoGroup::$foreignRepos

protected

Definition at line 34 of file RepoGroup.php.

Referenced by hasForeignRepos().

◆ $instance

RepoGroup RepoGroup::$instance

staticprotected

Definition at line 49 of file RepoGroup.php.

Referenced by setSingleton(), and singleton().

◆ $localInfo

array RepoGroup::$localInfo

protected

Definition at line 40 of file RepoGroup.php.

Referenced by __construct().

◆ $localRepo

LocalRepo RepoGroup::$localRepo

protected

Definition at line 31 of file RepoGroup.php.

Referenced by getRepo().

◆ $reposInitialised

bool RepoGroup::$reposInitialised = false

protected

Definition at line 37 of file RepoGroup.php.

◆ MAX_CACHE_SIZE

const RepoGroup::MAX_CACHE_SIZE = 500

Maximum number of cache items.

Definition at line 52 of file RepoGroup.php.

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

includes/filerepo/RepoGroup.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkRedirect()

◆ clearCache()

◆ destroySingleton()

◆ findBySha1()

◆ findBySha1s()

◆ findFile()

◆ findFileFromKey()

◆ findFiles()

◆ forEachForeignRepo()

◆ getFileProps()

◆ getLocalRepo()

◆ getRepo()

◆ getRepoByName()

◆ hasForeignRepos()

◆ initialiseRepos()

◆ newRepo()

◆ setSingleton()

◆ singleton()

◆ splitVirtualUrl()

Member Data Documentation

◆ $cache

◆ $foreignInfo

◆ $foreignRepos

◆ $instance

◆ $localInfo

◆ $localRepo

◆ $reposInitialised

◆ MAX_CACHE_SIZE