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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*
*/
namespace Piwik\Plugins\LanguagesManager;
use Exception;
use Piwik\API\Request;
use Piwik\AssetManager\UIAssetFetcher\PluginUmdAssetFetcher;
use Piwik\Common;
use Piwik\Config;
use Piwik\Container\StaticContainer;
use Piwik\Cookie;
use Piwik\Intl\Locale;
use Piwik\Nonce;
use Piwik\Piwik;
use Piwik\ProxyHttp;
use Piwik\Translation\Translator;
use Piwik\View;
/**
*
*/
class LanguagesManager extends \Piwik\Plugin
{
public const LANGUAGE_SELECTION_NONCE = 'LanguagesManager.selection';
/**
* @see \Piwik\Plugin::registerEvents
*/
public function registerEvents()
{
return array(
'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys',
'Config.NoConfigurationFile' => 'initLanguage',
'Request.dispatchCoreAndPluginUpdatesScreen' => 'initLanguage',
'Request.dispatch' => 'initLanguage',
'Platform.initialized' => 'initLanguage',
'UsersManager.deleteUser' => 'deleteUserLanguage',
'Template.topBar' => 'addLanguagesManagerToOtherTopBar',
'Template.jsGlobalVariables' => 'jsGlobalVariables',
'Db.getTablesInstalled' => 'getTablesInstalled',
);
}
public function getClientSideTranslationKeys(&$translations)
{
$translations[] = 'LanguagesManager_TranslationSearch';
$translations[] = 'LanguagesManager_AboutPiwikTranslations';
}
/**
* Register the new tables, so Matomo knows about them.
*
* @param array $allTablesInstalled
*/
public function getTablesInstalled(&$allTablesInstalled)
{
$allTablesInstalled[] = Common::prefixTable('user_language');
}
/**
* Adds the languages drop-down list to topbars other than the main one rendered
* in CoreHome/templates/top_bar.twig. The 'other' topbars are on the Installation
* and CoreUpdater screens.
*/
public function addLanguagesManagerToOtherTopBar(&$str)
{
// piwik object & scripts aren't loaded in 'other' topbars
$str .= "<script type='text/javascript'>if (!window.piwik) window.piwik={};</script>";
$file = PluginUmdAssetFetcher::getUmdFileToUseForPlugin('LanguagesManager');
$str .= "<script type='text/javascript' src='$file' defer></script>";
$str .= $this->getLanguagesSelector();
}
/**
* Adds the languages drop-down list to topbars other than the main one rendered
* in CoreHome/templates/top_bar.twig. The 'other' topbars are on the Installation
* and CoreUpdater screens.
*/
public function jsGlobalVariables(&$str)
{
// piwik object & scripts aren't loaded in 'other' topbars
$str .= "piwik.languageName = '" . self::getLanguageNameForCurrentUser() . "';";
}
/**
* Renders and returns the language selector HTML.
*
* @return string
*/
public function getLanguagesSelector()
{
$view = new View("@LanguagesManager/getLanguagesSelector");
$view->languages = API::getInstance()->getAvailableLanguageNames();
$view->currentLanguageCode = self::getLanguageCodeForCurrentUser();
$view->currentLanguageName = self::getLanguageNameForCurrentUser();
$view->nonce = Nonce::getNonce(self::LANGUAGE_SELECTION_NONCE);
return $view->render();
}
public function initLanguage()
{
/** @var Translator $translator */
$translator = StaticContainer::get('Piwik\Translation\Translator');
$language = Common::getRequestVar('language', '', 'string');
if (empty($language)) {
$userLanguage = self::getLanguageCodeForCurrentUser();
if (API::getInstance()->isLanguageAvailable($userLanguage)) {
$language = $userLanguage;
}
}
if (!empty($language) && API::getInstance()->isLanguageAvailable($language)) {
$translator->setCurrentLanguage($language);
}
$locale = $translator->translate('General_Locale');
Locale::setLocale($locale);
}
public function deleteUserLanguage($userLogin)
{
$model = new Model();
$model->deleteUserLanguage($userLogin);
}
/**
* @throws Exception if non-recoverable error
*/
public function install()
{
Model::install();
}
/**
* @throws Exception if non-recoverable error
*/
public function uninstall()
{
Model::uninstall();
}
/**
* @return boolean
*/
public static function uses12HourClockForCurrentUser()
{
try {
$currentUser = Piwik::getCurrentUserLogin();
return Request::processRequest('LanguagesManager.uses12HourClockForUser', array('login' => $currentUser));
} catch (Exception $e) {
return false;
}
}
/**
* @return string Two letters language code, eg. "fr"
*/
public static function getLanguageCodeForCurrentUser()
{
$languageCode = self::getLanguageFromPreferences();
if (!API::getInstance()->isLanguageAvailable($languageCode)) {
$languageCode = Common::extractLanguageAndRegionCodeFromBrowserLanguage(Common::getBrowserLanguage(), API::getInstance()->getAvailableLanguages());
}
if (!API::getInstance()->isLanguageAvailable($languageCode)) {
$languageCode = StaticContainer::get('Piwik\Translation\Translator')->getDefaultLanguage();
}
return $languageCode;
}
/**
* @return string Full english language string, eg. "French"
*/
public static function getLanguageNameForCurrentUser()
{
$languageCode = self::getLanguageCodeForCurrentUser();
$languages = API::getInstance()->getAvailableLanguageNames();
foreach ($languages as $language) {
if ($language['code'] === $languageCode) {
return $language['name'];
}
}
return false;
}
/**
* @return string|false if language preference could not be loaded
*/
protected static function getLanguageFromPreferences()
{
if (($language = self::getLanguageForSession()) != null) {
return $language;
}
try {
$currentUser = Piwik::getCurrentUserLogin();
return API::getInstance()->getLanguageForUser($currentUser);
} catch (Exception $e) {
return false;
}
}
/**
* Returns the language for the session
*
* @return string|null
*/
public static function getLanguageForSession()
{
$cookieName = Config::getInstance()->General['language_cookie_name'];
$cookie = new Cookie($cookieName);
if ($cookie->isCookieFound()) {
return $cookie->get('language');
}
return null;
}
/**
* Set the language for the session
*
* @param string $languageCode ISO language code
* @return bool
*/
public static function setLanguageForSession($languageCode)
{
if (!API::getInstance()->isLanguageAvailable($languageCode)) {
return false;
}
$cookieName = Config::getInstance()->General['language_cookie_name'];
$cookie = new Cookie($cookieName, 0);
$cookie->set('language', $languageCode);
$cookie->setSecure(ProxyHttp::isHttps());
$cookie->setHttpOnly(true);
$cookie->save('Lax');
return true;
}
}
|