remark42/backend/vendor/github.com/go-pkgz/lgr/logger.go

package lgr

import (
	"fmt"
	"io"
	"os"
	"path"
	"runtime"
	"strings"
	"sync"
	"time"
)

var levels = []string{"DEBUG", "INFO", "WARN", "ERROR", "PANIC", "FATAL"}

// Logger provided simple logger with basic support of levels. Thread safe
type Logger struct {
	stdout, stderr    io.Writer
	dbg               bool
	lock              sync.Mutex
	callerFile        bool
	callerFunc        bool
	callerPkg         bool
	callerSkip        int
	ignoredPkgCallers []string

	now         nowFn
	fatal       panicFn
	levelBraces bool
	msec        bool
}

type nowFn func() time.Time
type panicFn func()

// New makes new leveled logger. Accepts dbg flag turing on info about the caller and allowing DEBUG messages/
// Two writers can be passed optionally - first for out and second for err
func New(options ...Option) *Logger {
	res := Logger{
		now:        time.Now,
		fatal:      func() { os.Exit(1) },
		stdout:     os.Stdout,
		stderr:     os.Stderr,
		callerSkip: 1,
	}
	for _, opt := range options {
		opt(&res)
	}
	return &res
}

// Logf implements L interface to output with printf style.
// Each line prefixed with ts, level and optionally (dbg mode only) by caller info.
// ERROR and FATAL also send the same line to err writer.
// FATAL adds runtime stack and os.exit(1), like panic.
func (l *Logger) Logf(format string, args ...interface{}) {

	// format timestamp with or without msecs
	ts := func() (res string) {
		if l.msec {
			return l.now().Format("2006/01/02 15:04:05.000")
		}
		return l.now().Format("2006/01/02 15:04:05")
	}

	lv, msg := l.extractLevel(fmt.Sprintf(format, args...))
	if lv == "DEBUG" && !l.dbg {
		return
	}
	var bld strings.Builder
	bld.WriteString(ts())
	bld.WriteString(l.formatLevel(lv))
	bld.WriteString(" ")

	if l.callerFile || l.callerFunc || l.callerPkg {
		if pc, file, line, ok := runtime.Caller(l.callerSkip); ok {

			funcName, fileInfo := "", ""

			if l.callerFunc {
				funcNameElems := strings.Split(runtime.FuncForPC(pc).Name(), "/")
				funcName = funcNameElems[len(funcNameElems)-1]
			}

			if l.callerFile {
				fnameElems := strings.Split(file, "/")
				fileInfo = fmt.Sprintf("%s:%d", strings.Join(fnameElems[len(fnameElems)-2:], "/"), line)
				if l.callerFunc {
					fileInfo += " "
				}
			}
			// callerPkg only if no other callers
			if l.callerPkg && !l.callerFile && !l.callerFunc {
				file = l.ignoreCaller(file)
				_, fileInfo = path.Split(path.Dir(file))
				if l.callerFunc {
					fileInfo += " "
				}
			}
			srcFileInfo := fmt.Sprintf("{%s%s} ", fileInfo, funcName)
			bld.WriteString(srcFileInfo)
		}
	}

	bld.WriteString(msg)  //nolint
	bld.WriteString("\n") //nolint

	l.lock.Lock()
	msgb := []byte(bld.String())
	l.stdout.Write(msgb) //nolint

	switch lv {
	case "PANIC", "FATAL":
		l.stderr.Write(msgb)      //nolint
		bld.WriteString("\n")     //nolint
		l.stderr.Write(getDump()) //nolint
		l.fatal()
	case "ERROR":
		l.stderr.Write(msgb) //nolint
	}

	l.lock.Unlock()
}

func (l *Logger) ignoreCaller(p string) string {
	for _, s := range l.ignoredPkgCallers {
		if strings.Contains(p, "/"+s+"/") {
			return strings.Replace(p, "/"+s, "", 1)
		}
	}
	return p
}

func (l *Logger) formatLevel(lv string) string {

	brace := func(b string) string {
		if l.levelBraces {
			return b
		}
		return ""
	}

	if lv == "" {
		return ""
	}

	spaces := ""
	if len(lv) == 4 {
		spaces = " "
	}
	return " " + brace("[") + lv + brace("]") + spaces
}

func (l *Logger) extractLevel(line string) (level, msg string) {
	for _, lv := range levels {
		if strings.HasPrefix(line, lv) {
			return lv, line[len(lv)+1:]
		}
		if strings.HasPrefix(line, "["+lv+"]") {
			return lv, line[len(lv)+3:]
		}
	}
	return "INFO", line
}

// getDump reads runtime stack and returns as a string
func getDump() []byte {
	maxSize := 5 * 1024 * 1024
	stacktrace := make([]byte, maxSize)
	length := runtime.Stack(stacktrace, true)
	if length > maxSize {
		length = maxSize
	}
	return stacktrace[:length]
}

// Option func type
type Option func(l *Logger)

// Out sets out writer
func Out(w io.Writer) Option {
	return func(l *Logger) {
		l.stdout = w
	}
}

// Err sets error writer
func Err(w io.Writer) Option {
	return func(l *Logger) {
		l.stderr = w
	}
}

// Debug turn on dbg mode
func Debug(l *Logger) {
	l.dbg = true
}

// CallerFile adds caller info with file, and line number
func CallerFile(l *Logger) {
	l.callerFile = true
}

// CallerFunc adds caller info with function name
func CallerFunc(l *Logger) {
	l.callerFunc = true
}

// CallerPkg adds caller's package name
func CallerPkg(l *Logger) {
	l.callerPkg = true
}

// CallerIgnore sets packages skipped from logging caller
func CallerIgnore(ignores ...string) Option {
	return func(l *Logger) {
		l.ignoredPkgCallers = ignores
	}
}

// CallerSkip sets how many trace levels to skip.
// by default this value is 1 , i.e. skip logger level only
func CallerSkip(n int) Option {
	return func(l *Logger) {
		l.callerSkip = n
	}
}

// LevelBraces adds [] to level
func LevelBraces(l *Logger) {
	l.levelBraces = true
}

// Msec adds .msec to timestamp
func Msec(l *Logger) {
	l.msec = true
}