From 31ab737bf26deb9315ffedf99a8bb7d43f620700 Mon Sep 17 00:00:00 2001
From: Matthew Holt <mholt@users.noreply.github.com>
Date: Fri, 28 Jun 2019 19:28:28 -0600
Subject: Refactor code related to getting current version

And set version in CertMagic for User-Agent purposes
---
 caddy.go | 74 ++++++++++++++++++++++++++++++++++++++++++----------------------
 1 file changed, 49 insertions(+), 25 deletions(-)

(limited to 'caddy.go')

diff --git a/caddy.go b/caddy.go
index 1655948..51eab2e 100644
--- a/caddy.go
+++ b/caddy.go
@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"runtime/debug"
 	"strings"
 	"sync"
 	"time"
@@ -12,6 +13,28 @@ import (
 	"github.com/mholt/certmagic"
 )
 
+// Config represents a Caddy configuration.
+type Config struct {
+	Admin *AdminConfig `json:"admin,omitempty"`
+
+	StorageRaw json.RawMessage `json:"storage,omitempty"`
+	storage    certmagic.Storage
+
+	AppsRaw map[string]json.RawMessage `json:"apps,omitempty"`
+
+	// apps stores the decoded Apps values,
+	// keyed by module name.
+	apps map[string]App
+
+	cancelFunc context.CancelFunc
+}
+
+// App is a thing that Caddy runs.
+type App interface {
+	Start() error
+	Stop() error
+}
+
 // Run runs Caddy with the given config.
 func Run(newCfg *Config) error {
 	currentCfgMu.Lock()
@@ -69,7 +92,7 @@ func Run(newCfg *Config) error {
 			return err
 		}
 
-		// Load, Provision, Validate
+		// Load, Provision, Validate each app and their submodules
 		err = func() error {
 			for modName, rawMsg := range newCfg.AppsRaw {
 				val, err := ctx.LoadModule(modName, rawMsg)
@@ -112,7 +135,7 @@ func Run(newCfg *Config) error {
 	oldCfg := currentCfg
 	currentCfg = newCfg
 
-	// Stop, Cleanup
+	// Stop, Cleanup each old app
 	if oldCfg != nil {
 		for name, a := range oldCfg.apps {
 			err := a.Stop()
@@ -121,35 +144,13 @@ func Run(newCfg *Config) error {
 			}
 		}
 
-		// clean up old modules
+		// clean up all old modules
 		oldCfg.cancelFunc()
 	}
 
 	return nil
 }
 
-// App is a thing that Caddy runs.
-type App interface {
-	Start() error
-	Stop() error
-}
-
-// Config represents a Caddy configuration.
-type Config struct {
-	Admin *AdminConfig `json:"admin,omitempty"`
-
-	StorageRaw json.RawMessage `json:"storage,omitempty"`
-	storage    certmagic.Storage
-
-	AppsRaw map[string]json.RawMessage `json:"apps,omitempty"`
-
-	// apps stores the decoded Apps values,
-	// keyed by module name.
-	apps map[string]App
-
-	cancelFunc context.CancelFunc
-}
-
 // Duration is a JSON-string-unmarshable duration type.
 type Duration time.Duration
 
@@ -163,6 +164,29 @@ func (d *Duration) UnmarshalJSON(b []byte) error {
 	return nil
 }
 
+// GoModule returns the build info of this Caddy
+// build from debug.BuildInfo (requires Go modules).
+// If no version information is available, a non-nil
+// value will still be returned, but with an
+// unknown version.
+func GoModule() *debug.Module {
+	bi, ok := debug.ReadBuildInfo()
+	if ok {
+		// The recommended way to build Caddy involves
+		// creating a separate main module, which
+		// TODO: track related Go issue: https://github.com/golang/go/issues/29228
+		for _, mod := range bi.Deps {
+			if mod.Path == goModule {
+				return mod
+			}
+		}
+	}
+	return &debug.Module{Version: "unknown"}
+}
+
+// goModule is the name of this Go module.
+const goModule = "github.com/mholt/caddy"
+
 // CtxKey is a value type for use with context.WithValue.
 type CtxKey string
 
-- 
cgit v1.2.3