lib/cmd/cmd.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: Apache-2.0
   4
   5 // package cmd helps define reusable functions that can be exposed as
   6 // [subcommands of] command line programs.
   7 package cmd
   8
   9 import (
  10         "flag"
  11         "fmt"
  12         "io"
  13         "io/ioutil"
  14         "path/filepath"
  15         "regexp"
  16         "runtime"
  17         "sort"
  18         "strings"
  19 )
  20
  21 type Handler interface {
  22         RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int
  23 }
  24
  25 type HandlerFunc func(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int
  26
  27 func (f HandlerFunc) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  28         return f(prog, args, stdin, stdout, stderr)
  29 }
  30
  31 // Version is a Handler that prints the package version (set at build
  32 // time using -ldflags) and Go runtime version to stdout, and returns
  33 // 0.
  34 var Version versionCommand
  35
  36 var version = "dev"
  37
  38 type versionCommand struct{}
  39
  40 func (versionCommand) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  41         prog = regexp.MustCompile(` -*version$`).ReplaceAllLiteralString(prog, "")
  42         fmt.Fprintf(stdout, "%s %s (%s)\n", prog, version, runtime.Version())
  43         return 0
  44 }
  45
  46 // Multi is a Handler that looks up its first argument in a map (after
  47 // stripping any "arvados-" or "crunch-" prefix), and invokes the
  48 // resulting Handler with the remaining args.
  49 //
  50 // Example:
  51 //
  52 //     os.Exit(Multi(map[string]Handler{
  53 //             "foobar": HandlerFunc(func(prog string, args []string) int {
  54 //                     fmt.Println(args[0])
  55 //                     return 2
  56 //             }),
  57 //     })("/usr/bin/multi", []string{"foobar", "baz"}))
  58 //
  59 // ...prints "baz" and exits 2.
  60 type Multi map[string]Handler
  61
  62 func (m Multi) RunCommand(prog string, args []string, stdin io.Reader, stdout, stderr io.Writer) int {
  63         _, basename := filepath.Split(prog)
  64         basename = strings.TrimPrefix(basename, "arvados-")
  65         basename = strings.TrimPrefix(basename, "crunch-")
  66         if cmd, ok := m[basename]; ok {
  67                 return cmd.RunCommand(prog, args, stdin, stdout, stderr)
  68         } else if len(args) < 1 {
  69                 fmt.Fprintf(stderr, "usage: %s command [args]\n", prog)
  70                 m.Usage(stderr)
  71                 return 2
  72         } else if cmd, ok = m[args[0]]; ok {
  73                 return cmd.RunCommand(prog+" "+args[0], args[1:], stdin, stdout, stderr)
  74         } else {
  75                 fmt.Fprintf(stderr, "%s: unrecognized command %q\n", prog, args[0])
  76                 m.Usage(stderr)
  77                 return 2
  78         }
  79 }
  80
  81 func (m Multi) Usage(stderr io.Writer) {
  82         fmt.Fprintf(stderr, "\nAvailable commands:\n")
  83         m.listSubcommands(stderr, "")
  84 }
  85
  86 func (m Multi) listSubcommands(out io.Writer, prefix string) {
  87         var subcommands []string
  88         for sc := range m {
  89                 if strings.HasPrefix(sc, "-") {
  90                         // Some subcommands have alternate versions
  91                         // like "--version" for compatibility. Don't
  92                         // clutter the subcommand summary with those.
  93                         continue
  94                 }
  95                 subcommands = append(subcommands, sc)
  96         }
  97         sort.Strings(subcommands)
  98         for _, sc := range subcommands {
  99                 switch cmd := m[sc].(type) {
 100                 case Multi:
 101                         cmd.listSubcommands(out, prefix+sc+" ")
 102                 default:
 103                         fmt.Fprintf(out, "    %s%s\n", prefix, sc)
 104                 }
 105         }
 106 }
 107
 108 type FlagSet interface {
 109         Init(string, flag.ErrorHandling)
 110         Args() []string
 111         NArg() int
 112         Parse([]string) error
 113         SetOutput(io.Writer)
 114         PrintDefaults()
 115 }
 116
 117 // SubcommandToFront silently parses args using flagset, and returns a
 118 // copy of args with the first non-flag argument moved to the
 119 // front. If parsing fails or consumes all of args, args is returned
 120 // unchanged.
 121 //
 122 // SubcommandToFront invokes methods on flagset that have side
 123 // effects, including Parse. In typical usage, flagset will not used
 124 // for anything else after being passed to SubcommandToFront.
 125 func SubcommandToFront(args []string, flagset FlagSet) []string {
 126         flagset.Init("", flag.ContinueOnError)
 127         flagset.SetOutput(ioutil.Discard)
 128         if err := flagset.Parse(args); err != nil || flagset.NArg() == 0 {
 129                 // No subcommand found.
 130                 return args
 131         }
 132         // Move subcommand to the front.
 133         flagargs := len(args) - flagset.NArg()
 134         newargs := make([]string, len(args))
 135         newargs[0] = args[flagargs]
 136         copy(newargs[1:flagargs+1], args[:flagargs])
 137         copy(newargs[flagargs+1:], args[flagargs+1:])
 138         return newargs
 139 }