1 #!/usr/bin/env python 2 3 """ 4 Common handler functionality for different entities. 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, get_uri, make_freebusy, to_part, \ 23 uri_dict 24 from imiptools.dates import format_datetime 25 from imiptools.period import Period 26 27 class CommonFreebusy: 28 29 "Common free/busy mix-in." 30 31 def request(self): 32 33 """ 34 Respond to a request by preparing a reply containing free/busy 35 information for each indicated attendee. 36 """ 37 38 oa = self.require_organiser_and_attendees() 39 if not oa: 40 return 41 42 (organiser, organiser_attr), attendees = oa 43 44 # Get the details for each attendee. 45 46 responses = [] 47 rwrite = responses.append 48 49 # For replies, the organiser and attendee are preserved. 50 51 for attendee, attendee_attr in attendees.items(): 52 freebusy = self.store.get_freebusy(attendee) 53 54 # Indicate the actual sender of the reply. 55 56 if self.messenger: 57 attendee_attr["SENT-BY"] = get_uri(self.messenger.sender) 58 59 dtstart = self.obj.get_datetime("DTSTART") 60 dtend = self.obj.get_datetime("DTEND") 61 period = dtstart and dtend and Period(dtstart, dtend, self.get_tzid()) or None 62 63 rwrite(make_freebusy(freebusy, self.uid, organiser, organiser_attr, attendee, attendee_attr, period)) 64 65 # Return the reply. 66 67 self.add_result("REPLY", [get_address(organiser)], to_part("REPLY", responses)) 68 69 class CommonEvent: 70 71 "Common outgoing message handling functionality mix-in." 72 73 def is_usable(self): 74 75 "Return whether the current object is usable." 76 77 return self.obj and self.obj.get_value("DTSTART") 78 79 def update_event_in_freebusy(self, for_organiser=True): 80 81 """ 82 Update free/busy information when handling an object, doing so for the 83 organiser of an event if 'for_organiser' is set to a true value. 84 """ 85 86 freebusy = self.store.get_freebusy_for_update(self.user) 87 try: 88 # Obtain the attendance attributes for this user, if available. 89 90 self.update_freebusy_for_participant(freebusy, self.user, for_organiser) 91 92 # Remove original recurrence details replaced by additional 93 # recurrences, as well as obsolete additional recurrences. 94 95 self.remove_freebusy_for_recurrences(freebusy, self.store.get_recurrences(self.user, self.uid)) 96 self.store.set_freebusy_in_update(self.user, freebusy) 97 98 if self.publisher and self.is_sharing(): 99 self.publisher.set_freebusy(self.user, freebusy) 100 101 # Update free/busy provider information if the event may recur 102 # indefinitely. 103 104 if self.possibly_recurring_indefinitely(): 105 self.store.append_freebusy_provider(self.user, self.obj) 106 107 finally: 108 self.store.release_freebusy(self.user) 109 110 return True 111 112 def remove_event_from_freebusy(self): 113 114 "Remove free/busy information when handling an object." 115 116 freebusy = self.store.get_freebusy_for_update(self.user) 117 try: 118 self.remove_from_freebusy(freebusy) 119 self.remove_freebusy_for_recurrences(freebusy) 120 self.store.set_freebusy_in_update(self.user, freebusy) 121 122 if self.publisher and self.is_sharing(): 123 self.publisher.set_freebusy(self.user, freebusy) 124 125 # Update free/busy provider information if the event may recur 126 # indefinitely. 127 128 if self.possibly_recurring_indefinitely(): 129 self.store.remove_freebusy_provider(self.user, self.obj) 130 131 finally: 132 self.store.release_freebusy(self.user) 133 134 def update_event_in_freebusy_offers(self): 135 136 "Update free/busy offers when handling an object." 137 138 freebusy = self.store.get_freebusy_offers_for_update(self.user) 139 try: 140 # Obtain the attendance attributes for this user, if available. 141 142 self.update_freebusy_for_participant(freebusy, self.user) 143 144 # Remove original recurrence details replaced by additional 145 # recurrences, as well as obsolete additional recurrences. 146 147 self.remove_freebusy_for_recurrences(freebusy, self.store.get_recurrences(self.user, self.uid)) 148 self.store.set_freebusy_offers_in_update(self.user, freebusy) 149 150 finally: 151 self.store.release_freebusy(self.user) 152 153 return True 154 155 def remove_event_from_freebusy_offers(self): 156 157 "Remove free/busy offers when handling an object." 158 159 freebusy = self.store.get_freebusy_offers_for_update(self.user) 160 try: 161 self.remove_from_freebusy(freebusy) 162 self.remove_freebusy_for_recurrences(freebusy) 163 self.store.set_freebusy_offers_in_update(self.user, freebusy) 164 165 finally: 166 self.store.release_freebusy(self.user) 167 168 return True 169 170 # vim: tabstop=4 expandtab shiftwidth=4