WikiMap.php

Go to the documentation of this file.

<?php
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;

        $wgConf->loadFullData();

        list( $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 ) || strpos( $path, '$1' ) === false ) {
            return null;
        }

        return new WikiReference( $canonicalServer, $path, $server );
    }

    private static function getWikiWikiReferenceFromSites( $wikiID ) {
        $siteLookup = \MediaWiki\MediaWikiServices::getInstance()->getSiteLookup();
        $site = $siteLookup->getSite( $wikiID );

        if ( !$site instanceof MediaWikiSite ) {
            // Abort if not a MediaWikiSite, as this is about Wikis
            return null;
        }

        $urlParts = wfParseUrl( $site->getPageUrl() );
        if ( $urlParts === false || !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 = isset( $urlParts['scheme'] ) ? $urlParts['scheme'] : 'http';
        $canonicalServer .= '://' . $urlParts['host'];

        return new WikiReference( $canonicalServer, $path );
    }

    public static function getWikiName( $wikiID ) {
        $wiki = WikiMap::getWiki( $wikiID );

        if ( $wiki ) {
            return $wiki->getDisplayName();
        }
        return $wikiID;
    }

    public static function foreignUserLink( $wikiID, $user, $text = null ) {
        return self::makeForeignLink( $wikiID, "User:$user", $text );
    }

    public static function makeForeignLink( $wikiID, $page, $text = null ) {
        if ( !$text ) {
            $text = $page;
        }

        $url = self::getForeignURL( $wikiID, $page );
        if ( $url === false ) {
            return false;
        }

        return Linker::makeExternalLink( $url, $text );
    }

    public static function getForeignURL( $wikiID, $page, $fragmentId = null ) {
        $wiki = WikiMap::getWiki( $wikiID );

        if ( $wiki ) {
            return $wiki->getFullUrl( $page, $fragmentId );
        }

        return false;
    }
}

class WikiReference {
    private $mCanonicalServer; 
    private $mServer; 
    private $mPath;   

    public function __construct( $canonicalServer, $path, $server = null ) {
        $this->mCanonicalServer = $canonicalServer;
        $this->mPath = $path;
        $this->mServer = $server === null ? $canonicalServer : $server;
    }

    public function getDisplayName() {
        $parsed = wfParseUrl( $this->mCanonicalServer );
        if ( $parsed ) {
            return $parsed['host'];
        } else {
            // Invalid server spec.
            // There's no sane thing to do here, so just return the canonical server name in full.
            return $this->mCanonicalServer;
        }
    }

    private function getLocalUrl( $page, $fragmentId = null ) {
        $page = wfUrlencode( str_replace( ' ', '_', $page ) );

        if ( is_string( $fragmentId ) && $fragmentId !== '' ) {
            $page .= '#' . wfUrlencode( $fragmentId );
        }

        return str_replace( '$1', $page, $this->mPath );
    }

    public function getCanonicalUrl( $page, $fragmentId = null ) {
        return $this->mCanonicalServer . $this->getLocalUrl( $page, $fragmentId );
    }

    public function getCanonicalServer() {
        return $this->mCanonicalServer;
    }

    public function getUrl( $page, $fragmentId = null ) {
        return $this->getCanonicalUrl( $page, $fragmentId );
    }

    public function getFullUrl( $page, $fragmentId = null ) {
        return $this->mServer .
            $this->getLocalUrl( $page, $fragmentId );
    }
}