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_SHOW_PREF);
193 static void client_show_raw_error(struct client *cl, const char *addinfo);
195 struct connection *client_get_connection(struct client *cl)
197 return cl->connection;
200 struct session_database *client_get_database(struct client *cl)
205 struct session *client_get_session(struct client *cl)
210 const char *client_get_pquery(struct client *cl)
215 static void client_send_raw_present(struct client *cl);
216 static int nativesyntax_to_type(struct session_database *sdb, char *type,
219 static void client_show_immediate(
220 ZOOM_resultset resultset, struct session_database *sdb, int position,
222 void (*error_handler)(void *data, const char *addinfo),
223 void (*record_handler)(void *data, const char *buf, size_t sz),
233 error_handler(data, "no resultset");
236 rec = ZOOM_resultset_record(resultset, position-1);
239 error_handler(data, "no record");
245 nativesyntax_to_type(sdb, type, rec);
246 buf = ZOOM_record_get(rec, type, &len);
249 error_handler(data, "no record");
252 record_handler(data, buf, len);
256 int client_show_raw_begin(struct client *cl, int position,
257 const char *syntax, const char *esn,
259 void (*error_handler)(void *data, const char *addinfo),
260 void (*record_handler)(void *data, const char *buf,
264 if (syntax == 0 && esn == 0)
265 client_show_immediate(cl->resultset, client_get_database(cl),
267 error_handler, record_handler,
271 struct show_raw *rr, **rrp;
277 rr = xmalloc(sizeof(*rr));
278 rr->position = position;
281 rr->error_handler = error_handler;
282 rr->record_handler = record_handler;
285 rr->syntax = xstrdup(syntax);
289 rr->esn = xstrdup(esn);
294 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
298 if (cl->state == Client_Failed)
300 client_show_raw_error(cl, "client failed");
302 else if (cl->state == Client_Disconnected)
304 client_show_raw_error(cl, "client disconnected");
308 client_send_raw_present(cl);
314 static void client_show_raw_delete(struct show_raw *r)
321 void client_show_raw_remove(struct client *cl, void *data)
323 struct show_raw *rr = data;
324 struct show_raw **rrp = &cl->show_raw;
330 client_show_raw_delete(rr);
334 void client_show_raw_dequeue(struct client *cl)
336 struct show_raw *rr = cl->show_raw;
338 cl->show_raw = rr->next;
339 client_show_raw_delete(rr);
342 static void client_show_raw_error(struct client *cl, const char *addinfo)
346 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
347 client_show_raw_dequeue(cl);
351 static void client_send_raw_present(struct client *cl)
353 struct session_database *sdb = client_get_database(cl);
354 struct connection *co = client_get_connection(cl);
355 ZOOM_resultset set = cl->resultset;
357 int offset = cl->show_raw->position;
358 const char *syntax = 0;
359 const char *elements = 0;
361 assert(cl->show_raw);
364 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
365 client_get_id(cl), 1, offset);
367 if (cl->show_raw->syntax)
368 syntax = cl->show_raw->syntax;
370 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
371 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
373 if (cl->show_raw->esn)
374 elements = cl->show_raw->esn;
376 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
377 if (elements && *elements)
378 ZOOM_resultset_option_set(set, "elementSetName", elements);
380 ZOOM_resultset_records(set, 0, offset-1, 1);
381 cl->show_raw->active = 1;
383 connection_continue(co);
386 static int nativesyntax_to_type(struct session_database *sdb, char *type,
389 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
393 if (!strncmp(s, "iso2709", 7))
395 const char *cp = strchr(s, ';');
396 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
398 else if (!strncmp(s, "xml", 3))
402 else if (!strncmp(s, "txml", 4))
404 const char *cp = strchr(s, ';');
405 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
411 else /* attempt to deduce structure */
413 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
416 if (!strcmp(syntax, "XML"))
421 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
423 strcpy(type, "xml; charset=marc8-s");
433 * TODO Consider thread safety!!!
436 void client_report_facets(struct client *cl, ZOOM_resultset rs)
438 struct session_database *sdb = client_get_database(cl);
439 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
443 struct session *se = client_get_session(cl);
444 int facet_num = ZOOM_resultset_facets_size(rs);
447 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
449 const char *p = strchr(s->name + 3, ':');
450 if (p && p[1] && s->value && s->value[0])
453 p++; /* p now holds logical facet name */
454 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
456 const char *native_name =
457 ZOOM_facet_field_name(facets[facet_idx]);
458 if (native_name && !strcmp(s->value, native_name))
462 ZOOM_facet_field_term_count(facets[facet_idx]);
463 for (term_idx = 0; term_idx < term_num; term_idx++ )
467 ZOOM_facet_field_get_term(facets[facet_idx],
470 add_facet(se, p, term, freq);
480 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
486 if (cl->show_raw->binary)
490 struct session_database *sdb = client_get_database(cl);
491 nativesyntax_to_type(sdb, type, rec);
494 buf = ZOOM_record_get(rec, type, &len);
495 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
496 client_show_raw_dequeue(cl);
499 void client_check_preferred_watch(struct client *cl)
501 struct session *se = cl->session;
502 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
506 /* TODO possible threading issue. Session can have been destroyed */
507 if (session_is_preferred_clients_ready(se)) {
508 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
511 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
516 yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
520 struct suggestions* client_suggestions_create(const char* suggestions_string);
521 static void client_suggestions_destroy(struct client *cl);
523 void client_search_response(struct client *cl)
525 struct connection *co = cl->connection;
526 ZOOM_connection link = connection_get_link(co);
527 ZOOM_resultset resultset = cl->resultset;
529 const char *error, *addinfo = 0;
531 if (ZOOM_connection_error(link, &error, &addinfo))
534 client_set_state(cl, Client_Error);
535 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
536 error, addinfo, client_get_id(cl));
540 yaz_log(YLOG_DEBUG, "client_search_response: hits "
541 ODR_INT_PRINTF, cl->hits);
542 client_report_facets(cl, resultset);
543 cl->record_offset = cl->startrecs;
544 cl->hits = ZOOM_resultset_size(resultset);
546 client_suggestions_destroy(cl);
547 cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
551 void client_got_records(struct client *cl)
553 struct session *se = cl->session;
557 session_alert_watch(se, SESSION_WATCH_SHOW);
558 session_alert_watch(se, SESSION_WATCH_RECORD);
563 static void client_record_ingest(struct client *cl)
565 const char *msg, *addinfo;
567 ZOOM_resultset resultset = cl->resultset;
568 int offset = cl->record_offset;
569 if ((rec = ZOOM_resultset_record(resultset, offset)))
572 if (cl->session == 0)
574 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
576 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
577 msg, addinfo, client_get_id(cl),
582 struct session_database *sdb = client_get_database(cl);
583 NMEM nmem = nmem_create();
587 if (nativesyntax_to_type(sdb, type, rec))
588 yaz_log(YLOG_WARN, "Failed to determine record type");
589 xmlrec = ZOOM_record_get(rec, type, NULL);
591 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
595 /* OK = 0, -1 = failure, -2 = Filtered */
596 if (ingest_record(cl, xmlrec, cl->record_offset, nmem) == -1)
597 yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
604 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
609 void client_record_response(struct client *cl)
611 struct connection *co = cl->connection;
612 ZOOM_connection link = connection_get_link(co);
613 ZOOM_resultset resultset = cl->resultset;
614 const char *error, *addinfo;
616 if (ZOOM_connection_error(link, &error, &addinfo))
618 client_set_state(cl, Client_Error);
619 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
620 error, addinfo, client_get_id(cl));
624 if (cl->show_raw && cl->show_raw->active)
627 if ((rec = ZOOM_resultset_record(resultset,
628 cl->show_raw->position-1)))
630 cl->show_raw->active = 0;
631 ingest_raw_record(cl, rec);
635 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
636 cl->show_raw->position-1);
641 client_record_ingest(cl);
646 void client_reingest(struct client *cl)
648 int i = cl->startrecs;
649 int to = cl->record_offset;
651 cl->record_offset = i;
653 client_record_ingest(cl);
656 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
658 struct session_database *sdb = client_get_database(cl);
660 WRBUF w = wrbuf_alloc();
664 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
666 const char *p = strchr(s->name + 3, ':');
669 yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
671 else if (s->value && s->value[0])
673 wrbuf_puts(w, "@attr 1=");
674 yaz_encode_pqf_term(w, s->value, strlen(s->value));
679 yaz_log(YLOG_LOG, "using facets str: %s", wrbuf_cstr(w));
680 ZOOM_connection_option_set(link, "facets",
681 wrbuf_len(w) ? wrbuf_cstr(w) : 0);
685 int client_has_facet(struct client *cl, const char *name)
687 struct session_database *sdb = client_get_database(cl);
690 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
692 const char *p = strchr(s->name + 3, ':');
693 if (p && !strcmp(name, p + 1))
699 void client_start_search(struct client *cl, const char *sort_strategy_and_spec,
702 struct session_database *sdb = client_get_database(cl);
703 struct connection *co = client_get_connection(cl);
704 ZOOM_connection link = connection_get_link(co);
706 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
707 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
708 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
709 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
710 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
711 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
712 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
713 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
714 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
715 char maxrecs_str[24], startrecs_str[24];
721 cl->record_offset = 0;
724 if (extra_args && *extra_args)
725 ZOOM_connection_option_set(link, "extraArgs", extra_args);
728 cl->preferred = atoi(opt_preferred);
730 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
731 client_get_id(cl), cl->preferred);
733 client_set_state(cl, Client_Working);
736 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
738 ZOOM_connection_option_set(link, "piggyback", "1");
740 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
741 if (*opt_sru && *opt_elements)
742 ZOOM_connection_option_set(link, "schema", opt_elements);
743 else if (*opt_elements)
744 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
746 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
748 if (opt_maxrecs && *opt_maxrecs)
750 cl->maxrecs = atoi(opt_maxrecs);
753 /* convert back to string representation used in ZOOM API */
754 sprintf(maxrecs_str, "%d", cl->maxrecs);
755 ZOOM_connection_option_set(link, "count", maxrecs_str);
757 if (cl->maxrecs > 20)
758 ZOOM_connection_option_set(link, "presentChunk", "20");
760 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
762 sprintf(startrecs_str, "%d", cl->startrecs);
763 ZOOM_connection_option_set(link, "start", startrecs_str);
765 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
766 /* facets definition is in PQF */
767 client_set_facets_request(cl, link);
769 q = ZOOM_query_create();
772 yaz_log(YLOG_LOG, "Search %s CQL: %s", client_get_id(cl),
774 ZOOM_query_cql(q, cl->cqlquery);
776 ZOOM_query_sortby(q, opt_sort);
780 yaz_log(YLOG_LOG, "Search %s PQF: %s", client_get_id(cl), cl->pquery);
782 ZOOM_query_prefix(q, cl->pquery);
784 if (sort_strategy_and_spec &&
785 strlen(sort_strategy_and_spec) < 40 /* spec below */)
788 strcpy(spec, sort_strategy_and_spec);
789 p = strchr(spec, ':');
792 *p++ = '\0'; /* cut the string in two */
799 yaz_log(YLOG_LOG, "applying %s %s", spec, p);
800 ZOOM_query_sortby2(q, spec, p);
803 rs = ZOOM_connection_search(link, q);
804 ZOOM_query_destroy(q);
805 ZOOM_resultset_destroy(cl->resultset);
807 connection_continue(co);
810 struct client *client_create(const char *id)
812 struct client *cl = xmalloc(sizeof(*cl));
821 cl->record_offset = 0;
823 cl->state = Client_Disconnected;
828 pazpar2_mutex_create(&cl->mutex, "client");
831 cl->facet_limits = 0;
833 cl->id = xstrdup(id);
839 void client_lock(struct client *c)
841 yaz_mutex_enter(c->mutex);
844 void client_unlock(struct client *c)
846 yaz_mutex_leave(c->mutex);
849 void client_incref(struct client *c)
851 pazpar2_incref(&c->ref_count, c->mutex);
852 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
853 c, client_get_id(c), c->ref_count);
856 int client_destroy(struct client *c)
860 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
861 c, client_get_id(c), c->ref_count);
862 if (!pazpar2_decref(&c->ref_count, c->mutex))
869 assert(!c->connection);
870 facet_limits_destroy(c->facet_limits);
874 ZOOM_resultset_destroy(c->resultset);
876 yaz_mutex_destroy(&c->mutex);
885 void client_set_connection(struct client *cl, struct connection *con)
888 ZOOM_resultset_release(cl->resultset);
891 assert(cl->connection == 0);
892 cl->connection = con;
897 cl->connection = con;
902 void client_disconnect(struct client *cl)
904 if (cl->state != Client_Idle)
905 client_set_state(cl, Client_Disconnected);
906 client_set_connection(cl, 0);
910 // Initialize CCL map for a target
911 static CCL_bibset prepare_cclmap(struct client *cl)
913 struct session_database *sdb = client_get_database(cl);
920 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
922 char *p = strchr(s->name + 3, ':');
925 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
930 ccl_qual_fitem(res, s->value, p);
935 // returns a xmalloced CQL query corresponding to the pquery in client
936 static char *make_cqlquery(struct client *cl)
938 cql_transform_t cqlt = cql_transform_create();
941 WRBUF wrb = wrbuf_alloc();
943 ODR odr_out = odr_createmem(ODR_ENCODE);
945 zquery = p_query_rpn(odr_out, cl->pquery);
946 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
947 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
949 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
954 r = xstrdup(wrbuf_cstr(wrb));
957 odr_destroy(odr_out);
958 cql_transform_close(cqlt);
962 // returns a xmalloced SOLR query corresponding to the pquery in client
963 // TODO Could prob. be merge with the similar make_cqlquery
964 static char *make_solrquery(struct client *cl)
966 solr_transform_t sqlt = solr_transform_create();
969 WRBUF wrb = wrbuf_alloc();
971 ODR odr_out = odr_createmem(ODR_ENCODE);
973 zquery = p_query_rpn(odr_out, cl->pquery);
975 yaz_log(YLOG_WARN, "Failed to generate RPN from PQF: %s", cl->pquery);
978 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
979 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
981 yaz_log(YLOG_WARN, "Failed to generate SOLR query from PQF %s, code=%d", cl->pquery, status);
986 r = xstrdup(wrbuf_cstr(wrb));
989 odr_destroy(odr_out);
990 solr_transform_close(sqlt);
994 const char *client_get_facet_limit_local(struct client *cl,
995 struct session_database *sdb,
997 NMEM nmem, int *num, char ***values)
999 const char *name = 0;
1000 const char *value = 0;
1001 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1003 struct setting *s = 0;
1005 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1007 const char *p = strchr(s->name + 3, ':');
1008 if (p && !strcmp(p + 1, name) && s->value &&
1009 !strncmp(s->value, "local:", 6))
1011 nmem_strsplit_escape2(nmem, "|", value, values,
1021 static int apply_limit(struct session_database *sdb,
1022 facet_limits_t facet_limits,
1023 WRBUF w_pqf, WRBUF w_ccl)
1029 NMEM nmem_tmp = nmem_create();
1030 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1032 struct setting *s = 0;
1034 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1036 const char *p = strchr(s->name + 3, ':');
1037 if (p && !strcmp(p + 1, name) && s->value)
1041 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1044 if (!strncmp(s->value, "rpn:", 4))
1046 const char *pqf = s->value + 4;
1048 wrbuf_puts(w_pqf, "@and ");
1049 wrbuf_puts(w_pqf, pqf);
1050 wrbuf_puts(w_pqf, " ");
1051 for (i = 0; i < num; i++)
1054 wrbuf_puts(w_pqf, "@or ");
1055 yaz_encode_pqf_term(w_pqf, values[i],
1059 else if (!strncmp(s->value, "ccl:", 4))
1061 const char *ccl = s->value + 4;
1063 wrbuf_puts(w_ccl, " and (");
1065 for (i = 0; i < num; i++)
1068 wrbuf_puts(w_ccl, " or ");
1069 wrbuf_puts(w_ccl, ccl);
1070 wrbuf_puts(w_ccl, "=\"");
1071 wrbuf_puts(w_ccl, values[i]);
1072 wrbuf_puts(w_ccl, "\"");
1074 wrbuf_puts(w_ccl, ")");
1077 else if (!strncmp(s->value, "local:", 6))
1081 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1082 sdb->database->id, s->value);
1083 ret = -1; /* bad limitmap */
1088 nmem_reset(nmem_tmp);
1091 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1092 (sdb->database ? sdb->database->id : "<no id>"), name);
1095 nmem_destroy(nmem_tmp);
1099 // Parse the query given the settings specific to this client
1100 int client_parse_query(struct client *cl, const char *query,
1101 facet_limits_t facet_limits,
1102 const char *startrecs, const char *maxrecs)
1104 struct session *se = client_get_session(cl);
1105 struct session_database *sdb = client_get_database(cl);
1106 struct ccl_rpn_node *cn;
1108 CCL_bibset ccl_map = prepare_cclmap(cl);
1109 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1110 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1111 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1112 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1120 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
1123 cl->maxrecs = atoi(maxrecs);
1126 if (startrecs && atoi(startrecs) != cl->startrecs)
1129 cl->startrecs = atoi(startrecs);
1132 w_ccl = wrbuf_alloc();
1133 wrbuf_puts(w_ccl, query);
1135 w_pqf = wrbuf_alloc();
1138 wrbuf_puts(w_pqf, pqf_prefix);
1139 wrbuf_puts(w_pqf, " ");
1142 if (apply_limit(sdb, facet_limits, w_pqf, w_ccl))
1145 facet_limits_destroy(cl->facet_limits);
1146 cl->facet_limits = facet_limits_dup(facet_limits);
1148 yaz_log(YLOG_LOG, "CCL query: %s", wrbuf_cstr(w_ccl));
1149 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1150 ccl_qual_rm(&ccl_map);
1153 client_set_state(cl, Client_Error);
1154 session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s",
1157 wrbuf_destroy(w_ccl);
1158 wrbuf_destroy(w_pqf);
1161 wrbuf_destroy(w_ccl);
1163 if (!pqf_strftime || !*pqf_strftime)
1164 ccl_pquery(w_pqf, cn);
1167 time_t cur_time = time(0);
1168 struct tm *tm = localtime(&cur_time);
1170 const char *cp = tmp_str;
1172 /* see man strftime(3) for things .. In particular %% gets converted
1173 to %.. And That's our original query .. */
1174 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1178 ccl_pquery(w_pqf, cn);
1180 wrbuf_putc(w_pqf, cp[0]);
1183 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1186 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1189 wrbuf_destroy(w_pqf);
1191 yaz_log(YLOG_LOG, "PQF query: %s", cl->pquery);
1193 xfree(cl->cqlquery);
1195 /* Support for PQF on SRU targets. */
1197 yaz_log(YLOG_DEBUG, "Query syntax: %s", query_syntax);
1198 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1200 if (!strcmp(sru, "solr")) {
1201 if (!(cl->cqlquery = make_solrquery(cl)))
1205 if (!(cl->cqlquery = make_cqlquery(cl)))
1212 /* TODO FIX Not thread safe */
1215 // Initialize relevance structure with query terms
1216 se->relevance = relevance_create_ccl(
1217 se->service->charsets, se->nmem, cn);
1224 void client_set_session(struct client *cl, struct session *se)
1229 int client_is_active(struct client *cl)
1231 if (cl->connection && (cl->state == Client_Connecting ||
1232 cl->state == Client_Working))
1237 int client_is_active_preferred(struct client *cl)
1239 /* only count if this is a preferred target. */
1242 /* TODO No sure this the condition that Seb wants */
1243 if (cl->connection && (cl->state == Client_Connecting ||
1244 cl->state == Client_Working))
1249 Odr_int client_get_hits(struct client *cl)
1254 int client_get_num_records(struct client *cl)
1256 return cl->record_offset;
1259 void client_set_diagnostic(struct client *cl, int diagnostic)
1261 cl->diagnostic = diagnostic;
1264 int client_get_diagnostic(struct client *cl)
1266 return cl->diagnostic;
1269 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1272 struct suggestions *suggestions = cl->suggestions;
1275 yaz_log(YLOG_DEBUG, "No suggestions found");
1278 if (suggestions->passthrough) {
1279 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1280 return suggestions->passthrough;
1282 if (suggestions->num == 0) {
1286 for (idx = 0; idx < suggestions->num; idx++) {
1287 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1288 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1289 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1290 wrbuf_puts(wrbuf, "</suggest>\n");
1293 wrbuf_puts(wrbuf, "/>\n");
1296 return wrbuf_cstr(wrbuf);
1300 void client_set_database(struct client *cl, struct session_database *db)
1305 const char *client_get_id(struct client *cl)
1310 int client_get_maxrecs(struct client *cl)
1315 void client_set_preferred(struct client *cl, int v)
1321 struct suggestions* client_suggestions_create(const char* suggestions_string)
1325 struct suggestions *suggestions;
1326 if (suggestions_string == 0)
1328 nmem = nmem_create();
1329 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1330 yaz_log(YLOG_DEBUG, "client target suggestions: %s", suggestions_string);
1332 suggestions->nmem = nmem;
1333 suggestions->num = 0;
1334 suggestions->misspelled = 0;
1335 suggestions->suggest = 0;
1336 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1338 if (suggestions_string)
1339 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1340 &suggestions->num, 1, '\\', 0);
1341 /* Set up misspelled array */
1342 suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1343 /* replace = with \0 .. for each item */
1344 for (i = 0; i < suggestions->num; i++)
1346 char *cp = strchr(suggestions->suggest[i], '=');
1349 suggestions->misspelled[i] = cp+1;
1355 static void client_suggestions_destroy(struct client *cl)
1357 NMEM nmem = cl->suggestions->nmem;
1358 cl->suggestions = 0;
1365 * c-file-style: "Stroustrup"
1366 * indent-tabs-mode: nil
1368 * vim: shiftwidth=4 tabstop=8 expandtab