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 void connection_continue(struct connection *co)
139 yaz_log(YLOG_LOG, "connection_continue");
140 iochan_setevent(co->iochan, EVENT_OUTPUT);
144 // Close connection and recycle structure
145 void connection_destroy(struct connection *co)
149 ZOOM_connection_destroy(co->link);
150 iochan_destroy(co->iochan);
153 ZOOM_resultset_destroy(co->resultset);
155 yaz_log(YLOG_DEBUG, "Connection destroy %s", co->host->hostport);
157 remove_connection_from_host(co);
160 client_disconnect(co->client);
164 co->next = connection_freelist;
165 connection_freelist = co;
168 // Creates a new connection for client, associated with the host of
170 struct connection *connection_create(struct client *cl)
172 struct connection *new;
173 struct host *host = client_get_host(cl);
175 if ((new = connection_freelist))
176 connection_freelist = new->next;
179 new = xmalloc(sizeof (struct connection));
184 new->next = new->host->connections;
185 new->host->connections = new;
187 new->authentication = "";
189 client_set_connection(cl, new);
192 new->state = Conn_Resolving;
194 connection_connect(new);
198 static void connection_handler(IOCHAN i, int event)
200 struct connection *co = iochan_getdata(i);
201 struct client *cl = co->client;
202 struct session *se = 0;
205 se = client_get_session(cl);
208 connection_destroy(co);
212 if (event & EVENT_TIMEOUT)
214 if (co->state == Conn_Connecting)
216 yaz_log(YLOG_WARN, "connect timeout %s", client_get_url(cl));
221 yaz_log(YLOG_LOG, "idle timeout %s", client_get_url(cl));
222 connection_destroy(co);
228 ZOOM_connection link = co->link;
230 if (ZOOM_event(1, &link))
234 int event = ZOOM_connection_last_event(link);
239 case ZOOM_EVENT_SEND_DATA:
241 case ZOOM_EVENT_RECV_DATA:
243 case ZOOM_EVENT_UNKNOWN:
245 case ZOOM_EVENT_SEND_APDU:
246 client_set_state(co->client, Client_Working);
248 case ZOOM_EVENT_RECV_APDU:
249 client_set_state(co->client, Client_Idle);
251 case ZOOM_EVENT_CONNECT:
252 yaz_log(YLOG_LOG, "Connected to %s", client_get_url(cl));
253 co->state = Conn_Open;
254 client_set_state(co->client, Client_Connected);
255 iochan_settimeout(i, global_parameters.z3950_session_timeout);
257 case ZOOM_EVENT_RECV_SEARCH:
258 yaz_log(YLOG_LOG, "Search response from %s", client_get_url(cl));
259 client_search_response(cl);
261 case ZOOM_EVENT_RECV_RECORD:
262 yaz_log(YLOG_LOG, "Record from %s", client_get_url(cl));
263 client_record_response(cl);
266 yaz_log(YLOG_LOG, "Unhandled event (%d) from %s",
267 event, client_get_url(cl));
270 while (ZOOM_event_nonblock(1, &link));
276 // Disassociate connection from client
277 void connection_release(struct connection *co)
279 struct client *cl = co->client;
281 yaz_log(YLOG_DEBUG, "Connection release %s", co->host->hostport);
284 client_set_connection(cl, 0);
288 void connect_resolver_host(struct host *host)
290 struct connection *con = host->connections;
293 if (con->state == Conn_Resolving)
295 if (!host->ipport) /* unresolved */
297 connection_destroy(con);
298 /* start all over .. at some point it will be NULL */
299 con = host->connections;
302 else if (!con->client)
304 connection_destroy(con);
305 /* start all over .. at some point it will be NULL */
306 con = host->connections;
311 connection_connect(con);
312 client_start_search(con->client);
317 yaz_log(YLOG_LOG, "connect_resolver_host: state=%d", con->state);
323 struct host *connection_get_host(struct connection *con)
328 // Callback for use by event loop
329 // We do this because ZOOM connections don't always have (the same) sockets
330 static int socketfun(IOCHAN c)
332 struct connection *co = iochan_getdata(c);
335 return ZOOM_connection_get_socket(co->link);
338 // Because ZOOM always knows what events it is interested in; we may not
339 static int maskfun(IOCHAN c)
341 struct connection *co = iochan_getdata(c);
345 // This is cheating a little, and assuming that eventl mask IDs are always
346 // the same as ZOOM-C's.
347 return ZOOM_connection_get_mask(co->link);
350 int connection_connect(struct connection *con)
352 ZOOM_connection link = 0;
353 struct host *host = connection_get_host(con);
354 ZOOM_options zoptions = ZOOM_options_create();
357 char ipport[512] = "";
359 struct session_database *sdb = client_get_database(con->client);
360 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
361 const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG);
363 assert(host->ipport);
366 ZOOM_options_set(zoptions, "async", "1");
367 ZOOM_options_set(zoptions, "implementationName",
368 global_parameters.implementationName);
369 ZOOM_options_set(zoptions, "implementationVersion",
370 global_parameters.implementationVersion);
371 if (zproxy && *zproxy)
373 con->zproxy = xstrdup(zproxy);
374 ZOOM_options_set(zoptions, "proxy", zproxy);
376 if (apdulog && *apdulog)
377 ZOOM_options_set(zoptions, "apdulog", apdulog);
379 if ((auth = (char*) session_setting_oneval(sdb, PZ_AUTHENTICATION)))
380 ZOOM_options_set(zoptions, "user", auth);
381 if ((sru = (char*) session_setting_oneval(sdb, PZ_SRU)) && *sru)
382 ZOOM_options_set(zoptions, "sru", sru);
384 if (!(link = ZOOM_connection_create(zoptions)))
386 yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create ZOOM Connection");
387 ZOOM_options_destroy(zoptions);
392 strcpy(ipport, "http://");
393 strcat(ipport, host->ipport);
395 ZOOM_connection_connect(link, ipport, 0);
398 con->iochan = iochan_create(0, connection_handler, 0);
399 con->state = Conn_Connecting;
400 iochan_settimeout(con->iochan, global_parameters.z3950_connect_timeout);
401 iochan_setdata(con->iochan, con);
402 iochan_setsocketfun(con->iochan, socketfun);
403 iochan_setmaskfun(con->iochan, maskfun);
404 pazpar2_add_channel(con->iochan);
406 /* this fragment is bad DRY: from client_prep_connection */
407 client_set_state(con->client, Client_Connecting);
408 ZOOM_options_destroy(zoptions);
409 // This creates the connection
410 ZOOM_connection_process(link);
414 const char *connection_get_url(struct connection *co)
416 return client_get_url(co->client);
419 void connection_set_authentication(struct connection *co, char *auth)
421 co->authentication = auth;
424 // Ensure that client has a connection associated
425 int client_prep_connection(struct client *cl)
427 struct connection *co;
428 struct session *se = client_get_session(cl);
429 struct host *host = client_get_host(cl);
430 struct session_database *sdb = client_get_database(cl);
431 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
433 if (zproxy && zproxy[0] == '\0')
436 co = client_get_connection(cl);
438 yaz_log(YLOG_DEBUG, "Client prep %s", client_get_url(cl));
442 // See if someone else has an idle connection
443 // We should look at timestamps here to select the longest-idle connection
444 for (co = host->connections; co; co = co->next)
445 if (connection_is_idle(co) &&
446 (!co->client || client_get_session(co->client) != se) &&
447 !strcmp(co->authentication,
448 session_setting_oneval(client_get_database(cl),
451 if (zproxy == 0 && co->zproxy == 0)
453 if (zproxy && co->zproxy && !strcmp(zproxy, co->zproxy))
458 connection_release(co);
459 client_set_connection(cl, co);
463 co = connection_create(cl);
475 int connection_send_apdu(struct connection *co, Z_APDU *a){return 10;}
482 * indent-tabs-mode: nil
484 * vim: shiftwidth=4 tabstop=8 expandtab