utils/common/ConfigUtils.ts

/*
 * Copyright (c) 2024 - 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import { ALERT_LEVEL, ExtRuleSet, Rule } from '../../model/Rule';
import { FileUtils } from './FileUtils';
import Logger, { LOG_MODULE_TYPE } from 'arkanalyzer/lib/utils/logger';
import { Utils } from './Utils';
import { execSync } from 'child_process';
import { Json5parser } from './Json5parser';
import { OptionValues } from 'commander';
import { CheckerStorage } from './CheckerStorage';
import path from 'path';
import { CheckEntry } from './CheckEntry';
import { RuleConfig } from '../../model/RuleConfig';
import { ProjectConfig } from '../../model/ProjectConfig';
import { file2CheckRuleMap, project2CheckRuleMap } from './CheckerIndex';
import fs from 'fs';
import { Message, MessageType } from '../../model/Message';

const logger = Logger.getLogger(LOG_MODULE_TYPE.HOMECHECK, 'ConfigUtils');

export class ConfigUtils {
    /**
     * 获取配置文件
     * @param configPath 配置文件路径
     * @param rootDir 根目录，可选参数
     * @returns 返回解析后的配置对象，如果解析失败则返回null
     */
    public static getConfig(configPath: string, rootDir?: string): any | null {
        if (!fs.existsSync(configPath) && rootDir) {
            // 规则配置文件不存在，使用默认配置文件
            configPath = path.join(rootDir, 'config', 'ruleConfg.json');
        }

        try {
            return Json5parser.parseJsonText(FileUtils.readFile(configPath));
        } catch (e) {
            logger.error(e);
            return null;
        }
    }

    /**
     * 解析配置文件并设置检查入口
     * @param argvObj 命令行参数对象
     * @param checkEntry 检查入口对象
     * @returns 是否成功解析配置文件
     */
    public static parseConfig(argvObj: OptionValues, checkEntry: CheckEntry): boolean {
        const ruleConfig = ConfigUtils.getConfig(argvObj.configPath, argvObj.arkCheckPath);
        const projectConfig = ConfigUtils.getConfig(argvObj.projectConfigPath);
        if (!ruleConfig || !projectConfig) {
            return false;
        }

        // 解析规则配置文件
        checkEntry.ruleConfig = new RuleConfig(ruleConfig);
        // 解析项目配置文件
        checkEntry.projectConfig = new ProjectConfig(projectConfig);
        // 日志配置
        const logPath = checkEntry.projectConfig.logPath;
        Utils.setLogPath(logPath.length === 0 ? './HomeCheck.log' : logPath);
        logger.info('Checking started.');
        // api版本配置
        CheckerStorage.getInstance().setApiVersion(checkEntry.projectConfig.apiVersion);
        // product配置
        CheckerStorage.getInstance().setProduct(checkEntry.projectConfig.product);
        return true;
    }

    /**
     * 从配置文件中获取规则
     * @param ruleConfig 规则配置
     * @param projectConfig 项目配置
     * @param message 消息通知实例
     * @returns Map, ruleId -- Rule
     */
    public static getRuleMap(ruleConfig: RuleConfig, projectConfig: ProjectConfig, message: Message): Map<string, Rule> {
        let ruleMap: Map<string, Rule> = new Map();
        const allRules = ConfigUtils.getRuleSetMap(projectConfig.arkCheckPath);
        for (const ruleSetStr of ruleConfig.ruleSet ?? []) {
            const ruleSet = allRules.get(ruleSetStr);
            if (!ruleSet) {
                logger.error('Invalid ruleSet name: ' + ruleSetStr);
                continue;
            }
            for (const [ruleId, level] of Object.entries(ruleSet)) {
                const alert = Utils.getEnumValues(level, ALERT_LEVEL);
                const rule = new Rule(ruleId, alert);
                ruleMap.set(rule.ruleId, rule);
            }
        }

        for (const ruleInfo of Object.entries(ruleConfig.rules ?? {})) {
            if (!this.isOnlineRule(ruleInfo[0], allRules)) {
                logger.error('Invalid rule name: ' + ruleInfo[0]);
                continue;
            }
            const rule = this.genRuleByOneRuleCfg(ruleInfo);
            if (!rule) {
                continue;
            }
            ruleMap.set(rule.ruleId, rule);
        }

        // override 独有配置
        Object.entries(ruleConfig.extRules ?? {}).forEach(ruleInfo => {
            const rule = this.genRuleByOneRuleCfg(ruleInfo);
            if (!rule) {
                return;
            }
            ruleMap.set(rule.ruleId, rule);
        });

        // 解析自定义规则集配置
        this.parseExtRuleConfig(ruleConfig, projectConfig, message, allRules, ruleMap);
        return ruleMap;
    }

    /**
     * 解析自定义规则配置
     * @param ruleConfig 规则配置
     * @param projectConfig 项目配置
     * @param message 消息对象
     * @param allRules 所有规则集合
     * @param ruleMap 规则映射
     */
    private static parseExtRuleConfig(ruleConfig: RuleConfig, projectConfig: ProjectConfig, message: Message,
        allRules: Map<string, object>, ruleMap: Map<string, Rule>): void {
        logger.info('The npmPath:' + projectConfig.npmPath);
        logger.info('The npmInstallDir:' + projectConfig.npmInstallDir);
        const extRuleSetSet = new Set<string>();
        (ruleConfig.extRuleSet as ExtRuleSet[]).forEach((ruleSet) => {
            if (!this.checkExtRuleSetConfig(ruleSet, allRules, extRuleSetSet, message)) {
                return;
            }
            try {
                const cmd = `${projectConfig.npmPath} install --no-save --prefix "${projectConfig.npmInstallDir}" "${ruleSet.packagePath}"`;
                logger.info('Start to execute cmd: ' + cmd);
                const execLog = execSync(cmd);
                logger.info('Exec log: ' + execLog.toString());
            } catch (e) {
                logger.error((e as Error).message);
                return;
            }
            logger.info('npm install completed.');

            let extPkg: any = null;
            try {
                extPkg = require(path.resolve(projectConfig.npmInstallDir, 'node_modules', ruleSet.ruleSetName));
            } catch (e) {
                logger.error((e as Error).message);
                message?.messageNotify(MessageType.CHECK_WARN, `Failed to get ${ruleSet.ruleSetName}, please check the ruleSetName.`);
                return;
            }
            extRuleSetSet.add(ruleSet.ruleSetName);

            this.processExternalRules(ruleSet, allRules, extPkg, message, ruleMap);
        });
    }

    private static processExternalRules(ruleSet: ExtRuleSet, allRules: Map<string, object>, extPkg: any, message: Message, ruleMap: Map<string, Rule>): void {
        Object.entries(ruleSet.extRules ?? {}).forEach(ruleInfo => {
            if (this.isOnlineRule(ruleInfo[0], allRules)) {
                message?.messageNotify(MessageType.CHECK_WARN, `The extRuleName can't be the same as the internal rules name, name = ${ruleInfo[0]}.`);
                return;
            }
            const rule = this.genRuleByOneRuleCfg(ruleInfo);
            if (!rule) {
                return;
            }
            let module = extPkg?.file2CheckRuleMap?.get(rule.ruleId);
            if (module) {
                file2CheckRuleMap.set(rule.ruleId, module);
            } else {
                module = extPkg?.project2CheckRuleMap?.get(rule.ruleId);
                if (module) {
                    project2CheckRuleMap.set(rule.ruleId, module);
                } else {
                    message?.messageNotify(MessageType.CHECK_WARN, `Failed to get '${rule.ruleId}' in '${ruleSet.ruleSetName}', please check the extRules.`);
                    return;
                }
            }
            ruleMap.set(rule.ruleId, rule);
        });
    }

    /**
     * 通过单个规则配置生成Rule对象，eg: '@ruleSet/ruleName': 'error' | ['error', []...]
     * @param ruleCfg - 规则配置，格式为 [string, any]
     * @returns Rule | null - 生成的规则对象或 null
     */
    private static genRuleByOneRuleCfg(ruleCfg: [string, any]): Rule | null {
        let alert = ALERT_LEVEL.SUGGESTION;
        let option: any[] = [];
        if (ruleCfg[1] instanceof Array) {
            alert = Utils.getEnumValues(ruleCfg[1][0], ALERT_LEVEL);
            for (let i = 1; i < ruleCfg[1].length; i++) {
                option.push(ruleCfg[1][i]);
            }
        } else {
            alert = Utils.getEnumValues(ruleCfg[1], ALERT_LEVEL);
        }
        const rule = new Rule(ruleCfg[0], alert);
        rule.option = option;
        return rule;
    }

    /**
     * 读取RuleSet.json中配置的规则集
     */
    static getRuleSetMap(rootDir: string): Map<string, object> {
        const ruleSetMap: Map<string, object> = new Map();
        try {
            const fileStr = FileUtils.readFile(path.join(rootDir, 'ruleSet.json'));
            const config: Record<string, object> = JSON.parse(fileStr);
            for (const [key, value] of Object.entries(config)) {
                ruleSetMap.set(key, value);
            }
        } catch (error) {
            logger.error((error as Error).message);
        }
        return ruleSetMap;
    }

    /**
     * 检查指定的规则是否存在
     * @param ruleId - 要检查的规则ID
     * @param allRules - 包含所有规则的Map对象
     * @returns 如果规则存在则返回true，否则返回false
     */
    static isOnlineRule(ruleId: string, allRules: Map<string, object>): boolean {
        for (const [ruleSet, rules] of allRules) {
            if (Object.keys(rules).includes(ruleId)) {
                return true;
            }
        }
        return false;
    }

    /**
     * 检查自定义规则集配置的有效性
     * @param ruleSet - 自定义规则集
     * @param allRules - 所有规则集合
     * @param extRuleSetSet - 自定义规则集集合
     * @param message - 消息对象
     * @returns {boolean} - 是否通过检查
     */
    static checkExtRuleSetConfig(ruleSet: ExtRuleSet, allRules: Map<string, object>, extRuleSetSet: Set<string>, message: Message): boolean {
        if (allRules.get(`${ruleSet.ruleSetName}`)) {
            message?.messageNotify(MessageType.CHECK_WARN, `The extRuleSetName can't be the same as the name of internal rule set name, name = ${ruleSet.ruleSetName}.`);
            return false;
        }
        if (!ruleSet.packagePath || ruleSet.packagePath.length === 0 || FileUtils.isExistsSync(ruleSet.packagePath) === false) {
            message?.messageNotify(MessageType.CHECK_WARN, `'${ruleSet.packagePath}' is invalid or not exist, please check the packagePath.`);
            return false;
        }
        if (extRuleSetSet.has(ruleSet.ruleSetName)) {
            message?.messageNotify(MessageType.CHECK_WARN, `'${ruleSet.ruleSetName}' is conflict, please check the ruleSetName.`);
            return false;
        }
        return true;
    }
}