-<?
-# Cache for article titles and ids linked from one source
-
+<?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
+ */
class LinkCache {
// Increment $mClassVer whenever old serialized versions of this class
// becomes incompatible with the new version.
- /* private */ var $mClassVer = 1;
+ /* private */ var $mClassVer = 2;
/* private */ var $mGoodLinks, $mBadLinks, $mActive;
- /* private */ var $mImageLinks;
+ /* 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->mGoodLinks = array();
$this->mBadLinks = array();
$this->mImageLinks = array();
+ $this->mCategoryLinks = array();
$this->mOldGoodLinks = array();
$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 {
}
}
- 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; }
}
+
+ function addCategoryLink( $title, $sortkey ) {
+ if ( $this->mActive ) { $this->mCategoryLinks[$title] = $sortkey; }
+ }
+
+ function addCategoryLinkObj( &$nt, $sortkey ) {
+ $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 ) );
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 );
}
}
- 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; }
- global $wgMemc;
- $fname = "LinkCache::addLinkObj";
+ $fname = 'LinkCache::addLinkObj';
wfProfileIn( $fname );
$ns = $nt->getNamespace();
$t = $nt->getDBkey();
- if ( "" == $title ) {
+ if ( '' == $title ) {
wfProfileOut( $fname );
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 );
+ $options = array( 'FOR UPDATE' );
+ } 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 ); }
return $id;
}
- function preFill( &$fromtitle )
- {
- global $wgEnablePersistentLC, $wgCompressedPersistentLC;
+ function preFill( &$fromtitle ) {
+ global $wgEnablePersistentLC;
- $fname = "LinkCache::preFill";
+ $fname = 'LinkCache::preFill';
wfProfileIn( $fname );
# Note -- $fromtitle is a Title *object*
- $dbkeyfrom = wfStrencode( $fromtitle->getPrefixedDBKey() );
+ $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 ) {
- $cc =& $this->getFromLinkscc( $dbkeyfrom );
- if( $cc != FALSE ){
- $this->mOldGoodLinks = $this->mGoodLinks = $cc->mGoodLinks;
- $this->mOldBadLinks = $this->mBadLinks = $cc->mBadLinks;
- $this->mPreFilled = true;
+ if( $this->fillFromLinkscc( $id ) ){
wfProfileOut( $fname );
- wfDebug( "LinkCache::preFill - got from linkscc\n" );
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 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 )
+ $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 )
);
}
- $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 ) ) {
+ $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->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" );
+ $this->saveToLinkscc( $id );
}
-
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;
}
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();
}
+ /**
+ * @access private
+ */
+ function fillFromLinkscc( $id ){
+ $fname = 'LinkCache::fillFromLinkscc';
- function &getFromLinkscc( $dbkeyfrom ){
- $res = wfQuery("SELECT lcc_cacheobj FROM linkscc WHERE lcc_title = '{$dbkeyfrom}'",
- DB_READ);
- $row = wfFetchObject( $res );
- if( $row == FALSE)
- return false;
-
+ $id = IntVal( $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" ) )
- $cacheobj = @gzuncompress( $row->lcc_cacheobj );
+ if( function_exists( 'gzuncompress' ) )
+ $cacheobj = @gzuncompress( $raw );
if($cacheobj == FALSE){
- $cacheobj = $row->lcc_cacheobj;
+ $cacheobj = $raw;
}
$cc = @unserialize( $cacheobj );
if( isset( $cc->mClassVer ) and ($cc->mClassVer == $this->mClassVer ) ){
- return $cc;
+ $this->mOldGoodLinks = $this->mGoodLinks = $cc->mGoodLinks;
+ $this->mOldBadLinks = $this->mBadLinks = $cc->mBadLinks;
+ $this->mPreFilled = true;
+ return TRUE;
} else {
return FALSE;
}
+
+ }
+
+ /**
+ * @access private
+ */
+ function saveToLinkscc( $pid ){
+ global $wgCompressedPersistentLC;
+ if( $wgCompressedPersistentLC and function_exists( 'gzcompress' ) ) {
+ $ser = gzcompress( serialize( $this ), 3 );
+ } 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);
+ }
+
+ }
+
+ /**
+ * 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 );
+ }
+ }
+
+ /**
+ * @param $pid is a page id
+ * @static
+ */
+ function linksccClearPage( $pid ){
+ global $wgEnablePersistentLC;
+ if ( $wgEnablePersistentLC ) {
+ $pid = intval( $pid );
+ $dbw =& wfGetDB( DB_MASTER );
+ $dbw->delete( 'linkscc', array( 'lcc_pageid' => $pid ) );
+ }
}
}
?>