1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2011 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 static YAZ_MUTEX g_mutex = 0;
71 static int no_clients = 0;
72 static int no_clients_total = 0;
74 static int client_use(int delta)
78 yaz_mutex_create(&g_mutex);
79 yaz_mutex_enter(g_mutex);
82 no_clients_total += delta;
84 yaz_mutex_leave(g_mutex);
85 yaz_log(YLOG_DEBUG, "%s clients=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
89 int clients_count(void) {
93 int clients_count_total(void) {
97 yaz_mutex_enter(g_mutex);
98 total = no_clients_total;
99 yaz_mutex_leave(g_mutex);
104 /** \brief Represents client state for a connection to one search target */
106 struct session_database *database;
107 struct connection *connection;
108 struct session *session;
109 char *pquery; // Current search
110 char *cqlquery; // used for SRU targets only
117 struct suggestions *suggestions;
118 enum client_state state;
119 struct show_raw *show_raw;
120 ZOOM_resultset resultset;
124 facet_limits_t facet_limits;
136 int active; // whether this request has been sent to the server
141 void (*error_handler)(void *data, const char *addinfo);
142 void (*record_handler)(void *data, const char *buf, size_t sz);
144 struct show_raw *next;
147 static const char *client_states[] = {
153 "Client_Disconnected"
156 const char *client_get_state_str(struct client *cl)
158 return client_states[cl->state];
161 enum client_state client_get_state(struct client *cl)
166 void client_set_state_nb(struct client *cl, enum client_state st)
171 void client_set_state(struct client *cl, enum client_state st)
174 if (client_is_active(cl))
177 /* If client is going from being active to inactive and all clients
178 are now idle we fire a watch for the session . The assumption is
179 that session is not mutex locked if client is already active */
180 if (was_active && !client_is_active(cl) && cl->session)
183 int no_active = session_active_clients(cl->session);
184 yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
185 client_get_id(cl), no_active);
186 if (no_active == 0) {
187 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
188 session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
189 session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
190 session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
195 static void client_show_raw_error(struct client *cl, const char *addinfo);
197 struct connection *client_get_connection(struct client *cl)
199 return cl->connection;
202 struct session_database *client_get_database(struct client *cl)
207 struct session *client_get_session(struct client *cl)
212 const char *client_get_pquery(struct client *cl)
217 static void client_send_raw_present(struct client *cl);
218 static int nativesyntax_to_type(struct session_database *sdb, char *type,
221 static void client_show_immediate(
222 ZOOM_resultset resultset, struct session_database *sdb, int position,
224 void (*error_handler)(void *data, const char *addinfo),
225 void (*record_handler)(void *data, const char *buf, size_t sz),
235 error_handler(data, "no resultset");
238 rec = ZOOM_resultset_record(resultset, position-1);
241 error_handler(data, "no record");
247 nativesyntax_to_type(sdb, type, rec);
248 buf = ZOOM_record_get(rec, type, &len);
251 error_handler(data, "no record");
254 record_handler(data, buf, len);
258 int client_show_raw_begin(struct client *cl, int position,
259 const char *syntax, const char *esn,
261 void (*error_handler)(void *data, const char *addinfo),
262 void (*record_handler)(void *data, const char *buf,
266 if (syntax == 0 && esn == 0)
267 client_show_immediate(cl->resultset, client_get_database(cl),
269 error_handler, record_handler,
273 struct show_raw *rr, **rrp;
279 rr = xmalloc(sizeof(*rr));
280 rr->position = position;
283 rr->error_handler = error_handler;
284 rr->record_handler = record_handler;
287 rr->syntax = xstrdup(syntax);
291 rr->esn = xstrdup(esn);
296 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
300 if (cl->state == Client_Failed)
302 client_show_raw_error(cl, "client failed");
304 else if (cl->state == Client_Disconnected)
306 client_show_raw_error(cl, "client disconnected");
310 client_send_raw_present(cl);
316 static void client_show_raw_delete(struct show_raw *r)
323 void client_show_raw_remove(struct client *cl, void *data)
325 struct show_raw *rr = data;
326 struct show_raw **rrp = &cl->show_raw;
332 client_show_raw_delete(rr);
336 void client_show_raw_dequeue(struct client *cl)
338 struct show_raw *rr = cl->show_raw;
340 cl->show_raw = rr->next;
341 client_show_raw_delete(rr);
344 static void client_show_raw_error(struct client *cl, const char *addinfo)
348 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
349 client_show_raw_dequeue(cl);
353 static void client_send_raw_present(struct client *cl)
355 struct session_database *sdb = client_get_database(cl);
356 struct connection *co = client_get_connection(cl);
357 ZOOM_resultset set = cl->resultset;
359 int offset = cl->show_raw->position;
360 const char *syntax = 0;
361 const char *elements = 0;
363 assert(cl->show_raw);
366 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
367 client_get_id(cl), 1, offset);
369 if (cl->show_raw->syntax)
370 syntax = cl->show_raw->syntax;
372 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
373 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
375 if (cl->show_raw->esn)
376 elements = cl->show_raw->esn;
378 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
379 if (elements && *elements)
380 ZOOM_resultset_option_set(set, "elementSetName", elements);
382 ZOOM_resultset_records(set, 0, offset-1, 1);
383 cl->show_raw->active = 1;
385 connection_continue(co);
388 static int nativesyntax_to_type(struct session_database *sdb, char *type,
391 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
395 if (!strncmp(s, "iso2709", 7))
397 const char *cp = strchr(s, ';');
398 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
400 else if (!strncmp(s, "xml", 3))
404 else if (!strncmp(s, "txml", 4))
406 const char *cp = strchr(s, ';');
407 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
413 else /* attempt to deduce structure */
415 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
418 if (!strcmp(syntax, "XML"))
423 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
425 strcpy(type, "xml; charset=marc8-s");
435 * TODO Consider thread safety!!!
438 void client_report_facets(struct client *cl, ZOOM_resultset rs)
440 struct session_database *sdb = client_get_database(cl);
441 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
445 struct session *se = client_get_session(cl);
446 int facet_num = ZOOM_resultset_facets_size(rs);
449 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
451 const char *p = strchr(s->name + 3, ':');
452 if (p && p[1] && s->value && s->value[0])
455 p++; /* p now holds logical facet name */
456 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
458 const char *native_name =
459 ZOOM_facet_field_name(facets[facet_idx]);
460 if (native_name && !strcmp(s->value, native_name))
464 ZOOM_facet_field_term_count(facets[facet_idx]);
465 for (term_idx = 0; term_idx < term_num; term_idx++ )
469 ZOOM_facet_field_get_term(facets[facet_idx],
472 add_facet(se, p, term, freq);
482 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
488 if (cl->show_raw->binary)
492 struct session_database *sdb = client_get_database(cl);
493 nativesyntax_to_type(sdb, type, rec);
496 buf = ZOOM_record_get(rec, type, &len);
497 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
498 client_show_raw_dequeue(cl);
501 void client_check_preferred_watch(struct client *cl)
503 struct session *se = cl->session;
504 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
508 /* TODO possible threading issue. Session can have been destroyed */
509 if (session_is_preferred_clients_ready(se)) {
510 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
513 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
518 yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
522 struct suggestions* client_suggestions_create(const char* suggestions_string);
523 static void client_suggestions_destroy(struct client *cl);
525 void client_search_response(struct client *cl)
527 struct connection *co = cl->connection;
528 ZOOM_connection link = connection_get_link(co);
529 ZOOM_resultset resultset = cl->resultset;
531 const char *error, *addinfo = 0;
533 if (ZOOM_connection_error(link, &error, &addinfo))
536 client_set_state(cl, Client_Error);
537 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
538 error, addinfo, client_get_id(cl));
542 yaz_log(YLOG_DEBUG, "client_search_response: hits "
543 ODR_INT_PRINTF, cl->hits);
544 client_report_facets(cl, resultset);
545 cl->record_offset = cl->startrecs;
546 cl->hits = ZOOM_resultset_size(resultset);
548 client_suggestions_destroy(cl);
549 cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
553 void client_got_records(struct client *cl)
555 struct session *se = cl->session;
558 if (reclist_get_num_records(se->reclist) > 0)
561 session_alert_watch(se, SESSION_WATCH_SHOW);
562 session_alert_watch(se, SESSION_WATCH_BYTARGET);
563 session_alert_watch(se, SESSION_WATCH_TERMLIST);
564 session_alert_watch(se, SESSION_WATCH_RECORD);
570 static void client_record_ingest(struct client *cl)
572 const char *msg, *addinfo;
574 ZOOM_resultset resultset = cl->resultset;
575 int offset = cl->record_offset;
576 if ((rec = ZOOM_resultset_record(resultset, offset)))
579 if (cl->session == 0)
581 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
583 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
584 msg, addinfo, client_get_id(cl),
589 struct session_database *sdb = client_get_database(cl);
590 NMEM nmem = nmem_create();
594 if (nativesyntax_to_type(sdb, type, rec))
595 yaz_log(YLOG_WARN, "Failed to determine record type");
596 xmlrec = ZOOM_record_get(rec, type, NULL);
598 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
602 /* OK = 0, -1 = failure, -2 = Filtered */
603 if (ingest_record(cl, xmlrec, cl->record_offset, nmem) == -1)
604 yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
611 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
616 void client_record_response(struct client *cl)
618 struct connection *co = cl->connection;
619 ZOOM_connection link = connection_get_link(co);
620 ZOOM_resultset resultset = cl->resultset;
621 const char *error, *addinfo;
623 if (ZOOM_connection_error(link, &error, &addinfo))
625 client_set_state(cl, Client_Error);
626 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
627 error, addinfo, client_get_id(cl));
631 if (cl->show_raw && cl->show_raw->active)
634 if ((rec = ZOOM_resultset_record(resultset,
635 cl->show_raw->position-1)))
637 cl->show_raw->active = 0;
638 ingest_raw_record(cl, rec);
642 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
643 cl->show_raw->position-1);
648 client_record_ingest(cl);
653 void client_reingest(struct client *cl)
655 int i = cl->startrecs;
656 int to = cl->record_offset;
658 cl->record_offset = i;
660 client_record_ingest(cl);
663 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
665 struct session_database *sdb = client_get_database(cl);
667 WRBUF w = wrbuf_alloc();
671 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
673 const char *p = strchr(s->name + 3, ':');
676 yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
678 else if (s->value && s->value[0])
680 wrbuf_puts(w, "@attr 1=");
681 yaz_encode_pqf_term(w, s->value, strlen(s->value));
686 yaz_log(YLOG_LOG, "using facets str: %s", wrbuf_cstr(w));
687 ZOOM_connection_option_set(link, "facets",
688 wrbuf_len(w) ? wrbuf_cstr(w) : 0);
692 int client_has_facet(struct client *cl, const char *name)
694 struct session_database *sdb = client_get_database(cl);
697 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
699 const char *p = strchr(s->name + 3, ':');
700 if (p && !strcmp(name, p + 1))
706 static const char *get_strategy_plus_sort(struct client *l, const char *field)
708 struct session_database *sdb = client_get_database(l);
711 const char *strategy_plus_sort = 0;
713 for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
715 char *p = strchr(s->name + 3, ':');
718 yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
722 if (!strcmp(p, field))
724 strategy_plus_sort = s->value;
728 return strategy_plus_sort;
731 void client_start_search(struct client *cl)
733 struct session_database *sdb = client_get_database(cl);
734 struct connection *co = client_get_connection(cl);
735 ZOOM_connection link = connection_get_link(co);
736 struct session *se = client_get_session(cl);
738 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
739 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
740 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
741 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
742 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
743 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
744 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
745 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
746 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
747 char maxrecs_str[24], startrecs_str[24];
754 if (extra_args && *extra_args)
755 ZOOM_connection_option_set(link, "extraArgs", extra_args);
758 cl->preferred = atoi(opt_preferred);
760 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
761 client_get_id(cl), cl->preferred);
763 client_set_state(cl, Client_Working);
766 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
768 ZOOM_connection_option_set(link, "piggyback", "1");
770 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
771 if (*opt_sru && *opt_elements)
772 ZOOM_connection_option_set(link, "schema", opt_elements);
773 else if (*opt_elements)
774 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
776 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
778 if (opt_maxrecs && *opt_maxrecs)
780 cl->maxrecs = atoi(opt_maxrecs);
783 /* convert back to string representation used in ZOOM API */
784 sprintf(maxrecs_str, "%d", cl->maxrecs);
785 ZOOM_connection_option_set(link, "count", maxrecs_str);
787 if (cl->maxrecs > 20)
788 ZOOM_connection_option_set(link, "presentChunk", "20");
790 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
792 sprintf(startrecs_str, "%d", cl->startrecs);
793 ZOOM_connection_option_set(link, "start", startrecs_str);
795 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
796 /* facets definition is in PQF */
797 client_set_facets_request(cl, link);
799 q = ZOOM_query_create();
802 yaz_log(YLOG_LOG, "Search %s CQL: %s", client_get_id(cl),
804 ZOOM_query_cql(q, cl->cqlquery);
806 ZOOM_query_sortby(q, opt_sort);
810 yaz_log(YLOG_LOG, "Search %s PQF: %s", client_get_id(cl), cl->pquery);
812 ZOOM_query_prefix(q, cl->pquery);
814 if (se->sorted_results)
815 { /* first entry is current sorting ! */
816 const char *sort_strategy_and_spec =
817 get_strategy_plus_sort(cl, se->sorted_results->field);
818 int increasing = se->sorted_results->increasing;
819 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
822 strcpy(spec, sort_strategy_and_spec);
823 p = strchr(spec, ':');
826 *p++ = '\0'; /* cut the string in two */
833 yaz_log(YLOG_LOG, "applying %s %s", spec, p);
834 ZOOM_query_sortby2(q, spec, p);
839 /* no native sorting.. If this is not the first search, then
841 if (se->sorted_results->next)
843 ZOOM_query_destroy(q);
844 client_set_state_nb(cl, Client_Idle);
850 cl->record_offset = 0;
851 rs = ZOOM_connection_search(link, q);
852 ZOOM_query_destroy(q);
853 ZOOM_resultset_destroy(cl->resultset);
855 connection_continue(co);
858 struct client *client_create(const char *id)
860 struct client *cl = xmalloc(sizeof(*cl));
869 cl->record_offset = 0;
871 cl->state = Client_Disconnected;
876 pazpar2_mutex_create(&cl->mutex, "client");
879 cl->facet_limits = 0;
881 cl->id = xstrdup(id);
887 void client_lock(struct client *c)
889 yaz_mutex_enter(c->mutex);
892 void client_unlock(struct client *c)
894 yaz_mutex_leave(c->mutex);
897 void client_incref(struct client *c)
899 pazpar2_incref(&c->ref_count, c->mutex);
900 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
901 c, client_get_id(c), c->ref_count);
904 int client_destroy(struct client *c)
908 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
909 c, client_get_id(c), c->ref_count);
910 if (!pazpar2_decref(&c->ref_count, c->mutex))
917 assert(!c->connection);
918 facet_limits_destroy(c->facet_limits);
922 ZOOM_resultset_destroy(c->resultset);
924 yaz_mutex_destroy(&c->mutex);
933 void client_set_connection(struct client *cl, struct connection *con)
936 ZOOM_resultset_release(cl->resultset);
939 assert(cl->connection == 0);
940 cl->connection = con;
945 cl->connection = con;
950 void client_disconnect(struct client *cl)
952 if (cl->state != Client_Idle)
953 client_set_state(cl, Client_Disconnected);
954 client_set_connection(cl, 0);
958 // Initialize CCL map for a target
959 static CCL_bibset prepare_cclmap(struct client *cl)
961 struct session_database *sdb = client_get_database(cl);
968 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
970 char *p = strchr(s->name + 3, ':');
973 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
978 ccl_qual_fitem(res, s->value, p);
983 // returns a xmalloced CQL query corresponding to the pquery in client
984 static char *make_cqlquery(struct client *cl)
986 cql_transform_t cqlt = cql_transform_create();
989 WRBUF wrb = wrbuf_alloc();
991 ODR odr_out = odr_createmem(ODR_ENCODE);
993 zquery = p_query_rpn(odr_out, cl->pquery);
994 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
995 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
997 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1002 r = xstrdup(wrbuf_cstr(wrb));
1005 odr_destroy(odr_out);
1006 cql_transform_close(cqlt);
1010 // returns a xmalloced SOLR query corresponding to the pquery in client
1011 // TODO Could prob. be merge with the similar make_cqlquery
1012 static char *make_solrquery(struct client *cl)
1014 solr_transform_t sqlt = solr_transform_create();
1017 WRBUF wrb = wrbuf_alloc();
1019 ODR odr_out = odr_createmem(ODR_ENCODE);
1021 zquery = p_query_rpn(odr_out, cl->pquery);
1023 yaz_log(YLOG_WARN, "Failed to generate RPN from PQF: %s", cl->pquery);
1026 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
1027 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1029 yaz_log(YLOG_WARN, "Failed to generate SOLR query from PQF %s, code=%d", cl->pquery, status);
1034 r = xstrdup(wrbuf_cstr(wrb));
1037 odr_destroy(odr_out);
1038 solr_transform_close(sqlt);
1042 const char *client_get_facet_limit_local(struct client *cl,
1043 struct session_database *sdb,
1045 NMEM nmem, int *num, char ***values)
1047 const char *name = 0;
1048 const char *value = 0;
1049 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1051 struct setting *s = 0;
1053 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1055 const char *p = strchr(s->name + 3, ':');
1056 if (p && !strcmp(p + 1, name) && s->value &&
1057 !strncmp(s->value, "local:", 6))
1059 nmem_strsplit_escape2(nmem, "|", value, values,
1069 static int apply_limit(struct session_database *sdb,
1070 facet_limits_t facet_limits,
1071 WRBUF w_pqf, WRBUF w_ccl)
1077 NMEM nmem_tmp = nmem_create();
1078 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1080 struct setting *s = 0;
1082 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1084 const char *p = strchr(s->name + 3, ':');
1085 if (p && !strcmp(p + 1, name) && s->value)
1089 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1092 if (!strncmp(s->value, "rpn:", 4))
1094 const char *pqf = s->value + 4;
1096 wrbuf_puts(w_pqf, "@and ");
1097 wrbuf_puts(w_pqf, pqf);
1098 wrbuf_puts(w_pqf, " ");
1099 for (i = 0; i < num; i++)
1102 wrbuf_puts(w_pqf, "@or ");
1103 yaz_encode_pqf_term(w_pqf, values[i],
1107 else if (!strncmp(s->value, "ccl:", 4))
1109 const char *ccl = s->value + 4;
1111 wrbuf_puts(w_ccl, " and (");
1113 for (i = 0; i < num; i++)
1116 wrbuf_puts(w_ccl, " or ");
1117 wrbuf_puts(w_ccl, ccl);
1118 wrbuf_puts(w_ccl, "=\"");
1119 wrbuf_puts(w_ccl, values[i]);
1120 wrbuf_puts(w_ccl, "\"");
1122 wrbuf_puts(w_ccl, ")");
1125 else if (!strncmp(s->value, "local:", 6))
1129 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1130 sdb->database->id, s->value);
1131 ret = -1; /* bad limitmap */
1136 nmem_reset(nmem_tmp);
1139 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1140 (sdb->database ? sdb->database->id : "<no id>"), name);
1143 nmem_destroy(nmem_tmp);
1147 // Parse the query given the settings specific to this client
1148 int client_parse_query(struct client *cl, const char *query,
1149 facet_limits_t facet_limits,
1150 const char *startrecs, const char *maxrecs)
1152 struct session *se = client_get_session(cl);
1153 struct session_database *sdb = client_get_database(cl);
1154 struct ccl_rpn_node *cn;
1156 CCL_bibset ccl_map = prepare_cclmap(cl);
1157 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1158 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1159 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1160 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1168 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
1171 cl->maxrecs = atoi(maxrecs);
1174 if (startrecs && atoi(startrecs) != cl->startrecs)
1177 cl->startrecs = atoi(startrecs);
1180 w_ccl = wrbuf_alloc();
1181 wrbuf_puts(w_ccl, query);
1183 w_pqf = wrbuf_alloc();
1186 wrbuf_puts(w_pqf, pqf_prefix);
1187 wrbuf_puts(w_pqf, " ");
1190 if (apply_limit(sdb, facet_limits, w_pqf, w_ccl))
1193 facet_limits_destroy(cl->facet_limits);
1194 cl->facet_limits = facet_limits_dup(facet_limits);
1196 yaz_log(YLOG_LOG, "CCL query: %s", wrbuf_cstr(w_ccl));
1197 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1198 ccl_qual_rm(&ccl_map);
1201 client_set_state(cl, Client_Error);
1202 session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s",
1205 wrbuf_destroy(w_ccl);
1206 wrbuf_destroy(w_pqf);
1209 wrbuf_destroy(w_ccl);
1211 if (!pqf_strftime || !*pqf_strftime)
1212 ccl_pquery(w_pqf, cn);
1215 time_t cur_time = time(0);
1216 struct tm *tm = localtime(&cur_time);
1218 const char *cp = tmp_str;
1220 /* see man strftime(3) for things .. In particular %% gets converted
1221 to %.. And That's our original query .. */
1222 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1226 ccl_pquery(w_pqf, cn);
1228 wrbuf_putc(w_pqf, cp[0]);
1231 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1234 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1237 wrbuf_destroy(w_pqf);
1239 yaz_log(YLOG_LOG, "PQF query: %s", cl->pquery);
1241 xfree(cl->cqlquery);
1243 /* Support for PQF on SRU targets. */
1245 yaz_log(YLOG_DEBUG, "Query syntax: %s", query_syntax);
1246 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1248 if (!strcmp(sru, "solr")) {
1249 if (!(cl->cqlquery = make_solrquery(cl)))
1253 if (!(cl->cqlquery = make_cqlquery(cl)))
1260 /* TODO FIX Not thread safe */
1263 // Initialize relevance structure with query terms
1264 se->relevance = relevance_create_ccl(
1265 se->service->charsets, se->nmem, cn);
1272 void client_set_session(struct client *cl, struct session *se)
1277 int client_is_active(struct client *cl)
1279 if (cl->connection && (cl->state == Client_Connecting ||
1280 cl->state == Client_Working))
1285 int client_is_active_preferred(struct client *cl)
1287 /* only count if this is a preferred target. */
1290 /* TODO No sure this the condition that Seb wants */
1291 if (cl->connection && (cl->state == Client_Connecting ||
1292 cl->state == Client_Working))
1297 Odr_int client_get_hits(struct client *cl)
1302 int client_get_num_records(struct client *cl)
1304 return cl->record_offset;
1307 void client_set_diagnostic(struct client *cl, int diagnostic)
1309 cl->diagnostic = diagnostic;
1312 int client_get_diagnostic(struct client *cl)
1314 return cl->diagnostic;
1317 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1320 struct suggestions *suggestions = cl->suggestions;
1323 //yaz_log(YLOG_DEBUG, "No suggestions found");
1326 if (suggestions->passthrough) {
1327 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1328 return suggestions->passthrough;
1330 if (suggestions->num == 0) {
1334 for (idx = 0; idx < suggestions->num; idx++) {
1335 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1336 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1337 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1338 wrbuf_puts(wrbuf, "</suggest>\n");
1341 wrbuf_puts(wrbuf, "/>\n");
1344 return wrbuf_cstr(wrbuf);
1348 void client_set_database(struct client *cl, struct session_database *db)
1353 const char *client_get_id(struct client *cl)
1358 int client_get_maxrecs(struct client *cl)
1363 void client_set_preferred(struct client *cl, int v)
1369 struct suggestions* client_suggestions_create(const char* suggestions_string)
1373 struct suggestions *suggestions;
1374 if (suggestions_string == 0)
1376 nmem = nmem_create();
1377 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1378 yaz_log(YLOG_DEBUG, "client target suggestions: %s", suggestions_string);
1380 suggestions->nmem = nmem;
1381 suggestions->num = 0;
1382 suggestions->misspelled = 0;
1383 suggestions->suggest = 0;
1384 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1386 if (suggestions_string)
1387 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1388 &suggestions->num, 1, '\\', 0);
1389 /* Set up misspelled array */
1390 suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1391 /* replace = with \0 .. for each item */
1392 for (i = 0; i < suggestions->num; i++)
1394 char *cp = strchr(suggestions->suggest[i], '=');
1397 suggestions->misspelled[i] = cp+1;
1403 static void client_suggestions_destroy(struct client *cl)
1405 NMEM nmem = cl->suggestions->nmem;
1406 cl->suggestions = 0;
1413 * c-file-style: "Stroustrup"
1414 * indent-tabs-mode: nil
1416 * vim: shiftwidth=4 tabstop=8 expandtab