src/client.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2012 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     int preferred;
 123     struct suggestions *suggestions;
 124     enum client_state state;
 125     struct show_raw *show_raw;
 126     ZOOM_resultset resultset;
 127     YAZ_MUTEX mutex;
 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     yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
 516     if (se)
 517     {
 518         client_unlock(cl);
 519         /* TODO possible threading issue. Session can have been destroyed */
 520         if (session_is_preferred_clients_ready(se)) {
 521             session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
 522         }
 523         else
 524             yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
 525
 526         client_lock(cl);
 527     }
 528     else
 529         yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
 530
 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     if (ZOOM_connection_error(link, &error, &addinfo))
 545     {
 546         cl->hits = 0;
 547         client_set_state(cl, Client_Error);
 548         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 549                 error, addinfo, client_get_id(cl));
 550     }
 551     else
 552     {
 553         client_report_facets(cl, resultset);
 554         cl->record_offset = cl->startrecs;
 555         cl->hits = ZOOM_resultset_size(resultset);
 556         yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, cl->hits);
 557         if (cl->suggestions)
 558             client_suggestions_destroy(cl);
 559         cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
 560     }
 561 }
 562
 563 void client_got_records(struct client *cl)
 564 {
 565     struct session *se = cl->session;
 566     if (se)
 567     {
 568         if (reclist_get_num_records(se->reclist) > 0)
 569         {
 570             client_unlock(cl);
 571             session_alert_watch(se, SESSION_WATCH_SHOW);
 572             session_alert_watch(se, SESSION_WATCH_BYTARGET);
 573             session_alert_watch(se, SESSION_WATCH_TERMLIST);
 574             session_alert_watch(se, SESSION_WATCH_RECORD);
 575             client_lock(cl);
 576         }
 577     }
 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     if (ZOOM_connection_error(link, &error, &addinfo))
 655     {
 656         client_set_state(cl, Client_Error);
 657         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 658             error, addinfo, client_get_id(cl));
 659     }
 660     else
 661     {
 662         if (cl->show_raw && cl->show_raw->active)
 663         {
 664             ZOOM_record rec = 0;
 665             if ((rec = ZOOM_resultset_record_immediate(
 666                      resultset, cl->show_raw->position-1)))
 667             {
 668                 cl->show_raw->active = 0;
 669                 ingest_raw_record(cl, rec);
 670             }
 671             else
 672             {
 673                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 674                         cl->show_raw->position-1);
 675             }
 676         }
 677         else
 678         {
 679             client_record_ingest(cl);
 680         }
 681     }
 682 }
 683
 684 int client_reingest(struct client *cl)
 685 {
 686     int i = cl->startrecs;
 687     int to = cl->record_offset;
 688     cl->filtered = 0;
 689
 690     cl->record_offset = i;
 691     for (; i < to; i++)
 692         client_record_ingest(cl);
 693     return 0;
 694 }
 695
 696 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
 697 {
 698     struct session_database *sdb = client_get_database(cl);
 699
 700     WRBUF w = wrbuf_alloc();
 701
 702     struct setting *s;
 703
 704     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 705     {
 706         const char *p = strchr(s->name + 3, ':');
 707         if (!p)
 708         {
 709             yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
 710         }
 711         else if (s->value && s->value[0])
 712         {
 713             wrbuf_puts(w, "@attr 1=");
 714             yaz_encode_pqf_term(w, s->value, strlen(s->value));
 715             if (s->next)
 716                 wrbuf_puts(w, ",");
 717         }
 718     }
 719     yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
 720     ZOOM_connection_option_set(link, "facets",
 721                                wrbuf_len(w) ? wrbuf_cstr(w) : 0);
 722     wrbuf_destroy(w);
 723 }
 724
 725 int client_has_facet(struct client *cl, const char *name)
 726 {
 727     struct session_database *sdb = client_get_database(cl);
 728     struct setting *s;
 729
 730     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 731     {
 732         const char *p = strchr(s->name + 3, ':');
 733         if (p && !strcmp(name, p + 1))
 734             return 1;
 735     }
 736     return 0;
 737 }
 738
 739 static const char *get_strategy_plus_sort(struct client *l, const char *field)
 740 {
 741     struct session_database *sdb = client_get_database(l);
 742     struct setting *s;
 743
 744     const char *strategy_plus_sort = 0;
 745
 746     for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
 747     {
 748         char *p = strchr(s->name + 3, ':');
 749         if (!p)
 750         {
 751             yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
 752             continue;
 753         }
 754         p++;
 755         if (!strcmp(p, field))
 756         {
 757             strategy_plus_sort = s->value;
 758             break;
 759         }
 760     }
 761     return strategy_plus_sort;
 762 }
 763
 764 int client_parse_init(struct client *cl, int same_search)
 765 {
 766     cl->same_search = same_search;
 767     return 0;
 768 }
 769
 770 /*
 771  * TODO consider how to extend the range
 772  * */
 773 int client_parse_range(struct client *cl, const char *startrecs, const char *maxrecs)
 774 {
 775     if (maxrecs && atoi(maxrecs) != cl->maxrecs)
 776     {
 777         cl->same_search = 0;
 778         cl->maxrecs = atoi(maxrecs);
 779     }
 780
 781     if (startrecs && atoi(startrecs) != cl->startrecs)
 782     {
 783         cl->same_search = 0;
 784         cl->startrecs = atoi(startrecs);
 785     }
 786
 787     return 0;
 788 }
 789
 790 int client_start_search(struct client *cl)
 791 {
 792     struct session_database *sdb = client_get_database(cl);
 793     struct connection *co = 0;
 794     ZOOM_connection link = 0;
 795     struct session *se = client_get_session(cl);
 796     ZOOM_resultset rs;
 797     const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
 798     const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
 799     const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
 800     const char *opt_requestsyn  = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 801     const char *opt_maxrecs     = session_setting_oneval(sdb, PZ_MAXRECS);
 802     const char *opt_sru         = session_setting_oneval(sdb, PZ_SRU);
 803     const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
 804     const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
 805     const char *extra_args      = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
 806     const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
 807     ZOOM_query query;
 808     char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
 809     struct timeval tval;
 810     int present_chunk = 20; // Default chunk size
 811     int rc_prep_connection;
 812
 813
 814     yaz_gettimeofday(&tval);
 815     tval.tv_sec += 5;
 816
 817     if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
 818         present_chunk = atoi(opt_present_chunk);
 819         yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
 820     }
 821     rc_prep_connection =
 822         client_prep_connection(cl, se->service->z3950_operation_timeout,
 823                                se->service->z3950_session_timeout,
 824                                se->service->server->iochan_man,
 825                                &tval);
 826     /* Nothing has changed and we already have a result */
 827     if (cl->same_search == 1 && rc_prep_connection == 2)
 828     {
 829         session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
 830         return client_reingest(cl);
 831     }
 832     else if (!rc_prep_connection)
 833     {
 834         session_log(se, YLOG_LOG, "client %s FAILED to search: No connection.", client_get_id(cl));
 835         return -1;
 836     }
 837     co = client_get_connection(cl);
 838     assert(cl);
 839     link = connection_get_link(co);
 840     assert(link);
 841
 842     session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
 843
 844     cl->diagnostic = 0;
 845     cl->filtered = 0;
 846
 847     if (extra_args && *extra_args)
 848         ZOOM_connection_option_set(link, "extraArgs", extra_args);
 849
 850     if (opt_preferred) {
 851         cl->preferred = atoi(opt_preferred);
 852         if (cl->preferred)
 853             yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
 854                     client_get_id(cl), cl->preferred);
 855     }
 856
 857     if (*opt_piggyback)
 858         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
 859     else
 860         ZOOM_connection_option_set(link, "piggyback", "1");
 861     if (*opt_queryenc)
 862         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
 863     if (*opt_sru && *opt_elements)
 864         ZOOM_connection_option_set(link, "schema", opt_elements);
 865     else if (*opt_elements)
 866         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
 867     if (*opt_requestsyn)
 868         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
 869
 870     if (opt_maxrecs && *opt_maxrecs)
 871     {
 872         cl->maxrecs = atoi(opt_maxrecs);
 873     }
 874
 875     /* convert back to string representation used in ZOOM API */
 876     sprintf(maxrecs_str, "%d", cl->maxrecs);
 877     ZOOM_connection_option_set(link, "count", maxrecs_str);
 878
 879     /* A present_chunk less than 1 will disable chunking. */
 880     if (present_chunk > 0 && cl->maxrecs > present_chunk) {
 881         sprintf(present_chunk_str, "%d", present_chunk);
 882         ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
 883         yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
 884     }
 885     else {
 886         ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
 887         yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
 888     }
 889     sprintf(startrecs_str, "%d", cl->startrecs);
 890     ZOOM_connection_option_set(link, "start", startrecs_str);
 891
 892     /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
 893     /* facets definition is in PQF */
 894     client_set_facets_request(cl, link);
 895
 896     query = ZOOM_query_create();
 897     if (cl->cqlquery)
 898     {
 899         yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl), cl->cqlquery);
 900         ZOOM_query_cql(query, cl->cqlquery);
 901         if (*opt_sort)
 902             ZOOM_query_sortby(query, opt_sort);
 903     }
 904     else
 905     {
 906         yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), cl->pquery);
 907
 908         ZOOM_query_prefix(query, cl->pquery);
 909     }
 910     if (cl->sort_strategy && cl->sort_criteria) {
 911         yaz_log(YLOG_LOG, "Client %s: Setting ZOOM sort strategy and criteria: %s %s",
 912                 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
 913         ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
 914     }
 915
 916     yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
 917     client_set_state(cl, Client_Working);
 918     cl->hits = 0;
 919     cl->record_offset = 0;
 920     rs = ZOOM_connection_search(link, query);
 921     ZOOM_query_destroy(query);
 922     ZOOM_resultset_destroy(cl->resultset);
 923     cl->resultset = rs;
 924     connection_continue(co);
 925     return 0;
 926 }
 927
 928 struct client *client_create(const char *id)
 929 {
 930     struct client *cl = xmalloc(sizeof(*cl));
 931     cl->maxrecs = 100;
 932     cl->startrecs = 0;
 933     cl->pquery = 0;
 934     cl->cqlquery = 0;
 935     cl->addinfo = 0;
 936     cl->database = 0;
 937     cl->connection = 0;
 938     cl->session = 0;
 939     cl->hits = 0;
 940     cl->record_offset = 0;
 941     cl->filtered = 0;
 942     cl->diagnostic = 0;
 943     cl->state = Client_Disconnected;
 944     cl->show_raw = 0;
 945     cl->resultset = 0;
 946     cl->suggestions = 0;
 947     cl->mutex = 0;
 948     pazpar2_mutex_create(&cl->mutex, "client");
 949     cl->preferred = 0;
 950     cl->ref_count = 1;
 951     cl->facet_limits = 0;
 952     cl->sort_strategy = 0;
 953     cl->sort_criteria = 0;
 954     assert(id);
 955     cl->id = xstrdup(id);
 956     client_use(1);
 957
 958     return cl;
 959 }
 960
 961 void client_lock(struct client *c)
 962 {
 963     yaz_mutex_enter(c->mutex);
 964 }
 965
 966 void client_unlock(struct client *c)
 967 {
 968     yaz_mutex_leave(c->mutex);
 969 }
 970
 971 void client_incref(struct client *c)
 972 {
 973     pazpar2_incref(&c->ref_count, c->mutex);
 974     yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
 975             c, client_get_id(c), c->ref_count);
 976 }
 977
 978 int client_destroy(struct client *c)
 979 {
 980     if (c)
 981     {
 982         yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
 983                 c, client_get_id(c), c->ref_count);
 984         if (!pazpar2_decref(&c->ref_count, c->mutex))
 985         {
 986             xfree(c->pquery);
 987             c->pquery = 0;
 988             xfree(c->cqlquery);
 989             c->cqlquery = 0;
 990             xfree(c->addinfo);
 991             c->addinfo = 0;
 992             xfree(c->id);
 993             xfree(c->sort_strategy);
 994             xfree(c->sort_criteria);
 995             assert(!c->connection);
 996             facet_limits_destroy(c->facet_limits);
 997
 998             if (c->resultset)
 999             {
1000                 ZOOM_resultset_destroy(c->resultset);
1001             }
1002             yaz_mutex_destroy(&c->mutex);
1003             xfree(c);
1004             client_use(-1);
1005             return 1;
1006         }
1007     }
1008     return 0;
1009 }
1010
1011 void client_set_connection(struct client *cl, struct connection *con)
1012 {
1013     if (cl->resultset)
1014         ZOOM_resultset_release(cl->resultset);
1015     if (con)
1016     {
1017         assert(cl->connection == 0);
1018         cl->connection = con;
1019         client_incref(cl);
1020     }
1021     else
1022     {
1023         cl->connection = con;
1024         client_destroy(cl);
1025     }
1026 }
1027
1028 void client_disconnect(struct client *cl)
1029 {
1030     if (cl->state != Client_Idle)
1031         client_set_state(cl, Client_Disconnected);
1032     client_set_connection(cl, 0);
1033 }
1034
1035
1036 // Initialize CCL map for a target
1037 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1038 {
1039     struct session_database *sdb = client_get_database(cl);
1040     struct setting *s;
1041     CCL_bibset res;
1042
1043     if (!sdb->settings)
1044         return 0;
1045     if (base_bibset)
1046         res = ccl_qual_dup(base_bibset);
1047     else
1048         res = ccl_qual_mk();
1049     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1050     {
1051         const char *addinfo = 0;
1052         char *p = strchr(s->name + 3, ':');
1053         if (!p)
1054         {
1055             WRBUF w = wrbuf_alloc();
1056             wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1057             yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1058             client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG, wrbuf_cstr(w));
1059             client_set_state_nb(cl, Client_Error);
1060             ccl_qual_rm(&res);
1061             wrbuf_destroy(w);
1062             return 0;
1063         }
1064         p++;
1065         if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1066         {
1067             WRBUF w = wrbuf_alloc();
1068
1069             wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1070                          s->name, p, addinfo);
1071             yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1072             client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG, wrbuf_cstr(w));
1073             client_set_state_nb(cl, Client_Error);
1074             ccl_qual_rm(&res);
1075             wrbuf_destroy(w);
1076             return 0;
1077         }
1078     }
1079     return res;
1080 }
1081
1082 // returns a xmalloced CQL query corresponding to the pquery in client
1083 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1084 {
1085     cql_transform_t cqlt = cql_transform_create();
1086     char *r = 0;
1087     WRBUF wrb = wrbuf_alloc();
1088     int status;
1089
1090     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1091     {
1092         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1093     }
1094     else
1095     {
1096         r = xstrdup(wrbuf_cstr(wrb));
1097     }
1098     wrbuf_destroy(wrb);
1099     cql_transform_close(cqlt);
1100     return r;
1101 }
1102
1103 // returns a xmalloced SOLR query corresponding to the pquery in client
1104 // TODO Could prob. be merge with the similar make_cqlquery
1105 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1106 {
1107     solr_transform_t sqlt = solr_transform_create();
1108     char *r = 0;
1109     WRBUF wrb = wrbuf_alloc();
1110     int status;
1111
1112     if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1113     {
1114         yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1115     }
1116     else
1117     {
1118         r = xstrdup(wrbuf_cstr(wrb));
1119     }
1120     wrbuf_destroy(wrb);
1121     solr_transform_close(sqlt);
1122     return r;
1123 }
1124
1125 const char *client_get_facet_limit_local(struct client *cl,
1126                                          struct session_database *sdb,
1127                                          int *l,
1128                                          NMEM nmem, int *num, char ***values)
1129 {
1130     const char *name = 0;
1131     const char *value = 0;
1132     for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1133     {
1134         struct setting *s = 0;
1135
1136         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1137         {
1138             const char *p = strchr(s->name + 3, ':');
1139             if (p && !strcmp(p + 1, name) && s->value &&
1140                 !strncmp(s->value, "local:", 6))
1141             {
1142                 const char *cp = s->value + 6;
1143                 while (*cp == ' ')
1144                     cp++;
1145
1146                 nmem_strsplit_escape2(nmem, "|", value, values,
1147                                       num, 1, '\\', 1);
1148                 (*l)++;
1149                 return *cp ? cp : name;
1150             }
1151         }
1152     }
1153     return 0;
1154 }
1155
1156 static int apply_limit(struct session_database *sdb,
1157                        facet_limits_t facet_limits,
1158                        WRBUF w_pqf, CCL_bibset ccl_map)
1159 {
1160     int ret = 0;
1161     int i = 0;
1162     const char *name;
1163     const char *value;
1164
1165     NMEM nmem_tmp = nmem_create();
1166     for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1167     {
1168         struct setting *s = 0;
1169         nmem_reset(nmem_tmp);
1170         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1171         {
1172             const char *p = strchr(s->name + 3, ':');
1173             if (p && !strcmp(p + 1, name) && s->value)
1174             {
1175                 char **values = 0;
1176                 int i, num = 0;
1177                 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1178                                       &num, 1, '\\', 1);
1179
1180                 if (!strncmp(s->value, "rpn:", 4))
1181                 {
1182                     const char *pqf = s->value + 4;
1183
1184                     wrbuf_puts(w_pqf, "@and ");
1185                     wrbuf_puts(w_pqf, pqf);
1186                     wrbuf_puts(w_pqf, " ");
1187                     for (i = 0; i < num; i++)
1188                     {
1189                         if (i < num - 1)
1190                             wrbuf_puts(w_pqf, "@or ");
1191                         yaz_encode_pqf_term(w_pqf, values[i],
1192                                             strlen(values[i]));
1193                     }
1194                 }
1195                 else if (!strncmp(s->value, "ccl:", 4))
1196                 {
1197                     const char *ccl = s->value + 4;
1198                     WRBUF ccl_w = wrbuf_alloc();
1199                     for (i = 0; i < num; i++)
1200                     {
1201                         int cerror, cpos;
1202                         struct ccl_rpn_node *cn;
1203
1204                         wrbuf_rewind(ccl_w);
1205                         wrbuf_puts(ccl_w, ccl);
1206                         wrbuf_puts(ccl_w, "=\"");
1207                         wrbuf_puts(ccl_w, values[i]);
1208                         wrbuf_puts(ccl_w, "\"");
1209
1210                         cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1211                                           &cerror, &cpos);
1212                         if (cn)
1213                         {
1214                             if (i == 0)
1215                                 wrbuf_printf(w_pqf, "@and ");
1216
1217                             /* or multiple values.. could be bad if last CCL
1218                                parse fails, but this is unlikely to happen */
1219                             if (i < num - 1)
1220                                 wrbuf_printf(w_pqf, "@or ");
1221                             ccl_pquery(w_pqf, cn);
1222                             ccl_rpn_delete(cn);
1223                         }
1224                     }
1225                     wrbuf_destroy(ccl_w);
1226                 }
1227                 else if (!strncmp(s->value, "local:", 6)) {
1228                     /* no operation */
1229                 }
1230                 else
1231                 {
1232                     yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1233                             sdb->database->id, s->value);
1234                     ret = -1; /* bad limitmap */
1235                 }
1236                 break;
1237             }
1238         }
1239         if (!s)
1240         {
1241             yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1242                     (sdb->database ? sdb->database->id : "<no id>"), name);
1243         }
1244     }
1245     nmem_destroy(nmem_tmp);
1246     return ret;
1247 }
1248
1249 // Parse the query given the settings specific to this client
1250 // client variable same_search is set as below as well as returned:
1251 // 0 if query is OK but different from before
1252 // 1 if query is OK but same as before
1253 // return -1 on query error
1254 // return -2 on limit error
1255 int client_parse_query(struct client *cl, const char *query,
1256                        facet_limits_t facet_limits,
1257                        CCL_bibset bibset)
1258 {
1259     struct session *se = client_get_session(cl);
1260     struct session_database *sdb = client_get_database(cl);
1261     struct ccl_rpn_node *cn;
1262     int cerror, cpos;
1263     ODR odr_out;
1264     CCL_bibset ccl_map = prepare_cclmap(cl, bibset);
1265     const char *sru = session_setting_oneval(sdb, PZ_SRU);
1266     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1267     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1268     const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1269     WRBUF w_ccl, w_pqf;
1270     int ret_value = 1;
1271     Z_RPNQuery *zquery;
1272
1273     if (!ccl_map)
1274         return -3;
1275
1276     w_ccl = wrbuf_alloc();
1277     wrbuf_puts(w_ccl, query);
1278
1279     w_pqf = wrbuf_alloc();
1280     if (*pqf_prefix)
1281     {
1282         wrbuf_puts(w_pqf, pqf_prefix);
1283         wrbuf_puts(w_pqf, " ");
1284     }
1285
1286     if (apply_limit(sdb, facet_limits, w_pqf, ccl_map))
1287     {
1288         ccl_qual_rm(&ccl_map);
1289         return -2;
1290     }
1291
1292     facet_limits_destroy(cl->facet_limits);
1293     cl->facet_limits = facet_limits_dup(facet_limits);
1294
1295     yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s", client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
1296     cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1297     ccl_qual_rm(&ccl_map);
1298     if (!cn)
1299     {
1300         client_set_state(cl, Client_Error);
1301         session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1302                     client_get_id(cl),
1303                     wrbuf_cstr(w_ccl));
1304         wrbuf_destroy(w_ccl);
1305         wrbuf_destroy(w_pqf);
1306         return -1;
1307     }
1308     wrbuf_destroy(w_ccl);
1309
1310     if (!pqf_strftime || !*pqf_strftime)
1311         ccl_pquery(w_pqf, cn);
1312     else
1313     {
1314         time_t cur_time = time(0);
1315         struct tm *tm =  localtime(&cur_time);
1316         char tmp_str[300];
1317         const char *cp = tmp_str;
1318
1319         /* see man strftime(3) for things .. In particular %% gets converted
1320          to %.. And That's our original query .. */
1321         strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1322         for (; *cp; cp++)
1323         {
1324             if (cp[0] == '%')
1325                 ccl_pquery(w_pqf, cn);
1326             else
1327                 wrbuf_putc(w_pqf, cp[0]);
1328         }
1329     }
1330
1331     /* Compares query and limit with old one. If different we need to research */
1332     if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1333     {
1334         if (cl->pquery)
1335             session_log(se, YLOG_LOG, "Client %s: Re-search due query/limit change: %s to %s",
1336                         client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
1337         xfree(cl->pquery);
1338         cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1339         // return value is no longer used.
1340         ret_value = 0;
1341         // Need to (re)search
1342         cl->same_search= 0;
1343     }
1344     wrbuf_destroy(w_pqf);
1345
1346     xfree(cl->cqlquery);
1347     cl->cqlquery = 0;
1348
1349     odr_out = odr_createmem(ODR_ENCODE);
1350     zquery = p_query_rpn(odr_out, cl->pquery);
1351     if (!zquery)
1352     {
1353
1354         session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1355                     client_get_id(cl), cl->pquery);
1356         ret_value = -1;
1357     }
1358     else
1359     {
1360         session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1361                     client_get_id(cl), cl->pquery);
1362
1363         /* Support for PQF on SRU targets. */
1364         if (strcmp(query_syntax, "pqf") != 0 && *sru)
1365         {
1366             if (!strcmp(sru, "solr"))
1367                 cl->cqlquery = make_solrquery(cl, zquery);
1368             else
1369                 cl->cqlquery = make_cqlquery(cl, zquery);
1370             if (!cl->cqlquery)
1371                 ret_value = -1;
1372             else
1373                 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
1374                             client_get_id(cl), cl->cqlquery, sru);
1375         }
1376     }
1377     odr_destroy(odr_out);
1378
1379     /* TODO FIX Not thread safe */
1380     if (!se->relevance)
1381     {
1382         // Initialize relevance structure with query terms
1383         se->relevance = relevance_create_ccl(se->service->charsets, cn,
1384                                              se->service->rank_cluster,
1385                                              se->service->rank_follow,
1386                                              se->service->rank_lead,
1387                                              se->service->rank_length);
1388     }
1389     ccl_rpn_delete(cn);
1390     return ret_value;
1391 }
1392
1393 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
1394 {
1395     if (sp)
1396     {
1397         const char *sort_strategy_and_spec =
1398             get_strategy_plus_sort(cl, sp->name);
1399         int increasing = sp->increasing;
1400         if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1401         {
1402             char strategy[50], *p;
1403             strcpy(strategy, sort_strategy_and_spec);
1404             p = strchr(strategy, ':');
1405             if (p)
1406             {
1407                 // Split the string in two
1408                 *p++ = 0;
1409                 while (*p == ' ')
1410                     p++;
1411                 if (increasing)
1412                     strcat(p, " <");
1413                 else
1414                     strcat(p, " >");
1415                 yaz_log(YLOG_LOG, "Client %s: applying sorting %s %s", client_get_id(cl), strategy, p);
1416                 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
1417                     cl->same_search = 0;
1418                 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
1419                     cl->same_search = 0;
1420                 if (cl->same_search == 0) {
1421                     xfree(cl->sort_strategy);
1422                     cl->sort_strategy = xstrdup(strategy);
1423                     xfree(cl->sort_criteria);
1424                     cl->sort_criteria = xstrdup(p);
1425                 }
1426             }
1427             else {
1428                 yaz_log(YLOG_LOG, "Client %s: Invalid sort strategy and spec found %s", client_get_id(cl), sort_strategy_and_spec);
1429                 xfree(cl->sort_strategy);
1430                 cl->sort_strategy  = 0;
1431                 xfree(cl->sort_criteria);
1432                 cl->sort_criteria = 0;
1433             }
1434         } else {
1435             yaz_log(YLOG_DEBUG, "Client %s: No sort strategy and spec found.", client_get_id(cl));
1436             xfree(cl->sort_strategy);
1437             cl->sort_strategy  = 0;
1438             xfree(cl->sort_criteria);
1439             cl->sort_criteria = 0;
1440         }
1441
1442     }
1443     return !cl->same_search;
1444 }
1445
1446 void client_set_session(struct client *cl, struct session *se)
1447 {
1448     cl->session = se;
1449 }
1450
1451 int client_is_active(struct client *cl)
1452 {
1453     if (cl->connection && (cl->state == Client_Connecting ||
1454                            cl->state == Client_Working))
1455         return 1;
1456     return 0;
1457 }
1458
1459 int client_is_active_preferred(struct client *cl)
1460 {
1461     /* only count if this is a preferred target. */
1462     if (!cl->preferred)
1463         return 0;
1464     /* TODO No sure this the condition that Seb wants */
1465     if (cl->connection && (cl->state == Client_Connecting ||
1466                            cl->state == Client_Working))
1467         return 1;
1468     return 0;
1469 }
1470
1471 Odr_int client_get_hits(struct client *cl)
1472 {
1473     return cl->hits;
1474 }
1475
1476 Odr_int client_get_approximation(struct client *cl)
1477 {
1478     if (cl->record_offset > 0) {
1479         Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered)) / cl->record_offset + 5) /10;
1480         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);
1481         return approx;
1482     }
1483     return cl->hits;
1484 }
1485
1486 int client_get_num_records(struct client *cl)
1487 {
1488     return cl->record_offset;
1489 }
1490
1491 int client_get_num_records_filtered(struct client *cl)
1492 {
1493     return cl->filtered;
1494 }
1495
1496 void client_set_diagnostic(struct client *cl, int diagnostic,
1497                            const char *addinfo)
1498 {
1499     cl->diagnostic = diagnostic;
1500     xfree(cl->addinfo);
1501     cl->addinfo = 0;
1502     if (addinfo)
1503         cl->addinfo = xstrdup(addinfo);
1504 }
1505
1506 int client_get_diagnostic(struct client *cl, const char **addinfo)
1507 {
1508     if (addinfo)
1509         *addinfo = cl->addinfo;
1510     return cl->diagnostic;
1511 }
1512
1513 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1514 {
1515     /* int idx; */
1516     struct suggestions *suggestions = cl->suggestions;
1517
1518     if (!suggestions) {
1519         //yaz_log(YLOG_DEBUG, "No suggestions found");
1520         return "";
1521     }
1522     if (suggestions->passthrough) {
1523         yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1524         return suggestions->passthrough;
1525     }
1526     if (suggestions->num == 0) {
1527         return "";
1528     }
1529     /*
1530     for (idx = 0; idx < suggestions->num; idx++) {
1531         wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1532         if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1533             wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1534             wrbuf_puts(wrbuf, "</suggest>\n");
1535         }
1536         else
1537             wrbuf_puts(wrbuf, "/>\n");
1538     }
1539     */
1540     return wrbuf_cstr(wrbuf);
1541 }
1542
1543
1544 void client_set_database(struct client *cl, struct session_database *db)
1545 {
1546     cl->database = db;
1547 }
1548
1549 const char *client_get_id(struct client *cl)
1550 {
1551     return cl->id;
1552 }
1553
1554 int client_get_maxrecs(struct client *cl)
1555 {
1556     return cl->maxrecs;
1557 }
1558
1559 void client_set_preferred(struct client *cl, int v)
1560 {
1561     cl->preferred = v;
1562 }
1563
1564
1565 struct suggestions* client_suggestions_create(const char* suggestions_string)
1566 {
1567     int i;
1568     NMEM nmem;
1569     struct suggestions *suggestions;
1570     if (suggestions_string == 0 || suggestions_string[0] == 0 )
1571         return 0;
1572     nmem = nmem_create();
1573     suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1574     yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1575
1576     suggestions->nmem = nmem;
1577     suggestions->num = 0;
1578     suggestions->misspelled = 0;
1579     suggestions->suggest = 0;
1580     suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1581
1582     if (suggestions_string)
1583         nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1584                               &suggestions->num, 1, '\\', 0);
1585     /* Set up misspelled array */
1586     suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1587     /* replace = with \0 .. for each item */
1588     for (i = 0; i < suggestions->num; i++)
1589     {
1590         char *cp = strchr(suggestions->suggest[i], '=');
1591         if (cp) {
1592             *cp = '\0';
1593             suggestions->misspelled[i] = cp+1;
1594         }
1595     }
1596     return suggestions;
1597 }
1598
1599 static void client_suggestions_destroy(struct client *cl)
1600 {
1601     NMEM nmem = cl->suggestions->nmem;
1602     cl->suggestions = 0;
1603     nmem_destroy(nmem);
1604 }
1605
1606 int client_test_sort_order(struct client *cl, struct reclist_sortparms *sp)
1607 {
1608     //TODO implement correctly.
1609     return 1;
1610 }
1611 /*
1612  * Local variables:
1613  * c-basic-offset: 4
1614  * c-file-style: "Stroustrup"
1615  * indent-tabs-mode: nil
1616  * End:
1617  * vim: shiftwidth=4 tabstop=8 expandtab
1618  */
1619