signal-desktop/ts/groupChange.ts
2023-03-27 16:37:39 -07:00

934 lines
27 KiB
TypeScript

// Copyright 2020 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
import type { LocalizerType } from './types/Util';
import type { ReplacementValuesType } from './types/I18N';
import type { UUIDStringType } from './types/UUID';
import { missingCaseError } from './util/missingCaseError';
import type { GroupV2ChangeDetailType, GroupV2ChangeType } from './groups';
import { SignalService as Proto } from './protobuf';
import * as log from './logging/log';
export type SmartContactRendererType<T> = (uuid: UUIDStringType) => T | string;
export type StringRendererType<T> = (
id: string,
i18n: LocalizerType,
components?: ReplacementValuesType<T | string>
) => T | string;
export type RenderOptionsType<T> = {
from?: UUIDStringType;
i18n: LocalizerType;
ourACI?: UUIDStringType;
ourPNI?: UUIDStringType;
renderContact: SmartContactRendererType<T>;
renderString: StringRendererType<T>;
};
const AccessControlEnum = Proto.AccessControl.AccessRequired;
const RoleEnum = Proto.Member.Role;
export type RenderChangeResultType<T> = ReadonlyArray<
Readonly<{
detail: GroupV2ChangeDetailType;
text: T | string;
// Used to differentiate between the multiple texts produced by
// 'admin-approval-bounce'
isLastText: boolean;
}>
>;
export function renderChange<T>(
change: GroupV2ChangeType,
options: RenderOptionsType<T>
): RenderChangeResultType<T> {
const { details, from } = change;
return details.flatMap((detail: GroupV2ChangeDetailType) => {
const texts = renderChangeDetail<T>(detail, {
...options,
from,
});
if (!Array.isArray(texts)) {
return { detail, isLastText: true, text: texts };
}
return texts.map((text, index) => {
const isLastText = index === texts.length - 1;
return { detail, isLastText, text };
});
});
}
export function renderChangeDetail<T>(
detail: GroupV2ChangeDetailType,
options: RenderOptionsType<T>
): T | string | ReadonlyArray<T | string> {
const { from, i18n, ourACI, ourPNI, renderContact, renderString } = options;
const isOurUuid = (uuid?: UUIDStringType): boolean => {
if (!uuid) {
return false;
}
return Boolean((ourACI && uuid === ourACI) || (ourPNI && uuid === ourPNI));
};
const fromYou = isOurUuid(from);
if (detail.type === 'create') {
if (fromYou) {
return renderString('GroupV2--create--you', i18n);
}
if (from) {
return renderString('GroupV2--create--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--create--unknown', i18n);
}
if (detail.type === 'title') {
const { newTitle } = detail;
if (newTitle) {
if (fromYou) {
return renderString('GroupV2--title--change--you', i18n, { newTitle });
}
if (from) {
return renderString('GroupV2--title--change--other', i18n, {
memberName: renderContact(from),
newTitle,
});
}
return renderString('GroupV2--title--change--unknown', i18n, {
newTitle,
});
}
if (fromYou) {
return renderString('GroupV2--title--remove--you', i18n);
}
if (from) {
return renderString('GroupV2--title--remove--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--title--remove--unknown', i18n);
}
if (detail.type === 'avatar') {
if (detail.removed) {
if (fromYou) {
return renderString('GroupV2--avatar--remove--you', i18n);
}
if (from) {
return renderString('GroupV2--avatar--remove--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--avatar--remove--unknown', i18n);
}
if (fromYou) {
return renderString('GroupV2--avatar--change--you', i18n);
}
if (from) {
return renderString('GroupV2--avatar--change--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--avatar--change--unknown', i18n);
}
if (detail.type === 'access-attributes') {
const { newPrivilege } = detail;
if (newPrivilege === AccessControlEnum.ADMINISTRATOR) {
if (fromYou) {
return renderString('GroupV2--access-attributes--admins--you', i18n);
}
if (from) {
return renderString('GroupV2--access-attributes--admins--other', i18n, {
adminName: renderContact(from),
});
}
return renderString('GroupV2--access-attributes--admins--unknown', i18n);
}
if (newPrivilege === AccessControlEnum.MEMBER) {
if (fromYou) {
return renderString('GroupV2--access-attributes--all--you', i18n);
}
if (from) {
return renderString('GroupV2--access-attributes--all--other', i18n, {
adminName: renderContact(from),
});
}
return renderString('GroupV2--access-attributes--all--unknown', i18n);
}
log.warn(
`access-attributes change type, privilege ${newPrivilege} is unknown`
);
return '';
}
if (detail.type === 'access-members') {
const { newPrivilege } = detail;
if (newPrivilege === AccessControlEnum.ADMINISTRATOR) {
if (fromYou) {
return renderString('GroupV2--access-members--admins--you', i18n);
}
if (from) {
return renderString('GroupV2--access-members--admins--other', i18n, {
adminName: renderContact(from),
});
}
return renderString('GroupV2--access-members--admins--unknown', i18n);
}
if (newPrivilege === AccessControlEnum.MEMBER) {
if (fromYou) {
return renderString('GroupV2--access-members--all--you', i18n);
}
if (from) {
return renderString('GroupV2--access-members--all--other', i18n, {
adminName: renderContact(from),
});
}
return renderString('GroupV2--access-members--all--unknown', i18n);
}
log.warn(
`access-members change type, privilege ${newPrivilege} is unknown`
);
return '';
}
if (detail.type === 'access-invite-link') {
const { newPrivilege } = detail;
if (newPrivilege === AccessControlEnum.ADMINISTRATOR) {
if (fromYou) {
return renderString('GroupV2--access-invite-link--enabled--you', i18n);
}
if (from) {
return renderString(
'GroupV2--access-invite-link--enabled--other',
i18n,
{ adminName: renderContact(from) }
);
}
return renderString(
'GroupV2--access-invite-link--enabled--unknown',
i18n
);
}
if (newPrivilege === AccessControlEnum.ANY) {
if (fromYou) {
return renderString('GroupV2--access-invite-link--disabled--you', i18n);
}
if (from) {
return renderString(
'GroupV2--access-invite-link--disabled--other',
i18n,
{ adminName: renderContact(from) }
);
}
return renderString(
'GroupV2--access-invite-link--disabled--unknown',
i18n
);
}
log.warn(
`access-invite-link change type, privilege ${newPrivilege} is unknown`
);
return '';
}
if (detail.type === 'member-add') {
const { uuid } = detail;
const weAreJoiner = isOurUuid(uuid);
if (weAreJoiner) {
if (fromYou) {
return renderString('GroupV2--member-add--you--you', i18n);
}
if (from) {
return renderString('GroupV2--member-add--you--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--member-add--you--unknown', i18n);
}
if (fromYou) {
return renderString('GroupV2--member-add--other--you', i18n, {
memberName: renderContact(uuid),
});
}
if (from) {
return renderString('GroupV2--member-add--other--other', i18n, {
adderName: renderContact(from),
addeeName: renderContact(uuid),
});
}
return renderString('GroupV2--member-add--other--unknown', i18n, {
memberName: renderContact(uuid),
});
}
if (detail.type === 'member-add-from-invite') {
const { uuid, inviter } = detail;
const weAreJoiner = isOurUuid(uuid);
const weAreInviter = isOurUuid(inviter);
if (!from || from !== uuid) {
if (weAreJoiner) {
// They can't be the same, no fromYou check here
if (from) {
return renderString('GroupV2--member-add--you--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--member-add--you--unknown', i18n);
}
if (fromYou) {
return renderString('GroupV2--member-add--invited--you', i18n, {
inviteeName: renderContact(uuid),
});
}
if (from) {
return renderString('GroupV2--member-add--invited--other', i18n, {
memberName: renderContact(from),
inviteeName: renderContact(uuid),
});
}
return renderString('GroupV2--member-add--invited--unknown', i18n, {
inviteeName: renderContact(uuid),
});
}
if (weAreJoiner) {
if (inviter) {
return renderString('GroupV2--member-add--from-invite--you', i18n, {
inviterName: renderContact(inviter),
});
}
return renderString(
'GroupV2--member-add--from-invite--you-no-from',
i18n
);
}
if (weAreInviter) {
return renderString('GroupV2--member-add--from-invite--from-you', i18n, {
inviteeName: renderContact(uuid),
});
}
if (inviter) {
return renderString('GroupV2--member-add--from-invite--other', i18n, {
inviteeName: renderContact(uuid),
inviterName: renderContact(inviter),
});
}
return renderString(
'GroupV2--member-add--from-invite--other-no-from',
i18n,
{
inviteeName: renderContact(uuid),
}
);
}
if (detail.type === 'member-add-from-link') {
const { uuid } = detail;
if (fromYou && isOurUuid(uuid)) {
return renderString('GroupV2--member-add-from-link--you--you', i18n);
}
if (from && uuid === from) {
return renderString('GroupV2--member-add-from-link--other', i18n, {
memberName: renderContact(from),
});
}
// Note: this shouldn't happen, because we only capture 'add-from-link' status
// from group change events, which always have a sender.
log.warn('member-add-from-link change type; we have no from!');
return renderString('GroupV2--member-add--other--unknown', i18n, {
memberName: renderContact(uuid),
});
}
if (detail.type === 'member-add-from-admin-approval') {
const { uuid } = detail;
const weAreJoiner = isOurUuid(uuid);
if (weAreJoiner) {
if (from) {
return renderString(
'GroupV2--member-add-from-admin-approval--you--other',
i18n,
{ adminName: renderContact(from) }
);
}
// Note: this shouldn't happen, because we only capture 'add-from-admin-approval'
// status from group change events, which always have a sender.
log.warn(
'member-add-from-admin-approval change type; we have no from, and we are joiner!'
);
return renderString(
'GroupV2--member-add-from-admin-approval--you--unknown',
i18n
);
}
if (fromYou) {
return renderString(
'GroupV2--member-add-from-admin-approval--other--you',
i18n,
{ joinerName: renderContact(uuid) }
);
}
if (from) {
return renderString(
'GroupV2--member-add-from-admin-approval--other--other',
i18n,
{
adminName: renderContact(from),
joinerName: renderContact(uuid),
}
);
}
// Note: this shouldn't happen, because we only capture 'add-from-admin-approval'
// status from group change events, which always have a sender.
log.warn('member-add-from-admin-approval change type; we have no from');
return renderString(
'GroupV2--member-add-from-admin-approval--other--unknown',
i18n,
{ joinerName: renderContact(uuid) }
);
}
if (detail.type === 'member-remove') {
const { uuid } = detail;
const weAreLeaver = isOurUuid(uuid);
if (weAreLeaver) {
if (fromYou) {
return renderString('GroupV2--member-remove--you--you', i18n);
}
if (from) {
return renderString('GroupV2--member-remove--you--other', i18n, {
adminName: renderContact(from),
});
}
return renderString('GroupV2--member-remove--you--unknown', i18n);
}
if (fromYou) {
return renderString('GroupV2--member-remove--other--you', i18n, {
memberName: renderContact(uuid),
});
}
if (from && from === uuid) {
return renderString('GroupV2--member-remove--other--self', i18n, {
memberName: renderContact(from),
});
}
if (from) {
return renderString('GroupV2--member-remove--other--other', i18n, {
adminName: renderContact(from),
memberName: renderContact(uuid),
});
}
return renderString('GroupV2--member-remove--other--unknown', i18n, {
memberName: renderContact(uuid),
});
}
if (detail.type === 'member-privilege') {
const { uuid, newPrivilege } = detail;
const weAreMember = isOurUuid(uuid);
if (newPrivilege === RoleEnum.ADMINISTRATOR) {
if (weAreMember) {
if (from) {
return renderString(
'GroupV2--member-privilege--promote--you--other',
i18n,
{ adminName: renderContact(from) }
);
}
return renderString(
'GroupV2--member-privilege--promote--you--unknown',
i18n
);
}
if (fromYou) {
return renderString(
'GroupV2--member-privilege--promote--other--you',
i18n,
{ memberName: renderContact(uuid) }
);
}
if (from) {
return renderString(
'GroupV2--member-privilege--promote--other--other',
i18n,
{
adminName: renderContact(from),
memberName: renderContact(uuid),
}
);
}
return renderString(
'GroupV2--member-privilege--promote--other--unknown',
i18n,
{ memberName: renderContact(uuid) }
);
}
if (newPrivilege === RoleEnum.DEFAULT) {
if (weAreMember) {
if (from) {
return renderString(
'GroupV2--member-privilege--demote--you--other',
i18n,
{ adminName: renderContact(from) }
);
}
return renderString(
'GroupV2--member-privilege--demote--you--unknown',
i18n
);
}
if (fromYou) {
return renderString(
'GroupV2--member-privilege--demote--other--you',
i18n,
{ memberName: renderContact(uuid) }
);
}
if (from) {
return renderString(
'GroupV2--member-privilege--demote--other--other',
i18n,
{
adminName: renderContact(from),
memberName: renderContact(uuid),
}
);
}
return renderString(
'GroupV2--member-privilege--demote--other--unknown',
i18n,
{ memberName: renderContact(uuid) }
);
}
log.warn(
`member-privilege change type, privilege ${newPrivilege} is unknown`
);
return '';
}
if (detail.type === 'pending-add-one') {
const { uuid } = detail;
const weAreInvited = isOurUuid(uuid);
if (weAreInvited) {
if (from) {
return renderString('GroupV2--pending-add--one--you--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--pending-add--one--you--unknown', i18n);
}
if (fromYou) {
return renderString('GroupV2--pending-add--one--other--you', i18n, {
inviteeName: renderContact(uuid),
});
}
if (from) {
return renderString('GroupV2--pending-add--one--other--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--pending-add--one--other--unknown', i18n);
}
if (detail.type === 'pending-add-many') {
const { count } = detail;
if (fromYou) {
return renderString('GroupV2--pending-add--many--you', i18n, {
count: count.toString(),
});
}
if (from) {
return renderString('GroupV2--pending-add--many--other', i18n, {
memberName: renderContact(from),
count: count.toString(),
});
}
return renderString('GroupV2--pending-add--many--unknown', i18n, {
count: count.toString(),
});
}
if (detail.type === 'pending-remove-one') {
const { inviter, uuid } = detail;
const weAreInviter = isOurUuid(inviter);
const weAreInvited = isOurUuid(uuid);
const sentByInvited = Boolean(from && from === uuid);
const sentByInviter = Boolean(from && inviter && from === inviter);
if (weAreInviter) {
if (sentByInvited) {
return renderString('GroupV2--pending-remove--decline--you', i18n, {
inviteeName: renderContact(uuid),
});
}
if (fromYou) {
return renderString(
'GroupV2--pending-remove--revoke-invite-from-you--one--you',
i18n,
{ inviteeName: renderContact(uuid) }
);
}
if (from) {
return renderString(
'GroupV2--pending-remove--revoke-invite-from-you--one--other',
i18n,
{
adminName: renderContact(from),
inviteeName: renderContact(uuid),
}
);
}
return renderString(
'GroupV2--pending-remove--revoke-invite-from-you--one--unknown',
i18n,
{ inviteeName: renderContact(uuid) }
);
}
if (sentByInvited) {
if (fromYou) {
return renderString('GroupV2--pending-remove--decline--from-you', i18n);
}
if (inviter) {
return renderString('GroupV2--pending-remove--decline--other', i18n, {
memberName: renderContact(inviter),
});
}
return renderString('GroupV2--pending-remove--decline--unknown', i18n);
}
if (inviter && sentByInviter) {
if (weAreInvited) {
return renderString(
'GroupV2--pending-remove--revoke-own--to-you',
i18n,
{ inviterName: renderContact(inviter) }
);
}
return renderString(
'GroupV2--pending-remove--revoke-own--unknown',
i18n,
{ inviterName: renderContact(inviter) }
);
}
if (inviter) {
if (fromYou) {
return renderString(
'GroupV2--pending-remove--revoke-invite-from--one--you',
i18n,
{ memberName: renderContact(inviter) }
);
}
if (from) {
return renderString(
'GroupV2--pending-remove--revoke-invite-from--one--other',
i18n,
{
adminName: renderContact(from),
memberName: renderContact(inviter),
}
);
}
return renderString(
'GroupV2--pending-remove--revoke-invite-from--one--unknown',
i18n,
{ memberName: renderContact(inviter) }
);
}
if (fromYou) {
return renderString('GroupV2--pending-remove--revoke--one--you', i18n);
}
if (from) {
return renderString('GroupV2--pending-remove--revoke--one--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--pending-remove--revoke--one--unknown', i18n);
}
if (detail.type === 'pending-remove-many') {
const { count, inviter } = detail;
const weAreInviter = isOurUuid(inviter);
if (weAreInviter) {
if (fromYou) {
return renderString(
'GroupV2--pending-remove--revoke-invite-from-you--many--you',
i18n,
{ count: count.toString() }
);
}
if (from) {
return renderString(
'GroupV2--pending-remove--revoke-invite-from-you--many--other',
i18n,
{
adminName: renderContact(from),
count: count.toString(),
}
);
}
return renderString(
'GroupV2--pending-remove--revoke-invite-from-you--many--unknown',
i18n,
{ count: count.toString() }
);
}
if (inviter) {
if (fromYou) {
return renderString(
'GroupV2--pending-remove--revoke-invite-from--many--you',
i18n,
{
count: count.toString(),
memberName: renderContact(inviter),
}
);
}
if (from) {
return renderString(
'GroupV2--pending-remove--revoke-invite-from--many--other',
i18n,
{
adminName: renderContact(from),
count: count.toString(),
memberName: renderContact(inviter),
}
);
}
return renderString(
'GroupV2--pending-remove--revoke-invite-from--many--unknown',
i18n,
{
count: count.toString(),
memberName: renderContact(inviter),
}
);
}
if (fromYou) {
return renderString('GroupV2--pending-remove--revoke--many--you', i18n, {
count: count.toString(),
});
}
if (from) {
return renderString(
'GroupV2--pending-remove--revoke--many--other',
i18n,
{
memberName: renderContact(from),
count: count.toString(),
}
);
}
return renderString(
'GroupV2--pending-remove--revoke--many--unknown',
i18n,
{ count: count.toString() }
);
}
if (detail.type === 'admin-approval-add-one') {
const { uuid } = detail;
const weAreJoiner = isOurUuid(uuid);
if (weAreJoiner) {
return renderString('GroupV2--admin-approval-add-one--you', i18n);
}
return renderString('GroupV2--admin-approval-add-one--other', i18n, {
joinerName: renderContact(uuid),
});
}
if (detail.type === 'admin-approval-remove-one') {
const { uuid } = detail;
const weAreJoiner = isOurUuid(uuid);
if (weAreJoiner) {
if (fromYou) {
return renderString(
'GroupV2--admin-approval-remove-one--you--you',
i18n
);
}
return renderString(
'GroupV2--admin-approval-remove-one--you--unknown',
i18n
);
}
if (fromYou) {
return renderString(
'GroupV2--admin-approval-remove-one--other--you',
i18n,
{ joinerName: renderContact(uuid) }
);
}
if (from && from === uuid) {
return renderString(
'GroupV2--admin-approval-remove-one--other--own',
i18n,
{ joinerName: renderContact(uuid) }
);
}
if (from) {
return renderString(
'GroupV2--admin-approval-remove-one--other--other',
i18n,
{
adminName: renderContact(from),
joinerName: renderContact(uuid),
}
);
}
// We default to the user canceling their request, because it is far more likely that
// if an admin does the denial, we'll get a change event from them.
return renderString(
'GroupV2--admin-approval-remove-one--other--own',
i18n,
{ joinerName: renderContact(uuid) }
);
}
if (detail.type === 'admin-approval-bounce') {
const { uuid, times, isApprovalPending } = detail;
let firstMessage: T | string;
if (times === 1) {
firstMessage = renderString('GroupV2--admin-approval-bounce--one', i18n, {
joinerName: renderContact(uuid),
});
} else {
firstMessage = renderString('GroupV2--admin-approval-bounce', i18n, {
joinerName: renderContact(uuid),
numberOfRequests: String(times),
});
}
if (!isApprovalPending) {
return firstMessage;
}
const secondMessage = renderChangeDetail(
{
type: 'admin-approval-add-one',
uuid,
},
options
);
return [
firstMessage,
...(Array.isArray(secondMessage) ? secondMessage : [secondMessage]),
];
}
if (detail.type === 'group-link-add') {
const { privilege } = detail;
if (privilege === AccessControlEnum.ADMINISTRATOR) {
if (fromYou) {
return renderString('GroupV2--group-link-add--enabled--you', i18n);
}
if (from) {
return renderString('GroupV2--group-link-add--enabled--other', i18n, {
adminName: renderContact(from),
});
}
return renderString('GroupV2--group-link-add--enabled--unknown', i18n);
}
if (privilege === AccessControlEnum.ANY) {
if (fromYou) {
return renderString('GroupV2--group-link-add--disabled--you', i18n);
}
if (from) {
return renderString('GroupV2--group-link-add--disabled--other', i18n, {
adminName: renderContact(from),
});
}
return renderString('GroupV2--group-link-add--disabled--unknown', i18n);
}
log.warn(`group-link-add change type, privilege ${privilege} is unknown`);
return '';
}
if (detail.type === 'group-link-reset') {
if (fromYou) {
return renderString('GroupV2--group-link-reset--you', i18n);
}
if (from) {
return renderString('GroupV2--group-link-reset--other', i18n, {
adminName: renderContact(from),
});
}
return renderString('GroupV2--group-link-reset--unknown', i18n);
}
if (detail.type === 'group-link-remove') {
if (fromYou) {
return renderString('GroupV2--group-link-remove--you', i18n);
}
if (from) {
return renderString('GroupV2--group-link-remove--other', i18n, {
adminName: renderContact(from),
});
}
return renderString('GroupV2--group-link-remove--unknown', i18n);
}
if (detail.type === 'description') {
if (detail.removed) {
if (fromYou) {
return renderString('GroupV2--description--remove--you', i18n);
}
if (from) {
return renderString('GroupV2--description--remove--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--description--remove--unknown', i18n);
}
if (fromYou) {
return renderString('GroupV2--description--change--you', i18n);
}
if (from) {
return renderString('GroupV2--description--change--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--description--change--unknown', i18n);
}
if (detail.type === 'announcements-only') {
if (detail.announcementsOnly) {
if (fromYou) {
return renderString('GroupV2--announcements--admin--you', i18n);
}
if (from) {
return renderString('GroupV2--announcements--admin--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--announcements--admin--unknown', i18n);
}
if (fromYou) {
return renderString('GroupV2--announcements--member--you', i18n);
}
if (from) {
return renderString('GroupV2--announcements--member--other', i18n, {
memberName: renderContact(from),
});
}
return renderString('GroupV2--announcements--member--unknown', i18n);
}
if (detail.type === 'summary') {
return renderString('icu:GroupV2--summary', i18n);
}
throw missingCaseError(detail);
}