1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2010 Index Data
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
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
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
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>
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>
58 #include <yaz/timing.h>
63 #include "parameters.h"
65 #include "connection.h"
67 #include "relevance.h"
70 /** \brief Represents client state for a connection to one search target */
72 struct session_database *database;
73 struct connection *connection;
74 struct session *session;
75 char *pquery; // Current search
76 char *cqlquery; // used for SRU targets only
82 enum client_state state;
83 struct show_raw *show_raw;
84 struct client *next; // next client in session or next in free list
85 ZOOM_resultset resultset;
91 int active; // whether this request has been sent to the server
96 void (*error_handler)(void *data, const char *addinfo);
97 void (*record_handler)(void *data, const char *buf, size_t sz);
99 struct show_raw *next;
102 static const char *client_states[] = {
108 "Client_Disconnected"
111 const char *client_get_state_str(struct client *cl)
113 return client_states[cl->state];
116 enum client_state client_get_state(struct client *cl)
121 void client_set_state(struct client *cl, enum client_state st)
124 /* no need to check for all client being non-active if this one
125 already is. Note that session_active_clients also LOCKS session */
127 if (!client_is_active(cl) && cl->session)
129 int no_active = session_active_clients(cl->session);
131 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
136 static void client_show_raw_error(struct client *cl, const char *addinfo);
138 // Close connection and set state to error
139 void client_fatal(struct client *cl)
141 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
142 connection_destroy(cl->connection);
143 client_set_state(cl, Client_Error);
146 struct connection *client_get_connection(struct client *cl)
148 return cl->connection;
151 struct session_database *client_get_database(struct client *cl)
156 struct session *client_get_session(struct client *cl)
161 const char *client_get_pquery(struct client *cl)
166 static void client_send_raw_present(struct client *cl);
167 static int nativesyntax_to_type(struct session_database *sdb, char *type,
170 static void client_show_immediate(
171 ZOOM_resultset resultset, struct session_database *sdb, int position,
173 void (*error_handler)(void *data, const char *addinfo),
174 void (*record_handler)(void *data, const char *buf, size_t sz),
184 error_handler(data, "no resultset");
187 rec = ZOOM_resultset_record(resultset, position-1);
190 error_handler(data, "no record");
196 nativesyntax_to_type(sdb, type, rec);
197 buf = ZOOM_record_get(rec, type, &len);
200 error_handler(data, "no record");
203 record_handler(data, buf, len);
207 int client_show_raw_begin(struct client *cl, int position,
208 const char *syntax, const char *esn,
210 void (*error_handler)(void *data, const char *addinfo),
211 void (*record_handler)(void *data, const char *buf,
215 if (syntax == 0 && esn == 0)
216 client_show_immediate(cl->resultset, client_get_database(cl),
218 error_handler, record_handler,
222 struct show_raw *rr, **rrp;
228 rr = xmalloc(sizeof(*rr));
229 rr->position = position;
232 rr->error_handler = error_handler;
233 rr->record_handler = record_handler;
236 rr->syntax = xstrdup(syntax);
240 rr->esn = xstrdup(esn);
245 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
249 if (cl->state == Client_Failed)
251 client_show_raw_error(cl, "client failed");
253 else if (cl->state == Client_Disconnected)
255 client_show_raw_error(cl, "client disconnected");
259 client_send_raw_present(cl);
265 static void client_show_raw_delete(struct show_raw *r)
272 void client_show_raw_remove(struct client *cl, void *data)
274 struct show_raw *rr = data;
275 struct show_raw **rrp = &cl->show_raw;
281 client_show_raw_delete(rr);
285 void client_show_raw_dequeue(struct client *cl)
287 struct show_raw *rr = cl->show_raw;
289 cl->show_raw = rr->next;
290 client_show_raw_delete(rr);
293 static void client_show_raw_error(struct client *cl, const char *addinfo)
297 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
298 client_show_raw_dequeue(cl);
302 static void client_send_raw_present(struct client *cl)
304 struct session_database *sdb = client_get_database(cl);
305 struct connection *co = client_get_connection(cl);
306 ZOOM_resultset set = cl->resultset;
308 int offset = cl->show_raw->position;
309 const char *syntax = 0;
310 const char *elements = 0;
312 assert(cl->show_raw);
315 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
316 client_get_url(cl), 1, offset);
318 if (cl->show_raw->syntax)
319 syntax = cl->show_raw->syntax;
321 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
322 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
324 if (cl->show_raw->esn)
325 elements = cl->show_raw->esn;
327 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
328 if (elements && *elements)
329 ZOOM_resultset_option_set(set, "elementSetName", elements);
331 ZOOM_resultset_records(set, 0, offset-1, 1);
332 cl->show_raw->active = 1;
334 connection_continue(co);
337 static int nativesyntax_to_type(struct session_database *sdb, char *type,
340 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
344 if (!strncmp(s, "iso2709", 7))
346 const char *cp = strchr(s, ';');
347 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
349 else if (!strncmp(s, "xml", 3))
353 else if (!strncmp(s, "txml", 4))
355 const char *cp = strchr(s, ';');
356 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
362 else /* attempt to deduce structure */
364 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
367 if (!strcmp(syntax, "XML"))
372 else if (!strcmp(syntax, "TXML"))
374 strcpy(type, "txml");
377 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
379 strcpy(type, "xml; charset=marc8-s");
388 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
394 if (cl->show_raw->binary)
398 struct session_database *sdb = client_get_database(cl);
399 nativesyntax_to_type(sdb, type, rec);
402 buf = ZOOM_record_get(rec, type, &len);
403 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
404 client_show_raw_dequeue(cl);
407 void client_search_response(struct client *cl)
409 struct connection *co = cl->connection;
410 struct session *se = cl->session;
411 ZOOM_connection link = connection_get_link(co);
412 ZOOM_resultset resultset = cl->resultset;
413 const char *error, *addinfo = 0;
415 if (ZOOM_connection_error(link, &error, &addinfo))
418 client_set_state(cl, Client_Error);
419 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
420 error, addinfo, client_get_url(cl));
424 cl->record_offset = cl->startrecs;
425 cl->hits = ZOOM_resultset_size(resultset);
427 se->total_hits += cl->hits;
431 void client_got_records(struct client *cl)
435 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
436 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
440 void client_record_response(struct client *cl)
442 struct connection *co = cl->connection;
443 ZOOM_connection link = connection_get_link(co);
444 ZOOM_resultset resultset = cl->resultset;
445 const char *error, *addinfo;
447 if (ZOOM_connection_error(link, &error, &addinfo))
449 client_set_state(cl, Client_Error);
450 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
451 error, addinfo, client_get_url(cl));
456 const char *msg, *addinfo;
458 if (cl->show_raw && cl->show_raw->active)
460 if ((rec = ZOOM_resultset_record(resultset,
461 cl->show_raw->position-1)))
463 cl->show_raw->active = 0;
464 ingest_raw_record(cl, rec);
468 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
469 cl->show_raw->position-1);
474 int offset = cl->record_offset;
475 if ((rec = ZOOM_resultset_record(resultset, offset)))
478 if (cl->session == 0)
480 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
482 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
483 msg, addinfo, client_get_url(cl),
488 struct session_database *sdb = client_get_database(cl);
489 NMEM nmem = nmem_create();
493 if (nativesyntax_to_type(sdb, type, rec))
494 yaz_log(YLOG_WARN, "Failed to determine record type");
495 xmlrec = ZOOM_record_get(rec, type, NULL);
497 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
501 if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
502 yaz_log(YLOG_WARN, "Failed to ingest from %s",
510 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
517 void client_start_search(struct client *cl)
519 struct session_database *sdb = client_get_database(cl);
520 struct connection *co = client_get_connection(cl);
521 ZOOM_connection link = connection_get_link(co);
523 char *databaseName = sdb->database->databases[0];
524 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
525 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
526 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
527 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
528 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
529 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
530 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
531 char maxrecs_str[24], startrecs_str[24];
536 cl->record_offset = 0;
538 client_set_state(cl, Client_Working);
541 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
543 ZOOM_connection_option_set(link, "piggyback", "1");
545 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
546 if (*opt_sru && *opt_elements)
547 ZOOM_connection_option_set(link, "schema", opt_elements);
548 else if (*opt_elements)
549 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
551 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
555 sprintf(maxrecs_str, "%d", cl->maxrecs);
556 opt_maxrecs = maxrecs_str;
558 ZOOM_connection_option_set(link, "count", opt_maxrecs);
561 if (atoi(opt_maxrecs) > 20)
562 ZOOM_connection_option_set(link, "presentChunk", "20");
564 ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
566 sprintf(startrecs_str, "%d", cl->startrecs);
567 ZOOM_connection_option_set(link, "start", startrecs_str);
570 ZOOM_connection_option_set(link, "databaseName", databaseName);
574 ZOOM_query q = ZOOM_query_create();
575 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
576 ZOOM_query_cql(q, cl->cqlquery);
578 ZOOM_query_sortby(q, opt_sort);
579 rs = ZOOM_connection_search(link, q);
580 ZOOM_query_destroy(q);
584 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
585 rs = ZOOM_connection_search_pqf(link, cl->pquery);
587 ZOOM_resultset_destroy(cl->resultset);
589 connection_continue(co);
592 struct client *client_create(void)
594 struct client *r = xmalloc(sizeof(*r));
603 r->record_offset = 0;
605 r->state = Client_Disconnected;
610 pazpar2_mutex_create(&r->mutex, "client");
617 void client_incref(struct client *c)
619 pazpar2_incref(&c->ref_count, c->mutex);
620 yaz_log(YLOG_DEBUG, "client_incref %s %d", client_get_url(c), c->ref_count);
623 int client_destroy(struct client *c)
627 yaz_log(YLOG_DEBUG, "client_destroy %s %d",
628 client_get_url(c), c->ref_count);
629 if (!pazpar2_decref(&c->ref_count, c->mutex))
637 ZOOM_resultset_destroy(c->resultset);
638 yaz_mutex_destroy(&c->mutex);
646 void client_set_connection(struct client *cl, struct connection *con)
650 assert(cl->connection == 0);
651 cl->connection = con;
656 cl->connection = con;
661 void client_disconnect(struct client *cl)
663 if (cl->state != Client_Idle)
664 client_set_state(cl, Client_Disconnected);
665 client_set_connection(cl, 0);
668 // Extract terms from query into null-terminated termlist
669 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
673 pull_terms(nmem, query, termlist, &num);
677 // Initialize CCL map for a target
678 static CCL_bibset prepare_cclmap(struct client *cl)
680 struct session_database *sdb = client_get_database(cl);
687 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
689 char *p = strchr(s->name + 3, ':');
692 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
697 ccl_qual_fitem(res, s->value, p);
702 // returns a xmalloced CQL query corresponding to the pquery in client
703 static char *make_cqlquery(struct client *cl)
705 cql_transform_t cqlt = cql_transform_create();
708 WRBUF wrb = wrbuf_alloc();
710 ODR odr_out = odr_createmem(ODR_ENCODE);
712 zquery = p_query_rpn(odr_out, cl->pquery);
713 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
714 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
716 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
721 r = xstrdup(wrbuf_cstr(wrb));
724 odr_destroy(odr_out);
725 cql_transform_close(cqlt);
729 // Parse the query given the settings specific to this client
730 int client_parse_query(struct client *cl, const char *query)
732 struct session *se = client_get_session(cl);
733 struct session_database *sdb = client_get_database(cl);
734 struct ccl_rpn_node *cn;
736 CCL_bibset ccl_map = prepare_cclmap(cl);
737 const char *sru = session_setting_oneval(sdb, PZ_SRU);
738 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
739 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
744 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
745 ccl_qual_rm(&ccl_map);
748 client_set_state(cl, Client_Error);
749 yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
751 client_get_database(cl)->database->url);
754 wrbuf_rewind(se->wrbuf);
757 wrbuf_puts(se->wrbuf, pqf_prefix);
758 wrbuf_puts(se->wrbuf, " ");
760 if (!pqf_strftime || !*pqf_strftime)
761 ccl_pquery(se->wrbuf, cn);
764 time_t cur_time = time(0);
765 struct tm *tm = localtime(&cur_time);
767 const char *cp = tmp_str;
769 /* see man strftime(3) for things .. In particular %% gets converted
770 to %.. And That's our original query .. */
771 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
775 ccl_pquery(se->wrbuf, cn);
777 wrbuf_putc(se->wrbuf, cp[0]);
781 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
786 if (!(cl->cqlquery = make_cqlquery(cl)))
794 // Initialize relevance structure with query terms
796 extract_terms(se->nmem, cn, p);
797 se->relevance = relevance_create(
798 se->service->relevance_pct,
799 se->nmem, (const char **) p);
807 void client_remove_from_session(struct client *c)
816 struct client **ccp = &se->clients;
818 while (*ccp && *ccp != c)
830 void client_set_session(struct client *cl, struct session *se)
833 cl->next = se->clients;
837 int client_is_active(struct client *cl)
839 if (cl->connection && (cl->state == Client_Connecting ||
840 cl->state == Client_Working))
845 struct client *client_next_in_session(struct client *cl)
853 Odr_int client_get_hits(struct client *cl)
858 int client_get_num_records(struct client *cl)
860 return cl->record_offset;
863 void client_set_diagnostic(struct client *cl, int diagnostic)
865 cl->diagnostic = diagnostic;
868 int client_get_diagnostic(struct client *cl)
870 return cl->diagnostic;
873 void client_set_database(struct client *cl, struct session_database *db)
878 struct host *client_get_host(struct client *cl)
880 return client_get_database(cl)->database->host;
883 const char *client_get_url(struct client *cl)
886 return client_get_database(cl)->database->url;
891 void client_set_maxrecs(struct client *cl, int v)
896 void client_set_startrecs(struct client *cl, int v)
904 * c-file-style: "Stroustrup"
905 * indent-tabs-mode: nil
907 * vim: shiftwidth=4 tabstop=8 expandtab