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>
55 #include <yaz/gettimeofday.h>
59 #include <yaz/timing.h>
64 #include "parameters.h"
66 #include "connection.h"
68 #include "relevance.h"
71 static YAZ_MUTEX g_mutex = 0;
72 static int no_clients = 0;
73 static int no_clients_total = 0;
75 static int client_use(int delta)
79 yaz_mutex_create(&g_mutex);
80 yaz_mutex_enter(g_mutex);
83 no_clients_total += delta;
85 yaz_mutex_leave(g_mutex);
86 yaz_log(YLOG_DEBUG, "%s clients=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
90 int clients_count(void) {
94 int clients_count_total(void) {
98 yaz_mutex_enter(g_mutex);
99 total = no_clients_total;
100 yaz_mutex_leave(g_mutex);
105 /** \brief Represents client state for a connection to one search target */
107 struct session_database *database;
108 struct connection *connection;
109 struct session *session;
110 char *pquery; // Current search
111 char *cqlquery; // used for SRU targets only
112 char *addinfo; // diagnostic info for most resent error
115 int filtered; // When using local:, this will count the number of filtered records.
120 struct suggestions *suggestions;
121 enum client_state state;
122 struct show_raw *show_raw;
123 ZOOM_resultset resultset;
127 facet_limits_t facet_limits;
142 int active; // whether this request has been sent to the server
148 void (*error_handler)(void *data, const char *addinfo);
149 void (*record_handler)(void *data, const char *buf, size_t sz);
151 struct show_raw *next;
154 static const char *client_states[] = {
160 "Client_Disconnected"
163 const char *client_get_state_str(struct client *cl)
165 return client_states[cl->state];
168 enum client_state client_get_state(struct client *cl)
173 void client_set_state_nb(struct client *cl, enum client_state st)
178 void client_set_state(struct client *cl, enum client_state st)
181 if (client_is_active(cl))
184 /* If client is going from being active to inactive and all clients
185 are now idle we fire a watch for the session . The assumption is
186 that session is not mutex locked if client is already active */
187 if (was_active && !client_is_active(cl) && cl->session)
190 int no_active = session_active_clients(cl->session);
191 yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
192 client_get_id(cl), no_active);
193 if (no_active == 0) {
194 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
195 session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
196 session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
197 session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
202 static void client_show_raw_error(struct client *cl, const char *addinfo);
204 struct connection *client_get_connection(struct client *cl)
206 return cl->connection;
209 struct session_database *client_get_database(struct client *cl)
214 struct session *client_get_session(struct client *cl)
219 const char *client_get_pquery(struct client *cl)
224 static void client_send_raw_present(struct client *cl);
225 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
227 static void client_show_immediate(
228 ZOOM_resultset resultset, struct session_database *sdb, int position,
230 void (*error_handler)(void *data, const char *addinfo),
231 void (*record_handler)(void *data, const char *buf, size_t sz),
233 const char *nativesyntax)
242 error_handler(data, "no resultset");
245 rec = ZOOM_resultset_record_immediate(resultset, position-1);
248 error_handler(data, "no record");
251 nativesyntax_to_type(nativesyntax, type, rec);
252 buf = ZOOM_record_get(rec, type, &len);
255 error_handler(data, "no record");
258 record_handler(data, buf, len);
262 int client_show_raw_begin(struct client *cl, int position,
263 const char *syntax, const char *esn,
265 void (*error_handler)(void *data, const char *addinfo),
266 void (*record_handler)(void *data, const char *buf,
269 const char *nativesyntax)
274 nativesyntax = "raw";
277 struct session_database *sdb = client_get_database(cl);
278 nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
282 if (syntax == 0 && esn == 0)
283 client_show_immediate(cl->resultset, client_get_database(cl),
285 error_handler, record_handler,
286 binary, nativesyntax);
289 struct show_raw *rr, **rrp;
295 rr = xmalloc(sizeof(*rr));
296 rr->position = position;
299 rr->error_handler = error_handler;
300 rr->record_handler = record_handler;
303 rr->syntax = xstrdup(syntax);
307 rr->esn = xstrdup(esn);
311 assert(nativesyntax);
312 rr->nativesyntax = xstrdup(nativesyntax);
316 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
320 if (cl->state == Client_Failed)
322 client_show_raw_error(cl, "client failed");
324 else if (cl->state == Client_Disconnected)
326 client_show_raw_error(cl, "client disconnected");
330 client_send_raw_present(cl);
336 static void client_show_raw_delete(struct show_raw *r)
340 xfree(r->nativesyntax);
344 void client_show_raw_remove(struct client *cl, void *data)
346 struct show_raw *rr = data;
347 struct show_raw **rrp = &cl->show_raw;
353 client_show_raw_delete(rr);
357 void client_show_raw_dequeue(struct client *cl)
359 struct show_raw *rr = cl->show_raw;
361 cl->show_raw = rr->next;
362 client_show_raw_delete(rr);
365 static void client_show_raw_error(struct client *cl, const char *addinfo)
369 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
370 client_show_raw_dequeue(cl);
374 static void client_send_raw_present(struct client *cl)
376 struct session_database *sdb = client_get_database(cl);
377 struct connection *co = client_get_connection(cl);
378 ZOOM_resultset set = cl->resultset;
380 int offset = cl->show_raw->position;
381 const char *syntax = 0;
382 const char *elements = 0;
384 assert(cl->show_raw);
387 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
388 client_get_id(cl), 1, offset);
390 if (cl->show_raw->syntax)
391 syntax = cl->show_raw->syntax;
393 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
394 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
396 if (cl->show_raw->esn)
397 elements = cl->show_raw->esn;
399 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
400 if (elements && *elements)
401 ZOOM_resultset_option_set(set, "elementSetName", elements);
403 ZOOM_resultset_records(set, 0, offset-1, 1);
404 cl->show_raw->active = 1;
406 connection_continue(co);
409 static int nativesyntax_to_type(const char *s, char *type,
414 if (!strncmp(s, "iso2709", 7))
416 const char *cp = strchr(s, ';');
417 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
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");
424 else /* pass verbatim to ZOOM - including "xml" */
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 client_report_facets(cl, resultset);
551 cl->record_offset = cl->startrecs;
552 cl->hits = ZOOM_resultset_size(resultset);
553 yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, cl->hits);
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), cl->record_offset);
596 struct session_database *sdb = client_get_database(cl);
597 NMEM nmem = nmem_create();
601 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
602 if (nativesyntax_to_type(s, type, rec))
603 yaz_log(YLOG_WARN, "Failed to determine record type");
604 xmlrec = ZOOM_record_get(rec, type, NULL);
606 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
610 /* OK = 0, -1 = failure, -2 = Filtered */
611 int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem);
613 yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
622 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d", offset);
626 void client_record_response(struct client *cl)
628 struct connection *co = cl->connection;
629 ZOOM_connection link = connection_get_link(co);
630 ZOOM_resultset resultset = cl->resultset;
631 const char *error, *addinfo;
633 if (ZOOM_connection_error(link, &error, &addinfo))
635 client_set_state(cl, Client_Error);
636 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
637 error, addinfo, client_get_id(cl));
641 if (cl->show_raw && cl->show_raw->active)
644 if ((rec = ZOOM_resultset_record_immediate(
645 resultset, cl->show_raw->position-1)))
647 cl->show_raw->active = 0;
648 ingest_raw_record(cl, rec);
652 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
653 cl->show_raw->position-1);
658 client_record_ingest(cl);
663 int client_reingest(struct client *cl)
665 int i = cl->startrecs;
666 int to = cl->record_offset;
669 cl->record_offset = i;
671 client_record_ingest(cl);
675 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
677 struct session_database *sdb = client_get_database(cl);
679 WRBUF w = wrbuf_alloc();
683 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
685 const char *p = strchr(s->name + 3, ':');
688 yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
690 else if (s->value && s->value[0])
692 wrbuf_puts(w, "@attr 1=");
693 yaz_encode_pqf_term(w, s->value, strlen(s->value));
698 yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
699 ZOOM_connection_option_set(link, "facets",
700 wrbuf_len(w) ? wrbuf_cstr(w) : 0);
704 int client_has_facet(struct client *cl, const char *name)
706 struct session_database *sdb = client_get_database(cl);
709 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
711 const char *p = strchr(s->name + 3, ':');
712 if (p && !strcmp(name, p + 1))
718 static const char *get_strategy_plus_sort(struct client *l, const char *field)
720 struct session_database *sdb = client_get_database(l);
723 const char *strategy_plus_sort = 0;
725 for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
727 char *p = strchr(s->name + 3, ':');
730 yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
734 if (!strcmp(p, field))
736 strategy_plus_sort = s->value;
740 return strategy_plus_sort;
743 int client_parse_init(struct client *cl, int same_search)
745 cl->same_search = same_search;
750 * TODO consider how to extend the range
752 int client_parse_range(struct client *cl, const char *startrecs, const char *maxrecs)
754 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
757 cl->maxrecs = atoi(maxrecs);
760 if (startrecs && atoi(startrecs) != cl->startrecs)
763 cl->startrecs = atoi(startrecs);
769 int client_start_search(struct client *cl)
771 struct session_database *sdb = client_get_database(cl);
772 struct connection *co = 0;
773 ZOOM_connection link = 0;
774 struct session *se = client_get_session(cl);
776 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
777 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
778 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
779 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
780 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
781 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
782 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
783 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
784 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
785 const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
787 char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
789 int present_chunk = 20; // Default chunk size
790 int rc_prep_connection;
793 yaz_gettimeofday(&tval);
796 if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
797 present_chunk = atoi(opt_present_chunk);
798 yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
801 client_prep_connection(cl, se->service->z3950_operation_timeout,
802 se->service->z3950_session_timeout,
803 se->service->server->iochan_man,
805 /* Nothing has changed and we already have a result */
806 if (cl->same_search == 1 && rc_prep_connection == 2)
808 session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
809 return client_reingest(cl);
811 else if (!rc_prep_connection)
813 session_log(se, YLOG_LOG, "client %s FAILED to search: No connection.", client_get_id(cl));
816 co = client_get_connection(cl);
818 link = connection_get_link(co);
821 session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
826 if (extra_args && *extra_args)
827 ZOOM_connection_option_set(link, "extraArgs", extra_args);
830 cl->preferred = atoi(opt_preferred);
832 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
833 client_get_id(cl), cl->preferred);
837 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
839 ZOOM_connection_option_set(link, "piggyback", "1");
841 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
842 if (*opt_sru && *opt_elements)
843 ZOOM_connection_option_set(link, "schema", opt_elements);
844 else if (*opt_elements)
845 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
847 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
849 if (opt_maxrecs && *opt_maxrecs)
851 cl->maxrecs = atoi(opt_maxrecs);
854 /* convert back to string representation used in ZOOM API */
855 sprintf(maxrecs_str, "%d", cl->maxrecs);
856 ZOOM_connection_option_set(link, "count", maxrecs_str);
858 /* A present_chunk less than 1 will disable chunking. */
859 if (present_chunk > 0 && cl->maxrecs > present_chunk) {
860 sprintf(present_chunk_str, "%d", present_chunk);
861 ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
862 yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
865 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
866 yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
868 sprintf(startrecs_str, "%d", cl->startrecs);
869 ZOOM_connection_option_set(link, "start", startrecs_str);
871 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
872 /* facets definition is in PQF */
873 client_set_facets_request(cl, link);
875 query = ZOOM_query_create();
878 yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl), cl->cqlquery);
879 ZOOM_query_cql(query, cl->cqlquery);
881 ZOOM_query_sortby(query, opt_sort);
885 yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), cl->pquery);
887 ZOOM_query_prefix(query, cl->pquery);
889 if (cl->sort_strategy && cl->sort_criteria) {
890 yaz_log(YLOG_LOG, "Client %s: Setting ZOOM sort strategy and criteria: %s %s",
891 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
892 ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
895 yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
896 client_set_state(cl, Client_Working);
898 cl->record_offset = 0;
899 rs = ZOOM_connection_search(link, query);
900 ZOOM_query_destroy(query);
901 ZOOM_resultset_destroy(cl->resultset);
903 connection_continue(co);
907 struct client *client_create(const char *id)
909 struct client *cl = xmalloc(sizeof(*cl));
919 cl->record_offset = 0;
922 cl->state = Client_Disconnected;
927 pazpar2_mutex_create(&cl->mutex, "client");
930 cl->facet_limits = 0;
931 cl->sort_strategy = 0;
932 cl->sort_criteria = 0;
934 cl->id = xstrdup(id);
940 void client_lock(struct client *c)
942 yaz_mutex_enter(c->mutex);
945 void client_unlock(struct client *c)
947 yaz_mutex_leave(c->mutex);
950 void client_incref(struct client *c)
952 pazpar2_incref(&c->ref_count, c->mutex);
953 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
954 c, client_get_id(c), c->ref_count);
957 int client_destroy(struct client *c)
961 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
962 c, client_get_id(c), c->ref_count);
963 if (!pazpar2_decref(&c->ref_count, c->mutex))
972 xfree(c->sort_strategy);
973 xfree(c->sort_criteria);
974 assert(!c->connection);
975 facet_limits_destroy(c->facet_limits);
979 ZOOM_resultset_destroy(c->resultset);
981 yaz_mutex_destroy(&c->mutex);
990 void client_set_connection(struct client *cl, struct connection *con)
993 ZOOM_resultset_release(cl->resultset);
996 assert(cl->connection == 0);
997 cl->connection = con;
1002 cl->connection = con;
1007 void client_disconnect(struct client *cl)
1009 if (cl->state != Client_Idle)
1010 client_set_state(cl, Client_Disconnected);
1011 client_set_connection(cl, 0);
1015 // Initialize CCL map for a target
1016 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1018 struct session_database *sdb = client_get_database(cl);
1025 res = ccl_qual_dup(base_bibset);
1027 res = ccl_qual_mk();
1028 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1030 const char *addinfo = 0;
1031 char *p = strchr(s->name + 3, ':');
1034 WRBUF w = wrbuf_alloc();
1035 wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1036 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1037 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG, wrbuf_cstr(w));
1038 client_set_state_nb(cl, Client_Error);
1044 if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1046 WRBUF w = wrbuf_alloc();
1048 wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1049 s->name, p, addinfo);
1050 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1051 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG, wrbuf_cstr(w));
1052 client_set_state_nb(cl, Client_Error);
1061 // returns a xmalloced CQL query corresponding to the pquery in client
1062 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1064 cql_transform_t cqlt = cql_transform_create();
1066 WRBUF wrb = wrbuf_alloc();
1069 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1071 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1075 r = xstrdup(wrbuf_cstr(wrb));
1078 cql_transform_close(cqlt);
1082 // returns a xmalloced SOLR query corresponding to the pquery in client
1083 // TODO Could prob. be merge with the similar make_cqlquery
1084 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1086 solr_transform_t sqlt = solr_transform_create();
1088 WRBUF wrb = wrbuf_alloc();
1091 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1093 yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1097 r = xstrdup(wrbuf_cstr(wrb));
1100 solr_transform_close(sqlt);
1104 const char *client_get_facet_limit_local(struct client *cl,
1105 struct session_database *sdb,
1107 NMEM nmem, int *num, char ***values)
1109 const char *name = 0;
1110 const char *value = 0;
1111 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1113 struct setting *s = 0;
1115 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1117 const char *p = strchr(s->name + 3, ':');
1118 if (p && !strcmp(p + 1, name) && s->value &&
1119 !strncmp(s->value, "local:", 6))
1121 const char *cp = s->value + 6;
1125 nmem_strsplit_escape2(nmem, "|", value, values,
1128 return *cp ? cp : name;
1135 static int apply_limit(struct session_database *sdb,
1136 facet_limits_t facet_limits,
1137 WRBUF w_pqf, CCL_bibset ccl_map)
1144 NMEM nmem_tmp = nmem_create();
1145 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1147 struct setting *s = 0;
1148 nmem_reset(nmem_tmp);
1149 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1151 const char *p = strchr(s->name + 3, ':');
1152 if (p && !strcmp(p + 1, name) && s->value)
1156 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1159 if (!strncmp(s->value, "rpn:", 4))
1161 const char *pqf = s->value + 4;
1163 wrbuf_puts(w_pqf, "@and ");
1164 wrbuf_puts(w_pqf, pqf);
1165 wrbuf_puts(w_pqf, " ");
1166 for (i = 0; i < num; i++)
1169 wrbuf_puts(w_pqf, "@or ");
1170 yaz_encode_pqf_term(w_pqf, values[i],
1174 else if (!strncmp(s->value, "ccl:", 4))
1176 const char *ccl = s->value + 4;
1177 WRBUF ccl_w = wrbuf_alloc();
1178 for (i = 0; i < num; i++)
1181 struct ccl_rpn_node *cn;
1183 wrbuf_rewind(ccl_w);
1184 wrbuf_puts(ccl_w, ccl);
1185 wrbuf_puts(ccl_w, "=\"");
1186 wrbuf_puts(ccl_w, values[i]);
1187 wrbuf_puts(ccl_w, "\"");
1189 cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1194 wrbuf_printf(w_pqf, "@and ");
1196 /* or multiple values.. could be bad if last CCL
1197 parse fails, but this is unlikely to happen */
1199 wrbuf_printf(w_pqf, "@or ");
1200 ccl_pquery(w_pqf, cn);
1204 wrbuf_destroy(ccl_w);
1206 else if (!strncmp(s->value, "local:", 6)) {
1211 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1212 sdb->database->id, s->value);
1213 ret = -1; /* bad limitmap */
1220 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1221 (sdb->database ? sdb->database->id : "<no id>"), name);
1224 nmem_destroy(nmem_tmp);
1228 // Parse the query given the settings specific to this client
1229 // client variable same_search is set as below as well as returned:
1230 // 0 if query is OK but different from before
1231 // 1 if query is OK but same as before
1232 // return -1 on query error
1233 // return -2 on limit error
1234 int client_parse_query(struct client *cl, const char *query,
1235 facet_limits_t facet_limits,
1238 struct session *se = client_get_session(cl);
1239 struct session_database *sdb = client_get_database(cl);
1240 struct ccl_rpn_node *cn;
1243 CCL_bibset ccl_map = prepare_cclmap(cl, bibset);
1244 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1245 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1246 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1247 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1255 w_ccl = wrbuf_alloc();
1256 wrbuf_puts(w_ccl, query);
1258 w_pqf = wrbuf_alloc();
1261 wrbuf_puts(w_pqf, pqf_prefix);
1262 wrbuf_puts(w_pqf, " ");
1265 if (apply_limit(sdb, facet_limits, w_pqf, ccl_map))
1267 ccl_qual_rm(&ccl_map);
1271 facet_limits_destroy(cl->facet_limits);
1272 cl->facet_limits = facet_limits_dup(facet_limits);
1274 yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s", client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
1275 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1276 ccl_qual_rm(&ccl_map);
1279 client_set_state(cl, Client_Error);
1280 session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1283 wrbuf_destroy(w_ccl);
1284 wrbuf_destroy(w_pqf);
1287 wrbuf_destroy(w_ccl);
1289 if (!pqf_strftime || !*pqf_strftime)
1290 ccl_pquery(w_pqf, cn);
1293 time_t cur_time = time(0);
1294 struct tm *tm = localtime(&cur_time);
1296 const char *cp = tmp_str;
1298 /* see man strftime(3) for things .. In particular %% gets converted
1299 to %.. And That's our original query .. */
1300 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1304 ccl_pquery(w_pqf, cn);
1306 wrbuf_putc(w_pqf, cp[0]);
1310 /* Compares query and limit with old one. If different we need to research */
1311 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1314 session_log(se, YLOG_LOG, "Client %s: Re-search due query/limit change: %s to %s",
1315 client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
1317 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1318 // return value is no longer used.
1320 // Need to (re)search
1323 wrbuf_destroy(w_pqf);
1325 xfree(cl->cqlquery);
1328 odr_out = odr_createmem(ODR_ENCODE);
1329 zquery = p_query_rpn(odr_out, cl->pquery);
1333 session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1334 client_get_id(cl), cl->pquery);
1339 session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1340 client_get_id(cl), cl->pquery);
1342 /* Support for PQF on SRU targets. */
1343 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1345 if (!strcmp(sru, "solr"))
1346 cl->cqlquery = make_solrquery(cl, zquery);
1348 cl->cqlquery = make_cqlquery(cl, zquery);
1352 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
1353 client_get_id(cl), cl->cqlquery, sru);
1356 odr_destroy(odr_out);
1358 /* TODO FIX Not thread safe */
1361 // Initialize relevance structure with query terms
1362 se->relevance = relevance_create_ccl(se->service->charsets, cn,
1363 se->service->rank_cluster,
1364 se->service->rank_follow,
1365 se->service->rank_lead,
1366 se->service->rank_length);
1372 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
1376 const char *sort_strategy_and_spec =
1377 get_strategy_plus_sort(cl, sp->name);
1378 int increasing = sp->increasing;
1379 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1381 char strategy[50], *p;
1382 strcpy(strategy, sort_strategy_and_spec);
1383 p = strchr(strategy, ':');
1386 // Split the string in two
1394 yaz_log(YLOG_LOG, "Client %s: applying sorting %s %s", client_get_id(cl), strategy, p);
1395 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
1396 cl->same_search = 0;
1397 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
1398 cl->same_search = 0;
1399 if (cl->same_search == 0) {
1400 xfree(cl->sort_strategy);
1401 cl->sort_strategy = xstrdup(strategy);
1402 xfree(cl->sort_criteria);
1403 cl->sort_criteria = xstrdup(p);
1407 yaz_log(YLOG_LOG, "Client %s: Invalid sort strategy and spec found %s", client_get_id(cl), sort_strategy_and_spec);
1408 xfree(cl->sort_strategy);
1409 cl->sort_strategy = 0;
1410 xfree(cl->sort_criteria);
1411 cl->sort_criteria = 0;
1414 yaz_log(YLOG_LOG, "Client %s: No sort strategy and spec found.", client_get_id(cl));
1415 xfree(cl->sort_strategy);
1416 cl->sort_strategy = 0;
1417 xfree(cl->sort_criteria);
1418 cl->sort_criteria = 0;
1422 return !cl->same_search;
1425 void client_set_session(struct client *cl, struct session *se)
1430 int client_is_active(struct client *cl)
1432 if (cl->connection && (cl->state == Client_Connecting ||
1433 cl->state == Client_Working))
1438 int client_is_active_preferred(struct client *cl)
1440 /* only count if this is a preferred target. */
1443 /* TODO No sure this the condition that Seb wants */
1444 if (cl->connection && (cl->state == Client_Connecting ||
1445 cl->state == Client_Working))
1450 Odr_int client_get_hits(struct client *cl)
1455 Odr_int client_get_approximation(struct client *cl)
1457 if (cl->record_offset > 0) {
1458 Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered)) / cl->record_offset + 5) /10;
1459 yaz_log(YLOG_DEBUG, "%s: Approx: %lld * %d / %d = %lld ", client_get_id(cl), cl->hits, cl->record_offset - cl->filtered, cl->record_offset, approx);
1465 int client_get_num_records(struct client *cl)
1467 return cl->record_offset;
1470 int client_get_num_records_filtered(struct client *cl)
1472 return cl->filtered;
1475 void client_set_diagnostic(struct client *cl, int diagnostic,
1476 const char *addinfo)
1478 cl->diagnostic = diagnostic;
1482 cl->addinfo = xstrdup(addinfo);
1485 int client_get_diagnostic(struct client *cl, const char **addinfo)
1488 *addinfo = cl->addinfo;
1489 return cl->diagnostic;
1492 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1495 struct suggestions *suggestions = cl->suggestions;
1498 //yaz_log(YLOG_DEBUG, "No suggestions found");
1501 if (suggestions->passthrough) {
1502 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1503 return suggestions->passthrough;
1505 if (suggestions->num == 0) {
1509 for (idx = 0; idx < suggestions->num; idx++) {
1510 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1511 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1512 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1513 wrbuf_puts(wrbuf, "</suggest>\n");
1516 wrbuf_puts(wrbuf, "/>\n");
1519 return wrbuf_cstr(wrbuf);
1523 void client_set_database(struct client *cl, struct session_database *db)
1528 const char *client_get_id(struct client *cl)
1533 int client_get_maxrecs(struct client *cl)
1538 void client_set_preferred(struct client *cl, int v)
1544 struct suggestions* client_suggestions_create(const char* suggestions_string)
1548 struct suggestions *suggestions;
1549 if (suggestions_string == 0 || suggestions_string[0] == 0 )
1551 nmem = nmem_create();
1552 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1553 yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1555 suggestions->nmem = nmem;
1556 suggestions->num = 0;
1557 suggestions->misspelled = 0;
1558 suggestions->suggest = 0;
1559 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1561 if (suggestions_string)
1562 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1563 &suggestions->num, 1, '\\', 0);
1564 /* Set up misspelled array */
1565 suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1566 /* replace = with \0 .. for each item */
1567 for (i = 0; i < suggestions->num; i++)
1569 char *cp = strchr(suggestions->suggest[i], '=');
1572 suggestions->misspelled[i] = cp+1;
1578 static void client_suggestions_destroy(struct client *cl)
1580 NMEM nmem = cl->suggestions->nmem;
1581 cl->suggestions = 0;
1585 int client_test_sort_order(struct client *cl, struct reclist_sortparms *sp)
1587 //TODO implement correctly.
1593 * c-file-style: "Stroustrup"
1594 * indent-tabs-mode: nil
1596 * vim: shiftwidth=4 tabstop=8 expandtab