MessageChangeStorage.php

Go to the documentation of this file.

<?php
use MediaWiki\Extension\Translate\MessageSync\MessageSourceChange;
 
class MessageChangeStorage {
    public const DEFAULT_NAME = 'default';
 
    public static function writeChanges( array $changes, $file ) {
        $cache = \Cdb\Writer::open( $file );
        $keys = array_keys( $changes );
        $cache->set( '#keys', TranslateUtils::serialize( $keys ) );
 
        foreach ( $changes as $key => $change ) {
            $value = TranslateUtils::serialize( $change->getAllModifications() );
            $cache->set( $key, $value );
        }
        $cache->close();
    }
 
    public static function isValidCdbName( $name ) {
        return preg_match( '/^[a-z_-]{1,100}$/i', $name );
    }
 
    public static function getCdbPath( $name ) {
        return TranslateUtils::cacheFile( "messagechanges.$name.cdb" );
    }
 
    public static function getGroupChanges( $cdbPath, $groupId ) {
        $reader = self::getCdbReader( $cdbPath );
        if ( $reader === null ) {
            return MessageSourceChange::loadModifications( [] );
        }
 
        $groups = TranslateUtils::deserialize( $reader->get( '#keys' ) );
 
        if ( !in_array( $groupId, $groups, true ) ) {
            throw new InvalidArgumentException( "Group Id - '$groupId' not found in cdb file " .
                "(path: $cdbPath)." );
        }
 
        return MessageSourceChange::loadModifications(
            TranslateUtils::deserialize( $reader->get( $groupId ) )
        );
    }
 
    public static function writeGroupChanges( MessageSourceChange $changes, $groupId, $cdbPath ) {
        $reader = self::getCdbReader( $cdbPath );
        if ( $reader === null ) {
            return;
        }
 
        $groups = TranslateUtils::deserialize( $reader->get( '#keys' ) );
 
        $allChanges = [];
        foreach ( $groups as $id ) {
            $allChanges[$id] = MessageSourceChange::loadModifications(
                TranslateUtils::deserialize( $reader->get( $id ) )
            );
        }
        $allChanges[$groupId] = $changes;
 
        self::writeChanges( $allChanges, $cdbPath );
    }
 
    private static function getCdbReader( $cdbPath ) {
        // File not found, probably no changes.
        if ( !file_exists( $cdbPath ) ) {
            return null;
        }
 
        return \Cdb\Reader::open( $cdbPath );
    }
 
    public static function getLastModifiedTime( $cdbPath ) {
        // File not found
        if ( !file_exists( $cdbPath ) ) {
            return null;
        }
 
        $stat = stat( $cdbPath );
 
        return $stat['mtime'];
    }
 
    public static function isModifiedSince( $cdbPath, $time ) {
        $lastModifiedTime = self::getLastModifiedTime( $cdbPath );
 
        if ( $lastModifiedTime === null ) {
            throw new InvalidArgumentException( "CDB file not found - $cdbPath" );
        }
 
        return $lastModifiedTime <= $time;
    }
}