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