caddy/modules/caddyhttp/staticresp.go

// 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 caddyhttp

import (
	"fmt"
	"net/http"
	"strconv"

	"github.com/caddyserver/caddy/v2"
	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
)

func init() {
	caddy.RegisterModule(StaticResponse{})
}

// StaticResponse implements a simple responder for static responses.
type StaticResponse struct {
	// The HTTP status code to respond with. Can be an integer or,
	// if needing to use a placeholder, a string.
	StatusCode WeakString `json:"status_code,omitempty"`

	// Header fields to set on the response.
	Headers http.Header `json:"headers,omitempty"`

	// The response body.
	Body string `json:"body,omitempty"`

	// If true, the server will close the client's connection
	// after writing the response.
	Close bool `json:"close,omitempty"`
}

// CaddyModule returns the Caddy module information.
func (StaticResponse) CaddyModule() caddy.ModuleInfo {
	return caddy.ModuleInfo{
		ID:  "http.handlers.static_response",
		New: func() caddy.Module { return new(StaticResponse) },
	}
}

// UnmarshalCaddyfile sets up the handler from Caddyfile tokens. Syntax:
//
//     respond [<matcher>] <status>|<body> [<status>] {
//         body <text>
//         close
//     }
//
// If there is just one argument (other than the matcher), it is considered
// to be a status code if it's a valid positive integer of 3 digits.
func (s *StaticResponse) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
	for d.Next() {
		args := d.RemainingArgs()
		switch len(args) {
		case 1:
			if len(args[0]) == 3 {
				if num, err := strconv.Atoi(args[0]); err == nil && num > 0 {
					s.StatusCode = WeakString(args[0])
					break
				}
			}
			s.Body = args[0]
		case 2:
			s.Body = args[0]
			s.StatusCode = WeakString(args[1])
		default:
			return d.ArgErr()
		}

		for d.NextBlock(0) {
			switch d.Val() {
			case "body":
				if s.Body != "" {
					return d.Err("body already specified")
				}
				if !d.AllArgs(&s.Body) {
					return d.ArgErr()
				}
			case "close":
				if s.Close {
					return d.Err("close already specified")
				}
				s.Close = true
			}
		}
	}
	return nil
}

func (s StaticResponse) ServeHTTP(w http.ResponseWriter, r *http.Request, _ Handler) error {
	repl := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer)

	// close the connection after responding
	r.Close = s.Close

	// set all headers
	for field, vals := range s.Headers {
		field = repl.ReplaceAll(field, "")
		newVals := make([]string, len(vals))
		for i := range vals {
			newVals[i] = repl.ReplaceAll(vals[i], "")
		}
		w.Header()[field] = newVals
	}

	// do not allow Go to sniff the content-type
	if w.Header().Get("Content-Type") == "" {
		w.Header()["Content-Type"] = nil
	}

	// get the status code
	statusCode := http.StatusOK
	if codeStr := s.StatusCode.String(); codeStr != "" {
		intVal, err := strconv.Atoi(repl.ReplaceAll(codeStr, ""))
		if err != nil {
			return Error(http.StatusInternalServerError, err)
		}
		statusCode = intVal
	}

	// write headers
	w.WriteHeader(statusCode)

	// write response body
	if s.Body != "" {
		fmt.Fprint(w, repl.ReplaceKnown(s.Body, ""))
	}

	return nil
}

// Interface guards
var (
	_ MiddlewareHandler     = (*StaticResponse)(nil)
	_ caddyfile.Unmarshaler = (*StaticResponse)(nil)
)
Add license 2019-07-01 01:07:58 +03:00			`// 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.`

Rough implementation of auto HTTP->HTTPS redirects Also added GracePeriod for server shutdowns 2019-05-07 18:56:13 +03:00			`package caddyhttp`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00
			`import (`
			`"fmt"`
			`"net/http"`
Default error handler; rename StaticFiles -> FileServer 2019-05-21 06:21:33 +03:00			`"strconv"`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00
go.mod: Append /v2 to module name; update all import paths See https://github.com/golang/go/wiki/Modules#semantic-import-versioning 2019-07-02 21:37:06 +03:00			`"github.com/caddyserver/caddy/v2"`
Implement config adapters and beginning of Caddyfile adapter Along with several other changes, such as renaming caddyhttp.ServerRoute to caddyhttp.Route, exporting some types that were not exported before, and tweaking the caddytls TLS values to be more consistent. Notably, we also now disable automatic cert management for names which already have a cert (manually) loaded into the cache. These names no longer need to be specified in the "skip_certificates" field of the automatic HTTPS config, because they will be skipped automatically. 2019-08-09 21:05:47 +03:00			`"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`)`

			`func init() {`
Refactor Caddyfile adapter and module registration Use piles from which to draw config values. Module values can return their name, so now we can do two-way mapping from value to name and name to value; whereas before we could only map name to value. This was problematic with the Caddyfile adapter since it receives values and needs to know the name to put in the config. 2019-08-21 19:46:35 +03:00			`caddy.RegisterModule(StaticResponse{})`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`}`

Add error & subroute handlers; weakString; other minor handler changes 2019-07-12 02:02:57 +03:00			`// StaticResponse implements a simple responder for static responses.`
			`type StaticResponse struct {`
