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