tracker

19.5 KB

1. // search.hl — THE SEARCH (tracker.worldapi.org#14): our own database first, then "Fetch from web" (TMDB) for titles
2. // we don't have yet, and the import of the one picked. Used by components/search.hl (`/search/<text>`).
3. //
4. // dbSearch(text) our shows, movies and people — from an IN-MEMORY INDEX built once at boot (no table scan per
5. // keystroke): every title/name split into words; each word's first 2 and first 3 characters are
6. // a bucket key → the entries holding such a word. A query looks at ONE bucket (its longest word's
7. // first 3 characters, or 2 for a 2-letter word) and keeps the entries where EVERY query word is
8. // the start of one of the entry's words. A title's year is one of its words ("doctor who 2005").
9. // webSearch(text) GET <TMDB_BASE_URL>/search/multi?query=… (one request; TV + movies only, people dropped) —
10. // the titles we already have (same TMDB id and kind) are left out
11. // importTitle(kind, id) a new show record from GET /tv/<id>?append_to_response=external_ids,aggregate_credits (a movie:
12. // /movie/<id>?…,credits), then tmdbsync.hl `syncShowWith` fills it from that same answer exactly like
13. // the daily sync does (seasons, episodes, poster, external ids); added to the index. The answer goes
14. // back as `details`: the caller (components/search.hl) stores its cast + crew (details.hl applyCredits,
15. // tracker#28 — details.hl imports this file, so it cannot be called from here)
16. //
17. // ADULT TITLES (mission 054): our database lists only titles with `adult == false` (shows.hl isPublicTitle; unknown is
18. // hidden) — `titleOk` holds that per show id, set by indexShow and by `searchTitleChanged` (the adult backfill and the daily
19. // sync call it per title). The web list asks TMDB with include_adult=false AND keeps only results with `adult` false.
20. //
21. // ONE PROCESS PER STORAGE (hybriel#21): the index lives in the app's process and is kept up to date by importTitle; the
22. // daily sync never changes a title. New rows get self-assigned 16-hex ids (hybriel#113), like tmdbsync.hl.
23. import { now } from 'hl:time'
24. import { randomBytes } from 'hl:crypto'
25. import { showsTable, personsTable, genresTable, isPublicTitle } from './shows.hl'
26. import { tmdbGet, tmdbImageBase, syncShowWith, persistSync, textOr, adultOf } from './tmdbsync.hl'
27. import { refreshCatalogShow } from './catalog.hl'
29. // ---- text → words ---------------------------------------------------------------------------------
30. // lower case, apostrophes dropped ("Grey's" → "greys"), every other punctuation mark a word break, the common Latin
31. // accents folded ("Amélie" → "amelie") — the same for the titles and the query
32. static apostrophes = ["'", '’', '`', '´']
33. static breaks = ['.', ',', ':', ';', '!', '?', '(', ')', '[', ']', '{', '}', '"', '“', '”', '„', '-', '–', '—', '/', '&', '+', '*', '#', '_', '|', '…', '·', '@', '=', '~', '<', '>']
34. static folds = [['á', 'a'], ['à', 'a'], ['â', 'a'], ['ä', 'a'], ['ã', 'a'], ['å', 'a'], ['æ', 'ae'], ['ç', 'c'], ['é', 'e'], ['è', 'e'], ['ê', 'e'], ['ë', 'e'],
35. ['í', 'i'], ['ì', 'i'], ['î', 'i'], ['ï', 'i'], ['ñ', 'n'], ['ó', 'o'], ['ò', 'o'], ['ô', 'o'], ['ö', 'o'], ['õ', 'o'], ['ø', 'o'], ['œ', 'oe'],
36. ['ú', 'u'], ['ù', 'u'], ['û', 'u'], ['ü', 'u'], ['ý', 'y'], ['ÿ', 'y'], ['ß', 'ss'], ['š', 's'], ['ž', 'z'], ['č', 'c'], ['ł', 'l']]
38. static normalize = (s) => {
39. if (s == null) { return '' }
40. let t = ('' + s).toLowerCase()
41. for (p of apostrophes) { if (t.includes(p)) { t = t.replaceAll(p, '') } }
42. for (p of breaks) { if (t.includes(p)) { t = t.replaceAll(p, ' ') } }
43. for (f of folds) { if (t.includes(f[0])) { t = t.replaceAll(f[0], f[1]) } }
44. return t
45. }
46. static wordsOf = (s) => {
47. let out = []
48. for (w of normalize(s).split(' ')) { if (w != '') { out.push(w) } }
49. return out
50. }
52. // ---- the index --------------------------------------------------------------------------------------
53. // entries[i] = { kind ('title' | 'person'), id, words, text (the words joined by one space, without the year) }
54. static entries = []
55. static buckets = {}
56. // what we have, by TMDB id: 'series:<id>' / 'movie:<id>' → our show id (the web list leaves these out)
57. static haveTmdb = {}
58. // tracker#18 (the daily sync's TVmaze change list, deltasync.hl): TVmaze id → our show id (kept by indexShow and
59. // searchTitleChanged — the sync fills TVmaze ids)
60. static haveTvmz = {}
61. // every show slug in use (an imported title gets a free one)
62. static slugTaken = {}
63. // show id → true when the title may be listed (not adult, mission 054)
64. static titleOk = {}
65. // tracker#18 (a title renamed by the daily sync): show id → its entry's index; an entry replaced by a newer one is `stale`
66. // (skipped by dbSearch — the buckets only ever grow)
67. static titleEntry = {}
68. static staleEntry = {}
69. static indexStats = { built = false titles = 0 people = 0 keys = 0 ms = 0 }
71. static bucketKeys = (words) => {
72. let seen = {}
73. let out = []
74. for (w of words) {
75. let n = 2
76. while (n <= 3) {
77. if (w.length >= n) {
78. let k = w.slice(0, n)
79. if (seen[k] != true) { seen[k] = true out.push(k) }
80. }
81. n = n + 1
82. }
83. }
84. return out
85. }
87. // `tie` orders equally good matches: lower first (a title: series before movies, then the newer one)
88. static addEntry = (kind, id, name, extra, tie) => {
89. let words = wordsOf(name)
90. if (words.length == 0) { return false }
91. let i = entries.length
92. let all = []
93. for (w of words) { all.push(w) }
94. if (extra != null && extra != '') { all.push(extra) }
95. entries.push({ kind = kind id = id words = all text = words.join(' ') tie = tie })
96. if (kind == 'title') { titleEntry[id] = i }
97. for (k of bucketKeys(all)) {
98. if (buckets[k] == null) { buckets[k] = [i] indexStats.keys = indexStats.keys + 1 } else { buckets[k].push(i) }
99. }
100. return true
101. }
103. static tmdbKeyOf = (type, tmdbId) => { return (type == 'movie' ? 'movie:' : 'series:') + tmdbId }
105. static yearWordOf = (show) => {
106. if (show.year != null) { return '' + show.year }
107. if (show.release != null && hlTypeName(show.release) == 'String' && show.release.length >= 4) { return show.release.slice(0, 4) }
108. return ''
109. }
111. static indexShow = (s) => {
112. if (s.urlSegment != null) { slugTaken[s.urlSegment] = true }
113. if (s.tmdbId != null) { haveTmdb[tmdbKeyOf(s.type, s.tmdbId)] = s.id }
114. if (s.tvmzId != null) { haveTvmz['' + s.tvmzId] = s.id }
115. titleOk[s.id] = isPublicTitle(s)
116. let y = toNumber(yearWordOf(s))
117. if (addEntry('title', s.id, s.title, yearWordOf(s), (s.type == 'movie' ? 10000 : 0) + (y != null ? 3000 - y : 2999))) { indexStats.titles = indexStats.titles + 1 }
118. return null
119. }
121. // tracker#26 (details.hl): a person added from a title's cast — findable by the search at once
122. static indexPerson = (p) => {
123. ensureIndex()
124. if (addEntry('person', p.id, p.name, '', 0)) { indexStats.people = indexStats.people + 1 }
125. return null
126. }
128. // a title's adult flag changed (the backfill / the daily sync): listed from now on, or not
129. static searchTitleChanged = (showId) => {
130. let s = showsTable.fetch(showId)
131. if (s != null) { titleOk[s.id] = isPublicTitle(s) }
132. if (s != null && s.tvmzId != null) { haveTvmz['' + s.tvmzId] = s.id }
133. return null
134. }
136. // a title's name changed (the daily sync, tracker#18): its old entry goes stale, a new one is added — found by the new name at once
137. static searchTitleRenamed = (showId) => {
138. if (!indexStats.built) { return null }
139. let s = showsTable.fetch(showId)
140. if (s == null) { return null }
141. let old = titleEntry[s.id]
142. if (old != null && entries[old].text == wordsOf(s.title).join(' ')) { return null }
143. if (old != null) { staleEntry['' + old] = true }
144. indexShow(s)
145. return null
146. }
148. // built once: at boot (project.hl calls it), else by the first search
149. static ensureIndex = () => {
150. if (indexStats.built) { return true }
151. indexStats.built = true
152. let t0 = now()
153. for (s of showsTable.find(null, null)) { indexShow(s) }
154. for (p of personsTable.find(null, null)) {
155. if (addEntry('person', p.id, p.name, '', 0)) { indexStats.people = indexStats.people + 1 }
156. }
157. indexStats.ms = now() - t0
158. console.log('search index: ' + indexStats.titles + ' titles, ' + indexStats.people + ' people, ' + indexStats.keys + ' keys, ' + indexStats.ms + ' ms')
159. return true
160. }
162. // tracker.worldapi.org#16 (people.hl): our show id for a TMDB title — `type` 'series' | 'movie' — or null
163. static titleIdByTmdb = (type, tmdbId) => {
164. ensureIndex()
165. return haveTmdb[tmdbKeyOf(type, tmdbId)]
166. }
167. // tracker#18: our show id for a TVmaze id, or null
168. static titleIdByTvmaze = (tvmzId) => {
169. ensureIndex()
170. return haveTvmz['' + tvmzId]
171. }
173. // ---- the query as it comes in the address ------------------------------------------------------------
174. // `/search/<text>`: a full page load hands the page the path segment already DECODED by the server (measured: `%2F` splits
175. // the segment → 404, so the page never puts one in the address), a client-side navigation the RAW one — decoded here.
176. // decodeURIComponent stops the request on a malformed one ('%zz', a broken UTF-8 run), so every %-run is checked first; a
177. // bad one is taken literally. (A text that itself looks like an escape, '%41', is decoded twice on a reload — accepted.)
178. static hexDigits = '0123456789abcdef'
179. static hexAt = (s, i) => {
180. if (i + 3 > s.length) { return -1 }
181. let a = hexDigits.indexOf(s.slice(i + 1, i + 2).toLowerCase())
182. let b = hexDigits.indexOf(s.slice(i + 2, i + 3).toLowerCase())
183. if (a < 0 || b < 0) { return -1 }
184. return a * 16 + b
185. }
186. // the bytes of one run of %XX are valid UTF-8 (the rules decodeURIComponent applies)
187. static utf8Ok = (bytes) => {
188. let i = 0
189. while (i < bytes.length) {
190. let b = bytes[i]
191. let need = 0
192. let lo = 128
193. let hi = 191
194. if (b < 128) { need = 0 } else if (b >= 194 && b <= 223) { need = 1 } else if (b >= 224 && b <= 239) {
195. need = 2
196. if (b == 224) { lo = 160 }
197. if (b == 237) { hi = 159 }
198. } else if (b >= 240 && b <= 244) {
199. need = 3
200. if (b == 240) { lo = 144 }
201. if (b == 244) { hi = 143 }
202. } else { return false }
203. if (i + need > bytes.length - 1) { return false }
204. let k = 1
205. while (k <= need) {
206. let c = bytes[i + k]
207. if (k == 1 && (c < lo || c > hi)) { return false }
208. if (k > 1 && (c < 128 || c > 191)) { return false }
209. k = k + 1
210. }
211. i = i + need + 1
212. }
213. return true
214. }
215. static decodableUri = (s) => {
216. let i = 0
217. while (i < s.length) {
218. if (s.slice(i, i + 1) == '%') {
219. let run = []
220. while (i < s.length && s.slice(i, i + 1) == '%') {
221. let v = hexAt(s, i)
222. if (v < 0) { return false }
223. run.push(v)
224. i = i + 3
225. }
226. if (!utf8Ok(run)) { return false }
227. } else {
228. i = i + 1
229. }
230. }
231. return true
232. }
233. static maxQuery = 100
234. static queryOfParam = (raw) => {
235. if (raw == null || hlTypeName(raw) != 'String' || raw == '') { return '' }
236. let t = raw.includes('%') && decodableUri(raw) ? decodeURIComponent(raw) : raw
237. return t.length > maxQuery ? t.slice(0, maxQuery) : t
238. }
240. // ---- our database ------------------------------------------------------------------------------------
241. static titleLimit = 30
242. static peopleLimit = 10
244. // lower is better: the whole name (0), the name starts with the query (1), its first word does (2), anything else (3);
245. // then the shorter name
246. static scoreOf = (e, qw, qtext) => {
247. if (e.text == qtext) { return 0 }
248. if (e.text.startsWith(qtext)) { return 1 }
249. if (e.words[0].startsWith(qw[0])) { return 2 }
250. return 3
251. }
252. static matchesAll = (e, qw) => {
253. for (q of qw) {
254. let hit = false
255. for (w of e.words) { if (!hit && w.startsWith(q)) { hit = true } }
256. if (!hit) { return false }
257. }
258. return true
259. }
260. // keeps the best `limit` of { score, len, tie, i } in order (hand-written: no list sort(), hybriel#1)
261. static insertTop = (top, item, limit) => {
262. let out = []
263. let inserted = false
264. for (x of top) {
265. if (!inserted && (item.score < x.score || (item.score == x.score && (item.len < x.len || (item.len == x.len && item.tie < x.tie))))) { out.push(item) inserted = true }
266. if (out.length < limit) { out.push(x) }
267. }
268. if (!inserted && out.length < limit) { out.push(item) }
269. return out
270. }
272. // { text, words, titles: [{ id }], people: [{ id }], titleCount, peopleCount, tooShort }
273. static dbSearch = (text) => {
274. ensureIndex()
275. let out = { text = text titles = [] people = [] titleCount = 0 peopleCount = 0 tooShort = false ms = 0 }
276. let t0 = now()
277. let qw = wordsOf(text)
278. let longest = ''
279. for (w of qw) { if (w.length > longest.length) { longest = w } }
280. if (longest.length < 2) { out.tooShort = true return out }
281. let key = longest.slice(0, longest.length >= 3 ? 3 : 2)
282. let cand = buckets[key]
283. if (cand == null) { return out }
284. let qtext = qw.join(' ')
285. let titles = []
286. let people = []
287. for (i of cand) {
288. let e = entries[i]
289. if ((e.kind != 'title' || (titleOk[e.id] == true && staleEntry['' + i] != true)) && matchesAll(e, qw)) {
290. let item = { score = scoreOf(e, qw, qtext) len = e.text.length tie = e.tie i = i }
291. if (e.kind == 'title') {
292. out.titleCount = out.titleCount + 1
293. titles = insertTop(titles, item, titleLimit)
294. } else {
295. out.peopleCount = out.peopleCount + 1
296. people = insertTop(people, item, peopleLimit)
297. }
298. }
299. }
300. for (t of titles) { out.titles.push({ id = entries[t.i].id }) }
301. for (p of people) { out.people.push({ id = entries[p.i].id }) }
302. out.ms = now() - t0
303. return out
304. }
306. // ---- the web (TMDB) -----------------------------------------------------------------------------------
307. static yearOfDate = (d) => { return textOr(d) != null && d.length >= 4 ? d.slice(0, 4) : '' }
309. // TMDB's search: [{ kind ('tv' | 'movie'), tmdbId, title, year, overview, posterUrl }] of what we DON'T have, or
310. // { failed }. One request (search/multi, page 1 = up to 20 results); people and titles we have are left out.
311. static webSearch = (text) => {
312. ensureIndex()
313. let qw = wordsOf(text)
314. if (text == null || text.trim().length < 2 || qw.length == 0) { return { rows = [] left = 0 failed = null } }
315. let j = tmdbGet('/search/multi?query=' + encodeURIComponent(text.trim()) + '&include_adult=false&page=1')
316. if (j.failed != null) { return { rows = [] left = 0 failed = j.failed } }
317. let rows = []
318. let left = 0
319. if (j.results != null) {
320. for (r of j.results) {
321. let kind = r.media_type
322. // mission 054: only what TMDB says is not adult (include_adult=false already, and the result's own flag)
323. if ((kind == 'tv' || kind == 'movie') && r.id != null && hlTypeName(r.id) == 'Number' && adultOf(r) == false) {
324. if (haveTmdb[tmdbKeyOf(kind == 'tv' ? 'series' : 'movie', r.id)] != null) {
325. left = left + 1
326. } else {
327. let title = kind == 'tv' ? textOr(r.name) : textOr(r.title)
328. let year = yearOfDate(kind == 'tv' ? r.first_air_date : r.release_date)
329. if (title != null) {
330. rows.push({ kind = kind tmdbId = r.id title = title year = year
331. overview = textOr(r.overview) != null ? r.overview : ''
332. posterUrl = textOr(r.poster_path) != null ? tmdbImageBase + '/w92' + r.poster_path : '/posters/none' })
333. }
334. }
335. }
336. }
337. }
338. return { rows = rows left = left failed = null }
339. }
341. // ---- the import ------------------------------------------------------------------------------------
342. static slugChars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
343. // "Doctor Who" → "Doctor-Who" (the migrated urlSegment form: letters and digits, everything else one '-'); a slug in use
344. // gets "-2", "-3", … like the migrated ones ("Raised-by-Wolves-2"); a title with no Latin letter at all → "title-<tmdbId>"
345. static slugOf = (title, tmdbId) => {
346. let out = slugBaseOf(title, 'title-' + tmdbId)
347. if (slugTaken[out] != true) { return out }
348. let n = 2
349. while (slugTaken[out + '-' + n] == true) { n = n + 1 }
350. return out + '-' + n
351. }
352. // the slug of a text without the "in use" check — `fallback` when it has no Latin letter at all (people.hl personSlugOf
353. // uses it for new people, tracker#26)
354. static slugBaseOf = (title, fallback) => {
355. let t = normalizeSlugText(title)
356. let out = ''
357. let dash = false
358. let i = 0
359. while (i < t.length) {
360. let c = t.slice(i, i + 1)
361. if (slugChars.includes(c)) {
362. if (dash && out != '') { out = out + '-' }
363. out = out + c
364. dash = false
365. } else {
366. dash = true
367. }
368. i = i + 1
369. }
370. if (out == '') { out = fallback }
371. if (out.length > 80) { out = out.slice(0, 80) }
372. return out
373. }
374. // the accents folded (keeping the case) and apostrophes dropped, so "Grey's Anatomy" → "Greys-Anatomy"
375. static normalizeSlugText = (s) => {
376. let t = '' + s
377. for (p of apostrophes) { if (t.includes(p)) { t = t.replaceAll(p, '') } }
378. for (f of folds) {
379. if (t.includes(f[0])) { t = t.replaceAll(f[0], f[1]) }
380. let up = f[0].toUpperCase()
381. if (up != f[0] && t.includes(up)) { t = t.replaceAll(up, f[1].toUpperCase()) }
382. }
383. return t
384. }
386. // our genres by lower-case name (TMDB's "Drama" → ours); TMDB-only names ("Sci-Fi & Fantasy") are left out
387. static genreIdsOf = (tmdbGenres) => {
388. let out = []
389. if (tmdbGenres == null) { return out }
390. let byName = {}
391. for (g of genresTable.find(null, null)) { if (g.name != null) { byName[('' + g.name).toLowerCase()] = g.id } }
392. for (tg of tmdbGenres) {
393. let id = tg.name != null ? byName[('' + tg.name).toLowerCase()] : null
394. if (id != null && !out.includes(id)) { out.push(id) }
395. }
396. return out
397. }
399. // `kind` 'tv' | 'movie', `tmdbId` a number → { slug, show, created, sync, details } or { error }. A title we already have (same
400. // TMDB id and kind) is not added again: its slug is answered.
401. static importTitle = (kind, tmdbId) => {
402. if (kind != 'tv' && kind != 'movie') { return { error = 'unknown kind' } }
403. // `tid`, not `id`: inside the record literal below an entry named `id` would shadow it for every later entry
404. let tid = toNumber('' + tmdbId)
405. if (tid == null || tid <= 0 || tid % 1 != 0) { return { error = 'bad TMDB id' } }
406. ensureIndex()
407. let type = kind == 'tv' ? 'series' : 'movie'
408. let have = haveTmdb[tmdbKeyOf(type, tid)]
409. if (have != null) {
410. let s = showsTable.fetch(have)
411. if (s != null) { return { slug = s.urlSegment show = s.id created = false } }
412. }
413. let d = tmdbGet('/' + kind + '/' + tid + '?append_to_response=external_ids,' + (kind == 'tv' ? 'aggregate_credits' : 'credits'))
414. if (d.failed != null) { return { error = 'TMDB: ' + d.failed } }
415. let title = kind == 'tv' ? textOr(d.name) : textOr(d.title)
416. if (title == null) { return { error = 'TMDB has no title for ' + kind + ' ' + tid } }
417. let release = textOr(kind == 'tv' ? d.first_air_date : d.release_date)
418. let year = release != null && release.length >= 4 ? toNumber(release.slice(0, 4)) : null
419. // tracker#18: `summary` is the creator's own text — TMDB's goes to tmdbSummary only
420. let record = {
421. id = randomBytes(8, 'hex') title = title summary = null tmdbSummary = textOr(d.overview) tmdbId = tid
422. language = textOr(d.original_language) type = type release = release year = year image = null
423. urlSegment = slugOf(title, tid) episodesCount = null homepage = textOr(d.homepage) imdbId = null seasonsCount = null
424. status = textOr(d.status) tagline = textOr(d.tagline) tvdbId = null tvmzId = null genres = genreIdsOf(d.genres)
425. cast = [] seasons = [] oldId = 'tmdb-' + kind + '-' + tid imported = now() adult = adultOf(d)
426. }
427. if (showsTable.put(record) == null) { return { error = 'could not store the title: ' + showsTable.lastError() } }
428. indexShow(record)
429. let r = syncShowWith(record.id, d)
430. persistSync()
431. // the public lists (catalog.hl, #13) get it at once, like a show the daily sync touched (merge of #13 + #14)
432. refreshCatalogShow(record.id)
433. console.log('search import: ' + kind + ' ' + tid + ' "' + title + '" → /shows/' + record.urlSegment + ' (newSeasons=' + r.newSeasons + ' newEpisodes=' + r.newEpisodes + ' posters=' + r.posters + ' ids=' + r.ids + ' requests=' + r.requests + ' errors=' + r.errors + (r.error != '' ? ' ' + r.error : '') + ')')
434. return { slug = record.urlSegment show = record.id created = true sync = r details = d }
435. }