Began removing $Id$ tags. This will be an ongoing process.
[citadel.git] / citadel / clientsocket.c
index 3c5e94caf928db5dd84bb3ce5bbc7a604784f722..1f66a261bab66bcb72c46c6d2a30e8f86ba7b17a 100644 (file)
@@ -1,11 +1,24 @@
 /*
- * $Id$
- *
  * This module handles client-side sockets opened by the Citadel server (for
  * the client side of Internet protocols, etc.)   It does _not_ handle client
  * sockets for the Citadel client; for that you must look in ipc_c_tcp.c
  * (which, uncoincidentally, bears a striking similarity to this file).
  *
+ * Copyright (c) 1987-2010 by the citadel.org team
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #include "sysdep.h"
@@ -14,6 +27,7 @@
 #include <stdio.h>
 #include <signal.h>
 #include <sys/types.h>
+#include <sys/time.h>
 #include <sys/socket.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
 #include <pwd.h>
 #include <errno.h>
 #include <stdarg.h>
+#include <libcitadel.h>
 #include "citadel.h"
+#include "server.h"
 #ifndef HAVE_SNPRINTF
 #include "snprintf.h"
 #endif
 #include "sysdep_decls.h"
+#include "config.h"
+#include "clientsocket.h"
+#include "ctdl_module.h"
 
-#ifndef INADDR_NONE
-#define INADDR_NONE 0xffffffff
-#endif
-
-int sock_connect(char *host, char *service, char *protocol)
+int sock_connect(char *host, char *service)
 {
-       struct hostent *phe;
-       struct servent *pse;
-       struct protoent *ppe;
-       struct sockaddr_in sin;
-       int s, type;
-
-       memset(&sin, 0, sizeof(sin));
-       sin.sin_family = AF_INET;
-
-       pse = getservbyname(service, protocol);
-       if (pse) {
-               sin.sin_port = pse->s_port;
-       } else if ((sin.sin_port = htons((u_short) atoi(service))) == 0) {
-               lprintf(3, "Can't get %s service entry: %s\n",
-                       service, strerror(errno));
-               return(-1);
-       }
-       phe = gethostbyname(host);
-       if (phe) {
-               memcpy(&sin.sin_addr, phe->h_addr, phe->h_length);
-       } else if ((sin.sin_addr.s_addr = inet_addr(host)) == INADDR_NONE) {
-               lprintf(3, "Can't get %s host entry: %s\n",
-                       host, strerror(errno));
-               return(-1);
-       }
-       if ((ppe = getprotobyname(protocol)) == 0) {
-               lprintf(3, "Can't get %s protocol entry: %s\n",
-                       protocol, strerror(errno));
-               return(-1);
-       }
-       if (!strcmp(protocol, "udp")) {
-               type = SOCK_DGRAM;
+       struct in6_addr serveraddr;
+       struct addrinfo hints;
+       struct addrinfo *res = NULL;
+       struct addrinfo *ai = NULL;
+       int rc = (-1);
+       int sock = (-1);
+
+       if ((host == NULL) || IsEmptyStr(host))
+               return (-1);
+       if ((service == NULL) || IsEmptyStr(service))
+               return (-1);
+
+       memset(&hints, 0x00, sizeof(hints));
+       hints.ai_flags = AI_NUMERICSERV;
+       hints.ai_family = AF_UNSPEC;
+       hints.ai_socktype = SOCK_STREAM;
+
+       /*
+        * Handle numeric IPv4 and IPv6 addresses
+        */
+       rc = inet_pton(AF_INET, host, &serveraddr);
+       if (rc == 1) {                                          /* dotted quad */
+               hints.ai_family = AF_INET;
+               hints.ai_flags |= AI_NUMERICHOST;
        } else {
-               type = SOCK_STREAM;
+               rc = inet_pton(AF_INET6, host, &serveraddr);
+               if (rc == 1) {                                  /* IPv6 address */
+                       hints.ai_family = AF_INET6;
+                       hints.ai_flags |= AI_NUMERICHOST;
+               }
        }
 
