aboutsummaryrefslogtreecommitdiffhomepage
path: root/modules/caddyhttp/invoke.go
blob: 97fd1cc31e2086111ec0bcfa00708ca58af0a2d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// 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"

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

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

// Invoke implements a handler that compiles and executes a
// named route that was defined on the server.
//
// EXPERIMENTAL: Subject to change or removal.
type Invoke struct {
	// Name is the key of the named route to execute
	Name string `json:"name,omitempty"`
}

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

func (invoke *Invoke) ServeHTTP(w http.ResponseWriter, r *http.Request, next Handler) error {
	server := r.Context().Value(ServerCtxKey).(*Server)
	if route, ok := server.NamedRoutes[invoke.Name]; ok {
		return route.Compile(next).ServeHTTP(w, r)
	}
	return fmt.Errorf("invoke: route '%s' not found", invoke.Name)
}

// Interface guards
var (
	_ MiddlewareHandler = (*Invoke)(nil)
)