-
Notifications
You must be signed in to change notification settings - Fork 69
/
json.go
418 lines (393 loc) · 12.6 KB
/
json.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
package config
/*
Copyright 2013 Am Laher
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.
*/
import (
"encoding/json"
"errors"
"io/ioutil"
"log"
"os"
"path/filepath"
"github.com/socketplane/socketplane/Godeps/_workspace/src/github.com/laher/goxc/core"
"github.com/socketplane/socketplane/Godeps/_workspace/src/github.com/laher/goxc/typeutils"
)
const (
GOXC_CONFIG_VERSION = "0.9"
)
var GOXC_CONFIG_SUPPORTED = []string{"0.5.0", "0.6", "0.8", "0.9"}
//0.6 REMOVED JsonSettings struct.
//Loads a config file and merges results with any 'override' files.
//0.8 using new inheritance rules. More flexibility, particular for people wanting different rules for different platforms
//0.10.x adding parameter isWriteLocal
func LoadJsonConfigOverrideable(dir string, configName string, isRead, isWriteLocal, verbose bool) (Settings, error) {
var configs []string
if isRead {
configs = []string{configName + core.GOXC_LOCAL_FILE_EXT, configName + core.GOXC_FILE_EXT,
core.GOXC_CONFIGNAME_BASE + core.GOXC_LOCAL_FILE_EXT,
core.GOXC_CONFIGNAME_BASE + core.GOXC_FILE_EXT}
} else {
if isWriteLocal {
configs = []string{configName + core.GOXC_LOCAL_FILE_EXT}
} else {
configs = []string{configName + core.GOXC_FILE_EXT}
}
}
return LoadJsonConfigs(dir, configs, verbose)
}
func LoadJsonConfigs(dir string, configs []string, verbose bool) (Settings, error) {
//most-important first
mergedSettingsMap := map[string]interface{}{}
for _, jsonFile := range configs {
settingsMap, err := loadJsonFileAsMap(jsonFile, verbose)
if err != nil {
if os.IsNotExist(err) {
//continue onto next file
} else {
//parse error. Stop right there.
return Settings{}, err
}
} else {
mergedSettingsMap = typeutils.MergeMaps(mergedSettingsMap, settingsMap)
}
}
return loadSettingsSection(mergedSettingsMap)
}
//0.5.6 provide more detail about errors (syntax errors for now)
func printErrorDetails(rawJson []byte, err error) {
switch typedErr := err.(type) {
case *json.SyntaxError:
lineNumber := 1
colNumber := 0
for i, b := range rawJson {
if int64(i) == typedErr.Offset {
log.Printf("JSON syntax error on line %d, column %d", lineNumber, colNumber)
return
}
if b == '\n' {
lineNumber = lineNumber + 1
colNumber = 0
} else {
colNumber = colNumber + 1
}
}
}
}
func validateRawJson(rawJson []byte, fileName string) []error {
var f interface{}
err := json.Unmarshal(rawJson, &f)
if err != nil {
log.Printf("ERROR (%s): invalid json!", fileName)
printErrorDetails(rawJson, err)
return []error{err}
}
var errs []error
m := f.(map[string]interface{})
rejectOldTaskDefinitions := false
//it was known as 'FormatVersion' until v0.9
if fv, keyExists := m["FormatVersion"]; keyExists {
m["ConfigVersion"] = fv
}
if fv, keyExists := m["ConfigVersion"]; keyExists {
configVersion := fv.(string)
if -1 == typeutils.StringSlicePos(GOXC_CONFIG_SUPPORTED, configVersion) {
log.Printf("WARNING (%s): is an old config file. File version: %s. Current version %v", fileName, configVersion, GOXC_CONFIG_VERSION)
rejectOldTaskDefinitions = true
}
} else {
log.Printf("WARNING (%s): format version not specified. Please ensure this file format is up to date.", fileName)
rejectOldTaskDefinitions = true
}
if s, keyExists := m["Settings"]; keyExists {
settings := s.(map[string]interface{})
errs = validateSettingsSection(settings, fileName, rejectOldTaskDefinitions)
} else {
errs = validateSettingsSection(m, fileName, rejectOldTaskDefinitions)
}
return errs
}
func validateSettingsSection(settings map[string]interface{}, fileName string, rejectOldTaskDefinitions bool) (errs []error) {
if _, keyExists := settings["ArtifactTypes"]; keyExists {
msg := "'ArtifactTypes' setting is deprecated. Please use tasks instead (By default goxc zips the binary ('archive' task) and then deletes the binary ('rmbin' task)."
log.Printf("ERROR (%s): %s", fileName, msg)
errs = append(errs, errors.New(msg))
}
if _, keyExists := settings["Codesign"]; keyExists {
msg := "'Codesign' setting is deprecated. Please use setting \"Settings\" : { \"TaskSettings\" : { \"codesign\" : { \"id\" : \"blah\" } } }."
log.Printf("ERROR (%s): %s", fileName, msg)
errs = append(errs, errors.New(msg))
}
if rejectOldTaskDefinitions {
if val, keyExists := settings["Tasks"]; keyExists {
valArr := val.([]interface{})
if len(valArr) == 1 && valArr[0] == core.TASK_BUILD_TOOLCHAIN {
//build-toolchain hasn't changed. Continue.
} else {
msg := "task definitions have changed in version 0.5.0. Please refer to latest docs and update your config file to version 0.5.0 accordingly."
log.Printf("ERROR (%s): %s", fileName, msg)
errs = append(errs, errors.New(msg))
}
}
}
return errs
}
func loadFile(jsonFile string, verbose bool) ([]byte, error) {
file, err := ioutil.ReadFile(jsonFile)
if err != nil {
if os.IsNotExist(err) {
if verbose { //not a problem.
log.Printf("%s not found", jsonFile)
}
} else {
//always log because it's unexpected
log.Printf("File error: %v", err)
}
} else {
if verbose {
log.Printf("Found %s", jsonFile)
}
}
return file, err
}
func loadJsonFileAsMap(jsonFile string, verbose bool) (map[string]interface{}, error) {
var f map[string]interface{}
rawJson, err := loadFile(jsonFile, verbose)
if err != nil {
return f, err
}
errs := validateRawJson(rawJson, jsonFile)
if errs != nil && len(errs) > 0 {
return f, errs[0]
}
//TODO: super-verbose option for logging file content? log.Printf("%s\n", string(file))
err = json.Unmarshal(rawJson, &f)
if err != nil {
log.Printf("ERROR (%s): invalid json!", jsonFile)
printErrorDetails(rawJson, err)
} else {
//it was known as FormatVersion until v0.9
if fv, keyExists := f["FormatVersion"]; keyExists {
f["ConfigVersion"] = fv
}
//fill all the way down.
if fv, keyExists := f["ConfigVersion"]; keyExists {
if s, keyExists := f["Settings"]; keyExists {
//Support for old versions, up until version 0.5.
settingsSection, err := typeutils.ToMap(s, "Settings")
if err != nil {
return f, err
} else {
if _, keyExists = settingsSection["ConfigVersion"]; !keyExists {
//set from jsonSettings
//it was previously known as FormatVersion ...
formatVersion, err := typeutils.ToString(fv, "FormatVersion")
if err != nil {
return f, err
}
settingsSection["ConfigVersion"] = formatVersion
}
return settingsSection, err
}
//settings, err := loadSettingsSection(settingsSection)
//return settings, err
}
} else {
return f, errors.New("File format version not specified!")
}
}
return f, err
}
// load json file. Glob for goxc
//0.5.6 parse from an interface{} instead of JsonSettings.
//More flexible & better error reporting possible.
// 0.6.4 deprecated in favour of loadJsonFileAsMap
func loadJsonFile(jsonFile string, verbose bool) (Settings, error) {
m, err := loadJsonFileAsMap(jsonFile, verbose)
if err != nil {
return Settings{}, err
}
return loadSettingsSection(m)
}
func loadSettingsSection(settingsSection map[string]interface{}) (settings Settings, err error) {
settings = Settings{}
for k, v := range settingsSection {
//try to match key
switch k {
case "Tasks":
settings.Tasks, err = typeutils.ToStringSlice(v, k)
case "TasksExclude":
settings.TasksExclude, err = typeutils.ToStringSlice(v, k)
case "TasksAppend":
settings.TasksAppend, err = typeutils.ToStringSlice(v, k)
case "TasksPrepend":
settings.TasksPrepend, err = typeutils.ToStringSlice(v, k)
case "AppName":
settings.AppName, err = typeutils.ToString(v, k)
case "ArtifactsDest":
settings.ArtifactsDest, err = typeutils.ToString(v, k)
case "OutPath":
settings.OutPath, err = typeutils.ToString(v, k)
case "Arch":
settings.Arch, err = typeutils.ToString(v, k)
case "Os":
settings.Os, err = typeutils.ToString(v, k)
case "BuildConstraints":
settings.BuildConstraints, err = typeutils.ToString(v, k)
case "ResourcesInclude":
settings.ResourcesInclude, err = typeutils.ToString(v, k)
case "ResourcesExclude":
settings.ResourcesExclude, err = typeutils.ToString(v, k)
case "MainDirsExclude":
settings.MainDirsExclude, err = typeutils.ToString(v, k)
//deprecated
case "Resources":
for k2, v2 := range v.(map[string]interface{}) {
switch k2 {
case "Include":
settings.ResourcesInclude, err = typeutils.ToString(v2, k+":"+k2)
case "Exclude":
settings.ResourcesExclude, err = typeutils.ToString(v2, k+":"+k2)
}
}
case "PackageVersion":
settings.PackageVersion, err = typeutils.ToString(v, k)
case "BranchName":
settings.BranchName, err = typeutils.ToString(v, k)
case "PrereleaseInfo":
settings.PrereleaseInfo, err = typeutils.ToString(v, k)
case "BuildName":
settings.BuildName, err = typeutils.ToString(v, k)
case "Verbosity":
settings.Verbosity, err = typeutils.ToString(v, k)
case "TaskSettings":
settings.TaskSettings, err = typeutils.ToMapStringMapStringInterface(v, k)
case "FormatVersion":
settings.GoxcConfigVersion, err = typeutils.ToString(v, k)
case "ConfigVersion":
settings.GoxcConfigVersion, err = typeutils.ToString(v, k)
case "BuildSettings":
m, err := typeutils.ToMap(v, k)
if err == nil {
settings.BuildSettings, err = buildSettingsFromMap(m)
if err == nil {
//log.Printf("Parsed build settings OK (%+v)", settings.BuildSettings)
}
}
case "Env":
settings.Env, err = typeutils.ToStringSlice(v, k)
default:
log.Printf("Warning!! Unrecognised Setting '%s' (value %v)", k, v)
}
if err != nil {
return settings, err
}
}
return settings, err
}
func WriteJsonConfig(dir string, settings Settings, configName string, isLocal bool) error {
settings.GoxcConfigVersion = GOXC_CONFIG_VERSION
bs := BuildSettings{}
if settings.BuildSettings != nil && bs.Equals(*settings.BuildSettings) {
settings.BuildSettings = nil
}
if isLocal {
jsonFile := filepath.Join(dir, configName+core.GOXC_LOCAL_FILE_EXT)
return writeJsonFile(settings, jsonFile)
}
jsonFile := filepath.Join(dir, configName+core.GOXC_FILE_EXT)
return writeJsonFile(settings, jsonFile)
}
func writeJsonFile(settings Settings, jsonFile string) error {
data, err := json.MarshalIndent(settings, "", "\t")
if err != nil {
log.Printf("Could NOT marshal json")
return err
}
//0.6 StripEmpties no longer required (use omitempty tag instead)
if settings.IsVerbose() {
log.Printf("Writing file %s", jsonFile)
}
return ioutil.WriteFile(jsonFile, data, 0644)
}
//use json from string
//0.6 DEPRECATED (unused)
func readJson(js []byte) (Settings, error) {
var settings Settings
err := json.Unmarshal(js, &settings)
if err != nil {
log.Printf("Error: %v", err)
}
if settings.IsVerbose() {
log.Printf("Settings: %+v", settings)
}
return settings, err
}
//0.6 DEPRECATED (unused)
func writeJson(m Settings) ([]byte, error) {
return json.MarshalIndent(m, "", "\t")
}
//0.6 DEPRECATED (in favour of omitempty tag)
func StripEmpties(rawJson []byte, verbose bool) ([]byte, error) {
var f interface{}
err := json.Unmarshal(rawJson, &f)
if err != nil {
log.Printf("Warning: invalid json. returning")
return rawJson, err
}
m := f.(map[string]interface{})
ret := make(map[string]interface{})
for k, v := range m {
switch vv := v.(type) {
case string:
if v != "" {
ret[k] = vv
} else {
if verbose {
log.Println("Stripping empty string", k)
}
}
case []interface{}:
if len(vv) > 0 {
ret[k] = vv
} else {
if verbose {
log.Println("Stripping empty array", k)
}
}
case map[string]interface{}:
bytes, err := json.Marshal(vv)
if err != nil {
log.Printf("Error marshalling inner map: %v", err)
return rawJson, err
}
strippedInner, err := StripEmpties(bytes, verbose)
if err != nil {
log.Printf("Error stripping inner map: %v", err)
return rawJson, err
}
var innerf interface{}
err = json.Unmarshal(strippedInner, &innerf)
if err != nil {
log.Printf("Error unmarshalling inner map: %v", err)
return rawJson, err
}
ret[k] = innerf
case nil:
if verbose {
log.Println("Stripping null value", k)
}
default:
ret[k] = vv
}
}
return json.MarshalIndent(ret, "", "\t")
}