I like having the version logged at startup and the Windows GUI stopped logging
[privoxy.git] / jbsockets.c
1 const char jbsockets_rcs[] = "$Id: jbsockets.c,v 1.49 2008/11/10 17:03:57 fabiankeil Exp $";
2 /*********************************************************************
3  *
4  * File        :  $Source: /cvsroot/ijbswa/current/jbsockets.c,v $
5  *
6  * Purpose     :  Contains wrappers for system-specific sockets code,
7  *                so that the rest of Junkbuster can be more
8  *                OS-independent.  Contains #ifdefs to make this work
9  *                on many platforms.
10  *
11  * Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge
12  *                Privoxy team. http://www.privoxy.org/
13  *
14  *                Based on the Internet Junkbuster originally written
15  *                by and Copyright (C) 1997 Anonymous Coders and 
16  *                Junkbusters Corporation.  http://www.junkbusters.com
17  *
18  *                This program is free software; you can redistribute it 
19  *                and/or modify it under the terms of the GNU General
20  *                Public License as published by the Free Software
21  *                Foundation; either version 2 of the License, or (at
22  *                your option) any later version.
23  *
24  *                This program is distributed in the hope that it will
25  *                be useful, but WITHOUT ANY WARRANTY; without even the
26  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
27  *                PARTICULAR PURPOSE.  See the GNU General Public
28  *                License for more details.
29  *
30  *                The GNU General Public License should be included with
31  *                this file.  If not, you can view it at
32  *                http://www.gnu.org/copyleft/gpl.html
33  *                or write to the Free Software Foundation, Inc., 59
34  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
35  *
36  * Revisions   :
37  *    $Log: jbsockets.c,v $
38  *    Revision 1.49  2008/11/10 17:03:57  fabiankeil
39  *    Fix a gcc44 warning and remove a now-obsolete cast.
40  *
41  *    Revision 1.48  2008/09/04 08:13:58  fabiankeil
42  *    Prepare for critical sections on Windows by adding a
43  *    layer of indirection before the pthread mutex functions.
44  *
45  *    Revision 1.47  2008/03/26 18:07:07  fabiankeil
46  *    Add hostname directive. Closes PR#1918189.
47  *
48  *    Revision 1.46  2008/03/21 11:13:57  fabiankeil
49  *    Only gather host information if it's actually needed.
50  *    Also move the code out of accept_connection() so it's less likely
51  *    to delay other incoming connections if the host is misconfigured.
52  *
53  *    Revision 1.45  2007/09/30 16:59:22  fabiankeil
54  *    Set the maximum listen() backlog to 128. Apparently SOMAXCONN is
55  *    neither high enough, nor a hard limit on mingw32. Again for BR#1795281.
56  *
57  *    Revision 1.44  2007/09/15 13:01:31  fabiankeil
58  *    Increase listen() backlog to SOMAXCONN (or 128) to decrease
59  *    chances of dropped connections under load. Problem reported
60  *    and fix suggested by nobody in BR#1795281.
61  *
62  *    Revision 1.43  2007/06/01 18:16:36  fabiankeil
63  *    Use the same mutex for gethostbyname() and gethostbyaddr() to prevent
64  *    deadlocks and crashes on OpenBSD and possibly other OS with neither
65  *    gethostbyname_r() nor gethostaddr_r(). Closes BR#1729174.
66  *    Thanks to Ralf Horstmann for report and solution.
67  *
68  *    Revision 1.42  2007/04/01 17:37:07  fabiankeil
69  *    - Add DNS retries for Solaris and other systems
70  *      whose gethostbyname_r version takes five arguments.
71  *    - Move maximum number of DNS retries into a macro.
72  *
73  *    Revision 1.41  2006/11/13 19:05:51  fabiankeil
74  *    Make pthread mutex locking more generic. Instead of
75  *    checking for OSX and OpenBSD, check for FEATURE_PTHREAD
76  *    and use mutex locking unless there is an _r function
77  *    available. Better safe than sorry.
78  *
79  *    Fixes "./configure --disable-pthread" and should result
80  *    in less threading-related problems on pthread-using platforms,
81  *    but it still doesn't fix BR#1122404.
82  *
83  *    Revision 1.40  2006/09/02 15:36:42  fabiankeil
84  *    Follow the OpenBSD port's lead and protect the resolve
85  *    functions on OpenBSD as well.
86  *
87  *    Revision 1.39  2006/08/03 02:46:41  david__schmidt
88  *    Incorporate Fabian Keil's patch work:\rhttp://www.fabiankeil.de/sourcecode/privoxy/
89  *
90  *    Revision 1.38  2006/07/18 14:48:46  david__schmidt
91  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
92  *    with what was really the latest development (the v_3_0_branch branch)
93  *
94  *    Revision 1.35.2.8  2006/01/21 16:16:08  david__schmidt
95  *    Thanks to  Edward Carrel for his patch to modernize OSX's\rpthreads support.  See bug #1409623.
96  *
97  *    Revision 1.35.2.7  2005/05/07 21:50:55  david__schmidt
98  *    A few memory leaks plugged (mostly on error paths)
99  *
100  *    Revision 1.35.2.6  2003/12/17 16:34:40  oes
101  *    Cosmetics
102  *
103  *    Revision 1.35.2.5  2003/04/29 11:32:54  oes
104  *    Don't rely on h_addr being non-NULL after gethostbyname.
105  *    Works around an oddness in Max OSX and closes bug #724796
106  *
107  *    Revision 1.35.2.4  2003/04/04 12:40:20  oes
108  *    Made sure the errno set by bind, not close[socket] is used in
109  *    bind_port. Probably fixes bugs #713777, #705562.
110  *
111  *    Revision 1.35.2.3  2003/03/07 03:41:04  david__schmidt
112  *    Wrapping all *_r functions (the non-_r versions of them) with mutex semaphores for OSX.  Hopefully this will take care of all of those pesky crash reports.
113  *
114  *    Revision 1.35.2.2  2002/11/20 14:37:24  oes
115  *    Fixed Win32 error logging in bind_port.
116  *    Thanks to Oliver Stoeneberg for the hint.
117  *
118  *    Revision 1.35.2.1  2002/05/26 23:41:27  joergs
119  *    AmigaOS: Fixed wrong type of len in write_socket()
120  *
121  *    Revision 1.35  2002/04/26 15:50:04  joergs
122  *    AmigaOS: No socklen_t, added AMIGA to the systems using int instead.
123  *
124  *    Revision 1.34  2002/04/08 20:31:41  swa
125  *    fixed JB spelling
126  *
127  *    Revision 1.33  2002/04/03 16:02:18  gliptak
128  *    Correcting compile warning with older gcc
129  *
130  *    Revision 1.32  2002/03/31 17:18:59  jongfoster
131  *    Win32 only: Enabling STRICT to fix a VC++ compile warning.
132  *
133  *    Revision 1.31  2002/03/29 03:33:13  david__schmidt
134  *    Fix Mac OSX compiler warnings
135  *
136  *    Revision 1.30  2002/03/27 14:32:43  david__schmidt
137  *    More compiler warning message maintenance
138  *
139  *    Revision 1.29  2002/03/26 22:29:54  swa
140  *    we have a new homepage!
141  *
142  *    Revision 1.28  2002/03/24 13:25:43  swa
143  *    name change related issues
144  *
145  *    Revision 1.27  2002/03/13 00:27:05  jongfoster
146  *    Killing warnings
147  *
148  *    Revision 1.26  2002/03/11 22:07:02  david__schmidt
149  *    OS/2 port maintenance:
150  *    - Fixed EMX build - it had decayed a little
151  *    - Fixed inexplicable crash during FD_ZERO - must be due to a bad macro.
152  *      substituted a memset for now.
153  *
154  *    Revision 1.25  2002/03/09 20:03:52  jongfoster
155  *    - Making various functions return int rather than size_t.
156  *      (Undoing a recent change).  Since size_t is unsigned on
157  *      Windows, functions like read_socket that return -1 on
158  *      error cannot return a size_t.
159  *
160  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
161  *      crashes, and also frequently caused JB to jump to 100%
162  *      CPU and stay there.  (Because it thought it had just
163  *      read ((unsigned)-1) == 4Gb of data...)
164  *
165  *    - The signature of write_socket has changed, it now simply
166  *      returns success=0/failure=nonzero.
167  *
168  *    - Trying to get rid of a few warnings --with-debug on
169  *      Windows, I've introduced a new type "jb_socket".  This is
170  *      used for the socket file descriptors.  On Windows, this
171  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
172  *      an int.  The error value can't be -1 any more, so it's
173  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
174  *      Windows it maps to the #define INVALID_SOCKET.)
175  *
176  *    - The signature of bind_port has changed.
177  *
178  *    Revision 1.24  2002/03/07 03:51:36  oes
179  *     - Improved handling of failed DNS lookups
180  *     - Fixed compiler warnings etc
181  *
182  *    Revision 1.23  2002/03/05 00:36:01  jongfoster
183  *    Fixing bug 514988 - unable to restart Junkbuster
184  *
185  *    Revision 1.22  2002/03/04 02:08:02  david__schmidt
186  *    Enable web editing of actions file on OS/2 (it had been broken all this time!)
187  *
188  *    Revision 1.21  2002/01/09 14:32:33  oes
189  *    Added support for gethostbyname_r and gethostbyaddr_r.
190  *
191  *    Revision 1.20  2001/11/16 00:48:48  jongfoster
192  *    Enabling duplicate-socket detection for all platforms, not
193  *    just Win32.
194  *
195  *    Revision 1.19  2001/10/25 03:40:47  david__schmidt
196  *    Change in porting tactics: OS/2's EMX porting layer doesn't allow multiple
197  *    threads to call select() simultaneously.  So, it's time to do a real, live,
198  *    native OS/2 port.  See defines for __EMX__ (the porting layer) vs. __OS2__
199  *    (native). Both versions will work, but using __OS2__ offers multi-threading.
200  *
201  *    Revision 1.18  2001/09/21 23:02:02  david__schmidt
202  *    Cleaning up 2 compiler warnings on OS/2.
203  *
204  *    Revision 1.17  2001/09/13 20:11:46  jongfoster
205  *    Fixing 2 compiler warnings under Win32
206  *
207  *    Revision 1.16  2001/07/30 22:08:36  jongfoster
208  *    Tidying up #defines:
209  *    - All feature #defines are now of the form FEATURE_xxx
210  *    - Permanently turned off WIN_GUI_EDIT
211  *    - Permanently turned on WEBDAV and SPLIT_PROXY_ARGS
212  *
213  *    Revision 1.15  2001/07/29 17:40:43  jongfoster
214  *    Fixed compiler warning by adding a cast
215  *
216  *    Revision 1.14  2001/07/18 13:47:59  oes
217  *    Eliminated dirty hack for getsockbyname()
218  *
219  *    Revision 1.13  2001/07/15 13:56:57  jongfoster
220  *    Removing unused local variable.
221  *
222  *    Revision 1.12  2001/07/01 17:04:11  oes
223  *    Bugfix: accept_connection no longer uses the obsolete hstrerror() function
224  *
225  *    Revision 1.11  2001/06/29 21:45:41  oes
226  *    Indentation, CRLF->LF, Tab-> Space
227  *
228  *    Revision 1.10  2001/06/29 13:29:15  oes
229  *    - Added remote (server) host IP to csp->http->host_ip_addr_str
230  *    - Added detection of local socket IP and fqdn
231  *    - Removed logentry from cancelled commit
232  *
233  *    Revision 1.9  2001/06/07 23:06:09  jongfoster
234  *    The host parameter to connect_to() is now const.
235  *
236  *    Revision 1.8  2001/06/03 19:12:07  oes
237  *    filled comment
238  *
239  *    Revision 1.7  2001/05/28 16:14:00  jongfoster
240  *    Fixing bug in LOG_LEVEL_LOG
241  *
242  *    Revision 1.6  2001/05/26 17:28:32  jongfoster
243  *    Fixed LOG_LEVEL_LOG
244  *
245  *    Revision 1.5  2001/05/26 15:26:15  jongfoster
246  *    ACL feature now provides more security by immediately dropping
247  *    connections from untrusted hosts.
248  *
249  *    Revision 1.4  2001/05/26 00:37:42  jongfoster
250  *    Cosmetic indentation correction.
251  *
252  *    Revision 1.3  2001/05/25 21:57:54  jongfoster
253  *    Now gives a warning under Windows if you try to bind
254  *    it to a port that's already in use.
255  *
256  *    Revision 1.2  2001/05/17 23:01:01  oes
257  *     - Cleaned CRLF's from the sources and related files
258  *
259  *    Revision 1.1.1.1  2001/05/15 13:58:54  oes
260  *    Initial import of version 2.9.3 source tree
261  *
262  *
263  *********************************************************************/
264 \f
265
266 #include "config.h"
267
268 #include <stdlib.h>
269 #include <stdio.h>
270 #include <string.h>
271 #include <errno.h>
272 #include <fcntl.h>
273 #include <sys/types.h>
274
275 #ifdef _WIN32
276
277 #ifndef STRICT
278 #define STRICT
279 #endif
280 #include <windows.h>
281 #include <sys/timeb.h>
282 #include <io.h>
283
284 #else
285
286 #ifndef __OS2__
287 #include <unistd.h>
288 #endif
289 #include <sys/time.h>
290 #include <netinet/in.h>
291 #include <sys/ioctl.h>
292 #include <netdb.h>
293 #include <sys/socket.h>
294
295 #ifndef __BEOS__
296 #include <netinet/tcp.h>
297 #ifndef __OS2__
298 #include <arpa/inet.h>
299 #endif
300 #else
301 #include <socket.h>
302 #endif
303
304 #if defined(__EMX__) || defined (__OS2__)
305 #include <sys/select.h>  /* OS/2/EMX needs a little help with select */
306 #ifdef __OS2__
307 #include <nerrno.h>
308 #endif
309 #endif
310
311 #endif
312
313 #include "project.h"
314
315 #ifdef FEATURE_PTHREAD
316 #include "jcc.h"
317 /* jcc.h is for mutex semaphores only */
318 #endif /* def FEATURE_PTHREAD */
319
320 #include "jbsockets.h"
321 #include "filters.h"
322 #include "errlog.h"
323
324 const char jbsockets_h_rcs[] = JBSOCKETS_H_VERSION;
325
326 /*
327  * Maximum number of gethostbyname(_r) retries in case of
328  * soft errors (TRY_AGAIN).
329  * XXX: Does it make sense to make this a config option?
330  */
331 #define MAX_DNS_RETRIES 10
332
333 #define MAX_LISTEN_BACKLOG 128
334
335
336 /*********************************************************************
337  *
338  * Function    :  connect_to
339  *
340  * Description :  Open a socket and connect to it.  Will check
341  *                that this is allowed according to ACL.
342  *
343  * Parameters  :
344  *          1  :  host = hostname to connect to
345  *          2  :  portnum = port to connent on (XXX: should be unsigned)
346  *          3  :  csp = Current client state (buffers, headers, etc...)
347  *                      Not modified, only used for source IP and ACL.
348  *
349  * Returns     :  JB_INVALID_SOCKET => failure, else it is the socket
350  *                file descriptor.
351  *
352  *********************************************************************/
353 jb_socket connect_to(const char *host, int portnum, struct client_state *csp)
354 {
355    struct sockaddr_in inaddr;
356    jb_socket fd;
357    unsigned int addr;
358    fd_set wfds;
359    struct timeval tv[1];
360 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA)
361    int   flags;
362 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) */
363
364 #ifdef FEATURE_ACL
365    struct access_control_addr dst[1];
366 #endif /* def FEATURE_ACL */
367
368    memset((char *)&inaddr, 0, sizeof inaddr);
369
370    if ((addr = resolve_hostname_to_ip(host)) == INADDR_NONE)
371    {
372       csp->http->host_ip_addr_str = strdup("unknown");
373       return(JB_INVALID_SOCKET);
374    }
375
376 #ifdef FEATURE_ACL
377    dst->addr = ntohl(addr);
378    dst->port = portnum;
379
380    if (block_acl(dst, csp))
381    {
382 #ifdef __OS2__
383       errno = SOCEPERM;
384 #else
385       errno = EPERM;
386 #endif
387       return(JB_INVALID_SOCKET);
388    }
389 #endif /* def FEATURE_ACL */
390
391    inaddr.sin_addr.s_addr = addr;
392    inaddr.sin_family      = AF_INET;
393    csp->http->host_ip_addr_str = strdup(inet_ntoa(inaddr.sin_addr));
394
395 #ifndef _WIN32
396    if (sizeof(inaddr.sin_port) == sizeof(short))
397 #endif /* ndef _WIN32 */
398    {
399       inaddr.sin_port = htons((unsigned short) portnum);
400    }
401 #ifndef _WIN32
402    else
403    {
404       inaddr.sin_port = htonl((unsigned long)portnum);
405    }
406 #endif /* ndef _WIN32 */
407
408 #ifdef _WIN32
409    if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) == JB_INVALID_SOCKET)
410 #else
411    if ((fd = socket(inaddr.sin_family, SOCK_STREAM, 0)) < 0)
412 #endif
413    {
414       return(JB_INVALID_SOCKET);
415    }
416
417 #ifdef TCP_NODELAY
418    {  /* turn off TCP coalescence */
419       int mi = 1;
420       setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (char *) &mi, sizeof (int));
421    }
422 #endif /* def TCP_NODELAY */
423
424 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
425    if ((flags = fcntl(fd, F_GETFL, 0)) != -1)
426    {
427       flags |= O_NDELAY;
428       fcntl(fd, F_SETFL, flags);
429    }
430 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
431
432    while (connect(fd, (struct sockaddr *) & inaddr, sizeof inaddr) == JB_INVALID_SOCKET)
433    {
434 #ifdef _WIN32
435       if (errno == WSAEINPROGRESS)
436 #elif __OS2__ 
437       if (sock_errno() == EINPROGRESS)
438 #else /* ifndef _WIN32 */
439       if (errno == EINPROGRESS)
440 #endif /* ndef _WIN32 || __OS2__ */
441       {
442          break;
443       }
444
445 #ifdef __OS2__ 
446       if (sock_errno() != EINTR)
447 #else
448       if (errno != EINTR)
449 #endif /* __OS2__ */
450       {
451          close_socket(fd);
452          return(JB_INVALID_SOCKET);
453       }
454    }
455
456 #if !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__)
457    if (flags != -1)
458    {
459       flags &= ~O_NDELAY;
460       fcntl(fd, F_SETFL, flags);
461    }
462 #endif /* !defined(_WIN32) && !defined(__BEOS__) && !defined(AMIGA) && !defined(__OS2__) */
463
464    /* wait for connection to complete */
465    FD_ZERO(&wfds);
466    FD_SET(fd, &wfds);
467
468    tv->tv_sec  = 30;
469    tv->tv_usec = 0;
470
471    /* MS Windows uses int, not SOCKET, for the 1st arg of select(). Wierd! */
472    if (select((int)fd + 1, NULL, &wfds, NULL, tv) <= 0)
473    {
474       close_socket(fd);
475       return(JB_INVALID_SOCKET);
476    }
477    return(fd);
478
479 }
480
481
482 /*********************************************************************
483  *
484  * Function    :  write_socket
485  *
486  * Description :  Write the contents of buf (for n bytes) to socket fd.
487  *
488  * Parameters  :
489  *          1  :  fd = file descriptor (aka. handle) of socket to write to.
490  *          2  :  buf = pointer to data to be written.
491  *          3  :  len = length of data to be written to the socket "fd".
492  *
493  * Returns     :  0 on success (entire buffer sent).
494  *                nonzero on error.
495  *
496  *********************************************************************/
497 #ifdef AMIGA
498 int write_socket(jb_socket fd, const char *buf, ssize_t len)
499 #else
500 int write_socket(jb_socket fd, const char *buf, size_t len)
501 #endif
502 {
503    if (len == 0)
504    {
505       return 0;
506    }
507
508    if (len < 0) /* constant condition - size_t isn't ever negative */ 
509    {
510       return 1;
511    }
512
513    log_error(LOG_LEVEL_LOG, "%N", len, buf);
514
515 #if defined(_WIN32)
516    return (send(fd, buf, (int)len, 0) != (int)len);
517 #elif defined(__BEOS__) || defined(AMIGA)
518    return (send(fd, buf, len, 0) != len);
519 #elif defined(__OS2__)
520    /*
521     * Break the data up into SOCKET_SEND_MAX chunks for sending...
522     * OS/2 seemed to complain when the chunks were too large.
523     */
524 #define SOCKET_SEND_MAX 65000
525    {
526       int write_len = 0, send_len, send_rc = 0, i = 0;
527       while ((i < len) && (send_rc != -1))
528       {
529          if ((i + SOCKET_SEND_MAX) > len)
530             send_len = len - i;
531          else
532             send_len = SOCKET_SEND_MAX;
533          send_rc = send(fd,(char*)buf + i, send_len, 0);
534          if (send_rc == -1)
535             return 1;
536          i = i + send_len;
537       }
538       return 0;
539    }
540 #else
541    return (write(fd, buf, len) != len);
542 #endif
543
544 }
545
546
547 /*********************************************************************
548  *
549  * Function    :  read_socket
550  *
551  * Description :  Read from a TCP/IP socket in a platform independent way.
552  *
553  * Parameters  :
554  *          1  :  fd = file descriptor of the socket to read
555  *          2  :  buf = pointer to buffer where data will be written
556  *                Must be >= len bytes long.
557  *          3  :  len = maximum number of bytes to read
558  *
559  * Returns     :  On success, the number of bytes read is returned (zero
560  *                indicates end of file), and the file position is advanced
561  *                by this number.  It is not an error if this number is
562  *                smaller than the number of bytes requested; this may hap-
563  *                pen for example because fewer bytes are actually available
564  *                right now (maybe because we were close to end-of-file, or
565  *                because we are reading from a pipe, or from a terminal,
566  *                or because read() was interrupted by a signal).  On error,
567  *                -1 is returned, and errno is set appropriately.  In this
568  *                case it is left unspecified whether the file position (if
569  *                any) changes.
570  *
571  *********************************************************************/
572 int read_socket(jb_socket fd, char *buf, int len)
573 {
574    if (len <= 0)
575    {
576       return(0);
577    }
578
579 #if defined(_WIN32)
580    return(recv(fd, buf, len, 0));
581 #elif defined(__BEOS__) || defined(AMIGA) || defined(__OS2__)
582    return(recv(fd, buf, (size_t)len, 0));
583 #else
584    return(read(fd, buf, (size_t)len));
585 #endif
586 }
587
588
589 /*********************************************************************
590  *
591  * Function    :  data_is_available
592  *
593  * Description :  Waits for data to arrive on a socket.
594  *
595  * Parameters  :
596  *          1  :  fd = file descriptor of the socket to read
597  *          2  :  seconds_to_wait = number of seconds after which we give up.
598  *
599  * Returns     :  TRUE if data arrived in time,
600  *                FALSE otherwise.
601  *
602  *********************************************************************/
603 int data_is_available(jb_socket fd, int seconds_to_wait)
604 {
605    fd_set rfds;
606    struct timeval timeout;
607    int n;
608
609    memset(&timeout, 0, sizeof(timeout));
610    timeout.tv_sec = seconds_to_wait;
611
612 #ifdef __OS2__
613    /* Copy and pasted from jcc.c ... */
614    memset(&rfds, 0, sizeof(fd_set));
615 #else
616    FD_ZERO(&rfds);
617 #endif
618    FD_SET(fd, &rfds);
619
620    n = select(fd+1, &rfds, NULL, NULL, &timeout);
621
622    /*
623     * XXX: Do we care about the different error conditions?
624     */
625    return (n == 1);
626 }
627
628
629 /*********************************************************************
630  *
631  * Function    :  close_socket
632  *
633  * Description :  Closes a TCP/IP socket
634  *
635  * Parameters  :
636  *          1  :  fd = file descriptor of socket to be closed
637  *
638  * Returns     :  void
639  *
640  *********************************************************************/
641 void close_socket(jb_socket fd)
642 {
643 #if defined(_WIN32) || defined(__BEOS__)
644    closesocket(fd);
645 #elif defined(AMIGA)
646    CloseSocket(fd); 
647 #elif defined(__OS2__)
648    soclose(fd);
649 #else
650    close(fd);
651 #endif
652
653 }
654
655
656 /*********************************************************************
657  *
658  * Function    :  bind_port
659  *
660  * Description :  Call socket, set socket options, and listen.
661  *                Called by listen_loop to "boot up" our proxy address.
662  *
663  * Parameters  :
664  *          1  :  hostnam = TCP/IP address to bind/listen to
665  *          2  :  portnum = port to listen on
666  *          3  :  pfd = pointer used to return file descriptor.
667  *
668  * Returns     :  if success, returns 0 and sets *pfd.
669  *                if failure, returns -3 if address is in use,
670  *                                    -2 if address unresolvable,
671  *                                    -1 otherwise
672  *********************************************************************/
673 int bind_port(const char *hostnam, int portnum, jb_socket *pfd)
674 {
675    struct sockaddr_in inaddr;
676    jb_socket fd;
677 #ifndef _WIN32
678    int one = 1;
679 #endif /* ndef _WIN32 */
680
681    *pfd = JB_INVALID_SOCKET;
682
683    memset((char *)&inaddr, '\0', sizeof inaddr);
684
685    inaddr.sin_family      = AF_INET;
686    inaddr.sin_addr.s_addr = resolve_hostname_to_ip(hostnam);
687
688    if (inaddr.sin_addr.s_addr == INADDR_NONE)
689    {
690       return(-2);
691    }
692
693 #ifndef _WIN32
694    if (sizeof(inaddr.sin_port) == sizeof(short))
695 #endif /* ndef _WIN32 */
696    {
697       inaddr.sin_port = htons((unsigned short) portnum);
698    }
699 #ifndef _WIN32
700    else
701    {
702       inaddr.sin_port = htonl((unsigned long) portnum);
703    }
704 #endif /* ndef _WIN32 */
705
706    fd = socket(AF_INET, SOCK_STREAM, 0);
707
708 #ifdef _WIN32
709    if (fd == JB_INVALID_SOCKET)
710 #else
711    if (fd < 0)
712 #endif
713    {
714       return(-1);
715    }
716
717 #ifndef _WIN32
718    /*
719     * This is not needed for Win32 - in fact, it stops
720     * duplicate instances of Privoxy from being caught.
721     *
722     * On UNIX, we assume the user is sensible enough not
723     * to start Privoxy multiple times on the same IP.
724     * Without this, stopping and restarting Privoxy
725     * from a script fails.
726     * Note: SO_REUSEADDR is meant to only take over
727     * sockets which are *not* in listen state in Linux,
728     * e.g. sockets in TIME_WAIT. YMMV.
729     */
730    setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (char *)&one, sizeof(one));
731 #endif /* ndef _WIN32 */
732
733    if (bind(fd, (struct sockaddr *)&inaddr, sizeof(inaddr)) < 0)
734    {
735 #ifdef _WIN32
736       errno = WSAGetLastError();
737       if (errno == WSAEADDRINUSE)
738 #else
739       if (errno == EADDRINUSE)
740 #endif
741       {
742          close_socket(fd);
743          return(-3);
744       }
745       else
746       {
747          close_socket(fd);
748          return(-1);
749       }
750    }
751
752    while (listen(fd, MAX_LISTEN_BACKLOG) == -1)
753    {
754       if (errno != EINTR)
755       {
756          return(-1);
757       }
758    }
759
760    *pfd = fd;
761    return 0;
762
763 }
764
765
766 /*********************************************************************
767  *
768  * Function    :  get_host_information
769  *
770  * Description :  Determines the IP address the client used to
771  *                reach us and the hostname associated with it.
772  *
773  *                XXX: Most of the code has been copy and pasted
774  *                from accept_connection() and not all of the
775  *                ifdefs paths have been tested afterwards.
776  *
777  * Parameters  :
778  *          1  :  afd = File descriptor returned from accept().
779  *          2  :  ip_address = Pointer to return the pointer to
780  *                             the ip address string.
781  *          3  :  hostname =   Pointer to return the pointer to
782  *                             the hostname or NULL if the caller
783  *                             isn't interested in it.
784  *
785  * Returns     :  void.
786  *
787  *********************************************************************/
788 void get_host_information(jb_socket afd, char **ip_address, char **hostname)
789 {
790    struct sockaddr_in server;
791    struct hostent *host = NULL;
792 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
793    /* according to accept_connection() this fixes a warning. */
794    int s_length;
795 #else
796    socklen_t s_length;
797 #endif
798 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS) ||  defined(HAVE_GETHOSTBYADDR_R_7_ARGS) || defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
799    struct hostent result;
800 #if defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
801    struct hostent_data hdata;
802 #else
803    char hbuf[HOSTENT_BUFFER_SIZE];
804    int thd_err;
805 #endif /* def HAVE_GETHOSTBYADDR_R_5_ARGS */
806 #endif /* def HAVE_GETHOSTBYADDR_R_(8|7|5)_ARGS */
807    s_length = sizeof(server);
808
809    if (NULL != hostname)
810    {
811       *hostname = NULL;
812    }
813    *ip_address = NULL;
814
815    if (!getsockname(afd, (struct sockaddr *) &server, &s_length))
816    {
817       *ip_address = strdup(inet_ntoa(server.sin_addr));
818
819       if (NULL == hostname)
820       {
821          /*
822           * We're done here, the caller isn't
823           * interested in knowing the hostname.
824           */
825          return;
826       }
827 #if defined(HAVE_GETHOSTBYADDR_R_8_ARGS)
828       gethostbyaddr_r((const char *)&server.sin_addr,
829                       sizeof(server.sin_addr), AF_INET,
830                       &result, hbuf, HOSTENT_BUFFER_SIZE,
831                       &host, &thd_err);
832 #elif defined(HAVE_GETHOSTBYADDR_R_7_ARGS)
833       host = gethostbyaddr_r((const char *)&server.sin_addr,
834                       sizeof(server.sin_addr), AF_INET,
835                       &result, hbuf, HOSTENT_BUFFER_SIZE, &thd_err);
836 #elif defined(HAVE_GETHOSTBYADDR_R_5_ARGS)
837       if (0 == gethostbyaddr_r((const char *)&server.sin_addr,
838                                sizeof(server.sin_addr), AF_INET,
839                                &result, &hdata))
840       {
841          host = &result;
842       }
843       else
844       {
845          host = NULL;
846       }
847 #elif FEATURE_PTHREAD
848       privoxy_mutex_lock(&resolver_mutex);
849       host = gethostbyaddr((const char *)&server.sin_addr, 
850                            sizeof(server.sin_addr), AF_INET);
851       privoxy_mutex_unlock(&resolver_mutex);
852 #else
853       host = gethostbyaddr((const char *)&server.sin_addr, 
854                            sizeof(server.sin_addr), AF_INET);
855 #endif
856       if (host == NULL)
857       {
858          log_error(LOG_LEVEL_ERROR, "Unable to get my own hostname: %E\n");
859       }
860       else
861       {
862          *hostname = strdup(host->h_name);
863       }
864    }
865
866    return;
867 }
868
869
870 /*********************************************************************
871  *
872  * Function    :  accept_connection
873  *
874  * Description :  Accepts a connection on a socket.  Socket must have
875  *                been created using bind_port().
876  *
877  * Parameters  :
878  *          1  :  csp = Client state, cfd, ip_addr_str, and 
879  *                ip_addr_long will be set by this routine.
880  *          2  :  fd  = file descriptor returned from bind_port
881  *
882  * Returns     :  when a connection is accepted, it returns 1 (TRUE).
883  *                On an error it returns 0 (FALSE).
884  *
885  *********************************************************************/
886 int accept_connection(struct client_state * csp, jb_socket fd)
887 {
888    struct sockaddr_in client;
889    jb_socket afd;
890 #if defined(_WIN32) || defined(__OS2__) || defined(__APPLE_CC__) || defined(AMIGA)
891    /* Wierdness - fix a warning. */
892    int c_length;
893 #else
894    socklen_t c_length;
895 #endif
896
897    c_length = sizeof(client);
898
899 #ifdef _WIN32
900    afd = accept (fd, (struct sockaddr *) &client, &c_length);
901    if (afd == JB_INVALID_SOCKET)
902    {
903       return 0;
904    }
905 #else
906    do
907    {
908       afd = accept (fd, (struct sockaddr *) &client, &c_length);
909    } while (afd < 1 && errno == EINTR);
910    if (afd < 0)
911    {
912       return 0;
913    }
914 #endif
915
916    csp->cfd = afd;
917    csp->ip_addr_str  = strdup(inet_ntoa(client.sin_addr));
918    csp->ip_addr_long = ntohl(client.sin_addr.s_addr);
919
920    return 1;
921
922 }
923
924
925 /*********************************************************************
926  *
927  * Function    :  resolve_hostname_to_ip
928  *
929  * Description :  Resolve a hostname to an internet tcp/ip address.
930  *                NULL or an empty string resolve to INADDR_ANY.
931  *
932  * Parameters  :
933  *          1  :  host = hostname to resolve
934  *
935  * Returns     :  INADDR_NONE => failure, INADDR_ANY or tcp/ip address if succesful.
936  *
937  *********************************************************************/
938 unsigned long resolve_hostname_to_ip(const char *host)
939 {
940    struct sockaddr_in inaddr;
941    struct hostent *hostp;
942    unsigned int dns_retries = 0;
943 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS) || defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
944    struct hostent result;
945 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS) || defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
946    char hbuf[HOSTENT_BUFFER_SIZE];
947    int thd_err;
948 #else /* defined(HAVE_GETHOSTBYNAME_R_3_ARGS) */
949    struct hostent_data hdata;
950 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5)_ARGS */
951 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
952
953    if ((host == NULL) || (*host == '\0'))
954    {
955       return(INADDR_ANY);
956    }
957
958    memset((char *) &inaddr, 0, sizeof inaddr);
959
960    if ((inaddr.sin_addr.s_addr = inet_addr(host)) == -1)
961    {
962 #if defined(HAVE_GETHOSTBYNAME_R_6_ARGS)
963       while (gethostbyname_r(host, &result, hbuf,
964                 HOSTENT_BUFFER_SIZE, &hostp, &thd_err)
965              && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
966       {   
967          log_error(LOG_LEVEL_ERROR,
968             "Timeout #%u while trying to resolve %s. Trying again.",
969             dns_retries, host);
970       }
971 #elif defined(HAVE_GETHOSTBYNAME_R_5_ARGS)
972       while (NULL == (hostp = gethostbyname_r(host, &result,
973                                  hbuf, HOSTENT_BUFFER_SIZE, &thd_err))
974              && (thd_err == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
975       {   
976          log_error(LOG_LEVEL_ERROR,
977             "Timeout #%u while trying to resolve %s. Trying again.",
978             dns_retries, host);
979       }
980 #elif defined(HAVE_GETHOSTBYNAME_R_3_ARGS)
981       /*
982        * XXX: Doesn't retry in case of soft errors.
983        * Does this gethostbyname_r version set h_errno?
984        */
985       if (0 == gethostbyname_r(host, &result, &hdata))
986       {
987          hostp = &result;
988       }
989       else
990       {
991          hostp = NULL;
992       }
993 #elif FEATURE_PTHREAD
994       privoxy_mutex_lock(&resolver_mutex);
995       while (NULL == (hostp = gethostbyname(host))
996              && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
997       {   
998          log_error(LOG_LEVEL_ERROR,
999             "Timeout #%u while trying to resolve %s. Trying again.",
1000             dns_retries, host);
1001       }
1002       privoxy_mutex_unlock(&resolver_mutex);
1003 #else
1004       while (NULL == (hostp = gethostbyname(host))
1005              && (h_errno == TRY_AGAIN) && (dns_retries++ < MAX_DNS_RETRIES))
1006       {
1007          log_error(LOG_LEVEL_ERROR,
1008             "Timeout #%u while trying to resolve %s. Trying again.",
1009             dns_retries, host);
1010       }
1011 #endif /* def HAVE_GETHOSTBYNAME_R_(6|5|3)_ARGS */
1012       /*
1013        * On Mac OSX, if a domain exists but doesn't have a type A
1014        * record associated with it, the h_addr member of the struct
1015        * hostent returned by gethostbyname is NULL, even if h_length
1016        * is 4. Therefore the second test below.
1017        */
1018       if (hostp == NULL || hostp->h_addr == NULL)
1019       {
1020          errno = EINVAL;
1021          log_error(LOG_LEVEL_ERROR, "could not resolve hostname %s", host);
1022          return(INADDR_NONE);
1023       }
1024       if (hostp->h_addrtype != AF_INET)
1025       {
1026 #ifdef _WIN32
1027          errno = WSAEPROTOTYPE;
1028 #else
1029          errno = EPROTOTYPE;
1030 #endif 
1031          log_error(LOG_LEVEL_ERROR, "hostname %s resolves to unknown address type.", host);
1032          return(INADDR_NONE);
1033       }
1034       memcpy(
1035          (char *) &inaddr.sin_addr,
1036          (char *) hostp->h_addr,
1037          sizeof(inaddr.sin_addr)
1038       );
1039    }
1040    return(inaddr.sin_addr.s_addr);
1041
1042 }
1043
1044
1045 /*
1046   Local Variables:
1047   tab-width: 3
1048   end:
1049 */