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 int requestid; // ID of current outstanding request
80 enum client_state state;
81 struct show_raw *show_raw;
82 struct client *next; // next client in session or next in free list
86 int active; // whether this request has been sent to the server
91 void (*error_handler)(void *data, const char *addinfo);
92 void (*record_handler)(void *data, const char *buf, size_t sz);
94 struct show_raw *next;
97 static const char *client_states[] = {
103 "Client_Disconnected",
108 static struct client *client_freelist = 0;
110 const char *client_get_state_str(struct client *cl)
112 return client_states[cl->state];
115 enum client_state client_get_state(struct client *cl)
120 void client_set_state(struct client *cl, enum client_state st)
125 int no_active = session_active_clients(cl->session);
127 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
131 static void client_show_raw_error(struct client *cl, const char *addinfo);
133 // Close connection and set state to error
134 void client_fatal(struct client *cl)
136 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
137 connection_destroy(cl->connection);
138 client_set_state(cl, Client_Error);
141 struct connection *client_get_connection(struct client *cl)
143 return cl->connection;
146 struct session_database *client_get_database(struct client *cl)
151 struct session *client_get_session(struct client *cl)
156 const char *client_get_pquery(struct client *cl)
161 void client_set_requestid(struct client *cl, int id)
167 static void client_send_raw_present(struct client *cl);
169 int client_show_raw_begin(struct client *cl, int position,
170 const char *syntax, const char *esn,
172 void (*error_handler)(void *data, const char *addinfo),
173 void (*record_handler)(void *data, const char *buf,
178 struct show_raw *rr, **rrp;
180 { /* the client has no connection */
183 rr = xmalloc(sizeof(*rr));
185 rr->position = position;
188 rr->error_handler = error_handler;
189 rr->record_handler = record_handler;
192 rr->syntax = xstrdup(syntax);
196 rr->esn = xstrdup(esn);
201 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
205 if (cl->state == Client_Failed)
207 client_show_raw_error(cl, "client failed");
209 else if (cl->state == Client_Disconnected)
211 client_show_raw_error(cl, "client disconnected");
215 client_send_raw_present(cl);
220 void client_show_raw_remove(struct client *cl, void *data)
222 struct show_raw *rr = data;
223 struct show_raw **rrp = &cl->show_raw;
233 void client_show_raw_dequeue(struct client *cl)
235 struct show_raw *rr = cl->show_raw;
237 cl->show_raw = rr->next;
241 static void client_show_raw_error(struct client *cl, const char *addinfo)
245 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
246 client_show_raw_dequeue(cl);
250 static void client_send_raw_present(struct client *cl)
252 struct session_database *sdb = client_get_database(cl);
253 struct connection *co = client_get_connection(cl);
254 ZOOM_resultset set = connection_get_resultset(co);
256 int offset = cl->show_raw->position;
257 const char *syntax = 0;
258 const char *elements = 0;
260 assert(cl->show_raw);
263 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
264 client_get_url(cl), 1, offset);
266 if (cl->show_raw->syntax)
267 syntax = cl->show_raw->syntax;
269 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
270 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
272 if (cl->show_raw->esn)
273 elements = cl->show_raw->esn;
275 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
276 if (elements && *elements)
277 ZOOM_resultset_option_set(set, "elementSetName", elements);
279 ZOOM_resultset_records(set, 0, offset-1, 1);
280 cl->show_raw->active = 1;
282 connection_continue(co);
285 static int nativesyntax_to_type(struct session_database *sdb, char *type)
287 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
291 if (!strncmp(s, "iso2709", 7))
293 const char *cp = strchr(s, ';');
294 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
296 else if (!strncmp(s, "xml", 3))
307 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
313 if (cl->show_raw->binary)
317 struct session_database *sdb = client_get_database(cl);
318 nativesyntax_to_type(sdb, type);
321 buf = ZOOM_record_get(rec, type, &len);
322 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
323 client_show_raw_dequeue(cl);
326 void client_search_response(struct client *cl)
328 struct connection *co = cl->connection;
329 struct session *se = cl->session;
330 ZOOM_connection link = connection_get_link(co);
331 ZOOM_resultset resultset = connection_get_resultset(co);
332 const char *error, *addinfo;
334 if (ZOOM_connection_error(link, &error, &addinfo))
337 client_set_state(cl, Client_Error);
338 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
339 error, addinfo, client_get_url(cl));
343 cl->record_offset = 0;
344 cl->hits = ZOOM_resultset_size(resultset);
345 se->total_hits += cl->hits;
350 void client_record_response(struct client *cl)
352 struct connection *co = cl->connection;
353 ZOOM_connection link = connection_get_link(co);
354 ZOOM_resultset resultset = connection_get_resultset(co);
355 const char *error, *addinfo;
357 if (ZOOM_connection_error(link, &error, &addinfo))
359 client_set_state(cl, Client_Error);
360 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
361 error, addinfo, client_get_url(cl));
366 const char *msg, *addinfo;
368 if (cl->show_raw && cl->show_raw->active)
370 if ((rec = ZOOM_resultset_record(resultset,
371 cl->show_raw->position-1)))
373 cl->show_raw->active = 0;
374 ingest_raw_record(cl, rec);
378 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
379 cl->show_raw->position-1);
384 int offset = cl->record_offset;
385 if ((rec = ZOOM_resultset_record(resultset, offset)))
388 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
389 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
390 error, addinfo, client_get_url(cl),
394 struct session_database *sdb = client_get_database(cl);
397 nativesyntax_to_type(sdb, type);
398 if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
400 if (ingest_record(cl, xmlrec, cl->record_offset))
402 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
403 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
406 yaz_log(YLOG_WARN, "Failed to ingest");
409 yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
415 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
422 void client_start_search(struct client *cl)
424 struct session_database *sdb = client_get_database(cl);
425 struct connection *co = client_get_connection(cl);
426 ZOOM_connection link = connection_get_link(co);
428 char *databaseName = sdb->database->databases[0];
429 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
430 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
431 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
432 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
433 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
434 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
439 cl->record_offset = 0;
441 client_set_state(cl, Client_Working);
444 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
446 ZOOM_connection_option_set(link, "piggyback", "1");
448 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
449 if (*opt_sru && *opt_elements)
450 ZOOM_connection_option_set(link, "schema", opt_elements);
451 else if (*opt_elements)
452 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
454 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
456 ZOOM_connection_option_set(link, "count", opt_maxrecs);
460 sprintf(n, "%d", global_parameters.toget);
461 ZOOM_connection_option_set(link, "count", n);
464 ZOOM_connection_option_set(link, "databaseName", databaseName);
466 ZOOM_connection_option_set(link, "presentChunk", "20");
470 ZOOM_query q = ZOOM_query_create();
471 ZOOM_query_cql(q, cl->cqlquery);
472 rs = ZOOM_connection_search(link, q);
473 ZOOM_query_destroy(q);
476 rs = ZOOM_connection_search_pqf(link, cl->pquery);
477 connection_set_resultset(co, rs);
478 connection_continue(co);
481 struct client *client_create(void)
487 client_freelist = client_freelist->next;
490 r = xmalloc(sizeof(struct client));
497 r->record_offset = 0;
501 r->state = Client_Disconnected;
507 void client_destroy(struct client *c)
509 struct session *se = c->session;
510 if (c == se->clients)
511 se->clients = c->next;
515 for (cc = se->clients; cc && cc->next != c; cc = cc->next)
524 connection_release(c->connection);
525 c->next = client_freelist;
529 void client_set_connection(struct client *cl, struct connection *con)
531 cl->connection = con;
534 void client_disconnect(struct client *cl)
536 if (cl->state != Client_Idle)
537 client_set_state(cl, Client_Disconnected);
538 client_set_connection(cl, 0);
541 // Extract terms from query into null-terminated termlist
542 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
546 pull_terms(nmem, query, termlist, &num);
550 // Initialize CCL map for a target
551 static CCL_bibset prepare_cclmap(struct client *cl)
553 struct session_database *sdb = client_get_database(cl);
560 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
562 char *p = strchr(s->name + 3, ':');
565 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
570 ccl_qual_fitem(res, s->value, p);
575 // returns a xmalloced CQL query corresponding to the pquery in client
576 static char *make_cqlquery(struct client *cl)
578 cql_transform_t cqlt = cql_transform_create();
581 WRBUF wrb = wrbuf_alloc();
584 zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
585 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
587 yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
590 r = xstrdup(wrbuf_cstr(wrb));
593 odr_reset(global_parameters.odr_out); // releases the zquery
594 cql_transform_close(cqlt);
598 // Parse the query given the settings specific to this client
599 int client_parse_query(struct client *cl, const char *query)
601 struct session *se = client_get_session(cl);
602 struct session_database *sdb = client_get_database(cl);
603 struct ccl_rpn_node *cn;
605 CCL_bibset ccl_map = prepare_cclmap(cl);
606 const char *sru = session_setting_oneval(sdb, PZ_SRU);
611 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
612 ccl_qual_rm(&ccl_map);
615 client_set_state(cl, Client_Error);
616 yaz_log(YLOG_WARN, "Failed to parse query for %s",
617 client_get_database(cl)->database->url);
620 wrbuf_rewind(se->wrbuf);
621 ccl_pquery(se->wrbuf, cn);
623 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
628 if (!(cl->cqlquery = make_cqlquery(cl)))
636 // Initialize relevance structure with query terms
638 extract_terms(se->nmem, cn, p);
639 se->relevance = relevance_create(
640 global_parameters.server->relevance_pct,
641 se->nmem, (const char **) p,
642 se->expected_maxrecs);
649 void client_set_session(struct client *cl, struct session *se)
652 cl->next = se->clients;
656 int client_is_active(struct client *cl)
658 if (cl->connection && (cl->state == Client_Continue ||
659 cl->state == Client_Connecting ||
660 cl->state == Client_Working))
665 struct client *client_next_in_session(struct client *cl)
673 int client_get_hits(struct client *cl)
678 int client_get_num_records(struct client *cl)
680 return cl->record_offset;
683 int client_get_diagnostic(struct client *cl)
685 return cl->diagnostic;
688 void client_set_database(struct client *cl, struct session_database *db)
693 struct host *client_get_host(struct client *cl)
695 return client_get_database(cl)->database->host;
698 const char *client_get_url(struct client *cl)
700 return client_get_database(cl)->database->url;
706 * indent-tabs-mode: nil
708 * vim: shiftwidth=4 tabstop=8 expandtab