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, cl);
 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 struct suggestions* client_suggestions_create(const char* suggestions_string);
 547 static void client_suggestions_destroy(struct client *cl);
 548
 549 void client_search_response(struct client *cl)
 550 {
 551     struct connection *co = cl->connection;
 552     ZOOM_connection link = connection_get_link(co);
 553     ZOOM_resultset resultset = cl->resultset;
 554     struct session *se = client_get_session(cl);
 555
 556     const char *error, *addinfo = 0;
 557
 558     if (ZOOM_connection_error(link, &error, &addinfo))
 559     {
 560         cl->hits = 0;
 561         session_log(se, YLOG_WARN, "%s: Error %s (%s)",
 562                     client_get_id(cl), error, addinfo);
 563         client_set_state(cl, Client_Error);
 564     }
 565     else
 566     {
 567         client_report_facets(cl, resultset);
 568         cl->record_offset = cl->startrecs;
 569         cl->hits = ZOOM_resultset_size(resultset);
 570         session_log(se, YLOG_LOG, "%s: hits: " ODR_INT_PRINTF,
 571                     client_get_id(cl), cl->hits);
 572         if (cl->suggestions)
 573             client_suggestions_destroy(cl);
 574         cl->suggestions =
 575             client_suggestions_create(ZOOM_resultset_option_get(
 576                                           resultset, "suggestions"));
 577     }
 578 }
 579
 580 void client_got_records(struct client *cl)
 581 {
 582     struct session *se = cl->session;
 583     if (se)
 584     {
 585         client_unlock(cl);
 586         /* TODO possible threading issue. Session can have been destroyed */
 587         if (session_is_preferred_clients_ready(se))
 588             session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
 589         client_lock(cl);
 590         if (reclist_get_num_records(se->reclist) > 0)
 591         {
 592             client_unlock(cl);
 593             session_alert_watch(se, SESSION_WATCH_SHOW);
 594             session_alert_watch(se, SESSION_WATCH_BYTARGET);
 595             session_alert_watch(se, SESSION_WATCH_TERMLIST);
 596             session_alert_watch(se, SESSION_WATCH_RECORD);
 597             client_lock(cl);
 598         }
 599     }
 600 }
 601
 602 static void client_record_ingest(struct client *cl)
 603 {
 604     const char *msg, *addinfo;
 605     ZOOM_record rec = 0;
 606     ZOOM_resultset resultset = cl->resultset;
 607     struct session *se = client_get_session(cl);
 608     xmlDoc *xdoc;
 609     int offset = cl->record_offset + 1; /* 0 versus 1 numbered offsets */
 610
 611     xdoc = client_get_xdoc(cl, offset);
 612     if (xdoc)
 613     {
 614         if (cl->session)
 615         {
 616             NMEM nmem = nmem_create();
 617             int rc = ingest_xml_record(cl, xdoc, offset, nmem, 1);
 618             if (rc == -1)
 619             {
 620                 session_log(se, YLOG_WARN,
 621                             "%s: #%d: failed to ingest xdoc",
 622                             client_get_id(cl), offset);
 623                 cl->ingest_failures++;
 624             }
 625             else if (rc == -2)
 626                 cl->filtered++;
 627             nmem_destroy(nmem);
 628         }
 629     }
 630     else if ((rec = ZOOM_resultset_record_immediate(resultset,
 631                                                     cl->record_offset)))
 632     {
 633         if (cl->session == 0)
 634             ;  /* no operation */
 635         else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
 636         {
 637             session_log(se, YLOG_WARN, "Record error %s (%s): %s #%d",
 638                         msg, addinfo, client_get_id(cl), offset);
 639             cl->record_failures++;
 640         }
 641         else
 642         {
 643             struct session_database *sdb = client_get_database(cl);
 644             NMEM nmem = nmem_create();
 645             const char *xmlrec;
 646             char type[80];
 647
 648             const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
 649             if (nativesyntax_to_type(s, type, rec))
 650                 session_log(se, YLOG_WARN, "Failed to determine record type");
 651             xmlrec = ZOOM_record_get(rec, type, NULL);
 652             if (!xmlrec)
 653             {
 654                 const char *rec_syn =  ZOOM_record_get(rec, "syntax", NULL);
 655                 session_log(se, YLOG_WARN, "%s: #%d: ZOOM_record_get failed",
 656                             client_get_id(cl), offset);
 657                 session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
 658                             "ZOOM record type=%s . Actual record syntax=%s",
 659                             s ? s : "null", type,
 660                             rec_syn ? rec_syn : "null");
 661                 cl->ingest_failures++;
 662             }
 663             else
 664             {
 665                 /* OK = 0, -1 = failure, -2 = Filtered */
 666                 int rc = ingest_record(cl, xmlrec, offset, nmem);
 667                 if (rc == -1)
 668                 {
 669                     const char *rec_syn =  ZOOM_record_get(rec, "syntax", NULL);
 670                     session_log(se, YLOG_WARN,
 671                                 "%s: #%d: failed to ingest record",
 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 if (rc == -2)
 680                     cl->filtered++;
 681             }
 682             nmem_destroy(nmem);
 683         }
 684     }
 685     else
 686     {
 687         session_log(se, YLOG_WARN, "Got NULL record from %s #%d",
 688                     client_get_id(cl), offset);
 689     }
 690     cl->record_offset++;
 691 }
 692
 693 void client_record_response(struct client *cl, int *got_records)
 694 {
 695     struct connection *co = cl->connection;
 696     ZOOM_connection link = connection_get_link(co);
 697     ZOOM_resultset resultset = cl->resultset;
 698     const char *error, *addinfo;
 699
 700     if (ZOOM_connection_error(link, &error, &addinfo))
 701     {
 702         struct session *se = client_get_session(cl);
 703         session_log(se, YLOG_WARN, "%s: Error %s (%s)",
 704                     client_get_id(cl), error, addinfo);
 705         client_set_state(cl, Client_Error);
 706     }
 707     else
 708     {
 709         if (cl->show_raw && cl->show_raw->active)
 710         {
 711             ZOOM_record rec = 0;
 712             if ((rec = ZOOM_resultset_record_immediate(
 713                      resultset, cl->show_raw->position-1)))
 714             {
 715                 cl->show_raw->active = 0;
 716                 ingest_raw_record(cl, rec);
 717             }
 718             else
 719             {
 720                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 721                         cl->show_raw->position-1);
 722             }
 723         }
 724         else
 725         {
 726             client_record_ingest(cl);
 727             *got_records = 1;
 728         }
 729     }
 730 }
 731
 732 int client_reingest(struct client *cl)
 733 {
 734     int i = cl->startrecs;
 735     int to = cl->record_offset;
 736     cl->record_failures = cl->ingest_failures = cl->filtered = 0;
 737
 738     cl->record_offset = i;
 739     for (; i < to; i++)
 740         client_record_ingest(cl);
 741     return 0;
 742 }
 743
 744 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
 745 {
 746     struct session_database *sdb = client_get_database(cl);
 747
 748     WRBUF w = wrbuf_alloc();
 749
 750     struct setting *s;
 751
 752     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 753     {
 754         const char *p = strchr(s->name + 3, ':');
 755         if (!p)
 756         {
 757             yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
 758         }
 759         else if (s->value && s->value[0])
 760         {
 761             wrbuf_puts(w, "@attr 1=");
 762             yaz_encode_pqf_term(w, s->value, strlen(s->value));
 763             if (s->next)
 764                 wrbuf_puts(w, ",");
 765         }
 766     }
 767     yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
 768     ZOOM_connection_option_set(link, "facets",
 769                                wrbuf_len(w) ? wrbuf_cstr(w) : 0);
 770     wrbuf_destroy(w);
 771 }
 772
 773 int client_has_facet(struct client *cl, const char *name)
 774 {
 775     struct session_database *sdb = client_get_database(cl);
 776     struct setting *s;
 777
 778     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 779     {
 780         const char *p = strchr(s->name + 3, ':');
 781         if ( !strncmp(p, ":split:", 7) )
 782             p += 6; // PAZ-1009
 783         yaz_log(YLOG_DEBUG, "client_has_facet: '%s' '%s' '%s' ",
 784                 name, s->name, p);
 785         if (p && !strcmp(name, p + 1))
 786             return 1;
 787     }
 788     return 0;
 789 }
 790
 791 static const char *get_strategy_plus_sort(struct client *l, const char *field)
 792 {
 793     struct session_database *sdb = client_get_database(l);
 794     struct setting *s;
 795
 796     const char *strategy_plus_sort = 0;
 797
 798     for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
 799     {
 800         char *p = strchr(s->name + 3, ':');
 801         if (!p)
 802         {
 803             yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
 804             continue;
 805         }
 806         p++;
 807         if (!strcmp(p, field))
 808         {
 809             strategy_plus_sort = s->value;
 810             break;
 811         }
 812     }
 813     return strategy_plus_sort;
 814 }
 815
 816 void client_update_show_stat(struct client *cl, int cmd)
 817 {
 818     if (cmd == 0)
 819         cl->show_stat_no = 0;
 820     else if (cmd == 1)
 821         cl->show_stat_no++;
 822 }
 823
 824 int client_fetch_more(struct client *cl)
 825 {
 826     struct session_database *sdb = client_get_database(cl);
 827     const char *str;
 828     int extend_recs = 0;
 829     int number = cl->hits - cl->record_offset;
 830
 831     str = session_setting_oneval(sdb, PZ_EXTENDRECS);
 832     if (!str || !*str)
 833         return 0;
 834
 835     extend_recs = atoi(str);
 836
 837     yaz_log(YLOG_LOG, "cl=%s show_stat_no=%d got=%d",
 838             client_get_id(cl), cl->show_stat_no, cl->record_offset);
 839     if (cl->show_stat_no < cl->record_offset)
 840         return 0;
 841     yaz_log(YLOG_LOG, "cl=%s Trying to fetch more", client_get_id(cl));
 842
 843     if (number > extend_recs)
 844         number = extend_recs;
 845     if (number > 0)
 846     {
 847         ZOOM_resultset set = cl->resultset;
 848         struct connection *co = client_get_connection(cl);
 849
 850         str = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 851         ZOOM_resultset_option_set(set, "preferredRecordSyntax", str);
 852         str = session_setting_oneval(sdb, PZ_ELEMENTS);
 853         if (str && *str)
 854             ZOOM_resultset_option_set(set, "elementSetName", str);
 855
 856         ZOOM_resultset_records(set, 0, cl->record_offset, number);
 857         client_set_state(cl, Client_Working);
 858         connection_continue(co);
 859         return 1;
 860     }
 861     else
 862     {
 863         yaz_log(YLOG_LOG, "cl=%s. OK no more in total set", client_get_id(cl));
 864     }
 865     return 0;
 866 }
 867
 868 int client_parse_init(struct client *cl, int same_search)
 869 {
 870     cl->same_search = same_search;
 871     return 0;
 872 }
 873
 874 /*
 875  * TODO consider how to extend the range
 876  * */
 877 int client_parse_range(struct client *cl, const char *startrecs,
 878                        const char *maxrecs)
 879 {
 880     if (maxrecs && atoi(maxrecs) != cl->maxrecs)
 881     {
 882         cl->same_search = 0;
 883         cl->maxrecs = atoi(maxrecs);
 884     }
 885
 886     if (startrecs && atoi(startrecs) != cl->startrecs)
 887     {
 888         cl->same_search = 0;
 889         cl->startrecs = atoi(startrecs);
 890     }
 891
 892     return 0;
 893 }
 894
 895 const char *client_get_query(struct client *cl, const char **type, NMEM nmem)
 896 {
 897     if (cl->pquery)
 898     {
 899         *type = "pqf";
 900         return nmem_strdup(nmem, cl->pquery);
 901     }
 902     if (cl->cqlquery)
 903     {
 904         *type = "cql";
 905         return nmem_strdup(nmem, cl->cqlquery);
 906     }
 907     *type = 0;
 908     return 0;
 909 }
 910
 911 int client_start_search(struct client *cl)
 912 {
 913     struct session_database *sdb = client_get_database(cl);
 914     struct connection *co = 0;
 915     ZOOM_connection link = 0;
 916     struct session *se = client_get_session(cl);
 917     ZOOM_resultset rs;
 918     const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
 919     const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
 920     const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
 921     const char *opt_requestsyn  = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 922     const char *opt_maxrecs     = session_setting_oneval(sdb, PZ_MAXRECS);
 923     const char *opt_sru         = session_setting_oneval(sdb, PZ_SRU);
 924     const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
 925     const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
 926     const char *extra_args      = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
 927     const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
 928     const char *opt_timeout     = session_setting_oneval(sdb, PZ_TIMEOUT);
 929     ZOOM_query query;
 930     char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
 931     struct timeval tval;
 932     int present_chunk = 20; // Default chunk size
 933     int rc_prep_connection;
 934     int operation_timeout = se->service->z3950_operation_timeout;
 935
 936     cl->diagnostic = 0;
 937     cl->record_failures = cl->ingest_failures = cl->filtered = 0;
 938
 939     yaz_gettimeofday(&tval);
 940     tval.tv_sec += 5;
 941
 942     if (opt_timeout && *opt_timeout)
 943         operation_timeout = atoi(opt_timeout);
 944
 945     if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
 946         present_chunk = atoi(opt_present_chunk);
 947         yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
 948     }
 949     rc_prep_connection =
 950         client_prep_connection(cl, operation_timeout,
 951                                se->service->z3950_session_timeout,
 952                                se->service->server->iochan_man,
 953                                &tval);
 954     /* Nothing has changed and we already have a result */
 955     if (cl->same_search == 1 && rc_prep_connection == 2)
 956     {
 957         session_log(se, YLOG_LOG, "%s: reuse result", client_get_id(cl));
 958         client_report_facets(cl, cl->resultset);
 959         return client_reingest(cl);
 960     }
 961     else if (!rc_prep_connection)
 962     {
 963         session_log(se, YLOG_LOG, "%s: postponing search: No connection",
 964                     client_get_id(cl));
 965         client_set_state_nb(cl, Client_Working);
 966         return -1;
 967     }
 968     co = client_get_connection(cl);
 969     assert(cl);
 970     link = connection_get_link(co);
 971     assert(link);
 972
 973     session_log(se, YLOG_LOG, "%s: new search", client_get_id(cl));
 974
 975     client_destroy_xdoc(cl);
 976     client_init_xdoc(cl);
 977
 978     if (extra_args && *extra_args)
 979         ZOOM_connection_option_set(link, "extraArgs", extra_args);
 980
 981     if (opt_preferred) {
 982         cl->preferred = atoi(opt_preferred);
 983         if (cl->preferred)
 984             yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
 985                     client_get_id(cl), cl->preferred);
 986     }
 987
 988     if (*opt_piggyback)
 989         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
 990     else
 991         ZOOM_connection_option_set(link, "piggyback", "1");
 992     if (*opt_queryenc)
 993         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
 994     if (*opt_sru && *opt_elements)
 995         ZOOM_connection_option_set(link, "schema", opt_elements);
 996     else if (*opt_elements)
 997         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
 998     if (*opt_requestsyn)
 999         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
