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"
161 stuff_to_cookie(cookie, 1024,
166 get_selected_language()
170 hprintf("Set-cookie: webcit=%s; path=/\r\n", unset);
172 hprintf("Set-cookie: webcit=%s; path=/\r\n", cookie);
173 if (server_cookie != NULL) {
174 hprintf("%s\n", server_cookie);
181 do_template("head", NULL);
183 /* check for ImportantMessages (these display in a div overlaying the main screen) */
184 if (!IsEmptyStr(WCC->ImportantMessage)) {
185 wprintf("<div id=\"important_message\">\n"
186 "<span class=\"imsg\">");
187 StrEscAppend(WCC->WBuf, NULL, WCC->ImportantMessage, 0, 0);
188 wprintf("</span><br />\n"
191 StrBufAppendBufPlain(WCC->trailing_javascript,
192 HKEY("setTimeout('hide_imsg_popup()', 5000); \n"),
195 WCC->ImportantMessage[0] = 0;
197 else if (StrLength(WCC->ImportantMsg) > 0) {
198 wprintf("<div id=\"important_message\">\n"
199 "<span class=\"imsg\">");
200 StrEscAppend(WCC->WBuf, WCC->ImportantMsg, NULL, 0, 0);
201 wprintf("</span><br />\n"
204 StrBufAppendBufPlain(WCC->trailing_javascript,
205 HKEY("setTimeout('hide_imsg_popup()', 5000); \n"),
208 FlushStrBuf(WCC->ImportantMsg);
210 if ( (WCC->logged_in) && (!unset_cookies) ) {
211 /*DoTemplate(HKEY("iconbar"), NULL, &NoCtx);*/
215 if (do_room_banner == 1) {
216 wprintf("<div id=\"banner\">\n");
217 embed_room_banner(NULL, navbar_default);
222 if (do_room_banner == 1) {
223 wprintf("<div id=\"content\">\n");
227 void output_custom_content_header(const char *ctype) {
228 hprintf("HTTP/1.1 200 OK\r\n");
229 hprintf("Content-type: %s; charset=utf-8\r\n",ctype);
230 hprintf("Server: %s / %s\r\n", PACKAGE_STRING, ChrPtr(WC->serv_info->serv_software));
231 hprintf("Connection: close\r\n");
236 * Generic function to do an HTTP redirect. Easy and fun.
238 void http_redirect(const char *whichpage) {
239 hprintf("HTTP/1.1 302 Moved Temporarily\n");
240 hprintf("Location: %s\r\n", whichpage);
241 hprintf("URI: %s\r\n", whichpage);
242 hprintf("Content-type: text/html; charset=utf-8\r\n");
243 wprintf("<html><body>");
244 wprintf("Go <a href=\"%s\">here</A>.", whichpage);
245 wprintf("</body></html>\n");
252 * Output a piece of content to the web browser using conformant HTTP and MIME semantics
254 void http_transmit_thing(const char *content_type,
258 lprintf(9, "http_transmit_thing(%s)%s\n",
260 ((is_static > 0) ? " (static)" : "")
263 output_headers(0, 0, 0, 0, 0, is_static);
265 hprintf("Content-type: %s\r\n"
267 "Connection: close\r\n",
275 * print menu box like used in the floor view or admin interface.
276 * This function takes pair of strings as va_args,
277 * Title Title string of the box
278 * Class CSS Class for the box
279 * nLines How many string pairs should we print? (URL, UrlText)
280 * ... Pairs of URL Strings and their Names
282 void print_menu_box(char* Title, char *Class, int nLines, ...)
287 svput("BOXTITLE", WCS_STRING, Title);
288 do_template("beginboxx", NULL);
290 wprintf("<ul class=\"%s\">", Class);
292 va_start(arg_list, nLines);
293 for (i = 0; i < nLines; ++i)
295 wprintf("<li><a href=\"%s\">", va_arg(arg_list, char *));
296 wprintf((char *) va_arg(arg_list, char *));
297 wprintf("</a></li>\n");
301 wprintf("</a></li>\n");
305 do_template("endbox", NULL);
311 * Convenience functions to display a page containing only a string
313 * titlebarcolor color of the titlebar of the frame
314 * titlebarmsg text to display in the title bar
315 * messagetext body of the box
317 void convenience_page(const char *titlebarcolor, const char *titlebarmsg, const char *messagetext)
319 hprintf("HTTP/1.1 200 OK\n");
320 output_headers(1, 1, 2, 0, 0, 0);
321 wprintf("<div id=\"banner\">\n");
322 wprintf("<table width=100%% border=0 bgcolor=\"#%s\"><tr><td>", titlebarcolor);
323 wprintf("<span class=\"titlebar\">%s</span>\n", titlebarmsg);
324 wprintf("</td></tr></table>\n");
325 wprintf("</div>\n<div id=\"content\">\n");
326 escputs(messagetext);
334 * Display a blank page.
336 void blank_page(void) {
337 output_headers(1, 1, 0, 0, 0, 0);
343 * A template has been requested
345 void url_do_template(void) {
346 const StrBuf *MimeType;
347 const StrBuf *Tmpl = sbstr("template");
349 MimeType = DoTemplate(SKEY(Tmpl), NULL, &NoCtx);
350 http_transmit_thing(ChrPtr(MimeType), 0);
356 * convenience function to indicate success
358 void display_success(char *successmessage)
360 convenience_page("007700", "OK", successmessage);
365 * Authorization required page
366 * This is probably temporary and should be revisited
368 void authorization_required(const char *message)
370 hprintf("HTTP/1.1 401 Authorization Required\r\n");
371 hprintf("WWW-Authenticate: Basic realm=\"%s\"\r\n", ChrPtr(WC->serv_info->serv_humannode));
372 hprintf("Content-Type: text/html\r\n");
374 wprintf(_("Authorization Required"));
375 wprintf("</h1>\r\n");
376 wprintf(_("The resource you requested requires a valid username and password. "
377 "You could not be logged in: %s\n"), message);
383 * Convenience functions to wrap around asynchronous ajax responses
385 void begin_ajax_response(void) {
388 FlushStrBuf(WCC->HBuf);
389 output_headers(0, 0, 0, 0, 0, 0);
391 hprintf("Content-type: text/html; charset=UTF-8\r\n"
393 "Connection: close\r\n"
400 * print ajax response footer
402 void end_ajax_response(void) {
409 * Wraps a Citadel server command in an AJAX transaction.
411 void ajax_servcmd(void)
419 begin_ajax_response();
421 serv_puts(bstr("g_cmd"));
422 StrBuf_ServGetln(Buf);
423 StrBufAppendBuf(WCC->WBuf, Buf, 0);
424 StrBufAppendBufPlain(WCC->WBuf, HKEY("\n"), 0);
426 switch (GetServerStatus(Buf, NULL)) {
428 serv_puts("\n\n000");
429 if ( (StrLength(Buf)==3) &&
430 !strcmp(ChrPtr(Buf), "000")) {
431 StrBufAppendBufPlain(WCC->WBuf, HKEY("\000"), 0);
436 StrBuf_ServGetln(Buf);
437 if ( (StrLength(Buf)==3) &&
438 !strcmp(ChrPtr(Buf), "000")) {
441 StrBufAppendBuf(WCC->WBuf, Buf, 0);
442 StrBufAppendBufPlain(WCC->WBuf, HKEY("\n"), 0);
446 text_to_server(bstr("g_input"));
450 len = atol(&ChrPtr(Buf)[4]);
451 StrBuf_ServGetBLOBBuffered(Buf, len);
454 len = atol(&ChrPtr(Buf)[4]);
456 memset(junk, 0, len);
457 serv_write(junk, len);
464 * This is kind of an ugly hack, but this is the only place it can go.
465 * If the command was GEXP, then the instant messenger window must be
466 * running, so reset the "last_pager_check" watchdog timer so
467 * that page_popup() doesn't try to open it a second time.
469 if (!strncasecmp(bstr("g_cmd"), "GEXP", 4)) {
470 WCC->last_pager_check = time(NULL);
477 * Helper function for the asynchronous check to see if we need
478 * to open the instant messenger window.
480 void seconds_since_last_gexp(void)
484 if ( (time(NULL) - WC->last_pager_check) < 30) {
490 serv_getln(buf, sizeof buf);
502 void ReadPostData(void)
504 const char *content_end = NULL;
507 StrBuf *content = NULL;
509 content = NewStrBuf();
511 StrBufPrintf(content,
513 "Content-length: %ld\n\n",
514 ChrPtr(WCC->Hdr->HR.ContentType),
515 WCC->Hdr->HR.ContentLength);
517 hprintf("Content-type: %s\n"
518 "Content-length: %d\n\n",
519 ContentType, ContentLength);
521 body_start = StrLength(content);
523 /** Read the entire input data at once. */
524 client_read_to(WCC->Hdr, content,
525 WCC->Hdr->HR.ContentLength,
528 if (!strncasecmp(ChrPtr(WCC->Hdr->HR.ContentType), "application/x-www-form-urlencoded", 33)) {
529 StrBufCutLeft(content, body_start);
530 ParseURLParams(content);
531 } else if (!strncasecmp(ChrPtr(WCC->Hdr->HR.ContentType), "multipart", 9)) {
532 content_end = ChrPtr(content) +
533 WCC->Hdr->HR.ContentLength +
535 mime_parser(ChrPtr(content), content_end, *upload_handler, NULL, NULL, NULL, 0);
537 FreeStrBuf(&content);
542 * Entry point for WebCit transaction
544 void session_loop(void)
553 * We stuff these with the values coming from the client cookies,
554 * so we can use them to reconnect a timed out session if we have to.
563 WCC->upload_length = 0;
566 WCC->trailing_javascript = NewStrBuf();
567 WCC->Hdr->nWildfireHeaders = 0;
568 if (WCC->Hdr->HR.Handler != NULL)
569 Flags = WCC->Hdr->HR.Handler->Flags; /* so we can temporarily add our own... */
571 if (WCC->Hdr->HR.ContentLength > 0) {
575 /* If there are variables in the URL, we must grab them now */
576 if (WCC->Hdr->PlainArgs != NULL)
577 ParseURLParams(WCC->Hdr->PlainArgs);
579 /* If the client sent a nonce that is incorrect, kill the request. */
580 if (havebstr("nonce")) {
581 lprintf(9, "Comparing supplied nonce %s to session nonce %ld\n",
582 bstr("nonce"), WCC->nonce);
583 if (ibstr("nonce") != WCC->nonce) {
584 lprintf(9, "Ignoring request with mismatched nonce.\n");
585 hprintf("HTTP/1.1 404 Security check failed\r\n");
586 hprintf("Content-Type: text/plain\r\n\r\n");
587 wprintf("Security check failed.\r\n");
589 goto SKIP_ALL_THIS_CRAP;
594 * If we're not connected to a Citadel server, try to hook up the
597 if (!WCC->connected) {
599 goto SKIP_ALL_THIS_CRAP;
604 * If we're not logged in, but we have authentication data (either from
605 * a cookie or from http-auth), try logging in to Citadel using that.
607 if ((!WCC->logged_in)
608 && (StrLength(WCC->Hdr->c_username) > 0)
609 && (StrLength(WCC->Hdr->c_password) > 0))
612 serv_printf("USER %s", ChrPtr(WCC->Hdr->c_username));
613 StrBuf_ServGetln(Buf);
614 if (GetServerStatus(Buf, NULL) == 3) {
615 serv_printf("PASS %s", ChrPtr(WCC->Hdr->c_password));
616 StrBuf_ServGetln(Buf);
617 if (GetServerStatus(Buf, NULL) == 2) {
618 become_logged_in(WCC->Hdr->c_username,
619 WCC->Hdr->c_password, Buf);
621 /* Should only display when password is wrong */
622 authorization_required(&buf[4]);
624 goto SKIP_ALL_THIS_CRAP;
629 xhttp = (WCC->Hdr->HR.eReqType != eGET) &&
630 (WCC->Hdr->HR.eReqType != ePOST) &&
631 (WCC->Hdr->HR.eReqType != eHEAD);
634 * If a 'gotofirst' parameter has been specified, attempt to goto that room
635 * prior to doing anything else.
637 if (havebstr("gotofirst")) {
639 ret = gotoroom(sbstr("gotofirst")); /* do quietly to avoid session output! */
640 if ((ret/100) != 2) {
641 lprintf(1, "GOTOFIRST: Unable to change to [%s]; Reason: %d\n",
642 bstr("gotofirst"), ret);
647 * If we aren't in any room yet, but we have cookie data telling us where we're
648 * supposed to be, and 'gotofirst' was not specified, then go there.
650 else if ( (StrLength(WCC->wc_roomname) == 0) && ( (StrLength(WCC->Hdr->c_roomname) > 0) )) {
653 lprintf(9, "We are in '%s' but cookie indicates '%s', going there...\n",
654 ChrPtr(WCC->wc_roomname),
655 ChrPtr(WCC->Hdr->c_roomname)
657 ret = gotoroom(WCC->Hdr->c_roomname); /* do quietly to avoid session output! */
658 if ((ret/100) != 2) {
659 lprintf(1, "COOKIEGOTO: Unable to change to [%s]; Reason: %d\n",
660 ChrPtr(WCC->Hdr->c_roomname), ret);
664 if (WCC->Hdr->HR.Handler != NULL) {
665 if (!WCC->logged_in && ((WCC->Hdr->HR.Handler->Flags & ANONYMOUS) == 0)) {
669 if ((WCC->Hdr->HR.Handler->Flags & AJAX) != 0)
670 begin_ajax_response();
671 WCC->Hdr->HR.Handler->F();
672 if ((WCC->Hdr->HR.Handler->Flags & AJAX) != 0)
676 /* When all else fais, display the main menu. */
691 * Replacement for sleep() that uses select() in order to avoid SIGALRM
693 void sleeeeeeeeeep(int seconds)
699 select(0, NULL, NULL, NULL, &tv);
703 int ConditionalImportantMesage(StrBuf *Target, WCTemplputParams *TP)
707 return ((!IsEmptyStr(WCC->ImportantMessage)) ||
708 (StrLength(WCC->ImportantMsg) > 0));
713 void tmplput_importantmessage(StrBuf *Target, WCTemplputParams *TP)
718 if (!IsEmptyStr(WCC->ImportantMessage)) {
719 StrEscAppend(Target, NULL, WCC->ImportantMessage, 0, 0);
720 WCC->ImportantMessage[0] = '\0';
722 else if (StrLength(WCC->ImportantMsg) > 0) {
723 StrEscAppend(Target, WCC->ImportantMsg, NULL, 0, 0);
724 FlushStrBuf(WCC->ImportantMsg);
729 void tmplput_trailing_javascript(StrBuf *Target, WCTemplputParams *TP)
734 StrBufAppendTemplate(Target, TP, WCC->trailing_javascript, 0);
737 void tmplput_csslocal(StrBuf *Target, WCTemplputParams *TP)
739 StrBufAppendBuf(Target,
743 extern char static_local_dir[PATH_MAX];
751 WebcitAddUrlHandler(HKEY("blank"), blank_page, ANONYMOUS|COOKIEUNNEEDED|ISSTATIC);
752 WebcitAddUrlHandler(HKEY("do_template"), url_do_template, ANONYMOUS);
753 WebcitAddUrlHandler(HKEY("sslg"), seconds_since_last_gexp, AJAX|LOGCHATTY);
754 WebcitAddUrlHandler(HKEY("ajax_servcmd"), ajax_servcmd, 0);
755 WebcitAddUrlHandler(HKEY("webcit"), blank_page, URLNAMESPACE);
757 RegisterConditional(HKEY("COND:IMPMSG"), 0, ConditionalImportantMesage, CTX_NONE);
758 RegisterNamespace("CSSLOCAL", 0, 0, tmplput_csslocal, CTX_NONE);
759 RegisterNamespace("IMPORTANTMESSAGE", 0, 0, tmplput_importantmessage, CTX_NONE);
760 RegisterNamespace("TRAILING_JAVASCRIPT", 0, 0, tmplput_trailing_javascript, CTX_NONE);
762 snprintf(dir, SIZ, "%s/static.local/webcit.css", static_local_dir);
763 if (!access(dir, R_OK)) {
764 lprintf(9, "Using local Stylesheet [%s]\n", dir);
765 csslocal = NewStrBufPlain(HKEY("<link href=\"static.local/webcit.css\" rel=\"stylesheet\" type=\"text/css\">"));
768 lprintf(9, "Didn't find site local Stylesheet [%s]\n", dir);
773 ServerStartModule_WEBCIT
776 HandlerHash = NewHash(1, NULL);
781 ServerShutdownModule_WEBCIT
784 FreeStrBuf(&csslocal);
785 DeleteHash(&HandlerHash);
791 SessionNewModule_WEBCIT
794 sess->ImportantMsg = NewStrBuf();
795 sess->WBuf = NewStrBuf();
796 sess->HBuf = NewStrBuf();
800 SessionDetachModule_WEBCIT
803 DeleteHash(&sess->Hdr->urlstrings);// TODO?
804 if (sess->upload_length > 0) {
806 sess->upload_length = 0;
808 FreeStrBuf(&sess->trailing_javascript);
810 if (StrLength(sess->WBuf) > SIZ * 30) /* Bigger than 120K? release. */
812 FreeStrBuf(&sess->WBuf);
813 sess->WBuf = NewStrBuf();
816 FlushStrBuf(sess->WBuf);
817 FlushStrBuf(sess->HBuf);
821 SessionDestroyModule_WEBCIT
824 FreeStrBuf(&sess->WBuf);
825 FreeStrBuf(&sess->HBuf);
826 FreeStrBuf(&sess->ImportantMsg);