/
serialization.go
552 lines (482 loc) · 15.4 KB
/
serialization.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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
// apcore is a server framework for implementing an ActivityPub application.
// Copyright (C) 2020 Cory Slep
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package models
import (
"context"
"database/sql"
"database/sql/driver"
"encoding/json"
"errors"
"fmt"
"net/url"
"time"
"github.com/go-fed/activity/pub"
"github.com/go-fed/activity/streams"
"github.com/go-fed/activity/streams/vocab"
"github.com/go-fed/apcore/app"
"github.com/microcosm-cc/bluemonday"
)
// Marshal takes any ActivityStreams type and serializes it to JSON.
func Marshal(v vocab.Type) (b []byte, err error) {
var m map[string]interface{}
m, err = streams.Serialize(v)
if err != nil {
return
}
b, err = json.Marshal(m)
if err != nil {
return
}
return
}
// unmarhsal attempts to deserialize JSON bytes into a value.
func unmarshal(maybeByte, v interface{}) error {
b, ok := maybeByte.([]byte)
if !ok {
return errors.New("failed to assert scan to []byte type")
}
return json.Unmarshal(b, v)
}
// SingleRow allows *sql.Rows to be treated as *sql.Row
type SingleRow interface {
app.SingleRow
}
func MustQueryOneRow(r *sql.Rows, fn func(r SingleRow) error) error {
return enforceOneRow(r, "", fn)
}
// enforceOneRow ensures that there is only one row in the *sql.Rows
//
// Normally, the SQL operations that assume a single row is being returned by
// the database take only the first row and then discard the rest of the rows
// silently. I would rather we know when our expectations are being violated or
// when the database constraints do not match the expected application logic,
// than silently retrieve an arbitrarily row (since the first one grabbed is
// returned arbitrarily, database-and-driver-dependent).
func enforceOneRow(r *sql.Rows, debugname string, fn func(r SingleRow) error) error {
var n int
for r.Next() {
if n > 0 {
return fmt.Errorf("%s: multiple database rows retrieved when enforcing one row", debugname)
}
err := fn(SingleRow(r))
if err != nil {
return err
}
n++
}
return r.Err()
}
func QueryRows(r *sql.Rows, fn func(r SingleRow) error) error {
return doForRows(r, "", fn)
}
// doForRows iterates over all rows and inspects for any errors.
func doForRows(r *sql.Rows, debugname string, fn func(r SingleRow) error) error {
for r.Next() {
err := fn(SingleRow(r))
if err != nil {
return err
}
}
return r.Err()
}
func MustChangeOneRow(r sql.Result) error {
return mustChangeOneRow(r, nil, "")
}
// mustChangeOneRow ensures an Exec SQL statement changes exactly one row, or
// returns an error.
func mustChangeOneRow(r sql.Result, existing error, name string) error {
if existing != nil {
return existing
}
if n, err := r.RowsAffected(); err != nil {
return err
} else if n != 1 {
return fmt.Errorf("sql query for %s changed %d rows instead of 1 row", name, n)
}
return nil
}
var _ driver.Valuer = Privileges{}
var _ sql.Scanner = &Privileges{}
// Privileges are a user's privileges serializable and deserializable into JSON
// for database storage.
type Privileges struct {
// Admin indicates whether to treat the user as an administrator by the
// framework.
Admin bool
// InstanceActor indicates whether to treat the user as the instance
// actor.
InstanceActor bool
// Payload is additional privilege information that is app-specific.
Payload json.RawMessage
}
func (p Privileges) Value() (driver.Value, error) {
return json.Marshal(p)
}
func (p *Privileges) Scan(src interface{}) error {
return unmarshal(src, p)
}
var _ driver.Valuer = Preferences{}
var _ sql.Scanner = &Preferences{}
// Preferences are a user's preferences serializable and deserializable into
// JSON for database storage.
type Preferences struct {
// OnFollow indicates default behavior when a Follow request is received
// by a user.
OnFollow OnFollowBehavior
// Payload is additional preference information that is app-specific.
Payload json.RawMessage
}
func (p Preferences) Value() (driver.Value, error) {
return json.Marshal(p)
}
func (p *Preferences) Scan(src interface{}) error {
return unmarshal(src, p)
}
var _ driver.Valuer = InstanceActorPreferences{}
var _ sql.Scanner = &InstanceActorPreferences{}
// InstanceActorPreferences are the preferences for an instance actor which are
// serializable and deserializable into JSON for database storage.
type InstanceActorPreferences struct {
// OnFollow indicates default behavior when a Follow request is received
// by a user.
OnFollow OnFollowBehavior
// OpenRegistrations indicates whether registrations are open for this
// software.
OpenRegistrations bool
// ServerBaseURL indicates the "base URL" of this server.
ServerBaseURL string
// ServerName contains the name of this particular server.
ServerName string
// OrgName contains the name of the wider organization this server
// belongs to.
OrgName string
// OrgContact contains the contact information for the Organization this
// server belongs to.
OrgContact string
// OrgAccount contains the account information representing the
// Organization this server belongs to.
OrgAccount string
// Payload is additional preference information that is app-specific.
Payload json.RawMessage
}
func (p InstanceActorPreferences) Value() (driver.Value, error) {
return json.Marshal(p)
}
func (p *InstanceActorPreferences) Scan(src interface{}) error {
return unmarshal(src, p)
}
var _ driver.Valuer = OnFollowBehavior(0)
var _ sql.Scanner = (*OnFollowBehavior)(nil)
// OnFollowBehavior is a wrapper around pub.OnFollowBehavior type that also
// knows how to serialize and deserialize itself for SQL database drivers in a
// more readable manner.
type OnFollowBehavior pub.OnFollowBehavior
const (
onFollowAlwaysAccept = "ALWAYS_ACCEPT"
onFollowAlwaysReject = "ALWAYS_REJECT"
onFollowManual = "MANUAL"
)
func (o OnFollowBehavior) Value() (driver.Value, error) {
switch pub.OnFollowBehavior(o) {
case pub.OnFollowAutomaticallyAccept:
return onFollowAlwaysAccept, nil
case pub.OnFollowAutomaticallyReject:
return onFollowAlwaysReject, nil
case pub.OnFollowDoNothing:
fallthrough
default:
return onFollowManual, nil
}
}
func (o *OnFollowBehavior) Scan(src interface{}) error {
s, ok := src.(string)
if !ok {
return errors.New("failed to assert scan to string type")
}
switch s {
case onFollowAlwaysAccept:
*o = OnFollowBehavior(pub.OnFollowAutomaticallyAccept)
case onFollowAlwaysReject:
*o = OnFollowBehavior(pub.OnFollowAutomaticallyReject)
case onFollowManual:
fallthrough
default:
*o = OnFollowBehavior(pub.OnFollowDoNothing)
}
return nil
}
var _ driver.Valuer = ActivityStreams{nil}
var _ sql.Scanner = &ActivityStreams{nil}
// ActivityStreams is a wrapper around any ActivityStreams type that also
// knows how to serialize and deserialize itself for SQL database drivers.
type ActivityStreams struct {
vocab.Type
}
func (a ActivityStreams) SanitizeContentSummaryHTML() {
type unsafeContent interface {
GetActivityStreamsSummary() vocab.ActivityStreamsSummaryProperty
GetActivityStreamsContent() vocab.ActivityStreamsContentProperty
SetActivityStreamsSummary(vocab.ActivityStreamsSummaryProperty)
SetActivityStreamsContent(vocab.ActivityStreamsContentProperty)
}
if ct, ok := a.Type.(unsafeContent); ok {
p := bluemonday.UGCPolicy()
summary := ct.GetActivityStreamsSummary()
if summary != nil && !summary.Empty() {
for iter := summary.Begin(); iter != summary.End(); iter = iter.Next() {
if iter.IsXMLSchemaString() {
iter.SetXMLSchemaString(p.Sanitize(iter.GetXMLSchemaString()))
}
}
}
content := ct.GetActivityStreamsContent()
if content != nil && !content.Empty() {
for iter := content.Begin(); iter != content.End(); iter = iter.Next() {
if iter.IsXMLSchemaString() {
iter.SetXMLSchemaString(p.Sanitize(iter.GetXMLSchemaString()))
}
}
}
}
}
func (a ActivityStreams) Value() (driver.Value, error) {
return Marshal(a)
}
func (a *ActivityStreams) Scan(src interface{}) error {
var m map[string]interface{}
if err := unmarshal(src, &m); err != nil {
return err
}
var err error
a.Type, err = streams.ToType(context.Background(), m)
return err
}
var _ driver.Valuer = ActivityStreamsPerson{nil}
var _ sql.Scanner = &ActivityStreamsPerson{nil}
// ActivityStreamsPerson is a wrapper around the ActivityStreams type that also
// knows how to serialize and deserialize itself for SQL database drivers.
type ActivityStreamsPerson struct {
vocab.ActivityStreamsPerson
}
func (a ActivityStreamsPerson) Value() (driver.Value, error) {
return Marshal(a)
}
func (a *ActivityStreamsPerson) Scan(src interface{}) error {
var m map[string]interface{}
if err := unmarshal(src, &m); err != nil {
return err
}
res, err := streams.NewJSONResolver(func(ctx context.Context, p vocab.ActivityStreamsPerson) error {
a.ActivityStreamsPerson = p
return nil
})
if err != nil {
return err
}
return res.Resolve(context.Background(), m)
}
var _ driver.Valuer = ActivityStreamsApplication{nil}
var _ sql.Scanner = &ActivityStreamsApplication{nil}
// ActivityStreamsApplication is a wrapper around the ActivityStreams type that also
// knows how to serialize and deserialize itself for SQL database drivers.
type ActivityStreamsApplication struct {
vocab.ActivityStreamsApplication
}
func (a ActivityStreamsApplication) Value() (driver.Value, error) {
return Marshal(a)
}
func (a *ActivityStreamsApplication) Scan(src interface{}) error {
var m map[string]interface{}
if err := unmarshal(src, &m); err != nil {
return err
}
res, err := streams.NewJSONResolver(func(ctx context.Context, p vocab.ActivityStreamsApplication) error {
a.ActivityStreamsApplication = p
return nil
})
if err != nil {
return err
}
return res.Resolve(context.Background(), m)
}
var _ driver.Valuer = ActivityStreamsOrderedCollection{nil}
var _ sql.Scanner = &ActivityStreamsOrderedCollection{nil}
// ActivityStreamsOrderedCollection is a wrapper around the ActivityStreams type
// that also knows how to serialize and deserialize itself for SQL database
// drivers.
type ActivityStreamsOrderedCollection struct {
vocab.ActivityStreamsOrderedCollection
}
func (a ActivityStreamsOrderedCollection) Value() (driver.Value, error) {
return Marshal(a)
}
func (a *ActivityStreamsOrderedCollection) Scan(src interface{}) error {
var m map[string]interface{}
if err := unmarshal(src, &m); err != nil {
return err
}
res, err := streams.NewJSONResolver(func(ctx context.Context, oc vocab.ActivityStreamsOrderedCollection) error {
a.ActivityStreamsOrderedCollection = oc
return nil
})
if err != nil {
return err
}
return res.Resolve(context.Background(), m)
}
var _ driver.Valuer = ActivityStreamsOrderedCollectionPage{nil}
var _ sql.Scanner = &ActivityStreamsOrderedCollectionPage{nil}
// ActivityStreamsOrderedCollectionPage is a wrapper around the ActivityStreams
// type that also knows how to serialize and deserialize itself for SQL database
// drivers.
type ActivityStreamsOrderedCollectionPage struct {
vocab.ActivityStreamsOrderedCollectionPage
}
func (a ActivityStreamsOrderedCollectionPage) Value() (driver.Value, error) {
return Marshal(a)
}
func (a *ActivityStreamsOrderedCollectionPage) Scan(src interface{}) error {
var m map[string]interface{}
if err := unmarshal(src, &m); err != nil {
return err
}
res, err := streams.NewJSONResolver(func(ctx context.Context, oc vocab.ActivityStreamsOrderedCollectionPage) error {
a.ActivityStreamsOrderedCollectionPage = oc
return nil
})
if err != nil {
return err
}
return res.Resolve(context.Background(), m)
}
var _ driver.Valuer = ActivityStreamsCollection{nil}
var _ sql.Scanner = &ActivityStreamsCollection{nil}
// ActivityStreamsCollection is a wrapper around the ActivityStreams type
// that also knows how to serialize and deserialize itself for SQL database
// drivers.
type ActivityStreamsCollection struct {
vocab.ActivityStreamsCollection
}
func (a ActivityStreamsCollection) Value() (driver.Value, error) {
return Marshal(a)
}
func (a *ActivityStreamsCollection) Scan(src interface{}) error {
var m map[string]interface{}
if err := unmarshal(src, &m); err != nil {
return err
}
res, err := streams.NewJSONResolver(func(ctx context.Context, oc vocab.ActivityStreamsCollection) error {
a.ActivityStreamsCollection = oc
return nil
})
if err != nil {
return err
}
return res.Resolve(context.Background(), m)
}
var _ driver.Valuer = ActivityStreamsCollectionPage{nil}
var _ sql.Scanner = &ActivityStreamsCollectionPage{nil}
// ActivityStreamsCollectionPage is a wrapper around the ActivityStreams
// type that also knows how to serialize and deserialize itself for SQL database
// drivers.
type ActivityStreamsCollectionPage struct {
vocab.ActivityStreamsCollectionPage
}
func (a ActivityStreamsCollectionPage) Value() (driver.Value, error) {
return Marshal(a)
}
func (a *ActivityStreamsCollectionPage) Scan(src interface{}) error {
var m map[string]interface{}
if err := unmarshal(src, &m); err != nil {
return err
}
res, err := streams.NewJSONResolver(func(ctx context.Context, oc vocab.ActivityStreamsCollectionPage) error {
a.ActivityStreamsCollectionPage = oc
return nil
})
if err != nil {
return err
}
return res.Resolve(context.Background(), m)
}
var _ driver.Valuer = ActivityStreamsFollow{nil}
var _ sql.Scanner = &ActivityStreamsFollow{nil}
// ActivityStreamsFollow is a wrapper around the ActivityStreams
// type that also knows how to serialize and deserialize itself for SQL database
// drivers.
type ActivityStreamsFollow struct {
vocab.ActivityStreamsFollow
}
func (a ActivityStreamsFollow) Value() (driver.Value, error) {
return Marshal(a)
}
func (a *ActivityStreamsFollow) Scan(src interface{}) error {
var m map[string]interface{}
if err := unmarshal(src, &m); err != nil {
return err
}
res, err := streams.NewJSONResolver(func(ctx context.Context, oc vocab.ActivityStreamsFollow) error {
a.ActivityStreamsFollow = oc
return nil
})
if err != nil {
return err
}
return res.Resolve(context.Background(), m)
}
var _ driver.Valuer = NullDuration{}
var _ sql.Scanner = &NullDuration{}
// NullDuration can handle nullable time.Duration values in the database.
type NullDuration struct {
Duration time.Duration
Valid bool
}
func (n NullDuration) Value() (driver.Value, error) {
if !n.Valid {
return nil, nil
}
return n.Duration, nil
}
func (n *NullDuration) Scan(src interface{}) error {
if src == nil {
n.Duration, n.Valid = 0, false
return nil
}
t, ok := src.(int64)
if !ok {
return errors.New("failed to assert scan to int64 type")
}
n.Duration, n.Valid = time.Duration(t), true
return nil
}
var _ driver.Valuer = URL{}
var _ sql.Scanner = &URL{}
// URL handles serializing/deserializing *url.URL types into databases.
type URL struct {
*url.URL
}
func (u URL) Value() (driver.Value, error) {
return u.URL.String(), nil
}
func (u *URL) Scan(src interface{}) error {
s, ok := src.(string)
if !ok {
return errors.New("failed to assert scan to string type")
}
var err error
u.URL, err = url.Parse(s)
return err
}