Newer
Older
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# combacscheduler.py
#
# Copyright 2014 BFR <info@freie-radios.de>
#
# 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 of the License
#
# 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, the license can be downloaded here:
#
# http://www.gnu.org/licenses/gpl.html
# Meta
__version__ = '0.1.1'
__license__ = "GNU General Public License (GPL) Version 3"
__version_info__ = (0, 1, 1)
__author__ = 'Michael Liebler <michael-liebler@radio-z.net>'
"""
Comba Scheduler Klasse
Is holding the eventqueue
"""
import signal
import pyev
import os
import os.path
import time
import simplejson
import datetime

Gottfried Gaisbauer
committed
import decimal
import json
from flask import jsonify
from datetime import timedelta
from dateutil.relativedelta import relativedelta
import logging
from glob import glob
import threading
# Die eigenen Bibliotheken
from libraries.base.schedulerconfig import AuraSchedulerConfig
from libraries.reporting.messenger import AuraMessenger
from libraries.base.calendar import AuraCalendarService
from modules.scheduling.models import ModelBroadcastEventOverrides

Gottfried Gaisbauer
committed
from libraries.database.broadcasts import Schedule, ScheduleEntry
from libraries.exceptions.auraexceptions import NoProgrammeLoadedException
"""
Comba Scheduler Class
Liefert Start und Stop Jobs an den Comba Controller, lädt XML-Playlisten und räumt auf
"""

Gottfried Gaisbauer
committed
def alchemyencoder(obj):
"""JSON encoder function for SQLAlchemy special classes."""
if isinstance(obj, datetime.date):
return obj.isoformat()
elif isinstance(obj, decimal.Decimal):
return float(obj)
class AuraScheduler():
messenger = AuraMessenger()

Gottfried Gaisbauer
committed
schedule_entries = None
schedule_events = None
schedulerconfig = None

Gottfried Gaisbauer
committed
job_result = {}
programme = None
client = None

Gottfried Gaisbauer
committed
debug = False

Gottfried Gaisbauer
committed
def __init__(self, config, debug): #, liquidsoap_client):
"""
Constructor
@type config: string

Gottfried Gaisbauer
committed
@param config: Pfad zur aura.ini
"""
self.auraconfig = config

Gottfried Gaisbauer
committed
self.debug = debug
# Messenger für Systemzustände initieren

Gottfried Gaisbauer
committed
self.messenger.set_channel('scheduler')
self.messenger.set_section('execjob')
self.messenger.set_mail_addresses(self.auraconfig.get('frommail'), self.auraconfig.get('adminmail'))

Gottfried Gaisbauer
committed
self.schedulerconfig = self.auraconfig.get("scheduler_config_file")
# Die Signale, die Abbruch signalisieren
self.stopsignals = (signal.SIGTERM, signal.SIGINT)
# das pyev Loop-Object
self.loop = pyev.default_loop()
# Das ist kein Reload
self.initial = True
# Der Scheduler wartet noch auf den Start Befehl
self.ready = False
# DIe Config laden

Gottfried Gaisbauer
committed
self.__load_config__()
self.scriptdir = os.path.dirname(os.path.abspath(__file__)) + '/..'

Gottfried Gaisbauer
committed
self.schedule_events = ScheduleEntry.query.filter
#errors_file = os.path.dirname(os.path.realpath(__file__)) + '/error/scheduler_error.js'
json_data = open(self.auraconfig.get("install_dir") + "/errormessages/scheduler_error.js")
self.errorData = simplejson.load(json_data)
self.messenger.send('Scheduler started', '0000', 'success', 'initApp', None, 'appinternal')
# ------------------------------------------------------------------------------------------ #
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# def set(self, key, value):
# """
# Eine property setzen
# @type key: string
# @param key: Der Key
# @type value: mixed
# @param value: Beliebiger Wert
# """
# self.__dict__[key] = value
# ------------------------------------------------------------------------------------------ #
# def get(self, key, default=None):
# """
# Eine property holen
# @type key: string
# @param key: Der Key
# @type default: mixed
# @param default: Beliebiger Wert#
#
# """
# if key not in self.__dict__:
# if default:
# self.set(key, default)
# else:
# return None
# return self.__dict__[key]
# ------------------------------------------------------------------------------------------ #

