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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*
*/
namespace Piwik\Plugins\LanguagesManager;
use Piwik\Db;
use Piwik\Development;
use Piwik\Filesystem;
use Piwik\Piwik;
use Piwik\Cache as PiwikCache;
use Piwik\Plugin\Manager as PluginManager;
use Piwik\Plugin\Manager;
use Piwik\Translation\Loader\DevelopmentLoader;
/**
* The LanguagesManager API lets you access existing Matomo translations, and change Users languages preferences.
*
* "getTranslationsForLanguage" will return all translation strings for a given language,
* so you can leverage Matomo translations in your application (and automatically benefit from the <a href='https://matomo.org/translations/' rel='noreferrer' target='_blank'>40+ translations</a>!).
* This is mostly useful to developers who integrate Matomo API results in their own application.
*
* You can also request the default language to load for a user via "getLanguageForUser",
* or update it via "setLanguageForUser".
*
* @method static \Piwik\Plugins\LanguagesManager\API getInstance()
*/
class API extends \Piwik\Plugin\API
{
protected $availableLanguageNames = null;
protected $languageNames = null;
/**
* Returns true if specified language is available
*
* @param string $languageCode
* @return bool true if language available; false otherwise
*/
public function isLanguageAvailable($languageCode)
{
return $languageCode !== false
&& Filesystem::isValidFilename($languageCode)
&& in_array($languageCode, $this->getAvailableLanguages());
}
/**
* Return array of available languages
*
* @return array Array of strings, each containing its ISO language code
*/
public function getAvailableLanguages()
{
if (!is_null($this->languageNames)) {
return $this->languageNames;
}
$path = PIWIK_INCLUDE_PATH . "/lang/";
$languagesPath = _glob($path . "*.json");
$pathLength = strlen($path);
$languages = array();
if ($languagesPath) {
foreach ($languagesPath as $language) {
$languages[] = substr($language, $pathLength, -strlen('.json'));
}
}
$this->enableDevelopmentLanguageInDevEnvironment($languages);
/**
* Hook called after loading available language files.
*
* Use this hook to customise the list of languagesPath available in Matomo.
*
* @param array
*/
Piwik::postEvent('LanguagesManager.getAvailableLanguages', array(&$languages));
/**
* Hook called after loading available language files.
*
* @param array
*
* @deprecated since v3.9.0 use LanguagesManager.getAvailableLanguages instead. Will be removed in Matomo 4.0.0
*/
Piwik::postEvent('LanguageManager.getAvailableLanguages', array(&$languages));
$this->languageNames = $languages;
return $languages;
}
/**
* Return information on translations (code, language, % translated, etc)
*
* @param boolean $excludeNonCorePlugins excludes non core plugin from percentage calculation
*
* @return array Array of arrays
*/
public function getAvailableLanguagesInfo($excludeNonCorePlugins=true)
{
$data = file_get_contents(PIWIK_INCLUDE_PATH . '/lang/en.json');
$englishTranslation = json_decode($data, true);
$pluginDirectories = Manager::getPluginsDirectories();
// merge with plugin translations if any
$pluginFiles = array();
foreach ($pluginDirectories as $pluginsDir) {
$pluginFiles = array_merge($pluginFiles, glob(sprintf('%s*/lang/en.json', $pluginsDir)));
}
foreach ($pluginFiles as $file) {
$fileWithoutPluginDir = str_replace($pluginDirectories, '', $file);
preg_match('/([^\/]+)\/lang/i', $fileWithoutPluginDir, $matches);
$plugin = $matches[1];
if (!$excludeNonCorePlugins || Manager::getInstance()->isPluginBundledWithCore($plugin)) {
$data = file_get_contents($file);
$pluginTranslations = json_decode($data, true);
$englishTranslation = array_merge_recursive($englishTranslation, $pluginTranslations);
}
}
$filenames = $this->getAvailableLanguages();
$languagesInfo = array();
foreach ($filenames as $filename) {
$data = file_get_contents(sprintf('%s/lang/%s.json', PIWIK_INCLUDE_PATH, $filename));
$translations = json_decode($data, true);
// merge with plugin translations if any
$pluginFiles = array();
foreach ($pluginDirectories as $pluginsDir) {
$pluginFiles = array_merge($pluginFiles, glob(sprintf('%s*/lang/%s.json', $pluginsDir, $filename)));
}
foreach ($pluginFiles as $file) {
$fileWithoutPluginDir = str_replace($pluginDirectories, '', $file);
preg_match('/([^\/]+)\/lang/i', $fileWithoutPluginDir, $matches);
$plugin = $matches[1];
if (!$excludeNonCorePlugins || Manager::getInstance()->isPluginBundledWithCore($plugin)) {
$data = file_get_contents($file);
$pluginTranslations = json_decode($data, true);
$translations = array_merge_recursive($translations, $pluginTranslations);
}
}
$intersect = function ($array, $array2) {
$res = $array;
foreach ($array as $module => $keys) {
if (!isset($array2[$module])) {
unset($res[$module]);
} else {
$res[$module] = array_intersect_key($res[$module], array_filter($array2[$module], 'strlen'));
}
}
return $res;
};
// Skip languages not having Intl translations
if (empty($translations['Intl'])) {
continue;
}
$translationStringsDone = $intersect($englishTranslation, $translations);
$percentageComplete = count($translationStringsDone, COUNT_RECURSIVE) / count($englishTranslation, COUNT_RECURSIVE);
$percentageComplete = round(100 * $percentageComplete, 0);
$languageInfo = array('code' => $filename,
'name' => $translations['Intl']['OriginalLanguageName'],
'english_name' => $translations['Intl']['EnglishLanguageName'],
'translators' => $translations['General']['TranslatorName'],
'percentage_complete' => $percentageComplete . '%',
);
$languagesInfo[] = $languageInfo;
}
return $languagesInfo;
}
/**
* Return array of available languages
*
* @return array Array of array, each containing its ISO language code and name of the language
*/
public function getAvailableLanguageNames()
{
$this->loadAvailableLanguages();
return $this->availableLanguageNames;
}
/**
* Returns translation strings by language
*
* @param string $languageCode ISO language code
* @return array|false Array of arrays, each containing 'label' (translation index) and 'value' (translated string); false if language unavailable
*/
public function getTranslationsForLanguage($languageCode)
{
if (!$this->isLanguageAvailable($languageCode)) {
return false;
}
$data = file_get_contents(PIWIK_INCLUDE_PATH . "/lang/$languageCode.json");
$translations = json_decode($data, true);
$languageInfo = array();
foreach ($translations as $module => $keys) {
foreach ($keys as $key => $value) {
$languageInfo[] = array(
'label' => sprintf("%s_%s", $module, $key),
'value' => $value
);
}
}
foreach (PluginManager::getInstance()->getLoadedPluginsName() as $pluginName) {
$translations = $this->getPluginTranslationsForLanguage($pluginName, $languageCode);
if (!empty($translations)) {
foreach ($translations as $keys) {
$languageInfo[] = $keys;
}
}
}
return $languageInfo;
}
/**
* Returns translation strings by language for given plugin
*
* @param string $pluginName name of plugin
* @param string $languageCode ISO language code
* @return array|false Array of arrays, each containing 'label' (translation index) and 'value' (translated string); false if language unavailable
*
* @ignore
*/
public function getPluginTranslationsForLanguage($pluginName, $languageCode)
{
if (!$this->isLanguageAvailable($languageCode)) {
return false;
}
$languageFile = Manager::getPluginDirectory($pluginName) . "/lang/$languageCode.json";
if (!file_exists($languageFile)) {
return false;
}
$data = file_get_contents($languageFile);
$translations = json_decode($data, true);
$languageInfo = array();
foreach ($translations as $module => $keys) {
foreach ($keys as $key => $value) {
$languageInfo[] = array(
'label' => sprintf("%s_%s", $module, $key),
'value' => $value
);
}
}
return $languageInfo;
}
/**
* Returns the language for the user
*
* @param string $login
* @return string
*/
public function getLanguageForUser($login)
{
if ($login == 'anonymous') {
return false;
}
Piwik::checkUserHasSuperUserAccessOrIsTheUser($login);
$lang = $this->getModel()->getLanguageForUser($login);
return $lang;
}
private function getModel()
{
return new Model();
}
/**
* Sets the language for the user
*
* @param string $login
* @param string $languageCode
* @return bool
*/
public function setLanguageForUser($login, $languageCode)
{
Piwik::checkUserHasSuperUserAccessOrIsTheUser($login);
Piwik::checkUserIsNotAnonymous();
if (!$this->isLanguageAvailable($languageCode)) {
return false;
}
$this->getModel()->setLanguageForUser($login, $languageCode);
return true;
}
/**
* Returns whether the user uses 12 hour clock
*
* @param string $login
* @return string
*/
public function uses12HourClockForUser($login)
{
if ($login == 'anonymous') {
return false;
}
Piwik::checkUserHasSuperUserAccessOrIsTheUser($login);
$lang = $this->getModel()->uses12HourClock($login);
return $lang;
}
/**
* Returns whether the user uses 12 hour clock
*
* @param string $login
* @param bool $use12HourClock
* @return string
*/
public function set12HourClockForUser($login, $use12HourClock)
{
if ($login == 'anonymous') {
return false;
}
Piwik::checkUserHasSuperUserAccessOrIsTheUser($login);
$lang = $this->getModel()->set12HourClock($login, $use12HourClock);
return $lang;
}
private function loadAvailableLanguages()
{
if (!is_null($this->availableLanguageNames)) {
return;
}
$cacheId = 'availableLanguages';
$cache = PiwikCache::getEagerCache();
if ($cache->contains($cacheId)) {
$languagesInfo = $cache->fetch($cacheId);
} else {
$languages = $this->getAvailableLanguages();
$languagesInfo = array();
foreach ($languages as $languageCode) {
$data = @file_get_contents(PIWIK_INCLUDE_PATH . "/plugins/Intl/lang/$languageCode.json");
// Skip languages not having Intl translations
if (empty($data)) {
continue;
}
$translations = json_decode($data, true);
$languagesInfo[] = array(
'code' => $languageCode,
'name' => $translations['Intl']['OriginalLanguageName'],
'english_name' => $translations['Intl']['EnglishLanguageName']
);
}
$cache->save($cacheId, $languagesInfo);
}
$this->availableLanguageNames = $languagesInfo;
}
private function enableDevelopmentLanguageInDevEnvironment(&$languages)
{
if (!Development::isEnabled()) {
$key = array_search(DevelopmentLoader::LANGUAGE_ID, $languages);
if ($key) {
unset($languages[$key]);
}
}
}
}
|