assets

README

Required Assets for the Gateway

HTTP Gateway Templates.

Updating

To update the templates, make changes to .html and .css files in the current directory.

Testing

1. Make sure you have Go installed.
2. From the assets/ directory, start the test server: go run test/main.go.

This will listen on localhost:3000 and reload the template every time you refresh the page. Here you have three pages:

• localhost:3000/dag for the DAG template preview; and
• localhost:3000/directory for the Directory template preview; and
• localhost:3000/error?code=500 for the Error template preview, you can replace 500 by a different status code.

Every time you refresh, the template will be reloaded.

Documentation

Index

• Variables
• func BuildTemplate(fs fs.FS, filename string) (*template.Template, error)
• func HasDNSLinkOrigin(gwURL string, path string) bool
• func ShortHash(hash string) string
• type Breadcrumb
  • func Breadcrumbs(urlPath string, dnslinkOrigin bool) []Breadcrumb
• type DagTemplateData
• type DirectoryItem
• type DirectoryTemplateData
• type ErrorTemplateData
• type GlobalData
• type MenuItem
• type ParsedNode
  • func ParseNode(node datamodel.Node) (*ParsedNode, error)

Variables

var (
	DirectoryTemplate *template.Template
	DagTemplate       *template.Template
	ErrorTemplate     *template.Template
)

var AssetHash string

AssetHash a non-cryptographic hash of all embedded assets

var KnownIcons = map[string]bool{
	".aac":  true,
	".ai":   true,
	".aiff": true,
	".avi":  true,
	".bmp":  true,
	".c":    true,
	".cpp":  true,
	".css":  true,
	".dat":  true,
	".dmg":  true,
	".doc":  true,
	".docx": true,
	".dotx": true,
	".dwg":  true,
	".dxf":  true,
	".eps":  true,
	".exe":  true,
	".flv":  true,
	".gif":  true,
	".h":    true,
	".hpp":  true,
	".html": true,
	".ics":  true,
	".iso":  true,
	".java": true,
	".jpg":  true,
	".jpeg": true,
	".js":   true,
	".key":  true,
	".less": true,
	".mid":  true,
	".mkv":  true,
	".mov":  true,
	".mp3":  true,
	".mp4":  true,
	".mpg":  true,
	".odf":  true,
	".ods":  true,
	".odt":  true,
	".ott":  true,
	".pdf":  true,
	".php":  true,
	".png":  true,
	".ppt":  true,
	".psd":  true,
	".py":   true,
	".qt":   true,
	".rar":  true,
	".rb":   true,
	".rtf":  true,
	".sass": true,
	".scss": true,
	".sql":  true,
	".tga":  true,
	".tgz":  true,
	".tiff": true,
	".txt":  true,
	".wav":  true,
	".wmv":  true,
	".xls":  true,
	".xlsx": true,
	".xml":  true,
	".yml":  true,
	".zip":  true,
}

Functions

func BuildTemplate

func BuildTemplate(fs fs.FS, filename string) (*template.Template, error)

func HasDNSLinkOrigin

func HasDNSLinkOrigin(gwURL string, path string) bool

helper to detect DNSLink website context (when hostname from gwURL is matching /ipns/<fqdn> in path)

func ShortHash

func ShortHash(hash string) string

Types

type Breadcrumb

type Breadcrumb struct {
	Name string
	Path string
}

func Breadcrumbs

func Breadcrumbs(urlPath string, dnslinkOrigin bool) []Breadcrumb

type DagTemplateData

type DagTemplateData struct {
	GlobalData
	Path      string
	CID       string
	CodecName string
	CodecHex  string
	Node      *ParsedNode
}

type DirectoryItem

type DirectoryItem struct {
	Size      string
	Name      string
	Path      string
	Hash      string
	ShortHash string
}

type DirectoryTemplateData

type DirectoryTemplateData struct {
	GlobalData
	Listing     []DirectoryItem
	Size        string
	Path        string
	Breadcrumbs []Breadcrumb
	BackLink    string
	Hash        string
}

type ErrorTemplateData

type ErrorTemplateData struct {
	GlobalData
	StatusCode int
	StatusText string
	Error      string
}

type GlobalData

type GlobalData struct {
	Menu       []MenuItem
	GatewayURL string
	DNSLink    bool
}

type MenuItem

type MenuItem struct {
	URL   string
	Title string
}

type ParsedNode

type ParsedNode struct {
	Keys   []*ParsedNode
	Values []*ParsedNode
	Value  string
	CID    string
	Long   bool
}

func ParseNode

func ParseNode(node datamodel.Node) (*ParsedNode, error)