1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2009 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>
64 #include "connection.h"
67 /** \brief Represents client state for a connection to one search target */
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
77 enum client_state state;
78 struct show_raw *show_raw;
79 struct client *next; // next client in session or next in free list
83 int active; // whether this request has been sent to the server
88 void (*error_handler)(void *data, const char *addinfo);
89 void (*record_handler)(void *data, const char *buf, size_t sz);
91 struct show_raw *next;
94 static const char *client_states[] = {
100 "Client_Disconnected"
103 static struct client *client_freelist = 0;
105 const char *client_get_state_str(struct client *cl)
107 return client_states[cl->state];
110 enum client_state client_get_state(struct client *cl)
115 void client_set_state(struct client *cl, enum client_state st)
120 int no_active = session_active_clients(cl->session);
122 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
126 static void client_show_raw_error(struct client *cl, const char *addinfo);
128 // Close connection and set state to error
129 void client_fatal(struct client *cl)
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);
136 struct connection *client_get_connection(struct client *cl)
138 return cl->connection;
141 struct session_database *client_get_database(struct client *cl)
146 struct session *client_get_session(struct client *cl)
151 const char *client_get_pquery(struct client *cl)
156 static void client_send_raw_present(struct client *cl);
158 int client_show_raw_begin(struct client *cl, int position,
159 const char *syntax, const char *esn,
161 void (*error_handler)(void *data, const char *addinfo),
162 void (*record_handler)(void *data, const char *buf,
167 struct show_raw *rr, **rrp;
169 { /* the client has no connection */
172 rr = xmalloc(sizeof(*rr));
174 rr->position = position;
177 rr->error_handler = error_handler;
178 rr->record_handler = record_handler;
181 rr->syntax = xstrdup(syntax);
185 rr->esn = xstrdup(esn);
190 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
194 if (cl->state == Client_Failed)
196 client_show_raw_error(cl, "client failed");
198 else if (cl->state == Client_Disconnected)
200 client_show_raw_error(cl, "client disconnected");
204 client_send_raw_present(cl);
209 void client_show_raw_remove(struct client *cl, void *data)
211 struct show_raw *rr = data;
212 struct show_raw **rrp = &cl->show_raw;
222 void client_show_raw_dequeue(struct client *cl)
224 struct show_raw *rr = cl->show_raw;
226 cl->show_raw = rr->next;
230 static void client_show_raw_error(struct client *cl, const char *addinfo)
234 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
235 client_show_raw_dequeue(cl);
239 static void client_send_raw_present(struct client *cl)
241 struct session_database *sdb = client_get_database(cl);
242 struct connection *co = client_get_connection(cl);
243 ZOOM_resultset set = connection_get_resultset(co);
245 int offset = cl->show_raw->position;
246 const char *syntax = 0;
247 const char *elements = 0;
249 assert(cl->show_raw);
252 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
253 client_get_url(cl), 1, offset);
255 if (cl->show_raw->syntax)
256 syntax = cl->show_raw->syntax;
258 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
259 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
261 if (cl->show_raw->esn)
262 elements = cl->show_raw->esn;
264 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
265 if (elements && *elements)
266 ZOOM_resultset_option_set(set, "elementSetName", elements);
268 ZOOM_resultset_records(set, 0, offset-1, 1);
269 cl->show_raw->active = 1;
271 connection_continue(co);
274 static int nativesyntax_to_type(struct session_database *sdb, char *type, ZOOM_record rec)
276 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
280 if (!strncmp(s, "iso2709", 7))
282 const char *cp = strchr(s, ';');
283 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
285 else if (!strncmp(s, "xml", 3))
293 else /* attempt to deduce structure */
295 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
298 if (!strcmp(syntax, "XML"))
303 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
305 strcpy(type, "xml; charset=marc8-s");
314 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
320 if (cl->show_raw->binary)
324 struct session_database *sdb = client_get_database(cl);
325 nativesyntax_to_type(sdb, type, rec);
328 buf = ZOOM_record_get(rec, type, &len);
329 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
330 client_show_raw_dequeue(cl);
333 void client_search_response(struct client *cl)
335 struct connection *co = cl->connection;
336 struct session *se = cl->session;
337 ZOOM_connection link = connection_get_link(co);
338 ZOOM_resultset resultset = connection_get_resultset(co);
339 const char *error, *addinfo;
341 if (ZOOM_connection_error(link, &error, &addinfo))
344 client_set_state(cl, Client_Error);
345 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
346 error, addinfo, client_get_url(cl));
350 cl->record_offset = 0;
351 cl->hits = ZOOM_resultset_size(resultset);
352 se->total_hits += cl->hits;
357 void client_record_response(struct client *cl)
359 struct connection *co = cl->connection;
360 ZOOM_connection link = connection_get_link(co);
361 ZOOM_resultset resultset = connection_get_resultset(co);
362 const char *error, *addinfo;
364 if (ZOOM_connection_error(link, &error, &addinfo))
366 client_set_state(cl, Client_Error);
367 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
368 error, addinfo, client_get_url(cl));
373 const char *msg, *addinfo;
375 if (cl->show_raw && cl->show_raw->active)
377 if ((rec = ZOOM_resultset_record(resultset,
378 cl->show_raw->position-1)))
380 cl->show_raw->active = 0;
381 ingest_raw_record(cl, rec);
385 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
386 cl->show_raw->position-1);
391 int offset = cl->record_offset;
392 if ((rec = ZOOM_resultset_record(resultset, offset)))
395 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
396 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
397 error, addinfo, client_get_url(cl),
401 struct session_database *sdb = client_get_database(cl);
404 if (nativesyntax_to_type(sdb, type, rec))
405 yaz_log(YLOG_WARN, "Failed to determine record type");
406 if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
408 if (ingest_record(cl, xmlrec, cl->record_offset))
410 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
411 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
414 yaz_log(YLOG_WARN, "Failed to ingest");
417 yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
423 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
430 void client_start_search(struct client *cl)
432 struct session_database *sdb = client_get_database(cl);
433 struct connection *co = client_get_connection(cl);
434 ZOOM_connection link = connection_get_link(co);
436 char *databaseName = sdb->database->databases[0];
437 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
438 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
439 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
440 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
441 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
442 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
447 cl->record_offset = 0;
449 client_set_state(cl, Client_Working);
452 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
454 ZOOM_connection_option_set(link, "piggyback", "1");
456 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
457 if (*opt_sru && *opt_elements)
458 ZOOM_connection_option_set(link, "schema", opt_elements);
459 else if (*opt_elements)
460 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
462 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
464 ZOOM_connection_option_set(link, "count", opt_maxrecs);
468 sprintf(n, "%d", global_parameters.toget);
469 ZOOM_connection_option_set(link, "count", n);
472 ZOOM_connection_option_set(link, "databaseName", databaseName);
474 ZOOM_connection_option_set(link, "presentChunk", "20");
478 ZOOM_query q = ZOOM_query_create();
479 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
480 ZOOM_query_cql(q, cl->cqlquery);
481 rs = ZOOM_connection_search(link, q);
482 ZOOM_query_destroy(q);
486 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
487 rs = ZOOM_connection_search_pqf(link, cl->pquery);
489 connection_set_resultset(co, rs);
490 connection_continue(co);
493 struct client *client_create(void)
499 client_freelist = client_freelist->next;
502 r = xmalloc(sizeof(struct client));
509 r->record_offset = 0;
511 r->state = Client_Disconnected;
517 void client_destroy(struct client *c)
519 struct session *se = c->session;
520 if (c == se->clients)
521 se->clients = c->next;
525 for (cc = se->clients; cc && cc->next != c; cc = cc->next)
534 connection_release(c->connection);
535 c->next = client_freelist;
539 void client_set_connection(struct client *cl, struct connection *con)
541 cl->connection = con;
544 void client_disconnect(struct client *cl)
546 if (cl->state != Client_Idle)
547 client_set_state(cl, Client_Disconnected);
548 client_set_connection(cl, 0);
551 // Extract terms from query into null-terminated termlist
552 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
556 pull_terms(nmem, query, termlist, &num);
560 // Initialize CCL map for a target
561 static CCL_bibset prepare_cclmap(struct client *cl)
563 struct session_database *sdb = client_get_database(cl);
570 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
572 char *p = strchr(s->name + 3, ':');
575 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
580 ccl_qual_fitem(res, s->value, p);
585 // returns a xmalloced CQL query corresponding to the pquery in client
586 static char *make_cqlquery(struct client *cl)
588 cql_transform_t cqlt = cql_transform_create();
591 WRBUF wrb = wrbuf_alloc();
594 zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
595 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
597 yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
600 r = xstrdup(wrbuf_cstr(wrb));
603 odr_reset(global_parameters.odr_out); // releases the zquery
604 cql_transform_close(cqlt);
608 // Parse the query given the settings specific to this client
609 int client_parse_query(struct client *cl, const char *query)
611 struct session *se = client_get_session(cl);
612 struct session_database *sdb = client_get_database(cl);
613 struct ccl_rpn_node *cn;
615 CCL_bibset ccl_map = prepare_cclmap(cl);
616 const char *sru = session_setting_oneval(sdb, PZ_SRU);
617 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
622 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
623 ccl_qual_rm(&ccl_map);
626 client_set_state(cl, Client_Error);
627 yaz_log(YLOG_WARN, "Failed to parse query for %s",
628 client_get_database(cl)->database->url);
631 wrbuf_rewind(se->wrbuf);
634 wrbuf_puts(se->wrbuf, pqf_prefix);
635 wrbuf_puts(se->wrbuf, " ");
637 ccl_pquery(se->wrbuf, cn);
639 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
644 if (!(cl->cqlquery = make_cqlquery(cl)))
652 // Initialize relevance structure with query terms
654 extract_terms(se->nmem, cn, p);
655 se->relevance = relevance_create(
656 global_parameters.server->relevance_pct,
657 se->nmem, (const char **) p,
658 se->expected_maxrecs);
665 void client_set_session(struct client *cl, struct session *se)
668 cl->next = se->clients;
672 int client_is_active(struct client *cl)
674 if (cl->connection && (cl->state == Client_Connecting ||
675 cl->state == Client_Working))
680 struct client *client_next_in_session(struct client *cl)
688 int client_get_hits(struct client *cl)
693 int client_get_num_records(struct client *cl)
695 return cl->record_offset;
698 int client_get_diagnostic(struct client *cl)
700 return cl->diagnostic;
703 void client_set_database(struct client *cl, struct session_database *db)
708 struct host *client_get_host(struct client *cl)
710 return client_get_database(cl)->database->host;
713 const char *client_get_url(struct client *cl)
715 return client_get_database(cl)->database->url;
721 * indent-tabs-mode: nil
723 * vim: shiftwidth=4 tabstop=8 expandtab