paul@1028 | 1 | #!/usr/bin/env python |
paul@1028 | 2 | |
paul@1028 | 3 | """ |
paul@1028 | 4 | Free/busy-related scheduling functionality. |
paul@1028 | 5 | |
paul@1028 | 6 | Copyright (C) 2015, 2016 Paul Boddie <paul@boddie.org.uk> |
paul@1028 | 7 | |
paul@1028 | 8 | This program is free software; you can redistribute it and/or modify it under |
paul@1028 | 9 | the terms of the GNU General Public License as published by the Free Software |
paul@1028 | 10 | Foundation; either version 3 of the License, or (at your option) any later |
paul@1028 | 11 | version. |
paul@1028 | 12 | |
paul@1028 | 13 | This program is distributed in the hope that it will be useful, but WITHOUT |
paul@1028 | 14 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
paul@1028 | 15 | FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
paul@1028 | 16 | details. |
paul@1028 | 17 | |
paul@1028 | 18 | You should have received a copy of the GNU General Public License along with |
paul@1028 | 19 | this program. If not, see <http://www.gnu.org/licenses/>. |
paul@1028 | 20 | """ |
paul@1028 | 21 | |
paul@1028 | 22 | from imiptools.data import uri_values |
paul@1028 | 23 | from imiptools.dates import ValidityError, to_timezone |
paul@1028 | 24 | |
paul@1031 | 25 | def schedule_in_freebusy(handler, args, freebusy=None): |
paul@1028 | 26 | |
paul@1028 | 27 | """ |
paul@1028 | 28 | Attempt to schedule the current object of the given 'handler' in the |
paul@1028 | 29 | free/busy schedule of a resource, returning an indication of the kind of |
paul@1028 | 30 | response to be returned. |
paul@1028 | 31 | |
paul@1028 | 32 | If 'freebusy' is specified, the given collection of busy periods will be |
paul@1028 | 33 | used to determine whether any conflicts occur. Otherwise, the current user's |
paul@1028 | 34 | free/busy records will be used. |
paul@1028 | 35 | """ |
paul@1028 | 36 | |
paul@1153 | 37 | _ = handler.get_translator() |
paul@1153 | 38 | |
paul@1028 | 39 | # If newer than any old version, discard old details from the |
paul@1028 | 40 | # free/busy record and check for suitability. |
paul@1028 | 41 | |
paul@1028 | 42 | periods = handler.get_periods(handler.obj) |
paul@1028 | 43 | |
paul@1039 | 44 | freebusy = freebusy or handler.get_store().get_freebusy(handler.user) |
paul@1039 | 45 | offers = handler.get_store().get_freebusy_offers(handler.user) |
paul@1028 | 46 | |
paul@1028 | 47 | # Check the periods against any scheduled events and against |
paul@1028 | 48 | # any outstanding offers. |
paul@1028 | 49 | |
paul@1028 | 50 | scheduled = handler.can_schedule(freebusy, periods) |
paul@1028 | 51 | scheduled = scheduled and handler.can_schedule(offers, periods) |
paul@1028 | 52 | |
paul@1153 | 53 | return standard_responses(handler, scheduled and "ACCEPTED" or "DECLINED") |
paul@1028 | 54 | |
paul@1031 | 55 | def schedule_corrected_in_freebusy(handler, args): |
paul@1028 | 56 | |
paul@1028 | 57 | """ |
paul@1028 | 58 | Attempt to schedule the current object of the given 'handler', correcting |
paul@1028 | 59 | specified datetimes according to the configuration of a resource, |
paul@1028 | 60 | returning an indication of the kind of response to be returned. |
paul@1028 | 61 | """ |
paul@1028 | 62 | |
paul@1153 | 63 | _ = handler.get_translator() |
paul@1153 | 64 | |
paul@1028 | 65 | obj = handler.obj.copy() |
paul@1028 | 66 | |
paul@1028 | 67 | # Check any constraints on the request. |
paul@1028 | 68 | |
paul@1028 | 69 | try: |
paul@1028 | 70 | corrected = handler.correct_object() |
paul@1028 | 71 | |
paul@1028 | 72 | # Refuse to schedule obviously invalid requests. |
paul@1028 | 73 | |
paul@1028 | 74 | except ValidityError: |
paul@1028 | 75 | return None |
paul@1028 | 76 | |
paul@1028 | 77 | # With a valid request, determine whether the event can be scheduled. |
paul@1028 | 78 | |
paul@1034 | 79 | scheduled = schedule_in_freebusy(handler, args) |
paul@1153 | 80 | response, description = scheduled or ("DECLINED", None) |
paul@1028 | 81 | |
paul@1028 | 82 | # Restore the original object if it was corrected but could not be |
paul@1028 | 83 | # scheduled. |
paul@1028 | 84 | |
paul@1153 | 85 | if response == "DECLINED" and corrected: |
paul@1028 | 86 | handler.set_object(obj) |
paul@1028 | 87 | |
paul@1028 | 88 | # Where the corrected object can be scheduled, issue a counter |
paul@1028 | 89 | # request. |
paul@1028 | 90 | |
paul@1153 | 91 | response = response == "ACCEPTED" and (corrected and "COUNTER" or "ACCEPTED") or "DECLINED" |
paul@1153 | 92 | return standard_responses(handler, response) |
paul@1028 | 93 | |
paul@1031 | 94 | def schedule_next_available_in_freebusy(handler, args): |
paul@1028 | 95 | |
paul@1028 | 96 | """ |
paul@1028 | 97 | Attempt to schedule the current object of the given 'handler', correcting |
paul@1028 | 98 | specified datetimes according to the configuration of a resource, then |
paul@1028 | 99 | suggesting the next available period in the free/busy records if scheduling |
paul@1028 | 100 | cannot occur for the requested period, returning an indication of the kind |
paul@1028 | 101 | of response to be returned. |
paul@1028 | 102 | """ |
paul@1028 | 103 | |
paul@1153 | 104 | _ = handler.get_translator() |
paul@1028 | 105 | |
paul@1153 | 106 | scheduled = schedule_corrected_in_freebusy(handler, args) |
paul@1153 | 107 | response, description = scheduled or ("DECLINED", None) |
paul@1153 | 108 | |
paul@1153 | 109 | if response in ("ACCEPTED", "COUNTER"): |
paul@1028 | 110 | return scheduled |
paul@1028 | 111 | |
paul@1028 | 112 | # There should already be free/busy information for the user. |
paul@1028 | 113 | |
paul@1039 | 114 | user_freebusy = handler.get_store().get_freebusy(handler.user) |
paul@1071 | 115 | |
paul@1071 | 116 | # Maintain a separate copy of the data. |
paul@1071 | 117 | |
paul@1071 | 118 | busy = user_freebusy.copy() |
paul@1028 | 119 | |
paul@1028 | 120 | # Subtract any periods from this event from the free/busy collections. |
paul@1028 | 121 | |
paul@1071 | 122 | event_periods = handler.remove_from_freebusy(busy) |
paul@1028 | 123 | |
paul@1028 | 124 | # Find busy periods for the other attendees. |
paul@1028 | 125 | |
paul@1028 | 126 | for attendee in uri_values(handler.obj.get_values("ATTENDEE")): |
paul@1028 | 127 | if attendee != handler.user: |
paul@1071 | 128 | |
paul@1071 | 129 | # Get a copy of the attendee's free/busy data. |
paul@1071 | 130 | |
paul@1071 | 131 | freebusy = handler.get_store().get_freebusy_for_other(handler.user, attendee).copy() |
paul@1028 | 132 | if freebusy: |
paul@1062 | 133 | freebusy.remove_periods(event_periods) |
paul@1028 | 134 | busy += freebusy |
paul@1028 | 135 | |
paul@1028 | 136 | # Obtain the combined busy periods. |
paul@1028 | 137 | |
paul@1062 | 138 | busy = busy.coalesce_freebusy() |
paul@1028 | 139 | |
paul@1028 | 140 | # Obtain free periods. |
paul@1028 | 141 | |
paul@1062 | 142 | free = busy.invert_freebusy() |
paul@1028 | 143 | permitted_values = handler.get_permitted_values() |
paul@1028 | 144 | periods = [] |
paul@1028 | 145 | |
paul@1028 | 146 | # Do not attempt to redefine rule-based periods. |
paul@1028 | 147 | |
paul@1028 | 148 | last = None |
paul@1028 | 149 | |
paul@1028 | 150 | for period in handler.get_periods(handler.obj, explicit_only=True): |
paul@1028 | 151 | duration = period.get_duration() |
paul@1028 | 152 | |
paul@1028 | 153 | # Try and schedule periods normally since some of them may be |
paul@1028 | 154 | # compatible with the schedule. |
paul@1028 | 155 | |
paul@1028 | 156 | if permitted_values: |
paul@1028 | 157 | period = period.get_corrected(permitted_values) |
paul@1028 | 158 | |
paul@1152 | 159 | scheduled = handler.can_schedule(busy, [period]) |
paul@1028 | 160 | |
paul@1152 | 161 | if scheduled: |
paul@1028 | 162 | periods.append(period) |
paul@1028 | 163 | last = period.get_end() |
paul@1028 | 164 | continue |
paul@1028 | 165 | |
paul@1028 | 166 | # Get free periods from the time of each period. |
paul@1028 | 167 | |
paul@1062 | 168 | for found in free.periods_from(period): |
paul@1028 | 169 | |
paul@1028 | 170 | # Skip any periods before the last period. |
paul@1028 | 171 | |
paul@1028 | 172 | if last: |
paul@1028 | 173 | if last > found.get_end(): |
paul@1028 | 174 | continue |
paul@1028 | 175 | |
paul@1028 | 176 | # Adjust the start of the free period to exclude the last period. |
paul@1028 | 177 | |
paul@1028 | 178 | found = found.make_corrected(max(found.get_start(), last), found.get_end()) |
paul@1028 | 179 | |
paul@1028 | 180 | # Only test free periods long enough to hold the requested period. |
paul@1028 | 181 | |
paul@1028 | 182 | if found.get_duration() >= duration: |
paul@1028 | 183 | |
paul@1028 | 184 | # Obtain a possible period, starting at the found point and |
paul@1028 | 185 | # with the requested duration. Then, correct the period if |
paul@1028 | 186 | # necessary. |
paul@1028 | 187 | |
paul@1028 | 188 | start = to_timezone(found.get_start(), period.get_tzid()) |
paul@1028 | 189 | possible = period.make_corrected(start, start + period.get_duration()) |
paul@1028 | 190 | if permitted_values: |
paul@1028 | 191 | possible = possible.get_corrected(permitted_values) |
paul@1028 | 192 | |
paul@1028 | 193 | # Only if the possible period is still within the free period |
paul@1028 | 194 | # can it be used. |
paul@1028 | 195 | |
paul@1028 | 196 | if possible.within(found): |
paul@1028 | 197 | periods.append(possible) |
paul@1028 | 198 | break |
paul@1028 | 199 | |
paul@1028 | 200 | # Where no period can be found, decline the invitation. |
paul@1028 | 201 | |
paul@1028 | 202 | else: |
paul@1153 | 203 | return "DECLINED", _("The recipient is unavailable in the requested period.") |
paul@1028 | 204 | |
paul@1028 | 205 | # Use the found period to set the start of the next window to search. |
paul@1028 | 206 | |
paul@1028 | 207 | last = periods[-1].get_end() |
paul@1028 | 208 | |
paul@1028 | 209 | # Replace the periods in the object. |
paul@1028 | 210 | |
paul@1028 | 211 | obj = handler.obj.copy() |
paul@1028 | 212 | changed = handler.obj.set_periods(periods) |
paul@1028 | 213 | |
paul@1028 | 214 | # Check one last time, reverting the change if not scheduled. |
paul@1028 | 215 | |
paul@1031 | 216 | scheduled = schedule_in_freebusy(handler, args, busy) |
paul@1153 | 217 | response, description = scheduled or ("DECLINED", None) |
paul@1028 | 218 | |
paul@1153 | 219 | if response == "DECLINED": |
paul@1028 | 220 | handler.set_object(obj) |
paul@1028 | 221 | |
paul@1153 | 222 | response = response == "ACCEPTED" and (changed and "COUNTER" or "ACCEPTED") or "DECLINED" |
paul@1153 | 223 | return standard_responses(handler, response) |
paul@1153 | 224 | |
paul@1153 | 225 | def standard_responses(handler, response): |
paul@1153 | 226 | |
paul@1153 | 227 | """ |
paul@1153 | 228 | Using 'handler' to translate descriptions, return a tuple containing the |
paul@1153 | 229 | 'response' and a suitable description. |
paul@1153 | 230 | """ |
paul@1153 | 231 | |
paul@1153 | 232 | _ = handler.get_translator() |
paul@1153 | 233 | |
paul@1153 | 234 | if response == "ACCEPTED": |
paul@1153 | 235 | return response, _("The recipient has scheduled the requested period.") |
paul@1153 | 236 | elif response == "COUNTER": |
paul@1153 | 237 | return response, _("The recipient has suggested a different period.") |
paul@1153 | 238 | else: |
paul@1153 | 239 | return response, _("The recipient is unavailable in the requested period.") |
paul@1028 | 240 | |
paul@1028 | 241 | # Registry of scheduling functions. |
paul@1028 | 242 | |
paul@1028 | 243 | scheduling_functions = { |
paul@1028 | 244 | "schedule_in_freebusy" : schedule_in_freebusy, |
paul@1028 | 245 | "schedule_corrected_in_freebusy" : schedule_corrected_in_freebusy, |
paul@1028 | 246 | "schedule_next_available_in_freebusy" : schedule_next_available_in_freebusy, |
paul@1028 | 247 | } |
paul@1028 | 248 | |
paul@1040 | 249 | # Registries of locking and unlocking functions. |
paul@1040 | 250 | |
paul@1040 | 251 | locking_functions = {} |
paul@1040 | 252 | unlocking_functions = {} |
paul@1040 | 253 | |
paul@1039 | 254 | # Registries of listener functions. |
paul@1039 | 255 | |
paul@1039 | 256 | confirmation_functions = {} |
paul@1039 | 257 | retraction_functions = {} |
paul@1039 | 258 | |
paul@1028 | 259 | # vim: tabstop=4 expandtab shiftwidth=4 |