Gottfried Gaisbauer
committed
def reload_config(self):
"""
Reload Scheduler - Config neu einlesen
"""
self.stop()
# Scheduler Config neu laden

Gottfried Gaisbauer
committed
if self.__load_config__():
self.messenger.send('Scheduler reloaded by user', '0500', 'success', 'reload', None, 'appinternal')
self.start()
# ------------------------------------------------------------------------------------------ #

Gottfried Gaisbauer
committed
def reload_programme(self, programme=None):
if programme is None:
self.programme = ScheduleEntry.select_all()
else:
print("WARNING: No processing of JSON String here implemented")

Gottfried Gaisbauer
committed
print("i am the scheduler and i am holding the following stuff")
for entry in self.programme:
from pprint import pprint
pprint(entry)

Gottfried Gaisbauer
committed
# ------------------------------------------------------------------------------------------ #
def get_act_programme_as_json(self):
if self.programme is None:
raise NoProgrammeLoadedException("")

Gottfried Gaisbauer
committed
return json.dumps([p._asdict() for p in self.programme], default=alchemyencoder)
# ------------------------------------------------------------------------------------------ #

Gottfried Gaisbauer
committed
def __load_config__(self):
"""
Scheduler-Config importieren
@rtype: boolean
@return: True/False
"""
# Wenn das Scheduling bereits läuft, muss der Scheduler nicht unbedingt angehalten werden
error_type = 'fatal' if self.initial else 'error'
# watcher_jobs = self.getJobs()
try:
# Die Jobs aus der Config ...

Gottfried Gaisbauer
committed
watcher_jobs = self.get_jobs()
except:
self.messenger.send('Config is broken', '0301', error_type, 'loadConfig', None, 'config')
if self.initial:
self.ready = False
return False
# Fehlermeldung senden, wenn keine Jobs gefunden worden sind
if len(watcher_jobs) == 0:
self.messenger.send('No Jobs found in Config', '0302', error_type, 'loadConfig', None, 'config')
# Der erste Watcher ist ein Signal-Watcher, der den sauberen Abbruch ermöglicht
self.watchers = [pyev.Signal(sig, self.loop, self.signal_cb)
for sig in self.stopsignals]
# Der zweite Watcher soll das Signal zum Reload der Config ermöglicen
sig_reload = self.loop.signal(signal.SIGUSR1, self.signal_reload)
self.watchers.append(sig_reload)
# Der dritte Watcher sendet alle 20 Sekunden ein Lebenszeichen

Gottfried Gaisbauer
committed
say_alive = self.loop.timer(0, 20, self.say_alive)
self.watchers.append(say_alive)
# Der vierte Watcher schaut alle 20 Sekunden nach, ob eine Vorproduktion eingespielt werden soll
lookup_prearranged = self.loop.timer(0, 20, self.lookup_prearranged)
self.watchers.append(lookup_prearranged)
# Der fünfte Watcher führt initiale Jobs durch
on_start = self.loop.timer(0, 30, self.on_start)
self.watchers.append(on_start)
# Nun Watcher für alle Jobs aus der Config erstellen
for watcher_job in watcher_jobs:
watcher = pyev.Scheduler(self.schedule_job, self.loop, self.exec_job, watcher_job)
# Jeder watcher wird von der Scheduler Funktion schedule_job schedult und vom Callback exec_job ausgeführt
# watcher_job wird an watcher.data übergeben
# schedule_job meldet an den Loop den nächsten Zeitpunkt von watcher_job['time']
# exec_job führt die Funktion dieser Klasse aus, die von watcher_job['job'] bezeichnet wird
self.watchers.append(watcher)
# Es kann losgehen
self.ready = True
return True

