Merge lp:~stefanor/ibid/logfile-visibility-567576-0.1 into lp:~ibid-core/ibid/old-release-0.1-1.6

[Stefano Rivera]

[SECURITY] Add a configuration glob-list of channels which should have public logs, rather than attempting to guess.

[Jonathan Hitchcock (vhata)]

"Configuration value must contain a colon" is *NOT* the same as "Configuration value must be of the form 'source:channel'". The user needs to be told why it should contain a colon, or what the colon means, not just that it needs to be there.

User-Centric Design, people!

(Otherwise, it's good :) )

review: Needs Fixing

[Stefano Rivera (stefanor)]

r949

[Jonathan Hitchcock (vhata)]

review: Approve

[Max Rabkin (max-rabkin)]

On that note, shouldn't we log misspelled source names?

[Stefano Rivera (stefanor)]

Done

[Ibid Branch Auto-Lander (ibid-tarmac)]

Voting does not meet specified criteria. Required: Approve >= 2, Disapprove == 0. Got: 1 Approve.

[marcog (marco-gallotta)]

review: Approve

=== modified file 'ibid/plugins/log.py'
--- ibid/plugins/log.py	2010-06-04 14:43:45 +0000
+++ ibid/plugins/log.py	2010-10-01 14:23:35 +0000
@@ -5,6 +5,8 @@
 
 from datetime import datetime
 from errno import EEXIST
+import fnmatch
+import logging
 from os.path import dirname, join, expanduser
 from os import chmod, makedirs
 from threading import Lock
@@ -14,9 +16,11 @@
 
 import ibid
 from ibid.plugins import Processor, handler
-from ibid.config import Option, BoolOption, IntOption
+from ibid.config import Option, BoolOption, IntOption, ListOption
 from ibid.event import Event
 
+log = logging.getLogger('plugins.log')
+
 class Log(Processor):
 
     addressed = False
@@ -41,6 +45,9 @@
     rename_format = Option('rename_format', 'Format string for rename events',
             u'%(timestamp)s %(sender_nick)s (%(sender_connection)s) has renamed to %(new_nick)s')
 
+    public_logs = ListOption('public_logs',
+            u'List of source:channel globs for channels which should have public logs',
+            [])
     public_mode = Option('public_mode',
             u'File Permissions mode for public channels, in octal', '644')
     private_mode = Option('private_mode',
@@ -55,6 +62,21 @@
     # Ensures that recently used FDs are still available in logs:
     recent_logs = []
 
+    def setup(self):
+        sources = list(set(ibid.config.sources.keys())
+                       | set(ibid.sources.keys()))
+        for glob in self.public_logs:
+            if u':' not in glob:
+                log.warning(u"public_logs configuration values must follow the "
+                            u"format source:channel. \"%s\" doesn't contain a "
+                            u"colon.", glob)
+                continue
+            source_glob = glob.split(u':', 1)[0]
+            if not fnmatch.filter(sources, source_glob):
+                log.warning(u'public_logs includes "%s", but there is no '
+                            u'configured source matching "%s"',
+                            glob, source_glob)
+
     def get_logfile(self, event):
         self.lock.acquire()
         try:
@@ -84,10 +106,18 @@
 
                 log = open(filename, 'a')
                 self.logs[filename] = log
-                if event.get('public', True):
-                    chmod(filename, int(self.public_mode, 8))
+
+                for glob in self.public_logs:
+                    if u':' not in glob:
+                        continue
+                    source_glob, channel_glob = glob.split(u':', 1)
+                    if (fnmatch.fnmatch(event.source, source_glob)
+                            and fnmatch.fnmatch(event.channel, channel_glob)):
+                        chmod(filename, int(self.public_mode, 8))
+                        break
                 else:
                     chmod(filename, int(self.private_mode, 8))
+
                 if len(self.recent_logs) > self.fd_cache:
                     self.recent_logs.pop()
             else: