diff --git a/assets/README.md b/assets/README.md
index 02af2f19ca0..b342d080101 100644
--- a/assets/README.md
+++ b/assets/README.md
@@ -3,13 +3,3 @@
This directory contains the go-ipfs assets:
* Getting started documentation (`init-doc`).
-* Directory listing HTML template (`dir-index-html`).
-
-## Re-generating
-
-Edit the source files and use `go generate` from within the
-assets directory:
-
-```
-go generate .
-```
diff --git a/assets/assets.go b/assets/assets.go
index 37cbbfad5db..00792d511d3 100644
--- a/assets/assets.go
+++ b/assets/assets.go
@@ -1,30 +1,22 @@
-//go:generate npm run build --prefix ./dir-index-html/
package assets
import (
"embed"
"fmt"
- "io"
- "io/fs"
gopath "path"
- "strconv"
"github.com/ipfs/kubo/core"
"github.com/ipfs/kubo/core/coreapi"
- "github.com/cespare/xxhash"
cid "github.com/ipfs/go-cid"
"github.com/ipfs/go-libipfs/files"
options "github.com/ipfs/interface-go-ipfs-core/options"
"github.com/ipfs/interface-go-ipfs-core/path"
)
-//go:embed init-doc dir-index-html/dir-index.html dir-index-html/knownIcons.txt
+//go:embed init-doc
var Asset embed.FS
-// AssetHash a non-cryptographic hash of all embedded assets
-var AssetHash string
-
// initDocPaths lists the paths for the docs we want to seed during --init
var initDocPaths = []string{
gopath.Join("init-doc", "about"),
@@ -36,32 +28,6 @@ var initDocPaths = []string{
gopath.Join("init-doc", "ping"),
}
-func init() {
- sum := xxhash.New()
- err := fs.WalkDir(Asset, ".", func(path string, d fs.DirEntry, err error) error {
- if err != nil {
- return err
- }
-
- if d.IsDir() {
- return nil
- }
-
- file, err := Asset.Open(path)
- if err != nil {
- return err
- }
- defer file.Close()
- _, err = io.Copy(sum, file)
- return err
- })
- if err != nil {
- panic("error creating asset sum: " + err.Error())
- }
-
- AssetHash = strconv.FormatUint(sum.Sum64(), 32)
-}
-
// SeedInitDocs adds the list of embedded init documentation to the passed node, pins it and returns the root key
func SeedInitDocs(nd *core.IpfsNode) (cid.Cid, error) {
return addAssetList(nd, initDocPaths)
diff --git a/assets/dag-index-html/README.md b/assets/dag-index-html/README.md
deleted file mode 100644
index de38a9504a1..00000000000
--- a/assets/dag-index-html/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# dag-index-html
-
-> HTML representation for non-UnixFS DAGs such as DAG-CBOR.
diff --git a/assets/dag-index-html/index.go b/assets/dag-index-html/index.go
deleted file mode 100644
index 214b06a3822..00000000000
--- a/assets/dag-index-html/index.go
+++ /dev/null
@@ -1,81 +0,0 @@
-package dagindexhtml
-
-import "html/template"
-
-// TODO: DagIndexTemplate - replace static CSS with shared one with ../dir-index-html
-
-// DagIndexTemplate is HTML-based template for non-UnixFS DAGs when request was
-// made with Accept: text/html (web browsers).
-var DagIndexTemplate = template.Must(template.New("redirect").Parse(`
-
-
- {{ .Path }}
-
-
-
-
-
-
-
-
-
-
- Preview as JSON (application/json)
-
-
-
-
- Or download as:
-
-
-
-
-
-
-
{{ .Path }}
-
-
-
-
-
-
-
-
- {{ if .BackLink }}
-
-
-
-
-
- ..
-
-
- {{ end }}
- {{ range .Listing }}
-
-
-
-
-
- {{ .Name }}
-
-
- {{ if .Hash }}
-
- {{ .ShortHash }}
-
- {{ end }}
-
- {{ .Size }}
-
- {{ end }}
-
-
-
{{ .Path }}
-
-
-
-
-
-
-
- {{ if .BackLink }}
-
-
-
-
-
- ..
-
-
- {{ end }}
- {{ range .Listing }}
-
-
-
-
-
- {{ .Name }}
-
-
- {{ if .Hash }}
-
- {{ .ShortHash }}
-
- {{ end }}
-
- {{ .Size }}
-
- {{ end }}
-
-
-
{{.ErrorMsg}} (if a redirect does not happen in 10 seconds, use "{{.SuggestedPath}}" instead)
-
-`))
-
-type redirectTemplateData struct {
- RedirectURL string
- SuggestedPath string
- ErrorMsg string
-}
-
-// gatewayHandler is a HTTP handler that serves IPFS objects (accessible by default at /ipfs/)
-// (it serves requests like GET /ipfs/QmVRzPKPzNtSrEzBFm2UZfxmPAgnaLke4DMcerbsGGSaFe/link)
-type gatewayHandler struct {
- config GatewayConfig
- api NodeAPI
- offlineAPI NodeAPI
-
- // generic metrics
- firstContentBlockGetMetric *prometheus.HistogramVec
- unixfsGetMetric *prometheus.SummaryVec // deprecated, use firstContentBlockGetMetric
-
- // response type metrics
- unixfsFileGetMetric *prometheus.HistogramVec
- unixfsGenDirGetMetric *prometheus.HistogramVec
- carStreamGetMetric *prometheus.HistogramVec
- rawBlockGetMetric *prometheus.HistogramVec
-}
-
-// StatusResponseWriter enables us to override HTTP Status Code passed to
-// WriteHeader function inside of http.ServeContent. Decision is based on
-// presence of HTTP Headers such as Location.
-type statusResponseWriter struct {
- http.ResponseWriter
-}
-
-// Custom type for collecting error details to be handled by `webRequestError`
-type requestError struct {
- Message string
- StatusCode int
- Err error
-}
-
-func (r *requestError) Error() string {
- return r.Err.Error()
-}
-
-func newRequestError(message string, err error, statusCode int) *requestError {
- return &requestError{
- Message: message,
- Err: err,
- StatusCode: statusCode,
- }
-}
-
-func (sw *statusResponseWriter) WriteHeader(code int) {
- // Check if we need to adjust Status Code to account for scheduled redirect
- // This enables us to return payload along with HTTP 301
- // for subdomain redirect in web browsers while also returning body for cli
- // tools which do not follow redirects by default (curl, wget).
- redirect := sw.ResponseWriter.Header().Get("Location")
- if redirect != "" && code == http.StatusOK {
- code = http.StatusMovedPermanently
- log.Debugw("subdomain redirect", "location", redirect, "status", code)
- }
- sw.ResponseWriter.WriteHeader(code)
-}
-
-// ServeContent replies to the request using the content in the provided ReadSeeker
-// and returns the status code written and any error encountered during a write.
-// It wraps http.ServeContent which takes care of If-None-Match+Etag,
-// Content-Length and range requests.
-func ServeContent(w http.ResponseWriter, req *http.Request, name string, modtime time.Time, content io.ReadSeeker) (int, bool, error) {
- ew := &errRecordingResponseWriter{ResponseWriter: w}
- http.ServeContent(ew, req, name, modtime, content)
-
- // When we calculate some metrics we want a flag that lets us to ignore
- // errors and 304 Not Modified, and only care when requested data
- // was sent in full.
- dataSent := ew.code/100 == 2 && ew.err == nil
-
- return ew.code, dataSent, ew.err
-}
-
-// errRecordingResponseWriter wraps a ResponseWriter to record the status code and any write error.
-type errRecordingResponseWriter struct {
- http.ResponseWriter
- code int
- err error
-}
-
-func (w *errRecordingResponseWriter) WriteHeader(code int) {
- if w.code == 0 {
- w.code = code
- }
- w.ResponseWriter.WriteHeader(code)
-}
-
-func (w *errRecordingResponseWriter) Write(p []byte) (int, error) {
- n, err := w.ResponseWriter.Write(p)
- if err != nil && w.err == nil {
- w.err = err
- }
- return n, err
-}
-
-// ReadFrom exposes errRecordingResponseWriter's underlying ResponseWriter to io.Copy
-// to allow optimized methods to be taken advantage of.
-func (w *errRecordingResponseWriter) ReadFrom(r io.Reader) (n int64, err error) {
- n, err = io.Copy(w.ResponseWriter, r)
- if err != nil && w.err == nil {
- w.err = err
- }
- return n, err
-}
-
-func newGatewaySummaryMetric(name string, help string) *prometheus.SummaryVec {
- summaryMetric := prometheus.NewSummaryVec(
- prometheus.SummaryOpts{
- Namespace: "ipfs",
- Subsystem: "http",
- Name: name,
- Help: help,
- },
- []string{"gateway"},
- )
- if err := prometheus.Register(summaryMetric); err != nil {
- if are, ok := err.(prometheus.AlreadyRegisteredError); ok {
- summaryMetric = are.ExistingCollector.(*prometheus.SummaryVec)
- } else {
- log.Errorf("failed to register ipfs_http_%s: %v", name, err)
- }
- }
- return summaryMetric
-}
-
-func newGatewayHistogramMetric(name string, help string) *prometheus.HistogramVec {
- // We can add buckets as a parameter in the future, but for now using static defaults
- // suggested in https://github.com/ipfs/kubo/issues/8441
- defaultBuckets := []float64{0.05, 0.1, 0.25, 0.5, 1, 2, 5, 10, 30, 60}
- histogramMetric := prometheus.NewHistogramVec(
- prometheus.HistogramOpts{
- Namespace: "ipfs",
- Subsystem: "http",
- Name: name,
- Help: help,
- Buckets: defaultBuckets,
- },
- []string{"gateway"},
- )
- if err := prometheus.Register(histogramMetric); err != nil {
- if are, ok := err.(prometheus.AlreadyRegisteredError); ok {
- histogramMetric = are.ExistingCollector.(*prometheus.HistogramVec)
- } else {
- log.Errorf("failed to register ipfs_http_%s: %v", name, err)
- }
- }
- return histogramMetric
-}
-
-// NewGatewayHandler returns an http.Handler that can act as a gateway to IPFS content
-// offlineApi is a version of the API that should not make network requests for missing data
-func NewGatewayHandler(c GatewayConfig, api NodeAPI, offlineAPI NodeAPI) http.Handler {
- return newGatewayHandler(c, api, offlineAPI)
-}
-
-func newGatewayHandler(c GatewayConfig, api NodeAPI, offlineAPI NodeAPI) *gatewayHandler {
- i := &gatewayHandler{
- config: c,
- api: api,
- offlineAPI: offlineAPI,
- // Improved Metrics
- // ----------------------------
- // Time till the first content block (bar in /ipfs/cid/foo/bar)
- // (format-agnostic, across all response types)
- firstContentBlockGetMetric: newGatewayHistogramMetric(
- "gw_first_content_block_get_latency_seconds",
- "The time till the first content block is received on GET from the gateway.",
- ),
-
- // Response-type specific metrics
- // ----------------------------
- // UnixFS: time it takes to return a file
- unixfsFileGetMetric: newGatewayHistogramMetric(
- "gw_unixfs_file_get_duration_seconds",
- "The time to serve an entire UnixFS file from the gateway.",
- ),
- // UnixFS: time it takes to generate static HTML with directory listing
- unixfsGenDirGetMetric: newGatewayHistogramMetric(
- "gw_unixfs_gen_dir_listing_get_duration_seconds",
- "The time to serve a generated UnixFS HTML directory listing from the gateway.",
- ),
- // CAR: time it takes to return requested CAR stream
- carStreamGetMetric: newGatewayHistogramMetric(
- "gw_car_stream_get_duration_seconds",
- "The time to GET an entire CAR stream from the gateway.",
- ),
- // Block: time it takes to return requested Block
- rawBlockGetMetric: newGatewayHistogramMetric(
- "gw_raw_block_get_duration_seconds",
- "The time to GET an entire raw Block from the gateway.",
- ),
-
- // Legacy Metrics
- // ----------------------------
- unixfsGetMetric: newGatewaySummaryMetric( // TODO: remove?
- // (deprecated, use firstContentBlockGetMetric instead)
- "unixfs_get_latency_seconds",
- "The time to receive the first UnixFS node on a GET from the gateway.",
- ),
- }
- return i
-}
-
-func parseIpfsPath(p string) (cid.Cid, string, error) {
- rootPath, err := path.ParsePath(p)
- if err != nil {
- return cid.Cid{}, "", err
- }
-
- // Check the path.
- rsegs := rootPath.Segments()
- if rsegs[0] != "ipfs" {
- return cid.Cid{}, "", fmt.Errorf("WritableGateway: only ipfs paths supported")
- }
-
- rootCid, err := cid.Decode(rsegs[1])
- if err != nil {
- return cid.Cid{}, "", err
- }
-
- return rootCid, path.Join(rsegs[2:]), nil
-}
-
-func (i *gatewayHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
- // the hour is a hard fallback, we don't expect it to happen, but just in case
- ctx, cancel := context.WithTimeout(r.Context(), time.Hour)
- defer cancel()
- r = r.WithContext(ctx)
-
- defer func() {
- if r := recover(); r != nil {
- log.Error("A panic occurred in the gateway handler!")
- log.Error(r)
- debug.PrintStack()
- }
- }()
-
- if i.config.Writable {
- switch r.Method {
- case http.MethodPost:
- i.postHandler(w, r)
- return
- case http.MethodPut:
- i.putHandler(w, r)
- return
- case http.MethodDelete:
- i.deleteHandler(w, r)
- return
- }
- }
-
- switch r.Method {
- case http.MethodGet, http.MethodHead:
- i.getOrHeadHandler(w, r)
- return
- case http.MethodOptions:
- i.optionsHandler(w, r)
- return
- }
-
- errmsg := "Method " + r.Method + " not allowed: "
- var status int
- if !i.config.Writable {
- status = http.StatusMethodNotAllowed
- errmsg = errmsg + "read only access"
- w.Header().Add("Allow", http.MethodGet)
- w.Header().Add("Allow", http.MethodHead)
- w.Header().Add("Allow", http.MethodOptions)
- } else {
- status = http.StatusBadRequest
- errmsg = errmsg + "bad request for " + r.URL.Path
- }
- http.Error(w, errmsg, status)
-}
-
-func (i *gatewayHandler) optionsHandler(w http.ResponseWriter, r *http.Request) {
- /*
- OPTIONS is a noop request that is used by the browsers to check
- if server accepts cross-site XMLHttpRequest (indicated by the presence of CORS headers)
- https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS#Preflighted_requests
- */
- i.addUserHeaders(w) // return all custom headers (including CORS ones, if set)
-}
-
-func (i *gatewayHandler) getOrHeadHandler(w http.ResponseWriter, r *http.Request) {
- begin := time.Now()
-
- logger := log.With("from", r.RequestURI)
- logger.Debug("http request received")
-
- if err := handleUnsupportedHeaders(r); err != nil {
- webRequestError(w, err)
- return
- }
-
- if requestHandled := handleProtocolHandlerRedirect(w, r, logger); requestHandled {
- return
- }
-
- if err := handleServiceWorkerRegistration(r); err != nil {
- webRequestError(w, err)
- return
- }
-
- contentPath := ipath.New(r.URL.Path)
-
- if requestHandled := i.handleOnlyIfCached(w, r, contentPath, logger); requestHandled {
- return
- }
-
- if requestHandled := handleSuperfluousNamespace(w, r, contentPath); requestHandled {
- return
- }
-
- // Detect when explicit Accept header or ?format parameter are present
- responseFormat, formatParams, err := customResponseFormat(r)
- if err != nil {
- webError(w, "error while processing the Accept header", err, http.StatusBadRequest)
- return
- }
- trace.SpanFromContext(r.Context()).SetAttributes(attribute.String("ResponseFormat", responseFormat))
-
- resolvedPath, contentPath, ok := i.handlePathResolution(w, r, responseFormat, contentPath, logger)
- if !ok {
- return
- }
- trace.SpanFromContext(r.Context()).SetAttributes(attribute.String("ResolvedPath", resolvedPath.String()))
-
- // Detect when If-None-Match HTTP header allows returning HTTP 304 Not Modified
- if inm := r.Header.Get("If-None-Match"); inm != "" {
- pathCid := resolvedPath.Cid()
- // need to check against both File and Dir Etag variants
- // because this inexpensive check happens before we do any I/O
- cidEtag := getEtag(r, pathCid)
- dirEtag := getDirListingEtag(pathCid)
- if etagMatch(inm, cidEtag, dirEtag) {
- // Finish early if client already has a matching Etag
- w.WriteHeader(http.StatusNotModified)
- return
- }
- }
-
- if err := i.handleGettingFirstBlock(r, begin, contentPath, resolvedPath); err != nil {
- webRequestError(w, err)
- return
- }
-
- if err := i.setCommonHeaders(w, r, contentPath); err != nil {
- webRequestError(w, err)
- return
- }
-
- // Support custom response formats passed via ?format or Accept HTTP header
- switch responseFormat {
- case "", "application/json", "application/cbor":
- switch mc.Code(resolvedPath.Cid().Prefix().Codec) {
- case mc.Json, mc.DagJson, mc.Cbor, mc.DagCbor:
- logger.Debugw("serving codec", "path", contentPath)
- i.serveCodec(r.Context(), w, r, resolvedPath, contentPath, begin, responseFormat)
- default:
- logger.Debugw("serving unixfs", "path", contentPath)
- i.serveUnixFS(r.Context(), w, r, resolvedPath, contentPath, begin, logger)
- }
- return
- case "application/vnd.ipld.raw":
- logger.Debugw("serving raw block", "path", contentPath)
- i.serveRawBlock(r.Context(), w, r, resolvedPath, contentPath, begin)
- return
- case "application/vnd.ipld.car":
- logger.Debugw("serving car stream", "path", contentPath)
- carVersion := formatParams["version"]
- i.serveCAR(r.Context(), w, r, resolvedPath, contentPath, carVersion, begin)
- return
- case "application/x-tar":
- logger.Debugw("serving tar file", "path", contentPath)
- i.serveTAR(r.Context(), w, r, resolvedPath, contentPath, begin, logger)
- return
- case "application/vnd.ipld.dag-json", "application/vnd.ipld.dag-cbor":
- logger.Debugw("serving codec", "path", contentPath)
- i.serveCodec(r.Context(), w, r, resolvedPath, contentPath, begin, responseFormat)
- case "application/vnd.ipfs.ipns-record":
- logger.Debugw("serving ipns record", "path", contentPath)
- i.serveIpnsRecord(r.Context(), w, r, resolvedPath, contentPath, begin, logger)
- return
- default: // catch-all for unsuported application/vnd.*
- err := fmt.Errorf("unsupported format %q", responseFormat)
- webError(w, "failed to respond with requested content type", err, http.StatusBadRequest)
- return
- }
-}
-
-func (i *gatewayHandler) postHandler(w http.ResponseWriter, r *http.Request) {
- p, err := i.api.Unixfs().Add(r.Context(), files.NewReaderFile(r.Body))
- if err != nil {
- internalWebError(w, err)
- return
- }
-
- i.addUserHeaders(w) // ok, _now_ write user's headers.
- w.Header().Set("IPFS-Hash", p.Cid().String())
- log.Debugw("CID created, http redirect", "from", r.URL, "to", p, "status", http.StatusCreated)
- http.Redirect(w, r, p.String(), http.StatusCreated)
-}
-
-func (i *gatewayHandler) putHandler(w http.ResponseWriter, r *http.Request) {
- ctx := r.Context()
- ds := i.api.Dag()
-
- // Parse the path
- rootCid, newPath, err := parseIpfsPath(r.URL.Path)
- if err != nil {
- webError(w, "WritableGateway: failed to parse the path", err, http.StatusBadRequest)
- return
- }
- if newPath == "" || newPath == "/" {
- http.Error(w, "WritableGateway: empty path", http.StatusBadRequest)
- return
- }
- newDirectory, newFileName := gopath.Split(newPath)
-
- // Resolve the old root.
-
- rnode, err := ds.Get(ctx, rootCid)
- if err != nil {
- webError(w, "WritableGateway: Could not create DAG from request", err, http.StatusInternalServerError)
- return
- }
-
- pbnd, ok := rnode.(*dag.ProtoNode)
- if !ok {
- webError(w, "Cannot read non protobuf nodes through gateway", dag.ErrNotProtobuf, http.StatusBadRequest)
- return
- }
-
- // Create the new file.
- newFilePath, err := i.api.Unixfs().Add(ctx, files.NewReaderFile(r.Body))
- if err != nil {
- webError(w, "WritableGateway: could not create DAG from request", err, http.StatusInternalServerError)
- return
- }
-
- newFile, err := ds.Get(ctx, newFilePath.Cid())
- if err != nil {
- webError(w, "WritableGateway: failed to resolve new file", err, http.StatusInternalServerError)
- return
- }
-
- // Patch the new file into the old root.
-
- root, err := mfs.NewRoot(ctx, ds, pbnd, nil)
- if err != nil {
- webError(w, "WritableGateway: failed to create MFS root", err, http.StatusBadRequest)
- return
- }
-
- if newDirectory != "" {
- err := mfs.Mkdir(root, newDirectory, mfs.MkdirOpts{Mkparents: true, Flush: false})
- if err != nil {
- webError(w, "WritableGateway: failed to create MFS directory", err, http.StatusInternalServerError)
- return
- }
- }
- dirNode, err := mfs.Lookup(root, newDirectory)
- if err != nil {
- webError(w, "WritableGateway: failed to lookup directory", err, http.StatusInternalServerError)
- return
- }
- dir, ok := dirNode.(*mfs.Directory)
- if !ok {
- http.Error(w, "WritableGateway: target directory is not a directory", http.StatusBadRequest)
- return
- }
- err = dir.Unlink(newFileName)
- switch err {
- case os.ErrNotExist, nil:
- default:
- webError(w, "WritableGateway: failed to replace existing file", err, http.StatusBadRequest)
- return
- }
- err = dir.AddChild(newFileName, newFile)
- if err != nil {
- webError(w, "WritableGateway: failed to link file into directory", err, http.StatusInternalServerError)
- return
- }
- nnode, err := root.GetDirectory().GetNode()
- if err != nil {
- webError(w, "WritableGateway: failed to finalize", err, http.StatusInternalServerError)
- return
- }
- newcid := nnode.Cid()
-
- i.addUserHeaders(w) // ok, _now_ write user's headers.
- w.Header().Set("IPFS-Hash", newcid.String())
-
- redirectURL := gopath.Join(ipfsPathPrefix, newcid.String(), newPath)
- log.Debugw("CID replaced, redirect", "from", r.URL, "to", redirectURL, "status", http.StatusCreated)
- http.Redirect(w, r, redirectURL, http.StatusCreated)
-}
-
-func (i *gatewayHandler) deleteHandler(w http.ResponseWriter, r *http.Request) {
- ctx := r.Context()
-
- // parse the path
-
- rootCid, newPath, err := parseIpfsPath(r.URL.Path)
- if err != nil {
- webError(w, "WritableGateway: failed to parse the path", err, http.StatusBadRequest)
- return
- }
- if newPath == "" || newPath == "/" {
- http.Error(w, "WritableGateway: empty path", http.StatusBadRequest)
- return
- }
- directory, filename := gopath.Split(newPath)
-
- // lookup the root
-
- rootNodeIPLD, err := i.api.Dag().Get(ctx, rootCid)
- if err != nil {
- webError(w, "WritableGateway: failed to resolve root CID", err, http.StatusInternalServerError)
- return
- }
- rootNode, ok := rootNodeIPLD.(*dag.ProtoNode)
- if !ok {
- http.Error(w, "WritableGateway: empty path", http.StatusInternalServerError)
- return
- }
-
- // construct the mfs root
-
- root, err := mfs.NewRoot(ctx, i.api.Dag(), rootNode, nil)
- if err != nil {
- webError(w, "WritableGateway: failed to construct the MFS root", err, http.StatusBadRequest)
- return
- }
-
- // lookup the parent directory
-
- parentNode, err := mfs.Lookup(root, directory)
- if err != nil {
- webError(w, "WritableGateway: failed to look up parent", err, http.StatusInternalServerError)
- return
- }
-
- parent, ok := parentNode.(*mfs.Directory)
- if !ok {
- http.Error(w, "WritableGateway: parent is not a directory", http.StatusInternalServerError)
- return
- }
-
- // delete the file
-
- switch parent.Unlink(filename) {
- case nil, os.ErrNotExist:
- default:
- webError(w, "WritableGateway: failed to remove file", err, http.StatusInternalServerError)
- return
- }
-
- nnode, err := root.GetDirectory().GetNode()
- if err != nil {
- webError(w, "WritableGateway: failed to finalize", err, http.StatusInternalServerError)
- return
- }
- ncid := nnode.Cid()
-
- i.addUserHeaders(w) // ok, _now_ write user's headers.
- w.Header().Set("IPFS-Hash", ncid.String())
-
- redirectURL := gopath.Join(ipfsPathPrefix+ncid.String(), directory)
- // note: StatusCreated is technically correct here as we created a new resource.
- log.Debugw("CID deleted, redirect", "from", r.RequestURI, "to", redirectURL, "status", http.StatusCreated)
- http.Redirect(w, r, redirectURL, http.StatusCreated)
-}
-
-func (i *gatewayHandler) addUserHeaders(w http.ResponseWriter) {
- for k, v := range i.config.Headers {
- w.Header()[k] = v
- }
-}
-
-func addCacheControlHeaders(w http.ResponseWriter, r *http.Request, contentPath ipath.Path, fileCid cid.Cid) (modtime time.Time) {
- // Set Etag to based on CID (override whatever was set before)
- w.Header().Set("Etag", getEtag(r, fileCid))
-
- // Set Cache-Control and Last-Modified based on contentPath properties
- if contentPath.Mutable() {
- // mutable namespaces such as /ipns/ can't be cached forever
-
- /* For now we set Last-Modified to Now() to leverage caching heuristics built into modern browsers:
- * https://github.com/ipfs/kubo/pull/8074#pullrequestreview-645196768
- * but we should not set it to fake values and use Cache-Control based on TTL instead */
- modtime = time.Now()
-
- // TODO: set Cache-Control based on TTL of IPNS/DNSLink: https://github.com/ipfs/kubo/issues/1818#issuecomment-1015849462
- // TODO: set Last-Modified based on /ipns/ publishing timestamp?
- } else {
- // immutable! CACHE ALL THE THINGS, FOREVER! wolololol
- w.Header().Set("Cache-Control", immutableCacheControl)
-
- // Set modtime to 'zero time' to disable Last-Modified header (superseded by Cache-Control)
- modtime = noModtime
-
- // TODO: set Last-Modified? - TBD - /ipfs/ modification metadata is present in unixfs 1.5 https://github.com/ipfs/kubo/issues/6920?
- }
-
- return modtime
-}
-
-// Set Content-Disposition if filename URL query param is present, return preferred filename
-func addContentDispositionHeader(w http.ResponseWriter, r *http.Request, contentPath ipath.Path) string {
- /* This logic enables:
- * - creation of HTML links that trigger "Save As.." dialog instead of being rendered by the browser
- * - overriding the filename used when saving subresource assets on HTML page
- * - providing a default filename for HTTP clients when downloading direct /ipfs/CID without any subpath
- */
-
- // URL param ?filename=cat.jpg triggers Content-Disposition: [..] filename
- // which impacts default name used in "Save As.." dialog
- name := getFilename(contentPath)
- urlFilename := r.URL.Query().Get("filename")
- if urlFilename != "" {
- disposition := "inline"
- // URL param ?download=true triggers Content-Disposition: [..] attachment
- // which skips rendering and forces "Save As.." dialog in browsers
- if r.URL.Query().Get("download") == "true" {
- disposition = "attachment"
- }
- setContentDispositionHeader(w, urlFilename, disposition)
- name = urlFilename
- }
- return name
-}
-
-// Set Content-Disposition to arbitrary filename and disposition
-func setContentDispositionHeader(w http.ResponseWriter, filename string, disposition string) {
- utf8Name := url.PathEscape(filename)
- asciiName := url.PathEscape(onlyASCII.ReplaceAllLiteralString(filename, "_"))
- w.Header().Set("Content-Disposition", fmt.Sprintf("%s; filename=\"%s\"; filename*=UTF-8''%s", disposition, asciiName, utf8Name))
-}
-
-// Set X-Ipfs-Roots with logical CID array for efficient HTTP cache invalidation.
-func (i *gatewayHandler) buildIpfsRootsHeader(contentPath string, r *http.Request) (string, error) {
- /*
- These are logical roots where each CID represent one path segment
- and resolves to either a directory or the root block of a file.
- The main purpose of this header is allow HTTP caches to do smarter decisions
- around cache invalidation (eg. keep specific subdirectory/file if it did not change)
-
- A good example is Wikipedia, which is HAMT-sharded, but we only care about
- logical roots that represent each segment of the human-readable content
- path:
-
- Given contentPath = /ipns/en.wikipedia-on-ipfs.org/wiki/Block_of_Wikipedia_in_Turkey
- rootCidList is a generated by doing `ipfs resolve -r` on each sub path:
- /ipns/en.wikipedia-on-ipfs.org → bafybeiaysi4s6lnjev27ln5icwm6tueaw2vdykrtjkwiphwekaywqhcjze
- /ipns/en.wikipedia-on-ipfs.org/wiki/ → bafybeihn2f7lhumh4grizksi2fl233cyszqadkn424ptjajfenykpsaiw4
- /ipns/en.wikipedia-on-ipfs.org/wiki/Block_of_Wikipedia_in_Turkey → bafkreibn6euazfvoghepcm4efzqx5l3hieof2frhp254hio5y7n3hv5rma
-
- The result is an ordered array of values:
- X-Ipfs-Roots: bafybeiaysi4s6lnjev27ln5icwm6tueaw2vdykrtjkwiphwekaywqhcjze,bafybeihn2f7lhumh4grizksi2fl233cyszqadkn424ptjajfenykpsaiw4,bafkreibn6euazfvoghepcm4efzqx5l3hieof2frhp254hio5y7n3hv5rma
-
- Note that while the top one will change every time any article is changed,
- the last root (responsible for specific article) may not change at all.
- */
- var sp strings.Builder
- var pathRoots []string
- pathSegments := strings.Split(contentPath[6:], "/")
- sp.WriteString(contentPath[:5]) // /ipfs or /ipns
- for _, root := range pathSegments {
- if root == "" {
- continue
- }
- sp.WriteString("/")
- sp.WriteString(root)
- resolvedSubPath, err := i.api.ResolvePath(r.Context(), ipath.New(sp.String()))
- if err != nil {
- return "", err
- }
- pathRoots = append(pathRoots, resolvedSubPath.Cid().String())
- }
- rootCidList := strings.Join(pathRoots, ",") // convention from rfc2616#sec4.2
- return rootCidList, nil
-}
-
-func webRequestError(w http.ResponseWriter, err *requestError) {
- webError(w, err.Message, err.Err, err.StatusCode)
-}
-
-func webError(w http.ResponseWriter, message string, err error, defaultCode int) {
- if _, ok := err.(resolver.ErrNoLink); ok {
- webErrorWithCode(w, message, err, http.StatusNotFound)
- } else if err == routing.ErrNotFound {
- webErrorWithCode(w, message, err, http.StatusNotFound)
- } else if ipld.IsNotFound(err) {
- webErrorWithCode(w, message, err, http.StatusNotFound)
- } else if err == context.DeadlineExceeded {
- webErrorWithCode(w, message, err, http.StatusRequestTimeout)
- } else {
- webErrorWithCode(w, message, err, defaultCode)
- }
-}
-
-func webErrorWithCode(w http.ResponseWriter, message string, err error, code int) {
- http.Error(w, fmt.Sprintf("%s: %s", message, err), code)
- if code >= 500 {
- log.Warnf("server error: %s: %s", message, err)
- }
-}
-
-// return a 500 error and log
-func internalWebError(w http.ResponseWriter, err error) {
- webErrorWithCode(w, "internalWebError", err, http.StatusInternalServerError)
-}
-
-func getFilename(contentPath ipath.Path) string {
- s := contentPath.String()
- if (strings.HasPrefix(s, ipfsPathPrefix) || strings.HasPrefix(s, ipnsPathPrefix)) && strings.Count(gopath.Clean(s), "/") <= 2 {
- // Don't want to treat ipfs.io in /ipns/ipfs.io as a filename.
- return ""
- }
- return gopath.Base(s)
-}
-
-// etagMatch evaluates if we can respond with HTTP 304 Not Modified
-// It supports multiple weak and strong etags passed in If-None-Matc stringh
-// including the wildcard one.
-func etagMatch(ifNoneMatchHeader string, cidEtag string, dirEtag string) bool {
- buf := ifNoneMatchHeader
- for {
- buf = textproto.TrimString(buf)
- if len(buf) == 0 {
- break
- }
- if buf[0] == ',' {
- buf = buf[1:]
- continue
- }
- // If-None-Match: * should match against any etag
- if buf[0] == '*' {
- return true
- }
- etag, remain := scanETag(buf)
- if etag == "" {
- break
- }
- // Check for match both strong and weak etags
- if etagWeakMatch(etag, cidEtag) || etagWeakMatch(etag, dirEtag) {
- return true
- }
- buf = remain
- }
- return false
-}
-
-// scanETag determines if a syntactically valid ETag is present at s. If so,
-// the ETag and remaining text after consuming ETag is returned. Otherwise,
-// it returns "", "".
-// (This is the same logic as one executed inside of http.ServeContent)
-func scanETag(s string) (etag string, remain string) {
- s = textproto.TrimString(s)
- start := 0
- if strings.HasPrefix(s, "W/") {
- start = 2
- }
- if len(s[start:]) < 2 || s[start] != '"' {
- return "", ""
- }
- // ETag is either W/"text" or "text".
- // See RFC 7232 2.3.
- for i := start + 1; i < len(s); i++ {
- c := s[i]
- switch {
- // Character values allowed in ETags.
- case c == 0x21 || c >= 0x23 && c <= 0x7E || c >= 0x80:
- case c == '"':
- return s[:i+1], s[i+1:]
- default:
- return "", ""
- }
- }
- return "", ""
-}
-
-// etagWeakMatch reports whether a and b match using weak ETag comparison.
-func etagWeakMatch(a, b string) bool {
- return strings.TrimPrefix(a, "W/") == strings.TrimPrefix(b, "W/")
-}
-
-// generate Etag value based on HTTP request and CID
-func getEtag(r *http.Request, cid cid.Cid) string {
- prefix := `"`
- suffix := `"`
- responseFormat, _, err := customResponseFormat(r)
- if err == nil && responseFormat != "" {
- // application/vnd.ipld.foo → foo
- // application/x-bar → x-bar
- shortFormat := responseFormat[strings.LastIndexAny(responseFormat, "/.")+1:]
- // Etag: "cid.shortFmt" (gives us nice compression together with Content-Disposition in block (raw) and car responses)
- suffix = `.` + shortFormat + suffix
- }
- // TODO: include selector suffix when https://github.com/ipfs/kubo/issues/8769 lands
- return prefix + cid.String() + suffix
-}
-
-// return explicit response format if specified in request as query parameter or via Accept HTTP header
-func customResponseFormat(r *http.Request) (mediaType string, params map[string]string, err error) {
- if formatParam := r.URL.Query().Get("format"); formatParam != "" {
- // translate query param to a content type
- switch formatParam {
- case "raw":
- return "application/vnd.ipld.raw", nil, nil
- case "car":
- return "application/vnd.ipld.car", nil, nil
- case "tar":
- return "application/x-tar", nil, nil
- case "json":
- return "application/json", nil, nil
- case "cbor":
- return "application/cbor", nil, nil
- case "dag-json":
- return "application/vnd.ipld.dag-json", nil, nil
- case "dag-cbor":
- return "application/vnd.ipld.dag-cbor", nil, nil
- case "ipns-record":
- return "application/vnd.ipfs.ipns-record", nil, nil
- }
- }
- // Browsers and other user agents will send Accept header with generic types like:
- // Accept:text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8
- // We only care about explicit, vendor-specific content-types and respond to the first match (in order).
- // TODO: make this RFC compliant and respect weights (eg. return CAR for Accept:application/vnd.ipld.dag-json;q=0.1,application/vnd.ipld.car;q=0.2)
- for _, header := range r.Header.Values("Accept") {
- for _, value := range strings.Split(header, ",") {
- accept := strings.TrimSpace(value)
- // respond to the very first matching content type
- if strings.HasPrefix(accept, "application/vnd.ipld") ||
- strings.HasPrefix(accept, "application/x-tar") ||
- strings.HasPrefix(accept, "application/json") ||
- strings.HasPrefix(accept, "application/cbor") ||
- strings.HasPrefix(accept, "application/vnd.ipfs") {
- mediatype, params, err := mime.ParseMediaType(accept)
- if err != nil {
- return "", nil, err
- }
- return mediatype, params, nil
- }
- }
- }
- // If none of special-cased content types is found, return empty string
- // to indicate default, implicit UnixFS response should be prepared
- return "", nil, nil
-}
-
-// returns unquoted path with all special characters revealed as \u codes
-func debugStr(path string) string {
- q := fmt.Sprintf("%+q", path)
- if len(q) >= 3 {
- q = q[1 : len(q)-1]
- }
- return q
-}
-
-// Resolve the provided contentPath including any special handling related to
-// the requested responseFormat. Returned ok flag indicates if gateway handler
-// should continue processing the request.
-func (i *gatewayHandler) handlePathResolution(w http.ResponseWriter, r *http.Request, responseFormat string, contentPath ipath.Path, logger *zap.SugaredLogger) (resolvedPath ipath.Resolved, newContentPath ipath.Path, ok bool) {
- // Attempt to resolve the provided path.
- resolvedPath, err := i.api.ResolvePath(r.Context(), contentPath)
-
- switch err {
- case nil:
- return resolvedPath, contentPath, true
- case coreiface.ErrOffline:
- webError(w, "ipfs resolve -r "+debugStr(contentPath.String()), err, http.StatusServiceUnavailable)
- return nil, nil, false
- default:
- // The path can't be resolved.
- if isUnixfsResponseFormat(responseFormat) {
- // If we have origin isolation (subdomain gw, DNSLink website),
- // and response type is UnixFS (default for website hosting)
- // check for presence of _redirects file and apply rules defined there.
- // See: https://github.com/ipfs/specs/pull/290
- if hasOriginIsolation(r) {
- resolvedPath, newContentPath, ok, hadMatchingRule := i.serveRedirectsIfPresent(w, r, resolvedPath, contentPath, logger)
- if hadMatchingRule {
- logger.Debugw("applied a rule from _redirects file")
- return resolvedPath, newContentPath, ok
- }
- }
-
- // if Accept is text/html, see if ipfs-404.html is present
- // This logic isn't documented and will likely be removed at some point.
- // Any 404 logic in _redirects above will have already run by this time, so it's really an extra fall back
- if i.serveLegacy404IfPresent(w, r, contentPath) {
- logger.Debugw("served legacy 404")
- return nil, nil, false
- }
- }
-
- // Note: webError will replace http.StatusBadRequest with StatusNotFound if necessary
- webError(w, "ipfs resolve -r "+debugStr(contentPath.String()), err, http.StatusBadRequest)
- return nil, nil, false
- }
-}
-
-// Detect 'Cache-Control: only-if-cached' in request and return data if it is already in the local datastore.
-// https://github.com/ipfs/specs/blob/main/http-gateways/PATH_GATEWAY.md#cache-control-request-header
-func (i *gatewayHandler) handleOnlyIfCached(w http.ResponseWriter, r *http.Request, contentPath ipath.Path, logger *zap.SugaredLogger) (requestHandled bool) {
- if r.Header.Get("Cache-Control") == "only-if-cached" {
- _, err := i.offlineAPI.Block().Stat(r.Context(), contentPath)
- if err != nil {
- if r.Method == http.MethodHead {
- w.WriteHeader(http.StatusPreconditionFailed)
- return true
- }
- errMsg := fmt.Sprintf("%q not in local datastore", contentPath.String())
- http.Error(w, errMsg, http.StatusPreconditionFailed)
- return true
- }
- if r.Method == http.MethodHead {
- w.WriteHeader(http.StatusOK)
- return true
- }
- }
- return false
-}
-
-func handleUnsupportedHeaders(r *http.Request) (err *requestError) {
- // X-Ipfs-Gateway-Prefix was removed (https://github.com/ipfs/kubo/issues/7702)
- // TODO: remove this after go-ipfs 0.13 ships
- if prfx := r.Header.Get("X-Ipfs-Gateway-Prefix"); prfx != "" {
- err := fmt.Errorf("X-Ipfs-Gateway-Prefix support was removed: https://github.com/ipfs/kubo/issues/7702")
- return newRequestError("unsupported HTTP header", err, http.StatusBadRequest)
- }
- return nil
-}
-
-// ?uri query param support for requests produced by web browsers
-// via navigator.registerProtocolHandler Web API
-// https://developer.mozilla.org/en-US/docs/Web/API/Navigator/registerProtocolHandler
-// TLDR: redirect /ipfs/?uri=ipfs%3A%2F%2Fcid%3Fquery%3Dval to /ipfs/cid?query=val
-func handleProtocolHandlerRedirect(w http.ResponseWriter, r *http.Request, logger *zap.SugaredLogger) (requestHandled bool) {
- if uriParam := r.URL.Query().Get("uri"); uriParam != "" {
- u, err := url.Parse(uriParam)
- if err != nil {
- webError(w, "failed to parse uri query parameter", err, http.StatusBadRequest)
- return true
- }
- if u.Scheme != "ipfs" && u.Scheme != "ipns" {
- webError(w, "uri query parameter scheme must be ipfs or ipns", err, http.StatusBadRequest)
- return true
- }
- path := u.Path
- if u.RawQuery != "" { // preserve query if present
- path = path + "?" + u.RawQuery
- }
-
- redirectURL := gopath.Join("/", u.Scheme, u.Host, path)
- logger.Debugw("uri param, redirect", "to", redirectURL, "status", http.StatusMovedPermanently)
- http.Redirect(w, r, redirectURL, http.StatusMovedPermanently)
- return true
- }
-
- return false
-}
-
-// Disallow Service Worker registration on namespace roots
-// https://github.com/ipfs/kubo/issues/4025
-func handleServiceWorkerRegistration(r *http.Request) (err *requestError) {
- if r.Header.Get("Service-Worker") == "script" {
- matched, _ := regexp.MatchString(`^/ip[fn]s/[^/]+$`, r.URL.Path)
- if matched {
- err := fmt.Errorf("registration is not allowed for this scope")
- return newRequestError("navigator.serviceWorker", err, http.StatusBadRequest)
- }
- }
-
- return nil
-}
-
-// Attempt to fix redundant /ipfs/ namespace as long as resulting
-// 'intended' path is valid. This is in case gremlins were tickled
-// wrong way and user ended up at /ipfs/ipfs/{cid} or /ipfs/ipns/{id}
-// like in bafybeien3m7mdn6imm425vc2s22erzyhbvk5n3ofzgikkhmdkh5cuqbpbq :^))
-func handleSuperfluousNamespace(w http.ResponseWriter, r *http.Request, contentPath ipath.Path) (requestHandled bool) {
- // If the path is valid, there's nothing to do
- if pathErr := contentPath.IsValid(); pathErr == nil {
- return false
- }
-
- // If there's no superflous namespace, there's nothing to do
- if !(strings.HasPrefix(r.URL.Path, "/ipfs/ipfs/") || strings.HasPrefix(r.URL.Path, "/ipfs/ipns/")) {
- return false
- }
-
- // Attempt to fix the superflous namespace
- intendedPath := ipath.New(strings.TrimPrefix(r.URL.Path, "/ipfs"))
- if err := intendedPath.IsValid(); err != nil {
- webError(w, "invalid ipfs path", err, http.StatusBadRequest)
- return true
- }
- intendedURL := intendedPath.String()
- if r.URL.RawQuery != "" {
- // we render HTML, so ensure query entries are properly escaped
- q, _ := url.ParseQuery(r.URL.RawQuery)
- intendedURL = intendedURL + "?" + q.Encode()
- }
- // return HTTP 400 (Bad Request) with HTML error page that:
- // - points at correct canonical path via prefix from breadcrumb Paths when directory
- // listing on a DNSLink website (loaded due to Host header in HTTP
- // request). Necessary because the hostname most likely won't have a
- // public gateway mounted.
- if dnslinkOrigin {
- prefix := "/ipns/" + contentRoot
- for i, crumb := range ret {
- if strings.HasPrefix(crumb.Path, prefix) {
- ret[i].Path = strings.Replace(crumb.Path, prefix, "", 1)
- }
- }
- // Make contentRoot breadcrumb link to the website root
- ret[1].Path = "/"
- }
-
- return ret
-}
-
-func shortHash(hash string) string {
- if len(hash) <= 8 {
- return hash
- }
- return (hash[0:4] + "\u2026" + hash[len(hash)-4:])
-}
-
-// helper to detect DNSLink website context
-// (when hostname from gwURL is matching /ipns/ in path)
-func hasDNSLinkOrigin(gwURL string, path string) bool {
- if gwURL != "" {
- fqdn := stripPort(strings.TrimPrefix(gwURL, "//"))
- return strings.HasPrefix(path, "/ipns/"+fqdn)
- }
- return false
-}
-
-var listingTemplate *template.Template
-
-func init() {
- knownIconsBytes, err := assets.Asset.ReadFile("dir-index-html/knownIcons.txt")
- if err != nil {
- panic(err)
- }
- knownIcons := make(map[string]struct{})
- for _, ext := range strings.Split(strings.TrimSuffix(string(knownIconsBytes), "\n"), "\n") {
- knownIcons[ext] = struct{}{}
- }
-
- // helper to guess the type/icon for it by the extension name
- iconFromExt := func(name string) string {
- ext := path.Ext(name)
- _, ok := knownIcons[ext]
- if !ok {
- // default blank icon
- return "ipfs-_blank"
- }
- return "ipfs-" + ext[1:] // slice of the first dot
- }
-
- // custom template-escaping function to escape a full path, including '#' and '?'
- urlEscape := func(rawUrl string) string {
- pathURL := url.URL{Path: rawUrl}
- return pathURL.String()
- }
-
- // Directory listing template
- dirIndexBytes, err := assets.Asset.ReadFile("dir-index-html/dir-index.html")
- if err != nil {
- panic(err)
- }
-
- listingTemplate = template.Must(template.New("dir").Funcs(template.FuncMap{
- "iconFromExt": iconFromExt,
- "urlEscape": urlEscape,
- }).Parse(string(dirIndexBytes)))
-}
diff --git a/core/corehttp/gateway_test.go b/core/corehttp/gateway_test.go
index 877ac9739ae..49fa519fb3d 100644
--- a/core/corehttp/gateway_test.go
+++ b/core/corehttp/gateway_test.go
@@ -651,28 +651,3 @@ func TestVersion(t *testing.T) {
t.Fatalf("response doesn't contain protocol version:\n%s", s)
}
}
-
-func TestEtagMatch(t *testing.T) {
- for _, test := range []struct {
- header string // value in If-None-Match HTTP header
- cidEtag string
- dirEtag string
- expected bool // expected result of etagMatch(header, cidEtag, dirEtag)
- }{
- {"", `"etag"`, "", false}, // no If-None-Match
- {"", "", `"etag"`, false}, // no If-None-Match
- {`"etag"`, `"etag"`, "", true}, // file etag match
- {`W/"etag"`, `"etag"`, "", true}, // file etag match
- {`"foo", W/"bar", W/"etag"`, `"etag"`, "", true}, // file etag match (array)
- {`"foo",W/"bar",W/"etag"`, `"etag"`, "", true}, // file etag match (compact array)
- {`"etag"`, "", `W/"etag"`, true}, // dir etag match
- {`"etag"`, "", `W/"etag"`, true}, // dir etag match
- {`W/"etag"`, "", `W/"etag"`, true}, // dir etag match
- {`*`, `"etag"`, "", true}, // wildcard etag match
- } {
- result := etagMatch(test.header, test.cidEtag, test.dirEtag)
- if result != test.expected {
- t.Fatalf("unexpected result of etagMatch(%q, %q, %q), got %t, expected %t", test.header, test.cidEtag, test.dirEtag, result, test.expected)
- }
- }
-}
diff --git a/core/corehttp/hostname.go b/core/corehttp/hostname.go
index 39e857aadfb..adc47ab4ddb 100644
--- a/core/corehttp/hostname.go
+++ b/core/corehttp/hostname.go
@@ -10,6 +10,7 @@ import (
"strings"
cid "github.com/ipfs/go-cid"
+ "github.com/ipfs/go-libipfs/gateway"
namesys "github.com/ipfs/go-namesys"
core "github.com/ipfs/kubo/core"
coreapi "github.com/ipfs/kubo/core/coreapi"
@@ -225,7 +226,7 @@ func HostnameOption() ServeOption {
if !cfg.Gateway.NoDNSLink && isDNSLinkName(r.Context(), coreAPI, host) {
// rewrite path and handle as DNSLink
r.URL.Path = "/ipns/" + stripPort(host) + r.URL.Path
- ctx := context.WithValue(r.Context(), requestContextKey("dnslink-hostname"), host)
+ ctx := context.WithValue(r.Context(), gateway.DNSLinkHostnameKey, host)
childMux.ServeHTTP(w, withHostnameContext(r.WithContext(ctx), host))
return
}
@@ -247,8 +248,6 @@ type wildcardHost struct {
spec *config.GatewaySpec
}
-type requestContextKey string
-
// Extends request context to include hostname of a canonical gateway root
// (subdomain root or dnslink fqdn)
func withHostnameContext(r *http.Request, hostname string) *http.Request {
@@ -257,7 +256,7 @@ func withHostnameContext(r *http.Request, hostname string) *http.Request {
// Host header, subdomain gateways have more comples rules (knownSubdomainDetails)
// More: https://github.com/ipfs/dir-index-html/issues/42
// nolint: staticcheck // non-backward compatible change
- ctx := context.WithValue(r.Context(), requestContextKey("gw-hostname"), hostname)
+ ctx := context.WithValue(r.Context(), gateway.GatewayHostnameKey, hostname)
return r.WithContext(ctx)
}
diff --git a/core/corehttp/lazyseek.go b/core/corehttp/lazyseek.go
deleted file mode 100644
index 2a379dc918a..00000000000
--- a/core/corehttp/lazyseek.go
+++ /dev/null
@@ -1,60 +0,0 @@
-package corehttp
-
-import (
- "fmt"
- "io"
-)
-
-// The HTTP server uses seek to determine the file size. Actually _seeking_ can
-// be slow so we wrap the seeker in a _lazy_ seeker.
-type lazySeeker struct {
- reader io.ReadSeeker
-
- size int64
- offset int64
- realOffset int64
-}
-
-func (s *lazySeeker) Seek(offset int64, whence int) (int64, error) {
- switch whence {
- case io.SeekEnd:
- return s.Seek(s.size+offset, io.SeekStart)
- case io.SeekCurrent:
- return s.Seek(s.offset+offset, io.SeekStart)
- case io.SeekStart:
- if offset < 0 {
- return s.offset, fmt.Errorf("invalid seek offset")
- }
- s.offset = offset
- return s.offset, nil
- default:
- return s.offset, fmt.Errorf("invalid whence: %d", whence)
- }
-}
-
-func (s *lazySeeker) Read(b []byte) (int, error) {
- // If we're past the end, EOF.
- if s.offset >= s.size {
- return 0, io.EOF
- }
-
- // actually seek
- for s.offset != s.realOffset {
- off, err := s.reader.Seek(s.offset, io.SeekStart)
- if err != nil {
- return 0, err
- }
- s.realOffset = off
- }
- off, err := s.reader.Read(b)
- s.realOffset += int64(off)
- s.offset += int64(off)
- return off, err
-}
-
-func (s *lazySeeker) Close() error {
- if closer, ok := s.reader.(io.Closer); ok {
- return closer.Close()
- }
- return nil
-}
diff --git a/core/corehttp/lazyseek_test.go b/core/corehttp/lazyseek_test.go
deleted file mode 100644
index 49aca0a0e2a..00000000000
--- a/core/corehttp/lazyseek_test.go
+++ /dev/null
@@ -1,136 +0,0 @@
-package corehttp
-
-import (
- "fmt"
- "io"
- "strings"
- "testing"
-)
-
-type badSeeker struct {
- io.ReadSeeker
-}
-
-var errBadSeek = fmt.Errorf("bad seeker")
-
-func (bs badSeeker) Seek(offset int64, whence int) (int64, error) {
- off, err := bs.ReadSeeker.Seek(0, io.SeekCurrent)
- if err != nil {
- panic(err)
- }
- return off, errBadSeek
-}
-
-func TestLazySeekerError(t *testing.T) {
- underlyingBuffer := strings.NewReader("fubar")
- s := &lazySeeker{
- reader: badSeeker{underlyingBuffer},
- size: underlyingBuffer.Size(),
- }
- off, err := s.Seek(0, io.SeekEnd)
- if err != nil {
- t.Fatal(err)
- }
- if off != s.size {
- t.Fatal("expected to seek to the end")
- }
-
- // shouldn't have actually seeked.
- b, err := io.ReadAll(s)
- if err != nil {
- t.Fatal(err)
- }
- if len(b) != 0 {
- t.Fatal("expected to read nothing")
- }
-
- // shouldn't need to actually seek.
- off, err = s.Seek(0, io.SeekStart)
- if err != nil {
- t.Fatal(err)
- }
- if off != 0 {
- t.Fatal("expected to seek to the start")
- }
- b, err = io.ReadAll(s)
- if err != nil {
- t.Fatal(err)
- }
- if string(b) != "fubar" {
- t.Fatal("expected to read string")
- }
-
- // should fail the second time.
- off, err = s.Seek(0, io.SeekStart)
- if err != nil {
- t.Fatal(err)
- }
- if off != 0 {
- t.Fatal("expected to seek to the start")
- }
- // right here...
- b, err = io.ReadAll(s)
- if err == nil {
- t.Fatalf("expected an error, got output %s", string(b))
- }
- if err != errBadSeek {
- t.Fatalf("expected a bad seek error, got %s", err)
- }
- if len(b) != 0 {
- t.Fatalf("expected to read nothing")
- }
-}
-
-func TestLazySeeker(t *testing.T) {
- underlyingBuffer := strings.NewReader("fubar")
- s := &lazySeeker{
- reader: underlyingBuffer,
- size: underlyingBuffer.Size(),
- }
- expectByte := func(b byte) {
- t.Helper()
- var buf [1]byte
- n, err := io.ReadFull(s, buf[:])
- if err != nil {
- t.Fatal(err)
- }
- if n != 1 {
- t.Fatalf("expected to read one byte, read %d", n)
- }
- if buf[0] != b {
- t.Fatalf("expected %b, got %b", b, buf[0])
- }
- }
- expectSeek := func(whence int, off, expOff int64, expErr string) {
- t.Helper()
- n, err := s.Seek(off, whence)
- if expErr == "" {
- if err != nil {
- t.Fatal("unexpected seek error: ", err)
- }
- } else {
- if err == nil || err.Error() != expErr {
- t.Fatalf("expected %s, got %s", err, expErr)
- }
- }
- if n != expOff {
- t.Fatalf("expected offset %d, got, %d", expOff, n)
- }
- }
-
- expectSeek(io.SeekEnd, 0, s.size, "")
- b, err := io.ReadAll(s)
- if err != nil {
- t.Fatal(err)
- }
- if len(b) != 0 {
- t.Fatal("expected to read nothing")
- }
- expectSeek(io.SeekEnd, -1, s.size-1, "")
- expectByte('r')
- expectSeek(io.SeekStart, 0, 0, "")
- expectByte('f')
- expectSeek(io.SeekCurrent, 1, 2, "")
- expectByte('b')
- expectSeek(io.SeekCurrent, -100, 3, "invalid seek offset")
-}
diff --git a/docs/examples/kubo-as-a-library/go.mod b/docs/examples/kubo-as-a-library/go.mod
index 3294cd137ab..a74bfbf3e03 100644
--- a/docs/examples/kubo-as-a-library/go.mod
+++ b/docs/examples/kubo-as-a-library/go.mod
@@ -7,7 +7,7 @@ go 1.18
replace github.com/ipfs/kubo => ./../../..
require (
- github.com/ipfs/go-libipfs v0.4.0
+ github.com/ipfs/go-libipfs v0.4.1-0.20230130233950-a005a5006496
github.com/ipfs/interface-go-ipfs-core v0.10.0
github.com/ipfs/kubo v0.0.0-00010101000000-000000000000
github.com/libp2p/go-libp2p v0.24.2
diff --git a/docs/examples/kubo-as-a-library/go.sum b/docs/examples/kubo-as-a-library/go.sum
index ece45c198d4..eb37654f786 100644
--- a/docs/examples/kubo-as-a-library/go.sum
+++ b/docs/examples/kubo-as-a-library/go.sum
@@ -548,8 +548,8 @@ github.com/ipfs/go-ipld-legacy v0.1.1 h1:BvD8PEuqwBHLTKqlGFTHSwrwFOMkVESEvwIYwR2
github.com/ipfs/go-ipld-legacy v0.1.1/go.mod h1:8AyKFCjgRPsQFf15ZQgDB8Din4DML/fOmKZkkFkrIEg=
github.com/ipfs/go-ipns v0.3.0 h1:ai791nTgVo+zTuq2bLvEGmWP1M0A6kGTXUsgv/Yq67A=
github.com/ipfs/go-ipns v0.3.0/go.mod h1:3cLT2rbvgPZGkHJoPO1YMJeh6LtkxopCkKFcio/wE24=
-github.com/ipfs/go-libipfs v0.4.0 h1:TkUxJGjtPnSzAgkw7VjS0/DBay3MPjmTBa4dGdUQCDE=
-github.com/ipfs/go-libipfs v0.4.0/go.mod h1:XsU2cP9jBhDrXoJDe0WxikB8XcVmD3k2MEZvB3dbYu8=
+github.com/ipfs/go-libipfs v0.4.1-0.20230130233950-a005a5006496 h1:RVI31GQCFODREpasIFyVFkS6PjJT2bMwr/Bgr9Ryql4=
+github.com/ipfs/go-libipfs v0.4.1-0.20230130233950-a005a5006496/go.mod h1:AAPvZADZ80i+QhGCWNWCsx8IGY0t9C+IBEngLeYtySY=
github.com/ipfs/go-log v0.0.1/go.mod h1:kL1d2/hzSpI0thNYjiKfjanbVNU+IIGA/WnNESY9leM=
github.com/ipfs/go-log v1.0.2/go.mod h1:1MNjMxe0u6xvJZgeqbJ8vdo2TKaGwZ1a0Bpza+sr2Sk=
github.com/ipfs/go-log v1.0.3/go.mod h1:OsLySYkwIbiSUR/yBTdv1qPtcE4FW3WPWk/ewz9Ru+A=
@@ -597,7 +597,7 @@ github.com/ipfs/interface-go-ipfs-core v0.10.0 h1:b/psL1oqJcySdQAsIBfW5ZJJkOAsYl
github.com/ipfs/interface-go-ipfs-core v0.10.0/go.mod h1:F3EcmDy53GFkF0H3iEJpfJC320fZ/4G60eftnItrrJ0=
github.com/ipld/edelweiss v0.2.0 h1:KfAZBP8eeJtrLxLhi7r3N0cBCo7JmwSRhOJp3WSpNjk=
github.com/ipld/edelweiss v0.2.0/go.mod h1:FJAzJRCep4iI8FOFlRriN9n0b7OuX3T/S9++NpBDmA4=
-github.com/ipld/go-car v0.4.0 h1:U6W7F1aKF/OJMHovnOVdst2cpQE5GhmHibQkAixgNcQ=
+github.com/ipld/go-car v0.5.0 h1:kcCEa3CvYMs0iE5BzD5sV7O2EwMiCIp3uF8tA6APQT8=
github.com/ipld/go-car/v2 v2.5.1 h1:U2ux9JS23upEgrJScW8VQuxmE94560kYxj9CQUpcfmk=
github.com/ipld/go-codec-dagpb v1.3.0/go.mod h1:ga4JTU3abYApDC3pZ00BC2RSvC3qfBb9MSJkMLSwnhA=
github.com/ipld/go-codec-dagpb v1.5.0 h1:RspDRdsJpLfgCI0ONhTAnbHdySGD4t+LHSPK4X1+R0k=
diff --git a/go.mod b/go.mod
index 3d91f40e77f..5edf9f68a46 100644
--- a/go.mod
+++ b/go.mod
@@ -7,14 +7,12 @@ require (
github.com/blang/semver/v4 v4.0.0
github.com/cenkalti/backoff/v4 v4.1.3
github.com/ceramicnetwork/go-dag-jose v0.1.0
- github.com/cespare/xxhash v1.1.0
github.com/cheggaaa/pb v1.0.29
github.com/coreos/go-systemd/v22 v22.5.0
github.com/dustin/go-humanize v1.0.0
github.com/elgris/jsondiff v0.0.0-20160530203242-765b5c24c302
github.com/facebookgo/atomicfile v0.0.0-20151019160806-2de1f203e7d5
github.com/fsnotify/fsnotify v1.6.0
- github.com/gabriel-vasile/mimetype v1.4.1
github.com/gogo/protobuf v1.3.2
github.com/google/uuid v1.3.0
github.com/hashicorp/go-multierror v1.1.1
@@ -41,14 +39,13 @@ require (
github.com/ipfs/go-ipfs-pinner v0.2.1
github.com/ipfs/go-ipfs-posinfo v0.0.1
github.com/ipfs/go-ipfs-provider v0.8.1
- github.com/ipfs/go-ipfs-redirects-file v0.1.1
github.com/ipfs/go-ipfs-routing v0.3.0
github.com/ipfs/go-ipfs-util v0.0.2
github.com/ipfs/go-ipld-format v0.4.0
github.com/ipfs/go-ipld-git v0.1.1
github.com/ipfs/go-ipld-legacy v0.1.1
github.com/ipfs/go-ipns v0.3.0
- github.com/ipfs/go-libipfs v0.4.0
+ github.com/ipfs/go-libipfs v0.4.1-0.20230130233950-a005a5006496
github.com/ipfs/go-log v1.0.5
github.com/ipfs/go-log/v2 v2.5.1
github.com/ipfs/go-merkledag v0.9.0
@@ -62,7 +59,7 @@ require (
github.com/ipfs/go-unixfsnode v1.5.1
github.com/ipfs/go-verifcid v0.0.2
github.com/ipfs/interface-go-ipfs-core v0.10.0
- github.com/ipld/go-car v0.4.0
+ github.com/ipld/go-car v0.5.0
github.com/ipld/go-car/v2 v2.5.1
github.com/ipld/go-codec-dagpb v1.5.0
github.com/ipld/go-ipld-prime v0.19.0
@@ -121,6 +118,7 @@ require (
github.com/alexbrainman/goissue34681 v0.0.0-20191006012335-3fc7a47baff5 // indirect
github.com/beorn7/perks v1.0.1 // indirect
github.com/cenkalti/backoff v2.2.1+incompatible // indirect
+ github.com/cespare/xxhash v1.1.0 // indirect
github.com/cespare/xxhash/v2 v2.2.0 // indirect
github.com/containerd/cgroups v1.0.4 // indirect
github.com/crackcomm/go-gitignore v0.0.0-20170627025303-887ab5e44cc3 // indirect
@@ -136,6 +134,7 @@ require (
github.com/felixge/httpsnoop v1.0.2 // indirect
github.com/flynn/noise v1.0.0 // indirect
github.com/francoispqt/gojay v1.2.13 // indirect
+ github.com/gabriel-vasile/mimetype v1.4.1 // indirect
github.com/go-kit/log v0.2.0 // indirect
github.com/go-logfmt/logfmt v0.5.1 // indirect
github.com/go-logr/logr v1.2.3 // indirect
@@ -161,6 +160,7 @@ require (
github.com/ipfs/go-ipfs-delay v0.0.1 // indirect
github.com/ipfs/go-ipfs-ds-help v1.1.0 // indirect
github.com/ipfs/go-ipfs-pq v0.0.2 // indirect
+ github.com/ipfs/go-ipfs-redirects-file v0.1.1 // indirect
github.com/ipfs/go-ipld-cbor v0.0.6 // indirect
github.com/ipfs/go-peertaskqueue v0.8.0 // indirect
github.com/ipld/edelweiss v0.2.0 // indirect
diff --git a/go.sum b/go.sum
index 471acc8080b..fefe9bf7160 100644
--- a/go.sum
+++ b/go.sum
@@ -570,8 +570,8 @@ github.com/ipfs/go-ipld-legacy v0.1.1 h1:BvD8PEuqwBHLTKqlGFTHSwrwFOMkVESEvwIYwR2
github.com/ipfs/go-ipld-legacy v0.1.1/go.mod h1:8AyKFCjgRPsQFf15ZQgDB8Din4DML/fOmKZkkFkrIEg=
github.com/ipfs/go-ipns v0.3.0 h1:ai791nTgVo+zTuq2bLvEGmWP1M0A6kGTXUsgv/Yq67A=
github.com/ipfs/go-ipns v0.3.0/go.mod h1:3cLT2rbvgPZGkHJoPO1YMJeh6LtkxopCkKFcio/wE24=
-github.com/ipfs/go-libipfs v0.4.0 h1:TkUxJGjtPnSzAgkw7VjS0/DBay3MPjmTBa4dGdUQCDE=
-github.com/ipfs/go-libipfs v0.4.0/go.mod h1:XsU2cP9jBhDrXoJDe0WxikB8XcVmD3k2MEZvB3dbYu8=
+github.com/ipfs/go-libipfs v0.4.1-0.20230130233950-a005a5006496 h1:RVI31GQCFODREpasIFyVFkS6PjJT2bMwr/Bgr9Ryql4=
+github.com/ipfs/go-libipfs v0.4.1-0.20230130233950-a005a5006496/go.mod h1:AAPvZADZ80i+QhGCWNWCsx8IGY0t9C+IBEngLeYtySY=
github.com/ipfs/go-log v0.0.1/go.mod h1:kL1d2/hzSpI0thNYjiKfjanbVNU+IIGA/WnNESY9leM=
github.com/ipfs/go-log v1.0.2/go.mod h1:1MNjMxe0u6xvJZgeqbJ8vdo2TKaGwZ1a0Bpza+sr2Sk=
github.com/ipfs/go-log v1.0.3/go.mod h1:OsLySYkwIbiSUR/yBTdv1qPtcE4FW3WPWk/ewz9Ru+A=
@@ -623,8 +623,8 @@ github.com/ipfs/interface-go-ipfs-core v0.10.0 h1:b/psL1oqJcySdQAsIBfW5ZJJkOAsYl
github.com/ipfs/interface-go-ipfs-core v0.10.0/go.mod h1:F3EcmDy53GFkF0H3iEJpfJC320fZ/4G60eftnItrrJ0=
github.com/ipld/edelweiss v0.2.0 h1:KfAZBP8eeJtrLxLhi7r3N0cBCo7JmwSRhOJp3WSpNjk=
github.com/ipld/edelweiss v0.2.0/go.mod h1:FJAzJRCep4iI8FOFlRriN9n0b7OuX3T/S9++NpBDmA4=
-github.com/ipld/go-car v0.4.0 h1:U6W7F1aKF/OJMHovnOVdst2cpQE5GhmHibQkAixgNcQ=
-github.com/ipld/go-car v0.4.0/go.mod h1:Uslcn4O9cBKK9wqHm/cLTFacg6RAPv6LZx2mxd2Ypl4=
+github.com/ipld/go-car v0.5.0 h1:kcCEa3CvYMs0iE5BzD5sV7O2EwMiCIp3uF8tA6APQT8=
+github.com/ipld/go-car v0.5.0/go.mod h1:ppiN5GWpjOZU9PgpAZ9HbZd9ZgSpwPMr48fGRJOWmvE=
github.com/ipld/go-car/v2 v2.5.1 h1:U2ux9JS23upEgrJScW8VQuxmE94560kYxj9CQUpcfmk=
github.com/ipld/go-car/v2 v2.5.1/go.mod h1:jKjGOqoCj5zn6KjnabD6JbnCsMntqU2hLiU6baZVO3E=
github.com/ipld/go-codec-dagpb v1.3.0/go.mod h1:ga4JTU3abYApDC3pZ00BC2RSvC3qfBb9MSJkMLSwnhA=