1 #!/usr/bin/env python 2 3 """ 4 Handlers for a person for whom scheduling is performed. 5 6 Copyright (C) 2014, 2015 Paul Boddie <paul@boddie.org.uk> 7 8 This program is free software; you can redistribute it and/or modify it under 9 the terms of the GNU General Public License as published by the Free Software 10 Foundation; either version 3 of the License, or (at your option) any later 11 version. 12 13 This program is distributed in the hope that it will be useful, but WITHOUT 14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 16 details. 17 18 You should have received a copy of the GNU General Public License along with 19 this program. If not, see <http://www.gnu.org/licenses/>. 20 """ 21 22 from imiptools.data import get_address, to_part, uri_dict, uri_item 23 from imiptools.handlers import Handler 24 from imiptools.handlers.common import CommonFreebusy, CommonEvent 25 from imiptools.period import FreeBusyPeriod, Period, replace_overlapping 26 27 class PersonHandler(CommonEvent, Handler): 28 29 "Event handling mechanisms specific to people." 30 31 def _add(self, queue=True): 32 33 """ 34 Add an event occurrence for the current object or produce a response 35 that requests the event details to be sent again. 36 """ 37 38 # Obtain valid organiser and attendee details. 39 40 oa = self.require_organiser_and_attendees() 41 if not oa: 42 return False 43 44 (organiser, organiser_attr), attendees = oa 45 46 # Request details where configured, doing so for unknown objects anyway. 47 48 if self.will_refresh(): 49 self.make_refresh() 50 51 # Record the event as a recurrence of the parent object. 52 53 self.update_recurrenceid() 54 55 # Update the recipient's record of the organiser's schedule. 56 57 self.update_freebusy_from_organiser(organiser) 58 59 # Stop if requesting the full event. 60 61 if self.will_refresh(): 62 return 63 64 # Set the additional occurrence. 65 66 self.store.set_event(self.user, self.uid, self.recurrenceid, self.obj.to_node()) 67 68 # Queue any request, if appropriate. 69 70 if queue: 71 self.store.queue_request(self.user, self.uid, self.recurrenceid) 72 73 return True 74 75 def _counter(self): 76 77 """ 78 Record details from a counter-proposal, updating the stored object with 79 attendance information. 80 """ 81 82 # Obtain valid organiser and attendee details. 83 84 oa = self.require_organiser_and_attendees(from_organiser=False) 85 if not oa: 86 return False 87 88 (organiser, organiser_attr), attendees = oa 89 90 # The responding attendee is regarded as not attending. 91 92 for attendee, attendee_attr in attendees.items(): 93 attendee_attr["PARTSTAT"] = "DECLINED" 94 95 # Update this attendance. 96 97 if self.merge_attendance(attendees): 98 self.update_freebusy_from_attendees(attendees) 99 100 # Queue any counter-proposal for perusal. 101 102 for attendee in attendees.keys(): 103 self.store.set_counter(self.user, attendee, self.obj.to_node(), self.uid, self.recurrenceid) 104 self.store.queue_request(self.user, self.uid, self.recurrenceid, "COUNTER") 105 106 return True 107 108 def _declinecounter(self): 109 110 "Revoke any counter-proposal recorded as a free/busy offer." 111 112 # Obtain valid organiser and attendee details. 113 114 oa = self.require_organiser_and_attendees() 115 if not oa: 116 return False 117 118 self.remove_event_from_freebusy_offers() 119 120 return True 121 122 def _publish(self): 123 124 "Record details of a published event." 125 126 # Handle an event being published by the sender to themself. 127 128 organiser_item = self.require_organiser() 129 if organiser_item: 130 organiser, organiser_attr = organiser_item 131 if self.user == organiser: 132 self.store.set_event(self.user, self.uid, self.recurrenceid, self.obj.to_node()) 133 return True 134 135 return self._record(from_organiser=True, queue=False) 136 137 def _record(self, from_organiser=True, queue=False, cancel=False): 138 139 """ 140 Record details from the current object given a message originating 141 from an organiser if 'from_organiser' is set to a true value, queuing a 142 request if 'queue' is set to a true value, or cancelling an event if 143 'cancel' is set to a true value. 144 """ 145 146 # Obtain valid organiser and attendee details. 147 148 oa = self.require_organiser_and_attendees(from_organiser) 149 if not oa: 150 return False 151 152 (organiser, organiser_attr), attendees = oa 153 154 # Handle notifications and invitations. 155 156 if from_organiser: 157 158 # Process for the current user, an attendee. 159 160 if not self.have_new_object(): 161 return False 162 163 # Remove additional recurrences if handling a complete event. 164 # Also remove any previous cancellations involving this event. 165 166 if not self.recurrenceid: 167 self.store.remove_recurrences(self.user, self.uid) 168 self.store.remove_cancellations(self.user, self.uid) 169 else: 170 self.store.remove_cancellation(self.user, self.uid, self.recurrenceid) 171 172 # Queue any request, if appropriate. 173 174 if queue: 175 self.store.queue_request(self.user, self.uid, self.recurrenceid) 176 177 # Cancel complete events or particular occurrences in recurring 178 # events. 179 180 if cancel: 181 self.store.cancel_event(self.user, self.uid, self.recurrenceid) 182 183 # Remove any associated request. 184 185 self.store.dequeue_request(self.user, self.uid, self.recurrenceid) 186 self.store.remove_counters(self.user, self.uid, self.recurrenceid) 187 188 # No return message will occur to update the free/busy 189 # information, so this is done here using outgoing message 190 # functionality. 191 192 self.remove_event_from_freebusy() 193 194 # Update the recipient's record of the organiser's schedule. 195 196 self.remove_freebusy_from_organiser(organiser) 197 198 else: 199 self.update_freebusy_from_organiser(organiser) 200 201 # Set the complete event or an additional occurrence. 202 203 self.store.set_event(self.user, self.uid, self.recurrenceid, self.obj.to_node()) 204 205 # As organiser, update attendance from valid attendees. 206 207 else: 208 if self.merge_attendance(attendees): 209 self.update_freebusy_from_attendees(attendees) 210 211 return True 212 213 def _refresh(self): 214 215 """ 216 Respond to a refresh message by providing complete event details to 217 attendees. 218 """ 219 220 # Obtain valid organiser and attendee details. 221 222 oa = self.require_organiser_and_attendees(False) 223 if not oa: 224 return False 225 226 (organiser, organiser_attr), attendees = oa 227 228 # Filter by stored attendees. 229 230 obj = self.get_stored_object_version() 231 stored_attendees = set(obj.get_values("ATTENDEE")) 232 attendees = stored_attendees.intersection(attendees) 233 234 if not attendees: 235 return False 236 237 # Assume that the outcome will be a request. It would not seem 238 # completely bizarre to produce a publishing message instead if a 239 # refresh message was unprovoked. 240 241 method = "REQUEST" 242 243 for attendee in attendees: 244 responses = [] 245 246 # Get the parent event, add SENT-BY details to the organiser. 247 248 obj = self.get_stored_object_version() 249 250 if self.is_participating(attendee, obj=obj): 251 organiser, organiser_attr = uri_item(obj.get_item("ORGANIZER")) 252 self.update_sender(organiser_attr) 253 responses.append(obj.to_node()) 254 255 # Get recurrences. 256 257 if not self.recurrenceid: 258 for recurrenceid in self.store.get_active_recurrences(self.user, self.uid): 259 260 # Get the recurrence, add SENT-BY details to the organiser. 261 262 obj = self.get_stored_object(self.uid, recurrenceid) 263 264 if self.is_participating(attendee, obj=obj): 265 organiser, organiser_attr = uri_item(obj.get_item("ORGANIZER")) 266 self.update_sender(organiser_attr) 267 responses.append(obj.to_node()) 268 269 self.add_result(method, [get_address(attendee)], to_part(method, responses)) 270 271 return True 272 273 class Event(PersonHandler): 274 275 "An event handler." 276 277 def add(self): 278 279 "Queue a suggested additional recurrence for any active event." 280 281 if self.allow_add() and self._add(queue=True): 282 return self.wrap("An addition to an event has been received.") 283 284 def cancel(self): 285 286 "Queue a cancellation of any active event." 287 288 if self._record(from_organiser=True, queue=False, cancel=True): 289 return self.wrap("An event cancellation has been received.", link=False) 290 291 def counter(self): 292 293 "Record a counter-proposal to a proposed event." 294 295 if self._counter(): 296 return self.wrap("A counter proposal to an event invitation has been received.", link=True) 297 298 def declinecounter(self): 299 300 "Record a rejection of a counter-proposal." 301 302 if self._declinecounter(): 303 return self.wrap("Your counter proposal to an event invitation has been declined.", link=True) 304 305 def publish(self): 306 307 "Register details of any relevant event." 308 309 if self._publish(): 310 return self.wrap("Details of an event have been received.") 311 312 def refresh(self): 313 314 "Requests to refresh events are handled either here or by the client." 315 316 if self.is_refreshing(): 317 return self._refresh() 318 else: 319 return self.wrap("A request for updated event details has been received.") 320 321 def reply(self): 322 323 "Record replies and notify the recipient." 324 325 if self._record(from_organiser=False, queue=False): 326 return self.wrap("A reply to an event invitation has been received.") 327 328 def request(self): 329 330 "Hold requests and notify the recipient." 331 332 if self._record(from_organiser=True, queue=True): 333 return self.wrap("An event invitation has been received.") 334 335 class PersonFreebusy(CommonFreebusy, Handler): 336 337 "Free/busy handling mechanisms specific to people." 338 339 def _record_freebusy(self, from_organiser=True): 340 341 """ 342 Record free/busy information for a message originating from an organiser 343 if 'from_organiser' is set to a true value. 344 """ 345 346 if from_organiser: 347 organiser_item = self.require_organiser(from_organiser) 348 if not organiser_item: 349 return 350 351 senders = [organiser_item] 352 else: 353 oa = self.require_organiser_and_attendees(from_organiser) 354 if not oa: 355 return 356 357 organiser_item, attendees = oa 358 senders = attendees.items() 359 360 if not senders: 361 return 362 363 freebusy = [FreeBusyPeriod(p.get_start_point(), p.get_end_point()) for p in self.obj.get_period_values("FREEBUSY")] 364 dtstart = self.obj.get_datetime("DTSTART") 365 dtend = self.obj.get_datetime("DTEND") 366 period = Period(dtstart, dtend, self.get_tzid()) 367 368 for sender, sender_attr in senders: 369 stored_freebusy = self.store.get_freebusy_for_other(self.user, sender) 370 replace_overlapping(stored_freebusy, period, freebusy) 371 self.store.set_freebusy_for_other(self.user, stored_freebusy, sender) 372 373 class Freebusy(PersonFreebusy): 374 375 "A free/busy handler." 376 377 def publish(self): 378 379 "Register free/busy information." 380 381 self._record_freebusy(from_organiser=True) 382 383 # Produce a message if configured to do so. 384 385 if self.is_notifying(): 386 return self.wrap("A free/busy update has been received.", link=False) 387 388 def reply(self): 389 390 "Record replies and notify the recipient." 391 392 self._record_freebusy(from_organiser=False) 393 394 # Produce a message if configured to do so. 395 396 if self.is_notifying(): 397 return self.wrap("A reply to a free/busy request has been received.", link=False) 398 399 def request(self): 400 401 """ 402 Respond to a request by preparing a reply containing free/busy 403 information for the recipient. 404 """ 405 406 # Produce a reply if configured to do so. 407 408 if self.is_sharing(): 409 return CommonFreebusy.request(self) 410 411 # Handler registry. 412 413 handlers = [ 414 ("VFREEBUSY", Freebusy), 415 ("VEVENT", Event), 416 ] 417 418 # vim: tabstop=4 expandtab shiftwidth=4