includes/interwiki/Interwiki.php

   1 <?php
   2 /**
   3  * @file
   4  * Interwiki table entry
   5  */
   6
   7 /**
   8  * The interwiki class
   9  * All information is loaded on creation when called by Interwiki::fetch( $prefix ).
  10  * All work is done on slave, because this should *never* change (except during
  11  * schema updates etc, which aren't wiki-related)
  12  */
  13 class Interwiki {
  14
  15         // Cache - removes oldest entry when it hits limit
  16         protected static $smCache = array();
  17         const CACHE_LIMIT = 100; // 0 means unlimited, any other value is max number of entries.
  18
  19         protected $mPrefix, $mURL, $mAPI, $mWikiID, $mLocal, $mTrans;
  20
  21         public function __construct( $prefix = null, $url = '', $api = '', $wikiId = '', $local = 0, $trans = 0 ) {
  22                 $this->mPrefix = $prefix;
  23                 $this->mURL = $url;
  24                 $this->mAPI = $api;
  25                 $this->mWikiID = $wikiId;
  26                 $this->mLocal = $local;
  27                 $this->mTrans = $trans;
  28         }
  29
  30         /**
  31          * Check whether an interwiki prefix exists
  32          *
  33          * @param $prefix String: interwiki prefix to use
  34          * @return Boolean: whether it exists
  35          */
  36         static public function isValidInterwiki( $prefix ) {
  37                 $result = self::fetch( $prefix );
  38                 return (bool)$result;
  39         }
  40
  41         /**
  42          * Fetch an Interwiki object
  43          *
  44          * @param $prefix String: interwiki prefix to use
  45          * @return Interwiki Object, or null if not valid
  46          */
  47         static public function fetch( $prefix ) {
  48                 global $wgContLang;
  49                 if( $prefix == '' ) {
  50                         return null;
  51                 }
  52                 $prefix = $wgContLang->lc( $prefix );
  53                 if( isset( self::$smCache[$prefix] ) ) {
  54                         return self::$smCache[$prefix];
  55                 }
  56                 global $wgInterwikiCache;
  57                 if( $wgInterwikiCache ) {
  58                         $iw = Interwiki::getInterwikiCached( $prefix );
  59                 } else {
  60                         $iw = Interwiki::load( $prefix );
  61                         if( !$iw ) {
  62                                 $iw = false;
  63                         }
  64                 }
  65                 if( self::CACHE_LIMIT && count( self::$smCache ) >= self::CACHE_LIMIT ) {
  66                         reset( self::$smCache );
  67                         unset( self::$smCache[key( self::$smCache )] );
  68                 }
  69                 self::$smCache[$prefix] = $iw;
  70                 return $iw;
  71         }
  72
  73         /**
  74          * Fetch interwiki prefix data from local cache in constant database.
  75          *
  76          * @note More logic is explained in DefaultSettings.
  77          *
  78          * @param $prefix String: interwiki prefix
  79          * @return Interwiki object
  80          */
  81         protected static function getInterwikiCached( $prefix ) {
  82                 $value = self::getInterwikiCacheEntry( $prefix );
  83
  84                 $s = new Interwiki( $prefix );
  85                 if ( $value != '' ) {
  86                         // Split values
  87                         list( $local, $url ) = explode( ' ', $value, 2 );
  88                         $s->mURL = $url;
  89                         $s->mLocal = (int)$local;
  90                 } else {
  91                         $s = false;
  92                 }
  93                 return $s;
  94         }
  95
  96         /**
  97          * Get entry from interwiki cache
  98          *
  99          * @note More logic is explained in DefaultSettings.
 100          *
 101          * @param $prefix String: database key
 102          * @return String: the entry
 103          */
 104         protected static function getInterwikiCacheEntry( $prefix ) {
 105                 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
 106                 static $db, $site;
 107
 108                 wfDebug( __METHOD__ . "( $prefix )\n" );
 109                 if( !$db ) {
 110                         $db = CdbReader::open( $wgInterwikiCache );
 111                 }
 112                 /* Resolve site name */
 113                 if( $wgInterwikiScopes >= 3 && !$site ) {
 114                         $site = $db->get( '__sites:' . wfWikiID() );
 115                         if ( $site == '' ) {
 116                                 $site = $wgInterwikiFallbackSite;
 117                         }
 118                 }
 119
 120                 $value = $db->get( wfMemcKey( $prefix ) );
 121                 // Site level
 122                 if ( $value == '' && $wgInterwikiScopes >= 3 ) {
 123                         $value = $db->get( "_{$site}:{$prefix}" );
 124                 }
 125                 // Global Level
 126                 if ( $value == '' && $wgInterwikiScopes >= 2 ) {
 127                         $value = $db->get( "__global:{$prefix}" );
 128                 }
 129                 if ( $value == 'undef' ) {
 130                         $value = '';
 131                 }
 132
 133
 134                 return $value;
 135         }
 136
 137         /**
 138          * Load the interwiki, trying first memcached then the DB
 139          *
 140          * @param $prefix string The interwiki prefix
 141          * @return Boolean: the prefix is valid
 142          */
 143         protected static function load( $prefix ) {
 144                 global $wgMemc, $wgInterwikiExpiry;
 145
 146                 $iwData = false;
 147                 if ( !wfRunHooks( 'InterwikiLoadPrefix', array( $prefix, &$iwData ) ) ) {
 148                         return Interwiki::loadFromArray( $iwData );
 149                 }
 150
 151                 if ( !$iwData ) {
 152                         $key = wfMemcKey( 'interwiki', $prefix );
 153                         $iwData = $wgMemc->get( $key );
 154                         if ( $iwData === '!NONEXISTENT' ) {
 155                                 return false; // negative cache hit
 156                         }
 157                 }
 158
 159                 if( $iwData && is_array( $iwData ) ) { // is_array is hack for old keys
 160                         $iw = Interwiki::loadFromArray( $iwData );
 161                         if( $iw ) {
 162                                 return $iw;
 163                         }
 164                 }
 165
 166                 $db = wfGetDB( DB_SLAVE );
 167
 168                 $row = $db->fetchRow( $db->select( 'interwiki', '*', array( 'iw_prefix' => $prefix ),
 169                         __METHOD__ ) );
 170                 $iw = Interwiki::loadFromArray( $row );
 171                 if ( $iw ) {
 172                         $mc = array(
 173                                 'iw_url' => $iw->mURL,
 174                                 'iw_api' => $iw->mAPI,
 175                                 'iw_local' => $iw->mLocal,
 176                                 'iw_trans' => $iw->mTrans
 177                         );
 178                         $wgMemc->add( $key, $mc, $wgInterwikiExpiry );
 179                         return $iw;
 180                 } else {
 181                         $wgMemc->add( $key, '!NONEXISTENT', $wgInterwikiExpiry ); // negative cache hit
 182                 }
 183
 184                 return false;
 185         }
 186
 187         /**
 188          * Fill in member variables from an array (e.g. memcached result, Database::fetchRow, etc)
 189          *
 190          * @param $mc array Associative array: row from the interwiki table
 191          * @return Boolean|Interwiki whether everything was there
 192          */
 193         protected static function loadFromArray( $mc ) {
 194                 if( isset( $mc['iw_url'] ) ) {
 195                         $iw = new Interwiki();
 196                         $iw->mURL = $mc['iw_url'];
 197                         $iw->mLocal = isset( $mc['iw_local'] ) ? $mc['iw_local'] : 0;
 198                         $iw->mTrans = isset( $mc['iw_trans'] ) ? $mc['iw_trans'] : 0;
 199                         $iw->mAPI = isset( $mc['iw_api'] ) ? $mc['iw_api'] : '';
 200                         $iw->mWikiID = isset( $mc['iw_wikiid'] ) ? $mc['iw_wikiid'] : '';
 201
 202                         return $iw;
 203                 }
 204                 return false;
 205         }
 206
 207         /**
 208          * Fetch all interwiki prefixes from interwiki cache
 209          *
 210          * @param $local null|string If not null, limits output to local/non-local interwikis
 211          * @return Array List of prefixes
 212          * @since 1.19
 213          */
 214         protected static function getAllPrefixesCached( $local ) {
 215                 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
 216                 static $db, $site;
 217
 218                 wfDebug( __METHOD__ . "()\n" );
 219                 if( !$db ) {
 220                         $db = CdbReader::open( $wgInterwikiCache );
 221                 }
 222                 /* Resolve site name */
 223                 if( $wgInterwikiScopes >= 3 && !$site ) {
 224                         $site = $db->get( '__sites:' . wfWikiID() );
 225                         if ( $site == '' ) {
 226                                 $site = $wgInterwikiFallbackSite;
 227                         }
 228                 }
 229
 230                 // List of interwiki sources
 231                 $sources = array();
 232                 // Global Level
 233                 if ( $wgInterwikiScopes >= 2 ) {
 234                         $sources[] = '__global';
 235                 }
 236                 // Site level
 237                 if ( $wgInterwikiScopes >= 3 ) {
 238                         $sources[] = '_' . $site;
 239                 }
 240                 $sources[] = wfWikiID();
 241
 242                 $data = array();
 243
 244                 foreach( $sources as $source ) {
 245                         $list = $db->get( "__list:{$source}" );
 246                         foreach ( explode( ' ', $list ) as $iw_prefix ) {
 247                                 $row = $db->get( "{$source}:{$iw_prefix}" );
 248                                 if( !$row ) {
 249                                         continue;
 250                                 }
 251
 252                                 list( $iw_local, $iw_url ) = explode( ' ', $row );
 253
 254                                 if ( $local !== null && $local != $iw_local ) {
 255                                         continue;
 256                                 }
 257
 258                                 $data[$iw_prefix] = array(
 259                                         'iw_prefix' => $iw_prefix,
 260                                         'iw_url'    => $iw_url,
 261                                         'iw_local'  => $iw_local,
 262                                 );
 263                         }
 264                 }
 265
 266                 ksort( $data );
 267
 268                 return array_values( $data );
 269         }
 270
 271         /**
 272          * Fetch all interwiki prefixes from DB
 273          *
 274          * @param $local string|null If not null, limits output to local/non-local interwikis
 275          * @return Array List of prefixes
 276          * @since 1.19
 277          */
 278         protected static function getAllPrefixesDB( $local ) {
 279                 $db = wfGetDB( DB_SLAVE );
 280
 281                 $where = array();
 282
 283                 if ( $local !== null ) {
 284                         if ( $local == 1 ) {
 285                                 $where['iw_local'] = 1;
 286                         } elseif ( $local == 0 ) {
 287                                 $where['iw_local'] = 0;
 288                         }
 289                 }
 290
 291                 $res = $db->select( 'interwiki',
 292                         array( 'iw_prefix', 'iw_url', 'iw_api', 'iw_wikiid', 'iw_local', 'iw_trans' ),
 293                         $where, __METHOD__, array( 'ORDER BY' => 'iw_prefix' )
 294                 );
 295                 $retval = array();
 296                 foreach ( $res as $row ) {
 297                         $retval[] = (array)$row;
 298                 }
 299                 return $retval;
 300         }
 301
 302         /**
 303          * Returns all interwiki prefixes
 304          *
 305          * @param $local string|null If set, limits output to local/non-local interwikis
 306          * @return Array List of prefixes
 307          * @since 1.19
 308          */
 309         public static function getAllPrefixes( $local = null ) {
 310                 global $wgInterwikiCache;
 311
 312                 if ( $wgInterwikiCache ) {
 313                         return self::getAllPrefixesCached( $local );
 314                 } else {
 315                         return self::getAllPrefixesDB( $local );
 316                 }
 317         }
 318
 319         /**
 320          * Get the URL for a particular title (or with $1 if no title given)
 321          *
 322          * @param $title String: what text to put for the article name
 323          * @return String: the URL
 324          * @note Prior to 1.19 The getURL with an argument was broken.
 325          *       If you if you use this arg in an extension that supports MW earlier
 326          *       than 1.19 please wfUrlencode and substitute $1 on your own.
 327          */
 328         public function getURL( $title = null ) {
 329                 $url = $this->mURL;
 330                 if( $title !== null ) {
 331                         $url = str_replace( "$1", wfUrlencode( $title ), $url );
 332                 }
 333                 return $url;
 334         }
 335
 336         /**
 337          * Get the API URL for this wiki
 338          *
 339          * @return String: the URL
 340          */
 341         public function getAPI() {
 342                 return $this->mAPI;
 343         }
 344
 345         /**
 346          * Get the DB name for this wiki
 347          *
 348          * @return String: the DB name
 349          */
 350         public function getWikiID() {
 351                 return $this->mWikiID;
 352         }
 353
 354         /**
 355          * Is this a local link from a sister project, or is
 356          * it something outside, like Google
 357          *
 358          * @return Boolean
 359          */
 360         public function isLocal() {
 361                 return $this->mLocal;
 362         }
 363
 364         /**
 365          * Can pages from this wiki be transcluded?
 366          * Still requires $wgEnableScaryTransclusion
 367          *
 368          * @return Boolean
 369          */
 370         public function isTranscludable() {
 371                 return $this->mTrans;
 372         }
 373
 374         /**
 375          * Get the name for the interwiki site
 376          *
 377          * @return String
 378          */
 379         public function getName() {
 380                 $msg = wfMessage( 'interwiki-name-' . $this->mPrefix )->inContentLanguage();
 381                 return !$msg->exists() ? '' : $msg;
 382         }
 383
 384         /**
 385          * Get a description for this interwiki
 386          *
 387          * @return String
 388          */
 389         public function getDescription() {
 390                 $msg = wfMessage( 'interwiki-desc-' . $this->mPrefix )->inContentLanguage();
 391                 return !$msg->exists() ? '' : $msg;
 392         }
 393 }