MediaWiki  REL1_31
RepoGroup.php
Go to the documentation of this file.
1 <?php
29 class RepoGroup {
31  protected $localRepo;
32 
34  protected $foreignRepos;
35 
37  protected $reposInitialised = false;
38 
40  protected $localInfo;
41 
43  protected $foreignInfo;
44 
46  protected $cache;
47 
49  protected static $instance;
50 
52  const MAX_CACHE_SIZE = 500;
53 
59  static function singleton() {
60  if ( self::$instance ) {
61  return self::$instance;
62  }
64  self::$instance = new RepoGroup( $wgLocalFileRepo, $wgForeignFileRepos );
65 
66  return self::$instance;
67  }
68 
73  static function destroySingleton() {
74  self::$instance = null;
75  }
76 
85  static function setSingleton( $instance ) {
86  self::$instance = $instance;
87  }
88 
99  $this->localInfo = $localInfo;
100  $this->foreignInfo = $foreignInfo;
101  $this->cache = new ProcessCacheLRU( self::MAX_CACHE_SIZE );
102  }
103 
120  function findFile( $title, $options = [] ) {
121  if ( !is_array( $options ) ) {
122  // MW 1.15 compat
123  $options = [ 'time' => $options ];
124  }
125  if ( isset( $options['bypassCache'] ) ) {
126  $options['latest'] = $options['bypassCache']; // b/c
127  }
128 
129  if ( !$this->reposInitialised ) {
130  $this->initialiseRepos();
131  }
133  if ( !$title ) {
134  return false;
135  }
136 
137  # Check the cache
138  $dbkey = $title->getDBkey();
139  if ( empty( $options['ignoreRedirect'] )
140  && empty( $options['private'] )
141  && empty( $options['latest'] )
142  ) {
143  $time = isset( $options['time'] ) ? $options['time'] : '';
144  if ( $this->cache->has( $dbkey, $time, 60 ) ) {
145  return $this->cache->get( $dbkey, $time );
146  }
147  $useCache = true;
148  } else {
149  $time = false;
150  $useCache = false;
151  }
152 
153  # Check the local repo
154  $image = $this->localRepo->findFile( $title, $options );
155 
156  # Check the foreign repos
157  if ( !$image ) {
158  foreach ( $this->foreignRepos as $repo ) {
159  $image = $repo->findFile( $title, $options );
160  if ( $image ) {
161  break;
162  }
163  }
164  }
165 
166  $image = $image ? $image : false; // type sanity
167  # Cache file existence or non-existence
168  if ( $useCache && ( !$image || $image->isCacheable() ) ) {
169  $this->cache->set( $dbkey, $time, $image );
170  }
171 
172  return $image;
173  }
174 
192  function findFiles( array $inputItems, $flags = 0 ) {
193  if ( !$this->reposInitialised ) {
194  $this->initialiseRepos();
195  }
196 
197  $items = [];
198  foreach ( $inputItems as $item ) {
199  if ( !is_array( $item ) ) {
200  $item = [ 'title' => $item ];
201  }
202  $item['title'] = File::normalizeTitle( $item['title'] );
203  if ( $item['title'] ) {
204  $items[$item['title']->getDBkey()] = $item;
205  }
206  }
207 
208  $images = $this->localRepo->findFiles( $items, $flags );
209 
210  foreach ( $this->foreignRepos as $repo ) {
211  // Remove found files from $items
212  foreach ( $images as $name => $image ) {
213  unset( $items[$name] );
214  }
215 
216  $images = array_merge( $images, $repo->findFiles( $items, $flags ) );
217  }
218 
219  return $images;
220  }
221 
227  function checkRedirect( Title $title ) {
228  if ( !$this->reposInitialised ) {
229  $this->initialiseRepos();
230  }
231 
232  $redir = $this->localRepo->checkRedirect( $title );
233  if ( $redir ) {
234  return $redir;
235  }
236 
237  foreach ( $this->foreignRepos as $repo ) {
238  $redir = $repo->checkRedirect( $title );
239  if ( $redir ) {
240  return $redir;
241  }
242  }
243 
244  return false;
245  }
246 
255  function findFileFromKey( $hash, $options = [] ) {
256  if ( !$this->reposInitialised ) {
257  $this->initialiseRepos();
258  }
259 
260  $file = $this->localRepo->findFileFromKey( $hash, $options );
261  if ( !$file ) {
262  foreach ( $this->foreignRepos as $repo ) {
263  $file = $repo->findFileFromKey( $hash, $options );
264  if ( $file ) {
265  break;
266  }
267  }
268  }
269 
270  return $file;
271  }
272 
279  function findBySha1( $hash ) {
280  if ( !$this->reposInitialised ) {
281  $this->initialiseRepos();
282  }
283 
284  $result = $this->localRepo->findBySha1( $hash );
285  foreach ( $this->foreignRepos as $repo ) {
286  $result = array_merge( $result, $repo->findBySha1( $hash ) );
287  }
288  usort( $result, 'File::compare' );
289 
290  return $result;
291  }
292 
299  function findBySha1s( array $hashes ) {
300  if ( !$this->reposInitialised ) {
301  $this->initialiseRepos();
302  }
303 
304  $result = $this->localRepo->findBySha1s( $hashes );
305  foreach ( $this->foreignRepos as $repo ) {
306  $result = array_merge_recursive( $result, $repo->findBySha1s( $hashes ) );
307  }
308  // sort the merged (and presorted) sublist of each hash
309  foreach ( $result as $hash => $files ) {
310  usort( $result[$hash], 'File::compare' );
311  }
312 
313  return $result;
314  }
315 
321  function getRepo( $index ) {
322  if ( !$this->reposInitialised ) {
323  $this->initialiseRepos();
324  }
325  if ( $index === 'local' ) {
326  return $this->localRepo;
327  } elseif ( isset( $this->foreignRepos[$index] ) ) {
328  return $this->foreignRepos[$index];
329  } else {
330  return false;
331  }
332  }
333 
339  function getRepoByName( $name ) {
340  if ( !$this->reposInitialised ) {
341  $this->initialiseRepos();
342  }
343  foreach ( $this->foreignRepos as $repo ) {
344  if ( $repo->name == $name ) {
345  return $repo;
346  }
347  }
348 
349  return false;
350  }
351 
358  function getLocalRepo() {
359  return $this->getRepo( 'local' );
360  }
361 
370  function forEachForeignRepo( $callback, $params = [] ) {
371  if ( !$this->reposInitialised ) {
372  $this->initialiseRepos();
373  }
374  foreach ( $this->foreignRepos as $repo ) {
375  $args = array_merge( [ $repo ], $params );
376  if ( call_user_func_array( $callback, $args ) ) {
377  return true;
378  }
379  }
380 
381  return false;
382  }
383 
388  function hasForeignRepos() {
389  if ( !$this->reposInitialised ) {
390  $this->initialiseRepos();
391  }
392  return (bool)$this->foreignRepos;
393  }
394 
398  function initialiseRepos() {
399  if ( $this->reposInitialised ) {
400  return;
401  }
402  $this->reposInitialised = true;
403 
404  $this->localRepo = $this->newRepo( $this->localInfo );
405  $this->foreignRepos = [];
406  foreach ( $this->foreignInfo as $key => $info ) {
407  $this->foreignRepos[$key] = $this->newRepo( $info );
408  }
409  }
410 
416  protected function newRepo( $info ) {
417  $class = $info['class'];
418 
419  return new $class( $info );
420  }
421 
428  function splitVirtualUrl( $url ) {
429  if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
430  throw new MWException( __METHOD__ . ': unknown protocol' );
431  }
432 
433  $bits = explode( '/', substr( $url, 9 ), 3 );
434  if ( count( $bits ) != 3 ) {
435  throw new MWException( __METHOD__ . ": invalid mwrepo URL: $url" );
436  }
437 
438  return $bits;
439  }
440 
445  function getFileProps( $fileName ) {
446  if ( FileRepo::isVirtualUrl( $fileName ) ) {
447  list( $repoName, /* $zone */, /* $rel */ ) = $this->splitVirtualUrl( $fileName );
448  if ( $repoName === '' ) {
449  $repoName = 'local';
450  }
451  $repo = $this->getRepo( $repoName );
452 
453  return $repo->getFileProps( $fileName );
454  } else {
455  $mwProps = new MWFileProps( MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer() );
456 
457  return $mwProps->getPropsFromPath( $fileName, true );
458  }
459  }
460 
465  public function clearCache( Title $title = null ) {
466  if ( $title == null ) {
467  $this->cache->clear();
468  } else {
469  $this->cache->clear( $title->getDBkey() );
470  }
471  }
472 }
RepoGroup\findFiles
findFiles(array $inputItems, $flags=0)
Search repositories for many files at once.
Definition: RepoGroup.php:192
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1795
RepoGroup\hasForeignRepos
hasForeignRepos()
Does the installation have any foreign repos set up?
Definition: RepoGroup.php:388
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
array
the array() calling protocol came about after MediaWiki 1.4rc1.
$wgLocalFileRepo
$wgLocalFileRepo
File repository structures.
Definition: DefaultSettings.php:539
$params
$params
Definition: styleTest.css.php:40
$result
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. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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! 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:1993
cache
you have access to all of the normal MediaWiki so you can get a DB use the cache
Definition: maintenance.txt:55
RepoGroup\__construct
__construct( $localInfo, $foreignInfo)
Construct a group of file repositories.
Definition: RepoGroup.php:98
RepoGroup\$localRepo
LocalRepo $localRepo
Definition: RepoGroup.php:31
File\normalizeTitle
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:184
php
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
RepoGroup\findBySha1s
findBySha1s(array $hashes)
Find all instances of files with this keys.
Definition: RepoGroup.php:299
RepoGroup\findFile
findFile( $title, $options=[])
Search repositories for an image.
Definition: RepoGroup.php:120
FileRepo
Base class for file repositories.
Definition: FileRepo.php:37
RepoGroup\$reposInitialised
bool $reposInitialised
Definition: RepoGroup.php:37
MWException
MediaWiki exception.
Definition: MWException.php:26
RepoGroup\forEachForeignRepo
forEachForeignRepo( $callback, $params=[])
Call a function for each foreign repo, with the repo object as the first parameter.
Definition: RepoGroup.php:370
RepoGroup\clearCache
clearCache(Title $title=null)
Clear RepoGroup process cache used for finding a file.
Definition: RepoGroup.php:465
RepoGroup\$foreignInfo
array $foreignInfo
Definition: RepoGroup.php:43
RepoGroup\MAX_CACHE_SIZE
const MAX_CACHE_SIZE
Maximum number of cache items.
Definition: RepoGroup.php:52
MediaWiki
A helper class for throttling authentication attempts.
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
MWFileProps
MimeMagic helper wrapper.
Definition: MWFileProps.php:28
RepoGroup\splitVirtualUrl
splitVirtualUrl( $url)
Split a virtual URL into repo, zone and rel parts.
Definition: RepoGroup.php:428
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
RepoGroup\initialiseRepos
initialiseRepos()
Initialise the $repos array.
Definition: RepoGroup.php:398
RepoGroup\newRepo
newRepo( $info)
Create a repo class based on an info structure.
Definition: RepoGroup.php:416
list
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
RepoGroup\$cache
ProcessCacheLRU $cache
Definition: RepoGroup.php:46
$options
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:2001
RepoGroup\destroySingleton
static destroySingleton()
Destroy the singleton instance, so that a new one will be created next time singleton() is called.
Definition: RepoGroup.php:73
RepoGroup\getLocalRepo
getLocalRepo()
Get the local repository, i.e.
Definition: RepoGroup.php:358
RepoGroup\$localInfo
array $localInfo
Definition: RepoGroup.php:40
RepoGroup\$instance
static RepoGroup $instance
Definition: RepoGroup.php:49
RepoGroup\findFileFromKey
findFileFromKey( $hash, $options=[])
Find an instance of the file with this key, created at the specified time Returns false if the file d...
Definition: RepoGroup.php:255
$args
if( $line===false) $args
Definition: cdb.php:64
Title
Represents a title within MediaWiki.
Definition: Title.php:39
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
RepoGroup\findBySha1
findBySha1( $hash)
Find all instances of files with this key.
Definition: RepoGroup.php:279
RepoGroup\$foreignRepos
FileRepo[] $foreignRepos
Definition: RepoGroup.php:34
$image
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:895
as
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
Definition: distributors.txt:22
FileRepo\isVirtualUrl
static isVirtualUrl( $url)
Determine if a string is an mwrepo:// URL.
Definition: FileRepo.php:257
RepoGroup
Prioritized list of file repositories.
Definition: RepoGroup.php:29
RepoGroup\getRepoByName
getRepoByName( $name)
Get the repo instance by its name.
Definition: RepoGroup.php:339
RepoGroup\getFileProps
getFileProps( $fileName)
Definition: RepoGroup.php:445
$hashes
$hashes
Definition: testCompression.php:66
RepoGroup\checkRedirect
checkRedirect(Title $title)
Interface for FileRepo::checkRedirect()
Definition: RepoGroup.php:227
RepoGroup\getRepo
getRepo( $index)
Get the repo instance with a given key.
Definition: RepoGroup.php:321
ProcessCacheLRU
Class for process caching individual properties of expiring items.
Definition: ProcessCacheLRU.php:32
$wgForeignFileRepos
$wgForeignFileRepos
Definition: DefaultSettings.php:544
LocalRepo
A repository that stores files in the local filesystem and registers them in the wiki's own database.
Definition: LocalRepo.php:35
RepoGroup\setSingleton
static setSingleton( $instance)
Set the singleton instance to a given object Used by extensions which hook into the Repo chain.
Definition: RepoGroup.php:85