mirror of
https://github.com/caddyserver/caddy.git
synced 2024-12-23 22:27:38 -05:00
ac4fa2c3a9
These changes span work from the last ~4 months in an effort to make Caddy more extensible, reduce the coupling between its components, and lay a more robust foundation of code going forward into 1.0. A bunch of new features have been added, too, with even higher future potential. The most significant design change is an overall inversion of dependencies. Instead of the caddy package knowing about the server and the notion of middleware and config, the caddy package exposes an interface that other components plug into. This does introduce more indirection when reading the code, but every piece is very modular and pluggable. Even the HTTP server is pluggable. The caddy package has been moved to the top level, and main has been pushed into a subfolder called caddy. The actual logic of the main file has been pushed even further into caddy/caddymain/run.go so that custom builds of Caddy can be 'go get'able. The HTTPS logic was surgically separated into two parts to divide the TLS-specific code and the HTTPS-specific code. The caddytls package can now be used by any type of server that needs TLS, not just HTTP. I also added the ability to customize nearly every aspect of TLS at the site level rather than all sites sharing the same TLS configuration. Not all of this flexibility is exposed in the Caddyfile yet, but it may be in the future. Caddy can also generate self-signed certificates in memory for the convenience of a developer working on localhost who wants HTTPS. And Caddy now supports the DNS challenge, assuming at least one DNS provider is plugged in. Dozens, if not hundreds, of other minor changes swept through the code base as I literally started from an empty main function, copying over functions or files as needed, then adjusting them to fit in the new design. Most tests have been restored and adapted to the new API, but more work is needed there. A lot of what was "impossible" before is now possible, or can be made possible with minimal disruption of the code. For example, it's fairly easy to make plugins hook into another part of the code via callbacks. Plugins can do more than just be directives; we now have plugins that customize how the Caddyfile is loaded (useful when you need to get your configuration from a remote store). Site addresses no longer need be just a host and port. They can have a path, allowing you to scope a configuration to a specific path. There is no inheretance, however; each site configuration is distinct. Thanks to amazing work by Lucas Clemente, this commit adds experimental QUIC support. Turn it on using the -quic flag; your browser may have to be configured to enable it. Almost everything is here, but you will notice that most of the middle- ware are missing. After those are transferred over, we'll be ready for beta tests. I'm very excited to get this out. Thanks for everyone's help and patience these last few months. I hope you like it!!
86 lines
2.8 KiB
Go
86 lines
2.8 KiB
Go
package caddy
|
|
|
|
import (
|
|
"strings"
|
|
|
|
"github.com/mholt/caddy/caddyfile"
|
|
)
|
|
|
|
// Controller is given to the setup function of directives which
|
|
// gives them access to be able to read tokens and do whatever
|
|
// they need to do.
|
|
type Controller struct {
|
|
caddyfile.Dispenser
|
|
|
|
// The instance in which the setup is occurring
|
|
instance *Instance
|
|
|
|
// Key is the key from the top of the server block, usually
|
|
// an address, hostname, or identifier of some sort.
|
|
Key string
|
|
|
|
// OncePerServerBlock is a function that executes f
|
|
// exactly once per server block, no matter how many
|
|
// hosts are associated with it. If it is the first
|
|
// time, the function f is executed immediately
|
|
// (not deferred) and may return an error which is
|
|
// returned by OncePerServerBlock.
|
|
OncePerServerBlock func(f func() error) error
|
|
|
|
// ServerBlockIndex is the 0-based index of the
|
|
// server block as it appeared in the input.
|
|
ServerBlockIndex int
|
|
|
|
// ServerBlockKeyIndex is the 0-based index of this
|
|
// key as it appeared in the input at the head of the
|
|
// server block.
|
|
ServerBlockKeyIndex int
|
|
|
|
// ServerBlockKeys is a list of keys that are
|
|
// associated with this server block. All these
|
|
// keys, consequently, share the same tokens.
|
|
ServerBlockKeys []string
|
|
|
|
// ServerBlockStorage is used by a directive's
|
|
// setup function to persist state between all
|
|
// the keys on a server block.
|
|
ServerBlockStorage interface{}
|
|
}
|
|
|
|
// ServerType gets the name of the server type that is being set up.
|
|
func (c *Controller) ServerType() string {
|
|
return c.instance.serverType
|
|
}
|
|
|
|
// OnStartup adds fn to the list of callback functions to execute
|
|
// when the server is about to be started.
|
|
func (c *Controller) OnStartup(fn func() error) {
|
|
c.instance.onStartup = append(c.instance.onStartup, fn)
|
|
}
|
|
|
|
// OnRestart adds fn to the list of callback functions to execute
|
|
// when the server is about to be restarted.
|
|
func (c *Controller) OnRestart(fn func() error) {
|
|
c.instance.onRestart = append(c.instance.onRestart, fn)
|
|
}
|
|
|
|
// OnShutdown adds fn to the list of callback functions to execute
|
|
// when the server is about to be shut down..
|
|
func (c *Controller) OnShutdown(fn func() error) {
|
|
c.instance.onShutdown = append(c.instance.onShutdown, fn)
|
|
}
|
|
|
|
// NewTestController creates a new *Controller for
|
|
// the input specified, with a filename of "Testfile".
|
|
// The Config is bare, consisting only of a Root of cwd.
|
|
//
|
|
// Used primarily for testing but needs to be exported so
|
|
// add-ons can use this as a convenience. Does not initialize
|
|
// the server-block-related fields.
|
|
func NewTestController(input string) *Controller {
|
|
return &Controller{
|
|
instance: &Instance{serverType: ""},
|
|
Dispenser: caddyfile.NewDispenser("Testfile", strings.NewReader(input)),
|
|
OncePerServerBlock: func(f func() error) error { return f() },
|
|
}
|
|
}
|