1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2008 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
41 #include <yaz/marcdisp.h>
42 #include <yaz/comstack.h>
43 #include <yaz/tcpip.h>
44 #include <yaz/proto.h>
45 #include <yaz/readconf.h>
46 #include <yaz/pquery.h>
47 #include <yaz/otherinfo.h>
48 #include <yaz/yaz-util.h>
50 #include <yaz/query-charset.h>
51 #include <yaz/querytowrbuf.h>
52 #include <yaz/oid_db.h>
53 #include <yaz/diagbib1.h>
54 #include <yaz/snprintf.h>
55 #include <yaz/rpn2cql.h>
59 #include <yaz/timing.h>
65 #include "connection.h"
68 /** \brief Represents client state for a connection to one search target */
70 struct session_database *database;
71 struct connection *connection;
72 struct session *session;
73 char *pquery; // Current search
74 char *cqlquery; // used for SRU targets only
79 enum client_state state;
80 struct show_raw *show_raw;
81 struct client *next; // next client in session or next in free list
85 int active; // whether this request has been sent to the server
90 void (*error_handler)(void *data, const char *addinfo);
91 void (*record_handler)(void *data, const char *buf, size_t sz);
93 struct show_raw *next;
96 static const char *client_states[] = {
102 "Client_Disconnected",
107 static struct client *client_freelist = 0;
109 const char *client_get_state_str(struct client *cl)
111 return client_states[cl->state];
114 enum client_state client_get_state(struct client *cl)
119 void client_set_state(struct client *cl, enum client_state st)
124 int no_active = session_active_clients(cl->session);
126 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
130 static void client_show_raw_error(struct client *cl, const char *addinfo);
132 // Close connection and set state to error
133 void client_fatal(struct client *cl)
135 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
136 connection_destroy(cl->connection);
137 client_set_state(cl, Client_Error);
140 struct connection *client_get_connection(struct client *cl)
142 return cl->connection;
145 struct session_database *client_get_database(struct client *cl)
150 struct session *client_get_session(struct client *cl)
155 const char *client_get_pquery(struct client *cl)
160 static void client_send_raw_present(struct client *cl);
162 int client_show_raw_begin(struct client *cl, int position,
163 const char *syntax, const char *esn,
165 void (*error_handler)(void *data, const char *addinfo),
166 void (*record_handler)(void *data, const char *buf,
171 struct show_raw *rr, **rrp;
173 { /* the client has no connection */
176 rr = xmalloc(sizeof(*rr));
178 rr->position = position;
181 rr->error_handler = error_handler;
182 rr->record_handler = record_handler;
185 rr->syntax = xstrdup(syntax);
189 rr->esn = xstrdup(esn);
194 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
198 if (cl->state == Client_Failed)
200 client_show_raw_error(cl, "client failed");
202 else if (cl->state == Client_Disconnected)
204 client_show_raw_error(cl, "client disconnected");
208 client_send_raw_present(cl);
213 void client_show_raw_remove(struct client *cl, void *data)
215 struct show_raw *rr = data;
216 struct show_raw **rrp = &cl->show_raw;
226 void client_show_raw_dequeue(struct client *cl)
228 struct show_raw *rr = cl->show_raw;
230 cl->show_raw = rr->next;
234 static void client_show_raw_error(struct client *cl, const char *addinfo)
238 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
239 client_show_raw_dequeue(cl);
243 static void client_send_raw_present(struct client *cl)
245 struct session_database *sdb = client_get_database(cl);
246 struct connection *co = client_get_connection(cl);
247 ZOOM_resultset set = connection_get_resultset(co);
249 int offset = cl->show_raw->position;
250 const char *syntax = 0;
251 const char *elements = 0;
253 assert(cl->show_raw);
256 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
257 client_get_url(cl), 1, offset);
259 if (cl->show_raw->syntax)
260 syntax = cl->show_raw->syntax;
262 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
263 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
265 if (cl->show_raw->esn)
266 elements = cl->show_raw->esn;
268 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
269 if (elements && *elements)
270 ZOOM_resultset_option_set(set, "elementSetName", elements);
272 ZOOM_resultset_records(set, 0, offset-1, 1);
273 cl->show_raw->active = 1;
275 connection_continue(co);
278 static int nativesyntax_to_type(struct session_database *sdb, char *type)
280 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
284 if (!strncmp(s, "iso2709", 7))
286 const char *cp = strchr(s, ';');
287 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
289 else if (!strncmp(s, "xml", 3))
300 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
306 if (cl->show_raw->binary)
310 struct session_database *sdb = client_get_database(cl);
311 nativesyntax_to_type(sdb, type);
314 buf = ZOOM_record_get(rec, type, &len);
315 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
316 client_show_raw_dequeue(cl);
319 void client_search_response(struct client *cl)
321 struct connection *co = cl->connection;
322 struct session *se = cl->session;
323 ZOOM_connection link = connection_get_link(co);
324 ZOOM_resultset resultset = connection_get_resultset(co);
325 const char *error, *addinfo;
327 if (ZOOM_connection_error(link, &error, &addinfo))
330 client_set_state(cl, Client_Error);
331 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
332 error, addinfo, client_get_url(cl));
336 cl->record_offset = 0;
337 cl->hits = ZOOM_resultset_size(resultset);
338 se->total_hits += cl->hits;
343 void client_record_response(struct client *cl)
345 struct connection *co = cl->connection;
346 ZOOM_connection link = connection_get_link(co);
347 ZOOM_resultset resultset = connection_get_resultset(co);
348 const char *error, *addinfo;
350 if (ZOOM_connection_error(link, &error, &addinfo))
352 client_set_state(cl, Client_Error);
353 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
354 error, addinfo, client_get_url(cl));
359 const char *msg, *addinfo;
361 if (cl->show_raw && cl->show_raw->active)
363 if ((rec = ZOOM_resultset_record(resultset,
364 cl->show_raw->position-1)))
366 cl->show_raw->active = 0;
367 ingest_raw_record(cl, rec);
371 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
372 cl->show_raw->position-1);
377 int offset = cl->record_offset;
378 if ((rec = ZOOM_resultset_record(resultset, offset)))
381 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
382 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
383 error, addinfo, client_get_url(cl),
387 struct session_database *sdb = client_get_database(cl);
390 nativesyntax_to_type(sdb, type);
391 if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
393 if (ingest_record(cl, xmlrec, cl->record_offset))
395 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
396 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
399 yaz_log(YLOG_WARN, "Failed to ingest");
402 yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
408 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
415 void client_start_search(struct client *cl)
417 struct session_database *sdb = client_get_database(cl);
418 struct connection *co = client_get_connection(cl);
419 ZOOM_connection link = connection_get_link(co);
421 char *databaseName = sdb->database->databases[0];
422 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
423 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
424 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
425 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
426 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
427 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
432 cl->record_offset = 0;
434 client_set_state(cl, Client_Working);
437 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
439 ZOOM_connection_option_set(link, "piggyback", "1");
441 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
442 if (*opt_sru && *opt_elements)
443 ZOOM_connection_option_set(link, "schema", opt_elements);
444 else if (*opt_elements)
445 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
447 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
449 ZOOM_connection_option_set(link, "count", opt_maxrecs);
453 sprintf(n, "%d", global_parameters.toget);
454 ZOOM_connection_option_set(link, "count", n);
457 ZOOM_connection_option_set(link, "databaseName", databaseName);
459 ZOOM_connection_option_set(link, "presentChunk", "20");
463 ZOOM_query q = ZOOM_query_create();
464 ZOOM_query_cql(q, cl->cqlquery);
465 rs = ZOOM_connection_search(link, q);
466 ZOOM_query_destroy(q);
469 rs = ZOOM_connection_search_pqf(link, cl->pquery);
470 connection_set_resultset(co, rs);
471 connection_continue(co);
474 struct client *client_create(void)
480 client_freelist = client_freelist->next;
483 r = xmalloc(sizeof(struct client));
490 r->record_offset = 0;
493 r->state = Client_Disconnected;
499 void client_destroy(struct client *c)
501 struct session *se = c->session;
502 if (c == se->clients)
503 se->clients = c->next;
507 for (cc = se->clients; cc && cc->next != c; cc = cc->next)
516 connection_release(c->connection);
517 c->next = client_freelist;
521 void client_set_connection(struct client *cl, struct connection *con)
523 cl->connection = con;
526 void client_disconnect(struct client *cl)
528 if (cl->state != Client_Idle)
529 client_set_state(cl, Client_Disconnected);
530 client_set_connection(cl, 0);
533 // Extract terms from query into null-terminated termlist
534 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
538 pull_terms(nmem, query, termlist, &num);
542 // Initialize CCL map for a target
543 static CCL_bibset prepare_cclmap(struct client *cl)
545 struct session_database *sdb = client_get_database(cl);
552 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
554 char *p = strchr(s->name + 3, ':');
557 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
562 ccl_qual_fitem(res, s->value, p);
567 // returns a xmalloced CQL query corresponding to the pquery in client
568 static char *make_cqlquery(struct client *cl)
570 cql_transform_t cqlt = cql_transform_create();
573 WRBUF wrb = wrbuf_alloc();
576 zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
577 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
579 yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
582 r = xstrdup(wrbuf_cstr(wrb));
585 odr_reset(global_parameters.odr_out); // releases the zquery
586 cql_transform_close(cqlt);
590 // Parse the query given the settings specific to this client
591 int client_parse_query(struct client *cl, const char *query)
593 struct session *se = client_get_session(cl);
594 struct session_database *sdb = client_get_database(cl);
595 struct ccl_rpn_node *cn;
597 CCL_bibset ccl_map = prepare_cclmap(cl);
598 const char *sru = session_setting_oneval(sdb, PZ_SRU);
603 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
604 ccl_qual_rm(&ccl_map);
607 client_set_state(cl, Client_Error);
608 yaz_log(YLOG_WARN, "Failed to parse query for %s",
609 client_get_database(cl)->database->url);
612 wrbuf_rewind(se->wrbuf);
613 ccl_pquery(se->wrbuf, cn);
615 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
620 if (!(cl->cqlquery = make_cqlquery(cl)))
628 // Initialize relevance structure with query terms
630 extract_terms(se->nmem, cn, p);
631 se->relevance = relevance_create(
632 global_parameters.server->relevance_pct,
633 se->nmem, (const char **) p,
634 se->expected_maxrecs);
641 void client_set_session(struct client *cl, struct session *se)
644 cl->next = se->clients;
648 int client_is_active(struct client *cl)
650 if (cl->connection && (cl->state == Client_Continue ||
651 cl->state == Client_Connecting ||
652 cl->state == Client_Working))
657 struct client *client_next_in_session(struct client *cl)
665 int client_get_hits(struct client *cl)
670 int client_get_num_records(struct client *cl)
672 return cl->record_offset;
675 int client_get_diagnostic(struct client *cl)
677 return cl->diagnostic;
680 void client_set_database(struct client *cl, struct session_database *db)
685 struct host *client_get_host(struct client *cl)
687 return client_get_database(cl)->database->host;
690 const char *client_get_url(struct client *cl)
692 return client_get_database(cl)->database->url;
698 * indent-tabs-mode: nil
700 * vim: shiftwidth=4 tabstop=8 expandtab