ported $wgAntiLockFlags from REL1_4
[lhc/web/wiklou.git] / includes / LinkCache.php
index 8dcba6f..9d86a24 100644 (file)
@@ -1,29 +1,44 @@
 <?php
-# Cache for article titles (prefixed DB keys) and ids linked from one source
-
+/**
+ * Cache for article titles (prefixed DB keys) and ids linked from one source
+ * @package MediaWiki
+ * @subpackage Cache
+ */
+
+/**
+ *
+ */
 # These are used in incrementalSetup()
 define ('LINKCACHE_GOOD', 0);
 define ('LINKCACHE_BAD', 1);
 define ('LINKCACHE_IMAGE', 2);
+define ('LINKCACHE_PAGE', 3);
 
+/**
+ * @package MediaWiki
+ * @subpackage Cache
+ */
 class LinkCache {      
        // Increment $mClassVer whenever old serialized versions of this class
        // becomes incompatible with the new version.
-       /* private */ var $mClassVer = 2;
+       /* private */ var $mClassVer = 3;
 
+       /* private */ var $mPageLinks;
        /* private */ var $mGoodLinks, $mBadLinks, $mActive;
        /* private */ var $mImageLinks, $mCategoryLinks;
        /* private */ var $mPreFilled, $mOldGoodLinks, $mOldBadLinks;
-       
+       /* private */ var $mForUpdate;
+
        /* private */ function getKey( $title ) {
                global $wgDBname;
-               return "$wgDBname:lc:title:$title";
+               return $wgDBname.':lc:title:'.$title;
        }
        
-       function LinkCache()
-       {
+       function LinkCache() {
                $this->mActive = true;
                $this->mPreFilled = false;
+               $this->mForUpdate = false;
+               $this->mPageLinks = array();
                $this->mGoodLinks = array();
                $this->mBadLinks = array();
                $this->mImageLinks = array();
@@ -32,8 +47,14 @@ class LinkCache {
                $this->mOldBadLinks = array();
        }
 
-       function getGoodLinkID( $title )
-       {
+       /**
+        * General accessor to get/set whether SELECT FOR UPDATE should be used
+        */
+       function forUpdate( $update = NULL ) { 
+               return wfSetVar( $this->mForUpdate, $update );
+       }
+       
+       function getGoodLinkID( $title ) {
                if ( array_key_exists( $title, $this->mGoodLinks ) ) {
                        return $this->mGoodLinks[$title];
                } else {
@@ -41,32 +62,31 @@ class LinkCache {
                }
        }
 
-       function isBadLink( $title )
-       {
+       function isBadLink( $title ) {
                return array_key_exists( $title, $this->mBadLinks ); 
        }
 
-       function addGoodLink( $id, $title )
-       {
+       function addGoodLinkObj( $id, $title ) {
                if ( $this->mActive ) {
-                       $this->mGoodLinks[$title] = $id;
+                       $dbkey = $title->getPrefixedDbKey();
+                       $this->mGoodLinks[$dbkey] = $id;
+                       $this->mPageLinks[$dbkey] = $title;
                }
        }
 
-       function addBadLink( $title )
-       {
-               if ( $this->mActive && ( ! $this->isBadLink( $title ) ) ) {
-                       $this->mBadLinks[$title] = 1;
+       function addBadLinkObj( $title ) {
+               $dbkey = $title->getPrefixedDbKey();
+               if ( $this->mActive && ( ! $this->isBadLink( $dbkey ) ) ) {
+                       $this->mBadLinks[$dbkey] = 1;
+                       $this->mPageLinks[$dbkey] = $title;
                }
        }
 
-       function addImageLink( $title )
-       {
+       function addImageLink( $title ) {
                if ( $this->mActive ) { $this->mImageLinks[$title] = 1; }
        }
 
-       function addImageLinkObj( $nt )
-       {
+       function addImageLinkObj( $nt ) {
                if ( $this->mActive ) { $this->mImageLinks[$nt->getDBkey()] = 1; }
        }
        
@@ -78,14 +98,12 @@ class LinkCache {
                $this->addCategoryLink( $nt->getDBkey(), $sortkey );
        }
 
-       function clearBadLink( $title )
-       {
+       function clearBadLink( $title ) {
                unset( $this->mBadLinks[$title] );
                $this->clearLink( $title );
        }
        
-       function clearLink( $title ) 
-       {
+       function clearLink( $title ) {
                global $wgMemc, $wgLinkCacheMemcached;
                if( $wgLinkCacheMemcached )
                        $wgMemc->delete( $this->getKey( $title ) );
@@ -93,13 +111,13 @@ class LinkCache {
 
        function suspend() { $this->mActive = false; }
        function resume() { $this->mActive = true; }
+       function getPageLinks() { return $this->mPageLinks; }
        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 )
-       {
+       function addLink( $title ) {
                $nt = Title::newFromDBkey( $title );
                if( $nt ) {
                        return $this->addLinkObj( $nt );
@@ -108,21 +126,20 @@ class LinkCache {
                }
        }
        
-       function addLinkObj( &$nt )
-       {
-               global $wgMemc, $wgLinkCacheMemcached;
+       function addLinkObj( &$nt ) {
+               global $wgMemc, $wgLinkCacheMemcached, $wgAntiLockFlags;
                $title = $nt->getPrefixedDBkey();
                if ( $this->isBadLink( $title ) ) { return 0; }         
                $id = $this->getGoodLinkID( $title );
                if ( 0 != $id ) { return $id; }
 
-               $fname = "LinkCache::addLinkObj";
+               $fname = 'LinkCache::addLinkObj';
                wfProfileIn( $fname );
 
                $ns = $nt->getNamespace();
                $t = $nt->getDBkey();
 
-               if ( "" == $title ) { 
+               if ( '' == $title ) { 
                        wfProfileOut( $fname );
                        return 0; 
                }
@@ -131,8 +148,17 @@ class LinkCache {
                if( $wgLinkCacheMemcached )
                        $id = $wgMemc->get( $key = $this->getKey( $title ) );
                if( ! is_integer( $id ) ) {
-                       $dbr =& wfGetDB( DB_READ );
-                       $id = $dbr->getField( 'cur', 'cur_id', array( 'cur_namespace' => $ns, 'cur_title' => $t ), $fname );
+                       if ( $this->mForUpdate ) {
+                               $db =& wfGetDB( DB_MASTER );
+                               if ( !( $wgAntiLockFlags & ALF_NO_LINK_LOCK ) ) {
+                                       $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;
                        }
@@ -140,19 +166,24 @@ class LinkCache {
                                $wgMemc->add( $key, $id, 3600*24 );
                }
                
-               if ( 0 == $id ) { $this->addBadLink( $title ); }
-               else { $this->addGoodLink( $id, $title ); }
+               if( 0 == $id ) {
+                       $this->addBadLinkObj( $nt );
+               } else {
+                       $this->addGoodLinkObj( $id, $nt );
+               }
                wfProfileOut( $fname );
                return $id;
        }
 
-       function preFill( &$fromtitle )
-       {
+       /**
+        * Bulk-check the pagelinks and page arrays for existence info.
+        * @param Title $fromtitle
+        */
+       function preFill( &$fromtitle ) {
                global $wgEnablePersistentLC;
 
-               $fname = "LinkCache::preFill";
+               $fname = 'LinkCache::preFill';
                wfProfileIn( $fname );
-               # Note -- $fromtitle is a Title *object*
 
                $this->suspend();
                $id = $fromtitle->getArticleID();
@@ -170,27 +201,33 @@ class LinkCache {
                                return;
                        }
                }
-
-               $dbr =& wfGetDB( DB_READ );
-               $cur = $dbr->tableName( 'cur' );
-               $links = $dbr->tableName( 'links' );
-
-               $sql = "SELECT cur_id,cur_namespace,cur_title
-                       FROM $cur,$links
-                       WHERE cur_id=l_to AND l_from=$id";
-               $res = $dbr->query( $sql, $fname );
-               while( $s = $dbr->fetchObject( $res ) ) {
-                       $this->addGoodLink( $s->cur_id,
-                               Title::makeName( $s->cur_namespace, $s->cur_title )
-                               );
+               if ( $this->mForUpdate ) {
+                       $db =& wfGetDB( DB_MASTER );
+                       $options = 'FOR UPDATE';
+               } else {
+                       $db =& wfGetDB( DB_SLAVE );
+                       $options = '';
                }
-               
-               $res = $dbr->select( 'brokenlinks', array( 'bl_to' ), array( 'bl_from' => $id ), $fname );
-               while( $s = wfFetchObject( $res ) ) {
-                       $this->addBadLink( $s->bl_to );
+
+               $page = $db->tableName( 'page' );
+               $pagelinks = $db->tableName( 'pagelinks' );
+
+               $sql = "SELECT page_id,pl_namespace,pl_title
+                       FROM $pagelinks
+                       LEFT JOIN $page
+                       ON pl_namespace=page_namespace AND pl_title=page_title
+                       WHERE pl_from=$id $options";
+               $res = $db->query( $sql, $fname );
+               while( $s = $db->fetchObject( $res ) ) {
+                       $title = Title::makeTitle( $s->pl_namespace, $s->pl_title );
+                       if( $s->page_id ) {
+                               $this->addGoodLinkObj( $s->page_id, $title );
+                       } else {
+                               $this->addBadLinkObj( $title );
+                       }
                }
-               
-               $this->mOldBadLinks = $this->mBadLinks;
+               $this->mOldPageLinks = $this->mPageLinks;
+               $this->mOldBadLinks  = $this->mBadLinks;
                $this->mOldGoodLinks = $this->mGoodLinks;
                $this->mPreFilled = true;
 
@@ -200,44 +237,61 @@ class LinkCache {
                wfProfileOut( $fname );
        }
 
-       function getGoodAdditions() 
-       {
+       function getGoodAdditions() {
                return array_diff( $this->mGoodLinks, $this->mOldGoodLinks );
        }
 
-       function getBadAdditions() 
-       {
+       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()
-       {
+       function getImageAdditions() {
                return array_diff_assoc( $this->mImageLinks, $this->mOldImageLinks );
        }
 
-       function getGoodDeletions() 
-       {
+       function getGoodDeletions() {
                return array_diff( $this->mOldGoodLinks, $this->mGoodLinks );
        }
 
-       function getBadDeletions()
-       {
+       function getBadDeletions() {
                return array_values( array_diff( array_keys( $this->mOldBadLinks ), array_keys( $this->mBadLinks ) ));
        }
 
-       function getImageDeletions()
-       {
+       function getImageDeletions() {
                return array_diff_assoc( $this->mOldImageLinks, $this->mImageLinks );
        }
+       
+       function getPageAdditions() {
+               $set = array_diff( array_keys( $this->mPageLinks ), array_keys( $this->mOldPageLinks ) );
+               $out = array();
+               foreach( $set as $key ) {
+                       $out[$key] = $this->mPageLinks[$key];
+               }
+               return $out;
+       }
+       
+       function getPageDeletions() {
+               $set = array_diff( array_keys( $this->mOldPageLinks ), array_keys( $this->mPageLinks ) );
+               $out = array();
+               foreach( $set as $key ) {
+                       $out[$key] = $this->mOldPageLinks[$key];
+               }
+               return $out;
+       }
 
-       #     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 )
-       {
+       /**
+        * 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.
+        *
+        * 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;
                }
@@ -255,6 +309,12 @@ class LinkCache {
                                $del = $this->getBadDeletions();
                                $add = $this->getBadAdditions();
                                break;
+                       case LINKCACHE_PAGE:
+                               $old =& $this->mOldPageLinks;
+                               $cur =& $this->mPageLinks;
+                               $del = $this->getPageDeletions();
+                               $add = $this->getPageAdditions();
+                               break;
                        default: # LINKCACHE_IMAGE
                                return false;           
                }
@@ -262,24 +322,37 @@ class LinkCache {
                return true;
        }
 
-       # Clears cache but leaves old preFill copies alone
-       function clear() 
-       {
+       /**
+        * Clears cache but leaves old preFill copies alone
+        */
+       function clear() {
+               $this->mPageLinks = array();
                $this->mGoodLinks = array();
                $this->mBadLinks = array();
                $this->mImageLinks = array();
        }
 
-       /* private */ function fillFromLinkscc( $id ){ 
+       /**
+        * @access private
+        */
+       function fillFromLinkscc( $id ){ 
+               $fname = 'LinkCache::fillFromLinkscc';
+
                $id = IntVal( $id );
-               $dbr =& wfGetDB( DB_READ );
-               $raw = $dbr->getField( 'linkscc', 'lcc_cacheobj', array( 'lcc_pageid' => $id ) );
+               if ( $this->mForUpdate ) {
+                       $db =& wfGetDB( DB_MASTER );
+                       $options = 'FOR UPDATE';
+               } else {
+                       $db =& wfGetDB( DB_SLAVE );
+                       $options = '';
+               }
+               $raw = $db->selectField( 'linkscc', 'lcc_cacheobj', array( 'lcc_pageid' => $id ), $fname, $options );
                if ( $raw === false ) {
                        return false;
                }
                
                $cacheobj = false;
-               if( function_exists( "gzuncompress" ) )
+               if( function_exists( 'gzuncompress' ) )
                        $cacheobj = @gzuncompress( $raw );
 
                if($cacheobj == FALSE){
@@ -287,6 +360,7 @@ class LinkCache {
                }
                $cc = @unserialize( $cacheobj );
                if( isset( $cc->mClassVer ) and ($cc->mClassVer == $this->mClassVer ) ){
+                       $this->mOldPageLinks = $this->mPageLinks = $cc->mPageLinks;
                        $this->mOldGoodLinks = $this->mGoodLinks = $cc->mGoodLinks;
                        $this->mOldBadLinks = $this->mBadLinks = $cc->mBadLinks;
                        $this->mPreFilled = true;
@@ -297,53 +371,170 @@ class LinkCache {
 
        }
 
-       /* private */ function saveToLinkscc( $pid ){
+       /**
+        * @access private
+        */
+       function saveToLinkscc( $pid ){
                global $wgCompressedPersistentLC;
-               if( $wgCompressedPersistentLC and function_exists( "gzcompress" ) ) {
+               if( $wgCompressedPersistentLC and function_exists( 'gzcompress' ) ) {
                        $ser = gzcompress( serialize( $this ), 3 );
                } else {
                        $ser = serialize( $this );
                }
-               $db =& wfGetDB( DB_WRITE );
+               $db =& wfGetDB( DB_MASTER );
                $db->replace( 'linkscc', array( 'lcc_pageid' ), array( 'lcc_pageid' => $pid, 'lcc_cacheobj' => $ser ) );
        }
 
-       # Delete linkscc rows which link to here
-       # $pid is a page id
-       /* static */ function linksccClearLinksTo( $pid ){
+       /**
+        * Delete linkscc rows which link to here
+        * @param $title The page linked to
+        * @static
+        */
+       function linksccClearLinksTo( $title ){
                global $wgEnablePersistentLC;
                if ( $wgEnablePersistentLC ) {
-                       $fname = "LinkCache::linksccClearLinksTo";
+                       $fname = 'LinkCache::linksccClearLinksTo';
                        $pid = intval( $pid );
-                       $dbw =& wfGetDB( DB_WRITE );
+                       $dbw =& wfGetDB( DB_MASTER );
                        # Delete linkscc rows which link to here
-                       $dbw->deleteJoin( 'linkscc', 'links', 'lcc_pageid', 'l_from', array( 'l_to' => $pid ), $fname );
+                       $dbw->deleteJoin( 'linkscc', 'pagelinks', 'lcc_pageid', 'pl_from',
+                               array(
+                                       'pl_namespace' => $title->getNamespace(),
+                                       'pl-title'     => $title->getDbKey() ),
+                               $fname );
                        # Delete linkscc row representing this page
                        $dbw->delete( 'linkscc', array( 'lcc_pageid' => $pid ), $fname);
                }
 
        }
 
-       # Delete linkscc rows with broken links to here
-       # $title is a prefixed db title, for example like Title->getPrefixedDBkey() returns.
-       /* static */ function linksccClearBrokenLinksTo( $title ){
+       /**
+        * @param $pid is a page id
+        * @static
+        */
+       function linksccClearPage( $pid ){
                global $wgEnablePersistentLC;
-               $fname = 'LinkCache::linksccClearBrokenLinksTo';
-
                if ( $wgEnablePersistentLC ) {
-                       $dbw =& wfGetDB( DB_WRITE );
-                       $dbw->deleteJoin( 'linkscc', 'brokenlinks', 'lcc_pageid', 'bl_from', array( 'bl_to' => $title ), $fname );
+                       $pid = intval( $pid );
+                       $dbw =& wfGetDB( DB_MASTER );
+                       $dbw->delete( 'linkscc', array( 'lcc_pageid' => $pid ) );
                }
        }
+}
 
-       # $pid is a page id
-       /* static */ function linksccClearPage( $pid ){
-               global $wgEnablePersistentLC;
-               if ( $wgEnablePersistentLC ) {
-                       $pid = intval( $pid );
-                       $dbw =& wfGetDB( DB_WRITE );
-                       $dbw->delete( 'linkscc', array( 'lcc_pageid' => $pid ) );
+/**
+ * Class representing a list of titles
+ * The execute() method checks them all for existence and adds them to a LinkCache object
+ +
+ * @package MediaWikki
+ * @subpackage Cache
+ */
+class LinkBatch {
+       /** 
+        * 2-d array, first index namespace, second index dbkey, value arbitrary
+        */
+       var $data = array();
+
+       function LinkBatch( $arr = array() ) {
+               foreach( $arr as $item ) {
+                       $this->addObj( $item );
                }
        }
+       
+       function addObj( $title ) {
+               $this->add( $title->getNamespace(), $title->getDBkey() );
+       }
+
+       function add( $ns, $dbkey ) {
+               if ( $ns < 0 ) {
+                       return;
+               }
+               if ( !array_key_exists( $ns, $this->data ) ) {
+                       $this->data[$ns] = array();
+               }
+
+               $this->data[$ns][$dbkey] = 1;
+       }
+
+       function execute( &$cache ) {
+               $fname = 'LinkBatch::execute';
+               $namespaces = array();
+
+               if ( !count( $this->data ) ) {
+                       return;
+               }
+
+               wfProfileIn( $fname );
+
+               // Construct query
+               // This is very similar to Parser::replaceLinkHolders
+               $dbr = wfGetDB( DB_SLAVE );
+               $page = $dbr->tableName( 'page' );
+               $sql = "SELECT page_id, page_namespace, page_title FROM $page WHERE "
+                       . $this->constructSet( 'page', $dbr );
+               
+               // Do query
+               $res = $dbr->query( $sql, $fname );
+
+               // Process results
+               // For each returned entry, add it to the list of good links, and remove it from $remaining
+
+               $remaining = $this->data;
+               while ( $row = $dbr->fetchObject( $res ) ) {
+                       $title = Title::makeTitle( $row->page_namespace, $row->page_title );
+                       $cache->addGoodLinkObj( $row->page_id, $title );
+                       unset( $remaining[$row->page_namespace][$row->page_title] );
+               }
+               $dbr->freeResult( $res );
+
+               // The remaining links in $data are bad links, register them as such
+               foreach ( $remaining as $ns => $dbkeys ) {
+                       foreach ( $dbkeys as $dbkey => $nothing ) {
+                               $title = Title::makeTitle( $ns, $dbkey );
+                               $cache->addBadLinkObj( $title );
+                       }
+               }
+
+               wfProfileOut( $fname );
+       }
+       
+       /**
+        * Construct a WHERE clause which will match all the given titles.
+        * Give the appropriate table's field name prefix ('page', 'pl', etc).
+        *
+        * @param string $prefix
+        * @return string
+        * @access public
+        */
+       function constructSet( $prefix, $db ) {
+               $first = true;
+               $sql = '';
+               foreach ( $this->data as $ns => $dbkeys ) {
+                       if ( !count( $dbkeys ) ) {
+                               continue;
+                       }
+
+                       if ( $first ) {
+                               $first = false;
+                       } else {
+                               $sql .= ' OR ';
+                       }
+                       $sql .= "({$prefix}_namespace=$ns AND {$prefix}_title IN (";
+
+                       $firstTitle = true;
+                       foreach( $dbkeys as $dbkey => $nothing ) {
+                               if ( $firstTitle ) {
+                                       $firstTitle = false;
+                               } else {
+                                       $sql .= ',';
+                               }
+                               $sql .= $db->addQuotes( $dbkey );
+                       }
+
+                       $sql .= '))';
+               }
+               return $sql;
+       }
 }
+
 ?>