MediaWiki REL1_33
RepoGroup.php
Go to the documentation of this file.
1<?php
25
31class RepoGroup {
33 protected $localRepo;
34
36 protected $foreignRepos;
37
39 protected $reposInitialised = false;
40
42 protected $localInfo;
43
45 protected $foreignInfo;
46
48 protected $cache;
49
51 protected static $instance;
52
54 const MAX_CACHE_SIZE = 500;
55
61 static function singleton() {
62 if ( self::$instance ) {
63 return self::$instance;
64 }
67 self::$instance = new RepoGroup( $wgLocalFileRepo, $wgForeignFileRepos );
68
69 return self::$instance;
70 }
71
76 static function destroySingleton() {
77 self::$instance = null;
78 }
79
88 static function setSingleton( $instance ) {
89 self::$instance = $instance;
90 }
91
102 $this->localInfo = $localInfo;
103 $this->foreignInfo = $foreignInfo;
104 $this->cache = new MapCacheLRU( self::MAX_CACHE_SIZE );
105 }
106
123 function findFile( $title, $options = [] ) {
124 if ( !is_array( $options ) ) {
125 // MW 1.15 compat
126 $options = [ 'time' => $options ];
127 }
128 if ( isset( $options['bypassCache'] ) ) {
129 $options['latest'] = $options['bypassCache']; // b/c
130 }
131 $options += [ 'time' => false ];
132
133 if ( !$this->reposInitialised ) {
134 $this->initialiseRepos();
135 }
136
138 if ( !$title ) {
139 return false;
140 }
141
142 # Check the cache
143 $dbkey = $title->getDBkey();
144 $timeKey = is_string( $options['time'] ) ? $options['time'] : '';
145 if ( empty( $options['ignoreRedirect'] )
146 && empty( $options['private'] )
147 && empty( $options['latest'] )
148 ) {
149 if ( $this->cache->hasField( $dbkey, $timeKey, 60 ) ) {
150 return $this->cache->getField( $dbkey, $timeKey );
151 }
152 $useCache = true;
153 } else {
154 $useCache = false;
155 }
156
157 # Check the local repo
158 $image = $this->localRepo->findFile( $title, $options );
159
160 # Check the foreign repos
161 if ( !$image ) {
162 foreach ( $this->foreignRepos as $repo ) {
163 $image = $repo->findFile( $title, $options );
164 if ( $image ) {
165 break;
166 }
167 }
168 }
169
170 $image = $image instanceof File ? $image : false; // type sanity
171 # Cache file existence or non-existence
172 if ( $useCache && ( !$image || $image->isCacheable() ) ) {
173 $this->cache->setField( $dbkey, $timeKey, $image );
174 }
175
176 return $image;
177 }
178
196 function findFiles( array $inputItems, $flags = 0 ) {
197 if ( !$this->reposInitialised ) {
198 $this->initialiseRepos();
199 }
200
201 $items = [];
202 foreach ( $inputItems as $item ) {
203 if ( !is_array( $item ) ) {
204 $item = [ 'title' => $item ];
205 }
206 $item['title'] = File::normalizeTitle( $item['title'] );
207 if ( $item['title'] ) {
208 $items[$item['title']->getDBkey()] = $item;
209 }
210 }
211
212 $images = $this->localRepo->findFiles( $items, $flags );
213
214 foreach ( $this->foreignRepos as $repo ) {
215 // Remove found files from $items
216 foreach ( $images as $name => $image ) {
217 unset( $items[$name] );
218 }
219
220 $images = array_merge( $images, $repo->findFiles( $items, $flags ) );
221 }
222
223 return $images;
224 }
225
231 function checkRedirect( Title $title ) {
232 if ( !$this->reposInitialised ) {
233 $this->initialiseRepos();
234 }
235
236 $redir = $this->localRepo->checkRedirect( $title );
237 if ( $redir ) {
238 return $redir;
239 }
240
241 foreach ( $this->foreignRepos as $repo ) {
242 $redir = $repo->checkRedirect( $title );
243 if ( $redir ) {
244 return $redir;
245 }
246 }
247
248 return false;
249 }
250
259 function findFileFromKey( $hash, $options = [] ) {
260 if ( !$this->reposInitialised ) {
261 $this->initialiseRepos();
262 }
263
264 $file = $this->localRepo->findFileFromKey( $hash, $options );
265 if ( !$file ) {
266 foreach ( $this->foreignRepos as $repo ) {
267 $file = $repo->findFileFromKey( $hash, $options );
268 if ( $file ) {
269 break;
270 }
271 }
272 }
273
274 return $file;
275 }
276
283 function findBySha1( $hash ) {
284 if ( !$this->reposInitialised ) {
285 $this->initialiseRepos();
286 }
287
288 $result = $this->localRepo->findBySha1( $hash );
289 foreach ( $this->foreignRepos as $repo ) {
290 $result = array_merge( $result, $repo->findBySha1( $hash ) );
291 }
292 usort( $result, 'File::compare' );
293
294 return $result;
295 }
296
304 if ( !$this->reposInitialised ) {
305 $this->initialiseRepos();
306 }
307
308 $result = $this->localRepo->findBySha1s( $hashes );
309 foreach ( $this->foreignRepos as $repo ) {
310 $result = array_merge_recursive( $result, $repo->findBySha1s( $hashes ) );
311 }
312 // sort the merged (and presorted) sublist of each hash
313 foreach ( $result as $hash => $files ) {
314 usort( $result[$hash], 'File::compare' );
315 }
316
317 return $result;
318 }
319
325 function getRepo( $index ) {
326 if ( !$this->reposInitialised ) {
327 $this->initialiseRepos();
328 }
329 if ( $index === 'local' ) {
330 return $this->localRepo;
331 }
332 return $this->foreignRepos[$index] ?? false;
333 }
334
340 function getRepoByName( $name ) {
341 if ( !$this->reposInitialised ) {
342 $this->initialiseRepos();
343 }
344 foreach ( $this->foreignRepos as $repo ) {
345 if ( $repo->name == $name ) {
346 return $repo;
347 }
348 }
349
350 return false;
351 }
352
359 function getLocalRepo() {
361 $repo = $this->getRepo( 'local' );
362
363 return $repo;
364 }
365
374 function forEachForeignRepo( $callback, $params = [] ) {
375 if ( !$this->reposInitialised ) {
376 $this->initialiseRepos();
377 }
378 foreach ( $this->foreignRepos as $repo ) {
379 if ( $callback( $repo, ...$params ) ) {
380 return true;
381 }
382 }
383
384 return false;
385 }
386
391 function hasForeignRepos() {
392 if ( !$this->reposInitialised ) {
393 $this->initialiseRepos();
394 }
395 return (bool)$this->foreignRepos;
396 }
397
401 function initialiseRepos() {
402 if ( $this->reposInitialised ) {
403 return;
404 }
405 $this->reposInitialised = true;
406
407 $this->localRepo = $this->newRepo( $this->localInfo );
408 $this->foreignRepos = [];
409 foreach ( $this->foreignInfo as $key => $info ) {
410 $this->foreignRepos[$key] = $this->newRepo( $info );
411 }
412 }
413
419 protected function newRepo( $info ) {
420 $class = $info['class'];
421
422 $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
423 $info['wanCache'] = $cache;
424
425 return new $class( $info );
426 }
427
434 function splitVirtualUrl( $url ) {
435 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
436 throw new MWException( __METHOD__ . ': unknown protocol' );
437 }
438
439 $bits = explode( '/', substr( $url, 9 ), 3 );
440 if ( count( $bits ) != 3 ) {
441 throw new MWException( __METHOD__ . ": invalid mwrepo URL: $url" );
442 }
443
444 return $bits;
445 }
446
451 function getFileProps( $fileName ) {
452 if ( FileRepo::isVirtualUrl( $fileName ) ) {
453 list( $repoName, /* $zone */, /* $rel */ ) = $this->splitVirtualUrl( $fileName );
454 if ( $repoName === '' ) {
455 $repoName = 'local';
456 }
457 $repo = $this->getRepo( $repoName );
458
459 return $repo->getFileProps( $fileName );
460 } else {
461 $mwProps = new MWFileProps( MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer() );
462
463 return $mwProps->getPropsFromPath( $fileName, true );
464 }
465 }
466
471 public function clearCache( Title $title = null ) {
472 if ( $title == null ) {
473 $this->cache->clear();
474 } else {
475 $this->cache->clear( $title->getDBkey() );
476 }
477 }
478}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
$wgLocalFileRepo
File repository structures.
$wgForeignFileRepos
Enable the use of files from one or more other wikis.
Base class for file repositories.
Definition FileRepo.php:39
static isVirtualUrl( $url)
Determine if a string is an mwrepo:// URL.
Definition FileRepo.php:254
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition File.php:52
static normalizeTitle( $title, $exception=false)
Given a string or Title object return either a valid Title object with namespace NS_FILE or null.
Definition File.php:185
A repository that stores files in the local filesystem and registers them in the wiki's own database.
Definition LocalRepo.php:36
MediaWiki exception.
MimeMagic helper wrapper.
Handles a simple LRU key/value map with a maximum number of entries.
MediaWikiServices is the service locator for the application scope of MediaWiki.
Class for process caching individual properties of expiring items.
Prioritized list of file repositories.
Definition RepoGroup.php:31
initialiseRepos()
Initialise the $repos array.
getRepoByName( $name)
Get the repo instance by its name.
array $foreignInfo
Definition RepoGroup.php:45
splitVirtualUrl( $url)
Split a virtual URL into repo, zone and rel parts.
const MAX_CACHE_SIZE
Maximum number of cache items.
Definition RepoGroup.php:54
hasForeignRepos()
Does the installation have any foreign repos set up?
findFileFromKey( $hash, $options=[])
Find an instance of the file with this key, created at the specified time Returns false if the file d...
bool $reposInitialised
Definition RepoGroup.php:39
__construct( $localInfo, $foreignInfo)
Construct a group of file repositories.
findFile( $title, $options=[])
Search repositories for an image.
ProcessCacheLRU $cache
Definition RepoGroup.php:48
getLocalRepo()
Get the local repository, i.e.
FileRepo[] $foreignRepos
Definition RepoGroup.php:36
findBySha1s(array $hashes)
Find all instances of files with this keys.
checkRedirect(Title $title)
Interface for FileRepo::checkRedirect()
static RepoGroup $instance
Definition RepoGroup.php:51
getRepo( $index)
Get the repo instance with a given key.
LocalRepo $localRepo
Definition RepoGroup.php:33
clearCache(Title $title=null)
Clear RepoGroup process cache used for finding a file.
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:61
findBySha1( $hash)
Find all instances of files with this key.
findFiles(array $inputItems, $flags=0)
Search repositories for many files at once.
static setSingleton( $instance)
Set the singleton instance to a given object Used by extensions which hook into the Repo chain.
Definition RepoGroup.php:88
newRepo( $info)
Create a repo class based on an info structure.
array $localInfo
Definition RepoGroup.php:42
getFileProps( $fileName)
static destroySingleton()
Destroy the singleton instance, so that a new one will be created next time singleton() is called.
Definition RepoGroup.php:76
forEachForeignRepo( $callback, $params=[])
Call a function for each foreign repo, with the repo object as the first parameter.
Represents a title within MediaWiki.
Definition Title.php:40
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image
Definition hooks.txt:886
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1991
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition hooks.txt:1999
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:955
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:271
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
you have access to all of the normal MediaWiki so you can get a DB use the cache
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
A helper class for throttling authentication attempts.
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition router.php:42
$params