Merge pull request #5623 from nextcloud/locale-setting

Add user locale/region setting

apps/provisioning_api/lib/Controller/AUserData.php

@@ -123,6 +123,7 @@ protected function getUserData(string $userId): array {
 		$data[AccountManager::PROPERTY_TWITTER] = $userAccount[AccountManager::PROPERTY_TWITTER]['value'];
 		$data['groups'] = $gids;
 		$data['language'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'lang');
+		$data['locale'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'locale');
 
 		return $data;
     }

apps/provisioning_api/lib/Controller/UsersController.php

@@ -13,6 +13,7 @@
  * @author Thomas Müller <thomas.mueller@tmit.eu>
  * @author Tom Needham <tom@owncloud.com>
  * @author John Molakvoæ <skjnldsv@protonmail.com>
+ * @author Thomas Citharel <tcit@tcit.fr>
  *
  * @license AGPL-3.0
  *
@@ -430,6 +431,11 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 				$permittedFields[] = 'language';
 			}
 
+			if ($this->config->getSystemValue('force_locale', false) === false ||
+				$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
+				$permittedFields[] = 'locale';
+			}
+
 			if ($this->appManager->isEnabledForUser('federatedfilesharing')) {
 				$federatedFileSharing = new \OCA\FederatedFileSharing\AppInfo\Application();
 				$shareProvider = $federatedFileSharing->getFederatedShareProvider();
@@ -456,6 +462,7 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 				$permittedFields[] = AccountManager::PROPERTY_EMAIL;
 				$permittedFields[] = 'password';
 				$permittedFields[] = 'language';
+				$permittedFields[] = 'locale';
 				$permittedFields[] = AccountManager::PROPERTY_PHONE;
 				$permittedFields[] = AccountManager::PROPERTY_ADDRESS;
 				$permittedFields[] = AccountManager::PROPERTY_WEBSITE;
@@ -505,6 +512,12 @@ public function editUser(string $userId, string $key, string $value): DataRespon
 				}
 				$this->config->setUserValue($targetUser->getUID(), 'core', 'lang', $value);
 				break;
+			case 'locale':
+				if (!$this->l10nFactory->localeExists($value)) {
+					throw new OCSException('Invalid locale', 102);
+				}
+				$this->config->setUserValue($targetUser->getUID(), 'core', 'locale', $value);
+				break;
 			case AccountManager::PROPERTY_EMAIL:
 				if (filter_var($value, FILTER_VALIDATE_EMAIL) || $value === '') {
 					$targetUser->setEMailAddress($value);

apps/provisioning_api/tests/Controller/UsersControllerTest.php

@@ -760,7 +760,7 @@ public function testGetUserDataAsAdmin() {
 			->method('getBackendClassName')
 			->will($this->returnValue('Database'));
 		$targetUser
-			->expects($this->exactly(5))
+			->expects($this->exactly(6))
 			->method('getUID')
 			->will($this->returnValue('UID'));
 
@@ -780,6 +780,7 @@ public function testGetUserDataAsAdmin() {
 			'twitter' => 'twitter',
 			'groups' => ['group0', 'group1', 'group2'],
 			'language' => 'de',
+			'locale' => null,
 		];
 		$this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['UID']));
 	}
@@ -865,7 +866,7 @@ public function testGetUserDataAsSubAdminAndUserIsAccessible() {
 			->method('getBackendClassName')
 			->will($this->returnValue('Database'));
 		$targetUser
-			->expects($this->exactly(5))
+			->expects($this->exactly(6))
 			->method('getUID')
 			->will($this->returnValue('UID'));
 		$this->accountManager->expects($this->any())->method('getUser')
@@ -895,6 +896,7 @@ public function testGetUserDataAsSubAdminAndUserIsAccessible() {
 			'twitter' => 'twitter',
 			'groups' => [],
 			'language' => 'da',
+			'locale' => null,
 		];
 		$this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['UID']));
 	}
@@ -1004,7 +1006,7 @@ public function testGetUserDataAsSubAdminSelfLookup() {
 			->method('getEMailAddress')
 			->will($this->returnValue('subadmin@nextcloud.com'));
 		$targetUser
-			->expects($this->exactly(5))
+			->expects($this->exactly(6))
 			->method('getUID')
 			->will($this->returnValue('UID'));
 		$targetUser
@@ -1050,6 +1052,7 @@ public function testGetUserDataAsSubAdminSelfLookup() {
 			'twitter' => 'twitter',
 			'groups' => [],
 			'language' => 'ru',
+			'locale' => null,
 		];
 		$this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['UID']));
 	}
