src/client.c

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