-
Notifications
You must be signed in to change notification settings - Fork 25
/
elements.go
624 lines (554 loc) · 17 KB
/
elements.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
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
// Copyright 2015-present, Cyrill @ Schumacher.fm and the CoreStore contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package config
import (
"sort"
"strings"
"github.com/corestoreio/errors"
"github.com/corestoreio/pkg/store/scope"
)
// Type* defines the type of the front end user input/display form
const (
TypeButton FieldType = iota + 1 // must be + 1 because 0 is not set
TypeCustom
TypeLabel
TypeHidden
TypeImage
TypeObscure
TypeMultiselect
TypeSelect
TypeText
TypeTextarea
TypeTime
TypeDuration
TypeZMaximum
)
// FieldType used in constants to define the frontend and input type
type FieldType uint8
const fieldTypeName = "TypeButtonTypeCustomTypeLabelTypeHiddenTypeImageTypeObscureTypeMultiselectTypeSelectTypeTextTypeTextareaTypeTime"
var fieldTypeIndex = [...]uint8{10, 20, 29, 39, 48, 59, 74, 84, 92, 104, 112}
func (i FieldType) String() string {
i--
if i >= FieldType(len(fieldTypeIndex)) {
return "FieldType(?)"
}
hi := fieldTypeIndex[i]
lo := uint8(0)
if i > 0 {
lo = fieldTypeIndex[i-1]
}
return fieldTypeName[lo:hi]
}
// MarshalJSON implements marshaling into a human readable string. @todo UnMarshal
func (i FieldType) MarshalJSON() ([]byte, error) {
return []byte(`"` + strings.ToLower(i.String()[4:]) + `"`), nil
}
// Sections contains a set of Sections. Some nifty helper functions exists.
// Thread safe for reading. A section slice can be used in many goroutines. It
// must remain lock-free.
type Sections []*Section
// Section defines the layout for the configuration section which contains
// groups and fields. Thread safe for reading but not for modifying.
type Section struct {
// ID unique ID and merged with others. 1st part of the path.
ID string
Label string `json:",omitempty"`
// Scopes: bit value eg: showInDefault="1" showInWebsite="1" showInStore="1"
// Scopes can contain multiple Scope but no more than Default, Website and
// Store.
Scopes scope.Perm `json:",omitempty"`
SortOrder int `json:",omitempty"`
// Resource TODO some kind of ACL if someone has the right to view,access and/or modify.
Resource uint `json:",omitempty"`
Groups Groups `json:",omitempty"`
}
// MakeSections wrapper function, for now.
func MakeSections(s ...*Section) Sections {
return Sections(s)
}
// MakeSectionsValidated creates a new validated Sections with a three level
// configuration.
func MakeSectionsValidated(sections ...*Section) (Sections, error) {
ss := MakeSections(sections...)
if err := ss.Validate(); err != nil {
return nil, errors.Wrap(err, "[element] MakeSections.Validate")
}
return ss, nil
}
// MustMakeSectionsValidate same as MakeSectionsValidated but panics on error.
func MustMakeSectionsValidate(sections ...*Section) Sections {
s, err := MakeSectionsValidated(sections...)
if err != nil {
panic(err)
}
return s
}
// MakeSectionsMerged creates a new validated Sections with a three level
// configuration. Before validation, slices are all merged together. Panics if a
// path is redundant. Only use this function if your package elements really has
// duplicated entries.
func MakeSectionsMerged(sections ...*Section) (Sections, error) {
var ss Sections
ss = ss.Merge(sections...)
if err := ss.Validate(); err != nil {
return nil, errors.Wrap(err, "[element] Sections.Validate")
}
return ss, nil
}
// MustMakeSectionsMerged same as MakeSectionsMerged but panics on error.
func MustMakeSectionsMerged(sections ...*Section) Sections {
s, err := MakeSectionsMerged(sections...)
if err != nil {
panic(err)
}
return s
}
// TotalFields calculates the total amount of all fields
func (ss Sections) TotalFields() (fs int) {
for _, s := range ss {
for _, g := range s.Groups {
for range g.Fields {
fs++
}
}
}
return fs
}
// MergeMultiple merges n SectionSlices into the current slice. Behaviour for
// duplicates: Last item wins. Not thread safe.
func (ss Sections) MergeMultiple(sSlices ...Sections) Sections {
for _, sl := range sSlices {
ss = ss.Merge(sl...)
}
return ss
}
// Merge merges n Sections into the current slice. Behaviour for duplicates:
// Last item wins. Not thread safe.
func (ss Sections) Merge(sections ...*Section) Sections {
for _, s := range sections {
ss = ss.merge(s)
}
return ss
}
// Merge copies the data from a Section into this slice. Appends if ID is not
// found in this slice otherwise overrides struct fields if not empty. Not
// thread safe.
func (ss Sections) merge(s *Section) Sections {
cs, idx := ss.Find(s.ID) // cs = current section
if idx < 0 {
ss = append(ss, s)
idx = len(ss) - 1
}
if cs == nil {
cs = new(Section)
}
cs.ID = s.ID
if s.Label != "" {
cs.Label = s.Label
}
if s.Scopes > 0 {
cs.Scopes = s.Scopes
}
if s.SortOrder != 0 {
cs.SortOrder = s.SortOrder
}
if s.Resource > 0 {
cs.Resource = s.Resource
}
cs.Groups = cs.Groups.Merge(s.Groups...)
ss[idx] = cs
return ss
}
// Find returns a Section pointer or -1 if section not found. Route must be a
// single part. E.g. if you have path "a/b/c" route would be in this case "a".
// 2nd return parameter contains the position of the Section within the Sections
// or -1 if not found.
func (ss Sections) Find(id string) (_ *Section, index int) {
for i, s := range ss {
if s.ID == id {
return s, i
}
}
return nil, -1
}
// FindGroup searches for a group using the first two path segments. Route must
// have the format a/b/c. 2nd return parameter contains the position of the
// Group within the GroupSlice of a Section or -1 if not found.
func (ss Sections) FindGroup(r string) (_ *Group, index int) {
p := &Path{
route: Route(r), // TODO fix this once Split has be refactored towards type Route
}
spl, err := p.Split()
if err != nil || len(spl) == 0 {
return nil, -10
}
cs, idx := ss.Find(spl[0])
if idx < 0 {
return nil, -1
}
return cs.Groups.Find(spl[1])
}
// FindField searches for a field using all path segments. Route must have the
// format a/b/c. 2nd return parameter contains the position of the Field within
// the FieldSlice of a Section/Group or -1 if not found.
func (ss Sections) FindField(r string) (_ *Field, index int) {
p := &Path{
route: Route(r), // TODO fix this once Split has be refactored towards type Route
}
spl, err := p.Split()
if err != nil || len(spl) < 3 {
return nil, -10
}
sec, idx := ss.Find(spl[0])
if idx < 0 {
return nil, -1
}
cg, idx := sec.Groups.Find(spl[1])
if idx < 0 {
return nil, -2
}
return cg.Fields.Find(spl[2])
}
// UpdateField searches for a field using all three path segments and updates
// the found field with the new field data. Returns the field position within
// the GroupSlice or a negative index in case a route part can't be found.
func (ss Sections) UpdateField(r string, nf *Field) (index int) {
p := &Path{
route: Route(r), // TODO fix this once Split has be refactored towards type Route
}
spl, err := p.Split()
if err != nil {
return -10
}
sec, sIDX := ss.Find(spl[0])
if sIDX < 0 {
return sIDX
}
cg, gIDX := sec.Groups.Find(spl[1])
if gIDX < 0 {
return gIDX
}
cf, fIDX := cg.Fields.Find(spl[2])
if fIDX < 0 {
return fIDX
}
ss[sIDX].Groups[gIDX].Fields[fIDX] = cf.Update(nf)
return fIDX
}
// Append adds 0..n Section. Not thread safe.
func (ss Sections) Append(s ...*Section) Sections {
return append(ss, s...)
}
// AppendFields adds 0..n *Fields. Path must have at least two path parts like
// a/b more path parts gets ignored. Returns as index the new length of the
// FieldSlice or a negative value on error.
func (ss Sections) AppendFields(r string, fs ...*Field) (_ Sections, index int) {
p := &Path{
route: Route(r), // TODO fix this once Split has be refactored towards type Route
}
spl, err := p.Split()
if err != nil || len(spl) < 3 {
return nil, -10
}
cs, sIDX := ss.Find(spl[0])
if sIDX < 0 {
return ss, sIDX
}
cg, gIDX := cs.Groups.Find(spl[1])
if gIDX < 0 {
return ss, gIDX
}
cg.Fields = cg.Fields.Append(fs...)
ss[sIDX].Groups[gIDX] = cg
return ss, len(ss[sIDX].Groups[gIDX].Fields)
}
// Validate checks for duplicated configuration paths in all three hierarchy
// levels. Error behaviour: NotValid
func (ss Sections) Validate() error {
if len(ss) == 0 {
return nil
}
dups := make(map[string]bool) // pc path checker
var buf strings.Builder
p := new(Path)
for _, s := range ss {
for _, g := range s.Groups {
for _, f := range g.Fields {
buf.WriteString(s.ID)
buf.WriteByte(PathSeparator)
buf.WriteString(g.ID)
buf.WriteByte(PathSeparator)
buf.WriteString(f.ID)
key := buf.String()
if !dups[key] {
dups[key] = true
} else {
return errors.Duplicated.Newf("[config] Within sections the path %q appears two times.", key)
}
if err := p.Parse(key); err != nil {
return errors.WithStack(err)
}
buf.Reset()
}
}
}
return nil
}
// SortAll recursively sorts all slices. Not thread safe.
func (ss Sections) SortAll() Sections {
for _, s := range ss {
for _, g := range s.Groups {
g.Fields.Sort()
}
s.Groups.Sort()
}
return ss.Sort()
}
// Sort convenience helper. Not thread safe.
func (ss Sections) Sort() Sections {
sort.Sort(ss)
return ss
}
func (ss Sections) Len() int {
return len(ss)
}
func (ss Sections) Swap(i, j int) {
ss[i], ss[j] = ss[j], ss[i]
}
func (ss Sections) Less(i, j int) bool {
return ss[i].SortOrder < ss[j].SortOrder
}
///////////////////////////////////////////////////////////////////////////////
// GROUPS
///////////////////////////////////////////////////////////////////////////////
// Groups contains a set of Groups.
type Groups []*Group
// Group defines the layout of a group containing multiple Fields.
type Group struct {
// ID unique ID and merged with others. 2nd part of the path.
ID string
Label string `json:",omitempty"`
Comment string `json:",omitempty"`
// Scopes: bit value eg: showInDefault="1" showInWebsite="1" showInStore="1"
Scopes scope.Perm `json:",omitempty"`
SortOrder int `json:",omitempty"`
HelpURL string `json:",omitempty"`
MoreURL string `json:",omitempty"`
DemoLink string `json:",omitempty"`
Fields Fields `json:",omitempty"`
// Groups Groups @todo see recursive options <xs:element name="group"> in app/code/Magento/Config/etc/system_file.xsd
}
// MakeGroups wrapper function, for now.
func MakeGroups(gs ...*Group) Groups {
return Groups(gs)
}
// Find returns a Group pointer or index -1 if group not found. Route must be a
// single part. E.g. if you have path "a/b/c" route would be in this case "b".
func (gs Groups) Find(id string) (_ *Group, index int) {
for i, g := range gs {
if g.ID != "" && g.ID == id {
return g, i
}
}
return nil, -2
}
// Merge copies the data from a groups into this slice and returns the new
// slice. Appends if ID is not found in this slice otherwise overrides struct
// fields if not empty. Not thread safe.
func (gs Groups) Merge(groups ...*Group) Groups {
for _, g := range groups {
gs = gs.merge(g)
}
return gs
}
func (gs Groups) merge(g *Group) Groups {
cg, idx := gs.Find(g.ID) // cg current group
if idx < 0 {
cg = g
gs = append(gs, cg)
idx = len(gs) - 1
}
if "" != g.Label {
cg.Label = g.Label
}
if "" != g.Comment {
cg.Comment = g.Comment
}
if g.Scopes > 0 {
cg.Scopes = g.Scopes
}
if g.SortOrder != 0 {
cg.SortOrder = g.SortOrder
}
cg.Fields = cg.Fields.Merge(g.Fields...)
gs[idx] = cg
return gs
}
// Sort convenience helper. Not thread safe.
func (gs Groups) Sort() Groups {
sort.Sort(gs)
return gs
}
func (gs Groups) Len() int {
return len(gs)
}
func (gs Groups) Swap(i, j int) {
gs[i], gs[j] = gs[j], gs[i]
}
func (gs Groups) Less(i, j int) bool {
return gs[i].SortOrder < gs[j].SortOrder
}
///////////////////////////////////////////////////////////////////////////////
// FIELDS
///////////////////////////////////////////////////////////////////////////////
// FieldMeta sets meta data for a field into the config.Service object. The meta
// data defines scope access restrictions and default values for different
// scopes.
// Intermediate type for function WithFieldMeta
type FieldMeta struct {
Events [eventMaxCount]observers
// Route defines the route or storage key, e.g.: customer/address/prefix_options
Route string
// WriteScopePerm sets the permission to allow setting values to this route.
// For example WriteScopePerm equals scope.PermStore can be set from
// default, website and store. If you restrict WriteScopePerm to
// scope.PermDefault, the route and its value can only be set from default
// but not from websites or stores. It is only allowed to set WriteScopePerm
// when ScopeID is zero or scope.DefaultTypeID.
WriteScopePerm scope.Perm
// ScopeID defines the scope ID for which a default value is valid. Scope
// type can only contain three scopes (default,websites or stores). ID
// relates to the corresponding website or store ID.
ScopeID scope.TypeID
Default string
DefaultValid bool
// Default sets the default value which gets later parsed into the desired
// final Go type. An empty string means not set or null.
valid bool
}
// Fields contains a set of Fields, the final configuration value.
type Fields []*Field
// Field contains the final path element of a configuration. Includes several
// options.
type Field struct {
// ID unique ID and NOT merged with others. 3rd and final part of the path.
ID string
// ConfigRoute if provided defines the storage path and overwrites the path from
// section.id + group.id + field.id. ConfigRoute can be nil.
ConfigRoute string `json:",omitempty"`
// Type is used for the front end on how to display a Field
Type FieldType `json:",omitempty"`
// Label a short label of the field
Label string `json:",omitempty"`
// Comment can contain HTML
Comment string `json:",omitempty"`
// Tooltip used for frontend and can contain HTML
Tooltip string `json:",omitempty"`
// SortOrder in ascending order
SortOrder int `json:",omitempty"`
// Visible used for configuration settings which are not exposed to the user.
Visible bool `json:",omitempty"`
// CanBeEmpty only used in HTML forms for multiselect fields
CanBeEmpty bool `json:",omitempty"`
// Scopes defines the max allowed scope. Some paths or values can only act
// on default, website or store scope. So perm checks if the provided
// path has a scope equal or lower than defined in perm.
Scopes scope.Perm `json:",omitempty"`
// Default can contain any default config value: float64, int64, string,
// bool. An empty string is equal to NULL. A default gets requests if the
// value for a path cannot be retrieved from Level1 or Level2 storage.
Default string `json:",omitempty"`
}
// MakeFields wrapper to create a new Fields
func MakeFields(fs ...*Field) Fields {
return Fields(fs)
}
// Find returns a Field pointer or index is -1 if field not found. Route must be
// a single part. E.g. if you have path "a/b/c" route would be in this case "c".
// 2nd argument int contains the slice index of the field.
func (fs Fields) Find(id string) (_ *Field, index int) {
for i, f := range fs {
if f.ID != "" && f.ID == id {
return f, i
}
}
return nil, -3
}
// Append adds *Field (variadic) to the Fields. Not thread safe.
func (fs Fields) Append(f ...*Field) Fields {
return append(fs, f...)
}
// Merge copies the data from a Field into this slice and returns the new slice.
// Appends if ID is not found in this slice otherwise overrides struct fields if
// not empty. Not thread safe.
func (fs Fields) Merge(fields ...*Field) Fields {
for _, f := range fields {
fs = fs.merge(f)
}
return fs
}
// merge merges field f into the slice. Appends the field if the Id is new.
func (fs Fields) merge(f *Field) Fields {
cf, idx := fs.Find(f.ID) // cf current field
if idx < 0 {
cf = f
fs = append(fs, cf)
idx = len(fs) - 1
}
fs[idx] = cf.Update(f)
return fs
}
// Sort convenience helper. Not thread safe.
func (fs Fields) Sort() Fields {
sort.Sort(fs)
return fs
}
func (fs Fields) Len() int {
return len(fs)
}
func (fs Fields) Swap(i, j int) {
fs[i], fs[j] = fs[j], fs[i]
}
func (fs Fields) Less(i, j int) bool {
return fs[i].SortOrder < fs[j].SortOrder
}
// Update applies the data from the new Field to the old field and returns the
// updated Field. Only non-empty values will be copied and byte slices gets
// cloned. The returned Field allows modifications.
func (f *Field) Update(new *Field) *Field {
if new.Type > 0 {
f.Type = new.Type
}
if "" != new.Label {
f.Label = new.Label
}
if "" != new.Comment {
f.Comment = new.Comment
}
if "" != new.Tooltip {
f.Tooltip = new.Tooltip
}
if new.Scopes > 0 {
f.Scopes = new.Scopes
}
if new.SortOrder != 0 {
f.SortOrder = new.SortOrder
}
f.Visible = new.Visible
f.CanBeEmpty = new.CanBeEmpty
if new.Default != "" {
f.Default = new.Default
}
return f
}