4 * Helper tools for dealing with other locally-hosted wikis
9 * Get a WikiReference object for $wikiID
11 * @param $wikiID String: wiki'd id (generally database name)
12 * @return WikiReference object or null if the wiki was not found
14 public static function getWiki( $wikiID ) {
17 $wgConf->loadFullData();
19 list( $major, $minor ) = $wgConf->siteFromDB( $wikiID );
20 if( $major === null ) {
23 $server = $wgConf->get( 'wgCanonicalServer', $wikiID, $major,
24 array( 'lang' => $minor, 'site' => $major ) );
25 $path = $wgConf->get( 'wgArticlePath', $wikiID, $major,
26 array( 'lang' => $minor, 'site' => $major ) );
27 return new WikiReference( $major, $minor, $server, $path );
31 * Convenience to get the wiki's display name
33 * @todo We can give more info than just the wiki id!
34 * @param $wikiID String: wiki'd id (generally database name)
35 * @return Wiki's name or $wiki_id if the wiki was not found
37 public static function getWikiName( $wikiID ) {
38 $wiki = WikiMap
::getWiki( $wikiID );
41 return $wiki->getDisplayName();
47 * Convenience to get a link to a user page on a foreign wiki
49 * @param $wikiID String: wiki'd id (generally database name)
50 * @param $user String: user name (must be normalised before calling this function!)
51 * @param $text String: link's text; optional, default to "User:$user"
52 * @return String: HTML link or false if the wiki was not found
54 public static function foreignUserLink( $wikiID, $user, $text=null ) {
55 return self
::makeForeignLink( $wikiID, "User:$user", $text );
59 * Convenience to get a link to a page on a foreign wiki
61 * @param $wikiID String: wiki'd id (generally database name)
62 * @param $page String: page name (must be normalised before calling this function!)
63 * @param $text String: link's text; optional, default to $page
64 * @return String: HTML link or false if the wiki was not found
66 public static function makeForeignLink( $wikiID, $page, $text=null ) {
71 $url = self
::getForeignURL( $wikiID, $page );
72 if ( $url === false ) {
76 return Linker
::makeExternalLink( $url, $text );
80 * Convenience to get a url to a page on a foreign wiki
82 * @param $wikiID String: wiki'd id (generally database name)
83 * @param $page String: page name (must be normalised before calling this function!)
84 * @return String: URL or false if the wiki was not found
86 public static function getForeignURL( $wikiID, $page ) {
87 $wiki = WikiMap
::getWiki( $wikiID );
90 return $wiki->getUrl( $page );
98 * Reference to a locally-hosted wiki
100 class WikiReference
{
101 private $mMinor; ///< 'en', 'meta', 'mediawiki', etc
102 private $mMajor; ///< 'wiki', 'wiktionary', etc
103 private $mServer; ///< server override, 'www.mediawiki.org'
104 private $mPath; ///< path override, '/wiki/$1'
106 public function __construct( $major, $minor, $server, $path ) {
107 $this->mMajor
= $major;
108 $this->mMinor
= $minor;
109 $this->mServer
= $server;
110 $this->mPath
= $path;
113 public function getHostname() {
114 $prefixes = array( 'http://', 'https://' );
115 foreach ( $prefixes as $prefix ) {
116 if ( substr( $this->mServer
, 0, strlen( $prefix ) ) ) {
117 return substr( $this->mServer
, strlen( $prefix ) );
120 throw new MWException( "Invalid hostname for wiki {$this->mMinor}.{$this->mMajor}" );
124 * Get the the URL in a way to de displayed to the user
125 * More or less Wikimedia specific
129 public function getDisplayName() {
130 $url = $this->getUrl( '' );
131 $parsed = wfParseUrl( $url );
133 return $parsed['host'];
135 // Invalid URL. There's no sane thing to do here, so just return it
141 * Helper function for getUrl()
143 * @todo FIXME: This may be generalized...
144 * @param $page String: page name (must be normalised before calling this function!)
145 * @return String: Url fragment
147 private function getLocalUrl( $page ) {
148 return str_replace( '$1', wfUrlEncode( str_replace( ' ', '_', $page ) ), $this->mPath
);
152 * Get a URL to a page on this foreign wiki
154 * @param $page String: page name (must be normalised before calling this function!)
155 * @return String: Url
157 public function getUrl( $page ) {
160 $this->getLocalUrl( $page );