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
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
188
189
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
from pygit2 import *
from hurry.filesize import size, alternative
from datetime import datetime
import mimetypes
from const import *
from config import *
mimetypes.add_type("text/gemini", ".gmi")
mimetypes.add_type("text/gemini", ".gemini")
def convert_filesize(bytes: int) -> str:
# convert filesize in bytes to a human-friendly format
return size(bytes, system=alternative)
class GitGmiRepo:
def __init__(self, name: str, path: str):
self.name = name
self.path = path
try:
self.repo = Repository(path)
except GitError:
raise FileNotFoundError(f"Error: no such repo: {name}")
def generate_header(self):
# global "header" to display above all views (except raw files)
header = (
f"# {self.name}\n"
f"=> {CGI_PATH} {GIT_GMI_SITE_TITLE}\n"
f"=> {CGI_PATH}{self.name}/summary summary\n"
f"=> {CGI_PATH}{self.name}/tree/{MAIN_BRANCH}/ tree\n"
f"=> {CGI_PATH}{self.name}/log log\n"
f"=> {CGI_PATH}{self.name}/refs refs\n\n"
)
return header
def view_summary(self) -> str:
response = f"{STATUS_SUCCESS} {META_GEMINI}\n" + self.generate_header()
# show 3 recent commits
recent_commits = self.get_commit_log()[:3]
for cmt in recent_commits:
time = str(datetime.utcfromtimestamp(cmt["time"])) + " UTC"
response += (
f"### {cmt['short_id']} - {cmt['author']} - {time}\n"
f"{cmt['msg'].splitlines()[0]}\n\n"
) # TODO: link to commit view
# find and display readme(.*)
tree = self.get_tree(MAIN_BRANCH)
trls = self.list_tree(tree)
found_readme = False
for item in trls:
if (
item["type"] == "file"
and item["name"].lower().split(".")[0] == ("readme")
and not found_readme
):
found_readme = True
response += (
f"## {item['name']} | {convert_filesize(item['size'])}\n"
f"{item['blob'].data.decode('utf-8')}"
)
if not found_readme:
response += "## No readme found."
return response
def get_commit_log(self) -> list:
# returns useful info from commit log.
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" + self.generate_header()
log = self.get_commit_log()
for cmt in log:
# looks like "2020-06-06 04:51:21 UTC"
time = str(datetime.utcfromtimestamp(cmt["time"])) + " UTC"
response += (
f"## {cmt['short_id']} - {cmt['author']} - {time}\n"
f"=> tree/{cmt['short_id']}/ view tree\n"
f"{cmt['msg']}\n\n"
)
return response
def get_refs(self) -> list:
refs = self.repo.listall_reference_objects()
return [
{
"name": ref.name,
"shorthand": ref.shorthand,
"target": ref.target,
"type": ref.type,
}
for ref in refs
]
def view_refs(self) -> str:
response = f"{STATUS_SUCCESS} {META_GEMINI}\n" + self.generate_header()
refs = self.get_refs()
for ref in refs:
response += (
f"## {ref['shorthand']}\n=> tree/{ref['shorthand']}/ view tree\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, revision_str: str) -> list:
# returns a recursive list of Blob objects
try:
revision = self.repo.revparse_single(revision_str)
if isinstance(revision, Commit):
# top level tree; may contain sub-trees
return self.parse_recursive_tree(revision.tree)
elif isinstance(revision, Tag):
return self.parse_recursive_tree(revision.get_object().tree)
except ValueError:
raise FileNotFoundError(f"Error: no such tree: {revision_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],
"items": 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
tree = self.get_tree(branch)
contents = self.list_tree(tree, location)
items = len(contents)
response = (
f"{STATUS_SUCCESS} {META_GEMINI}\n"
+ self.generate_header()
+ f"## {self.name}{'/' if location else ''}{'/'.join(location)}/"
f" | {items} {'items' if items > 1 else 'item'}\n\n"
)
for item in contents:
if item["type"] == "dir":
response += (
f"=> {item['name']}/ {item['name']}/ | {item['items']} items\n"
)
elif item["type"] == "file":
response += f"=> {item['name']} {item['name']} | {convert_filesize(item['size'])}\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)
response = (
f"{STATUS_SUCCESS} {META_GEMINI}\n"
+ self.generate_header()
+ f"## {self.name}/{'/'.join(location)} | {convert_filesize(blob.size)}\n\n"
f"=> {blob.name}?raw view raw\n\n"
f"```\n"
)
response += blob.data.decode("utf-8") + "\n```"
return response
def view_raw_blob(self, branch: str, location=[]) -> str:
blob = self.get_blob(branch, location)
# if mimetypes can't make out the type, set it to plaintext
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
|
