Merge pull request #257 from thelounge/xpaw/console-log

Add global logging helper

.eslintrc.yml

@@ -30,6 +30,7 @@ rules:
   spaced-comment: [2, always]
 
 globals:
+  log: false
   $: false
   Favico: false
   Handlebars: false

package.json

@@ -29,6 +29,7 @@
   "dependencies": {
     "bcrypt-nodejs": "0.0.3",
     "cheerio": "0.20.0",
+    "colors": "1.1.2",
     "commander": "2.9.0",
     "event-stream": "3.3.2",
     "express": "4.13.4",

src/client.js

@@ -1,7 +1,7 @@
 var _ = require("lodash");
 var Chan = require("./models/chan");
 var crypto = require("crypto");
-var log = require("./log");
+var userLog = require("./userLog");
 var Msg = require("./models/msg");
 var Network = require("./models/network");
 var ircFramework = require("irc-framework");
@@ -75,6 +75,8 @@ function Client(manager, name, config) {
 			delay += 1000;
 		});
 	}
+
+	log.info("User '" + name + "' loaded");
 }
 
 Client.prototype.emit = function(event, data) {
@@ -90,7 +92,7 @@ Client.prototype.emit = function(event, data) {
 				if (target.chan.type === Chan.Type.LOBBY) {
 					chan = target.network.host;
 				}
-				log.write(
+				userLog.write(
 					this.name,
 					target.network.host,
 					chan,

src/clientManager.js

@@ -31,7 +31,7 @@ ClientManager.prototype.loadUser = function(name) {
 	try {
 		var json = this.readUserConfig(name);
 	} catch (e) {
-		console.log(e);
+		log.error("Failed to read user config", e);
 		return;
 	}
 	if (!this.findClient(name)) {
@@ -40,9 +40,6 @@ ClientManager.prototype.loadUser = function(name) {
 			name,
 			json
 		));
-		console.log(
-			"User '" + name + "' loaded."
-		);
 	}
 };
 
@@ -58,7 +55,7 @@ ClientManager.prototype.getUsers = function() {
 			}
 		});
 	} catch (e) {
-		console.log(e);
+		log.error("Failed to get users", e);
 		return;
 	}
 	return users;
@@ -107,7 +104,7 @@ ClientManager.prototype.updateUser = function(name, opts) {
 			JSON.stringify(user, null, " ")
 		);
 	} catch (e) {
-		console.log(e);
+		log.error("Failed to update user", e);
 		return;
 	}
 	return true;
@@ -160,9 +157,7 @@ ClientManager.prototype.autoload = function(/* sockets */) {
 			if (client) {
 				client.quit();
 				self.clients = _.without(self.clients, client);
-				console.log(
+				log.info("User '" + name + "' disconnected");
-					"User '" + name + "' disconnected."
-				);
 			}
 		});
 	}, 1000);

src/command-line/add.js

@@ -13,10 +13,8 @@ program
 		try {
 			mkdirp.sync(path);
 		} catch (e) {
-			console.log("");
+			log.error("Could not create", path);
-			console.log("Could not create " + path);
+			log.info("Try running the command as sudo.");
-			console.log("Try running the command as sudo.");
-			console.log("");
 			return;
 		}
 		try {
@@ -24,18 +22,14 @@ program
 			fs.mkdirSync(test);
 			fs.rmdirSync(test);
 		} catch (e) {
-			console.log("");
+			log.error("You have no permissions to write to", path);
-			console.log("You have no permissions to write to " + path);
+			log.info("Try running the command as sudo.");
-			console.log("Try running the command as sudo.");
-			console.log("");
 			return;
 		}
 		var manager = new ClientManager();
 		var users = manager.getUsers();
 		if (users.indexOf(name) !== -1) {
-			console.log("");
+			log.error("User '" + name + "' already exists.");
-			console.log("User '" + name + "' already exists.");
-			console.log("");
 			return;
 		}
 		require("read")({
@@ -47,14 +41,12 @@ program
 	});
 
 function add(manager, name, password) {
-	console.log("");
 	var salt = bcrypt.genSaltSync(8);
 	var hash = bcrypt.hashSync(password, salt);
 	manager.addUser(
 		name,
 		hash
 	);
-	console.log("User '" + name + "' created:");
+	log.info("User '" + name + "' created:");
-	console.log(Helper.HOME + "/users/" + name + ".json");
+	log.info(Helper.HOME + "/users/" + name + ".json");
-	console.log("");
 }

src/command-line/edit.js

