mirror of
https://github.com/rclone/rclone
synced 2024-11-12 10:50:08 +01:00
1ac6dacf0f
* Implement about for:
* local, crypt, cache, drive, swift, hubic, onedrive, pcloud, dropbox
* Implement `--json` and `---full` flag for `rclone about`
* change About interface to return a Usage structure
* Remove operations.About as it is too thin an interface
* Implement Integration test
Relates to #1138 and #1564
113 lines
2.7 KiB
Go
113 lines
2.7 KiB
Go
package about
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"os"
|
|
|
|
"github.com/ncw/rclone/cmd"
|
|
"github.com/ncw/rclone/fs"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
jsonOutput bool
|
|
fullOutput bool
|
|
)
|
|
|
|
func init() {
|
|
cmd.Root.AddCommand(commandDefinition)
|
|
commandDefinition.Flags().BoolVar(&jsonOutput, "json", false, "Format output as JSON")
|
|
commandDefinition.Flags().BoolVar(&fullOutput, "full", false, "Full numbers instead of SI units")
|
|
}
|
|
|
|
// printValue formats uv to be output
|
|
func printValue(what string, uv *int64) {
|
|
what += ":"
|
|
if uv == nil {
|
|
return
|
|
}
|
|
var val string
|
|
if fullOutput {
|
|
val = fmt.Sprintf("%d", *uv)
|
|
} else {
|
|
val = fs.SizeSuffix(*uv).String()
|
|
}
|
|
fmt.Printf("%-9s%v\n", what, val)
|
|
}
|
|
|
|
var commandDefinition = &cobra.Command{
|
|
Use: "about remote:",
|
|
Short: `Get quota information from the remote.`,
|
|
Long: `
|
|
Get quota information from the remote, like bytes used/free/quota and bytes
|
|
used in the trash. Not supported by all remotes.
|
|
|
|
This will print to stdout something like this:
|
|
|
|
Total: 17G
|
|
Used: 7.444G
|
|
Free: 1.315G
|
|
Trashed: 100.000M
|
|
Other: 8.241G
|
|
|
|
Where the fields are:
|
|
|
|
* Total: total size available.
|
|
* Used: total size used
|
|
* Free: total amount this user could upload.
|
|
* Trashed: total amount in the trash
|
|
* Other: total amount in other storage (eg Gmail, Google Photos)
|
|
* Objects: total number of objects in the storage
|
|
|
|
Note that not all the backends provide all the fields - they will be
|
|
missing if they are not known for that backend. Where it is known
|
|
that the value is unlimited the value will also be omitted.
|
|
|
|
Use the --full flag to see the numbers written out in full, eg
|
|
|
|
Total: 18253611008
|
|
Used: 7993453766
|
|
Free: 1411001220
|
|
Trashed: 104857602
|
|
Other: 8849156022
|
|
|
|
Use the --json flag for a computer readable output, eg
|
|
|
|
{
|
|
"total": 18253611008,
|
|
"used": 7993453766,
|
|
"trashed": 104857602,
|
|
"other": 8849156022,
|
|
"free": 1411001220
|
|
}
|
|
`,
|
|
Run: func(command *cobra.Command, args []string) {
|
|
cmd.CheckArgs(1, 1, command, args)
|
|
f := cmd.NewFsSrc(args)
|
|
cmd.Run(true, false, command, func() error {
|
|
doAbout := f.Features().About
|
|
if doAbout == nil {
|
|
return errors.Errorf("%v doesn't support about", f)
|
|
}
|
|
u, err := doAbout()
|
|
if err != nil {
|
|
return errors.Wrap(err, "About call failed")
|
|
}
|
|
if jsonOutput {
|
|
out := json.NewEncoder(os.Stdout)
|
|
out.SetIndent("", "\t")
|
|
return out.Encode(u)
|
|
}
|
|
printValue("Total", u.Total)
|
|
printValue("Used", u.Used)
|
|
printValue("Free", u.Free)
|
|
printValue("Trashed", u.Trashed)
|
|
printValue("Other", u.Other)
|
|
printValue("Objects", u.Objects)
|
|
return nil
|
|
})
|
|
},
|
|
}
|