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;
131 facet_limits_t facet_limits;
146 int active; // whether this request has been sent to the server
152 void (*error_handler)(void *data, const char *addinfo);
153 void (*record_handler)(void *data, const char *buf, size_t sz);
155 struct show_raw *next;
158 static const char *client_states[] = {
164 "Client_Disconnected"
167 const char *client_get_state_str(struct client *cl)
169 return client_states[cl->state];
172 enum client_state client_get_state(struct client *cl)
177 void client_set_state_nb(struct client *cl, enum client_state st)
182 void client_set_state(struct client *cl, enum client_state st)
185 if (client_is_active(cl))
188 /* If client is going from being active to inactive and all clients
189 are now idle we fire a watch for the session . The assumption is
190 that session is not mutex locked if client is already active */
191 if (was_active && !client_is_active(cl) && cl->session)
194 int no_active = session_active_clients(cl->session);
195 yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
196 client_get_id(cl), no_active);
197 if (no_active == 0) {
198 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
199 session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
200 session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
201 session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
206 static void client_show_raw_error(struct client *cl, const char *addinfo);
208 struct connection *client_get_connection(struct client *cl)
210 return cl->connection;
213 struct session_database *client_get_database(struct client *cl)
218 struct session *client_get_session(struct client *cl)
223 const char *client_get_pquery(struct client *cl)
228 static void client_send_raw_present(struct client *cl);
229 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
231 static void client_show_immediate(
232 ZOOM_resultset resultset, struct session_database *sdb, int position,
234 void (*error_handler)(void *data, const char *addinfo),
235 void (*record_handler)(void *data, const char *buf, size_t sz),
237 const char *nativesyntax)
246 error_handler(data, "no resultset");
249 rec = ZOOM_resultset_record_immediate(resultset, position-1);
252 error_handler(data, "no record");
255 nativesyntax_to_type(nativesyntax, type, rec);
256 buf = ZOOM_record_get(rec, type, &len);
259 error_handler(data, "no record");
262 record_handler(data, buf, len);
266 int client_show_raw_begin(struct client *cl, int position,
267 const char *syntax, const char *esn,
269 void (*error_handler)(void *data, const char *addinfo),
270 void (*record_handler)(void *data, const char *buf,
273 const char *nativesyntax)
278 nativesyntax = "raw";
281 struct session_database *sdb = client_get_database(cl);
282 nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
286 if (syntax == 0 && esn == 0)
287 client_show_immediate(cl->resultset, client_get_database(cl),
289 error_handler, record_handler,
290 binary, nativesyntax);
293 struct show_raw *rr, **rrp;
299 rr = xmalloc(sizeof(*rr));
300 rr->position = position;
303 rr->error_handler = error_handler;
304 rr->record_handler = record_handler;
307 rr->syntax = xstrdup(syntax);
311 rr->esn = xstrdup(esn);
315 assert(nativesyntax);
316 rr->nativesyntax = xstrdup(nativesyntax);
320 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
324 if (cl->state == Client_Failed)
326 client_show_raw_error(cl, "client failed");
328 else if (cl->state == Client_Disconnected)
330 client_show_raw_error(cl, "client disconnected");
334 client_send_raw_present(cl);
340 static void client_show_raw_delete(struct show_raw *r)
344 xfree(r->nativesyntax);
348 void client_show_raw_remove(struct client *cl, void *data)
350 struct show_raw *rr = data;
351 struct show_raw **rrp = &cl->show_raw;
357 client_show_raw_delete(rr);
361 void client_show_raw_dequeue(struct client *cl)
363 struct show_raw *rr = cl->show_raw;
365 cl->show_raw = rr->next;
366 client_show_raw_delete(rr);
369 static void client_show_raw_error(struct client *cl, const char *addinfo)
373 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
374 client_show_raw_dequeue(cl);
378 static void client_send_raw_present(struct client *cl)
380 struct session_database *sdb = client_get_database(cl);
381 struct connection *co = client_get_connection(cl);
382 ZOOM_resultset set = cl->resultset;
384 int offset = cl->show_raw->position;
385 const char *syntax = 0;
386 const char *elements = 0;
388 assert(cl->show_raw);
391 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
392 client_get_id(cl), 1, offset);
394 if (cl->show_raw->syntax)
395 syntax = cl->show_raw->syntax;
397 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
398 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
400 if (cl->show_raw->esn)
401 elements = cl->show_raw->esn;
403 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
404 if (elements && *elements)
405 ZOOM_resultset_option_set(set, "elementSetName", elements);
407 ZOOM_resultset_records(set, 0, offset-1, 1);
408 cl->show_raw->active = 1;
410 connection_continue(co);
413 static int nativesyntax_to_type(const char *s, char *type,
418 if (!strncmp(s, "iso2709", 7))
420 const char *cp = strchr(s, ';');
421 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
423 else if (!strncmp(s, "txml", 4))
425 const char *cp = strchr(s, ';');
426 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
428 else /* pass verbatim to ZOOM - including "xml" */
432 else /* attempt to deduce structure */
434 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
437 if (!strcmp(syntax, "XML"))
442 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
444 strcpy(type, "xml; charset=marc8-s");
454 * TODO Consider thread safety!!!
457 void client_report_facets(struct client *cl, ZOOM_resultset rs)
459 struct session_database *sdb = client_get_database(cl);
460 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
464 struct session *se = client_get_session(cl);
465 int facet_num = ZOOM_resultset_facets_size(rs);
468 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
470 const char *p = strchr(s->name + 3, ':');
471 if (p && p[1] && s->value && s->value[0])
474 p++; /* p now holds logical facet name */
475 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
477 const char *native_name =
478 ZOOM_facet_field_name(facets[facet_idx]);
479 if (native_name && !strcmp(s->value, native_name))
483 ZOOM_facet_field_term_count(facets[facet_idx]);
484 for (term_idx = 0; term_idx < term_num; term_idx++ )
488 ZOOM_facet_field_get_term(facets[facet_idx],
491 add_facet(se, p, term, freq);
501 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
507 nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
508 buf = ZOOM_record_get(rec, type, &len);
509 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
510 client_show_raw_dequeue(cl);
513 void client_check_preferred_watch(struct client *cl)
515 struct session *se = cl->session;
516 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
520 /* TODO possible threading issue. Session can have been destroyed */
521 if (session_is_preferred_clients_ready(se)) {
522 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
525 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
530 yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
534 struct suggestions* client_suggestions_create(const char* suggestions_string);
535 static void client_suggestions_destroy(struct client *cl);
537 void client_search_response(struct client *cl)
539 struct connection *co = cl->connection;
540 ZOOM_connection link = connection_get_link(co);
541 ZOOM_resultset resultset = cl->resultset;
543 const char *error, *addinfo = 0;
545 if (ZOOM_connection_error(link, &error, &addinfo))
548 client_set_state(cl, Client_Error);
549 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
550 error, addinfo, client_get_id(cl));
554 client_report_facets(cl, resultset);
555 cl->record_offset = cl->startrecs;
556 cl->hits = ZOOM_resultset_size(resultset);
557 yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, cl->hits);
559 client_suggestions_destroy(cl);
560 cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
564 void client_got_records(struct client *cl)
566 struct session *se = cl->session;
569 if (reclist_get_num_records(se->reclist) > 0)
572 session_alert_watch(se, SESSION_WATCH_SHOW);
573 session_alert_watch(se, SESSION_WATCH_BYTARGET);
574 session_alert_watch(se, SESSION_WATCH_TERMLIST);
575 session_alert_watch(se, SESSION_WATCH_RECORD);
581 static void client_record_ingest(struct client *cl)
583 const char *msg, *addinfo;
585 ZOOM_resultset resultset = cl->resultset;
586 struct session *se = client_get_session(cl);
588 if ((rec = ZOOM_resultset_record_immediate(resultset, cl->record_offset)))
590 int offset = ++cl->record_offset;
591 if (cl->session == 0) {
594 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
596 session_log(se, YLOG_WARN, "Record error %s (%s): %s #%d",
597 msg, addinfo, client_get_id(cl), offset);
601 struct session_database *sdb = client_get_database(cl);
602 NMEM nmem = nmem_create();
606 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
607 if (nativesyntax_to_type(s, type, rec))
608 session_log(se, YLOG_WARN, "Failed to determine record type");
609 xmlrec = ZOOM_record_get(rec, type, NULL);
612 const char *rec_syn = ZOOM_record_get(rec, "syntax", NULL);
613 session_log(se, YLOG_WARN, "ZOOM_record_get failed from %s #%d",
614 client_get_id(cl), offset);
615 session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
616 "ZOOM record type=%s . Actual record syntax=%s",
617 s ? s : "null", type,
618 rec_syn ? rec_syn : "null");
622 /* OK = 0, -1 = failure, -2 = Filtered */
623 int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem);
626 const char *rec_syn = ZOOM_record_get(rec, "syntax", NULL);
627 session_log(se, YLOG_WARN,
628 "Failed to ingest record from %s #%d",
629 client_get_id(cl), offset);
630 session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
631 "ZOOM record type=%s . Actual record syntax=%s",
632 s ? s : "null", type,
633 rec_syn ? rec_syn : "null");
643 session_log(se, YLOG_WARN, "Got NULL record from %s #%d",
644 client_get_id(cl), cl->record_offset);
648 void client_record_response(struct client *cl)
650 struct connection *co = cl->connection;
651 ZOOM_connection link = connection_get_link(co);
652 ZOOM_resultset resultset = cl->resultset;
653 const char *error, *addinfo;
655 if (ZOOM_connection_error(link, &error, &addinfo))
657 client_set_state(cl, Client_Error);
658 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
659 error, addinfo, client_get_id(cl));
663 if (cl->show_raw && cl->show_raw->active)
666 if ((rec = ZOOM_resultset_record_immediate(
667 resultset, cl->show_raw->position-1)))
669 cl->show_raw->active = 0;
670 ingest_raw_record(cl, rec);
674 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
675 cl->show_raw->position-1);
680 client_record_ingest(cl);
685 int client_reingest(struct client *cl)
687 int i = cl->startrecs;
688 int to = cl->record_offset;
691 cl->record_offset = i;
693 client_record_ingest(cl);
697 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
699 struct session_database *sdb = client_get_database(cl);
701 WRBUF w = wrbuf_alloc();
705 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
707 const char *p = strchr(s->name + 3, ':');
710 yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
712 else if (s->value && s->value[0])
714 wrbuf_puts(w, "@attr 1=");
715 yaz_encode_pqf_term(w, s->value, strlen(s->value));
720 yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
721 ZOOM_connection_option_set(link, "facets",
722 wrbuf_len(w) ? wrbuf_cstr(w) : 0);
726 int client_has_facet(struct client *cl, const char *name)
728 struct session_database *sdb = client_get_database(cl);
731 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
733 const char *p = strchr(s->name + 3, ':');
734 if (p && !strcmp(name, p + 1))
740 static const char *get_strategy_plus_sort(struct client *l, const char *field)
742 struct session_database *sdb = client_get_database(l);
745 const char *strategy_plus_sort = 0;
747 for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
749 char *p = strchr(s->name + 3, ':');
752 yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
756 if (!strcmp(p, field))
758 strategy_plus_sort = s->value;
762 return strategy_plus_sort;
765 int client_fetch_more(struct client *cl)
767 struct session_database *sdb = client_get_database(cl);
772 str = session_setting_oneval(sdb, PZ_EXTENDRECS);
774 extend_recs = atoi(str);
776 if (extend_recs > cl->hits)
777 extend_recs = cl->hits;
779 number = extend_recs - cl->record_offset;
782 ZOOM_resultset set = cl->resultset;
783 struct connection *co = client_get_connection(cl);
785 str = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
786 ZOOM_resultset_option_set(set, "preferredRecordSyntax", str);
787 str = session_setting_oneval(sdb, PZ_ELEMENTS);
789 ZOOM_resultset_option_set(set, "elementSetName", str);
791 ZOOM_resultset_records(set, 0, cl->record_offset, number);
792 client_set_state(cl, Client_Working);
793 connection_continue(co);
799 int client_parse_init(struct client *cl, int same_search)
801 cl->same_search = same_search;
806 * TODO consider how to extend the range
808 int client_parse_range(struct client *cl, const char *startrecs, const char *maxrecs)
810 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
813 cl->maxrecs = atoi(maxrecs);
816 if (startrecs && atoi(startrecs) != cl->startrecs)
819 cl->startrecs = atoi(startrecs);
825 int client_start_search(struct client *cl)
827 struct session_database *sdb = client_get_database(cl);
828 struct connection *co = 0;
829 ZOOM_connection link = 0;
830 struct session *se = client_get_session(cl);
832 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
833 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
834 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
835 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
836 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
837 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
838 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
839 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
840 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
841 const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
843 char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
845 int present_chunk = 20; // Default chunk size
846 int rc_prep_connection;
849 yaz_gettimeofday(&tval);
852 if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
853 present_chunk = atoi(opt_present_chunk);
854 yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
857 client_prep_connection(cl, se->service->z3950_operation_timeout,
858 se->service->z3950_session_timeout,
859 se->service->server->iochan_man,
861 /* Nothing has changed and we already have a result */
862 if (cl->same_search == 1 && rc_prep_connection == 2)
864 session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
865 return client_reingest(cl);
867 else if (!rc_prep_connection)
869 session_log(se, YLOG_LOG, "client %s FAILED to search: No connection.", client_get_id(cl));
872 co = client_get_connection(cl);
874 link = connection_get_link(co);
877 session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
882 if (extra_args && *extra_args)
883 ZOOM_connection_option_set(link, "extraArgs", extra_args);
886 cl->preferred = atoi(opt_preferred);
888 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
889 client_get_id(cl), cl->preferred);
893 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
895 ZOOM_connection_option_set(link, "piggyback", "1");
897 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
898 if (*opt_sru && *opt_elements)
899 ZOOM_connection_option_set(link, "schema", opt_elements);
900 else if (*opt_elements)
901 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
903 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
905 if (opt_maxrecs && *opt_maxrecs)
907 cl->maxrecs = atoi(opt_maxrecs);
910 /* convert back to string representation used in ZOOM API */
911 sprintf(maxrecs_str, "%d", cl->maxrecs);
912 ZOOM_connection_option_set(link, "count", maxrecs_str);
914 /* A present_chunk less than 1 will disable chunking. */
915 if (present_chunk > 0 && cl->maxrecs > present_chunk) {
916 sprintf(present_chunk_str, "%d", present_chunk);
917 ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
918 yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
921 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
922 yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
924 sprintf(startrecs_str, "%d", cl->startrecs);
925 ZOOM_connection_option_set(link, "start", startrecs_str);
927 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
928 /* facets definition is in PQF */
929 client_set_facets_request(cl, link);
931 query = ZOOM_query_create();
934 yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl), cl->cqlquery);
935 ZOOM_query_cql(query, cl->cqlquery);
937 ZOOM_query_sortby(query, opt_sort);
941 yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), cl->pquery);
943 ZOOM_query_prefix(query, cl->pquery);
945 if (cl->sort_strategy && cl->sort_criteria) {
946 yaz_log(YLOG_LOG, "Client %s: Setting ZOOM sort strategy and criteria: %s %s",
947 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
948 ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
951 yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
952 client_set_state(cl, Client_Working);
954 cl->record_offset = 0;
955 rs = ZOOM_connection_search(link, query);
956 ZOOM_query_destroy(query);
957 ZOOM_resultset_destroy(cl->resultset);
959 connection_continue(co);
963 struct client *client_create(const char *id)
965 struct client *cl = xmalloc(sizeof(*cl));
976 cl->record_offset = 0;
979 cl->state = Client_Disconnected;
984 pazpar2_mutex_create(&cl->mutex, "client");
987 cl->facet_limits = 0;
988 cl->sort_strategy = 0;
989 cl->sort_criteria = 0;
991 cl->id = xstrdup(id);
997 void client_lock(struct client *c)
999 yaz_mutex_enter(c->mutex);
1002 void client_unlock(struct client *c)
1004 yaz_mutex_leave(c->mutex);
1007 void client_incref(struct client *c)
1009 pazpar2_incref(&c->ref_count, c->mutex);
1010 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
1011 c, client_get_id(c), c->ref_count);
1014 int client_destroy(struct client *c)
1018 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
1019 c, client_get_id(c), c->ref_count);
1020 if (!pazpar2_decref(&c->ref_count, c->mutex))
1031 xfree(c->sort_strategy);
1032 xfree(c->sort_criteria);
1033 assert(!c->connection);
1034 facet_limits_destroy(c->facet_limits);
1038 ZOOM_resultset_destroy(c->resultset);
1040 yaz_mutex_destroy(&c->mutex);
1049 void client_set_connection(struct client *cl, struct connection *con)
1052 ZOOM_resultset_release(cl->resultset);
1055 assert(cl->connection == 0);
1056 cl->connection = con;
1061 cl->connection = con;
1066 void client_disconnect(struct client *cl)
1068 if (cl->state != Client_Idle)
1069 client_set_state(cl, Client_Disconnected);
1070 client_set_connection(cl, 0);
1074 // Initialize CCL map for a target
1075 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1077 struct session_database *sdb = client_get_database(cl);
1084 res = ccl_qual_dup(base_bibset);
1086 res = ccl_qual_mk();
1087 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1089 const char *addinfo = 0;
1090 char *p = strchr(s->name + 3, ':');
1093 WRBUF w = wrbuf_alloc();
1094 wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1095 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1096 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1097 ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1099 client_set_state_nb(cl, Client_Error);
1105 if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1107 WRBUF w = wrbuf_alloc();
1109 wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1110 s->name, p, addinfo);
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);
1124 // returns a xmalloced CQL query corresponding to the pquery in client
1125 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1127 cql_transform_t cqlt = cql_transform_create();
1129 WRBUF wrb = wrbuf_alloc();
1132 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1134 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1138 r = xstrdup(wrbuf_cstr(wrb));
1141 cql_transform_close(cqlt);
1145 // returns a xmalloced SOLR query corresponding to the pquery in client
1146 // TODO Could prob. be merge with the similar make_cqlquery
1147 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1149 solr_transform_t sqlt = solr_transform_create();
1151 WRBUF wrb = wrbuf_alloc();
1154 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1156 yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1160 r = xstrdup(wrbuf_cstr(wrb));
1163 solr_transform_close(sqlt);
1167 const char *client_get_facet_limit_local(struct client *cl,
1168 struct session_database *sdb,
1170 NMEM nmem, int *num, char ***values)
1172 const char *name = 0;
1173 const char *value = 0;
1174 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1176 struct setting *s = 0;
1178 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1180 const char *p = strchr(s->name + 3, ':');
1181 if (p && !strcmp(p + 1, name) && s->value)
1185 nmem_strsplit_escape2(nmem, ",", s->value, &cvalues,
1187 for (j = 0; j < cnum; j++)
1189 const char *cvalue = cvalues[j];
1190 while (*cvalue == ' ')
1192 if (!strncmp(cvalue, "local:", 6))
1194 const char *cp = cvalue + 6;
1197 nmem_strsplit_escape2(nmem, "|", value, values,
1200 return *cp ? cp : name;
1209 static int apply_limit(struct session_database *sdb,
1210 facet_limits_t facet_limits,
1211 WRBUF w_pqf, CCL_bibset ccl_map,
1212 struct conf_service *service)
1219 NMEM nmem_tmp = nmem_create();
1220 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1222 struct setting *s = 0;
1223 nmem_reset(nmem_tmp);
1224 /* name="pz:limitmap:author" value="rpn:@attr 1=4|local:other" */
1225 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1227 const char *p = strchr(s->name + 3, ':');
1228 if (p && !strcmp(p + 1, name) && s->value)
1234 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1237 nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues,
1240 for (j = 0; ret == 0 && j < cnum; j++)
1242 const char *cvalue = cvalues[j];
1243 while (*cvalue == ' ')
1245 if (!strncmp(cvalue, "rpn:", 4))
1247 const char *pqf = cvalue + 4;
1248 wrbuf_puts(w_pqf, "@and ");
1249 wrbuf_puts(w_pqf, pqf);
1250 wrbuf_puts(w_pqf, " ");
1251 for (i = 0; i < num; i++)
1254 wrbuf_puts(w_pqf, "@or ");
1255 yaz_encode_pqf_term(w_pqf, values[i],
1259 else if (!strncmp(cvalue, "ccl:", 4))
1261 const char *ccl = cvalue + 4;
1262 WRBUF ccl_w = wrbuf_alloc();
1263 for (i = 0; i < num; i++)
1266 struct ccl_rpn_node *cn;
1267 wrbuf_rewind(ccl_w);
1268 wrbuf_puts(ccl_w, ccl);
1269 wrbuf_puts(ccl_w, "=\"");
1270 wrbuf_puts(ccl_w, values[i]);
1271 wrbuf_puts(ccl_w, "\"");
1273 cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1278 wrbuf_printf(w_pqf, "@and ");
1280 /* or multiple values.. could be bad if last
1281 CCL parse fails, but this is unlikely to
1284 wrbuf_printf(w_pqf, "@or ");
1285 ccl_pquery(w_pqf, cn);
1289 wrbuf_destroy(ccl_w);
1291 else if (!strncmp(cvalue, "local:", 6)) {
1296 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1297 sdb->database->id, cvalue);
1298 ret = -1; /* bad limitmap */
1307 for (i = 0; i < service->num_metadata; i++)
1309 struct conf_metadata *md = service->metadata + i;
1310 if (!strcmp(md->name, name) && md->limitcluster)
1312 yaz_log(YLOG_LOG, "limitcluster in use for %s",
1317 if (i == service->num_metadata)
1319 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1320 (sdb->database ? sdb->database->id : "<no id>"), name);
1324 nmem_destroy(nmem_tmp);
1328 // Parse the query given the settings specific to this client
1329 // client variable same_search is set as below as well as returned:
1330 // 0 if query is OK but different from before
1331 // 1 if query is OK but same as before
1332 // return -1 on query error
1333 // return -2 on limit error
1334 int client_parse_query(struct client *cl, const char *query,
1335 facet_limits_t facet_limits)
1337 struct session *se = client_get_session(cl);
1338 struct conf_service *service = se->service;
1339 struct session_database *sdb = client_get_database(cl);
1340 struct ccl_rpn_node *cn;
1343 CCL_bibset ccl_map = prepare_cclmap(cl, service->ccl_bibset);
1344 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1345 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1346 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1347 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1355 w_ccl = wrbuf_alloc();
1356 wrbuf_puts(w_ccl, query);
1358 w_pqf = wrbuf_alloc();
1361 wrbuf_puts(w_pqf, pqf_prefix);
1362 wrbuf_puts(w_pqf, " ");
1365 if (apply_limit(sdb, facet_limits, w_pqf, ccl_map, service))
1367 ccl_qual_rm(&ccl_map);
1371 facet_limits_destroy(cl->facet_limits);
1372 cl->facet_limits = facet_limits_dup(facet_limits);
1374 yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s", client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
1375 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1376 ccl_qual_rm(&ccl_map);
1379 client_set_state(cl, Client_Error);
1380 session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1383 wrbuf_destroy(w_ccl);
1384 wrbuf_destroy(w_pqf);
1387 wrbuf_destroy(w_ccl);
1389 if (!pqf_strftime || !*pqf_strftime)
1390 ccl_pquery(w_pqf, cn);
1393 time_t cur_time = time(0);
1394 struct tm *tm = localtime(&cur_time);
1396 const char *cp = tmp_str;
1398 /* see man strftime(3) for things .. In particular %% gets converted
1399 to %.. And That's our original query .. */
1400 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1404 ccl_pquery(w_pqf, cn);
1406 wrbuf_putc(w_pqf, cp[0]);
1410 /* Compares query and limit with old one. If different we need to research */
1411 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1414 session_log(se, YLOG_LOG, "Client %s: Re-search due query/limit change: %s to %s",
1415 client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
1417 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1418 // return value is no longer used.
1420 // Need to (re)search
1423 wrbuf_destroy(w_pqf);
1425 xfree(cl->cqlquery);
1428 odr_out = odr_createmem(ODR_ENCODE);
1429 zquery = p_query_rpn(odr_out, cl->pquery);
1433 session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1434 client_get_id(cl), cl->pquery);
1439 session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1440 client_get_id(cl), cl->pquery);
1442 /* Support for PQF on SRU targets. */
1443 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1445 if (!strcmp(sru, "solr"))
1446 cl->cqlquery = make_solrquery(cl, zquery);
1448 cl->cqlquery = make_cqlquery(cl, zquery);
1452 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
1453 client_get_id(cl), cl->cqlquery, sru);
1456 odr_destroy(odr_out);
1458 /* TODO FIX Not thread safe */
1461 // Initialize relevance structure with query terms
1462 se->relevance = relevance_create_ccl(se->service->charsets, cn,
1463 se->service->rank_cluster,
1464 se->service->rank_follow,
1465 se->service->rank_lead,
1466 se->service->rank_length);
1472 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
1476 const char *sort_strategy_and_spec =
1477 get_strategy_plus_sort(cl, sp->name);
1478 int increasing = sp->increasing;
1479 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1481 char strategy[50], *p;
1482 strcpy(strategy, sort_strategy_and_spec);
1483 p = strchr(strategy, ':');
1486 // Split the string in two
1494 yaz_log(YLOG_LOG, "Client %s: applying sorting %s %s", client_get_id(cl), strategy, p);
1495 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
1496 cl->same_search = 0;
1497 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
1498 cl->same_search = 0;
1499 if (cl->same_search == 0) {
1500 xfree(cl->sort_strategy);
1501 cl->sort_strategy = xstrdup(strategy);
1502 xfree(cl->sort_criteria);
1503 cl->sort_criteria = xstrdup(p);
1507 yaz_log(YLOG_LOG, "Client %s: Invalid sort strategy and spec found %s", client_get_id(cl), sort_strategy_and_spec);
1508 xfree(cl->sort_strategy);
1509 cl->sort_strategy = 0;
1510 xfree(cl->sort_criteria);
1511 cl->sort_criteria = 0;
1514 yaz_log(YLOG_DEBUG, "Client %s: No sort strategy and spec found.", client_get_id(cl));
1515 xfree(cl->sort_strategy);
1516 cl->sort_strategy = 0;
1517 xfree(cl->sort_criteria);
1518 cl->sort_criteria = 0;
1522 return !cl->same_search;
1525 void client_set_session(struct client *cl, struct session *se)
1530 int client_is_active(struct client *cl)
1532 if (cl->connection && (cl->state == Client_Connecting ||
1533 cl->state == Client_Working))
1538 int client_is_active_preferred(struct client *cl)
1540 /* only count if this is a preferred target. */
1543 /* TODO No sure this the condition that Seb wants */
1544 if (cl->connection && (cl->state == Client_Connecting ||
1545 cl->state == Client_Working))
1550 Odr_int client_get_hits(struct client *cl)
1555 Odr_int client_get_approximation(struct client *cl)
1557 if (cl->record_offset > 0) {
1558 Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered)) / cl->record_offset + 5) /10;
1559 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);
1565 int client_get_num_records(struct client *cl)
1567 return cl->record_offset;
1570 int client_get_num_records_filtered(struct client *cl)
1572 return cl->filtered;
1575 void client_set_diagnostic(struct client *cl, int diagnostic,
1576 const char *message, const char *addinfo)
1578 cl->diagnostic = diagnostic;
1580 cl->message = xstrdup(message);
1584 cl->addinfo = xstrdup(addinfo);
1587 int client_get_diagnostic(struct client *cl, const char **message,
1588 const char **addinfo)
1591 *message = cl->message;
1593 *addinfo = cl->addinfo;
1594 return cl->diagnostic;
1597 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1600 struct suggestions *suggestions = cl->suggestions;
1603 //yaz_log(YLOG_DEBUG, "No suggestions found");
1606 if (suggestions->passthrough) {
1607 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1608 return suggestions->passthrough;
1610 if (suggestions->num == 0) {
1614 for (idx = 0; idx < suggestions->num; idx++) {
1615 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1616 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1617 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1618 wrbuf_puts(wrbuf, "</suggest>\n");
1621 wrbuf_puts(wrbuf, "/>\n");
1624 return wrbuf_cstr(wrbuf);
1628 void client_set_database(struct client *cl, struct session_database *db)
1633 const char *client_get_id(struct client *cl)
1638 int client_get_maxrecs(struct client *cl)
1643 void client_set_preferred(struct client *cl, int v)
1649 struct suggestions* client_suggestions_create(const char* suggestions_string)
1653 struct suggestions *suggestions;
1654 if (suggestions_string == 0 || suggestions_string[0] == 0 )
1656 nmem = nmem_create();
1657 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1658 yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1660 suggestions->nmem = nmem;
1661 suggestions->num = 0;
1662 suggestions->misspelled = 0;
1663 suggestions->suggest = 0;
1664 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1666 if (suggestions_string)
1667 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1668 &suggestions->num, 1, '\\', 0);
1669 /* Set up misspelled array */
1670 suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1671 /* replace = with \0 .. for each item */
1672 for (i = 0; i < suggestions->num; i++)
1674 char *cp = strchr(suggestions->suggest[i], '=');
1677 suggestions->misspelled[i] = cp+1;
1683 static void client_suggestions_destroy(struct client *cl)
1685 NMEM nmem = cl->suggestions->nmem;
1686 cl->suggestions = 0;
1690 int client_test_sort_order(struct client *cl, struct reclist_sortparms *sp)
1692 //TODO implement correctly.
1698 * c-file-style: "Stroustrup"
1699 * indent-tabs-mode: nil
1701 * vim: shiftwidth=4 tabstop=8 expandtab