src/client.c

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