mirror of https://github.com/ethereum/go-ethereum
swarm/api: refactor and improve HTTP API (#3773)
This PR deprecates the file related RPC calls in favour of an improved HTTP API. The main aim is to expose a simple to use API which can be consumed by thin clients (e.g. curl and HTML forms) without the need for complex logic (e.g. manipulating prefix trie manifests).pull/3748/head
Lewis Marshall
8 years ago
committed by
Felix Lange
parent
9aca9e6deb
commit
71fdaa4238
@ -0,0 +1,71 @@ |
||||
// Copyright 2016 The go-ethereum Authors
|
||||
// This file is part of go-ethereum.
|
||||
//
|
||||
// go-ethereum is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// go-ethereum is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package http |
||||
|
||||
import ( |
||||
"html/template" |
||||
"path" |
||||
|
||||
"github.com/ethereum/go-ethereum/swarm/api" |
||||
) |
||||
|
||||
type htmlListData struct { |
||||
URI *api.URI |
||||
List *api.ManifestList |
||||
} |
||||
|
||||
var htmlListTemplate = template.Must(template.New("html-list").Funcs(template.FuncMap{"basename": path.Base}).Parse(` |
||||
<!DOCTYPE html> |
||||
<html> |
||||
<head> |
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
||||
<meta name="viewport" content="width=device-width, initial-scale=1"> |
||||
<title>Swarm index of {{ .URI }}</title> |
||||
</head> |
||||
|
||||
<body> |
||||
<h1>Swarm index of {{ .URI }}</h1> |
||||
<hr> |
||||
<table> |
||||
<thead> |
||||
<tr> |
||||
<th>Path</th> |
||||
<th>Type</th> |
||||
<th>Size</th> |
||||
</tr> |
||||
</thead> |
||||
|
||||
<tbody> |
||||
{{ range .List.CommonPrefixes }} |
||||
<tr> |
||||
<td><a href="{{ basename . }}/?list=true">{{ basename . }}/</a></td> |
||||
<td>DIR</td> |
||||
<td>-</td> |
||||
</tr> |
||||
{{ end }} |
||||
|
||||
{{ range .List.Entries }} |
||||
<tr> |
||||
<td><a href="{{ basename .Path }}">{{ basename .Path }}</a></td> |
||||
<td>{{ .ContentType }}</td> |
||||
<td>{{ .Size }}</td> |
||||
</tr> |
||||
{{ end }} |
||||
</table> |
||||
<hr> |
||||
</body> |
||||
`[1:])) |
||||
@ -0,0 +1,96 @@ |
||||
// Copyright 2016 The go-ethereum Authors
|
||||
// This file is part of the go-ethereum library.
|
||||
//
|
||||
// The go-ethereum library is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// The go-ethereum library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package api |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/url" |
||||
"strings" |
||||
) |
||||
|
||||
// URI is a reference to content stored in swarm.
|
||||
type URI struct { |
||||
// Scheme has one of the following values:
|
||||
//
|
||||
// * bzz - an entry in a swarm manifest
|
||||
// * bzzr - raw swarm content
|
||||
// * bzzi - immutable URI of an entry in a swarm manifest
|
||||
// (address is not resolved)
|
||||
Scheme string |
||||
|
||||
// Addr is either a hexadecimal storage key or it an address which
|
||||
// resolves to a storage key
|
||||
Addr string |
||||
|
||||
// Path is the path to the content within a swarm manifest
|
||||
Path string |
||||
} |
||||
|
||||
// Parse parses rawuri into a URI struct, where rawuri is expected to have one
|
||||
// of the following formats:
|
||||
//
|
||||
// * <scheme>:/
|
||||
// * <scheme>:/<addr>
|
||||
// * <scheme>:/<addr>/<path>
|
||||
// * <scheme>://
|
||||
// * <scheme>://<addr>
|
||||
// * <scheme>://<addr>/<path>
|
||||
//
|
||||
// with scheme one of bzz, bzzr or bzzi
|
||||
func Parse(rawuri string) (*URI, error) { |
||||
u, err := url.Parse(rawuri) |
||||
if err != nil { |
||||
return nil, err |
||||
} |
||||
uri := &URI{Scheme: u.Scheme} |
||||
|
||||
// check the scheme is valid
|
||||
switch uri.Scheme { |
||||
case "bzz", "bzzi", "bzzr": |
||||
default: |
||||
return nil, fmt.Errorf("unknown scheme %q", u.Scheme) |
||||
} |
||||
|
||||
// handle URIs like bzz://<addr>/<path> where the addr and path
|
||||
// have already been split by url.Parse
|
||||
if u.Host != "" { |
||||
uri.Addr = u.Host |
||||
uri.Path = strings.TrimLeft(u.Path, "/") |
||||
return uri, nil |
||||
} |
||||
|
||||
// URI is like bzz:/<addr>/<path> so split the addr and path from
|
||||
// the raw path (which will be /<addr>/<path>)
|
||||
parts := strings.SplitN(strings.TrimLeft(u.Path, "/"), "/", 2) |
||||
uri.Addr = parts[0] |
||||
if len(parts) == 2 { |
||||
uri.Path = parts[1] |
||||
} |
||||
return uri, nil |
||||
} |
||||
|
||||
func (u *URI) Raw() bool { |
||||
return u.Scheme == "bzzr" |
||||
} |
||||
|
||||
func (u *URI) Immutable() bool { |
||||
return u.Scheme == "bzzi" |
||||
} |
||||
|
||||
func (u *URI) String() string { |
||||
return u.Scheme + ":/" + u.Addr + "/" + u.Path |
||||
} |
||||
@ -0,0 +1,120 @@ |
||||
// Copyright 2016 The go-ethereum Authors
|
||||
// This file is part of the go-ethereum library.
|
||||
//
|
||||
// The go-ethereum library is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU Lesser General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// The go-ethereum library is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU Lesser General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU Lesser General Public License
|
||||
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
package api |
||||
|
||||
import ( |
||||
"reflect" |
||||
"testing" |
||||
) |
||||
|
||||
func TestParseURI(t *testing.T) { |
||||
type test struct { |
||||
uri string |
||||
expectURI *URI |
||||
expectErr bool |
||||
expectRaw bool |
||||
expectImmutable bool |
||||
} |
||||
tests := []test{ |
||||
{ |
||||
uri: "", |
||||
expectErr: true, |
||||
}, |
||||
{ |
||||
uri: "foo", |
||||
expectErr: true, |
||||
}, |
||||
{ |
||||
uri: "bzz", |
||||
expectErr: true, |
||||
}, |
||||
{ |
||||
uri: "bzz:", |
||||
expectURI: &URI{Scheme: "bzz"}, |
||||
}, |
||||
{ |
||||
uri: "bzzi:", |
||||
expectURI: &URI{Scheme: "bzzi"}, |
||||
expectImmutable: true, |
||||
}, |
||||
{ |
||||
uri: "bzzr:", |
||||
expectURI: &URI{Scheme: "bzzr"}, |
||||
expectRaw: true, |
||||
}, |
||||
{ |
||||
uri: "bzz:/", |
||||
expectURI: &URI{Scheme: "bzz"}, |
||||
}, |
||||
{ |
||||
uri: "bzz:/abc123", |
||||
expectURI: &URI{Scheme: "bzz", Addr: "abc123"}, |
||||
}, |
||||
{ |
||||
uri: "bzz:/abc123/path/to/entry", |
||||
expectURI: &URI{Scheme: "bzz", Addr: "abc123", Path: "path/to/entry"}, |
||||
}, |
||||
{ |
||||
uri: "bzzr:/", |
||||
expectURI: &URI{Scheme: "bzzr"}, |
||||
expectRaw: true, |
||||
}, |
||||
{ |
||||
uri: "bzzr:/abc123", |
||||
expectURI: &URI{Scheme: "bzzr", Addr: "abc123"}, |
||||
expectRaw: true, |
||||
}, |
||||
{ |
||||
uri: "bzzr:/abc123/path/to/entry", |
||||
expectURI: &URI{Scheme: "bzzr", Addr: "abc123", Path: "path/to/entry"}, |
||||
expectRaw: true, |
||||
}, |
||||
{ |
||||
uri: "bzz://", |
||||
expectURI: &URI{Scheme: "bzz"}, |
||||
}, |
||||
{ |
||||
uri: "bzz://abc123", |
||||
expectURI: &URI{Scheme: "bzz", Addr: "abc123"}, |
||||
}, |
||||
{ |
||||
uri: "bzz://abc123/path/to/entry", |
||||
expectURI: &URI{Scheme: "bzz", Addr: "abc123", Path: "path/to/entry"}, |
||||
}, |
||||
} |
||||
for _, x := range tests { |
||||
actual, err := Parse(x.uri) |
||||
if x.expectErr { |
||||
if err == nil { |
||||
t.Fatalf("expected %s to error", x.uri) |
||||
} |
||||
continue |
||||
} |
||||
if err != nil { |
||||
t.Fatalf("error parsing %s: %s", x.uri, err) |
||||
} |
||||
if !reflect.DeepEqual(actual, x.expectURI) { |
||||
t.Fatalf("expected %s to return %#v, got %#v", x.uri, x.expectURI, actual) |
||||
} |
||||
if actual.Raw() != x.expectRaw { |
||||
t.Fatalf("expected %s raw to be %t, got %t", x.uri, x.expectRaw, actual.Raw()) |
||||
} |
||||
if actual.Immutable() != x.expectImmutable { |
||||
t.Fatalf("expected %s immutable to be %t, got %t", x.uri, x.expectImmutable, actual.Immutable()) |
||||
} |
||||
} |
||||
} |
||||
Loading…
Reference in new issue