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