123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315 |
- // Package godotenv is a go port of the ruby dotenv library (https://github.com/bkeepers/dotenv)
- //
- // Examples/readme can be found on the github page at https://github.com/joho/godotenv
- //
- // The TL;DR is that you make a .env file that looks something like
- //
- // SOME_ENV_VAR=somevalue
- //
- // and then in your go code you can call
- //
- // godotenv.Load()
- //
- // and all the env vars declared in .env will be available through os.Getenv("SOME_ENV_VAR")
- package godotenv
-
- import (
- "bufio"
- "errors"
- "fmt"
- "io"
- "os"
- "os/exec"
- "regexp"
- "sort"
- "strings"
- )
-
- const doubleQuoteSpecialChars = "\\\n\r\"!$`"
-
- // Load will read your env file(s) and load them into ENV for this process.
- //
- // Call this function as close as possible to the start of your program (ideally in main)
- //
- // If you call Load without any args it will default to loading .env in the current path
- //
- // You can otherwise tell it which files to load (there can be more than one) like
- //
- // godotenv.Load("fileone", "filetwo")
- //
- // It's important to note that it WILL NOT OVERRIDE an env variable that already exists - consider the .env file to set dev vars or sensible defaults
- func Load(filenames ...string) (err error) {
- filenames = filenamesOrDefault(filenames)
-
- for _, filename := range filenames {
- err = loadFile(filename, false)
- if err != nil {
- return // return early on a spazout
- }
- }
- return
- }
-
- // Overload will read your env file(s) and load them into ENV for this process.
- //
- // Call this function as close as possible to the start of your program (ideally in main)
- //
- // If you call Overload without any args it will default to loading .env in the current path
- //
- // You can otherwise tell it which files to load (there can be more than one) like
- //
- // godotenv.Overload("fileone", "filetwo")
- //
- // It's important to note this WILL OVERRIDE an env variable that already exists - consider the .env file to forcefilly set all vars.
- func Overload(filenames ...string) (err error) {
- filenames = filenamesOrDefault(filenames)
-
- for _, filename := range filenames {
- err = loadFile(filename, true)
- if err != nil {
- return // return early on a spazout
- }
- }
- return
- }
-
- // Read all env (with same file loading semantics as Load) but return values as
- // a map rather than automatically writing values into env
- func Read(filenames ...string) (envMap map[string]string, err error) {
- filenames = filenamesOrDefault(filenames)
- envMap = make(map[string]string)
-
- for _, filename := range filenames {
- individualEnvMap, individualErr := readFile(filename)
-
- if individualErr != nil {
- err = individualErr
- return // return early on a spazout
- }
-
- for key, value := range individualEnvMap {
- envMap[key] = value
- }
- }
-
- return
- }
-
- // Parse reads an env file from io.Reader, returning a map of keys and values.
- func Parse(r io.Reader) (envMap map[string]string, err error) {
- envMap = make(map[string]string)
-
- var lines []string
- scanner := bufio.NewScanner(r)
- for scanner.Scan() {
- lines = append(lines, scanner.Text())
- }
-
- if err = scanner.Err(); err != nil {
- return
- }
-
- for _, fullLine := range lines {
- if !isIgnoredLine(fullLine) {
- var key, value string
- key, value, err = parseLine(fullLine)
-
- if err != nil {
- return
- }
- envMap[key] = value
- }
- }
- return
- }
-
- //Unmarshal reads an env file from a string, returning a map of keys and values.
- func Unmarshal(str string) (envMap map[string]string, err error) {
- return Parse(strings.NewReader(str))
- }
-
- // Exec loads env vars from the specified filenames (empty map falls back to default)
- // then executes the cmd specified.
- //
- // Simply hooks up os.Stdin/err/out to the command and calls Run()
- //
- // If you want more fine grained control over your command it's recommended
- // that you use `Load()` or `Read()` and the `os/exec` package yourself.
- func Exec(filenames []string, cmd string, cmdArgs []string) error {
- Load(filenames...)
-
- command := exec.Command(cmd, cmdArgs...)
- command.Stdin = os.Stdin
- command.Stdout = os.Stdout
- command.Stderr = os.Stderr
- return command.Run()
- }
-
- // Write serializes the given environment and writes it to a file
- func Write(envMap map[string]string, filename string) error {
- content, error := Marshal(envMap)
- if error != nil {
- return error
- }
- file, error := os.Create(filename)
- if error != nil {
- return error
- }
- _, err := file.WriteString(content)
- return err
- }
-
- // Marshal outputs the given environment as a dotenv-formatted environment file.
- // Each line is in the format: KEY="VALUE" where VALUE is backslash-escaped.
- func Marshal(envMap map[string]string) (string, error) {
- lines := make([]string, 0, len(envMap))
- for k, v := range envMap {
- lines = append(lines, fmt.Sprintf(`%s="%s"`, k, doubleQuoteEscape(v)))
- }
- sort.Strings(lines)
- return strings.Join(lines, "\n"), nil
- }
-
- func filenamesOrDefault(filenames []string) []string {
- if len(filenames) == 0 {
- return []string{".env"}
- }
- return filenames
- }
-
- func loadFile(filename string, overload bool) error {
- envMap, err := readFile(filename)
- if err != nil {
- return err
- }
-
- currentEnv := map[string]bool{}
- rawEnv := os.Environ()
- for _, rawEnvLine := range rawEnv {
- key := strings.Split(rawEnvLine, "=")[0]
- currentEnv[key] = true
- }
-
- for key, value := range envMap {
- if !currentEnv[key] || overload {
- os.Setenv(key, value)
- }
- }
-
- return nil
- }
-
- func readFile(filename string) (envMap map[string]string, err error) {
- file, err := os.Open(filename)
- if err != nil {
- return
- }
- defer file.Close()
-
- return Parse(file)
- }
-
- func parseLine(line string) (key string, value string, err error) {
- if len(line) == 0 {
- err = errors.New("zero length string")
- return
- }
-
- // ditch the comments (but keep quoted hashes)
- if strings.Contains(line, "#") {
- segmentsBetweenHashes := strings.Split(line, "#")
- quotesAreOpen := false
- var segmentsToKeep []string
- for _, segment := range segmentsBetweenHashes {
- if strings.Count(segment, "\"") == 1 || strings.Count(segment, "'") == 1 {
- if quotesAreOpen {
- quotesAreOpen = false
- segmentsToKeep = append(segmentsToKeep, segment)
- } else {
- quotesAreOpen = true
- }
- }
-
- if len(segmentsToKeep) == 0 || quotesAreOpen {
- segmentsToKeep = append(segmentsToKeep, segment)
- }
- }
-
- line = strings.Join(segmentsToKeep, "#")
- }
-
- firstEquals := strings.Index(line, "=")
- firstColon := strings.Index(line, ":")
- splitString := strings.SplitN(line, "=", 2)
- if firstColon != -1 && (firstColon < firstEquals || firstEquals == -1) {
- //this is a yaml-style line
- splitString = strings.SplitN(line, ":", 2)
- }
-
- if len(splitString) != 2 {
- err = errors.New("Can't separate key from value")
- return
- }
-
- // Parse the key
- key = splitString[0]
- if strings.HasPrefix(key, "export") {
- key = strings.TrimPrefix(key, "export")
- }
- key = strings.Trim(key, " ")
-
- // Parse the value
- value = parseValue(splitString[1])
- return
- }
-
- func parseValue(value string) string {
-
- // trim
- value = strings.Trim(value, " ")
-
- // check if we've got quoted values or possible escapes
- if len(value) > 1 {
- first := string(value[0:1])
- last := string(value[len(value)-1:])
- if first == last && strings.ContainsAny(first, `"'`) {
- // pull the quotes off the edges
- value = value[1 : len(value)-1]
- // handle escapes
- escapeRegex := regexp.MustCompile(`\\.`)
- value = escapeRegex.ReplaceAllStringFunc(value, func(match string) string {
- c := strings.TrimPrefix(match, `\`)
- switch c {
- case "n":
- return "\n"
- case "r":
- return "\r"
- default:
- return c
- }
- })
- }
- }
-
- return value
- }
-
- func isIgnoredLine(line string) bool {
- trimmedLine := strings.Trim(line, " \n\t")
- return len(trimmedLine) == 0 || strings.HasPrefix(trimmedLine, "#")
- }
-
- func doubleQuoteEscape(line string) string {
- for _, c := range doubleQuoteSpecialChars {
- toReplace := "\\" + string(c)
- if c == '\n' {
- toReplace = `\n`
- }
- if c == '\r' {
- toReplace = `\r`
- }
- line = strings.Replace(line, string(c), toReplace, -1)
- }
- return line
- }
|