Repository navigation
Expand file tree
/
Copy pathLocalizationModel.php
More file actions
437 lines (337 loc) · 13.2 KB
/
Copy pathLocalizationModel.php
File metadata and controls
437 lines (337 loc) · 13.2 KB
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
<?php namespace RainLab\Builder\Classes;
use ApplicationException;
use Symfony\Component\Yaml\Dumper as YamlDumper;
use SystemException;
use DirectoryIterator;
use ValidationException;
use Yaml;
use Exception;
use Config;
use Lang;
use File;
/**
* Represents and manages plugin localization files.
*
* @package rainlab\builder
* @author Alexey Bobkov, Samuel Georges
*/
class LocalizationModel extends BaseModel
{
public $strings;
public $language;
public $originalLanguage;
protected static $fillable = [
'strings',
'language'
];
protected $validationRules = [
'language' => ['required', 'regex:/^[a-z0-9\.\-]+$/i']
];
protected $originalStringArray = [];
public function load($language)
{
$this->language = $language;
$this->originalLanguage = $language;
$filePath = $this->getFilePath();
if (!File::isFile($filePath)) {
throw new ApplicationException(Lang::get('rainlab.builder::lang.localization.error_cant_load_file'));
}
if (!$this->validateFileContents($filePath)) {
throw new ApplicationException(Lang::get('rainlab.builder::lang.localization.error_bad_localization_file_contents'));
}
$strings = include($filePath);
if (!is_array($strings)) {
throw new ApplicationException(Lang::get('rainlab.builder::lang.localization.error_file_not_array'));
}
$this->originalStringArray = $strings;
if (count($strings) > 0) {
$dumper = new YamlDumper();
$this->strings = $dumper->dump($strings, 20, 0, false, true);
}
else {
$this->strings = '';
}
$this->exists = true;
}
public static function initModel($pluginCode, $language)
{
$model = new self();
$model->setPluginCode($pluginCode);
$model->language = $language;
return $model;
}
public function save()
{
$data = $this->modelToLanguageFile();
$this->validate();
$filePath = File::symbolizePath($this->getFilePath());
$isNew = $this->isNewModel();
if (File::isFile($filePath)) {
if ($isNew || $this->originalLanguage != $this->language) {
throw new ValidationException(['fileName' => Lang::get('rainlab.builder::lang.common.error_file_exists', ['path'=>$this->language.'/'.basename($filePath)])]);
}
}
$fileDirectory = dirname($filePath);
if (!File::isDirectory($fileDirectory)) {
if (!File::makeDirectory($fileDirectory, 0777, true, true)) {
throw new ApplicationException(Lang::get('rainlab.builder::lang.common.error_make_dir', ['name'=>$fileDirectory]));
}
}
if (@File::put($filePath, $data) === false) {
throw new ApplicationException(Lang::get('rainlab.builder::lang.localization.save_error', ['name'=>$filePath]));
}
@File::chmod($filePath);
if (!$this->isNewModel() && strlen($this->originalLanguage) > 0 && $this->originalLanguage != $this->language) {
$this->originalFilePath = $this->getFilePath($this->originalLanguage);
@File::delete($this->originalFilePath);
}
$this->originalLanguage = $this->language;
$this->exists = true;
}
public function deleteModel()
{
if ($this->isNewModel()) {
throw new ApplicationException('Cannot delete language file which is not saved yet.');
}
$filePath = File::symbolizePath($this->getFilePath());
if (File::isFile($filePath)) {
if (!@unlink($filePath)) {
throw new ApplicationException(Lang::get('rainlab.builder::lang.localization.error_delete_file'));
}
}
}
public function initContent()
{
$templatePath = '$/rainlab/builder/classes/localizationmodel/templates/lang.php';
$templatePath = File::symbolizePath($templatePath);
$strings = include($templatePath);
$dumper = new YamlDumper();
$this->strings = $dumper->dump($strings, 20, 0, false, true);
}
public static function listPluginLanguages($pluginCodeObj)
{
$languagesDirectoryPath = $pluginCodeObj->toPluginDirectoryPath().'/lang';
$languagesDirectoryPath = File::symbolizePath($languagesDirectoryPath);
if (!File::isDirectory($languagesDirectoryPath)) {
return [];
}
$result = [];
foreach (new DirectoryIterator($languagesDirectoryPath) as $fileInfo) {
if (!$fileInfo->isDir() || $fileInfo->isDot()) {
continue;
}
$langFilePath = $fileInfo->getPathname().'/lang.php';
if (File::isFile($langFilePath)) {
$result[] = $fileInfo->getFilename();
}
}
return $result;
}
public function copyStringsFrom($destinationText, $sourceLanguageCode)
{
$sourceLanguageModel = new self();
$sourceLanguageModel->setPluginCodeObj($this->getPluginCodeObj());
$sourceLanguageModel->load($sourceLanguageCode);
$srcArray = $sourceLanguageModel->getOriginalStringsArray();
$languageMixer = new LanguageMixer();
return $languageMixer->addStringsFromAnotherLanguage($destinationText, $srcArray);
}
public function getOriginalStringsArray()
{
return $this->originalStringArray;
}
public function createStringAndSave($stringKey, $stringValue)
{
$stringKey = trim($stringKey, '.');
if (!strlen($stringKey)) {
throw new ValidationException(['key' => Lang::get('rainlab.builder::lang.localization.string_key_is_empty')]);
}
if (!strlen($stringValue)) {
throw new ValidationException(['value' => Lang::get('rainlab.builder::lang.localization.string_value_is_empty')]);
}
$originalStringArray = $this->getOriginalStringsArray();
$languagePrefix = strtolower($this->getPluginCodeObj()->toCode()).'::lang.';
$existingStrings = self::convertToStringsArray($originalStringArray, $languagePrefix);
if (array_key_exists($languagePrefix.$stringKey, $existingStrings)) {
throw new ValidationException(['key' => Lang::get('rainlab.builder::lang.localization.string_key_exists')]);
}
$existingSections = self::convertToSectionsArray($originalStringArray);
if (array_key_exists($stringKey.'.', $existingSections)) {
throw new ValidationException(['key' => Lang::get('rainlab.builder::lang.localization.string_key_exists')]);
}
$sectionArray = [];
self::createStringSections($sectionArray, $stringKey, $stringValue) ;
$this->checkKeyWritable($stringKey, $existingStrings, $languagePrefix);
$newStrings = LanguageMixer::arrayMergeRecursive($originalStringArray, $sectionArray);
$dumper = new YamlDumper();
$this->strings = $dumper->dump($newStrings, 20, 0, false, true);
$this->save();
return $languagePrefix.$stringKey;
}
public static function getDefaultLanguage()
{
$language = Config::get('app.locale');
if (!$language) {
throw new ApplicationException('The default language is not defined in the application configuration (app.locale).');
}
return $language;
}
public static function getPluginRegistryData($pluginCode, $subtype)
{
$defaultLanguage = self::getDefaultLanguage();
$model = new self();
$model->setPluginCode($pluginCode);
$model->language = $defaultLanguage;
$filePath = $model->getFilePath();
if (!File::isFile($filePath)) {
return [];
}
$model->load($defaultLanguage);
$array = $model->getOriginalStringsArray();
$languagePrefix = strtolower($model->getPluginCodeObj()->toCode()).'::lang.';
if ($subtype !== 'sections') {
return self::convertToStringsArray($array, $languagePrefix);
}
return self::convertToSectionsArray($array);
}
public static function languageFileExists($pluginCode, $language)
{
$model = new self();
$model->setPluginCode($pluginCode);
$model->language = $language;
$filePath = $model->getFilePath();
return File::isFile($filePath);
}
protected static function createStringSections(&$arr, $path, $value)
{
$keys = explode('.', $path);
while ($key = array_shift($keys)) {
$arr = &$arr[$key];
}
$arr = $value;
}
protected static function convertToStringsArray($stringsArray, $prefix, $currentKey = '')
{
$result = [];
foreach ($stringsArray as $key => $value) {
$newKey = strlen($currentKey) ? $currentKey.'.'.$key : $key;
if (is_scalar($value)) {
$result[$prefix.$newKey] = $value;
}
else {
$result = array_merge($result, self::convertToStringsArray($value, $prefix, $newKey));
}
}
return $result;
}
protected static function convertToSectionsArray($stringsArray, $currentKey = '')
{
$result = [];
foreach ($stringsArray as $key => $value) {
$newKey = strlen($currentKey) ? $currentKey.'.'.$key : $key;
if (is_scalar($value)) {
$result[$currentKey.'.'] = $currentKey.'.';
}
else {
$result = array_merge($result, self::convertToSectionsArray($value, $newKey));
}
}
return $result;
}
protected function validateLanguage($language)
{
return preg_match('/^[a-z0-9\.\-]+$/i', $language);
}
protected function getFilePath($language = null)
{
if ($language === null) {
$language = $this->language;
}
$language = trim($language);
if (!strlen($language)) {
throw new SystemException('The form model language is not set.');
}
if (!$this->validateLanguage($language)) {
throw new SystemException('Invalid language file name: '.$language);
}
$path = $this->getPluginCodeObj()->toPluginDirectoryPath().'/lang/'.$language.'/lang.php';
return File::symbolizePath($path);
}
protected function modelToLanguageFile()
{
$this->strings = trim($this->strings);
if (!strlen($this->strings)) {
return "<?php return [\n];";
}
try {
$data = $this->getSanitizedPHPStrings(Yaml::parse($this->strings));
$phpData = var_export($data, true);
$phpData = preg_replace('/^(\s+)\),/m', '$1],', $phpData);
$phpData = preg_replace('/^(\s+)array\s+\(/m', '$1[', $phpData);
$phpData = preg_replace_callback('/^(\s+)/m', function ($matches) {
return str_repeat($matches[1], 2); // Increase indentation
}, $phpData);
$phpData = preg_replace('/\n\s+\[/m', '[', $phpData);
$phpData = preg_replace('/^array\s\(/', '[', $phpData);
$phpData = preg_replace('/^\)\Z/m', ']', $phpData);
return "<?php return ".$phpData.";";
}
catch (Exception $ex) {
throw new ApplicationException(sprintf('Cannot parse the YAML content: %s', $ex->getMessage()));
}
}
protected function validateFileContents($path)
{
$fileContents = File::get($path);
$stream = new PhpSourceStream($fileContents);
$invalidTokens = [
T_CLASS,
T_FUNCTION,
T_INCLUDE,
T_INCLUDE_ONCE,
T_REQUIRE,
T_REQUIRE_ONCE,
T_EVAL,
T_ECHO,
T_GOTO,
T_HALT_COMPILER,
T_STRING // Unescaped strings - function names, etc.
];
while ($stream->forward()) {
$tokenCode = $stream->getCurrentCode();
if (in_array($tokenCode, $invalidTokens)) {
return false;
}
}
return true;
}
protected function getSanitizedPHPStrings($strings)
{
array_walk_recursive($strings, function (&$item, $key) {
if (!is_scalar($item)) {
return;
}
// In YAML single quotes are escaped with two single quotes
// http://yaml.org/spec/current.html#id2534365
$item = str_replace("''", "'", $item);
});
return $strings;
}
protected function checkKeyWritable($stringKey, $existingStrings, $languagePrefix)
{
$sectionList = explode('.', $stringKey);
$lastElement = array_pop($sectionList);
while (strlen($lastElement)) {
if (count($sectionList) > 0) {
$fullKey = implode('.', $sectionList).'.'.$lastElement;
}
else {
$fullKey = $lastElement;
}
if (array_key_exists($languagePrefix.$fullKey, $existingStrings)) {
throw new ValidationException(['key' => Lang::get('rainlab.builder::lang.localization.string_key_is_a_string', ['key'=>$fullKey])]);
}
$lastElement = array_pop($sectionList);
}
}
}