imip-agent

Annotated imiptools/data.py

318:f8538cef6ced
2015-02-10 Paul Boddie Changed the get_periods function to use time regime information so that recurring events function across time zone changes.
paul@213 1
#!/usr/bin/env python
paul@213 2
paul@213 3
"""
paul@213 4
Interpretation of vCalendar content.
paul@213 5
paul@213 6
Copyright (C) 2014, 2015 Paul Boddie <paul@boddie.org.uk>
paul@213 7
paul@213 8
This program is free software; you can redistribute it and/or modify it under
paul@213 9
the terms of the GNU General Public License as published by the Free Software
paul@213 10
Foundation; either version 3 of the License, or (at your option) any later
paul@213 11
version.
paul@213 12
paul@213 13
This program is distributed in the hope that it will be useful, but WITHOUT
paul@213 14
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
paul@213 15
FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
paul@213 16
details.
paul@213 17
paul@213 18
You should have received a copy of the GNU General Public License along with
paul@213 19
this program.  If not, see <http://www.gnu.org/licenses/>.
paul@213 20
"""
paul@213 21
paul@256 22
from datetime import datetime, timedelta
paul@213 23
from email.mime.text import MIMEText
paul@291 24
from imiptools.dates import format_datetime, get_datetime, get_freebusy_period, \
paul@318 25
                            to_timezone, to_utc_datetime
paul@316 26
from pytz import timezone
paul@213 27
from vCalendar import iterwrite, parse, ParseError, to_dict, to_node
paul@256 28
from vRecurrence import get_parameters, get_rule
paul@213 29
import email.utils
paul@213 30
paul@213 31
try:
paul@213 32
    from cStringIO import StringIO
paul@213 33
except ImportError:
paul@213 34
    from StringIO import StringIO
paul@213 35
paul@213 36
class Object:
paul@213 37
paul@213 38
    "Access to calendar structures."
paul@213 39
paul@213 40
    def __init__(self, fragment):
paul@213 41
        self.objtype, (self.details, self.attr) = fragment.items()[0]
paul@213 42
paul@213 43
    def get_items(self, name, all=True):
paul@213 44
        return get_items(self.details, name, all)
paul@213 45
paul@213 46
    def get_item(self, name):
paul@213 47
        return get_item(self.details, name)
paul@213 48
paul@213 49
    def get_value_map(self, name):
paul@213 50
        return get_value_map(self.details, name)
paul@213 51
paul@213 52
    def get_values(self, name, all=True):
paul@213 53
        return get_values(self.details, name, all)
paul@213 54
paul@213 55
    def get_value(self, name):
paul@213 56
        return get_value(self.details, name)
paul@213 57
paul@213 58
    def get_utc_datetime(self, name):
paul@213 59
        return get_utc_datetime(self.details, name)
paul@213 60
paul@318 61
    def get_datetime(self, name):
paul@318 62
        dt, attr = get_datetime_item(self.details, name)
paul@318 63
        return dt
paul@318 64
paul@289 65
    def get_datetime_item(self, name):
paul@289 66
        return get_datetime_item(self.details, name)
paul@289 67
paul@213 68
    def to_node(self):
paul@213 69
        return to_node({self.objtype : [(self.details, self.attr)]})
paul@213 70
paul@213 71
    def to_part(self, method):
paul@213 72
        return to_part(method, [self.to_node()])
paul@213 73
paul@213 74
    # Direct access to the structure.
paul@213 75
paul@213 76
    def __getitem__(self, name):
paul@213 77
        return self.details[name]
paul@213 78
paul@213 79
    def __setitem__(self, name, value):
paul@213 80
        self.details[name] = value
paul@213 81
paul@213 82
    def __delitem__(self, name):
paul@213 83
        del self.details[name]
paul@213 84
paul@256 85
    # Computed results.
paul@256 86
paul@318 87
    def get_periods(self, tzid, window_size=100):
paul@318 88
        return get_periods(self, tzid, window_size)
paul@256 89
paul@291 90
    def get_periods_for_freebusy(self, tzid, window_size=100):
