1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2012 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
111 char *addinfo; // diagnostic info for most resent error
114 int filtered; // When using local:, this will count the number of filtered records.
119 struct suggestions *suggestions;
120 enum client_state state;
121 struct show_raw *show_raw;
122 ZOOM_resultset resultset;
126 facet_limits_t facet_limits;
138 int active; // whether this request has been sent to the server
144 void (*error_handler)(void *data, const char *addinfo);
145 void (*record_handler)(void *data, const char *buf, size_t sz);
147 struct show_raw *next;
150 static const char *client_states[] = {
156 "Client_Disconnected"
159 const char *client_get_state_str(struct client *cl)
161 return client_states[cl->state];
164 enum client_state client_get_state(struct client *cl)
169 void client_set_state_nb(struct client *cl, enum client_state st)
174 void client_set_state(struct client *cl, enum client_state st)
177 if (client_is_active(cl))
180 /* If client is going from being active to inactive and all clients
181 are now idle we fire a watch for the session . The assumption is
182 that session is not mutex locked if client is already active */
183 if (was_active && !client_is_active(cl) && cl->session)
186 int no_active = session_active_clients(cl->session);
187 yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
188 client_get_id(cl), no_active);
189 if (no_active == 0) {
190 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
191 session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
192 session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
193 session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
198 static void client_show_raw_error(struct client *cl, const char *addinfo);
200 struct connection *client_get_connection(struct client *cl)
202 return cl->connection;
205 struct session_database *client_get_database(struct client *cl)
210 struct session *client_get_session(struct client *cl)
215 const char *client_get_pquery(struct client *cl)
220 static void client_send_raw_present(struct client *cl);
221 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
223 static void client_show_immediate(
224 ZOOM_resultset resultset, struct session_database *sdb, int position,
226 void (*error_handler)(void *data, const char *addinfo),
227 void (*record_handler)(void *data, const char *buf, size_t sz),
229 const char *nativesyntax)
238 error_handler(data, "no resultset");
241 rec = ZOOM_resultset_record_immediate(resultset, position-1);
244 error_handler(data, "no record");
247 nativesyntax_to_type(nativesyntax, 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,
265 const char *nativesyntax)
270 nativesyntax = "raw";
273 struct session_database *sdb = client_get_database(cl);
274 nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
278 if (syntax == 0 && esn == 0)
279 client_show_immediate(cl->resultset, client_get_database(cl),
281 error_handler, record_handler,
282 binary, nativesyntax);
285 struct show_raw *rr, **rrp;
291 rr = xmalloc(sizeof(*rr));
292 rr->position = position;
295 rr->error_handler = error_handler;
296 rr->record_handler = record_handler;
299 rr->syntax = xstrdup(syntax);
303 rr->esn = xstrdup(esn);
307 assert(nativesyntax);
308 rr->nativesyntax = xstrdup(nativesyntax);
312 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
316 if (cl->state == Client_Failed)
318 client_show_raw_error(cl, "client failed");
320 else if (cl->state == Client_Disconnected)
322 client_show_raw_error(cl, "client disconnected");
326 client_send_raw_present(cl);
332 static void client_show_raw_delete(struct show_raw *r)
336 xfree(r->nativesyntax);
340 void client_show_raw_remove(struct client *cl, void *data)
342 struct show_raw *rr = data;
343 struct show_raw **rrp = &cl->show_raw;
349 client_show_raw_delete(rr);
353 void client_show_raw_dequeue(struct client *cl)
355 struct show_raw *rr = cl->show_raw;
357 cl->show_raw = rr->next;
358 client_show_raw_delete(rr);
361 static void client_show_raw_error(struct client *cl, const char *addinfo)
365 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
366 client_show_raw_dequeue(cl);
370 static void client_send_raw_present(struct client *cl)
372 struct session_database *sdb = client_get_database(cl);
373 struct connection *co = client_get_connection(cl);
374 ZOOM_resultset set = cl->resultset;
376 int offset = cl->show_raw->position;
377 const char *syntax = 0;
378 const char *elements = 0;
380 assert(cl->show_raw);
383 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
384 client_get_id(cl), 1, offset);
386 if (cl->show_raw->syntax)
387 syntax = cl->show_raw->syntax;
389 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
390 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
392 if (cl->show_raw->esn)
393 elements = cl->show_raw->esn;
395 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
396 if (elements && *elements)
397 ZOOM_resultset_option_set(set, "elementSetName", elements);
399 ZOOM_resultset_records(set, 0, offset-1, 1);
400 cl->show_raw->active = 1;
402 connection_continue(co);
405 static int nativesyntax_to_type(const char *s, char *type,
410 if (!strncmp(s, "iso2709", 7))
412 const char *cp = strchr(s, ';');
413 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
415 else if (!strncmp(s, "xml", 3))
419 else if (!strncmp(s, "txml", 4))
421 const char *cp = strchr(s, ';');
422 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
428 else /* attempt to deduce structure */
430 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
433 if (!strcmp(syntax, "XML"))
438 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
440 strcpy(type, "xml; charset=marc8-s");
450 * TODO Consider thread safety!!!
453 void client_report_facets(struct client *cl, ZOOM_resultset rs)
455 struct session_database *sdb = client_get_database(cl);
456 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
460 struct session *se = client_get_session(cl);
461 int facet_num = ZOOM_resultset_facets_size(rs);
464 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
466 const char *p = strchr(s->name + 3, ':');
467 if (p && p[1] && s->value && s->value[0])
470 p++; /* p now holds logical facet name */
471 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
473 const char *native_name =
474 ZOOM_facet_field_name(facets[facet_idx]);
475 if (native_name && !strcmp(s->value, native_name))
479 ZOOM_facet_field_term_count(facets[facet_idx]);
480 for (term_idx = 0; term_idx < term_num; term_idx++ )
484 ZOOM_facet_field_get_term(facets[facet_idx],
487 add_facet(se, p, term, freq);
497 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
503 nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
504 buf = ZOOM_record_get(rec, type, &len);
505 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
506 client_show_raw_dequeue(cl);
509 void client_check_preferred_watch(struct client *cl)
511 struct session *se = cl->session;
512 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
516 /* TODO possible threading issue. Session can have been destroyed */
517 if (session_is_preferred_clients_ready(se)) {
518 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
521 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
526 yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
530 struct suggestions* client_suggestions_create(const char* suggestions_string);
531 static void client_suggestions_destroy(struct client *cl);
533 void client_search_response(struct client *cl)
535 struct connection *co = cl->connection;
536 ZOOM_connection link = connection_get_link(co);
537 ZOOM_resultset resultset = cl->resultset;
539 const char *error, *addinfo = 0;
541 if (ZOOM_connection_error(link, &error, &addinfo))
544 client_set_state(cl, Client_Error);
545 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
546 error, addinfo, client_get_id(cl));
550 yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, cl->hits);
551 client_report_facets(cl, resultset);
552 cl->record_offset = cl->startrecs;
553 cl->hits = ZOOM_resultset_size(resultset);
555 client_suggestions_destroy(cl);
556 cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
560 void client_got_records(struct client *cl)
562 struct session *se = cl->session;
565 if (reclist_get_num_records(se->reclist) > 0)
568 session_alert_watch(se, SESSION_WATCH_SHOW);
569 session_alert_watch(se, SESSION_WATCH_BYTARGET);
570 session_alert_watch(se, SESSION_WATCH_TERMLIST);
571 session_alert_watch(se, SESSION_WATCH_RECORD);
577 static void client_record_ingest(struct client *cl)
579 const char *msg, *addinfo;
581 ZOOM_resultset resultset = cl->resultset;
582 int offset = cl->record_offset;
583 if ((rec = ZOOM_resultset_record_immediate(resultset, offset)))
586 if (cl->session == 0) {
589 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
591 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
592 msg, addinfo, client_get_id(cl),
597 struct session_database *sdb = client_get_database(cl);
598 NMEM nmem = nmem_create();
602 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
603 if (nativesyntax_to_type(s, type, rec))
604 yaz_log(YLOG_WARN, "Failed to determine record type");
605 xmlrec = ZOOM_record_get(rec, type, NULL);
607 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
611 /* OK = 0, -1 = failure, -2 = Filtered */
612 int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem);
614 yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
623 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
628 void client_record_response(struct client *cl)
630 struct connection *co = cl->connection;
631 ZOOM_connection link = connection_get_link(co);
632 ZOOM_resultset resultset = cl->resultset;
633 const char *error, *addinfo;
635 if (ZOOM_connection_error(link, &error, &addinfo))
637 client_set_state(cl, Client_Error);
638 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
639 error, addinfo, client_get_id(cl));
643 if (cl->show_raw && cl->show_raw->active)
646 if ((rec = ZOOM_resultset_record_immediate(
647 resultset, cl->show_raw->position-1)))
649 cl->show_raw->active = 0;
650 ingest_raw_record(cl, rec);
654 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
655 cl->show_raw->position-1);
660 client_record_ingest(cl);
665 void client_reingest(struct client *cl)
667 int i = cl->startrecs;
668 int to = cl->record_offset;
671 cl->record_offset = i;
673 client_record_ingest(cl);
676 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
678 struct session_database *sdb = client_get_database(cl);
680 WRBUF w = wrbuf_alloc();
684 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
686 const char *p = strchr(s->name + 3, ':');
689 yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
691 else if (s->value && s->value[0])
693 wrbuf_puts(w, "@attr 1=");
694 yaz_encode_pqf_term(w, s->value, strlen(s->value));
699 yaz_log(YLOG_LOG, "using facets str: %s", wrbuf_cstr(w));
700 ZOOM_connection_option_set(link, "facets",
701 wrbuf_len(w) ? wrbuf_cstr(w) : 0);
705 int client_has_facet(struct client *cl, const char *name)
707 struct session_database *sdb = client_get_database(cl);
710 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
712 const char *p = strchr(s->name + 3, ':');
713 if (p && !strcmp(name, p + 1))
719 static const char *get_strategy_plus_sort(struct client *l, const char *field)
721 struct session_database *sdb = client_get_database(l);
724 const char *strategy_plus_sort = 0;
726 for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
728 char *p = strchr(s->name + 3, ':');
731 yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
735 if (!strcmp(p, field))
737 strategy_plus_sort = s->value;
741 return strategy_plus_sort;
744 void client_start_search(struct client *cl)
746 struct session_database *sdb = client_get_database(cl);
747 struct connection *co = client_get_connection(cl);
748 ZOOM_connection link = connection_get_link(co);
749 struct session *se = client_get_session(cl);
751 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
752 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
753 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
754 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
755 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
756 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
757 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
758 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
759 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
760 const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
761 /* Default present chunk */
762 int present_chunk = 20;
763 if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
764 present_chunk = atoi(opt_present_chunk);
766 char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
773 if (extra_args && *extra_args)
774 ZOOM_connection_option_set(link, "extraArgs", extra_args);
777 cl->preferred = atoi(opt_preferred);
779 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
780 client_get_id(cl), cl->preferred);
784 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
786 ZOOM_connection_option_set(link, "piggyback", "1");
788 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
789 if (*opt_sru && *opt_elements)
790 ZOOM_connection_option_set(link, "schema", opt_elements);
791 else if (*opt_elements)
792 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
794 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
796 if (opt_maxrecs && *opt_maxrecs)
798 cl->maxrecs = atoi(opt_maxrecs);
801 /* convert back to string representation used in ZOOM API */
802 sprintf(maxrecs_str, "%d", cl->maxrecs);
803 ZOOM_connection_option_set(link, "count", maxrecs_str);
805 /* A present_chunk less than 1 will disable chunking. */
806 if (present_chunk > 0 && cl->maxrecs > present_chunk) {
807 sprintf(present_chunk_str, "%d", present_chunk);
808 ZOOM_connection_option_set(link, "presentChunk", opt_present_chunk);
811 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
813 sprintf(startrecs_str, "%d", cl->startrecs);
814 ZOOM_connection_option_set(link, "start", startrecs_str);
816 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
817 /* facets definition is in PQF */
818 client_set_facets_request(cl, link);
820 q = ZOOM_query_create();
823 yaz_log(YLOG_LOG, "Search %s CQL: %s", client_get_id(cl),
825 ZOOM_query_cql(q, cl->cqlquery);
827 ZOOM_query_sortby(q, opt_sort);
831 yaz_log(YLOG_LOG, "Search %s PQF: %s", client_get_id(cl), cl->pquery);
833 ZOOM_query_prefix(q, cl->pquery);
835 if (se->sorted_results)
836 { /* first entry is current sorting ! */
837 const char *sort_strategy_and_spec =
838 get_strategy_plus_sort(cl, se->sorted_results->field);
839 int increasing = se->sorted_results->increasing;
840 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
843 strcpy(spec, sort_strategy_and_spec);
844 p = strchr(spec, ':');
847 *p++ = '\0'; /* cut the string in two */
854 yaz_log(YLOG_LOG, "applying %s %s", spec, p);
855 ZOOM_query_sortby2(q, spec, p);
860 /* no native sorting.. If this is not the first search, then
862 if (se->sorted_results->next)
864 ZOOM_query_destroy(q);
869 client_set_state(cl, Client_Working);
871 cl->record_offset = 0;
872 rs = ZOOM_connection_search(link, q);
873 ZOOM_query_destroy(q);
874 ZOOM_resultset_destroy(cl->resultset);
876 connection_continue(co);
879 struct client *client_create(const char *id)
881 struct client *cl = xmalloc(sizeof(*cl));
891 cl->record_offset = 0;
894 cl->state = Client_Disconnected;
899 pazpar2_mutex_create(&cl->mutex, "client");
902 cl->facet_limits = 0;
904 cl->id = xstrdup(id);
910 void client_lock(struct client *c)
912 yaz_mutex_enter(c->mutex);
915 void client_unlock(struct client *c)
917 yaz_mutex_leave(c->mutex);
920 void client_incref(struct client *c)
922 pazpar2_incref(&c->ref_count, c->mutex);
923 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
924 c, client_get_id(c), c->ref_count);
927 int client_destroy(struct client *c)
931 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
932 c, client_get_id(c), c->ref_count);
933 if (!pazpar2_decref(&c->ref_count, c->mutex))
942 assert(!c->connection);
943 facet_limits_destroy(c->facet_limits);
947 ZOOM_resultset_destroy(c->resultset);
949 yaz_mutex_destroy(&c->mutex);
958 void client_set_connection(struct client *cl, struct connection *con)
961 ZOOM_resultset_release(cl->resultset);
964 assert(cl->connection == 0);
965 cl->connection = con;
970 cl->connection = con;
975 void client_disconnect(struct client *cl)
977 if (cl->state != Client_Idle)
978 client_set_state(cl, Client_Disconnected);
979 client_set_connection(cl, 0);
983 // Initialize CCL map for a target
984 static CCL_bibset prepare_cclmap(struct client *cl)
986 struct session_database *sdb = client_get_database(cl);
993 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
995 char *p = strchr(s->name + 3, ':');
998 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
1003 ccl_qual_fitem(res, s->value, p);
1008 // returns a xmalloced CQL query corresponding to the pquery in client
1009 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1011 cql_transform_t cqlt = cql_transform_create();
1013 WRBUF wrb = wrbuf_alloc();
1016 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1018 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1022 r = xstrdup(wrbuf_cstr(wrb));
1025 cql_transform_close(cqlt);
1029 // returns a xmalloced SOLR query corresponding to the pquery in client
1030 // TODO Could prob. be merge with the similar make_cqlquery
1031 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1033 solr_transform_t sqlt = solr_transform_create();
1035 WRBUF wrb = wrbuf_alloc();
1038 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1040 yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1044 r = xstrdup(wrbuf_cstr(wrb));
1047 solr_transform_close(sqlt);
1051 const char *client_get_facet_limit_local(struct client *cl,
1052 struct session_database *sdb,
1054 NMEM nmem, int *num, char ***values)
1056 const char *name = 0;
1057 const char *value = 0;
1058 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1060 struct setting *s = 0;
1062 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1064 const char *p = strchr(s->name + 3, ':');
1065 if (p && !strcmp(p + 1, name) && s->value &&
1066 !strncmp(s->value, "local:", 6))
1068 const char *cp = s->value + 6;
1072 nmem_strsplit_escape2(nmem, "|", value, values,
1075 return *cp ? cp : name;
1082 static int apply_limit(struct session_database *sdb,
1083 facet_limits_t facet_limits,
1084 WRBUF w_pqf, WRBUF w_ccl)
1090 NMEM nmem_tmp = nmem_create();
1091 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1093 struct setting *s = 0;
1095 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1097 const char *p = strchr(s->name + 3, ':');
1098 if (p && !strcmp(p + 1, name) && s->value)
1102 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1105 if (!strncmp(s->value, "rpn:", 4))
1107 const char *pqf = s->value + 4;
1109 wrbuf_puts(w_pqf, "@and ");
1110 wrbuf_puts(w_pqf, pqf);
1111 wrbuf_puts(w_pqf, " ");
1112 for (i = 0; i < num; i++)
1115 wrbuf_puts(w_pqf, "@or ");
1116 yaz_encode_pqf_term(w_pqf, values[i],
1120 else if (!strncmp(s->value, "ccl:", 4))
1122 const char *ccl = s->value + 4;
1124 wrbuf_puts(w_ccl, " and (");
1126 for (i = 0; i < num; i++)
1129 wrbuf_puts(w_ccl, " or ");
1130 wrbuf_puts(w_ccl, ccl);
1131 wrbuf_puts(w_ccl, "=\"");
1132 wrbuf_puts(w_ccl, values[i]);
1133 wrbuf_puts(w_ccl, "\"");
1135 wrbuf_puts(w_ccl, ")");
1138 else if (!strncmp(s->value, "local:", 6)) {
1143 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1144 sdb->database->id, s->value);
1145 ret = -1; /* bad limitmap */
1150 nmem_reset(nmem_tmp);
1153 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1154 (sdb->database ? sdb->database->id : "<no id>"), name);
1157 nmem_destroy(nmem_tmp);
1161 // Parse the query given the settings specific to this client
1162 // return 0 if query is OK but different from before
1163 // return 1 if query is OK but same as before
1164 // return -1 on query error
1165 // return -2 on limit error
1166 int client_parse_query(struct client *cl, const char *query,
1167 facet_limits_t facet_limits,
1168 const char *startrecs, const char *maxrecs)
1170 struct session *se = client_get_session(cl);
1171 struct session_database *sdb = client_get_database(cl);
1172 struct ccl_rpn_node *cn;
1175 CCL_bibset ccl_map = prepare_cclmap(cl);
1176 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1177 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1178 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1179 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1187 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
1190 cl->maxrecs = atoi(maxrecs);
1193 if (startrecs && atoi(startrecs) != cl->startrecs)
1196 cl->startrecs = atoi(startrecs);
1199 w_ccl = wrbuf_alloc();
1200 wrbuf_puts(w_ccl, query);
1202 w_pqf = wrbuf_alloc();
1205 wrbuf_puts(w_pqf, pqf_prefix);
1206 wrbuf_puts(w_pqf, " ");
1209 if (apply_limit(sdb, facet_limits, w_pqf, w_ccl))
1212 facet_limits_destroy(cl->facet_limits);
1213 cl->facet_limits = facet_limits_dup(facet_limits);
1215 yaz_log(YLOG_LOG, "CCL query: %s", wrbuf_cstr(w_ccl));
1216 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1217 ccl_qual_rm(&ccl_map);
1220 client_set_state(cl, Client_Error);
1221 session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s",
1224 wrbuf_destroy(w_ccl);
1225 wrbuf_destroy(w_pqf);
1228 wrbuf_destroy(w_ccl);
1230 if (!pqf_strftime || !*pqf_strftime)
1231 ccl_pquery(w_pqf, cn);
1234 time_t cur_time = time(0);
1235 struct tm *tm = localtime(&cur_time);
1237 const char *cp = tmp_str;
1239 /* see man strftime(3) for things .. In particular %% gets converted
1240 to %.. And That's our original query .. */
1241 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1245 ccl_pquery(w_pqf, cn);
1247 wrbuf_putc(w_pqf, cp[0]);
1251 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1254 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1257 wrbuf_destroy(w_pqf);
1259 xfree(cl->cqlquery);
1262 odr_out = odr_createmem(ODR_ENCODE);
1263 zquery = p_query_rpn(odr_out, cl->pquery);
1267 session_log(se, YLOG_WARN, "Invalid PQF query for %s: %s",
1268 client_get_id(cl), cl->pquery);
1273 session_log(se, YLOG_LOG, "PQF for %s: %s",
1274 client_get_id(cl), cl->pquery);
1276 /* Support for PQF on SRU targets. */
1277 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1279 if (!strcmp(sru, "solr"))
1280 cl->cqlquery = make_solrquery(cl, zquery);
1282 cl->cqlquery = make_cqlquery(cl, zquery);
1287 odr_destroy(odr_out);
1289 /* TODO FIX Not thread safe */
1292 // Initialize relevance structure with query terms
1293 se->relevance = relevance_create_ccl(
1294 se->service->charsets, se->nmem, cn);
1300 void client_set_session(struct client *cl, struct session *se)
1305 int client_is_active(struct client *cl)
1307 if (cl->connection && (cl->state == Client_Connecting ||
1308 cl->state == Client_Working))
1313 int client_is_active_preferred(struct client *cl)
1315 /* only count if this is a preferred target. */
1318 /* TODO No sure this the condition that Seb wants */
1319 if (cl->connection && (cl->state == Client_Connecting ||
1320 cl->state == Client_Working))
1325 Odr_int client_get_hits(struct client *cl)
1330 Odr_int client_get_approximation(struct client *cl)
1332 int records = cl->record_offset + cl->filtered;
1334 return cl->hits * cl->record_offset / records;
1338 int client_get_num_records(struct client *cl)
1340 return cl->record_offset;
1343 int client_get_num_records_filtered(struct client *cl)
1345 return cl->filtered;
1348 void client_set_diagnostic(struct client *cl, int diagnostic,
1349 const char *addinfo)
1351 cl->diagnostic = diagnostic;
1355 cl->addinfo = xstrdup(addinfo);
1358 int client_get_diagnostic(struct client *cl, const char **addinfo)
1361 *addinfo = cl->addinfo;
1362 return cl->diagnostic;
1365 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1368 struct suggestions *suggestions = cl->suggestions;
1371 //yaz_log(YLOG_DEBUG, "No suggestions found");
1374 if (suggestions->passthrough) {
1375 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1376 return suggestions->passthrough;
1378 if (suggestions->num == 0) {
1382 for (idx = 0; idx < suggestions->num; idx++) {
1383 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1384 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1385 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1386 wrbuf_puts(wrbuf, "</suggest>\n");
1389 wrbuf_puts(wrbuf, "/>\n");
1392 return wrbuf_cstr(wrbuf);
1396 void client_set_database(struct client *cl, struct session_database *db)
1401 const char *client_get_id(struct client *cl)
1406 int client_get_maxrecs(struct client *cl)
1411 void client_set_preferred(struct client *cl, int v)
1417 struct suggestions* client_suggestions_create(const char* suggestions_string)
1421 struct suggestions *suggestions;
1422 if (suggestions_string == 0)
1424 nmem = nmem_create();
1425 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1426 yaz_log(YLOG_DEBUG, "client target suggestions: %s", suggestions_string);
1428 suggestions->nmem = nmem;
1429 suggestions->num = 0;
1430 suggestions->misspelled = 0;
1431 suggestions->suggest = 0;
1432 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1434 if (suggestions_string)
1435 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1436 &suggestions->num, 1, '\\', 0);
1437 /* Set up misspelled array */
1438 suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1439 /* replace = with \0 .. for each item */
1440 for (i = 0; i < suggestions->num; i++)
1442 char *cp = strchr(suggestions->suggest[i], '=');
1445 suggestions->misspelled[i] = cp+1;
1451 static void client_suggestions_destroy(struct client *cl)
1453 NMEM nmem = cl->suggestions->nmem;
1454 cl->suggestions = 0;
1461 * c-file-style: "Stroustrup"
1462 * indent-tabs-mode: nil
1464 * vim: shiftwidth=4 tabstop=8 expandtab