src/client.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 client.c
  21     \brief Z39.50 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 #if HAVE_NETDB_H
  41 #include <netdb.h>
  42 #endif
  43 #include <signal.h>
  44 #include <ctype.h>
  45 #include <assert.h>
  46
  47 #include <yaz/marcdisp.h>
  48 #include <yaz/comstack.h>
  49 #include <yaz/tcpip.h>
  50 #include <yaz/proto.h>
  51 #include <yaz/readconf.h>
  52 #include <yaz/pquery.h>
  53 #include <yaz/otherinfo.h>
  54 #include <yaz/yaz-util.h>
  55 #include <yaz/nmem.h>
  56 #include <yaz/query-charset.h>
  57 #include <yaz/querytowrbuf.h>
  58 #include <yaz/oid_db.h>
  59 #include <yaz/diagbib1.h>
  60 #include <yaz/snprintf.h>
  61 #include <yaz/rpn2cql.h>
  62
  63 #define USE_TIMING 0
  64 #if USE_TIMING
  65 #include <yaz/timing.h>
  66 #endif
  67
  68 #if HAVE_NETINET_IN_H
  69 #include <netinet/in.h>
  70 #endif
  71
  72 #include "pazpar2.h"
  73
  74 #include "client.h"
  75 #include "connection.h"
  76 #include "settings.h"
  77
  78 /** \brief Represents client state for a connection to one search target */
  79 struct client {
  80     struct session_database *database;
  81     struct connection *connection;
  82     struct session *session;
  83     char *pquery; // Current search
  84     char *cqlquery; // used for SRU targets only
  85     int hits;
  86     int record_offset;
  87     int setno;
  88     int requestid;            // ID of current outstanding request
  89     int diagnostic;
  90     enum client_state state;
  91     struct show_raw *show_raw;
  92     struct client *next;     // next client in session or next in free list
  93 };
  94
  95 struct show_raw {
  96     int active; // whether this request has been sent to the server
  97     int position;
  98     int binary;
  99     char *syntax;
 100     char *esn;
 101     void (*error_handler)(void *data, const char *addinfo);
 102     void (*record_handler)(void *data, const char *buf, size_t sz);
 103     void *data;
 104     struct show_raw *next;
 105 };
 106
 107 static const char *client_states[] = {
 108     "Client_Connecting",
 109     "Client_Connected",
 110     "Client_Idle",
 111     "Client_Working",
 112     "Client_Error",
 113     "Client_Failed",
 114     "Client_Disconnected",
 115     "Client_Stopped",
 116     "Client_Continue"
 117 };
 118
 119 static struct client *client_freelist = 0;
 120
 121 const char *client_get_state_str(struct client *cl)
 122 {
 123     return client_states[cl->state];
 124 }
 125
 126 enum client_state client_get_state(struct client *cl)
 127 {
 128     return cl->state;
 129 }
 130
 131 void client_set_state(struct client *cl, enum client_state st)
 132 {
 133     cl->state = st;
 134     if (cl->session)
 135     {
 136         int no_active = session_active_clients(cl->session);
 137         if (no_active == 0)
 138             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
 139     }
 140 }
 141
 142 static void client_show_raw_error(struct client *cl, const char *addinfo);
 143
 144 // Close connection and set state to error
 145 void client_fatal(struct client *cl)
 146 {
 147     yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
 148     connection_destroy(cl->connection);
 149     client_set_state(cl, Client_Error);
 150 }
 151
 152 struct connection *client_get_connection(struct client *cl)
 153 {
 154     return cl->connection;
 155 }
 156
 157 struct session_database *client_get_database(struct client *cl)
 158 {
 159     return cl->database;
 160 }
 161
 162 struct session *client_get_session(struct client *cl)
 163 {
 164     return cl->session;
 165 }
 166
 167 const char *client_get_pquery(struct client *cl)
 168 {
 169     return cl->pquery;
 170 }
 171
 172 void client_set_requestid(struct client *cl, int id)
 173 {
 174     cl->requestid = id;
 175 }
 176
 177
 178 static void client_send_raw_present(struct client *cl);
 179
 180 int client_show_raw_begin(struct client *cl, int position,
 181                           const char *syntax, const char *esn,
 182                           void *data,
 183                           void (*error_handler)(void *data, const char *addinfo),
 184                           void (*record_handler)(void *data, const char *buf,
 185                                                  size_t sz),
 186                           void **data2,
 187                           int binary)
 188 {
 189     struct show_raw *rr, **rrp;
 190     if (!cl->connection)
 191     {   /* the client has no connection */
 192         return -1;
 193     }
 194     rr = xmalloc(sizeof(*rr));
 195     *data2 = rr;
 196     rr->position = position;
 197     rr->active = 0;
 198     rr->data = data;
 199     rr->error_handler = error_handler;
 200     rr->record_handler = record_handler;
 201     rr->binary = binary;
 202     if (syntax)
 203         rr->syntax = xstrdup(syntax);
 204     else
 205         rr->syntax = 0;
 206     if (esn)
 207         rr->esn = xstrdup(esn);
 208     else
 209         rr->esn = 0;
 210     rr->next = 0;
 211
 212     for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
 213         ;
 214     *rrp = rr;
 215
 216     if (cl->state == Client_Failed)
 217     {
 218         client_show_raw_error(cl, "client failed");
 219     }
 220     else if (cl->state == Client_Disconnected)
 221     {
 222         client_show_raw_error(cl, "client disconnected");
 223     }
 224     else
 225     {
 226         client_send_raw_present(cl);
 227     }
 228     return 0;
 229 }
 230
 231 void client_show_raw_remove(struct client *cl, void *data)
 232 {
 233     struct show_raw *rr = data;
 234     struct show_raw **rrp = &cl->show_raw;
 235     while (*rrp != rr)
 236         rrp = &(*rrp)->next;
 237     if (*rrp)
 238     {
 239         *rrp = rr->next;
 240         xfree(rr);
 241     }
 242 }
 243
 244 void client_show_raw_dequeue(struct client *cl)
 245 {
 246     struct show_raw *rr = cl->show_raw;
 247
 248     cl->show_raw = rr->next;
 249     xfree(rr);
 250 }
 251
 252 static void client_show_raw_error(struct client *cl, const char *addinfo)
 253 {
 254     while (cl->show_raw)
 255     {
 256         cl->show_raw->error_handler(cl->show_raw->data, addinfo);
 257         client_show_raw_dequeue(cl);
 258     }
 259 }
 260
 261 static void client_send_raw_present(struct client *cl)
 262 {
 263     struct session_database *sdb = client_get_database(cl);
 264     struct connection *co = client_get_connection(cl);
 265     ZOOM_resultset set = connection_get_resultset(co);
 266
 267     int offset = cl->show_raw->position;
 268     const char *syntax = 0;
 269     const char *elements = 0;
 270
 271     assert(cl->show_raw);
 272     assert(set);
 273
 274     yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
 275             client_get_url(cl), 1, offset);
 276
 277     if (cl->show_raw->syntax)
 278         syntax = cl->show_raw->syntax;
 279     else
 280         syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 281     ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
 282
 283     if (cl->show_raw->esn)
 284         elements = cl->show_raw->esn;
 285     else
 286         elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 287     if (elements && *elements)
 288         ZOOM_resultset_option_set(set, "elementSetName", elements);
 289
 290     ZOOM_resultset_records(set, 0, offset-1, 1);
 291     cl->show_raw->active = 1;
 292
 293     connection_continue(co);
 294 }
 295
 296 static int nativesyntax_to_type(struct session_database *sdb, char *type)
 297 {
 298     const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
 299
 300     if (s && *s)
 301     {
 302         if (!strncmp(s, "iso2709", 7))
 303         {
 304             const char *cp = strchr(s, ';');
 305             yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
 306         }
 307         else if (!strncmp(s, "xml", 3))
 308         {
 309             strcpy(type, "xml");
 310         }
 311         else
 312             return -1;
 313         return 0;
 314     }
 315     return -1;
 316 }
 317
 318 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
 319 {
 320     const char *buf;
 321     int len;
 322     char type[80];
 323
 324     if (cl->show_raw->binary)
 325         strcpy(type, "raw");
 326     else
 327     {
 328         struct session_database *sdb = client_get_database(cl);
 329         nativesyntax_to_type(sdb, type);
 330     }
 331
 332     buf = ZOOM_record_get(rec, type, &len);
 333     cl->show_raw->record_handler(cl->show_raw->data,  buf, len);
 334     client_show_raw_dequeue(cl);
 335 }
 336
 337 void client_search_response(struct client *cl)
 338 {
 339     struct connection *co = cl->connection;
 340     struct session *se = cl->session;
 341     ZOOM_connection link = connection_get_link(co);
 342     ZOOM_resultset resultset = connection_get_resultset(co);
 343     const char *error, *addinfo;
 344
 345     if (ZOOM_connection_error(link, &error, &addinfo))
 346     {
 347         cl->hits = 0;
 348         client_set_state(cl, Client_Error);
 349         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 350             error, addinfo, client_get_url(cl));
 351     }
 352     else
 353     {
 354         cl->hits = ZOOM_resultset_size(resultset);
 355         se->total_hits += cl->hits;
 356     }
 357 }
 358
 359
 360 void client_record_response(struct client *cl)
 361 {
 362     struct connection *co = cl->connection;
 363     ZOOM_connection link = connection_get_link(co);
 364     ZOOM_resultset resultset = connection_get_resultset(co);
 365     const char *error, *addinfo;
 366
 367     if (ZOOM_connection_error(link, &error, &addinfo))
 368     {
 369         client_set_state(cl, Client_Error);
 370         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 371             error, addinfo, client_get_url(cl));
 372     }
 373     else
 374     {
 375         ZOOM_record rec = 0;
 376         const char *msg, *addinfo;
 377
 378         if (cl->show_raw && cl->show_raw->active)
 379         {
 380             if ((rec = ZOOM_resultset_record(resultset,
 381                                              cl->show_raw->position-1)))
 382             {
 383                 cl->show_raw->active = 0;
 384                 ingest_raw_record(cl, rec);
 385             }
 386             else
 387             {
 388                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 389                         cl->show_raw->position-1);
 390             }
 391         }
 392         else
 393         {
 394             int offset = cl->record_offset;
 395             if ((rec = ZOOM_resultset_record(resultset, offset)))
 396             {
 397                 cl->record_offset++;
 398                 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
 399                     yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
 400                             error, addinfo, client_get_url(cl),
 401                             cl->record_offset);
 402                 else
 403                 {
 404                     struct session_database *sdb = client_get_database(cl);
 405                     const char *xmlrec;
 406                     char type[80];
 407                     nativesyntax_to_type(sdb, type);
 408                     if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
 409                     {
 410                         if (ingest_record(cl, xmlrec, cl->record_offset))
 411                         {
 412                             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
 413                             session_alert_watch(cl->session, SESSION_WATCH_RECORD);
 414                         }
 415                         else
 416                             yaz_log(YLOG_WARN, "Failed to ingest");
 417                     }
 418                     else
 419                         yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
 420                 }
 421
 422             }
 423             else
 424             {
 425                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 426                         offset);
 427             }
 428         }
 429     }
 430 }
 431
 432 void client_start_search(struct client *cl)
 433 {
 434     struct session_database *sdb = client_get_database(cl);
 435     struct connection *co = client_get_connection(cl);
 436     ZOOM_connection link = connection_get_link(co);
 437     ZOOM_resultset rs;
 438     char *databaseName = sdb->database->databases[0];
 439     const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
 440     const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
 441     const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 442     const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 443     const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
 444     const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
 445
 446     assert(link);
 447
 448     cl->hits = -1;
 449     cl->record_offset = 0;
 450     cl->diagnostic = 0;
 451     client_set_state(cl, Client_Working);
 452
 453     if (*opt_piggyback)
 454         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
 455     else
 456         ZOOM_connection_option_set(link, "piggyback", "1");
 457     if (*opt_queryenc)
 458         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
 459     if (*opt_sru && *opt_elements)
 460         ZOOM_connection_option_set(link, "schema", opt_elements);
 461     else if (*opt_elements)
 462         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
 463     if (*opt_requestsyn)
 464         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
 465     if (*opt_maxrecs)
 466         ZOOM_connection_option_set(link, "count", opt_maxrecs);
 467     else
 468     {
 469         char n[128];
 470         sprintf(n, "%d", global_parameters.toget);
 471         ZOOM_connection_option_set(link, "count", n);
 472     }
 473     if (databaseName)
 474         ZOOM_connection_option_set(link, "databaseName", databaseName);
 475
 476     ZOOM_connection_option_set(link, "presentChunk", "20");
 477
 478     if (cl->cqlquery)
 479     {
 480         ZOOM_query q = ZOOM_query_create();
 481         ZOOM_query_cql(q, cl->cqlquery);
 482         rs = ZOOM_connection_search(link, q);
 483         ZOOM_query_destroy(q);
 484     }
 485     else
 486         rs = ZOOM_connection_search_pqf(link, cl->pquery);
 487     connection_set_resultset(co, rs);
 488     connection_continue(co);
 489 }
 490
 491 struct client *client_create(void)
 492 {
 493     struct client *r;
 494     if (client_freelist)
 495     {
 496         r = client_freelist;
 497         client_freelist = client_freelist->next;
 498     }
 499     else
 500         r = xmalloc(sizeof(struct client));
 501     r->pquery = 0;
 502     r->cqlquery = 0;
 503     r->database = 0;
 504     r->connection = 0;
 505     r->session = 0;
 506     r->hits = 0;
 507     r->record_offset = 0;
 508     r->setno = 0;
 509     r->requestid = -1;
 510     r->diagnostic = 0;
 511     r->state = Client_Disconnected;
 512     r->show_raw = 0;
 513     r->next = 0;
 514     return r;
 515 }
 516
 517 void client_destroy(struct client *c)
 518 {
 519     struct session *se = c->session;
 520     if (c == se->clients)
 521         se->clients = c->next;
 522     else
 523     {
 524         struct client *cc;
 525         for (cc = se->clients; cc && cc->next != c; cc = cc->next)
 526             ;
 527         if (cc)
 528             cc->next = c->next;
 529     }
 530     xfree(c->pquery);
 531     xfree(c->cqlquery);
 532
 533     if (c->connection)
 534         connection_release(c->connection);
 535     c->next = client_freelist;
 536     client_freelist = c;
 537 }
 538
 539 void client_set_connection(struct client *cl, struct connection *con)
 540 {
 541     cl->connection = con;
 542 }
 543
 544 void client_disconnect(struct client *cl)
 545 {
 546     if (cl->state != Client_Idle)
 547         client_set_state(cl, Client_Disconnected);
 548     client_set_connection(cl, 0);
 549 }
 550
 551 // Extract terms from query into null-terminated termlist
 552 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
 553 {
 554     int num = 0;
 555
 556     pull_terms(nmem, query, termlist, &num);
 557     termlist[num] = 0;
 558 }
 559
 560 // Initialize CCL map for a target
 561 static CCL_bibset prepare_cclmap(struct client *cl)
 562 {
 563     struct session_database *sdb = client_get_database(cl);
 564     struct setting *s;
 565     CCL_bibset res;
 566
 567     if (!sdb->settings)
 568         return 0;
 569     res = ccl_qual_mk();
 570     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
 571     {
 572         char *p = strchr(s->name + 3, ':');
 573         if (!p)
 574         {
 575             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
 576             ccl_qual_rm(&res);
 577             return 0;
 578         }
 579         p++;
 580         ccl_qual_fitem(res, s->value, p);
 581     }
 582     return res;
 583 }
 584
 585 // returns a xmalloced CQL query corresponding to the pquery in client
 586 static char *make_cqlquery(struct client *cl)
 587 {
 588     cql_transform_t cqlt = cql_transform_create();
 589     Z_RPNQuery *zquery;
 590     char *r;
 591     WRBUF wrb = wrbuf_alloc();
 592     int status;
 593
 594     zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
 595     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
 596     {
 597         yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
 598         return 0;
 599     }
 600     r = xstrdup(wrbuf_cstr(wrb));
 601
 602     wrbuf_destroy(wrb);
 603     odr_reset(global_parameters.odr_out); // releases the zquery
 604     cql_transform_close(cqlt);
 605     return r;
 606 }
 607
 608 // Parse the query given the settings specific to this client
 609 int client_parse_query(struct client *cl, const char *query)
 610 {
 611     struct session *se = client_get_session(cl);
 612     struct session_database *sdb = client_get_database(cl);
 613     struct ccl_rpn_node *cn;
 614     int cerror, cpos;
 615     CCL_bibset ccl_map = prepare_cclmap(cl);
 616     const char *sru = session_setting_oneval(sdb, PZ_SRU);
 617
 618     if (!ccl_map)
 619         return -1;
 620
 621     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
 622     ccl_qual_rm(&ccl_map);
 623     if (!cn)
 624     {
 625         client_set_state(cl, Client_Error);
 626         yaz_log(YLOG_WARN, "Failed to parse query for %s",
 627                          client_get_database(cl)->database->url);
 628         return -1;
 629     }
 630     wrbuf_rewind(se->wrbuf);
 631     ccl_pquery(se->wrbuf, cn);
 632     xfree(cl->pquery);
 633     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
 634
 635     xfree(cl->cqlquery);
 636     if (*sru)
 637     {
 638         if (!(cl->cqlquery = make_cqlquery(cl)))
 639             return -1;
 640     }
 641     else
 642         cl->cqlquery = 0;
 643
 644     if (!se->relevance)
 645     {
 646         // Initialize relevance structure with query terms
 647         char *p[512];
 648         extract_terms(se->nmem, cn, p);
 649         se->relevance = relevance_create(
 650             global_parameters.server->relevance_pct,
 651             se->nmem, (const char **) p,
 652             se->expected_maxrecs);
 653     }
 654
 655     ccl_rpn_delete(cn);
 656     return 0;
 657 }
 658
 659 void client_set_session(struct client *cl, struct session *se)
 660 {
 661     cl->session = se;
 662     cl->next = se->clients;
 663     se->clients = cl;
 664 }
 665
 666 int client_is_active(struct client *cl)
 667 {
 668     if (cl->connection && (cl->state == Client_Continue ||
 669                            cl->state == Client_Connecting ||
 670                            cl->state == Client_Working))
 671         return 1;
 672     return 0;
 673 }
 674
 675 struct client *client_next_in_session(struct client *cl)
 676 {
 677     if (cl)
 678         return cl->next;
 679     return 0;
 680
 681 }
 682
 683 int client_get_hits(struct client *cl)
 684 {
 685     return cl->hits;
 686 }
 687
 688 int client_get_num_records(struct client *cl)
 689 {
 690     return cl->record_offset;
 691 }
 692
 693 int client_get_diagnostic(struct client *cl)
 694 {
 695     return cl->diagnostic;
 696 }
 697
 698 void client_set_database(struct client *cl, struct session_database *db)
 699 {
 700     cl->database = db;
 701 }
 702
 703 struct host *client_get_host(struct client *cl)
 704 {
 705     return client_get_database(cl)->database->host;
 706 }
 707
 708 const char *client_get_url(struct client *cl)
 709 {
 710     return client_get_database(cl)->database->url;
 711 }
 712
 713 /*
 714  * Local variables:
 715  * c-basic-offset: 4
 716  * indent-tabs-mode: nil
 717  * End:
 718  * vim: shiftwidth=4 tabstop=8 expandtab
 719  */