fix: fix tz handling in ics files (#4630)

* fix: render upcoming.ics timestamps correctly

Both correctly display timestamps in the claimed time zones and format
the date-times in correct iCalendar format.

* refactor: also render DTSTAMP using ics_date_time tag

* fix: render valid date-times in agenda.ics

* fix: render valid date-time in important_dates_for_meeting.ics

Only touching the DTSTAMP here. The DTSTART has VALUE=DATE so the tag
does not handle it.

* test: test ics_date_time tag
This commit is contained in:
Jennifer Richards 2022-10-24 12:54:52 -03:00 committed by GitHub
parent 000e8431c2
commit a331fb6d2a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 40 additions and 10 deletions

View file

@ -502,6 +502,36 @@ def ics_esc(text):
text = re.sub(r"([\n,;\\])", r"\\\1", text)
return text
@register.simple_tag
def ics_date_time(dt, tzname):
"""Render a datetime as an iCalendar date-time
dt a datetime, localized to the timezone to be displayed
tzname is the name for this timezone
Caller must arrange for a VTIMEZONE for the tzname to be included in the iCalendar file.
Output includes a ':'. Use like:
DTSTART{% ics_date_time timestamp 'America/Los_Angeles' %}
to get
DTSTART;TZID=America/Los_Angeles:20221021T111200
>>> ics_date_time(datetime.datetime(2022,1,2,3,4,5), 'utc')
':20220102T030405Z'
>>> ics_date_time(datetime.datetime(2022,1,2,3,4,5), 'UTC')
':20220102T030405Z'
>>> ics_date_time(datetime.datetime(2022,1,2,3,4,5), 'America/Los_Angeles')
';TZID=America/Los_Angeles:20220102T030405'
"""
timestamp = dt.strftime('%Y%m%dT%H%M%S')
if tzname.lower() == 'utc':
return f':{timestamp}Z'
else:
return f';TZID={ics_esc(tzname)}:{timestamp}'
@register.filter
def consensus(doc):
"""Returns document consensus Yes/No/Unknown."""

View file

@ -8,9 +8,9 @@ SUMMARY:{% if item.session.name %}{{item.session.name|ics_esc}}{% else %}{% if n
{% if item.timeslot.show_location %}LOCATION:{{item.timeslot.get_location}}
{% endif %}STATUS:{{item.session.ical_status}}
CLASS:PUBLIC
DTSTART;TZID={{schedule.meeting.time_zone|ics_esc}}:{{ item.timeslot.time|date:"Ymd" }}T{{item.timeslot.time|date:"Hi"}}00
DTEND;TZID={{schedule.meeting.time_zone|ics_esc}}:{{ item.timeslot.end_time|date:"Ymd" }}T{{item.timeslot.end_time|date:"Hi"}}00
DTSTAMP:{{ item.timeslot.modified|date:"Ymd" }}T{{ item.timeslot.modified|date:"His" }}Z{% if item.session.agenda %}
DTSTART{% ics_date_time item.timeslot.local_start_time schedule.meeting.time_zone %}
DTEND{% ics_date_time item.timeslot.local_end_time schedule.meeting.time_zone %}
DTSTAMP:{% ics_date_time item.timeslot.modified|utc 'utc' %}{% if item.session.agenda %}
URL:{{item.session.agenda.get_versionless_href}}{% endif %}
DESCRIPTION:{{item.timeslot.name|ics_esc}}\n{% if item.session.agenda_note %}
Note: {{item.session.agenda_note|ics_esc}}\n{% endif %}{% if item.timeslot.location.webex_url %}

View file

@ -1,9 +1,9 @@
{% load tz %}{% for d in meeting.important_dates %}BEGIN:VEVENT
{% load tz ietf_filters %}{% for d in meeting.important_dates %}BEGIN:VEVENT
UID:ietf-{{ meeting.number }}-{{ d.name_id }}-{{ d.date.isoformat }}
SUMMARY:IETF {{ meeting.number }}: {{ d.name.name }}
CLASS:PUBLIC
DTSTART{% if not d.midnight_cutoff %};VALUE=DATE{% endif %}:{{ d.date|date:"Ymd" }}{% if d.midnight_cutoff %}235900Z{% endif %}
DTSTAMP:{{ meeting.cached_updated|utc|date:"Ymd" }}T{{ meeting.cached_updated|utc|date:"His" }}Z
DTSTAMP{% ics_date_time meeting.cached_updated|utc 'utc' %}
TRANSP:TRANSPARENT
DESCRIPTION:{{ d.name.desc }}{% if first and d.name.slug == 'openreg' or first and d.name.slug == 'earlybird' %}\n
Register here: https://www.ietf.org/how/meetings/register/{% endif %}{% if d.name.slug == 'opensched' %}\n

View file

@ -1,4 +1,4 @@
{% load humanize %}{% autoescape off %}{% load ietf_filters %}BEGIN:VCALENDAR
{% load humanize tz %}{% autoescape off %}{% load ietf_filters %}BEGIN:VCALENDAR
VERSION:2.0
METHOD:PUBLISH
PRODID:-//IETF//datatracker.ietf.org ical upcoming//EN
@ -8,9 +8,9 @@ SUMMARY:{% if item.session.name %}{{item.session.group.acronym|lower}} - {{item.
{% if item.schedule.meeting.city %}LOCATION:{{item.schedule.meeting.city}},{{item.schedule.meeting.country}}
{% endif %}STATUS:{{item.session.ical_status}}
CLASS:PUBLIC
DTSTART{% if item.schedule.meeting.time_zone %};TZID={{ item.schedule.meeting.time_zone|ics_esc }}{%endif%}:{{ item.timeslot.time|date:"Ymd" }}T{{item.timeslot.time|date:"Hi"}}00
DTEND{% if item.schedule.meeting.time_zone %};TZID={{ item.schedule.meeting.time_zone|ics_esc }}{%endif%}:{{ item.timeslot.end_time|date:"Ymd" }}T{{item.timeslot.end_time|date:"Hi"}}00
DTSTAMP:{{ item.timeslot.modified|date:"Ymd" }}T{{ item.timeslot.modified|date:"His" }}Z
DTSTART{% ics_date_time item.timeslot.local_start_time item.schedule.meeting.time_zone %}
DTEND{% ics_date_time item.timeslot.local_end_time item.schedule.meeting.time_zone %}
DTSTAMP:{% ics_date_time item.timeslot.modified|utc 'utc' %}
{% if item.session.agenda %}URL:{{item.session.agenda.get_href}}
DESCRIPTION:{{item.timeslot.name|ics_esc}}\n{% if item.session.agenda_note %}
Note: {{item.session.agenda_note|ics_esc}}\n{% endif %}{% for material in item.session.materials.all %}
@ -25,7 +25,7 @@ LOCATION:{{ meeting.city }},{{ meeting.country }}{% endif %}
CLASS:PUBLIC
DTSTART;VALUE=DATE{% if meeting.time_zone %};TZID={{ meeting.time_zone|ics_esc }}{% endif %}:{{ meeting.date|date:"Ymd" }}
DTEND;VALUE=DATE{% if meeting.time_zone %};TZID={{ meeting.time_zone|ics_esc }}{% endif %}:{{ meeting.end_date|date:"Ymd" }}
DTSTAMP:{{ meeting.cached_updated|date:"Ymd" }}T{{ meeting.cached_updated|date:"His" }}Z
DTSTAMP{% ics_date_time meeting.cached_updated|utc 'utc' %}
URL:{{ request.scheme }}://{{ request.get_host }}{% url 'agenda' num=meeting.number %}
END:VEVENT
{% endfor %}END:VCALENDAR{% endautoescape %}