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