Restructure modules (#1572)

* Move portbase into monorepo

* Add new simple module mgr

* [WIP] Switch to new simple module mgr

* Add StateMgr and more worker variants

* [WIP] Switch more modules

* [WIP] Switch more modules

* [WIP] swtich more modules

* [WIP] switch all SPN modules

* [WIP] switch all service modules

* [WIP] Convert all workers to the new module system

* [WIP] add new task system to module manager

* [WIP] Add second take for scheduling workers

* [WIP] Add FIXME for bugs in new scheduler

* [WIP] Add minor improvements to scheduler

* [WIP] Add new worker scheduler

* [WIP] Fix more bug related to new module system

* [WIP] Fix start handing of the new module system

* [WIP] Improve startup process

* [WIP] Fix minor issues

* [WIP] Fix missing subsystem in settings

* [WIP] Initialize managers in constructor

* [WIP] Move module event initialization to constrictors

* [WIP] Fix setting for enabling and disabling the SPN module

* [WIP] Move API registeration into module construction

* [WIP] Update states mgr for all modules

* [WIP] Add CmdLine operation support

* Add state helper methods to module group and instance

* Add notification and module status handling to status package

* Fix starting issues

* Remove pilot widget and update security lock to new status data

* Remove debug logs

* Improve http server shutdown

* Add workaround for cleanly shutting down firewall+netquery

* Improve logging

* Add syncing states with notifications for new module system

* Improve starting, stopping, shutdown; resolve FIXMEs/TODOs

* [WIP] Fix most unit tests

* Review new module system and fix minor issues

* Push shutdown and restart events again via API

* Set sleep mode via interface

* Update example/template module

* [WIP] Fix spn/cabin unit test

* Remove deprecated UI elements

* Make log output more similar for the logging transition phase

* Switch spn hub and observer cmds to new module system

* Fix log sources

* Make worker mgr less error prone

* Fix tests and minor issues

* Fix observation hub

* Improve shutdown and restart handling

* Split up big connection.go source file

* Move varint and dsd packages to structures repo

* Improve expansion test

* Fix linter warnings

* Fix interception module on windows

* Fix linter errors

---------

Co-authored-by: Vladimir Stoilov <vladimir@safing.io>
This commit is contained in:
Daniel Hååvi
2024-08-09 17:15:48 +02:00
committed by GitHub
parent 10a77498f4
commit 80664d1a27
647 changed files with 37690 additions and 3366 deletions

View File

@@ -1,36 +1,69 @@
package status
import (
"context"
"errors"
"fmt"
"sync"
"sync/atomic"
"github.com/safing/portbase/modules"
"github.com/safing/portbase/utils/debug"
"github.com/safing/portmaster/base/notifications"
"github.com/safing/portmaster/base/runtime"
"github.com/safing/portmaster/base/utils/debug"
"github.com/safing/portmaster/service/mgr"
"github.com/safing/portmaster/service/netenv"
)
var module *modules.Module
// Status Module manages status information.
type Status struct {
mgr *mgr.Manager
instance instance
func init() {
module = modules.Register("status", nil, start, nil, "base", "config")
publishUpdate runtime.PushFunc
triggerUpdate chan struct{}
states map[string]mgr.StateUpdate
statesLock sync.Mutex
notifications map[string]map[string]*notifications.Notification
notificationsLock sync.Mutex
}
func start() error {
if err := setupRuntimeProvider(); err != nil {
// Manager returns the module manager.
func (s *Status) Manager() *mgr.Manager {
return s.mgr
}
// Start starts the module.
func (s *Status) Start() error {
if err := s.setupRuntimeProvider(); err != nil {
return err
}
if err := module.RegisterEventHook(
netenv.ModuleName,
netenv.OnlineStatusChangedEvent,
"update online status in system status",
func(_ context.Context, _ interface{}) error {
pushSystemStatus()
return nil
s.mgr.Go("status publisher", s.statusPublisher)
s.instance.NetEnv().EventOnlineStatusChange.AddCallback("update online status in system status",
func(_ *mgr.WorkerCtx, _ netenv.OnlineStatus) (bool, error) {
s.triggerPublishStatus()
return false, nil
},
); err != nil {
return err
)
// Make an initial status query.
s.statesLock.Lock()
defer s.statesLock.Unlock()
// Add status callback within the lock so we can force the right order.
s.instance.AddStatesCallback("status update", s.handleModuleStatusUpdate)
// Get initial states.
for _, stateUpdate := range s.instance.GetStates() {
s.states[stateUpdate.Module] = stateUpdate
s.deriveNotificationsFromStateUpdate(stateUpdate)
}
return nil
}
// Stop stops the module.
func (s *Status) Stop() error {
return nil
}
@@ -43,3 +76,31 @@ func AddToDebugInfo(di *debug.Info) {
"CaptivePortal: "+netenv.GetCaptivePortal().URL,
)
}
var (
module *Status
shimLoaded atomic.Bool
)
// New returns a new status module.
func New(instance instance) (*Status, error) {
if !shimLoaded.CompareAndSwap(false, true) {
return nil, errors.New("only one instance allowed")
}
m := mgr.New("Status")
module = &Status{
mgr: m,
instance: instance,
triggerUpdate: make(chan struct{}, 1),
states: make(map[string]mgr.StateUpdate),
notifications: make(map[string]map[string]*notifications.Notification),
}
return module, nil
}
type instance interface {
NetEnv() *netenv.NetEnv
GetStates() []mgr.StateUpdate
AddStatesCallback(callbackName string, callback mgr.EventCallbackFunc[mgr.StateUpdate])
}