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