92b2708492e0506174f2825071ecb9f0bb6b0f41
[dbuscron] / dbuscron / parser.py
1 # encoding: utf-8
2 from __future__ import with_statement
3 import os
4 import re
5 from dbuscron.bus import DbusBus
6
7 def unescape_():
8     h = '[0-9A-Fa-f]'
9     r = re.compile(r'\\x('+h+r'{2})|\\u('+h+'{4})')
10
11     def unescape(value):
12         if not (value and
13                 (r'\x' in value or r'\u' in value)):
14             return value
15
16         return r.sub(
17             lambda m: chr(int(m.group(1), 16))
18                 if m.group(1) is not None else
19                     unichr(int(m.group(2), 16))
20                         .encode('utf-8'),\
21             value)
22     return unescape
23 unescape = unescape_()
24
25 def product(*args):
26     if args:
27         head, tail = args[0], args[1:]
28         for h in head:
29             for t in product(*tail):
30                 yield (h,) + t
31
32     else:
33         yield ()
34
35 class CrontabParserError(SyntaxError):
36     def __init__(self, message, lineno, expected=None):
37         if expected:
38             if isinstance(expected, (tuple, list)):
39                 exp = ' (expected %s or %s)' % (', '.join(expected[:-1]), expected[-1])
40         else:
41             exp = ''
42
43         msg = '%s%s at line %d' % (message, exp, lineno)
44
45         SyntaxError.__init__(self, msg)
46
47 def CrontabParser(filename):
48     if os.path.isfile(filename):
49         parser_class = FileParser
50
51     elif os.path.isdir(filename):
52         parser_class = DirectoryParser
53
54     else:
55         raise SystemError("I can parse only directories or simple files.")
56
57     return parser_class(filename)
58
59 class FileParser(object):
60     __fields_sep = re.compile(r'\s+')
61     __envvar_sep = re.compile(r'\s*=\s*')
62     __fields_chk = {
63             'bus_'         : None,
64             'type_'        : ('signal', 'method_call', 'method_return', 'error'),
65             'sender_'      : None,
66             'interface_'   : re.compile(r'^[a-zA-Z][a-zA-Z0-9_.]+$'),
67             'path_'        : re.compile(r'^/[a-zA-Z0-9_/]+$'),
68             'member_'      : re.compile(r'^[a-zA-Z][a-zA-Z0-9_]+$'),
69             'destination_' : None,
70             'args_'        : None,
71             }
72     __fields = [
73             'bus_',
74             'type_',
75             'sender_',
76             'interface_',
77             'path_',
78             'member_',
79             'destination_',
80             'args_',
81             ]
82
83     def __init__(self, fname):
84         self.__bus = DbusBus()
85         self.__filename = fname
86         self.__environ = dict()
87
88     @property
89     def environ(self):
90         return self.__environ
91
92     def _iterate_file(self, filename):
93         # bus type sender interface path member destination args command
94         lineno = 0
95         with open(filename) as f:
96             for line in f:
97                 lineno += 1
98                 line = line.strip()
99
100                 if not line or line.startswith('#'):
101                     continue
102
103                 parts = self.__fields_sep.split(line, 8)
104                 if len(parts) < 9:
105                     parts = self.__envvar_sep.split(line, 1)
106                     if len(parts) == 2:
107                         self.__environ[parts[0]] = parts[1]
108                         continue
109
110                     raise CrontabParserError('Unexpected number of records', lineno)
111
112                 rule = [('s', 'S'), self.__fields_chk['type_'], (None,), (None,), (None,), (None,), (None,), (None,)]
113
114                 for p in range(0, 8):
115                     if parts[p] != '*':
116                         rule[p] = parts[p].split(',')
117
118                 command = parts[8]
119
120                 for r in product(*rule):
121                     r = list(r)
122                     if r[0] == 'S':
123                         r[0] = self.__bus.system
124                     elif r[0] == 's':
125                         r[0] = self.__bus.session
126                     else:
127                         raise CrontabParserError('Unexpected bus value', lineno, expected=('S', 's', '*'))
128
129                     if r[7]:
130                         r[7] = map(unescape, r[7].split(';'))
131
132                     ruled = dict()
133                     for i, f in enumerate(self.__fields):
134                         if r[i] is not None and self.__fields_chk[f]:
135                             if isinstance(self.__fields_chk[f], tuple):
136                                 if r[i] not in self.__fields_chk[f]:
137                                     raise CrontabParserError('Unexpected %s value' % (f.strip('_')), lineno,
138                                             expected=self.__fields_chk[f])
139                             else:
140                                 if not self.__fields_chk[f].match(r[i]):
141                                     raise CrontabParserError('Incorrect %s value' % (f.strip('_')), lineno)
142                         ruled[f] = r[i]
143
144                     yield ruled, command
145
146     def __iter__(self):
147         return self._iterate_file(self.__filename)
148
149 class DirectoryParser(CrontabParser):
150
151     def __init__(self, dirname, recursive=False):
152         self.__dirname = dirname
153         self.__recursive = recursive
154         super(DirectoryParser, self).__init__(None)
155
156     def _dirwalker_plain(self):
157         for i in os.listdir(self.__dirname):
158             if os.path.isfile(i):
159                 yield i
160
161     def _dirwalker_recursive(self):
162         for r, d, f in os.walk(self.__dirname):
163             for i in f:
164                 yield i
165
166     def __iter__(self):
167
168         if self.__recursive:
169             dirwalker = self._dirwalker_recursive
170         else:
171             dirwalker = self._dirwalker_plain
172
173         for fname in dirwalker():
174             fullname = os.path.join(self.__dirname, fname)
175             self.__filename = fullname
176             for item in self._iterate_file(fullname):
177                 yield item
178
179 def OptionsParser(args=None, help=u'', **opts):
180
181     from optparse import OptionParser
182     import dbuscron
183     parser = OptionParser(usage=help, version="%prog " + dbuscron.__version__)
184     for opt, desc in opts.iteritems():
185         names = desc.pop('names')
186         desc['dest'] = opt
187         parser.add_option(*names, **desc)
188
189     return parser.parse_args(args)[0]
190