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