Improve godocs all around These will be used in the new automated documentation system 2019-12-23 22:45:35 +03:00			`// The HTTP status code to respond with. Can be an integer or,`
			`// if needing to use a placeholder, a string.`
			StatusCode WeakString `json:"status_code,omitempty"`

			`// Header fields to set on the response.`
			Headers http.Header `json:"headers,omitempty"`

			`// The response body.`
			Body string `json:"body,omitempty"`

			`// If true, the server will close the client's connection`
			`// after writing the response.`
			Close bool `json:"close,omitempty"`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`}`

Refactor Caddyfile adapter and module registration Use piles from which to draw config values. Module values can return their name, so now we can do two-way mapping from value to name and name to value; whereas before we could only map name to value. This was problematic with the Caddyfile adapter since it receives values and needs to know the name to put in the config. 2019-08-21 19:46:35 +03:00			`// CaddyModule returns the Caddy module information.`
			`func (StaticResponse) CaddyModule() caddy.ModuleInfo {`
			`return caddy.ModuleInfo{`
v2: Module documentation; refactor LoadModule(); new caddy struct tags (#2924) This commit goes a long way toward making automated documentation of Caddy config and Caddy modules possible. It's a broad, sweeping change, but mostly internal. It allows us to automatically generate docs for all Caddy modules (including future third-party ones) and make them viewable on a web page; it also doubles as godoc comments. As such, this commit makes significant progress in migrating the docs from our temporary wiki page toward our new website which is still under construction. With this change, all host modules will use ctx.LoadModule() and pass in both the struct pointer and the field name as a string. This allows the reflect package to read the struct tag from that field so that it can get the necessary information like the module namespace and the inline key. This has the nice side-effect of unifying the code and documentation. It also simplifies module loading, and handles several variations on field types for raw module fields (i.e. variations on json.RawMessage, such as arrays and maps). I also renamed ModuleInfo.Name -> ModuleInfo.ID, to make it clear that the ID is the "full name" which includes both the module namespace and the name. This clarity is helpful when describing module hierarchy. As of this change, Caddy modules are no longer an experimental design. I think the architecture is good enough to go forward. 2019-12-10 23:36:46 +03:00			`ID: "http.handlers.static_response",`
			`New: func() caddy.Module { return new(StaticResponse) },`
Refactor Caddyfile adapter and module registration Use piles from which to draw config values. Module values can return their name, so now we can do two-way mapping from value to name and name to value; whereas before we could only map name to value. This was problematic with the Caddyfile adapter since it receives values and needs to know the name to put in the config. 2019-08-21 19:46:35 +03:00			`}`
			`}`

Implement config adapters and beginning of Caddyfile adapter Along with several other changes, such as renaming caddyhttp.ServerRoute to caddyhttp.Route, exporting some types that were not exported before, and tweaking the caddytls TLS values to be more consistent. Notably, we also now disable automatic cert management for names which already have a cert (manually) loaded into the cache. These names no longer need to be specified in the "skip_certificates" field of the automatic HTTPS config, because they will be skipped automatically. 2019-08-09 21:05:47 +03:00			`// UnmarshalCaddyfile sets up the handler from Caddyfile tokens. Syntax:`
			`//`
httpcaddyfile: Update directive docs; put root after rewrite 2020-01-22 19:32:38 +03:00			`// respond [<matcher>] <status>\|<body> [<status>] {`
Implement config adapters and beginning of Caddyfile adapter Along with several other changes, such as renaming caddyhttp.ServerRoute to caddyhttp.Route, exporting some types that were not exported before, and tweaking the caddytls TLS values to be more consistent. Notably, we also now disable automatic cert management for names which already have a cert (manually) loaded into the cache. These names no longer need to be specified in the "skip_certificates" field of the automatic HTTPS config, because they will be skipped automatically. 2019-08-09 21:05:47 +03:00			`// body <text>`
			`// close`
			`// }`
			`//`
caddyhttp: Improve docs, and Caddyfile for respond directive 2020-01-17 20:57:57 +03:00			`// If there is just one argument (other than the matcher), it is considered`
			`// to be a status code if it's a valid positive integer of 3 digits.`
Implement config adapters and beginning of Caddyfile adapter Along with several other changes, such as renaming caddyhttp.ServerRoute to caddyhttp.Route, exporting some types that were not exported before, and tweaking the caddytls TLS values to be more consistent. Notably, we also now disable automatic cert management for names which already have a cert (manually) loaded into the cache. These names no longer need to be specified in the "skip_certificates" field of the automatic HTTPS config, because they will be skipped automatically. 2019-08-09 21:05:47 +03:00			`func (s StaticResponse) UnmarshalCaddyfile(d caddyfile.Dispenser) error {`
			`for d.Next() {`
caddyhttp: Improve docs, and Caddyfile for respond directive 2020-01-17 20:57:57 +03:00			`args := d.RemainingArgs()`
			`switch len(args) {`
			`case 1:`
			`if len(args[0]) == 3 {`
			`if num, err := strconv.Atoi(args[0]); err == nil && num > 0 {`
			`s.StatusCode = WeakString(args[0])`
			`break`
			`}`
			`}`
			`s.Body = args[0]`
			`case 2:`
			`s.Body = args[0]`
			`s.StatusCode = WeakString(args[1])`
			`default:`
			`return d.ArgErr()`
Implement config adapters and beginning of Caddyfile adapter Along with several other changes, such as renaming caddyhttp.ServerRoute to caddyhttp.Route, exporting some types that were not exported before, and tweaking the caddytls TLS values to be more consistent. Notably, we also now disable automatic cert management for names which already have a cert (manually) loaded into the cache. These names no longer need to be specified in the "skip_certificates" field of the automatic HTTPS config, because they will be skipped automatically. 2019-08-09 21:05:47 +03:00			`}`
caddyhttp: Improve docs, and Caddyfile for respond directive 2020-01-17 20:57:57 +03:00
caddyfile: Improve Dispenser.NextBlock() to support nesting 2019-09-11 04:21:52 +03:00			`for d.NextBlock(0) {`
Implement config adapters and beginning of Caddyfile adapter Along with several other changes, such as renaming caddyhttp.ServerRoute to caddyhttp.Route, exporting some types that were not exported before, and tweaking the caddytls TLS values to be more consistent. Notably, we also now disable automatic cert management for names which already have a cert (manually) loaded into the cache. These names no longer need to be specified in the "skip_certificates" field of the automatic HTTPS config, because they will be skipped automatically. 2019-08-09 21:05:47 +03:00			`switch d.Val() {`
			`case "body":`
			`if s.Body != "" {`
			`return d.Err("body already specified")`
			`}`
caddyhttp: Improve docs, and Caddyfile for respond directive 2020-01-17 20:57:57 +03:00			`if !d.AllArgs(&s.Body) {`
Implement config adapters and beginning of Caddyfile adapter Along with several other changes, such as renaming caddyhttp.ServerRoute to caddyhttp.Route, exporting some types that were not exported before, and tweaking the caddytls TLS values to be more consistent. Notably, we also now disable automatic cert management for names which already have a cert (manually) loaded into the cache. These names no longer need to be specified in the "skip_certificates" field of the automatic HTTPS config, because they will be skipped automatically. 2019-08-09 21:05:47 +03:00			`return d.ArgErr()`
			`}`
			`case "close":`
			`if s.Close {`
			`return d.Err("close already specified")`
			`}`
			`s.Close = true`
			`}`
			`}`
			`}`
			`return nil`
			`}`

Add error & subroute handlers; weakString; other minor handler changes 2019-07-12 02:02:57 +03:00			`func (s StaticResponse) ServeHTTP(w http.ResponseWriter, r *http.Request, _ Handler) error {`
Export Replacer and use concrete type instead of interface The interface was only making things difficult; a concrete pointer is probably best. 2019-12-29 23:12:52 +03:00			`repl := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer)`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00
Some minor updates, and get rid of OnLoad/OnUnload 2019-05-16 20:46:17 +03:00			`// close the connection after responding`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`r.Close = s.Close`

Fix deferred header ops 2019-05-21 07:00:54 +03:00			`// set all headers`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`for field, vals := range s.Headers {`
Implement most of static file server; refactor and improve Replacer 2019-05-20 19:59:20 +03:00			`field = repl.ReplaceAll(field, "")`
Various bug fixes and minor improvements - Fix static responder so it doesn't replace its own headers config, and instead replaces the actual response header values - caddyhttp.ResponseRecorder type optionally buffers response - Add interface guards to ensure regexp matchers get provisioned - Use default HTTP port if one is not explicitly set - Encode middleware writes status code 200 if not written upstream - Templates and markdown only try to execute on text responses - Static file server sets Content-Type based on file extension only (this whole thing -- MIME sniffing, etc -- needs more configurability) 2019-06-21 23:36:26 +03:00			`newVals := make([]string, len(vals))`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`for i := range vals {`
Various bug fixes and minor improvements - Fix static responder so it doesn't replace its own headers config, and instead replaces the actual response header values - caddyhttp.ResponseRecorder type optionally buffers response - Add interface guards to ensure regexp matchers get provisioned - Use default HTTP port if one is not explicitly set - Encode middleware writes status code 200 if not written upstream - Templates and markdown only try to execute on text responses - Static file server sets Content-Type based on file extension only (this whole thing -- MIME sniffing, etc -- needs more configurability) 2019-06-21 23:36:26 +03:00			`newVals[i] = repl.ReplaceAll(vals[i], "")`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`}`
Various bug fixes and minor improvements - Fix static responder so it doesn't replace its own headers config, and instead replaces the actual response header values - caddyhttp.ResponseRecorder type optionally buffers response - Add interface guards to ensure regexp matchers get provisioned - Use default HTTP port if one is not explicitly set - Encode middleware writes status code 200 if not written upstream - Templates and markdown only try to execute on text responses - Static file server sets Content-Type based on file extension only (this whole thing -- MIME sniffing, etc -- needs more configurability) 2019-06-21 23:36:26 +03:00			`w.Header()[field] = newVals`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`}`

Do not allow Go standard lib to sniff Content-Type header 2019-06-08 04:59:17 +03:00			`// do not allow Go to sniff the content-type`
			`if w.Header().Get("Content-Type") == "" {`
			`w.Header()["Content-Type"] = nil`
			`}`

Fix deferred header ops 2019-05-21 07:00:54 +03:00			`// get the status code`
Flatten HTTP handler config (#2662) Differentiating middleware and responders has one benefit, namely that it's clear which module provides the response, but even then it's not a great advantage. Linear handler config makes a little more sense, giving greater flexibility and simplifying the core a bit, even though it's slightly awkward that handlers which are responders may not use the 'next' handler that is passed in at all. 2019-07-09 21:58:39 +03:00			`statusCode := http.StatusOK`
Add error & subroute handlers; weakString; other minor handler changes 2019-07-12 02:02:57 +03:00			`if codeStr := s.StatusCode.String(); codeStr != "" {`
			`intVal, err := strconv.Atoi(repl.ReplaceAll(codeStr, ""))`
			`if err != nil {`
			`return Error(http.StatusInternalServerError, err)`
Default error handler; rename StaticFiles -> FileServer 2019-05-21 06:21:33 +03:00			`}`
Add error & subroute handlers; weakString; other minor handler changes 2019-07-12 02:02:57 +03:00			`statusCode = intVal`
Default error handler; rename StaticFiles -> FileServer 2019-05-21 06:21:33 +03:00			`}`
Fix deferred header ops 2019-05-21 07:00:54 +03:00
			`// write headers`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`w.WriteHeader(statusCode)`

Fix deferred header ops 2019-05-21 07:00:54 +03:00			`// write response body`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`if s.Body != "" {`
v2: Logging! (#2831) * logging: Initial implementation * logging: More encoder formats, better defaults * logging: Fix repetition bug with FilterEncoder; add more presets * logging: DiscardWriter; delete or no-op logs that discard their output * logging: Add http.handlers.log module; enhance Replacer methods The Replacer interface has new methods to customize how to handle empty or unrecognized placeholders. Closes #2815. * logging: Overhaul HTTP logging, fix bugs, improve filtering, etc. * logging: General cleanup, begin transitioning to using new loggers * Fixes after merge conflict 2019-10-28 23:39:37 +03:00			`fmt.Fprint(w, repl.ReplaceKnown(s.Body, ""))`
Begin implementing HTTP replacer and static responder 2019-05-04 22:21:20 +03:00			`}`

			`return nil`
			`}`

httpcaddyfile: static_response -> respond; minor cleanups 2019-09-16 20:04:18 +03:00			`// Interface guards`
			`var (`
			`_ MiddlewareHandler = (*StaticResponse)(nil)`
			`_ caddyfile.Unmarshaler = (*StaticResponse)(nil)`
			`)`