ident

4.5 KB

1. // lib/util.hl — SMALL SHARED HELPERS of ident (mission 009, code order): the storage directory and env numbers,
2. // lists and records, ids, text checks, the email shape, oldest-first order. Each one exists once; the topic files
3. // import what they use. Statics only.
4. import { env } from 'hl:proc'
6. // IDENT_STORAGE names another table DIRECTORY (the gates run on their own). Relative
7. // paths resolve against the ENTRY SCRIPT's directory — tools must pass an absolute one.
8. static dir = env('IDENT_STORAGE') != null ? env('IDENT_STORAGE') : './storage/mpackdb'
10. static envNumber = (name, fallback) => {
11. v = env(name)
12. if (v == null || v == '') { return fallback }
13. n = toNumber(v)
14. return n == null ? fallback : n
15. }
17. // an empty list written to hl:mpackdb comes back as an empty hybrid (`.length` null)
18. static countOf = (list) => {
19. if (list == null) { return 0 }
20. n = list.length
21. return n == null ? 0 : n
22. }
23. static first = (list) => { return countOf(list) > 0 ? list[0] : null }
25. static str = (v) => { return v == null ? '' : v }
26. static isList = (v) => { return v != null && hlTypeName(v) == 'Hybrid' && v.length != null }
27. static isObject = (v) => { return v != null && hlTypeName(v) == 'Hybrid' && v.length == null }
29. // A PUBLIC ID is an mpackdb UUID: a non-empty string (a number is never one — an old
30. // numeric id from before mission 009 finds nothing)
31. static isId = (v) => { return v != null && hlTypeName(v) == 'String' && v.length > 0 && v.length <= 64 }
33. // every record is written as a whole (hl:mpackdb's update replaces it)
34. static merged = (rec, changes) => {
35. out = {}
36. for (k of rec.keys()) { out[k] = rec[k] }
37. for (k of changes.keys()) { out[k] = changes[k] }
38. return out
39. }
41. // OLDEST FIRST: by the stored `created`, a tie by the id (never by key order)
42. static olderThan = (a, b) => {
43. ca = a.created == null ? 0 : a.created
44. cb = b.created == null ? 0 : b.created
45. if (ca != cb) { return ca < cb }
46. return a.id < b.id // strings order by code point (hybriel#2)
47. }
48. // a found list, oldest first (insertion sort by hand: no list sort(), hybriel #6)
49. static oldestFirst = (list) => {
50. out = []
51. if (countOf(list) == 0) { return out }
52. for (x of list) { out.push(x) }
53. let i = 1
54. while (i < out.length) {
55. let cur = out[i]
56. let j = i - 1
57. while (j >= 0 && olderThan(cur, out[j])) {
58. out[j + 1] = out[j]
59. j = j - 1
60. }
61. out[j + 1] = cur
62. i = i + 1
63. }
64. return out
65. }
67. // ---- text checks ------------------------------------------------------------------------
68. // no control characters (a field is one line of text)
69. static hasControl = (s) => {
70. let i = 0
71. while (i < s.length) {
72. let c = s.charCodeAt(i)
73. if (c < 32 || c == 127) { return true }
74. i = i + 1
75. }
76. return false
77. }
79. // the characters a URL may hold (a return URL, a notification's icon / link)
80. static urlChars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-._~:/?&=%+,;@!$()*[]'
82. // AN EMAIL ADDRESS: lowercased and trimmed, then a plain whitelist shape
83. static normEmail = (email) => { return email == null ? '' : ('' + email).trim().toLowerCase() }
85. static validEmail = (email) => {
86. if (email == null || email.length < 3 || email.length > 200) { return false }
87. at = email.indexOf('@')
88. if (at < 1 || at != email.lastIndexOf('@') || at == email.length - 1) { return false }
89. if (!email.slice(at + 1, email.length).includes('.')) { return false }
90. // a whitelist: the language has no escapes to name a CR or a tab with
91. ok = 'abcdefghijklmnopqrstuvwxyz0123456789.-_+@'
92. let i = 0
93. while (i < email.length) {
94. if (!ok.includes(email[i])) { return false }
95. i = i + 1
96. }
97. return true
98. }
100. // A TIME ZONE is an IANA name as the browser reports it (`Europe/Vienna`, `UTC`,
101. // `America/Argentina/Buenos_Aires`, `Etc/GMT+5`). hl:time knows no zones (hybriel #11),
102. // so the server checks the SHAPE only; the page checks the name against the browser's
103. // own list (Intl.supportedValuesOf) before it sends it.
104. static zoneChars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/_+-'
105. static checkTimeZone = (tz) => {
106. if (tz == null || hlTypeName(tz) != 'String') { return { error = 'the time zone must be a string' } }
107. t = tz.trim()
108. if (t == '') { return { error = 'the time zone is empty' } }
109. if (t.length > 64) { return { error = 'the time zone name is too long' } }
110. let i = 0
111. while (i < t.length) {
112. if (!zoneChars.includes(t[i])) { return { error = 'that is not a time zone name (like Europe/Vienna)' } }
113. i = i + 1
114. }
115. if (t[0] == '/' || t[t.length - 1] == '/' || t.includes('//')) { return { error = 'that is not a time zone name (like Europe/Vienna)' } }
116. return { timeZone = t }
117. }