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