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 );
155 if( $iwData && is_array( $iwData ) ) { // is_array is hack for old keys
156 $iw = Interwiki
::loadFromArray( $iwData );
162 $db = wfGetDB( DB_SLAVE
);
164 $row = $db->fetchRow( $db->select( 'interwiki', '*', array( 'iw_prefix' => $prefix ),
166 $iw = Interwiki
::loadFromArray( $row );
169 'iw_url' => $iw->mURL
,
170 'iw_api' => $iw->mAPI
,
171 'iw_local' => $iw->mLocal
,
172 'iw_trans' => $iw->mTrans
174 $wgMemc->add( $key, $mc, $wgInterwikiExpiry );
182 * Fill in member variables from an array (e.g. memcached result, Database::fetchRow, etc)
184 * @param $mc Associative array: row from the interwiki table
185 * @return Boolean: whether everything was there
187 protected static function loadFromArray( $mc ) {
188 if( isset( $mc['iw_url'] ) ) {
189 $iw = new Interwiki();
190 $iw->mURL
= $mc['iw_url'];
191 $iw->mLocal
= isset( $mc['iw_local'] ) ?
$mc['iw_local'] : 0;
192 $iw->mTrans
= isset( $mc['iw_trans'] ) ?
$mc['iw_trans'] : 0;
193 $iw->mAPI
= isset( $mc['iw_api'] ) ?
$mc['iw_api'] : '';
194 $iw->mWikiID
= isset( $mc['iw_wikiid'] ) ?
$mc['iw_wikiid'] : '';
202 * Fetch all interwiki prefixes from interwiki cache
204 * @param $local If not null, limits output to local/non-local interwikis
205 * @return Array List of prefixes
208 protected static function getAllPrefixesCached( $local ) {
209 global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
212 wfDebug( __METHOD__
. "()\n" );
214 $db = CdbReader
::open( $wgInterwikiCache );
216 /* Resolve site name */
217 if( $wgInterwikiScopes >= 3 && !$site ) {
218 $site = $db->get( '__sites:' . wfWikiID() );
220 $site = $wgInterwikiFallbackSite;
224 // List of interwiki sources
227 if ( $wgInterwikiScopes >= 2 ) {
228 $sources[] = '__global';
231 if ( $wgInterwikiScopes >= 3 ) {
232 $sources[] = '_' . $site;
234 $sources[] = wfWikiID();
238 foreach( $sources as $source ) {
239 $list = $db->get( "__list:{$source}" );
240 foreach ( explode( ' ', $list ) as $iw_prefix ) {
241 $row = $db->get( "{$source}:{$iw_prefix}" );
246 list( $iw_local, $iw_url ) = explode( ' ', $row );
248 if ( $local !== null && $local != $iw_local ) {
252 $data[$iw_prefix] = array(
253 'iw_prefix' => $iw_prefix,
255 'iw_local' => $iw_local,
262 return array_values( $data );
266 * Fetch all interwiki prefixes from DB
268 * @param $local If not null, limits output to local/non-local interwikis
269 * @return Array List of prefixes
272 protected static function getAllPrefixesDB( $local ) {
273 $db = wfGetDB( DB_SLAVE
);
277 if ( $local !== null ) {
279 $where['iw_local'] = 1;
280 } elseif ( $local == 0 ) {
281 $where['iw_local'] = 0;
285 $res = $db->select( 'interwiki',
286 array( 'iw_prefix', 'iw_url', 'iw_api', 'iw_wikiid', 'iw_local', 'iw_trans' ),
287 $where, __METHOD__
, array( 'ORDER BY' => 'iw_prefix' )
290 foreach ( $res as $row ) {
291 $retval[] = (array)$row;
297 * Returns all interwiki prefixes
299 * @param $local If set, limits output to local/non-local interwikis
300 * @return Array List of prefixes
303 public static function getAllPrefixes( $local = null ) {
304 global $wgInterwikiCache;
306 if ( $wgInterwikiCache ) {
307 return self
::getAllPrefixesCached( $local );
309 return self
::getAllPrefixesDB( $local );
314 * Get the URL for a particular title (or with $1 if no title given)
316 * @param $title String: what text to put for the article name
317 * @return String: the URL
318 * @note Prior to 1.19 The getURL with an argument was broken.
319 * If you if you use this arg in an extension that supports MW earlier
320 * than 1.19 please wfUrlencode and substitute $1 on your own.
322 public function getURL( $title = null ) {
324 if( $title !== null ) {
325 $url = str_replace( "$1", wfUrlencode( $title ), $url );
331 * Get the API URL for this wiki
333 * @return String: the URL
335 public function getAPI() {
340 * Get the DB name for this wiki
342 * @return String: the DB name
344 public function getWikiID() {
345 return $this->mWikiID
;
349 * Is this a local link from a sister project, or is
350 * it something outside, like Google
354 public function isLocal() {
355 return $this->mLocal
;
359 * Can pages from this wiki be transcluded?
360 * Still requires $wgEnableScaryTransclusion
364 public function isTranscludable() {
365 return $this->mTrans
;
369 * Get the name for the interwiki site
373 public function getName() {
374 $msg = wfMessage( 'interwiki-name-' . $this->mPrefix
)->inContentLanguage();
375 return !$msg->exists() ?
'' : $msg;
379 * Get a description for this interwiki
383 public function getDescription() {
384 $msg = wfMessage( 'interwiki-desc-' . $this->mPrefix
)->inContentLanguage();
385 return !$msg->exists() ?
'' : $msg;