summaryrefslogtreecommitdiffstats
path: root/lib/xdsconfig/fileconfig.go
blob: ee9ca147413b2c0c2e5dc86396d82cef50ba641d (plain)
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
/*
 * Copyright (C) 2017 "IoT.bzh"
 * Author Sebastien Douheret <sebastien@iot.bzh>
 *
 * 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 xdsconfig

import (
	"encoding/json"
	"os"
	"os/user"
	"path"
	"path/filepath"
	"strings"

	common "github.com/iotbzh/xds-common/golib"
)

const (
	// ConfigDir Directory in user HOME directory where xds config will be saved
	ConfigDir = ".xds-server"
	// GlobalConfigFilename Global config filename
	GlobalConfigFilename = "config.json"
	// ServerDataFilename Server data filename
	ServerDataFilename = "server-data.xml"
	// FoldersConfigFilename Folders config filename
	FoldersConfigFilename = "server-config_folders.xml"
)

// SyncThingConf definition
type SyncThingConf struct {
	BinDir          string `json:"binDir"`
	Home            string `json:"home"`
	GuiAddress      string `json:"gui-address"`
	GuiAPIKey       string `json:"gui-apikey"`
	RescanIntervalS int    `json:"rescanIntervalS"`
}

// FileConfig is the JSON structure of xds-server config file (config.json)
type FileConfig struct {
	WebAppDir    string         `json:"webAppDir"`
	ShareRootDir string         `json:"shareRootDir"`
	SdkRootDir   string         `json:"sdkRootDir"`
	HTTPPort     string         `json:"httpPort"`
	SThgConf     *SyncThingConf `json:"syncthing"`
	LogsDir      string         `json:"logsDir"`
}

// readGlobalConfig reads configuration from a config file.
// Order to determine which config file is used:
//  1/ from command line option: "--config myConfig.json"
//  2/ $HOME/.xds-server/config.json file
//  3/ /etc/xds-server/config.json file
//  4/ <xds-server executable dir>/config.json file
func readGlobalConfig(c *Config, confFile string) error {

	searchIn := make([]string, 0, 3)
	if confFile != "" {
		searchIn = append(searchIn, confFile)
	}
	if usr, err := user.Current(); err == nil {
		searchIn = append(searchIn, path.Join(usr.HomeDir, ConfigDir,
			GlobalConfigFilename))
	}

	searchIn = append(searchIn, "/etc/xds-server/config.json")

	exePath := os.Args[0]
	ee, _ := os.Executable()
	exeAbsPath, err := filepath.Abs(ee)
	if err == nil {
		exePath, err = filepath.EvalSymlinks(exeAbsPath)
		if err == nil {
			exePath = filepath.Dir(ee)
		} else {
			exePath = filepath.Dir(exeAbsPath)
		}
	}
	searchIn = append(searchIn, path.Join(exePath, "config.json"))

	var cFile *string
	for _, p := range searchIn {
		if _, err := os.Stat(p); err == nil {
			cFile = &p
			break
		}
	}
	if cFile == nil {
		// No config file found
		return nil
	}
	c.Log.Infof("Use config file:       %s", *cFile)

	// TODO move on viper package to support comments in JSON and also
	// bind with flags (command line options)
	// see https://github.com/spf13/viper#working-with-flags
	fd, _ := os.Open(*cFile)
	defer fd.Close()
	fCfg := FileConfig{}
	if err := json.NewDecoder(fd).Decode(&fCfg); err != nil {
		return err
	}

	// Support environment variables (IOW ${MY_ENV_VAR} syntax) in config.json
	vars := []*string{
		&fCfg.WebAppDir,
		&fCfg.ShareRootDir,
		&fCfg.SdkRootDir,
		&fCfg.LogsDir}
	if fCfg.SThgConf != nil {
		vars = append(vars, &fCfg.SThgConf.Home, &fCfg.SThgConf.BinDir)
	}
	for _, field := range vars {
		var err error
		if *field, err = common.ResolveEnvVar(*field); err != nil {
			return err
		}
	}

	// Use config file settings else use default config
	if fCfg.WebAppDir == "" {
		fCfg.WebAppDir = c.FileConf.WebAppDir
	}
	if fCfg.ShareRootDir == "" {
		fCfg.ShareRootDir = c.FileConf.ShareRootDir
	}
	if fCfg.SdkRootDir == "" {
		fCfg.SdkRootDir = c.FileConf.SdkRootDir
	}
	if fCfg.HTTPPort == "" {
		fCfg.HTTPPort = c.FileConf.HTTPPort
	}
	if fCfg.LogsDir == "" {
		fCfg.LogsDir = c.FileConf.LogsDir
	}

	// Resolve webapp dir (support relative or full path)
	fCfg.WebAppDir = strings.Trim(fCfg.WebAppDir, " ")
	if !strings.HasPrefix(fCfg.WebAppDir, "/") && exePath != "" {
		cwd, _ := os.Getwd()

		// Check first from current directory
		for _, rootD := range []string{exePath, cwd} {
			ff := path.Join(rootD, fCfg.WebAppDir, "index.html")
			if common.Exists(ff) {
				fCfg.WebAppDir = path.Join(rootD, fCfg.WebAppDir)
				break
			}
		}
	}

	c.FileConf = fCfg
	return nil
}

func configFilenameGet(cfgFile string) (string, error) {
	usr, err := user.Current()
	if err != nil {
		return "", err
	}
	return path.Join(usr.HomeDir, ConfigDir, cfgFile), nil
}

// FoldersConfigFilenameGet
func FoldersConfigFilenameGet() (string, error) {
	return configFilenameGet(FoldersConfigFilename)
}

// ServerDataFilenameGet
func ServerDataFilenameGet() (string, error) {
	return configFilenameGet(ServerDataFilename)
}