Annocate static vars left
[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 conf_server *server;
71     struct connection *connection;
72     struct session *session;
73     char *pquery; // Current search
74     char *cqlquery; // used for SRU targets only
75     int hits;
76     int record_offset;
77     int diagnostic;
78     enum client_state state;
79     struct show_raw *show_raw;
80     struct client *next;     // next client in session or next in free list
81     ZOOM_resultset resultset;
82 };
83
84 struct show_raw {
85     int active; // whether this request has been sent to the server
86     int position;
87     int binary;
88     char *syntax;
89     char *esn;
90     void (*error_handler)(void *data, const char *addinfo);
91     void (*record_handler)(void *data, const char *buf, size_t sz);
92     void *data;
93     struct show_raw *next;
94 };
95
96 static const char *client_states[] = {
97     "Client_Connecting",
98     "Client_Idle",
99     "Client_Working",
100     "Client_Error",
101     "Client_Failed",
102     "Client_Disconnected"
103 };
104
105 static struct client *client_freelist = 0; /* thread pr */
106
107 const char *client_get_state_str(struct client *cl)
108 {
109     return client_states[cl->state];
110 }
111
112 enum client_state client_get_state(struct client *cl)
113 {
114     return cl->state;
115 }
116
117 void client_set_state(struct client *cl, enum client_state st)
118 {
119     cl->state = st;
120     if (cl->session)
121     {
122         int no_active = session_active_clients(cl->session);
123         if (no_active == 0)
124             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
125     }
126 }
127
128 static void client_show_raw_error(struct client *cl, const char *addinfo);
129
130 // Close connection and set state to error
131 void client_fatal(struct client *cl)
132 {
133     yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
134     connection_destroy(cl->connection);
135     client_set_state(cl, Client_Error);
136 }
137
138 struct connection *client_get_connection(struct client *cl)
139 {
140     return cl->connection;
141 }
142
143 struct session_database *client_get_database(struct client *cl)
144 {
145     return cl->database;
146 }
147
148 struct session *client_get_session(struct client *cl)
149 {
150     return cl->session;
151 }
152
153 const char *client_get_pquery(struct client *cl)
154 {
155     return cl->pquery;
156 }
157
158 static void client_send_raw_present(struct client *cl);
159 static int nativesyntax_to_type(struct session_database *sdb, char *type,
160                                 ZOOM_record rec);
161
162 static void client_show_immediate(
163     ZOOM_resultset resultset, struct session_database *sdb, int position,
164     void *data,
165     void (*error_handler)(void *data, const char *addinfo),
166     void (*record_handler)(void *data, const char *buf, size_t sz),
167     int binary)
168 {
169     ZOOM_record rec = 0;
170     char type[80];
171     const char *buf;
172     int len;
173
174     if (!resultset)
175     {
176         error_handler(data, "no resultset");
177         return;
178     }
179     rec = ZOOM_resultset_record(resultset, position-1);
180     if (!rec)
181     {
182         error_handler(data, "no record");
183         return;
184     }
185     if (binary)
186         strcpy(type, "raw");
187     else
188         nativesyntax_to_type(sdb, type, rec);
189     buf = ZOOM_record_get(rec, type, &len);
190     if (!buf)
191     {
192         error_handler(data, "no record");
193         return;
194     }
195     record_handler(data, buf, len);
196 }
197
198
199 int client_show_raw_begin(struct client *cl, int position,
200                           const char *syntax, const char *esn,
201                           void *data,
202                           void (*error_handler)(void *data, const char *addinfo),
203                           void (*record_handler)(void *data, const char *buf,
204                                                  size_t sz),
205                           int binary)
206 {
207     if (syntax == 0 && esn == 0)
208         client_show_immediate(cl->resultset, client_get_database(cl),
209                               position, data,
210                               error_handler, record_handler,
211                               binary);
212     else
213     {
214         struct show_raw *rr, **rrp;
215
216         if (!cl->connection)
217             return -1;
218     
219
220         rr = xmalloc(sizeof(*rr));
221         rr->position = position;
222         rr->active = 0;
223         rr->data = data;
224         rr->error_handler = error_handler;
225         rr->record_handler = record_handler;
226         rr->binary = binary;
227         if (syntax)
228             rr->syntax = xstrdup(syntax);
229         else
230             rr->syntax = 0;
231         if (esn)
232             rr->esn = xstrdup(esn);
233         else
234             rr->esn = 0;
235         rr->next = 0;
236         
237         for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
238             ;
239         *rrp = rr;
240         
241         if (cl->state == Client_Failed)
242         {
243             client_show_raw_error(cl, "client failed");
244         }
245         else if (cl->state == Client_Disconnected)
246         {
247             client_show_raw_error(cl, "client disconnected");
248         }
249         else
250         {
251             client_send_raw_present(cl);
252         }
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 = cl->resultset;
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 = cl->resultset;
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 = cl->resultset;
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     ZOOM_resultset_destroy(cl->resultset);
539     cl->resultset = rs;
540     connection_continue(co);
541 }
542
543 struct client *client_create(void)
544 {
545     struct client *r;
546     if (client_freelist)
547     {
548         r = client_freelist;
549         client_freelist = client_freelist->next;
550     }
551     else
552         r = xmalloc(sizeof(struct client));
553     r->pquery = 0;
554     r->cqlquery = 0;
555     r->database = 0;
556     r->connection = 0;
557     r->session = 0;
558     r->hits = 0;
559     r->record_offset = 0;
560     r->diagnostic = 0;
561     r->state = Client_Disconnected;
562     r->show_raw = 0;
563     r->resultset = 0;
564     r->next = 0;
565     return r;
566 }
567
568 void client_destroy(struct client *c)
569 {
570     struct session *se = c->session;
571     if (c == se->clients)
572         se->clients = c->next;
573     else
574     {
575         struct client *cc;
576         for (cc = se->clients; cc && cc->next != c; cc = cc->next)
577             ;
578         if (cc)
579             cc->next = c->next;
580     }
581     xfree(c->pquery);
582     xfree(c->cqlquery);
583
584     if (c->connection)
585         connection_release(c->connection);
586
587     ZOOM_resultset_destroy(c->resultset);
588     c->resultset = 0;
589     c->next = client_freelist;
590     client_freelist = c;
591 }
592
593 void client_set_connection(struct client *cl, struct connection *con)
594 {
595     cl->connection = con;
596 }
597
598 void client_disconnect(struct client *cl)
599 {
600     if (cl->state != Client_Idle)
601         client_set_state(cl, Client_Disconnected);
602     client_set_connection(cl, 0);
603 }
604
605 // Extract terms from query into null-terminated termlist
606 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
607 {
608     int num = 0;
609
610     pull_terms(nmem, query, termlist, &num);
611     termlist[num] = 0;
612 }
613
614 // Initialize CCL map for a target
615 static CCL_bibset prepare_cclmap(struct client *cl)
616 {
617     struct session_database *sdb = client_get_database(cl);
618     struct setting *s;
619     CCL_bibset res;
620
621     if (!sdb->settings)
622         return 0;
623     res = ccl_qual_mk();
624     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
625     {
626         char *p = strchr(s->name + 3, ':');
627         if (!p)
628         {
629             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
630             ccl_qual_rm(&res);
631             return 0;
632         }
633         p++;
634         ccl_qual_fitem(res, s->value, p);
635     }
636     return res;
637 }
638
639 // returns a xmalloced CQL query corresponding to the pquery in client
640 static char *make_cqlquery(struct client *cl)
641 {
642     cql_transform_t cqlt = cql_transform_create();
643     Z_RPNQuery *zquery;
644     char *r;
645     WRBUF wrb = wrbuf_alloc();
646     int status;
647     ODR odr_out = odr_createmem(ODR_ENCODE);
648
649     zquery = p_query_rpn(odr_out, cl->pquery);
650     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
651     {
652         yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
653         r = 0;
654     }
655     else
656     {
657         r = xstrdup(wrbuf_cstr(wrb));
658     }     
659     wrbuf_destroy(wrb);
660     odr_destroy(odr_out);
661     cql_transform_close(cqlt);
662     return r;
663 }
664
665 // Parse the query given the settings specific to this client
666 int client_parse_query(struct client *cl, const char *query)
667 {
668     struct session *se = client_get_session(cl);
669     struct session_database *sdb = client_get_database(cl);
670     struct ccl_rpn_node *cn;
671     int cerror, cpos;
672     CCL_bibset ccl_map = prepare_cclmap(cl);
673     const char *sru = session_setting_oneval(sdb, PZ_SRU);
674     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
675
676     if (!ccl_map)
677         return -1;
678
679     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
680     ccl_qual_rm(&ccl_map);
681     if (!cn)
682     {
683         client_set_state(cl, Client_Error);
684         yaz_log(YLOG_WARN, "Failed to parse query for %s",
685                          client_get_database(cl)->database->url);
686         return -1;
687     }
688     wrbuf_rewind(se->wrbuf);
689     if (*pqf_prefix)
690     {
691         wrbuf_puts(se->wrbuf, pqf_prefix);
692         wrbuf_puts(se->wrbuf, " ");
693     }
694     ccl_pquery(se->wrbuf, cn);
695     xfree(cl->pquery);
696     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
697
698     xfree(cl->cqlquery);
699     if (*sru)
700     {
701         if (!(cl->cqlquery = make_cqlquery(cl)))
702             return -1;
703     }
704     else
705         cl->cqlquery = 0;
706
707     if (!se->relevance)
708     {
709         // Initialize relevance structure with query terms
710         char *p[512];
711         extract_terms(se->nmem, cn, p);
712         se->relevance = relevance_create(
713             se->service->relevance_pct,
714             se->nmem, (const char **) p,
715             se->expected_maxrecs);
716     }
717
718     ccl_rpn_delete(cn);
719     return 0;
720 }
721
722 void client_set_session(struct client *cl, struct session *se)
723 {
724     cl->session = se;
725     cl->next = se->clients;
726     se->clients = cl;
727 }
728
729 int client_is_active(struct client *cl)
730 {
731     if (cl->connection && (cl->state == Client_Connecting ||
732                            cl->state == Client_Working))
733         return 1;
734     return 0;
735 }
736
737 struct client *client_next_in_session(struct client *cl)
738 {
739     if (cl)
740         return cl->next;
741     return 0;
742
743 }
744
745 int client_get_hits(struct client *cl)
746 {
747     return cl->hits;
748 }
749
750 int client_get_num_records(struct client *cl)
751 {
752     return cl->record_offset;
753 }
754
755 int client_get_diagnostic(struct client *cl)
756 {
757     return cl->diagnostic;
758 }
759
760 void client_set_database(struct client *cl, struct session_database *db)
761 {
762     cl->database = db;
763 }
764
765 struct host *client_get_host(struct client *cl)
766 {
767     return client_get_database(cl)->database->host;
768 }
769
770 const char *client_get_url(struct client *cl)
771 {
772     return client_get_database(cl)->database->url;
773 }
774
775 /*
776  * Local variables:
777  * c-basic-offset: 4
778  * c-file-style: "Stroustrup"
779  * indent-tabs-mode: nil
780  * End:
781  * vim: shiftwidth=4 tabstop=8 expandtab
782  */
783