mirror of https://github.com/muety/wakapi.git
403 lines
13 KiB
Go
403 lines
13 KiB
Go
package config
|
||
|
||
import (
|
||
"encoding/json"
|
||
"flag"
|
||
"fmt"
|
||
"io/ioutil"
|
||
"net/http"
|
||
"os"
|
||
"strings"
|
||
"time"
|
||
|
||
"github.com/emvi/logbuch"
|
||
"github.com/gorilla/securecookie"
|
||
"github.com/jinzhu/configor"
|
||
"github.com/muety/wakapi/data"
|
||
"github.com/muety/wakapi/models"
|
||
"gorm.io/gorm"
|
||
)
|
||
|
||
const (
|
||
defaultConfigPath = "config.yml"
|
||
|
||
SQLDialectMysql = "mysql"
|
||
SQLDialectPostgres = "postgres"
|
||
SQLDialectSqlite = "sqlite3"
|
||
|
||
KeyLatestTotalTime = "latest_total_time"
|
||
KeyLatestTotalUsers = "latest_total_users"
|
||
KeyLastImportImport = "last_import"
|
||
|
||
SimpleDateFormat = "2006-01-02"
|
||
SimpleDateTimeFormat = "2006-01-02 15:04:05"
|
||
|
||
ErrUnauthorized = "401 unauthorized"
|
||
ErrBadRequest = "400 bad request"
|
||
ErrInternalServerError = "500 internal server error"
|
||
)
|
||
|
||
const (
|
||
WakatimeApiUrl = "https://wakatime.com/api/v1"
|
||
WakatimeApiUserUrl = "/users/current"
|
||
WakatimeApiAllTimeUrl = "/users/current/all_time_since_today"
|
||
WakatimeApiHeartbeatsUrl = "/users/current/heartbeats"
|
||
WakatimeApiHeartbeatsBulkUrl = "/users/current/heartbeats.bulk"
|
||
WakatimeApiUserAgentsUrl = "/users/current/user_agents"
|
||
WakatimeApiMachineNamesUrl = "/users/current/machine_names"
|
||
)
|
||
|
||
const (
|
||
MailProviderSmtp = "smtp"
|
||
MailProviderMailWhale = "mailwhale"
|
||
)
|
||
|
||
var emailProviders = []string{
|
||
MailProviderSmtp,
|
||
MailProviderMailWhale,
|
||
}
|
||
|
||
var cfg *Config
|
||
var cFlag = flag.String("config", defaultConfigPath, "config file location")
|
||
var env string
|
||
|
||
type appConfig struct {
|
||
AggregationTime string `yaml:"aggregation_time" default:"02:15" env:"WAKAPI_AGGREGATION_TIME"`
|
||
ReportTimeWeekly string `yaml:"report_time_weekly" default:"fri,18:00" env:"WAKAPI_REPORT_TIME_WEEKLY"`
|
||
ImportBackoffMin int `yaml:"import_backoff_min" default:"5" env:"WAKAPI_IMPORT_BACKOFF_MIN"`
|
||
ImportBatchSize int `yaml:"import_batch_size" default:"50" env:"WAKAPI_IMPORT_BATCH_SIZE"`
|
||
InactiveDays int `yaml:"inactive_days" default:"7" env:"WAKAPI_INACTIVE_DAYS"`
|
||
CountCacheTTLMin int `yaml:"count_cache_ttl_min" default:"30" env:"WAKAPI_COUNT_CACHE_TTL_MIN"`
|
||
AvatarURLTemplate string `yaml:"avatar_url_template" default:"https://avatars.dicebear.com/api/pixel-art-neutral/{username_hash}.svg"`
|
||
CustomLanguages map[string]string `yaml:"custom_languages"`
|
||
Colors map[string]map[string]string `yaml:"-"`
|
||
}
|
||
|
||
type securityConfig struct {
|
||
AllowSignup bool `yaml:"allow_signup" default:"true" env:"WAKAPI_ALLOW_SIGNUP"`
|
||
ExposeMetrics bool `yaml:"expose_metrics" default:"false" env:"WAKAPI_EXPOSE_METRICS"`
|
||
EnableProxy bool `yaml:"enable_proxy" default:"false" env:"WAKAPI_ENABLE_PROXY"` // only intended for production instance at wakapi.dev
|
||
// this is actually a pepper (https://en.wikipedia.org/wiki/Pepper_(cryptography))
|
||
PasswordSalt string `yaml:"password_salt" default:"" env:"WAKAPI_PASSWORD_SALT"`
|
||
InsecureCookies bool `yaml:"insecure_cookies" default:"false" env:"WAKAPI_INSECURE_COOKIES"`
|
||
CookieMaxAgeSec int `yaml:"cookie_max_age" default:"172800" env:"WAKAPI_COOKIE_MAX_AGE"`
|
||
SecureCookie *securecookie.SecureCookie `yaml:"-"`
|
||
}
|
||
|
||
type dbConfig struct {
|
||
Host string `env:"WAKAPI_DB_HOST"`
|
||
Port uint `env:"WAKAPI_DB_PORT"`
|
||
User string `env:"WAKAPI_DB_USER"`
|
||
Password string `env:"WAKAPI_DB_PASSWORD"`
|
||
Name string `default:"wakapi_db.db" env:"WAKAPI_DB_NAME"`
|
||
Dialect string `yaml:"-"`
|
||
Charset string `default:"utf8mb4" env:"WAKAPI_DB_CHARSET"`
|
||
Type string `yaml:"dialect" default:"sqlite3" env:"WAKAPI_DB_TYPE"`
|
||
MaxConn uint `yaml:"max_conn" default:"2" env:"WAKAPI_DB_MAX_CONNECTIONS"`
|
||
Ssl bool `default:"false" env:"WAKAPI_DB_SSL"`
|
||
AutoMigrateFailSilently bool `yaml:"automigrate_fail_silently" default:"false" env:"WAKAPI_DB_AUTOMIGRATE_FAIL_SILENTLY"`
|
||
}
|
||
|
||
type serverConfig struct {
|
||
Port int `default:"3000" env:"WAKAPI_PORT"`
|
||
ListenIpV4 string `yaml:"listen_ipv4" default:"127.0.0.1" env:"WAKAPI_LISTEN_IPV4"`
|
||
ListenIpV6 string `yaml:"listen_ipv6" default:"::1" env:"WAKAPI_LISTEN_IPV6"`
|
||
ListenSocket string `yaml:"listen_socket" default:"" env:"WAKAPI_LISTEN_SOCKET"`
|
||
TimeoutSec int `yaml:"timeout_sec" default:"30" env:"WAKAPI_TIMEOUT_SEC"`
|
||
BasePath string `yaml:"base_path" default:"/" env:"WAKAPI_BASE_PATH"`
|
||
PublicUrl string `yaml:"public_url" default:"http://localhost:3000" env:"WAKAPI_PUBLIC_URL"`
|
||
TlsCertPath string `yaml:"tls_cert_path" default:"" env:"WAKAPI_TLS_CERT_PATH"`
|
||
TlsKeyPath string `yaml:"tls_key_path" default:"" env:"WAKAPI_TLS_KEY_PATH"`
|
||
}
|
||
|
||
type sentryConfig struct {
|
||
Dsn string `env:"WAKAPI_SENTRY_DSN"`
|
||
EnableTracing bool `yaml:"enable_tracing" env:"WAKAPI_SENTRY_TRACING"`
|
||
SampleRate float32 `yaml:"sample_rate" default:"0.75" env:"WAKAPI_SENTRY_SAMPLE_RATE"`
|
||
SampleRateHeartbeats float32 `yaml:"sample_rate_heartbeats" default:"0.1" env:"WAKAPI_SENTRY_SAMPLE_RATE_HEARTBEATS"`
|
||
}
|
||
|
||
type mailConfig struct {
|
||
Enabled bool `env:"WAKAPI_MAIL_ENABLED" default:"true"`
|
||
Provider string `env:"WAKAPI_MAIL_PROVIDER" default:"smtp"`
|
||
MailWhale MailwhaleMailConfig `yaml:"mailwhale"`
|
||
Smtp SMTPMailConfig `yaml:"smtp"`
|
||
Sender string `env:"WAKAPI_MAIL_SENDER" yaml:"sender"`
|
||
}
|
||
|
||
type MailwhaleMailConfig struct {
|
||
Url string `env:"WAKAPI_MAIL_MAILWHALE_URL"`
|
||
ClientId string `yaml:"client_id" env:"WAKAPI_MAIL_MAILWHALE_CLIENT_ID"`
|
||
ClientSecret string `yaml:"client_secret" env:"WAKAPI_MAIL_MAILWHALE_CLIENT_SECRET"`
|
||
}
|
||
|
||
type SMTPMailConfig struct {
|
||
Host string `env:"WAKAPI_MAIL_SMTP_HOST"`
|
||
Port uint `env:"WAKAPI_MAIL_SMTP_PORT"`
|
||
Username string `env:"WAKAPI_MAIL_SMTP_USER"`
|
||
Password string `env:"WAKAPI_MAIL_SMTP_PASS"`
|
||
TLS bool `env:"WAKAPI_MAIL_SMTP_TLS"`
|
||
}
|
||
|
||
type Config struct {
|
||
Env string `default:"dev" env:"ENVIRONMENT"`
|
||
Version string `yaml:"-"`
|
||
App appConfig
|
||
Security securityConfig
|
||
Db dbConfig
|
||
Server serverConfig
|
||
Sentry sentryConfig
|
||
Mail mailConfig
|
||
}
|
||
|
||
func (c *Config) CreateCookie(name, value, path string) *http.Cookie {
|
||
return c.createCookie(name, value, path, c.Security.CookieMaxAgeSec)
|
||
}
|
||
|
||
func (c *Config) GetClearCookie(name, path string) *http.Cookie {
|
||
return c.createCookie(name, "", path, -1)
|
||
}
|
||
|
||
func (c *Config) createCookie(name, value, path string, maxAge int) *http.Cookie {
|
||
return &http.Cookie{
|
||
Name: name,
|
||
Value: value,
|
||
Path: path,
|
||
MaxAge: maxAge,
|
||
Secure: !c.Security.InsecureCookies,
|
||
HttpOnly: true,
|
||
SameSite: http.SameSiteStrictMode,
|
||
}
|
||
}
|
||
|
||
func (c *Config) IsDev() bool {
|
||
return IsDev(c.Env)
|
||
}
|
||
|
||
func (c *Config) UseTLS() bool {
|
||
return c.Server.TlsCertPath != "" && c.Server.TlsKeyPath != ""
|
||
}
|
||
|
||
func (c *Config) GetMigrationFunc(dbDialect string) models.MigrationFunc {
|
||
switch dbDialect {
|
||
default:
|
||
return func(db *gorm.DB) error {
|
||
if err := db.AutoMigrate(&models.User{}); err != nil && !c.Db.AutoMigrateFailSilently {
|
||
return err
|
||
}
|
||
if err := db.AutoMigrate(&models.KeyStringValue{}); err != nil && !c.Db.AutoMigrateFailSilently {
|
||
return err
|
||
}
|
||
if err := db.AutoMigrate(&models.Alias{}); err != nil && !c.Db.AutoMigrateFailSilently {
|
||
return err
|
||
}
|
||
if err := db.AutoMigrate(&models.Heartbeat{}); err != nil && !c.Db.AutoMigrateFailSilently {
|
||
return err
|
||
}
|
||
if err := db.AutoMigrate(&models.Summary{}); err != nil && !c.Db.AutoMigrateFailSilently {
|
||
return err
|
||
}
|
||
if err := db.AutoMigrate(&models.SummaryItem{}); err != nil && !c.Db.AutoMigrateFailSilently {
|
||
return err
|
||
}
|
||
if err := db.AutoMigrate(&models.LanguageMapping{}); err != nil && !c.Db.AutoMigrateFailSilently {
|
||
return err
|
||
}
|
||
if err := db.AutoMigrate(&models.ProjectLabel{}); err != nil && !c.Db.AutoMigrateFailSilently {
|
||
return err
|
||
}
|
||
if err := db.AutoMigrate(&models.Diagnostics{}); err != nil && !c.Db.AutoMigrateFailSilently {
|
||
return err
|
||
}
|
||
return nil
|
||
}
|
||
}
|
||
}
|
||
|
||
func (c *appConfig) GetCustomLanguages() map[string]string {
|
||
return cloneStringMap(c.CustomLanguages, false)
|
||
}
|
||
|
||
func (c *appConfig) GetLanguageColors() map[string]string {
|
||
return cloneStringMap(c.Colors["languages"], true)
|
||
}
|
||
|
||
func (c *appConfig) GetEditorColors() map[string]string {
|
||
return cloneStringMap(c.Colors["editors"], true)
|
||
}
|
||
|
||
func (c *appConfig) GetOSColors() map[string]string {
|
||
return cloneStringMap(c.Colors["operating_systems"], true)
|
||
}
|
||
|
||
func (c *appConfig) GetWeeklyReportDay() time.Weekday {
|
||
s := strings.Split(c.ReportTimeWeekly, ",")[0]
|
||
return parseWeekday(s)
|
||
}
|
||
|
||
func (c *appConfig) GetWeeklyReportTime() string {
|
||
return strings.Split(c.ReportTimeWeekly, ",")[1]
|
||
}
|
||
|
||
func (c *dbConfig) IsSQLite() bool {
|
||
return c.Dialect == "sqlite3"
|
||
}
|
||
|
||
func (c *dbConfig) IsMySQL() bool {
|
||
return c.Dialect == "mysql"
|
||
}
|
||
|
||
func (c *dbConfig) IsPostgres() bool {
|
||
return c.Dialect == "postgres"
|
||
}
|
||
|
||
func (c *serverConfig) GetPublicUrl() string {
|
||
return strings.TrimSuffix(c.PublicUrl, "/")
|
||
}
|
||
|
||
func (c *SMTPMailConfig) ConnStr() string {
|
||
return fmt.Sprintf("%s:%d", c.Host, c.Port)
|
||
}
|
||
|
||
func IsDev(env string) bool {
|
||
return env == "dev" || env == "development"
|
||
}
|
||
|
||
func readColors() map[string]map[string]string {
|
||
// Read language colors
|
||
// Source:
|
||
// – https://raw.githubusercontent.com/ozh/github-colors/master/colors.json
|
||
// – https://wakatime.com/colors/operating_systems
|
||
// - https://wakatime.com/colors/editors
|
||
// Extracted from Wakatime website with XPath (see below) and did a bit of regex magic after.
|
||
// – $x('//span[@class="editor-icon tip"]/@data-original-title').map(e => e.nodeValue)
|
||
// – $x('//span[@class="editor-icon tip"]/div[1]/text()').map(e => e.nodeValue)
|
||
|
||
raw := data.ColorsFile
|
||
if IsDev(env) {
|
||
raw, _ = ioutil.ReadFile("data/colors.json")
|
||
}
|
||
|
||
var colors = make(map[string]map[string]string)
|
||
if err := json.Unmarshal(raw, &colors); err != nil {
|
||
logbuch.Fatal(err.Error())
|
||
}
|
||
|
||
return colors
|
||
}
|
||
|
||
func mustReadConfigLocation() string {
|
||
if _, err := os.Stat(*cFlag); err != nil {
|
||
logbuch.Fatal("failed to find config file at '%s'", *cFlag)
|
||
}
|
||
return *cFlag
|
||
}
|
||
|
||
func resolveDbDialect(dbType string) string {
|
||
if dbType == "cockroach" {
|
||
return "postgres"
|
||
}
|
||
if dbType == "sqlite" {
|
||
return "sqlite3"
|
||
}
|
||
if dbType == "mariadb" {
|
||
return "mysql"
|
||
}
|
||
return dbType
|
||
}
|
||
|
||
func findString(needle string, haystack []string, defaultVal string) string {
|
||
for _, s := range haystack {
|
||
if s == needle {
|
||
return s
|
||
}
|
||
}
|
||
return defaultVal
|
||
}
|
||
|
||
func parseWeekday(s string) time.Weekday {
|
||
switch strings.ToLower(s) {
|
||
case "mon", strings.ToLower(time.Monday.String()):
|
||
return time.Monday
|
||
case "tue", strings.ToLower(time.Tuesday.String()):
|
||
return time.Tuesday
|
||
case "wed", strings.ToLower(time.Wednesday.String()):
|
||
return time.Wednesday
|
||
case "thu", strings.ToLower(time.Thursday.String()):
|
||
return time.Thursday
|
||
case "fri", strings.ToLower(time.Friday.String()):
|
||
return time.Friday
|
||
case "sat", strings.ToLower(time.Saturday.String()):
|
||
return time.Saturday
|
||
case "sun", strings.ToLower(time.Sunday.String()):
|
||
return time.Sunday
|
||
}
|
||
return time.Monday
|
||
}
|
||
|
||
func Set(config *Config) {
|
||
cfg = config
|
||
}
|
||
|
||
func Get() *Config {
|
||
return cfg
|
||
}
|
||
|
||
func Load(version string) *Config {
|
||
config := &Config{}
|
||
|
||
flag.Parse()
|
||
|
||
if err := configor.New(&configor.Config{}).Load(config, mustReadConfigLocation()); err != nil {
|
||
logbuch.Fatal("failed to read config: %v", err)
|
||
}
|
||
|
||
env = config.Env
|
||
config.Version = strings.TrimSpace(version)
|
||
config.App.Colors = readColors()
|
||
config.Db.Dialect = resolveDbDialect(config.Db.Type)
|
||
config.Security.SecureCookie = securecookie.New(
|
||
securecookie.GenerateRandomKey(64),
|
||
securecookie.GenerateRandomKey(32),
|
||
)
|
||
|
||
if strings.HasSuffix(config.Server.BasePath, "/") {
|
||
config.Server.BasePath = config.Server.BasePath[:len(config.Server.BasePath)-1]
|
||
}
|
||
|
||
for k, v := range config.App.CustomLanguages {
|
||
if v == "" {
|
||
config.App.CustomLanguages[k] = "unknown"
|
||
}
|
||
}
|
||
|
||
if config.Sentry.Dsn != "" {
|
||
logbuch.Info("enabling sentry integration")
|
||
initSentry(config.Sentry, config.IsDev())
|
||
}
|
||
|
||
// some validation checks
|
||
if config.Server.ListenIpV4 == "" && config.Server.ListenIpV6 == "" && config.Server.ListenSocket == "" {
|
||
logbuch.Fatal("either of listen_ipv4 or listen_ipv6 or listen_socket must be set")
|
||
}
|
||
if config.Db.MaxConn <= 0 {
|
||
logbuch.Fatal("you must allow at least one database connection")
|
||
}
|
||
if config.Db.MaxConn > 1 && config.Db.IsSQLite() {
|
||
logbuch.Warn("with sqlite, only a single connection is supported") // otherwise 'PRAGMA foreign_keys=ON' would somehow have to be set for every connection in the pool
|
||
config.Db.MaxConn = 1
|
||
}
|
||
if config.Mail.Provider != "" && findString(config.Mail.Provider, emailProviders, "") == "" {
|
||
logbuch.Fatal("unknown mail provider '%s'", config.Mail.Provider)
|
||
}
|
||
if _, err := time.Parse("15:04", config.App.GetWeeklyReportTime()); err != nil {
|
||
logbuch.Fatal("invalid interval set for report_time_weekly")
|
||
}
|
||
if _, err := time.Parse("15:04", config.App.AggregationTime); err != nil {
|
||
logbuch.Fatal("invalid interval set for aggregation_time")
|
||
}
|
||
|
||
Set(config)
|
||
return Get()
|
||
}
|