diff --git a/cmd/serve/http/http.go b/cmd/serve/http/http.go index 7c71eb312..c10019480 100644 --- a/cmd/serve/http/http.go +++ b/cmd/serve/http/http.go @@ -126,7 +126,7 @@ func (s *server) serveDir(w http.ResponseWriter, r *http.Request, dirRemote stri } // Make the entries for display - directory := serve.NewDirectory(dirRemote) + directory := serve.NewDirectory(dirRemote, s.HTMLTemplate) for _, node := range dirEntries { directory.AddEntry(node.Path(), node.IsDir()) } diff --git a/cmd/serve/httplib/httplib.go b/cmd/serve/httplib/httplib.go index 49d55c640..43bfa42ec 100644 --- a/cmd/serve/httplib/httplib.go +++ b/cmd/serve/httplib/httplib.go @@ -6,6 +6,7 @@ import ( "crypto/x509" "encoding/base64" "fmt" + "html/template" "io/ioutil" "log" "net" @@ -14,6 +15,7 @@ import ( "time" auth "github.com/abbot/go-http-auth" + "github.com/ncw/rclone/cmd/serve/httplib/serve/data" "github.com/ncw/rclone/fs" "github.com/pkg/errors" ) @@ -107,8 +109,9 @@ type Server struct { waitChan chan struct{} // for waiting on the listener to close httpServer *http.Server basicPassHashed string - useSSL bool // if server is configured for SSL/TLS - usingAuth bool // set if authentication is configured + useSSL bool // if server is configured for SSL/TLS + usingAuth bool // set if authentication is configured + HTMLTemplate *template.Template // HTML template for web interface } // singleUserProvider provides the encrypted password for a single user @@ -205,6 +208,12 @@ func NewServer(handler http.Handler, opt *Options) *Server { s.httpServer.TLSConfig.ClientAuth = tls.RequireAndVerifyClientCert } + htmlTemplate, templateErr := data.GetTemplate() + if templateErr != nil { + log.Fatalf(templateErr.Error()) + } + s.HTMLTemplate = htmlTemplate + return s } diff --git a/cmd/serve/httplib/serve/data/assets_generate.go b/cmd/serve/httplib/serve/data/assets_generate.go new file mode 100644 index 000000000..ae5d87b3b --- /dev/null +++ b/cmd/serve/httplib/serve/data/assets_generate.go @@ -0,0 +1,22 @@ +// +build ignore + +package main + +import ( + "log" + "net/http" + + "github.com/shurcooL/vfsgen" +) + +func main() { + var AssetDir http.FileSystem = http.Dir("./templates") + err := vfsgen.Generate(AssetDir, vfsgen.Options{ + PackageName: "data", + BuildTags: "!dev", + VariableName: "Assets", + }) + if err != nil { + log.Fatalln(err) + } +} diff --git a/cmd/serve/httplib/serve/data/assets_vfsdata.go b/cmd/serve/httplib/serve/data/assets_vfsdata.go new file mode 100644 index 000000000..88d14efdd --- /dev/null +++ b/cmd/serve/httplib/serve/data/assets_vfsdata.go @@ -0,0 +1,186 @@ +// Code generated by vfsgen; DO NOT EDIT. + +// +build !dev + +package data + +import ( + "bytes" + "compress/gzip" + "fmt" + "io" + "io/ioutil" + "net/http" + "os" + pathpkg "path" + "time" +) + +// Assets statically implements the virtual filesystem provided to vfsgen. +var Assets = func() http.FileSystem { + fs := vfsgen۰FS{ + "/": &vfsgen۰DirInfo{ + name: "/", + modTime: time.Date(2018, 12, 16, 6, 54, 42, 894445775, time.UTC), + }, + "/index.html": &vfsgen۰CompressedFileInfo{ + name: "index.html", + modTime: time.Date(2018, 12, 16, 6, 54, 42, 790442328, time.UTC), + uncompressedSize: 226, + + compressedContent: []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\x5c\x8f\x31\xcf\x83\x20\x10\x86\x77\x7e\xc5\x7d\xc4\xf5\x93\xb8\x35\x0d\xb0\xb4\x6e\x26\x6d\x1a\x3b\x74\x3c\xeb\x29\x24\x4a\x13\xa4\x43\x43\xf8\xef\x0d\xea\xd4\x09\xee\x79\xef\x9e\xcb\xc9\xbf\xf3\xe5\xd4\x3e\xae\x35\x98\x30\x4f\x9a\xc9\xfc\xc0\x84\x6e\x54\x9c\x1c\xcf\x80\xb0\xd7\x4c\xce\x14\x10\x9e\x06\xfd\x42\x41\xf1\x77\x18\xfe\x0f\x39\x0d\x36\x4c\xa4\x63\x84\xb2\xcd\x3f\x48\x49\x8a\x8d\x31\x29\xf6\xd1\xee\xd5\x7f\xb2\xa8\xfa\xe9\x33\x95\x66\x31\x82\x47\x37\x12\x14\x16\x8e\x0a\xca\xda\x05\x6f\x69\xc9\x39\x82\xf1\x34\x28\x1e\x23\x14\xb6\xbc\xdf\x1a\x48\x89\xeb\xad\x6a\x08\x87\xd5\x81\x5a\x76\x1e\xc4\x2a\x22\xd7\xaf\x6c\xdf\x27\xb6\x8b\xbe\x01\x00\x00\xff\xff\x92\x2e\x35\x75\xe2\x00\x00\x00"), + }, + } + fs["/"].(*vfsgen۰DirInfo).entries = []os.FileInfo{ + fs["/index.html"].(os.FileInfo), + } + + return fs +}() + +type vfsgen۰FS map[string]interface{} + +func (fs vfsgen۰FS) Open(path string) (http.File, error) { + path = pathpkg.Clean("/" + path) + f, ok := fs[path] + if !ok { + return nil, &os.PathError{Op: "open", Path: path, Err: os.ErrNotExist} + } + + switch f := f.(type) { + case *vfsgen۰CompressedFileInfo: + gr, err := gzip.NewReader(bytes.NewReader(f.compressedContent)) + if err != nil { + // This should never happen because we generate the gzip bytes such that they are always valid. + panic("unexpected error reading own gzip compressed bytes: " + err.Error()) + } + return &vfsgen۰CompressedFile{ + vfsgen۰CompressedFileInfo: f, + gr: gr, + }, nil + case *vfsgen۰DirInfo: + return &vfsgen۰Dir{ + vfsgen۰DirInfo: f, + }, nil + default: + // This should never happen because we generate only the above types. + panic(fmt.Sprintf("unexpected type %T", f)) + } +} + +// vfsgen۰CompressedFileInfo is a static definition of a gzip compressed file. +type vfsgen۰CompressedFileInfo struct { + name string + modTime time.Time + compressedContent []byte + uncompressedSize int64 +} + +func (f *vfsgen۰CompressedFileInfo) Readdir(count int) ([]os.FileInfo, error) { + return nil, fmt.Errorf("cannot Readdir from file %s", f.name) +} +func (f *vfsgen۰CompressedFileInfo) Stat() (os.FileInfo, error) { return f, nil } + +func (f *vfsgen۰CompressedFileInfo) GzipBytes() []byte { + return f.compressedContent +} + +func (f *vfsgen۰CompressedFileInfo) Name() string { return f.name } +func (f *vfsgen۰CompressedFileInfo) Size() int64 { return f.uncompressedSize } +func (f *vfsgen۰CompressedFileInfo) Mode() os.FileMode { return 0444 } +func (f *vfsgen۰CompressedFileInfo) ModTime() time.Time { return f.modTime } +func (f *vfsgen۰CompressedFileInfo) IsDir() bool { return false } +func (f *vfsgen۰CompressedFileInfo) Sys() interface{} { return nil } + +// vfsgen۰CompressedFile is an opened compressedFile instance. +type vfsgen۰CompressedFile struct { + *vfsgen۰CompressedFileInfo + gr *gzip.Reader + grPos int64 // Actual gr uncompressed position. + seekPos int64 // Seek uncompressed position. +} + +func (f *vfsgen۰CompressedFile) Read(p []byte) (n int, err error) { + if f.grPos > f.seekPos { + // Rewind to beginning. + err = f.gr.Reset(bytes.NewReader(f.compressedContent)) + if err != nil { + return 0, err + } + f.grPos = 0 + } + if f.grPos < f.seekPos { + // Fast-forward. + _, err = io.CopyN(ioutil.Discard, f.gr, f.seekPos-f.grPos) + if err != nil { + return 0, err + } + f.grPos = f.seekPos + } + n, err = f.gr.Read(p) + f.grPos += int64(n) + f.seekPos = f.grPos + return n, err +} +func (f *vfsgen۰CompressedFile) Seek(offset int64, whence int) (int64, error) { + switch whence { + case io.SeekStart: + f.seekPos = 0 + offset + case io.SeekCurrent: + f.seekPos += offset + case io.SeekEnd: + f.seekPos = f.uncompressedSize + offset + default: + panic(fmt.Errorf("invalid whence value: %v", whence)) + } + return f.seekPos, nil +} +func (f *vfsgen۰CompressedFile) Close() error { + return f.gr.Close() +} + +// vfsgen۰DirInfo is a static definition of a directory. +type vfsgen۰DirInfo struct { + name string + modTime time.Time + entries []os.FileInfo +} + +func (d *vfsgen۰DirInfo) Read([]byte) (int, error) { + return 0, fmt.Errorf("cannot Read from directory %s", d.name) +} +func (d *vfsgen۰DirInfo) Close() error { return nil } +func (d *vfsgen۰DirInfo) Stat() (os.FileInfo, error) { return d, nil } + +func (d *vfsgen۰DirInfo) Name() string { return d.name } +func (d *vfsgen۰DirInfo) Size() int64 { return 0 } +func (d *vfsgen۰DirInfo) Mode() os.FileMode { return 0755 | os.ModeDir } +func (d *vfsgen۰DirInfo) ModTime() time.Time { return d.modTime } +func (d *vfsgen۰DirInfo) IsDir() bool { return true } +func (d *vfsgen۰DirInfo) Sys() interface{} { return nil } + +// vfsgen۰Dir is an opened dir instance. +type vfsgen۰Dir struct { + *vfsgen۰DirInfo + pos int // Position within entries for Seek and Readdir. +} + +func (d *vfsgen۰Dir) Seek(offset int64, whence int) (int64, error) { + if offset == 0 && whence == io.SeekStart { + d.pos = 0 + return 0, nil + } + return 0, fmt.Errorf("unsupported Seek in directory %s", d.name) +} + +func (d *vfsgen۰Dir) Readdir(count int) ([]os.FileInfo, error) { + if d.pos >= len(d.entries) && count > 0 { + return nil, io.EOF + } + if count <= 0 || count > len(d.entries)-d.pos { + count = len(d.entries) - d.pos + } + e := d.entries[d.pos : d.pos+count] + d.pos += count + return e, nil +} diff --git a/cmd/serve/httplib/serve/data/data.go b/cmd/serve/httplib/serve/data/data.go new file mode 100644 index 000000000..d0c51ebaa --- /dev/null +++ b/cmd/serve/httplib/serve/data/data.go @@ -0,0 +1,36 @@ +//go:generate go run assets_generate.go +// The "go:generate" directive compiles static assets by running assets_generate.go + +package data + +import ( + "html/template" + "io/ioutil" + + "github.com/ncw/rclone/fs" + "github.com/pkg/errors" +) + +// GetTemplate eturns the HTML template for serving directories via HTTP +func GetTemplate() (tpl *template.Template, err error) { + templateFile, err := Assets.Open("index.html") + if err != nil { + return nil, errors.Wrap(err, "get template open") + } + + defer fs.CheckClose(templateFile, &err) + + templateBytes, err := ioutil.ReadAll(templateFile) + if err != nil { + return nil, errors.Wrap(err, "get template read") + } + + var templateString = string(templateBytes) + + tpl, err = template.New("index").Parse(templateString) + if err != nil { + return nil, errors.Wrap(err, "get template parse") + } + + return +} diff --git a/cmd/serve/httplib/serve/data/templates/index.html b/cmd/serve/httplib/serve/data/templates/index.html new file mode 100644 index 000000000..9f16c72f8 --- /dev/null +++ b/cmd/serve/httplib/serve/data/templates/index.html @@ -0,0 +1,11 @@ + + + + +{{ .Title }} + + +

