1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2013 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
42 #include <yaz/marcdisp.h>
43 #include <yaz/comstack.h>
44 #include <yaz/tcpip.h>
45 #include <yaz/proto.h>
46 #include <yaz/readconf.h>
47 #include <yaz/pquery.h>
48 #include <yaz/otherinfo.h>
49 #include <yaz/yaz-util.h>
51 #include <yaz/query-charset.h>
52 #include <yaz/querytowrbuf.h>
53 #include <yaz/oid_db.h>
54 #include <yaz/diagbib1.h>
55 #include <yaz/snprintf.h>
56 #include <yaz/rpn2cql.h>
57 #include <yaz/rpn2solr.h>
58 #include <yaz/gettimeofday.h>
62 #include <yaz/timing.h>
67 #include "parameters.h"
69 #include "connection.h"
71 #include "relevance.h"
74 static YAZ_MUTEX g_mutex = 0;
75 static int no_clients = 0;
76 static int no_clients_total = 0;
78 static int client_use(int delta)
82 yaz_mutex_create(&g_mutex);
83 yaz_mutex_enter(g_mutex);
86 no_clients_total += delta;
88 yaz_mutex_leave(g_mutex);
89 yaz_log(YLOG_DEBUG, "%s clients=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
93 int clients_count(void) {
97 int clients_count_total(void) {
101 yaz_mutex_enter(g_mutex);
102 total = no_clients_total;
103 yaz_mutex_leave(g_mutex);
108 /** \brief Represents client state for a connection to one search target */
110 struct session_database *database;
111 struct connection *connection;
112 struct session *session;
113 char *pquery; // Current search
114 char *cqlquery; // used for SRU targets only
115 char *addinfo; // diagnostic info for most resent error
118 int filtered; // When using local:, this will count the number of filtered records.
124 struct suggestions *suggestions;
125 enum client_state state;
126 struct show_raw *show_raw;
127 ZOOM_resultset resultset;
130 facet_limits_t facet_limits;
145 int active; // whether this request has been sent to the server
151 void (*error_handler)(void *data, const char *addinfo);
152 void (*record_handler)(void *data, const char *buf, size_t sz);
154 struct show_raw *next;
157 static const char *client_states[] = {
163 "Client_Disconnected"
166 const char *client_get_state_str(struct client *cl)
168 return client_states[cl->state];
171 enum client_state client_get_state(struct client *cl)
176 void client_set_state_nb(struct client *cl, enum client_state st)
181 void client_set_state(struct client *cl, enum client_state st)
184 if (client_is_active(cl))
187 /* If client is going from being active to inactive and all clients
188 are now idle we fire a watch for the session . The assumption is
189 that session is not mutex locked if client is already active */
190 if (was_active && !client_is_active(cl) && cl->session)
193 int no_active = session_active_clients(cl->session);
194 yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
195 client_get_id(cl), no_active);
196 if (no_active == 0) {
197 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
198 session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
199 session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
200 session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
205 static void client_show_raw_error(struct client *cl, const char *addinfo);
207 struct connection *client_get_connection(struct client *cl)
209 return cl->connection;
212 struct session_database *client_get_database(struct client *cl)
217 struct session *client_get_session(struct client *cl)
222 const char *client_get_pquery(struct client *cl)
227 static void client_send_raw_present(struct client *cl);
228 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
230 static void client_show_immediate(
231 ZOOM_resultset resultset, struct session_database *sdb, int position,
233 void (*error_handler)(void *data, const char *addinfo),
234 void (*record_handler)(void *data, const char *buf, size_t sz),
236 const char *nativesyntax)
245 error_handler(data, "no resultset");
248 rec = ZOOM_resultset_record_immediate(resultset, position-1);
251 error_handler(data, "no record");
254 nativesyntax_to_type(nativesyntax, type, rec);
255 buf = ZOOM_record_get(rec, type, &len);
258 error_handler(data, "no record");
261 record_handler(data, buf, len);
265 int client_show_raw_begin(struct client *cl, int position,
266 const char *syntax, const char *esn,
268 void (*error_handler)(void *data, const char *addinfo),
269 void (*record_handler)(void *data, const char *buf,
272 const char *nativesyntax)
277 nativesyntax = "raw";
280 struct session_database *sdb = client_get_database(cl);
281 nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
285 if (syntax == 0 && esn == 0)
286 client_show_immediate(cl->resultset, client_get_database(cl),
288 error_handler, record_handler,
289 binary, nativesyntax);
292 struct show_raw *rr, **rrp;
298 rr = xmalloc(sizeof(*rr));
299 rr->position = position;
302 rr->error_handler = error_handler;
303 rr->record_handler = record_handler;
306 rr->syntax = xstrdup(syntax);
310 rr->esn = xstrdup(esn);
314 assert(nativesyntax);
315 rr->nativesyntax = xstrdup(nativesyntax);
319 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
323 if (cl->state == Client_Failed)
325 client_show_raw_error(cl, "client failed");
327 else if (cl->state == Client_Disconnected)
329 client_show_raw_error(cl, "client disconnected");
333 client_send_raw_present(cl);
339 static void client_show_raw_delete(struct show_raw *r)
343 xfree(r->nativesyntax);
347 void client_show_raw_remove(struct client *cl, void *data)
349 struct show_raw *rr = data;
350 struct show_raw **rrp = &cl->show_raw;
356 client_show_raw_delete(rr);
360 void client_show_raw_dequeue(struct client *cl)
362 struct show_raw *rr = cl->show_raw;
364 cl->show_raw = rr->next;
365 client_show_raw_delete(rr);
368 static void client_show_raw_error(struct client *cl, const char *addinfo)
372 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
373 client_show_raw_dequeue(cl);
377 static void client_send_raw_present(struct client *cl)
379 struct session_database *sdb = client_get_database(cl);
380 struct connection *co = client_get_connection(cl);
381 ZOOM_resultset set = cl->resultset;
383 int offset = cl->show_raw->position;
384 const char *syntax = 0;
385 const char *elements = 0;
387 assert(cl->show_raw);
390 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
391 client_get_id(cl), 1, offset);
393 if (cl->show_raw->syntax)
394 syntax = cl->show_raw->syntax;
396 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
397 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
399 if (cl->show_raw->esn)
400 elements = cl->show_raw->esn;
402 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
403 if (elements && *elements)
404 ZOOM_resultset_option_set(set, "elementSetName", elements);
406 ZOOM_resultset_records(set, 0, offset-1, 1);
407 cl->show_raw->active = 1;
409 connection_continue(co);
412 static int nativesyntax_to_type(const char *s, char *type,
417 if (!strncmp(s, "iso2709", 7))
419 const char *cp = strchr(s, ';');
420 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
422 else if (!strncmp(s, "txml", 4))
424 const char *cp = strchr(s, ';');
425 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
427 else /* pass verbatim to ZOOM - including "xml" */
431 else /* attempt to deduce structure */
433 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
436 if (!strcmp(syntax, "XML"))
441 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
443 strcpy(type, "xml; charset=marc8-s");
453 * TODO Consider thread safety!!!
456 void client_report_facets(struct client *cl, ZOOM_resultset rs)
458 struct session_database *sdb = client_get_database(cl);
459 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
463 struct session *se = client_get_session(cl);
464 int facet_num = ZOOM_resultset_facets_size(rs);
467 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
469 const char *p = strchr(s->name + 3, ':');
470 if (p && p[1] && s->value && s->value[0])
473 p++; /* p now holds logical facet name */
474 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
476 const char *native_name =
477 ZOOM_facet_field_name(facets[facet_idx]);
478 if (native_name && !strcmp(s->value, native_name))
482 ZOOM_facet_field_term_count(facets[facet_idx]);
483 for (term_idx = 0; term_idx < term_num; term_idx++ )
487 ZOOM_facet_field_get_term(facets[facet_idx],
490 add_facet(se, p, term, freq);
500 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
506 nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
507 buf = ZOOM_record_get(rec, type, &len);
508 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
509 client_show_raw_dequeue(cl);
512 void client_check_preferred_watch(struct client *cl)
514 struct session *se = cl->session;
516 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
520 if (session_is_preferred_clients_ready(se))
521 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
523 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
527 yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
531 struct suggestions* client_suggestions_create(const char* suggestions_string);
532 static void client_suggestions_destroy(struct client *cl);
534 void client_search_response(struct client *cl)
536 struct connection *co = cl->connection;
537 ZOOM_connection link = connection_get_link(co);
538 ZOOM_resultset resultset = cl->resultset;
540 const char *error, *addinfo = 0;
542 if (ZOOM_connection_error(link, &error, &addinfo))
545 client_set_state(cl, Client_Error);
546 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
547 error, addinfo, client_get_id(cl));
551 client_report_facets(cl, resultset);
552 cl->record_offset = cl->startrecs;
553 cl->hits = ZOOM_resultset_size(resultset);
554 yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, cl->hits);
556 client_suggestions_destroy(cl);
557 cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
561 void client_got_records(struct client *cl)
563 struct session *se = cl->session;
565 if (reclist_get_num_records(se->reclist) > 0)
567 session_alert_watch(se, SESSION_WATCH_SHOW);
568 session_alert_watch(se, SESSION_WATCH_BYTARGET);
569 session_alert_watch(se, SESSION_WATCH_TERMLIST);
570 session_alert_watch(se, SESSION_WATCH_RECORD);
574 static void client_record_ingest(struct client *cl)
576 const char *msg, *addinfo;
578 ZOOM_resultset resultset = cl->resultset;
579 struct session *se = client_get_session(cl);
581 if ((rec = ZOOM_resultset_record_immediate(resultset, cl->record_offset)))
583 int offset = ++cl->record_offset;
584 if (cl->session == 0) {
587 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
589 session_log(se, YLOG_WARN, "Record error %s (%s): %s #%d",
590 msg, addinfo, client_get_id(cl), offset);
594 struct session_database *sdb = client_get_database(cl);
595 NMEM nmem = nmem_create();
599 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
600 if (nativesyntax_to_type(s, type, rec))
601 session_log(se, YLOG_WARN, "Failed to determine record type");
602 xmlrec = ZOOM_record_get(rec, type, NULL);
605 const char *rec_syn = ZOOM_record_get(rec, "syntax", NULL);
606 session_log(se, YLOG_WARN, "ZOOM_record_get failed from %s #%d",
607 client_get_id(cl), offset);
608 session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
609 "ZOOM record type=%s . Actual record syntax=%s",
610 s ? s : "null", type,
611 rec_syn ? rec_syn : "null");
615 /* OK = 0, -1 = failure, -2 = Filtered */
616 int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem);
619 const char *rec_syn = ZOOM_record_get(rec, "syntax", NULL);
620 session_log(se, YLOG_WARN,
621 "Failed to ingest record from %s #%d",
622 client_get_id(cl), offset);
623 session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
624 "ZOOM record type=%s . Actual record syntax=%s",
625 s ? s : "null", type,
626 rec_syn ? rec_syn : "null");
636 session_log(se, YLOG_WARN, "Got NULL record from %s #%d",
637 client_get_id(cl), cl->record_offset);
641 void client_record_response(struct client *cl, int *got_records)
643 struct connection *co = cl->connection;
644 ZOOM_connection link = connection_get_link(co);
645 ZOOM_resultset resultset = cl->resultset;
646 const char *error, *addinfo;
648 if (ZOOM_connection_error(link, &error, &addinfo))
650 client_set_state(cl, Client_Error);
651 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
652 error, addinfo, client_get_id(cl));
656 if (cl->show_raw && cl->show_raw->active)
659 if ((rec = ZOOM_resultset_record_immediate(
660 resultset, cl->show_raw->position-1)))
662 cl->show_raw->active = 0;
663 ingest_raw_record(cl, rec);
667 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
668 cl->show_raw->position-1);
673 client_record_ingest(cl);
679 int client_reingest(struct client *cl)
681 int i = cl->startrecs;
682 int to = cl->record_offset;
685 cl->record_offset = i;
687 client_record_ingest(cl);
691 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
693 struct session_database *sdb = client_get_database(cl);
695 WRBUF w = wrbuf_alloc();
699 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
701 const char *p = strchr(s->name + 3, ':');
704 yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
706 else if (s->value && s->value[0])
708 wrbuf_puts(w, "@attr 1=");
709 yaz_encode_pqf_term(w, s->value, strlen(s->value));
714 yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
715 ZOOM_connection_option_set(link, "facets",
716 wrbuf_len(w) ? wrbuf_cstr(w) : 0);
720 int client_has_facet(struct client *cl, const char *name)
722 struct session_database *sdb = client_get_database(cl);
725 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
727 const char *p = strchr(s->name + 3, ':');
728 if (p && !strcmp(name, p + 1))
734 static const char *get_strategy_plus_sort(struct client *l, const char *field)
736 struct session_database *sdb = client_get_database(l);
739 const char *strategy_plus_sort = 0;
741 for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
743 char *p = strchr(s->name + 3, ':');
746 yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
750 if (!strcmp(p, field))
752 strategy_plus_sort = s->value;
756 return strategy_plus_sort;
759 int client_parse_init(struct client *cl, int same_search)
761 cl->same_search = same_search;
766 * TODO consider how to extend the range
768 int client_parse_range(struct client *cl, const char *startrecs, const char *maxrecs)
770 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
773 cl->maxrecs = atoi(maxrecs);
776 if (startrecs && atoi(startrecs) != cl->startrecs)
779 cl->startrecs = atoi(startrecs);
785 int client_start_search(struct client *cl)
787 struct session_database *sdb = client_get_database(cl);
788 struct connection *co = 0;
789 ZOOM_connection link = 0;
790 struct session *se = client_get_session(cl);
792 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
793 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
794 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
795 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
796 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
797 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
798 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
799 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
800 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
801 const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
803 char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
805 int present_chunk = 20; // Default chunk size
806 int rc_prep_connection;
809 yaz_gettimeofday(&tval);
812 if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
813 present_chunk = atoi(opt_present_chunk);
814 yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
817 client_prep_connection(cl, se->service->z3950_operation_timeout,
818 se->service->z3950_session_timeout,
819 se->service->server->iochan_man,
821 /* Nothing has changed and we already have a result */
822 if (cl->same_search == 1 && rc_prep_connection == 2)
824 session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
825 return client_reingest(cl);
827 else if (!rc_prep_connection)
829 session_log(se, YLOG_LOG, "client %s FAILED to search: No connection.", client_get_id(cl));
832 co = client_get_connection(cl);
834 link = connection_get_link(co);
837 session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
842 if (extra_args && *extra_args)
843 ZOOM_connection_option_set(link, "extraArgs", extra_args);
846 cl->preferred = atoi(opt_preferred);
848 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
849 client_get_id(cl), cl->preferred);
853 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
855 ZOOM_connection_option_set(link, "piggyback", "1");
857 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
858 if (*opt_sru && *opt_elements)
859 ZOOM_connection_option_set(link, "schema", opt_elements);
860 else if (*opt_elements)
861 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
863 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
865 if (opt_maxrecs && *opt_maxrecs)
867 cl->maxrecs = atoi(opt_maxrecs);
870 /* convert back to string representation used in ZOOM API */
871 sprintf(maxrecs_str, "%d", cl->maxrecs);
872 ZOOM_connection_option_set(link, "count", maxrecs_str);
874 /* A present_chunk less than 1 will disable chunking. */
875 if (present_chunk > 0 && cl->maxrecs > present_chunk) {
876 sprintf(present_chunk_str, "%d", present_chunk);
877 ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
878 yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
881 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
882 yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
884 sprintf(startrecs_str, "%d", cl->startrecs);
885 ZOOM_connection_option_set(link, "start", startrecs_str);
887 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
888 /* facets definition is in PQF */
889 client_set_facets_request(cl, link);
891 query = ZOOM_query_create();
894 yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl), cl->cqlquery);
895 ZOOM_query_cql(query, cl->cqlquery);
897 ZOOM_query_sortby(query, opt_sort);
901 yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), cl->pquery);
903 ZOOM_query_prefix(query, cl->pquery);
905 if (cl->sort_strategy && cl->sort_criteria) {
906 yaz_log(YLOG_LOG, "Client %s: Setting ZOOM sort strategy and criteria: %s %s",
907 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
908 ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
911 yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
912 client_set_state(cl, Client_Working);
914 cl->record_offset = 0;
915 rs = ZOOM_connection_search(link, query);
916 ZOOM_query_destroy(query);
917 ZOOM_resultset_destroy(cl->resultset);
919 connection_continue(co);
923 struct client *client_create(const char *id)
925 struct client *cl = xmalloc(sizeof(*cl));
936 cl->record_offset = 0;
939 cl->state = Client_Disconnected;
945 cl->facet_limits = 0;
946 cl->sort_strategy = 0;
947 cl->sort_criteria = 0;
949 cl->id = xstrdup(id);
955 void client_incref(struct client *c)
958 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
959 c, client_get_id(c), c->ref_count);
962 int client_destroy(struct client *c)
966 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
967 c, client_get_id(c), c->ref_count);
968 if (--c->ref_count == 0)
979 xfree(c->sort_strategy);
980 xfree(c->sort_criteria);
981 assert(!c->connection);
982 facet_limits_destroy(c->facet_limits);
986 ZOOM_resultset_destroy(c->resultset);
996 void client_set_connection(struct client *cl, struct connection *con)
999 ZOOM_resultset_release(cl->resultset);
1002 assert(cl->connection == 0);
1003 cl->connection = con;
1008 cl->connection = con;
1013 void client_disconnect(struct client *cl)
1015 if (cl->state != Client_Idle)
1016 client_set_state(cl, Client_Disconnected);
1017 client_set_connection(cl, 0);
1021 // Initialize CCL map for a target
1022 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1024 struct session_database *sdb = client_get_database(cl);
1031 res = ccl_qual_dup(base_bibset);
1033 res = ccl_qual_mk();
1034 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1036 const char *addinfo = 0;
1037 char *p = strchr(s->name + 3, ':');
1040 WRBUF w = wrbuf_alloc();
1041 wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1042 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1043 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1044 ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1046 client_set_state_nb(cl, Client_Error);
1052 if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1054 WRBUF w = wrbuf_alloc();
1056 wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1057 s->name, p, addinfo);
1058 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1059 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1060 ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1062 client_set_state_nb(cl, Client_Error);
1071 // returns a xmalloced CQL query corresponding to the pquery in client
1072 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1074 cql_transform_t cqlt = cql_transform_create();
1076 WRBUF wrb = wrbuf_alloc();
1079 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1081 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1085 r = xstrdup(wrbuf_cstr(wrb));
1088 cql_transform_close(cqlt);
1092 // returns a xmalloced SOLR query corresponding to the pquery in client
1093 // TODO Could prob. be merge with the similar make_cqlquery
1094 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1096 solr_transform_t sqlt = solr_transform_create();
1098 WRBUF wrb = wrbuf_alloc();
1101 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1103 yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1107 r = xstrdup(wrbuf_cstr(wrb));
1110 solr_transform_close(sqlt);
1114 const char *client_get_facet_limit_local(struct client *cl,
1115 struct session_database *sdb,
1117 NMEM nmem, int *num, char ***values)
1119 const char *name = 0;
1120 const char *value = 0;
1121 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1123 struct setting *s = 0;
1125 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1127 const char *p = strchr(s->name + 3, ':');
1128 if (p && !strcmp(p + 1, name) && s->value)
1132 nmem_strsplit_escape2(nmem, ",", s->value, &cvalues,
1134 for (j = 0; j < cnum; j++)
1136 const char *cvalue = cvalues[j];
1137 while (*cvalue == ' ')
1139 if (!strncmp(cvalue, "local:", 6))
1141 const char *cp = cvalue + 6;
1144 nmem_strsplit_escape2(nmem, "|", value, values,
1147 return *cp ? cp : name;
1156 static int apply_limit(struct session_database *sdb,
1157 facet_limits_t facet_limits,
1158 WRBUF w_pqf, CCL_bibset ccl_map,
1159 struct conf_service *service)
1166 NMEM nmem_tmp = nmem_create();
1167 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1169 struct setting *s = 0;
1170 nmem_reset(nmem_tmp);
1171 /* name="pz:limitmap:author" value="rpn:@attr 1=4|local:other" */
1172 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1174 const char *p = strchr(s->name + 3, ':');
1175 if (p && !strcmp(p + 1, name) && s->value)
1181 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1184 nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues,
1187 for (j = 0; ret == 0 && j < cnum; j++)
1189 const char *cvalue = cvalues[j];
1190 while (*cvalue == ' ')
1192 if (!strncmp(cvalue, "rpn:", 4))
1194 const char *pqf = cvalue + 4;
1195 wrbuf_puts(w_pqf, "@and ");
1196 wrbuf_puts(w_pqf, pqf);
1197 wrbuf_puts(w_pqf, " ");
1198 for (i = 0; i < num; i++)
1201 wrbuf_puts(w_pqf, "@or ");
1202 yaz_encode_pqf_term(w_pqf, values[i],
1206 else if (!strncmp(cvalue, "ccl:", 4))
1208 const char *ccl = cvalue + 4;
1209 WRBUF ccl_w = wrbuf_alloc();
1210 for (i = 0; i < num; i++)
1213 struct ccl_rpn_node *cn;
1214 wrbuf_rewind(ccl_w);
1215 wrbuf_puts(ccl_w, ccl);
1216 wrbuf_puts(ccl_w, "=\"");
1217 wrbuf_puts(ccl_w, values[i]);
1218 wrbuf_puts(ccl_w, "\"");
1220 cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1225 wrbuf_printf(w_pqf, "@and ");
1227 /* or multiple values.. could be bad if last
1228 CCL parse fails, but this is unlikely to
1231 wrbuf_printf(w_pqf, "@or ");
1232 ccl_pquery(w_pqf, cn);
1236 wrbuf_destroy(ccl_w);
1238 else if (!strncmp(cvalue, "local:", 6)) {
1243 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1244 sdb->database->id, cvalue);
1245 ret = -1; /* bad limitmap */
1254 for (i = 0; i < service->num_metadata; i++)
1256 struct conf_metadata *md = service->metadata + i;
1257 if (!strcmp(md->name, name) && md->limitcluster)
1259 yaz_log(YLOG_LOG, "limitcluster in use for %s",
1264 if (i == service->num_metadata)
1266 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1267 (sdb->database ? sdb->database->id : "<no id>"), name);
1271 nmem_destroy(nmem_tmp);
1275 // Parse the query given the settings specific to this client
1276 // client variable same_search is set as below as well as returned:
1277 // 0 if query is OK but different from before
1278 // 1 if query is OK but same as before
1279 // return -1 on query error
1280 // return -2 on limit error
1281 int client_parse_query(struct client *cl, const char *query,
1282 facet_limits_t facet_limits)
1284 struct session *se = client_get_session(cl);
1285 struct conf_service *service = se->service;
1286 struct session_database *sdb = client_get_database(cl);
1287 struct ccl_rpn_node *cn;
1290 CCL_bibset ccl_map = prepare_cclmap(cl, service->ccl_bibset);
1291 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1292 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1293 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1294 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1302 w_ccl = wrbuf_alloc();
1303 wrbuf_puts(w_ccl, query);
1305 w_pqf = wrbuf_alloc();
1308 wrbuf_puts(w_pqf, pqf_prefix);
1309 wrbuf_puts(w_pqf, " ");
1312 if (apply_limit(sdb, facet_limits, w_pqf, ccl_map, service))
1314 ccl_qual_rm(&ccl_map);
1318 facet_limits_destroy(cl->facet_limits);
1319 cl->facet_limits = facet_limits_dup(facet_limits);
1321 yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s", client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
1322 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1323 ccl_qual_rm(&ccl_map);
1326 client_set_state(cl, Client_Error);
1327 session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1330 wrbuf_destroy(w_ccl);
1331 wrbuf_destroy(w_pqf);
1334 wrbuf_destroy(w_ccl);
1336 if (!pqf_strftime || !*pqf_strftime)
1337 ccl_pquery(w_pqf, cn);
1340 time_t cur_time = time(0);
1341 struct tm *tm = localtime(&cur_time);
1343 const char *cp = tmp_str;
1345 /* see man strftime(3) for things .. In particular %% gets converted
1346 to %.. And That's our original query .. */
1347 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1351 ccl_pquery(w_pqf, cn);
1353 wrbuf_putc(w_pqf, cp[0]);
1357 /* Compares query and limit with old one. If different we need to research */
1358 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1361 session_log(se, YLOG_LOG, "Client %s: Re-search due query/limit change: %s to %s",
1362 client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
1364 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1365 // return value is no longer used.
1367 // Need to (re)search
1370 wrbuf_destroy(w_pqf);
1372 xfree(cl->cqlquery);
1375 odr_out = odr_createmem(ODR_ENCODE);
1376 zquery = p_query_rpn(odr_out, cl->pquery);
1380 session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1381 client_get_id(cl), cl->pquery);
1386 session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1387 client_get_id(cl), cl->pquery);
1389 /* Support for PQF on SRU targets. */
1390 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1392 if (!strcmp(sru, "solr"))
1393 cl->cqlquery = make_solrquery(cl, zquery);
1395 cl->cqlquery = make_cqlquery(cl, zquery);
1399 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
1400 client_get_id(cl), cl->cqlquery, sru);
1403 odr_destroy(odr_out);
1405 /* TODO FIX Not thread safe */
1408 // Initialize relevance structure with query terms
1409 se->relevance = relevance_create_ccl(se->service->charsets, cn,
1410 se->service->rank_cluster,
1411 se->service->rank_follow,
1412 se->service->rank_lead,
1413 se->service->rank_length);
1419 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
1423 const char *sort_strategy_and_spec =
1424 get_strategy_plus_sort(cl, sp->name);
1425 int increasing = sp->increasing;
1426 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1428 char strategy[50], *p;
1429 strcpy(strategy, sort_strategy_and_spec);
1430 p = strchr(strategy, ':');
1433 // Split the string in two
1441 yaz_log(YLOG_LOG, "Client %s: applying sorting %s %s", client_get_id(cl), strategy, p);
1442 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
1443 cl->same_search = 0;
1444 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
1445 cl->same_search = 0;
1446 if (cl->same_search == 0) {
1447 xfree(cl->sort_strategy);
1448 cl->sort_strategy = xstrdup(strategy);
1449 xfree(cl->sort_criteria);
1450 cl->sort_criteria = xstrdup(p);
1454 yaz_log(YLOG_LOG, "Client %s: Invalid sort strategy and spec found %s", client_get_id(cl), sort_strategy_and_spec);
1455 xfree(cl->sort_strategy);
1456 cl->sort_strategy = 0;
1457 xfree(cl->sort_criteria);
1458 cl->sort_criteria = 0;
1461 yaz_log(YLOG_DEBUG, "Client %s: No sort strategy and spec found.", client_get_id(cl));
1462 xfree(cl->sort_strategy);
1463 cl->sort_strategy = 0;
1464 xfree(cl->sort_criteria);
1465 cl->sort_criteria = 0;
1469 return !cl->same_search;
1472 void client_set_session(struct client *cl, struct session *se)
1477 int client_is_active(struct client *cl)
1479 if (cl->connection && (cl->state == Client_Connecting ||
1480 cl->state == Client_Working))
1485 int client_is_active_preferred(struct client *cl)
1487 /* only count if this is a preferred target. */
1490 /* TODO No sure this the condition that Seb wants */
1491 if (cl->connection && (cl->state == Client_Connecting ||
1492 cl->state == Client_Working))
1497 Odr_int client_get_hits(struct client *cl)
1502 Odr_int client_get_approximation(struct client *cl)
1504 if (cl->record_offset > 0) {
1505 Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered)) / cl->record_offset + 5) /10;
1506 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);
1512 int client_get_num_records(struct client *cl)
1514 return cl->record_offset;
1517 int client_get_num_records_filtered(struct client *cl)
1519 return cl->filtered;
1522 void client_set_diagnostic(struct client *cl, int diagnostic,
1523 const char *message, const char *addinfo)
1525 cl->diagnostic = diagnostic;
1527 cl->message = xstrdup(message);
1531 cl->addinfo = xstrdup(addinfo);
1534 int client_get_diagnostic(struct client *cl, const char **message,
1535 const char **addinfo)
1538 *message = cl->message;
1540 *addinfo = cl->addinfo;
1541 return cl->diagnostic;
1544 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1547 struct suggestions *suggestions = cl->suggestions;
1550 //yaz_log(YLOG_DEBUG, "No suggestions found");
1553 if (suggestions->passthrough) {
1554 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1555 return suggestions->passthrough;
1557 if (suggestions->num == 0) {
1561 for (idx = 0; idx < suggestions->num; idx++) {
1562 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1563 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1564 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1565 wrbuf_puts(wrbuf, "</suggest>\n");
1568 wrbuf_puts(wrbuf, "/>\n");
1571 return wrbuf_cstr(wrbuf);
1575 void client_set_database(struct client *cl, struct session_database *db)
1580 const char *client_get_id(struct client *cl)
1585 int client_get_maxrecs(struct client *cl)
1590 struct suggestions* client_suggestions_create(const char* suggestions_string)
1594 struct suggestions *suggestions;
1595 if (suggestions_string == 0 || suggestions_string[0] == 0 )
1597 nmem = nmem_create();
1598 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1599 yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1601 suggestions->nmem = nmem;
1602 suggestions->num = 0;
1603 suggestions->misspelled = 0;
1604 suggestions->suggest = 0;
1605 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1607 if (suggestions_string)
1608 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1609 &suggestions->num, 1, '\\', 0);
1610 /* Set up misspelled array */
1611 suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1612 /* replace = with \0 .. for each item */
1613 for (i = 0; i < suggestions->num; i++)
1615 char *cp = strchr(suggestions->suggest[i], '=');
1618 suggestions->misspelled[i] = cp+1;
1624 static void client_suggestions_destroy(struct client *cl)
1626 NMEM nmem = cl->suggestions->nmem;
1627 cl->suggestions = 0;
1631 int client_test_sort_order(struct client *cl, struct reclist_sortparms *sp)
1633 //TODO implement correctly.
1639 * c-file-style: "Stroustrup"
1640 * indent-tabs-mode: nil
1642 * vim: shiftwidth=4 tabstop=8 expandtab