mirror of
https://github.com/foxcpp/maddy.git
synced 2025-04-07 06:57:37 +03:00
bf188e454f
The intention is to keep to repo root clean while the list of packages is slowly growing. Additionally, a bunch of small (~30 LoC) files in the repo root is merged into a single maddy.go file, for the same reason. Most of the internal code is moved into the internal/ directory. Go toolchain will make it impossible to import these packages from external applications. Some packages are renamed and moved into the pkg/ directory in the root. According to https://github.com/golang-standards/project-layout this is the de-facto standard to place "library code that's ok to use by external applications" in. To clearly define the purpose of top-level directories, README.md files are added to each.
71 lines
2.8 KiB
Go
71 lines
2.8 KiB
Go
// Package module contains modules registry and interfaces implemented
|
|
// by modules.
|
|
//
|
|
// Interfaces are placed here to prevent circular dependencies.
|
|
//
|
|
// Each interface required by maddy for operation is provided by some object
|
|
// called "module". This includes authentication, storage backends, DKIM,
|
|
// email filters, etc. Each module may serve multiple functions. I.e. it can
|
|
// be IMAP storage backend, SMTP downstream and authentication provider at the
|
|
// same moment.
|
|
//
|
|
// Each module gets its own unique name (sql for go-imap-sql, proxy for
|
|
// proxy module, local for local delivery perhaps, etc). Each module instance
|
|
// also gets its own (unique too) name which is used to refer to it in
|
|
// configuration.
|
|
package module
|
|
|
|
import (
|
|
"github.com/foxcpp/maddy/internal/config"
|
|
)
|
|
|
|
// Module is the interface implemented by all maddy module instances.
|
|
//
|
|
// It defines basic methods used to identify instances.
|
|
//
|
|
// Additionally, module can implement io.Closer if it needs to perform clean-up
|
|
// on shutdown. If module starts long-lived goroutines - they should be stopped
|
|
// *before* Close method returns to ensure graceful shutdown.
|
|
type Module interface {
|
|
// Init performs actual initialization of the module.
|
|
//
|
|
// It is not done in FuncNewModule so all module instances are
|
|
// registered at time of initialization, thus initialization does not
|
|
// depends on ordering of configuration blocks and modules can reference
|
|
// each other without any problems.
|
|
//
|
|
// Module can use passed config.Map to read its configuration variables.
|
|
Init(*config.Map) error
|
|
|
|
// Name method reports module name.
|
|
//
|
|
// It is used to reference module in the configuration and in logs.
|
|
Name() string
|
|
|
|
// InstanceName method reports unique name of this module instance.
|
|
InstanceName() string
|
|
}
|
|
|
|
// FuncNewModule is function that creates new instance of module with specified name.
|
|
//
|
|
// Module.InstanceName() of the returned module object should return instName.
|
|
// aliases slice contains other names that can be used to reference created
|
|
// module instance.
|
|
//
|
|
// If module is defined inline, instName will be empty and all values
|
|
// specified after module name in configuration will be in inlineArgs.
|
|
type FuncNewModule func(modName, instName string, aliases, inlineArgs []string) (Module, error)
|
|
|
|
// FuncNewEndpoint is a function that creates new instance of endpoint
|
|
// module.
|
|
//
|
|
// Compared to regular modules, endpoint module instances are:
|
|
// - Not registered in the global registry.
|
|
// - Can't be defined inline.
|
|
// - Don't have an unique name
|
|
// - All config arguments are always passed as an 'addrs' slice and not used as
|
|
// names.
|
|
//
|
|
// As a consequence of having no per-instance name, InstanceName of the module
|
|
// object always returns the same value as Name.
|
|
type FuncNewEndpoint func(modName string, addrs []string) (Module, error)
|