src/client.c

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