Implemented RodelbahnboxValidator.
[philipp/winterrodeln/wrpylib.git] / wrpylib / wrvalidators.py
1 #!/usr/bin/python2.7
2 # -*- coding: iso-8859-15 -*-
3 # $Id$
4 # $HeadURL$
5 """This file contains "validators" that convert between string and python (database) representation
6 of properties used in the "Rodelbahnbox" and "Gasthausbox".
7 The "to_python" method has to get a unicode argument.
8 """
9 import datetime
10 import re
11 import xml.dom.minidom as minidom
12 from xml.parsers.expat import ExpatError
13 import collections
14 import formencode
15 import formencode.national
16
17
18 class OrderedSchema(formencode.Schema):
19     def _convert_to_python(self, value, state):
20         pre_validators = self.pre_validators
21         chained_validators = self.chained_validators
22         for validator in pre_validators:
23             value = validator.to_python(value, state)
24         self.pre_validators = []
25         self.chained_validators = []
26         try:
27             result = formencode.Schema._convert_to_python(self, value, state)
28             ordered_result = collections.OrderedDict()
29             for key in value.iterkeys():
30                 ordered_result[key] = result[key]
31             for validator in chained_validators:
32                 ordered_result = validator.to_python(ordered_result, state)
33         finally:
34             self.pre_validators = pre_validators
35             self.chained_validators = chained_validators
36         return ordered_result
37
38
39 class NoneValidator(formencode.FancyValidator):
40     """Takes a validator and makes it possible that empty strings are mapped to None."""
41     def __init__(self, validator, python_none=None):
42         self.validator = validator
43         self.python_none = python_none
44     
45     def to_python(self, value, state=None):
46         self.assert_string(value, state)
47         if value == u'': return self.python_none
48         return self.validator.to_python(value, state)
49     
50     def from_python(self, value, state=None):
51         if value == self.python_none: return u''
52         return self.validator.from_python(value, state)
53
54
55 class NeinValidator(formencode.FancyValidator):
56     """Take an arbitrary validator and adds the possibility that the
57     string can be u'Nein'.
58     Example together with an UnsignedNone validator:
59     >>> v = NeinValidator(UnsignedNone())
60     >>> v.to_python(u'')
61     None
62     >>> v.to_python(u'34')
63     34
64     >>> v.to_python(u'Nein')
65     u'Nein'
66     """
67     def __init__(self, validator, python_no=u'Nein'):
68         self.validator = validator
69         self.python_no = python_no
70     
71     def to_python(self, value, state=None):
72         self.assert_string(value, state)
73         if value == u'Nein': return self.python_no
74         return self.validator.to_python(value, state)
75     
76     def from_python(self, value, state=None):
77         if value == self.python_no: return u'Nein'
78         return self.validator.from_python(value, state)
79
80
81 class Unicode(formencode.FancyValidator):
82     """Converts an unicode string to an unicode string:
83     u'any string' <=> u'any string'"""
84     def to_python(self, value, state=None):
85         self.assert_string(value, state)
86         return unicode(value)
87
88     def from_python(self, value, state=None):
89         return unicode(value)
90
91
92 class UnicodeNone(NoneValidator):
93     """Converts an unicode string to an unicode string:
94     u'' <=> None
95     u'any string' <=> u'any string'"""
96     def __init__(self):
97         NoneValidator.__init__(self, Unicode())
98
99
100 class Unsigned(formencode.FancyValidator):
101     """Converts an unsigned number to a string and vice versa:
102     u'0'  <=>  0
103     u'1'  <=>  1
104     u'45' <=> 45
105     """
106     def __init__(self, max=None):
107         self.iv = formencode.validators.Int(min=0, max=max)
108
109     def to_python(self, value, state=None):
110         self.assert_string(value, state)
111         return self.iv.to_python(value, state)
112     
113     def from_python(self, value, state=None):
114         return unicode(value)
115
116
117 class UnsignedNone(NoneValidator):
118     """Converts an unsigned number to a string and vice versa:
119     u''   <=> None
120     u'0'  <=>  0
121     u'1'  <=>  1
122     u'45' <=> 45
123     """
124     def __init__(self, max=None):
125         NoneValidator.__init__(self, Unsigned(max))
126
127
128 class UnsignedNeinNone(NoneValidator):
129     """ Translates a number of Nein to a number.
130     u''     <=> None
131     u'Nein' <=> 0
132     u'1'    <=> 1
133     u'2'    <=> 2
134     ...
135     """
136     def __init__(self):
137         NoneValidator.__init__(self, UnsignedNone())
138
139
140 class Loop(formencode.FancyValidator):
141     """Takes a validator and calls from_python(to_python(value))."""
142     def __init__(self, validator):
143         self.validator = validator
144
145     def to_python(self, value, state=None):
146         self.assert_string(value, state)
147         return self.validator.from_python(self.validator.to_python(value, state))
148     
149     def from_python(self, value, state=None):
150         # we don't call self.validator.to_python(self.validator.from_python(value))
151         # here because our to_python implementation basically leaves the input untouched
152         # and so should from_python do.
153         return self.validator.from_python(self.validator.to_python(value, state))
154
155
156 class DictValidator(formencode.FancyValidator):
157     """Translates strings to other values via a python directory.
158     >>> boolValidator = DictValidator({u'': None, u'Ja': True, u'Nein': False})
159     >>> boolValidator.to_python(u'')
160     None
161     >>> boolValidator.to_python(u'Ja')
162     True
163     """
164     def __init__(self, dict):
165         self.dict = dict
166     
167     def to_python(self, value, state=None):
168         self.assert_string(value, state)
169         if not self.dict.has_key(value): raise formencode.Invalid("Key not found in dict.", value, state)
170         return self.dict[value]
171     
172     def from_python(self, value, state=None):
173         for k, v in self.dict.iteritems():
174             if v == value:
175                 return k
176         raise formencode.Invalid('Invalid value', value, state)
177
178
179 class GermanBoolNone(DictValidator):
180     """Converts German bool values to the python bool type:
181     u''     <=> None
182     u'Ja'   <=> True
183     u'Nein' <=> False
184     """
185     def __init__(self):
186         DictValidator.__init__(self, {u'': None, u'Ja': True, u'Nein': False})
187
188
189 class GermanTristateTuple(DictValidator):
190     """Does the following conversion:
191     u''          <=> (None, None)
192     u'Ja'        <=> (True, False)
193     u'Teilweise' <=> (True,  True)
194     u'Nein'      <=> (False, True)"""
195     def __init__(self, yes_python = (True, False), no_python = (False, True), partly_python = (True, True), none_python = (None, None)):
196         DictValidator.__init__(self, {u'': none_python, u'Ja': yes_python, u'Nein': no_python, u'Teilweise': partly_python})
197
198
199 class GermanTristateFloat(GermanTristateTuple):
200     """Converts the a property with the possible values 0.0, 0.5, 1.0 or None
201     to a German text:
202     u''          <=> None
203     u'Ja'        <=> 1.0
204     u'Teilweise' <=> 0.5
205     u'Nein'      <=> 0.0"""
206     def __init__(self):
207         GermanTristateTuple.__init__(self, yes_python=1.0, no_python=0.0, partly_python=0.5, none_python=None)
208
209
210 class ValueComment(formencode.FancyValidator):
211     """Converts value with a potentially optional comment to a python tuple. If a comment is present, the
212     closing bracket has to be the rightmost character.
213     u''                                 <=> (None, None)
214     u'value'                            <=> (u'value', None)
215     u'value (comment)'                  <=> (u'value', u'comment')
216     u'[[link (linkcomment)]]'           <=> (u'[[link (linkcomment)]]', None)
217     u'[[link (linkcomment)]] (comment)' <=> (u'[[link (linkcomment)]]', comment)
218     """
219     def __init__(self, value_validator=UnicodeNone(), comment_validator=UnicodeNone(), comment_is_optional=True):
220         self.value_validator = value_validator
221         self.comment_validator = comment_validator
222         self.comment_is_optional = comment_is_optional
223     
224     def to_python(self, value, state=None):
225         self.assert_string(value, state)
226         if value == u'':
227             v = value
228             c = value
229         else:
230             right = value.rfind(')')
231             if right+1 != len(value):
232                 if not self.comment_is_optional: raise formencode.Invalid(u'Mandatory comment not present', value, state)
233                 v = value
234                 c = u''
235             else:
236                 left = value.rfind('(')
237                 if left < 0: raise formencode.Invalid(u'Invalid format', value, state)
238                 v = value[:left].strip()
239                 c = value[left+1:right].strip()
240         return self.value_validator.to_python(v, state), self.comment_validator.to_python(c, state)
241
242     def from_python(self, value, state=None):
243         assert len(value) == 2
244         v = self.value_validator.from_python(value[0], state)
245         c = self.comment_validator.from_python(value[1], state)
246         if len(c) > 0:
247             if len(v) > 0: return u'%s (%s)' % (v, c)
248             else: return u'(%s)' % c
249         return v
250
251
252 class SemicolonList(formencode.FancyValidator):
253     """Applies a given validator to a semicolon separated list of values and returns a python list.
254     For an empty string an empty list is returned."""
255     def __init__(self, validator=Unicode()):
256         self.validator = validator
257     
258     def to_python(self, value, state=None):
259         self.assert_string(value, state)
260         return [self.validator.to_python(s.strip(), state) for s in value.split(';')]
261     
262     def from_python(self, value, state=None):
263         return "; ".join([self.validator.from_python(s, state) for s in value])
264         
265     
266 class ValueCommentList(SemicolonList):
267     """A value-comment list looks like one of the following lines:
268         value
269         value (optional comment)
270         value1; value2
271         value1; value2 (optional comment)
272         value1 (optional comment1); value2 (optional comment2); value3 (otional comment3)
273         value1 (optional comment1); value2 (optional comment2); value3 (otional comment3)
274     This function returns the value-comment list as list of tuples:
275         [(u'value1', u'comment1'), (u'value2', None)]
276     If no comment is present, None is specified.
277     For an empty string, [] is returned."""    
278     def __init__(self, value_validator=Unicode(), comments_are_optional=True):
279         SemicolonList.__init__(self, ValueComment(value_validator, comment_is_optional=comments_are_optional))
280
281
282 class GenericDateTime(formencode.FancyValidator):
283     """Converts a generic date/time information to a datetime class with a user defined format.
284     '2009-03-22 20:36:15' would be specified as '%Y-%m-%d %H:%M:%S'."""
285     
286     def __init__(self, date_time_format = '%Y-%m-%d %H:%M:%S', **keywords):
287         formencode.FancyValidator.__init__(self, **keywords)
288         self.date_time_format = date_time_format
289     
290     def to_python(self, value, state=None):
291         self.assert_string(value, state)
292         try: return datetime.datetime.strptime(value, self.date_time_format)
293         except ValueError, e: raise formencode.Invalid(str(e), value, state)
294     
295     def from_python(self, value, state=None):
296         return value.strftime(self.date_time_format)
297
298
299 class DateTimeNoSec(GenericDateTime):
300     def __init__(self, **keywords):
301         GenericDateTime.__init__(self, '%Y-%m-%d %H:%M', **keywords)
302
303
304 class DateNone(NoneValidator):
305     """Converts date information to date classes with the format '%Y-%m-%d' or None."""
306     def __init__(self):
307         NoneValidator.__init__(self, GenericDateTime('%Y-%m-%d'))
308
309
310 class Geo(formencode.FancyValidator):
311     """Formats to coordinates '47.076207 N 11.453553 E' to the (latitude, longitude) tuplet."""
312     def to_python(self, value, state=None):
313         self.assert_string(value, state)
314         r = re.match(u'(\d+\.\d+) N (\d+\.\d+) E', value)
315         if r is None: raise formencode.Invalid(u"Coordinates '%s' have not a format like '47.076207 N 11.453553 E'" % value, value, state)
316         return (float(r.groups()[0]), float(r.groups()[1]))
317     
318     def from_python(self, value, state=None):
319         latitude, longitude = value
320         return u'%.6f N %.6f E' % (latitude, longitude)
321
322
323 class GeoNone(NoneValidator):
324     """Formats to coordinates '47.076207 N 11.453553 E' to the (latitude, longitude) tuplet."""
325     def __init__(self):
326         NoneValidator.__init__(self, Geo(), (None, None))
327
328
329 class MultiGeo(formencode.FancyValidator):
330     "Formats multiple coordinates, even in multiple lines to [(latitude, longitude, elevation), ...] or [(latitude, longitude, None), ...] tuplets."
331     
332     # Valid for input_format
333     FORMAT_GUESS = 0         # guesses the input format; default for input_format
334     FORMAT_NONE = -1          # indicates missing formats
335     
336     # Valid for input_format and output_format
337     FORMAT_GEOCACHING = 1    # e.g. "N 47° 13.692 E 011° 25.535"
338     FORMAT_WINTERRODELN = 2  # e.g. "47.222134 N 11.467211 E"
339     FORMAT_GMAPPLUGIN = 3    # e.g. "47.232922, 11.452239"
340     FORMAT_GPX = 4           # e.g. "<trkpt lat="47.181289" lon="11.408827"><ele>1090.57</ele></trkpt>"
341     
342     input_format = FORMAT_GUESS
343     output_format = FORMAT_WINTERRODELN
344     last_input_format = FORMAT_NONE
345
346     def __init__(self, input_format = FORMAT_GUESS, output_format = FORMAT_WINTERRODELN, **keywords):
347         self.input_format = input_format
348         self.output_format = output_format
349         formencode.FancyValidator.__init__(self, if_empty = (None, None, None), **keywords)
350     
351     def to_python(self, value, state=None):
352         self.assert_string(value, state)
353         input_format = self.input_format
354         if not input_format in [self.FORMAT_GUESS, self.FORMAT_GEOCACHING, self.FORMAT_WINTERRODELN, self.FORMAT_GMAPPLUGIN, self.FORMAT_GPX]:
355             raise formencode.Invalid(u"input_format %d is not recognized" % input_format, value, state) # Shouldn't it be an other type of runtime error?
356         lines = [line.strip() for line in value.split("\n") if len(line.strip()) > 0]
357         
358         result = []
359         for line in lines:
360             if input_format == self.FORMAT_GUESS or input_format == self.FORMAT_GEOCACHING:
361                 r = re.match(u'N ?(\d+)° ?(\d+\.\d+) +E ?(\d+)° ?(\d+\.\d+)', line)
362                 if not r is None:
363                     g = r.groups()
364                     result.append((float(g[0]) + float(g[1])/60, float(g[2]) + float(g[3])/60, None))
365                     last_input_format = self.FORMAT_WINTERRODELN
366                     continue
367                     
368             if input_format == self.FORMAT_GUESS or input_format == self.FORMAT_WINTERRODELN:
369                 r = re.match(u'(\d+\.\d+) N (\d+\.\d+) E', line)
370                 if not r is None:
371                     result.append((float(r.groups()[0]), float(r.groups()[1]), None))
372                     last_input_format = self.FORMAT_WINTERRODELN
373                     continue
374                 
375             if input_format == self.FORMAT_GUESS or input_format == self.FORMAT_GMAPPLUGIN:
376                 r = re.match(u'(\d+\.\d+), ?(\d+\.\d+)', line)
377                 if not r is None:
378                     result.append((float(r.groups()[0]), float(r.groups()[1]), None))
379                     last_input_format = self.FORMAT_GMAPPLUGIN
380                     continue
381                 
382             if input_format == self.FORMAT_GUESS or input_format == self.FORMAT_GPX:
383                 try:
384                     xml = minidom.parseString(line)
385                     coord = xml.documentElement
386                     lat = float(coord.getAttribute('lat'))
387                     lon = float(coord.getAttribute('lon'))
388                     try: ele = float(coord.childNodes[0].childNodes[0].nodeValue)
389                     except (IndexError, ValueError): ele = None
390                     result.append((lat, lon, ele))
391                     last_input_format = self.FORMAT_GPX
392                     continue
393                 except (ExpatError, IndexError, ValueError): pass
394
395             raise formencode.Invalid(u"Coordinates '%s' have no known format" % line, value, state)
396             
397         return result
398     
399     def from_python(self, value, state=None):
400         output_format = self.output_format
401         result = []
402         for latitude, longitude, height in value:
403             if output_format == self.FORMAT_GEOCACHING:
404                 degree = latitude
405                 result.append(u'N %02d° %02.3f E %03d° %02.3f' % (latitude, latitude % 1 * 60, longitude, longitude % 1 * 60))
406                 
407             elif output_format == self.FORMAT_WINTERRODELN:
408                 result.append(u'%.6f N %.6f E' % (latitude, longitude))
409
410             elif output_format == self.FORMAT_GMAPPLUGIN:
411                 result.append(u'%.6f, %.6f' % (latitude, longitude))
412                 
413             elif output_format == self.FORMAT_GPX:
414                 if not height is None: result.append(u'<trkpt lat="%.6f" lon="%.6f"><ele>%.2f</ele></trkpt>' % (latitude, longitude, height))
415                 else: result.append(u'<trkpt lat="%.6f" lon="%.6f"/>' % (latitude, longitude))
416             
417             else:
418                 raise formencode.Invalid(u"output_format %d is not recognized" % output_format, value, state) # Shouldn't it be an other type of runtime error?
419             
420         return "\n".join(result)
421
422
423 # deprecated
424 class AustrianPhoneNumber(formencode.FancyValidator):
425     """
426     Validates and converts phone numbers to +##/###/####### or +##/###/#######-### (having an extension)
427     @param  default_cc      country code for prepending if none is provided, defaults to 43 (Austria)
428     ::
429         >>> v = AustrianPhoneNumber()
430         >>> v.to_python(u'0512/12345678')
431         u'+43/512/12345678'
432         >>> v.to_python(u'+43/512/12345678')
433         u'+43/512/12345678'
434         >>> v.to_python(u'0512/1234567-89') # 89 is the extension
435         u'+43/512/1234567-89'
436         >>> v.to_python(u'+43/512/1234567-89')
437         u'+43/512/1234567-89'
438         >>> v.to_python(u'0512 / 12345678') # Exception
439         >>> v.to_python(u'0512-12345678') # Exception
440     """
441     # Inspired by formencode.national.InternationalPhoneNumber
442
443     default_cc = 43 # Default country code
444     messages = {'phoneFormat': "'%%(value)s' is an invalid format. Please enter a number in the form +43/###/####### or 0###/########."}
445
446     def to_python(self, value, state=None):
447         self.assert_string(value, state)
448         m = re.match(u'^(?:\+(\d+)/)?([\d/]+)(?:-(\d+))?$', value)
449         # This will separate 
450         #     u'+43/512/1234567-89'  => (u'43', u'512/1234567', u'89')
451         #     u'+43/512/1234/567-89' => (u'43', u'512/1234/567', u'89')
452         #     u'+43/512/1234/567'    => (u'43', u'512/1234/567', None)
453         #     u'0512/1234567'        => (None, u'0512/1234567', None)
454         if m is None: raise formencode.Invalid(self.message('phoneFormat', None) % {'value': value}, value, state)
455         (country, phone, extension) = m.groups()
456         
457         # Phone
458         if phone.find(u'//') > -1 or phone.count('/') == 0: raise formencode.Invalid(self.message('phoneFormat', None) % {'value': value}, value, state)
459         
460         # Country
461         if country is None:
462             if phone[0] != '0': raise formencode.Invalid(self.message('phoneFormat', None) % {'value': value}, value, state)
463             phone = phone[1:]
464             country = unicode(self.default_cc)
465         
466         if extension is None: return '+%s/%s' % (country, phone)
467         return '+%s/%s-%s' % (country, phone, extension)
468
469
470 # Deprecated
471 class AustrianPhoneNumberNone(NoneValidator):
472     def __init__(self):
473         NoneValidator.__init__(self, AustrianPhoneNumber())
474
475
476 # Deprecated
477 class AustrianPhoneNumberCommentLoop(NoneValidator):
478     def __init__(self):
479         NoneValidator.__init__(self, Loop(ValueComment(AustrianPhoneNumber())))
480
481
482 class GermanDifficulty(DictValidator):
483     """Converts the difficulty represented in a number from 1 to 3 (or None)
484     to a German representation:
485     u''       <=> None
486     u'leicht' <=> 1
487     u'mittel' <=> 2
488     u'schwer' <=> 3"""
489     def __init__(self):
490         DictValidator.__init__(self, {u'': None, u'leicht': 1, u'mittel': 2, u'schwer': 3})
491
492
493 class GermanAvalanches(DictValidator):
494     """Converts the avalanches property represented as number from 1 to 4 (or None)
495     to a German representation:
496     u''             <=> None
497     u'kaum'         <=> 1
498     u'selten'       <=> 2
499     u'gelegentlich' <=> 3
500     u'häufig'       <=> 4"""
501     def __init__(self):
502         DictValidator.__init__(self, {u'': None, u'kaum': 1, u'selten': 2, u'gelegentlich': 3, u'häufig': 4})
503
504
505 class GermanPublicTransport(DictValidator):
506     """Converts the public_transport property represented as number from 1 to 6 (or None)
507     to a German representation:
508     u''            <=> None
509     u'Sehr gut'    <=> 1
510     u'Gut'         <=> 2
511     u'Mittelmäßig' <=> 3
512     u'Schlecht'    <=> 4
513     u'Nein'        <=> 5
514     u'Ja'          <=> 6"""
515     def __init__(self):
516         DictValidator.__init__(self, {u'': None, u'Sehr gut': 1, u'Gut': 2, u'Mittelmäßig': 3, u'Schlecht': 4, u'Nein': 5, u'Ja': 6})
517
518
519 class GermanTristateFloatComment(ValueComment):
520     """Converts the a property with the possible values 0.0, 0.5, 1.0 or None and an optional comment
521     in parenthesis to a German text:
522     u''                  <=> (None, None)
523     u'Ja'                <=> (1.0,  None)
524     u'Teilweise'         <=> (0.5,  None)
525     u'Nein'              <=> (0.0,  None)
526     u'Ja (aber schmal)'  <=> (1.0,  u'aber schmal')
527     u'Teilweise (oben)'  <=> (0.5,  u'oben')
528     u'Nein (aber breit)' <=> (0.0,  u'aber breit')
529     """
530     def __init__(self):
531         ValueComment.__init__(self, GermanTristateFloat())
532
533
534 class UnsignedCommentNone(NoneValidator):
535     """Converts the a property with unsigned values an optional comment
536     in parenthesis to a text:
537     u''           <=> (None, None)
538     u'2 (Mo, Di)' <=> (2,  u'Mo, Di')
539     u'7'          <=> (7,  None)
540     u'0'          <=> (0,  None)
541     """
542     def __init__(self, max=None):
543         NoneValidator.__init__(self, ValueComment(Unsigned(max=max)), (None, None))
544
545
546 class GermanCachet(formencode.FancyValidator):
547     """Converts a "Gütesiegel":
548     u'' <=> None
549     u'Nein' <=> 'Nein'
550     u'Tiroler Naturrodelbahn-Gütesiegel 2009 mittel' <=> u'Tiroler Naturrodelbahn-Gütesiegel 2009 mittel'"""
551     def to_python(self, value, state=None):
552         self.assert_string(value, state)
553         if value == u'': return None
554         elif value == u'Nein': return value
555         elif value.startswith(u'Tiroler Naturrodelbahn-Gütesiegel '):
556             p = value.split(" ")
557             Unsigned().to_python(p[2], state) # check if year can be parsed
558             if not p[3] in ['leicht', 'mittel', 'schwer']: raise formencode.Invalid("Unbekannter Schwierigkeitsgrad", value, state)
559             return value
560         else: raise formencode.Invalid(u"Unbekanntes Gütesiegel", value, state)
561     
562     def from_python(self, value, state=None):
563         if value is None: return u''
564         assert value != u''
565         return self.to_python(value, state)
566
567
568 class Url(formencode.FancyValidator):
569     """Validates an URL. In contrast to fromencode.validators.URL, umlauts are allowed."""
570     # formencode 1.2.5 to formencode 1.3.0a1 sometimes raise ValueError instead of Invalid exceptions
571     # https://github.com/formencode/formencode/pull/61
572     urlv = formencode.validators.URL()    
573
574     def to_python(self, value, state=None):
575         self.assert_string(value, state)
576         v = value
577         v = v.replace(u'ä', u'a')
578         v = v.replace(u'ö', u'o')
579         v = v.replace(u'ü', u'u')
580         v = v.replace(u'ß', u'ss')
581         v = self.urlv.to_python(v, state)
582         return value
583     
584     def from_python(self, value, state=None):
585         return value
586
587
588 class UrlNeinNone(NoneValidator):
589     """Validates an URL. In contrast to fromencode.validators.URL, umlauts are allowed.
590     The special value u"Nein" is allowed."""
591     def __init__(self):
592         NoneValidator.__init__(self, NeinValidator(Url()))
593
594
595 class ValueCommentListNeinLoopNone(NoneValidator):
596     """Translates a semicolon separated list of values with optional comments in paranthesis or u'Nein' to itself.
597     An empty string is translated to None:
598     u''                   <=> None
599     u'Nein'               <=> u'Nein'
600     u'T-Mobile (gut); A1' <=> u'T-Mobile (gut); A1'"""
601     def __init__(self):
602         NoneValidator.__init__(self, NeinValidator(Loop(ValueCommentList())))
603
604
605 class PhoneNumber(formencode.FancyValidator):
606     """Telefonnumber in international format, e.g. u'+43-699-1234567'"""
607     def __init__(self, default_cc=43):
608         self.validator = formencode.national.InternationalPhoneNumber(default_cc=lambda: default_cc)
609
610     def to_python(self, value, state=None):
611         return unicode(self.validator.to_python(value, state))
612
613     def from_python(self, value, state=None):
614         return self.validator.from_python(value, state)
615
616
617 class PhoneCommentListNeinLoopNone(NoneValidator):
618     """List with semicolon-separated phone numbers in international format with optional comment or 'Nein' as string:
619     u''                                                       <=> None
620     u'Nein'                                                   <=> u'Nein'
621     u'+43-699-1234567 (nicht nach 20:00 Uhr); +43-512-123456' <=> u'+43-699-1234567 (nicht nach 20:00 Uhr); +43-512-123456'
622     """
623     def __init__(self, comments_are_optional):
624         NoneValidator.__init__(self, NeinValidator(Loop(ValueCommentList(PhoneNumber(default_cc=43), comments_are_optional=comments_are_optional))))
625
626
627 class MaskedEmail(formencode.FancyValidator):
628     """A masked email address as defined here is an email address that has the `@` character replacted by the text `(at)`.
629     So instead of `abd.def@example.com` it would be `abc.def(at)example.com`.
630     This validator takes either a normal or a masked email address in it's to_python method and returns the normal email address as well
631     as a bool indicating whether the email address was masked.
632     u''                       <=> (None, None)
633     u'abc.def@example.com'    <=> (u'abc.def@example.com', False)
634     u'abc.def(at)example.com' <=> (u'abc.def@example.com', True)
635     
636     """
637     def __init__(self, *args, **kw):
638         if not kw.has_key('strip'): kw['strip'] = True
639         if not kw.has_key('not_empty'): kw['not_empty'] = False
640         if not kw.has_key('if_empty'): kw['if_empty'] = (None, None)
641         self.at = '(at)'
642         formencode.FancyValidator.__init__(self, *args, **kw)
643
644     def _to_python(self, value, state=None):
645         email = value.replace(self.at, '@')
646         masked = value != email
647         val_email = formencode.validators.Email()
648         return val_email.to_python(email, state), masked
649
650     def _from_python(self, value, state=None):
651         email, masked = value
652         if email is None: return u''
653         val_email = formencode.validators.Email()
654         email = val_email.from_python(email, state)
655         if masked: email = email.replace('@', self.at)
656         return email
657
658
659 class EmailCommentListNeinLoopNone(NoneValidator):
660     """Converts a semicolon-separated list of email addresses with optional comments to itself.
661     The special value of u'Nein' indicates that there are no email addresses.
662     The empty string translates to None:
663     u''                                                   <=> None
664     u'Nein'                                               <=> u'Nein'
665     u'first@example.com'                                  <=> u'first@example.com'
666     u'first@example.com (Nur Winter); second@example.com' <=> u'first@example.com (Nur Winter); second@example.com'
667
668     If the parameter allow_masked_email is true, the following gives no error:
669     u'abc.def(at)example.com (comment)'                   <=> u'abc.def(at)example.com (comment)'
670     """
671     def __init__(self, allow_masked_email=False):
672         NoneValidator.__init__(self, NeinValidator(Loop(ValueCommentList(MaskedEmail() if allow_masked_email else formencode.validators.Email()))))
673
674
675 class WikiPage(formencode.FancyValidator):
676     """Validates wiki page name like u'[[Birgitzer Alm]]'.
677     The page is not checked for existance.
678     An empty string is an error.
679     u'[[Birgitzer Alm]]' <=> u'[[Birgitzer Alm]]'
680     """
681     def to_python(self, value, state=None):
682         self.assert_string(value, state)
683         if not value.startswith('[[') or not value.endswith(']]'): 
684             raise formencode.Invalid('No valid wiki page name', value, state)
685         return value
686     
687     def from_python(self, value, state=None):
688         return value
689
690
691 class WikiPageList(SemicolonList):
692     """Validates a list of wiki pages like u'[[Birgitzer Alm]]; [[Kemater Alm]]'.
693     u'[[Birgitzer Alm]]; [[Kemater Alm]]' <=> [u'[[Birgitzer Alm]]', u'[[Kemater Alm]]']
694     u'[[Birgitzer Alm]]'                  <=> [u'[[Birgitzer Alm]]']
695     u''                                   <=> []
696     """
697     def __init__(self):
698         SemicolonList.__init__(self, WikiPage())
699
700
701 class WikiPageListLoopNone(NoneValidator):
702     """Validates a list of wiki pages like u'[[Birgitzer Alm]]; [[Kemater Alm]]' as string.
703     u'[[Birgitzer Alm]]; [[Kemater Alm]]' <=> u'[[Birgitzer Alm]]; [[Kemater Alm]]'
704     u'[[Birgitzer Alm]]'                  <=> u'[[Birgitzer Alm]]'
705     u''                                   <=> None
706     """
707     def __init__(self):
708         NoneValidator.__init__(self, Loop(WikiPageList()))
709
710
711 class TupleSecondValidator(formencode.FancyValidator):
712     """Does not really validate anything but puts the string through
713     a validator in the second part of a tuple.
714     Examples with an Unsigned() validator and the True argument:
715     u'6' <=> (True, 6)
716     u'2' <=> (True, 2)"""
717     def __init__(self, first=True, validator=UnicodeNone()):
718         self.first = first
719         self.validator = validator
720     
721     def to_python(self, value, state=None):
722         self.assert_string(value, state)
723         return self.first, self.validator.to_python(value, state)
724     
725     def from_python(self, value, state=None):
726         assert value[0] == self.first
727         return self.validator.from_python(value[1], state)
728
729
730 class BoolUnicodeTupleValidator(NoneValidator):
731     """Translates an unparsed string or u'Nein' to a tuple:
732     u''         <=> (None, None)
733     u'Nein'     <=> (False, None)
734     u'any text' <=> (True, u'any text')
735     """
736     def __init__(self, validator=UnicodeNone()):
737         NoneValidator.__init__(self, NeinValidator(TupleSecondValidator(True, validator), (False, None)), (None, None))
738
739
740 class GermanLift(BoolUnicodeTupleValidator):
741     """Checks a lift_details property. It is a value comment property with the following
742     values allowed:
743     u'Sessellift'
744     u'Gondel'
745     u'Linienbus'
746     u'Taxi'
747     u'Sonstige'
748     Alternatively, the value u'Nein' is allowed.
749     An empty string maps to (None, None).
750     
751     Examples:
752     u''                                       <=> (None, None)
753     u'Nein'                                   <=> (False, None)
754     u'Sessellift                              <=> (True, u'Sessellift')
755     u'Gondel (nur bis zur Hälfte)'            <=> (True, u'Gondel (nur bis zur Hälfte)')
756     u'Sessellift; Taxi'                       <=> (True, u'Sessellift; Taxi')
757     u'Sessellift (Wochenende); Taxi (6 Euro)' <=> (True, u'Sessellift (Wochenende); Taxi (6 Euro)')
758     """
759     def __init__(self):
760         BoolUnicodeTupleValidator.__init__(self, Loop(ValueCommentList(DictValidator({u'Sessellift': u'Sessellift', u'Gondel': u'Gondel', u'Linienbus': u'Linienbus', u'Taxi': u'Taxi', u'Sonstige': u'Sonstige'}))))
761         
762
763 class SledRental(BoolUnicodeTupleValidator):
764     """The value can be an empty string, u'Nein' or a comma-separated list of unicode strings with optional comments.
765     u''                                       <=> (None, None)
766     u'Nein'                                   <=> (False, None)
767     u'Talstation (nur mit Ticket); Schneealm' <=> (True, u'Talstation (nur mit Ticket); Schneealm')"""
768     def __init__(self):
769         BoolUnicodeTupleValidator.__init__(self, Loop(ValueCommentList()))
770
771
772 class RodelbahnboxDictValidator(OrderedSchema):
773     """Takes the fields of the Rodelbahnbox as dict of strings and returns them as dict of appropriet types."""
774     def __init__(self):
775         self.add_field(u'Position', GeoNone()) # '47.583333 N 15.75 E'
776         self.add_field(u'Position oben', GeoNone()) # '47.583333 N 15.75 E'
777         self.add_field(u'Höhe oben', UnsignedNone()) # '2000'
778         self.add_field(u'Position unten', GeoNone()) # '47.583333 N 15.75 E'
779         self.add_field(u'Höhe unten', UnsignedNone()) # '1200'
780         self.add_field(u'Länge', UnsignedNone()) # 3500
781         self.add_field(u'Schwierigkeit', GermanDifficulty()) # 'mittel'
782         self.add_field(u'Lawinen', GermanAvalanches()) # 'kaum'
783         self.add_field(u'Betreiber', UnicodeNone()) # 'Max Mustermann'
784         self.add_field(u'Öffentliche Anreise', GermanPublicTransport()) # 'Mittelmäßig'
785         self.add_field(u'Aufstieg möglich', GermanBoolNone()) # 'Ja'
786         self.add_field(u'Aufstieg getrennt', GermanTristateFloatComment()) # 'Ja'
787         self.add_field(u'Gehzeit', UnsignedNone()) # 90
788         self.add_field(u'Aufstiegshilfe', GermanLift()) # 'Gondel (unterer Teil)'
789         self.add_field(u'Beleuchtungsanlage', GermanTristateFloatComment())
790         self.add_field(u'Beleuchtungstage', UnsignedCommentNone(7)) # '3 (Montag, Mittwoch, Freitag)'
791         self.add_field(u'Rodelverleih', SledRental()) # 'Talstation Serlesbahnan'
792         self.add_field(u'Gütesiegel', GermanCachet()) # 'Tiroler Naturrodelbahn-Gütesiegel 2009 mittel'
793         self.add_field(u'Webauskunft', UrlNeinNone()) # 'http://www.nösslachhütte.at/page9.php'
794         self.add_field(u'Telefonauskunft', PhoneCommentListNeinLoopNone(comments_are_optional=False)) # '+43-664-5487520 (Mitterer Alm)'
795         self.add_field(u'Bild', UnicodeNone())
796         self.add_field(u'In Übersichtskarte', GermanBoolNone())
797         self.add_field(u'Forumid', UnsignedNeinNone())