-       s = socket(PF_INET, type, ppe->p_proto);
-       if (s < 0) {
-               lprintf(3, "Can't create socket: %s\n", strerror(errno));
+       /* Begin the connection process */
+
+       rc = getaddrinfo(host, service, &hints, &res);
+       if (rc != 0) {
+               CtdlLogPrintf(CTDL_ERR, "%s: %s\n", host, gai_strerror(rc));
                return(-1);
        }
 
-/* FIX ... the alarm clock is a problem for multithreaded programs because all
- * threads receive the signal.
-       signal(SIGALRM, timeout);
-       alarm(30);
+       /*
+        * Try all available addresses until we connect to one or until we run out.
+        */
+       for (ai = res; ai != NULL; ai = ai->ai_next) {
+               sock = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol);
+               if (sock < 0) {
+                       CtdlLogPrintf(CTDL_ERR, "socket() failed: %s\n", strerror(errno));
+                       return(-1);
+               }
+               rc = connect(sock, ai->ai_addr, ai->ai_addrlen);
+               if (rc >= 0) {
+                       return(sock);
+               }
+               else {
+                       CtdlLogPrintf(CTDL_ERR, "connect() failed: %s\n", strerror(errno));
+                       close(sock);
+               }
+       }
+
+       return(-1);
+}
+
+
+
+/*
+ * Read data from the client socket.
+ *
+ * sock                socket fd to read from
+ * buf         buffer to read into 
+ * bytes       number of bytes to read
+ * timeout     Number of seconds to wait before timing out
+ *
+ * Possible return values:
+ *      1       Requested number of bytes has been read.
+ *      0       Request timed out.
+ *     -1      Connection is broken, or other error.
  */