@@ -9,9 +9,7 @@ program
 	.action(function(name) {
 		var users = new ClientManager().getUsers();
 		if (users.indexOf(name) === -1) {
-			console.log("");
+			log.error("User '" + name + "' doesn't exist.");
-			console.log("User '" + name + "' doesn't exist.");
-			console.log("");
 			return;
 		}
 		child.spawn(

src/command-line/index.js

@@ -1,3 +1,5 @@
+GLOBAL.log = require("../log.js");
+
 var program = require("commander");
 var pkg = require("../../package.json");
 var fs = require("fs");
@@ -20,8 +22,7 @@ if (!fs.existsSync(config)) {
 		config,
 		fs.readFileSync(__dirname + "/../../defaults/config.js")
 	);
-	console.log("Config created:");
+	log.info("Config created:", config);
-	console.log(config);
 }
 
 require("./start");

src/command-line/list.js

@@ -7,15 +7,11 @@ program
 	.action(function() {
 		var users = new ClientManager().getUsers();
 		if (!users.length) {
-			console.log("");
+			log.warn("No users found!");
-			console.log("No users found!");
-			console.log("");
 		} else {
-			console.log("");
 			console.log("Users:");
 			for (var i = 0; i < users.length; i++) {
 				console.log("  " + (i + 1) + ". " + users[i]);
 			}
-			console.log("");
 		}
 	});

src/command-line/remove.js

@@ -13,20 +13,14 @@ program
 			fs.mkdirSync(test);
 			fs.rmdirSync(test);
 		} catch (e) {
-			console.log("");
+			log.warn("You have no permissions to delete from " + path);
-			console.log("You have no permissions to delete from " + path);
+			log.info("Try running the command as sudo.");
-			console.log("Try running the command as sudo.");
-			console.log("");
 			return;
 		}
 		var manager = new ClientManager();
 		if (manager.removeUser(name)) {
-			console.log("");
+			log.info("Removed user '" + name + "'.");
-			console.log("Removed '" + name + "'.");
-			console.log("");
 		} else {
-			console.log("");
+			log.error("User '" + name + "' doesn't exist.");
-			console.log("User '" + name + "' doesn't exist.");
-			console.log("");
 		}
 	});

src/command-line/reset.js

@@ -10,9 +10,7 @@ program
 	.action(function(name) {
 		var users = new ClientManager().getUsers();
 		if (users.indexOf(name) === -1) {
-			console.log("");
+			log.error("User '" + name + "' doesn't exist.");
-			console.log("User '" + name + "' doesn't exist.");
-			console.log("");
 			return;
 		}
 		var file = Helper.HOME + "/users/" + name + ".json";
@@ -21,7 +19,6 @@ program
 			prompt: "[thelounge] New password: ",
 			silent: true
 		}, function(err, password) {
-			console.log("");
 			if (err) {
 				return;
 			}
@@ -32,7 +29,6 @@ program
 				file,
 				JSON.stringify(user, null, "  ")
 			);
-			console.log("Successfully reset password for '" + name + "'.");
+			log.info("Successfully reset password for '" + name + "'.");
-			console.log("");
 		});
 	});

src/command-line/start.js

