(bug 20274) Strict standards issue in 5.3.
[lhc/web/wiklou.git] / includes / Interwiki.php
index 754fb3b..69bcd1e 100644 (file)
  */
 class Interwiki {
 
-       // Cache - removed in LRU order when it hits limit
+       // Cache - removes oldest entry when it hits limit
        protected static $smCache = array();
        const CACHE_LIMIT = 100; // 0 means unlimited, any other value is max number of entries.
 
        protected $mPrefix, $mURL, $mLocal, $mTrans;
 
-       function __construct( $prefix = null, $url = '', $local = 0, $trans = 0 )
-       {
+       public function __construct( $prefix = null, $url = '', $local = 0, $trans = 0 ) {
                $this->mPrefix = $prefix;
                $this->mURL = $url;
                $this->mLocal = $local;
                $this->mTrans = $trans;
        }
 
+       /**
+        * Check whether an interwiki prefix exists
+        * 
+        * @return bool Whether it exists
+        * @param $prefix string Interwiki prefix to use
+        */
+       static public function isValidInterwiki( $prefix ) {
+               $result = self::fetch( $prefix );
+               return (bool)$result;
+       }
+
        /**
         * Fetch an Interwiki object
         * 
@@ -32,174 +42,193 @@ class Interwiki {
         * @param $prefix string Interwiki prefix to use
         */
        static public function fetch( $prefix ) {
-               if( isset( self::$smCache[$prefix] ) ){
+               global $wgContLang;
+               if( $prefix == '' ) {
+                       return null;
+               }
+               $prefix = $wgContLang->lc( $prefix );
+               if( isset( self::$smCache[$prefix] ) ) {
                        return self::$smCache[$prefix];
                }
                global $wgInterwikiCache;
-               if ($wgInterwikiCache) {
-                       return Interwiki::getInterwikiCached( $key );
-               }
-               $iw = new Interwiki;
-               if(! $iw->load( $prefix ) ){
-                       return 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 ){
-                       array_shift( self::$smCache );
+               if( self::CACHE_LIMIT && count( self::$smCache ) >= self::CACHE_LIMIT ) {
+                       reset( self::$smCache );
+                       unset( self::$smCache[ key( self::$smCache ) ] );
                }
-               self::$smCache[$prefix] = &$iw;
+               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{\string} URL of interwiki site
+        * @param $prefix \type{\string} Interwiki prefix
+        * @return \type{\Interwiki} An interwiki object
         */
-       protected static function getInterwikiCached( $key ) {
-               global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
-               static $db, $site;
+       protected static function getInterwikiCached( $prefix ) {
+               $value = self::getInterwikiCacheEntry( $prefix );
 
-               if (!$db)
-                       $db=dba_open($wgInterwikiCache,'r','cdb');
-               /* Resolve site name */
-               if ($wgInterwikiScopes>=3 and !$site) {
-                       $site = dba_fetch('__sites:' . wfWikiID(), $db);
-                       if ($site=="")
-                               $site = $wgInterwikiFallbackSite;
-               }
-               $value = dba_fetch( wfMemcKey( $key ), $db);
-               if ($value=='' and $wgInterwikiScopes>=3) {
-                       /* try site-level */
-                       $value = dba_fetch("_{$site}:{$key}", $db);
-               }
-               if ($value=='' and $wgInterwikiScopes>=2) {
-                       /* try globals */
-                       $value = dba_fetch("__global:{$key}", $db);
-               }
-               if ($value=='undef')
-                       $value='';
-               $s = new Interwiki( $key );
+               $s = new Interwiki( $prefix );
                if ( $value != '' ) {
+                       // Split values
                        list( $local, $url ) = explode( ' ', $value, 2 );
                        $s->mURL = $url;
                        $s->mLocal = (int)$local;
-               }else{
-                       return false;
-               }
-               if( self::CACHE_LIMIT && count( self::$smCache ) >= self::CACHE_LIMIT ){
-                       array_shift( self::$smCache );
+               } else {
+                       $s = false;
                }
-               self::$smCache[$prefix] = &$s;
                return $s;
        }
 
        /**
-        * Get the DB object
+        * Get entry from interwiki cache
+        *
+        * @note More logic is explained in DefaultSettings.
         *
-        * @return Database
+        * @param $prefix \type{\string} Database key
+        * @return \type{\string) The entry
         */
-       function &getDB(){
-               $db = wfGetDB( DB_SLAVE );
-               return $db;
+       protected static function getInterwikiCacheEntry( $prefix ) {
+               global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
+               static $db, $site;
+
+               wfDebug( __METHOD__ . "( $prefix )\n" );
+               if( !$db ) {
+                       $db = CdbReader::open( $wgInterwikiCache );
+               }
+               /* Resolve site name */
+               if( $wgInterwikiScopes>=3 && !$site ) {
+                       $site = $db->get( '__sites:' . wfWikiID() );
+                       if ( $site == '' ) {
+                               $site = $wgInterwikiFallbackSite;
+                       }
+               }
+
+               $value = $db->get( wfMemcKey( $prefix ) );
+               // Site level
+               if ( $value == '' && $wgInterwikiScopes >= 3 ) {
+                       $value = $db->get( "_{$site}:{$prefix}" );
+               }
+               // Global Level
+               if ( $value == '' && $wgInterwikiScopes >= 2 ) {
+                       $value = $db->get( "__global:{$prefix}" );
+               }
+               if ( $value == 'undef' )
+                       $value = '';
+
+               return $value;
        }
 
        /**
-        * Load interwiki from the DB
+        * Load the interwiki, trying first memcached then the DB
         *
         * @param $prefix The interwiki prefix
         * @return bool The prefix is valid
-        *
+        * @static
         */
-       function load( $prefix ) {
-               global $wgMemc;
+       protected static function load( $prefix ) {
+               global $wgMemc, $wgInterwikiExpiry;
                $key = wfMemcKey( 'interwiki', $prefix );
                $mc = $wgMemc->get( $key );
-               if( $mc && is_array( $mc ) && $this->loadFromArray( $mc ) ){ // is_array is hack for old keys
-                       wfDebug("Succeeded\n");
-                       return true;
+               $iw = false;
+               if( $mc && is_array( $mc ) ) { // is_array is hack for old keys
+                       $iw = Interwiki::loadFromArray( $mc );
+                       if( $iw ) {
+                               return $iw;
+                       }
                }
-               
-               $db =& $this->getDB();
-               $res = $db->resultObject( $db->select( 'interwiki', '*', array( 'iw_prefix' => $prefix ),
+
+               $db = wfGetDB( DB_SLAVE );
+
+               $row = $db->fetchRow( $db->select( 'interwiki', '*', array( 'iw_prefix' => $prefix ),
                        __METHOD__ ) );
-               if ( $this->loadFromResult( $res ) ) {
-                       $mc = array( 'url' => $this->mURL, 'local' => $this->mLocal, 'trans' => $this->mTrans );
-                       $wgMemc->add( $key, $mc );
-                       return true;
+               $iw = Interwiki::loadFromArray( $row );
+               if ( $iw ) {
+                       $mc = array( 'iw_url' => $iw->mURL, '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)
+        * 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
         */
-       function loadFromArray( $mc ) {
-               if( isset( $mc['url'] ) && isset( $mc['local'] ) && isset( $mc['trans'] ) ){
-                       $this->mURL = $mc['url'];
-                       $this->mLocal = $mc['local'];
-                       $this->mTrans = $mc['trans'];
-                       return true;
+       protected static function loadFromArray( $mc ) {
+               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'];
+                       return $iw;
                }
                return false;
        }
-       
-       /**
-        * Fill in member variables from a result wrapper
-        *
-        * @return bool Whether there was a row there
-        * @param $res ResultWrapper Row from the interwiki table
-        */
-       function loadFromResult( ResultWrapper $res ) {
-               $ret = false;
-               if ( 0 != $res->numRows() ) {
-                       # Get first entry
-                       $row = $res->fetchObject();
-                       $this->initFromRow( $row );
-                       $ret = true;
-               }
-               $res->free();
-               return $ret;
-       }
 
        /**
-        * Given a database row from the interwiki table, initialize
-        * member variables
-        *
-        * @param $row ResultWrapper A row from the interwiki table
-        */
-       function initFromRow( $row ) {
-               $this->mPrefix = $row->iw_prefix;
-               $this->mURL = $row->iw_url;
-               $this->mLocal = $row->iw_local;
-               $this->mTrans = $row->iw_trans;
-       }
-       
-       /** 
         * 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
         */
-       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(){
+
+       /**
+        * Is this a local link from a sister project, or is
+        * it something outside, like Google
+        * @return bool
+        */
+       public function isLocal() {
                return $this->mLocal;
        }
-       
-       function isTranscludable(){
+
+       /**
+        * Can pages from this wiki be transcluded?
+        * Still requires $wgEnableScaryTransclusion
+        * @return bool
+        */
+       public function isTranscludable() {
                return $this->mTrans;
        }
 
+       /**
+        * Get the name for the interwiki site
+        * @return String
+        */
+       public function getName() {
+               $key = 'interwiki-name-' . $this->mPrefix;
+               $msg = wfMsgForContent( $key );
+               return wfEmptyMsg( $key, $msg ) ? '' : $msg;
+       }
+
+       /**
+        * Get a description for this interwiki
+        * @return String
+        */
+       public function getDescription() {
+               $key = 'interwiki-desc-' . $this->mPrefix;
+               $msg = wfMsgForContent( $key );
+               return wfEmptyMsg( $key, $msg ) ? '' : $msg;
+       }
 }