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;
77 static int client_use(int delta)
81 yaz_mutex_create(&g_mutex);
82 yaz_mutex_enter(g_mutex);
85 yaz_mutex_leave(g_mutex);
86 yaz_log(YLOG_DEBUG, "%s clients=%d",
87 delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
91 int clients_count(void)
96 /** \brief Represents client state for a connection to one search target */
98 struct session_database *database;
99 struct connection *connection;
100 struct session *session;
101 char *pquery; // Current search
102 char *cqlquery; // used for SRU targets only
103 char *addinfo; // diagnostic info for most resent error
107 int filtered; // When using local:, this will count the number of filtered records.
113 struct suggestions *suggestions;
114 enum client_state state;
115 struct show_raw *show_raw;
116 ZOOM_resultset resultset;
120 facet_limits_t facet_limits;
135 int active; // whether this request has been sent to the server
141 void (*error_handler)(void *data, const char *addinfo);
142 void (*record_handler)(void *data, const char *buf, size_t sz);
144 struct show_raw *next;
147 static const char *client_states[] = {
153 "Client_Disconnected"
156 const char *client_get_state_str(struct client *cl)
158 return client_states[cl->state];
161 enum client_state client_get_state(struct client *cl)
166 void client_set_state_nb(struct client *cl, enum client_state st)
171 void client_set_state(struct client *cl, enum client_state st)
174 if (client_is_active(cl))
177 /* If client is going from being active to inactive and all clients
178 are now idle we fire a watch for the session . The assumption is
179 that session is not mutex locked if client is already active */
180 if (was_active && !client_is_active(cl) && cl->session)
183 int no_active = session_active_clients(cl->session);
184 yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
185 client_get_id(cl), no_active);
186 if (no_active == 0) {
187 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
188 session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
189 session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
190 session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
195 static void client_show_raw_error(struct client *cl, const char *addinfo);
197 struct connection *client_get_connection(struct client *cl)
199 return cl->connection;
202 struct session_database *client_get_database(struct client *cl)
207 struct session *client_get_session(struct client *cl)
212 static void client_send_raw_present(struct client *cl);
213 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
215 static void client_show_immediate(
216 ZOOM_resultset resultset, struct session_database *sdb, int position,
218 void (*error_handler)(void *data, const char *addinfo),
219 void (*record_handler)(void *data, const char *buf, size_t sz),
221 const char *nativesyntax)
230 error_handler(data, "no resultset");
233 rec = ZOOM_resultset_record_immediate(resultset, position-1);
236 error_handler(data, "no record");
239 nativesyntax_to_type(nativesyntax, type, rec);
240 buf = ZOOM_record_get(rec, type, &len);
243 error_handler(data, "no record");
246 record_handler(data, buf, len);
250 int client_show_raw_begin(struct client *cl, int position,
251 const char *syntax, const char *esn,
253 void (*error_handler)(void *data, const char *addinfo),
254 void (*record_handler)(void *data, const char *buf,
257 const char *nativesyntax)
262 nativesyntax = "raw";
265 struct session_database *sdb = client_get_database(cl);
266 nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
270 if (syntax == 0 && esn == 0)
271 client_show_immediate(cl->resultset, client_get_database(cl),
273 error_handler, record_handler,
274 binary, nativesyntax);
277 struct show_raw *rr, **rrp;
283 rr = xmalloc(sizeof(*rr));
284 rr->position = position;
287 rr->error_handler = error_handler;
288 rr->record_handler = record_handler;
291 rr->syntax = xstrdup(syntax);
295 rr->esn = xstrdup(esn);
299 assert(nativesyntax);
300 rr->nativesyntax = xstrdup(nativesyntax);
304 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
308 if (cl->state == Client_Failed)
310 client_show_raw_error(cl, "client failed");
312 else if (cl->state == Client_Disconnected)
314 client_show_raw_error(cl, "client disconnected");
318 client_send_raw_present(cl);
324 static void client_show_raw_delete(struct show_raw *r)
328 xfree(r->nativesyntax);
332 void client_show_raw_remove(struct client *cl, void *data)
334 struct show_raw *rr = data;
335 struct show_raw **rrp = &cl->show_raw;
341 client_show_raw_delete(rr);
345 static void client_show_raw_dequeue(struct client *cl)
347 struct show_raw *rr = cl->show_raw;
349 cl->show_raw = rr->next;
350 client_show_raw_delete(rr);
353 static void client_show_raw_error(struct client *cl, const char *addinfo)
357 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
358 client_show_raw_dequeue(cl);
362 static void client_send_raw_present(struct client *cl)
364 struct session_database *sdb = client_get_database(cl);
365 struct connection *co = client_get_connection(cl);
366 ZOOM_resultset set = cl->resultset;
368 int offset = cl->show_raw->position;
369 const char *syntax = 0;
370 const char *elements = 0;
372 assert(cl->show_raw);
375 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
376 client_get_id(cl), 1, offset);
378 if (cl->show_raw->syntax)
379 syntax = cl->show_raw->syntax;
381 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
382 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
384 if (cl->show_raw->esn)
385 elements = cl->show_raw->esn;
387 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
388 if (elements && *elements)
389 ZOOM_resultset_option_set(set, "elementSetName", elements);
391 ZOOM_resultset_records(set, 0, offset-1, 1);
392 cl->show_raw->active = 1;
394 connection_continue(co);
397 static int nativesyntax_to_type(const char *s, char *type,
402 if (!strncmp(s, "iso2709", 7))
404 const char *cp = strchr(s, ';');
405 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
407 else if (!strncmp(s, "txml", 4))
409 const char *cp = strchr(s, ';');
410 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
412 else /* pass verbatim to ZOOM - including "xml" */
416 else /* attempt to deduce structure */
418 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
421 if (!strcmp(syntax, "XML"))
426 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
428 strcpy(type, "xml; charset=marc8-s");
438 * TODO Consider thread safety!!!
441 static void client_report_facets(struct client *cl, ZOOM_resultset rs)
443 struct session_database *sdb = client_get_database(cl);
444 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
448 struct session *se = client_get_session(cl);
449 int facet_num = ZOOM_resultset_facets_size(rs);
452 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
454 const char *p = strchr(s->name + 3, ':');
455 if (p && p[1] && s->value && s->value[0])
458 p++; /* p now holds logical facet name */
459 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
461 const char *native_name =
462 ZOOM_facet_field_name(facets[facet_idx]);
463 if (native_name && !strcmp(s->value, native_name))
467 ZOOM_facet_field_term_count(facets[facet_idx]);
468 for (term_idx = 0; term_idx < term_num; term_idx++ )
472 ZOOM_facet_field_get_term(facets[facet_idx],
475 add_facet(se, p, term, freq);
485 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
491 nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
492 buf = ZOOM_record_get(rec, type, &len);
493 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
494 client_show_raw_dequeue(cl);
497 void client_check_preferred_watch(struct client *cl)
499 struct session *se = cl->session;
500 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
504 /* TODO possible threading issue. Session can have been destroyed */
505 if (session_is_preferred_clients_ready(se)) {
506 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
509 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
514 yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
518 struct suggestions* client_suggestions_create(const char* suggestions_string);
519 static void client_suggestions_destroy(struct client *cl);
521 void client_search_response(struct client *cl)
523 struct connection *co = cl->connection;
524 ZOOM_connection link = connection_get_link(co);
525 ZOOM_resultset resultset = cl->resultset;
527 const char *error, *addinfo = 0;
529 if (ZOOM_connection_error(link, &error, &addinfo))
532 client_set_state(cl, Client_Error);
533 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
534 error, addinfo, client_get_id(cl));
538 client_report_facets(cl, resultset);
539 cl->record_offset = cl->startrecs;
540 cl->hits = ZOOM_resultset_size(resultset);
541 yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF,
544 client_suggestions_destroy(cl);
546 client_suggestions_create(ZOOM_resultset_option_get(
547 resultset, "suggestions"));
551 void client_got_records(struct client *cl)
553 struct session *se = cl->session;
556 if (reclist_get_num_records(se->reclist) > 0)
559 session_alert_watch(se, SESSION_WATCH_SHOW);
560 session_alert_watch(se, SESSION_WATCH_BYTARGET);
561 session_alert_watch(se, SESSION_WATCH_TERMLIST);
562 session_alert_watch(se, SESSION_WATCH_RECORD);
568 static void client_record_ingest(struct client *cl)
570 const char *msg, *addinfo;
572 ZOOM_resultset resultset = cl->resultset;
573 struct session *se = client_get_session(cl);
575 if ((rec = ZOOM_resultset_record_immediate(resultset, cl->record_offset)))
577 int offset = ++cl->record_offset;
578 if (cl->session == 0)
580 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
582 session_log(se, YLOG_WARN, "Record error %s (%s): %s #%d",
583 msg, addinfo, client_get_id(cl), offset);
587 struct session_database *sdb = client_get_database(cl);
588 NMEM nmem = nmem_create();
592 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
593 if (nativesyntax_to_type(s, type, rec))
594 session_log(se, YLOG_WARN, "Failed to determine record type");
595 xmlrec = ZOOM_record_get(rec, type, NULL);
598 const char *rec_syn = ZOOM_record_get(rec, "syntax", NULL);
599 session_log(se, YLOG_WARN, "ZOOM_record_get failed from %s #%d",
600 client_get_id(cl), offset);
601 session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
602 "ZOOM record type=%s . Actual record syntax=%s",
603 s ? s : "null", type,
604 rec_syn ? rec_syn : "null");
608 /* OK = 0, -1 = failure, -2 = Filtered */
609 int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem);
612 const char *rec_syn = ZOOM_record_get(rec, "syntax", NULL);
613 session_log(se, YLOG_WARN,
614 "Failed to ingest record from %s #%d",
615 client_get_id(cl), offset);
616 session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
617 "ZOOM record type=%s . Actual record syntax=%s",
618 s ? s : "null", type,
619 rec_syn ? rec_syn : "null");
629 session_log(se, YLOG_WARN, "Got NULL record from %s #%d",
630 client_get_id(cl), cl->record_offset);
634 void client_record_response(struct client *cl, int *got_records)
636 struct connection *co = cl->connection;
637 ZOOM_connection link = connection_get_link(co);
638 ZOOM_resultset resultset = cl->resultset;
639 const char *error, *addinfo;
641 if (ZOOM_connection_error(link, &error, &addinfo))
643 client_set_state(cl, Client_Error);
644 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
645 error, addinfo, client_get_id(cl));
649 if (cl->show_raw && cl->show_raw->active)
652 if ((rec = ZOOM_resultset_record_immediate(
653 resultset, cl->show_raw->position-1)))
655 cl->show_raw->active = 0;
656 ingest_raw_record(cl, rec);
660 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
661 cl->show_raw->position-1);
666 client_record_ingest(cl);
672 int client_reingest(struct client *cl)
674 int i = cl->startrecs;
675 int to = cl->record_offset;
678 cl->record_offset = i;
680 client_record_ingest(cl);
684 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
686 struct session_database *sdb = client_get_database(cl);
688 WRBUF w = wrbuf_alloc();
692 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
694 const char *p = strchr(s->name + 3, ':');
697 yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
699 else if (s->value && s->value[0])
701 wrbuf_puts(w, "@attr 1=");
702 yaz_encode_pqf_term(w, s->value, strlen(s->value));
707 yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
708 ZOOM_connection_option_set(link, "facets",
709 wrbuf_len(w) ? wrbuf_cstr(w) : 0);
713 int client_has_facet(struct client *cl, const char *name)
715 struct session_database *sdb = client_get_database(cl);
718 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
720 const char *p = strchr(s->name + 3, ':');
721 if (p && !strcmp(name, p + 1))
727 static const char *get_strategy_plus_sort(struct client *l, const char *field)
729 struct session_database *sdb = client_get_database(l);
732 const char *strategy_plus_sort = 0;
734 for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
736 char *p = strchr(s->name + 3, ':');
739 yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
743 if (!strcmp(p, field))
745 strategy_plus_sort = s->value;
749 return strategy_plus_sort;
752 void client_update_show_stat(struct client *cl, int cmd)
755 cl->show_stat_no = 0;
760 int client_fetch_more(struct client *cl)
762 struct session_database *sdb = client_get_database(cl);
765 int number = cl->hits - cl->record_offset;
767 str = session_setting_oneval(sdb, PZ_EXTENDRECS);
771 extend_recs = atoi(str);
773 yaz_log(YLOG_LOG, "cl=%s show_stat_no=%d got=%d",
774 client_get_id(cl), cl->show_stat_no, cl->record_offset);
775 if (cl->show_stat_no < cl->record_offset)
777 yaz_log(YLOG_LOG, "cl=%s Trying to fetch more", client_get_id(cl));
779 if (number > extend_recs)
780 number = extend_recs;
783 ZOOM_resultset set = cl->resultset;
784 struct connection *co = client_get_connection(cl);
786 str = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
787 ZOOM_resultset_option_set(set, "preferredRecordSyntax", str);
788 str = session_setting_oneval(sdb, PZ_ELEMENTS);
790 ZOOM_resultset_option_set(set, "elementSetName", str);
792 ZOOM_resultset_records(set, 0, cl->record_offset, number);
793 client_set_state(cl, Client_Working);
794 connection_continue(co);
799 yaz_log(YLOG_LOG, "cl=%s. OK no more in total set", client_get_id(cl));
804 int client_parse_init(struct client *cl, int same_search)
806 cl->same_search = same_search;
811 * TODO consider how to extend the range
813 int client_parse_range(struct client *cl, const char *startrecs,
816 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
819 cl->maxrecs = atoi(maxrecs);
822 if (startrecs && atoi(startrecs) != cl->startrecs)
825 cl->startrecs = atoi(startrecs);
831 int client_start_search(struct client *cl)
833 struct session_database *sdb = client_get_database(cl);
834 struct connection *co = 0;
835 ZOOM_connection link = 0;
836 struct session *se = client_get_session(cl);
838 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
839 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
840 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
841 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
842 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
843 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
844 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
845 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
846 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
847 const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
849 char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
851 int present_chunk = 20; // Default chunk size
852 int rc_prep_connection;
855 yaz_gettimeofday(&tval);
858 if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
859 present_chunk = atoi(opt_present_chunk);
860 yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
863 client_prep_connection(cl, se->service->z3950_operation_timeout,
864 se->service->z3950_session_timeout,
865 se->service->server->iochan_man,
867 /* Nothing has changed and we already have a result */
868 if (cl->same_search == 1 && rc_prep_connection == 2)
870 session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
871 return client_reingest(cl);
873 else if (!rc_prep_connection)
875 session_log(se, YLOG_LOG, "client %s FAILED to search: No connection.", client_get_id(cl));
878 co = client_get_connection(cl);
880 link = connection_get_link(co);
883 session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
888 if (extra_args && *extra_args)
889 ZOOM_connection_option_set(link, "extraArgs", extra_args);
892 cl->preferred = atoi(opt_preferred);
894 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
895 client_get_id(cl), cl->preferred);
899 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
901 ZOOM_connection_option_set(link, "piggyback", "1");
903 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
904 if (*opt_sru && *opt_elements)
905 ZOOM_connection_option_set(link, "schema", opt_elements);
906 else if (*opt_elements)
907 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
909 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
911 if (opt_maxrecs && *opt_maxrecs)
913 cl->maxrecs = atoi(opt_maxrecs);
916 /* convert back to string representation used in ZOOM API */
917 sprintf(maxrecs_str, "%d", cl->maxrecs);
918 ZOOM_connection_option_set(link, "count", maxrecs_str);
920 /* A present_chunk less than 1 will disable chunking. */
921 if (present_chunk > 0 && cl->maxrecs > present_chunk) {
922 sprintf(present_chunk_str, "%d", present_chunk);
923 ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
924 yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
927 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
928 yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
930 sprintf(startrecs_str, "%d", cl->startrecs);
931 ZOOM_connection_option_set(link, "start", startrecs_str);
933 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
934 /* facets definition is in PQF */
935 client_set_facets_request(cl, link);
937 query = ZOOM_query_create();
940 yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl),
942 ZOOM_query_cql(query, cl->cqlquery);
944 ZOOM_query_sortby(query, opt_sort);
948 yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl),
951 ZOOM_query_prefix(query, cl->pquery);
953 if (cl->sort_strategy && cl->sort_criteria) {
954 yaz_log(YLOG_LOG, "Client %s: "
955 "Set ZOOM sort strategy and criteria: %s %s",
956 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
957 ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
960 yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
961 client_set_state(cl, Client_Working);
963 cl->record_offset = 0;
964 rs = ZOOM_connection_search(link, query);
965 ZOOM_query_destroy(query);
966 ZOOM_resultset_destroy(cl->resultset);
968 connection_continue(co);
972 struct client *client_create(const char *id)
974 struct client *cl = xmalloc(sizeof(*cl));
985 cl->record_offset = 0;
988 cl->state = Client_Disconnected;
993 pazpar2_mutex_create(&cl->mutex, "client");
996 cl->facet_limits = 0;
997 cl->sort_strategy = 0;
998 cl->sort_criteria = 0;
1000 cl->id = xstrdup(id);
1003 yaz_log(YLOG_DEBUG, "client_create c=%p %s", cl, id);
1007 void client_lock(struct client *c)
1009 yaz_mutex_enter(c->mutex);
1012 void client_unlock(struct client *c)
1014 yaz_mutex_leave(c->mutex);
1017 void client_incref(struct client *c)
1019 pazpar2_incref(&c->ref_count, c->mutex);
1020 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
1021 c, client_get_id(c), c->ref_count);
1024 int client_destroy(struct client *c)
1028 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
1029 c, client_get_id(c), c->ref_count);
1030 if (!pazpar2_decref(&c->ref_count, c->mutex))
1041 xfree(c->sort_strategy);
1042 xfree(c->sort_criteria);
1043 assert(!c->connection);
1044 facet_limits_destroy(c->facet_limits);
1048 ZOOM_resultset_destroy(c->resultset);
1050 yaz_mutex_destroy(&c->mutex);
1059 void client_set_connection(struct client *cl, struct connection *con)
1062 ZOOM_resultset_release(cl->resultset);
1065 assert(cl->connection == 0);
1066 cl->connection = con;
1071 cl->connection = con;
1076 void client_disconnect(struct client *cl)
1078 if (cl->state != Client_Idle)
1079 client_set_state(cl, Client_Disconnected);
1080 client_set_connection(cl, 0);
1083 // Initialize CCL map for a target
1084 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1086 struct session_database *sdb = client_get_database(cl);
1093 res = ccl_qual_dup(base_bibset);
1095 res = ccl_qual_mk();
1096 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1098 const char *addinfo = 0;
1099 char *p = strchr(s->name + 3, ':');
1102 WRBUF w = wrbuf_alloc();
1103 wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1104 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1105 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1106 ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1108 client_set_state_nb(cl, Client_Error);
1114 if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1116 WRBUF w = wrbuf_alloc();
1118 wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1119 s->name, p, addinfo);
1120 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1121 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1122 ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1124 client_set_state_nb(cl, Client_Error);
1133 // returns a xmalloced CQL query corresponding to the pquery in client
1134 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1136 cql_transform_t cqlt = cql_transform_create();
1138 WRBUF wrb = wrbuf_alloc();
1141 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1143 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1147 r = xstrdup(wrbuf_cstr(wrb));
1150 cql_transform_close(cqlt);
1154 // returns a xmalloced SOLR query corresponding to the pquery in client
1155 // TODO Could prob. be merge with the similar make_cqlquery
1156 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1158 solr_transform_t sqlt = solr_transform_create();
1160 WRBUF wrb = wrbuf_alloc();
1163 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1165 yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1169 r = xstrdup(wrbuf_cstr(wrb));
1172 solr_transform_close(sqlt);
1176 const char *client_get_facet_limit_local(struct client *cl,
1177 struct session_database *sdb,
1179 NMEM nmem, int *num, char ***values)
1181 const char *name = 0;
1182 const char *value = 0;
1183 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1185 struct setting *s = 0;
1187 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1189 const char *p = strchr(s->name + 3, ':');
1190 if (p && !strcmp(p + 1, name) && s->value)
1194 nmem_strsplit_escape2(nmem, ",", s->value, &cvalues,
1196 for (j = 0; j < cnum; j++)
1198 const char *cvalue = cvalues[j];
1199 while (*cvalue == ' ')
1201 if (!strncmp(cvalue, "local:", 6))
1203 const char *cp = cvalue + 6;
1206 nmem_strsplit_escape2(nmem, "|", value, values,
1209 return *cp ? cp : name;
1218 static int apply_limit(struct session_database *sdb,
1219 facet_limits_t facet_limits,
1220 WRBUF w_pqf, CCL_bibset ccl_map,
1221 struct conf_service *service)
1228 NMEM nmem_tmp = nmem_create();
1229 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1231 struct setting *s = 0;
1232 nmem_reset(nmem_tmp);
1233 /* name="pz:limitmap:author" value="rpn:@attr 1=4|local:other" */
1234 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1236 const char *p = strchr(s->name + 3, ':');
1237 if (p && !strcmp(p + 1, name) && s->value)
1243 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1246 nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues,
1249 for (j = 0; ret == 0 && j < cnum; j++)
1251 const char *cvalue = cvalues[j];
1252 while (*cvalue == ' ')
1254 if (!strncmp(cvalue, "rpn:", 4))
1256 const char *pqf = cvalue + 4;
1257 wrbuf_puts(w_pqf, "@and ");
1258 wrbuf_puts(w_pqf, pqf);
1259 wrbuf_puts(w_pqf, " ");
1260 for (i = 0; i < num; i++)
1263 wrbuf_puts(w_pqf, "@or ");
1264 yaz_encode_pqf_term(w_pqf, values[i],
1268 else if (!strncmp(cvalue, "ccl:", 4))
1270 const char *ccl = cvalue + 4;
1271 WRBUF ccl_w = wrbuf_alloc();
1272 for (i = 0; i < num; i++)
1275 struct ccl_rpn_node *cn;
1276 wrbuf_rewind(ccl_w);
1277 wrbuf_puts(ccl_w, ccl);
1278 wrbuf_puts(ccl_w, "=\"");
1279 wrbuf_puts(ccl_w, values[i]);
1280 wrbuf_puts(ccl_w, "\"");
1282 cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1287 wrbuf_printf(w_pqf, "@and ");
1289 /* or multiple values.. could be bad if last
1290 CCL parse fails, but this is unlikely to
1293 wrbuf_printf(w_pqf, "@or ");
1294 ccl_pquery(w_pqf, cn);
1298 wrbuf_destroy(ccl_w);
1300 else if (!strncmp(cvalue, "local:", 6)) {
1305 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1306 sdb->database->id, cvalue);
1307 ret = -1; /* bad limitmap */
1316 for (i = 0; i < service->num_metadata; i++)
1318 struct conf_metadata *md = service->metadata + i;
1319 if (!strcmp(md->name, name) && md->limitcluster)
1321 yaz_log(YLOG_LOG, "limitcluster in use for %s",
1326 if (i == service->num_metadata)
1328 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1329 (sdb->database ? sdb->database->id : "<no id>"), name);
1333 nmem_destroy(nmem_tmp);
1337 // Parse the query given the settings specific to this client
1338 // client variable same_search is set as below as well as returned:
1339 // 0 if query is OK but different from before
1340 // 1 if query is OK but same as before
1341 // return -1 on query error
1342 // return -2 on limit error
1343 int client_parse_query(struct client *cl, const char *query,
1344 facet_limits_t facet_limits)
1346 struct session *se = client_get_session(cl);
1347 struct conf_service *service = se->service;
1348 struct session_database *sdb = client_get_database(cl);
1349 struct ccl_rpn_node *cn;
1352 CCL_bibset ccl_map = prepare_cclmap(cl, service->ccl_bibset);
1353 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1354 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1355 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1356 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1364 w_ccl = wrbuf_alloc();
1365 wrbuf_puts(w_ccl, query);
1367 w_pqf = wrbuf_alloc();
1370 wrbuf_puts(w_pqf, pqf_prefix);
1371 wrbuf_puts(w_pqf, " ");
1374 if (apply_limit(sdb, facet_limits, w_pqf, ccl_map, service))
1376 ccl_qual_rm(&ccl_map);
1380 facet_limits_destroy(cl->facet_limits);
1381 cl->facet_limits = facet_limits_dup(facet_limits);
1383 yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s",
1384 client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
1385 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1386 ccl_qual_rm(&ccl_map);
1389 client_set_state(cl, Client_Error);
1390 session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1393 wrbuf_destroy(w_ccl);
1394 wrbuf_destroy(w_pqf);
1397 wrbuf_destroy(w_ccl);
1399 if (!pqf_strftime || !*pqf_strftime)
1400 ccl_pquery(w_pqf, cn);
1403 time_t cur_time = time(0);
1404 struct tm *tm = localtime(&cur_time);
1406 const char *cp = tmp_str;
1408 /* see man strftime(3) for things .. In particular %% gets converted
1409 to %.. And That's our original query .. */
1410 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1414 ccl_pquery(w_pqf, cn);
1416 wrbuf_putc(w_pqf, cp[0]);
1420 /* Compares query and limit with old one. If different we need to research */
1421 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1424 session_log(se, YLOG_LOG, "Client %s: "
1425 "Re-search due query/limit change: %s to %s",
1426 client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
1428 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1429 // return value is no longer used.
1431 // Need to (re)search
1434 wrbuf_destroy(w_pqf);
1436 xfree(cl->cqlquery);
1439 odr_out = odr_createmem(ODR_ENCODE);
1440 zquery = p_query_rpn(odr_out, cl->pquery);
1444 session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1445 client_get_id(cl), cl->pquery);
1450 session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1451 client_get_id(cl), cl->pquery);
1453 /* Support for PQF on SRU targets. */
1454 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1456 if (!strcmp(sru, "solr"))
1457 cl->cqlquery = make_solrquery(cl, zquery);
1459 cl->cqlquery = make_cqlquery(cl, zquery);
1463 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
1464 client_get_id(cl), cl->cqlquery, sru);
1467 odr_destroy(odr_out);
1469 /* TODO FIX Not thread safe */
1472 // Initialize relevance structure with query terms
1473 se->relevance = relevance_create_ccl(se->service->charsets, cn,
1474 se->service->rank_cluster,
1475 se->service->rank_follow,
1476 se->service->rank_lead,
1477 se->service->rank_length);
1483 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
1487 const char *sort_strategy_and_spec =
1488 get_strategy_plus_sort(cl, sp->name);
1489 int increasing = sp->increasing;
1490 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1492 char strategy[50], *p;
1493 strcpy(strategy, sort_strategy_and_spec);
1494 p = strchr(strategy, ':');
1497 // Split the string in two
1505 yaz_log(YLOG_LOG, "Client %s: "
1506 "applying sorting %s %s", client_get_id(cl),
1508 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
1509 cl->same_search = 0;
1510 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
1511 cl->same_search = 0;
1512 if (cl->same_search == 0) {
1513 xfree(cl->sort_strategy);
1514 cl->sort_strategy = xstrdup(strategy);
1515 xfree(cl->sort_criteria);
1516 cl->sort_criteria = xstrdup(p);
1520 yaz_log(YLOG_LOG, "Client %s: "
1521 "Invalid sort strategy and spec found %s",
1522 client_get_id(cl), sort_strategy_and_spec);
1523 xfree(cl->sort_strategy);
1524 cl->sort_strategy = 0;
1525 xfree(cl->sort_criteria);
1526 cl->sort_criteria = 0;
1531 yaz_log(YLOG_DEBUG, "Client %s: "
1532 "No sort strategy and spec found.", client_get_id(cl));
1533 xfree(cl->sort_strategy);
1534 cl->sort_strategy = 0;
1535 xfree(cl->sort_criteria);
1536 cl->sort_criteria = 0;
1540 return !cl->same_search;
1543 void client_set_session(struct client *cl, struct session *se)
1548 int client_is_active(struct client *cl)
1550 if (cl->connection && (cl->state == Client_Connecting ||
1551 cl->state == Client_Working))
1556 int client_is_active_preferred(struct client *cl)
1558 /* only count if this is a preferred target. */
1561 /* TODO No sure this the condition that Seb wants */
1562 if (cl->connection && (cl->state == Client_Connecting ||
1563 cl->state == Client_Working))
1568 Odr_int client_get_hits(struct client *cl)
1573 Odr_int client_get_approximation(struct client *cl)
1575 if (cl->record_offset > 0)
1577 Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered))
1578 / cl->record_offset + 5) /10;
1579 yaz_log(YLOG_DEBUG, "%s: Approx: %lld * %d / %d = %lld ",
1580 client_get_id(cl), cl->hits,
1581 cl->record_offset - cl->filtered, cl->record_offset, approx);
1587 int client_get_num_records(struct client *cl)
1589 return cl->record_offset;
1592 int client_get_num_records_filtered(struct client *cl)
1594 return cl->filtered;
1597 void client_set_diagnostic(struct client *cl, int diagnostic,
1598 const char *message, const char *addinfo)
1600 cl->diagnostic = diagnostic;
1602 cl->message = xstrdup(message);
1606 cl->addinfo = xstrdup(addinfo);
1609 int client_get_diagnostic(struct client *cl, const char **message,
1610 const char **addinfo)
1613 *message = cl->message;
1615 *addinfo = cl->addinfo;
1616 return cl->diagnostic;
1619 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1622 struct suggestions *suggestions = cl->suggestions;
1626 if (suggestions->passthrough)
1628 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n",
1629 suggestions->passthrough);
1630 return suggestions->passthrough;
1632 if (suggestions->num == 0)
1635 for (idx = 0; idx < suggestions->num; idx++) {
1636 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1637 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1638 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1639 wrbuf_puts(wrbuf, "</suggest>\n");
1642 wrbuf_puts(wrbuf, "/>\n");
1645 return wrbuf_cstr(wrbuf);
1649 void client_set_database(struct client *cl, struct session_database *db)
1654 const char *client_get_id(struct client *cl)
1659 int client_get_maxrecs(struct client *cl)
1664 void client_set_preferred(struct client *cl, int v)
1670 struct suggestions* client_suggestions_create(const char* suggestions_string)
1674 struct suggestions *suggestions;
1675 if (suggestions_string == 0 || suggestions_string[0] == 0 )
1677 nmem = nmem_create();
1678 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1679 yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1681 suggestions->nmem = nmem;
1682 suggestions->num = 0;
1683 suggestions->misspelled = 0;
1684 suggestions->suggest = 0;
1685 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1687 if (suggestions_string)
1688 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1689 &suggestions->num, 1, '\\', 0);
1690 /* Set up misspelled array */
1691 suggestions->misspelled = (char **)
1692 nmem_malloc(nmem, suggestions->num * sizeof(*suggestions->misspelled));
1693 /* replace = with \0 .. for each item */
1694 for (i = 0; i < suggestions->num; i++)
1696 char *cp = strchr(suggestions->suggest[i], '=');
1699 suggestions->misspelled[i] = cp+1;
1705 static void client_suggestions_destroy(struct client *cl)
1707 NMEM nmem = cl->suggestions->nmem;
1708 cl->suggestions = 0;
1715 * c-file-style: "Stroustrup"
1716 * indent-tabs-mode: nil
1718 * vim: shiftwidth=4 tabstop=8 expandtab