wait a second between stop and start in the restart command. This avoid
[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 static void client_show_immediate(struct client *cl, int position,
161                                   void *data,
162                                   void (*error_handler)(void *data, const char *addinfo),
163                                   void (*record_handler)(void *data, const char *buf,
164                                                          size_t sz),
165                                   int binary)
166 {
167     struct connection *co = cl->connection;
168     struct session_database *sdb = client_get_database(cl);
169     ZOOM_resultset resultset = 0;
170     ZOOM_record rec = 0;
171     char type[80];
172     const char *buf;
173     int len;
174
175     assert(co);
176
177     resultset = connection_get_resultset(co);
178     if (!resultset)
179     {
180         error_handler(data, "no resultset");
181         return;
182     }
183     rec = ZOOM_resultset_record(resultset, position-1);
184     if (!rec)
185     {
186         error_handler(data, "no record");
187         return;
188     }
189     if (binary)
190         strcpy(type, "raw");
191     else
192         nativesyntax_to_type(sdb, type, rec);
193     buf = ZOOM_record_get(rec, type, &len);
194     if (!buf)
195     {
196         error_handler(data, "no record");
197         return;
198     }
199     record_handler(data, buf, len);
200 }
201
202
203 int client_show_raw_begin(struct client *cl, int position,
204                           const char *syntax, const char *esn,
205                           void *data,
206                           void (*error_handler)(void *data, const char *addinfo),
207                           void (*record_handler)(void *data, const char *buf,
208                                                  size_t sz),
209                           int binary)
210 {
211     if (!cl->connection)
212         return -1;
213     
214     if (syntax == 0 && esn == 0)
215         client_show_immediate(cl, position, data,
216                               error_handler, record_handler,
217                               binary);
218     else
219     {
220         struct show_raw *rr, **rrp;
221         rr = xmalloc(sizeof(*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     }
255     return 0;
256 }
257
258 void client_show_raw_remove(struct client *cl, void *data)
259 {
260     struct show_raw *rr = data;
261     struct show_raw **rrp = &cl->show_raw;
262     while (*rrp != rr)
263         rrp = &(*rrp)->next;
264     if (*rrp)
265     {
266         *rrp = rr->next;
267         xfree(rr);
268     }
269 }
270
271 void client_show_raw_dequeue(struct client *cl)
272 {
273     struct show_raw *rr = cl->show_raw;
274
275     cl->show_raw = rr->next;
276     xfree(rr);
277 }
278
279 static void client_show_raw_error(struct client *cl, const char *addinfo)
280 {
281     while (cl->show_raw)
282     {
283         cl->show_raw->error_handler(cl->show_raw->data, addinfo);
284         client_show_raw_dequeue(cl);
285     }
286 }
287
288 static void client_send_raw_present(struct client *cl)
289 {
290     struct session_database *sdb = client_get_database(cl);
291     struct connection *co = client_get_connection(cl);
292     ZOOM_resultset set = connection_get_resultset(co);
293
294     int offset = cl->show_raw->position;
295     const char *syntax = 0;
296     const char *elements = 0;
297
298     assert(cl->show_raw);
299     assert(set);
300
301     yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
302             client_get_url(cl), 1, offset);
303
304     if (cl->show_raw->syntax)
305         syntax = cl->show_raw->syntax;
306     else
307         syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
308     ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
309
310     if (cl->show_raw->esn)
311         elements = cl->show_raw->esn;
312     else
313         elements = session_setting_oneval(sdb, PZ_ELEMENTS);
314     if (elements && *elements)
315         ZOOM_resultset_option_set(set, "elementSetName", elements);
316
317     ZOOM_resultset_records(set, 0, offset-1, 1);
318     cl->show_raw->active = 1;
319
320     connection_continue(co);
321 }
322
323 static int nativesyntax_to_type(struct session_database *sdb, char *type,
324                                 ZOOM_record rec)
325 {
326     const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
327
328     if (s && *s)
329     {
330         if (!strncmp(s, "iso2709", 7))
331         {
332             const char *cp = strchr(s, ';');
333             yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
334         }
335         else if (!strncmp(s, "xml", 3))
336         {
337             strcpy(type, "xml");
338         }
339         else
340             return -1;
341         return 0;
342     }
343     else  /* attempt to deduce structure */
344     {
345         const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
346         if (syntax)
347         {
348             if (!strcmp(syntax, "XML"))
349             {
350                 strcpy(type, "xml");
351                 return 0;
352             }
353             else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
354             {
355                 strcpy(type, "xml; charset=marc8-s");
356                 return 0;
357             }
358             else return -1;
359         }
360         else return -1;
361     }
362 }
363
364 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
365 {
366     const char *buf;
367     int len;
368     char type[80];
369
370     if (cl->show_raw->binary)
371         strcpy(type, "raw");
372     else
373     {
374         struct session_database *sdb = client_get_database(cl);
375         nativesyntax_to_type(sdb, type, rec);
376     }
377
378     buf = ZOOM_record_get(rec, type, &len);
379     cl->show_raw->record_handler(cl->show_raw->data,  buf, len);
380     client_show_raw_dequeue(cl);
381 }
382
383 void client_search_response(struct client *cl)
384 {
385     struct connection *co = cl->connection;
386     struct session *se = cl->session;
387     ZOOM_connection link = connection_get_link(co);
388     ZOOM_resultset resultset = connection_get_resultset(co);
389     const char *error, *addinfo;
390
391     if (ZOOM_connection_error(link, &error, &addinfo))
392     {
393         cl->hits = 0;
394         client_set_state(cl, Client_Error);
395         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
396             error, addinfo, client_get_url(cl));
397     }
398     else
399     {
400         cl->record_offset = 0;
401         cl->hits = ZOOM_resultset_size(resultset);
402         se->total_hits += cl->hits;
403     }
404 }
405
406
407 void client_record_response(struct client *cl)
408 {
409     struct connection *co = cl->connection;
410     ZOOM_connection link = connection_get_link(co);
411     ZOOM_resultset resultset = connection_get_resultset(co);
412     const char *error, *addinfo;
413
414     if (ZOOM_connection_error(link, &error, &addinfo))
415     {
416         client_set_state(cl, Client_Error);
417         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
418             error, addinfo, client_get_url(cl));
419     }
420     else
421     {
422         ZOOM_record rec = 0;
423         const char *msg, *addinfo;
424         
425         if (cl->show_raw && cl->show_raw->active)
426         {
427             if ((rec = ZOOM_resultset_record(resultset,
428                                              cl->show_raw->position-1)))
429             {
430                 cl->show_raw->active = 0;
431                 ingest_raw_record(cl, rec);
432             }
433             else
434             {
435                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
436                         cl->show_raw->position-1);
437             }
438         }
439         else
440         {
441             int offset = cl->record_offset;
442             if ((rec = ZOOM_resultset_record(resultset, offset)))
443             {
444                 cl->record_offset++;
445                 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
446                     yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
447                             error, addinfo, client_get_url(cl),
448                             cl->record_offset);
449                 else
450                 {
451                     struct session_database *sdb = client_get_database(cl);
452                     const char *xmlrec;
453                     char type[80];
454                     if (nativesyntax_to_type(sdb, type, rec))
455                         yaz_log(YLOG_WARN, "Failed to determine record type");
456                     if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
457                     {
458                         if (ingest_record(cl, xmlrec, cl->record_offset))
459                         {
460                             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
461                             session_alert_watch(cl->session, SESSION_WATCH_RECORD);
462                         }
463                         else
464                             yaz_log(YLOG_WARN, "Failed to ingest");
465                     }
466                     else
467                         yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
468                 }
469
470             }
471             else
472             {
473                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
474                         offset);
475             }
476         }
477     }
478 }
479
480 void client_start_search(struct client *cl)
481 {
482     struct session_database *sdb = client_get_database(cl);
483     struct connection *co = client_get_connection(cl);
484     ZOOM_connection link = connection_get_link(co);
485     ZOOM_resultset rs;
486     char *databaseName = sdb->database->databases[0];
487     const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
488     const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
489     const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
490     const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
491     const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
492     const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
493
494     assert(link);
495
496     cl->hits = -1;
497     cl->record_offset = 0;
498     cl->diagnostic = 0;
499     client_set_state(cl, Client_Working);
500
501     if (*opt_piggyback)
502         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
503     else
504         ZOOM_connection_option_set(link, "piggyback", "1");
505     if (*opt_queryenc)
506         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
507     if (*opt_sru && *opt_elements)
508         ZOOM_connection_option_set(link, "schema", opt_elements);
509     else if (*opt_elements)
510         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
511     if (*opt_requestsyn)
512         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
513     if (*opt_maxrecs)
514         ZOOM_connection_option_set(link, "count", opt_maxrecs);
515     else
516     {
517         char n[128];
518         sprintf(n, "%d", global_parameters.toget);
519         ZOOM_connection_option_set(link, "count", n);
520     }
521     if (databaseName)
522         ZOOM_connection_option_set(link, "databaseName", databaseName);
523
524     ZOOM_connection_option_set(link, "presentChunk", "20");
525
526     if (cl->cqlquery)
527     {
528         ZOOM_query q = ZOOM_query_create();
529         yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
530         ZOOM_query_cql(q, cl->cqlquery);
531         rs = ZOOM_connection_search(link, q);
532         ZOOM_query_destroy(q);
533     }
534     else
535     {
536         yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
537         rs = ZOOM_connection_search_pqf(link, cl->pquery);
538     }
539     connection_set_resultset(co, 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->next = 0;
564     return r;
565 }
566
567 void client_destroy(struct client *c)
568 {
569     struct session *se = c->session;
570     if (c == se->clients)
571         se->clients = c->next;
572     else
573     {
574         struct client *cc;
575         for (cc = se->clients; cc && cc->next != c; cc = cc->next)
576             ;
577         if (cc)
578             cc->next = c->next;
579     }
580     xfree(c->pquery);
581     xfree(c->cqlquery);
582
583     if (c->connection)
584         connection_release(c->connection);
585     c->next = client_freelist;
586     client_freelist = c;
587 }
588
589 void client_set_connection(struct client *cl, struct connection *con)
590 {
591     cl->connection = con;
592 }
593
594 void client_disconnect(struct client *cl)
595 {
596     if (cl->state != Client_Idle)
597         client_set_state(cl, Client_Disconnected);
598     client_set_connection(cl, 0);
599 }
600
601 // Extract terms from query into null-terminated termlist
602 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
603 {
604     int num = 0;
605
606     pull_terms(nmem, query, termlist, &num);
607     termlist[num] = 0;
608 }
609
610 // Initialize CCL map for a target
611 static CCL_bibset prepare_cclmap(struct client *cl)
612 {
613     struct session_database *sdb = client_get_database(cl);
614     struct setting *s;
615     CCL_bibset res;
616
617     if (!sdb->settings)
618         return 0;
619     res = ccl_qual_mk();
620     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
621     {
622         char *p = strchr(s->name + 3, ':');
623         if (!p)
624         {
625             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
626             ccl_qual_rm(&res);
627             return 0;
628         }
629         p++;
630         ccl_qual_fitem(res, s->value, p);
631     }
632     return res;
633 }
634
635 // returns a xmalloced CQL query corresponding to the pquery in client
636 static char *make_cqlquery(struct client *cl)
637 {
638     cql_transform_t cqlt = cql_transform_create();
639     Z_RPNQuery *zquery;
640     char *r;
641     WRBUF wrb = wrbuf_alloc();
642     int status;
643
644     zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
645     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
646     {
647         yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
648         return 0;
649     }
650     r = xstrdup(wrbuf_cstr(wrb));
651
652     wrbuf_destroy(wrb);
653     odr_reset(global_parameters.odr_out); // releases the zquery
654     cql_transform_close(cqlt);
655     return r;
656 }
657
658 // Parse the query given the settings specific to this client
659 int client_parse_query(struct client *cl, const char *query)
660 {
661     struct session *se = client_get_session(cl);
662     struct session_database *sdb = client_get_database(cl);
663     struct ccl_rpn_node *cn;
664     int cerror, cpos;
665     CCL_bibset ccl_map = prepare_cclmap(cl);
666     const char *sru = session_setting_oneval(sdb, PZ_SRU);
667     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
668
669     if (!ccl_map)
670         return -1;
671
672     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
673     ccl_qual_rm(&ccl_map);
674     if (!cn)
675     {
676         client_set_state(cl, Client_Error);
677         yaz_log(YLOG_WARN, "Failed to parse query for %s",
678                          client_get_database(cl)->database->url);
679         return -1;
680     }
681     wrbuf_rewind(se->wrbuf);
682     if (*pqf_prefix)
683     {
684         wrbuf_puts(se->wrbuf, pqf_prefix);
685         wrbuf_puts(se->wrbuf, " ");
686     }
687     ccl_pquery(se->wrbuf, cn);
688     xfree(cl->pquery);
689     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
690
691     xfree(cl->cqlquery);
692     if (*sru)
693     {
694         if (!(cl->cqlquery = make_cqlquery(cl)))
695             return -1;
696     }
697     else
698         cl->cqlquery = 0;
699
700     if (!se->relevance)
701     {
702         // Initialize relevance structure with query terms
703         char *p[512];
704         extract_terms(se->nmem, cn, p);
705         se->relevance = relevance_create(
706             global_parameters.server->relevance_pct,
707             se->nmem, (const char **) p,
708             se->expected_maxrecs);
709     }
710
711     ccl_rpn_delete(cn);
712     return 0;
713 }
714
715 void client_set_session(struct client *cl, struct session *se)
716 {
717     cl->session = se;
718     cl->next = se->clients;
719     se->clients = cl;
720 }
721
722 int client_is_active(struct client *cl)
723 {
724     if (cl->connection && (cl->state == Client_Connecting ||
725                            cl->state == Client_Working))
726         return 1;
727     return 0;
728 }
729
730 struct client *client_next_in_session(struct client *cl)
731 {
732     if (cl)
733         return cl->next;
734     return 0;
735
736 }
737
738 int client_get_hits(struct client *cl)
739 {
740     return cl->hits;
741 }
742
743 int client_get_num_records(struct client *cl)
744 {
745     return cl->record_offset;
746 }
747
748 int client_get_diagnostic(struct client *cl)
749 {
750     return cl->diagnostic;
751 }
752
753 void client_set_database(struct client *cl, struct session_database *db)
754 {
755     cl->database = db;
756 }
757
758 struct host *client_get_host(struct client *cl)
759 {
760     return client_get_database(cl)->database->host;
761 }
762
763 const char *client_get_url(struct client *cl)
764 {
765     return client_get_database(cl)->database->url;
766 }
767
768 /*
769  * Local variables:
770  * c-basic-offset: 4
771  * c-file-style: "Stroustrup"
772  * indent-tabs-mode: nil
773  * End:
774  * vim: shiftwidth=4 tabstop=8 expandtab
775  */
776