@@ -21,10 +21,8 @@ program
 			mode = false;
 		}
 		if (!mode && !users.length) {
-			console.log("");
+			log.warn("No users found!");
-			console.log("No users found!");
+			log.info("Create a new user with 'lounge add <name>'.");
-			console.log("Create a new user with 'lounge add <name>'.");
-			console.log("");
 		} else {
 			server({
 				host: program.host || process.env.IP   || config.host,

src/identd.js

@@ -4,7 +4,9 @@ var net = require("net");
 var users = {};
 
 module.exports.start = function(port) {
-	net.createServer(init).listen(port || 113);
+	port = port || 113;
+	log.info("Starting identd server on port", port);
+	net.createServer(init).listen(port);
 };
 
 module.exports.hook = function(stream, user) {
@@ -44,4 +46,3 @@ function parse(data) {
 	data = data.split(",");
 	return parseInt(data[0]) + ", " + parseInt(data[1]);
 }
-

src/log.js

@@ -1,47 +1,31 @@
-var fs = require("fs");
+var colors = require("colors/safe");
-var mkdirp = require("mkdirp");
 var moment = require("moment");
 var Helper = require("./helper");
 
-module.exports.write = function(user, network, chan, msg) {
+function timestamp(type, messageArgs) {
-	try {
-		var path = Helper.HOME + "/logs/" + user + "/" + network;
-		mkdirp.sync(path);
-	} catch (e) {
-		console.log(e);
-		return;
-	}
-
 	var config = Helper.getConfig();
 	var format = (config.logs || {}).format || "YYYY-MM-DD HH:mm:ss";
 	var tz = (config.logs || {}).timezone || "UTC+00:00";
 
 	var time = moment().utcOffset(tz).format(format);
-	var line = "[" + time + "] ";
 
-	var type = msg.type.trim();
+	Array.prototype.unshift.call(messageArgs, colors.dim(time), type);
-	if (type === "message" || type === "highlight") {
-		// Format:
-		// [2014-01-01 00:00:00] <Arnold> Put that cookie down.. Now!!
-		line += "<" + msg.from + "> " + msg.text;
-	} else {
-		// Format:
-		// [2014-01-01 00:00:00] * Arnold quit
-		line += "* " + msg.from + " " + msg.type;
-		if (msg.text) {
-			line += " " + msg.text;
-		}
-	}
 
-	fs.appendFile(
+	return messageArgs;
-		// Quick fix to escape pre-escape channel names that contain % using %%,
+}
-		// and / using %. **This does not escape all reserved words**
+
-		path + "/" + chan.replace(/%/g, "%%").replace(/\//g, "%") + ".log",
+exports.err = function() {
-		line + "\n",
+	console.error.apply(console, timestamp(colors.red("[ERROR]"), arguments));
-		function(e) {
+};
-			if (e) {
+
-				console.log("Log#write():\n" + e);
+exports.warn = function() {
-			}
+	console.error.apply(console, timestamp(colors.yellow("[WARN]"), arguments));
-		}
+};
-	);
+
+exports.info = function() {
+	console.log.apply(console, timestamp(colors.blue("[INFO]"), arguments));
+};
+
+exports.debug = function() {
+	console.log.apply(console, timestamp(colors.green("[DEBUG]"), arguments));
 };

src/plugins/irc-events/connection.js

@@ -26,7 +26,7 @@ module.exports = function(irc, network) {
 	});
 
 	irc.on("socket error", function(err) {
-		console.log(err);
+		log.debug("IRC socket error", err);
 		network.channels[0].pushMessage(client, new Msg({
 			type: Msg.Type.ERROR,
 			text: "Socket error: " + err

src/plugins/irc-events/error.js

@@ -5,12 +5,12 @@ module.exports = function(irc, network) {
 
 	// TODO: remove later
 	irc.on("irc_error", function(data) {
-		console.log("Got an irc_error");
+		log.debug("Got an irc_error");
 		irc.emit("error", data);
 	});
 
 	irc.on("error", function(data) {
-		console.log("error", data);
+		log.debug("error", data);
 		var text = data.error;
 		if (data.reason) {
 			text = data.reason + " (" + text + ")";

src/server.js

@@ -56,10 +56,8 @@ module.exports = function(options) {
 
 	manager.sockets = sockets;
 
-	console.log("");
+	log.info("The Lounge is now running on", protocol + "://" + config.host + ":" + config.port + "/");
-	console.log("The Lounge is now running on " + protocol + "://" + config.host + ":" + config.port + "/");
+	log.info("Press ctrl-c to stop");
-	console.log("Press ctrl-c to stop");
-	console.log("");
 
 	if (!config.public) {
 		manager.loadUsers();

src/userLog.js

@@ -0,0 +1,45 @@
+var fs = require("fs");
+var mkdirp = require("mkdirp");
+var moment = require("moment");
+var Helper = require("./helper");
+
+module.exports.write = function(user, network, chan, msg) {
+	try {
+		var path = Helper.HOME + "/logs/" + user + "/" + network;
+		mkdirp.sync(path);
+	} catch (e) {
+		log.error("Unabled to create logs directory", e);
+		return;
+	}
+
+	var config = Helper.getConfig();
+	var format = (config.logs || {}).format || "YYYY-MM-DD HH:mm:ss";
+	var tz = (config.logs || {}).timezone || "UTC+00:00";
+
+	var time = moment().utcOffset(tz).format(format);
+	var line = "[" + time + "] ";
+
+	var type = msg.type.trim();
+	if (type === "message" || type === "highlight") {
+		// Format:
+		// [2014-01-01 00:00:00] <Arnold> Put that cookie down.. Now!!
+		line += "<" + msg.from + "> " + msg.text;
+	} else {
+		// Format:
+		// [2014-01-01 00:00:00] * Arnold quit
+		line += "* " + msg.from + " " + msg.type;
+		if (msg.text) {
+			line += " " + msg.text;
+		}
+	}
+
+	fs.appendFile(
+		// Quick fix to escape pre-escape channel names that contain % using %%,
+		// and / using %. **This does not escape all reserved words**
+		path + "/" + chan.replace(/%/g, "%%").replace(/\//g, "%") + ".log",
+		line + "\n",
+		function(e) {
+			log.error("Failed to write user log", e);
+		}
+	);
+};