Kolab Groupware OBS

bonnie.spec Changed

bonnie-0.2.2.tar.gz/dealer.py Deleted

bonnie-0.2.2.tar.gz/.gitignore -> bonnie-0.3.0.tar.gz/.gitignore Changed

bonnie-0.2.2.tar.gz/bonnie/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/__init__.py Changed

@@ -1,20 +1,21 @@
 # -*- coding: utf-8 -*-
-# Copyright 2010-2013 Kolab Systems AG (http://www.kolabsys.com)
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import logging
@@ -30,9 +31,12 @@
         Return the correct logger class.
     """
     logging.setLoggerClass(Logger)
-    log = logging.getLogger(name=name)
+
+    log = logging.getLogger(name=name.replace(".", "_"))
     return log
 
+log = getLogger('bonnie')
+
 from bonnie.conf import Conf
 conf = Conf()

bonnie-0.2.2.tar.gz/bonnie/broker/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/broker/__init__.py Changed

@@ -2,21 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Library General Public License for more details.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """
@@ -27,12 +26,17 @@
 from bonnie.daemon import BonnieDaemon
 
 class BonnieBroker(BonnieDaemon):
+    """
+
+    """
     pidfile = "/var/run/bonnie/broker.pid"
 
     def __init__(self, *args, **kw):
         super(BonnieBroker, self).__init__(*args, **kw)
 
+        #: Interests are registered here.
         self.broker_interests = {}
+
         self.broker_modules = {}
 
         for _class in brokers.list_classes():

bonnie-0.2.2.tar.gz/bonnie/broker/brokers/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/broker/brokers/__init__.py Changed

bonnie-0.2.2.tar.gz/bonnie/broker/brokers/zmq_broker/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/broker/brokers/zmq_broker/__init__.py Changed

@@ -2,27 +2,30 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Library General Public License for more details.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """
     This is the ZMQ broker implementation for Bonnie.
 """
 
+import datetime
+from dateutil.parser import parse
+from dateutil.tz import tzutc
+import json
 from multiprocessing import Process
 import os
 import random
@@ -38,6 +41,8 @@
 conf = bonnie.getConf()
 log = bonnie.getLogger('bonnie.broker.ZMQBroker')
 
+from bonnie.broker.state import init_db
+
 import collector
 import job
 import worker
@@ -54,7 +59,8 @@
 
         self.routers = {}
         self.router_processes = {}
-        self.collector_interests = []
+
+        self.collector_jobs_pending = 0
 
     def register(self, callback):
         callback({ '_all': self.run })
@@ -138,17 +144,29 @@
         self.running = True
         last_expire = time.time()
         last_state = time.time()
+        last_vacuum = time.time()
+
+        try:
+            db = init_db('broker')
+            db.execute("VACUUM")
+            db.commit()
+        except Exception, errmsg:
+            pass
+
         poller_timeout = int(conf.get('broker', 'zmq_poller_timeout', 100))
 
         while self.running:
             try:
-                # TODO: adjust polling timout according to the number of pending jobs
+                # TODO: adjust polling timout according to the number
+                # of pending jobs.
                 sockets = dict(self.poller.poll(poller_timeout))
-            except KeyboardInterrupt, e:
+
+            except KeyboardInterrupt, errmsg:
                 log.info("zmq.Poller KeyboardInterrupt")
                 break
-            except Exception, e:
-                log.error("zmq.Poller error: %r", e)
+
+            except Exception, errmsg:
+                log.error("zmq.Poller error: %r", errmsg)
                 sockets = dict()
 
             for socket, event in sockets.iteritems():
@@ -159,12 +177,8 @@
                         result = getattr(router, '%s' % callforward)()
                         callback(router, result)
 
-            for _collector in collector.select_by_state(b'READY'):
-                self._send_collector_job(_collector.identity)
-
-            for _worker in worker.select_by_state(b'READY'):
-                self._send_worker_job(_worker.identity)
-
+            # Once every 30 seconds, expire stale collectors and
+            # workers, unlock jobs and expire those done.
             if last_expire < (time.time() - 30):
                 for _collector in collector.select_by_state(b'READY'):
                     self._request_collector_state(_collector.identity)
@@ -173,50 +187,14 @@
                 worker.expire()
                 job.unlock()
                 job.expire()
-                last_expire = time.time()
 
-            if last_state < (time.time() - 10):
-                stats_start = time.time()
-                jcp = job.count_by_type_and_state('collector', b'PENDING')
-                jwp = job.count_by_type_and_state('worker', b'PENDING')
-                jca = job.count_by_type_and_state('collector', b'ALLOC')
-                jwa = job.count_by_type_and_state('worker', b'ALLOC')
-
-                stats = {
-                        'cb': collector.count_by_state(b'BUSY'),
-                        'cr': collector.count_by_state(b'READY'),
-                        'cs': collector.count_by_state(b'STALE'),
-                        'ja': sum([jca, jwa]),
-                        'jca': jca,
-                        'jcp': jcp,
-                        'jd': job.count_by_state(b'DONE'),
-                        'jp': sum([jcp, jwp]),
-                        'jwa': jwa,
-                        'jwp': jwp,
-                        'jf': job.count_by_state(b'FAILED'),
-                        'jo': job.count_by_state(b'POSTPONED'),
-                        'wb': worker.count_by_state(b'BUSY'),
-                        'wr': worker.count_by_state(b'READY'),
-                        'ws': worker.count_by_state(b'STALE'),
-                    }
-                stats_end = time.time()
-
-                stats['duration'] = "%.4f" % (stats_end - stats_start)
-
-                log.info("""
-    Jobs:       done=%(jd)d, pending=%(jp)d, alloc=%(ja)d,
-                postponed=%(jo)d, failed=%(jf)d.
-    Workers:    ready=%(wr)d, busy=%(wb)d, stale=%(ws)d,
-                pending=%(jwp)d, alloc=%(jwa)d.
-    Collectors: ready=%(cr)d, busy=%(cb)d, stale=%(cs)d,
-                pending=%(jcp)d, alloc=%(jca)d.
-    Took:       seconds=%(duration)s.""" % stats)
-
-                self._write_stats(stats)
+                last_expire = time.time()
 
+            # Report on the state of jobs.
+            if last_state < (time.time() - 30):
+                self._write_stats()
                 last_state = time.time()
 
-
         log.info("Shutting down")
 
         for attrs in self.routers.values():
@@ -237,6 +215,7 @@
 
         if not hasattr(self, '_handle_cr_%s' % (cmd)):
             log.error("Unhandled CR cmd %s" % (cmd))
+            return
 
         handler = getattr(self, '_handle_cr_%s' % (cmd))
         handler(router, collector_identity, message[2:])
@@ -250,9 +229,23 @@
         log.debug("Dealer Router Message: %r" % (message), level=8)
         dealer_identity = message[0]
         notification = message[1]
+
+        done = False
+        attempts = 0
+        while not done:
+            attempts += 1
+            try:
+                _job = job.add(dealer_identity, notification)
+                if not _job == None:
+                    done = True
+            except Exception, errmsg:
+                if attempts % 10 == 0:
+                    log.error("Dealer Router cannot add jobs: %r" % (errmsg))
+
         stream.send_multipart([dealer_identity, b'ACK'])
 
-        job.add(dealer_identity, notification)
+        if not _job == None:
+            log.info("Job %s NEW by %s" % (_job.uuid, dealer_identity))
 
     def _cb_wr_recv_multipart(self, router, message):
         log.debug("Worker Router Message: %r" % (message), level=8)
@@ -269,23 +262,15 @@
     def _cb_wcr_recv_multipart(self, router, message):
         log.debug("Worker Controller Router Message: %r" % (message), level=8)
         worker_identity = message[0]
-        commands = message[1].split(" ")
-
-        # check for aggregated collector commands
-        collector_commands = [c for c in commands if c in self.collector_interests]
-
-        if len(collector_commands) == len(commands):
-            self._handle_wcr_COLLECT(router, worker_identity, message[1], message[2:])
-        else:
-            cmd = message[1]
+        cmd = message[1]
 
-            if not hasattr(self, '_handle_wcr_%s' % (cmd)):
-                log.error("Unknown WCR cmd %s for job %s" % (cmd, message[2]))
-                self._handle_wcr_UNKNOWN(router, worker_identity, message[2:])
-                return
+        if not hasattr(self, '_handle_wcr_%s' % (cmd)):
+            log.error("Unknown WCR cmd %s for job %s" % (cmd, message[2]))
+            self._handle_wcr_UNKNOWN(router, worker_identity, message[2:])
+            return
 
-            handler = getattr(self, '_handle_wcr_%s' % (cmd))
-            handler(router, worker_identity, message[2:])
+        handler = getattr(self, '_handle_wcr_%s' % (cmd))
+        handler(router, worker_identity, message[2:])
 
     ##
     ## Collector Router command functions
@@ -331,12 +316,6 @@
         state = message[0]
         interests = message[1].split(" ")
 
-        # register the reported interests
-        if len(interests) > 0:
-            _interests = list(interests)
-            _interests.extend(self.collector_interests)
-            self.collector_interests = list(set(_interests))
-
         collector.set_state(identity, state, interests)
 
         if state == b'READY':
@@ -363,23 +342,20 @@
 
         self._send_worker_job(identity)
 
-    def _handle_wcr_COLLECT(self, router, identity, commands, message):
-        log.debug("Handing COLLECT for identity %s (commands: %r, message: %r)" % (identity, commands, message), level=7)
-        job_uuid = message[0]
-        log.info("Job %s COLLECT (%r) by %s" % (job_uuid, commands, identity))
-
-        updates = dict(
-                cmd = commands,
-                state = b'PENDING',
-                job_type = 'collector'
-            )
+    def _handle_wcr_COLLECT(self, router, identity, message):
+        log.debug("Handing COLLECT for identity %s (message: %r)" % (identity, message[:-1]), level=7)
+        commands = message[0]
+        job_uuid = message[1]
+        notification = message[2]
 
