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 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
|
// Package env contains runtime environment variables for usql, along with
// various helper funcs to determine the user's configuration.
package env
import (
"bytes"
"io"
"os"
"os/exec"
"os/user"
"path/filepath"
"regexp"
"runtime"
"strconv"
"strings"
"unicode/utf8"
"github.com/kenshaw/rasterm"
"github.com/xo/dburl/passfile"
"github.com/xo/usql/text"
)
// Getenv tries retrieving successive keys from os environment variables.
func Getenv(keys ...string) (string, bool) {
m := make(map[string]string)
for _, v := range os.Environ() {
if i := strings.Index(v, "="); i != -1 {
m[v[:i]] = v[i+1:]
}
}
for _, key := range keys {
if v, ok := m[key]; ok {
return v, true
}
}
return "", false
}
// Chdir changes the current working directory to the specified path, or to the
// user's home directory if path is not specified.
func Chdir(u *user.User, path string) error {
if path != "" {
path = passfile.Expand(u.HomeDir, path)
} else {
path = u.HomeDir
}
return os.Chdir(path)
}
// OpenFile opens a file for read (os.O_RDONLY), returning the full, expanded
// path of the file. Callers are responsible for closing the returned file.
func OpenFile(u *user.User, path string, relative bool) (string, *os.File, error) {
path, err := filepath.EvalSymlinks(passfile.Expand(u.HomeDir, path))
switch {
case err != nil && os.IsNotExist(err):
return "", nil, text.ErrNoSuchFileOrDirectory
case err != nil:
return "", nil, err
}
fi, err := os.Stat(path)
switch {
case err != nil && os.IsNotExist(err):
return "", nil, text.ErrNoSuchFileOrDirectory
case err != nil:
return "", nil, err
case fi.IsDir():
return "", nil, text.ErrCannotIncludeDirectories
}
f, err := os.OpenFile(path, os.O_RDONLY, 0)
if err != nil {
return "", nil, err
}
return path, f, nil
}
// EditFile edits a file. If path is empty, then a temporary file will be created.
func EditFile(u *user.User, path, line, s string) ([]rune, error) {
ed := All()["EDITOR"]
if ed == "" {
if p, err := exec.LookPath("vi"); err == nil {
ed = p
} else {
return nil, text.ErrNoEditorDefined
}
}
if path != "" {
path = passfile.Expand(u.HomeDir, path)
} else {
f, err := os.CreateTemp("", text.CommandLower()+".*.sql")
if err != nil {
return nil, err
}
err = f.Close()
if err != nil {
return nil, err
}
path = f.Name()
err = os.WriteFile(path, []byte(strings.TrimSuffix(s, "\n")+"\n"), 0o644)
if err != nil {
return nil, err
}
}
// setup args
args := []string{path}
if line != "" {
if s, ok := Getenv(text.CommandUpper() + "_EDITOR_LINENUMBER_ARG"); ok {
args = append(args, s+line)
} else {
args = append(args, "+"+line)
}
}
// create command
c := exec.Command(ed, args...)
c.Stdin = os.Stdin
c.Stdout = os.Stdout
c.Stderr = os.Stderr
// run
if err := c.Run(); err != nil {
return nil, err
}
// read
buf, err := os.ReadFile(path)
if err != nil {
return nil, err
}
return []rune(strings.TrimSuffix(string(buf), "\n")), nil
}
// HistoryFile returns the path to the history file.
//
// Defaults to ~/.<command name>_history, overridden by environment variable
// <COMMAND NAME>_HISTORY (ie, ~/.usql_history and USQL_HISTORY).
func HistoryFile(u *user.User) string {
n := text.CommandUpper() + "_HISTORY"
path := "~/." + strings.ToLower(n)
if s, ok := Getenv(n); ok {
path = s
}
return passfile.Expand(u.HomeDir, path)
}
// RCFile returns the path to the RC file.
//
// Defaults to ~/.<command name>rc, overridden by environment variable
// <COMMAND NAME>RC (ie, ~/.usqlrc and USQLRC).
func RCFile(u *user.User) string {
n := text.CommandUpper() + "RC"
path := "~/." + strings.ToLower(n)
if s, ok := Getenv(n); ok {
path = s
}
return passfile.Expand(u.HomeDir, path)
}
// Getshell returns the user's defined SHELL, or system default (if found on
// path) and the appropriate command-line argument for the returned shell.
//
// Looks at the SHELL environment variable first, and then COMSPEC/ComSpec on
// Windows. Defaults to sh on non-Windows systems, and to cmd.exe on Windows.
func Getshell() (string, string) {
shell, ok := Getenv("SHELL")
param := "-c"
if !ok && runtime.GOOS == "windows" {
shell, _ = Getenv("COMSPEC", "ComSpec")
param = "/c"
}
// look up path for "cmd.exe" if no other SHELL
if shell == "" && runtime.GOOS == "windows" {
shell, _ = exec.LookPath("cmd.exe")
if shell != "" {
param = "/c"
}
}
// lookup path for "sh" if no other SHELL
if shell == "" {
shell, _ = exec.LookPath("sh")
if shell != "" {
param = "-c"
}
}
return shell, param
}
// Shell runs s as a shell. When s is empty the user's SHELL or COMSPEC is
// used. See Getshell.
func Shell(s string) error {
shell, param := Getshell()
if shell == "" {
return text.ErrNoShellAvailable
}
s = strings.TrimSpace(s)
var params []string
if s != "" {
params = append(params, param, s)
}
// drop to shell
cmd := exec.Command(shell, params...)
cmd.Stdin, cmd.Stdout, cmd.Stderr = os.Stdin, os.Stdout, os.Stderr
_ = cmd.Run()
return nil
}
// Pipe starts a command and returns its input for writing.
func Pipe(stdout, stderr io.Writer, c string) (io.WriteCloser, *exec.Cmd, error) {
shell, param := Getshell()
if shell == "" {
return nil, nil, text.ErrNoShellAvailable
}
cmd := exec.Command(shell, param, c)
cmd.Stdout, cmd.Stderr = stdout, stderr
out, err := cmd.StdinPipe()
if err != nil {
return nil, nil, err
}
return out, cmd, cmd.Start()
}
// Exec executes s using the user's SHELL / COMSPEC with -c (or /c) and
// returning the captured output. See Getshell.
//
// When SHELL or COMSPEC is not defined, then "sh" / "cmd.exe" will be used
// instead, assuming it is found on the system's PATH.
func Exec(s string) (string, error) {
s = strings.TrimSpace(s)
if s == "" {
return "", nil
}
shell, param := Getshell()
if shell == "" {
return "", text.ErrNoShellAvailable
}
buf, err := exec.Command(shell, param, s).CombinedOutput()
if err != nil {
return "", err
}
// remove ending \r\n
buf = bytes.TrimSuffix(buf, []byte{'\n'})
buf = bytes.TrimSuffix(buf, []byte{'\r'})
return string(buf), nil
}
var cleanDoubleRE = regexp.MustCompile(`(^|[^\\])''`)
// Dequote unquotes a string.
func Dequote(s string, quote byte) (string, error) {
if len(s) < 2 || s[len(s)-1] != quote {
return "", text.ErrUnterminatedQuotedString
}
s = s[1 : len(s)-1]
if quote == '\'' {
s = cleanDoubleRE.ReplaceAllString(s, "$1\\'")
}
// this is the last part of strconv.Unquote
var runeTmp [utf8.UTFMax]byte
buf := make([]byte, 0, 3*len(s)/2) // Try to avoid more allocations.
for len(s) > 0 {
c, multibyte, ss, err := strconv.UnquoteChar(s, quote)
switch {
case err != nil && err == strconv.ErrSyntax:
return "", text.ErrInvalidQuotedString
case err != nil:
return "", err
}
s = ss
if c < utf8.RuneSelf || !multibyte {
buf = append(buf, byte(c))
} else {
n := utf8.EncodeRune(runeTmp[:], c)
buf = append(buf, runeTmp[:n]...)
}
}
return string(buf), nil
}
// Getvar retrieves an environment variable.
func Getvar(s string, v Vars) (bool, string, error) {
q, n := "", s
if c := s[0]; c == '\'' || c == '"' {
var err error
if n, err = Dequote(s, c); err != nil {
return false, "", err
}
q = string(c)
}
if val, ok := v[n]; ok {
return true, q + val + q, nil
}
return false, s, nil
}
// Unquote returns a func that unquotes strings for the user.
//
// When exec is true, backtick'd strings will be executed using the provided
// user's shell (see Exec).
func Unquote(u *user.User, exec bool, v Vars) func(string, bool) (bool, string, error) {
return func(s string, isvar bool) (bool, string, error) {
// log.Printf(">>> UNQUOTE: %q", s)
if isvar {
return Getvar(s, v)
}
if len(s) < 2 {
return false, "", text.ErrInvalidQuotedString
}
c := s[0]
z, err := Dequote(s, c)
if err != nil {
return false, "", err
}
if c == '\'' || c == '"' {
return true, z, nil
}
if c != '`' {
return false, "", text.ErrInvalidQuotedString
}
if !exec {
return true, z, nil
}
res, err := Exec(z)
if err != nil {
return false, "", err
}
return true, res, nil
}
}
// TermGraphics returns the [rasterm.TermType] based on TERM_GRAPHICS
// environment variable.
func TermGraphics() rasterm.TermType {
var typ rasterm.TermType
_ = typ.UnmarshalText([]byte(Get("TERM_GRAPHICS")))
return typ
}
|