File: keywords.go

package info (click to toggle)
golang-github-vbatts-go-mtree 0.4.2-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 656 kB
  • sloc: sh: 150; makefile: 61
file content (327 lines) | stat: -rw-r--r-- 8,255 bytes parent folder | download | duplicates (2)
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
package mtree

import (
	"fmt"
	"strings"

	"github.com/vbatts/go-mtree/pkg/govis"
)

// DefaultVisFlags is the set of Vis flags used when encoding filenames and
// other similar entries.
const DefaultVisFlags govis.VisFlag = govis.VisWhite | govis.VisOctal | govis.VisGlob

// Keyword is the string name of a keyword, with some convenience functions for
// determining whether it is a default or bsd standard keyword.
// It first portion before the "="
type Keyword string

// Prefix is the portion of the keyword before a first "." (if present).
//
// Primarly for the xattr use-case, where the keyword `xattr.security.selinux` would have a Suffix of `security.selinux`.
func (k Keyword) Prefix() Keyword {
	if strings.Contains(string(k), ".") {
		return Keyword(strings.SplitN(string(k), ".", 2)[0])
	}
	return k
}

// Suffix is the portion of the keyword after a first ".".
// This is an option feature.
//
// Primarly for the xattr use-case, where the keyword `xattr.security.selinux` would have a Suffix of `security.selinux`.
func (k Keyword) Suffix() string {
	if strings.Contains(string(k), ".") {
		return strings.SplitN(string(k), ".", 2)[1]
	}
	return string(k)
}

// Default returns whether this keyword is in the default set of keywords
func (k Keyword) Default() bool {
	return InKeywordSlice(k, DefaultKeywords)
}

// Bsd returns whether this keyword is in the upstream FreeBSD mtree(8)
func (k Keyword) Bsd() bool {
	return InKeywordSlice(k, BsdKeywords)
}

// Synonym returns the canonical name for this keyword. This is provides the
// same functionality as KeywordSynonym()
func (k Keyword) Synonym() Keyword {
	return KeywordSynonym(string(k))
}

// InKeywordSlice checks for the presence of `a` in `list`
func InKeywordSlice(a Keyword, list []Keyword) bool {
	for _, b := range list {
		if b == a {
			return true
		}
	}
	return false
}
func inKeyValSlice(a KeyVal, list []KeyVal) bool {
	for _, b := range list {
		if b == a {
			return true
		}
	}
	return false
}

// ToKeywords makes a list of Keyword from a list of string
func ToKeywords(list []string) []Keyword {
	ret := make([]Keyword, len(list))
	for i := range list {
		ret[i] = Keyword(list[i])
	}
	return ret
}

// FromKeywords makes a list of string from a list of Keyword
func FromKeywords(list []Keyword) []string {
	ret := make([]string, len(list))
	for i := range list {
		ret[i] = string(list[i])
	}
	return ret
}

// KeyValToString constructs a list of string from the list of KeyVal
func KeyValToString(list []KeyVal) []string {
	ret := make([]string, len(list))
	for i := range list {
		ret[i] = string(list[i])
	}
	return ret
}

// StringToKeyVals constructs a list of KeyVal from the list of strings, like "keyword=value"
func StringToKeyVals(list []string) []KeyVal {
	ret := make([]KeyVal, len(list))
	for i := range list {
		ret[i] = KeyVal(list[i])
	}
	return ret
}

// KeyVal is a "keyword=value"
type KeyVal string

// Keyword is the mapping to the available keywords
func (kv KeyVal) Keyword() Keyword {
	if !strings.Contains(string(kv), "=") {
		return Keyword("")
	}
	return Keyword(strings.SplitN(strings.TrimSpace(string(kv)), "=", 2)[0])
}

// Value is the data/value portion of "keyword=value"
func (kv KeyVal) Value() string {
	if !strings.Contains(string(kv), "=") {
		return ""
	}
	return strings.SplitN(strings.TrimSpace(string(kv)), "=", 2)[1]
}

// NewValue returns a new KeyVal with the newval
func (kv KeyVal) NewValue(newval string) KeyVal {
	return KeyVal(fmt.Sprintf("%s=%s", kv.Keyword(), newval))
}

// Equal returns whether two KeyVal are equivalent. This takes
// care of certain odd cases such as tar_mtime, and should be used over
// using == comparisons directly unless you really know what you're
// doing.
func (kv KeyVal) Equal(b KeyVal) bool {
	// TODO: Implement handling of tar_mtime.
	return kv.Keyword() == b.Keyword() && kv.Value() == b.Value()
}

func keywordPrefixes(kvset []Keyword) []Keyword {
	kvs := []Keyword{}
	for _, kv := range kvset {
		kvs = append(kvs, kv.Prefix())
	}
	return kvs
}

