Skip to content

"rsync for cloud storage" - Google Drive, S3, Dropbox, Backblaze B2, One Drive, Swift, Hubic, Wasabi, Google Cloud Storage, Azure Blob, Azure Files, Yandex Files

serve http: add serve rc interface

Nick Craig-Wood780f4040ea8e
diff --git a/cmd/serve/http/http.go b/cmd/serve/http/http.go
index e68c5951f..f9290684a 100644
--- a/cmd/serve/http/http.go
+++ b/cmd/serve/http/http.go
@@ -6,6 +6,7 @@ import (
"errors"
"fmt"
"io"
+ "net"
"net/http"
"os"
"path"
@@ -22,6 +23,7 @@ import (
"github.com/rclone/rclone/fs/accounting"
"github.com/rclone/rclone/fs/config/configstruct"
"github.com/rclone/rclone/fs/config/flags"
+ "github.com/rclone/rclone/fs/rc"
libhttp "github.com/rclone/rclone/lib/http"
"github.com/rclone/rclone/lib/http/serve"
"github.com/rclone/rclone/lib/systemd"
@@ -68,6 +70,28 @@ func init() {
vfsflags.AddFlags(flagSet)
proxyflags.AddFlags(flagSet)
cmdserve.Command.AddCommand(Command)
+ cmdserve.AddRc("http", func(ctx context.Context, f fs.Fs, in rc.Params) (cmdserve.Handle, error) {
+ // Read VFS Opts
+ var vfsOpt = vfscommon.Opt // set default opts
+ err := configstruct.SetAny(in, &vfsOpt)
+ if err != nil {
+ return nil, err
+ }
+ // Read Proxy Opts
+ var proxyOpt = proxy.Opt // set default opts
+ err = configstruct.SetAny(in, &proxyOpt)
+ if err != nil {
+ return nil, err
+ }
+ // Read opts
+ var opt = Opt // set default opts
+ err = configstruct.SetAny(in, &opt)
+ if err != nil {
+ return nil, err
+ }
+ // Create server
+ return newServer(ctx, f, &opt, &vfsOpt, &proxyOpt)
+ })
}
// Command definition for cobra
@@ -101,14 +125,12 @@ control the stats printing.
}
cmd.Run(false, true, command, func() error {
- s, err := run(context.Background(), f, Opt)
+ s, err := newServer(context.Background(), f, &Opt, &vfscommon.Opt, &proxy.Opt)
if err != nil {
fs.Fatal(nil, fmt.Sprint(err))
}
-
defer systemd.Notify()()
- s.server.Wait()
- return nil
+ return s.Serve()
})
},
}
@@ -148,19 +170,19 @@ func (s *HTTP) auth(user, pass string) (value any, err error) {
return VFS, err
}
-func run(ctx context.Context, f fs.Fs, opt Options) (s *HTTP, err error) {
+func newServer(ctx context.Context, f fs.Fs, opt *Options, vfsOpt *vfscommon.Options, proxyOpt *proxy.Options) (s *HTTP, err error) {
s = &HTTP{
f: f,
ctx: ctx,
- opt: opt,
+ opt: *opt,
}
- if proxy.Opt.AuthProxy != "" {
- s.proxy = proxy.New(ctx, &proxy.Opt, &vfscommon.Opt)
+ if proxyOpt.AuthProxy != "" {
+ s.proxy = proxy.New(ctx, proxyOpt, vfsOpt)
// override auth
s.opt.Auth.CustomAuthFn = s.auth
} else {
- s._vfs = vfs.New(f, &vfscommon.Opt)
+ s._vfs = vfs.New(f, vfsOpt)
}
s.server, err = libhttp.NewServer(ctx,
@@ -180,9 +202,24 @@ func run(ctx context.Context, f fs.Fs, opt Options) (s *HTTP, err error) {
router.Get("/*", s.handler)
router.Head("/*", s.handler)
+ return s, nil
+}
+
+// Serve HTTP until the server is shutdown
+func (s *HTTP) Serve() error {
s.server.Serve()
+ s.server.Wait()
+ return nil
+}
- return s, nil
+// Addr returns the first address of the server
+func (s *HTTP) Addr() net.Addr {
+ return s.server.Addr()
+}
+
+// Shutdown the server
+func (s *HTTP) Shutdown() error {
+ return s.server.Shutdown()
}
// handler reads incoming requests and dispatches them
diff --git a/cmd/serve/http/http_test.go b/cmd/serve/http/http_test.go
index 06266334d..3044c141a 100644
--- a/cmd/serve/http/http_test.go
+++ b/cmd/serve/http/http_test.go
@@ -13,9 +13,12 @@ import (
_ "github.com/rclone/rclone/backend/local"
"github.com/rclone/rclone/cmd/serve/proxy"
+ "github.com/rclone/rclone/cmd/serve/servetest"
"github.com/rclone/rclone/fs"
"github.com/rclone/rclone/fs/filter"
+ "github.com/rclone/rclone/fs/rc"
libhttp "github.com/rclone/rclone/lib/http"
+ "github.com/rclone/rclone/vfs/vfscommon"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@@ -44,8 +47,11 @@ func start(ctx context.Context, t *testing.T, f fs.Fs) (s *HTTP, testURL string)
opts.Auth.BasicPass = testPass
}
- s, err := run(ctx, f, opts)
+ s, err := newServer(ctx, f, &opts, &vfscommon.Opt, &proxy.Opt)
require.NoError(t, err, "failed to start server")
+ go func() {
+ require.NoError(t, s.Serve())
+ }()
urls := s.server.URLs()
require.Len(t, urls, 1, "expected one URL")
@@ -267,3 +273,10 @@ func TestGET(t *testing.T) {
func TestAuthProxy(t *testing.T) {
testGET(t, true)
}
+
+func TestRc(t *testing.T) {
+ servetest.TestRc(t, rc.Params{
+ "type": "http",
+ "vfs_cache_mode": "off",
+ })
+}