From c8c57c1dd091540d022cd5d20e8c386dc305937f Mon Sep 17 00:00:00 2001 From: Craig Peterson Date: Wed, 13 Jan 2016 21:03:03 -0700 Subject: [PATCH] moving all main logic into caddy package --- caddy/directives.go | 3 + caddy/main.go | 198 +++++++++++++++++++++++++++++ main_test.go => caddy/main_test.go | 2 +- main.go | 192 +--------------------------- 4 files changed, 203 insertions(+), 192 deletions(-) create mode 100644 caddy/main.go rename main_test.go => caddy/main_test.go (98%) diff --git a/caddy/directives.go b/caddy/directives.go index 37ac6e64a..cf7875355 100644 --- a/caddy/directives.go +++ b/caddy/directives.go @@ -68,6 +68,9 @@ var directiveOrder = []directive{ {"browse", setup.Browse}, } +// RegisterDirective adds the given directive to caddy's list of directives. +// Pass the name of a directive you want it to be placed after, +// otherwise it will be placed at the bottom of the stack. func RegisterDirective(name string, setup SetupFunc, after string) { dir := directive{name: name, setup: setup} idx := len(directiveOrder) diff --git a/caddy/main.go b/caddy/main.go new file mode 100644 index 000000000..3705a437b --- /dev/null +++ b/caddy/main.go @@ -0,0 +1,198 @@ +package caddy + +import ( + "errors" + "flag" + "fmt" + "io/ioutil" + "log" + "os" + "runtime" + "strconv" + "strings" + "time" + + "github.com/mholt/caddy/caddy/letsencrypt" + "github.com/xenolf/lego/acme" +) + +var ( + conf string + cpu string + logfile string + revoke string + version bool +) + +const ( + appName = "Caddy" + appVersion = "0.8.1" +) + +// Main runs all of the logic that the caddy executable runs, including flag parsing, configuration loading, +// and starting the server. This should never return until the server shuts down. +func Main() { + TrapSignals() + flag.BoolVar(&letsencrypt.Agreed, "agree", false, "Agree to Let's Encrypt Subscriber Agreement") + flag.StringVar(&letsencrypt.CAUrl, "ca", "https://acme-v01.api.letsencrypt.org/directory", "Certificate authority ACME server") + flag.StringVar(&conf, "conf", "", "Configuration file to use (default="+DefaultConfigFile+")") + flag.StringVar(&cpu, "cpu", "100%", "CPU cap") + flag.StringVar(&letsencrypt.DefaultEmail, "email", "", "Default Let's Encrypt account email address") + flag.DurationVar(&GracefulTimeout, "grace", 5*time.Second, "Maximum duration of graceful shutdown") + flag.StringVar(&Host, "host", DefaultHost, "Default host") + flag.BoolVar(&HTTP2, "http2", true, "HTTP/2 support") // TODO: temporary flag until http2 merged into std lib + flag.StringVar(&logfile, "log", "", "Process log file") + flag.StringVar(&PidFile, "pidfile", "", "Path to write pid file") + flag.StringVar(&Port, "port", DefaultPort, "Default port") + flag.BoolVar(&Quiet, "quiet", false, "Quiet mode (no initialization output)") + flag.StringVar(&revoke, "revoke", "", "Hostname for which to revoke the certificate") + flag.StringVar(&Root, "root", DefaultRoot, "Root path to default site") + flag.BoolVar(&version, "version", false, "Show version") + + flag.Parse() // called here in main() to allow other packages to set flags in their inits + + AppName = appName + AppVersion = appVersion + acme.UserAgent = appName + "/" + appVersion + + // set up process log before anything bad happens + switch logfile { + case "stdout": + log.SetOutput(os.Stdout) + case "stderr": + log.SetOutput(os.Stderr) + case "": + log.SetOutput(ioutil.Discard) + default: + file, err := os.OpenFile(logfile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644) + if err != nil { + log.Fatalf("Error opening process log file: %v", err) + } + log.SetOutput(file) + } + + if revoke != "" { + err := letsencrypt.Revoke(revoke) + if err != nil { + log.Fatal(err) + } + fmt.Printf("Revoked certificate for %s\n", revoke) + os.Exit(0) + } + if version { + fmt.Printf("%s %s\n", AppName, AppVersion) + os.Exit(0) + } + + // Set CPU cap + err := setCPU(cpu) + if err != nil { + mustLogFatal(err) + } + + // Get Caddyfile input + caddyfile, err := LoadCaddyfile(loadCaddyfile) + if err != nil { + mustLogFatal(err) + } + + // Start your engines + err = Start(caddyfile) + if err != nil { + mustLogFatal(err) + } + + // Twiddle your thumbs + Wait() +} + +// mustLogFatal just wraps log.Fatal() in a way that ensures the +// output is always printed to stderr so the user can see it +// if the user is still there, even if the process log was not +// enabled. If this process is a restart, however, and the user +// might not be there anymore, this just logs to the process log +// and exits. +func mustLogFatal(args ...interface{}) { + if !IsRestart() { + log.SetOutput(os.Stderr) + } + log.Fatal(args...) +} + +func loadCaddyfile() (Input, error) { + // Try -conf flag + if conf != "" { + if conf == "stdin" { + return CaddyfileFromPipe(os.Stdin) + } + + contents, err := ioutil.ReadFile(conf) + if err != nil { + return nil, err + } + + return CaddyfileInput{ + Contents: contents, + Filepath: conf, + RealFile: true, + }, nil + } + + // command line args + if flag.NArg() > 0 { + confBody := Host + ":" + Port + "\n" + strings.Join(flag.Args(), "\n") + return CaddyfileInput{ + Contents: []byte(confBody), + Filepath: "args", + }, nil + } + + // Caddyfile in cwd + contents, err := ioutil.ReadFile(DefaultConfigFile) + if err != nil { + if os.IsNotExist(err) { + return DefaultInput(), nil + } + return nil, err + } + return CaddyfileInput{ + Contents: contents, + Filepath: DefaultConfigFile, + RealFile: true, + }, nil +} + +// setCPU parses string cpu and sets GOMAXPROCS +// according to its value. It accepts either +// a number (e.g. 3) or a percent (e.g. 50%). +func setCPU(cpu string) error { + var numCPU int + + availCPU := runtime.NumCPU() + + if strings.HasSuffix(cpu, "%") { + // Percent + var percent float32 + pctStr := cpu[:len(cpu)-1] + pctInt, err := strconv.Atoi(pctStr) + if err != nil || pctInt < 1 || pctInt > 100 { + return errors.New("invalid CPU value: percentage must be between 1-100") + } + percent = float32(pctInt) / 100 + numCPU = int(float32(availCPU) * percent) + } else { + // Number + num, err := strconv.Atoi(cpu) + if err != nil || num < 1 { + return errors.New("invalid CPU value: provide a number or percent greater than 0") + } + numCPU = num + } + + if numCPU > availCPU { + numCPU = availCPU + } + + runtime.GOMAXPROCS(numCPU) + return nil +} diff --git a/main_test.go b/caddy/main_test.go similarity index 98% rename from main_test.go rename to caddy/main_test.go index 311673164..528288db0 100644 --- a/main_test.go +++ b/caddy/main_test.go @@ -1,4 +1,4 @@ -package main +package caddy import ( "runtime" diff --git a/main.go b/main.go index 813423018..c1ebf155f 100644 --- a/main.go +++ b/main.go @@ -1,199 +1,9 @@ package main import ( - "errors" - "flag" - "fmt" - "io/ioutil" - "log" - "os" - "runtime" - "strconv" - "strings" - "time" - "github.com/mholt/caddy/caddy" - "github.com/mholt/caddy/caddy/letsencrypt" - "github.com/xenolf/lego/acme" ) -var ( - conf string - cpu string - logfile string - revoke string - version bool -) - -const ( - appName = "Caddy" - appVersion = "0.8.1" -) - -func init() { - caddy.TrapSignals() - flag.BoolVar(&letsencrypt.Agreed, "agree", false, "Agree to Let's Encrypt Subscriber Agreement") - flag.StringVar(&letsencrypt.CAUrl, "ca", "https://acme-v01.api.letsencrypt.org/directory", "Certificate authority ACME server") - flag.StringVar(&conf, "conf", "", "Configuration file to use (default="+caddy.DefaultConfigFile+")") - flag.StringVar(&cpu, "cpu", "100%", "CPU cap") - flag.StringVar(&letsencrypt.DefaultEmail, "email", "", "Default Let's Encrypt account email address") - flag.DurationVar(&caddy.GracefulTimeout, "grace", 5*time.Second, "Maximum duration of graceful shutdown") - flag.StringVar(&caddy.Host, "host", caddy.DefaultHost, "Default host") - flag.BoolVar(&caddy.HTTP2, "http2", true, "HTTP/2 support") // TODO: temporary flag until http2 merged into std lib - flag.StringVar(&logfile, "log", "", "Process log file") - flag.StringVar(&caddy.PidFile, "pidfile", "", "Path to write pid file") - flag.StringVar(&caddy.Port, "port", caddy.DefaultPort, "Default port") - flag.BoolVar(&caddy.Quiet, "quiet", false, "Quiet mode (no initialization output)") - flag.StringVar(&revoke, "revoke", "", "Hostname for which to revoke the certificate") - flag.StringVar(&caddy.Root, "root", caddy.DefaultRoot, "Root path to default site") - flag.BoolVar(&version, "version", false, "Show version") -} - func main() { - flag.Parse() // called here in main() to allow other packages to set flags in their inits - - caddy.AppName = appName - caddy.AppVersion = appVersion - acme.UserAgent = appName + "/" + appVersion - - // set up process log before anything bad happens - switch logfile { - case "stdout": - log.SetOutput(os.Stdout) - case "stderr": - log.SetOutput(os.Stderr) - case "": - log.SetOutput(ioutil.Discard) - default: - file, err := os.OpenFile(logfile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0644) - if err != nil { - log.Fatalf("Error opening process log file: %v", err) - } - log.SetOutput(file) - } - - if revoke != "" { - err := letsencrypt.Revoke(revoke) - if err != nil { - log.Fatal(err) - } - fmt.Printf("Revoked certificate for %s\n", revoke) - os.Exit(0) - } - if version { - fmt.Printf("%s %s\n", caddy.AppName, caddy.AppVersion) - os.Exit(0) - } - - // Set CPU cap - err := setCPU(cpu) - if err != nil { - mustLogFatal(err) - } - - // Get Caddyfile input - caddyfile, err := caddy.LoadCaddyfile(loadCaddyfile) - if err != nil { - mustLogFatal(err) - } - - // Start your engines - err = caddy.Start(caddyfile) - if err != nil { - mustLogFatal(err) - } - - // Twiddle your thumbs - caddy.Wait() -} - -// mustLogFatal just wraps log.Fatal() in a way that ensures the -// output is always printed to stderr so the user can see it -// if the user is still there, even if the process log was not -// enabled. If this process is a restart, however, and the user -// might not be there anymore, this just logs to the process log -// and exits. -func mustLogFatal(args ...interface{}) { - if !caddy.IsRestart() { - log.SetOutput(os.Stderr) - } - log.Fatal(args...) -} - -func loadCaddyfile() (caddy.Input, error) { - // Try -conf flag - if conf != "" { - if conf == "stdin" { - return caddy.CaddyfileFromPipe(os.Stdin) - } - - contents, err := ioutil.ReadFile(conf) - if err != nil { - return nil, err - } - - return caddy.CaddyfileInput{ - Contents: contents, - Filepath: conf, - RealFile: true, - }, nil - } - - // command line args - if flag.NArg() > 0 { - confBody := caddy.Host + ":" + caddy.Port + "\n" + strings.Join(flag.Args(), "\n") - return caddy.CaddyfileInput{ - Contents: []byte(confBody), - Filepath: "args", - }, nil - } - - // Caddyfile in cwd - contents, err := ioutil.ReadFile(caddy.DefaultConfigFile) - if err != nil { - if os.IsNotExist(err) { - return caddy.DefaultInput(), nil - } - return nil, err - } - return caddy.CaddyfileInput{ - Contents: contents, - Filepath: caddy.DefaultConfigFile, - RealFile: true, - }, nil -} - -// setCPU parses string cpu and sets GOMAXPROCS -// according to its value. It accepts either -// a number (e.g. 3) or a percent (e.g. 50%). -func setCPU(cpu string) error { - var numCPU int - - availCPU := runtime.NumCPU() - - if strings.HasSuffix(cpu, "%") { - // Percent - var percent float32 - pctStr := cpu[:len(cpu)-1] - pctInt, err := strconv.Atoi(pctStr) - if err != nil || pctInt < 1 || pctInt > 100 { - return errors.New("invalid CPU value: percentage must be between 1-100") - } - percent = float32(pctInt) / 100 - numCPU = int(float32(availCPU) * percent) - } else { - // Number - num, err := strconv.Atoi(cpu) - if err != nil || num < 1 { - return errors.New("invalid CPU value: provide a number or percent greater than 0") - } - numCPU = num - } - - if numCPU > availCPU { - numCPU = availCPU - } - - runtime.GOMAXPROCS(numCPU) - return nil + caddy.Main() }