tree.py 16.4 KB
Newer Older
M
Mars Liu 已提交
1 2 3
import json
import logging
import os
M
Mars Liu 已提交
4
import subprocess
M
Mars Liu 已提交
5 6
import sys
import uuid
M
Mars Liu 已提交
7
import re
M
Mars Liu 已提交
8

M
Mars Liu 已提交
9 10
from parsec import BasicState, ParsecError

M
Mars Liu 已提交
11
from .exercises.markdown import parse
12
from .exercises.init_exercises import emit_head, emit_answer, emit_options, simple_list_md_dump
M
Mars Liu 已提交
13

M
Mars Liu 已提交
14 15 16 17 18 19 20 21 22
id_set = set()
logger = logging.getLogger(__name__)
logger.setLevel(logging.INFO)
handler = logging.StreamHandler(sys.stdout)
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)


M
Mars Liu 已提交
23 24 25 26 27 28
def search_author(author_dict, username):
    for key in author_dict:
        names = author_dict[key]
        if username in names:
            return key
    return username
M
Mars Liu 已提交
29 30


M
Mars Liu 已提交
31 32 33 34 35 36 37 38 39
def user_name(md_file, author_dict):
    ret = subprocess.Popen([
        "git", "log", md_file
    ], stdout=subprocess.PIPE)
    lines = list(map(lambda l: l.decode(), ret.stdout.readlines()))
    author_lines = []
    for line in lines:
        if line.startswith('Author'):
            author_lines.append(line.split(' ')[1])
40 41
    if len(author_lines) == 0:
        return None
M
Mars Liu 已提交
42 43
    author_nick_name = author_lines[-1]
    return search_author(author_dict, author_nick_name)
M
Mars Liu 已提交
44 45 46


def load_json(p):
M
Mars Liu 已提交
47
    with open(p, 'r', encoding="utf-8") as f:
M
Mars Liu 已提交
48 49 50
        try:
            return json.loads(f.read())
        except UnicodeDecodeError:
51 52
            logger.info(
                "json 文件 [{p}] 编码错误,请确保其内容保存为 utf-8 或 base64 后的 ascii 格式。")
M
Mars Liu 已提交
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70


def dump_json(p, j, exist_ok=False, override=False):
    if os.path.exists(p):
        if exist_ok:
            if not override:
                return
        else:
            logger.error(f"{p} already exist")
            sys.exit(0)

    with open(p, 'w+', encoding="utf8") as f:
        f.write(json.dumps(j, indent=2, ensure_ascii=False))


def ensure_config(path):
    config_path = os.path.join(path, "config.json")
    if not os.path.exists(config_path):
M
0.0.7  
Mars Liu 已提交
71 72 73
        node = {"keywords": [],
                "keywords_must": [],
                "keywords_forbid": []}
M
Mars Liu 已提交
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
        dump_json(config_path, node, exist_ok=True, override=False)
        return node
    else:
        return load_json(config_path)


def parse_no_name(d):
    p = r'(\d+)\.(.*)'
    m = re.search(p, d)

    try:
        no = int(m.group(1))
        dir_name = m.group(2)
    except:
        sys.exit(0)

    return no, dir_name


def check_export(base, cfg):
    flag = False
    exports = []
    for export in cfg.get('export', []):
        ecfg_path = os.path.join(base, export)
        if os.path.exists(ecfg_path):
            exports.append(export)
        else:
            flag = True
    if flag:
        cfg["export"] = exports
    return flag


class TreeWalker:
M
Mars Liu 已提交
108 109 110 111 112 113 114 115 116 117 118 119
    def __init__(
            self, root,
            tree_name,
            title=None,
            log=None,
            authors=None,
            enable_notebook=None,
            ignore_keywords=False
    ):
        self.ignore_keywords = ignore_keywords
        self.authors = authors if authors else {}
        self.enable_notebook = enable_notebook
