update some syntax and make the code more future-proof ;)
[enigma2-plugins.git] / growlee / src / Syslog.py
1 from __future__ import print_function
2
3 from twisted.internet.protocol import DatagramProtocol
4 from twisted.internet import reactor
5 from twisted.internet import reactor
6 from time import strftime, strptime, localtime
7 from os import uname
8
9 from Screens.MessageBox import MessageBox
10 from Tools import Notifications
11
12 from GrowleeConnection import emergencyDisable
13 from . import NOTIFICATIONID
14
15 SYSLOG_UDP_PORT = 514
16
17 FACILITY = {
18         'kern': 0, 'user': 1, 'mail': 2, 'daemon': 3,
19         'auth': 4, 'syslog': 5, 'lpr': 6, 'news': 7,
20         'uucp': 8, 'cron': 9, 'authpriv': 10, 'ftp': 11,
21         'local0': 16, 'local1': 17, 'local2': 18, 'local3': 19,
22         'local4': 20, 'local5': 21, 'local6': 22, 'local7': 23,
23 }
24
25 SEVERITY = {
26         'emerg': 0, 'alert':1, 'crit': 2, 'err': 3,
27         'warning': 4, 'notice': 5, 'info': 6, 'debug': 7
28 }
29
30 reverse = lambda map: dict((v,k) for k,v in map.items())
31
32 SEVERITYMAP = {
33         MessageBox.TYPE_YESNO: SEVERITY['debug'],
34         MessageBox.TYPE_INFO: SEVERITY['info'],
35         MessageBox.TYPE_WARNING: SEVERITY['warning'],
36         MessageBox.TYPE_ERROR: SEVERITY['err'],
37 }
38
39 class SyslogNetworkProtocol(DatagramProtocol):
40         addr = None
41         def __init__(self, host):
42                 self.host = host
43
44         def gotIP(self, ip):
45                 self.addr = (ip, SYSLOG_UDP_PORT)
46
47         def noIP(self, error):
48                 print("--------------------------------", error)
49                 emergencyDisable()
50
51         def startProtocol(self):
52                 reactor.resolve(self.host.address.value).addCallback(self.gotIP).addErrback(self.noIP)
53
54         def sendNotification(self, title='No title.', description='No message.', priority=0):
55                 if not self.transport or not self.addr or not self.host.enable_outgoing.value:
56                         return
57
58                 ltime = localtime()
59                 day = strftime("%d", ltime)
60                 if day[0] == "0":
61                         day = " " + day[1:]
62                 value = strftime("%b %%s %H:%M:%S", ltime)
63                 timestamp = value % (day,)
64                 payload = "<%d>%s %s growlee: (%s) %s" % (FACILITY['local0'] * 8 + SEVERITYMAP[priority], timestamp, uname()[1], title, description.replace('\n', ' '),)
65                 # TODO: better way to stay within the 1024 char-limit (e.g. ignore title, multiple packets, ...)
66                 #if len(payload) > 1024:
67                 #       payload = payload[:1024]
68                 self.transport.write(payload, self.addr)
69
70         def datagramReceived(self, data, addr):
71                 if not self.host.enable_incoming.value:
72                         return
73
74                 Len = len(data)
75                 # NOTE: since we're capable of handling longer messages, lets just do so
76                 # even if they do not comply to the protocol
77                 #if Len > 1024: # invalid according to rfc
78                 #       return
79
80                 # read prio field
81                 prio, data = data.split('>', 1)
82                 prio = int(prio[1:])
83                 facility, severity = divmod(prio, 8) # just the ids
84                 #facility = reverse(FACILITY)[facility]
85                 type = reverse(SEVERITYMAP).get(severity, MessageBox.TYPE_ERROR)
86
87                 # parse remaining header
88                 try:
89                         # try to parse timestamp to determine validity
90                         timestamp = strptime(data[:15], '%b %d %H:%M:%S')
91                 except ValueError:
92                         message = data
93                 else:
94                         hostname, body = data[16:].split(' ', 1)
95                         # NOTE: we could re-process timestamp to get a customized display format,
96                         # but lets just keep this for now
97                         message = hostname + ' @ ' + data[:15] + ': ' + body
98
99                 Notifications.AddNotificationWithID(
100                         NOTIFICATIONID,
101                         MessageBox,
102                         text = message,
103                         type = type,
104                         timeout = 10, # XXX: un-hardcode timeout?
105                         close_on_any_key = True,
106                 )
107
108 class SyslogAbstraction:
109         def __init__(self, host):
110                 self.syslog = SyslogNetworkProtocol(host)
111                 listeningPort = SYSLOG_UDP_PORT if host.enable_incoming.value else 0
112                 self.serverPort = reactor.listenUDP(listeningPort, self.syslog)
113
114         def sendNotification(self, title='No title.', description='No description.', priority=-1, timeout=-1):
115                 self.syslog.sendNotification(title=title, description=description, priority=priority)
116
117         def stop(self):
118                 return self.serverPort.stopListening()