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