{{ .Title }}

+{{ range $i := .Entries }}{{ $i.Leaf }}
+{{ end }} + diff --git a/cmd/serve/httplib/serve/dir.go b/cmd/serve/httplib/serve/dir.go index e27a7ca66..4156d9f33 100644 --- a/cmd/serve/httplib/serve/dir.go +++ b/cmd/serve/httplib/serve/dir.go @@ -21,17 +21,19 @@ type DirEntry struct { // Directory represents a directory type Directory struct { - DirRemote string - Title string - Entries []DirEntry - Query string + DirRemote string + Title string + Entries []DirEntry + Query string + HTMLTemplate *template.Template } // NewDirectory makes an empty Directory -func NewDirectory(dirRemote string) *Directory { +func NewDirectory(dirRemote string, htmlTemplate *template.Template) *Directory { d := &Directory{ - DirRemote: dirRemote, - Title: fmt.Sprintf("Directory listing of /%s", dirRemote), + DirRemote: dirRemote, + Title: fmt.Sprintf("Directory listing of /%s", dirRemote), + HTMLTemplate: htmlTemplate, } return d } @@ -77,26 +79,10 @@ func (d *Directory) Serve(w http.ResponseWriter, r *http.Request) { defer accounting.Stats.DoneTransferring(d.DirRemote, true) fs.Infof(d.DirRemote, "%s: Serving directory", r.RemoteAddr) - err := indexTemplate.Execute(w, d) + + err := d.HTMLTemplate.Execute(w, d) if err != nil { Error(d.DirRemote, w, "Failed to render template", err) return } } - -// indexPage is a directory listing template -var indexPage = ` - - - -{{ .Title }} - - -

{{ .Title }}

-{{ range $i := .Entries }}{{ $i.Leaf }}
-{{ end }} - -` - -// indexTemplate is the instantiated indexPage -var indexTemplate = template.Must(template.New("index").Parse(indexPage)) diff --git a/cmd/serve/httplib/serve/dir_test.go b/cmd/serve/httplib/serve/dir_test.go index e4d0ffec4..37c3ce0e6 100644 --- a/cmd/serve/httplib/serve/dir_test.go +++ b/cmd/serve/httplib/serve/dir_test.go @@ -2,23 +2,32 @@ package serve import ( "errors" + "html/template" "io/ioutil" "net/http" "net/http/httptest" "net/url" "testing" + "github.com/ncw/rclone/cmd/serve/httplib/serve/data" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) +func GetTemplate(t *testing.T) *template.Template { + htmlTemplate, err := data.GetTemplate() + require.NoError(t, err) + return htmlTemplate +} + func TestNewDirectory(t *testing.T) { - d := NewDirectory("z") + d := NewDirectory("z", GetTemplate(t)) assert.Equal(t, "z", d.DirRemote) assert.Equal(t, "Directory listing of /z", d.Title) } func TestSetQuery(t *testing.T) { - d := NewDirectory("z") + d := NewDirectory("z", GetTemplate(t)) assert.Equal(t, "", d.Query) d.SetQuery(url.Values{"potato": []string{"42"}}) assert.Equal(t, "?potato=42", d.Query) @@ -27,7 +36,7 @@ func TestSetQuery(t *testing.T) { } func TestAddEntry(t *testing.T) { - var d = NewDirectory("z") + var d = NewDirectory("z", GetTemplate(t)) d.AddEntry("", true) d.AddEntry("dir", true) d.AddEntry("a/b/c/d.txt", false) @@ -42,7 +51,7 @@ func TestAddEntry(t *testing.T) { }, d.Entries) // Now test with a query parameter - d = NewDirectory("z").SetQuery(url.Values{"potato": []string{"42"}}) + d = NewDirectory("z", GetTemplate(t)).SetQuery(url.Values{"potato": []string{"42"}}) d.AddEntry("file", false) d.AddEntry("dir", true) assert.Equal(t, []DirEntry{ @@ -62,7 +71,7 @@ func TestError(t *testing.T) { } func TestServe(t *testing.T) { - d := NewDirectory("aDirectory") + d := NewDirectory("aDirectory", GetTemplate(t)) d.AddEntry("file", false) d.AddEntry("dir", true) diff --git a/fs/rc/rcserver/rcserver.go b/fs/rc/rcserver/rcserver.go index b52718e2f..6ccddfe3c 100644 --- a/fs/rc/rcserver/rcserver.go +++ b/fs/rc/rcserver/rcserver.go @@ -211,7 +211,7 @@ func (s *Server) handleOptions(w http.ResponseWriter, r *http.Request, path stri func (s *Server) serveRoot(w http.ResponseWriter, r *http.Request) { remotes := config.FileSections() sort.Strings(remotes) - directory := serve.NewDirectory("") + directory := serve.NewDirectory("", s.HTMLTemplate) directory.Title = "List of all rclone remotes." q := url.Values{} for _, remote := range remotes { @@ -235,7 +235,7 @@ func (s *Server) serveRemote(w http.ResponseWriter, r *http.Request, path string return } // Make the entries for display - directory := serve.NewDirectory(path) + directory := serve.NewDirectory(path, s.HTMLTemplate) for _, entry := range entries { _, isDir := entry.(fs.Directory) directory.AddEntry(entry.Remote(), isDir)