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