paul@318 91
        periods = self.get_periods(tzid, window_size)
paul@291 92
        return get_periods_for_freebusy(self, periods, tzid)
paul@291 93
paul@213 94
# Construction and serialisation.
paul@213 95
paul@213 96
def make_calendar(nodes, method=None):
paul@213 97
paul@213 98
    """
paul@213 99
    Return a complete calendar node wrapping the given 'nodes' and employing the
paul@213 100
    given 'method', if indicated.
paul@213 101
    """
paul@213 102
paul@213 103
    return ("VCALENDAR", {},
paul@213 104
            (method and [("METHOD", {}, method)] or []) +
paul@213 105
            [("VERSION", {}, "2.0")] +
paul@213 106
            nodes
paul@213 107
           )
paul@213 108
paul@292 109
def make_freebusy(freebusy, uid, organiser, organiser_attr=None, attendee=None, attendee_attr=None):
paul@222 110
    
paul@222 111
    """
paul@222 112
    Return a calendar node defining the free/busy details described in the given
paul@292 113
    'freebusy' list, employing the given 'uid', for the given 'organiser' and
paul@292 114
    optional 'organiser_attr', with the optional 'attendee' providing recipient
paul@292 115
    details together with the optional 'attendee_attr'.
paul@222 116
    """
paul@222 117
    
paul@222 118
    record = []
paul@222 119
    rwrite = record.append
paul@222 120
    
paul@292 121
    rwrite(("ORGANIZER", organiser_attr or {}, organiser))
paul@222 122
paul@222 123
    if attendee:
paul@292 124
        rwrite(("ATTENDEE", attendee_attr or {}, attendee)) 
paul@222 125
paul@222 126
    rwrite(("UID", {}, uid))
paul@222 127
paul@222 128
    if freebusy:
paul@222 129
        for start, end, uid, transp in freebusy:
paul@222 130
            if transp == "OPAQUE":
paul@222 131
                rwrite(("FREEBUSY", {"FBTYPE" : "BUSY"}, "/".join([start, end])))
paul@222 132
paul@222 133
    return ("VFREEBUSY", {}, record)
paul@222 134
paul@213 135
def parse_object(f, encoding, objtype=None):
paul@213 136
paul@213 137
    """
paul@213 138
    Parse the iTIP content from 'f' having the given 'encoding'. If 'objtype' is
paul@213 139
    given, only objects of that type will be returned. Otherwise, the root of
paul@213 140
    the content will be returned as a dictionary with a single key indicating
paul@213 141
    the object type.
paul@213 142
paul@213 143
    Return None if the content was not readable or suitable.
paul@213 144
    """
paul@213 145
paul@213 146
    try:
paul@213 147
        try:
paul@213 148
            doctype, attrs, elements = obj = parse(f, encoding=encoding)
paul@213 149
            if objtype and doctype == objtype:
paul@213 150
                return to_dict(obj)[objtype][0]
paul@213 151
            elif not objtype:
paul@213 152
                return to_dict(obj)
paul@213 153
        finally:
paul@213 154
            f.close()
paul@213 155
paul@213 156
    # NOTE: Handle parse errors properly.
paul@213 157
paul@213 158
    except (ParseError, ValueError):
paul@213 159
        pass
paul@213 160
paul@213 161
    return None
paul@213 162
paul@213 163
def to_part(method, calendar):
paul@213 164
paul@213 165
    """
paul@213 166
    Write using the given 'method', the 'calendar' details to a MIME
paul@213 167
    text/calendar part.
paul@213 168
    """
paul@213 169
paul@213 170
    encoding = "utf-8"
paul@213 171
    out = StringIO()
paul@213 172
    try:
paul@213 173
        to_stream(out, make_calendar(calendar, method), encoding)
paul@213 174
        part = MIMEText(out.getvalue(), "calendar", encoding)
paul@213 175
        part.set_param("method", method)
paul@213 176
        return part
paul@213 177
paul@213 178
    finally:
paul@213 179
        out.close()
