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
|
#!/usr/bin/env python
# -*- encoding: utf-8 -*-
import datetime
import logging
import re
import uuid
import icalendar
from caldav.lib.python_utilities import to_normal_str
## Global counter. We don't want to be too verbose on the users, ref https://github.com/home-assistant/core/issues/86938
fixup_error_loggings = 0
## Fixups to the icalendar data to work around compatibility issues.
## TODO:
## 1) this should only be done if needed. Use try-except around the
## fragments where icalendar/vobject is parsing ical data, and do the
## fixups there.
## 2) arguably, this is outside the scope of the caldav library.
## check if this can be done in vobject or icalendar libraries instead
## of here
## TODO: would be nice with proper documentation on what systems are
## generating broken data. Compatibility issues should also be collected
## in the documentation. somewhere.
def fix(event):
"""This function receives some ical as it's given from the server, checks for
breakages with the standard, and attempts to fix up known issues:
1) COMPLETED MUST be a datetime in UTC according to the RFC, but sometimes
a date is given. (Google Calendar?)
2) The RFC does not specify any range restrictions on the dates,
but clearly it doesn't make sense with a CREATED-timestamp that is
centuries or decades before RFC2445 was published in 1998.
Apparently some calendar servers generate nonsensical CREATED
timestamps while other calendar servers can't handle CREATED
timestamps prior to 1970. Probably it would make more sense to
drop the CREATED line completely rather than moving it from the
end of year 0AD to the beginning of year 1970. (Google Calendar)
3) iCloud apparently duplicates the DTSTAMP property sometimes -
keep the first DTSTAMP encountered (arguably the DTSTAMP with earliest value
should be kept).
4) ref https://github.com/python-caldav/caldav/issues/37,
X-APPLE-STRUCTURED-EVENT attribute sometimes comes with trailing
white space. I've decided to remove all trailing spaces, since
they seem to cause a traceback with vobject and those lines are
simply ignored by icalendar.
5) Zimbra can apparently create events with both dtstart, dtend
and duration set - which is forbidden according to the RFC. We
should probably verify that the data is consistent. As for now,
we'll just drop DURATION or DTEND (whatever comes last).
"""
event = to_normal_str(event)
if not event.endswith("\n"):
event = event + "\n"
## TODO: add ^ before COMPLETED and CREATED?
## 1) Add an arbitrary time if completed is given as date
fixed = re.sub(r"COMPLETED:(\d+)\s", r"COMPLETED:\g<1>T120000Z", event)
## 2) CREATED timestamps prior to epoch does not make sense,
## change from year 0001 to epoch.
fixed = re.sub("CREATED:00001231T000000Z", "CREATED:19700101T000000Z", fixed)
fixed = re.sub(r"\\+('\")", r"\1", fixed)
## 4) trailing whitespace probably never makes sense
fixed = re.sub(" *$", "", fixed)
## 3 fix duplicated DTSTAMP ... and ...
## 5 prepare to remove DURATION or DTEND/DUE if both DURATION and
## DTEND/DUE is set.
## remove duplication of DTSTAMP
fixed2 = (
"\n".join(filter(LineFilterDiscardingDuplicates(), fixed.strip().split("\n")))
+ "\n"
)
if fixed2 != event:
global fixup_error_loggings
fixup_error_loggings += 1
remove_bit = lambda n: n & (n - 1)
if not remove_bit(fixup_error_loggings):
log = logging.error
else:
log = logging.debug
log(
"""Ical data was modified to avoid compatibility issues
(Your calendar server breaks the icalendar standard)
This is probably harmless, particularly if not editing events or tasks
(error count: %i - this error is ratelimited)"""
% fixup_error_loggings,
exc_info=True,
)
try:
import difflib
log(
"\n".join(
difflib.unified_diff(
event.split("\n"), fixed2.split("\n"), lineterm=""
)
)
)
except:
log("Original: \n" + event)
log("Modified: \n" + fixed2)
return fixed2
class LineFilterDiscardingDuplicates:
"""Needs to be a class because it keeps track of whether a certain
group of date line was already encountered within a vobject.
This must be called line by line in order on the complete text, at
least comprising the complete vobject.
"""
def __init__(self):
self.stamped = 0
self.ended = 0
def __call__(self, line):
if line.startswith("BEGIN:V"):
self.stamped = 0
self.ended = 0
elif re.match("(DURATION|DTEND|DUE)[:;]", line):
if self.ended:
return False
self.ended += 1
elif re.match("DTSTAMP[:;]", line):
if self.stamped:
return False
self.stamped += 1
return True
## sorry for being english-language-euro-centric ... fits rather perfectly as default language for me :-)
def create_ical(ical_fragment=None, objtype=None, language="en_DK", **props):
"""
I somehow feel this fits more into the icalendar library than here
"""
ical_fragment = to_normal_str(ical_fragment)
if not ical_fragment or not re.search("^BEGIN:V", ical_fragment, re.MULTILINE):
my_instance = icalendar.Calendar()
my_instance.add("prodid", "-//python-caldav//caldav//" + language)
my_instance.add("version", "2.0")
if objtype is None:
objtype = "VEVENT"
component = icalendar.cal.component_factory[objtype]()
component.add("dtstamp", datetime.datetime.now(tz=datetime.timezone.utc))
if not props.get("uid") and not "\nUID:" in (ical_fragment or ""):
component.add("uid", uuid.uuid1())
my_instance.add_component(component)
## STATUS should default to NEEDS-ACTION for tasks, if it's not set
## (otherwise we cannot easily add a task to a davical calendar and
## then find it again - ref https://gitlab.com/davical-project/davical/-/issues/281
if (
not props.get("status")
and not "\nSTATUS:" in (ical_fragment or "")
and objtype == "VTODO"
):
props["status"] = "NEEDS-ACTION"
else:
if not ical_fragment.strip().startswith("BEGIN:VCALENDAR"):
ical_fragment = (
"BEGIN:VCALENDAR\n"
+ to_normal_str(ical_fragment.strip())
+ "\nEND:VCALENDAR\n"
)
my_instance = icalendar.Calendar.from_ical(ical_fragment)
component = my_instance.subcomponents[0]
ical_fragment = None
for prop in props:
if props[prop] is not None:
if isinstance(props[prop], datetime.datetime) and not props[prop].tzinfo:
## We need to have a timezone! Assume UTC.
props[prop] = props[prop].astimezone(datetime.timezone.utc)
if prop in ("child", "parent"):
for value in props[prop]:
component.add(
"related-to",
str(value),
parameters={"reltype": prop.upper()},
encode=True,
)
else:
component.add(prop, props[prop])
ret = to_normal_str(my_instance.to_ical())
if ical_fragment and ical_fragment.strip():
ret = re.sub(
"^END:V",
ical_fragment.strip() + "\nEND:V",
ret,
flags=re.MULTILINE,
count=1,
)
return ret
|
