src/client.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2011 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 #include <stdlib.h>
  28 #include <stdio.h>
  29 #include <string.h>
  30 #if HAVE_SYS_TIME_H
  31 #include <sys/time.h>
  32 #endif
  33 #if HAVE_UNISTD_H
  34 #include <unistd.h>
  35 #endif
  36 #include <signal.h>
  37 #include <assert.h>
  38
  39 #include <yaz/marcdisp.h>
  40 #include <yaz/comstack.h>
  41 #include <yaz/tcpip.h>
  42 #include <yaz/proto.h>
  43 #include <yaz/readconf.h>
  44 #include <yaz/pquery.h>
  45 #include <yaz/otherinfo.h>
  46 #include <yaz/yaz-util.h>
  47 #include <yaz/nmem.h>
  48 #include <yaz/query-charset.h>
  49 #include <yaz/querytowrbuf.h>
  50 #include <yaz/oid_db.h>
  51 #include <yaz/diagbib1.h>
  52 #include <yaz/snprintf.h>
  53 #include <yaz/rpn2cql.h>
  54 #include <yaz/rpn2solr.h>
  55
  56 #define USE_TIMING 0
  57 #if USE_TIMING
  58 #include <yaz/timing.h>
  59 #endif
  60
  61 #include "ppmutex.h"
  62 #include "session.h"
  63 #include "parameters.h"
  64 #include "client.h"
  65 #include "connection.h"
  66 #include "settings.h"
  67 #include "relevance.h"
  68 #include "incref.h"
  69
  70 /* client counting (1) , disable client counting (0) */
  71 #if 1
  72 static YAZ_MUTEX g_mutex = 0;
  73 static int no_clients = 0;
  74
  75 static void client_use(int delta)
  76 {
  77     if (!g_mutex)
  78         yaz_mutex_create(&g_mutex);
  79     yaz_mutex_enter(g_mutex);
  80     no_clients += delta;
  81     yaz_mutex_leave(g_mutex);
  82     yaz_log(YLOG_DEBUG, "%s clients=%d", delta > 0 ? "INC" : "DEC", no_clients);
  83 }
  84 #else
  85 #define client_use(x)
  86 #endif
  87
  88 /** \brief Represents client state for a connection to one search target */
  89 struct client {
  90     struct session_database *database;
  91     struct connection *connection;
  92     struct session *session;
  93     char *pquery; // Current search
  94     char *cqlquery; // used for SRU targets only
  95     Odr_int hits;
  96     int record_offset;
  97     int maxrecs;
  98     int startrecs;
  99     int diagnostic;
 100     int preferred;
 101     enum client_state state;
 102     struct show_raw *show_raw;
 103     ZOOM_resultset resultset;
 104     YAZ_MUTEX mutex;
 105     int ref_count;
 106     /* copy of database->url */
 107     char *url;
 108 };
 109
 110 struct show_raw {
 111     int active; // whether this request has been sent to the server
 112     int position;
 113     int binary;
 114     char *syntax;
 115     char *esn;
 116     void (*error_handler)(void *data, const char *addinfo);
 117     void (*record_handler)(void *data, const char *buf, size_t sz);
 118     void *data;
 119     struct show_raw *next;
 120 };
 121
 122 static const char *client_states[] = {
 123     "Client_Connecting",
 124     "Client_Idle",
 125     "Client_Working",
 126     "Client_Error",
 127     "Client_Failed",
 128     "Client_Disconnected"
 129 };
 130
 131 const char *client_get_state_str(struct client *cl)
 132 {
 133     return client_states[cl->state];
 134 }
 135
 136 enum client_state client_get_state(struct client *cl)
 137 {
 138     return cl->state;
 139 }
 140
 141 void client_set_state(struct client *cl, enum client_state st)
 142 {
 143     int was_active = 0;
 144     if (client_is_active(cl))
 145         was_active = 1;
 146     cl->state = st;
 147     /* If client is going from being active to inactive and all clients
 148        are now idle we fire a watch for the session . The assumption is
 149        that session is not mutex locked if client is already active */
 150     if (was_active && !client_is_active(cl) && cl->session)
 151     {
 152
 153         int no_active = session_active_clients(cl->session);
 154         yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d", client_get_url(cl), no_active);
 155         if (no_active == 0) {
 156             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
 157             session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
 158         }
 159     }
 160 }
 161
 162 static void client_show_raw_error(struct client *cl, const char *addinfo);
 163
 164 struct connection *client_get_connection(struct client *cl)
 165 {
 166     return cl->connection;
 167 }
 168
 169 struct session_database *client_get_database(struct client *cl)
 170 {
 171     return cl->database;
 172 }
 173
 174 struct session *client_get_session(struct client *cl)
 175 {
 176     return cl->session;
 177 }
 178
 179 const char *client_get_pquery(struct client *cl)
 180 {
 181     return cl->pquery;
 182 }
 183
 184 static void client_send_raw_present(struct client *cl);
 185 static int nativesyntax_to_type(struct session_database *sdb, char *type,
 186                                 ZOOM_record rec);
 187
 188 static void client_show_immediate(
 189     ZOOM_resultset resultset, struct session_database *sdb, int position,
 190     void *data,
 191     void (*error_handler)(void *data, const char *addinfo),
 192     void (*record_handler)(void *data, const char *buf, size_t sz),
 193     int binary)
 194 {
 195     ZOOM_record rec = 0;
 196     char type[80];
 197     const char *buf;
 198     int len;
 199
 200     if (!resultset)
 201     {
 202         error_handler(data, "no resultset");
 203         return;
 204     }
 205     rec = ZOOM_resultset_record(resultset, position-1);
 206     if (!rec)
 207     {
 208         error_handler(data, "no record");
 209         return;
 210     }
 211     if (binary)
 212         strcpy(type, "raw");
 213     else
 214         nativesyntax_to_type(sdb, type, rec);
 215     buf = ZOOM_record_get(rec, type, &len);
 216     if (!buf)
 217     {
 218         error_handler(data, "no record");
 219         return;
 220     }
 221     record_handler(data, buf, len);
 222 }
 223
 224
 225 int client_show_raw_begin(struct client *cl, int position,
 226                           const char *syntax, const char *esn,
 227                           void *data,
 228                           void (*error_handler)(void *data, const char *addinfo),
 229                           void (*record_handler)(void *data, const char *buf,
 230                                                  size_t sz),
 231                           int binary)
 232 {
 233     if (syntax == 0 && esn == 0)
 234         client_show_immediate(cl->resultset, client_get_database(cl),
 235                               position, data,
 236                               error_handler, record_handler,
 237                               binary);
 238     else
 239     {
 240         struct show_raw *rr, **rrp;
 241
 242         if (!cl->connection)
 243             return -1;
 244
 245
 246         rr = xmalloc(sizeof(*rr));
 247         rr->position = position;
 248         rr->active = 0;
 249         rr->data = data;
 250         rr->error_handler = error_handler;
 251         rr->record_handler = record_handler;
 252         rr->binary = binary;
 253         if (syntax)
 254             rr->syntax = xstrdup(syntax);
 255         else
 256             rr->syntax = 0;
 257         if (esn)
 258             rr->esn = xstrdup(esn);
 259         else
 260             rr->esn = 0;
 261         rr->next = 0;
 262
 263         for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
 264             ;
 265         *rrp = rr;
 266
 267         if (cl->state == Client_Failed)
 268         {
 269             client_show_raw_error(cl, "client failed");
 270         }
 271         else if (cl->state == Client_Disconnected)
 272         {
 273             client_show_raw_error(cl, "client disconnected");
 274         }
 275         else
 276         {
 277             client_send_raw_present(cl);
 278         }
 279     }
 280     return 0;
 281 }
 282
 283 static void client_show_raw_delete(struct show_raw *r)
 284 {
 285     xfree(r->syntax);
 286     xfree(r->esn);
 287     xfree(r);
 288 }
 289
 290 void client_show_raw_remove(struct client *cl, void *data)
 291 {
 292     struct show_raw *rr = data;
 293     struct show_raw **rrp = &cl->show_raw;
 294     while (*rrp != rr)
 295         rrp = &(*rrp)->next;
 296     if (*rrp)
 297     {
 298         *rrp = rr->next;
 299         client_show_raw_delete(rr);
 300     }
 301 }
 302
 303 void client_show_raw_dequeue(struct client *cl)
 304 {
 305     struct show_raw *rr = cl->show_raw;
 306
 307     cl->show_raw = rr->next;
 308     client_show_raw_delete(rr);
 309 }
 310
 311 static void client_show_raw_error(struct client *cl, const char *addinfo)
 312 {
 313     while (cl->show_raw)
 314     {
 315         cl->show_raw->error_handler(cl->show_raw->data, addinfo);
 316         client_show_raw_dequeue(cl);
 317     }
 318 }
 319
 320 static void client_send_raw_present(struct client *cl)
 321 {
 322     struct session_database *sdb = client_get_database(cl);
 323     struct connection *co = client_get_connection(cl);
 324     ZOOM_resultset set = cl->resultset;
 325
 326     int offset = cl->show_raw->position;
 327     const char *syntax = 0;
 328     const char *elements = 0;
 329
 330     assert(cl->show_raw);
 331     assert(set);
 332
 333     yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
 334             client_get_url(cl), 1, offset);
 335
 336     if (cl->show_raw->syntax)
 337         syntax = cl->show_raw->syntax;
 338     else
 339         syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 340     ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
 341
 342     if (cl->show_raw->esn)
 343         elements = cl->show_raw->esn;
 344     else
 345         elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 346     if (elements && *elements)
 347         ZOOM_resultset_option_set(set, "elementSetName", elements);
 348
 349     ZOOM_resultset_records(set, 0, offset-1, 1);
 350     cl->show_raw->active = 1;
 351
 352     connection_continue(co);
 353 }
 354
 355 static int nativesyntax_to_type(struct session_database *sdb, char *type,
 356                                 ZOOM_record rec)
 357 {
 358     const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
 359
 360     if (s && *s)
 361     {
 362         if (!strncmp(s, "iso2709", 7))
 363         {
 364             const char *cp = strchr(s, ';');
 365             yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
 366         }
 367         else if (!strncmp(s, "xml", 3))
 368         {
 369             strcpy(type, "xml");
 370         }
 371         else if (!strncmp(s, "txml", 4))
 372         {
 373             const char *cp = strchr(s, ';');
 374             yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
 375         }
 376         else
 377             return -1;
 378         return 0;
 379     }
 380     else  /* attempt to deduce structure */
 381     {
 382         const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
 383         if (syntax)
 384         {
 385             if (!strcmp(syntax, "XML"))
 386             {
 387                 strcpy(type, "xml");
 388                 return 0;
 389             }
 390             else if (!strcmp(syntax, "TXML"))
 391                 {
 392                     strcpy(type, "txml");
 393                     return 0;
 394                 }
 395             else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
 396             {
 397                 strcpy(type, "xml; charset=marc8-s");
 398                 return 0;
 399             }
 400             else return -1;
 401         }
 402         else return -1;
 403     }
 404 }
 405
 406 /**
 407  * TODO Consider thread safety!!!
 408  *
 409  */
 410 int client_report_facets(struct client *cl, ZOOM_resultset rs) {
 411     int facet_idx;
 412     ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
 413     int facet_num;
 414     struct session *se = client_get_session(cl);
 415     facet_num = ZOOM_resultset_facets_size(rs);
 416     yaz_log(YLOG_DEBUG, "client_report_facets: %d", facet_num);
 417
 418     for (facet_idx = 0; facet_idx < facet_num; facet_idx++) {
 419         const char *name = ZOOM_facet_field_name(facets[facet_idx]);
 420         size_t term_idx;
 421         size_t term_num = ZOOM_facet_field_term_count(facets[facet_idx]);
 422         for (term_idx = 0; term_idx < term_num; term_idx++ ) {
 423             int freq;
 424             const char *term = ZOOM_facet_field_get_term(facets[facet_idx], term_idx, &freq);
 425             if (term)
 426                 add_facet(se, name, term, freq);
 427         }
 428     }
 429
 430     return 0;
 431 }
 432
 433 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
 434 {
 435     const char *buf;
 436     int len;
 437     char type[80];
 438
 439     if (cl->show_raw->binary)
 440         strcpy(type, "raw");
 441     else
 442     {
 443         struct session_database *sdb = client_get_database(cl);
 444         nativesyntax_to_type(sdb, type, rec);
 445     }
 446
 447     buf = ZOOM_record_get(rec, type, &len);
 448     cl->show_raw->record_handler(cl->show_raw->data,  buf, len);
 449     client_show_raw_dequeue(cl);
 450 }
 451
 452 void client_check_preferred_watch(struct client *cl)
 453 {
 454     struct session *se = cl->session;
 455     yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_url(cl));
 456     if (se)
 457     {
 458         client_unlock(cl);
 459         if (session_is_preferred_clients_ready(se)) {
 460             session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
 461         }
 462         else
 463             yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
 464
 465         client_lock(cl);
 466     }
 467     else
 468         yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_url(cl));
 469
 470 }
 471
 472 void client_search_response(struct client *cl)
 473 {
 474     struct connection *co = cl->connection;
 475     struct session *se = cl->session;
 476     ZOOM_connection link = connection_get_link(co);
 477     ZOOM_resultset resultset = cl->resultset;
 478
 479     const char *error, *addinfo = 0;
 480
 481     if (ZOOM_connection_error(link, &error, &addinfo))
 482     {
 483         cl->hits = 0;
 484         client_set_state(cl, Client_Error);
 485         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 486                 error, addinfo, client_get_url(cl));
 487     }
 488     else
 489     {
 490         yaz_log(YLOG_DEBUG, "client_search_response: hits "
 491                 ODR_INT_PRINTF, cl->hits);
 492         client_report_facets(cl, resultset);
 493         cl->record_offset = cl->startrecs;
 494         cl->hits = ZOOM_resultset_size(resultset);
 495         if (se) {
 496             se->total_hits += cl->hits;
 497             yaz_log(YLOG_DEBUG, "client_search_response: total hits "
 498                     ODR_INT_PRINTF, se->total_hits);
 499         }
 500     }
 501 }
 502
 503 void client_got_records(struct client *cl)
 504 {
 505     struct session *se = cl->session;
 506     if (se)
 507     {
 508         client_unlock(cl);
 509         session_alert_watch(se, SESSION_WATCH_SHOW);
 510         session_alert_watch(se, SESSION_WATCH_RECORD);
 511         client_lock(cl);
 512     }
 513 }
 514
 515 void client_record_response(struct client *cl)
 516 {
 517     struct connection *co = cl->connection;
 518     ZOOM_connection link = connection_get_link(co);
 519     ZOOM_resultset resultset = cl->resultset;
 520     const char *error, *addinfo;
 521
 522     if (ZOOM_connection_error(link, &error, &addinfo))
 523     {
 524         client_set_state(cl, Client_Error);
 525         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 526             error, addinfo, client_get_url(cl));
 527     }
 528     else
 529     {
 530         ZOOM_record rec = 0;
 531         const char *msg, *addinfo;
 532
 533         if (cl->show_raw && cl->show_raw->active)
 534         {
 535             if ((rec = ZOOM_resultset_record(resultset,
 536                                              cl->show_raw->position-1)))
 537             {
 538                 cl->show_raw->active = 0;
 539                 ingest_raw_record(cl, rec);
 540             }
 541             else
 542             {
 543                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 544                         cl->show_raw->position-1);
 545             }
 546         }
 547         else
 548         {
 549             int offset = cl->record_offset;
 550             if ((rec = ZOOM_resultset_record(resultset, offset)))
 551             {
 552                 cl->record_offset++;
 553                 if (cl->session == 0)
 554                     ;
 555                 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
 556                 {
 557                     yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
 558                             msg, addinfo, client_get_url(cl),
 559                             cl->record_offset);
 560                 }
 561                 else
 562                 {
 563                     struct session_database *sdb = client_get_database(cl);
 564                     NMEM nmem = nmem_create();
 565                     const char *xmlrec;
 566                     char type[80];
 567
 568                     if (nativesyntax_to_type(sdb, type, rec))
 569                         yaz_log(YLOG_WARN, "Failed to determine record type");
 570                     xmlrec = ZOOM_record_get(rec, type, NULL);
 571                     if (!xmlrec)
 572                         yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
 573                                 client_get_url(cl));
 574                     else
 575                     {
 576                         if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
 577                             yaz_log(YLOG_WARN, "Failed to ingest from %s",
 578                                     client_get_url(cl));
 579                     }
 580                     nmem_destroy(nmem);
 581                 }
 582             }
 583             else
 584             {
 585                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 586                         offset);
 587             }
 588         }
 589     }
 590 }
 591
 592 static int client_set_facets_request(struct client *cl, ZOOM_connection link)
 593 {
 594     struct session_database *sdb = client_get_database(cl);
 595     const char *opt_facet_term_sort  = session_setting_oneval(sdb, PZ_TERMLIST_TERM_SORT);
 596     const char *opt_facet_term_count = session_setting_oneval(sdb, PZ_TERMLIST_TERM_COUNT);
 597
 598     /* Future record filtering on target */
 599     /* const char *opt_facet_record_filter = session_setting_oneval(sdb, PZ_RECORDFILTER); */
 600
 601     /* Disable when no count is set */
 602     /* TODO Verify: Do we need to reset the  ZOOM facets if a ZOOM Connection is being reused??? */
 603     if (opt_facet_term_count && *opt_facet_term_count)
 604     {
 605         int index = 0;
 606         struct session *session = client_get_session(cl);
 607         struct conf_service *service = session->service;
 608         int num = service->num_metadata;
 609         WRBUF wrbuf = wrbuf_alloc();
 610         yaz_log(YLOG_DEBUG, "Facet settings, sort: %s count: %s",
 611                 opt_facet_term_sort, opt_facet_term_count);
 612         for (index = 0; index < num; index++)
 613         {
 614             struct conf_metadata *conf_meta = &service->metadata[index];
 615             if (conf_meta->termlist)
 616             {
 617                 if (wrbuf_len(wrbuf))
 618                     wrbuf_puts(wrbuf, ", ");
 619                 wrbuf_printf(wrbuf, "@attr 1=%s", conf_meta->name);
 620
 621                 if (opt_facet_term_sort && *opt_facet_term_sort)
 622                     wrbuf_printf(wrbuf, " @attr 2=%s", opt_facet_term_sort);
 623                 wrbuf_printf(wrbuf, " @attr 3=%s", opt_facet_term_count);
 624             }
 625         }
 626         if (wrbuf_len(wrbuf))
 627         {
 628             yaz_log(YLOG_LOG, "Setting ZOOM facets option: %s", wrbuf_cstr(wrbuf));
 629             ZOOM_connection_option_set(link, "facets", wrbuf_cstr(wrbuf));
 630             return 1;
 631         }
 632     }
 633     return 0;
 634 }
 635
 636 int client_has_facet(struct client *cl, const char *name) {
 637     ZOOM_facet_field facet_field;
 638     if (!cl || !cl->resultset || !name) {
 639         yaz_log(YLOG_DEBUG, "client has facet: Missing %p %p %s", cl, (cl ? cl->resultset: 0), name);
 640         return 0;
 641     }
 642     facet_field = ZOOM_resultset_get_facet_field(cl->resultset, name);
 643     if (facet_field) {
 644         yaz_log(YLOG_DEBUG, "client: has facets for %s", name);
 645         return 1;
 646     }
 647     yaz_log(YLOG_DEBUG, "client: No facets for %s", name);
 648     return 0;
 649 }
 650
 651
 652 void client_start_search(struct client *cl)
 653 {
 654     struct session_database *sdb = client_get_database(cl);
 655     struct connection *co = client_get_connection(cl);
 656     ZOOM_connection link = connection_get_link(co);
 657     ZOOM_resultset rs;
 658     char *databaseName = sdb->database->databases[0];
 659     const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
 660     const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
 661     const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
 662     const char *opt_requestsyn  = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 663     const char *opt_maxrecs     = session_setting_oneval(sdb, PZ_MAXRECS);
 664     const char *opt_sru         = session_setting_oneval(sdb, PZ_SRU);
 665     const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
 666     const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
 667     char maxrecs_str[24], startrecs_str[24];
 668
 669     assert(link);
 670
 671     cl->hits = -1;
 672     cl->record_offset = 0;
 673     cl->diagnostic = 0;
 674
 675     if (opt_preferred) {
 676         cl->preferred = atoi(opt_preferred);
 677         if (cl->preferred)
 678             yaz_log(YLOG_LOG, "Target %s has preferred status: %d", sdb->database->url, cl->preferred);
 679     }
 680     client_set_state(cl, Client_Working);
 681
 682     if (*opt_piggyback)
 683         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
 684     else
 685         ZOOM_connection_option_set(link, "piggyback", "1");
 686     if (*opt_queryenc)
 687         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
 688     if (*opt_sru && *opt_elements)
 689         ZOOM_connection_option_set(link, "schema", opt_elements);
 690     else if (*opt_elements)
 691         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
 692     if (*opt_requestsyn)
 693         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
 694
 695     if (opt_maxrecs && *opt_maxrecs)
 696     {
 697         cl->maxrecs = atoi(opt_maxrecs);
 698     }
 699
 700     /* convert back to string representation used in ZOOM API */
 701     sprintf(maxrecs_str, "%d", cl->maxrecs);
 702     ZOOM_connection_option_set(link, "count", maxrecs_str);
 703
 704     if (cl->maxrecs > 20)
 705         ZOOM_connection_option_set(link, "presentChunk", "20");
 706     else
 707         ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
 708
 709     sprintf(startrecs_str, "%d", cl->startrecs);
 710     ZOOM_connection_option_set(link, "start", startrecs_str);
 711
 712     if (databaseName)
 713         ZOOM_connection_option_set(link, "databaseName", databaseName);
 714
 715     /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
 716     /* facets definition is in PQF */
 717     client_set_facets_request(cl, link);
 718
 719     if (cl->cqlquery)
 720     {
 721         ZOOM_query q = ZOOM_query_create();
 722         yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
 723         ZOOM_query_cql(q, cl->cqlquery);
 724         if (*opt_sort)
 725             ZOOM_query_sortby(q, opt_sort);
 726         rs = ZOOM_connection_search(link, q);
 727         ZOOM_query_destroy(q);
 728     }
 729     else
 730     {
 731         yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
 732         rs = ZOOM_connection_search_pqf(link, cl->pquery);
 733     }
 734     ZOOM_resultset_destroy(cl->resultset);
 735     cl->resultset = rs;
 736     connection_continue(co);
 737 }
 738
 739 struct client *client_create(void)
 740 {
 741     struct client *cl = xmalloc(sizeof(*cl));
 742     cl->maxrecs = 100;
 743     cl->startrecs = 0;
 744     cl->pquery = 0;
 745     cl->cqlquery = 0;
 746     cl->database = 0;
 747     cl->connection = 0;
 748     cl->session = 0;
 749     cl->hits = 0;
 750     cl->record_offset = 0;
 751     cl->diagnostic = 0;
 752     cl->state = Client_Disconnected;
 753     cl->show_raw = 0;
 754     cl->resultset = 0;
 755     cl->mutex = 0;
 756     pazpar2_mutex_create(&cl->mutex, "client");
 757     cl->preferred = 0;
 758     cl->ref_count = 1;
 759     cl->url = 0;
 760     client_use(1);
 761
 762     return cl;
 763 }
 764
 765 void client_lock(struct client *c)
 766 {
 767     yaz_mutex_enter(c->mutex);
 768 }
 769
 770 void client_unlock(struct client *c)
 771 {
 772     yaz_mutex_leave(c->mutex);
 773 }
 774
 775 void client_incref(struct client *c)
 776 {
 777     pazpar2_incref(&c->ref_count, c->mutex);
 778     yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
 779             c, client_get_url(c), c->ref_count);
 780 }
 781
 782 int client_destroy(struct client *c)
 783 {
 784     if (c)
 785     {
 786         yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
 787                 c, client_get_url(c), c->ref_count);
 788         if (!pazpar2_decref(&c->ref_count, c->mutex))
 789         {
 790             xfree(c->pquery);
 791             c->pquery = 0;
 792             xfree(c->cqlquery);
 793             c->cqlquery = 0;
 794             xfree(c->url);
 795             assert(!c->connection);
 796
 797             if (c->resultset)
 798             {
 799                 ZOOM_resultset_destroy(c->resultset);
 800             }
 801             yaz_mutex_destroy(&c->mutex);
 802             xfree(c);
 803             client_use(-1);
 804             return 1;
 805         }
 806     }
 807     return 0;
 808 }
 809
 810 void client_set_connection(struct client *cl, struct connection *con)
 811 {
 812     if (cl->resultset)
 813         ZOOM_resultset_release(cl->resultset);
 814     if (con)
 815     {
 816         assert(cl->connection == 0);
 817         cl->connection = con;
 818         client_incref(cl);
 819     }
 820     else
 821     {
 822         cl->connection = con;
 823         client_destroy(cl);
 824     }
 825 }
 826
 827 void client_disconnect(struct client *cl)
 828 {
 829     if (cl->state != Client_Idle)
 830         client_set_state(cl, Client_Disconnected);
 831     client_set_connection(cl, 0);
 832 }
 833
 834 // Extract terms from query into null-terminated termlist
 835 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
 836 {
 837     int num = 0;
 838
 839     pull_terms(nmem, query, termlist, &num);
 840     termlist[num] = 0;
 841 }
 842
 843 // Initialize CCL map for a target
 844 static CCL_bibset prepare_cclmap(struct client *cl)
 845 {
 846     struct session_database *sdb = client_get_database(cl);
 847     struct setting *s;
 848     CCL_bibset res;
 849
 850     if (!sdb->settings)
 851         return 0;
 852     res = ccl_qual_mk();
 853     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
 854     {
 855         char *p = strchr(s->name + 3, ':');
 856         if (!p)
 857         {
 858             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
 859             ccl_qual_rm(&res);
 860             return 0;
 861         }
 862         p++;
 863         ccl_qual_fitem(res, s->value, p);
 864     }
 865     return res;
 866 }
 867
 868 // returns a xmalloced CQL query corresponding to the pquery in client
 869 static char *make_cqlquery(struct client *cl)
 870 {
 871     cql_transform_t cqlt = cql_transform_create();
 872     Z_RPNQuery *zquery;
 873     char *r;
 874     WRBUF wrb = wrbuf_alloc();
 875     int status;
 876     ODR odr_out = odr_createmem(ODR_ENCODE);
 877
 878     zquery = p_query_rpn(odr_out, cl->pquery);
 879     yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
 880     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
 881     {
 882         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
 883         r = 0;
 884     }
 885     else
 886     {
 887         r = xstrdup(wrbuf_cstr(wrb));
 888     }
 889     wrbuf_destroy(wrb);
 890     odr_destroy(odr_out);
 891     cql_transform_close(cqlt);
 892     return r;
 893 }
 894
 895 // returns a xmalloced SOLR query corresponding to the pquery in client
 896 // TODO Could prob. be merge with the similar make_cqlquery
 897 static char *make_solrquery(struct client *cl)
 898 {
 899     solr_transform_t sqlt = solr_transform_create();
 900     Z_RPNQuery *zquery;
 901     char *r;
 902     WRBUF wrb = wrbuf_alloc();
 903     int status;
 904     ODR odr_out = odr_createmem(ODR_ENCODE);
 905
 906     zquery = p_query_rpn(odr_out, cl->pquery);
 907     yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
 908     if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
 909     {
 910         yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
 911         r = 0;
 912     }
 913     else
 914     {
 915         r = xstrdup(wrbuf_cstr(wrb));
 916     }
 917     wrbuf_destroy(wrb);
 918     odr_destroy(odr_out);
 919     solr_transform_close(sqlt);
 920     return r;
 921 }
 922
 923 // Parse the query given the settings specific to this client
 924 int client_parse_query(struct client *cl, const char *query)
 925 {
 926     struct session *se = client_get_session(cl);
 927     struct session_database *sdb = client_get_database(cl);
 928     struct ccl_rpn_node *cn;
 929     int cerror, cpos;
 930     CCL_bibset ccl_map = prepare_cclmap(cl);
 931     const char *sru = session_setting_oneval(sdb, PZ_SRU);
 932     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
 933     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
 934
 935     if (!ccl_map)
 936         return -1;
 937
 938     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
 939     ccl_qual_rm(&ccl_map);
 940     if (!cn)
 941     {
 942         client_set_state(cl, Client_Error);
 943         session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s",
 944                 query,
 945                 client_get_database(cl)->database->url);
 946         return -1;
 947     }
 948     wrbuf_rewind(se->wrbuf);
 949     if (*pqf_prefix)
 950     {
 951         wrbuf_puts(se->wrbuf, pqf_prefix);
 952         wrbuf_puts(se->wrbuf, " ");
 953     }
 954     if (!pqf_strftime || !*pqf_strftime)
 955         ccl_pquery(se->wrbuf, cn);
 956     else
 957     {
 958         time_t cur_time = time(0);
 959         struct tm *tm =  localtime(&cur_time);
 960         char tmp_str[300];
 961         const char *cp = tmp_str;
 962
 963         /* see man strftime(3) for things .. In particular %% gets converted
 964          to %.. And That's our original query .. */
 965         strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
 966         for (; *cp; cp++)
 967         {
 968             if (cp[0] == '%')
 969                 ccl_pquery(se->wrbuf, cn);
 970             else
 971                 wrbuf_putc(se->wrbuf, cp[0]);
 972         }
 973     }
 974     xfree(cl->pquery);
 975     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
 976
 977     xfree(cl->cqlquery);
 978     if (*sru)
 979     {
 980         if (!strcmp(sru, "solr")) {
 981             if (!(cl->cqlquery = make_solrquery(cl)))
 982                 return -1;
 983         }
 984         else {
 985             if (!(cl->cqlquery = make_cqlquery(cl)))
 986                 return -1;
 987         }
 988     }
 989     else
 990         cl->cqlquery = 0;
 991
 992     /* TODO FIX Not thread safe */
 993     if (!se->relevance)
 994     {
 995         // Initialize relevance structure with query terms
 996         char *p[512];
 997         extract_terms(se->nmem, cn, p);
 998         se->relevance = relevance_create(
 999             se->service->relevance_pct,
1000             se->nmem, (const char **) p);
1001     }
1002
1003     ccl_rpn_delete(cn);
1004     return 0;
1005 }
1006
1007 void client_set_session(struct client *cl, struct session *se)
1008 {
1009     cl->session = se;
1010 }
1011
1012 int client_is_active(struct client *cl)
1013 {
1014     if (cl->connection && (cl->state == Client_Connecting ||
1015                            cl->state == Client_Working))
1016         return 1;
1017     return 0;
1018 }
1019
1020 int client_is_active_preferred(struct client *cl)
1021 {
1022     /* only count if this is a preferred target. */
1023     if (!cl->preferred)
1024         return 0;
1025     /* TODO No sure this the condition that Seb wants */
1026     if (cl->connection && (cl->state == Client_Connecting ||
1027                            cl->state == Client_Working))
1028         return 1;
1029     return 0;
1030 }
1031
1032
1033 Odr_int client_get_hits(struct client *cl)
1034 {
1035     return cl->hits;
1036 }
1037
1038 int client_get_num_records(struct client *cl)
1039 {
1040     return cl->record_offset;
1041 }
1042
1043 void client_set_diagnostic(struct client *cl, int diagnostic)
1044 {
1045     cl->diagnostic = diagnostic;
1046 }
1047
1048 int client_get_diagnostic(struct client *cl)
1049 {
1050     return cl->diagnostic;
1051 }
1052
1053 void client_set_database(struct client *cl, struct session_database *db)
1054 {
1055     cl->database = db;
1056     /* Copy the URL for safe logging even after session is gone */
1057     if (db) {
1058         cl->url = xstrdup(db->database->url);
1059     }
1060 }
1061
1062 struct host *client_get_host(struct client *cl)
1063 {
1064     return client_get_database(cl)->database->host;
1065 }
1066
1067 const char *client_get_url(struct client *cl)
1068 {
1069     if (cl->url)
1070         return cl->url;
1071     else
1072         /* This must not happen anymore, as the url is present until destruction of client  */
1073         return "NOURL";
1074 }
1075
1076 void client_set_maxrecs(struct client *cl, int v)
1077 {
1078     cl->maxrecs = v;
1079 }
1080
1081 int client_get_maxrecs(struct client *cl)
1082 {
1083     return cl->maxrecs;
1084 }
1085
1086 void client_set_startrecs(struct client *cl, int v)
1087 {
1088     cl->startrecs = v;
1089 }
1090
1091 void client_set_preferred(struct client *cl, int v)
1092 {
1093     cl->preferred = v;
1094 }
1095
1096
1097 /*
1098  * Local variables:
1099  * c-basic-offset: 4
1100  * c-file-style: "Stroustrup"
1101  * indent-tabs-mode: nil
1102  * End:
1103  * vim: shiftwidth=4 tabstop=8 expandtab
1104  */
1105