@@ -1236,7 +1239,7 @@ public function testEditUserAdminUserSelfEditChangeValidQuota() {
 			->with('UserToEdit')
 			->will($this->returnValue($targetUser));
 		$this->groupManager
-			->expects($this->exactly(2))
+			->expects($this->exactly(3))
 			->method('isAdmin')
 			->with('UID')
 			->will($this->returnValue(true));
@@ -1271,7 +1274,7 @@ public function testEditUserAdminUserSelfEditChangeInvalidQuota() {
 			->with('UserToEdit')
 			->will($this->returnValue($targetUser));
 		$this->groupManager
-			->expects($this->exactly(2))
+			->expects($this->exactly(3))
 			->method('isAdmin')
 			->with('UID')
 			->will($this->returnValue(true));

config/config.sample.php

@@ -178,6 +178,29 @@
  */
 'force_language' => 'en',
 
+/**
+ * This sets the default locale on your Nextcloud server, using ISO_639
+ * language codes such as ``en`` for English, ``de`` for German, and ``fr`` for
+ * French, and ISO-3166 country codes such as ``GB``, ``US``, ``CA``, as defined
+ * in RFC 5646. It overrides automatic locale detection on public pages like
+ * login or shared items. User's locale preferences configured under "personal
+ * -> locale" override this setting after they have logged in.
+ *
+ * Defaults to ``en``
+ */
+'default_locale' => 'en_US',
+
+/**
+ * With this setting a locale can be forced for all users. If a locale is
+ * forced, the users are also unable to change their locale in the personal
+ * settings. If users shall be unable to change their locale, but users have
+ * different languages, this value can be set to ``true`` instead of a locale
+ * code.
+ *
+ * Defaults to ``false``
+ */
+'force_locale' => 'en_US',
+
 /**
  * Set the default app to open on login. Use the app names as they appear in the
  * URL after clicking them in the Apps menu, such as documents, calendar, and

core/css/icons.scss

@@ -402,6 +402,10 @@ img, object, video, button, textarea, input, select, div[contenteditable='true']
 	background-image: url('../img/actions/tag.svg?v=1');
 }
 
+.icon-timezone {
+	background-image: url('../img/actions/timezone.svg?v=1');
+}
+
 .icon-toggle {
 	background-image: url('../img/actions/toggle.svg?v=1');
 }

core/js/js.js

@@ -791,6 +791,15 @@ var OCP = {},
 	 * @return {String} locale string
 	 */
 	getLocale: function() {
+		return $('html').data('locale');
+	},
+
+	/**
+	 * Returns the user's language
+	 *
+	 * @returns {String} language string
+	 */
+	getLanguage: function () {
 		return $('html').prop('lang');
 	},
 

core/templates/layout.user.php

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html class="ng-csp" data-placeholder-focus="false" lang="<?php p($_['language']); ?>" >
+<html class="ng-csp" data-placeholder-focus="false" lang="<?php p($_['language']); ?>" data-locale="<?php p($_['locale']); ?>" >
 	<head data-user="<?php p($_['user_uid']); ?>" data-user-displayname="<?php p($_['user_displayname']); ?>" data-requesttoken="<?php p($_['requesttoken']); ?>">
 		<meta charset="utf-8">
 		<title>

lib/private/L10N/Factory.php

@@ -54,6 +54,11 @@ class Factory implements IFactory {
 	 */
 	protected $availableLanguages = [];
 
+	/**
+	 * @var array
+	 */
+	protected $availableLocales = [];
+
 	/**
 	 * @var array Structure: string => callable
 	 */
@@ -97,9 +102,10 @@ public function __construct(IConfig $config,
 	 *
 	 * @param string $app
 	 * @param string|null $lang
+	 * @param string|null $locale
 	 * @return \OCP\IL10N
 	 */
-	public function get($app, $lang = null) {
+	public function get($app, $lang = null, $locale = null) {
 		$app = \OC_App::cleanAppId($app);
 		if ($lang !== null) {
 			$lang = str_replace(array('\0', '/', '\\', '..'), '', (string) $lang);
@@ -110,13 +116,22 @@ public function get($app, $lang = null) {
 			$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,
+				$this, $app, $lang, $locale,
 				$this->getL10nFilesForApp($app, $lang)
 			);
 		}
@@ -185,6 +200,48 @@ public function findLanguage($app = null) {
 		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 all available languages for an app
 	 *
@@ -236,6 +293,20 @@ public function findAvailableLanguages($app = null) {
 		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
@@ -250,6 +321,23 @@ public function languageExists($app, $lang) {
 		return array_search($lang, $languages) !== false;
 	}
 
+	/**
+	 * @param string $locale
+	 * @return bool
+	 */
+	public function localeExists($locale) {
+		if ($locale === 'en') { //english is always available
+			return true;
+		}
+
+		$locales = $this->findAvailableLocales();
+		$userLocale = array_filter($locales, function($value) use ($locale) {
+			return $locale === $value['code'];
+		});
+
+		return !empty($userLocale);
+	}
+
 	/**
 	 * @param string|null $app
 	 * @return string