// Package rc implements a remote control server and registry for rclone // // To register your internal calls, call rc.Add(path, function). Your // function should take ane return a Param. It can also return an // error. Use rc.NewError to wrap an existing error along with an // http response type if another response other than 500 internal // error is required on error. package rc import ( "encoding/json" "io" "net/http" _ "net/http/pprof" // install the pprof http handlers "strings" "github.com/ncw/rclone/cmd/serve/httplib" "github.com/ncw/rclone/fs" "github.com/pkg/errors" ) // Options contains options for the remote control server type Options struct { HTTPOptions httplib.Options Enabled bool } // DefaultOpt is the default values used for Options var DefaultOpt = Options{ HTTPOptions: httplib.DefaultOpt, Enabled: false, } func init() { DefaultOpt.HTTPOptions.ListenAddr = "localhost:5572" } // Start the remote control server if configured func Start(opt *Options) { if opt.Enabled { s := newServer(opt) go s.serve() } } // server contains everything to run the server type server struct { srv *httplib.Server } func newServer(opt *Options) *server { // Serve on the DefaultServeMux so can have global registrations appear mux := http.DefaultServeMux s := &server{ srv: httplib.NewServer(mux, &opt.HTTPOptions), } mux.HandleFunc("/", s.handler) return s } // serve runs the http server - doesn't return func (s *server) serve() { err := s.srv.Serve() if err != nil { fs.Errorf(nil, "Opening listener: %v", err) } fs.Logf(nil, "Serving remote control on %s", s.srv.URL()) s.srv.Wait() } // WriteJSON writes JSON in out to w func WriteJSON(w io.Writer, out Params) error { enc := json.NewEncoder(w) enc.SetIndent("", "\t") return enc.Encode(out) } // handler reads incoming requests and dispatches them func (s *server) handler(w http.ResponseWriter, r *http.Request) { path := strings.Trim(r.URL.Path, "/") in := make(Params) writeError := func(err error, status int) { fs.Errorf(nil, "rc: %q: error: %v", path, err) w.WriteHeader(status) err = WriteJSON(w, Params{ "error": err.Error(), "input": in, }) if err != nil { // can't return the error at this point fs.Errorf(nil, "rc: failed to write JSON output: %v", err) } } if r.Method != "POST" { writeError(errors.Errorf("method %q not allowed - POST required", r.Method), http.StatusMethodNotAllowed) return } // Find the call call := registry.get(path) if call == nil { writeError(errors.Errorf("couldn't find method %q", path), http.StatusMethodNotAllowed) return } // Parse the POST and URL parameters into r.Form err := r.ParseForm() if err != nil { writeError(errors.Wrap(err, "failed to parse form/URL parameters"), http.StatusBadRequest) return } // Read the POST and URL parameters into in for k, vs := range r.Form { if len(vs) > 0 { in[k] = vs[len(vs)-1] } } fs.Debugf(nil, "form = %+v", r.Form) // Parse a JSON blob from the input if r.Header.Get("Content-Type") == "application/json" { err := json.NewDecoder(r.Body).Decode(&in) if err != nil { writeError(errors.Wrap(err, "failed to read input JSON"), http.StatusBadRequest) return } } fs.Debugf(nil, "rc: %q: with parameters %+v", path, in) out, err := call.Fn(in) if err != nil { writeError(errors.Wrap(err, "remote control command failed"), http.StatusInternalServerError) return } fs.Debugf(nil, "rc: %q: reply %+v: %v", path, out, err) err = WriteJSON(w, out) if err != nil { // can't return the error at this point fs.Errorf(nil, "rc: failed to write JSON output: %v", err) } }