tracker

18.6 KB

1. // project.hl — tracker.worldapi.org: THE MAP (mission 028, docs: README "Files"). Config, the routes and how the parts are wired;
2. // what each feature does is in the file named here, not in this one.
3. //
4. // login (ident only, the header's selector + button) lib/users.hl, components/main.hl, login.js, /login/* below
5. // the shell: header, main menu, user menu, sidebar components/main.hl (theme/shell/*, vendored from layouts.worldapi.org)
6. // /genres · /people (the main menu) · /settings lib/catalog.hl genreList · lib/people.hl peopleOf* · components/settings.hl
7. // titles: records, slugs, kinds, list caches lib/shows.hl a title's page: components/show.hl
8. // public lists /movies /series /shows /genres, home lib/catalog.hl
9. // components/{movies,allseries,allshows,genre,home,tilelist}.hl
10. // follows · watches · /my/* lib/follows.hl · lib/watches.hl
11. // components/{myshows,mymovies,unwatched,schedule}.hl
12. // search, web search, import lib/search.hl (+ search-helpers.hl) components/search.hl
13. // people, a person's page and filmography fill lib/people.hl components/person.hl
14. // cast + crew, the credits job lib/credits.hl (+ credits-helpers.hl)
15. // a title completed from TMDB (details repair) lib/details.hl
16. // TMDB / TVmaze requests, posters lib/tmdb.hl
17. // the sync of one title · which titles a day lib/sync.hl (+ sync-helpers.hl) · lib/dailysync.hl
18. // adult flag + kind backfills lib/backfill.hl
19. // short ids (/<shortId>) lib/shortids.hl
20. // franchises + timelines · TMDB collection seed lib/franchises.hl · lib/collections.hl
21. // components/franchise*.hl, timelineedit.hl
22. // duplicate titles merged lib/merge.hl
23. // the background jobs and their clocks lib/jobs.hl (one instance, made below after the server)
24. // poster + photo files lib/images.hl
25. // shared helpers (env, paths, dates, ids, lists) lib/util.hl
26. // styles · design tokens · the WorldAPI theme components/styles.hl · shared/tokens.hl · theme/ (never edited here)
27. //
28. // Config (env; no committed secret — the first deploy registers this app in ident and sets these, done by the architect, as
29. // with ident's own .env for SMTP): TRACKER_PORT (45008), TRACKER_URL (this app's own public address, for the return URL),
30. // IDENT_URL (https://ident.worldapi.org), TRACKER_KEY (pk_…), TRACKER_SECRET (sk_…), TRACKER_STORAGE, TRACKER_SESSIONS,
31. // TRACKER_WATCH, TMDB_READ_TOKEN; the jobs' switches and limits: lib/jobs.hl (README "Config").
32. import WebFramework from 'hl:web'
33. import { Response } from 'hl:http1'
34. import { env } from 'hl:proc'
35. import { now } from 'hl:time'
37. import Styles from './components/styles.hl'
38. import Home from './components/home.hl'
39. import LoginFailed from './components/loginfailed.hl'
40. import Show from './components/show.hl'
41. import Unwatched from './components/unwatched.hl'
42. import Schedule from './components/schedule.hl'
43. import MyShows from './components/myshows.hl'
44. import MyMovies from './components/mymovies.hl'
45. import Movies from './components/movies.hl'
46. import AllShows from './components/allshows.hl'
47. import AllSeries from './components/allseries.hl'
48. import Search from './components/search.hl'
49. import Person from './components/person.hl'
50. import Genre from './components/genre.hl'
51. import Genres from './components/genres.hl'
52. import People from './components/people.hl'
53. import Settings from './components/settings.hl'
54. import Franchises from './components/franchises.hl'
55. import Franchise from './components/franchise.hl'
56. import FranchiseEdit from './components/franchiseedit.hl'
57. import TimelineEdit from './components/timelineedit.hl'
58. import { dark, darker } from './shared/tokens.hl'
59. import { postersDir, profilesDir } from './lib/util.hl'
60. import { loginCallbackOf } from './lib/users.hl'
61. import { imageResponse, isSafePosterName } from './lib/images.hl'
62. import { ensureIndex } from './lib/search.hl'
63. import { showsMovedPath, warmTitleCaches, warmEpisodeKeys, movedSlugs, movedPathOf, personById } from './lib/shows.hl'
64. import { allWatchedEpisodeIds } from './lib/watches.hl'
65. import { allFollowedShowIds } from './lib/follows.hl'
66. import { ensureShortIds, shortIdPath } from './lib/shortids.hl'
67. import { guestPersonId } from './lib/people.hl'
68. import { moveCopiedSummaries } from './lib/dailysync.hl'
69. import { ensureFranchises } from './lib/franchises.hl'
70. import Jobs from './lib/jobs.hl'
72. static appTitle = "tracker"
74. // ---- THE INSTALLABLE APP (tracker.worldapi.org#10), the same way calendar.worldapi.org does it: hl:web's own web app
75. // manifest (/__hl/manifest.webmanifest, linked from every head with the apple-touch-icon and theme-color) and service
76. // worker (/__hl/sw.js) from these settings — no JavaScript of ours. Icons in icons/ (icon.svg is the source, the PNGs
77. // are rendered from it with rsvg-convert, README "Icons"). The theme colour is the header's background (darker), the
78. // splash background the page's (dark) — both off the tokens, not written out again.
79. appThemeColor = darker.value
80. appBackgroundColor = dark.value
81. appIcons = [
82. { src = '/icons/icon-192.png' sizes = '192x192' purpose = 'any' }
83. { src = '/icons/icon-512.png' sizes = '512x512' purpose = 'any' }
84. { src = '/icons/icon-192.png' sizes = '192x192' purpose = 'maskable' }
85. { src = '/icons/icon-512.png' sizes = '512x512' purpose = 'maskable' }
86. ]
87. appTouchIcon = '/icons/apple-touch-icon.png'
88. appFavicon = '/icons/favicon.svg'
89. // OFFLINE: only the shell — the header and `/` (components/main.hl says "You are offline" while the browser has no
90. // network). The data pages are not kept: without a network they get hl:web's "Unavailable offline" page.
91. offline = [ Home ]
93. styles = Styles
95. port = env('TRACKER_PORT') != null ? toNumber(env('TRACKER_PORT')) : 45008
96. watching = env('TRACKER_WATCH') != '0'
97. // read by hl:web's own manifest config (WebFramework.hl `cfg.sessionDir`), not the constructor call below
98. sessionDir = env('TRACKER_SESSIONS') != null ? env('TRACKER_SESSIONS') : null
100. // ---- the function routes: each checks its input, asks the topic, answers ---------------------------------------------------
101. // /login/callback?ident_code=… (lib/users.hl): the code exchanged, this app's session signed in, back to the page (`?next=`)
102. loginCallback = (&route, &req) => { return loginCallbackOf(server.sessions, req) }
103. // /posters/<name>, /profiles/<name> (lib/images.hl): the file, else the placeholder
104. posterRoute = (&route, &req) => { return imageResponse(postersDir, route.params != null ? route.params.name : null, 'poster') }
105. profileRoute = (&route, &req) => { return imageResponse(profilesDir, route.params != null ? route.params.name : null, 'photo') }
107. // the old addresses of the personal lists (tracker.worldapi.org#8): they all live under /my/ now — a permanent redirect so old
108. // links keep working (architect's decision)
109. movedTo = (&path) => { return new Response('moved to ' + path, { status = 301 headers = { 'Location' = path 'Content-Type' = 'text/plain; charset=utf-8' } }) }
110. notFoundText = (&text) => { return new Response(text, { status = 404 headers = { 'Content-Type' = 'text/plain; charset=utf-8' } }) }
111. unwatchedMoved = (&route, &req) => { return movedTo('/my/unwatched') }
112. scheduleMoved = (&route, &req) => { return movedTo('/my/schedule') }
113. // mission 058: the show page's genre pills linked `/genre/<x>` (no page there) — the genre pages are `/genres/<x>`
114. genreMoved = (&route, &req) => {
115. g = route.params != null ? route.params.genre : null
116. return movedTo(isSafePosterName(g) ? '/genres/' + g : '/')
117. }
118. // mission 060 (tracker.worldapi.org#27): `/<shortId>` → 301 to the title's or person's page (lib/shortids.hl); upper case is
119. // read as lower case; anything else is a 404
120. shortIdRoute = (&route, &req) => {
121. sid = route.params != null ? route.params.sid : null
122. path = sid != null && hlTypeName(sid) == 'String' ? shortIdPath(sid.toLowerCase()) : null
123. if (path == null) { return notFoundText('not found') }
124. return movedTo(path)
125. }
126. // mission 062: a GUEST STAR's link (components/show.hl castRowsOf) — `/person/tmdb/<tmdbId>?show=<show id>` creates the person
127. // (lib/people.hl guestPersonId) or finds the one we have, then 302 → `/person/<slug>`. A function route: the browser loads it
128. // itself (hl:web's client router hands every non-component link to the browser)
129. guestRoute = (&route, &req) => {
130. t = route.params != null ? route.params.tmdb : null
131. tmdbId = t != null && hlTypeName(t) == 'String' && t.length <= 10 ? toNumber(t) : null
132. if (tmdbId == null || tmdbId < 1) { return notFoundText('not found') }
133. q = req.query != null ? req.query : {}
134. r = guestPersonId(tmdbId, q.show)
135. p = r.id != null ? personById(r.id) : null
136. if (p == null || p.urlSegment == null) { return notFoundText('not found: ' + (r.error != null ? r.error : 'no such person')) }
137. return new Response('see /person/' + p.urlSegment, { status = 302 headers = { 'Location' = '/person/' + p.urlSegment 'Cache-Control' = 'no-store' 'Content-Type' = 'text/plain; charset=utf-8' } })
138. }
139. // tracker#32 (mission 031): the header's search field sends GET /find?q=<text> (the theme's AppHeader form); a page cannot read a
140. // query string, so this answers 302 → /search/<text> ('/', '?', '#' as spaces, like components/search.hl), no text → /search
141. findRoute = (&route, &req) => {
142. q = req.query != null && req.query.q != null && hlTypeName(req.query.q) == 'String' ? req.query.q.replaceAll('/', ' ').replaceAll('?', ' ').replaceAll('#', ' ').trim() : ''
143. to = q != '' ? '/search/' + encodeURIComponent(q) : '/search'
144. return new Response('see ' + to, { status = 302 headers = { 'Location' = to 'Cache-Control' = 'no-store' 'Content-Type' = 'text/plain; charset=utf-8' } })
145. }
146. // /shows/<slug> (tracker.worldapi.org#21, mission 068): a series or movie (or a merged duplicate's slug) answers 301 to its page
147. // (lib/shows.hl showsMovedPath). hl:web has no way for a component route to answer a redirect, so this is a FUNCTION route, and
148. // for a show (or an unknown slug: the page's own "Not found") it renders the title page the way hl:web renders a component
149. // route (WebFramework.hl `on http.request`, the `component` branch): the Show component matched at /series/<slug> — same
150. // component, same params — with the cookie's session, a new one (and its cookie) when the browser brought none. In the browser
151. // a link to /shows/<slug> is then a full page load; every other title page stays a client-side navigation.
152. showsRoute = (&route, &req) => {
153. slug = route.params != null ? route.params.slug : null
154. to = showsMovedPath(slug)
155. if (to != null) { return movedTo(to) }
156. m = server.router.match('/series/' + slug)
157. let s = req.session
158. fresh = s == null
159. if (fresh) { s = server.sessions.mint() }
160. let res = server.page(m, s, server.hostOf(req.headers['host']), server.requestHeaders(req.headers))
161. if (fresh) { res.headers['Set-Cookie'] = server.sessions.cookieHeader(s.id) }
162. return res
163. }
164. // tracker#31 (mission 026): the slug of a merged duplicate, or a keeper's former slug → 301 to the keeper's page (lib/shows.hl
165. // movedSlugs, read at boot). A component route cannot redirect, so each such slug gets its own function route under /movies/ and
166. // /series/ (/shows/ is showsRoute). A title merged while this process runs answers the keeper's page under its old slug (shows.hl
167. // showBySlug) until the next start.
168. slugMoved = (&route, &req) => {
169. to = movedPathOf(req.path)
170. if (to == null) { return notFoundText('not found') }
171. return movedTo(to)
172. }
174. routes = [
175. { pattern = "/favicon.ico" file = "./icons/favicon.ico" headers = { 'Cache-Control' = 'no-cache' } }
176. // the installable app (tracker.worldapi.org#10): the icons (manifest and service worker are hl:web's own, from appIcons / offline)
177. { pattern = "/icons/icon-192.png" file = "./icons/icon-192.png" headers = { 'Cache-Control' = 'no-cache' } }
178. { pattern = "/icons/icon-512.png" file = "./icons/icon-512.png" headers = { 'Cache-Control' = 'no-cache' } }
179. { pattern = "/icons/apple-touch-icon.png" file = "./icons/apple-touch-icon.png" headers = { 'Cache-Control' = 'no-cache' } }
180. { pattern = "/icons/favicon.svg" file = "./icons/favicon.svg" headers = { 'Cache-Control' = 'no-cache' } }
181. { pattern = "/login/callback" function = loginCallback }
182. { pattern = "/login/failed" component = LoginFailed }
183. { pattern = "/login.js" file = "./login.js" headers = { 'Cache-Control' = 'no-cache' } }
184. { pattern = "/posters/:name" function = posterRoute }
185. // tracker.worldapi.org#13: every movie / every series, 24 per page — the page is a PATH segment (`/movies/page/2`), a
186. // page component cannot read `?page=` (hybriel#11) — and the movies the user follows
187. { pattern = "/movies" component = Movies }
188. { pattern = "/movies/page/:page" component = Movies }
189. // tracker.worldapi.org#21 (mission 068): series and shows split — /series lists the series, /shows the shows; a title's page
190. // is /movies/<slug>, /series/<slug> or /shows/<slug> (one component; /shows/<slug> is showsRoute above)
191. { pattern = "/movies/:slug" component = Show }
192. { pattern = "/series" component = AllSeries }
193. { pattern = "/series/page/:page" component = AllSeries }
194. { pattern = "/series/:slug" component = Show }
195. { pattern = "/shows" component = AllShows }
196. { pattern = "/shows/page/:page" component = AllShows }
197. { pattern = "/shows/:slug" function = showsRoute }
198. { pattern = "/my/movies" component = MyMovies }
199. { pattern = "/my/unwatched" component = Unwatched }
200. { pattern = "/my/schedule" component = Schedule }
201. // #21: /my/series and /my/shows (one component, components/myshows.hl; any other word there is its "Not found")
202. { pattern = "/my/:tv" component = MyShows }
203. { pattern = "/unwatched" function = unwatchedMoved }
204. { pattern = "/schedule" function = scheduleMoved }
205. // tracker.worldapi.org#14: the search — `/search/<text>` (hl:web gives a page no query string, so not `?q=`)
206. { pattern = "/search/:q?" component = Search }
207. { pattern = "/find" function = findRoute }
208. // tracker.worldapi.org#16: a person's page (the show page's cast and the search link here) and their photo
209. { pattern = "/person/tmdb/:tmdb" function = guestRoute }
210. { pattern = "/person/:slug" component = Person }
211. { pattern = "/profiles/:name" function = profileRoute }
212. // mission 058 (tracker.worldapi.org#25): a genre's movies and series, like /movies (the page in the path)
213. { pattern = "/genres/:genre" component = Genre }
214. { pattern = "/genres/:genre/page/:page" component = Genre }
215. { pattern = "/genre/:genre" function = genreMoved }
216. // tracker#32 (mission 031): the main menu's Genres and People, the user menu's Settings
217. { pattern = "/genres" component = Genres }
218. { pattern = "/people" component = People }
219. { pattern = "/people/:letter" component = People }
220. { pattern = "/people/:letter/page/:page" component = People }
221. { pattern = "/settings" component = Settings }
222. // tracker.worldapi.org#19 (mission 066): franchises and timelines, the creator's editor (`/franchises/edit` before the slug)
223. { pattern = "/franchises" component = Franchises }
224. { pattern = "/franchises/edit" component = FranchiseEdit }
225. { pattern = "/franchises/:slug" component = Franchise }
226. { pattern = "/timelines/:tslug" component = Franchise }
227. { pattern = "/timelines/:slug/edit" component = TimelineEdit }
228. { pattern = "/" component = Home }
229. // mission 060 (tracker.worldapi.org#27): a short id → its page (LAST: every named one-segment route above wins)
230. { pattern = "/:sid" function = shortIdRoute }
231. ]
233. // WHO GETS THE PUSH: the login state reaches the tabs of one session (components/main.hl trackerSignedIn/Out).
234. tagOf = (&session) => { return session != null && session.data != null ? session.data.tag : null }
235. audience = {
236. trackerSignedIn = (tag, &session) => { return tag != null && tagOf(session) == tag }
237. trackerSignedOut = (tag, &session) => { return tag != null && tagOf(session) == tag }
238. }
240. // cookies are per host, not per port: an own name keeps this app's session apart from
241. // ident's own (and from any other worldapi app sharing a dev host), see ident README "Design
242. // tokens" / hybriel#10 hybriel#17.
243. sessionCookie = 'trackersid'
244. // tracker.worldapi.org#14: the search index (lib/search.hl) is built once here at boot (~0.6 s on the real data), not by the
245. // first search
246. searchIndexReady = ensureIndex()
247. // mission 060: every short id in use (one map over shows AND persons) and the records still without one, before the first request
248. shortIdsReady = ensureShortIds()
249. // tracker#30 (mission 025): the slim list caches (lib/shows.hl cardOf / episodeRowsOf) of every followed title, before the first
250. // /my/ load — not filled by that load
251. titleCachesStart = now()
252. titleCachesWarm = warmTitleCaches(allFollowedShowIds())
253. episodeKeysWarm = warmEpisodeKeys(allWatchedEpisodeIds())
254. console.log('list caches: ' + titleCachesWarm + ' followed titles, ' + episodeKeysWarm + ' watched episodes in ' + (now() - titleCachesStart) + ' ms')
255. // tracker#18, ONCE (lib/dailysync.hl moveCopiedSummaries): a `summary` that is only the migrated copy of tmdbSummary is MOVED to
256. // `migratedSummary` (mission 070: kept, not shown) — the current TMDB text shows; the creator's own texts stay
257. summariesMoved = moveCopiedSummaries()
258. if (summariesMoved.ran) { console.log('summaries: moved ' + summariesMoved.moved + ' copies of tmdbSummary to migratedSummary, kept ' + summariesMoved.kept + ' own texts, errors ' + summariesMoved.errors + ', ' + summariesMoved.ms + ' ms') }
259. // mission 066: which timelines every title is in (one scan of the timelines), before the first show page
260. franchisesReady = ensureFranchises()
261. // tracker#31: the moved slugs' routes first, then `routes` as written (hl:web reads the written list for the pages it serves)
262. movedSlugList = movedSlugs()
263. withMovedSlugs = () => {
264. out = []
265. for (m of movedSlugList) {
266. out.push({ pattern = '/movies/' + m.slug function = slugMoved })
267. out.push({ pattern = '/series/' + m.slug function = slugMoved })
268. }
269. for (r of routes) { out.push(r) }
270. return out
271. }
272. allRoutes = withMovedSlugs()
273. console.log('moved slugs: ' + movedSlugList.length + ' (301 to the keeper)')
274. server = new WebFramework(routes = allRoutes, styles = styles, port = port, sessionCookie = sessionCookie, watchMode = watching)
276. // ---- THE BACKGROUND JOBS (lib/jobs.hl): the daily TMDB sync, the backfills, the details repair, the credits job, the duplicate
277. // merge, the short-id backfill, the collection seed — constructing it starts their clocks and logs which ones are off
278. jobs = new Jobs()
280. on Error(e) { console.log('error absorbed: ' + e.message) }