1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2011 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
118 struct suggestions *suggestions;
119 enum client_state state;
120 struct show_raw *show_raw;
121 ZOOM_resultset resultset;
125 facet_limits_t facet_limits;
137 int active; // whether this request has been sent to the server
143 void (*error_handler)(void *data, const char *addinfo);
144 void (*record_handler)(void *data, const char *buf, size_t sz);
146 struct show_raw *next;
149 static const char *client_states[] = {
155 "Client_Disconnected"
158 const char *client_get_state_str(struct client *cl)
160 return client_states[cl->state];
163 enum client_state client_get_state(struct client *cl)
168 void client_set_state_nb(struct client *cl, enum client_state st)
173 void client_set_state(struct client *cl, enum client_state st)
176 if (client_is_active(cl))
179 /* If client is going from being active to inactive and all clients
180 are now idle we fire a watch for the session . The assumption is
181 that session is not mutex locked if client is already active */
182 if (was_active && !client_is_active(cl) && cl->session)
185 int no_active = session_active_clients(cl->session);
186 yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
187 client_get_id(cl), no_active);
188 if (no_active == 0) {
189 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
190 session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
191 session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
192 session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
197 static void client_show_raw_error(struct client *cl, const char *addinfo);
199 struct connection *client_get_connection(struct client *cl)
201 return cl->connection;
204 struct session_database *client_get_database(struct client *cl)
209 struct session *client_get_session(struct client *cl)
214 const char *client_get_pquery(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(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 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, "xml", 3))
418 else if (!strncmp(s, "txml", 4))
420 const char *cp = strchr(s, ';');
421 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
427 else /* attempt to deduce structure */
429 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
432 if (!strcmp(syntax, "XML"))
437 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
439 strcpy(type, "xml; charset=marc8-s");
449 * TODO Consider thread safety!!!
452 void client_report_facets(struct client *cl, ZOOM_resultset rs)
454 struct session_database *sdb = client_get_database(cl);
455 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
459 struct session *se = client_get_session(cl);
460 int facet_num = ZOOM_resultset_facets_size(rs);
463 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
465 const char *p = strchr(s->name + 3, ':');
466 if (p && p[1] && s->value && s->value[0])
469 p++; /* p now holds logical facet name */
470 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
472 const char *native_name =
473 ZOOM_facet_field_name(facets[facet_idx]);
474 if (native_name && !strcmp(s->value, native_name))
478 ZOOM_facet_field_term_count(facets[facet_idx]);
479 for (term_idx = 0; term_idx < term_num; term_idx++ )
483 ZOOM_facet_field_get_term(facets[facet_idx],
486 add_facet(se, p, term, freq);
496 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
502 nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
503 buf = ZOOM_record_get(rec, type, &len);
504 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
505 client_show_raw_dequeue(cl);
508 void client_check_preferred_watch(struct client *cl)
510 struct session *se = cl->session;
511 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl));
515 /* TODO possible threading issue. Session can have been destroyed */
516 if (session_is_preferred_clients_ready(se)) {
517 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
520 yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets.");
525 yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl));
529 struct suggestions* client_suggestions_create(const char* suggestions_string);
530 static void client_suggestions_destroy(struct client *cl);
532 void client_search_response(struct client *cl)
534 struct connection *co = cl->connection;
535 ZOOM_connection link = connection_get_link(co);
536 ZOOM_resultset resultset = cl->resultset;
538 const char *error, *addinfo = 0;
540 if (ZOOM_connection_error(link, &error, &addinfo))
543 client_set_state(cl, Client_Error);
544 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
545 error, addinfo, client_get_id(cl));
549 yaz_log(YLOG_DEBUG, "client_search_response: hits "
550 ODR_INT_PRINTF, cl->hits);
551 client_report_facets(cl, resultset);
552 cl->record_offset = cl->startrecs;
553 cl->hits = ZOOM_resultset_size(resultset);
555 client_suggestions_destroy(cl);
556 cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
560 void client_got_records(struct client *cl)
562 struct session *se = cl->session;
565 if (reclist_get_num_records(se->reclist) > 0)
568 session_alert_watch(se, SESSION_WATCH_SHOW);
569 session_alert_watch(se, SESSION_WATCH_BYTARGET);
570 session_alert_watch(se, SESSION_WATCH_TERMLIST);
571 session_alert_watch(se, SESSION_WATCH_RECORD);
577 static void client_record_ingest(struct client *cl)
579 const char *msg, *addinfo;
581 ZOOM_resultset resultset = cl->resultset;
582 int offset = cl->record_offset;
583 if ((rec = ZOOM_resultset_record(resultset, offset)))
586 if (cl->session == 0)
588 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
590 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
591 msg, addinfo, client_get_id(cl),
596 struct session_database *sdb = client_get_database(cl);
597 NMEM nmem = nmem_create();
601 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
602 if (nativesyntax_to_type(s, type, rec))
603 yaz_log(YLOG_WARN, "Failed to determine record type");
604 xmlrec = ZOOM_record_get(rec, type, NULL);
606 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
610 /* OK = 0, -1 = failure, -2 = Filtered */
611 if (ingest_record(cl, xmlrec, cl->record_offset, nmem) == -1)
612 yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
619 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
624 void client_record_response(struct client *cl)
626 struct connection *co = cl->connection;
627 ZOOM_connection link = connection_get_link(co);
628 ZOOM_resultset resultset = cl->resultset;
629 const char *error, *addinfo;
631 if (ZOOM_connection_error(link, &error, &addinfo))
633 client_set_state(cl, Client_Error);
634 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
635 error, addinfo, client_get_id(cl));
639 if (cl->show_raw && cl->show_raw->active)
642 if ((rec = ZOOM_resultset_record(resultset,
643 cl->show_raw->position-1)))
645 cl->show_raw->active = 0;
646 ingest_raw_record(cl, rec);
650 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
651 cl->show_raw->position-1);
656 client_record_ingest(cl);
661 void client_reingest(struct client *cl)
663 int i = cl->startrecs;
664 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 char maxrecs_str[24], startrecs_str[24];
762 if (extra_args && *extra_args)
763 ZOOM_connection_option_set(link, "extraArgs", extra_args);
766 cl->preferred = atoi(opt_preferred);
768 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
769 client_get_id(cl), cl->preferred);
771 client_set_state(cl, Client_Working);
774 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
776 ZOOM_connection_option_set(link, "piggyback", "1");
778 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
779 if (*opt_sru && *opt_elements)
780 ZOOM_connection_option_set(link, "schema", opt_elements);
781 else if (*opt_elements)
782 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
784 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
786 if (opt_maxrecs && *opt_maxrecs)
788 cl->maxrecs = atoi(opt_maxrecs);
791 /* convert back to string representation used in ZOOM API */
792 sprintf(maxrecs_str, "%d", cl->maxrecs);
793 ZOOM_connection_option_set(link, "count", maxrecs_str);
795 if (cl->maxrecs > 20)
796 ZOOM_connection_option_set(link, "presentChunk", "20");
798 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
800 sprintf(startrecs_str, "%d", cl->startrecs);
801 ZOOM_connection_option_set(link, "start", startrecs_str);
803 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
804 /* facets definition is in PQF */
805 client_set_facets_request(cl, link);
807 q = ZOOM_query_create();
810 yaz_log(YLOG_LOG, "Search %s CQL: %s", client_get_id(cl),
812 ZOOM_query_cql(q, cl->cqlquery);
814 ZOOM_query_sortby(q, opt_sort);
818 yaz_log(YLOG_LOG, "Search %s PQF: %s", client_get_id(cl), cl->pquery);
820 ZOOM_query_prefix(q, cl->pquery);
822 if (se->sorted_results)
823 { /* first entry is current sorting ! */
824 const char *sort_strategy_and_spec =
825 get_strategy_plus_sort(cl, se->sorted_results->field);
826 int increasing = se->sorted_results->increasing;
827 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
830 strcpy(spec, sort_strategy_and_spec);
831 p = strchr(spec, ':');
834 *p++ = '\0'; /* cut the string in two */
841 yaz_log(YLOG_LOG, "applying %s %s", spec, p);
842 ZOOM_query_sortby2(q, spec, p);
847 /* no native sorting.. If this is not the first search, then
849 if (se->sorted_results->next)
851 ZOOM_query_destroy(q);
852 client_set_state_nb(cl, Client_Idle);
858 cl->record_offset = 0;
859 rs = ZOOM_connection_search(link, q);
860 ZOOM_query_destroy(q);
861 ZOOM_resultset_destroy(cl->resultset);
863 connection_continue(co);
866 struct client *client_create(const char *id)
868 struct client *cl = xmalloc(sizeof(*cl));
878 cl->record_offset = 0;
880 cl->state = Client_Disconnected;
885 pazpar2_mutex_create(&cl->mutex, "client");
888 cl->facet_limits = 0;
890 cl->id = xstrdup(id);
896 void client_lock(struct client *c)
898 yaz_mutex_enter(c->mutex);
901 void client_unlock(struct client *c)
903 yaz_mutex_leave(c->mutex);
906 void client_incref(struct client *c)
908 pazpar2_incref(&c->ref_count, c->mutex);
909 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
910 c, client_get_id(c), c->ref_count);
913 int client_destroy(struct client *c)
917 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
918 c, client_get_id(c), c->ref_count);
919 if (!pazpar2_decref(&c->ref_count, c->mutex))
928 assert(!c->connection);
929 facet_limits_destroy(c->facet_limits);
933 ZOOM_resultset_destroy(c->resultset);
935 yaz_mutex_destroy(&c->mutex);
944 void client_set_connection(struct client *cl, struct connection *con)
947 ZOOM_resultset_release(cl->resultset);
950 assert(cl->connection == 0);
951 cl->connection = con;
956 cl->connection = con;
961 void client_disconnect(struct client *cl)
963 if (cl->state != Client_Idle)
964 client_set_state(cl, Client_Disconnected);
965 client_set_connection(cl, 0);
969 // Initialize CCL map for a target
970 static CCL_bibset prepare_cclmap(struct client *cl)
972 struct session_database *sdb = client_get_database(cl);
979 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
981 char *p = strchr(s->name + 3, ':');
984 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
989 ccl_qual_fitem(res, s->value, p);
994 // returns a xmalloced CQL query corresponding to the pquery in client
995 static char *make_cqlquery(struct client *cl)
997 cql_transform_t cqlt = cql_transform_create();
1000 WRBUF wrb = wrbuf_alloc();
1002 ODR odr_out = odr_createmem(ODR_ENCODE);
1004 zquery = p_query_rpn(odr_out, cl->pquery);
1005 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
1006 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1008 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1013 r = xstrdup(wrbuf_cstr(wrb));
1016 odr_destroy(odr_out);
1017 cql_transform_close(cqlt);
1021 // returns a xmalloced SOLR query corresponding to the pquery in client
1022 // TODO Could prob. be merge with the similar make_cqlquery
1023 static char *make_solrquery(struct client *cl)
1025 solr_transform_t sqlt = solr_transform_create();
1028 WRBUF wrb = wrbuf_alloc();
1030 ODR odr_out = odr_createmem(ODR_ENCODE);
1032 zquery = p_query_rpn(odr_out, cl->pquery);
1034 yaz_log(YLOG_WARN, "Failed to generate RPN from PQF: %s", cl->pquery);
1037 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
1038 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1040 yaz_log(YLOG_WARN, "Failed to generate SOLR query from PQF %s, code=%d", cl->pquery, status);
1045 r = xstrdup(wrbuf_cstr(wrb));
1048 odr_destroy(odr_out);
1049 solr_transform_close(sqlt);
1053 const char *client_get_facet_limit_local(struct client *cl,
1054 struct session_database *sdb,
1056 NMEM nmem, int *num, char ***values)
1058 const char *name = 0;
1059 const char *value = 0;
1060 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1062 struct setting *s = 0;
1064 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1066 const char *p = strchr(s->name + 3, ':');
1067 if (p && !strcmp(p + 1, name) && s->value &&
1068 !strncmp(s->value, "local:", 6))
1070 nmem_strsplit_escape2(nmem, "|", value, values,
1080 static int apply_limit(struct session_database *sdb,
1081 facet_limits_t facet_limits,
1082 WRBUF w_pqf, WRBUF w_ccl)
1088 NMEM nmem_tmp = nmem_create();
1089 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1091 struct setting *s = 0;
1093 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1095 const char *p = strchr(s->name + 3, ':');
1096 if (p && !strcmp(p + 1, name) && s->value)
1100 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1103 if (!strncmp(s->value, "rpn:", 4))
1105 const char *pqf = s->value + 4;
1107 wrbuf_puts(w_pqf, "@and ");
1108 wrbuf_puts(w_pqf, pqf);
1109 wrbuf_puts(w_pqf, " ");
1110 for (i = 0; i < num; i++)
1113 wrbuf_puts(w_pqf, "@or ");
1114 yaz_encode_pqf_term(w_pqf, values[i],
1118 else if (!strncmp(s->value, "ccl:", 4))
1120 const char *ccl = s->value + 4;
1122 wrbuf_puts(w_ccl, " and (");
1124 for (i = 0; i < num; i++)
1127 wrbuf_puts(w_ccl, " or ");
1128 wrbuf_puts(w_ccl, ccl);
1129 wrbuf_puts(w_ccl, "=\"");
1130 wrbuf_puts(w_ccl, values[i]);
1131 wrbuf_puts(w_ccl, "\"");
1133 wrbuf_puts(w_ccl, ")");
1136 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 */
1147 nmem_reset(nmem_tmp);
1150 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1151 (sdb->database ? sdb->database->id : "<no id>"), name);
1154 nmem_destroy(nmem_tmp);
1158 // Parse the query given the settings specific to this client
1159 int client_parse_query(struct client *cl, const char *query,
1160 facet_limits_t facet_limits,
1161 const char *startrecs, const char *maxrecs)
1163 struct session *se = client_get_session(cl);
1164 struct session_database *sdb = client_get_database(cl);
1165 struct ccl_rpn_node *cn;
1167 CCL_bibset ccl_map = prepare_cclmap(cl);
1168 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1169 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1170 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1171 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1179 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
1182 cl->maxrecs = atoi(maxrecs);
1185 if (startrecs && atoi(startrecs) != cl->startrecs)
1188 cl->startrecs = atoi(startrecs);
1191 w_ccl = wrbuf_alloc();
1192 wrbuf_puts(w_ccl, query);
1194 w_pqf = wrbuf_alloc();
1197 wrbuf_puts(w_pqf, pqf_prefix);
1198 wrbuf_puts(w_pqf, " ");
1201 if (apply_limit(sdb, facet_limits, w_pqf, w_ccl))
1204 facet_limits_destroy(cl->facet_limits);
1205 cl->facet_limits = facet_limits_dup(facet_limits);
1207 yaz_log(YLOG_LOG, "CCL query: %s", wrbuf_cstr(w_ccl));
1208 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1209 ccl_qual_rm(&ccl_map);
1212 client_set_state(cl, Client_Error);
1213 session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s",
1216 wrbuf_destroy(w_ccl);
1217 wrbuf_destroy(w_pqf);
1220 wrbuf_destroy(w_ccl);
1222 if (!pqf_strftime || !*pqf_strftime)
1223 ccl_pquery(w_pqf, cn);
1226 time_t cur_time = time(0);
1227 struct tm *tm = localtime(&cur_time);
1229 const char *cp = tmp_str;
1231 /* see man strftime(3) for things .. In particular %% gets converted
1232 to %.. And That's our original query .. */
1233 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1237 ccl_pquery(w_pqf, cn);
1239 wrbuf_putc(w_pqf, cp[0]);
1242 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1245 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1248 wrbuf_destroy(w_pqf);
1250 yaz_log(YLOG_LOG, "PQF query: %s", cl->pquery);
1252 xfree(cl->cqlquery);
1254 /* Support for PQF on SRU targets. */
1256 yaz_log(YLOG_DEBUG, "Query syntax: %s", query_syntax);
1257 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1259 if (!strcmp(sru, "solr")) {
1260 if (!(cl->cqlquery = make_solrquery(cl)))
1264 if (!(cl->cqlquery = make_cqlquery(cl)))
1271 /* TODO FIX Not thread safe */
1274 // Initialize relevance structure with query terms
1275 se->relevance = relevance_create_ccl(
1276 se->service->charsets, se->nmem, cn);
1283 void client_set_session(struct client *cl, struct session *se)
1288 int client_is_active(struct client *cl)
1290 if (cl->connection && (cl->state == Client_Connecting ||
1291 cl->state == Client_Working))
1296 int client_is_active_preferred(struct client *cl)
1298 /* only count if this is a preferred target. */
1301 /* TODO No sure this the condition that Seb wants */
1302 if (cl->connection && (cl->state == Client_Connecting ||
1303 cl->state == Client_Working))
1308 Odr_int client_get_hits(struct client *cl)
1313 int client_get_num_records(struct client *cl)
1315 return cl->record_offset;
1318 void client_set_diagnostic(struct client *cl, int diagnostic,
1319 const char *addinfo)
1321 cl->diagnostic = diagnostic;
1325 cl->addinfo = xstrdup(addinfo);
1328 int client_get_diagnostic(struct client *cl, const char **addinfo)
1331 *addinfo = cl->addinfo;
1332 return cl->diagnostic;
1335 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1338 struct suggestions *suggestions = cl->suggestions;
1341 //yaz_log(YLOG_DEBUG, "No suggestions found");
1344 if (suggestions->passthrough) {
1345 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1346 return suggestions->passthrough;
1348 if (suggestions->num == 0) {
1352 for (idx = 0; idx < suggestions->num; idx++) {
1353 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1354 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1355 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1356 wrbuf_puts(wrbuf, "</suggest>\n");
1359 wrbuf_puts(wrbuf, "/>\n");
1362 return wrbuf_cstr(wrbuf);
1366 void client_set_database(struct client *cl, struct session_database *db)
1371 const char *client_get_id(struct client *cl)
1376 int client_get_maxrecs(struct client *cl)
1381 void client_set_preferred(struct client *cl, int v)
1387 struct suggestions* client_suggestions_create(const char* suggestions_string)
1391 struct suggestions *suggestions;
1392 if (suggestions_string == 0)
1394 nmem = nmem_create();
1395 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1396 yaz_log(YLOG_DEBUG, "client target suggestions: %s", suggestions_string);
1398 suggestions->nmem = nmem;
1399 suggestions->num = 0;
1400 suggestions->misspelled = 0;
1401 suggestions->suggest = 0;
1402 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1404 if (suggestions_string)
1405 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1406 &suggestions->num, 1, '\\', 0);
1407 /* Set up misspelled array */
1408 suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1409 /* replace = with \0 .. for each item */
1410 for (i = 0; i < suggestions->num; i++)
1412 char *cp = strchr(suggestions->suggest[i], '=');
1415 suggestions->misspelled[i] = cp+1;
1421 static void client_suggestions_destroy(struct client *cl)
1423 NMEM nmem = cl->suggestions->nmem;
1424 cl->suggestions = 0;
1431 * c-file-style: "Stroustrup"
1432 * indent-tabs-mode: nil
1434 * vim: shiftwidth=4 tabstop=8 expandtab