Use flag instead of flags

Author: crooks

chain.go

@@ -99,7 +99,7 @@ func makeChain(inChain []string) (outChain []string, err error) {
 				log.Warn("No candidate remailers match selection criteria")
 			}
 
-			if len(candidates) == 0 && flags.Remailer {
+			if len(candidates) == 0 && flag.Remailer {
 				log.Warn("Relaxing latency and uptime criteria to build chain")
 				if len(outChain) == 0 {
 					// Construct a list of suitable exit remailers

client.go

@@ -31,19 +31,19 @@ func readMessage(filename string) []byte {
 		fmt.Fprintf(os.Stderr, "%s: Malformed mail message\n", filename)
 		os.Exit(1)
 	}
-	if flags.To != "" {
-		msg.Header["To"] = []string{flags.To}
-		if !strings.Contains(flags.To, "@") {
+	if flag.To != "" {
+		msg.Header["To"] = []string{flag.To}
+		if !strings.Contains(flag.To, "@") {
 			fmt.Fprintf(
 				os.Stderr,
 				"%s: Recipient doesn't appear to be an "+
 					"email address\n",
-				flags.To,
+				flag.To,
 			)
 		}
 	}
-	if flags.Subject != "" {
-		msg.Header["Subject"] = []string{flags.Subject}
+	if flag.Subject != "" {
+		msg.Header["Subject"] = []string{flag.Subject}
 	}
 	return assemble(*msg)
 }
@@ -59,20 +59,20 @@ func mixprep() {
 	var plain []byte
 	// final is consistent across multiple copies so we define it early
 	final := newSlotFinal()
-	if len(flags.Args) == 0 {
+	if len(flag.Args) == 0 {
 		//fmt.Println("Enter message, complete with headers.  Ctrl-D to finish")
 		plain, err = ioutil.ReadAll(os.Stdin)
 		if err != nil {
 			fmt.Fprintln(os.Stderr, err)
 			os.Exit(1)
 		}
-	} else if len(flags.Args) == 1 {
+	} else if len(flag.Args) == 1 {
 		// A single arg should be the filename
-		plain = readMessage(flags.Args[0])
-	} else if len(flags.Args) >= 2 {
+		plain = readMessage(flag.Args[0])
+	} else if len(flag.Args) >= 2 {
 		// Two args should be recipient and filename
-		flags.To = flags.Args[0]
-		plain = readMessage(flags.Args[1])
+		flag.To = flag.Args[0]
+		plain = readMessage(flag.Args[1])
 	}
 	// plainLen is the length of the plain byte message and can exceed
 	// the total body size of the payload.
@@ -107,10 +107,10 @@ func mixprep() {
 	// Read the chain from flag or config
 	var inChain []string
 	var inChainFunc []string
-	if flags.Chain == "" {
+	if flag.Chain == "" {
 		inChain = strings.Split(cfg.Stats.Chain, ",")
 	} else {
-		inChain = strings.Split(flags.Chain, ",")
+		inChain = strings.Split(flag.Chain, ",")
 	}
 	if len(inChain) == 0 {
 		err = errors.New("empty input chain")
@@ -136,15 +136,15 @@ func mixprep() {
 		}
 		gotExit = false
 		// If no copies flag is specified, use the config file NUMCOPIES
-		if flags.Copies == 0 {
-			flags.Copies = cfg.Stats.Numcopies
+		if flag.Copies == 0 {
+			flag.Copies = cfg.Stats.Numcopies
 		}
-		if flags.Copies > maxCopies {
+		if flag.Copies > maxCopies {
 			// Limit copies to a maximum of 10
-			flags.Copies = maxCopies
+			flag.Copies = maxCopies
 		}
 		// Copies loop begins here
-		for n := 0; n < flags.Copies; n++ {
+		for n := 0; n < flag.Copies; n++ {
 			if gotExit {
 				// Set the last node in the chain to the
 				// previously select exitnode
@@ -169,7 +169,7 @@ func mixprep() {
 			// Retain the entry hop.  We need to mail the message to it.
 			sendTo := chain[0]
 			// Report the chain if we're running as a client.
-			if flags.Client {
+			if flag.Client {
 				log.Infof("Chain: %s\n", strings.Join(chain, ","))
 			}
 			yamnMsg := encodeMsg(
@@ -182,7 +182,7 @@ func mixprep() {
 	} // End of fragments loop
 
 	// Decide if we want to inject a dummy
-	if !flags.NoDummy && Pubring.HaveStats() && crandom.Dice() < 80 {
+	if !flag.NoDummy && Pubring.HaveStats() && crandom.Dice() < 80 {
 		dummy()
 	}
 }
@@ -333,10 +333,10 @@ func dummy() {
 	plainMsg := []byte("I hope Len approves")
 	// Make a single hop chain with a random node
 	var inChain []string
-	if flags.Chain == "" {
+	if flag.Chain == "" {
 		inChain = []string{"*", "*"}
 	} else {
-		inChain = strings.Split(flags.Chain, ",")
+		inChain = strings.Split(flag.Chain, ",")
 	}
 	final := newSlotFinal()
 	// Override the default delivery method (255 = Dummy)

config/config.go

@@ -2,6 +2,7 @@ package config
 
 import (
 	"flag"
+	"fmt"
 	"io/ioutil"
 	"os"
 	"path"
@@ -107,6 +108,22 @@ type Flags struct {
 	MemInfo  bool
 }
 
+// GetCfg parses the command line flags and config file if they haven't been previously parsed.
+// This should be an init function but tests fail if flags are parsed in init.
+//  See: https://github.com/golang/go/issues/46869
+func GetCfg() (*Flags, *Config) {
+	var err error
+	f := ParseFlags()
+	// Some config defaults are derived from flags so ParseConfig is a flags method
+	c, err := f.ParseConfig()
+	if err != nil {
+		// No logging is defined at this point so log the error to stderr
+		fmt.Fprintf(os.Stderr, "Unable to parse config file: %v", err)
+		os.Exit(1)
+	}
+	return f, c
+}
+
 // WriteConfig will write the current config to a given filename
 func (c *Config) WriteConfig(filename string) error {
 	data, err := yaml.Marshal(c)
@@ -139,15 +156,11 @@ func ParseFlags() *Flags {
 	flag.BoolVar(&f.Send, "send", false, "Force pool send")
 	flag.BoolVar(&f.Send, "S", false, "Force pool send")
 	// Perform remailer actions
-	flag.BoolVar(&f.Remailer, "remailer", false,
-		"Perform routine remailer actions")
-	flag.BoolVar(&f.Remailer, "M", false,
-		"Perform routine remailer actions")
+	flag.BoolVar(&f.Remailer, "remailer", false, "Perform routine remailer actions")
+	flag.BoolVar(&f.Remailer, "M", false, "Perform routine remailer actions")
 	// Start remailer as a daemon
-	flag.BoolVar(&f.Daemon, "daemon", false,
-		"Start remailer as a daemon. (Requires -M")
-	flag.BoolVar(&f.Daemon, "D", false,
-		"Start remailer as a daemon. (Requires -M")
+	flag.BoolVar(&f.Daemon, "daemon", false, "Start remailer as a daemon. (Requires -M)")
+	flag.BoolVar(&f.Daemon, "D", false, "Start remailer as a daemon. (Requires -M)")
 	// Remailer chain
 	flag.StringVar(&f.Chain, "chain", "", "Remailer chain")
 	flag.StringVar(&f.Chain, "l", "", "Remailer chain")
@@ -158,8 +171,8 @@ func ParseFlags() *Flags {
 	flag.StringVar(&f.Subject, "subject", "", "Subject header")
 	flag.StringVar(&f.Subject, "s", "", "Subject header")
 	// Number of copies
-	flag.IntVar(&f.Copies, "copies", 0, "Number of copies")
-	flag.IntVar(&f.Copies, "c", 0, "Number of copies")
+	flag.IntVar(&f.Copies, "copies", 2, "Number of copies")
+	flag.IntVar(&f.Copies, "c", 2, "Number of copies")
 	// Config file
 	flag.StringVar(&f.Config, "config", "", "Config file")
 	// Read STDIN

config/config_test.go

@@ -9,8 +9,6 @@ import (
 func TestFlags(t *testing.T) {
 	expectedClient := false
 	expectedCopies := 0
-
-	// This needs to be set prior to doing ParseFlags()
 	f := ParseFlags()
 	if f.Client != expectedClient {
 		t.Errorf("Expected Client to contain \"%v\" but got \"%v\".", expectedClient, f.Client)

go.mod

@@ -13,4 +13,4 @@ require (
 	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
 )
 
-replace github.com/Masterminds/log-go v0.4.0 => github.com/crooks/log-go v0.4.1
+replace github.com/Masterminds/log-go v0.4.0 => github.com/crooks/log-go v0.4.1

go.sum

@@ -1,6 +1,4 @@
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
-github.com/Masterminds/log-go v0.4.0 h1:RkiJ3U65qjGtHRfV2T74DurURYDDz0sBs7U383hC3Qs=
-github.com/Masterminds/log-go v0.4.0/go.mod h1:xPgU2yZAUbQCkvzB2I8OaqV5OFqOmq907g++YvJDL5Y=
 github.com/crooks/log-go v0.4.1 h1:YVUpOxLAwCW0DWcxE6g4xEeMhODljWyNmGG09a/aGlw=
 github.com/crooks/log-go v0.4.1/go.mod h1:xPgU2yZAUbQCkvzB2I8OaqV5OFqOmq907g++YvJDL5Y=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

pool.go

@@ -47,7 +47,7 @@ func serverPoolOutboundSend() {
 // on clients, where all messages should be sent instantly after creation.
 func poolOutboundSend() {
 	var err error
-	if cfg.Remailer.Daemon || flags.Daemon {
+	if cfg.Remailer.Daemon || flag.Daemon {
 		// This should never happen.  If the server is started as a
 		// daemon, the serverPoolOutboundSend process is initiated and
 		// runs in an endless loop.  This function would conflict with
@@ -62,7 +62,7 @@ func poolOutboundSend() {
 		log.Warnf("Reading pool failed: %s", err)
 		return
 	}
-	if flags.Remailer {
+	if flag.Remailer {
 		// During normal operation, the pool shouldn't be flushed.
 		log.Warn("Flushing outbound remailer pool")
 	}

server.go

@@ -83,7 +83,7 @@ func loopServer() (err error) {
 	oneDay := time.Duration(dayLength) * time.Second
 
 	// Determine if this is a single run or the start of a Daemon
-	runAsDaemon := cfg.Remailer.Daemon || flags.Daemon
+	runAsDaemon := cfg.Remailer.Daemon || flag.Daemon
 
 	// Actually start the server loop
 	if runAsDaemon {
@@ -252,15 +252,15 @@ func nagOperator() {
 		)
 	}
 	// Complain about high pool rates.
-	if cfg.Pool.Rate > 90 && !flags.Send {
+	if cfg.Pool.Rate > 90 && !flag.Send {
 		log.Warnf(
 			"Your pool rate of %d is excessively high. Unless "+
 				"testing, a lower setting is recommended.",
 			cfg.Pool.Rate,
 		)
 	}
 	// Complain about running a remailer with flag_send
-	if flags.Send && flags.Remailer {
+	if flag.Send && flag.Remailer {
 		log.Warnf(
 			"Your remailer will flush the outbound pool every "+
 				"%d seconds. Unless you're testing, this is "+
@@ -418,7 +418,7 @@ func decodeV2(d *decMessage, slotDataBytes []byte) (err error) {
 			writeMessageToPool(inter.getNextHop(), d.getPayload())
 			stats.outYamn++
 			// Decide if we want to inject a dummy
-			if !flags.NoDummy && crandom.Dice() < 55 {
+			if !flag.NoDummy && crandom.Dice() < 55 {
 				dummy()
 				stats.outDummy++
 			}

yamn.go

@@ -3,6 +3,7 @@ package main
 import (
 	"fmt"
 	"io/ioutil"
+	stdlog "log"
 	"os"
 
 	"github.com/Masterminds/log-go"
@@ -24,17 +25,9 @@ const (
 
 var (
 	// flags - Command line flags
-	flags *config.Flags
+	flag *config.Flags
 	// cfg - Config parameters
 	cfg *config.Config
-	// Trace loglevel
-	Trace *log.Logger
-	// Info loglevel
-	Info *log.Logger
-	// Warn loglevel
-	Warn *log.Logger
-	// Error loglevel
-	Error *log.Logger
 	// Pubring - Public Keyring
 	Pubring *keymgr.Pubring
 	// IDDb - Message ID log (replay protection)
@@ -45,20 +38,13 @@ var (
 
 func main() {
 	var err error
-	flags = config.ParseFlags()
-	if flags.Version {
+	flag, cfg = config.GetCfg()
+	if flag.Version {
 		fmt.Println(version)
 		os.Exit(0)
 	}
-	// Some config defaults are derived from flags so ParseConfig is a flags method
-	cfg, err = flags.ParseConfig()
-	if err != nil {
-		// No logging is defined at this point so log the error to stderr
-		fmt.Fprintf(os.Stderr, "Unable to parse config file: %v", err)
-		os.Exit(1)
-	}
 	// If the debug flag is set, print the config and exit
-	if flags.Debug {
+	if flag.Debug {
 		y, err := cfg.Debug()
 		if err != nil {
 			fmt.Printf("Debugging Error: %s\n", err)
@@ -74,6 +60,15 @@ func main() {
 		fmt.Fprintf(os.Stderr, "%s: Unknown loglevel", cfg.General.Loglevel)
 		os.Exit(1)
 	}
+	// If we're logging to a file, open the file and redirect output to it
+	if cfg.General.LogToFile {
+		logfile, err := os.OpenFile(cfg.Files.Logfile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "%s: Error opening logfile: %v", cfg.Files.Logfile, err)
+			os.Exit(1)
+		}
+		stdlog.SetOutput(logfile)
+	}
 	log.Current = log.StdLogger{Level: loglevel}
 
 	// Inform the user which (if any) config file was used.
@@ -84,9 +79,9 @@ func main() {
 	}
 
 	// Setup complete, time to do some work
-	if flags.Client {
+	if flag.Client {
 		mixprep()
-	} else if flags.Stdin {
+	} else if flag.Stdin {
 		dir := maildir.Dir(cfg.Files.Maildir)
 		newmsg, err := dir.NewDelivery()
 		if err != nil {
@@ -100,20 +95,20 @@ func main() {
 		}
 		newmsg.Write(stdin)
 		newmsg.Close()
-	} else if flags.Remailer {
+	} else if flag.Remailer {
 		err = loopServer()
 		if err != nil {
 			panic(err)
 		}
-	} else if flags.Dummy {
+	} else if flag.Dummy {
 		injectDummy()
-	} else if flags.Refresh {
+	} else if flag.Refresh {
 		fmt.Printf("Keyring refresh: from=%s, to=%s\n", cfg.Urls.Pubring, cfg.Files.Pubring)
 		httpGet(cfg.Urls.Pubring, cfg.Files.Pubring)
 		fmt.Printf("Stats refresh: from=%s, to=%s\n", cfg.Urls.Mlist2, cfg.Files.Mlist2)
 		httpGet(cfg.Urls.Mlist2, cfg.Files.Mlist2)
 	}
-	if flags.Send {
+	if flag.Send {
 		// Flush the outbound pool
 		poolOutboundSend()
 	}