Merge "Avoid master queries in Title::getLinksFrom()"
[lhc/web/wiklou.git] / includes / cache / LinkCache.php
index 3db84a6..8a79bd8 100644 (file)
  */
 class LinkCache {
        /**
-        * @var MapCacheLRU
+        * @var HashBagOStuff
         */
        private $mGoodLinks;
        /**
-        * @var MapCacheLRU
+        * @var HashBagOStuff
         */
        private $mBadLinks;
        private $mForUpdate = false;
@@ -49,8 +49,8 @@ class LinkCache {
        protected static $instance;
 
        public function __construct() {
-               $this->mGoodLinks = new MapCacheLRU( self::MAX_SIZE );
-               $this->mBadLinks = new MapCacheLRU( self::MAX_SIZE );
+               $this->mGoodLinks = new HashBagOStuff( [ 'maxKeys' => self::MAX_SIZE ] );
+               $this->mBadLinks = new HashBagOStuff( [ 'maxKeys' => self::MAX_SIZE ] );
        }
 
        /**
@@ -58,37 +58,44 @@ class LinkCache {
         *
         * @return LinkCache
         */
-       static function &singleton() {
-               if ( self::$instance ) {
-                       return self::$instance;
+       public static function &singleton() {
+               if ( !self::$instance ) {
+                       self::$instance = new LinkCache;
                }
-               self::$instance = new LinkCache;
 
                return self::$instance;
        }
 
        /**
-        * Destroy the singleton instance, a new one will be created next time
-        * singleton() is called.
+        * Destroy the singleton instance
+        *
+        * A new one will be created next time singleton() is called.
+        *
         * @since 1.22
         */
-       static function destroySingleton() {
+       public static function destroySingleton() {
                self::$instance = null;
        }
 
        /**
         * Set the singleton instance to a given object.
+        *
         * Since we do not have an interface for LinkCache, you have to be sure the
         * given object implements all the LinkCache public methods.
+        *
         * @param LinkCache $instance
         * @since 1.22
         */
-       static function setSingleton( LinkCache $instance ) {
+       public static function setSingleton( LinkCache $instance ) {
                self::$instance = $instance;
        }
 
        /**
-        * General accessor to get/set whether SELECT FOR UPDATE should be used
+        * General accessor to get/set whether the master DB should be used
+        *
+        * This used to also set the FOR UPDATE option (locking the rows read
+        * in order to avoid link table inconsistency), which was later removed
+        * for performance on wikis with a high edit rate.
         *
         * @param bool $update
         * @return bool
@@ -99,32 +106,30 @@ class LinkCache {
 
        /**
         * @param string $title
-        * @return int
+        * @return int Page ID or zero
         */
        public function getGoodLinkID( $title ) {
-               if ( $this->mGoodLinks->has( $title ) ) {
-                       $info = $this->mGoodLinks->get( $title );
-                       return $info['id'];
-               } else {
+               $info = $this->mGoodLinks->get( $title );
+               if ( !$info ) {
                        return 0;
                }
+               return $info['id'];
        }
 
        /**
         * Get a field of a title object from cache.
-        * If this link is not good, it will return NULL.
+        * If this link is not a cached good title, it will return NULL.
         * @param Title $title
         * @param string $field ('length','redirect','revision','model')
-        * @return string|null
+        * @return string|int|null
         */
        public function getGoodLinkFieldObj( $title, $field ) {
                $dbkey = $title->getPrefixedDBkey();
-               if ( $this->mGoodLinks->has( $dbkey ) ) {
-                       $info = $this->mGoodLinks->get( $dbkey );
-                       return $info[$field];
-               } else {
+               $info = $this->mGoodLinks->get( $dbkey );
+               if ( !$info ) {
                        return null;
                }
+               return $info[$field];
        }
 
        /**
@@ -132,8 +137,8 @@ class LinkCache {
         * @return bool
         */
        public function isBadLink( $title ) {
-               // We need to use get here since has will not call ping.
-               return $this->mBadLinks->get( $title ) !== null;
+               // Use get() to ensure it records as used for LRU.
+               return $this->mBadLinks->get( $title ) !== false;
        }
 
        /**
@@ -145,18 +150,20 @@ class LinkCache {
         * @param int $redir Whether the page is a redirect
         * @param int $revision Latest revision's ID
         * @param string|null $model Latest revision's content model ID
+        * @param string|null $lang Language code of the page, if not the content language
         */
-       public function addGoodLinkObj( $id, $title, $len = -1, $redir = null,
-               $revision = 0, $model = null
+       public function addGoodLinkObj( $id, Title $title, $len = -1, $redir = null,
+               $revision = 0, $model = null, $lang = null
        ) {
                $dbkey = $title->getPrefixedDBkey();
-               $this->mGoodLinks->set( $dbkey, array(
+               $this->mGoodLinks->set( $dbkey, [
                        'id' => (int)$id,
                        'length' => (int)$len,
                        'redirect' => (int)$redir,
                        'revision' => (int)$revision,
                        'model' => $model ? (string)$model : null,
-               ) );
+                       'lang' => $lang ? (string)$lang : null,
+               ] );
        }
 
        /**
@@ -166,21 +173,22 @@ class LinkCache {
         * @param stdClass $row Object which has the fields page_id, page_is_redirect,
         *  page_latest and page_content_model
         */
-       public function addGoodLinkObjFromRow( $title, $row ) {
+       public function addGoodLinkObjFromRow( Title $title, $row ) {
                $dbkey = $title->getPrefixedDBkey();
-               $this->mGoodLinks->set( $dbkey, array(
+               $this->mGoodLinks->set( $dbkey, [
                        'id' => intval( $row->page_id ),
                        'length' => intval( $row->page_len ),
                        'redirect' => intval( $row->page_is_redirect ),
                        'revision' => intval( $row->page_latest ),
                        'model' => !empty( $row->page_content_model ) ? strval( $row->page_content_model ) : null,
-               ) );
+                       'lang' => !empty( $row->page_lang ) ? strval( $row->page_lang ) : null,
+               ] );
        }
 
        /**
         * @param Title $title
         */
-       public function addBadLinkObj( $title ) {
+       public function addBadLinkObj( Title $title ) {
                $dbkey = $title->getPrefixedDBkey();
                if ( !$this->isBadLink( $dbkey ) ) {
                        $this->mBadLinks->set( $dbkey, 1 );
@@ -188,7 +196,7 @@ class LinkCache {
        }
 
        public function clearBadLink( $title ) {
-               $this->mBadLinks->clear( array( $title ) );
+               $this->mBadLinks->clear( [ $title ] );
        }
 
        /**
@@ -196,58 +204,32 @@ class LinkCache {
         */
        public function clearLink( $title ) {
                $dbkey = $title->getPrefixedDBkey();
-               $this->mBadLinks->clear( array( $dbkey ) );
-               $this->mGoodLinks->clear( array( $dbkey ) );
-       }
-
-
-       /**
-        * @deprecated since 1.26
-        * @return array
-        */
-       public function getGoodLinks() {
-               wfDeprecated( __METHOD__, '1.26' );
-               $links = array();
-               foreach ( $this->mGoodLinks->getAllKeys() as $key ) {
-                       $info = $this->mGoodLinks->get( $key );
-                       $links[$key] = $info['id'];
-               }
-
-               return $links;
-       }
-
-       /**
-        * @deprecated since 1.26
-        * @return array
-        */
-       public function getBadLinks() {
-               wfDeprecated( __METHOD__, '1.26' );
-               return $this->mBadLinks->getAllKeys();
+               $this->mBadLinks->delete( $dbkey );
+               $this->mGoodLinks->delete( $dbkey );
        }
 
        /**
         * Add a title to the link cache, return the page_id or zero if non-existent
         *
         * @param string $title Title to add
-        * @return int
+        * @return int Page ID or zero
         */
        public function addLink( $title ) {
                $nt = Title::newFromDBkey( $title );
-               if ( $nt ) {
-                       return $this->addLinkObj( $nt );
-               } else {
+               if ( !$nt ) {
                        return 0;
                }
+               return $this->addLinkObj( $nt );
        }
 
        /**
         * Add a title to the link cache, return the page_id or zero if non-existent
         *
         * @param Title $nt Title object to add
-        * @return int
+        * @return int Page ID or zero
         */
-       public function addLinkObj( $nt ) {
-               global $wgContentHandlerUseDB;
+       public function addLinkObj( Title $nt ) {
+               global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
 
                $key = $nt->getPrefixedDBkey();
                if ( $this->isBadLink( $key ) || $nt->isExternal() ) {
@@ -262,25 +244,25 @@ class LinkCache {
                        return 0;
                }
 
-               # Some fields heavily used for linking...
-               if ( $this->mForUpdate ) {
-                       $db = wfGetDB( DB_MASTER );
-               } else {
-                       $db = wfGetDB( DB_SLAVE );
-               }
+               // Some fields heavily used for linking...
+               $db = $this->mForUpdate ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
 
-               $f = array( 'page_id', 'page_len', 'page_is_redirect', 'page_latest' );
+               $fields = [ 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ];
                if ( $wgContentHandlerUseDB ) {
-                       $f[] = 'page_content_model';
+                       $fields[] = 'page_content_model';
                }
+               if ( $wgPageLanguageUseDB ) {
+                       $fields[] = 'page_lang';
+               }
+
+               $row = $db->selectRow( 'page', $fields,
+                       [ 'page_namespace' => $nt->getNamespace(), 'page_title' => $nt->getDBkey() ],
+                       __METHOD__
+               );
 
-               $s = $db->selectRow( 'page', $f,
-                       array( 'page_namespace' => $nt->getNamespace(), 'page_title' => $nt->getDBkey() ),
-                       __METHOD__ );
-               # Set fields...
-               if ( $s !== false ) {
-                       $this->addGoodLinkObjFromRow( $nt, $s );
-                       $id = intval( $s->page_id );
+               if ( $row !== false ) {
+                       $this->addGoodLinkObjFromRow( $nt, $row );
+                       $id = intval( $row->page_id );
                } else {
                        $this->addBadLinkObj( $nt );
                        $id = 0;