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 void client_report_facets(struct client *cl, ZOOM_resultset rs)
 427 {
 428     int facet_idx;
 429     struct session_database *sdb = client_get_database(cl);
 430     ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
 431     int facet_num;
 432     struct session *se = client_get_session(cl);
 433     struct setting *s;
 434     facet_num = ZOOM_resultset_facets_size(rs);
 435     yaz_log(YLOG_DEBUG, "client_report_facets: %d", facet_num);
 436
 437     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 438     {
 439         const char *p = strchr(s->name + 3, ':');
 440         if (p && p[1] && s->value && s->value[0])
 441         {
 442             p++; /* p now holds logical facet name */
 443             for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
 444             {
 445                 const char *native_name =
 446                     ZOOM_facet_field_name(facets[facet_idx]);
 447                 if (native_name && !strcmp(s->value, native_name))
 448                 {
 449                     size_t term_idx;
 450                     size_t term_num =
 451                         ZOOM_facet_field_term_count(facets[facet_idx]);
 452                     for (term_idx = 0; term_idx < term_num; term_idx++ )
 453                     {
 454                         int freq;
 455                         const char *term =
 456                             ZOOM_facet_field_get_term(facets[facet_idx],
 457                                                       term_idx, &freq);
 458                         if (term)
 459                             add_facet(se, p, term, freq);
 460                     }
 461                     break;
 462                 }
 463             }
 464         }
 465     }
 466 }
 467
 468 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
 469 {
 470     const char *buf;
 471     int len;
 472     char type[80];
 473
 474     if (cl->show_raw->binary)
 475         strcpy(type, "raw");
 476     else
 477     {
 478         struct session_database *sdb = client_get_database(cl);
 479         nativesyntax_to_type(sdb, type, rec);
 480     }
 481
 482     buf = ZOOM_record_get(rec, type, &len);
 483     cl->show_raw->record_handler(cl->show_raw->data,  buf, len);
 484     client_show_raw_dequeue(cl);
 485 }
 486
 487 void client_check_preferred_watch(struct client *cl)
 488 {
 489     struct session *se = cl->session;
 490     yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_url(cl));
 491     if (se)
 492     {
 493         client_unlock(cl);
 494         /* TODO possible threading issue. Session can have been destroyed */
 495         if (session_is_preferred_clients_ready(se)) {
 496             session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
 497         }
 498         else
 499             yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
 500
 501         client_lock(cl);
 502     }
 503     else
 504         yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_url(cl));
 505
 506 }
 507
 508 void client_search_response(struct client *cl)
 509 {
 510     struct connection *co = cl->connection;
 511     struct session *se = cl->session;
 512     ZOOM_connection link = connection_get_link(co);
 513     ZOOM_resultset resultset = cl->resultset;
 514
 515     const char *error, *addinfo = 0;
 516
 517     if (ZOOM_connection_error(link, &error, &addinfo))
 518     {
 519         cl->hits = 0;
 520         client_set_state(cl, Client_Error);
 521         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 522                 error, addinfo, client_get_url(cl));
 523     }
 524     else
 525     {
 526         yaz_log(YLOG_DEBUG, "client_search_response: hits "
 527                 ODR_INT_PRINTF, cl->hits);
 528         client_report_facets(cl, resultset);
 529         cl->record_offset = cl->startrecs;
 530         cl->hits = ZOOM_resultset_size(resultset);
 531         if (se) {
 532             se->total_hits += cl->hits;
 533             yaz_log(YLOG_DEBUG, "client_search_response: total hits "
 534                     ODR_INT_PRINTF, se->total_hits);
 535         }
 536     }
 537 }
 538
 539 void client_got_records(struct client *cl)
 540 {
 541     struct session *se = cl->session;
 542     if (se)
 543     {
 544         client_unlock(cl);
 545         session_alert_watch(se, SESSION_WATCH_SHOW);
 546         session_alert_watch(se, SESSION_WATCH_RECORD);
 547         client_lock(cl);
 548     }
 549 }
 550
 551 void client_record_response(struct client *cl)
 552 {
 553     struct connection *co = cl->connection;
 554     ZOOM_connection link = connection_get_link(co);
 555     ZOOM_resultset resultset = cl->resultset;
 556     const char *error, *addinfo;
 557
 558     if (ZOOM_connection_error(link, &error, &addinfo))
 559     {
 560         client_set_state(cl, Client_Error);
 561         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 562             error, addinfo, client_get_url(cl));
 563     }
 564     else
 565     {
 566         ZOOM_record rec = 0;
 567         const char *msg, *addinfo;
 568
 569         if (cl->show_raw && cl->show_raw->active)
 570         {
 571             if ((rec = ZOOM_resultset_record(resultset,
 572                                              cl->show_raw->position-1)))
 573             {
 574                 cl->show_raw->active = 0;
 575                 ingest_raw_record(cl, rec);
 576             }
 577             else
 578             {
 579                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 580                         cl->show_raw->position-1);
 581             }
 582         }
 583         else
 584         {
 585             int offset = cl->record_offset;
 586             if ((rec = ZOOM_resultset_record(resultset, offset)))
 587             {
 588                 cl->record_offset++;
 589                 if (cl->session == 0)
 590                     ;
 591                 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
 592                 {
 593                     yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
 594                             msg, addinfo, client_get_url(cl),
 595                             cl->record_offset);
 596                 }
 597                 else
 598                 {
 599                     struct session_database *sdb = client_get_database(cl);
 600                     NMEM nmem = nmem_create();
 601                     const char *xmlrec;
 602                     char type[80];
 603
 604                     if (nativesyntax_to_type(sdb, type, rec))
 605                         yaz_log(YLOG_WARN, "Failed to determine record type");
 606                     xmlrec = ZOOM_record_get(rec, type, NULL);
 607                     if (!xmlrec)
 608                         yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
 609                                 client_get_url(cl));
 610                     else
 611                     {
 612                         /* OK = 0, -1 = failure, -2 = Filtered */
 613                         if (ingest_record(cl, xmlrec, cl->record_offset, nmem) == -1)
 614                             yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_url(cl));
 615                     }
 616                     nmem_destroy(nmem);
 617                 }
 618             }
 619             else
 620             {
 621                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 622                         offset);
 623             }
 624         }
 625     }
 626 }
 627
 628 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
 629 {
 630     struct session_database *sdb = client_get_database(cl);
 631
 632     WRBUF w = wrbuf_alloc();
 633
 634     struct setting *s;
 635
 636     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 637     {
 638         const char *p = strchr(s->name + 3, ':');
 639         if (!p)
 640         {
 641             yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
 642         }
 643         else if (s->value && s->value[0])
 644         {
 645             wrbuf_puts(w, "@attr 1=");
 646             yaz_encode_pqf_term(w, s->value, strlen(s->value));
 647             if (s->next)
 648                 wrbuf_puts(w, ",");
 649         }
 650     }
 651     yaz_log(YLOG_LOG, "using facets str: %s", wrbuf_cstr(w));
 652     ZOOM_connection_option_set(link, "facets",
 653                                wrbuf_len(w) ? wrbuf_cstr(w) : 0);
 654     wrbuf_destroy(w);
 655 }
 656
 657 int client_has_facet(struct client *cl, const char *name)
 658 {
 659     struct session_database *sdb = client_get_database(cl);
 660     struct setting *s;
 661
 662     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 663     {
 664         const char *p = strchr(s->name + 3, ':');
 665         if (p && !strcmp(name, p + 1))
 666             return 1;
 667     }
 668     return 0;
 669 }
 670
 671 void client_start_search(struct client *cl)
 672 {
 673     struct session_database *sdb = client_get_database(cl);
 674     struct connection *co = client_get_connection(cl);
 675     ZOOM_connection link = connection_get_link(co);
 676     ZOOM_resultset rs;
 677     char *databaseName = sdb->database->databases[0];
 678     const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
 679     const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
 680     const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
 681     const char *opt_requestsyn  = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 682     const char *opt_maxrecs     = session_setting_oneval(sdb, PZ_MAXRECS);
 683     const char *opt_sru         = session_setting_oneval(sdb, PZ_SRU);
 684     const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
 685     const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
 686     const char *extra_args      = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
 687     char maxrecs_str[24], startrecs_str[24];
 688
 689     assert(link);
 690
 691     cl->hits = -1;
 692     cl->record_offset = 0;
 693     cl->diagnostic = 0;
 694
 695     if (extra_args && *extra_args)
 696         ZOOM_connection_option_set(link, "extraArgs", extra_args);
 697
 698     if (opt_preferred) {
 699         cl->preferred = atoi(opt_preferred);
 700         if (cl->preferred)
 701             yaz_log(YLOG_LOG, "Target %s has preferred status: %d", sdb->database->url, cl->preferred);
 702     }
 703     client_set_state(cl, Client_Working);
 704
 705     if (*opt_piggyback)
 706         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
 707     else
 708         ZOOM_connection_option_set(link, "piggyback", "1");
 709     if (*opt_queryenc)
 710         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
 711     if (*opt_sru && *opt_elements)
 712         ZOOM_connection_option_set(link, "schema", opt_elements);
 713     else if (*opt_elements)
 714         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
 715     if (*opt_requestsyn)
 716         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
 717
 718     if (opt_maxrecs && *opt_maxrecs)
 719     {
 720         cl->maxrecs = atoi(opt_maxrecs);
 721     }
 722
 723     /* convert back to string representation used in ZOOM API */
 724     sprintf(maxrecs_str, "%d", cl->maxrecs);
 725     ZOOM_connection_option_set(link, "count", maxrecs_str);
 726
 727     if (cl->maxrecs > 20)
 728         ZOOM_connection_option_set(link, "presentChunk", "20");
 729     else
 730         ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
 731
 732     sprintf(startrecs_str, "%d", cl->startrecs);
 733     ZOOM_connection_option_set(link, "start", startrecs_str);
 734
 735     if (databaseName)
 736         ZOOM_connection_option_set(link, "databaseName", databaseName);
 737
 738     /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
 739     /* facets definition is in PQF */
 740     client_set_facets_request(cl, link);
 741
 742     if (cl->cqlquery)
 743     {
 744         ZOOM_query q = ZOOM_query_create();
 745         yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
 746         ZOOM_query_cql(q, cl->cqlquery);
 747         if (*opt_sort)
 748             ZOOM_query_sortby(q, opt_sort);
 749         rs = ZOOM_connection_search(link, q);
 750         ZOOM_query_destroy(q);
 751     }
 752     else
 753     {
 754         yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
 755         rs = ZOOM_connection_search_pqf(link, cl->pquery);
 756     }
 757     ZOOM_resultset_destroy(cl->resultset);
 758     cl->resultset = rs;
 759     connection_continue(co);
 760 }
 761
 762 struct client *client_create(void)
 763 {
 764     struct client *cl = xmalloc(sizeof(*cl));
 765     cl->maxrecs = 100;
 766     cl->startrecs = 0;
 767     cl->pquery = 0;
 768     cl->cqlquery = 0;
 769     cl->database = 0;
 770     cl->connection = 0;
 771     cl->session = 0;
 772     cl->hits = 0;
 773     cl->record_offset = 0;
 774     cl->diagnostic = 0;
 775     cl->state = Client_Disconnected;
 776     cl->show_raw = 0;
 777     cl->resultset = 0;
 778     cl->mutex = 0;
 779     pazpar2_mutex_create(&cl->mutex, "client");
 780     cl->preferred = 0;
 781     cl->ref_count = 1;
 782     cl->url = 0;
 783     client_use(1);
 784
 785     return cl;
 786 }
 787
 788 void client_lock(struct client *c)
 789 {
 790     yaz_mutex_enter(c->mutex);
 791 }
 792
 793 void client_unlock(struct client *c)
 794 {
 795     yaz_mutex_leave(c->mutex);
 796 }
 797
 798 void client_incref(struct client *c)
 799 {
 800     pazpar2_incref(&c->ref_count, c->mutex);
 801     yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
 802             c, client_get_url(c), c->ref_count);
 803 }
 804
 805 int client_destroy(struct client *c)
 806 {
 807     if (c)
 808     {
 809         yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
 810                 c, client_get_url(c), c->ref_count);
 811         if (!pazpar2_decref(&c->ref_count, c->mutex))
 812         {
 813             xfree(c->pquery);
 814             c->pquery = 0;
 815             xfree(c->cqlquery);
 816             c->cqlquery = 0;
 817             xfree(c->url);
 818             assert(!c->connection);
 819
 820             if (c->resultset)
 821             {
 822                 ZOOM_resultset_destroy(c->resultset);
 823             }
 824             yaz_mutex_destroy(&c->mutex);
 825             xfree(c);
 826             client_use(-1);
 827             return 1;
 828         }
 829     }
 830     return 0;
 831 }
 832
 833 void client_set_connection(struct client *cl, struct connection *con)
 834 {
 835     if (cl->resultset)
 836         ZOOM_resultset_release(cl->resultset);
 837     if (con)
 838     {
 839         assert(cl->connection == 0);
 840         cl->connection = con;
 841         client_incref(cl);
 842     }
 843     else
 844     {
 845         cl->connection = con;
 846         client_destroy(cl);
 847     }
 848 }
 849
 850 void client_disconnect(struct client *cl)
 851 {
 852     if (cl->state != Client_Idle)
 853         client_set_state(cl, Client_Disconnected);
 854     client_set_connection(cl, 0);
 855 }
 856
 857 // Extract terms from query into null-terminated termlist
 858 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
 859 {
 860     int num = 0;
 861
 862     pull_terms(nmem, query, termlist, &num);
 863     termlist[num] = 0;
 864 }
 865
 866 // Initialize CCL map for a target
 867 static CCL_bibset prepare_cclmap(struct client *cl)
 868 {
 869     struct session_database *sdb = client_get_database(cl);
 870     struct setting *s;
 871     CCL_bibset res;
 872
 873     if (!sdb->settings)
 874         return 0;
 875     res = ccl_qual_mk();
 876     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
 877     {
 878         char *p = strchr(s->name + 3, ':');
 879         if (!p)
 880         {
 881             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
 882             ccl_qual_rm(&res);
 883             return 0;
 884         }
 885         p++;
 886         ccl_qual_fitem(res, s->value, p);
 887     }
 888     return res;
 889 }
 890
 891 // returns a xmalloced CQL query corresponding to the pquery in client
 892 static char *make_cqlquery(struct client *cl)
 893 {
 894     cql_transform_t cqlt = cql_transform_create();
 895     Z_RPNQuery *zquery;
 896     char *r;
 897     WRBUF wrb = wrbuf_alloc();
 898     int status;
 899     ODR odr_out = odr_createmem(ODR_ENCODE);
 900
 901     zquery = p_query_rpn(odr_out, cl->pquery);
 902     yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
 903     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
 904     {
 905         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
 906         r = 0;
 907     }
 908     else
 909     {
 910         r = xstrdup(wrbuf_cstr(wrb));
 911     }
 912     wrbuf_destroy(wrb);
 913     odr_destroy(odr_out);
 914     cql_transform_close(cqlt);
 915     return r;
 916 }
 917
 918 // returns a xmalloced SOLR query corresponding to the pquery in client
 919 // TODO Could prob. be merge with the similar make_cqlquery
 920 static char *make_solrquery(struct client *cl)
 921 {
 922     solr_transform_t sqlt = solr_transform_create();
 923     Z_RPNQuery *zquery;
 924     char *r;
 925     WRBUF wrb = wrbuf_alloc();
 926     int status;
 927     ODR odr_out = odr_createmem(ODR_ENCODE);
 928
 929     zquery = p_query_rpn(odr_out, cl->pquery);
 930     yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
 931     if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
 932     {
 933         yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
 934         r = 0;
 935     }
 936     else
 937     {
 938         r = xstrdup(wrbuf_cstr(wrb));
 939     }
 940     wrbuf_destroy(wrb);
 941     odr_destroy(odr_out);
 942     solr_transform_close(sqlt);
 943     return r;
 944 }
 945
 946 // Parse the query given the settings specific to this client
 947 int client_parse_query(struct client *cl, const char *query)
 948 {
 949     struct session *se = client_get_session(cl);
 950     struct session_database *sdb = client_get_database(cl);
 951     struct ccl_rpn_node *cn;
 952     struct ccl_rpn_node *cn_recordfilter = 0;
 953     int cerror, cpos;
 954     CCL_bibset ccl_map = prepare_cclmap(cl);
 955     const char *sru = session_setting_oneval(sdb, PZ_SRU);
 956     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
 957     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
 958     const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
 959     /* Collected, Mixed, Remote */
 960     const char *option_recordfilter = session_setting_oneval(sdb, PZ_OPTION_RECORDFILTER);
 961     const char *record_filter = session_setting_oneval(sdb, PZ_RECORDFILTER);
 962     if (!ccl_map)
 963         return -1;
 964
 965     yaz_log(YLOG_DEBUG, "query: %s", query);
 966     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
 967     if (strcmp("remote", option_recordfilter) == 0 && record_filter != 0 && record_filter[0] != 0) {
 968         int cerror, cpos;
 969         yaz_log(YLOG_DEBUG, "record_filter: %s", record_filter);
 970         cn_recordfilter = ccl_find_str(ccl_map, record_filter, &cerror, &cpos);
 971         if (!cn_recordfilter)
 972             session_log(se, YLOG_WARN, "Failed to parse CCL record filter '%s' for %s",
 973                     record_filter, client_get_database(cl)->database->url);
 974     }
 975     ccl_qual_rm(&ccl_map);
 976     if (!cn)
 977     {
 978         client_set_state(cl, Client_Error);
 979         session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s",
 980                 query,
 981                 client_get_database(cl)->database->url);
 982         return -1;
 983     }
 984     wrbuf_rewind(se->wrbuf);
 985     if (*pqf_prefix)
 986     {
 987         wrbuf_puts(se->wrbuf, pqf_prefix);
 988         wrbuf_puts(se->wrbuf, " ");
 989     }
 990
 991     if (cn_recordfilter) {
 992         wrbuf_puts(se->wrbuf, "@and ");
 993         ccl_pquery(se->wrbuf, cn_recordfilter);
 994         wrbuf_puts(se->wrbuf, " ");
 995     }
 996
 997     if (!pqf_strftime || !*pqf_strftime)
 998         ccl_pquery(se->wrbuf, cn);
 999     else
