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