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