Create IPIP: UnixFS and Gateway support for explicit MIME/Content-Type
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 冷清
调研方向
从 #331 中跟踪的 UnixFS 规范工作开始,然后审查所引用的 gateway 规范以及位于 core/corehttp/gateway_handler_unixfs_file.go 的 Kubo gateway 处理程序。当某个 IPIP 定义了规范的 MIME 存储和 gateway 行为,并且有一个涵盖 ipfs add 和 gateway 响应的 Kubo 参考实现时,这项工作就完成了。
由索引模型根据 Issue 内容生成。
描述
This is a placeholder issue for creating IPIP to add support for storing explicit MIME/Content-Type in UnixFS DAG itself, like we already do for opt-in mode and mtime, and acting on its presence on Gateways.
There is alrernative approach to allow stating explicit content-type header via _headers file (similar to recently shipped _redirects) – some notes in https://github.com/ipfs/specs/issues/257
Context
UnixFSv2 never happened, but ability to explicitly specify Content-Type was one of my asks: https://github.com/ipld/legacy-unixfs-v2/issues/11
Years later, we still guess Content-Type on gateways.
While it is fine for most of the time, but we should provide users with ability to explicitly set media type at the time of data onboarding.
Since 2018 we made some related development: we've added opt-in support for mode and mtime attributes. ~2020 (https://github.com/ipfs/specs/issues/217#issuecomment-582369839). Support for mode and mtime was implemented in JS-IPFS a while ago, Kubo still has PR open (https://github.com/ipfs/go-unixfs/pull/117).
Initial idea (details to be fleshed out in IPIP) is to introduce optional mtype similar way.
This is alternative to introducing _headers file mentioned in https://github.com/ipfs/specs/issues/257.
Ref.
- old discussions https://github.com/ipfs/kubo/issues/2164
- Media Type registry at IANA: https://www.iana.org/assignments/media-types/media-types.xhtml
- IETF RFC about Media Types https://www.rfc-editor.org/rfc/rfc2046.html
- Some examples how the same CID can be returned with different
Content-Type: https://github.com/ipfs/in-web-browsers/issues/152 - Kubo Gateway guessing
Content-Typebased on filename and magic bytes: https://github.com/ipfs/kubo/blob/v0.17.0-rc2/core/corehttp/gateway_handler_unixfs_file.go#L55-L87- Gateway support for overriding filename: https://github.com/ipfs/specs/blob/main/http-gateways/PATH_GATEWAY.md#filename-request-query-parameter
- IPFS users leverage this for adjusting Content-Type when
/ipfs/cidis requested without any filename, but with built-in support for explicit content type we could make it "just work".
- IPFS users leverage this for adjusting Content-Type when
- Gateway support for overriding filename: https://github.com/ipfs/specs/blob/main/http-gateways/PATH_GATEWAY.md#filename-request-query-parameter
TODO
- wait until UnixFS specs land (#331)
- create IPIP against UnixFS specs that
- defines canonical way of storing explicit MIME (content/media type) in UnixFS root dag-pb blocks.
- modifies Gateway spec to disable mime-sniffing and use sanitized (ASCII-only) value from dag-pb in
Content-Typeheader
- Create reference implementation in Kubo
- adds optional
--content-typetoipfs add - skip sniffing and set
Content-Typeheader on gateway, if present
- adds optional
- 主要语言
- HTML
- 星标
- 1.2k
- 派生
- 250
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
ipfs/specs 的其他 Issue
-
need/triage
难度 2/5 1-3 小时 新手友好度 68/100
-
need/triage
难度 5/5 一周以上 新手友好度 30/100
-
dnslink:// URIs未关闭need/triage
难度 5/5 一周以上 新手友好度 30/100
-
难度 5/5 一周以上 新手友好度 35/100
-
need/triage
难度 3/5 1-2 天 新手友好度 55/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
SocialGouv/egapro#5212 ·
维护者通常 2 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
area:filesystem bug need-triage
难度 2/5 1-3 小时 新手友好度 85/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
triage/confirmed
难度 2/5 1-3 小时 新手友好度 78/100
agentscope-ai/agentscope#4068 ·
维护者通常 2 天内回复