M
Mars Liu 已提交
120 121 122 123 124 125 126 127 128 129
        self.name = tree_name
        self.root = root
        self.title = tree_name if title is None else title
        self.tree = {}
        self.logger = logger if log is None else log

    def walk(self):
        root = self.load_root()
        root_node = {
            "node_id": root["node_id"],
M
0.0.7  
Mars Liu 已提交
130
            "keywords": root.get("keywords", []),
M
Mars Liu 已提交
131
            "children": [],
M
0.0.6  
Mars Liu 已提交
132 133
            "keywords_must": root.get("keywords_must", []),
            "keywords_forbid": root.get("keywords_forbid", [])
M
Mars Liu 已提交
134 135 136 137 138 139 140 141 142 143 144 145
        }
        self.tree[root["tree_name"]] = root_node
        self.load_levels(root_node)
        self.load_chapters(self.root, root_node)
        for index, level in enumerate(root_node["children"]):
            level_title = list(level.keys())[0]
            level_node = list(level.values())[0]
            level_path = os.path.join(self.root, f"{index + 1}.{level_title}")
            self.load_chapters(level_path, level_node)
            for index, chapter in enumerate(level_node["children"]):
                chapter_title = list(chapter.keys())[0]
                chapter_node = list(chapter.values())[0]
M
Mars Liu 已提交
146 147
                chapter_path = os.path.join(
                    level_path, f"{index + 1}.{chapter_title}")
M
Mars Liu 已提交
148 149 150
                self.load_sections(chapter_path, chapter_node)
                for index, section_node in enumerate(chapter_node["children"]):
                    section_title = list(section_node.keys())[0]
M
Mars Liu 已提交
151 152
                    full_path = os.path.join(
                        chapter_path, f"{index + 1}.{section_title}")
M
Mars Liu 已提交
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
                    if os.path.isdir(full_path):
                        self.check_section_keywords(full_path)
                        self.ensure_exercises(full_path)

        tree_path = os.path.join(self.root, "tree.json")
        dump_json(tree_path, self.tree, exist_ok=True, override=True)
        return self.tree

    def sort_dir_list(self, dirs):
        result = [self.extract_node_env(dir) for dir in dirs]
        result.sort(key=lambda item: item[0])
        return result

    def load_levels(self, root_node):
        levels = []
        for level in os.listdir(self.root):
            if not os.path.isdir(level):
                continue
            level_path = os.path.join(self.root, level)
            num, config = self.load_level_node(level_path)
            levels.append((num, config))

        levels = self.resort_children(self.root, levels)
        root_node["children"] = [item[1] for item in levels]
        return root_node

    def load_level_node(self, level_path):
        config = self.ensure_level_config(level_path)
        num, name = self.extract_node_env(level_path)

        result = {
            name: {
                "node_id": config["node_id"],
                "keywords": config["keywords"],
                "children": [],
M
0.0.6  
Mars Liu 已提交
188 189
                "keywords_must": config.get("keywords_must", []),
                "keywords_forbid": config.get("keywords_forbid", [])
M
Mars Liu 已提交
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
            }
        }

        return num, result

    def load_chapters(self, base, level_node):
        chapters = []
        for name in os.listdir(base):
            full_name = os.path.join(base, name)
            if os.path.isdir(full_name):
                num, chapter = self.load_chapter_node(full_name)
                chapters.append((num, chapter))

        chapters = self.resort_children(base, chapters)
        level_node["children"] = [item[1] for item in chapters]
        return level_node

    def load_sections(self, base, chapter_node):
        sections = []
        for name in os.listdir(base):
            full_name = os.path.join(base, name)
            if os.path.isdir(full_name):
                num, section = self.load_section_node(full_name)
                sections.append((num, section))

        sections = self.resort_children(base, sections)
        chapter_node["children"] = [item[1] for item in sections]
        return chapter_node

    def resort_children(self, base, children):
        children.sort(key=lambda item: item[0])
        for index, [number, element] in enumerate(children):
            title = list(element.keys())[0]
            origin = os.path.join(base, f"{number}.{title}")
            posted = os.path.join(base, f"{index + 1}.{title}")
            if origin != posted:
                self.logger.info(f"rename [{origin}] to [{posted}]")
M
Mars Liu 已提交
227
            os.rename(origin, posted)
