event.py
No OneTemporary
Actions

Authored By

Unknown

Size

28 KB

Referenced Files

None

Subscribers

None

event.py
View Options

	import datetime
	import icalendar
	from icalendar import vDatetime
	from icalendar import vText
	import kolabformat
	import pytz
	import time
	import uuid

	import pykolab
	from pykolab import constants
	from pykolab import utils
	from pykolab.translate import _

	from attendee import Attendee
	from contact_reference import ContactReference

	log = pykolab.getLogger('pykolab.xml_event')

	def event_from_ical(string):
	return Event(from_ical=string)

	def event_from_string(string):
	return Event(from_string=string)

	class Event(object):
	status_map = {
	"TENTATIVE": kolabformat.StatusTentative,
	"CONFIRMED": kolabformat.StatusConfirmed,
	"CANCELLED": kolabformat.StatusCancelled,
	}

	def __init__(self, from_ical="", from_string=""):
	self._attendees = []

	if from_ical == "":
	if from_string == "":
	self.event = kolabformat.Event()
	else:
	self.event = kolabformat.readEvent(from_string, False)
	else:
	self.from_ical(from_ical)

	self.uid = self.get_uid()

	def add_attendee(self, email, name=None, rsvp=False, role=None, participant_status=None, cutype="INDIVIDUAL"):
	attendee = Attendee(email, name, rsvp, role, participant_status)
	self._attendees.append(attendee)
	self.event.setAttendees(self._attendees)

	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.

	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)):
	if hasattr(self, 'get_ical_%s' % (attr.lower())):
	exec("retval = self.get_ical_%s()" % (attr.lower()))
	if not retval == None and not retval == "":
	event.add(attr.lower(), retval)

	elif hasattr(self, 'get_%s' % (attr.lower())):
	exec("retval = self.get_%s()" % (attr.lower()))
	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)):
	if hasattr(self, 'get_ical_%s' % (attr.lower())):
	exec("retval = self.get_ical_%s()" % (attr.lower()))
	if isinstance(retval, list) and not len(retval) == 0:
	for _retval in retval:
	event.add(attr.lower(), _retval, encode=0)

	elif hasattr(self, 'get_%s' % (attr.lower())):
	exec("retval = self.get_%s()" % (attr.lower()))
	if isinstance(retval, list) and not len(retval) == 0:
	for _retval in retval:
	event.add(attr.lower(), _retval, encode=0)

	cal.add_component(event)

	if hasattr(cal, 'to_ical'):
	return cal.to_ical()
	elif hasattr(cal, 'as_string'):
	return cal.as_string()

	def delegate(self, delegators, delegatees):
	if not isinstance(delegators, list):
	delegators = [delegators]

	if not isinstance(delegatees, list):
	delegatees = [delegatees]

	_delegators = []
	for delegator in delegators:
	_delegators.append(self.get_attendee(delegator))

	_delegatees = []

	for delegatee in 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)
	_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):
	self.event = kolabformat.Event()
	if 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)

	# 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 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 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_created(self):
	_datetime = self.event.created()

	(
	year,
	month,
	day,
	hour,
	minute,
	second
	) = (
	_datetime.year(),
	_datetime.month(),
	_datetime.day(),
	_datetime.hour(),
	_datetime.minute(),
	_datetime.second()
	)

	try:
	result = datetime.datetime(year, month, day, hour, minute, second)
	except ValueError:
	result = datetime.datetime.now()

	def get_end(self):
	_datetime = self.event.end()

	(
	year,
	month,
	day,
	) = (
	_datetime.year(),
	_datetime.month(),
	_datetime.day(),
	)

	if not _datetime.hour() == None and not _datetime.hour() < 0:
	(
	hour,
	minute,
	second
	) = (
	_datetime.hour(),
	_datetime.minute(),
	_datetime.second()
	)

	_timezone = _datetime.timezone()

	if _timezone == '':
	_timezone = pytz.utc
	elif _timezone == None:
	_timezone = pytz.utc
	else:
	_timezone = pytz.timezone(_timezone)

	if _datetime.hour() == None or _datetime.hour() < 0:
	return datetime.date(year, month, day)
	else:
	return datetime.datetime(year, month, day, hour, minute, second, tzinfo=_timezone)

	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):
	return self.get_end()

	def get_ical_dtstamp(self):
	return
	try:
	retval = self.event.lastModified()
	if retval == None or retval == "":
	return datetime.datetime.now()
	except:
	return datetime.datetime.now()

	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

	if status in self.status_map.values():
	return [k for k, v in self.status_map.iteritems() if v == status][0]

	def get_lastmodified(self):
	try:
	_datetime = self.event.lastModified()
	if retval == None or retval == "":
	self.__str__()
	except:
	self.__str__()

	_datetime = self.event.lastModified()

	(
	year,
	month,
	day,
	hour,
	minute,
	second
	) = (
	_datetime.year(),
	_datetime.month(),
	_datetime.day(),
	_datetime.hour(),
	_datetime.minute(),
	_datetime.second()
	)

	return datetime.datetime(year, month, day, hour, minute, second)

	def get_organizer(self):
	organizer = self.event.organizer()
	return organizer

	def get_priority(self):
	return self.event.priority()

	def get_start(self):
	_datetime = self.event.start()

	(
	year,
	month,
	day,
	) = (
	_datetime.year(),
	_datetime.month(),
	_datetime.day(),
	)

	if not _datetime.hour() == None and not _datetime.hour() < 0:
	(
	hour,
	minute,
	second
	) = (
	_datetime.hour(),
	_datetime.minute(),
	_datetime.second()
	)

	_timezone = _datetime.timezone()

	if _timezone == '':
	_timezone = pytz.utc
	elif _timezone == None:
	_timezone = pytz.utc
	else:
	_timezone = pytz.timezone(_timezone)

	if _datetime.hour() == None or _datetime.hour() < 0:
	return datetime.date(year, month, day)
	else:
	return datetime.datetime(year, month, day, hour, minute, second, tzinfo=_timezone)

	def get_status(self):
	status = self.event.status()
	for key in self.status_map.keys():
	if self.status_map[key] == status:
	return key

	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 set_attendee_participant_status(self, attendee, status):
	"""
	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)
	self.event.setAttendees(self._attendees)

	def set_created(self, _datetime=None):
	if _datetime == None:
	_datetime = datetime.datetime.now()

	(
	year,
	month,
	day,
	hour,
	minute,
	second
	) = (
	_datetime.year,
	_datetime.month,
	_datetime.day,
	_datetime.hour,
	_datetime.minute,
	_datetime.second
	)

	self.event.setCreated(
	kolabformat.cDateTime(year, month, day, hour, minute, second)
	)

	def set_dtstamp(self, _datetime):
	(
	year,
	month,
	day,
	hour,
	minute,
	second
	) = (
	_datetime.year,
	_datetime.month,
	_datetime.day,
	_datetime.hour,
	_datetime.minute,
	_datetime.second
	)

	self.event.setLastModified(
	kolabformat.cDateTime(year, month, day, hour, minute, second)
	)

	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")

	(
	year,
	month,
	day,
	) = (
	_datetime.year,
	_datetime.month,
	_datetime.day,
	)
	if hasattr(_datetime, 'hour'):
	(
	hour,
	minute,
	second
	) = (
	_datetime.hour,
	_datetime.minute,
	_datetime.second
	)
	_cdatetime = kolabformat.cDateTime(year, month, day, hour, minute, second)
	else:
	_cdatetime = kolabformat.cDateTime(year, month, day)

	if hasattr(_datetime, "tzinfo"):
	_cdatetime.setTimezone(_datetime.tzinfo.__str__())

	self.event.setEnd(_cdatetime)

	def set_from_ical(self, attr, value):
	if attr == "dtend":
	self.set_ical_dtend(value.dt)
	elif attr == "dtstart":
	self.set_ical_dtstart(value.dt)
	elif attr == "status":
	self.set_ical_status(value)
	elif attr == "summary":
	self.set_ical_summary(value)
	elif attr == "priority":
	self.set_ical_priority(value)
	elif attr == "attendee":
	self.set_ical_attendee(value)
	elif attr == "organizer":
	self.set_ical_organizer(value)
	elif attr == "uid":
	self.set_ical_uid(value)

	else:
	print "WARNING, no function for", attr

	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 = 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

	self.add_attendee(address, name=name, rsvp=rsvp, role=role, participant_status=partstat)

	def set_ical_dtend(self, dtend):
	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_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 = params['CN']

	self.set_organizer(str(address), name=cn)

	def set_ical_priority(self, priority):
	self.set_priority(priority)

	def set_ical_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)
	else:
	raise ValueError, _("Invalid status %r") % (status)

	def set_ical_summary(self, summary):
	self.set_summary(str(summary))

	def set_ical_uid(self, uid):
	self.set_uid(str(uid))

	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.now()

	if not valid_datetime:
	raise InvalidEventDateError, _("Event start needs datetime.date or datetime.datetime instance")

	(
	year,
	month,
	day,
	) = (
	_datetime.year,
	_datetime.month,
	_datetime.day,
	)
	if hasattr(_datetime, 'hour'):
	(
	hour,
	minute,
	second
	) = (
	_datetime.hour,
	_datetime.minute,
	_datetime.second
	)
	else:
	(hour, minute, second) = (0,0,0)

	self.event.setLastModified(kolabformat.cDateTime(year, month, day, hour, minute, second))

	def set_organizer(self, email, name=None):
	contactreference = ContactReference(email)
	if not name == None:
	contactreference.set_name(name)

	self.event.setOrganizer(contactreference)

	def set_priority(self, priority):
	self.event.setPriority(priority)

	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")

	(
	year,
	month,
	day,
	) = (
	_datetime.year,
	_datetime.month,
	_datetime.day,
	)
	if hasattr(_datetime, 'hour'):
	(
	hour,
	minute,
	second
	) = (
	_datetime.hour,
	_datetime.minute,
	_datetime.second
	)
	_cdatetime = kolabformat.cDateTime(year, month, day, hour, minute, second)
	else:
	_cdatetime = kolabformat.cDateTime(year, month, day)

	if hasattr(_datetime, "tzinfo"):
	_cdatetime.setTimezone(_datetime.tzinfo.__str__())

	self.event.setStart(_cdatetime)

	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)
	else:
	raise InvalidEventStatusError, _("Invalid status set: %r") % (status)

	def set_summary(self, summary):
	self.event.setSummary(summary)

	def set_uid(self, uid):
	self.event.setUid(str(uid))

	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_message(self):
	from email.MIMEMultipart import MIMEMultipart
	from email.MIMEBase import MIMEBase
	from email.MIMEText import MIMEText
	from email.Utils import COMMASPACE, formatdate
	from email import Encoders

	msg = MIMEMultipart()
	organizer = self.get_organizer()
	email = organizer.email()
	name = organizer.name()

	if 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-Type', 'application/x-vnd.kolab.event')

	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()

	part.set_payload(str(self))

	part.add_header('Content-Disposition', 'attachment; filename="kolab.xml"')
	part.replace_header('Content-Transfer-Encoding', '8bit')

	msg.attach(part)

	return msg

	def to_message_itip(self, from_address, method="REQUEST", participant_status="ACCEPTED"):
	from email.MIMEMultipart import MIMEMultipart
	from email.MIMEBase import MIMEBase
	from email.MIMEText import MIMEText
	from email.Utils import COMMASPACE, formatdate
	from email import Encoders

	msg = MIMEMultipart()

	msg_from = None

	if method == "REPLY":
	# TODO: Make user friendly name <email>
	msg['To'] = self.get_organizer().email()

	attendees = self.get_attendees()

	# TODO: 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)

	self._attendees = [attendee]
	self.event.setAttendees(self._attendees)

	name = attendee.get_name()
	email = attendee.get_email()

	if not name:
	msg_from = email
	else:
	msg_from = '"%s" <%s>' % (name, email)

	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.get_email()
	name = organizer.get_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'] = msg_from

	msg['Date'] = formatdate(localtime=True)

	# TODO: Should allow for localization
	text = utils.multiline_message("""
	This is a response to one of your event requests.
	""")

	msg.attach( MIMEText(text) )

	part = MIMEBase('text', "calendar")
	part.set_charset('UTF-8')

	# TODO: Should allow for localization
	msg["Subject"] = "Meeting Request %s" % (participant_status)

	part.set_payload(self.as_string_itip(method=method))

	part.add_header('Content-Disposition', 'attachment; filename="event.ics"')
	part.replace_header('Content-Transfer-Encoding', '8bit')

	msg.attach(part)

	return msg

	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)

File Metadata

Mime Type: text/x-script.python
Expires: Mon, Apr 6, 12:58 AM (5 d, 4 h ago)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 4f/03/d1ed0df7f6ee4aa2f6e583c36c30
Default Alt Text: event.py (28 KB)

event.pyNo OneTemporaryActions

event.pyView Options

File Metadata

Event Timeline

event.py
No OneTemporary
Actions

event.py
View Options