From 4d005a2c1d2929dc770acd3a2bfed59495c70557 Mon Sep 17 00:00:00 2001 From: zelig Date: Mon, 26 Oct 2015 22:24:09 +0100 Subject: rpc api: eth_getNatSpec * xeth, rpc: implement eth_getNatSpec for tx confirmations * rename silly docserver -> httpclient * eth/backend: httpclient now accessible via eth.Ethereum init-d via config.DocRoot * cmd: introduce separate CLI flag for DocRoot (defaults to homedir) * common/path: delete unused assetpath func, separate HomeDir func --- common/docserver/docserver.go | 120 --------------------------------- common/docserver/docserver_test.go | 77 ---------------------- common/httpclient/httpclient.go | 124 +++++++++++++++++++++++++++++++++++ common/httpclient/httpclient_test.go | 77 ++++++++++++++++++++++ common/natspec/natspec.go | 14 ++-- common/natspec/natspec_e2e_test.go | 6 +- common/path.go | 44 ++----------- 7 files changed, 217 insertions(+), 245 deletions(-) delete mode 100644 common/docserver/docserver.go delete mode 100644 common/docserver/docserver_test.go create mode 100644 common/httpclient/httpclient.go create mode 100644 common/httpclient/httpclient_test.go (limited to 'common') diff --git a/common/docserver/docserver.go b/common/docserver/docserver.go deleted file mode 100644 index cfc4e3b26..000000000 --- a/common/docserver/docserver.go +++ /dev/null @@ -1,120 +0,0 @@ -// Copyright 2015 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 . - -package docserver - -import ( - "fmt" - "io/ioutil" - "net/http" - "path/filepath" - - "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/crypto" -) - -type DocServer struct { - *http.Transport - DocRoot string - schemes []string -} - -func New(docRoot string) (self *DocServer) { - self = &DocServer{ - Transport: &http.Transport{}, - DocRoot: docRoot, - schemes: []string{"file"}, - } - self.RegisterProtocol("file", http.NewFileTransport(http.Dir(self.DocRoot))) - return -} - -// Clients should be reused instead of created as needed. Clients are safe for concurrent use by multiple goroutines. - -// A Client is higher-level than a RoundTripper (such as Transport) and additionally handles HTTP details such as cookies and redirects. - -func (self *DocServer) Client() *http.Client { - return &http.Client{ - Transport: self, - } -} - -func (self *DocServer) RegisterScheme(scheme string, rt http.RoundTripper) { - self.schemes = append(self.schemes, scheme) - self.RegisterProtocol(scheme, rt) -} - -func (self *DocServer) HasScheme(scheme string) bool { - for _, s := range self.schemes { - if s == scheme { - return true - } - } - return false -} - -func (self *DocServer) GetAuthContent(uri string, hash common.Hash) (content []byte, err error) { - // retrieve content - content, err = self.Get(uri, "") - if err != nil { - return - } - - // check hash to authenticate content - chash := crypto.Sha3Hash(content) - if chash != hash { - content = nil - err = fmt.Errorf("content hash mismatch %x != %x (exp)", hash[:], chash[:]) - } - - return - -} - -// Get(uri, path) downloads the document at uri, if path is non-empty it -// is interpreted as a filepath to which the contents are saved -func (self *DocServer) Get(uri, path string) (content []byte, err error) { - // retrieve content - resp, err := self.Client().Get(uri) - - defer func() { - if resp != nil { - resp.Body.Close() - } - }() - - if err != nil { - return - } - - content, err = ioutil.ReadAll(resp.Body) - if err != nil { - return - } - - if resp.StatusCode/100 != 2 { - return content, fmt.Errorf("HTTP error: %s", resp.Status) - } - - if path != "" { - var abspath string - abspath, err = filepath.Abs(path) - ioutil.WriteFile(abspath, content, 0700) - } - - return - -} diff --git a/common/docserver/docserver_test.go b/common/docserver/docserver_test.go deleted file mode 100644 index 632603add..000000000 --- a/common/docserver/docserver_test.go +++ /dev/null @@ -1,77 +0,0 @@ -// Copyright 2015 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 . - -package docserver - -import ( - "io/ioutil" - "net/http" - "os" - "path" - "testing" - - "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/crypto" -) - -func TestGetAuthContent(t *testing.T) { - dir, err := ioutil.TempDir("", "docserver-test") - if err != nil { - t.Fatal("cannot create temporary directory:", err) - } - defer os.RemoveAll(dir) - ds := New(dir) - - text := "test" - hash := crypto.Sha3Hash([]byte(text)) - if err := ioutil.WriteFile(path.Join(dir, "test.content"), []byte(text), os.ModePerm); err != nil { - t.Fatal("could not write test file", err) - } - content, err := ds.GetAuthContent("file:///test.content", hash) - if err != nil { - t.Errorf("no error expected, got %v", err) - } - if string(content) != text { - t.Errorf("incorrect content. expected %v, got %v", text, string(content)) - } - - hash = common.Hash{} - content, err = ds.GetAuthContent("file:///test.content", hash) - expected := "content hash mismatch 0000000000000000000000000000000000000000000000000000000000000000 != 9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658 (exp)" - if err == nil { - t.Errorf("expected error, got nothing") - } else { - if err.Error() != expected { - t.Errorf("expected error '%s' got '%v'", expected, err) - } - } - -} - -type rt struct{} - -func (rt) RoundTrip(req *http.Request) (resp *http.Response, err error) { return } - -func TestRegisterScheme(t *testing.T) { - ds := New("/tmp/") - if ds.HasScheme("scheme") { - t.Errorf("expected scheme not to be registered") - } - ds.RegisterScheme("scheme", rt{}) - if !ds.HasScheme("scheme") { - t.Errorf("expected scheme to be registered") - } -} \ No newline at end of file diff --git a/common/httpclient/httpclient.go b/common/httpclient/httpclient.go new file mode 100644 index 000000000..23373ecaf --- /dev/null +++ b/common/httpclient/httpclient.go @@ -0,0 +1,124 @@ +// Copyright 2015 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 . + +package httpclient + +import ( + "fmt" + "io/ioutil" + "net/http" + "path/filepath" + + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/crypto" +) + +type HTTPClient struct { + *http.Transport + DocRoot string + schemes []string +} + +func New(docRoot string) (self *HTTPClient) { + self = &HTTPClient{ + Transport: &http.Transport{}, + DocRoot: docRoot, + schemes: []string{"file"}, + } + self.RegisterProtocol("file", http.NewFileTransport(http.Dir(self.DocRoot))) + return +} + +// Clients should be reused instead of created as needed. Clients are safe for concurrent use by multiple goroutines. + +// A Client is higher-level than a RoundTripper (such as Transport) and additionally handles HTTP details such as cookies and redirects. + +func (self *HTTPClient) Client() *http.Client { + return &http.Client{ + Transport: self, + } +} + +func (self *HTTPClient) RegisterScheme(scheme string, rt http.RoundTripper) { + self.schemes = append(self.schemes, scheme) + self.RegisterProtocol(scheme, rt) +} + +func (self *HTTPClient) HasScheme(scheme string) bool { + for _, s := range self.schemes { + if s == scheme { + return true + } + } + return false +} + +func (self *HTTPClient) GetAuthContent(uri string, hash common.Hash) ([]byte, error) { + // retrieve content + content, err := self.Get(uri, "") + if err != nil { + return nil, err + } + + // check hash to authenticate content + chash := crypto.Sha3Hash(content) + if chash != hash { + return nil, fmt.Errorf("content hash mismatch %x != %x (exp)", hash[:], chash[:]) + } + + return content, nil + +} + +// Get(uri, path) downloads the document at uri, if path is non-empty it +// is interpreted as a filepath to which the contents are saved +func (self *HTTPClient) Get(uri, path string) ([]byte, error) { + // retrieve content + resp, err := self.Client().Get(uri) + if err != nil { + return nil, err + } + defer func() { + if resp != nil { + resp.Body.Close() + } + }() + + var content []byte + content, err = ioutil.ReadAll(resp.Body) + if err != nil { + return nil, err + } + + if resp.StatusCode/100 != 2 { + return content, fmt.Errorf("HTTP error: %s", resp.Status) + } + + if path != "" { + var abspath string + abspath, err = filepath.Abs(path) + if err != nil { + return nil, err + } + err = ioutil.WriteFile(abspath, content, 0600) + if err != nil { + return nil, err + } + } + + return content, nil + +} diff --git a/common/httpclient/httpclient_test.go b/common/httpclient/httpclient_test.go new file mode 100644 index 000000000..6c3782e15 --- /dev/null +++ b/common/httpclient/httpclient_test.go @@ -0,0 +1,77 @@ +// Copyright 2015 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 . + +package httpclient + +import ( + "io/ioutil" + "net/http" + "os" + "path" + "testing" + + "github.com/ethereum/go-ethereum/common" + "github.com/ethereum/go-ethereum/crypto" +) + +func TestGetAuthContent(t *testing.T) { + dir, err := ioutil.TempDir("", "httpclient-test") + if err != nil { + t.Fatal("cannot create temporary directory:", err) + } + defer os.RemoveAll(dir) + client := New(dir) + + text := "test" + hash := crypto.Sha3Hash([]byte(text)) + if err := ioutil.WriteFile(path.Join(dir, "test.content"), []byte(text), os.ModePerm); err != nil { + t.Fatal("could not write test file", err) + } + content, err := client.GetAuthContent("file:///test.content", hash) + if err != nil { + t.Errorf("no error expected, got %v", err) + } + if string(content) != text { + t.Errorf("incorrect content. expected %v, got %v", text, string(content)) + } + + hash = common.Hash{} + content, err = client.GetAuthContent("file:///test.content", hash) + expected := "content hash mismatch 0000000000000000000000000000000000000000000000000000000000000000 != 9c22ff5f21f0b81b113e63f7db6da94fedef11b2119b4088b89664fb9a3cb658 (exp)" + if err == nil { + t.Errorf("expected error, got nothing") + } else { + if err.Error() != expected { + t.Errorf("expected error '%s' got '%v'", expected, err) + } + } + +} + +type rt struct{} + +func (rt) RoundTrip(req *http.Request) (resp *http.Response, err error) { return } + +func TestRegisterScheme(t *testing.T) { + client := New("/tmp/") + if client.HasScheme("scheme") { + t.Errorf("expected scheme not to be registered") + } + client.RegisterScheme("scheme", rt{}) + if !client.HasScheme("scheme") { + t.Errorf("expected scheme to be registered") + } +} diff --git a/common/natspec/natspec.go b/common/natspec/natspec.go index 0265c2e13..d9627b4e1 100644 --- a/common/natspec/natspec.go +++ b/common/natspec/natspec.go @@ -23,7 +23,7 @@ import ( "strings" "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/common/docserver" + "github.com/ethereum/go-ethereum/common/httpclient" "github.com/ethereum/go-ethereum/common/registrar" "github.com/ethereum/go-ethereum/crypto" "github.com/ethereum/go-ethereum/xeth" @@ -43,7 +43,7 @@ type NatSpec struct { // the implementation is frontend friendly in that it always gives back // a notice that is safe to display // :FIXME: the second return value is an error, which can be used to fine-tune bahaviour -func GetNotice(xeth *xeth.XEth, tx string, http *docserver.DocServer) (notice string) { +func GetNotice(xeth *xeth.XEth, tx string, http *httpclient.HTTPClient) (notice string) { ns, err := New(xeth, tx, http) if err != nil { if ns == nil { @@ -83,7 +83,7 @@ type contractInfo struct { DeveloperDoc json.RawMessage `json:"developerDoc"` } -func New(xeth *xeth.XEth, jsontx string, http *docserver.DocServer) (self *NatSpec, err error) { +func New(xeth *xeth.XEth, jsontx string, http *httpclient.HTTPClient) (self *NatSpec, err error) { // extract contract address from tx var tx jsonTx @@ -104,7 +104,7 @@ func New(xeth *xeth.XEth, jsontx string, http *docserver.DocServer) (self *NatSp } // also called by admin.contractInfo.get -func FetchDocsForContract(contractAddress string, xeth *xeth.XEth, ds *docserver.DocServer) (content []byte, err error) { +func FetchDocsForContract(contractAddress string, xeth *xeth.XEth, client *httpclient.HTTPClient) (content []byte, err error) { // retrieve contract hash from state codehex := xeth.CodeAt(contractAddress) codeb := xeth.CodeAtBytes(contractAddress) @@ -122,8 +122,8 @@ func FetchDocsForContract(contractAddress string, xeth *xeth.XEth, ds *docserver if err != nil { return } - if ds.HasScheme("bzz") { - content, err = ds.Get("bzz://"+hash.Hex()[2:], "") + if client.HasScheme("bzz") { + content, err = client.Get("bzz://"+hash.Hex()[2:], "") if err == nil { // non-fatal return } @@ -137,7 +137,7 @@ func FetchDocsForContract(contractAddress string, xeth *xeth.XEth, ds *docserver } // get content via http client and authenticate content using hash - content, err = ds.GetAuthContent(uri, hash) + content, err = client.GetAuthContent(uri, hash) if err != nil { return } diff --git a/common/natspec/natspec_e2e_test.go b/common/natspec/natspec_e2e_test.go index 4149314c3..706a294ec 100644 --- a/common/natspec/natspec_e2e_test.go +++ b/common/natspec/natspec_e2e_test.go @@ -28,7 +28,7 @@ import ( "github.com/ethereum/go-ethereum/accounts" "github.com/ethereum/go-ethereum/common" - "github.com/ethereum/go-ethereum/common/docserver" + "github.com/ethereum/go-ethereum/common/httpclient" "github.com/ethereum/go-ethereum/common/registrar" "github.com/ethereum/go-ethereum/core" "github.com/ethereum/go-ethereum/crypto" @@ -113,8 +113,8 @@ func (self *testFrontend) UnlockAccount(acc []byte) bool { func (self *testFrontend) ConfirmTransaction(tx string) bool { if self.wantNatSpec { - ds := docserver.New("/tmp/") - self.lastConfirm = GetNotice(self.xeth, tx, ds) + client := httpclient.New("/tmp/") + self.lastConfirm = GetNotice(self.xeth, tx, client) } return true } diff --git a/common/path.go b/common/path.go index 1253c424c..39eacacee 100644 --- a/common/path.go +++ b/common/path.go @@ -23,8 +23,6 @@ import ( "path/filepath" "runtime" "strings" - - "github.com/kardianos/osext" ) // MakeName creates a node name that follows the ethereum convention @@ -65,48 +63,18 @@ func AbsolutePath(Datadir string, filename string) string { return filepath.Join(Datadir, filename) } -func DefaultAssetPath() string { - var assetPath string - pwd, _ := os.Getwd() - srcdir := filepath.Join(os.Getenv("GOPATH"), "src", "github.com", "ethereum", "go-ethereum", "cmd", "mist") - - // If the current working directory is the go-ethereum dir - // assume a debug build and use the source directory as - // asset directory. - if pwd == srcdir { - assetPath = filepath.Join(pwd, "assets") +func HomeDir() (home string) { + if usr, err := user.Current(); err == nil { + home = usr.HomeDir } else { - switch runtime.GOOS { - case "darwin": - // Get Binary Directory - exedir, _ := osext.ExecutableFolder() - assetPath = filepath.Join(exedir, "..", "Resources") - case "linux": - assetPath = filepath.Join("usr", "share", "mist") - case "windows": - assetPath = filepath.Join(".", "assets") - default: - assetPath = "." - } - } - - // Check if the assetPath exists. If not, try the source directory - // This happens when binary is run from outside cmd/mist directory - if _, err := os.Stat(assetPath); os.IsNotExist(err) { - assetPath = filepath.Join(srcdir, "assets") + home = os.Getenv("HOME") } - - return assetPath + return } func DefaultDataDir() string { // Try to place the data folder in the user's home dir - var home string - if usr, err := user.Current(); err == nil { - home = usr.HomeDir - } else { - home = os.Getenv("HOME") - } + home := HomeDir() if home != "" { if runtime.GOOS == "darwin" { return filepath.Join(home, "Library", "Ethereum") -- cgit v1.2.3