Support hiding certain logs (e.g. ones containing passwords).

earwigbot/commands/__init__.py

@@ -63,14 +63,15 @@ class Command(object):
         self.logger = bot.commands.logger.getChild(self.name)
 
         # Convenience functions:
-        self.say = lambda target, msg: self.bot.frontend.say(target, msg)
-        self.reply = lambda data, msg: self.bot.frontend.reply(data, msg)
-        self.action = lambda target, msg: self.bot.frontend.action(target, msg)
-        self.notice = lambda target, msg: self.bot.frontend.notice(target, msg)
-        self.join = lambda chan: self.bot.frontend.join(chan)
-        self.part = lambda chan, msg=None: self.bot.frontend.part(chan, msg)
-        self.mode = lambda t, level, msg: self.bot.frontend.mode(t, level, msg)
-        self.pong = lambda target: self.bot.frontend.pong(target)
+        self.say = lambda target, msg, hidelog=False: self.bot.frontend.say(target, msg, hidelog)
+        self.reply = lambda data, msg, hidelog=False: self.bot.frontend.reply(data, msg, hidelog)
+        self.action = lambda target, msg, hidelog=False: self.bot.frontend.action(target, msg, hidelog)
+        self.notice = lambda target, msg, hidelog=False: self.bot.frontend.notice(target, msg, hidelog)
+        self.join = lambda chan, hidelog=False: self.bot.frontend.join(chan, hidelog)
+        self.part = lambda chan, msg=None, hidelog=False: self.bot.frontend.part(chan, msg, hidelog)
+        self.mode = lambda t, level, msg, hidelog=False: self.bot.frontend.mode(t, level, msg, hidelog)
+        self.ping = lambda target, hidelog=False: self.bot.frontend.ping(target, hidelog)
+        self.pong = lambda target, hidelog=False: self.bot.frontend.pong(target, hidelog)
 
         self.setup()
 

earwigbot/commands/threads.py

@@ -88,7 +88,10 @@ class Threads(Command):
                                                start_time))
 
         if daemon_threads:
-            msg = "\x02{0}\x0F threads active: {1}, and \x02{2}\x0F command/task threads: {3}."
+            if len(daemon_threads) > 1:
+                msg = "\x02{0}\x0F threads active: {1}, and \x02{2}\x0F command/task threads: {3}."
+            else:
+                msg = "\x02{0}\x0F threads active: {1}, and \x02{2}\x0F command/task thread: {3}."
             msg = msg.format(len(threads), ', '.join(normal_threads),
                              len(daemon_threads), ', '.join(daemon_threads))
         else:

earwigbot/irc/connection.py

@@ -72,7 +72,7 @@ class IRCConnection(object):
             raise BrokenSocketError()
         return data
 
-    def _send(self, msg):
+    def _send(self, msg, hidelog=False):
         """Send data to the server."""
         with self._send_lock:
             try:
@@ -80,7 +80,8 @@ class IRCConnection(object):
             except socket.error:
                 self._is_running = False
             else:
-                self.logger.debug(msg)
+                if not hidelog:
+                    self.logger.debug(msg)
 
     def _quit(self, msg=None):
         """Issue a quit message to the server. Doesn't close the connection."""
@@ -123,52 +124,52 @@ class IRCConnection(object):
         """Our realname (gecos field) on the server."""
         return self._realname
 
-    def say(self, target, msg):
+    def say(self, target, msg, hidelog=False):
         """Send a private message to a target on the server."""
         msg = "PRIVMSG {0} :{1}".format(target, msg)
-        self._send(msg)
+        self._send(msg, hidelog)
 
-    def reply(self, data, msg):
+    def reply(self, data, msg, hidelog=False):
         """Send a private message as a reply to a user on the server."""
         msg = "\x02{0}\x0f: {1}".format(data.nick, msg)
-        self.say(data.chan, msg)
+        self.say(data.chan, msg, hidelog)
 
-    def action(self, target, msg):
+    def action(self, target, msg, hidelog=False):
         """Send a private message to a target on the server as an action."""
         msg = "\x01ACTION {0}\x01".format(msg)
-        self.say(target, msg)
+        self.say(target, msg, hidelog)
 
-    def notice(self, target, msg):
+    def notice(self, target, msg, hidelog=False):
         """Send a notice to a target on the server."""
         msg = "NOTICE {0} :{1}".format(target, msg)
-        self._send(msg)
+        self._send(msg, hidelog)
 
-    def join(self, chan):
+    def join(self, chan, hidelog=False):
         """Join a channel on the server."""
         msg = "JOIN {0}".format(chan)
-        self._send(msg)
+        self._send(msg, hidelog)
 
-    def part(self, chan, msg=None):
+    def part(self, chan, msg=None, hidelog=False):
         """Part from a channel on the server, optionally using an message."""
         if msg:
-            self._send("PART {0} :{1}".format(chan, msg))
+            self._send("PART {0} :{1}".format(chan, msg), hidelog)
         else:
-            self._send("PART {0}".format(chan))
+            self._send("PART {0}".format(chan), hidelog)
 
-    def mode(self, target, level, msg):
+    def mode(self, target, level, msg, hidelog=False):
         """Send a mode message to the server."""
         msg = "MODE {0} {1} {2}".format(target, level, msg)
-        self._send(msg)
+        self._send(msg, hidelog)
 
-    def ping(self, target):
+    def ping(self, target, hidelog=False):
         """Ping another entity on the server."""
         msg = "PING {0}".format(target)
-        self._send(msg)
+        self._send(msg, hidelog)
 
-    def pong(self, target):
+    def pong(self, target, hidelog=False):
         """Pong another entity on the server."""
         msg = "PONG {0}".format(target)
-        self._send(msg)
+        self._send(msg, hidelog)
 
     def loop(self):
         """Main loop for the IRC connection."""

earwigbot/irc/frontend.py

@@ -70,7 +70,7 @@ class Frontend(IRCConnection):
                 pass
             else:
                 msg = "IDENTIFY {0} {1}".format(username, password)
-                self.say("NickServ", msg)
+                self.say("NickServ", msg, hidelog=True)
 
             # Join all of our startup channels:
             for chan in self.bot.config.irc["frontend"]["channels"]:

earwigbot/wiki/site.py

@@ -222,7 +222,10 @@ class Site(object):
         self._last_query_time = time()
 
         url, data = self._build_api_query(params, ignore_maxlag)
-        self._logger.debug("{0} -> {1}".format(url, data))
+        if "lgpassword" in params:
+            self._logger.debug("{0} -> <hidden>".format(url))
+        else:
+            self._logger.debug("{0} -> {1}".format(url, data))
 
         try:
             response = self._opener.open(url, data)