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