aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/utils/customflags.go
blob: 78a6b8d22036502616259f5da1fa8bd0ccf50fb6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
package utils

import (
    "flag"
    "fmt"
    "os"
    "os/user"
    "path/filepath"
    "strings"

    "github.com/codegangsta/cli"
)

// 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 {
    Value string
}

func (self *DirectoryString) String() string {
    return self.Value
}

func (self *DirectoryString) Set(value string) error {
    self.Value = expandPath(value)
    return nil
}

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

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

    if len(self.Value.Value) > 0 {
        fmtString = "%s \"%v\"\t%v"
    } else {
        fmtString = "%s %v\t%v"
    }

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

func eachName(longName string, fn func(string)) {
    parts := strings.Split(longName, ",")
    for _, name := range parts {
        name = strings.Trim(name, " ")
        fn(name)
    }
}

// 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) {
    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) {
        set.Var(&self.Value, self.Name, self.Usage)
    })
}

func prefixFor(name string) (prefix string) {
    if len(name) == 1 {
        prefix = "-"
    } else {
        prefix = "--"
    }

    return
}

func prefixedNames(fullName string) (prefixed string) {
    parts := strings.Split(fullName, ",")
    for i, name := range parts {
        name = strings.Trim(name, " ")
        prefixed += prefixFor(name) + name
        if i < len(parts)-1 {
            prefixed += ", "
        }
    }
    return
}

func withEnvHint(envVar, str string) string {
    envText := ""
    if envVar != "" {
        envText = fmt.Sprintf(" [$%s]", strings.Join(strings.Split(envVar, ","), ", $"))
    }
    return str + envText
}

func (self DirectoryFlag) getName() string {
    return self.Name
}

func (self *DirectoryFlag) Set(value string) {
    self.Value.Value = value
}

// 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 {
    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))
}