src/client.c

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