GadgetDefinitionNamespaceRepo.php

Go to the documentation of this file.

<?php
 
use MediaWiki\Linker\LinkTarget;
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\Database;
 
class GadgetDefinitionNamespaceRepo extends GadgetRepo {
    const CACHE_TTL = 86400;
 
    private $wanCache;
 
    public function __construct() {
        $this->wanCache = MediaWikiServices::getInstance()->getMainWANObjectCache();
    }
 
    public function getGadgetIds() {
        $key = $this->getGadgetIdsKey();
 
        return $this->wanCache->getWithSetCallback(
            $key,
            self::CACHE_TTL,
            function ( $oldValue, &$ttl, array &$setOpts ) {
                $dbr = wfGetDB( DB_REPLICA );
                $setOpts += Database::getCacheSetOptions( $dbr );
 
                return $dbr->selectFieldValues(
                    'page',
                    'page_title',
                    [ 'page_namespace' => NS_GADGET_DEFINITION ],
                    __METHOD__
                );
            },
            [
                'checkKeys' => [ $key ],
                'pcTTL' => WANObjectCache::TTL_PROC_SHORT,
                'lockTSE' => 30
            ]
        );
    }
 
    public function handlePageUpdate( LinkTarget $target ) {
        if ( $target->inNamespace( NS_GADGET_DEFINITION ) ) {
            $this->purgeGadgetEntry( $target->getText() );
        }
    }
 
    public function handlePageCreation( LinkTarget $target ) {
        if ( $target->inNamespace( NS_GADGET_DEFINITION ) ) {
            $this->purgeGadgetIdsList();
        }
    }
 
    public function handlePageDeletion( LinkTarget $target ) {
        if ( $target->inNamespace( NS_GADGET_DEFINITION ) ) {
            $this->purgeGadgetIdsList();
            $this->purgeGadgetEntry( $target->getText() );
        }
    }
 
    public function purgeGadgetIdsList() {
        $this->wanCache->touchCheckKey( $this->getGadgetIdsKey() );
    }
 
    public function getGadget( $id ) {
        $key = $this->getGadgetCacheKey( $id );
        $gadget = $this->wanCache->getWithSetCallback(
            $key,
            self::CACHE_TTL,
            function ( $old, &$ttl, array &$setOpts ) use ( $id ) {
                $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
                $title = Title::makeTitleSafe( NS_GADGET_DEFINITION, $id );
                if ( !$title ) {
                    $ttl = WANObjectCache::TTL_UNCACHEABLE;
                    return null;
                }
 
                $rev = Revision::newFromTitle( $title );
                if ( !$rev ) {
                    $ttl = WANObjectCache::TTL_UNCACHEABLE;
                    return null;
                }
 
                $content = $rev->getContent();
                if ( !$content instanceof GadgetDefinitionContent ) {
                    // Uhm...
                    $ttl = WANObjectCache::TTL_UNCACHEABLE;
                    return null;
                }
 
                return Gadget::newFromDefinitionContent( $id, $content );
            },
            [
                'checkKeys' => [ $key ],
                'pcTTL' => WANObjectCache::TTL_PROC_SHORT,
                'lockTSE' => 30
            ]
        );
 
        if ( $gadget === null ) {
            throw new InvalidArgumentException( "No gadget registered for '$id'" );
        }
 
        return $gadget;
    }
 
    public function purgeGadgetEntry( $id ) {
        $this->wanCache->touchCheckKey( $this->getGadgetCacheKey( $id ) );
    }
 
    private function getGadgetIdsKey() {
        return $this->wanCache->makeKey( 'gadgets', 'namespace', 'ids' );
    }
 
    private function getGadgetCacheKey( $id ) {
        return $this->wanCache->makeKey(
            'gadgets', 'object', md5( $id ), Gadget::GADGET_CLASS_VERSION );
    }
}