setup.go

// File: "setup.go"

package xlog

import (
	"context"
	"fmt"
	"io/fs"
	"log"
	"log/slog" // go>=1.21
	"os"
	"path"
	"path/filepath"
	"strconv"
	"sync"
	"time"
	//"golang.org/x/exp/slog" // depricated for go>=1.21
)

// Saved loggers, current log level
var (
	defaultLog   *log.Logger  = log.Default()  // initial standtart logger
	defaultSlog  *slog.Logger = slog.Default() // initial structured logger
	currentXlog  Xlog         = Default()      // current global logger
	currentLevel Level        = DEFAULT_LEVEL  // current global log level
	defaultLock  sync.Mutex
)

// Setup standart simple logger
func SetupLog(logger *log.Logger, conf Conf) {
	flag := 0
	if conf.Time {
		flag |= log.LstdFlags
		if conf.TimeUS {
			flag |= log.Lmicroseconds
		}
	}
	if conf.Src {
		if conf.SrcLong {
			flag |= log.Llongfile
		} else {
			flag |= log.Lshortfile
		}
	}
	if conf.Prefix != "" {
		flag |= log.Lmsgprefix
	}

	out := openFile(conf.File, conf.FileMode)
	logger.SetOutput(out)
	logger.SetPrefix(conf.Prefix)
	logger.SetFlags(flag)
}

// Create new configured standart logger
func NewLog(conf Conf) *log.Logger {
	logger := log.New(os.Stdout, "", 0)
	SetupLog(logger, conf)
	return logger
}

// Create new configures structured logger (default/text/JSON/Tinted handler)
func NewSlog(conf Conf) *slog.Logger {
	if !conf.Slog && !conf.JSON && !conf.Tint {
		// Don't use Text/JSON/Tint handler, tune standart logger
		return newSlogStd(conf)
	}

	level := ParseLvl(conf.Level)
	out := openFile(conf.File, conf.FileMode)
	var handler slog.Handler

	if conf.Tint {
		// Use Tinted Handler
		opts := &TintOptions{
			AddSource:   conf.Src,
			SourceLong:  conf.SrcLong,
			Level:       level,
			NoLevel:     conf.NoLevel,
			ReplaceAttr: nil,
			TimeFormat:  conf.TimeTint,
			NoColor:     conf.NoColor,
		}

		if conf.TimeTint == "" {
			if conf.Time {
				opts.TimeFormat = DEFAULT_TIME_FORMAT
				if conf.TimeUS {
					opts.TimeFormat = DEFAULT_TIME_FORMAT_US
				}
			}
		}

		handler = NewTintHandler(out, opts)
	} else {
		// Use Text/JSON handler
		opts := &slog.HandlerOptions{
			AddSource: conf.Src,
			Level:     level,
		}

		if ADD_LEVELS || !conf.Time || conf.Src || !conf.SrcLong || conf.NoLevel {
			opts.ReplaceAttr = func(groups []string, a slog.Attr) slog.Attr {
				switch a.Key {
				case slog.TimeKey:
					if !conf.Time && len(groups) == 0 {
						return slog.Attr{} // remove timestamp from log
					}
					if conf.TimeUS {
						t := a.Value.Any().(time.Time)
						tstr := t.Format(RFC3339Micro)
						return slog.String(slog.TimeKey, tstr)
					} else if conf.JSON { // FIX difference between Text and JSON handler
						t := a.Value.Any().(time.Time)
						tstr := t.Format(RFC3339Milli)
						return slog.String(slog.TimeKey, tstr)
					}
				case slog.SourceKey:
					src := a.Value.Any().(*slog.Source)
					if src.File == "" { // FIX some bug if slog work as standart logger
						return slog.Attr{}
					}
					if conf.SrcLong { // long: directory + file name
						dir, file := filepath.Split(src.File)
						src.File = filepath.Join(filepath.Base(dir), file)
					} else { // short: only file name
						src.File = path.Base(src.File)
					}
					a.Value = slog.AnyValue(src)
				case slog.LevelKey:
					if conf.NoLevel {
						return slog.Attr{} // remove "level=..." etc
					}
					if ADD_LEVELS { // add TRACE/NOTICE/FATAL/PANIC
						level := a.Value.Any().(slog.Level)
						label := Level(level).String()
						return slog.String(slog.LevelKey, label)
					}
				} // switch
				return a
			}
		}

		if conf.JSON {
			handler = slog.NewJSONHandler(out, opts)
		} else {
			handler = slog.NewTextHandler(out, opts)
		}
	}

	logger := slog.New(handler)
	if conf.AddKey != "" && conf.AddValue != "" {
		logger = logger.With(conf.AddKey, conf.AddValue)
	}
	return logger
}

