|
| 1 | +package logging |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "io" |
| 6 | + "log" |
| 7 | + "os" |
| 8 | + "path/filepath" |
| 9 | + "regexp" |
| 10 | + "strings" |
| 11 | + "text/template" |
| 12 | + "time" |
| 13 | +) |
| 14 | + |
| 15 | +func NewLogger(w io.Writer) *log.Logger { |
| 16 | + return log.New(w, "", log.LstdFlags|log.Lshortfile) |
| 17 | +} |
| 18 | + |
| 19 | +type fileLogger struct { |
| 20 | + l *log.Logger |
| 21 | + f *os.File |
| 22 | +} |
| 23 | + |
| 24 | +func NewFileLogger(rawPath string) (*fileLogger, error) { |
| 25 | + path, err := parseLogPath(rawPath) |
| 26 | + if err != nil { |
| 27 | + return nil, fmt.Errorf("failed to parse path: %w", err) |
| 28 | + } |
| 29 | + |
| 30 | + if !filepath.IsAbs(path) { |
| 31 | + return nil, fmt.Errorf("please provide absolute log path to prevent ambiguity (given: %q)", |
| 32 | + path) |
| 33 | + } |
| 34 | + |
| 35 | + mode := os.O_TRUNC | os.O_CREATE | os.O_WRONLY |
| 36 | + file, err := os.OpenFile(path, mode, 0600) |
| 37 | + if err != nil { |
| 38 | + return nil, err |
| 39 | + } |
| 40 | + |
| 41 | + return &fileLogger{ |
| 42 | + l: NewLogger(file), |
| 43 | + f: file, |
| 44 | + }, nil |
| 45 | +} |
| 46 | + |
| 47 | +func parseLogPath(rawPath string) (string, error) { |
| 48 | + tpl := template.New("log-file") |
| 49 | + tpl = tpl.Funcs(template.FuncMap{ |
| 50 | + "timestamp": time.Now().Local().Unix, |
| 51 | + "pid": os.Getpid, |
| 52 | + "ppid": os.Getppid, |
| 53 | + }) |
| 54 | + tpl, err := tpl.Parse(rawPath) |
| 55 | + if err != nil { |
| 56 | + return "", err |
| 57 | + } |
| 58 | + |
| 59 | + buf := &strings.Builder{} |
| 60 | + err = tpl.Execute(buf, nil) |
| 61 | + if err != nil { |
| 62 | + return "", err |
| 63 | + } |
| 64 | + |
| 65 | + return buf.String(), nil |
| 66 | +} |
| 67 | + |
| 68 | +func ValidateExecLogPath(rawPath string) error { |
| 69 | + _, err := parseExecLogPathTemplate([]string{}, rawPath) |
| 70 | + return err |
| 71 | +} |
| 72 | + |
| 73 | +func ParseExecLogPath(args []string, rawPath string) (string, error) { |
| 74 | + tpl, err := parseExecLogPathTemplate(args, rawPath) |
| 75 | + if err != nil { |
| 76 | + return "", err |
| 77 | + } |
| 78 | + |
| 79 | + buf := &strings.Builder{} |
| 80 | + err = tpl.Execute(buf, nil) |
| 81 | + if err != nil { |
| 82 | + return "", err |
| 83 | + } |
| 84 | + |
| 85 | + return buf.String(), nil |
| 86 | +} |
| 87 | + |
| 88 | +func parseExecLogPathTemplate(args []string, rawPath string) (*template.Template, error) { |
| 89 | + tpl := template.New("tf-log-file") |
| 90 | + tpl = tpl.Funcs(template.FuncMap{ |
| 91 | + "timestamp": time.Now().Local().Unix, |
| 92 | + "lsPid": os.Getpid, |
| 93 | + "lsPpid": os.Getppid, |
| 94 | + "args": func() string { |
| 95 | + return escapeArguments(args) |
| 96 | + }, |
| 97 | + }) |
| 98 | + return tpl.Parse(rawPath) |
| 99 | +} |
| 100 | + |
| 101 | +// escapeArguments turns arguments into a string |
| 102 | +// which is safe to use in a filename without any side-effects |
| 103 | +func escapeArguments(rawArgs []string) string { |
| 104 | + unsafeCharsRe := regexp.MustCompile(`[^a-z-_]+`) |
| 105 | + |
| 106 | + safeArgs := make([]string, len(rawArgs), len(rawArgs)) |
| 107 | + for _, rawArg := range rawArgs { |
| 108 | + // Replace any unsafe character with a hyphen |
| 109 | + safeArg := unsafeCharsRe.ReplaceAllString(rawArg, "-") |
| 110 | + safeArgs = append(safeArgs, safeArg) |
| 111 | + } |
| 112 | + |
| 113 | + args := strings.Join(safeArgs, "-") |
| 114 | + |
| 115 | + // Reduce hyphens to just one |
| 116 | + hyphensRe := regexp.MustCompile(`[-]+`) |
| 117 | + reduced := hyphensRe.ReplaceAllString(args, "-") |
| 118 | + |
| 119 | + // Trim hyphens from both ends |
| 120 | + return strings.Trim(reduced, "-") |
| 121 | +} |
| 122 | + |
| 123 | +func (fl *fileLogger) Logger() *log.Logger { |
| 124 | + return fl.l |
| 125 | +} |
| 126 | + |
| 127 | +func (fl *fileLogger) Close() error { |
| 128 | + return fl.f.Close() |
| 129 | +} |
0 commit comments