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