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
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
* @category Piwik
* @package Piwik
*/
namespace Piwik;
use Exception;
use Piwik\Config;
use Piwik\Common;
/**
* @package Piwik
*/
class Translate
{
/**
* This event is called before generating the JavaScript code that allows other JavaScript
* to access Piwik i18n strings. Plugins should handle this event to specify which translations
* should be available to JavaScript code.
*
* Event handlers should add whole translation keys, ie, keys that include the plugin name.
* For example:
*
* <code>
* public function getClientSideTranslationKeys(&$result)
* {
* $result[] = "MyPlugin_MyTranslation";
* }
* </code>
*
* Callback Signature: function (array &$result)
*/
const GET_CLIENT_SIDE_TRANSLATION_KEYS_EVENT = 'Translate.getClientSideTranslationKeys';
static private $instance = null;
static private $languageToLoad = null;
private $loadedLanguage = false;
/**
* @return \Piwik\Translate
*/
static public function getInstance()
{
if (self::$instance == null) {
self::$instance = new self;
}
return self::$instance;
}
/**
* Clean a string that may contain HTML special chars, single/double quotes, HTML entities, leading/trailing whitespace
*
* @param string $s
* @return string
*/
static public function clean($s)
{
return html_entity_decode(trim($s), ENT_QUOTES, 'UTF-8');
}
public function loadEnglishTranslation()
{
$this->loadCoreTranslationFile('en');
}
public function unloadEnglishTranslation()
{
$GLOBALS['Piwik_translations'] = array();
}
public function reloadLanguage($language = false)
{
if (empty($language)) {
$language = $this->getLanguageToLoad();
}
$this->unloadEnglishTranslation();
$this->loadEnglishTranslation();
$this->loadCoreTranslation($language);
PluginsManager::getInstance()->loadPluginTranslations($language);
}
/**
* Reads the specified code translation file in memory.
*
* @param bool|string $language 2 letter language code. If not specified, will detect current user translation, or load default translation.
* @return void
*/
public function loadCoreTranslation($language = false)
{
if (empty($language)) {
$language = $this->getLanguageToLoad();
}
if ($this->loadedLanguage == $language) {
return;
}
$this->loadCoreTranslationFile($language);
}
private function loadCoreTranslationFile($language)
{
$path = PIWIK_INCLUDE_PATH . '/lang/' . $language . '.json';
if (!Common::isValidFilename($language) || !is_readable($path)) {
throw new Exception(Piwik_TranslateException('General_ExceptionLanguageFileNotFound', array($language)));
}
$data = file_get_contents($path);
$translations = json_decode($data, true);
$this->mergeTranslationArray($translations);
$this->setLocale();
$this->loadedLanguage = $language;
}
public function mergeTranslationArray($translation)
{
if (!isset($GLOBALS['Piwik_translations'])) {
$GLOBALS['Piwik_translations'] = array();
}
// we could check that no string overlap here
$GLOBALS['Piwik_translations'] = array_replace_recursive($GLOBALS['Piwik_translations'], $translation);
}
/**
* @return string the language filename prefix, eg 'en' for english
* @throws exception if the language set is not a valid filename
*/
public function getLanguageToLoad()
{
if (is_null(self::$languageToLoad)) {
$lang = Common::getRequestVar('language', '', 'string');
Piwik_PostEvent('Translate.getLanguageToLoad', array(&$lang));
self::$languageToLoad = $lang;
}
return self::$languageToLoad;
}
/** Reset the cached language to load. Used in tests. */
static public function reset()
{
self::$languageToLoad = null;
}
public function getLanguageLoaded()
{
return $this->loadedLanguage;
}
public function getLanguageDefault()
{
return Config::getInstance()->General['default_language'];
}
/**
* Generate javascript translations array
*
* @param array $moduleList
*/
public function getJavascriptTranslations()
{
$translations = $GLOBALS['Piwik_translations'];
$clientSideTranslations = array();
foreach ($this->getClientSideTranslationKeys() as $key) {
list($plugin, $stringName) = explode("_", $key, 2);
$clientSideTranslations[$key] = $translations[$plugin][$stringName];
}
$js = 'var translations = ' . Common::json_encode($clientSideTranslations) . ';';
$js .= "\n" . 'if(typeof(piwik_translations) == \'undefined\') { var piwik_translations = new Object; }' .
'for(var i in translations) { piwik_translations[i] = translations[i];} ';
$js .= 'function _pk_translate(translationStringId) { ' .
'if( typeof(piwik_translations[translationStringId]) != \'undefined\' ){ return piwik_translations[translationStringId]; }' .
'return "The string "+translationStringId+" was not loaded in javascript. Make sure it is suffixed with _js.";}';
return $js;
}
/**
* Returns the list of client side translations by key. These translations will be outputted
* to the translation JavaScript.
*/
private function getClientSideTranslationKeys()
{
$moduleRegex = '#^.*_js$#i';
// Hack: common translations used in JS but not only, force them to be defined in JS
$result = array('General_Save', 'General_OrCancel');
Piwik_PostEvent(self::GET_CLIENT_SIDE_TRANSLATION_KEYS_EVENT, array(&$result));
$translations = $GLOBALS['Piwik_translations'];
foreach ($translations as $module => $keys) {
foreach($keys as $key => $value) {
// Find keys ending with _js
if (preg_match($moduleRegex, $key)) {
$result[] = $module . '_' . $key;
}
}
}
return $result;
}
/**
* Set locale
*
* @see http://php.net/setlocale
*/
private function setLocale()
{
$locale = $GLOBALS['Piwik_translations']['General']['Locale'];
$locale_variant = str_replace('UTF-8', 'UTF8', $locale);
setlocale(LC_ALL, $locale, $locale_variant);
setlocale(LC_CTYPE, '');
}
}
|
