-/* $Id: connection.c,v 1.12 2007-09-20 08:13:27 adam Exp $
- Copyright (c) 2006-2007, Index Data.
-
-This file is part of Pazpar2.
+/* This file is part of Pazpar2.
+ Copyright (C) Index Data
Pazpar2 is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
for more details.
You should have received a copy of the GNU General Public License
-along with Pazpar2; see the file LICENSE. If not, write to the
-Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
- */
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+*/
/** \file connection.c
\brief Z39.50 connection (low-level client)
*/
+#if HAVE_CONFIG_H
+#include <config.h>
+#endif
+
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
+#if HAVE_SYS_TIME_H
#include <sys/time.h>
+#endif
+#if HAVE_UNISTD_H
#include <unistd.h>
-#include <sys/socket.h>
-#include <netdb.h>
+#endif
+
#include <signal.h>
-#include <ctype.h>
#include <assert.h>
-#if HAVE_CONFIG_H
-#include "cconfig.h"
-#endif
-
#include <yaz/log.h>
#include <yaz/comstack.h>
#include <yaz/tcpip.h>
#include "connection.h"
-#include "eventl.h"
-#include "pazpar2.h"
-#include "host.h"
+#include "session.h"
#include "client.h"
#include "settings.h"
-#include "parameters.h"
+
+/* connection counting (1) , disable connection counting (0) */
+#if 1
+static YAZ_MUTEX g_mutex = 0;
+static int no_connections = 0;
+static int total_no_connections = 0;
+
+static int connection_use(int delta)
+{
+ int result;
+ if (!g_mutex)
+ yaz_mutex_create(&g_mutex);
+ yaz_mutex_enter(g_mutex);
+ no_connections += delta;
+ result = no_connections;
+ if (delta > 0)
+ total_no_connections += delta;
+ yaz_mutex_leave(g_mutex);
+ if (delta == 0)
+ return result;
+ yaz_log(YLOG_LOG, "%s connections=%d", delta > 0 ? "INC" : "DEC",
+ no_connections);
+ return result;
+}
+
+int connections_count(void)
+{
+ return connection_use(0);
+}
+
+
+#else
+#define connection_use(x)
+#define connections_count(x) 0
+#define connections_count_total(x) 0
+#endif
/** \brief Represents a physical, reusable connection to a remote Z39.50 host
*/
struct connection {
IOCHAN iochan;
- COMSTACK link;
- struct host *host;
+ ZOOM_connection link;
struct client *client;
- char *ibuf;
- int ibufsize;
- char *authentication; // Empty string or authentication string if set
char *zproxy;
+ char *url;
enum {
- Conn_Resolving,
+ Conn_Closed,
Conn_Connecting,
- Conn_Open,
- Conn_Waiting,
+ Conn_Open
} state;
+ int operation_timeout;
+ int session_timeout;
struct connection *next; // next for same host or next in free list
};
-static struct connection *connection_freelist = 0;
+static int connection_connect(struct connection *con, iochan_man_t iochan_man);
-static void remove_connection_from_host(struct connection *con)
+ZOOM_connection connection_get_link(struct connection *co)
{
- struct connection **conp = &con->host->connections;
- assert(con);
- while (*conp)
- {
- if (*conp == con)
- {
- *conp = (*conp)->next;
- return;
- }
- conp = &(*conp)->next;
- }
- assert(*conp == 0);
+ return co->link;
+}
+
+void connection_mark_dead(struct connection *co)
+{
+ iochan_settimeout(co->iochan, 1);
}
// Close connection and recycle structure
-void connection_destroy(struct connection *co)
+static void connection_destroy(struct connection *co)
{
if (co->link)
{
- cs_close(co->link);
+ ZOOM_connection_destroy(co->link);
iochan_destroy(co->iochan);
}
+ yaz_log(YLOG_DEBUG, "%p Connection destroy %s", co, co->url);
- yaz_log(YLOG_DEBUG, "Connection destroy %s", co->host->hostport);
-
- remove_connection_from_host(co);
if (co->client)
{
client_disconnect(co->client);
}
+
xfree(co->zproxy);
- co->zproxy = 0;
- co->next = connection_freelist;
- connection_freelist = co;
+ xfree(co->url);
+ xfree(co);
+ connection_use(-1);
}
-// Creates a new connection for client, associated with the host of
+// Creates a new connection for client, associated with the host of
// client's database
-struct connection *connection_create(struct client *cl)
+static struct connection *connection_create(struct client *cl,
+ const char *url,
+ const char *zproxy,
+ int operation_timeout,
+ int session_timeout,
+ iochan_man_t iochan_man)
{
- struct connection *new;
- struct host *host = client_get_host(cl);
-
- if ((new = connection_freelist))
- connection_freelist = new->next;
- else
- {
- new = xmalloc(sizeof (struct connection));
- new->ibuf = 0;
- new->ibufsize = 0;
- }
- new->host = host;
- new->next = new->host->connections;
- new->host->connections = new;
- new->client = cl;
- new->authentication = "";
- new->zproxy = 0;
- client_set_connection(cl, new);
- new->link = 0;
- new->state = Conn_Resolving;
- if (host->ipport)
- connection_connect(new);
- return new;
-}
+ struct connection *co;
+ int ret;
-static void connection_handler(IOCHAN i, int event)
-{
- struct connection *co = iochan_getdata(i);
- struct client *cl = co->client;
- struct session *se = 0;
+ co = xmalloc(sizeof(*co));
- if (cl)
- se = client_get_session(cl);
- else
- {
+ co->client = cl;
+ co->url = xstrdup(url);
+ co->zproxy = 0;
+ if (zproxy)
+ co->zproxy = xstrdup(zproxy);
+
+ client_set_connection(cl, co);
+ co->link = 0;
+ co->state = Conn_Closed;
+ co->operation_timeout = operation_timeout;
+ co->session_timeout = session_timeout;
+
+ ret = connection_connect(co, iochan_man);
+ connection_use(1);
+ if (ret)
+ { /* error */
connection_destroy(co);
- return;
+ co = 0;
}
+ return co;
+}
- if (event & EVENT_TIMEOUT)
+static void non_block_events(struct connection *co)
+{
+ int got_records = 0;
+ IOCHAN iochan = co->iochan;
+ ZOOM_connection link = co->link;
+ while (1)
{
- if (co->state == Conn_Connecting)
- {
- yaz_log(YLOG_WARN, "connect timeout %s", client_get_url(cl));
- client_fatal(cl);
- }
- else
+ struct client *cl = co->client;
+ int ev;
+ int r = ZOOM_event_nonblock(1, &link);
+ if (!r)
+ break;
+ if (!cl)
+ continue;
+ ev = ZOOM_connection_last_event(link);
+
+#if 1
+ yaz_log(YLOG_DEBUG, "%p Connection ZOOM_EVENT_%s", co, ZOOM_get_event_str(ev));
+#endif
+ switch (ev)
{
- yaz_log(YLOG_LOG, "idle timeout %s", client_get_url(cl));
- connection_destroy(co);
- }
- return;
- }
- if (co->state == Conn_Connecting && event & EVENT_OUTPUT)
- {
- int errcode;
- socklen_t errlen = sizeof(errcode);
-
- if (getsockopt(cs_fileno(co->link), SOL_SOCKET, SO_ERROR, &errcode,
- &errlen) < 0 || errcode != 0)
- {
- client_fatal(cl);
- return;
- }
- else
- {
- yaz_log(YLOG_DEBUG, "Connect OK");
- co->state = Conn_Open;
- if (cl)
- client_set_state(cl, Client_Connected);
- iochan_settimeout(i, global_parameters.z3950_session_timeout);
- }
- }
-
- else if (event & EVENT_INPUT)
- {
- int len = cs_get(co->link, &co->ibuf, &co->ibufsize);
-
- if (len < 0)
- {
- yaz_log(YLOG_WARN|YLOG_ERRNO, "Error reading from %s",
- client_get_url(cl));
- connection_destroy(co);
- return;
- }
- else if (len == 0)
- {
- yaz_log(YLOG_WARN, "EOF reading from %s", client_get_url(cl));
- connection_destroy(co);
- return;
- }
- else if (len > 1) // We discard input if we have no connection
- {
- co->state = Conn_Open;
-
- if (client_is_our_response(cl))
+ case ZOOM_EVENT_TIMEOUT:
+ break;
+ case ZOOM_EVENT_END:
{
- Z_APDU *a;
- struct session_database *sdb = client_get_database(cl);
- const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG);
-
- odr_reset(global_parameters.odr_in);
- odr_setbuf(global_parameters.odr_in, co->ibuf, len, 0);
- if (!z_APDU(global_parameters.odr_in, &a, 0, 0))
+ const char *error, *addinfo;
+ int err;
+ if ((err = ZOOM_connection_error(link, &error, &addinfo)))
{
- client_fatal(cl);
- return;
- }
+ struct session *se = client_get_session(cl);
- if (apdulog && *apdulog && *apdulog != '0')
- {
- ODR p = odr_createmem(ODR_PRINT);
- yaz_log(YLOG_LOG, "recv APDU %s", client_get_url(cl));
-
- odr_setprint(p, yaz_log_file());
- z_APDU(p, &a, 0, 0);
- odr_setprint(p, stderr);
- odr_destroy(p);
+ session_log(se, YLOG_WARN, "%s: Error %s (%s)",
+ client_get_id(cl), error, addinfo);
+ client_set_diagnostic(cl, err, error, addinfo);
+ client_set_state(cl, Client_Error);
}
- switch (a->which)
+ else
{
- case Z_APDU_initResponse:
- client_init_response(cl, a);
- break;
- case Z_APDU_searchResponse:
- client_search_response(cl, a);
- break;
- case Z_APDU_presentResponse:
- client_present_response(cl, a);
- break;
- case Z_APDU_close:
- client_close_response(cl, a);
- break;
- default:
- yaz_log(YLOG_WARN,
- "Unexpected Z39.50 response from %s",
- client_get_url(cl));
- client_fatal(cl);
- return;
+ iochan_settimeout(iochan, co->session_timeout);
+ client_set_state(cl, Client_Idle);
}
- // We aren't expecting staggered output from target
- // if (cs_more(t->link))
- // iochan_setevent(i, EVENT_INPUT);
- }
- else // we throw away response and go to idle mode
- {
- yaz_log(YLOG_DEBUG, "Ignoring result of expired operation");
- client_set_state(cl, Client_Continue);
}
- }
- /* if len==1 we do nothing but wait for more input */
+ break;
+ case ZOOM_EVENT_SEND_DATA:
+ break;
+ case ZOOM_EVENT_RECV_DATA:
+ break;
+ case ZOOM_EVENT_UNKNOWN:
+ break;
+ case ZOOM_EVENT_SEND_APDU:
+ client_set_state(co->client, Client_Working);
+ iochan_settimeout(iochan, co->operation_timeout);
+ break;
+ case ZOOM_EVENT_RECV_APDU:
+ break;
+ case ZOOM_EVENT_CONNECT:
+ co->state = Conn_Open;
+ break;
+ case ZOOM_EVENT_RECV_SEARCH:
+ client_search_response(cl);
+ break;
+ case ZOOM_EVENT_RECV_RECORD:
+ client_record_response(cl, &got_records);
+ break;
+ case ZOOM_EVENT_NONE:
+ break;
+ default:
+ yaz_log(YLOG_LOG, "Unhandled event (%d) from %s",
+ ev, client_get_id(cl));
+ break;
+ }
+ }
+ if (got_records)
+ {
+ struct client *cl = co->client;
+ if (cl)
+ client_got_records(cl);
}
- client_continue(cl);
}
-// Disassociate connection from client
-void connection_release(struct connection *co)
+static void iochan_update(struct connection *co)
{
- struct client *cl = co->client;
+ if (co->link)
+ {
+ int m = ZOOM_connection_get_mask(co->link);
- yaz_log(YLOG_DEBUG, "Connection release %s", co->host->hostport);
- if (!cl)
- return;
- client_set_connection(cl, 0);
- co->client = 0;
+ if (m == 0)
+ m = ZOOM_SELECT_READ;
+ iochan_setflags(co->iochan, m);
+ iochan_setfd(co->iochan, ZOOM_connection_get_socket(co->link));
+ }
}
-void connect_resolver_host(struct host *host)
+void connection_continue(struct connection *co)
{
- struct connection *con = host->connections;
- while (con)
+ int r = ZOOM_connection_exec_task(co->link);
+ if (!r)
{
- if (con->state == Conn_Resolving)
- {
- if (!host->ipport) /* unresolved */
- {
- connection_destroy(con);
- /* start all over .. at some point it will be NULL */
- con = host->connections;
- continue;
- }
- else if (!con->client)
- {
- connection_destroy(con);
- /* start all over .. at some point it will be NULL */
- con = host->connections;
- continue;
- }
- else
- {
- connection_connect(con);
- }
- }
- else
- {
- yaz_log(YLOG_LOG, "connect_resolver_host: state=%d", con->state);
- }
- con = con->next;
+ struct client *cl = co->client;
+
+ client_lock(cl);
+ non_block_events(co);
+ client_unlock(cl);
}
+ else
+ iochan_update(co);
}
-int connection_send_apdu(struct connection *co, Z_APDU *a)
+static void connection_handler(IOCHAN iochan, int event)
{
- char *buf;
- int len, r;
+ struct connection *co = iochan_getdata(iochan);
+ struct client *cl;
- if (!z_APDU(global_parameters.odr_out, &a, 0, 0))
+ cl = co->client;
+ if (!cl)
{
- odr_perror(global_parameters.odr_out, "Encoding APDU");
- abort();
+ /* no client associated with it.. We are probably getting
+ a closed connection from the target.. Or, perhaps, an unexpected
+ package.. We will just close the connection */
+ yaz_log(YLOG_LOG, "timeout connection %p event=%d", co, event);
+ connection_destroy(co);
}
- buf = odr_getbuf(global_parameters.odr_out, &len, 0);
- r = cs_put(co->link, buf, len);
- if (r < 0)
+ else if (event & EVENT_TIMEOUT)
{
- yaz_log(YLOG_WARN, "cs_put: %s", cs_errmsg(cs_errno(co->link)));
- return -1;
+ ZOOM_connection_fire_event_timeout(co->link);
+ client_lock(cl);
+ non_block_events(co);
+ client_unlock(cl);
+
+ connection_destroy(co);
}
- else if (r == 1)
+ else
{
- fprintf(stderr, "cs_put incomplete (ParaZ does not handle that)\n");
- return -1;;
+ if (ZOOM_connection_is_idle(co->link))
+ {
+ connection_destroy(co);
+ return;
+ }
+ client_lock(cl);
+ non_block_events(co);
+
+ ZOOM_connection_fire_event_socket(co->link, event);
+
+ non_block_events(co);
+ client_unlock(cl);
+
+ iochan_update(co);
}
- odr_reset(global_parameters.odr_out); /* release the APDU structure */
- co->state = Conn_Waiting;
- iochan_setflags(co->iochan, EVENT_INPUT);
- return 0;
}
-struct host *connection_get_host(struct connection *con)
+void connection_release2(struct connection *co)
{
- return con->host;
+ co->client = 0;
}
-int connection_connect(struct connection *con)
+static int connection_connect(struct connection *con, iochan_man_t iochan_man)
{
- COMSTACK link = 0;
- struct host *host = connection_get_host(con);
- void *addr;
- int res;
-
- struct session_database *sdb = client_get_database(con->client);
- const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
+ ZOOM_options zoptions = ZOOM_options_create();
+ const char *auth;
+ const char *charset;
+ const char *sru;
+ const char *sru_version = 0;
+ const char *value;
+ int r = 0;
+ WRBUF w;
+
+ struct client *cl = con->client;
+ struct session_database *sdb = client_get_database(cl);
+ const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG);
+ struct session *se = client_get_session(cl);
+ const char *memcached = session_setting_oneval(sdb, PZ_MEMCACHED);
+ const char *redis = session_setting_oneval(sdb, PZ_REDIS);
- assert(host->ipport);
assert(con);
- if (!(link = cs_create(tcpip_type, 0, PROTO_Z3950)))
+ ZOOM_options_set(zoptions, "async", "1");
+ ZOOM_options_set(zoptions, "implementationName", PACKAGE_NAME);
+ ZOOM_options_set(zoptions, "implementationVersion", VERSION);
+
+ if ((charset = session_setting_oneval(sdb, PZ_NEGOTIATION_CHARSET)))
+ ZOOM_options_set(zoptions, "charset", charset);
+ if (memcached && *memcached)
+ ZOOM_options_set(zoptions, "memcached", memcached);
+ if (redis && *redis)
+ ZOOM_options_set(zoptions, "redis", redis);
+
+ if (con->zproxy)
{
- yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create comstack");
- return -1;
+ yaz_log(YLOG_LOG, "proxy=%s", con->zproxy);
+ ZOOM_options_set(zoptions, "proxy", con->zproxy);
}
+ if (apdulog && *apdulog)
+ ZOOM_options_set(zoptions, "apdulog", apdulog);
- if (zproxy && *zproxy)
- con->zproxy = xstrdup(zproxy);
- if (!con->zproxy)
+ if ((sru = session_setting_oneval(sdb, PZ_SRU)) && *sru)
+ ZOOM_options_set(zoptions, "sru", sru);
+ if ((sru_version = session_setting_oneval(sdb, PZ_SRU_VERSION))
+ && *sru_version)
+ ZOOM_options_set(zoptions, "sru_version", sru_version);
+
+ if ((auth = session_setting_oneval(sdb, PZ_AUTHENTICATION)))
{
- /* no Z39.50 proxy needed - direct connect */
- yaz_log(YLOG_DEBUG, "Connection create %s", connection_get_url(con));
-
- if (!(addr = cs_straddr(link, host->ipport)))
+ /* allow splitting user and reset with a blank always */
+ const char *cp1 = strchr(auth, ' ');
+ if (!cp1 && sru && *sru)
+ cp1 = strchr(auth, '/');
+ if (!cp1)
{
- yaz_log(YLOG_WARN|YLOG_ERRNO,
- "Lookup of IP address %s failed", host->ipport);
- return -1;
+ /* Z39.50 user/password style, or no password for SRU */
+ ZOOM_options_set(zoptions, "user", auth);
}
-
- } else {
- /* Z39.50 proxy connect */
- yaz_log(YLOG_DEBUG, "Connection create %s proxy %s",
- connection_get_url(con), con->zproxy);
-
- if (!(addr = cs_straddr(link, con->zproxy)))
+ else
{
- yaz_log(YLOG_WARN|YLOG_ERRNO,
- "Lookup of ZProxy IP address %s failed",
- con->zproxy);
- return -1;
+ /* now consider group as well */
+ const char *cp2 = strchr(cp1 + 1, ' ');
+
+ ZOOM_options_setl(zoptions, "user", auth, cp1 - auth);
+ if (!cp2)
+ ZOOM_options_set(zoptions, "password", cp1 + 1);
+ else
+ {
+ ZOOM_options_setl(zoptions, "group", cp1 + 1, cp2 - cp1 - 1);
+ ZOOM_options_set(zoptions, "password", cp2 + 1);
+ }
}
}
-
- res = cs_connect(link, addr);
- if (res < 0)
+
+ value = session_setting_oneval(sdb, PZ_AUTHENTICATION_MODE);
+ if (value && *value)
+ ZOOM_options_set(zoptions, "authenticationMode", value);
+
+ if (!(con->link = ZOOM_connection_create(zoptions)))
{
- yaz_log(YLOG_WARN|YLOG_ERRNO, "cs_connect %s",
- connection_get_url(con));
+ session_log(se, YLOG_WARN, "%s: ZOOM_connection_create failed",
+ client_get_id(cl));
+ ZOOM_options_destroy(zoptions);
return -1;
}
- con->link = link;
- con->state = Conn_Connecting;
- con->iochan = iochan_create(cs_fileno(link), connection_handler, 0);
- iochan_settimeout(con->iochan, global_parameters.z3950_connect_timeout);
- iochan_setdata(con->iochan, con);
- pazpar2_add_channel(con->iochan);
- /* this fragment is bad DRY: from client_prep_connection */
- client_set_state(con->client, Client_Connecting);
- iochan_setflag(con->iochan, EVENT_OUTPUT);
- return 0;
-}
+ w = wrbuf_alloc();
+ if (sru && *sru && !strstr(con->url, "://"))
+ wrbuf_puts(w, "http://");
+ if (strchr(con->url, '#'))
+ {
+ const char *cp = strchr(con->url, '#');
+ wrbuf_write(w, con->url, cp - con->url);
+ }
+ else
+ wrbuf_puts(w, con->url);
-const char *connection_get_url(struct connection *co)
-{
- return client_get_url(co->client);
-}
+ ZOOM_connection_connect(con->link, wrbuf_cstr(w), 0);
-void connection_set_authentication(struct connection *co, char *auth)
-{
- co->authentication = auth;
+ con->iochan = iochan_create(-1, connection_handler, 0, "connection_socket");
+ con->state = Conn_Connecting;
+ iochan_settimeout(con->iochan, con->operation_timeout);
+ iochan_setdata(con->iochan, con);
+ if (iochan_add(iochan_man, con->iochan, 20))
+ {
+ session_log(se, YLOG_WARN, "%s: out of connections", client_get_id(cl));
+ iochan_destroy(con->iochan);
+ con->iochan = 0;
+ ZOOM_connection_destroy(con->link);
+ con->link = 0;
+ r = -1;
+ }
+ else
+ {
+ client_set_state(cl, Client_Connecting);
+ }
+ ZOOM_options_destroy(zoptions);
+ wrbuf_destroy(w);
+ return r;
}
// Ensure that client has a connection associated
-int client_prep_connection(struct client *cl)
+int client_prep_connection(struct client *cl,
+ int operation_timeout, int session_timeout,
+ iochan_man_t iochan_man,
+ const struct timeval *abstime)
{
struct connection *co;
- struct session *se = client_get_session(cl);
- struct host *host = client_get_host(cl);
struct session_database *sdb = client_get_database(cl);
const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
+ const char *url = session_setting_oneval(sdb, PZ_URL);
if (zproxy && zproxy[0] == '\0')
zproxy = 0;
- co = client_get_connection(cl);
+ if (!url || !*url)
+ url = sdb->database->id;
- yaz_log(YLOG_DEBUG, "Client prep %s", client_get_url(cl));
+ yaz_log(YLOG_DEBUG, "client_prep_connection: target=%s url=%s",
+ client_get_id(cl), url);
+ co = client_get_connection(cl);
+ if (co)
+ return 2;
if (!co)
{
- // See if someone else has an idle connection
- // We should look at timestamps here to select the longest-idle connection
- for (co = host->connections; co; co = co->next)
- if (co->state == Conn_Open &&
- (!co->client || client_get_session(co->client) != se) &&
- !strcmp(co->authentication,
- session_setting_oneval(client_get_database(cl),
- PZ_AUTHENTICATION)))
- {
- if (zproxy == 0 && co->zproxy == 0)
- break;
- if (zproxy && co->zproxy && !strcmp(zproxy, co->zproxy))
- break;
- }
- if (co)
- {
- connection_release(co);
- client_set_connection(cl, co);
- co->client = cl;
- }
- else
- co = connection_create(cl);
+ co = connection_create(cl, url, zproxy,
+ operation_timeout, session_timeout,
+ iochan_man);
}
- if (co)
- {
- if (co->state == Conn_Connecting)
- {
- client_set_state(cl, Client_Connecting);
- iochan_setflag(co->iochan, EVENT_OUTPUT);
- }
- else if (co->state == Conn_Open)
- {
- if (client_get_state(cl) == Client_Error
- || client_get_state(cl) == Client_Disconnected
- || client_get_state(cl) == Client_Idle)
- client_set_state(cl, Client_Continue);
- iochan_setflag(co->iochan, EVENT_OUTPUT);
- }
+
+ if (co && co->link)
return 1;
- }
else
return 0;
}
-
-
/*
* Local variables:
* c-basic-offset: 4
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
* End:
* vim: shiftwidth=4 tabstop=8 expandtab
*/
+