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>
2024-08-09 17:15:48 +02:00
parent 10a77498f4
commit 80664d1a27
647 changed files with 37690 additions and 3366 deletions
--- a/base/template/module.go
+++ b/base/template/module.go
@@ -0,0 +1,96 @@
+package template
+
+import (
+	"time"
+
+	"github.com/safing/portmaster/base/config"
+	"github.com/safing/portmaster/service/mgr"
+)
+
+// Template showcases the usage of the module system.
+type Template struct {
+	i      instance
+	m      *mgr.Manager
+	states *mgr.StateMgr
+
+	EventRecordAdded   *mgr.EventMgr[string]
+	EventRecordDeleted *mgr.EventMgr[string]
+
+	specialWorkerMgr *mgr.WorkerMgr
+}
+
+type instance interface{}
+
+// New returns a new template.
+func New(instance instance) (*Template, error) {
+	m := mgr.New("template")
+	t := &Template{
+		i:      instance,
+		m:      m,
+		states: m.NewStateMgr(),
+
+		EventRecordAdded:   mgr.NewEventMgr[string]("record added", m),
+		EventRecordDeleted: mgr.NewEventMgr[string]("record deleted", m),
+
+		specialWorkerMgr: m.NewWorkerMgr("special worker", serviceWorker, nil),
+	}
+
+	// register options
+	err := config.Register(&config.Option{
+		Name:            "language",
+		Key:             "template/language",
+		Description:     "Sets the language for the template [TEMPLATE]",
+		OptType:         config.OptTypeString,
+		ExpertiseLevel:  config.ExpertiseLevelUser, // default
+		ReleaseLevel:    config.ReleaseLevelStable, // default
+		RequiresRestart: false,                     // default
+		DefaultValue:    "en",
+		ValidationRegex: "^[a-z]{2}$",
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	return t, nil
+}
+
+// Manager returns the module manager.
+func (t *Template) Manager() *mgr.Manager {
+	return t.m
+}
+
+// States returns the module states.
+func (t *Template) States() *mgr.StateMgr {
+	return t.states
+}
+
+// Start starts the module.
+func (t *Template) Start() error {
+	t.m.Go("worker", serviceWorker)
+	t.specialWorkerMgr.Delay(10 * time.Minute)
+
+	return nil
+}
+
+// Stop stops the module.
+func Stop() error {
+	return nil
+}
+
+func serviceWorker(w *mgr.WorkerCtx) error {
+	for {
+		select {
+		case <-time.After(1 * time.Second):
+			err := do()
+			if err != nil {
+				return err
+			}
+		case <-w.Done():
+			return nil
+		}
+	}
+}
+
+func do() error {
+	return nil
+}