1000
1001     if (opt_maxrecs && *opt_maxrecs)
1002     {
1003         cl->maxrecs = atoi(opt_maxrecs);
1004     }
1005
1006     /* convert back to string representation used in ZOOM API */
1007     sprintf(maxrecs_str, "%d", cl->maxrecs);
1008     ZOOM_connection_option_set(link, "count", maxrecs_str);
1009
1010     /* A present_chunk less than 1 will disable chunking. */
1011     if (present_chunk > 0 && cl->maxrecs > present_chunk) {
1012         sprintf(present_chunk_str, "%d", present_chunk);
1013         ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
1014         yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
1015     }
1016     else {
1017         ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
1018         yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
1019     }
1020     sprintf(startrecs_str, "%d", cl->startrecs);
1021     ZOOM_connection_option_set(link, "start", startrecs_str);
1022
1023     /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
1024     /* facets definition is in PQF */
1025     client_set_facets_request(cl, link);
1026
1027     query = ZOOM_query_create();
1028     if (cl->cqlquery)
1029     {
1030         session_log(se, YLOG_LOG, "%s: Search CQL: %s", client_get_id(cl),
1031                     cl->cqlquery);
1032         ZOOM_query_cql(query, cl->cqlquery);
1033         if (*opt_sort)
1034             ZOOM_query_sortby(query, opt_sort);
1035     }
1036     else
1037     {
1038         session_log(se, YLOG_LOG, "%s: Search PQF: %s", client_get_id(cl),
1039                     cl->pquery);
1040         ZOOM_query_prefix(query, cl->pquery);
1041     }
1042     if (cl->sort_strategy && cl->sort_criteria) {
1043         yaz_log(YLOG_LOG, "Client %s: "
1044                 "Set ZOOM sort strategy and criteria: %s %s",
1045                 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
1046         ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
1047     }
1048
1049     yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
1050     client_set_state(cl, Client_Working);
1051     cl->hits = 0;
1052     cl->record_offset = 0;
1053     rs = ZOOM_connection_search(link, query);
1054     ZOOM_query_destroy(query);
1055     ZOOM_resultset_destroy(cl->resultset);
1056     cl->resultset = rs;
1057     connection_continue(co);
1058     return 0;
1059 }
1060
1061 struct client *client_create(const char *id)
1062 {
1063     struct client *cl = xmalloc(sizeof(*cl));
1064     cl->maxrecs = 100;
1065     cl->startrecs = 0;
1066     cl->pquery = 0;
1067     cl->cqlquery = 0;
1068     cl->addinfo = 0;
1069     cl->message = 0;
1070     cl->database = 0;
1071     cl->connection = 0;
1072     cl->session = 0;
1073     cl->hits = 0;
1074     cl->record_offset = 0;
1075     cl->filtered = 0;
1076     cl->diagnostic = 0;
1077     cl->state = Client_Disconnected;
1078     cl->show_raw = 0;
1079     cl->resultset = 0;
1080     cl->suggestions = 0;
1081     cl->mutex = 0;
1082     pazpar2_mutex_create(&cl->mutex, "client");
1083     cl->preferred = 0;
1084     cl->ref_count = 1;
1085     cl->facet_limits = 0;
1086     cl->sort_strategy = 0;
1087     cl->sort_criteria = 0;
1088     assert(id);
1089     cl->id = xstrdup(id);
1090     client_init_xdoc(cl);
1091     client_use(1);
1092
1093     yaz_log(YLOG_DEBUG, "client_create c=%p %s", cl, id);
1094     return cl;
1095 }
1096
1097 void client_lock(struct client *c)
1098 {
1099     yaz_mutex_enter(c->mutex);
1100 }
1101
1102 void client_unlock(struct client *c)
1103 {
1104     yaz_mutex_leave(c->mutex);
1105 }
1106
1107 void client_incref(struct client *c)
1108 {
1109     pazpar2_incref(&c->ref_count, c->mutex);
1110     yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
1111             c, client_get_id(c), c->ref_count);
1112 }
1113
1114 int client_destroy(struct client *c)
1115 {
1116     if (c)
1117     {
1118         yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
1119                 c, client_get_id(c), c->ref_count);
1120         if (!pazpar2_decref(&c->ref_count, c->mutex))
1121         {
1122             xfree(c->pquery);
1123             c->pquery = 0;
1124             xfree(c->cqlquery);
1125             c->cqlquery = 0;
1126             xfree(c->addinfo);
1127             c->addinfo = 0;
1128             xfree(c->message);
1129             c->message = 0;
1130             xfree(c->id);
1131             xfree(c->sort_strategy);
1132             xfree(c->sort_criteria);
1133             assert(!c->connection);
1134             facet_limits_destroy(c->facet_limits);
1135
1136             client_destroy_xdoc(c);
1137             if (c->resultset)
1138             {
1139                 ZOOM_resultset_destroy(c->resultset);
1140             }
1141             yaz_mutex_destroy(&c->mutex);
1142             xfree(c);
1143             client_use(-1);
1144             return 1;
1145         }
1146     }
1147     return 0;
1148 }
1149
1150 void client_set_connection(struct client *cl, struct connection *con)
1151 {
1152     if (cl->resultset)
1153         ZOOM_resultset_release(cl->resultset);
1154     if (con)
1155     {
1156         assert(cl->connection == 0);
1157         cl->connection = con;
1158         client_incref(cl);
1159     }
1160     else
1161     {
1162         client_lock(cl);
1163         cl->connection = con;
1164         client_unlock(cl);
1165         client_destroy(cl);
1166     }
1167 }
1168
1169 void client_disconnect(struct client *cl)
1170 {
1171     if (cl->state != Client_Idle)
1172         client_set_state(cl, Client_Disconnected);
1173     client_set_connection(cl, 0);
1174 }
1175
1176 void client_stop(struct client *cl)
1177 {
1178     client_lock(cl);
1179     if (cl->state == Client_Working || cl->state == Client_Connecting)
1180     {
1181         yaz_log(YLOG_LOG, "client_stop: %s release", client_get_id(cl));
1182         if (cl->connection)
1183         {
1184             connection_release2(cl->connection);
1185             assert(cl->ref_count > 1);
1186             cl->ref_count--;
1187             cl->connection = 0;
1188         }
1189         cl->state = Client_Disconnected;
1190     }
1191     else
1192         yaz_log(YLOG_LOG, "client_stop: %s ignore", client_get_id(cl));
1193     client_unlock(cl);
1194 }
1195
1196 // Initialize CCL map for a target
1197 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1198 {
1199     struct session_database *sdb = client_get_database(cl);
1200     struct setting *s;
1201     CCL_bibset res;
1202
1203     if (!sdb->settings)
1204         return 0;
1205     if (base_bibset)
1206         res = ccl_qual_dup(base_bibset);
1207     else
1208         res = ccl_qual_mk();
1209     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1210     {
1211         const char *addinfo = 0;
1212         char *p = strchr(s->name + 3, ':');
1213         if (!p)
1214         {
1215             WRBUF w = wrbuf_alloc();
1216             wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1217             yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1218             client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1219                                   ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1220                                   wrbuf_cstr(w));
1221             client_set_state_nb(cl, Client_Error);
1222             ccl_qual_rm(&res);
1223             wrbuf_destroy(w);
1224             return 0;
1225         }
1226         p++;
1227         if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1228         {
1229             WRBUF w = wrbuf_alloc();
1230
1231             wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1232                          s->name, p, addinfo);
1233             yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1234             client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1235                                   ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1236                                   wrbuf_cstr(w));
1237             client_set_state_nb(cl, Client_Error);
1238             ccl_qual_rm(&res);
1239             wrbuf_destroy(w);
1240             return 0;
1241         }
1242     }
1243     return res;
1244 }
1245
1246 // returns a xmalloced CQL query corresponding to the pquery in client
1247 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1248 {
1249     cql_transform_t cqlt = cql_transform_create();
1250     char *r = 0;
1251     WRBUF wrb = wrbuf_alloc();
1252     int status;
1253
1254     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1255     {
1256         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1257     }
1258     else
1259     {
1260         r = xstrdup(wrbuf_cstr(wrb));
1261     }
1262     wrbuf_destroy(wrb);
1263     cql_transform_close(cqlt);
1264     return r;
1265 }
1266
1267 // returns a xmalloced SOLR query corresponding to the pquery in client
1268 // TODO Could prob. be merge with the similar make_cqlquery
1269 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1270 {
1271     solr_transform_t sqlt = solr_transform_create();
1272     char *r = 0;
1273     WRBUF wrb = wrbuf_alloc();
1274     int status;
1275
1276     if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1277     {
1278         yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1279     }
1280     else
1281     {
1282         r = xstrdup(wrbuf_cstr(wrb));
1283     }
1284     wrbuf_destroy(wrb);
1285     solr_transform_close(sqlt);
1286     return r;
1287 }
1288
1289 const char *client_get_facet_limit_local(struct client *cl,
1290                                          struct session_database *sdb,
1291                                          int *l,
1292                                          NMEM nmem, int *num, char ***values)
1293 {
1294     const char *name = 0;
1295     const char *value = 0;
1296     for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1297     {
1298         struct setting *s = 0;
1299
1300         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1301         {
1302             const char *p = strchr(s->name + 3, ':');
1303             if (p && !strcmp(p + 1, name) && s->value)
1304             {
1305                 int j, cnum;
1306                 char **cvalues;
1307                 nmem_strsplit_escape2(nmem, ",", s->value, &cvalues,
1308                                       &cnum, 1, '\\', 1);
1309                 for (j = 0; j < cnum; j++)
1310                 {
1311                     const char *cvalue = cvalues[j];
1312                     while (*cvalue == ' ')
1313                         cvalue++;
1314                     if (!strncmp(cvalue, "local:", 6))
1315                     {
1316                         const char *cp = cvalue + 6;
1317                         while (*cp == ' ')
1318                             cp++;
1319                         nmem_strsplit_escape2(nmem, "|", value, values,
1320                                               num, 1, '\\', 1);
1321                         (*l)++;
1322                         return *cp ? cp : name;
1323                     }
1324                 }
1325             }
1326         }
1327     }
1328     return 0;
1329 }
1330
1331 static void ccl_quote_map_term(CCL_bibset ccl_map, WRBUF w,
1332                                const char *term)
1333 {
1334     int quote_it = 0;
1335     const char *cp;
1336     for (cp = term; *cp; cp++)
1337         if ((*cp >= '0' && *cp <= '9') || strchr(" +-", *cp))
1338             ;
1339         else
1340             quote_it = 1;
1341     if (!quote_it)
1342         wrbuf_puts(w, term);
1343     else
1344     {
1345         wrbuf_putc(w, '\"');
1346         for (cp = term; *cp; cp++)
1347         {
1348             if (strchr( "\\\"", *cp))
1349                 wrbuf_putc(w, '\\');
1350             wrbuf_putc(w, *cp);
1351         }
1352         wrbuf_putc(w, '\"');
1353     }
1354 }
1355
1356 static int apply_limit(struct client *cl,
1357                        facet_limits_t facet_limits,
1358                        WRBUF w_pqf, CCL_bibset ccl_map,
1359                        struct conf_service *service)
1360 {
1361     int ret = 0;
1362     int i = 0;
1363     const char *name;
1364     const char *value;
1365     struct session_database *sdb = client_get_database(cl);
1366
1367     NMEM nmem_tmp = nmem_create();
1368     for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1369     {
1370         struct setting *s = 0;
1371         nmem_reset(nmem_tmp);
1372         /* name="pz:limitmap:author" value="rpn:@attr 1=4|local:other" */
1373         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1374         {
1375             const char *p = strchr(s->name + 3, ':');
1376             if (p && !strcmp(p + 1, name) && s->value)
1377             {
1378                 char **values = 0;
1379                 int i, num = 0;
1380                 char **cvalues = 0;
1381                 int j, cnum = 0;
1382                 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1383                                       &num, 1, '\\', 1);
1384
1385                 for (i = 0; i < num; i++)
1386                 {
1387                     const char *id = session_lookup_id_facet(cl->session,
1388                                                              cl, name,
1389                                                              values[i]);
1390                     if (id) {
1391                         values[i] = nmem_strdup(nmem_tmp, id);
1392                         yaz_log(YLOG_DEBUG,
1393                             "apply_limit: s='%s' found id '%s'",s->name,id );
1394
1395                     }
1396                 }
1397                 nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues,
1398                                       &cnum, 1, '\\', 1);
1399
1400                 for (j = 0; ret == 0 && j < cnum; j++)
1401                 {
1402                     const char *cvalue = cvalues[j];
1403                     while (*cvalue == ' ')
1404                         cvalue++;
1405                     if (!strncmp(cvalue, "rpn:", 4))
1406                     {
1407                         const char *pqf = cvalue + 4;
1408                         wrbuf_puts(w_pqf, "@and ");
1409                         wrbuf_puts(w_pqf, pqf);
1410                         wrbuf_puts(w_pqf, " ");
1411                         for (i = 0; i < num; i++)
1412                         {
1413                             if (i < num - 1)
1414                                 wrbuf_puts(w_pqf, "@or ");
1415                             yaz_encode_pqf_term(w_pqf, values[i],
1416                                                 strlen(values[i]));
1417                         }
1418                     }
1419                     else if (!strncmp(cvalue, "ccl:", 4))
1420                     {
1421                         const char *ccl = cvalue + 4;
1422                         WRBUF ccl_w = wrbuf_alloc();
1423                         for (i = 0; i < num; i++)
1424                         {
1425                             int cerror, cpos;
1426                             struct ccl_rpn_node *cn;
1427                             wrbuf_rewind(ccl_w);
1428                             wrbuf_puts(ccl_w, ccl);
1429                             wrbuf_putc(ccl_w, '=');
1430                             ccl_quote_map_term(ccl_map, ccl_w, values[i]);
1431                             cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1432                                               &cerror, &cpos);
1433                             if (cn)
1434                             {
1435                                 if (i == 0)
1436                                     wrbuf_printf(w_pqf, "@and ");
1437
1438                                 /* or multiple values.. could be bad if last
1439                                    CCL parse fails, but this is unlikely to
1440                                    happen */
1441                                 if (i < num - 1)
1442                                     wrbuf_printf(w_pqf, "@or ");
1443                                 ccl_pquery(w_pqf, cn);
1444                                 yaz_log(YLOG_DEBUG,"apply_limit (ccl): %s",
1445                                         wrbuf_cstr(w_pqf));
1446                                 ccl_rpn_delete(cn);
1447                             }
1448                         }
1449                         wrbuf_destroy(ccl_w);
1450                     }
1451                     else if (!strncmp(cvalue, "local:", 6)) {
1452                         /* no operation */
1453                     }
1454                     else
1455                     {
1456                         yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1457                                 sdb->database->id, cvalue);
1458                         ret = -1; /* bad limitmap */
1459                     }
1460                 }
1461                 break;
1462             }
1463         }
1464         if (!s)
1465         {
1466             int i;
1467             for (i = 0; i < service->num_metadata; i++)
1468             {
1469                 struct conf_metadata *md = service->metadata + i;
1470                 if (!strcmp(md->name, name) && md->limitcluster)
1471                 {
1472                     yaz_log(YLOG_LOG, "limitcluster in use for %s",
1473                             md->name);
1474                     break;
1475                 }
1476             }
1477             if (i == service->num_metadata)
1478             {
1479                 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1480                         (sdb->database ? sdb->database->id : "<no id>"), name);
1481             }
1482         }
1483     }
1484     nmem_destroy(nmem_tmp);
1485     return ret;
1486 }
1487
1488 // Parse the query given the settings specific to this client
1489 // client variable same_search is set as below as well as returned:
1490 // 0 if query is OK but different from before
1491 // 1 if query is OK but same as before
1492 // return -1 on query error
1493 // return -2 on limit error
1494 int client_parse_query(struct client *cl, const char *query,
1495                        facet_limits_t facet_limits, const char **error_msg)
1496 {
1497     struct session *se = client_get_session(cl);
1498     struct conf_service *service = se->service;
1499     struct session_database *sdb = client_get_database(cl);
1500     struct ccl_rpn_node *cn;
1501     int cerror, cpos;
1502     ODR odr_out;
1503     CCL_bibset ccl_map = prepare_cclmap(cl, service->ccl_bibset);
1504     const char *sru = session_setting_oneval(sdb, PZ_SRU);
1505     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1506     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1507     const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1508     WRBUF w_ccl, w_pqf;
1509     int ret_value = 1;
1510     Z_RPNQuery *zquery;
1511
1512     if (!ccl_map)
1513         return -3;
1514
1515     w_ccl = wrbuf_alloc();
1516     wrbuf_puts(w_ccl, query);
1517
1518     w_pqf = wrbuf_alloc();
1519     if (*pqf_prefix)
1520     {
1521         wrbuf_puts(w_pqf, pqf_prefix);
1522         wrbuf_puts(w_pqf, " ");
1523     }
1524
1525     if (apply_limit(cl, facet_limits, w_pqf, ccl_map, service))
1526     {
1527         ccl_qual_rm(&ccl_map);
1528         return -2;
1529     }
1530
1531     facet_limits_destroy(cl->facet_limits);
1532     cl->facet_limits = facet_limits_dup(facet_limits);
1533
1534     yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s",
1535             client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
1536     cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1537     ccl_qual_rm(&ccl_map);
1538     if (!cn)
1539     {
1540         if (error_msg)
1541             *error_msg = ccl_err_msg(cerror);
1542         client_set_state(cl, Client_Error);
1543         session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1544                     client_get_id(cl),
1545                     wrbuf_cstr(w_ccl));
1546         wrbuf_destroy(w_ccl);
1547         wrbuf_destroy(w_pqf);
1548         return -1;
1549     }
1550     wrbuf_destroy(w_ccl);
1551
1552     if (!pqf_strftime || !*pqf_strftime)
1553         ccl_pquery(w_pqf, cn);
1554     else
1555     {
1556         time_t cur_time = time(0);
1557         struct tm *tm =  localtime(&cur_time);
1558         char tmp_str[300];
1559         const char *cp = tmp_str;
1560
1561         /* see man strftime(3) for things .. In particular %% gets converted
1562          to %.. And That's our original query .. */
1563         strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1564         for (; *cp; cp++)
1565         {
1566             if (cp[0] == '%')
1567                 ccl_pquery(w_pqf, cn);
1568             else
1569                 wrbuf_putc(w_pqf, cp[0]);
1570         }
1571     }
1572
1573     /* Compares query and limit with old one. If different we need to research */
1574     if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1575     {
1576         if (cl->pquery)
1577             session_log(se, YLOG_LOG, "Client %s: "
1578                         "Re-search due query/limit change: %s to %s",
1579                         client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
1580         xfree(cl->pquery);
1581         cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1582         // return value is no longer used.
1583         ret_value = 0;
1584         // Need to (re)search
1585         cl->same_search= 0;
1586     }
1587     wrbuf_destroy(w_pqf);
1588
1589     xfree(cl->cqlquery);
1590     cl->cqlquery = 0;
1591
1592     odr_out = odr_createmem(ODR_ENCODE);
1593     zquery = p_query_rpn(odr_out, cl->pquery);
1594     if (!zquery)
1595     {
1596
1597         session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1598                     client_get_id(cl), cl->pquery);
1599         ret_value = -1;
1600         *error_msg = "Invalid PQF after CCL to PQF conversion";
1601     }
1602     else
1603     {
1604         session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1605                     client_get_id(cl), cl->pquery);
1606
1607         /* Support for PQF on SRU targets. */
1608         if (strcmp(query_syntax, "pqf") != 0 && *sru)
1609         {
1610             if (!strcmp(sru, "solr"))
1611                 cl->cqlquery = make_solrquery(cl, zquery);
1612             else
1613                 cl->cqlquery = make_cqlquery(cl, zquery);
1614             if (!cl->cqlquery)
1615             {
1616                 *error_msg = "Cannot convert PQF to Solr/CQL";
1617                 ret_value = -1;
1618             }
1619             else
1620                 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
1621                             client_get_id(cl), cl->cqlquery, sru);
1622         }
1623     }
1624     odr_destroy(odr_out);
1625
1626     /* TODO FIX Not thread safe */
1627     if (!se->relevance)
1628     {
1629         // Initialize relevance structure with query terms
1630         se->relevance = relevance_create_ccl(se->service->charsets, cn,
1631                                              se->service->rank_cluster,
1632                                              se->service->rank_follow,
1633                                              se->service->rank_lead,
1634                                              se->service->rank_length);
1635     }
1636     ccl_rpn_delete(cn);
1637     return ret_value;
1638 }
1639
1640 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
1641 {
1642     if (sp)
1643     {
1644         const char *sort_strategy_and_spec =
1645             get_strategy_plus_sort(cl, sp->name);
1646         int increasing = sp->increasing;
1647         if (!strcmp(sp->name, "relevance"))
1648             increasing = 1;
1649         if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1650         {
1651             char strategy[50], *p;
1652             strcpy(strategy, sort_strategy_and_spec);
1653             p = strchr(strategy, ':');
1654             if (p)
1655             {
1656                 // Split the string in two
1657                 *p++ = 0;
1658                 while (*p == ' ')
1659                     p++;
1660                 if (increasing)
1661                     strcat(p, " <");
1662                 else
1663                     strcat(p, " >");
1664                 yaz_log(YLOG_LOG, "Client %s: "
1665                         "applying sorting %s %s", client_get_id(cl),
1666                         strategy, p);
1667                 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
1668                     cl->same_search = 0;
1669                 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
1670                     cl->same_search = 0;
1671                 if (cl->same_search == 0) {
1672                     xfree(cl->sort_strategy);
1673                     cl->sort_strategy = xstrdup(strategy);
1674                     xfree(cl->sort_criteria);
1675                     cl->sort_criteria = xstrdup(p);
1676                 }
1677             }
1678             else {
1679                 yaz_log(YLOG_LOG, "Client %s: "
1680                         "Invalid sort strategy and spec found %s",
1681                         client_get_id(cl), sort_strategy_and_spec);
1682                 xfree(cl->sort_strategy);
1683                 cl->sort_strategy  = 0;
1684                 xfree(cl->sort_criteria);
1685                 cl->sort_criteria = 0;
1686             }
1687         }
1688         else
1689         {
1690             yaz_log(YLOG_DEBUG, "Client %s: "
1691                     "No sort strategy and spec found.", client_get_id(cl));
1692             xfree(cl->sort_strategy);
1693             cl->sort_strategy  = 0;
1694             xfree(cl->sort_criteria);
1695             cl->sort_criteria = 0;
1696         }
1697
1698     }
1699     return !cl->same_search;
1700 }
1701
1702 void client_set_session(struct client *cl, struct session *se)
1703 {
1704     cl->session = se;
1705 }
1706
1707 int client_is_active(struct client *cl)
1708 {
1709     if (cl->connection && (cl->state == Client_Connecting ||
1710                            cl->state == Client_Working))
1711         return 1;
1712     return 0;
1713 }
1714
1715 int client_is_active_preferred(struct client *cl)
1716 {
1717     /* only count if this is a preferred target. */
1718     if (!cl->preferred)
1719         return 0;
1720     /* TODO No sure this the condition that Seb wants */
1721     if (cl->connection && (cl->state == Client_Connecting ||
1722                            cl->state == Client_Working))
1723         return 1;
1724     return 0;
1725 }
1726
1727 Odr_int client_get_hits(struct client *cl)
1728 {
1729     return cl->hits;
1730 }
1731
1732 Odr_int client_get_approximation(struct client *cl)
1733 {
1734     if (cl->record_offset > 0)
1735     {
1736         Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered))
1737                           / cl->record_offset + 5) /10;
1738         yaz_log(YLOG_DEBUG, "%s: Approx: %lld * %d / %d = %lld ",
1739                 client_get_id(cl), cl->hits,
1740                 cl->record_offset - cl->filtered, cl->record_offset, approx);
1741         return approx;
1742     }
1743     return cl->hits;
1744 }
1745
1746 int client_get_num_records(struct client *cl, int *filtered, int *ingest,
1747                            int *failed)
1748 {
1749     if (filtered)
1750         *filtered = cl->filtered;
1751     if (ingest)
1752         *ingest = cl->ingest_failures;
1753     if (failed)
1754         *failed = cl->record_failures;
1755     return cl->record_offset;
1756 }
1757
1758 void client_set_diagnostic(struct client *cl, int diagnostic,
1759                            const char *message, const char *addinfo)
1760 {
1761     cl->diagnostic = diagnostic;
1762     xfree(cl->message);
1763     cl->message = xstrdup(message);
1764     xfree(cl->addinfo);
1765     cl->addinfo = 0;
1766     if (addinfo)
1767         cl->addinfo = xstrdup(addinfo);
1768 }
1769
1770 int client_get_diagnostic(struct client *cl, const char **message,
1771                           const char **addinfo)
1772 {
1773     if (message)
1774         *message = cl->message;
1775     if (addinfo)
1776         *addinfo = cl->addinfo;
1777     return cl->diagnostic;
1778 }
1779
1780 const char *client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1781 {
1782     /* int idx; */
1783     struct suggestions *suggestions = cl->suggestions;
1784
1785     if (!suggestions)
1786         return "";
1787     if (suggestions->passthrough)
1788     {
1789         yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n",
1790                 suggestions->passthrough);
1791         return suggestions->passthrough;
1792     }
1793     if (suggestions->num == 0)
1794         return "";
1795     /*
1796     for (idx = 0; idx < suggestions->num; idx++) {
1797         wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1798         if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1799             wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1800             wrbuf_puts(wrbuf, "</suggest>\n");
1801         }
1802         else
1803             wrbuf_puts(wrbuf, "/>\n");
1804     }
1805     */
1806     return wrbuf_cstr(wrbuf);
1807 }
1808
1809 void client_set_database(struct client *cl, struct session_database *db)
1810 {
1811     cl->database = db;
1812 }
1813
1814 const char *client_get_id(struct client *cl)
1815 {
1816     return cl->id;
1817 }
1818
1819 int client_get_maxrecs(struct client *cl)
1820 {
1821     return cl->maxrecs;
1822 }
1823
1824 void client_set_preferred(struct client *cl, int v)
1825 {
1826     cl->preferred = v;
1827 }
1828
1829
1830 struct suggestions* client_suggestions_create(const char* suggestions_string)
1831 {
1832     int i;
1833     NMEM nmem;
1834     struct suggestions *suggestions;
1835     if (suggestions_string == 0 || suggestions_string[0] == 0 )
1836         return 0;
1837     nmem = nmem_create();
1838     suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1839     yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1840
1841     suggestions->nmem = nmem;
1842     suggestions->num = 0;
1843     suggestions->misspelled = 0;
1844     suggestions->suggest = 0;
1845     suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1846
1847     if (suggestions_string)
1848         nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1849                               &suggestions->num, 1, '\\', 0);
1850     /* Set up misspelled array */
1851     suggestions->misspelled = (char **)
1852         nmem_malloc(nmem, suggestions->num * sizeof(*suggestions->misspelled));
1853     /* replace = with \0 .. for each item */
1854     for (i = 0; i < suggestions->num; i++)
1855     {
1856         char *cp = strchr(suggestions->suggest[i], '=');
1857         if (cp) {
1858             *cp = '\0';
1859             suggestions->misspelled[i] = cp+1;
1860         }
1861     }
1862     return suggestions;
1863 }
1864
1865 static void client_suggestions_destroy(struct client *cl)
1866 {
1867     NMEM nmem = cl->suggestions->nmem;
1868     cl->suggestions = 0;
1869     nmem_destroy(nmem);
1870 }
1871
1872 /*
1873  * Local variables:
1874  * c-basic-offset: 4
1875  * c-file-style: "Stroustrup"
1876  * indent-tabs-mode: nil
1877  * End:
1878  * vim: shiftwidth=4 tabstop=8 expandtab
1879  */
1880