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>

service/broadcasts/api.go

@@ -7,16 +7,15 @@ import (
 	"net/http"
 	"strings"
 
-	"github.com/safing/portbase/api"
-	"github.com/safing/portbase/database"
-	"github.com/safing/portbase/database/accessor"
+	"github.com/safing/portmaster/base/api"
+	"github.com/safing/portmaster/base/database"
+	"github.com/safing/portmaster/base/database/accessor"
 )
 
 func registerAPIEndpoints() error {
 	if err := api.RegisterEndpoint(api.Endpoint{
 		Path:        `broadcasts/matching-data`,
 		Read:        api.PermitAdmin,
-		BelongsTo:   module,
 		StructFunc:  handleMatchingData,
 		Name:        "Get Broadcast Notifications Matching Data",
 		Description: "Returns the data used by the broadcast notifications to match the instance.",
@@ -28,7 +27,6 @@ func registerAPIEndpoints() error {
 		Path:        `broadcasts/reset-state`,
 		Write:       api.PermitAdmin,
 		WriteMethod: http.MethodPost,
-		BelongsTo:   module,
 		ActionFunc:  handleResetState,
 		Name:        "Resets the Broadcast Notification States",
 		Description: "Delete the cache of Broadcast Notifications, making them appear again.",
@@ -40,7 +38,6 @@ func registerAPIEndpoints() error {
 		Path:        `broadcasts/simulate`,
 		Write:       api.PermitAdmin,
 		WriteMethod: http.MethodPost,
-		BelongsTo:   module,
 		ActionFunc:  handleSimulate,
 		Name:        "Simulate Broadcast Notifications",
 		Description: "Test broadcast notifications by sending a valid source file in the body.",

service/broadcasts/data.go

@@ -4,7 +4,7 @@ import (
 	"strconv"
 	"time"
 
-	"github.com/safing/portbase/config"
+	"github.com/safing/portmaster/base/config"
 	"github.com/safing/portmaster/service/intel/geoip"
 	"github.com/safing/portmaster/service/netenv"
 	"github.com/safing/portmaster/service/updates"

service/broadcasts/install_info.go

@@ -9,11 +9,11 @@ import (
 
 	semver "github.com/hashicorp/go-version"
 
-	"github.com/safing/portbase/database"
-	"github.com/safing/portbase/database/query"
-	"github.com/safing/portbase/database/record"
-	"github.com/safing/portbase/info"
-	"github.com/safing/portbase/log"
+	"github.com/safing/portmaster/base/database"
+	"github.com/safing/portmaster/base/database/query"
+	"github.com/safing/portmaster/base/database/record"
+	"github.com/safing/portmaster/base/info"
+	"github.com/safing/portmaster/base/log"
 )
 
 const installInfoDBKey = "core:status/install-info"

service/broadcasts/module.go

@@ -1,16 +1,39 @@
 package broadcasts
 
 import (
+	"errors"
 	"sync"
+	"sync/atomic"
 	"time"
 
-	"github.com/safing/portbase/database"
-	"github.com/safing/portbase/modules"
+	"github.com/safing/portmaster/base/database"
+	"github.com/safing/portmaster/service/mgr"
 )
 
-var (
-	module *modules.Module
+type Broadcasts struct {
+	mgr      *mgr.Manager
+	instance instance
 
+	states *mgr.StateMgr
+}
+
+func (b *Broadcasts) Manager() *mgr.Manager {
+	return b.mgr
+}
+
+func (b *Broadcasts) Start() error {
+	return start()
+}
+
+func (b *Broadcasts) Stop() error {
+	return nil
+}
+
+func (b *Broadcasts) States() *mgr.StateMgr {
+	return b.states
+}
+
+var (
 	db = database.NewInterface(&database.Options{
 		Local:    true,
 		Internal: true,
@@ -20,7 +43,7 @@ var (
 )
 
 func init() {
-	module = modules.Register("broadcasts", prep, start, nil, "updates", "netenv", "notifications")
+	// module = modules.Register("broadcasts", prep, start, nil, "updates", "netenv", "notifications")
 }
 
 func prep() error {
@@ -38,9 +61,34 @@ func start() error {
 
 	// Start broadcast notifier task.
 	startOnce.Do(func() {
-		module.NewTask("broadcast notifier", broadcastNotify).
-			Repeat(10 * time.Minute).Queue()
+		module.mgr.Repeat("broadcast notifier", 10*time.Minute, broadcastNotify)
 	})
 
 	return nil
 }
+
+var (
+	module     *Broadcasts
+	shimLoaded atomic.Bool
+)
+
+// New returns a new Config module.
+func New(instance instance) (*Broadcasts, error) {
+	if !shimLoaded.CompareAndSwap(false, true) {
+		return nil, errors.New("only one instance allowed")
+	}
+	m := mgr.New("Broadcasts")
+	module = &Broadcasts{
+		mgr:      m,
+		instance: instance,
+		states:   m.NewStateMgr(),
+	}
+
+	if err := prep(); err != nil {
+		return nil, err
+	}
+
+	return module, nil
+}
+
+type instance interface{}

service/broadcasts/notify.go

@@ -12,12 +12,12 @@ import (
 
 	"github.com/ghodss/yaml"
 
-	"github.com/safing/portbase/database"
-	"github.com/safing/portbase/database/accessor"
-	"github.com/safing/portbase/database/query"
-	"github.com/safing/portbase/log"
-	"github.com/safing/portbase/modules"
-	"github.com/safing/portbase/notifications"
+	"github.com/safing/portmaster/base/database"
+	"github.com/safing/portmaster/base/database/accessor"
+	"github.com/safing/portmaster/base/database/query"
+	"github.com/safing/portmaster/base/log"
+	"github.com/safing/portmaster/base/notifications"
+	"github.com/safing/portmaster/service/mgr"
 	"github.com/safing/portmaster/service/updates"
 )
 
@@ -66,7 +66,7 @@ type BroadcastNotification struct {
 	repeatDuration time.Duration
 }
 
-func broadcastNotify(ctx context.Context, t *modules.Task) error {
+func broadcastNotify(ctx *mgr.WorkerCtx) error {
 	// Get broadcast notifications file, load it from disk and parse it.
 	broadcastsResource, err := updates.GetFile(broadcastsResourcePath)
 	if err != nil {
@@ -210,10 +210,8 @@ func handleBroadcast(bn *BroadcastNotification, matchingDataAccessor accessor.Ac
 
 	// Display notification.
 	n.Save()
-
-	// Attach to module to raise more awareness.
 	if bn.AttachToModule {
-		n.AttachToModule(module)
+		n.SyncWithState(module.states)
 	}
 
 	return nil

service/broadcasts/state.go

@@ -5,7 +5,7 @@ import (
 	"sync"
 	"time"
 
-	"github.com/safing/portbase/database/record"
+	"github.com/safing/portmaster/base/database/record"
 )
 
 const broadcastStatesDBKey = "core:broadcasts/state"