MediaWiki  1.30.0
ClassicInterwikiLookup.php
Go to the documentation of this file.
1 <?php
3 
24 use \Cdb\Exception as CdbException;
25 use \Cdb\Reader as CdbReader;
27 use Hooks;
32 
46 
50  private $localCache;
51 
56 
60  private $objectCache;
61 
66 
70  private $cdbData;
71 
76 
80  private $fallbackSite;
81 
85  private $cdbReader = null;
86 
90  private $thisSite = null;
91 
105  function __construct(
109  $cdbData,
112  ) {
113  $this->localCache = new MapCacheLRU( 100 );
114 
115  $this->contentLanguage = $contentLanguage;
116  $this->objectCache = $objectCache;
117  $this->objectCacheExpiry = $objectCacheExpiry;
118  $this->cdbData = $cdbData;
119  $this->interwikiScopes = $interwikiScopes;
120  $this->fallbackSite = $fallbackSite;
121  }
122 
129  public function isValidInterwiki( $prefix ) {
130  $result = $this->fetch( $prefix );
131 
132  return (bool)$result;
133  }
134 
141  public function fetch( $prefix ) {
142  if ( $prefix == '' ) {
143  return null;
144  }
145 
146  $prefix = $this->contentLanguage->lc( $prefix );
147  if ( $this->localCache->has( $prefix ) ) {
148  return $this->localCache->get( $prefix );
149  }
150 
151  if ( $this->cdbData ) {
152  $iw = $this->getInterwikiCached( $prefix );
153  } else {
154  $iw = $this->load( $prefix );
155  if ( !$iw ) {
156  $iw = false;
157  }
158  }
159  $this->localCache->set( $prefix, $iw );
160 
161  return $iw;
162  }
163 
169  public function resetLocalCache() {
170  $this->localCache->clear();
171  }
172 
177  public function invalidateCache( $prefix ) {
178  $this->localCache->clear( $prefix );
179 
180  $key = $this->objectCache->makeKey( 'interwiki', $prefix );
181  $this->objectCache->delete( $key );
182  }
183 
192  private function getInterwikiCached( $prefix ) {
193  $value = $this->getInterwikiCacheEntry( $prefix );
194 
195  if ( $value ) {
196  // Split values
197  list( $local, $url ) = explode( ' ', $value, 2 );
198  return new Interwiki( $prefix, $url, '', '', (int)$local );
199  } else {
200  return false;
201  }
202  }
203 
212  private function getInterwikiCacheEntry( $prefix ) {
213  wfDebug( __METHOD__ . "( $prefix )\n" );
214  $value = false;
215  try {
216  // Resolve site name
217  if ( $this->interwikiScopes >= 3 && !$this->thisSite ) {
218  $this->thisSite = $this->getCacheValue( '__sites:' . wfWikiID() );
219  if ( $this->thisSite == '' ) {
220  $this->thisSite = $this->fallbackSite;
221  }
222  }
223 
224  $value = $this->getCacheValue( wfWikiID() . ':' . $prefix );
225  // Site level
226  if ( $value == '' && $this->interwikiScopes >= 3 ) {
227  $value = $this->getCacheValue( "_{$this->thisSite}:{$prefix}" );
228  }
229  // Global Level
230  if ( $value == '' && $this->interwikiScopes >= 2 ) {
231  $value = $this->getCacheValue( "__global:{$prefix}" );
232  }
233  if ( $value == 'undef' ) {
234  $value = '';
235  }
236  } catch ( CdbException $e ) {
237  wfDebug( __METHOD__ . ": CdbException caught, error message was "
238  . $e->getMessage() );
239  }
240 
241  return $value;
242  }
243 
244  private function getCacheValue( $key ) {
245  if ( $this->cdbReader === null ) {
246  if ( is_string( $this->cdbData ) ) {
247  $this->cdbReader = \Cdb\Reader::open( $this->cdbData );
248  } elseif ( is_array( $this->cdbData ) ) {
249  $this->cdbReader = new \Cdb\Reader\Hash( $this->cdbData );
250  } else {
251  $this->cdbReader = false;
252  }
253  }
254 
255  if ( $this->cdbReader ) {
256  return $this->cdbReader->get( $key );
257  } else {
258  return false;
259  }
260  }
261 
268  private function load( $prefix ) {
269  $iwData = [];
270  if ( !Hooks::run( 'InterwikiLoadPrefix', [ $prefix, &$iwData ] ) ) {
271  return $this->loadFromArray( $iwData );
272  }
273 
274  if ( is_array( $iwData ) ) {
275  $iw = $this->loadFromArray( $iwData );
276  if ( $iw ) {
277  return $iw; // handled by hook
278  }
279  }
280 
281  $iwData = $this->objectCache->getWithSetCallback(
282  $this->objectCache->makeKey( 'interwiki', $prefix ),
284  function ( $oldValue, &$ttl, array &$setOpts ) use ( $prefix ) {
285  $dbr = wfGetDB( DB_REPLICA ); // TODO: inject LoadBalancer
286 
287  $setOpts += Database::getCacheSetOptions( $dbr );
288 
289  $row = $dbr->selectRow(
290  'interwiki',
291  self::selectFields(),
292  [ 'iw_prefix' => $prefix ],
293  __METHOD__
294  );
295 
296  return $row ? (array)$row : '!NONEXISTENT';
297  }
298  );
299 
300  if ( is_array( $iwData ) ) {
301  return $this->loadFromArray( $iwData ) ?: false;
302  }
303 
304  return false;
305  }
306 
313  private function loadFromArray( $mc ) {
314  if ( isset( $mc['iw_url'] ) ) {
315  $url = $mc['iw_url'];
316  $local = isset( $mc['iw_local'] ) ? $mc['iw_local'] : 0;
317  $trans = isset( $mc['iw_trans'] ) ? $mc['iw_trans'] : 0;
318  $api = isset( $mc['iw_api'] ) ? $mc['iw_api'] : '';
319  $wikiId = isset( $mc['iw_wikiid'] ) ? $mc['iw_wikiid'] : '';
320 
321  return new Interwiki( null, $url, $api, $wikiId, $local, $trans );
322  }
323 
324  return false;
325  }
326 
333  private function getAllPrefixesCached( $local ) {
334  wfDebug( __METHOD__ . "()\n" );
335  $data = [];
336  try {
337  /* Resolve site name */
338  if ( $this->interwikiScopes >= 3 && !$this->thisSite ) {
339  $site = $this->getCacheValue( '__sites:' . wfWikiID() );
340 
341  if ( $site == '' ) {
342  $this->thisSite = $this->fallbackSite;
343  } else {
344  $this->thisSite = $site;
345  }
346  }
347 
348  // List of interwiki sources
349  $sources = [];
350  // Global Level
351  if ( $this->interwikiScopes >= 2 ) {
352  $sources[] = '__global';
353  }
354  // Site level
355  if ( $this->interwikiScopes >= 3 ) {
356  $sources[] = '_' . $this->thisSite;
357  }
358  $sources[] = wfWikiID();
359 
360  foreach ( $sources as $source ) {
361  $list = $this->getCacheValue( '__list:' . $source );
362  foreach ( explode( ' ', $list ) as $iw_prefix ) {
363  $row = $this->getCacheValue( "{$source}:{$iw_prefix}" );
364  if ( !$row ) {
365  continue;
366  }
367 
368  list( $iw_local, $iw_url ) = explode( ' ', $row );
369 
370  if ( $local !== null && $local != $iw_local ) {
371  continue;
372  }
373 
374  $data[$iw_prefix] = [
375  'iw_prefix' => $iw_prefix,
376  'iw_url' => $iw_url,
377  'iw_local' => $iw_local,
378  ];
379  }
380  }
381  } catch ( CdbException $e ) {
382  wfDebug( __METHOD__ . ": CdbException caught, error message was "
383  . $e->getMessage() );
384  }
385 
386  return array_values( $data );
387  }
388 
395  private function getAllPrefixesDB( $local ) {
396  $db = wfGetDB( DB_REPLICA ); // TODO: inject DB LoadBalancer
397 
398  $where = [];
399 
400  if ( $local !== null ) {
401  if ( $local == 1 ) {
402  $where['iw_local'] = 1;
403  } elseif ( $local == 0 ) {
404  $where['iw_local'] = 0;
405  }
406  }
407 
408  $res = $db->select( 'interwiki',
409  self::selectFields(),
410  $where, __METHOD__, [ 'ORDER BY' => 'iw_prefix' ]
411  );
412 
413  $retval = [];
414  foreach ( $res as $row ) {
415  $retval[] = (array)$row;
416  }
417 
418  return $retval;
419  }
420 
427  public function getAllPrefixes( $local = null ) {
428  if ( $this->cdbData ) {
429  return $this->getAllPrefixesCached( $local );
430  }
431 
432  return $this->getAllPrefixesDB( $local );
433  }
434 
440  private static function selectFields() {
441  return [
442  'iw_prefix',
443  'iw_url',
444  'iw_api',
445  'iw_wikiid',
446  'iw_local',
447  'iw_trans'
448  ];
449  }
450 
451 }
MediaWiki\Interwiki\ClassicInterwikiLookup\__construct
__construct(Language $contentLanguage, WANObjectCache $objectCache, $objectCacheExpiry, $cdbData, $interwikiScopes, $fallbackSite)
Definition: ClassicInterwikiLookup.php:105
MediaWiki\Interwiki\ClassicInterwikiLookup\$contentLanguage
Language $contentLanguage
Definition: ClassicInterwikiLookup.php:55
Wikimedia\Rdbms\Database
Relational database abstraction object.
Definition: Database.php:45
MediaWiki\Interwiki\ClassicInterwikiLookup\$localCache
MapCacheLRU $localCache
Definition: ClassicInterwikiLookup.php:50
MediaWiki\Interwiki\ClassicInterwikiLookup\isValidInterwiki
isValidInterwiki( $prefix)
Check whether an interwiki prefix exists.
Definition: ClassicInterwikiLookup.php:129
MediaWiki\Interwiki\ClassicInterwikiLookup
InterwikiLookup implementing the "classic" interwiki storage (hardcoded up to MW 1....
Definition: ClassicInterwikiLookup.php:45
MediaWiki\Interwiki\ClassicInterwikiLookup\getAllPrefixesCached
getAllPrefixesCached( $local)
Fetch all interwiki prefixes from interwiki cache.
Definition: ClassicInterwikiLookup.php:333
MediaWiki\Interwiki\ClassicInterwikiLookup\resetLocalCache
resetLocalCache()
Resets locally cached Interwiki objects.
Definition: ClassicInterwikiLookup.php:169
$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. '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 '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:1963
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
MediaWiki\Interwiki\ClassicInterwikiLookup\$thisSite
string null $thisSite
Definition: ClassicInterwikiLookup.php:90
$res
$res
Definition: database.txt:21
Makefile.open
open
Definition: Makefile.py:18
MediaWiki\Interwiki\ClassicInterwikiLookup\$interwikiScopes
int $interwikiScopes
Definition: ClassicInterwikiLookup.php:75
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:35
MediaWiki\Interwiki\ClassicInterwikiLookup\getAllPrefixesDB
getAllPrefixesDB( $local)
Fetch all interwiki prefixes from DB.
Definition: ClassicInterwikiLookup.php:395
MediaWiki\Interwiki\ClassicInterwikiLookup\getInterwikiCacheEntry
getInterwikiCacheEntry( $prefix)
Get entry from interwiki cache.
Definition: ClassicInterwikiLookup.php:212
MediaWiki\Interwiki\ClassicInterwikiLookup\load
load( $prefix)
Load the interwiki, trying first memcached then the DB.
Definition: ClassicInterwikiLookup.php:268
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2856
MediaWiki\Interwiki\InterwikiLookup
Service interface for looking up Interwiki records.
Definition: InterwikiLookup.php:31
MediaWiki\Interwiki\ClassicInterwikiLookup\$objectCache
WANObjectCache $objectCache
Definition: ClassicInterwikiLookup.php:60
MapCacheLRU
Handles a simple LRU key/value map with a maximum number of entries.
Definition: MapCacheLRU.php:34
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:1047
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
MediaWiki\Interwiki\ClassicInterwikiLookup\$cdbData
bool array string $cdbData
Definition: ClassicInterwikiLookup.php:70
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2807
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2141
MediaWiki\Interwiki\ClassicInterwikiLookup\fetch
fetch( $prefix)
Fetch an Interwiki object.
Definition: ClassicInterwikiLookup.php:141
$value
$value
Definition: styleTest.css.php:45
$retval
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
Definition: hooks.txt:244
MediaWiki\Interwiki\ClassicInterwikiLookup\getAllPrefixes
getAllPrefixes( $local=null)
Returns all interwiki prefixes.
Definition: ClassicInterwikiLookup.php:427
WANObjectCache
Multi-datacenter aware caching interface.
Definition: WANObjectCache.php:80
Wikimedia\Rdbms\Database\getCacheSetOptions
static getCacheSetOptions(IDatabase $db1)
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estima...
Definition: Database.php:3214
MediaWiki\Interwiki\ClassicInterwikiLookup\$objectCacheExpiry
int $objectCacheExpiry
Definition: ClassicInterwikiLookup.php:65
MediaWiki\Interwiki\ClassicInterwikiLookup\$fallbackSite
string $fallbackSite
Definition: ClassicInterwikiLookup.php:80
MediaWiki\Interwiki\ClassicInterwikiLookup\invalidateCache
invalidateCache( $prefix)
Purge the in-process and object cache for an interwiki prefix.
Definition: ClassicInterwikiLookup.php:177
MediaWiki\Interwiki\ClassicInterwikiLookup\selectFields
static selectFields()
Return the list of interwiki fields that should be selected to create a new Interwiki object.
Definition: ClassicInterwikiLookup.php:440
$dbr
if(! $regexes) $dbr
Definition: cleanup.php:94
Interwiki
Value object for representing interwiki records.
Definition: Interwiki.php:27
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:9
MediaWiki\Interwiki
Definition: ClassicInterwikiLookup.php:2
$source
$source
Definition: mwdoc-filter.php:46
MediaWiki\Interwiki\ClassicInterwikiLookup\$cdbReader
CdbReader null $cdbReader
Definition: ClassicInterwikiLookup.php:85
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
MediaWiki\Interwiki\ClassicInterwikiLookup\getInterwikiCached
getInterwikiCached( $prefix)
Fetch interwiki prefix data from local cache in constant database.
Definition: ClassicInterwikiLookup.php:192
MediaWiki\Interwiki\ClassicInterwikiLookup\getCacheValue
getCacheValue( $key)
Definition: ClassicInterwikiLookup.php:244
MediaWiki\Interwiki\ClassicInterwikiLookup\loadFromArray
loadFromArray( $mc)
Fill in member variables from an array (e.g.
Definition: ClassicInterwikiLookup.php:313
Language
Internationalisation code.
Definition: Language.php:35
Hooks
Hooks class.
Definition: Hooks.php:34
array
the array() calling protocol came about after MediaWiki 1.4rc1.