1000     {
1001         time_t cur_time = time(0);
1002         struct tm *tm =  localtime(&cur_time);
1003         char tmp_str[300];
1004         const char *cp = tmp_str;
1005
1006         /* see man strftime(3) for things .. In particular %% gets converted
1007          to %.. And That's our original query .. */
1008         strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1009         for (; *cp; cp++)
1010         {
1011             if (cp[0] == '%')
1012                 ccl_pquery(se->wrbuf, cn);
1013             else
1014                 wrbuf_putc(se->wrbuf, cp[0]);
1015         }
1016     }
1017     xfree(cl->pquery);
1018     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
1019
1020     yaz_log(YLOG_DEBUG, "PQF query: %s", cl->pquery);
1021
1022     xfree(cl->cqlquery);
1023
1024     /* Support for PQF on SRU targets. */
1025     /* TODO Refactor */
1026     yaz_log(YLOG_DEBUG, "Query syntax: %s", query_syntax);
1027     if (strcmp(query_syntax, "pqf") != 0 && *sru)
1028     {
1029         if (!strcmp(sru, "solr")) {
1030             if (!(cl->cqlquery = make_solrquery(cl)))
1031                 return -1;
1032         }
1033         else {
1034             if (!(cl->cqlquery = make_cqlquery(cl)))
1035                 return -1;
1036         }
1037     }
1038     else
1039         cl->cqlquery = 0;
1040
1041     /* TODO FIX Not thread safe */
1042     if (!se->relevance)
1043     {
1044         // Initialize relevance structure with query terms
1045         char *p[512];
1046         extract_terms(se->nmem, cn, p);
1047         se->relevance = relevance_create(
1048             se->service->relevance_pct,
1049             se->nmem, (const char **) p);
1050     }
1051
1052     ccl_rpn_delete(cn);
1053     return 0;
1054 }
1055
1056 void client_set_session(struct client *cl, struct session *se)
1057 {
1058     cl->session = se;
1059 }
1060
1061 int client_is_active(struct client *cl)
1062 {
1063     if (cl->connection && (cl->state == Client_Connecting ||
1064                            cl->state == Client_Working))
1065         return 1;
1066     return 0;
1067 }
1068
1069 int client_is_active_preferred(struct client *cl)
1070 {
1071     /* only count if this is a preferred target. */
1072     if (!cl->preferred)
1073         return 0;
1074     /* TODO No sure this the condition that Seb wants */
1075     if (cl->connection && (cl->state == Client_Connecting ||
1076                            cl->state == Client_Working))
1077         return 1;
1078     return 0;
1079 }
1080
1081
1082 Odr_int client_get_hits(struct client *cl)
1083 {
1084     return cl->hits;
1085 }
1086
1087 int client_get_num_records(struct client *cl)
1088 {
1089     return cl->record_offset;
1090 }
1091
1092 void client_set_diagnostic(struct client *cl, int diagnostic)
1093 {
1094     cl->diagnostic = diagnostic;
1095 }
1096
1097 int client_get_diagnostic(struct client *cl)
1098 {
1099     return cl->diagnostic;
1100 }
1101
1102 void client_set_database(struct client *cl, struct session_database *db)
1103 {
1104     cl->database = db;
1105     /* Copy the URL for safe logging even after session is gone */
1106     if (db) {
1107         cl->url = xstrdup(db->database->url);
1108     }
1109 }
1110
1111 struct host *client_get_host(struct client *cl)
1112 {
1113     return client_get_database(cl)->database->host;
1114 }
1115
1116 const char *client_get_url(struct client *cl)
1117 {
1118     if (cl->url)
1119         return cl->url;
1120     else
1121         /* This must not happen anymore, as the url is present until destruction of client  */
1122         return "NOURL";
1123 }
1124
1125 void client_set_maxrecs(struct client *cl, int v)
1126 {
1127     cl->maxrecs = v;
1128 }
1129
1130 int client_get_maxrecs(struct client *cl)
1131 {
1132     return cl->maxrecs;
1133 }
1134
1135 void client_set_startrecs(struct client *cl, int v)
1136 {
1137     cl->startrecs = v;
1138 }
1139
1140 void client_set_preferred(struct client *cl, int v)
1141 {
1142     cl->preferred = v;
1143 }
1144
1145
1146 /*
1147  * Local variables:
1148  * c-basic-offset: 4
1149  * c-file-style: "Stroustrup"
1150  * indent-tabs-mode: nil
1151  * End:
1152  * vim: shiftwidth=4 tabstop=8 expandtab
1153  */
1154