<?php
+/**
+ * Tools for dealing with other locally-hosted wikis.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
/**
* Helper tools for dealing with other locally-hosted wikis
/**
* Get a WikiReference object for $wikiID
*
- * @param $wikiID String: wiki'd id (generally database name)
+ * @param string $wikiID wiki'd id (generally database name)
* @return WikiReference object or null if the wiki was not found
*/
public static function getWiki( $wikiID ) {
$wgConf->loadFullData();
list( $major, $minor ) = $wgConf->siteFromDB( $wikiID );
- if( isset( $major ) ) {
- $server = $wgConf->get( 'wgServer', $wikiID, $major,
- array( 'lang' => $minor, 'site' => $major ) );
- $path = $wgConf->get( 'wgArticlePath', $wikiID, $major,
- array( 'lang' => $minor, 'site' => $major ) );
- return new WikiReference( $major, $minor, $server, $path );
- } else {
+ if ( $major === null ) {
return null;
}
+ $server = $wgConf->get( 'wgServer', $wikiID, $major,
+ array( 'lang' => $minor, 'site' => $major ) );
+
+ $canonicalServer = $wgConf->get( 'wgCanonicalServer', $wikiID, $major,
+ array( 'lang' => $minor, 'site' => $major ) );
+ if ( $canonicalServer === false || $canonicalServer === null ) {
+ $canonicalServer = $server;
+ }
+
+ $path = $wgConf->get( 'wgArticlePath', $wikiID, $major,
+ array( 'lang' => $minor, 'site' => $major ) );
+ return new WikiReference( $major, $minor, $canonicalServer, $path, $server );
}
-
+
/**
* Convenience to get the wiki's display name
*
* @todo We can give more info than just the wiki id!
- * @param $wikiID String: wiki'd id (generally database name)
- * @return Wiki's name or $wiki_id if the wiki was not found
+ * @param string $wikiID wiki'd id (generally database name)
+ * @return string|int Wiki's name or $wiki_id if the wiki was not found
*/
public static function getWikiName( $wikiID ) {
$wiki = WikiMap::getWiki( $wikiID );
/**
* Convenience to get a link to a user page on a foreign wiki
*
- * @param $wikiID String: wiki'd id (generally database name)
- * @param $user String: user name (must be normalised before calling this function!)
- * @param $text String: link's text; optional, default to "User:$user"
+ * @param string $wikiID wiki'd id (generally database name)
+ * @param string $user user name (must be normalised before calling this function!)
+ * @param string $text link's text; optional, default to "User:$user"
* @return String: HTML link or false if the wiki was not found
*/
- public static function foreignUserLink( $wikiID, $user, $text=null ) {
+ public static function foreignUserLink( $wikiID, $user, $text = null ) {
return self::makeForeignLink( $wikiID, "User:$user", $text );
}
/**
* Convenience to get a link to a page on a foreign wiki
*
- * @param $wikiID String: wiki'd id (generally database name)
- * @param $page String: page name (must be normalised before calling this function!)
- * @param $text String: link's text; optional, default to $page
+ * @param string $wikiID wiki'd id (generally database name)
+ * @param string $page page name (must be normalised before calling this function!)
+ * @param string $text link's text; optional, default to $page
* @return String: HTML link or false if the wiki was not found
*/
- public static function makeForeignLink( $wikiID, $page, $text=null ) {
+ public static function makeForeignLink( $wikiID, $page, $text = null ) {
if ( !$text ) {
$text = $page;
}
/**
* Convenience to get a url to a page on a foreign wiki
*
- * @param $wikiID String: wiki'd id (generally database name)
- * @param $page String: page name (must be normalised before calling this function!)
+ * @param string $wikiID wiki'd id (generally database name)
+ * @param string $page page name (must be normalised before calling this function!)
* @return String: URL or false if the wiki was not found
*/
public static function getForeignURL( $wikiID, $page ) {
$wiki = WikiMap::getWiki( $wikiID );
-
+
if ( $wiki ) {
- return $wiki->getUrl( $page );
+ return $wiki->getFullUrl( $page );
}
-
+
return false;
}
}
class WikiReference {
private $mMinor; ///< 'en', 'meta', 'mediawiki', etc
private $mMajor; ///< 'wiki', 'wiktionary', etc
- private $mServer; ///< server override, 'www.mediawiki.org'
- private $mPath; ///< path override, '/wiki/$1'
+ private $mCanonicalServer; ///< canonical server URL, e.g. 'https://www.mediawiki.org'
+ private $mServer; ///< server URL, may be protocol-relative, e.g. '//www.mediawiki.org'
+ private $mPath; ///< path, '/wiki/$1'
- public function __construct( $major, $minor, $server, $path ) {
+ /**
+ * @param $major string
+ * @param $minor string
+ * @param $canonicalServer string
+ * @param $path string
+ * @param $server null|string
+ */
+ public function __construct( $major, $minor, $canonicalServer, $path, $server = null ) {
$this->mMajor = $major;
$this->mMinor = $minor;
- $this->mServer = $server;
+ $this->mCanonicalServer = $canonicalServer;
$this->mPath = $path;
+ $this->mServer = $server === null ? $canonicalServer : $server;
}
+ /**
+ * @return string
+ * @throws MWException
+ */
public function getHostname() {
$prefixes = array( 'http://', 'https://' );
foreach ( $prefixes as $prefix ) {
- if ( substr( $this->mServer, 0, strlen( $prefix ) ) ) {
- return substr( $this->mServer, strlen( $prefix ) );
+ if ( substr( $this->mCanonicalServer, 0, strlen( $prefix ) ) ) {
+ return substr( $this->mCanonicalServer, strlen( $prefix ) );
}
}
throw new MWException( "Invalid hostname for wiki {$this->mMinor}.{$this->mMajor}" );
*/
public function getDisplayName() {
$url = $this->getUrl( '' );
- $url = preg_replace( '!^https?://!', '', $url );
- $url = preg_replace( '!/index\.php(\?title=|/)$!', '/', $url );
- $url = preg_replace( '!/wiki/$!', '/', $url );
- $url = preg_replace( '!/$!', '', $url );
- return $url;
+ $parsed = wfParseUrl( $url );
+ if ( $parsed ) {
+ return $parsed['host'];
+ } else {
+ // Invalid URL. There's no sane thing to do here, so just return it
+ return $url;
+ }
}
/**
* Helper function for getUrl()
*
* @todo FIXME: This may be generalized...
- * @param $page String: page name (must be normalised before calling this function!)
+ * @param string $page page name (must be normalised before calling this function!)
* @return String: Url fragment
*/
private function getLocalUrl( $page ) {
}
/**
- * Get a URL to a page on this foreign wiki
+ * Get a canonical (i.e. based on $wgCanonicalServer) URL to a page on this foreign wiki
*
- * @param $page String: page name (must be normalised before calling this function!)
+ * @param string $page page name (must be normalised before calling this function!)
* @return String: Url
*/
+ public function getCanonicalUrl( $page ) {
+ return $this->mCanonicalServer . $this->getLocalUrl( $page );
+ }
+
+ /**
+ * Get a canonical server URL
+ * @return string
+ */
+ public function getCanonicalServer() {
+ return $this->mCanonicalServer;
+ }
+
+ /**
+ * Alias for getCanonicalUrl(), for backwards compatibility.
+ * @param $page string
+ * @return String
+ */
public function getUrl( $page ) {
- return
- $this->mServer .
+ return $this->getCanonicalUrl( $page );
+ }
+
+ /**
+ * Get a URL based on $wgServer, like Title::getFullURL() would produce
+ * when called locally on the wiki.
+ *
+ * @param string $page page name (must be normalized before calling this function!)
+ * @return String: URL
+ */
+ public function getFullUrl( $page ) {
+ return $this->mServer .
$this->getLocalUrl( $page );
}
}
dépôts / lhc / web / wiklou.git / blobdiff