MediaWiki  REL1_31
ClassicInterwikiLookup.php
Go to the documentation of this file.
1 <?php
24 
25 use Cdb\Exception as CdbException;
26 use Cdb\Reader as CdbReader;
27 use Hooks;
33 
47 
51  private $localCache;
52 
57 
61  private $objectCache;
62 
67 
71  private $cdbData;
72 
77 
81  private $fallbackSite;
82 
86  private $cdbReader = null;
87 
91  private $thisSite = null;
92 
106  function __construct(
110  $cdbData,
113  ) {
114  $this->localCache = new MapCacheLRU( 100 );
115 
116  $this->contentLanguage = $contentLanguage;
117  $this->objectCache = $objectCache;
118  $this->objectCacheExpiry = $objectCacheExpiry;
119  $this->cdbData = $cdbData;
120  $this->interwikiScopes = $interwikiScopes;
121  $this->fallbackSite = $fallbackSite;
122  }
123 
130  public function isValidInterwiki( $prefix ) {
131  $result = $this->fetch( $prefix );
132 
133  return (bool)$result;
134  }
135 
142  public function fetch( $prefix ) {
143  if ( $prefix == '' ) {
144  return null;
145  }
146 
147  $prefix = $this->contentLanguage->lc( $prefix );
148  if ( $this->localCache->has( $prefix ) ) {
149  return $this->localCache->get( $prefix );
150  }
151 
152  if ( $this->cdbData ) {
153  $iw = $this->getInterwikiCached( $prefix );
154  } else {
155  $iw = $this->load( $prefix );
156  if ( !$iw ) {
157  $iw = false;
158  }
159  }
160  $this->localCache->set( $prefix, $iw );
161 
162  return $iw;
163  }
164 
170  public function resetLocalCache() {
171  $this->localCache->clear();
172  }
173 
178  public function invalidateCache( $prefix ) {
179  $this->localCache->clear( $prefix );
180 
181  $key = $this->objectCache->makeKey( 'interwiki', $prefix );
182  $this->objectCache->delete( $key );
183  }
184 
193  private function getInterwikiCached( $prefix ) {
194  $value = $this->getInterwikiCacheEntry( $prefix );
195 
196  if ( $value ) {
197  // Split values
198  list( $local, $url ) = explode( ' ', $value, 2 );
199  return new Interwiki( $prefix, $url, '', '', (int)$local );
200  } else {
201  return false;
202  }
203  }
204 
213  private function getInterwikiCacheEntry( $prefix ) {
214  wfDebug( __METHOD__ . "( $prefix )\n" );
215  $value = false;
216  try {
217  // Resolve site name
218  if ( $this->interwikiScopes >= 3 && !$this->thisSite ) {
219  $this->thisSite = $this->getCacheValue( '__sites:' . wfWikiID() );
220  if ( $this->thisSite == '' ) {
221  $this->thisSite = $this->fallbackSite;
222  }
223  }
224 
225  $value = $this->getCacheValue( wfWikiID() . ':' . $prefix );
226  // Site level
227  if ( $value == '' && $this->interwikiScopes >= 3 ) {
228  $value = $this->getCacheValue( "_{$this->thisSite}:{$prefix}" );
229  }
230  // Global Level
231  if ( $value == '' && $this->interwikiScopes >= 2 ) {
232  $value = $this->getCacheValue( "__global:{$prefix}" );
233  }
234  if ( $value == 'undef' ) {
235  $value = '';
236  }
237  } catch ( CdbException $e ) {
238  wfDebug( __METHOD__ . ": CdbException caught, error message was "
239  . $e->getMessage() );
240  }
241 
242  return $value;
243  }
244 
245  private function getCacheValue( $key ) {
246  if ( $this->cdbReader === null ) {
247  if ( is_string( $this->cdbData ) ) {
248  $this->cdbReader = \Cdb\Reader::open( $this->cdbData );
249  } elseif ( is_array( $this->cdbData ) ) {
250  $this->cdbReader = new \Cdb\Reader\Hash( $this->cdbData );
251  } else {
252  $this->cdbReader = false;
253  }
254  }
255 
256  if ( $this->cdbReader ) {
257  return $this->cdbReader->get( $key );
258  } else {
259  return false;
260  }
261  }
262 
269  private function load( $prefix ) {
270  $iwData = [];
271  if ( !Hooks::run( 'InterwikiLoadPrefix', [ $prefix, &$iwData ] ) ) {
272  return $this->loadFromArray( $iwData );
273  }
274 
275  if ( is_array( $iwData ) ) {
276  $iw = $this->loadFromArray( $iwData );
277  if ( $iw ) {
278  return $iw; // handled by hook
279  }
280  }
281 
282  $iwData = $this->objectCache->getWithSetCallback(
283  $this->objectCache->makeKey( 'interwiki', $prefix ),
284  $this->objectCacheExpiry,
285  function ( $oldValue, &$ttl, array &$setOpts ) use ( $prefix ) {
286  $dbr = wfGetDB( DB_REPLICA ); // TODO: inject LoadBalancer
287 
288  $setOpts += Database::getCacheSetOptions( $dbr );
289 
290  $row = $dbr->selectRow(
291  'interwiki',
292  self::selectFields(),
293  [ 'iw_prefix' => $prefix ],
294  __METHOD__
295  );
296 
297  return $row ? (array)$row : '!NONEXISTENT';
298  }
299  );
300 
301  if ( is_array( $iwData ) ) {
302  return $this->loadFromArray( $iwData ) ?: false;
303  }
304 
305  return false;
306  }
307 
314  private function loadFromArray( $mc ) {
315  if ( isset( $mc['iw_url'] ) ) {
316  $url = $mc['iw_url'];
317  $local = isset( $mc['iw_local'] ) ? $mc['iw_local'] : 0;
318  $trans = isset( $mc['iw_trans'] ) ? $mc['iw_trans'] : 0;
319  $api = isset( $mc['iw_api'] ) ? $mc['iw_api'] : '';
320  $wikiId = isset( $mc['iw_wikiid'] ) ? $mc['iw_wikiid'] : '';
321 
322  return new Interwiki( null, $url, $api, $wikiId, $local, $trans );
323  }
324 
325  return false;
326  }
327 
334  private function getAllPrefixesCached( $local ) {
335  wfDebug( __METHOD__ . "()\n" );
336  $data = [];
337  try {
338  /* Resolve site name */
339  if ( $this->interwikiScopes >= 3 && !$this->thisSite ) {
340  $site = $this->getCacheValue( '__sites:' . wfWikiID() );
341 
342  if ( $site == '' ) {
343  $this->thisSite = $this->fallbackSite;
344  } else {
345  $this->thisSite = $site;
346  }
347  }
348 
349  // List of interwiki sources
350  $sources = [];
351  // Global Level
352  if ( $this->interwikiScopes >= 2 ) {
353  $sources[] = '__global';
354  }
355  // Site level
356  if ( $this->interwikiScopes >= 3 ) {
357  $sources[] = '_' . $this->thisSite;
358  }
359  $sources[] = wfWikiID();
360 
361  foreach ( $sources as $source ) {
362  $list = $this->getCacheValue( '__list:' . $source );
363  foreach ( explode( ' ', $list ) as $iw_prefix ) {
364  $row = $this->getCacheValue( "{$source}:{$iw_prefix}" );
365  if ( !$row ) {
366  continue;
367  }
368 
369  list( $iw_local, $iw_url ) = explode( ' ', $row );
370 
371  if ( $local !== null && $local != $iw_local ) {
372  continue;
373  }
374 
375  $data[$iw_prefix] = [
376  'iw_prefix' => $iw_prefix,
377  'iw_url' => $iw_url,
378  'iw_local' => $iw_local,
379  ];
380  }
381  }
382  } catch ( CdbException $e ) {
383  wfDebug( __METHOD__ . ": CdbException caught, error message was "
384  . $e->getMessage() );
385  }
386 
387  return array_values( $data );
388  }
389 
396  private function getAllPrefixesDB( $local ) {
397  $db = wfGetDB( DB_REPLICA ); // TODO: inject DB LoadBalancer
398 
399  $where = [];
400 
401  if ( $local !== null ) {
402  if ( $local == 1 ) {
403  $where['iw_local'] = 1;
404  } elseif ( $local == 0 ) {
405  $where['iw_local'] = 0;
406  }
407  }
408 
409  $res = $db->select( 'interwiki',
410  self::selectFields(),
411  $where, __METHOD__, [ 'ORDER BY' => 'iw_prefix' ]
412  );
413 
414  $retval = [];
415  foreach ( $res as $row ) {
416  $retval[] = (array)$row;
417  }
418 
419  return $retval;
420  }
421 
428  public function getAllPrefixes( $local = null ) {
429  if ( $this->cdbData ) {
430  return $this->getAllPrefixesCached( $local );
431  }
432 
433  return $this->getAllPrefixesDB( $local );
434  }
435 
441  private static function selectFields() {
442  return [
443  'iw_prefix',
444  'iw_url',
445  'iw_api',
446  'iw_wikiid',
447  'iw_local',
448  'iw_trans'
449  ];
450  }
451 
452 }
MediaWiki\Interwiki\ClassicInterwikiLookup\__construct
__construct(Language $contentLanguage, WANObjectCache $objectCache, $objectCacheExpiry, $cdbData, $interwikiScopes, $fallbackSite)
Definition: ClassicInterwikiLookup.php:106
MediaWiki\Interwiki\ClassicInterwikiLookup\$contentLanguage
Language $contentLanguage
Definition: ClassicInterwikiLookup.php:56
Wikimedia\Rdbms\Database
Relational database abstraction object.
Definition: Database.php:48
MediaWiki\Interwiki\ClassicInterwikiLookup\$localCache
MapCacheLRU $localCache
Definition: ClassicInterwikiLookup.php:51
MediaWiki\Interwiki\ClassicInterwikiLookup\isValidInterwiki
isValidInterwiki( $prefix)
Check whether an interwiki prefix exists.
Definition: ClassicInterwikiLookup.php:130
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
MediaWiki\Interwiki\ClassicInterwikiLookup
InterwikiLookup implementing the "classic" interwiki storage (hardcoded up to MW 1....
Definition: ClassicInterwikiLookup.php:46
MediaWiki\Interwiki\ClassicInterwikiLookup\getAllPrefixesCached
getAllPrefixesCached( $local)
Fetch all interwiki prefixes from interwiki cache.
Definition: ClassicInterwikiLookup.php:334
array
the array() calling protocol came about after MediaWiki 1.4rc1.
MediaWiki\Interwiki\ClassicInterwikiLookup\resetLocalCache
resetLocalCache()
Resets locally cached Interwiki objects.
Definition: ClassicInterwikiLookup.php:170
MediaWiki\Interwiki\ClassicInterwikiLookup\$thisSite
string null $thisSite
Definition: ClassicInterwikiLookup.php:91
$res
$res
Definition: database.txt:21
Makefile.open
open
Definition: Makefile.py:18
$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
MediaWiki\Interwiki\ClassicInterwikiLookup\$interwikiScopes
int $interwikiScopes
Definition: ClassicInterwikiLookup.php:76
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
$dbr
$dbr
Definition: testCompression.php:50
MediaWiki\Interwiki\ClassicInterwikiLookup\getAllPrefixesDB
getAllPrefixesDB( $local)
Fetch all interwiki prefixes from DB.
Definition: ClassicInterwikiLookup.php:396
MediaWiki\Interwiki\ClassicInterwikiLookup\getInterwikiCacheEntry
getInterwikiCacheEntry( $prefix)
Get entry from interwiki cache.
Definition: ClassicInterwikiLookup.php:213
Wikimedia\Rdbms\Database\getCacheSetOptions
static getCacheSetOptions(IDatabase $db1, IDatabase $db2=null)
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estima...
Definition: Database.php:4069
MediaWiki\Interwiki\ClassicInterwikiLookup\load
load( $prefix)
Load the interwiki, trying first memcached then the DB.
Definition: ClassicInterwikiLookup.php:269
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
MediaWiki\Interwiki\InterwikiLookup
Service interface for looking up Interwiki records.
Definition: InterwikiLookup.php:31
MediaWiki\Interwiki\ClassicInterwikiLookup\$objectCache
WANObjectCache $objectCache
Definition: ClassicInterwikiLookup.php:61
MapCacheLRU
Handles a simple LRU key/value map with a maximum number of entries.
Definition: MapCacheLRU.php:34
function
when a variable name is used in a function
Definition: design.txt:93
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:994
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:71
wfWikiID
wfWikiID()
Get an ASCII string identifying this wiki This is used as a prefix in memcached keys.
Definition: GlobalFunctions.php:2763
MediaWiki\Interwiki\ClassicInterwikiLookup\fetch
fetch( $prefix)
Fetch an Interwiki object.
Definition: ClassicInterwikiLookup.php:142
$value
$value
Definition: styleTest.css.php:45
MediaWiki\Interwiki\ClassicInterwikiLookup\getAllPrefixes
getAllPrefixes( $local=null)
Returns all interwiki prefixes.
Definition: ClassicInterwikiLookup.php:428
WANObjectCache
Multi-datacenter aware caching interface.
Definition: WANObjectCache.php:87
MediaWiki\Interwiki\ClassicInterwikiLookup\$objectCacheExpiry
int $objectCacheExpiry
Definition: ClassicInterwikiLookup.php:66
MediaWiki\Interwiki\ClassicInterwikiLookup\$fallbackSite
string $fallbackSite
Definition: ClassicInterwikiLookup.php:81
MediaWiki\Interwiki\ClassicInterwikiLookup\invalidateCache
invalidateCache( $prefix)
Purge the in-process and object cache for an interwiki prefix.
Definition: ClassicInterwikiLookup.php:178
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:441
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:22
MediaWiki\Interwiki
Copyright (C) 2018 Kunal Mehta legoktm@member.fsf.org
Definition: ClassicInterwikiLookup.php:23
$source
$source
Definition: mwdoc-filter.php:46
MediaWiki\Interwiki\ClassicInterwikiLookup\$cdbReader
CdbReader null $cdbReader
Definition: ClassicInterwikiLookup.php:86
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:193
MediaWiki\Interwiki\ClassicInterwikiLookup\getCacheValue
getCacheValue( $key)
Definition: ClassicInterwikiLookup.php:245
$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:266
MediaWiki\Interwiki\ClassicInterwikiLookup\loadFromArray
loadFromArray( $mc)
Fill in member variables from an array (e.g.
Definition: ClassicInterwikiLookup.php:314
Language
Internationalisation code.
Definition: Language.php:35
Hooks
Hooks class.
Definition: Hooks.php:34
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171