9f86ce63859123a3247145ab3fabedb7e394ba0a
[pazpar2-moved-to-github.git] / 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, "txml", 4))
416         {
417             const char *cp = strchr(s, ';');
418             yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
419         }
420         else /* pass verbatim to ZOOM - including "xml" */
421             strcpy(type, s);
422         return 0;
423     }
424     else  /* attempt to deduce structure */
425     {
426         const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
427         if (syntax)
428         {
429             if (!strcmp(syntax, "XML"))
430             {
431                 strcpy(type, "xml");
432                 return 0;
433             }
434             else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
435             {
436                 strcpy(type, "xml; charset=marc8-s");
437                 return 0;
438             }
439             else return -1;
440         }
441         else return -1;
442     }
443 }
444
445 /**
446  * TODO Consider thread safety!!!
447  *
448  */
449 void client_report_facets(struct client *cl, ZOOM_resultset rs)
450 {
451     struct session_database *sdb = client_get_database(cl);
452     ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
453
454     if (sdb && facets)
455     {
456         struct session *se = client_get_session(cl);
457         int facet_num = ZOOM_resultset_facets_size(rs);
458         struct setting *s;
459
460         for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
461         {
462             const char *p = strchr(s->name + 3, ':');
463             if (p && p[1] && s->value && s->value[0])
464             {
465                 int facet_idx;
466                 p++; /* p now holds logical facet name */
467                 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
468                 {
469                     const char *native_name =
470                         ZOOM_facet_field_name(facets[facet_idx]);
471                     if (native_name && !strcmp(s->value, native_name))
472                     {
473                         size_t term_idx;
474                         size_t term_num =
475                             ZOOM_facet_field_term_count(facets[facet_idx]);
476                         for (term_idx = 0; term_idx < term_num; term_idx++ )
477                         {
478                             int freq;
479                             const char *term =
480                                 ZOOM_facet_field_get_term(facets[facet_idx],
481                                                           term_idx, &freq);
482                             if (term)
483                                 add_facet(se, p, term, freq);
484                         }
485                         break;
486                     }
487                 }
488             }
489         }
490     }
491 }
492
493 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
494 {
495     const char *buf;
496     int len;
497     char type[80];
498
499     nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
500     buf = ZOOM_record_get(rec, type, &len);
501     cl->show_raw->record_handler(cl->show_raw->data,  buf, len);
502     client_show_raw_dequeue(cl);
503 }
504
505 void client_check_preferred_watch(struct client *cl)
506 {
507     struct session *se = cl->session;
508     yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
509     if (se)
510     {
511         client_unlock(cl);
512         /* TODO possible threading issue. Session can have been destroyed */
513         if (session_is_preferred_clients_ready(se)) {
514             session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
515         }
516         else
517             yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
518
519         client_lock(cl);
520     }
521     else
522         yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
523
524 }
525
526 struct suggestions* client_suggestions_create(const char* suggestions_string);
527 static void client_suggestions_destroy(struct client *cl);
528
529 void client_search_response(struct client *cl)
530 {
531     struct connection *co = cl->connection;
532     ZOOM_connection link = connection_get_link(co);
533     ZOOM_resultset resultset = cl->resultset;
534
535     const char *error, *addinfo = 0;
536     
537     if (ZOOM_connection_error(link, &error, &addinfo))
538     {
539         cl->hits = 0;
540         client_set_state(cl, Client_Error);
541         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
542                 error, addinfo, client_get_id(cl));
543     }
544     else
545     {
546         client_report_facets(cl, resultset);
547         cl->record_offset = cl->startrecs;
548         cl->hits = ZOOM_resultset_size(resultset);
549         yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, cl->hits);
550         if (cl->suggestions)
551             client_suggestions_destroy(cl);
552         cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
553     }
554 }
555
556 void client_got_records(struct client *cl)
557 {
558     struct session *se = cl->session;
559     if (se)
560     {
561         if (reclist_get_num_records(se->reclist) > 0)
562         {
563             client_unlock(cl);
564             session_alert_watch(se, SESSION_WATCH_SHOW);
565             session_alert_watch(se, SESSION_WATCH_BYTARGET);
566             session_alert_watch(se, SESSION_WATCH_TERMLIST);
567             session_alert_watch(se, SESSION_WATCH_RECORD);
568             client_lock(cl);
569         }
570     }
571 }
572
573 static void client_record_ingest(struct client *cl)
574 {
575     const char *msg, *addinfo;
576     ZOOM_record rec = 0;
577     ZOOM_resultset resultset = cl->resultset;
578     int offset = cl->record_offset;
579     if ((rec = ZOOM_resultset_record_immediate(resultset, offset)))
580     {
581         cl->record_offset++;
582         if (cl->session == 0) {
583             /* no operation */
584         }
585         else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
586         {
587             yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
588                     msg, addinfo, client_get_id(cl), cl->record_offset);
589         }
590         else
591         {
592             struct session_database *sdb = client_get_database(cl);
593             NMEM nmem = nmem_create();
594             const char *xmlrec;
595             char type[80];
596             
597             const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
598             if (nativesyntax_to_type(s, type, rec))
599                 yaz_log(YLOG_WARN, "Failed to determine record type");
600             xmlrec = ZOOM_record_get(rec, type, NULL);
601             if (!xmlrec)
602                 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
603                         client_get_id(cl));
604             else
605             {
606                 /* OK = 0, -1 = failure, -2 = Filtered */
607                 int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem);
608                 if (rc == -1)
609                     yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
610                 if (rc == -2)
611                     cl->filtered += 1;
612             }
613             nmem_destroy(nmem);
614         }
615     }
616     else
617     {
618         yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
619                 offset);
620     }
621 }
622
623 void client_record_response(struct client *cl)
624 {
625     struct connection *co = cl->connection;
626     ZOOM_connection link = connection_get_link(co);
627     ZOOM_resultset resultset = cl->resultset;
628     const char *error, *addinfo;
629
630     if (ZOOM_connection_error(link, &error, &addinfo))
631     {
632         client_set_state(cl, Client_Error);
633         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
634             error, addinfo, client_get_id(cl));
635     }
636     else
637     {
638         if (cl->show_raw && cl->show_raw->active)
639         {
640             ZOOM_record rec = 0;
641             if ((rec = ZOOM_resultset_record_immediate(
642                      resultset, cl->show_raw->position-1)))
643             {
644                 cl->show_raw->active = 0;
645                 ingest_raw_record(cl, rec);
646             }
647             else
648             {
649                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
650                         cl->show_raw->position-1);
651             }
652         }
653         else
654         {
655             client_record_ingest(cl);
656         }
657     }
658 }
659
660 void client_reingest(struct client *cl)
661 {
662     int i = cl->startrecs;
663     int to = cl->record_offset;
664     cl->filtered = 0;
665
666     cl->record_offset = i;
667     for (; i < to; i++)
668         client_record_ingest(cl);
669 }
670
671 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
672 {
673     struct session_database *sdb = client_get_database(cl);
674
675     WRBUF w = wrbuf_alloc();
676     
677     struct setting *s;
678
679     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
680     {
681         const char *p = strchr(s->name + 3, ':');
682         if (!p)
683         {
684             yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
685         }
686         else if (s->value && s->value[0])
687         {
688             wrbuf_puts(w, "@attr 1=");
689             yaz_encode_pqf_term(w, s->value, strlen(s->value));
690             if (s->next)
691                 wrbuf_puts(w, ",");
692         }
693     }
694     yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
695     ZOOM_connection_option_set(link, "facets",
696                                wrbuf_len(w) ? wrbuf_cstr(w) : 0);
697     wrbuf_destroy(w);
698 }
699
700 int client_has_facet(struct client *cl, const char *name)
701 {
702     struct session_database *sdb = client_get_database(cl);
703     struct setting *s;
704
705     for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
706     {
707         const char *p = strchr(s->name + 3, ':');
708         if (p && !strcmp(name, p + 1))
709             return 1;
710     }
711     return 0;
712 }
713
714 static const char *get_strategy_plus_sort(struct client *l, const char *field)
715 {
716     struct session_database *sdb = client_get_database(l);
717     struct setting *s;
718
719     const char *strategy_plus_sort = 0;
720     
721     for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
722     {
723         char *p = strchr(s->name + 3, ':');
724         if (!p)
725         {
726             yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
727             continue;
728         }
729         p++;
730         if (!strcmp(p, field))
731         {
732             strategy_plus_sort = s->value;
733             break;
734         }
735     }
736     return strategy_plus_sort;
737 }
738
739 void client_start_search(struct client *cl)
740 {
741     struct session_database *sdb = client_get_database(cl);
742     struct connection *co = client_get_connection(cl);
743     ZOOM_connection link = connection_get_link(co);
744     struct session *se = client_get_session(cl);
745     ZOOM_resultset rs;
746     const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
747     const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
748     const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
749     const char *opt_requestsyn  = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
750     const char *opt_maxrecs     = session_setting_oneval(sdb, PZ_MAXRECS);
751     const char *opt_sru         = session_setting_oneval(sdb, PZ_SRU);
752     const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
753     const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
754     const char *extra_args      = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
755     const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
756     ZOOM_query q;
757     char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
758     int present_chunk = 20; // Default chunk size
759     if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
760         present_chunk = atoi(opt_present_chunk);
761         yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
762     }
763     assert(link);
764
765     cl->diagnostic = 0;
766     cl->filtered = 0;
767
768     if (extra_args && *extra_args)
769         ZOOM_connection_option_set(link, "extraArgs", extra_args);
770
771     if (opt_preferred) {
772         cl->preferred = atoi(opt_preferred);
773         if (cl->preferred)
774             yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
775                     client_get_id(cl), cl->preferred);
776     }
777
778     if (*opt_piggyback)
779         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
780     else
781         ZOOM_connection_option_set(link, "piggyback", "1");
782     if (*opt_queryenc)
783         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
784     if (*opt_sru && *opt_elements)
785         ZOOM_connection_option_set(link, "schema", opt_elements);
786     else if (*opt_elements)
787         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
788     if (*opt_requestsyn)
789         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
790
791     if (opt_maxrecs && *opt_maxrecs)
792     {
793         cl->maxrecs = atoi(opt_maxrecs);
794     }
795
796     /* convert back to string representation used in ZOOM API */
797     sprintf(maxrecs_str, "%d", cl->maxrecs);
798     ZOOM_connection_option_set(link, "count", maxrecs_str);
799
800     /* A present_chunk less than 1 will disable chunking. */
801     if (present_chunk > 0 && cl->maxrecs > present_chunk) {
802         sprintf(present_chunk_str, "%d", present_chunk);
803         ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
804         yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
805     }
806     else {
807         ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
808         yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
809     }
810     sprintf(startrecs_str, "%d", cl->startrecs);
811     ZOOM_connection_option_set(link, "start", startrecs_str);
812
813     /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
814     /* facets definition is in PQF */
815     client_set_facets_request(cl, link);
816
817     q = ZOOM_query_create();
818     if (cl->cqlquery)
819     {
820         yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl), cl->cqlquery);
821         ZOOM_query_cql(q, cl->cqlquery);
822         if (*opt_sort)
823             ZOOM_query_sortby(q, opt_sort);
824     }
825     else
826     {
827         yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), cl->pquery);
828         
829         ZOOM_query_prefix(q, cl->pquery);
830     }
831     if (se->sorted_results)
832     {   /* first entry is current sorting ! */
833         const char *sort_strategy_and_spec =
834             get_strategy_plus_sort(cl, se->sorted_results->field);
835         int increasing = se->sorted_results->increasing;
836         int position = se->sorted_results->position;
837         if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
838         {
839             char spec[50], *p;
840             strcpy(spec, sort_strategy_and_spec);
841             p = strchr(spec, ':');
842             if (p)
843             {
844                 *p++ = '\0'; /* cut the string in two */
845                 while (*p == ' ')
846                     p++;
847                 if (increasing)
848                     strcat(p, " <");
849                 else
850                     strcat(p, " >");
851                 yaz_log(YLOG_LOG, "Client %s: applying sorting %s %s", client_get_id(cl), spec, p);
852                 ZOOM_query_sortby2(q, spec, p);
853             }
854         }
855         else
856         {
857             /* no native sorting.. If this is not the first search, then
858                skip it entirely */
859             if (se->sorted_results->next)
860             {
861                 yaz_log(YLOG_DEBUG,"Client %s: Do not (re)search anyway", client_get_id(cl));
862                 ZOOM_query_destroy(q);
863                 return;
864             }
865         }
866     }
867     yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
868     client_set_state(cl, Client_Working);
869     cl->hits = 0;
870     cl->record_offset = 0;
871     rs = ZOOM_connection_search(link, q);
872     ZOOM_query_destroy(q);
873     ZOOM_resultset_destroy(cl->resultset);
874     cl->resultset = rs;
875     connection_continue(co);
876 }
877
878 struct client *client_create(const char *id)
879 {
880     struct client *cl = xmalloc(sizeof(*cl));
881     cl->maxrecs = 100;
882     cl->startrecs = 0;
883     cl->pquery = 0;
884     cl->cqlquery = 0;
885     cl->addinfo = 0;
886     cl->database = 0;
887     cl->connection = 0;
888     cl->session = 0;
889     cl->hits = 0;
890     cl->record_offset = 0;
891     cl->filtered = 0;
892     cl->diagnostic = 0;
893     cl->state = Client_Disconnected;
894     cl->show_raw = 0;
895     cl->resultset = 0;
896     cl->suggestions = 0;
897     cl->mutex = 0;
898     pazpar2_mutex_create(&cl->mutex, "client");
899     cl->preferred = 0;
900     cl->ref_count = 1;
901     cl->facet_limits = 0;
902     assert(id);
903     cl->id = xstrdup(id);
904     client_use(1);
905     
906     return cl;
907 }
908
909 void client_lock(struct client *c)
910 {
911     yaz_mutex_enter(c->mutex);
912 }
913
914 void client_unlock(struct client *c)
915 {
916     yaz_mutex_leave(c->mutex);
917 }
918
919 void client_incref(struct client *c)
920 {
921     pazpar2_incref(&c->ref_count, c->mutex);
922     yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
923             c, client_get_id(c), c->ref_count);
924 }
925
926 int client_destroy(struct client *c)
927 {
928     if (c)
929     {
930         yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
931                 c, client_get_id(c), c->ref_count);
932         if (!pazpar2_decref(&c->ref_count, c->mutex))
933         {
934             xfree(c->pquery);
935             c->pquery = 0;
936             xfree(c->cqlquery);
937             c->cqlquery = 0;
938             xfree(c->addinfo);
939             c->addinfo = 0;
940             xfree(c->id);
941             assert(!c->connection);
942             facet_limits_destroy(c->facet_limits);
943
944             if (c->resultset)
945             {
946                 ZOOM_resultset_destroy(c->resultset);
947             }
948             yaz_mutex_destroy(&c->mutex);
949             xfree(c);
950             client_use(-1);
951             return 1;
952         }
953     }
954     return 0;
955 }
956
957 void client_set_connection(struct client *cl, struct connection *con)
958 {
959     if (cl->resultset)
960         ZOOM_resultset_release(cl->resultset);
961     if (con)
962     {
963         assert(cl->connection == 0);
964         cl->connection = con;
965         client_incref(cl);
966     }
967     else
968     {
969         cl->connection = con;
970         client_destroy(cl);
971     }
972 }
973
974 void client_disconnect(struct client *cl)
975 {
976     if (cl->state != Client_Idle)
977         client_set_state(cl, Client_Disconnected);
978     client_set_connection(cl, 0);
979 }
980
981
982 // Initialize CCL map for a target
983 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
984 {
985     struct session_database *sdb = client_get_database(cl);
986     struct setting *s;
987     CCL_bibset res;
988
989     if (!sdb->settings)
990         return 0;
991     if (base_bibset)
992         res = ccl_qual_dup(base_bibset);
993     else
994         res = ccl_qual_mk();
995     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
996     {
997         char *p = strchr(s->name + 3, ':');
998         if (!p)
999         {
1000             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
1001             ccl_qual_rm(&res);
1002             return 0;
1003         }
1004         p++;
1005         ccl_qual_fitem(res, s->value, p);
1006     }
1007     return res;
1008 }
1009
1010 // returns a xmalloced CQL query corresponding to the pquery in client
1011 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1012 {
1013     cql_transform_t cqlt = cql_transform_create();
1014     char *r = 0;
1015     WRBUF wrb = wrbuf_alloc();
1016     int status;
1017
1018     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1019     {
1020         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1021     }
1022     else
1023     {
1024         r = xstrdup(wrbuf_cstr(wrb));
1025     }     
1026     wrbuf_destroy(wrb);
1027     cql_transform_close(cqlt);
1028     return r;
1029 }
1030
1031 // returns a xmalloced SOLR query corresponding to the pquery in client
1032 // TODO Could prob. be merge with the similar make_cqlquery
1033 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1034 {
1035     solr_transform_t sqlt = solr_transform_create();
1036     char *r = 0;
1037     WRBUF wrb = wrbuf_alloc();
1038     int status;
1039     
1040     if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1041     {
1042         yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1043     }
1044     else
1045     {
1046         r = xstrdup(wrbuf_cstr(wrb));
1047     }
1048     wrbuf_destroy(wrb);
1049     solr_transform_close(sqlt);
1050     return r;
1051 }
1052
1053 const char *client_get_facet_limit_local(struct client *cl,
1054                                          struct session_database *sdb,
1055                                          int *l,
1056                                          NMEM nmem, int *num, char ***values)
1057 {
1058     const char *name = 0;
1059     const char *value = 0;
1060     for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1061     {
1062         struct setting *s = 0;
1063         
1064         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1065         {
1066             const char *p = strchr(s->name + 3, ':');
1067             if (p && !strcmp(p + 1, name) && s->value &&
1068                 !strncmp(s->value, "local:", 6))
1069             {
1070                 const char *cp = s->value + 6;
1071                 while (*cp == ' ')
1072                     cp++;
1073                     
1074                 nmem_strsplit_escape2(nmem, "|", value, values,
1075                                       num, 1, '\\', 1);
1076                 (*l)++;
1077                 return *cp ? cp : name;
1078             }
1079         }
1080     }
1081     return 0;
1082 }
1083
1084 static int apply_limit(struct session_database *sdb,
1085                        facet_limits_t facet_limits,
1086                        WRBUF w_pqf, CCL_bibset ccl_map)
1087 {
1088     int ret = 0;
1089     int i = 0;
1090     const char *name;
1091     const char *value;
1092
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         nmem_reset(nmem_tmp);
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                     WRBUF ccl_w = wrbuf_alloc();
1127                     for (i = 0; i < num; i++)
1128                     {
1129                         int cerror, cpos;
1130                         struct ccl_rpn_node *cn;
1131
1132                         wrbuf_rewind(ccl_w);
1133                         wrbuf_puts(ccl_w, ccl);
1134                         wrbuf_puts(ccl_w, "=\"");
1135                         wrbuf_puts(ccl_w, values[i]);
1136                         wrbuf_puts(ccl_w, "\"");
1137
1138                         cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w), 
1139                                           &cerror, &cpos);
1140                         if (cn)
1141                         {
1142                             if (i == 0)
1143                                 wrbuf_printf(w_pqf, "@and ");
1144
1145                             /* or multiple values.. could be bad if last CCL
1146                                parse fails, but this is unlikely to happen */
1147                             if (i < num - 1)
1148                                 wrbuf_printf(w_pqf, "@or ");
1149                             ccl_pquery(w_pqf, cn);
1150                             ccl_rpn_delete(cn);
1151                         }
1152                     }
1153                     wrbuf_destroy(ccl_w);
1154                 }
1155                 else if (!strncmp(s->value, "local:", 6)) {
1156                     /* no operation */
1157                 }
1158                 else
1159                 {
1160                     yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1161                             sdb->database->id, s->value);
1162                     ret = -1; /* bad limitmap */
1163                 }
1164                 break;
1165             }
1166         }
1167         if (!s)
1168         {
1169             yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1170                     (sdb->database ? sdb->database->id : "<no id>"), name);
1171         }
1172     }
1173     nmem_destroy(nmem_tmp);
1174     return ret;
1175 }
1176                         
1177 // Parse the query given the settings specific to this client
1178 // return 0 if query is OK but different from before
1179 // return 1 if query is OK but same as before
1180 // return -1 on query error
1181 // return -2 on limit error
1182 int client_parse_query(struct client *cl, const char *query,
1183                        facet_limits_t facet_limits,
1184                        const char *startrecs, const char *maxrecs,
1185                        CCL_bibset bibset)
1186 {
1187     struct session *se = client_get_session(cl);
1188     struct session_database *sdb = client_get_database(cl);
1189     struct ccl_rpn_node *cn;
1190     int cerror, cpos;
1191     ODR odr_out;
1192     CCL_bibset ccl_map = prepare_cclmap(cl, bibset);
1193     const char *sru = session_setting_oneval(sdb, PZ_SRU);
1194     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1195     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1196     const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1197     WRBUF w_ccl, w_pqf;
1198     int ret_value = 1;
1199     Z_RPNQuery *zquery;
1200
1201     if (!ccl_map)
1202         return -1;
1203
1204     if (maxrecs && atoi(maxrecs) != cl->maxrecs)
1205     {
1206         ret_value = 0;
1207         cl->maxrecs = atoi(maxrecs);
1208     }
1209
1210     if (startrecs && atoi(startrecs) != cl->startrecs)
1211     {
1212         ret_value = 0;
1213         cl->startrecs = atoi(startrecs);
1214     }
1215
1216     w_ccl = wrbuf_alloc();
1217     wrbuf_puts(w_ccl, query);
1218
1219     w_pqf = wrbuf_alloc();
1220     if (*pqf_prefix)
1221     {
1222         wrbuf_puts(w_pqf, pqf_prefix);
1223         wrbuf_puts(w_pqf, " ");
1224     }
1225
1226     if (apply_limit(sdb, facet_limits, w_pqf, ccl_map))
1227     {
1228         ccl_qual_rm(&ccl_map);
1229         return -2;
1230     }
1231
1232     facet_limits_destroy(cl->facet_limits);
1233     cl->facet_limits = facet_limits_dup(facet_limits);
1234
1235     yaz_log(YLOG_LOG, "Client %s: CCL query: %s", client_get_id(cl), wrbuf_cstr(w_ccl));
1236     cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1237     ccl_qual_rm(&ccl_map);
1238     if (!cn)
1239     {
1240         client_set_state(cl, Client_Error);
1241         session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1242                     client_get_id(cl),
1243                     wrbuf_cstr(w_ccl));
1244         wrbuf_destroy(w_ccl);
1245         wrbuf_destroy(w_pqf);
1246         return -1;
1247     }
1248     wrbuf_destroy(w_ccl);
1249
1250     if (!pqf_strftime || !*pqf_strftime)
1251         ccl_pquery(w_pqf, cn);
1252     else
1253     {
1254         time_t cur_time = time(0);
1255         struct tm *tm =  localtime(&cur_time);
1256         char tmp_str[300];
1257         const char *cp = tmp_str;
1258
1259         /* see man strftime(3) for things .. In particular %% gets converted
1260          to %.. And That's our original query .. */
1261         strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1262         for (; *cp; cp++)
1263         {
1264             if (cp[0] == '%')
1265                 ccl_pquery(w_pqf, cn);
1266             else
1267                 wrbuf_putc(w_pqf, cp[0]);
1268         }
1269     }
1270
1271     if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1272     {
1273         xfree(cl->pquery);
1274         cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1275         ret_value = 0;
1276     }
1277     wrbuf_destroy(w_pqf);
1278     
1279     xfree(cl->cqlquery);
1280     cl->cqlquery = 0;
1281
1282     odr_out = odr_createmem(ODR_ENCODE);    
1283     zquery = p_query_rpn(odr_out, cl->pquery);
1284     if (!zquery)
1285     {
1286
1287         session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1288                     client_get_id(cl), cl->pquery);
1289         ret_value = -1;
1290     }
1291     else
1292     {
1293         session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1294                     client_get_id(cl), cl->pquery);
1295         
1296         /* Support for PQF on SRU targets. */
1297         if (strcmp(query_syntax, "pqf") != 0 && *sru)
1298         {
1299             if (!strcmp(sru, "solr"))
1300                 cl->cqlquery = make_solrquery(cl, zquery);
1301             else
1302                 cl->cqlquery = make_cqlquery(cl, zquery);
1303             if (!cl->cqlquery)
1304                 ret_value = -1;
1305         }
1306     }
1307     odr_destroy(odr_out);
1308
1309     /* TODO FIX Not thread safe */
1310     if (!se->relevance)
1311     {
1312         // Initialize relevance structure with query terms
1313         se->relevance = relevance_create_ccl(se->service->charsets, cn,
1314                                              se->service->rank_cluster);
1315     }
1316     ccl_rpn_delete(cn);
1317     return ret_value;
1318 }
1319
1320 void client_set_session(struct client *cl, struct session *se)
1321 {
1322     cl->session = se;
1323 }
1324
1325 int client_is_active(struct client *cl)
1326 {
1327     if (cl->connection && (cl->state == Client_Connecting ||
1328                            cl->state == Client_Working))
1329         return 1;
1330     return 0;
1331 }
1332
1333 int client_is_active_preferred(struct client *cl)
1334 {
1335     /* only count if this is a preferred target. */
1336     if (!cl->preferred)
1337         return 0;
1338     /* TODO No sure this the condition that Seb wants */
1339     if (cl->connection && (cl->state == Client_Connecting ||
1340                            cl->state == Client_Working))
1341         return 1;
1342     return 0;
1343 }
1344
1345 Odr_int client_get_hits(struct client *cl)
1346 {
1347     return cl->hits;
1348 }
1349
1350 Odr_int client_get_approximation(struct client *cl)
1351 {
1352     if (cl->record_offset > 0) {
1353         Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered)) / cl->record_offset + 5) /10;
1354         yaz_log(YLOG_DEBUG, "%s: Approx: %lld * %d / %d = %lld ", client_get_id(cl), cl->hits, cl->record_offset - cl->filtered, cl->record_offset, approx);
1355         return approx;
1356     }
1357     return cl->hits;
1358 }
1359
1360 int client_get_num_records(struct client *cl)
1361 {
1362     return cl->record_offset;
1363 }
1364
1365 int client_get_num_records_filtered(struct client *cl)
1366 {
1367     return cl->filtered;
1368 }
1369
1370 void client_set_diagnostic(struct client *cl, int diagnostic,
1371                            const char *addinfo)
1372 {
1373     cl->diagnostic = diagnostic;
1374     xfree(cl->addinfo);
1375     cl->addinfo = 0;
1376     if (addinfo)
1377         cl->addinfo = xstrdup(addinfo);
1378 }
1379
1380 int client_get_diagnostic(struct client *cl, const char **addinfo)
1381 {
1382     if (addinfo)
1383         *addinfo = cl->addinfo;
1384     return cl->diagnostic;
1385 }
1386
1387 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1388 {
1389     /* int idx; */
1390     struct suggestions *suggestions = cl->suggestions;
1391
1392     if (!suggestions) {
1393         //yaz_log(YLOG_DEBUG, "No suggestions found");
1394         return "";
1395     }
1396     if (suggestions->passthrough) {
1397         yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1398         return suggestions->passthrough;
1399     }
1400     if (suggestions->num == 0) {
1401         return "";
1402     }
1403     /*
1404     for (idx = 0; idx < suggestions->num; idx++) {
1405         wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1406         if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1407             wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1408             wrbuf_puts(wrbuf, "</suggest>\n");
1409         }
1410         else
1411             wrbuf_puts(wrbuf, "/>\n");
1412     }
1413     */
1414     return wrbuf_cstr(wrbuf);
1415 }
1416
1417
1418 void client_set_database(struct client *cl, struct session_database *db)
1419 {
1420     cl->database = db;
1421 }
1422
1423 const char *client_get_id(struct client *cl)
1424 {
1425     return cl->id;
1426 }
1427
1428 int client_get_maxrecs(struct client *cl)
1429 {
1430     return cl->maxrecs;
1431 }
1432
1433 void client_set_preferred(struct client *cl, int v)
1434 {
1435     cl->preferred = v;
1436 }
1437
1438
1439 struct suggestions* client_suggestions_create(const char* suggestions_string)
1440 {
1441     int i;
1442     NMEM nmem;
1443     struct suggestions *suggestions;
1444     if (suggestions_string == 0 || suggestions_string[0] == 0 )
1445         return 0;
1446     nmem = nmem_create();
1447     suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1448     yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1449
1450     suggestions->nmem = nmem;
1451     suggestions->num = 0;
1452     suggestions->misspelled = 0;
1453     suggestions->suggest = 0;
1454     suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1455
1456     if (suggestions_string)
1457         nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1458                               &suggestions->num, 1, '\\', 0);
1459     /* Set up misspelled array */
1460     suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1461     /* replace = with \0 .. for each item */
1462     for (i = 0; i < suggestions->num; i++)
1463     {
1464         char *cp = strchr(suggestions->suggest[i], '=');
1465         if (cp) {
1466             *cp = '\0';
1467             suggestions->misspelled[i] = cp+1;
1468         }
1469     }
1470     return suggestions;
1471 }
1472
1473 static void client_suggestions_destroy(struct client *cl)
1474 {
1475     NMEM nmem = cl->suggestions->nmem;
1476     cl->suggestions = 0;
1477     nmem_destroy(nmem);
1478 }
1479
1480 /*
1481  * Local variables:
1482  * c-basic-offset: 4
1483  * c-file-style: "Stroustrup"
1484  * indent-tabs-mode: nil
1485  * End:
1486  * vim: shiftwidth=4 tabstop=8 expandtab
1487  */
1488