* Doxygen groups. Sorted the files into groups. so now we have a nice structure
[citadel.git] / webcit / tcp_sockets.c
index c6c58f236d2d4edb8b17fc37798e523bac2d5971..37d538c370865b367d9a595f35afaf8568755552 100644 (file)
 /*
- * tcp_sockets.c
- * 
- * TCP socket module for WebCit
- *
  * $Id$
  */
+/** 
+ * \defgroup TcpSockets TCP client socket module for WebCit
+ * \ingroup CitadelCommunitacion
+ */
+/*@{*/
+
+/*
+ * Uncomment this to log all communications with the Citadel server
+#define SERV_TRACE 1
+ */
 
-#include <stdlib.h>
-#include <unistd.h>
-#include <stdio.h>
-#include <signal.h>
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <netinet/in.h>
-#include <arpa/inet.h>
-#include <netdb.h>
-#include <string.h>
-#include <stdarg.h>
 #include "webcit.h"
+#include "webserver.h"
 
-char server_is_local = 0;
+/**
+ * \brief register the timeout
+ * \param signum signalhandler number
+ * \return signals
+ */
+RETSIGTYPE timeout(int signum)
+{
+       lprintf(1, "Connection timed out.\n");
+       exit(3);
+}
 
-#ifndef INADDR_NONE
-#define INADDR_NONE 0xffffffff
-#endif
 
-extern int errno;
+/**
+ * \brief Connect a unix domain socket
+ * \param sockpath where to open a unix domain socket
+ */
+int uds_connectsock(char *sockpath)
+{
+       struct sockaddr_un addr;
+       int s;
 
-int serv_sock;
+       memset(&addr, 0, sizeof(addr));
+       addr.sun_family = AF_UNIX;
+       strncpy(addr.sun_path, sockpath, sizeof addr.sun_path);
 
+       s = socket(AF_UNIX, SOCK_STREAM, 0);
+       if (s < 0) {
+               lprintf(1, "Can't create socket: %s\n",
+                       strerror(errno));
+               return(-1);
+       }
 
-void timeout(int signum) {
-       printf("\rConnection timed out.\n");
-       exit(3);
+       if (connect(s, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
+               lprintf(1, "Can't connect: %s\n",
+                       strerror(errno));
+               close(s);
+               return(-1);
        }
 
-int connectsock(char *host, char *service, char *protocol)
+       return s;
+}
+
+
+/**
+ * \brief Connect a TCP/IP socket
+ * \param host the host to connect to
+ * \param service the service on the host to call
+ */
+int tcp_connectsock(char *host, char *service)
 {
        struct hostent *phe;
        struct servent *pse;
        struct protoent *ppe;
        struct sockaddr_in sin;
-       int s,type;
+       int s;
 
-       bzero((char *)&sin,sizeof(sin));
+       memset(&sin, 0, sizeof(sin));
        sin.sin_family = AF_INET;
 
-       pse=getservbyname(service,protocol);
+       pse = getservbyname(service, "tcp");
        if (pse) {
                sin.sin_port = pse->s_port;
-               }
-       else if ((sin.sin_port = htons((u_short)atoi(service))) == 0) {
-               fprintf(stderr,"can't get %s service entry\n", service);
-               return(-1);
-               }
-       
-       phe=gethostbyname(host);
+       } else if ((sin.sin_port = htons((u_short) atoi(service))) == 0) {
+               lprintf(1, "Can't get %s service entry\n", service);
+               return (-1);
+       }
+       phe = gethostbyname(host);
        if (phe) {
-               bcopy(phe->h_addr,(char *)&sin.sin_addr,phe->h_length);
-               }
-       else if ((sin.sin_addr.s_addr = inet_addr(host))==INADDR_NONE) {
-               fprintf(stderr,"can't get %s host entry: %s\n",
-                       host,strerror(errno));
-               return(-1);
-               }
-
-       if ((ppe=getprotobyname(protocol))==0) {
-               fprintf(stderr,"can't get %s protocol entry: %s\n",
-                       protocol,strerror(errno));
-               return(-1);
-               }
-
-       if (!strcmp(protocol,"udp"))
-               type = SOCK_DGRAM;
-       else
-               type = SOCK_STREAM;
-
-       s = socket(PF_INET,type,ppe->p_proto);
-       if (s<0) {
-               fprintf(stderr,"can't create socket: %s\n",strerror(errno));
-               return(-1);
-               }
-
+               memcpy(&sin.sin_addr, phe->h_addr, phe->h_length);
+       } else if ((sin.sin_addr.s_addr = inet_addr(host)) == INADDR_NONE) {
+               lprintf(1, "Can't get %s host entry: %s\n",
+                       host, strerror(errno));
+               return (-1);
+       }
+       if ((ppe = getprotobyname("tcp")) == 0) {
+               lprintf(1, "Can't get TCP protocol entry: %s\n",
+                       strerror(errno));
+               return (-1);
+       }
 
-       signal(SIGALRM,timeout);
+       s = socket(PF_INET, SOCK_STREAM, ppe->p_proto);
+       if (s < 0) {
+               lprintf(1, "Can't create socket: %s\n", strerror(errno));
+               return (-1);
+       }
+       signal(SIGALRM, timeout);
        alarm(30);
 
-       if (connect(s,(struct sockaddr *)&sin,sizeof(sin))<0) {
-               fprintf(stderr,"can't connect to %s.%s: %s\n",
-                       host,service,strerror(errno));
-               return(-1);
-               }
-
+       if (connect(s, (struct sockaddr *) &sin, sizeof(sin)) < 0) {
+               lprintf(1, "Can't connect to %s.%s: %s\n",
+                       host, service, strerror(errno));
+               close(s);
+               return (-1);
+       }
        alarm(0);
-       signal(SIGALRM,SIG_IGN);
+       signal(SIGALRM, SIG_IGN);
 
-       return(s);
-       }
+       return (s);
+}
 
 
 
 
-/*
- * Input binary data from socket
+/**
+ * \brief Input binary data from socket
+ * \param buf the buffer to get the input to
+ * \param bytes the maximal number of bytes to read
  */
 void serv_read(char *buf, int bytes)
 {
-        int len,rlen;
+       int len, rlen;
 
-        len = 0;
-        while(len<bytes) {
-                rlen = read(serv_sock,&buf[len],bytes-len);
-                if (rlen<1) {
-                        fprintf(stderr, "Server connection broken: %s\n",
+       len = 0;
+       while (len < bytes) {
+               rlen = read(WC->serv_sock, &buf[len], bytes - len);
+               if (rlen < 1) {
+                       lprintf(1, "Server connection broken: %s\n",
                                strerror(errno));
-                        connected = 0;
-                       logged_in = 0;
+                       close(WC->serv_sock);
+                       WC->serv_sock = (-1);
+                       WC->connected = 0;
+                       WC->logged_in = 0;
+                       memset(buf, 0, bytes);
                        return;
-                        }
-                len = len + rlen;
-                }
-        }
+               }
+               len = len + rlen;
+       }
+}
 
 
-/*
- * input string from pipe
+/**
+ * \brief input string from pipe
  */
