2 * This module handles client-side sockets opened by the Citadel server (for
3 * the client side of Internet protocols, etc.) It does _not_ handle client
4 * sockets for the Citadel client; for that you must look in ipc_c_tcp.c
5 * (which, uncoincidentally, bears a striking similarity to this file).
7 * Copyright (c) 1987-2010 by the citadel.org team
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 #include <sys/types.h>
31 #include <sys/socket.h>
32 #include <netinet/in.h>
33 #include <arpa/inet.h>
39 #include <libcitadel.h>
45 #include "sysdep_decls.h"
47 #include "clientsocket.h"
48 #include "ctdl_module.h"
50 int sock_connect(char *host, char *service)
52 struct in6_addr serveraddr;
53 struct addrinfo hints;
54 struct addrinfo *res = NULL;
55 struct addrinfo *ai = NULL;
59 if ((host == NULL) || IsEmptyStr(host))
61 if ((service == NULL) || IsEmptyStr(service))
64 memset(&hints, 0x00, sizeof(hints));
65 hints.ai_flags = AI_NUMERICSERV;
66 hints.ai_family = AF_UNSPEC;
67 hints.ai_socktype = SOCK_STREAM;
70 * Handle numeric IPv4 and IPv6 addresses
72 rc = inet_pton(AF_INET, host, &serveraddr);
73 if (rc == 1) { /* dotted quad */
74 hints.ai_family = AF_INET;
75 hints.ai_flags |= AI_NUMERICHOST;
77 rc = inet_pton(AF_INET6, host, &serveraddr);
78 if (rc == 1) { /* IPv6 address */
79 hints.ai_family = AF_INET6;
80 hints.ai_flags |= AI_NUMERICHOST;
84 /* Begin the connection process */
86 rc = getaddrinfo(host, service, &hints, &res);
88 CtdlLogPrintf(CTDL_ERR, "%s: %s\n", host, gai_strerror(rc));
93 * Try all available addresses until we connect to one or until we run out.
95 for (ai = res; ai != NULL; ai = ai->ai_next) {
96 sock = socket(ai->ai_family, ai->ai_socktype, ai->ai_protocol);
98 CtdlLogPrintf(CTDL_ERR, "socket() failed: %s\n", strerror(errno));
102 rc = connect(sock, ai->ai_addr, ai->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, int nSec)
174 CitContext *CCC = MyContext();
179 rc = StrBufTCP_read_buffered_line_fast(Target,
182 sock, nSec, 1, &Error);
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, 5);
204 i = StrLength(CCC->sMigrateBuf);
205 pCh = ChrPtr(CCC->sMigrateBuf);
207 memcpy(buf, pCh, i + 1);
209 FlushStrBuf(CCC->sMigrateBuf);
211 safestrncpy(&buf[i], "000", bufsize - i);
219 * sock_read() - input binary data from socket.
220 * Returns the number of bytes read, or -1 for error.
222 INLINE int sock_read(int *sock, char *buf, int bytes,
223 int keep_reading_until_full)
225 return sock_read_to(sock, buf, bytes, CLIENT_TIMEOUT,
226 keep_reading_until_full);
231 * sock_write() - send binary to server.
232 * Returns the number of bytes written, or -1 for error.
234 int sock_write(int *sock, const char *buf, int nbytes)
235 { return sock_write_timeout(sock, buf, nbytes, 50); }
236 int sock_write_timeout(int *sock, const char *buf, int nbytes, int timeout)
238 int nSuccessLess = 0;
239 int bytes_written = 0;
245 int selectresolution = 100;
247 fdflags = fcntl(*sock, F_GETFL);
248 IsNonBlock = (fdflags & O_NONBLOCK) == O_NONBLOCK;
250 while ((nSuccessLess < timeout) &&
252 (bytes_written < nbytes))
255 tv.tv_sec = selectresolution;
259 FD_SET(*sock, &rfds);
260 if (select(*sock + 1, NULL, &rfds, NULL, &tv) == -1) {
261 /// *Error = strerror(errno);
267 if (IsNonBlock && ! FD_ISSET(*sock, &rfds)) {
271 retval = write(*sock, &buf[bytes_written],
272 nbytes - bytes_written);
278 bytes_written = bytes_written + retval;
279 if (IsNonBlock && (bytes_written == nbytes)){
280 tv.tv_sec = selectresolution;
284 FD_SET(*sock, &rfds);
285 if (select(*sock + 1, NULL, &rfds, NULL, &tv) == -1) {
286 /// *Error = strerror(errno);
293 return (bytes_written);
299 * client_getln() ... Get a LF-terminated line of text from the client.
300 * (This is implemented in terms of client_read() and could be
301 * justifiably moved out of sysdep.c)
303 int sock_getln_err(int *sock, char *buf, int bufsize, int *rc, int nSec)
306 CitContext *CCC = MyContext();
309 FlushStrBuf(CCC->sMigrateBuf);
310 *rc = retval = CtdlSockGetLine(sock, CCC->sMigrateBuf, nSec);
312 i = StrLength(CCC->sMigrateBuf);
313 pCh = ChrPtr(CCC->sMigrateBuf);
315 memcpy(buf, pCh, i + 1);
317 FlushStrBuf(CCC->sMigrateBuf);
319 safestrncpy(&buf[i], "000", bufsize - i);
326 * Multiline version of sock_gets() ... this is a convenience function for
327 * client side protocol implementations. It only returns the first line of
328 * a multiline response, discarding the rest.
330 int ml_sock_gets(int *sock, char *buf, int nSec)
336 g = sock_getln_err(sock, buf, SIZ, &rc, nSec);
345 g = sock_getln_err(sock, bigbuf, SIZ, &rc, nSec);
350 } while ((g >= 4) && (bigbuf[3] == '-'));
352 return (strlen(buf));
357 * sock_puts() - send line to server - implemented in terms of serv_write()
358 * Returns the number of bytes written, or -1 for error.
360 int sock_puts(int *sock, char *buf)
364 i = sock_write(sock, buf, strlen(buf));
367 j = sock_write(sock, "\n", 1);