summaryrefslogtreecommitdiff
path: root/modules/caddyhttp/starlarkmw/internal/lib/module.go
blob: 13c706c22cb032ba2e0c51e20c6579e894790abd (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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
package lib

import (
	"encoding/json"
	"fmt"
	"strings"

	"github.com/caddyserver/caddy/v2/modules/caddyhttp"

	"github.com/caddyserver/caddy/v2"
	"go.starlark.net/starlark"
)

// ResponderModule represents a module that satisfies the caddyhttp handler.
type ResponderModule struct {
	Name     string
	Cfg      json.RawMessage
	Instance caddyhttp.Handler
}

func (r ResponderModule) Freeze()               {}
func (r ResponderModule) Hash() (uint32, error) { return 0, fmt.Errorf("unhashable: responder module") }
func (r ResponderModule) String() string        { return "responder module" }
func (r ResponderModule) Type() string          { return "responder module" }
func (r ResponderModule) Truth() starlark.Bool  { return true }

// Middleware represents a module that satisfies the starlark Value interface.
type Middleware struct {
	Name     string
	Cfg      json.RawMessage
	Instance caddyhttp.MiddlewareHandler
}

func (r Middleware) Freeze()               {}
func (r Middleware) Hash() (uint32, error) { return 0, fmt.Errorf("unhashable: middleware") }
func (r Middleware) String() string        { return "middleware" }
func (r Middleware) Type() string          { return "middleware" }
func (r Middleware) Truth() starlark.Bool  { return true }

// LoadMiddleware represents the method exposed to starlark to load a Caddy module.
type LoadMiddleware struct {
	Middleware Middleware
	Ctx        caddy.Context
}

func (r LoadMiddleware) Freeze()               {}
func (r LoadMiddleware) Hash() (uint32, error) { return 0, fmt.Errorf("unhashable: loadMiddleware") }
func (r LoadMiddleware) String() string        { return "loadMiddleware" }
func (r LoadMiddleware) Type() string          { return "function: loadMiddleware" }
func (r LoadMiddleware) Truth() starlark.Bool  { return true }

// Run is the method bound to the starlark loadMiddleware function.
func (r *LoadMiddleware) Run(thread *starlark.Thread, fn *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
	var name string
	var cfg *starlark.Dict
	err := starlark.UnpackPositionalArgs(fn.Name(), args, kwargs, 2, &name, &cfg)
	if err != nil {
		return starlark.None, fmt.Errorf("unpacking arguments: %v", err.Error())
	}

	js := json.RawMessage(cfg.String())

	if !strings.Contains(name, "http.handlers.") {
		name = fmt.Sprintf("http.handlers.%s", name)
	}

	inst, err := r.Ctx.LoadModuleByID(name, js)
	if err != nil {
		return starlark.None, err
	}

	mid, ok := inst.(caddyhttp.MiddlewareHandler)
	if !ok {
		return starlark.None, fmt.Errorf("could not assert as middleware handler")
	}

	m := Middleware{
		Name:     name,
		Cfg:      js,
		Instance: mid,
	}

	r.Middleware = m

	return m, nil
}

// LoadResponder represents the method exposed to starlark to load a Caddy middleware responder.
type LoadResponder struct {
	Module ResponderModule
	Ctx    caddy.Context
}

func (r LoadResponder) Freeze()               {}
func (r LoadResponder) Hash() (uint32, error) { return 0, fmt.Errorf("unhashable: loadModule") }
func (r LoadResponder) String() string        { return "loadModule" }
func (r LoadResponder) Type() string          { return "function: loadModule" }
func (r LoadResponder) Truth() starlark.Bool  { return true }

// Run is the method bound to the starlark loadResponder function.
func (r *LoadResponder) Run(thread *starlark.Thread, fn *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
	var name string
	var cfg *starlark.Dict
	err := starlark.UnpackPositionalArgs(fn.Name(), args, kwargs, 2, &name, &cfg)
	if err != nil {
		return starlark.None, fmt.Errorf("unpacking arguments: %v", err.Error())
	}

	js := json.RawMessage(cfg.String())

	if !strings.Contains(name, "http.handlers.") {
		name = fmt.Sprintf("http.handlers.%s", name)
	}

	inst, err := r.Ctx.LoadModuleByID(name, js)
	if err != nil {
		return starlark.None, err
	}

	res, ok := inst.(caddyhttp.Handler)
	if !ok {
		return starlark.None, fmt.Errorf("could not assert as responder")
	}

	m := ResponderModule{
		Name:     name,
		Cfg:      js,
		Instance: res,
	}

	r.Module = m

	return m, nil
}

// Execute represents the method exposed to starlark to build a middleware chain.
type Execute struct {
	Modules []Middleware
}

func (r Execute) Freeze()               {}
func (r Execute) Hash() (uint32, error) { return 0, fmt.Errorf("unhashable: execute") }
func (r Execute) String() string        { return "execute" }
func (r Execute) Type() string          { return "function: execute" }
func (r Execute) Truth() starlark.Bool  { return true }

// Run is the method bound to the starlark execute function.
func (r *Execute) Run(thread *starlark.Thread, fn *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error) {
	var mids *starlark.List
	err := starlark.UnpackPositionalArgs(fn.Name(), args, kwargs, 1, &mids)
	if err != nil {
		return starlark.None, fmt.Errorf("unpacking arguments: %v", err.Error())
	}

	for i := 0; i < mids.Len(); i++ {
		val, ok := mids.Index(i).(Middleware)
		if !ok {
			return starlark.None, fmt.Errorf("cannot get module from execute")
		}

		r.Modules = append(r.Modules, val)
	}

	return starlark.None, nil
}