mirror of
https://github.com/signalapp/Signal-Desktop.git
synced 2026-05-03 14:51:18 +01:00
Introduce the new Settings tab
Co-authored-by: Jamie Kyle <jamie@signal.org> Co-authored-by: Fedor Indutny <indutny@signal.org> Co-authored-by: Fedor Indutny <79877362+indutny-signal@users.noreply.github.com>
This commit is contained in:
Scott Nonnenberg
GitHub
@@ -5,16 +5,13 @@ import type { BrowserWindow } from 'electron';
|
||||
import { ipcMain as ipc, session } from 'electron';
|
||||
import { EventEmitter } from 'events';
|
||||
|
||||
import * as log from '../logging/log';
|
||||
import { userConfig } from '../../app/user_config';
|
||||
import { ephemeralConfig } from '../../app/ephemeral_config';
|
||||
import { installPermissionsHandler } from '../../app/permissions';
|
||||
import { strictAssert } from '../util/assert';
|
||||
import { explodePromise } from '../util/explodePromise';
|
||||
import type {
|
||||
IPCEventsValuesType,
|
||||
IPCEventsCallbacksType,
|
||||
} from '../util/createIPCEvents';
|
||||
import type { EphemeralSettings, SettingsValuesType } from '../util/preload';
|
||||
|
||||
import type { EphemeralSettings } from '../util/preload';
|
||||
|
||||
const EPHEMERAL_NAME_MAP = new Map([
|
||||
['spellCheck', 'spell-check'],
|
||||
@@ -24,18 +21,8 @@ const EPHEMERAL_NAME_MAP = new Map([
|
||||
['contentProtection', 'contentProtection'],
|
||||
]);
|
||||
|
||||
type ResponseQueueEntry = Readonly<{
|
||||
resolve(value: unknown): void;
|
||||
reject(error: Error): void;
|
||||
}>;
|
||||
|
||||
type SettingChangeEventType<Key extends keyof SettingsValuesType> =
|
||||
`change:${Key}`;
|
||||
|
||||
export class SettingsChannel extends EventEmitter {
|
||||
#mainWindow?: BrowserWindow;
|
||||
readonly #responseQueue = new Map<number, ResponseQueueEntry>();
|
||||
#responseSeq = 0;
|
||||
|
||||
public setMainWindow(mainWindow: BrowserWindow | undefined): void {
|
||||
this.#mainWindow = mainWindow;
|
||||
@@ -45,81 +32,16 @@ export class SettingsChannel extends EventEmitter {
|
||||
return this.#mainWindow;
|
||||
}
|
||||
|
||||
public openSettingsTab(): void {
|
||||
if (!this.#mainWindow) {
|
||||
log.warn('openSettingsTab: No mainWindow, cannot open settings tab');
|
||||
return;
|
||||
}
|
||||
this.#mainWindow.webContents.send('open-settings-tab');
|
||||
this.#mainWindow.show();
|
||||
}
|
||||
|
||||
public install(): void {
|
||||
this.#installSetting('deviceName', { setter: false });
|
||||
this.#installSetting('phoneNumber', { setter: false });
|
||||
|
||||
// ChatColorPicker redux hookups
|
||||
this.#installCallback('getCustomColors');
|
||||
this.#installCallback('getConversationsWithCustomColor');
|
||||
this.#installCallback('resetAllChatColors');
|
||||
this.#installCallback('resetDefaultChatColor');
|
||||
this.#installCallback('addCustomColor');
|
||||
this.#installCallback('editCustomColor');
|
||||
this.#installCallback('removeCustomColor');
|
||||
this.#installCallback('removeCustomColorOnConversations');
|
||||
this.#installCallback('setGlobalDefaultConversationColor');
|
||||
this.#installCallback('getDefaultConversationColor');
|
||||
|
||||
// Various callbacks
|
||||
this.#installCallback('deleteAllMyStories');
|
||||
this.#installCallback('getAvailableIODevices');
|
||||
this.#installCallback('isPrimary');
|
||||
this.#installCallback('isInternalUser');
|
||||
this.#installCallback('syncRequest');
|
||||
this.#installCallback('setEmojiSkinToneDefault');
|
||||
this.#installCallback('getEmojiSkinToneDefault');
|
||||
this.#installCallback('exportLocalBackup');
|
||||
this.#installCallback('importLocalBackup');
|
||||
this.#installCallback('validateBackup');
|
||||
|
||||
// Backups
|
||||
this.#installSetting('backupFeatureEnabled', { setter: false });
|
||||
this.#installSetting('cloudBackupStatus', { setter: false });
|
||||
this.#installSetting('backupSubscriptionStatus', { setter: false });
|
||||
this.#installCallback('refreshCloudBackupStatus');
|
||||
this.#installCallback('refreshBackupSubscriptionStatus');
|
||||
|
||||
// Getters only. These are set by the primary device
|
||||
this.#installSetting('blockedCount', { setter: false });
|
||||
this.#installSetting('linkPreviewSetting', { setter: false });
|
||||
this.#installSetting('readReceiptSetting', { setter: false });
|
||||
this.#installSetting('typingIndicatorSetting', { setter: false });
|
||||
|
||||
this.#installSetting('hideMenuBar');
|
||||
this.#installSetting('notificationSetting');
|
||||
this.#installSetting('notificationDrawAttention');
|
||||
this.#installSetting('audioMessage');
|
||||
this.#installSetting('audioNotification');
|
||||
this.#installSetting('countMutedConversations');
|
||||
|
||||
this.#installSetting('sentMediaQualitySetting');
|
||||
this.#installSetting('textFormatting');
|
||||
|
||||
this.#installSetting('autoConvertEmoji');
|
||||
this.#installSetting('autoDownloadUpdate');
|
||||
this.#installSetting('autoDownloadAttachment');
|
||||
this.#installSetting('autoLaunch');
|
||||
|
||||
this.#installSetting('alwaysRelayCalls');
|
||||
this.#installSetting('callRingtoneNotification');
|
||||
this.#installSetting('callSystemNotification');
|
||||
this.#installSetting('incomingCallNotification');
|
||||
|
||||
// Media settings
|
||||
this.#installSetting('preferredAudioInputDevice');
|
||||
this.#installSetting('preferredAudioOutputDevice');
|
||||
this.#installSetting('preferredVideoInputDevice');
|
||||
|
||||
this.#installSetting('lastSyncTime');
|
||||
this.#installSetting('universalExpireTimer');
|
||||
|
||||
this.#installSetting('hasStoriesDisabled');
|
||||
this.#installSetting('zoomFactor');
|
||||
|
||||
this.#installSetting('phoneNumberDiscoverabilitySetting');
|
||||
this.#installSetting('phoneNumberSharingSetting');
|
||||
|
||||
this.#installEphemeralSetting('themeSetting');
|
||||
this.#installEphemeralSetting('systemTraySetting');
|
||||
this.#installEphemeralSetting('localeOverride');
|
||||
@@ -156,113 +78,6 @@ export class SettingsChannel extends EventEmitter {
|
||||
userConfig,
|
||||
});
|
||||
});
|
||||
|
||||
ipc.on('settings:response', (_event, seq, error, value) => {
|
||||
const entry = this.#responseQueue.get(seq);
|
||||
this.#responseQueue.delete(seq);
|
||||
if (!entry) {
|
||||
return;
|
||||
}
|
||||
|
||||
const { resolve, reject } = entry;
|
||||
if (error) {
|
||||
reject(error);
|
||||
} else {
|
||||
resolve(value);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
#waitForResponse<Value>(): { promise: Promise<Value>; seq: number } {
|
||||
const seq = this.#responseSeq;
|
||||
|
||||
// eslint-disable-next-line no-bitwise
|
||||
this.#responseSeq = (this.#responseSeq + 1) & 0x7fffffff;
|
||||
|
||||
const { promise, resolve, reject } = explodePromise<Value>();
|
||||
|
||||
this.#responseQueue.set(seq, { resolve, reject });
|
||||
|
||||
return { seq, promise };
|
||||
}
|
||||
|
||||
public getSettingFromMainWindow<Name extends keyof IPCEventsValuesType>(
|
||||
name: Name
|
||||
): Promise<IPCEventsValuesType[Name]> {
|
||||
const mainWindow = this.#mainWindow;
|
||||
if (!mainWindow || !mainWindow.webContents) {
|
||||
throw new Error('No main window');
|
||||
}
|
||||
|
||||
const { seq, promise } = this.#waitForResponse<IPCEventsValuesType[Name]>();
|
||||
|
||||
mainWindow.webContents.send(`settings:get:${name}`, { seq });
|
||||
|
||||
return promise;
|
||||
}
|
||||
|
||||
public setSettingInMainWindow<Name extends keyof IPCEventsValuesType>(
|
||||
name: Name,
|
||||
value: IPCEventsValuesType[Name]
|
||||
): Promise<void> {
|
||||
const mainWindow = this.#mainWindow;
|
||||
if (!mainWindow || !mainWindow.webContents) {
|
||||
throw new Error('No main window');
|
||||
}
|
||||
|
||||
const { seq, promise } = this.#waitForResponse<void>();
|
||||
|
||||
mainWindow.webContents.send(`settings:set:${name}`, { seq, value });
|
||||
|
||||
return promise;
|
||||
}
|
||||
|
||||
public invokeCallbackInMainWindow<Name extends keyof IPCEventsCallbacksType>(
|
||||
name: Name,
|
||||
args: ReadonlyArray<unknown>
|
||||
): Promise<unknown> {
|
||||
const mainWindow = this.#mainWindow;
|
||||
if (!mainWindow || !mainWindow.webContents) {
|
||||
throw new Error('Main window not found');
|
||||
}
|
||||
|
||||
const { seq, promise } = this.#waitForResponse<unknown>();
|
||||
|
||||
mainWindow.webContents.send(`settings:call:${name}`, { seq, args });
|
||||
|
||||
return promise;
|
||||
}
|
||||
|
||||
#installCallback<Name extends keyof IPCEventsCallbacksType>(
|
||||
name: Name
|
||||
): void {
|
||||
ipc.handle(`settings:call:${name}`, async (_event, args) => {
|
||||
return this.invokeCallbackInMainWindow(name, args);
|
||||
});
|
||||
}
|
||||
|
||||
#installSetting<Name extends keyof IPCEventsValuesType>(
|
||||
name: Name,
|
||||
{
|
||||
getter = true,
|
||||
setter = true,
|
||||
}: { getter?: boolean; setter?: boolean } = {}
|
||||
): void {
|
||||
if (getter) {
|
||||
ipc.handle(`settings:get:${name}`, async () => {
|
||||
return this.getSettingFromMainWindow(name);
|
||||
});
|
||||
}
|
||||
|
||||
if (!setter) {
|
||||
return;
|
||||
}
|
||||
|
||||
ipc.handle(`settings:set:${name}`, async (_event, value) => {
|
||||
await this.setSettingInMainWindow(name, value);
|
||||
|
||||
this.emit(`change:${name}`, value);
|
||||
});
|
||||
}
|
||||
|
||||
#installEphemeralSetting<Name extends keyof EphemeralSettings>(
|
||||
@@ -285,8 +100,6 @@ export class SettingsChannel extends EventEmitter {
|
||||
);
|
||||
ephemeralConfig.set(ephemeralName, value);
|
||||
|
||||
this.emit(`change:${name}`, value);
|
||||
|
||||
// Notify main to notify windows of preferences change. As for DB-backed
|
||||
// settings, those are set by the renderer, and afterwards the renderer IPC sends
|
||||
// to main the event 'preferences-changed'.
|
||||
@@ -313,12 +126,6 @@ export class SettingsChannel extends EventEmitter {
|
||||
callback: (name: string) => void
|
||||
): this;
|
||||
|
||||
public override on(
|
||||
type: SettingChangeEventType<keyof SettingsValuesType>,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
callback: (...args: Array<any>) => void
|
||||
): this;
|
||||
|
||||
public override on(
|
||||
type: string | symbol,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
@@ -337,12 +144,6 @@ export class SettingsChannel extends EventEmitter {
|
||||
name: string
|
||||
): boolean;
|
||||
|
||||
public override emit(
|
||||
type: SettingChangeEventType<keyof SettingsValuesType>,
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
...args: Array<any>
|
||||
): boolean;
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
public override emit(type: string | symbol, ...args: Array<any>): boolean {
|
||||
return super.emit(type, ...args);
|
||||
|
||||
Reference in New Issue
Block a user