// Setup standart and structured default global loggers
func Setup(conf Conf) {
	// Setup standart logger
	l := logDefault()
	SetupLog(l, conf)

	// Setup structured logger
	s := NewSlog(conf)
	slog.SetDefault(s)

	// Save log level and update global xlog wrapper
	defaultLock.Lock()
	currentLevel = ParseLvl(conf.Level)
	currentXlog = X(s)
	defaultLock.Unlock()

	// Repeat setup standart logger (stop loop forever)
	// TODO: why?
	SetupLog(l, conf)

	// FIXME: TODO
	// В экспериментальном slog есть ошибка:
	// При добавлении хендлера для управления уровнем
	// логирования некорректно выводятся имена файлов (и строк).
	// Что интересно, в Go v1.21 в log/slog всё исправлено.
	// Используя Go до версии 1.21 (например 1.20) при включении
	// управления уровнем логирования при работе slog через slog.defaultHandler
	// в угоду возможности управления уровнями отключаем вывод файлов и строк.
	// Если "golang.org/x/exp/slog" доработают это FIX можно будет убрать.
	if OLD_SLOG_FIX { // "runtime.Version() < go1.21.0"
		if currentLevel != DEFAULT_LEVEL {
			stdlog := logDefault()
			flag := stdlog.Flags()
			flag = flag &^ (log.Lshortfile | log.Llongfile) // sorry...
			stdlog.SetFlags(flag)
		}
	}
}

// Get default standart logger
func logDefault() *log.Logger {
	defaultLock.Lock()
	defer defaultLock.Unlock()
	l := defaultLog
	if l == nil {
		l = log.Default()
		defaultLog = l
	}
	return l
}

// Get default structured logger
func slogDefault() *slog.Logger {
	defaultLock.Lock()
	defer defaultLock.Unlock()
	l := defaultSlog
	if l == nil {
		l = slog.Default()
		defaultSlog = l
	}
	return l
}

// Convert file mode string (oct like "0644") to fs.FileMode
func fileMode(mode string) fs.FileMode {
	if mode == "" {
		mode = FILE_MODE
	}
	perm, err := strconv.ParseInt(mode, 8, 10)
	if err != nil {
		//fmt.Fprintf(os.Stderr, "ERROR: bad logfile mode='%s'; set mode=0%03o\n",
		//	mode, DEFAULT_FILE_MODE)
		return DEFAULT_FILE_MODE
	}
	return fs.FileMode(perm & 0777)
}

// Select (open) log file
func openFile(file, mode string) *os.File {
	switch file {
	case "stdout", "os.Stdout", "":
		return os.Stdout
	case "stderr", "os.Stderr":
		return os.Stderr
	}

	perm := fileMode(mode)
	out, err := os.OpenFile(file, os.O_APPEND|os.O_WRONLY|os.O_CREATE, perm)
	if err != nil {
		fmt.Fprintf(os.Stderr, "ERROR: can't create logfile: %v; use os.Stdout\n", err)
		return os.Stdout
	}

	return out
}

// Create custom structured logger based on default standart logger
func newSlogStd(conf Conf) (logger *slog.Logger) {
	// Setup standart logger
	stdlog := logDefault()
	SetupLog(stdlog, conf)

	level := ParseLvl(conf.Level)
	if level == DEFAULT_LEVEL {
		// Don't change default log level
		logger = slogDefault()
	} else {
		// Hook to direct log level
		handler := slogDefault().Handler() // slog.defaultHandler
		handler = newStdHandler(level, handler)
		logger = slog.New(handler)
	}

	if conf.AddKey != "" && conf.AddValue != "" {
		logger = logger.With(conf.AddKey, conf.AddValue)
	}
	return logger
}

// Help wrapper to direct log level in standart logger mode
type stdHandler struct {
	level   Level
	handler slog.Handler
}

// Create logStdHandler with the given level
func newStdHandler(level Level, h slog.Handler) *stdHandler {
	// Optimization: avoid chains of logStdHandlers
	if sh, ok := h.(*stdHandler); ok {
		h = sh.handler
	}
	return &stdHandler{level, h}
}

// Enabled() implements Enabled() by reporting whether
func (h *stdHandler) Enabled(_ context.Context, level slog.Level) bool {
	return Level(level) >= h.level
}

// Handle() implements Handler.Handle()
func (h *stdHandler) Handle(ctx context.Context, r slog.Record) error {
	return h.handler.Handle(ctx, r)
}

// WithAttrs() implements Handler.WithAttrs()
func (h *stdHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
	//if len(attrs) == 0 {
	//  return h
	//}
	return newStdHandler(h.level, h.handler.WithAttrs(attrs))
}

// WithGroup() implements Handler.WithGroup()
func (h *stdHandler) WithGroup(name string) slog.Handler {
	//if name == "" {
	//  return h
	//}
	return newStdHandler(h.level, h.handler.WithGroup(name))
}

// EOF: "setup.go"