Merge pull request #1046 from nextcloud/enh/987/map-language

Map the user language

Author: julien-nc

lib/Command/UpsertProvider.php

@@ -59,6 +59,10 @@ class UpsertProvider extends Base {
 			'shortcut' => null, 'mode' => InputOption::VALUE_REQUIRED, 'setting_key' => ProviderService::SETTING_EXTRA_CLAIMS,
 			'description' => 'Extra claims to request when getting tokens',
 		],
+		'mapping-language' => [
+			'shortcut' => null, 'mode' => InputOption::VALUE_REQUIRED, 'setting_key' => ProviderService::SETTING_MAPPING_LANGUAGE,
+			'description' => 'Attribute mapping of the account language',
+		],
 		'mapping-website' => [
 			'shortcut' => null, 'mode' => InputOption::VALUE_REQUIRED, 'setting_key' => ProviderService::SETTING_MAPPING_WEBSITE,
 			'description' => 'Attribute mapping of the website',

lib/Service/ProviderService.php

@@ -26,6 +26,7 @@ class ProviderService {
 	public const SETTING_MAPPING_EMAIL = 'mappingEmail';
 	public const SETTING_MAPPING_QUOTA = 'mappingQuota';
 	public const SETTING_MAPPING_GROUPS = 'mappingGroups';
+	public const SETTING_MAPPING_LANGUAGE = 'mappingLanguage';
 	public const SETTING_MAPPING_ADDRESS = 'mappingAddress';
 	public const SETTING_MAPPING_STREETADDRESS = 'mappingStreetaddress';
 	public const SETTING_MAPPING_POSTALCODE = 'mappingPostalcode';
@@ -140,6 +141,7 @@ private function getSupportedSettings(): array {
 			self::SETTING_MAPPING_QUOTA,
 			self::SETTING_MAPPING_UID,
 			self::SETTING_MAPPING_GROUPS,
+			self::SETTING_MAPPING_LANGUAGE,
 			self::SETTING_MAPPING_ADDRESS,
 			self::SETTING_MAPPING_STREETADDRESS,
 			self::SETTING_MAPPING_POSTALCODE,

lib/Service/ProvisioningService.php

@@ -24,6 +24,7 @@
 use OCP\ISession;
 use OCP\IUser;
 use OCP\IUserManager;
+use OCP\L10N\IFactory;
 use OCP\User\Events\UserChangedEvent;
 use Psr\Log\LoggerInterface;
 use Throwable;
@@ -43,6 +44,7 @@ public function __construct(
 		private IAvatarManager $avatarManager,
 		private IConfig $config,
 		private ISession $session,
+		private IFactory $l10nFactory,
 	) {
 	}
 
@@ -77,6 +79,9 @@ public function provisionUser(string $tokenUserId, int $providerId, object $idTo
 		$quotaAttribute = $this->providerService->getSetting($providerId, ProviderService::SETTING_MAPPING_QUOTA, 'quota');
 		$quota = $idTokenPayload->{$quotaAttribute} ?? null;
 
+		$languageAttribute = $this->providerService->getSetting($providerId, ProviderService::SETTING_MAPPING_LANGUAGE, 'language');
+		$language = $idTokenPayload->{$languageAttribute} ?? null;
+
 		$genderAttribute = $this->providerService->getSetting($providerId, ProviderService::SETTING_MAPPING_GENDER, 'gender');
 		$gender = $idTokenPayload->{$genderAttribute} ?? null;
 
@@ -236,6 +241,19 @@ public function provisionUser(string $tokenUserId, int $providerId, object $idTo
 			$account->setProperty('phone', $event->getValue(), $defaultScopes[IAccountManager::PROPERTY_PHONE] ?? $fallbackScope, '1', '');
 		}
 
+		$event = new AttributeMappedEvent(ProviderService::SETTING_MAPPING_LANGUAGE, $idTokenPayload, $language);
+		$this->eventDispatcher->dispatchTyped($event);
+		$this->logger->debug('Language mapping event dispatched');
+		if ($event->hasValue()) {
+			$language = $event->getValue();
+			$languagesCodes = $this->l10nFactory->findAvailableLanguages();
+			if (in_array($language, $languagesCodes, true) || $language === 'en') {
+				$this->config->setUserValue($user->getUID(), 'core', 'lang', $language);
+			} else {
+				$this->logger->debug('Invalid language in ID token', ['language' => $language]);
+			}
+		}
+
 		$addressParts = null;
 		if (is_object($address)) {
 			// Update the location/address

src/components/SettingsForm.vue

@@ -129,6 +129,13 @@
 					type="text"
 					placeholder="phone_number">
 			</p>
+			<p>
+				<label for="mapping-language">{{ t('user_oidc', 'Language mapping') }}</label>
+				<input id="mapping-language"
+					v-model="localProvider.settings.mappingLanguage"
+					type="text"
+					placeholder="language">
+			</p>
 			<p>
 				<label for="mapping-role">{{ t('user_oidc', 'Role/Title mapping') }}</label>
 				<input id="mapping-role"

tests/unit/Service/ProviderServiceTest.php

@@ -65,6 +65,7 @@ public function testGetProvidersWithSettings() {
 					'mappingQuota' => '1',
 					'mappingUid' => '1',
 					'mappingGroups' => '1',
+					'mappingLanguage' => '1',
 					'mappingAddress' => '1',
 					'mappingStreetaddress' => '1',
 					'mappingPostalcode' => '1',
@@ -105,6 +106,7 @@ public function testGetProvidersWithSettings() {
 					'mappingQuota' => '1',
 					'mappingUid' => '1',
 					'mappingGroups' => '1',
+					'mappingLanguage' => '1',
 					'mappingAddress' => '1',
 					'mappingStreetaddress' => '1',
 					'mappingPostalcode' => '1',
@@ -149,6 +151,7 @@ public function testSetSettings() {
 			'extraClaims' => 'claim1 claim2',
 			'providerBasedId' => false,
 			'groupProvisioning' => true,
+			'mappingLanguage' => 'language',
 			'mappingAddress' => 'address',
 			'mappingStreetaddress' => 'street_address',
 			'mappingPostalcode' => 'postal_code',
@@ -176,6 +179,7 @@ public function testSetSettings() {
 				[Application::APP_ID, 'provider-1-' . ProviderService::SETTING_MAPPING_QUOTA, '', '1g'],
 				[Application::APP_ID, 'provider-1-' . ProviderService::SETTING_MAPPING_UID, '', 'uid'],
 				[Application::APP_ID, 'provider-1-' . ProviderService::SETTING_MAPPING_GROUPS, '', 'groups'],
+				[Application::APP_ID, 'provider-1-' . ProviderService::SETTING_MAPPING_LANGUAGE, '', 'language'],
 				[Application::APP_ID, 'provider-1-' . ProviderService::SETTING_MAPPING_ADDRESS, '', 'address'],
 				[Application::APP_ID, 'provider-1-' . ProviderService::SETTING_MAPPING_STREETADDRESS, '', 'street_address'],
 				[Application::APP_ID, 'provider-1-' . ProviderService::SETTING_MAPPING_POSTALCODE, '', 'postal_code'],

tests/unit/Service/ProvisioningServiceTest.php

@@ -21,6 +21,7 @@
 use OCP\ISession;
 use OCP\IUser;
 use OCP\IUserManager;
+use OCP\L10N\IFactory;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
@@ -64,6 +65,10 @@ class ProvisioningServiceTest extends TestCase {
 
 	/** @var ISession | MockObject */
 	private $session;
+	/**
+	 * @var IFactory | MockObject
+	 */
+	private $l10nFactory;
 
 	public function setUp(): void {
 		parent::setUp();
@@ -80,6 +85,7 @@ public function setUp(): void {
 		$this->avatarManager = $this->createMock(IAvatarManager::class);
 		$this->config = $this->createMock(IConfig::class);
 		$this->session = $this->createMock(ISession::class);
+		$this->l10nFactory = $this->createMock(IFactory::class);
 
 		$this->provisioningService = new ProvisioningService(
 			$this->idService,
@@ -94,6 +100,7 @@ public function setUp(): void {
 			$this->avatarManager,
 			$this->config,
 			$this->session,
+			$this->l10nFactory,
 		);
 	}
 
@@ -119,6 +126,7 @@ public function testProvisionUserAutoProvisioning(): void {
 					[$providerId, ProviderService::SETTING_MAPPING_DISPLAYNAME, 'name', 'name'],
 					[$providerId, ProviderService::SETTING_MAPPING_QUOTA, 'quota', 'quota'],
 					[$providerId, ProviderService::SETTING_GROUP_PROVISIONING, '0', '0'],
+					[$providerId, ProviderService::SETTING_MAPPING_LANGUAGE, 'language', 'language'],
 					[$providerId, ProviderService::SETTING_MAPPING_ADDRESS, 'address', 'address'],
 					[$providerId, ProviderService::SETTING_MAPPING_STREETADDRESS, 'street_address', 'street_address'],
 					[$providerId, ProviderService::SETTING_MAPPING_POSTALCODE, 'postal_code', 'postal_code'],