+int socket_read_blob(int *Socket, StrBuf * Target, int bytes, int timeout)
+{
+       CitContext *CCC = MyContext();
+       const char *Error;
+       int retval = 0;
 
-       if (connect(s, (struct sockaddr *) &sin, sizeof(sin)) < 0) {
-               lprintf(3, "can't connect to %s.%s: %s\n",
-                       host, service, strerror(errno));
-               return(-1);
+
+       retval = StrBufReadBLOBBuffered(Target,
+                                       CCC->sReadBuf,
+                                       &CCC->sPos,
+                                       Socket, 1, bytes, O_TERM, &Error);
+       if (retval < 0) {
+               CtdlLogPrintf(CTDL_CRIT,
+                             "%s failed: %s\n", __FUNCTION__, Error);
        }
+       return retval;
+}
+
+
+int sock_read_to(int *sock, char *buf, int bytes, int timeout,
+                int keep_reading_until_full)
+{
+       CitContext *CCC = MyContext();
+       int rc;
+
+       FlushStrBuf(CCC->MigrateBuf);
+       rc = socket_read_blob(sock, CCC->sMigrateBuf, bytes, timeout);
+       if (rc < 0) {
+               *buf = '\0';
+               return rc;
+       } else {
+               if (StrLength(CCC->MigrateBuf) < bytes)
+                       bytes = StrLength(CCC->MigrateBuf);
+               memcpy(buf, ChrPtr(CCC->MigrateBuf), bytes);
+
+               FlushStrBuf(CCC->MigrateBuf);
+               return rc;
+       }
+}
+
+
+int CtdlSockGetLine(int *sock, StrBuf * Target)
+{
+       CitContext *CCC = MyContext();
+       const char *Error;
+       int rc;
+
+       FlushStrBuf(Target);
+       rc = StrBufTCP_read_buffered_line_fast(Target,
+                                              CCC->sReadBuf,
+                                              &CCC->sPos,
+                                              sock, 5, 1, &Error);
+       if ((rc < 0) && (Error != NULL))
+               CtdlLogPrintf(CTDL_CRIT,
+                             "%s failed: %s\n", __FUNCTION__, Error);
+       return rc;
+}
+
+
 /*
-       alarm(0);
-       signal(SIGALRM, SIG_IGN);
+ * client_getln()   ...   Get a LF-terminated line of text from the client.
+ * (This is implemented in terms of client_read() and could be
+ * justifiably moved out of sysdep.c)
  */
+int sock_getln(int *sock, char *buf, int bufsize)
+{
+       int i, retval;
+       CitContext *CCC = MyContext();
+       const char *pCh;
+
+       FlushStrBuf(CCC->sMigrateBuf);
+       retval = CtdlSockGetLine(sock, CCC->sMigrateBuf);
 
-       return (s);
+       i = StrLength(CCC->sMigrateBuf);
+       pCh = ChrPtr(CCC->sMigrateBuf);
+       /* Strip the trailing LF, and the trailing CR if present.
+        */
+       if (bufsize <= i)
+               i = bufsize - 1;
+       while ((i > 0)
+              && ((pCh[i - 1] == 13)
+                  || (pCh[i - 1] == 10))) {
+               i--;
+       }
+       memcpy(buf, pCh, i);
+       buf[i] = 0;
+
+       FlushStrBuf(CCC->sMigrateBuf);
+       if (retval < 0) {
+               safestrncpy(&buf[i], "000", bufsize - i);
+               i += 3;
+       }
+       return i;
 }
 
+
 /*
  * sock_read() - input binary data from socket.
  * Returns the number of bytes read, or -1 for error.
  */
-int sock_read(int sock, char *buf, int bytes)
+INLINE int sock_read(int *sock, char *buf, int bytes,
+                    int keep_reading_until_full)
 {
-       int len, rlen;
-
-       len = 0;
-       while (len < bytes) {
-               rlen = read(sock, &buf[len], bytes - len);
-               if (rlen < 1) {
-                       return (-1);
-               }
-               len = len + rlen;
-       }
-       return (len);
+       return sock_read_to(sock, buf, bytes, CLIENT_TIMEOUT,
+                           keep_reading_until_full);
 }
 
 
@@ -119,14 +238,17 @@ int sock_read(int sock, char *buf, int bytes)
  * sock_write() - send binary to server.
  * Returns the number of bytes written, or -1 for error.
  */
-int sock_write(int sock, char *buf, int nbytes)
+int sock_write(int *sock, const char *buf, int nbytes)
 {
        int bytes_written = 0;
        int retval;
-       while (bytes_written < nbytes) {
-               retval = write(sock, &buf[bytes_written],
+
+       while ((*sock != -1) && (bytes_written < nbytes)) {
+               retval = write(*sock, &buf[bytes_written],
                               nbytes - bytes_written);
                if (retval < 1) {
+                       sock_close(*sock);
+                       *sock = -1;
                        return (-1);
                }
                bytes_written = bytes_written + retval;
@@ -136,36 +258,28 @@ int sock_write(int sock, char *buf, int nbytes)
 
 
 /*
- * Input string from socket - implemented in terms of sock_read()
- * 
+ * Multiline version of sock_gets() ... this is a convenience function for
+ * client side protocol implementations.  It only returns the first line of
+ * a multiline response, discarding the rest.
  */
-int sock_gets(int sock, char *buf)
+int ml_sock_gets(int *sock, char *buf)
 {
-       int i;
+       char bigbuf[1024];
+       int g;
 
-       /* Read one character at a time.
-        */
-       for (i = 0;; i++) {
-               if (sock_read(sock, &buf[i], 1) < 0) return(-1);
-               if (buf[i] == '\n' || i == 255)
-                       break;
-       }
+       g = sock_getln(sock, buf, SIZ);
+       if (g < 4)
+               return (g);
+       if (buf[3] != '-')
+               return (g);
 
-       /* If we got a long line, discard characters until the newline.
-        */
-       if (i == 255)
-               while (buf[i] != '\n')
-                       if (sock_read(sock, &buf[i], 1) < 0) return(-1);
+       do {
+               g = sock_getln(sock, bigbuf, SIZ);
+               if (g < 0)
+                       return (g);
+       } while ((g >= 4) && (bigbuf[3] == '-'));
 
-       /* Strip any trailing CR and LF characters.
-        */
-       buf[i] = 0;
-       while ( (strlen(buf)>0)
-             && ((buf[strlen(buf)-1]==13)
-             || (buf[strlen(buf)-1]==10)) ) {
-               buf[strlen(buf)-1] = 0;
-       }
-       return(strlen(buf));
+       return (strlen(buf));
 }
 
 
@@ -173,13 +287,15 @@ int sock_gets(int sock, char *buf)
  * sock_puts() - send line to server - implemented in terms of serv_write()
  * Returns the number of bytes written, or -1 for error.
  */
-int sock_puts(int sock, char *buf)
+int sock_puts(int *sock, char *buf)
 {
        int i, j;
 
        i = sock_write(sock, buf, strlen(buf));
-       if (i<0) return(i);
+       if (i < 0)
+               return (i);
        j = sock_write(sock, "\n", 1);
-       if (j<0) return(j);
-       return(i+j);
+       if (j < 0)
+               return (j);
+       return (i + j);
 }