1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2010 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)
42 #include <yaz/comstack.h>
43 #include <yaz/tcpip.h>
44 #include "connection.h"
51 /** \brief Represents a physical, reusable connection to a remote Z39.50 host
57 struct client *client;
66 int operation_timeout;
68 struct connection *next; // next for same host or next in free list
71 static struct connection *connection_freelist = 0; /* thread pr */
73 static int connection_connect(struct connection *con, iochan_man_t iochan_man);
75 static int connection_is_idle(struct connection *co)
77 ZOOM_connection link = co->link;
80 if (co->state != Conn_Open || !link)
83 if (!ZOOM_connection_is_idle(link))
85 event = ZOOM_connection_peek_event(link);
86 if (event == ZOOM_EVENT_NONE || event == ZOOM_EVENT_END)
92 ZOOM_connection connection_get_link(struct connection *co)
97 static void remove_connection_from_host(struct connection *con)
99 struct connection **conp = &con->host->connections;
105 *conp = (*conp)->next;
108 conp = &(*conp)->next;
113 // Close connection and recycle structure
114 void connection_destroy(struct connection *co)
118 ZOOM_connection_destroy(co->link);
119 iochan_destroy(co->iochan);
121 yaz_log(YLOG_DEBUG, "Connection destroy %s", co->host->hostport);
123 remove_connection_from_host(co);
126 client_disconnect(co->client);
130 co->next = connection_freelist;
131 connection_freelist = co;
134 // Creates a new connection for client, associated with the host of
136 static struct connection *connection_create(struct client *cl,
137 int operation_timeout,
139 iochan_man_t iochan_man)
141 struct connection *new;
142 struct host *host = client_get_host(cl);
144 if ((new = connection_freelist))
145 connection_freelist = new->next;
148 new = xmalloc(sizeof (struct connection));
153 new->next = new->host->connections;
154 new->host->connections = new;
157 client_set_connection(cl, new);
159 new->state = Conn_Resolving;
160 new->operation_timeout = operation_timeout;
161 new->session_timeout = session_timeout;
163 connection_connect(new, iochan_man);
167 static void non_block_events(struct connection *co)
169 struct client *cl = co->client;
170 IOCHAN iochan = co->iochan;
171 ZOOM_connection link = co->link;
175 int r = ZOOM_event_nonblock(1, &link);
178 ev = ZOOM_connection_last_event(link);
180 yaz_log(YLOG_LOG, "ZOOM_EVENT_%s", ZOOM_get_event_str(ev));
186 const char *error, *addinfo;
188 if ((err = ZOOM_connection_error(link, &error, &addinfo)))
190 yaz_log(YLOG_LOG, "Error %s from %s",
191 error, client_get_url(cl));
193 iochan_settimeout(iochan, co->session_timeout);
194 client_set_diagnostic(cl, err);
195 client_set_state(cl, Client_Idle);
198 case ZOOM_EVENT_SEND_DATA:
200 case ZOOM_EVENT_RECV_DATA:
202 case ZOOM_EVENT_UNKNOWN:
204 case ZOOM_EVENT_SEND_APDU:
205 client_set_state(co->client, Client_Working);
206 iochan_settimeout(iochan, co->operation_timeout);
208 case ZOOM_EVENT_RECV_APDU:
210 case ZOOM_EVENT_CONNECT:
211 yaz_log(YLOG_LOG, "Connected to %s", client_get_url(cl));
212 co->state = Conn_Open;
214 case ZOOM_EVENT_RECV_SEARCH:
215 client_search_response(cl);
217 case ZOOM_EVENT_RECV_RECORD:
218 client_record_response(cl);
221 yaz_log(YLOG_LOG, "Unhandled event (%d) from %s",
222 ev, client_get_url(cl));
227 void connection_continue(struct connection *co)
229 non_block_events(co);
232 static void connection_handler(IOCHAN iochan, int event)
234 struct connection *co = iochan_getdata(iochan);
235 struct client *cl = co->client;
236 struct session *se = 0;
239 se = client_get_session(cl);
242 connection_destroy(co);
246 if (event & EVENT_TIMEOUT)
248 if (co->state == Conn_Connecting)
250 yaz_log(YLOG_WARN, "connect timeout %s", client_get_url(cl));
255 yaz_log(YLOG_LOG, "idle timeout %s", client_get_url(cl));
256 connection_destroy(co);
261 non_block_events(co);
263 ZOOM_connection_fire_event_socket(co->link, event);
265 non_block_events(co);
270 // Disassociate connection from client
271 void connection_release(struct connection *co)
273 struct client *cl = co->client;
275 yaz_log(YLOG_DEBUG, "Connection release %s", co->host->hostport);
278 client_set_connection(cl, 0);
282 void connect_resolver_host(struct host *host, iochan_man_t iochan_man)
284 struct connection *con = host->connections;
287 if (con->state == Conn_Resolving)
289 if (!host->ipport) /* unresolved */
291 connection_destroy(con);
292 /* start all over .. at some point it will be NULL */
293 con = host->connections;
296 else if (!con->client)
298 connection_destroy(con);
299 /* start all over .. at some point it will be NULL */
300 con = host->connections;
305 connection_connect(con, iochan_man);
306 client_start_search(con->client);
311 yaz_log(YLOG_LOG, "connect_resolver_host: state=%d", con->state);
317 static struct host *connection_get_host(struct connection *con)
322 // Callback for use by event loop
323 // We do this because ZOOM connections don't always have (the same) sockets
324 static int socketfun(IOCHAN c)
326 struct connection *co = iochan_getdata(c);
329 return ZOOM_connection_get_socket(co->link);
332 // Because ZOOM always knows what events it is interested in; we may not
333 static int maskfun(IOCHAN c)
335 struct connection *co = iochan_getdata(c);
339 // This is cheating a little, and assuming that eventl mask IDs are always
340 // the same as ZOOM-C's.
341 return ZOOM_connection_get_mask(co->link);
344 static int connection_connect(struct connection *con, iochan_man_t iochan_man)
346 ZOOM_connection link = 0;
347 struct host *host = connection_get_host(con);
348 ZOOM_options zoptions = ZOOM_options_create();
352 const char *sru_version = 0;
354 struct session_database *sdb = client_get_database(con->client);
355 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
356 const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG);
358 assert(host->ipport);
361 ZOOM_options_set(zoptions, "async", "1");
362 ZOOM_options_set(zoptions, "implementationName", PACKAGE_NAME);
363 ZOOM_options_set(zoptions, "implementationVersion", VERSION);
365 if ((charset = session_setting_oneval(sdb, PZ_NEGOTIATION_CHARSET)))
366 ZOOM_options_set(zoptions, "charset", charset);
368 if (zproxy && *zproxy)
370 con->zproxy = xstrdup(zproxy);
371 ZOOM_options_set(zoptions, "proxy", zproxy);
373 if (apdulog && *apdulog)
374 ZOOM_options_set(zoptions, "apdulog", apdulog);
376 if ((auth = session_setting_oneval(sdb, PZ_AUTHENTICATION)))
377 ZOOM_options_set(zoptions, "user", auth);
378 if ((sru = session_setting_oneval(sdb, PZ_SRU)) && *sru)
379 ZOOM_options_set(zoptions, "sru", sru);
380 if ((sru_version = session_setting_oneval(sdb, PZ_SRU_VERSION))
382 ZOOM_options_set(zoptions, "sru_version", sru_version);
384 if (!(link = ZOOM_connection_create(zoptions)))
386 yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create ZOOM Connection");
387 ZOOM_options_destroy(zoptions);
393 char http_hostport[512];
394 strcpy(http_hostport, "http://");
395 strcat(http_hostport, host->hostport);
396 ZOOM_connection_connect(link, http_hostport, 0);
399 ZOOM_connection_connect(link, host->ipport, 0);
402 con->iochan = iochan_create(0, connection_handler, 0);
403 con->state = Conn_Connecting;
404 iochan_settimeout(con->iochan, con->operation_timeout);
405 iochan_setdata(con->iochan, con);
406 iochan_setsocketfun(con->iochan, socketfun);
407 iochan_setmaskfun(con->iochan, maskfun);
408 iochan_add(iochan_man, con->iochan);
410 /* this fragment is bad DRY: from client_prep_connection */
411 client_set_state(con->client, Client_Connecting);
412 ZOOM_options_destroy(zoptions);
416 const char *connection_get_url(struct connection *co)
418 return client_get_url(co->client);
421 // Ensure that client has a connection associated
422 int client_prep_connection(struct client *cl,
423 int operation_timeout, int session_timeout,
424 iochan_man_t iochan_man)
426 struct connection *co;
427 struct session *se = client_get_session(cl);
428 struct host *host = client_get_host(cl);
429 struct session_database *sdb = client_get_database(cl);
430 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
432 if (zproxy && zproxy[0] == '\0')
438 co = client_get_connection(cl);
440 yaz_log(YLOG_DEBUG, "Client prep %s", client_get_url(cl));
444 // See if someone else has an idle connection
445 // We should look at timestamps here to select the longest-idle connection
446 for (co = host->connections; co; co = co->next)
447 if (connection_is_idle(co) &&
448 (!co->client || client_get_session(co->client) != se) &&
449 !strcmp(ZOOM_connection_option_get(co->link, "user"),
450 session_setting_oneval(client_get_database(cl),
453 if (zproxy == 0 && co->zproxy == 0)
455 if (zproxy && co->zproxy && !strcmp(zproxy, co->zproxy))
460 connection_release(co);
461 client_set_connection(cl, co);
463 co->operation_timeout = operation_timeout;
464 co->session_timeout = session_timeout;
465 /* tells ZOOM to reconnect if necessary. Disabled becuase
466 the ZOOM_connection_connect flushes the task queue */
467 ZOOM_connection_connect(co->link, 0, 0);
471 co = connection_create(cl, operation_timeout, session_timeout,
485 * c-file-style: "Stroustrup"
486 * indent-tabs-mode: nil
488 * vim: shiftwidth=4 tabstop=8 expandtab