1 #!/usr/bin/env python 2 3 import cgi, os, sys 4 5 sys.path.append("/var/lib/imip-agent") 6 7 from imiptools import Messenger 8 from imiptools.content import Handler, \ 9 format_datetime, get_address, get_datetime, \ 10 get_item, get_uri, get_utc_datetime, get_values, \ 11 parse_object, to_part, to_timezone 12 from imiptools.period import have_conflict 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) 90 self.messenger.sendmail(self.organisers, message.as_string()) 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 # Update the free/busy information. 115 116 if accept: 117 periods = self.get_periods() 118 self.update_freebusy(freebusy, attendee, periods) 119 120 if self.publisher: 121 self.publisher.set_freebusy(attendee, freebusy) 122 123 return True 124 125 return False 126 127 class Manager: 128 129 "A simple manager application." 130 131 def __init__(self, messenger=None): 132 self.messenger = messenger or Messenger() 133 134 self.env = CGIEnvironment() 135 user = self.env.get_user() 136 self.user = user and get_uri(user) or None 137 self.out = self.env.get_output() 138 self.page = markup.page() 139 self.encoding = "utf-8" 140 141 self.store = imip_store.FileStore() 142 143 try: 144 self.publisher = imip_store.FilePublisher() 145 except OSError: 146 self.publisher = None 147 148 # Data management methods. 149 150 def remove_request(self, uid): 151 requests = self.store.get_requests(self.user) 152 if uid in requests: 153 requests.remove(uid) 154 self.store.set_requests(self.user, requests) 155 156 # Presentation methods. 157 158 def new_page(self, title): 159 self.page.init(title=title, charset=self.encoding) 160 161 def status(self, code, message): 162 print >>self.out, "Status:", code, message 163 164 def no_user(self): 165 self.status(403, "Forbidden") 166 self.new_page(title="Forbidden") 167 self.page.p("You are not logged in and thus cannot access scheduling requests.") 168 169 def no_page(self): 170 self.status(404, "Not Found") 171 self.new_page(title="Not Found") 172 self.page.p("No page is provided at the given address.") 173 174 def show_requests(self): 175 176 "Show requests for the current user." 177 178 # NOTE: This list could be more informative, but it is envisaged that 179 # NOTE: the requests would be visited directly anyway. 180 181 self.new_page(title="Pending Requests") 182 183 requests = self.store.get_requests(self.user) 184 185 if requests: 186 self.page.ul() 187 188 for request in requests: 189 self.page.li() 190 self.page.a(request, href="%s/%s" % (self.env.get_url().rstrip("/"), request)) 191 self.page.li.close() 192 193 self.page.ul.close() 194 195 else: 196 self.page.p("There are no pending requests.") 197 198 def show_request(self, path_info): 199 200 "Show a request using the given 'path_info' for the current user." 201 202 uid = path_info.lstrip("/").split("/", 1)[0] 203 f = uid and self.store.get_event(self.user, uid) or None 204 205 if not f: 206 return False 207 208 request = parse_object(f, "utf-8") 209 210 if not request: 211 return False 212 213 objtype = request.keys()[0] 214 request = request[objtype][0] 215 216 # Handle a submitted form. 217 218 args = self.env.get_args() 219 show_form = False 220 221 accept = args.has_key("accept") 222 decline = args.has_key("decline") 223 224 if accept or decline: 225 226 handler = ManagerHandler(request, objtype, self.user, self.messenger) 227 228 if handler.process_request(accept): 229 230 # Remove the request from the list. 231 232 self.remove_request(uid) 233 234 elif args.has_key("ignore"): 235 236 # Remove the request from the list. 237 238 self.remove_request(uid) 239 240 else: 241 show_form = True 242 243 self.new_page(title="Request") 244 245 # Provide a summary of the request. 246 247 self.page.p("The following request was received:") 248 self.page.dl() 249 250 for name in ["SUMMARY", "DTSTART", "DTEND", "ORGANIZER", "ATTENDEE"]: 251 for value in get_values(request, name): 252 self.page.dt(name) 253 self.page.dd(value) 254 255 self.page.dl.close() 256 257 dtstart = format_datetime(get_utc_datetime(request, "DTSTART")) 258 dtend = format_datetime(get_utc_datetime(request, "DTEND")) 259 260 # Indicate whether there are conflicting events. 261 262 freebusy = self.store.get_freebusy(self.user) 263 264 if freebusy: 265 266 # Obtain any time zone details from the suggested event. 267 268 _dtstart, attr = get_item(request, "DTSTART") 269 tzid = attr.get("TZID") 270 271 # Show any conflicts. 272 273 for start, end, found_uid in have_conflict(freebusy, [(dtstart, dtend)], True): 274 if uid != found_uid: 275 start = format_datetime(to_timezone(get_datetime(start), tzid)) 276 end = format_datetime(to_timezone(get_datetime(end), tzid)) 277 self.page.p("Event conflicts with another from %s to %s." % (start, end)) 278 279 # Show a form if no action has just been taken. 280 281 if show_form: 282 self.page.p("Action to take for this request:") 283 self.page.form(method="POST") 284 self.page.p() 285 self.page.input(name="accept", type="submit", value="Accept") 286 self.page.add(" ") 287 self.page.input(name="decline", type="submit", value="Decline") 288 self.page.add(" ") 289 self.page.input(name="ignore", type="submit", value="Ignore") 290 self.page.p.close() 291 self.page.form.close() 292 293 return True 294 295 def select_action(self): 296 297 "Select the desired action and show the result." 298 299 path_info = self.env.get_path_info().rstrip("/") 300 if not path_info: 301 self.show_requests() 302 elif self.show_request(path_info): 303 pass 304 else: 305 self.no_page() 306 307 def __call__(self): 308 309 "Interpret a request and show an appropriate response." 310 311 if not self.user: 312 self.no_user() 313 else: 314 self.select_action() 315 316 # Write the headers and actual content. 317 318 print >>self.out, "Content-Type: text/html; charset=%s" % self.encoding 319 print >>self.out 320 self.out.write(unicode(self.page).encode(self.encoding)) 321 322 if __name__ == "__main__": 323 Manager()() 324 325 # vim: tabstop=4 expandtab shiftwidth=4