ical-filter

HTTP daemon that can parse any ical feed and represent it in a normalized fashion. Allows filtering based on iCalendar event summaries. Ideal if you have a iCalendar feed that you want tailor made to include in your favorite calendar application. I use it to create a personalized duty-call calendar, since I do not have access to the software that serves the original feed.

Note: currently any other alarms, todos, journals and freebusies are not propagated. If you need this please file an issue.

Note: all datetimes are normalized to UTC.

Setup

Build the binary and run with the following optional ENV variables:

RUST_LOG=info \
ICAL_FILTER_SOCKETADDR=127.0.0.1:8080 \
cargo run

Endpoints

All endpoints accept the following query parameters:

• url: source url for an ical feed.
• filter[] (optional): a filter of the format [!]condition:pattern to be applied on the summary (title) field. Including a ! at the start of the filter will invert it. All filters must match for an event to be included.

Supported conditions:

• equals -- summary equals pattern (the behaviour of previous versions)
• startsWith -- summary starts with pattern
• endsWith -- summary ends with pattern
• contains -- summary contains pattern
• regex -- summary matches the given regex

Example filters:

• true: -- matches everything. equivalent to not including a filter
• !regex:this:can:have:colons.* -- rejects events starting with this:can:have:colons
• contains:aaa~!true: -- rejects all events due to the inverted true condition

JSON

Retrieve the url and render as JSON with Content-Type: application/json.

http://localhost:8080/v1/json

Will retrieve similar to:

[
    {
        "uid": "TU586226199",
        "summary": "Duty call",
        "stamp": "2020-07-03T08:55:14Z",
        "created": "2020-01-20T16:17:34Z",
        "start": "2020-01-25T08:00:00Z",
        "end": "2020-01-26T08:00:00Z"
    },
    {
        "uid": "TU597147530",
        "summary": "Duty call",
        "stamp": "2020-07-03T08:55:14Z",
        "created": "2020-01-28T07:45:28Z",
        "start": "2020-02-02T08:00:00Z",
        "end": "2020-02-03T08:00:00Z"
    }
]

iCal

Retrieve the url and render as an iCalender v2.0 file with Content-Type: text/calendar.

http://localhost:8080/v1/ical

Will retrieve similar to:

BEGIN:VCALENDAR
VERSION:2.0
PRODID:ical-filter
CALSCALE:GREGORIAN
METHOD:PUBLISH
BEGIN:VTIMEZONE
TZID:UTC
BEGIN:STANDARD
DTSTART:19700329T020000
TZOFFSETFROM:+0000
TZOFFSETTO:+0000
END:STANDARD
END:VTIMEZONE
BEGIN:VEVENT
UID:TU586226199
DTSTAMP:20200703T085514Z
SUMMARY:Duty call
DTSTART:20200125T080000Z
DTEND:20200125T080000Z
CREATED:20200120T161734Z
END:VEVENT
BEGIN:VEVENT
UID:TU597147530
DTSTAMP:20200703T085514Z
SUMMARY:Duty call
DTSTART:20200202T080000Z
DTEND:20200202T080000Z
CREATED:20200128T074528Z
END:VEVENT
END:VCALENDAR