-void serv_gets(char *strbuf)
+void serv_getln(char *strbuf, int bufsize)
 {
-       int ch,len;
+       int ch, len;
        char buf[2];
 
        len = 0;
-       strcpy(strbuf,"");
+       strbuf[0] = 0;
        do {
                serv_read(&buf[0], 1);
                ch = buf[0];
                strbuf[len++] = ch;
-               } while((ch!=10)&&(ch!=13)&&(ch!=0)&&(len<255));
-       strbuf[len-1] = 0;
-       /* fprintf(stderr, ">%s\n", strbuf); */
-       }
+       } while ((ch != 10) && (ch != 0) && (len < (bufsize-1)));
+       if (strbuf[len-1] == 10) strbuf[--len] = 0;
+       if (strbuf[len-1] == 13) strbuf[--len] = 0;
+#ifdef SERV_TRACE
+       lprintf(9, "%3d>%s\n", WC->serv_sock, strbuf);
+#endif
+}
 
 
 
-/*
- * send binary to server
+/**
+ * \brief send binary to server
+ * \param buf the buffer to write to citadel server
+ * \param nbytes how many bytes to send to citadel server
  */
 void serv_write(char *buf, int nbytes)
 {
-        int bytes_written = 0;
-        int retval;
-        while (bytes_written < nbytes) {
-                retval = write(serv_sock, &buf[bytes_written],
-                        nbytes - bytes_written);
-                if (retval < 1) {
-                        fprintf(stderr, "Server connection broken: %s\n",
+       int bytes_written = 0;
+       int retval;
+       while (bytes_written < nbytes) {
+               retval = write(WC->serv_sock, &buf[bytes_written],
+                              nbytes - bytes_written);
+               if (retval < 1) {
+                       lprintf(1, "Server connection broken: %s\n",
                                strerror(errno));
-                        connected = 0;
-                       logged_in = 0;
+                       close(WC->serv_sock);
+                       WC->serv_sock = (-1);
+                       WC->connected = 0;
+                       WC->logged_in = 0;
                        return;
-                        }
-                bytes_written = bytes_written + retval;
-                }
-        }
+               }
+               bytes_written = bytes_written + retval;
+       }
+}
 
 
-/*
- * send line to server
+/**
+ * \brief send line to server
+ * \param string the line to send to the citadel server
  */
 void serv_puts(char *string)
 {
-       char buf[256];
+       char buf[SIZ];
 
-       sprintf(buf,"%s\n",string);
+#ifdef SERV_TRACE
+       lprintf(9, "%3d<%s\n", WC->serv_sock, string);
+#endif
+       sprintf(buf, "%s\n", string);
        serv_write(buf, strlen(buf));
-       }
+}
 
 
-/*
- * convenience function to send stuff to the server
+/**
+ * \brief convenience function to send stuff to the server
+ * \param format the formatstring
+ * \param ... the entities to insert into format 
  */
-void serv_printf(const char *format, ...) {   
-        va_list arg_ptr;   
-       char buf[256];
+void serv_printf(const char *format,...)
+{
+       va_list arg_ptr;
+       char buf[SIZ];
 
-               va_start(arg_ptr, format);   
-               vsprintf(buf, format, arg_ptr);   
-               va_end(arg_ptr);   
+       va_start(arg_ptr, format);
+       vsnprintf(buf, sizeof buf, format, arg_ptr);
+       va_end(arg_ptr);
 
        strcat(buf, "\n");
        serv_write(buf, strlen(buf));
-       /* fprintf(stderr, "<%s", buf); */
-       }
+#ifdef SERV_TRACE
+       lprintf(9, "<%s", buf);
+#endif
+}
 
 
+/*@}*/