Method __format_rules

client/tool/regexscan.py:142–186

把[{'name':str, 'params':str}...]格式的rule_list转换为 rule_name-value的格式，并把reg_exp编译好 :param rule_list: [{'name':str, 'params':str}...] :return: { rule_name: { 'reg_pattern': reg_pattern, 'exclude': exclude_paths, 'include': inclu

(self, rule_list)

class RegexScan(CodeLintModel):
    def __format_rules(self, rule_list):
        """把[{'name':str, 'params':str}...]格式的rule_list转换为 rule_name-value的格式，并把reg_exp编译好
        :param rule_list: [{'name':str, 'params':str}...]
        :return: {
            rule_name: {
                'reg_pattern': reg_pattern,
                'exclude': exclude_paths,
                'include': include_paths,
                'msg': msg,
                'ignore_comment': True|False
            }
        }
        """
        rules = {}
        for rule in rule_list:
            rule_name = rule['name']
            if not rule.get('params'):
                logger.error(f"{rule_name} rule parameter is empty, check for existing rules.")
                continue
            if "[regexcheck]" in rule['params']:
                rule_params = rule['params']
            else:
                rule_params = "[regexcheck]\r\n" + rule['params']
            rule_params_dict = ConfigReader(cfg_string=rule_params).read('regexcheck')

            reg_exp = rule_params_dict.get('regex', '')
            if not reg_exp:
                logger.error(f"{rule_name} rule parameter is wrong, not fill in the regular expression, skip this rule.")
                continue
            reg_pattern = re.compile(reg_exp)
            exclude_paths = rule_params_dict.get('exclude', '')
            exclude_paths = [p.strip() for p in exclude_paths.split(';') if p.strip()] if exclude_paths else []
            include_paths = rule_params_dict.get('include', '')
            include_paths = [p.strip() for p in include_paths.split(';') if p.strip()] if include_paths else []
            # 大小写不敏感,可以支持True|true|False|false等
            ignore_comment = True if rule_params_dict.get('ignore_comment', 'False').lower() == 'true' else False
            msg = rule_params_dict.get('msg', "Irregular codes found: %s")
            rules[rule_name] = {
                'reg_pattern': reg_pattern,
                'exclude': exclude_paths,
                'include': include_paths,
                'msg': msg,
                'ignore_comment': ignore_comment
            }
        return rules

    def analyze(self, params):
        """执行扫描任务