AggregateMessageGroupLoader.php

Go to the documentation of this file.

<?php
use MediaWiki\Extension\Translate\Utilities\Utilities;
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IDatabase;
 
class AggregateMessageGroupLoader extends MessageGroupLoader
    implements CachedMessageGroupLoader {
 
    private const CACHE_KEY = 'aggregate';
    private const CACHE_VERSION = 2;
 
    protected $cache;
    protected $db;
    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' ],
            ]
        );
    }
 
    public function getGroups() {
        if ( $this->groups === null ) {
            $this->groups = $this->initGroupsFromConf( $this->cache->getValue() );
        }
 
        return $this->groups;
    }
 
    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()
            )
        );
    }
 
    public function getCacheData(): array {
        $groupIds = TranslateMetadata::getGroupsWithSubgroups();
        TranslateMetadata::preloadGroups( $groupIds, __METHOD__ );
 
        $groups = [];
        foreach ( $groupIds as $id ) {
            $conf = [];
            $conf['BASIC'] = [
                'id' => $id,
                'label' => TranslateMetadata::get( $id, 'name' ),
                'description' => TranslateMetadata::get( $id, 'description' ),
                'meta' => 1,
                'class' => AggregateMessageGroup::class,
                'namespace' => NS_TRANSLATIONS,
            ];
            $sourcelanguage = TranslateMetadata::get( $id, 'sourcelanguagecode' );
            if ( $sourcelanguage ) {
                $conf['BASIC']['sourcelanguage'] = $sourcelanguage;
            }
            $conf['GROUPS'] = TranslateMetadata::getSubgroups( $id );
            $groups[$id] = $conf;
        }
 
        return $groups;
    }
 
    public function loadAggregateGroups(): array {
        // get the data from the database everytime
        // @phan-suppress-next-line PhanTypeMismatchReturn type is guaranteed via getCacheData above
        return $this->initGroupsFromConf( $this->getCacheData() );
    }
 
    protected function initGroupsFromConf( array $groups ): array {
        return array_map( [ MessageGroupBase::class, 'factory' ], $groups );
    }
 
    public function recache() {
        $this->clearProcessCache();
        $this->cache->touchKey();
 
        $cacheData = $this->cache->getValue( 'recache' );
        $this->groups = $this->initGroupsFromConf( $cacheData );
    }
 
    public function clearCache() {
        $this->clearProcessCache();
        $this->cache->delete();
    }
 
    protected function clearProcessCache() {
        $this->groups = null;
    }
}