1 #!/usr/bin/env python 2 3 import cgi, os, sys 4 5 sys.path.append("/var/lib/imip-agent") 6 7 from imiptools.content import Handler, \ 8 format_datetime, get_address, get_datetime, \ 9 get_item, get_uri, get_utc_datetime, get_values, \ 10 parse_object, to_part, to_timezone 11 from imiptools.mail import Messenger 12 from imiptools.period import have_conflict, get_slots, get_spans 13 from vCalendar import to_node 14 import markup 15 import imip_store 16 17 getenv = os.environ.get 18 setenv = os.environ.__setitem__ 19 20 class CGIEnvironment: 21 22 "A CGI-compatible environment." 23 24 def __init__(self): 25 self.args = None 26 self.method = None 27 self.path = None 28 self.path_info = None 29 self.user = None 30 31 def get_args(self): 32 if self.args is None: 33 if self.get_method() != "POST": 34 setenv("QUERY_STRING", "") 35 self.args = cgi.parse(keep_blank_values=True) 36 return self.args 37 38 def get_method(self): 39 if self.method is None: 40 self.method = getenv("REQUEST_METHOD") or "GET" 41 return self.method 42 43 def get_path(self): 44 if self.path is None: 45 self.path = getenv("SCRIPT_NAME") or "" 46 return self.path 47 48 def get_path_info(self): 49 if self.path_info is None: 50 self.path_info = getenv("PATH_INFO") or "" 51 return self.path_info 52 53 def get_user(self): 54 if self.user is None: 55 self.user = getenv("REMOTE_USER") or "" 56 return self.user 57 58 def get_output(self): 59 return sys.stdout 60 61 def get_url(self): 62 path = self.get_path() 63 path_info = self.get_path_info() 64 return "%s%s" % (path.rstrip("/"), path_info) 65 66 class ManagerHandler(Handler): 67 68 "A content handler for use by the manager." 69 70 def __init__(self, details, objtype, user, messenger): 71 Handler.__init__(self, details) 72 self.objtype = objtype 73 self.user = user 74 self.messenger = messenger 75 76 self.organisers = map(get_address, self.get_values("ORGANIZER")) 77 78 # Communication methods. 79 80 def send_message(self, sender): 81 82 """ 83 Create a full calendar object and send it to the organisers from the 84 given 'sender'. 85 """ 86 87 node = to_node({self.objtype : [(self.details, {})]}) 88 part = to_part("REPLY", [node]) 89 message = self.messenger.make_message([part], self.organisers, sender=sender) 90 self.messenger.sendmail(self.organisers, message.as_string(), sender=sender) 91 92 # Action methods. 93 94 def process_request(self, accept): 95 96 """ 97 Process the current request for the given 'user', accepting any request 98 when 'accept' is true, declining requests otherwise. Return whether any 99 action was taken. 100 """ 101 102 # When accepting or declining, do so only on behalf of this user, 103 # preserving any other attributes set as an attendee. 104 105 for attendee, attendee_attr in self.get_items("ATTENDEE"): 106 107 if attendee == self.user: 108 freebusy = self.store.get_freebusy(attendee) 109 110 attendee_attr["PARTSTAT"] = accept and "ACCEPTED" or "DECLINED" 111 self.details["ATTENDEE"] = [(attendee, attendee_attr)] 112 self.send_message(get_address(attendee)) 113 114 return True 115 116 return False 117 118 class Manager: 119 120 "A simple manager application." 121 122 def __init__(self, messenger=None): 123 self.messenger = messenger or Messenger() 124 125 self.env = CGIEnvironment() 126 user = self.env.get_user() 127 self.user = user and get_uri(user) or None 128 self.out = self.env.get_output() 129 self.page = markup.page() 130 self.encoding = "utf-8" 131 132 self.store = imip_store.FileStore() 133 134 try: 135 self.publisher = imip_store.FilePublisher() 136 except OSError: 137 self.publisher = None 138 139 # Data management methods. 140 141 def remove_request(self, uid): 142 return self.store.dequeue_request(self.user, uid) 143 144 # Presentation methods. 145 146 def new_page(self, title): 147 self.page.init(title=title, charset=self.encoding) 148 149 def status(self, code, message): 150 print >>self.out, "Status:", code, message 151 152 def no_user(self): 153 self.status(403, "Forbidden") 154 self.new_page(title="Forbidden") 155 self.page.p("You are not logged in and thus cannot access scheduling requests.") 156 157 def no_page(self): 158 self.status(404, "Not Found") 159 self.new_page(title="Not Found") 160 self.page.p("No page is provided at the given address.") 161 162 def show_requests(self): 163 164 "Show requests for the current user." 165 166 # NOTE: This list could be more informative, but it is envisaged that 167 # NOTE: the requests would be visited directly anyway. 168 169 self.new_page(title="Pending Requests") 170 171 requests = self.store.get_requests(self.user) 172 173 if requests: 174 self.page.p("Pending requests:") 175 176 self.page.ul() 177 178 for request in requests: 179 self.page.li() 180 self.page.a(request, href="%s/%s" % (self.env.get_url().rstrip("/"), request)) 181 self.page.li.close() 182 183 self.page.ul.close() 184 185 else: 186 self.page.p("There are no pending requests.") 187 188 def show_request(self, path_info): 189 190 "Show a request using the given 'path_info' for the current user." 191 192 uid = path_info.lstrip("/").split("/", 1)[0] 193 f = uid and self.store.get_event(self.user, uid) or None 194 195 if not f: 196 return False 197 198 request = parse_object(f, "utf-8") 199 200 if not request: 201 return False 202 203 objtype = request.keys()[0] 204 request = request[objtype][0] 205 206 # Handle a submitted form. 207 208 args = self.env.get_args() 209 show_form = False 210 211 accept = args.has_key("accept") 212 decline = args.has_key("decline") 213 214 if accept or decline: 215 216 handler = ManagerHandler(request, objtype, self.user, self.messenger) 217 218 if handler.process_request(accept): 219 220 # Remove the request from the list. 221 222 self.remove_request(uid) 223 224 elif args.has_key("ignore"): 225 226 # Remove the request from the list. 227 228 self.remove_request(uid) 229 230 else: 231 show_form = True 232 233 self.new_page(title="Request") 234 235 # Provide a summary of the request. 236 237 self.page.p("The following request was received:") 238 self.page.dl() 239 240 for name in ["SUMMARY", "DTSTART", "DTEND", "ORGANIZER", "ATTENDEE"]: 241 for value in get_values(request, name): 242 self.page.dt(name) 243 self.page.dd(value) 244 245 self.page.dl.close() 246 247 dtstart = format_datetime(get_utc_datetime(request, "DTSTART")) 248 dtend = format_datetime(get_utc_datetime(request, "DTEND")) 249 250 # Indicate whether there are conflicting events. 251 252 freebusy = self.store.get_freebusy(self.user) 253 254 if freebusy: 255 256 # Obtain any time zone details from the suggested event. 257 258 _dtstart, attr = get_item(request, "DTSTART") 259 tzid = attr.get("TZID") 260 261 # Show any conflicts. 262 263 for t in have_conflict(freebusy, [(dtstart, dtend)], True): 264 start, end, found_uid = t[:3] 265 if uid != found_uid: 266 start = format_datetime(to_timezone(get_datetime(start), tzid)) 267 end = format_datetime(to_timezone(get_datetime(end), tzid)) 268 self.page.p("Event conflicts with another from %s to %s." % (start, end)) 269 270 # Show a form if no action has just been taken. 271 272 if show_form: 273 self.page.p("Action to take for this request:") 274 self.page.form(method="POST") 275 self.page.p() 276 self.page.input(name="accept", type="submit", value="Accept") 277 self.page.add(" ") 278 self.page.input(name="decline", type="submit", value="Decline") 279 self.page.add(" ") 280 self.page.input(name="ignore", type="submit", value="Ignore") 281 self.page.p.close() 282 self.page.form.close() 283 284 return True 285 286 def show_calendar(self): 287 288 "Show the calendar for the current user." 289 290 self.new_page(title="Calendar") 291 292 freebusy = self.store.get_freebusy(self.user) 293 page = self.page 294 295 if not freebusy: 296 page.p("No events scheduled.") 297 return 298 299 # Day view: start at the earliest known day and produce days until the 300 # latest known day, perhaps with expandable sections of empty days. 301 302 # Month view: start at the earliest known month and produce months until 303 # the latest known month, perhaps with expandable sections of empty 304 # months. 305 306 # Details of users to invite to new events could be superimposed on the 307 # calendar. 308 309 # Requests could be listed and linked to their tentative positions in 310 # the calendar. 311 312 slots = get_slots(freebusy) 313 spans = get_spans(slots) 314 315 page.table(border=1, cellspacing=0, cellpadding=5) 316 317 for point, active in slots: 318 page.tr() 319 page.th(class_="timeslot") 320 page.add(point) 321 page.th.close() 322 323 for t in active: 324 if t: 325 start, end, uid = t[:3] 326 span = spans[uid] 327 if point == start: 328 page.td(class_="event", rowspan=span) 329 page.add(uid) 330 page.td.close() 331 else: 332 page.td(class_="empty") 333 page.td.close() 334 335 page.tr.close() 336 337 page.table.close() 338 339 def select_action(self): 340 341 "Select the desired action and show the result." 342 343 path_info = self.env.get_path_info().rstrip("/") 344 if not path_info: 345 self.show_requests() 346 elif path_info.rsplit("/", 1)[-1] == "calendar": 347 self.show_calendar() 348 elif self.show_request(path_info): 349 pass 350 else: 351 self.no_page() 352 353 def __call__(self): 354 355 "Interpret a request and show an appropriate response." 356 357 if not self.user: 358 self.no_user() 359 else: 360 self.select_action() 361 362 # Write the headers and actual content. 363 364 print >>self.out, "Content-Type: text/html; charset=%s" % self.encoding 365 print >>self.out 366 self.out.write(unicode(self.page).encode(self.encoding)) 367 368 if __name__ == "__main__": 369 Manager( 370 Messenger( 371 "imip-agent@example.com", 372 "Calendar system message", 373 "This is a message from the calendar system." 374 ) 375 )() 376 377 # vim: tabstop=4 expandtab shiftwidth=4