safing-portbase/modules/subsystems/subsystems.go

package subsystems

import (
	"context"
	"fmt"
	"sync"
	"time"

	"github.com/tevino/abool"

	"github.com/safing/portbase/config"
	"github.com/safing/portbase/modules"
)

var (
	subsystemsLock   sync.Mutex
	subsystems       []*Subsystem
	subsystemsMap    = make(map[string]*Subsystem)
	subsystemsLocked = abool.New()

	handlingConfigChanges = abool.New()
)

// Register registers a new subsystem. The given option must be a bool option.
// Should be called in init() directly after the modules.Register() function.
// The config option must not yet be registered and will be registered for
// you. Pass a nil option to force enable.
func Register(id, name, description string, module *modules.Module, configKeySpace string, option *config.Option) {
	// lock slice and map
	subsystemsLock.Lock()
	defer subsystemsLock.Unlock()

	// check if registration is closed
	if subsystemsLocked.IsSet() {
		panic("subsystems can only be registered in prep phase or earlier")
	}

	// check if already registered
	if _, ok := subsystemsMap[name]; ok {
		panic(fmt.Sprintf(`subsystem "%s" already registered`, name))
	}

	// create new
	new := &Subsystem{
		ID:             id,
		Name:           name,
		Description:    description,
		module:         module,
		toggleOption:   option,
		ConfigKeySpace: configKeySpace,
	}
	if new.toggleOption != nil {
		new.ToggleOptionKey = new.toggleOption.Key
		new.ExpertiseLevel = new.toggleOption.ExpertiseLevel
		new.ReleaseLevel = new.toggleOption.ReleaseLevel
	}

	// register config
	if option != nil {
		err := config.Register(option)
		if err != nil {
			panic(fmt.Sprintf("failed to register config: %s", err))
		}
		new.toggleValue = config.GetAsBool(new.ToggleOptionKey, false)
	} else {
		// force enabled
		new.toggleValue = func() bool { return true }
	}

	subsystemsMap[name] = new
	subsystems = append(subsystems, new)
}

func handleModuleChanges(m *modules.Module) {
	// check if ready
	if !subsystemsLocked.IsSet() {
		return
	}

	// check if shutting down
	if modules.IsShuttingDown() {
		return
	}

	// find module status
	var moduleSubsystem *Subsystem
	var moduleStatus *ModuleStatus
subsystemLoop:
	for _, subsystem := range subsystems {
		for _, status := range subsystem.Modules {
			if m.Name == status.Name {
				moduleSubsystem = subsystem
				moduleStatus = status
				break subsystemLoop
			}
		}
	}
	// abort if not found
	if moduleSubsystem == nil || moduleStatus == nil {
		return
	}

	// update status
	moduleSubsystem.Lock()
	changed := compareAndUpdateStatus(m, moduleStatus)
	if changed {
		moduleSubsystem.makeSummary()
	}
	moduleSubsystem.Unlock()

	// save
	if changed {
		moduleSubsystem.Save()
	}
}

func handleConfigChanges(ctx context.Context, _ interface{}) error {
	// bail out early if we haven't started yet or are already
	// shutting down
	if !subsystemsLocked.IsSet() || modules.IsShuttingDown() {
		return nil
	}

	// potentially catch multiple changes
	if handlingConfigChanges.SetToIf(false, true) {
		time.Sleep(100 * time.Millisecond)
		handlingConfigChanges.UnSet()
	} else {
		return nil
	}

	// only run one instance at any time
	subsystemsLock.Lock()
	defer subsystemsLock.Unlock()

	var changed bool
	for _, subsystem := range subsystems {
		if subsystem.module.SetEnabled(subsystem.toggleValue()) {
			// if changed
			changed = true
		}
	}
	if !changed {
		return nil
	}

	err := modules.ManageModules()
	if err != nil {
		module.Error(
			"modulemgmt-failed",
			fmt.Sprintf("The subsystem framework failed to start or stop one or more modules.\nError: %s\nCheck logs for more information.", err),
		)
	} else {
		module.Resolve("modulemgmt-failed")
	}

	return nil
}