src/client.c

   1 /* $Id: client.c,v 1.17 2007-08-17 12:25:26 adam Exp $
   2    Copyright (c) 2006-2007, Index Data.
   3
   4 This file is part of Pazpar2.
   5
   6 Pazpar2 is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Pazpar2; see the file LICENSE.  If not, write to the
  18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.
  20  */
  21
  22 /** \file client.c
  23     \brief Z39.50 client
  24 */
  25
  26 #include <stdlib.h>
  27 #include <stdio.h>
  28 #include <string.h>
  29 #include <sys/time.h>
  30 #include <unistd.h>
  31 #include <sys/socket.h>
  32 #include <netdb.h>
  33 #include <signal.h>
  34 #include <ctype.h>
  35 #include <assert.h>
  36
  37 #include <yaz/marcdisp.h>
  38 #include <yaz/comstack.h>
  39 #include <yaz/tcpip.h>
  40 #include <yaz/proto.h>
  41 #include <yaz/readconf.h>
  42 #include <yaz/pquery.h>
  43 #include <yaz/otherinfo.h>
  44 #include <yaz/yaz-util.h>
  45 #include <yaz/nmem.h>
  46 #include <yaz/query-charset.h>
  47 #include <yaz/querytowrbuf.h>
  48 #include <yaz/oid_db.h>
  49 #include <yaz/diagbib1.h>
  50
  51 #if HAVE_CONFIG_H
  52 #include "cconfig.h"
  53 #endif
  54
  55 #define USE_TIMING 0
  56 #if USE_TIMING
  57 #include <yaz/timing.h>
  58 #endif
  59
  60 #include <netinet/in.h>
  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     int hits;
  75     int records;
  76     int setno;
  77     int requestid;            // ID of current outstanding request
  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     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 };
  93
  94 static const char *client_states[] = {
  95     "Client_Connecting",
  96     "Client_Connected",
  97     "Client_Idle",
  98     "Client_Initializing",
  99     "Client_Searching",
 100     "Client_Presenting",
 101     "Client_Error",
 102     "Client_Failed",
 103     "Client_Disconnected",
 104     "Client_Stopped"
 105 };
 106
 107 static struct client *client_freelist = 0;
 108
 109 static int send_apdu(struct client *c, Z_APDU *a)
 110 {
 111     struct session_database *sdb = client_get_database(c);
 112     const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG);
 113     if (apdulog && *apdulog && *apdulog != '0')
 114     {
 115         ODR p = odr_createmem(ODR_PRINT);
 116         yaz_log(YLOG_LOG, "send APDU %s", client_get_url(c));
 117
 118         odr_setprint(p, yaz_log_file());
 119         z_APDU(p, &a, 0, 0);
 120         odr_setprint(p, stderr);
 121         odr_destroy(p);
 122     }
 123     return connection_send_apdu(client_get_connection(c), a);
 124 }
 125
 126
 127 const char *client_get_state_str(struct client *cl)
 128 {
 129     return client_states[cl->state];
 130 }
 131
 132 enum client_state client_get_state(struct client *cl)
 133 {
 134     return cl->state;
 135 }
 136
 137 void client_set_state(struct client *cl, enum client_state st)
 138 {
 139     cl->state = st;
 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     client_show_raw_error(cl, "client connection failure");
 148     yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
 149     connection_destroy(cl->connection);
 150     cl->state = Client_Error;
 151 }
 152
 153
 154 static int diag_to_wrbuf(Z_DiagRec **pp, int num, WRBUF w)
 155 {
 156     int code = 0;
 157     int i;
 158     for (i = 0; i<num; i++)
 159     {
 160         Z_DiagRec *p = pp[i];
 161         if (i)
 162             wrbuf_puts(w, "; ");
 163         if (p->which != Z_DiagRec_defaultFormat)
 164         {
 165             wrbuf_puts(w, "? Not in default format");
 166         }
 167         else
 168         {
 169             Z_DefaultDiagFormat *r = p->u.defaultFormat;
 170
 171             if (!r->diagnosticSetId)
 172                 wrbuf_puts(w, "? Missing diagset");
 173             else
 174             {
 175                 oid_class oclass;
 176                 char diag_name_buf[OID_STR_MAX];
 177                 const char *diag_name = 0;
 178                 diag_name = yaz_oid_to_string_buf
 179                     (r->diagnosticSetId, &oclass, diag_name_buf);
 180                 wrbuf_puts(w, diag_name);
 181             }
 182             if (!code)
 183                 code = *r->condition;
 184             wrbuf_printf(w, " %d %s", *r->condition,
 185                          diagbib1_str(*r->condition));
 186             switch (r->which)
 187             {
 188             case Z_DefaultDiagFormat_v2Addinfo:
 189                 wrbuf_printf(w, " -- v2 addinfo '%s'", r->u.v2Addinfo);
 190                 break;
 191             case Z_DefaultDiagFormat_v3Addinfo:
 192                 wrbuf_printf(w, " -- v3 addinfo '%s'", r->u.v3Addinfo);
 193                 break;
 194             }
 195         }
 196     }
 197     return code;
 198 }
 199
 200
 201
 202 struct connection *client_get_connection(struct client *cl)
 203 {
 204     return cl->connection;
 205 }
 206
 207 struct session_database *client_get_database(struct client *cl)
 208 {
 209     return cl->database;
 210 }
 211
 212 struct session *client_get_session(struct client *cl)
 213 {
 214     return cl->session;
 215 }
 216
 217 const char *client_get_pquery(struct client *cl)
 218 {
 219     return cl->pquery;
 220 }
 221
 222 void client_set_requestid(struct client *cl, int id)
 223 {
 224     cl->requestid = id;
 225 }
 226
 227 int client_show_raw_begin(struct client *cl, int position,
 228                           const char *syntax, const char *esn,
 229                           void *data,
 230                           void (*error_handler)(void *data, const char *addinfo),
 231                           void (*record_handler)(void *data, const char *buf,
 232                                                  size_t sz))
 233 {
 234     if (cl->show_raw)
 235         return -1;
 236     cl->show_raw = xmalloc(sizeof(*cl->show_raw));
 237     cl->show_raw->position = position;
 238     cl->show_raw->active = 0;
 239     cl->show_raw->data = data;
 240     cl->show_raw->error_handler = error_handler;
 241     cl->show_raw->record_handler = record_handler;
 242     if (syntax)
 243         cl->show_raw->syntax = xstrdup(syntax);
 244     else
 245         cl->show_raw->syntax = 0;
 246     if (esn)
 247         cl->show_raw->esn = xstrdup(esn);
 248     else
 249         cl->show_raw->esn = 0;
 250
 251
 252     if (cl->state == Client_Failed)
 253     {
 254         client_show_raw_error(cl, "client failed");
 255     }
 256     else if (cl->state == Client_Disconnected)
 257     {
 258         client_show_raw_error(cl, "client disconnected");
 259     }
 260     else
 261     {
 262         client_continue(cl);
 263     }
 264     return 0;
 265 }
 266
 267 void client_show_raw_reset(struct client *cl)
 268 {
 269     xfree(cl->show_raw);
 270     cl->show_raw = 0;
 271 }
 272
 273 static void client_show_raw_error(struct client *cl, const char *addinfo)
 274 {
 275     if (cl->show_raw)
 276     {
 277         cl->show_raw->error_handler(cl->show_raw->data, addinfo);
 278         client_show_raw_reset(cl);
 279     }
 280 }
 281
 282 static void client_show_raw_cancel(struct client *cl)
 283 {
 284     if (cl->show_raw)
 285     {
 286         cl->show_raw->error_handler(cl->show_raw->data, "cancel");
 287         client_show_raw_reset(cl);
 288     }
 289 }
 290
 291 static void client_present_syntax(Z_APDU *a, const char *syntax)
 292 {
 293     // empty string for syntax OMITS preferredRecordSyntax (OPTIONAL)
 294     if (syntax && *syntax)
 295         a->u.presentRequest->preferredRecordSyntax =
 296             yaz_string_to_oid_odr(yaz_oid_std(),
 297                                   CLASS_RECSYN, syntax,
 298                                   global_parameters.odr_out);
 299 }
 300
 301 static void client_present_elements(Z_APDU *a, const char *elements)
 302 {
 303     if (elements && *elements)  // element set is optional
 304     {
 305         Z_ElementSetNames *elementSetNames =
 306             odr_malloc(global_parameters.odr_out, sizeof(*elementSetNames));
 307         Z_RecordComposition *compo =
 308             odr_malloc(global_parameters.odr_out, sizeof(*compo));
 309         a->u.presentRequest->recordComposition = compo;
 310
 311         compo->which = Z_RecordComp_simple;
 312         compo->u.simple = elementSetNames;
 313
 314         elementSetNames->which = Z_ElementSetNames_generic;
 315         elementSetNames->u.generic =
 316             odr_strdup(global_parameters.odr_out, elements);
 317     }
 318 }
 319
 320 void client_send_raw_present(struct client *cl)
 321 {
 322     struct session_database *sdb = client_get_database(cl);
 323     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest);
 324     int toget = 1;
 325     int start = cl->show_raw->position;
 326     const char *syntax = 0;
 327     const char *elements = 0;
 328
 329     assert(cl->show_raw);
 330
 331     yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
 332             client_get_url(cl), toget, start);
 333
 334     a->u.presentRequest->resultSetStartPoint = &start;
 335     a->u.presentRequest->numberOfRecordsRequested = &toget;
 336
 337     if (cl->show_raw->syntax)
 338         syntax = cl->show_raw->syntax;
 339     else
 340         syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 341
 342     client_present_syntax(a, syntax);
 343     if (cl->show_raw->esn)
 344         elements = cl->show_raw->esn;
 345     else
 346         elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 347     client_present_elements(a, elements);
 348
 349     if (send_apdu(cl, a) >= 0)
 350     {
 351         cl->show_raw->active = 1;
 352         cl->state = Client_Presenting;
 353     }
 354     else
 355     {
 356         client_show_raw_error(cl, "send_apdu failed");
 357         cl->state = Client_Error;
 358     }
 359     odr_reset(global_parameters.odr_out);
 360 }
 361
 362 void client_send_present(struct client *cl)
 363 {
 364     struct session_database *sdb = client_get_database(cl);
 365     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest);
 366     int toget;
 367     int start = cl->records + 1;
 368     const char *syntax = 0;
 369     const char *elements = 0;
 370
 371     toget = global_parameters.chunk;
 372     if (toget > global_parameters.toget - cl->records)
 373         toget = global_parameters.toget - cl->records;
 374     if (toget > cl->hits - cl->records)
 375         toget = cl->hits - cl->records;
 376
 377     yaz_log(YLOG_DEBUG, "Trying to present %d record(s) from %d",
 378             toget, start);
 379
 380     a->u.presentRequest->resultSetStartPoint = &start;
 381     a->u.presentRequest->numberOfRecordsRequested = &toget;
 382
 383     syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 384     client_present_syntax(a, syntax);
 385
 386     elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 387     client_present_elements(a, elements);
 388
 389     if (send_apdu(cl, a) >= 0)
 390         cl->state = Client_Presenting;
 391     else
 392         cl->state = Client_Error;
 393     odr_reset(global_parameters.odr_out);
 394 }
 395
 396
 397 void client_send_search(struct client *cl)
 398 {
 399     struct session *se = client_get_session(cl);
 400     struct session_database *sdb = client_get_database(cl);
 401     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_searchRequest);
 402     int ndb;
 403     char **databaselist;
 404     Z_Query *zquery;
 405     int ssub = 0, lslb = 100000, mspn = 10;
 406     char *piggyback = 0;
 407     char *queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
 408
 409     yaz_log(YLOG_DEBUG, "Sending search to %s", sdb->database->url);
 410
 411
 412     // constructing RPN query
 413     a->u.searchRequest->query = zquery = odr_malloc(global_parameters.odr_out,
 414                                                     sizeof(Z_Query));
 415     zquery->which = Z_Query_type_1;
 416     zquery->u.type_1 = p_query_rpn(global_parameters.odr_out,
 417                                    client_get_pquery(cl));
 418
 419     // converting to target encoding
 420     if (queryenc && *queryenc)
 421     {
 422         yaz_iconv_t iconv = yaz_iconv_open(queryenc, "UTF-8");
 423         if (iconv){
 424             yaz_query_charset_convert_rpnquery(zquery->u.type_1,
 425                                                global_parameters.odr_out,
 426                                                iconv);
 427             yaz_iconv_close(iconv);
 428         } else
 429             yaz_log(YLOG_WARN, "Query encoding failed %s %s",
 430                     client_get_database(cl)->database->url, queryenc);
 431     }
 432
 433     for (ndb = 0; sdb->database->databases[ndb]; ndb++)
 434         ;
 435     databaselist = odr_malloc(global_parameters.odr_out, sizeof(char*) * ndb);
 436     for (ndb = 0; sdb->database->databases[ndb]; ndb++)
 437         databaselist[ndb] = sdb->database->databases[ndb];
 438
 439     if (!(piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK))
 440         || *piggyback == '1')
 441     {
 442         const char *elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 443         const char *recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 444         if (recsyn && *recsyn)
 445         {
 446             a->u.searchRequest->preferredRecordSyntax =
 447                 yaz_string_to_oid_odr(yaz_oid_std(),
 448                                       CLASS_RECSYN, recsyn,
 449                                       global_parameters.odr_out);
 450         }
 451         if (elements && *elements)
 452         {
 453             Z_ElementSetNames *esn =
 454                 odr_malloc(global_parameters.odr_out, sizeof(*esn));
 455             esn->which = Z_ElementSetNames_generic;
 456             esn->u.generic = odr_strdup(global_parameters.odr_out, elements);
 457
 458             a->u.searchRequest->smallSetElementSetNames = esn;
 459             a->u.searchRequest->mediumSetElementSetNames = esn;
 460         }
 461         a->u.searchRequest->smallSetUpperBound = &ssub;
 462         a->u.searchRequest->largeSetLowerBound = &lslb;
 463         a->u.searchRequest->mediumSetPresentNumber = &mspn;
 464     }
 465     a->u.searchRequest->databaseNames = databaselist;
 466     a->u.searchRequest->num_databaseNames = ndb;
 467
 468
 469     {  //scope for sending and logging queries
 470         WRBUF wbquery = wrbuf_alloc();
 471         yaz_query_to_wrbuf(wbquery, a->u.searchRequest->query);
 472
 473
 474         if (send_apdu(cl, a) >= 0)
 475         {
 476             client_set_state(cl, Client_Searching);
 477             client_set_requestid(cl, se->requestid);
 478             yaz_log(YLOG_LOG, "SearchRequest %s %s %s",
 479                     client_get_database(cl)->database->url,
 480                     queryenc ? queryenc : "UTF-8",
 481                     wrbuf_cstr(wbquery));
 482         }
 483         else {
 484             client_set_state(cl, Client_Error);
 485             yaz_log(YLOG_WARN, "Failed SearchRequest %s  %s %s",
 486                     client_get_database(cl)->database->url,
 487                     queryenc ? queryenc : "UTF-8",
 488                     wrbuf_cstr(wbquery));
 489         }
 490
 491         wrbuf_destroy(wbquery);
 492     }
 493
 494     odr_reset(global_parameters.odr_out);
 495 }
 496
 497 void client_init_response(struct client *cl, Z_APDU *a)
 498 {
 499     Z_InitResponse *r = a->u.initResponse;
 500
 501     yaz_log(YLOG_DEBUG, "Init response %s", cl->database->database->url);
 502
 503     if (*r->result)
 504         cl->state = Client_Idle;
 505     else
 506         cl->state = Client_Failed; // FIXME need to do something to the connection
 507 }
 508
 509
 510 static void ingest_raw_records(struct client *cl, Z_Records *r)
 511 {
 512     Z_NamePlusRecordList *rlist;
 513     Z_NamePlusRecord *npr;
 514     xmlDoc *doc;
 515     xmlChar *buf_out;
 516     int len_out;
 517     if (r->which != Z_Records_DBOSD)
 518     {
 519         client_show_raw_error(cl, "non-surrogate diagnostics");
 520         return;
 521     }
 522
 523     rlist = r->u.databaseOrSurDiagnostics;
 524     if (rlist->num_records != 1 || !rlist->records || !rlist->records[0])
 525     {
 526         client_show_raw_error(cl, "no records");
 527         return;
 528     }
 529     npr = rlist->records[0];
 530     if (npr->which != Z_NamePlusRecord_databaseRecord)
 531     {
 532         client_show_raw_error(cl, "surrogate diagnostic");
 533         return;
 534     }
 535
 536     doc = record_to_xml(client_get_database(cl), npr->u.databaseRecord);
 537     if (!doc)
 538     {
 539         client_show_raw_error(cl, "unable to convert record to xml");
 540         return;
 541     }
 542
 543     xmlDocDumpMemory(doc, &buf_out, &len_out);
 544     xmlFreeDoc(doc);
 545
 546     cl->show_raw->record_handler(cl->show_raw->data,
 547                                  (const char *) buf_out, len_out);
 548
 549     xmlFree(buf_out);
 550     xfree(cl->show_raw);
 551     cl->show_raw = 0;
 552 }
 553
 554 static void ingest_records(struct client *cl, Z_Records *r)
 555 {
 556 #if USE_TIMING
 557     yaz_timing_t t = yaz_timing_create();
 558 #endif
 559     struct record *rec;
 560     struct session *s = client_get_session(cl);
 561     Z_NamePlusRecordList *rlist;
 562     int i;
 563
 564     if (r->which != Z_Records_DBOSD)
 565         return;
 566     rlist = r->u.databaseOrSurDiagnostics;
 567     for (i = 0; i < rlist->num_records; i++)
 568     {
 569         Z_NamePlusRecord *npr = rlist->records[i];
 570
 571         cl->records++;
 572         if (npr->which != Z_NamePlusRecord_databaseRecord)
 573         {
 574             yaz_log(YLOG_WARN,
 575                     "Unexpected record type, probably diagnostic %s",
 576                     cl->database->database->url);
 577             continue;
 578         }
 579
 580         rec = ingest_record(cl, npr->u.databaseRecord, cl->records);
 581         if (!rec)
 582             continue;
 583     }
 584     if (rlist->num_records)
 585         session_alert_watch(s, SESSION_WATCH_RECORDS);
 586
 587 #if USE_TIMING
 588     yaz_timing_stop(t);
 589     yaz_log(YLOG_LOG, "ingest_records %6.5f %3.2f %3.2f",
 590             yaz_timing_get_real(t), yaz_timing_get_user(t),
 591             yaz_timing_get_sys(t));
 592     yaz_timing_destroy(&t);
 593 #endif
 594 }
 595
 596
 597 void client_search_response(struct client *cl, Z_APDU *a)
 598 {
 599     struct session *se = cl->session;
 600     Z_SearchResponse *r = a->u.searchResponse;
 601
 602     yaz_log(YLOG_DEBUG, "Search response %s (status=%d)",
 603             cl->database->database->url, *r->searchStatus);
 604
 605     if (*r->searchStatus)
 606     {
 607         cl->hits = *r->resultCount;
 608         se->total_hits += cl->hits;
 609         if (r->presentStatus && !*r->presentStatus && r->records)
 610         {
 611             yaz_log(YLOG_DEBUG, "Records in search response %s",
 612                     cl->database->database->url);
 613             ingest_records(cl, r->records);
 614         }
 615         cl->state = Client_Idle;
 616     }
 617     else
 618     {          /*"FAILED"*/
 619         Z_Records *recs = r->records;
 620         cl->hits = 0;
 621         cl->state = Client_Error;
 622         if (recs && recs->which == Z_Records_NSD)
 623         {
 624             WRBUF w = wrbuf_alloc();
 625
 626             Z_DiagRec dr, *dr_p = &dr;
 627             dr.which = Z_DiagRec_defaultFormat;
 628             dr.u.defaultFormat = recs->u.nonSurrogateDiagnostic;
 629
 630             wrbuf_printf(w, "Search response NSD %s: ",
 631                          cl->database->database->url);
 632
 633             cl->diagnostic = diag_to_wrbuf(&dr_p, 1, w);
 634
 635             yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
 636
 637             cl->state = Client_Error;
 638             wrbuf_destroy(w);
 639         }
 640         else if (recs && recs->which == Z_Records_multipleNSD)
 641         {
 642             WRBUF w = wrbuf_alloc();
 643
 644             wrbuf_printf(w, "Search response multipleNSD %s: ",
 645                          cl->database->database->url);
 646             cl->diagnostic =
 647                 diag_to_wrbuf(recs->u.multipleNonSurDiagnostics->diagRecs,
 648                               recs->u.multipleNonSurDiagnostics->num_diagRecs,
 649                               w);
 650             yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
 651             cl->state = Client_Error;
 652             wrbuf_destroy(w);
 653         }
 654     }
 655 }
 656
 657 void client_present_response(struct client *cl, Z_APDU *a)
 658 {
 659     Z_PresentResponse *r = a->u.presentResponse;
 660     Z_Records *recs = r->records;
 661
 662     if (recs && recs->which == Z_Records_NSD)
 663     {
 664         WRBUF w = wrbuf_alloc();
 665
 666         Z_DiagRec dr, *dr_p = &dr;
 667         dr.which = Z_DiagRec_defaultFormat;
 668         dr.u.defaultFormat = recs->u.nonSurrogateDiagnostic;
 669
 670         wrbuf_printf(w, "Present response NSD %s: ",
 671                      cl->database->database->url);
 672
 673         cl->diagnostic = diag_to_wrbuf(&dr_p, 1, w);
 674
 675         yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
 676
 677         cl->state = Client_Error;
 678         wrbuf_destroy(w);
 679
 680         client_show_raw_error(cl, "non surrogate diagnostics");
 681     }
 682     else if (recs && recs->which == Z_Records_multipleNSD)
 683     {
 684         WRBUF w = wrbuf_alloc();
 685
 686         wrbuf_printf(w, "Present response multipleNSD %s: ",
 687                      cl->database->database->url);
 688         cl->diagnostic =
 689             diag_to_wrbuf(recs->u.multipleNonSurDiagnostics->diagRecs,
 690                           recs->u.multipleNonSurDiagnostics->num_diagRecs,
 691                           w);
 692         yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
 693         cl->state = Client_Error;
 694         wrbuf_destroy(w);
 695     }
 696     else if (recs && !*r->presentStatus && cl->state != Client_Error)
 697     {
 698         yaz_log(YLOG_DEBUG, "Good Present response %s",
 699                 cl->database->database->url);
 700
 701         // we can mix show raw and normal show ..
 702         if (cl->show_raw && cl->show_raw->active)
 703         {
 704             cl->show_raw->active = 0; // no longer active
 705             ingest_raw_records(cl, recs);
 706         }
 707         else
 708             ingest_records(cl, recs);
 709         cl->state = Client_Idle;
 710     }
 711     else if (*r->presentStatus)
 712     {
 713         yaz_log(YLOG_WARN, "Bad Present response %s",
 714                 cl->database->database->url);
 715         cl->state = Client_Error;
 716         client_show_raw_error(cl, "bad present response");
 717     }
 718 }
 719
 720 void client_close_response(struct client *cl, Z_APDU *a)
 721 {
 722     struct connection *co = cl->connection;
 723     /* Z_Close *r = a->u.close; */
 724
 725     yaz_log(YLOG_WARN, "Close response %s", cl->database->database->url);
 726
 727     cl->state = Client_Failed;
 728     connection_destroy(co);
 729 }
 730
 731 int client_is_our_response(struct client *cl)
 732 {
 733     struct session *se = client_get_session(cl);
 734
 735     if (cl && (cl->requestid == se->requestid ||
 736                cl->state == Client_Initializing))
 737         return 1;
 738     return 0;
 739 }
 740
 741 // Set authentication token in init if one is set for the client
 742 // TODO: Extend this to handle other schemes than open (should be simple)
 743 static void init_authentication(struct client *cl, Z_InitRequest *req)
 744 {
 745     struct session_database *sdb = client_get_database(cl);
 746     char *auth = session_setting_oneval(sdb, PZ_AUTHENTICATION);
 747
 748     if (*auth)
 749     {
 750         struct connection *co = client_get_connection(cl);
 751         struct session *se = client_get_session(cl);
 752         Z_IdAuthentication *idAuth = odr_malloc(global_parameters.odr_out,
 753                 sizeof(*idAuth));
 754         idAuth->which = Z_IdAuthentication_open;
 755         idAuth->u.open = auth;
 756         req->idAuthentication = idAuth;
 757         connection_set_authentication(co, nmem_strdup(se->session_nmem, auth));
 758     }
 759 }
 760
 761 static void init_zproxy(struct client *cl, Z_InitRequest *req)
 762 {
 763     struct session_database *sdb = client_get_database(cl);
 764     char *ztarget = sdb->database->url;
 765     //char *ztarget = sdb->url;
 766     char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
 767
 768     if (*zproxy)
 769         yaz_oi_set_string_oid(&req->otherInfo,
 770                               global_parameters.odr_out,
 771                               yaz_oid_userinfo_proxy,
 772                               1, ztarget);
 773 }
 774
 775
 776 static void client_init_request(struct client *cl)
 777 {
 778     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_initRequest);
 779
 780     a->u.initRequest->implementationId = global_parameters.implementationId;
 781     a->u.initRequest->implementationName = global_parameters.implementationName;
 782     a->u.initRequest->implementationVersion =
 783         global_parameters.implementationVersion;
 784     ODR_MASK_SET(a->u.initRequest->options, Z_Options_search);
 785     ODR_MASK_SET(a->u.initRequest->options, Z_Options_present);
 786     ODR_MASK_SET(a->u.initRequest->options, Z_Options_namedResultSets);
 787
 788     ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_1);
 789     ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_2);
 790     ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_3);
 791
 792     init_authentication(cl, a->u.initRequest);
 793     init_zproxy(cl, a->u.initRequest);
 794
 795     if (send_apdu(cl, a) >= 0)
 796         client_set_state(cl, Client_Initializing);
 797     else
 798         client_set_state(cl, Client_Error);
 799     odr_reset(global_parameters.odr_out);
 800 }
 801
 802 void client_continue(struct client *cl)
 803 {
 804     if (cl->state == Client_Connected) {
 805         client_init_request(cl);
 806     }
 807     if (cl->state == Client_Idle)
 808     {
 809         struct session *se = client_get_session(cl);
 810         if (cl->requestid != se->requestid && cl->pquery) {
 811             // we'll have to abort this because result set is to be deleted
 812             client_show_raw_cancel(cl);
 813             client_send_search(cl);
 814         }
 815         else if (cl->show_raw)
 816         {
 817             client_send_raw_present(cl);
 818         }
 819         else if (cl->hits > 0 && cl->records < global_parameters.toget &&
 820             cl->records < cl->hits) {
 821             client_send_present(cl);
 822         }
 823     }
 824 }
 825
 826 struct client *client_create(void)
 827 {
 828     struct client *r;
 829     if (client_freelist)
 830     {
 831         r = client_freelist;
 832         client_freelist = client_freelist->next;
 833     }
 834     else
 835         r = xmalloc(sizeof(struct client));
 836     r->pquery = 0;
 837     r->database = 0;
 838     r->connection = 0;
 839     r->session = 0;
 840     r->hits = 0;
 841     r->records = 0;
 842     r->setno = 0;
 843     r->requestid = -1;
 844     r->diagnostic = 0;
 845     r->state = Client_Disconnected;
 846     r->show_raw = 0;
 847     r->next = 0;
 848     return r;
 849 }
 850
 851 void client_destroy(struct client *c)
 852 {
 853     struct session *se = c->session;
 854     if (c == se->clients)
 855         se->clients = c->next;
 856     else
 857     {
 858         struct client *cc;
 859         for (cc = se->clients; cc && cc->next != c; cc = cc->next)
 860             ;
 861         if (cc)
 862             cc->next = c->next;
 863     }
 864     xfree(c->pquery);
 865
 866     if (c->connection)
 867         connection_release(c->connection);
 868     c->next = client_freelist;
 869     client_freelist = c;
 870 }
 871
 872 void client_set_connection(struct client *cl, struct connection *con)
 873 {
 874     cl->connection = con;
 875 }
 876
 877 void client_disconnect(struct client *cl)
 878 {
 879     if (cl->state != Client_Idle)
 880         cl->state = Client_Disconnected;
 881     client_set_connection(cl, 0);
 882 }
 883
 884 // Extract terms from query into null-terminated termlist
 885 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
 886 {
 887     int num = 0;
 888
 889     pull_terms(nmem, query, termlist, &num);
 890     termlist[num] = 0;
 891 }
 892
 893 // Initialize CCL map for a target
 894 static CCL_bibset prepare_cclmap(struct client *cl)
 895 {
 896     struct session_database *sdb = client_get_database(cl);
 897     struct setting *s;
 898     CCL_bibset res;
 899
 900     if (!sdb->settings)
 901         return 0;
 902     res = ccl_qual_mk();
 903     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
 904     {
 905         char *p = strchr(s->name + 3, ':');
 906         if (!p)
 907         {
 908             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
 909             ccl_qual_rm(&res);
 910             return 0;
 911         }
 912         p++;
 913         ccl_qual_fitem(res, s->value, p);
 914     }
 915     return res;
 916 }
 917
 918 // Parse the query given the settings specific to this client
 919 int client_parse_query(struct client *cl, const char *query)
 920 {
 921     struct session *se = client_get_session(cl);
 922     struct ccl_rpn_node *cn;
 923     int cerror, cpos;
 924     CCL_bibset ccl_map = prepare_cclmap(cl);
 925
 926     if (!ccl_map)
 927         return -1;
 928
 929     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
 930     ccl_qual_rm(&ccl_map);
 931     if (!cn)
 932     {
 933         cl->state = Client_Error;
 934         yaz_log(YLOG_WARN, "Failed to parse query for %s",
 935                          client_get_database(cl)->database->url);
 936         return -1;
 937     }
 938     wrbuf_rewind(se->wrbuf);
 939     ccl_pquery(se->wrbuf, cn);
 940     xfree(cl->pquery);
 941     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
 942
 943     if (!se->relevance)
 944     {
 945         // Initialize relevance structure with query terms
 946         char *p[512];
 947         extract_terms(se->nmem, cn, p);
 948         se->relevance = relevance_create(client_get_database(cl)->pct,
 949                                          se->nmem, (const char **) p,
 950                                          se->expected_maxrecs);
 951     }
 952
 953     ccl_rpn_delete(cn);
 954     return 0;
 955 }
 956
 957 void client_set_session(struct client *cl, struct session *se)
 958 {
 959     cl->session = se;
 960     cl->next = se->clients;
 961     se->clients = cl;
 962 }
 963
 964 int client_is_active(struct client *cl)
 965 {
 966     if (cl->connection && (cl->state == Client_Connecting ||
 967                            cl->state == Client_Initializing ||
 968                            cl->state == Client_Searching ||
 969                            cl->state == Client_Presenting))
 970         return 1;
 971     return 0;
 972 }
 973
 974 struct client *client_next_in_session(struct client *cl)
 975 {
 976     if (cl)
 977         return cl->next;
 978     return 0;
 979
 980 }
 981
 982 int client_get_hits(struct client *cl)
 983 {
 984     return cl->hits;
 985 }
 986
 987 int client_get_num_records(struct client *cl)
 988 {
 989     return cl->records;
 990 }
 991
 992 int client_get_diagnostic(struct client *cl)
 993 {
 994     return cl->diagnostic;
 995 }
 996
 997 void client_set_database(struct client *cl, struct session_database *db)
 998 {
 999     cl->database = db;
1000 }
1001
1002 struct host *client_get_host(struct client *cl)
1003 {
1004     return client_get_database(cl)->database->host;
1005 }
1006
1007 const char *client_get_url(struct client *cl)
1008 {
1009     return client_get_database(cl)->database->url;
1010 }
1011
1012 /*
1013  * Local variables:
1014  * c-basic-offset: 4
1015  * indent-tabs-mode: nil
1016  * End:
1017  * vim: shiftwidth=4 tabstop=8 expandtab
1018  */