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@668 | 23 | from imiptools.config import MANAGER_INTERFACE |
paul@606 | 24 | from imiptools.data import Object, get_address, get_uri, get_window_end, \ |
paul@606 | 25 | is_new_object, make_freebusy, to_part, \ |
paul@604 | 26 | uri_dict, uri_items, uri_values |
paul@669 | 27 | from imiptools.dates import check_permitted_values, format_datetime, get_default_timezone, \ |
paul@627 | 28 | get_timestamp, to_timezone |
paul@606 | 29 | from imiptools.period import can_schedule, remove_period, \ |
paul@606 | 30 | remove_additional_periods, remove_affected_period, \ |
paul@606 | 31 | update_freebusy |
paul@443 | 32 | from imiptools.profile import Preferences |
paul@604 | 33 | import imip_store |
paul@441 | 34 | |
paul@443 | 35 | class Client: |
paul@443 | 36 | |
paul@443 | 37 | "Common handler and manager methods." |
paul@443 | 38 | |
paul@467 | 39 | default_window_size = 100 |
paul@467 | 40 | |
paul@639 | 41 | def __init__(self, user, messenger=None, store=None, publisher=None, preferences_dir=None): |
paul@443 | 42 | self.user = user |
paul@601 | 43 | self.messenger = messenger |
paul@604 | 44 | self.store = store or imip_store.FileStore() |
paul@604 | 45 | |
paul@604 | 46 | try: |
paul@604 | 47 | self.publisher = publisher or imip_store.FilePublisher() |
paul@604 | 48 | except OSError: |
paul@604 | 49 | self.publisher = None |
paul@604 | 50 | |
paul@639 | 51 | self.preferences_dir = preferences_dir |
paul@443 | 52 | self.preferences = None |
paul@443 | 53 | |
paul@443 | 54 | def get_preferences(self): |
paul@467 | 55 | if not self.preferences and self.user: |
paul@639 | 56 | self.preferences = Preferences(self.user, self.preferences_dir) |
paul@443 | 57 | return self.preferences |
paul@443 | 58 | |
paul@443 | 59 | def get_tzid(self): |
paul@443 | 60 | prefs = self.get_preferences() |
paul@467 | 61 | return prefs and prefs.get("TZID") or get_default_timezone() |
paul@443 | 62 | |
paul@443 | 63 | def get_window_size(self): |
paul@443 | 64 | prefs = self.get_preferences() |
paul@443 | 65 | try: |
paul@467 | 66 | return prefs and int(prefs.get("window_size")) or self.default_window_size |
paul@443 | 67 | except (TypeError, ValueError): |
paul@467 | 68 | return self.default_window_size |
paul@443 | 69 | |
paul@443 | 70 | def get_window_end(self): |
paul@443 | 71 | return get_window_end(self.get_tzid(), self.get_window_size()) |
paul@443 | 72 | |
paul@667 | 73 | def is_participating(self): |
paul@667 | 74 | prefs = self.get_preferences() |
paul@667 | 75 | return prefs and prefs.get("participating", "participate") != "no" or False |
paul@667 | 76 | |
paul@443 | 77 | def is_sharing(self): |
paul@467 | 78 | prefs = self.get_preferences() |
paul@467 | 79 | return prefs and prefs.get("freebusy_sharing") == "share" or False |
paul@443 | 80 | |
paul@443 | 81 | def is_bundling(self): |
paul@467 | 82 | prefs = self.get_preferences() |
paul@467 | 83 | return prefs and prefs.get("freebusy_bundling") == "always" or False |
paul@467 | 84 | |
paul@467 | 85 | def is_notifying(self): |
paul@467 | 86 | prefs = self.get_preferences() |
paul@467 | 87 | return prefs and prefs.get("freebusy_messages") == "notify" or False |
paul@443 | 88 | |
paul@688 | 89 | def is_refreshing(self): |
paul@688 | 90 | prefs = self.get_preferences() |
paul@688 | 91 | return prefs and prefs.get("event_refreshing") == "always" or False |
paul@688 | 92 | |
paul@668 | 93 | def have_manager(self): |
paul@668 | 94 | return MANAGER_INTERFACE |
paul@668 | 95 | |
paul@669 | 96 | def get_permitted_values(self): |
paul@655 | 97 | |
paul@655 | 98 | """ |
paul@655 | 99 | Decode a specification of one of the following forms... |
paul@655 | 100 | |
paul@655 | 101 | <minute values> |
paul@655 | 102 | <hour values>:<minute values> |
paul@655 | 103 | <hour values>:<minute values>:<second values> |
paul@655 | 104 | |
paul@655 | 105 | ...with each list of values being comma-separated. |
paul@655 | 106 | """ |
paul@655 | 107 | |
paul@655 | 108 | prefs = self.get_preferences() |
paul@669 | 109 | permitted_values = prefs and prefs.get("permitted_times") |
paul@669 | 110 | if permitted_values: |
paul@655 | 111 | try: |
paul@655 | 112 | l = [] |
paul@669 | 113 | for component in permitted_values.split(":")[:3]: |
paul@655 | 114 | if component: |
paul@655 | 115 | l.append(map(int, component.split(","))) |
paul@655 | 116 | else: |
paul@655 | 117 | l.append(None) |
paul@655 | 118 | |
paul@655 | 119 | # NOTE: Should probably report an error somehow. |
paul@655 | 120 | |
paul@655 | 121 | except ValueError: |
paul@655 | 122 | return None |
paul@655 | 123 | else: |
paul@655 | 124 | l = (len(l) < 2 and [None] or []) + l + (len(l) < 3 and [None] or []) |
paul@655 | 125 | return l |
paul@655 | 126 | else: |
paul@655 | 127 | return None |
paul@655 | 128 | |
paul@581 | 129 | # Common operations on calendar data. |
paul@581 | 130 | |
paul@619 | 131 | def update_attendees(self, obj, attendees, removed): |
paul@619 | 132 | |
paul@619 | 133 | """ |
paul@619 | 134 | Update the attendees in 'obj' with the given 'attendees' and 'removed' |
paul@619 | 135 | attendee lists. A list is returned containing the attendees whose |
paul@619 | 136 | attendance should be cancelled. |
paul@619 | 137 | """ |
paul@619 | 138 | |
paul@619 | 139 | to_cancel = [] |
paul@619 | 140 | |
paul@619 | 141 | existing_attendees = uri_values(obj.get_values("ATTENDEE") or []) |
paul@619 | 142 | added = set(attendees).difference(existing_attendees) |
paul@619 | 143 | |
paul@619 | 144 | if added or removed: |
paul@619 | 145 | attendees = uri_items(obj.get_items("ATTENDEE") or []) |
paul@619 | 146 | sequence = obj.get_value("SEQUENCE") |
paul@619 | 147 | |
paul@619 | 148 | if removed: |
paul@619 | 149 | remaining = [] |
paul@619 | 150 | |
paul@619 | 151 | for attendee, attendee_attr in attendees: |
paul@619 | 152 | if attendee in removed: |
paul@619 | 153 | |
paul@619 | 154 | # Without a sequence number, assume that the event has not |
paul@619 | 155 | # been published and that attendees can be silently removed. |
paul@619 | 156 | |
paul@619 | 157 | if sequence is not None: |
paul@619 | 158 | to_cancel.append((attendee, attendee_attr)) |
paul@619 | 159 | else: |
paul@619 | 160 | remaining.append((attendee, attendee_attr)) |
paul@619 | 161 | |
paul@619 | 162 | attendees = remaining |
paul@619 | 163 | |
paul@619 | 164 | if added: |
paul@619 | 165 | for attendee in added: |
paul@619 | 166 | attendee = attendee.strip() |
paul@619 | 167 | if attendee: |
paul@619 | 168 | attendees.append((get_uri(attendee), {"PARTSTAT" : "NEEDS-ACTION", "RSVP" : "TRUE"})) |
paul@619 | 169 | |
paul@619 | 170 | obj["ATTENDEE"] = attendees |
paul@619 | 171 | |
paul@619 | 172 | return to_cancel |
paul@619 | 173 | |
paul@582 | 174 | def update_participation(self, obj, partstat=None): |
paul@581 | 175 | |
paul@581 | 176 | """ |
paul@581 | 177 | Update the participation in 'obj' of the user with the given 'partstat'. |
paul@581 | 178 | """ |
paul@581 | 179 | |
paul@581 | 180 | attendee_attr = uri_dict(obj.get_value_map("ATTENDEE")).get(self.user) |
paul@582 | 181 | if not attendee_attr: |
paul@582 | 182 | return None |
paul@582 | 183 | if partstat: |
paul@582 | 184 | attendee_attr["PARTSTAT"] = partstat |
paul@581 | 185 | if attendee_attr.has_key("RSVP"): |
paul@581 | 186 | del attendee_attr["RSVP"] |
paul@584 | 187 | self.update_sender(attendee_attr) |
paul@581 | 188 | return attendee_attr |
paul@581 | 189 | |
paul@584 | 190 | def update_sender(self, attr): |
paul@584 | 191 | |
paul@584 | 192 | "Update the SENT-BY attribute of the 'attr' sender metadata." |
paul@584 | 193 | |
paul@584 | 194 | if self.messenger and self.messenger.sender != get_address(self.user): |
paul@584 | 195 | attr["SENT-BY"] = get_uri(self.messenger.sender) |
paul@584 | 196 | |
paul@606 | 197 | def get_periods(self, obj): |
paul@606 | 198 | |
paul@606 | 199 | """ |
paul@606 | 200 | Return periods for the given 'obj'. Interpretation of periods can depend |
paul@606 | 201 | on the time zone, which is obtained for the current user. |
paul@606 | 202 | """ |
paul@606 | 203 | |
paul@606 | 204 | return obj.get_periods(self.get_tzid(), self.get_window_end()) |
paul@606 | 205 | |
paul@606 | 206 | # Store operations. |
paul@606 | 207 | |
paul@606 | 208 | def get_stored_object(self, uid, recurrenceid): |
paul@606 | 209 | |
paul@606 | 210 | """ |
paul@606 | 211 | Return the stored object for the current user, with the given 'uid' and |
paul@606 | 212 | 'recurrenceid'. |
paul@606 | 213 | """ |
paul@606 | 214 | |
paul@606 | 215 | fragment = self.store.get_event(self.user, uid, recurrenceid) |
paul@606 | 216 | return fragment and Object(fragment) |
paul@606 | 217 | |
paul@604 | 218 | # Free/busy operations. |
paul@604 | 219 | |
paul@606 | 220 | def get_freebusy_part(self, freebusy=None): |
paul@604 | 221 | |
paul@604 | 222 | """ |
paul@606 | 223 | Return a message part containing free/busy information for the user, |
paul@606 | 224 | either specified as 'freebusy' or obtained from the store directly. |
paul@604 | 225 | """ |
paul@604 | 226 | |
paul@604 | 227 | if self.is_sharing() and self.is_bundling(): |
paul@604 | 228 | |
paul@604 | 229 | # Invent a unique identifier. |
paul@604 | 230 | |
paul@604 | 231 | utcnow = get_timestamp() |
paul@604 | 232 | uid = "imip-agent-%s-%s" % (utcnow, get_address(self.user)) |
paul@604 | 233 | |
paul@606 | 234 | freebusy = freebusy or self.store.get_freebusy(self.user) |
paul@604 | 235 | |
paul@604 | 236 | user_attr = {} |
paul@604 | 237 | self.update_sender(user_attr) |
paul@604 | 238 | return to_part("PUBLISH", [make_freebusy(freebusy, uid, self.user, user_attr)]) |
paul@604 | 239 | |
paul@604 | 240 | return None |
paul@604 | 241 | |
paul@606 | 242 | def update_freebusy(self, freebusy, periods, transp, uid, recurrenceid, summary, organiser): |
paul@606 | 243 | |
paul@606 | 244 | """ |
paul@606 | 245 | Update the 'freebusy' collection with the given 'periods', indicating a |
paul@606 | 246 | 'transp' status, explicit 'uid' and 'recurrenceid' to indicate either a |
paul@606 | 247 | recurrence or the parent event. The 'summary' and 'organiser' must also |
paul@606 | 248 | be provided. |
paul@606 | 249 | """ |
paul@606 | 250 | |
paul@612 | 251 | update_freebusy(freebusy, periods, transp, uid, recurrenceid, summary, organiser) |
paul@606 | 252 | |
paul@601 | 253 | class ClientForObject(Client): |
paul@601 | 254 | |
paul@601 | 255 | "A client maintaining a specific object." |
paul@601 | 256 | |
paul@639 | 257 | def __init__(self, obj, user, messenger=None, store=None, publisher=None, preferences_dir=None): |
paul@639 | 258 | Client.__init__(self, user, messenger, store, publisher, preferences_dir) |
paul@601 | 259 | self.set_object(obj) |
paul@601 | 260 | |
paul@601 | 261 | def set_object(self, obj): |
paul@606 | 262 | |
paul@606 | 263 | "Set the current object to 'obj', obtaining metadata details." |
paul@606 | 264 | |
paul@601 | 265 | self.obj = obj |
paul@601 | 266 | self.uid = obj and self.obj.get_uid() |
paul@601 | 267 | self.recurrenceid = obj and self.obj.get_recurrenceid() |
paul@601 | 268 | self.sequence = obj and self.obj.get_value("SEQUENCE") |
paul@601 | 269 | self.dtstamp = obj and self.obj.get_value("DTSTAMP") |
paul@601 | 270 | |
paul@604 | 271 | # Object update methods. |
paul@601 | 272 | |
paul@676 | 273 | def update_recurrenceid(self): |
paul@676 | 274 | |
paul@676 | 275 | """ |
paul@676 | 276 | Update the RECURRENCE-ID in the current object, initialising it from |
paul@676 | 277 | DTSTART. |
paul@676 | 278 | """ |
paul@676 | 279 | |
paul@680 | 280 | self.obj["RECURRENCE-ID"] = [self.obj.get_item("DTSTART")] |
paul@676 | 281 | self.recurrenceid = self.obj.get_recurrenceid() |
paul@676 | 282 | |
paul@601 | 283 | def update_dtstamp(self): |
paul@601 | 284 | |
paul@601 | 285 | "Update the DTSTAMP in the current object." |
paul@601 | 286 | |
paul@601 | 287 | dtstamp = self.obj.get_utc_datetime("DTSTAMP") |
paul@601 | 288 | utcnow = to_timezone(datetime.utcnow(), "UTC") |
paul@676 | 289 | self.dtstamp = format_datetime(dtstamp > utcnow and dtstamp or utcnow) |
paul@676 | 290 | self.obj["DTSTAMP"] = [(self.dtstamp, {})] |
paul@601 | 291 | |
paul@601 | 292 | def set_sequence(self, increment=False): |
paul@601 | 293 | |
paul@601 | 294 | "Update the SEQUENCE in the current object." |
paul@601 | 295 | |
paul@601 | 296 | sequence = self.obj.get_value("SEQUENCE") or "0" |
paul@601 | 297 | self.obj["SEQUENCE"] = [(str(int(sequence) + (increment and 1 or 0)), {})] |
paul@601 | 298 | |
paul@606 | 299 | def merge_attendance(self, attendees): |
paul@606 | 300 | |
paul@606 | 301 | """ |
paul@606 | 302 | Merge attendance from the current object's 'attendees' into the version |
paul@606 | 303 | stored for the current user. |
paul@606 | 304 | """ |
paul@606 | 305 | |
paul@606 | 306 | obj = self.get_stored_object_version() |
paul@606 | 307 | |
paul@606 | 308 | if not obj or not self.have_new_object(obj): |
paul@606 | 309 | return False |
paul@606 | 310 | |
paul@606 | 311 | # Get attendee details in a usable form. |
paul@606 | 312 | |
paul@606 | 313 | attendee_map = uri_dict(obj.get_value_map("ATTENDEE")) |
paul@606 | 314 | |
paul@606 | 315 | for attendee, attendee_attr in attendees.items(): |
paul@606 | 316 | |
paul@606 | 317 | # Update attendance in the loaded object. |
paul@606 | 318 | |
paul@606 | 319 | attendee_map[attendee] = attendee_attr |
paul@606 | 320 | |
paul@606 | 321 | # Set the new details and store the object. |
paul@606 | 322 | |
paul@606 | 323 | obj["ATTENDEE"] = attendee_map.items() |
paul@606 | 324 | |
paul@606 | 325 | # Set the complete event if not an additional occurrence. |
paul@606 | 326 | |
paul@606 | 327 | event = obj.to_node() |
paul@606 | 328 | self.store.set_event(self.user, self.uid, self.recurrenceid, event) |
paul@606 | 329 | |
paul@606 | 330 | return True |
paul@606 | 331 | |
paul@606 | 332 | # Object-related tests. |
paul@606 | 333 | |
paul@694 | 334 | def get_attendance(self, user=None, obj=None): |
paul@606 | 335 | |
paul@606 | 336 | """ |
paul@606 | 337 | Return the attendance attributes for 'user', or the current user if |
paul@606 | 338 | 'user' is not specified. |
paul@606 | 339 | """ |
paul@606 | 340 | |
paul@694 | 341 | attendees = uri_dict((obj or self.obj).get_value_map("ATTENDEE")) |
paul@697 | 342 | return attendees.get(user or self.user) |
paul@606 | 343 | |
paul@694 | 344 | def is_participating(self, user, as_organiser=False, obj=None): |
paul@609 | 345 | |
paul@609 | 346 | """ |
paul@609 | 347 | Return whether, subject to the 'user' indicating an identity and the |
paul@609 | 348 | 'as_organiser' status of that identity, the user concerned is actually |
paul@609 | 349 | participating in the current object event. |
paul@609 | 350 | """ |
paul@609 | 351 | |
paul@697 | 352 | # Use any attendee property information for an organiser, not the |
paul@697 | 353 | # organiser property attributes. |
paul@697 | 354 | |
paul@694 | 355 | attr = self.get_attendance(user, obj=obj) |
paul@697 | 356 | return as_organiser or attr is not None and not attr or attr and attr.get("PARTSTAT") != "DECLINED" |
paul@609 | 357 | |
paul@609 | 358 | def get_overriding_transparency(self, user, as_organiser=False): |
paul@609 | 359 | |
paul@609 | 360 | """ |
paul@609 | 361 | Return the overriding transparency to be associated with the free/busy |
paul@609 | 362 | records for an event, subject to the 'user' indicating an identity and |
paul@609 | 363 | the 'as_organiser' status of that identity. |
paul@609 | 364 | |
paul@609 | 365 | Where an identity is only an organiser and not attending, "ORG" is |
paul@609 | 366 | returned. Otherwise, no overriding transparency is defined and None is |
paul@609 | 367 | returned. |
paul@609 | 368 | """ |
paul@609 | 369 | |
paul@609 | 370 | attr = self.get_attendance(user) |
paul@609 | 371 | return as_organiser and not (attr and attr.get("PARTSTAT")) and "ORG" or None |
paul@609 | 372 | |
paul@606 | 373 | def is_attendee(self, identity, obj=None): |
paul@606 | 374 | |
paul@606 | 375 | """ |
paul@606 | 376 | Return whether 'identity' is an attendee in the current object, or in |
paul@606 | 377 | 'obj' if specified. |
paul@606 | 378 | """ |
paul@606 | 379 | |
paul@606 | 380 | return identity in uri_values((obj or self.obj).get_values("ATTENDEE")) |
paul@606 | 381 | |
paul@606 | 382 | def can_schedule(self, freebusy, periods): |
paul@606 | 383 | |
paul@606 | 384 | """ |
paul@606 | 385 | Indicate whether within 'freebusy' the given 'periods' can be scheduled. |
paul@606 | 386 | """ |
paul@606 | 387 | |
paul@606 | 388 | return can_schedule(freebusy, periods, self.uid, self.recurrenceid) |
paul@606 | 389 | |
paul@682 | 390 | def have_new_object(self, obj=None, strict=True): |
paul@606 | 391 | |
paul@606 | 392 | """ |
paul@606 | 393 | Return whether the current object is new to the current user (or if the |
paul@682 | 394 | given 'obj' is new). If 'strict' is specified and is a false value, the |
paul@682 | 395 | DTSTAMP test will be ignored. This is useful in handling responses from |
paul@682 | 396 | attendees from clients (like Claws Mail) that erase time information |
paul@682 | 397 | from DTSTAMP and make it invalid. |
paul@606 | 398 | """ |
paul@606 | 399 | |
paul@606 | 400 | obj = obj or self.get_stored_object_version() |
paul@606 | 401 | |
paul@606 | 402 | # If found, compare SEQUENCE and potentially DTSTAMP. |
paul@606 | 403 | |
paul@606 | 404 | if obj: |
paul@606 | 405 | sequence = obj.get_value("SEQUENCE") |
paul@606 | 406 | dtstamp = obj.get_value("DTSTAMP") |
paul@606 | 407 | |
paul@606 | 408 | # If the request refers to an older version of the object, ignore |
paul@606 | 409 | # it. |
paul@606 | 410 | |
paul@682 | 411 | return is_new_object(sequence, self.sequence, dtstamp, self.dtstamp, not strict) |
paul@606 | 412 | |
paul@606 | 413 | return True |
paul@606 | 414 | |
paul@672 | 415 | def possibly_recurring_indefinitely(self): |
paul@672 | 416 | |
paul@672 | 417 | "Return whether the object recurs indefinitely." |
paul@672 | 418 | |
paul@672 | 419 | # Obtain the stored object to make sure that recurrence information |
paul@672 | 420 | # is not being ignored. This might happen if a client sends a |
paul@672 | 421 | # cancellation without the complete set of properties, for instance. |
paul@672 | 422 | |
paul@672 | 423 | return self.obj.possibly_recurring_indefinitely() or \ |
paul@672 | 424 | self.get_stored_object_version() and \ |
paul@672 | 425 | self.get_stored_object_version().possibly_recurring_indefinitely() |
paul@672 | 426 | |
paul@655 | 427 | # Constraint application on event periods. |
paul@655 | 428 | |
paul@655 | 429 | def check_object(self): |
paul@655 | 430 | |
paul@655 | 431 | "Check the object against any scheduling constraints." |
paul@655 | 432 | |
paul@669 | 433 | permitted_values = self.get_permitted_values() |
paul@669 | 434 | if not permitted_values: |
paul@655 | 435 | return None |
paul@655 | 436 | |
paul@655 | 437 | invalid = [] |
paul@655 | 438 | |
paul@660 | 439 | for period in self.obj.get_periods(self.get_tzid()): |
paul@655 | 440 | start = period.get_start() |
paul@655 | 441 | end = period.get_end() |
paul@669 | 442 | start_errors = check_permitted_values(start, permitted_values) |
paul@669 | 443 | end_errors = check_permitted_values(end, permitted_values) |
paul@656 | 444 | if start_errors or end_errors: |
paul@656 | 445 | invalid.append((period.origin, start_errors, end_errors)) |
paul@655 | 446 | |
paul@655 | 447 | return invalid |
paul@655 | 448 | |
paul@660 | 449 | def correct_object(self): |
paul@655 | 450 | |
paul@660 | 451 | "Correct the object according to any scheduling constraints." |
paul@655 | 452 | |
paul@669 | 453 | permitted_values = self.get_permitted_values() |
paul@669 | 454 | return permitted_values and self.obj.correct_object(self.get_tzid(), permitted_values) |
paul@655 | 455 | |
paul@606 | 456 | # Object retrieval. |
paul@606 | 457 | |
paul@606 | 458 | def get_stored_object_version(self): |
paul@606 | 459 | |
paul@606 | 460 | """ |
paul@606 | 461 | Return the stored object to which the current object refers for the |
paul@606 | 462 | current user. |
paul@606 | 463 | """ |
paul@606 | 464 | |
paul@606 | 465 | return self.get_stored_object(self.uid, self.recurrenceid) |
paul@606 | 466 | |
paul@704 | 467 | def get_definitive_object(self, as_organiser): |
paul@606 | 468 | |
paul@606 | 469 | """ |
paul@606 | 470 | Return an object considered definitive for the current transaction, |
paul@704 | 471 | using 'as_organiser' to select the current transaction's object if |
paul@704 | 472 | false, or selecting a stored object if true. |
paul@606 | 473 | """ |
paul@606 | 474 | |
paul@704 | 475 | return not as_organiser and self.obj or self.get_stored_object_version() |
paul@606 | 476 | |
paul@606 | 477 | def get_parent_object(self): |
paul@606 | 478 | |
paul@606 | 479 | """ |
paul@606 | 480 | Return the parent object to which the current object refers for the |
paul@606 | 481 | current user. |
paul@606 | 482 | """ |
paul@606 | 483 | |
paul@606 | 484 | return self.recurrenceid and self.get_stored_object(self.uid, None) or None |
paul@606 | 485 | |
paul@606 | 486 | # Convenience methods for modifying free/busy collections. |
paul@606 | 487 | |
paul@606 | 488 | def get_recurrence_start_point(self, recurrenceid): |
paul@606 | 489 | |
paul@606 | 490 | "Get 'recurrenceid' in a form suitable for matching free/busy entries." |
paul@606 | 491 | |
paul@627 | 492 | return self.obj.get_recurrence_start_point(recurrenceid, self.get_tzid()) |
paul@606 | 493 | |
paul@606 | 494 | def remove_from_freebusy(self, freebusy): |
paul@606 | 495 | |
paul@606 | 496 | "Remove this event from the given 'freebusy' collection." |
paul@606 | 497 | |
paul@606 | 498 | if not remove_period(freebusy, self.uid, self.recurrenceid) and self.recurrenceid: |
paul@606 | 499 | remove_affected_period(freebusy, self.uid, self.get_recurrence_start_point(self.recurrenceid)) |
paul@606 | 500 | |
paul@606 | 501 | def remove_freebusy_for_recurrences(self, freebusy, recurrenceids=None): |
paul@606 | 502 | |
paul@606 | 503 | """ |
paul@606 | 504 | Remove from 'freebusy' any original recurrence from parent free/busy |
paul@606 | 505 | details for the current object, if the current object is a specific |
paul@606 | 506 | additional recurrence. Otherwise, remove all additional recurrence |
paul@606 | 507 | information corresponding to 'recurrenceids', or if omitted, all |
paul@606 | 508 | recurrences. |
paul@606 | 509 | """ |
paul@606 | 510 | |
paul@606 | 511 | if self.recurrenceid: |
paul@606 | 512 | recurrenceid = self.get_recurrence_start_point(self.recurrenceid) |
paul@606 | 513 | remove_affected_period(freebusy, self.uid, recurrenceid) |
paul@606 | 514 | else: |
paul@606 | 515 | # Remove obsolete recurrence periods. |
paul@606 | 516 | |
paul@606 | 517 | remove_additional_periods(freebusy, self.uid, recurrenceids) |
paul@606 | 518 | |
paul@606 | 519 | # Remove original periods affected by additional recurrences. |
paul@606 | 520 | |
paul@606 | 521 | if recurrenceids: |
paul@606 | 522 | for recurrenceid in recurrenceids: |
paul@606 | 523 | recurrenceid = self.get_recurrence_start_point(recurrenceid) |
paul@606 | 524 | remove_affected_period(freebusy, self.uid, recurrenceid) |
paul@606 | 525 | |
paul@704 | 526 | def update_freebusy(self, freebusy, user, as_organiser): |
paul@606 | 527 | |
paul@606 | 528 | """ |
paul@606 | 529 | Update the 'freebusy' collection for this event with the periods and |
paul@606 | 530 | transparency associated with the current object, subject to the 'user' |
paul@606 | 531 | identity and the attendance details provided for them, indicating |
paul@704 | 532 | whether the update is being done 'as_organiser' (for the organiser of |
paul@676 | 533 | an event) 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@704 | 540 | obj = self.get_definitive_object(as_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@704 | 551 | transp = self.get_overriding_transparency(user, as_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@695 | 566 | Update the 'freebusy' collection for the given 'user', indicating |
paul@695 | 567 | whether the update is 'for_organiser' (being done for the organiser of |
paul@695 | 568 | an event) or not, and whether it is 'updating_other' (meaning another |
paul@695 | 569 | user's details). |
paul@606 | 570 | """ |
paul@606 | 571 | |
paul@606 | 572 | # Record in the free/busy details unless a non-participating attendee. |
paul@697 | 573 | # Remove periods for non-participating attendees. |
paul@606 | 574 | |
paul@606 | 575 | if self.is_participating(user, for_organiser and not updating_other): |
paul@704 | 576 | self.update_freebusy(freebusy, user, |
paul@704 | 577 | for_organiser and not updating_other or |
paul@704 | 578 | not for_organiser and updating_other |
paul@704 | 579 | ) |
paul@606 | 580 | else: |
paul@606 | 581 | self.remove_from_freebusy(freebusy) |
paul@606 | 582 | |
paul@697 | 583 | def remove_freebusy_for_participant(self, freebusy, user, for_organiser=False, |
paul@697 | 584 | updating_other=False): |
paul@697 | 585 | |
paul@697 | 586 | """ |
paul@697 | 587 | Remove details from the 'freebusy' collection for the given 'user', |
paul@697 | 588 | indicating whether the modification is 'for_organiser' (being done for |
paul@697 | 589 | the organiser of an event) or not, and whether it is 'updating_other' |
paul@697 | 590 | (meaning another user's details). |
paul@697 | 591 | """ |
paul@697 | 592 | |
paul@697 | 593 | # Remove from the free/busy details if a specified attendee. |
paul@697 | 594 | |
paul@697 | 595 | if self.is_participating(user, for_organiser and not updating_other): |
paul@697 | 596 | self.remove_from_freebusy(freebusy) |
paul@697 | 597 | |
paul@606 | 598 | # Convenience methods for updating stored free/busy information received |
paul@606 | 599 | # from other users. |
paul@606 | 600 | |
paul@697 | 601 | def update_freebusy_from_participant(self, user, for_organiser, fn=None): |
paul@606 | 602 | |
paul@606 | 603 | """ |
paul@606 | 604 | For the current user, record the free/busy information for another |
paul@606 | 605 | 'user', indicating whether the update is 'for_organiser' or not, thus |
paul@606 | 606 | maintaining a separate record of their free/busy details. |
paul@606 | 607 | """ |
paul@606 | 608 | |
paul@697 | 609 | fn = fn or self.update_freebusy_for_participant |
paul@697 | 610 | |
paul@606 | 611 | # A user does not store free/busy information for themself as another |
paul@606 | 612 | # party. |
paul@606 | 613 | |
paul@606 | 614 | if user == self.user: |
paul@606 | 615 | return |
paul@606 | 616 | |
paul@702 | 617 | freebusy = self.store.get_freebusy_for_other_for_update(self.user, user) |
paul@702 | 618 | try: |
paul@702 | 619 | fn(freebusy, user, for_organiser, True) |
paul@702 | 620 | |
paul@702 | 621 | # Tidy up any obsolete recurrences. |
paul@606 | 622 | |
paul@702 | 623 | self.remove_freebusy_for_recurrences(freebusy, self.store.get_recurrences(self.user, self.uid)) |
paul@702 | 624 | self.store.set_freebusy_for_other_in_update(self.user, freebusy, user) |
paul@606 | 625 | |
paul@702 | 626 | finally: |
paul@702 | 627 | self.store.release_freebusy(self.user) |
paul@606 | 628 | |
paul@606 | 629 | def update_freebusy_from_organiser(self, organiser): |
paul@606 | 630 | |
paul@606 | 631 | "For the current user, record free/busy information from 'organiser'." |
paul@606 | 632 | |
paul@606 | 633 | self.update_freebusy_from_participant(organiser, True) |
paul@606 | 634 | |
paul@606 | 635 | def update_freebusy_from_attendees(self, attendees): |
paul@606 | 636 | |
paul@606 | 637 | "For the current user, record free/busy information from 'attendees'." |
paul@606 | 638 | |
paul@606 | 639 | for attendee in attendees.keys(): |
paul@606 | 640 | self.update_freebusy_from_participant(attendee, False) |
paul@606 | 641 | |
paul@697 | 642 | def remove_freebusy_from_organiser(self, organiser): |
paul@697 | 643 | |
paul@697 | 644 | "For the current user, remove free/busy information from 'organiser'." |
paul@697 | 645 | |
paul@697 | 646 | self.update_freebusy_from_participant(organiser, True, self.remove_freebusy_for_participant) |
paul@697 | 647 | |
paul@697 | 648 | def remove_freebusy_from_attendees(self, attendees): |
paul@697 | 649 | |
paul@697 | 650 | "For the current user, remove free/busy information from 'attendees'." |
paul@697 | 651 | |
paul@697 | 652 | for attendee in attendees.keys(): |
paul@697 | 653 | self.update_freebusy_from_participant(attendee, False, self.remove_freebusy_for_participant) |
paul@697 | 654 | |
paul@441 | 655 | # vim: tabstop=4 expandtab shiftwidth=4 |