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