1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use Wikimedia\StaticArrayWriter;
/**
* Localisation cache storage based on PHP files and static arrays.
*
* @since 1.26
* @ingroup Language
*/
class LCStoreStaticArray implements LCStore {
/** @var string|null Current language code. */
private $currentLang = null;
/** @var array Localisation data. */
private $data = [];
/** @var string|null File name. */
private $fname = null;
/** @var string Directory for cache files. */
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 );
}
/**
* Determine whether this array contains only scalar values.
*
* @param array $arr
* @return bool
*/
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;
}
/**
* Encodes a value into an array format
*
* @param mixed $value
* @return array|mixed
* @throws RuntimeException
*/
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 ) );
}
/**
* Decode something that was encoded with 'encode'
*
* @param mixed $encoded
* @return array|mixed
* @throws RuntimeException
*/
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;
}
}
|
