/**
* The interwiki class
* All information is loaded on creation when called by Interwiki::fetch( $prefix ).
- * All work is done on slave, because this should *never* change (except during schema updates etc, which arent wiki-related)
+ * All work is done on slave, because this should *never* change (except during
+ * schema updates etc, which aren't wiki-related)
*/
class Interwiki {
protected static $smCache = array();
const CACHE_LIMIT = 100; // 0 means unlimited, any other value is max number of entries.
- protected $mPrefix, $mURL, $mLocal, $mTrans;
+ protected $mPrefix, $mURL, $mAPI, $mWikiID, $mLocal, $mTrans;
- function __construct( $prefix = null, $url = '', $local = 0, $trans = 0 )
- {
+ public function __construct( $prefix = null, $url = '', $api = '', $wikiId = '', $local = 0, $trans = 0 ) {
$this->mPrefix = $prefix;
$this->mURL = $url;
+ $this->mAPI = $api;
+ $this->mWikiID = $wikiId;
$this->mLocal = $local;
$this->mTrans = $trans;
}
/**
* Check whether an interwiki prefix exists
- *
- * @return bool Whether it exists
- * @param $prefix string Interwiki prefix to use
+ *
+ * @param $prefix String: interwiki prefix to use
+ * @return Boolean: whether it exists
*/
- static public function isValidInterwiki( $prefix ){
- global $wgContLang;
- $prefix = $wgContLang->lc( $prefix );
- if( isset( self::$smCache[$prefix] ) ){
- return true;
- }
- global $wgInterwikiCache;
- if ($wgInterwikiCache) {
- return Interwiki::isValidInterwikiCached( $key );
- }
- $iw = Interwiki::load( $prefix );
- if( !$iw ){
- $iw = false;
- }
- if( self::CACHE_LIMIT && count( self::$smCache ) >= self::CACHE_LIMIT ){
- reset( self::$smCache );
- unset( self::$smCache[ key( self::$smCache ) ] );
- }
- self::$smCache[$prefix] = $iw;
- return true;
+ static public function isValidInterwiki( $prefix ) {
+ $result = self::fetch( $prefix );
+ return (bool)$result;
}
/**
* Fetch an Interwiki object
- *
+ *
+ * @param $prefix String: interwiki prefix to use
* @return Interwiki Object, or null if not valid
- * @param $prefix string Interwiki prefix to use
*/
static public function fetch( $prefix ) {
global $wgContLang;
+ if( $prefix == '' ) {
+ return null;
+ }
$prefix = $wgContLang->lc( $prefix );
- if( isset( self::$smCache[$prefix] ) ){
+ if( isset( self::$smCache[$prefix] ) ) {
return self::$smCache[$prefix];
}
global $wgInterwikiCache;
- if ($wgInterwikiCache) {
- return Interwiki::getInterwikiCached( $key );
- }
- $iw = Interwiki::load( $prefix );
- if( !$iw ){
- $iw = false;
+ if( $wgInterwikiCache ) {
+ $iw = Interwiki::getInterwikiCached( $prefix );
+ } else {
+ $iw = Interwiki::load( $prefix );
+ if( !$iw ) {
+ $iw = false;
+ }
}
- if( self::CACHE_LIMIT && count( self::$smCache ) >= self::CACHE_LIMIT ){
+ if( self::CACHE_LIMIT && count( self::$smCache ) >= self::CACHE_LIMIT ) {
reset( self::$smCache );
- unset( self::$smCache[ key( self::$smCache ) ] );
+ unset( self::$smCache[key( self::$smCache )] );
}
self::$smCache[$prefix] = $iw;
return $iw;
}
-
+
/**
* Fetch interwiki prefix data from local cache in constant database.
*
* @note More logic is explained in DefaultSettings.
*
- * @param $key \type{\string} Database key
- * @return \type{\Interwiki} An interwiki object
+ * @param $prefix String: interwiki prefix
+ * @return Interwiki object
*/
- protected static function getInterwikiCached( $key ) {
- $value = getInterwikiCacheEntry( $key );
-
- $s = new Interwiki( $key );
+ protected static function getInterwikiCached( $prefix ) {
+ $value = self::getInterwikiCacheEntry( $prefix );
+
+ $s = new Interwiki( $prefix );
if ( $value != '' ) {
// Split values
list( $local, $url ) = explode( ' ', $value, 2 );
$s->mURL = $url;
$s->mLocal = (int)$local;
- }else{
+ } else {
$s = false;
}
- if( self::CACHE_LIMIT && count( self::$smCache ) >= self::CACHE_LIMIT ){
- reset( self::$smCache );
- unset( self::$smCache[ key( self::$smCache ) ] );
- }
- self::$smCache[$prefix] = $s;
return $s;
}
-
- /**
- * Check whether an interwiki is in the cache
- *
- * @note More logic is explained in DefaultSettings.
- *
- * @param $key \type{\string} Database key
- * @return \type{\bool} Whether it exists
- */
- protected static function isValidInterwikiCached( $key ) {
- $value = getInterwikiCacheEntry( $key );
- return $value != '';
- }
-
+
/**
* Get entry from interwiki cache
*
* @note More logic is explained in DefaultSettings.
*
- * @param $key \type{\string} Database key
- * @return \type{\string) The entry
+ * @param $prefix String: database key
+ * @return String: the entry
*/
- protected static function getInterwikiCacheEntry( $key ){
+ protected static function getInterwikiCacheEntry( $prefix ) {
global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
static $db, $site;
- if( !$db ){
- $db = dba_open( $wgInterwikiCache, 'r', 'cdb' );
+ wfDebug( __METHOD__ . "( $prefix )\n" );
+ if( !$db ) {
+ $db = CdbReader::open( $wgInterwikiCache );
}
/* Resolve site name */
- if( $wgInterwikiScopes>=3 && !$site ) {
- $site = dba_fetch( '__sites:' . wfWikiID(), $db );
- if ( $site == "" ){
+ if( $wgInterwikiScopes >= 3 && !$site ) {
+ $site = $db->get( '__sites:' . wfWikiID() );
+ if ( $site == '' ) {
$site = $wgInterwikiFallbackSite;
}
}
-
- $value = dba_fetch( wfMemcKey( $key ), $db );
+
+ $value = $db->get( wfMemcKey( $prefix ) );
// Site level
if ( $value == '' && $wgInterwikiScopes >= 3 ) {
- $value = dba_fetch( "_{$site}:{$key}", $db );
+ $value = $db->get( "_{$site}:{$prefix}" );
}
// Global Level
if ( $value == '' && $wgInterwikiScopes >= 2 ) {
- $value = dba_fetch( "__global:{$key}", $db );
+ $value = $db->get( "__global:{$prefix}" );
}
- if ( $value == 'undef' )
+ if ( $value == 'undef' ) {
$value = '';
-
+ }
+
return $value;
}
* Load the interwiki, trying first memcached then the DB
*
* @param $prefix The interwiki prefix
- * @return bool The prefix is valid
- * @static
- *
+ * @return Boolean: the prefix is valid
*/
protected static function load( $prefix ) {
- global $wgMemc;
- $key = wfMemcKey( 'interwiki', $prefix );
- $mc = $wgMemc->get( $key );
- $iw = false;
- if( $mc && is_array( $mc ) ){ // is_array is hack for old keys
- $iw = Interwiki::loadFromArray( $mc );
- return $iw;
+ global $wgMemc, $wgInterwikiExpiry;
+
+ $iwData = false;
+ if ( !wfRunHooks( 'InterwikiLoadPrefix', array( $prefix, &$iwData ) ) ) {
+ return Interwiki::loadFromArray( $iwData );
+ }
+
+ if ( !$iwData ) {
+ $key = wfMemcKey( 'interwiki', $prefix );
+ $iwData = $wgMemc->get( $key );
+ }
+
+ if( $iwData && is_array( $iwData ) ) { // is_array is hack for old keys
+ $iw = Interwiki::loadFromArray( $iwData );
+ if( $iw ) {
+ return $iw;
+ }
}
-
+
$db = wfGetDB( DB_SLAVE );
-
+
$row = $db->fetchRow( $db->select( 'interwiki', '*', array( 'iw_prefix' => $prefix ),
__METHOD__ ) );
$iw = Interwiki::loadFromArray( $row );
if ( $iw ) {
- $mc = array( 'iw_url' => $iw->mURL, 'iw_local' => $iw->mLocal, 'iw_trans' => $iw->mTrans );
- $wgMemc->add( $key, $mc );
+ $mc = array(
+ 'iw_url' => $iw->mURL,
+ 'iw_api' => $iw->mAPI,
+ 'iw_local' => $iw->mLocal,
+ 'iw_trans' => $iw->mTrans
+ );
+ $wgMemc->add( $key, $mc, $wgInterwikiExpiry );
return $iw;
}
-
+
return false;
}
/**
* Fill in member variables from an array (e.g. memcached result, Database::fetchRow, etc)
*
- * @return bool Whether everything was there
- * @param $res ResultWrapper Row from the interwiki table
- * @static
+ * @param $mc Associative array: row from the interwiki table
+ * @return Boolean: whether everything was there
*/
protected static function loadFromArray( $mc ) {
- if( isset( $mc['iw_url'] ) && isset( $mc['iw_local'] ) && isset( $mc['iw_trans'] ) ){
+ if( isset( $mc['iw_url'] ) && isset( $mc['iw_local'] ) && isset( $mc['iw_trans'] ) ) {
$iw = new Interwiki();
$iw->mURL = $mc['iw_url'];
$iw->mLocal = $mc['iw_local'];
$iw->mTrans = $mc['iw_trans'];
+ $iw->mAPI = isset( $mc['iw_api'] ) ? $mc['iw_api'] : '';
+ $iw->mWikiID = isset( $mc['iw_wikiid'] ) ? $mc['iw_wikiid'] : '';
+
return $iw;
}
return false;
}
-
- /**
+
+ /**
* Get the URL for a particular title (or with $1 if no title given)
- *
- * @param $title string What text to put for the article name
- * @return string The URL
+ *
+ * @param $title String: what text to put for the article name
+ * @return String: the URL
*/
- function getURL( $title = null ){
+ public function getURL( $title = null ) {
$url = $this->mURL;
- if( $title != null ){
+ if( $title != null ) {
$url = str_replace( "$1", $title, $url );
}
return $url;
}
-
- function isLocal(){
+
+ /**
+ * Get the API URL for this wiki
+ *
+ * @return String: the URL
+ */
+ public function getAPI() {
+ return $this->mAPI;
+ }
+
+ /**
+ * Get the DB name for this wiki
+ *
+ * @return String: the DB name
+ */
+ public function getWikiID() {
+ return $this->mWikiID;
+ }
+
+ /**
+ * Is this a local link from a sister project, or is
+ * it something outside, like Google
+ *
+ * @return Boolean
+ */
+ public function isLocal() {
return $this->mLocal;
}
-
- function isTranscludable(){
+
+ /**
+ * Can pages from this wiki be transcluded?
+ * Still requires $wgEnableScaryTransclusion
+ *
+ * @return Boolean
+ */
+ public function isTranscludable() {
return $this->mTrans;
}
+ /**
+ * Get the name for the interwiki site
+ *
+ * @return String
+ */
+ public function getName() {
+ $msg = wfMessage( 'interwiki-name-' . $this->mPrefix )->inContentLanguage();
+ return !$msg->exists() ? '' : $msg;
+ }
+
+ /**
+ * Get a description for this interwiki
+ *
+ * @return String
+ */
+ public function getDescription() {
+ $msg = wfMessage( 'interwiki-desc-' . $this->mPrefix )->inContentLanguage();
+ return !$msg->exists() ? '' : $msg;
+ }
}