summaryrefslogtreecommitdiff
path: root/git-gmi/git.py
blob: 9a0ab0d14e6095b801ca9c0e3defa3c22ffd62dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
from pygit2 import *
import mimetypes
from const import *


class GitGmiRepo:
    def __init__(self, name: str, path: str):
        self.name = name
        self.path = path
        try:
            self.repo = Repository(path)
        except FileNotFoundError:
            print(f"Error: repository {path} not found")

    def view_summary(self) -> str:
        tree = self.get_tree("master")
        trls = self.list_tree(tree)
        for item in trls:
            if item["type"] == "file" and item["name"].lower().split(".")[0] == (
                "readme"
            ):
                # mimetypes.guess_type() returns tuple (type, encoding)
                # only the first one of which we care about
                response = (
                    f"{STATUS_SUCCESS} {mimetypes.guess_type(item['name'])[0]}\n"
                    "=> tree/master/ tree\n"
                    "=> log/ log\n\n"
                )
                response += item["blob"].data.decode("utf-8")
                break
        return response

    def get_commit_log(self) -> list:
        # returns the commit log in a human-readable way.
        repo = self.repo
        commits = list(repo.walk(repo[repo.head.target].id, GIT_SORT_TIME))
        log = [
            {
                "id": str(cmt.id),  # hex SHA-1 hash
                "short_id": str(cmt.short_id),  # short version of the above
                "author": cmt.author.name,  # author's display name
                "time": cmt.commit_time,  # unix timestamp
                "msg": cmt.message,  # full commit message
            }
            for cmt in commits
        ]

        return log  # reverse chronical order

    def view_log(self) -> str:
        response = f"{STATUS_SUCCESS} {META_GEMINI}\n"
        log = self.get_commit_log()
        for cmt in log:
            response += f"## {cmt['short_id']} - {cmt['author']}\n{cmt['msg']}\n\n"
        return response

    @classmethod
    def parse_recursive_tree(cls, tree: Tree) -> list:
        # recursively replace all Trees with a list of Blobs inside it,
        # bundled with the Tree's name as a tuple,
        # e.g. [('src', [blob0, blob1]), otherblob].
        tree_list = list(tree)
        for idx, item in enumerate(tree_list):
            if isinstance(item, Tree):
                tree_list[idx] = (item.name, cls.parse_recursive_tree(tree_list[idx]))

        return tree_list

    def get_tree(self, commit_str: str) -> list:
        # returns a recursive list of Blob objects
        try:
            commit = self.repo.revparse_single(commit_str)
            # top level tree; may contain sub-trees
            return self.parse_recursive_tree(commit.tree)
        except ValueError:
            raise FileNotFoundError(f"Error: no such tree: {commit_str}")
            return None

    @staticmethod
    def list_tree(tree_list: list, location=[]) -> list:
        # tree_list is the output of parse_recursive_tree(<tree>);
        # location is which dir you are viewing, represented path-like
        # in a list, e.g. ['src', 'static', 'css'] => 'src/static/css',
        # which this method will cd into and display to the visitor.
        # when there is no such dir, raises FileNotFoundError.
        trls = tree_list
        for loc in location:
            found = False
            for item in trls:
                if isinstance(item, tuple) and item[0] == loc:
                    trls = item[1]
                    found = True
                    break
            if not found:
                raise FileNotFoundError(
                    f"Error: no such directory: {'/'.join(location)}"
                )

        contents = []
        for item in trls:
            if isinstance(item, tuple):
                # was originally a Tree; structure: ('dir_name', [list_of_blobs])
                contents.append(
                    {
                        "type": "dir",
                        "name": item[0],
                        "size": len(item[1]),  # number of objects in dir
                    }
                )

            elif isinstance(item, Blob):
                contents.append(
                    {
                        "type": "file",
                        "name": item.name,
                        "blob": item,
                        "size": item.size,  # size in bytes
                    }
                )

        return contents

    def view_tree(self, branch: str, location=[]) -> str:
        # actual Gemini response
        # consists of a header and a body
        response = f"{STATUS_SUCCESS} {META_GEMINI}\n"
        tree = self.get_tree(branch)
        contents = self.list_tree(tree, location)
        for item in contents:
            if item["type"] == "dir":
                response += (
                    f"=> {item['name']}/ {item['name']}/ | {item['size']} items\n"
                )
            elif item["type"] == "file":
                response += f"=> {item['name']} {item['name']} | {item['size']} bytes\n"
        return response

    def get_blob(self, commit_str: str, location=[]) -> Blob:
        # returns a specific Blob object
        # location: just like that of list_tree, but the last element
        # is the filename
        try:
            tree = self.get_tree(commit_str)
            trls = self.list_tree(tree, location[:-1])
            for item in trls:
                if item["type"] == "file" and item["name"] == location[-1]:
                    return item["blob"]
            raise FileNotFoundError(f"Error: no such file: {'/'.join(location)}")
        except FileNotFoundError:
            raise FileNotFoundError(f"Error: No such tree: {'/'.join(location[:-1])}")

    def view_blob(self, branch: str, location=[]) -> str:
        blob = self.get_blob(branch, location)
        guessed_mimetype = mimetypes.guess_type(blob.name)[0] or "text/plain"
        response = f"{STATUS_SUCCESS} {guessed_mimetype}\n"
        response += blob.data.decode("utf-8")
        return response