4 * Interwiki table entry
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)
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.
19 protected $mPrefix, $mURL, $mAPI, $mWikiID, $mLocal, $mTrans;
21 public function __construct( $prefix = null, $url = '', $api = '', $wikiId = '', $local = 0, $trans = 0 ) {
22 $this->mPrefix
= $prefix;
25 $this->mWikiID
= $wikiId;
26 $this->mLocal
= $local;
27 $this->mTrans
= $trans;
31 * Check whether an interwiki prefix exists
33 * @param $prefix String: interwiki prefix to use
34 * @return Boolean: whether it exists
36 static public function isValidInterwiki( $prefix ) {
37 $result = self
::fetch( $prefix );
42 * Fetch an Interwiki object
44 * @param $prefix String: interwiki prefix to use
45 * @return Interwiki Object, or null if not valid
47 static public function fetch( $prefix ) {
52 $prefix = $wgContLang->lc( $prefix );
53 if( isset( self
::$smCache[$prefix] ) ) {
54 return self
::$smCache[$prefix];
56 global $wgInterwikiCache;
57 if( $wgInterwikiCache ) {
58 $iw = Interwiki
::getInterwikiCached( $prefix );
60 $iw = Interwiki
::load( $prefix );
65 if( self
::CACHE_LIMIT
&& count( self
::$smCache ) >= self
::CACHE_LIMIT
) {
66 reset( self
::$smCache );
67 unset( self
::$smCache[key( self
::$smCache )] );
69 self
::$smCache[$prefix] = $iw;
74 * Fetch interwiki prefix data from local cache in constant database.
76 * @note More logic is explained in DefaultSettings.
78 * @param $prefix String: interwiki prefix
79 * @return Interwiki object
81 protected static function getInterwikiCached( $prefix ) {
82 $value = self
::getInterwikiCacheEntry( $prefix );
84 $s = new Interwiki( $prefix );
87 list( $local, $url ) = explode( ' ', $value, 2 );
89 $s->mLocal
= (int)$local;
97 * Get entry from interwiki cache
99 * @note More logic is explained in DefaultSettings.
101 * @param $prefix String: database key
102 * @return String: the entry
104 protected static function getInterwikiCacheEntry( $prefix ) {
105 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
108 wfDebug( __METHOD__
. "( $prefix )\n" );
110 $db = CdbReader
::open( $wgInterwikiCache );
112 /* Resolve site name */
113 if( $wgInterwikiScopes >= 3 && !$site ) {
114 $site = $db->get( '__sites:' . wfWikiID() );
116 $site = $wgInterwikiFallbackSite;
120 $value = $db->get( wfMemcKey( $prefix ) );
122 if ( $value == '' && $wgInterwikiScopes >= 3 ) {
123 $value = $db->get( "_{$site}:{$prefix}" );
126 if ( $value == '' && $wgInterwikiScopes >= 2 ) {
127 $value = $db->get( "__global:{$prefix}" );
129 if ( $value == 'undef' ) {
137 * Load the interwiki, trying first memcached then the DB
139 * @param $prefix The interwiki prefix
140 * @return Boolean: the prefix is valid
142 protected static function load( $prefix ) {
143 global $wgMemc, $wgInterwikiExpiry;
146 if ( !wfRunHooks( 'InterwikiLoadPrefix', array( $prefix, &$iwData ) ) ) {
147 return Interwiki
::loadFromArray( $iwData );
151 $key = wfMemcKey( 'interwiki', $prefix );
152 $iwData = $wgMemc->get( $key );
153 if ( $iwData === '!NONEXISTENT' ) {
154 return false; // negative cache hit
158 if( $iwData && is_array( $iwData ) ) { // is_array is hack for old keys
159 $iw = Interwiki
::loadFromArray( $iwData );
165 $db = wfGetDB( DB_SLAVE
);
167 $row = $db->fetchRow( $db->select( 'interwiki', '*', array( 'iw_prefix' => $prefix ),
169 $iw = Interwiki
::loadFromArray( $row );
172 'iw_url' => $iw->mURL
,
173 'iw_api' => $iw->mAPI
,
174 'iw_local' => $iw->mLocal
,
175 'iw_trans' => $iw->mTrans
177 $wgMemc->add( $key, $mc, $wgInterwikiExpiry );
180 $wgMemc->add( $key, '!NONEXISTENT', $wgInterwikiExpiry ); // negative cache hit
187 * Fill in member variables from an array (e.g. memcached result, Database::fetchRow, etc)
189 * @param $mc Associative array: row from the interwiki table
190 * @return Boolean: whether everything was there
192 protected static function loadFromArray( $mc ) {
193 if( isset( $mc['iw_url'] ) ) {
194 $iw = new Interwiki();
195 $iw->mURL
= $mc['iw_url'];
196 $iw->mLocal
= isset( $mc['iw_local'] ) ?
$mc['iw_local'] : 0;
197 $iw->mTrans
= isset( $mc['iw_trans'] ) ?
$mc['iw_trans'] : 0;
198 $iw->mAPI
= isset( $mc['iw_api'] ) ?
$mc['iw_api'] : '';
199 $iw->mWikiID
= isset( $mc['iw_wikiid'] ) ?
$mc['iw_wikiid'] : '';
207 * Fetch all interwiki prefixes from interwiki cache
209 * @param $local If not null, limits output to local/non-local interwikis
210 * @return Array List of prefixes
213 protected static function getAllPrefixesCached( $local ) {
214 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
217 wfDebug( __METHOD__
. "()\n" );
219 $db = CdbReader
::open( $wgInterwikiCache );
221 /* Resolve site name */
222 if( $wgInterwikiScopes >= 3 && !$site ) {
223 $site = $db->get( '__sites:' . wfWikiID() );
225 $site = $wgInterwikiFallbackSite;
229 // List of interwiki sources
232 if ( $wgInterwikiScopes >= 2 ) {
233 $sources[] = '__global';
236 if ( $wgInterwikiScopes >= 3 ) {
237 $sources[] = '_' . $site;
239 $sources[] = wfWikiID();
243 foreach( $sources as $source ) {
244 $list = $db->get( "__list:{$source}" );
245 foreach ( explode( ' ', $list ) as $iw_prefix ) {
246 $row = $db->get( "{$source}:{$iw_prefix}" );
251 list( $iw_local, $iw_url ) = explode( ' ', $row );
253 if ( $local !== null && $local != $iw_local ) {
257 $data[$iw_prefix] = array(
258 'iw_prefix' => $iw_prefix,
260 'iw_local' => $iw_local,
267 return array_values( $data );
271 * Fetch all interwiki prefixes from DB
273 * @param $local If not null, limits output to local/non-local interwikis
274 * @return Array List of prefixes
277 protected static function getAllPrefixesDB( $local ) {
278 $db = wfGetDB( DB_SLAVE
);
282 if ( $local !== null ) {
284 $where['iw_local'] = 1;
285 } elseif ( $local == 0 ) {
286 $where['iw_local'] = 0;
290 $res = $db->select( 'interwiki',
291 array( 'iw_prefix', 'iw_url', 'iw_api', 'iw_wikiid', 'iw_local', 'iw_trans' ),
292 $where, __METHOD__
, array( 'ORDER BY' => 'iw_prefix' )
295 foreach ( $res as $row ) {
296 $retval[] = (array)$row;
302 * Returns all interwiki prefixes
304 * @param $local If set, limits output to local/non-local interwikis
305 * @return Array List of prefixes
308 public static function getAllPrefixes( $local = null ) {
309 global $wgInterwikiCache;
311 if ( $wgInterwikiCache ) {
312 return self
::getAllPrefixesCached( $local );
314 return self
::getAllPrefixesDB( $local );
319 * Get the URL for a particular title (or with $1 if no title given)
321 * @param $title String: what text to put for the article name
322 * @return String: the URL
323 * @note Prior to 1.19 The getURL with an argument was broken.
324 * If you if you use this arg in an extension that supports MW earlier
325 * than 1.19 please wfUrlencode and substitute $1 on your own.
327 public function getURL( $title = null ) {
329 if( $title !== null ) {
330 $url = str_replace( "$1", wfUrlencode( $title ), $url );
336 * Get the API URL for this wiki
338 * @return String: the URL
340 public function getAPI() {
345 * Get the DB name for this wiki
347 * @return String: the DB name
349 public function getWikiID() {
350 return $this->mWikiID
;
354 * Is this a local link from a sister project, or is
355 * it something outside, like Google
359 public function isLocal() {
360 return $this->mLocal
;
364 * Can pages from this wiki be transcluded?
365 * Still requires $wgEnableScaryTransclusion
369 public function isTranscludable() {
370 return $this->mTrans
;
374 * Get the name for the interwiki site
378 public function getName() {
379 $msg = wfMessage( 'interwiki-name-' . $this->mPrefix
)->inContentLanguage();
380 return !$msg->exists() ?
'' : $msg;
384 * Get a description for this interwiki
388 public function getDescription() {
389 $msg = wfMessage( 'interwiki-desc-' . $this->mPrefix
)->inContentLanguage();
390 return !$msg->exists() ?
'' : $msg;