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 use Wikimedia\StaticArrayWriter;
  24
  25 /**
  26  * @since 1.26
  27  */
  28 class LCStoreStaticArray implements LCStore {
  29         /** @var string|null Current language code. */
  30         private $currentLang = null;
  31
  32         /** @var array Localisation data. */
  33         private $data = [];
  34
  35         /** @var string File name. */
  36         private $fname = null;
  37
  38         /** @var string Directory for cache files. */
  39         private $directory;
  40
  41         public function __construct( $conf = [] ) {
  42                 global $wgCacheDirectory;
  43
  44                 $this->directory = $conf['directory'] ?? $wgCacheDirectory;
  45         }
  46
  47         public function startWrite( $code ) {
  48                 if ( !file_exists( $this->directory ) ) {
  49                         if ( !wfMkdirParents( $this->directory, null, __METHOD__ ) ) {
  50                                 throw new MWException( "Unable to create the localisation store " .
  51                                         "directory \"{$this->directory}\"" );
  52                         }
  53                 }
  54
  55                 $this->currentLang = $code;
  56                 $this->fname = $this->directory . '/' . $code . '.l10n.php';
  57                 $this->data[$code] = [];
  58                 if ( file_exists( $this->fname ) ) {
  59                         $this->data[$code] = require $this->fname;
  60                 }
  61         }
  62
  63         public function set( $key, $value ) {
  64                 $this->data[$this->currentLang][$key] = self::encode( $value );
  65         }
  66
  67         /**
  68          * Encodes a value into an array format
  69          *
  70          * @param mixed $value
  71          * @return array|mixed
  72          * @throws RuntimeException
  73          */
  74         public static function encode( $value ) {
  75                 if ( is_array( $value ) ) {
  76                         // [a]rray
  77                         return [ 'a', array_map( 'LCStoreStaticArray::encode', $value ) ];
  78                 }
  79                 if ( is_object( $value ) ) {
  80                         // [s]erialized
  81                         return [ 's', serialize( $value ) ];
  82                 }
  83                 if ( is_scalar( $value ) || $value === null ) {
  84                         // Scalar value, written directly without array
  85                         return $value;
  86                 }
  87
  88                 throw new RuntimeException( 'Cannot encode ' . var_export( $value, true ) );
  89         }
  90
  91         /**
  92          * Decode something that was encoded with encode
  93          *
  94          * @param mixed $encoded
  95          * @return array|mixed
  96          * @throws RuntimeException
  97          */
  98         public static function decode( $encoded ) {
  99                 if ( !is_array( $encoded ) ) {
 100                         // Scalar values are written directly without array
 101                         return $encoded;
 102                 }
 103
 104                 list( $type, $data ) = $encoded;
 105
 106                 switch ( $type ) {
 107                         case 'a':
 108                                 return array_map( 'LCStoreStaticArray::decode', $data );
 109                         case 's':
 110                                 return unserialize( $data );
 111                         case 'v':
 112                                 // Support: MediaWiki 1.32 and earlier
 113                                 // Backward compatibility with older file format
 114                                 return $data;
 115                         default:
 116                                 throw new RuntimeException(
 117                                         'Unable to decode ' . var_export( $encoded, true ) );
 118                 }
 119         }
 120
 121         public function finishWrite() {
 122                 $writer = new StaticArrayWriter();
 123                 $out = $writer->create(
 124                         $this->data[$this->currentLang],
 125                         'Generated by LCStoreStaticArray.php -- do not edit!'
 126                 );
 127                 file_put_contents( $this->fname, $out );
 128                 $this->currentLang = null;
 129                 $this->fname = null;
 130         }
 131
 132         public function get( $code, $key ) {
 133                 if ( !array_key_exists( $code, $this->data ) ) {
 134                         $fname = $this->directory . '/' . $code . '.l10n.php';
 135                         if ( !file_exists( $fname ) ) {
 136                                 return null;
 137                         }
 138                         $this->data[$code] = require $fname;
 139                 }
 140                 $data = $this->data[$code];
 141                 if ( array_key_exists( $key, $data ) ) {
 142                         return self::decode( $data[$key] );
 143                 }
 144                 return null;
 145         }
 146 }