File: static_file_modifier.go

package info (click to toggle)
golang-github-google-martian 2.1.0%2Bgit20181219.d0b5ad3-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 1,140 kB
  • sloc: makefile: 3
file content (232 lines) | stat: -rw-r--r-- 6,447 bytes parent folder | download
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
// Copyright 2015 Google Inc. All rights reserved.
//
// 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 static provides a modifier that allows Martian to return static files
// local to Martian. The static modifier does not support setting explicit path
// mappings via the JSON API.
package static

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io"
	"io/ioutil"
	"mime"
	"mime/multipart"
	"net/http"
	"net/textproto"
	"os"
	"path"
	"path/filepath"
	"strconv"
	"strings"

	"github.com/google/martian"
	"github.com/google/martian/parse"
)

// Modifier is a martian.RequestResponseModifier that routes reqeusts to rootPath
// and serves the assets there, while skipping the HTTP roundtrip.
type Modifier struct {
	rootPath      string
	explicitPaths map[string]string
}

type staticJSON struct {
	ExplicitPaths map[string]string    `json:"explicitPaths"`
	RootPath      string               `json:"rootPath"`
	Scope         []parse.ModifierType `json:"scope"`
}

func init() {
	parse.Register("static.Modifier", modifierFromJSON)
}

// NewModifier constructs a static.Modifier that takes a path to serve files from, as well as an optional mapping of request paths to local
// file paths (still rooted at rootPath).
func NewModifier(rootPath string) *Modifier {
	return &Modifier{
		rootPath:      path.Clean(rootPath),
		explicitPaths: make(map[string]string),
	}
}

// ModifyRequest marks the context to skip the roundtrip and downgrades any https requests
// to http.
func (s *Modifier) ModifyRequest(req *http.Request) error {
	ctx := martian.NewContext(req)
	ctx.SkipRoundTrip()

	return nil
}

// ModifyResponse reads the file rooted at rootPath joined with the request URL
// path. In the case that the the request path is a key in s.explicitPaths, ModifyRequest
// will attempt to open the file located at s.rootPath joined by the value in s.explicitPaths
// (keyed by res.Request.URL.Path).  In the case that the file cannot be found, the response
// will be a 404. ModifyResponse will return a 404 for any path that is defined in s.explictPaths
// and that does not exist locally, even if that file does exist in s.rootPath.
func (s *Modifier) ModifyResponse(res *http.Response) error {
	reqpth := filepath.Clean(res.Request.URL.Path)
	fpth := filepath.Join(s.rootPath, reqpth)

	if _, ok := s.explicitPaths[reqpth]; ok {
		fpth = filepath.Join(s.rootPath, s.explicitPaths[reqpth])
	}

	f, err := os.Open(fpth)
	switch {
	case os.IsNotExist(err):
		res.StatusCode = http.StatusNotFound
		return nil
	case os.IsPermission(err):
		// This is returning a StatusUnauthorized to reflect that the Martian does
		// not have the appropriate permissions on the local file system.  This is a
		// deviation from the standard assumption around an HTTP 401 response.
		res.StatusCode = http.StatusUnauthorized
		return err
	case err != nil:
		res.StatusCode = http.StatusInternalServerError
		return err
	}

	res.Body.Close()

	info, err := f.Stat()
	if err != nil {
		res.StatusCode = http.StatusInternalServerError
		return err
	}

	contentType := mime.TypeByExtension(filepath.Ext(fpth))
	res.Header.Set("Content-Type", contentType)

	// If no range request header is present, return the file as the response body.
	if res.Request.Header.Get("Range") == "" {
		res.ContentLength = info.Size()
		res.Body = f

		return nil
	}

	rh := res.Request.Header.Get("Range")
	rh = strings.ToLower(rh)
	sranges := strings.Split(strings.TrimLeft(rh, "bytes="), ",")
	var ranges [][]int
	for _, rng := range sranges {
		if strings.HasSuffix(rng, "-") {
			rng = fmt.Sprintf("%s%d", rng, info.Size()-1)
		}

		rs := strings.Split(rng, "-")
		if len(rs) != 2 {
			res.StatusCode = http.StatusRequestedRangeNotSatisfiable
			return nil
		}
		start, err := strconv.Atoi(strings.TrimSpace(rs[0]))
		if err != nil {
			return err
		}

		end, err := strconv.Atoi(strings.TrimSpace(rs[1]))
		if err != nil {
			return err
		}

		if start > end {
			res.StatusCode = http.StatusRequestedRangeNotSatisfiable
			return nil
		}

		ranges = append(ranges, []int{start, end})
	}

	// Range request.
	res.StatusCode = http.StatusPartialContent

	// Single range request.
	if len(ranges) == 1 {
		start := ranges[0][0]
		end := ranges[0][1]
		length := end - start + 1
		seg := make([]byte, length)

		switch n, err := f.ReadAt(seg, int64(start)); err {
		case nil, io.EOF:
			res.ContentLength = int64(n)
		default:
			return err
		}

		res.Body = ioutil.NopCloser(bytes.NewReader(seg))
		res.Header.Set("Content-Range", fmt.Sprintf("bytes %d-%d/%d", start, end, info.Size()))

		return nil
	}

	// Multipart range request.
	var mpbody bytes.Buffer
	mpw := multipart.NewWriter(&mpbody)

	for _, rng := range ranges {
		start, end := rng[0], rng[1]
		mimeh := make(textproto.MIMEHeader)
		mimeh.Set("Content-Type", contentType)
		mimeh.Set("Content-Range", fmt.Sprintf("bytes %d-%d/%d", start, end, info.Size()))

		length := end - start + 1
		seg := make([]byte, length)

		switch n, err := f.ReadAt(seg, int64(start)); err {
		case nil, io.EOF:
			res.ContentLength = int64(n)
		default:
			return err
		}

		pw, err := mpw.CreatePart(mimeh)
		if err != nil {
			return err
		}

		if _, err := pw.Write(seg); err != nil {
			return err
		}
	}
	mpw.Close()

	res.ContentLength = int64(len(mpbody.Bytes()))
	res.Body = ioutil.NopCloser(bytes.NewReader(mpbody.Bytes()))
	res.Header.Set("Content-Type", fmt.Sprintf("multipart/byteranges; boundary=%s", mpw.Boundary()))

	return nil
}

// SetExplicitPathMappings sets an optional mapping of request paths to local
// file paths rooted at s.rootPath.
func (s *Modifier) SetExplicitPathMappings(ep map[string]string) {
	s.explicitPaths = ep
}

func modifierFromJSON(b []byte) (*parse.Result, error) {
	msg := &staticJSON{}
	if err := json.Unmarshal(b, msg); err != nil {
		return nil, err
	}

	mod := NewModifier(msg.RootPath)
	mod.SetExplicitPathMappings(msg.ExplicitPaths)
	return parse.NewResult(mod, msg.Scope)
}