paul@441 | 1 | #!/usr/bin/env python |
paul@441 | 2 | |
paul@441 | 3 | """ |
paul@441 | 4 | Common calendar client utilities. |
paul@441 | 5 | |
paul@441 | 6 | Copyright (C) 2014, 2015 Paul Boddie <paul@boddie.org.uk> |
paul@441 | 7 | |
paul@441 | 8 | This program is free software; you can redistribute it and/or modify it under |
paul@441 | 9 | the terms of the GNU General Public License as published by the Free Software |
paul@441 | 10 | Foundation; either version 3 of the License, or (at your option) any later |
paul@441 | 11 | version. |
paul@441 | 12 | |
paul@441 | 13 | This program is distributed in the hope that it will be useful, but WITHOUT |
paul@441 | 14 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
paul@441 | 15 | FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
paul@441 | 16 | details. |
paul@441 | 17 | |
paul@441 | 18 | You should have received a copy of the GNU General Public License along with |
paul@441 | 19 | this program. If not, see <http://www.gnu.org/licenses/>. |
paul@441 | 20 | """ |
paul@441 | 21 | |
paul@601 | 22 | from datetime import datetime |
paul@606 | 23 | from imiptools.data import Object, get_address, get_uri, get_window_end, \ |
paul@606 | 24 | is_new_object, make_freebusy, to_part, \ |
paul@604 | 25 | uri_dict, uri_items, uri_values |
paul@604 | 26 | from imiptools.dates import format_datetime, get_default_timezone, \ |
paul@627 | 27 | get_timestamp, to_timezone |
paul@606 | 28 | from imiptools.period import can_schedule, remove_period, \ |
paul@606 | 29 | remove_additional_periods, remove_affected_period, \ |
paul@606 | 30 | update_freebusy |
paul@443 | 31 | from imiptools.profile import Preferences |
paul@604 | 32 | import imip_store |
paul@441 | 33 | |
paul@443 | 34 | class Client: |
paul@443 | 35 | |
paul@443 | 36 | "Common handler and manager methods." |
paul@443 | 37 | |
paul@467 | 38 | default_window_size = 100 |
paul@467 | 39 | |
paul@639 | 40 | def __init__(self, user, messenger=None, store=None, publisher=None, preferences_dir=None): |
paul@443 | 41 | self.user = user |
paul@601 | 42 | self.messenger = messenger |
paul@604 | 43 | self.store = store or imip_store.FileStore() |
paul@604 | 44 | |
paul@604 | 45 | try: |
paul@604 | 46 | self.publisher = publisher or imip_store.FilePublisher() |
paul@604 | 47 | except OSError: |
paul@604 | 48 | self.publisher = None |
paul@604 | 49 | |
paul@639 | 50 | self.preferences_dir = preferences_dir |
paul@443 | 51 | self.preferences = None |
paul@443 | 52 | |
paul@443 | 53 | def get_preferences(self): |
paul@467 | 54 | if not self.preferences and self.user: |
paul@639 | 55 | self.preferences = Preferences(self.user, self.preferences_dir) |
paul@443 | 56 | return self.preferences |
paul@443 | 57 | |
paul@443 | 58 | def get_tzid(self): |
paul@443 | 59 | prefs = self.get_preferences() |
paul@467 | 60 | return prefs and prefs.get("TZID") or get_default_timezone() |
paul@443 | 61 | |
paul@443 | 62 | def get_window_size(self): |
paul@443 | 63 | prefs = self.get_preferences() |
paul@443 | 64 | try: |
paul@467 | 65 | return prefs and int(prefs.get("window_size")) or self.default_window_size |
paul@443 | 66 | except (TypeError, ValueError): |
paul@467 | 67 | return self.default_window_size |
paul@443 | 68 | |
paul@443 | 69 | def get_window_end(self): |
paul@443 | 70 | return get_window_end(self.get_tzid(), self.get_window_size()) |
paul@443 | 71 | |
paul@443 | 72 | def is_sharing(self): |
paul@467 | 73 | prefs = self.get_preferences() |
paul@467 | 74 | return prefs and prefs.get("freebusy_sharing") == "share" or False |
paul@443 | 75 | |
paul@443 | 76 | def is_bundling(self): |
paul@467 | 77 | prefs = self.get_preferences() |
paul@467 | 78 | return prefs and prefs.get("freebusy_bundling") == "always" or False |
paul@467 | 79 | |
paul@467 | 80 | def is_notifying(self): |
paul@467 | 81 | prefs = self.get_preferences() |
paul@467 | 82 | return prefs and prefs.get("freebusy_messages") == "notify" or False |
paul@443 | 83 | |
paul@655 | 84 | def get_scheduling_resolution(self): |
paul@655 | 85 | |
paul@655 | 86 | """ |
paul@655 | 87 | Decode a specification of one of the following forms... |
paul@655 | 88 | |
paul@655 | 89 | <minute values> |
paul@655 | 90 | <hour values>:<minute values> |
paul@655 | 91 | <hour values>:<minute values>:<second values> |
paul@655 | 92 | |
paul@655 | 93 | ...with each list of values being comma-separated. |
paul@655 | 94 | """ |
paul@655 | 95 | |
paul@655 | 96 | prefs = self.get_preferences() |
paul@655 | 97 | resolution = prefs and prefs.get("scheduling_resolution") |
paul@655 | 98 | if resolution: |
paul@655 | 99 | try: |
paul@655 | 100 | l = [] |
paul@655 | 101 | for component in resolution.split(":")[:3]: |
paul@655 | 102 | if component: |
paul@655 | 103 | l.append(map(int, component.split(","))) |
paul@655 | 104 | else: |
paul@655 | 105 | l.append(None) |
paul@655 | 106 | |
paul@655 | 107 | # NOTE: Should probably report an error somehow. |
paul@655 | 108 | |
paul@655 | 109 | except ValueError: |
paul@655 | 110 | return None |
paul@655 | 111 | else: |
paul@655 | 112 | l = (len(l) < 2 and [None] or []) + l + (len(l) < 3 and [None] or []) |
paul@655 | 113 | return l |
paul@655 | 114 | else: |
paul@655 | 115 | return None |
paul@655 | 116 | |
paul@581 | 117 | # Common operations on calendar data. |
paul@581 | 118 | |
paul@619 | 119 | def update_attendees(self, obj, attendees, removed): |
paul@619 | 120 | |
paul@619 | 121 | """ |
paul@619 | 122 | Update the attendees in 'obj' with the given 'attendees' and 'removed' |
paul@619 | 123 | attendee lists. A list is returned containing the attendees whose |
paul@619 | 124 | attendance should be cancelled. |
paul@619 | 125 | """ |
paul@619 | 126 | |
paul@619 | 127 | to_cancel = [] |
paul@619 | 128 | |
paul@619 | 129 | existing_attendees = uri_values(obj.get_values("ATTENDEE") or []) |
paul@619 | 130 | added = set(attendees).difference(existing_attendees) |
paul@619 | 131 | |
paul@619 | 132 | if added or removed: |
paul@619 | 133 | attendees = uri_items(obj.get_items("ATTENDEE") or []) |
paul@619 | 134 | sequence = obj.get_value("SEQUENCE") |
paul@619 | 135 | |
paul@619 | 136 | if removed: |
paul@619 | 137 | remaining = [] |
paul@619 | 138 | |
paul@619 | 139 | for attendee, attendee_attr in attendees: |
paul@619 | 140 | if attendee in removed: |
paul@619 | 141 | |
paul@619 | 142 | # Without a sequence number, assume that the event has not |
paul@619 | 143 | # been published and that attendees can be silently removed. |
paul@619 | 144 | |
paul@619 | 145 | if sequence is not None: |
paul@619 | 146 | to_cancel.append((attendee, attendee_attr)) |
paul@619 | 147 | else: |
paul@619 | 148 | remaining.append((attendee, attendee_attr)) |
paul@619 | 149 | |
paul@619 | 150 | attendees = remaining |
paul@619 | 151 | |
paul@619 | 152 | if added: |
paul@619 | 153 | for attendee in added: |
paul@619 | 154 | attendee = attendee.strip() |
paul@619 | 155 | if attendee: |
paul@619 | 156 | attendees.append((get_uri(attendee), {"PARTSTAT" : "NEEDS-ACTION", "RSVP" : "TRUE"})) |
paul@619 | 157 | |
paul@619 | 158 | obj["ATTENDEE"] = attendees |
paul@619 | 159 | |
paul@619 | 160 | return to_cancel |
paul@619 | 161 | |
paul@582 | 162 | def update_participation(self, obj, partstat=None): |
paul@581 | 163 | |
paul@581 | 164 | """ |
paul@581 | 165 | Update the participation in 'obj' of the user with the given 'partstat'. |
paul@581 | 166 | """ |
paul@581 | 167 | |
paul@581 | 168 | attendee_attr = uri_dict(obj.get_value_map("ATTENDEE")).get(self.user) |
paul@582 | 169 | if not attendee_attr: |
paul@582 | 170 | return None |
paul@582 | 171 | if partstat: |
paul@582 | 172 | attendee_attr["PARTSTAT"] = partstat |
paul@581 | 173 | if attendee_attr.has_key("RSVP"): |
paul@581 | 174 | del attendee_attr["RSVP"] |
paul@584 | 175 | self.update_sender(attendee_attr) |
paul@581 | 176 | return attendee_attr |
paul@581 | 177 | |
paul@584 | 178 | def update_sender(self, attr): |
paul@584 | 179 | |
paul@584 | 180 | "Update the SENT-BY attribute of the 'attr' sender metadata." |
paul@584 | 181 | |
paul@584 | 182 | if self.messenger and self.messenger.sender != get_address(self.user): |
paul@584 | 183 | attr["SENT-BY"] = get_uri(self.messenger.sender) |
paul@584 | 184 | |
paul@606 | 185 | def get_periods(self, obj): |
paul@606 | 186 | |
paul@606 | 187 | """ |
paul@606 | 188 | Return periods for the given 'obj'. Interpretation of periods can depend |
paul@606 | 189 | on the time zone, which is obtained for the current user. |
paul@606 | 190 | """ |
paul@606 | 191 | |
paul@606 | 192 | return obj.get_periods(self.get_tzid(), self.get_window_end()) |
paul@606 | 193 | |
paul@606 | 194 | # Store operations. |
paul@606 | 195 | |
paul@606 | 196 | def get_stored_object(self, uid, recurrenceid): |
paul@606 | 197 | |
paul@606 | 198 | """ |
paul@606 | 199 | Return the stored object for the current user, with the given 'uid' and |
paul@606 | 200 | 'recurrenceid'. |
paul@606 | 201 | """ |
paul@606 | 202 | |
paul@606 | 203 | fragment = self.store.get_event(self.user, uid, recurrenceid) |
paul@606 | 204 | return fragment and Object(fragment) |
paul@606 | 205 | |
paul@604 | 206 | # Free/busy operations. |
paul@604 | 207 | |
paul@606 | 208 | def get_freebusy_part(self, freebusy=None): |
paul@604 | 209 | |
paul@604 | 210 | """ |
paul@606 | 211 | Return a message part containing free/busy information for the user, |
paul@606 | 212 | either specified as 'freebusy' or obtained from the store directly. |
paul@604 | 213 | """ |
paul@604 | 214 | |
paul@604 | 215 | if self.is_sharing() and self.is_bundling(): |
paul@604 | 216 | |
paul@604 | 217 | # Invent a unique identifier. |
paul@604 | 218 | |
paul@604 | 219 | utcnow = get_timestamp() |
paul@604 | 220 | uid = "imip-agent-%s-%s" % (utcnow, get_address(self.user)) |
paul@604 | 221 | |
paul@606 | 222 | freebusy = freebusy or self.store.get_freebusy(self.user) |
paul@604 | 223 | |
paul@604 | 224 | user_attr = {} |
paul@604 | 225 | self.update_sender(user_attr) |
paul@604 | 226 | return to_part("PUBLISH", [make_freebusy(freebusy, uid, self.user, user_attr)]) |
paul@604 | 227 | |
paul@604 | 228 | return None |
paul@604 | 229 | |
paul@606 | 230 | def update_freebusy(self, freebusy, periods, transp, uid, recurrenceid, summary, organiser): |
paul@606 | 231 | |
paul@606 | 232 | """ |
paul@606 | 233 | Update the 'freebusy' collection with the given 'periods', indicating a |
paul@606 | 234 | 'transp' status, explicit 'uid' and 'recurrenceid' to indicate either a |
paul@606 | 235 | recurrence or the parent event. The 'summary' and 'organiser' must also |
paul@606 | 236 | be provided. |
paul@606 | 237 | """ |
paul@606 | 238 | |
paul@612 | 239 | update_freebusy(freebusy, periods, transp, uid, recurrenceid, summary, organiser) |
paul@606 | 240 | |
paul@601 | 241 | class ClientForObject(Client): |
paul@601 | 242 | |
paul@601 | 243 | "A client maintaining a specific object." |
paul@601 | 244 | |
paul@639 | 245 | def __init__(self, obj, user, messenger=None, store=None, publisher=None, preferences_dir=None): |
paul@639 | 246 | Client.__init__(self, user, messenger, store, publisher, preferences_dir) |
paul@601 | 247 | self.set_object(obj) |
paul@601 | 248 | |
paul@601 | 249 | def set_object(self, obj): |
paul@606 | 250 | |
paul@606 | 251 | "Set the current object to 'obj', obtaining metadata details." |
paul@606 | 252 | |
paul@601 | 253 | self.obj = obj |
paul@601 | 254 | self.uid = obj and self.obj.get_uid() |
paul@601 | 255 | self.recurrenceid = obj and self.obj.get_recurrenceid() |
paul@601 | 256 | self.sequence = obj and self.obj.get_value("SEQUENCE") |
paul@601 | 257 | self.dtstamp = obj and self.obj.get_value("DTSTAMP") |
paul@601 | 258 | |
paul@604 | 259 | # Object update methods. |
paul@601 | 260 | |
paul@601 | 261 | def update_dtstamp(self): |
paul@601 | 262 | |
paul@601 | 263 | "Update the DTSTAMP in the current object." |
paul@601 | 264 | |
paul@601 | 265 | dtstamp = self.obj.get_utc_datetime("DTSTAMP") |
paul@601 | 266 | utcnow = to_timezone(datetime.utcnow(), "UTC") |
paul@601 | 267 | self.obj["DTSTAMP"] = [(format_datetime(dtstamp > utcnow and dtstamp or utcnow), {})] |
paul@601 | 268 | |
paul@601 | 269 | def set_sequence(self, increment=False): |
paul@601 | 270 | |
paul@601 | 271 | "Update the SEQUENCE in the current object." |
paul@601 | 272 | |
paul@601 | 273 | sequence = self.obj.get_value("SEQUENCE") or "0" |
paul@601 | 274 | self.obj["SEQUENCE"] = [(str(int(sequence) + (increment and 1 or 0)), {})] |
paul@601 | 275 | |
paul@606 | 276 | def merge_attendance(self, attendees): |
paul@606 | 277 | |
paul@606 | 278 | """ |
paul@606 | 279 | Merge attendance from the current object's 'attendees' into the version |
paul@606 | 280 | stored for the current user. |
paul@606 | 281 | """ |
paul@606 | 282 | |
paul@606 | 283 | obj = self.get_stored_object_version() |
paul@606 | 284 | |
paul@606 | 285 | if not obj or not self.have_new_object(obj): |
paul@606 | 286 | return False |
paul@606 | 287 | |
paul@606 | 288 | # Get attendee details in a usable form. |
paul@606 | 289 | |
paul@606 | 290 | attendee_map = uri_dict(obj.get_value_map("ATTENDEE")) |
paul@606 | 291 | |
paul@606 | 292 | for attendee, attendee_attr in attendees.items(): |
paul@606 | 293 | |
paul@606 | 294 | # Update attendance in the loaded object. |
paul@606 | 295 | |
paul@606 | 296 | attendee_map[attendee] = attendee_attr |
paul@606 | 297 | |
paul@606 | 298 | # Set the new details and store the object. |
paul@606 | 299 | |
paul@606 | 300 | obj["ATTENDEE"] = attendee_map.items() |
paul@606 | 301 | |
paul@606 | 302 | # Set the complete event if not an additional occurrence. |
paul@606 | 303 | |
paul@606 | 304 | event = obj.to_node() |
paul@606 | 305 | self.store.set_event(self.user, self.uid, self.recurrenceid, event) |
paul@606 | 306 | |
paul@606 | 307 | return True |
paul@606 | 308 | |
paul@606 | 309 | # Object-related tests. |
paul@606 | 310 | |
paul@606 | 311 | def get_attendance(self, user=None): |
paul@606 | 312 | |
paul@606 | 313 | """ |
paul@606 | 314 | Return the attendance attributes for 'user', or the current user if |
paul@606 | 315 | 'user' is not specified. |
paul@606 | 316 | """ |
paul@606 | 317 | |
paul@606 | 318 | attendees = uri_dict(self.obj.get_value_map("ATTENDEE")) |
paul@606 | 319 | return attendees.get(user or self.user) or {} |
paul@606 | 320 | |
paul@609 | 321 | def is_participating(self, user, as_organiser=False): |
paul@609 | 322 | |
paul@609 | 323 | """ |
paul@609 | 324 | Return whether, subject to the 'user' indicating an identity and the |
paul@609 | 325 | 'as_organiser' status of that identity, the user concerned is actually |
paul@609 | 326 | participating in the current object event. |
paul@609 | 327 | """ |
paul@609 | 328 | |
paul@609 | 329 | attr = self.get_attendance(user) |
paul@609 | 330 | return as_organiser or not attr or attr.get("PARTSTAT") != "DECLINED" |
paul@609 | 331 | |
paul@609 | 332 | def get_overriding_transparency(self, user, as_organiser=False): |
paul@609 | 333 | |
paul@609 | 334 | """ |
paul@609 | 335 | Return the overriding transparency to be associated with the free/busy |
paul@609 | 336 | records for an event, subject to the 'user' indicating an identity and |
paul@609 | 337 | the 'as_organiser' status of that identity. |
paul@609 | 338 | |
paul@609 | 339 | Where an identity is only an organiser and not attending, "ORG" is |
paul@609 | 340 | returned. Otherwise, no overriding transparency is defined and None is |
paul@609 | 341 | returned. |
paul@609 | 342 | """ |
paul@609 | 343 | |
paul@609 | 344 | attr = self.get_attendance(user) |
paul@609 | 345 | return as_organiser and not (attr and attr.get("PARTSTAT")) and "ORG" or None |
paul@609 | 346 | |
paul@606 | 347 | def is_attendee(self, identity, obj=None): |
paul@606 | 348 | |
paul@606 | 349 | """ |
paul@606 | 350 | Return whether 'identity' is an attendee in the current object, or in |
paul@606 | 351 | 'obj' if specified. |
paul@606 | 352 | """ |
paul@606 | 353 | |
paul@606 | 354 | return identity in uri_values((obj or self.obj).get_values("ATTENDEE")) |
paul@606 | 355 | |
paul@606 | 356 | def can_schedule(self, freebusy, periods): |
paul@606 | 357 | |
paul@606 | 358 | """ |
paul@606 | 359 | Indicate whether within 'freebusy' the given 'periods' can be scheduled. |
paul@606 | 360 | """ |
paul@606 | 361 | |
paul@606 | 362 | return can_schedule(freebusy, periods, self.uid, self.recurrenceid) |
paul@606 | 363 | |
paul@606 | 364 | def have_new_object(self, obj=None): |
paul@606 | 365 | |
paul@606 | 366 | """ |
paul@606 | 367 | Return whether the current object is new to the current user (or if the |
paul@606 | 368 | given 'obj' is new). |
paul@606 | 369 | """ |
paul@606 | 370 | |
paul@606 | 371 | obj = obj or self.get_stored_object_version() |
paul@606 | 372 | |
paul@606 | 373 | # If found, compare SEQUENCE and potentially DTSTAMP. |
paul@606 | 374 | |
paul@606 | 375 | if obj: |
paul@606 | 376 | sequence = obj.get_value("SEQUENCE") |
paul@606 | 377 | dtstamp = obj.get_value("DTSTAMP") |
paul@606 | 378 | |
paul@606 | 379 | # If the request refers to an older version of the object, ignore |
paul@606 | 380 | # it. |
paul@606 | 381 | |
paul@606 | 382 | return is_new_object(sequence, self.sequence, dtstamp, self.dtstamp, |
paul@606 | 383 | self.is_partstat_updated(obj)) |
paul@606 | 384 | |
paul@606 | 385 | return True |
paul@606 | 386 | |
paul@606 | 387 | def is_partstat_updated(self, obj): |
paul@606 | 388 | |
paul@606 | 389 | """ |
paul@606 | 390 | Return whether the participant status has been updated in the current |
paul@606 | 391 | object in comparison to the given 'obj'. |
paul@606 | 392 | |
paul@606 | 393 | NOTE: Some clients like Claws Mail erase time information from DTSTAMP |
paul@606 | 394 | NOTE: and make it invalid. Thus, such attendance information may also be |
paul@606 | 395 | NOTE: incorporated into any new object assessment. |
paul@606 | 396 | """ |
paul@606 | 397 | |
paul@606 | 398 | old_attendees = uri_dict(obj.get_value_map("ATTENDEE")) |
paul@606 | 399 | new_attendees = uri_dict(self.obj.get_value_map("ATTENDEE")) |
paul@606 | 400 | |
paul@606 | 401 | for attendee, attr in old_attendees.items(): |
paul@606 | 402 | old_partstat = attr.get("PARTSTAT") |
paul@606 | 403 | new_attr = new_attendees.get(attendee) |
paul@606 | 404 | new_partstat = new_attr and new_attr.get("PARTSTAT") |
paul@606 | 405 | |
paul@606 | 406 | if old_partstat == "NEEDS-ACTION" and new_partstat and \ |
paul@606 | 407 | new_partstat != old_partstat: |
paul@606 | 408 | |
paul@606 | 409 | return True |
paul@606 | 410 | |
paul@606 | 411 | return False |
paul@606 | 412 | |
paul@655 | 413 | # Constraint application on event periods. |
paul@655 | 414 | |
paul@655 | 415 | class ValidityError(Exception): |
paul@655 | 416 | pass |
paul@655 | 417 | |
paul@655 | 418 | def check_object(self): |
paul@655 | 419 | |
paul@655 | 420 | "Check the object against any scheduling constraints." |
paul@655 | 421 | |
paul@655 | 422 | resolution = self.get_scheduling_resolution() |
paul@655 | 423 | if not resolution: |
paul@655 | 424 | return None |
paul@655 | 425 | |
paul@655 | 426 | tzid = self.get_tzid() |
paul@655 | 427 | invalid = [] |
paul@655 | 428 | |
paul@655 | 429 | for period in self.obj.get_periods(tzid): |
paul@655 | 430 | start = period.get_start() |
paul@655 | 431 | end = period.get_end() |
paul@655 | 432 | start_result = self.check_resolution(start, resolution) |
paul@655 | 433 | end_result = self.check_resolution(end, resolution) |
paul@655 | 434 | if start_result or end_result: |
paul@655 | 435 | invalid.append((period.origin, start_result, end_result)) |
paul@655 | 436 | |
paul@655 | 437 | return invalid |
paul@655 | 438 | |
paul@655 | 439 | def check_resolution(self, dt, resolution): |
paul@655 | 440 | |
paul@655 | 441 | "Check the datetime 'dt' against the 'resolution' list." |
paul@655 | 442 | |
paul@655 | 443 | if not isinstance(dt, datetime): |
paul@655 | 444 | raise ValidityError |
paul@655 | 445 | |
paul@655 | 446 | hours, minutes, seconds = resolution |
paul@655 | 447 | |
paul@655 | 448 | if hours and dt.hour not in hours: |
paul@655 | 449 | return "hour" |
paul@655 | 450 | if minutes and dt.minute not in minutes: |
paul@655 | 451 | return "minute" |
paul@655 | 452 | if seconds and dt.second not in seconds: |
paul@655 | 453 | return "second" |
paul@655 | 454 | |
paul@655 | 455 | return None |
paul@655 | 456 | |
paul@606 | 457 | # Object retrieval. |
paul@606 | 458 | |
paul@606 | 459 | def get_stored_object_version(self): |
paul@606 | 460 | |
paul@606 | 461 | """ |
paul@606 | 462 | Return the stored object to which the current object refers for the |
paul@606 | 463 | current user. |
paul@606 | 464 | """ |
paul@606 | 465 | |
paul@606 | 466 | return self.get_stored_object(self.uid, self.recurrenceid) |
paul@606 | 467 | |
paul@606 | 468 | def get_definitive_object(self, from_organiser): |
paul@606 | 469 | |
paul@606 | 470 | """ |
paul@606 | 471 | Return an object considered definitive for the current transaction, |
paul@606 | 472 | using 'from_organiser' to select the current transaction's object if |
paul@606 | 473 | true, or selecting a stored object if false. |
paul@606 | 474 | """ |
paul@606 | 475 | |
paul@606 | 476 | return from_organiser and self.obj or self.get_stored_object_version() |
paul@606 | 477 | |
paul@606 | 478 | def get_parent_object(self): |
paul@606 | 479 | |
paul@606 | 480 | """ |
paul@606 | 481 | Return the parent object to which the current object refers for the |
paul@606 | 482 | current user. |
paul@606 | 483 | """ |
paul@606 | 484 | |
paul@606 | 485 | return self.recurrenceid and self.get_stored_object(self.uid, None) or None |
paul@606 | 486 | |
paul@606 | 487 | # Convenience methods for modifying free/busy collections. |
paul@606 | 488 | |
paul@606 | 489 | def get_recurrence_start_point(self, recurrenceid): |
paul@606 | 490 | |
paul@606 | 491 | "Get 'recurrenceid' in a form suitable for matching free/busy entries." |
paul@606 | 492 | |
paul@627 | 493 | return self.obj.get_recurrence_start_point(recurrenceid, self.get_tzid()) |
paul@606 | 494 | |
paul@606 | 495 | def remove_from_freebusy(self, freebusy): |
paul@606 | 496 | |
paul@606 | 497 | "Remove this event from the given 'freebusy' collection." |
paul@606 | 498 | |
paul@606 | 499 | if not remove_period(freebusy, self.uid, self.recurrenceid) and self.recurrenceid: |
paul@606 | 500 | remove_affected_period(freebusy, self.uid, self.get_recurrence_start_point(self.recurrenceid)) |
paul@606 | 501 | |
paul@606 | 502 | def remove_freebusy_for_recurrences(self, freebusy, recurrenceids=None): |
paul@606 | 503 | |
paul@606 | 504 | """ |
paul@606 | 505 | Remove from 'freebusy' any original recurrence from parent free/busy |
paul@606 | 506 | details for the current object, if the current object is a specific |
paul@606 | 507 | additional recurrence. Otherwise, remove all additional recurrence |
paul@606 | 508 | information corresponding to 'recurrenceids', or if omitted, all |
paul@606 | 509 | recurrences. |
paul@606 | 510 | """ |
paul@606 | 511 | |
paul@606 | 512 | if self.recurrenceid: |
paul@606 | 513 | recurrenceid = self.get_recurrence_start_point(self.recurrenceid) |
paul@606 | 514 | remove_affected_period(freebusy, self.uid, recurrenceid) |
paul@606 | 515 | else: |
paul@606 | 516 | # Remove obsolete recurrence periods. |
paul@606 | 517 | |
paul@606 | 518 | remove_additional_periods(freebusy, self.uid, recurrenceids) |
paul@606 | 519 | |
paul@606 | 520 | # Remove original periods affected by additional recurrences. |
paul@606 | 521 | |
paul@606 | 522 | if recurrenceids: |
paul@606 | 523 | for recurrenceid in recurrenceids: |
paul@606 | 524 | recurrenceid = self.get_recurrence_start_point(recurrenceid) |
paul@606 | 525 | remove_affected_period(freebusy, self.uid, recurrenceid) |
paul@606 | 526 | |
paul@606 | 527 | def update_freebusy(self, freebusy, user, for_organiser): |
paul@606 | 528 | |
paul@606 | 529 | """ |
paul@606 | 530 | Update the 'freebusy' collection for this event with the periods and |
paul@606 | 531 | transparency associated with the current object, subject to the 'user' |
paul@606 | 532 | identity and the attendance details provided for them, indicating |
paul@606 | 533 | whether the update is 'for_organiser' or not. |
paul@606 | 534 | """ |
paul@606 | 535 | |
paul@606 | 536 | # Obtain the stored object if the current object is not issued by the |
paul@606 | 537 | # organiser. Attendees do not have the opportunity to redefine the |
paul@606 | 538 | # periods. |
paul@606 | 539 | |
paul@606 | 540 | obj = self.get_definitive_object(for_organiser) |
paul@606 | 541 | if not obj: |
paul@606 | 542 | return |
paul@606 | 543 | |
paul@606 | 544 | # Obtain the affected periods. |
paul@606 | 545 | |
paul@606 | 546 | periods = self.get_periods(obj) |
paul@606 | 547 | |
paul@606 | 548 | # Define an overriding transparency, the indicated event transparency, |
paul@606 | 549 | # or the default transparency for the free/busy entry. |
paul@606 | 550 | |
paul@606 | 551 | transp = self.get_overriding_transparency(user, for_organiser) or \ |
paul@606 | 552 | obj.get_value("TRANSP") or \ |
paul@606 | 553 | "OPAQUE" |
paul@606 | 554 | |
paul@606 | 555 | # Perform the low-level update. |
paul@606 | 556 | |
paul@606 | 557 | Client.update_freebusy(self, freebusy, periods, transp, |
paul@606 | 558 | self.uid, self.recurrenceid, |
paul@606 | 559 | obj.get_value("SUMMARY"), |
paul@606 | 560 | obj.get_value("ORGANIZER")) |
paul@606 | 561 | |
paul@606 | 562 | def update_freebusy_for_participant(self, freebusy, user, for_organiser=False, |
paul@606 | 563 | updating_other=False): |
paul@606 | 564 | |
paul@606 | 565 | """ |
paul@606 | 566 | Update the 'freebusy' collection using the given 'periods', involving |
paul@606 | 567 | the given 'user', indicating whether the update is 'for_organiser' or |
paul@606 | 568 | not, and whether it is 'updating_other' (meaning another user's |
paul@606 | 569 | details). |
paul@606 | 570 | """ |
paul@606 | 571 | |
paul@606 | 572 | # Record in the free/busy details unless a non-participating attendee. |
paul@606 | 573 | # Use any attendee information for an organiser, not the organiser's own |
paul@606 | 574 | # attributes. |
paul@606 | 575 | |
paul@606 | 576 | if self.is_participating(user, for_organiser and not updating_other): |
paul@606 | 577 | self.update_freebusy(freebusy, user, for_organiser) |
paul@606 | 578 | else: |
paul@606 | 579 | self.remove_from_freebusy(freebusy) |
paul@606 | 580 | |
paul@606 | 581 | # Convenience methods for updating stored free/busy information received |
paul@606 | 582 | # from other users. |
paul@606 | 583 | |
paul@606 | 584 | def update_freebusy_from_participant(self, user, for_organiser): |
paul@606 | 585 | |
paul@606 | 586 | """ |
paul@606 | 587 | For the current user, record the free/busy information for another |
paul@606 | 588 | 'user', indicating whether the update is 'for_organiser' or not, thus |
paul@606 | 589 | maintaining a separate record of their free/busy details. |
paul@606 | 590 | """ |
paul@606 | 591 | |
paul@606 | 592 | # A user does not store free/busy information for themself as another |
paul@606 | 593 | # party. |
paul@606 | 594 | |
paul@606 | 595 | if user == self.user: |
paul@606 | 596 | return |
paul@606 | 597 | |
paul@606 | 598 | freebusy = self.store.get_freebusy_for_other(self.user, user) |
paul@606 | 599 | self.update_freebusy_for_participant(freebusy, user, for_organiser, True) |
paul@606 | 600 | |
paul@606 | 601 | # Tidy up any obsolete recurrences. |
paul@606 | 602 | |
paul@606 | 603 | self.remove_freebusy_for_recurrences(freebusy, self.store.get_recurrences(self.user, self.uid)) |
paul@606 | 604 | self.store.set_freebusy_for_other(self.user, freebusy, user) |
paul@606 | 605 | |
paul@606 | 606 | def update_freebusy_from_organiser(self, organiser): |
paul@606 | 607 | |
paul@606 | 608 | "For the current user, record free/busy information from 'organiser'." |
paul@606 | 609 | |
paul@606 | 610 | self.update_freebusy_from_participant(organiser, True) |
paul@606 | 611 | |
paul@606 | 612 | def update_freebusy_from_attendees(self, attendees): |
paul@606 | 613 | |
paul@606 | 614 | "For the current user, record free/busy information from 'attendees'." |
paul@606 | 615 | |
paul@606 | 616 | for attendee in attendees.keys(): |
paul@606 | 617 | self.update_freebusy_from_participant(attendee, False) |
paul@606 | 618 | |
paul@441 | 619 | # vim: tabstop=4 expandtab shiftwidth=4 |