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