src/client.c

   1 /* $Id: client.c,v 1.15 2007-07-05 18:46:03 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 || cl->state == Client_Disconnected)
 253     {
 254         client_show_raw_error(cl, "not connected");
 255     }
 256     else
 257     {
 258         client_continue(cl);
 259     }
 260     return 0;
 261 }
 262
 263 void client_show_raw_reset(struct client *cl)
 264 {
 265     xfree(cl->show_raw);
 266     cl->show_raw = 0;
 267 }
 268
 269 static void client_show_raw_error(struct client *cl, const char *addinfo)
 270 {
 271     if (cl->show_raw)
 272     {
 273         cl->show_raw->error_handler(cl->show_raw->data, addinfo);
 274         client_show_raw_reset(cl);
 275     }
 276 }
 277
 278 static void client_show_raw_cancel(struct client *cl)
 279 {
 280     if (cl->show_raw)
 281     {
 282         cl->show_raw->error_handler(cl->show_raw->data, "cancel");
 283         client_show_raw_reset(cl);
 284     }
 285 }
 286
 287 static void client_present_syntax(Z_APDU *a, const char *syntax)
 288 {
 289     // empty string for syntax OMITS preferredRecordSyntax (OPTIONAL)
 290     if (syntax && *syntax)
 291         a->u.presentRequest->preferredRecordSyntax =
 292             yaz_string_to_oid_odr(yaz_oid_std(),
 293                                   CLASS_RECSYN, syntax,
 294                                   global_parameters.odr_out);
 295 }
 296
 297 static void client_present_elements(Z_APDU *a, const char *elements)
 298 {
 299     if (elements && *elements)  // element set is optional
 300     {
 301         Z_ElementSetNames *elementSetNames =
 302             odr_malloc(global_parameters.odr_out, sizeof(*elementSetNames));
 303         Z_RecordComposition *compo =
 304             odr_malloc(global_parameters.odr_out, sizeof(*compo));
 305         a->u.presentRequest->recordComposition = compo;
 306
 307         compo->which = Z_RecordComp_simple;
 308         compo->u.simple = elementSetNames;
 309
 310         elementSetNames->which = Z_ElementSetNames_generic;
 311         elementSetNames->u.generic =
 312             odr_strdup(global_parameters.odr_out, elements);
 313     }
 314 }
 315
 316 void client_send_raw_present(struct client *cl)
 317 {
 318     struct session_database *sdb = client_get_database(cl);
 319     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest);
 320     int toget = 1;
 321     int start = cl->show_raw->position;
 322     const char *syntax = 0;
 323     const char *elements = 0;
 324
 325     assert(cl->show_raw);
 326
 327     yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
 328             client_get_url(cl), toget, start);
 329
 330     a->u.presentRequest->resultSetStartPoint = &start;
 331     a->u.presentRequest->numberOfRecordsRequested = &toget;
 332
 333     if (cl->show_raw->syntax)
 334         syntax = cl->show_raw->syntax;
 335     else
 336         syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 337
 338     client_present_syntax(a, syntax);
 339     if (cl->show_raw->esn)
 340         elements = cl->show_raw->esn;
 341     else
 342         elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 343     client_present_elements(a, elements);
 344
 345     if (send_apdu(cl, a) >= 0)
 346     {
 347         cl->show_raw->active = 1;
 348         cl->state = Client_Presenting;
 349     }
 350     else
 351     {
 352         client_show_raw_error(cl, "send_apdu failed");
 353         cl->state = Client_Error;
 354     }
 355     odr_reset(global_parameters.odr_out);
 356 }
 357
 358 void client_send_present(struct client *cl)
 359 {
 360     struct session_database *sdb = client_get_database(cl);
 361     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest);
 362     int toget;
 363     int start = cl->records + 1;
 364     const char *syntax = 0;
 365     const char *elements = 0;
 366
 367     toget = global_parameters.chunk;
 368     if (toget > global_parameters.toget - cl->records)
 369         toget = global_parameters.toget - cl->records;
 370     if (toget > cl->hits - cl->records)
 371         toget = cl->hits - cl->records;
 372
 373     yaz_log(YLOG_DEBUG, "Trying to present %d record(s) from %d",
 374             toget, start);
 375
 376     a->u.presentRequest->resultSetStartPoint = &start;
 377     a->u.presentRequest->numberOfRecordsRequested = &toget;
 378
 379     syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 380     client_present_syntax(a, syntax);
 381
 382     elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 383     client_present_elements(a, elements);
 384
 385     if (send_apdu(cl, a) >= 0)
 386         cl->state = Client_Presenting;
 387     else
 388         cl->state = Client_Error;
 389     odr_reset(global_parameters.odr_out);
 390 }
 391
 392
 393 void client_send_search(struct client *cl)
 394 {
 395     struct session *se = client_get_session(cl);
 396     struct session_database *sdb = client_get_database(cl);
 397     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_searchRequest);
 398     int ndb;
 399     char **databaselist;
 400     Z_Query *zquery;
 401     int ssub = 0, lslb = 100000, mspn = 10;
 402     char *piggyback = 0;
 403     char *queryenc = 0;
 404     yaz_iconv_t iconv = 0;
 405
 406     yaz_log(YLOG_DEBUG, "Sending search to %s", sdb->database->url);
 407
 408
 409     // constructing RPN query
 410     a->u.searchRequest->query = zquery = odr_malloc(global_parameters.odr_out,
 411                                                     sizeof(Z_Query));
 412     zquery->which = Z_Query_type_1;
 413     zquery->u.type_1 = p_query_rpn(global_parameters.odr_out,
 414                                    client_get_pquery(cl));
 415
 416     // converting to target encoding
 417     if ((queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING))){
 418         iconv = yaz_iconv_open(queryenc, "UTF-8");
 419         if (iconv){
 420             yaz_query_charset_convert_rpnquery(zquery->u.type_1,
 421                                                global_parameters.odr_out,
 422                                                iconv);
 423             yaz_iconv_close(iconv);
 424         } else
 425             yaz_log(YLOG_WARN, "Query encoding failed %s %s",
 426                     client_get_database(cl)->database->url, queryenc);
 427     }
 428
 429     for (ndb = 0; sdb->database->databases[ndb]; ndb++)
 430         ;
 431     databaselist = odr_malloc(global_parameters.odr_out, sizeof(char*) * ndb);
 432     for (ndb = 0; sdb->database->databases[ndb]; ndb++)
 433         databaselist[ndb] = sdb->database->databases[ndb];
 434
 435     if (!(piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK))
 436         || *piggyback == '1')
 437     {
 438         const char *elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 439         const char *recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 440         if (recsyn && *recsyn)
 441         {
 442             a->u.searchRequest->preferredRecordSyntax =
 443                 yaz_string_to_oid_odr(yaz_oid_std(),
 444                                       CLASS_RECSYN, recsyn,
 445                                       global_parameters.odr_out);
 446         }
 447         if (elements && *elements)
 448         {
 449             Z_ElementSetNames *esn =
 450                 odr_malloc(global_parameters.odr_out, sizeof(*esn));
 451             esn->which = Z_ElementSetNames_generic;
 452             esn->u.generic = odr_strdup(global_parameters.odr_out, elements);
 453
 454             a->u.searchRequest->smallSetElementSetNames = esn;
 455             a->u.searchRequest->mediumSetElementSetNames = esn;
 456         }
 457         a->u.searchRequest->smallSetUpperBound = &ssub;
 458         a->u.searchRequest->largeSetLowerBound = &lslb;
 459         a->u.searchRequest->mediumSetPresentNumber = &mspn;
 460     }
 461     a->u.searchRequest->databaseNames = databaselist;
 462     a->u.searchRequest->num_databaseNames = ndb;
 463
 464
 465     {  //scope for sending and logging queries
 466         WRBUF wbquery = wrbuf_alloc();
 467         yaz_query_to_wrbuf(wbquery, a->u.searchRequest->query);
 468
 469
 470         if (send_apdu(cl, a) >= 0)
 471         {
 472             client_set_state(cl, Client_Searching);
 473             client_set_requestid(cl, se->requestid);
 474             yaz_log(YLOG_LOG, "SearchRequest %s %s %s",
 475                     client_get_database(cl)->database->url,
 476                     queryenc ? queryenc : "UTF-8",
 477                     wrbuf_cstr(wbquery));
 478         }
 479         else {
 480             client_set_state(cl, Client_Error);
 481             yaz_log(YLOG_WARN, "Failed SearchRequest %s  %s %s",
 482                     client_get_database(cl)->database->url,
 483                     queryenc ? queryenc : "UTF-8",
 484                     wrbuf_cstr(wbquery));
 485         }
 486
 487         wrbuf_destroy(wbquery);
 488     }
 489
 490     odr_reset(global_parameters.odr_out);
 491 }
 492
 493 void client_init_response(struct client *cl, Z_APDU *a)
 494 {
 495     Z_InitResponse *r = a->u.initResponse;
 496
 497     yaz_log(YLOG_DEBUG, "Init response %s", cl->database->database->url);
 498
 499     if (*r->result)
 500         cl->state = Client_Idle;
 501     else
 502         cl->state = Client_Failed; // FIXME need to do something to the connection
 503 }
 504
 505
 506 static void ingest_raw_records(struct client *cl, Z_Records *r)
 507 {
 508     Z_NamePlusRecordList *rlist;
 509     Z_NamePlusRecord *npr;
 510     xmlDoc *doc;
 511     xmlChar *buf_out;
 512     int len_out;
 513     if (r->which != Z_Records_DBOSD)
 514     {
 515         client_show_raw_error(cl, "non-surrogate diagnostics");
 516         return;
 517     }
 518
 519     rlist = r->u.databaseOrSurDiagnostics;
 520     if (rlist->num_records != 1 || !rlist->records || !rlist->records[0])
 521     {
 522         client_show_raw_error(cl, "no records");
 523         return;
 524     }
 525     npr = rlist->records[0];
 526     if (npr->which != Z_NamePlusRecord_databaseRecord)
 527     {
 528         client_show_raw_error(cl, "surrogate diagnostic");
 529         return;
 530     }
 531
 532     doc = record_to_xml(client_get_database(cl), npr->u.databaseRecord);
 533     if (!doc)
 534     {
 535         client_show_raw_error(cl, "unable to convert record to xml");
 536         return;
 537     }
 538
 539     xmlDocDumpMemory(doc, &buf_out, &len_out);
 540     xmlFreeDoc(doc);
 541
 542     cl->show_raw->record_handler(cl->show_raw->data,
 543                                  (const char *) buf_out, len_out);
 544
 545     xmlFree(buf_out);
 546     xfree(cl->show_raw);
 547     cl->show_raw = 0;
 548 }
 549
 550 static void ingest_records(struct client *cl, Z_Records *r)
 551 {
 552 #if USE_TIMING
 553     yaz_timing_t t = yaz_timing_create();
 554 #endif
 555     struct record *rec;
 556     struct session *s = client_get_session(cl);
 557     Z_NamePlusRecordList *rlist;
 558     int i;
 559
 560     if (r->which != Z_Records_DBOSD)
 561         return;
 562     rlist = r->u.databaseOrSurDiagnostics;
 563     for (i = 0; i < rlist->num_records; i++)
 564     {
 565         Z_NamePlusRecord *npr = rlist->records[i];
 566
 567         cl->records++;
 568         if (npr->which != Z_NamePlusRecord_databaseRecord)
 569         {
 570             yaz_log(YLOG_WARN,
 571                     "Unexpected record type, probably diagnostic %s",
 572                     cl->database->database->url);
 573             continue;
 574         }
 575
 576         rec = ingest_record(cl, npr->u.databaseRecord, cl->records);
 577         if (!rec)
 578             continue;
 579     }
 580     if (rlist->num_records)
 581         session_alert_watch(s, SESSION_WATCH_RECORDS);
 582
 583 #if USE_TIMING
 584     yaz_timing_stop(t);
 585     yaz_log(YLOG_LOG, "ingest_records %6.5f %3.2f %3.2f",
 586             yaz_timing_get_real(t), yaz_timing_get_user(t),
 587             yaz_timing_get_sys(t));
 588     yaz_timing_destroy(&t);
 589 #endif
 590 }
 591
 592
 593 void client_search_response(struct client *cl, Z_APDU *a)
 594 {
 595     struct session *se = cl->session;
 596     Z_SearchResponse *r = a->u.searchResponse;
 597
 598     yaz_log(YLOG_DEBUG, "Search response %s (status=%d)",
 599             cl->database->database->url, *r->searchStatus);
 600
 601     if (*r->searchStatus)
 602     {
 603         cl->hits = *r->resultCount;
 604         se->total_hits += cl->hits;
 605         if (r->presentStatus && !*r->presentStatus && r->records)
 606         {
 607             yaz_log(YLOG_DEBUG, "Records in search response %s",
 608                     cl->database->database->url);
 609             ingest_records(cl, r->records);
 610         }
 611         cl->state = Client_Idle;
 612     }
 613     else
 614     {          /*"FAILED"*/
 615         Z_Records *recs = r->records;
 616         cl->hits = 0;
 617         cl->state = Client_Error;
 618         if (recs && recs->which == Z_Records_NSD)
 619         {
 620             WRBUF w = wrbuf_alloc();
 621
 622             Z_DiagRec dr, *dr_p = &dr;
 623             dr.which = Z_DiagRec_defaultFormat;
 624             dr.u.defaultFormat = recs->u.nonSurrogateDiagnostic;
 625
 626             wrbuf_printf(w, "Search response NSD %s: ",
 627                          cl->database->database->url);
 628
 629             cl->diagnostic = diag_to_wrbuf(&dr_p, 1, w);
 630
 631             yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
 632
 633             cl->state = Client_Error;
 634             wrbuf_destroy(w);
 635         }
 636         else if (recs && recs->which == Z_Records_multipleNSD)
 637         {
 638             WRBUF w = wrbuf_alloc();
 639
 640             wrbuf_printf(w, "Search response multipleNSD %s: ",
 641                          cl->database->database->url);
 642             cl->diagnostic =
 643                 diag_to_wrbuf(recs->u.multipleNonSurDiagnostics->diagRecs,
 644                               recs->u.multipleNonSurDiagnostics->num_diagRecs,
 645                               w);
 646             yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
 647             cl->state = Client_Error;
 648             wrbuf_destroy(w);
 649         }
 650     }
 651 }
 652
 653 void client_present_response(struct client *cl, Z_APDU *a)
 654 {
 655     Z_PresentResponse *r = a->u.presentResponse;
 656     Z_Records *recs = r->records;
 657
 658     if (recs && recs->which == Z_Records_NSD)
 659     {
 660         WRBUF w = wrbuf_alloc();
 661
 662         Z_DiagRec dr, *dr_p = &dr;
 663         dr.which = Z_DiagRec_defaultFormat;
 664         dr.u.defaultFormat = recs->u.nonSurrogateDiagnostic;
 665
 666         wrbuf_printf(w, "Present response NSD %s: ",
 667                      cl->database->database->url);
 668
 669         cl->diagnostic = diag_to_wrbuf(&dr_p, 1, w);
 670
 671         yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
 672
 673         cl->state = Client_Error;
 674         wrbuf_destroy(w);
 675
 676         client_show_raw_error(cl, "non surrogate diagnostics");
 677     }
 678     else if (recs && recs->which == Z_Records_multipleNSD)
 679     {
 680         WRBUF w = wrbuf_alloc();
 681
 682         wrbuf_printf(w, "Present response multipleNSD %s: ",
 683                      cl->database->database->url);
 684         cl->diagnostic =
 685             diag_to_wrbuf(recs->u.multipleNonSurDiagnostics->diagRecs,
 686                           recs->u.multipleNonSurDiagnostics->num_diagRecs,
 687                           w);
 688         yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
 689         cl->state = Client_Error;
 690         wrbuf_destroy(w);
 691     }
 692     else if (recs && !*r->presentStatus && cl->state != Client_Error)
 693     {
 694         yaz_log(YLOG_DEBUG, "Good Present response %s",
 695                 cl->database->database->url);
 696
 697         // we can mix show raw and normal show ..
 698         if (cl->show_raw && cl->show_raw->active)
 699         {
 700             cl->show_raw->active = 0; // no longer active
 701             ingest_raw_records(cl, recs);
 702         }
 703         else
 704             ingest_records(cl, recs);
 705         cl->state = Client_Idle;
 706     }
 707     else if (*r->presentStatus)
 708     {
 709         yaz_log(YLOG_WARN, "Bad Present response %s",
 710                 cl->database->database->url);
 711         cl->state = Client_Error;
 712         client_show_raw_error(cl, "bad present response");
 713     }
 714 }
 715
 716 void client_close_response(struct client *cl, Z_APDU *a)
 717 {
 718     struct connection *co = cl->connection;
 719     /* Z_Close *r = a->u.close; */
 720
 721     yaz_log(YLOG_WARN, "Close response %s", cl->database->database->url);
 722
 723     cl->state = Client_Failed;
 724     connection_destroy(co);
 725 }
 726
 727 int client_is_our_response(struct client *cl)
 728 {
 729     struct session *se = client_get_session(cl);
 730
 731     if (cl && (cl->requestid == se->requestid ||
 732                cl->state == Client_Initializing))
 733         return 1;
 734     return 0;
 735 }
 736
 737 // Set authentication token in init if one is set for the client
 738 // TODO: Extend this to handle other schemes than open (should be simple)
 739 static void init_authentication(struct client *cl, Z_InitRequest *req)
 740 {
 741     struct session_database *sdb = client_get_database(cl);
 742     char *auth = session_setting_oneval(sdb, PZ_AUTHENTICATION);
 743
 744     if (*auth)
 745     {
 746         struct connection *co = client_get_connection(cl);
 747         struct session *se = client_get_session(cl);
 748         Z_IdAuthentication *idAuth = odr_malloc(global_parameters.odr_out,
 749                 sizeof(*idAuth));
 750         idAuth->which = Z_IdAuthentication_open;
 751         idAuth->u.open = auth;
 752         req->idAuthentication = idAuth;
 753         connection_set_authentication(co, nmem_strdup(se->session_nmem, auth));
 754     }
 755 }
 756
 757 static void init_zproxy(struct client *cl, Z_InitRequest *req)
 758 {
 759     struct session_database *sdb = client_get_database(cl);
 760     char *ztarget = sdb->database->url;
 761     //char *ztarget = sdb->url;
 762     char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
 763
 764     if (*zproxy)
 765         yaz_oi_set_string_oid(&req->otherInfo,
 766                               global_parameters.odr_out,
 767                               yaz_oid_userinfo_proxy,
 768                               1, ztarget);
 769 }
 770
 771
 772 static void client_init_request(struct client *cl)
 773 {
 774     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_initRequest);
 775
 776     a->u.initRequest->implementationId = global_parameters.implementationId;
 777     a->u.initRequest->implementationName = global_parameters.implementationName;
 778     a->u.initRequest->implementationVersion =
 779         global_parameters.implementationVersion;
 780     ODR_MASK_SET(a->u.initRequest->options, Z_Options_search);
 781     ODR_MASK_SET(a->u.initRequest->options, Z_Options_present);
 782     ODR_MASK_SET(a->u.initRequest->options, Z_Options_namedResultSets);
 783
 784     ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_1);
 785     ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_2);
 786     ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_3);
 787
 788     init_authentication(cl, a->u.initRequest);
 789     init_zproxy(cl, a->u.initRequest);
 790
 791     if (send_apdu(cl, a) >= 0)
 792         client_set_state(cl, Client_Initializing);
 793     else
 794         client_set_state(cl, Client_Error);
 795     odr_reset(global_parameters.odr_out);
 796 }
 797
 798 void client_continue(struct client *cl)
 799 {
 800     if (cl->state == Client_Connected) {
 801         client_init_request(cl);
 802     }
 803     if (cl->state == Client_Idle)
 804     {
 805         struct session *se = client_get_session(cl);
 806         if (cl->requestid != se->requestid && cl->pquery) {
 807             // we'll have to abort this because result set is to be deleted
 808             client_show_raw_cancel(cl);
 809             client_send_search(cl);
 810         }
 811         else if (cl->show_raw)
 812         {
 813             client_send_raw_present(cl);
 814         }
 815         else if (cl->hits > 0 && cl->records < global_parameters.toget &&
 816             cl->records < cl->hits) {
 817             client_send_present(cl);
 818         }
 819     }
 820 }
 821
 822 struct client *client_create(void)
 823 {
 824     struct client *r;
 825     if (client_freelist)
 826     {
 827         r = client_freelist;
 828         client_freelist = client_freelist->next;
 829     }
 830     else
 831         r = xmalloc(sizeof(struct client));
 832     r->pquery = 0;
 833     r->database = 0;
 834     r->connection = 0;
 835     r->session = 0;
 836     r->hits = 0;
 837     r->records = 0;
 838     r->setno = 0;
 839     r->requestid = -1;
 840     r->diagnostic = 0;
 841     r->state = Client_Disconnected;
 842     r->show_raw = 0;
 843     r->next = 0;
 844     return r;
 845 }
 846
 847 void client_destroy(struct client *c)
 848 {
 849     struct session *se = c->session;
 850     if (c == se->clients)
 851         se->clients = c->next;
 852     else
 853     {
 854         struct client *cc;
 855         for (cc = se->clients; cc && cc->next != c; cc = cc->next)
 856             ;
 857         if (cc)
 858             cc->next = c->next;
 859     }
 860     xfree(c->pquery);
 861
 862     if (c->connection)
 863         connection_release(c->connection);
 864     c->next = client_freelist;
 865     client_freelist = c;
 866 }
 867
 868 void client_set_connection(struct client *cl, struct connection *con)
 869 {
 870     cl->connection = con;
 871 }
 872
 873 void client_disconnect(struct client *cl)
 874 {
 875     if (cl->state != Client_Idle)
 876         cl->state = Client_Disconnected;
 877     client_set_connection(cl, 0);
 878 }
 879
 880 // Extract terms from query into null-terminated termlist
 881 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
 882 {
 883     int num = 0;
 884
 885     pull_terms(nmem, query, termlist, &num);
 886     termlist[num] = 0;
 887 }
 888
 889 // Initialize CCL map for a target
 890 static CCL_bibset prepare_cclmap(struct client *cl)
 891 {
 892     struct session_database *sdb = client_get_database(cl);
 893     struct setting *s;
 894     CCL_bibset res;
 895
 896     if (!sdb->settings)
 897         return 0;
 898     res = ccl_qual_mk();
 899     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
 900     {
 901         char *p = strchr(s->name + 3, ':');
 902         if (!p)
 903         {
 904             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
 905             ccl_qual_rm(&res);
 906             return 0;
 907         }
 908         p++;
 909         ccl_qual_fitem(res, s->value, p);
 910     }
 911     return res;
 912 }
 913
 914 // Parse the query given the settings specific to this client
 915 int client_parse_query(struct client *cl, const char *query)
 916 {
 917     struct session *se = client_get_session(cl);
 918     struct ccl_rpn_node *cn;
 919     int cerror, cpos;
 920     CCL_bibset ccl_map = prepare_cclmap(cl);
 921
 922     if (!ccl_map)
 923         return -1;
 924     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
 925     ccl_qual_rm(&ccl_map);
 926     if (!cn)
 927     {
 928         cl->state = Client_Error;
 929         yaz_log(YLOG_WARN, "Failed to parse query for %s",
 930                          client_get_database(cl)->database->url);
 931         return -1;
 932     }
 933     wrbuf_rewind(se->wrbuf);
 934     ccl_pquery(se->wrbuf, cn);
 935     xfree(cl->pquery);
 936     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
 937
 938     if (!se->relevance)
 939     {
 940         // Initialize relevance structure with query terms
 941         char *p[512];
 942         extract_terms(se->nmem, cn, p);
 943         se->relevance = relevance_create(client_get_database(cl)->pct,
 944                                          se->nmem, (const char **) p,
 945                                          se->expected_maxrecs);
 946     }
 947
 948     ccl_rpn_delete(cn);
 949     return 0;
 950 }
 951
 952 void client_set_session(struct client *cl, struct session *se)
 953 {
 954     cl->session = se;
 955     cl->next = se->clients;
 956     se->clients = cl;
 957 }
 958
 959 int client_is_active(struct client *cl)
 960 {
 961     if (cl->connection && (cl->state == Client_Connecting ||
 962                            cl->state == Client_Initializing ||
 963                            cl->state == Client_Searching ||
 964                            cl->state == Client_Presenting))
 965         return 1;
 966     return 0;
 967 }
 968
 969 struct client *client_next_in_session(struct client *cl)
 970 {
 971     if (cl)
 972         return cl->next;
 973     return 0;
 974
 975 }
 976
 977 int client_get_hits(struct client *cl)
 978 {
 979     return cl->hits;
 980 }
 981
 982 int client_get_num_records(struct client *cl)
 983 {
 984     return cl->records;
 985 }
 986
 987 int client_get_diagnostic(struct client *cl)
 988 {
 989     return cl->diagnostic;
 990 }
 991
 992 void client_set_database(struct client *cl, struct session_database *db)
 993 {
 994     cl->database = db;
 995 }
 996
 997 struct host *client_get_host(struct client *cl)
 998 {
 999     return client_get_database(cl)->database->host;
1000 }
1001
1002 const char *client_get_url(struct client *cl)
1003 {
1004     return client_get_database(cl)->database->url;
1005 }
1006
1007 /*
1008  * Local variables:
1009  * c-basic-offset: 4
1010  * indent-tabs-mode: nil
1011  * End:
1012  * vim: shiftwidth=4 tabstop=8 expandtab
1013  */