imip-agent

imiptools/handlers/common.py

740:2962011812c0
2015-09-13 Paul Boddie Added support for recording expiry times on free/busy offers, fixing testing for expired offers.
     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, method=None):    74     75         "Return whether the current object is usable with the given 'method'."    76     77         return self.obj and (    78             method in ("CANCEL", "REFRESH") or    79             self.obj.get_datetime("DTSTART") and    80                 (self.obj.get_datetime("DTEND") or self.obj.get_duration("DURATION")))    81     82     def will_refresh(self):    83     84         """    85         Indicate whether a REFRESH message should be used to respond to an ADD    86         message.    87         """    88     89         return not self.get_stored_object_version() or self.get_add_method_response() == "refresh"    90     91     def make_refresh(self):    92     93         "Make a REFRESH message."    94     95         organiser = get_uri(self.obj.get_value("ORGANIZER"))    96         attendees = uri_dict(self.obj.get_value_map("ATTENDEE"))    97     98         # Add SENT-BY details to the recipient's attributes.    99    100         attendee_attr = attendees[self.user]   101         self.update_sender(attendee_attr)   102    103         # Make a new object with a minimal property selection.   104    105         obj = self.obj.copy()   106         obj.preserve(("ORGANIZER", "DTSTAMP", "UID", "RECURRENCE-ID"))   107         obj["ATTENDEE"] = [(self.user, attendee_attr)]   108    109         # Send a REFRESH message in response.   110    111         self.add_result("REFRESH", [get_address(organiser)], obj.to_part("REFRESH"))   112    113     def update_event_in_freebusy(self, for_organiser=True):   114    115         """   116         Update free/busy information when handling an object, doing so for the   117         organiser of an event if 'for_organiser' is set to a true value.   118         """   119    120         freebusy = self.store.get_freebusy(self.user)   121    122         # Obtain the attendance attributes for this user, if available.   123    124         self.update_freebusy_for_participant(freebusy, self.user, for_organiser)   125    126         # Remove original recurrence details replaced by additional   127         # recurrences, as well as obsolete additional recurrences.   128    129         self.remove_freebusy_for_recurrences(freebusy, self.store.get_recurrences(self.user, self.uid))   130         self.store.set_freebusy(self.user, freebusy)   131    132         if self.publisher and self.is_sharing():   133             self.publisher.set_freebusy(self.user, freebusy)   134    135         # Update free/busy provider information if the event may recur   136         # indefinitely.   137    138         if self.possibly_recurring_indefinitely():   139             self.store.append_freebusy_provider(self.user, self.obj)   140    141         return True   142    143     def remove_event_from_freebusy(self):   144    145         "Remove free/busy information when handling an object."   146    147         freebusy = self.store.get_freebusy(self.user)   148    149         self.remove_from_freebusy(freebusy)   150         self.remove_freebusy_for_recurrences(freebusy)   151         self.store.set_freebusy(self.user, freebusy)   152    153         if self.publisher and self.is_sharing():   154             self.publisher.set_freebusy(self.user, freebusy)   155    156         # Update free/busy provider information if the event may recur   157         # indefinitely.   158    159         if self.possibly_recurring_indefinitely():   160             self.store.remove_freebusy_provider(self.user, self.obj)   161    162     def update_event_in_freebusy_offers(self):   163    164         "Update free/busy offers when handling an object."   165    166         freebusy = self.store.get_freebusy_offers(self.user)   167    168         # Obtain the attendance attributes for this user, if available.   169    170         self.update_freebusy_for_participant(freebusy, self.user, offer=True)   171    172         # Remove original recurrence details replaced by additional   173         # recurrences, as well as obsolete additional recurrences.   174    175         self.remove_freebusy_for_recurrences(freebusy, self.store.get_recurrences(self.user, self.uid))   176         self.store.set_freebusy_offers(self.user, freebusy)   177    178         return True   179    180     def remove_event_from_freebusy_offers(self):   181    182         "Remove free/busy offers when handling an object."   183    184         freebusy = self.store.get_freebusy_offers(self.user)   185    186         self.remove_from_freebusy(freebusy)   187         self.remove_freebusy_for_recurrences(freebusy)   188         self.store.set_freebusy_offers(self.user, freebusy)   189    190         return True   191    192 # vim: tabstop=4 expandtab shiftwidth=4