Gottfried Gaisbauer
committed
def get_jobs(self):
error_type = 'fatal' if self.initial else 'error'
try:
# Das scheduler.xml laden

Gottfried Gaisbauer
committed
self.schedulerconfig = AuraSchedulerConfig(self.schedulerconfig)
except:
# Das scheint kein gültiges XML zu sein
self.messenger.send('Config is broken', '0301', error_type, 'loadConfig', None, 'config')
# Wenn das beim Start passiert können wir nix tun
if self.initial:
self.ready = False
return False
jobs = self.schedulerconfig.getJobs()
for job in jobs:
if job['job'] == 'start_recording' or job['job'] == 'play_playlist':

Gottfried Gaisbauer
committed
stopjob = self.__get_stop_job__(job)
jobs.append(stopjob)
return jobs
# -----------------------------------------------------------------------#

Gottfried Gaisbauer
committed
def __get_stop_job__(self, startjob):
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
job = {}
job['job'] = 'stop_playlist' if startjob['job'] == 'play_playlist' else 'stop_recording'
if startjob['day'] == 'all':
job['day'] = startjob['day']
else:
if startjob['time'] < startjob['until']:
job['day'] = startjob['day']
else:
try:
day = int(startjob['day'])
stopday = 0 if day > 5 else day+1
job['day'] = str(stopday)
except:
job['day'] = 'all'
job['time'] = startjob['until']
return job
# ------------------------------------------------------------------------------------------ #
def start(self):
"""
Event Loop starten
"""
# Alle watcher starten
for watcher in self.watchers:
watcher.start()
logging.debug("{0}: started".format(self))
try:
self.loop.start()
except:
self.messenger.send("Loop did'nt start", '0302', 'fatal', 'appstart', None, 'appinternal')
else:
self.messenger.send("Scheduler started", '0100', 'success', 'appstart', None, 'appinternal')
# ------------------------------------------------------------------------------------------ #
def stop(self):
"""
Event Loop stoppen
"""
self.loop.stop(pyev.EVBREAK_ALL)
# alle watchers stoppen und entfernen
while self.watchers:
self.watchers.pop().stop()
self.messenger.send("Loop stopped", '0400', 'success', 'appstart', None, 'appinternal')
# ------------------------------------------------------------------------------------------ #

Gottfried Gaisbauer
committed
def say_alive(self, watcher, revents):
"""
Alle 20 Sekunden ein Lebenssignal senden
@type watcher: object
@param watcher: Das watcher Objekt
@type revents: object
@param revents: Event Callbacks
"""
print("AuraScheduler saying alive")

Gottfried Gaisbauer
committed
self.messenger.say_alive()
# ------------------------------------------------------------------------------------------ #
def signal_cb(self, loop, revents):
"""
Signalverarbeitung bei Abbruch
@type loop: object
@param loop: Das py_ev loop Objekt
@type revents: object
@param revents: Event Callbacks
"""
self.messenger.send("Received stop signal", '1100', 'success', 'appstop', None, 'appinternal')
self.stop()
# ------------------------------------------------------------------------------------------ #
def signal_reload(self, loop, revents):
"""
Lädt Scheduling-Konfiguration neu bei Signal SIGUSR1
@type loop: object
@param loop: Das py_ev loop Objekt
@type revents: object
@param revents: Event Callbacks
"""
self.messenger.send("Comba Scheduler gracefull restarted", '1200', 'success', 'appreload', None, 'appinternal')

