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         client_unlock(cl);
 559         session_alert_watch(se, SESSION_WATCH_SHOW);
 560         session_alert_watch(se, SESSION_WATCH_BYTARGET);
 561         session_alert_watch(se, SESSION_WATCH_TERMLIST);
 562         session_alert_watch(se, SESSION_WATCH_RECORD);
 563         client_lock(cl);
 564     }
 565 }
 566
 567 static void client_record_ingest(struct client *cl)
 568 {
 569     const char *msg, *addinfo;
 570     ZOOM_record rec = 0;
 571     ZOOM_resultset resultset = cl->resultset;
 572     int offset = cl->record_offset;
 573     if ((rec = ZOOM_resultset_record(resultset, offset)))
 574     {
 575         cl->record_offset++;
 576         if (cl->session == 0)
 577             ;
 578         else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
 579         {
 580             yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
 581                     msg, addinfo, client_get_id(cl),
 582                     cl->record_offset);
 583         }
 584         else
 585         {
 586             struct session_database *sdb = client_get_database(cl);
 587             NMEM nmem = nmem_create();
 588             const char *xmlrec;
 589             char type[80];
 590
 591             if (nativesyntax_to_type(sdb, type, rec))
 592                 yaz_log(YLOG_WARN, "Failed to determine record type");
 593             xmlrec = ZOOM_record_get(rec, type, NULL);
 594             if (!xmlrec)
 595                 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
 596                         client_get_id(cl));
 597             else
 598             {
 599                 /* OK = 0, -1 = failure, -2 = Filtered */
 600                 if (ingest_record(cl, xmlrec, cl->record_offset, nmem) == -1)
 601                     yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
 602             }
 603             nmem_destroy(nmem);
 604         }
 605     }
 606     else
 607     {
 608         yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 609                 offset);
 610     }
 611 }
 612
 613 void client_record_response(struct client *cl)
 614 {
 615     struct connection *co = cl->connection;
 616     ZOOM_connection link = connection_get_link(co);
 617     ZOOM_resultset resultset = cl->resultset;
 618     const char *error, *addinfo;
 619
 620     if (ZOOM_connection_error(link, &error, &addinfo))
 621     {
 622         client_set_state(cl, Client_Error);
 623         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 624             error, addinfo, client_get_id(cl));
 625     }
 626     else
 627     {
 628         if (cl->show_raw && cl->show_raw->active)
 629         {
 630             ZOOM_record rec = 0;
 631             if ((rec = ZOOM_resultset_record(resultset,
 632                                              cl->show_raw->position-1)))
 633             {
 634                 cl->show_raw->active = 0;
 635                 ingest_raw_record(cl, rec);
 636             }
 637             else
 638             {
 639                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 640                         cl->show_raw->position-1);
 641             }
 642         }
 643         else
 644         {
 645             client_record_ingest(cl);
 646         }
 647     }
 648 }
 649
 650 void client_reingest(struct client *cl)
 651 {
 652     int i = cl->startrecs;
 653     int to = cl->record_offset;
 654
 655     cl->record_offset = i;
 656     for (; i < to; i++)
 657         client_record_ingest(cl);
 658 }
 659
 660 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
 661 {
 662     struct session_database *sdb = client_get_database(cl);
 663
 664     WRBUF w = wrbuf_alloc();
 665
 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)
 672         {
 673             yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
 674         }
 675         else if (s->value && s->value[0])
 676         {
 677             wrbuf_puts(w, "@attr 1=");
 678             yaz_encode_pqf_term(w, s->value, strlen(s->value));
 679             if (s->next)
 680                 wrbuf_puts(w, ",");
 681         }
 682     }
 683     yaz_log(YLOG_LOG, "using facets str: %s", wrbuf_cstr(w));
 684     ZOOM_connection_option_set(link, "facets",
 685                                wrbuf_len(w) ? wrbuf_cstr(w) : 0);
 686     wrbuf_destroy(w);
 687 }
 688
 689 int client_has_facet(struct client *cl, const char *name)
 690 {
 691     struct session_database *sdb = client_get_database(cl);
 692     struct setting *s;
 693
 694     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
 695     {
 696         const char *p = strchr(s->name + 3, ':');
 697         if (p && !strcmp(name, p + 1))
 698             return 1;
 699     }
 700     return 0;
 701 }
 702
 703 void client_start_search(struct client *cl, const char *sort_strategy_and_spec,
 704                          int increasing)
 705 {
 706     struct session_database *sdb = client_get_database(cl);
 707     struct connection *co = client_get_connection(cl);
 708     ZOOM_connection link = connection_get_link(co);
 709     ZOOM_resultset rs;
 710     const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
 711     const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
 712     const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
 713     const char *opt_requestsyn  = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 714     const char *opt_maxrecs     = session_setting_oneval(sdb, PZ_MAXRECS);
 715     const char *opt_sru         = session_setting_oneval(sdb, PZ_SRU);
 716     const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
 717     const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
 718     const char *extra_args      = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
 719     char maxrecs_str[24], startrecs_str[24];
 720     ZOOM_query q;
 721
 722     assert(link);
 723
 724     cl->hits = 0;
 725     cl->record_offset = 0;
 726     cl->diagnostic = 0;
 727
 728     if (extra_args && *extra_args)
 729         ZOOM_connection_option_set(link, "extraArgs", extra_args);
 730
 731     if (opt_preferred) {
 732         cl->preferred = atoi(opt_preferred);
 733         if (cl->preferred)
 734             yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
 735                     client_get_id(cl), cl->preferred);
 736     }
 737     client_set_state(cl, Client_Working);
 738
 739     if (*opt_piggyback)
 740         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
 741     else
 742         ZOOM_connection_option_set(link, "piggyback", "1");
 743     if (*opt_queryenc)
 744         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
 745     if (*opt_sru && *opt_elements)
 746         ZOOM_connection_option_set(link, "schema", opt_elements);
 747     else if (*opt_elements)
 748         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
 749     if (*opt_requestsyn)
 750         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
 751
 752     if (opt_maxrecs && *opt_maxrecs)
 753     {
 754         cl->maxrecs = atoi(opt_maxrecs);
 755     }
 756
 757     /* convert back to string representation used in ZOOM API */
 758     sprintf(maxrecs_str, "%d", cl->maxrecs);
 759     ZOOM_connection_option_set(link, "count", maxrecs_str);
 760
 761     if (cl->maxrecs > 20)
 762         ZOOM_connection_option_set(link, "presentChunk", "20");
 763     else
 764         ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
 765
 766     sprintf(startrecs_str, "%d", cl->startrecs);
 767     ZOOM_connection_option_set(link, "start", startrecs_str);
 768
 769     /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
 770     /* facets definition is in PQF */
 771     client_set_facets_request(cl, link);
 772
 773     q = ZOOM_query_create();
 774     if (cl->cqlquery)
 775     {
 776         yaz_log(YLOG_LOG, "Search %s CQL: %s", client_get_id(cl),
 777                 cl->cqlquery);
 778         ZOOM_query_cql(q, cl->cqlquery);
 779         if (*opt_sort)
 780             ZOOM_query_sortby(q, opt_sort);
 781     }
 782     else
 783     {
 784         yaz_log(YLOG_LOG, "Search %s PQF: %s", client_get_id(cl), cl->pquery);
 785
 786         ZOOM_query_prefix(q, cl->pquery);
 787     }
 788     if (sort_strategy_and_spec &&
 789         strlen(sort_strategy_and_spec) < 40 /* spec below */)
 790     {
 791         char spec[50], *p;
 792         strcpy(spec, sort_strategy_and_spec);
 793         p = strchr(spec, ':');
 794         if (p)
 795         {
 796             *p++ = '\0'; /* cut the string in two */
 797             while (*p == ' ')
 798                 p++;
 799             if (increasing)
 800                 strcat(p, " <");
 801             else
 802                 strcat(p, " >");
 803             yaz_log(YLOG_LOG, "applying %s %s", spec, p);
 804             ZOOM_query_sortby2(q, spec, p);
 805         }
 806     }
 807     rs = ZOOM_connection_search(link, q);
 808     ZOOM_query_destroy(q);
 809     ZOOM_resultset_destroy(cl->resultset);
 810     cl->resultset = rs;
 811     connection_continue(co);
 812 }
 813
 814 struct client *client_create(const char *id)
 815 {
 816     struct client *cl = xmalloc(sizeof(*cl));
 817     cl->maxrecs = 100;
 818     cl->startrecs = 0;
 819     cl->pquery = 0;
 820     cl->cqlquery = 0;
 821     cl->database = 0;
 822     cl->connection = 0;
 823     cl->session = 0;
 824     cl->hits = 0;
 825     cl->record_offset = 0;
 826     cl->diagnostic = 0;
 827     cl->state = Client_Disconnected;
 828     cl->show_raw = 0;
 829     cl->resultset = 0;
 830     cl->suggestions = 0;
 831     cl->mutex = 0;
 832     pazpar2_mutex_create(&cl->mutex, "client");
 833     cl->preferred = 0;
 834     cl->ref_count = 1;
 835     cl->facet_limits = 0;
 836     assert(id);
 837     cl->id = xstrdup(id);
 838     client_use(1);
 839
 840     return cl;
 841 }
 842
 843 void client_lock(struct client *c)
 844 {
 845     yaz_mutex_enter(c->mutex);
 846 }
 847
 848 void client_unlock(struct client *c)
 849 {
 850     yaz_mutex_leave(c->mutex);
 851 }
 852
 853 void client_incref(struct client *c)
 854 {
 855     pazpar2_incref(&c->ref_count, c->mutex);
 856     yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
 857             c, client_get_id(c), c->ref_count);
 858 }
 859
 860 int client_destroy(struct client *c)
 861 {
 862     if (c)
 863     {
 864         yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
 865                 c, client_get_id(c), c->ref_count);
 866         if (!pazpar2_decref(&c->ref_count, c->mutex))
 867         {
 868             xfree(c->pquery);
 869             c->pquery = 0;
 870             xfree(c->cqlquery);
 871             c->cqlquery = 0;
 872             xfree(c->id);
 873             assert(!c->connection);
 874             facet_limits_destroy(c->facet_limits);
 875
 876             if (c->resultset)
 877             {
 878                 ZOOM_resultset_destroy(c->resultset);
 879             }
 880             yaz_mutex_destroy(&c->mutex);
 881             xfree(c);
 882             client_use(-1);
 883             return 1;
 884         }
 885     }
 886     return 0;
 887 }
 888
 889 void client_set_connection(struct client *cl, struct connection *con)
 890 {
 891     if (cl->resultset)
 892         ZOOM_resultset_release(cl->resultset);
 893     if (con)
 894     {
 895         assert(cl->connection == 0);
 896         cl->connection = con;
 897         client_incref(cl);
 898     }
 899     else
 900     {
 901         cl->connection = con;
 902         client_destroy(cl);
 903     }
 904 }
 905
 906 void client_disconnect(struct client *cl)
 907 {
 908     if (cl->state != Client_Idle)
 909         client_set_state(cl, Client_Disconnected);
 910     client_set_connection(cl, 0);
 911 }
 912
 913
 914 // Initialize CCL map for a target
 915 static CCL_bibset prepare_cclmap(struct client *cl)
 916 {
 917     struct session_database *sdb = client_get_database(cl);
 918     struct setting *s;
 919     CCL_bibset res;
 920
 921     if (!sdb->settings)
 922         return 0;
 923     res = ccl_qual_mk();
 924     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
 925     {
 926         char *p = strchr(s->name + 3, ':');
 927         if (!p)
 928         {
 929             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
 930             ccl_qual_rm(&res);
 931             return 0;
 932         }
 933         p++;
 934         ccl_qual_fitem(res, s->value, p);
 935     }
 936     return res;
 937 }
 938
 939 // returns a xmalloced CQL query corresponding to the pquery in client
 940 static char *make_cqlquery(struct client *cl)
 941 {
 942     cql_transform_t cqlt = cql_transform_create();
 943     Z_RPNQuery *zquery;
 944     char *r;
 945     WRBUF wrb = wrbuf_alloc();
 946     int status;
 947     ODR odr_out = odr_createmem(ODR_ENCODE);
 948
 949     zquery = p_query_rpn(odr_out, cl->pquery);
 950     yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
 951     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
 952     {
 953         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
 954         r = 0;
 955     }
 956     else
 957     {
 958         r = xstrdup(wrbuf_cstr(wrb));
 959     }
 960     wrbuf_destroy(wrb);
 961     odr_destroy(odr_out);
 962     cql_transform_close(cqlt);
 963     return r;
 964 }
 965
 966 // returns a xmalloced SOLR query corresponding to the pquery in client
 967 // TODO Could prob. be merge with the similar make_cqlquery
 968 static char *make_solrquery(struct client *cl)
 969 {
 970     solr_transform_t sqlt = solr_transform_create();
 971     Z_RPNQuery *zquery;
 972     char *r;
 973     WRBUF wrb = wrbuf_alloc();
 974     int status;
 975     ODR odr_out = odr_createmem(ODR_ENCODE);
 976
 977     zquery = p_query_rpn(odr_out, cl->pquery);
 978     if (zquery == 0) {
 979         yaz_log(YLOG_WARN, "Failed to generate RPN from PQF: %s", cl->pquery);
 980         return 0;
 981     }
 982     yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
 983     if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
 984     {
 985         yaz_log(YLOG_WARN, "Failed to generate SOLR query from PQF %s, code=%d", cl->pquery, status);
 986         r = 0;
 987     }
 988     else
 989     {
 990         r = xstrdup(wrbuf_cstr(wrb));
 991     }
 992     wrbuf_destroy(wrb);
 993     odr_destroy(odr_out);
 994     solr_transform_close(sqlt);
 995     return r;
 996 }
 997
 998 const char *client_get_facet_limit_local(struct client *cl,
 999                                          struct session_database *sdb,
1000                                          int *l,
1001                                          NMEM nmem, int *num, char ***values)
1002 {
1003     const char *name = 0;
1004     const char *value = 0;
1005     for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1006     {
1007         struct setting *s = 0;
1008
1009         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1010         {
1011             const char *p = strchr(s->name + 3, ':');
1012             if (p && !strcmp(p + 1, name) && s->value &&
1013                 !strncmp(s->value, "local:", 6))
1014             {
1015                 nmem_strsplit_escape2(nmem, "|", value, values,
1016                                       num, 1, '\\', 1);
1017                 (*l)++;
1018                 return name;
1019             }
1020         }
1021     }
1022     return 0;
1023 }
1024
1025 static int apply_limit(struct session_database *sdb,
1026                        facet_limits_t facet_limits,
1027                        WRBUF w_pqf, WRBUF w_ccl)
1028 {
1029     int ret = 0;
1030     int i = 0;
1031     const char *name;
1032     const char *value;
1033     NMEM nmem_tmp = nmem_create();
1034     for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1035     {
1036         struct setting *s = 0;
1037
1038         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1039         {
1040             const char *p = strchr(s->name + 3, ':');
1041             if (p && !strcmp(p + 1, name) && s->value)
1042             {
1043                 char **values = 0;
1044                 int i, num = 0;
1045                 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1046                                       &num, 1, '\\', 1);
1047
1048                 if (!strncmp(s->value, "rpn:", 4))
1049                 {
1050                     const char *pqf = s->value + 4;
1051
1052                     wrbuf_puts(w_pqf, "@and ");
1053                     wrbuf_puts(w_pqf, pqf);
1054                     wrbuf_puts(w_pqf, " ");
1055                     for (i = 0; i < num; i++)
1056                     {
1057                         if (i < num - 1)
1058                             wrbuf_puts(w_pqf, "@or ");
1059                         yaz_encode_pqf_term(w_pqf, values[i],
1060                                             strlen(values[i]));
1061                     }
1062                 }
1063                 else if (!strncmp(s->value, "ccl:", 4))
1064                 {
1065                     const char *ccl = s->value + 4;
1066
1067                     wrbuf_puts(w_ccl, " and (");
1068
1069                     for (i = 0; i < num; i++)
1070                     {
1071                         if (i)
1072                             wrbuf_puts(w_ccl, " or ");
1073                         wrbuf_puts(w_ccl, ccl);
1074                         wrbuf_puts(w_ccl, "=\"");
1075                         wrbuf_puts(w_ccl, values[i]);
1076                         wrbuf_puts(w_ccl, "\"");
1077                     }
1078                     wrbuf_puts(w_ccl, ")");
1079
1080                 }
1081                 else if (!strncmp(s->value, "local:", 6))
1082                     ;
1083                 else
1084                 {
1085                     yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1086                             sdb->database->id, s->value);
1087                     ret = -1; /* bad limitmap */
1088                 }
1089                 break;
1090             }
1091         }
1092         nmem_reset(nmem_tmp);
1093         if (!s)
1094         {
1095             yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1096                     (sdb->database ? sdb->database->id : "<no id>"), name);
1097         }
1098     }
1099     nmem_destroy(nmem_tmp);
1100     return ret;
1101 }
1102
1103 // Parse the query given the settings specific to this client
1104 int client_parse_query(struct client *cl, const char *query,
1105                        facet_limits_t facet_limits,
1106                        const char *startrecs, const char *maxrecs)
1107 {
1108     struct session *se = client_get_session(cl);
1109     struct session_database *sdb = client_get_database(cl);
1110     struct ccl_rpn_node *cn;
1111     int cerror, cpos;
1112     CCL_bibset ccl_map = prepare_cclmap(cl);
1113     const char *sru = session_setting_oneval(sdb, PZ_SRU);
1114     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1115     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1116     const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1117     WRBUF w_ccl, w_pqf;
1118     int ret_value = 1;
1119
1120     if (!ccl_map)
1121         return -1;
1122
1123
1124     if (maxrecs && atoi(maxrecs) != cl->maxrecs)
1125     {
1126         ret_value = 0;
1127         cl->maxrecs = atoi(maxrecs);
1128     }
1129
1130     if (startrecs && atoi(startrecs) != cl->startrecs)
1131     {
1132         ret_value = 0;
1133         cl->startrecs = atoi(startrecs);
1134     }
1135
1136     w_ccl = wrbuf_alloc();
1137     wrbuf_puts(w_ccl, query);
1138
1139     w_pqf = wrbuf_alloc();
1140     if (*pqf_prefix)
1141     {
1142         wrbuf_puts(w_pqf, pqf_prefix);
1143         wrbuf_puts(w_pqf, " ");
1144     }
1145
1146     if (apply_limit(sdb, facet_limits, w_pqf, w_ccl))
1147         return -2;
1148
1149     facet_limits_destroy(cl->facet_limits);
1150     cl->facet_limits = facet_limits_dup(facet_limits);
1151
1152     yaz_log(YLOG_LOG, "CCL query: %s", wrbuf_cstr(w_ccl));
1153     cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1154     ccl_qual_rm(&ccl_map);
1155     if (!cn)
1156     {
1157         client_set_state(cl, Client_Error);
1158         session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s",
1159                     wrbuf_cstr(w_ccl),
1160                     client_get_id(cl));
1161         wrbuf_destroy(w_ccl);
1162         wrbuf_destroy(w_pqf);
1163         return -1;
1164     }
1165     wrbuf_destroy(w_ccl);
1166
1167     if (!pqf_strftime || !*pqf_strftime)
1168         ccl_pquery(w_pqf, cn);
1169     else
1170     {
1171         time_t cur_time = time(0);
1172         struct tm *tm =  localtime(&cur_time);
1173         char tmp_str[300];
1174         const char *cp = tmp_str;
1175
1176         /* see man strftime(3) for things .. In particular %% gets converted
1177          to %.. And That's our original query .. */
1178         strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1179         for (; *cp; cp++)
1180         {
1181             if (cp[0] == '%')
1182                 ccl_pquery(w_pqf, cn);
1183             else
1184                 wrbuf_putc(w_pqf, cp[0]);
1185         }
1186     }
1187     if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1188     {
1189         xfree(cl->pquery);
1190         cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1191         ret_value = 0;
1192     }
1193     wrbuf_destroy(w_pqf);
1194
1195     yaz_log(YLOG_LOG, "PQF query: %s", cl->pquery);
1196
1197     xfree(cl->cqlquery);
1198
1199     /* Support for PQF on SRU targets. */
1200     /* TODO Refactor */
1201     yaz_log(YLOG_DEBUG, "Query syntax: %s", query_syntax);
1202     if (strcmp(query_syntax, "pqf") != 0 && *sru)
1203     {
1204         if (!strcmp(sru, "solr")) {
1205             if (!(cl->cqlquery = make_solrquery(cl)))
1206                 return -1;
1207         }
1208         else {
1209             if (!(cl->cqlquery = make_cqlquery(cl)))
1210                 return -1;
1211         }
1212     }
1213     else
1214         cl->cqlquery = 0;
1215
1216     /* TODO FIX Not thread safe */
1217     if (!se->relevance)
1218     {
1219         // Initialize relevance structure with query terms
1220         se->relevance = relevance_create_ccl(
1221             se->service->charsets, se->nmem, cn);
1222     }
1223
1224     ccl_rpn_delete(cn);
1225     return ret_value;
1226 }
1227
1228 void client_set_session(struct client *cl, struct session *se)
1229 {
1230     cl->session = se;
1231 }
1232
1233 int client_is_active(struct client *cl)
1234 {
1235     if (cl->connection && (cl->state == Client_Connecting ||
1236                            cl->state == Client_Working))
1237         return 1;
1238     return 0;
1239 }
1240
1241 int client_is_active_preferred(struct client *cl)
1242 {
1243     /* only count if this is a preferred target. */
1244     if (!cl->preferred)
1245         return 0;
1246     /* TODO No sure this the condition that Seb wants */
1247     if (cl->connection && (cl->state == Client_Connecting ||
1248                            cl->state == Client_Working))
1249         return 1;
1250     return 0;
1251 }
1252
1253 Odr_int client_get_hits(struct client *cl)
1254 {
1255     return cl->hits;
1256 }
1257
1258 int client_get_num_records(struct client *cl)
1259 {
1260     return cl->record_offset;
1261 }
1262
1263 void client_set_diagnostic(struct client *cl, int diagnostic)
1264 {
1265     cl->diagnostic = diagnostic;
1266 }
1267
1268 int client_get_diagnostic(struct client *cl)
1269 {
1270     return cl->diagnostic;
1271 }
1272
1273 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1274 {
1275     /* int idx; */
1276     struct suggestions *suggestions = cl->suggestions;
1277
1278     if (!suggestions) {
1279         //yaz_log(YLOG_DEBUG, "No suggestions found");
1280         return "";
1281     }
1282     if (suggestions->passthrough) {
1283         yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1284         return suggestions->passthrough;
1285     }
1286     if (suggestions->num == 0) {
1287         return "";
1288     }
1289     /*
1290     for (idx = 0; idx < suggestions->num; idx++) {
1291         wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1292         if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1293             wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1294             wrbuf_puts(wrbuf, "</suggest>\n");
1295         }
1296         else
1297             wrbuf_puts(wrbuf, "/>\n");
1298     }
1299     */
1300     return wrbuf_cstr(wrbuf);
1301 }
1302
1303
1304 void client_set_database(struct client *cl, struct session_database *db)
1305 {
1306     cl->database = db;
1307 }
1308
1309 const char *client_get_id(struct client *cl)
1310 {
1311     return cl->id;
1312 }
1313
1314 int client_get_maxrecs(struct client *cl)
1315 {
1316     return cl->maxrecs;
1317 }
1318
1319 void client_set_preferred(struct client *cl, int v)
1320 {
1321     cl->preferred = v;
1322 }
1323
1324
1325 struct suggestions* client_suggestions_create(const char* suggestions_string)
1326 {
1327     int i;
1328     NMEM nmem;
1329     struct suggestions *suggestions;
1330     if (suggestions_string == 0)
1331         return 0;
1332     nmem = nmem_create();
1333     suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1334     yaz_log(YLOG_DEBUG, "client target suggestions: %s", suggestions_string);
1335
1336     suggestions->nmem = nmem;
1337     suggestions->num = 0;
1338     suggestions->misspelled = 0;
1339     suggestions->suggest = 0;
1340     suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1341
1342     if (suggestions_string)
1343         nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1344                               &suggestions->num, 1, '\\', 0);
1345     /* Set up misspelled array */
1346     suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1347     /* replace = with \0 .. for each item */
1348     for (i = 0; i < suggestions->num; i++)
1349     {
1350         char *cp = strchr(suggestions->suggest[i], '=');
1351         if (cp) {
1352             *cp = '\0';
1353             suggestions->misspelled[i] = cp+1;
1354         }
1355     }
1356     return suggestions;
1357 }
1358
1359 static void client_suggestions_destroy(struct client *cl)
1360 {
1361     NMEM nmem = cl->suggestions->nmem;
1362     cl->suggestions = 0;
1363     nmem_destroy(nmem);
1364 }
1365
1366 /*
1367  * Local variables:
1368  * c-basic-offset: 4
1369  * c-file-style: "Stroustrup"
1370  * indent-tabs-mode: nil
1371  * End:
1372  * vim: shiftwidth=4 tabstop=8 expandtab
1373  */
1374