WikiMap.php

Go to the documentation of this file.

<?php
namespace MediaWiki\WikiMap;
 
use MediaWiki\MediaWikiServices;
use MediaWiki\Site\MediaWikiSite;
use MediaWiki\SpecialPage\SpecialPage;
use Wikimedia\Rdbms\DatabaseDomain;
 
class WikiMap {
 
    public static function getWiki( $wikiID ) {
        $wikiReference = self::getWikiReferenceFromWgConf( $wikiID );
        if ( $wikiReference ) {
            return $wikiReference;
        }
 
        // Try sites, if $wgConf failed
        return self::getWikiWikiReferenceFromSites( $wikiID );
    }
 
    private static function getWikiReferenceFromWgConf( $wikiID ) {
        global $wgConf;
        '@phan-var \MediaWiki\Config\SiteConfiguration $wgConf';
 
        $wgConf->loadFullData();
 
        [ $major, $minor ] = $wgConf->siteFromDB( $wikiID );
        if ( $major === null ) {
            return null;
        }
        $server = $wgConf->get( 'wgServer', $wikiID, $major,
            [ 'lang' => $minor, 'site' => $major ] );
 
        $canonicalServer = $wgConf->get( 'wgCanonicalServer', $wikiID, $major,
            [ 'lang' => $minor, 'site' => $major ] );
        if ( $canonicalServer === false || $canonicalServer === null ) {
            $canonicalServer = $server;
        }
 
        $path = $wgConf->get( 'wgArticlePath', $wikiID, $major,
            [ 'lang' => $minor, 'site' => $major ] );
 
        // If we don't have a canonical server or a path containing $1, the
        // WikiReference isn't going to function properly. Just return null in
        // that case.
        if ( !is_string( $canonicalServer ) || !is_string( $path ) || !str_contains( $path, '$1' ) ) {
            return null;
        }
 
        return new WikiReference( $canonicalServer, $path, $server );
    }
 
    private static function getWikiWikiReferenceFromSites( $wikiID ) {
        $siteLookup = MediaWikiServices::getInstance()->getSiteLookup();
        $site = $siteLookup->getSite( $wikiID );
 
        if ( !$site instanceof MediaWikiSite ) {
            // Abort if not a MediaWikiSite, as this is about Wikis
            return null;
        }
 
        $urlParts = wfGetUrlUtils()->parse( $site->getPageUrl() );
        if ( $urlParts === null || !isset( $urlParts['path'] ) || !isset( $urlParts['host'] ) ) {
            // We can't create a meaningful WikiReference without URLs
            return null;
        }
 
        // XXX: Check whether path contains a $1?
        $path = $urlParts['path'];
        if ( isset( $urlParts['query'] ) ) {
            $path .= '?' . $urlParts['query'];
        }
 
        $canonicalServer = $urlParts['scheme'] ?? 'http';
        $canonicalServer .= '://' . $urlParts['host'];
        if ( isset( $urlParts['port'] ) ) {
            $canonicalServer .= ':' . $urlParts['port'];
        }
 
        return new WikiReference( $canonicalServer, $path );
    }
 
    public static function getWikiName( $wikiID ) {
        $wiki = self::getWiki( $wikiID );
        return $wiki ? $wiki->getDisplayName() : $wikiID;
    }
 
    public static function foreignUserLink( $wikiID, $user, $text = null ) {
        return self::makeForeignLink( $wikiID, "User:$user", $text );
    }
 
    public static function makeForeignLink( $wikiID, $page, $text = null ) {
        // phpcs:ignore MediaWiki.Usage.DeprecatedGlobalVariables.Deprecated$wgTitle
        global $wgTitle;
        if ( !$text ) {
            $text = $page;
        }
 
        $url = self::getForeignURL( $wikiID, $page );
        if ( $url === false ) {
            return false;
        }
 
        $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
        return $linkRenderer->makeExternalLink(
            $url,
            $text,
            $wgTitle ?? SpecialPage::getTitleFor( 'Badtitle' )
        );
    }
 
    public static function getForeignURL( $wikiID, $page, $fragmentId = null ) {
        $wiki = self::getWiki( $wikiID );
 
        if ( $wiki ) {
            return $wiki->getFullUrl( $page, $fragmentId );
        }
 
        return false;
    }
 
