156 lines
3.7 KiB
Go
156 lines
3.7 KiB
Go
// Copyright 2015 The go-ethereum Authors
|
|
// This file is part of go-ethereum.
|
|
//
|
|
// go-ethereum is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// go-ethereum is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package utils
|
|
|
|
import (
|
|
"flag"
|
|
"fmt"
|
|
"os"
|
|
"os/user"
|
|
"path"
|
|
"strings"
|
|
|
|
"gopkg.in/urfave/cli.v1"
|
|
)
|
|
|
|
// 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 home := homeDir(); home != "" {
|
|
p = home + p[1:]
|
|
}
|
|
}
|
|
return path.Clean(os.ExpandEnv(p))
|
|
}
|
|
|
|
func homeDir() string {
|
|
if home := os.Getenv("HOME"); home != "" {
|
|
return home
|
|
}
|
|
if usr, err := user.Current(); err == nil {
|
|
return usr.HomeDir
|
|
}
|
|
return ""
|
|
}
|