1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2008 Index Data
4 Pazpar2 is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 /** \file connection.c
21 \brief Z39.50 connection (low-level client)
38 #include <sys/socket.h>
42 typedef int socklen_t;
53 #include <yaz/comstack.h>
54 #include <yaz/tcpip.h>
55 #include "connection.h"
61 #include "parameters.h"
64 /** \brief Represents a physical, reusable connection to a remote Z39.50 host
69 ZOOM_resultset resultset;
71 struct client *client;
74 char *authentication; // Empty string or authentication string if set
81 struct connection *next; // next for same host or next in free list
84 static struct connection *connection_freelist = 0;
86 static int connection_is_idle(struct connection *co)
88 ZOOM_connection link = co->link;
89 int event = ZOOM_connection_peek_event(link);
91 if (co->state != Conn_Open)
95 event = ZOOM_connection_peek_event(link);
96 if (event == ZOOM_EVENT_NONE ||
97 event == ZOOM_EVENT_END)
103 ZOOM_connection connection_get_link(struct connection *co)
108 ZOOM_resultset connection_get_resultset(struct connection *co)
110 return co->resultset;
113 void connection_set_resultset(struct connection *co, ZOOM_resultset rs)
116 ZOOM_resultset_destroy(co->resultset);
120 static void remove_connection_from_host(struct connection *con)
122 struct connection **conp = &con->host->connections;
128 *conp = (*conp)->next;
131 conp = &(*conp)->next;
136 // Close connection and recycle structure
137 void connection_destroy(struct connection *co)
141 ZOOM_connection_destroy(co->link);
142 iochan_destroy(co->iochan);
145 ZOOM_resultset_destroy(co->resultset);
147 yaz_log(YLOG_DEBUG, "Connection destroy %s", co->host->hostport);
149 remove_connection_from_host(co);
152 client_disconnect(co->client);
156 co->next = connection_freelist;
157 connection_freelist = co;
160 // Creates a new connection for client, associated with the host of
162 struct connection *connection_create(struct client *cl)
164 struct connection *new;
165 struct host *host = client_get_host(cl);
167 if ((new = connection_freelist))
168 connection_freelist = new->next;
171 new = xmalloc(sizeof (struct connection));
176 new->next = new->host->connections;
177 new->host->connections = new;
179 new->authentication = "";
181 client_set_connection(cl, new);
184 new->state = Conn_Connecting;
186 connection_connect(new);
190 static void connection_handler(IOCHAN i, int event)
192 struct connection *co = iochan_getdata(i);
193 struct client *cl = co->client;
194 struct session *se = 0;
197 se = client_get_session(cl);
200 connection_destroy(co);
204 if (event & EVENT_TIMEOUT)
206 if (co->state == Conn_Connecting)
208 yaz_log(YLOG_WARN, "connect timeout %s", client_get_url(cl));
213 yaz_log(YLOG_LOG, "idle timeout %s", client_get_url(cl));
214 connection_destroy(co);
220 ZOOM_connection link = co->link;
222 if (ZOOM_event(1, &link))
225 int event = ZOOM_connection_last_event(link);
230 case ZOOM_EVENT_SEND_DATA:
232 case ZOOM_EVENT_RECV_DATA:
234 case ZOOM_EVENT_UNKNOWN:
236 case ZOOM_EVENT_SEND_APDU:
237 client_set_state(co->client, Client_Working);
239 case ZOOM_EVENT_RECV_APDU:
240 client_set_state(co->client, Client_Idle);
242 case ZOOM_EVENT_CONNECT:
243 yaz_log(YLOG_LOG, "Connected to %s", client_get_url(cl));
244 co->state = Conn_Open;
245 client_set_state(co->client, Client_Connected);
246 iochan_settimeout(i, global_parameters.z3950_session_timeout);
248 case ZOOM_EVENT_RECV_SEARCH:
249 yaz_log(YLOG_LOG, "Search response from %s", client_get_url(cl));
250 client_search_response(cl);
252 case ZOOM_EVENT_RECV_RECORD:
253 yaz_log(YLOG_LOG, "Record from %s", client_get_url(cl));
254 client_record_response(cl);
257 yaz_log(YLOG_LOG, "Unhandled event (%d) from %s",
258 event, client_get_url(cl));
261 while(ZOOM_event_nonblock(1, &link));
267 // Disassociate connection from client
268 void connection_release(struct connection *co)
270 struct client *cl = co->client;
272 yaz_log(YLOG_DEBUG, "Connection release %s", co->host->hostport);
275 client_set_connection(cl, 0);
279 void connect_resolver_host(struct host *host)
281 struct connection *con = host->connections;
284 if (con->state == Conn_Resolving)
286 if (!host->ipport) /* unresolved */
288 connection_destroy(con);
289 /* start all over .. at some point it will be NULL */
290 con = host->connections;
293 else if (!con->client)
295 connection_destroy(con);
296 /* start all over .. at some point it will be NULL */
297 con = host->connections;
302 connection_connect(con);
307 yaz_log(YLOG_LOG, "connect_resolver_host: state=%d", con->state);
313 struct host *connection_get_host(struct connection *con)
318 // Callback for use by event loop
319 // We do this because ZOOM connections don't always have (the same) sockets
320 static int socketfun(IOCHAN c)
322 struct connection *co = iochan_getdata(c);
325 return ZOOM_connection_get_socket(co->link);
328 // Because ZOOM always knows what events it is interested in; we may not
329 static int maskfun(IOCHAN c)
331 struct connection *co = iochan_getdata(c);
335 // This is cheating a little, and assuming that eventl mask IDs are always
336 // the same as ZOOM-C's.
337 return ZOOM_connection_get_mask(co->link);
340 int connection_connect(struct connection *con)
342 ZOOM_connection link = 0;
343 struct host *host = connection_get_host(con);
344 ZOOM_options zoptions = ZOOM_options_create();
347 struct session_database *sdb = client_get_database(con->client);
348 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
350 assert(host->ipport);
353 ZOOM_options_set(zoptions, "async", "1");
354 ZOOM_options_set(zoptions, "implementationName",
355 global_parameters.implementationName);
356 ZOOM_options_set(zoptions, "implementationVersion",
357 global_parameters.implementationVersion);
359 if (zproxy && *zproxy)
361 con->zproxy = xstrdup(zproxy);
362 ZOOM_options_set(zoptions, "proxy", zproxy);
365 if ((auth = (char*) session_setting_oneval(sdb, PZ_AUTHENTICATION)))
366 ZOOM_options_set(zoptions, "user", auth);
368 if (!(link = ZOOM_connection_create(zoptions)))
370 yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create ZOOM Connection");
371 ZOOM_options_destroy(zoptions);
374 ZOOM_connection_connect(link, host->ipport, 0);
377 con->iochan = iochan_create(0, connection_handler, 0);
378 con->state = Conn_Connecting;
379 iochan_settimeout(con->iochan, global_parameters.z3950_connect_timeout);
380 iochan_setdata(con->iochan, con);
381 iochan_setsocketfun(con->iochan, socketfun);
382 iochan_setmaskfun(con->iochan, maskfun);
383 pazpar2_add_channel(con->iochan);
385 /* this fragment is bad DRY: from client_prep_connection */
386 client_set_state(con->client, Client_Connecting);
387 ZOOM_options_destroy(zoptions);
388 // This creates the connection
389 ZOOM_connection_process(link);
393 const char *connection_get_url(struct connection *co)
395 return client_get_url(co->client);
398 void connection_set_authentication(struct connection *co, char *auth)
400 co->authentication = auth;
403 // Ensure that client has a connection associated
404 int client_prep_connection(struct client *cl)
406 struct connection *co;
407 struct session *se = client_get_session(cl);
408 struct host *host = client_get_host(cl);
409 struct session_database *sdb = client_get_database(cl);
410 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
412 if (zproxy && zproxy[0] == '\0')
415 co = client_get_connection(cl);
417 yaz_log(YLOG_DEBUG, "Client prep %s", client_get_url(cl));
421 // See if someone else has an idle connection
422 // We should look at timestamps here to select the longest-idle connection
423 for (co = host->connections; co; co = co->next)
424 if (connection_is_idle(co) &&
425 (!co->client || client_get_session(co->client) != se) &&
426 !strcmp(co->authentication,
427 session_setting_oneval(client_get_database(cl),
430 if (zproxy == 0 && co->zproxy == 0)
432 if (zproxy && co->zproxy && !strcmp(zproxy, co->zproxy))
437 connection_release(co);
438 client_set_connection(cl, co);
442 co = connection_create(cl);
454 int connection_send_apdu(struct connection *co, Z_APDU *a){return 10;}
461 * indent-tabs-mode: nil
463 * vim: shiftwidth=4 tabstop=8 expandtab