""" Copyright (c) 2016-2020 Keith Sterling http://www.keithsterling.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. """ import logging import hashlib from datetime import datetime from datetime import timedelta from apscheduler.schedulers.background import BackgroundScheduler from apscheduler.schedulers.blocking import BlockingScheduler from apscheduler.events import EVENT_ALL from apscheduler.events import SchedulerEvent, JobEvent, JobSubmissionEvent, JobExecutionEvent from programy.utils.logging.ylogger import YLogger def scheduled(name, userid, clientid, action, text): ProgramyScheduler.scheduled_event(name, userid, clientid, action, text) def scheduler_listener(event): ProgramyScheduler.listener_event(event) class ProgramyScheduler: schedulers = {} def __init__(self, client, configuration): self._client = client self._scheduler = None self._configuration = configuration if self._configuration: if self._configuration.debug_level is not None: self.set_debug_level(self._configuration.debug_level) self._scheduler = self._create_scheduler(self._configuration) self.register_schedulder(self, self._configuration.name) if self._configuration.add_listeners is True: YLogger.debug(None, "Scheduler registering listeners") self.register_listeners() if self._configuration.remove_all_jobs is True: YLogger.debug(None, "Scheduler removing all existing jobs") self._scheduler.remove_all_jobs() YLogger.debug(None, "Scheduler initiated...") else: YLogger.debug(None, "Scheduler not initiated...") @property def name(self): return self._configuration.name def register_schedulder(self, scheduler, name): if name in ProgramyScheduler.schedulers: YLogger.error(None, "Scheduler with name [%s] already registered", name) else: ProgramyScheduler.schedulers[name] = scheduler def set_debug_level(self, level): logging.getLogger('apscheduler').setLevel(level) def register_listeners(self): self._scheduler.add_listener(scheduler_listener, EVENT_ALL) def _create_scheduler(self, configuration): config = configuration.create_scheduler_config() if configuration.blocking is True: if config is not None: YLogger.debug(None, "Creating Blocking Scheduler WITH config") return BlockingScheduler(config) else: YLogger.debug(None, "Creating Blocking Scheduler WITHOUT config") return BlockingScheduler() else: if config is not None: YLogger.debug(None, "Creating Background Scheduler WITH config") return BackgroundScheduler(config) else: YLogger.debug(None, "Creating Background Scheduler WITHOUT config") return BackgroundScheduler() def start(self): YLogger.debug(None, "Scheduler starting...") self._scheduler.start() def stop(self): YLogger.debug(None, "Scheduler stopping...") self._scheduler.shutdown() def stop_job(self, jobid): YLogger.debug(None, "Scheduler stopping %s" % jobid) self._scheduler.remove_job(jobid) def pause(self): YLogger.debug(None, "Scheduler pausing all...") self._scheduler.pause() def pause_job(self, jobid): YLogger.debug(None, "Scheduler pausing %s" % jobid) self._scheduler.pause_job(jobid) def resume(self): YLogger.debug(None, "Scheduler resuming all...") self._scheduler.resume() def resume_job(self, jobid): YLogger.debug(None, "Scheduler resuming %s" % jobid) self._scheduler.resume_job(jobid) def list_jobs(self): id_jobs = {} jobs = self._scheduler.get_jobs() for job in jobs: id_jobs[job.id] = job return id_jobs def create_job_id(self, userid, clientid, action, text): jobid = "%s:%s:%s:%s" % (userid, clientid, action, text) hashed = hashlib.md5(jobid.encode()) return hashed.hexdigest() def remove_existing_job(self, job_id): old_job = self._scheduler.get_job(job_id) if old_job is not None: self._scheduler.remove_job(old_job) ################################################################################################################# # Interval triggers def schedule_every_n_seconds(self, userid, clientid, action, text, seconds): YLogger.debug(None, "Scheduler scheduling every %d seconds" % seconds) job_id = self.create_job_id(userid, clientid, action, text) self.remove_existing_job(job_id) self._scheduler.add_job(scheduled, 'interval', [self.name, userid, clientid, action, text], id=job_id, seconds=seconds) def schedule_every_n_minutes(self, userid, clientid, action, text, minutes): YLogger.debug(None, "Scheduler scheduling every %d minutes" % minutes) job_id = self.create_job_id(userid, clientid, action, text) self.remove_existing_job(job_id) self._scheduler.add_job(scheduled, 'interval', [self.name, userid, clientid, action, text], id=job_id, minutes=minutes) def schedule_every_n_hours(self, userid, clientid, action, text, hours): YLogger.debug(None, "Scheduler scheduling every %d hours" % hours) job_id = self.create_job_id(userid, clientid, action, text) self.remove_existing_job(job_id) self._scheduler.add_job(scheduled, 'interval', [self.name, userid, clientid, action, text], id=job_id, hours=hours) def schedule_every_n_days(self, userid, clientid, action, text, days): YLogger.debug(None, "Scheduler scheduling every %d days" % days) job_id = self.create_job_id(userid, clientid, action, text) self.remove_existing_job(job_id) self._scheduler.add_job(scheduled, 'interval', [self.name, userid, clientid, action, text], id=job_id, days=days) def schedule_every_n_weeks(self, userid, clientid, action, text, weeks): YLogger.debug(None, "Scheduler scheduling every %d weeks" % weeks) job_id = self.create_job_id(userid, clientid, action, text) self.remove_existing_job(job_id) self._scheduler.add_job(scheduled, 'interval', [self.name, userid, clientid, action, text], id=job_id, weeks=weeks) def schedule_every_n(self, userid, clientid, action, text, weeks=0, days=0, hours=0, minutes=0, seconds=0): YLogger.debug(None, "Scheduler scheduling every n") job_id = self.create_job_id(userid, clientid, action, text) self.remove_existing_job(job_id) self._scheduler.add_job(scheduled, 'interval', [self.name, userid, clientid, action, text], id=job_id, weeks=weeks, days=days, hours=hours, minutes=minutes, seconds=seconds) ################################################################################################################# # Date trigger def schedule_in_n_weeks(self, userid, clientid, action, text, weeks): YLogger.debug(None, "Scheduler scheduling in %d weeks" % weeks) now = datetime.now() the_future = now + timedelta(weeks=weeks) self.schedule_at_datetime(userid, clientid, action, text, the_future) def schedule_in_n_days(self, userid, clientid, action, text, days): YLogger.debug(None, "Scheduler scheduling in %d days" % days) now = datetime.now() the_future = now + timedelta(days=days) self.schedule_at_datetime(userid, clientid, action, text, the_future) def schedule_in_n_hours(self, userid, clientid, action, text, hours): YLogger.debug(None, "Scheduler scheduling in %d hours" % hours) now = datetime.now() the_future = now + timedelta(hours=hours) self.schedule_at_datetime(userid, clientid, action, text, the_future) def schedule_in_n_minutes(self, userid, clientid, action, text, minutes): YLogger.debug(None, "Scheduler scheduling in %d minutes" % minutes) now = datetime.now() the_future = now + timedelta(minutes=minutes) self.schedule_at_datetime(userid, clientid, action, text, the_future) def schedule_in_n_seconds(self, userid, clientid, action, text, seconds): YLogger.debug(None, "Scheduler scheduling in %d seconds" % seconds) now = datetime.now() the_future = now + timedelta(seconds=seconds) self.schedule_at_datetime(userid, clientid, action, text, the_future) def schedule_at_datetime(self, userid, clientid, action, text, schedule): YLogger.debug(None, "Scheduler scheduling in datetime") job_id = self.create_job_id(userid, clientid, action, text) self.remove_existing_job(job_id) self._scheduler.add_job(scheduled, 'date', [self.name, userid, clientid, action, text], id=job_id, run_date=schedule) ################################################################################################################# # Cron triggers def schedule_as_cron(self, userid, clientid, action, text, year='*', month='*', day='*', week='*', day_of_week='*', hour='*', minute='*', second='*'): YLogger.debug(None, "Scheduler scheduling cron") job_id = self.create_job_id(userid, clientid, action, text) self.remove_existing_job(job_id) self._scheduler.add_job(scheduled, 'cron', [self.name, userid, clientid, action, text], id=job_id, year=year, month=month, day=day, week=week, day_of_week=day_of_week, hour=hour, minute=minute, second=second) ################################################################################################################# # Admin/Debug Functions @staticmethod def get_event_str(event): if isinstance(event, JobExecutionEvent): if event.exception: return "JobExecutionEvent [%s] [%s] [%s] [%s] [%s] [%s]" % ( event.code, event.job_id, event.jobstore, event.scheduled_run_time, event.retval, event.exception) else: return "JobExecutionEvent [%s] [%s] [%s] [%s] [%s]" % ( event.code, event.job_id, event.jobstore, event.scheduled_run_time, event.retval) elif isinstance(event, JobSubmissionEvent): return "JobSubmissionEvent [%s] [%s] [%s] [%s]" % ( str(event.code), event.job_id, event.jobstore, event.scheduled_run_times) elif isinstance(event, JobEvent): return "JobEvent [%s] [%s] [%s] [%s]" % (event.code, event.job_id, event.jobstore, event.alias) elif isinstance(event, SchedulerEvent): return "SchedulerEvent [%s] [%s]" % (event.code, event.alias) return None @staticmethod def listener_event(event): message = ProgramyScheduler.get_event_str(event) if message is not None: YLogger.debug(None, message) else: YLogger.error(None, "Unknown APSchedulerEvent! %s", str(event)) ################################################################################################################# # Admin/Debug Functions @staticmethod def scheduled_event(name, userid, clientid, action, text): YLogger.debug(None, "Received Scheduled Event [%s] [%s] [%s] [%s] [%s]", name, userid, clientid, action, text) if name in ProgramyScheduler.schedulers: scheduler = ProgramyScheduler.schedulers[name] scheduler.scheduled(userid, clientid, action, text) else: YLogger.error(None, "Unknown scheduler [%s]", name) def scheduled(self, userid, clientid, action, text): YLogger.debug(None, "Processing Scheduled Event [%s] [%s] [%s] [%s] [%s]", self.name, userid, clientid, action, text) client_context = self._client.create_client_context(userid) if action == 'TEXT': self._client.render_response(client_context, text) elif action == 'SRAI': response = client_context.bot.ask_question(client_context, text) self._client.render_response(client_context, response) else: YLogger.error(client_context, "Unknown scheduler command [%s]", action)