MediaWiki  master
WikiMap.php
Go to the documentation of this file.
1 <?php
25 
29 class WikiMap {
30 
37  public static function getWiki( $wikiID ) {
38  $wikiReference = self::getWikiReferenceFromWgConf( $wikiID );
39  if ( $wikiReference ) {
40  return $wikiReference;
41  }
42 
43  // Try sites, if $wgConf failed
44  return self::getWikiWikiReferenceFromSites( $wikiID );
45  }
46 
51  private static function getWikiReferenceFromWgConf( $wikiID ) {
52  global $wgConf;
53 
54  $wgConf->loadFullData();
55 
56  list( $major, $minor ) = $wgConf->siteFromDB( $wikiID );
57  if ( $major === null ) {
58  return null;
59  }
60  $server = $wgConf->get( 'wgServer', $wikiID, $major,
61  [ 'lang' => $minor, 'site' => $major ] );
62 
63  $canonicalServer = $wgConf->get( 'wgCanonicalServer', $wikiID, $major,
64  [ 'lang' => $minor, 'site' => $major ] );
65  if ( $canonicalServer === false || $canonicalServer === null ) {
66  $canonicalServer = $server;
67  }
68 
69  $path = $wgConf->get( 'wgArticlePath', $wikiID, $major,
70  [ 'lang' => $minor, 'site' => $major ] );
71 
72  // If we don't have a canonical server or a path containing $1, the
73  // WikiReference isn't going to function properly. Just return null in
74  // that case.
75  if ( !is_string( $canonicalServer ) || !is_string( $path ) || strpos( $path, '$1' ) === false ) {
76  return null;
77  }
78 
79  return new WikiReference( $canonicalServer, $path, $server );
80  }
81 
86  private static function getWikiWikiReferenceFromSites( $wikiID ) {
87  $siteLookup = MediaWikiServices::getInstance()->getSiteLookup();
88  $site = $siteLookup->getSite( $wikiID );
89 
90  if ( !$site instanceof MediaWikiSite ) {
91  // Abort if not a MediaWikiSite, as this is about Wikis
92  return null;
93  }
94 
95  $urlParts = wfParseUrl( $site->getPageUrl() );
96  if ( $urlParts === false || !isset( $urlParts['path'] ) || !isset( $urlParts['host'] ) ) {
97  // We can't create a meaningful WikiReference without URLs
98  return null;
99  }
100 
101  // XXX: Check whether path contains a $1?
102  $path = $urlParts['path'];
103  if ( isset( $urlParts['query'] ) ) {
104  $path .= '?' . $urlParts['query'];
105  }
106 
107  $canonicalServer = $urlParts['scheme'] ?? 'http';
108  $canonicalServer .= '://' . $urlParts['host'];
109 
110  return new WikiReference( $canonicalServer, $path );
111  }
112 
120  public static function getWikiName( $wikiID ) {
121  $wiki = self::getWiki( $wikiID );
122 
123  if ( $wiki ) {
124  return $wiki->getDisplayName();
125  }
126  return $wikiID;
127  }
128 
137  public static function foreignUserLink( $wikiID, $user, $text = null ) {
138  return self::makeForeignLink( $wikiID, "User:$user", $text );
139  }
140 
149  public static function makeForeignLink( $wikiID, $page, $text = null ) {
150  if ( !$text ) {
151  $text = $page;
152  }
153 
154  $url = self::getForeignURL( $wikiID, $page );
155  if ( $url === false ) {
156  return false;
157  }
158 
159  return Linker::makeExternalLink( $url, $text );
160  }
161 
171  public static function getForeignURL( $wikiID, $page, $fragmentId = null ) {
172  $wiki = self::getWiki( $wikiID );
173 
174  if ( $wiki ) {
175  return $wiki->getFullUrl( $page, $fragmentId );
176  }
177 
178  return false;
179  }
180 
187  public static function getCanonicalServerInfoForAllWikis() {
188  $cache = MediaWikiServices::getInstance()->getLocalServerObjectCache();
189 
190  return $cache->getWithSetCallback(
191  $cache->makeGlobalKey( 'wikimap', 'canonical-urls' ),
192  $cache::TTL_DAY,
193  function () {
195 
196  $infoMap = [];
197  // Make sure at least the current wiki is set, for simple configurations.
198  // This also makes it the first in the map, which is useful for common cases.
199  $wikiId = self::getWikiIdFromDomain( self::getCurrentWikiDomain() );
200  $infoMap[$wikiId] = [
201  'url' => $wgCanonicalServer,
202  'parts' => wfParseUrl( $wgCanonicalServer )
203  ];
204 
205  foreach ( $wgLocalDatabases as $wikiId ) {
206  $wikiReference = self::getWiki( $wikiId );
207  if ( $wikiReference ) {
208  $url = $wikiReference->getCanonicalServer();
209  $infoMap[$wikiId] = [ 'url' => $url, 'parts' => wfParseUrl( $url ) ];
210  }
211  }
212 
213  return $infoMap;
214  }
215  );
216  }
217 
223  public static function getWikiFromUrl( $url ) {
224  $urlPartsCheck = wfParseUrl( $url );
225  if ( $urlPartsCheck === false ) {
226  return false;
227  }
228 
229  $urlPartsCheck = array_intersect_key( $urlPartsCheck, [ 'host' => 1, 'port' => 1 ] );
230  foreach ( self::getCanonicalServerInfoForAllWikis() as $wikiId => $info ) {
231  $urlParts = $info['parts'];
232  if ( $urlParts === false ) {
233  continue; // sanity
234  }
235 
236  $urlParts = array_intersect_key( $urlParts, [ 'host' => 1, 'port' => 1 ] );
237  if ( $urlParts == $urlPartsCheck ) {
238  return $wikiId;
239  }
240  }
241 
242  return false;
243  }
244 
254  public static function getWikiIdFromDomain( $domain ) {
255  $domain = DatabaseDomain::newFromId( $domain );
256 
257  if ( !in_array( $domain->getSchema(), [ null, 'mediawiki' ], true ) ) {
258  // Include the schema if it is set and is not the default placeholder.
259  // This means a site admin may have specifically taylored the schemas.
260  // Domain IDs might use the form <DB>-<project>-<language>, meaning that
261  // the schema portion must be accounted for to disambiguate wikis.
262  return "{$domain->getDatabase()}-{$domain->getSchema()}-{$domain->getTablePrefix()}";
263  }
264 
265  // Note that if this wiki ID is passed a a domain ID to LoadBalancer, then it can
266  // handle the schema by assuming the generic "mediawiki" schema if needed.
267  return strlen( $domain->getTablePrefix() )
268  ? "{$domain->getDatabase()}-{$domain->getTablePrefix()}"
269  : (string)$domain->getDatabase();
270  }
271 
276  public static function getCurrentWikiDomain() {
278  // Avoid invoking LBFactory to avoid any chance of recursion
279  return new DatabaseDomain( $wgDBname, $wgDBmwschema, (string)$wgDBprefix );
280  }
281 
287  public static function isCurrentWikiDomain( $domain ) {
288  $domain = DatabaseDomain::newFromId( $domain );
289  $curDomain = self::getCurrentWikiDomain();
290 
291  if ( !in_array( $curDomain->getSchema(), [ null, 'mediawiki' ], true ) ) {
292  // Include the schema if it is set and is not the default placeholder.
293  // This means a site admin may have specifically taylored the schemas.
294  // Domain IDs might use the form <DB>-<project>-<language>, meaning that
295  // the schema portion must be accounted for to disambiguate wikis.
296  return $curDomain->equals( $domain );
297  }
298 
299  return (
300  $curDomain->getDatabase() === $domain->getDatabase() &&
301  $curDomain->getTablePrefix() === $domain->getTablePrefix()
302  );
303  }
304 
310  public static function isCurrentWikiId( $wikiId ) {
311  return ( self::getWikiIdFromDomain( self::getCurrentWikiDomain() ) === $wikiId );
312  }
313 }
static getWikiReferenceFromWgConf( $wikiID)
Definition: WikiMap.php:51
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
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getWikiName( $wikiID)
Convenience to get the wiki&#39;s display name.
Definition: WikiMap.php:120
static getWikiIdFromDomain( $domain)
Get the wiki ID of a database domain.
Definition: WikiMap.php:254
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
$wgDBmwschema
Mediawiki schema; this should be alphanumeric and not contain spaces nor hyphens. ...
static getCurrentWikiDomain()
Definition: WikiMap.php:276
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
static getWiki( $wikiID)
Get a WikiReference object for $wikiID.
Definition: WikiMap.php:37
static getWikiWikiReferenceFromSites( $wikiID)
Definition: WikiMap.php:86
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 noclasses just before the function returns a value If you return true
Definition: hooks.txt:1996
static getForeignURL( $wikiID, $page, $fragmentId=null)
Convenience to get a url to a page on a foreign wiki.
Definition: WikiMap.php:171
static isCurrentWikiDomain( $domain)
Definition: WikiMap.php:287
Reference to a locally-hosted wiki.
static getCanonicalServerInfoForAllWikis()
Get canonical server info for all local wikis in the map that have one.
Definition: WikiMap.php:187
$cache
Definition: mcc.php:33
static makeExternalLink( $url, $text, $escape=true, $linktype='', $attribs=[], $title=null)
Make an external link.
Definition: Linker.php:827
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
static makeForeignLink( $wikiID, $page, $text=null)
Convenience to get a link to a page on a foreign wiki.
Definition: WikiMap.php:149
$wgConf
wgConf hold the site configuration.
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
Class to handle database/prefix specification for IDatabase domains.
static isCurrentWikiId( $wikiId)
Definition: WikiMap.php:310
$wgDBprefix
Table name prefix; this should be alphanumeric and not contain spaces nor hyphens.
controlled by the following MediaWiki still creates a BagOStuff but calls it to it are no ops If the cache daemon can t be it should also disable itself fairly $wgDBname
Definition: memcached.txt:93
$wgCanonicalServer
Canonical URL of the server, to use in IRC feeds and notification e-mails.
string [] $wgLocalDatabases
Other wikis on this site, can be administered from a single developer account.
static foreignUserLink( $wikiID, $user, $text=null)
Convenience to get a link to a user page on a foreign wiki.
Definition: WikiMap.php:137
static getWikiFromUrl( $url)
Definition: WikiMap.php:223
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1487