Implement Configure-Start-Stop module lifetime and non-global Registry object

container.Global is temporarily added until we start passing container
during module initialization.

Author: foxcpp

framework/config/module/modconfig.go

@@ -28,19 +28,18 @@ package modconfig
 
 import (
 	"fmt"
-	"io"
 	"reflect"
 	"strings"
 
 	parser "github.com/foxcpp/maddy/framework/cfgparser"
 	"github.com/foxcpp/maddy/framework/config"
-	"github.com/foxcpp/maddy/framework/hooks"
+	"github.com/foxcpp/maddy/framework/container"
 	"github.com/foxcpp/maddy/framework/log"
 	"github.com/foxcpp/maddy/framework/module"
 )
 
 // createInlineModule is a helper function for config matchers that can create inline modules.
-func createInlineModule(preferredNamespace, modName string, args []string) (module.Module, error) {
+func createInlineModule(preferredNamespace, modName string) (module.Module, error) {
 	var newMod module.FuncNewModule
 	originalModName := modName
 
@@ -61,26 +60,21 @@ func createInlineModule(preferredNamespace, modName string, args []string) (modu
 		return nil, fmt.Errorf("unknown module: %s (namespace: %s)", originalModName, preferredNamespace)
 	}
 
-	return newMod(modName, "", nil, args)
+	return newMod(modName, "")
 }
 
-// initInlineModule constructs "faked" config tree and passes it to module
+// configureInlineModule constructs "faked" config tree and passes it to module
 // Init function to make it look like it is defined at top-level.
 //
-// args must contain at least one argument, otherwise initInlineModule panics.
-func initInlineModule(modObj module.Module, globals map[string]interface{}, block config.Node) error {
-	err := modObj.Init(config.NewMap(globals, block))
+// args must contain at least one argument, otherwise configureInlineModule panics.
+func configureInlineModule(modObj module.Module, args []string, globals map[string]interface{}, block config.Node) error {
+	err := modObj.Configure(args, config.NewMap(globals, block))
 	if err != nil {
 		return err
 	}
 
-	if closer, ok := modObj.(io.Closer); ok {
-		hooks.AddHook(hooks.EventShutdown, func() {
-			log.Debugf("close %s (%s)", modObj.Name(), modObj.InstanceName())
-			if err := closer.Close(); err != nil {
-				log.Printf("module %s (%s) close failed: %v", modObj.Name(), modObj.InstanceName(), err)
-			}
-		})
+	if li, ok := modObj.(module.LifetimeModule); ok {
+		container.Global.Lifetime.Add(li)
 	}
 
 	return nil
@@ -117,11 +111,11 @@ func ModuleFromNode(preferredNamespace string, args []string, inlineCfg config.N
 		if len(args) != 1 || inlineCfg.Children != nil {
 			return parser.NodeErr(inlineCfg, "exactly one argument is required to use existing config block")
 		}
-		modObj, err = module.GetInstance(args[0][1:])
+		modObj, err = container.Global.Modules.Get(args[0][1:])
 		log.Debugf("%s:%d: reference %s", inlineCfg.File, inlineCfg.Line, args[0])
 	} else {
 		log.Debugf("%s:%d: new module %s %v", inlineCfg.File, inlineCfg.Line, args[0], args[1:])
-		modObj, err = createInlineModule(preferredNamespace, args[0], args[1:])
+		modObj, err = createInlineModule(preferredNamespace, args[0])
 	}
 	if err != nil {
 		return err
@@ -144,7 +138,7 @@ func ModuleFromNode(preferredNamespace string, args []string, inlineCfg config.N
 	reflect.ValueOf(moduleIface).Elem().Set(reflect.ValueOf(modObj))
 
 	if !referenceExisting {
-		if err := initInlineModule(modObj, globals, inlineCfg); err != nil {
+		if err := configureInlineModule(modObj, args[1:], globals, inlineCfg); err != nil {
 			return err
 		}
 	}

framework/container/container.go

@@ -0,0 +1,70 @@
+/*
+Maddy Mail Server - Composable all-in-one email server.
+Copyright © 2019-2020 Max Mazurov <fox.cpp@disroot.org>, Maddy Mail Server contributors
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+*/
+
+package container
+
+import (
+	"github.com/foxcpp/maddy/framework/log"
+	"github.com/foxcpp/maddy/framework/module"
+)
+
+type GlobalConfig struct {
+	// StateDirectory contains the path to the directory that
+	// should be used to store any data that should be
+	// preserved between sessions.
+	//
+	// Value of this variable must not change after initialization
+	// in cmd/maddy/main.go.
+	StateDirectory string
+
+	// RuntimeDirectory contains the path to the directory that
+	// should be used to store any temporary data.
+	//
+	// It should be preferred over os.TempDir, which is
+	// global and world-readable on most systems, while
+	// RuntimeDirectory can be dedicated for maddy.
+	//
+	// Value of this variable must not change after initialization
+	// in cmd/maddy/main.go.
+	RuntimeDirectory string
+
+	// LibexecDirectory contains the path to the directory
+	// where helper binaries should be searched.
+	//
+	// Value of this variable must not change after initialization
+	// in cmd/maddy/main.go.
+	LibexecDirectory string
+}
+
+type C struct {
+	Config        GlobalConfig
+	DefaultLogger log.Logger
+	Modules       *module.Registry
+	Lifetime      *module.LifetimeTracker
+}
+
+func New() *C {
+	return &C{
+		DefaultLogger: log.DefaultLogger,
+		Modules:       module.NewRegistry(log.DefaultLogger.Sublogger("registry")),
+		Lifetime:      module.NewLifetime(log.DefaultLogger.Sublogger("lifetime")),
+	}
+}
+
+// Global is the default instance while refactoring is in progress.
+var Global *C

framework/log/log.go

@@ -224,6 +224,17 @@ func (l Logger) log(debug bool, s string) {
 	// Logging is disabled - do nothing.
 }
 
+func (l Logger) Sublogger(name string) Logger {
+	if l.Name != "" {
+		name = l.Name + "/" + name
+	}
+	return Logger{
+		Out:   l.Out,
+		Name:  name,
+		Debug: l.Debug,
+	}
+}
+
 // DefaultLogger is the global Logger object that is used by
 // package-level logging functions.
 //

framework/module/delivery_target.go

@@ -33,12 +33,12 @@ import (
 // Modules implementing this interface should be registered with "target."
 // prefix in name.
 type DeliveryTarget interface {
-	// Start starts the delivery of a new message.
+	// StartDelivery starts the delivery of a new message.
 	//
 	// The domain part of the MAIL FROM address is assumed to be U-labels with
 	// NFC normalization and case-folding applied. The message source should
 	// ensure that by calling address.CleanDomain if necessary.
-	Start(ctx context.Context, msgMeta *MsgMetadata, mailFrom string) (Delivery, error)
+	StartDelivery(ctx context.Context, msgMeta *MsgMetadata, mailFrom string) (Delivery, error)
 }
 
 type Delivery interface {
@@ -54,7 +54,7 @@ type Delivery interface {
 	// however. They should be silently ignored.
 	//
 	// Implementation should do as much checks as possible here and reject
-	// recipients that can't be used.  Note: MsgMetadata object passed to Start
+	// recipients that can't be used.  Note: MsgMetadata object passed to StartDelivery
 	// contains BodyLength field. If it is non-zero, it can be used to check
 	// storage quota for the user before Body.
 	AddRcpt(ctx context.Context, rcptTo string, opts smtp.RcptOptions) error

framework/module/dummy.go

@@ -54,11 +54,11 @@ func (d *Dummy) InstanceName() string {
 	return d.instName
 }
 
-func (d *Dummy) Init(_ *config.Map) error {
+func (d *Dummy) Configure(_ []string, _ *config.Map) error {
 	return nil
 }
 
-func (d *Dummy) Start(ctx context.Context, msgMeta *MsgMetadata, mailFrom string) (Delivery, error) {
+func (d *Dummy) StartDelivery(ctx context.Context, msgMeta *MsgMetadata, mailFrom string) (Delivery, error) {
 	return dummyDelivery{}, nil
 }
 
@@ -81,7 +81,7 @@ func (dd dummyDelivery) Commit(ctx context.Context) error {
 }
 
 func init() {
-	Register("dummy", func(_, instName string, _, _ []string) (Module, error) {
+	Register("dummy", func(_, instName string) (Module, error) {
 		return &Dummy{instName: instName}, nil
 	})
 }