(bug 24898) MediaWiki uses /tmp even if a vHost-specific tempdir is set, also make...
[lhc/web/wiklou.git] / includes / LinkCache.php
index fdac736..dce3459 100644 (file)
@@ -1,30 +1,43 @@
-<?
-# Cache for article titles and ids linked from one source
-
-# These are used in incrementalSetup()
-define ('LINKCACHE_GOOD', 0);
-define ('LINKCACHE_BAD', 1);
-define ('LINKCACHE_IMAGE', 2);
-
+<?php
+/**
+ * Cache for article titles (prefixed DB keys) and ids linked from one source
+ *
+ * @ingroup Cache
+ */
 class LinkCache {
+       // Increment $mClassVer whenever old serialized versions of this class
+       // becomes incompatible with the new version.
+       /* private */ var $mClassVer = 4;
+
+       /* private */ var $mGoodLinks, $mBadLinks;
+       /* private */ var $mForUpdate;
+
+       /**
+        * Get an instance of this class
+        */
+       static function &singleton() {
+               static $instance;
+               if ( !isset( $instance ) ) {
+                       $instance = new LinkCache;
+               }
+               return $instance;
+       }
 
-       /* private */ var $mGoodLinks, $mBadLinks, $mActive;
-       /* private */ var $mImageLinks; 
-       /* private */ var $mPreFilled, $mOldGoodLinks, $mOldBadLinks;
-       
-       function LinkCache()
-       {
-               $this->mActive = true;
-               $this->mPreFilled = false;
+       function __construct() {
+               $this->mForUpdate = false;
                $this->mGoodLinks = array();
+               $this->mGoodLinkFields = array();
                $this->mBadLinks = array();
-               $this->mImageLinks = array();
-               $this->mOldGoodLinks = array();
-               $this->mOldBadLinks = array();
        }
 
-       function getGoodLinkID( $title )
-       {
+       /**
+        * General accessor to get/set whether SELECT FOR UPDATE should be used
+        */
+       public function forUpdate( $update = null ) {
+               return wfSetVar( $this->mForUpdate, $update );
+       }
+
+       public function getGoodLinkID( $title ) {
                if ( array_key_exists( $title, $this->mGoodLinks ) ) {
                        return $this->mGoodLinks[$title];
                } else {
@@ -32,182 +45,157 @@ class LinkCache {
                }
        }
 
-       function isBadLink( $title )
-       {
-               return in_array( $title, $this->mBadLinks );
-       }
-
-       function addGoodLink( $id, $title )
-       {
-               if ( $this->mActive ) {
-                       $this->mGoodLinks[$title] = $id;
+       /**
+        * Get a field of a title object from cache.
+        * If this link is not good, it will return NULL.
+        * @param $title Title
+        * @param $field String: ('length','redirect','revision')
+        * @return mixed
+        */
+       public function getGoodLinkFieldObj( $title, $field ) {
+               $dbkey = $title->getPrefixedDbKey();
+               if ( array_key_exists( $dbkey, $this->mGoodLinkFields ) ) {
+                       return $this->mGoodLinkFields[$dbkey][$field];
+               } else {
+                       return null;
                }
        }
 
-       function addBadLink( $title )
-       {
-               if ( $this->mActive && ( ! $this->isBadLink( $title ) ) ) {
-                       array_push( $this->mBadLinks, $title );
+       public function isBadLink( $title ) {
+               return array_key_exists( $title, $this->mBadLinks );
+       }
+
+       /**
+        * Add a link for the title to the link cache
+        *
+        * @param $id Integer: page's ID
+        * @param $title Title object
+        * @param $len Integer: text's length
+        * @param $redir Integer: whether the page is a redirect
+        * @param $revision Integer: latest revision's ID
+        */
+       public function addGoodLinkObj( $id, $title, $len = -1, $redir = null, $revision = false ) {
+               $dbkey = $title->getPrefixedDbKey();
+               $this->mGoodLinks[$dbkey] = intval( $id );
+               $this->mGoodLinkFields[$dbkey] = array(
+                       'length' => intval( $len ),
+                       'redirect' => intval( $redir ),
+                       'revision' => intval( $revision ) );
+       }
+
+       public function addBadLinkObj( $title ) {
+               $dbkey = $title->getPrefixedDbKey();
+               if ( !$this->isBadLink( $dbkey ) ) {
+                       $this->mBadLinks[$dbkey] = 1;
                }
        }
 
-       function addImageLink( $title )
-       {
-               if ( $this->mActive ) { $this->mImageLinks[$title] = 1; }
+       public function clearBadLink( $title ) {
+               unset( $this->mBadLinks[$title] );
        }
 
-       function clearBadLink( $title )
-       {
-               $index = array_search( $title, $this->mBadLinks );
-               if ( isset( $index ) ) {
-                       unset( $this->mBadLinks[$index] );
+       public function clearLink( $title ) {
+               $dbkey = $title->getPrefixedDbKey();
+               if( isset($this->mBadLinks[$dbkey]) ) {
+                       unset($this->mBadLinks[$dbkey]);
+               }
+               if( isset($this->mGoodLinks[$dbkey]) ) {
+                       unset($this->mGoodLinks[$dbkey]);
+               }
+               if( isset($this->mGoodLinkFields[$dbkey]) ) {
+                       unset($this->mGoodLinkFields[$dbkey]);
                }
-               global $wgMemc, $wgDBname;
-               $wgMemc->delete( "$wgDBname:lc:title:$title" );
        }
 
-       function suspend() { $this->mActive = false; }
-       function resume() { $this->mActive = true; }
-       function getGoodLinks() { return $this->mGoodLinks; }
-       function getBadLinks() { return $this->mBadLinks; }
-       function getImageLinks() { return $this->mImageLinks; }
-
-       function addLink( $title )
-       {
-               if ( $this->isBadLink( $title ) ) { return 0; }
-               $id = $this->getGoodLinkID( $title );
-               if ( 0 != $id ) { return $id; }
-
-               global $wgMemc, $wgDBname;
-               wfProfileIn( "LinkCache::addLink-checkdatabase" );
+       public function getGoodLinks() { return $this->mGoodLinks; }
+       public function getBadLinks() { return array_keys( $this->mBadLinks ); }
 
+       /**
+        * Add a title to the link cache, return the page_id or zero if non-existent
+        *
+        * @param $title String: title to add
+        * @return Integer
+        */
+       public function addLink( $title ) {
                $nt = Title::newFromDBkey( $title );
-               $ns = $nt->getNamespace();
-               $t = $nt->getDBkey();
-
-               if ( "" == $t ) { return 0; }
+               if( $nt ) {
+                       return $this->addLinkObj( $nt );
+               } else {
+                       return 0;
+               }
+       }
 
-               $id = $wgMemc->get( $key = "$wgDBname:lc:title:$title" );
-               if( $id === FALSE ) {
-                       $sql = "SELECT HIGH_PRIORITY cur_id FROM cur WHERE cur_namespace=" .
-                         "{$ns} AND cur_title='" . wfStrencode( $t ) . "'";
-                       $res = wfQuery( $sql, "LinkCache::addLink" );
+       /**
+        * Add a title to the link cache, return the page_id or zero if non-existent
+        *
+        * @param $nt Title object to add
+        * @return Integer
+        */
+       public function addLinkObj( $nt ) {
+               global $wgAntiLockFlags;
+               wfProfileIn( __METHOD__ );
 
-                       if ( 0 == wfNumRows( $res ) ) {
-                               $id = 0;
-                       } else {
-                               $s = wfFetchObject( $res );
-                               $id = $s->cur_id;
-                       }
-                       $wgMemc->add( $key, $id, time()+3600 );
+               $key = $nt->getPrefixedDBkey();
+               if ( $this->isBadLink( $key ) ) {
+                       wfProfileOut( __METHOD__ );
+                       return 0;
+               }
+               $id = $this->getGoodLinkID( $key );
+               if ( $id != 0 ) {
+                       wfProfileOut( __METHOD__ );
+                       return $id;
                }
-               if ( 0 == $id ) { $this->addBadLink( $title ); }
-               else { $this->addGoodLink( $id, $title ); }
-               wfProfileOut();
-               return $id;
-       }
 
-       function preFill( $fromtitle )
-       {
-               wfProfileIn( "LinkCache::preFill" );
-               # Note -- $fromtitle is a Title *object*
-               $dbkeyfrom = wfStrencode( $fromtitle->getPrefixedDBKey() );
-               $sql = "SELECT HIGH_PRIORITY cur_id,cur_namespace,cur_title
-                       FROM cur,links
-                       WHERE cur_id=l_to AND l_from='{$dbkeyfrom}'";
-               $res = wfQuery( $sql, "LinkCache::preFill" );
-               while( $s = wfFetchObject( $res ) ) {
-                       $this->addGoodLink( $s->cur_id,
-                               Title::makeName( $s->cur_namespace, $s->cur_title )
-                               );
+               if ( $key === '' ) {
+                       wfProfileOut( __METHOD__ );
+                       return 0;
                }
                
-               $this->suspend();
-               $id = $fromtitle->getArticleID();
-               $this->resume();
-               
-               $sql = "SELECT HIGH_PRIORITY bl_to
-                       FROM brokenlinks
-                       WHERE bl_from='{$id}'";
-               $res = wfQuery( $sql, "LinkCache::preFill" );
-               while( $s = wfFetchObject( $res ) ) {
-                       $this->addBadLink( $s->bl_to );
+               # Some fields heavily used for linking...
+               if ( $this->mForUpdate ) {
+                       $db = wfGetDB( DB_MASTER );
+                       if ( !( $wgAntiLockFlags & ALF_NO_LINK_LOCK ) ) {
+                               $options = array( 'FOR UPDATE' );
+                       } else {
+                               $options = array();
+                       }
+               } else {
+                       $db = wfGetDB( DB_SLAVE );
+                       $options = array();
                }
-               
-               $this->mOldBadLinks = $this->mBadLinks;
-               $this->mOldGoodLinks = $this->mGoodLinks;
-               $this->mPreFilled = true;
-               
-               wfProfileOut();
-       }
-
-       function getGoodAdditions() 
-       {
-               return array_diff( $this->mGoodLinks, $this->mOldGoodLinks );
-       }
-
-       function getBadAdditions() 
-       {
-               return array_values( array_diff( $this->mBadLinks, $this->mOldBadLinks ) );
-       }
 
-       function getImageAdditions()
-       {
-               return array_diff_assoc( $this->mImageLinks, $this->mOldImageLinks );
-       }
-
-       function getGoodDeletions() 
-       {
-               return array_diff( $this->mOldGoodLinks, $this->mGoodLinks );
-       }
-
-       function getBadDeletions()
-       {
-               return array_values( array_diff( $this->mOldBadLinks, $this->mBadLinks ) );
-       }
-
-       function getImageDeletions()
-       {
-               return array_diff_assoc( $this->mOldImageLinks, $this->mImageLinks );
-       }
-
-       #     Parameters: $which is one of the LINKCACHE_xxx constants, $del and $add are 
-       # the incremental update arrays which will be filled. Returns whether or not it's
-       # worth doing the incremental version. For example, if [[List of mathematical topics]]
-       # was blanked, it would take a long, long time to do incrementally.
-       function incrementalSetup( $which, &$del, &$add )
-       {
-               if ( ! $this->mPreFilled ) {
-                       return false;
+               $s = $db->selectRow( 'page', 
+                       array( 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ),
+                       array( 'page_namespace' => $nt->getNamespace(), 'page_title' => $nt->getDBkey() ),
+                       __METHOD__, $options );
+               # Set fields...
+               if ( $s !== false ) {
+                       $id = intval( $s->page_id );
+                       $len = intval( $s->page_len );
+                       $redirect = intval( $s->page_is_redirect );
+                       $revision = intval( $s->page_latest );
+               } else {
+                       $id = 0;
+                       $len = -1;
+                       $redirect = 0;
+                       $revision = 0;
                }
 
-               switch ( $which ) {
-                       case LINKCACHE_GOOD:
-                               $old =& $this->mOldGoodLinks;
-                               $cur =& $this->mGoodLinks;
-                               $del = $this->getGoodDeletions();
-                               $add = $this->getGoodAdditions();
-                               break;
-                       case LINKCACHE_BAD:
-                               $old =& $this->mOldBadLinks;
-                               $cur =& $this->mBadLinks;
-                               $del = $this->getBadDeletions();
-                               $add = $this->getBadAdditions();
-                               break;
-                       default: # LINKCACHE_IMAGE
-                               return false;           
+               if ( $id == 0 ) {
+                       $this->addBadLinkObj( $nt );
+               } else {
+                       $this->addGoodLinkObj( $id, $nt, $len, $redirect, $revision );
                }
-               
-               return true;
+               wfProfileOut( __METHOD__ );
+               return $id;
        }
 
-       # Clears cache but leaves old preFill copies alone
-       function clear() 
-       {
+       /**
+        * Clears cache
+        */
+       public function clear() {
                $this->mGoodLinks = array();
+               $this->mGoodLinkFields = array();
                $this->mBadLinks = array();
-               $this->mImageLinks = array();
        }
-       
 }
-?>