TranslatablePageMessageGroupStore.php

Go to the documentation of this file.

<?php
use MediaWiki\Extension\Translate\MessageGroupProcessing\RevTagStore;
use MediaWiki\Extension\Translate\PageTranslation\TranslatablePage;
use MediaWiki\Extension\Translate\Utilities\Utilities;
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IDatabase;
 
class TranslatablePageMessageGroupStore extends MessageGroupLoader
    implements CachedMessageGroupLoader
{
 
    private const CACHE_KEY = 'wikipage';
    private const CACHE_VERSION = 2;
 
    protected $db;
    protected $cache;
    protected $groups;
 
    public function __construct( IDatabase $db, MessageGroupWANCache $cache ) {
        $this->db = $db;
        $this->cache = $cache;
        $this->cache->configure(
            [
                'key' => self::CACHE_KEY,
                'version' => self::CACHE_VERSION,
                'regenerator' => [ $this, 'getCacheData' ],
                'touchedCallback' => [ $this, 'isExpired' ]
            ]
        );
    }
 
    public function getGroups() {
        if ( $this->groups === null ) {
            $wrapper = $this->cache->getValue();
            $this->groups = $this->initGroupsFromTitle( $wrapper->getValue() );
        }
 
        return $this->groups;
    }
 
    public function recache() {
        $this->clearProcessCache();
        $this->cache->touchKey();
 
        $wrapper = $this->cache->getValue( 'recache' );
        $this->groups = $this->initGroupsFromTitle( $wrapper->getValue() );
    }
 
    public function clearCache() {
        $this->clearProcessCache();
        $this->cache->delete();
    }
 
    protected function clearProcessCache() {
        $this->groups = null;
    }
 
    public function getCacheData() {
        global $wgEnablePageTranslation;
 
        $groupTitles = $deps = [];
        $deps = new GlobalDependency( 'wgEnablePageTranslation' );
 
        if ( $wgEnablePageTranslation ) {
            $groupTitles = $this->getTranslatablePageTitles();
        }
 
        $wrapper = new DependencyWrapper( $groupTitles, $deps );
        $wrapper->initialiseDeps();
        return $wrapper;
    }
 
    public static function registerLoader( array &$groupLoader, array $deps ) {
        $groupLoader[] = self::getInstance(
            $deps['database'],
            $deps['cache']
        );
    }
 
    public static function getInstance( IDatabase $db = null, WANObjectCache $cache = null ) {
        return new self(
            $db ?? Utilities::getSafeReadDB(),
            new MessageGroupWANCache(
                $cache ?? MediaWikiServices::getInstance()->getMainWANObjectCache()
            )
        );
    }
 
    protected function getTranslatablePageTitles() {
        $groupTitles = [];
        $tables = [ 'page', 'revtag' ];
        $vars = [ 'page_id', 'page_namespace', 'page_title' ];
        $conds = [ 'page_id=rt_page', 'rt_type' => RevTagStore::TP_MARK_TAG ];
        $options = [ 'GROUP BY' => 'rt_page,page_id,page_namespace,page_title' ];
        $res = $this->db->select( $tables, $vars, $conds, __METHOD__, $options );
 
        foreach ( $res as $r ) {
            $title = Title::newFromRow( $r );
            $groupTitles[] = $title->getPrefixedText();
        }
 
        return $groupTitles;
    }
 
    protected function initGroupsFromTitle( $titles ) {
        $groups = [];
        foreach ( $titles as $title ) {
            $title = Title::newFromText( $title );
            $id = TranslatablePage::getMessageGroupIdFromTitle( $title );
            $groups[$id] = new WikiPageMessageGroup( $id, $title );
        }
 
        return $groups;
    }
}