2 * Copyright (c) 1987-2012 by the citadel.org team
4 * This program is open source software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 3.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
14 * Uncomment this to log all communications with the Citadel server
19 #include "webserver.h"
21 long MaxRead = -1; /* should we do READ scattered or all at once? */
24 * register the timeout
26 RETSIGTYPE timeout(int signum)
28 syslog(LOG_WARNING, "Connection timed out; unable to reach citserver\n");
29 /* no exit here, since we need to server the connection unreachable thing. exit(3); */
34 * Client side - connect to a unix domain socket
36 int uds_connectsock(char *sockpath)
38 struct sockaddr_un addr;
41 memset(&addr, 0, sizeof(addr));
42 addr.sun_family = AF_UNIX;
43 strncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
45 s = socket(AF_UNIX, SOCK_STREAM, 0);
47 syslog(LOG_WARNING, "Can't create socket [%s]: %s\n", sockpath, strerror(errno));
51 if (connect(s, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
52 syslog(LOG_WARNING, "Can't connect [%s]: %s\n", sockpath, strerror(errno));
61 * TCP client - connect to a host/port
63 int tcp_connectsock(char *host, char *service)
65 struct in6_addr serveraddr;
66 struct addrinfo hints;
67 struct addrinfo *res = NULL;
68 struct addrinfo *ai = NULL;
72 if ((host == NULL) || IsEmptyStr(host))
74 if ((service == NULL) || IsEmptyStr(service))
77 syslog(LOG_DEBUG, "tcp_connectsock(%s,%s)\n", host, service);
79 memset(&hints, 0x00, sizeof(hints));
80 hints.ai_flags = AI_NUMERICSERV;
81 hints.ai_family = AF_UNSPEC;
82 hints.ai_socktype = SOCK_STREAM;
85 * Handle numeric IPv4 and IPv6 addresses
87 rc = inet_pton(AF_INET, host, &serveraddr);
88 if (rc == 1) { /* dotted quad */
89 hints.ai_family = AF_INET;
90 hints.ai_flags |= AI_NUMERICHOST;
92 rc = inet_pton(AF_INET6, host, &serveraddr);
93 if (rc == 1) { /* IPv6 address */
94 hints.ai_family = AF_INET6;
95 hints.ai_flags |= AI_NUMERICHOST;
99 /* Begin the connection process */
101 rc = getaddrinfo(host, service, &hints, &res);
103 syslog(LOG_DEBUG, "%s: %s\n", host, gai_strerror(rc));
109 * Try all available addresses until we connect to one or until we run out.
111 for (ai = res; ai != NULL; ai = ai->ai_next) {
113 if (ai->ai_family == AF_INET) syslog(LOG_DEBUG, "Trying IPv4\n");
114 else if (ai->ai_family == AF_INET6) syslog(LOG_DEBUG, "Trying IPv6\n");
115 else syslog(LOG_WARNING, "This is going to fail.\n");
117 s = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol);
119 syslog(LOG_WARNING, "socket() failed: %s\n", strerror(errno));
123 rc = connect(s, ai->ai_addr, ai->ai_addrlen);
128 fdflags = fcntl(rc, F_GETFL);
131 "unable to get socket %d flags! %s \n",
137 fdflags = fdflags | O_NONBLOCK;
138 if (fcntl(rc, F_SETFL, fdflags) < 0) {
140 "unable to set socket %d nonblocking flags! %s \n",
150 syslog(LOG_WARNING, "connect() failed: %s\n", strerror(errno));
160 * input string from pipe
162 int serv_getln(char *strbuf, int bufsize)
168 StrBuf_ServGetln(WCC->MigrateReadLineBuf);
169 len = StrLength(WCC->MigrateReadLineBuf);
172 memcpy(strbuf, ChrPtr(WCC->MigrateReadLineBuf), len);
173 FlushStrBuf(WCC->MigrateReadLineBuf);
176 syslog(LOG_DEBUG, "%3d<<<%s\n", WCC->serv_sock, strbuf);
182 int StrBuf_ServGetln(StrBuf *buf)
185 const char *ErrStr = NULL;
192 rc = StrBufTCP_read_buffered_line_fast(buf,
200 syslog(LOG_INFO, "StrBuf_ServGetln(): Server connection broken: %s\n",
202 wc_backtrace(LOG_INFO);
203 if (WCC->serv_sock > 0) close(WCC->serv_sock);
204 WCC->serv_sock = (-1);
212 if (WCC->ReadPos != NULL)
213 pos = WCC->ReadPos - ChrPtr(WCC->ReadBuf);
214 syslog(LOG_DEBUG, "%3d<<<[%ld]%s\n", WC->serv_sock, pos, ChrPtr(buf));
220 int StrBuf_ServGetBLOBBuffered(StrBuf *buf, long BlobSize)
226 rc = StrBufReadBLOBBuffered(buf,
236 syslog(LOG_INFO, "StrBuf_ServGetBLOBBuffered(): Server connection broken: %s\n",
238 wc_backtrace(LOG_INFO);
239 if (WCC->serv_sock > 0) close(WCC->serv_sock);
240 WCC->serv_sock = (-1);
246 syslog(LOG_DEBUG, "%3d<<<BLOB: %d bytes\n", WC->serv_sock, StrLength(buf));
252 int StrBuf_ServGetBLOB(StrBuf *buf, long BlobSize)
259 rc = StrBufReadBLOB(buf, &WCC->serv_sock, 1, BlobSize, &ErrStr);
262 syslog(LOG_INFO, "StrBuf_ServGetBLOB(): Server connection broken: %s\n",
264 wc_backtrace(LOG_INFO);
265 if (WCC->serv_sock > 0) close(WCC->serv_sock);
266 WCC->serv_sock = (-1);
272 syslog(LOG_DEBUG, "%3d<<<BLOB: %d bytes\n", WC->serv_sock, StrLength(buf));
279 void FlushReadBuf (void)
286 len = StrLength(WCC->ReadBuf);
288 (WCC->ReadPos != NULL) &&
289 (WCC->ReadPos != StrBufNOTNULL))
292 pch = ChrPtr(WCC->ReadBuf);
294 if (WCC->ReadPos != pche)
297 "ERROR: somebody didn't eat his soup! Remaing Chars: %ld [%s]\n",
298 (long)(pche - WCC->ReadPos),
302 "--------------------------------------------------------------------------------\n"
304 "--------------------------------------------------------------------------------\n",
306 AppendImportantMessage(HKEY("Suppenkasper alert! watch your webcit logfile and get connected to your favourite opensource Crew."));
310 FlushStrBuf(WCC->ReadBuf);
318 * send binary to server
319 * buf the buffer to write to citadel server
320 * nbytes how many bytes to send to citadel server
322 int serv_write(const char *buf, int nbytes)
325 int bytes_written = 0;
329 while (bytes_written < nbytes) {
330 retval = write(WCC->serv_sock, &buf[bytes_written],
331 nbytes - bytes_written);
333 const char *ErrStr = strerror(errno);
334 syslog(LOG_INFO, "serv_write(): Server connection broken: %s\n",
336 if (WCC->serv_sock > 0) close(WCC->serv_sock);
337 WCC->serv_sock = (-1);
342 bytes_written = bytes_written + retval;
349 * send line to server
350 * string the line to send to the citadel server
352 int serv_puts(const char *string)
355 syslog(LOG_DEBUG, "%3d>>>%s\n", WC->serv_sock, string);
359 if (!serv_write(string, strlen(string)))
361 return serv_write("\n", 1);
365 * send line to server
366 * string the line to send to the citadel server
368 int serv_putbuf(const StrBuf *string)
371 syslog(LOG_DEBUG, "%3d>>>%s\n", WC->serv_sock, ChrPtr(string));
375 if (!serv_write(ChrPtr(string), StrLength(string)))
377 return serv_write("\n", 1);
382 * convenience function to send stuff to the server
383 * format the formatstring
384 * ... the entities to insert into format
386 int serv_printf(const char *format,...)
395 va_start(arg_ptr, format);
396 vsnprintf(buf, sizeof buf, format, arg_ptr);
402 rc = serv_write(buf, len);
404 syslog(LOG_DEBUG, ">>>%s", buf);
411 * Read binary data from server into memory using a series of server READ commands.
412 * returns the read content as StrBuf
414 int serv_read_binary(StrBuf *Ret, size_t total_len, StrBuf *Buf)
417 size_t bytes_read = 0;
418 size_t this_block = 0;
426 while ((bytes_read < total_len) && (ServerRc == 6)) {
428 if (WCC->serv_sock==-1) {
433 serv_printf("READ "SIZE_T_FMT"|"SIZE_T_FMT, bytes_read, total_len-bytes_read);
434 if ( (rc = StrBuf_ServGetln(Buf) > 0) &&
435 (ServerRc = GetServerStatus(Buf, NULL), ServerRc == 6) )
439 StrBufCutLeft(Buf, 4);
440 this_block = StrTol(Buf);
441 rc = StrBuf_ServGetBLOBBuffered(Ret, this_block);
443 syslog(LOG_INFO, "Server connection broken during download\n");
444 wc_backtrace(LOG_INFO);
445 if (WCC->serv_sock > 0) close(WCC->serv_sock);
446 WCC->serv_sock = (-1);
455 return StrLength(Ret);
459 int ClientGetLine(ParsedHttpHdrs *Hdr, StrBuf *Target)
463 const char *pch, *pchs;
464 int rlen, len, retval = 0;
468 if (StrLength(Hdr->ReadBuf) > 0)
470 pchs = ChrPtr(Hdr->ReadBuf);
471 pch = strchr(pchs, '\n');
475 if (len > 0 && (*(pch - 1) == '\r') )
477 StrBufSub(Target, Hdr->ReadBuf, 0, len - rlen);
478 StrBufCutLeft(Hdr->ReadBuf, len + 1);
483 while (retval == 0) {
485 pchs = ChrPtr(Hdr->ReadBuf);
487 pch = strchr(pchs, '\n');
489 retval = client_read_sslbuffer(Hdr->ReadBuf, SLEEPING);
490 pchs = ChrPtr(Hdr->ReadBuf);
491 pch = strchr(pchs, '\n');
502 if ((retval > 0) && (pch != NULL)) {
505 if (len > 0 && (*(pch - 1) == '\r') )
507 StrBufSub(Target, Hdr->ReadBuf, 0, len - rlen);
508 StrBufCutLeft(Hdr->ReadBuf, len + 1);
517 return StrBufTCP_read_buffered_line_fast(Target,
528 * This is a generic function to set up a master socket for listening on
529 * a TCP port. The server shuts down if the bind fails. (IPv4/IPv6 version)
531 * ip_addr IP address to bind
532 * port_number port number to bind
533 * queue_len number of incoming connections to allow in the queue
535 int webcit_tcp_server(const char *ip_addr, int port_number, int queue_len)
537 const char *ipv4broadcast = "0.0.0.0";
540 struct sockaddr_in6 sin6;
541 struct sockaddr_in sin4;
546 memset(&sin6, 0, sizeof(sin6));
547 memset(&sin4, 0, sizeof(sin4));
548 sin6.sin6_family = AF_INET6;
549 sin4.sin_family = AF_INET;
551 if ( (ip_addr == NULL) /* any IPv6 */
552 || (IsEmptyStr(ip_addr))
553 || (!strcmp(ip_addr, "*"))
557 sin6.sin6_addr = in6addr_any;
559 else if (!strcmp(ip_addr, "0.0.0.0")) /* any IPv4 */
562 sin4.sin_addr.s_addr = INADDR_ANY;
564 else if ((strchr(ip_addr, '.')) && (!strchr(ip_addr, ':'))) /* specific IPv4 */
567 if (inet_pton(AF_INET, ip_addr, &sin4.sin_addr) <= 0) {
568 syslog(LOG_WARNING, "Error binding to [%s] : %s\n", ip_addr, strerror(errno));
569 return (-WC_EXIT_BIND);
572 else /* specific IPv6 */
575 if (inet_pton(AF_INET6, ip_addr, &sin6.sin6_addr) <= 0) {
576 syslog(LOG_WARNING, "Error binding to [%s] : %s\n", ip_addr, strerror(errno));
577 return (-WC_EXIT_BIND);
581 if (port_number == 0) {
582 syslog(LOG_WARNING, "Cannot start: no port number specified.\n");
583 return (-WC_EXIT_BIND);
585 sin6.sin6_port = htons((u_short) port_number);
586 sin4.sin_port = htons((u_short) port_number);
588 p = getprotobyname("tcp");
590 s = socket( ((ip_version == 6) ? PF_INET6 : PF_INET), SOCK_STREAM, (p->p_proto));
592 if (IsDefault && (errno == EAFNOSUPPORT))
595 ip_addr = ipv4broadcast;
598 syslog(LOG_WARNING, "Can't create a listening socket: %s\n", strerror(errno));
599 return (-WC_EXIT_BIND);
601 /* Set some socket options that make sense. */
603 setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
605 if (ip_version == 6) {
606 b = bind(s, (struct sockaddr *) &sin6, sizeof(sin6));
609 b = bind(s, (struct sockaddr *) &sin4, sizeof(sin4));
613 syslog(LOG_EMERG, "Can't bind: %s\n", strerror(errno));
615 return (-WC_EXIT_BIND);
618 if (listen(s, queue_len) < 0) {
619 syslog(LOG_EMERG, "Can't listen: %s\n", strerror(errno));
621 return (-WC_EXIT_BIND);
628 * Create a Unix domain socket and listen on it
629 * sockpath - file name of the unix domain socket
630 * queue_len - Number of incoming connections to allow in the queue
632 int webcit_uds_server(char *sockpath, int queue_len)
634 struct sockaddr_un addr;
637 int actual_queue_len;
639 actual_queue_len = queue_len;
640 if (actual_queue_len < 5) actual_queue_len = 5;
642 i = unlink(sockpath);
643 if ((i != 0) && (errno != ENOENT)) {
644 syslog(LOG_WARNING, "webcit: can't unlink %s: %s\n",
645 sockpath, strerror(errno));
646 return (-WC_EXIT_BIND);
649 memset(&addr, 0, sizeof(addr));
650 addr.sun_family = AF_UNIX;
651 safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
653 s = socket(AF_UNIX, SOCK_STREAM, 0);
655 syslog(LOG_WARNING, "webcit: Can't create a unix domain socket: %s\n", strerror(errno));
656 return (-WC_EXIT_BIND);
659 if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
660 syslog(LOG_WARNING, "webcit: Can't bind: %s\n", strerror(errno));
662 return (-WC_EXIT_BIND);
665 if (listen(s, actual_queue_len) < 0) {
666 syslog(LOG_WARNING, "webcit: Can't listen: %s\n", strerror(errno));
668 return (-WC_EXIT_BIND);
671 chmod(sockpath, 0777);
679 * Read data from the client socket.
681 * sock socket fd to read from
682 * buf buffer to read into
683 * bytes number of bytes to read
684 * timeout Number of seconds to wait before timing out
686 * Possible return values:
687 * 1 Requested number of bytes has been read.
688 * 0 Request timed out.
689 * -1 Connection is broken, or other error.
691 int client_read_to(ParsedHttpHdrs *Hdr, StrBuf *Target, int bytes, int timeout)
701 baselen = StrLength(Target);
703 if (Hdr->Pos == NULL)
704 Hdr->Pos = ChrPtr(Hdr->ReadBuf);
706 if (StrLength(Hdr->ReadBuf) > 0)
708 bufremain = StrLength(Hdr->ReadBuf) - (Hdr->Pos - ChrPtr(Hdr->ReadBuf));
710 if (bytes < bufremain)
712 StrBufAppendBufPlain(Target, Hdr->Pos, bufremain, 0);
713 StrBufCutLeft(Hdr->ReadBuf, bufremain);
716 if (bytes > bufremain)
718 while ((StrLength(Hdr->ReadBuf) + StrLength(Target) < bytes + baselen) &&
720 retval = client_read_sslbuffer(Hdr->ReadBuf, timeout);
722 StrBufAppendBuf(Target, Hdr->ReadBuf, 0); /* todo: Buf > bytes? */
726 syslog(LOG_INFO, "client_read_ssl() failed\n");
735 retval = StrBufReadBLOBBuffered(Target,
744 syslog(LOG_INFO, "client_read() failed: %s\n",
746 wc_backtrace(LOG_DEBUG);
755 * Begin buffering HTTP output so we can transmit it all in one write operation later.
757 void begin_burst(void)
759 if (WC->WBuf == NULL) {
760 WC->WBuf = NewStrBufPlain(NULL, 32768);
766 * Finish buffering HTTP output. [Compress using zlib and] output with a Content-Length: header.
771 const char *ptr, *eptr;
777 if (!DisableGzip && (WCC->Hdr->HR.gzip_ok))
779 if (CompressBuffer(WCC->WBuf) > 0)
780 hprintf("Content-encoding: gzip\r\n");
782 syslog(LOG_ALERT, "Compression failed: %d [%s] sending uncompressed\n", errno, strerror(errno));
783 wc_backtrace(LOG_INFO);
787 if (WCC->WFBuf != NULL) {
788 WildFireSerializePayload(WCC->WFBuf, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
789 FreeStrBuf(&WCC->WFBuf);
792 if (WCC->Hdr->HR.prohibit_caching)
793 hprintf("Pragma: no-cache\r\nCache-Control: no-store\r\nExpires:-1\r\n");
794 hprintf("Content-length: %d\r\n\r\n", StrLength(WCC->WBuf));
796 ptr = ChrPtr(WCC->HBuf);
797 count = StrLength(WCC->HBuf);
802 client_write_ssl(WCC->HBuf);
803 client_write_ssl(WCC->WBuf);
808 if (WCC->Hdr->http_sock == -1)
810 fdflags = fcntl(WC->Hdr->http_sock, F_GETFL);
812 while ((ptr < eptr) && (WCC->Hdr->http_sock != -1)){
813 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
815 FD_SET(WCC->Hdr->http_sock, &wset);
816 if (select(WCC->Hdr->http_sock + 1, NULL, &wset, NULL, NULL) == -1) {
817 syslog(LOG_DEBUG, "client_write: Socket select failed (%s)\n", strerror(errno));
822 if ((WCC->Hdr->http_sock == -1) ||
823 (res = write(WCC->Hdr->http_sock,
826 syslog(LOG_DEBUG, "client_write: Socket write failed (%s)\n", strerror(errno));
827 wc_backtrace(LOG_INFO);
834 ptr = ChrPtr(WCC->WBuf);
835 count = StrLength(WCC->WBuf);
838 while ((ptr < eptr) && (WCC->Hdr->http_sock != -1)) {
839 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
841 FD_SET(WCC->Hdr->http_sock, &wset);
842 if (select(WCC->Hdr->http_sock + 1, NULL, &wset, NULL, NULL) == -1) {
843 syslog(LOG_INFO, "client_write: Socket select failed (%s)\n", strerror(errno));
848 if ((WCC->Hdr->http_sock == -1) ||
849 (res = write(WCC->Hdr->http_sock,
852 syslog(LOG_INFO, "client_write: Socket write failed (%s)\n", strerror(errno));
853 wc_backtrace(LOG_INFO);
860 return StrLength(WCC->WBuf);
865 * lingering_close() a`la Apache. see
866 * http://www.apache.org/docs/misc/fin_wait_2.html for rationale
868 int lingering_close(int fd)
873 struct timeval tv, start;
875 gettimeofday(&start, NULL);
881 gettimeofday(&tv, NULL);
882 tv.tv_sec = SLEEPING - (tv.tv_sec - start.tv_sec);
883 tv.tv_usec = start.tv_usec - tv.tv_usec;
884 if (tv.tv_usec < 0) {
886 tv.tv_usec += 1000000;
890 i = select(fd + 1, &set, NULL, NULL, &tv);
891 } while (i == -1 && errno == EINTR);
896 i = read(fd, buf, sizeof buf);
897 } while (i != 0 && (i != -1 || errno == EINTR));
903 HttpNewModule_TCPSOCKETS
904 (ParsedHttpHdrs *httpreq)
907 httpreq->ReadBuf = NewStrBufPlain(NULL, SIZ * 4);
911 HttpDetachModule_TCPSOCKETS
912 (ParsedHttpHdrs *httpreq)
915 FlushStrBuf(httpreq->ReadBuf);
916 ReAdjustEmptyBuf(httpreq->ReadBuf, 4 * SIZ, SIZ);
920 HttpDestroyModule_TCPSOCKETS
921 (ParsedHttpHdrs *httpreq)
924 FreeStrBuf(&httpreq->ReadBuf);
929 SessionNewModule_TCPSOCKETS
932 sess->CLineBuf = NewStrBuf();
933 sess->MigrateReadLineBuf = NewStrBuf();
937 SessionDestroyModule_TCPSOCKETS
940 FreeStrBuf(&sess->CLineBuf);
941 FreeStrBuf(&sess->ReadBuf);
943 sess->ReadPos = NULL;
944 FreeStrBuf(&sess->MigrateReadLineBuf);
945 if (sess->serv_sock > 0) {
946 syslog(LOG_DEBUG, "Closing socket %d", sess->serv_sock);
947 close(sess->serv_sock);
949 sess->serv_sock = -1;