gitoria

9.3 KB

1. // lib/code.hl — BROWSING CODE (ticket gitoria#9): /code, /branch/<name>, /commit/<id> of a repo address.
2. // /code = the repo's main branch (the owner's setting, else `main`, else the first branch);
3. // /branch/<name> = that branch at its last commit; /commit/<id> = the whole project at that commit.
4. // Behind each: the folder tree, a file's lines, the branches, the latest commits. Read on the server while the page is
5. // built (browseNow, components/codebrowser.hl); "Make main" (the owner) is makeMain.
6. import { localStamp } from './util.hl'
7. import { git, branchNames, pickDefault, maxTree } from './git.hl'
8. import { safePath, enc, isHexId, tabAt, tabs, sizeText } from './git-helpers.hl'
9. import { setMainBranch, repoAt } from './repos.hl'
10. import { withRefParts } from './tickets-helpers.hl'
12. // a line of valid UTF-8, as bytes (@ stands for a backslash: a string ending in a backslash cannot be written, so it is cut from '\u005cx')
13. static utf8Line = '^(?:[@x00-@x7F]|[@xC2-@xDF][@x80-@xBF]|@xE0[@xA0-@xBF][@x80-@xBF]|[@xE1-@xEC@xEE@xEF][@x80-@xBF]{2}|@xED[@x80-@x9F][@x80-@xBF]|@xF0[@x90-@xBF][@x80-@xBF]{2}|[@xF1-@xF3][@x80-@xBF]{3}|@xF4[@x80-@x8F][@x80-@xBF]{2})*$'.replaceAll('@', '\u005cx'.slice(0, 1))
14. static maxBrowseLines = 2000
15. static maxBlobBytes = 1000000
16. static maxCommits = 20
18. // the view, SYNCHRONOUSLY (git() calls back before it returns): what the code pages' root uses
19. static browseNow = (slug, kind, rest, setting, owner) => {
20. let out = null
21. browse(slug, kind, rest, setting, owner, (result) => {
22. out = result
23. return null
24. })
25. return out
26. }
28. // the answer's fixed shape: the page reads these names, whatever the state
29. static shape = (state, message) => {
30. return { state = state isMessage = message != '' message = message isTree = false isFile = false refLabel = '' kindLabel = ''
31. sha = '' short = '' commitHref = '' subject = '' author = '' date = '' hasCrumbs = false crumbs = [] entries = [] noEntries = false lines = [] binary = false tooBig = false truncated = false fileSize = ''
32. branches = [] commits = [] hasCommits = false defaultName = '' isCommitView = false canSet = false }
33. }
35. // the answer for one view → done(result). kind: 'code' | 'branch' | 'commit'; rest = what follows in the URL;
36. // setting = the repo's saved main branch ('' = none); owner = the viewer may change it
37. static browse = (slug, kind, rest, setting, owner, done) => {
38. segs = []
39. for (x of rest.split('/')) { if (x != '') { segs.push(x) } }
40. branchNames(slug, (names) => {
41. if (names.length == 0) {
42. done(shape('empty', 'This repository has no commits yet. See the Code page to find out how to push code.'))
43. return null
44. }
45. dflt = pickDefault(names, setting)
46. let ref = null
47. let label = ''
48. let base = ''
49. let pathSegs = segs
50. let sha = ''
51. go = () => {
52. path = pathSegs.join('/')
53. let bad = false
54. for (sg of pathSegs) { if (sg == '.' || sg == '..' || !safePath(sg)) { bad = true } }
55. if (bad) {
56. done(shape('nopath', 'No such path in ' + label + '.'))
57. return null
58. }
59. here = (p) => { return p == '' ? (kind == 'code' ? '/code' : base.slice(0, base.length - 1)) : base + enc(p) }
60. branchLinks = []
61. for (n of names) { branchLinks.push({ name = n href = '/branch/' + enc(n) isDefault = n == dflt isCurrent = kind == 'branch' && n == label notCurrent = !(kind == 'branch' && n == label) canSet = owner && n != dflt }) }
62. git(slug, ['log', '-' + maxCommits, '--format=%H%x09%ct%x09%an%x09%s', ref], maxCommits, (lg) => {
63. commits = []
64. for (l of lg.lines) {
65. let f = tabs(l)
66. if (f.length >= 4) {
67. let sub = f.slice(3).join(' ')
68. commits.push({ sha = f[0] short = f[0].slice(0, 8) date = localStamp(toNumber(f[1]) * 1000) author = f[2] subject = sub href = '/commit/' + f[0] })
69. }
70. }
71. if (commits.length == 0) {
72. done(shape('empty', 'This repository has no commits yet. See the Code page to find out how to push code.'))
73. return null
74. }
75. r = shape('ok', '')
76. r.refLabel = label
77. r.kindLabel = kind == 'commit' ? 'Commit' : (kind == 'code' ? 'Main branch' : 'Branch')
78. r.isCommitView = kind == 'commit'
79. r.sha = commits[0].sha
80. r.short = commits[0].short
81. r.commitHref = '/commit/' + commits[0].sha
82. r.subject = commits[0].subject
83. r.author = commits[0].author
84. r.date = commits[0].date
85. r.branches = branchLinks
86. r.commits = commits
87. r.hasCommits = true
88. r.defaultName = dflt
89. r.canSet = owner
90. crumbs = [{ name = label href = here('') last = path == '' linked = path != '' }]
91. let acc = ''
92. let ci = 0
93. while (ci < pathSegs.length) {
94. acc = acc == '' ? pathSegs[ci] : acc + '/' + pathSegs[ci]
95. crumbs.push({ name = pathSegs[ci] href = here(acc) last = ci == pathSegs.length - 1 linked = ci != pathSegs.length - 1 })
96. ci = ci + 1
97. }
98. r.crumbs = crumbs
99. r.hasCrumbs = true
100. spec = ref + ':' + path
101. git(slug, ['cat-file', '-t', spec], 1, (ty) => {
102. t = ty.ok && ty.lines.length > 0 ? ty.lines[0] : ''
103. if (t == 'tree') {
104. git(slug, ['ls-tree', '-l', spec], maxTree, (ls) => {
105. dirs = []
106. files = []
107. for (l of ls.ok ? ls.lines : []) {
108. let tab = tabAt(l)
109. if (tab > 0) {
110. let meta = []
111. for (m of l.slice(0, tab).split(' ')) { if (m != '') { meta.push(m) } }
112. let name = l.slice(tab + 1)
113. if (meta.length >= 3 && safePath(name)) {
114. let full = path == '' ? name : path + '/' + name
115. let isDir = meta[1] == 'tree'
116. let isBlob = meta[1] == 'blob'
117. let e = { name = name isDir = isDir isFile = isBlob isOther = !isDir && !isBlob href = (isDir || isBlob) ? here(full) : '' size = (isBlob && meta.length >= 4 && meta[3] != '-') ? sizeText(toNumber(meta[3])) : '' isSub = meta[1] == 'commit' }
118. if (isDir) { dirs.push(e) } else { files.push(e) }
119. }
120. }
121. }
122. for (e of files) { dirs.push(e) }
123. r.isTree = true
124. r.entries = dirs
125. r.noEntries = dirs.length == 0
126. done(r)
127. return null
128. })
129. } else {
130. if (t == 'blob') {
131. git(slug, ['cat-file', '-s', spec], 1, (sz) => {
132. bytes = sz.ok && sz.lines.length > 0 ? toNumber(sz.lines[0]) : 0
133. r.isFile = true
134. r.fileSize = sizeText(bytes)
135. if (bytes > maxBlobBytes) {
136. r.tooBig = true
137. done(r)
138. return null
139. }
140. // only UTF-8 text is read as lines: any other bytes cannot travel to the page. git's own verdict
141. // for text (`grep -I`), then a PCRE check that every line is valid UTF-8 (`-v` finds the others).
142. git(slug, ['--literal-pathspecs', 'grep', '-I', '-l', '-e', '', ref, '--', path], 1, (tx) => {
143. if (bytes == 0) {
144. done(r)
145. return null
146. }
147. if (!tx.ok) {
148. r.binary = true
149. done(r)
150. return null
151. }
152. git(slug, ['--literal-pathspecs', 'grep', '-I', '-P', '-v', '-c', '-e', utf8Line, ref, '--', path], 1, (bad) => {
153. if (bad.ok) {
154. r.binary = true
155. done(r)
156. return null
157. }
158. git(slug, ['cat-file', 'blob', spec], maxBrowseLines + 1, (b) => {
159. lines = []
160. let n = 1
161. for (l of b.ok ? b.lines : []) {
162. if (n <= maxBrowseLines) { lines.push({ n = n text = l }) }
163. n = n + 1
164. }
165. if (n - 1 > maxBrowseLines) { r.truncated = true }
166. r.lines = lines
167. done(r)
168. return null
169. })
170. return null
171. })
172. return null
173. })
174. return null
175. })
176. } else {
177. done(shape('nopath', 'No such path in ' + label + '.'))
178. }
179. }
180. return null
181. })
182. return null
183. })
184. return null
185. }
186. if (kind == 'code') {
187. ref = dflt
188. label = dflt
189. base = '/code/'
190. go()
191. return null
192. }
193. if (kind == 'branch') {
194. let k = segs.length
195. while (k >= 1 && ref == null) {
196. let cand = segs.slice(0, k).join('/')
197. if (names.includes(cand)) {
198. ref = cand
199. label = cand
200. pathSegs = segs.slice(k)
201. }
202. k = k - 1
203. }
204. if (ref == null) {
205. done(shape('nobranch', segs.length == 0 ? 'Choose a branch.' : "This repository has no branch '" + segs.join('/') + "'."))
206. return null
207. }
208. base = '/branch/' + enc(ref) + '/'
209. go()
210. return null
211. }
212. // a commit
213. if (segs.length == 0 || !isHexId(segs[0])) {
214. done(shape('nocommit', 'No such commit.'))
215. return null
216. }
217. git(slug, ['rev-parse', '--verify', '--quiet', segs[0] + '^{commit}'], 1, (rp) => {
218. if (!rp.ok || rp.lines.length == 0 || !isHexId(rp.lines[0]) || rp.lines[0].length != 40) {
219. done(shape('nocommit', "No commit '" + segs[0] + "' in this repository."))
220. return null
221. }
222. sha = rp.lines[0]
223. ref = sha
224. label = sha.slice(0, 8)
225. base = '/commit/' + sha + '/'
226. pathSegs = segs.slice(1)
227. go()
228. return null
229. })
230. })
231. }
233. // "MAKE MAIN" (the owner, components/codebrowser.hl): the branch must exist; the setting is stored and the view is read
234. // again with it, with the ticket links of the subjects → { result } | { error }
235. static makeMain = (userId, slug, name, kind, rest) => {
236. let known = []
237. branchNames(slug, (names) => {
238. known = names
239. return null
240. })
241. if (!known.includes(name)) { return { error = 'no such branch' } }
242. r = setMainBranch(userId, slug, name)
243. if (r.error != null) { return { error = r.error } }
244. return { result = withRefParts(browseNow(slug, kind, rest, name, true), repoAt(slug).ticketsProject) }
245. }