2017-10-07 00:16:47 +00:00
|
|
|
// Copyright 2010 The Go Authors. All rights reserved.
|
2012-03-27 23:13:14 +00:00
|
|
|
// Use of this source code is governed by a BSD-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
|
|
|
// General environment variables.
|
|
|
|
|
|
|
|
package os
|
|
|
|
|
2018-12-28 15:30:48 +00:00
|
|
|
import (
|
|
|
|
"internal/testlog"
|
|
|
|
"syscall"
|
|
|
|
)
|
2012-03-27 23:13:14 +00:00
|
|
|
|
|
|
|
// Expand replaces ${var} or $var in the string based on the mapping function.
|
2014-09-21 17:33:12 +00:00
|
|
|
// For example, os.ExpandEnv(s) is equivalent to os.Expand(s, os.Getenv).
|
2012-03-27 23:13:14 +00:00
|
|
|
func Expand(s string, mapping func(string) string) string {
|
|
|
|
buf := make([]byte, 0, 2*len(s))
|
|
|
|
// ${} is all ASCII, so bytes are fine for this operation.
|
|
|
|
i := 0
|
|
|
|
for j := 0; j < len(s); j++ {
|
|
|
|
if s[j] == '$' && j+1 < len(s) {
|
|
|
|
buf = append(buf, s[i:j]...)
|
|
|
|
name, w := getShellName(s[j+1:])
|
|
|
|
buf = append(buf, mapping(name)...)
|
|
|
|
j += w
|
|
|
|
i = j + 1
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return string(buf) + s[i:]
|
|
|
|
}
|
|
|
|
|
|
|
|
// ExpandEnv replaces ${var} or $var in the string according to the values
|
2017-10-07 00:16:47 +00:00
|
|
|
// of the current environment variables. References to undefined
|
2012-03-27 23:13:14 +00:00
|
|
|
// variables are replaced by the empty string.
|
|
|
|
func ExpandEnv(s string) string {
|
|
|
|
return Expand(s, Getenv)
|
|
|
|
}
|
|
|
|
|
2017-04-10 11:32:00 +00:00
|
|
|
// isShellSpecialVar reports whether the character identifies a special
|
2012-03-27 23:13:14 +00:00
|
|
|
// shell variable such as $*.
|
|
|
|
func isShellSpecialVar(c uint8) bool {
|
|
|
|
switch c {
|
2017-10-07 00:16:47 +00:00
|
|
|
case '*', '#', '$', '@', '!', '?', '-', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9':
|
2012-03-27 23:13:14 +00:00
|
|
|
return true
|
|
|
|
}
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
// isAlphaNum reports whether the byte is an ASCII letter, number, or underscore
|
|
|
|
func isAlphaNum(c uint8) bool {
|
|
|
|
return c == '_' || '0' <= c && c <= '9' || 'a' <= c && c <= 'z' || 'A' <= c && c <= 'Z'
|
|
|
|
}
|
|
|
|
|
2017-04-10 11:32:00 +00:00
|
|
|
// getShellName returns the name that begins the string and the number of bytes
|
2017-10-07 00:16:47 +00:00
|
|
|
// consumed to extract it. If the name is enclosed in {}, it's part of a ${}
|
2012-03-27 23:13:14 +00:00
|
|
|
// expansion and two more bytes are needed than the length of the name.
|
|
|
|
func getShellName(s string) (string, int) {
|
|
|
|
switch {
|
|
|
|
case s[0] == '{':
|
|
|
|
if len(s) > 2 && isShellSpecialVar(s[1]) && s[2] == '}' {
|
|
|
|
return s[1:2], 3
|
|
|
|
}
|
|
|
|
// Scan to closing brace
|
|
|
|
for i := 1; i < len(s); i++ {
|
|
|
|
if s[i] == '}' {
|
|
|
|
return s[1:i], i + 1
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return "", 1 // Bad syntax; just eat the brace.
|
|
|
|
case isShellSpecialVar(s[0]):
|
|
|
|
return s[0:1], 1
|
|
|
|
}
|
|
|
|
// Scan alphanumerics.
|
|
|
|
var i int
|
|
|
|
for i = 0; i < len(s) && isAlphaNum(s[i]); i++ {
|
|
|
|
}
|
|
|
|
return s[:i], i
|
|
|
|
}
|
|
|
|
|
|
|
|
// Getenv retrieves the value of the environment variable named by the key.
|
|
|
|
// It returns the value, which will be empty if the variable is not present.
|
2017-10-07 00:16:47 +00:00
|
|
|
// To distinguish between an empty value and an unset value, use LookupEnv.
|
2012-03-27 23:13:14 +00:00
|
|
|
func Getenv(key string) string {
|
2018-12-28 15:30:48 +00:00
|
|
|
testlog.Getenv(key)
|
2012-03-27 23:13:14 +00:00
|
|
|
v, _ := syscall.Getenv(key)
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
|
2017-04-10 11:32:00 +00:00
|
|
|
// LookupEnv retrieves the value of the environment variable named
|
|
|
|
// by the key. If the variable is present in the environment the
|
|
|
|
// value (which may be empty) is returned and the boolean is true.
|
|
|
|
// Otherwise the returned value will be empty and the boolean will
|
|
|
|
// be false.
|
|
|
|
func LookupEnv(key string) (string, bool) {
|
2018-12-28 15:30:48 +00:00
|
|
|
testlog.Getenv(key)
|
2017-04-10 11:32:00 +00:00
|
|
|
return syscall.Getenv(key)
|
|
|
|
}
|
|
|
|
|
2012-03-27 23:13:14 +00:00
|
|
|
// Setenv sets the value of the environment variable named by the key.
|
|
|
|
// It returns an error, if any.
|
|
|
|
func Setenv(key, value string) error {
|
|
|
|
err := syscall.Setenv(key, value)
|
|
|
|
if err != nil {
|
|
|
|
return NewSyscallError("setenv", err)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2015-08-28 15:33:40 +00:00
|
|
|
// Unsetenv unsets a single environment variable.
|
|
|
|
func Unsetenv(key string) error {
|
|
|
|
return syscall.Unsetenv(key)
|
|
|
|
}
|
|
|
|
|
2012-03-27 23:13:14 +00:00
|
|
|
// Clearenv deletes all environment variables.
|
|
|
|
func Clearenv() {
|
|
|
|
syscall.Clearenv()
|
|
|
|
}
|
|
|
|
|
|
|
|
// Environ returns a copy of strings representing the environment,
|
|
|
|
// in the form "key=value".
|
|
|
|
func Environ() []string {
|
|
|
|
return syscall.Environ()
|
|
|
|
}
|