gitoria

8.4 KB

1. // project.hl — gitoria.worldapi.org: THE MAP. Config, routes and WHO HEARS WHAT; the logic lives in lib/. Hybriel on hl:web.
2. //
3. // WHERE THINGS ARE (one line per feature; README.md "Files" has the full list):
4. // repos: create, list, owner, main-branch setting, push rule lib/repos.hl (slug rules, rows, Markdown view: lib/repos-helpers.hl)
5. // users, login through ident, display names lib/users.hl
6. // git on the server (calls, branches, init, temp folder) lib/git.hl (paths, ids, |||PR / |||RL markers: lib/git-helpers.hl)
7. // the repo homepage (README.md / $docs) lib/homepage.hl (Markdown → blocks: lib/markdown.hl)
8. // browsing code (/code, /branch, /commit), "Make main" lib/code.hl
9. // pull requests, the Merge button lib/pulls.hl
10. // releases lib/releases.hl
11. // a repo's tickets, connecting tickets, `#12` links both ways lib/tickets.hl (lib/tickets-helpers.hl)
12. // push and pull over HTTPS (the git protocol's routes) lib/transport.hl (lib/transport-helpers.hl)
13. // access tokens / ssh keys lib/tokens.hl / lib/sshkeys.hl
14. // function routes: API, /login/callback, /settings/connect…, /__git/… lib/api.hl (plumbing: lib/api-helpers.hl)
15. // shared helpers (env, storage dir, addresses, lists, Vienna time) lib/util.hl
16. // pages: shell, repo list, readme, code, pulls, releases, tickets, settings, tokens, keys components/*.hl; CSS components/styles.hl
17. //
18. // HOW A REPO GETS ITS ADDRESS (ticket #6, gitoria#16): nginx sends `gitoria.worldapi.org` AND every
19. // `<slug>.gitoria.worldapi.org` to this one app. Every page component that declares `host = null` gets the
20. // request's host (without port, hybriel#74) on the SERVER, on the first load and on every hl:web navigation:
21. // the main address shows the repo list + "create" (components/index.hl → list.hl), `<slug>.` shows that repo —
22. // each repo view is its own page component on its own route (readme, code, branch, commit, pulls, releases,
23. // tickets), rendered on the server WITH its content: git is read with hl:proc run(), which waits (hybriel#80).
24. // The session cookie carries `Domain=.<host>` (hl:web `sessionDomain`, hybriel#44) so one
25. // login holds on every address; the login button always returns through the main address
26. // (the only origin registered in ident) and then on to the repo the login started from.
27. import WebFramework from 'hl:web'
28. import { env } from 'hl:proc'
30. import Styles from './components/styles.hl'
31. import { dark, darker } from './shared/tokens.hl'
32. import { hostOnly, domainFor } from './lib/util.hl'
33. import { tagOf } from './lib/users.hl'
34. import { apiRepos, apiRepo, loginCallback, connectStart, connectBack, gitKeys, gitAccess } from './lib/api.hl'
35. import { gitTransport } from './lib/transport.hl'
37. import Index from './components/index.hl'
38. import Code from './components/code.hl'
39. import Branch from './components/branch.hl'
40. import Commit from './components/commit.hl'
41. import Pulls from './components/pulls.hl'
42. import Releases from './components/releases.hl'
43. import Tickets from './components/tickets.hl'
44. import Settings from './components/settings.hl'
45. import LoginFailed from './components/loginfailed.hl'
47. static siteName = "gitoria"
49. appTitle = siteName
50. styles = Styles
52. // ---- THE INSTALLABLE APP (mission 046), the same way calendar.worldapi.org and tracker do it: hl:web's own web app
53. // manifest (/__hl/manifest.webmanifest, linked from every head with the apple-touch-icon and theme-color) and service
54. // worker (/__hl/sw.js) from these settings — no JavaScript of ours. Icons in icons/ (icon.svg is the source, the PNGs
55. // are rendered from it with rsvg-convert, README "PWA"). The theme colour is the header's background (darker), the
56. // splash background the page's (dark) — both off the tokens. Every repo address is its own origin, so each one gets
57. // its own manifest and worker (start_url / = that repo's Readme).
58. appThemeColor = darker.value
59. appBackgroundColor = dark.value
60. appIcons = [
61. { src = '/icons/icon-192.png' sizes = '192x192' purpose = 'any' }
62. { src = '/icons/icon-512.png' sizes = '512x512' purpose = 'any' }
63. { src = '/icons/icon-192.png' sizes = '192x192' purpose = 'maskable' }
64. { src = '/icons/icon-512.png' sizes = '512x512' purpose = 'maskable' }
65. ]
66. appTouchIcon = '/icons/apple-touch-icon.png'
67. appFavicon = '/icons/favicon.svg'
68. // OFFLINE: only the shell and `/` (components/main.hl says "You are offline" while the browser has no network). `/`
69. // is kept as last seen (the worker is network-first and refreshes its copy on every online visit): the repo list on
70. // the main address, the Readme on a repo address. Every other page (code, commits, pulls, …) needs the network and
71. // gets hl:web's "Unavailable offline" page.
72. offline = [ Index ]
74. // EVERY REPO VIEW IS ITS OWN PAGE (gitoria#16); `/` is the list on the main address, the Readme on a repo address.
75. routes = [
76. { pattern = "/favicon.ico" file = "./icons/favicon.ico" headers = { 'Cache-Control' = 'no-cache' } }
77. // the installable app (mission 046): the icons (manifest and service worker are hl:web's own, from appIcons / offline)
78. { pattern = "/icons/icon-192.png" file = "./icons/icon-192.png" headers = { 'Cache-Control' = 'no-cache' } }
79. { pattern = "/icons/icon-512.png" file = "./icons/icon-512.png" headers = { 'Cache-Control' = 'no-cache' } }
80. { pattern = "/icons/apple-touch-icon.png" file = "./icons/apple-touch-icon.png" headers = { 'Cache-Control' = 'no-cache' } }
81. { pattern = "/icons/favicon.svg" file = "./icons/favicon.svg" headers = { 'Cache-Control' = 'no-cache' } }
82. // the login button's return and the tickets connection write the session: the request and the store go BY REFERENCE (lib/api.hl)
83. { pattern = "/login/callback" function = (route, req) => { return loginCallback(route, &req, &server.sessions) } }
84. { pattern = "/login/failed" component = LoginFailed }
85. { pattern = "/login.js" file = "./login.js" headers = { 'Cache-Control' = 'no-cache' } }
86. { pattern = "/api/repos" function = apiRepos }
87. { pattern = "/api/repos/:slug" function = apiRepo }
88. { pattern = "/" component = Index }
89. { pattern = "/code" component = Code }
90. { pattern = "/code/*path" component = Code }
91. { pattern = "/branch/*path" component = Branch }
92. { pattern = "/commit/*path" component = Commit }
93. { pattern = "/pulls" component = Pulls }
94. { pattern = "/releases" component = Releases }
95. { pattern = "/tickets" component = Tickets }
96. { pattern = "/settings" component = Settings }
97. { pattern = "/settings/connect" function = (route, req) => { return connectStart(route, &req, &server.sessions) } }
98. { pattern = "/settings/connected" function = (route, req) => { return connectBack(route, &req, &server.sessions) } }
99. { pattern = "/__git/keys" function = gitKeys }
100. { pattern = "/__git/access" function = gitAccess }
101. { pattern = "/:repo/info/refs" function = gitTransport }
102. { pattern = "/:repo/git-upload-pack" function = gitTransport }
103. { pattern = "/:repo/git-receive-pack" function = gitTransport }
104. ]
106. // WHO GETS THE PUSH: a new repo reaches every open page (the list follows live)
107. // `gitoriaSignedIn` / `gitoriaSignedOut` go to the tabs of ONE session: the one whose login carries
108. // that random tag (session.data.tag, set at login, users.hl tagOf) — every open page of it switches without a reload.
109. audience = {
110. repoCreated = (row, session) => { return true }
111. ticketOpened = (slug, row, session) => { return true }
112. gitoriaSignedIn = (tag, info, session) => { return tag != null && tagOf(session) == tag }
113. gitoriaSignedOut = (tag, session) => { return tag != null && tagOf(session) == tag }
114. }
116. sessionDir = env('GITORIA_SESSIONS') != null ? env('GITORIA_SESSIONS') : null
117. port = env('GITORIA_PORT') != null ? toNumber(env('GITORIA_PORT')) : 8360
118. // HL_HOST = the interface hl:web binds (hybriel #24, fixed upstream): 127.0.0.1 on Byrodin behind nginx;
119. // unset = 0.0.0.0 (dev on Loreana). GITORIA_WATCH=0 = no dev watcher. The session cookie is `gitoriasid` (hybriel #10).
120. watching = env('GITORIA_WATCH') != '0'
121. sessionCookie = 'gitoriasid'
122. // the cookie's Domain (hybriel#44): every <slug>.<host> shares the login (util.hl domainFor; '' = host-only → null)
123. sessionDomain = domainFor(hostOnly) != '' ? domainFor(hostOnly) : null
124. server = new WebFramework(routes = routes, styles = styles, minify = true, port = port, watchMode = watching, sessionCookie = sessionCookie, sessionDomain = sessionDomain)
126. on Error(e) { console.log('error absorbed: ' + e.message) }