-        if len(message) > 1:
-            updates['notification'] = message[1]
+        log.info("Job %s COLLECT by %s" % (job_uuid, identity))
 
         job.update(
                 job_uuid,
-                **updates
+                cmd = commands,
+                state = b'PENDING',
+                job_type = 'collector',
+                notification = notification
             )
 
         worker.update(
@@ -493,21 +469,18 @@
             log.info("ioloop.IOLoop KeyboardInterrupt")
         except Exception, e:
             log.error("ioloop.IOLoop error: %r", e)
-
+        finally:
+            ioloop.IOLoop.instance().stop()
 
     def _send_collector_job(self, identity):
         _job = job.select_for_collector(identity)
 
         if _job == None:
+            #log.info("No jobs for collector %s" % (identity))
             return
 
-        collector.update(
-                identity,
-                state = b'BUSY',
-                job = _job.id
-            )
-
-        log.debug("Sending %s to %s" % (_job.uuid, identity), level=7)
+        log.info("Job %s ALLOC to %s" % (_job.uuid, identity))
+        #log.debug("Sending %s to %s" % (_job.uuid, identity), level=7)
 
         self.routers['collector']['router'].send_multipart(
                 [
@@ -522,15 +495,11 @@
         _job = job.select_for_worker(identity)
 
         if _job == None:
+            #log.info("No jobs for worker %s" % (identity))
             return
 
-        worker.update(
-                identity,
-                state = b'BUSY',
-                job = _job.id
-            )
-
-        log.debug("Sending %s to %s" % (_job.uuid, identity), level=7)
+        log.info("Job %s ALLOC to %s" % (_job.uuid, identity))
+        #log.debug("Sending %s to %s" % (_job.uuid, identity), level=7)
 
         self.routers['worker_controller']['router'].send_multipart(
                 [
@@ -540,34 +509,101 @@
                     ]
             )
 
-    def _write_stats(self, stats):
-        if os.access("/var/lib/bonnie/state.state", os.W_OK):
-            try:
-                fp = open("/var/lib/bonnie/state.stats", "w")
-                fp.write("""# Source this file in your script
-jobs_done=%(jd)d
-jobs_pending=%(jp)d
-jobs_alloc=%(ja)d
-jobs_orphaned=%(jo)d
-workers_ready=%(wr)d
-workers_busy=%(wb)d
-workers_stale=%(ws)d
-collectors_ready=%(cr)d
-collectors_busy=%(cb)d
-collectors_stale=%(cs)d
-collector_jobs_pending=%(jcp)d
-collector_jobs_alloc=%(jcp)d
-worker_jobs_pending=%(jwp)d
-worker_jobs_alloc=%(jwa)d
-""" % stats)
-                fp.close()
+    def _write_stats(self):
+        job_retention = (int)(conf.get(
+                "broker",
+                "job_retention",
+                300
+            ))
 
-            except Exception, errmsg:
-                log.error(
-                        "An error occurred writing out the stats file:\n%s" % (
-                                errmsg
-                            )
-                    )
+        stats_start = time.time()
+
+        jcp = job.count_by_type_and_state('collector', b'PENDING')
+        jwp = job.count_by_type_and_state('worker', b'PENDING')
+        jca = job.count_by_type_and_state('collector', b'ALLOC')
+        jwa = job.count_by_type_and_state('worker', b'ALLOC')
+
+        _job = job.first()
+
+        if _job == None:
+            jt = 0
+        else:
+            _job_notification = json.loads(_job.notification)
+            _job_timestamp = parse(_job_notification['timestamp']).astimezone(tzutc())
+            now = parse(
+                    datetime.datetime.strftime(
+                            datetime.datetime.utcnow(),
+                            "%Y-%m-%dT%H:%M:%S.%fZ"
+                        )
+                ).astimezone(tzutc())
+
+            delta = now - _job_timestamp
+            if hasattr(delta, 'total_seconds'):
+                seconds = delta.total_seconds()
+            else:
+                seconds = (delta.days * 24 * 3600) + delta.seconds
+
+            jt = round(seconds, 0)
+
+        stats = {
+                'cb': collector.count_by_state(b'BUSY'),
+                'cr': collector.count_by_state(b'READY'),
+                'cs': collector.count_by_state(b'STALE'),
+                'ja': sum([jca, jwa]),
+                'jca': jca,
+                'jcp': jcp,
+                'jd': job.count_by_state(b'DONE'),
+                'jf': job.count_by_state(b'FAILED'),
+                'jo': job.count_by_state(b'POSTPONED'),
+                'jp': sum([jcp, jwp]),
+                'jr': job_retention,
+                'jt': jt,
+                'jwa': jwa,
+                'jwp': jwp,
+                'wb': worker.count_by_state(b'BUSY'),
+                'wr': worker.count_by_state(b'READY'),
+                'ws': worker.count_by_state(b'STALE'),
+            }
+
+        stats_end = time.time()
+
+        stats['duration'] = "%.4f" % (stats_end - stats_start)
+
+        self._write_stats_file(stats)
+        self._write_stats_log(stats)
+
+    def _write_stats_file(self, stats):
+        fp = open("/var/lib/bonnie/state.stats", "w")
+        fp.write("""# Source this file in your script
+                job_retention=%(jr)d
+                jobs_done=%(jd)d
+                jobs_pending=%(jp)d
+                jobs_alloc=%(ja)d
+                jobs_postponed=%(jo)d
+                jobs_failed=%(jf)d
+                jobs_lag=%(jt)d
+                workers_ready=%(wr)d
+                workers_busy=%(wb)d
+                workers_stale=%(ws)d
+                collectors_ready=%(cr)d
+                collectors_busy=%(cb)d
+                collectors_stale=%(cs)d
+                collector_jobs_pending=%(jcp)d
+                collector_jobs_alloc=%(jca)d
+                worker_jobs_pending=%(jwp)d
+                worker_jobs_alloc=%(jwa)d
+                """.replace('    ', '') % (stats))
+        fp.close()
+
+    def _write_stats_log(self, stats):
+        log.info("""
+            Jobs:       done=%(jd)d, pending=%(jp)d, alloc=%(ja)d,
+                        postponed=%(jo)d, failed=%(jf)d.
+            Workers:    ready=%(wr)d, busy=%(wb)d, stale=%(ws)d,
+                        pending=%(jwp)d, alloc=%(jwa)d.
+            Collectors: ready=%(cr)d, busy=%(cb)d, stale=%(cs)d,
+                        pending=%(jcp)d, alloc=%(jca)d.
+            Took:       seconds=%(duration)s.""" % stats)
 
     def _request_collector_state(self, identity):
         log.debug("Requesting state from %s" % (identity), level=7)

bonnie-0.2.2.tar.gz/bonnie/broker/brokers/zmq_broker/collector.py -> bonnie-0.3.0.tar.gz/bonnie/broker/brokers/zmq_broker/collector.py Changed

@@ -2,21 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Library General Public License for more details.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import datetime
@@ -99,6 +98,11 @@
 
     collector = db.query(Collector).filter_by(identity=identity).first()
 
+    if collector == None:
+        db.add(Collector(identity))
+        db.commit()
+        collector = db.query(Collector).filter_by(identity=identity).first()
+
     for attr, value in kw.iteritems():
         setattr(collector, attr, value)
 
@@ -107,6 +111,17 @@
 def expire():
     db = init_db('collectors')
 
+    for collector in db.query(Collector).filter(Collector.timestamp <= (datetime.datetime.utcnow() - datetime.timedelta(0, 90)), Collector.state == b'STALE').all():
+        log.debug("Purging collector %s as very stale" % (collector.identity), level=7)
+        if not collector.job == None:
+            _job = db.query(Job).filter_by(id=collector.job).first()
+            if not _job == None:
+                _job.state = b'PENDING'
+                _job.timestamp = datetime.datetime.utcnow()
+
+        db.delete(collector)
+        db.commit()
+
     for collector in db.query(Collector).filter(Collector.timestamp <= (datetime.datetime.utcnow() - datetime.timedelta(0, 90)), Collector.state != b'STALE').all():
         log.debug("Marking collector %s as stale" % (collector.identity), level=7)
         if not collector.job == None:

bonnie-0.2.2.tar.gz/bonnie/broker/brokers/zmq_broker/job.py -> bonnie-0.3.0.tar.gz/bonnie/broker/brokers/zmq_broker/job.py Changed

@@ -2,27 +2,27 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Library General Public License for more details.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import datetime
 import time
 
 from sqlalchemy.exc import IntegrityError
+from sqlalchemy.exc import OperationalError
 
 import bonnie
 conf = bonnie.getConf()
@@ -37,11 +37,26 @@
         Add a new job.
     """
     db = init_db('jobs')
+
+    if db == None:
+        return None
+
+    job = None
+
     try:
-        db.add(Job(dealer, notification, job_type))
+        job = Job(dealer, notification, job_type)
+        db.add(job)
         db.commit()
     except IntegrityError, errmsg:
+        log.error("SQLAlchemy Integrity Error: %r" % (errmsg))
         db.rollback()
+        return None
+    except OperationalError, errmsg:
+        log.error("SQLAlchemy Operational Error: %r" % (errmsg))
+        db.rollback()
+        return None
+
+    return job
 
 def count():
     db = init_db('jobs')
@@ -63,6 +78,11 @@
     result = db.query(Job).filter_by(job_type=job_type, state=state).count()
     return result
 
+def first():
+    db = init_db('jobs')
+    result = db.query(Job).filter(Job.state != b'DONE').order_by(Job.id).first()
+    return result
+
 def select(job_uuid):
     db = init_db('jobs')
     result = db.query(Job).filter_by(uuid=job_uuid).first()
@@ -104,12 +124,16 @@
 
     # This results in following the storage order and is by far the
     # fastest methodology.
-    job = db.query(Job).filter_by(collector=identity, job_type='collector', state=b'PENDING').first()
+    job = db.query(Job).filter_by(collector=identity, job_type='collector', state=b'PENDING').order_by(Job.id).first()
 
-    if not job == None:
-        job.state = b'ALLOC'
-        job.timestamp = datetime.datetime.utcnow()
-        db.commit()
+    if job == None:
+        return
+
+    job.state = b'ALLOC'
+    job.timestamp = datetime.datetime.utcnow()
+    collector.job = job.id
+    collector.state = b'BUSY'
+    db.commit()
 
     return job
 
@@ -134,12 +158,15 @@
 
     # This results in following the storage order and is by far the
     # fastest methodology.
-    job = db.query(Job).filter_by(job_type='worker', state=b'PENDING').first()
+    job = db.query(Job).filter_by(job_type='worker', state=b'PENDING').order_by(Job.id).first()
 
-    if not job == None:
-        job.state = b'ALLOC'
-        job.timestamp = datetime.datetime.utcnow()
-        db.commit()
+    if job == None:
+        return
+
+    job.state = b'ALLOC'
+    worker.job = job.id
+    worker.state = b'BUSY'
+    db.commit()
 
     return job
 
@@ -178,7 +205,9 @@
     """
     db = init_db('jobs')
 
-    for job in db.query(Job).filter(Job.timestamp <= (datetime.datetime.utcnow() - datetime.timedelta(0, 300)), Job.state == b'DONE').all():
+    job_retention = (int)(conf.get("broker", "job_retention", 300))
+
+    for job in db.query(Job).filter(Job.timestamp <= (datetime.datetime.utcnow() - datetime.timedelta(0, job_retention)), Job.state == b'DONE').all():
         log.debug("Purging job %s" % (job.uuid), level=7)
         db.delete(job)

bonnie-0.2.2.tar.gz/bonnie/broker/brokers/zmq_broker/worker.py -> bonnie-0.3.0.tar.gz/bonnie/broker/brokers/zmq_broker/worker.py Changed

@@ -2,21 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Library General Public License for more details.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import datetime

bonnie-0.2.2.tar.gz/bonnie/broker/state.py -> bonnie-0.3.0.tar.gz/bonnie/broker/state.py Changed

@@ -1,22 +1,21 @@
 # -*- coding: utf-8 -*-
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
-# Thomas Bruederli <bruederli at kolabsys.com>
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Library General Public License for more details.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import datetime
@@ -37,6 +36,7 @@
 from sqlalchemy import create_engine
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import relationship
+from sqlalchemy.schema import Index
 
 try:
     from sqlalchemy.orm import relationship
@@ -120,6 +120,10 @@
         self.cmd = None
         self.pushbacks = 0
 
+Index('job_collector', 'collector')
+Index('job_job_type', 'job_type')
+Index('job_state', 'state')
+
 class Worker(DeclarativeBase):
     __tablename__ = 'worker'
 
@@ -153,11 +157,11 @@
     try:
         engine = create_engine(db_uri, echo=echo)
         DeclarativeBase.metadata.create_all(engine)
-    except:
-        engine = create_engine('sqlite:////tmp/state.db')
-        DeclarativeBase.metadata.create_all(engine)
+    except Exception, errmsg:
+        log.error("Exception occurred: %r" % (errmsg))
+        return None
 
-    Session = sessionmaker(bind=engine)
+    Session = sessionmaker(bind=engine,autoflush=True)
     db = Session()
 
     return db

bonnie-0.2.2.tar.gz/bonnie/collector/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/collector/__init__.py Changed

@@ -1,23 +1,21 @@
 # -*- coding: utf-8 -*-
-#
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import os

bonnie-0.2.2.tar.gz/bonnie/collector/handlers/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/collector/handlers/__init__.py Changed

@@ -1,3 +1,23 @@
+# -*- coding: utf-8 -*-
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
+#
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 from messagedata import MessageDataHandler
 from imapdata import IMAPDataHandler
 from ldapdata import LDAPDataHandler
@@ -13,4 +33,4 @@
         MessageDataHandler,
         IMAPDataHandler,
         LDAPDataHandler
-    ]
\ No newline at end of file
+    ]

bonnie-0.2.2.tar.gz/bonnie/collector/handlers/imapdata.py -> bonnie-0.3.0.tar.gz/bonnie/collector/handlers/imapdata.py Changed

@@ -1,20 +1,21 @@
 # -*- coding: utf-8 -*-
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
-# Thomas Bruederli <bruederli at kolabsys.com>
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import json
@@ -43,9 +44,13 @@
 
     def register(self, callback):
         interests = {
-            'GETMETADATA':  { 'callback': self.get_imap_folder_metadata },
-            'GETACL':  { 'callback': self.get_imap_folder_acl }
-        }
+                'GETMETADATA': {
+                        'callback': self.get_imap_folder_metadata
+                    },
+                'GETACL': {
+                        'callback': self.get_imap_folder_acl
+                    }
+            }
 
         callback(interests)

bonnie-0.2.2.tar.gz/bonnie/collector/handlers/ldapdata.py -> bonnie-0.3.0.tar.gz/bonnie/collector/handlers/ldapdata.py Changed

@@ -1,20 +1,21 @@
 # -*- coding: utf-8 -*-
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
-# Thomas Bruederli <bruederli at kolabsys.com>
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import json
@@ -44,8 +45,8 @@
 
     def register(self, callback):
         interests = {
-            'GETUSERDATA': { 'callback': self.get_user_data }
-        }
+                'GETUSERDATA': { 'callback': self.get_user_data }
+            }
 
         callback(interests)

bonnie-0.2.2.tar.gz/bonnie/collector/handlers/messagedata.py -> bonnie-0.3.0.tar.gz/bonnie/collector/handlers/messagedata.py Changed

@@ -1,20 +1,21 @@
 # -*- coding: utf-8 -*-
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
-# Thomas Bruederli <bruederli at kolabsys.com>
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import os
@@ -39,9 +40,13 @@
 
     def register(self, callback):
         interests = {
-            'FETCH':  { 'callback': self.retrieve_contents_for_messages },
-            'HEADER': { 'callback': self.retrieve_headers_for_messages }
-        }
+                'FETCH':  {
+                        'callback': self.retrieve_contents_for_messages
+                    },
+                'HEADER': {
+                        'callback': self.retrieve_headers_for_messages
+                    }
+            }
 
         callback(interests)

bonnie-0.2.2.tar.gz/bonnie/collector/inputs/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/collector/inputs/__init__.py Changed

bonnie-0.2.2.tar.gz/bonnie/collector/inputs/zmq_input.py -> bonnie-0.3.0.tar.gz/bonnie/collector/inputs/zmq_input.py Changed

@@ -1,23 +1,21 @@
 # -*- coding: utf-8 -*-
-#
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """
@@ -83,22 +81,22 @@
             Receive a message on the Collector Router.
         """
         log.debug("Collector Router Message: %r" % (message), level=8)
-        collector_identity = message[0]
+        cmd = message[0]
 
-        if message[0] == b"STATE" or not self.state == b"READY":
+        if cmd == b"STATE":
             self.report_state()
         else:
             job_uuid = message[1]
             notification = message[2]
 
             if not self.notify_callback == None:
-                self.notify_callback(message[0], job_uuid, notification)
+                self.notify_callback(cmd, job_uuid, notification)
 
     def callback_done(self, job_uuid, result):
         log.debug("Handler callback done for job %s: %r" % (job_uuid, result), level=8)
         self.report_timestamp = time.time()
         self.collector.send_multipart([b"DONE", job_uuid, result])
-        log.debug("Handler results sent for job %s" % (job_uuid), level=7)
+        log.info("Job %s DONE by %s" % (job_uuid, self.identity))
 
     def terminate(self):
         log.info("[%s] shutting down", self.identity)

bonnie-0.2.2.tar.gz/bonnie/conf.py -> bonnie-0.3.0.tar.gz/bonnie/conf.py Changed

bonnie-0.2.2.tar.gz/bonnie/daemon.py -> bonnie-0.3.0.tar.gz/bonnie/daemon.py Changed

@@ -1,22 +1,21 @@
 # -*- coding: utf-8 -*-
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
-# Thomas Bruederli <bruederli at kolabsys.com>
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Library General Public License for more details.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import os
@@ -25,11 +24,22 @@
 import pwd
 import signal
 import traceback
+
 import bonnie
 conf = bonnie.getConf()
 log = bonnie.getLogger('bonnie')
 
 class BonnieDaemon(object):
+    """
+        A standard daemon process abstraction layer for Bonnie.
+
+        This class provides the following capabilities for Bonnie
+        daemons (through inheritance):
+
+        *   standard command-line options
+        *   :func:`dropping privileges <drop_privileges>`
+        *   :func:`signal handling <signal_handlers>`
+    """
     pidfile = "/var/run/bonnie/bonnie.pid"
 
     def __init__(self, *args, **kw):
@@ -76,7 +86,8 @@
 
     def run(self, *args, **kw):
         """
-            The daemon main loop
+            The daemon main loop. Override this function in a
+            :class:`BonnieDaemon` sub-class.
         """
         pass
 
@@ -224,7 +235,7 @@
     """
         This forks the current process into a daemon.
     """
-    # do the UNIX double-fork magic, see Stevens' "Advanced 
+    # do the UNIX double-fork magic, see Stevens' "Advanced
     # Programming in the UNIX Environment" for details (ISBN 0201563177)
     try:
         pid = os.fork()

bonnie-0.2.2.tar.gz/bonnie/dealer/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/dealer/__init__.py Changed

@@ -1,23 +1,21 @@
 # -*- coding: utf-8 -*-
-#
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import json
@@ -53,6 +51,9 @@
         if event in exclude_events:
             return False
 
+        if user == None:
+            return True
+
         blacklist_events = conf.get('dealer', 'blacklist_events', None)
         if not blacklist_events == None:
             blacklist_events = blacklist_events.split(',')
@@ -66,7 +67,7 @@
             blacklist_users = []
 
         # ignore blacklisted events for blacklisted users
-        if event in blacklist_events and user is not None and user in blacklist_users:
+        if event in blacklist_events and user in blacklist_users:
             return False
 
         return True

bonnie-0.2.2.tar.gz/bonnie/dealer/outputs/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/dealer/outputs/__init__.py Changed

bonnie-0.2.2.tar.gz/bonnie/dealer/outputs/file_output.py -> bonnie-0.3.0.tar.gz/bonnie/dealer/outputs/file_output.py Changed

@@ -1,23 +1,21 @@
 # -*- coding: utf-8 -*-
-#
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import os

bonnie-0.2.2.tar.gz/bonnie/dealer/outputs/zmq_output.py -> bonnie-0.3.0.tar.gz/bonnie/dealer/outputs/zmq_output.py Changed

@@ -1,23 +1,21 @@
 # -*- coding: utf-8 -*-
-#
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import os

bonnie-0.2.2.tar.gz/bonnie/logger.py -> bonnie-0.3.0.tar.gz/bonnie/logger.py Changed

@@ -1,20 +1,21 @@
 # -*- coding: utf-8 -*-
-# Copyright 2010-2013 Kolab Systems AG (http://www.kolabsys.com)
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import grp

bonnie-0.2.2.tar.gz/bonnie/plugins/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/plugins/__init__.py Changed

@@ -1,20 +1,21 @@
 # -*- coding: utf-8 -*-
-# Copyright 2010-2013 Kolab Systems AG (http://www.kolabsys.com)
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import logging

bonnie-0.2.2.tar.gz/bonnie/translate.py -> bonnie-0.3.0.tar.gz/bonnie/translate.py Changed

@@ -1,20 +1,21 @@
 # -*- coding: utf-8 -*-
-# Copyright 2010-2013 Kolab Systems AG (http://www.kolabsys.com)
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 try:

bonnie-0.2.2.tar.gz/bonnie/utils.py -> bonnie-0.3.0.tar.gz/bonnie/utils.py Changed

bonnie-0.2.2.tar.gz/bonnie/worker/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/worker/__init__.py Changed

@@ -1,23 +1,21 @@
 # -*- coding: utf-8 -*-
-#
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import json
@@ -37,6 +35,11 @@
 log = bonnie.getLogger('bonnie.worker')
 
 class BonnieWorker(BonnieDaemon):
+    """
+        Bonnie Worker specific version of a :class:`Bonnie Daemon <bonnie.daemon.BonnieDaemon>`
+    """
+
+    #: The process ID file to use.
     pidfile = "/var/run/bonnie/worker.pid"
 
     def __init__(self, *args, **kw):
@@ -59,7 +62,9 @@
 
     def run(self):
         """
-            Daemon main loop
+            The Bonnie worker main loop, responsible for creating
+            :class:`worker processes
+            <bonnie.worker.BonnieWorkerProcess>`
         """
         num_childs = conf.num_childs or conf.get('worker', 'num_childs')
         if num_childs is not None:
@@ -93,11 +98,15 @@
 
     def run_child(self):
         """
-            This method is being run in a separate process
+            Target method for :class:`worker processes
+            <bonnie.worker.BonnieWorkerProcess>`
         """
         BonnieWorkerProcess(as_child=True).run()
 
     def terminate(self, *args, **kw):
+        """
+            Stop the worker daemon.
+        """
         self.running = False
         for p in self.childs:
             p.terminate()
@@ -106,16 +115,26 @@
             for p in self.childs:
                 p.join()
 
-
 class BonnieWorkerProcess(object):
+    #: Holder of interests registered by handlers
     handler_interests = { '_all': [] }
+
+    #: Holder of interests registered by input channel modules
     input_interests = {}
+
+    #: Holder of interests registered by storage channel modules
     storage_interests = {}
+
+    #: Holder of interests registered by output channel modules
     output_interests = {}
 
+    #: Lists registered handler modules
     handler_modules = {}
+    #: Lists registered input modules
     input_modules = {}
+    #: Lists registered storage modules
     storage_modules = {}
+    #: Lists registered output modules
     output_modules = {}
 
     output_exclude_events = []
@@ -169,19 +188,97 @@
 
         if self.handler_interests.has_key(event):
             for interest in self.handler_interests[event]:
-                (notification, _jobs) = self.interest_callback(interest, notification)
-                jobs.extend(_jobs)
+                (notification, _jobs) = self.interest_callback(
+                        interest,
+                        notification
+                    )
+
+                if len(_jobs) > 0:
+                    log.debug(
+                            "Handler interest %r for event %s returns jobs: %r" % (
+                                    interest,
+                                    event,
+                                    _jobs
+                                ),
+                            level = 6
+                        )
+
+                    jobs.extend(_jobs)
 
         for interest in self.handler_interests['_all']:
