Speakr is a personal, self-hosted web application designed for transcribing audio recordings
Python
"""
Calendar/ICS file generation services.
"""
import json
import uuid
from datetime import datetime, timedelta
def generate_ics_content(event):
"""Generate ICS calendar file content for an event."""
import uuid
from datetime import datetime, timedelta
# Generate unique ID for the event
uid = f"{event.id}-{uuid.uuid4()}@speakr.app"
# Format dates in iCalendar format (YYYYMMDDTHHMMSS)
def format_ical_date(dt):
if dt:
return dt.strftime('%Y%m%dT%H%M%S')
return None
# Start building ICS content
lines = [
'BEGIN:VCALENDAR',
'VERSION:2.0',
'PRODID:-//Speakr//Event Export//EN',
'CALSCALE:GREGORIAN',
'METHOD:PUBLISH',
'BEGIN:VEVENT',
f'UID:{uid}',
f'DTSTAMP:{format_ical_date(datetime.utcnow())}Z', # UTC, as RFC 5545 requires
]
# Add event details
if event.start_datetime:
lines.append(f'DTSTART:{format_ical_date(event.start_datetime)}')
if event.end_datetime:
lines.append(f'DTEND:{format_ical_date(event.end_datetime)}')
elif event.start_datetime:
# If no end time, default to 1 hour after start
end_time = event.start_datetime + timedelta(hours=1)
lines.append(f'DTEND:{format_ical_date(end_time)}')
# Add title and description. Attendees without an address are listed in
# the description; ATTENDEE needs a real mailto: address.
lines.append(f'SUMMARY:{escape_ical_text(event.title)}')
people = event.attendee_list() if hasattr(event, 'attendee_list') else []
unaddressed = [p['name'] for p in people if p['name'] and not p['email']]
description = event.description or ''
if unaddressed:
description = (description + '\n\n' if description else '') + 'Attendees: ' + ', '.join(unaddressed)
if description:
lines.append(f'DESCRIPTION:{escape_ical_text(description)}')
# Add location if available
if event.location:
lines.append(f'LOCATION:{escape_ical_text(event.location)}')
for person in people:
if person['email']:
name = (person['name'] or person['email']).replace('"', "'")
lines.append(f'ATTENDEE;CN="{name}":mailto:{person["email"]}')
# Add reminder/alarm if specified
if event.reminder_minutes and event.reminder_minutes > 0:
lines.extend([
'BEGIN:VALARM',
'TRIGGER:-PT{}M'.format(event.reminder_minutes),
'ACTION:DISPLAY',
f'DESCRIPTION:Reminder: {escape_ical_text(event.title)}',
'END:VALARM'
])
# Close event and calendar
lines.extend([
'STATUS:CONFIRMED',
'TRANSP:OPAQUE',
'END:VEVENT',
'END:VCALENDAR'
])
return '\r\n'.join(fold_ical_line(line) for line in lines)
def fold_ical_line(line, limit=75):
"""Fold a content line at 75 octets (RFC 5545 section 3.1), never inside a
UTF-8 character; continuation lines start with one space."""
data = line.encode('utf-8')
if len(data) <= limit:
return line
parts, current, size = [], '', 0
for ch in line:
width = len(ch.encode('utf-8'))
room = limit if not parts else limit - 1
if size + width > room:
parts.append(current)
current, size = '', 0
current += ch
size += width
parts.append(current)
return '\r\n '.join(parts)
def escape_ical_text(text):
"""Escape special characters for iCalendar format."""
if not text:
return ''
# Escape special characters
text = str(text)
text = text.replace('\\', '\\\\')
text = text.replace(',', '\\,')
text = text.replace(';', '\\;')
text = text.replace('\r\n', '\n').replace('\r', '\n')
text = text.replace('\n', '\\n')
return text
def generate_combined_ics(events):
"""One calendar file with several events (web download and API v1).
Each VEVENT comes from generate_ics_content, so escaping, DTSTAMP and the
default one-hour end are the same in both downloads (#412).
"""
lines = ["BEGIN:VCALENDAR", "VERSION:2.0", "PRODID:-//Speakr//Event Export//EN",
"CALSCALE:GREGORIAN", "METHOD:PUBLISH"]
for event in events:
in_event = False
for line in generate_ics_content(event).replace("\r\n", "\n").split("\n"):
if line.startswith("BEGIN:VEVENT"):
in_event = True
if in_event:
lines.append(line)
if line.startswith("END:VEVENT"):
in_event = False
lines.append("END:VCALENDAR")
return "\r\n".join(lines)