Allow to force a language and set it via the ocs api

Signed-off-by: Joas Schilling <coding@schilljs.com>

apps/provisioning_api/lib/Controller/UsersController.php

@@ -286,6 +286,7 @@ class UsersController extends OCSController {
 		$data[AccountManager::PROPERTY_WEBSITE] = $userAccount[AccountManager::PROPERTY_WEBSITE]['value'];
 		$data[AccountManager::PROPERTY_TWITTER] = $userAccount[AccountManager::PROPERTY_TWITTER]['value'];
 		$data['groups'] = $gids;
+		$data['language'] = $this->config->getUserValue($targetUserObject->getUID(), 'core', 'lang');
 
 		return $data;
 	}
@@ -322,6 +323,10 @@ class UsersController extends OCSController {
 			}
 
 			$permittedFields[] = 'password';
+			if ($this->config->getSystemValue('force_language', false) === false ||
+				$this->groupManager->isAdmin($currentLoggedInUser->getUID())) {
+				$permittedFields[] = 'language';
+			}
 
 			if ($this->appManager->isEnabledForUser('federatedfilesharing')) {
 				$federatedFileSharing = new \OCA\FederatedFileSharing\AppInfo\Application();
@@ -348,6 +353,7 @@ class UsersController extends OCSController {
 				$permittedFields[] = AccountManager::PROPERTY_DISPLAYNAME;
 				$permittedFields[] = AccountManager::PROPERTY_EMAIL;
 				$permittedFields[] = 'password';
+				$permittedFields[] = 'language';
 				$permittedFields[] = AccountManager::PROPERTY_PHONE;
 				$permittedFields[] = AccountManager::PROPERTY_ADDRESS;
 				$permittedFields[] = AccountManager::PROPERTY_WEBSITE;
@@ -392,6 +398,13 @@ class UsersController extends OCSController {
 			case 'password':
 				$targetUser->setPassword($value);
 				break;
+			case 'language':
+				$languagesCodes = $this->l10nFactory->findAvailableLanguages();
+				if (!in_array($value, $languagesCodes, true) && $value !== 'en') {
+					throw new OCSException('Invalid language', 102);
+				}
+				$this->config->setUserValue($targetUser->getUID(), 'core', 'lang', $value);
+				break;
 			case AccountManager::PROPERTY_EMAIL:
 				if(filter_var($value, FILTER_VALIDATE_EMAIL)) {
 					$targetUser->setEMailAddress($value);

apps/provisioning_api/tests/Controller/UsersControllerTest.php

@@ -699,6 +699,11 @@ class UsersControllerTest extends TestCase {
 			->method('getUserValue')
 			->with('UID', 'core', 'enabled', 'true')
 			->will($this->returnValue('true'));
+		$this->config
+			->expects($this->at(1))
+			->method('getUserValue')
+			->with('UID', 'core', 'lang')
+			->will($this->returnValue('de'));
 		$this->api
 			->expects($this->once())
 			->method('fillStorageInfo')
@@ -709,7 +714,7 @@ class UsersControllerTest extends TestCase {
 			->method('getDisplayName')
 			->will($this->returnValue('Demo User'));
 		$targetUser
-			->expects($this->exactly(3))
+			->expects($this->exactly(4))
 			->method('getUID')
 			->will($this->returnValue('UID'));
 
@@ -723,7 +728,8 @@ class UsersControllerTest extends TestCase {
 			'address' => 'address',
 			'website' => 'website',
 			'twitter' => 'twitter',
-			'groups' => ['group0', 'group1', 'group2']
+			'groups' => ['group0', 'group1', 'group2'],
+			'language' => 'de',
 		];
 		$this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['UserToGet']));
 	}
@@ -778,6 +784,11 @@ class UsersControllerTest extends TestCase {
 			->method('getUserValue')
 			->with('UID', 'core', 'enabled', 'true')
 			->will($this->returnValue('true'));
+		$this->config
+			->expects($this->at(1))
+			->method('getUserValue')
+			->with('UID', 'core', 'lang')
+			->will($this->returnValue('da'));
 		$this->api
 			->expects($this->once())
 			->method('fillStorageInfo')
@@ -788,7 +799,7 @@ class UsersControllerTest extends TestCase {
 			->method('getDisplayName')
 			->will($this->returnValue('Demo User'));
 		$targetUser
-			->expects($this->exactly(3))
+			->expects($this->exactly(4))
 			->method('getUID')
 			->will($this->returnValue('UID'));
 		$this->accountManager->expects($this->any())->method('getUser')
@@ -812,7 +823,8 @@ class UsersControllerTest extends TestCase {
 			'address' => 'address',
 			'website' => 'website',
 			'twitter' => 'twitter',
-			'groups' => []
+			'groups' => [],
+			'language' => 'da',
 		];
 		$this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['UserToGet']));
 	}
@@ -918,9 +930,14 @@ class UsersControllerTest extends TestCase {
 			->method('getEMailAddress')
 			->will($this->returnValue('subadmin@owncloud.org'));
 		$targetUser
-			->expects($this->exactly(3))
+			->expects($this->exactly(4))
 			->method('getUID')
 			->will($this->returnValue('UID'));
+		$this->config
+			->expects($this->at(0))
+			->method('getUserValue')
+			->with('UID', 'core', 'lang')
+			->will($this->returnValue('ru'));
 		$this->accountManager->expects($this->any())->method('getUser')
 			->with($targetUser)
 			->willReturn(
@@ -941,7 +958,8 @@ class UsersControllerTest extends TestCase {
 			'address' => 'address',
 			'website' => 'website',
 			'twitter' => 'twitter',
-			'groups' => []
+			'groups' => [],
+			'language' => 'ru',
 		];
 		$this->assertEquals($expected, $this->invokePrivate($this->api, 'getUserData', ['subadmin']));
 	}
@@ -1128,7 +1146,7 @@ class UsersControllerTest extends TestCase {
 			->with('UserToEdit')
 			->will($this->returnValue($targetUser));
 		$this->groupManager
-			->expects($this->once())
+			->expects($this->exactly(2))
 			->method('isAdmin')
 			->with('UID')
 			->will($this->returnValue(true));
@@ -1163,7 +1181,7 @@ class UsersControllerTest extends TestCase {
 			->with('UserToEdit')
 			->will($this->returnValue($targetUser));
 		$this->groupManager
-			->expects($this->once())
+			->expects($this->exactly(2))
 			->method('isAdmin')
 			->with('UID')
 			->will($this->returnValue(true));

config/config.sample.php

@@ -163,6 +163,17 @@ $CONFIG = array(
  */
 'default_language' => 'en',
 
+/**
+ * With this setting a language can be forced for all users. If a language is
+ * forced, the users are also unable to change their language in the personal
+ * settings. If users shall be unable to change their language, but users have
+ * different languages, this value can be set to ``true`` instead of a language
+ * code.
+ *
+ * Defaults to ``false``
+ */
+'force_language' => 'en',
+
 /**
  * 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

lib/private/L10N/Factory.php

@@ -99,6 +99,12 @@ class Factory implements IFactory {
 		if ($lang !== null) {
 			$lang = str_replace(array('\0', '/', '\\', '..'), '', (string) $lang);
 		}
+
+		$forceLang = $this->config->getSystemValue('force_language', false);
+		if (is_string($forceLang)) {
+			$lang = $forceLang;
+		}
+
 		if ($lang === null || !$this->languageExists($app, $lang)) {
 			$lang = $this->findLanguage($app);
 		}
@@ -125,7 +131,7 @@ class Factory implements IFactory {
 		}
 
 		/**
-		 * At this point ownCloud might not yet be installed and thus the lookup
+		 * 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
 		 *

settings/Controller/PersonalController.php

@@ -1,87 +0,0 @@
-<?php
-/**
- * @copyright  Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program 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 (at your option) any later version.
- *
- * 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
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- */
-namespace OC\Settings\Controller;
-
-use OCP\AppFramework\Controller;
-use OCP\AppFramework\Http;
-use OCP\AppFramework\Http\JSONResponse;
-use OCP\IConfig;
-use OCP\IL10N;
-use OCP\IRequest;
-use OCP\L10N\IFactory;
-
-class PersonalController extends Controller {
-	/** @var IFactory */
-	private $l10nFactory;
-
-	/** @var string */
-	private $userId;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var IL10N */
-	private $l;
-
-	/**
-	 * PersonalController constructor.
-	 *
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IFactory $l10nFactory
-	 * @param $userId
-	 * @param IConfig $config
-	 * @param IL10N $l
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								IFactory $l10nFactory,
-								$userId,
-								IConfig $config,
-								IL10N $l) {
-		parent::__construct($appName, $request);
-
-		$this->l10nFactory = $l10nFactory;
-		$this->userId = $userId;
-		$this->config = $config;
-		$this->l = $l;
-	}
-
-	/**
-	 * @NoAdminRequired
-	 * @NoSubadminRequired
-	 * @param string $lang
-	 * @return JSONResponse
-	 */
-	public function setLanguage($lang) {
-		if ($lang !== '') {
-			$languagesCodes = $this->l10nFactory->findAvailableLanguages();
-			if (array_search($lang, $languagesCodes) || $lang === 'en') {
-				$this->config->setUserValue($this->userId, 'core', 'lang', $lang);
-				return new JSONResponse([]);
-			}
-		}
-
-		return new JSONResponse(['message' => $this->l->t('Invalid request')], Http::STATUS_BAD_REQUEST);
-	}
-}

settings/js/personal.js

@@ -258,23 +258,31 @@ $(document).ready(function () {
 	});
 	federationSettingsView.render();
 
-	$("#languageinput").change(function () {
+	var updateLanguage = function () {
-		// Serialize the data
+		if (OC.PasswordConfirmation.requiresPasswordConfirmation()) {
-		var post = $("#languageinput").serialize();
+			OC.PasswordConfirmation.requirePasswordConfirmation(updateLanguage);
-		// Ajax foo
+			return;
-		$.ajax(
+		}
-			'ajax/setlanguage.php',
+
-			{
+		var selectedLang = $("#languageinput").val(),
-				method: 'POST',
+			user = OC.getCurrentUser();
-				data: post
+
+		$.ajax({
+			url: OC.linkToOCS('cloud/users', 2) + user['uid'],
+			method: 'PUT',
+			data: {
+				key: 'language',
+				value: selectedLang
+			},
+			success: function() {
+				location.reload();
+			},
+			fail: function() {
+				OC.Notification.showTemporary(t('settings', 'An error occured while changing your language. Please reload the page and try again.'));
 			}
-		).done(function() {
-			location.reload();
-		}).fail(function(jqXHR) {
-			$('#passworderror').text(jqXHR.responseJSON.message);
 		});
-		return false;
+	};
-	});
+	$("#languageinput").change(updateLanguage);
 
 	var uploadparms = {
 		pasteZone: null,

settings/personal.php

@@ -73,63 +73,66 @@ $storageInfo=OC_Helper::getStorageInfo('/');
 
 $user = OC::$server->getUserManager()->get(OC_User::getUser());
 
-$userLang=$config->getUserValue( OC_User::getUser(), 'core', 'lang', \OC::$server->getL10NFactory()->findLanguage() );
+$forceLanguage = $config->getSystemValue('force_language', false);
-$languageCodes = \OC::$server->getL10NFactory()->findAvailableLanguages();
+if ($forceLanguage === false) {
+	$userLang=$config->getUserValue( OC_User::getUser(), 'core', 'lang', \OC::$server->getL10NFactory()->findLanguage() );
+	$languageCodes = \OC::$server->getL10NFactory()->findAvailableLanguages();
 
-// array of common languages
+	// array of common languages
-$commonLangCodes = array(
+	$commonLangCodes = array(
-	'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'
+		'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'
-);
+	);
 
-$languages=array();
+	$languages=array();
-$commonLanguages = array();
+	$commonLanguages = array();
-foreach($languageCodes as $lang) {
+	foreach($languageCodes as $lang) {
-	$l = \OC::$server->getL10N('settings', $lang);
+		$l = \OC::$server->getL10N('settings', $lang);
-	// TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
+		// TRANSLATORS this is the language name for the language switcher in the personal settings and should be the localized version
-	$potentialName = (string) $l->t('__language_name__');
+		$potentialName = (string) $l->t('__language_name__');
-	if($l->getLanguageCode() === $lang && substr($potentialName, 0, 1) !== '_') {//first check if the language name is in the translation file
+		if($l->getLanguageCode() === $lang && substr($potentialName, 0, 1) !== '_') {//first check if the language name is in the translation file
-		$ln = array('code' => $lang, 'name' => $potentialName);
+			$ln = array('code' => $lang, 'name' => $potentialName);
-	} elseif ($lang === 'en') {
+		} elseif ($lang === 'en') {
-		$ln = ['code' => $lang, 'name' => 'English (US)'];
+			$ln = ['code' => $lang, 'name' => 'English (US)'];
-	}else{//fallback to language code
+		}else{//fallback to language code
-		$ln=array('code'=>$lang, 'name'=>$lang);
+			$ln=array('code'=>$lang, 'name'=>$lang);
+		}
+
+		// put appropriate languages into appropriate arrays, to print them sorted
+		// used language -> common languages -> divider -> other languages
+		if ($lang === $userLang) {
+			$userLang = $ln;
+		} elseif (in_array($lang, $commonLangCodes)) {
+			$commonLanguages[array_search($lang, $commonLangCodes)]=$ln;
+		} else {
+			$languages[]=$ln;
+		}
 	}
 
-	// put appropriate languages into appropriate arrays, to print them sorted
+	// if user language is not available but set somehow: show the actual code as name
-	// used language -> common languages -> divider -> other languages
+	if (!is_array($userLang)) {
-	if ($lang === $userLang) {
+		$userLang = [
-		$userLang = $ln;
+			'code' => $userLang,
-	} elseif (in_array($lang, $commonLangCodes)) {
+			'name' => $userLang,
-		$commonLanguages[array_search($lang, $commonLangCodes)]=$ln;
+		];
-	} else {
-		$languages[]=$ln;
 	}
+
+	ksort($commonLanguages);
+
+	// sort now by displayed language not the iso-code
+	usort( $languages, 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']);
+	});
 }
 
-// if user language is not available but set somehow: show the actual code as name
-if (!is_array($userLang)) {
-	$userLang = [
-		'code' => $userLang,
-		'name' => $userLang,
-	];
-}
-
-ksort($commonLanguages);
-
-// sort now by displayed language not the iso-code
-usort( $languages, 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']);
-});
-
 //links to clients
 $clients = array(
 	'desktop' => $config->getSystemValue('customclient_desktop', $defaults->getSyncClientUrl()),
@@ -165,9 +168,11 @@ $tmpl->assign('usage_relative', $storageInfo['relative']);
 $tmpl->assign('quota', $storageInfo['quota']);
 $tmpl->assign('clients', $clients);
 $tmpl->assign('email', $userData[\OC\Accounts\AccountManager::PROPERTY_EMAIL]['value']);
-$tmpl->assign('languages', $languages);
+if ($forceLanguage === false) {
-$tmpl->assign('commonlanguages', $commonLanguages);
+	$tmpl->assign('languages', $languages);
-$tmpl->assign('activelanguage', $userLang);
+	$tmpl->assign('commonlanguages', $commonLanguages);
+	$tmpl->assign('activelanguage', $userLang);
+}
 $tmpl->assign('passwordChangeSupported', OC_User::canUserChangePassword(OC_User::getUser()));
 $tmpl->assign('displayNameChangeSupported', OC_User::canUserChangeDisplayName(OC_User::getUser()));
 $tmpl->assign('displayName', $userData[\OC\Accounts\AccountManager::PROPERTY_DISPLAYNAME]['value']);

settings/routes.php

@@ -69,7 +69,6 @@ $application->registerRoutes($this, [
 		['name' => 'AdminSettings#form', 'url' => '/settings/admin/{section}', 'verb' => 'GET'],
 		['name' => 'ChangePassword#changePersonalPassword', 'url' => '/settings/personal/changepassword', 'verb' => 'POST'],
 		['name' => 'ChangePassword#changeUserPassword', 'url' => '/settings/users/changepassword', 'verb' => 'POST'],
-		['name' => 'Personal#setLanguage', 'url' => '/settings/ajax/setlanguage.php', 'verb' => 'POST'],
 		['name' => 'Groups#index', 'url' => '/settings/users/groups', 'verb' => 'GET'],
 		['name' => 'Groups#show', 'url' => '/settings/users/groups/{id}', 'requirements' => ['id' => '[^?]*'], 'verb' => 'GET'],
 		['name' => 'Groups#create', 'url' => '/settings/users/groups', 'verb' => 'POST'],

settings/templates/personal.php

@@ -292,6 +292,7 @@ if($_['passwordChangeSupported']) {
 }
 ?>
 
+<?php if (isset($_['activelanguage'])) { ?>
 <form id="language" class="section">
 	<h2>
 		<label for="languageinput"><?php p($l->t('Language'));?></label>
@@ -317,6 +318,7 @@ if($_['passwordChangeSupported']) {
 		<em><?php p($l->t('Help translate'));?></em>
 	</a>
 </form>
+<?php } ?>
 
 
 <?php if(OC_APP::isEnabled('firstrunwizard')) {?>

tests/Settings/Controller/PersonalControllerTest.php

@@ -1,122 +0,0 @@
-<?php
-/**
- *
- *
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program 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 (at your option) any later version.
- *
- * 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
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- */
-namespace Test\Settings\Controller;
-
-use OC\Settings\Controller\PersonalController;
-use OCP\AppFramework\Http;
-use OCP\AppFramework\Http\JSONResponse;
-use OCP\IConfig;
-use OCP\IL10N;
-use OCP\IRequest;
-use OCP\L10N\IFactory;
-
-class PersonalControllerTest extends \Test\TestCase {
-
-	/** @var IFactory|\PHPUnit_Framework_MockObject_MockObject */
-	private $l10nFactory;
-	/** @var IConfig|\PHPUnit_Framework_MockObject_MockObject */
-	private $config;
-	/** @var PersonalController */
-	private $controller;
-	/** @var IL10N */
-	private $l;
-
-	public function setUp() {
-		parent::setUp();
-
-		$this->l10nFactory = $this->createMock(IFactory::class);
-		$this->config = $this->createMock(IConfig::class);
-		$this->l = $this->createMock(IL10N::class);
-
-		$this->l->method('t')
-			->will($this->returnCallback(function ($text, $parameters = []) {
-				return vsprintf($text, $parameters);
-			}));
-
-		$this->controller = new PersonalController(
-			'settings',
-			$this->createMock(IRequest::class),
-			$this->l10nFactory,
-			'user',
-			$this->config,
-			$this->l
-		);
-	}
-
-	public function testSetLanguage() {
-		$this->l10nFactory->method('findAvailableLanguages')
-			->willReturn(['aa', 'bb', 'cc']);
-		$this->config->expects($this->once())
-			->method('setUserValue')
-			->with(
-				$this->equalTo('user'),
-				$this->equalTo('core'),
-				$this->equalTo('lang'),
-				$this->equalTo('bb')
-			);
-
-		$resp = $this->controller->setLanguage('bb');
-		$expected = new JSONResponse([]);
-		$this->assertEquals($expected, $resp);
-	}
-
-	public function testSetLanguageEn() {
-		$this->l10nFactory->method('findAvailableLanguages')
-			->willReturn(['aa', 'bb', 'cc']);
-		$this->config->expects($this->once())
-			->method('setUserValue')
-			->with(
-				$this->equalTo('user'),
-				$this->equalTo('core'),
-				$this->equalTo('lang'),
-				$this->equalTo('en')
-			);
-
-		$resp = $this->controller->setLanguage('en');
-		$expected = new JSONResponse([]);
-		$this->assertEquals($expected, $resp);
-	}
-
-	public function testSetLanguageFails() {
-		$this->l10nFactory->method('findAvailableLanguages')
-			->willReturn(['aa', 'bb', 'cc']);
-		$this->config->expects($this->never())
-			->method('setUserValue');
-
-		$resp = $this->controller->setLanguage('dd');
-		$expected = new JSONResponse(['message' => 'Invalid request'], Http::STATUS_BAD_REQUEST);
-		$this->assertEquals($expected, $resp);
-	}
-
-
-	public function testSetLanguageEmpty() {
-		$this->l10nFactory->method('findAvailableLanguages')
-			->willReturn(['aa', 'bb', 'cc']);
-		$this->config->expects($this->never())
-			->method('setUserValue');
-
-		$resp = $this->controller->setLanguage('');
-		$expected = new JSONResponse(['message' => 'Invalid request'], Http::STATUS_BAD_REQUEST);
-		$this->assertEquals($expected, $resp);
-	}
-}