M
Mars Liu 已提交
228 229 230 231 232 233 234 235 236 237 238 239 240
        return children

    def ensure_chapters(self):
        for subdir in os.listdir(self.root):
            self.ensure_level_config(subdir)

    def load_root(self):
        config_path = os.path.join(self.root, "config.json")
        if not os.path.exists(config_path):
            config = {
                "tree_name": self.name,
                "keywords": [],
                "node_id": self.gen_node_id(),
M
Mars Liu 已提交
241 242
                "keywords_must": [],
                "keywords_forbid": []
M
Mars Liu 已提交
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
            }
            dump_json(config_path, config, exist_ok=True, override=True)
        else:
            config = load_json(config_path)
            flag, result = self.ensure_node_id(config)
            if flag:
                dump_json(config_path, result, exist_ok=True, override=True)

        return config

    def ensure_level_config(self, path):
        config_path = os.path.join(path, "config.json")
        if not os.path.exists(config_path):
            config = {
                "node_id": self.gen_node_id()
            }
            dump_json(config_path, config, exist_ok=True, override=True)
        else:
            config = load_json(config_path)
            flag, result = self.ensure_node_id(config)
            if flag:
                dump_json(config_path, config, exist_ok=True, override=True)
        return config

    def ensure_chapter_config(self, path):
        config_path = os.path.join(path, "config.json")
        if not os.path.exists(config_path):
            config = {
                "node_id": self.gen_node_id(),
M
Mars Liu 已提交
272 273 274
                "keywords": [],
                "keywords_must": [],
                "keywords_forbid": []
M
Mars Liu 已提交
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
            }
            dump_json(config_path, config, exist_ok=True, override=True)
        else:
            config = load_json(config_path)
            flag, result = self.ensure_node_id(config)
            if flag:
                dump_json(config_path, config, exist_ok=True, override=True)
        return config

    def ensure_section_config(self, path):
        config_path = os.path.join(path, "config.json")
        if not os.path.exists(config_path):
            config = {
                "node_id": self.gen_node_id(),
                "keywords": [],
                "children": [],
M
0.0.7  
Mars Liu 已提交
291 292 293
                "export": [],
                "keywords_must": [],
                "keywords_forbid": []
M
Mars Liu 已提交
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
            }
            dump_json(config_path, config, exist_ok=True, override=True)
        else:
            config = load_json(config_path)
            flag, result = self.ensure_node_id(config)
            if flag:
                dump_json(config_path, result, exist_ok=True, override=True)
        return config

    def ensure_node_id(self, config):
        flag = False
        if "node_id" not in config or \
                not config["node_id"].startswith(f"{self.name}-") or \
                config["node_id"] in id_set:
            new_id = self.gen_node_id()
            id_set.add(new_id)
            config["node_id"] = new_id
            flag = True

        for child in config.get("children", []):
            child_node = list(child.values())[0]
            f, _ = self.ensure_node_id(child_node)
            flag = flag or f

        return flag, config

    def gen_node_id(self):
        return f"{self.name}-{uuid.uuid4().hex}"

    def extract_node_env(self, path):
        try:
            _, dir = os.path.split(path)
            self.logger.info(path)
            number, title = dir.split(".", 1)
            return int(number), title
        except Exception as error:
            self.logger.error(f"目录 [{path}] 解析失败,结构不合法,可能是缺少序号")
            # sys.exit(1)
            raise error

    def load_chapter_node(self, full_name):
        config = self.ensure_chapter_config(full_name)
        num, name = self.extract_node_env(full_name)
        result = {
            name: {
                "node_id": config["node_id"],
                "keywords": config["keywords"],
                "children": [],
M
0.0.6  
Mars Liu 已提交
342 343
                "keywords_must": config.get("keywords_must", []),
                "keywords_forbid": config.get("keywords_forbid", [])
M
Mars Liu 已提交
344 345 346 347 348 349 350 351 352 353
            }
        }
        return num, result

    def load_section_node(self, full_name):
        config = self.ensure_section_config(full_name)
        num, name = self.extract_node_env(full_name)
        result = {
            name: {
                "node_id": config["node_id"],
M
0.0.7  
Mars Liu 已提交
354
                "keywords": config.get("keywords", []),
M
Mars Liu 已提交
355
                "children": config.get("children", []),
M
0.0.6  
Mars Liu 已提交
356 357
                "keywords_must": config.get("keywords_must", []),
                "keywords_forbid": config.get("keywords_forbid", [])
M
Mars Liu 已提交
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
            }
        }
        # if "children" in config:
        #     result["children"] = config["children"]
        return num, result

    def ensure_exercises(self, section_path):
        config = self.ensure_section_config(section_path)
        flag = False
        for e in os.listdir(section_path):
            base, ext = os.path.splitext(e)
            _, source = os.path.split(e)
            if ext != ".md":
                continue
            mfile = base + ".json"
            meta_path = os.path.join(section_path, mfile)
M
Mars Liu 已提交
374 375
            md_file = os.path.join(section_path, e)
            self.ensure_exercises_meta(meta_path, source, md_file)