-            (notification, _jobs) = self.interest_callback(interest, notification)
-            jobs.extend(_jobs)
+            (notification, _jobs) = self.interest_callback(
+                    interest,
+                    notification
+                )
+
+            if len(_jobs) > 0:
+                log.debug(
+                        "Handler interest %r for _all returns jobs: %r" % (
+                                interest,
+                                _jobs
+                            ),
+                        level = 6
+                    )
+
+                jobs.extend(_jobs)
+
+        jobs = list(set(jobs))
+
+        if len(jobs) > 0:
+            log.debug(
+                    "Handler interests included jobs: %r" % (jobs),
+                    level = 6
+                )
 
-        # trigger storage modules which registered interest in particular notification properties
+        handler_jobs_num = len(jobs)
+
+        # trigger storage modules which registered interest in
+        # particular notification properties.
         for prop,storage_interests in self.storage_interests.iteritems():
             if notification.has_key(prop):
                 for interest in storage_interests:
-                    (notification, _jobs) = self.interest_callback(interest, notification)
-                    jobs.extend(_jobs)
+                    log.debug(
+                            "Storage interest %s for property %s to be executed" % (
+                                    interest,
+                                    prop
+                                ),
+                            level = 6
+                        )
+
+                    (notification, _jobs) = self.interest_callback(
+                            interest,
+                            notification
+                        )
+
+                    if len(_jobs) > 0:
+                        log.debug(
+                                "Storage interest %r for %r returns jobs: %r" % (
+                                        interest,
+                                        prop,
+                                        _jobs
+                                    ),
+                                level = 6
+                            )
+
+                        jobs.extend(_jobs)
+
+            else:
+                log.debug(
+                        "Storage interests for property %s not (yet) relevant" % (
+                                prop
+                            ),
+                        level = 6
+                    )
+
+        jobs = list(set(jobs))
+
+        if len(jobs) > handler_jobs_num:
+            log.debug(
+                    "Storage interests included additional jobs: %r" % (
+                            jobs
+                        ),
+                    level = 6
+                )
 
         # finally send notification to output handlers if no jobs remaining
         if len(jobs) == 0 and not notification.has_key('_suppress_output') and not event in self.output_exclude_events:
@@ -197,7 +294,7 @@
 
         log.debug("Event notification %r processed. Jobs = %r" % (event, jobs), level=7)
 
-        return notification, list(set(jobs))
+        return json.dumps(notification), list(set(jobs))
 
     def input_report(self):
         """
@@ -212,9 +309,9 @@
             if hasattr(_storage, 'report'):
                 _storage.report()
 
-        for _storage in self.storage_modules.values():
-            if hasattr(_storage, 'report'):
-                _storage.report()
+        for _output in self.output_modules.values():
+            if hasattr(_output, 'report'):
+                _output.report()
 
     def interest_callback(self, interest, notification):
         """
@@ -229,12 +326,13 @@
             A handler registers itself with a set of interests, based on
             the event notification type.
 
-            For example, for a handler to subscribe to a 'MessageAppend'
+            For example, for a handler to subscribe to a *MessageAppend*
             event notification type, it would register itself with the
-            following interests, provided it wants its method 'run' to
-            be executed:
+            following interests, provided it wants its method ``run`` to
+            be executed::
 
                 { 'MessageAppend': { 'callback': self.run } }
+
         """
         for interest,how in interests.iteritems():
             if not self.handler_interests.has_key(interest):
@@ -244,11 +342,14 @@
 
         return self
 
-    def register_input(self, interests):
+    def register_input(self, interests={}):
         self.input_interests = interests
         return self
 
-    def register_output(self, interests):
+    def register_output(self, interests={}):
+        """
+            Output channel module registration.
+        """
         for interest,how in interests.iteritems():
             if not self.output_interests.has_key(interest):
                 self.output_interests[interest] = []
@@ -257,7 +358,10 @@
 
         return self
 
-    def register_storage(self, interests):
+    def register_storage(self, interests={}):
+        """
+            Storage channel module registration.
+        """
         for interest,how in interests.iteritems():
             if not self.storage_interests.has_key(interest):
                 self.storage_interests[interest] = []
@@ -267,7 +371,13 @@
         return self
 
     def run(self):
-        input_modules = conf.get('worker', 'input_modules').split(',')
+        input_modules = conf.get('worker', 'input_modules')
+        if input_modules == None:
+            log.error("No input modules configured for worker")
+            return
+
+        input_modules = [x.strip() for x in input_modules.split(',')]
+
         for _input in self.input_modules.values():
             if _input.name() in input_modules:
                 _input.run(callback=self.event_notification, report=self.input_report)

bonnie-0.2.2.tar.gz/bonnie/worker/constants.py -> bonnie-0.3.0.tar.gz/bonnie/worker/constants.py Changed

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/__init__.py Changed

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/aclchange.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/aclchange.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """
@@ -24,6 +25,10 @@
 from bonnie.worker.handlers import MailboxHandlerBase
 
 class AclChangeHandler(MailboxHandlerBase):
+    """
+        Handler for an event that changes the ACL on an object.
+    """
+
     event = 'AclChange'
 
     def __init__(self, *args, **kw):

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/base.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/base.py Changed

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/changelog.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/changelog.py Changed

@@ -1,20 +1,21 @@
 # -*- coding: utf-8 -*-
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
-# Thomas Bruederli <bruederli at kolabsys.com>
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/flagsclear.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/flagsclear.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/flagsset.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/flagsset.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/login.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/login.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """
@@ -24,7 +25,29 @@
 from bonnie.worker.handlers import HandlerBase
 
 class LoginHandler(HandlerBase):
+    """
+        A *Login* event notification handler.
+
+        The event notification is a JSON object with the following
+        layout::
+
+            {
+                    "event":"Login",
+                    "timestamp":"2014-11-27T10:45:38.201+01:00",
+                    "service":"imap",
+                    "serverDomain":"10.8.14.13",
+                    "serverPort":143,
+                    "clientIP":"10.8.13.10",
+                    "clientPort":45735,
+                    "uri":"imap://imapb13.example.org",
+                    "pid":14210,
+                    "user":"alexander.aachen@example.org",
+                    "vnd.cmu.sessionId":"cyrus-imapd-14210-1417081537-1-10541965771286434889"
+                }
+
+    """
+
     event = 'Login'
 
     def __init__(self, *args, **kw):
-        HandlerBase.__init__(self, *args, **kw)
+        super(LoginHandler, self).__init__(*args, **kw)

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/logout.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/logout.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """
@@ -32,11 +33,12 @@
     event = 'Logout'
 
     def __init__(self, *args, **kw):
-        HandlerBase.__init__(self, *args, **kw)
+        super(LogoutHandler, self).__init__(*args, **kw)
 
     def run(self, notification):
-        # lookup corresponding Login event and update that record with logout_time
-        # and suppress separate logging of this event with notification['_suppress_output'] = True
+        # lookup corresponding Login event and update that record with
+        # logout_time and suppress separate logging of this event with
+        # notification['_suppress_output'] = True.
         if notification.has_key('vnd.cmu.sessionId'):
             now = datetime.datetime.now(tzutc())
             attempts = 4
@@ -80,4 +82,4 @@
             # push back into the job queue, the corresponding Login event may not yet have been processed.
             return (notification, [b"POSTPONE"])
 
-        return super(LogoutHandler, self).run(notification)
\ No newline at end of file
+        return super(LogoutHandler, self).run(notification)

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/mailboxbase.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/mailboxbase.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/mailboxcreate.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/mailboxcreate.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/mailboxdelete.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/mailboxdelete.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/mailboxrename.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/mailboxrename.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/mailboxsubscribe.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/mailboxsubscribe.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/mailboxunsubscribe.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/mailboxunsubscribe.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/messageappend.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/messageappend.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """
@@ -27,11 +28,11 @@
     event = 'MessageAppend'
 
     def __init__(self, *args, **kw):
-        MessageHandlerBase.__init__(self, *args, **kw)
+        super(MessageAppendHandler, self).__init__(*args, **kw)
 
     def run(self, notification):
         # call super for some basic notification processing
-        (notification, jobs) = super(MessageHandlerBase, self).run(notification)
+        (notification, jobs) = super(MessageAppendHandler, self).run(notification)
 
         if not notification.has_key('messageContent') or notification['messageContent'] in [None, ""]:
             self.log.debug("Adding FETCH job for " + self.event, level=8)

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/messagebase.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/messagebase.py Changed

@@ -1,40 +1,46 @@
 # -*- coding: utf-8 -*-
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
-# Thomas Bruederli <bruederli at kolabsys.com>
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-"""
-    Base handler for an event notification of type 'Message*'
-"""
-
 import bonnie
+
+from bonnie.utils import parse_imap_uri
 from bonnie.worker.handlers import HandlerBase
 
 class MessageHandlerBase(HandlerBase):
     event = None
 
     def __init__(self, *args, **kw):
-        HandlerBase.__init__(self, *args, **kw)
+        super(MessageHandlerBase, self).__init__(*args, **kw)
         self.log = bonnie.getLogger('bonnie.worker.' + self.event)
 
     def run(self, notification):
         # call super for some basic notification processing
         (notification, jobs) = super(MessageHandlerBase, self).run(notification)
 
+        # Insert the URI UID (if it exists) in to uidset for further handlers
+        if notification.has_key('uri') and notification.has_key('uidset'):
+            uri = parse_imap_uri(notification['uri'])
+
+            if uri.has_key('UID'):
+                notification['uidset'] = uri['UID']
+
         # message notifications require message headers
         if not notification.has_key('messageHeaders'):
             self.log.debug("Adding HEADER job for " + self.event, level=8)

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/messagecopy.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/messagecopy.py Changed

@@ -2,28 +2,29 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-"""
-    Base handler for an event notification of type 'MessageCopy'
-"""
-
 from bonnie.worker.handlers import MessageHandlerBase
 
 class MessageCopyHandler(MessageHandlerBase):
+    """
+        Handler for a *MessageCopy* event.
+    """
+
     event = 'MessageCopy'
 
     def __init__(self, *args, **kw):

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/messageexpire.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/messageexpire.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/messageexpunge.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/messageexpunge.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/messagemove.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/messagemove.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/messagenew.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/messagenew.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """
@@ -27,4 +28,4 @@
     event = 'MessageNew'
 
     def __init__(self, *args, **kw):
-        MessageAppendHandler.__init__(self, *args, **kw)
+        super(MessageNewHandler, self).__init__(*args, **kw)

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/messageread.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/messageread.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/messagetrash.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/messagetrash.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/quotachange.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/quotachange.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/quotaexceeded.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/quotaexceeded.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/handlers/quotawithin.py -> bonnie-0.3.0.tar.gz/bonnie/worker/handlers/quotawithin.py Changed

@@ -2,19 +2,20 @@
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later version
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """

bonnie-0.2.2.tar.gz/bonnie/worker/inputs/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/worker/inputs/__init__.py Changed

bonnie-0.2.2.tar.gz/bonnie/worker/inputs/zmq_input.py -> bonnie-0.3.0.tar.gz/bonnie/worker/inputs/zmq_input.py Changed

@@ -1,23 +1,21 @@
 # -*- coding: utf-8 -*-
-#
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 """
@@ -27,6 +25,7 @@
 """
 
 import os
+import random
 import socket
 import time
 import zmq
@@ -43,6 +42,7 @@
         self.job_uuid = None
         self.lastping = 0
         self.report_timestamp = 0
+        self.busy_start = 0
 
     def name(self):
         return 'zmq_input'
@@ -51,6 +51,9 @@
         pass
 
     def report_state(self):
+        if self.busy_start < (time.time() - 90):
+            self.set_state_ready()
+
         log.debug("[%s] reporting state: %s" % (self.identity, self.state), level=8)
         message = [b"STATE", self.state]
 
@@ -106,7 +109,7 @@
 
             now = time.time()
 
-            if self.report_timestamp < (now - 60):
+            if self.report_timestamp < (time.time() - 10):
                 self.report_state()
 
             if self.controller in sockets:
@@ -145,11 +148,15 @@
                             self.controller.send_multipart([b"DONE", self.job_uuid])
                         else:
                             log.debug("[%s] Has jobs: %r" % (self.identity, jobs), level=8)
-                            self.controller.send_multipart([b" ".join(jobs), self.job_uuid])
+
+                            if b'POSTPONE' in jobs:
+                                self.controller.send_multipart([b'POSTPONE', self.job_uuid])
+                            else:
+                                self.controller.send_multipart([b'COLLECT', b" ".join(jobs), self.job_uuid, notification])
 
                         self.set_state_ready()
 
-            if report is not None and self.lastping < (now - 60):
+            if report is not None and self.lastping < (now - random.randint(55,65)):
                 report()
                 self.lastping = now
 
@@ -159,6 +166,7 @@
     def set_state_busy(self, _job_id):
         log.debug("[%s] Set state to BUSY" % (self.identity), level=9)
         self.report_timestamp = time.time()
+        self.busy_start = time.time()
         self.state = b"BUSY"
         self.job_uuid = _job_id

bonnie-0.2.2.tar.gz/bonnie/worker/outputs/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/worker/outputs/__init__.py Changed

bonnie-0.2.2.tar.gz/bonnie/worker/outputs/elasticsearch_output.py -> bonnie-0.3.0.tar.gz/bonnie/worker/outputs/elasticsearch_output.py Changed

@@ -1,3 +1,23 @@
+# -*- coding: utf-8 -*-
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
+#
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 import datetime
 
 from dateutil.parser import parse
@@ -58,6 +78,7 @@
             }
 
         log = { '@version': bonnie.API_VERSION }
+
         for key,val in notification.iteritems():
             newkey = keymap[key] if keymap.has_key(key) else key
             if newkey is not None:

bonnie-0.2.2.tar.gz/bonnie/worker/storage/__init__.py -> bonnie-0.3.0.tar.gz/bonnie/worker/storage/__init__.py Changed

bonnie-0.2.2.tar.gz/bonnie/worker/storage/caching.py -> bonnie-0.3.0.tar.gz/bonnie/worker/storage/caching.py Changed

@@ -1,22 +1,21 @@
 # -*- coding: utf-8 -*-
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
-# Thomas Bruederli <bruederli at kolabsys.com>
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
-# This program is distributed in the hope that it will be useful, but
-# WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Library General Public License for more details.
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import time

bonnie-0.2.2.tar.gz/bonnie/worker/storage/elasticsearch_storage.py -> bonnie-0.3.0.tar.gz/bonnie/worker/storage/elasticsearch_storage.py Changed

@@ -1,23 +1,21 @@
 # -*- coding: utf-8 -*-
-#
 # Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
 #
 # Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
 #
-# This program is free software; you can redistribute it and/or modify
+# This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; version 3 or, at your option, any later
-# version.
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Library General Public License for more details.
+# GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
-# USA.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
 import re
@@ -49,16 +47,20 @@
     users_doctype = 'user'
 
     def __init__(self, *args, **kw):
-        elasticsearch_output_address = conf.get('worker', 'elasticsearch_storage_address')
+        elasticsearch_output_address = conf.get(
+                'worker',
+                'elasticsearch_storage_address'
+            )
 
         if elasticsearch_output_address == None:
             elasticsearch_output_address = 'localhost'
 
         self.es = elasticsearch.Elasticsearch(
-            host=elasticsearch_output_address
-        )
+                host=elasticsearch_output_address
+            )
 
-        # use dicts with automatic expiration for caching user/folder lookups
+        # use dicts with automatic expiration for caching user/folder
+        # lookups
         self.user_id_cache = CachedDict(300)
         self.folder_id_cache = CachedDict(120)
 
@@ -67,11 +69,20 @@
 
     def register(self, callback, **kw):
         if callback is not None:
-            self.worker = callback(interests={
-                'uidset': { 'callback': self.resolve_folder_uri },
-                'folder_uniqueid': { 'callback': self.resolve_folder_uri },
-                'mailboxID': { 'callback': self.resolve_folder_uri, 'kw': { 'attrib': 'mailboxID' } }
-            })
+            self.worker = callback(
+                    interests = {
+                            'uidset': {
+                                    'callback': self.resolve_folder_uri
+                                },
+                            'folder_uniqueid': {
+                                    'callback': self.resolve_folder_uri
+                                },
+                            'mailboxID': {
+                                    'callback': self.resolve_folder_uri,
+                                    'kw': { 'attrib': 'mailboxID' }
+                                }
+                        }
+                )
 
     def get(self, key, index=None, doctype=None, fields=None, **kw):
         """
@@ -81,85 +92,128 @@
         _doctype = doctype or self.default_doctype
         try:
             res = self.es.get(
-                index=_index,
-                doc_type=_doctype,
-                id=key,
-                _source_include=fields or '*'
-            )
-            log.debug("ES get result for %s/%s/%s: %r" % (_index, _doctype, key, res), level=8)
+                    index = _index,
+                    doc_type = _doctype,
+                    id = key,
+                    _source_include = fields or '*'
+                )
+
+            log.debug(
+                    "ES get result for %s/%s/%s: %r" % (
+                            _index,
+                            _doctype,
+                            key,
+                            res
+                        ),
+                    level = 8
+                )
 
             if res['found']:
                 result = self._transform_result(res)
             else:
                 result = None
 