Gottfried Gaisbauer
committed
self.reload_config()
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# ------------------------------------------------------------------------------------------ #
def schedule_job(self, watcher, now):
"""
Callback zum Scheduling eines Jobs
@type watcher: object
@param watcher: Das watcher Objekt
@type now: float
@param now: Aktuelle Zeit in Sekunden
@rtype: float
@return: Die Zeit zu der der Job ausgeführt werden soll in Sekunden
"""
# nächstes Ereignis dieses Watchers aus den watcher data
data = watcher.data.copy()
next_schedule = data['time']
# Minuten und Stunden
(next_hour, next_minute) = next_schedule.split(':')
# Zum Vergleich die aktuelle und die auszuführende Unhrzeit in Integer wandeln
today_time = int(datetime.datetime.now().strftime('%H%M'))
next_time = int(next_hour + next_minute)
# Wenn der Job erst morgen ausgeführt werden soll ist day_offset 1
day_offset = 1 if (today_time >= next_time) else 0
# Ist ein Tag angegeben
if 'day' in data:
try:
#Montag ist 0
dayofweek = int(data['day'])
delta = relativedelta(hour=int(next_hour), minute=int(next_minute), second=0, microsecond=0,
weekday=dayofweek)
except:
#Fallback - day ist vermutlich ein String
delta = relativedelta(hour=int(next_hour), minute=int(next_minute), second=0, microsecond=0)
else:
delta = relativedelta(hour=int(next_hour), minute=int(next_minute), second=0, microsecond=0)
# Ermittle das Datumsobjekt
schedule_result = datetime.datetime.now() + timedelta(day_offset) + delta
# In Sekunden umrechnen
result = time.mktime(schedule_result.timetuple())
schedule_time_human = datetime.datetime.fromtimestamp(int(result)).strftime('%Y-%m-%d %H:%M:%S')
time_now = datetime.datetime.fromtimestamp(time.time()).strftime('%Y-%m-%d %H:%M:%S')
date_human = datetime.datetime.fromtimestamp(int(result)).strftime('%Y-%m-%d')
time_human = datetime.datetime.fromtimestamp(int(result)).strftime('%H:%M')
# Events feuern, zum stoppen und starten einer Playlist
# TODO: Diese events müssen bei einem Reset gelöscht werden
# Es sollte sicher sein, einfach alle keys mit playerevent_*_playliststart unc playerevent_*_playliststop zu löschen
if 'job' in data:
if data['job'] == 'play_playlist':
event = {'job': 'play_playlist', 'date': date_human, 'time': time_human}

Gottfried Gaisbauer
committed
self.messenger.queue_add_event('playliststart', str(schedule_time_human).replace(' ', 'T'), event,
'player')
if data['job'] == 'stop_playlist':
event = {'job': 'stop_playlist', 'date': date_human, 'time': time_human}

Gottfried Gaisbauer
committed
self.messenger.queue_add_event('playliststop', str(schedule_time_human).replace(' ', 'T'), event,
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
'player')
data['scheduled_at'] = time_now
data['scheduled_for'] = schedule_time_human
self.info('schedule_job', data, '00', simplejson.dumps(data), 'schedulejob')
# das nächste mal starten wir diesen Job in result Sekunden
return result
# ------------------------------------------------------------------------------------------ #
def exec_job(self, watcher, revents):
"""
Callback, um einen Job auszuführen
@type watcher: object
@param watcher: Das watcher Objekt
@type revents: object
@param revents: Event Callbacks
"""
data = watcher.data.copy()
# Welcher Job ausgeführt werden soll wird in watcher.data vermerkt
job = data['job']
# Job ausführen
try:
exec("a=self." + job + "(data)")
except Exception as e:
data['exec'] = 'exec"a=self.' + job + '(' + simplejson.dumps(data) + ')"'
data['Exception'] = str(e)
self.fatal('exec_job', data, '01', simplejson.dumps(data))
watcher.stop() #stop the watcher
else:
self.success('exec_job', data, '00', simplejson.dumps(data))
# ------------------------------------------------------------------------------------------ #

