3 * Interwiki table entry.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
22 use \Cdb\Exception
as CdbException
;
23 use \Cdb\Reader
as CdbReader
;
27 * All information is loaded on creation when called by Interwiki::fetch( $prefix ).
28 * All work is done on slave, because this should *never* change (except during
29 * schema updates etc, which aren't wiki-related)
32 // Cache - removes oldest entry when it hits limit
33 protected static $smCache = array();
34 const CACHE_LIMIT
= 100; // 0 means unlimited, any other value is max number of entries.
36 /** @var string The interwiki prefix, (e.g. "Meatball", or the language prefix "de") */
39 /** @var string The URL of the wiki, with "$1" as a placeholder for an article name. */
42 /** @var string The URL of the file api.php */
45 /** @var string The name of the database (for a connection to be established
46 * with wfGetLB( 'wikiid' ))
50 /** @var bool Whether the wiki is in this project */
53 /** @var bool Whether interwiki transclusions are allowed */
56 public function __construct( $prefix = null, $url = '', $api = '', $wikiId = '', $local = 0,
59 $this->mPrefix
= $prefix;
62 $this->mWikiID
= $wikiId;
63 $this->mLocal
= $local;
64 $this->mTrans
= $trans;
68 * Check whether an interwiki prefix exists
70 * @param string $prefix Interwiki prefix to use
71 * @return bool Whether it exists
73 public static function isValidInterwiki( $prefix ) {
74 $result = self
::fetch( $prefix );
80 * Fetch an Interwiki object
82 * @param string $prefix Interwiki prefix to use
83 * @return Interwiki|null|bool
85 public static function fetch( $prefix ) {
88 if ( $prefix == '' ) {
92 $prefix = $wgContLang->lc( $prefix );
93 if ( isset( self
::$smCache[$prefix] ) ) {
94 return self
::$smCache[$prefix];
97 global $wgInterwikiCache;
98 if ( $wgInterwikiCache ) {
99 $iw = Interwiki
::getInterwikiCached( $prefix );
101 $iw = Interwiki
::load( $prefix );
107 if ( self
::CACHE_LIMIT
&& count( self
::$smCache ) >= self
::CACHE_LIMIT
) {
108 reset( self
::$smCache );
109 unset( self
::$smCache[key( self
::$smCache )] );
112 self
::$smCache[$prefix] = $iw;
118 * Purge the cache for an interwiki prefix
119 * @param string $prefix
122 public static function invalidateCache( $prefix ) {
123 $cache = ObjectCache
::getMainWANInstance();
124 $key = wfMemcKey( 'interwiki', $prefix );
125 $cache->delete( $key );
129 * Fetch interwiki prefix data from local cache in constant database.
131 * @note More logic is explained in DefaultSettings.
133 * @param string $prefix Interwiki prefix
136 protected static function getInterwikiCached( $prefix ) {
137 $value = self
::getInterwikiCacheEntry( $prefix );
139 $s = new Interwiki( $prefix );
140 if ( $value != '' ) {
142 list( $local, $url ) = explode( ' ', $value, 2 );
144 $s->mLocal
= (int)$local;
153 * Get entry from interwiki cache
155 * @note More logic is explained in DefaultSettings.
157 * @param string $prefix Database key
158 * @return string The interwiki entry
160 protected static function getInterwikiCacheEntry( $prefix ) {
161 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
164 wfDebug( __METHOD__
. "( $prefix )\n" );
168 $db = CdbReader
::open( $wgInterwikiCache );
170 /* Resolve site name */
171 if ( $wgInterwikiScopes >= 3 && !$site ) {
172 $site = $db->get( '__sites:' . wfWikiID() );
174 $site = $wgInterwikiFallbackSite;
178 $value = $db->get( wfMemcKey( $prefix ) );
180 if ( $value == '' && $wgInterwikiScopes >= 3 ) {
181 $value = $db->get( "_{$site}:{$prefix}" );
184 if ( $value == '' && $wgInterwikiScopes >= 2 ) {
185 $value = $db->get( "__global:{$prefix}" );
187 if ( $value == 'undef' ) {
190 } catch ( CdbException
$e ) {
191 wfDebug( __METHOD__
. ": CdbException caught, error message was "
192 . $e->getMessage() );
199 * Load the interwiki, trying first memcached then the DB
201 * @param string $prefix The interwiki prefix
202 * @return Interwiki|bool Interwiki if $prefix is valid, otherwise false
204 protected static function load( $prefix ) {
205 global $wgInterwikiExpiry;
208 if ( !Hooks
::run( 'InterwikiLoadPrefix', array( $prefix, &$iwData ) ) ) {
209 return Interwiki
::loadFromArray( $iwData );
212 $cache = ObjectCache
::getMainWANInstance();
215 $key = wfMemcKey( 'interwiki', $prefix );
216 $iwData = $cache->get( $key );
217 if ( $iwData === '!NONEXISTENT' ) {
218 // negative cache hit
223 // is_array is hack for old keys
224 if ( $iwData && is_array( $iwData ) ) {
225 $iw = Interwiki
::loadFromArray( $iwData );
231 $db = wfGetDB( DB_SLAVE
);
233 $row = $db->fetchRow( $db->select(
235 self
::selectFields(),
236 array( 'iw_prefix' => $prefix ),
240 $iw = Interwiki
::loadFromArray( $row );
243 'iw_url' => $iw->mURL
,
244 'iw_api' => $iw->mAPI
,
245 'iw_local' => $iw->mLocal
,
246 'iw_trans' => $iw->mTrans
248 $cache->set( $key, $mc, $wgInterwikiExpiry );
253 // negative cache hit
254 $cache->set( $key, '!NONEXISTENT', $wgInterwikiExpiry );
260 * Fill in member variables from an array (e.g. memcached result, Database::fetchRow, etc)
262 * @param array $mc Associative array: row from the interwiki table
263 * @return Interwiki|bool Interwiki object or false if $mc['iw_url'] is not set
265 protected static function loadFromArray( $mc ) {
266 if ( isset( $mc['iw_url'] ) ) {
267 $iw = new Interwiki();
268 $iw->mURL
= $mc['iw_url'];
269 $iw->mLocal
= isset( $mc['iw_local'] ) ?
$mc['iw_local'] : 0;
270 $iw->mTrans
= isset( $mc['iw_trans'] ) ?
$mc['iw_trans'] : 0;
271 $iw->mAPI
= isset( $mc['iw_api'] ) ?
$mc['iw_api'] : '';
272 $iw->mWikiID
= isset( $mc['iw_wikiid'] ) ?
$mc['iw_wikiid'] : '';
281 * Fetch all interwiki prefixes from interwiki cache
283 * @param null|string $local If not null, limits output to local/non-local interwikis
284 * @return array List of prefixes
287 protected static function getAllPrefixesCached( $local ) {
288 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
291 wfDebug( __METHOD__
. "()\n" );
295 $db = CdbReader
::open( $wgInterwikiCache );
297 /* Resolve site name */
298 if ( $wgInterwikiScopes >= 3 && !$site ) {
299 $site = $db->get( '__sites:' . wfWikiID() );
301 $site = $wgInterwikiFallbackSite;
305 // List of interwiki sources
308 if ( $wgInterwikiScopes >= 2 ) {
309 $sources[] = '__global';
312 if ( $wgInterwikiScopes >= 3 ) {
313 $sources[] = '_' . $site;
315 $sources[] = wfWikiID();
317 foreach ( $sources as $source ) {
318 $list = $db->get( "__list:{$source}" );
319 foreach ( explode( ' ', $list ) as $iw_prefix ) {
320 $row = $db->get( "{$source}:{$iw_prefix}" );
325 list( $iw_local, $iw_url ) = explode( ' ', $row );
327 if ( $local !== null && $local != $iw_local ) {
331 $data[$iw_prefix] = array(
332 'iw_prefix' => $iw_prefix,
334 'iw_local' => $iw_local,
338 } catch ( CdbException
$e ) {
339 wfDebug( __METHOD__
. ": CdbException caught, error message was "
340 . $e->getMessage() );
345 return array_values( $data );
349 * Fetch all interwiki prefixes from DB
351 * @param string|null $local If not null, limits output to local/non-local interwikis
352 * @return array List of prefixes
355 protected static function getAllPrefixesDB( $local ) {
356 $db = wfGetDB( DB_SLAVE
);
360 if ( $local !== null ) {
362 $where['iw_local'] = 1;
363 } elseif ( $local == 0 ) {
364 $where['iw_local'] = 0;
368 $res = $db->select( 'interwiki',
369 self
::selectFields(),
370 $where, __METHOD__
, array( 'ORDER BY' => 'iw_prefix' )
374 foreach ( $res as $row ) {
375 $retval[] = (array)$row;
382 * Returns all interwiki prefixes
384 * @param string|null $local If set, limits output to local/non-local interwikis
385 * @return array List of prefixes
388 public static function getAllPrefixes( $local = null ) {
389 global $wgInterwikiCache;
391 if ( $wgInterwikiCache ) {
392 return self
::getAllPrefixesCached( $local );
395 return self
::getAllPrefixesDB( $local );
399 * Get the URL for a particular title (or with $1 if no title given)
401 * @param string $title What text to put for the article name
402 * @return string The URL
403 * @note Prior to 1.19 The getURL with an argument was broken.
404 * If you if you use this arg in an extension that supports MW earlier
405 * than 1.19 please wfUrlencode and substitute $1 on your own.
407 public function getURL( $title = null ) {
409 if ( $title !== null ) {
410 $url = str_replace( "$1", wfUrlencode( $title ), $url );
417 * Get the API URL for this wiki
419 * @return string The URL
421 public function getAPI() {
426 * Get the DB name for this wiki
428 * @return string The DB name
430 public function getWikiID() {
431 return $this->mWikiID
;
435 * Is this a local link from a sister project, or is
436 * it something outside, like Google
440 public function isLocal() {
441 return $this->mLocal
;
445 * Can pages from this wiki be transcluded?
446 * Still requires $wgEnableScaryTransclusion
450 public function isTranscludable() {
451 return $this->mTrans
;
455 * Get the name for the interwiki site
459 public function getName() {
460 $msg = wfMessage( 'interwiki-name-' . $this->mPrefix
)->inContentLanguage();
462 return !$msg->exists() ?
'' : $msg;
466 * Get a description for this interwiki
470 public function getDescription() {
471 $msg = wfMessage( 'interwiki-desc-' . $this->mPrefix
)->inContentLanguage();
473 return !$msg->exists() ?
'' : $msg;
477 * Return the list of interwiki fields that should be selected to create
478 * a new Interwiki object.
481 public static function selectFields() {