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>
62 #include "parameters.h"
64 #include "connection.h"
66 #include "relevance.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
81 ZOOM_resultset resultset;
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"
105 static struct client *client_freelist = 0; /* thread pr */
107 const char *client_get_state_str(struct client *cl)
109 return client_states[cl->state];
112 enum client_state client_get_state(struct client *cl)
117 void client_set_state(struct client *cl, enum client_state st)
122 int no_active = session_active_clients(cl->session);
124 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
128 static void client_show_raw_error(struct client *cl, const char *addinfo);
130 // Close connection and set state to error
131 void client_fatal(struct client *cl)
133 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
134 connection_destroy(cl->connection);
135 client_set_state(cl, Client_Error);
138 struct connection *client_get_connection(struct client *cl)
140 return cl->connection;
143 struct session_database *client_get_database(struct client *cl)
148 struct session *client_get_session(struct client *cl)
153 const char *client_get_pquery(struct client *cl)
158 static void client_send_raw_present(struct client *cl);
159 static int nativesyntax_to_type(struct session_database *sdb, char *type,
162 static void client_show_immediate(
163 ZOOM_resultset resultset, struct session_database *sdb, int position,
165 void (*error_handler)(void *data, const char *addinfo),
166 void (*record_handler)(void *data, const char *buf, size_t sz),
176 error_handler(data, "no resultset");
179 rec = ZOOM_resultset_record(resultset, position-1);
182 error_handler(data, "no record");
188 nativesyntax_to_type(sdb, type, rec);
189 buf = ZOOM_record_get(rec, type, &len);
192 error_handler(data, "no record");
195 record_handler(data, buf, len);
199 int client_show_raw_begin(struct client *cl, int position,
200 const char *syntax, const char *esn,
202 void (*error_handler)(void *data, const char *addinfo),
203 void (*record_handler)(void *data, const char *buf,
207 if (syntax == 0 && esn == 0)
208 client_show_immediate(cl->resultset, client_get_database(cl),
210 error_handler, record_handler,
214 struct show_raw *rr, **rrp;
220 rr = xmalloc(sizeof(*rr));
221 rr->position = position;
224 rr->error_handler = error_handler;
225 rr->record_handler = record_handler;
228 rr->syntax = xstrdup(syntax);
232 rr->esn = xstrdup(esn);
237 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
241 if (cl->state == Client_Failed)
243 client_show_raw_error(cl, "client failed");
245 else if (cl->state == Client_Disconnected)
247 client_show_raw_error(cl, "client disconnected");
251 client_send_raw_present(cl);
257 static void client_show_raw_delete(struct show_raw *r)
264 void client_show_raw_remove(struct client *cl, void *data)
266 struct show_raw *rr = data;
267 struct show_raw **rrp = &cl->show_raw;
273 client_show_raw_delete(rr);
277 void client_show_raw_dequeue(struct client *cl)
279 struct show_raw *rr = cl->show_raw;
281 cl->show_raw = rr->next;
282 client_show_raw_delete(rr);
285 static void client_show_raw_error(struct client *cl, const char *addinfo)
289 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
290 client_show_raw_dequeue(cl);
294 static void client_send_raw_present(struct client *cl)
296 struct session_database *sdb = client_get_database(cl);
297 struct connection *co = client_get_connection(cl);
298 ZOOM_resultset set = cl->resultset;
300 int offset = cl->show_raw->position;
301 const char *syntax = 0;
302 const char *elements = 0;
304 assert(cl->show_raw);
307 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
308 client_get_url(cl), 1, offset);
310 if (cl->show_raw->syntax)
311 syntax = cl->show_raw->syntax;
313 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
314 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
316 if (cl->show_raw->esn)
317 elements = cl->show_raw->esn;
319 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
320 if (elements && *elements)
321 ZOOM_resultset_option_set(set, "elementSetName", elements);
323 ZOOM_resultset_records(set, 0, offset-1, 1);
324 cl->show_raw->active = 1;
326 connection_continue(co);
329 static int nativesyntax_to_type(struct session_database *sdb, char *type,
332 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
336 if (!strncmp(s, "iso2709", 7))
338 const char *cp = strchr(s, ';');
339 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
341 else if (!strncmp(s, "xml", 3))
349 else /* attempt to deduce structure */
351 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
354 if (!strcmp(syntax, "XML"))
359 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
361 strcpy(type, "xml; charset=marc8-s");
370 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
376 if (cl->show_raw->binary)
380 struct session_database *sdb = client_get_database(cl);
381 nativesyntax_to_type(sdb, type, rec);
384 buf = ZOOM_record_get(rec, type, &len);
385 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
386 client_show_raw_dequeue(cl);
389 void client_search_response(struct client *cl)
391 struct connection *co = cl->connection;
392 struct session *se = cl->session;
393 ZOOM_connection link = connection_get_link(co);
394 ZOOM_resultset resultset = cl->resultset;
395 const char *error, *addinfo;
397 if (ZOOM_connection_error(link, &error, &addinfo))
400 client_set_state(cl, Client_Error);
401 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
402 error, addinfo, client_get_url(cl));
406 cl->record_offset = 0;
407 cl->hits = ZOOM_resultset_size(resultset);
408 se->total_hits += cl->hits;
413 void client_record_response(struct client *cl)
415 struct connection *co = cl->connection;
416 ZOOM_connection link = connection_get_link(co);
417 ZOOM_resultset resultset = cl->resultset;
418 const char *error, *addinfo;
420 if (ZOOM_connection_error(link, &error, &addinfo))
422 client_set_state(cl, Client_Error);
423 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
424 error, addinfo, client_get_url(cl));
429 const char *msg, *addinfo;
431 if (cl->show_raw && cl->show_raw->active)
433 if ((rec = ZOOM_resultset_record(resultset,
434 cl->show_raw->position-1)))
436 cl->show_raw->active = 0;
437 ingest_raw_record(cl, rec);
441 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
442 cl->show_raw->position-1);
447 int offset = cl->record_offset;
448 if ((rec = ZOOM_resultset_record(resultset, offset)))
451 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
452 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
453 error, addinfo, client_get_url(cl),
457 struct session_database *sdb = client_get_database(cl);
460 if (nativesyntax_to_type(sdb, type, rec))
461 yaz_log(YLOG_WARN, "Failed to determine record type");
462 if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
464 if (ingest_record(cl, xmlrec, cl->record_offset))
466 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
467 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
470 yaz_log(YLOG_WARN, "Failed to ingest");
473 yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
479 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
486 void client_start_search(struct client *cl)
488 struct session_database *sdb = client_get_database(cl);
489 struct connection *co = client_get_connection(cl);
490 ZOOM_connection link = connection_get_link(co);
492 char *databaseName = sdb->database->databases[0];
493 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
494 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
495 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
496 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
497 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
498 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
499 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
504 cl->record_offset = 0;
506 client_set_state(cl, Client_Working);
509 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
511 ZOOM_connection_option_set(link, "piggyback", "1");
513 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
514 if (*opt_sru && *opt_elements)
515 ZOOM_connection_option_set(link, "schema", opt_elements);
516 else if (*opt_elements)
517 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
519 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
521 ZOOM_connection_option_set(link, "count", opt_maxrecs);
523 ZOOM_connection_option_set(link, "count", "100");
526 ZOOM_connection_option_set(link, "databaseName", databaseName);
528 ZOOM_connection_option_set(link, "presentChunk", "20");
532 ZOOM_query q = ZOOM_query_create();
533 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
534 ZOOM_query_cql(q, cl->cqlquery);
536 ZOOM_query_sortby(q, opt_sort);
537 rs = ZOOM_connection_search(link, q);
538 ZOOM_query_destroy(q);
542 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
543 rs = ZOOM_connection_search_pqf(link, cl->pquery);
545 ZOOM_resultset_destroy(cl->resultset);
547 connection_continue(co);
550 struct client *client_create(void)
556 client_freelist = client_freelist->next;
559 r = xmalloc(sizeof(struct client));
566 r->record_offset = 0;
568 r->state = Client_Disconnected;
575 void client_destroy(struct client *c)
577 struct session *se = c->session;
578 if (c == se->clients)
579 se->clients = c->next;
583 for (cc = se->clients; cc && cc->next != c; cc = cc->next)
592 connection_release(c->connection);
594 ZOOM_resultset_destroy(c->resultset);
596 c->next = client_freelist;
600 void client_set_connection(struct client *cl, struct connection *con)
602 cl->connection = con;
605 void client_disconnect(struct client *cl)
607 if (cl->state != Client_Idle)
608 client_set_state(cl, Client_Disconnected);
609 client_set_connection(cl, 0);
612 // Extract terms from query into null-terminated termlist
613 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
617 pull_terms(nmem, query, termlist, &num);
621 // Initialize CCL map for a target
622 static CCL_bibset prepare_cclmap(struct client *cl)
624 struct session_database *sdb = client_get_database(cl);
631 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
633 char *p = strchr(s->name + 3, ':');
636 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
641 ccl_qual_fitem(res, s->value, p);
646 // returns a xmalloced CQL query corresponding to the pquery in client
647 static char *make_cqlquery(struct client *cl)
649 cql_transform_t cqlt = cql_transform_create();
652 WRBUF wrb = wrbuf_alloc();
654 ODR odr_out = odr_createmem(ODR_ENCODE);
656 zquery = p_query_rpn(odr_out, cl->pquery);
657 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
658 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
660 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
665 r = xstrdup(wrbuf_cstr(wrb));
668 odr_destroy(odr_out);
669 cql_transform_close(cqlt);
673 // Parse the query given the settings specific to this client
674 int client_parse_query(struct client *cl, const char *query)
676 struct session *se = client_get_session(cl);
677 struct session_database *sdb = client_get_database(cl);
678 struct ccl_rpn_node *cn;
680 CCL_bibset ccl_map = prepare_cclmap(cl);
681 const char *sru = session_setting_oneval(sdb, PZ_SRU);
682 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
687 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
688 ccl_qual_rm(&ccl_map);
691 client_set_state(cl, Client_Error);
692 yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
694 client_get_database(cl)->database->url);
697 wrbuf_rewind(se->wrbuf);
700 wrbuf_puts(se->wrbuf, pqf_prefix);
701 wrbuf_puts(se->wrbuf, " ");
703 ccl_pquery(se->wrbuf, cn);
705 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
710 if (!(cl->cqlquery = make_cqlquery(cl)))
718 // Initialize relevance structure with query terms
720 extract_terms(se->nmem, cn, p);
721 se->relevance = relevance_create(
722 se->service->relevance_pct,
723 se->nmem, (const char **) p);
730 void client_set_session(struct client *cl, struct session *se)
733 cl->next = se->clients;
737 int client_is_active(struct client *cl)
739 if (cl->connection && (cl->state == Client_Connecting ||
740 cl->state == Client_Working))
745 struct client *client_next_in_session(struct client *cl)
753 int client_get_hits(struct client *cl)
758 int client_get_num_records(struct client *cl)
760 return cl->record_offset;
763 int client_get_diagnostic(struct client *cl)
765 return cl->diagnostic;
768 void client_set_database(struct client *cl, struct session_database *db)
773 struct host *client_get_host(struct client *cl)
775 return client_get_database(cl)->database->host;
778 const char *client_get_url(struct client *cl)
780 return client_get_database(cl)->database->url;
786 * c-file-style: "Stroustrup"
787 * indent-tabs-mode: nil
789 * vim: shiftwidth=4 tabstop=8 expandtab