tickets

4.3 KB

1. // lib/invites.hl — PEOPLE JOIN A PROJECT THROUGH IDENT'S INVITE SERVICE (ticket #20; ident README "Invites",
2. // ident#22). An admin asks ident for an invite for one project and a role (mayInvite, createInvite) and shows the
3. // link; whoever opens it and picks an identity is sent back to /login/callback?ident_code=…&invite=<invite id>.
4. // lib/api.hl loginCallback then exchanges the code (users.hl), and joinByInvite asks ident who ACCEPTED the invite
5. // (`identities`) and only then makes that person a member. Statics only, the server realm. A failed fetch is
6. // absorbed by project.hl's `on Error` (the call then yields null → "ident did not answer").
7. import { fetch } from 'hl:fetch'
8. import { identKey, identSecret, identExchangeUrl, callbackUrl } from './users.hl'
9. import { projectByRef, isAdminOf, roles, addMember } from './projects.hl'
11. static ua = { 'user-agent' = 'tickets.worldapi.org (ident invites)' }
13. // only letters, digits and dashes (ident's invite ids)
14. static isInviteId = (s) => {
15. if (s == null || hlTypeName(s) != 'String' || s.length == 0 || s.length > 100) { return false }
16. let i = 0
17. while (i < s.length) {
18. let c = s.charCodeAt(i)
19. if (!((c >= 48 && c <= 57) || (c >= 97 && c <= 122) || (c >= 65 && c <= 90) || c == 45 || c == 95)) { return false }
20. i = i + 1
21. }
22. return true
23. }
25. static identCall = (path, body) => {
26. if (identKey == '' || identSecret == '') { return { error = 'invites are not set up on this server (IDENT_API_KEY / IDENT_API_SECRET missing)' } }
27. let json = { key = identKey secret = identSecret }
28. for (k of body.keys()) { json[k] = body[k] }
29. r = fetch(identExchangeUrl + path, { method = 'POST' json = json headers = ua timeoutMs = 10000 })
30. if (r == null || r.status == null || r.status == 0) { return { error = 'ident did not answer' } }
31. j = r.json()
32. if (r.status != 200) { return { error = 'ident refused (' + r.status + (j != null && j.error != null ? ': ' + j.error : '') + ')' } }
33. if (j == null) { return { error = 'ident answered nothing readable' } }
34. return { body = j }
35. }
37. // may this user invite to project `p` with `role`? null, or the refusal { error, field, forbidden? }
38. // (the caller then checks its numbers and calls createInvite)
39. static mayInvite = (p, user, role) => {
40. if (!isAdminOf(p.id, user)) { return { error = 'only an admin of the project can invite' field = '' forbidden = true } }
41. if (!roles.includes(role)) { return { error = 'role must be one of: ' + roles.join(', ') field = 'role' } }
42. return null
43. }
45. // an invite link for `projectId` and `role`: { url, id, expires } | { error }. `email` (optional) makes ident mail it.
46. static createInvite = (projectId, role, uses, days, email) => {
47. body = { project = projectId role = role return = callbackUrl uses = uses days = days }
48. if (email != null && email != '') { body.email = email }
49. r = identCall('/api/invites', body)
50. if (r.error != null) { return r }
51. j = r.body
52. if (j.url == null || j.id == null) { return { error = 'ident answered no invite link' } }
53. return { url = j.url id = j.id expires = j.expires mailed = j.mailed == true }
54. }
56. // did this identity accept this invite? { project (id), role } | { error }
57. static acceptedInvite = (inviteId, identity) => {
58. if (!isInviteId(inviteId)) { return { error = 'that is not an invite id' } }
59. r = identCall('/api/invites/get', { id = inviteId })
60. if (r.error != null) { return r }
61. inv = r.body.invite
62. if (inv == null || inv.project == null || inv.role == null) { return { error = 'ident answered no invite' } }
63. let ok = false
64. if (inv.identities != null && countOfIds(inv.identities) > 0) { for (i of inv.identities) { if (i == identity) { ok = true } } }
65. if (!ok) { return { error = 'this login did not accept that invite' } }
66. return { project = inv.project role = inv.role }
67. }
68. static countOfIds = (list) => {
69. n = list.length
70. return n == null ? 0 : n
71. }
73. // THE INVITED PERSON JOINS (the login callback brought `invite=<id>`): only when ident says this identity accepted
74. // the invite does the user become a member, with the invite's role. Answers { project (record) } or { error }
75. static joinByInvite = (inviteId, identity, userId) => {
76. a = acceptedInvite(inviteId, identity)
77. if (a.error != null) { return a }
78. jp = projectByRef(a.project)
79. if (jp == null || !roles.includes(a.role)) { return { error = 'the invite is for a project or role that does not exist here' } }
80. addMember(jp.id, userId, a.role)
81. return { project = jp }
82. }