paul@213 180
paul@213 181
def to_stream(out, fragment, encoding="utf-8"):
paul@213 182
    iterwrite(out, encoding=encoding).append(fragment)
paul@213 183
paul@213 184
# Structure access functions.
paul@213 185
paul@213 186
def get_items(d, name, all=True):
paul@213 187
paul@213 188
    """
paul@213 189
    Get all items from 'd' for the given 'name', returning single items if
paul@213 190
    'all' is specified and set to a false value and if only one value is
paul@213 191
    present for the name. Return None if no items are found for the name or if
paul@213 192
    many items are found but 'all' is set to a false value.
paul@213 193
    """
paul@213 194
paul@213 195
    if d.has_key(name):
paul@213 196
        values = d[name]
paul@213 197
        if all:
paul@213 198
            return values
paul@213 199
        elif len(values) == 1:
paul@213 200
            return values[0]
paul@213 201
        else:
paul@213 202
            return None
paul@213 203
    else:
paul@213 204
        return None
paul@213 205
paul@213 206
def get_item(d, name):
paul@213 207
    return get_items(d, name, False)
paul@213 208
paul@213 209
def get_value_map(d, name):
paul@213 210
paul@213 211
    """
paul@213 212
    Return a dictionary for all items in 'd' having the given 'name'. The
paul@213 213
    dictionary will map values for the name to any attributes or qualifiers
paul@213 214
    that may have been present.
paul@213 215
    """
paul@213 216
paul@213 217
    items = get_items(d, name)
paul@213 218
    if items:
paul@213 219
        return dict(items)
paul@213 220
    else:
paul@213 221
        return {}
paul@213 222
paul@213 223
def get_values(d, name, all=True):
paul@213 224
    if d.has_key(name):
paul@213 225
        values = d[name]
paul@213 226
        if not all and len(values) == 1:
paul@213 227
            return values[0][0]
paul@213 228
        else:
paul@213 229
            return map(lambda x: x[0], values)
paul@213 230
    else:
paul@213 231
        return None
paul@213 232
paul@213 233
def get_value(d, name):
paul@213 234
    return get_values(d, name, False)
paul@213 235
paul@213 236
def get_utc_datetime(d, name):
paul@289 237
    dt, attr = get_datetime_item(d, name)
paul@289 238
    return to_utc_datetime(dt)
paul@289 239
paul@289 240
def get_datetime_item(d, name):
paul@213 241
    value, attr = get_item(d, name)
paul@289 242
    return get_datetime(value, attr), attr
paul@213 243
paul@213 244
def get_addresses(values):
paul@213 245
    return [address for name, address in email.utils.getaddresses(values)]
paul@213 246
paul@213 247
def get_address(value):
paul@213 248
    return value.lower().startswith("mailto:") and value.lower()[7:] or value
paul@213 249
paul@213 250
def get_uri(value):
paul@213 251
    return value.lower().startswith("mailto:") and value.lower() or ":" in value and value or "mailto:%s" % value.lower()
paul@213 252
paul@309 253
uri_value = get_uri
paul@309 254
paul@309 255
def uri_values(values):
paul@309 256
    return map(get_uri, values)
paul@309 257
paul@213 258
def uri_dict(d):
paul@213 259
    return dict([(get_uri(key), value) for key, value in d.items()])
paul@213 260
paul@213 261
def uri_item(item):
paul@213 262
    return get_uri(item[0]), item[1]
paul@213 263
paul@213 264
def uri_items(items):
paul@213 265
    return [(get_uri(value), attr) for value, attr in items]
paul@213 266
paul@220 267
# Operations on structure data.
paul@220 268
paul@220 269
def is_new_object(old_sequence, new_sequence, old_dtstamp, new_dtstamp, partstat_set):
paul@220 270
paul@220 271
    """
paul@220 272
    Return for the given 'old_sequence' and 'new_sequence', 'old_dtstamp' and
paul@220 273
    'new_dtstamp', and the 'partstat_set' indication, whether the object
paul@220 274
    providing the new information is really newer than the object providing the
paul@220 275
    old information.
paul@220 276
    """
