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