MediaWiki  master
ClassicInterwikiLookup.php
Go to the documentation of this file.
1 <?php
24 
27 use Hooks;
30 use WikiMap;
34 
48 
52  private $localCache;
53 
57  private $contLang;
58 
62  private $objectCache;
63 
68 
72  private $cdbData;
73 
78 
82  private $fallbackSite;
83 
87  private $cdbReader = null;
88 
92  private $thisSite = null;
93 
107  function __construct(
111  $cdbData,
114  ) {
115  $this->localCache = new MapCacheLRU( 100 );
116 
117  $this->contLang = $contLang;
118  $this->objectCache = $objectCache;
119  $this->objectCacheExpiry = $objectCacheExpiry;
120  $this->cdbData = $cdbData;
121  $this->interwikiScopes = $interwikiScopes;
122  $this->fallbackSite = $fallbackSite;
123  }
124 
131  public function isValidInterwiki( $prefix ) {
132  $result = $this->fetch( $prefix );
133 
134  return (bool)$result;
135  }
136 
143  public function fetch( $prefix ) {
144  if ( $prefix == '' ) {
145  return null;
146  }
147 
148  $prefix = $this->contLang->lc( $prefix );
149  if ( $this->localCache->has( $prefix ) ) {
150  return $this->localCache->get( $prefix );
151  }
152 
153  if ( $this->cdbData ) {
154  $iw = $this->getInterwikiCached( $prefix );
155  } else {
156  $iw = $this->load( $prefix );
157  if ( !$iw ) {
158  $iw = false;
159  }
160  }
161  $this->localCache->set( $prefix, $iw );
162 
163  return $iw;
164  }
165 
171  public function resetLocalCache() {
172  $this->localCache->clear();
173  }
174 
179  public function invalidateCache( $prefix ) {
180  $this->localCache->clear( $prefix );
181 
182  $key = $this->objectCache->makeKey( 'interwiki', $prefix );
183  $this->objectCache->delete( $key );
184  }
185 
194  private function getInterwikiCached( $prefix ) {
195  $value = $this->getInterwikiCacheEntry( $prefix );
196 
197  if ( $value ) {
198  // Split values
199  list( $local, $url ) = explode( ' ', $value, 2 );
200  return new Interwiki( $prefix, $url, '', '', (int)$local );
201  } else {
202  return false;
203  }
204  }
205 
214  private function getInterwikiCacheEntry( $prefix ) {
215  wfDebug( __METHOD__ . "( $prefix )\n" );
216 
218 
219  $value = false;
220  try {
221  // Resolve site name
222  if ( $this->interwikiScopes >= 3 && !$this->thisSite ) {
223  $this->thisSite = $this->getCacheValue( '__sites:' . $wikiId );
224  if ( $this->thisSite == '' ) {
225  $this->thisSite = $this->fallbackSite;
226  }
227  }
228 
229  $value = $this->getCacheValue( $wikiId . ':' . $prefix );
230  // Site level
231  if ( $value == '' && $this->interwikiScopes >= 3 ) {
232  $value = $this->getCacheValue( "_{$this->thisSite}:{$prefix}" );
233  }
234  // Global Level
235  if ( $value == '' && $this->interwikiScopes >= 2 ) {
236  $value = $this->getCacheValue( "__global:{$prefix}" );
237  }
238  if ( $value == 'undef' ) {
239  $value = '';
240  }
241  } catch ( CdbException $e ) {
242  wfDebug( __METHOD__ . ": CdbException caught, error message was "
243  . $e->getMessage() );
244  }
245 
246  return $value;
247  }
248 
249  private function getCacheValue( $key ) {
250  if ( $this->cdbReader === null ) {
251  if ( is_string( $this->cdbData ) ) {
252  $this->cdbReader = \Cdb\Reader::open( $this->cdbData );
253  } elseif ( is_array( $this->cdbData ) ) {
254  $this->cdbReader = new \Cdb\Reader\Hash( $this->cdbData );
255  } else {
256  $this->cdbReader = false;
257  }
258  }
259 
260  if ( $this->cdbReader ) {
261  return $this->cdbReader->get( $key );
262  } else {
263  return false;
264  }
265  }
266 
273  private function load( $prefix ) {
274  $iwData = [];
275  if ( !Hooks::run( 'InterwikiLoadPrefix', [ $prefix, &$iwData ] ) ) {
276  return $this->loadFromArray( $iwData );
277  }
278 
279  if ( is_array( $iwData ) ) {
280  $iw = $this->loadFromArray( $iwData );
281  if ( $iw ) {
282  return $iw; // handled by hook
283  }
284  }
285 
286  $fname = __METHOD__;
287  $iwData = $this->objectCache->getWithSetCallback(
288  $this->objectCache->makeKey( 'interwiki', $prefix ),
290  function ( $oldValue, &$ttl, array &$setOpts ) use ( $prefix, $fname ) {
291  $dbr = wfGetDB( DB_REPLICA ); // TODO: inject LoadBalancer
292 
293  $setOpts += Database::getCacheSetOptions( $dbr );
294 
295  $row = $dbr->selectRow(
296  'interwiki',
297  self::selectFields(),
298  [ 'iw_prefix' => $prefix ],
299  $fname
300  );
301 
302  return $row ? (array)$row : '!NONEXISTENT';
303  }
304  );
305 
306  if ( is_array( $iwData ) ) {
307  return $this->loadFromArray( $iwData ) ?: false;
308  }
309 
310  return false;
311  }
312 
319  private function loadFromArray( $mc ) {
320  if ( isset( $mc['iw_url'] ) ) {
321  $url = $mc['iw_url'];
322  $local = $mc['iw_local'] ?? 0;
323  $trans = $mc['iw_trans'] ?? 0;
324  $api = $mc['iw_api'] ?? '';
325  $wikiId = $mc['iw_wikiid'] ?? '';
326 
327  return new Interwiki( null, $url, $api, $wikiId, $local, $trans );
328  }
329 
330  return false;
331  }
332 
339  private function getAllPrefixesCached( $local ) {
340  wfDebug( __METHOD__ . "()\n" );
341 
343 
344  $data = [];
345  try {
346  /* Resolve site name */
347  if ( $this->interwikiScopes >= 3 && !$this->thisSite ) {
348  $site = $this->getCacheValue( '__sites:' . $wikiId );
349 
350  if ( $site == '' ) {
351  $this->thisSite = $this->fallbackSite;
352  } else {
353  $this->thisSite = $site;
354  }
355  }
356 
357  // List of interwiki sources
358  $sources = [];
359  // Global Level
360  if ( $this->interwikiScopes >= 2 ) {
361  $sources[] = '__global';
362  }
363  // Site level
364  if ( $this->interwikiScopes >= 3 ) {
365  $sources[] = '_' . $this->thisSite;
366  }
367  $sources[] = $wikiId;
368 
369  foreach ( $sources as $source ) {
370  $list = $this->getCacheValue( '__list:' . $source );
371  foreach ( explode( ' ', $list ) as $iw_prefix ) {
372  $row = $this->getCacheValue( "{$source}:{$iw_prefix}" );
373  if ( !$row ) {
374  continue;
375  }
376 
377  list( $iw_local, $iw_url ) = explode( ' ', $row );
378 
379  if ( $local !== null && $local != $iw_local ) {
380  continue;
381  }
382 
383  $data[$iw_prefix] = [
384  'iw_prefix' => $iw_prefix,
385  'iw_url' => $iw_url,
386  'iw_local' => $iw_local,
387  ];
388  }
389  }
390  } catch ( CdbException $e ) {
391  wfDebug( __METHOD__ . ": CdbException caught, error message was "
392  . $e->getMessage() );
393  }
394 
395  return array_values( $data );
396  }
397 
404  private function getAllPrefixesDB( $local ) {
405  $db = wfGetDB( DB_REPLICA ); // TODO: inject DB LoadBalancer
406 
407  $where = [];
408 
409  if ( $local !== null ) {
410  if ( $local == 1 ) {
411  $where['iw_local'] = 1;
412  } elseif ( $local == 0 ) {
413  $where['iw_local'] = 0;
414  }
415  }
416 
417  $res = $db->select( 'interwiki',
418  self::selectFields(),
419  $where, __METHOD__, [ 'ORDER BY' => 'iw_prefix' ]
420  );
421 
422  $retval = [];
423  foreach ( $res as $row ) {
424  $retval[] = (array)$row;
425  }
426 
427  return $retval;
428  }
429 
436  public function getAllPrefixes( $local = null ) {
437  if ( $this->cdbData ) {
438  return $this->getAllPrefixesCached( $local );
439  }
440 
441  return $this->getAllPrefixesDB( $local );
442  }
443 
449  private static function selectFields() {
450  return [
451  'iw_prefix',
452  'iw_url',
453  'iw_api',
454  'iw_wikiid',
455  'iw_local',
456  'iw_trans'
457  ];
458  }
459 
460 }
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))
getAllPrefixesDB( $local)
Fetch all interwiki prefixes from DB.
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
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
static selectFields()
Return the list of interwiki fields that should be selected to create a new Interwiki object...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
getInterwikiCacheEntry( $prefix)
Get entry from interwiki cache.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
static getWikiIdFromDbDomain( $domain)
Get the wiki ID of a database domain.
Definition: WikiMap.php:259
$source
$value
InterwikiLookup implementing the "classic" interwiki storage (hardcoded up to MW 1.26).
getAllPrefixes( $local=null)
Returns all interwiki prefixes.
isValidInterwiki( $prefix)
Check whether an interwiki prefix exists.
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
$res
Definition: database.txt:21
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
invalidateCache( $prefix)
Purge the in-process and object cache for an interwiki prefix.
fetch( $prefix)
Fetch an Interwiki object.
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
loadFromArray( $mc)
Fill in member variables from an array (e.g.
Service interface for looking up Interwiki records.
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
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:123
Value object for representing interwiki records.
Definition: Interwiki.php:27
static getCurrentWikiDbDomain()
Definition: WikiMap.php:292
__construct(Language $contLang, WANObjectCache $objectCache, $objectCacheExpiry, $cdbData, $interwikiScopes, $fallbackSite)
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
Copyright (C) 2018 Kunal Mehta legoktm@member.fsf.org
load( $prefix)
Load the interwiki, trying first memcached then the DB.
getAllPrefixesCached( $local)
Fetch all interwiki prefixes from interwiki cache.
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:4287
getInterwikiCached( $prefix)
Fetch interwiki prefix data from local cache in constant database.
resetLocalCache()
Resets locally cached Interwiki objects.
const DB_REPLICA
Definition: defines.php:25
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200