-        except elasticsearch.exceptions.NotFoundError, e:
-            log.debug("ES entry not found for %s/%s/%s: %r" % (_index, _doctype, key, e))
+        except elasticsearch.exceptions.NotFoundError, errmsg:
+            log.debug(
+                    "ES entry not found for %s/%s/%s: %r" % (
+                            _index,
+                            _doctype,
+                            key,
+                            errmsg
+                        )
+                )
+
             result = None
 
-        except Exception, e:
-            log.warning("ES get exception: %r", e)
+        except Exception, errmsg:
+            log.warning("ES get exception: %r" % (errmsg))
             result = None
 
         return result
 
-
     def set(self, key, value, index=None, doctype=None, **kw):
         """
             Standard API for writing to key/value storage
         """
         _index = index or self.default_index
         _doctype = doctype or self.default_doctype
+
         try:
             existing = self.es.get(
-                index=_index,
-                doc_type=_doctype,
-                id=key,
-                fields=None
-            )
-            log.debug("ES get result for %s/%s/%s: %r" % (_index, _doctype, key, existing), level=8)
+                    index = _index,
+                    doc_type = _doctype,
+                    id = key,
+                    fields = None
+                )
 
-        except elasticsearch.exceptions.NotFoundError, e:
+            log.debug(
+                    "ES get result for %s/%s/%s: %r" % (
+                            _index,
+                            _doctype,
+                            key,
+                            existing
+                        ),
+                    level = 8
+                )
+
+        except elasticsearch.exceptions.NotFoundError, errmsg:
             existing = None
 
-        except Exception, e:
-            log.warning("ES get exception: %r", e)
+        except Exception, errmsg:
+            log.warning("ES get exception: %r" % (errmsg))
             existing = None
 
         if existing is None:
             try:
                 ret = self.es.create(
-                    index=_index,
-                    doc_type=_doctype,
-                    id=key,
-                    body=value,
-                    consistency='one',
-                    replication='async'
-                )
-                log.debug("Created ES object for %s/%s/%s: %r" % (_index, _doctype, key, ret), level=8)
-
-            except Exception, e:
-                log.warning("ES create exception: %r", e)
+                        index = _index,
+                        doc_type = _doctype,
+                        id = key,
+                        body = value,
+                        consistency = 'one',
+                        replication = 'async'
+                    )
+
+                log.debug(
+                        "Created ES object for %s/%s/%s: %r" % (
+                                _index,
+                                _doctype,
+                                key,
+                                ret
+                            ),
+                        level = 8
+                    )
+
+            except Exception, errmsg:
+                log.warning("ES create exception: %r" % (errmsg))
                 ret = None
+
         else:
             try:
                 ret = self.es.update(
-                    index=_index,
-                    doc_type=_doctype,
-                    id=key,
-                    body={ 'doc': value },
-                    consistency='one',
-                    replication='async'
-                )
-                log.debug("Updated ES object for %s/%s/%s: %r" % (_index, _doctype, key, ret), level=8)
-
-            except Exception, e:
-                log.warning("ES update exception: %r", e)
+                        index = _index,
+                        doc_type = _doctype,
+                        id = key,
+                        body = { 'doc': value },
+                        consistency = 'one',
+                        replication = 'async'
+                    )
+
+                log.debug(
+                        "Updated ES object for %s/%s/%s: %r" % (
+                                _index,
+                                _doctype,
+                                key,
+                                ret
+                            ),
+                        level = 8
+                    )
+
+            except Exception, errmsg:
+                log.warning("ES update exception: %r" % (errmsg))
 
         return ret
 
-
-
     def select(self, query, index=None, doctype=None, fields=None, sortby=None, limit=None, **kw):
         """
             Standard API for querying storage
@@ -176,7 +230,11 @@
             @param limit:   Number of records to return
         """
         result = None
-        args = dict(index=index or self.default_index, doc_type=doctype or self.default_doctype, _source_include=fields or '*')
+        args = dict(
+                index = index or self.default_index,
+                doc_type = doctype or self.default_doctype,
+                _source_include = fields or '*'
+            )
 
         if isinstance(query, dict):
             args['body'] = query
@@ -192,14 +250,27 @@
 
         try:
             res = self.es.search(**args)
-            log.debug("ES select result for %r: %r" % (args['q'] or args['body'], res), level=8)
+            log.debug(
+                    "ES select result for %r: %r" % (
+                            args['q'] or args['body'],
+                            res
+                        ),
+                    level = 8
+                )
+
+        except elasticsearch.exceptions.NotFoundError, errmsg:
+            log.debug(
+                    "ES entry not found for %r: %r" % (
+                            args['q'] or args['body'],
+                            errmsg
+                        ),
+                    level = 8
+                )
 
-        except elasticsearch.exceptions.NotFoundError, e:
-            log.debug("ES entry not found for %r: %r", args['q'] or args['body'], e)
             res = None
 
-        except Exception, e:
-            log.warning("ES get exception: %r", e)
+        except Exception, errmsg:
+            log.warning("ES get exception: %r" % (errmsg))
             res = None
 
         if res is not None and res.has_key('hits'):
@@ -212,7 +283,8 @@
 
     def _build_query(self, params, boolean='AND'):
         """
-            Convert the given list of query parameters into a Lucene query string
+            Convert the given list of query parameters into a Lucene
+            query string.
         """
         query = []
         for p in params:
@@ -258,7 +330,8 @@
 
     def resolve_username(self, user, user_data=None, force=False):
         """
-            Resovle the given username to the corresponding nsuniqueid from LDAP
+            Resolve the given username to the corresponding nsuniqueid
+            from LDAP
         """
         if not '@' in user:
             return user
@@ -288,8 +361,16 @@
             # insert a user record into our database
             del user_data['id']
             user_data['user'] = user
-            user_data['@timestamp'] = datetime.datetime.now(tzutc()).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
-            self.set(user_id, user_data, index=self.users_index, doctype=self.users_doctype)
+            user_data['@timestamp'] = datetime.datetime.now(
+                    tzutc()
+                ).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
+
+            self.set(
+                    user_id,
+                    user_data,
+                    index=self.users_index,
+                    doctype=self.users_doctype
+                )
 
         elif force:
             user_id = hashlib.md5(user).hexdigest()
@@ -304,8 +385,8 @@
     def notificaton2folder(self, notification, attrib='uri'):
         """
             Turn the given notification record into a folder document.
-            including the computation of a unique identifier which is a checksum
-            of the (relevant) folder properties.
+            including the computation of a unique identifier which is a
+            checksum of the (relevant) folder properties.
         """
         # split the uri parameter into useful parts
         uri = parse_imap_uri(notification[attrib])
@@ -319,57 +400,91 @@
         if not notification.has_key('metadata'):
             return False
 
-        if not notification.has_key('folder_uniqueid') and notification['metadata'].has_key('/shared/vendor/cmu/cyrus-imapd/uniqueid'):
+        if not notification.has_key('folder_uniqueid') and \
+                notification['metadata'].has_key(
+                        '/shared/vendor/cmu/cyrus-imapd/uniqueid'
+                    ):
+
             notification['folder_uniqueid'] = notification['metadata']['/shared/vendor/cmu/cyrus-imapd/uniqueid']
 
         if not notification.has_key('folder_uniqueid'):
-            notification['folder_uniqueid'] = hashlib.md5(notification[attrib]).hexdigest()
+            notification['folder_uniqueid'] = hashlib.md5(
+                    notification[attrib]
+                ).hexdigest()
 
         body = {
-            '@version': bonnie.API_VERSION,
-            '@timestamp': datetime.datetime.now(tzutc()).strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
-            'uniqueid': notification['folder_uniqueid'],
-            'metadata': notification['metadata'],
-            'acl': dict((self.resolve_username(k, force=True),v) for k,v in notification['acl'].iteritems()),
-            'type': notification['metadata']['/shared/vendor/kolab/folder-type'] if notification['metadata'].has_key('/shared/vendor/kolab/folder-type') else 'mail',
-            'owner': uri['user'] + '@' + uri['domain'] if uri['user'] is not None else 'nobody',
-            'server': uri['host'],
-            'name': re.sub('@.+$', '', uri['path']),
-            'uri': folder_uri,
-        }
+                '@version': bonnie.API_VERSION,
+                '@timestamp': datetime.datetime.now(
+                        tzutc()
+                    ).strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
+
+                'uniqueid': notification['folder_uniqueid'],
+                'metadata': notification['metadata'],
+                'acl': dict(
+                        (self.resolve_username(k, force=True),v) for k,v in notification['acl'].iteritems()
+                    ),
+
+                'type': notification['metadata']['/shared/vendor/kolab/folder-type'] if notification['metadata'].has_key('/shared/vendor/kolab/folder-type') else 'mail',
+
+                'owner': uri['user'] + '@' + uri['domain'] if uri['user'] is not None else 'nobody',
+                'server': uri['host'],
+                'name': re.sub('@.+$', '', uri['path']),
+                'uri': folder_uri,
+            }
 
         # compute folder object signature and the unique identifier
-        ignore_metadata = ['/shared/vendor/cmu/cyrus-imapd/lastupdate', '/shared/vendor/cmu/cyrus-imapd/pop3newuidl', '/shared/vendor/cmu/cyrus-imapd/size']
+        ignore_metadata = [
+                '/shared/vendor/cmu/cyrus-imapd/lastupdate',
+                '/shared/vendor/cmu/cyrus-imapd/pop3newuidl',
+                '/shared/vendor/cmu/cyrus-imapd/size'
+            ]
+
         signature = {
-            '@version': bonnie.API_VERSION,
-            'owner': body['owner'],
-            'server': body['server'],
-            'uniqueid': notification['folder_uniqueid'],
-            'metadata': [(k,v) for k,v in sorted(body['metadata'].iteritems()) if k not in ignore_metadata],
-            'acl': [(k,v) for k,v in sorted(body['acl'].iteritems())],
-        }
-        serialized = ";".join("%s:%s" % (k,v) for k,v in sorted(signature.iteritems()))
+                '@version': bonnie.API_VERSION,
+                'owner': body['owner'],
+                'server': body['server'],
+                'uniqueid': notification['folder_uniqueid'],
+                'metadata': [
+                        (k,v) for k,v in sorted(body['metadata'].iteritems()) if k not in ignore_metadata
+                    ],
+
+                'acl': [
+                        (k,v) for k,v in sorted(body['acl'].iteritems())
+                    ],
+            }
+
+        serialized = ";".join(
+                "%s:%s" % (k,v) for k,v in sorted(signature.iteritems())
+            )
+
         folder_id = hashlib.md5(serialized).hexdigest()
 
         return dict(id=folder_id, body=body)
 
-
     def resolve_folder_uri(self, notification, attrib='uri'):
         """
-            Resolve the folder uri (or folder_uniqueid) into an elasticsearch object ID
+            Resolve the folder uri (or folder_uniqueid) into an
+            elasticsearch object ID.
         """
         # no folder resolving required
-        if not notification.has_key(attrib) or notification.has_key('folder_id'):
+        if not notification.has_key(attrib) or \
+                notification.has_key('folder_id'):
+
             return (notification, [])
 
         now = int(time.time())
         base_uri = re.sub(';.+$', '', notification[attrib])
         jobs = []
 
-        log.debug("Resolve folder for %r = %r" % (attrib, base_uri), level=8)
+        log.debug(
+                "Resolve folder for %r = %r" % (attrib, base_uri),
+                level = 8
+            )
 
         # return id cached in memory
-        if not notification.has_key('metadata') and self.folder_id_cache.has_key(base_uri):
+        if not notification.has_key('metadata') and \
+                self.folder_id_cache.has_key(base_uri):
+
             notification['folder_id'] = self.folder_id_cache[base_uri]
             return (notification, [])
 
@@ -387,7 +502,8 @@
         if len(jobs) > 0:
             return (notification, jobs)
 
-        # extract folder properties and a unique identifier from the notification
+        # extract folder properties and a unique identifier from the
+        # notification
         folder = self.notificaton2folder(notification)
 
         # abort if notificaton2folder() failed
@@ -404,38 +520,46 @@
 
         # create an entry for the referenced imap folder
         if existing is None:
-            log.debug("Create folder object for: %r" % (folder['body']['uri']), level=8)
+            log.debug(
+                    "Create folder object for: %r" % (
+                            folder['body']['uri']
+                        ),
+                    level = 8
+                )
 
             ret = self.set(
-                index=self.folders_index,
-                doctype=self.folders_doctype,
-                key=folder['id'],
-                value=folder['body']
-            )
+                    index = self.folders_index,
+                    doctype = self.folders_doctype,
+                    key = folder['id'],
+                    value = folder['body']
+                )
+
             if ret is None:
                 folder = None
 
         # update entry if name changed
         elif folder['body']['uniqueid'] == existing['uniqueid'] and \
-            not folder['body']['name'] == existing['name']:
+                not folder['body']['name'] == existing['name']:
+
             try:
                 ret = self.es.update(
-                    index=self.folders_index,
-                    doc_type=self.folders_doctype,
-                    id=folder['id'],
-                    body={ 'doc': {
-                            'name': folder['body']['name'],
-                            'uri': folder['body']['uri']
-                        }
-                    },
-                    consistency='one',
-                    replication='async'
-                )
-                log.debug("Updated folder object: %r" % (ret), level=8)
+                        index = self.folders_index,
+                        doc_type = self.folders_doctype,
+                        id = folder['id'],
+                        body = {
+                                'doc': {
+                                        'name': folder['body']['name'],
+                                        'uri': folder['body']['uri']
+                                    }
+                            },
+                        consistency = 'one',
+                        replication = 'async'
+                    )
 
-            except Exception, e:
-                log.warning("ES update exception: %r", e)
+                log.debug("Updated folder object: %r" % (ret), level=8)
 
+            except Exception, errmsg:
+                log.warning("ES update exception: %r" % (errmsg))
 
         # add reference to internal folder_id
         if folder is not None:

bonnie-0.2.2.tar.gz/broker.py -> bonnie-0.3.0.tar.gz/broker.py Changed

bonnie-0.2.2.tar.gz/collector.py -> bonnie-0.3.0.tar.gz/collector.py Changed

bonnie-0.3.0.tar.gz/dealer-async.py Added

@@ -0,0 +1,35 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
+#
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+import json
+import os
+import sys
+
+from bonnie.dealer import BonnieDealer
+
+if __name__ == "__main__":
+    notification = sys.stdin.read().strip()
+
+    newpid = os.fork()
+
+    if newpid == 0:
+        dealer = BonnieDealer()
+        dealer.run(notification)

bonnie-0.3.0.tar.gz/dealer-sync.py Added

@@ -0,0 +1,38 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
+#
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+import json
+import os
+import sys
+
+from bonnie.dealer import BonnieDealer
+
+if __name__ == "__main__":
+    notification = sys.stdin.read().strip()
+
+    dealer = BonnieDealer()
+    dealer.run(notification)
+
+#    newpid = os.fork()
+#
+#    if newpid == 0:
+#        dealer = BonnieDealer()
+#        dealer.run(notification)

bonnie-0.3.0.tar.gz/docs Added

bonnie-0.3.0.tar.gz/docs/Makefile Added

@@ -0,0 +1,153 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Bonnie.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Bonnie.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/Bonnie"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Bonnie"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

bonnie-0.3.0.tar.gz/docs/_static Added

bonnie-0.3.0.tar.gz/docs/_static/basic.css_t Added

