citadel/clientsocket.c

   1 /*
   2  * $Id$
   3  *
   4  * This module handles client-side sockets opened by the Citadel server (for
   5  * the client side of Internet protocols, etc.)   It does _not_ handle client
   6  * sockets for the Citadel client; for that you must look in ipc_c_tcp.c
   7  * (which, uncoincidentally, bears a striking similarity to this file).
   8  *
   9  * Copyright (c) 1987-2009 by the citadel.org team
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 3 of the License, or
  14  *  (at your option) any later version.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program; if not, write to the Free Software
  23  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  24  */
  25
  26 #include "sysdep.h"
  27 #include <stdlib.h>
  28 #include <unistd.h>
  29 #include <stdio.h>
  30 #include <signal.h>
  31 #include <sys/types.h>
  32 #include <sys/time.h>
  33 #include <sys/socket.h>
  34 #include <netinet/in.h>
  35 #include <arpa/inet.h>
  36 #include <netdb.h>
  37 #include <string.h>
  38 #include <pwd.h>
  39 #include <errno.h>
  40 #include <stdarg.h>
  41 #include <libcitadel.h>
  42 #include "citadel.h"
  43 #include "server.h"
  44 #ifndef HAVE_SNPRINTF
  45 #include "snprintf.h"
  46 #endif
  47 #include "sysdep_decls.h"
  48 #include "config.h"
  49 #include "clientsocket.h"
  50
  51 #include "ctdl_module.h"
  52
  53 #ifndef INADDR_NONE
  54 #define INADDR_NONE 0xffffffff
  55 #endif
  56
  57 int sock_connect(char *host, char *service, char *protocol)
  58 {
  59         struct hostent *phe;
  60         struct servent *pse;
  61         struct protoent *ppe;
  62         struct sockaddr_in sin;
  63         struct sockaddr_in egress_sin;
  64         int s, type;
  65
  66         if ((host == NULL) || IsEmptyStr(host))
  67                 return(-1);
  68         if ((service == NULL) || IsEmptyStr(service))
  69                 return(-1);
  70         if ((protocol == NULL) || IsEmptyStr(protocol))
  71                 return(-1);
  72
  73         memset(&sin, 0, sizeof(sin));
  74         sin.sin_family = AF_INET;
  75
  76         pse = getservbyname(service, protocol);
  77         if (pse) {
  78                 sin.sin_port = pse->s_port;
  79         } else if ((sin.sin_port = htons((u_short) atoi(service))) == 0) {
  80                 CtdlLogPrintf(CTDL_CRIT, "Can't get %s service entry: %s\n",
  81                         service, strerror(errno));
  82                 return(-1);
  83         }
  84         phe = gethostbyname(host);
  85         if (phe) {
  86                 memcpy(&sin.sin_addr, phe->h_addr, phe->h_length);
  87         } else if ((sin.sin_addr.s_addr = inet_addr(host)) == INADDR_NONE) {
  88                 CtdlLogPrintf(CTDL_ERR, "Can't get %s host entry: %s\n",
  89                         host, strerror(errno));
  90                 return(-1);
  91         }
  92         if ((ppe = getprotobyname(protocol)) == 0) {
  93                 CtdlLogPrintf(CTDL_CRIT, "Can't get %s protocol entry: %s\n",
  94                         protocol, strerror(errno));
  95                 return(-1);
  96         }
  97         if (!strcmp(protocol, "udp")) {
  98                 type = SOCK_DGRAM;
  99         } else {
 100                 type = SOCK_STREAM;
 101         }
 102
 103         s = socket(PF_INET, type, ppe->p_proto);
 104         if (s < 0) {
 105                 CtdlLogPrintf(CTDL_CRIT, "Can't create socket: %s\n", strerror(errno));
 106                 return(-1);
 107         }
 108
 109         /* If citserver is bound to a specific IP address on the host, make
 110          * sure we use that address for outbound connections.
 111          */
 112         memset(&egress_sin, 0, sizeof(egress_sin));
 113         egress_sin.sin_family = AF_INET;
 114         if (!IsEmptyStr(config.c_ip_addr)) {
 115                 egress_sin.sin_addr.s_addr = inet_addr(config.c_ip_addr);
 116                 if (egress_sin.sin_addr.s_addr == !INADDR_ANY) {
 117                         egress_sin.sin_addr.s_addr = INADDR_ANY;
 118                 }
 119
 120                 /* If this bind fails, no problem; we can still use INADDR_ANY */
 121                 bind(s, (struct sockaddr *)&egress_sin, sizeof(egress_sin));
 122         }
 123
 124         /* Now try to connect to the remote host. */
 125         if (connect(s, (struct sockaddr *) &sin, sizeof(sin)) < 0) {
 126                 CtdlLogPrintf(CTDL_ERR, "Can't connect to %s:%s: %s\n",
 127                         host, service, strerror(errno));
 128                 close(s);
 129                 return(-1);
 130         }
 131
 132         return (s);
 133 }
 134
 135
 136
 137 /*
 138  * sock_read_to() - input binary data from socket, with a settable timeout.
 139  * Returns the number of bytes read, or -1 for error.
 140  * If keep_reading_until_full is nonzero, we keep reading until we get the number of requested bytes
 141  */
 142 int sock_read_to(int sock, char *buf, int bytes, int timeout, int keep_reading_until_full)
 143 {
 144         int len,rlen;
 145         fd_set rfds;
 146         struct timeval tv;
 147         int retval;
 148
 149         len = 0;
 150         while (len<bytes) {
 151                 FD_ZERO(&rfds);
 152                 FD_SET(sock, &rfds);
 153                 tv.tv_sec = timeout;
 154                 tv.tv_usec = 0;
 155
 156                 retval = select(sock+1, &rfds, NULL, NULL, &tv);
 157
 158                 if (FD_ISSET(sock, &rfds) == 0) {       /* timed out */
 159                         CtdlLogPrintf(CTDL_ERR, "sock_read() timed out.\n");
 160                         return(-1);
 161                 }
 162
 163                 rlen = read(sock, &buf[len], bytes-len);
 164                 if (rlen<1) {
 165                         CtdlLogPrintf(CTDL_ERR, "sock_read() failed: %s\n",
 166                                 strerror(errno));
 167                         return(-1);
 168                 }
 169                 len = len + rlen;
 170                 if (!keep_reading_until_full) return(len);
 171         }
 172         return(bytes);
 173 }
 174
 175
 176 /*
 177  * sock_read() - input binary data from socket.
 178  * Returns the number of bytes read, or -1 for error.
 179  */
 180 INLINE int sock_read(int sock, char *buf, int bytes, int keep_reading_until_full)
 181 {
 182         return sock_read_to(sock, buf, bytes, CLIENT_TIMEOUT, keep_reading_until_full);
 183 }
 184
 185
 186 /*
 187  * sock_write() - send binary to server.
 188  * Returns the number of bytes written, or -1 for error.
 189  */
 190 int sock_write(int sock, char *buf, int nbytes)
 191 {
 192         int bytes_written = 0;
 193         int retval;
 194         while (bytes_written < nbytes) {
 195                 retval = write(sock, &buf[bytes_written],
 196                                nbytes - bytes_written);
 197                 if (retval < 1) {
 198                         return (-1);
 199                 }
 200                 bytes_written = bytes_written + retval;
 201         }
 202         return (bytes_written);
 203 }
 204
 205
 206
 207 /*
 208  * Input string from socket - implemented in terms of sock_read()
 209  *
 210  */
 211 int sock_getln(int sock, char *buf, int bufsize)
 212 {
 213         int i;
 214
 215         /* Read one character at a time.
 216          */
 217         for (i = 0;; i++) {
 218                 if (sock_read(sock, &buf[i], 1, 1) < 0) return(-1);
 219                 if (buf[i] == '\n' || i == (bufsize-1))
 220                         break;
 221         }
 222
 223         /* If we got a long line, discard characters until the newline.
 224          */
 225         if (i == (bufsize-1))
 226                 while (buf[i] != '\n')
 227                         if (sock_read(sock, &buf[i], 1, 1) < 0) return(-1);
 228
 229         /* Strip any trailing CR and LF characters.
 230          */
 231         buf[i] = 0;
 232         while ( (i > 0)
 233                 && ( (buf[i - 1]==13)
 234                      || ( buf[i - 1]==10)) ) {
 235                 i--;
 236                 buf[i] = 0;
 237         }
 238         return(i);
 239 }
 240
 241 /*
 242  * Multiline version of sock_gets() ... this is a convenience function for
 243  * client side protocol implementations.  It only returns the first line of
 244  * a multiline response, discarding the rest.
 245  */
 246 int ml_sock_gets(int sock, char *buf) {
 247         char bigbuf[1024];
 248         int g;
 249
 250         g = sock_getln(sock, buf, SIZ);
 251         if (g < 4) return(g);
 252         if (buf[3] != '-') return(g);
 253
 254         do {
 255                 g = sock_getln(sock, bigbuf, SIZ);
 256                 if (g < 0) return(g);
 257         } while ( (g >= 4) && (bigbuf[3] == '-') );
 258
 259         return(strlen(buf));
 260 }
 261
 262
 263 /*
 264  * sock_puts() - send line to server - implemented in terms of serv_write()
 265  * Returns the number of bytes written, or -1 for error.
 266  */
 267 int sock_puts(int sock, char *buf)
 268 {
 269         int i, j;
 270
 271         i = sock_write(sock, buf, strlen(buf));
 272         if (i<0) return(i);
 273         j = sock_write(sock, "\n", 1);
 274         if (j<0) return(j);
 275         return(i+j);
 276 }