From 0531e93b64ba92f732b35a386654d4d5f4d133ee Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Thu, 24 Nov 2022 17:39:52 +0100 Subject: [PATCH] refactor: create template at assets/dag-index-html This is a quick, static placeholder that follows the style of dir-index-html. Future work will refine this, perhaps by reusing parts of https://explore.ipld.io/ --- assets/dag-index-html/README.md | 3 + assets/dag-index-html/index.go | 81 ++++++++++++++++++++++++ assets/dir-index-html/README.md | 2 +- assets/dir-index-html/dir-index.html | 12 ++-- assets/dir-index-html/src/dir-index.html | 12 ++-- core/corehttp/gateway_handler_codec.go | 34 ++++------ 6 files changed, 108 insertions(+), 36 deletions(-) create mode 100644 assets/dag-index-html/README.md create mode 100644 assets/dag-index-html/index.go diff --git a/assets/dag-index-html/README.md b/assets/dag-index-html/README.md new file mode 100644 index 000000000000..de38a9504a1e --- /dev/null +++ b/assets/dag-index-html/README.md @@ -0,0 +1,3 @@ +# 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 new file mode 100644 index 000000000000..a3782f19cee5 --- /dev/null +++ b/assets/dag-index-html/index.go @@ -0,0 +1,81 @@ +package dagindexhtml + +import "html/template" + +// HTML-based template for non-UnixFS DAGs when request was made with +// Accept: text/html. +// TODO: replace static CSS with shared one with ../dir-index-html +var DagIndexTemplate = template.Must(template.New("redirect").Parse(` + + + + + + + + + + + + + + + + + + {{ .Path }} + + + +
+ +
+
About IPFS
+
Install IPFS
+
About
+
Install
+
+ + + +
+
+
+
+
+

CID: {{.CID}}
+ Codec: {{.CodecName}} ({{.CodecHex}})

+

This CID is not UnixFS (not a file, nor a directory)

+
+
+ + + + + + + +
+

Preview as JSON
(application/json)

+
+

Or download as: +

+

+
+
+
+ +`)) + +type DagIndexTemplateData struct { + Path string + CID string + CodecName string + CodecHex string +} diff --git a/assets/dir-index-html/README.md b/assets/dir-index-html/README.md index ad5fa68b2db5..3dd45eb59056 100644 --- a/assets/dir-index-html/README.md +++ b/assets/dir-index-html/README.md @@ -1,6 +1,6 @@ # dir-index-html -> Directory listing HTML for `go-ipfs` gateways +> Directory listing HTML for HTTP gateway ![](https://user-images.githubusercontent.com/157609/88379209-ce6f0600-cda2-11ea-9620-20b9237bb441.png) diff --git a/assets/dir-index-html/dir-index.html b/assets/dir-index-html/dir-index.html index a2d662d19c7b..1d00e5fe73f6 100644 --- a/assets/dir-index-html/dir-index.html +++ b/assets/dir-index-html/dir-index.html @@ -26,12 +26,12 @@
-
About IPFS
-
Install IPFS
-
About
-
Install
+
About IPFS
+
Install IPFS
+
About
+
Install
- +
@@ -84,7 +84,7 @@ {{ if .Hash }} - + {{ .ShortHash }} {{ end }} diff --git a/assets/dir-index-html/src/dir-index.html b/assets/dir-index-html/src/dir-index.html index 1bbbb0a9a8c5..a763b3e76bb4 100644 --- a/assets/dir-index-html/src/dir-index.html +++ b/assets/dir-index-html/src/dir-index.html @@ -25,12 +25,12 @@
-
About IPFS
-
Install IPFS
-
About
-
Install
+
About IPFS
+
Install IPFS
+
About
+
Install
@@ -83,7 +83,7 @@ {{ if .Hash }} - + {{ .ShortHash }} {{ end }} diff --git a/core/corehttp/gateway_handler_codec.go b/core/corehttp/gateway_handler_codec.go index 5c9ebe808582..736ffc5ab347 100644 --- a/core/corehttp/gateway_handler_codec.go +++ b/core/corehttp/gateway_handler_codec.go @@ -12,6 +12,7 @@ import ( ipldlegacy "github.com/ipfs/go-ipld-legacy" ipath "github.com/ipfs/interface-go-ipfs-core/path" + dih "github.com/ipfs/kubo/assets/dag-index-html" "github.com/ipfs/kubo/tracing" "github.com/ipld/go-ipld-prime" "github.com/ipld/go-ipld-prime/multicodec" @@ -117,29 +118,16 @@ func (i *gatewayHandler) serveCodec(ctx context.Context, w http.ResponseWriter, } func (i *gatewayHandler) serveCodecHTML(ctx context.Context, w http.ResponseWriter, r *http.Request, resolvedPath ipath.Resolved, contentPath ipath.Path) { - codecName := mc.Code(resolvedPath.Cid().Prefix().Codec).String() - body := fmt.Sprintf(` - - - - - -

Requested CID %q uses %q codec.

- - - -`, resolvedPath.Cid(), codecName) - - _, _ = w.Write([]byte(body)) + // TODO: cache-control/etag like for DirIndex + cidCodec := mc.Code(resolvedPath.Cid().Prefix().Codec) + if err := dih.DagIndexTemplate.Execute(w, dih.DagIndexTemplateData{ + Path: contentPath.String(), + CID: resolvedPath.Cid().String(), + CodecName: cidCodec.String(), + CodecHex: fmt.Sprintf("0x%x", uint64(cidCodec)), + }); err != nil { + webError(w, "failed to generate HTML listing for this DAG: retry without 'Accept: text/html'", err, http.StatusInternalServerError) + } } func (i *gatewayHandler) serveCodecRaw(ctx context.Context, w http.ResponseWriter, r *http.Request, resolvedPath ipath.Resolved, contentPath ipath.Path, contentType string) {