File: keyfile.go

package info (click to toggle)
go-dlib 5.6.0.9%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,200 kB
  • sloc: ansic: 4,664; xml: 1,456; makefile: 20; sh: 15
file content (259 lines) | stat: -rw-r--r-- 5,833 bytes parent folder | download | duplicates (3)
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
/*
 * Copyright (C) 2017 ~ 2018 Deepin Technology Co., Ltd.
 *
 * Author:     jouyouyun <jouyouwen717@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package keyfile

import (
	"fmt"
	"regexp"
	"sync"
)

var LineBreak = "\n"

type KeyFile struct {
	mutex  sync.RWMutex
	keyReg *regexp.Regexp
	data   map[string]map[string]string // section -> key : value

	sectionList []string            // section name list
	keyList     map[string][]string // section -> key name list

	sectionComments map[string]string
	keyComments     map[string]map[string]string // keys comments.
	ListSeparator   byte
}

func NewKeyFile() *KeyFile {
	f := &KeyFile{
		data:            make(map[string]map[string]string),
		keyList:         make(map[string][]string),
		sectionComments: make(map[string]string),
		keyComments:     make(map[string]map[string]string),
		ListSeparator:   ';',
	}
	return f
}

func (f *KeyFile) SetKeyRegexp(keyReg *regexp.Regexp) {
	f.keyReg = keyReg
}

// it returns true if the key and value were inserted
// or return false if the value was overwritten.
func (f *KeyFile) SetValue(section, key, value string) bool {
	if section == "" || key == "" {
		return false
	}

	if f.keyReg != nil &&
		!f.keyReg.MatchString(key) {
		return false
	}

	f.mutex.Lock()
	defer f.mutex.Unlock()

	// Check if section exists
	if _, ok := f.data[section]; !ok {
		f.data[section] = make(map[string]string)
		f.sectionList = append(f.sectionList, section)
	}

	// check if key exists
	_, ok := f.data[section][key]
	f.data[section][key] = value
	if !ok {
		f.keyList[section] = append(f.keyList[section], key)
	}
	return !ok
}

func (f *KeyFile) DeleteKey(section, key string) bool {
	f.mutex.Lock()
	defer f.mutex.Unlock()

	// Check if section exists
	if _, ok := f.data[section]; !ok {
		return false
	}

	// Check if key exists
	if _, ok := f.data[section][key]; ok {
		delete(f.data[section], key)
		f.SetKeyComments(section, key, "")
		i := 0
		for _, keyName := range f.keyList[section] {
			if keyName == key {
				break
			}
			i++
		}
		// Remove from key list
		keyList := f.keyList[section]
		f.keyList[section] = append(keyList[:i], keyList[i+1:]...)
		return true
	}
	return false
}

func (f *KeyFile) GetValue(section, key string) (string, error) {
	f.mutex.RLock()
	defer f.mutex.RUnlock()

	// Check if section exists
	if _, ok := f.data[section]; !ok {
		return "", SectionNotFoundError{section}
	}

	// Section exists
	// Check if key exists or empty value
	value, ok := f.data[section][key]
	if !ok {
		return "", KeyNotFoundError{key}
	}

	// Key exists
	return value, nil
}

func (f *KeyFile) GetBool(section, key string) (bool, error) {
	value, err := f.GetValue(section, key)
	if err != nil {
		return false, err
	}

	return parseValueAsBool(value)
}

func (f *KeyFile) GetSections() []string {
	return f.sectionList
}

func (f *KeyFile) GetKeys(section string) []string {
	if _, ok := f.data[section]; !ok {
		// Section not exists
		return nil
	}
	return f.keyList[section]
}

// It returns true if the section was deleted, and false if the section didn't exist
func (f *KeyFile) DeleteSection(section string) bool {
	if _, ok := f.data[section]; !ok {
		return false
	}

	delete(f.data, section)
	f.SetSectionComments(section, "")

	// Remove from sectionList
	i := 0
	for _, secName := range f.sectionList {
		if secName == section {
			break
		}
		i++
	}
	f.sectionList = append(f.sectionList[:i], f.sectionList[i+1:]...)
	delete(f.keyList, section)
	delete(f.keyComments, section)
	return true
}

func (f *KeyFile) GetSection(section string) (map[string]string, error) {
	if _, ok := f.data[section]; !ok {
		return nil, SectionNotFoundError{section}
	}

	secMap := f.data[section]
	return secMap, nil
}

func (f *KeyFile) SetSectionComments(section, comments string) bool {
	if len(comments) == 0 {
		delete(f.sectionComments, section)
		return true
	}

	// Check if comment exists
	_, ok := f.sectionComments[section]
	if comments[0] != '#' {
		comments = "# " + comments
	}
	f.sectionComments[section] = comments
	return !ok
}

func (f *KeyFile) SetKeyComments(section, key, comments string) bool {
	if _, ok := f.keyComments[section]; ok {
		if len(comments) == 0 {
			delete(f.keyComments[section], key)
			return true
		}
	} else {
		if len(comments) == 0 {
			return true
		} else {
			f.keyComments[section] = make(map[string]string)
		}
	}

	_, ok := f.keyComments[section][key]
	if comments[0] != '#' {
		comments = "# " + comments
	}
	f.keyComments[section][key] = comments
	return !ok
}

func (f *KeyFile) GetSectionComments(section string) string {
	return f.sectionComments[section]
}

func (f *KeyFile) GetKeyComments(section, key string) string {
	if _, ok := f.keyComments[section]; ok {
		return f.keyComments[section][key]
	}
	return ""
}

type SectionNotFoundError struct {
	Name string
}

func (err SectionNotFoundError) Error() string {
	return fmt.Sprintf("section %q not found", err.Name)
}

type KeyNotFoundError struct {
	Name string
}

func (err KeyNotFoundError) Error() string {
	return fmt.Sprintf("key %q not found", err.Name)
}

type InvalidValueError struct {
	Value string
}

func (err InvalidValueError) Error() string {
	return fmt.Sprintf("value %q is invalid", err.Value)
}