    public static function getCanonicalServerInfoForAllWikis() {
        $cache = MediaWikiServices::getInstance()->getLocalServerObjectCache();
 
        return $cache->getWithSetCallback(
            $cache->makeGlobalKey( 'wikimap-canonical-urls' ),
            $cache::TTL_DAY,
            static function () {
                global $wgLocalDatabases, $wgCanonicalServer;
 
                $infoMap = [];
                // Make sure at least the current wiki is set, for simple configurations.
                // This also makes it the first in the map, which is useful for common cases.
                $wikiId = self::getCurrentWikiId();
                $infoMap[$wikiId] = [
                    'url' => $wgCanonicalServer,
                    'parts' => wfGetUrlUtils()->parse( $wgCanonicalServer )
                ];
 
                foreach ( $wgLocalDatabases as $wikiId ) {
                    $wikiReference = self::getWiki( $wikiId );
                    if ( $wikiReference ) {
                        $url = $wikiReference->getCanonicalServer();
                        $infoMap[$wikiId] = [ 'url' => $url, 'parts' => wfGetUrlUtils()->parse( $url ) ];
                    }
                }
 
                return $infoMap;
            }
        );
    }
 
    public static function getWikiFromUrl( $url ) {
        global $wgCanonicalServer;
 
        if ( str_starts_with( $url, "$wgCanonicalServer/" ) ) {
            // Optimisation: Handle the common case.
            // (Duplicates self::getCanonicalServerInfoForAllWikis)
            return self::getCurrentWikiId();
        }
 
        $urlPartsCheck = wfGetUrlUtils()->parse( $url );
        if ( $urlPartsCheck === null
            || !in_array( $urlPartsCheck['scheme'], [ '', 'http', 'https' ], true )
        ) {
            return false;
        }
 
        static $relevantKeys = [ 'host' => 1, 'port' => 1 ];
        $urlPartsCheck = array_intersect_key( $urlPartsCheck, $relevantKeys );
 
        foreach ( self::getCanonicalServerInfoForAllWikis() as $wikiId => $info ) {
            $urlParts = $info['parts'];
            if ( $urlParts === false ) {
                continue;
            }
 
            $urlParts = array_intersect_key( $urlParts, $relevantKeys );
            if ( $urlParts == $urlPartsCheck ) {
                return $wikiId;
            }
        }
 
        return false;
    }
 
    public static function getWikiIdFromDbDomain( $domain ) {
        $domain = DatabaseDomain::newFromId( $domain );
        // Since the schema was not always part of the wiki ID, try to maintain backwards
        // compatibility with some common cases. Assume that if the DB domain schema is just
        // the installer default then it is probably the case that the schema is the same for
        // all wikis in the farm. Historically, any wiki farm had to make the database/prefix
        // combination unique per wiki. Omit the schema if it does not seem wiki specific.
        if ( !in_array( $domain->getSchema(), [ null, 'mediawiki' ], true ) ) {
            // This means a site admin may have specifically tailored the schemas.
            // Domain IDs might use the form <DB>-<project>- or <DB>-<project>-<language>_,
            // meaning that the schema portion must be accounted for to disambiguate wikis.
            return "{$domain->getDatabase()}-{$domain->getSchema()}-{$domain->getTablePrefix()}";
        }
        // Note that if this wiki ID is passed as a domain ID to LoadBalancer, then it can
        // handle the schema by assuming the generic "mediawiki" schema if needed.
        return strlen( $domain->getTablePrefix() )
            ? "{$domain->getDatabase()}-{$domain->getTablePrefix()}"
            : (string)$domain->getDatabase();
    }
 
    public static function getCurrentWikiDbDomain() {
        global $wgDBname, $wgDBmwschema, $wgDBprefix;
        // Avoid invoking LBFactory to avoid any chance of recursion
        return new DatabaseDomain( $wgDBname, $wgDBmwschema, (string)$wgDBprefix );
    }
 
    public static function getCurrentWikiId() {
        return self::getWikiIdFromDbDomain( self::getCurrentWikiDbDomain() );
    }
 
    public static function isCurrentWikiDbDomain( $domain ) {
        return self::getCurrentWikiDbDomain()->equals( $domain );
    }
 
    public static function isCurrentWikiId( $wikiId ) {
        return ( self::getCurrentWikiId() === $wikiId );
    }
}