Merge pull request #16 from ralphwetzel/v3

Preparation for V3.0.1

theonionbox/stamp.txt

@@ -1 +1 @@
-20161001|214145
+20161003|180117

theonionbox/theonionbox.py

@@ -2,7 +2,7 @@
 from __future__ import absolute_import
 from __future__ import print_function
 
-__version__ = '3.0'      # stamp will be added later
+__version__ = '3.0.1'      # stamp will be added later
 __description__ = 'The Onion Box: WebInterface to monitor Tor Relays and Bridges'
 
 
@@ -11,7 +11,7 @@
 # bottle
 # psutil
 # configparser
-# apscheduler
+# apscheduler (either v3.x or v2.x)
 # requests
 
 #####
@@ -515,12 +515,12 @@ def update_time_deviation():
 #####
 # The Scheduler
 
+from tob.scheduler import Scheduler
+
 # used to run all async activities within TOB
-from apscheduler.schedulers.background import BackgroundScheduler
-box_cron = BackgroundScheduler()
+box_cron = Scheduler()
 box_cron.start()
 
-
 #####
 # SESSION Management
 from tob.session import SessionFactory, make_short_id

theonionbox/tob/scheduler.py

@@ -0,0 +1,90 @@
+#####
+# Class to support APScheduler v3 (default) and v2
+# despite their interfaces are incompatible!
+
+class Scheduler(object):
+
+    schedulr = None
+    aps30 = True
+
+    def __init__(self):
+
+        #####
+        # ApScheduler version detection
+        import apscheduler
+        self.aps30 = apscheduler.version_info >= (3, 0, 0)
+
+        if self.aps30:
+            # APScheduler 3.x implementation
+            from apscheduler.schedulers.background import BackgroundScheduler
+            self.schedulr = BackgroundScheduler()
+        else:
+            # APScheduler 2.x implementation
+            from apscheduler.scheduler import Scheduler
+            self.schedulr = Scheduler()
+
+    def start(self):
+        return self.schedulr.start()
+
+    def get_job(self, name):
+        if self.aps30:
+            return self.schedulr.get_job(name)
+        else:
+            jobs = self.schedulr.get_jobs()
+            for job in jobs:
+                if job.name == name:
+                    return job
+
+            return None
+
+    def add_job(self, func, trigger, args=None, kwargs=None, id=None, **trigger_args):
+        if self.aps30:
+            return self.schedulr.add_job(func, trigger, id=id, args=args, kwargs=kwargs, **trigger_args)
+        else:
+            if trigger is 'date':
+                run_date = trigger_args['run_date']   # by intention: to raise if not set!
+                del trigger_args['run_date']
+                return self.schedulr.add_date_job(func, run_date, name=id, args=args, kwargs=kwargs)
+            elif trigger is 'interval':
+                # only partially implemented!!
+                seconds = 0
+                minutes = 0
+                hours = 0
+                if 'seconds' in trigger_args:
+                    seconds = trigger_args.get('seconds', 0)
+                    del trigger_args['seconds']
+
+                if 'minutes' in trigger_args:
+                    minutes = trigger_args.get('minutes', 0)
+                    del trigger_args['minutes']
+
+                if 'hours' in trigger_args:
+                    hours = trigger_args.get('hours', 0)
+                    del trigger_args['hours']
+
+                return self.schedulr.add_interval_job(func, name=id,
+                                                      hours=hours, minutes=minutes, seconds=seconds,
+                                                      args=args, kwargs=kwargs)
+            elif trigger is 'cron':
+                # only partially implemented!!
+                second = 0
+                minute = 0
+                hour = 0
+                if 'second' in trigger_args:
+                    second = trigger_args.get('second', 0)
+                    del trigger_args['second']
+
+                if 'minute' in trigger_args:
+                    minute = trigger_args.get('minute', 0)
+                    del trigger_args['minute']
+
+                if 'hour' in trigger_args:
+                    hour = trigger_args.get('hour', 0)
+                    del trigger_args['hour']
+
+                return self.schedulr.add_cron_job(func, name=id, hour=hour, minute=minute, second=second)
+            else:
+                raise NotImplementedError
+
+    def shutdown(self):
+        return self.schedulr.shutdown()