customflags.go 2.86 KB
Newer Older
1
package utils
2

3
import (
4 5 6 7 8 9 10 11
	"flag"
	"fmt"
	"os"
	"os/user"
	"path/filepath"
	"strings"

	"github.com/codegangsta/cli"
12 13 14 15 16 17
)

// Custom type which is registered in the flags library which cli uses for
// argument parsing. This allows us to expand Value to an absolute path when
// the argument is parsed
type DirectoryString struct {
18
	Value string
19 20
}

21
func (self *DirectoryString) String() string {
22
	return self.Value
23 24
}

25
func (self *DirectoryString) Set(value string) error {
26 27
	self.Value = expandPath(value)
	return nil
28 29 30 31 32
}

// Custom cli.Flag type which expand the received string to an absolute path.
// e.g. ~/.ethereum -> /home/username/.ethereum
type DirectoryFlag struct {
33 34 35 36 37
	cli.GenericFlag
	Name   string
	Value  DirectoryString
	Usage  string
	EnvVar string
38 39 40
}

func (self DirectoryFlag) String() string {
41 42
	var fmtString string
	fmtString = "%s %v\t%v"
43

44 45 46 47 48
	if len(self.Value.Value) > 0 {
		fmtString = "%s \"%v\"\t%v"
	} else {
		fmtString = "%s %v\t%v"
	}
49

50
	return withEnvHint(self.EnvVar, fmt.Sprintf(fmtString, prefixedNames(self.Name), self.Value.Value, self.Usage))
51 52 53
}

func eachName(longName string, fn func(string)) {
54 55 56 57 58
	parts := strings.Split(longName, ",")
	for _, name := range parts {
		name = strings.Trim(name, " ")
		fn(name)
	}
59
}
60

61 62 63
// called by cli library, grabs variable from environment (if in env)
// and adds variable to flag set for parsing.
func (self DirectoryFlag) Apply(set *flag.FlagSet) {
64 65 66 67 68 69 70 71 72 73 74
	if self.EnvVar != "" {
		for _, envVar := range strings.Split(self.EnvVar, ",") {
			envVar = strings.TrimSpace(envVar)
			if envVal := os.Getenv(envVar); envVal != "" {
				self.Value.Value = envVal
				break
			}
		}
	}

	eachName(self.Name, func(name string) {
75
		set.Var(&self.Value, self.Name, self.Usage)
76
	})
77 78 79
}

func prefixFor(name string) (prefix string) {
80 81 82 83 84
	if len(name) == 1 {
		prefix = "-"
	} else {
		prefix = "--"
	}
85

86
	return
87 88 89
}

func prefixedNames(fullName string) (prefixed string) {
90 91 92 93 94 95 96 97 98
	parts := strings.Split(fullName, ",")
	for i, name := range parts {
		name = strings.Trim(name, " ")
		prefixed += prefixFor(name) + name
		if i < len(parts)-1 {
			prefixed += ", "
		}
	}
	return
99 100 101
}

func withEnvHint(envVar, str string) string {
102 103 104 105 106
	envText := ""
	if envVar != "" {
		envText = fmt.Sprintf(" [$%s]", strings.Join(strings.Split(envVar, ","), ", $"))
	}
	return str + envText
107 108 109
}

func (self DirectoryFlag) getName() string {
110
	return self.Name
111 112 113
}

func (self *DirectoryFlag) Set(value string) {
114
	self.Value.Value = value
115 116 117 118 119 120 121 122
}

// Expands a file path
// 1. replace tilde with users home dir
// 2. expands embedded environment variables
// 3. cleans the path, e.g. /a/b/../c -> /a/c
// Note, it has limitations, e.g. ~someuser/tmp will not be expanded
func expandPath(p string) string {
123 124 125 126 127 128 129 130 131
	if strings.HasPrefix(p, "~/") || strings.HasPrefix(p, "~\\") {
		if user, err := user.Current(); err == nil {
			if err == nil {
				p = strings.Replace(p, "~", user.HomeDir, 1)
			}
		}
	}

	return filepath.Clean(os.ExpandEnv(p))
132
}