Logging compatible with js

This commit is contained in:
Yuriy Glukhov 2016-09-03 21:11:10 +03:00
commit c43a7f3980

View file

@ -47,7 +47,9 @@
## **Warning:** The global list of handlers is a thread var, this means that ## **Warning:** The global list of handlers is a thread var, this means that
## the handlers must be re-added in each thread. ## the handlers must be re-added in each thread.
import strutils, os, times import strutils, times
when not defined(js):
import os
type type
Level* = enum ## logging level Level* = enum ## logging level
@ -77,6 +79,8 @@ type
ConsoleLogger* = ref object of Logger ## logger that writes the messages to the ConsoleLogger* = ref object of Logger ## logger that writes the messages to the
## console ## console
when not defined(js):
type
FileLogger* = ref object of Logger ## logger that writes the messages to a file FileLogger* = ref object of Logger ## logger that writes the messages to a file
file*: File ## the wrapped file. file*: File ## the wrapped file.
@ -90,8 +94,9 @@ type
logFiles: int # how many log files already created, e.g. basename.1, basename.2... logFiles: int # how many log files already created, e.g. basename.1, basename.2...
bufSize: int # size of output buffer (-1: use system defaults, 0: unbuffered, >0: fixed buffer size) bufSize: int # size of output buffer (-1: use system defaults, 0: unbuffered, >0: fixed buffer size)
{.deprecated: [TLevel: Level, PLogger: Logger, PConsoleLogger: ConsoleLogger, {.deprecated: [PFileLogger: FileLogger, PRollingFileLogger: RollingFileLogger].}
PFileLogger: FileLogger, PRollingFileLogger: RollingFileLogger].}
{.deprecated: [TLevel: Level, PLogger: Logger, PConsoleLogger: ConsoleLogger].}
var var
level {.threadvar.}: Level ## global log filter level {.threadvar.}: Level ## global log filter
@ -112,7 +117,7 @@ proc substituteLog*(frmt: string, level: Level, args: varargs[string, `$`]): str
else: else:
inc(i) inc(i)
var v = "" var v = ""
var app = getAppFilename() let app = when defined(js): "" else: getAppFilename()
while frmt[i] in IdentChars: while frmt[i] in IdentChars:
v.add(toLower(frmt[i])) v.add(toLower(frmt[i]))
inc(i) inc(i)
@ -121,8 +126,10 @@ proc substituteLog*(frmt: string, level: Level, args: varargs[string, `$`]): str
of "time": result.add(getClockStr()) of "time": result.add(getClockStr())
of "datetime": result.add(getDateStr() & "T" & getClockStr()) of "datetime": result.add(getDateStr() & "T" & getClockStr())
of "app": result.add(app) of "app": result.add(app)
of "appdir": result.add(app.splitFile.dir) of "appdir":
of "appname": result.add(app.splitFile.name) when not defined(js): result.add(app.splitFile.dir)
of "appname":
when not defined(js): result.add(app.splitFile.name)
of "levelid": result.add(LevelNames[level][0]) of "levelid": result.add(LevelNames[level][0])
of "levelname": result.add(LevelNames[level]) of "levelname": result.add(LevelNames[level])
else: discard else: discard
@ -139,27 +146,33 @@ method log*(logger: Logger, level: Level, args: varargs[string, `$`]) {.
method log*(logger: ConsoleLogger, level: Level, args: varargs[string, `$`]) = method log*(logger: ConsoleLogger, level: Level, args: varargs[string, `$`]) =
## Logs to the console using ``logger`` only. ## Logs to the console using ``logger`` only.
if level >= logging.level and level >= logger.levelThreshold: if level >= logging.level and level >= logger.levelThreshold:
writeLine(stdout, substituteLog(logger.fmtStr, level, args)) let ln = substituteLog(logger.fmtStr, level, args)
when defined(js):
let cln: cstring = ln
{.emit: "console.log(`cln`);".}
else:
writeLine(stdout, ln)
if level in {lvlError, lvlFatal}: flushFile(stdout) if level in {lvlError, lvlFatal}: flushFile(stdout)
method log*(logger: FileLogger, level: Level, args: varargs[string, `$`]) =
## Logs to a file using ``logger`` only.
if level >= logging.level and level >= logger.levelThreshold:
writeLine(logger.file, substituteLog(logger.fmtStr, level, args))
if level in {lvlError, lvlFatal}: flushFile(logger.file)
proc defaultFilename*(): string =
## Returns the default filename for a logger.
var (path, name, _) = splitFile(getAppFilename())
result = changeFileExt(path / name, "log")
proc newConsoleLogger*(levelThreshold = lvlAll, fmtStr = defaultFmtStr): ConsoleLogger = proc newConsoleLogger*(levelThreshold = lvlAll, fmtStr = defaultFmtStr): ConsoleLogger =
## Creates a new console logger. This logger logs to the console. ## Creates a new console logger. This logger logs to the console.
new result new result
result.fmtStr = fmtStr result.fmtStr = fmtStr
result.levelThreshold = levelThreshold result.levelThreshold = levelThreshold
proc newFileLogger*(filename = defaultFilename(), when not defined(js):
method log*(logger: FileLogger, level: Level, args: varargs[string, `$`]) =
## Logs to a file using ``logger`` only.
if level >= logging.level and level >= logger.levelThreshold:
writeLine(logger.file, substituteLog(logger.fmtStr, level, args))
if level in {lvlError, lvlFatal}: flushFile(logger.file)
proc defaultFilename*(): string =
## Returns the default filename for a logger.
var (path, name, _) = splitFile(getAppFilename())
result = changeFileExt(path / name, "log")
proc newFileLogger*(filename = defaultFilename(),
mode: FileMode = fmAppend, mode: FileMode = fmAppend,
levelThreshold = lvlAll, levelThreshold = lvlAll,
fmtStr = defaultFmtStr, fmtStr = defaultFmtStr,
@ -172,14 +185,14 @@ proc newFileLogger*(filename = defaultFilename(),
result.file = open(filename, mode, bufSize = bufSize) result.file = open(filename, mode, bufSize = bufSize)
result.fmtStr = fmtStr result.fmtStr = fmtStr
# ------ # ------
proc countLogLines(logger: RollingFileLogger): int = proc countLogLines(logger: RollingFileLogger): int =
result = 0 result = 0
for line in logger.file.lines(): for line in logger.file.lines():
result.inc() result.inc()
proc countFiles(filename: string): int = proc countFiles(filename: string): int =
# Example: file.log.1 # Example: file.log.1
result = 0 result = 0
let (dir, name, ext) = splitFile(filename) let (dir, name, ext) = splitFile(filename)
@ -194,7 +207,7 @@ proc countFiles(filename: string): int =
result = num result = num
except ValueError: discard except ValueError: discard
proc newRollingFileLogger*(filename = defaultFilename(), proc newRollingFileLogger*(filename = defaultFilename(),
mode: FileMode = fmReadWrite, mode: FileMode = fmReadWrite,
levelThreshold = lvlAll, levelThreshold = lvlAll,
fmtStr = defaultFmtStr, fmtStr = defaultFmtStr,
@ -220,14 +233,14 @@ proc newRollingFileLogger*(filename = defaultFilename(),
# We need to get a line count because we will be appending to the file. # We need to get a line count because we will be appending to the file.
result.curLine = countLogLines(result) result.curLine = countLogLines(result)
proc rotate(logger: RollingFileLogger) = proc rotate(logger: RollingFileLogger) =
let (dir, name, ext) = splitFile(logger.baseName) let (dir, name, ext) = splitFile(logger.baseName)
for i in countdown(logger.logFiles, 0): for i in countdown(logger.logFiles, 0):
let srcSuff = if i != 0: ExtSep & $i else: "" let srcSuff = if i != 0: ExtSep & $i else: ""
moveFile(dir / (name & ext & srcSuff), moveFile(dir / (name & ext & srcSuff),
dir / (name & ext & ExtSep & $(i+1))) dir / (name & ext & ExtSep & $(i+1)))
method log*(logger: RollingFileLogger, level: Level, args: varargs[string, `$`]) = method log*(logger: RollingFileLogger, level: Level, args: varargs[string, `$`]) =
## Logs to a file using rolling ``logger`` only. ## Logs to a file using rolling ``logger`` only.
if level >= logging.level and level >= logger.levelThreshold: if level >= logging.level and level >= logger.levelThreshold:
if logger.curLine >= logger.maxLines: if logger.curLine >= logger.maxLines: