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