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,
164 get_selected_language()
168 hprintf("Set-cookie: webcit=%s; path=/\r\n", unset);
170 hprintf("Set-cookie: webcit=%s; path=/\r\n", cookie);
171 if (server_cookie != NULL) {
172 hprintf("%s\n", server_cookie);
178 do_template("head", NULL);
180 /* check for ImportantMessages (these display in a div overlaying the main screen) */
181 if (!IsEmptyStr(WCC->ImportantMessage)) {
182 wprintf("<div id=\"important_message\">\n"
183 "<span class=\"imsg\">");
184 StrEscAppend(WCC->WBuf, NULL, WCC->ImportantMessage, 0, 0);
185 wprintf("</span><br />\n"
188 StrBufAppendBufPlain(WCC->trailing_javascript,
189 HKEY("setTimeout('hide_imsg_popup()', 5000); \n"),
192 WCC->ImportantMessage[0] = 0;
194 else if (StrLength(WCC->ImportantMsg) > 0) {
195 wprintf("<div id=\"important_message\">\n"
196 "<span class=\"imsg\">");
197 StrEscAppend(WCC->WBuf, WCC->ImportantMsg, NULL, 0, 0);
198 wprintf("</span><br />\n"
201 StrBufAppendBufPlain(WCC->trailing_javascript,
202 HKEY("setTimeout('hide_imsg_popup()', 5000); \n"),
205 FlushStrBuf(WCC->ImportantMsg);
207 if ( (WCC->logged_in) && (!unset_cookies) ) {
208 /*DoTemplate(HKEY("iconbar"), NULL, &NoCtx);*/
212 if (do_room_banner == 1) {
213 wprintf("<div id=\"banner\">\n");
214 embed_room_banner(NULL, navbar_default);
219 if (do_room_banner == 1) {
220 wprintf("<div id=\"content\">\n");
224 void output_custom_content_header(const char *ctype) {
225 hprintf("HTTP/1.1 200 OK\r\n");
226 hprintf("Content-type: %s; charset=utf-8\r\n",ctype);
227 hprintf("Server: %s / %s\r\n", PACKAGE_STRING, ChrPtr(WC->serv_info->serv_software));
228 hprintf("Connection: close\r\n");
233 * Generic function to do an HTTP redirect. Easy and fun.
235 void http_redirect(const char *whichpage) {
236 hprintf("HTTP/1.1 302 Moved Temporarily\n");
237 hprintf("Location: %s\r\n", whichpage);
238 hprintf("URI: %s\r\n", whichpage);
239 hprintf("Content-type: text/html; charset=utf-8\r\n");
240 wprintf("<html><body>");
241 wprintf("Go <a href=\"%s\">here</A>.", whichpage);
242 wprintf("</body></html>\n");
249 * Output a piece of content to the web browser using conformant HTTP and MIME semantics
251 void http_transmit_thing(const char *content_type,
255 lprintf(9, "http_transmit_thing(%s)%s\n",
257 (is_static ? " (static)" : "")
260 output_headers(0, 0, 0, 0, 0, is_static);
262 hprintf("Content-type: %s\r\n"
264 "Connection: close\r\n",
272 * print menu box like used in the floor view or admin interface.
273 * This function takes pair of strings as va_args,
274 * Title Title string of the box
275 * Class CSS Class for the box
276 * nLines How many string pairs should we print? (URL, UrlText)
277 * ... Pairs of URL Strings and their Names
279 void print_menu_box(char* Title, char *Class, int nLines, ...)
284 svput("BOXTITLE", WCS_STRING, Title);
285 do_template("beginboxx", NULL);
287 wprintf("<ul class=\"%s\">", Class);
289 va_start(arg_list, nLines);
290 for (i = 0; i < nLines; ++i)
292 wprintf("<li><a href=\"%s\">", va_arg(arg_list, char *));
293 wprintf((char *) va_arg(arg_list, char *));
294 wprintf("</a></li>\n");
298 wprintf("</a></li>\n");
302 do_template("endbox", NULL);
308 * Convenience functions to display a page containing only a string
310 * titlebarcolor color of the titlebar of the frame
311 * titlebarmsg text to display in the title bar
312 * messagetext body of the box
314 void convenience_page(const char *titlebarcolor, const char *titlebarmsg, const char *messagetext)
316 hprintf("HTTP/1.1 200 OK\n");
317 output_headers(1, 1, 2, 0, 0, 0);
318 wprintf("<div id=\"banner\">\n");
319 wprintf("<table width=100%% border=0 bgcolor=\"#%s\"><tr><td>", titlebarcolor);
320 wprintf("<span class=\"titlebar\">%s</span>\n", titlebarmsg);
321 wprintf("</td></tr></table>\n");
322 wprintf("</div>\n<div id=\"content\">\n");
323 escputs(messagetext);
331 * Display a blank page.
333 void blank_page(void) {
334 output_headers(1, 1, 0, 0, 0, 0);
340 * A template has been requested
342 void url_do_template(void) {
343 const StrBuf *MimeType;
344 const StrBuf *Tmpl = sbstr("template");
346 MimeType = DoTemplate(SKEY(Tmpl), NULL, &NoCtx);
347 http_transmit_thing(ChrPtr(MimeType), 0);
353 * convenience function to indicate success
355 void display_success(char *successmessage)
357 convenience_page("007700", "OK", successmessage);
362 * Authorization required page
363 * This is probably temporary and should be revisited
365 void authorization_required(const char *message)
367 hprintf("HTTP/1.1 401 Authorization Required\r\n");
368 hprintf("WWW-Authenticate: Basic realm=\"%s\"\r\n", ChrPtr(WC->serv_info->serv_humannode));
369 hprintf("Content-Type: text/html\r\n");
371 wprintf(_("Authorization Required"));
372 wprintf("</h1>\r\n");
373 wprintf(_("The resource you requested requires a valid username and password. "
374 "You could not be logged in: %s\n"), message);
380 * Convenience functions to wrap around asynchronous ajax responses
382 void begin_ajax_response(void) {
385 FlushStrBuf(WCC->HBuf);
386 output_headers(0, 0, 0, 0, 0, 0);
388 hprintf("Content-type: text/html; charset=UTF-8\r\n"
390 "Connection: close\r\n"
397 * print ajax response footer
399 void end_ajax_response(void) {
403 /* If it's a "force 404" situation then display the error and bail. */
406 hprintf("HTTP/1.1 404 Not found\r\n");
407 hprintf("Content-Type: text/plain\r\n");
408 wprintf("Not found\r\n");
414 * Wraps a Citadel server command in an AJAX transaction.
416 void ajax_servcmd(void)
424 begin_ajax_response();
426 serv_puts(bstr("g_cmd"));
427 StrBuf_ServGetln(Buf);
428 StrBufAppendBuf(WCC->WBuf, Buf, 0);
429 StrBufAppendBufPlain(WCC->WBuf, HKEY("\n"), 0);
431 switch (GetServerStatus(Buf, NULL)) {
433 serv_puts("\n\n000");
434 if ( (StrLength(Buf)==3) &&
435 !strcmp(ChrPtr(Buf), "000")) {
436 StrBufAppendBufPlain(WCC->WBuf, HKEY("\000"), 0);
441 StrBuf_ServGetln(Buf);
442 if ( (StrLength(Buf)==3) &&
443 !strcmp(ChrPtr(Buf), "000")) {
446 StrBufAppendBuf(WCC->WBuf, Buf, 0);
447 StrBufAppendBufPlain(WCC->WBuf, HKEY("\n"), 0);
451 text_to_server(bstr("g_input"));
455 len = atol(&ChrPtr(Buf)[4]);
456 StrBuf_ServGetBLOBBuffered(Buf, len);
459 len = atol(&ChrPtr(Buf)[4]);
461 memset(junk, 0, len);
462 serv_write(junk, len);
469 * This is kind of an ugly hack, but this is the only place it can go.
470 * If the command was GEXP, then the instant messenger window must be
471 * running, so reset the "last_pager_check" watchdog timer so
472 * that page_popup() doesn't try to open it a second time.
474 if (!strncasecmp(bstr("g_cmd"), "GEXP", 4)) {
475 WCC->last_pager_check = time(NULL);
482 * Helper function for the asynchronous check to see if we need
483 * to open the instant messenger window.
485 void seconds_since_last_gexp(void)
489 if ( (time(NULL) - WC->last_pager_check) < 30) {
495 serv_getln(buf, sizeof buf);
507 void ReadPostData(void)
509 const char *content_end = NULL;
512 StrBuf *content = NULL;
514 content = NewStrBuf();
516 StrBufPrintf(content,
518 "Content-length: %ld\n\n",
519 ChrPtr(WCC->Hdr->ContentType),
520 WCC->Hdr->ContentLength);
522 hprintf("Content-type: %s\n"
523 "Content-length: %d\n\n",
524 ContentType, ContentLength);
526 body_start = StrLength(content);
528 /** Read the entire input data at once. */
529 client_read_to(&WCC->Hdr->http_sock,
531 WCC->Hdr->ReadBuf, &WCC->Hdr->Pos,
532 WCC->Hdr->ContentLength,
535 if (!strncasecmp(ChrPtr(WCC->Hdr->ContentType), "application/x-www-form-urlencoded", 33)) {
536 StrBufCutLeft(content, body_start);
537 ParseURLParams(content);
538 } else if (!strncasecmp(ChrPtr(WCC->Hdr->ContentType), "multipart", 9)) {
539 content_end = ChrPtr(content) +
540 WCC->Hdr->ContentLength +
542 mime_parser(ChrPtr(content), content_end, *upload_handler, NULL, NULL, NULL, 0);
544 FreeStrBuf(&content);
549 * Entry point for WebCit transaction
551 void session_loop(void)
560 * We stuff these with the values coming from the client cookies,
561 * so we can use them to reconnect a timed out session if we have to.
570 WCC->upload_length = 0;
573 WCC->trailing_javascript = NewStrBuf();
574 WCC->Hdr->nWildfireHeaders = 0;
575 if (WCC->Hdr->Handler != NULL)
576 Flags = WCC->Hdr->Handler->Flags; /* so we can temporarily add our own... */
578 if (WCC->Hdr->ContentLength > 0) {
582 /* If there are variables in the URL, we must grab them now */
583 if (WCC->Hdr->PlainArgs != NULL)
584 ParseURLParams(WCC->Hdr->PlainArgs);
586 /* If the client sent a nonce that is incorrect, kill the request. */
587 if (havebstr("nonce")) {
588 lprintf(9, "Comparing supplied nonce %s to session nonce %ld\n",
589 bstr("nonce"), WCC->nonce);
590 if (ibstr("nonce") != WCC->nonce) {
591 lprintf(9, "Ignoring request with mismatched nonce.\n");
592 hprintf("HTTP/1.1 404 Security check failed\r\n");
593 hprintf("Content-Type: text/plain\r\n\r\n");
594 wprintf("Security check failed.\r\n");
596 goto SKIP_ALL_THIS_CRAP;
601 * If we're not connected to a Citadel server, try to hook up the
604 if (!WCC->connected) {
606 goto SKIP_ALL_THIS_CRAP;
611 * If we're not logged in, but we have authentication data (either from
612 * a cookie or from http-auth), try logging in to Citadel using that.
614 if ((!WCC->logged_in)
615 && (StrLength(WCC->Hdr->c_username) > 0)
616 && (StrLength(WCC->Hdr->c_password) > 0))
619 serv_printf("USER %s", ChrPtr(WCC->Hdr->c_username));
620 StrBuf_ServGetln(Buf);
621 if (GetServerStatus(Buf, NULL) == 3) {
622 serv_printf("PASS %s", ChrPtr(WCC->Hdr->c_password));
623 StrBuf_ServGetln(Buf);
624 if (GetServerStatus(Buf, NULL) == 2) {
625 become_logged_in(WCC->Hdr->c_username,
626 WCC->Hdr->c_password, Buf);
628 /* Should only display when password is wrong */
629 authorization_required(&buf[4]);
631 goto SKIP_ALL_THIS_CRAP;
636 xhttp = (WCC->Hdr->eReqType != eGET) &&
637 (WCC->Hdr->eReqType != ePOST) &&
638 (WCC->Hdr->eReqType != eHEAD);
641 * If a 'gotofirst' parameter has been specified, attempt to goto that room
642 * prior to doing anything else.
644 if (havebstr("gotofirst")) {
646 ret = gotoroom(sbstr("gotofirst")); /* do quietly to avoid session output! */
647 if ((ret/100) != 2) {
648 lprintf(1, "GOTOFIRST: Unable to change to [%s]; Reason: %d\n",
649 bstr("gotofirst"), ret);
654 * If we aren't in any room yet, but we have cookie data telling us where we're
655 * supposed to be, and 'gotofirst' was not specified, then go there.
657 else if ( (StrLength(WCC->wc_roomname) == 0) && ( (StrLength(WCC->Hdr->c_roomname) > 0) )) {
658 lprintf(9, "We are in '%s' but cookie indicates '%s', going there...\n",
659 ChrPtr(WCC->wc_roomname),
660 ChrPtr(WCC->Hdr->c_roomname)
663 ret = gotoroom(WCC->Hdr->c_roomname); /* do quietly to avoid session output! */
664 if ((ret/100) != 2) {
665 lprintf(1, "COOKIEGOTO: Unable to change to [%s]; Reason: %d\n",
666 ChrPtr(WCC->Hdr->c_roomname), ret);
670 if (WCC->Hdr->Handler != NULL) {
671 if (!WCC->logged_in && ((WCC->Hdr->Handler->Flags & ANONYMOUS) == 0)) {
675 if ((WCC->Hdr->Handler->Flags & AJAX) != 0)
676 begin_ajax_response();
677 WCC->Hdr->Handler->F();
678 if ((WCC->Hdr->Handler->Flags & AJAX) != 0)
682 /* When all else fais, display the main menu. */
693 WCC->Hdr->http_host = NULL;
698 * Replacement for sleep() that uses select() in order to avoid SIGALRM
700 void sleeeeeeeeeep(int seconds)
706 select(0, NULL, NULL, NULL, &tv);
710 int ConditionalImportantMesage(StrBuf *Target, WCTemplputParams *TP)
714 return ((!IsEmptyStr(WCC->ImportantMessage)) ||
715 (StrLength(WCC->ImportantMsg) > 0));
720 void tmplput_importantmessage(StrBuf *Target, WCTemplputParams *TP)
725 if (!IsEmptyStr(WCC->ImportantMessage)) {
726 StrEscAppend(Target, NULL, WCC->ImportantMessage, 0, 0);
727 WCC->ImportantMessage[0] = '\0';
729 else if (StrLength(WCC->ImportantMsg) > 0) {
730 StrEscAppend(Target, WCC->ImportantMsg, NULL, 0, 0);
731 FlushStrBuf(WCC->ImportantMsg);
736 void tmplput_trailing_javascript(StrBuf *Target, WCTemplputParams *TP)
741 StrBufAppendTemplate(Target, TP, WCC->trailing_javascript, 0);
744 void tmplput_csslocal(StrBuf *Target, WCTemplputParams *TP)
746 StrBufAppendBuf(Target,
750 extern char static_local_dir[PATH_MAX];
758 WebcitAddUrlHandler(HKEY("404"), do_404, ANONYMOUS|COOKIEUNNEEDED);
759 WebcitAddUrlHandler(HKEY("blank"), blank_page, ANONYMOUS|COOKIEUNNEEDED|ISSTATIC);
762 WebcitAddUrlHandler(HKEY("blank"), blank_page, ANONYMOUS);
763 WebcitAddUrlHandler(HKEY("do_template"), url_do_template, ANONYMOUS);
764 WebcitAddUrlHandler(HKEY("sslg"), seconds_since_last_gexp, AJAX|LOGCHATTY);
765 WebcitAddUrlHandler(HKEY("ajax_servcmd"), ajax_servcmd, 0);
767 RegisterConditional(HKEY("COND:IMPMSG"), 0, ConditionalImportantMesage, CTX_NONE);
768 RegisterNamespace("CSSLOCAL", 0, 0, tmplput_csslocal, CTX_NONE);
769 RegisterNamespace("IMPORTANTMESSAGE", 0, 0, tmplput_importantmessage, CTX_NONE);
770 RegisterNamespace("TRAILING_JAVASCRIPT", 0, 0, tmplput_trailing_javascript, CTX_NONE);
772 snprintf(dir, SIZ, "%s/static.local/webcit.css", static_local_dir);
773 if (!access(dir, R_OK)) {
774 lprintf(9, "Using local Stylesheet [%s]\n", dir);
775 csslocal = NewStrBufPlain(HKEY("<link href=\"static.local/webcit.css\" rel=\"stylesheet\" type=\"text/css\">"));
778 lprintf(9, "Didn't find site local Stylesheet [%s]\n", dir);
783 ServerStartModule_WEBCIT
786 HandlerHash = NewHash(1, NULL);
791 ServerShutdownModule_WEBCIT
794 FreeStrBuf(&csslocal);
795 DeleteHash(&HandlerHash);
801 SessionNewModule_WEBCIT
804 sess->ImportantMsg = NewStrBuf();
805 sess->WBuf = NewStrBuf();
806 sess->HBuf = NewStrBuf();
810 SessionDetachModule_WEBCIT
813 DeleteHash(&sess->Hdr->urlstrings);// TODO?
814 if (sess->upload_length > 0) {
816 sess->upload_length = 0;
818 FreeStrBuf(&sess->trailing_javascript);
820 if (StrLength(sess->WBuf) > SIZ * 30) /* Bigger than 120K? release. */
822 FreeStrBuf(&sess->WBuf);
823 sess->WBuf = NewStrBuf();
826 FlushStrBuf(sess->WBuf);
827 FlushStrBuf(sess->HBuf);
831 SessionDestroyModule_WEBCIT
834 FreeStrBuf(&sess->WBuf);
835 FreeStrBuf(&sess->HBuf);
836 FreeStrBuf(&sess->ImportantMsg);