feat: add setting to map an ldap attribute to the user's voice extens…

…ion (#33598)
RocketChat · Oct 25, 2024 · a1bbdbf · a1bbdbf
1 parent c718ebd
commit a1bbdbf
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 0 deletions.
diff --git a/.changeset/shiny-falcons-vanish.md b/.changeset/shiny-falcons-vanish.md
@@ -0,0 +1,7 @@
+---
+'@rocket.chat/core-typings': minor
+'@rocket.chat/i18n': minor
+'@rocket.chat/meteor': minor
+---
+
+Adds a new setting to allow mapping LDAP attributes to the user's extension
diff --git a/apps/meteor/app/importer/server/classes/converters/UserConverter.ts b/apps/meteor/app/importer/server/classes/converters/UserConverter.ts
@@ -352,6 +352,7 @@ export class UserConverter extends RecordConverter<IImportUserRecord, UserConver
 			...(userData.importIds?.length && { importIds: userData.importIds }),
 			...(!!userData.customFields && { customFields: userData.customFields }),
 			...(userData.deleted !== undefined && { active: !userData.deleted }),
+			...(userData.voipExtension !== undefined && { freeSwitchExtension: userData.voipExtension }),
 		};
 	}
 

diff --git a/apps/meteor/server/lib/ldap/Manager.ts b/apps/meteor/server/lib/ldap/Manager.ts
@@ -167,13 +167,15 @@ export class LDAPManager {
 		const username = this.slugifyUsername(ldapUser, usedUsername || id || '') || undefined;
 		const emails = this.getLdapEmails(ldapUser, username);
 		const name = this.getLdapName(ldapUser) || undefined;
+		const voipExtension = this.getLdapExtension(ldapUser);
 
 		const userData: IImportUser = {
 			type: 'user',
 			emails,
 			importIds: [ldapUser.dn],
 			username,
 			name,
+			voipExtension,
 			services: {
 				ldap: {
 					idAttribute,
@@ -438,6 +440,15 @@ export class LDAPManager {
 		return this.getLdapDynamicValue(ldapUser, nameAttributes);
 	}
 
+	private static getLdapExtension(ldapUser: ILDAPEntry): string | undefined {
+		const extensionAttribute = settings.get<string>('LDAP_Extension_Field');
+		if (!extensionAttribute) {
+			return;
+		}
+
+		return this.getLdapString(ldapUser, extensionAttribute);
+	}
+
 	private static getLdapEmails(ldapUser: ILDAPEntry, username?: string): string[] {
 		const emailAttributes = getLDAPConditionalSetting<string>('LDAP_Email_Field');
 		if (emailAttributes) {

diff --git a/apps/meteor/server/settings/ldap.ts b/apps/meteor/server/settings/ldap.ts
@@ -209,6 +209,11 @@ export const createLdapSettings = () =>
 					enableQuery,
 					displayQuery: ldapOnly,
 				});
+
+				await this.add('LDAP_Extension_Field', '', {
+					type: 'string',
+					enableQuery,
+				});
 			});
 
 			await this.section('LDAP_DataSync_Avatar', async function () {

diff --git a/packages/core-typings/src/import/IImportUser.ts b/packages/core-typings/src/import/IImportUser.ts
@@ -18,4 +18,5 @@ export interface IImportUser {
 	customFields?: Record<string, any>;
 
 	password?: string;
+	voipExtension?: string;
 }
diff --git a/packages/i18n/src/locales/en.i18n.json b/packages/i18n/src/locales/en.i18n.json
@@ -3037,6 +3037,7 @@
   "LDAP_Server_Type_Other": "Other",
   "LDAP_Name_Field": "Name Field",
   "LDAP_Email_Field": "Email Field",
+  "LDAP_Extension_Field": "Extension Field",
   "LDAP_Update_Data_On_Login": "Update User Data on Login",
   "LDAP_Update_Data_On_OAuth_Login": "Update User Data on Login with OAuth services",
   "LDAP_Advanced_Sync": "Advanced Sync",