src/connection.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2008 Index Data
   3
   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
   7 version.
   8
   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
  12 for more details.
  13
  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
  17
  18 */
  19
  20 /** \file connection.c
  21     \brief Z39.50 connection (low-level client)
  22 */
  23
  24 #if HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <stdlib.h>
  29 #include <stdio.h>
  30 #include <string.h>
  31 #if HAVE_SYS_TIME_H
  32 #include <sys/time.h>
  33 #endif
  34 #if HAVE_UNISTD_H
  35 #include <unistd.h>
  36 #endif
  37 #if HAVE_SYS_SOCKET_H
  38 #include <sys/socket.h>
  39 #endif
  40 #ifdef WIN32
  41 #include <winsock.h>
  42 typedef int socklen_t;
  43 #endif
  44 #if HAVE_NETDB_H
  45 #include <netdb.h>
  46 #endif
  47
  48 #include <signal.h>
  49 #include <ctype.h>
  50 #include <assert.h>
  51
  52 #include <yaz/log.h>
  53 #include <yaz/comstack.h>
  54 #include <yaz/tcpip.h>
  55 #include "connection.h"
  56 #include "eventl.h"
  57 #include "pazpar2.h"
  58 #include "host.h"
  59 #include "client.h"
  60 #include "settings.h"
  61 #include "parameters.h"
  62
  63
  64 /** \brief Represents a physical, reusable  connection to a remote Z39.50 host
  65  */
  66 struct connection {
  67     IOCHAN iochan;
  68     ZOOM_connection link;
  69     ZOOM_resultset resultset;
  70     struct host *host;
  71     struct client *client;
  72     char *ibuf;
  73     int ibufsize;
  74     char *zproxy;
  75     enum {
  76         Conn_Resolving,
  77         Conn_Connecting,
  78         Conn_Open
  79     } state;
  80     struct connection *next; // next for same host or next in free list
  81 };
  82
  83 static struct connection *connection_freelist = 0;
  84
  85 static int connection_connect(struct connection *con);
  86
  87 static int connection_is_idle(struct connection *co)
  88 {
  89     ZOOM_connection link = co->link;
  90     int event;
  91
  92     if (co->state != Conn_Open || !link)
  93         return 0;
  94
  95     event = ZOOM_connection_peek_event(link);
  96     if (event == ZOOM_EVENT_NONE ||
  97                 event == ZOOM_EVENT_END)
  98         return 1;
  99     else
 100         return 0;
 101 }
 102
 103 ZOOM_connection connection_get_link(struct connection *co)
 104 {
 105     return co->link;
 106 }
 107
 108 ZOOM_resultset connection_get_resultset(struct connection *co)
 109 {
 110     return co->resultset;
 111 }
 112
 113 void connection_set_resultset(struct connection *co, ZOOM_resultset rs)
 114 {
 115     if (co->resultset)
 116         ZOOM_resultset_destroy(co->resultset);
 117     co->resultset = rs;
 118 }
 119
 120 static void remove_connection_from_host(struct connection *con)
 121 {
 122     struct connection **conp = &con->host->connections;
 123     assert(con);
 124     while (*conp)
 125     {
 126         if (*conp == con)
 127         {
 128             *conp = (*conp)->next;
 129             return;
 130         }
 131         conp = &(*conp)->next;
 132     }
 133     assert(*conp == 0);
 134 }
 135
 136 void connection_continue(struct connection *co)
 137 {
 138     yaz_log(YLOG_LOG, "connection_continue");
 139     iochan_setevent(co->iochan, EVENT_OUTPUT);
 140 }
 141
 142 // Close connection and recycle structure
 143 void connection_destroy(struct connection *co)
 144 {
 145     if (co->link)
 146     {
 147         ZOOM_connection_destroy(co->link);
 148         iochan_destroy(co->iochan);
 149     }
 150     if (co->resultset)
 151         ZOOM_resultset_destroy(co->resultset);
 152
 153     yaz_log(YLOG_DEBUG, "Connection destroy %s", co->host->hostport);
 154
 155     remove_connection_from_host(co);
 156     if (co->client)
 157     {
 158         client_disconnect(co->client);
 159     }
 160     xfree(co->zproxy);
 161     co->zproxy = 0;
 162     co->next = connection_freelist;
 163     connection_freelist = co;
 164 }
 165
 166 // Creates a new connection for client, associated with the host of
 167 // client's database
 168 static struct connection *connection_create(struct client *cl)
 169 {
 170     struct connection *new;
 171     struct host *host = client_get_host(cl);
 172
 173     if ((new = connection_freelist))
 174         connection_freelist = new->next;
 175     else
 176     {
 177         new = xmalloc(sizeof (struct connection));
 178         new->ibuf = 0;
 179         new->ibufsize = 0;
 180     }
 181     new->host = host;
 182     new->next = new->host->connections;
 183     new->host->connections = new;
 184     new->client = cl;
 185     new->zproxy = 0;
 186     client_set_connection(cl, new);
 187     new->link = 0;
 188     new->resultset = 0;
 189     new->state = Conn_Resolving;
 190     if (host->ipport)
 191         connection_connect(new);
 192     return new;
 193 }
 194
 195 static void connection_handler(IOCHAN i, int event)
 196 {
 197     struct connection *co = iochan_getdata(i);
 198     struct client *cl = co->client;
 199     struct session *se = 0;
 200
 201     if (cl)
 202         se = client_get_session(cl);
 203     else
 204     {
 205         connection_destroy(co);
 206         return;
 207     }
 208
 209     if (event & EVENT_TIMEOUT)
 210     {
 211         if (co->state == Conn_Connecting)
 212         {
 213             yaz_log(YLOG_WARN,  "connect timeout %s", client_get_url(cl));
 214             client_fatal(cl);
 215         }
 216         else
 217         {
 218             yaz_log(YLOG_LOG,  "idle timeout %s", client_get_url(cl));
 219             connection_destroy(co);
 220         }
 221         return;
 222     }
 223     else
 224     {
 225         ZOOM_connection link = co->link;
 226
 227         if (ZOOM_event(1, &link))
 228         {
 229             do
 230             {
 231                 int event = ZOOM_connection_last_event(link);
 232                 switch (event)
 233                 {
 234                 case ZOOM_EVENT_END:
 235                     client_set_state(co->client, Client_Idle);
 236                     break;
 237                 case ZOOM_EVENT_SEND_DATA:
 238                     break;
 239                 case ZOOM_EVENT_RECV_DATA:
 240                     break;
 241                 case ZOOM_EVENT_UNKNOWN:
 242                     break;
 243                 case ZOOM_EVENT_SEND_APDU:
 244                     client_set_state(co->client, Client_Working);
 245                     break;
 246                 case ZOOM_EVENT_RECV_APDU:
 247                     break;
 248                 case ZOOM_EVENT_CONNECT:
 249                     yaz_log(YLOG_LOG, "Connected to %s", client_get_url(cl));
 250                     co->state = Conn_Open;
 251                     client_set_state(co->client, Client_Connected);
 252                     iochan_settimeout(i, global_parameters.z3950_session_timeout);
 253                     break;
 254                 case ZOOM_EVENT_RECV_SEARCH:
 255                     yaz_log(YLOG_LOG, "Search response from %s", client_get_url(cl));
 256                     client_search_response(cl);
 257                     break;
 258                 case ZOOM_EVENT_RECV_RECORD:
 259                     yaz_log(YLOG_LOG, "Record from %s", client_get_url(cl));
 260                     client_record_response(cl);
 261                     break;
 262                 default:
 263                     yaz_log(YLOG_LOG, "Unhandled event (%d) from %s",
 264                             event, client_get_url(cl));
 265                 }
 266             }
 267             while (ZOOM_event_nonblock(1, &link));
 268         }
 269     }
 270 }
 271
 272
 273 // Disassociate connection from client
 274 void connection_release(struct connection *co)
 275 {
 276     struct client *cl = co->client;
 277
 278     yaz_log(YLOG_DEBUG, "Connection release %s", co->host->hostport);
 279     if (!cl)
 280         return;
 281     client_set_connection(cl, 0);
 282     co->client = 0;
 283 }
 284
 285 void connect_resolver_host(struct host *host)
 286 {
 287     struct connection *con = host->connections;
 288     while (con)
 289     {
 290         if (con->state == Conn_Resolving)
 291         {
 292             if (!host->ipport) /* unresolved */
 293             {
 294                 connection_destroy(con);
 295                 /* start all over .. at some point it will be NULL */
 296                 con = host->connections;
 297                 continue;
 298             }
 299             else if (!con->client)
 300             {
 301                 connection_destroy(con);
 302                 /* start all over .. at some point it will be NULL */
 303                 con = host->connections;
 304                 continue;
 305             }
 306             else
 307             {
 308                 connection_connect(con);
 309                 client_start_search(con->client);
 310             }
 311         }
 312         else
 313         {
 314             yaz_log(YLOG_LOG, "connect_resolver_host: state=%d", con->state);
 315         }
 316         con = con->next;
 317     }
 318 }
 319
 320 static struct host *connection_get_host(struct connection *con)
 321 {
 322     return con->host;
 323 }
 324
 325 // Callback for use by event loop
 326 // We do this because ZOOM connections don't always have (the same) sockets
 327 static int socketfun(IOCHAN c)
 328 {
 329     struct connection *co = iochan_getdata(c);
 330     if (!co->link)
 331         return -1;
 332     return ZOOM_connection_get_socket(co->link);
 333 }
 334
 335 // Because ZOOM always knows what events it is interested in; we may not
 336 static int maskfun(IOCHAN c)
 337 {
 338     struct connection *co = iochan_getdata(c);
 339     if (!co->link)
 340         return 0;
 341
 342     // This is cheating a little, and assuming that eventl mask IDs are always
 343     // the same as ZOOM-C's.
 344     return ZOOM_connection_get_mask(co->link);
 345 }
 346
 347 static int connection_connect(struct connection *con)
 348 {
 349     ZOOM_connection link = 0;
 350     struct host *host = connection_get_host(con);
 351     ZOOM_options zoptions = ZOOM_options_create();
 352     const char *auth;
 353     const char *sru;
 354     const char *sru_version = 0;
 355     char ipport[512] = "";
 356
 357     struct session_database *sdb = client_get_database(con->client);
 358     const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
 359     const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG);
 360
 361     assert(host->ipport);
 362     assert(con);
 363
 364     ZOOM_options_set(zoptions, "async", "1");
 365     ZOOM_options_set(zoptions, "implementationName",
 366             global_parameters.implementationName);
 367     ZOOM_options_set(zoptions, "implementationVersion",
 368             global_parameters.implementationVersion);
 369     if (zproxy && *zproxy)
 370     {
 371         con->zproxy = xstrdup(zproxy);
 372         ZOOM_options_set(zoptions, "proxy", zproxy);
 373     }
 374     if (apdulog && *apdulog)
 375         ZOOM_options_set(zoptions, "apdulog", apdulog);
 376
 377     if ((auth = session_setting_oneval(sdb, PZ_AUTHENTICATION)))
 378         ZOOM_options_set(zoptions, "user", auth);
 379     if ((sru = session_setting_oneval(sdb, PZ_SRU)) && *sru)
 380         ZOOM_options_set(zoptions, "sru", sru);
 381     if ((sru_version = session_setting_oneval(sdb, PZ_SRU_VERSION))
 382         && *sru_version)
 383         ZOOM_options_set(zoptions, "sru_version", sru_version);
 384
 385     if (!(link = ZOOM_connection_create(zoptions)))
 386     {
 387         yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create ZOOM Connection");
 388         ZOOM_options_destroy(zoptions);
 389         return -1;
 390     }
 391
 392     if (sru && *sru)
 393         strcpy(ipport, "http://");
 394     strcat(ipport, host->ipport);
 395     /* deal with SRU path here because databaseName option is not read in
 396        ZOOM in SRU mode */
 397     if (sru && *sru)
 398     {
 399         if (*sdb->database->databases[0])
 400         {
 401             strcat(ipport, "/");
 402             strcat(ipport, sdb->database->databases[0]);
 403         }
 404     }
 405     ZOOM_connection_connect(link, ipport, 0);
 406
 407     con->link = link;
 408     con->iochan = iochan_create(0, connection_handler, 0);
 409     con->state = Conn_Connecting;
 410     iochan_settimeout(con->iochan, global_parameters.z3950_connect_timeout);
 411     iochan_setdata(con->iochan, con);
 412     iochan_setsocketfun(con->iochan, socketfun);
 413     iochan_setmaskfun(con->iochan, maskfun);
 414     pazpar2_add_channel(con->iochan);
 415
 416     /* this fragment is bad DRY: from client_prep_connection */
 417     client_set_state(con->client, Client_Connecting);
 418     ZOOM_options_destroy(zoptions);
 419     // This creates the connection
 420     ZOOM_connection_process(link);
 421     return 0;
 422 }
 423
 424 const char *connection_get_url(struct connection *co)
 425 {
 426     return client_get_url(co->client);
 427 }
 428
 429 // Ensure that client has a connection associated
 430 int client_prep_connection(struct client *cl)
 431 {
 432     struct connection *co;
 433     struct session *se = client_get_session(cl);
 434     struct host *host = client_get_host(cl);
 435     struct session_database *sdb = client_get_database(cl);
 436     const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
 437
 438     if (zproxy && zproxy[0] == '\0')
 439         zproxy = 0;
 440
 441     co = client_get_connection(cl);
 442
 443     yaz_log(YLOG_DEBUG, "Client prep %s", client_get_url(cl));
 444
 445     if (!co)
 446     {
 447         // See if someone else has an idle connection
 448         // We should look at timestamps here to select the longest-idle connection
 449         for (co = host->connections; co; co = co->next)
 450             if (connection_is_idle(co) &&
 451                 (!co->client || client_get_session(co->client) != se) &&
 452                 !strcmp(ZOOM_connection_option_get(co->link, "user"),
 453                         session_setting_oneval(client_get_database(cl),
 454                                                PZ_AUTHENTICATION)))
 455             {
 456                 if (zproxy == 0 && co->zproxy == 0)
 457                     break;
 458                 if (zproxy && co->zproxy && !strcmp(zproxy, co->zproxy))
 459                     break;
 460             }
 461         if (co)
 462         {
 463             connection_release(co);
 464             client_set_connection(cl, co);
 465             co->client = cl;
 466         }
 467         else
 468             co = connection_create(cl);
 469     }
 470
 471     if (co && co->link)
 472         return 1;
 473     else
 474         return 0;
 475 }
 476
 477 /*
 478  * Local variables:
 479  * c-basic-offset: 4
 480  * indent-tabs-mode: nil
 481  * End:
 482  * vim: shiftwidth=4 tabstop=8 expandtab
 483  */