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
79 enum client_state state;
80 struct show_raw *show_raw;
81 struct client *next; // next client in session or next in free list
82 ZOOM_resultset resultset;
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"
106 static struct client *client_freelist = 0; /* thread pr */
108 const char *client_get_state_str(struct client *cl)
110 return client_states[cl->state];
113 enum client_state client_get_state(struct client *cl)
118 void client_set_state(struct client *cl, enum client_state st)
123 int no_active = session_active_clients(cl->session);
125 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
129 static void client_show_raw_error(struct client *cl, const char *addinfo);
131 // Close connection and set state to error
132 void client_fatal(struct client *cl)
134 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
135 connection_destroy(cl->connection);
136 client_set_state(cl, Client_Error);
139 struct connection *client_get_connection(struct client *cl)
141 return cl->connection;
144 struct session_database *client_get_database(struct client *cl)
149 struct session *client_get_session(struct client *cl)
154 const char *client_get_pquery(struct client *cl)
159 static void client_send_raw_present(struct client *cl);
160 static int nativesyntax_to_type(struct session_database *sdb, char *type,
163 static void client_show_immediate(
164 ZOOM_resultset resultset, struct session_database *sdb, int position,
166 void (*error_handler)(void *data, const char *addinfo),
167 void (*record_handler)(void *data, const char *buf, size_t sz),
177 error_handler(data, "no resultset");
180 rec = ZOOM_resultset_record(resultset, position-1);
183 error_handler(data, "no record");
189 nativesyntax_to_type(sdb, type, rec);
190 buf = ZOOM_record_get(rec, type, &len);
193 error_handler(data, "no record");
196 record_handler(data, buf, len);
200 int client_show_raw_begin(struct client *cl, int position,
201 const char *syntax, const char *esn,
203 void (*error_handler)(void *data, const char *addinfo),
204 void (*record_handler)(void *data, const char *buf,
208 if (syntax == 0 && esn == 0)
209 client_show_immediate(cl->resultset, client_get_database(cl),
211 error_handler, record_handler,
215 struct show_raw *rr, **rrp;
221 rr = xmalloc(sizeof(*rr));
222 rr->position = position;
225 rr->error_handler = error_handler;
226 rr->record_handler = record_handler;
229 rr->syntax = xstrdup(syntax);
233 rr->esn = xstrdup(esn);
238 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
242 if (cl->state == Client_Failed)
244 client_show_raw_error(cl, "client failed");
246 else if (cl->state == Client_Disconnected)
248 client_show_raw_error(cl, "client disconnected");
252 client_send_raw_present(cl);
258 static void client_show_raw_delete(struct show_raw *r)
265 void client_show_raw_remove(struct client *cl, void *data)
267 struct show_raw *rr = data;
268 struct show_raw **rrp = &cl->show_raw;
274 client_show_raw_delete(rr);
278 void client_show_raw_dequeue(struct client *cl)
280 struct show_raw *rr = cl->show_raw;
282 cl->show_raw = rr->next;
283 client_show_raw_delete(rr);
286 static void client_show_raw_error(struct client *cl, const char *addinfo)
290 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
291 client_show_raw_dequeue(cl);
295 static void client_send_raw_present(struct client *cl)
297 struct session_database *sdb = client_get_database(cl);
298 struct connection *co = client_get_connection(cl);
299 ZOOM_resultset set = cl->resultset;
301 int offset = cl->show_raw->position;
302 const char *syntax = 0;
303 const char *elements = 0;
305 assert(cl->show_raw);
308 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
309 client_get_url(cl), 1, offset);
311 if (cl->show_raw->syntax)
312 syntax = cl->show_raw->syntax;
314 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
315 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
317 if (cl->show_raw->esn)
318 elements = cl->show_raw->esn;
320 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
321 if (elements && *elements)
322 ZOOM_resultset_option_set(set, "elementSetName", elements);
324 ZOOM_resultset_records(set, 0, offset-1, 1);
325 cl->show_raw->active = 1;
327 connection_continue(co);
330 static int nativesyntax_to_type(struct session_database *sdb, char *type,
333 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
337 if (!strncmp(s, "iso2709", 7))
339 const char *cp = strchr(s, ';');
340 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
342 else if (!strncmp(s, "xml", 3))
350 else /* attempt to deduce structure */
352 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
355 if (!strcmp(syntax, "XML"))
360 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
362 strcpy(type, "xml; charset=marc8-s");
371 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
377 if (cl->show_raw->binary)
381 struct session_database *sdb = client_get_database(cl);
382 nativesyntax_to_type(sdb, type, rec);
385 buf = ZOOM_record_get(rec, type, &len);
386 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
387 client_show_raw_dequeue(cl);
390 void client_search_response(struct client *cl)
392 struct connection *co = cl->connection;
393 struct session *se = cl->session;
394 ZOOM_connection link = connection_get_link(co);
395 ZOOM_resultset resultset = cl->resultset;
396 const char *error, *addinfo;
398 if (ZOOM_connection_error(link, &error, &addinfo))
401 client_set_state(cl, Client_Error);
402 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
403 error, addinfo, client_get_url(cl));
407 cl->record_offset = 0;
408 cl->hits = ZOOM_resultset_size(resultset);
409 se->total_hits += cl->hits;
414 void client_record_response(struct client *cl)
416 struct connection *co = cl->connection;
417 ZOOM_connection link = connection_get_link(co);
418 ZOOM_resultset resultset = cl->resultset;
419 const char *error, *addinfo;
421 if (ZOOM_connection_error(link, &error, &addinfo))
423 client_set_state(cl, Client_Error);
424 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
425 error, addinfo, client_get_url(cl));
430 const char *msg, *addinfo;
432 if (cl->show_raw && cl->show_raw->active)
434 if ((rec = ZOOM_resultset_record(resultset,
435 cl->show_raw->position-1)))
437 cl->show_raw->active = 0;
438 ingest_raw_record(cl, rec);
442 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
443 cl->show_raw->position-1);
448 int offset = cl->record_offset;
449 if ((rec = ZOOM_resultset_record(resultset, offset)))
452 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
453 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
454 error, addinfo, client_get_url(cl),
458 struct session_database *sdb = client_get_database(cl);
461 if (nativesyntax_to_type(sdb, type, rec))
462 yaz_log(YLOG_WARN, "Failed to determine record type");
463 if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
465 if (ingest_record(cl, xmlrec, cl->record_offset))
467 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
468 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
471 yaz_log(YLOG_WARN, "Failed to ingest");
474 yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
480 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
487 void client_start_search(struct client *cl)
489 struct session_database *sdb = client_get_database(cl);
490 struct connection *co = client_get_connection(cl);
491 ZOOM_connection link = connection_get_link(co);
493 char *databaseName = sdb->database->databases[0];
494 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
495 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
496 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
497 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
498 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
499 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
500 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
501 char maxrecs_str[24];
506 cl->record_offset = 0;
508 client_set_state(cl, Client_Working);
511 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
513 ZOOM_connection_option_set(link, "piggyback", "1");
515 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
516 if (*opt_sru && *opt_elements)
517 ZOOM_connection_option_set(link, "schema", opt_elements);
518 else if (*opt_elements)
519 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
521 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
525 sprintf(maxrecs_str, "%d", cl->maxrecs);
526 opt_maxrecs = maxrecs_str;
528 ZOOM_connection_option_set(link, "count", opt_maxrecs);
530 if (atoi(opt_maxrecs) > 20)
531 ZOOM_connection_option_set(link, "presentChunk", "20");
533 ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
536 ZOOM_connection_option_set(link, "databaseName", databaseName);
540 ZOOM_query q = ZOOM_query_create();
541 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
542 ZOOM_query_cql(q, cl->cqlquery);
544 ZOOM_query_sortby(q, opt_sort);
545 rs = ZOOM_connection_search(link, q);
546 ZOOM_query_destroy(q);
550 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
551 rs = ZOOM_connection_search_pqf(link, cl->pquery);
553 ZOOM_resultset_destroy(cl->resultset);
555 connection_continue(co);
558 struct client *client_create(void)
564 client_freelist = client_freelist->next;
567 r = xmalloc(sizeof(struct client));
575 r->record_offset = 0;
577 r->state = Client_Disconnected;
584 void client_destroy(struct client *c)
586 struct session *se = c->session;
587 if (c == se->clients)
588 se->clients = c->next;
592 for (cc = se->clients; cc && cc->next != c; cc = cc->next)
601 connection_release(c->connection);
603 ZOOM_resultset_destroy(c->resultset);
605 c->next = client_freelist;
609 void client_set_connection(struct client *cl, struct connection *con)
611 cl->connection = con;
614 void client_disconnect(struct client *cl)
616 if (cl->state != Client_Idle)
617 client_set_state(cl, Client_Disconnected);
618 client_set_connection(cl, 0);
621 // Extract terms from query into null-terminated termlist
622 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
626 pull_terms(nmem, query, termlist, &num);
630 // Initialize CCL map for a target
631 static CCL_bibset prepare_cclmap(struct client *cl)
633 struct session_database *sdb = client_get_database(cl);
640 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
642 char *p = strchr(s->name + 3, ':');
645 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
650 ccl_qual_fitem(res, s->value, p);
655 // returns a xmalloced CQL query corresponding to the pquery in client
656 static char *make_cqlquery(struct client *cl)
658 cql_transform_t cqlt = cql_transform_create();
661 WRBUF wrb = wrbuf_alloc();
663 ODR odr_out = odr_createmem(ODR_ENCODE);
665 zquery = p_query_rpn(odr_out, cl->pquery);
666 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
667 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
669 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
674 r = xstrdup(wrbuf_cstr(wrb));
677 odr_destroy(odr_out);
678 cql_transform_close(cqlt);
682 // Parse the query given the settings specific to this client
683 int client_parse_query(struct client *cl, const char *query)
685 struct session *se = client_get_session(cl);
686 struct session_database *sdb = client_get_database(cl);
687 struct ccl_rpn_node *cn;
689 CCL_bibset ccl_map = prepare_cclmap(cl);
690 const char *sru = session_setting_oneval(sdb, PZ_SRU);
691 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
696 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
697 ccl_qual_rm(&ccl_map);
700 client_set_state(cl, Client_Error);
701 yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
703 client_get_database(cl)->database->url);
706 wrbuf_rewind(se->wrbuf);
709 wrbuf_puts(se->wrbuf, pqf_prefix);
710 wrbuf_puts(se->wrbuf, " ");
712 ccl_pquery(se->wrbuf, cn);
714 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
719 if (!(cl->cqlquery = make_cqlquery(cl)))
727 // Initialize relevance structure with query terms
729 extract_terms(se->nmem, cn, p);
730 se->relevance = relevance_create(
731 se->service->relevance_pct,
732 se->nmem, (const char **) p);
739 void client_set_session(struct client *cl, struct session *se)
742 cl->next = se->clients;
746 int client_is_active(struct client *cl)
748 if (cl->connection && (cl->state == Client_Connecting ||
749 cl->state == Client_Working))
754 struct client *client_next_in_session(struct client *cl)
762 int client_get_hits(struct client *cl)
767 int client_get_num_records(struct client *cl)
769 return cl->record_offset;
772 int client_get_diagnostic(struct client *cl)
774 return cl->diagnostic;
777 void client_set_database(struct client *cl, struct session_database *db)
782 struct host *client_get_host(struct client *cl)
784 return client_get_database(cl)->database->host;
787 const char *client_get_url(struct client *cl)
789 return client_get_database(cl)->database->url;
792 void client_set_maxrecs(struct client *cl, int v)
800 * c-file-style: "Stroustrup"
801 * indent-tabs-mode: nil
803 * vim: shiftwidth=4 tabstop=8 expandtab