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