nextcloud / server

lib/private/L10N/Factory.php

Indentation +617 added lines, -617 removed lines

@@ -53,621 +53,621 @@
  */
 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 $userSession;
-
-	/** @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,
-		$serverRoot
-	) {
-		$this->config = $config;
-		$this->request = $request;
-		$this->userSession = $userSession;
-		$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->getSystemValue('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->getSystemValue('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->getSystemValue('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';
-		}
-
-		// 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->getSystemValue('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;
-		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->getSystemValue('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 (strpos($sub, '..') !== false) {
-			return false;
-		}
-
-		// Check whether $sub is a subdirectory of $parent
-		if (strpos($sub, $parent) === 0) {
-			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->getSystemValue('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
-		];
-	}
+    /** @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 $userSession;
+
+    /** @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,
+        $serverRoot
+    ) {
+        $this->config = $config;
+        $this->request = $request;
+        $this->userSession = $userSession;
+        $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->getSystemValue('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->getSystemValue('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->getSystemValue('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';
+        }
+
+        // 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->getSystemValue('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;
+        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->getSystemValue('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 (strpos($sub, '..') !== false) {
+            return false;
+        }
+
+        // Check whether $sub is a subdirectory of $parent
+        if (strpos($sub, $parent) === 0) {
+            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->getSystemValue('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
+        ];
+    }
 }

Spacing +15 added lines, -15 removed lines

@@ -126,7 +126,7 @@ 
 	 * @return \OCP\IL10N
 	 */
 	public function get($app, $lang = null, $locale = null) {
-		return new LazyL10N(function () use ($app, $lang, $locale) {
+		return new LazyL10N(function() use ($app, $lang, $locale) {
 			$app = \OC_App::cleanAppId($app);
 			if ($lang !== null) {
 				$lang = str_replace(['\0', '/', '\\', '..'], '', $lang);
@@ -191,7 +191,7 @@ 
 		 * @link https://github.com/owncloud/core/issues/21955
 		 */
 		if ($this->config->getSystemValue('installed', false)) {
-			$userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() :  null;
+			$userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() : null;
 			if (!is_null($userId)) {
 				$userLang = $this->config->getUserValue($userId, 'core', 'lang', null);
 			} else {
@@ -278,7 +278,7 @@ 
 		}
 
 		if ($this->config->getSystemValue('installed', false)) {
-			$userId = null !== $this->userSession->getUser() ? $this->userSession->getUser()->getUID() :  null;
+			$userId = null !== $this->userSession->getUser() ? $this->userSession->getUser()->getUID() : null;
 			$userLocale = null;
 			if (null !== $userId) {
 				$userLocale = $this->config->getUserValue($userId, 'core', 'locale', null);
@@ -359,7 +359,7 @@ 
 		// merge with translations from theme
 		$theme = $this->config->getSystemValue('theme');
 		if (!empty($theme)) {
-			$themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot));
+			$themeDir = $this->serverRoot.'/themes/'.$theme.substr($dir, strlen($this->serverRoot));
 
 			if (is_dir($themeDir)) {
 				$files = scandir($themeDir);
@@ -385,7 +385,7 @@ 
 			return $this->availableLocales;
 		}
 
-		$localeData = file_get_contents(\OC::$SERVERROOT . '/resources/locales.json');
+		$localeData = file_get_contents(\OC::$SERVERROOT.'/resources/locales.json');
 		$this->availableLocales = \json_decode($localeData, true);
 
 		return $this->availableLocales;
@@ -554,11 +554,11 @@ 
 		$languageFiles = [];
 
 		$i18nDir = $this->findL10nDir($app);
-		$transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json';
+		$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/'))
+		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
@@ -568,7 +568,7 @@ 
 		// merge with translations from theme
 		$theme = $this->config->getSystemValue('theme');
 		if (!empty($theme)) {
-			$transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot));
+			$transFile = $this->serverRoot.'/themes/'.$theme.substr($transFile, strlen($this->serverRoot));
 			if (file_exists($transFile)) {
 				$languageFiles[] = $transFile;
 			}
@@ -585,14 +585,14 @@ 
 	 */
 	protected function findL10nDir($app = null) {
 		if (in_array($app, ['core', 'lib'])) {
-			if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) {
-				return $this->serverRoot . '/' . $app . '/l10n/';
+			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 \OC_App::getAppPath($app).'/l10n/';
 		}
-		return $this->serverRoot . '/core/l10n/';
+		return $this->serverRoot.'/core/l10n/';
 	}
 
 	/**
@@ -651,7 +651,7 @@ 
 		ksort($commonLanguages);
 
 		// sort now by displayed language not the iso-code
-		usort($otherLanguages, function ($a, $b) {
+		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;

lib/public/L10N/IFactory.php

Indentation +121 added lines, -121 removed lines

@@ -38,125 +38,125 @@
  * @since 8.2.0
  */
 interface IFactory {
-	/**
-	 * Get a language instance
-	 *
-	 * @param string $app
-	 * @param string|null $lang
-	 * @param string|null $locale
-	 * @return \OCP\IL10N
-	 * @since 8.2.0
-	 */
-	public function get($app, $lang = null, $locale = null);
-
-	/**
-	 * Find the best language for the context of the current user
-	 *
-	 * This method will try to find the most specific language based on info
-	 * from the user who is logged into the current process and will fall
-	 * back to system settings and heuristics otherwise.
-	 *
-	 * @param string|null $appId specify if you only want a language a specific app supports
-	 *
-	 * @return string language code, defaults to 'en' if no other matches are found
-	 * @since 9.0.0
-	 */
-	public function findLanguage(?string $appId = null): string;
-
-	/**
-	 * Try to find the best language for generic tasks
-	 *
-	 * This method will try to find the most generic language based on system
-	 * settings, independent of the user logged into the current process. This
-	 * is useful for tasks that are run for another user. E.g. the current user
-	 * sends an email to someone else, then we don't want the current user's
-	 * language to be picked but rather a instance-wide default that likely fits
-	 * the target user
-	 *
-	 * @param string|null $appId specify if you only want a language a specific app supports
-	 *
-	 * @return string language code, defaults to 'en' if no other matches are found
-	 * @since 23.0.0
-	 */
-	public function findGenericLanguage(string $appId = null): string;
-
-	/**
-	 * @param string|null $lang user language as default locale
-	 * @return string locale If nothing works it returns 'en_US'
-	 * @since 14.0.0
-	 */
-	public function findLocale($lang = null);
-
-	/**
-	 * find the matching lang from the locale
-	 *
-	 * @param string $app
-	 * @param string $locale
-	 * @return null|string
-	 * @since 14.0.1
-	 */
-	public function findLanguageFromLocale(string $app = 'core', string $locale = null);
-
-	/**
-	 * Find all available languages for an app
-	 *
-	 * @param string|null $app App id or null for core
-	 * @return string[] an array of available languages
-	 * @since 9.0.0
-	 */
-	public function findAvailableLanguages($app = null): array;
-
-	/**
-	 * @return array an array of available
-	 * @since 14.0.0
-	 */
-	public function findAvailableLocales();
-
-	/**
-	 * @param string|null $app App id or null for core
-	 * @param string $lang
-	 * @return bool
-	 * @since 9.0.0
-	 */
-	public function languageExists($app, $lang);
-
-	/**
-	 * @param string $locale
-	 * @return bool
-	 * @since 14.0.0
-	 */
-	public function localeExists($locale);
-
-	/**
-	 * iterate through language settings (if provided) in this order:
-	 * 1. returns the forced language or:
-	 * 2. if applicable, the trunk of 1 (e.g. "fu" instead of "fu_BAR"
-	 * 3. returns the user language or:
-	 * 4. if applicable, the trunk of 3
-	 * 5. returns the system default language or:
-	 * 6. if applicable, the trunk of 5
-	 * 7+∞. returns 'en'
-	 *
-	 * Hint: in most cases findLanguage() suits you fine
-	 *
-	 * @since 14.0.0
-	 */
-	public function getLanguageIterator(IUser $user = null): ILanguageIterator;
-
-	/**
-	 * returns the common language and other languages in an
-	 * associative array
-	 *
-	 * @since 23.0.0
-	 */
-	public function getLanguages(): array;
-
-	/**
-	 * 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;
+    /**
+     * Get a language instance
+     *
+     * @param string $app
+     * @param string|null $lang
+     * @param string|null $locale
+     * @return \OCP\IL10N
+     * @since 8.2.0
+     */
+    public function get($app, $lang = null, $locale = null);
+
+    /**
+     * Find the best language for the context of the current user
+     *
+     * This method will try to find the most specific language based on info
+     * from the user who is logged into the current process and will fall
+     * back to system settings and heuristics otherwise.
+     *
+     * @param string|null $appId specify if you only want a language a specific app supports
+     *
+     * @return string language code, defaults to 'en' if no other matches are found
+     * @since 9.0.0
+     */
+    public function findLanguage(?string $appId = null): string;
+
+    /**
+     * Try to find the best language for generic tasks
+     *
+     * This method will try to find the most generic language based on system
+     * settings, independent of the user logged into the current process. This
+     * is useful for tasks that are run for another user. E.g. the current user
+     * sends an email to someone else, then we don't want the current user's
+     * language to be picked but rather a instance-wide default that likely fits
+     * the target user
+     *
+     * @param string|null $appId specify if you only want a language a specific app supports
+     *
+     * @return string language code, defaults to 'en' if no other matches are found
+     * @since 23.0.0
+     */
+    public function findGenericLanguage(string $appId = null): string;
+
+    /**
+     * @param string|null $lang user language as default locale
+     * @return string locale If nothing works it returns 'en_US'
+     * @since 14.0.0
+     */
+    public function findLocale($lang = null);
+
+    /**
+     * find the matching lang from the locale
+     *
+     * @param string $app
+     * @param string $locale
+     * @return null|string
+     * @since 14.0.1
+     */
+    public function findLanguageFromLocale(string $app = 'core', string $locale = null);
+
+    /**
+     * Find all available languages for an app
+     *
+     * @param string|null $app App id or null for core
+     * @return string[] an array of available languages
+     * @since 9.0.0
+     */
+    public function findAvailableLanguages($app = null): array;
+
+    /**
+     * @return array an array of available
+     * @since 14.0.0
+     */
+    public function findAvailableLocales();
+
+    /**
+     * @param string|null $app App id or null for core
+     * @param string $lang
+     * @return bool
+     * @since 9.0.0
+     */
+    public function languageExists($app, $lang);
+
+    /**
+     * @param string $locale
+     * @return bool
+     * @since 14.0.0
+     */
+    public function localeExists($locale);
+
+    /**
+     * iterate through language settings (if provided) in this order:
+     * 1. returns the forced language or:
+     * 2. if applicable, the trunk of 1 (e.g. "fu" instead of "fu_BAR"
+     * 3. returns the user language or:
+     * 4. if applicable, the trunk of 3
+     * 5. returns the system default language or:
+     * 6. if applicable, the trunk of 5
+     * 7+∞. returns 'en'
+     *
+     * Hint: in most cases findLanguage() suits you fine
+     *
+     * @since 14.0.0
+     */
+    public function getLanguageIterator(IUser $user = null): ILanguageIterator;
+
+    /**
+     * returns the common language and other languages in an
+     * associative array
+     *
+     * @since 23.0.0
+     */
+    public function getLanguages(): array;
+
+    /**
+     * 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;
 }