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