238 lines
8.1 KiB
PHP
238 lines
8.1 KiB
PHP
<?php
|
|
/*
|
|
* Xibo - Digital Signage - http://www.xibo.org.uk
|
|
* Copyright (C) 2015 Spring Signage Ltd
|
|
*
|
|
* This file (TranslationEngine.php) is part of Xibo.
|
|
*
|
|
* Xibo is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* any later version.
|
|
*
|
|
* Xibo 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 Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with Xibo. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
namespace Xibo\Helper;
|
|
|
|
use CachedFileReader;
|
|
use Gettext\Translations;
|
|
use Gettext\Translator;
|
|
use gettext_reader;
|
|
use Illuminate\Support\Str;
|
|
use Xibo\Service\ConfigServiceInterface;
|
|
|
|
/**
|
|
* Class Translate
|
|
* @package Xibo\Helper
|
|
*/
|
|
class Translate
|
|
{
|
|
private static $requestedLanguage;
|
|
private static $locale;
|
|
private static $jsLocale;
|
|
private static $jsLocaleRequested;
|
|
|
|
/**
|
|
* Gets and Sets the Locale
|
|
* @param ConfigServiceInterface $config
|
|
* @param $language string[optional] The Language to Load
|
|
*/
|
|
public static function InitLocale($config, $language = NULL)
|
|
{
|
|
// The default language
|
|
$default = ($language === null) ? $config->getSetting('DEFAULT_LANGUAGE') : $language;
|
|
|
|
// Build an array of supported languages
|
|
$localeDir = PROJECT_ROOT . '/locale';
|
|
$supportedLanguages = array_map('basename', glob($localeDir . '/*.mo'));
|
|
|
|
// Record any matching languages we find.
|
|
$foundLanguage = null;
|
|
|
|
// Try to get the local firstly from _REQUEST (post then get)
|
|
if ($language != null) {
|
|
// Serve only the requested language
|
|
// Firstly, Sanitize it
|
|
self::$requestedLanguage = str_replace('-', '_', $language);
|
|
|
|
// Check its valid
|
|
if (in_array(self::$requestedLanguage . '.mo', $supportedLanguages)) {
|
|
$foundLanguage = self::$requestedLanguage;
|
|
}
|
|
}
|
|
else if ($config->getSetting('DETECT_LANGUAGE') == 1) {
|
|
// Detect the language, try from HTTP accept
|
|
// Parse the language header and build a preference array
|
|
$languagePreferenceArray = Translate::parseHttpAcceptLanguageHeader();
|
|
|
|
if (count($languagePreferenceArray) > 0) {
|
|
// Go through the list until we have a match
|
|
foreach ($languagePreferenceArray as $languagePreference => $preferenceRating) {
|
|
|
|
// We don't ship an en.mo, so fudge in a case where we automatically convert that to en_GB
|
|
if ($languagePreference == 'en')
|
|
$languagePreference = 'en_GB';
|
|
|
|
// Sanitize
|
|
$languagePreference = str_replace('-', '_', $languagePreference);
|
|
|
|
// Set as requested
|
|
self::$requestedLanguage = $languagePreference;
|
|
|
|
// Check it is valid
|
|
if (in_array($languagePreference . '.mo', $supportedLanguages)) {
|
|
$foundLanguage = $languagePreference;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Requested language
|
|
if (self::$requestedLanguage == null)
|
|
self::$requestedLanguage = $default;
|
|
|
|
// Are we still empty, then default language from settings
|
|
if ($foundLanguage == '') {
|
|
// Check the default
|
|
if (!in_array($default . '.mo', $supportedLanguages)) {
|
|
$default = 'en_GB';
|
|
}
|
|
|
|
// The default is valid
|
|
$foundLanguage = $default;
|
|
}
|
|
|
|
// Load translations
|
|
$translator = new Translator();
|
|
$translator->loadTranslations(Translations::fromMoFile($localeDir . '/' . $foundLanguage . '.mo'));
|
|
$translator->register();
|
|
|
|
// Store our resolved language locales
|
|
self::$locale = $foundLanguage;
|
|
self::$jsLocale = str_replace('_', '-', $foundLanguage);
|
|
self::$jsLocaleRequested = str_replace('_', '-', self::$requestedLanguage);
|
|
}
|
|
|
|
/**
|
|
* Get translations for user selected language
|
|
* @param $language
|
|
* @return Translator|null
|
|
*/
|
|
public static function getTranslationsFromLocale($language): ?Translator
|
|
{
|
|
// Build an array of supported languages
|
|
$localeDir = PROJECT_ROOT . '/locale';
|
|
$supportedLanguages = array_map('basename', glob($localeDir . '/*.mo'));
|
|
|
|
// Record any matching languages we find.
|
|
$foundLanguage = null;
|
|
|
|
// Try to get the local firstly from _REQUEST (post then get)
|
|
if ($language != null) {
|
|
$parsedLanguage = str_replace('-', '_', $language);
|
|
|
|
// Check its valid
|
|
if (in_array($parsedLanguage . '.mo', $supportedLanguages)) {
|
|
$foundLanguage = $parsedLanguage;
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
// Are we still empty, then return null
|
|
if ($foundLanguage == '') {
|
|
return null;
|
|
}
|
|
|
|
// Load translations
|
|
$translator = new Translator();
|
|
$translator->loadTranslations(Translations::fromMoFile($localeDir . '/' . $foundLanguage . '.mo'));
|
|
$translator->register();
|
|
|
|
return $translator;
|
|
}
|
|
|
|
/**
|
|
* Get the Locale
|
|
* @param null $characters The number of characters to take from the beginning of the local string
|
|
* @return mixed
|
|
*/
|
|
public static function GetLocale($characters = null)
|
|
{
|
|
return ($characters == null) ? self::$locale : substr(self::$locale, 0, $characters);
|
|
}
|
|
|
|
public static function GetJsLocale()
|
|
{
|
|
return self::$jsLocale;
|
|
}
|
|
|
|
/**
|
|
* @param array $options
|
|
* @return string
|
|
*/
|
|
public static function getRequestedJsLocale($options = [])
|
|
{
|
|
$options = array_merge([
|
|
'short' => false
|
|
], $options);
|
|
|
|
if ($options['short'] && (strlen(self::$jsLocaleRequested) > 2) && Str::contains(self::$jsLocaleRequested, '-')) {
|
|
// Short js-locale requested, and our string is longer than 2 characters and has a splitter (language variant)
|
|
$variant = explode('-', self::$jsLocaleRequested);
|
|
|
|
// The logic here is that if they are the same, i.e. de-DE, then we should only output de, but if they are
|
|
// different, i.e. de-AT then we should output the whole thing
|
|
return (strtolower($variant[0]) === strtolower($variant[1])) ? $variant[0] : self::$jsLocaleRequested;
|
|
} else {
|
|
return self::$jsLocaleRequested;
|
|
}
|
|
}
|
|
|
|
public static function getRequestedLanguage()
|
|
{
|
|
return self::$requestedLanguage;
|
|
}
|
|
|
|
/**
|
|
* Parse the HttpAcceptLanguage Header
|
|
* Inspired by: http://www.thefutureoftheweb.com/blog/use-accept-language-header
|
|
* @param null $header
|
|
* @return array Language array where the key is the language identifier and the value is the preference double.
|
|
*/
|
|
public static function parseHttpAcceptLanguageHeader($header = null)
|
|
{
|
|
if ($header == null)
|
|
$header = isset($_SERVER['HTTP_ACCEPT_LANGUAGE']) ? $_SERVER['HTTP_ACCEPT_LANGUAGE'] : '';
|
|
|
|
$languages = array();
|
|
|
|
if ($header != '') {
|
|
// break up string into pieces (languages and q factors)
|
|
preg_match_all('/([a-z]{1,8}(-[a-z]{1,8})?)\s*(;\s*q\s*=\s*(1|0\.[0-9]+))?/i', $header, $langParse);
|
|
|
|
if (count($langParse[1])) {
|
|
// create a list like "en" => 0.8
|
|
$languages = array_combine($langParse[1], $langParse[4]);
|
|
|
|
// set default to 1 for any without q factor
|
|
foreach ($languages as $lang => $val) {
|
|
if ($val === '')
|
|
$languages[$lang] = 1;
|
|
}
|
|
|
|
// sort list based on value
|
|
arsort($languages, SORT_NUMERIC);
|
|
}
|
|
}
|
|
|
|
return $languages;
|
|
}
|
|
} |