forked from adieu/vobject
/
icalendar.py
1929 lines (1664 loc) · 75.2 KB
/
icalendar.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
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Definitions and behavior for iCalendar, also known as vCalendar 2.0"""
import string
import behavior
import dateutil.rrule
import dateutil.tz
import StringIO, cStringIO
import datetime
import socket, random #for generating a UID
import itertools
from base import (VObjectError, NativeError, ValidateError, ParseError,
VBase, Component, ContentLine, logger, defaultSerialize,
registerBehavior, backslashEscape, foldOneLine,
newFromBehavior, CRLF, LF, ascii)
#------------------------------- Constants -------------------------------------
DATENAMES = ("rdate", "exdate")
RULENAMES = ("exrule", "rrule")
DATESANDRULES = ("exrule", "rrule", "rdate", "exdate")
PRODID = u"-//PYVOBJECT//NONSGML Version 1//EN"
WEEKDAYS = "MO", "TU", "WE", "TH", "FR", "SA", "SU"
FREQUENCIES = ('YEARLY', 'MONTHLY', 'WEEKLY', 'DAILY', 'HOURLY', 'MINUTELY',
'SECONDLY')
zeroDelta = datetime.timedelta(0)
twoHours = datetime.timedelta(hours=2)
#---------------------------- TZID registry ------------------------------------
__tzidMap={}
def toUnicode(s):
"""Take a string or unicode, turn it into unicode, decoding as utf-8"""
if isinstance(s, str):
s = s.decode('utf-8')
return s
def registerTzid(tzid, tzinfo):
"""Register a tzid -> tzinfo mapping."""
__tzidMap[toUnicode(tzid)]=tzinfo
def getTzid(tzid):
"""Return the tzid if it exists, or None."""
return __tzidMap.get(toUnicode(tzid), None)
utc = dateutil.tz.tzutc()
registerTzid("UTC", utc)
#-------------------- Helper subclasses ----------------------------------------
class TimezoneComponent(Component):
"""A VTIMEZONE object.
VTIMEZONEs are parsed by dateutil.tz.tzical, the resulting datetime.tzinfo
subclass is stored in self.tzinfo, self.tzid stores the TZID associated
with this timezone.
@ivar name:
The uppercased name of the object, in this case always 'VTIMEZONE'.
@ivar tzinfo:
A datetime.tzinfo subclass representing this timezone.
@ivar tzid:
The string used to refer to this timezone.
"""
def __init__(self, tzinfo=None, *args, **kwds):
"""Accept an existing Component or a tzinfo class."""
super(TimezoneComponent, self).__init__(*args, **kwds)
self.isNative=True
# hack to make sure a behavior is assigned
if self.behavior is None:
self.behavior = VTimezone
if tzinfo is not None:
self.tzinfo = tzinfo
if not hasattr(self, 'name') or self.name == '':
self.name = 'VTIMEZONE'
self.useBegin = True
@classmethod
def registerTzinfo(obj, tzinfo):
"""Register tzinfo if it's not already registered, return its tzid."""
tzid = obj.pickTzid(tzinfo)
if tzid and not getTzid(tzid):
registerTzid(tzid, tzinfo)
return tzid
def gettzinfo(self):
# workaround for dateutil failing to parse some experimental properties
good_lines = ('rdate', 'rrule', 'dtstart', 'tzname', 'tzoffsetfrom',
'tzoffsetto', 'tzid')
# serialize encodes as utf-8, cStringIO will leave utf-8 alone
buffer = cStringIO.StringIO()
# allow empty VTIMEZONEs
if len(self.contents) == 0:
return None
def customSerialize(obj):
if isinstance(obj, Component):
foldOneLine(buffer, u"BEGIN:" + obj.name)
for child in obj.lines():
if child.name.lower() in good_lines:
child.serialize(buffer, 75, validate=False)
for comp in obj.components():
customSerialize(comp)
foldOneLine(buffer, u"END:" + obj.name)
customSerialize(self)
buffer.seek(0) # tzical wants to read a stream
return dateutil.tz.tzical(buffer).get()
def settzinfo(self, tzinfo, start=2000, end=2030):
"""Create appropriate objects in self to represent tzinfo.
Collapse DST transitions to rrules as much as possible.
Assumptions:
- DST <-> Standard transitions occur on the hour
- never within a month of one another
- twice or fewer times a year
- never in the month of December
- DST always moves offset exactly one hour later
- tzinfo classes dst method always treats times that could be in either
offset as being in the later regime
"""
def fromLastWeek(dt):
"""How many weeks from the end of the month dt is, starting from 1."""
weekDelta = datetime.timedelta(weeks=1)
n = 1
current = dt + weekDelta
while current.month == dt.month:
n += 1
current += weekDelta
return n
# lists of dictionaries defining rules which are no longer in effect
completed = {'daylight' : [], 'standard' : []}
# dictionary defining rules which are currently in effect
working = {'daylight' : None, 'standard' : None}
# rule may be based on the nth week of the month or the nth from the last
for year in xrange(start, end + 1):
newyear = datetime.datetime(year, 1, 1)
for transitionTo in 'daylight', 'standard':
transition = getTransition(transitionTo, year, tzinfo)
oldrule = working[transitionTo]
if transition == newyear:
# transitionTo is in effect for the whole year
rule = {'end' : None,
'start' : newyear,
'month' : 1,
'weekday' : None,
'hour' : None,
'plus' : None,
'minus' : None,
'name' : tzinfo.tzname(newyear),
'offset' : tzinfo.utcoffset(newyear),
'offsetfrom' : tzinfo.utcoffset(newyear)}
if oldrule is None:
# transitionTo was not yet in effect
working[transitionTo] = rule
else:
# transitionTo was already in effect
if (oldrule['offset'] !=
tzinfo.utcoffset(newyear)):
# old rule was different, it shouldn't continue
oldrule['end'] = year - 1
completed[transitionTo].append(oldrule)
working[transitionTo] = rule
elif transition is None:
# transitionTo is not in effect
if oldrule is not None:
# transitionTo used to be in effect
oldrule['end'] = year - 1
completed[transitionTo].append(oldrule)
working[transitionTo] = None
else:
# an offset transition was found
old_offset = tzinfo.utcoffset(transition - twoHours)
rule = {'end' : None, # None, or an integer year
'start' : transition, # the datetime of transition
'month' : transition.month,
'weekday' : transition.weekday(),
'hour' : transition.hour,
'name' : tzinfo.tzname(transition),
'plus' : (transition.day - 1)/ 7 + 1,#nth week of the month
'minus' : fromLastWeek(transition), #nth from last week
'offset' : tzinfo.utcoffset(transition),
'offsetfrom' : old_offset}
if oldrule is None:
working[transitionTo] = rule
else:
plusMatch = rule['plus'] == oldrule['plus']
minusMatch = rule['minus'] == oldrule['minus']
truth = plusMatch or minusMatch
for key in 'month', 'weekday', 'hour', 'offset':
truth = truth and rule[key] == oldrule[key]
if truth:
# the old rule is still true, limit to plus or minus
if not plusMatch:
oldrule['plus'] = None
if not minusMatch:
oldrule['minus'] = None
else:
# the new rule did not match the old
oldrule['end'] = year - 1
completed[transitionTo].append(oldrule)
working[transitionTo] = rule
for transitionTo in 'daylight', 'standard':
if working[transitionTo] is not None:
completed[transitionTo].append(working[transitionTo])
self.tzid = []
self.daylight = []
self.standard = []
self.add('tzid').value = self.pickTzid(tzinfo, True)
old = None
for transitionTo in 'daylight', 'standard':
for rule in completed[transitionTo]:
comp = self.add(transitionTo)
dtstart = comp.add('dtstart')
dtstart.value = rule['start']
if rule['name'] is not None:
comp.add('tzname').value = rule['name']
line = comp.add('tzoffsetto')
line.value = deltaToOffset(rule['offset'])
line = comp.add('tzoffsetfrom')
line.value = deltaToOffset(rule['offsetfrom'])
if rule['plus'] is not None:
num = rule['plus']
elif rule['minus'] is not None:
num = -1 * rule['minus']
else:
num = None
if num is not None:
dayString = ";BYDAY=" + str(num) + WEEKDAYS[rule['weekday']]
else:
dayString = ""
if rule['end'] is not None:
if rule['hour'] is None:
# all year offset, with no rule
endDate = datetime.datetime(rule['end'], 1, 1)
else:
weekday = dateutil.rrule.weekday(rule['weekday'], num)
du_rule = dateutil.rrule.rrule(dateutil.rrule.YEARLY,
bymonth = rule['month'],byweekday = weekday,
dtstart = datetime.datetime(
rule['end'], 1, 1, rule['hour'])
)
endDate = du_rule[0]
endDate = endDate.replace(tzinfo = utc) - rule['offsetfrom']
endString = ";UNTIL="+ dateTimeToString(endDate)
else:
endString = ''
rulestring = "FREQ=YEARLY%s;BYMONTH=%s%s" % \
(dayString, str(rule['month']), endString)
comp.add('rrule').value = rulestring
tzinfo = property(gettzinfo, settzinfo)
# prevent Component's __setattr__ from overriding the tzinfo property
normal_attributes = Component.normal_attributes + ['tzinfo']
@staticmethod
def pickTzid(tzinfo, allowUTC=False):
"""
Given a tzinfo class, use known APIs to determine TZID, or use tzname.
"""
if tzinfo is None or (not allowUTC and tzinfo_eq(tzinfo, utc)):
#If tzinfo is UTC, we don't need a TZID
return None
# try PyICU's tzid key
if hasattr(tzinfo, 'tzid'):
return toUnicode(tzinfo.tzid)
# try pytz zone key
if hasattr(tzinfo, 'zone'):
return toUnicode(tzinfo.zone)
# try tzical's tzid key
elif hasattr(tzinfo, '_tzid'):
return toUnicode(tzinfo._tzid)
else:
# return tzname for standard (non-DST) time
notDST = datetime.timedelta(0)
for month in xrange(1,13):
dt = datetime.datetime(2000, month, 1)
if tzinfo.dst(dt) == notDST:
return toUnicode(tzinfo.tzname(dt))
# there was no standard time in 2000!
raise VObjectError("Unable to guess TZID for tzinfo %s" % str(tzinfo))
def __str__(self):
return "<VTIMEZONE | " + str(getattr(self, 'tzid', 'No TZID')) +">"
def __repr__(self):
return self.__str__()
def prettyPrint(self, level, tabwidth):
pre = ' ' * level * tabwidth
print pre, self.name
print pre, "TZID:", self.tzid
print
class RecurringComponent(Component):
"""A vCalendar component like VEVENT or VTODO which may recur.
Any recurring component can have one or multiple RRULE, RDATE,
EXRULE, or EXDATE lines, and one or zero DTSTART lines. It can also have a
variety of children that don't have any recurrence information.
In the example below, note that dtstart is included in the rruleset.
This is not the default behavior for dateutil's rrule implementation unless
dtstart would already have been a member of the recurrence rule, and as a
result, COUNT is wrong. This can be worked around when getting rruleset by
adjusting count down by one if an rrule has a count and dtstart isn't in its
result set, but by default, the rruleset property doesn't do this work
around, to access it getrruleset must be called with addRDate set True.
>>> import dateutil.rrule, datetime
>>> vevent = RecurringComponent(name='VEVENT')
>>> vevent.add('rrule').value =u"FREQ=WEEKLY;COUNT=2;INTERVAL=2;BYDAY=TU,TH"
>>> vevent.add('dtstart').value = datetime.datetime(2005, 1, 19, 9)
When creating rrule's programmatically it should be kept in
mind that count doesn't necessarily mean what rfc2445 says.
>>> list(vevent.rruleset)
[datetime.datetime(2005, 1, 20, 9, 0), datetime.datetime(2005, 2, 1, 9, 0)]
>>> list(vevent.getrruleset(addRDate=True))
[datetime.datetime(2005, 1, 19, 9, 0), datetime.datetime(2005, 1, 20, 9, 0)]
Also note that dateutil will expand all-day events (datetime.date values) to
datetime.datetime value with time 0 and no timezone.
>>> vevent.dtstart.value = datetime.date(2005,3,18)
>>> list(vevent.rruleset)
[datetime.datetime(2005, 3, 29, 0, 0), datetime.datetime(2005, 3, 31, 0, 0)]
>>> list(vevent.getrruleset(True))
[datetime.datetime(2005, 3, 18, 0, 0), datetime.datetime(2005, 3, 29, 0, 0)]
@ivar rruleset:
A U{rruleset<https://moin.conectiva.com.br/DateUtil>}.
"""
def __init__(self, *args, **kwds):
super(RecurringComponent, self).__init__(*args, **kwds)
self.isNative=True
#self.clobberedRDates=[]
def getrruleset(self, addRDate = False):
"""Get an rruleset created from self.
If addRDate is True, add an RDATE for dtstart if it's not included in
an RRULE, and count is decremented if it exists.
Note that for rules which don't match DTSTART, DTSTART may not appear
in list(rruleset), although it should. By default, an RDATE is not
created in these cases, and count isn't updated, so dateutil may list
a spurious occurrence.
"""
rruleset = None
for name in DATESANDRULES:
addfunc = None
for line in self.contents.get(name, ()):
# don't bother creating a rruleset unless there's a rule
if rruleset is None:
rruleset = dateutil.rrule.rruleset()
if addfunc is None:
addfunc=getattr(rruleset, name)
if name in DATENAMES:
if type(line.value[0]) == datetime.datetime:
map(addfunc, line.value)
elif type(line.value[0]) == datetime.date:
for dt in line.value:
addfunc(datetime.datetime(dt.year, dt.month, dt.day))
else:
# ignore RDATEs with PERIOD values for now
pass
elif name in RULENAMES:
try:
dtstart = self.dtstart.value
except AttributeError, KeyError:
# Special for VTODO - try DUE property instead
try:
if self.name == "VTODO":
dtstart = self.due.value
else:
# if there's no dtstart, just return None
return None
except AttributeError, KeyError:
# if there's no due, just return None
return None
# rrulestr complains about unicode, so cast to str
# a Ruby iCalendar library escapes semi-colons in rrules,
# so also remove any backslashes
value = str(line.value).replace('\\', '')
rule = dateutil.rrule.rrulestr(value, dtstart=dtstart)
until = rule._until
if until is not None and \
isinstance(dtstart, datetime.datetime) and \
(until.tzinfo != dtstart.tzinfo):
# dateutil converts the UNTIL date to a datetime,
# check to see if the UNTIL parameter value was a date
vals = dict(pair.split('=') for pair in
line.value.upper().split(';'))
if len(vals.get('UNTIL', '')) == 8:
until = datetime.datetime.combine(until.date(),
dtstart.time())
# While RFC2445 says UNTIL MUST be UTC, Chandler allows
# floating recurring events, and uses floating UNTIL values.
# Also, some odd floating UNTIL but timezoned DTSTART values
# have shown up in the wild, so put floating UNTIL values
# DTSTART's timezone
if until.tzinfo is None:
until = until.replace(tzinfo=dtstart.tzinfo)
if dtstart.tzinfo is not None:
until = until.astimezone(dtstart.tzinfo)
# RFC2445 actually states that UNTIL must be a UTC value. Whilst the
# changes above work OK, one problem case is if DTSTART is floating but
# UNTIL is properly specified as UTC (or with a TZID). In that case dateutil
# will fail datetime comparisons. There is no easy solution to this as
# there is no obvious timezone (at this point) to do proper floating time
# offset compisons. The best we can do is treat the UNTIL value as floating.
# This could mean incorrect determination of the last instance. The better
# solution here is to encourage clients to use COUNT rather than UNTIL
# when DTSTART is floating.
if dtstart.tzinfo is None:
until = until.replace(tzinfo=None)
rule._until = until
# add the rrule or exrule to the rruleset
addfunc(rule)
if name == 'rrule' and addRDate:
try:
# dateutils does not work with all-day (datetime.date) items
# so we need to convert to a datetime.datetime
# (which is what dateutils does internally)
if not isinstance(dtstart, datetime.datetime):
adddtstart = datetime.datetime.fromordinal(dtstart.toordinal())
else:
adddtstart = dtstart
if rruleset._rrule[-1][0] != adddtstart:
rruleset.rdate(adddtstart)
added = True
else:
added = False
except IndexError:
# it's conceivable that an rrule might have 0 datetimes
added = False
if added and rruleset._rrule[-1]._count != None:
rruleset._rrule[-1]._count -= 1
return rruleset
def setrruleset(self, rruleset):
# Get DTSTART from component (or DUE if no DTSTART in a VTODO)
try:
dtstart = self.dtstart.value
except AttributeError, KeyError:
if self.name == "VTODO":
dtstart = self.due.value
else:
raise
isDate = datetime.date == type(dtstart)
if isDate:
dtstart = datetime.datetime(dtstart.year,dtstart.month, dtstart.day)
untilSerialize = dateToString
else:
# make sure to convert time zones to UTC
untilSerialize = lambda x: dateTimeToString(x, True)
for name in DATESANDRULES:
if name in self.contents:
del self.contents[name]
setlist = getattr(rruleset, '_' + name)
if name in DATENAMES:
setlist = list(setlist) # make a copy of the list
if name == 'rdate' and dtstart in setlist:
setlist.remove(dtstart)
if isDate:
setlist = [dt.date() for dt in setlist]
if len(setlist) > 0:
self.add(name).value = setlist
elif name in RULENAMES:
for rule in setlist:
buf = StringIO.StringIO()
buf.write('FREQ=')
buf.write(FREQUENCIES[rule._freq])
values = {}
if rule._interval != 1:
values['INTERVAL'] = [str(rule._interval)]
if rule._wkst != 0: # wkst defaults to Monday
values['WKST'] = [WEEKDAYS[rule._wkst]]
if rule._bysetpos is not None:
values['BYSETPOS'] = [str(i) for i in rule._bysetpos]
if rule._count is not None:
values['COUNT'] = [str(rule._count)]
elif rule._until is not None:
values['UNTIL'] = [untilSerialize(rule._until)]
days = []
if (rule._byweekday is not None and (
dateutil.rrule.WEEKLY != rule._freq or
len(rule._byweekday) != 1 or
rule._dtstart.weekday() != rule._byweekday[0])):
# ignore byweekday if freq is WEEKLY and day correlates
# with dtstart because it was automatically set by
# dateutil
days.extend(WEEKDAYS[n] for n in rule._byweekday)
if rule._bynweekday is not None:
days.extend(str(n) + WEEKDAYS[day] for day, n in rule._bynweekday)
if len(days) > 0:
values['BYDAY'] = days
if rule._bymonthday is not None and len(rule._bymonthday) > 0:
if not (rule._freq <= dateutil.rrule.MONTHLY and
len(rule._bymonthday) == 1 and
rule._bymonthday[0] == rule._dtstart.day):
# ignore bymonthday if it's generated by dateutil
values['BYMONTHDAY'] = [str(n) for n in rule._bymonthday]
if rule._bynmonthday is not None and len(rule._bynmonthday) > 0:
values.setdefault('BYMONTHDAY', []).extend(str(n) for n in rule._bynmonthday)
if rule._bymonth is not None and len(rule._bymonth) > 0:
if (rule._byweekday is not None or
len(rule._bynweekday or ()) > 0 or
not (rule._freq == dateutil.rrule.YEARLY and
len(rule._bymonth) == 1 and
rule._bymonth[0] == rule._dtstart.month)):
# ignore bymonth if it's generated by dateutil
values['BYMONTH'] = [str(n) for n in rule._bymonth]
if rule._byyearday is not None:
values['BYYEARDAY'] = [str(n) for n in rule._byyearday]
if rule._byweekno is not None:
values['BYWEEKNO'] = [str(n) for n in rule._byweekno]
# byhour, byminute, bysecond are always ignored for now
for key, paramvals in values.iteritems():
buf.write(';')
buf.write(key)
buf.write('=')
buf.write(','.join(paramvals))
self.add(name).value = buf.getvalue()
rruleset = property(getrruleset, setrruleset)
def __setattr__(self, name, value):
"""For convenience, make self.contents directly accessible."""
if name == 'rruleset':
self.setrruleset(value)
else:
super(RecurringComponent, self).__setattr__(name, value)
class TextBehavior(behavior.Behavior):
"""Provide backslash escape encoding/decoding for single valued properties.
TextBehavior also deals with base64 encoding if the ENCODING parameter is
explicitly set to BASE64.
"""
base64string = 'BASE64' # vCard uses B
@classmethod
def decode(cls, line):
"""Remove backslash escaping from line.value."""
if line.encoded:
encoding = getattr(line, 'encoding_param', None)
if encoding and encoding.upper() == cls.base64string:
line.value = line.value.decode('base64')
else:
line.value = stringToTextValues(line.value)[0]
line.encoded=False
@classmethod
def encode(cls, line):
"""Backslash escape line.value."""
if not line.encoded:
encoding = getattr(line, 'encoding_param', None)
if encoding and encoding.upper() == cls.base64string:
line.value = line.value.encode('base64').replace('\n', '')
else:
line.value = backslashEscape(line.value)
line.encoded=True
class VCalendarComponentBehavior(behavior.Behavior):
defaultBehavior = TextBehavior
isComponent = True
class RecurringBehavior(VCalendarComponentBehavior):
"""Parent Behavior for components which should be RecurringComponents."""
hasNative = True
@staticmethod
def transformToNative(obj):
"""Turn a recurring Component into a RecurringComponent."""
if not obj.isNative:
object.__setattr__(obj, '__class__', RecurringComponent)
obj.isNative = True
return obj
@staticmethod
def transformFromNative(obj):
if obj.isNative:
object.__setattr__(obj, '__class__', Component)
obj.isNative = False
return obj
@staticmethod
def generateImplicitParameters(obj):
"""Generate a UID if one does not exist.
This is just a dummy implementation, for now.
"""
if not hasattr(obj, 'uid'):
rand = str(int(random.random() * 100000))
now = datetime.datetime.now(utc)
now = dateTimeToString(now)
host = socket.gethostname()
obj.add(ContentLine('UID', [], now + '-' + rand + '@' + host))
class DateTimeBehavior(behavior.Behavior):
"""Parent Behavior for ContentLines containing one DATE-TIME."""
hasNative = True
@staticmethod
def transformToNative(obj):
"""Turn obj.value into a datetime.
RFC2445 allows times without time zone information, "floating times"
in some properties. Mostly, this isn't what you want, but when parsing
a file, real floating times are noted by setting to 'TRUE' the
X-VOBJ-FLOATINGTIME-ALLOWED parameter.
"""
if obj.isNative: return obj
obj.isNative = True
if obj.value == '': return obj
obj.value=str(obj.value)
#we're cheating a little here, parseDtstart allows DATE
obj.value=parseDtstart(obj)
if obj.value.tzinfo is None:
obj.params['X-VOBJ-FLOATINGTIME-ALLOWED'] = ['TRUE']
if obj.params.get('TZID'):
# Keep a copy of the original TZID around
obj.params['X-VOBJ-ORIGINAL-TZID'] = [obj.params['TZID']]
del obj.params['TZID']
return obj
@classmethod
def transformFromNative(cls, obj):
"""Replace the datetime in obj.value with an ISO 8601 string."""
if obj.isNative:
obj.isNative = False
tzid = TimezoneComponent.registerTzinfo(obj.value.tzinfo)
obj.value = dateTimeToString(obj.value, cls.forceUTC)
if not cls.forceUTC and tzid is not None:
obj.tzid_param = tzid
if obj.params.get('X-VOBJ-ORIGINAL-TZID'):
if not hasattr(obj, 'tzid_param'):
obj.tzid_param = obj.x_vobj_original_tzid_param
del obj.params['X-VOBJ-ORIGINAL-TZID']
return obj
class UTCDateTimeBehavior(DateTimeBehavior):
"""A value which must be specified in UTC."""
forceUTC = True
class DateOrDateTimeBehavior(behavior.Behavior):
"""Parent Behavior for ContentLines containing one DATE or DATE-TIME."""
hasNative = True
@staticmethod
def transformToNative(obj):
"""Turn obj.value into a date or datetime."""
if obj.isNative: return obj
obj.isNative = True
if obj.value == '': return obj
obj.value=str(obj.value)
obj.value=parseDtstart(obj, allowSignatureMismatch=True)
if getattr(obj, 'value_param', 'DATE-TIME').upper() == 'DATE-TIME':
if hasattr(obj, 'tzid_param'):
# Keep a copy of the original TZID around
obj.params['X-VOBJ-ORIGINAL-TZID'] = [obj.tzid_param]
del obj.tzid_param
return obj
@staticmethod
def transformFromNative(obj):
"""Replace the date or datetime in obj.value with an ISO 8601 string."""
if type(obj.value) == datetime.date:
obj.isNative = False
obj.value_param = 'DATE'
obj.value = dateToString(obj.value)
return obj
else: return DateTimeBehavior.transformFromNative(obj)
class MultiDateBehavior(behavior.Behavior):
"""
Parent Behavior for ContentLines containing one or more DATE, DATE-TIME, or
PERIOD.
"""
hasNative = True
@staticmethod
def transformToNative(obj):
"""
Turn obj.value into a list of dates, datetimes, or
(datetime, timedelta) tuples.
"""
if obj.isNative:
return obj
obj.isNative = True
if obj.value == '':
obj.value = []
return obj
tzinfo = getTzid(getattr(obj, 'tzid_param', None))
valueParam = getattr(obj, 'value_param', "DATE-TIME").upper()
valTexts = obj.value.split(",")
if valueParam == "DATE":
obj.value = [stringToDate(x) for x in valTexts]
elif valueParam == "DATE-TIME":
obj.value = [stringToDateTime(x, tzinfo) for x in valTexts]
elif valueParam == "PERIOD":
obj.value = [stringToPeriod(x, tzinfo) for x in valTexts]
return obj
@staticmethod
def transformFromNative(obj):
"""
Replace the date, datetime or period tuples in obj.value with
appropriate strings.
"""
if obj.value and type(obj.value[0]) == datetime.date:
obj.isNative = False
obj.value_param = 'DATE'
obj.value = ','.join([dateToString(val) for val in obj.value])
return obj
# Fixme: handle PERIOD case
else:
if obj.isNative:
obj.isNative = False
transformed = []
tzid = None
for val in obj.value:
if tzid is None and type(val) == datetime.datetime:
tzid = TimezoneComponent.registerTzinfo(val.tzinfo)
if tzid is not None:
obj.tzid_param = tzid
transformed.append(dateTimeToString(val))
obj.value = ','.join(transformed)
return obj
class MultiTextBehavior(behavior.Behavior):
"""Provide backslash escape encoding/decoding of each of several values.
After transformation, value is a list of strings.
"""
listSeparator = ","
@classmethod
def decode(cls, line):
"""Remove backslash escaping from line.value, then split on commas."""
if line.encoded:
line.value = stringToTextValues(line.value,
listSeparator=cls.listSeparator)
line.encoded=False
@classmethod
def encode(cls, line):
"""Backslash escape line.value."""
if not line.encoded:
line.value = cls.listSeparator.join(backslashEscape(val) for val in line.value)
line.encoded=True
class SemicolonMultiTextBehavior(MultiTextBehavior):
listSeparator = ";"
#------------------------ Registered Behavior subclasses -----------------------
class VCalendar2_0(VCalendarComponentBehavior):
"""vCalendar 2.0 behavior. With added VAVAILABILITY support."""
name = 'VCALENDAR'
description = 'vCalendar 2.0, also known as iCalendar.'
versionString = '2.0'
sortFirst = ('version', 'calscale', 'method', 'prodid', 'vtimezone')
knownChildren = {'CALSCALE': (0, 1, None),#min, max, behaviorRegistry id
'METHOD': (0, 1, None),
'VERSION': (0, 1, None),#required, but auto-generated
'PRODID': (1, 1, None),
'VTIMEZONE': (0, None, None),
'VEVENT': (0, None, None),
'VTODO': (0, None, None),
'VJOURNAL': (0, None, None),
'VFREEBUSY': (0, None, None),
'VAVAILABILITY': (0, None, None),
}
@classmethod
def generateImplicitParameters(cls, obj):
"""Create PRODID, VERSION, and VTIMEZONEs if needed.
VTIMEZONEs will need to exist whenever TZID parameters exist or when
datetimes with tzinfo exist.
"""
for comp in obj.components():
if comp.behavior is not None:
comp.behavior.generateImplicitParameters(comp)
if not hasattr(obj, 'prodid'):
obj.add(ContentLine('PRODID', [], PRODID))
if not hasattr(obj, 'version'):
obj.add(ContentLine('VERSION', [], cls.versionString))
tzidsUsed = {}
def findTzids(obj, table):
if isinstance(obj, ContentLine) and (obj.behavior is None or
not obj.behavior.forceUTC):
if getattr(obj, 'tzid_param', None):
table[obj.tzid_param] = 1
else:
if type(obj.value) == list:
for item in obj.value:
tzinfo = getattr(obj.value, 'tzinfo', None)
tzid = TimezoneComponent.registerTzinfo(tzinfo)
if tzid:
table[tzid] = 1
else:
tzinfo = getattr(obj.value, 'tzinfo', None)
tzid = TimezoneComponent.registerTzinfo(tzinfo)
if tzid:
table[tzid] = 1
for child in obj.getChildren():
if obj.name != 'VTIMEZONE':
findTzids(child, table)
findTzids(obj, tzidsUsed)
oldtzids = [toUnicode(x.tzid.value) for x in getattr(obj, 'vtimezone_list', [])]
for tzid in tzidsUsed.keys():
tzid = toUnicode(tzid)
if tzid != u'UTC' and tzid not in oldtzids:
obj.add(TimezoneComponent(tzinfo=getTzid(tzid)))
registerBehavior(VCalendar2_0)
class VTimezone(VCalendarComponentBehavior):
"""Timezone behavior."""
name = 'VTIMEZONE'
hasNative = True
description = 'A grouping of component properties that defines a time zone.'
sortFirst = ('tzid', 'last-modified', 'tzurl', 'standard', 'daylight')
knownChildren = {'TZID': (1, 1, None),#min, max, behaviorRegistry id
'LAST-MODIFIED':(0, 1, None),
'TZURL': (0, 1, None),
'STANDARD': (0, None, None),#NOTE: One of Standard or
'DAYLIGHT': (0, None, None) # Daylight must appear
}
@classmethod
def validate(cls, obj, raiseException, *args):
if not hasattr(obj, 'tzid') or obj.tzid.value is None:
if raiseException:
m = "VTIMEZONE components must contain a valid TZID"
raise ValidateError(m)
return False
if obj.contents.has_key('standard') or obj.contents.has_key('daylight'):
return super(VTimezone, cls).validate(obj, raiseException, *args)
else:
if raiseException:
m = "VTIMEZONE components must contain a STANDARD or a DAYLIGHT\
component"
raise ValidateError(m)
return False
@staticmethod
def transformToNative(obj):
if not obj.isNative:
object.__setattr__(obj, '__class__', TimezoneComponent)
obj.isNative = True
obj.registerTzinfo(obj.tzinfo)
return obj
@staticmethod
def transformFromNative(obj):
return obj
registerBehavior(VTimezone)
class TZID(behavior.Behavior):
"""Don't use TextBehavior for TZID.
RFC2445 only allows TZID lines to be paramtext, so they shouldn't need any
encoding or decoding. Unfortunately, some Microsoft products use commas
in TZIDs which should NOT be treated as a multi-valued text property, nor
do we want to escape them. Leaving them alone works for Microsoft's breakage,
and doesn't affect compliant iCalendar streams.
"""
registerBehavior(TZID)
class DaylightOrStandard(VCalendarComponentBehavior):
hasNative = False
knownChildren = {'DTSTART': (1, 1, None),#min, max, behaviorRegistry id
'RRULE': (0, 1, None)}
registerBehavior(DaylightOrStandard, 'STANDARD')
registerBehavior(DaylightOrStandard, 'DAYLIGHT')
class VEvent(RecurringBehavior):
"""Event behavior."""
name='VEVENT'
sortFirst = ('uid', 'recurrence-id', 'dtstart', 'duration', 'dtend')
description='A grouping of component properties, and possibly including \
"VALARM" calendar components, that represents a scheduled \
amount of time on a calendar.'
knownChildren = {'DTSTART': (0, 1, None),#min, max, behaviorRegistry id
'CLASS': (0, 1, None),
'CREATED': (0, 1, None),
'DESCRIPTION': (0, 1, None),
'GEO': (0, 1, None),
'LAST-MODIFIED':(0, 1, None),
'LOCATION': (0, 1, None),
'ORGANIZER': (0, 1, None),
'PRIORITY': (0, 1, None),
'DTSTAMP': (0, 1, None),
'SEQUENCE': (0, 1, None),
'STATUS': (0, 1, None),
'SUMMARY': (0, 1, None),
'TRANSP': (0, 1, None),
'UID': (1, 1, None),
'URL': (0, 1, None),
'RECURRENCE-ID':(0, 1, None),
'DTEND': (0, 1, None), #NOTE: Only one of DtEnd or
'DURATION': (0, 1, None), # Duration can appear
'ATTACH': (0, None, None),
'ATTENDEE': (0, None, None),
'CATEGORIES': (0, None, None),
'COMMENT': (0, None, None),
'CONTACT': (0, None, None),
'EXDATE': (0, None, None),
'EXRULE': (0, None, None),
'REQUEST-STATUS': (0, None, None),
'RELATED-TO': (0, None, None),
'RESOURCES': (0, None, None),
'RDATE': (0, None, None),
'RRULE': (0, None, None),
'VALARM': (0, None, None)
}
@classmethod
def validate(cls, obj, raiseException, *args):
if obj.contents.has_key('dtend') and obj.contents.has_key('duration'):
if raiseException:
m = "VEVENT components cannot contain both DTEND and DURATION\
components"
raise ValidateError(m)
return False
else:
return super(VEvent, cls).validate(obj, raiseException, *args)
registerBehavior(VEvent)
class VTodo(RecurringBehavior):
"""To-do behavior."""
name='VTODO'
description='A grouping of component properties and possibly "VALARM" \