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).
9 * Copyright (c) 1987-2010 by the citadel.org team
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.
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.
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
31 #include <sys/types.h>
33 #include <sys/socket.h>
34 #include <netinet/in.h>
35 #include <arpa/inet.h>
41 #include <libcitadel.h>
47 #include "sysdep_decls.h"
49 #include "clientsocket.h"
50 #include "ctdl_module.h"
52 int sock_connect(char *host, char *service)
54 struct in6_addr serveraddr;
55 struct addrinfo hints;
56 struct addrinfo *res = NULL;
57 struct addrinfo *ai = NULL;
61 if ((host == NULL) || IsEmptyStr(host))
63 if ((service == NULL) || IsEmptyStr(service))
66 memset(&hints, 0x00, sizeof(hints));
67 hints.ai_flags = AI_NUMERICSERV;
68 hints.ai_family = AF_UNSPEC;
69 hints.ai_socktype = SOCK_STREAM;
72 * Handle numeric IPv4 and IPv6 addresses
74 rc = inet_pton(AF_INET, host, &serveraddr);
75 if (rc == 1) { /* dotted quad */
76 hints.ai_family = AF_INET;
77 hints.ai_flags |= AI_NUMERICHOST;
79 rc = inet_pton(AF_INET6, host, &serveraddr);
80 if (rc == 1) { /* IPv6 address */
81 hints.ai_family = AF_INET6;
82 hints.ai_flags |= AI_NUMERICHOST;
86 /* Begin the connection process */
88 rc = getaddrinfo(host, service, &hints, &res);
90 CtdlLogPrintf(CTDL_ERR, "%s: %s\n", host, gai_strerror(rc));
95 * Try all available addresses until we connect to one or until we run out.
97 for (ai = res; ai != NULL; ai = ai->ai_next) {
98 sock = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol);
100 CtdlLogPrintf(CTDL_ERR, "socket() failed: %s\n", strerror(errno));
103 rc = connect(sock, res->ai_addr, res->ai_addrlen);
108 CtdlLogPrintf(CTDL_ERR, "connect() failed: %s\n", strerror(errno));
119 * Read data from the client socket.
121 * sock socket fd to read from
122 * buf buffer to read into
123 * bytes number of bytes to read
124 * timeout Number of seconds to wait before timing out
126 * Possible return values:
127 * 1 Requested number of bytes has been read.
128 * 0 Request timed out.
129 * -1 Connection is broken, or other error.
131 int socket_read_blob(int *Socket, StrBuf * Target, int bytes, int timeout)
133 CitContext *CCC = MyContext();
138 retval = StrBufReadBLOBBuffered(Target,
141 Socket, 1, bytes, O_TERM, &Error);
143 CtdlLogPrintf(CTDL_CRIT,
144 "%s failed: %s\n", __FUNCTION__, Error);
150 int sock_read_to(int *sock, char *buf, int bytes, int timeout,
151 int keep_reading_until_full)
153 CitContext *CCC = MyContext();
156 FlushStrBuf(CCC->MigrateBuf);
157 rc = socket_read_blob(sock, CCC->sMigrateBuf, bytes, timeout);
162 if (StrLength(CCC->MigrateBuf) < bytes)
163 bytes = StrLength(CCC->MigrateBuf);
164 memcpy(buf, ChrPtr(CCC->MigrateBuf), bytes);
166 FlushStrBuf(CCC->MigrateBuf);
172 int CtdlSockGetLine(int *sock, StrBuf * Target)
174 CitContext *CCC = MyContext();
179 rc = StrBufTCP_read_buffered_line_fast(Target,
183 if ((rc < 0) && (Error != NULL))
184 CtdlLogPrintf(CTDL_CRIT,
185 "%s failed: %s\n", __FUNCTION__, Error);
191 * client_getln() ... Get a LF-terminated line of text from the client.
192 * (This is implemented in terms of client_read() and could be
193 * justifiably moved out of sysdep.c)
195 int sock_getln(int *sock, char *buf, int bufsize)
198 CitContext *CCC = MyContext();
201 FlushStrBuf(CCC->sMigrateBuf);
202 retval = CtdlSockGetLine(sock, CCC->sMigrateBuf);
204 i = StrLength(CCC->sMigrateBuf);
205 pCh = ChrPtr(CCC->sMigrateBuf);
206 /* Strip the trailing LF, and the trailing CR if present.
211 && ((pCh[i - 1] == 13)
212 || (pCh[i - 1] == 10))) {
218 FlushStrBuf(CCC->sMigrateBuf);
220 safestrncpy(&buf[i], "000", bufsize - i);
228 * sock_read() - input binary data from socket.
229 * Returns the number of bytes read, or -1 for error.
231 INLINE int sock_read(int *sock, char *buf, int bytes,
232 int keep_reading_until_full)
234 return sock_read_to(sock, buf, bytes, CLIENT_TIMEOUT,
235 keep_reading_until_full);
240 * sock_write() - send binary to server.
241 * Returns the number of bytes written, or -1 for error.
243 int sock_write(int *sock, const char *buf, int nbytes)
245 int bytes_written = 0;
248 while ((*sock != -1) && (bytes_written < nbytes)) {
249 retval = write(*sock, &buf[bytes_written],
250 nbytes - bytes_written);
256 bytes_written = bytes_written + retval;
258 return (bytes_written);
263 * Multiline version of sock_gets() ... this is a convenience function for
264 * client side protocol implementations. It only returns the first line of
265 * a multiline response, discarding the rest.
267 int ml_sock_gets(int *sock, char *buf)
272 g = sock_getln(sock, buf, SIZ);
279 g = sock_getln(sock, bigbuf, SIZ);
282 } while ((g >= 4) && (bigbuf[3] == '-'));
284 return (strlen(buf));
289 * sock_puts() - send line to server - implemented in terms of serv_write()
290 * Returns the number of bytes written, or -1 for error.
292 int sock_puts(int *sock, char *buf)
296 i = sock_write(sock, buf, strlen(buf));
299 j = sock_write(sock, "\n", 1);