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_uri, uri_values, values_from_items 23 from imiptools.dates import format_datetime 24 from imiptools.handlers import Handler 25 from imiptools.handlers.common import CommonFreebusy 26 from imiptools.period import Period, replace_overlapping 27 from imiptools.profile import Preferences 28 29 class PersonHandler(Handler): 30 31 "Handling mechanisms specific to people." 32 33 def _record(self, from_organiser=True, queue=False, cancel=False): 34 35 """ 36 Record details from the current object given a message originating 37 from an organiser if 'from_organiser' is set to a true value, queuing a 38 request if 'queue' is set to a true value, or cancelling an event if 39 'cancel' is set to a true value. 40 """ 41 42 # Obtain valid organiser and attendee details. 43 44 oa = self.require_organiser_and_attendees(from_organiser) 45 if not oa: 46 return False 47 48 (organiser, organiser_attr), attendees = organiser_item, attendees = oa 49 50 # Handle notifications and invitations. 51 52 if from_organiser: 53 54 # Process for the current user, an attendee. 55 56 if not self.have_new_object() or not self.is_attendee(self.user): 57 return False 58 59 # Set the complete event or an additional occurrence. 60 61 self.store.set_event(self.user, self.uid, self.recurrenceid, self.obj.to_node()) 62 63 # Remove additional recurrences if handling a complete event. 64 65 if not self.recurrenceid: 66 self.store.remove_recurrences(self.user, self.uid) 67 68 # Queue any request. 69 70 if queue: 71 self.store.queue_request(self.user, self.uid, self.recurrenceid) 72 elif cancel: 73 self.store.cancel_event(self.user, self.uid, self.recurrenceid) 74 75 # No return message will occur to update the free/busy 76 # information, so this is done here. 77 78 freebusy = self.store.get_freebusy(self.user) 79 self.remove_from_freebusy(freebusy) 80 81 self.store.set_freebusy(self.user, freebusy) 82 83 if self.publisher and self.is_sharing(): 84 self.publisher.set_freebusy(self.user, freebusy) 85 86 self.update_freebusy_from_organiser(organiser_item) 87 88 # As organiser, update attendance from valid attendees. 89 90 else: 91 if self.merge_attendance(attendees): 92 self.update_freebusy_from_attendees(attendees) 93 94 return True 95 96 def _record_freebusy(self, from_organiser=True): 97 98 """ 99 Record free/busy information for a message originating from an organiser 100 if 'from_organiser' is set to a true value. 101 """ 102 103 if from_organiser: 104 organiser_item = self.require_organiser(from_organiser) 105 if not organiser_item: 106 return 107 108 senders = [organiser_item] 109 else: 110 oa = self.require_organiser_and_attendees(from_organiser) 111 if not oa: 112 return 113 114 organiser_item, attendees = oa 115 senders = attendees.items() 116 117 if not senders: 118 return 119 120 freebusy = [] 121 122 for value in self.obj.get_values("FREEBUSY") or []: 123 if not isinstance(value, list): 124 value = [value] 125 for v in value: 126 try: 127 start, end = v.split("/", 1) 128 freebusy.append(Period(start, end)) 129 except ValueError: 130 pass 131 132 dtstart = format_datetime(self.obj.get_utc_datetime("DTSTART")) 133 dtend = format_datetime(self.obj.get_utc_datetime("DTEND")) 134 135 for sender, sender_attr in senders: 136 stored_freebusy = self.store.get_freebusy_for_other(self.user, sender) 137 replace_overlapping(stored_freebusy, Period(dtstart, dtend), freebusy) 138 self.store.set_freebusy_for_other(self.user, stored_freebusy, sender) 139 140 class Event(PersonHandler): 141 142 "An event handler." 143 144 def add(self): 145 146 # NOTE: Queue a suggested modification to any active event. 147 148 return self.wrap("An addition to an event has been received.", link=False) 149 150 def cancel(self): 151 152 "Queue a cancellation of any active event." 153 154 self._record(from_organiser=True, queue=False, cancel=True) 155 return self.wrap("A cancellation has been received.", link=False) 156 157 def counter(self): 158 159 # NOTE: Queue a suggested modification to any active event. 160 161 return self.wrap("A counter proposal has been received.", link=False) 162 163 def declinecounter(self): 164 165 # NOTE: Queue a suggested modification to any active event. 166 167 return self.wrap("A declining counter proposal has been received.", link=False) 168 169 def publish(self): 170 171 "Register details of any relevant event." 172 173 self._record(from_organiser=True, queue=False) 174 return self.wrap("Details of an event have been received.") 175 176 def refresh(self): 177 178 "Generate details of any active event." 179 180 # NOTE: Return event details if configured to do so. 181 182 return self.wrap("A request for updated event details has been received.") 183 184 def reply(self): 185 186 "Record replies and notify the recipient." 187 188 self._record(from_organiser=False, queue=False) 189 return self.wrap("A reply has been received.") 190 191 def request(self): 192 193 "Hold requests and notify the recipient." 194 195 self._record(from_organiser=True, queue=True) 196 return self.wrap("A request has been received.") 197 198 class Freebusy(PersonHandler, CommonFreebusy): 199 200 "A free/busy handler." 201 202 def publish(self): 203 204 "Register free/busy information." 205 206 self._record_freebusy(from_organiser=True) 207 208 # Produce a message if configured to do so. 209 210 if self.is_notifying(): 211 return self.wrap("A free/busy update has been received.", link=False) 212 213 def reply(self): 214 215 "Record replies and notify the recipient." 216 217 self._record_freebusy(from_organiser=False) 218 219 # Produce a message if configured to do so. 220 221 if self.is_notifying(): 222 return self.wrap("A reply to a free/busy request has been received.", link=False) 223 224 def request(self): 225 226 """ 227 Respond to a request by preparing a reply containing free/busy 228 information for the recipient. 229 """ 230 231 # Produce a reply if configured to do so. 232 233 if self.is_sharing(): 234 return CommonFreebusy.request(self) 235 236 # Handler registry. 237 238 handlers = [ 239 ("VFREEBUSY", Freebusy), 240 ("VEVENT", Event), 241 ] 242 243 # vim: tabstop=4 expandtab shiftwidth=4