3 * Prioritized list of file repositories.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 use MediaWiki\MediaWikiServices
;
27 * Prioritized list of file repositories
35 /** @var FileRepo[] */
36 protected $foreignRepos;
38 /** @var WANObjectCache */
42 protected $reposInitialised = false;
48 protected $foreignInfo;
50 /** @var MapCacheLRU */
53 /** Maximum number of cache items */
54 const MAX_CACHE_SIZE
= 500;
57 * @deprecated since 1.34, use MediaWikiServices::getRepoGroup
60 static function singleton() {
61 return MediaWikiServices
::getInstance()->getRepoGroup();
65 * @deprecated since 1.34, use MediaWikiTestCase::overrideMwServices() or similar. This will
66 * cause bugs if you don't reset all other services that depend on this one at the same time.
68 static function destroySingleton() {
69 MediaWikiServices
::getInstance()->resetServiceForTesting( 'RepoGroup' );
73 * @deprecated since 1.34, use MediaWikiTestCase::setService, this can mess up state of other
75 * @param RepoGroup $instance
77 static function setSingleton( $instance ) {
78 $services = MediaWikiServices
::getInstance();
79 $services->disableService( 'RepoGroup' );
80 $services->redefineService( 'RepoGroup',
81 function () use ( $instance ) {
88 * Construct a group of file repositories. Do not call this -- use
89 * MediaWikiServices::getRepoGroup.
91 * @param array $localInfo Associative array for local repo's info
92 * @param array $foreignInfo Array of repository info arrays.
93 * Each info array is an associative array with the 'class' member
94 * giving the class name. The entire array is passed to the repository
95 * constructor as the first parameter.
96 * @param WANObjectCache $wanCache
98 function __construct( $localInfo, $foreignInfo, $wanCache ) {
99 $this->localInfo
= $localInfo;
100 $this->foreignInfo
= $foreignInfo;
101 $this->cache
= new MapCacheLRU( self
::MAX_CACHE_SIZE
);
102 $this->wanCache
= $wanCache;
106 * Search repositories for an image.
108 * @param Title|string $title Title object or string
109 * @param array $options Associative array of options:
110 * time: requested time for an archived image, or false for the
111 * current version. An image object will be returned which was
112 * created at the specified time.
113 * ignoreRedirect: If true, do not follow file redirects
114 * private: If true, return restricted (deleted) files if the current
115 * user is allowed to view them. Otherwise, such files will not
117 * latest: If true, load from the latest available data into File objects
118 * @phan-param array{time?:mixed,ignoreRedirect?:bool,private?:bool,latest?:bool} $options
119 * @suppress PhanTypeInvalidDimOffset
120 * @return File|bool False if title is not found
122 function findFile( $title, $options = [] ) {
123 if ( !is_array( $options ) ) {
125 $options = [ 'time' => $options ];
127 if ( isset( $options['bypassCache'] ) ) {
128 $options['latest'] = $options['bypassCache']; // b/c
130 $options +
= [ 'time' => false ];
132 if ( !$this->reposInitialised
) {
133 $this->initialiseRepos();
136 $title = File
::normalizeTitle( $title );
142 $dbkey = $title->getDBkey();
143 $timeKey = is_string( $options['time'] ) ?
$options['time'] : '';
144 if ( empty( $options['ignoreRedirect'] )
145 && empty( $options['private'] )
146 && empty( $options['latest'] )
148 if ( $this->cache
->hasField( $dbkey, $timeKey, 60 ) ) {
149 return $this->cache
->getField( $dbkey, $timeKey );
156 # Check the local repo
157 $image = $this->localRepo
->findFile( $title, $options );
159 # Check the foreign repos
161 foreach ( $this->foreignRepos
as $repo ) {
162 $image = $repo->findFile( $title, $options );
169 $image = $image instanceof File ?
$image : false; // type sanity
170 # Cache file existence or non-existence
171 if ( $useCache && ( !$image ||
$image->isCacheable() ) ) {
172 $this->cache
->setField( $dbkey, $timeKey, $image );
179 * Search repositories for many files at once.
181 * @param array $inputItems An array of titles, or an array of findFile() options with
182 * the "title" option giving the title. Example:
184 * $findItem = [ 'title' => $title, 'private' => true ];
185 * $findBatch = [ $findItem ];
186 * $repo->findFiles( $findBatch );
188 * No title should appear in $items twice, as the result use titles as keys
189 * @param int $flags Supports:
190 * - FileRepo::NAME_AND_TIME_ONLY : return a (search title => (title,timestamp)) map.
191 * The search title uses the input titles; the other is the final post-redirect title.
192 * All titles are returned as string DB keys and the inner array is associative.
193 * @return array Map of (file name => File objects) for matches
195 function findFiles( array $inputItems, $flags = 0 ) {
196 if ( !$this->reposInitialised
) {
197 $this->initialiseRepos();
201 foreach ( $inputItems as $item ) {
202 if ( !is_array( $item ) ) {
203 $item = [ 'title' => $item ];
205 $item['title'] = File
::normalizeTitle( $item['title'] );
206 if ( $item['title'] ) {
207 $items[$item['title']->getDBkey()] = $item;
211 $images = $this->localRepo
->findFiles( $items, $flags );
213 foreach ( $this->foreignRepos
as $repo ) {
214 // Remove found files from $items
215 foreach ( $images as $name => $image ) {
216 unset( $items[$name] );
219 $images = array_merge( $images, $repo->findFiles( $items, $flags ) );
226 * Interface for FileRepo::checkRedirect()
227 * @param Title $title
230 function checkRedirect( Title
$title ) {
231 if ( !$this->reposInitialised
) {
232 $this->initialiseRepos();
235 $redir = $this->localRepo
->checkRedirect( $title );
240 foreach ( $this->foreignRepos
as $repo ) {
241 $redir = $repo->checkRedirect( $title );
251 * Find an instance of the file with this key, created at the specified time
252 * Returns false if the file does not exist.
254 * @param string $hash Base 36 SHA-1 hash
255 * @param array $options Option array, same as findFile()
256 * @return File|bool File object or false if it is not found
258 function findFileFromKey( $hash, $options = [] ) {
259 if ( !$this->reposInitialised
) {
260 $this->initialiseRepos();
263 $file = $this->localRepo
->findFileFromKey( $hash, $options );
265 foreach ( $this->foreignRepos
as $repo ) {
266 $file = $repo->findFileFromKey( $hash, $options );
277 * Find all instances of files with this key
279 * @param string $hash Base 36 SHA-1 hash
282 function findBySha1( $hash ) {
283 if ( !$this->reposInitialised
) {
284 $this->initialiseRepos();
287 $result = $this->localRepo
->findBySha1( $hash );
288 foreach ( $this->foreignRepos
as $repo ) {
289 $result = array_merge( $result, $repo->findBySha1( $hash ) );
291 usort( $result, 'File::compare' );
297 * Find all instances of files with this keys
299 * @param array $hashes Base 36 SHA-1 hashes
300 * @return array Array of array of File objects
302 function findBySha1s( array $hashes ) {
303 if ( !$this->reposInitialised
) {
304 $this->initialiseRepos();
307 $result = $this->localRepo
->findBySha1s( $hashes );
308 foreach ( $this->foreignRepos
as $repo ) {
309 $result = array_merge_recursive( $result, $repo->findBySha1s( $hashes ) );
311 // sort the merged (and presorted) sublist of each hash
312 foreach ( $result as $hash => $files ) {
313 usort( $result[$hash], 'File::compare' );
320 * Get the repo instance with a given key.
321 * @param string|int $index
322 * @return bool|FileRepo
324 function getRepo( $index ) {
325 if ( !$this->reposInitialised
) {
326 $this->initialiseRepos();
328 if ( $index === 'local' ) {
329 return $this->localRepo
;
331 return $this->foreignRepos
[$index] ??
false;
335 * Get the repo instance by its name
336 * @param string $name
337 * @return FileRepo|bool
339 function getRepoByName( $name ) {
340 if ( !$this->reposInitialised
) {
341 $this->initialiseRepos();
343 foreach ( $this->foreignRepos
as $repo ) {
344 if ( $repo->name
== $name ) {
353 * Get the local repository, i.e. the one corresponding to the local image
354 * table. Files are typically uploaded to the local repository.
358 function getLocalRepo() {
359 /** @var LocalRepo $repo */
360 $repo = $this->getRepo( 'local' );
366 * Call a function for each foreign repo, with the repo object as the
369 * @param callable $callback The function to call
370 * @param array $params Optional additional parameters to pass to the function
373 function forEachForeignRepo( $callback, $params = [] ) {
374 if ( !$this->reposInitialised
) {
375 $this->initialiseRepos();
377 foreach ( $this->foreignRepos
as $repo ) {
378 if ( $callback( $repo, ...$params ) ) {
387 * Does the installation have any foreign repos set up?
390 function hasForeignRepos() {
391 if ( !$this->reposInitialised
) {
392 $this->initialiseRepos();
394 return (bool)$this->foreignRepos
;
398 * Initialise the $repos array
400 function initialiseRepos() {
401 if ( $this->reposInitialised
) {
404 $this->reposInitialised
= true;
406 $this->localRepo
= $this->newRepo( $this->localInfo
);
407 $this->foreignRepos
= [];
408 foreach ( $this->foreignInfo
as $key => $info ) {
409 $this->foreignRepos
[$key] = $this->newRepo( $info );
414 * Create a repo class based on an info structure
418 protected function newRepo( $info ) {
419 $class = $info['class'];
421 $info['wanCache'] = $this->wanCache
;
423 return new $class( $info );
427 * Split a virtual URL into repo, zone and rel parts
429 * @throws MWException
430 * @return string[] Containing repo, zone and rel
432 function splitVirtualUrl( $url ) {
433 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
434 throw new MWException( __METHOD__
. ': unknown protocol' );
437 $bits = explode( '/', substr( $url, 9 ), 3 );
438 if ( count( $bits ) != 3 ) {
439 throw new MWException( __METHOD__
. ": invalid mwrepo URL: $url" );
446 * @param string $fileName
449 function getFileProps( $fileName ) {
450 if ( FileRepo
::isVirtualUrl( $fileName ) ) {
451 list( $repoName, /* $zone */, /* $rel */ ) = $this->splitVirtualUrl( $fileName );
452 if ( $repoName === '' ) {
455 $repo = $this->getRepo( $repoName );
457 return $repo->getFileProps( $fileName );
459 $mwProps = new MWFileProps( MediaWiki\MediaWikiServices
::getInstance()->getMimeAnalyzer() );
461 return $mwProps->getPropsFromPath( $fileName, true );
466 * Clear RepoGroup process cache used for finding a file
467 * @param Title|null $title Title of the file or null to clear all files
469 public function clearCache( Title
$title = null ) {
470 if ( $title == null ) {
471 $this->cache
->clear();
473 $this->cache
->clear( $title->getDBkey() );