Gottfried Gaisbauer
committed
def clear_channel(self, channel):
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
"""
Schaltet auto-Channel aus und common-Channel ein
Skippt anschließend ggf. verbleibende Tracks vom auto-Channel
@type channel: str
@param channel: Kanal
"""
def _get_data(result):
"""
Untermethode: prüft ob noch tracks im Channel Queue sind
"""
try:
if result['success'] == 'success':
if 'value' in result:
return result['value']
else:
return True
else:
return False
except:
return False
# Common Channel laut
self.client.channel_set_volume('common', 100)
# Auto-Channel leise
self.client.channel_set_volume(channel, 0)
# Channel Queue holen
data = self.client.get_channelqueue(channel)
# Channel initial skippen...
self.client.channel_skip(channel)
queue = _get_data(data)
# ...für jeden track erneut skippen
if queue and 'tracks' in queue:
tracks = queue['tracks']
for track in tracks:
time.sleep(1.0)
self.client.channel_skip(channel)
# Auto Channel für erneute Verwendung ausschalten und laut stellen
self.client.channel_off(channel)
self.client.channel_set_volume(channel, 100)
# ------------------------------------------------------------------------------------------ #

Gottfried Gaisbauer
committed
def run_channel(self, channel):
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
self.client.channel_set_volume('common', 0)
self.client.channel_set_volume(channel, 100)
self.client.channel_on(channel)
# ------------------------------------------------------------------------------------------ #
def lookup_prearranged(self, watcher, revents):
"""
Job-Methode. Spielt ggf. Vorproduktionen aus
Diese wird als Trackliste auf einen von zwei Extra-Channels (auto1 und 2) gelegt
@type watcher: object
@param watcher: Das watcher Objekt
@type revents: object
@param revents: Event Callbacks
"""
# Vorproduktion in den nächsten 20 Sekunden vorgemerkt?
tracks = ModelBroadcastEventOverrides.upcoming(datetime.datetime.now(),20)
#print(tracks)
# print(type(tracks))
if tracks and len(tracks) > 0:
# alle tracks enthalten die Information über den zugehörigen broadcast event
event = tracks[0].broadcast_event
# freien preprod channel checken,
channel = 'auto1'
if not self.client.channel_is_active('auto1'):
channel = 'auto1'
elif not self.client.channel_is_active('auto2'):
channel = 'auto2'
else:
self.error('lookup_prearranged', "false", '01')
return
# tracks in preprod channel laden
pos = 0
for track in tracks:
self.client.channel_track_insert(channel, track.location, pos)
pos = pos + 1
now = datetime.datetime.now()
# zeitgesteuert einschalten
on = (event.start - now).total_seconds()

Gottfried Gaisbauer
committed
threading.Timer(on, self.run_channel, [channel]).start()
# zeitgesteuert skippen
off = (event.end - now).total_seconds()

Gottfried Gaisbauer
committed
threading.Timer(off, self.clear_channel, [channel]).start()
# ------------------------------------------------------------------------------------------ #
def on_start(self, watcher, revents):
self.client.playlist_play()
self.client.playlist_pause()
watcher.stop()
# ------------------------------------------------------------------------------------------ #
def load_playlist(self, data=None):
"""
Playlist laden
"""
store = AuraCalendarService()

Gottfried Gaisbauer
committed
self.__prepare_playlist_store__(store, datetime.datetime.now(), data)
uri = store.get_uri()
store.start()
# wait until childs thread returns
store.join()
data = {}
data['uri'] = uri
result = self.client.playlist_load(uri)

Gottfried Gaisbauer
committed
if self.__check_result__(result):
self.success('load_playlist', data, '00')
else:
self.error('load_playlist', data, '02')
# ------------------------------------------------------------------------------------------ #

Gottfried Gaisbauer
committed
@staticmethod
def __prepare_playlist_store__(self, store, dateBegin, data):
"""
Playlist speichern
"""
try:
fromtime = data['from']
until = data['until']
except:
return
# Das aktuelle Datum
today_time = dateBegin.strftime('%H:%M')
# Wir müssen ermitteln, ob die eigentliche Abspielzeit vielleicht erst morgen ist
day_offset = 1 if (today_time > fromtime) else 0
start_date = dateBegin + timedelta(day_offset)
# datefrom ist Datum, an dem die Playlist beginnen soll
datefrom = str(start_date.strftime('%F')) + ' ' + fromtime
# Die Playlist holen

