MediaWiki  master
RepoGroup.php
Go to the documentation of this file.
1 <?php
25 
31 class RepoGroup {
33  protected $localRepo;
34 
36  protected $foreignRepos;
37 
39  protected $wanCache;
40 
42  protected $reposInitialised = false;
43 
45  protected $localInfo;
46 
48  protected $foreignInfo;
49 
51  protected $cache;
52 
54  const MAX_CACHE_SIZE = 500;
55 
60  static function singleton() {
61  return MediaWikiServices::getInstance()->getRepoGroup();
62  }
63 
68  static function destroySingleton() {
69  MediaWikiServices::getInstance()->resetServiceForTesting( 'RepoGroup' );
70  }
71 
77  static function setSingleton( $instance ) {
78  $services = MediaWikiServices::getInstance();
79  $services->disableService( 'RepoGroup' );
80  $services->redefineService( 'RepoGroup',
81  function () use ( $instance ) {
82  return $instance;
83  }
84  );
85  }
86 
99  $this->localInfo = $localInfo;
100  $this->foreignInfo = $foreignInfo;
101  $this->cache = new MapCacheLRU( self::MAX_CACHE_SIZE );
102  $this->wanCache = $wanCache;
103  }
104 
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  $options += [ 'time' => false ];
129 
130  if ( !$this->reposInitialised ) {
131  $this->initialiseRepos();
132  }
133 
135  if ( !$title ) {
136  return false;
137  }
138 
139  # Check the cache
140  $dbkey = $title->getDBkey();
141  $timeKey = is_string( $options['time'] ) ? $options['time'] : '';
142  if ( empty( $options['ignoreRedirect'] )
143  && empty( $options['private'] )
144  && empty( $options['latest'] )
145  ) {
146  if ( $this->cache->hasField( $dbkey, $timeKey, 60 ) ) {
147  return $this->cache->getField( $dbkey, $timeKey );
148  }
149  $useCache = true;
150  } else {
151  $useCache = false;
152  }
153 
154  # Check the local repo
155  $image = $this->localRepo->findFile( $title, $options );
156 
157  # Check the foreign repos
158  if ( !$image ) {
159  foreach ( $this->foreignRepos as $repo ) {
160  $image = $repo->findFile( $title, $options );
161  if ( $image ) {
162  break;
163  }
164  }
165  }
166 
167  $image = $image instanceof File ? $image : false; // type sanity
168  # Cache file existence or non-existence
169  if ( $useCache && ( !$image || $image->isCacheable() ) ) {
170  $this->cache->setField( $dbkey, $timeKey, $image );
171  }
172 
173  return $image;
174  }
175 
193  function findFiles( array $inputItems, $flags = 0 ) {
194  if ( !$this->reposInitialised ) {
195  $this->initialiseRepos();
196  }
197 
198  $items = [];
199  foreach ( $inputItems as $item ) {
200  if ( !is_array( $item ) ) {
201  $item = [ 'title' => $item ];
202  }
203  $item['title'] = File::normalizeTitle( $item['title'] );
204  if ( $item['title'] ) {
205  $items[$item['title']->getDBkey()] = $item;
206  }
207  }
208 
209  $images = $this->localRepo->findFiles( $items, $flags );
210 
211  foreach ( $this->foreignRepos as $repo ) {
212  // Remove found files from $items
213  foreach ( $images as $name => $image ) {
214  unset( $items[$name] );
215  }
216 
217  $images = array_merge( $images, $repo->findFiles( $items, $flags ) );
218  }
219 
220  return $images;
221  }
222 
228  function checkRedirect( Title $title ) {
229  if ( !$this->reposInitialised ) {
230  $this->initialiseRepos();
231  }
232 
233  $redir = $this->localRepo->checkRedirect( $title );
234  if ( $redir ) {
235  return $redir;
236  }
237 
238  foreach ( $this->foreignRepos as $repo ) {
239  $redir = $repo->checkRedirect( $title );
240  if ( $redir ) {
241  return $redir;
242  }
243  }
244 
245  return false;
246  }
247 
256  function findFileFromKey( $hash, $options = [] ) {
257  if ( !$this->reposInitialised ) {
258  $this->initialiseRepos();
259  }
260 
261  $file = $this->localRepo->findFileFromKey( $hash, $options );
262  if ( !$file ) {
263  foreach ( $this->foreignRepos as $repo ) {
264  $file = $repo->findFileFromKey( $hash, $options );
265  if ( $file ) {
266  break;
267  }
268  }
269  }
270 
271  return $file;
272  }
273 
280  function findBySha1( $hash ) {
281  if ( !$this->reposInitialised ) {
282  $this->initialiseRepos();
283  }
284 
285  $result = $this->localRepo->findBySha1( $hash );
286  foreach ( $this->foreignRepos as $repo ) {
287  $result = array_merge( $result, $repo->findBySha1( $hash ) );
288  }
289  usort( $result, 'File::compare' );
290 
291  return $result;
292  }
293 
300  function findBySha1s( array $hashes ) {
301  if ( !$this->reposInitialised ) {
302  $this->initialiseRepos();
303  }
304 
305  $result = $this->localRepo->findBySha1s( $hashes );
306  foreach ( $this->foreignRepos as $repo ) {
307  $result = array_merge_recursive( $result, $repo->findBySha1s( $hashes ) );
308  }
309  // sort the merged (and presorted) sublist of each hash
310  foreach ( $result as $hash => $files ) {
311  usort( $result[$hash], 'File::compare' );
312  }
313 
314  return $result;
315  }
316 
322  function getRepo( $index ) {
323  if ( !$this->reposInitialised ) {
324  $this->initialiseRepos();
325  }
326  if ( $index === 'local' ) {
327  return $this->localRepo;
328  }
329  return $this->foreignRepos[$index] ?? false;
330  }
331 
337  function getRepoByName( $name ) {
338  if ( !$this->reposInitialised ) {
339  $this->initialiseRepos();
340  }
341  foreach ( $this->foreignRepos as $repo ) {
342  if ( $repo->name == $name ) {
343  return $repo;
344  }
345  }
346 
347  return false;
348  }
349 
356  function getLocalRepo() {
358  $repo = $this->getRepo( 'local' );
359 
360  return $repo;
361  }
362 
371  function forEachForeignRepo( $callback, $params = [] ) {
372  if ( !$this->reposInitialised ) {
373  $this->initialiseRepos();
374  }
375  foreach ( $this->foreignRepos as $repo ) {
376  if ( $callback( $repo, ...$params ) ) {
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  $info['wanCache'] = $this->wanCache;
420 
421  return new $class( $info );
422  }
423 
430  function splitVirtualUrl( $url ) {
431  if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
432  throw new MWException( __METHOD__ . ': unknown protocol' );
433  }
434 
435  $bits = explode( '/', substr( $url, 9 ), 3 );
436  if ( count( $bits ) != 3 ) {
437  throw new MWException( __METHOD__ . ": invalid mwrepo URL: $url" );
438  }
439 
440  return $bits;
441  }
442 
447  function getFileProps( $fileName ) {
448  if ( FileRepo::isVirtualUrl( $fileName ) ) {
449  list( $repoName, /* $zone */, /* $rel */ ) = $this->splitVirtualUrl( $fileName );
450  if ( $repoName === '' ) {
451  $repoName = 'local';
452  }
453  $repo = $this->getRepo( $repoName );
454 
455  return $repo->getFileProps( $fileName );
456  } else {
457  $mwProps = new MWFileProps( MediaWiki\MediaWikiServices::getInstance()->getMimeAnalyzer() );
458 
459  return $mwProps->getPropsFromPath( $fileName, true );
460  }
461  }
462 
467  public function clearCache( Title $title = null ) {
468  if ( $title == null ) {
469  $this->cache->clear();
470  } else {
471  $this->cache->clear( $title->getDBkey() );
472  }
473  }
474 }
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))
findFiles(array $inputItems, $flags=0)
Search repositories for many files at once.
Definition: RepoGroup.php:193
findFile( $title, $options=[])
Search repositories for an image.
Definition: RepoGroup.php:120
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
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
bool $reposInitialised
Definition: RepoGroup.php:42
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
__construct( $localInfo, $foreignInfo, $wanCache)
Construct a group of file repositories.
Definition: RepoGroup.php:98
LocalRepo $localRepo
Definition: RepoGroup.php:33
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:256
static destroySingleton()
Definition: RepoGroup.php:68
getLocalRepo()
Get the local repository, i.e.
Definition: RepoGroup.php:356
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 MediaWikiServices
Definition: injection.txt:23
getRepoByName( $name)
Get the repo instance by its name.
Definition: RepoGroup.php:337
A helper class for throttling authentication attempts.
static setSingleton( $instance)
Definition: RepoGroup.php:77
newRepo( $info)
Create a repo class based on an info structure.
Definition: RepoGroup.php:416
FileRepo [] $foreignRepos
Definition: RepoGroup.php:36
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. '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:1980
you have access to all of the normal MediaWiki so you can get a DB use the cache
Definition: maintenance.txt:52
splitVirtualUrl( $url)
Split a virtual URL into repo, zone and rel parts.
Definition: RepoGroup.php:430
initialiseRepos()
Initialise the $repos array.
Definition: RepoGroup.php:398
getRepo( $index)
Get the repo instance with a given key.
Definition: RepoGroup.php:322
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
Definition: hooks.txt:2217
hasForeignRepos()
Does the installation have any foreign repos set up?
Definition: RepoGroup.php:388
static singleton()
Definition: RepoGroup.php:60
static isVirtualUrl( $url)
Determine if a string is an mwrepo:// URL.
Definition: FileRepo.php:255
$params
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:1982
array $localInfo
Definition: RepoGroup.php:45
forEachForeignRepo( $callback, $params=[])
Call a function for each foreign repo, with the repo object as the first parameter.
Definition: RepoGroup.php:371
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 null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
array $foreignInfo
Definition: RepoGroup.php:48
MapCacheLRU $cache
Definition: RepoGroup.php:51
checkRedirect(Title $title)
Interface for FileRepo::checkRedirect()
Definition: RepoGroup.php:228
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:9
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:35
const MAX_CACHE_SIZE
Maximum number of cache items.
Definition: RepoGroup.php:54
clearCache(Title $title=null)
Clear RepoGroup process cache used for finding a file.
Definition: RepoGroup.php:467
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:780
findBySha1s(array $hashes)
Find all instances of files with this keys.
Definition: RepoGroup.php:300
MimeMagic helper wrapper.
Definition: MWFileProps.php:28
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
findBySha1( $hash)
Find all instances of files with this key.
Definition: RepoGroup.php:280
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:61
WANObjectCache $wanCache
Definition: RepoGroup.php:39
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:194
getFileProps( $fileName)
Definition: RepoGroup.php:447