snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/server/lib/search/service/SearchProviderService.ts

@@ -0,0 +1,122 @@
+import { withDebouncing } from '../../../../lib/utils/highOrderFunctions';
+import { settings, settingsRegistry } from '../../../settings';
+import { SearchLogger } from '../logger/logger';
+import type { SearchProvider } from '../model/SearchProvider';
+
+export class SearchProviderService {
+	public providers: Record<string, SearchProvider> = {};
+
+	public activeProvider?: SearchProvider;
+
+	/**
+	 * Stop current provider (if there is one) and start the new
+	 * @param id the id of the provider which should be started
+	 */
+	async use(id: SearchProvider['key']) {
+		if (!this.providers[id]) {
+			throw new Error(`provider ${id} cannot be found`);
+		}
+
+		let reason: 'startup' | 'update' | 'switch';
+
+		if (!this.activeProvider) {
+			reason = 'startup';
+		} else if (this.activeProvider.key === this.providers[id].key) {
+			reason = 'update';
+		} else {
+			reason = 'switch';
+		}
+
+		if (this.activeProvider) {
+			const provider = this.activeProvider;
+			SearchLogger.debug({
+				msg: 'Stopping provider',
+				providerKey: provider.key,
+			});
+
+			await new Promise<void>((resolve) => provider.stop(resolve));
+		}
+
+		this.activeProvider = undefined;
+
+		SearchLogger.debug({
+			msg: 'Start provider',
+			providerKey: id,
+		});
+
+		await this.providers[id].run(reason);
+		this.activeProvider = this.providers[id];
+	}
+
+	/**
+	 * Registers a search provider on system startup
+	 */
+	register(provider: SearchProvider) {
+		this.providers[provider.key] = provider;
+	}
+
+	/**
+	 * Starts the service (loads provider settings for admin ui, add lister not setting changes, enable current provider
+	 */
+	async start() {
+		SearchLogger.debug('Load data for all providers');
+
+		const { providers } = this;
+
+		// add settings for admininistration
+		await settingsRegistry.addGroup('Search', async function () {
+			await this.add('Search.Provider', 'defaultProvider', {
+				type: 'select',
+				values: Object.values(providers).map((provider) => ({
+					key: provider.key,
+					i18nLabel: provider.i18nLabel,
+				})),
+				public: true,
+				i18nLabel: 'Search_Provider',
+			});
+
+			await Promise.all(
+				Object.keys(providers)
+					.filter((key) => providers[key].settings && providers[key].settings.length > 0)
+					.map(async (key) => {
+						await this.section(providers[key].i18nLabel, async function () {
+							await Promise.all(
+								providers[key].settings.map(async (setting) => {
+									const _options: Record<string, unknown> = {
+										type: setting.type,
+										...setting.options,
+									};
+
+									_options.enableQuery = _options.enableQuery || [];
+
+									if (!_options.enableQuery) {
+										_options.enableQuery = [];
+									}
+
+									if (Array.isArray(_options.enableQuery)) {
+										_options.enableQuery.push({
+											_id: 'Search.Provider',
+											value: key,
+										});
+									}
+
+									await this.add(setting.id, setting.defaultValue, _options);
+								}),
+							);
+						});
+					}),
+			);
+		});
+
+		// add listener to react on setting changes
+		const configProvider = withDebouncing({ wait: 1000 })(() => {
+			const providerId = settings.get<string>('Search.Provider');
+
+			if (providerId) {
+				void this.use(providerId); // TODO do something with success and errors
+			}
+		});
+
+		settings.watchByRegex(/^Search\./, configProvider);
+	}
+}

apps/meteor/server/lib/search/service/SearchResultValidationService.ts

@@ -0,0 +1,112 @@
+import type { IRoom, IUser } from '@rocket.chat/core-typings';
+import { Users, Rooms } from '@rocket.chat/models';
+import { isTruthy } from '@rocket.chat/tools';
+import mem from 'mem';
+import { Meteor } from 'meteor/meteor';
+
+import { canAccessRoomAsync } from '../../authorization';
+import { SearchLogger } from '../logger/logger';
+import type { IRawSearchResult, ISearchResult } from '../model/ISearchResult';
+
+export class SearchResultValidationService {
+	private getSubscription = mem(async (rid: IRoom['_id'], uid?: IUser['_id']) => {
+		if (!rid) {
+			return;
+		}
+
+		const room = await Rooms.findOneById(rid);
+		if (!room) {
+			return;
+		}
+
+		if (!uid || !(await canAccessRoomAsync(room, { _id: uid }))) {
+			return;
+		}
+
+		return room;
+	});
+
+	private getUser = mem(async (uid: IUser['_id']) => {
+		if (!uid) {
+			return;
+		}
+
+		return Users.findOneById(uid, { projection: { username: 1 } });
+	});
+
+	async validateSearchResult(result: IRawSearchResult): Promise<ISearchResult> {
+		const uid = Meteor.userId() ?? undefined;
+
+		const validatedResult: ISearchResult = {};
+
+		// get subscription for message
+		if (result.message) {
+			validatedResult.message = {
+				docs: (
+					await Promise.all(
+						result.message.docs.map(async (msg) => {
+							const user = await this.getUser(msg.u._id);
+							const subscription = await this.getSubscription(msg.rid, uid);
+
+							if (subscription) {
+								SearchLogger.debug({
+									msg: 'User can access message',
+									userId: uid,
+									roomId: msg.rid,
+								});
+								return {
+									...msg,
+									user: msg.u._id,
+									r: { name: subscription.name, t: subscription.t },
+									username: user?.username,
+									valid: true,
+								};
+							}
+
+							SearchLogger.debug({
+								msg: 'User cannot access message',
+								userId: uid,
+								roomId: msg.rid,
+							});
+							return undefined;
+						}),
+					)
+				).filter(isTruthy),
+			};
+		}
+
+		if (result.room) {
+			result.room.docs = (
+				await Promise.all(
+					result.room.docs.map(async (room) => {
+						const subscription = await this.getSubscription(room._id, uid);
+
+						if (!subscription) {
+							SearchLogger.debug({
+								msg: 'User cannot access room',
+								userId: uid,
+								roomId: room._id,
+							});
+							return undefined;
+						}
+
+						SearchLogger.debug({
+							msg: 'User can access room',
+							userId: uid,
+							roomId: room._id,
+						});
+
+						return {
+							...room,
+							valid: true,
+							t: subscription.t,
+							name: subscription.name,
+						};
+					}),
+				)
+			).filter(isTruthy);
+		}
+
+		return validatedResult;
+	}
+}

apps/meteor/server/lib/search/service/index.ts

@@ -0,0 +1,5 @@
+import { SearchProviderService } from './SearchProviderService';
+import { SearchResultValidationService } from './SearchResultValidationService';
+
+export const searchProviderService = new SearchProviderService();
+export const validationService = new SearchResultValidationService();