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, *res = 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));
92 sock = socket(res->ai_family, res->ai_socktype, res->ai_protocol);
94 CtdlLogPrintf(CTDL_ERR, "socket() failed: %s\n", strerror(errno));
98 rc = connect(sock, res->ai_addr, res->ai_addrlen);
101 * Note: the res is a linked list of addresses found for server.
102 * If the connect() fails to the first one, subsequent addresses
103 * (if any) in the list could be tried if desired.
105 CtdlLogPrintf(CTDL_ERR, "connect() failed: %s\n", strerror(errno));
115 * Read data from the client socket.
117 * sock socket fd to read from
118 * buf buffer to read into
119 * bytes number of bytes to read
120 * timeout Number of seconds to wait before timing out
122 * Possible return values:
123 * 1 Requested number of bytes has been read.
124 * 0 Request timed out.
125 * -1 Connection is broken, or other error.
127 int socket_read_blob(int *Socket, StrBuf * Target, int bytes, int timeout)
129 CitContext *CCC = MyContext();
134 retval = StrBufReadBLOBBuffered(Target,
137 Socket, 1, bytes, O_TERM, &Error);
139 CtdlLogPrintf(CTDL_CRIT,
140 "%s failed: %s\n", __FUNCTION__, Error);
146 int sock_read_to(int *sock, char *buf, int bytes, int timeout,
147 int keep_reading_until_full)
149 CitContext *CCC = MyContext();
152 FlushStrBuf(CCC->MigrateBuf);
153 rc = socket_read_blob(sock, CCC->sMigrateBuf, bytes, timeout);
158 if (StrLength(CCC->MigrateBuf) < bytes)
159 bytes = StrLength(CCC->MigrateBuf);
160 memcpy(buf, ChrPtr(CCC->MigrateBuf), bytes);
162 FlushStrBuf(CCC->MigrateBuf);
168 int CtdlSockGetLine(int *sock, StrBuf * Target)
170 CitContext *CCC = MyContext();
175 rc = StrBufTCP_read_buffered_line_fast(Target,
179 if ((rc < 0) && (Error != NULL))
180 CtdlLogPrintf(CTDL_CRIT,
181 "%s failed: %s\n", __FUNCTION__, Error);
187 * client_getln() ... Get a LF-terminated line of text from the client.
188 * (This is implemented in terms of client_read() and could be
189 * justifiably moved out of sysdep.c)
191 int sock_getln(int *sock, char *buf, int bufsize)
194 CitContext *CCC = MyContext();
197 FlushStrBuf(CCC->sMigrateBuf);
198 retval = CtdlSockGetLine(sock, CCC->sMigrateBuf);
200 i = StrLength(CCC->sMigrateBuf);
201 pCh = ChrPtr(CCC->sMigrateBuf);
202 /* Strip the trailing LF, and the trailing CR if present.
207 && ((pCh[i - 1] == 13)
208 || (pCh[i - 1] == 10))) {
214 FlushStrBuf(CCC->sMigrateBuf);
216 safestrncpy(&buf[i], "000", bufsize - i);
224 * sock_read() - input binary data from socket.
225 * Returns the number of bytes read, or -1 for error.
227 INLINE int sock_read(int *sock, char *buf, int bytes,
228 int keep_reading_until_full)
230 return sock_read_to(sock, buf, bytes, CLIENT_TIMEOUT,
231 keep_reading_until_full);
236 * sock_write() - send binary to server.
237 * Returns the number of bytes written, or -1 for error.
239 int sock_write(int *sock, const char *buf, int nbytes)
241 int bytes_written = 0;
244 while ((*sock != -1) && (bytes_written < nbytes)) {
245 retval = write(*sock, &buf[bytes_written],
246 nbytes - bytes_written);
252 bytes_written = bytes_written + retval;
254 return (bytes_written);
259 * Multiline version of sock_gets() ... this is a convenience function for
260 * client side protocol implementations. It only returns the first line of
261 * a multiline response, discarding the rest.
263 int ml_sock_gets(int *sock, char *buf)
268 g = sock_getln(sock, buf, SIZ);
275 g = sock_getln(sock, bigbuf, SIZ);
278 } while ((g >= 4) && (bigbuf[3] == '-'));
280 return (strlen(buf));
285 * sock_puts() - send line to server - implemented in terms of serv_write()
286 * Returns the number of bytes written, or -1 for error.
288 int sock_puts(int *sock, char *buf)
292 i = sock_write(sock, buf, strlen(buf));
295 j = sock_write(sock, "\n", 1);