1
0
Fork 0
mirror of https://git.sr.ht/~rjarry/aerc synced 2025-11-27 20:14:06 +01:00
aerc/config/config.go
Robin Jarry 51fd25c0f1 reload: fix crash when reloading via IPC
When reloading the configuration with :reload, global variables in the
config package are reset to their startup values and then, the config is
parsed from disk. While the parsing is done, these variables are
temporarily in an inconsistent and possibly invalid state.

When commands are executed interactively from aerc, they are handled by
the main goroutine which also deals with UI rendering. No UI render will
be done while :reload is in progress.

However, the IPC socket handler runs in an independent goroutine. This
has the unfortunate side effect to let the UI goroutine to run while
config parsing is in progress and causes crashes:

[signal SIGSEGV: segmentation violation code=0x1 addr=0x0 pc=0x6bb142]

goroutine 1 [running]:
git.sr.ht/~rjarry/aerc/lib/log.PanicHandler()
	lib/log/panic-logger.go:51 +0x6cf
panic({0xc1d960?, 0x134a6e0?})
	/usr/lib/go/src/runtime/panic.go:783 +0x132
git.sr.ht/~rjarry/aerc/config.(*StyleConf).getStyle(0xc00038b908?, 0x4206b7?)
	config/style.go:386 +0x42
git.sr.ht/~rjarry/aerc/config.StyleSet.Get({0x0, 0x0, 0x0, {0x0, 0x0, 0x0}}, 0x421a65?, 0x0)
	config/style.go:408 +0x8b
git.sr.ht/~rjarry/aerc/config.(*UIConfig).GetStyle(...)
	config/ui.go:379
git.sr.ht/~rjarry/aerc/lib/ui.(*TabStrip).Draw(0xc000314700, 0xc000192230)
	lib/ui/tab.go:378 +0x15b
git.sr.ht/~rjarry/aerc/lib/ui.(*Grid).Draw(0xc000186fc0, 0xc0002c25f0)
	lib/ui/grid.go:126 +0x28e
git.sr.ht/~rjarry/aerc/app.(*Aerc).Draw(0x14b9f00, 0xc0002c25f0)
	app/aerc.go:192 +0x1fe
git.sr.ht/~rjarry/aerc/lib/ui.Render()
	lib/ui/ui.go:155 +0x16b
main.main()
	main.go:310 +0x997

Make the reload operation safe by changing how config objects are
exposed and updated. Change all objects to be atomic pointers. Expose
public functions to access their value atomically. Only update their
value after a complete and successful config parse. This way the UI
thread will always have access to a valid configuration.

NB: The account configuration is not included in this change since it
cannot be reloaded.

Fixes: https://todo.sr.ht/~rjarry/aerc/319
Reported-by: Anachron <gith@cron.world>
Signed-off-by: Robin Jarry <robin@jarry.cc>
2025-09-23 14:02:37 +02:00

213 lines
4.6 KiB
Go

