FileBasedMessageGroupLoader.php

Go to the documentation of this file.

<?php
use MediaWiki\Extension\Translate\MessageGroupConfiguration\MessageGroupConfigurationParser;
use MediaWiki\MediaWikiServices;
 
class FileBasedMessageGroupLoader extends MessageGroupLoader
    implements CachedMessageGroupLoader {
 
    private const CACHE_KEY = 'filebased';
    private const CACHE_VERSION = 2;
 
    protected $groups;
    protected $cache;
 
    public function __construct( MessageGroupWANCache $cache ) {
        $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();
            $cacheData = $wrapper->getValue();
            $this->initFromCacheValue( $cacheData );
        }
 
        return $this->groups;
    }
 
    public static function registerLoader( array &$groupLoader, array $deps ) {
        $groupLoader[] = self::getInstance(
            $deps['cache']
        );
    }
 
    public static function getInstance( WANObjectCache $cache = null ) {
        return new self(
            new MessageGroupWANCache(
                $cache ?? MediaWikiServices::getInstance()->getMainWANObjectCache()
            )
        );
    }
 
    public function getCacheData() {
        global $wgTranslateGroupFiles;
 
        $autoload = $groups = $deps = $value = [];
        $deps[] = new GlobalDependency( 'wgTranslateGroupFiles' );
 
        // TODO: See if DI can be used here
        $parser = new MessageGroupConfigurationParser();
        foreach ( $wgTranslateGroupFiles as $configFile ) {
            $deps[] = new FileDependency( realpath( $configFile ) );
 
            $yaml = file_get_contents( $configFile );
            $fgroups = $parser->getHopefullyValidConfigurations(
                $yaml,
                static function ( $index, $config, $errmsg ) use ( $configFile ) {
                    trigger_error( "Document $index in $configFile is invalid: $errmsg", E_USER_WARNING );
                }
            );
 
            foreach ( $fgroups as $id => $conf ) {
                if ( !empty( $conf['AUTOLOAD'] ) && is_array( $conf['AUTOLOAD'] ) ) {
                    $dir = dirname( $configFile );
                    $additions = array_map( static function ( $file ) use ( $dir ) {
                        return "$dir/$file";
                    }, $conf['AUTOLOAD'] );
                    self::appendAutoloader( $additions, $autoload );
                }
 
                $groups[$id] = $conf;
            }
        }
        $value['groups'] = $groups;
        $value['autoload'] = $autoload;
 
        $wrapper = new DependencyWrapper( $value, $deps );
        $wrapper->initialiseDeps();
        return $wrapper;
    }
 
    public function recache() {
        $this->clearProcessCache();
        $this->cache->touchKey();
 
        $wrapper = $this->cache->getValue( 'recache' );
        $cacheData = $wrapper->getValue();
        $this->initFromCacheValue( $cacheData );
    }
 
    public function clearCache() {
        $this->clearProcessCache();
        $this->cache->delete();
    }
 
    protected function clearProcessCache() {
        $this->groups = null;
    }
 
    protected function initFromCacheValue( array $cacheData ) {
        global $wgAutoloadClasses;
        $this->groups = [];
 
        $autoload = $cacheData['autoload'];
        $groupConfs = $cacheData['groups'];
 
        foreach ( $groupConfs as $id => $conf ) {
            $this->groups[$id] = MessageGroupBase::factory( $conf );
        }
 
        self::appendAutoloader( $autoload, $wgAutoloadClasses );
    }
 
    private static function appendAutoloader( array $additions, array &$to ) {
        foreach ( $additions as $class => $file ) {
            if ( isset( $to[$class] ) && $to[$class] !== $file ) {
                $msg = "Autoload conflict for $class: {$to[$class]} !== $file";
                trigger_error( $msg, E_USER_WARNING );
                continue;
            }
 
            $to[$class] = $file;
        }
    }
}