* @file
* @ingroup Cache
*/
+use MediaWiki\Linker\LinkTarget;
+use MediaWiki\MediaWikiServices;
/**
* Cache for article titles (prefixed DB keys) and ids linked from one source
* @ingroup Cache
*/
class LinkCache {
- /**
- * @var HashBagOStuff
- */
+ /** @var HashBagOStuff */
private $mGoodLinks;
- /**
- * @var HashBagOStuff
- */
+ /** @var HashBagOStuff */
private $mBadLinks;
+ /** @var WANObjectCache */
+ private $wanCache;
+
+ /** @var bool */
private $mForUpdate = false;
+ /** @var TitleFormatter */
+ private $titleFormatter;
+
/**
* How many Titles to store. There are two caches, so the amount actually
* stored in memory can be up to twice this.
*/
const MAX_SIZE = 10000;
- /**
- * @var LinkCache
- */
- protected static $instance;
-
- public function __construct() {
+ public function __construct( TitleFormatter $titleFormatter, WANObjectCache $cache ) {
$this->mGoodLinks = new HashBagOStuff( [ 'maxKeys' => self::MAX_SIZE ] );
$this->mBadLinks = new HashBagOStuff( [ 'maxKeys' => self::MAX_SIZE ] );
+ $this->wanCache = $cache;
+ $this->titleFormatter = $titleFormatter;
}
/**
* Get an instance of this class.
*
* @return LinkCache
+ * @deprecated since 1.28, use MediaWikiServices instead
*/
public static function singleton() {
- if ( !self::$instance ) {
- self::$instance = new LinkCache;
- }
-
- return self::$instance;
- }
-
- /**
- * Destroy the singleton instance
- *
- * A new one will be created next time singleton() is called.
- *
- * @since 1.22
- */
- public static function destroySingleton() {
- self::$instance = null;
- }
-
- /**
- * Set the singleton instance to a given object.
- *
- * Since we do not have an interface for LinkCache, you have to be sure the
- * given object implements all the LinkCache public methods.
- *
- * @param LinkCache $instance
- * @since 1.22
- */
- public static function setSingleton( LinkCache $instance ) {
- self::$instance = $instance;
+ return MediaWikiServices::getInstance()->getLinkCache();
}
/**
/**
* Get a field of a title object from cache.
* If this link is not a cached good title, it will return NULL.
- * @param Title $title
+ * @param LinkTarget $target
* @param string $field ('length','redirect','revision','model')
* @return string|int|null
*/
- public function getGoodLinkFieldObj( Title $title, $field ) {
- $dbkey = $title->getPrefixedDBkey();
+ public function getGoodLinkFieldObj( LinkTarget $target, $field ) {
+ $dbkey = $this->titleFormatter->getPrefixedDBkey( $target );
$info = $this->mGoodLinks->get( $dbkey );
if ( !$info ) {
return null;
* Add a link for the title to the link cache
*
* @param int $id Page's ID
- * @param Title $title
+ * @param LinkTarget $target
* @param int $len Text's length
* @param int $redir Whether the page is a redirect
* @param int $revision Latest revision's ID
* @param string|null $model Latest revision's content model ID
* @param string|null $lang Language code of the page, if not the content language
*/
- public function addGoodLinkObj( $id, Title $title, $len = -1, $redir = null,
+ public function addGoodLinkObj( $id, LinkTarget $target, $len = -1, $redir = null,
$revision = 0, $model = null, $lang = null
) {
- $dbkey = $title->getPrefixedDBkey();
+ $dbkey = $this->titleFormatter->getPrefixedDBkey( $target );
$this->mGoodLinks->set( $dbkey, [
'id' => (int)$id,
'length' => (int)$len,
/**
* Same as above with better interface.
* @since 1.19
- * @param Title $title
+ * @param LinkTarget $target
* @param stdClass $row Object which has the fields page_id, page_is_redirect,
* page_latest and page_content_model
*/
- public function addGoodLinkObjFromRow( Title $title, $row ) {
- $dbkey = $title->getPrefixedDBkey();
+ public function addGoodLinkObjFromRow( LinkTarget $target, $row ) {
+ $dbkey = $this->titleFormatter->getPrefixedDBkey( $target );
$this->mGoodLinks->set( $dbkey, [
'id' => intval( $row->page_id ),
'length' => intval( $row->page_len ),
}
/**
- * @param Title $title
+ * @param LinkTarget $target
*/
- public function addBadLinkObj( Title $title ) {
- $dbkey = $title->getPrefixedDBkey();
+ public function addBadLinkObj( LinkTarget $target ) {
+ $dbkey = $this->titleFormatter->getPrefixedDBkey( $target );
if ( !$this->isBadLink( $dbkey ) ) {
$this->mBadLinks->set( $dbkey, 1 );
}
}
/**
- * @param Title $title
+ * @param LinkTarget $target
*/
- public function clearLink( Title $title ) {
- $dbkey = $title->getPrefixedDBkey();
+ public function clearLink( LinkTarget $target ) {
+ $dbkey = $this->titleFormatter->getPrefixedDBkey( $target );
$this->mBadLinks->delete( $dbkey );
$this->mGoodLinks->delete( $dbkey );
}
/**
* Add a title to the link cache, return the page_id or zero if non-existent
*
+ * @deprecated since 1.27, unused
* @param string $title Prefixed DB key
* @return int Page ID or zero
*/
}
/**
- * Add a title to the link cache, return the page_id or zero if non-existent
+ * Fields that LinkCache needs to select
*
- * @param Title $nt Title object to add
- * @return int Page ID or zero
+ * @since 1.28
+ * @return array
*/
- public function addLinkObj( Title $nt ) {
+ public static function getSelectFields() {
global $wgContentHandlerUseDB, $wgPageLanguageUseDB;
- $key = $nt->getPrefixedDBkey();
- if ( $this->isBadLink( $key ) || $nt->isExternal() ) {
+ $fields = [ 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ];
+ if ( $wgContentHandlerUseDB ) {
+ $fields[] = 'page_content_model';
+ }
+ if ( $wgPageLanguageUseDB ) {
+ $fields[] = 'page_lang';
+ }
+
+ return $fields;
+ }
+
+ /**
+ * Add a title to the link cache, return the page_id or zero if non-existent
+ *
+ * @param LinkTarget $nt LinkTarget object to add
+ * @return int Page ID or zero
+ */
+ public function addLinkObj( LinkTarget $nt ) {
+ $key = $this->titleFormatter->getPrefixedDBkey( $nt );
+ if ( $this->isBadLink( $key ) || $nt->isExternal()
+ || $nt->inNamespace( NS_SPECIAL )
+ ) {
return 0;
}
$id = $this->getGoodLinkID( $key );
return 0;
}
- // Some fields heavily used for linking...
- $db = $this->mForUpdate ? wfGetDB( DB_MASTER ) : wfGetDB( DB_SLAVE );
+ // Cache template/file pages as they are less often viewed but heavily used
+ if ( $this->mForUpdate ) {
+ $row = $this->fetchPageRow( wfGetDB( DB_MASTER ), $nt );
+ } elseif ( $this->isCacheable( $nt ) ) {
+ // These pages are often transcluded heavily, so cache them
+ $cache = $this->wanCache;
+ $row = $cache->getWithSetCallback(
+ $cache->makeKey( 'page', $nt->getNamespace(), sha1( $nt->getDBkey() ) ),
+ $cache::TTL_DAY,
+ function ( $curValue, &$ttl, array &$setOpts ) use ( $cache, $nt ) {
+ $dbr = wfGetDB( DB_REPLICA );
+ $setOpts += Database::getCacheSetOptions( $dbr );
- $fields = [ 'page_id', 'page_len', 'page_is_redirect', 'page_latest' ];
- if ( $wgContentHandlerUseDB ) {
- $fields[] = 'page_content_model';
- }
- if ( $wgPageLanguageUseDB ) {
- $fields[] = 'page_lang';
- }
+ $row = $this->fetchPageRow( $dbr, $nt );
+ $mtime = $row ? wfTimestamp( TS_UNIX, $row->page_touched ) : false;
+ $ttl = $cache->adaptiveTTL( $mtime, $ttl );
- $row = $db->selectRow( 'page', $fields,
- [ 'page_namespace' => $nt->getNamespace(), 'page_title' => $nt->getDBkey() ],
- __METHOD__
- );
+ return $row;
+ }
+ );
+ } else {
+ $row = $this->fetchPageRow( wfGetDB( DB_REPLICA ), $nt );
+ }
- if ( $row !== false ) {
+ if ( $row ) {
$this->addGoodLinkObjFromRow( $nt, $row );
$id = intval( $row->page_id );
} else {
return $id;
}
+ private function isCacheable( LinkTarget $title ) {
+ return ( $title->inNamespace( NS_TEMPLATE ) || $title->inNamespace( NS_FILE ) );
+ }
+
+ private function fetchPageRow( IDatabase $db, LinkTarget $nt ) {
+ $fields = self::getSelectFields();
+ if ( $this->isCacheable( $nt ) ) {
+ $fields[] = 'page_touched';
+ }
+
+ return $db->selectRow(
+ 'page',
+ $fields,
+ [ 'page_namespace' => $nt->getNamespace(), 'page_title' => $nt->getDBkey() ],
+ __METHOD__
+ );
+ }
+
+ /**
+ * Purge the link cache for a title
+ *
+ * @param LinkTarget $title
+ * @since 1.28
+ */
+ public function invalidateTitle( LinkTarget $title ) {
+ if ( $this->isCacheable( $title ) ) {
+ $cache = ObjectCache::getMainWANInstance();
+ $cache->delete(
+ $cache->makeKey( 'page', $title->getNamespace(), sha1( $title->getDBkey() ) )
+ );
+ }
+ }
+
/**
* Clears cache
*/