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;
64 int operation_timeout;
66 struct connection *next; // next for same host or next in free list
69 static int connection_connect(struct connection *con, iochan_man_t iochan_man);
71 static int connection_is_idle(struct connection *co)
73 ZOOM_connection link = co->link;
76 if (co->state != Conn_Open || !link)
79 if (!ZOOM_connection_is_idle(link))
81 event = ZOOM_connection_peek_event(link);
82 if (event == ZOOM_EVENT_NONE)
88 ZOOM_connection connection_get_link(struct connection *co)
93 static void remove_connection_from_host(struct connection *con)
95 struct connection **conp = &con->host->connections;
97 yaz_mutex_enter(con->host->mutex);
102 *conp = (*conp)->next;
105 conp = &(*conp)->next;
107 yaz_mutex_leave(con->host->mutex);
110 // Close connection and recycle structure
111 void connection_destroy(struct connection *co)
115 ZOOM_connection_destroy(co->link);
116 iochan_destroy(co->iochan);
118 yaz_log(YLOG_DEBUG, "Connection destroy %s", co->host->hostport);
122 client_disconnect(co->client);
125 remove_connection_from_host(co);
130 // Creates a new connection for client, associated with the host of
132 static struct connection *connection_create(struct client *cl,
133 int operation_timeout,
135 iochan_man_t iochan_man)
137 struct connection *new;
138 struct host *host = client_get_host(cl);
140 new = xmalloc(sizeof(*new));
143 yaz_mutex_enter(host->mutex);
144 new->next = new->host->connections;
145 new->host->connections = new;
146 yaz_mutex_leave(host->mutex);
150 client_set_connection(cl, new);
152 new->state = Conn_Resolving;
153 new->operation_timeout = operation_timeout;
154 new->session_timeout = session_timeout;
156 connection_connect(new, iochan_man);
160 static void non_block_events(struct connection *co)
163 IOCHAN iochan = co->iochan;
164 ZOOM_connection link = co->link;
167 struct client *cl = co->client;
169 int r = ZOOM_event_nonblock(1, &link);
174 ev = ZOOM_connection_last_event(link);
177 yaz_log(YLOG_LOG, "ZOOM_EVENT_%s", ZOOM_get_event_str(ev));
183 const char *error, *addinfo;
185 if ((err = ZOOM_connection_error(link, &error, &addinfo)))
187 yaz_log(YLOG_LOG, "Error %s from %s",
188 error, client_get_url(cl));
190 iochan_settimeout(iochan, co->session_timeout);
191 client_set_diagnostic(cl, err);
192 client_set_state(cl, Client_Idle);
195 case ZOOM_EVENT_SEND_DATA:
197 case ZOOM_EVENT_RECV_DATA:
199 case ZOOM_EVENT_UNKNOWN:
201 case ZOOM_EVENT_SEND_APDU:
202 client_set_state(co->client, Client_Working);
203 iochan_settimeout(iochan, co->operation_timeout);
205 case ZOOM_EVENT_RECV_APDU:
207 case ZOOM_EVENT_CONNECT:
208 yaz_log(YLOG_LOG, "Connected to %s", client_get_url(cl));
209 co->state = Conn_Open;
211 case ZOOM_EVENT_RECV_SEARCH:
212 client_search_response(cl);
214 case ZOOM_EVENT_RECV_RECORD:
215 client_record_response(cl);
219 yaz_log(YLOG_LOG, "Unhandled event (%d) from %s",
220 ev, client_get_url(cl));
225 struct client *cl = co->client;
228 client_got_records(cl);
233 void connection_continue(struct connection *co)
235 int r = ZOOM_connection_exec_task(co->link);
237 yaz_log(YLOG_WARN, "No task was executed for connection");
240 static void connection_handler(IOCHAN iochan, int event)
242 struct connection *co = iochan_getdata(iochan);
243 struct client *cl = co->client;
247 /* no client associated with it.. We are probably getting
248 a closed connection from the target.. Or, perhaps, an unexpected
249 package.. We will just close the connection */
250 yaz_log(YLOG_LOG, "timeout connection %p event=%d", co, event);
251 connection_destroy(co);
254 if (event & EVENT_TIMEOUT)
256 if (co->state == Conn_Connecting)
258 yaz_log(YLOG_WARN, "connect timeout %s", client_get_url(cl));
263 yaz_log(YLOG_LOG, "idle timeout %s", client_get_url(cl));
264 connection_destroy(co);
269 non_block_events(co);
271 ZOOM_connection_fire_event_socket(co->link, event);
273 non_block_events(co);
278 // Disassociate connection from client
279 void connection_release(struct connection *co)
281 struct client *cl = co->client;
285 client_set_connection(cl, 0);
289 void connect_resolver_host(struct host *host, iochan_man_t iochan_man)
291 struct connection *con;
294 yaz_mutex_enter(host->mutex);
295 con = host->connections;
298 if (con->state == Conn_Resolving)
300 if (!host->ipport) /* unresolved */
302 yaz_mutex_leave(host->mutex);
303 connection_destroy(con);
305 /* start all over .. at some point it will be NULL */
307 else if (!con->client)
309 yaz_mutex_leave(host->mutex);
310 connection_destroy(con);
311 /* start all over .. at some point it will be NULL */
316 yaz_mutex_leave(host->mutex);
317 connection_connect(con, iochan_man);
318 client_start_search(con->client);
324 yaz_log(YLOG_LOG, "connect_resolver_host: state=%d", con->state);
328 yaz_mutex_leave(host->mutex);
331 static struct host *connection_get_host(struct connection *con)
336 // Callback for use by event loop
337 // We do this because ZOOM connections don't always have (the same) sockets
338 static int socketfun(IOCHAN c)
340 struct connection *co = iochan_getdata(c);
343 return ZOOM_connection_get_socket(co->link);
346 // Because ZOOM always knows what events it is interested in; we may not
347 static int maskfun(IOCHAN c)
349 struct connection *co = iochan_getdata(c);
353 // This is cheating a little, and assuming that eventl mask IDs are always
354 // the same as ZOOM-C's.
355 return ZOOM_connection_get_mask(co->link);
358 static int connection_connect(struct connection *con, iochan_man_t iochan_man)
360 ZOOM_connection link = 0;
361 struct host *host = connection_get_host(con);
362 ZOOM_options zoptions = ZOOM_options_create();
366 const char *sru_version = 0;
368 struct session_database *sdb = client_get_database(con->client);
369 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
370 const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG);
372 assert(host->ipport);
375 ZOOM_options_set(zoptions, "async", "1");
376 ZOOM_options_set(zoptions, "implementationName", PACKAGE_NAME);
377 ZOOM_options_set(zoptions, "implementationVersion", VERSION);
379 if ((charset = session_setting_oneval(sdb, PZ_NEGOTIATION_CHARSET)))
380 ZOOM_options_set(zoptions, "charset", charset);
382 if (zproxy && *zproxy)
384 con->zproxy = xstrdup(zproxy);
385 ZOOM_options_set(zoptions, "proxy", zproxy);
387 if (apdulog && *apdulog)
388 ZOOM_options_set(zoptions, "apdulog", apdulog);
390 if ((auth = session_setting_oneval(sdb, PZ_AUTHENTICATION)))
391 ZOOM_options_set(zoptions, "user", auth);
392 if ((sru = session_setting_oneval(sdb, PZ_SRU)) && *sru)
393 ZOOM_options_set(zoptions, "sru", sru);
394 if ((sru_version = session_setting_oneval(sdb, PZ_SRU_VERSION))
396 ZOOM_options_set(zoptions, "sru_version", sru_version);
398 if (!(link = ZOOM_connection_create(zoptions)))
400 yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create ZOOM Connection");
401 ZOOM_options_destroy(zoptions);
407 char http_hostport[512];
408 strcpy(http_hostport, "http://");
409 strcat(http_hostport, host->hostport);
410 ZOOM_connection_connect(link, http_hostport, 0);
413 ZOOM_connection_connect(link, host->ipport, 0);
416 con->iochan = iochan_create(0, connection_handler, 0, "connection_socket");
417 con->state = Conn_Connecting;
418 iochan_settimeout(con->iochan, con->operation_timeout);
419 iochan_setdata(con->iochan, con);
420 iochan_setsocketfun(con->iochan, socketfun);
421 iochan_setmaskfun(con->iochan, maskfun);
422 iochan_add(iochan_man, con->iochan);
424 /* this fragment is bad DRY: from client_prep_connection */
425 client_set_state(con->client, Client_Connecting);
426 ZOOM_options_destroy(zoptions);
430 const char *connection_get_url(struct connection *co)
432 return client_get_url(co->client);
435 // Ensure that client has a connection associated
436 int client_prep_connection(struct client *cl,
437 int operation_timeout, int session_timeout,
438 iochan_man_t iochan_man)
440 struct connection *co;
441 struct host *host = client_get_host(cl);
442 struct session_database *sdb = client_get_database(cl);
443 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
445 if (zproxy && zproxy[0] == '\0')
451 co = client_get_connection(cl);
453 yaz_log(YLOG_DEBUG, "Client prep %s", client_get_url(cl));
457 // See if someone else has an idle connection
458 // We should look at timestamps here to select the longest-idle connection
459 yaz_mutex_enter(host->mutex);
460 for (co = host->connections; co; co = co->next)
461 if (connection_is_idle(co) &&
462 (!co->client || client_get_state(co->client) == Client_Idle) &&
463 !strcmp(ZOOM_connection_option_get(co->link, "user"),
464 session_setting_oneval(client_get_database(cl),
467 if (zproxy == 0 && co->zproxy == 0)
469 if (zproxy && co->zproxy && !strcmp(zproxy, co->zproxy))
474 connection_release(co);
475 client_set_connection(cl, co);
477 /* ensure that connection is only assigned to this client
478 by marking the client non Idle */
479 client_set_state(cl, Client_Working);
480 yaz_mutex_leave(host->mutex);
481 co->operation_timeout = operation_timeout;
482 co->session_timeout = session_timeout;
483 /* tells ZOOM to reconnect if necessary. Disabled becuase
484 the ZOOM_connection_connect flushes the task queue */
485 ZOOM_connection_connect(co->link, 0, 0);
489 yaz_mutex_leave(host->mutex);
490 co = connection_create(cl, operation_timeout, session_timeout,
504 * c-file-style: "Stroustrup"
505 * indent-tabs-mode: nil
507 * vim: shiftwidth=4 tabstop=8 expandtab