calendar

9.2 KB

1. // events.hl — THE EVENTS (ticket calendar#2). One hl:mpackdb table, storage/mpackdb/events.db, pk @id, index owner.
2. // A record IS a WorldAPI Event (https://worldapi.org/standards/event): the `$`-keys `$type $version $kind $title
3. // $description $start $end $timezone $location $status $visibility $created $updated`, plus `owner` (the users @id)
4. // and the @id. Appointment: `$start`/`$end` local wall-clock `YYYY-MM-DDTHH:MM:SS` in `$timezone`. All-day:
5. // `$kind = 'allday'`, `$start` a date, `$end` the EXCLUSIVE end date (left out for one day). Every event is
6. // `$visibility = 'private'`: every function takes the owner's user id and reaches only that user's events.
7. import { MPackDB } from 'hl:mpackdb'
8. import { timestamp } from 'hl:time'
9. import { storageDir, countOfList, firstOf } from './users.hl'
10. import { isText, isDate, isTime, isZone, nextDay, prevDay, before } from './components/month-view/dates.hl'
11. import { toReminders, toRows, defaultRows } from './components/month-view/reminders.hl'
13. static eventsTable = new MPackDB(file = storageDir + '/events.db', primaryKey = '@id', indexes = ['owner'])
15. // the calendar's settings: the default reminders every event without its own gets (`$reminders` of the WorldAPI Calendar)
16. static settingsTable = new MPackDB(file = storageDir + '/settings.db', primaryKey = '@id', indexes = ['!owner'])
18. static maxTitle = 200
19. static maxPlace = 200
20. static maxNotes = 5000
22. // what the page sends: { id?, custom, reminders (rows), title, allDay, startDate, startTime, endDate, endTime, place, notes, zone }
23. // → { error } or { record } (a WorldAPI Event without owner/id). endDate/endTime may be empty (no end); all-day: the
24. // last day, inclusive ('' = one day).
25. static build = (b) => {
26. if (b == null || hlTypeName(b) != 'Hybrid') { return { error = 'the event must be an object' } }
27. if (!isText(b.title) || b.title.trim() == '') { return { error = 'the event needs a title' } }
28. if (b.title.length > maxTitle) { return { error = 'the title is too long (at most ' + maxTitle + ' characters)' } }
29. if (!isText(b.place) || b.place.length > maxPlace) { return { error = 'the place is too long (at most ' + maxPlace + ' characters)' } }
30. if (!isText(b.notes) || b.notes.length > maxNotes) { return { error = 'the notes are too long (at most ' + maxNotes + ' characters)' } }
31. if (b.allDay != true && b.allDay != false) { return { error = 'allDay must be true or false' } }
32. if (!isDate(b.startDate)) { return { error = 'the start date is not a date' } }
33. if (!isZone(b.zone)) { return { error = 'the time zone is missing' } }
34. let r = {}
35. r['$type'] = 'event'
36. r['$version'] = 1
37. r['$title'] = b.title.trim()
38. if (b.notes.trim() != '') { r['$description'] = b.notes }
39. if (b.place.trim() != '') { r['$location'] = b.place.trim() }
40. r['$status'] = 'confirmed'
41. r['$visibility'] = 'private'
42. // no own reminders: `$reminders` stays out and the calendar's apply; own ones (also none at all) are written
43. if (b.custom == true) {
44. let rem = toReminders(b.reminders)
45. if (rem.error != null) { return { error = rem.error } }
46. r['$reminders'] = rem.reminders
47. }
48. if (b.allDay) {
49. r['$kind'] = 'allday'
50. r['$start'] = b.startDate
51. if (isText(b.endDate) && b.endDate != '') {
52. if (!isDate(b.endDate)) { return { error = 'the end date is not a date' } }
53. if (before(b.endDate, b.startDate)) { return { error = 'the end is before the start' } }
54. if (b.endDate != b.startDate) { r['$end'] = nextDay(b.endDate) }
55. }
56. return { record = r }
57. }
58. if (!isTime(b.startTime)) { return { error = 'the start time is not a time' } }
59. r['$kind'] = 'appointment'
60. r['$timezone'] = b.zone
61. r['$start'] = b.startDate + 'T' + b.startTime + ':00'
62. let hasEnd = (isText(b.endDate) && b.endDate != '') || (isText(b.endTime) && b.endTime != '')
63. if (hasEnd) {
64. let ed = isText(b.endDate) && b.endDate != '' ? b.endDate : b.startDate
65. if (!isDate(ed)) { return { error = 'the end date is not a date' } }
66. if (!isTime(b.endTime)) { return { error = 'the end time is not a time' } }
67. let end = ed + 'T' + b.endTime + ':00'
68. if (before(end, r['$start'])) { return { error = 'the end is before the start' } }
69. r['$end'] = end
70. }
71. return { record = r }
72. }
74. // what the page shows of a stored event: first / last day (inclusive), times, texts
75. static viewOf = (e) => {
76. let allDay = e['$kind'] == 'allday'
77. let start = e['$start']
78. let end = e['$end']
79. let first = start.slice(0, 10)
80. let last = first
81. if (allDay) {
82. if (end != null) { last = prevDay(end) }
83. } else if (end != null) {
84. last = end.slice(0, 10)
85. }
86. let v = { id = e.id title = e['$title'] allDay = allDay first = first last = last
87. startDate = first startTime = allDay ? '' : start.slice(11, 16)
88. endDate = end == null ? '' : last endTime = allDay || end == null ? '' : end.slice(11, 16)
89. place = e['$location'] == null ? '' : e['$location'] notes = e['$description'] == null ? '' : e['$description']
90. start = start zone = e['$timezone'] == null ? '' : e['$timezone']
91. custom = e['$reminders'] != null rows = e['$reminders'] == null ? [] : toRows(e['$reminders']) }
92. return v
93. }
95. static ownEvent = (userId, id) => {
96. if (id == null || hlTypeName(id) != 'String' || id == '') { return null }
97. let e = eventsTable.fetch(id)
98. if (e == null || e.owner != userId) { return null }
99. return e
100. }
102. // the owner's events that touch first..last (dates), by start
103. static eventsBetween = (userId, first, last) => {
104. let found = eventsTable.find('owner', userId)
105. let n = countOfList(found)
106. let views = []
107. let i = 0
108. while (i < n) {
109. let v = viewOf(found[i])
110. if (!before(v.last, first) && !before(last, v.first)) { views.push(v) }
111. i = i + 1
112. }
113. let m = views.length
114. let out = []
115. let used = []
116. i = 0
117. while (i < m) { used.push(false) i = i + 1 }
118. let round = 0
119. while (round < m) {
120. let best = -1
121. let j = 0
122. while (j < m) {
123. if (!used[j] && (best < 0 || before(views[j].start, views[best].start))) { best = j }
124. j = j + 1
125. }
126. used[best] = true
127. out.push(views[best])
128. round = round + 1
129. }
130. return out
131. }
133. // an event made offline carries a temporary id `local-…` until the page reloads; the server keeps it as `ref`, so an edit
134. // (or delete) sent with that id reaches the same event instead of making a second one
135. static isLocalId = (id) => { return isText(id) && id.length > 6 && id.length <= 60 && id.slice(0, 6) == 'local-' }
137. static realId = (userId, id) => {
138. if (!isLocalId(id)) { return id }
139. let found = eventsTable.find('owner', userId)
140. let n = countOfList(found)
141. let i = 0
142. while (i < n) {
143. if (found[i].ref == id) { return found[i].id }
144. i = i + 1
145. }
146. return null
147. }
149. // create, or change when the fields name an event (real or temporary id)
150. static saveEvent = (userId, b) => {
151. if (b != null && hlTypeName(b) == 'Hybrid' && b.id != null && b.id != '') {
152. let id = realId(userId, b.id)
153. if (id != null) { return changeEvent(userId, id, b) }
154. if (!isLocalId(b.id)) { return changeEvent(userId, b.id, b) }
155. }
156. return createEvent(userId, b)
157. }
159. static createEvent = (userId, b) => {
160. let x = build(b)
161. if (x.error != null) { return x }
162. let r = x.record
163. let t = timestamp()
164. r['$created'] = t
165. r['$updated'] = t
166. r.owner = userId
167. if (isLocalId(b.id)) { r.ref = b.id }
168. let id = eventsTable.put(r)
169. if (id == null) { return { error = 'could not store the event: ' + eventsTable.lastError() } }
170. return { id = id }
171. }
173. static changeEvent = (userId, id, b) => {
174. let old = ownEvent(userId, id)
175. if (old == null) { return { error = 'no such event' } }
176. let x = build(b)
177. if (x.error != null) { return x }
178. let r = x.record
179. r['$created'] = old['$created']
180. r['$updated'] = timestamp()
181. r.owner = userId
182. if (old.ref != null) { r.ref = old.ref }
183. r.id = id
184. eventsTable.update(id, r)
185. return { id = id }
186. }
188. static deleteEvent = (userId, given) => {
189. let id = realId(userId, given)
190. let old = ownEvent(userId, id)
191. if (old == null) { return { error = 'no such event' } }
192. eventsTable.delete(id)
193. return { ok = true }
194. }
197. // ---- the calendar's default reminders and the reminders still to come ----------------------------------
199. static settingsOf = (userId) => { return firstOf(settingsTable.find('owner', userId)) }
201. // the rows of the owner's defaults (1 hour before, the day before at 20:00 until they change them)
202. static defaultsOf = (userId) => {
203. let s = settingsOf(userId)
204. if (s == null || s.reminders == null) { return defaultRows }
205. return toRows(s.reminders)
206. }
208. static saveDefaults = (userId, rows) => {
209. let rem = toReminders(rows)
210. if (rem.error != null) { return rem }
211. let s = settingsOf(userId)
212. let r = { owner = userId reminders = rem.reminders }
213. if (s == null) {
214. if (settingsTable.put(r) == null) { return { error = 'could not store the settings: ' + settingsTable.lastError() } }
215. } else {
216. r.id = s.id
217. settingsTable.update(s.id, r)
218. }
219. return { ok = true }
220. }
222. // the owner's events starting first..last with the reminders that apply (own, else the defaults); timed and all-day
223. static upcoming = (userId, first, last) => {
224. let defaults = defaultsOf(userId)
225. let found = eventsTable.find('owner', userId)
226. let n = countOfList(found)
227. let out = []
228. let i = 0
229. while (i < n) {
230. let v = viewOf(found[i])
231. if (!before(v.first, first) && !before(last, v.first)) {
232. let list = { id = v.id title = v.title allDay = v.allDay startDate = v.startDate startTime = v.startTime place = v.place zone = v.zone rows = v.custom ? v.rows : defaults }
233. out.push(list)
234. }
235. i = i + 1
236. }
237. return out
238. }