Merge branch 'master' into paz-927
[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, cl);
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 ( !strncmp(p, ":split:", 7) )
782             p += 6; // PAZ-1009
783         if (p && !strcmp(name, p + 1))
784             return 1;
785     }
786     return 0;
787 }
788
789 static const char *get_strategy_plus_sort(struct client *l, const char *field)
790 {
791     struct session_database *sdb = client_get_database(l);
792     struct setting *s;
793
794     const char *strategy_plus_sort = 0;
795
796     for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
797     {
798         char *p = strchr(s->name + 3, ':');
799         if (!p)
800         {
801             yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
802             continue;
803         }
804         p++;
805         if (!strcmp(p, field))
806         {
807             strategy_plus_sort = s->value;
808             break;
809         }
810     }
811     return strategy_plus_sort;
812 }
813
814 void client_update_show_stat(struct client *cl, int cmd)
815 {
816     if (cmd == 0)
817         cl->show_stat_no = 0;
818     else if (cmd == 1)
819         cl->show_stat_no++;
820 }
821
822 int client_fetch_more(struct client *cl)
823 {
824     struct session_database *sdb = client_get_database(cl);
825     const char *str;
826     int extend_recs = 0;
827     int number = cl->hits - cl->record_offset;
828
829     str = session_setting_oneval(sdb, PZ_EXTENDRECS);
830     if (!str || !*str)
831         return 0;
832
833     extend_recs = atoi(str);
834
835     yaz_log(YLOG_LOG, "cl=%s show_stat_no=%d got=%d",
836             client_get_id(cl), cl->show_stat_no, cl->record_offset);
837     if (cl->show_stat_no < cl->record_offset)
838         return 0;
839     yaz_log(YLOG_LOG, "cl=%s Trying to fetch more", client_get_id(cl));
840
841     if (number > extend_recs)
842         number = extend_recs;
843     if (number > 0)
844     {
845         ZOOM_resultset set = cl->resultset;
846         struct connection *co = client_get_connection(cl);
847
848         str = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
849         ZOOM_resultset_option_set(set, "preferredRecordSyntax", str);
850         str = session_setting_oneval(sdb, PZ_ELEMENTS);
851         if (str && *str)
852             ZOOM_resultset_option_set(set, "elementSetName", str);
853
854         ZOOM_resultset_records(set, 0, cl->record_offset, number);
855         client_set_state(cl, Client_Working);
856         connection_continue(co);
857         return 1;
858     }
859     else
860     {
861         yaz_log(YLOG_LOG, "cl=%s. OK no more in total set", client_get_id(cl));
862     }
863     return 0;
864 }
865
866 int client_parse_init(struct client *cl, int same_search)
867 {
868     cl->same_search = same_search;
869     return 0;
870 }
871
872 /*
873  * TODO consider how to extend the range
874  * */
875 int client_parse_range(struct client *cl, const char *startrecs,
876                        const char *maxrecs)
877 {
878     if (maxrecs && atoi(maxrecs) != cl->maxrecs)
879     {
880         cl->same_search = 0;
881         cl->maxrecs = atoi(maxrecs);
882     }
883
884     if (startrecs && atoi(startrecs) != cl->startrecs)
885     {
886         cl->same_search = 0;
887         cl->startrecs = atoi(startrecs);
888     }
889
890     return 0;
891 }
892
893 const char *client_get_query(struct client *cl, const char **type, NMEM nmem)
894 {
895     if (cl->pquery)
896     {
897         *type = "pqf";
898         return nmem_strdup(nmem, cl->pquery);
899     }
900     if (cl->cqlquery)
901     {
902         *type = "cql";
903         return nmem_strdup(nmem, cl->cqlquery);
904     }
905     *type = 0;
906     return 0;
907 }
908
909 int client_start_search(struct client *cl)
910 {
911     struct session_database *sdb = client_get_database(cl);
912     struct connection *co = 0;
913     ZOOM_connection link = 0;
914     struct session *se = client_get_session(cl);
915     ZOOM_resultset rs;
916     const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
917     const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
918     const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
919     const char *opt_requestsyn  = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
920     const char *opt_maxrecs     = session_setting_oneval(sdb, PZ_MAXRECS);
921     const char *opt_sru         = session_setting_oneval(sdb, PZ_SRU);
922     const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
923     const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
924     const char *extra_args      = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
925     const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
926     const char *opt_timeout     = session_setting_oneval(sdb, PZ_TIMEOUT);
927     ZOOM_query query;
928     char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
929     struct timeval tval;
930     int present_chunk = 20; // Default chunk size
931     int rc_prep_connection;
932     int operation_timeout = se->service->z3950_operation_timeout;
933
934     cl->diagnostic = 0;
935     cl->record_failures = cl->ingest_failures = cl->filtered = 0;
936
937     yaz_gettimeofday(&tval);
938     tval.tv_sec += 5;
939
940     if (opt_timeout && *opt_timeout)
941         operation_timeout = atoi(opt_timeout);
942
943     if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
944         present_chunk = atoi(opt_present_chunk);
945         yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
946     }
947     rc_prep_connection =
948         client_prep_connection(cl, operation_timeout,
949                                se->service->z3950_session_timeout,
950                                se->service->server->iochan_man,
951                                &tval);
952     /* Nothing has changed and we already have a result */
953     if (cl->same_search == 1 && rc_prep_connection == 2)
954     {
955         session_log(se, YLOG_LOG, "%s: reuse result", client_get_id(cl));
956         client_report_facets(cl, cl->resultset);
957         return client_reingest(cl);
958     }
959     else if (!rc_prep_connection)
960     {
961         client_set_diagnostic(cl, 2,
962                               ZOOM_diag_str(2),
963                               "Cannot create connection");
964         client_set_state_nb(cl, Client_Error);
965         return -1;
966     }
967     co = client_get_connection(cl);
968     assert(cl);
969     link = connection_get_link(co);
970     assert(link);
971
972     session_log(se, YLOG_LOG, "%s: new search", client_get_id(cl));
973
974     client_destroy_xdoc(cl);
975     client_init_xdoc(cl);
976
977     if (extra_args && *extra_args)
978         ZOOM_connection_option_set(link, "extraArgs", extra_args);
979
980     if (opt_preferred) {
981         cl->preferred = atoi(opt_preferred);
982         if (cl->preferred)
983             yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
984                     client_get_id(cl), cl->preferred);
985     }
986
987     if (*opt_piggyback)
988         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
989     else
990         ZOOM_connection_option_set(link, "piggyback", "1");
991     if (*opt_queryenc)
992         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
993     if (*opt_sru && *opt_elements)
994         ZOOM_connection_option_set(link, "schema", opt_elements);
995     else if (*opt_elements)
996         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
997     if (*opt_requestsyn)
998         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
999
1000     if (opt_maxrecs && *opt_maxrecs)
1001     {
1002         cl->maxrecs = atoi(opt_maxrecs);
1003     }
1004
1005     /* convert back to string representation used in ZOOM API */
1006     sprintf(maxrecs_str, "%d", cl->maxrecs);
1007     ZOOM_connection_option_set(link, "count", maxrecs_str);
1008
1009     /* A present_chunk less than 1 will disable chunking. */
1010     if (present_chunk > 0 && cl->maxrecs > present_chunk) {
1011         sprintf(present_chunk_str, "%d", present_chunk);
1012         ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
1013         yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
1014     }
1015     else {
1016         ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
1017         yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
1018     }
1019     sprintf(startrecs_str, "%d", cl->startrecs);
1020     ZOOM_connection_option_set(link, "start", startrecs_str);
1021
1022     /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
1023     /* facets definition is in PQF */
1024     client_set_facets_request(cl, link);
1025
1026     query = ZOOM_query_create();
1027     if (cl->cqlquery)
1028     {
1029         session_log(se, YLOG_LOG, "%s: Search CQL: %s", client_get_id(cl),
1030                     cl->cqlquery);
1031         ZOOM_query_cql(query, cl->cqlquery);
1032         if (*opt_sort)
1033             ZOOM_query_sortby(query, opt_sort);
1034     }
1035     else
1036     {
1037         session_log(se, YLOG_LOG, "%s: Search PQF: %s", client_get_id(cl),
1038                     cl->pquery);
1039         ZOOM_query_prefix(query, cl->pquery);
1040     }
1041     if (cl->sort_strategy && cl->sort_criteria) {
1042         yaz_log(YLOG_LOG, "Client %s: "
1043                 "Set ZOOM sort strategy and criteria: %s %s",
1044                 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
1045         ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
1046     }
1047
1048     yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
1049     client_set_state(cl, Client_Working);
1050     cl->hits = 0;
1051     cl->record_offset = 0;
1052     rs = ZOOM_connection_search(link, query);
1053     ZOOM_query_destroy(query);
1054     ZOOM_resultset_destroy(cl->resultset);
1055     cl->resultset = rs;
1056     connection_continue(co);
1057     return 0;
1058 }
1059
1060 struct client *client_create(const char *id)
1061 {
1062     struct client *cl = xmalloc(sizeof(*cl));
1063     cl->maxrecs = 100;
1064     cl->startrecs = 0;
1065     cl->pquery = 0;
1066     cl->cqlquery = 0;
1067     cl->addinfo = 0;
1068     cl->message = 0;
1069     cl->database = 0;
1070     cl->connection = 0;
1071     cl->session = 0;
1072     cl->hits = 0;
1073     cl->record_offset = 0;
1074     cl->filtered = 0;
1075     cl->diagnostic = 0;
1076     cl->state = Client_Disconnected;
1077     cl->show_raw = 0;
1078     cl->resultset = 0;
1079     cl->suggestions = 0;
1080     cl->mutex = 0;
1081     pazpar2_mutex_create(&cl->mutex, "client");
1082     cl->preferred = 0;
1083     cl->ref_count = 1;
1084     cl->facet_limits = 0;
1085     cl->sort_strategy = 0;
1086     cl->sort_criteria = 0;
1087     assert(id);
1088     cl->id = xstrdup(id);
1089     client_init_xdoc(cl);
1090     client_use(1);
1091
1092     yaz_log(YLOG_DEBUG, "client_create c=%p %s", cl, id);
1093     return cl;
1094 }
1095
1096 void client_lock(struct client *c)
1097 {
1098     yaz_mutex_enter(c->mutex);
1099 }
1100
1101 void client_unlock(struct client *c)
1102 {
1103     yaz_mutex_leave(c->mutex);
1104 }
1105
1106 void client_incref(struct client *c)
1107 {
1108     pazpar2_incref(&c->ref_count, c->mutex);
1109     yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
1110             c, client_get_id(c), c->ref_count);
1111 }
1112
1113 int client_destroy(struct client *c)
1114 {
1115     if (c)
1116     {
1117         yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
1118                 c, client_get_id(c), c->ref_count);
1119         if (!pazpar2_decref(&c->ref_count, c->mutex))
1120         {
1121             xfree(c->pquery);
1122             c->pquery = 0;
1123             xfree(c->cqlquery);
1124             c->cqlquery = 0;
1125             xfree(c->addinfo);
1126             c->addinfo = 0;
1127             xfree(c->message);
1128             c->message = 0;
1129             xfree(c->id);
1130             xfree(c->sort_strategy);
1131             xfree(c->sort_criteria);
1132             assert(!c->connection);
1133             facet_limits_destroy(c->facet_limits);
1134
1135             client_destroy_xdoc(c);
1136             if (c->resultset)
1137             {
1138                 ZOOM_resultset_destroy(c->resultset);
1139             }
1140             yaz_mutex_destroy(&c->mutex);
1141             xfree(c);
1142             client_use(-1);
1143             return 1;
1144         }
1145     }
1146     return 0;
1147 }
1148
1149 void client_set_connection(struct client *cl, struct connection *con)
1150 {
1151     if (cl->resultset)
1152         ZOOM_resultset_release(cl->resultset);
1153     if (con)
1154     {
1155         assert(cl->connection == 0);
1156         cl->connection = con;
1157         client_incref(cl);
1158     }
1159     else
1160     {
1161         client_lock(cl);
1162         cl->connection = con;
1163         client_unlock(cl);
1164         client_destroy(cl);
1165     }
1166 }
1167
1168 void client_disconnect(struct client *cl)
1169 {
1170     if (cl->state != Client_Idle)
1171         client_set_state(cl, Client_Disconnected);
1172     client_set_connection(cl, 0);
1173 }
1174
1175 void client_mark_dead(struct client *cl)
1176 {
1177     if (cl->connection)
1178         connection_mark_dead(cl->connection);
1179 }
1180
1181 void client_stop(struct client *cl)
1182 {
1183     client_lock(cl);
1184     if (cl->state == Client_Working || cl->state == Client_Connecting)
1185     {
1186         yaz_log(YLOG_LOG, "client_stop: %s release", client_get_id(cl));
1187         if (cl->connection)
1188         {
1189             connection_release2(cl->connection);
1190             assert(cl->ref_count > 1);
1191             cl->ref_count--;
1192             cl->connection = 0;
1193         }
1194         cl->state = Client_Disconnected;
1195     }
1196     else
1197         yaz_log(YLOG_LOG, "client_stop: %s ignore", client_get_id(cl));
1198     client_unlock(cl);
1199 }
1200
1201 // Initialize CCL map for a target
1202 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1203 {
1204     struct session_database *sdb = client_get_database(cl);
1205     struct setting *s;
1206     CCL_bibset res;
1207
1208     if (!sdb->settings)
1209         return 0;
1210     if (base_bibset)
1211         res = ccl_qual_dup(base_bibset);
1212     else
1213         res = ccl_qual_mk();
1214     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1215     {
1216         const char *addinfo = 0;
1217         char *p = strchr(s->name + 3, ':');
1218         if (!p)
1219         {
1220             WRBUF w = wrbuf_alloc();
1221             wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1222             yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1223             client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1224                                   ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1225                                   wrbuf_cstr(w));
1226             client_set_state_nb(cl, Client_Error);
1227             ccl_qual_rm(&res);
1228             wrbuf_destroy(w);
1229             return 0;
1230         }
1231         p++;
1232         if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1233         {
1234             WRBUF w = wrbuf_alloc();
1235
1236             wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1237                          s->name, p, addinfo);
1238             yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1239             client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1240                                   ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1241                                   wrbuf_cstr(w));
1242             client_set_state_nb(cl, Client_Error);
1243             ccl_qual_rm(&res);
1244             wrbuf_destroy(w);
1245             return 0;
1246         }
1247     }
1248     return res;
1249 }
1250
1251 // returns a xmalloced CQL query corresponding to the pquery in client
1252 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1253 {
1254     cql_transform_t cqlt = cql_transform_create();
1255     char *r = 0;
1256     WRBUF wrb = wrbuf_alloc();
1257     int status;
1258
1259     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1260     {
1261         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1262     }
1263     else
1264     {
1265         r = xstrdup(wrbuf_cstr(wrb));
1266     }
1267     wrbuf_destroy(wrb);
1268     cql_transform_close(cqlt);
1269     return r;
1270 }
1271
1272 // returns a xmalloced SOLR query corresponding to the pquery in client
1273 // TODO Could prob. be merge with the similar make_cqlquery
1274 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1275 {
1276     solr_transform_t sqlt = solr_transform_create();
1277     char *r = 0;
1278     WRBUF wrb = wrbuf_alloc();
1279     int status;
1280
1281     if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1282     {
1283         yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1284     }
1285     else
1286     {
1287         r = xstrdup(wrbuf_cstr(wrb));
1288     }
1289     wrbuf_destroy(wrb);
1290     solr_transform_close(sqlt);
1291     return r;
1292 }
1293
1294 const char *client_get_facet_limit_local(struct client *cl,
1295                                          struct session_database *sdb,
1296                                          int *l,
1297                                          NMEM nmem, int *num, char ***values)
1298 {
1299     const char *name = 0;
1300     const char *value = 0;
1301     for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1302     {
1303         struct setting *s = 0;
1304
1305         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1306         {
1307             const char *p = strchr(s->name + 3, ':');
1308             if (p && !strcmp(p + 1, name) && s->value)
1309             {
1310                 int j, cnum;
1311                 char **cvalues;
1312                 nmem_strsplit_escape2(nmem, ",", s->value, &cvalues,
1313                                       &cnum, 1, '\\', 1);
1314                 for (j = 0; j < cnum; j++)
1315                 {
1316                     const char *cvalue = cvalues[j];
1317                     while (*cvalue == ' ')
1318                         cvalue++;
1319                     if (!strncmp(cvalue, "local:", 6))
1320                     {
1321                         const char *cp = cvalue + 6;
1322                         while (*cp == ' ')
1323                             cp++;
1324                         nmem_strsplit_escape2(nmem, "|", value, values,
1325                                               num, 1, '\\', 1);
1326                         (*l)++;
1327                         return *cp ? cp : name;
1328                     }
1329                 }
1330             }
1331         }
1332     }
1333     return 0;
1334 }
1335
1336 static void ccl_quote_map_term(CCL_bibset ccl_map, WRBUF w,
1337                                const char *term)
1338 {
1339     int quote_it = 0;
1340     const char *cp;
1341     for (cp = term; *cp; cp++)
1342         if ((*cp >= '0' && *cp <= '9') || strchr(" +-", *cp))
1343             ;
1344         else
1345             quote_it = 1;
1346     if (!quote_it)
1347         wrbuf_puts(w, term);
1348     else
1349     {
1350         wrbuf_putc(w, '\"');
1351         for (cp = term; *cp; cp++)
1352         {
1353             if (strchr( "\\\"", *cp))
1354                 wrbuf_putc(w, '\\');
1355             wrbuf_putc(w, *cp);
1356         }
1357         wrbuf_putc(w, '\"');
1358     }
1359 }
1360
1361 static int apply_limit(struct client *cl,
1362                        facet_limits_t facet_limits,
1363                        WRBUF w_pqf, CCL_bibset ccl_map,
1364                        struct conf_service *service)
1365 {
1366     int ret = 0;
1367     int i = 0;
1368     const char *name;
1369     const char *value;
1370     struct session_database *sdb = client_get_database(cl);
1371
1372     NMEM nmem_tmp = nmem_create();
1373     for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1374     {
1375         struct setting *s = 0;
1376         nmem_reset(nmem_tmp);
1377         /* name="pz:limitmap:author" value="rpn:@attr 1=4|local:other" */
1378         for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1379         {
1380             const char *p = strchr(s->name + 3, ':');
1381             if (p && !strcmp(p + 1, name) && s->value)
1382             {
1383                 char **values = 0;
1384                 int i, num = 0;
1385                 char **cvalues = 0;
1386                 int j, cnum = 0;
1387                 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1388                                       &num, 1, '\\', 1);
1389
1390                 for (i = 0; i < num; i++)
1391                 {
1392                     const char *id = session_lookup_id_facet(cl->session,
1393                                                              cl, name,
1394                                                              values[i]);
1395                     if (id)
1396                     {
1397                         if ( *id )
1398                         {
1399                             values[i] = nmem_strdup(nmem_tmp, id);
1400                             yaz_log(YLOG_DEBUG,
1401                                 "apply_limit: s='%s' found id '%s'",s->name,id );
1402                         }
1403                         else
1404                         {
1405                             yaz_log(YLOG_DEBUG,
1406                                 "apply_limit: %s: term '%s' not found, failing client",
1407                                 s->name, values[i] );
1408                             ret = -1;
1409                         }
1410                     }
1411                 }
1412                 nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues,
1413                                       &cnum, 1, '\\', 1);
1414
1415                 for (j = 0; ret == 0 && j < cnum; j++)
1416                 {
1417                     const char *cvalue = cvalues[j];
1418                     while (*cvalue == ' ')
1419                         cvalue++;
1420                     if (!strncmp(cvalue, "rpn:", 4))
1421                     {
1422                         const char *pqf = cvalue + 4;
1423                         wrbuf_puts(w_pqf, "@and ");
1424                         wrbuf_puts(w_pqf, pqf);
1425                         wrbuf_puts(w_pqf, " ");
1426                         for (i = 0; i < num; i++)
1427                         {
1428                             if (i < num - 1)
1429                                 wrbuf_puts(w_pqf, "@or ");
1430                             yaz_encode_pqf_term(w_pqf, values[i],
1431                                                 strlen(values[i]));
1432                         }
1433                     }
1434                     else if (!strncmp(cvalue, "ccl:", 4))
1435                     {
1436                         const char *ccl = cvalue + 4;
1437                         WRBUF ccl_w = wrbuf_alloc();
1438                         for (i = 0; i < num; i++)
1439                         {
1440                             int cerror, cpos;
1441                             struct ccl_rpn_node *cn;
1442                             wrbuf_rewind(ccl_w);
1443                             wrbuf_puts(ccl_w, ccl);
1444                             wrbuf_putc(ccl_w, '=');
1445                             ccl_quote_map_term(ccl_map, ccl_w, values[i]);
1446                             cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1447                                               &cerror, &cpos);
1448                             if (cn)
1449                             {
1450                                 if (i == 0)
1451                                     wrbuf_printf(w_pqf, "@and ");
1452
1453                                 /* or multiple values.. could be bad if last
1454                                    CCL parse fails, but this is unlikely to
1455                                    happen */
1456                                 if (i < num - 1)
1457                                     wrbuf_printf(w_pqf, "@or ");
1458                                 ccl_pquery(w_pqf, cn);
1459                                 ccl_rpn_delete(cn);
1460                             }
1461                         }
1462                         wrbuf_destroy(ccl_w);
1463                     }
1464                     else if (!strncmp(cvalue, "local:", 6)) {
1465                         /* no operation */
1466                     }
1467                     else
1468                     {
1469                         yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1470                                 sdb->database->id, cvalue);
1471                         ret = -1; /* bad limitmap */
1472                     }
1473                 }
1474                 break;
1475             }
1476         }
1477         if (!s)
1478         {
1479             int i;
1480             for (i = 0; i < service->num_metadata; i++)
1481             {
1482                 struct conf_metadata *md = service->metadata + i;
1483                 if (!strcmp(md->name, name) && md->limitcluster)
1484                 {
1485                     yaz_log(YLOG_LOG, "limitcluster in use for %s",
1486                             md->name);
1487                     break;
1488                 }
1489             }
1490             if (i == service->num_metadata)
1491             {
1492                 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1493                         (sdb->database ? sdb->database->id : "<no id>"), name);
1494             }
1495         }
1496     }
1497     nmem_destroy(nmem_tmp);
1498     return ret;
1499 }
1500
1501 // Parse the query given the settings specific to this client
1502 // client variable same_search is set as below as well as returned:
1503 // 0 if query is OK but different from before
1504 // 1 if query is OK but same as before
1505 // return -1 on query error
1506 // return -2 on limit error
1507 int client_parse_query(struct client *cl, const char *query,
1508                        facet_limits_t facet_limits, const char **error_msg)
1509 {
1510     struct session *se = client_get_session(cl);
1511     struct conf_service *service = se->service;
1512     struct session_database *sdb = client_get_database(cl);
1513     struct ccl_rpn_node *cn;
1514     int cerror, cpos;
1515     ODR odr_out;
1516     CCL_bibset ccl_map = prepare_cclmap(cl, service->ccl_bibset);
1517     const char *sru = session_setting_oneval(sdb, PZ_SRU);
1518     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1519     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1520     const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1521     WRBUF w_ccl, w_pqf;
1522     int ret_value = 1;
1523     Z_RPNQuery *zquery;
1524
1525     if (!ccl_map)
1526         return -3;
1527
1528     xfree(cl->cqlquery);
1529     cl->cqlquery = 0;
1530
1531     w_ccl = wrbuf_alloc();
1532     wrbuf_puts(w_ccl, query);
1533
1534     w_pqf = wrbuf_alloc();
1535     if (*pqf_prefix)
1536     {
1537         wrbuf_puts(w_pqf, pqf_prefix);
1538         wrbuf_puts(w_pqf, " ");
1539     }
1540
1541     if (apply_limit(cl, facet_limits, w_pqf, ccl_map, service))
1542     {
1543         client_set_state(cl, Client_Error);
1544         ccl_qual_rm(&ccl_map);
1545
1546         wrbuf_destroy(w_ccl);
1547         wrbuf_destroy(w_pqf);
1548
1549         xfree(cl->pquery);
1550         cl->pquery = 0;
1551
1552         return -2;
1553     }
1554
1555     facet_limits_destroy(cl->facet_limits);
1556     cl->facet_limits = facet_limits_dup(facet_limits);
1557
1558     yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s",
1559             client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
1560     cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1561     ccl_qual_rm(&ccl_map);
1562     if (!cn)
1563     {
1564         if (error_msg)
1565             *error_msg = ccl_err_msg(cerror);
1566         client_set_state(cl, Client_Error);
1567         session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1568                     client_get_id(cl),
1569                     wrbuf_cstr(w_ccl));
1570         wrbuf_destroy(w_ccl);
1571         wrbuf_destroy(w_pqf);
1572
1573         xfree(cl->pquery);
1574         cl->pquery = 0;
1575
1576         return -1;
1577     }
1578     wrbuf_destroy(w_ccl);
1579
1580     if (!pqf_strftime || !*pqf_strftime)
1581         ccl_pquery(w_pqf, cn);
1582     else
1583     {
1584         time_t cur_time = time(0);
1585         struct tm *tm =  localtime(&cur_time);
1586         char tmp_str[300];
1587         const char *cp = tmp_str;
1588
1589         /* see man strftime(3) for things .. In particular %% gets converted
1590          to %.. And That's our original query .. */
1591         strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1592         for (; *cp; cp++)
1593         {
1594             if (cp[0] == '%')
1595                 ccl_pquery(w_pqf, cn);
1596             else
1597                 wrbuf_putc(w_pqf, cp[0]);
1598         }
1599     }
1600
1601     /* Compares query and limit with old one. If different we need to research */
1602     if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1603     {
1604         if (cl->pquery)
1605             session_log(se, YLOG_LOG, "Client %s: "
1606                         "Re-search due query/limit change: %s to %s",
1607                         client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
1608         xfree(cl->pquery);
1609         cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1610         // return value is no longer used.
1611         ret_value = 0;
1612         // Need to (re)search
1613         cl->same_search= 0;
1614     }
1615     wrbuf_destroy(w_pqf);
1616
1617     odr_out = odr_createmem(ODR_ENCODE);
1618     zquery = p_query_rpn(odr_out, cl->pquery);
1619     if (!zquery)
1620     {
1621         session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1622                     client_get_id(cl), cl->pquery);
1623         ret_value = -1;
1624         *error_msg = "Invalid PQF after CCL to PQF conversion";
1625     }
1626     else
1627     {
1628         session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1629                     client_get_id(cl), cl->pquery);
1630
1631         /* Support for PQF on SRU targets. */
1632         if (strcmp(query_syntax, "pqf") != 0 && *sru)
1633         {
1634             if (!strcmp(sru, "solr"))
1635                 cl->cqlquery = make_solrquery(cl, zquery);
1636             else
1637                 cl->cqlquery = make_cqlquery(cl, zquery);
1638             if (!cl->cqlquery)
1639             {
1640                 *error_msg = "Cannot convert PQF to Solr/CQL";
1641                 ret_value = -1;
1642             }
1643             else
1644                 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
1645                             client_get_id(cl), cl->cqlquery, sru);
1646         }
1647     }
1648     odr_destroy(odr_out);
1649
1650     /* TODO FIX Not thread safe */
1651     if (!se->relevance)
1652     {
1653         // Initialize relevance structure with query terms
1654         se->relevance = relevance_create_ccl(se->service->charsets, cn,
1655                                              se->service->rank_cluster,
1656                                              se->service->rank_follow,
1657                                              se->service->rank_lead,
1658                                              se->service->rank_length);
1659     }
1660     ccl_rpn_delete(cn);
1661     return ret_value;
1662 }
1663
1664 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp,
1665                       int *has_sortmap)
1666 {
1667     if (has_sortmap)
1668         *has_sortmap = 0;
1669     if (sp)
1670     {
1671         const char *sort_strategy_and_spec =
1672             get_strategy_plus_sort(cl, sp->name);
1673         int increasing = sp->increasing;
1674         if (!strcmp(sp->name, "relevance"))
1675             increasing = 1;
1676         if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1677         {
1678             char strategy[50], *p;
1679             strcpy(strategy, sort_strategy_and_spec);
1680             p = strchr(strategy, ':');
1681             if (p)
1682             {
1683                 // Split the string in two
1684                 *p++ = 0;
1685                 while (*p == ' ')
1686                     p++;
1687                 if (increasing)
1688                     strcat(p, " <");
1689                 else
1690                     strcat(p, " >");
1691                 yaz_log(YLOG_LOG, "Client %s: "
1692                         "applying sorting %s %s", client_get_id(cl),
1693                         strategy, p);
1694                 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
1695                     cl->same_search = 0;
1696                 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
1697                     cl->same_search = 0;
1698                 if (cl->same_search == 0) {
1699                     xfree(cl->sort_strategy);
1700                     cl->sort_strategy = xstrdup(strategy);
1701                     xfree(cl->sort_criteria);
1702                     cl->sort_criteria = xstrdup(p);
1703                 }
1704                 if (has_sortmap)
1705                     (*has_sortmap)++;
1706             }
1707             else {
1708                 yaz_log(YLOG_LOG, "Client %s: "
1709                         "Invalid sort strategy and spec found %s",
1710                         client_get_id(cl), sort_strategy_and_spec);
1711                 xfree(cl->sort_strategy);
1712                 cl->sort_strategy  = 0;
1713                 xfree(cl->sort_criteria);
1714                 cl->sort_criteria = 0;
1715             }
1716         }
1717         else
1718         {
1719             yaz_log(YLOG_DEBUG, "Client %s: "
1720                     "No sort strategy and spec found.", client_get_id(cl));
1721             xfree(cl->sort_strategy);
1722             cl->sort_strategy  = 0;
1723             xfree(cl->sort_criteria);
1724             cl->sort_criteria = 0;
1725         }
1726
1727     }
1728     return !cl->same_search;
1729 }
1730
1731 void client_set_session(struct client *cl, struct session *se)
1732 {
1733     cl->session = se;
1734 }
1735
1736 int client_is_active(struct client *cl)
1737 {
1738     if (cl->connection && (cl->state == Client_Connecting ||
1739                            cl->state == Client_Working))
1740         return 1;
1741     return 0;
1742 }
1743
1744 int client_is_active_preferred(struct client *cl)
1745 {
1746     /* only count if this is a preferred target. */
1747     if (!cl->preferred)
1748         return 0;
1749     /* TODO No sure this the condition that Seb wants */
1750     if (cl->connection && (cl->state == Client_Connecting ||
1751                            cl->state == Client_Working))
1752         return 1;
1753     return 0;
1754 }
1755
1756 Odr_int client_get_hits(struct client *cl)
1757 {
1758     return cl->hits;
1759 }
1760
1761 Odr_int client_get_approximation(struct client *cl)
1762 {
1763     if (cl->record_offset > 0)
1764     {
1765         Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered))
1766                           / cl->record_offset + 5) /10;
1767         yaz_log(YLOG_DEBUG, "%s: Approx: %lld * %d / %d = %lld ",
1768                 client_get_id(cl), cl->hits,
1769                 cl->record_offset - cl->filtered, cl->record_offset, approx);
1770         return approx;
1771     }
1772     return cl->hits;
1773 }
1774
1775 int client_get_num_records(struct client *cl, int *filtered, int *ingest,
1776                            int *failed)
1777 {
1778     if (filtered)
1779         *filtered = cl->filtered;
1780     if (ingest)
1781         *ingest = cl->ingest_failures;
1782     if (failed)
1783         *failed = cl->record_failures;
1784     return cl->record_offset;
1785 }
1786
1787 void client_set_diagnostic(struct client *cl, int diagnostic,
1788                            const char *message, const char *addinfo)
1789 {
1790     cl->diagnostic = diagnostic;
1791     xfree(cl->message);
1792     cl->message = xstrdup(message);
1793     xfree(cl->addinfo);
1794     cl->addinfo = 0;
1795     if (addinfo)
1796         cl->addinfo = xstrdup(addinfo);
1797 }
1798
1799 int client_get_diagnostic(struct client *cl, const char **message,
1800                           const char **addinfo)
1801 {
1802     if (message)
1803         *message = cl->message;
1804     if (addinfo)
1805         *addinfo = cl->addinfo;
1806     return cl->diagnostic;
1807 }
1808
1809 const char *client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1810 {
1811     /* int idx; */
1812     struct suggestions *suggestions = cl->suggestions;
1813
1814     if (!suggestions)
1815         return "";
1816     if (suggestions->passthrough)
1817     {
1818         yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n",
1819                 suggestions->passthrough);
1820         return suggestions->passthrough;
1821     }
1822     if (suggestions->num == 0)
1823         return "";
1824     /*
1825     for (idx = 0; idx < suggestions->num; idx++) {
1826         wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1827         if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1828             wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1829             wrbuf_puts(wrbuf, "</suggest>\n");
1830         }
1831         else
1832             wrbuf_puts(wrbuf, "/>\n");
1833     }
1834     */
1835     return wrbuf_cstr(wrbuf);
1836 }
1837
1838 void client_set_database(struct client *cl, struct session_database *db)
1839 {
1840     cl->database = db;
1841 }
1842
1843 const char *client_get_id(struct client *cl)
1844 {
1845     return cl->id;
1846 }
1847
1848 int client_get_maxrecs(struct client *cl)
1849 {
1850     return cl->maxrecs;
1851 }
1852
1853 void client_set_preferred(struct client *cl, int v)
1854 {
1855     cl->preferred = v;
1856 }
1857
1858
1859 struct suggestions* client_suggestions_create(const char* suggestions_string)
1860 {
1861     int i;
1862     NMEM nmem;
1863     struct suggestions *suggestions;
1864     if (suggestions_string == 0 || suggestions_string[0] == 0 )
1865         return 0;
1866     nmem = nmem_create();
1867     suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1868     yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1869
1870     suggestions->nmem = nmem;
1871     suggestions->num = 0;
1872     suggestions->misspelled = 0;
1873     suggestions->suggest = 0;
1874     suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1875
1876     if (suggestions_string)
1877         nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1878                               &suggestions->num, 1, '\\', 0);
1879     /* Set up misspelled array */
1880     suggestions->misspelled = (char **)
1881         nmem_malloc(nmem, suggestions->num * sizeof(*suggestions->misspelled));
1882     /* replace = with \0 .. for each item */
1883     for (i = 0; i < suggestions->num; i++)
1884     {
1885         char *cp = strchr(suggestions->suggest[i], '=');
1886         if (cp) {
1887             *cp = '\0';
1888             suggestions->misspelled[i] = cp+1;
1889         }
1890     }
1891     return suggestions;
1892 }
1893
1894 static void client_suggestions_destroy(struct client *cl)
1895 {
1896     NMEM nmem = cl->suggestions->nmem;
1897     cl->suggestions = 0;
1898     nmem_destroy(nmem);
1899 }
1900
1901 /*
1902  * Local variables:
1903  * c-basic-offset: 4
1904  * c-file-style: "Stroustrup"
1905  * indent-tabs-mode: nil
1906  * End:
1907  * vim: shiftwidth=4 tabstop=8 expandtab
1908  */
1909