src/services/ConfigManager.ts

/**
 * This file is part of SudoBot.
 *
 * Copyright (C) 2021-2023 OSN Developers.
 *
 * SudoBot is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SudoBot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
 */

import fs, { writeFile } from "fs/promises";
import { z } from "zod";
import Service from "../core/Service";
import { GuildConfigSchema } from "../types/GuildConfigSchema";
import { SystemConfig, SystemConfigSchema } from "../types/SystemConfigSchema";
import { log, logInfo } from "../utils/logger";
import { sudoPrefix } from "../utils/utils";

export * from "../types/GuildConfigSchema";

export const name = "configManager";

export const GuildConfigContainerSchema = z.record(z.string(), GuildConfigSchema.optional().or(z.undefined()));
export type GuildConfigContainer = z.infer<typeof GuildConfigContainerSchema>;

export default class ConfigManager extends Service {
    public readonly configPath = sudoPrefix("config/config.json");
    public readonly systemConfigPath = sudoPrefix("config/system.json");
    protected configSchemaPath = "";

    config: GuildConfigContainer = {} as GuildConfigContainer;
    systemConfig: SystemConfig = {} as SystemConfig;

    async boot() {
        await this.load();
    }

    async load() {
        log(`Loading system configuration from file: ${this.systemConfigPath}`);
        const systemConfigFileContents = await fs.readFile(this.systemConfigPath, { encoding: "utf-8" });

        log(`Loading guild configuration from file: ${this.configPath}`);
        const configFileContents = await fs.readFile(this.configPath, { encoding: "utf-8" });

        const configJSON = JSON.parse(configFileContents);

        if ("$schema" in configJSON) {
            this.configSchemaPath = configJSON.$schema;
            delete configJSON.$schema;
        }

        this.config = GuildConfigContainerSchema.parse(configJSON);
        this.systemConfig = SystemConfigSchema.parse(JSON.parse(systemConfigFileContents));
        logInfo("Successfully loaded the configuration files");
    }

    async write({ guild = true, system = false } = {}) {
        if (guild) {
            log(`Writing guild configuration to file: ${this.configPath}`);

            const json = JSON.stringify(
                {
                    $schema: this.configSchemaPath,
                    ...this.config
                },
                null,
                4
            );

            await writeFile(this.configPath, json, { encoding: "utf-8" });
        }

        if (system) {
            log(`Writing system configuration to file: ${this.systemConfigPath}`);

            const json = JSON.stringify(this.systemConfig, null, 4);
            await writeFile(this.systemConfigPath, json, { encoding: "utf-8" });
        }

        logInfo("Successfully wrote the configuration files");
    }
}
1	rakinar2	577	/**
2			* This file is part of SudoBot.
3			*
4			* Copyright (C) 2021-2023 OSN Developers.
5			*
6			* SudoBot is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU Affero General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* SudoBot is distributed in the hope that it will be useful, but
12			* WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU Affero General Public License for more details.
15			*
16			* You should have received a copy of the GNU Affero General Public License
17			* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18			*/
19
20			import fs, { writeFile } from "fs/promises";
21			import { z } from "zod";
22			import Service from "../core/Service";
23			import { GuildConfigSchema } from "../types/GuildConfigSchema";
24			import { SystemConfig, SystemConfigSchema } from "../types/SystemConfigSchema";
25			import { log, logInfo } from "../utils/logger";
26			import { sudoPrefix } from "../utils/utils";
27
28			export * from "../types/GuildConfigSchema";
29
30			export const name = "configManager";
31
32			export const GuildConfigContainerSchema = z.record(z.string(), GuildConfigSchema.optional().or(z.undefined()));
33			export type GuildConfigContainer = z.infer<typeof GuildConfigContainerSchema>;
34
35			export default class ConfigManager extends Service {
36			public readonly configPath = sudoPrefix("config/config.json");
37			public readonly systemConfigPath = sudoPrefix("config/system.json");
38			protected configSchemaPath = "";
39
40			config: GuildConfigContainer = {} as GuildConfigContainer;
41			systemConfig: SystemConfig = {} as SystemConfig;
42
43			async boot() {
44			await this.load();
45			}
46
47			async load() {
48			log(`Loading system configuration from file: ${this.systemConfigPath}`);
49			const systemConfigFileContents = await fs.readFile(this.systemConfigPath, { encoding: "utf-8" });
50
51			log(`Loading guild configuration from file: ${this.configPath}`);
52			const configFileContents = await fs.readFile(this.configPath, { encoding: "utf-8" });
53
54			const configJSON = JSON.parse(configFileContents);
55
56			if ("$schema" in configJSON) {
57			this.configSchemaPath = configJSON.$schema;
58			delete configJSON.$schema;
59			}
60
61			this.config = GuildConfigContainerSchema.parse(configJSON);
62			this.systemConfig = SystemConfigSchema.parse(JSON.parse(systemConfigFileContents));
63			logInfo("Successfully loaded the configuration files");
64			}
65
66			async write({ guild = true, system = false } = {}) {
67			if (guild) {
68			log(`Writing guild configuration to file: ${this.configPath}`);
69
70			const json = JSON.stringify(
71			{
72			$schema: this.configSchemaPath,
73			...this.config
74			},
75			null,
76			4
77			);
78
79			await writeFile(this.configPath, json, { encoding: "utf-8" });
80			}
81
82			if (system) {
83			log(`Writing system configuration to file: ${this.systemConfigPath}`);
84
85			const json = JSON.stringify(this.systemConfig, null, 4);
86			await writeFile(this.systemConfigPath, json, { encoding: "utf-8" });
87			}
88
89			logInfo("Successfully wrote the configuration files");
90			}
91			}