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:
91
base/database/hook.go
Normal file
91
base/database/hook.go
Normal file
@@ -0,0 +1,91 @@
|
||||
package database
|
||||
|
||||
import (
|
||||
"github.com/safing/portmaster/base/database/query"
|
||||
"github.com/safing/portmaster/base/database/record"
|
||||
)
|
||||
|
||||
// Hook can be registered for a database query and
|
||||
// will be executed at certain points during the life
|
||||
// cycle of a database record.
|
||||
type Hook interface {
|
||||
// UsesPreGet should return true if the hook's PreGet
|
||||
// should be called prior to loading a database record
|
||||
// from the underlying storage.
|
||||
UsesPreGet() bool
|
||||
// PreGet is called before a database record is loaded from
|
||||
// the underlying storage. A PreGet hookd may be used to
|
||||
// implement more advanced access control on database keys.
|
||||
PreGet(dbKey string) error
|
||||
// UsesPostGet should return true if the hook's PostGet
|
||||
// should be called after loading a database record from
|
||||
// the underlying storage.
|
||||
UsesPostGet() bool
|
||||
// PostGet is called after a record has been loaded form the
|
||||
// underlying storage and may perform additional mutation
|
||||
// or access check based on the records data.
|
||||
// The passed record is already locked by the database system
|
||||
// so users can safely access all data of r.
|
||||
PostGet(r record.Record) (record.Record, error)
|
||||
// UsesPrePut should return true if the hook's PrePut method
|
||||
// should be called prior to saving a record in the database.
|
||||
UsesPrePut() bool
|
||||
// PrePut is called prior to saving (creating or updating) a
|
||||
// record in the database storage. It may be used to perform
|
||||
// extended validation or mutations on the record.
|
||||
// The passed record is already locked by the database system
|
||||
// so users can safely access all data of r.
|
||||
PrePut(r record.Record) (record.Record, error)
|
||||
}
|
||||
|
||||
// RegisteredHook is a registered database hook.
|
||||
type RegisteredHook struct {
|
||||
q *query.Query
|
||||
h Hook
|
||||
}
|
||||
|
||||
// RegisterHook registers a hook for records matching the given
|
||||
// query in the database.
|
||||
func RegisterHook(q *query.Query, hook Hook) (*RegisteredHook, error) {
|
||||
_, err := q.Check()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
c, err := getController(q.DatabaseName())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
rh := &RegisteredHook{
|
||||
q: q,
|
||||
h: hook,
|
||||
}
|
||||
|
||||
c.hooksLock.Lock()
|
||||
defer c.hooksLock.Unlock()
|
||||
c.hooks = append(c.hooks, rh)
|
||||
|
||||
return rh, nil
|
||||
}
|
||||
|
||||
// Cancel unregisteres the hook from the database. Once
|
||||
// Cancel returned the hook's methods will not be called
|
||||
// anymore for updates that matched the registered query.
|
||||
func (h *RegisteredHook) Cancel() error {
|
||||
c, err := getController(h.q.DatabaseName())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
c.hooksLock.Lock()
|
||||
defer c.hooksLock.Unlock()
|
||||
|
||||
for key, hook := range c.hooks {
|
||||
if hook.q == h.q {
|
||||
c.hooks = append(c.hooks[:key], c.hooks[key+1:]...)
|
||||
return nil
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
Reference in New Issue
Block a user