/
doclayer.go
518 lines (462 loc) · 14.5 KB
/
doclayer.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
/*
Defines and manages Nodes, which can include Kinds or Documents.
colour := Kind("Colour")
// Doesn't exist, CATID_MIN = 10
// LB+ LBTYPE_CATID(10) -> LBTYPE_KIND(LBTYPE_CATKEY("Colour"),LBTYPE_CATID_SET(10))
// LB+ "Colour" -> LBTYPE_CATID(10)
green := Kind("Green")
green.Save()
thing, _, err := NewKind("Thing")
animal, _, err := NewKind("Animal")
animal.AddParent(thing).Save()
thing.Save()
animal.Save()
frog := NewDoc("frog", animal)
frog.SetField("eyes", uint8(2))
frog.SetField("colour", green)
frog.Save()
// LB+ LBTYPE_CATID(11) -> LBTYPE_CATKEY("/Thing/Animal/")
// LB+ "/Thing/Animal/" -> LBTYPE_CATID(11)
// LB+ LBTYPE_CATIDS(12) -> VALOC -> LBTYPE_DOC(LBTYPE_CATKEY("Thing/Animal/frog"),LBTYPE_MAP("colour":LBTYPE_CATIDS(1),"eyes":LBTYPE_UINT8(2)))
// LB+ "/Thing/Animal/frog" -> LBTYPE_CATIDS(12)
f1 := GetDoc(animal, "frog") // Finds "/Thing/Animal/frog" and retrieves each field into struct
*/
package logbase
import (
"github.com/h00gs/gubed"
"fmt"
"encoding/binary"
"bytes"
"strings"
"io"
)
const (
NODE_TYPE_SEPARATOR string = ":"
)
type NodeConfig struct {
namespace string
}
var NodeConfigs = map[LBTYPE]*NodeConfig{
LBTYPE_KIND: &NodeConfig{"kind"},
LBTYPE_DOC: &NodeConfig{"doc"},
}
var NodeKeyPrefix map[string]LBTYPE = make(map[string]LBTYPE)
func init() {
// Create namespace reverse map, adding in NODE_TYPE_SEPARATOR
for typ, ncfg := range NodeConfigs {
NodeKeyPrefix[ncfg.namespace + NODE_TYPE_SEPARATOR] = typ
}
}
// A Node can represent a "kind" (type or class) or a "document".
type Node struct {
cid *CatalogId
name string // MC string key stored with namespace prefix
parents *CatalogIdSet
ntype LBTYPE
*FieldMap
mcr_id CatalogRecord // Allows us to convert between Node <-> Catalog
mcr_name CatalogRecord // Allows us to convert between Node <-> Catalog
debug *gubed.Logger // a small price to pay
}
type Field struct {
*Vtype
*Vdata // does not include LBTYPE
}
type FieldMap struct {
fields map[string]*Field
}
// Node.
// Getters.
func (node *Node) CATID() *CatalogId {return node.cid}
func (node *Node) Id() CATID_TYPE {return node.cid.id}
func (node *Node) NodeType() LBTYPE {return node.ntype}
func (node *Node) Name() string {return node.name}
func (node *Node) Fields() map[string]*Field {return node.FieldMap.fields}
func (node *Node) GetFieldMap() *FieldMap {return node.FieldMap}
func (node *Node) Parents() *CatalogIdSet {return node.parents}
func (node *Node) GetIdCatalogRecord() CatalogRecord {return node.mcr_id}
func (node *Node) GetNameCatalogRecord() CatalogRecord {return node.mcr_name}
func (node *Node) SetId(id CATID_TYPE) {
node.cid = NewCatalogId(id)
return
}
func (node *Node) ReadCheckType(bfr *bytes.Buffer, reqtyp LBTYPE, nilok bool, desc string) (typ LBTYPE, err error) {
err = node.debug.DecodeError(binary.Read(bfr, BIGEND, &typ))
if err != nil {return}
if typ == reqtyp || (nilok && typ == LBTYPE_NIL) {return}
nilstr := ""
if !nilok && typ == LBTYPE_NIL {
nilstr = ", and this node does not permit nil type"
}
err = node.debug.Error(FmtErrBadType(
"Decoding %s bytes, LBTYPE should be %v but is %v" + nilstr,
desc, reqtyp, typ))
return
}
func (node *Node) ReadSizedBytes(bfr *bytes.Buffer) (byts []byte, err error) {
var size LBUINT
err = node.debug.DecodeError(binary.Read(bfr, BIGEND, &size))
if err != nil {return}
byts = make([]byte, int(size))
err = node.debug.DecodeError(binary.Read(bfr, BIGEND, &byts))
return
}
// Read the parent CATID set, which is always the last section of the buffer.
func (node *Node) ReadCATIDSet(bfr *bytes.Buffer) (err error) {
rem := bfr.Len() % int(CATID_TYPE_SIZE)
if rem > 0 {
err = node.debug.Error(FmtErrPartialCATIDSet(bfr.Len(), CATID_TYPE_SIZE))
return
}
n := bfr.Len() / int(CATID_TYPE_SIZE)
var id CATID_TYPE
node.parents.set = make([]*CatalogId, n)
for i := 0; i < n; i++ {
err = node.debug.Error(binary.Read(bfr, BIGEND, &id))
node.parents.set[i] = NewCatalogId(id)
if err != nil {break}
}
return
}
// Return a byte slice with a Node packed ready for file writing.
func (node *Node) Pack() []byte {
bfr := new(bytes.Buffer)
// Write CATID
binary.Write(bfr, BIGEND, LBTYPE_CATID)
binary.Write(bfr, BIGEND, node.Id())
// Write Catalog string key
binary.Write(bfr, BIGEND, LBTYPE_CATKEY)
ksz := AsLBUINT(len(node.Name()))
binary.Write(bfr, BIGEND, ksz)
bfr.Write([]byte(node.Name()))
// Write field map
if node.HasFields() > 0 {
binary.Write(bfr, BIGEND, LBTYPE_MAP)
byts := node.FieldMap.ToBytes(node.debug)
binary.Write(bfr, BIGEND, AsLBUINT(len(byts)))
bfr.Write(byts)
} else {
binary.Write(bfr, BIGEND, LBTYPE_NIL)
}
// Write parents CATID set
if node.HasParents() > 0 {
binary.Write(bfr, BIGEND, LBTYPE_CATID_SET)
byts := node.parents.ToBytes(node.debug)
binary.Write(bfr, BIGEND, AsLBUINT(len(byts)))
bfr.Write(byts)
} else {
binary.Write(bfr, BIGEND, LBTYPE_NIL)
}
return bfr.Bytes()
}
// Unpack Node bytes.
func (node *Node) FromBytes(bfr *bytes.Buffer) (error) {
// Read CATID
_, err := node.ReadCheckType(bfr, LBTYPE_CATID, false, "cid") // read LBTYPE
if err != nil {return err}
var id CATID_TYPE
err = node.debug.Error(binary.Read(bfr, BIGEND, &id)) // read CATID
node.SetId(id)
if err != nil {return err}
// Read Catalog string key
_, err = node.ReadCheckType(bfr, LBTYPE_CATKEY, false, "name") // read LBTYPE
if err != nil {return err}
kbyts, err := node.ReadSizedBytes(bfr) // read name key
if err != nil {return err}
node.name = string(kbyts)
// Read field map (optional or LBTYPE_NIL allowed in case of a LBTYPE_KIND)
nilok := (node.ntype == LBTYPE_KIND)
typ, err := node.ReadCheckType(bfr, LBTYPE_MAP, nilok, "field map") // read LBTYPE
if err != nil {return err}
node.FieldMap = NewFieldMap()
if typ != LBTYPE_NIL {
fbyts, err := node.ReadSizedBytes(bfr) // read field map bytes
if err != nil {return err}
node.FieldMap.FromBytes(bytes.NewBuffer(fbyts), node.debug)
}
// Read parents CATID set (can be LBTYPE_NIL)
typ, err = node.ReadCheckType(bfr, LBTYPE_CATID_SET, true, "parents set") // read LBTYPE
if err != nil {return err}
if typ != LBTYPE_NIL {
pbyts, err := node.ReadSizedBytes(bfr) // read field map bytes
if err != nil {return err}
err = node.parents.FromBytes(bytes.NewBuffer(pbyts), node.debug) // read parents set
return err
}
return nil
}
func MintNode(ntype LBTYPE) *Node {
return &Node{
ntype: ntype,
parents: NewCatalogIdSet(),
debug: gubed.ScreenLogger,
FieldMap: NewFieldMap(),
}
}
func MakeNode(name string, ntype LBTYPE, debug *gubed.Logger) *Node {
switch ntype {
case LBTYPE_KIND, LBTYPE_DOC:
return &Node{
name: name,
ntype: ntype,
parents: NewCatalogIdSet(),
debug: debug,
FieldMap: NewFieldMap(),
}
default:
debug.Error(FmtErrBadType("Bad key type: %d", ntype))
return nil
}
}
func NormaliseNodeName(name string, ntype LBTYPE) string {
prefix := NodeConfigs[ntype].namespace + NODE_TYPE_SEPARATOR
basename := strings.TrimPrefix(name, prefix)
return prefix + basename
}
func (lbase *Logbase) NewNode(name string, ntype LBTYPE, create bool) (node *Node, exists bool, err error) {
// Check cache
normname := NormaliseNodeName(name, ntype)
obj, present := lbase.NodeCache().objects[normname]
if present {return obj.(*Node), true, nil}
vbyts, vtype, mcr_name, err := lbase.Get(normname)
if err != nil {return}
exists = false
if vbyts == nil && create {
// A new node
node = MakeNode(normname, ntype, lbase.debug)
node.SetId(lbase.MasterCatalog().PopNextId())
} else {
exists = true
node = MakeNode(normname, ntype, lbase.debug)
// Read existing node data
if vtype != LBTYPE_CATID {
err = lbase.debug.Error(FmtErrBadType(
"Found record in logbase %s for node %q with type %v, " +
"but should be type %v",
lbase.name, normname, vtype, LBTYPE_CATID))
return
}
id, err1 := BytesToCatalogId(vbyts, lbase.debug)
if err1 != nil {err = err1; return}
var mcr_id CatalogRecord
vbyts, vtype, mcr_id, err = lbase.Get(id)
if vbyts == nil {
err = lbase.debug.Error(FmtErrKeyNotFound(id))
return
}
if vtype != ntype {
err = lbase.debug.Error(FmtErrBadType(
"Found record %v in logbase %s for node %q via CATID %v " +
"with type %v, but should be type %v",
vbyts, lbase.name, normname, id, vtype, ntype))
return
}
node.mcr_id = mcr_id
node.mcr_name = mcr_name
node.FromBytes(bytes.NewBuffer(vbyts))
}
// Add to cache
lbase.NodeCache().objects[normname] = node
return
}
// Save two records, the first maps the node CATID to its complete binary
// representation, the second maps the name string to the parents set.
func (node *Node) Save(lbase *Logbase) error {
lbase.debug.Basic("Saving %q to logbase %s", node.Name(), lbase.Name())
mcr_id, err := lbase.Put(node.CATID().id, node.Pack(), LBTYPE_KIND)
node.mcr_id = mcr_id
if node.debug.Error(err) != nil {return err}
mcr_name, err := lbase.Put(node.Name(), node.CATID().ToBytes(node.debug), LBTYPE_CATID)
node.mcr_name = mcr_name
return node.debug.Error(err)
}
func (node *Node) String() string {
return fmt.Sprintf("{%q %v %v %v}",
node.Name(),
node.CATID(),
node.GetFieldMap(),
node.Parents())
}
// A Node can only have parents of type Kind.
func (node *Node) AddParent(parent *Node) *Node {
if parent.NodeType() != LBTYPE_KIND {
node.debug.Error(FmtErrBadType(
"Only a node of LBTYPE_KIND can be a parent, nothing done"))
} else {
node.parents.Add(parent.CATID())
}
return node
}
// Alias for AddParent.
func (node *Node) OfKind(parent *Node) *Node {
return node.AddParent(parent)
}
func (node *Node) HasParent(parent *Node) bool {
return node.Parents().Contains(parent.CATID())
}
func (node *Node) HasParents() int {
return len(node.Parents().set)
}
func (node *Node) HasFields() int {
return len(node.Fields())
}
// Kind.
// Create a Kind instance, and retrieve the logbase data for it if it exists.
func (lbase *Logbase) Kind(name string) (*Node, bool, error) {
return lbase.NewNode(name, LBTYPE_KIND, true)
}
// Retrieve the Kind if it exists.
func (lbase *Logbase) GetKind(name string) (*Node, bool, error) {
return lbase.NewNode(name, LBTYPE_KIND, false)
}
// Document.
// Create a Document instance, and retrieve the logbase data for it if it exists.
func (lbase *Logbase) Doc(name string) (*Node, bool, error) {
return lbase.NewNode(name, LBTYPE_DOC, true)
}
// Retrieve the Doc if it exists.
func (lbase *Logbase) GetDoc(name string) (*Node, bool, error) {
return lbase.NewNode(name, LBTYPE_DOC, false)
}
// Fields.
func NewField() *Field {
return &Field{
Vtype: &Vtype{},
Vdata: &Vdata{},
}
}
func MakeField(vbyts []byte, vtype LBTYPE) *Field {
return &Field{
Vtype: &Vtype{vtype},
Vdata: &Vdata{vbyts},
}
}
func NewFieldMap() *FieldMap {
return &FieldMap{
fields: make(map[string]*Field),
}
}
func (node *Node) SetFieldWithType(label string, val interface{}, vtype LBTYPE) *Node {
vbyts, err := ToBytes(val, vtype, node.debug)
if err != nil {
node.debug.Error(FmtErrBadType(
"Attempt to set field %q to %v using LBTYPE %v for node %q, " +
"nothing done",
label, val, vtype, node.Name()))
return node
}
fold, exists := node.fields[label]
fnew := MakeField(vbyts, vtype)
if exists {
node.debug.Fine("Replacing old field %v with %v", fold, fnew)
} else {
node.debug.Fine("Creating new field %v", fnew)
}
node.fields[label] = fnew
return node
}
func (fmap *FieldMap) ToBytes(debug *gubed.Logger) []byte {
bfr := new(bytes.Buffer)
var vsz LBUINT
var lbyts []byte
for label, field := range fmap.fields {
lbyts = []byte(label)
binary.Write(bfr, BIGEND, AsLBUINT(len(lbyts))) // label size
bfr.Write(lbyts) // label
vsz = AsLBUINT(len(field.vbyts)) + LBUINT(LBTYPE_SIZE)
binary.Write(bfr, BIGEND, vsz) // value size, including LBTYPE
binary.Write(bfr, BIGEND, field.vtype) // LBTYPE
bfr.Write(field.vbyts) // value
}
return bfr.Bytes()
}
func (fmap *FieldMap) FromBytes(bfr *bytes.Buffer, debug *gubed.Logger) (err error) {
var size LBUINT
var label string
var vtype LBTYPE
var bits []byte
for bfr.Len() > 0 {
err = debug.DecodeError(binary.Read(bfr, BIGEND, &size)) // label size
if err == io.EOF {break} else {if err != nil {return}}
bits = make([]byte, int(size))
err = debug.DecodeError(binary.Read(bfr, BIGEND, &bits))
if err == io.EOF {break} else {if err != nil {return}}
label = string(bits) // label
err = debug.DecodeError(binary.Read(bfr, BIGEND, &size)) // value size
if err == io.EOF {break} else {if err != nil {return}}
bits = make([]byte, int(size) - LBTYPE_SIZE)
err = debug.DecodeError(binary.Read(bfr, BIGEND, &vtype)) // LBTYPE
if err == io.EOF {break} else {if err != nil {return}}
err = debug.DecodeError(binary.Read(bfr, BIGEND, &bits))
fmap.fields[label] = MakeField(bits, vtype)
if err == io.EOF {break} else {if err != nil {return}}
}
return
}
func (field *Field) String() string {
return fmt.Sprintf("%d,%s",
field.vtype,
ValBytesToString(field.vbyts, field.vtype))
}
func (fmap *FieldMap) String() string {
result := "{"
first := true
for label, field := range fmap.fields {
if !first {result += ","; first = false}
result += fmt.Sprintf("%q:(%s)", label, field.String())
}
return result + "}"
}
// Find.
func GetNodeNameType(key interface{}) (string, LBTYPE) {
if k, ok := key.(string); ok {
for prefix, ntype := range NodeKeyPrefix { // note prefix includes separator
if strings.HasPrefix(k, prefix) {
basename := strings.TrimPrefix(k, prefix)
return basename, ntype
}
}
}
return "", LBTYPE_NIL
}
func (lbase *Logbase) FindOfKind(name string, ntype LBTYPE) []*Node {
var result []*Node
kind, exists, err := lbase.NewNode(name, LBTYPE_KIND, false)
if err != nil {
lbase.debug.Error(err)
return nil
}
if !exists {
lbase.debug.Error(
FmtErrKeyNotFound(NormaliseNodeName(name, LBTYPE_KIND)))
return nil
}
var basename string
var typ LBTYPE
for key, _ := range lbase.mcat.index {
basename, typ = GetNodeNameType(key)
if typ == ntype {
node, _, err := lbase.NewNode(basename, ntype, true)
lbase.debug.Error(err)
if err == nil && node.Parents().Contains(kind.CATID()) {
result = append(result, node)
}
}
}
return result
}
func (lbase *Logbase) FindKindOfKind(name string) []*Node {
return lbase.FindOfKind(name, LBTYPE_KIND)
}
func (lbase *Logbase) FindDocOfKind(name string) []*Node {
return lbase.FindOfKind(name, LBTYPE_DOC)
}
func (lbase *Logbase) AsCatalog(nodes []*Node) *Catalog {
if len(nodes) == 0 {return nil}
cat := MakeQueryCatalog(lbase.debug)
for _, node := range nodes {
cat.Put(node.name, node.mcr_name)
cat.Put(node.cid.id, node.mcr_id)
}
return cat
}