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
38 #include <sys/socket.h>
47 #include <yaz/marcdisp.h>
48 #include <yaz/comstack.h>
49 #include <yaz/tcpip.h>
50 #include <yaz/proto.h>
51 #include <yaz/readconf.h>
52 #include <yaz/pquery.h>
53 #include <yaz/otherinfo.h>
54 #include <yaz/yaz-util.h>
56 #include <yaz/query-charset.h>
57 #include <yaz/querytowrbuf.h>
58 #include <yaz/oid_db.h>
59 #include <yaz/diagbib1.h>
60 #include <yaz/snprintf.h>
61 #include <yaz/rpn2cql.h>
65 #include <yaz/timing.h>
69 #include <netinet/in.h>
75 #include "connection.h"
78 /** \brief Represents client state for a connection to one search target */
80 struct session_database *database;
81 struct connection *connection;
82 struct session *session;
83 char *pquery; // Current search
84 char *cqlquery; // used for SRU targets only
88 int requestid; // ID of current outstanding request
90 enum client_state state;
91 struct show_raw *show_raw;
92 struct client *next; // next client in session or next in free list
96 int active; // whether this request has been sent to the server
101 void (*error_handler)(void *data, const char *addinfo);
102 void (*record_handler)(void *data, const char *buf, size_t sz);
104 struct show_raw *next;
107 static const char *client_states[] = {
114 "Client_Disconnected",
119 static struct client *client_freelist = 0;
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)
136 int no_active = session_active_clients(cl->session);
138 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
142 static void client_show_raw_error(struct client *cl, const char *addinfo);
144 // Close connection and set state to error
145 void client_fatal(struct client *cl)
147 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
148 connection_destroy(cl->connection);
149 client_set_state(cl, Client_Error);
152 struct connection *client_get_connection(struct client *cl)
154 return cl->connection;
157 struct session_database *client_get_database(struct client *cl)
162 struct session *client_get_session(struct client *cl)
167 const char *client_get_pquery(struct client *cl)
172 void client_set_requestid(struct client *cl, int id)
178 static void client_send_raw_present(struct client *cl);
180 int client_show_raw_begin(struct client *cl, int position,
181 const char *syntax, const char *esn,
183 void (*error_handler)(void *data, const char *addinfo),
184 void (*record_handler)(void *data, const char *buf,
189 struct show_raw *rr, **rrp;
191 { /* the client has no connection */
194 rr = xmalloc(sizeof(*rr));
196 rr->position = position;
199 rr->error_handler = error_handler;
200 rr->record_handler = record_handler;
203 rr->syntax = xstrdup(syntax);
207 rr->esn = xstrdup(esn);
212 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
216 if (cl->state == Client_Failed)
218 client_show_raw_error(cl, "client failed");
220 else if (cl->state == Client_Disconnected)
222 client_show_raw_error(cl, "client disconnected");
226 client_send_raw_present(cl);
231 void client_show_raw_remove(struct client *cl, void *data)
233 struct show_raw *rr = data;
234 struct show_raw **rrp = &cl->show_raw;
244 void client_show_raw_dequeue(struct client *cl)
246 struct show_raw *rr = cl->show_raw;
248 cl->show_raw = rr->next;
252 static void client_show_raw_error(struct client *cl, const char *addinfo)
256 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
257 client_show_raw_dequeue(cl);
261 static void client_send_raw_present(struct client *cl)
263 struct session_database *sdb = client_get_database(cl);
264 struct connection *co = client_get_connection(cl);
265 ZOOM_resultset set = connection_get_resultset(co);
267 int offset = cl->show_raw->position;
268 const char *syntax = 0;
269 const char *elements = 0;
271 assert(cl->show_raw);
274 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
275 client_get_url(cl), 1, offset);
277 if (cl->show_raw->syntax)
278 syntax = cl->show_raw->syntax;
280 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
281 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
283 if (cl->show_raw->esn)
284 elements = cl->show_raw->esn;
286 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
287 if (elements && *elements)
288 ZOOM_resultset_option_set(set, "elementSetName", elements);
290 ZOOM_resultset_records(set, 0, offset-1, 1);
291 cl->show_raw->active = 1;
293 connection_continue(co);
296 static int nativesyntax_to_type(struct session_database *sdb, char *type)
298 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
302 if (!strncmp(s, "iso2709", 7))
304 const char *cp = strchr(s, ';');
305 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
307 else if (!strncmp(s, "xml", 3))
318 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
324 if (cl->show_raw->binary)
328 struct session_database *sdb = client_get_database(cl);
329 nativesyntax_to_type(sdb, type);
332 buf = ZOOM_record_get(rec, type, &len);
333 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
334 client_show_raw_dequeue(cl);
337 void client_search_response(struct client *cl)
339 struct connection *co = cl->connection;
340 struct session *se = cl->session;
341 ZOOM_connection link = connection_get_link(co);
342 ZOOM_resultset resultset = connection_get_resultset(co);
343 const char *error, *addinfo;
345 if (ZOOM_connection_error(link, &error, &addinfo))
348 client_set_state(cl, Client_Error);
349 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
350 error, addinfo, client_get_url(cl));
354 cl->hits = ZOOM_resultset_size(resultset);
355 se->total_hits += cl->hits;
360 void client_record_response(struct client *cl)
362 struct connection *co = cl->connection;
363 ZOOM_connection link = connection_get_link(co);
364 ZOOM_resultset resultset = connection_get_resultset(co);
365 const char *error, *addinfo;
367 if (ZOOM_connection_error(link, &error, &addinfo))
369 client_set_state(cl, Client_Error);
370 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
371 error, addinfo, client_get_url(cl));
376 const char *msg, *addinfo;
378 if (cl->show_raw && cl->show_raw->active)
380 if ((rec = ZOOM_resultset_record(resultset,
381 cl->show_raw->position-1)))
383 cl->show_raw->active = 0;
384 ingest_raw_record(cl, rec);
388 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
389 cl->show_raw->position-1);
394 int offset = cl->record_offset;
395 if ((rec = ZOOM_resultset_record(resultset, offset)))
398 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
399 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
400 error, addinfo, client_get_url(cl),
404 struct session_database *sdb = client_get_database(cl);
407 nativesyntax_to_type(sdb, type);
408 if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
410 if (ingest_record(cl, xmlrec, cl->record_offset))
412 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
413 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
416 yaz_log(YLOG_WARN, "Failed to ingest");
419 yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
425 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
432 void client_start_search(struct client *cl)
434 struct session_database *sdb = client_get_database(cl);
435 struct connection *co = client_get_connection(cl);
436 ZOOM_connection link = connection_get_link(co);
438 char *databaseName = sdb->database->databases[0];
439 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
440 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
441 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
442 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
443 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
444 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
449 cl->record_offset = 0;
451 client_set_state(cl, Client_Working);
454 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
456 ZOOM_connection_option_set(link, "piggyback", "1");
458 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
459 if (*opt_sru && *opt_elements)
460 ZOOM_connection_option_set(link, "schema", opt_elements);
461 else if (*opt_elements)
462 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
464 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
466 ZOOM_connection_option_set(link, "count", opt_maxrecs);
470 sprintf(n, "%d", global_parameters.toget);
471 ZOOM_connection_option_set(link, "count", n);
474 ZOOM_connection_option_set(link, "databaseName", databaseName);
476 ZOOM_connection_option_set(link, "presentChunk", "20");
480 ZOOM_query q = ZOOM_query_create();
481 ZOOM_query_cql(q, cl->cqlquery);
482 rs = ZOOM_connection_search(link, q);
483 ZOOM_query_destroy(q);
486 rs = ZOOM_connection_search_pqf(link, cl->pquery);
487 connection_set_resultset(co, rs);
488 connection_continue(co);
491 struct client *client_create(void)
497 client_freelist = client_freelist->next;
500 r = xmalloc(sizeof(struct client));
507 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);
621 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
622 ccl_qual_rm(&ccl_map);
625 client_set_state(cl, Client_Error);
626 yaz_log(YLOG_WARN, "Failed to parse query for %s",
627 client_get_database(cl)->database->url);
630 wrbuf_rewind(se->wrbuf);
631 ccl_pquery(se->wrbuf, cn);
633 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
638 if (!(cl->cqlquery = make_cqlquery(cl)))
646 // Initialize relevance structure with query terms
648 extract_terms(se->nmem, cn, p);
649 se->relevance = relevance_create(
650 global_parameters.server->relevance_pct,
651 se->nmem, (const char **) p,
652 se->expected_maxrecs);
659 void client_set_session(struct client *cl, struct session *se)
662 cl->next = se->clients;
666 int client_is_active(struct client *cl)
668 if (cl->connection && (cl->state == Client_Continue ||
669 cl->state == Client_Connecting ||
670 cl->state == Client_Working))
675 struct client *client_next_in_session(struct client *cl)
683 int client_get_hits(struct client *cl)
688 int client_get_num_records(struct client *cl)
690 return cl->record_offset;
693 int client_get_diagnostic(struct client *cl)
695 return cl->diagnostic;
698 void client_set_database(struct client *cl, struct session_database *db)
703 struct host *client_get_host(struct client *cl)
705 return client_get_database(cl)->database->host;
708 const char *client_get_url(struct client *cl)
710 return client_get_database(cl)->database->url;
716 * indent-tabs-mode: nil
718 * vim: shiftwidth=4 tabstop=8 expandtab