src/client.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2013 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 #ifdef WIN32
  37 #include <windows.h>
  38 #endif
  39 #include <signal.h>
  40 #include <assert.h>
  41
  42 #include <yaz/marcdisp.h>
  43 #include <yaz/comstack.h>
  44 #include <yaz/tcpip.h>
  45 #include <yaz/proto.h>
  46 #include <yaz/readconf.h>
  47 #include <yaz/pquery.h>
  48 #include <yaz/otherinfo.h>
  49 #include <yaz/yaz-util.h>
  50 #include <yaz/nmem.h>
  51 #include <yaz/query-charset.h>
  52 #include <yaz/querytowrbuf.h>
  53 #include <yaz/oid_db.h>
  54 #include <yaz/diagbib1.h>
  55 #include <yaz/snprintf.h>
  56 #include <yaz/rpn2cql.h>
  57 #include <yaz/rpn2solr.h>
  58 #include <yaz/gettimeofday.h>
  59
  60 #define USE_TIMING 0
  61 #if USE_TIMING
  62 #include <yaz/timing.h>
  63 #endif
  64
  65 #include "ppmutex.h"
  66 #include "session.h"
  67 #include "parameters.h"
  68 #include "client.h"
  69 #include "connection.h"
  70 #include "settings.h"
  71 #include "relevance.h"
  72 #include "incref.h"
  73
  74 static YAZ_MUTEX g_mutex = 0;
  75 static int no_clients = 0;
  76 static int no_clients_total = 0;
  77
  78 static int client_use(int delta)
  79 {
  80     int clients;
  81     if (!g_mutex)
  82         yaz_mutex_create(&g_mutex);
  83     yaz_mutex_enter(g_mutex);
  84     no_clients += delta;
  85     if (delta > 0)
  86         no_clients_total += delta;
  87     clients = no_clients;
  88     yaz_mutex_leave(g_mutex);
  89     yaz_log(YLOG_DEBUG, "%s clients=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
  90     return clients;
  91 }
  92
  93 int  clients_count(void) {
  94     return client_use(0);
  95 }
  96
  97 int  clients_count_total(void) {
  98     int total = 0;
  99     if (!g_mutex)
 100         return 0;
 101     yaz_mutex_enter(g_mutex);
 102     total = no_clients_total;
 103     yaz_mutex_leave(g_mutex);
 104     return total;
 105 }
 106
 107
 108 /** \brief Represents client state for a connection to one search target */
 109 struct client {
 110     struct session_database *database;
 111     struct connection *connection;
 112     struct session *session;
 113     char *pquery; // Current search
 114     char *cqlquery; // used for SRU targets only
 115     char *addinfo; // diagnostic info for most resent error
 116     Odr_int hits;
 117     int record_offset;
 118     int filtered; // When using local:, this will count the number of filtered records.
 119     int maxrecs;
 120     int startrecs;
 121     int diagnostic;
 122     char *message;
 123     int preferred;
 124     struct suggestions *suggestions;
 125     enum client_state state;
 126     struct show_raw *show_raw;
 127     ZOOM_resultset resultset;
 128     YAZ_MUTEX mutex;
 129     int ref_count;
 130     char *id;
 131     facet_limits_t facet_limits;
 132     int same_search;
 133     char *sort_strategy;
 134     char *sort_criteria;
 135 };
 136
 137 struct suggestions {
 138     NMEM nmem;
 139     int num;
 140     char **misspelled;
 141     char **suggest;
 142     char *passthrough;
 143 };
 144
 145 struct show_raw {
 146     int active; // whether this request has been sent to the server
 147     int position;
 148     int binary;
 149     char *syntax;
 150     char *esn;
 151     char *nativesyntax;
 152     void (*error_handler)(void *data, const char *addinfo);
 153     void (*record_handler)(void *data, const char *buf, size_t sz);
 154     void *data;
 155     struct show_raw *next;
 156 };
 157
 158 static const char *client_states[] = {
 159     "Client_Connecting",
 160     "Client_Idle",
 161     "Client_Working",
 162     "Client_Error",
 163     "Client_Failed",
 164     "Client_Disconnected"
 165 };
 166
 167 const char *client_get_state_str(struct client *cl)
 168 {
 169     return client_states[cl->state];
 170 }
 171
 172 enum client_state client_get_state(struct client *cl)
 173 {
 174     return cl->state;
 175 }
 176
 177 void client_set_state_nb(struct client *cl, enum client_state st)
 178 {
 179     cl->state = st;
 180 }
 181
 182 void client_set_state(struct client *cl, enum client_state st)
 183 {
 184     int was_active = 0;
 185     if (client_is_active(cl))
 186         was_active = 1;
 187     cl->state = st;
 188     /* If client is going from being active to inactive and all clients
 189        are now idle we fire a watch for the session . The assumption is
 190        that session is not mutex locked if client is already active */
 191     if (was_active && !client_is_active(cl) && cl->session)
 192     {
 193
 194         int no_active = session_active_clients(cl->session);
 195         yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
 196                 client_get_id(cl), no_active);
 197         if (no_active == 0) {
 198             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
 199             session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
 200             session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
 201             session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
 202         }
 203     }
 204 }
 205
 206 static void client_show_raw_error(struct client *cl, const char *addinfo);
 207
 208 struct connection *client_get_connection(struct client *cl)
 209 {
 210     return cl->connection;
 211 }
 212
 213 struct session_database *client_get_database(struct client *cl)
 214 {
 215     return cl->database;
 216 }
 217
 218 struct session *client_get_session(struct client *cl)
 219 {
 220     return cl->session;
 221 }
 222
 223 const char *client_get_pquery(struct client *cl)
 224 {
 225     return cl->pquery;
 226 }
 227
 228 static void client_send_raw_present(struct client *cl);
 229 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
 230
 231 static void client_show_immediate(
 232     ZOOM_resultset resultset, struct session_database *sdb, int position,
 233     void *data,
 234     void (*error_handler)(void *data, const char *addinfo),
 235     void (*record_handler)(void *data, const char *buf, size_t sz),
 236     int binary,
 237     const char *nativesyntax)
 238 {
 239     ZOOM_record rec = 0;
 240     char type[80];
 241     const char *buf;
 242     int len;
 243
 244     if (!resultset)
 245     {
 246         error_handler(data, "no resultset");
 247         return;
 248     }
 249     rec = ZOOM_resultset_record_immediate(resultset, position-1);
 250     if (!rec)
 251     {
 252         error_handler(data, "no record");
 253         return;
 254     }
 255     nativesyntax_to_type(nativesyntax, type, rec);
 256     buf = ZOOM_record_get(rec, type, &len);
 257     if (!buf)
 258     {
 259         error_handler(data, "no record");
 260         return;
 261     }
 262     record_handler(data, buf, len);
 263 }
 264
 265
 266 int client_show_raw_begin(struct client *cl, int position,
 267                           const char *syntax, const char *esn,
 268                           void *data,
 269                           void (*error_handler)(void *data, const char *addinfo),
 270                           void (*record_handler)(void *data, const char *buf,
 271                                                  size_t sz),
 272                           int binary,
 273                           const char *nativesyntax)
 274 {
 275     if (!nativesyntax)
 276     {
 277         if (binary)
 278             nativesyntax = "raw";
 279         else
 280         {
 281             struct session_database *sdb = client_get_database(cl);
 282             nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
 283         }
 284     }
 285
 286     if (syntax == 0 && esn == 0)
 287         client_show_immediate(cl->resultset, client_get_database(cl),
 288                               position, data,
 289                               error_handler, record_handler,
 290                               binary, nativesyntax);
 291     else
 292     {
 293         struct show_raw *rr, **rrp;
 294
 295         if (!cl->connection)
 296             return -1;
 297
 298
 299         rr = xmalloc(sizeof(*rr));
 300         rr->position = position;
 301         rr->active = 0;
 302         rr->data = data;
 303         rr->error_handler = error_handler;
 304         rr->record_handler = record_handler;
 305         rr->binary = binary;
 306         if (syntax)
 307             rr->syntax = xstrdup(syntax);
 308         else
 309             rr->syntax = 0;
 310         if (esn)
 311             rr->esn = xstrdup(esn);
 312         else
 313             rr->esn = 0;
 314
 315         assert(nativesyntax);
 316         rr->nativesyntax = xstrdup(nativesyntax);
 317
 318         rr->next = 0;
 319
 320         for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
 321             ;
 322         *rrp = rr;
 323
 324         if (cl->state == Client_Failed)
 325         {
 326             client_show_raw_error(cl, "client failed");
 327         }
 328         else if (cl->state == Client_Disconnected)
 329         {
 330             client_show_raw_error(cl, "client disconnected");
 331         }
 332         else
 333         {
 334             client_send_raw_present(cl);
 335         }
 336     }
 337     return 0;
 338 }
 339
 340 static void client_show_raw_delete(struct show_raw *r)
 341 {
 342     xfree(r->syntax);
 343     xfree(r->esn);
 344     xfree(r->nativesyntax);
 345     xfree(r);
 346 }
 347
 348 void client_show_raw_remove(struct client *cl, void *data)
 349 {
 350     struct show_raw *rr = data;
 351     struct show_raw **rrp = &cl->show_raw;
 352     while (*rrp != rr)
 353         rrp = &(*rrp)->next;
 354     if (*rrp)
 355     {
 356         *rrp = rr->next;
 357         client_show_raw_delete(rr);
 358     }
 359 }
 360
 361 void client_show_raw_dequeue(struct client *cl)
 362 {
 363     struct show_raw *rr = cl->show_raw;
 364
 365     cl->show_raw = rr->next;
 366     client_show_raw_delete(rr);
 367 }
 368
 369 static void client_show_raw_error(struct client *cl, const char *addinfo)
 370 {
 371     while (cl->show_raw)
 372     {
 373         cl->show_raw->error_handler(cl->show_raw->data, addinfo);
 374         client_show_raw_dequeue(cl);
 375     }
 376 }
 377
 378 static void client_send_raw_present(struct client *cl)
 379 {
 380     struct session_database *sdb = client_get_database(cl);
 381     struct connection *co = client_get_connection(cl);
 382     ZOOM_resultset set = cl->resultset;
 383
 384     int offset = cl->show_raw->position;
 385     const char *syntax = 0;
 386     const char *elements = 0;
 387
 388     assert(cl->show_raw);
 389     assert(set);
 390
 391     yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
 392             client_get_id(cl), 1, offset);
 393
 394     if (cl->show_raw->syntax)
 395         syntax = cl->show_raw->syntax;
 396     else
 397         syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 398     ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
 399
 400     if (cl->show_raw->esn)
 401         elements = cl->show_raw->esn;
 402     else
 403         elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 404     if (elements && *elements)
 405         ZOOM_resultset_option_set(set, "elementSetName", elements);
 406
 407     ZOOM_resultset_records(set, 0, offset-1, 1);
 408     cl->show_raw->active = 1;
 409
 410     connection_continue(co);
 411 }
 412
 413 static int nativesyntax_to_type(const char *s, char *type,
 414                                 ZOOM_record rec)
 415 {
 416     if (s && *s)
 417     {
 418         if (!strncmp(s, "iso2709", 7))
 419         {
 420             const char *cp = strchr(s, ';');
 421             yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
 422         }
 423         else if (!strncmp(s, "txml", 4))
 424         {
 425             const char *cp = strchr(s, ';');
 426             yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
 427         }
 428         else /* pass verbatim to ZOOM - including "xml" */
 429             strcpy(type, s);
 430         return 0;
 431     }
 432     else  /* attempt to deduce structure */
 433     {
 434         const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
 435         if (syntax)
 436         {
 437             if (!strcmp(syntax, "XML"))
 438             {
 439                 strcpy(type, "xml");
 440                 return 0;
 441             }
 442             else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
 443             {
 444                 strcpy(type, "xml; charset=marc8-s");
 445                 return 0;
 446             }
 447             else return -1;
 448         }
 449         else return -1;
 450     }
 451 }
 452
 453 /**
 454  * TODO Consider thread safety!!!
 455  *
 456  */
 457 void client_report_facets(struct client *cl, ZOOM_resultset rs)
 458 {
 459     struct session_database *sdb = client_get_database(cl);
 460     ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
 461
 462     if (sdb && facets)
 463     {
 464         struct session *se = client_get_session(cl);
 465         int facet_num = ZOOM_resultset_facets_size(rs);
 466         struct setting *s;
 467
 468         for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 469         {
 470             const char *p = strchr(s->name + 3, ':');
 471             if (p && p[1] && s->value && s->value[0])
 472             {
 473                 int facet_idx;
 474                 p++; /* p now holds logical facet name */
 475                 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
 476                 {
 477                     const char *native_name =
 478                         ZOOM_facet_field_name(facets[facet_idx]);
 479                     if (native_name && !strcmp(s->value, native_name))
 480                     {
 481                         size_t term_idx;
 482                         size_t term_num =
 483                             ZOOM_facet_field_term_count(facets[facet_idx]);
 484                         for (term_idx = 0; term_idx < term_num; term_idx++ )
 485                         {
 486                             int freq;
 487                             const char *term =
 488                                 ZOOM_facet_field_get_term(facets[facet_idx],
 489                                                           term_idx, &freq);
 490                             if (term)
 491                                 add_facet(se, p, term, freq);
 492                         }
 493                         break;
 494                     }
 495                 }
 496             }
 497         }
 498     }
 499 }
 500
 501 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
 502 {
 503     const char *buf;
 504     int len;
 505     char type[80];
 506
 507     nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
 508     buf = ZOOM_record_get(rec, type, &len);
 509     cl->show_raw->record_handler(cl->show_raw->data,  buf, len);
 510     client_show_raw_dequeue(cl);
 511 }
 512
 513 void client_check_preferred_watch(struct client *cl)
 514 {
 515     struct session *se = cl->session;
 516     yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
 517     if (se)
 518     {
 519         client_unlock(cl);
 520         /* TODO possible threading issue. Session can have been destroyed */
 521         if (session_is_preferred_clients_ready(se)) {
 522             session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
 523         }
 524         else
 525             yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
 526
 527         client_lock(cl);
 528     }
 529     else
 530         yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
 531
 532 }
 533
 534 struct suggestions* client_suggestions_create(const char* suggestions_string);
 535 static void client_suggestions_destroy(struct client *cl);
 536
 537 void client_search_response(struct client *cl)
 538 {
 539     struct connection *co = cl->connection;
 540     ZOOM_connection link = connection_get_link(co);
 541     ZOOM_resultset resultset = cl->resultset;
 542
 543     const char *error, *addinfo = 0;
 544
 545     if (ZOOM_connection_error(link, &error, &addinfo))
 546     {
 547         cl->hits = 0;
 548         client_set_state(cl, Client_Error);
 549         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 550                 error, addinfo, client_get_id(cl));
 551     }
 552     else
 553     {
 554         client_report_facets(cl, resultset);
 555         cl->record_offset = cl->startrecs;
 556         cl->hits = ZOOM_resultset_size(resultset);
 557         yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, cl->hits);
 558         if (cl->suggestions)
 559             client_suggestions_destroy(cl);
 560         cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
 561     }
 562 }
 563
 564 void client_got_records(struct client *cl)
 565 {
 566     struct session *se = cl->session;
 567     if (se)
 568     {
 569         if (reclist_get_num_records(se->reclist) > 0)
 570         {
 571             client_unlock(cl);
 572             session_alert_watch(se, SESSION_WATCH_SHOW);
 573             session_alert_watch(se, SESSION_WATCH_BYTARGET);
 574             session_alert_watch(se, SESSION_WATCH_TERMLIST);
 575             session_alert_watch(se, SESSION_WATCH_RECORD);
 576             client_lock(cl);
 577         }
 578     }
 579 }
 580
 581 static void client_record_ingest(struct client *cl)
 582 {
 583     const char *msg, *addinfo;
 584     ZOOM_record rec = 0;
 585     ZOOM_resultset resultset = cl->resultset;
 586     struct session *se = client_get_session(cl);
 587
 588     if ((rec = ZOOM_resultset_record_immediate(resultset, cl->record_offset)))
 589     {
 590         int offset = ++cl->record_offset;
 591         if (cl->session == 0) {
 592             /* no operation */
 593         }
 594         else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
 595         {
 596             session_log(se, YLOG_WARN, "Record error %s (%s): %s #%d",
 597                         msg, addinfo, client_get_id(cl), offset);
 598         }
 599         else
 600         {
 601             struct session_database *sdb = client_get_database(cl);
 602             NMEM nmem = nmem_create();
 603             const char *xmlrec;
 604             char type[80];
 605
 606             const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
 607             if (nativesyntax_to_type(s, type, rec))
 608                 session_log(se, YLOG_WARN, "Failed to determine record type");
 609             xmlrec = ZOOM_record_get(rec, type, NULL);
 610             if (!xmlrec)
 611             {
 612                 const char *rec_syn =  ZOOM_record_get(rec, "syntax", NULL);
 613                 session_log(se, YLOG_WARN, "ZOOM_record_get failed from %s #%d",
 614                             client_get_id(cl), offset);
 615                 session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
 616                             "ZOOM record type=%s . Actual record syntax=%s",
 617                             s ? s : "null", type,
 618                             rec_syn ? rec_syn : "null");
 619             }
 620             else
 621             {
 622                 /* OK = 0, -1 = failure, -2 = Filtered */
 623                 int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem);
 624                 if (rc == -1)
 625                 {
 626                     const char *rec_syn =  ZOOM_record_get(rec, "syntax", NULL);
 627                     session_log(se, YLOG_WARN,
 628                                 "Failed to ingest record from %s #%d",
 629                                 client_get_id(cl), offset);
 630                     session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
 631                                 "ZOOM record type=%s . Actual record syntax=%s",
 632                                 s ? s : "null", type,
 633                                 rec_syn ? rec_syn : "null");
 634                 }
 635                 if (rc == -2)
 636                     cl->filtered += 1;
 637             }
 638             nmem_destroy(nmem);
 639         }
 640     }
 641     else
 642     {
 643         session_log(se, YLOG_WARN, "Got NULL record from %s #%d",
 644                     client_get_id(cl), cl->record_offset);
 645     }
 646 }
 647
 648 void client_record_response(struct client *cl)
 649 {
 650     struct connection *co = cl->connection;
 651     ZOOM_connection link = connection_get_link(co);
 652     ZOOM_resultset resultset = cl->resultset;
 653     const char *error, *addinfo;
 654
 655     if (ZOOM_connection_error(link, &error, &addinfo))
 656     {
 657         client_set_state(cl, Client_Error);
 658         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 659             error, addinfo, client_get_id(cl));
 660     }
 661     else
 662     {
 663         if (cl->show_raw && cl->show_raw->active)
 664         {
 665             ZOOM_record rec = 0;
 666             if ((rec = ZOOM_resultset_record_immediate(
 667                      resultset, cl->show_raw->position-1)))
 668             {
 669                 cl->show_raw->active = 0;
 670                 ingest_raw_record(cl, rec);
 671             }
 672             else
 673             {
 674                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 675                         cl->show_raw->position-1);
 676             }
 677         }
 678         else
 679         {
 680             client_record_ingest(cl);
 681         }
 682     }
 683 }
 684
 685 int client_reingest(struct client *cl)
 686 {
 687     int i = cl->startrecs;
 688     int to = cl->record_offset;
 689     cl->filtered = 0;
 690
 691     cl->record_offset = i;
 692     for (; i < to; i++)
 693         client_record_ingest(cl);
 694     return 0;
 695 }
 696
 697 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
 698 {
 699     struct session_database *sdb = client_get_database(cl);
 700
 701     WRBUF w = wrbuf_alloc();
 702
 703     struct setting *s;
 704
 705     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 706     {
 707         const char *p = strchr(s->name + 3, ':');
 708         if (!p)
 709         {
 710             yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
 711         }
 712         else if (s->value && s->value[0])
 713         {
 714             wrbuf_puts(w, "@attr 1=");
 715             yaz_encode_pqf_term(w, s->value, strlen(s->value));
 716             if (s->next)
 717                 wrbuf_puts(w, ",");
 718         }
 719     }
 720     yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
 721     ZOOM_connection_option_set(link, "facets",
 722                                wrbuf_len(w) ? wrbuf_cstr(w) : 0);
 723     wrbuf_destroy(w);
 724 }
 725
 726 int client_has_facet(struct client *cl, const char *name)
 727 {
 728     struct session_database *sdb = client_get_database(cl);
 729     struct setting *s;
 730
 731     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 732     {
 733         const char *p = strchr(s->name + 3, ':');
 734         if (p && !strcmp(name, p + 1))
 735             return 1;
 736     }
 737     return 0;
 738 }
 739
 740 static const char *get_strategy_plus_sort(struct client *l, const char *field)
 741 {
 742     struct session_database *sdb = client_get_database(l);
 743     struct setting *s;
 744
 745     const char *strategy_plus_sort = 0;
 746
 747     for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
 748     {
 749         char *p = strchr(s->name + 3, ':');
 750         if (!p)
 751         {
 752             yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
 753             continue;
 754         }
 755         p++;
 756         if (!strcmp(p, field))
 757         {
 758             strategy_plus_sort = s->value;
 759             break;
 760         }
 761     }
 762     return strategy_plus_sort;
 763 }
 764
 765 int client_fetch_more(struct client *cl)
 766 {
 767     struct session_database *sdb = client_get_database(cl);
 768     const char *str;
 769     int extra = cl->hits - cl->record_offset;
 770
 771     if (extra > 0)
 772     {
 773         ZOOM_resultset set = cl->resultset;
 774         struct connection *co = client_get_connection(cl);
 775         int max_extra = 10;
 776
 777         if (extra > max_extra)
 778             extra = max_extra;
 779
 780         str = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 781         ZOOM_resultset_option_set(set, "preferredRecordSyntax", str);
 782         str = session_setting_oneval(sdb, PZ_ELEMENTS);
 783         if (str && *str)
 784             ZOOM_resultset_option_set(set, "elementSetName", str);
 785
 786         ZOOM_resultset_records(set, 0, cl->record_offset, extra);
 787         client_set_state(cl, Client_Working);
 788         connection_continue(co);
 789         return 1;
 790     }
 791     return 0;
 792 }
 793
 794 int client_parse_init(struct client *cl, int same_search)
 795 {
 796     cl->same_search = same_search;
 797     return 0;
 798 }
 799
 800 /*
 801  * TODO consider how to extend the range
 802  * */
 803 int client_parse_range(struct client *cl, const char *startrecs, const char *maxrecs)
 804 {
 805     if (maxrecs && atoi(maxrecs) != cl->maxrecs)
 806     {
 807         cl->same_search = 0;
 808         cl->maxrecs = atoi(maxrecs);
 809     }
 810
 811     if (startrecs && atoi(startrecs) != cl->startrecs)
 812     {
 813         cl->same_search = 0;
 814         cl->startrecs = atoi(startrecs);
 815     }
 816
 817     return 0;
 818 }
 819
 820 int client_start_search(struct client *cl)
 821 {
 822     struct session_database *sdb = client_get_database(cl);
 823     struct connection *co = 0;
 824     ZOOM_connection link = 0;
 825     struct session *se = client_get_session(cl);
 826     ZOOM_resultset rs;
 827     const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
 828     const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
 829     const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
 830     const char *opt_requestsyn  = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 831     const char *opt_maxrecs     = session_setting_oneval(sdb, PZ_MAXRECS);
 832     const char *opt_sru         = session_setting_oneval(sdb, PZ_SRU);
 833     const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
 834     const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
 835     const char *extra_args      = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
 836     const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
 837     ZOOM_query query;
 838     char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
 839     struct timeval tval;
 840     int present_chunk = 20; // Default chunk size
 841     int rc_prep_connection;
 842
 843
 844     yaz_gettimeofday(&tval);
 845     tval.tv_sec += 5;
 846
 847     if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
 848         present_chunk = atoi(opt_present_chunk);
 849         yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
 850     }
 851     rc_prep_connection =
 852         client_prep_connection(cl, se->service->z3950_operation_timeout,
 853                                se->service->z3950_session_timeout,
 854                                se->service->server->iochan_man,
 855                                &tval);
 856     /* Nothing has changed and we already have a result */
 857     if (cl->same_search == 1 && rc_prep_connection == 2)
 858     {
 859         session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
 860         return client_reingest(cl);
 861     }
 862     else if (!rc_prep_connection)
 863     {
 864         session_log(se, YLOG_LOG, "client %s FAILED to search: No connection.", client_get_id(cl));
 865         return -1;
 866     }
 867     co = client_get_connection(cl);
 868     assert(cl);
 869     link = connection_get_link(co);
 870     assert(link);
 871
 872     session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
 873
 874     cl->diagnostic = 0;
 875     cl->filtered = 0;
 876
 877     if (extra_args && *extra_args)
 878         ZOOM_connection_option_set(link, "extraArgs", extra_args);
 879
 880     if (opt_preferred) {
 881         cl->preferred = atoi(opt_preferred);
 882         if (cl->preferred)
 883             yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
 884                     client_get_id(cl), cl->preferred);
 885     }
 886
 887     if (*opt_piggyback)
 888         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
 889     else
 890         ZOOM_connection_option_set(link, "piggyback", "1");
 891     if (*opt_queryenc)
 892         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
 893     if (*opt_sru && *opt_elements)
 894         ZOOM_connection_option_set(link, "schema", opt_elements);
 895     else if (*opt_elements)
 896         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
 897     if (*opt_requestsyn)
 898         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
 899
 900     if (opt_maxrecs && *opt_maxrecs)
 901     {
 902         cl->maxrecs = atoi(opt_maxrecs);
 903     }
 904
 905     /* convert back to string representation used in ZOOM API */
 906     sprintf(maxrecs_str, "%d", cl->maxrecs);
 907     ZOOM_connection_option_set(link, "count", maxrecs_str);
 908
 909     /* A present_chunk less than 1 will disable chunking. */
 910     if (present_chunk > 0 && cl->maxrecs > present_chunk) {
 911         sprintf(present_chunk_str, "%d", present_chunk);
 912         ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
 913         yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
 914     }
 915     else {
 916         ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
 917         yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
 918     }
 919     sprintf(startrecs_str, "%d", cl->startrecs);
 920     ZOOM_connection_option_set(link, "start", startrecs_str);
 921
 922     /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
 923     /* facets definition is in PQF */
 924     client_set_facets_request(cl, link);
 925
 926     query = ZOOM_query_create();
 927     if (cl->cqlquery)
 928     {
 929         yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl), cl->cqlquery);
 930         ZOOM_query_cql(query, cl->cqlquery);
 931         if (*opt_sort)
 932             ZOOM_query_sortby(query, opt_sort);
 933     }
 934     else
 935     {
 936         yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), cl->pquery);
 937
 938         ZOOM_query_prefix(query, cl->pquery);
 939     }
 940     if (cl->sort_strategy && cl->sort_criteria) {
 941         yaz_log(YLOG_LOG, "Client %s: Setting ZOOM sort strategy and criteria: %s %s",
 942                 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
 943         ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
 944     }
 945
 946     yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
 947     client_set_state(cl, Client_Working);
 948     cl->hits = 0;
 949     cl->record_offset = 0;
 950     rs = ZOOM_connection_search(link, query);
 951     ZOOM_query_destroy(query);
 952     ZOOM_resultset_destroy(cl->resultset);
 953     cl->resultset = rs;
 954     connection_continue(co);
 955     return 0;
 956 }
 957
 958 struct client *client_create(const char *id)
 959 {
 960     struct client *cl = xmalloc(sizeof(*cl));
 961     cl->maxrecs = 100;
 962     cl->startrecs = 0;
 963     cl->pquery = 0;
 964     cl->cqlquery = 0;
 965     cl->addinfo = 0;
 966     cl->message = 0;
 967     cl->database = 0;
 968     cl->connection = 0;
 969     cl->session = 0;
 970     cl->hits = 0;
 971     cl->record_offset = 0;
 972     cl->filtered = 0;
 973     cl->diagnostic = 0;
 974     cl->state = Client_Disconnected;
 975     cl->show_raw = 0;
 976     cl->resultset = 0;
 977     cl->suggestions = 0;
 978     cl->mutex = 0;
 979     pazpar2_mutex_create(&cl->mutex, "client");
 980     cl->preferred = 0;
 981     cl->ref_count = 1;
 982     cl->facet_limits = 0;
 983     cl->sort_strategy = 0;
 984     cl->sort_criteria = 0;
 985     assert(id);
 986     cl->id = xstrdup(id);
 987     client_use(1);
 988
 989     return cl;
 990 }
 991
 992 void client_lock(struct client *c)
 993 {
 994     yaz_mutex_enter(c->mutex);
 995 }
 996
 997 void client_unlock(struct client *c)
 998 {
 999     yaz_mutex_leave(c->mutex);
1000 }
1001
1002 void client_incref(struct client *c)
1003 {
1004     pazpar2_incref(&c->ref_count, c->mutex);
1005     yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
1006             c, client_get_id(c), c->ref_count);
1007 }
1008
1009 int client_destroy(struct client *c)
1010 {
1011     if (c)
1012     {
1013         yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
1014                 c, client_get_id(c), c->ref_count);
1015         if (!pazpar2_decref(&c->ref_count, c->mutex))
1016         {
1017             xfree(c->pquery);
1018             c->pquery = 0;
1019             xfree(c->cqlquery);
1020             c->cqlquery = 0;
1021             xfree(c->addinfo);
1022             c->addinfo = 0;
1023             xfree(c->message);
1024             c->message = 0;
1025             xfree(c->id);
1026             xfree(c->sort_strategy);
1027             xfree(c->sort_criteria);
1028             assert(!c->connection);
1029             facet_limits_destroy(c->facet_limits);
1030
1031             if (c->resultset)
1032             {
1033                 ZOOM_resultset_destroy(c->resultset);
1034             }
1035             yaz_mutex_destroy(&c->mutex);
1036             xfree(c);
1037             client_use(-1);
1038             return 1;
1039         }
1040     }
1041     return 0;
1042 }
1043
1044 void client_set_connection(struct client *cl, struct connection *con)
1045 {
1046     if (cl->resultset)
1047         ZOOM_resultset_release(cl->resultset);
1048     if (con)
1049     {
1050         assert(cl->connection == 0);
1051         cl->connection = con;
1052         client_incref(cl);
1053     }
1054     else
1055     {
1056         cl->connection = con;
1057         client_destroy(cl);
1058     }
1059 }
1060
1061 void client_disconnect(struct client *cl)
1062 {
1063     if (cl->state != Client_Idle)
1064         client_set_state(cl, Client_Disconnected);
1065     client_set_connection(cl, 0);
1066 }
1067
1068
1069 // Initialize CCL map for a target
1070 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1071 {
1072     struct session_database *sdb = client_get_database(cl);
1073     struct setting *s;
1074     CCL_bibset res;
1075
1076     if (!sdb->settings)
1077         return 0;
1078     if (base_bibset)
1079         res = ccl_qual_dup(base_bibset);
1080     else
1081         res = ccl_qual_mk();
1082     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1083     {
1084         const char *addinfo = 0;
1085         char *p = strchr(s->name + 3, ':');
1086         if (!p)
1087         {
1088             WRBUF w = wrbuf_alloc();
1089             wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1090             yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1091             client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1092                                   ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1093                                   wrbuf_cstr(w));
1094             client_set_state_nb(cl, Client_Error);
1095             ccl_qual_rm(&res);
1096             wrbuf_destroy(w);
1097             return 0;
1098         }
1099         p++;
1100         if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1101         {
1102             WRBUF w = wrbuf_alloc();
1103
1104             wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1105                          s->name, p, addinfo);
1106             yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1107             client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1108                                   ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1109                                   wrbuf_cstr(w));
1110             client_set_state_nb(cl, Client_Error);
1111             ccl_qual_rm(&res);
1112             wrbuf_destroy(w);
1113             return 0;
1114         }
1115     }
1116     return res;
1117 }
1118
1119 // returns a xmalloced CQL query corresponding to the pquery in client
1120 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1121 {
1122     cql_transform_t cqlt = cql_transform_create();
1123     char *r = 0;
1124     WRBUF wrb = wrbuf_alloc();
1125     int status;
1126
1127     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1128     {
1129         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1130     }
1131     else
1132     {
1133         r = xstrdup(wrbuf_cstr(wrb));
1134     }
1135     wrbuf_destroy(wrb);
1136     cql_transform_close(cqlt);
1137     return r;
1138 }
1139
1140 // returns a xmalloced SOLR query corresponding to the pquery in client
1141 // TODO Could prob. be merge with the similar make_cqlquery
1142 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1143 {
1144     solr_transform_t sqlt = solr_transform_create();
1145     char *r = 0;
1146     WRBUF wrb = wrbuf_alloc();
1147     int status;
1148
1149     if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1150     {
1151         yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1152     }
1153     else
1154     {
1155         r = xstrdup(wrbuf_cstr(wrb));
1156     }
1157     wrbuf_destroy(wrb);
1158     solr_transform_close(sqlt);
1159     return r;
1160 }
1161
1162 const char *client_get_facet_limit_local(struct client *cl,
1163                                          struct session_database *sdb,
1164                                          int *l,
1165                                          NMEM nmem, int *num, char ***values)
1166 {
1167     const char *name = 0;
1168     const char *value = 0;
1169     for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1170     {
1171         struct setting *s = 0;
1172
1173         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1174         {
1175             const char *p = strchr(s->name + 3, ':');
1176             if (p && !strcmp(p + 1, name) && s->value)
1177             {
1178                 int j, cnum;
1179                 char **cvalues;
1180                 nmem_strsplit_escape2(nmem, ",", s->value, &cvalues,
1181                                       &cnum, 1, '\\', 1);
1182                 for (j = 0; j < cnum; j++)
1183                 {
1184                     const char *cvalue = cvalues[j];
1185                     while (*cvalue == ' ')
1186                         cvalue++;
1187                     if (!strncmp(cvalue, "local:", 6))
1188                     {
1189                         const char *cp = cvalue + 6;
1190                         while (*cp == ' ')
1191                             cp++;
1192                         nmem_strsplit_escape2(nmem, "|", value, values,
1193                                               num, 1, '\\', 1);
1194                         (*l)++;
1195                         return *cp ? cp : name;
1196                     }
1197                 }
1198             }
1199         }
1200     }
1201     return 0;
1202 }
1203
1204 static int apply_limit(struct session_database *sdb,
1205                        facet_limits_t facet_limits,
1206                        WRBUF w_pqf, CCL_bibset ccl_map,
1207                        struct conf_service *service)
1208 {
1209     int ret = 0;
1210     int i = 0;
1211     const char *name;
1212     const char *value;
1213
1214     NMEM nmem_tmp = nmem_create();
1215     for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1216     {
1217         struct setting *s = 0;
1218         nmem_reset(nmem_tmp);
1219         /* name="pz:limitmap:author" value="rpn:@attr 1=4|local:other" */
1220         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1221         {
1222             const char *p = strchr(s->name + 3, ':');
1223             if (p && !strcmp(p + 1, name) && s->value)
1224             {
1225                 char **values = 0;
1226                 int i, num = 0;
1227                 char **cvalues = 0;
1228                 int j, cnum = 0;
1229                 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1230                                       &num, 1, '\\', 1);
1231
1232                 nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues,
1233                                       &cnum, 1, '\\', 1);
1234
1235                 for (j = 0; ret == 0 && j < cnum; j++)
1236                 {
1237                     const char *cvalue = cvalues[j];
1238                     while (*cvalue == ' ')
1239                         cvalue++;
1240                     if (!strncmp(cvalue, "rpn:", 4))
1241                     {
1242                         const char *pqf = cvalue + 4;
1243                         wrbuf_puts(w_pqf, "@and ");
1244                         wrbuf_puts(w_pqf, pqf);
1245                         wrbuf_puts(w_pqf, " ");
1246                         for (i = 0; i < num; i++)
1247                         {
1248                             if (i < num - 1)
1249                                 wrbuf_puts(w_pqf, "@or ");
1250                             yaz_encode_pqf_term(w_pqf, values[i],
1251                                                 strlen(values[i]));
1252                         }
1253                     }
1254                     else if (!strncmp(cvalue, "ccl:", 4))
1255                     {
1256                         const char *ccl = cvalue + 4;
1257                         WRBUF ccl_w = wrbuf_alloc();
1258                         for (i = 0; i < num; i++)
1259                         {
1260                             int cerror, cpos;
1261                             struct ccl_rpn_node *cn;
1262                             wrbuf_rewind(ccl_w);
1263                             wrbuf_puts(ccl_w, ccl);
1264                             wrbuf_puts(ccl_w, "=\"");
1265                             wrbuf_puts(ccl_w, values[i]);
1266                             wrbuf_puts(ccl_w, "\"");
1267
1268                             cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1269                                               &cerror, &cpos);
1270                             if (cn)
1271                             {
1272                                 if (i == 0)
1273                                     wrbuf_printf(w_pqf, "@and ");
1274
1275                                 /* or multiple values.. could be bad if last
1276                                    CCL parse fails, but this is unlikely to
1277                                    happen */
1278                                 if (i < num - 1)
1279                                     wrbuf_printf(w_pqf, "@or ");
1280                                 ccl_pquery(w_pqf, cn);
1281                                 ccl_rpn_delete(cn);
1282                             }
1283                         }
1284                         wrbuf_destroy(ccl_w);
1285                     }
1286                     else if (!strncmp(cvalue, "local:", 6)) {
1287                         /* no operation */
1288                     }
1289                     else
1290                     {
1291                         yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1292                                 sdb->database->id, cvalue);
1293                         ret = -1; /* bad limitmap */
1294                     }
1295                     break;
1296                 }
1297             }
1298         }
1299         if (!s)
1300         {
1301             int i;
1302             for (i = 0; i < service->num_metadata; i++)
1303             {
1304                 struct conf_metadata *md = service->metadata + i;
1305                 if (!strcmp(md->name, name) && md->limitcluster)
1306                 {
1307                     yaz_log(YLOG_LOG, "limitcluster in use for %s",
1308                             md->name);
1309                     break;
1310                 }
1311             }
1312             if (i == service->num_metadata)
1313             {
1314                 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1315                         (sdb->database ? sdb->database->id : "<no id>"), name);
1316             }
1317         }
1318     }
1319     nmem_destroy(nmem_tmp);
1320     return ret;
1321 }
1322
1323 // Parse the query given the settings specific to this client
1324 // client variable same_search is set as below as well as returned:
1325 // 0 if query is OK but different from before
1326 // 1 if query is OK but same as before
1327 // return -1 on query error
1328 // return -2 on limit error
1329 int client_parse_query(struct client *cl, const char *query,
1330                        facet_limits_t facet_limits)
1331 {
1332     struct session *se = client_get_session(cl);
1333     struct conf_service *service = se->service;
1334     struct session_database *sdb = client_get_database(cl);
1335     struct ccl_rpn_node *cn;
1336     int cerror, cpos;
1337     ODR odr_out;
1338     CCL_bibset ccl_map = prepare_cclmap(cl, service->ccl_bibset);
1339     const char *sru = session_setting_oneval(sdb, PZ_SRU);
1340     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1341     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1342     const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1343     WRBUF w_ccl, w_pqf;
1344     int ret_value = 1;
1345     Z_RPNQuery *zquery;
1346
1347     if (!ccl_map)
1348         return -3;
1349
1350     w_ccl = wrbuf_alloc();
1351     wrbuf_puts(w_ccl, query);
1352
1353     w_pqf = wrbuf_alloc();
1354     if (*pqf_prefix)
1355     {
1356         wrbuf_puts(w_pqf, pqf_prefix);
1357         wrbuf_puts(w_pqf, " ");
1358     }
1359
1360     if (apply_limit(sdb, facet_limits, w_pqf, ccl_map, service))
1361     {
1362         ccl_qual_rm(&ccl_map);
1363         return -2;
1364     }
1365
1366     facet_limits_destroy(cl->facet_limits);
1367     cl->facet_limits = facet_limits_dup(facet_limits);
1368
1369     yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s", client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
1370     cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1371     ccl_qual_rm(&ccl_map);
1372     if (!cn)
1373     {
1374         client_set_state(cl, Client_Error);
1375         session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1376                     client_get_id(cl),
1377                     wrbuf_cstr(w_ccl));
1378         wrbuf_destroy(w_ccl);
1379         wrbuf_destroy(w_pqf);
1380         return -1;
1381     }
1382     wrbuf_destroy(w_ccl);
1383
1384     if (!pqf_strftime || !*pqf_strftime)
1385         ccl_pquery(w_pqf, cn);
1386     else
1387     {
1388         time_t cur_time = time(0);
1389         struct tm *tm =  localtime(&cur_time);
1390         char tmp_str[300];
1391         const char *cp = tmp_str;
1392
1393         /* see man strftime(3) for things .. In particular %% gets converted
1394          to %.. And That's our original query .. */
1395         strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1396         for (; *cp; cp++)
1397         {
1398             if (cp[0] == '%')
1399                 ccl_pquery(w_pqf, cn);
1400             else
1401                 wrbuf_putc(w_pqf, cp[0]);
1402         }
1403     }
1404
1405     /* Compares query and limit with old one. If different we need to research */
1406     if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1407     {
1408         if (cl->pquery)
1409             session_log(se, YLOG_LOG, "Client %s: Re-search due query/limit change: %s to %s",
1410                         client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
1411         xfree(cl->pquery);
1412         cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1413         // return value is no longer used.
1414         ret_value = 0;
1415         // Need to (re)search
1416         cl->same_search= 0;
1417     }
1418     wrbuf_destroy(w_pqf);
1419
1420     xfree(cl->cqlquery);
1421     cl->cqlquery = 0;
1422
1423     odr_out = odr_createmem(ODR_ENCODE);
1424     zquery = p_query_rpn(odr_out, cl->pquery);
1425     if (!zquery)
1426     {
1427
1428         session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1429                     client_get_id(cl), cl->pquery);
1430         ret_value = -1;
1431     }
1432     else
1433     {
1434         session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1435                     client_get_id(cl), cl->pquery);
1436
1437         /* Support for PQF on SRU targets. */
1438         if (strcmp(query_syntax, "pqf") != 0 && *sru)
1439         {
1440             if (!strcmp(sru, "solr"))
1441                 cl->cqlquery = make_solrquery(cl, zquery);
1442             else
1443                 cl->cqlquery = make_cqlquery(cl, zquery);
1444             if (!cl->cqlquery)
1445                 ret_value = -1;
1446             else
1447                 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
1448                             client_get_id(cl), cl->cqlquery, sru);
1449         }
1450     }
1451     odr_destroy(odr_out);
1452
1453     /* TODO FIX Not thread safe */
1454     if (!se->relevance)
1455     {
1456         // Initialize relevance structure with query terms
1457         se->relevance = relevance_create_ccl(se->service->charsets, cn,
1458                                              se->service->rank_cluster,
1459                                              se->service->rank_follow,
1460                                              se->service->rank_lead,
1461                                              se->service->rank_length);
1462     }
1463     ccl_rpn_delete(cn);
1464     return ret_value;
1465 }
1466
1467 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
1468 {
1469     if (sp)
1470     {
1471         const char *sort_strategy_and_spec =
1472             get_strategy_plus_sort(cl, sp->name);
1473         int increasing = sp->increasing;
1474         if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1475         {
1476             char strategy[50], *p;
1477             strcpy(strategy, sort_strategy_and_spec);
1478             p = strchr(strategy, ':');
1479             if (p)
1480             {
1481                 // Split the string in two
1482                 *p++ = 0;
1483                 while (*p == ' ')
1484                     p++;
1485                 if (increasing)
1486                     strcat(p, " <");
1487                 else
1488                     strcat(p, " >");
1489                 yaz_log(YLOG_LOG, "Client %s: applying sorting %s %s", client_get_id(cl), strategy, p);
1490                 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
1491                     cl->same_search = 0;
1492                 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
1493                     cl->same_search = 0;
1494                 if (cl->same_search == 0) {
1495                     xfree(cl->sort_strategy);
1496                     cl->sort_strategy = xstrdup(strategy);
1497                     xfree(cl->sort_criteria);
1498                     cl->sort_criteria = xstrdup(p);
1499                 }
1500             }
1501             else {
1502                 yaz_log(YLOG_LOG, "Client %s: Invalid sort strategy and spec found %s", client_get_id(cl), sort_strategy_and_spec);
1503                 xfree(cl->sort_strategy);
1504                 cl->sort_strategy  = 0;
1505                 xfree(cl->sort_criteria);
1506                 cl->sort_criteria = 0;
1507             }
1508         } else {
1509             yaz_log(YLOG_DEBUG, "Client %s: No sort strategy and spec found.", client_get_id(cl));
1510             xfree(cl->sort_strategy);
1511             cl->sort_strategy  = 0;
1512             xfree(cl->sort_criteria);
1513             cl->sort_criteria = 0;
1514         }
1515
1516     }
1517     return !cl->same_search;
1518 }
1519
1520 void client_set_session(struct client *cl, struct session *se)
1521 {
1522     cl->session = se;
1523 }
1524
1525 int client_is_active(struct client *cl)
1526 {
1527     if (cl->connection && (cl->state == Client_Connecting ||
1528                            cl->state == Client_Working))
1529         return 1;
1530     return 0;
1531 }
1532
1533 int client_is_active_preferred(struct client *cl)
1534 {
1535     /* only count if this is a preferred target. */
1536     if (!cl->preferred)
1537         return 0;
1538     /* TODO No sure this the condition that Seb wants */
1539     if (cl->connection && (cl->state == Client_Connecting ||
1540                            cl->state == Client_Working))
1541         return 1;
1542     return 0;
1543 }
1544
1545 Odr_int client_get_hits(struct client *cl)
1546 {
1547     return cl->hits;
1548 }
1549
1550 Odr_int client_get_approximation(struct client *cl)
1551 {
1552     if (cl->record_offset > 0) {
1553         Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered)) / cl->record_offset + 5) /10;
1554         yaz_log(YLOG_DEBUG, "%s: Approx: %lld * %d / %d = %lld ", client_get_id(cl), cl->hits, cl->record_offset - cl->filtered, cl->record_offset, approx);
1555         return approx;
1556     }
1557     return cl->hits;
1558 }
1559
1560 int client_get_num_records(struct client *cl)
1561 {
1562     return cl->record_offset;
1563 }
1564
1565 int client_get_num_records_filtered(struct client *cl)
1566 {
1567     return cl->filtered;
1568 }
1569
1570 void client_set_diagnostic(struct client *cl, int diagnostic,
1571                            const char *message, const char *addinfo)
1572 {
1573     cl->diagnostic = diagnostic;
1574     xfree(cl->message);
1575     cl->message = xstrdup(message);
1576     xfree(cl->addinfo);
1577     cl->addinfo = 0;
1578     if (addinfo)
1579         cl->addinfo = xstrdup(addinfo);
1580 }
1581
1582 int client_get_diagnostic(struct client *cl, const char **message,
1583                           const char **addinfo)
1584 {
1585     if (message)
1586         *message = cl->message;
1587     if (addinfo)
1588         *addinfo = cl->addinfo;
1589     return cl->diagnostic;
1590 }
1591
1592 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1593 {
1594     /* int idx; */
1595     struct suggestions *suggestions = cl->suggestions;
1596
1597     if (!suggestions) {
1598         //yaz_log(YLOG_DEBUG, "No suggestions found");
1599         return "";
1600     }
1601     if (suggestions->passthrough) {
1602         yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1603         return suggestions->passthrough;
1604     }
1605     if (suggestions->num == 0) {
1606         return "";
1607     }
1608     /*
1609     for (idx = 0; idx < suggestions->num; idx++) {
1610         wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1611         if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1612             wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1613             wrbuf_puts(wrbuf, "</suggest>\n");
1614         }
1615         else
1616             wrbuf_puts(wrbuf, "/>\n");
1617     }
1618     */
1619     return wrbuf_cstr(wrbuf);
1620 }
1621
1622
1623 void client_set_database(struct client *cl, struct session_database *db)
1624 {
1625     cl->database = db;
1626 }
1627
1628 const char *client_get_id(struct client *cl)
1629 {
1630     return cl->id;
1631 }
1632
1633 int client_get_maxrecs(struct client *cl)
1634 {
1635     return cl->maxrecs;
1636 }
1637
1638 void client_set_preferred(struct client *cl, int v)
1639 {
1640     cl->preferred = v;
1641 }
1642
1643
1644 struct suggestions* client_suggestions_create(const char* suggestions_string)
1645 {
1646     int i;
1647     NMEM nmem;
1648     struct suggestions *suggestions;
1649     if (suggestions_string == 0 || suggestions_string[0] == 0 )
1650         return 0;
1651     nmem = nmem_create();
1652     suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1653     yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1654
1655     suggestions->nmem = nmem;
1656     suggestions->num = 0;
1657     suggestions->misspelled = 0;
1658     suggestions->suggest = 0;
1659     suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1660
1661     if (suggestions_string)
1662         nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1663                               &suggestions->num, 1, '\\', 0);
1664     /* Set up misspelled array */
1665     suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1666     /* replace = with \0 .. for each item */
1667     for (i = 0; i < suggestions->num; i++)
1668     {
1669         char *cp = strchr(suggestions->suggest[i], '=');
1670         if (cp) {
1671             *cp = '\0';
1672             suggestions->misspelled[i] = cp+1;
1673         }
1674     }
1675     return suggestions;
1676 }
1677
1678 static void client_suggestions_destroy(struct client *cl)
1679 {
1680     NMEM nmem = cl->suggestions->nmem;
1681     cl->suggestions = 0;
1682     nmem_destroy(nmem);
1683 }
1684
1685 int client_test_sort_order(struct client *cl, struct reclist_sortparms *sp)
1686 {
1687     //TODO implement correctly.
1688     return 1;
1689 }
1690 /*
1691  * Local variables:
1692  * c-basic-offset: 4
1693  * c-file-style: "Stroustrup"
1694  * indent-tabs-mode: nil
1695  * End:
1696  * vim: shiftwidth=4 tabstop=8 expandtab
1697  */
1698