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>
62 #include "parameters.h"
64 #include "connection.h"
66 #include "relevance.h"
69 /** \brief Represents client state for a connection to one search target */
71 struct session_database *database;
72 struct connection *connection;
73 struct session *session;
74 char *pquery; // Current search
75 char *cqlquery; // used for SRU targets only
81 enum client_state state;
82 struct show_raw *show_raw;
83 struct client *next; // next client in session or next in free list
84 ZOOM_resultset resultset;
90 int active; // whether this request has been sent to the server
95 void (*error_handler)(void *data, const char *addinfo);
96 void (*record_handler)(void *data, const char *buf, size_t sz);
98 struct show_raw *next;
101 static const char *client_states[] = {
107 "Client_Disconnected"
110 static void client_enter(struct client *cl)
112 yaz_mutex_enter(cl->mutex);
115 static void client_leave(struct client *cl)
117 yaz_mutex_leave(cl->mutex);
121 const char *client_get_state_str(struct client *cl)
123 return client_states[cl->state];
126 enum client_state client_get_state(struct client *cl)
131 void client_set_state(struct client *cl, enum client_state st)
134 /* no need to check for all client being non-active if this one
135 already is. Note that session_active_clients also LOCKS session */
137 if (!client_is_active(cl) && cl->session)
139 int no_active = session_active_clients(cl->session);
141 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
146 static void client_show_raw_error(struct client *cl, const char *addinfo);
148 // Close connection and set state to error
149 void client_fatal(struct client *cl)
151 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
152 connection_destroy(cl->connection);
153 client_set_state(cl, Client_Error);
156 struct connection *client_get_connection(struct client *cl)
158 return cl->connection;
161 struct session_database *client_get_database(struct client *cl)
166 struct session *client_get_session(struct client *cl)
171 const char *client_get_pquery(struct client *cl)
176 static void client_send_raw_present(struct client *cl);
177 static int nativesyntax_to_type(struct session_database *sdb, char *type,
180 static void client_show_immediate(
181 ZOOM_resultset resultset, struct session_database *sdb, int position,
183 void (*error_handler)(void *data, const char *addinfo),
184 void (*record_handler)(void *data, const char *buf, size_t sz),
194 error_handler(data, "no resultset");
197 rec = ZOOM_resultset_record(resultset, position-1);
200 error_handler(data, "no record");
206 nativesyntax_to_type(sdb, type, rec);
207 buf = ZOOM_record_get(rec, type, &len);
210 error_handler(data, "no record");
213 record_handler(data, buf, len);
217 int client_show_raw_begin(struct client *cl, int position,
218 const char *syntax, const char *esn,
220 void (*error_handler)(void *data, const char *addinfo),
221 void (*record_handler)(void *data, const char *buf,
225 if (syntax == 0 && esn == 0)
226 client_show_immediate(cl->resultset, client_get_database(cl),
228 error_handler, record_handler,
232 struct show_raw *rr, **rrp;
238 rr = xmalloc(sizeof(*rr));
239 rr->position = position;
242 rr->error_handler = error_handler;
243 rr->record_handler = record_handler;
246 rr->syntax = xstrdup(syntax);
250 rr->esn = xstrdup(esn);
255 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
259 if (cl->state == Client_Failed)
261 client_show_raw_error(cl, "client failed");
263 else if (cl->state == Client_Disconnected)
265 client_show_raw_error(cl, "client disconnected");
269 client_send_raw_present(cl);
275 static void client_show_raw_delete(struct show_raw *r)
282 void client_show_raw_remove(struct client *cl, void *data)
284 struct show_raw *rr = data;
285 struct show_raw **rrp = &cl->show_raw;
291 client_show_raw_delete(rr);
295 void client_show_raw_dequeue(struct client *cl)
297 struct show_raw *rr = cl->show_raw;
299 cl->show_raw = rr->next;
300 client_show_raw_delete(rr);
303 static void client_show_raw_error(struct client *cl, const char *addinfo)
307 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
308 client_show_raw_dequeue(cl);
312 static void client_send_raw_present(struct client *cl)
314 struct session_database *sdb = client_get_database(cl);
315 struct connection *co = client_get_connection(cl);
316 ZOOM_resultset set = cl->resultset;
318 int offset = cl->show_raw->position;
319 const char *syntax = 0;
320 const char *elements = 0;
322 assert(cl->show_raw);
325 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
326 client_get_url(cl), 1, offset);
328 if (cl->show_raw->syntax)
329 syntax = cl->show_raw->syntax;
331 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
332 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
334 if (cl->show_raw->esn)
335 elements = cl->show_raw->esn;
337 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
338 if (elements && *elements)
339 ZOOM_resultset_option_set(set, "elementSetName", elements);
341 ZOOM_resultset_records(set, 0, offset-1, 1);
342 cl->show_raw->active = 1;
344 connection_continue(co);
347 static int nativesyntax_to_type(struct session_database *sdb, char *type,
350 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
354 if (!strncmp(s, "iso2709", 7))
356 const char *cp = strchr(s, ';');
357 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
359 else if (!strncmp(s, "xml", 3))
367 else /* attempt to deduce structure */
369 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
372 if (!strcmp(syntax, "XML"))
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 static void 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_search_response(struct client *cl)
436 static void record_response(struct client *cl)
438 struct connection *co = cl->connection;
439 ZOOM_connection link = connection_get_link(co);
440 ZOOM_resultset resultset = cl->resultset;
441 const char *error, *addinfo;
443 if (ZOOM_connection_error(link, &error, &addinfo))
445 client_set_state(cl, Client_Error);
446 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
447 error, addinfo, client_get_url(cl));
452 const char *msg, *addinfo;
454 if (cl->show_raw && cl->show_raw->active)
456 if ((rec = ZOOM_resultset_record(resultset,
457 cl->show_raw->position-1)))
459 cl->show_raw->active = 0;
460 ingest_raw_record(cl, rec);
464 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
465 cl->show_raw->position-1);
470 int offset = cl->record_offset;
471 if ((rec = ZOOM_resultset_record(resultset, offset)))
474 if (cl->session == 0)
476 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
477 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
478 error, addinfo, client_get_url(cl),
482 struct session_database *sdb = client_get_database(cl);
483 NMEM nmem = nmem_create();
486 if (nativesyntax_to_type(sdb, type, rec))
487 yaz_log(YLOG_WARN, "Failed to determine record type");
488 xmlrec = ZOOM_record_get(rec, type, NULL);
490 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
494 if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
495 yaz_log(YLOG_WARN, "Failed to ingest from %s",
499 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
500 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
508 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
515 void client_record_response(struct client *cl)
520 void client_start_search(struct client *cl)
522 struct session_database *sdb = client_get_database(cl);
523 struct connection *co = client_get_connection(cl);
524 ZOOM_connection link = connection_get_link(co);
526 char *databaseName = sdb->database->databases[0];
527 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
528 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
529 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
530 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
531 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
532 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
533 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
534 char maxrecs_str[24], startrecs_str[24];
539 cl->record_offset = 0;
541 client_set_state(cl, Client_Working);
544 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
546 ZOOM_connection_option_set(link, "piggyback", "1");
548 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
549 if (*opt_sru && *opt_elements)
550 ZOOM_connection_option_set(link, "schema", opt_elements);
551 else if (*opt_elements)
552 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
554 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
558 sprintf(maxrecs_str, "%d", cl->maxrecs);
559 opt_maxrecs = maxrecs_str;
561 ZOOM_connection_option_set(link, "count", opt_maxrecs);
564 if (atoi(opt_maxrecs) > 20)
565 ZOOM_connection_option_set(link, "presentChunk", "20");
567 ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
569 sprintf(startrecs_str, "%d", cl->startrecs);
570 ZOOM_connection_option_set(link, "start", startrecs_str);
573 ZOOM_connection_option_set(link, "databaseName", databaseName);
577 ZOOM_query q = ZOOM_query_create();
578 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
579 ZOOM_query_cql(q, cl->cqlquery);
581 ZOOM_query_sortby(q, opt_sort);
582 rs = ZOOM_connection_search(link, q);
583 ZOOM_query_destroy(q);
587 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
588 rs = ZOOM_connection_search_pqf(link, cl->pquery);
590 ZOOM_resultset_destroy(cl->resultset);
592 connection_continue(co);
595 struct client *client_create(void)
597 struct client *r = xmalloc(sizeof(*r));
606 r->record_offset = 0;
608 r->state = Client_Disconnected;
613 yaz_mutex_create(&r->mutex);
619 void client_incref(struct client *c)
621 pazpar2_incref(&c->ref_count, c->mutex);
622 yaz_log(YLOG_LOG, "client_incref %s %d", client_get_url(c), c->ref_count);
625 int client_destroy(struct client *c)
629 yaz_log(YLOG_LOG, "client_destroy %s %d",
630 client_get_url(c), c->ref_count);
631 if (!pazpar2_decref(&c->ref_count, c->mutex))
642 connection_release(c->connection);
644 ZOOM_resultset_destroy(c->resultset);
645 yaz_mutex_destroy(&c->mutex);
653 void client_set_connection(struct client *cl, struct connection *con)
657 assert(cl->connection == 0);
658 cl->connection = con;
663 cl->connection = con;
668 void client_disconnect(struct client *cl)
670 if (cl->state != Client_Idle)
671 client_set_state(cl, Client_Disconnected);
672 client_set_connection(cl, 0);
675 // Extract terms from query into null-terminated termlist
676 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
680 pull_terms(nmem, query, termlist, &num);
684 // Initialize CCL map for a target
685 static CCL_bibset prepare_cclmap(struct client *cl)
687 struct session_database *sdb = client_get_database(cl);
694 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
696 char *p = strchr(s->name + 3, ':');
699 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
704 ccl_qual_fitem(res, s->value, p);
709 // returns a xmalloced CQL query corresponding to the pquery in client
710 static char *make_cqlquery(struct client *cl)
712 cql_transform_t cqlt = cql_transform_create();
715 WRBUF wrb = wrbuf_alloc();
717 ODR odr_out = odr_createmem(ODR_ENCODE);
719 zquery = p_query_rpn(odr_out, cl->pquery);
720 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
721 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
723 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
728 r = xstrdup(wrbuf_cstr(wrb));
731 odr_destroy(odr_out);
732 cql_transform_close(cqlt);
736 // Parse the query given the settings specific to this client
737 int client_parse_query(struct client *cl, const char *query)
739 struct session *se = client_get_session(cl);
740 struct session_database *sdb = client_get_database(cl);
741 struct ccl_rpn_node *cn;
743 CCL_bibset ccl_map = prepare_cclmap(cl);
744 const char *sru = session_setting_oneval(sdb, PZ_SRU);
745 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
746 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
751 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
752 ccl_qual_rm(&ccl_map);
755 client_set_state(cl, Client_Error);
756 yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
758 client_get_database(cl)->database->url);
761 wrbuf_rewind(se->wrbuf);
764 wrbuf_puts(se->wrbuf, pqf_prefix);
765 wrbuf_puts(se->wrbuf, " ");
767 if (!pqf_strftime || !*pqf_strftime)
768 ccl_pquery(se->wrbuf, cn);
771 time_t cur_time = time(0);
772 struct tm *tm = localtime(&cur_time);
774 const char *cp = tmp_str;
776 /* see man strftime(3) for things .. In particular %% gets converted
777 to %.. And That's our original query .. */
778 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
782 ccl_pquery(se->wrbuf, cn);
784 wrbuf_putc(se->wrbuf, cp[0]);
788 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
793 if (!(cl->cqlquery = make_cqlquery(cl)))
801 // Initialize relevance structure with query terms
803 extract_terms(se->nmem, cn, p);
804 se->relevance = relevance_create(
805 se->service->relevance_pct,
806 se->nmem, (const char **) p);
814 void client_remove_from_session(struct client *c)
816 struct session *se = c->session;
821 struct client **ccp = &se->clients;
823 while (*ccp && *ccp != c)
833 void client_set_session(struct client *cl, struct session *se)
836 cl->next = se->clients;
840 int client_is_active(struct client *cl)
842 if (cl->connection && (cl->state == Client_Connecting ||
843 cl->state == Client_Working))
848 struct client *client_next_in_session(struct client *cl)
856 Odr_int client_get_hits(struct client *cl)
861 int client_get_num_records(struct client *cl)
863 return cl->record_offset;
866 void client_set_diagnostic(struct client *cl, int diagnostic)
868 cl->diagnostic = diagnostic;
871 int client_get_diagnostic(struct client *cl)
873 return cl->diagnostic;
876 void client_set_database(struct client *cl, struct session_database *db)
881 struct host *client_get_host(struct client *cl)
883 return client_get_database(cl)->database->host;
886 const char *client_get_url(struct client *cl)
888 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