/* * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /*jsl:option explicit*/ /** * @fileoverview log4js is a library to log in JavaScript in similar manner * than in log4j for Java. The API should be nearly the same. * * This file contains all log4js code and is the only file required for logging. * *

Example:

*
 *  var logging = require('log4js-node')();
 *  //add an appender that logs all messages to stdout.
 *  logging.addAppender(logging.consoleAppender());
 *  //add an appender that logs "some-category" to a file
 *  logging.addAppender(logging.fileAppender("file.log"), "some-category");
 *  //get a logger
 *  var log = logging.getLogger("some-category"); 
 *  log.setLevel(logging.levels.TRACE); //set the Level
 * 
 *  ...
 * 
 *  //call the log
 *  log.trace("trace me" );
 * 
* * @version 1.0 * @author Stephan Strittmatter - http://jroller.com/page/stritti * @author Seth Chisamore - http://www.chisamore.com * @since 2005-05-20 * @static * Website: http://log4js.berlios.de */ module.exports = function (fileSystem, standardOutput, configPaths) { var fs = fileSystem || require('fs'), standardOutput = standardOutput || console.log, configPaths = configPaths || require.paths, sys = require('sys'), events = require('events'), path = require('path'), DEFAULT_CATEGORY = '[default]', ALL_CATEGORIES = '[all]', loggers = {}, appenders = {}, levels = { ALL: new Level(Number.MIN_VALUE, "ALL"), TRACE: new Level(5000, "TRACE"), DEBUG: new Level(10000, "DEBUG"), INFO: new Level(20000, "INFO"), WARN: new Level(30000, "WARN"), ERROR: new Level(40000, "ERROR"), FATAL: new Level(50000, "FATAL"), OFF: new Level(Number.MAX_VALUE, "OFF") }, appenderMakers = { "file": function(config) { var layout; if (config.layout) { layout = layoutMakers[config.layout.type](config.layout); } return fileAppender(config.filename, layout); }, "console": function(config) { var layout; if (config.layout) { layout = layoutMakers[config.layout.type](config.layout); } return consoleAppender(layout); }, "logLevelFilter": function(config) { var appender = appenderMakers[config.appender.type](config.appender); return logLevelFilter(config.level, appender); } }, layoutMakers = { "messagePassThrough": function() { return messagePassThroughLayout; }, "basic": function() { return basicLayout; }, "pattern": function (config) { var pattern = config.pattern || undefined; return patternLayout(pattern); } }; /** * Get a logger instance. Instance is cached on categoryName level. * @param {String} categoryName name of category to log to. * @return {Logger} instance of logger for the category * @static */ function getLogger (categoryName) { // Use default logger if categoryName is not specified or invalid if (!(typeof categoryName == "string")) { categoryName = DEFAULT_CATEGORY; } var appenderList; if (!loggers[categoryName]) { // Create the logger for this name if it doesn't already exist loggers[categoryName] = new Logger(categoryName); if (appenders[categoryName]) { appenderList = appenders[categoryName]; appenderList.forEach(function(appender) { loggers[categoryName].addListener("log", appender); }); } if (appenders[ALL_CATEGORIES]) { appenderList = appenders[ALL_CATEGORIES]; appenderList.forEach(function(appender) { loggers[categoryName].addListener("log", appender); }); } } return loggers[categoryName]; } /** * args are appender, then zero or more categories */ function addAppender () { var args = Array.prototype.slice.call(arguments); var appender = args.shift(); if (args.length == 0 || args[0] === undefined) { args = [ ALL_CATEGORIES ]; } //argument may already be an array if (args[0].forEach) { args = args[0]; } args.forEach(function(category) { if (!appenders[category]) { appenders[category] = []; } appenders[category].push(appender); if (category === ALL_CATEGORIES) { for (var logger in loggers) { if (loggers.hasOwnProperty(logger)) { loggers[logger].addListener("log", appender); } } } else if (loggers[category]) { loggers[category].addListener("log", appender); } }); } function clearAppenders () { appenders = []; for (var logger in loggers) { if (loggers.hasOwnProperty(logger)) { loggers[logger].removeAllListeners("log"); } } } function configure (configurationFile) { if (configurationFile) { try { var config = JSON.parse(fs.readFileSync(configurationFile, "utf8")); configureAppenders(config.appenders); configureLevels(config.levels); } catch (e) { throw new Error("Problem reading log4js config file " + configurationFile + ". Error was " + e.message); } } } function findConfiguration() { //add current directory onto the list of configPaths var paths = ['.'].concat(configPaths); //add this module's directory to the end of the list, so that we pick up the default config paths.push(__dirname); var pathsWithConfig = paths.filter( function (pathToCheck) { try { fs.statSync(path.join(pathToCheck, "log4js.json")); return true; } catch (e) { return false; } }); if (pathsWithConfig.length > 0) { return path.join(pathsWithConfig[0], 'log4js.json'); } return undefined; } function configureAppenders(appenderList) { clearAppenders(); if (appenderList) { appenderList.forEach(function(appenderConfig) { var appender = appenderMakers[appenderConfig.type](appenderConfig); if (appender) { addAppender(appender, appenderConfig.category); } else { throw new Error("log4js configuration problem for "+sys.inspect(appenderConfig)); } }); } else { addAppender(consoleAppender); } } function configureLevels(levels) { if (levels) { for (var category in levels) { if (levels.hasOwnProperty(category)) { getLogger(category).setLevel(levels[category]); } } } } function Level(level, levelStr) { this.level = level; this.levelStr = levelStr; } /** * converts given String to corresponding Level * @param {String} sArg String value of Level * @param {Log4js.Level} defaultLevel default Level, if no String representation * @return Level object * @type Log4js.Level */ Level.toLevel = function(sArg, defaultLevel) { if (sArg === null) { return defaultLevel; } if (typeof sArg == "string") { var s = sArg.toUpperCase(); if (levels[s]) { return levels[s]; } } return defaultLevel; }; Level.prototype.toString = function() { return this.levelStr; }; Level.prototype.isLessThanOrEqualTo = function(otherLevel) { return this.level <= otherLevel.level; }; Level.prototype.isGreaterThanOrEqualTo = function(otherLevel) { return this.level >= otherLevel.level; }; /** * Models a logging event. * @constructor * @param {String} categoryName name of category * @param {Log4js.Level} level level of message * @param {String} message message to log * @param {Log4js.Logger} logger the associated logger * @author Seth Chisamore */ function LoggingEvent (categoryName, level, message, exception, logger) { this.startTime = new Date(); this.categoryName = categoryName; this.message = message; this.exception = exception; this.level = level; this.logger = logger; } /** * Logger to log messages. * use {@see Log4js#getLogger(String)} to get an instance. * @constructor * @param name name of category to log to * @author Stephan Strittmatter */ function Logger (name, level) { this.category = name || DEFAULT_CATEGORY; this.level = Level.toLevel(level, levels.TRACE); } sys.inherits(Logger, events.EventEmitter); Logger.prototype.setLevel = function(level) { this.level = Level.toLevel(level, levels.TRACE); }; Logger.prototype.log = function(logLevel, message, exception) { var loggingEvent = new LoggingEvent(this.category, logLevel, message, exception, this); this.emit("log", loggingEvent); }; Logger.prototype.isLevelEnabled = function(otherLevel) { return this.level.isLessThanOrEqualTo(otherLevel); }; ['Trace','Debug','Info','Warn','Error','Fatal'].forEach( function(levelString) { var level = Level.toLevel(levelString); Logger.prototype['is'+levelString+'Enabled'] = function() { return this.isLevelEnabled(level); }; Logger.prototype[levelString.toLowerCase()] = function (message, exception) { if (this.isLevelEnabled(level)) { this.log(level, message, exception); } }; } ); /** * Get the default logger instance. * @return {Logger} instance of default logger * @static */ function getDefaultLogger () { return getLogger(DEFAULT_CATEGORY); } function consoleAppender (layout) { layout = layout || basicLayout; return function(loggingEvent) { standardOutput(layout(loggingEvent)); }; } /** * File Appender writing the logs to a text file. * * @param file file log messages will be written to * @param layout a function that takes a logevent and returns a string (defaults to basicLayout). */ function fileAppender (file, layout) { layout = layout || basicLayout; //syncs are generally bad, but we need //the file to be open before we start doing any writing. var logFile = fs.openSync(file, 'a', 0644); return function(loggingEvent) { fs.write(logFile, layout(loggingEvent)+'\n', null, "utf8"); }; } function logLevelFilter (levelString, appender) { var level = Level.toLevel(levelString); return function(logEvent) { if (logEvent.level.isGreaterThanOrEqualTo(level)) { appender(logEvent); } } } /** * BasicLayout is a simple layout for storing the logs. The logs are stored * in following format: *
     * [startTime] [logLevel] categoryName - message\n
     * 
* * @author Stephan Strittmatter */ function basicLayout (loggingEvent) { var timestampLevelAndCategory = '[' + loggingEvent.startTime.toFormattedString() + '] '; timestampLevelAndCategory += '[' + loggingEvent.level.toString() + '] '; timestampLevelAndCategory += loggingEvent.categoryName + ' - '; var output = timestampLevelAndCategory + loggingEvent.message; if (loggingEvent.exception) { output += '\n' output += timestampLevelAndCategory; if (loggingEvent.exception.stack) { output += loggingEvent.exception.stack; } else { output += loggingEvent.exception.name + ': '+loggingEvent.exception.message; } } return output; } function messagePassThroughLayout (loggingEvent) { return loggingEvent.message; } /** * PatternLayout * Takes a pattern string and returns a layout function. * @author Stephan Strittmatter */ function patternLayout (pattern) { var TTCC_CONVERSION_PATTERN = "%r %p %c - %m%n"; var regex = /%(-?[0-9]+)?(\.?[0-9]+)?([cdmnpr%])(\{([^\}]+)\})?|([^%]+)/; pattern = pattern || patternLayout.TTCC_CONVERSION_PATTERN; return function(loggingEvent) { var formattedString = ""; var result; var searchString = this.pattern; while ((result = regex.exec(searchString))) { var matchedString = result[0]; var padding = result[1]; var truncation = result[2]; var conversionCharacter = result[3]; var specifier = result[5]; var text = result[6]; // Check if the pattern matched was just normal text if (text) { formattedString += "" + text; } else { // Create a raw replacement string based on the conversion // character and specifier var replacement = ""; switch(conversionCharacter) { case "c": var loggerName = loggingEvent.categoryName; if (specifier) { var precision = parseInt(specifier, 10); var loggerNameBits = loggingEvent.categoryName.split("."); if (precision >= loggerNameBits.length) { replacement = loggerName; } else { replacement = loggerNameBits.slice(loggerNameBits.length - precision).join("."); } } else { replacement = loggerName; } break; case "d": var dateFormat = Date.ISO8601_FORMAT; if (specifier) { dateFormat = specifier; // Pick up special cases if (dateFormat == "ISO8601") { dateFormat = Date.ISO8601_FORMAT; } else if (dateFormat == "ABSOLUTE") { dateFormat = Date.ABSOLUTETIME_FORMAT; } else if (dateFormat == "DATE") { dateFormat = Date.DATETIME_FORMAT; } } // Format the date replacement = loggingEvent.startTime.toFormattedString(dateFormat); break; case "m": replacement = loggingEvent.message; break; case "n": replacement = "\n"; break; case "p": replacement = loggingEvent.level.toString(); break; case "r": replacement = "" + loggingEvent.startTime.toLocaleTimeString(); break; case "%": replacement = "%"; break; default: replacement = matchedString; break; } // Format the replacement according to any padding or // truncation specified var len; // First, truncation if (truncation) { len = parseInt(truncation.substr(1), 10); replacement = replacement.substring(0, len); } // Next, padding if (padding) { if (padding.charAt(0) == "-") { len = parseInt(padding.substr(1), 10); // Right pad with spaces while (replacement.length < len) { replacement += " "; } } else { len = parseInt(padding, 10); // Left pad with spaces while (replacement.length < len) { replacement = " " + replacement; } } } formattedString += replacement; } searchString = searchString.substr(result.index + result[0].length); } return formattedString; }; }; //set ourselves up if we can find a default log4js.json configure(findConfiguration()); return { getLogger: getLogger, getDefaultLogger: getDefaultLogger, addAppender: addAppender, clearAppenders: clearAppenders, configure: configure, levels: levels, consoleAppender: consoleAppender, fileAppender: fileAppender, logLevelFilter: logLevelFilter, basicLayout: basicLayout, messagePassThroughLayout: messagePassThroughLayout, patternLayout: patternLayout }; } Date.ISO8601_FORMAT = "yyyy-MM-dd hh:mm:ss.SSS"; Date.ISO8601_WITH_TZ_OFFSET_FORMAT = "yyyy-MM-ddThh:mm:ssO"; Date.DATETIME_FORMAT = "dd MMM YYYY hh:mm:ss.SSS"; Date.ABSOLUTETIME_FORMAT = "hh:mm:ss.SSS"; Date.prototype.toFormattedString = function(format) { format = format || Date.ISO8601_FORMAT; var vDay = addZero(this.getDate()); var vMonth = addZero(this.getMonth()+1); var vYearLong = addZero(this.getFullYear()); var vYearShort = addZero(this.getFullYear().toString().substring(3,4)); var vYear = (format.indexOf("yyyy") > -1 ? vYearLong : vYearShort); var vHour = addZero(this.getHours()); var vMinute = addZero(this.getMinutes()); var vSecond = addZero(this.getSeconds()); var vMillisecond = padWithZeros(this.getMilliseconds(), 3); var vTimeZone = offset(this); var formatted = format .replace(/dd/g, vDay) .replace(/MM/g, vMonth) .replace(/y{1,4}/g, vYear) .replace(/hh/g, vHour) .replace(/mm/g, vMinute) .replace(/ss/g, vSecond) .replace(/SSS/g, vMillisecond) .replace(/O/g, vTimeZone); return formatted; function padWithZeros(vNumber, width) { var numAsString = vNumber + ""; while (numAsString.length < width) { numAsString = "0" + numAsString; } return numAsString; } function addZero(vNumber) { return padWithZeros(vNumber, 2); } /** * Formats the TimeOffest * Thanks to http://www.svendtofte.com/code/date_format/ * @private */ function offset(date) { // Difference to Greenwich time (GMT) in hours var os = Math.abs(date.getTimezoneOffset()); var h = String(Math.floor(os/60)); var m = String(os%60); h.length == 1? h = "0"+h:1; m.length == 1? m = "0"+m:1; return date.getTimezoneOffset() < 0 ? "+"+h+m : "-"+h+m; } };