Extensive refactor, quality of life enhancements

[rbdr/mobius] / cmd / mobius-hotline-server / main.go

diff --git a/cmd/mobius-hotline-server/main.go b/cmd/mobius-hotline-server/main.go
index 2f914c4d1f6a34242dfd180b50ddd67ecb2a1598..04b3c57a3597920b5a15a06df7b4d2c4748d6908 100644 (file)
--- a/cmd/mobius-hotline-server/main.go
+++ b/cmd/mobius-hotline-server/main.go
@@ -7,90 +7,175 @@ import (
        "flag"
        "fmt"
        "github.com/jhalter/mobius/hotline"
        "flag"
        "fmt"
        "github.com/jhalter/mobius/hotline"

-       "go.uber.org/zap"
-       "go.uber.org/zap/zapcore"
+       "github.com/jhalter/mobius/internal/mobius"
+       "gopkg.in/natefinch/lumberjack.v2"

        "io"
        "log"
        "io"
        "log"

-       "math/rand"
+       "log/slog"

        "net/http"
        "os"
        "net/http"
        "os"

-       "runtime"
-       "strings"
-       "time"
+       "os/signal"
+       "path"
+       "path/filepath"
+       "syscall"

 )
 
 //go:embed mobius/config
 var cfgTemplate embed.FS
 
 )
 
 //go:embed mobius/config
 var cfgTemplate embed.FS
 

-const (
-       defaultPort = 5500
+var logLevels = map[string]slog.Level{
+       "debug": slog.LevelDebug,
+       "info":  slog.LevelInfo,
+       "error": slog.LevelError,
+}
+
+// Values swapped in by go-releaser at build time
+var (
+       version = "dev"
+       commit  = "none"
+       date    = "unknown"

 )
 
 func main() {
 )
 
 func main() {

-       rand.Seed(time.Now().UnixNano())
+       ctx, cancel := context.WithCancel(context.Background())

 
 

-       ctx, cancelRoot := context.WithCancel(context.Background())
+       sigChan := make(chan os.Signal, 1)
+       signal.Notify(sigChan, syscall.SIGTERM, syscall.SIGHUP, syscall.SIGINT, os.Interrupt)

 
 

-       basePort := flag.Int("bind", defaultPort, "Bind address and port")
+       netInterface := flag.String("interface", "", "IP addr of interface to listen on.  Defaults to all interfaces.")
+       basePort := flag.Int("bind", 5500, "Base Hotline server port.  File transfer port is base port + 1.")

        statsPort := flag.String("stats-port", "", "Enable stats HTTP endpoint on address and port")
        statsPort := flag.String("stats-port", "", "Enable stats HTTP endpoint on address and port")

-       configDir := flag.String("config", defaultConfigPath(), "Path to config root")
-       version := flag.Bool("version", false, "print version and exit")
+       configDir := flag.String("config", configSearchPaths(), "Path to config root")
+       printVersion := flag.Bool("version", false, "Print version and exit")

        logLevel := flag.String("log-level", "info", "Log level")
        logLevel := flag.String("log-level", "info", "Log level")

+       logFile := flag.String("log-file", "", "Path to log file")

        init := flag.Bool("init", false, "Populate the config dir with default configuration")
 
        flag.Parse()
 
        init := flag.Bool("init", false, "Populate the config dir with default configuration")
 
        flag.Parse()
 

-       if *version {
-               fmt.Printf("v%s\n", hotline.VERSION)
-               os.Exit(0)
-       }
-
-       zapLvl, ok := zapLogLevel[*logLevel]
-       if !ok {
-               fmt.Printf("Invalid log level %s.  Must be debug, info, warn, or error.\n", *logLevel)
+       if *printVersion {
+               fmt.Printf("mobius-hotline-server %s, commit %s, built at %s", version, commit, date)

                os.Exit(0)
        }
 
                os.Exit(0)
        }
 

-       cores := []zapcore.Core{newStdoutCore(zapLvl)}
-       l := zap.New(zapcore.NewTee(cores...))
-       defer func() { _ = l.Sync() }()
-       logger := l.Sugar()
-
-       if !(strings.HasSuffix(*configDir, "/") || strings.HasSuffix(*configDir, "\\")) {
-               *configDir = *configDir + "/"
-       }
+       slogger := slog.New(
+               slog.NewTextHandler(
+                       io.MultiWriter(os.Stdout, &lumberjack.Logger{
+                               Filename:   *logFile,
+                               MaxSize:    100, // MB
+                               MaxBackups: 3,
+                               MaxAge:     365, // days
+                       }),
+                       &slog.HandlerOptions{Level: logLevels[*logLevel]},
+               ),
+       )

 
 

+       // It's important for Windows compatibility to use path.Join and not filepath.Join for the config dir initialization.
+       // https://github.com/golang/go/issues/44305

        if *init {
        if *init {

-               if _, err := os.Stat(*configDir + "/config.yaml"); os.IsNotExist(err) {
+               if _, err := os.Stat(path.Join(*configDir, "/config.yaml")); os.IsNotExist(err) {

                        if err := os.MkdirAll(*configDir, 0750); err != nil {
                        if err := os.MkdirAll(*configDir, 0750); err != nil {

-                               logger.Fatal(err)
+                               slogger.Error(fmt.Sprintf("error creating config dir: %s", err))
+                               os.Exit(1)

                        }
                        }

-
-                       if err := copyDir("mobius/config", *configDir); err != nil {
-                               logger.Fatal(err)
+                       if err := copyDir(path.Join("mobius", "config"), *configDir); err != nil {
+                               slogger.Error(fmt.Sprintf("error copying config dir: %s", err))
+                               os.Exit(1)

                        }
                        }

-                       logger.Infow("Config dir initialized at " + *configDir)
-
+                       slogger.Info("Config dir initialized at " + *configDir)

                } else {
                } else {

-                       logger.Infow("Existing config dir found.  Skipping initialization.")
+                       slogger.Info("Existing config dir found.  Skipping initialization.")

                }
        }
 
                }
        }
 

-       if _, err := os.Stat(*configDir); os.IsNotExist(err) {
-               logger.Fatalw("Configuration directory not found", "path", configDir)
+       config, err := mobius.LoadConfig(path.Join(*configDir, "config.yaml"))
+       if err != nil {
+               slogger.Error(fmt.Sprintf("Error loading config: %v", err))
+               os.Exit(1)
+       }
+
+       srv, err := hotline.NewServer(
+               hotline.WithInterface(*netInterface),
+               hotline.WithLogger(slogger),
+               hotline.WithPort(*basePort),
+               hotline.WithConfig(*config),
+       )
+       if err != nil {
+               slogger.Error(fmt.Sprintf("Error starting server: %s", err))
+               os.Exit(1)
+       }
+
+       srv.MessageBoard, err = mobius.NewFlatNews(path.Join(*configDir, "MessageBoard.txt"))
+       if err != nil {
+               slogger.Error(fmt.Sprintf("Error loading message board: %v", err))
+               os.Exit(1)
+       }
+
+       srv.BanList, err = mobius.NewBanFile(path.Join(*configDir, "Banlist.yaml"))
+       if err != nil {
+               slogger.Error(fmt.Sprintf("Error loading ban list: %v", err))
+               os.Exit(1)
+       }
+
+       srv.ThreadedNewsMgr, err = mobius.NewThreadedNewsYAML(path.Join(*configDir, "ThreadedNews.yaml"))
+       if err != nil {
+               slogger.Error(fmt.Sprintf("Error loading news: %v", err))
+               os.Exit(1)
+       }
+
+       srv.AccountManager, err = mobius.NewYAMLAccountManager(filepath.Join(*configDir, "Users/"))
+       if err != nil {
+               slogger.Error(fmt.Sprintf("Error loading accounts: %v", err))
+               os.Exit(1)
+       }
+
+       srv.Agreement, err = mobius.NewAgreement(*configDir, "\r")
+       if err != nil {
+               slogger.Error(fmt.Sprintf("Error loading agreement: %v", err))
+               os.Exit(1)

        }
 
        }
 

-       srv, err := hotline.NewServer(*configDir, "", *basePort, logger, &hotline.OSFileStore{})
+       bannerPath := filepath.Join(*configDir, config.BannerFile)
+       srv.Banner, err = os.ReadFile(bannerPath)

        if err != nil {
        if err != nil {

-               logger.Fatal(err)
+               slogger.Error(fmt.Sprintf("Error loading accounts: %v", err))
+               os.Exit(1)

        }
 
        }
 

-       sh := statHandler{hlServer: srv}
+       reloadFunc := func() {
+               if err := srv.MessageBoard.(*mobius.FlatNews).Reload(); err != nil {
+                       slogger.Error("Error reloading news", "err", err)
+               }
+
+               if err := srv.BanList.(*mobius.BanFile).Load(); err != nil {
+                       slogger.Error("Error reloading ban list", "err", err)
+               }
+
+               if err := srv.ThreadedNewsMgr.(*mobius.ThreadedNewsYAML).Load(); err != nil {
+                       slogger.Error("Error reloading threaded news list", "err", err)
+               }
+
+               if err := srv.Agreement.(*mobius.Agreement).Reload(); err != nil {
+                       slogger.Error(fmt.Sprintf("Error reloading agreement: %v", err))
+                       os.Exit(1)
+               }
+       }
+
+       reloadHandler := func(reloadFunc func()) func(w http.ResponseWriter, _ *http.Request) {
+               return func(w http.ResponseWriter, _ *http.Request) {
+                       reloadFunc()
+
+                       _, _ = io.WriteString(w, `{ "msg": "config reloaded" }`)
+               }
+       }
+
+       sh := APIHandler{hlServer: srv}

        if *statsPort != "" {
                http.HandleFunc("/", sh.RenderStats)
        if *statsPort != "" {
                http.HandleFunc("/", sh.RenderStats)

+               http.HandleFunc("/api/v1/stats", sh.RenderStats)
+               http.HandleFunc("/api/v1/reload", reloadHandler(reloadFunc))

 
                go func(srv *hotline.Server) {
 
                go func(srv *hotline.Server) {

-                       // Use the default DefaultServeMux.

                        err = http.ListenAndServe(":"+*statsPort, nil)
                        if err != nil {
                                log.Fatal(err)
                        err = http.ListenAndServe(":"+*statsPort, nil)
                        if err != nil {
                                log.Fatal(err)


@@ -98,16 +183,43 @@ func main() {
                }(srv)
        }
 
                }(srv)
        }
 

+       go func() {
+               for {
+                       sig := <-sigChan
+                       switch sig {
+                       case syscall.SIGHUP:
+                               slogger.Info("SIGHUP received.  Reloading configuration.")
+
+                               reloadFunc()
+                       default:
+                               signal.Stop(sigChan)
+                               cancel()
+                               os.Exit(0)
+                       }
+
+               }
+       }()
+
+       slogger.Info("Hotline server started",
+               "version", version,
+               "config", *configDir,
+               "API port", fmt.Sprintf("%s:%v", *netInterface, *basePort),
+               "Transfer port", fmt.Sprintf("%s:%v", *netInterface, *basePort+1),
+       )
+
+       // Assign functions to handle specific Hotline transaction types
+       mobius.RegisterHandlers(srv)
+

        // Serve Hotline requests until program exit
        // Serve Hotline requests until program exit

-       logger.Fatal(srv.ListenAndServe(ctx, cancelRoot))
+       log.Fatal(srv.ListenAndServe(ctx))

 }
 
 }
 

-type statHandler struct {
+type APIHandler struct {

        hlServer *hotline.Server
 }
 
        hlServer *hotline.Server
 }
 

-func (sh *statHandler) RenderStats(w http.ResponseWriter, _ *http.Request) {
-       u, err := json.Marshal(sh.hlServer.Stats)
+func (sh *APIHandler) RenderStats(w http.ResponseWriter, _ *http.Request) {
+       u, err := json.Marshal(sh.hlServer.CurrentStats())

        if err != nil {
                panic(err)
        }
        if err != nil {
                panic(err)
        }


@@ -115,45 +227,17 @@ func (sh *statHandler) RenderStats(w http.ResponseWriter, _ *http.Request) {
        _, _ = io.WriteString(w, string(u))
 }
 
        _, _ = io.WriteString(w, string(u))
 }
 

-func newStdoutCore(level zapcore.Level) zapcore.Core {
-       encoderCfg := zap.NewProductionEncoderConfig()
-       encoderCfg.TimeKey = "timestamp"
-       encoderCfg.EncodeTime = zapcore.ISO8601TimeEncoder
-
-       return zapcore.NewCore(
-               zapcore.NewConsoleEncoder(encoderCfg),
-               zapcore.Lock(os.Stdout),
-               level,
-       )
-}
-
-var zapLogLevel = map[string]zapcore.Level{
-       "debug": zap.DebugLevel,
-       "info":  zap.InfoLevel,
-       "warn":  zap.WarnLevel,
-       "error": zap.ErrorLevel,
-}
-
-func defaultConfigPath() (cfgPath string) {
-       switch runtime.GOOS {
-       case "windows":
-               cfgPath = "config/"
-       case "darwin":
-               if _, err := os.Stat("/usr/local/var/mobius/config/"); err == nil {
-                       cfgPath = "/usr/local/var/mobius/config/"
-               } else if _, err := os.Stat("/opt/homebrew/var/mobius/config"); err == nil {
-                       cfgPath = "/opt/homebrew/var/mobius/config/"
+func configSearchPaths() string {
+       for _, cfgPath := range mobius.ConfigSearchOrder {
+               if _, err := os.Stat(cfgPath); err == nil {
+                       return cfgPath

                }
                }

-       case "linux":
-               cfgPath = "/usr/local/var/mobius/config/"
-       default:
-               fmt.Printf("unsupported OS")

        }
 
        }
 

-       return cfgPath
+       return "config"

 }
 
 }
 

-// TODO: Simplify this mess.  Why is it so difficult to recursively copy a directory?
+// copyDir recursively copies a directory tree, attempting to preserve permissions.

 func copyDir(src, dst string) error {
        entries, err := cfgTemplate.ReadDir(src)
        if err != nil {
 func copyDir(src, dst string) error {
        entries, err := cfgTemplate.ReadDir(src)
        if err != nil {


@@ -161,33 +245,33 @@ func copyDir(src, dst string) error {
        }
        for _, dirEntry := range entries {
                if dirEntry.IsDir() {
        }
        for _, dirEntry := range entries {
                if dirEntry.IsDir() {

-                       if err := os.MkdirAll(dst+"/"+dirEntry.Name(), 0777); err != nil {
+                       if err := os.MkdirAll(path.Join(dst, dirEntry.Name()), 0777); err != nil {

                                panic(err)
                        }
                                panic(err)
                        }

-                       subdirEntries, _ := cfgTemplate.ReadDir(src + "/" + dirEntry.Name())
+                       subdirEntries, _ := cfgTemplate.ReadDir(path.Join(src, dirEntry.Name()))

                        for _, subDirEntry := range subdirEntries {
                        for _, subDirEntry := range subdirEntries {

-                               f, err := os.Create(dst + "/" + dirEntry.Name() + "/" + subDirEntry.Name())
+                               f, err := os.Create(path.Join(dst, dirEntry.Name(), subDirEntry.Name()))

                                if err != nil {
                                        return err
                                }
 
                                if err != nil {
                                        return err
                                }
 

-                               srcFile, err := cfgTemplate.Open(src + "/" + dirEntry.Name() + "/" + subDirEntry.Name())
+                               srcFile, err := cfgTemplate.Open(path.Join(src, dirEntry.Name(), subDirEntry.Name()))

                                if err != nil {
                                if err != nil {

-                                       return err
+                                       return fmt.Errorf("error copying srcFile: %w", err)

                                }
                                _, err = io.Copy(f, srcFile)
                                if err != nil {
                                        return err
                                }
                                }
                                _, err = io.Copy(f, srcFile)
                                if err != nil {
                                        return err
                                }

-                               f.Close()
+                               _ = f.Close()

                        }
                } else {
                        }
                } else {

-                       f, err := os.Create(dst + "/" + dirEntry.Name())
+                       f, err := os.Create(path.Join(dst, dirEntry.Name()))

                        if err != nil {
                                return err
                        }
 
                        if err != nil {
                                return err
                        }
 

-                       srcFile, err := cfgTemplate.Open(src + "/" + dirEntry.Name())
+                       srcFile, err := cfgTemplate.Open(path.Join(src, dirEntry.Name()))

                        if err != nil {
                                return err
                        }
                        if err != nil {
                                return err
                        }


@@ -195,9 +279,8 @@ func copyDir(src, dst string) error {
                        if err != nil {
                                return err
                        }
                        if err != nil {
                                return err
                        }

-                       f.Close()
+                       _ = f.Close()

                }
                }

-

        }
 
        return nil
        }
 
        return nil