This repository has been archived by the owner on Jul 3, 2019. It is now read-only.
/
vcard_validators.py
executable file
·716 lines (622 loc) · 29.6 KB
/
vcard_validators.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
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
398
399
400
401
402
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
439
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
483
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
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
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
708
709
710
711
712
713
714
715
716
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
vCard v3.0 (RFC 2426) validating functions
Should contain all the general purpose validation code extracted from
standards.
"""
import re
import six
import warnings
# Third party modules
import isodate
# Local modules
from .vcard_definitions import (
DOUBLE_QUOTE_CHARACTER, ID_CHARACTERS, ESCAPED_CHARACTERS, QUOTE_SAFE_CHARACTERS, SAFE_CHARACTERS, SPACE_CHARACTER)
from .vcard_errors import (
# Error literals
NOTE_INVALID_DATE,
NOTE_INVALID_LANGUAGE_VALUE,
NOTE_INVALID_PARAMETER_NAME,
NOTE_INVALID_PARAMETER_VALUE,
NOTE_INVALID_SUB_VALUE,
NOTE_INVALID_SUB_VALUE_COUNT,
NOTE_INVALID_TEXT_VALUE,
NOTE_INVALID_TIME,
NOTE_INVALID_TIME_ZONE,
NOTE_INVALID_URI,
NOTE_INVALID_VALUE,
NOTE_INVALID_VALUE_COUNT,
NOTE_INVALID_X_NAME,
NOTE_MISMATCH_PARAMETER,
NOTE_MISSING_PARAMETER,
NOTE_NON_EMPTY_PARAMETER,
WARN_DEFAULT_TYPE_VALUE,
WARN_INVALID_EMAIL_TYPE,
WARN_MULTIPLE_NAMES,
# Functions
show_warning,
# Classes
VCardError,
VCardItemCountError,
VCardNameError,
VCardValueError
)
VALID_DATE = re.compile(r'^\d{4}-?\d{2}-?\d{2}$')
VALID_TIMEZONE = re.compile(r'^(Z|[+-]\d{2}:?\d{2})$')
VALID_TIME_WITH_TIMEZONE = re.compile(r'^(\d{2}:?\d{2}:?\d{2}(?:,\d+)?)(.*)$')
VALID_LANGUAGE_TAG = re.compile(r'^([a-z]{1,8})(-[a-z]{1,8})*$')
VALID_X_NAME = re.compile(r'^X-[{0}]+$'.format(re.escape(ID_CHARACTERS)))
VALID_PRESENTATION_TEXT = re.compile(u'^[{0}]*$'.format(re.escape(SAFE_CHARACTERS)))
VALID_TEXT = re.compile(u'^([{0}:{1}]|(\\\\[{2}]))*$'.format(
re.escape(SAFE_CHARACTERS), DOUBLE_QUOTE_CHARACTER, re.escape(ESCAPED_CHARACTERS)))
VALID_QUOTED_STRING = re.compile(u'^{0}[{1}]{0}$'.format(DOUBLE_QUOTE_CHARACTER, re.escape(QUOTE_SAFE_CHARACTERS)))
VALID_FLOAT = re.compile(r'^[+-]?\d+(\.\d+)?$')
LABEL_TYPE_VALUES = ('dom', 'intl', 'postal', 'parcel', 'home', 'work', 'pref')
TELEPHONE_TYPE_VALUES = (
'home', 'msg', 'work', 'pref', 'voice', 'fax', 'cell', 'video', 'pager', 'bbs', 'modem', 'car', 'isdn', 'pcs')
EMAIL_TYPE_VALUES = ('internet', 'x400', 'pref', 'dom', 'intl', 'postal', 'parcel', 'home', 'work')
def _expect_no_parameters(property_):
parameters = __get_parameters(property_)
if parameters is not None:
raise VCardItemCountError('{0}: {1}'.format(NOTE_NON_EMPTY_PARAMETER, parameters), {})
def _expect_parameters(property_):
if __get_parameters(property_) is None:
raise VCardItemCountError(NOTE_MISSING_PARAMETER, {})
def _expect_value_count(values, count):
if len(values) != count:
raise VCardItemCountError('{0}: {1:d} (expected {2})'.format(NOTE_INVALID_VALUE_COUNT, len(values), count), {})
def _expect_sub_value_count(sub_values, count):
if len(sub_values) != count:
raise VCardItemCountError(
'{0}: {1:d} (expected {2})'.format(NOTE_INVALID_SUB_VALUE_COUNT, len(sub_values), count), {})
def validate_date(text):
"""
Based on http://tools.ietf.org/html/rfc2425#section-5.8.4 and the fact
that it specifies a subset of ISO 8601.
@param text: String
"""
if VALID_DATE.match(text) is None:
raise VCardValueError(NOTE_INVALID_DATE, {'String': text})
try:
isodate.parse_date(text)
except (isodate.ISO8601Error, ValueError):
raise VCardValueError(NOTE_INVALID_DATE, {'String': text})
def validate_time_zone(text):
"""
Based on http://tools.ietf.org/html/rfc2425#section-5.8.4 and the fact
that it specifies a subset of ISO 8601.
@param text: String
Examples:
>>> validate_time_zone('Z')
>>> validate_time_zone('+01:00')
>>> validate_time_zone('-12:30')
>>> validate_time_zone('+23:59')
>>> validate_time_zone('-0001')
>>> validate_time_zone('-00:30')
>>> validate_time_zone('+00:30')
>>> validate_time_zone('Z+01:00') # Can't combine Z and offset
... # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid time zone ...
String: Z+01:00
>>> validate_time_zone('+1:00') # Need preceding zero
... # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid time zone ...
String: +1:00
>>> validate_time_zone('0100') # Need + or -
... # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid time zone ...
String: 0100
>>> validate_time_zone('01') # Need colon and minutes
... # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid time zone ...
String: 01
>>> validate_time_zone('01:') # Need minutes
... # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid time zone ...
String: 01:
>>> validate_time_zone('01:1') # Need preceding zero
... # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid time zone ...
"""
if not VALID_TIMEZONE.match(text):
raise VCardValueError(NOTE_INVALID_TIME_ZONE, {'String': text})
try:
isodate.parse_tzinfo(text.replace('+', 'Z+').replace('-', 'Z-'))
except (isodate.ISO8601Error, ValueError):
raise VCardValueError(NOTE_INVALID_TIME_ZONE, {'String': text})
def validate_time(text):
"""
Based on http://tools.ietf.org/html/rfc2425#section-5.8.4 and the fact
that it specifies a subset of ISO 8601.
@param text: String
Examples:
>>> validate_time('00:00:00')
>>> validate_time('000000')
>>> validate_time('01:02:03Z')
>>> validate_time('01:02:03+01:30')
>>> validate_time('01:02:60') # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid time (See RFC 2425 section 5.8.4 for time syntax)
String: 01:02:60
>>> validate_time('01:60:59') # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid time (See RFC 2425 section 5.8.4 for time syntax)
String: 01:60:59
>>> validate_time('24:00:00') # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid time (See RFC 2425 section 5.8.4 for time syntax)
String: 24:00:00
>>> validate_time('00:00:00Z+01') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid time zone ...
String: Z+01
"""
time_timezone = VALID_TIME_WITH_TIMEZONE.match(text)
if time_timezone is None:
raise VCardValueError(NOTE_INVALID_TIME, {'String': text})
time_str, timezone_str = time_timezone.groups()
try:
isodate.parse_time(time_str)
except (isodate.ISO8601Error, ValueError):
raise VCardValueError(NOTE_INVALID_TIME, {'String': text})
if timezone_str == '':
return
validate_time_zone(timezone_str)
def validate_language_tag(text):
"""
langval, as defined by RFC 1766 <http://tools.ietf.org/html/rfc1766>
@param text: String
Examples:
>>> validate_language_tag('en')
>>> validate_language_tag('-US') # Need primary tag # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid language (See RFC 1766 section 2 for details)
String: -us
>>> validate_language_tag('en-') # Can't end with dash # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid language (See RFC 1766 section 2 for details)
String: en-
>>> validate_language_tag('en-US')
"""
text = text.lower() # Case insensitive
if VALID_LANGUAGE_TAG.match(text) is None:
raise VCardValueError(NOTE_INVALID_LANGUAGE_VALUE, {'String': text})
# TODO: Extend to validate according to referenced ISO/RFC standards
def validate_x_name(text):
"""
@param text: Single parameter name
Examples:
>>> validate_x_name('X-abc')
>>> validate_x_name('X-' + ID_CHARACTERS)
>>> validate_x_name('X-') # Have to have more characters # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardNameError: Invalid X-name (See RFC 2426 section 4 for x-name syntax)
String: X-
>>> validate_x_name('') # Have to start with X- #doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
VCardNameError: Invalid X-name (See RFC 2426 section 4 for x-name syntax)
...
>>> validate_x_name('x-abc') # X must be upper case # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardNameError: Invalid X-name (See RFC 2426 section 4 for x-name syntax)
String: x-abc
>>> validate_x_name('foo') # Have to start with X- # doctest: +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardNameError: Invalid X-name (See RFC 2426 section 4 for x-name syntax)
String: foo
"""
if VALID_X_NAME.match(text) is None:
raise VCardNameError(NOTE_INVALID_X_NAME, {'String': text})
def validate_presentation_text(text):
"""
ptext, as described on page 28
<http://tools.ietf.org/html/rfc2426#section-4>
@param text: String
Examples:
>>> validate_presentation_text('')
>>> validate_presentation_text(SAFE_CHARACTERS)
>>> validate_presentation_text(u'\u000B') #doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid parameter value ...
String: ...
"""
if VALID_PRESENTATION_TEXT.match(text) is None:
raise VCardValueError(NOTE_INVALID_PARAMETER_VALUE, {'String': text})
def validate_text_value(text):
"""
text-value, as described on page 37
<http://tools.ietf.org/html/rfc2426#section-4>
@param text: String
Examples:
>>> validate_text_value('')
>>> validate_text_value('\\\\,')
>>> validate_text_value(SAFE_CHARACTERS)
>>> validate_text_value('\\\\n')
>>> validate_text_value(';') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid text value (See RFC 2426 section 4 for details)
String: ...
>>> validate_text_value('\\\\\\\\;') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid text value (See RFC 2426 section 4 for details)
String: ...
"""
if VALID_TEXT.match(text) is None:
raise VCardValueError(NOTE_INVALID_TEXT_VALUE, {'String': text})
def validate_quoted_string(text):
"""
quoted-string, as described on page 28
<http://tools.ietf.org/html/rfc2426#section-4>
@param text: String
Examples:
>>> validate_quoted_string(DOUBLE_QUOTE_CHARACTER + QUOTE_SAFE_CHARACTERS[0] + DOUBLE_QUOTE_CHARACTER)
>>> validate_quoted_string(
... DOUBLE_QUOTE_CHARACTER + DOUBLE_QUOTE_CHARACTER) # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid parameter value ...
>>> validate_quoted_string(
... DOUBLE_QUOTE_CHARACTER + QUOTE_SAFE_CHARACTERS[-1]*2 + DOUBLE_QUOTE_CHARACTER
... ) # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid parameter value ...
String: "ÿÿ"
"""
if VALID_QUOTED_STRING.match(text) is None:
raise VCardValueError(NOTE_INVALID_PARAMETER_VALUE, {'String': text})
def validate_param_value(text):
"""
param-value, as described on page 28
<http://tools.ietf.org/html/rfc2426#section-4>
@param text: Single parameter value
Examples:
>>> validate_param_value('')
>>> validate_param_value(SAFE_CHARACTERS)
>>> validate_param_value(DOUBLE_QUOTE_CHARACTER + QUOTE_SAFE_CHARACTERS[0] + DOUBLE_QUOTE_CHARACTER)
>>> validate_param_value(
... DOUBLE_QUOTE_CHARACTER + DOUBLE_QUOTE_CHARACTER) # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid parameter value ...
String: ""
"""
try:
validate_presentation_text(text)
except VCardValueError:
try:
validate_quoted_string(text)
except VCardValueError:
raise VCardValueError(NOTE_INVALID_PARAMETER_VALUE, {'String': text})
def validate_text_parameter(parameter):
"""
text-param, as described on page 35
<http://tools.ietf.org/html/rfc2426#section-4>
@param parameter: Single parameter, as returned by get_vcard_property_param
Examples:
>>> validate_text_parameter(['VALUE', {'ptext'}])
"""
param_name = parameter[0].upper()
param_values = parameter[1]
if param_name == 'VALUE':
if param_values != {'ptext'}:
raise VCardValueError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_values), {})
return
elif param_name == 'LANGUAGE':
if len(param_values) != 1:
raise VCardValueError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_values), {})
for param_value in param_values:
validate_language_tag(param_value)
else:
validate_x_name(param_name)
if len(param_values) != 1:
raise VCardValueError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_values), {})
validate_param_value(param_values[0])
def validate_float(text):
"""
float value, as described on page 10 of RFC 2425
<http://tools.ietf.org/html/rfc2425#section-5.8.4>
Examples:
>>> validate_float('12')
>>> validate_float('12.345')
>>> validate_float('+12.345')
>>> validate_float('-12.345')
>>> validate_float('12.') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
VCardValueError: Invalid sub-value ...
>>> validate_float('.12') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
VCardValueError: Invalid sub-value ...
>>> validate_float('foo') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
VCardValueError: Invalid sub-value ...
>>> validate_float('++12.345') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
VCardValueError: Invalid sub-value ...
>>> validate_float('--12.345') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
VCardValueError: Invalid sub-value ...
>>> validate_float('12.34.5') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
...
VCardValueError: Invalid sub-value ...
"""
if VALID_FLOAT.match(text) is None:
raise VCardValueError('{0}, expected float value: {1}'.format(NOTE_INVALID_SUB_VALUE, text), {})
def validate_uri(text):
"""
genericurl, as described in RFC 1738
<http://tools.ietf.org/html/rfc1738#section-5>.
@param text: Single parameter value
Examples:
>>> validate_uri('http://example.org/')
>>> validate_uri('http\\://example.org/') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid URI ...
String: http\\://example.org/
>>> validate_uri('http:') # doctest: +ELLIPSIS +IGNORE_EXCEPTION_DETAIL
Traceback (most recent call last):
VCardValueError: Invalid URI ...
String: http:
"""
parts = six.Module_six_moves_urllib.parse.urlparse(text)
if parts[0] == '' or (parts[1] == '' and parts[2] == ''):
raise VCardValueError(NOTE_INVALID_URI, {'String': text})
def validate_vcard_property(property_):
"""
Checks any property according to
<http://tools.ietf.org/html/rfc2426#section-3> and
<http://tools.ietf.org/html/rfc2426#section-4>. Checks are grouped by
property to allow easy overview rather than a short function.
@param property_: Formatted property
"""
property_name = property_.name.upper()
try:
if property_name in ('BEGIN', 'END'):
# <http://tools.ietf.org/html/rfc2426#section-2.1.1>
_expect_no_parameters(property_)
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
if property_.values[0][0].lower() != 'vcard':
raise VCardValueError(
'{0}: {1} (expected "VCARD")'.format(NOTE_INVALID_VALUE, property_.values[0][0]), {})
if property_name == 'NAME':
# <http://tools.ietf.org/html/rfc2426#section-2.1.2>
_expect_no_parameters(property_)
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
validate_text_value(property_.values[0][0])
if property_name == 'PROFILE':
# <http://tools.ietf.org/html/rfc2426#section-2.1.3>
_expect_no_parameters(property_)
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
if property_.values[0][0].lower() != 'vcard':
raise VCardValueError(
'{0}: {1} (expected "VCARD")'.format(NOTE_INVALID_VALUE, property_.values[0][0]), {})
validate_text_value(property_.values[0][0])
if property_name == 'SOURCE':
# <http://tools.ietf.org/html/rfc2426#section-2.1.4>
_expect_parameters(property_)
for parameter_name, param_values in property_.parameters.items():
if parameter_name.upper() == 'VALUE':
if param_values != {'uri'}:
raise VCardValueError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_values), {})
if 'CONTEXT' in property_.parameters:
raise VCardValueError(
'{0}: {1} and {2}'.format(NOTE_MISMATCH_PARAMETER, ('VALUE', 'CONTEXT')), {})
elif parameter_name.upper() == 'CONTEXT':
if param_values != {'word'}:
raise VCardValueError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_values), {})
if 'VALUE' in property_.parameters:
raise VCardValueError(
'{0}: {1} and {2}'.format(NOTE_MISMATCH_PARAMETER, ('VALUE', 'CONTEXT')), {})
else:
raise VCardNameError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_NAME, parameter_name), {})
if property_name == 'FN':
# <http://tools.ietf.org/html/rfc2426#section-3.1.1>
if property_.parameters is not None:
for parameter in property_.parameters.items():
validate_text_parameter(parameter)
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
validate_text_value(property_.values[0][0])
elif property_name == 'VERSION':
_expect_no_parameters(property_)
_expect_value_count(property_.values, 1)
if property_.values[0][0] != '3.0':
raise VCardValueError(
'{0}: {1} (expected "3.0")'.format(NOTE_INVALID_VALUE, property_.values[0][0]), {})
elif property_name == 'N':
# <http://tools.ietf.org/html/rfc2426#section-3.1.2>
if property_.parameters is not None:
for parameter in property_.parameters.items():
validate_text_parameter(parameter)
_expect_value_count(property_.values, 5)
# Should names be split?
for names in property_.values:
warnings.showwarning = show_warning
for name in names:
validate_text_value(name)
if name.find(SPACE_CHARACTER) != -1 and \
''.join([''.join(names) for names in property_.values]) != name:
# Space in name
# Not just a single name
warnings.warn('{0}: {1}'.format(WARN_MULTIPLE_NAMES, name.encode('utf-8')))
elif property_name == 'NICKNAME':
# <http://tools.ietf.org/html/rfc2426#section-3.1.3>
if property_.parameters is not None:
for parameter in property_.parameters.items():
validate_text_parameter(parameter)
_expect_value_count(property_.values, 1)
elif property_name in ['PHOTO', 'LOGO']:
# <http://tools.ietf.org/html/rfc2426#section-3.1.4>
# <http://tools.ietf.org/html/rfc2426#section-3.5.4>
_expect_parameters(property_)
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
for parameter_name, param_values in property_.parameters.items():
if parameter_name.upper() == 'ENCODING':
if param_values != {'b'}:
raise VCardValueError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_values), {})
if 'VALUE' in property_.parameters:
raise VCardValueError(
'{0}: {1} and {2}'.format(NOTE_MISMATCH_PARAMETER, ('ENCODING', 'VALUE')), {})
elif parameter_name.upper() == 'TYPE' and 'ENCODING' not in property_.parameters:
raise VCardItemCountError('{0}: {1}'.format(NOTE_MISSING_PARAMETER, 'ENCODING'), {})
elif parameter_name.upper() == 'VALUE':
if param_values != {'uri'}:
raise VCardValueError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_values), {})
else:
validate_uri(property_.values[0][0])
elif parameter_name.upper() not in ['ENCODING', 'TYPE', 'VALUE']:
raise VCardNameError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_NAME, parameter_name), {})
elif property_name == 'BDAY':
# <http://tools.ietf.org/html/rfc2426#section-3.1.5>
_expect_no_parameters(property_)
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
validate_date(property_.values[0][0])
elif property_name == 'ADR':
# <http://tools.ietf.org/html/rfc2426#section-3.2.1>
_expect_value_count(property_.values, 7)
if property_.parameters is not None:
for parameter_name, param_values in property_.parameters.items():
if parameter_name.upper() == 'TYPE':
for param_sub_value in param_values:
if param_sub_value not in LABEL_TYPE_VALUES:
raise VCardValueError(
'{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_sub_value), {})
if param_values == {'intl', 'postal', 'parcel', 'work'}:
warnings.warn('{0}: {1}'.format(WARN_DEFAULT_TYPE_VALUE, property_.values))
else:
validate_text_parameter(property_)
elif property_name == 'LABEL':
# <http://tools.ietf.org/html/rfc2426#section-3.2.2>
if property_.parameters is not None:
for parameter_name, param_values in property_.parameters.items():
if parameter_name.upper() == 'TYPE':
for param_sub_value in param_values:
if param_sub_value not in LABEL_TYPE_VALUES:
raise VCardValueError(
'{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_sub_value), {})
if param_values == {'intl', 'postal', 'parcel', 'work'}:
warnings.warn('{0}: {1}'.format(WARN_DEFAULT_TYPE_VALUE, property_.values))
else:
validate_text_parameter(property_)
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
validate_text_value(property_.values[0][0])
elif property_name == 'TEL':
# <http://tools.ietf.org/html/rfc2426#section-3.3.1>
if property_.parameters is not None:
for parameter_name, param_values in property_.parameters.items():
if parameter_name.upper() == 'TYPE':
for param_sub_value in param_values:
if param_sub_value.lower() not in TELEPHONE_TYPE_VALUES:
raise VCardValueError(
'{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_sub_value), {})
if set([value.lower() for value in param_values]) == {'voice'}:
warnings.warn('{0}: {1}'.format(WARN_DEFAULT_TYPE_VALUE, property_.values))
else:
raise VCardNameError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_NAME, parameter_name), {})
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
elif property_name == 'EMAIL':
# <http://tools.ietf.org/html/rfc2426#section-3.3.2>
if property_.parameters is not None:
for parameter_name, param_values in property_.parameters.items():
if parameter_name.upper() == 'TYPE':
for param_sub_value in param_values:
if param_sub_value.lower() not in EMAIL_TYPE_VALUES:
warnings.warn('{0}: {1}'.format(WARN_INVALID_EMAIL_TYPE, param_sub_value))
if set([value.lower() for value in param_values]) == {'internet'}:
warnings.warn('{0}: {1[values]}'.format(WARN_DEFAULT_TYPE_VALUE, property_))
else:
raise VCardNameError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_NAME, parameter_name), {})
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
validate_text_value(property_.values[0][0])
elif property_name == 'MAILER':
# <http://tools.ietf.org/html/rfc2426#section-3.3.3>
_expect_no_parameters(property_)
_expect_value_count(property_.values, 1)
_expect_value_count(property_.values[0], 1)
validate_text_value(property_.values[0][0])
elif property_name == 'TZ':
# <http://tools.ietf.org/html/rfc2426#section-3.4.1>
_expect_no_parameters(property_)
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
value = property_.values[0][0]
validate_time_zone(value)
elif property_name == 'GEO':
# <http://tools.ietf.org/html/rfc2426#section-3.4.2>
_expect_no_parameters(property_)
_expect_value_count(property_.values, 2)
# can the following be...
# _expect_sub_value_count(property_.values[0], 2)
# ...?
for value in property_.values:
if len(value) != 1:
raise VCardItemCountError(
'{0}: {1:d} (expected 1)'.format(NOTE_INVALID_SUB_VALUE_COUNT, len(property_.values[0])), {})
validate_float(value[0])
elif property_name == 'TITLE':
# <http://tools.ietf.org/html/rfc2426#section-3.5.1>
if property_.parameters is not None:
for parameter in property_.parameters.items():
validate_text_parameter(parameter)
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
validate_text_value(property_.values[0][0])
elif property_name == 'ROLE':
# <http://tools.ietf.org/html/rfc2426#section-3.5.2>
if property_.parameters is not None:
for parameter in property_.parameters.items():
validate_text_parameter(parameter)
_expect_value_count(property_.values, 1)
_expect_sub_value_count(property_.values[0], 1)
validate_text_value(property_.values[0][0])
elif property_name == 'AGENT':
# <http://tools.ietf.org/html/rfc2426#section-3.5.4>
if property_.parameters is not None:
for parameter_name, param_values in property_.parameters.items():
if parameter_name.upper() != 'VALUE':
raise VCardNameError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_NAME, param_values), {})
if param_values != {'uri'}:
raise VCardValueError('{0}: {1}'.format(NOTE_INVALID_PARAMETER_VALUE, param_values), {})
_expect_value_count(property_.values, 1)
# can this be...
# _expect_sub_value_count(property_.values[0], 1)
# ...?
for value in property_.values:
if len(value) != 1:
raise VCardItemCountError(
'{0}: {1:d} (expected 1)'.format(
NOTE_INVALID_SUB_VALUE_COUNT, len(property_.values[0])), {})
validate_uri(value[0])
else:
# Inline vCard object
pass # TODO: Un-escape and validate value
elif property_name == 'URL':
# <http://tools.ietf.org/html/rfc2426#section-3.6.8>
_expect_no_parameters(property_)
_expect_value_count(property_.values, 1)
validate_uri(property_.values[0][0])
except VCardError as error:
error.context['Property'] = property_name
err_type = type(error)
raise err_type(error.message, error.context)
def __get_parameters(property_):
return property_.parameters