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