1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2012 Index Data
4 Pazpar2 is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
39 #include <yaz/marcdisp.h>
40 #include <yaz/comstack.h>
41 #include <yaz/tcpip.h>
42 #include <yaz/proto.h>
43 #include <yaz/readconf.h>
44 #include <yaz/pquery.h>
45 #include <yaz/otherinfo.h>
46 #include <yaz/yaz-util.h>
48 #include <yaz/query-charset.h>
49 #include <yaz/querytowrbuf.h>
50 #include <yaz/oid_db.h>
51 #include <yaz/diagbib1.h>
52 #include <yaz/snprintf.h>
53 #include <yaz/rpn2cql.h>
54 #include <yaz/rpn2solr.h>
58 #include <yaz/timing.h>
63 #include "parameters.h"
65 #include "connection.h"
67 #include "relevance.h"
70 static YAZ_MUTEX g_mutex = 0;
71 static int no_clients = 0;
72 static int no_clients_total = 0;
74 static int client_use(int delta)
78 yaz_mutex_create(&g_mutex);
79 yaz_mutex_enter(g_mutex);
82 no_clients_total += delta;
84 yaz_mutex_leave(g_mutex);
85 yaz_log(YLOG_DEBUG, "%s clients=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
89 int clients_count(void) {
93 int clients_count_total(void) {
97 yaz_mutex_enter(g_mutex);
98 total = no_clients_total;
99 yaz_mutex_leave(g_mutex);
104 /** \brief Represents client state for a connection to one search target */
106 struct session_database *database;
107 struct connection *connection;
108 struct session *session;
109 char *pquery; // Current search
110 char *cqlquery; // used for SRU targets only
111 char *addinfo; // diagnostic info for most resent error
114 int filtered; // When using local:, this will count the number of filtered records.
119 struct suggestions *suggestions;
120 enum client_state state;
121 struct show_raw *show_raw;
122 ZOOM_resultset resultset;
126 facet_limits_t facet_limits;
138 int active; // whether this request has been sent to the server
144 void (*error_handler)(void *data, const char *addinfo);
145 void (*record_handler)(void *data, const char *buf, size_t sz);
147 struct show_raw *next;
150 static const char *client_states[] = {
156 "Client_Disconnected"
159 const char *client_get_state_str(struct client *cl)
161 return client_states[cl->state];
164 enum client_state client_get_state(struct client *cl)
169 void client_set_state_nb(struct client *cl, enum client_state st)
174 void client_set_state(struct client *cl, enum client_state st)
177 if (client_is_active(cl))
180 /* If client is going from being active to inactive and all clients
181 are now idle we fire a watch for the session . The assumption is
182 that session is not mutex locked if client is already active */
183 if (was_active && !client_is_active(cl) && cl->session)
186 int no_active = session_active_clients(cl->session);
187 yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
188 client_get_id(cl), no_active);
189 if (no_active == 0) {
190 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
191 session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
192 session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
193 session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
198 static void client_show_raw_error(struct client *cl, const char *addinfo);
200 struct connection *client_get_connection(struct client *cl)
202 return cl->connection;
205 struct session_database *client_get_database(struct client *cl)
210 struct session *client_get_session(struct client *cl)
215 const char *client_get_pquery(struct client *cl)
220 static void client_send_raw_present(struct client *cl);
221 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
223 static void client_show_immediate(
224 ZOOM_resultset resultset, struct session_database *sdb, int position,
226 void (*error_handler)(void *data, const char *addinfo),
227 void (*record_handler)(void *data, const char *buf, size_t sz),
229 const char *nativesyntax)
238 error_handler(data, "no resultset");
241 rec = ZOOM_resultset_record_immediate(resultset, position-1);
244 error_handler(data, "no record");
247 nativesyntax_to_type(nativesyntax, type, rec);
248 buf = ZOOM_record_get(rec, type, &len);
251 error_handler(data, "no record");
254 record_handler(data, buf, len);
258 int client_show_raw_begin(struct client *cl, int position,
259 const char *syntax, const char *esn,
261 void (*error_handler)(void *data, const char *addinfo),
262 void (*record_handler)(void *data, const char *buf,
265 const char *nativesyntax)
270 nativesyntax = "raw";
273 struct session_database *sdb = client_get_database(cl);
274 nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
278 if (syntax == 0 && esn == 0)
279 client_show_immediate(cl->resultset, client_get_database(cl),
281 error_handler, record_handler,
282 binary, nativesyntax);
285 struct show_raw *rr, **rrp;
291 rr = xmalloc(sizeof(*rr));
292 rr->position = position;
295 rr->error_handler = error_handler;
296 rr->record_handler = record_handler;
299 rr->syntax = xstrdup(syntax);
303 rr->esn = xstrdup(esn);
307 assert(nativesyntax);
308 rr->nativesyntax = xstrdup(nativesyntax);
312 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
316 if (cl->state == Client_Failed)
318 client_show_raw_error(cl, "client failed");
320 else if (cl->state == Client_Disconnected)
322 client_show_raw_error(cl, "client disconnected");
326 client_send_raw_present(cl);
332 static void client_show_raw_delete(struct show_raw *r)
336 xfree(r->nativesyntax);
340 void client_show_raw_remove(struct client *cl, void *data)
342 struct show_raw *rr = data;
343 struct show_raw **rrp = &cl->show_raw;
349 client_show_raw_delete(rr);
353 void client_show_raw_dequeue(struct client *cl)
355 struct show_raw *rr = cl->show_raw;
357 cl->show_raw = rr->next;
358 client_show_raw_delete(rr);
361 static void client_show_raw_error(struct client *cl, const char *addinfo)
365 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
366 client_show_raw_dequeue(cl);
370 static void client_send_raw_present(struct client *cl)
372 struct session_database *sdb = client_get_database(cl);
373 struct connection *co = client_get_connection(cl);
374 ZOOM_resultset set = cl->resultset;
376 int offset = cl->show_raw->position;
377 const char *syntax = 0;
378 const char *elements = 0;
380 assert(cl->show_raw);
383 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
384 client_get_id(cl), 1, offset);
386 if (cl->show_raw->syntax)
387 syntax = cl->show_raw->syntax;
389 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
390 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
392 if (cl->show_raw->esn)
393 elements = cl->show_raw->esn;
395 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
396 if (elements && *elements)
397 ZOOM_resultset_option_set(set, "elementSetName", elements);
399 ZOOM_resultset_records(set, 0, offset-1, 1);
400 cl->show_raw->active = 1;
402 connection_continue(co);
405 static int nativesyntax_to_type(const char *s, char *type,
410 if (!strncmp(s, "iso2709", 7))
412 const char *cp = strchr(s, ';');
413 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
415 else if (!strncmp(s, "txml", 4))
417 const char *cp = strchr(s, ';');
418 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
420 else /* pass verbatim to ZOOM - including "xml" */
424 else /* attempt to deduce structure */
426 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
429 if (!strcmp(syntax, "XML"))
434 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
436 strcpy(type, "xml; charset=marc8-s");
446 * TODO Consider thread safety!!!
449 void client_report_facets(struct client *cl, ZOOM_resultset rs)
451 struct session_database *sdb = client_get_database(cl);
452 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
456 struct session *se = client_get_session(cl);
457 int facet_num = ZOOM_resultset_facets_size(rs);
460 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
462 const char *p = strchr(s->name + 3, ':');
463 if (p && p[1] && s->value && s->value[0])
466 p++; /* p now holds logical facet name */
467 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
469 const char *native_name =
470 ZOOM_facet_field_name(facets[facet_idx]);
471 if (native_name && !strcmp(s->value, native_name))
475 ZOOM_facet_field_term_count(facets[facet_idx]);
476 for (term_idx = 0; term_idx < term_num; term_idx++ )
480 ZOOM_facet_field_get_term(facets[facet_idx],
483 add_facet(se, p, term, freq);
493 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
499 nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
500 buf = ZOOM_record_get(rec, type, &len);
501 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
502 client_show_raw_dequeue(cl);
505 void client_check_preferred_watch(struct client *cl)
507 struct session *se = cl->session;
508 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
512 /* TODO possible threading issue. Session can have been destroyed */
513 if (session_is_preferred_clients_ready(se)) {
514 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
517 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
522 yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
526 struct suggestions* client_suggestions_create(const char* suggestions_string);
527 static void client_suggestions_destroy(struct client *cl);
529 void client_search_response(struct client *cl)
531 struct connection *co = cl->connection;
532 ZOOM_connection link = connection_get_link(co);
533 ZOOM_resultset resultset = cl->resultset;
535 const char *error, *addinfo = 0;
537 if (ZOOM_connection_error(link, &error, &addinfo))
540 client_set_state(cl, Client_Error);
541 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
542 error, addinfo, client_get_id(cl));
546 client_report_facets(cl, resultset);
547 cl->record_offset = cl->startrecs;
548 cl->hits = ZOOM_resultset_size(resultset);
549 yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, cl->hits);
551 client_suggestions_destroy(cl);
552 cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
556 void client_got_records(struct client *cl)
558 struct session *se = cl->session;
561 if (reclist_get_num_records(se->reclist) > 0)
564 session_alert_watch(se, SESSION_WATCH_SHOW);
565 session_alert_watch(se, SESSION_WATCH_BYTARGET);
566 session_alert_watch(se, SESSION_WATCH_TERMLIST);
567 session_alert_watch(se, SESSION_WATCH_RECORD);
573 static void client_record_ingest(struct client *cl)
575 const char *msg, *addinfo;
577 ZOOM_resultset resultset = cl->resultset;
578 int offset = cl->record_offset;
579 if ((rec = ZOOM_resultset_record_immediate(resultset, offset)))
582 if (cl->session == 0) {
585 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
587 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
588 msg, addinfo, client_get_id(cl), cl->record_offset);
592 struct session_database *sdb = client_get_database(cl);
593 NMEM nmem = nmem_create();
597 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
598 if (nativesyntax_to_type(s, type, rec))
599 yaz_log(YLOG_WARN, "Failed to determine record type");
600 xmlrec = ZOOM_record_get(rec, type, NULL);
602 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
606 /* OK = 0, -1 = failure, -2 = Filtered */
607 int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem);
609 yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
618 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
623 void client_record_response(struct client *cl)
625 struct connection *co = cl->connection;
626 ZOOM_connection link = connection_get_link(co);
627 ZOOM_resultset resultset = cl->resultset;
628 const char *error, *addinfo;
630 if (ZOOM_connection_error(link, &error, &addinfo))
632 client_set_state(cl, Client_Error);
633 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
634 error, addinfo, client_get_id(cl));
638 if (cl->show_raw && cl->show_raw->active)
641 if ((rec = ZOOM_resultset_record_immediate(
642 resultset, cl->show_raw->position-1)))
644 cl->show_raw->active = 0;
645 ingest_raw_record(cl, rec);
649 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
650 cl->show_raw->position-1);
655 client_record_ingest(cl);
660 void client_reingest(struct client *cl)
662 int i = cl->startrecs;
663 int to = cl->record_offset;
666 cl->record_offset = i;
668 client_record_ingest(cl);
671 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
673 struct session_database *sdb = client_get_database(cl);
675 WRBUF w = wrbuf_alloc();
679 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
681 const char *p = strchr(s->name + 3, ':');
684 yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
686 else if (s->value && s->value[0])
688 wrbuf_puts(w, "@attr 1=");
689 yaz_encode_pqf_term(w, s->value, strlen(s->value));
694 yaz_log(YLOG_LOG, "using facets str: %s", wrbuf_cstr(w));
695 ZOOM_connection_option_set(link, "facets",
696 wrbuf_len(w) ? wrbuf_cstr(w) : 0);
700 int client_has_facet(struct client *cl, const char *name)
702 struct session_database *sdb = client_get_database(cl);
705 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
707 const char *p = strchr(s->name + 3, ':');
708 if (p && !strcmp(name, p + 1))
714 static const char *get_strategy_plus_sort(struct client *l, const char *field)
716 struct session_database *sdb = client_get_database(l);
719 const char *strategy_plus_sort = 0;
721 for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
723 char *p = strchr(s->name + 3, ':');
726 yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
730 if (!strcmp(p, field))
732 strategy_plus_sort = s->value;
736 return strategy_plus_sort;
739 void client_start_search(struct client *cl)
741 struct session_database *sdb = client_get_database(cl);
742 struct connection *co = client_get_connection(cl);
743 ZOOM_connection link = connection_get_link(co);
744 struct session *se = client_get_session(cl);
746 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
747 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
748 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
749 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
750 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
751 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
752 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
753 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
754 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
755 const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
757 char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
758 int present_chunk = 20; // Default chunk size
759 if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
760 present_chunk = atoi(opt_present_chunk);
761 yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
768 if (extra_args && *extra_args)
769 ZOOM_connection_option_set(link, "extraArgs", extra_args);
772 cl->preferred = atoi(opt_preferred);
774 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
775 client_get_id(cl), cl->preferred);
779 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
781 ZOOM_connection_option_set(link, "piggyback", "1");
783 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
784 if (*opt_sru && *opt_elements)
785 ZOOM_connection_option_set(link, "schema", opt_elements);
786 else if (*opt_elements)
787 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
789 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
791 if (opt_maxrecs && *opt_maxrecs)
793 cl->maxrecs = atoi(opt_maxrecs);
796 /* convert back to string representation used in ZOOM API */
797 sprintf(maxrecs_str, "%d", cl->maxrecs);
798 ZOOM_connection_option_set(link, "count", maxrecs_str);
800 /* A present_chunk less than 1 will disable chunking. */
801 if (present_chunk > 0 && cl->maxrecs > present_chunk) {
802 sprintf(present_chunk_str, "%d", present_chunk);
803 ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
804 yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
807 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
808 yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
810 sprintf(startrecs_str, "%d", cl->startrecs);
811 ZOOM_connection_option_set(link, "start", startrecs_str);
813 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
814 /* facets definition is in PQF */
815 client_set_facets_request(cl, link);
817 q = ZOOM_query_create();
820 yaz_log(YLOG_LOG, "Search %s CQL: %s", client_get_id(cl),
822 ZOOM_query_cql(q, cl->cqlquery);
824 ZOOM_query_sortby(q, opt_sort);
828 yaz_log(YLOG_LOG, "Search %s PQF: %s", client_get_id(cl), cl->pquery);
830 ZOOM_query_prefix(q, cl->pquery);
832 if (se->sorted_results)
833 { /* first entry is current sorting ! */
834 const char *sort_strategy_and_spec =
835 get_strategy_plus_sort(cl, se->sorted_results->field);
836 int increasing = se->sorted_results->increasing;
837 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
840 strcpy(spec, sort_strategy_and_spec);
841 p = strchr(spec, ':');
844 *p++ = '\0'; /* cut the string in two */
851 yaz_log(YLOG_LOG, "applying %s %s", spec, p);
852 ZOOM_query_sortby2(q, spec, p);
857 /* no native sorting.. If this is not the first search, then
859 if (se->sorted_results->next)
861 ZOOM_query_destroy(q);
866 client_set_state(cl, Client_Working);
868 cl->record_offset = 0;
869 rs = ZOOM_connection_search(link, q);
870 ZOOM_query_destroy(q);
871 ZOOM_resultset_destroy(cl->resultset);
873 connection_continue(co);
876 struct client *client_create(const char *id)
878 struct client *cl = xmalloc(sizeof(*cl));
888 cl->record_offset = 0;
891 cl->state = Client_Disconnected;
896 pazpar2_mutex_create(&cl->mutex, "client");
899 cl->facet_limits = 0;
901 cl->id = xstrdup(id);
907 void client_lock(struct client *c)
909 yaz_mutex_enter(c->mutex);
912 void client_unlock(struct client *c)
914 yaz_mutex_leave(c->mutex);
917 void client_incref(struct client *c)
919 pazpar2_incref(&c->ref_count, c->mutex);
920 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
921 c, client_get_id(c), c->ref_count);
924 int client_destroy(struct client *c)
928 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
929 c, client_get_id(c), c->ref_count);
930 if (!pazpar2_decref(&c->ref_count, c->mutex))
939 assert(!c->connection);
940 facet_limits_destroy(c->facet_limits);
944 ZOOM_resultset_destroy(c->resultset);
946 yaz_mutex_destroy(&c->mutex);
955 void client_set_connection(struct client *cl, struct connection *con)
958 ZOOM_resultset_release(cl->resultset);
961 assert(cl->connection == 0);
962 cl->connection = con;
967 cl->connection = con;
972 void client_disconnect(struct client *cl)
974 if (cl->state != Client_Idle)
975 client_set_state(cl, Client_Disconnected);
976 client_set_connection(cl, 0);
980 // Initialize CCL map for a target
981 static CCL_bibset prepare_cclmap(struct client *cl)
983 struct session_database *sdb = client_get_database(cl);
990 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
992 char *p = strchr(s->name + 3, ':');
995 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
1000 ccl_qual_fitem(res, s->value, p);
1005 // returns a xmalloced CQL query corresponding to the pquery in client
1006 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1008 cql_transform_t cqlt = cql_transform_create();
1010 WRBUF wrb = wrbuf_alloc();
1013 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1015 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1019 r = xstrdup(wrbuf_cstr(wrb));
1022 cql_transform_close(cqlt);
1026 // returns a xmalloced SOLR query corresponding to the pquery in client
1027 // TODO Could prob. be merge with the similar make_cqlquery
1028 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1030 solr_transform_t sqlt = solr_transform_create();
1032 WRBUF wrb = wrbuf_alloc();
1035 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1037 yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1041 r = xstrdup(wrbuf_cstr(wrb));
1044 solr_transform_close(sqlt);
1048 const char *client_get_facet_limit_local(struct client *cl,
1049 struct session_database *sdb,
1051 NMEM nmem, int *num, char ***values)
1053 const char *name = 0;
1054 const char *value = 0;
1055 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1057 struct setting *s = 0;
1059 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1061 const char *p = strchr(s->name + 3, ':');
1062 if (p && !strcmp(p + 1, name) && s->value &&
1063 !strncmp(s->value, "local:", 6))
1065 const char *cp = s->value + 6;
1069 nmem_strsplit_escape2(nmem, "|", value, values,
1072 return *cp ? cp : name;
1079 static int apply_limit(struct session_database *sdb,
1080 facet_limits_t facet_limits,
1081 WRBUF w_pqf, WRBUF w_ccl)
1087 NMEM nmem_tmp = nmem_create();
1088 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1090 struct setting *s = 0;
1091 nmem_reset(nmem_tmp);
1092 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1094 const char *p = strchr(s->name + 3, ':');
1095 if (p && !strcmp(p + 1, name) && s->value)
1099 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1102 if (!strncmp(s->value, "rpn:", 4))
1104 const char *pqf = s->value + 4;
1106 wrbuf_puts(w_pqf, "@and ");
1107 wrbuf_puts(w_pqf, pqf);
1108 wrbuf_puts(w_pqf, " ");
1109 for (i = 0; i < num; i++)
1112 wrbuf_puts(w_pqf, "@or ");
1113 yaz_encode_pqf_term(w_pqf, values[i],
1117 else if (!strncmp(s->value, "ccl:", 4))
1119 const char *ccl = s->value + 4;
1121 wrbuf_puts(w_ccl, " and (");
1123 for (i = 0; i < num; i++)
1126 wrbuf_puts(w_ccl, " or ");
1127 wrbuf_puts(w_ccl, ccl);
1128 wrbuf_puts(w_ccl, "=\"");
1129 wrbuf_puts(w_ccl, values[i]);
1130 wrbuf_puts(w_ccl, "\"");
1132 wrbuf_puts(w_ccl, ")");
1135 else if (!strncmp(s->value, "local:", 6)) {
1140 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1141 sdb->database->id, s->value);
1142 ret = -1; /* bad limitmap */
1149 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1150 (sdb->database ? sdb->database->id : "<no id>"), name);
1153 nmem_destroy(nmem_tmp);
1157 // Parse the query given the settings specific to this client
1158 // return 0 if query is OK but different from before
1159 // return 1 if query is OK but same as before
1160 // return -1 on query error
1161 // return -2 on limit error
1162 int client_parse_query(struct client *cl, const char *query,
1163 facet_limits_t facet_limits,
1164 const char *startrecs, const char *maxrecs)
1166 struct session *se = client_get_session(cl);
1167 struct session_database *sdb = client_get_database(cl);
1168 struct ccl_rpn_node *cn;
1171 CCL_bibset ccl_map = prepare_cclmap(cl);
1172 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1173 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1174 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1175 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1183 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
1186 cl->maxrecs = atoi(maxrecs);
1189 if (startrecs && atoi(startrecs) != cl->startrecs)
1192 cl->startrecs = atoi(startrecs);
1195 w_ccl = wrbuf_alloc();
1196 wrbuf_puts(w_ccl, query);
1198 w_pqf = wrbuf_alloc();
1201 wrbuf_puts(w_pqf, pqf_prefix);
1202 wrbuf_puts(w_pqf, " ");
1205 if (apply_limit(sdb, facet_limits, w_pqf, w_ccl))
1208 facet_limits_destroy(cl->facet_limits);
1209 cl->facet_limits = facet_limits_dup(facet_limits);
1211 yaz_log(YLOG_LOG, "CCL query: %s", wrbuf_cstr(w_ccl));
1212 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1213 ccl_qual_rm(&ccl_map);
1216 client_set_state(cl, Client_Error);
1217 session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s",
1220 wrbuf_destroy(w_ccl);
1221 wrbuf_destroy(w_pqf);
1224 wrbuf_destroy(w_ccl);
1226 if (!pqf_strftime || !*pqf_strftime)
1227 ccl_pquery(w_pqf, cn);
1230 time_t cur_time = time(0);
1231 struct tm *tm = localtime(&cur_time);
1233 const char *cp = tmp_str;
1235 /* see man strftime(3) for things .. In particular %% gets converted
1236 to %.. And That's our original query .. */
1237 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1241 ccl_pquery(w_pqf, cn);
1243 wrbuf_putc(w_pqf, cp[0]);
1247 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1250 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1253 wrbuf_destroy(w_pqf);
1255 xfree(cl->cqlquery);
1258 odr_out = odr_createmem(ODR_ENCODE);
1259 zquery = p_query_rpn(odr_out, cl->pquery);
1263 session_log(se, YLOG_WARN, "Invalid PQF query for %s: %s",
1264 client_get_id(cl), cl->pquery);
1269 session_log(se, YLOG_LOG, "PQF for %s: %s",
1270 client_get_id(cl), cl->pquery);
1272 /* Support for PQF on SRU targets. */
1273 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1275 if (!strcmp(sru, "solr"))
1276 cl->cqlquery = make_solrquery(cl, zquery);
1278 cl->cqlquery = make_cqlquery(cl, zquery);
1283 odr_destroy(odr_out);
1285 /* TODO FIX Not thread safe */
1288 // Initialize relevance structure with query terms
1289 se->relevance = relevance_create_ccl(se->service->charsets, cn);
1295 void client_set_session(struct client *cl, struct session *se)
1300 int client_is_active(struct client *cl)
1302 if (cl->connection && (cl->state == Client_Connecting ||
1303 cl->state == Client_Working))
1308 int client_is_active_preferred(struct client *cl)
1310 /* only count if this is a preferred target. */
1313 /* TODO No sure this the condition that Seb wants */
1314 if (cl->connection && (cl->state == Client_Connecting ||
1315 cl->state == Client_Working))
1320 Odr_int client_get_hits(struct client *cl)
1325 Odr_int client_get_approximation(struct client *cl)
1327 if (cl->record_offset > 0) {
1328 Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered)) / cl->record_offset + 5) /10;
1329 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);
1335 int client_get_num_records(struct client *cl)
1337 return cl->record_offset;
1340 int client_get_num_records_filtered(struct client *cl)
1342 return cl->filtered;
1345 void client_set_diagnostic(struct client *cl, int diagnostic,
1346 const char *addinfo)
1348 cl->diagnostic = diagnostic;
1352 cl->addinfo = xstrdup(addinfo);
1355 int client_get_diagnostic(struct client *cl, const char **addinfo)
1358 *addinfo = cl->addinfo;
1359 return cl->diagnostic;
1362 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1365 struct suggestions *suggestions = cl->suggestions;
1368 //yaz_log(YLOG_DEBUG, "No suggestions found");
1371 if (suggestions->passthrough) {
1372 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1373 return suggestions->passthrough;
1375 if (suggestions->num == 0) {
1379 for (idx = 0; idx < suggestions->num; idx++) {
1380 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1381 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1382 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1383 wrbuf_puts(wrbuf, "</suggest>\n");
1386 wrbuf_puts(wrbuf, "/>\n");
1389 return wrbuf_cstr(wrbuf);
1393 void client_set_database(struct client *cl, struct session_database *db)
1398 const char *client_get_id(struct client *cl)
1403 int client_get_maxrecs(struct client *cl)
1408 void client_set_preferred(struct client *cl, int v)
1414 struct suggestions* client_suggestions_create(const char* suggestions_string)
1418 struct suggestions *suggestions;
1419 if (suggestions_string == 0)
1421 nmem = nmem_create();
1422 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1423 yaz_log(YLOG_DEBUG, "client target suggestions: %s", suggestions_string);
1425 suggestions->nmem = nmem;
1426 suggestions->num = 0;
1427 suggestions->misspelled = 0;
1428 suggestions->suggest = 0;
1429 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1431 if (suggestions_string)
1432 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1433 &suggestions->num, 1, '\\', 0);
1434 /* Set up misspelled array */
1435 suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1436 /* replace = with \0 .. for each item */
1437 for (i = 0; i < suggestions->num; i++)
1439 char *cp = strchr(suggestions->suggest[i], '=');
1442 suggestions->misspelled[i] = cp+1;
1448 static void client_suggestions_destroy(struct client *cl)
1450 NMEM nmem = cl->suggestions->nmem;
1451 cl->suggestions = 0;
1458 * c-file-style: "Stroustrup"
1459 * indent-tabs-mode: nil
1461 * vim: shiftwidth=4 tabstop=8 expandtab