Follow-up r84814: revert redundant summary message addition.
[lhc/web/wiklou.git] / includes / LinkCache.php
index fae8ff7..e2db69a 100644 (file)
@@ -1,56 +1,43 @@
 <?php
 /**
  * Cache for article titles (prefixed DB keys) and ids linked from one source
- * @package MediaWiki
- */
-
-/**
- *
- */
-# These are used in incrementalSetup()
-define ('LINKCACHE_GOOD', 0);
-define ('LINKCACHE_BAD', 1);
-define ('LINKCACHE_IMAGE', 2);
-
-/**
  *
- * @package MediaWiki
+ * @ingroup Cache
  */
-class LinkCache {      
+class LinkCache {
        // Increment $mClassVer whenever old serialized versions of this class
        // becomes incompatible with the new version.
-       /* private */ var $mClassVer = 2;
+       /* private */ var $mClassVer = 4;
 
-       /* private */ var $mGoodLinks, $mBadLinks, $mActive;
-       /* private */ var $mImageLinks, $mCategoryLinks;
-       /* private */ var $mPreFilled, $mOldGoodLinks, $mOldBadLinks;
+       /* private */ var $mGoodLinks, $mBadLinks;
        /* private */ var $mForUpdate;
 
-       /* private */ function getKey( $title ) {
-               global $wgDBname;
-               return $wgDBname.':lc:title:'.$title;
+       /**
+        * Get an instance of this class
+        */
+       static function &singleton() {
+               static $instance;
+               if ( !isset( $instance ) ) {
+                       $instance = new LinkCache;
+               }
+               return $instance;
        }
-       
-       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->mCategoryLinks = array();
-               $this->mOldGoodLinks = array();
-               $this->mOldBadLinks = array();
        }
 
        /**
         * General accessor to get/set whether SELECT FOR UPDATE should be used
         */
-       function forUpdate( $update = NULL ) { 
+       public function forUpdate( $update = null ) {
                return wfSetVar( $this->mForUpdate, $update );
        }
-       
-       function getGoodLinkID( $title ) {
+
+       public function getGoodLinkID( $title ) {
                if ( array_key_exists( $title, $this->mGoodLinks ) ) {
                        return $this->mGoodLinks[$title];
                } else {
@@ -58,335 +45,157 @@ class LinkCache {
                }
        }
 
-       function isBadLink( $title ) {
-               return array_key_exists( $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 ) ) ) {
-                       $this->mBadLinks[$title] = 1;
-               }
+       public function isBadLink( $title ) {
+               return array_key_exists( $title, $this->mBadLinks );
        }
 
-       function addImageLink( $title ) {
-               if ( $this->mActive ) { $this->mImageLinks[$title] = 1; }
+       /**
+        * 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 ) );
        }
 
-       function addImageLinkObj( $nt ) {
-               if ( $this->mActive ) { $this->mImageLinks[$nt->getDBkey()] = 1; }
-       }
-       
-       function addCategoryLink( $title, $sortkey ) {
-               if ( $this->mActive ) { $this->mCategoryLinks[$title] = $sortkey; }
-       }
-       
-       function addCategoryLinkObj( &$nt, $sortkey ) {
-               $this->addCategoryLink( $nt->getDBkey(), $sortkey );
+       public function addBadLinkObj( $title ) {
+               $dbkey = $title->getPrefixedDbKey();
+               if ( !$this->isBadLink( $dbkey ) ) {
+                       $this->mBadLinks[$dbkey] = 1;
+               }
        }
 
-       function clearBadLink( $title ) {
+       public function clearBadLink( $title ) {
                unset( $this->mBadLinks[$title] );
-               $this->clearLink( $title );
        }
-       
-       function clearLink( $title ) {
-               global $wgMemc, $wgLinkCacheMemcached;
-               if( $wgLinkCacheMemcached )
-                       $wgMemc->delete( $this->getKey( $title ) );
-       }
-
-       function suspend() { $this->mActive = false; }
-       function resume() { $this->mActive = true; }
-       function getGoodLinks() { return $this->mGoodLinks; }
-       function getBadLinks() { return array_keys( $this->mBadLinks ); }
-       function getImageLinks() { return $this->mImageLinks; }
-       function getCategoryLinks() { return $this->mCategoryLinks; }
 
-       function addLink( $title ) {
-               $nt = Title::newFromDBkey( $title );
-               if( $nt ) {
-                       return $this->addLinkObj( $nt );
-               } else {
-                       return 0;
+       public function clearLink( $title ) {
+               $dbkey = $title->getPrefixedDbKey();
+               if( isset($this->mBadLinks[$dbkey]) ) {
+                       unset($this->mBadLinks[$dbkey]);
                }
-       }
-       
-       function addLinkObj( &$nt ) {
-               global $wgMemc, $wgLinkCacheMemcached;
-               $title = $nt->getPrefixedDBkey();
-               if ( $this->isBadLink( $title ) ) { return 0; }         
-               $id = $this->getGoodLinkID( $title );
-               if ( 0 != $id ) { return $id; }
-
-               $fname = 'LinkCache::addLinkObj';
-               wfProfileIn( $fname );
-
-               $ns = $nt->getNamespace();
-               $t = $nt->getDBkey();
-
-               if ( '' == $title ) { 
-                       wfProfileOut( $fname );
-                       return 0; 
+               if( isset($this->mGoodLinks[$dbkey]) ) {
+                       unset($this->mGoodLinks[$dbkey]);
                }
-               
-               $id = NULL;
-               if( $wgLinkCacheMemcached )
-                       $id = $wgMemc->get( $key = $this->getKey( $title ) );
-               if( ! is_integer( $id ) ) {
-                       if ( $this->mForUpdate ) {
-                               $db =& wfGetDB( DB_MASTER );
-                               $options = array( 'FOR UPDATE' );
-                       } else {
-                               $db =& wfGetDB( DB_SLAVE );
-                               $options = array();
-                       }
-
-                       $id = $db->selectField( 'page', 'page_id', array( 'page_namespace' => $ns, 'page_title' => $t ), $fname, $options );
-                       if ( !$id ) {
-                               $id = 0;
-                       }
-                       if( $wgLinkCacheMemcached )
-                               $wgMemc->add( $key, $id, 3600*24 );
+               if( isset($this->mGoodLinkFields[$dbkey]) ) {
+                       unset($this->mGoodLinkFields[$dbkey]);
                }
-               
-               if ( 0 == $id ) { $this->addBadLink( $title ); }
-               else { $this->addGoodLink( $id, $title ); }
-               wfProfileOut( $fname );
-               return $id;
        }
 
-       function preFill( &$fromtitle ) {
-               global $wgEnablePersistentLC;
-
-               $fname = 'LinkCache::preFill';
-               wfProfileIn( $fname );
-               # Note -- $fromtitle is a Title *object*
-
-               $this->suspend();
-               $id = $fromtitle->getArticleID();
-               $this->resume();
-               
-               if( $id == 0 ) {
-                       wfDebug( "$fname - got id 0 for title '" . $fromtitle->getPrefixedDBkey() . "'\n" );
-                       wfProfileOut( $fname );
-                       return;
-               }
-               
-               if ( $wgEnablePersistentLC ) {
-                       if( $this->fillFromLinkscc( $id ) ){
-                               wfProfileOut( $fname );
-                               return;
-                       }
-               }
-               if ( $this->mForUpdate ) {
-                       $db =& wfGetDB( DB_MASTER );
-                       $options = 'FOR UPDATE';
-               } else {
-                       $db =& wfGetDB( DB_SLAVE );
-                       $options = '';
-               }
-
-               $page = $db->tableName( 'page' );
-               $links = $db->tableName( 'links' );
-
-               $sql = "SELECT page_id,page_namespace,page_title
-                       FROM $page,$links
-                       WHERE page_id=l_to AND l_from=$id $options";
-               $res = $db->query( $sql, $fname );
-               while( $s = $db->fetchObject( $res ) ) {
-                       $this->addGoodLink( $s->page_id,
-                               Title::makeName( $s->page_namespace, $s->page_title )
-                               );
-               }
-               
-               $res = $db->select( 'brokenlinks', array( 'bl_to' ), array( 'bl_from' => $id ), $fname, array( $options ) );
-               while( $s = $db->fetchObject( $res ) ) {
-                       $this->addBadLink( $s->bl_to );
-               }
-               
-               $this->mOldBadLinks = $this->mBadLinks;
-               $this->mOldGoodLinks = $this->mGoodLinks;
-               $this->mPreFilled = true;
-
-               if ( $wgEnablePersistentLC ) {
-                       $this->saveToLinkscc( $id );
-               }
-               wfProfileOut( $fname );
-       }
-
-       function getGoodAdditions() {
-               return array_diff( $this->mGoodLinks, $this->mOldGoodLinks );
-       }
-
-       function getBadAdditions() {
-               #wfDebug( "mOldBadLinks: " . implode( ', ', array_keys( $this->mOldBadLinks ) ) . "\n" );
-               #wfDebug( "mBadLinks: " . implode( ', ', array_keys( $this->mBadLinks ) ) . "\n" );
-               return array_values( array_diff( array_keys( $this->mBadLinks ), array_keys( $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( array_keys( $this->mOldBadLinks ), array_keys( $this->mBadLinks ) ));
-       }
-
-       function getImageDeletions() {
-               return array_diff_assoc( $this->mOldImageLinks, $this->mImageLinks );
-       }
+       public function getGoodLinks() { return $this->mGoodLinks; }
+       public function getBadLinks() { return array_keys( $this->mBadLinks ); }
 
        /**
-        * Parameters:
-        * @param $which is one of the LINKCACHE_xxx constants
-        * @param $del,$add are the incremental update arrays which will be filled.
-        *
-        * @return Returns whether or not it's worth doing the incremental version.
+        * Add a title to the link cache, return the page_id or zero if non-existent
         *
-        * For example, if [[List of mathematical topics]] was blanked,
-        * it would take a long, long time to do incrementally.
+        * @param $title String: title to add
+        * @return Integer
         */
-       function incrementalSetup( $which, &$del, &$add ) {
-               if ( ! $this->mPreFilled ) {
-                       return false;
-               }
-
-               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;           
+       public function addLink( $title ) {
+               $nt = Title::newFromDBkey( $title );
+               if( $nt ) {
+                       return $this->addLinkObj( $nt );
+               } else {
+                       return 0;
                }
-               
-               return true;
-       }
-
-       /**
-        * Clears cache but leaves old preFill copies alone
-        */
-       function clear() {
-               $this->mGoodLinks = array();
-               $this->mBadLinks = array();
-               $this->mImageLinks = array();
        }
 
        /**
-        * @access private
+        * Add a title to the link cache, return the page_id or zero if non-existent
+        *
+        * @param $nt Title object to add
+        * @return Integer
         */
-       function fillFromLinkscc( $id ){ 
-               $fname = 'LinkCache::fillFromLinkscc';
+       public function addLinkObj( $nt ) {
+               global $wgAntiLockFlags;
+               wfProfileIn( __METHOD__ );
 
-               $id = IntVal( $id );
-               if ( $this->mForUpdate ) {
-                       $db =& wfGetDB( DB_MASTER );
-                       $options = 'FOR UPDATE';
-               } else {
-                       $db =& wfGetDB( DB_SLAVE );
-                       $options = '';
+               $key = $nt->getPrefixedDBkey();
+               if ( $this->isBadLink( $key ) || $nt->isExternal() ) {
+                       wfProfileOut( __METHOD__ );
+                       return 0;
                }
-               $raw = $db->selectField( 'linkscc', 'lcc_cacheobj', array( 'lcc_pageid' => $id ), $fname, $options );
-               if ( $raw === false ) {
-                       return false;
+               $id = $this->getGoodLinkID( $key );
+               if ( $id != 0 ) {
+                       wfProfileOut( __METHOD__ );
+                       return $id;
                }
-               
-               $cacheobj = false;
-               if( function_exists( 'gzuncompress' ) )
-                       $cacheobj = @gzuncompress( $raw );
 
-               if($cacheobj == FALSE){
-                       $cacheobj = $raw;
-               }
-               $cc = @unserialize( $cacheobj );
-               if( isset( $cc->mClassVer ) and ($cc->mClassVer == $this->mClassVer ) ){
-                       $this->mOldGoodLinks = $this->mGoodLinks = $cc->mGoodLinks;
-                       $this->mOldBadLinks = $this->mBadLinks = $cc->mBadLinks;
-                       $this->mPreFilled = true;
-                       return TRUE;
-               } else {
-                       return FALSE;
+               if ( $key === '' ) {
+                       wfProfileOut( __METHOD__ );
+                       return 0;
                }
 
-       }
-
-       /**
-        * @access private
-        */
-       function saveToLinkscc( $pid ){
-               global $wgCompressedPersistentLC;
-               if( $wgCompressedPersistentLC and function_exists( 'gzcompress' ) ) {
-                       $ser = gzcompress( serialize( $this ), 3 );
+               # 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 {
-                       $ser = serialize( $this );
-               }
-               $db =& wfGetDB( DB_MASTER );
-               $db->replace( 'linkscc', array( 'lcc_pageid' ), array( 'lcc_pageid' => $pid, 'lcc_cacheobj' => $ser ) );
-       }
-
-       /**
-        * Delete linkscc rows which link to here
-        * @param $pid is a page id
-        * @static
-        */
-       function linksccClearLinksTo( $pid ){
-               global $wgEnablePersistentLC;
-               if ( $wgEnablePersistentLC ) {
-                       $fname = 'LinkCache::linksccClearLinksTo';
-                       $pid = intval( $pid );
-                       $dbw =& wfGetDB( DB_MASTER );
-                       # Delete linkscc rows which link to here
-                       $dbw->deleteJoin( 'linkscc', 'links', 'lcc_pageid', 'l_from', array( 'l_to' => $pid ), $fname );
-                       # Delete linkscc row representing this page
-                       $dbw->delete( 'linkscc', array( 'lcc_pageid' => $pid ), $fname);
+                       $db = wfGetDB( DB_SLAVE );
+                       $options = array();
+               }
+
+               $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;
                }
 
-       }
-
-       /**
-        * Delete linkscc rows with broken links to here
-        * @param $title is a prefixed db title for example like Title->getPrefixedDBkey() returns.
-        * @static
-        */
-       function linksccClearBrokenLinksTo( $title ){
-               global $wgEnablePersistentLC;
-               $fname = 'LinkCache::linksccClearBrokenLinksTo';
-
-               if ( $wgEnablePersistentLC ) {
-                       $dbw =& wfGetDB( DB_MASTER );
-                       $dbw->deleteJoin( 'linkscc', 'brokenlinks', 'lcc_pageid', 'bl_from', array( 'bl_to' => $title ), $fname );
+               if ( $id == 0 ) {
+                       $this->addBadLinkObj( $nt );
+               } else {
+                       $this->addGoodLinkObj( $id, $nt, $len, $redirect, $revision );
                }
+               wfProfileOut( __METHOD__ );
+               return $id;
        }
 
        /**
-        * @param $pid is a page id
-        * @static
+        * Clears cache
         */
-       function linksccClearPage( $pid ){
-               global $wgEnablePersistentLC;
-               if ( $wgEnablePersistentLC ) {
-                       $pid = intval( $pid );
-                       $dbw =& wfGetDB( DB_MASTER );
-                       $dbw->delete( 'linkscc', array( 'lcc_pageid' => $pid ) );
-               }
+       public function clear() {
+               $this->mGoodLinks = array();
+               $this->mGoodLinkFields = array();
+               $this->mBadLinks = array();
        }
 }
-?>