paul@108 | 1 | #!/usr/bin/env python |
paul@108 | 2 | |
paul@108 | 3 | """ |
paul@108 | 4 | Common handler functionality for different entities. |
paul@146 | 5 | |
paul@146 | 6 | Copyright (C) 2014, 2015 Paul Boddie <paul@boddie.org.uk> |
paul@146 | 7 | |
paul@146 | 8 | This program is free software; you can redistribute it and/or modify it under |
paul@146 | 9 | the terms of the GNU General Public License as published by the Free Software |
paul@146 | 10 | Foundation; either version 3 of the License, or (at your option) any later |
paul@146 | 11 | version. |
paul@146 | 12 | |
paul@146 | 13 | This program is distributed in the hope that it will be useful, but WITHOUT |
paul@146 | 14 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
paul@146 | 15 | FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
paul@146 | 16 | details. |
paul@146 | 17 | |
paul@146 | 18 | You should have received a copy of the GNU General Public License along with |
paul@146 | 19 | this program. If not, see <http://www.gnu.org/licenses/>. |
paul@108 | 20 | """ |
paul@108 | 21 | |
paul@580 | 22 | from imiptools.data import get_address, get_uri, make_freebusy, to_part, \ |
paul@580 | 23 | uri_dict |
paul@327 | 24 | from imiptools.dates import format_datetime |
paul@562 | 25 | from imiptools.period import Period |
paul@108 | 26 | |
paul@222 | 27 | class CommonFreebusy: |
paul@108 | 28 | |
paul@222 | 29 | "Common free/busy mix-in." |
paul@181 | 30 | |
paul@222 | 31 | def request(self): |
paul@181 | 32 | |
paul@181 | 33 | """ |
paul@222 | 34 | Respond to a request by preparing a reply containing free/busy |
paul@222 | 35 | information for each indicated attendee. |
paul@181 | 36 | """ |
paul@181 | 37 | |
paul@108 | 38 | oa = self.require_organiser_and_attendees() |
paul@108 | 39 | if not oa: |
paul@228 | 40 | return |
paul@108 | 41 | |
paul@181 | 42 | (organiser, organiser_attr), attendees = oa |
paul@108 | 43 | |
paul@181 | 44 | # Get the details for each attendee. |
paul@108 | 45 | |
paul@222 | 46 | responses = [] |
paul@222 | 47 | rwrite = responses.append |
paul@222 | 48 | |
paul@222 | 49 | # For replies, the organiser and attendee are preserved. |
paul@108 | 50 | |
paul@181 | 51 | for attendee, attendee_attr in attendees.items(): |
paul@222 | 52 | freebusy = self.store.get_freebusy(attendee) |
paul@292 | 53 | |
paul@292 | 54 | # Indicate the actual sender of the reply. |
paul@292 | 55 | |
paul@292 | 56 | if self.messenger: |
paul@292 | 57 | attendee_attr["SENT-BY"] = get_uri(self.messenger.sender) |
paul@292 | 58 | |
paul@562 | 59 | tzid = self.obj.get_tzid() or self.get_tzid() |
paul@562 | 60 | dtstart = self.obj.get_datetime("DTSTART") |
paul@562 | 61 | dtend = self.obj.get_datetime("DTEND") |
paul@562 | 62 | period = dtstart and dtend and Period(dtstart, dtend, tzid) or None |
paul@327 | 63 | |
paul@562 | 64 | rwrite(make_freebusy(freebusy, self.uid, organiser, organiser_attr, attendee, attendee_attr, period)) |
paul@183 | 65 | |
paul@183 | 66 | # Return the reply. |
paul@183 | 67 | |
paul@228 | 68 | self.add_result("REPLY", [get_address(organiser)], to_part("REPLY", responses)) |
paul@183 | 69 | |
paul@580 | 70 | class Outgoing: |
paul@580 | 71 | |
paul@580 | 72 | "Common outgoing message handling functionality." |
paul@580 | 73 | |
paul@580 | 74 | def update_event_in_freebusy(self, from_organiser=True): |
paul@580 | 75 | |
paul@580 | 76 | "Update free/busy information when handling an object." |
paul@580 | 77 | |
paul@580 | 78 | freebusy = self.store.get_freebusy(self.user) |
paul@580 | 79 | |
paul@580 | 80 | # Use the stored event in case the reply is incomplete, as is seen |
paul@580 | 81 | # when Claws sends a REPLY for an object originally employing |
paul@580 | 82 | # recurrence information. |
paul@580 | 83 | |
paul@580 | 84 | obj = self.get_definitive_object(from_organiser) |
paul@580 | 85 | if not obj: |
paul@580 | 86 | return False # although this should not happen |
paul@580 | 87 | |
paul@580 | 88 | # If newer than any old version, discard old details from the |
paul@580 | 89 | # free/busy record and check for suitability. |
paul@580 | 90 | |
paul@580 | 91 | # Interpretation of periods can depend on the time zone. |
paul@580 | 92 | |
paul@580 | 93 | periods = obj.get_periods(self.get_tzid(), self.get_window_end()) |
paul@580 | 94 | |
paul@580 | 95 | # Obtain the attendance attributes for this user, if available. |
paul@580 | 96 | |
paul@580 | 97 | attendees = uri_dict(self.obj.get_value_map("ATTENDEE")) |
paul@580 | 98 | self.update_freebusy_for_participant(freebusy, periods, attendees.get(self.user), from_organiser) |
paul@580 | 99 | |
paul@580 | 100 | # Remove original recurrence details replaced by additional |
paul@580 | 101 | # recurrences, as well as obsolete additional recurrences. |
paul@580 | 102 | |
paul@580 | 103 | self.remove_freebusy_for_recurrences(freebusy, self.store.get_recurrences(self.user, self.uid)) |
paul@580 | 104 | self.store.set_freebusy(self.user, freebusy) |
paul@580 | 105 | |
paul@580 | 106 | if self.publisher and self.is_sharing(): |
paul@580 | 107 | self.publisher.set_freebusy(self.user, freebusy) |
paul@580 | 108 | |
paul@580 | 109 | return True |
paul@580 | 110 | |
paul@580 | 111 | def remove_event_from_freebusy(self): |
paul@580 | 112 | |
paul@580 | 113 | "Remove free/busy information when handling an object." |
paul@580 | 114 | |
paul@580 | 115 | freebusy = self.store.get_freebusy(self.user) |
paul@580 | 116 | self.remove_from_freebusy(freebusy) |
paul@580 | 117 | self.remove_freebusy_for_recurrences(freebusy) |
paul@580 | 118 | self.store.set_freebusy(self.user, freebusy) |
paul@580 | 119 | |
paul@580 | 120 | if self.publisher and self.is_sharing(): |
paul@580 | 121 | self.publisher.set_freebusy(self.user, freebusy) |
paul@580 | 122 | |
paul@108 | 123 | # vim: tabstop=4 expandtab shiftwidth=4 |