-
Notifications
You must be signed in to change notification settings - Fork 0
/
spec-block.go
419 lines (361 loc) · 14.2 KB
/
spec-block.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
package main
import (
"database/sql"
"fmt"
"net/http"
"time"
)
const blockTitleMaxLen = 255
// SpecBlock represents a section within a spec or spec subspec.
type SpecBlock struct {
ID int64 `json:"id"`
SpecID int64 `json:"specId"`
Created time.Time `json:"created"`
Updated time.Time `json:"updated"`
SubspecID *int64 `json:"subspecId"` // may be null (belongs to spec directly)
ParentID *int64 `json:"parentId"` // may be null (root level)
OrderNumber int `json:"orderNumber"`
StyleType string `json:"styleType"`
ContentType string `json:"contentType"`
RefType *string `json:"refType"`
RefID *int64 `json:"refId"`
Title *string `json:"title"`
Body *string `json:"body"`
HTML *string `json:"html"` // rendered when content type is markdown
RefItem interface{} `json:"refItem,omitempty"`
// Community attributes
UnreadCount uint `json:"unreadCount"`
CommentsCount uint `json:"commentsCount"`
// Note on omitempty: https://play.golang.org/p/Lk_FdWeL4i8
// empty slice will be omitted
SubBlocks []*SpecBlock `json:"subblocks,omitempty"`
}
const (
// ListStyleBullet indicates a bullet point style list item.
ListStyleBullet = "bullet"
// ListStyleNumbered indicates a list item numbered relative to other numbered items in the same list.
ListStyleNumbered = "numbered"
// ListStyleNone indicates a list item with no bullet.
ListStyleNone = "none"
// TextContentPlain indicates plaintext with potential newlines.
TextContentPlain = "plaintext"
// TextContentMarkdown indicates markdown processing is required for rendering.
TextContentMarkdown = "markdown"
)
func isValidListStyleType(t string) bool {
return stringInSlice(t, []string{
ListStyleBullet,
ListStyleNumbered,
ListStyleNone,
})
}
func isValidTextContentType(t string) bool {
return stringInSlice(t, []string{
TextContentPlain,
TextContentMarkdown,
})
}
func loadBlockForEditing(db DBConn, userID uint, specID, blockID int64) (*SpecBlock, error) {
var args = []interface{}{specID, userID, blockID}
// only load block_body; preview will be rendered separately if content type is Markdown
var query = `SELECT spec_block.id, spec_block.spec_id, spec_block.created_at, spec_block.updated_at,
spec_block.subspec_id, spec_block.parent_id, spec_block.order_number,
spec_block.style_type, spec_block.content_type, spec_block.ref_type, spec_block.ref_id,
spec_block.block_title, spec_block.block_body, NULL AS rendered_html,
ref_subspec.spec_id AS subspec_spec_id,
ref_subspec.subspec_name, ref_subspec.subspec_desc, ref_subspec.is_private,
ref_url.spec_id AS url_spec_id, ref_url.created_at AS url_created, ref_url.updated_at AS url_updated,
ref_url.url AS url_url, ref_url.url_title, ref_url.url_desc, ref_url.url_image_data,
-- select number of unread comments
(SELECT COUNT(c.id) FROM spec_community_comment AS c
LEFT JOIN spec_community_read AS r
ON r.user_id = $2 AND r.target_type = 'comment' AND r.target_id = c.id
WHERE c.target_type = 'block' AND c.target_id = spec_block.id
AND r.user_id IS NULL
) AS unread_count,
-- select total number of comments
(SELECT COUNT(*) FROM spec_community_comment AS c
WHERE c.target_type = 'block' AND c.target_id = spec_block.id
) AS comments_count
FROM spec_block
LEFT JOIN spec_subspec AS ref_subspec
ON spec_block.ref_type = ` + argPlaceholder(BlockRefSubspec, &args) + `
AND ref_subspec.id = spec_block.ref_id
AND ref_subspec.spec_id = spec_block.spec_id
LEFT JOIN spec_url AS ref_url
ON spec_block.ref_type = ` + argPlaceholder(BlockRefURL, &args) + `
AND ref_url.id = spec_block.ref_id
AND ref_url.spec_id = spec_block.spec_id
WHERE spec_block.spec_id = $1 AND spec_block.id = $3`
rows, err := db.Query(query, args...)
if err != nil {
return nil, fmt.Errorf("querying blocks: %w", err)
}
blocks := []*SpecBlock{}
blocksByID := map[int64]*SpecBlock{}
err = readBlocks(rows, &blocks, &blocksByID)
if err != nil {
return nil, fmt.Errorf("reading blocks: %w", err)
}
if len(blocks) > 0 {
return blocks[0], nil
}
return nil, fmt.Errorf("no blocks found in spec %d for block %d", specID, blockID)
}
func loadBlocksByID(db DBConn, userID uint, specID int64, blockIDs ...int64) ([]*SpecBlock, error) {
var args = []interface{}{specID, userID}
// build values map for order numbers
var valuesMap = [][]interface{}{}
for i := 0; i < len(blockIDs); i++ {
valuesMap = append(valuesMap, []interface{}{
blockIDs[i],
i,
})
}
// Ref items are only loaded if belonging to the same spec.
// TODO Allow linking to any ref item, but verify current user's access when joining info.
var query = `WITH RECURSIVE block_tree(id) AS (
-- Anchor
SELECT spec_block.id, selected.order_number
FROM spec_block
INNER JOIN (` + argValuesMap(&args, valuesMap) + `) AS selected(id, order_number)
ON selected.id = spec_block.id
WHERE spec_id = $1
UNION ALL
-- Recursive Member
SELECT spec_block.id, spec_block.order_number
FROM spec_block, block_tree
WHERE spec_block.spec_id = $1
AND spec_block.parent_id = block_tree.id
)
SELECT spec_block.id, spec_block.spec_id, spec_block.created_at, spec_block.updated_at,
spec_block.subspec_id, spec_block.parent_id, spec_block.order_number,
spec_block.style_type, spec_block.content_type, spec_block.ref_type, spec_block.ref_id,
spec_block.block_title,
CASE WHEN spec_block.content_type = 'plaintext' THEN spec_block.block_body ELSE NULL END AS block_body,
CASE WHEN spec_block.content_type = 'markdown' THEN spec_block.rendered_html ELSE NULL END AS rendered_html,
ref_subspec.spec_id AS subspec_spec_id,
ref_subspec.subspec_name, ref_subspec.subspec_desc, ref_subspec.is_private,
ref_url.spec_id AS url_spec_id, ref_url.created_at AS url_created, ref_url.updated_at AS url_updated,
ref_url.url AS url_url, ref_url.url_title, ref_url.url_desc, ref_url.url_image_data,
-- select number of unread comments
(SELECT COUNT(c.id) FROM spec_community_comment AS c
LEFT JOIN spec_community_read AS r
ON r.user_id = $2 AND r.target_type = 'comment' AND r.target_id = c.id
WHERE c.target_type = 'block' AND c.target_id = spec_block.id
AND r.user_id IS NULL
) AS unread_count,
-- select total number of comments
(SELECT COUNT(*) FROM spec_community_comment AS c
WHERE c.target_type = 'block' AND c.target_id = spec_block.id
) AS comments_count
FROM spec_block
INNER JOIN block_tree
ON block_tree.id = spec_block.id
LEFT JOIN spec_subspec AS ref_subspec
ON spec_block.ref_type = ` + argPlaceholder(BlockRefSubspec, &args) + `
AND ref_subspec.id = spec_block.ref_id
AND ref_subspec.spec_id = spec_block.spec_id
LEFT JOIN spec_url AS ref_url
ON spec_block.ref_type = ` + argPlaceholder(BlockRefURL, &args) + `
AND ref_url.id = spec_block.ref_id
AND ref_url.spec_id = spec_block.spec_id
ORDER BY spec_block.parent_id, block_tree.order_number`
rows, err := db.Query(query, args...)
if err != nil {
return nil, fmt.Errorf("querying blocks: %w", err)
}
blocks := []*SpecBlock{}
blocksByID := map[int64]*SpecBlock{}
err = readBlocks(rows, &blocks, &blocksByID)
if err != nil {
return nil, fmt.Errorf("reading blocks: %w", err)
}
requestedBlocks := []*SpecBlock{}
for _, b := range blocks {
if int64InSlice(b.ID, blockIDs) {
requestedBlocks = append(requestedBlocks, b)
}
}
return requestedBlocks, nil
}
// load the blocks in a spec or subspec
func loadContextBlocks(db *sql.DB, userID *uint, specID int64, subspecID *int64) ([]*SpecBlock, error) {
var args = []interface{}{}
var unreadCountField string
if userID == nil {
unreadCountField = `0 AS unread_count`
} else {
unreadCountField = `(SELECT COUNT(c.id) FROM spec_community_comment AS c
LEFT JOIN spec_community_read AS r
ON r.user_id = ` + argPlaceholder(userID, &args) + `
AND r.target_type = 'comment' AND r.target_id = c.id
WHERE c.target_type = 'block' AND c.target_id = spec_block.id
AND r.user_id IS NULL
) AS unread_count`
}
// Ref items are only loaded if belonging to the same spec.
// TODO Allow linking to any ref item, but verify current user's access when joining info.
var query = `SELECT spec_block.id, spec_block.spec_id, spec_block.created_at, spec_block.updated_at,
spec_block.subspec_id, spec_block.parent_id, spec_block.order_number,
spec_block.style_type, spec_block.content_type, spec_block.ref_type, spec_block.ref_id,
spec_block.block_title,
CASE WHEN spec_block.content_type = 'plaintext' THEN spec_block.block_body ELSE NULL END AS block_body,
CASE WHEN spec_block.content_type = 'markdown' THEN spec_block.rendered_html ELSE NULL END AS rendered_html,
ref_subspec.spec_id AS subspec_spec_id,
ref_subspec.subspec_name, ref_subspec.subspec_desc, ref_subspec.is_private,
ref_url.spec_id AS url_spec_id, ref_url.created_at AS url_created, ref_url.updated_at AS url_updated,
ref_url.url AS url_url, ref_url.url_title, ref_url.url_desc, ref_url.url_image_data,
-- select number of unread comments
` + unreadCountField + `,
-- select total number of comments
(SELECT COUNT(*) FROM spec_community_comment AS c
WHERE c.target_type = 'block' AND c.target_id = spec_block.id
) AS comments_count
FROM spec_block
LEFT JOIN spec_subspec AS ref_subspec
ON spec_block.ref_type=` + argPlaceholder(BlockRefSubspec, &args) + `
AND ref_subspec.id=spec_block.ref_id
AND ref_subspec.spec_id = spec_block.spec_id
LEFT JOIN spec_url AS ref_url
ON spec_block.ref_type=` + argPlaceholder(BlockRefURL, &args) + `
AND ref_url.id=spec_block.ref_id
AND ref_url.spec_id = spec_block.spec_id
WHERE spec_block.spec_id=` + argPlaceholder(specID, &args) + `
AND ` + eqCond("spec_block.subspec_id", subspecID, &args) + `
ORDER BY spec_block.parent_id, spec_block.order_number`
rows, err := db.Query(query, args...)
if err != nil {
return nil, fmt.Errorf("querying blocks: %w", err)
}
blocks := []*SpecBlock{}
blocksByID := map[int64]*SpecBlock{}
err = readBlocks(rows, &blocks, &blocksByID)
if err != nil {
return nil, fmt.Errorf("reading blocks: %w", err)
}
rootBlocks := []*SpecBlock{}
for _, b := range blocks {
if b.ParentID == nil {
rootBlocks = append(rootBlocks, b)
}
}
return rootBlocks, nil
}
func readBlocks(rows *sql.Rows, blocks *[]*SpecBlock, blocksByID *map[int64]*SpecBlock) error {
for rows.Next() {
b := &SpecBlock{}
var subspecSpecID, urlSpecID *int64
var subspecName, subspecDesc *string
var subspecPrivate *bool
var urlCreated, urlUpdated *time.Time
var urlURL, urlTitle, urlDesc, urlImageData *string
err := rows.Scan(&b.ID, &b.SpecID, &b.Created, &b.Updated,
&b.SubspecID, &b.ParentID, &b.OrderNumber,
&b.StyleType, &b.ContentType, &b.RefType, &b.RefID, &b.Title, &b.Body, &b.HTML,
&subspecSpecID, &subspecName, &subspecDesc, &subspecPrivate,
&urlSpecID, &urlCreated, &urlUpdated, &urlURL, &urlTitle, &urlDesc, &urlImageData,
&b.UnreadCount, &b.CommentsCount)
if err != nil {
if err2 := rows.Close(); err2 != nil {
return fmt.Errorf("closing rows: %s; on scan error: %w", err2, err)
}
return fmt.Errorf("scanning block: %w", err)
}
if b.RefType != nil {
switch *b.RefType {
case BlockRefURL:
if urlSpecID != nil {
b.RefItem = &URLObject{
ID: *b.RefID,
SpecID: *urlSpecID,
Created: *urlCreated,
URL: *urlURL,
Title: urlTitle,
Desc: urlDesc,
ImageData: urlImageData,
Updated: *urlUpdated,
}
}
case BlockRefSubspec:
if subspecSpecID != nil {
b.RefItem = &SpecSubspec{
ID: *b.RefID,
SpecID: *subspecSpecID,
Name: *subspecName,
Desc: subspecDesc,
Private: *subspecPrivate,
}
}
}
}
*blocks = append(*blocks, b)
(*blocksByID)[b.ID] = b
}
// Link blocks to parents
for _, b := range *blocks {
if b.ParentID != nil {
parentBlock, ok := (*blocksByID)[*b.ParentID]
if ok {
parentBlock.SubBlocks = append(parentBlock.SubBlocks, b)
}
}
}
return nil
}
// Increments order numbers of blocks starting at the specified block,
// and returns the order number preceeding that block.
// If insertBeforeID is nil, returns the order number at the end of the list.
func makeInsertAt(tx *sql.Tx,
specID int64, subspecID *int64, parentID *int64, insertBeforeID *int64,
requiredPositions int) (int, int, error) {
if requiredPositions <= 0 {
return 0, 0, fmt.Errorf("invalid requiredPositions: %d", requiredPositions)
}
var insertAt int
if insertBeforeID == nil {
// Insert at end - get next order_number
var args = []interface{}{specID}
var query = `SELECT COALESCE(MAX(order_number), -1) + 1 AS insert_at FROM spec_block
WHERE spec_id = $1
AND ` + eqCond("subspec_id", subspecID, &args) + `
AND ` + eqCond("parent_id", parentID, &args)
var err = tx.QueryRow(query, args...).Scan(&insertAt)
if err != nil {
return 0, http.StatusInternalServerError, fmt.Errorf("selecting next order number: %w", err)
}
return insertAt, http.StatusOK, nil
}
// Increase order numbers of following blocks
var args = []interface{}{specID, requiredPositions}
var query = `UPDATE spec_block
SET order_number = order_number + $2
WHERE spec_id = $1
AND ` + eqCond("subspec_id", subspecID, &args) + `
AND ` + eqCond("parent_id", parentID, &args) + `
AND order_number >= (
SELECT insert_before_block.order_number
FROM spec_block AS insert_before_block
WHERE insert_before_block.id = ` + argPlaceholder(*insertBeforeID, &args) + `
)`
_, err := tx.Exec(query, args...)
if err != nil {
return 0, http.StatusInternalServerError, fmt.Errorf("incrementing order numbers: %w", err)
}
// Get order number after preceeding block
args = []interface{}{specID}
query = `SELECT COALESCE(MAX(order_number), -1) + 1 FROM spec_block
WHERE spec_id = $1
AND ` + eqCond("subspec_id", subspecID, &args) + `
AND ` + eqCond("parent_id", parentID, &args) + `
AND order_number < (
SELECT insert_before_block.order_number
FROM spec_block AS insert_before_block
WHERE insert_before_block.id = ` + argPlaceholder(*insertBeforeID, &args) + `
)`
err = tx.QueryRow(query, args...).Scan(&insertAt)
if err != nil {
return 0, http.StatusInternalServerError, fmt.Errorf("selecting preceeding order number: %w", err)
}
return insertAt, http.StatusOK, nil
}