Page MenuHomePhorge

No OneTemporary

Authored By
Unknown
Size
92 KB
Referenced Files
None
Subscribers
None
diff --git a/pykolab/xml/event.py b/pykolab/xml/event.py
index 7a81ab8..ab643a5 100644
--- a/pykolab/xml/event.py
+++ b/pykolab/xml/event.py
@@ -1,1445 +1,1453 @@
import datetime
import icalendar
import kolabformat
import pytz
import time
import uuid
import base64
import re
import pykolab
from pykolab import constants
from pykolab import utils
from pykolab.xml import utils as xmlutils
from pykolab.xml import participant_status_label
from pykolab.translate import _
from os import path
from attendee import Attendee
from contact_reference import ContactReference
from recurrence_rule import RecurrenceRule
log = pykolab.getLogger('pykolab.xml_event')
def ustr(s):
if not isinstance(s, unicode):
for cs in ['utf-8','latin-1']:
try:
s = unicode(s, cs)
break
except:
pass
if isinstance(s, unicode):
return s.encode('utf-8')
return s
def event_from_ical(ical, string=None):
return Event(from_ical=ical, from_string=string)
def event_from_string(string):
return Event(from_string=string)
def event_from_message(message):
event = None
if message.is_multipart():
for part in message.walk():
if part.get_content_type() == "application/calendar+xml":
payload = part.get_payload(decode=True)
event = event_from_string(payload)
# append attachment parts to Event object
elif event and part.has_key('Content-ID'):
event._attachment_parts.append(part)
return event
class Event(object):
type = 'event'
thisandfuture = False
status_map = {
None: kolabformat.StatusUndefined,
"TENTATIVE": kolabformat.StatusTentative,
"CONFIRMED": kolabformat.StatusConfirmed,
"CANCELLED": kolabformat.StatusCancelled,
"COMPLETED": kolabformat.StatusCompleted,
"IN-PROCESS": kolabformat.StatusInProcess,
"NEEDS-ACTION": kolabformat.StatusNeedsAction,
}
classification_map = {
"PUBLIC": kolabformat.ClassPublic,
"PRIVATE": kolabformat.ClassPrivate,
"CONFIDENTIAL": kolabformat.ClassConfidential,
}
alarm_type_map = {
'EMAIL': kolabformat.Alarm.EMailAlarm,
'DISPLAY': kolabformat.Alarm.DisplayAlarm,
'AUDIO': kolabformat.Alarm.AudioAlarm
}
related_map = {
'START': kolabformat.Start,
'END': kolabformat.End
}
properties_map = {
# property: getter
"uid": "get_uid",
"created": "get_created",
"lastmodified-date": "get_lastmodified",
"sequence": "sequence",
"classification": "get_classification",
"categories": "categories",
"start": "get_start",
"end": "get_end",
"duration": "get_duration",
"transparency": "transparency",
"rrule": "recurrenceRule",
"rdate": "recurrenceDates",
"exdate": "exceptionDates",
"recurrence-id": "recurrenceID",
"summary": "summary",
"description": "description",
"priority": "priority",
"status": "get_ical_status",
"location": "location",
"organizer": "organizer",
"attendee": "get_attendees",
"attach": "attachments",
"url": "url",
"alarm": "alarms",
"x-custom": "customProperties",
# TODO: add to_dict() support for these
# "exception": "exceptions",
}
def __init__(self, from_ical="", from_string=""):
self._attendees = []
self._categories = []
self._exceptions = []
self._attachment_parts = []
if isinstance(from_ical, str) and from_ical == "":
if from_string == "":
self.event = kolabformat.Event()
else:
self.event = kolabformat.readEvent(from_string, False)
self._load_attendees()
self._load_exceptions()
else:
self.from_ical(from_ical, from_string)
self.uid = self.get_uid()
def _load_attendees(self):
for a in self.event.attendees():
att = Attendee(a.contact().email())
att.copy_from(a)
self._attendees.append(att)
def _load_exceptions(self):
for ex in self.event.exceptions():
exception = Event()
exception.uid = ex.uid()
exception.event = ex
exception._load_attendees()
self._exceptions.append(exception)
def add_attendee(self, email_or_attendee, name=None, rsvp=False, role=None, participant_status=None, cutype="INDIVIDUAL", params=None):
if isinstance(email_or_attendee, Attendee):
attendee = email_or_attendee
else:
attendee = Attendee(email_or_attendee, name, rsvp, role, participant_status, cutype, params)
# apply update to self and all exceptions
self.update_attendees([attendee], True)
def add_category(self, category):
self._categories.append(ustr(category))
self.event.setCategories(self._categories)
def add_exception_date(self, _datetime):
valid_datetime = False
if isinstance(_datetime, datetime.date):
valid_datetime = True
if isinstance(_datetime, datetime.datetime):
# If no timezone information is passed on, make it UTC
if _datetime.tzinfo == None:
_datetime = _datetime.replace(tzinfo=pytz.utc)
valid_datetime = True
if not valid_datetime:
raise InvalidEventDateError, _("Exdate needs datetime.date or datetime.datetime instance, got %r") % (type(_datetime))
self.event.addExceptionDate(xmlutils.to_cdatetime(_datetime, True))
def add_exception(self, exception):
recurrence_id = exception.get_recurrence_id()
if recurrence_id is None:
raise EventIntegrityError, "Recurrence exceptions require a Recurrence-ID property"
# check if an exception with the given recurrence-id already exists
append = True
vexceptions = self.event.exceptions()
for i, ex in enumerate(self._exceptions):
if ex.get_recurrence_id() == recurrence_id and ex.thisandfuture == exception.thisandfuture:
# update the existing exception
vexceptions[i] = exception.event
self._exceptions[i] = exception
append = False
# check if main event matches the given recurrence-id
if append and self.get_recurrence_id() == recurrence_id:
self.event = exception.event
self._load_attendees()
self._load_exceptions()
append = False
if append:
vexceptions.append(exception.event)
self._exceptions.append(exception)
self.event.setExceptions(vexceptions)
def as_string_itip(self, method="REQUEST"):
cal = icalendar.Calendar()
cal.add(
'prodid',
'-//pykolab-%s-%s//kolab.org//' % (
constants.__version__,
constants.__release__
)
)
cal.add('version', '2.0')
# TODO: Really?
cal.add('calscale', 'GREGORIAN')
# TODO: Not always a request...
cal.add('method', method)
# TODO: Add timezone information using icalendar.?()
# Not sure if there is a class for it.
cal.add_component(self.to_ical())
# add recurrence exceptions
if len(self._exceptions) > 0 and not method == 'REPLY':
for exception in self._exceptions:
cal.add_component(exception.to_ical())
if hasattr(cal, 'to_ical'):
return cal.to_ical()
elif hasattr(cal, 'as_string'):
return cal.as_string()
def to_ical(self):
event = icalendar.Event()
# Required
event['uid'] = self.get_uid()
# NOTE: Make sure to list(set()) or duplicates may arise
for attr in list(set(event.singletons)):
_attr = attr.lower().replace('-', '')
ical_getter = 'get_ical_%s' % (_attr)
default_getter = 'get_%s' % (_attr)
retval = None
if hasattr(self, ical_getter):
retval = getattr(self, ical_getter)()
if not retval == None and not retval == "":
event.add(attr.lower(), retval)
elif hasattr(self, default_getter):
retval = getattr(self, default_getter)()
if not retval == None and not retval == "":
event.add(attr.lower(), retval, encode=0)
# NOTE: Make sure to list(set()) or duplicates may arise
for attr in list(set(event.multiple)):
_attr = attr.lower().replace('-', '')
ical_getter = 'get_ical_%s' % (_attr)
default_getter = 'get_%s' % (_attr)
retval = None
if hasattr(self, ical_getter):
retval = getattr(self, ical_getter)()
elif hasattr(self, default_getter):
retval = getattr(self, default_getter)()
if isinstance(retval, list) and not len(retval) == 0:
for _retval in retval:
event.add(attr.lower(), _retval, encode=0)
# copy custom properties to iCal
for cs in self.event.customProperties():
event.add(cs.identifier, cs.value)
return event
def delegate(self, delegators, delegatees, names=None):
if not isinstance(delegators, list):
delegators = [delegators]
if not isinstance(delegatees, list):
delegatees = [delegatees]
if not isinstance(names, list):
names = [names]
_delegators = []
for delegator in delegators:
_delegators.append(self.get_attendee(delegator))
_delegatees = []
for i,delegatee in enumerate(delegatees):
try:
_delegatees.append(self.get_attendee(delegatee))
except:
# TODO: An iTip needs to be sent out to the new attendee
self.add_attendee(delegatee, names[i] if i < len(names) else None)
_delegatees.append(self.get_attendee(delegatee))
for delegator in _delegators:
delegator.delegate_to(_delegatees)
for delegatee in _delegatees:
delegatee.delegate_from(_delegators)
self.event.setAttendees(self._attendees)
def from_ical(self, ical, raw=None):
if isinstance(ical, icalendar.Event) or isinstance(ical, icalendar.Calendar):
ical_event = ical
elif hasattr(icalendar.Event, 'from_ical'):
ical_event = icalendar.Event.from_ical(ical)
elif hasattr(icalendar.Event, 'from_string'):
ical_event = icalendar.Event.from_string(ical)
# VCALENDAR block was given, find the first VEVENT item
if isinstance(ical_event, icalendar.Calendar):
for c in ical_event.walk():
if c.name == 'VEVENT':
ical_event = c
break
# use the libkolab calendaring bindings to load the full iCal data
if ical_event.has_key('RRULE') or ical_event.has_key('ATTACH') \
or [part for part in ical_event.walk() if part.name == 'VALARM']:
if raw is None or raw == "":
raw = ical if isinstance(ical, str) else ical.to_ical()
self._xml_from_ical(raw)
else:
self.event = kolabformat.Event()
# TODO: Clause the timestamps for zulu suffix causing datetime.datetime
# to fail substitution.
for attr in list(set(ical_event.required)):
if ical_event.has_key(attr):
self.set_from_ical(attr.lower(), ical_event[attr])
# NOTE: Make sure to list(set()) or duplicates may arise
for attr in list(set(ical_event.singletons)):
if ical_event.has_key(attr):
self.set_from_ical(attr.lower(), ical_event[attr])
# NOTE: Make sure to list(set()) or duplicates may arise
for attr in list(set(ical_event.multiple)):
if ical_event.has_key(attr):
self.set_from_ical(attr.lower(), ical_event[attr])
def _xml_from_ical(self, ical):
if not "BEGIN:VCALENDAR" in ical:
ical = "BEGIN:VCALENDAR\nVERSION:2.0\n" + ical + "\nEND:VCALENDAR"
from kolab.calendaring import EventCal
self.event = EventCal()
success = self.event.fromICal(ical)
if success:
self._load_exceptions()
return success
def get_attendee_participant_status(self, attendee):
return attendee.get_participant_status()
def get_attendee(self, attendee):
if isinstance(attendee, basestring):
if attendee in [x.get_email() for x in self.get_attendees()]:
attendee = self.get_attendee_by_email(attendee)
elif attendee in [x.get_name() for x in self.get_attendees()]:
attendee = self.get_attendee_by_name(attendee)
else:
raise ValueError, _("No attendee with email or name %r") %(attendee)
return attendee
elif isinstance(attendee, Attendee):
return attendee
else:
raise ValueError, _("Invalid argument value attendee %r, must be basestring or Attendee") % (attendee)
def find_attendee(self, attendee):
try:
return self.get_attendee(attendee)
except:
return None
def get_attendee_by_email(self, email):
if email in [x.get_email() for x in self.get_attendees()]:
return [x for x in self.get_attendees() if x.get_email() == email][0]
raise ValueError, _("No attendee with email %r") %(email)
def get_attendee_by_name(self, name):
if name in [x.get_name() for x in self.get_attendees()]:
return [x for x in self.get_attendees() if x.get_name() == name][0]
raise ValueError, _("No attendee with name %r") %(name)
def get_attendees(self):
return self._attendees
def get_categories(self):
return [str(c) for c in self.event.categories()]
def get_classification(self):
return self.event.classification()
def get_created(self):
try:
return xmlutils.from_cdatetime(self.event.created(), True)
except ValueError:
return datetime.datetime.now()
def get_description(self):
return self.event.description()
def get_comment(self):
if hasattr(self.event, 'comment'):
return self.event.comment()
else:
return None
def get_duration(self):
duration = self.event.duration()
if duration and duration.isValid():
dtd = datetime.timedelta(
days=duration.days(),
seconds=duration.seconds(),
minutes=duration.minutes(),
hours=duration.hours(),
weeks=duration.weeks()
)
return dtd
return None
def get_end(self):
dt = xmlutils.from_cdatetime(self.event.end(), True)
if not dt:
duration = self.get_duration()
if duration is not None:
dt = self.get_start() + duration
return dt
def get_date_text(self, date_format=None, time_format=None):
if date_format is None:
date_format = _("%Y-%m-%d")
if time_format is None:
time_format = _("%H:%M (%Z)")
start = self.get_start()
end = self.get_end()
all_day = not hasattr(start, 'date')
start_date = start.date() if not all_day else start
end_date = end.date() if not all_day else end
if start_date == end_date:
end_format = time_format
else:
end_format = date_format + " " + time_format
if all_day:
time_format = ''
if start_date == end_date:
return start.strftime(date_format)
return "%s - %s" % (start.strftime(date_format + " " + time_format), end.strftime(end_format))
def get_exception_dates(self):
return map(lambda _: xmlutils.from_cdatetime(_, True), self.event.exceptionDates())
def get_exceptions(self):
return self._exceptions
def has_exceptions(self):
return len(self._exceptions) > 0
def get_attachments(self):
return self.event.attachments()
def get_attachment_data(self, i):
vattach = self.event.attachments()
if i < len(vattach):
attachment = vattach[i]
uri = attachment.uri()
if uri and uri[0:4] == 'cid:':
# get data from MIME part with matching content-id
cid = '<' + uri[4:] + '>'
for p in self._attachment_parts:
if p['Content-ID'] == cid:
return p.get_payload(decode=True)
else:
return attachment.data()
return None
def get_alarms(self):
return self.event.alarms()
def get_ical_attendee(self):
# TODO: Formatting, aye? See also the example snippet:
#
# ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;CUTYPE=GROUP:
# MAILTO:employee-A@host.com
attendees = []
for attendee in self.get_attendees():
email = attendee.get_email()
name = attendee.get_name()
rsvp = attendee.get_rsvp()
role = attendee.get_role()
partstat = attendee.get_participant_status()
cutype = attendee.get_cutype()
delegators = attendee.get_delegated_from()
delegatees = attendee.get_delegated_to()
if rsvp in attendee.rsvp_map.keys():
_rsvp = rsvp
elif rsvp in attendee.rsvp_map.values():
_rsvp = [k for k, v in attendee.rsvp_map.iteritems() if v == rsvp][0]
else:
_rsvp = None
if role in attendee.role_map.keys():
_role = role
elif role in attendee.role_map.values():
_role = [k for k, v in attendee.role_map.iteritems() if v == role][0]
else:
_role = None
if partstat in attendee.participant_status_map.keys():
_partstat = partstat
elif partstat in attendee.participant_status_map.values():
_partstat = [k for k, v in attendee.participant_status_map.iteritems() if v == partstat][0]
else:
_partstat = None
if cutype in attendee.cutype_map.keys():
_cutype = cutype
elif cutype in attendee.cutype_map.values():
_cutype = [k for k, v in attendee.cutype_map.iteritems() if v == cutype][0]
else:
_cutype = None
_attendee = icalendar.vCalAddress("MAILTO:%s" % email)
if not name == None and not name == "":
_attendee.params['CN'] = icalendar.vText(name)
if not _rsvp == None:
_attendee.params['RSVP'] = icalendar.vText(_rsvp)
if not _role == None:
_attendee.params['ROLE'] = icalendar.vText(_role)
if not _partstat == None:
_attendee.params['PARTSTAT'] = icalendar.vText(_partstat)
if not _cutype == None:
_attendee.params['CUTYPE'] = icalendar.vText(_cutype)
if not delegators == None and len(delegators) > 0:
_attendee.params['DELEGATED-FROM'] = icalendar.vText(delegators[0].email())
if not delegatees == None and len(delegatees) > 0:
_attendee.params['DELEGATED-TO'] = icalendar.vText(delegatees[0].email())
attendees.append(_attendee)
return attendees
def get_ical_attendee_participant_status(self, attendee):
attendee = self.get_attendee(attendee)
if attendee.get_participant_status() in attendee.participant_status_map.keys():
return attendee.get_participant_status()
elif attendee.get_participant_status() in attendee.participant_status_map.values():
return [k for k, v in attendee.participant_status_map.iteritems() if v == attendee.get_participant_status()][0]
else:
raise ValueError, _("Invalid participant status")
def get_ical_created(self):
return self.get_created()
def get_ical_dtend(self):
dtend = self.get_end()
# shift end by one day on all-day events
if not hasattr(dtend, 'hour'):
dtend = dtend + datetime.timedelta(days=1)
return dtend
def get_ical_dtstamp(self):
try:
retval = self.get_lastmodified()
if retval == None or retval == "":
return datetime.datetime.now()
except:
return datetime.datetime.now()
def get_ical_lastmodified(self):
return self.get_ical_dtstamp()
def get_ical_dtstart(self):
return self.get_start()
def get_ical_organizer(self):
contact = self.get_organizer()
organizer = icalendar.vCalAddress("MAILTO:%s" % contact.email())
name = contact.name()
if not name == None and not name == "":
organizer.params["CN"] = icalendar.vText(name)
return organizer
def get_ical_status(self):
status = self.event.status()
if status in self.status_map.keys():
return status
return self._translate_value(status, self.status_map) if status else None
def get_ical_class(self):
class_ = self.event.classification()
return self._translate_value(class_, self.classification_map) if class_ else None
def get_ical_sequence(self):
return str(self.event.sequence()) if self.event.sequence() else None
def get_ical_comment(self):
comment = self.get_comment()
if comment is not None:
return [ comment ]
return None
def get_ical_recurrenceid(self):
rid = self.get_recurrence_id()
if isinstance(rid, datetime.datetime) or isinstance(rid, datetime.date):
prop = icalendar.vDatetime(rid)
if self.thisandfuture:
prop.params.update({'RANGE':'THISANDFUTURE'})
return prop
return None
def get_ical_rrule(self):
result = []
rrule = self.get_recurrence()
if rrule.isValid():
result.append(rrule.to_ical())
return result
def get_location(self):
return self.event.location()
def get_lastmodified(self):
try:
_datetime = self.event.lastModified()
if retval == None or retval == "":
self.__str__()
except:
self.__str__()
return xmlutils.from_cdatetime(self.event.lastModified(), True)
def get_organizer(self):
organizer = self.event.organizer()
return organizer
def get_priority(self):
return str(self.event.priority())
def get_start(self):
return xmlutils.from_cdatetime(self.event.start(), True)
def get_status(self, translated=False):
status = self.event.status()
if translated:
return self._translate_value(status, self.status_map) if status else None
return status
def get_summary(self):
return self.event.summary()
def get_uid(self):
uid = self.event.uid()
if not uid == '':
return uid
else:
self.set_uid(uuid.uuid4())
return self.get_uid()
def get_recurrence_id(self):
self.thisandfuture = self.event.thisAndFuture();
- return xmlutils.from_cdatetime(self.event.recurrenceID(), True)
+ recurrence_id = xmlutils.from_cdatetime(self.event.recurrenceID(), True)
+
+ # fix recurrence-id type if stored as date instead of datetime
+ if recurrence_id is not None and isinstance(recurrence_id, datetime.date):
+ dtstart = self.get_start()
+ if not type(recurrence_id) == type(dtstart):
+ recurrence_id = datetime.datetime.combine(recurrence_id, dtstart.time()).replace(tzinfo=dtstart.tzinfo)
+
+ return recurrence_id
def get_thisandfuture(self):
self.thisandfuture = self.event.thisAndFuture();
return self.thisandfuture
def get_sequence(self):
return self.event.sequence()
def get_url(self):
return self.event.url()
def get_transparency(self):
return self.event.transparency()
def get_recurrence(self):
return RecurrenceRule(self.event.recurrenceRule())
def set_attendees(self, _attendees, recursive=False):
if recursive:
self._attendees = []
self.update_attendees(_attendees, True)
else:
self._attendees = _attendees
self.event.setAttendees(self._attendees)
def set_attendee_participant_status(self, attendee, status, rsvp=None):
"""
Set the participant status of an attendee to status.
As the attendee arg, pass an email address or name, for this
function to obtain the attendee object by searching the list of
attendees for this event.
"""
attendee = self.get_attendee(attendee)
attendee.set_participant_status(status)
if rsvp is not None:
attendee.set_rsvp(rsvp)
# apply update to self and all exceptions
self.update_attendees([attendee], False)
def update_attendees(self, _attendees, append=True):
self.merge_attendee_data(_attendees, append)
if len(self._exceptions):
vexceptions = self.event.exceptions()
for i, exception in enumerate(self._exceptions):
exception.merge_attendee_data(_attendees, append)
vexceptions[i] = exception.event
self.event.setExceptions(vexceptions)
def merge_attendee_data(self, _attendees, append=True):
for attendee in _attendees:
found = False
for candidate in self._attendees:
if candidate.get_email() == attendee.get_email():
candidate.copy_from(attendee)
found = True
break
if not found and append:
self._attendees.append(attendee)
self.event.setAttendees(self._attendees)
def set_classification(self, classification):
if classification in self.classification_map.keys():
self.event.setClassification(self.classification_map[classification])
elif classification in self.classification_map.values():
self.event.setClassification(status)
else:
raise ValueError, _("Invalid classification %r") % (classification)
def set_created(self, _datetime=None):
if _datetime == None:
_datetime = datetime.datetime.utcnow()
self.event.setCreated(xmlutils.to_cdatetime(_datetime, False, True))
def set_description(self, description):
self.event.setDescription(ustr(description))
def set_comment(self, comment):
if hasattr(self.event, 'setComment'):
self.event.setComment(ustr(comment))
def set_dtstamp(self, _datetime):
self.event.setLastModified(xmlutils.to_cdatetime(_datetime, False, True))
def set_end(self, _datetime):
valid_datetime = False
if isinstance(_datetime, datetime.date):
valid_datetime = True
if isinstance(_datetime, datetime.datetime):
# If no timezone information is passed on, make it UTC
if _datetime.tzinfo == None:
_datetime = _datetime.replace(tzinfo=pytz.utc)
valid_datetime = True
if not valid_datetime:
raise InvalidEventDateError, _("Event end needs datetime.date or datetime.datetime instance, got %r") % (type(_datetime))
self.event.setEnd(xmlutils.to_cdatetime(_datetime, True))
def set_exception_dates(self, _datetimes):
for _datetime in _datetimes:
self.add_exception_date(_datetime)
def add_custom_property(self, name, value):
if not name.upper().startswith('X-'):
raise ValueError, _("Invalid custom property name %r") % (name)
props = self.event.customProperties()
props.append(kolabformat.CustomProperty(name.upper(), value))
self.event.setCustomProperties(props)
def set_from_ical(self, attr, value):
attr = attr.replace('-', '')
ical_setter = 'set_ical_' + attr
default_setter = 'set_' + attr
params = value.params if hasattr(value, 'params') else {}
if isinstance(value, icalendar.vDDDTypes) and hasattr(value, 'dt'):
value = value.dt
if attr == "categories":
self.add_category(value)
elif attr == "class":
self.set_classification(value)
elif attr == "recurrenceid":
self.set_ical_recurrenceid(value, params)
elif hasattr(self, ical_setter):
getattr(self, ical_setter)(value)
elif hasattr(self, default_setter):
getattr(self, default_setter)(value)
def set_ical_attendee(self, _attendee):
if isinstance(_attendee, basestring):
_attendee = [_attendee]
if isinstance(_attendee, list):
for attendee in _attendee:
address = str(attendee).split(':')[-1]
if hasattr(attendee, 'params'):
params = attendee.params
else:
params = {}
if params.has_key('CN'):
name = ustr(params['CN'])
else:
name = None
if params.has_key('ROLE'):
role = params['ROLE']
else:
role = None
if params.has_key('PARTSTAT'):
partstat = params['PARTSTAT']
else:
partstat = None
if params.has_key('RSVP'):
rsvp = params['RSVP']
else:
rsvp = None
if params.has_key('CUTYPE'):
cutype = params['CUTYPE']
else:
cutype = kolabformat.CutypeIndividual
att = self.add_attendee(address, name=name, rsvp=rsvp, role=role, participant_status=partstat, cutype=cutype, params=params)
def set_ical_dtend(self, dtend):
# shift end by one day on all-day events
if not hasattr(dtend, 'hour'):
dtend = dtend - datetime.timedelta(days=1)
self.set_end(dtend)
def set_ical_dtstamp(self, dtstamp):
self.set_dtstamp(dtstamp)
def set_ical_dtstart(self, dtstart):
self.set_start(dtstart)
def set_ical_lastmodified(self, lastmod):
self.set_lastmodified(lastmod)
def set_ical_duration(self, value):
if hasattr(value, 'dt'):
value = value.dt
duration = kolabformat.Duration(value.days, 0, 0, value.seconds, False)
self.event.setDuration(duration)
def set_ical_organizer(self, organizer):
address = str(organizer).split(':')[-1]
cn = None
if hasattr(organizer, 'params'):
params = organizer.params
else:
params = {}
if params.has_key('CN'):
cn = ustr(params['CN'])
self.set_organizer(str(address), name=cn)
def set_ical_priority(self, priority):
self.set_priority(priority)
def set_ical_sequence(self, sequence):
self.set_sequence(sequence)
def set_ical_summary(self, summary):
self.set_summary(ustr(summary))
def set_ical_uid(self, uid):
self.set_uid(str(uid))
def set_ical_recurrenceid(self, value, params):
try:
self.thisandfuture = params.get('RANGE', '') == 'THISANDFUTURE'
self.set_recurrence_id(value, self.thisandfuture)
except InvalidEventDateError, e:
pass
def set_lastmodified(self, _datetime=None):
valid_datetime = False
if isinstance(_datetime, datetime.date):
valid_datetime = True
if isinstance(_datetime, datetime.datetime):
valid_datetime = True
if _datetime == None:
valid_datetime = True
_datetime = datetime.datetime.utcnow()
if not valid_datetime:
raise InvalidEventDateError, _("Event last-modified needs datetime.date or datetime.datetime instance, got %r") % (type(_datetime))
self.event.setLastModified(xmlutils.to_cdatetime(_datetime, False, True))
def set_location(self, location):
self.event.setLocation(ustr(location))
def set_organizer(self, email, name=None):
contactreference = ContactReference(email)
if not name == None:
contactreference.setName(name)
self.event.setOrganizer(contactreference)
def set_priority(self, priority):
self.event.setPriority(priority)
def set_sequence(self, sequence):
self.event.setSequence(int(sequence))
def set_url(self, url):
self.event.setUrl(str(url))
def set_recurrence(self, recurrence):
self.event.setRecurrenceRule(recurrence)
# reset eventcal instance
if hasattr(self, 'eventcal'):
del self.eventcal
def set_start(self, _datetime):
valid_datetime = False
if isinstance(_datetime, datetime.date):
valid_datetime = True
if isinstance(_datetime, datetime.datetime):
# If no timezone information is passed on, make it UTC
if _datetime.tzinfo == None:
_datetime = _datetime.replace(tzinfo=pytz.utc)
valid_datetime = True
if not valid_datetime:
raise InvalidEventDateError, _("Event start needs datetime.date or datetime.datetime instance, got %r") % (type(_datetime))
self.event.setStart(xmlutils.to_cdatetime(_datetime, True))
def set_status(self, status):
if status in self.status_map.keys():
self.event.setStatus(self.status_map[status])
elif status in self.status_map.values():
self.event.setStatus(status)
elif not status == kolabformat.StatusUndefined:
raise InvalidEventStatusError, _("Invalid status set: %r") % (status)
def set_summary(self, summary):
self.event.setSummary(summary)
def set_uid(self, uid):
self.uid = uid
self.event.setUid(str(uid))
def set_recurrence_id(self, _datetime, _thisandfuture=None):
valid_datetime = False
if isinstance(_datetime, datetime.date):
valid_datetime = True
if isinstance(_datetime, datetime.datetime):
# If no timezone information is passed on, use the one from event start
if _datetime.tzinfo == None:
_start = self.get_start()
_datetime = _datetime.replace(tzinfo=_start.tzinfo)
valid_datetime = True
if not valid_datetime:
raise InvalidEventDateError, _("Event recurrence-id needs datetime.datetime instance")
if _thisandfuture is None:
_thisandfuture = self.thisandfuture
self.event.setRecurrenceID(xmlutils.to_cdatetime(_datetime), _thisandfuture)
def set_transparency(self, transp):
return self.event.setTransparency(transp)
def __str__(self):
event_xml = kolabformat.writeEvent(self.event)
error = kolabformat.error()
if error == None or not error:
return event_xml
else:
raise EventIntegrityError, kolabformat.errorMessage()
def to_dict(self):
data = dict()
for p, getter in self.properties_map.iteritems():
val = None
if hasattr(self, getter):
val = getattr(self, getter)()
elif hasattr(self.event, getter):
val = getattr(self.event, getter)()
if isinstance(val, kolabformat.cDateTime):
val = xmlutils.from_cdatetime(val, True)
elif isinstance(val, kolabformat.vectordatetime):
val = [xmlutils.from_cdatetime(x, True) for x in val]
elif isinstance(val, kolabformat.vectors):
val = [str(x) for x in val]
elif isinstance(val, kolabformat.vectorcs):
for x in val:
data[x.identifier] = x.value
val = None
elif isinstance(val, kolabformat.ContactReference):
val = ContactReference(val).to_dict()
elif isinstance(val, kolabformat.RecurrenceRule):
val = RecurrenceRule(val).to_dict()
elif isinstance(val, kolabformat.vectorattachment):
val = [dict(fmttype=x.mimetype(), label=x.label(), uri=x.uri()) for x in val]
elif isinstance(val, kolabformat.vectoralarm):
val = [self._alarm_to_dict(x) for x in val]
elif isinstance(val, list):
val = [x.to_dict() for x in val if hasattr(x, 'to_dict')]
if val is not None:
data[p] = val
return data
def _alarm_to_dict(self, alarm):
ret = dict(
action=self._translate_value(alarm.type(), self.alarm_type_map),
summary=alarm.summary(),
description=alarm.description(),
trigger=None
)
start = alarm.start()
if start and start.isValid():
ret['trigger'] = xmlutils.from_cdatetime(start, True)
else:
ret['trigger'] = dict(related=self._translate_value(alarm.relativeTo(), self.related_map))
duration = alarm.relativeStart()
if duration and duration.isValid():
prefix = '-' if duration.isNegative() else '+'
value = prefix + "P%dW%dDT%dH%dM%dS" % (
duration.weeks(), duration.days(), duration.hours(), duration.minutes(), duration.seconds()
)
ret['trigger']['value'] = re.sub(r"T$", '', re.sub(r"0[WDHMS]", '', value))
if alarm.type() == kolabformat.Alarm.EMailAlarm:
ret['attendee'] = [ContactReference(a).to_dict() for a in alarm.attendees()]
return ret
def _translate_value(self, val, map):
name_map = dict([(v, k) for (k, v) in map.iteritems()])
return name_map[val] if name_map.has_key(val) else 'UNKNOWN'
def to_message(self, creator=None):
from email.MIMEMultipart import MIMEMultipart
from email.MIMEBase import MIMEBase
from email.MIMEText import MIMEText
from email.Utils import COMMASPACE, formatdate
msg = MIMEMultipart()
organizer = self.get_organizer()
email = organizer.email()
name = organizer.name()
if creator:
msg['From'] = creator
elif not name:
msg['From'] = email
else:
msg['From'] = '"%s" <%s>' % (name, email)
msg['To'] = ', '.join([x.__str__() for x in self.get_attendees()])
msg['Date'] = formatdate(localtime=True)
msg.add_header('X-Kolab-MIME-Version', '3.0')
msg.add_header('X-Kolab-Type', 'application/x-vnd.kolab.' + self.type)
text = utils.multiline_message("""
This is a Kolab Groupware object. To view this object you
will need an email client that understands the Kolab
Groupware format. For a list of such email clients please
visit http://www.kolab.org/
""")
msg.attach( MIMEText(text) )
part = MIMEBase('application', "calendar+xml")
part.set_charset('UTF-8')
msg["Subject"] = self.get_uid()
# extract attachment data into separate MIME parts
vattach = self.event.attachments()
i = 0
for attach in vattach:
if attach.uri():
continue
mimetype = attach.mimetype()
(primary, seconday) = mimetype.split('/')
name = attach.label()
if not name:
name = 'unknown.x'
(basename, suffix) = path.splitext(name)
t = datetime.datetime.now()
cid = "%s.%s.%s%s" % (basename, time.mktime(t.timetuple()), t.microsecond + len(self._attachment_parts), suffix)
p = MIMEBase(primary, seconday)
p.add_header('Content-Disposition', 'attachment', filename=name)
p.add_header('Content-Transfer-Encoding', 'base64')
p.add_header('Content-ID', '<' + cid + '>')
p.set_payload(base64.b64encode(attach.data()))
self._attachment_parts.append(p)
# modify attachment object
attach.setData('', mimetype)
attach.setUri('cid:' + cid, mimetype)
vattach[i] = attach
i += 1
self.event.setAttachments(vattach)
part.set_payload(str(self))
part.add_header('Content-Disposition', 'attachment; filename="kolab.xml"')
part.replace_header('Content-Transfer-Encoding', '8bit')
msg.attach(part)
# append attachment parts
for p in self._attachment_parts:
msg.attach(p)
return msg
def to_message_itip(self, from_address, method="REQUEST", participant_status="ACCEPTED", subject=None, message_text=None):
from email.MIMEMultipart import MIMEMultipart
from email.MIMEBase import MIMEBase
from email.MIMEText import MIMEText
from email.Utils import COMMASPACE, formatdate
# encode unicode strings with quoted-printable
from email import charset
charset.add_charset('utf-8', charset.SHORTEST, charset.QP)
msg = MIMEMultipart()
msg_from = None
attendees = None
if method == "REPLY":
# TODO: Make user friendly name <email>
msg['To'] = self.get_organizer().email()
attendees = self.get_attendees()
reply_attendees = []
# There's an exception here for delegation (partstat DELEGATED)
for attendee in attendees:
if attendee.get_email() == from_address:
# Only the attendee is supposed to be listed in a reply
attendee.set_participant_status(participant_status)
attendee.set_rsvp(False)
reply_attendees.append(attendee)
name = attendee.get_name()
email = attendee.get_email()
if not name:
msg_from = email
else:
msg_from = '"%s" <%s>' % (name, email)
elif from_address in attendee.get_delegated_from(True):
reply_attendees.append(attendee)
# keep only replying (and delegated) attendee(s)
self._attendees = reply_attendees
self.event.setAttendees(self._attendees)
if msg_from == None:
organizer = self.get_organizer()
email = organizer.email()
name = organizer.name()
if email == from_address:
if not name:
msg_from = email
else:
msg_from = '"%s" <%s>' % (name, email)
elif method == "REQUEST":
organizer = self.get_organizer()
email = organizer.email()
name = organizer.name()
if not name:
msg_from = email
else:
msg_from = '"%s" <%s>' % (name, email)
if msg_from == None:
if from_address == None:
log.error(_("No sender specified"))
else:
msg_from = from_address
msg['From'] = utils.str2unicode(msg_from)
msg['Date'] = formatdate(localtime=True)
if subject is None:
subject = _("Invitation for %s was %s") % (self.get_summary(), participant_status_label(participant_status))
msg['Subject'] = utils.str2unicode(subject)
if message_text is None:
message_text = _("""This is an automated response to one of your event requests.""")
msg.attach(MIMEText(utils.stripped_message(message_text), _charset='utf-8'))
part = MIMEBase('text', 'calendar', charset='UTF-8', method=method)
del part['MIME-Version'] # mime parts don't need this
part.set_payload(self.as_string_itip(method=method))
part.add_header('Content-Disposition', 'attachment; filename="event.ics"')
part.add_header('Content-Transfer-Encoding', '8bit')
msg.attach(part)
# restore the original list of attendees
# attendees being reduced to the replying attendee above
if attendees is not None:
self._attendees = attendees
self.event.setAttendees(self._attendees)
return msg
def is_recurring(self):
return self.event.recurrenceRule().isValid()
def to_event_cal(self):
from kolab.calendaring import EventCal
return EventCal(self.event)
def get_next_occurence(self, _datetime):
if not hasattr(self, 'eventcal'):
self.eventcal = self.to_event_cal()
next_cdatetime = self.eventcal.getNextOccurence(xmlutils.to_cdatetime(_datetime, True))
next_datetime = xmlutils.from_cdatetime(next_cdatetime, True) if next_cdatetime is not None else None
# cut infinite recurrence at a reasonable point
if next_datetime and not self.get_last_occurrence() and next_datetime > xmlutils.to_dt(self._recurrence_end()):
next_datetime = None
# next_datetime is always a cdatetime, convert to date if necessary
if next_datetime and not isinstance(self.get_start(), datetime.datetime):
next_datetime = datetime.date(next_datetime.year, next_datetime.month, next_datetime.day)
return next_datetime
def get_occurence_end_date(self, datetime):
if not datetime:
return None
if not hasattr(self, 'eventcal'):
return None
end_cdatetime = self.eventcal.getOccurenceEndDate(xmlutils.to_cdatetime(datetime, True))
return xmlutils.from_cdatetime(end_cdatetime, True) if end_cdatetime is not None else None
def get_last_occurrence(self, force=False):
if not hasattr(self, 'eventcal'):
self.eventcal = self.to_event_cal()
last = self.eventcal.getLastOccurrence()
last_datetime = xmlutils.from_cdatetime(last, True) if last is not None else None
# we're forced to return some date
if last_datetime is None and force:
last_datetime = self._recurrence_end()
return last_datetime
def get_next_instance(self, datetime):
next_start = self.get_next_occurence(datetime)
if next_start:
instance = Event(from_string=str(self))
instance.set_start(next_start)
instance.event.setRecurrenceID(xmlutils.to_cdatetime(next_start), False)
next_end = self.get_occurence_end_date(next_start)
if next_end:
instance.set_end(next_end)
# unset recurrence rule and exceptions
instance.set_recurrence(kolabformat.RecurrenceRule())
instance.event.setExceptions(kolabformat.vectorevent())
instance.event.setExceptionDates(kolabformat.vectordatetime())
instance._exceptions = []
instance._isexception = False
# unset attachments list (only stored in main event)
instance.event.setAttachments(kolabformat.vectorattachment())
# copy data from matching exception
# (give precedence to single occurrence exceptions over thisandfuture)
for exception in self._exceptions:
recurrence_id = exception.get_recurrence_id()
if recurrence_id == next_start and (not exception.thisandfuture or not instance._isexception):
instance = exception
instance._isexception = True
if not exception.thisandfuture:
break
elif exception.thisandfuture and next_start > recurrence_id:
# TODO: merge exception properties over this instance + adjust start/end with the according offset
pass
return instance
return None
def get_instance(self, _datetime):
# If no timezone information is given, use the one from event start
if isinstance(_datetime, datetime.datetime) and _datetime.tzinfo == None:
_start = self.get_start()
if hasattr(_start, 'tzinfo'):
_datetime = _datetime.replace(tzinfo=_start.tzinfo)
if self.is_recurring():
instance = self.get_next_instance(_datetime - datetime.timedelta(days=1))
while instance:
recurrence_id = instance.get_recurrence_id()
if type(recurrence_id) == type(_datetime) and recurrence_id <= _datetime:
if xmlutils.dates_equal(recurrence_id, _datetime):
return instance
instance = self.get_next_instance(instance.get_start())
else:
break
elif self.has_exceptions():
for exception in self._exceptions:
recurrence_id = exception.get_recurrence_id()
if type(recurrence_id) == type(_datetime) and xmlutils.dates_equal(recurrence_id, _datetime):
return exception
if self.get_recurrence_id():
recurrence_id = self.get_recurrence_id()
if type(recurrence_id) == type(_datetime) and xmlutils.dates_equal(recurrence_id, _datetime):
return self
return None
def _recurrence_end(self):
"""
Determine a reasonable end date for infinitely recurring events
"""
rrule = self.event.recurrenceRule()
if rrule.isValid() and rrule.count() < 0 and not rrule.end().isValid():
now = datetime.datetime.now()
switch = {
kolabformat.RecurrenceRule.Yearly: 100,
kolabformat.RecurrenceRule.Monthly: 20
}
intvl = switch[rrule.frequency()] if rrule.frequency() in switch else 10
return self.get_start().replace(year=now.year + intvl)
return xmlutils.from_cdatetime(rrule.end(), True)
class EventIntegrityError(Exception):
def __init__(self, message):
Exception.__init__(self, message)
class InvalidEventDateError(Exception):
def __init__(self, message):
Exception.__init__(self, message)
class InvalidEventStatusError(Exception):
def __init__(self, message):
Exception.__init__(self, message)
diff --git a/tests/unit/test-003-event.py b/tests/unit/test-003-event.py
index 5798101..f039ca1 100644
--- a/tests/unit/test-003-event.py
+++ b/tests/unit/test-003-event.py
@@ -1,963 +1,971 @@
import re
import datetime
import pytz
import sys
import unittest
import kolabformat
import icalendar
import pykolab
from pykolab.xml import Attendee
from pykolab.xml import Event
from pykolab.xml import RecurrenceRule
from pykolab.xml import EventIntegrityError
from pykolab.xml import InvalidAttendeeParticipantStatusError
from pykolab.xml import InvalidEventDateError
from pykolab.xml import event_from_ical
from pykolab.xml import event_from_string
from pykolab.xml import event_from_message
from pykolab.xml import compute_diff
from pykolab.xml import property_to_string
from collections import OrderedDict
ical_event = """
BEGIN:VEVENT
UID:7a35527d-f783-4b58-b404-b1389bd2fc57
DTSTAMP;VALUE=DATE-TIME:20140407T122311Z
CREATED;VALUE=DATE-TIME:20140407T122245Z
LAST-MODIFIED;VALUE=DATE-TIME:20140407T122311Z
DTSTART;TZID=Europe/Zurich;VALUE=DATE-TIME:20140523T110000
DURATION:PT1H30M0S
RRULE:FREQ=WEEKLY;INTERVAL=1;COUNT=10
EXDATE;TZID=Europe/Zurich;VALUE=DATE-TIME:20140530T110000
EXDATE;TZID=Europe/Zurich;VALUE=DATE-TIME:20140620T110000
SUMMARY:Summary
LOCATION:Location
DESCRIPTION:Description\\n2 lines
CATEGORIES:Personal
TRANSP:OPAQUE
PRIORITY:2
SEQUENCE:2
CLASS:PUBLIC
ATTENDEE;CN="Manager, Jane";PARTSTAT=NEEDS-ACTION;ROLE=REQ-PARTICIPANT;CUTYP
E=INDIVIDUAL;RSVP=TRUE:mailto:jane.manager@example.org
ATTENDEE;CUTYPE=RESOURCE;PARTSTAT=NEEDS-ACTION;ROLE=OPT-PARTICIPANT;RSVP=FA
LSE:MAILTO:max@imum.com
ORGANIZER;CN=Doe\, John:mailto:john.doe@example.org
URL:http://somelink.com/foo
ATTACH;VALUE=BINARY;ENCODING=BASE64;FMTTYPE=image/png;X-LABEL=silhouette.pn
g:iVBORw0KGgoAAAANSUhEUgAAAC4AAAAuCAIAAADY27xgAAAAGXRFWHRTb2Z0d2FyZQBBZG9i
ZSBJbWFnZVJlYWR5ccllPAAAAsRJREFUeNrsmeluKjEMhTswrAWB4P3fECGx79CjsTDmOKRkpF
xxpfoHSmchX7ybFrfb7eszpPH1MfKH8ofyH6KUtd/c7/en0wmfWBdF0Wq1Op1Ou91uNGoer6iX
V1ar1Xa7xUJeB4qsr9frdyVlWWZH2VZyPp+xPXHIAoK70+m02+1m9JXj8bhcLi+Xi3J4xUCazS
bUltdtd7ud7ldUIhC3u+iTwF0sFhlR4Kds4LtRZK1w4te5UM6V6JaqhqC3CQ28OAsKggJfbZ3U
eozCqZ4koHIZCGmD9ivuos9YONFirmxrI0UNZG1kbZeUXdJQNJNa91RlqMn0ekYUMZDup6dXVV
m+1OSZhqLx6bVCELJGSsyFQtFrF15JGYMZgoxubWGDSDVhvTipDKWhoBOIpFobxtlbJ0Gh0/tg
lgXal4woUHi/36fQoBQncDAlupa8DeVwOPRe4lUyGAwQ+dl7W+xBXkJBhEUqR32UoJfYIKrR4d
ZBgcdIRqfEqn+mekl9FNRbSTA249la3ev1/kXHD47ZbEYR5L9kMplkd9vNZqMFyIYxxfN8Pk8q
QGlagT5QDtfrNYUMlWW9LiGNPPSmC/+OgpK2r4RO6dOatZd+4gAAemdIi6Fg9EKLD4vASWkzv3
ew06NSCiA40CumAIoaIrhrcAwjF7aDo58gUchgNV+0n1BAcDgcoAZrXV9mI4qkhtK6FJFhi9Fo
ZKPsgQI1ACJieH/Kd570t+xFoIzHYzl5Q40CFGrSqGuks3qmYIKJfIl0nPKLxAMFw7Dv1+2QYf
vFSOBQubbOFDSc7ZcfWvHv6DzhOzT6IeOVPuz8Roex0f6EgsE/2IL4qdg7hIXz7/pBie7q1uWr
tp66xrif0l1KwUE4P7Y9Gci/ZgtNRFX+Rw06Q2RigsjuDc3urwKHxuNITaaxyD9mT2WvSDAXn/
Pvhh8BBgBjyfPSGbSYcwAAAABJRU5ErkJggg==
ATTACH;VALUE=BINARY;ENCODING=BASE64;FMTTYPE=text/plain;X-LABEL=text.txt:VGh
pcyBpcyBhIHRleHQgZmlsZQo=
BEGIN:VALARM
ACTION:DISPLAY
TRIGGER:-PT30M
END:VALARM
END:VEVENT
"""
ical_exception = """
BEGIN:VEVENT
UID:7a35527d-f783-4b58-b404-b1389bd2fc57
DTSTAMP;VALUE=DATE-TIME:20140407T122311Z
CREATED;VALUE=DATE-TIME:20140407T122245Z
LAST-MODIFIED;VALUE=DATE-TIME:20140407T122311Z
RECURRENCE-ID;TZID=Europe/Zurich;RANGE=THISANDFUTURE:20140606T110000
DTSTART;TZID=Europe/Zurich;VALUE=DATE-TIME:20140607T120000
DTEND;TZID=Europe/Zurich;VALUE=DATE-TIME:20140607T143000
SUMMARY:Exception
CATEGORIES:Personal
TRANSP:TRANSPARENT
PRIORITY:2
SEQUENCE:3
STATUS:CANCELLED
ORGANIZER;CN=Doe\, John:mailto:john.doe@example.org
END:VEVENT
"""
xml_event = """
<icalendar xmlns="urn:ietf:params:xml:ns:icalendar-2.0">
<vcalendar>
<properties>
<prodid>
<text>Libkolabxml-1.1</text>
</prodid>
<version>
<text>2.0</text>
</version>
<x-kolab-version>
<text>3.1.0</text>
</x-kolab-version>
</properties>
<components>
<vevent>
<properties>
<uid>
<text>75c740bb-b3c6-442c-8021-ecbaeb0a025e</text>
</uid>
<created>
<date-time>2014-07-07T01:28:23Z</date-time>
</created>
<dtstamp>
<date-time>2014-07-07T01:28:23Z</date-time>
</dtstamp>
<sequence>
<integer>1</integer>
</sequence>
<class>
<text>PUBLIC</text>
</class>
<dtstart>
<parameters>
<tzid>
<text>/kolab.org/Europe/London</text>
</tzid>
</parameters>
<date-time>2014-08-13T10:00:00</date-time>
</dtstart>
<dtend>
<parameters>
<tzid><text>/kolab.org/Europe/London</text></tzid>
</parameters>
<date-time>2014-08-13T14:00:00</date-time>
</dtend>
<rrule>
<recur>
<freq>DAILY</freq>
<until>
<date>2015-07-25</date>
</until>
</recur>
</rrule>
<exdate>
<parameters>
<tzid>
<text>/kolab.org/Europe/Berlin</text>
</tzid>
</parameters>
<date>2014-07-19</date>
<date>2014-07-26</date>
<date>2014-07-12</date>
<date>2014-07-13</date>
<date>2014-07-20</date>
<date>2014-07-27</date>
<date>2014-07-05</date>
<date>2014-07-06</date>
</exdate>
<summary>
<text>test</text>
</summary>
<description>
<text>test</text>
</description>
<priority>
<integer>5</integer>
</priority>
<status>
<text>CANCELLED</text>
</status>
<location>
<text>Room 101</text>
</location>
<organizer>
<parameters>
<cn><text>Doe, John</text></cn>
</parameters>
<cal-address>mailto:%3Cjohn%40example.org%3E</cal-address>
</organizer>
<attendee>
<parameters>
<partstat><text>ACCEPTED</text></partstat>
<role><text>REQ-PARTICIPANT</text></role>
<rsvp><boolean>true</boolean></rsvp>
<delegated-from><cal-address>mailto:%3Csomebody%40else.com%3E</cal-address></delegated-from>
</parameters>
<cal-address>mailto:%3Cjane%40example.org%3E</cal-address>
</attendee>
<attendee>
<parameters>
<partstat><text>DELEGATED</text></partstat>
<role><text>NON-PARTICIPANT</text></role>
<delegated-to><cal-address>mailto:%3Cjane%40example.org%3E</cal-address></delegated-to>
</parameters>
<cal-address>mailto:%3Csomebody%40else.com%3E</cal-address>
</attendee>
<attach>
<parameters>
<fmttype>
<text>text/html</text>
</fmttype>
<x-label>
<text>noname.1395223627.5555</text>
</x-label>
</parameters>
<uri>cid:noname.1395223627.5555</uri>
</attach>
<x-custom>
<identifier>X-MOZ-RECEIVED-DTSTAMP</identifier>
<value>20140224T155612Z</value>
</x-custom>
<x-custom>
<identifier>X-GWSHOW-AS</identifier>
<value>BUSY</value>
</x-custom>
</properties>
<components>
<valarm>
<properties>
<action>
<text>DISPLAY</text>
</action>
<description>
<text>alarm 1</text>
</description>
<trigger>
<parameters>
<related>
<text>START</text>
</related>
</parameters>
<duration>-PT2H</duration>
</trigger>
</properties>
</valarm>
<valarm>
<properties>
<action>
<text>EMAIL</text>
</action>
<summary>
<text>test</text>
</summary>
<description>
<text>alarm 2</text>
</description>
<attendee>
<cal-address>mailto:%3Cjohn.doe%40example.org%3E</cal-address>
</attendee>
<trigger>
<parameters>
<related>
<text>START</text>
</related>
</parameters>
<duration>-P1D</duration>
</trigger>
</properties>
</valarm>
</components>
</vevent>
<vevent>
<properties>
<uid>
<text>75c740bb-b3c6-442c-8021-ecbaeb0a025e</text>
</uid>
<created>
<date-time>2014-07-07T01:28:23Z</date-time>
</created>
<dtstamp>
<date-time>2014-07-07T01:28:23Z</date-time>
</dtstamp>
<sequence>
<integer>2</integer>
</sequence>
<class>
<text>PUBLIC</text>
</class>
<dtstart>
<parameters>
<tzid>
<text>/kolab.org/Europe/London</text>
</tzid>
</parameters>
<date-time>2014-08-16T13:00:00</date-time>
</dtstart>
<dtend>
<parameters>
<tzid><text>/kolab.org/Europe/London</text></tzid>
</parameters>
<date-time>2014-08-16T16:00:00</date-time>
</dtend>
<recurrence-id>
<parameters>
<tzid>
<text>/kolab.org/Europe/London</text>
</tzid>
<range>
<text>THISANDFUTURE</text>
</range>
</parameters>
<date-time>2014-08-16T10:00:00</date-time>
</recurrence-id>
<summary>
<text>exception</text>
</summary>
<description>
<text>exception</text>
</description>
<location>
<text>Room 101</text>
</location>
<organizer>
<parameters>
<cn><text>Doe, John</text></cn>
</parameters>
<cal-address>mailto:%3Cjohn%40example.org%3E</cal-address>
</organizer>
<attendee>
<parameters>
<partstat><text>DECLINED</text></partstat>
<role><text>REQ-PARTICIPANT</text></role>
</parameters>
<cal-address>mailto:%3Cjane%40example.org%3E</cal-address>
</attendee>
</properties>
</vevent>
</components>
</vcalendar>
</icalendar>
"""
class TestEventXML(unittest.TestCase):
event = Event()
@classmethod
def setUp(self):
""" Compatibility for twisted.trial.unittest
"""
self.setup_class()
@classmethod
def setup_class(self, *args, **kw):
# set language to default
pykolab.translate.setUserLanguage('en_US')
def assertIsInstance(self, _value, _type):
if hasattr(unittest.TestCase, 'assertIsInstance'):
return unittest.TestCase.assertIsInstance(self, _value, _type)
else:
if (type(_value)) == _type:
return True
else:
raise AssertionError, "%s != %s" % (type(_value), _type)
def test_000_no_start_date(self):
self.assertRaises(EventIntegrityError, self.event.__str__)
def test_001_minimal(self):
self.event.set_start(datetime.datetime.now(pytz.timezone("Europe/London")))
self.assertIsInstance(self.event.get_start(), datetime.datetime)
self.assertIsInstance(self.event.__str__(), str)
def test_002_attendees_list(self):
self.assertIsInstance(self.event.get_attendees(), list)
def test_003_attendees_no_default(self):
self.assertEqual(len(self.event.get_attendees()), 0)
def test_004_attendee_add(self):
self.event.add_attendee("john@doe.org")
self.assertIsInstance(self.event.get_attendees(), list)
self.assertEqual(len(self.event.get_attendees()), 1)
def test_005_attendee_add_name_and_props(self):
self.event.add_attendee("jane@doe.org", "Doe, Jane", role="OPT-PARTICIPANT", cutype="RESOURCE")
self.assertIsInstance(self.event.get_attendees(), list)
self.assertEqual(len(self.event.get_attendees()), 2)
def test_006_get_attendees(self):
self.assertEqual([x.get_email() for x in self.event.get_attendees()], ["john@doe.org", "jane@doe.org"])
def test_007_get_attendee_by_email(self):
self.assertIsInstance(self.event.get_attendee_by_email("jane@doe.org"), Attendee)
self.assertIsInstance(self.event.get_attendee("jane@doe.org"), Attendee)
def test_007_get_attendee_props(self):
self.assertEqual(self.event.get_attendee("jane@doe.org").get_cutype(), kolabformat.CutypeResource)
self.assertEqual(self.event.get_attendee("jane@doe.org").get_role(), kolabformat.Optional)
def test_007_get_nonexistent_attendee_by_email(self):
self.assertRaises(ValueError, self.event.get_attendee_by_email, "nosuchattendee@invalid.domain")
self.assertRaises(ValueError, self.event.get_attendee, "nosuchattendee@invalid.domain")
def test_008_get_attendee_by_name(self):
self.assertIsInstance(self.event.get_attendee_by_name("Doe, Jane"), Attendee)
self.assertIsInstance(self.event.get_attendee("Doe, Jane"), Attendee)
def test_008_get_nonexistent_attendee_by_name(self):
self.assertRaises(ValueError, self.event.get_attendee_by_name, "Houdini, Harry")
self.assertRaises(ValueError, self.event.get_attendee, "Houdini, Harry")
def test_009_invalid_participant_status(self):
self.assertRaises(InvalidAttendeeParticipantStatusError, self.event.set_attendee_participant_status, "jane@doe.org", "INVALID")
def test_009_update_attendees(self):
jane = self.event.get_attendee("jane@doe.org")
jane.set_name("Jane (GI) Doe")
self.event.update_attendees([jane])
self.assertEqual(len(self.event.get_attendees()), 2)
self.assertEqual(self.event.get_attendee("jane@doe.org").get_name(), "Jane (GI) Doe")
def test_010_datetime_from_string(self):
self.assertRaises(InvalidEventDateError, self.event.set_start, "2012-05-23 11:58:00")
def test_011_attendee_equality(self):
self.assertEqual(self.event.get_attendee("jane@doe.org").get_email(), "jane@doe.org")
def test_012_delegate_new_attendee(self):
self.event.delegate("jane@doe.org", "max@imum.com")
def test_013_delegatee_is_now_attendee(self):
delegatee = self.event.get_attendee("max@imum.com")
self.assertIsInstance(delegatee, Attendee)
self.assertEqual(delegatee.get_role(), kolabformat.Optional)
self.assertEqual(delegatee.get_cutype(), kolabformat.CutypeResource)
def test_014_delegate_attendee_adds(self):
self.assertEqual(len(self.event.get_attendee("jane@doe.org").get_delegated_to()), 1)
self.event.delegate("jane@doe.org", "john@doe.org")
self.assertEqual(len(self.event.get_attendee("jane@doe.org").get_delegated_to()), 2)
def test_015_timezone(self):
_tz = self.event.get_start()
self.assertIsInstance(_tz.tzinfo, datetime.tzinfo)
def test_016_start_with_timezone(self):
_start = datetime.datetime(2012, 05, 23, 11, 58, 00, tzinfo=pytz.timezone("Europe/Zurich"))
_start_utc = _start.astimezone(pytz.utc)
self.assertEqual(_start.__str__(), "2012-05-23 11:58:00+01:00")
self.assertEqual(_start_utc.__str__(), "2012-05-23 10:58:00+00:00")
self.event.set_start(_start)
self.assertIsInstance(_start.tzinfo, datetime.tzinfo)
self.assertEqual(_start.tzinfo, pytz.timezone("Europe/Zurich"))
def test_017_allday_without_timezone(self):
_start = datetime.date(2012, 05, 23)
self.assertEqual(_start.__str__(), "2012-05-23")
self.event.set_start(_start)
self.assertEqual(hasattr(_start,'tzinfo'), False)
self.assertEqual(self.event.get_start().__str__(), "2012-05-23")
def test_018_load_from_ical(self):
ical_str = """BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Roundcube//Roundcube libcalendaring 1.1-git//Sabre//Sabre VObject
2.1.3//EN
CALSCALE:GREGORIAN
METHOD:REQUEST
""" + ical_event + ical_exception + "END:VCALENDAR"
ical = icalendar.Calendar.from_ical(ical_str)
event = event_from_ical(ical.walk('VEVENT')[0], ical_str)
self.assertEqual(event.get_location(), "Location")
self.assertEqual(str(event.get_lastmodified()), "2014-04-07 12:23:11+00:00")
self.assertEqual(event.get_description(), "Description\n2 lines")
self.assertEqual(event.get_url(), "http://somelink.com/foo")
self.assertEqual(event.get_transparency(), False)
self.assertEqual(event.get_categories(), ["Personal"])
self.assertEqual(event.get_priority(), '2')
self.assertEqual(event.get_classification(), kolabformat.ClassPublic)
self.assertEqual(event.get_attendee_by_email("max@imum.com").get_cutype(), kolabformat.CutypeResource)
self.assertEqual(event.get_sequence(), 2)
self.assertTrue(event.is_recurring())
self.assertIsInstance(event.get_duration(), datetime.timedelta)
self.assertIsInstance(event.get_end(), datetime.datetime)
self.assertEqual(str(event.get_end()), "2014-05-23 12:30:00+02:00")
self.assertEqual(len(event.get_exception_dates()), 2)
self.assertIsInstance(event.get_exception_dates()[0], datetime.datetime)
self.assertEqual(len(event.get_alarms()), 1)
self.assertEqual(len(event.get_attachments()), 2)
self.assertEqual(len(event.get_exceptions()), 1)
exception = event.get_exceptions()[0]
self.assertIsInstance(exception.get_recurrence_id(), datetime.datetime)
# self.assertEqual(exception.thisandfuture, True)
self.assertEqual(str(exception.get_start()), "2014-06-07 12:00:00+02:00")
def test_018_ical_to_message(self):
event = event_from_ical(ical_event)
message = event.to_message()
self.assertTrue(message.is_multipart())
self.assertEqual(message['Subject'], event.uid)
self.assertEqual(message['X-Kolab-Type'], 'application/x-vnd.kolab.event')
parts = [p for p in message.walk()]
attachments = event.get_attachments();
self.assertEqual(len(parts), 5)
self.assertEqual(parts[1].get_content_type(), 'text/plain')
self.assertEqual(parts[2].get_content_type(), 'application/calendar+xml')
self.assertEqual(parts[3].get_content_type(), 'image/png')
self.assertEqual(parts[4].get_content_type(), 'text/plain')
self.assertEqual(parts[2]['Content-ID'], None)
self.assertEqual(parts[3]['Content-ID'].strip('<>'), attachments[0].uri()[4:])
self.assertEqual(parts[4]['Content-ID'].strip('<>'), attachments[1].uri()[4:])
def test_018_ical_allday_events(self):
ical = """BEGIN:VEVENT
UID:ffffffff-f783-4b58-b404-b1389bd2ffff
DTSTAMP;VALUE=DATE-TIME:20140407T122311Z
CREATED;VALUE=DATE-TIME:20140407T122245Z
DTSTART;VALUE=DATE:20140823
DTEND;VALUE=DATE:20140824
SUMMARY:All day
DESCRIPTION:One single day
TRANSP:OPAQUE
CLASS:PUBLIC
END:VEVENT
"""
event = event_from_ical(ical)
self.assertEqual(str(event.get_start()), "2014-08-23")
self.assertEqual(str(event.get_end()), "2014-08-23")
self.assertEqual(str(event.get_ical_dtend()), "2014-08-24")
self.assertTrue(re.match('.*<dtend>\s*<date>2014-08-23</date>', str(event), re.DOTALL))
def test_019_as_string_itip(self):
self.event.set_summary("test")
self.event.set_start(datetime.datetime(2014, 05, 23, 11, 00, 00, tzinfo=pytz.timezone("Europe/London")))
self.event.set_end(datetime.datetime(2014, 05, 23, 12, 30, 00, tzinfo=pytz.timezone("Europe/London")))
self.event.set_sequence(3)
self.event.set_classification('CONFIDENTIAL')
self.event.add_custom_property('X-Custom', 'check')
self.event.set_recurrence_id(datetime.datetime(2014, 05, 23, 11, 0, 0), True)
rrule = RecurrenceRule()
rrule.set_frequency(kolabformat.RecurrenceRule.Weekly)
rrule.set_byday(['2WE','-1SU'])
rrule.setBymonth([2])
rrule.set_count(10)
rrule.set_until(datetime.datetime(2014,7,23, 11,0,0, tzinfo=pytz.utc))
self.event.set_recurrence(rrule);
ical = icalendar.Calendar.from_ical(self.event.as_string_itip())
event = ical.walk('VEVENT')[0]
self.assertEqual(event['uid'], self.event.get_uid())
self.assertEqual(event['summary'], "test")
self.assertEqual(event['sequence'], 3)
self.assertEqual(event['X-CUSTOM'], "check")
self.assertIsInstance(event['dtstamp'].dt, datetime.datetime)
self.assertEqual(event['class'], "CONFIDENTIAL")
self.assertIsInstance(event['recurrence-id'].dt, datetime.datetime)
self.assertEqual(event['recurrence-id'].params.get('RANGE'), 'THISANDFUTURE')
self.assertTrue(event.has_key('rrule'))
self.assertEqual(event['rrule']['FREQ'][0], 'WEEKLY')
self.assertEqual(event['rrule']['INTERVAL'][0], 1)
self.assertEqual(event['rrule']['COUNT'][0], 10)
self.assertEqual(event['rrule']['BYMONTH'][0], 2)
self.assertEqual(event['rrule']['BYDAY'], ['2WE','-1SU'])
self.assertIsInstance(event['rrule']['UNTIL'][0], datetime.datetime)
def test_019_to_message_itip(self):
self.event = Event()
self.event.set_summary("test")
self.event.set_start(datetime.datetime(2014, 05, 23, 11, 00, 00, tzinfo=pytz.timezone("Europe/London")))
self.event.set_end(datetime.datetime(2014, 05, 23, 12, 30, 00, tzinfo=pytz.timezone("Europe/London")))
self.event.set_organizer("me@kolab.org")
self.event.add_attendee("john@doe.org")
self.event.add_attendee("jane@doe.org")
message = self.event.to_message_itip("john@doe.org", method="REPLY", participant_status="ACCEPTED")
itip_event = None
for part in message.walk():
if part.get_content_type() == "text/calendar":
ical = icalendar.Calendar.from_ical(part.get_payload(decode=True))
itip_event = ical.walk('VEVENT')[0]
break
self.assertEqual(itip_event['uid'], self.event.get_uid())
self.assertEqual(itip_event['attendee'].lower(), 'mailto:john@doe.org')
# delegate jane => jack
self.event.delegate("jane@doe.org", "jack@ripper.com", "Jack")
message = self.event.to_message_itip("jane@doe.org", method="REPLY", participant_status="DELEGATED")
itip_event = None
for part in message.walk():
if part.get_content_type() == "text/calendar":
ical = icalendar.Calendar.from_ical(part.get_payload(decode=True))
itip_event = ical.walk('VEVENT')[0]
break
self.assertEqual(len(itip_event['attendee']), 2)
self.assertEqual(str(itip_event['attendee'][0]).lower(), 'mailto:jane@doe.org')
self.assertEqual(str(itip_event['attendee'][1]).lower(), 'mailto:jack@ripper.com')
self.assertEqual(itip_event['attendee'][0].params['delegated-to'], 'jack@ripper.com')
self.assertEqual(itip_event['attendee'][1].params['delegated-from'], 'jane@doe.org')
def test_020_calendaring_recurrence(self):
rrule = kolabformat.RecurrenceRule()
rrule.setFrequency(kolabformat.RecurrenceRule.Monthly)
rrule.setCount(10)
self.event = Event()
self.event.set_recurrence(rrule);
_start = datetime.datetime(2014, 5, 1, 11, 30, 00, tzinfo=pytz.timezone("Europe/London"))
self.event.set_start(_start)
self.event.set_end(_start + datetime.timedelta(hours=2))
self.assertTrue(self.event.is_recurring())
next_date = self.event.get_next_occurence(_start)
self.assertIsInstance(next_date, datetime.datetime)
self.assertEqual(next_date.month, 6)
self.assertEqual(next_date.day, 1)
end_date = self.event.get_occurence_end_date(next_date)
self.assertIsInstance(end_date, datetime.datetime)
self.assertEqual(end_date.month, 6)
self.assertEqual(end_date.hour, 13)
self.assertEqual(self.event.get_next_occurence(next_date).month, 7)
last_date = self.event.get_last_occurrence()
self.assertIsInstance(last_date, datetime.datetime)
self.assertEqual(last_date.year, 2015)
self.assertEqual(last_date.month, 2)
self.assertEqual(self.event.get_next_occurence(last_date), None)
# check infinite recurrence
rrule = kolabformat.RecurrenceRule()
rrule.setFrequency(kolabformat.RecurrenceRule.Monthly)
self.event.set_recurrence(rrule);
self.assertEqual(self.event.get_last_occurrence(), None)
self.assertIsInstance(self.event.get_last_occurrence(force=True), datetime.datetime)
# check get_next_instance() which returns a clone of the base event
next_instance = self.event.get_next_instance(next_date)
self.assertIsInstance(next_instance, Event)
self.assertIsInstance(next_instance.get_recurrence_id(), datetime.datetime)
self.assertEqual(self.event.get_summary(), next_instance.get_summary())
self.assertEqual(next_instance.get_start().month, 7)
self.assertFalse(next_instance.is_recurring())
# check get_next_occurence() with an infinitely recurring all-day event
rrule = kolabformat.RecurrenceRule()
rrule.setFrequency(kolabformat.RecurrenceRule.Yearly)
self.event.set_recurrence(rrule);
self.event.set_start(datetime.date(2014, 5, 1))
self.event.set_end(datetime.date(2014, 5, 1))
next_date = self.event.get_next_occurence(datetime.date(2015, 1, 1))
self.assertIsInstance(next_date, datetime.date)
self.assertEqual(next_date.year, 2015)
self.assertEqual(next_date.month, 5)
def test_021_calendaring_no_recurrence(self):
_start = datetime.datetime(2014, 2, 1, 14, 30, 00, tzinfo=pytz.timezone("Europe/London"))
self.event = Event()
self.event.set_start(_start)
self.event.set_end(_start + datetime.timedelta(hours=2))
self.assertEqual(self.event.get_next_occurence(_start), None)
self.assertEqual(self.event.get_last_occurrence(), None)
def test_021_add_exceptions(self):
event = event_from_ical(ical_event)
exception = event_from_ical(ical_exception)
self.assertIsInstance(event, Event)
self.assertIsInstance(exception, Event)
event.add_exception(exception)
self.assertEquals(len(event.get_exceptions()), 1)
# second call shall replace the existing exception
event.add_exception(exception)
self.assertEquals(len(event.get_exceptions()), 1)
# first real occurrence should be our exception
occurrence = event.get_next_instance(event.get_start())
self.assertEqual(occurrence.get_summary(), "Exception")
def test_021_allday_recurrence(self):
rrule = kolabformat.RecurrenceRule()
rrule.setFrequency(kolabformat.RecurrenceRule.Daily)
rrule.setCount(10)
self.event = Event()
self.event.set_summary('alldays')
self.event.set_recurrence(rrule);
_start = datetime.date(2015,1,1)
self.event.set_start(_start)
self.event.set_end(_start)
exdate = datetime.date(2015,1,5)
xmlexception = Event(from_string=str(self.event))
xmlexception.set_start(exdate)
xmlexception.set_end(exdate)
xmlexception.set_recurrence_id(exdate, False)
xmlexception.set_status('CANCELLED')
self.event.add_exception(xmlexception)
inst3 = self.event.get_instance(datetime.date(2015,1,3))
self.assertEqual(inst3.get_start(), datetime.date(2015,1,3))
inst5 = self.event.get_instance(exdate)
self.assertEqual(inst5.get_status(True), 'CANCELLED')
def test_021_ical_exceptions(self):
self.event.set_summary("test")
self.event.set_start(datetime.datetime(2014, 05, 23, 11, 00, 00, tzinfo=pytz.timezone("Europe/London")))
self.event.set_end(datetime.datetime(2014, 05, 23, 12, 30, 00, tzinfo=pytz.timezone("Europe/London")))
rrule = kolabformat.RecurrenceRule()
rrule.setFrequency(kolabformat.RecurrenceRule.Weekly)
self.event.set_recurrence(rrule)
xmlexception = Event(from_string=str(self.event))
xmlexception.set_start(datetime.datetime(2014, 05, 30, 14, 00, 00, tzinfo=pytz.timezone("Europe/London")))
xmlexception.set_end(datetime.datetime(2014, 05, 30, 16, 00, 00, tzinfo=pytz.timezone("Europe/London")))
xmlexception.set_recurrence_id(datetime.datetime(2014, 05, 30, 11, 0, 0), False)
self.event.add_exception(xmlexception)
ical = icalendar.Calendar.from_ical(self.event.as_string_itip())
vevents = ical.walk('VEVENT')
event = vevents[0]
exception = vevents[1]
self.assertEqual(event['uid'], self.event.get_uid())
self.assertEqual(event['summary'], "test")
self.assertEqual(exception['uid'], self.event.get_uid())
self.assertIsInstance(exception['recurrence-id'].dt, datetime.datetime)
self.assertEqual(exception['recurrence-id'].params.get('RANGE'), None)
def test_021_single_instances(self):
self.event = Event()
self.event.set_summary('singles')
_start = datetime.datetime(2015,3,1, 14,0,0, tzinfo=pytz.timezone("Europe/London"))
self.event.set_start(_start)
self.event.set_end(_start + datetime.timedelta(hours=1))
self.event.set_recurrence_id(_start)
_start2 = datetime.datetime(2015,3,5, 15,0,0, tzinfo=pytz.timezone("Europe/London"))
xmlexception = Event(from_string=str(self.event))
xmlexception.set_start(_start2)
xmlexception.set_end(_start2 + datetime.timedelta(hours=1))
xmlexception.set_summary('singles #2')
xmlexception.set_recurrence_id(_start2)
self.event.add_exception(xmlexception)
self.assertEqual(self.event.has_exceptions(), True)
first = self.event.get_instance(_start)
self.assertIsInstance(first, Event)
self.assertEqual(first.get_summary(), "singles")
second = self.event.get_instance(_start2)
self.assertIsInstance(second, Event)
self.assertEqual(second.get_summary(), "singles #2")
# update main instance
first.set_status('CANCELLED')
first.set_summary("singles #1")
self.event.add_exception(first)
event = event_from_string(str(self.event))
self.assertEqual(self.event.has_exceptions(), True)
self.assertEqual(event.get_status(True), 'CANCELLED')
self.assertEqual(event.get_summary(), "singles #1")
def test_022_load_from_xml(self):
event = event_from_string(xml_event)
self.assertEqual(event.uid, '75c740bb-b3c6-442c-8021-ecbaeb0a025e')
self.assertEqual(event.get_attendee_by_email("jane@example.org").get_participant_status(), kolabformat.PartAccepted)
self.assertEqual(len(event.get_attendee_by_email("jane@example.org").get_delegated_from()), 1)
self.assertEqual(len(event.get_attendee_by_email("somebody@else.com").get_delegated_to()), 1)
self.assertEqual(event.get_sequence(), 1)
self.assertIsInstance(event.get_start(), datetime.datetime)
self.assertEqual(str(event.get_start()), "2014-08-13 10:00:00+01:00")
self.assertTrue(event.is_recurring())
exceptions = event.get_exceptions()
self.assertEqual(len(exceptions), 1)
exception = exceptions[0]
self.assertIsInstance(exception.get_recurrence_id(), datetime.datetime)
self.assertTrue(exception.thisandfuture)
self.assertEqual(str(exception.get_start()), "2014-08-16 13:00:00+01:00")
self.assertEqual(exception.get_attendee_by_email("jane@example.org").get_participant_status(), kolabformat.PartDeclined)
self.assertRaises(ValueError, exception.get_attendee, "somebody@else.com")
# get instances with exception data
occurrence = event.get_next_instance(exception.get_start() - datetime.timedelta(days=1))
self.assertEqual(occurrence.get_start(), exception.get_start())
self.assertEqual(occurrence.get_summary(), "exception")
# find instance directly by date
_recurrence_id = datetime.datetime(2014, 8, 15, 10, 0, 0)
occurrence = event.get_instance(_recurrence_id)
self.assertIsInstance(occurrence, Event)
self.assertEqual(str(occurrence.get_recurrence_id()), "2014-08-15 10:00:00+01:00")
+ # set invalid date-only recurrence-id
+ exception.set_recurrence_id(datetime.date(2014,8,16))
+ event.add_exception(exception)
+
+ inst = event.get_next_instance(_recurrence_id);
+ self.assertIsInstance(inst, Event)
+ self.assertIsInstance(inst.get_recurrence_id(), datetime.datetime)
+
def test_023_load_from_message(self):
event = event_from_message(event_from_ical(ical_event).to_message())
event.set_sequence(3)
message = event.to_message()
self.assertTrue(message.is_multipart())
# check attachment MIME parts are kept
parts = [p for p in message.walk()]
attachments = event.get_attachments();
self.assertEqual(len(parts), 5)
self.assertEqual(parts[3].get_content_type(), 'image/png')
self.assertEqual(parts[3]['Content-ID'].strip('<>'), attachments[0].uri()[4:])
self.assertEqual(parts[4].get_content_type(), 'text/plain')
self.assertEqual(parts[4]['Content-ID'].strip('<>'), attachments[1].uri()[4:])
self.assertEqual(event.get_attachment_data(1), 'This is a text file')
def test_024_bogus_itip_data(self):
# DTSTAMP contains an invalid date/time value
vevent = """BEGIN:VEVENT
UID:626421779C777FBE9C9B85A80D04DDFA-A4BF5BBB9FEAA271
DTSTAMP:20120713T1254140
DTSTART;TZID=Europe/London:20120713T100000
DTEND;TZID=Europe/London:20120713T110000
SUMMARY:test
DESCRIPTION:test
ORGANIZER;CN="Doe, John":mailto:john.doe@example.org
ATTENDEE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;RSVP=TRUE:mailt
o:jane.doe@example.org
ATTENDEE;ROLE=OPT-PARTICIPANT;PARTSTAT=NEEDS-ACTION;RSVP=TRUE:mailt
o:user.external@example.com
SEQUENCE:1
TRANSP:OPAQUE
END:VEVENT
"""
event = event_from_ical(vevent)
self.assertRaises(EventIntegrityError, event.to_message)
def test_025_to_dict(self):
data = event_from_string(xml_event).to_dict()
self.assertIsInstance(data, dict)
self.assertIsInstance(data['start'], datetime.datetime)
self.assertIsInstance(data['end'], datetime.datetime)
self.assertIsInstance(data['created'], datetime.datetime)
self.assertIsInstance(data['lastmodified-date'], datetime.datetime)
self.assertEqual(data['uid'], '75c740bb-b3c6-442c-8021-ecbaeb0a025e')
self.assertEqual(data['summary'], 'test')
self.assertEqual(data['location'], 'Room 101')
self.assertEqual(data['description'], 'test')
self.assertEqual(data['priority'], 5)
self.assertEqual(data['status'], 'CANCELLED')
self.assertEqual(data['sequence'], 1)
self.assertEqual(data['transparency'], False)
self.assertEqual(data['X-GWSHOW-AS'], 'BUSY')
self.assertIsInstance(data['organizer'], dict)
self.assertEqual(data['organizer']['email'], 'john@example.org')
self.assertEqual(len(data['attendee']), 2)
self.assertIsInstance(data['attendee'][0], dict)
self.assertEqual(len(data['attach']), 1)
self.assertIsInstance(data['attach'][0], dict)
self.assertEqual(data['attach'][0]['fmttype'], 'text/html')
self.assertIsInstance(data['rrule'], dict)
self.assertEqual(data['rrule']['freq'], 'DAILY')
self.assertEqual(data['rrule']['interval'], 1)
self.assertEqual(data['rrule']['wkst'], 'MO')
self.assertIsInstance(data['rrule']['until'], datetime.date)
self.assertIsInstance(data['alarm'], list)
self.assertEqual(len(data['alarm']), 2)
self.assertEqual(data['alarm'][0]['action'], 'DISPLAY')
self.assertEqual(data['alarm'][1]['action'], 'EMAIL')
self.assertEqual(data['alarm'][1]['trigger']['value'], '-P1D')
self.assertEqual(len(data['alarm'][1]['attendee']), 1)
def test_026_compute_diff(self):
e1 = event_from_string(xml_event)
e2 = event_from_string(xml_event)
e2.set_summary("test2")
e2.set_end(e1.get_end() + datetime.timedelta(hours=2))
e2.set_sequence(e1.get_sequence() + 1)
e2.set_attendee_participant_status("jane@example.org", "DECLINED")
e2.set_lastmodified()
diff = compute_diff(e1.to_dict(), e2.to_dict(), True)
self.assertEqual(len(diff), 5)
ps = self._find_prop_in_list(diff, 'summary')
self.assertIsInstance(ps, OrderedDict)
self.assertEqual(ps['new'], "test2")
pa = self._find_prop_in_list(diff, 'attendee')
self.assertIsInstance(pa, OrderedDict)
self.assertEqual(pa['index'], 0)
self.assertEqual(pa['new'], dict(partstat='DECLINED'))
def test_026_property_to_string(self):
data = event_from_string(xml_event).to_dict()
self.assertEqual(property_to_string('sequence', data['sequence']), "1")
self.assertEqual(property_to_string('start', data['start']), "2014-08-13 10:00 (BST)")
self.assertEqual(property_to_string('organizer', data['organizer']), "Doe, John")
self.assertEqual(property_to_string('attendee', data['attendee'][0]), "jane@example.org, Accepted")
self.assertEqual(property_to_string('rrule', data['rrule']), "Every 1 day(s) until 2015-07-25")
self.assertEqual(property_to_string('exdate', data['exdate'][0]), "2014-07-19")
self.assertEqual(property_to_string('alarm', data['alarm'][0]), "Display message 2 hour(s) before")
self.assertEqual(property_to_string('attach', data['attach'][0]), "noname.1395223627.5555")
def test_027_merge_attendee_data(self):
event = event_from_string(xml_event)
jane = event.get_attendee("jane@example.org")
jane.set_participant_status('TENTATIVE')
jack = Attendee("jack@example.org", name="Jack", role='OPT-PARTICIPANT')
some = event.set_attendee_participant_status("somebody@else.com", 'ACCEPTED')
# update jane + add jack
event.update_attendees([jane,jack])
self.assertEqual(len(event.get_attendees()), 3)
self.assertEqual(event.get_attendee("jane@example.org").get_participant_status(), kolabformat.PartTentative)
self.assertEqual(event.get_attendee("somebody@else.com").get_participant_status(), kolabformat.PartAccepted)
# test write + read
event = event_from_string(str(event))
exception = event.get_exceptions()[0]
self.assertEqual(len(exception.get_attendees()), 2)
self.assertEqual(event.get_attendee("jane@example.org").get_participant_status(), kolabformat.PartTentative)
self.assertEqual(event.get_attendee("jack@example.org").get_name(), "Jack")
self.assertRaises(ValueError, exception.get_attendee, "somebody@else.com") # not addded to exception
def _find_prop_in_list(self, diff, name):
for prop in diff:
if prop['property'] == name:
return prop
return None
if __name__ == '__main__':
unittest.main()

File Metadata

Mime Type
text/x-diff
Expires
Fri, Apr 24, 11:06 AM (1 w, 4 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
18866017
Default Alt Text
(92 KB)

Event Timeline