mirror of
https://github.com/caddyserver/caddy.git
synced 2025-05-24 02:02:26 -04:00
caddyfile: Support global config block; allow non-empty blocks w/ 0 keys
This commit is contained in:
parent
a0fd2b6c0a
commit
af25f0254e
@ -29,15 +29,15 @@ type Adapter struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Adapt converts the Caddyfile config in body to Caddy JSON.
|
// Adapt converts the Caddyfile config in body to Caddy JSON.
|
||||||
func (a Adapter) Adapt(body []byte, options map[string]string) ([]byte, []caddyconfig.Warning, error) {
|
func (a Adapter) Adapt(body []byte, options map[string]interface{}) ([]byte, []caddyconfig.Warning, error) {
|
||||||
if a.ServerType == nil {
|
if a.ServerType == nil {
|
||||||
return nil, nil, fmt.Errorf("no server type")
|
return nil, nil, fmt.Errorf("no server type")
|
||||||
}
|
}
|
||||||
if options == nil {
|
if options == nil {
|
||||||
options = make(map[string]string)
|
options = make(map[string]interface{})
|
||||||
}
|
}
|
||||||
|
|
||||||
filename := options["filename"]
|
filename, _ := options["filename"].(string)
|
||||||
if filename == "" {
|
if filename == "" {
|
||||||
filename = "Caddyfile"
|
filename = "Caddyfile"
|
||||||
}
|
}
|
||||||
@ -80,7 +80,7 @@ type ServerType interface {
|
|||||||
// (e.g. CLI flags) and creates a Caddy
|
// (e.g. CLI flags) and creates a Caddy
|
||||||
// config, along with any warnings or
|
// config, along with any warnings or
|
||||||
// an error.
|
// an error.
|
||||||
Setup([]ServerBlock, map[string]string) (*caddy.Config, []caddyconfig.Warning, error)
|
Setup([]ServerBlock, map[string]interface{}) (*caddy.Config, []caddyconfig.Warning, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Interface guard
|
// Interface guard
|
||||||
|
@ -186,10 +186,10 @@ func (d *Dispenser) File() string {
|
|||||||
|
|
||||||
// Args is a convenience function that loads the next arguments
|
// Args is a convenience function that loads the next arguments
|
||||||
// (tokens on the same line) into an arbitrary number of strings
|
// (tokens on the same line) into an arbitrary number of strings
|
||||||
// pointed to in targets. If there are fewer tokens available
|
// pointed to in targets. If there are not enough argument tokens
|
||||||
// than string pointers, the remaining strings will not be changed
|
// available to fill targets, false is returned and the remaining
|
||||||
// and false will be returned. If there were enough tokens available
|
// targets are left unchanged. If all the targets are filled,
|
||||||
// to fill the arguments, then true will be returned.
|
// then true is returned.
|
||||||
func (d *Dispenser) Args(targets ...*string) bool {
|
func (d *Dispenser) Args(targets ...*string) bool {
|
||||||
for i := 0; i < len(targets); i++ {
|
for i := 0; i < len(targets); i++ {
|
||||||
if !d.NextArg() {
|
if !d.NextArg() {
|
||||||
@ -200,6 +200,21 @@ func (d *Dispenser) Args(targets ...*string) bool {
|
|||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AllArgs is like Args, but if there are more argument tokens
|
||||||
|
// available than there are targets, false is returned. The
|
||||||
|
// number of available argument tokens must match the number of
|
||||||
|
// targets exactly to return true.
|
||||||
|
func (d *Dispenser) AllArgs(targets ...*string) bool {
|
||||||
|
if !d.Args(targets...) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if d.NextArg() {
|
||||||
|
d.Prev()
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
// RemainingArgs loads any more arguments (tokens on the same line)
|
// RemainingArgs loads any more arguments (tokens on the same line)
|
||||||
// into a slice and returns them. Open curly brace tokens also indicate
|
// into a slice and returns them. Open curly brace tokens also indicate
|
||||||
// the end of arguments, and the curly brace is not included in
|
// the end of arguments, and the curly brace is not included in
|
||||||
|
@ -70,7 +70,7 @@ func (p *parser) parseAll() ([]ServerBlock, error) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return blocks, err
|
return blocks, err
|
||||||
}
|
}
|
||||||
if len(p.block.Keys) > 0 {
|
if len(p.block.Keys) > 0 || len(p.block.Segments) > 0 {
|
||||||
blocks = append(blocks, p.block)
|
blocks = append(blocks, p.block)
|
||||||
}
|
}
|
||||||
if p.nesting > 0 {
|
if p.nesting > 0 {
|
||||||
|
@ -22,7 +22,7 @@ import (
|
|||||||
// Adapter is a type which can adapt a configuration to Caddy JSON.
|
// Adapter is a type which can adapt a configuration to Caddy JSON.
|
||||||
// It returns the results and any warnings, or an error.
|
// It returns the results and any warnings, or an error.
|
||||||
type Adapter interface {
|
type Adapter interface {
|
||||||
Adapt(body []byte, options map[string]string) ([]byte, []Warning, error)
|
Adapt(body []byte, options map[string]interface{}) ([]byte, []Warning, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Warning represents a warning or notice related to conversion.
|
// Warning represents a warning or notice related to conversion.
|
||||||
|
53
caddyconfig/httpcaddyfile/global.go
Normal file
53
caddyconfig/httpcaddyfile/global.go
Normal file
@ -0,0 +1,53 @@
|
|||||||
|
// Copyright 2015 Matthew Holt and The Caddy Authors
|
||||||
|
//
|
||||||
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
// you may not use this file except in compliance with the License.
|
||||||
|
// You may obtain a copy of the License at
|
||||||
|
//
|
||||||
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
//
|
||||||
|
// Unless required by applicable law or agreed to in writing, software
|
||||||
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
// See the License for the specific language governing permissions and
|
||||||
|
// limitations under the License.
|
||||||
|
|
||||||
|
package httpcaddyfile
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
|
||||||
|
)
|
||||||
|
|
||||||
|
func parseHTTPPort(d *caddyfile.Dispenser) (int, error) {
|
||||||
|
var httpPort int
|
||||||
|
for d.Next() {
|
||||||
|
var httpPortStr string
|
||||||
|
if !d.AllArgs(&httpPortStr) {
|
||||||
|
return 0, d.ArgErr()
|
||||||
|
}
|
||||||
|
var err error
|
||||||
|
httpPort, err = strconv.Atoi(httpPortStr)
|
||||||
|
if err != nil {
|
||||||
|
return 0, d.Errf("converting port '%s' to integer value: %v", httpPortStr, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return httpPort, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseHTTPSPort(d *caddyfile.Dispenser) (int, error) {
|
||||||
|
var httpsPort int
|
||||||
|
for d.Next() {
|
||||||
|
var httpsPortStr string
|
||||||
|
if !d.AllArgs(&httpsPortStr) {
|
||||||
|
return 0, d.ArgErr()
|
||||||
|
}
|
||||||
|
var err error
|
||||||
|
httpsPort, err = strconv.Atoi(httpsPortStr)
|
||||||
|
if err != nil {
|
||||||
|
return 0, d.Errf("converting port '%s' to integer value: %v", httpsPortStr, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return httpsPort, nil
|
||||||
|
}
|
@ -19,7 +19,6 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
"reflect"
|
"reflect"
|
||||||
"sort"
|
"sort"
|
||||||
"strconv"
|
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"github.com/caddyserver/caddy/v2"
|
"github.com/caddyserver/caddy/v2"
|
||||||
@ -44,7 +43,7 @@ type ServerType struct {
|
|||||||
|
|
||||||
// Setup makes a config from the tokens.
|
// Setup makes a config from the tokens.
|
||||||
func (st ServerType) Setup(originalServerBlocks []caddyfile.ServerBlock,
|
func (st ServerType) Setup(originalServerBlocks []caddyfile.ServerBlock,
|
||||||
options map[string]string) (*caddy.Config, []caddyconfig.Warning, error) {
|
options map[string]interface{}) (*caddy.Config, []caddyconfig.Warning, error) {
|
||||||
var warnings []caddyconfig.Warning
|
var warnings []caddyconfig.Warning
|
||||||
|
|
||||||
var serverBlocks []serverBlock
|
var serverBlocks []serverBlock
|
||||||
@ -55,6 +54,29 @@ func (st ServerType) Setup(originalServerBlocks []caddyfile.ServerBlock,
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// global configuration
|
||||||
|
if len(serverBlocks) > 0 && len(serverBlocks[0].block.Keys) == 0 {
|
||||||
|
sb := serverBlocks[0]
|
||||||
|
for _, segment := range sb.block.Segments {
|
||||||
|
dir := segment.Directive()
|
||||||
|
var val interface{}
|
||||||
|
var err error
|
||||||
|
switch dir {
|
||||||
|
case "http_port":
|
||||||
|
val, err = parseHTTPPort(caddyfile.NewDispenser(segment))
|
||||||
|
case "https_port":
|
||||||
|
val, err = parseHTTPSPort(caddyfile.NewDispenser(segment))
|
||||||
|
default:
|
||||||
|
return nil, warnings, fmt.Errorf("unrecognized parameter name: %s", dir)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, warnings, fmt.Errorf("%s: %v", dir, err)
|
||||||
|
}
|
||||||
|
options[dir] = val
|
||||||
|
}
|
||||||
|
serverBlocks = serverBlocks[1:]
|
||||||
|
}
|
||||||
|
|
||||||
for _, sb := range serverBlocks {
|
for _, sb := range serverBlocks {
|
||||||
// replace shorthand placeholders (which are
|
// replace shorthand placeholders (which are
|
||||||
// convenient when writing a Caddyfile) with
|
// convenient when writing a Caddyfile) with
|
||||||
@ -77,11 +99,15 @@ func (st ServerType) Setup(originalServerBlocks []caddyfile.ServerBlock,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if len(sb.block.Keys) == 0 {
|
||||||
|
return nil, warnings, fmt.Errorf("server block without any key is global configuration, and if used, it must be first")
|
||||||
|
}
|
||||||
|
|
||||||
// extract matcher definitions
|
// extract matcher definitions
|
||||||
d := sb.block.DispenseDirective("matcher")
|
d := sb.block.DispenseDirective("matcher")
|
||||||
matcherDefs, err := st.parseMatcherDefinitions(d)
|
matcherDefs, err := st.parseMatcherDefinitions(d)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, nil, err
|
return nil, warnings, err
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, segment := range sb.block.Segments {
|
for _, segment := range sb.block.Segments {
|
||||||
@ -129,8 +155,8 @@ func (st ServerType) Setup(originalServerBlocks []caddyfile.ServerBlock,
|
|||||||
|
|
||||||
// now that each server is configured, make the HTTP app
|
// now that each server is configured, make the HTTP app
|
||||||
httpApp := caddyhttp.App{
|
httpApp := caddyhttp.App{
|
||||||
HTTPPort: tryInt(options["http-port"], &warnings),
|
HTTPPort: tryInt(options["http_port"], &warnings),
|
||||||
HTTPSPort: tryInt(options["https-port"], &warnings),
|
HTTPSPort: tryInt(options["https_port"], &warnings),
|
||||||
Servers: servers,
|
Servers: servers,
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -494,17 +520,14 @@ func encodeMatcherSet(matchers map[string]caddyhttp.RequestMatcher) (map[string]
|
|||||||
return msEncoded, nil
|
return msEncoded, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// tryInt tries to convert str to an integer. If it fails, it downgrades
|
// tryInt tries to convert val to an integer. If it fails,
|
||||||
// the error to a warning and returns 0.
|
// it downgrades the error to a warning and returns 0.
|
||||||
func tryInt(str string, warnings *[]caddyconfig.Warning) int {
|
func tryInt(val interface{}, warnings *[]caddyconfig.Warning) int {
|
||||||
if str == "" {
|
intVal, ok := val.(int)
|
||||||
return 0
|
if val != nil && !ok && warnings != nil {
|
||||||
|
*warnings = append(*warnings, caddyconfig.Warning{Message: "not an integer type"})
|
||||||
}
|
}
|
||||||
val, err := strconv.Atoi(str)
|
return intVal
|
||||||
if err != nil && warnings != nil {
|
|
||||||
*warnings = append(*warnings, caddyconfig.Warning{Message: err.Error()})
|
|
||||||
}
|
|
||||||
return val
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type matcherSetAndTokens struct {
|
type matcherSetAndTokens struct {
|
||||||
|
@ -331,7 +331,7 @@ func cmdAdaptConfig() (int, error) {
|
|||||||
fmt.Errorf("reading input file: %v", err)
|
fmt.Errorf("reading input file: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
opts := make(map[string]string)
|
opts := make(map[string]interface{})
|
||||||
if *adaptCmdPrettyFlag {
|
if *adaptCmdPrettyFlag {
|
||||||
opts["pretty"] = "true"
|
opts["pretty"] = "true"
|
||||||
}
|
}
|
||||||
|
@ -131,9 +131,8 @@ func loadConfig(configFile, adapterName string) ([]byte, error) {
|
|||||||
|
|
||||||
// adapt config
|
// adapt config
|
||||||
if cfgAdapter != nil {
|
if cfgAdapter != nil {
|
||||||
adaptedConfig, warnings, err := cfgAdapter.Adapt(config, map[string]string{
|
adaptedConfig, warnings, err := cfgAdapter.Adapt(config, map[string]interface{}{
|
||||||
"filename": configFile,
|
"filename": configFile,
|
||||||
// TODO: all other options... (http-port, etc...)
|
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf("adapting config using %s: %v", adapterName, err)
|
return nil, fmt.Errorf("adapting config using %s: %v", adapterName, err)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user