Command record may return cached records (bug #2799).
[pazpar2-moved-to-github.git] / src / client.c
1 /* This file is part of Pazpar2.
2    Copyright (C) 2006-2009 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
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <string.h>
31 #if HAVE_SYS_TIME_H
32 #include <sys/time.h>
33 #endif
34 #if HAVE_UNISTD_H
35 #include <unistd.h>
36 #endif
37 #include <signal.h>
38 #include <assert.h>
39
40 #include <yaz/marcdisp.h>
41 #include <yaz/comstack.h>
42 #include <yaz/tcpip.h>
43 #include <yaz/proto.h>
44 #include <yaz/readconf.h>
45 #include <yaz/pquery.h>
46 #include <yaz/otherinfo.h>
47 #include <yaz/yaz-util.h>
48 #include <yaz/nmem.h>
49 #include <yaz/query-charset.h>
50 #include <yaz/querytowrbuf.h>
51 #include <yaz/oid_db.h>
52 #include <yaz/diagbib1.h>
53 #include <yaz/snprintf.h>
54 #include <yaz/rpn2cql.h>
55
56 #define USE_TIMING 0
57 #if USE_TIMING
58 #include <yaz/timing.h>
59 #endif
60
61 #include "pazpar2.h"
62
63 #include "client.h"
64 #include "connection.h"
65 #include "settings.h"
66
67 /** \brief Represents client state for a connection to one search target */
68 struct client {
69     struct session_database *database;
70     struct connection *connection;
71     struct session *session;
72     char *pquery; // Current search
73     char *cqlquery; // used for SRU targets only
74     int hits;
75     int record_offset;
76     int diagnostic;
77     enum client_state state;
78     struct show_raw *show_raw;
79     struct client *next;     // next client in session or next in free list
80 };
81
82 struct show_raw {
83     int active; // whether this request has been sent to the server
84     int position;
85     int binary;
86     char *syntax;
87     char *esn;
88     void (*error_handler)(void *data, const char *addinfo);
89     void (*record_handler)(void *data, const char *buf, size_t sz);
90     void *data;
91     struct show_raw *next;
92 };
93
94 static const char *client_states[] = {
95     "Client_Connecting",
96     "Client_Idle",
97     "Client_Working",
98     "Client_Error",
99     "Client_Failed",
100     "Client_Disconnected"
101 };
102
103 static struct client *client_freelist = 0;
104
105 const char *client_get_state_str(struct client *cl)
106 {
107     return client_states[cl->state];
108 }
109
110 enum client_state client_get_state(struct client *cl)
111 {
112     return cl->state;
113 }
114
115 void client_set_state(struct client *cl, enum client_state st)
116 {
117     cl->state = st;
118     if (cl->session)
119     {
120         int no_active = session_active_clients(cl->session);
121         if (no_active == 0)
122             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
123     }
124 }
125
126 static void client_show_raw_error(struct client *cl, const char *addinfo);
127
128 // Close connection and set state to error
129 void client_fatal(struct client *cl)
130 {
131     yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
132     connection_destroy(cl->connection);
133     client_set_state(cl, Client_Error);
134 }
135
136 struct connection *client_get_connection(struct client *cl)
137 {
138     return cl->connection;
139 }
140
141 struct session_database *client_get_database(struct client *cl)
142 {
143     return cl->database;
144 }
145
146 struct session *client_get_session(struct client *cl)
147 {
148     return cl->session;
149 }
150
151 const char *client_get_pquery(struct client *cl)
152 {
153     return cl->pquery;
154 }
155
156 static void client_send_raw_present(struct client *cl);
157 static int nativesyntax_to_type(struct session_database *sdb, char *type,
158                                 ZOOM_record rec);
159
160 int client_show_raw_immediate(struct client *cl, int position,
161                               const char *syntax, const char *esn,
162                               void *data,
163                               void (*error_handler)(void *data, const char *addinfo),
164                               void (*record_handler)(void *data, const char *buf,
165                                                      size_t sz),
166                               int binary)
167 {
168     struct connection *co = cl->connection;
169     struct session_database *sdb = client_get_database(cl);
170     ZOOM_resultset resultset = 0;
171     ZOOM_record rec = 0;
172     char type[80];
173     const char *buf;
174     int len;
175
176     if (!co)
177         return -1;
178
179     resultset = connection_get_resultset(co);
180     if (!resultset)
181     {
182         error_handler(data, "no resultset");
183         return 0;
184     }
185     rec = ZOOM_resultset_record(resultset, position-1);
186     if (!rec)
187     {
188         error_handler(data, "no record");
189         return 0;
190     }
191     if (binary)
192         strcpy(type, "raw");
193     else
194         nativesyntax_to_type(sdb, type, rec);
195     buf = ZOOM_record_get(rec, type, &len);
196     if (!buf)
197     {
198         error_handler(data, "no record");
199         return 0;
200     }
201     record_handler(data, buf, len);
202     return 0;
203 }
204
205
206 int client_show_raw_begin(struct client *cl, int position,
207                           const char *syntax, const char *esn,
208                           void *data,
209                           void (*error_handler)(void *data, const char *addinfo),
210                           void (*record_handler)(void *data, const char *buf,
211                                                  size_t sz),
212                           void **data2,
213                           int binary)
214 {
215     struct show_raw *rr, **rrp;
216     if (!cl->connection)
217     {   /* the client has no connection */
218         return -1;
219     }
220     rr = xmalloc(sizeof(*rr));
221     *data2 = rr;
222     rr->position = position;
223     rr->active = 0;
224     rr->data = data;
225     rr->error_handler = error_handler;
226     rr->record_handler = record_handler;
227     rr->binary = binary;
228     if (syntax)
229         rr->syntax = xstrdup(syntax);
230     else
231         rr->syntax = 0;
232     if (esn)
233         rr->esn = xstrdup(esn);
234     else
235         rr->esn = 0;
236     rr->next = 0;
237     
238     for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
239         ;
240     *rrp = rr;
241     
242     if (cl->state == Client_Failed)
243     {
244         client_show_raw_error(cl, "client failed");
245     }
246     else if (cl->state == Client_Disconnected)
247     {
248         client_show_raw_error(cl, "client disconnected");
249     }
250     else
251     {
252         client_send_raw_present(cl);
253     }
254     return 0;
255 }
256
257 void client_show_raw_remove(struct client *cl, void *data)
258 {
259     struct show_raw *rr = data;
260     struct show_raw **rrp = &cl->show_raw;
261     while (*rrp != rr)
262         rrp = &(*rrp)->next;
263     if (*rrp)
264     {
265         *rrp = rr->next;
266         xfree(rr);
267     }
268 }
269
270 void client_show_raw_dequeue(struct client *cl)
271 {
272     struct show_raw *rr = cl->show_raw;
273
274     cl->show_raw = rr->next;
275     xfree(rr);
276 }
277
278 static void client_show_raw_error(struct client *cl, const char *addinfo)
279 {
280     while (cl->show_raw)
281     {
282         cl->show_raw->error_handler(cl->show_raw->data, addinfo);
283         client_show_raw_dequeue(cl);
284     }
285 }
286
287 static void client_send_raw_present(struct client *cl)
288 {
289     struct session_database *sdb = client_get_database(cl);
290     struct connection *co = client_get_connection(cl);
291     ZOOM_resultset set = connection_get_resultset(co);
292
293     int offset = cl->show_raw->position;
294     const char *syntax = 0;
295     const char *elements = 0;
296
297     assert(cl->show_raw);
298     assert(set);
299
300     yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
301             client_get_url(cl), 1, offset);
302
303     if (cl->show_raw->syntax)
304         syntax = cl->show_raw->syntax;
305     else
306         syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
307     ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
308
309     if (cl->show_raw->esn)
310         elements = cl->show_raw->esn;
311     else
312         elements = session_setting_oneval(sdb, PZ_ELEMENTS);
313     if (elements && *elements)
314         ZOOM_resultset_option_set(set, "elementSetName", elements);
315
316     ZOOM_resultset_records(set, 0, offset-1, 1);
317     cl->show_raw->active = 1;
318
319     connection_continue(co);
320 }
321
322 static int nativesyntax_to_type(struct session_database *sdb, char *type,
323                                 ZOOM_record rec)
324 {
325     const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
326
327     if (s && *s)
328     {
329         if (!strncmp(s, "iso2709", 7))
330         {
331             const char *cp = strchr(s, ';');
332             yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
333         }
334         else if (!strncmp(s, "xml", 3))
335         {
336             strcpy(type, "xml");
337         }
338         else
339             return -1;
340         return 0;
341     }
342     else  /* attempt to deduce structure */
343     {
344         const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
345         if (syntax)
346         {
347             if (!strcmp(syntax, "XML"))
348             {
349                 strcpy(type, "xml");
350                 return 0;
351             }
352             else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
353             {
354                 strcpy(type, "xml; charset=marc8-s");
355                 return 0;
356             }
357             else return -1;
358         }
359         else return -1;
360     }
361 }
362
363 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
364 {
365     const char *buf;
366     int len;
367     char type[80];
368
369     if (cl->show_raw->binary)
370         strcpy(type, "raw");
371     else
372     {
373         struct session_database *sdb = client_get_database(cl);
374         nativesyntax_to_type(sdb, type, rec);
375     }
376
377     buf = ZOOM_record_get(rec, type, &len);
378     cl->show_raw->record_handler(cl->show_raw->data,  buf, len);
379     client_show_raw_dequeue(cl);
380 }
381
382 void client_search_response(struct client *cl)
383 {
384     struct connection *co = cl->connection;
385     struct session *se = cl->session;
386     ZOOM_connection link = connection_get_link(co);
387     ZOOM_resultset resultset = connection_get_resultset(co);
388     const char *error, *addinfo;
389
390     if (ZOOM_connection_error(link, &error, &addinfo))
391     {
392         cl->hits = 0;
393         client_set_state(cl, Client_Error);
394         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
395             error, addinfo, client_get_url(cl));
396     }
397     else
398     {
399         cl->record_offset = 0;
400         cl->hits = ZOOM_resultset_size(resultset);
401         se->total_hits += cl->hits;
402     }
403 }
404
405
406 void client_record_response(struct client *cl)
407 {
408     struct connection *co = cl->connection;
409     ZOOM_connection link = connection_get_link(co);
410     ZOOM_resultset resultset = connection_get_resultset(co);
411     const char *error, *addinfo;
412
413     if (ZOOM_connection_error(link, &error, &addinfo))
414     {
415         client_set_state(cl, Client_Error);
416         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
417             error, addinfo, client_get_url(cl));
418     }
419     else
420     {
421         ZOOM_record rec = 0;
422         const char *msg, *addinfo;
423         
424         if (cl->show_raw && cl->show_raw->active)
425         {
426             if ((rec = ZOOM_resultset_record(resultset,
427                                              cl->show_raw->position-1)))
428             {
429                 cl->show_raw->active = 0;
430                 ingest_raw_record(cl, rec);
431             }
432             else
433             {
434                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
435                         cl->show_raw->position-1);
436             }
437         }
438         else
439         {
440             int offset = cl->record_offset;
441             if ((rec = ZOOM_resultset_record(resultset, offset)))
442             {
443                 cl->record_offset++;
444                 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
445                     yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
446                             error, addinfo, client_get_url(cl),
447                             cl->record_offset);
448                 else
449                 {
450                     struct session_database *sdb = client_get_database(cl);
451                     const char *xmlrec;
452                     char type[80];
453                     if (nativesyntax_to_type(sdb, type, rec))
454                         yaz_log(YLOG_WARN, "Failed to determine record type");
455                     if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
456                     {
457                         if (ingest_record(cl, xmlrec, cl->record_offset))
458                         {
459                             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
460                             session_alert_watch(cl->session, SESSION_WATCH_RECORD);
461                         }
462                         else
463                             yaz_log(YLOG_WARN, "Failed to ingest");
464                     }
465                     else
466                         yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
467                 }
468
469             }
470             else
471             {
472                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
473                         offset);
474             }
475         }
476     }
477 }
478
479 void client_start_search(struct client *cl)
480 {
481     struct session_database *sdb = client_get_database(cl);
482     struct connection *co = client_get_connection(cl);
483     ZOOM_connection link = connection_get_link(co);
484     ZOOM_resultset rs;
485     char *databaseName = sdb->database->databases[0];
486     const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
487     const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
488     const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
489     const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
490     const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
491     const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
492
493     assert(link);
494
495     cl->hits = -1;
496     cl->record_offset = 0;
497     cl->diagnostic = 0;
498     client_set_state(cl, Client_Working);
499
500     if (*opt_piggyback)
501         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
502     else
503         ZOOM_connection_option_set(link, "piggyback", "1");
504     if (*opt_queryenc)
505         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
506     if (*opt_sru && *opt_elements)
507         ZOOM_connection_option_set(link, "schema", opt_elements);
508     else if (*opt_elements)
509         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
510     if (*opt_requestsyn)
511         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
512     if (*opt_maxrecs)
513         ZOOM_connection_option_set(link, "count", opt_maxrecs);
514     else
515     {
516         char n[128];
517         sprintf(n, "%d", global_parameters.toget);
518         ZOOM_connection_option_set(link, "count", n);
519     }
520     if (databaseName)
521         ZOOM_connection_option_set(link, "databaseName", databaseName);
522
523     ZOOM_connection_option_set(link, "presentChunk", "20");
524
525     if (cl->cqlquery)
526     {
527         ZOOM_query q = ZOOM_query_create();
528         yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
529         ZOOM_query_cql(q, cl->cqlquery);
530         rs = ZOOM_connection_search(link, q);
531         ZOOM_query_destroy(q);
532     }
533     else
534     {
535         yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
536         rs = ZOOM_connection_search_pqf(link, cl->pquery);
537     }
538     connection_set_resultset(co, rs);
539     connection_continue(co);
540 }
541
542 struct client *client_create(void)
543 {
544     struct client *r;
545     if (client_freelist)
546     {
547         r = client_freelist;
548         client_freelist = client_freelist->next;
549     }
550     else
551         r = xmalloc(sizeof(struct client));
552     r->pquery = 0;
553     r->cqlquery = 0;
554     r->database = 0;
555     r->connection = 0;
556     r->session = 0;
557     r->hits = 0;
558     r->record_offset = 0;
559     r->diagnostic = 0;
560     r->state = Client_Disconnected;
561     r->show_raw = 0;
562     r->next = 0;
563     return r;
564 }
565
566 void client_destroy(struct client *c)
567 {
568     struct session *se = c->session;
569     if (c == se->clients)
570         se->clients = c->next;
571     else
572     {
573         struct client *cc;
574         for (cc = se->clients; cc && cc->next != c; cc = cc->next)
575             ;
576         if (cc)
577             cc->next = c->next;
578     }
579     xfree(c->pquery);
580     xfree(c->cqlquery);
581
582     if (c->connection)
583         connection_release(c->connection);
584     c->next = client_freelist;
585     client_freelist = c;
586 }
587
588 void client_set_connection(struct client *cl, struct connection *con)
589 {
590     cl->connection = con;
591 }
592
593 void client_disconnect(struct client *cl)
594 {
595     if (cl->state != Client_Idle)
596         client_set_state(cl, Client_Disconnected);
597     client_set_connection(cl, 0);
598 }
599
600 // Extract terms from query into null-terminated termlist
601 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
602 {
603     int num = 0;
604
605     pull_terms(nmem, query, termlist, &num);
606     termlist[num] = 0;
607 }
608
609 // Initialize CCL map for a target
610 static CCL_bibset prepare_cclmap(struct client *cl)
611 {
612     struct session_database *sdb = client_get_database(cl);
613     struct setting *s;
614     CCL_bibset res;
615
616     if (!sdb->settings)
617         return 0;
618     res = ccl_qual_mk();
619     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
620     {
621         char *p = strchr(s->name + 3, ':');
622         if (!p)
623         {
624             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
625             ccl_qual_rm(&res);
626             return 0;
627         }
628         p++;
629         ccl_qual_fitem(res, s->value, p);
630     }
631     return res;
632 }
633
634 // returns a xmalloced CQL query corresponding to the pquery in client
635 static char *make_cqlquery(struct client *cl)
636 {
637     cql_transform_t cqlt = cql_transform_create();
638     Z_RPNQuery *zquery;
639     char *r;
640     WRBUF wrb = wrbuf_alloc();
641     int status;
642
643     zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
644     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
645     {
646         yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
647         return 0;
648     }
649     r = xstrdup(wrbuf_cstr(wrb));
650
651     wrbuf_destroy(wrb);
652     odr_reset(global_parameters.odr_out); // releases the zquery
653     cql_transform_close(cqlt);
654     return r;
655 }
656
657 // Parse the query given the settings specific to this client
658 int client_parse_query(struct client *cl, const char *query)
659 {
660     struct session *se = client_get_session(cl);
661     struct session_database *sdb = client_get_database(cl);
662     struct ccl_rpn_node *cn;
663     int cerror, cpos;
664     CCL_bibset ccl_map = prepare_cclmap(cl);
665     const char *sru = session_setting_oneval(sdb, PZ_SRU);
666     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
667
668     if (!ccl_map)
669         return -1;
670
671     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
672     ccl_qual_rm(&ccl_map);
673     if (!cn)
674     {
675         client_set_state(cl, Client_Error);
676         yaz_log(YLOG_WARN, "Failed to parse query for %s",
677                          client_get_database(cl)->database->url);
678         return -1;
679     }
680     wrbuf_rewind(se->wrbuf);
681     if (*pqf_prefix)
682     {
683         wrbuf_puts(se->wrbuf, pqf_prefix);
684         wrbuf_puts(se->wrbuf, " ");
685     }
686     ccl_pquery(se->wrbuf, cn);
687     xfree(cl->pquery);
688     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
689
690     xfree(cl->cqlquery);
691     if (*sru)
692     {
693         if (!(cl->cqlquery = make_cqlquery(cl)))
694             return -1;
695     }
696     else
697         cl->cqlquery = 0;
698
699     if (!se->relevance)
700     {
701         // Initialize relevance structure with query terms
702         char *p[512];
703         extract_terms(se->nmem, cn, p);
704         se->relevance = relevance_create(
705             global_parameters.server->relevance_pct,
706             se->nmem, (const char **) p,
707             se->expected_maxrecs);
708     }
709
710     ccl_rpn_delete(cn);
711     return 0;
712 }
713
714 void client_set_session(struct client *cl, struct session *se)
715 {
716     cl->session = se;
717     cl->next = se->clients;
718     se->clients = cl;
719 }
720
721 int client_is_active(struct client *cl)
722 {
723     if (cl->connection && (cl->state == Client_Connecting ||
724                            cl->state == Client_Working))
725         return 1;
726     return 0;
727 }
728
729 struct client *client_next_in_session(struct client *cl)
730 {
731     if (cl)
732         return cl->next;
733     return 0;
734
735 }
736
737 int client_get_hits(struct client *cl)
738 {
739     return cl->hits;
740 }
741
742 int client_get_num_records(struct client *cl)
743 {
744     return cl->record_offset;
745 }
746
747 int client_get_diagnostic(struct client *cl)
748 {
749     return cl->diagnostic;
750 }
751
752 void client_set_database(struct client *cl, struct session_database *db)
753 {
754     cl->database = db;
755 }
756
757 struct host *client_get_host(struct client *cl)
758 {
759     return client_get_database(cl)->database->host;
760 }
761
762 const char *client_get_url(struct client *cl)
763 {
764     return client_get_database(cl)->database->url;
765 }
766
767 /*
768  * Local variables:
769  * c-basic-offset: 4
770  * c-file-style: "Stroustrup"
771  * indent-tabs-mode: nil
772  * End:
773  * vim: shiftwidth=4 tabstop=8 expandtab
774  */
775