Gottfried Gaisbauer
committed
store.set_date_from(datefrom)
store.set_until_time(until)
# ------------------------------------------------------------------------------------------ #
def play_playlist(self, data):
"""
Playlist starten
"""

Gottfried Gaisbauer
committed
# TODO: Fehler auswerten
result = self.client.playlist_play()

Gottfried Gaisbauer
committed
if self.__check_result__(result):
self.success('play_playlist', result, '00')
else:
self.error('play_playlist', result, '01')
# ------------------------------------------------------------------------------------------ #
def stop_playlist(self, data):
"""
Playlist anhalten
"""

Gottfried Gaisbauer
committed
# TODO: Fehler auswerten
if self.get('has_input_device'):
result = self.client.playlist_pause()
else:
result = self.client.playlist_stop()

Gottfried Gaisbauer
committed
if self.__check_result__(result):
self.success('stop_playlist', result, '00')
else:
self.error('stop_playlist', result, '01')
# ------------------------------------------------------------------------------------------ #
def start_recording(self, data):
"""
Aufnahme starten
"""
result = self.client.recorder_start()
# store = AuraCalendarService()
# self._preparePlaylistStore(store, datetime.datetime.now(), data)
# uri = store.getUri()
# store.start()

Gottfried Gaisbauer
committed
if self.__check_result__(result):
self.success('start_recording', result, '00')
else:
self.error('start_recording', result, '01')
# ------------------------------------------------------------------------------------------ #
def stop_recording(self, data):
"""
Aufnahme anhalten
"""
result = self.client.recorder_stop()

Gottfried Gaisbauer
committed
if self.__check_result__(result):
self.success('stop_recording', result, '00')
else:
self.error('stop_recording', result, '01')
# ------------------------------------------------------------------------------------------ #
def precache(self, data):
"""
Playlisten 7 Tage im Voraus abholen
"""
# periods = self.config.getPlayPeriods() + self.config.getRecordPeriods()
# timeBegin = datetime.datetime.now()
# for i in range(0, int(self.get('calendar_precache_days'))):
# for period in periods:
# store = AuraCalendarService()
# self._preparePlaylistStore(store, timeBegin, period)
# store.start()
# counter = 40
# while counter > 0 and store.is_alive():
# counter = counter - 1
# time.sleep(0.1)
# timeBegin = timeBegin + datetime.timedelta(1)
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
self.success('precache')
# ------------------------------------------------------------------------------------------ #
def clean_cached(self, data):
"""
Nicht mehr benötigte Audios und Playlisten löschen
@type data: dict
@param data: das job dict
"""
# Zeitdauer, die Dateien aufgehoben werden sollen
try:
savetime = int(data['daysolder']) * 86400
except:
savetime = 3*86400
# Jetzt ist Jetzt
now = time.time()
files = []
# Alle Audiodateien finden
for dir, _, _ in os.walk(self.audiobase):
# Leere Verzeichnisse löschen
if len(os.listdir(dir)) == 0:
try:
os.rmdir(dir)
except:
#TODO: Fehlemeldung
pass
else:
files.extend(glob(os.path.join(dir, '*.wav')))
# Alle Dateien löschen, die älter als savetime sind
for file in files:
if os.path.isfile(file) and os.stat(file).st_mtime < now - savetime:
try:
os.remove(file)
except:
#TODO: Fehlemeldung
pass
self.success('clean_cached')
# ------------------------------------------------------------------------------------------ #

