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 _record(self, from_organiser=True, queue=False, cancel=False): 109 110 """ 111 Record details from the current object given a message originating 112 from an organiser if 'from_organiser' is set to a true value, queuing a 113 request if 'queue' is set to a true value, or cancelling an event if 114 'cancel' is set to a true value. 115 """ 116 117 # Obtain valid organiser and attendee details. 118 119 oa = self.require_organiser_and_attendees(from_organiser) 120 if not oa: 121 return False 122 123 (organiser, organiser_attr), attendees = oa 124 125 # Handle notifications and invitations. 126 127 if from_organiser: 128 129 # Process for the current user, an attendee. 130 131 if not self.have_new_object(): 132 return False 133 134 # Remove additional recurrences if handling a complete event. 135 # Also remove any previous cancellations involving this event. 136 137 if not self.recurrenceid: 138 self.store.remove_recurrences(self.user, self.uid) 139 self.store.remove_cancellations(self.user, self.uid) 140 else: 141 self.store.remove_cancellation(self.user, self.uid, self.recurrenceid) 142 143 # Queue any request, if appropriate. 144 145 if queue: 146 self.store.queue_request(self.user, self.uid, self.recurrenceid) 147 148 # Cancel complete events or particular occurrences in recurring 149 # events. 150 151 if cancel: 152 self.store.cancel_event(self.user, self.uid, self.recurrenceid) 153 self.store.dequeue_request(self.user, self.uid, self.recurrenceid) 154 155 # Remove any associated request. 156 157 self.store.dequeue_request(self.user, self.uid, self.recurrenceid) 158 159 # No return message will occur to update the free/busy 160 # information, so this is done here using outgoing message 161 # functionality. 162 163 self.remove_event_from_freebusy() 164 165 # Update the recipient's record of the organiser's schedule. 166 167 self.remove_freebusy_from_organiser(organiser) 168 169 else: 170 self.update_freebusy_from_organiser(organiser) 171 172 # Set the complete event or an additional occurrence. 173 174 self.store.set_event(self.user, self.uid, self.recurrenceid, self.obj.to_node()) 175 176 # As organiser, update attendance from valid attendees. 177 178 else: 179 if self.merge_attendance(attendees): 180 self.update_freebusy_from_attendees(attendees) 181 182 return True 183 184 def _refresh(self): 185 186 """ 187 Respond to a refresh message by providing complete event details to 188 attendees. 189 """ 190 191 # Obtain valid organiser and attendee details. 192 193 oa = self.require_organiser_and_attendees(False) 194 if not oa: 195 return False 196 197 (organiser, organiser_attr), attendees = oa 198 199 # Filter by stored attendees. 200 201 obj = self.get_stored_object_version() 202 stored_attendees = set(obj.get_values("ATTENDEE")) 203 attendees = stored_attendees.intersection(attendees) 204 205 if not attendees: 206 return False 207 208 # Assume that the outcome will be a request. It would not seem 209 # completely bizarre to produce a publishing message instead if a 210 # refresh message was unprovoked. 211 212 method = "REQUEST" 213 214 for attendee in attendees: 215 responses = [] 216 217 # Get the parent event, add SENT-BY details to the organiser. 218 219 obj = self.get_stored_object_version() 220 221 if self.is_participating(attendee, obj=obj): 222 organiser, organiser_attr = uri_item(obj.get_item("ORGANIZER")) 223 self.update_sender(organiser_attr) 224 responses.append(obj.to_node()) 225 226 # Get recurrences. 227 228 if not self.recurrenceid: 229 for recurrenceid in self.store.get_active_recurrences(self.user, self.uid): 230 231 # Get the recurrence, add SENT-BY details to the organiser. 232 233 obj = self.get_stored_object(self.uid, recurrenceid) 234 235 if self.is_participating(attendee, obj=obj): 236 organiser, organiser_attr = uri_item(obj.get_item("ORGANIZER")) 237 self.update_sender(organiser_attr) 238 responses.append(obj.to_node()) 239 240 self.add_result(method, [get_address(attendee)], to_part(method, responses)) 241 242 return True 243 244 class Event(PersonHandler): 245 246 "An event handler." 247 248 def add(self): 249 250 "Queue a suggested additional recurrence for any active event." 251 252 if self.allow_add() and self._add(queue=True): 253 return self.wrap("An addition to an event has been received.") 254 255 def cancel(self): 256 257 "Queue a cancellation of any active event." 258 259 if self._record(from_organiser=True, queue=False, cancel=True): 260 return self.wrap("An event cancellation has been received.", link=False) 261 262 def counter(self): 263 264 "Record a counter-proposal to a proposed event." 265 266 if self._counter(): 267 return self.wrap("A counter proposal to an event invitation has been received.", link=False) 268 269 def declinecounter(self): 270 271 # NOTE: Queue a rejected modification to any active event. 272 273 return self.wrap("Your counter proposal to an event invitation has been declined.", link=False) 274 275 def publish(self): 276 277 "Register details of any relevant event." 278 279 if self._record(from_organiser=True, queue=False): 280 return self.wrap("Details of an event have been received.") 281 282 def refresh(self): 283 284 "Requests to refresh events are handled either here or by the client." 285 286 if self.is_refreshing(): 287 return self._refresh() 288 else: 289 return self.wrap("A request for updated event details has been received.") 290 291 def reply(self): 292 293 "Record replies and notify the recipient." 294 295 if self._record(from_organiser=False, queue=False): 296 return self.wrap("A reply to an event invitation has been received.") 297 298 def request(self): 299 300 "Hold requests and notify the recipient." 301 302 if self._record(from_organiser=True, queue=True): 303 return self.wrap("An event invitation has been received.") 304 305 class PersonFreebusy(CommonFreebusy, Handler): 306 307 "Free/busy handling mechanisms specific to people." 308 309 def _record_freebusy(self, from_organiser=True): 310 311 """ 312 Record free/busy information for a message originating from an organiser 313 if 'from_organiser' is set to a true value. 314 """ 315 316 if from_organiser: 317 organiser_item = self.require_organiser(from_organiser) 318 if not organiser_item: 319 return 320 321 senders = [organiser_item] 322 else: 323 oa = self.require_organiser_and_attendees(from_organiser) 324 if not oa: 325 return 326 327 organiser_item, attendees = oa 328 senders = attendees.items() 329 330 if not senders: 331 return 332 333 freebusy = [FreeBusyPeriod(p.get_start_point(), p.get_end_point()) for p in self.obj.get_period_values("FREEBUSY")] 334 dtstart = self.obj.get_datetime("DTSTART") 335 dtend = self.obj.get_datetime("DTEND") 336 period = Period(dtstart, dtend, self.get_tzid()) 337 338 for sender, sender_attr in senders: 339 stored_freebusy = self.store.get_freebusy_for_other(self.user, sender) 340 replace_overlapping(stored_freebusy, period, freebusy) 341 self.store.set_freebusy_for_other(self.user, stored_freebusy, sender) 342 343 class Freebusy(PersonFreebusy): 344 345 "A free/busy handler." 346 347 def publish(self): 348 349 "Register free/busy information." 350 351 self._record_freebusy(from_organiser=True) 352 353 # Produce a message if configured to do so. 354 355 if self.is_notifying(): 356 return self.wrap("A free/busy update has been received.", link=False) 357 358 def reply(self): 359 360 "Record replies and notify the recipient." 361 362 self._record_freebusy(from_organiser=False) 363 364 # Produce a message if configured to do so. 365 366 if self.is_notifying(): 367 return self.wrap("A reply to a free/busy request has been received.", link=False) 368 369 def request(self): 370 371 """ 372 Respond to a request by preparing a reply containing free/busy 373 information for the recipient. 374 """ 375 376 # Produce a reply if configured to do so. 377 378 if self.is_sharing(): 379 return CommonFreebusy.request(self) 380 381 # Handler registry. 382 383 handlers = [ 384 ("VFREEBUSY", Freebusy), 385 ("VEVENT", Event), 386 ] 387 388 # vim: tabstop=4 expandtab shiftwidth=4