1 #!/usr/bin/env python 2 3 """ 4 Common calendar client utilities. 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, get_window_end, uri_dict, uri_items, uri_values 23 from imiptools.dates import get_default_timezone 24 from imiptools.profile import Preferences 25 26 def update_attendees(obj, attendees, removed): 27 28 """ 29 Update the attendees in 'obj' with the given 'attendees' and 'removed' 30 attendee lists. A list is returned containing the attendees whose 31 attendance should be cancelled. 32 """ 33 34 to_cancel = [] 35 36 existing_attendees = uri_values(obj.get_values("ATTENDEE") or []) 37 added = set(attendees).difference(existing_attendees) 38 39 if added or removed: 40 attendees = uri_items(obj.get_items("ATTENDEE") or []) 41 sequence = obj.get_value("SEQUENCE") 42 43 if removed: 44 remaining = [] 45 46 for attendee, attendee_attr in attendees: 47 if attendee in removed: 48 49 # Without a sequence number, assume that the event has not 50 # been published and that attendees can be silently removed. 51 52 if sequence is not None: 53 to_cancel.append((attendee, attendee_attr)) 54 else: 55 remaining.append((attendee, attendee_attr)) 56 57 attendees = remaining 58 59 if added: 60 for attendee in added: 61 attendee = attendee.strip() 62 if attendee: 63 attendees.append((get_uri(attendee), {"PARTSTAT" : "NEEDS-ACTION", "RSVP" : "TRUE"})) 64 65 obj["ATTENDEE"] = attendees 66 67 return to_cancel 68 69 class Client: 70 71 "Common handler and manager methods." 72 73 default_window_size = 100 74 75 def __init__(self, user): 76 self.user = user 77 self.preferences = None 78 79 def get_preferences(self): 80 if not self.preferences and self.user: 81 self.preferences = Preferences(self.user) 82 return self.preferences 83 84 def get_tzid(self): 85 prefs = self.get_preferences() 86 return prefs and prefs.get("TZID") or get_default_timezone() 87 88 def get_window_size(self): 89 prefs = self.get_preferences() 90 try: 91 return prefs and int(prefs.get("window_size")) or self.default_window_size 92 except (TypeError, ValueError): 93 return self.default_window_size 94 95 def get_window_end(self): 96 return get_window_end(self.get_tzid(), self.get_window_size()) 97 98 def is_sharing(self): 99 prefs = self.get_preferences() 100 return prefs and prefs.get("freebusy_sharing") == "share" or False 101 102 def is_bundling(self): 103 prefs = self.get_preferences() 104 return prefs and prefs.get("freebusy_bundling") == "always" or False 105 106 def is_notifying(self): 107 prefs = self.get_preferences() 108 return prefs and prefs.get("freebusy_messages") == "notify" or False 109 110 # Common operations on calendar data. 111 112 def update_participation(self, obj, partstat=None): 113 114 """ 115 Update the participation in 'obj' of the user with the given 'partstat'. 116 """ 117 118 attendee_attr = uri_dict(obj.get_value_map("ATTENDEE")).get(self.user) 119 if not attendee_attr: 120 return None 121 if partstat: 122 attendee_attr["PARTSTAT"] = partstat 123 if attendee_attr.has_key("RSVP"): 124 del attendee_attr["RSVP"] 125 if self.messenger and self.messenger.sender != get_address(self.user): 126 attendee_attr["SENT-BY"] = get_uri(self.messenger.sender) 127 return attendee_attr 128 129 # vim: tabstop=4 expandtab shiftwidth=4