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
78 enum client_state state;
79 struct show_raw *show_raw;
80 struct client *next; // next client in session or next in free list
84 int active; // whether this request has been sent to the server
89 void (*error_handler)(void *data, const char *addinfo);
90 void (*record_handler)(void *data, const char *buf, size_t sz);
92 struct show_raw *next;
95 static const char *client_states[] = {
101 "Client_Disconnected"
104 static struct client *client_freelist = 0;
106 const char *client_get_state_str(struct client *cl)
108 return client_states[cl->state];
111 enum client_state client_get_state(struct client *cl)
116 void client_set_state(struct client *cl, enum client_state st)
121 int no_active = session_active_clients(cl->session);
123 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
127 static void client_show_raw_error(struct client *cl, const char *addinfo);
129 // Close connection and set state to error
130 void client_fatal(struct client *cl)
132 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
133 connection_destroy(cl->connection);
134 client_set_state(cl, Client_Error);
137 struct connection *client_get_connection(struct client *cl)
139 return cl->connection;
142 struct session_database *client_get_database(struct client *cl)
147 struct session *client_get_session(struct client *cl)
152 const char *client_get_pquery(struct client *cl)
157 static void client_send_raw_present(struct client *cl);
159 int client_show_raw_begin(struct client *cl, int position,
160 const char *syntax, const char *esn,
162 void (*error_handler)(void *data, const char *addinfo),
163 void (*record_handler)(void *data, const char *buf,
168 struct show_raw *rr, **rrp;
170 { /* the client has no connection */
173 rr = xmalloc(sizeof(*rr));
175 rr->position = position;
178 rr->error_handler = error_handler;
179 rr->record_handler = record_handler;
182 rr->syntax = xstrdup(syntax);
186 rr->esn = xstrdup(esn);
191 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
195 if (cl->state == Client_Failed)
197 client_show_raw_error(cl, "client failed");
199 else if (cl->state == Client_Disconnected)
201 client_show_raw_error(cl, "client disconnected");
205 client_send_raw_present(cl);
210 void client_show_raw_remove(struct client *cl, void *data)
212 struct show_raw *rr = data;
213 struct show_raw **rrp = &cl->show_raw;
223 void client_show_raw_dequeue(struct client *cl)
225 struct show_raw *rr = cl->show_raw;
227 cl->show_raw = rr->next;
231 static void client_show_raw_error(struct client *cl, const char *addinfo)
235 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
236 client_show_raw_dequeue(cl);
240 static void client_send_raw_present(struct client *cl)
242 struct session_database *sdb = client_get_database(cl);
243 struct connection *co = client_get_connection(cl);
244 ZOOM_resultset set = connection_get_resultset(co);
246 int offset = cl->show_raw->position;
247 const char *syntax = 0;
248 const char *elements = 0;
250 assert(cl->show_raw);
253 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
254 client_get_url(cl), 1, offset);
256 if (cl->show_raw->syntax)
257 syntax = cl->show_raw->syntax;
259 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
260 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
262 if (cl->show_raw->esn)
263 elements = cl->show_raw->esn;
265 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
266 if (elements && *elements)
267 ZOOM_resultset_option_set(set, "elementSetName", elements);
269 ZOOM_resultset_records(set, 0, offset-1, 1);
270 cl->show_raw->active = 1;
272 connection_continue(co);
275 static int nativesyntax_to_type(struct session_database *sdb, char *type)
277 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
281 if (!strncmp(s, "iso2709", 7))
283 const char *cp = strchr(s, ';');
284 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
286 else if (!strncmp(s, "xml", 3))
297 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
303 if (cl->show_raw->binary)
307 struct session_database *sdb = client_get_database(cl);
308 nativesyntax_to_type(sdb, type);
311 buf = ZOOM_record_get(rec, type, &len);
312 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
313 client_show_raw_dequeue(cl);
316 void client_search_response(struct client *cl)
318 struct connection *co = cl->connection;
319 struct session *se = cl->session;
320 ZOOM_connection link = connection_get_link(co);
321 ZOOM_resultset resultset = connection_get_resultset(co);
322 const char *error, *addinfo;
324 if (ZOOM_connection_error(link, &error, &addinfo))
327 client_set_state(cl, Client_Error);
328 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
329 error, addinfo, client_get_url(cl));
333 cl->record_offset = 0;
334 cl->hits = ZOOM_resultset_size(resultset);
335 se->total_hits += cl->hits;
340 void client_record_response(struct client *cl)
342 struct connection *co = cl->connection;
343 ZOOM_connection link = connection_get_link(co);
344 ZOOM_resultset resultset = connection_get_resultset(co);
345 const char *error, *addinfo;
347 if (ZOOM_connection_error(link, &error, &addinfo))
349 client_set_state(cl, Client_Error);
350 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
351 error, addinfo, client_get_url(cl));
356 const char *msg, *addinfo;
358 if (cl->show_raw && cl->show_raw->active)
360 if ((rec = ZOOM_resultset_record(resultset,
361 cl->show_raw->position-1)))
363 cl->show_raw->active = 0;
364 ingest_raw_record(cl, rec);
368 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
369 cl->show_raw->position-1);
374 int offset = cl->record_offset;
375 if ((rec = ZOOM_resultset_record(resultset, offset)))
378 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
379 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
380 error, addinfo, client_get_url(cl),
384 struct session_database *sdb = client_get_database(cl);
387 nativesyntax_to_type(sdb, type);
388 if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
390 if (ingest_record(cl, xmlrec, cl->record_offset))
392 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
393 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
396 yaz_log(YLOG_WARN, "Failed to ingest");
399 yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
405 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
412 void client_start_search(struct client *cl)
414 struct session_database *sdb = client_get_database(cl);
415 struct connection *co = client_get_connection(cl);
416 ZOOM_connection link = connection_get_link(co);
418 char *databaseName = sdb->database->databases[0];
419 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
420 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
421 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
422 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
423 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
424 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
429 cl->record_offset = 0;
431 client_set_state(cl, Client_Working);
434 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
436 ZOOM_connection_option_set(link, "piggyback", "1");
438 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
439 if (*opt_sru && *opt_elements)
440 ZOOM_connection_option_set(link, "schema", opt_elements);
441 else if (*opt_elements)
442 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
444 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
446 ZOOM_connection_option_set(link, "count", opt_maxrecs);
450 sprintf(n, "%d", global_parameters.toget);
451 ZOOM_connection_option_set(link, "count", n);
454 ZOOM_connection_option_set(link, "databaseName", databaseName);
456 ZOOM_connection_option_set(link, "presentChunk", "20");
460 ZOOM_query q = ZOOM_query_create();
461 ZOOM_query_cql(q, cl->cqlquery);
462 rs = ZOOM_connection_search(link, q);
463 ZOOM_query_destroy(q);
466 rs = ZOOM_connection_search_pqf(link, cl->pquery);
467 connection_set_resultset(co, rs);
468 connection_continue(co);
471 struct client *client_create(void)
477 client_freelist = client_freelist->next;
480 r = xmalloc(sizeof(struct client));
487 r->record_offset = 0;
489 r->state = Client_Disconnected;
495 void client_destroy(struct client *c)
497 struct session *se = c->session;
498 if (c == se->clients)
499 se->clients = c->next;
503 for (cc = se->clients; cc && cc->next != c; cc = cc->next)
512 connection_release(c->connection);
513 c->next = client_freelist;
517 void client_set_connection(struct client *cl, struct connection *con)
519 cl->connection = con;
522 void client_disconnect(struct client *cl)
524 if (cl->state != Client_Idle)
525 client_set_state(cl, Client_Disconnected);
526 client_set_connection(cl, 0);
529 // Extract terms from query into null-terminated termlist
530 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
534 pull_terms(nmem, query, termlist, &num);
538 // Initialize CCL map for a target
539 static CCL_bibset prepare_cclmap(struct client *cl)
541 struct session_database *sdb = client_get_database(cl);
548 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
550 char *p = strchr(s->name + 3, ':');
553 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
558 ccl_qual_fitem(res, s->value, p);
563 // returns a xmalloced CQL query corresponding to the pquery in client
564 static char *make_cqlquery(struct client *cl)
566 cql_transform_t cqlt = cql_transform_create();
569 WRBUF wrb = wrbuf_alloc();
572 zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
573 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
575 yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
578 r = xstrdup(wrbuf_cstr(wrb));
581 odr_reset(global_parameters.odr_out); // releases the zquery
582 cql_transform_close(cqlt);
586 // Parse the query given the settings specific to this client
587 int client_parse_query(struct client *cl, const char *query)
589 struct session *se = client_get_session(cl);
590 struct session_database *sdb = client_get_database(cl);
591 struct ccl_rpn_node *cn;
593 CCL_bibset ccl_map = prepare_cclmap(cl);
594 const char *sru = session_setting_oneval(sdb, PZ_SRU);
599 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
600 ccl_qual_rm(&ccl_map);
603 client_set_state(cl, Client_Error);
604 yaz_log(YLOG_WARN, "Failed to parse query for %s",
605 client_get_database(cl)->database->url);
608 wrbuf_rewind(se->wrbuf);
609 ccl_pquery(se->wrbuf, cn);
611 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
616 if (!(cl->cqlquery = make_cqlquery(cl)))
624 // Initialize relevance structure with query terms
626 extract_terms(se->nmem, cn, p);
627 se->relevance = relevance_create(
628 global_parameters.server->relevance_pct,
629 se->nmem, (const char **) p,
630 se->expected_maxrecs);
637 void client_set_session(struct client *cl, struct session *se)
640 cl->next = se->clients;
644 int client_is_active(struct client *cl)
646 if (cl->connection && (cl->state == Client_Connecting ||
647 cl->state == Client_Working))
652 struct client *client_next_in_session(struct client *cl)
660 int client_get_hits(struct client *cl)
665 int client_get_num_records(struct client *cl)
667 return cl->record_offset;
670 int client_get_diagnostic(struct client *cl)
672 return cl->diagnostic;
675 void client_set_database(struct client *cl, struct session_database *db)
680 struct host *client_get_host(struct client *cl)
682 return client_get_database(cl)->database->host;
685 const char *client_get_url(struct client *cl)
687 return client_get_database(cl)->database->url;
693 * indent-tabs-mode: nil
695 * vim: shiftwidth=4 tabstop=8 expandtab