src/client.c

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