Prevent registration/login with the username "MediaWiki default"
[lhc/web/wiklou.git] / includes / LinkCache.php
index 7332524..33447c3 100644 (file)
@@ -1,38 +1,54 @@
-<?
-# 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);
-
-class LinkCache {      
+<?php
+/**
+ * Cache for article titles (prefixed DB keys) and ids linked from one source
+ * @package MediaWiki
+ * @subpackage Cache
+ */
+
+/**
+ * @package MediaWiki
+ * @subpackage Cache
+ */
+class LinkCache {
        // Increment $mClassVer whenever old serialized versions of this class
        // becomes incompatible with the new version.
-       /* private */ var $mClassVer = 1; 
+       /* private */ var $mClassVer = 3;
+
+       /* private */ var $mPageLinks;
+       /* private */ var $mGoodLinks, $mBadLinks;
+       /* private */ var $mForUpdate;
+
+       /**
+        * Get an instance of this class
+        */
+       function &singleton() {
+               static $instance;
+               if ( !isset( $instance ) ) {
+                       $instance = new LinkCache;
+               }
+               return $instance;
+       }
+
+       function LinkCache() {
+               $this->mForUpdate = false;
+               $this->mPageLinks = array();
+               $this->mGoodLinks = array();
+               $this->mBadLinks = array();
+       }
 
-       /* private */ var $mGoodLinks, $mBadLinks, $mActive;
-       /* private */ var $mImageLinks; 
-       /* private */ var $mPreFilled, $mOldGoodLinks, $mOldBadLinks;
-       
        /* private */ function getKey( $title ) {
                global $wgDBname;
-               return "$wgDBname:lc:title:$title";
+               return $wgDBname.':lc:title:'.$title;
        }
-       
-       function LinkCache()
-       {
-               $this->mActive = true;
-               $this->mPreFilled = false;
-               $this->mGoodLinks = array();
-               $this->mBadLinks = array();
-               $this->mImageLinks = array();
-               $this->mOldGoodLinks = array();
-               $this->mOldBadLinks = array();
+
+       /**
+        * 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 {
@@ -40,56 +56,45 @@ class LinkCache {
                }
        }
 
-       function isBadLink( $title )
-       {
-               return array_key_exists( $title, $this->mBadLinks ); 
+       function isBadLink( $title ) {
+               return array_key_exists( $title, $this->mBadLinks );
        }
 
-       function addGoodLink( $id, $title )
-       {
-               if ( $this->mActive ) {
-                       $this->mGoodLinks[$title] = $id;
-               }
+       function addGoodLinkObj( $id, $title ) {
+               $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->isBadLink( $dbkey ) ) {
+                       $this->mBadLinks[$dbkey] = 1;
+                       $this->mPageLinks[$dbkey] = $title;
                }
        }
 
-       function addImageLink( $title )
-       {
-               if ( $this->mActive ) { $this->mImageLinks[$title] = 1; }
-       }
-
-       function addImageLinkObj( $nt )
-       {
-               if ( $this->mActive ) { $this->mImageLinks[$nt->getDBkey()] = 1; }
-       }
-
-       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 ) );
        }
 
-       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 addLink( $title )
-       {
+       /**
+        * Add a title to the link cache, return the page_id or zero if non-existent
+        * @param string $title Title to add
+        * @return integer
+        */
+       function addLink( $title ) {
                $nt = Title::newFromDBkey( $title );
                if( $nt ) {
                        return $this->addLinkObj( $nt );
@@ -97,204 +102,77 @@ class LinkCache {
                        return 0;
                }
        }
-       
-       function addLinkObj( &$nt )
-       {
+
+       /**
+        * Add a title to the link cache, return the page_id or zero if non-existent
+        * @param Title $nt Title to add
+        * @return integer
+        */
+       function addLinkObj( &$nt ) {
+               global $wgMemc, $wgLinkCacheMemcached, $wgAntiLockFlags;
                $title = $nt->getPrefixedDBkey();
-               if ( $this->isBadLink( $title ) ) { return 0; }         
+               if ( $this->isBadLink( $title ) ) { return 0; }
                $id = $this->getGoodLinkID( $title );
                if ( 0 != $id ) { return $id; }
 
-               global $wgMemc;
-               $fname = "LinkCache::addLinkObj";
+               $fname = 'LinkCache::addLinkObj';
+               global $wgProfiling, $wgProfiler;
+               if ( $wgProfiling && isset( $wgProfiler ) ) {
+                       $fname .= ' (' . $wgProfiler->getCurrentSection() . ')';
+               }
+
                wfProfileIn( $fname );
 
                $ns = $nt->getNamespace();
                $t = $nt->getDBkey();
 
-               if ( "" == $title ) { 
+               if ( '' == $title ) {
                        wfProfileOut( $fname );
-                       return 0; 
+                       return 0;
                }
-               
-               $id = FALSE;
+
+               $id = NULL;
                if( $wgLinkCacheMemcached )
                        $id = $wgMemc->get( $key = $this->getKey( $title ) );
-               if( $id === FALSE ) {
-                       $sql = "SELECT cur_id FROM cur WHERE cur_namespace=" .
-                         "{$ns} AND cur_title='" . wfStrencode( $t ) . "'";
-                       $res = wfQuery( $sql, DB_READ, "LinkCache::addLink" );
+               if( ! is_integer( $id ) ) {
+                       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();
+                       }
 
-                       if ( 0 == wfNumRows( $res ) ) {
+                       $id = $db->selectField( 'page', 'page_id',
+                                       array( 'page_namespace' => $ns, 'page_title' => $t ),
+                                       $fname, $options );
+                       if ( !$id ) {
                                $id = 0;
-                       } else {
-                               $s = wfFetchObject( $res );
-                               $id = $s->cur_id;
                        }
                        if( $wgLinkCacheMemcached )
-                               $wgMemc->add( $key, $id, time()+3600 );
+                               $wgMemc->add( $key, $id, 3600*24 );
                }
-               
-               if ( 0 == $id ) { $this->addBadLink( $title ); }
-               else { $this->addGoodLink( $id, $title ); }
-               wfProfileOut( $fname );
-               return $id;
-       }
-
-       function preFill( &$fromtitle )
-       {
-               global $wgEnablePersistentLC, $wgCompressedPersistentLC;
-
-               $fname = "LinkCache::preFill";
-               wfProfileIn( $fname );
-               # Note -- $fromtitle is a Title *object*
-               $dbkeyfrom = wfStrencode( $fromtitle->getPrefixedDBKey() );
-
-               if ( $wgEnablePersistentLC ) {
-                       $cc =& $this->getFromLinkscc( $dbkeyfrom );
-                       if( $cc != FALSE ){
-                               $this->mOldGoodLinks = $this->mGoodLinks = $cc->mGoodLinks;
-                               $this->mOldBadLinks = $this->mBadLinks = $cc->mBadLinks;
-                               $this->mPreFilled = true;
-                               wfProfileOut( $fname );
-                               wfDebug( "LinkCache::preFill - got from linkscc\n" );
-                               return;
-                       } 
-               }
-
 
-               $sql = "SELECT cur_id,cur_namespace,cur_title
-                       FROM cur,links
-                       WHERE cur_id=l_to AND l_from='{$dbkeyfrom}'";
-               $res = wfQuery( $sql, DB_READ, $fname );
-               while( $s = wfFetchObject( $res ) ) {
-                       $this->addGoodLink( $s->cur_id,
-                               Title::makeName( $s->cur_namespace, $s->cur_title )
-                               );
-               }
-               
-               $this->suspend();
-               $id = $fromtitle->getArticleID();
-               $this->resume();
-               
-               $sql = "SELECT bl_to
-                       FROM brokenlinks
-                       WHERE bl_from='{$id}'";
-               $res = wfQuery( $sql, DB_READ, "LinkCache::preFill" );
-               while( $s = wfFetchObject( $res ) ) {
-                       $this->addBadLink( $s->bl_to );
-               }
-               
-               $this->mOldBadLinks = $this->mBadLinks;
-               $this->mOldGoodLinks = $this->mGoodLinks;
-               $this->mPreFilled = true;
-
-               if ( $wgEnablePersistentLC ) {
-                       // put fetched link data into cache
-                       if( $wgCompressedPersistentLC and function_exists( "gzcompress" ) ) {
-                               $ser = wfStrencode( gzcompress( serialize( $this ), 3 ));
-                       } else {
-                               $ser = wfStrencode( serialize( $this ) );
-                       }
-                       wfQuery("REPLACE INTO linkscc VALUES({$id}, '{$dbkeyfrom}', '{$ser}')", 
-                               DB_WRITE);
-                               wfDebug( "LinkCache::preFill - saved to linkscc\n" );
+               if( 0 == $id ) {
+                       $this->addBadLinkObj( $nt );
+               } else {
+                       $this->addGoodLinkObj( $id, $nt );
                }
-
                wfProfileOut( $fname );
+               return $id;
        }
 
-       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 );
-       }
-
-       #     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;
-               }
-
-               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;           
-               }
-               
-               return true;
-       }
-
-       # Clears cache but leaves old preFill copies alone
-       function clear() 
-       {
+       /**
+        * Clears cache
+        */
+       function clear() {
+               $this->mPageLinks = array();
                $this->mGoodLinks = array();
                $this->mBadLinks = array();
-               $this->mImageLinks = array();
-       }
-
-
-       function &getFromLinkscc( $dbkeyfrom ){
-               $res = wfQuery("SELECT lcc_cacheobj FROM linkscc WHERE lcc_title = '{$dbkeyfrom}'", 
-                       DB_READ);
-               $row = wfFetchObject( $res );
-               if( $row == FALSE)
-                       return false;   
-
-               $cacheobj = false;
-               if( function_exists( "gzuncompress" ) )
-                       $cacheobj = @gzuncompress( $row->lcc_cacheobj );
-
-               if($cacheobj == FALSE){
-                       $cacheobj = $row->lcc_cacheobj;
-               }
-               $cc = @unserialize( $cacheobj );
-               if( isset( $cc->mClassVer ) and ($cc->mClassVer == $this->mClassVer ) ){
-                       return $cc;
-               } else {
-                       return FALSE;
-               }
        }
 }
 ?>