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