upstream-rocketchat/apps/meteor/client/views/room/hooks/useRetentionPolicy.ts

import type { IRoom, IRoomWithRetentionPolicy } from '@rocket.chat/core-typings';
import { useSetting } from '@rocket.chat/ui-contexts';

import { TIMEUNIT, isValidTimespan, timeUnitToMs } from '../../../lib/convertTimeUnit';

const hasRetentionPolicy = (room: IRoom & { retention?: any }): room is IRoomWithRetentionPolicy =>
	'retention' in room && room.retention !== undefined;

const isRetentionOverridden = (room: IRoom & { retention?: any }) => 'overrideGlobal' in room.retention && room.retention.overrideGlobal;

type RetentionPolicySettings = {
	enabled: boolean;
	filesOnly: boolean;
	doNotPrunePinned: boolean;
	ignoreThreads: boolean;
	appliesToChannels: boolean;
	maxAgeChannels: number;
	appliesToGroups: boolean;
	maxAgeGroups: number;
	appliesToDMs: boolean;
	maxAgeDMs: number;
};

const isActive = (room: IRoom, { enabled, appliesToChannels, appliesToGroups, appliesToDMs }: RetentionPolicySettings): boolean => {
	if (!enabled) {
		return false;
	}

	if (hasRetentionPolicy(room) && room.retention.enabled !== undefined) {
		return room.retention.enabled;
	}

	switch (room.t) {
		case 'c':
			return appliesToChannels;
		case 'p':
			return appliesToGroups;
		case 'd':
			return appliesToDMs;
	}

	return false;
};

const extractFilesOnly = (room: IRoom, { filesOnly }: RetentionPolicySettings): boolean => {
	if (hasRetentionPolicy(room) && isRetentionOverridden(room)) {
		return room.retention.filesOnly;
	}

	return filesOnly;
};

const extractExcludePinned = (room: IRoom, { doNotPrunePinned }: RetentionPolicySettings): boolean => {
	if (hasRetentionPolicy(room) && isRetentionOverridden(room)) {
		return room.retention.excludePinned;
	}

	return doNotPrunePinned;
};

const extractIgnoreThreads = (room: IRoom, { ignoreThreads }: RetentionPolicySettings): boolean => {
	if (hasRetentionPolicy(room) && isRetentionOverridden(room)) {
		return room.retention.ignoreThreads;
	}

	return ignoreThreads;
};

const getMaxAge = (room: IRoom, { maxAgeChannels, maxAgeGroups, maxAgeDMs }: RetentionPolicySettings): number => {
	if (hasRetentionPolicy(room) && isRetentionOverridden(room) && isValidTimespan(room.retention.maxAge)) {
		return timeUnitToMs(TIMEUNIT.days, room.retention.maxAge);
	}

	if (room.t === 'c') {
		return maxAgeChannels;
	}
	if (room.t === 'p') {
		return maxAgeGroups;
	}
	if (room.t === 'd') {
		return maxAgeDMs;
	}

	return -Infinity;
};

export type RetentionPolicy = {
	enabled: boolean;
	isActive: boolean;
	filesOnly: boolean;
	excludePinned: boolean;
	ignoreThreads: boolean;
	maxAge: number;
};

export const useRetentionPolicy = (room: IRoom | undefined): RetentionPolicy | undefined => {
	const settings = {
		enabled: useSetting('RetentionPolicy_Enabled', false),
		filesOnly: useSetting('RetentionPolicy_FilesOnly', false),
		doNotPrunePinned: useSetting('RetentionPolicy_DoNotPrunePinned', false),
		ignoreThreads: useSetting('RetentionPolicy_DoNotPruneThreads', true),
		appliesToChannels: useSetting('RetentionPolicy_AppliesToChannels', false),
		maxAgeChannels: useSetting('RetentionPolicy_TTL_Channels', 2592000000),
		appliesToGroups: useSetting('RetentionPolicy_AppliesToGroups', false),
		maxAgeGroups: useSetting('RetentionPolicy_TTL_Groups', 2592000000),
		appliesToDMs: useSetting('RetentionPolicy_AppliesToDMs', false),
		maxAgeDMs: useSetting('RetentionPolicy_TTL_DMs', 2592000000),
	} as const;

	if (!room) {
		return undefined;
	}

	return {
		enabled: settings.enabled,
		isActive: isActive(room, settings),
		filesOnly: extractFilesOnly(room, settings),
		excludePinned: extractExcludePinned(room, settings),
		ignoreThreads: extractIgnoreThreads(room, settings),
		maxAge: getMaxAge(room, settings),
	};
};