4 * This is the main transaction loop of the web service. It maintains a
5 * persistent session to the Citadel server, handling HTTP WebCit requests as
6 * they arrive and presenting a user interface.
8 #define SHOW_ME_VAPPEND_PRINTF
13 #include "webserver.h"
17 * String to unset the cookie.
18 * Any date "in the past" will work, so I chose my birthday, right down to
19 * the exact minute. :)
21 static char *unset = "; expires=28-May-1971 18:10:00 GMT";
22 StrBuf *csslocal = NULL;
23 HashList *HandlerHash = NULL;
26 void DeleteWebcitHandler(void *vHandler)
28 WebcitHandler *Handler = (WebcitHandler*) vHandler;
29 FreeStrBuf(&Handler->Name);
34 void WebcitAddUrlHandler(const char * UrlString,
39 WebcitHandler *NewHandler;
40 NewHandler = (WebcitHandler*) malloc(sizeof(WebcitHandler));
42 NewHandler->Flags = Flags;
43 NewHandler->Name = NewStrBufPlain(UrlString, UrlSLen);
44 Put(HandlerHash, UrlString, UrlSLen, NewHandler, DeleteWebcitHandler);
49 * web-printing funcion. uses our vsnprintf wrapper
51 void wprintf(const char *format,...)
56 if (WCC->WBuf == NULL)
57 WCC->WBuf = NewStrBuf();
59 va_start(arg_ptr, format);
60 StrBufVAppendPrintf(WCC->WBuf, format, arg_ptr);
65 * http-header-printing funcion. uses our vsnprintf wrapper
67 void hprintf(const char *format,...)
72 va_start(arg_ptr, format);
73 StrBufVAppendPrintf(WCC->HBuf, format, arg_ptr);
80 * wrap up an HTTP session, closes tags, etc.
82 * print_standard_html_footer should be set to:
83 * 0 - to transmit only,
84 * nonzero - to append the closing tags
86 void wDumpContent(int print_standard_html_footer)
88 if (print_standard_html_footer) {
89 wprintf("</div> <!-- end of 'content' div -->\n");
90 do_template("trailing", NULL);
93 /* If we've been saving it all up for one big output burst,
94 * go ahead and do that now.
103 * Output HTTP headers and leading HTML for a page
105 void output_headers( int do_httpheaders, /* 1 = output HTTP headers */
106 int do_htmlhead, /* 1 = output HTML <head> section and <body> opener */
108 int do_room_banner, /* 0=no, 1=yes,
109 * 2 = I'm going to embed my own, so don't open the
110 * <div id="content"> either.
113 int unset_cookies, /* 1 = session is terminating, so unset the cookies */
114 int suppress_check, /* 1 = suppress check for instant messages */
115 int cache /* 1 = allow browser to cache this page */
121 hprintf("HTTP/1.1 200 OK\n");
122 http_datestring(httpnow, sizeof httpnow, time(NULL));
124 if (do_httpheaders) {
125 if (WCC->serv_info != NULL)
126 hprintf("Content-type: text/html; charset=utf-8\r\n"
128 "Connection: close\r\n",
130 ChrPtr(WCC->serv_info->serv_software));
132 hprintf("Content-type: text/html; charset=utf-8\r\n"
133 "Server: %s / [n/a]\n"
134 "Connection: close\r\n",
139 char httpTomorow[128];
141 http_datestring(httpTomorow, sizeof httpTomorow,
142 time(NULL) + 60 * 60 * 24 * 2);
144 hprintf("Pragma: public\r\n"
145 "Cache-Control: max-age=3600, must-revalidate\r\n"
146 "Last-modified: %s\r\n"
153 hprintf("Pragma: no-cache\r\n"
154 "Cache-Control: no-store\r\n"
159 stuff_to_cookie(cookie, 1024,
160 WCC->wc_session, WCC->wc_username,
161 WCC->wc_password, WCC->wc_roomname);
164 hprintf("Set-cookie: webcit=%s; path=/\r\n", unset);
166 hprintf("Set-cookie: webcit=%s; path=/\r\n", cookie);
167 if (server_cookie != NULL) {
168 hprintf("%s\n", server_cookie);
174 do_template("head", NULL);
176 /* check for ImportantMessages (these display in a div overlaying the main screen) */
177 if (!IsEmptyStr(WCC->ImportantMessage)) {
178 wprintf("<div id=\"important_message\">\n"
179 "<span class=\"imsg\">");
180 StrEscAppend(WCC->WBuf, NULL, WCC->ImportantMessage, 0, 0);
181 wprintf("</span><br />\n"
184 StrBufAppendBufPlain(WCC->trailing_javascript,
185 HKEY("setTimeout('hide_imsg_popup()', 5000); \n"),
188 WCC->ImportantMessage[0] = 0;
190 else if (StrLength(WCC->ImportantMsg) > 0) {
191 wprintf("<div id=\"important_message\">\n"
192 "<span class=\"imsg\">");
193 StrEscAppend(WCC->WBuf, WCC->ImportantMsg, NULL, 0, 0);
194 wprintf("</span><br />\n"
197 StrBufAppendBufPlain(WCC->trailing_javascript,
198 HKEY("setTimeout('hide_imsg_popup()', 5000); \n"),
201 FlushStrBuf(WCC->ImportantMsg);
203 if ( (WCC->logged_in) && (!unset_cookies) ) {
204 /*DoTemplate(HKEY("iconbar"), NULL, &NoCtx);*/
208 if (do_room_banner == 1) {
209 wprintf("<div id=\"banner\">\n");
210 embed_room_banner(NULL, navbar_default);
215 if (do_room_banner == 1) {
216 wprintf("<div id=\"content\">\n");
220 void output_custom_content_header(const char *ctype) {
221 hprintf("HTTP/1.1 200 OK\r\n");
222 hprintf("Content-type: %s; charset=utf-8\r\n",ctype);
223 hprintf("Server: %s / %s\r\n", PACKAGE_STRING, ChrPtr(WC->serv_info->serv_software));
224 hprintf("Connection: close\r\n");
229 * Generic function to do an HTTP redirect. Easy and fun.
231 void http_redirect(const char *whichpage) {
232 hprintf("HTTP/1.1 302 Moved Temporarily\n");
233 hprintf("Location: %s\r\n", whichpage);
234 hprintf("URI: %s\r\n", whichpage);
235 hprintf("Content-type: text/html; charset=utf-8\r\n");
236 wprintf("<html><body>");
237 wprintf("Go <a href=\"%s\">here</A>.", whichpage);
238 wprintf("</body></html>\n");
245 * Output a piece of content to the web browser using conformant HTTP and MIME semantics
247 void http_transmit_thing(const char *content_type,
251 lprintf(9, "http_transmit_thing(%s)%s\n",
253 (is_static ? " (static)" : "")
256 output_headers(0, 0, 0, 0, 0, is_static);
258 hprintf("Content-type: %s\r\n"
260 "Connection: close\r\n",
268 * print menu box like used in the floor view or admin interface.
269 * This function takes pair of strings as va_args,
270 * Title Title string of the box
271 * Class CSS Class for the box
272 * nLines How many string pairs should we print? (URL, UrlText)
273 * ... Pairs of URL Strings and their Names
275 void print_menu_box(char* Title, char *Class, int nLines, ...)
280 svput("BOXTITLE", WCS_STRING, Title);
281 do_template("beginboxx", NULL);
283 wprintf("<ul class=\"%s\">", Class);
285 va_start(arg_list, nLines);
286 for (i = 0; i < nLines; ++i)
288 wprintf("<li><a href=\"%s\">", va_arg(arg_list, char *));
289 wprintf((char *) va_arg(arg_list, char *));
290 wprintf("</a></li>\n");
294 wprintf("</a></li>\n");
298 do_template("endbox", NULL);
304 * Convenience functions to display a page containing only a string
306 * titlebarcolor color of the titlebar of the frame
307 * titlebarmsg text to display in the title bar
308 * messagetext body of the box
310 void convenience_page(const char *titlebarcolor, const char *titlebarmsg, const char *messagetext)
312 hprintf("HTTP/1.1 200 OK\n");
313 output_headers(1, 1, 2, 0, 0, 0);
314 wprintf("<div id=\"banner\">\n");
315 wprintf("<table width=100%% border=0 bgcolor=\"#%s\"><tr><td>", titlebarcolor);
316 wprintf("<span class=\"titlebar\">%s</span>\n", titlebarmsg);
317 wprintf("</td></tr></table>\n");
318 wprintf("</div>\n<div id=\"content\">\n");
319 escputs(messagetext);
327 * Display a blank page.
329 void blank_page(void) {
330 output_headers(1, 1, 0, 0, 0, 0);
336 * A template has been requested
338 void url_do_template(void) {
339 const StrBuf *MimeType;
340 const StrBuf *Tmpl = sbstr("template");
342 MimeType = DoTemplate(SKEY(Tmpl), NULL, &NoCtx);
343 http_transmit_thing(ChrPtr(MimeType), 0);
349 * convenience function to indicate success
351 void display_success(char *successmessage)
353 convenience_page("007700", "OK", successmessage);
358 * Authorization required page
359 * This is probably temporary and should be revisited
361 void authorization_required(const char *message)
363 hprintf("HTTP/1.1 401 Authorization Required\r\n");
364 hprintf("WWW-Authenticate: Basic realm=\"%s\"\r\n", ChrPtr(WC->serv_info->serv_humannode));
365 hprintf("Content-Type: text/html\r\n");
367 wprintf(_("Authorization Required"));
368 wprintf("</h1>\r\n");
369 wprintf(_("The resource you requested requires a valid username and password. "
370 "You could not be logged in: %s\n"), message);
376 * Convenience functions to wrap around asynchronous ajax responses
378 void begin_ajax_response(void) {
381 FlushStrBuf(WCC->HBuf);
382 output_headers(0, 0, 0, 0, 0, 0);
384 hprintf("Content-type: text/html; charset=UTF-8\r\n"
386 "Connection: close\r\n"
393 * print ajax response footer
395 void end_ajax_response(void) {
399 /* If it's a "force 404" situation then display the error and bail. */
402 hprintf("HTTP/1.1 404 Not found\r\n");
403 hprintf("Content-Type: text/plain\r\n");
404 wprintf("Not found\r\n");
410 * Wraps a Citadel server command in an AJAX transaction.
412 void ajax_servcmd(void)
420 begin_ajax_response();
422 serv_puts(bstr("g_cmd"));
423 StrBuf_ServGetln(Buf);
424 StrBufAppendBuf(WCC->WBuf, Buf, 0);
425 StrBufAppendBufPlain(WCC->WBuf, HKEY("\n"), 0);
427 switch (GetServerStatus(Buf, NULL)) {
429 serv_puts("\n\n000");
430 if ( (StrLength(Buf)==3) &&
431 !strcmp(ChrPtr(Buf), "000")) {
432 StrBufAppendBufPlain(WCC->WBuf, HKEY("\000"), 0);
437 StrBuf_ServGetln(Buf);
438 if ( (StrLength(Buf)==3) &&
439 !strcmp(ChrPtr(Buf), "000")) {
442 StrBufAppendBuf(WCC->WBuf, Buf, 0);
443 StrBufAppendBufPlain(WCC->WBuf, HKEY("\n"), 0);
447 text_to_server(bstr("g_input"));
451 len = atol(&ChrPtr(Buf)[4]);
452 StrBuf_ServGetBLOBBuffered(Buf, len);
455 len = atol(&ChrPtr(Buf)[4]);
457 memset(junk, 0, len);
458 serv_write(junk, len);
465 * This is kind of an ugly hack, but this is the only place it can go.
466 * If the command was GEXP, then the instant messenger window must be
467 * running, so reset the "last_pager_check" watchdog timer so
468 * that page_popup() doesn't try to open it a second time.
470 if (!strncasecmp(bstr("g_cmd"), "GEXP", 4)) {
471 WCC->last_pager_check = time(NULL);
478 * Helper function for the asynchronous check to see if we need
479 * to open the instant messenger window.
481 void seconds_since_last_gexp(void)
485 if ( (time(NULL) - WC->last_pager_check) < 30) {
491 serv_getln(buf, sizeof buf);
503 void ReadPostData(void)
505 const char *content_end = NULL;
508 StrBuf *content = NULL;
510 content = NewStrBuf();
512 StrBufPrintf(content,
514 "Content-length: %ld\n\n",
515 ChrPtr(WCC->Hdr->ContentType),
516 WCC->Hdr->ContentLength);
518 hprintf("Content-type: %s\n"
519 "Content-length: %d\n\n",
520 ContentType, ContentLength);
522 body_start = StrLength(content);
524 /** Read the entire input data at once. */
525 client_read_to(&WCC->Hdr->http_sock,
527 WCC->Hdr->ReadBuf, &WCC->Hdr->Pos,
528 WCC->Hdr->ContentLength,
531 if (!strncasecmp(ChrPtr(WCC->Hdr->ContentType), "application/x-www-form-urlencoded", 33)) {
532 StrBufCutLeft(content, body_start);
533 ParseURLParams(content);
534 } else if (!strncasecmp(ChrPtr(WCC->Hdr->ContentType), "multipart", 9)) {
535 content_end = ChrPtr(content) +
536 WCC->Hdr->ContentLength +
538 mime_parser(ChrPtr(content), content_end, *upload_handler, NULL, NULL, NULL, 0);
540 FreeStrBuf(&content);
545 * Entry point for WebCit transaction
547 void session_loop(void)
556 * We stuff these with the values coming from the client cookies,
557 * so we can use them to reconnect a timed out session if we have to.
566 WCC->upload_length = 0;
569 WCC->trailing_javascript = NewStrBuf();
570 WCC->Hdr->nWildfireHeaders = 0;
571 if (WCC->Hdr->Handler != NULL)
572 Flags = WCC->Hdr->Handler->Flags; /* so we can temporarily add our own... */
574 if (WCC->Hdr->ContentLength > 0) {
578 /* If there are variables in the URL, we must grab them now */
579 if (WCC->Hdr->PlainArgs != NULL)
580 ParseURLParams(WCC->Hdr->PlainArgs);
582 /* If the client sent a nonce that is incorrect, kill the request. */
583 if (havebstr("nonce")) {
584 lprintf(9, "Comparing supplied nonce %s to session nonce %ld\n",
585 bstr("nonce"), WCC->nonce);
586 if (ibstr("nonce") != WCC->nonce) {
587 lprintf(9, "Ignoring request with mismatched nonce.\n");
588 hprintf("HTTP/1.1 404 Security check failed\r\n");
589 hprintf("Content-Type: text/plain\r\n\r\n");
590 wprintf("Security check failed.\r\n");
592 goto SKIP_ALL_THIS_CRAP;
597 * If we're not connected to a Citadel server, try to hook up the
600 if (!WCC->connected) {
602 goto SKIP_ALL_THIS_CRAP;
607 * If we're not logged in, but we have HTTP Authentication data,
608 * try logging in to Citadel using that.
610 if ((!WCC->logged_in)
611 && (StrLength(WCC->Hdr->c_username) > 0)
612 && (StrLength(WCC->Hdr->c_password) > 0))
615 serv_printf("USER %s", ChrPtr(WCC->Hdr->c_username));
616 StrBuf_ServGetln(Buf);
617 if (GetServerStatus(Buf, NULL) == 3) {
618 serv_printf("PASS %s", ChrPtr(WCC->Hdr->c_password));
619 StrBuf_ServGetln(Buf);
620 if (GetServerStatus(Buf, NULL) == 2) {
621 become_logged_in(WCC->Hdr->c_username,
622 WCC->Hdr->c_password, Buf);
624 /* Should only display when password is wrong */
625 authorization_required(&buf[4]);
627 goto SKIP_ALL_THIS_CRAP;
632 xhttp = (WCC->Hdr->eReqType != eGET) &&
633 (WCC->Hdr->eReqType != ePOST) &&
634 (WCC->Hdr->eReqType != eHEAD);
637 * If we're not logged in, but we have username and password cookies
638 * supplied by the browser, try using them to log in.
640 if ((!WCC->logged_in)
641 && (StrLength(WCC->Hdr->c_username)>0)
642 && (StrLength(WCC->Hdr->c_password)>0)) {
643 ReEstablish_Session();
647 * If a 'gotofirst' parameter has been specified, attempt to goto that room
648 * prior to doing anything else.
650 if (havebstr("gotofirst")) {
652 ret = gotoroom(sbstr("gotofirst")); /* do this quietly to avoid session output! */
654 lprintf(1, "GOTOFIRST: Unable to change to [%s]; Reason: %d\n", bstr("gotofirst"), ret);
657 if (WCC->Hdr->Handler != NULL) {
658 if (!WCC->logged_in && ((WCC->Hdr->Handler->Flags & ANONYMOUS) == 0)) {
662 if ((WCC->Hdr->Handler->Flags & AJAX) != 0)
663 begin_ajax_response();
664 WCC->Hdr->Handler->F();
665 if ((WCC->Hdr->Handler->Flags & AJAX) != 0)
669 /* When all else fais, display the main menu. */
678 if (WCC->SavePrefsToServer) {
680 WCC->SavePrefsToServer = 0;
684 WCC->Hdr->http_host = NULL;
689 * Replacement for sleep() that uses select() in order to avoid SIGALRM
691 void sleeeeeeeeeep(int seconds)
697 select(0, NULL, NULL, NULL, &tv);
701 int ConditionalImportantMesage(StrBuf *Target, WCTemplputParams *TP)
705 return ((!IsEmptyStr(WCC->ImportantMessage)) ||
706 (StrLength(WCC->ImportantMsg) > 0));
711 void tmplput_importantmessage(StrBuf *Target, WCTemplputParams *TP)
716 if (!IsEmptyStr(WCC->ImportantMessage)) {
717 StrEscAppend(Target, NULL, WCC->ImportantMessage, 0, 0);
718 WCC->ImportantMessage[0] = '\0';
720 else if (StrLength(WCC->ImportantMsg) > 0) {
721 StrEscAppend(Target, WCC->ImportantMsg, NULL, 0, 0);
722 FlushStrBuf(WCC->ImportantMsg);
727 void tmplput_trailing_javascript(StrBuf *Target, WCTemplputParams *TP)
732 StrBufAppendTemplate(Target, TP, WCC->trailing_javascript, 0);
735 void tmplput_csslocal(StrBuf *Target, WCTemplputParams *TP)
737 StrBufAppendBuf(Target,
741 extern char static_local_dir[PATH_MAX];
749 WebcitAddUrlHandler(HKEY("404"), do_404, ANONYMOUS|COOKIEUNNEEDED);
750 WebcitAddUrlHandler(HKEY("blank"), blank_page, ANONYMOUS|COOKIEUNNEEDED|ISSTATIC);
753 WebcitAddUrlHandler(HKEY("blank"), blank_page, ANONYMOUS);
754 WebcitAddUrlHandler(HKEY("do_template"), url_do_template, ANONYMOUS);
755 WebcitAddUrlHandler(HKEY("sslg"), seconds_since_last_gexp, AJAX|LOGCHATTY);
756 WebcitAddUrlHandler(HKEY("ajax_servcmd"), ajax_servcmd, 0);
758 RegisterConditional(HKEY("COND:IMPMSG"), 0, ConditionalImportantMesage, CTX_NONE);
759 RegisterNamespace("CSSLOCAL", 0, 0, tmplput_csslocal, CTX_NONE);
760 RegisterNamespace("IMPORTANTMESSAGE", 0, 0, tmplput_importantmessage, CTX_NONE);
761 RegisterNamespace("TRAILING_JAVASCRIPT", 0, 0, tmplput_trailing_javascript, CTX_NONE);
763 snprintf(dir, SIZ, "%s/static.local/webcit.css", static_local_dir);
764 if (!access(dir, R_OK)) {
765 lprintf(9, "Using local Stylesheet [%s]\n", dir);
766 csslocal = NewStrBufPlain(HKEY("<link href=\"static.local/webcit.css\" rel=\"stylesheet\" type=\"text/css\">"));
769 lprintf(9, "Didn't find site local Stylesheet [%s]\n", dir);
774 ServerStartModule_WEBCIT
777 HandlerHash = NewHash(1, NULL);
782 ServerShutdownModule_WEBCIT
785 FreeStrBuf(&csslocal);
786 DeleteHash(&HandlerHash);
792 SessionNewModule_WEBCIT
795 sess->ImportantMsg = NewStrBuf();
796 sess->WBuf = NewStrBuf();
797 sess->HBuf = NewStrBuf();
801 SessionDetachModule_WEBCIT
804 DeleteHash(&sess->Hdr->urlstrings);// TODO?
805 if (sess->upload_length > 0) {
807 sess->upload_length = 0;
809 FreeStrBuf(&sess->trailing_javascript);
811 if (StrLength(sess->WBuf) > SIZ * 30) /* Bigger than 120K? release. */
813 FreeStrBuf(&sess->WBuf);
814 sess->WBuf = NewStrBuf();
817 FlushStrBuf(sess->WBuf);
818 FlushStrBuf(sess->HBuf);
822 SessionDestroyModule_WEBCIT
825 FreeStrBuf(&sess->WBuf);
826 FreeStrBuf(&sess->HBuf);
827 FreeStrBuf(&sess->ImportantMsg);