b40d9bd4c4
Currently rclone check supports matching two file trees by sizes and hashes. This change adds support for SUM files produced by GNU utilities like sha1sum. Fixes #1005 Note: checksum by default checks, hashsum by default prints sums. New flag is named "--checkfile" but carries hash name. Summary of introduced command forms: ``` rclone check sums.sha1 remote:path --checkfile sha1 rclone checksum sha1 sums.sha1 remote:path rclone hashsum sha1 remote:path --checkfile sums.sha1 rclone sha1sum remote:path --checkfile sums.sha1 rclone md5sum remote:path --checkfile sums.md5 ```
114 lines
3.5 KiB
Go
114 lines
3.5 KiB
Go
package hashsum
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/pkg/errors"
|
|
"github.com/rclone/rclone/cmd"
|
|
"github.com/rclone/rclone/fs"
|
|
"github.com/rclone/rclone/fs/config/flags"
|
|
"github.com/rclone/rclone/fs/hash"
|
|
"github.com/rclone/rclone/fs/operations"
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/pflag"
|
|
)
|
|
|
|
// Global hashsum flags for reuse in hashsum, md5sum, sha1sum
|
|
var (
|
|
OutputBase64 = false
|
|
DownloadFlag = false
|
|
HashsumOutfile = ""
|
|
ChecksumFile = ""
|
|
)
|
|
|
|
func init() {
|
|
cmd.Root.AddCommand(commandDefinition)
|
|
cmdFlags := commandDefinition.Flags()
|
|
AddHashFlags(cmdFlags)
|
|
}
|
|
|
|
// AddHashFlags is a convenience function to add the command flags OutputBase64 and DownloadFlag to hashsum, md5sum, sha1sum
|
|
func AddHashFlags(cmdFlags *pflag.FlagSet) {
|
|
flags.BoolVarP(cmdFlags, &OutputBase64, "base64", "", OutputBase64, "Output base64 encoded hashsum")
|
|
flags.StringVarP(cmdFlags, &HashsumOutfile, "output-file", "", HashsumOutfile, "Output hashsums to a file rather than the terminal")
|
|
flags.StringVarP(cmdFlags, &ChecksumFile, "checkfile", "C", ChecksumFile, "Validate hashes against a given SUM file instead of printing them")
|
|
flags.BoolVarP(cmdFlags, &DownloadFlag, "download", "", DownloadFlag, "Download the file and hash it locally; if this flag is not specified, the hash is requested from the remote")
|
|
}
|
|
|
|
// GetHashsumOutput opens and closes the output file when using the output-file flag
|
|
func GetHashsumOutput(filename string) (out *os.File, close func(), err error) {
|
|
out, err = os.Create(filename)
|
|
if err != nil {
|
|
err = errors.Wrapf(err, "Failed to open output file %v", filename)
|
|
return nil, nil, err
|
|
}
|
|
|
|
close = func() {
|
|
err := out.Close()
|
|
if err != nil {
|
|
fs.Errorf(nil, "Failed to close output file %v: %v", filename, err)
|
|
}
|
|
}
|
|
|
|
return out, close, nil
|
|
}
|
|
|
|
var commandDefinition = &cobra.Command{
|
|
Use: "hashsum <hash> remote:path",
|
|
Short: `Produces a hashsum file for all the objects in the path.`,
|
|
Long: `
|
|
Produces a hash file for all the objects in the path using the hash
|
|
named. The output is in the same format as the standard
|
|
md5sum/sha1sum tool.
|
|
|
|
By default, the hash is requested from the remote. If the hash is
|
|
not supported by the remote, no hash will be returned. With the
|
|
download flag, the file will be downloaded from the remote and
|
|
hashed locally enabling any hash for any remote.
|
|
|
|
Run without a hash to see the list of all supported hashes, e.g.
|
|
|
|
$ rclone hashsum
|
|
` + hash.HelpString(4) + `
|
|
Then
|
|
|
|
$ rclone hashsum MD5 remote:path
|
|
|
|
Note that hash names are case insensitive.
|
|
`,
|
|
RunE: func(command *cobra.Command, args []string) error {
|
|
cmd.CheckArgs(0, 2, command, args)
|
|
if len(args) == 0 {
|
|
fmt.Print(hash.HelpString(0))
|
|
return nil
|
|
} else if len(args) == 1 {
|
|
return errors.New("need hash type and remote")
|
|
}
|
|
var ht hash.Type
|
|
err := ht.Set(args[0])
|
|
if err != nil {
|
|
fmt.Println(hash.HelpString(0))
|
|
return err
|
|
}
|
|
fsrc := cmd.NewFsSrc(args[1:])
|
|
|
|
cmd.Run(false, false, command, func() error {
|
|
if ChecksumFile != "" {
|
|
fsum, sumFile := cmd.NewFsFile(ChecksumFile)
|
|
return operations.CheckSum(context.Background(), fsrc, fsum, sumFile, ht, nil, DownloadFlag)
|
|
}
|
|
if HashsumOutfile == "" {
|
|
return operations.HashLister(context.Background(), ht, OutputBase64, DownloadFlag, fsrc, nil)
|
|
}
|
|
output, close, err := GetHashsumOutput(HashsumOutfile)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer close()
|
|
return operations.HashLister(context.Background(), ht, OutputBase64, DownloadFlag, fsrc, output)
|
|
})
|
|
return nil
|
|
},
|
|
}
|