forked from thecodeteam/libstorage
-
Notifications
You must be signed in to change notification settings - Fork 0
/
handlers_logging.go
273 lines (238 loc) · 5.84 KB
/
handlers_logging.go
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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
package handlers
import (
"bytes"
"fmt"
"io"
"net"
"net/http"
"net/http/httptest"
"net/http/httputil"
"net/url"
"strconv"
"strings"
"time"
"unicode/utf8"
"github.com/akutz/gotil"
"github.com/codedellemc/libstorage/api/types"
)
const (
lowerhex = "0123456789abcdef"
)
// loggingHandler is an HTTP logging handler for the libStorage service
// endpoint.
type loggingHandler struct {
handler types.APIFunc
logRequests bool
logResponses bool
writer io.Writer
}
// NewLoggingHandler instantiates a new instance of the loggingHandler type.
func NewLoggingHandler(
w io.Writer,
logHTTPRequests, logHTTPResponses bool) types.Middleware {
return &loggingHandler{
writer: w,
logRequests: logHTTPRequests,
logResponses: logHTTPResponses,
}
}
func (h *loggingHandler) Name() string {
return "logging-handler"
}
func (h *loggingHandler) Handler(m types.APIFunc) types.APIFunc {
return (&loggingHandler{m, h.logRequests, h.logResponses, h.writer}).Handle
}
// Handle is the type's Handler function.
func (h *loggingHandler) Handle(
ctx types.Context,
w http.ResponseWriter,
req *http.Request,
store types.Store) error {
bw := &bytes.Buffer{}
defer func(w io.Writer) {
h.writer.Write(bw.Bytes())
}(bw)
var err error
var reqDump []byte
if h.logRequests {
if reqDump, err = httputil.DumpRequest(req, true); err != nil {
return err
}
}
rec := httptest.NewRecorder()
reqErr := h.handler(ctx, rec, req, store)
logRequest(h.logRequests, bw, rec, req, reqDump)
if reqErr != nil {
return reqErr
}
if h.logResponses {
fmt.Fprintln(bw, "")
logResponse(bw, rec, req)
fmt.Fprintln(bw, "")
}
for k, v := range rec.HeaderMap {
w.Header()[k] = v
}
w.WriteHeader(rec.Code)
if req.Method != http.MethodHead {
w.Write(rec.Body.Bytes())
}
return nil
}
func logRequest(
l bool,
w io.Writer,
rec *httptest.ResponseRecorder,
req *http.Request,
reqDump []byte) {
cll := buildCommonLogLine(
req, *req.URL, time.Now(), rec.Code, rec.Body.Len())
fmt.Fprintln(w, string(cll))
if !l || len(reqDump) == 0 {
return
}
fmt.Fprintln(w, "")
fmt.Fprint(w, " -------------------------- ")
fmt.Fprint(w, "HTTP REQUEST (SERVER)")
fmt.Fprintln(w, " --------------------------")
gotil.WriteIndented(w, reqDump)
}
func logResponse(
w io.Writer,
rec *httptest.ResponseRecorder,
req *http.Request) {
fmt.Fprint(w, " -------------------------- ")
fmt.Fprint(w, "HTTP RESPONSE (SERVER)")
fmt.Fprintln(w, " -------------------------")
for k, v := range rec.HeaderMap {
fmt.Fprintf(w, " %s=%s\n", k, strings.Join(v, ","))
}
fmt.Fprintln(w, "")
if !isBinaryContent(rec.HeaderMap) {
gotil.WriteIndented(w, rec.Body.Bytes())
}
}
func isBinaryContent(headers http.Header) bool {
v, ok := headers["Content-Type"]
if !ok || len(v) == 0 {
return false
}
return v[0] == "application/octet-stream"
}
// buildCommonLogLine builds a log entry for req in Apache Common Log Format.
// ts is the timestamp with which the entry should be logged.
// status and size are used to provide the response HTTP status and size.
//
// This function was taken from the Gorilla toolkit's handlers.go file.
func buildCommonLogLine(
req *http.Request,
url url.URL,
ts time.Time,
status int,
size int) []byte {
username := "-"
if url.User != nil {
if name := url.User.Username(); name != "" {
username = name
}
}
host, _, err := net.SplitHostPort(req.RemoteAddr)
if err != nil {
host = req.RemoteAddr
}
uri := req.RequestURI
// Requests using the CONNECT method over HTTP/2.0 must use
// the authority field (aka r.Host) to identify the target.
// Refer: https://httpwg.github.io/specs/rfc7540.html#CONNECT
if req.ProtoMajor == 2 && req.Method == "CONNECT" {
uri = req.Host
}
if uri == "" {
uri = url.RequestURI()
}
buf := make([]byte, 0, 3*(len(host)+len(username)+
len(req.Method)+len(uri)+len(req.Proto)+50)/2)
buf = append(buf, host...)
buf = append(buf, " - "...)
buf = append(buf, username...)
buf = append(buf, " ["...)
buf = append(buf, ts.Format("02/Jan/2006:15:04:05 -0700")...)
buf = append(buf, `] "`...)
buf = append(buf, req.Method...)
buf = append(buf, " "...)
buf = appendQuoted(buf, uri)
buf = append(buf, " "...)
buf = append(buf, req.Proto...)
buf = append(buf, `" `...)
buf = append(buf, strconv.Itoa(status)...)
buf = append(buf, " "...)
buf = append(buf, strconv.Itoa(size)...)
return buf
}
func appendQuoted(buf []byte, s string) []byte {
var runeTmp [utf8.UTFMax]byte
for width := 0; len(s) > 0; s = s[width:] {
r := rune(s[0])
width = 1
if r >= utf8.RuneSelf {
r, width = utf8.DecodeRuneInString(s)
}
if width == 1 && r == utf8.RuneError {
buf = append(buf, `\x`...)
buf = append(buf, lowerhex[s[0]>>4])
buf = append(buf, lowerhex[s[0]&0xF])
continue
}
if r == rune('"') || r == '\\' { // always backslashed
buf = append(buf, '\\')
buf = append(buf, byte(r))
continue
}
if strconv.IsPrint(r) {
n := utf8.EncodeRune(runeTmp[:], r)
buf = append(buf, runeTmp[:n]...)
continue
}
buf = appendRune(buf, s, r)
}
return buf
}
func appendRune(buf []byte, s string, r rune) []byte {
switch r {
case '\a':
buf = append(buf, `\a`...)
case '\b':
buf = append(buf, `\b`...)
case '\f':
buf = append(buf, `\f`...)
case '\n':
buf = append(buf, `\n`...)
case '\r':
buf = append(buf, `\r`...)
case '\t':
buf = append(buf, `\t`...)
case '\v':
buf = append(buf, `\v`...)
default:
switch {
case r < ' ':
buf = append(buf, `\x`...)
buf = append(buf, lowerhex[s[0]>>4])
buf = append(buf, lowerhex[s[0]&0xF])
case r > utf8.MaxRune:
r = 0xFFFD
fallthrough
case r < 0x10000:
buf = append(buf, `\u`...)
for s := 12; s >= 0; s -= 4 {
buf = append(buf, lowerhex[r>>uint(s)&0xF])
}
default:
buf = append(buf, `\U`...)
for s := 28; s >= 0; s -= 4 {
buf = append(buf, lowerhex[r>>uint(s)&0xF])
}
}
}
return buf
}