src/client.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2010 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 /* client counting (1) , disable client counting (0) */
  71 #if 1
  72 static YAZ_MUTEX g_mutex = 0;
  73 static int no_clients = 0;
  74
  75 static void client_use(int delta)
  76 {
  77     if (!g_mutex)
  78         yaz_mutex_create(&g_mutex);
  79     yaz_mutex_enter(g_mutex);
  80     no_clients += delta;
  81     yaz_mutex_leave(g_mutex);
  82     yaz_log(YLOG_DEBUG, "%s clients=%d", delta > 0 ? "INC" : "DEC", no_clients);
  83 }
  84 #else
  85 #define client_use(x)
  86 #endif
  87
  88 /** \brief Represents client state for a connection to one search target */
  89 struct client {
  90     struct session_database *database;
  91     struct connection *connection;
  92     struct session *session;
  93     char *pquery; // Current search
  94     char *cqlquery; // used for SRU targets only
  95     Odr_int hits;
  96     int record_offset;
  97     int maxrecs;
  98     int startrecs;
  99     int diagnostic;
 100     int preferred;
 101     enum client_state state;
 102     struct show_raw *show_raw;
 103     ZOOM_resultset resultset;
 104     YAZ_MUTEX mutex;
 105     int ref_count;
 106 };
 107
 108 struct show_raw {
 109     int active; // whether this request has been sent to the server
 110     int position;
 111     int binary;
 112     char *syntax;
 113     char *esn;
 114     void (*error_handler)(void *data, const char *addinfo);
 115     void (*record_handler)(void *data, const char *buf, size_t sz);
 116     void *data;
 117     struct show_raw *next;
 118 };
 119
 120 static const char *client_states[] = {
 121     "Client_Connecting",
 122     "Client_Idle",
 123     "Client_Working",
 124     "Client_Error",
 125     "Client_Failed",
 126     "Client_Disconnected"
 127 };
 128
 129 const char *client_get_state_str(struct client *cl)
 130 {
 131     return client_states[cl->state];
 132 }
 133
 134 enum client_state client_get_state(struct client *cl)
 135 {
 136     return cl->state;
 137 }
 138
 139 void client_set_state(struct client *cl, enum client_state st)
 140 {
 141     int was_active = 0;
 142     if (client_is_active(cl))
 143         was_active = 1;
 144     cl->state = st;
 145     /* If client is going from being active to inactive and all clients
 146        are now idle we fire a watch for the session . The assumption is
 147        that session is not mutex locked if client is already active */
 148     if (was_active && !client_is_active(cl) && cl->session)
 149     {
 150
 151         int no_active = session_active_clients(cl->session);
 152         yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d", client_get_url(cl), no_active);
 153         if (no_active == 0) {
 154             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
 155             session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
 156         }
 157     }
 158 }
 159
 160 static void client_show_raw_error(struct client *cl, const char *addinfo);
 161
 162 struct connection *client_get_connection(struct client *cl)
 163 {
 164     return cl->connection;
 165 }
 166
 167 struct session_database *client_get_database(struct client *cl)
 168 {
 169     return cl->database;
 170 }
 171
 172 struct session *client_get_session(struct client *cl)
 173 {
 174     return cl->session;
 175 }
 176
 177 const char *client_get_pquery(struct client *cl)
 178 {
 179     return cl->pquery;
 180 }
 181
 182 static void client_send_raw_present(struct client *cl);
 183 static int nativesyntax_to_type(struct session_database *sdb, char *type,
 184                                 ZOOM_record rec);
 185
 186 static void client_show_immediate(
 187     ZOOM_resultset resultset, struct session_database *sdb, int position,
 188     void *data,
 189     void (*error_handler)(void *data, const char *addinfo),
 190     void (*record_handler)(void *data, const char *buf, size_t sz),
 191     int binary)
 192 {
 193     ZOOM_record rec = 0;
 194     char type[80];
 195     const char *buf;
 196     int len;
 197
 198     if (!resultset)
 199     {
 200         error_handler(data, "no resultset");
 201         return;
 202     }
 203     rec = ZOOM_resultset_record(resultset, position-1);
 204     if (!rec)
 205     {
 206         error_handler(data, "no record");
 207         return;
 208     }
 209     if (binary)
 210         strcpy(type, "raw");
 211     else
 212         nativesyntax_to_type(sdb, type, rec);
 213     buf = ZOOM_record_get(rec, type, &len);
 214     if (!buf)
 215     {
 216         error_handler(data, "no record");
 217         return;
 218     }
 219     record_handler(data, buf, len);
 220 }
 221
 222
 223 int client_show_raw_begin(struct client *cl, int position,
 224                           const char *syntax, const char *esn,
 225                           void *data,
 226                           void (*error_handler)(void *data, const char *addinfo),
 227                           void (*record_handler)(void *data, const char *buf,
 228                                                  size_t sz),
 229                           int binary)
 230 {
 231     if (syntax == 0 && esn == 0)
 232         client_show_immediate(cl->resultset, client_get_database(cl),
 233                               position, data,
 234                               error_handler, record_handler,
 235                               binary);
 236     else
 237     {
 238         struct show_raw *rr, **rrp;
 239
 240         if (!cl->connection)
 241             return -1;
 242
 243
 244         rr = xmalloc(sizeof(*rr));
 245         rr->position = position;
 246         rr->active = 0;
 247         rr->data = data;
 248         rr->error_handler = error_handler;
 249         rr->record_handler = record_handler;
 250         rr->binary = binary;
 251         if (syntax)
 252             rr->syntax = xstrdup(syntax);
 253         else
 254             rr->syntax = 0;
 255         if (esn)
 256             rr->esn = xstrdup(esn);
 257         else
 258             rr->esn = 0;
 259         rr->next = 0;
 260
 261         for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
 262             ;
 263         *rrp = rr;
 264
 265         if (cl->state == Client_Failed)
 266         {
 267             client_show_raw_error(cl, "client failed");
 268         }
 269         else if (cl->state == Client_Disconnected)
 270         {
 271             client_show_raw_error(cl, "client disconnected");
 272         }
 273         else
 274         {
 275             client_send_raw_present(cl);
 276         }
 277     }
 278     return 0;
 279 }
 280
 281 static void client_show_raw_delete(struct show_raw *r)
 282 {
 283     xfree(r->syntax);
 284     xfree(r->esn);
 285     xfree(r);
 286 }
 287
 288 void client_show_raw_remove(struct client *cl, void *data)
 289 {
 290     struct show_raw *rr = data;
 291     struct show_raw **rrp = &cl->show_raw;
 292     while (*rrp != rr)
 293         rrp = &(*rrp)->next;
 294     if (*rrp)
 295     {
 296         *rrp = rr->next;
 297         client_show_raw_delete(rr);
 298     }
 299 }
 300
 301 void client_show_raw_dequeue(struct client *cl)
 302 {
 303     struct show_raw *rr = cl->show_raw;
 304
 305     cl->show_raw = rr->next;
 306     client_show_raw_delete(rr);
 307 }
 308
 309 static void client_show_raw_error(struct client *cl, const char *addinfo)
 310 {
 311     while (cl->show_raw)
 312     {
 313         cl->show_raw->error_handler(cl->show_raw->data, addinfo);
 314         client_show_raw_dequeue(cl);
 315     }
 316 }
 317
 318 static void client_send_raw_present(struct client *cl)
 319 {
 320     struct session_database *sdb = client_get_database(cl);
 321     struct connection *co = client_get_connection(cl);
 322     ZOOM_resultset set = cl->resultset;
 323
 324     int offset = cl->show_raw->position;
 325     const char *syntax = 0;
 326     const char *elements = 0;
 327
 328     assert(cl->show_raw);
 329     assert(set);
 330
 331     yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
 332             client_get_url(cl), 1, offset);
 333
 334     if (cl->show_raw->syntax)
 335         syntax = cl->show_raw->syntax;
 336     else
 337         syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 338     ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
 339
 340     if (cl->show_raw->esn)
 341         elements = cl->show_raw->esn;
 342     else
 343         elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 344     if (elements && *elements)
 345         ZOOM_resultset_option_set(set, "elementSetName", elements);
 346
 347     ZOOM_resultset_records(set, 0, offset-1, 1);
 348     cl->show_raw->active = 1;
 349
 350     connection_continue(co);
 351 }
 352
 353 static int nativesyntax_to_type(struct session_database *sdb, char *type,
 354                                 ZOOM_record rec)
 355 {
 356     const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
 357
 358     if (s && *s)
 359     {
 360         if (!strncmp(s, "iso2709", 7))
 361         {
 362             const char *cp = strchr(s, ';');
 363             yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
 364         }
 365         else if (!strncmp(s, "xml", 3))
 366         {
 367             strcpy(type, "xml");
 368         }
 369         else if (!strncmp(s, "txml", 4))
 370         {
 371             const char *cp = strchr(s, ';');
 372             yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
 373         }
 374         else
 375             return -1;
 376         return 0;
 377     }
 378     else  /* attempt to deduce structure */
 379     {
 380         const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
 381         if (syntax)
 382         {
 383             if (!strcmp(syntax, "XML"))
 384             {
 385                 strcpy(type, "xml");
 386                 return 0;
 387             }
 388             else if (!strcmp(syntax, "TXML"))
 389                 {
 390                     strcpy(type, "txml");
 391                     return 0;
 392                 }
 393             else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
 394             {
 395                 strcpy(type, "xml; charset=marc8-s");
 396                 return 0;
 397             }
 398             else return -1;
 399         }
 400         else return -1;
 401     }
 402 }
 403
 404 /**
 405  * TODO Consider thread safety!!!
 406  *
 407  */
 408 int client_report_facets(struct client *cl, ZOOM_resultset rs) {
 409     int facet_idx;
 410     ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
 411     int facet_num;
 412     struct session *se = client_get_session(cl);
 413     facet_num = ZOOM_resultset_facets_size(rs);
 414     yaz_log(YLOG_DEBUG, "client_report_facets: %d", facet_num);
 415
 416     for (facet_idx = 0; facet_idx < facet_num; facet_idx++) {
 417         const char *name = ZOOM_facet_field_name(facets[facet_idx]);
 418         size_t term_idx;
 419         size_t term_num = ZOOM_facet_field_term_count(facets[facet_idx]);
 420         for (term_idx = 0; term_idx < term_num; term_idx++ ) {
 421             int freq;
 422             const char *term = ZOOM_facet_field_get_term(facets[facet_idx], term_idx, &freq);
 423             if (term)
 424                 add_facet(se, name, term, freq);
 425         }
 426     }
 427
 428     return 0;
 429 }
 430
 431 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
 432 {
 433     const char *buf;
 434     int len;
 435     char type[80];
 436
 437     if (cl->show_raw->binary)
 438         strcpy(type, "raw");
 439     else
 440     {
 441         struct session_database *sdb = client_get_database(cl);
 442         nativesyntax_to_type(sdb, type, rec);
 443     }
 444
 445     buf = ZOOM_record_get(rec, type, &len);
 446     cl->show_raw->record_handler(cl->show_raw->data,  buf, len);
 447     client_show_raw_dequeue(cl);
 448 }
 449
 450 void client_check_preferred_watch(struct client *cl)
 451 {
 452     struct session *se = cl->session;
 453     yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_url(cl));
 454     if (se)
 455     {
 456         client_unlock(cl);
 457         if (session_is_preferred_clients_ready(se)) {
 458             session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
 459         }
 460         else
 461             yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
 462
 463         client_lock(cl);
 464     }
 465     else
 466         yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_url(cl));
 467
 468 }
 469
 470 void client_search_response(struct client *cl)
 471 {
 472     struct connection *co = cl->connection;
 473     struct session *se = cl->session;
 474     ZOOM_connection link = connection_get_link(co);
 475     ZOOM_resultset resultset = cl->resultset;
 476
 477     const char *error, *addinfo = 0;
 478
 479     if (ZOOM_connection_error(link, &error, &addinfo))
 480     {
 481         cl->hits = 0;
 482         client_set_state(cl, Client_Error);
 483         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 484                 error, addinfo, client_get_url(cl));
 485     }
 486     else
 487     {
 488         client_report_facets(cl, resultset);
 489         cl->record_offset = cl->startrecs;
 490         cl->hits = ZOOM_resultset_size(resultset);
 491         if (se)
 492             se->total_hits += cl->hits;
 493     }
 494 }
 495
 496 void client_got_records(struct client *cl)
 497 {
 498     struct session *se = cl->session;
 499     if (se)
 500     {
 501         client_unlock(cl);
 502         session_alert_watch(se, SESSION_WATCH_SHOW);
 503         session_alert_watch(se, SESSION_WATCH_RECORD);
 504         client_lock(cl);
 505     }
 506 }
 507
 508 void client_record_response(struct client *cl)
 509 {
 510     struct connection *co = cl->connection;
 511     ZOOM_connection link = connection_get_link(co);
 512     ZOOM_resultset resultset = cl->resultset;
 513     const char *error, *addinfo;
 514
 515     if (ZOOM_connection_error(link, &error, &addinfo))
 516     {
 517         client_set_state(cl, Client_Error);
 518         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 519             error, addinfo, client_get_url(cl));
 520     }
 521     else
 522     {
 523         ZOOM_record rec = 0;
 524         const char *msg, *addinfo;
 525
 526         if (cl->show_raw && cl->show_raw->active)
 527         {
 528             if ((rec = ZOOM_resultset_record(resultset,
 529                                              cl->show_raw->position-1)))
 530             {
 531                 cl->show_raw->active = 0;
 532                 ingest_raw_record(cl, rec);
 533             }
 534             else
 535             {
 536                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 537                         cl->show_raw->position-1);
 538             }
 539         }
 540         else
 541         {
 542             int offset = cl->record_offset;
 543             if ((rec = ZOOM_resultset_record(resultset, offset)))
 544             {
 545                 cl->record_offset++;
 546                 if (cl->session == 0)
 547                     ;
 548                 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
 549                 {
 550                     yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
 551                             msg, addinfo, client_get_url(cl),
 552                             cl->record_offset);
 553                 }
 554                 else
 555                 {
 556                     struct session_database *sdb = client_get_database(cl);
 557                     NMEM nmem = nmem_create();
 558                     const char *xmlrec;
 559                     char type[80];
 560
 561                     if (nativesyntax_to_type(sdb, type, rec))
 562                         yaz_log(YLOG_WARN, "Failed to determine record type");
 563                     xmlrec = ZOOM_record_get(rec, type, NULL);
 564                     if (!xmlrec)
 565                         yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
 566                                 client_get_url(cl));
 567                     else
 568                     {
 569                         if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
 570                             yaz_log(YLOG_WARN, "Failed to ingest from %s",
 571                                     client_get_url(cl));
 572                     }
 573                     nmem_destroy(nmem);
 574                 }
 575             }
 576             else
 577             {
 578                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 579                         offset);
 580             }
 581         }
 582     }
 583 }
 584
 585 static int client_set_facets_request(struct client *cl, ZOOM_connection link)
 586 {
 587     struct session_database *sdb = client_get_database(cl);
 588     const char *opt_facet_term_sort  = session_setting_oneval(sdb, PZ_TERMLIST_TERM_SORT);
 589     const char *opt_facet_term_count = session_setting_oneval(sdb, PZ_TERMLIST_TERM_COUNT);
 590     /* Disable when no count is set */
 591     /* TODO Verify: Do we need to reset the  ZOOM facets if a ZOOM Connection is being reused??? */
 592     if (opt_facet_term_count && *opt_facet_term_count)
 593     {
 594         int index = 0;
 595         struct session *session = client_get_session(cl);
 596         struct conf_service *service = session->service;
 597         int num = service->num_metadata;
 598         WRBUF wrbuf = wrbuf_alloc();
 599         yaz_log(YLOG_DEBUG, "Facet settings, sort: %s count: %s",
 600                 opt_facet_term_sort, opt_facet_term_count);
 601         for (index = 0; index < num; index++)
 602         {
 603             struct conf_metadata *conf_meta = &service->metadata[index];
 604             if (conf_meta->termlist)
 605             {
 606                 if (wrbuf_len(wrbuf))
 607                     wrbuf_puts(wrbuf, ", ");
 608                 wrbuf_printf(wrbuf, "@attr 1=%s", conf_meta->name);
 609
 610                 if (opt_facet_term_sort && *opt_facet_term_sort)
 611                     wrbuf_printf(wrbuf, " @attr 2=%s", opt_facet_term_sort);
 612                 wrbuf_printf(wrbuf, " @attr 3=%s", opt_facet_term_count);
 613             }
 614         }
 615         if (wrbuf_len(wrbuf))
 616         {
 617             yaz_log(YLOG_LOG, "Setting ZOOM facets option: %s", wrbuf_cstr(wrbuf));
 618             ZOOM_connection_option_set(link, "facets", wrbuf_cstr(wrbuf));
 619             return 1;
 620         }
 621     }
 622     return 0;
 623 }
 624
 625 int client_has_facet(struct client *cl, const char *name) {
 626     ZOOM_facet_field facet_field;
 627     if (!cl || !cl->resultset || !name) {
 628         yaz_log(YLOG_DEBUG, "client has facet: Missing %p %p %s", cl, (cl ? cl->resultset: 0), name);
 629         return 0;
 630     }
 631     facet_field = ZOOM_resultset_get_facet_field(cl->resultset, name);
 632     if (facet_field) {
 633         yaz_log(YLOG_DEBUG, "client: has facets for %s", name);
 634         return 1;
 635     }
 636     yaz_log(YLOG_DEBUG, "client: No facets for %s", name);
 637     return 0;
 638 }
 639
 640
 641 void client_start_search(struct client *cl)
 642 {
 643     struct session_database *sdb = client_get_database(cl);
 644     struct connection *co = client_get_connection(cl);
 645     ZOOM_connection link = connection_get_link(co);
 646     ZOOM_resultset rs;
 647     char *databaseName = sdb->database->databases[0];
 648     const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
 649     const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
 650     const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
 651     const char *opt_requestsyn  = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 652     const char *opt_maxrecs     = session_setting_oneval(sdb, PZ_MAXRECS);
 653     const char *opt_sru         = session_setting_oneval(sdb, PZ_SRU);
 654     const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
 655     const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
 656     char maxrecs_str[24], startrecs_str[24];
 657
 658     assert(link);
 659
 660     cl->hits = -1;
 661     cl->record_offset = 0;
 662     cl->diagnostic = 0;
 663
 664     if (opt_preferred) {
 665         cl->preferred = atoi(opt_preferred);
 666         if (cl->preferred)
 667             yaz_log(YLOG_LOG, "Target %s has preferred status: %d", sdb->database->url, cl->preferred);
 668     }
 669     client_set_state(cl, Client_Working);
 670
 671     if (*opt_piggyback)
 672         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
 673     else
 674         ZOOM_connection_option_set(link, "piggyback", "1");
 675     if (*opt_queryenc)
 676         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
 677     if (*opt_sru && *opt_elements)
 678         ZOOM_connection_option_set(link, "schema", opt_elements);
 679     else if (*opt_elements)
 680         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
 681     if (*opt_requestsyn)
 682         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
 683
 684     if (!*opt_maxrecs)
 685     {
 686         sprintf(maxrecs_str, "%d", cl->maxrecs);
 687         opt_maxrecs = maxrecs_str;
 688     }
 689     ZOOM_connection_option_set(link, "count", opt_maxrecs);
 690
 691
 692     if (atoi(opt_maxrecs) > 20)
 693         ZOOM_connection_option_set(link, "presentChunk", "20");
 694     else
 695         ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
 696
 697     sprintf(startrecs_str, "%d", cl->startrecs);
 698     ZOOM_connection_option_set(link, "start", startrecs_str);
 699
 700     if (databaseName)
 701         ZOOM_connection_option_set(link, "databaseName", databaseName);
 702
 703     /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
 704     /* facets definition is in PQF */
 705     client_set_facets_request(cl, link);
 706
 707     if (cl->cqlquery)
 708     {
 709         ZOOM_query q = ZOOM_query_create();
 710         yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
 711         ZOOM_query_cql(q, cl->cqlquery);
 712         if (*opt_sort)
 713             ZOOM_query_sortby(q, opt_sort);
 714         rs = ZOOM_connection_search(link, q);
 715         ZOOM_query_destroy(q);
 716     }
 717     else
 718     {
 719         yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
 720         rs = ZOOM_connection_search_pqf(link, cl->pquery);
 721     }
 722     ZOOM_resultset_destroy(cl->resultset);
 723     cl->resultset = rs;
 724     connection_continue(co);
 725 }
 726
 727 struct client *client_create(void)
 728 {
 729     struct client *r = xmalloc(sizeof(*r));
 730     r->maxrecs = 100;
 731     r->startrecs = 0;
 732     r->pquery = 0;
 733     r->cqlquery = 0;
 734     r->database = 0;
 735     r->connection = 0;
 736     r->session = 0;
 737     r->hits = 0;
 738     r->record_offset = 0;
 739     r->diagnostic = 0;
 740     r->state = Client_Disconnected;
 741     r->show_raw = 0;
 742     r->resultset = 0;
 743     r->mutex = 0;
 744     pazpar2_mutex_create(&r->mutex, "client");
 745     r->preferred = 0;
 746     r->ref_count = 1;
 747     client_use(1);
 748
 749     return r;
 750 }
 751
 752 void client_lock(struct client *c)
 753 {
 754     yaz_mutex_enter(c->mutex);
 755 }
 756
 757 void client_unlock(struct client *c)
 758 {
 759     yaz_mutex_leave(c->mutex);
 760 }
 761
 762 void client_incref(struct client *c)
 763 {
 764     pazpar2_incref(&c->ref_count, c->mutex);
 765     yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
 766             c, client_get_url(c), c->ref_count);
 767 }
 768
 769 int client_destroy(struct client *c)
 770 {
 771     if (c)
 772     {
 773         yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
 774                 c, client_get_url(c), c->ref_count);
 775         if (!pazpar2_decref(&c->ref_count, c->mutex))
 776         {
 777             xfree(c->pquery);
 778             c->pquery = 0;
 779             xfree(c->cqlquery);
 780             c->cqlquery = 0;
 781             assert(!c->connection);
 782
 783             if (c->resultset)
 784             {
 785                 ZOOM_resultset_destroy(c->resultset);
 786             }
 787             yaz_mutex_destroy(&c->mutex);
 788             xfree(c);
 789             client_use(-1);
 790             return 1;
 791         }
 792     }
 793     return 0;
 794 }
 795
 796 void client_set_connection(struct client *cl, struct connection *con)
 797 {
 798     if (cl->resultset)
 799         ZOOM_resultset_release(cl->resultset);
 800     if (con)
 801     {
 802         assert(cl->connection == 0);
 803         cl->connection = con;
 804         client_incref(cl);
 805     }
 806     else
 807     {
 808         cl->connection = con;
 809         client_destroy(cl);
 810     }
 811 }
 812
 813 void client_disconnect(struct client *cl)
 814 {
 815     if (cl->state != Client_Idle)
 816         client_set_state(cl, Client_Disconnected);
 817     client_set_connection(cl, 0);
 818 }
 819
 820 // Extract terms from query into null-terminated termlist
 821 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
 822 {
 823     int num = 0;
 824
 825     pull_terms(nmem, query, termlist, &num);
 826     termlist[num] = 0;
 827 }
 828
 829 // Initialize CCL map for a target
 830 static CCL_bibset prepare_cclmap(struct client *cl)
 831 {
 832     struct session_database *sdb = client_get_database(cl);
 833     struct setting *s;
 834     CCL_bibset res;
 835
 836     if (!sdb->settings)
 837         return 0;
 838     res = ccl_qual_mk();
 839     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
 840     {
 841         char *p = strchr(s->name + 3, ':');
 842         if (!p)
 843         {
 844             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
 845             ccl_qual_rm(&res);
 846             return 0;
 847         }
 848         p++;
 849         ccl_qual_fitem(res, s->value, p);
 850     }
 851     return res;
 852 }
 853
 854 // returns a xmalloced CQL query corresponding to the pquery in client
 855 static char *make_cqlquery(struct client *cl)
 856 {
 857     cql_transform_t cqlt = cql_transform_create();
 858     Z_RPNQuery *zquery;
 859     char *r;
 860     WRBUF wrb = wrbuf_alloc();
 861     int status;
 862     ODR odr_out = odr_createmem(ODR_ENCODE);
 863
 864     zquery = p_query_rpn(odr_out, cl->pquery);
 865     yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
 866     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
 867     {
 868         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
 869         r = 0;
 870     }
 871     else
 872     {
 873         r = xstrdup(wrbuf_cstr(wrb));
 874     }
 875     wrbuf_destroy(wrb);
 876     odr_destroy(odr_out);
 877     cql_transform_close(cqlt);
 878     return r;
 879 }
 880
 881 // returns a xmalloced SOLR query corresponding to the pquery in client
 882 // TODO Could prob. be merge with the similar make_cqlquery
 883 static char *make_solrquery(struct client *cl)
 884 {
 885     solr_transform_t sqlt = solr_transform_create();
 886     Z_RPNQuery *zquery;
 887     char *r;
 888     WRBUF wrb = wrbuf_alloc();
 889     int status;
 890     ODR odr_out = odr_createmem(ODR_ENCODE);
 891
 892     zquery = p_query_rpn(odr_out, cl->pquery);
 893     yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
 894     if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
 895     {
 896         yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
 897         r = 0;
 898     }
 899     else
 900     {
 901         r = xstrdup(wrbuf_cstr(wrb));
 902     }
 903     wrbuf_destroy(wrb);
 904     odr_destroy(odr_out);
 905     solr_transform_close(sqlt);
 906     return r;
 907 }
 908
 909 // Parse the query given the settings specific to this client
 910 int client_parse_query(struct client *cl, const char *query)
 911 {
 912     struct session *se = client_get_session(cl);
 913     struct session_database *sdb = client_get_database(cl);
 914     struct ccl_rpn_node *cn;
 915     int cerror, cpos;
 916     CCL_bibset ccl_map = prepare_cclmap(cl);
 917     const char *sru = session_setting_oneval(sdb, PZ_SRU);
 918     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
 919     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
 920
 921     if (!ccl_map)
 922         return -1;
 923
 924     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
 925     ccl_qual_rm(&ccl_map);
 926     if (!cn)
 927     {
 928         client_set_state(cl, Client_Error);
 929         yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
 930                 query,
 931                 client_get_database(cl)->database->url);
 932         return -1;
 933     }
 934     wrbuf_rewind(se->wrbuf);
 935     if (*pqf_prefix)
 936     {
 937         wrbuf_puts(se->wrbuf, pqf_prefix);
 938         wrbuf_puts(se->wrbuf, " ");
 939     }
 940     if (!pqf_strftime || !*pqf_strftime)
 941         ccl_pquery(se->wrbuf, cn);
 942     else
 943     {
 944         time_t cur_time = time(0);
 945         struct tm *tm =  localtime(&cur_time);
 946         char tmp_str[300];
 947         const char *cp = tmp_str;
 948
 949         /* see man strftime(3) for things .. In particular %% gets converted
 950          to %.. And That's our original query .. */
 951         strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
 952         for (; *cp; cp++)
 953         {
 954             if (cp[0] == '%')
 955                 ccl_pquery(se->wrbuf, cn);
 956             else
 957                 wrbuf_putc(se->wrbuf, cp[0]);
 958         }
 959     }
 960     xfree(cl->pquery);
 961     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
 962
 963     xfree(cl->cqlquery);
 964     if (*sru)
 965     {
 966         if (!strcmp(sru, "solr")) {
 967             if (!(cl->cqlquery = make_solrquery(cl)))
 968                 return -1;
 969         }
 970         else {
 971             if (!(cl->cqlquery = make_cqlquery(cl)))
 972                 return -1;
 973         }
 974     }
 975     else
 976         cl->cqlquery = 0;
 977
 978     /* TODO FIX Not thread safe */
 979     if (!se->relevance)
 980     {
 981         // Initialize relevance structure with query terms
 982         char *p[512];
 983         extract_terms(se->nmem, cn, p);
 984         se->relevance = relevance_create(
 985             se->service->relevance_pct,
 986             se->nmem, (const char **) p);
 987     }
 988
 989     ccl_rpn_delete(cn);
 990     return 0;
 991 }
 992
 993 void client_set_session(struct client *cl, struct session *se)
 994 {
 995     cl->session = se;
 996 }
 997
 998 int client_is_active(struct client *cl)
 999 {
1000     if (cl->connection && (cl->state == Client_Connecting ||
1001                            cl->state == Client_Working))
1002         return 1;
1003     return 0;
1004 }
1005
1006 int client_is_active_preferred(struct client *cl)
1007 {
1008     /* only count if this is a preferred target. */
1009     if (!cl->preferred)
1010         return 0;
1011     /* TODO No sure this the condition that Seb wants */
1012     if (cl->connection && (cl->state == Client_Connecting ||
1013                            cl->state == Client_Working))
1014         return 1;
1015     return 0;
1016 }
1017
1018
1019 Odr_int client_get_hits(struct client *cl)
1020 {
1021     return cl->hits;
1022 }
1023
1024 int client_get_num_records(struct client *cl)
1025 {
1026     return cl->record_offset;
1027 }
1028
1029 void client_set_diagnostic(struct client *cl, int diagnostic)
1030 {
1031     cl->diagnostic = diagnostic;
1032 }
1033
1034 int client_get_diagnostic(struct client *cl)
1035 {
1036     return cl->diagnostic;
1037 }
1038
1039 void client_set_database(struct client *cl, struct session_database *db)
1040 {
1041     cl->database = db;
1042 }
1043
1044 struct host *client_get_host(struct client *cl)
1045 {
1046     return client_get_database(cl)->database->host;
1047 }
1048
1049 const char *client_get_url(struct client *cl)
1050 {
1051     if (cl->database)
1052         return client_get_database(cl)->database->url;
1053     else
1054         return "NOURL";
1055 }
1056
1057 void client_set_maxrecs(struct client *cl, int v)
1058 {
1059     cl->maxrecs = v;
1060 }
1061
1062 void client_set_startrecs(struct client *cl, int v)
1063 {
1064     cl->startrecs = v;
1065 }
1066
1067 void client_set_preferred(struct client *cl, int v)
1068 {
1069     cl->preferred = v;
1070 }
1071
1072
1073 /*
1074  * Local variables:
1075  * c-basic-offset: 4
1076  * c-file-style: "Stroustrup"
1077  * indent-tabs-mode: nil
1078  * End:
1079  * vim: shiftwidth=4 tabstop=8 expandtab
1080  */
1081