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 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.ul() 175 176 for request in requests: 177 self.page.li() 178 self.page.a(request, href="%s/%s" % (self.env.get_url().rstrip("/"), request)) 179 self.page.li.close() 180 181 self.page.ul.close() 182 183 else: 184 self.page.p("There are no pending requests.") 185 186 def show_request(self, path_info): 187 188 "Show a request using the given 'path_info' for the current user." 189 190 uid = path_info.lstrip("/").split("/", 1)[0] 191 f = uid and self.store.get_event(self.user, uid) or None 192 193 if not f: 194 return False 195 196 request = parse_object(f, "utf-8") 197 198 if not request: 199 return False 200 201 objtype = request.keys()[0] 202 request = request[objtype][0] 203 204 # Handle a submitted form. 205 206 args = self.env.get_args() 207 show_form = False 208 209 accept = args.has_key("accept") 210 decline = args.has_key("decline") 211 212 if accept or decline: 213 214 handler = ManagerHandler(request, objtype, self.user, self.messenger) 215 216 if handler.process_request(accept): 217 218 # Remove the request from the list. 219 220 self.remove_request(uid) 221 222 elif args.has_key("ignore"): 223 224 # Remove the request from the list. 225 226 self.remove_request(uid) 227 228 else: 229 show_form = True 230 231 self.new_page(title="Request") 232 233 # Provide a summary of the request. 234 235 self.page.p("The following request was received:") 236 self.page.dl() 237 238 for name in ["SUMMARY", "DTSTART", "DTEND", "ORGANIZER", "ATTENDEE"]: 239 for value in get_values(request, name): 240 self.page.dt(name) 241 self.page.dd(value) 242 243 self.page.dl.close() 244 245 dtstart = format_datetime(get_utc_datetime(request, "DTSTART")) 246 dtend = format_datetime(get_utc_datetime(request, "DTEND")) 247 248 # Indicate whether there are conflicting events. 249 250 freebusy = self.store.get_freebusy(self.user) 251 252 if freebusy: 253 254 # Obtain any time zone details from the suggested event. 255 256 _dtstart, attr = get_item(request, "DTSTART") 257 tzid = attr.get("TZID") 258 259 # Show any conflicts. 260 261 for start, end, found_uid in have_conflict(freebusy, [(dtstart, dtend)], True): 262 if uid != found_uid: 263 start = format_datetime(to_timezone(get_datetime(start), tzid)) 264 end = format_datetime(to_timezone(get_datetime(end), tzid)) 265 self.page.p("Event conflicts with another from %s to %s." % (start, end)) 266 267 # Show a form if no action has just been taken. 268 269 if show_form: 270 self.page.p("Action to take for this request:") 271 self.page.form(method="POST") 272 self.page.p() 273 self.page.input(name="accept", type="submit", value="Accept") 274 self.page.add(" ") 275 self.page.input(name="decline", type="submit", value="Decline") 276 self.page.add(" ") 277 self.page.input(name="ignore", type="submit", value="Ignore") 278 self.page.p.close() 279 self.page.form.close() 280 281 return True 282 283 def select_action(self): 284 285 "Select the desired action and show the result." 286 287 path_info = self.env.get_path_info().rstrip("/") 288 if not path_info: 289 self.show_requests() 290 elif self.show_request(path_info): 291 pass 292 else: 293 self.no_page() 294 295 def __call__(self): 296 297 "Interpret a request and show an appropriate response." 298 299 if not self.user: 300 self.no_user() 301 else: 302 self.select_action() 303 304 # Write the headers and actual content. 305 306 print >>self.out, "Content-Type: text/html; charset=%s" % self.encoding 307 print >>self.out 308 self.out.write(unicode(self.page).encode(self.encoding)) 309 310 if __name__ == "__main__": 311 Manager( 312 Messenger( 313 "imip-agent@example.com", 314 "Calendar system message", 315 "This is a message from the calendar system." 316 ) 317 )() 318 319 # vim: tabstop=4 expandtab shiftwidth=4