3 * Tools for dealing with other locally-hosted wikis.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\MediaWikiServices
;
24 use Wikimedia\Rdbms\DatabaseDomain
;
27 * Helper tools for dealing with other locally-hosted wikis.
32 * Get a WikiReference object for $wikiID
34 * @param string $wikiID Wiki'd id (generally database name)
35 * @return WikiReference|null WikiReference object or null if the wiki was not found
37 public static function getWiki( $wikiID ) {
38 $wikiReference = self
::getWikiReferenceFromWgConf( $wikiID );
39 if ( $wikiReference ) {
40 return $wikiReference;
43 // Try sites, if $wgConf failed
44 return self
::getWikiWikiReferenceFromSites( $wikiID );
48 * @param string $wikiID
49 * @return WikiReference|null WikiReference object or null if the wiki was not found
51 private static function getWikiReferenceFromWgConf( $wikiID ) {
54 $wgConf->loadFullData();
56 list( $major, $minor ) = $wgConf->siteFromDB( $wikiID );
57 if ( $major === null ) {
60 $server = $wgConf->get( 'wgServer', $wikiID, $major,
61 [ 'lang' => $minor, 'site' => $major ] );
63 $canonicalServer = $wgConf->get( 'wgCanonicalServer', $wikiID, $major,
64 [ 'lang' => $minor, 'site' => $major ] );
65 if ( $canonicalServer === false ||
$canonicalServer === null ) {
66 $canonicalServer = $server;
69 $path = $wgConf->get( 'wgArticlePath', $wikiID, $major,
70 [ 'lang' => $minor, 'site' => $major ] );
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
75 if ( !is_string( $canonicalServer ) ||
!is_string( $path ) ||
strpos( $path, '$1' ) === false ) {
79 return new WikiReference( $canonicalServer, $path, $server );
83 * @param string $wikiID
84 * @return WikiReference|null WikiReference object or null if the wiki was not found
86 private static function getWikiWikiReferenceFromSites( $wikiID ) {
87 $siteLookup = MediaWikiServices
::getInstance()->getSiteLookup();
88 $site = $siteLookup->getSite( $wikiID );
90 if ( !$site instanceof MediaWikiSite
) {
91 // Abort if not a MediaWikiSite, as this is about Wikis
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
101 // XXX: Check whether path contains a $1?
102 $path = $urlParts['path'];
103 if ( isset( $urlParts['query'] ) ) {
104 $path .= '?' . $urlParts['query'];
107 $canonicalServer = $urlParts['scheme'] ??
'http';
108 $canonicalServer .= '://' . $urlParts['host'];
110 return new WikiReference( $canonicalServer, $path );
114 * Convenience to get the wiki's display name
116 * @todo We can give more info than just the wiki id!
117 * @param string $wikiID Wiki'd id (generally database name)
118 * @return string|int Wiki's name or $wiki_id if the wiki was not found
120 public static function getWikiName( $wikiID ) {
121 $wiki = self
::getWiki( $wikiID );
124 return $wiki->getDisplayName();
130 * Convenience to get a link to a user page on a foreign wiki
132 * @param string $wikiID Wiki'd id (generally database name)
133 * @param string $user User name (must be normalised before calling this function!)
134 * @param string|null $text Link's text; optional, default to "User:$user"
135 * @return string HTML link or false if the wiki was not found
137 public static function foreignUserLink( $wikiID, $user, $text = null ) {
138 return self
::makeForeignLink( $wikiID, "User:$user", $text );
142 * Convenience to get a link to a page on a foreign wiki
144 * @param string $wikiID Wiki'd id (generally database name)
145 * @param string $page Page name (must be normalised before calling this function!)
146 * @param string|null $text Link's text; optional, default to $page
147 * @return string|false HTML link or false if the wiki was not found
149 public static function makeForeignLink( $wikiID, $page, $text = null ) {
154 $url = self
::getForeignURL( $wikiID, $page );
155 if ( $url === false ) {
159 return Linker
::makeExternalLink( $url, $text );
163 * Convenience to get a url to a page on a foreign wiki
165 * @param string $wikiID Wiki'd id (generally database name)
166 * @param string $page Page name (must be normalised before calling this function!)
167 * @param string|null $fragmentId
169 * @return string|bool URL or false if the wiki was not found
171 public static function getForeignURL( $wikiID, $page, $fragmentId = null ) {
172 $wiki = self
::getWiki( $wikiID );
175 return $wiki->getFullUrl( $page, $fragmentId );
182 * Get canonical server info for all local wikis in the map that have one
184 * @return array Map of (local wiki ID => map of (url,parts))
187 public static function getCanonicalServerInfoForAllWikis() {
188 $cache = MediaWikiServices
::getInstance()->getLocalServerObjectCache();
190 return $cache->getWithSetCallback(
191 $cache->makeGlobalKey( 'wikimap', 'canonical-urls' ),
194 global $wgLocalDatabases, $wgCanonicalServer;
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
::getWikiIdFromDbDomain( self
::getCurrentWikiDbDomain() );
200 $infoMap[$wikiId] = [
201 'url' => $wgCanonicalServer,
202 'parts' => wfParseUrl( $wgCanonicalServer )
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 ) ];
220 * @return bool|string Wiki ID or false
223 public static function getWikiFromUrl( $url ) {
224 global $wgCanonicalServer;
226 if ( strpos( $url, "$wgCanonicalServer/" ) === 0 ) {
227 // Optimisation: Handle the the common case.
228 // (Duplicates self::getCanonicalServerInfoForAllWikis)
229 return self
::getWikiIdFromDbDomain( self
::getCurrentWikiDbDomain() );
232 $urlPartsCheck = wfParseUrl( $url );
233 if ( $urlPartsCheck === false ) {
237 static $relevantKeys = [ 'host' => 1, 'port' => 1 ];
238 $urlPartsCheck = array_intersect_key( $urlPartsCheck, $relevantKeys );
240 foreach ( self
::getCanonicalServerInfoForAllWikis() as $wikiId => $info ) {
241 $urlParts = $info['parts'];
242 if ( $urlParts === false ) {
246 $urlParts = array_intersect_key( $urlParts, $relevantKeys );
247 if ( $urlParts == $urlPartsCheck ) {
256 * Get the wiki ID of a database domain
258 * This is like DatabaseDomain::getId() without encoding (for legacy reasons) and
259 * without the schema if it is the generic installer default of "mediawiki"/"dbo"
262 * @see PostgresInstaller
263 * @see MssqlInstaller
265 * @param string|DatabaseDomain $domain
269 public static function getWikiIdFromDbDomain( $domain ) {
270 $domain = DatabaseDomain
::newFromId( $domain );
271 // Since the schema was not always part of the wiki ID, try to maintain backwards
272 // compatibility with some common cases. Assume that if the DB domain schema is just
273 // the installer default then it is probably the case that the schema is the same for
274 // all wikis in the farm. Historically, any wiki farm had to make the database/prefix
275 // combination unique per wiki. Ommit the schema if it does not seem wiki specific.
276 if ( !in_array( $domain->getSchema(), [ null, 'mediawiki', 'dbo' ], true ) ) {
277 // This means a site admin may have specifically taylored the schemas.
278 // Domain IDs might use the form <DB>-<project>- or <DB>-<project>-<language>_,
279 // meaning that the schema portion must be accounted for to disambiguate wikis.
280 return "{$domain->getDatabase()}-{$domain->getSchema()}-{$domain->getTablePrefix()}";
282 // Note that if this wiki ID is passed a a domain ID to LoadBalancer, then it can
283 // handle the schema by assuming the generic "mediawiki" schema if needed.
284 return strlen( $domain->getTablePrefix() )
285 ?
"{$domain->getDatabase()}-{$domain->getTablePrefix()}"
286 : (string)$domain->getDatabase();
290 * @return DatabaseDomain Database domain of the current wiki
293 public static function getCurrentWikiDbDomain() {
294 global $wgDBname, $wgDBmwschema, $wgDBprefix;
295 // Avoid invoking LBFactory to avoid any chance of recursion
296 return new DatabaseDomain( $wgDBname, $wgDBmwschema, (string)$wgDBprefix );
300 * @param DatabaseDomain|string $domain
301 * @return bool Whether $domain matches the DB domain of the current wiki
304 public static function isCurrentWikiDbDomain( $domain ) {
305 return self
::getCurrentWikiDbDomain()->equals( $domain );
309 * @param string $wikiId
310 * @return bool Whether $wikiId matches the wiki ID of the current wiki
313 public static function isCurrentWikiId( $wikiId ) {
314 return ( self
::getWikiIdFromDbDomain( self
::getCurrentWikiDbDomain() ) === $wikiId );