// keyvalSelector takes an array of KeyVal ("keyword=value") and filters out
// that only the set of keywords
func keyvalSelector(keyval []KeyVal, keyset []Keyword) []KeyVal {
	retList := []KeyVal{}
	for _, kv := range keyval {
		if InKeywordSlice(kv.Keyword().Prefix(), keywordPrefixes(keyset)) {
			retList = append(retList, kv)
		}
	}
	return retList
}

func keyValDifference(this, that []KeyVal) []KeyVal {
	if len(this) == 0 {
		return that
	}
	diff := []KeyVal{}
	for _, kv := range this {
		if !inKeyValSlice(kv, that) {
			diff = append(diff, kv)
		}
	}
	return diff
}
func keyValCopy(set []KeyVal) []KeyVal {
	ret := make([]KeyVal, len(set))
	for i := range set {
		ret[i] = set[i]
	}
	return ret
}

// Has the "keyword" present in the list of KeyVal, and returns the
// corresponding KeyVal, else an empty string.
func Has(keyvals []KeyVal, keyword string) []KeyVal {
	return HasKeyword(keyvals, Keyword(keyword))
}

// HasKeyword the "keyword" present in the list of KeyVal, and returns the
// corresponding KeyVal, else an empty string.
// This match is done on the Prefix of the keyword only.
func HasKeyword(keyvals []KeyVal, keyword Keyword) []KeyVal {
	kvs := []KeyVal{}
	for i := range keyvals {
		if keyvals[i].Keyword().Prefix() == keyword.Prefix() {
			kvs = append(kvs, keyvals[i])
		}
	}
	return kvs
}

// MergeSet takes the current setKeyVals, and then applies the entryKeyVals
// such that the entry's values win. The union is returned.
func MergeSet(setKeyVals, entryKeyVals []string) []KeyVal {
	retList := StringToKeyVals(setKeyVals)
	eKVs := StringToKeyVals(entryKeyVals)
	return MergeKeyValSet(retList, eKVs)
}

// MergeKeyValSet does a merge of the two sets of KeyVal, and the KeyVal of
// entryKeyVals win when there is a duplicate Keyword.
func MergeKeyValSet(setKeyVals, entryKeyVals []KeyVal) []KeyVal {
	retList := keyValCopy(setKeyVals)
	seenKeywords := []Keyword{}
	for i := range retList {
		word := retList[i].Keyword()
		for _, kv := range HasKeyword(entryKeyVals, word) {
			// match on the keyword prefix and suffix here
			if kv.Keyword() == word {
				retList[i] = kv
			}
		}
		seenKeywords = append(seenKeywords, word)
	}
	for i := range entryKeyVals {
		if !InKeywordSlice(entryKeyVals[i].Keyword(), seenKeywords) {
			retList = append(retList, entryKeyVals[i])
		}
	}
	return retList
}

var (
	// DefaultKeywords has the several default keyword producers (uid, gid,
	// mode, nlink, type, size, mtime)
	DefaultKeywords = []Keyword{
		"size",
		"type",
		"uid",
		"gid",
		"mode",
		"link",
		"nlink",
		"time",
	}

	// DefaultTarKeywords has keywords that should be used when creating a manifest from
	// an archive. Currently, evaluating the # of hardlinks has not been implemented yet
	DefaultTarKeywords = []Keyword{
		"size",
		"type",
		"uid",
		"gid",
		"mode",
		"link",
		"tar_time",
	}

	// BsdKeywords is the set of keywords that is only in the upstream FreeBSD mtree
	BsdKeywords = []Keyword{
		"cksum",
		"flags", // this one is really mostly BSD specific ...
		"ignore",
		"gid",
		"gname",
		"link",
		"md5",
		"md5digest",
		"mode",
		"nlink",
		"nochange",
		"optional",
		"ripemd160digest",
		"rmd160",
		"rmd160digest",
		"sha1",
		"sha1digest",
		"sha256",
		"sha256digest",
		"sha384",
		"sha384digest",
		"sha512",
		"sha512digest",
		"size",
		"tags",
		"time",
		"type",
		"uid",
		"uname",
	}

	// SetKeywords is the default set of keywords calculated for a `/set` SpecialType
	SetKeywords = []Keyword{
		"uid",
		"gid",
	}
)

// KeywordSynonym returns the canonical name for keywords that have synonyms,
// and just returns the name provided if there is no synonym. In this way it
// ought to be safe to wrap any keyword name.
func KeywordSynonym(name string) Keyword {
	var retname string
	switch name {
	case "md5":
		retname = "md5digest"
	case "rmd160":
		retname = "ripemd160digest"
	case "rmd160digest":
		retname = "ripemd160digest"
	case "sha1":
		retname = "sha1digest"
	case "sha256":
		retname = "sha256digest"
	case "sha384":
		retname = "sha384digest"
	case "sha512":
		retname = "sha512digest"
	case "sha512256":
		retname = "sha512256digest"
	case "xattrs":
		retname = "xattr"
	default:
		retname = name
	}
	return Keyword(retname)
}