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 yaz_mutex_enter(g_mutex);
98 yaz_mutex_leave(g_mutex);
103 /** \brief Represents client state for a connection to one search target */
105 struct session_database *database;
106 struct connection *connection;
107 struct session *session;
108 char *pquery; // Current search
109 char *cqlquery; // used for SRU targets only
110 char *addinfo; // diagnostic info for most resent error
114 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 static void client_send_raw_present(struct client *cl);
220 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
222 static void client_show_immediate(
223 ZOOM_resultset resultset, struct session_database *sdb, int position,
225 void (*error_handler)(void *data, const char *addinfo),
226 void (*record_handler)(void *data, const char *buf, size_t sz),
228 const char *nativesyntax)
237 error_handler(data, "no resultset");
240 rec = ZOOM_resultset_record_immediate(resultset, position-1);
243 error_handler(data, "no record");
246 nativesyntax_to_type(nativesyntax, type, rec);
247 buf = ZOOM_record_get(rec, type, &len);
250 error_handler(data, "no record");
253 record_handler(data, buf, len);
257 int client_show_raw_begin(struct client *cl, int position,
258 const char *syntax, const char *esn,
260 void (*error_handler)(void *data, const char *addinfo),
261 void (*record_handler)(void *data, const char *buf,
264 const char *nativesyntax)
269 nativesyntax = "raw";
272 struct session_database *sdb = client_get_database(cl);
273 nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
277 if (syntax == 0 && esn == 0)
278 client_show_immediate(cl->resultset, client_get_database(cl),
280 error_handler, record_handler,
281 binary, nativesyntax);
284 struct show_raw *rr, **rrp;
290 rr = xmalloc(sizeof(*rr));
291 rr->position = position;
294 rr->error_handler = error_handler;
295 rr->record_handler = record_handler;
298 rr->syntax = xstrdup(syntax);
302 rr->esn = xstrdup(esn);
306 assert(nativesyntax);
307 rr->nativesyntax = xstrdup(nativesyntax);
311 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
315 if (cl->state == Client_Failed)
317 client_show_raw_error(cl, "client failed");
319 else if (cl->state == Client_Disconnected)
321 client_show_raw_error(cl, "client disconnected");
325 client_send_raw_present(cl);
331 static void client_show_raw_delete(struct show_raw *r)
335 xfree(r->nativesyntax);
339 void client_show_raw_remove(struct client *cl, void *data)
341 struct show_raw *rr = data;
342 struct show_raw **rrp = &cl->show_raw;
348 client_show_raw_delete(rr);
352 static void client_show_raw_dequeue(struct client *cl)
354 struct show_raw *rr = cl->show_raw;
356 cl->show_raw = rr->next;
357 client_show_raw_delete(rr);
360 static void client_show_raw_error(struct client *cl, const char *addinfo)
364 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
365 client_show_raw_dequeue(cl);
369 static void client_send_raw_present(struct client *cl)
371 struct session_database *sdb = client_get_database(cl);
372 struct connection *co = client_get_connection(cl);
373 ZOOM_resultset set = cl->resultset;
375 int offset = cl->show_raw->position;
376 const char *syntax = 0;
377 const char *elements = 0;
379 assert(cl->show_raw);
382 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
383 client_get_id(cl), 1, offset);
385 if (cl->show_raw->syntax)
386 syntax = cl->show_raw->syntax;
388 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
389 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
391 if (cl->show_raw->esn)
392 elements = cl->show_raw->esn;
394 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
395 if (elements && *elements)
396 ZOOM_resultset_option_set(set, "elementSetName", elements);
398 ZOOM_resultset_records(set, 0, offset-1, 1);
399 cl->show_raw->active = 1;
401 connection_continue(co);
404 static int nativesyntax_to_type(const char *s, char *type,
409 if (!strncmp(s, "iso2709", 7))
411 const char *cp = strchr(s, ';');
412 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
414 else if (!strncmp(s, "txml", 4))
416 const char *cp = strchr(s, ';');
417 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
419 else /* pass verbatim to ZOOM - including "xml" */
423 else /* attempt to deduce structure */
425 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
428 if (!strcmp(syntax, "XML"))
433 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
435 strcpy(type, "xml; charset=marc8-s");
445 * TODO Consider thread safety!!!
448 static void client_report_facets(struct client *cl, ZOOM_resultset rs)
450 struct session_database *sdb = client_get_database(cl);
451 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
455 struct session *se = client_get_session(cl);
456 int facet_num = ZOOM_resultset_facets_size(rs);
459 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
461 const char *p = strchr(s->name + 3, ':');
462 if (p && p[1] && s->value && s->value[0])
465 p++; /* p now holds logical facet name */
466 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
468 const char *native_name =
469 ZOOM_facet_field_name(facets[facet_idx]);
470 if (native_name && !strcmp(s->value, native_name))
474 ZOOM_facet_field_term_count(facets[facet_idx]);
475 for (term_idx = 0; term_idx < term_num; term_idx++ )
479 ZOOM_facet_field_get_term(facets[facet_idx],
482 add_facet(se, p, term, freq);
492 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
498 nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
499 buf = ZOOM_record_get(rec, type, &len);
500 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
501 client_show_raw_dequeue(cl);
504 void client_check_preferred_watch(struct client *cl)
506 struct session *se = cl->session;
507 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
511 /* TODO possible threading issue. Session can have been destroyed */
512 if (session_is_preferred_clients_ready(se)) {
513 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
516 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
521 yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
525 struct suggestions* client_suggestions_create(const char* suggestions_string);
526 static void client_suggestions_destroy(struct client *cl);
528 void client_search_response(struct client *cl)
530 struct connection *co = cl->connection;
531 ZOOM_connection link = connection_get_link(co);
532 ZOOM_resultset resultset = cl->resultset;
534 const char *error, *addinfo = 0;
536 if (ZOOM_connection_error(link, &error, &addinfo))
539 client_set_state(cl, Client_Error);
540 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
541 error, addinfo, client_get_id(cl));
545 client_report_facets(cl, resultset);
546 cl->record_offset = cl->startrecs;
547 cl->hits = ZOOM_resultset_size(resultset);
548 yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF,
551 client_suggestions_destroy(cl);
553 client_suggestions_create(ZOOM_resultset_option_get(
554 resultset, "suggestions"));
558 void client_got_records(struct client *cl)
560 struct session *se = cl->session;
563 if (reclist_get_num_records(se->reclist) > 0)
566 session_alert_watch(se, SESSION_WATCH_SHOW);
567 session_alert_watch(se, SESSION_WATCH_BYTARGET);
568 session_alert_watch(se, SESSION_WATCH_TERMLIST);
569 session_alert_watch(se, SESSION_WATCH_RECORD);
575 static void client_record_ingest(struct client *cl)
577 const char *msg, *addinfo;
579 ZOOM_resultset resultset = cl->resultset;
580 struct session *se = client_get_session(cl);
582 if ((rec = ZOOM_resultset_record_immediate(resultset, cl->record_offset)))
584 int offset = ++cl->record_offset;
585 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 void client_update_show_stat(struct client *cl, int cmd)
762 cl->show_stat_no = 0;
767 int client_fetch_more(struct client *cl)
769 struct session_database *sdb = client_get_database(cl);
772 int number = cl->hits - cl->record_offset;
774 str = session_setting_oneval(sdb, PZ_EXTENDRECS);
778 extend_recs = atoi(str);
780 yaz_log(YLOG_LOG, "cl=%s show_stat_no=%d got=%d",
781 client_get_id(cl), cl->show_stat_no, cl->record_offset);
782 if (cl->show_stat_no < cl->record_offset)
784 yaz_log(YLOG_LOG, "cl=%s Trying to fetch more", client_get_id(cl));
786 if (number > extend_recs)
787 number = extend_recs;
790 ZOOM_resultset set = cl->resultset;
791 struct connection *co = client_get_connection(cl);
793 str = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
794 ZOOM_resultset_option_set(set, "preferredRecordSyntax", str);
795 str = session_setting_oneval(sdb, PZ_ELEMENTS);
797 ZOOM_resultset_option_set(set, "elementSetName", str);
799 ZOOM_resultset_records(set, 0, cl->record_offset, number);
800 client_set_state(cl, Client_Working);
801 connection_continue(co);
806 yaz_log(YLOG_LOG, "cl=%s. OK no more in total set", client_get_id(cl));
811 int client_parse_init(struct client *cl, int same_search)
813 cl->same_search = same_search;
818 * TODO consider how to extend the range
820 int client_parse_range(struct client *cl, const char *startrecs,
823 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
826 cl->maxrecs = atoi(maxrecs);
829 if (startrecs && atoi(startrecs) != cl->startrecs)
832 cl->startrecs = atoi(startrecs);
838 int client_start_search(struct client *cl)
840 struct session_database *sdb = client_get_database(cl);
841 struct connection *co = 0;
842 ZOOM_connection link = 0;
843 struct session *se = client_get_session(cl);
845 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
846 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
847 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
848 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
849 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
850 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
851 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
852 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
853 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
854 const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
856 char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
858 int present_chunk = 20; // Default chunk size
859 int rc_prep_connection;
862 yaz_gettimeofday(&tval);
865 if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
866 present_chunk = atoi(opt_present_chunk);
867 yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
870 client_prep_connection(cl, se->service->z3950_operation_timeout,
871 se->service->z3950_session_timeout,
872 se->service->server->iochan_man,
874 /* Nothing has changed and we already have a result */
875 if (cl->same_search == 1 && rc_prep_connection == 2)
877 session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
878 return client_reingest(cl);
880 else if (!rc_prep_connection)
882 session_log(se, YLOG_LOG, "client %s FAILED to search: No connection.", client_get_id(cl));
885 co = client_get_connection(cl);
887 link = connection_get_link(co);
890 session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
895 if (extra_args && *extra_args)
896 ZOOM_connection_option_set(link, "extraArgs", extra_args);
899 cl->preferred = atoi(opt_preferred);
901 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
902 client_get_id(cl), cl->preferred);
906 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
908 ZOOM_connection_option_set(link, "piggyback", "1");
910 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
911 if (*opt_sru && *opt_elements)
912 ZOOM_connection_option_set(link, "schema", opt_elements);
913 else if (*opt_elements)
914 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
916 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
918 if (opt_maxrecs && *opt_maxrecs)
920 cl->maxrecs = atoi(opt_maxrecs);
923 /* convert back to string representation used in ZOOM API */
924 sprintf(maxrecs_str, "%d", cl->maxrecs);
925 ZOOM_connection_option_set(link, "count", maxrecs_str);
927 /* A present_chunk less than 1 will disable chunking. */
928 if (present_chunk > 0 && cl->maxrecs > present_chunk) {
929 sprintf(present_chunk_str, "%d", present_chunk);
930 ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
931 yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
934 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
935 yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
937 sprintf(startrecs_str, "%d", cl->startrecs);
938 ZOOM_connection_option_set(link, "start", startrecs_str);
940 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
941 /* facets definition is in PQF */
942 client_set_facets_request(cl, link);
944 query = ZOOM_query_create();
947 yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl),
949 ZOOM_query_cql(query, cl->cqlquery);
951 ZOOM_query_sortby(query, opt_sort);
955 yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl),
958 ZOOM_query_prefix(query, cl->pquery);
960 if (cl->sort_strategy && cl->sort_criteria) {
961 yaz_log(YLOG_LOG, "Client %s: "
962 "Set ZOOM sort strategy and criteria: %s %s",
963 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
964 ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
967 yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
968 client_set_state(cl, Client_Working);
970 cl->record_offset = 0;
971 rs = ZOOM_connection_search(link, query);
972 ZOOM_query_destroy(query);
973 ZOOM_resultset_destroy(cl->resultset);
975 connection_continue(co);
979 struct client *client_create(const char *id)
981 struct client *cl = xmalloc(sizeof(*cl));
992 cl->record_offset = 0;
995 cl->state = Client_Disconnected;
1000 pazpar2_mutex_create(&cl->mutex, "client");
1003 cl->facet_limits = 0;
1004 cl->sort_strategy = 0;
1005 cl->sort_criteria = 0;
1007 cl->id = xstrdup(id);
1010 yaz_log(YLOG_DEBUG, "client_create c=%p %s", cl, id);
1014 void client_lock(struct client *c)
1016 yaz_mutex_enter(c->mutex);
1019 void client_unlock(struct client *c)
1021 yaz_mutex_leave(c->mutex);
1024 void client_incref(struct client *c)
1026 pazpar2_incref(&c->ref_count, c->mutex);
1027 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
1028 c, client_get_id(c), c->ref_count);
1031 int client_destroy(struct client *c)
1035 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
1036 c, client_get_id(c), c->ref_count);
1037 if (!pazpar2_decref(&c->ref_count, c->mutex))
1048 xfree(c->sort_strategy);
1049 xfree(c->sort_criteria);
1050 assert(!c->connection);
1051 facet_limits_destroy(c->facet_limits);
1055 ZOOM_resultset_destroy(c->resultset);
1057 yaz_mutex_destroy(&c->mutex);
1066 void client_set_connection(struct client *cl, struct connection *con)
1069 ZOOM_resultset_release(cl->resultset);
1072 assert(cl->connection == 0);
1073 cl->connection = con;
1078 cl->connection = con;
1083 void client_disconnect(struct client *cl)
1085 if (cl->state != Client_Idle)
1086 client_set_state(cl, Client_Disconnected);
1087 client_set_connection(cl, 0);
1090 // Initialize CCL map for a target
1091 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1093 struct session_database *sdb = client_get_database(cl);
1100 res = ccl_qual_dup(base_bibset);
1102 res = ccl_qual_mk();
1103 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1105 const char *addinfo = 0;
1106 char *p = strchr(s->name + 3, ':');
1109 WRBUF w = wrbuf_alloc();
1110 wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1111 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1112 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1113 ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1115 client_set_state_nb(cl, Client_Error);
1121 if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1123 WRBUF w = wrbuf_alloc();
1125 wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1126 s->name, p, addinfo);
1127 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1128 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1129 ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1131 client_set_state_nb(cl, Client_Error);
1140 // returns a xmalloced CQL query corresponding to the pquery in client
1141 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1143 cql_transform_t cqlt = cql_transform_create();
1145 WRBUF wrb = wrbuf_alloc();
1148 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1150 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1154 r = xstrdup(wrbuf_cstr(wrb));
1157 cql_transform_close(cqlt);
1161 // returns a xmalloced SOLR query corresponding to the pquery in client
1162 // TODO Could prob. be merge with the similar make_cqlquery
1163 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1165 solr_transform_t sqlt = solr_transform_create();
1167 WRBUF wrb = wrbuf_alloc();
1170 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1172 yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1176 r = xstrdup(wrbuf_cstr(wrb));
1179 solr_transform_close(sqlt);
1183 const char *client_get_facet_limit_local(struct client *cl,
1184 struct session_database *sdb,
1186 NMEM nmem, int *num, char ***values)
1188 const char *name = 0;
1189 const char *value = 0;
1190 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1192 struct setting *s = 0;
1194 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1196 const char *p = strchr(s->name + 3, ':');
1197 if (p && !strcmp(p + 1, name) && s->value)
1201 nmem_strsplit_escape2(nmem, ",", s->value, &cvalues,
1203 for (j = 0; j < cnum; j++)
1205 const char *cvalue = cvalues[j];
1206 while (*cvalue == ' ')
1208 if (!strncmp(cvalue, "local:", 6))
1210 const char *cp = cvalue + 6;
1213 nmem_strsplit_escape2(nmem, "|", value, values,
1216 return *cp ? cp : name;
1225 static int apply_limit(struct session_database *sdb,
1226 facet_limits_t facet_limits,
1227 WRBUF w_pqf, CCL_bibset ccl_map,
1228 struct conf_service *service)
1235 NMEM nmem_tmp = nmem_create();
1236 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1238 struct setting *s = 0;
1239 nmem_reset(nmem_tmp);
1240 /* name="pz:limitmap:author" value="rpn:@attr 1=4|local:other" */
1241 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1243 const char *p = strchr(s->name + 3, ':');
1244 if (p && !strcmp(p + 1, name) && s->value)
1250 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1253 nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues,
1256 for (j = 0; ret == 0 && j < cnum; j++)
1258 const char *cvalue = cvalues[j];
1259 while (*cvalue == ' ')
1261 if (!strncmp(cvalue, "rpn:", 4))
1263 const char *pqf = cvalue + 4;
1264 wrbuf_puts(w_pqf, "@and ");
1265 wrbuf_puts(w_pqf, pqf);
1266 wrbuf_puts(w_pqf, " ");
1267 for (i = 0; i < num; i++)
1270 wrbuf_puts(w_pqf, "@or ");
1271 yaz_encode_pqf_term(w_pqf, values[i],
1275 else if (!strncmp(cvalue, "ccl:", 4))
1277 const char *ccl = cvalue + 4;
1278 WRBUF ccl_w = wrbuf_alloc();
1279 for (i = 0; i < num; i++)
1282 struct ccl_rpn_node *cn;
1283 wrbuf_rewind(ccl_w);
1284 wrbuf_puts(ccl_w, ccl);
1285 wrbuf_puts(ccl_w, "=\"");
1286 wrbuf_puts(ccl_w, values[i]);
1287 wrbuf_puts(ccl_w, "\"");
1289 cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1294 wrbuf_printf(w_pqf, "@and ");
1296 /* or multiple values.. could be bad if last
1297 CCL parse fails, but this is unlikely to
1300 wrbuf_printf(w_pqf, "@or ");
1301 ccl_pquery(w_pqf, cn);
1305 wrbuf_destroy(ccl_w);
1307 else if (!strncmp(cvalue, "local:", 6)) {
1312 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1313 sdb->database->id, cvalue);
1314 ret = -1; /* bad limitmap */
1323 for (i = 0; i < service->num_metadata; i++)
1325 struct conf_metadata *md = service->metadata + i;
1326 if (!strcmp(md->name, name) && md->limitcluster)
1328 yaz_log(YLOG_LOG, "limitcluster in use for %s",
1333 if (i == service->num_metadata)
1335 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1336 (sdb->database ? sdb->database->id : "<no id>"), name);
1340 nmem_destroy(nmem_tmp);
1344 // Parse the query given the settings specific to this client
1345 // client variable same_search is set as below as well as returned:
1346 // 0 if query is OK but different from before
1347 // 1 if query is OK but same as before
1348 // return -1 on query error
1349 // return -2 on limit error
1350 int client_parse_query(struct client *cl, const char *query,
1351 facet_limits_t facet_limits)
1353 struct session *se = client_get_session(cl);
1354 struct conf_service *service = se->service;
1355 struct session_database *sdb = client_get_database(cl);
1356 struct ccl_rpn_node *cn;
1359 CCL_bibset ccl_map = prepare_cclmap(cl, service->ccl_bibset);
1360 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1361 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1362 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1363 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1371 w_ccl = wrbuf_alloc();
1372 wrbuf_puts(w_ccl, query);
1374 w_pqf = wrbuf_alloc();
1377 wrbuf_puts(w_pqf, pqf_prefix);
1378 wrbuf_puts(w_pqf, " ");
1381 if (apply_limit(sdb, facet_limits, w_pqf, ccl_map, service))
1383 ccl_qual_rm(&ccl_map);
1387 facet_limits_destroy(cl->facet_limits);
1388 cl->facet_limits = facet_limits_dup(facet_limits);
1390 yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s",
1391 client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
1392 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1393 ccl_qual_rm(&ccl_map);
1396 client_set_state(cl, Client_Error);
1397 session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1400 wrbuf_destroy(w_ccl);
1401 wrbuf_destroy(w_pqf);
1404 wrbuf_destroy(w_ccl);
1406 if (!pqf_strftime || !*pqf_strftime)
1407 ccl_pquery(w_pqf, cn);
1410 time_t cur_time = time(0);
1411 struct tm *tm = localtime(&cur_time);
1413 const char *cp = tmp_str;
1415 /* see man strftime(3) for things .. In particular %% gets converted
1416 to %.. And That's our original query .. */
1417 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1421 ccl_pquery(w_pqf, cn);
1423 wrbuf_putc(w_pqf, cp[0]);
1427 /* Compares query and limit with old one. If different we need to research */
1428 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1431 session_log(se, YLOG_LOG, "Client %s: "
1432 "Re-search due query/limit change: %s to %s",
1433 client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
1435 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1436 // return value is no longer used.
1438 // Need to (re)search
1441 wrbuf_destroy(w_pqf);
1443 xfree(cl->cqlquery);
1446 odr_out = odr_createmem(ODR_ENCODE);
1447 zquery = p_query_rpn(odr_out, cl->pquery);
1451 session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1452 client_get_id(cl), cl->pquery);
1457 session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1458 client_get_id(cl), cl->pquery);
1460 /* Support for PQF on SRU targets. */
1461 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1463 if (!strcmp(sru, "solr"))
1464 cl->cqlquery = make_solrquery(cl, zquery);
1466 cl->cqlquery = make_cqlquery(cl, zquery);
1470 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
1471 client_get_id(cl), cl->cqlquery, sru);
1474 odr_destroy(odr_out);
1476 /* TODO FIX Not thread safe */
1479 // Initialize relevance structure with query terms
1480 se->relevance = relevance_create_ccl(se->service->charsets, cn,
1481 se->service->rank_cluster,
1482 se->service->rank_follow,
1483 se->service->rank_lead,
1484 se->service->rank_length);
1490 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
1494 const char *sort_strategy_and_spec =
1495 get_strategy_plus_sort(cl, sp->name);
1496 int increasing = sp->increasing;
1497 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1499 char strategy[50], *p;
1500 strcpy(strategy, sort_strategy_and_spec);
1501 p = strchr(strategy, ':');
1504 // Split the string in two
1512 yaz_log(YLOG_LOG, "Client %s: "
1513 "applying sorting %s %s", client_get_id(cl),
1515 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
1516 cl->same_search = 0;
1517 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
1518 cl->same_search = 0;
1519 if (cl->same_search == 0) {
1520 xfree(cl->sort_strategy);
1521 cl->sort_strategy = xstrdup(strategy);
1522 xfree(cl->sort_criteria);
1523 cl->sort_criteria = xstrdup(p);
1527 yaz_log(YLOG_LOG, "Client %s: "
1528 "Invalid sort strategy and spec found %s",
1529 client_get_id(cl), sort_strategy_and_spec);
1530 xfree(cl->sort_strategy);
1531 cl->sort_strategy = 0;
1532 xfree(cl->sort_criteria);
1533 cl->sort_criteria = 0;
1538 yaz_log(YLOG_DEBUG, "Client %s: "
1539 "No sort strategy and spec found.", client_get_id(cl));
1540 xfree(cl->sort_strategy);
1541 cl->sort_strategy = 0;
1542 xfree(cl->sort_criteria);
1543 cl->sort_criteria = 0;
1547 return !cl->same_search;
1550 void client_set_session(struct client *cl, struct session *se)
1555 int client_is_active(struct client *cl)
1557 if (cl->connection && (cl->state == Client_Connecting ||
1558 cl->state == Client_Working))
1563 int client_is_active_preferred(struct client *cl)
1565 /* only count if this is a preferred target. */
1568 /* TODO No sure this the condition that Seb wants */
1569 if (cl->connection && (cl->state == Client_Connecting ||
1570 cl->state == Client_Working))
1575 Odr_int client_get_hits(struct client *cl)
1580 Odr_int client_get_approximation(struct client *cl)
1582 if (cl->record_offset > 0)
1584 Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered))
1585 / cl->record_offset + 5) /10;
1586 yaz_log(YLOG_DEBUG, "%s: Approx: %lld * %d / %d = %lld ",
1587 client_get_id(cl), cl->hits,
1588 cl->record_offset - cl->filtered, cl->record_offset, approx);
1594 int client_get_num_records(struct client *cl)
1596 return cl->record_offset;
1599 int client_get_num_records_filtered(struct client *cl)
1601 return cl->filtered;
1604 void client_set_diagnostic(struct client *cl, int diagnostic,
1605 const char *message, const char *addinfo)
1607 cl->diagnostic = diagnostic;
1609 cl->message = xstrdup(message);
1613 cl->addinfo = xstrdup(addinfo);
1616 int client_get_diagnostic(struct client *cl, const char **message,
1617 const char **addinfo)
1620 *message = cl->message;
1622 *addinfo = cl->addinfo;
1623 return cl->diagnostic;
1626 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1629 struct suggestions *suggestions = cl->suggestions;
1633 if (suggestions->passthrough)
1635 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n",
1636 suggestions->passthrough);
1637 return suggestions->passthrough;
1639 if (suggestions->num == 0)
1642 for (idx = 0; idx < suggestions->num; idx++) {
1643 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1644 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1645 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1646 wrbuf_puts(wrbuf, "</suggest>\n");
1649 wrbuf_puts(wrbuf, "/>\n");
1652 return wrbuf_cstr(wrbuf);
1656 void client_set_database(struct client *cl, struct session_database *db)
1661 const char *client_get_id(struct client *cl)
1666 int client_get_maxrecs(struct client *cl)
1671 void client_set_preferred(struct client *cl, int v)
1677 struct suggestions* client_suggestions_create(const char* suggestions_string)
1681 struct suggestions *suggestions;
1682 if (suggestions_string == 0 || suggestions_string[0] == 0 )
1684 nmem = nmem_create();
1685 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1686 yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1688 suggestions->nmem = nmem;
1689 suggestions->num = 0;
1690 suggestions->misspelled = 0;
1691 suggestions->suggest = 0;
1692 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1694 if (suggestions_string)
1695 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1696 &suggestions->num, 1, '\\', 0);
1697 /* Set up misspelled array */
1698 suggestions->misspelled = (char **)
1699 nmem_malloc(nmem, suggestions->num * sizeof(*suggestions->misspelled));
1700 /* replace = with \0 .. for each item */
1701 for (i = 0; i < suggestions->num; i++)
1703 char *cp = strchr(suggestions->suggest[i], '=');
1706 suggestions->misspelled[i] = cp+1;
1712 static void client_suggestions_destroy(struct client *cl)
1714 NMEM nmem = cl->suggestions->nmem;
1715 cl->suggestions = 0;
1722 * c-file-style: "Stroustrup"
1723 * indent-tabs-mode: nil
1725 * vim: shiftwidth=4 tabstop=8 expandtab