1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2010 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
39 #include <yaz/marcdisp.h>
40 #include <yaz/comstack.h>
41 #include <yaz/tcpip.h>
42 #include <yaz/proto.h>
43 #include <yaz/readconf.h>
44 #include <yaz/pquery.h>
45 #include <yaz/otherinfo.h>
46 #include <yaz/yaz-util.h>
48 #include <yaz/query-charset.h>
49 #include <yaz/querytowrbuf.h>
50 #include <yaz/oid_db.h>
51 #include <yaz/diagbib1.h>
52 #include <yaz/snprintf.h>
53 #include <yaz/rpn2cql.h>
54 #include <yaz/rpn2solr.h>
58 #include <yaz/timing.h>
63 #include "parameters.h"
65 #include "connection.h"
67 #include "relevance.h"
70 /* client counting (1) , disable client counting (0) */
72 static YAZ_MUTEX g_mutex = 0;
73 static int no_clients = 0;
75 static void client_use(int delta)
78 yaz_mutex_create(&g_mutex);
79 yaz_mutex_enter(g_mutex);
81 yaz_mutex_leave(g_mutex);
82 yaz_log(YLOG_DEBUG, "%s clients=%d", delta > 0 ? "INC" : "DEC", no_clients);
88 /** \brief Represents client state for a connection to one search target */
90 struct session_database *database;
91 struct connection *connection;
92 struct session *session;
93 char *pquery; // Current search
94 char *cqlquery; // used for SRU targets only
100 enum client_state state;
101 struct show_raw *show_raw;
102 ZOOM_resultset resultset;
108 int active; // whether this request has been sent to the server
113 void (*error_handler)(void *data, const char *addinfo);
114 void (*record_handler)(void *data, const char *buf, size_t sz);
116 struct show_raw *next;
119 static const char *client_states[] = {
125 "Client_Disconnected"
128 const char *client_get_state_str(struct client *cl)
130 return client_states[cl->state];
133 enum client_state client_get_state(struct client *cl)
138 void client_set_state(struct client *cl, enum client_state st)
141 if (client_is_active(cl))
144 /* If client is going from being active to inactive and all clients
145 are now idle we fire a watch for the session . The assumption is
146 that session is not mutex locked if client is already active */
147 if (was_active && !client_is_active(cl) && cl->session)
149 int no_active = session_active_clients(cl->session);
151 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
155 static void client_show_raw_error(struct client *cl, const char *addinfo);
157 struct connection *client_get_connection(struct client *cl)
159 return cl->connection;
162 struct session_database *client_get_database(struct client *cl)
167 struct session *client_get_session(struct client *cl)
172 const char *client_get_pquery(struct client *cl)
177 static void client_send_raw_present(struct client *cl);
178 static int nativesyntax_to_type(struct session_database *sdb, char *type,
181 static void client_show_immediate(
182 ZOOM_resultset resultset, struct session_database *sdb, int position,
184 void (*error_handler)(void *data, const char *addinfo),
185 void (*record_handler)(void *data, const char *buf, size_t sz),
195 error_handler(data, "no resultset");
198 rec = ZOOM_resultset_record(resultset, position-1);
201 error_handler(data, "no record");
207 nativesyntax_to_type(sdb, type, rec);
208 buf = ZOOM_record_get(rec, type, &len);
211 error_handler(data, "no record");
214 record_handler(data, buf, len);
218 int client_show_raw_begin(struct client *cl, int position,
219 const char *syntax, const char *esn,
221 void (*error_handler)(void *data, const char *addinfo),
222 void (*record_handler)(void *data, const char *buf,
226 if (syntax == 0 && esn == 0)
227 client_show_immediate(cl->resultset, client_get_database(cl),
229 error_handler, record_handler,
233 struct show_raw *rr, **rrp;
239 rr = xmalloc(sizeof(*rr));
240 rr->position = position;
243 rr->error_handler = error_handler;
244 rr->record_handler = record_handler;
247 rr->syntax = xstrdup(syntax);
251 rr->esn = xstrdup(esn);
256 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
260 if (cl->state == Client_Failed)
262 client_show_raw_error(cl, "client failed");
264 else if (cl->state == Client_Disconnected)
266 client_show_raw_error(cl, "client disconnected");
270 client_send_raw_present(cl);
276 static void client_show_raw_delete(struct show_raw *r)
283 void client_show_raw_remove(struct client *cl, void *data)
285 struct show_raw *rr = data;
286 struct show_raw **rrp = &cl->show_raw;
292 client_show_raw_delete(rr);
296 void client_show_raw_dequeue(struct client *cl)
298 struct show_raw *rr = cl->show_raw;
300 cl->show_raw = rr->next;
301 client_show_raw_delete(rr);
304 static void client_show_raw_error(struct client *cl, const char *addinfo)
308 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
309 client_show_raw_dequeue(cl);
313 static void client_send_raw_present(struct client *cl)
315 struct session_database *sdb = client_get_database(cl);
316 struct connection *co = client_get_connection(cl);
317 ZOOM_resultset set = cl->resultset;
319 int offset = cl->show_raw->position;
320 const char *syntax = 0;
321 const char *elements = 0;
323 assert(cl->show_raw);
326 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
327 client_get_url(cl), 1, offset);
329 if (cl->show_raw->syntax)
330 syntax = cl->show_raw->syntax;
332 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
333 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
335 if (cl->show_raw->esn)
336 elements = cl->show_raw->esn;
338 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
339 if (elements && *elements)
340 ZOOM_resultset_option_set(set, "elementSetName", elements);
342 ZOOM_resultset_records(set, 0, offset-1, 1);
343 cl->show_raw->active = 1;
345 connection_continue(co);
348 static int nativesyntax_to_type(struct session_database *sdb, char *type,
351 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
355 if (!strncmp(s, "iso2709", 7))
357 const char *cp = strchr(s, ';');
358 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
360 else if (!strncmp(s, "xml", 3))
364 else if (!strncmp(s, "txml", 4))
366 const char *cp = strchr(s, ';');
367 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
373 else /* attempt to deduce structure */
375 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
378 if (!strcmp(syntax, "XML"))
383 else if (!strcmp(syntax, "TXML"))
385 strcpy(type, "txml");
388 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
390 strcpy(type, "xml; charset=marc8-s");
400 * TODO Consider thread safety!!!
403 int client_report_facets(struct client *cl, ZOOM_resultset rs) {
405 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
407 struct session *se = client_get_session(cl);
408 facet_num = ZOOM_resultset_facets_size(rs);
409 yaz_log(YLOG_DEBUG, "client_report_facets: %d", facet_num);
411 for (facet_idx = 0; facet_idx < facet_num; facet_idx++) {
412 const char *name = ZOOM_facet_field_name(facets[facet_idx]);
414 size_t term_num = ZOOM_facet_field_term_count(facets[facet_idx]);
415 for (term_idx = 0; term_idx < term_num; term_idx++ ) {
417 const char *term = ZOOM_facet_field_get_term(facets[facet_idx], term_idx, &freq);
419 add_facet(se, name, term, freq);
426 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
432 if (cl->show_raw->binary)
436 struct session_database *sdb = client_get_database(cl);
437 nativesyntax_to_type(sdb, type, rec);
440 buf = ZOOM_record_get(rec, type, &len);
441 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
442 client_show_raw_dequeue(cl);
445 void client_search_response(struct client *cl)
447 struct connection *co = cl->connection;
448 struct session *se = cl->session;
449 ZOOM_connection link = connection_get_link(co);
450 ZOOM_resultset resultset = cl->resultset;
452 const char *error, *addinfo = 0;
454 if (ZOOM_connection_error(link, &error, &addinfo))
457 client_set_state(cl, Client_Error);
458 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
459 error, addinfo, client_get_url(cl));
463 client_report_facets(cl, resultset);
464 cl->record_offset = cl->startrecs;
465 cl->hits = ZOOM_resultset_size(resultset);
467 se->total_hits += cl->hits;
471 void client_got_records(struct client *cl)
473 struct session *se = cl->session;
477 session_alert_watch(se, SESSION_WATCH_SHOW);
478 session_alert_watch(se, SESSION_WATCH_RECORD);
483 void client_record_response(struct client *cl)
485 struct connection *co = cl->connection;
486 ZOOM_connection link = connection_get_link(co);
487 ZOOM_resultset resultset = cl->resultset;
488 const char *error, *addinfo;
490 if (ZOOM_connection_error(link, &error, &addinfo))
492 client_set_state(cl, Client_Error);
493 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
494 error, addinfo, client_get_url(cl));
499 const char *msg, *addinfo;
501 if (cl->show_raw && cl->show_raw->active)
503 if ((rec = ZOOM_resultset_record(resultset,
504 cl->show_raw->position-1)))
506 cl->show_raw->active = 0;
507 ingest_raw_record(cl, rec);
511 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
512 cl->show_raw->position-1);
517 int offset = cl->record_offset;
518 if ((rec = ZOOM_resultset_record(resultset, offset)))
521 if (cl->session == 0)
523 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
525 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
526 msg, addinfo, client_get_url(cl),
531 struct session_database *sdb = client_get_database(cl);
532 NMEM nmem = nmem_create();
536 if (nativesyntax_to_type(sdb, type, rec))
537 yaz_log(YLOG_WARN, "Failed to determine record type");
538 xmlrec = ZOOM_record_get(rec, type, NULL);
540 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
544 if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
545 yaz_log(YLOG_WARN, "Failed to ingest from %s",
553 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
560 static int client_set_facets_request(struct client *cl, ZOOM_connection link)
562 struct session_database *sdb = client_get_database(cl);
563 const char *opt_facet_term_sort = session_setting_oneval(sdb, PZ_TERMLIST_TERM_SORT);
564 const char *opt_facet_term_count = session_setting_oneval(sdb, PZ_TERMLIST_TERM_COUNT);
565 /* Disable when no count is set */
566 /* TODO Verify: Do we need to reset the ZOOM facets if a ZOOM Connection is being reused??? */
567 if (opt_facet_term_count && *opt_facet_term_count)
570 struct session *session = client_get_session(cl);
571 struct conf_service *service = session->service;
572 int num = service->num_metadata;
573 WRBUF wrbuf = wrbuf_alloc();
574 yaz_log(YLOG_DEBUG, "Facet settings, sort: %s count: %s",
575 opt_facet_term_sort, opt_facet_term_count);
576 for (index = 0; index < num; index++)
578 struct conf_metadata *conf_meta = &service->metadata[index];
579 if (conf_meta->termlist)
581 if (wrbuf_len(wrbuf))
582 wrbuf_puts(wrbuf, ", ");
583 wrbuf_printf(wrbuf, "@attr 1=%s", conf_meta->name);
585 if (opt_facet_term_sort && *opt_facet_term_sort)
586 wrbuf_printf(wrbuf, " @attr 2=%s", opt_facet_term_sort);
587 wrbuf_printf(wrbuf, " @attr 3=%s", opt_facet_term_count);
590 if (wrbuf_len(wrbuf))
592 yaz_log(YLOG_LOG, "Setting ZOOM facets option: %s", wrbuf_cstr(wrbuf));
593 ZOOM_connection_option_set(link, "facets", wrbuf_cstr(wrbuf));
600 int client_has_facet(struct client *cl, const char *name) {
601 ZOOM_facet_field facet_field;
602 if (!cl || !cl->resultset || !name) {
603 yaz_log(YLOG_DEBUG, "client has facet: Missing %p %p %s", cl, (cl ? cl->resultset: 0), name);
606 facet_field = ZOOM_resultset_get_facet_field(cl->resultset, name);
608 yaz_log(YLOG_DEBUG, "client: has facets for %s", name);
611 yaz_log(YLOG_DEBUG, "client: No facets for %s", name);
616 void client_start_search(struct client *cl)
618 struct session_database *sdb = client_get_database(cl);
619 struct connection *co = client_get_connection(cl);
620 ZOOM_connection link = connection_get_link(co);
622 char *databaseName = sdb->database->databases[0];
623 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
624 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
625 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
626 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
627 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
628 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
629 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
630 char maxrecs_str[24], startrecs_str[24];
635 cl->record_offset = 0;
637 client_set_state(cl, Client_Working);
640 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
642 ZOOM_connection_option_set(link, "piggyback", "1");
644 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
645 if (*opt_sru && *opt_elements)
646 ZOOM_connection_option_set(link, "schema", opt_elements);
647 else if (*opt_elements)
648 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
650 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
654 sprintf(maxrecs_str, "%d", cl->maxrecs);
655 opt_maxrecs = maxrecs_str;
657 ZOOM_connection_option_set(link, "count", opt_maxrecs);
660 if (atoi(opt_maxrecs) > 20)
661 ZOOM_connection_option_set(link, "presentChunk", "20");
663 ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
665 sprintf(startrecs_str, "%d", cl->startrecs);
666 ZOOM_connection_option_set(link, "start", startrecs_str);
669 ZOOM_connection_option_set(link, "databaseName", databaseName);
671 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
672 client_set_facets_request(cl, link);
676 ZOOM_query q = ZOOM_query_create();
677 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
678 ZOOM_query_cql(q, cl->cqlquery);
680 ZOOM_query_sortby(q, opt_sort);
681 rs = ZOOM_connection_search(link, q);
682 ZOOM_query_destroy(q);
686 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
687 rs = ZOOM_connection_search_pqf(link, cl->pquery);
689 ZOOM_resultset_destroy(cl->resultset);
691 connection_continue(co);
694 struct client *client_create(void)
696 struct client *r = xmalloc(sizeof(*r));
705 r->record_offset = 0;
707 r->state = Client_Disconnected;
711 pazpar2_mutex_create(&r->mutex, "client");
719 void client_lock(struct client *c)
721 yaz_mutex_enter(c->mutex);
724 void client_unlock(struct client *c)
726 yaz_mutex_leave(c->mutex);
729 void client_incref(struct client *c)
731 pazpar2_incref(&c->ref_count, c->mutex);
732 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
733 c, client_get_url(c), c->ref_count);
736 int client_destroy(struct client *c)
740 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
741 c, client_get_url(c), c->ref_count);
742 if (!pazpar2_decref(&c->ref_count, c->mutex))
748 assert(!c->connection);
752 ZOOM_resultset_destroy(c->resultset);
754 yaz_mutex_destroy(&c->mutex);
763 void client_set_connection(struct client *cl, struct connection *con)
766 ZOOM_resultset_release(cl->resultset);
769 assert(cl->connection == 0);
770 cl->connection = con;
775 cl->connection = con;
780 void client_disconnect(struct client *cl)
782 if (cl->state != Client_Idle)
783 client_set_state(cl, Client_Disconnected);
784 client_set_connection(cl, 0);
787 // Extract terms from query into null-terminated termlist
788 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
792 pull_terms(nmem, query, termlist, &num);
796 // Initialize CCL map for a target
797 static CCL_bibset prepare_cclmap(struct client *cl)
799 struct session_database *sdb = client_get_database(cl);
806 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
808 char *p = strchr(s->name + 3, ':');
811 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
816 ccl_qual_fitem(res, s->value, p);
821 // returns a xmalloced CQL query corresponding to the pquery in client
822 static char *make_cqlquery(struct client *cl)
824 cql_transform_t cqlt = cql_transform_create();
827 WRBUF wrb = wrbuf_alloc();
829 ODR odr_out = odr_createmem(ODR_ENCODE);
831 zquery = p_query_rpn(odr_out, cl->pquery);
832 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
833 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
835 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
840 r = xstrdup(wrbuf_cstr(wrb));
843 odr_destroy(odr_out);
844 cql_transform_close(cqlt);
848 // returns a xmalloced SOLR query corresponding to the pquery in client
849 // TODO Could prob. be merge with the similar make_cqlquery
850 static char *make_solrquery(struct client *cl)
852 solr_transform_t sqlt = solr_transform_create();
855 WRBUF wrb = wrbuf_alloc();
857 ODR odr_out = odr_createmem(ODR_ENCODE);
859 zquery = p_query_rpn(odr_out, cl->pquery);
860 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
861 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
863 yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
868 r = xstrdup(wrbuf_cstr(wrb));
871 odr_destroy(odr_out);
872 solr_transform_close(sqlt);
876 // Parse the query given the settings specific to this client
877 int client_parse_query(struct client *cl, const char *query)
879 struct session *se = client_get_session(cl);
880 struct session_database *sdb = client_get_database(cl);
881 struct ccl_rpn_node *cn;
883 CCL_bibset ccl_map = prepare_cclmap(cl);
884 const char *sru = session_setting_oneval(sdb, PZ_SRU);
885 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
886 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
891 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
892 ccl_qual_rm(&ccl_map);
895 client_set_state(cl, Client_Error);
896 yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
898 client_get_database(cl)->database->url);
901 wrbuf_rewind(se->wrbuf);
904 wrbuf_puts(se->wrbuf, pqf_prefix);
905 wrbuf_puts(se->wrbuf, " ");
907 if (!pqf_strftime || !*pqf_strftime)
908 ccl_pquery(se->wrbuf, cn);
911 time_t cur_time = time(0);
912 struct tm *tm = localtime(&cur_time);
914 const char *cp = tmp_str;
916 /* see man strftime(3) for things .. In particular %% gets converted
917 to %.. And That's our original query .. */
918 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
922 ccl_pquery(se->wrbuf, cn);
924 wrbuf_putc(se->wrbuf, cp[0]);
928 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
933 if (!strcmp(sru, "solr")) {
934 if (!(cl->cqlquery = make_solrquery(cl)))
938 if (!(cl->cqlquery = make_cqlquery(cl)))
945 /* TODO FIX Not thread safe */
948 // Initialize relevance structure with query terms
950 extract_terms(se->nmem, cn, p);
951 se->relevance = relevance_create(
952 se->service->relevance_pct,
953 se->nmem, (const char **) p);
960 void client_set_session(struct client *cl, struct session *se)
965 int client_is_active(struct client *cl)
967 if (cl->connection && (cl->state == Client_Connecting ||
968 cl->state == Client_Working))
973 Odr_int client_get_hits(struct client *cl)
978 int client_get_num_records(struct client *cl)
980 return cl->record_offset;
983 void client_set_diagnostic(struct client *cl, int diagnostic)
985 cl->diagnostic = diagnostic;
988 int client_get_diagnostic(struct client *cl)
990 return cl->diagnostic;
993 void client_set_database(struct client *cl, struct session_database *db)
998 struct host *client_get_host(struct client *cl)
1000 return client_get_database(cl)->database->host;
1003 const char *client_get_url(struct client *cl)
1006 return client_get_database(cl)->database->url;
1011 void client_set_maxrecs(struct client *cl, int v)
1016 void client_set_startrecs(struct client *cl, int v)
1024 * c-file-style: "Stroustrup"
1025 * indent-tabs-mode: nil
1027 * vim: shiftwidth=4 tabstop=8 expandtab