package config
import (
"errors"
"fmt"
"os"
"path"
"slices"
"strings"
"git.sr.ht/~rjarry/aerc/lib/xdg"
"github.com/go-ini/ini"
)
// Set at build time
var (
shareDir string
libexecDir string
)
func buildDefaultDirs() []string {
var defaultDirs []string
prefixes := []string{
xdg.ConfigPath(),
"~/.local/libexec",
xdg.DataPath(),
}
// Add XDG_CONFIG_HOME and XDG_DATA_HOME
for _, v := range prefixes {
if v != "" {
defaultDirs = append(defaultDirs, xdg.ExpandHome(v, "aerc"))
}
}
// Trim null chars inserted post-build by systems like Conda
shareDir := strings.TrimRight(shareDir, "\x00")
libexecDir := strings.TrimRight(libexecDir, "\x00")
// Add custom buildtime dirs
if libexecDir != "" && libexecDir != "/usr/local/libexec/aerc" {
defaultDirs = append(defaultDirs, xdg.ExpandHome(libexecDir))
}
if shareDir != "" && shareDir != "/usr/local/share/aerc" {
defaultDirs = append(defaultDirs, xdg.ExpandHome(shareDir))
}
// Add fixed fallback locations
defaultDirs = append(defaultDirs, "/usr/local/libexec/aerc")
defaultDirs = append(defaultDirs, "/usr/local/share/aerc")
defaultDirs = append(defaultDirs, "/usr/libexec/aerc")
defaultDirs = append(defaultDirs, "/usr/share/aerc")
return defaultDirs
}
var SearchDirs = buildDefaultDirs()
func installTemplate(root, name string) error {
var err error
if _, err = os.Stat(root); os.IsNotExist(err) {
err = os.MkdirAll(root, 0o755)
if err != nil {
return err
}
}
var data []byte
for _, dir := range SearchDirs {
data, err = os.ReadFile(path.Join(dir, name))
if err == nil {
break
}
}
if err != nil {
return err
}
err = os.WriteFile(path.Join(root, name), data, 0o644)
if err != nil {
return err
}
return nil
}
func parseConf(filename string) error {
file, err := ini.LoadSources(ini.LoadOptions{
KeyValueDelimiters: "=",
}, filename)
if err != nil {
return err
}
general, err := parseGeneral(file)
if err != nil {
return err
}
filters, err := parseFilters(file)
if err != nil {
return err
}
compose, err := parseCompose(file)
if err != nil {
return err
}
converters, err := parseConverters(file)
if err != nil {
return err
}
viewer, err := parseViewer(file)
if err != nil {
return err
}
statusline, err := parseStatusline(file)
if err != nil {
return err
}
openers, err := parseOpeners(file)
if err != nil {
return err
}
hooks, err := parseHooks(file)
if err != nil {
return err
}
ui, err := parseUi(file)
if err != nil {
return err
}
templates, err := parseTemplates(file)
if err != nil {
return err
}
// config parse successful, atomically change all items at once
generalConfig.Store(general)
filtersConfig.Store(&filters)
composeConfig.Store(compose)
convertersConfig.Store(&converters)
viewerConfig.Store(viewer)
statuslineConfig.Store(statusline)
openersConfig.Store(&openers)
hooksConfig.Store(hooks)
uiConfig.Store(ui)
templatesConfig.Store(templates)
return nil
}
func init() {
// store empty values to ensure unit-tests pass without configuration
generalConfig.Store(&GeneralConfig{})
filtersConfig.Store(nil)
composeConfig.Store(&ComposeConfig{})
convertersConfig.Store(nil)
viewerConfig.Store(&ViewerConfig{})
statuslineConfig.Store(&StatuslineConfig{})
openersConfig.Store(nil)
hooksConfig.Store(&HooksConfig{})
ui := &UIConfig{}
ui.style.Store(&StyleSet{})
uiConfig.Store(ui)
templatesConfig.Store(&TemplateConfig{})
}
func LoadConfigFromFile(
root *string, accts []string, filename, bindPath, acctPath string,
) error {
if root == nil {
_root := xdg.ConfigPath("aerc")
root = &_root
}
if filename == "" {
filename = path.Join(*root, "aerc.conf")
// if it doesn't exist copy over the template, then load
if _, err := os.Stat(filename); errors.Is(err, os.ErrNotExist) {
fmt.Printf("%s not found, installing the system default\n", filename)
if err := installTemplate(*root, "aerc.conf"); err != nil {
return err
}
}
}
SetConfFilename(filename)
if err := parseConf(filename); err != nil {
return fmt.Errorf("%s: %w", filename, err)
}
if err := parseAccounts(*root, accts, acctPath); err != nil {
return err
}
if err := parseBinds(*root, bindPath); err != nil {
return err
}
return nil
}
func parseLayout(layout string) [][]string {
rows := strings.Split(layout, ",")
l := make([][]string, len(rows))
for i, r := range rows {
l[i] = strings.Split(r, "|")
}
return l
}
func contains(list []string, v string) bool {
return slices.Contains(list, v)
}
// warning message related to configuration (deprecation, etc.)
type Warning struct {
Title string
Body string
}
var Warnings []Warning