new url for lingering_close() description
[citadel.git] / webcit / tcp_sockets.c
1 /*
2  * Copyright (c) 1987-2012 by the citadel.org team
3  *
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.
6  * 
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.
11  */
12
13 /*
14  * Uncomment this to log all communications with the Citadel server
15 #define SERV_TRACE 1
16  */
17
18 #include "webcit.h"
19 #include "webserver.h"
20
21 long MaxRead = -1; /* should we do READ scattered or all at once? */
22
23 /*
24  * register the timeout
25  */
26 RETSIGTYPE timeout(int signum)
27 {
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); */
30 }
31
32
33 /*
34  * Client side - connect to a unix domain socket
35  */
36 int uds_connectsock(char *sockpath)
37 {
38         struct sockaddr_un addr;
39         int s;
40
41         memset(&addr, 0, sizeof(addr));
42         addr.sun_family = AF_UNIX;
43         strncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
44
45         s = socket(AF_UNIX, SOCK_STREAM, 0);
46         if (s < 0) {
47                 syslog(LOG_WARNING, "Can't create socket [%s]: %s\n", sockpath, strerror(errno));
48                 return(-1);
49         }
50
51         if (connect(s, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
52                 syslog(LOG_WARNING, "Can't connect [%s]: %s\n", sockpath, strerror(errno));
53                 close(s);
54                 return(-1);
55         }
56         return s;
57 }
58
59
60 /*
61  * TCP client - connect to a host/port 
62  */
63 int tcp_connectsock(char *host, char *service)
64 {
65         struct in6_addr serveraddr;
66         struct addrinfo hints;
67         struct addrinfo *res = NULL;
68         struct addrinfo *ai = NULL;
69         int rc = (-1);
70         int s = (-1);
71
72         if ((host == NULL) || IsEmptyStr(host))
73                 return (-1);
74         if ((service == NULL) || IsEmptyStr(service))
75                 return (-1);
76
77         syslog(LOG_DEBUG, "tcp_connectsock(%s,%s)\n", host, service);
78
79         memset(&hints, 0x00, sizeof(hints));
80         hints.ai_flags = AI_NUMERICSERV;
81         hints.ai_family = AF_UNSPEC;
82         hints.ai_socktype = SOCK_STREAM;
83
84         /*
85          * Handle numeric IPv4 and IPv6 addresses
86          */
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;
91         } else {
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;
96                 }
97         }
98
99         /* Begin the connection process */
100
101         rc = getaddrinfo(host, service, &hints, &res);
102         if (rc != 0) {
103                 syslog(LOG_DEBUG, "%s: %s\n", host, gai_strerror(rc));
104                 freeaddrinfo(res);
105                 return(-1);
106         }
107
108         /*
109          * Try all available addresses until we connect to one or until we run out.
110          */
111         for (ai = res; ai != NULL; ai = ai->ai_next) {
112
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");
116
117                 s = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol);
118                 if (s < 0) {
119                         syslog(LOG_WARNING, "socket() failed: %s\n", strerror(errno));
120                         freeaddrinfo(res);
121                         return(-1);
122                 }
123                 rc = connect(s, ai->ai_addr, ai->ai_addrlen);
124                 if (rc >= 0) {
125                         int fdflags;
126                         freeaddrinfo(res);
127
128                         fdflags = fcntl(rc, F_GETFL);
129                         if (fdflags < 0) {
130                                 syslog(LOG_ERR,
131                                        "unable to get socket %d flags! %s \n",
132                                        rc,
133                                        strerror(errno));
134                                 close(rc);
135                                 return -1;
136                         }
137                         fdflags = fdflags | O_NONBLOCK;
138                         if (fcntl(rc, F_SETFL, fdflags) < 0) {
139                                 syslog(LOG_ERR,
140                                        "unable to set socket %d nonblocking flags! %s \n",
141                                        rc,
142                                        strerror(errno));
143                                 close(s);
144                                 return -1;
145                         }
146
147                         return(s);
148                 }
149                 else {
150                         syslog(LOG_WARNING, "connect() failed: %s\n", strerror(errno));
151                         close(s);
152                 }
153         }
154         freeaddrinfo(res);
155         return(-1);
156 }
157
158
159 /*
160  *  input string from pipe
161  */
162 int serv_getln(char *strbuf, int bufsize)
163 {
164         wcsession *WCC = WC;
165         int len;
166
167         *strbuf = '\0';
168         StrBuf_ServGetln(WCC->MigrateReadLineBuf);
169         len = StrLength(WCC->MigrateReadLineBuf);
170         if (len > bufsize)
171                 len = bufsize - 1;
172         memcpy(strbuf, ChrPtr(WCC->MigrateReadLineBuf), len);
173         FlushStrBuf(WCC->MigrateReadLineBuf);
174         strbuf[len] = '\0';
175 #ifdef SERV_TRACE
176         syslog(LOG_DEBUG, "%3d<<<%s\n", WCC->serv_sock, strbuf);
177 #endif
178         return len;
179 }
180
181
182 int StrBuf_ServGetln(StrBuf *buf)
183 {
184         wcsession *WCC = WC;
185         const char *ErrStr = NULL;
186         int rc;
187         
188         if (!WCC->connected)
189                 return -1;
190
191         FlushStrBuf(buf);
192         rc = StrBufTCP_read_buffered_line_fast(buf, 
193                                                WCC->ReadBuf, 
194                                                &WCC->ReadPos, 
195                                                &WCC->serv_sock, 
196                                                5, 1, 
197                                                &ErrStr);
198         if (rc < 0)
199         {
200                 syslog(LOG_INFO, "StrBuf_ServGetln(): Server connection broken: %s\n",
201                         (ErrStr)?ErrStr:"");
202                 wc_backtrace(LOG_INFO);
203                 if (WCC->serv_sock > 0) close(WCC->serv_sock);
204                 WCC->serv_sock = (-1);
205                 WCC->connected = 0;
206                 WCC->logged_in = 0;
207         }
208 #ifdef SERV_TRACE
209         else 
210         {
211                 long pos = 0;
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));
215         }
216 #endif
217         return rc;
218 }
219
220 int StrBuf_ServGetBLOBBuffered(StrBuf *buf, long BlobSize)
221 {
222         wcsession *WCC = WC;
223         const char *ErrStr;
224         int rc;
225         
226         rc = StrBufReadBLOBBuffered(buf, 
227                                     WCC->ReadBuf, 
228                                     &WCC->ReadPos,
229                                     &WCC->serv_sock, 
230                                     1, 
231                                     BlobSize, 
232                                     NNN_TERM,
233                                     &ErrStr);
234         if (rc < 0)
235         {
236                 syslog(LOG_INFO, "StrBuf_ServGetBLOBBuffered(): Server connection broken: %s\n",
237                         (ErrStr)?ErrStr:"");
238                 wc_backtrace(LOG_INFO);
239                 if (WCC->serv_sock > 0) close(WCC->serv_sock);
240                 WCC->serv_sock = (-1);
241                 WCC->connected = 0;
242                 WCC->logged_in = 0;
243         }
244 #ifdef SERV_TRACE
245         else
246                 syslog(LOG_DEBUG, "%3d<<<BLOB: %d bytes\n", WC->serv_sock, StrLength(buf));
247 #endif
248
249         return rc;
250 }
251
252 int StrBuf_ServGetBLOB(StrBuf *buf, long BlobSize)
253 {
254         wcsession *WCC = WC;
255         const char *ErrStr;
256         int rc;
257         
258         WCC->ReadPos = NULL;
259         rc = StrBufReadBLOB(buf, &WCC->serv_sock, 1, BlobSize, &ErrStr);
260         if (rc < 0)
261         {
262                 syslog(LOG_INFO, "StrBuf_ServGetBLOB(): Server connection broken: %s\n",
263                         (ErrStr)?ErrStr:"");
264                 wc_backtrace(LOG_INFO);
265                 if (WCC->serv_sock > 0) close(WCC->serv_sock);
266                 WCC->serv_sock = (-1);
267                 WCC->connected = 0;
268                 WCC->logged_in = 0;
269         }
270 #ifdef SERV_TRACE
271         else
272                 syslog(LOG_DEBUG, "%3d<<<BLOB: %d bytes\n", WC->serv_sock, StrLength(buf));
273 #endif
274
275         return rc;
276 }
277
278
279 void FlushReadBuf (void)
280 {
281         long len;
282         const char *pch;
283         const char *pche;
284         wcsession *WCC = WC;
285
286         len = StrLength(WCC->ReadBuf);
287         if ((len > 0) &&
288             (WCC->ReadPos != NULL) && 
289             (WCC->ReadPos != StrBufNOTNULL))
290                 
291         {
292                 pch = ChrPtr(WCC->ReadBuf);
293                 pche = pch + len;
294                 if (WCC->ReadPos != pche)
295                 {
296                         syslog(LOG_EMERG,
297                                 "ERROR: somebody didn't eat his soup! Remaing Chars: %ld [%s]\n", 
298                                 (long)(pche - WCC->ReadPos),
299                                 pche
300                         );
301                         syslog(LOG_EMERG, 
302                                 "--------------------------------------------------------------------------------\n"
303                                 "Whole buf: [%s]\n"
304                                 "--------------------------------------------------------------------------------\n", 
305                                 pch);
306                         AppendImportantMessage(HKEY("Suppenkasper alert! watch your webcit logfile and get connected to your favourite opensource Crew."));
307                 }
308         }
309
310         FlushStrBuf(WCC->ReadBuf);
311         WCC->ReadPos = NULL;
312
313
314 }
315
316
317 /*
318  *  send binary to server
319  *  buf the buffer to write to citadel server
320  *  nbytes how many bytes to send to citadel server
321  */
322 int serv_write(const char *buf, int nbytes)
323 {
324         wcsession *WCC = WC;
325         int bytes_written = 0;
326         int retval;
327
328         FlushReadBuf();
329         while (bytes_written < nbytes) {
330                 retval = write(WCC->serv_sock, &buf[bytes_written],
331                                nbytes - bytes_written);
332                 if (retval < 1) {
333                         const char *ErrStr = strerror(errno);
334                         syslog(LOG_INFO, "serv_write(): Server connection broken: %s\n",
335                                 (ErrStr)?ErrStr:"");
336                         if (WCC->serv_sock > 0) close(WCC->serv_sock);
337                         WCC->serv_sock = (-1);
338                         WCC->connected = 0;
339                         WCC->logged_in = 0;
340                         return 0;
341                 }
342                 bytes_written = bytes_written + retval;
343         }
344         return 1;
345 }
346
347
348 /*
349  *  send line to server
350  *  string the line to send to the citadel server
351  */
352 int serv_puts(const char *string)
353 {
354 #ifdef SERV_TRACE
355         syslog(LOG_DEBUG, "%3d>>>%s\n", WC->serv_sock, string);
356 #endif
357         FlushReadBuf();
358
359         if (!serv_write(string, strlen(string)))
360                 return 0;
361         return serv_write("\n", 1);
362 }
363
364 /*
365  *  send line to server
366  *  string the line to send to the citadel server
367  */
368 int serv_putbuf(const StrBuf *string)
369 {
370 #ifdef SERV_TRACE
371         syslog(LOG_DEBUG, "%3d>>>%s\n", WC->serv_sock, ChrPtr(string));
372 #endif
373         FlushReadBuf();
374
375         if (!serv_write(ChrPtr(string), StrLength(string)))
376                 return 0;
377         return serv_write("\n", 1);
378 }
379
380
381 /*
382  *  convenience function to send stuff to the server
383  *  format the formatstring
384  *  ... the entities to insert into format 
385  */
386 int serv_printf(const char *format,...)
387 {
388         va_list arg_ptr;
389         char buf[SIZ];
390         size_t len;
391         int rc;
392
393         FlushReadBuf();
394
395         va_start(arg_ptr, format);
396         vsnprintf(buf, sizeof buf, format, arg_ptr);
397         va_end(arg_ptr);
398
399         len = strlen(buf);
400         buf[len++] = '\n';
401         buf[len] = '\0';
402         rc = serv_write(buf, len);
403 #ifdef SERV_TRACE
404         syslog(LOG_DEBUG, ">>>%s", buf);
405 #endif
406         return rc;
407 }
408
409
410 /*
411  * Read binary data from server into memory using a series of server READ commands.
412  * returns the read content as StrBuf
413  */
414 int serv_read_binary(StrBuf *Ret, size_t total_len, StrBuf *Buf) 
415 {
416         wcsession *WCC = WC;
417         size_t bytes_read = 0;
418         size_t this_block = 0;
419         int rc = 6;
420         int ServerRc = 6;
421
422         if (Ret == NULL) {
423                 return -1;
424         }
425
426         while ((bytes_read < total_len) && (ServerRc == 6)) {
427
428                 if (WCC->serv_sock==-1) {
429                         FlushStrBuf(Ret); 
430                         return -1; 
431                 }
432
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) ) 
436                 {
437                         if (rc < 0)
438                                 return rc;
439                         StrBufCutLeft(Buf, 4);
440                         this_block = StrTol(Buf);
441                         rc = StrBuf_ServGetBLOBBuffered(Ret, this_block);
442                         if (rc < 0) {
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);
447                                 WCC->connected = 0;
448                                 WCC->logged_in = 0;
449                                 return rc;
450                         }
451                         bytes_read += rc;
452                 }
453         }
454
455         return StrLength(Ret);
456 }
457
458
459 int client_write(StrBuf *ThisBuf)
460 {
461         wcsession *WCC = WC;
462         const char *ptr, *eptr;
463         long count;
464         ssize_t res = 0;
465         fd_set wset;
466         int fdflags;
467
468         ptr = ChrPtr(ThisBuf);
469         count = StrLength(ThisBuf);
470         eptr = ptr + count;
471
472         fdflags = fcntl(WC->Hdr->http_sock, F_GETFL);
473
474         while ((ptr < eptr) && (WCC->Hdr->http_sock != -1)) {
475                 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
476                         FD_ZERO(&wset);
477                         FD_SET(WCC->Hdr->http_sock, &wset);
478                         if (select(WCC->Hdr->http_sock + 1, NULL, &wset, NULL, NULL) == -1) {
479                                 syslog(LOG_INFO, "client_write: Socket select failed (%s)\n", strerror(errno));
480                                 return -1;
481                         }
482                 }
483
484                 if ((WCC->Hdr->http_sock == -1) || 
485                     ((res = write(WCC->Hdr->http_sock, ptr, count)),
486                      (res == -1)))
487                 {
488                         syslog(LOG_INFO, "client_write: Socket write failed (%s)\n", strerror(errno));
489                         wc_backtrace(LOG_INFO);
490                         return -1;
491                 }
492                 count -= res;
493                 ptr += res;
494         }
495         return 0;
496 }
497
498
499 int
500 read_serv_chunk(
501
502         StrBuf *Buf,
503         size_t total_len,
504         size_t *bytes_read
505         )
506 {
507         int rc;
508         int ServerRc;
509         wcsession *WCC = WC;
510
511         serv_printf("READ "SIZE_T_FMT"|"SIZE_T_FMT, *bytes_read, total_len-(*bytes_read));
512         if ( (rc = StrBuf_ServGetln(Buf) > 0) &&
513              (ServerRc = GetServerStatus(Buf, NULL), ServerRc == 6) ) 
514         {
515                 size_t this_block = 0;
516
517                 if (rc < 0)
518                         return rc;
519
520                 StrBufCutLeft(Buf, 4);
521                 this_block = StrTol(Buf);
522                 rc = StrBuf_ServGetBLOBBuffered(WCC->WBuf, this_block);
523                 if (rc < 0) {
524                         syslog(LOG_INFO, "Server connection broken during download\n");
525                         wc_backtrace(LOG_INFO);
526                         if (WCC->serv_sock > 0) close(WCC->serv_sock);
527                         WCC->serv_sock = (-1);
528                         WCC->connected = 0;
529                         WCC->logged_in = 0;
530                         return rc;
531                 }
532                 *bytes_read += rc;
533         }
534         return 6;
535 }
536
537 static inline int send_http(StrBuf *Buf)
538 {
539 #ifdef HAVE_OPENSSL
540         if (is_https)
541                 return client_write_ssl(Buf);
542         else
543 #endif
544                 return client_write(Buf);
545 }
546 /*
547  * Read binary data from server into memory using a series of server READ commands.
548  * returns the read content as StrBuf
549  */
550 void serv_read_binary_to_http(StrBuf *MimeType, size_t total_len, int is_static, int detect_mime)
551 {
552         int ServerRc = 6;
553         wcsession *WCC = WC;
554         size_t bytes_read = 0;
555         int first = 1;
556         int client_con_state = 0;
557         int chunked = 0;
558         StrBuf *BufHeader = NULL;
559         StrBuf *Buf;
560
561         Buf = NewStrBuf();
562
563         if (WCC->Hdr->HaveRange)
564         {
565                 WCC->Hdr->HaveRange++;
566                 WCC->Hdr->TotalBytes = total_len;
567                 /* open range? or beyound file border? correct the numbers. */
568                 if ((WCC->Hdr->RangeTil == -1) || (WCC->Hdr->RangeTil>= total_len))
569                         WCC->Hdr->RangeTil = total_len - 1;
570                 bytes_read = WCC->Hdr->RangeStart;
571                 total_len = WCC->Hdr->RangeTil;
572         }
573         else
574                 chunked = total_len > SIZ * 10; /* TODO: disallow for HTTP / 1.0 */
575
576         if (chunked)
577         {
578                 BufHeader=NewStrBuf();
579         }
580
581         if ((detect_mime != 0) && (bytes_read != 0))
582         {
583                 /* need to read first chunk to detect mime, though the client doesn't care */
584                 size_t bytes_read = 0;
585                 const char *CT;
586
587                 ServerRc = read_serv_chunk(
588                         Buf,
589                         total_len,
590                         &bytes_read);
591
592                 if (ServerRc != 6)
593                 {
594                         FreeStrBuf(&Buf);
595                         return;
596                 }
597                 CT = GuessMimeType(SKEY(WCC->WBuf));
598                 FlushStrBuf(WCC->WBuf);
599                 StrBufPlain(MimeType, CT, -1);
600                 detect_mime = 0;
601                 FreeStrBuf(&Buf);
602         }
603
604         if (!detect_mime)
605         {
606                 http_transmit_headers(ChrPtr(MimeType), is_static, chunked);
607                 
608                 if (send_http(WCC->HBuf) < 0)
609                 {
610                         FreeStrBuf(&Buf);
611                         return;
612                 }
613         }
614
615         while ((bytes_read < total_len) &&
616                (ServerRc == 6) &&
617                (client_con_state == 0))
618         {
619
620                 if (WCC->serv_sock==-1) {
621                         FlushStrBuf(WCC->WBuf); 
622                         FreeStrBuf(&Buf);
623                         return;
624                 }
625
626                 ServerRc = read_serv_chunk(
627                         Buf,
628                         total_len,
629                         &bytes_read);
630                 if (ServerRc != 6)
631                         break;
632
633                 if (detect_mime)
634                 {
635                         const char *CT;
636                         detect_mime = 0;
637                         
638                         CT = GuessMimeType(SKEY(WCC->WBuf));
639                         StrBufPlain(MimeType, CT, -1);
640                         http_transmit_headers(ChrPtr(MimeType), is_static, chunked);
641                         
642                         client_con_state = send_http(WCC->HBuf);
643                 }
644
645                 if ((chunked) && (client_con_state == 0))
646                 {
647                         StrBufPrintf(BufHeader, "%s%x\r\n", 
648                                      (first)?"":"\r\n",
649                                      StrLength (WCC->WBuf));
650                         first = 0;
651                         client_con_state = send_http(BufHeader);
652                 }
653
654                 if (client_con_state == 0)
655                     client_con_state = send_http(WCC->WBuf);
656
657                 FlushStrBuf(WCC->WBuf);
658         }
659
660         if ((chunked) && (client_con_state == 0))
661         {
662                 StrBufPlain(BufHeader, HKEY("\r\n0\r\n\r\n"));
663                 if (send_http(BufHeader) < 0)
664                 {
665                         FreeStrBuf(&Buf);
666                         return;
667                 }
668         }
669         FreeStrBuf(&Buf);
670 }
671
672 int ClientGetLine(ParsedHttpHdrs *Hdr, StrBuf *Target)
673 {
674         const char *Error;
675 #ifdef HAVE_OPENSSL
676         const char *pch, *pchs;
677         int rlen, len, retval = 0;
678
679         if (is_https) {
680                 int ntries = 0;
681                 if (StrLength(Hdr->ReadBuf) > 0)
682                 {
683                         pchs = ChrPtr(Hdr->ReadBuf);
684                         pch = strchr(pchs, '\n');
685                         if (pch != NULL) {
686                                 rlen = 0;
687                                 len = pch - pchs;
688                                 if (len > 0 && (*(pch - 1) == '\r') )
689                                         rlen ++;
690                                 StrBufSub(Target, Hdr->ReadBuf, 0, len - rlen);
691                                 StrBufCutLeft(Hdr->ReadBuf, len + 1);
692                                 return len - rlen;
693                         }
694                 }
695
696                 while (retval == 0) { 
697                                 pch = NULL;
698                                 pchs = ChrPtr(Hdr->ReadBuf);
699                                 if (*pchs != '\0')
700                                         pch = strchr(pchs, '\n');
701                                 if (pch == NULL) {
702                                         retval = client_read_sslbuffer(Hdr->ReadBuf, SLEEPING);
703                                         pchs = ChrPtr(Hdr->ReadBuf);
704                                         pch = strchr(pchs, '\n');
705                                         if (pch == NULL)
706                                                 retval = 0;
707                                 }
708                                 if (retval == 0) {
709                                         sleeeeeeeeeep(1);
710                                         ntries ++;
711                                 }
712                                 if (ntries > 10)
713                                         return 0;
714                 }
715                 if ((retval > 0) && (pch != NULL)) {
716                         rlen = 0;
717                         len = pch - pchs;
718                         if (len > 0 && (*(pch - 1) == '\r') )
719                                 rlen ++;
720                         StrBufSub(Target, Hdr->ReadBuf, 0, len - rlen);
721                         StrBufCutLeft(Hdr->ReadBuf, len + 1);
722                         return len - rlen;
723
724                 }
725                 else 
726                         return -1;
727         }
728         else 
729 #endif
730                 return StrBufTCP_read_buffered_line_fast(Target, 
731                                                          Hdr->ReadBuf,
732                                                          &Hdr->Pos,
733                                                          &Hdr->http_sock,
734                                                          5,
735                                                          1,
736                                                          &Error);
737 }
738
739
740 /* 
741  * This is a generic function to set up a master socket for listening on
742  * a TCP port.  The server shuts down if the bind fails.  (IPv4/IPv6 version)
743  *
744  * ip_addr      IP address to bind
745  * port_number  port number to bind
746  * queue_len    number of incoming connections to allow in the queue
747  */
748 int webcit_tcp_server(const char *ip_addr, int port_number, int queue_len)
749 {
750         const char *ipv4broadcast = "0.0.0.0";
751         int IsDefault = 0;
752         struct protoent *p;
753         struct sockaddr_in6 sin6;
754         struct sockaddr_in sin4;
755         int s, i, b;
756         int ip_version = 6;
757
758 retry:
759         memset(&sin6, 0, sizeof(sin6));
760         memset(&sin4, 0, sizeof(sin4));
761         sin6.sin6_family = AF_INET6;
762         sin4.sin_family = AF_INET;
763
764         if (    (ip_addr == NULL)                                                       /* any IPv6 */
765                 || (IsEmptyStr(ip_addr))
766                 || (!strcmp(ip_addr, "*"))
767         ) {
768                 IsDefault = 1;
769                 ip_version = 6;
770                 sin6.sin6_addr = in6addr_any;
771         }
772         else if (!strcmp(ip_addr, "0.0.0.0"))                                           /* any IPv4 */
773         {
774                 ip_version = 4;
775                 sin4.sin_addr.s_addr = INADDR_ANY;
776         }
777         else if ((strchr(ip_addr, '.')) && (!strchr(ip_addr, ':')))                     /* specific IPv4 */
778         {
779                 ip_version = 4;
780                 if (inet_pton(AF_INET, ip_addr, &sin4.sin_addr) <= 0) {
781                         syslog(LOG_WARNING, "Error binding to [%s] : %s\n", ip_addr, strerror(errno));
782                         return (-WC_EXIT_BIND);
783                 }
784         }
785         else                                                                            /* specific IPv6 */
786         {
787                 ip_version = 6;
788                 if (inet_pton(AF_INET6, ip_addr, &sin6.sin6_addr) <= 0) {
789                         syslog(LOG_WARNING, "Error binding to [%s] : %s\n", ip_addr, strerror(errno));
790                         return (-WC_EXIT_BIND);
791                 }
792         }
793
794         if (port_number == 0) {
795                 syslog(LOG_WARNING, "Cannot start: no port number specified.\n");
796                 return (-WC_EXIT_BIND);
797         }
798         sin6.sin6_port = htons((u_short) port_number);
799         sin4.sin_port = htons((u_short) port_number);
800
801         p = getprotobyname("tcp");
802
803         s = socket( ((ip_version == 6) ? PF_INET6 : PF_INET), SOCK_STREAM, (p->p_proto));
804         if (s < 0) {
805                 if (IsDefault && (errno == EAFNOSUPPORT))
806                 {
807                         s = 0;
808                         ip_addr = ipv4broadcast;
809                         goto retry;
810                 }
811                 syslog(LOG_WARNING, "Can't create a listening socket: %s\n", strerror(errno));
812                 return (-WC_EXIT_BIND);
813         }
814         /* Set some socket options that make sense. */
815         i = 1;
816         setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i));
817
818         if (ip_version == 6) {
819                 b = bind(s, (struct sockaddr *) &sin6, sizeof(sin6));
820         }
821         else {
822                 b = bind(s, (struct sockaddr *) &sin4, sizeof(sin4));
823         }
824
825         if (b < 0) {
826                 syslog(LOG_EMERG, "Can't bind: %s\n", strerror(errno));
827                 close(s);
828                 return (-WC_EXIT_BIND);
829         }
830
831         if (listen(s, queue_len) < 0) {
832                 syslog(LOG_EMERG, "Can't listen: %s\n", strerror(errno));
833                 close(s);
834                 return (-WC_EXIT_BIND);
835         }
836         return (s);
837 }
838
839
840 /*
841  * Create a Unix domain socket and listen on it
842  * sockpath - file name of the unix domain socket
843  * queue_len - Number of incoming connections to allow in the queue
844  */
845 int webcit_uds_server(char *sockpath, int queue_len)
846 {
847         struct sockaddr_un addr;
848         int s;
849         int i;
850         int actual_queue_len;
851
852         actual_queue_len = queue_len;
853         if (actual_queue_len < 5) actual_queue_len = 5;
854
855         i = unlink(sockpath);
856         if ((i != 0) && (errno != ENOENT)) {
857                 syslog(LOG_WARNING, "webcit: can't unlink %s: %s\n",
858                         sockpath, strerror(errno));
859                 return (-WC_EXIT_BIND);
860         }
861
862         memset(&addr, 0, sizeof(addr));
863         addr.sun_family = AF_UNIX;
864         safestrncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
865
866         s = socket(AF_UNIX, SOCK_STREAM, 0);
867         if (s < 0) {
868                 syslog(LOG_WARNING, "webcit: Can't create a unix domain socket: %s\n", strerror(errno));
869                 return (-WC_EXIT_BIND);
870         }
871
872         if (bind(s, (struct sockaddr *)&addr, sizeof(addr)) < 0) {
873                 syslog(LOG_WARNING, "webcit: Can't bind: %s\n", strerror(errno));
874                 close(s);
875                 return (-WC_EXIT_BIND);
876         }
877
878         if (listen(s, actual_queue_len) < 0) {
879                 syslog(LOG_WARNING, "webcit: Can't listen: %s\n", strerror(errno));
880                 close(s);
881                 return (-WC_EXIT_BIND);
882         }
883
884         chmod(sockpath, 0777);
885         return(s);
886 }
887
888
889
890
891 /*
892  * Read data from the client socket.
893  *
894  * sock         socket fd to read from
895  * buf          buffer to read into 
896  * bytes        number of bytes to read
897  * timeout      Number of seconds to wait before timing out
898  *
899  * Possible return values:
900  *      1       Requested number of bytes has been read.
901  *      0       Request timed out.
902  *      -1      Connection is broken, or other error.
903  */
904 int client_read_to(ParsedHttpHdrs *Hdr, StrBuf *Target, int bytes, int timeout)
905 {
906         const char *Error;
907         int retval = 0;
908
909 #ifdef HAVE_OPENSSL
910         if (is_https) {
911                 long bufremain = 0;
912                 long baselen;
913
914                 baselen = StrLength(Target);
915
916                 if (Hdr->Pos == NULL)
917                         Hdr->Pos = ChrPtr(Hdr->ReadBuf);
918
919                 if (StrLength(Hdr->ReadBuf) > 0)
920                 {
921                         bufremain = StrLength(Hdr->ReadBuf) - (Hdr->Pos - ChrPtr(Hdr->ReadBuf));
922                         
923                         if (bytes < bufremain)
924                                 bufremain = bytes;
925                         StrBufAppendBufPlain(Target, Hdr->Pos, bufremain, 0);
926                         StrBufCutLeft(Hdr->ReadBuf, bufremain);
927                 }
928
929                 if (bytes > bufremain) 
930                 {
931                         while ((StrLength(Hdr->ReadBuf) + StrLength(Target) < bytes + baselen) &&
932                                (retval >= 0))
933                                 retval = client_read_sslbuffer(Hdr->ReadBuf, timeout);
934                         if (retval >= 0) {
935                                 StrBufAppendBuf(Target, Hdr->ReadBuf, 0); /* todo: Buf > bytes? */
936                                 return 1;
937                         }
938                         else {
939                                 syslog(LOG_INFO, "client_read_ssl() failed\n");
940                                 return -1;
941                         }
942                 }
943                 else 
944                         return 1;
945         }
946 #endif
947
948         retval = StrBufReadBLOBBuffered(Target, 
949                                         Hdr->ReadBuf, 
950                                         &Hdr->Pos, 
951                                         &Hdr->http_sock, 
952                                         1, 
953                                         bytes,
954                                         O_TERM,
955                                         &Error);
956         if (retval < 0) {
957                 syslog(LOG_INFO, "client_read() failed: %s\n",
958                         Error);
959                 wc_backtrace(LOG_DEBUG);
960                 return retval;
961         }
962
963         return 1;
964 }
965
966
967 /*
968  * Begin buffering HTTP output so we can transmit it all in one write operation later.
969  */
970 void begin_burst(void)
971 {
972         if (WC->WBuf == NULL) {
973                 WC->WBuf = NewStrBufPlain(NULL, 32768);
974         }
975 }
976
977
978 /*
979  * Finish buffering HTTP output.  [Compress using zlib and] output with a Content-Length: header.
980  */
981 long end_burst(void)
982 {
983         wcsession *WCC = WC;
984         const char *ptr, *eptr;
985         long count;
986         ssize_t res = 0;
987         fd_set wset;
988         int fdflags;
989
990         if (!DisableGzip && (WCC->Hdr->HR.gzip_ok))
991         {
992                 if (CompressBuffer(WCC->WBuf) > 0)
993                         hprintf("Content-encoding: gzip\r\n");
994                 else {
995                         syslog(LOG_ALERT, "Compression failed: %d [%s] sending uncompressed\n", errno, strerror(errno));
996                         wc_backtrace(LOG_INFO);
997                 }
998         }
999
1000         if (WCC->WFBuf != NULL) {
1001                 WildFireSerializePayload(WCC->WFBuf, WCC->HBuf, &WCC->Hdr->nWildfireHeaders, NULL);
1002                 FreeStrBuf(&WCC->WFBuf);
1003         }
1004
1005         if (WCC->Hdr->HR.prohibit_caching)
1006                 hprintf("Pragma: no-cache\r\nCache-Control: no-store\r\nExpires:-1\r\n");
1007         hprintf("Content-length: %d\r\n\r\n", StrLength(WCC->WBuf));
1008
1009         ptr = ChrPtr(WCC->HBuf);
1010         count = StrLength(WCC->HBuf);
1011         eptr = ptr + count;
1012
1013 #ifdef HAVE_OPENSSL
1014         if (is_https) {
1015                 client_write_ssl(WCC->HBuf);
1016                 client_write_ssl(WCC->WBuf);
1017                 return (count);
1018         }
1019 #endif
1020
1021         if (WCC->Hdr->http_sock == -1)
1022                 return -1;
1023         fdflags = fcntl(WC->Hdr->http_sock, F_GETFL);
1024
1025         while ((ptr < eptr) && (WCC->Hdr->http_sock != -1)){
1026                 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
1027                         FD_ZERO(&wset);
1028                         FD_SET(WCC->Hdr->http_sock, &wset);
1029                         if (select(WCC->Hdr->http_sock + 1, NULL, &wset, NULL, NULL) == -1) {
1030                                 syslog(LOG_DEBUG, "client_write: Socket select failed (%s)\n", strerror(errno));
1031                                 return -1;
1032                         }
1033                 }
1034
1035                 if ((WCC->Hdr->http_sock == -1) || 
1036                     (res = write(WCC->Hdr->http_sock, 
1037                                  ptr,
1038                                  count)) == -1) {
1039                         syslog(LOG_DEBUG, "client_write: Socket write failed (%s)\n", strerror(errno));
1040                         wc_backtrace(LOG_INFO);
1041                         return res;
1042                 }
1043                 count -= res;
1044                 ptr += res;
1045         }
1046
1047         ptr = ChrPtr(WCC->WBuf);
1048         count = StrLength(WCC->WBuf);
1049         eptr = ptr + count;
1050
1051         while ((ptr < eptr) && (WCC->Hdr->http_sock != -1)) {
1052                 if ((fdflags & O_NONBLOCK) == O_NONBLOCK) {
1053                         FD_ZERO(&wset);
1054                         FD_SET(WCC->Hdr->http_sock, &wset);
1055                         if (select(WCC->Hdr->http_sock + 1, NULL, &wset, NULL, NULL) == -1) {
1056                                 syslog(LOG_INFO, "client_write: Socket select failed (%s)\n", strerror(errno));
1057                                 return -1;
1058                         }
1059                 }
1060
1061                 if ((WCC->Hdr->http_sock == -1) || 
1062                     (res = write(WCC->Hdr->http_sock, 
1063                                  ptr,
1064                                  count)) == -1) {
1065                         syslog(LOG_INFO, "client_write: Socket write failed (%s)\n", strerror(errno));
1066                         wc_backtrace(LOG_INFO);
1067                         return res;
1068                 }
1069                 count -= res;
1070                 ptr += res;
1071         }
1072
1073         return StrLength(WCC->WBuf);
1074 }
1075
1076
1077 /*
1078  * lingering_close() a`la Apache. see
1079  * http://httpd.apache.org/docs/2.0/misc/fin_wait_2.html for rationale
1080  */
1081 int lingering_close(int fd)
1082 {
1083         char buf[SIZ];
1084         int i;
1085         fd_set set;
1086         struct timeval tv, start;
1087
1088         gettimeofday(&start, NULL);
1089         if (fd == -1)
1090                 return -1;
1091         shutdown(fd, 1);
1092         do {
1093                 do {
1094                         gettimeofday(&tv, NULL);
1095                         tv.tv_sec = SLEEPING - (tv.tv_sec - start.tv_sec);
1096                         tv.tv_usec = start.tv_usec - tv.tv_usec;
1097                         if (tv.tv_usec < 0) {
1098                                 tv.tv_sec--;
1099                                 tv.tv_usec += 1000000;
1100                         }
1101                         FD_ZERO(&set);
1102                         FD_SET(fd, &set);
1103                         i = select(fd + 1, &set, NULL, NULL, &tv);
1104                 } while (i == -1 && errno == EINTR);
1105
1106                 if (i <= 0)
1107                         break;
1108
1109                 i = read(fd, buf, sizeof buf);
1110         } while (i != 0 && (i != -1 || errno == EINTR));
1111
1112         return close(fd);
1113 }
1114
1115 void
1116 HttpNewModule_TCPSOCKETS
1117 (ParsedHttpHdrs *httpreq)
1118 {
1119
1120         httpreq->ReadBuf = NewStrBufPlain(NULL, SIZ * 4);
1121 }
1122
1123 void
1124 HttpDetachModule_TCPSOCKETS
1125 (ParsedHttpHdrs *httpreq)
1126 {
1127
1128         FlushStrBuf(httpreq->ReadBuf);
1129         ReAdjustEmptyBuf(httpreq->ReadBuf, 4 * SIZ, SIZ);
1130 }
1131
1132 void
1133 HttpDestroyModule_TCPSOCKETS
1134 (ParsedHttpHdrs *httpreq)
1135 {
1136
1137         FreeStrBuf(&httpreq->ReadBuf);
1138 }
1139
1140
1141 void
1142 SessionNewModule_TCPSOCKETS
1143 (wcsession *sess)
1144 {
1145         sess->CLineBuf = NewStrBuf();
1146         sess->MigrateReadLineBuf = NewStrBuf();
1147 }
1148
1149 void 
1150 SessionDestroyModule_TCPSOCKETS
1151 (wcsession *sess)
1152 {
1153         FreeStrBuf(&sess->CLineBuf);
1154         FreeStrBuf(&sess->ReadBuf);
1155         sess->connected = 0;
1156         sess->ReadPos = NULL;
1157         FreeStrBuf(&sess->MigrateReadLineBuf);
1158         if (sess->serv_sock > 0) {
1159                 syslog(LOG_DEBUG, "Closing socket %d", sess->serv_sock);
1160                 close(sess->serv_sock);
1161         }
1162         sess->serv_sock = -1;
1163 }