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
|
/*
Copyright (c) 2019 Ben Morrison (gbmor)
This file is part of Getwtxt.
Getwtxt 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
(at your option) any later version.
Getwtxt 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 Getwtxt. If not, see <https://www.gnu.org/licenses/>.
*/
package svc // import "git.sr.ht/~gbmor/getwtxt/svc"
import (
"fmt"
"log"
"os"
"path/filepath"
"strings"
"sync"
"time"
"github.com/spf13/viper"
)
var reqLog *log.Logger
// Configuration values are held in an instance of
// this struct.
type Configuration struct {
Mu sync.RWMutex
Port int `yaml:"ListenPort"`
MsgLog string `yaml:"MessageLog"`
ReqLog string `yaml:"RequestLog"`
DBType string `yaml:"DatabaseType"`
DBPath string `yaml:"DatabasePath"`
AssetsDir string `yaml:"AssetsDirectory"`
StaticDir string `yaml:"StaticFilesDirectory"`
AdminPassHash string `yaml:"-"`
StdoutLogging bool `yaml:"StdoutLogging"`
CacheInterval time.Duration `yaml:"StatusFetchInterval"`
DBInterval time.Duration `yaml:"DatabasePushInterval"`
Instance `yaml:"Instance"`
}
// Instance refers to meta data about
// this specific instance of getwtxt
type Instance struct {
Vers string `yaml:"-"`
Name string `yaml:"Instance.SiteName"`
URL string `yaml:"Instance.URL"`
Owner string `yaml:"Instance.OwnerName"`
Mail string `yaml:"Instance.Email"`
Desc string `yaml:"Instance.Description"`
}
// Called on start-up. Initializes everything
// related to configuration values.
func initConfig() {
log.Printf("Loading configuration ...\n")
parseConfigFlag()
setConfigDefaults()
if err := viper.ReadInConfig(); err != nil {
log.Printf("%v\n", err.Error())
log.Printf("Using defaults ...\n")
bindConfig()
return
}
viper.WatchConfig()
viper.OnConfigChange(reInit)
bindConfig()
}
// Registers either stdout or a specified file
// to the default logger, and the same for the
// request logger.
func initLogging() {
confObj.Mu.RLock()
defer confObj.Mu.RUnlock()
if confObj.StdoutLogging {
log.SetOutput(os.Stdout)
reqLog = log.New(os.Stdout, "", log.LstdFlags)
} else {
msgLog, err := os.OpenFile(confObj.MsgLog, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0600)
errLog("Could not open log file: ", err)
reqLogFile, err := os.OpenFile(confObj.ReqLog, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0600)
errLog("Could not open log file: ", err)
// Listen for the signal to close the log file
// in a separate thread. Passing it as an argument
// to prevent race conditions when the config is
// reloaded.
go func(msg *os.File, req *os.File) {
<-closeLog
log.Printf("Closing log files ...\n\n")
errLog("Could not close log file: ", msg.Close())
errLog("Could not close log file: ", req.Close())
}(msgLog, reqLogFile)
log.SetOutput(msgLog)
reqLog = log.New(reqLogFile, "", log.LstdFlags)
}
}
// Default values should a config file
// not be available.
func setConfigDefaults() {
viper.SetDefault("ListenPort", 9001)
viper.SetDefault("MessageLog", "logs/message.log")
viper.SetDefault("RequestLog", "logs/request.log")
viper.SetDefault("DatabasePath", "getwtxt.db")
viper.SetDefault("AssetsDirectory", "assets")
viper.SetDefault("StaticFilesDirectory", "static")
viper.SetDefault("DatabaseType", "leveldb")
viper.SetDefault("StdoutLogging", false)
viper.SetDefault("ReCacheInterval", "1h")
viper.SetDefault("DatabasePushInterval", "5m")
viper.SetDefault("AdminPassword", "please_change_me")
viper.SetDefault("Instance.SiteName", "getwtxt")
viper.SetDefault("Instance.OwnerName", "Anonymous Microblogger")
viper.SetDefault("Instance.Email", "nobody@knows")
viper.SetDefault("Instance.URL", "https://twtxt.example.com")
viper.SetDefault("Instance.Description", "A fast, resilient twtxt registry server written in Go!")
}
// Reads data from the configuration
// flag and acts accordingly.
func parseConfigFlag() {
if *flagConfFile == "" {
viper.SetConfigName("getwtxt")
viper.SetConfigType("yml")
viper.AddConfigPath(".")
viper.AddConfigPath("/usr/local/getwtxt")
viper.AddConfigPath("/etc")
viper.AddConfigPath("/usr/local/etc")
} else {
path, file := filepath.Split(*flagConfFile)
if path == "" {
path = "."
}
filename := strings.Split(file, ".")
viper.SetConfigName(filename[0])
viper.SetConfigType(filename[1])
viper.AddConfigPath(path)
}
}
// Simply goes down the list of fields
// in the confObj instance of &Configuration{},
// assigning values from the config file.
func bindConfig() {
confObj.Mu.Lock()
confObj.Port = viper.GetInt("ListenPort")
confObj.MsgLog = viper.GetString("MessageLog")
confObj.ReqLog = viper.GetString("RequestLog")
confObj.DBType = strings.ToLower(viper.GetString("DatabaseType"))
confObj.DBPath = viper.GetString("DatabasePath")
confObj.AssetsDir = viper.GetString("AssetsDirectory")
confObj.StaticDir = viper.GetString("StaticFilesDirectory")
confObj.StdoutLogging = viper.GetBool("StdoutLogging")
confObj.CacheInterval = viper.GetDuration("StatusFetchInterval")
confObj.DBInterval = viper.GetDuration("DatabasePushInterval")
txtPass := viper.GetString("AdminPassword")
if txtPass == "please_change_me" {
fmt.Println("Please set AdminPassword in getwtxt.yml")
os.Exit(1)
}
passHash, err := HashPass(txtPass)
if err != nil {
errFatal("Failed to hash administrator password: ", err)
}
confObj.AdminPassHash = passHash
confObj.Instance.Vers = Vers
confObj.Instance.Name = viper.GetString("Instance.SiteName")
confObj.Instance.URL = viper.GetString("Instance.URL")
confObj.Instance.Owner = viper.GetString("Instance.OwnerName")
confObj.Instance.Mail = viper.GetString("Instance.Email")
confObj.Instance.Desc = viper.GetString("Instance.Description")
if *flagDBType != "" {
confObj.DBType = *flagDBType
}
if *flagDBPath != "" {
confObj.DBPath = *flagDBPath
}
if *flagAssets != "" {
confObj.AssetsDir = *flagAssets
}
confObj.Mu.Unlock()
announceConfig()
}
// Echoes chosen configuration options on startup and after
// a change in getwtxt.yml is detected.
func announceConfig() {
confObj.Mu.RLock()
defer confObj.Mu.RUnlock()
if confObj.StdoutLogging {
log.Printf("Logging to: stdout\n")
} else {
log.Printf("Logging messages to: %v\n", confObj.MsgLog)
log.Printf("Logging requests to: %v\n", confObj.ReqLog)
}
log.Printf("Using %v database: %v\n", confObj.DBType, confObj.DBPath)
log.Printf("Database push interval: %v\n", confObj.DBInterval)
log.Printf("User status fetch interval: %v\n", confObj.CacheInterval)
log.Printf("Static files directory: %v", confObj.StaticDir)
}
|