chore: New Backend Architecture for Voice Calls

.yarn/patches/drachtio-srf-npm-5.0.12-b0b1afaad6.patch

@@ -0,0 +1,56 @@
+diff --git a/lib/@types/index.d.ts b/lib/@types/index.d.ts
+index f71a82f458c1432202be8d4585fc70ba94bee4a4..b874ee9e1fa8a051f06d4824fc12161acfadb78a 100644
+--- a/lib/@types/index.d.ts
++++ b/lib/@types/index.d.ts
+@@ -119,12 +119,12 @@ declare namespace Srf {
+     on(messageType: "modify", callback: (req: SrfRequest, res: SrfResponse) => void): void;
+     once(messageType: string, callback: (msg: SrfResponse) => void): void;
+     listeners(messageType: string): any[];
+-    request(opts?: SrfRequest): Promise<SrfResponse>;
+-    request(opts: SrfRequest, callback?: (err: any, msg: SrfResponse) => void): void;
++    request(opts?: Partial<SrfRequest>): Promise<SrfResponse>;
++    request(opts: Partial<SrfRequest>, callback?: (err: any, msg: SrfResponse) => void): void;
+   }
+
+   export interface CreateUASOptions {
+-    localSdp: string;
++    localSdp: string | (() => string | Promise<string>);
+     headers?: SipMessageHeaders;
+   }
+
+@@ -135,6 +135,8 @@ declare namespace Srf {
+     localSdp?: string;
+     proxy?: string;
+     auth?: { username: string; password: string; };
++    callingName?: string;
++    callingNumber?: string;
+   }
+
+   export interface CreateB2BUAOptions {
+@@ -155,7 +157,7 @@ declare class Srf extends EventEmitter {
+   constructor();
+   constructor(tags: string | string[]);
+   connect(config?: Srf.SrfConfig): Promise<void>;
+-  disconnect(): void;
++  disconnect(socket?: Socket): void;
+   use(callback: (req: Srf.SrfRequest, res: Srf.SrfResponse, next: Function) => void): void;
+   use(messageType: string, callback: (req: Srf.SrfRequest, res: Srf.SrfResponse, next: Function) => void): void;
+   invite(callback: (req: Srf.SrfRequest, res: Srf.SrfResponse) => void): void;
+@@ -164,12 +166,12 @@ declare class Srf extends EventEmitter {
+   proxyRequest(req: Srf.SrfRequest, destination: string | string[], opts?: Srf.ProxyRequestOptions, callback?: (err: any, results: string) => void): void;
+   createUAS(req: Srf.SrfRequest, res: Srf.SrfResponse, opts: Srf.CreateUASOptions): Promise<Srf.Dialog>;
+   createUAS(req: Srf.SrfRequest, res: Srf.SrfResponse, opts: Srf.CreateUASOptions, callback?: (err: any, dialog: Srf.Dialog) => void): this;
+-  createUAC(uri: string | Srf.CreateUACOptions, opts?: Srf.CreateUACOptions, progressCallbacks?: { cbRequest?: (req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Srf.SrfResponse) => void; }): Promise<Srf.Dialog>;
+-  createUAC(uri: string | Srf.CreateUACOptions, opts?: Srf.CreateUACOptions, progressCallbacks?: { cbRequest?: (req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Srf.SrfResponse) => void; }, callback?: (err: any, dialog: Srf.Dialog) => void): this;
+-  createB2BUA(req: Srf.SrfRequest, res: Srf.SrfResponse, uri: string, opts: Srf.CreateB2BUAOptions, progressCallbacks?: { cbRequest?: (req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Response) => void; cbFinalizedUac?: (uac: Srf.Dialog) => void; }): Promise<{ uas: Srf.Dialog; uac: Srf.Dialog }>;
+-  createB2BUA(req: Srf.SrfRequest, res: Srf.SrfResponse, uri: string, opts: Srf.CreateB2BUAOptions, progressCallbacks?: { cbRequest?: (req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Response) => void; cbFinalizedUac?: (uac: Srf.Dialog) => void; }, callback?: (err: any, dialog: Srf.Dialog) => void): this;
++  createUAC(uri: string | Srf.CreateUACOptions, opts?: Srf.CreateUACOptions, progressCallbacks?: { cbRequest?: (error: unknown, req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Srf.SrfResponse) => void; }): Promise<Srf.Dialog>;
++  createUAC(uri: string | Srf.CreateUACOptions, opts?: Srf.CreateUACOptions, progressCallbacks?: { cbRequest?: (error: unknown, req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Srf.SrfResponse) => void; }, callback?: (err: any, dialog: Srf.Dialog) => void): this;
++  createB2BUA(req: Srf.SrfRequest, res: Srf.SrfResponse, uri: string, opts: Srf.CreateB2BUAOptions, progressCallbacks?: { cbRequest?: (error: unknown, req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Response) => void; cbFinalizedUac?: (uac: Srf.Dialog) => void; }): Promise<{ uas: Srf.Dialog; uac: Srf.Dialog }>;
++  createB2BUA(req: Srf.SrfRequest, res: Srf.SrfResponse, uri: string, opts: Srf.CreateB2BUAOptions, progressCallbacks?: { cbRequest?: (error: unknown, req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Response) => void; cbFinalizedUac?: (uac: Srf.Dialog) => void; }, callback?: (err: any, dialog: Srf.Dialog) => void): this;
+   on(event: 'connect', listener: (err: Error, hostPort: string) => void): this;
+-  on(event: 'error', listener: (err: Error) => void): this;
++  on(event: 'error', listener: (err: Error, socket?: Socket) => void): this;
+   on(event: 'disconnect', listener: () => void): this;
+   on(event: 'message', listener: (req: Srf.SrfRequest, res: Srf.SrfResponse) => void): this;
+   on(event: 'request', listener: (req: Srf.SrfRequest, res: Srf.SrfResponse) => void): this;

apps/meteor/app/authorization/server/constant/permissions.ts

@@ -228,6 +228,10 @@ export const permissions = [
 	// Allow viewing details of an extension
 	{ _id: 'view-voip-extension-details', roles: ['admin', 'user'] },
 
+	// New Media calls permissions
+	{ _id: 'allow-internal-voice-calls', roles: ['admin', 'user'] },
+	{ _id: 'allow-external-voice-calls', roles: ['admin', 'user'] },
+
 	{ _id: 'remove-livechat-department', roles: ['livechat-manager', 'admin'] },
 	{ _id: 'manage-apps', roles: ['admin'] },
 	{ _id: 'post-readonly', roles: ['admin', 'owner', 'moderator'] },

apps/meteor/ee/server/settings/voip.ts

@@ -17,53 +17,106 @@ export function addSettings(): Promise<void> {
 					alert: 'VoIP_TeamCollab_Beta_Alert',
 				});
 
-				await this.add('VoIP_TeamCollab_FreeSwitch_Host', '', {
-					type: 'string',
-					public: true,
-					invalidValue: '',
-					enableQuery,
-				});
+				await this.section('VoIP_TeamCollab_WebRTC', async function () {
+					await this.add('VoIP_TeamCollab_Ice_Servers', 'stun:stun.l.google.com:19302', {
+						type: 'string',
+						public: true,
+						invalidValue: '',
+						enableQuery,
+					});
 
-				await this.add('VoIP_TeamCollab_FreeSwitch_Port', 8021, {
-					type: 'int',
-					public: true,
-					invalidValue: 8021,
-					enableQuery,
+					await this.add('VoIP_TeamCollab_Ice_Gathering_Timeout', 5000, {
+						type: 'int',
+						public: true,
+						invalidValue: 5000,
+						enableQuery,
+					});
 				});
 
-				await this.add('VoIP_TeamCollab_FreeSwitch_Password', '', {
-					type: 'password',
-					secret: true,
-					invalidValue: '',
-					enableQuery,
-				});
+				await this.section('VoIP_TeamCollab_SIP_Integration', async function () {
+					await this.add('VoIP_TeamCollab_SIP_Integration_Enabled', false, {
+						type: 'boolean',
+						public: true,
+						invalidValue: false,
+					});
 
-				await this.add('VoIP_TeamCollab_FreeSwitch_Timeout', 3000, {
-					type: 'int',
-					public: true,
-					invalidValue: 3000,
-					enableQuery,
-				});
+					await this.add('VoIP_TeamCollab_SIP_Integration_For_Internal_Calls', false, {
+						type: 'boolean',
+						public: true,
+						invalidValue: false,
+					});
 
-				await this.add('VoIP_TeamCollab_FreeSwitch_WebSocket_Path', '', {
-					type: 'string',
-					public: true,
-					invalidValue: '',
-					enableQuery,
-				});
+					await this.add('VoIP_TeamCollab_Drachtio_Host', '', {
+						type: 'string',
+						public: false,
+						invalidValue: '',
+						enableQuery,
+					});
 
-				await this.add('VoIP_TeamCollab_Ice_Servers', 'stun:stun.l.google.com:19302', {
-					type: 'string',
-					public: true,
-					invalidValue: '',
-					enableQuery,
+					await this.add('VoIP_TeamCollab_Drachtio_Port', 9022, {
+						type: 'int',
+						public: false,
+						invalidValue: 9022,
+						enableQuery,
+					});
+
+					await this.add('VoIP_TeamCollab_Drachtio_Password', '', {
+						type: 'password',
+						secret: true,
+						invalidValue: '',
+						enableQuery,
+					});
+
+					await this.add('VoIP_TeamCollab_SIP_Server_Host', '', {
+						type: 'string',
+						public: false,
+						invalidValue: '',
+						enableQuery,
+					});
+
+					await this.add('VoIP_TeamCollab_SIP_Server_Port', 5080, {
+						type: 'int',
+						public: false,
+						invalidValue: 5080,
+						enableQuery,
+					});
 				});
 
-				await this.add('VoIP_TeamCollab_Ice_Gathering_Timeout', 5000, {
-					type: 'int',
-					public: true,
-					invalidValue: 5000,
-					enableQuery,
+				await this.section('VoIP_TeamCollab_FreeSwitch', async function () {
+					await this.add('VoIP_TeamCollab_FreeSwitch_Host', '', {
+						type: 'string',
+						public: false,
+						invalidValue: '',
+						enableQuery,
+					});
+
+					await this.add('VoIP_TeamCollab_FreeSwitch_Port', 8021, {
+						type: 'int',
+						public: false,
+						invalidValue: 8021,
+						enableQuery,
+					});
+
+					await this.add('VoIP_TeamCollab_FreeSwitch_Password', '', {
+						type: 'password',
+						secret: true,
+						invalidValue: '',
+						enableQuery,
+					});
+
+					await this.add('VoIP_TeamCollab_FreeSwitch_Timeout', 3000, {
+						type: 'int',
+						public: true,
+						invalidValue: 3000,
+						enableQuery,
+					});
+
+					await this.add('VoIP_TeamCollab_FreeSwitch_WebSocket_Path', '', {
+						type: 'string',
+						public: true,
+						invalidValue: '',
+						enableQuery,
+					});
 				});
 			},
 		);

apps/meteor/package.json

@@ -345,6 +345,7 @@
 		"date.js": "~0.3.3",
 		"debug": "~4.3.7",
 		"dompurify": "^3.2.6",
+		"drachtio-srf": "patch:drachtio-srf@npm%3A5.0.12#~/.yarn/patches/drachtio-srf-npm-5.0.12-b0b1afaad6.patch",
 		"ejson": "^2.2.3",
 		"emailreplyparser": "^0.0.5",
 		"emoji-toolkit": "^7.0.1",

apps/meteor/server/services/media-call/service.ts

@@ -1,4 +1,4 @@
-import { api, ServiceClassInternal, type IMediaCallService } from '@rocket.chat/core-services';
+import { api, ServiceClassInternal, type IMediaCallService, Authorization } from '@rocket.chat/core-services';
 import type { IUser } from '@rocket.chat/core-typings';
 import { Logger } from '@rocket.chat/logger';
 import { callServer, type IMediaCallServerSettings } from '@rocket.chat/media-calls';
@@ -15,6 +15,8 @@ export class MediaCallService extends ServiceClassInternal implements IMediaCall
 	constructor() {
 		super();
 		callServer.emitter.on('signalRequest', ({ toUid, signal }) => this.sendSignal(toUid, signal));
+		callServer.emitter.on('callUpdated', (params) => api.broadcast('media-call.updated', params));
+		this.onEvent('media-call.updated', (params) => callServer.receiveCallUpdate(params));
 
 		this.onEvent('watch.settings', async ({ setting }): Promise<void> => {
 			if (setting._id.startsWith('VoIP_TeamCollab_')) {
@@ -70,8 +72,8 @@ export class MediaCallService extends ServiceClassInternal implements IMediaCall
 
 	private getMediaServerSettings(): IMediaCallServerSettings {
 		const enabled = settings.get<boolean>('VoIP_TeamCollab_Enabled') ?? false;
-		const sipEnabled = false;
-		const forceSip = false;
+		const sipEnabled = enabled && (settings.get<boolean>('VoIP_TeamCollab_SIP_Integration_Enabled') ?? false);
+		const forceSip = sipEnabled && (settings.get<boolean>('VoIP_TeamCollab_SIP_Integration_For_Internal_Calls') ?? false);
 
 		return {
 			enabled,
@@ -81,10 +83,30 @@ export class MediaCallService extends ServiceClassInternal implements IMediaCall
 			},
 			sip: {
 				enabled: sipEnabled,
+				drachtio: {
+					host: settings.get<string>('VoIP_TeamCollab_Drachtio_Host') ?? '',
+					port: settings.get<number>('VoIP_TeamCollab_Drachtio_Port') ?? 9022,
+					secret: settings.get<string>('VoIP_TeamCollab_Drachtio_Password') ?? '',
+				},
+				sipServer: {
+					host: settings.get<string>('VoIP_TeamCollab_SIP_Server_Host') ?? '',
+					port: settings.get<number>('VoIP_TeamCollab_SIP_Server_Port') ?? 5080,
+				},
 			},
+			permissionCheck: (uid, callType) => this.userHasMediaCallPermission(uid, callType),
 		};
 	}
 
+	private async userHasMediaCallPermission(uid: IUser['_id'], callType: 'internal' | 'external' | 'any'): Promise<boolean> {
+		if (callType === 'any') {
+			return Authorization.hasAtLeastOnePermission(uid, ['allow-internal-voice-calls', 'allow-external-voice-calls']);
+		}
+
+		const permissionId = `allow-${callType}-voice-calls`;
+
+		return Authorization.hasPermission(uid, permissionId);
+	}
+
 	private async deserializeClientSignal(serialized: string): Promise<ClientMediaSignal> {
 		try {
 			const signal = JSON.parse(serialized);

ee/packages/media-calls/package.json

@@ -28,6 +28,7 @@
 		"@rocket.chat/emitter": "~0.31.25",
 		"@rocket.chat/logger": "workspace:^",
 		"@rocket.chat/media-signaling": "workspace:^",
-		"@rocket.chat/models": "workspace:^"
+		"@rocket.chat/models": "workspace:^",
+		"drachtio-srf": "patch:drachtio-srf@npm%3A5.0.12#~/.yarn/patches/drachtio-srf-npm-5.0.12-b0b1afaad6.patch"
 	}
 }

ee/packages/media-calls/src/base/BaseAgent.ts

@@ -77,6 +77,8 @@ export abstract class BaseMediaCallAgent implements IMediaCallAgent {
 
 	public abstract onCallTransferred(callId: string): Promise<void>;
 
+	public abstract onDTMF(callId: string, dtmf: string, duration: number): Promise<void>;
+
 	protected async createOrUpdateChannel(call: IMediaCall, contractId: string): Promise<IMediaCallChannel> {
 		if (!contractId) {
 			throw new Error('error-invalid-contract');

ee/packages/media-calls/src/base/BaseCallProvider.ts

@@ -1,9 +1,16 @@
 import type { IMediaCall } from '@rocket.chat/core-typings';
+import type { ClientMediaSignalBody } from '@rocket.chat/media-signaling';
+
+import { logger } from '../logger';
 
 export class BaseCallProvider {
 	public get callId(): string {
 		return this.call._id;
 	}
 
 	constructor(public readonly call: IMediaCall) {}
+
+	public async reactToCallChanges(params: { dtmf?: ClientMediaSignalBody<'dtmf'> }): Promise<void> {
+		logger.debug({ msg: 'BaseCallProvider.reactToCallChanges', callId: this.callId, params });
+	}
 }

ee/packages/media-calls/src/definition/IMediaCallAgent.ts

@@ -1,4 +1,4 @@
-import type { IMediaCall, MediaCallActor, MediaCallActorType } from '@rocket.chat/core-typings';
+import type { IMediaCall, MediaCallActor, MediaCallActorType, MediaCallContact } from '@rocket.chat/core-typings';
 import type { CallRole } from '@rocket.chat/media-signaling';
 
 export interface IMediaCallAgent {
@@ -18,7 +18,9 @@ export interface IMediaCallAgent {
 	/* Called when the sdp of the other actor is available, regardless of call state, or when this actor must provide an offer */
 	onRemoteDescriptionChanged(callId: string, negotiationId: string): Promise<void>;
 
+	onDTMF(callId: string, tone: string, duration: number): Promise<void>;
+
 	onCallTransferred(callId: string): Promise<void>;
 
-	getMyCallActor(call: IMediaCall): MediaCallActor;
+	getMyCallActor(call: IMediaCall): MediaCallContact;
 }

ee/packages/media-calls/src/definition/IMediaCallServer.ts

@@ -1,10 +1,11 @@
 import type { IUser } from '@rocket.chat/core-typings';
 import type { Emitter } from '@rocket.chat/emitter';
-import type { ClientMediaSignal, ServerMediaSignal } from '@rocket.chat/media-signaling';
+import type { ClientMediaSignal, ClientMediaSignalBody, ServerMediaSignal } from '@rocket.chat/media-signaling';
 
 import type { InternalCallParams } from './common';
 
 export type MediaCallServerEvents = {
+	callUpdated: { callId: string; dtmf?: ClientMediaSignalBody<'dtmf'> };
 	signalRequest: { toUid: IUser['_id']; signal: ServerMediaSignal };
 };
 
@@ -18,17 +19,30 @@ export interface IMediaCallServerSettings {
 
 	sip: {
 		enabled: boolean;
+		drachtio: {
+			host: string;
+			port: number;
+			secret: string;
+		};
+		sipServer: {
+			host: string;
+			port: number;
+		};
 	};
+
+	permissionCheck: (uid: IUser['_id'], callType: 'internal' | 'external' | 'any') => Promise<boolean>;
 }
 
 export interface IMediaCallServer {
 	emitter: Emitter<MediaCallServerEvents>;
 
 	// functions that trigger events
 	sendSignal(toUid: IUser['_id'], signal: ServerMediaSignal): void;
+	reportCallUpdate(params: { callId: string; dtmf?: ClientMediaSignalBody<'dtmf'> }): void;
 
 	// functions that are run on events
 	receiveSignal(fromUid: IUser['_id'], signal: ClientMediaSignal): void;
+	receiveCallUpdate(params: { callId: string; dtmf?: ClientMediaSignalBody<'dtmf'> }): void;
 
 	// extra functions available to the service
 	hangupExpiredCalls(): Promise<void>;

ee/packages/media-calls/src/definition/common.ts

@@ -1,12 +1,4 @@
-import type {
-	AtLeast,
-	IMediaCall,
-	IUser,
-	MediaCallActorType,
-	MediaCallContact,
-	MediaCallSignedActor,
-	MediaCallSignedContact,
-} from '@rocket.chat/core-typings';
+import type { AtLeast, IMediaCall, IUser, MediaCallActorType, MediaCallContact, MediaCallSignedContact } from '@rocket.chat/core-typings';
 import type { CallRejectedReason, CallService } from '@rocket.chat/media-signaling';
 
 export type MinimalUserData = Pick<IUser, '_id' | 'username' | 'name' | 'freeSwitchExtension'>;
@@ -22,7 +14,7 @@ export type InternalCallParams = {
 	requestedCallId?: string;
 	requestedService?: CallService;
 	parentCallId?: string;
-	requestedBy?: MediaCallSignedActor;
+	requestedBy?: MediaCallSignedContact;
 };
 
 export type MediaCallHeader = AtLeast<IMediaCall, '_id' | 'caller' | 'callee'>;