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