M
Mars Liu 已提交
376 377 378 379 380
            export = config.get("export", [])
            if mfile not in export and self.name != "algorithm":
                export.append(mfile)
                flag = True
                config["export"] = export
381 382

            data = None
M
Mars Liu 已提交
383
            with open(md_file, "r", encoding="utf-8") as efile:
M
Mars Liu 已提交
384 385 386 387 388
                try:
                    data = efile.read()
                except UnicodeDecodeError:
                    logger.error(f"习题 [{md_file}] 编码错误,请确保其保存为 utf-8 编码")
                    sys.exit(1)
389 390 391 392 393 394 395 396 397 398

            if data.strip() == '':
                md = []
                emit_head(md)
                emit_answer(md, None)
                emit_options(md, None)
                simple_list_md_dump(md_file, md)

            data = None
            with open(md_file, "r", encoding="utf-8") as efile:
M
Mars Liu 已提交
399
                try:
400 401 402 403 404 405 406 407 408 409 410 411 412
                    data = efile.read()
                except UnicodeDecodeError:
                    logger.error(f"习题 [{md_file}] 编码错误,请确保其保存为 utf-8 编码")
                    sys.exit(1)

            state = BasicState(data)
            try:
                doc = parse(state)
            except ParsecError as err:
                index = state.index
                context = state.data[index - 15:index + 15]
                logger.error(
                    f"习题 [{md_file}] 解析失败,在位置 {index} [{context}] 附近有格式: [{err}]")
M
Mars Liu 已提交
413 414

        if flag:
M
Mars Liu 已提交
415 416
            dump_json(os.path.join(section_path, "config.json"),
                      config, True, True)
M
Mars Liu 已提交
417 418 419 420

        for e in config.get("export", []):
            full_name = os.path.join(section_path, e)
            exercise = load_json(full_name)
M
Mars Liu 已提交
421
            if "exercise_id" not in exercise or exercise.get("exercise_id") in id_set:
M
Mars Liu 已提交
422 423 424 425 426 427
                eid = uuid.uuid4().hex
                exercise["exercise_id"] = eid
                dump_json(full_name, exercise, True, True)
            else:
                id_set.add(exercise["exercise_id"])

M
Mars Liu 已提交
428
    def ensure_exercises_meta(self, meta_path, source, md_file):
M
Mars Liu 已提交
429 430 431
        _, mfile = os.path.split(meta_path)
        meta = None
        if os.path.exists(meta_path):
M
Mars Liu 已提交
432 433
            with open(meta_path) as f:
                content = f.read()
M
Mars Liu 已提交
434 435 436 437 438 439 440 441 442
            if content:
                meta = json.loads(content)
                if "exercise_id" not in meta:
                    meta["exercise_id"] = uuid.uuid4().hex
                if "notebook_enable" not in meta:
                    meta["notebook_enable"] = self.default_notebook()
                if "source" not in meta:
                    meta["source"] = source
                if "author" not in meta:
M
Mars Liu 已提交
443
                    meta["author"] = user_name(md_file, self.authors)
444 445
                elif meta['author'] is None:
                    meta["author"] = user_name(md_file, self.authors)
M
Mars Liu 已提交
446 447
                if "type" not in meta:
                    meta["type"] = "code_options"
M
Mars Liu 已提交
448 449 450 451 452 453 454 455 456

        if meta is None:
            meta = {
                "type": "code_options",
                "author": user_name(md_file, self.authors),
                "source": source,
                "notebook_enable": self.default_notebook(),
                "exercise_id": uuid.uuid4().hex
            }
M
Mars Liu 已提交
457 458 459
        dump_json(meta_path, meta, True, True)

    def default_notebook(self):
M
Mars Liu 已提交
460 461
        if self.enable_notebook is not None:
            return self.enable_notebook
M
Mars Liu 已提交
462 463 464 465 466 467
        if self.name in ["python", "java", "c"]:
            return True
        else:
            return False

    def check_section_keywords(self, full_path):
M
Mars Liu 已提交
468 469
        if self.ignore_keywords:
            return
M
Mars Liu 已提交
470 471 472 473
        config = self.ensure_section_config(full_path)
        if not config.get("keywords", []):
            self.logger.error(f"节点 [{full_path}] 的关键字为空,请修改配置文件写入关键字")
            sys.exit(1)