1
0
mirror of https://github.com/osmarks/mycorrhiza.git synced 2024-12-13 05:50:27 +00:00
mycorrhiza/cfg/config.go

196 lines
6.0 KiB
Go
Raw Normal View History

// Package cfg contains global variables that represent the current wiki
// configuration, including CLI options, configuration file values and header
// links.
package cfg
import (
"errors"
"fmt"
"os"
"github.com/go-ini/ini"
)
// These variables represent the configuration. You are not meant to modify
// them after they were set.
// See https://mycorrhiza.wiki/hypha/configuration/fields for the
// documentation.
var (
WikiName string
NaviTitleIcon string
HomeHypha string
UserHypha string
HeaderLinksHypha string
ListenAddr string
URL string
UseAuth bool
AllowRegistration bool
RegistrationLimit uint64
Locked bool
UseWhiteList bool
WhiteList []string
2021-07-01 09:45:29 +00:00
CommonScripts []string
ViewScripts []string
EditScripts []string
2021-07-14 19:51:55 +00:00
// TelegramEnabled if both TelegramBotToken and TelegramBotName are not empty strings.
TelegramEnabled bool
2021-07-14 19:51:55 +00:00
TelegramBotToken string
TelegramBotName string
)
// WikiDir is a full path to the wiki storage directory, which also must be a
// git repo. This variable is set in parseCliArgs().
var WikiDir string
2021-05-11 08:33:00 +00:00
// Config represents a Mycorrhiza wiki configuration file. This type is used
// only when reading configs.
type Config struct {
WikiName string `comment:"This name appears in the header and on various pages."`
NaviTitleIcon string `comment:"This icon is used in the breadcrumbs bar."`
Hyphae
Network
Authorization
CustomScripts `comment:"You can specify additional scripts to load on different kinds of pages, delimited by a comma ',' sign."`
Telegram `comment:"You can enable Telegram authorization. Follow these instructions: https://core.telegram.org/widgets/login#setting-up-a-bot"`
}
// Hyphae is a section of Config which has fields related to special hyphae.
type Hyphae struct {
HomeHypha string `comment:"This hypha will be the main (index) page of your wiki, served on /."`
UserHypha string `comment:"This hypha is used as a prefix for user hyphae."`
HeaderLinksHypha string `comment:"You can also specify a hypha to populate your own custom header links from."`
}
// Network is a section of Config that has fields related to network stuff:
// HTTP and Gemini.
type Network struct {
ListenAddr string
URL string `comment:"Set your wiki's public URL here. It's used for OpenGraph generation and syndication feeds."`
}
// CustomScripts is a section with paths to JavaScript files that are loaded on
// specified pages.
type CustomScripts struct {
2021-07-01 09:45:29 +00:00
// CommonScripts: everywhere...
CommonScripts []string `delim:"," comment:"These scripts are loaded from anywhere."`
// ViewScripts: /hypha, /rev
ViewScripts []string `delim:"," comment:"These scripts are only loaded on view pages."`
// Edit: /edit
EditScripts []string `delim:"," comment:"These scripts are only loaded on the edit page."`
}
// Authorization is a section of Config that has fields related to
// authorization and authentication.
type Authorization struct {
UseAuth bool
AllowRegistration bool
RegistrationLimit uint64 `comment:"This field controls the maximum amount of allowed registrations."`
Locked bool `comment:"Set if users have to authorize to see anything on the wiki."`
UseWhiteList bool `comment:"If true, WhiteList is used. Else it is not used."`
WhiteList []string `delim:"," comment:"Usernames of people who can log in to your wiki separated by comma."`
}
2021-07-14 19:51:55 +00:00
// Telegram is the section of Config that sets Telegram authorization.
type Telegram struct {
TelegramBotToken string `comment:"Token of your bot."`
TelegramBotName string `comment:"Username of your bot, sans @."`
2021-07-14 19:51:55 +00:00
}
// ReadConfigFile reads a config on the given path and stores the
// configuration. Call it sometime during the initialization.
func ReadConfigFile(path string) error {
cfg := &Config{
2021-06-12 15:01:24 +00:00
WikiName: "Mycorrhiza Wiki",
NaviTitleIcon: "🍄",
Hyphae: Hyphae{
HomeHypha: "home",
UserHypha: "u",
HeaderLinksHypha: "",
},
Network: Network{
ListenAddr: "127.0.0.1:1737",
URL: "",
},
Authorization: Authorization{
UseAuth: false,
AllowRegistration: false,
RegistrationLimit: 0,
Locked: false,
UseWhiteList: false,
WhiteList: []string{},
},
CustomScripts: CustomScripts{
2021-07-01 09:45:29 +00:00
CommonScripts: []string{},
ViewScripts: []string{},
EditScripts: []string{},
},
2021-07-14 19:51:55 +00:00
Telegram: Telegram{
TelegramBotToken: "",
TelegramBotName: "",
2021-07-14 19:51:55 +00:00
},
}
2021-03-09 14:27:14 +00:00
f, err := ini.Load(path)
if err != nil {
if errors.Is(err, os.ErrNotExist) {
f = ini.Empty()
// Save the default configuration
err = f.ReflectFrom(cfg)
if err != nil {
return fmt.Errorf("Failed to serialize the config: %w", err)
}
// Disable key-value auto-aligning, but retain spaces around '=' sign
ini.PrettyFormat = false
ini.PrettyEqual = true
if err = f.SaveTo(path); err != nil {
return fmt.Errorf("Failed to save the config file: %w", err)
}
} else {
return fmt.Errorf("Failed to open the config file: %w", err)
}
}
// Map the config file to the config struct. It'll do nothing if the file
// doesn't exist or is empty.
if err := f.MapTo(cfg); err != nil {
return err
}
// Map the struct to the global variables
WikiName = cfg.WikiName
NaviTitleIcon = cfg.NaviTitleIcon
HomeHypha = cfg.HomeHypha
UserHypha = cfg.UserHypha
HeaderLinksHypha = cfg.HeaderLinksHypha
if ListenAddr == "" {
ListenAddr = cfg.ListenAddr
}
URL = cfg.URL
UseAuth = cfg.UseAuth
AllowRegistration = cfg.AllowRegistration
RegistrationLimit = cfg.RegistrationLimit
Locked = cfg.Locked && cfg.UseAuth // Makes no sense to have the lock but no auth
2021-07-14 21:30:30 +00:00
UseWhiteList = cfg.UseWhiteList
WhiteList = cfg.WhiteList
2021-07-01 09:45:29 +00:00
CommonScripts = cfg.CommonScripts
ViewScripts = cfg.ViewScripts
EditScripts = cfg.EditScripts
2021-07-14 19:51:55 +00:00
TelegramBotToken = cfg.TelegramBotToken
TelegramBotName = cfg.TelegramBotName
TelegramEnabled = (TelegramBotToken != "") && (TelegramBotName != "")
2021-05-11 08:33:00 +00:00
// This URL makes much more sense.
if URL == "" {
URL = "http://" + ListenAddr
2021-05-11 08:33:00 +00:00
}
return nil
}