144
vendor/github.com/mholt/caddy/caddyhttp/push/handler.go
generated
vendored
Normal file
144
vendor/github.com/mholt/caddy/caddyhttp/push/handler.go
generated
vendored
Normal file
@@ -0,0 +1,144 @@
|
||||
// Copyright 2015 Light Code Labs, LLC
|
||||
//
|
||||
// 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 push
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/mholt/caddy/caddyhttp/httpserver"
|
||||
)
|
||||
|
||||
func (h Middleware) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error) {
|
||||
pusher, hasPusher := w.(http.Pusher)
|
||||
|
||||
// no push possible, carry on
|
||||
if !hasPusher {
|
||||
return h.Next.ServeHTTP(w, r)
|
||||
}
|
||||
|
||||
// check if this is a request for the pushed resource (avoid recursion)
|
||||
if _, exists := r.Header[pushHeader]; exists {
|
||||
return h.Next.ServeHTTP(w, r)
|
||||
}
|
||||
|
||||
headers := h.filterProxiedHeaders(r.Header)
|
||||
|
||||
// push first
|
||||
outer:
|
||||
for _, rule := range h.Rules {
|
||||
urlPath := r.URL.Path
|
||||
matches := httpserver.Path(urlPath).Matches(rule.Path)
|
||||
// Also check IndexPages when requesting a directory
|
||||
if !matches {
|
||||
indexFile, isIndexFile := httpserver.IndexFile(h.Root, urlPath, h.indexPages)
|
||||
if isIndexFile {
|
||||
matches = httpserver.Path(indexFile).Matches(rule.Path)
|
||||
}
|
||||
}
|
||||
if matches {
|
||||
for _, resource := range rule.Resources {
|
||||
pushErr := pusher.Push(resource.Path, &http.PushOptions{
|
||||
Method: resource.Method,
|
||||
Header: h.mergeHeaders(headers, resource.Header),
|
||||
})
|
||||
if pushErr != nil {
|
||||
// if we cannot push (either not supported or concurrent streams are full - break)
|
||||
break outer
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// serve later
|
||||
code, err := h.Next.ServeHTTP(w, r)
|
||||
|
||||
// push resources returned in Link headers from upstream middlewares or proxied apps
|
||||
if links, exists := w.Header()["Link"]; exists {
|
||||
h.servePreloadLinks(pusher, headers, links)
|
||||
}
|
||||
|
||||
return code, err
|
||||
}
|
||||
|
||||
// servePreloadLinks parses Link headers from backend and pushes resources found in them.
|
||||
// For accepted header formats check parseLinkHeader function.
|
||||
//
|
||||
// If resource has 'nopush' attribute then it will be omitted.
|
||||
func (h Middleware) servePreloadLinks(pusher http.Pusher, headers http.Header, resources []string) {
|
||||
outer:
|
||||
for _, resource := range resources {
|
||||
for _, resource := range parseLinkHeader(resource) {
|
||||
if _, exists := resource.params["nopush"]; exists {
|
||||
continue
|
||||
}
|
||||
|
||||
if h.isRemoteResource(resource.uri) {
|
||||
continue
|
||||
}
|
||||
|
||||
err := pusher.Push(resource.uri, &http.PushOptions{
|
||||
Method: http.MethodGet,
|
||||
Header: headers,
|
||||
})
|
||||
|
||||
if err != nil {
|
||||
break outer
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (h Middleware) isRemoteResource(resource string) bool {
|
||||
return strings.HasPrefix(resource, "//") ||
|
||||
strings.HasPrefix(resource, "http://") ||
|
||||
strings.HasPrefix(resource, "https://")
|
||||
}
|
||||
|
||||
func (h Middleware) mergeHeaders(l, r http.Header) http.Header {
|
||||
out := http.Header{}
|
||||
|
||||
for k, v := range l {
|
||||
out[k] = v
|
||||
}
|
||||
|
||||
for k, vv := range r {
|
||||
for _, v := range vv {
|
||||
out.Add(k, v)
|
||||
}
|
||||
}
|
||||
|
||||
return out
|
||||
}
|
||||
|
||||
func (h Middleware) filterProxiedHeaders(headers http.Header) http.Header {
|
||||
filter := http.Header{}
|
||||
|
||||
for _, header := range proxiedHeaders {
|
||||
if val, ok := headers[header]; ok {
|
||||
filter[header] = val
|
||||
}
|
||||
}
|
||||
|
||||
return filter
|
||||
}
|
||||
|
||||
var proxiedHeaders = []string{
|
||||
"Accept-Encoding",
|
||||
"Accept-Language",
|
||||
"Cache-Control",
|
||||
"Host",
|
||||
"User-Agent",
|
||||
}
|
||||
77
vendor/github.com/mholt/caddy/caddyhttp/push/link_parser.go
generated
vendored
Normal file
77
vendor/github.com/mholt/caddy/caddyhttp/push/link_parser.go
generated
vendored
Normal file
@@ -0,0 +1,77 @@
|
||||
// Copyright 2015 Light Code Labs, LLC
|
||||
//
|
||||
// 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 push
|
||||
|
||||
import (
|
||||
"strings"
|
||||
)
|
||||
|
||||
const (
|
||||
commaSeparator = ","
|
||||
semicolonSeparator = ";"
|
||||
equalSeparator = "="
|
||||
)
|
||||
|
||||
type linkResource struct {
|
||||
uri string
|
||||
params map[string]string
|
||||
}
|
||||
|
||||
// parseLinkHeader is responsible for parsing Link header and returning list of found resources.
|
||||
//
|
||||
// Accepted formats are:
|
||||
// Link: </resource>; as=script
|
||||
// Link: </resource>; as=script,</resource2>; as=style
|
||||
// Link: </resource>;</resource2>
|
||||
func parseLinkHeader(header string) []linkResource {
|
||||
resources := []linkResource{}
|
||||
|
||||
if header == "" {
|
||||
return resources
|
||||
}
|
||||
|
||||
for _, link := range strings.Split(header, commaSeparator) {
|
||||
l := linkResource{params: make(map[string]string)}
|
||||
|
||||
li, ri := strings.Index(link, "<"), strings.Index(link, ">")
|
||||
|
||||
if li == -1 || ri == -1 {
|
||||
continue
|
||||
}
|
||||
|
||||
l.uri = strings.TrimSpace(link[li+1 : ri])
|
||||
|
||||
for _, param := range strings.Split(strings.TrimSpace(link[ri+1:]), semicolonSeparator) {
|
||||
parts := strings.SplitN(strings.TrimSpace(param), equalSeparator, 2)
|
||||
key := strings.TrimSpace(parts[0])
|
||||
|
||||
if key == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
if len(parts) == 1 {
|
||||
l.params[key] = key
|
||||
}
|
||||
|
||||
if len(parts) == 2 {
|
||||
l.params[key] = strings.TrimSpace(parts[1])
|
||||
}
|
||||
}
|
||||
|
||||
resources = append(resources, l)
|
||||
}
|
||||
|
||||
return resources
|
||||
}
|
||||
46
vendor/github.com/mholt/caddy/caddyhttp/push/push.go
generated
vendored
Normal file
46
vendor/github.com/mholt/caddy/caddyhttp/push/push.go
generated
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
// Copyright 2015 Light Code Labs, LLC
|
||||
//
|
||||
// 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 push
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/mholt/caddy/caddyhttp/httpserver"
|
||||
)
|
||||
|
||||
type (
|
||||
// Rule describes conditions on which resources will be pushed
|
||||
Rule struct {
|
||||
Path string
|
||||
Resources []Resource
|
||||
}
|
||||
|
||||
// Resource describes resource to be pushed
|
||||
Resource struct {
|
||||
Path string
|
||||
Method string
|
||||
Header http.Header
|
||||
}
|
||||
|
||||
// Middleware supports pushing resources to clients
|
||||
Middleware struct {
|
||||
Next httpserver.Handler
|
||||
Rules []Rule
|
||||
Root http.FileSystem
|
||||
indexPages []string // will be injected from SiteConfig on setup
|
||||
}
|
||||
|
||||
ruleOp func([]Resource)
|
||||
)
|
||||
193
vendor/github.com/mholt/caddy/caddyhttp/push/setup.go
generated
vendored
Normal file
193
vendor/github.com/mholt/caddy/caddyhttp/push/setup.go
generated
vendored
Normal file
@@ -0,0 +1,193 @@
|
||||
// Copyright 2015 Light Code Labs, LLC
|
||||
//
|
||||
// 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 push
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/mholt/caddy"
|
||||
"github.com/mholt/caddy/caddyhttp/httpserver"
|
||||
)
|
||||
|
||||
func init() {
|
||||
caddy.RegisterPlugin("push", caddy.Plugin{
|
||||
ServerType: "http",
|
||||
Action: setup,
|
||||
})
|
||||
}
|
||||
|
||||
var errInvalidHeader = errors.New("header directive requires [name] [value]")
|
||||
|
||||
var errHeaderStartsWithColon = errors.New("header cannot start with colon")
|
||||
var errMethodNotSupported = errors.New("push supports only GET and HEAD methods")
|
||||
|
||||
const pushHeader = "X-Push"
|
||||
|
||||
var emptyRules = []Rule{}
|
||||
|
||||
// setup configures a new Push middleware
|
||||
func setup(c *caddy.Controller) error {
|
||||
rules, err := parsePushRules(c)
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
cfg := httpserver.GetConfig(c)
|
||||
cfg.AddMiddleware(func(next httpserver.Handler) httpserver.Handler {
|
||||
return Middleware{Next: next, Rules: rules, Root: http.Dir(cfg.Root), indexPages: cfg.IndexPages}
|
||||
})
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func parsePushRules(c *caddy.Controller) ([]Rule, error) {
|
||||
var rules = make(map[string]*Rule)
|
||||
|
||||
for c.NextLine() {
|
||||
var rule *Rule
|
||||
var resources []Resource
|
||||
var ops []ruleOp
|
||||
|
||||
parseBlock := func() error {
|
||||
for c.NextBlock() {
|
||||
val := c.Val()
|
||||
|
||||
switch val {
|
||||
case "method":
|
||||
if !c.NextArg() {
|
||||
return c.ArgErr()
|
||||
}
|
||||
|
||||
method := c.Val()
|
||||
|
||||
if err := validateMethod(method); err != nil {
|
||||
return errMethodNotSupported
|
||||
}
|
||||
|
||||
ops = append(ops, setMethodOp(method))
|
||||
|
||||
case "header":
|
||||
args := c.RemainingArgs()
|
||||
|
||||
if len(args) != 2 {
|
||||
return errInvalidHeader
|
||||
}
|
||||
|
||||
if err := validateHeader(args[0]); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
ops = append(ops, setHeaderOp(args[0], args[1]))
|
||||
default:
|
||||
resources = append(resources, Resource{
|
||||
Path: val,
|
||||
Method: http.MethodGet,
|
||||
Header: http.Header{pushHeader: []string{}},
|
||||
})
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
args := c.RemainingArgs()
|
||||
|
||||
if len(args) == 0 {
|
||||
rule = new(Rule)
|
||||
rule.Path = "/"
|
||||
rules["/"] = rule
|
||||
err := parseBlock()
|
||||
if err != nil {
|
||||
return emptyRules, err
|
||||
}
|
||||
} else {
|
||||
path := args[0]
|
||||
|
||||
if existingRule, ok := rules[path]; ok {
|
||||
rule = existingRule
|
||||
} else {
|
||||
rule = new(Rule)
|
||||
rule.Path = path
|
||||
rules[rule.Path] = rule
|
||||
}
|
||||
|
||||
for i := 1; i < len(args); i++ {
|
||||
resources = append(resources, Resource{
|
||||
Path: args[i],
|
||||
Method: http.MethodGet,
|
||||
Header: http.Header{pushHeader: []string{}},
|
||||
})
|
||||
}
|
||||
|
||||
err := parseBlock()
|
||||
if err != nil {
|
||||
return emptyRules, err
|
||||
}
|
||||
}
|
||||
|
||||
for _, op := range ops {
|
||||
op(resources)
|
||||
}
|
||||
rule.Resources = append(rule.Resources, resources...)
|
||||
}
|
||||
|
||||
var returnRules []Rule
|
||||
for _, rule := range rules {
|
||||
returnRules = append(returnRules, *rule)
|
||||
}
|
||||
|
||||
return returnRules, nil
|
||||
}
|
||||
|
||||
func setHeaderOp(key, value string) func(resources []Resource) {
|
||||
return func(resources []Resource) {
|
||||
for index := range resources {
|
||||
resources[index].Header.Set(key, value)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func setMethodOp(method string) func(resources []Resource) {
|
||||
return func(resources []Resource) {
|
||||
for index := range resources {
|
||||
resources[index].Method = method
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func validateHeader(header string) error {
|
||||
if strings.HasPrefix(header, ":") {
|
||||
return errHeaderStartsWithColon
|
||||
}
|
||||
|
||||
switch strings.ToLower(header) {
|
||||
case "content-length", "content-encoding", "trailer", "te", "expect", "host":
|
||||
return fmt.Errorf("push headers cannot include %s", header)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// rules based on https://go-review.googlesource.com/#/c/29439/4/http2/go18.go#94
|
||||
func validateMethod(method string) error {
|
||||
if method != http.MethodGet && method != http.MethodHead {
|
||||
return errMethodNotSupported
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
Reference in New Issue
Block a user