"""
hCalendar: A microformat for serializing iCalendar data
(http://microformats.org/wiki/hcalendar)
Here is a sample event in an iCalendar:
BEGIN:VCALENDAR
PRODID:-//XYZproduct//EN
VERSION:2.0
BEGIN:VEVENT
URL:http://www.web2con.com/
DTSTART:20051005
DTEND:20051008
SUMMARY:Web 2.0 Conference
LOCATION:Argent Hotel\, San Francisco\, CA
END:VEVENT
END:VCALENDAR
and an equivalent event in hCalendar format with various elements optimized appropriately.
Web 2.0 Conference:
October 5-
7,
at the Argent Hotel, San Francisco, CA
"""
import six
from datetime import date, datetime, timedelta
from .base import CRLF, registerBehavior
from .icalendar import VCalendar2_0
class HCalendar(VCalendar2_0):
name = 'HCALENDAR'
@classmethod
def serialize(cls, obj, buf=None, lineLength=None, validate=True):
"""
Serialize iCalendar to HTML using the hCalendar microformat (http://microformats.org/wiki/hcalendar)
"""
outbuf = buf or six.StringIO()
level = 0 # holds current indentation level
tabwidth = 3
def indent():
return ' ' * level * tabwidth
def out(s):
outbuf.write(indent())
outbuf.write(s)
# not serializing optional vcalendar wrapper
vevents = obj.vevent_list
for event in vevents:
out('' + CRLF)
level += 1
# URL
url = event.getChildValue("url")
if url:
out('' + CRLF)
level += 1
# SUMMARY
summary = event.getChildValue("summary")
if summary:
out('' + summary + ':' + CRLF)
# DTSTART
dtstart = event.getChildValue("dtstart")
if dtstart:
if type(dtstart) == date:
timeformat = "%A, %B %e"
machine = "%Y%m%d"
elif type(dtstart) == datetime:
timeformat = "%A, %B %e, %H:%M"
machine = "%Y%m%dT%H%M%S%z"
#TODO: Handle non-datetime formats?
#TODO: Spec says we should handle when dtstart isn't included
out('{1!s}\r\n'
.format(dtstart.strftime(machine),
dtstart.strftime(timeformat)))
# DTEND
dtend = event.getChildValue("dtend")
if not dtend:
duration = event.getChildValue("duration")
if duration:
dtend = duration + dtstart
# TODO: If lacking dtend & duration?
if dtend:
human = dtend
# TODO: Human readable part could be smarter, excluding repeated data
if type(dtend) == date:
human = dtend - timedelta(days=1)
out('- {1!s}\r\n'
.format(dtend.strftime(machine),
human.strftime(timeformat)))
# LOCATION
location = event.getChildValue("location")
if location:
out('at ' + location + '' + CRLF)
description = event.getChildValue("description")
if description:
out('' + description + '
' + CRLF)
if url:
level -= 1
out('' + CRLF)
level -= 1
out('' + CRLF) # close vevent
return buf or outbuf.getvalue()
registerBehavior(HCalendar)