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