rc: add sync report parameters to sync/sync, sync/copy and sync/move - fixes #9846

The sync report flags (--combined, --missing-on-src, --missing-on-dst,
--match, --differ, --error and --dest-after) were only wired up in the
CLI commands so there was no way to get these reports over the rc or
from librclone.

This adds boolean parameters of the same names as operations/check
(combined, missingOnSrc, missingOnDst, match, differ, error and
destAfter) to sync/sync, sync/copy and sync/move. Each requested
report is returned as an array of strings in the output, just as
operations/check does. All default to off so existing callers see no
change in the output.

To share the code between the CLI and the rc the report writer helper
from operations/check is exported as operations.RcReportWriter, the
lsf defaults for --dest-after are moved into
operations.NewSyncLoggerOpt and the listing setup and --no-traverse
warnings from operationsflags.ConfigureLoggers into LoggerOpt.Init.

fs/sync/rc.go

@@ -3,6 +3,8 @@ package sync
 import (
 	"context"
 
+	"github.com/rclone/rclone/fs"
+	"github.com/rclone/rclone/fs/operations"
 	"github.com/rclone/rclone/fs/rc"
 )
 
@@ -23,7 +25,27 @@ func init() {
 - srcFs - a remote name string e.g. "drive:src" for the source
 - dstFs - a remote name string e.g. "drive:dst" for the destination
 - createEmptySrcDirs - create empty src directories on destination if set
-` + moveHelp + `
+` + moveHelp + `- combined - make a combined report of changes (default false)
+- missingOnSrc - report all files missing from the source (default false)
+- missingOnDst - report all files missing from the destination (default false)
+- match - report all matching files (default false)
+- differ - report all non-matching files (default false)
+- error - report all files with errors (hashing or reading) (default false)
+- destAfter - report all files that exist on the destination post-` + name + ` (default false)
+
+Returns:
+
+- combined - array of strings of combined report of changes
+- missingOnSrc - array of strings of all files missing from the source
+- missingOnDst - array of strings of all files missing from the destination
+- match - array of strings of all matching files
+- differ - array of strings of all non-matching files
+- error - array of strings of all files with errors (hashing or reading)
+- destAfter - array of strings of all files that exist on the destination post-` + name + `
+
+Each report is only returned if its parameter is set to true. If the
+operation fails the reports are only available if it was run with
+` + "`_async`" + `, as part of the job output.
 
 See the [` + name + `](/commands/rclone_` + name + `/) command for more information on the above.`,
 		})
@@ -44,17 +66,38 @@ func rcSyncCopyMove(ctx context.Context, in rc.Params, name string) (out rc.Para
 	if rc.NotErrParamNotFound(err) {
 		return nil, err
 	}
+	ctx, out = rcLogger(ctx, in, dstFs)
 	switch name {
 	case "sync":
-		return nil, Sync(ctx, dstFs, srcFs, createEmptySrcDirs)
+		return out, Sync(ctx, dstFs, srcFs, createEmptySrcDirs)
 	case "copy":
-		return nil, CopyDir(ctx, dstFs, srcFs, createEmptySrcDirs)
+		return out, CopyDir(ctx, dstFs, srcFs, createEmptySrcDirs)
 	case "move":
 		deleteEmptySrcDirs, err := in.GetBool("deleteEmptySrcDirs")
 		if rc.NotErrParamNotFound(err) {
 			return nil, err
 		}
-		return nil, MoveDir(ctx, dstFs, srcFs, deleteEmptySrcDirs, createEmptySrcDirs)
+		return out, MoveDir(ctx, dstFs, srcFs, deleteEmptySrcDirs, createEmptySrcDirs)
 	}
 	panic("unknown rcSyncCopyMove type")
 }
+
+// rcLogger returns ctx with a sync logger which collects the reports
+// requested in in into the returned out, which is empty if none were.
+func rcLogger(ctx context.Context, in rc.Params, fdst fs.Fs) (context.Context, rc.Params) {
+	out := rc.Params{}
+	opt := operations.NewSyncLoggerOpt()
+	opt.Combined = operations.RcReportWriter(in, out, "combined", false)
+	opt.MissingOnSrc = operations.RcReportWriter(in, out, "missingOnSrc", false)
+	opt.MissingOnDst = operations.RcReportWriter(in, out, "missingOnDst", false)
+	opt.Match = operations.RcReportWriter(in, out, "match", false)
+	opt.Differ = operations.RcReportWriter(in, out, "differ", false)
+	opt.Error = operations.RcReportWriter(in, out, "error", false)
+	opt.DestAfter = operations.RcReportWriter(in, out, "destAfter", false)
+	if len(out) == 0 {
+		return ctx, out
+	}
+	opt.LoggerFn = operations.NewDefaultLoggerFn(&opt)
+	opt.Init(ctx, fdst, nil)
+	return operations.WithSyncLogger(ctx, opt), out
+}