-
Notifications
You must be signed in to change notification settings - Fork 17
/
ipfs.go
338 lines (300 loc) · 11.3 KB
/
ipfs.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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
package httpserver
import (
"context"
"errors"
"fmt"
"net/http"
"strconv"
"strings"
"github.com/filecoin-project/lassie/pkg/build"
"github.com/filecoin-project/lassie/pkg/heyfil"
"github.com/filecoin-project/lassie/pkg/retriever"
"github.com/filecoin-project/lassie/pkg/storage"
"github.com/filecoin-project/lassie/pkg/types"
"github.com/ipfs/go-cid"
"github.com/ipfs/go-unixfsnode"
"github.com/ipld/go-car/v2/storage/deferred"
cidlink "github.com/ipld/go-ipld-prime/linking/cid"
trustlessutils "github.com/ipld/go-trustless-utils"
trustlesshttp "github.com/ipld/go-trustless-utils/http"
"github.com/multiformats/go-multicodec"
)
func IpfsHandler(fetcher types.Fetcher, cfg HttpServerConfig) func(http.ResponseWriter, *http.Request) {
return func(res http.ResponseWriter, req *http.Request) {
statusLogger := newStatusLogger(req.Method, req.URL.Path)
if !checkGet(req, res, statusLogger) {
return
}
ok, request := decodeRetrievalRequest(cfg, res, req, statusLogger)
if !ok {
return
}
ok, fileName := decodeFilename(res, req, statusLogger, request.Root)
if !ok {
return
}
// TODO: this needs to be propagated through the request, perhaps on
// RetrievalRequest or we decode it as a UUID and override RetrievalID?
requestId := req.Header.Get("X-Request-Id")
if requestId == "" {
requestId = request.RetrievalID.String()
} else {
logger.Debugw("custom X-Request-Id fore retrieval", "request_id", requestId, "retrieval_id", request.RetrievalID)
}
tempStore := storage.NewDeferredStorageCar(cfg.TempDir, request.Root)
var carWriter storage.DeferredWriter
if request.Duplicates {
carWriter = storage.NewDuplicateAdderCarForStream(req.Context(), res, request.Root, request.Path, request.Scope, request.Bytes, tempStore)
} else {
carWriter = deferred.NewDeferredCarWriterForStream(res, []cid.Cid{request.Root})
}
carStore := storage.NewCachingTempStore(carWriter.BlockWriteOpener(), tempStore)
defer func() {
if err := carStore.Close(); err != nil {
logger.Errorf("error closing temp store: %s", err)
}
}()
request.LinkSystem.SetWriteStorage(carStore)
request.LinkSystem.SetReadStorage(carStore)
// setup preload storage for bitswap, the temporary CAR store can set up a
// separate preload space in its storage
request.PreloadLinkSystem = cidlink.DefaultLinkSystem()
preloadStore := carStore.PreloadStore()
request.PreloadLinkSystem.SetReadStorage(preloadStore)
request.PreloadLinkSystem.SetWriteStorage(preloadStore)
request.PreloadLinkSystem.TrustedStorage = true
// bytesWritten will be closed once we've started writing CAR content to
// the response writer. Once closed, no other content should be written.
bytesWritten := make(chan struct{}, 1)
carWriter.OnPut(func(int) {
// called once we start writing blocks into the CAR (on the first Put())
res.Header().Set("Server", build.UserAgent) // "lassie/vx.y.z-<git commit hash>"
res.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%q", fileName))
res.Header().Set("Accept-Ranges", "none")
res.Header().Set("Cache-Control", trustlesshttp.ResponseCacheControlHeader)
res.Header().Set("Content-Type", trustlesshttp.DefaultContentType().WithDuplicates(request.Duplicates).String())
res.Header().Set("Etag", request.Etag())
res.Header().Set("X-Content-Type-Options", "nosniff")
res.Header().Set("X-Ipfs-Path", trustlessutils.PathEscape(req.URL.Path))
res.Header().Set("X-Trace-Id", requestId)
statusLogger.logStatus(200, "OK")
close(bytesWritten)
}, true)
logger.Debugw("fetching",
"retrieval_id", request.RetrievalID,
"root", request.Root.String(),
"path", request.Path,
"dag-scope", request.Scope,
"entity-bytes", request.Bytes,
"dups", request.Duplicates,
"maxBlocks", request.MaxBlocks,
)
stats, err := fetcher.Fetch(req.Context(), request, types.WithEventsCallback(servertimingsSubscriber(req, bytesWritten)))
// force all blocks to flush
if cerr := carWriter.Close(); cerr != nil && !errors.Is(cerr, context.Canceled) {
logger.Infof("error closing car writer: %s", cerr)
}
if err != nil {
select {
case <-bytesWritten:
logger.Debugw("unclean close", "cid", request.Root, "retrievalID", request.RetrievalID)
if err := closeWithUnterminatedChunk(res); err != nil {
logger.Infow("unable to send early termination", "err", err)
}
return
default:
}
if errors.Is(err, retriever.ErrNoCandidates) {
errorResponse(res, statusLogger, http.StatusBadGateway, errors.New("no candidates found"))
} else {
errorResponse(res, statusLogger, http.StatusGatewayTimeout, fmt.Errorf("failed to fetch CID: %w", err))
}
return
}
logger.Debugw("successfully fetched",
"retrieval_id", request.RetrievalID,
"root", request.Root.String(),
"path", request.Path,
"dag-scope", request.Scope,
"entity-bytes", request.Bytes,
"dups", request.Duplicates,
"maxBlocks", request.MaxBlocks,
"duration", stats.Duration,
"bytes", stats.Size,
)
}
}
func checkGet(req *http.Request, res http.ResponseWriter, statusLogger *statusLogger) bool {
// filter out everything but GET requests
if req.Method == http.MethodGet {
return true
}
res.Header().Add("Allow", http.MethodGet)
errorResponse(res, statusLogger, http.StatusMethodNotAllowed, errors.New("method not allowed"))
return false
}
func decodeRequest(res http.ResponseWriter, req *http.Request, statusLogger *statusLogger) (bool, trustlessutils.Request) {
rootCid, path, err := trustlesshttp.ParseUrlPath(req.URL.Path)
if err != nil {
if errors.Is(err, trustlesshttp.ErrPathNotFound) {
errorResponse(res, statusLogger, http.StatusNotFound, err)
} else if errors.Is(err, trustlesshttp.ErrBadCid) {
errorResponse(res, statusLogger, http.StatusBadRequest, err)
} else {
errorResponse(res, statusLogger, http.StatusInternalServerError, err)
}
return false, trustlessutils.Request{}
}
accepts, err := trustlesshttp.CheckFormat(req)
if err != nil {
errorResponse(res, statusLogger, http.StatusBadRequest, err)
return false, trustlessutils.Request{}
}
// TODO: accepts[0] should be acceptable but it may be for a
// application/ipld.vnd.raw (IsRaw()) which we don't currently support; we
// should add support for it in the daemon and allow accepts[0] to be chosen.
var accept trustlesshttp.ContentType
for _, a := range accepts {
if a.IsCar() {
accept = a
break
}
}
if !accept.IsCar() {
errorResponse(res, statusLogger, http.StatusNotAcceptable, fmt.Errorf("invalid Accept header or format parameter; unsupported %q", req.Header.Get("Accept")))
}
dagScope, err := trustlesshttp.ParseScope(req)
if err != nil {
errorResponse(res, statusLogger, http.StatusBadRequest, err)
return false, trustlessutils.Request{}
}
byteRange, err := trustlesshttp.ParseByteRange(req)
if err != nil {
errorResponse(res, statusLogger, http.StatusBadRequest, err)
return false, trustlessutils.Request{}
}
return true, trustlessutils.Request{
Root: rootCid,
Path: path.String(),
Scope: dagScope,
Bytes: byteRange,
Duplicates: accept.Duplicates,
}
}
func decodeRetrievalRequest(cfg HttpServerConfig, res http.ResponseWriter, req *http.Request, statusLogger *statusLogger) (bool, types.RetrievalRequest) {
ok, request := decodeRequest(res, req, statusLogger)
if !ok {
return false, types.RetrievalRequest{}
}
protocols, err := parseProtocols(req)
if err != nil {
errorResponse(res, statusLogger, http.StatusBadRequest, err)
return false, types.RetrievalRequest{}
}
providers, err := parseProviders(req)
if err != nil {
errorResponse(res, statusLogger, http.StatusBadRequest, err)
return false, types.RetrievalRequest{}
}
// extract block limit from query param as needed
var maxBlocks uint64
if req.URL.Query().Has("blockLimit") {
if parsedBlockLimit, err := strconv.ParseUint(req.URL.Query().Get("blockLimit"), 10, 64); err == nil {
maxBlocks = parsedBlockLimit
}
}
// use the lowest non-zero value for block limit
if maxBlocks == 0 || (cfg.MaxBlocksPerRequest > 0 && maxBlocks > cfg.MaxBlocksPerRequest) {
maxBlocks = cfg.MaxBlocksPerRequest
}
retrievalId, err := types.NewRetrievalID()
if err != nil {
errorResponse(res, statusLogger, http.StatusInternalServerError, fmt.Errorf("failed to generate retrieval ID: %w", err))
return false, types.RetrievalRequest{}
}
linkSystem := cidlink.DefaultLinkSystem()
linkSystem.TrustedStorage = true
unixfsnode.AddUnixFSReificationToLinkSystem(&linkSystem)
return true, types.RetrievalRequest{
Request: request,
RetrievalID: retrievalId,
LinkSystem: linkSystem,
Protocols: protocols,
Providers: providers,
MaxBlocks: maxBlocks,
}
}
func decodeFilename(res http.ResponseWriter, req *http.Request, statusLogger *statusLogger, root cid.Cid) (bool, string) {
fileName, err := trustlesshttp.ParseFilename(req)
if err != nil {
errorResponse(res, statusLogger, http.StatusBadRequest, err)
return false, ""
}
// for setting Content-Disposition header based on filename url parameter
if fileName == "" {
fileName = fmt.Sprintf("%s%s", root, trustlesshttp.FilenameExtCar)
}
return true, fileName
}
// statusLogger is a logger for logging response statuses for a given request
type statusLogger struct {
method string
path string
}
func newStatusLogger(method string, path string) *statusLogger {
return &statusLogger{method, path}
}
// logStatus logs the method, path, status code and message
func (l statusLogger) logStatus(statusCode int, message string) {
logger.Infof("%s\t%s\t%d: %s\n", l.method, l.path, statusCode, message)
}
func parseProtocols(req *http.Request) ([]multicodec.Code, error) {
if req.URL.Query().Has("protocols") {
return types.ParseProtocolsString(req.URL.Query().Get("protocols"))
}
return nil, nil
}
func parseProviders(req *http.Request) ([]types.Provider, error) {
if req.URL.Query().Has("providers") {
// in case we have been given filecoin actor addresses we can look them up
// with heyfil and translate to full multiaddrs, otherwise this is a
// pass-through
trans, err := heyfil.Heyfil{TranslateFaddr: true}.TranslateAll(strings.Split(req.URL.Query().Get("providers"), ","))
if err != nil {
return nil, err
}
providers, err := types.ParseProviderStrings(strings.Join(trans, ","))
if err != nil {
return nil, errors.New("invalid providers parameter")
}
return providers, nil
}
return nil, nil
}
// errorResponse logs and replies to the request with the status code and error
func errorResponse(res http.ResponseWriter, statusLogger *statusLogger, code int, err error) {
statusLogger.logStatus(code, err.Error())
http.Error(res, err.Error(), code)
}
// closeWithUnterminatedChunk attempts to take control of the the http conn and terminate the stream early
func closeWithUnterminatedChunk(res http.ResponseWriter) error {
hijacker, ok := res.(http.Hijacker)
if !ok {
return errors.New("unable to access hijack interface")
}
conn, buf, err := hijacker.Hijack()
if err != nil {
return fmt.Errorf("unable to access conn through hijack interface: %w", err)
}
if _, err := buf.Write(trustlesshttp.ResponseChunkDelimeter); err != nil {
return fmt.Errorf("writing response chunk delimiter: %w", err)
}
if err := buf.Flush(); err != nil {
return fmt.Errorf("flushing buff: %w", err)
}
// attempt to close just the write side
if err := conn.Close(); err != nil {
return fmt.Errorf("closing write conn: %w", err)
}
return nil
}