xref: /MusicFree/src/core/config.ts (revision 268ffae051f9727ffd7aa44d5171e698a9dc4fd2) 
1// import {Quality} from '@/constants/commonConst';
2import {CustomizedColors} from '@/hooks/useColors';
3import {getStorage, setStorage} from '@/utils/storage';
4import produce from 'immer';
5import {useEffect, useState} from 'react';
6
7type ExceptionType = IMusic.IMusicItem | IMusic.IMusicItem[] | IMusic.IQuality;
8interface IConfig {
9    setting: {
10        basic: {
11            autoPlayWhenAppStart: boolean;
12            /** 使用移动网络播放 */
13            useCelluarNetworkPlay: boolean;
14            /** 使用移动网络下载 */
15            useCelluarNetworkDownload: boolean;
16            /** 最大同时下载 */
17            maxDownload: number | string;
18            /** 播放歌曲行为 */
19            clickMusicInSearch: '播放歌曲' | '播放歌曲并替换播放列表';
20            /** 点击专辑单曲 */
21            clickMusicInAlbum: '播放专辑' | '播放单曲';
22            /** 下载文件夹 */
23            downloadPath: string;
24            /** 同时播放 */
25            notInterrupt: boolean;
26            /** 打断时 */
27            tempRemoteDuck: '暂停' | '降低音量';
28            /** 播放错误时自动停止 */
29            autoStopWhenError: boolean;
30            /** 插件缓存策略 todo */
31            pluginCacheControl: string;
32            /** 最大音乐缓存 */
33            maxCacheSize: number;
34            /** 默认播放音质 */
35            defaultPlayQuality: IMusic.IQualityKey;
36            /** 音质顺序 */
37            playQualityOrder: 'asc' | 'desc';
38            /** 默认下载音质 */
39            defaultDownloadQuality: IMusic.IQualityKey;
40            /** 下载音质顺序 */
41            downloadQualityOrder: 'asc' | 'desc';
42            /** 歌曲详情页 */
43            musicDetailDefault: 'album' | 'lyric';
44            /** 歌曲详情页常亮 */
45            musicDetailAwake: boolean;
46            debug: {
47                errorLog: boolean;
48                traceLog: boolean;
49                devLog: boolean;
50            };
51            /** 最大历史记录条目 */
52            maxHistoryLen: number;
53            /** 启动时自动更新插件 */
54            autoUpdatePlugin: boolean;
55            // 不检查插件版本号
56            notCheckPluginVersion: boolean;
57            /** 关联歌词方式 */
58            associateLyricType: 'input' | 'search';
59        };
60        /** 歌词 */
61        lyric: {
62            showStatusBarLyric: boolean;
63            topPercent: number;
64            leftPercent: number;
65            align: number;
66            color: string;
67            backgroundColor: string;
68            widthPercent: number;
69            fontSize: number;
70        };
71
72        /** 主题 */
73        theme: {
74            background: string;
75            backgroundOpacity: number;
76            backgroundBlur: number;
77            colors: CustomizedColors;
78            followSystem: boolean;
79            selectedTheme: string;
80        };
81
82        backup: {
83            resumeMode: 'append' | 'overwrite';
84        };
85
86        plugin: {
87            subscribeUrl: string;
88        };
89        webdav: {
90            url: string;
91            username: string;
92            password: string;
93        };
94    };
95    status: {
96        music: {
97            /** 当前的音乐 */
98            track: IMusic.IMusicItem;
99            /** 进度 */
100            progress: number;
101            /** 模式 */
102            repeatMode: string;
103            /** 列表 */
104            musicQueue: IMusic.IMusicItem[];
105            /** 速度 */
106            rate: number;
107        };
108        app: {
109            /** 跳过特定版本 */
110            skipVersion: string;
111        };
112    };
113}
114
115type FilterType<T, R = never> = T extends Record<string | number, any>
116    ? {
117          [P in keyof T]: T[P] extends ExceptionType ? R : T[P];
118      }
119    : never;
120
121type KeyPaths<
122    T extends object,
123    Root extends boolean = true,
124    R = FilterType<T, ''>,
125    K extends keyof R = keyof R,
126> = K extends string | number
127    ?
128          | (Root extends true ? `${K}` : `.${K}`)
129          | (R[K] extends Record<string | number, any>
130                ? `${Root extends true ? `${K}` : `.${K}`}${KeyPaths<
131                      R[K],
132                      false
133                  >}`
134                : never)
135    : never;
136
137type KeyPathValue<T extends object, K extends string> = T extends Record<
138    string | number,
139    any
140>
141    ? K extends `${infer S}.${infer R}`
142        ? KeyPathValue<T[S], R>
143        : T[K]
144    : never;
145
146type KeyPathsObj<
147    T extends object,
148    K extends string = KeyPaths<T>,
149> = T extends Record<string | number, any>
150    ? {
151          [R in K]: KeyPathValue<T, R>;
152      }
153    : never;
154
155type DeepPartial<T> = {
156    [K in keyof T]?: T[K] extends Record<string | number, any>
157        ? T[K] extends ExceptionType
158            ? T[K]
159            : DeepPartial<T[K]>
160        : T[K];
161};
162
163export type IConfigPaths = KeyPaths<IConfig>;
164type PartialConfig = DeepPartial<IConfig> | null;
165type IConfigPathsObj = KeyPathsObj<DeepPartial<IConfig>, IConfigPaths>;
166
167let config: PartialConfig = null;
168/** 初始化config */
169async function setup() {
170    config = (await getStorage('local-config')) ?? {};
171    // await checkValidPath(['setting.theme.background']);
172    notify();
173}
174
175/** 设置config */
176async function setConfig<T extends IConfigPaths>(
177    key: T,
178    value: IConfigPathsObj[T],
179    shouldNotify = true,
180) {
181    if (config === null) {
182        return;
183    }
184    const keys = key.split('.');
185
186    const result = produce(config, draft => {
187        draft[keys[0] as keyof IConfig] = draft[keys[0] as keyof IConfig] ?? {};
188        let conf: any = draft[keys[0] as keyof IConfig];
189        for (let i = 1; i < keys.length - 1; ++i) {
190            if (!conf?.[keys[i]]) {
191                conf[keys[i]] = {};
192            }
193            conf = conf[keys[i]];
194        }
195        conf[keys[keys.length - 1]] = value;
196        return draft;
197    });
198
199    setStorage('local-config', result);
200    config = result;
201    if (shouldNotify) {
202        notify();
203    }
204}
205
206// todo: 获取兜底
207/** 获取config */
208function getConfig(): PartialConfig;
209function getConfig<T extends IConfigPaths>(key: T): IConfigPathsObj[T];
210function getConfig(key?: string) {
211    let result: any = config;
212    if (key && config) {
213        result = getPathValue(config, key);
214    }
215
216    return result;
217}
218
219/** 通过path获取值 */
220function getPathValue(obj: Record<string, any>, path: string) {
221    const keys = path.split('.');
222    let tmp = obj;
223    for (let i = 0; i < keys.length; ++i) {
224        tmp = tmp?.[keys[i]];
225    }
226    return tmp;
227}
228
229/** 同步hook */
230const notifyCbs = new Set<() => void>();
231function notify() {
232    notifyCbs.forEach(_ => _?.());
233}
234
235/** hook */
236function useConfig(): PartialConfig;
237function useConfig<T extends IConfigPaths>(key: T): IConfigPathsObj[T];
238function useConfig(key?: string) {
239    // TODO: 应该有性能损失
240    const [_cfg, _setCfg] = useState<PartialConfig>(config);
241    function setCfg() {
242        _setCfg(config);
243    }
244    useEffect(() => {
245        notifyCbs.add(setCfg);
246        return () => {
247            notifyCbs.delete(setCfg);
248        };
249    }, []);
250
251    if (key) {
252        return _cfg ? getPathValue(_cfg, key) : undefined;
253    } else {
254        return _cfg;
255    }
256}
257
258const Config = {
259    get: getConfig,
260    set: setConfig,
261    useConfig,
262    setup,
263};
264
265export default Config;
266