LCStoreStaticArray.php

Go to the documentation of this file.

<?php
use Wikimedia\StaticArrayWriter;
 
class LCStoreStaticArray implements LCStore {
    private $currentLang = null;
 
    private $data = [];
 
    private $fname = null;
 
    private $directory;
 
    public function __construct( $conf = [] ) {
        $this->directory = $conf['directory'];
    }
 
    public function startWrite( $code ) {
        if ( !is_dir( $this->directory ) && !wfMkdirParents( $this->directory, null, __METHOD__ ) ) {
            throw new MWException( "Unable to create the localisation store " .
                "directory \"{$this->directory}\"" );
        }
 
        $this->currentLang = $code;
        $this->fname = $this->directory . '/' . $code . '.l10n.php';
        $this->data[$code] = [];
        if ( is_file( $this->fname ) ) {
            $this->data[$code] = require $this->fname;
        }
    }
 
    public function set( $key, $value ) {
        $this->data[$this->currentLang][$key] = self::encode( $value );
    }
 
    private static function isValueArray( array $arr ) {
        foreach ( $arr as $value ) {
            if ( is_scalar( $value )
                || $value === null
                || ( is_array( $value ) && self::isValueArray( $value ) )
            ) {
                continue;
            }
            return false;
        }
        return true;
    }
 
    public static function encode( $value ) {
        if ( is_array( $value ) && self::isValueArray( $value ) ) {
            // Type: scalar [v]alue.
            // Optimization: Write large arrays as one value to avoid recursive decoding cost.
            return [ 'v', $value ];
        }
        if ( is_array( $value ) || is_object( $value ) ) {
            // Type: [s]serialized.
            // Optimization: Avoid recursive decoding cost. Write arrays with an objects
            // as one serialised value.
            return [ 's', serialize( $value ) ];
        }
        if ( is_scalar( $value ) || $value === null ) {
            // Optimization: Reduce file size by not wrapping scalar values.
            return $value;
        }
 
        throw new RuntimeException( 'Cannot encode ' . var_export( $value, true ) );
    }
 
    public static function decode( $encoded ) {
        if ( !is_array( $encoded ) ) {
            // Unwrapped scalar value
            return $encoded;
        }
 
        [ $type, $data ] = $encoded;
 
        switch ( $type ) {
            case 'v':
                // Value array (1.35+) or unwrapped scalar value (1.32 and earlier)
                return $data;
            case 's':
                return unserialize( $data );
            case 'a':
                // Support: MediaWiki 1.34 and earlier (older file format)
                return array_map( [ __CLASS__, 'decode' ], $data );
            default:
                throw new RuntimeException(
                    'Unable to decode ' . var_export( $encoded, true ) );
        }
    }
 
    public function finishWrite() {
        $writer = new StaticArrayWriter();
        $out = $writer->create(
            $this->data[$this->currentLang],
            'Generated by LCStoreStaticArray.php -- do not edit!'
        );
        // Don't just write to the file, since concurrent requests may see a partial file (T304515).
        // Write to a file in the same filesystem so that it can be atomically moved.
        $tmpFileName = "{$this->fname}.tmp." . getmypid() . '.' . mt_rand();
        file_put_contents( $tmpFileName, $out );
        rename( $tmpFileName, $this->fname );
        // Release the data to manage the memory in rebuildLocalisationCache
        unset( $this->data[$this->currentLang] );
        $this->currentLang = null;
        $this->fname = null;
    }
 
    public function get( $code, $key ) {
        if ( !array_key_exists( $code, $this->data ) ) {
            $fname = $this->directory . '/' . $code . '.l10n.php';
            if ( !is_file( $fname ) ) {
                return null;
            }
            $this->data[$code] = require $fname;
        }
        $data = $this->data[$code];
        if ( array_key_exists( $key, $data ) ) {
            return self::decode( $data[$key] );
        }
        return null;
    }
}