Gottfried Gaisbauer
committed
def __get_error__(self, job, errornumber, data):
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
"""
Privat: Ermittelt Fehlermeldung, Job-Name (Klassenmethode) und Fehlercode für den Job aus error/controller_error.js
@type errornumber: string
@param errornumber: Die interne Fehlernummer der aufrufenden Methode
"""
### weil es eine "bound method" ist, kommmt data als string an!???
if data == None:
data = {}
if type(data) == type(str()):
data = simplejson.loads(data)
hasData = isinstance(data, (dict)) and len(data) > 0
if job in self.errorData:
errMsg = self.errorData[job][errornumber]
errID = self.errorData[job]['id'] + str(errornumber)
if hasData:
for key in data.keys():
errMsg = errMsg.replace('::' + key + '::', str(data[key]))
data['message'] = errMsg
data['job'] = job
data['code'] = errID
return data
# ------------------------------------------------------------------------------------------ #
def success(self, job, data=None, errnum='00', value='', section='execjob'):
"""
Erfolgsmeldung loggen
@type errnum: string
@param errnum: Errornummer der aufrufenden Funktion
@type value: string
@param value: Optionaler Wert
@type section: string
@param section: Gültigkeitsbereich
"""

Gottfried Gaisbauer
committed
error = self.__get_error__(job, errnum, data)
self.job_result = {'message': error['message'], 'code': error['code'], 'success': 'success',
'job': error['job'], 'value': value, 'section': section}
self.messenger.send(error['message'], error['code'], 'success', error['job'], value, section)
# ------------------------------------------------------------------------------------------ #
def info(self, job, data=None, errnum='01', value='', section='execjob'):
"""
Info loggen
@type errnum: string
@param errnum: Errornummer der aufrufenden Funktion
@type value: string
@param value: Optionaler Wert
@type section: string
@param section: Gültigkeitsbereich
"""

Gottfried Gaisbauer
committed
error = self.__get_error__(job, errnum, data)
self.job_result = {'message': error['message'], 'code': error['code'], 'success': 'info', 'job': error['job'],
'value': value, 'section': section}
self.messenger.send(error['message'], error['code'], 'info', error['job'], value, section)
# ------------------------------------------------------------------------------------------ #
def warning(self, job, data=None, errnum='01', value='', section='execjob'):
"""
Warnung loggen
@type errnum: string
@param errnum: Errornummer der aufrufenden Funktion
@type value: string
@param value: Optionaler Wert
@type section: string
@param section: Gültigkeitsbereich
"""

Gottfried Gaisbauer
committed
error = self.__get_error__(job, errnum, data)
self.job_result = {'message': error['message'], 'code': error['code'], 'success': 'warning',
'job': error['job'], 'value': value, 'section': section}
self.messenger.send(error['message'], error['code'], 'warning', error['job'], value, section)
# ------------------------------------------------------------------------------------------ #
def error(self, job, data=None, errnum='01', value='', section='execjob'):
"""
Error loggen
@type errnum: string
@param errnum: Errornummer der aufrufenden Funktion
@type value: string
@param value: Optionaler Wert
@type section: string
@param section: Gültigkeitsbereich
"""

Gottfried Gaisbauer
committed
error = self.__get_error__(job, errnum, data)
self.job_result = {'message': error['message'], 'code': error['code'], 'success': 'error', 'job': error['job'],
'value': value, 'section': section}
self.messenger.send(error['message'], error['code'], 'error', error['job'], value, section)
# ------------------------------------------------------------------------------------------ #
def fatal(self, job, data=None, errnum='01', value='', section='execjob'):
"""
Fatal error loggen
@type errnum: string
@param errnum: Errornummer der aufrufenden Funktion
@type value: string
@param value: Optionaler Wert
@type section: string
@param section: Gültigkeitsbereich
"""

Gottfried Gaisbauer
committed
error = self.__get_error__(job, errnum, data)
self.job_result = {'message': error['message'], 'code': error['code'], 'success': 'fatal', 'job': error['job'],
'value': value, 'section': section}
self.messenger.send(error['message'], error['code'], 'fatal', error['job'], value, section)
# ------------------------------------------------------------------------------------------ #

Gottfried Gaisbauer
committed
def __check_result__(self, result):
"""
Fehlerbehandlung
@type result: string
@param result: Ein Json-String
"""
try:
self.lq_error = simplejson.loads(result)
except:
return False
try:
if self.lq_error['success'] == 'success':
return True
else:
return False
except:
return False