paul@220 277
paul@220 278
    have_sequence = old_sequence is not None and new_sequence is not None
paul@220 279
    is_same_sequence = have_sequence and int(new_sequence) == int(old_sequence)
paul@220 280
paul@220 281
    have_dtstamp = old_dtstamp and new_dtstamp
paul@220 282
    is_old_dtstamp = have_dtstamp and new_dtstamp < old_dtstamp or old_dtstamp and not new_dtstamp
paul@220 283
paul@220 284
    is_old_sequence = have_sequence and (
paul@220 285
        int(new_sequence) < int(old_sequence) or
paul@220 286
        is_same_sequence and is_old_dtstamp
paul@220 287
        )
paul@220 288
paul@220 289
    return is_same_sequence and partstat_set or not is_old_sequence
paul@220 290
paul@256 291
# NOTE: Need to expose the 100 day window for recurring events in the
paul@256 292
# NOTE: configuration.
paul@256 293
paul@318 294
def get_periods(obj, tzid, window_size=100):
paul@256 295
paul@256 296
    """
paul@256 297
    Return periods for the given object 'obj', confining materialised periods
paul@256 298
    to the given 'window_size' in days starting from the present moment.
paul@256 299
    """
paul@256 300
paul@318 301
    # NOTE: Need also RDATE and EXDATE support.
paul@318 302
paul@318 303
    rrule = obj.get_value("RRULE")
paul@318 304
paul@318 305
    if not rrule:
paul@318 306
        return [(obj.get_utc_datetime("DTSTART"), obj.get_utc_datetime("DTEND"))]
paul@318 307
paul@318 308
    # Use localised datetimes.
paul@318 309
paul@318 310
    dtstart, start_attr = obj.get_datetime_item("DTSTART")
paul@318 311
    dtend, end_attr = obj.get_datetime_item("DTEND")
paul@318 312
paul@318 313
    tzid = start_attr.get("TZID") or end_attr.get("TZID") or tzid
paul@256 314
paul@256 315
    # NOTE: Need also DURATION support.
paul@256 316
paul@256 317
    duration = dtend - dtstart
paul@256 318
paul@256 319
    # Recurrence rules create multiple instances to be checked.
paul@256 320
    # Conflicts may only be assessed within a period defined by policy
paul@256 321
    # for the agent, with instances outside that period being considered
paul@256 322
    # unchecked.
paul@256 323
paul@318 324
    window_end = to_timezone(datetime.now(), tzid) + timedelta(window_size)
paul@256 325
paul@318 326
    selector = get_rule(dtstart, rrule)
paul@318 327
    parameters = get_parameters(rrule)
paul@318 328
    periods = []
paul@256 329
paul@318 330
    for start in selector.materialise(dtstart, window_end, parameters.get("COUNT"), parameters.get("BYSETPOS")):
paul@318 331
        start = to_timezone(datetime(*start), tzid)
paul@318 332
        start = to_timezone(start, "UTC")
paul@318 333
        end = start + duration
paul@318 334
        periods.append((start, end))
paul@256 335
paul@256 336
    return periods
paul@256 337
paul@291 338
def get_periods_for_freebusy(obj, periods, tzid):
paul@291 339
paul@306 340
    """
paul@306 341
    Get free/busy-compliant periods employed by 'obj' from the given 'periods',
paul@306 342
    using the indicated 'tzid' to convert dates to datetimes.
paul@306 343
    """
paul@306 344
paul@291 345
    start, start_attr = obj.get_datetime_item("DTSTART")
paul@291 346
    end, end_attr = obj.get_datetime_item("DTEND")
paul@291 347
paul@291 348
    tzid = start_attr.get("TZID") or end_attr.get("TZID") or tzid
paul@291 349
paul@291 350
    l = []
paul@291 351
paul@291 352
    for start, end in periods:
paul@291 353
        start, end = get_freebusy_period(start, end, tzid)
paul@291 354
        l.append((format_datetime(start), format_datetime(end)))
paul@291 355
paul@291 356
    return l
paul@291 357
paul@213 358
# vim: tabstop=4 expandtab shiftwidth=4