includes/cache/localisation/LCStoreStaticArray.php

   1 <?php
   2 /**
   3  *  Localisation cache storage based on PHP files and static arrays.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * @since 1.26
  25  */
  26 class LCStoreStaticArray implements LCStore {
  27         /** @var string|null Current language code. */
  28         private $currentLang = null;
  29
  30         /** @var array Localisation data. */
  31         private $data = [];
  32
  33         /** @var string File name. */
  34         private $fname = null;
  35
  36         /** @var string Directory for cache files. */
  37         private $directory;
  38
  39         public function __construct( $conf = [] ) {
  40                 global $wgCacheDirectory;
  41
  42                 if ( isset( $conf['directory'] ) ) {
  43                         $this->directory = $conf['directory'];
  44                 } else {
  45                         $this->directory = $wgCacheDirectory;
  46                 }
  47         }
  48
  49         public function startWrite( $code ) {
  50                 $this->currentLang = $code;
  51                 $this->fname = $this->directory . '/' . $code . '.l10n.php';
  52                 $this->data[$code] = [];
  53                 if ( file_exists( $this->fname ) ) {
  54                         $this->data[$code] = require $this->fname;
  55                 }
  56         }
  57
  58         public function set( $key, $value ) {
  59                 $this->data[$this->currentLang][$key] = self::encode( $value );
  60         }
  61
  62         /**
  63          * Encodes a value into an array format
  64          *
  65          * @param mixed $value
  66          * @return array
  67          * @throws RuntimeException
  68          */
  69         public static function encode( $value ) {
  70                 if ( is_scalar( $value ) || $value === null ) {
  71                         // [V]alue
  72                         return [ 'v', $value ];
  73                 }
  74                 if ( is_object( $value ) ) {
  75                         // [S]erialized
  76                         return [ 's', serialize( $value ) ];
  77                 }
  78                 if ( is_array( $value ) ) {
  79                         // [A]rray
  80                         return [ 'a', array_map( function ( $v ) {
  81                                 return LCStoreStaticArray::encode( $v );
  82                         }, $value ) ];
  83                 }
  84
  85                 throw new RuntimeException( 'Cannot encode ' . var_export( $value, true ) );
  86         }
  87
  88         /**
  89          * Decode something that was encoded with encode
  90          *
  91          * @param array $encoded
  92          * @return array|mixed
  93          * @throws RuntimeException
  94          */
  95         public static function decode( array $encoded ) {
  96                 $type = $encoded[0];
  97                 $data = $encoded[1];
  98
  99                 switch ( $type ) {
 100                 case 'v':
 101                         return $data;
 102                 case 's':
 103                         return unserialize( $data );
 104                 case 'a':
 105                         return array_map( function ( $v ) {
 106                                 return LCStoreStaticArray::decode( $v );
 107                         }, $data );
 108                 default:
 109                         throw new RuntimeException(
 110                                 'Unable to decode ' . var_export( $encoded, true ) );
 111                 }
 112         }
 113
 114         public function finishWrite() {
 115                 file_put_contents(
 116                         $this->fname,
 117                         "<?php\n" .
 118                         "// Generated by LCStoreStaticArray.php -- do not edit!\n" .
 119                         "return " .
 120                         var_export( $this->data[$this->currentLang], true ) . ';'
 121                 );
 122                 $this->currentLang = null;
 123                 $this->fname = null;
 124         }
 125
 126         public function get( $code, $key ) {
 127                 if ( !array_key_exists( $code, $this->data ) ) {
 128                         $fname = $this->directory . '/' . $code . '.l10n.php';
 129                         if ( !file_exists( $fname ) ) {
 130                                 return null;
 131                         }
 132                         $this->data[$code] = require $fname;
 133                 }
 134                 $data = $this->data[$code];
 135                 if ( array_key_exists( $key, $data ) ) {
 136                         return self::decode( $data[$key] );
 137                 }
 138                 return null;
 139         }
 140 }