@@ -0,0 +1,541 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+    clear: both;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+    width: 100%;
+    font-size: 90%;
+}
+
+div.related h3 {
+    display: none;
+}
+
+div.related ul {
+    margin: 0;
+    padding: 0 0 0 10px;
+    list-style: none;
+}
+
+div.related li {
+    display: inline;
+}
+
+div.related li.right {
+    float: right;
+    margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+    padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+    float: left;
+    width: 230px;
+    margin-left: -100%;
+    font-size: 90%;
+}
+
+div.sphinxsidebar ul {
+    list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+    margin-left: 20px;
+    list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+    margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+    border: 1px solid #98dbcc;
+    font-family: sans-serif;
+    font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+    width: 170px;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+    width: 30px;
+}
+
+img {
+    max-width: 100%;
+    border: 0;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+    margin: 10px 0 0 20px;
+    padding: 0;
+}
+
+ul.search li {
+    padding: 5px 0 5px 20px;
+    background-image: url(file.png);
+    background-repeat: no-repeat;
+    background-position: 0 7px;
+}
+
+ul.search li a {
+    font-weight: bold;
+}
+
+ul.search li div.context {
+    color: #888;
+    margin: 2px 0 0 30px;
+    text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+    font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+    width: 90%;
+}
+
+table.contentstable p.biglink {
+    line-height: 150%;
+}
+
+a.biglink {
+    font-size: 1.3em;
+}
+
+span.linkdescr {
+    font-style: italic;
+    padding-top: 5px;
+    font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+    width: 100%;
+}
+
+table.indextable td {
+    text-align: left;
+    vertical-align: top;
+}
+
+table.indextable dl, table.indextable dd {
+    margin-top: 0;
+    margin-bottom: 0;
+}
+
+table.indextable tr.pcap {
+    height: 10px;
+}
+
+table.indextable tr.cap {
+    margin-top: 10px;
+    background-color: #f2f2f2;
+}
+
+img.toggler {
+    margin-right: 3px;
+    margin-top: 3px;
+    cursor: pointer;
+}
+
+div.modindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+a.headerlink {
+    visibility: hidden;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink {
+    visibility: visible;
+}
+
+div.body p.caption {
+    text-align: inherit;
+}
+
+div.body td {
+    text-align: left;
+}
+
+.field-list ul {
+    padding-left: 1em;
+}
+
+.first {
+    margin-top: 0 !important;
+}
+
+p.rubric {
+    margin-top: 30px;
+    font-weight: bold;
+}
+
+img.align-left, .figure.align-left, object.align-left {
+    clear: left;
+    float: left;
+    margin-right: 1em;
+}
+
+img.align-right, .figure.align-right, object.align-right {
+    clear: right;
+    float: right;
+    margin-left: 1em;
+}
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+    text-align: left;
+}
+
+.align-center {
+    text-align: center;
+}
+
+.align-right {
+    text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar {
+    margin: 0 0 0.5em 1em;
+    border: 1px solid #ddb;
+    padding: 7px 7px 0 7px;
+    background-color: #ffe;
+    width: 40%;
+    float: right;
+}
+
+p.sidebar-title {
+    font-weight: bold;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+
+div.topic {
+    border: 1px solid #ccc;
+    padding: 7px 7px 0 7px;
+    margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+    font-size: 1.1em;
+    font-weight: bold;
+    margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+    margin-top: 10px;
+    margin-bottom: 10px;
+    padding: 7px;
+}
+
+div.admonition dt {
+    font-weight: bold;
+}
+
+div.admonition dl {
+    margin-bottom: 0;
+}
+
+p.admonition-title {
+    margin: 0px 10px 5px 0px;
+    font-weight: bold;
+}
+
+div.body p.centered {
+    text-align: center;
+    margin-top: 25px;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+    border: 0;
+    border-collapse: collapse;
+}
+
+table.docutils td, table.docutils th {
+    padding: 1px 8px 1px 5px;
+    border-top: 0;
+    border-left: 0;
+    border-right: 0;
+    border-bottom: 1px solid #aaa;
+}
+
+table.field-list td, table.field-list th {
+    border: 0 !important;
+}
+
+table.footnote td, table.footnote th {
+    border: 0 !important;
+}
+
+th {
+    text-align: left;
+    padding-right: 5px;
+}
+
+table.citation {
+    border-left: solid 1px gray;
+    margin-left: 1px;
+}
+
+table.citation td {
+    border-bottom: none;
+}
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+    list-style: decimal;
+}
+
+ol.loweralpha {
+    list-style: lower-alpha;
+}
+
+ol.upperalpha {
+    list-style: upper-alpha;
+}
+
+ol.lowerroman {
+    list-style: lower-roman;
+}
+
+ol.upperroman {
+    list-style: upper-roman;
+}
+
+dl {
+    margin-bottom: 15px;
+}
+
+dd p {
+    margin-top: 0px;
+}
+
+dd ul, dd table {
+    margin-bottom: 10px;
+}
+
+dd {
+    margin-top: 3px;
+    margin-bottom: 10px;
+    margin-left: 30px;
+}
+
+dt:target, .highlighted {
+    background-color: #fbe54e;
+}
+
+dl.glossary dt {
+    font-weight: bold;
+    font-size: 1.1em;
+}
+
+.field-list ul {
+    margin: 0;
+    padding-left: 1em;
+}
+
+.field-list p {
+    margin: 0;
+}
+
+.refcount {
+    color: #060;
+}
+
+.optional {
+    font-size: 1.3em;
+}
+
+.versionmodified {
+    font-style: italic;
+}
+
+.system-message {
+    background-color: #fda;
+    padding: 5px;
+    border: 3px solid red;
+}
+
+.footnote:target  {
+    background-color: #ffa;
+}
+
+.line-block {
+    display: block;
+    margin-top: 1em;
+    margin-bottom: 1em;
+}
+
+.line-block .line-block {
+    margin-top: 0;
+    margin-bottom: 0;
+    margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+    font-family: sans-serif;
+}
+
+.accelerator {
+    text-decoration: underline;
+}
+
+.classifier {
+    font-style: oblique;
+}
+
+abbr, acronym {
+    border-bottom: dotted 1px;
+    cursor: help;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+    overflow: auto;
+    overflow-y: hidden;  /* fixes display issues on Chrome browsers */
+}
+
+td.linenos pre {
+    padding: 5px 0px;
+    border: 0;
+    background-color: transparent;
+    color: #aaa;
+}
+
+table.highlighttable {
+    margin-left: 0.5em;
+}
+
+table.highlighttable td {
+    padding: 0 0.5em 0 0.5em;
+}
+
+tt.descname {
+    background-color: transparent;
+    font-weight: bold;
+    font-size: 1.2em;
+}
+
+tt.descclassname {
+    background-color: transparent;
+}
+
+tt.xref, a tt {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
+    background-color: transparent;
+}
+
+.viewcode-link {
+    float: right;
+}
+
+.viewcode-back {
+    float: right;
+    font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+    margin: -1px -10px;
+    padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+    vertical-align: middle;
+}
+
+div.body div.math p {
+    text-align: center;
+}
+
+span.eqno {
+    float: right;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+    div.document,
+    div.documentwrapper,
+    div.bodywrapper {
+        margin: 0 !important;
+        width: 100%;
+    }
+
+    div.sphinxsidebar,
+    div.related,
+    div.footer,
+    #top-link {
+        display: none;
+    }
+}

bonnie-0.3.0.tar.gz/docs/_static/images Added

bonnie-0.3.0.tar.gz/docs/_static/images/bonnie_jobs_done-pinpoint=1417359241,1417411037.png Added

bonnie-0.3.0.tar.gz/docs/_static/images/bonnie_jobs_pending-pinpoint=1417359574,1417411771.png Added

bonnie-0.3.0.tar.gz/docs/about Added

bonnie-0.3.0.tar.gz/docs/about/archival.rst Added

bonnie-0.3.0.tar.gz/docs/about/backup-and-restore.rst Added

bonnie-0.3.0.tar.gz/docs/about/data-loss-prevention.rst Added

bonnie-0.3.0.tar.gz/docs/about/e-discovery.rst Added

bonnie-0.3.0.tar.gz/docs/architecture-and-design.rst Added

