Modification to LinkBatch
[lhc/web/wiklou.git] / includes / LinkCache.php
index 4bb1dfe..4a57909 100644 (file)
@@ -1,11 +1,21 @@
 <?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
+ */
+
+/**
+ *
+ */
 # These are used in incrementalSetup()
 define ('LINKCACHE_GOOD', 0);
 define ('LINKCACHE_BAD', 1);
 define ('LINKCACHE_IMAGE', 2);
 
+/**
+ *
+ * @package MediaWiki
+ */
 class LinkCache {      
        // Increment $mClassVer whenever old serialized versions of this class
        // becomes incompatible with the new version.
@@ -18,11 +28,10 @@ class LinkCache {
 
        /* 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;
@@ -34,13 +43,14 @@ class LinkCache {
                $this->mOldBadLinks = array();
        }
 
-       # General accessor to get/set whether SELECT FOR UPDATE should be used
+       /**
+        * General accessor to get/set whether SELECT FOR UPDATE should be used
+        */
        function forUpdate( $update = NULL ) { 
                return wfSetVar( $this->mForUpdate, $update );
        }
        
-       function getGoodLinkID( $title )
-       {
+       function getGoodLinkID( $title ) {
                if ( array_key_exists( $title, $this->mGoodLinks ) ) {
                        return $this->mGoodLinks[$title];
                } else {
@@ -48,32 +58,27 @@ class LinkCache {
                }
        }
 
-       function isBadLink( $title )
-       {
+       function isBadLink( $title ) {
                return array_key_exists( $title, $this->mBadLinks ); 
        }
 
-       function addGoodLink( $id, $title )
-       {
+       function addGoodLink( $id, $title ) {
                if ( $this->mActive ) {
                        $this->mGoodLinks[$title] = $id;
                }
        }
 
-       function addBadLink( $title )
-       {
+       function addBadLink( $title ) {
                if ( $this->mActive && ( ! $this->isBadLink( $title ) ) ) {
                        $this->mBadLinks[$title] = 1;
                }
        }
 
-       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; }
        }
        
@@ -85,14 +90,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 ) );
@@ -105,8 +108,7 @@ class LinkCache {
        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 );
@@ -115,21 +117,20 @@ class LinkCache {
                }
        }
        
-       function addLinkObj( &$nt )
-       {
+       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";
+               $fname = 'LinkCache::addLinkObj';
                wfProfileIn( $fname );
 
                $ns = $nt->getNamespace();
                $t = $nt->getDBkey();
 
-               if ( "" == $title ) { 
+               if ( '' == $title ) { 
                        wfProfileOut( $fname );
                        return 0; 
                }
@@ -146,7 +147,7 @@ class LinkCache {
                                $options = array();
                        }
 
-                       $id = $db->getField( 'cur', 'cur_id', array( 'cur_namespace' => $ns, 'cur_title' => $t ), $fname, $options );
+                       $id = $db->selectField( 'page', 'page_id', array( 'page_namespace' => $ns, 'page_title' => $t ), $fname, $options );
                        if ( !$id ) {
                                $id = 0;
                        }
@@ -160,11 +161,10 @@ class LinkCache {
                return $id;
        }
 
-       function preFill( &$fromtitle )
-       {
+       function preFill( &$fromtitle ) {
                global $wgEnablePersistentLC;
 
-               $fname = "LinkCache::preFill";
+               $fname = 'LinkCache::preFill';
                wfProfileIn( $fname );
                # Note -- $fromtitle is a Title *object*
 
@@ -192,16 +192,16 @@ class LinkCache {
                        $options = '';
                }
 
-               $cur = $db->tableName( 'cur' );
+               $page = $db->tableName( 'page' );
                $links = $db->tableName( 'links' );
 
-               $sql = "SELECT cur_id,cur_namespace,cur_title
-                       FROM $cur,$links
-                       WHERE cur_id=l_to AND l_from=$id $options";
+               $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->cur_id,
-                               Title::makeName( $s->cur_namespace, $s->cur_title )
+                       $this->addGoodLink( $s->page_id,
+                               Title::makeName( $s->page_namespace, $s->page_title )
                                );
                }
                
@@ -220,44 +220,43 @@ 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 );
        }
 
-       #     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;
                }
@@ -282,15 +281,19 @@ 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->mGoodLinks = array();
                $this->mBadLinks = array();
                $this->mImageLinks = array();
        }
 
-       /* private */ function fillFromLinkscc( $id ){ 
+       /**
+        * @access private
+        */
+       function fillFromLinkscc( $id ){ 
                $fname = 'LinkCache::fillFromLinkscc';
 
                $id = IntVal( $id );
@@ -301,13 +304,13 @@ class LinkCache {
                        $db =& wfGetDB( DB_SLAVE );
                        $options = '';
                }
-               $raw = $db->getField( 'linkscc', 'lcc_cacheobj', array( 'lcc_pageid' => $id ), $fname, $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){
@@ -325,9 +328,12 @@ 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 );
@@ -336,12 +342,15 @@ class LinkCache {
                $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 $pid is a page id
+        * @static
+        */
+       function linksccClearLinksTo( $pid ){
                global $wgEnablePersistentLC;
                if ( $wgEnablePersistentLC ) {
-                       $fname = "LinkCache::linksccClearLinksTo";
+                       $fname = 'LinkCache::linksccClearLinksTo';
                        $pid = intval( $pid );
                        $dbw =& wfGetDB( DB_MASTER );
                        # Delete linkscc rows which link to here
@@ -352,9 +361,12 @@ class LinkCache {
 
        }
 
-       # Delete linkscc rows with broken links to here
-       # $title is a prefixed db title, for example like Title->getPrefixedDBkey() returns.
-       /* static */ function linksccClearBrokenLinksTo( $title ){
+       /**
+        * 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';
 
@@ -364,8 +376,11 @@ class LinkCache {
                }
        }
 
-       # $pid is a page id
-       /* static */ function linksccClearPage( $pid ){
+       /**
+        * @param $pid is a page id
+        * @static
+        */
+       function linksccClearPage( $pid ){
                global $wgEnablePersistentLC;
                if ( $wgEnablePersistentLC ) {
                        $pid = intval( $pid );
@@ -374,4 +389,98 @@ class LinkCache {
                }
        }
 }
+
+/**
+ * Class representing a list of titles
+ * The execute() method checks them all for existence and adds them to a LinkCache object
+ */
+class LinkBatch {
+       /** 
+        * 2-d array, first index namespace, second index dbkey, value arbitrary
+        */
+       var $data = array();
+
+       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 ";
+               $first = true;
+               
+               foreach ( $this->data as $ns => $dbkeys ) {
+                       if ( !count( $dbkeys ) ) {
+                               continue;
+                       }
+
+                       if ( $first ) {
+                               $first = false;
+                       } else {
+                               $sql .= ' OR ';
+                       }
+                       $sql .= "(page_namespace=$ns AND page_title IN (";
+
+                       $firstTitle = true;
+                       foreach( $dbkeys as $dbkey => $nothing ) {
+                               if ( $firstTitle ) {
+                                       $firstTitle = false;
+                               } else {
+                                       $sql .= ',';
+                               }
+                               $sql .= $dbr->addQuotes( $dbkey );
+                       }
+
+                       $sql .= '))';
+               }
+               
+               // 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->addGoodLink( $row->page_id, $title->getPrefixedDBkey() );
+                       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->addBadLink( $title->getPrefixedText() );
+                       }
+               }
+
+               wfProfileOut( $fname );
+       }
+}
+
 ?>