123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683 |
- <?php
- declare(strict_types=1);
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- * @copyright 2016 Roeland Jago Douma <roeland@famdouma.nl>
- * @copyright 2016 Lukas Reschke <lukas@statuscode.ch>
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Bart Visscher <bartv@thisnet.nl>
- * @author Bjoern Schiessle <bjoern@schiessle.org>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Georg Ehrke <oc.list@georgehrke.com>
- * @author GretaD <gretadoci@gmail.com>
- * @author Joas Schilling <coding@schilljs.com>
- * @author John Molakvoæ <skjnldsv@protonmail.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Robin McCorkell <robin@mccorkell.me.uk>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Citharel <nextcloud@tcit.fr>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program 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, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- namespace OC\L10N;
- use OCP\ICache;
- use OCP\ICacheFactory;
- use OCP\IConfig;
- use OCP\IRequest;
- use OCP\IUser;
- use OCP\IUserSession;
- use OCP\L10N\IFactory;
- use OCP\L10N\ILanguageIterator;
- use function is_null;
- /**
- * A factory that generates language instances
- */
- class Factory implements IFactory {
- /** @var string */
- protected $requestLanguage = '';
- /**
- * cached instances
- * @var array Structure: Lang => App => \OCP\IL10N
- */
- protected $instances = [];
- /**
- * @var array Structure: App => string[]
- */
- protected $availableLanguages = [];
- /**
- * @var array
- */
- protected $localeCache = [];
- /**
- * @var array
- */
- protected $availableLocales = [];
- /**
- * @var array Structure: string => callable
- */
- protected $pluralFunctions = [];
- public const COMMON_LANGUAGE_CODES = [
- 'en', 'es', 'fr', 'de', 'de_DE', 'ja', 'ar', 'ru', 'nl', 'it',
- 'pt_BR', 'pt_PT', 'da', 'fi_FI', 'nb_NO', 'sv', 'tr', 'zh_CN', 'ko'
- ];
- /** @var IConfig */
- protected $config;
- /** @var IRequest */
- protected $request;
- /** @var IUserSession */
- protected IUserSession $userSession;
- private ICache $cache;
- /** @var string */
- protected $serverRoot;
- /**
- * @param IConfig $config
- * @param IRequest $request
- * @param IUserSession $userSession
- * @param string $serverRoot
- */
- public function __construct(
- IConfig $config,
- IRequest $request,
- IUserSession $userSession,
- ICacheFactory $cacheFactory,
- $serverRoot
- ) {
- $this->config = $config;
- $this->request = $request;
- $this->userSession = $userSession;
- $this->cache = $cacheFactory->createLocal('L10NFactory');
- $this->serverRoot = $serverRoot;
- }
- /**
- * Get a language instance
- *
- * @param string $app
- * @param string|null $lang
- * @param string|null $locale
- * @return \OCP\IL10N
- */
- public function get($app, $lang = null, $locale = null) {
- return new LazyL10N(function () use ($app, $lang, $locale) {
- $app = \OC_App::cleanAppId($app);
- if ($lang !== null) {
- $lang = str_replace(['\0', '/', '\\', '..'], '', $lang);
- }
- $forceLang = $this->config->getSystemValue('force_language', false);
- if (is_string($forceLang)) {
- $lang = $forceLang;
- }
- $forceLocale = $this->config->getSystemValue('force_locale', false);
- if (is_string($forceLocale)) {
- $locale = $forceLocale;
- }
- if ($lang === null || !$this->languageExists($app, $lang)) {
- $lang = $this->findLanguage($app);
- }
- if ($locale === null || !$this->localeExists($locale)) {
- $locale = $this->findLocale($lang);
- }
- if (!isset($this->instances[$lang][$app])) {
- $this->instances[$lang][$app] = new L10N(
- $this,
- $app,
- $lang,
- $locale,
- $this->getL10nFilesForApp($app, $lang)
- );
- }
- return $this->instances[$lang][$app];
- });
- }
- /**
- * Find the best language
- *
- * @param string|null $appId App id or null for core
- *
- * @return string language If nothing works it returns 'en'
- */
- public function findLanguage(?string $appId = null): string {
- // Step 1: Forced language always has precedence over anything else
- $forceLang = $this->config->getSystemValue('force_language', false);
- if (is_string($forceLang)) {
- $this->requestLanguage = $forceLang;
- }
- // Step 2: Return cached language
- if ($this->requestLanguage !== '' && $this->languageExists($appId, $this->requestLanguage)) {
- return $this->requestLanguage;
- }
- /**
- * Step 3: At this point Nextcloud might not yet be installed and thus the lookup
- * in the preferences table might fail. For this reason we need to check
- * whether the instance has already been installed
- *
- * @link https://github.com/owncloud/core/issues/21955
- */
- if ($this->config->getSystemValueBool('installed', false)) {
- $userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() : null;
- if (!is_null($userId)) {
- $userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
- } else {
- $userLang = null;
- }
- } else {
- $userId = null;
- $userLang = null;
- }
- if ($userLang) {
- $this->requestLanguage = $userLang;
- if ($this->languageExists($appId, $userLang)) {
- return $userLang;
- }
- }
- // Step 4: Check the request headers
- try {
- // Try to get the language from the Request
- $lang = $this->getLanguageFromRequest($appId);
- if ($userId !== null && $appId === null && !$userLang) {
- $this->config->setUserValue($userId, 'core', 'lang', $lang);
- }
- return $lang;
- } catch (LanguageNotFoundException $e) {
- // Finding language from request failed fall back to default language
- $defaultLanguage = $this->config->getSystemValue('default_language', false);
- if ($defaultLanguage !== false && $this->languageExists($appId, $defaultLanguage)) {
- return $defaultLanguage;
- }
- }
- // Step 5: fall back to English
- return 'en';
- }
- public function findGenericLanguage(string $appId = null): string {
- // Step 1: Forced language always has precedence over anything else
- $forcedLanguage = $this->config->getSystemValue('force_language', false);
- if ($forcedLanguage !== false) {
- return $forcedLanguage;
- }
- // Step 2: Check if we have a default language
- $defaultLanguage = $this->config->getSystemValue('default_language', false);
- if ($defaultLanguage !== false && $this->languageExists($appId, $defaultLanguage)) {
- return $defaultLanguage;
- }
- // Step 3.1: Check if Nextcloud is already installed before we try to access user info
- if (!$this->config->getSystemValueBool('installed', false)) {
- return 'en';
- }
- // Step 3.2: Check the current user (if any) for their preferred language
- $user = $this->userSession->getUser();
- if ($user !== null) {
- $userLang = $this->config->getUserValue($user->getUID(), 'core', 'lang', null);
- if ($userLang !== null) {
- return $userLang;
- }
- }
- // Step 4: Check the request headers
- try {
- return $this->getLanguageFromRequest($appId);
- } catch (LanguageNotFoundException $e) {
- // Ignore and continue
- }
- // Step 5: fall back to English
- return 'en';
- }
- /**
- * find the best locale
- *
- * @param string $lang
- * @return null|string
- */
- public function findLocale($lang = null) {
- $forceLocale = $this->config->getSystemValue('force_locale', false);
- if (is_string($forceLocale) && $this->localeExists($forceLocale)) {
- return $forceLocale;
- }
- if ($this->config->getSystemValueBool('installed', false)) {
- $userId = null !== $this->userSession->getUser() ? $this->userSession->getUser()->getUID() : null;
- $userLocale = null;
- if (null !== $userId) {
- $userLocale = $this->config->getUserValue($userId, 'core', 'locale', null);
- }
- } else {
- $userId = null;
- $userLocale = null;
- }
- if ($userLocale && $this->localeExists($userLocale)) {
- return $userLocale;
- }
- // Default : use system default locale
- $defaultLocale = $this->config->getSystemValue('default_locale', false);
- if ($defaultLocale !== false && $this->localeExists($defaultLocale)) {
- return $defaultLocale;
- }
- // If no user locale set, use lang as locale
- if (null !== $lang && $this->localeExists($lang)) {
- return $lang;
- }
- // At last, return USA
- return 'en_US';
- }
- /**
- * find the matching lang from the locale
- *
- * @param string $app
- * @param string $locale
- * @return null|string
- */
- public function findLanguageFromLocale(string $app = 'core', string $locale = null) {
- if ($this->languageExists($app, $locale)) {
- return $locale;
- }
- // Try to split e.g: fr_FR => fr
- $locale = explode('_', $locale)[0];
- if ($this->languageExists($app, $locale)) {
- return $locale;
- }
- }
- /**
- * Find all available languages for an app
- *
- * @param string|null $app App id or null for core
- * @return string[] an array of available languages
- */
- public function findAvailableLanguages($app = null): array {
- $key = $app;
- if ($key === null) {
- $key = 'null';
- }
- if ($availableLanguages = $this->cache->get($key)) {
- $this->availableLanguages[$key] = $availableLanguages;
- }
- // also works with null as key
- if (!empty($this->availableLanguages[$key])) {
- return $this->availableLanguages[$key];
- }
- $available = ['en']; //english is always available
- $dir = $this->findL10nDir($app);
- if (is_dir($dir)) {
- $files = scandir($dir);
- if ($files !== false) {
- foreach ($files as $file) {
- if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
- $available[] = substr($file, 0, -5);
- }
- }
- }
- }
- // merge with translations from theme
- $theme = $this->config->getSystemValueString('theme');
- if (!empty($theme)) {
- $themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
- if (is_dir($themeDir)) {
- $files = scandir($themeDir);
- if ($files !== false) {
- foreach ($files as $file) {
- if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') {
- $available[] = substr($file, 0, -5);
- }
- }
- }
- }
- }
- $this->availableLanguages[$key] = $available;
- $this->cache->set($key, $available, 60);
- return $available;
- }
- /**
- * @return array|mixed
- */
- public function findAvailableLocales() {
- if (!empty($this->availableLocales)) {
- return $this->availableLocales;
- }
- $localeData = file_get_contents(\OC::$SERVERROOT . '/resources/locales.json');
- $this->availableLocales = \json_decode($localeData, true);
- return $this->availableLocales;
- }
- /**
- * @param string|null $app App id or null for core
- * @param string $lang
- * @return bool
- */
- public function languageExists($app, $lang) {
- if ($lang === 'en') { //english is always available
- return true;
- }
- $languages = $this->findAvailableLanguages($app);
- return in_array($lang, $languages);
- }
- public function getLanguageIterator(IUser $user = null): ILanguageIterator {
- $user = $user ?? $this->userSession->getUser();
- if ($user === null) {
- throw new \RuntimeException('Failed to get an IUser instance');
- }
- return new LanguageIterator($user, $this->config);
- }
- /**
- * Return the language to use when sending something to a user
- *
- * @param IUser|null $user
- * @return string
- * @since 20.0.0
- */
- public function getUserLanguage(IUser $user = null): string {
- $language = $this->config->getSystemValue('force_language', false);
- if ($language !== false) {
- return $language;
- }
- if ($user instanceof IUser) {
- $language = $this->config->getUserValue($user->getUID(), 'core', 'lang', null);
- if ($language !== null) {
- return $language;
- }
- // Use language from request
- if ($this->userSession->getUser() instanceof IUser &&
- $user->getUID() === $this->userSession->getUser()->getUID()) {
- try {
- return $this->getLanguageFromRequest();
- } catch (LanguageNotFoundException $e) {
- }
- }
- }
- return $this->config->getSystemValueString('default_language', 'en');
- }
- /**
- * @param string $locale
- * @return bool
- */
- public function localeExists($locale) {
- if ($locale === 'en') { //english is always available
- return true;
- }
- if ($this->localeCache === []) {
- $locales = $this->findAvailableLocales();
- foreach ($locales as $l) {
- $this->localeCache[$l['code']] = true;
- }
- }
- return isset($this->localeCache[$locale]);
- }
- /**
- * @throws LanguageNotFoundException
- */
- private function getLanguageFromRequest(?string $app = null): string {
- $header = $this->request->getHeader('ACCEPT_LANGUAGE');
- if ($header !== '') {
- $available = $this->findAvailableLanguages($app);
- // E.g. make sure that 'de' is before 'de_DE'.
- sort($available);
- $preferences = preg_split('/,\s*/', strtolower($header));
- foreach ($preferences as $preference) {
- [$preferred_language] = explode(';', $preference);
- $preferred_language = str_replace('-', '_', $preferred_language);
- foreach ($available as $available_language) {
- if ($preferred_language === strtolower($available_language)) {
- return $this->respectDefaultLanguage($app, $available_language);
- }
- }
- // Fallback from de_De to de
- foreach ($available as $available_language) {
- if (substr($preferred_language, 0, 2) === $available_language) {
- return $available_language;
- }
- }
- }
- }
- throw new LanguageNotFoundException();
- }
- /**
- * if default language is set to de_DE (formal German) this should be
- * preferred to 'de' (non-formal German) if possible
- */
- protected function respectDefaultLanguage(?string $app, string $lang): string {
- $result = $lang;
- $defaultLanguage = $this->config->getSystemValue('default_language', false);
- // use formal version of german ("Sie" instead of "Du") if the default
- // language is set to 'de_DE' if possible
- if (
- is_string($defaultLanguage) &&
- strtolower($lang) === 'de' &&
- strtolower($defaultLanguage) === 'de_de' &&
- $this->languageExists($app, 'de_DE')
- ) {
- $result = 'de_DE';
- }
- return $result;
- }
- /**
- * Checks if $sub is a subdirectory of $parent
- *
- * @param string $sub
- * @param string $parent
- * @return bool
- */
- private function isSubDirectory($sub, $parent) {
- // Check whether $sub contains no ".."
- if (str_contains($sub, '..')) {
- return false;
- }
- // Check whether $sub is a subdirectory of $parent
- if (str_starts_with($sub, $parent)) {
- return true;
- }
- return false;
- }
- /**
- * Get a list of language files that should be loaded
- *
- * @param string $app
- * @param string $lang
- * @return string[]
- */
- // FIXME This method is only public, until OC_L10N does not need it anymore,
- // FIXME This is also the reason, why it is not in the public interface
- public function getL10nFilesForApp($app, $lang) {
- $languageFiles = [];
- $i18nDir = $this->findL10nDir($app);
- $transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';
- if (($this->isSubDirectory($transFile, $this->serverRoot . '/core/l10n/')
- || $this->isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/')
- || $this->isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/'))
- && file_exists($transFile)
- ) {
- // load the translations file
- $languageFiles[] = $transFile;
- }
- // merge with translations from theme
- $theme = $this->config->getSystemValueString('theme');
- if (!empty($theme)) {
- $transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
- if (file_exists($transFile)) {
- $languageFiles[] = $transFile;
- }
- }
- return $languageFiles;
- }
- /**
- * find the l10n directory
- *
- * @param string $app App id or empty string for core
- * @return string directory
- */
- protected function findL10nDir($app = null) {
- if (in_array($app, ['core', 'lib'])) {
- if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
- return $this->serverRoot . '/' . $app . '/l10n/';
- }
- } elseif ($app && \OC_App::getAppPath($app) !== false) {
- // Check if the app is in the app folder
- return \OC_App::getAppPath($app) . '/l10n/';
- }
- return $this->serverRoot . '/core/l10n/';
- }
- /**
- * @inheritDoc
- */
- public function getLanguages(): array {
- $forceLanguage = $this->config->getSystemValue('force_language', false);
- if ($forceLanguage !== false) {
- $l = $this->get('lib', $forceLanguage);
- $potentialName = $l->t('__language_name__');
- return [
- 'commonLanguages' => [[
- 'code' => $forceLanguage,
- 'name' => $potentialName,
- ]],
- 'otherLanguages' => [],
- ];
- }
- $languageCodes = $this->findAvailableLanguages();
- $commonLanguages = [];
- $otherLanguages = [];
- foreach ($languageCodes as $lang) {
- $l = $this->get('lib', $lang);
- // TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
- $potentialName = $l->t('__language_name__');
- if ($l->getLanguageCode() === $lang && $potentialName[0] !== '_') { //first check if the language name is in the translation file
- $ln = [
- 'code' => $lang,
- 'name' => $potentialName
- ];
- } elseif ($lang === 'en') {
- $ln = [
- 'code' => $lang,
- 'name' => 'English (US)'
- ];
- } else { //fallback to language code
- $ln = [
- 'code' => $lang,
- 'name' => $lang
- ];
- }
- // put appropriate languages into appropriate arrays, to print them sorted
- // common languages -> divider -> other languages
- if (in_array($lang, self::COMMON_LANGUAGE_CODES)) {
- $commonLanguages[array_search($lang, self::COMMON_LANGUAGE_CODES)] = $ln;
- } else {
- $otherLanguages[] = $ln;
- }
- }
- ksort($commonLanguages);
- // sort now by displayed language not the iso-code
- usort($otherLanguages, function ($a, $b) {
- if ($a['code'] === $a['name'] && $b['code'] !== $b['name']) {
- // If a doesn't have a name, but b does, list b before a
- return 1;
- }
- if ($a['code'] !== $a['name'] && $b['code'] === $b['name']) {
- // If a does have a name, but b doesn't, list a before b
- return -1;
- }
- // Otherwise compare the names
- return strcmp($a['name'], $b['name']);
- });
- return [
- // reset indexes
- 'commonLanguages' => array_values($commonLanguages),
- 'otherLanguages' => $otherLanguages
- ];
- }
- }
|