@@ -0,0 +1,1860 @@
+:tocdepth: 2
+
+.. _architecture-and-design:
+
+=======================
+Architecture and Design
+=======================
+
+Bonnie receives and parses :term:`event notifications` issued by Cyrus
+IMAP 2.5.
+
+An event notification is issued when a user logs on or off, and when a
+user makes a change to a mailbox or message.
+
+These event notifications are used to build the data sets for each of
+the following features included with Bonnie;
+
+    *   :ref:`about-archival`
+
+    *   :ref:`about-backup-and-restore`
+
+    *   :ref:`about-e-discovery`
+
+    *   :ref:`about-data-loss-prevention`
+
+These features are (each of them) optional, in that a deployment used
+solely for e-Discovery does not imply the inclusion of the other
+features, and most feature descriptions use super-nomenclature for
+otherwise limited, self-contained facilities that tend to serve a more
+narrow purpose.
+
+One example is a ``changelog`` module, which can be used to preserve
+selected subsets of data, such as "who changed what in an event". This
+particular module would fall under the category of e-Discovery, but not
+include the full feature-set of e-Discovery.
+
+.. rubric:: Technology Base
+
+The initial design of Bonnie is created with the following technologies
+as the basis:
+
+    *   Elasticsearch
+    *   ZeroMQ
+
+The functional components that make up a complete Bonnie environment are
+designed to be pluggable such that one or more extensions can be used
+for either of the following channels:
+
+**input**
+
+    Used to receive new event notifications, or jobs, to be handled.
+
+**storage**
+
+    Used to store event notifications, queues and/or metadata.
+
+**output**
+
+    The final and persistent record(s) of state.
+
+To parse information in to useful, digestible chunks, Bonnie uses
+so-called *handlers*, that subscribe to event notifications using
+*interests*.
+
+For example, a *Logout* event is only stored to the output channel,
+should a corresponding *Login* event be available. After all, there must
+not be a *Logout* event without a *Login* event also having occurred.
+
+A handler interested in the *Logout* event uses the storage channel to
+determine the corresponding *Login* event is indeed available.
+
+This storage channel may be configured to be an intermediate buffer,
+that holds all *Login* events until after the corresponding *Logout*
+event notification is received, or a timeout occurs, or may be
+configured to be the same channel as the output channel.
+
+Overview of Components
+======================
+
+The Bonnie infrastructure components are an add-on to an existing Cyrus
+IMAP environment, typically as part of a `Kolab Groupware`_ deployment.
+
+More detailed diagrams of communication flows in a standard Kolab
+Groupware environment are available in the
+`Kolab Groupware documentation`_, and are outside of the scope of the
+design documentation for Bonnie. Suffice it to say, that Kolab Groupware
+components communicate with Cyrus IMAP:
+
+.. graphviz::
+
+    digraph {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "Kolab Groupware";
+
+            "Cyrus IMAP";
+
+            "Kolab Groupware" -> "Cyrus IMAP" [dir=both];
+
+        }
+
+As Bonnie is added on top of this (existing) infrastructure the design
+overview for the infrastructure becomes:
+
+.. graphviz::
+
+    digraph {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "Kolab Groupware" [color=gray50,style=filled];
+
+            subgraph cluster_bonnie {
+                    label = "Bonnie Infrastructure";
+
+                    "Broker";
+
+                    subgraph cluster_imap {
+                            label = "IMAP Server";
+
+                            "Cyrus IMAP" [color=gray50,style=filled];
+
+                            "Collector";
+                            "Dealer";
+                        }
+
+                    "Worker";
+                }
+
+            "Kolab Groupware" -> "Cyrus IMAP" [dir=both];
+
+            "Cyrus IMAP" -> "Dealer";
+
+            "Dealer" -> "Broker";
+
+            "Broker" -> "Worker" [dir=both];
+
+            "Collector" -> "Broker" [dir=both];
+
+            "Worker" -> "Storage" [dir=both];
+
+        }
+
+The **Dealer** Component
+========================
+
+A dealer is a script executed once for each event notification, and is
+used to dispatch the event notification as fast and as efficient as
+possible.
+
+.. graphviz::
+
+    digraph {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "Kolab Groupware" [color=gray50,style=filled];
+
+            subgraph cluster_bonnie {
+                    label = "Bonnie Infrastructure";
+
+                    "Broker";
+
+                    subgraph cluster_imap {
+                            label = "IMAP Server";
+
+                            "Cyrus IMAP" [color=gray50,style=filled];
+
+                            "Collector";
+                            "Dealer" [color="green",style=filled];
+                        }
+
+                    "Worker";
+                }
+
+            "Kolab Groupware" -> "Cyrus IMAP" [dir=both];
+
+            "Cyrus IMAP" -> "Dealer";
+
+            "Dealer" -> "Broker";
+
+            "Broker" -> "Worker" [dir=both];
+
+            "Collector" -> "Broker" [dir=both];
+
+            "Worker" -> "Storage" [dir=both];
+
+        }
+
+The Cyrus IMAP server's notification daemon :manpage:`notifyd(1)`
+awaits the successful exit return code of the dealer script.
+
+Should the dealer script not complete in a timely fashion and take
+longer than anticipated, the Cyrus IMAP server will get congested and
+ultimately freeze.
+
+The default Bonnie dealer is made to fork to the background allowing the
+Cyrus IMAP server to continue without congestion. Using this
+asynchronous dealer counts toward the maximum number of processes.
+
+A synchronous dealer is also available, that does not fork to the
+background.
+
+The dealer script uses ``stdin`` for input, can be configured to use one
+or more storage data channels, and is configured to use one or more
+output channels such as ``file`` or ``zmq``.
+
+If applicable to the particular output channel used, in order to
+guarantee the delivery of the event notification, the dealer awaits
+confirmation of the event notification having been received.
+
+Supported Channels
+------------------
+
+Currently supported input channels:
+
+    *   ``sys.stdin``
+
+        .. versionadded:: 0.1.0
+
+Currently supported storage channels:
+
+    None
+
+Currently supported output channels:
+
+    *   File
+
+        Recommended only for troubleshooting and development.
+
+        .. versionadded:: 0.2.0
+
+    *   ZeroMQ
+
+        .. versionadded:: 0.1.0
+
+Component Design Diagram
+------------------------
+
+.. graphviz::
+
+    digraph dealer {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "input" -> "dealer" [label="(1)"];
+
+            "dealer" -> "dealer (fork)" [label="(2)"];
+
+            "dealer" -> "input" [label="return (3)"];
+
+            "dealer (fork)" -> "file output", "zmq output" [label="(4)",style=dotted,color=gray50];
+        }
+
+.. IMPORTANT::
+
+    The size of the datagram used to send event notifications to
+    :manpage:`notifyd(1)` is limited to 8192 bytes, too small for
+    complete message contents.
+
+.. NOTE::
+
+    While the dealer could be supplied with intelligence to retrieve
+    message contents, entertain handlers, and connect to output channels
+    directly, ...
+
+.. TODO::
+
+    A storage layer implementation for the dealer should allow a maximum
+    number of retries on the output channel, each of them failing, to
+    form a local buffer allowing the dealer to fail to deliver its event
+    notifications.
+
+.. TODO::
+
+    The :manpage:`notifyd(8)` daemon could be made to issue event
+    notifications on to a ZeroMQ message bus directly.
+
+    .. seealso::
+
+        *   :bugzilla:`4000`
+
+The **Broker** Component
+========================
+
+A broker receives the event notifications -- and, if appropriate,
+acknowledges their receipt -- before dispatching them in (generally) the
+right direction.
+
+.. graphviz::
+
+    digraph {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "Kolab Groupware" [color=gray50,style=filled];
+
+            subgraph cluster_bonnie {
+                    label = "Bonnie Infrastructure";
+
+                    "Broker";
+
+                    subgraph cluster_imap {
+                            label = "IMAP Server";
+
+                            "Cyrus IMAP" [color=gray50,style=filled];
+
+                            "Collector";
+                            "Dealer";
+                        }
+
+                    "Worker";
+                }
+
+            "Kolab Groupware" -> "Cyrus IMAP" [dir=both];
+
+            "Cyrus IMAP" -> "Dealer";
+
+            "Broker" [color="green",style=filled];
+
+            "Dealer" -> "Broker";
+
+            "Broker" -> "Worker" [dir=both];
+
+            "Collector" -> "Broker" [dir=both];
+
+            "Worker" -> "Storage" [dir=both];
+
+        }
+
+We say "generally the right direction", because the broker does not hold
+any processing intelligence, and as such it can only make routing
+decisions based on configured rules -- not necessarily the most
+appropriate, but conform a predictable process.
+
+One reason for the broker not holding any intelligence is that it must
+maintain a level of responsiveness in order for the dealer (for example)
+to receive its acknowledgements in a timely fashion.
+
+There is always a chance of processing of intelligence in program
+routines becoming overly burdensome compared to other tasks the program
+may also need to fulfill. Hence, the broker is a broker, and just that.
+
+Bonnie uses :ref:`architecture-and-design-the-worker-component` to hold
+the intelligence needed to fulfill functional requirements.
+
+The broker too uses one or more input modules to receive event
+notifications, maintains persistent queues in one or more configured
+storage channels, and dispatches event notifications over configured
+output channels.
+
+Supported Channels
+------------------
+
+Supported input channels include:
+
+    *   ZeroMQ
+
+        .. versionadded:: 0.2.3
+
+Supported storage channels include:
+
+    *   Databases supported by SQLAlchemy 0.8.0
+
+        .. versionadded:: 0.2.3
+
+Supported output channels include:
+
+    *   ZeroMQ
+
+        .. versionadded:: 0.2.3
+
+Component Design Diagram
+------------------------
+
+The overview of input, storage and output channels is quite standard
+from the perspective of the broker component:
+
+.. graphviz::
+
+    digraph broker {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "input" -> "input router" [label="(2)"];
+
+            "input router" -> "storage" [label="(3)"];
+
+            "input" -> "input router" [dir=back,label="(4)"];
+
+            "storage" -> "output router" [label="(5)"];
+
+            "output router" -> "output" [label="(6)"];
+        }
+
+Note that path from the original input to the job queue is largely a
+one-way street, with exception of the receipt confirmation.
+
+Zooming in to provide a little more detail when the broker uses ZeroMQ:
+
+.. graphviz::
+
+    digraph broker {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "input" -> "dealer" [label="(1)"];
+            "dealer" -> "dealer router" [label="(2)"];
+
+            subgraph cluster_broker {
+                    label = "Broker";
+                    color = gray90;
+                    style = filled;
+
+                    "dealer router";
+                    "job queue";
+                    "worker controller router";
+                    "worker router";
+                    "dot1" [style=dot,color=gray90,fontcolor=gray90];
+                    "dot2" [style=dot,color=gray90,fontcolor=gray90];
+                }
+
+            "dealer router" -> "job queue" [label="(3)"];
+            "dealer" -> "dealer router" [dir=back,label="(4)"];
+            "worker controller router" -> "worker" [dir=back,label="(5)"];
+            "job queue" -> "worker controller router" [dir=back,label="(6)"];
+            "job queue" -> "worker controller router" [label="(7)"];
+            "worker controller router" -> "worker" [label="(8)"];
+            "dot1" -> "dot2" -> "worker router" [dir=none,color=gray90];
+            "worker router" -> "worker" [dir=back,label="(9)"];
+            "worker router" -> "worker" [label="(10)"];
+            "worker controller router" -> "worker" [dir=back,label="(11)"];
+            "job queue" -> "worker controller router" [dir=back,label="(12)"];
+        }
+
+Because of the size of the original event notification datagram,
+additional information may need to be fetched. This information
+typically includes information available only on the original source of
+the event notification, such as message payload.
+
+.. graphviz::
+
+    digraph broker {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            subgraph cluster_broker {
+                    label = "Broker";
+                    color = gray90;
+                    style = filled;
+
+                    "dealer router";
+                    "job queue";
+                    "worker controller router";
+                    "worker router";
+                    "collector router";
+                    "dot1" [style=dot,color=gray90,fontcolor=gray90];
+                    "dot2" [style=dot,color=gray90,fontcolor=gray90];
+                }
+
+            "input" -> "dealer" [label="(1)"];
+            "dealer" -> "dealer router" [label="(2)"];
+            "dealer router" -> "job queue" [label="(3)"];
+            "dealer" -> "dealer router" [dir=back,label="(4)"];
+            "worker controller router" -> "worker" [dir=back,label="(5)"];
+            "job queue" -> "worker controller router" [dir=back,label="(6)"];
+            "job queue" -> "worker controller router" [label="(7)"];
+            "worker controller router" -> "worker" [label="(8)"];
+            "dot1" -> "dot2" -> "worker router" [dir=none,color=gray90];
+            "worker router" -> "worker" [dir=back,label="(9)"];
+            "worker router" -> "worker" [label="(10)"];
+            "worker controller router" -> "worker" [dir=back,label="(11)"];
+            "job queue" -> "worker controller router" [dir=back,label="(12)"];
+            "collector" -> "collector router" [label="(13)"];
+            "collector router" -> "job queue" [label="(14)"];
+            "collector router" -> "job queue" [dir=back,label="(15)"];
+            "collector" -> "collector router" [dir=back,label="(16)"];
+            "collector" -> "collector router" [label="(17)"];
+            "collector router" -> "job queue" [label="(18)"];
+        }
+
+.. _architecture-and-design-the-worker-component:
+
+The **Worker** Component
+========================
+
+The Bonnie worker is where the processing happens -- one can have as
+many workers as necessary, or as few as required.
+
+.. graphviz::
+
+    digraph {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "Kolab Groupware" [color=gray50,style=filled];
+
+            subgraph cluster_bonnie {
+                    label = "Bonnie Infrastructure";
+
+                    "Broker";
+
+                    subgraph cluster_imap {
+                            label = "IMAP Server";
+
+                            "Cyrus IMAP" [color=gray50,style=filled];
+
+                            "Collector";
+                            "Dealer";
+                        }
+
+                    "Worker" [color="green",style=filled];
+                }
+
+            "Kolab Groupware" -> "Cyrus IMAP" [dir=both];
+            "Cyrus IMAP" -> "Dealer";
+            "Broker";
+            "Dealer" -> "Broker";
+            "Broker" -> "Worker" [dir=both];
+            "Collector" -> "Broker" [dir=both];
+            "Worker" -> "Storage" [dir=both];
+        }
+
+The worker periodically announces its presence and state to the broker,
+which subsequently assigns jobs to the worker. The exchange of worker
+status and broker assigment messages occurs over a separate *controller*
+channel to allow a worker to take as much time as it needs to complete
+the necessary routines.
+
+.. graphviz::
+
+    digraph broker {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            subgraph cluster_broker {
+                    label = "Broker";
+                    color = gray90;
+                    style = filled;
+
+                    "job queue";
+                    "worker controller router";
+                    "worker router";
+                    "dot2" [style=dot,color=gray90,fontcolor=gray90];
+                }
+
+            "worker controller router" -> "worker" [dir=back,label="(5)"];
+            "job queue" -> "worker controller router" [dir=back,label="(6)"];
+            "job queue" -> "worker controller router" [label="(7)"];
+            "worker controller router" -> "worker" [label="(8)"];
+            "dot2" -> "worker router" [dir=none,color=gray90];
+            "worker router" -> "worker" [dir=back,label="(9)"];
+            "worker router" -> "worker" [label="(10)"];
+            "worker controller router" -> "worker" [dir=back,label="(11)"];
+            "job queue" -> "worker controller router" [dir=back,label="(12)"];
+        }
+
+The worker may require additional information to be obtained, such
+as the message payload [#]_.
+
+Component Design Diagram
+------------------------
+
+.. graphviz::
+
+    digraph broker {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+            fontname = Calibri;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            subgraph cluster_input {
+                    label = "input";
+                    color = gray90;
+                    style = filled;
+
+                    "job queue";
+                    "worker controller router";
+                    "worker router";
+                    "job queue" -> "worker controller router" [color=gray90,dir=none];
+                    "job queue" -> "worker router" [color=gray90,dir=none];
+
+            }
+
+            subgraph cluster_worker {
+                    label = "worker";
+                    color = gray90;
+                    style = filled;
+
+                    "worker controller dealer";
+                    "worker dealer";
+            }
+
+            "worker controller router" -> "worker controller dealer" [label="(8)"];
+            "worker controller dealer" -> "worker controller router" [label="(11)"];
+            "worker router" -> "worker dealer" [label="(10)"];
+            "worker router" -> "worker dealer" [dir=back,label="(11)"];
+            "worker dealer" -> "worker dealer" [label="(12)"];
+            "worker dealer" -> "storage" [label="(13)"];
+        }
+
+The **Collector** Component
+===========================
+
+    The collector daemon is an optional component subscribing to
+    requests for additional information that can only reliably be
+    obtained from a Cyrus IMAP backend spool directory.
+
+**System Log Centralization**
+
+    The centralization of system log files such as
+    :file:`/var/log/maillog` aids in tracing the exchange of messages as
+    they descend across infrastructure, and helps in associating, for
+    example, a Login event to an IMAP frontend with the corresponding
+    web server session [#]_.
+
+
+
+.. _architecture-and-design-figure-bonnie-jobs-done:
+
+.. figure:: _static/images/bonnie_jobs_done-pinpoint=1417359241,1417411037.png
+
+    Figure #1: Jobs processed per minute
+
+:ref:`architecture-and-design-figure-jobs-pending` graphs approximately
+90.000 email being delivered approximately 30.000 users and shows, in
+order of appearance;
+
+*16:00 - 17:00*
+
+    Initial submission of new event notifications at a rate of
+    approximately 25 event notifications per second.
+
+*16:00 - 17:00*
+
+    As soon as the first few event notifications are received, the
+    broker starts dispatching jobs to workers. Initially, all jobs are
+    worker jobs.
+
+    Workers may conclude extra information is needed, and cause the job
+    to subsequently be dispatched to collectors.
+
+    :ref:`architecture-and-design-figure-jobs-pending` clearly shows
+    divergence of the total number of jobs (yellow) and the number of
+    worker jobs in state pending (blue). It also shows the number of
+    collectors jobs rising (orange).
+
+    .. NOTE::
+
+        The broker may allocate more jobs to workers than there are
+        workers available (see :bugzilla:`4000`).
+
+    .. NOTE::
+
+        The broker considers the collectors are single-threaded, while
+        in fact they may be multi-threaded (see :bugzilla:`4000`).
+
+    .. NOTE::
+
+        The collector jobs likely lag behind worker jobs being
+        reassigned, because the broker intentionally dispatches worker
+        jobs before collector jobs.
+
+*17:00*
+
+    No more or few inbound event notifications. Collectors have started
+    to process, workers are starting to process jobs with complete data-
+    sets.
+
+*19:00 - 19:30*
+
+    Collector's processing of jobs surges (orange),
+
+    Number of pending jobs decreases (green),
+
+    Number of worker jobs stagnates (blue, collector jobs are updated to
+    become worker jobs),
+
+*01:00 - 01:30*
+
+    A new email is submitted to approximately 2200 recipients,
+    triggering new event notifications.
+
+*04:30*
+
+    Processing of collector jobs is completed, the remainder of pending
+    jobs is now equal to the remainder of pending worker jobs.
+
+*05:00 - 06:00*
+
+    The remainder of worker jobs over-allocated are unlocked and
+    processed.
+
+.. _architecture-and-design-figure-jobs-pending:
+
+.. figure:: _static/images/bonnie_jobs_pending-pinpoint=1417359574,1417411771.png
+
+    Figure #2: Job Queue Statistics
+
+Bonnie Design
+=============
+
+The Bonnie infrastructure components are an add-on to an existing Kolab
+Groupware environment, where Kolab communicates with Cyrus IMAP. More
+detailed diagrams of communication flows in a standard Kolab Groupware
+environment are available elsewhere in the documentation, and are
+outside of the scope of the functional design for Bonnie.
+
+.. graphviz::
+
+    digraph {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "Kolab Groupware";
+
+            "Cyrus IMAP";
+
+            "Kolab Groupware" -> "Cyrus IMAP" [dir=both,label="(1)"];
+
+        }
+
+As Bonnie is added on top of this (existing) infrastructure, and with
+Cyrus IMAP 2.5 event notification features enabled, the functional
+design for the infrastructure becomes:
+
+.. graphviz::
+
+    digraph {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "Kolab Groupware" [color=gray50,style=filled];
+
+            subgraph cluster_bonnie {
+                    label = "Bonnie Infrastructure";
+
+                    "Broker";
+
+                    subgraph cluster_imap {
+                            label = "IMAP Server";
+
+                            "Cyrus IMAP" [color=gray50,style=filled];
+
+                            "Collector";
+                            "Dealer";
+                        }
+
+                    "Worker";
+                }
+
+            "Kolab Groupware" -> "Cyrus IMAP" [dir=both,label="(1)"];
+
+            "Cyrus IMAP" -> "Dealer" [label="(2)"];
+
+            "Dealer" -> "Broker" [label="(3)"];
+
+            "Broker" -> "Worker" [label="(4)"];
+
+            "Broker" -> "Worker" [dir=back,label="(4a)"];
+
+            "Collector" -> "Broker" [dir=back,label="(4b)"];
+            "Collector" -> "Broker" [label="(4c)"];
+
+            "Worker" -> "Storage" [dir=both,label="(5)"];
+
+        }
+
+This process involves the following steps:
+
+1.  Kolab Groupware continues to communicate with Cyrus IMAP directly.
+
+2.  For changes to content in Cyrus IMAP, and other events worth
+    maintaining a record of, Cyrus IMAP issues an event notification
+    [#]_.
+
+3.  A *dealer* dispatches the event notification to a central *broker*
+    as fast as possible, and unlocks the Cyrus IMAP processes as quickly
+    as possible [#]_.
+
+4.  The *broker* maintains a queue of event notifications that are
+    picked off the queue by *worker* processes one-by-one.
+
+    a.  Should the *worker* declare an interest [#]_ in data not
+        included in the original event notification [#]_, then the event
+        notification is sent back to the *broker* for re-evaluation.
+
+    b.  Re-evaluation currently includes contacting a *collector* that
+        runs on the Cyrus IMAP server that issued the original event
+        notification [#]_.
+
+    c.  An amended event notification (with additional data) is sent
+        back to the *broker*.
+
+5.  After the *worker* evaluates the new event notification [#]_, it
+    stores the event in storage [#]_.
+
+ZeroMQ Communication Model
+==========================
+
+The Bonnie source code allows the technology used to communicate between
+components to be easily substituted.
+
+For the initial development phase the communications between Bonnie
+components is based on ZeroMQ (0MQ).
+
+Specifically to this message bus technology, the communication model is
+evaluated to address access and directionality concerns:
+
+.. graphviz::
+
+    digraph {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            subgraph cluster_broker {
+                    label="broker";
+
+                    "\*:5570" -> "dealer_router" -> "queue";
+                    "\*:5571" -> "collector_router" -> "queue";
+                    "queue" -> "controller_router" -> "\*:5572";
+                    "queue" -> "worker_router" -> "\*:5573";
+                }
+
+            subgraph cluster_worker {
+                    label="worker";
+
+                    "worker";
+                    "controller";
+                }
+
+            subgraph cluster_imap {
+                    label="imap server";
+                    "collector";
+                    "dealer";
+                }
+
+            "collector" -> "\*:5571";
+            "dealer" -> "\*:5570";
+            "\*:5572" -> "controller" [dir=back];
+            "\*:5573" -> "worker" [dir=back];
+
+            "worker" -> "storage";
+        }
+
+.. _and-bonnie-broker-worker-interaction:
+
+Broker -- Worker Interaction
+============================
+
+When the broker starts up, it creates three listener sockets:
+
+#.  A dealer router,
+
+    used for incoming event notifications from IMAP servers passed through the Dealer component.
+
+#.  A worker router,
+
+    used to exchange job information and notification payload with workers.
+
+#.  A control router,
+
+    used to exchange worker and job state information.
+
+When the worker starts, it connects to both the control router and
+worker router.
+
+#.  Using the controller channel, the worker let's the broker know it is
+    ready to receive a job.
+
+    .. graphviz::
+
+        digraph {
+                rankdir = LR;
+                splines = true;
+                overlab = prism;
+
+                edge [color=gray50, fontname=Calibri, fontsize=11];
+                node [shape=record, fontname=Calibri, fontsize=11];
+
+                "broker" -> "worker" [label="READY",dir=back];
+            }
+
+    *   The broker adds the worker to its list of workers.
+
+    *   The broker will continue to receive occasional messages from the
+        worker to allow it to determine whether or not it is still
+        available.
+
+#.  The broker, maintaining a queue of jobs to assign to workers, lets
+    the worker know about a newly assigned job -- again using the controller channel.
+
+    .. graphviz::
+
+        digraph {
+                rankdir = LR;
+                splines = true;
+                overlab = prism;
+
+                edge [color=gray50, fontname=Calibri, fontsize=11];
+                node [shape=record, fontname=Calibri, fontsize=11];
+
+                "broker" -> "worker" [label="TAKE $ID"];
+            }
+
+#.  The worker internally triggers the retrieval of the job using the
+    worker channel.
+
+    .. graphviz::
+
+        digraph {
+                rankdir = LR;
+                splines = true;
+                overlab = prism;
+
+                edge [color=gray50, fontname=Calibri, fontsize=11];
+                node [shape=record, fontname=Calibri, fontsize=11];
+
+                "broker" -> "worker" [label="GET $ID",dir=back];
+                "broker" -> "worker" [label="JOB $ID $PAYLOAD"];
+            }
+
+#.  The worker is now in state BUSY and must respond within a set
+    interval or the broker will set the job back in to PENDING state,
+    and mark the worker as unavailable.
+
+.. _and-bonnie-worker-design:
+
+Worker Design
+=============
+
+The worker is built out of plugins, that subscribe to an event type,
+where event types available are listed in
+:ref:`and-bonnie-event-notification-types`.
+
+Each event type individually may require handling -- for example, a
+logout event is associated with the corresponding login event.
+
+The following components will be pluggable and configurable:
+
+*   subscribing to a message bus or queue, as ``inputs``, initially
+    including only ``zmq``.
+
+*   event handling, as ``handlers``, initially including only one
+    handler per event notification and higher level processors
+    ``changelog`` and ``freebusy`` to detect changes in groupwware
+    objects.
+
+*   result output, as ``output``, initially including only
+    ``elasticsearch``.
+
+*   storage for transactions pending or aggregated meta information,
+    as ``storage``, initialy including only ``elasticsearch``.
+
+Assuming an installation path of :file:`bonnie/worker/`, the following
+depicts its tree layout:
+
+.. parsed-literal::
+
+    handlers/
+        `-  changelog.py
+        `-  freebusy.py
+        `-  mailboxcreate.py
+        `-  messageappend.py
+        `-  ...
+    inputs/
+        `-  zmq_input.py
+    outputs/
+        `-  elasticsearch_output.py
+    storage/
+        `-  elasticsearch_storage.py
+
+To take the changelog and freebusy handlers as an example, the following
+event notification types may need to be subscribed to.
+
+:ref:`and-bonnie-event-mailboxcreate`
+
+    A new mailbox that is an event folder may have been created.
+
+    The initial event is handled by the base handler for the event
+    notification type.
+
+    Passing this event right through to the changelog handler would make
+    it require obtaining the ``/shared/vendor/kolab/folder-type`` and/or
+    ``/private/vendor/kolab/folder-type`` metadata value(s) in order to
+    determine whether the folder indeed is an event folder.
+
+    However, the setting of metadata is an event separate from the
+    mailbox creation, and at the moment the handler receives the initial
+    event notification, the metadata may not have been set yet.
+
+    .. NOTE::
+
+        At the time of this writing, no separate event notification for
+        setting folder-level METADATA exists.
+
+:ref:`and-bonnie-event-mailboxdelete`
+
+    A mailbox that was an event folder may have been deleted.
+
+:ref:`and-bonnie-event-mailboxrename`
+
+    A mailbox that was an event folder may have been renamed.
+
+:ref:`and-bonnie-event-messageappend`
+
+    Only applicable to event folders, this depicts a new or updated
+    version of an existing event has been appended.
+
+:ref:`and-bonnie-event-messagecopy`
+
+    One or more events may have been copied from an event folder into
+    another event folder.
+
+:ref:`and-bonnie-event-messagemove`
+
+    One or more events may have been moved from one event folder into
+    another event folder.
+
+.. NOTE::
+
+    Plugins that are interested in the vendor/kolab/folder-type METADATA
+    value(s) of a folder can reply with additional commands for the collector
+    component which will put the current job back into the PENDING state and
+    send it through the handler again once the requested information was added
+    to the notification payload.
+
+
+.. _and-bonnie-event-notification-types:
+
+Event Notification Types
+========================
+
+Event types available include, in alphabetical order:
+
+#.  :ref:`and-bonnie-event-flagsclear`
+#.  :ref:`and-bonnie-event-flagsset`
+#.  :ref:`and-bonnie-event-login`
+#.  :ref:`and-bonnie-event-logout`
+#.  :ref:`and-bonnie-event-mailboxcreate`
+#.  :ref:`and-bonnie-event-mailboxdelete`
+#.  :ref:`and-bonnie-event-mailboxrename`
+#.  :ref:`and-bonnie-event-mailboxsubscribe`
+#.  :ref:`and-bonnie-event-mailboxunsubscribe`
+#.  :ref:`and-bonnie-event-messageappend`
+#.  :ref:`and-bonnie-event-messagecopy`
+#.  :ref:`and-bonnie-event-messageexpire`
+#.  :ref:`and-bonnie-event-messageexpunge`
+#.  :ref:`and-bonnie-event-messagemove`
+#.  :ref:`and-bonnie-event-messagenew`
+#.  :ref:`and-bonnie-event-messageread`
+#.  :ref:`and-bonnie-event-messagetrash`
+#.  :ref:`and-bonnie-event-quotaexceeded`
+#.  :ref:`and-bonnie-event-quotawithin`
+#.  :ref:`and-bonnie-event-quotachange`
+
+.. _and-bonnie-event-flagsclear:
+
+FlagsClear
+----------
+
+This event notification type indicates one or more messages have had its
+flags cleared.
+
+Flags having been cleared may include ``\Seen``, but also ``\Deleted``,
+and any custom other flag on an IMAP message.
+
+Subscribe to this notification for:
+
+*   Backup/Restore
+*   e-Discovery
+
+.. _and-bonnie-event-flagsset:
+
+FlagsSet
+--------
+
+Subscribe to this notification for:
+
+*   Backup/Restore
+*   e-Discovery
+
+.. _and-bonnie-event-login:
+
+Login
+-----
+
+Additional information to obtain for this event notification type:
+
+*   The persistent unique attribute for the user object.
+*   Additional LDAP object attributes.
+
+Information storage:
+
+*   This event needs to be stored until it can be associated with a
+    :ref:`and-bonnie-event-logout` event notification type.
+
+Subscribe to this notification for:
+
+*   e-Discovery
+
+.. _and-bonnie-event-logout:
+
+Logout
+------
+
+Subscribe to this notification for:
+
+*   e-Discovery
+
+.. _and-bonnie-event-mailboxcreate:
+
+MailboxCreate
+-------------
+
+Additional information to obtain
+
+.. _and-bonnie-event-mailboxdelete:
+
+MailboxDelete
+-------------
+
+.. _and-bonnie-event-mailboxrename:
+
+MailboxRename
+-------------
+
+.. _and-bonnie-event-mailboxsubscribe:
+
+MailboxSubscribe
+----------------
+
+.. _and-bonnie-event-mailboxunsubscribe:
+
+MailboxUnsubscribe
+------------------
+
+.. _and-bonnie-event-messageappend:
+
+MessageAppend
+-------------
+
+.. _and-bonnie-event-messagecopy:
+
+MessageCopy
+-----------
+
+.. _and-bonnie-event-messageexpire:
+
+MessageExpire
+-------------
+
+.. _and-bonnie-event-messageexpunge:
+
+MessageExpunge
+--------------
+
+.. _and-bonnie-event-messagemove:
+
+MessageMove
+-----------
+
+.. _and-bonnie-event-messagenew:
+
+MessageNew
+----------
+
+.. _and-bonnie-event-messageread:
+
+MessageRead
+-----------
+
+.. _and-bonnie-event-messagetrash:
+
+MessageTrash
+------------
+
+.. _and-bonnie-event-quotaexceeded:
+
+QuotaExceeded
+-------------
+
+.. _and-bonnie-event-quotawithin:
+
+QuotaWithin
+-----------
+
+.. _and-bonnie-event-quotachange:
+
+QuotaChange
+-----------
+
+An Integrated Solution
+======================
+
+The following aspects of an environment need to be tracked;
+
+*   Logs such as ``/var/log/maillog``, which contain the information
+    about exchange of messages between internal and external systems and
+    software (Postfix/LMTP -> Cyrus IMAP).
+
+*   Cyrus IMAP 2.5 Events broadcasted.
+
+.. graphviz::
+
+    digraph {
+            subgraph cluster_imap {
+                    width = 7.0;
+                    "IMAP #" [shape=rectangle];
+                    "IMAP 2" [shape=rectangle];
+                    "IMAP 1" [shape=rectangle];
+                }
+
+            "Message Bus" [shape=rectangle,width=7.0];
+
+            "IMAP #" -> "Message Bus";
+            "IMAP 2" -> "Message Bus";
+            "IMAP 1" -> "Message Bus";
+
+            subgraph cluster_subscribers {
+                    width = 7.0;
+                    "Archival" [shape=rectangle];
+                    "Backup" [shape=rectangle];
+                    "Data-Loss Prevention" [shape=rectangle];
+                    "e-Discovery" [shape=rectangle];
+                }
+
+            "Message Bus" -> "Archival";
+            "Message Bus" -> "Backup";
+            "Message Bus" -> "Data-Loss Prevention";
+            "Message Bus" -> "e-Discovery";
+
+            "NoSQL Storage" [shape=rectangle,width=3.0];
+            "SQL Storage" [shape=rectangle,width=3.0];
+
+            "Archival", "Backup", "Data-Loss Prevention", "e-Discovery" -> "NoSQL Storage", "SQL Storage";
+        }
+
+In this picture, IMAP (using Cyrus IMAP 2.5) issues so-called
+:term:`event notifications` to a message bus, that can be picked up by the
+appropriate subscribers.
+
+Note that the subscribers are different components to plug in and enable, or
+leave out -- not everyone has a need for Archival and e-Discovery capabilities.
+
+As such, a component plugged in could announce its presence, and start working
+backwards as well as start collecting the relevant subsets of data in a retro-
+active manner.
+
+.. graphviz::
+
+    digraph event_notification {
+            rankdir = LR;
+            splines = true;
+            overlab = prism;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11];
+            node [shape=record, fontname=Calibri, fontsize=11];
+
+            "subscriber";
+            "message bus" [height=2.0];
+            "daemon";
+            "publisher";
+
+            "subscriber" -> "message bus" [label="announces presence"];
+            "daemon" -> "message bus" [label="presence announcement", dir=back];
+            "daemon" -> "message bus" [label="works backwards"];
+            "publisher" -> "message bus" [label="event notifications"];
+
+        }
+
+To allow scaling, the intermediate medium is likely a message bus such
+as ActiveMQ, AMQP, ZeroMQ, etc.
+
+Between Cyrus IMAP 2.5 and the message bus must be a thin application
+that is capable of:
+
+*   Retrieving the payload of the message(s) involved if necessary,
+*   Submit the remainder to a message bus.
+
+This is because Cyrus IMAP 2.5:
+
+#.  at the time of this writing, does not support submitting the event
+    notifications to a message bus directly [#]_,
+
+#.  the size of the message payload is likely to exceed the maximum size of an
+    event notification datagram [#]_.
+
+Processing of inbound messages must happen real-time or near-time, but should
+also be post-processed:
+
+*   e-Discovery requires post-processing to sufficiently associate the message
+    in its context, and contains an audit trail.
+
+*   Archival and Backup require payload, and may also use post-processing to
+    facilitate Restore.
+
+Event Notifications
+===================
+
+The following events trigger notifications:
+
+.. code-block:: c
+
+    /*
+    * event types defined in RFC 5423 - Internet Message Store Events
+    */
+    enum event_type {
+        EVENT_CANCELLED           = (0),
+        /* Message Addition and Deletion */
+        EVENT_MESSAGE_APPEND      = (1<<0),
+        EVENT_MESSAGE_EXPIRE      = (1<<1),
+        EVENT_MESSAGE_EXPUNGE     = (1<<2),
+        EVENT_MESSAGE_NEW         = (1<<3),
+        EVENT_MESSAGE_COPY        = (1<<4), /* additional event type to notify IMAP COPY */
+        EVENT_MESSAGE_MOVE        = (1<<5), /* additional event type to notify IMAP MOVE */
+        EVENT_QUOTA_EXCEED        = (1<<6),
+        EVENT_QUOTA_WITHIN        = (1<<7),
+        EVENT_QUOTA_CHANGE        = (1<<8),
+        /* Message Flags */
+        EVENT_MESSAGE_READ        = (1<<9),
+        EVENT_MESSAGE_TRASH       = (1<<10),
+        EVENT_FLAGS_SET           = (1<<11),
+        EVENT_FLAGS_CLEAR         = (1<<12),
+        /* Access Accounting */
+        EVENT_LOGIN               = (1<<13),
+        EVENT_LOGOUT              = (1<<14),
+        /* Mailbox Management */
+        EVENT_MAILBOX_CREATE      = (1<<15),
+        EVENT_MAILBOX_DELETE      = (1<<16),
+        EVENT_MAILBOX_RENAME      = (1<<17),
+        EVENT_MAILBOX_SUBSCRIBE   = (1<<18),
+        EVENT_MAILBOX_UNSUBSCRIBE = (1<<19)
+    };
+
+In addition, Kolab Groupware makes available the following event notifications:
+
+.. code-block:: c
+
+    enum event_type {
+        (...)
+        EVENT_MAILBOX_UNSUBSCRIBE = (1<<19),
+        EVENT_ACL_CHANGE          = (1<<20)
+    };
+
+This means the following event notifications are lacking:
+
+#.  METADATA change notification
+
+It is possible to run Cyrus IMAP 2.5 notifications in a blocking fashion,
+allowing the (post-)processing operation(s) to complete in full before the IMAP
+session is allowed to continue / confirms the modification/mutation.
+
+
+.. Removed ORM model description after moving to elasticsearch for storage
+.. __ include:: bonnie-orm.rst
+
+
+Queries and Information Distribution
+====================================
+
+ZeroMQ
+======
+
+.. graphviz::
+
+    digraph bonnie_zeromq {
+            splines = true;
+            overlap = prism;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11]
+            node [shape=record, fontname=Calibri, fontsize=11]
+
+            subgraph cluster_broker {
+                    label = "Broker";
+                    "Client Router";
+                    "Controller";
+                    "Worker Router";
+                }
+
+            "Client-%d" -> "Client Router";
+            "Worker-%d" -> "Worker Router";
+            "Worker-%d" -> "Controller";
+        }
+
+Dealer <-> Broker <-> Worker Message Exchange
+=============================================
+
+Modelled after an article about tracking worker status at
+http://rfc.zeromq.org/spec:14
+
+.. graphviz::
+
+    digraph bonnie_broker {
+            rankdir = LR;
+            splines = true;
+            overlap = prism;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11]
+            node [shape=record, fontname=Calibri, fontsize=11]
+
+            subgraph cluster_broker {
+                    label = "Broker";
+
+                    "Dealer Router";
+                    "Job Queue";
+                }
+
+            subgraph cluster_clients {
+                    label = "Dealers";
+                    "Dealer $x" [label="Dealer-%d"];
+                    "Dealer $y" [label="Dealer-%d"];
+                }
+
+            "Dealer $x", "Dealer $y" -> "Dealer Router" [label="(1) Submit"];
+            "Dealer Router" -> "Job Queue" [label="(2) Queue"];
+            "Dealer $x", "Dealer $y" -> "Dealer Router" [label="(3) Acknowledge",dir=back];
+
+        }
+
+**Dealer - Broker Concerns**
+
+    #.  The dealer is queuing without a high-water mark and without a local
+        swap defined. It is only after the broker is available this queue is
+        flushed. This could introduce a loss of notifications.
+
+    #.  The dealer is not awaiting confirmation in the sense that it will replay
+        the submission if needed, such as after the dealer has been restarted.
+        This too could introduce a loss of notifications.
+
+    #.  The dealer is certainly not awaiting confirmation from any worker that
+        the notification had been submitted to for handling.
+
+    #.  The dealer is a sub-process of the cyrus-imapd service, and should this
+        service be restarted, is not handling such signals to preserve state.
+
+**Broker Concerns**
+
+    #.  The broker is keeping the job queue in memory for fast updates and responses.
+
+    .. NOTE::
+        The broker component shall periodically dump the job queue and registered
+        worker and collector connections into a persistant storage layer which has yet
+        to be defined.
+
+.. graphviz::
+
+    digraph bonnie_broker {
+            rankdir = LR;
+            splines = true;
+            overlap = prism;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11]
+            node [shape=record, fontname=Calibri, fontsize=11]
+
+            subgraph cluster_broker {
+                    label = "Broker";
+
+                    "Controller";
+                    "Job Queue";
+                    "Worker Router";
+                    "Worker List";
+                }
+
+            subgraph cluster_workers {
+                    label = "Workers";
+                    "Worker $x" [label="Worker-%d"];
+                    "Worker $y" [label="Worker-%d"];
+                }
+
+            "Worker $x", "Worker $y" -> "Controller" [label="(a) READY"];
+
+            "Controller" -> "Job Queue" [label="(b) Find Job"];
+            "Controller" -> "Worker List" [label="(c) Find Worker"];
+            "Controller" -> "Worker $x", "Worker $y" [label="(d) Assign Job"];
+
+            "Worker $x", "Worker $y" -> "Worker Router" [label="(e) Take Job"];
+            "Worker Router" -> "Worker List" [label="(f) Mark BUSY"];
+        }
+
+.. graphviz::
+
+    digraph bonnie_broker {
+            rankdir = LR;
+            splines = true;
+            overlap = prism;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11]
+            node [shape=record, fontname=Calibri, fontsize=11]
+
+            subgraph cluster_broker {
+                    label = "Broker";
+
+                    "Controller";
+                    "Dealer Router";
+                    "Job Queue";
+                    "Worker Router";
+                    "Worker List";
+                }
+
+            subgraph cluster_clients {
+                    label = "Dealers";
+                    "Dealer $x" [label="Dealer-%d"];
+                    "Dealer $y" [label="Dealer-%d"];
+                }
+
+            subgraph cluster_workers {
+                    label = "Workers";
+                    "Worker $x" [label="Worker-%d"];
+                    "Worker $y" [label="Worker-%d"];
+                }
+
+            "Dealer $x", "Dealer $y" -> "Dealer Router" [label="(1) Submit"];
+            "Dealer Router" -> "Job Queue" [label="(2) Queue"];
+            "Dealer $x", "Dealer $y" -> "Dealer Router" [label="(3) Acknowledge",dir=back];
+
+            "Worker $x", "Worker $y" -> "Controller" [label="(a) READY"];
+
+            "Controller" -> "Job Queue" [label="(b) Find Job"];
+            "Controller" -> "Worker List" [label="(c) Find Worker"];
+            "Controller" -> "Worker $x", "Worker $y" [label="(d) Assign Job"];
+
+            "Worker $x", "Worker $y" -> "Worker Router" [label="(e) Take Job"];
+            "Worker Router" -> "Worker List" [label="(f) Mark BUSY"];
+        }
+
+
+.. _and-bonnie-storage-layout-schema:
+
+Storage Layout and Schema
+=========================
+
+Logging Event Notifications
+---------------------------
+
+Logging event notification into the storage backend (currently elasticsearch)
+is inspired by logstash and writes to daily rotated indexes ``logstash-Y-m-d``
+using document type ``logs``. The basic schema of an event notification
+contains the following attributes:
+
+.. code-block:: json
+
+    {
+      "@timestamp": "2014-10-11T23:10:20.536000Z",
+      "@version": 1,
+      "event": "SomeEvent",
+      "client_ip": "::1",
+      "folder_id": "4ed7903ebd7722d12596a2e2ed57bbdf",
+      "folder_uniqueid": "f83c6305-f884-440a-b93d-eff285ada1f4",
+      "service": "imap",
+      "session_id": "kolab.example.org-2819-1413069020-1",
+      "uri": "imap://john.doe@example.org@kolab.example.org/INBOX;UIDVALIDITY=1411487701",
+      "user": "john.doe@example.org",
+      "user_id": "f6c10801-1dd111b2-9d31a2a8-bebbcb98",
+    }
+
+The very minimal attributes required for an event notification entry are
+
+*   ``@timestamp``: The UTC time when the event was logged
+*   ``@version``: Bonnie data API version
+*   ``event``: The Cyrus IMAP event
+*   ``service``: "imap" denoting that this logstash entry represents an IMAP event notification
+*   ``session_id``: The Cyrus IMAP session identifier
+*   ``user``: The authenticated user who triggered the event
+
+Depending on the event type, additional attributes containg message IDs, message
+headers or payload, flag names or ACL. For message or mailbox based events the ``uri``
+attribute is added and refers to the mailbox/folder the operation was executed on.
+
+From the basic attributes, some relations to metadata (see :ref:`and-bonnie-storing-metadata`)
+are extracted and the logstash entry is extended with identifiers referring to user
+and folder metadata entries:
+
+*   ``folder_uniqueid``: The gobally unique folder identifer of a mailbox folder from IMAP.
+
+*   ``folder_id``: Links to a folder entry representing the current state of a mailbox folder
+    at the time the event occurred. This includes folder name, metadata and access rights.
+
+*   ``user_id``: Unique identifier (from the LDAP ``nsuniqueid`` attribute) of the
+    use who executed the logged operation in IMAP.
+
+
+.. _and-bonnie-storing-metadata:
+
+Storing Metadata
+----------------
+
+Metadata records are used to amend log data with more complete and persistent
+information of rather volatile attributes like username and mailbox URIs issued
+by Cyrus IMAP 2.5 notifications. For example, the same physical human being
+(jane.gi@example.org) could change email addresses for any of many unrelated
+causes (jane.doe@example.org) and IMAP folders can be renamed at any given time.
+
+Users
+^^^^^
+
+Stored in ``objects/user`` with the following schema:
+
+.. code-block:: json
+
+    {
+      "@timestamp": "2014-10-11T19:30:24.330029Z",
+      "dn": "uid=doe,ou=People,dc=example,dc=org",
+      "user": "john.doe@example.org",
+      "cn": "John Doe"
+    }
+
+The ``nsuniqueid`` attribute from the LDAP is used as the primary key/id
+of user records.
+
+Folders
+^^^^^^^
+
+Stored in ``objects/folder`` with the following schema:
+
+.. code-block:: json
+
+    {
+      "@timestamp": "2014-10-11T23:10:54.055272Z",
+      "@version": 1,
+      "acl": {
+        "anyone": "lrswiptedn",
+        "f6c10801-1dd111b2-9d31a2a8-bebbcb98": "lrswipkxtecdan"
+      },
+      "metadata": {
+        "/shared/vendor/cmu/cyrus-imapd/duplicatedeliver": "false",
+        "/shared/vendor/cmu/cyrus-imapd/lastupdate": "12-Oct-2014 01:10:20 +0200",
+        "/shared/vendor/cmu/cyrus-imapd/partition": "default",
+        "/shared/vendor/cmu/cyrus-imapd/pop3newuidl": "true",
+        "/shared/vendor/cmu/cyrus-imapd/sharedseen": "false",
+        "/shared/vendor/cmu/cyrus-imapd/size": "2593",
+        "/shared/vendor/cmu/cyrus-imapd/uniqueid": "f83c6305-f884-440a-b93d-eff285ada1f4",
+        "/shared/vendor/kolab/folder-type": "mail"
+      },
+      "name": "INBOX",
+      "owner": "john.doe",
+      "server": "kolab.example.org",
+      "type": "mail",
+      "uniqueid": "f83c6305-f884-440a-b93d-eff285ada1f4",
+      "uri": "imap://john.doe@example.org@kolab.example.org/INBOX"
+    }
+
+The primary key/id of folder records is computed as a checksum of all
+attributes and metadata entries considered relevant for the "state" of
+a folder. This means that a new folder record is created when ACLs or
+folder type metadata is changed.
+
+The keys of ``acl`` entries provided by the Collector module from IMAP data
+are translated into static user identifers.
+
+.. NOTE::
+
+    In order to compute the folder identifier, the complete set of
+    folder information like metadata and acl has to be pulled from
+    IMAP using a collector job on every single event notification.
+    Once Cyrus IMAP supports notifications for metadata changes
+    (`#3698 <https://issues.kolab.org/show_bug.cgi?id=3698>`_),
+    this could be skipped and the folder metadata records can be
+    updated on specific events only.
+
+
+Object Relations
+----------------
+
+Although elasticsearch isn't a relational database, the Bonnie storage model implies
+a simple object relation model between logs and metadata.
+
+.. graphviz::
+
+    digraph bonnie_relations {
+            splines = true;
+            overlap = prism;
+
+            edge [color=gray50, fontname=Calibri, fontsize=11]
+            node [shape=record, fontname=Calibri, fontsize=11]
+
+            subgraph cluster_user {
+                    label = "User (objects/user)";
+                    user_user_id [label="_id", color=blue, fontcolor=blue];
+                    user_user_dn [label="dn", color=blue, fontcolor=blue];
+                    user_user_cn [label="cn", color=blue, fontcolor=blue];
+                }
+
+            subgraph cluster_folder {
+                    label = "Folder (objects/folder)";
+                    folder_id [label="_id", color=blue, fontcolor=blue];
+                    folder_uniqueid [label="uniqueid", color=blue, fontcolor=blue];
+                }
+
+            subgraph cluster_log {
+                    label = "Log Entry (logstash-*/log)";
+                    log_user [label="user", color=blue, fontcolor=blue];
+                    log_uri [label="uri", color=blue, fontcolor=blue];
+                    log_user_id [label="user_id", color=blue, fontcolor=blue];
+                    log_folder_id [label="folder_id", color=blue, fontcolor=blue];
+                }
+
+            log_user -> log_user_id [label="resolves to"];
+            log_uri -> log_folder_id [label="resolves to"];
+            log_user_id -> user_user_id [label="FOREIGN KEY"];
+            log_folder_id -> folder_id [label="FOREIGN KEY"];
+        }
+
+
+Accessing the Collected Data
+----------------------------
+
+Some of the collected data, primarily changelogs of groupware objects, shall
+be made available to Kolab clients to display the history of a certain object
+or creation/last-modification information including the according usernames
+which is not stored in the Kolab data format itself.
+
+A dedicated web service provides access to the archived data through an API
+and thereby translates the raw information from the storage backend into
+more concrete groupware object related data.
+
+See the :ref:`and-bonnie-client-api` for details.
+
+.. rubric:: Footnotes
+
+.. [#]
+
+    The worker shall be a multi-threaded daemon (using
+    multiprocessing.Pool), that is a pluggable application.
+
+    .. seealso::
+
+        *   :ref:`and-bonnie-worker-design`
+        *   :ref:`and-bonnie-broker-worker-interaction`
+
+.. [#]
+
+    The worker shall determine based on functional features enabled, and
+    existing data, whether or not it requires a copy of the original
+    message payload.
+
+.. [#]
+
+    It is assumed we'll be working with RSyslog, Logstash and Elastic
+    Search.
+
+.. [#]
+
+    A list of events triggering a notification to be issued is available
+    at :ref:`and-bonnie-event-notification-types`.
+
+.. [#]
+
+    The event notification process is a blocking thread, meaning that a
+    login event for example, will not incur a "successful" response back
+    to the client unless the notification dispatcher returns
+    successfully.
+
+.. [#]
+
+    An *interest* is being declared by a worker handler plugin, and
+    may require message content to be available for further parsing.
+
+.. [#]
+
+    Event notification contents are limited to a datagram size that is
+    not large enough to sustainably contain message payload.
+
+.. [#]
+
+    A collector daemon is needed to prevent having to access the data
+    using the IMAP protocol, and miss the data (such as on expunge
+    events or folder deletions). Instead, the collector accesses the
+    filesystem underneath Cyrus IMAP directly.
+
+.. [#]
+
+    The new event notification now contains additional information
+    needed for one of the worker handler plugins to correctly associate
+    and/or otherwise analyse data and relationships.
+
+.. [#]
+
+    The storage used is preferrably an indexed storage layer with
+    full-text indexing capabilities.
+
+.. [#]
+
+    http://git.cyrusimap.org/cyrus-imapd/tree/notifyd?id=8bdaeae3f891ba2a748ba91a4c324ee11346e292
+
+.. [#]
+
+    Needs further investigation, for the actual maximum size of a datagram may
+    have ceased to be hard-coded. Yet, to submit a large message through the
+    notification daemon while the notification target is eligible to pick up the
+    message contents from the filesystem seems like duplication.
+
+.. _Kolab Groupware: https://kolab.org
+.. _Kolab Groupware documentation: https://docs.kolab.org

bonnie-0.3.0.tar.gz/docs/conf.py Added

@@ -0,0 +1,278 @@
+# -*- coding: utf-8 -*-
+#
+# Bonnie documentation build configuration file, created by
+# sphinx-quickstart on Fri Nov 28 14:43:59 2014.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(1, os.path.abspath('../../pykolab.git'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+        'sphinx.ext.autodoc',
+        'sphinx.ext.coverage',
+        'sphinx.ext.doctest',
+        'sphinx.ext.extlinks',
+        'sphinx.ext.graphviz',
+        'sphinx.ext.ifconfig',
+        'sphinx.ext.intersphinx',
+        'sphinx.ext.mathjax',
+        'sphinx.ext.todo',
+        'sphinx.ext.viewcode'
+    ]
+
+autodoc_member_order = 'groupwise'
+
+autodoc_default_flags = [
+        'members',
+        'undoc-members',
+        'private-members',
+        #'special-members',
+        'inherited-members',
+        'show-inheritance'
+    ]
+
+todo_include_todos = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Bonnie'
+copyright = u'2014, Jeroen van Meeuwen <vanmeeuwen@kolabsys.com>, Thomas Bruederli <bruederli@kolabsys.com>'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.2'
+# The full version, including alpha/beta/rc tags.
+release = '0.2.3'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinxdoc'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Bonniedoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'Bonnie.tex', u'Bonnie Documentation',
+   u'Jeroen van Meeuwen \\textless{}vanmeeuwen@kolabsys.com\\textgreater{}, Thomas Bruederli \\textless{}bruederli@kolabsys.com\\textgreater{}', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'bonnie', u'Bonnie Documentation',
+     [u'Jeroen van Meeuwen <vanmeeuwen@kolabsys.com>, Thomas Bruederli <bruederli@kolabsys.com>'], 1)
+]
+
+extlinks = {
+        'bugzilla':('https://issues.kolab.org/show_bug.cgi?id=%s', 'Ticket #'),
+    }
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'Bonnie', u'Bonnie Documentation',
+   u'Jeroen van Meeuwen <vanmeeuwen@kolabsys.com>, Thomas Bruederli <bruederli@kolabsys.com>', 'Bonnie', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+        'python': ('http://docs.python.org/', None),
+        'pyzmq': ('https://zeromq.github.io/pyzmq/', None),
+    }

bonnie-0.3.0.tar.gz/docs/index.rst Added

bonnie-0.3.0.tar.gz/docs/modules.rst Added

bonnie-0.3.0.tar.gz/docs/technical-documentation Added

bonnie-0.3.0.tar.gz/docs/technical-documentation/daemon.rst Added

bonnie-0.3.0.tar.gz/docs/technical-documentation/index.rst Added

bonnie-0.3.0.tar.gz/docs/technical-documentation/worker-handlers.rst Added

bonnie-0.3.0.tar.gz/docs/technical-documentation/worker.rst Added

bonnie-0.2.2.tar.gz/tests/__init__.py -> bonnie-0.3.0.tar.gz/tests/__init__.py Changed

bonnie-0.2.2.tar.gz/tests/functional/__init__.py -> bonnie-0.3.0.tar.gz/tests/functional/__init__.py Changed

bonnie-0.2.2.tar.gz/tests/functional/test_001_login.py -> bonnie-0.3.0.tar.gz/tests/functional/test_001_login.py Changed

@@ -1,3 +1,23 @@
+# -*- coding: utf-8 -*-
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
+#
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 import json
 import time
 
@@ -54,4 +74,4 @@
 
         self.assertIsInstance(user, dict)
         self.assertEqual(user['user'], login['user'])
-        self.assertEqual(user['cn'], 'John Doe')
\ No newline at end of file
+        self.assertEqual(user['cn'], 'John Doe')

bonnie-0.2.2.tar.gz/tests/functional/test_002_mailboxes.py -> bonnie-0.3.0.tar.gz/tests/functional/test_002_mailboxes.py Changed

bonnie-0.2.2.tar.gz/tests/functional/test_003_messages.py -> bonnie-0.3.0.tar.gz/tests/functional/test_003_messages.py Changed

@@ -1,3 +1,23 @@
+# -*- coding: utf-8 -*-
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
+#
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 import json
 
 from . import TestBonnieFunctional
@@ -244,4 +264,3 @@
         self.assertTrue(event['headers']['Subject'] in messagetrash['messageHeaders']['36']['Subject'])
         self.assertEqual(len(event['message_id']), 0)
 
-        
\ No newline at end of file

bonnie-0.2.2.tar.gz/tests/functional/test_004_changelog.py -> bonnie-0.3.0.tar.gz/tests/functional/test_004_changelog.py Changed

bonnie-0.2.2.tar.gz/tests/functional/testbase.py -> bonnie-0.3.0.tar.gz/tests/functional/testbase.py Changed

bonnie-0.2.2.tar.gz/tests/unit/__init__.py -> bonnie-0.3.0.tar.gz/tests/unit/__init__.py Changed

bonnie-0.2.2.tar.gz/tests/unit/test_001_utils.py -> bonnie-0.3.0.tar.gz/tests/unit/test_001_utils.py Changed

bonnie-0.2.2.tar.gz/tests/unit/test_002_collector.py -> bonnie-0.3.0.tar.gz/tests/unit/test_002_collector.py Changed

bonnie-0.2.2.tar.gz/tests/unit/test_003_dealer.py -> bonnie-0.3.0.tar.gz/tests/unit/test_003_dealer.py Changed

@@ -1,3 +1,23 @@
+# -*- coding: utf-8 -*-
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
+#
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 import os
 import json
 import bonnie
@@ -45,4 +65,3 @@
         dealer.run(json.dumps({ 'event':'MessageAppend', 'user':'cyrus-admin' }))
         self.assertEqual(len(BonnieDealerOutput.output_calls), 1)
         self.assertIn('MessageAppend', BonnieDealerOutput.output_calls)
-        
\ No newline at end of file

bonnie-0.2.2.tar.gz/tests/unit/test_004_worker.py -> bonnie-0.3.0.tar.gz/tests/unit/test_004_worker.py Changed

@@ -1,3 +1,23 @@
+# -*- coding: utf-8 -*-
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
+#
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 import json
 import elasticsearch
 import bonnie
@@ -75,4 +95,3 @@
         }
         folder = storage.notificaton2folder(notification)
         self.assertNotEqual(folder['id'], folder_id)
-        
\ No newline at end of file

bonnie-0.2.2.tar.gz/tests/unit/test_005_persistence.py -> bonnie-0.3.0.tar.gz/tests/unit/test_005_persistence.py Changed

@@ -1,3 +1,23 @@
+# -*- coding: utf-8 -*-
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
+#
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 import os
 import json
 import bonnie
@@ -97,4 +117,4 @@
         worker_jobs.append(two)
 
         self.assertEqual(worker_jobs[0], done)
-        self.assertEqual(worker_jobs[-1], two)
\ No newline at end of file
+        self.assertEqual(worker_jobs[-1], two)

bonnie-0.2.2.tar.gz/tests/unit/test_006_caching.py -> bonnie-0.3.0.tar.gz/tests/unit/test_006_caching.py Changed

@@ -1,3 +1,23 @@
+# -*- coding: utf-8 -*-
+# Copyright 2010-2014 Kolab Systems AG (http://www.kolabsys.com)
+#
+# Jeroen van Meeuwen (Kolab Systems) <vanmeeuwen a kolabsys.com>
+# Thomas Bruederli (Kolab Systems) <bruederli a kolabsys.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
 import time
 
 from twisted.trial import unittest
@@ -48,4 +68,3 @@
         # expunge internal cache
         d.expunge()
         self.assertEqual(len(d.data), 0)
-        
\ No newline at end of file

bonnie-0.2.2.tar.gz/worker.py -> bonnie-0.3.0.tar.gz/worker.py Changed

Changes of Revision 38