-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #835 from nextcloud/feat/settings
feat: add application config aka settings
- Loading branch information
Showing
21 changed files
with
631 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /* | ||
| * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| import { join } from 'node:path' | ||
| import { readFile, writeFile } from 'node:fs/promises' | ||
| import { app } from 'electron' | ||
| import { isLinux } from '../shared/os.utils.js' | ||
|
|
||
| const APP_CONFIG_FILE_NAME = 'config.json' | ||
|
|
||
| // Windows: C:\Users\<username>\AppData\Roaming\Nextcloud Talk\config.json | ||
| // Linux: ~/.config/Nextcloud Talk/config.json (or $XDG_CONFIG_HOME) | ||
| // macOS: ~/Library/Application Support/Nextcloud Talk/config.json | ||
| const APP_CONFIG_FILE_PATH = join(app.getPath('userData'), APP_CONFIG_FILE_NAME) | ||
|
|
||
| /** | ||
| * Application level config. Applied to all accounts and persist on re-login. | ||
| * Stored in the application data directory. | ||
| */ | ||
| export type AppConfig = { | ||
| // ---------------- | ||
| // General settings | ||
| // ---------------- | ||
|
|
||
| // Nothing yet... | ||
|
|
||
| // ------------------- | ||
| // Appearance settings | ||
| // ------------------- | ||
|
|
||
| /** | ||
| * Application theme. | ||
| * Default: 'default' to follow the system theme. | ||
| */ | ||
| theme: 'default' | 'dark' | 'light' | ||
| /** | ||
| * Whether to use a custom title bar or the system default. | ||
| * Default: true on Linux, false otherwise. | ||
| */ | ||
| systemTitleBar: boolean | ||
|
|
||
| // ---------------- | ||
| // Privacy settings | ||
| // ---------------- | ||
|
|
||
| // Nothing yet... | ||
|
|
||
| // ---------------------- | ||
| // Notifications settings | ||
| // ---------------------- | ||
|
|
||
| // Nothing yet... | ||
| } | ||
|
|
||
| /** | ||
| * Get the default config | ||
| */ | ||
| const defaultAppConfig: AppConfig = { | ||
| theme: 'default', | ||
| systemTitleBar: isLinux(), | ||
| } | ||
|
|
||
| /** Local cache of the config file mixed with the default values */ | ||
| const appConfig: Partial<AppConfig> = {} | ||
| /** Whether the application config has been read from the config file and ready to use */ | ||
| let initialized = false | ||
|
|
||
| /** | ||
| * Read the application config from the file | ||
| */ | ||
| async function readAppConfigFile(): Promise<Partial<AppConfig>> { | ||
| try { | ||
| const content = await readFile(APP_CONFIG_FILE_PATH, 'utf-8') | ||
| return JSON.parse(content) | ||
| } catch (error) { | ||
| if (error instanceof Error && 'code' in error && error.code !== 'ENOENT') { | ||
| console.error('Failed to read the application config file', error) | ||
| } | ||
| // No file or invalid file - no custom config | ||
| return {} | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Write the application config to the config file | ||
| * @param config - The config to write | ||
| */ | ||
| async function writeAppConfigFile(config: Partial<AppConfig>) { | ||
| try { | ||
| // Format for readability | ||
| const content = JSON.stringify(config, null, 2) | ||
| await writeFile(APP_CONFIG_FILE_PATH, content) | ||
| } catch (error) { | ||
| console.error('Failed to write the application config file', error) | ||
| throw error | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Load the application config into the application memory | ||
| */ | ||
| export async function loadAppConfig() { | ||
| const config = await readAppConfigFile() | ||
| Object.assign(appConfig, config) | ||
| initialized = true | ||
| } | ||
|
|
||
| export function getAppConfig(): AppConfig | ||
| export function getAppConfig<T extends keyof AppConfig>(key?: T): AppConfig[T] | ||
| /** | ||
| * Get an application config value | ||
| * @param key - The config key to get | ||
| * @return - If key is provided, the value of the key. Otherwise, the full config | ||
| */ | ||
| export function getAppConfig<T extends keyof AppConfig>(key?: T): AppConfig | AppConfig[T] { | ||
| if (!initialized) { | ||
| throw new Error('The application config is not initialized yet') | ||
| } | ||
|
|
||
| const config = Object.assign({}, defaultAppConfig, appConfig) | ||
|
|
||
| if (key) { | ||
| return config[key] | ||
| } | ||
|
|
||
| return config | ||
| } | ||
|
|
||
| /** | ||
| * Set an application config value | ||
| * @param key - Settings key to set | ||
| * @param value - Value to set or undefined to reset to the default value | ||
| * @return Promise<AppConfig> - The full settings after the change | ||
| */ | ||
| export async function setAppConfig<K extends keyof AppConfig>(key: K, value?: AppConfig[K]) { | ||
| if (value !== undefined) { | ||
| appConfig[key] = value | ||
| } else { | ||
| delete appConfig[key] | ||
| } | ||
| await writeAppConfigFile(appConfig) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| import type { AppConfig } from '../app/AppConfig.ts' | ||
|
|
||
| let appConfig: AppConfig | null = null | ||
|
|
||
| /** | ||
| * Initialize the AppConfig | ||
| */ | ||
| export async function initAppConfig() { | ||
| if (appConfig) { | ||
| return | ||
| } | ||
|
|
||
| appConfig = await window.TALK_DESKTOP.getAppConfig() | ||
| } | ||
|
|
||
| /** | ||
| * Get AppConfig | ||
| * @return - AppConfig | ||
| */ | ||
| export function getAppConfig() { | ||
| if (!appConfig) { | ||
| throw new Error('AppConfig is not initialized') | ||
| } | ||
|
|
||
| return appConfig | ||
| } | ||
|
|
||
| /** | ||
| * Get an application config value | ||
| * @param key - The key of the config value | ||
| * @return - The config value | ||
| */ | ||
| export function getAppConfigValue<K extends keyof AppConfig>(key: K) { | ||
| if (!appConfig) { | ||
| throw new Error('AppConfig is not initialized') | ||
| } | ||
|
|
||
| return appConfig[key] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.