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>
55 #include <yaz/gettimeofday.h>
59 #include <yaz/timing.h>
64 #include "parameters.h"
66 #include "connection.h"
68 #include "relevance.h"
71 static YAZ_MUTEX g_mutex = 0;
72 static int no_clients = 0;
73 static int no_clients_total = 0;
75 static int client_use(int delta)
79 yaz_mutex_create(&g_mutex);
80 yaz_mutex_enter(g_mutex);
83 no_clients_total += delta;
85 yaz_mutex_leave(g_mutex);
86 yaz_log(YLOG_DEBUG, "%s clients=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
90 int clients_count(void) {
94 int clients_count_total(void) {
98 yaz_mutex_enter(g_mutex);
99 total = no_clients_total;
100 yaz_mutex_leave(g_mutex);
105 /** \brief Represents client state for a connection to one search target */
107 struct session_database *database;
108 struct connection *connection;
109 struct session *session;
110 char *pquery; // Current search
111 char *cqlquery; // used for SRU targets only
112 char *addinfo; // diagnostic info for most resent error
115 int filtered; // When using local:, this will count the number of filtered records.
120 struct suggestions *suggestions;
121 enum client_state state;
122 struct show_raw *show_raw;
123 ZOOM_resultset resultset;
127 facet_limits_t facet_limits;
141 int active; // whether this request has been sent to the server
147 void (*error_handler)(void *data, const char *addinfo);
148 void (*record_handler)(void *data, const char *buf, size_t sz);
150 struct show_raw *next;
153 static const char *client_states[] = {
159 "Client_Disconnected"
162 const char *client_get_state_str(struct client *cl)
164 return client_states[cl->state];
167 enum client_state client_get_state(struct client *cl)
172 void client_set_state_nb(struct client *cl, enum client_state st)
177 void client_set_state(struct client *cl, enum client_state st)
180 if (client_is_active(cl))
183 /* If client is going from being active to inactive and all clients
184 are now idle we fire a watch for the session . The assumption is
185 that session is not mutex locked if client is already active */
186 if (was_active && !client_is_active(cl) && cl->session)
189 int no_active = session_active_clients(cl->session);
190 yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
191 client_get_id(cl), no_active);
192 if (no_active == 0) {
193 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
194 session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
195 session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
196 session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
201 static void client_show_raw_error(struct client *cl, const char *addinfo);
203 struct connection *client_get_connection(struct client *cl)
205 return cl->connection;
208 struct session_database *client_get_database(struct client *cl)
213 struct session *client_get_session(struct client *cl)
218 const char *client_get_pquery(struct client *cl)
223 static void client_send_raw_present(struct client *cl);
224 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
226 static void client_show_immediate(
227 ZOOM_resultset resultset, struct session_database *sdb, int position,
229 void (*error_handler)(void *data, const char *addinfo),
230 void (*record_handler)(void *data, const char *buf, size_t sz),
232 const char *nativesyntax)
241 error_handler(data, "no resultset");
244 rec = ZOOM_resultset_record_immediate(resultset, position-1);
247 error_handler(data, "no record");
250 nativesyntax_to_type(nativesyntax, type, rec);
251 buf = ZOOM_record_get(rec, type, &len);
254 error_handler(data, "no record");
257 record_handler(data, buf, len);
261 int client_show_raw_begin(struct client *cl, int position,
262 const char *syntax, const char *esn,
264 void (*error_handler)(void *data, const char *addinfo),
265 void (*record_handler)(void *data, const char *buf,
268 const char *nativesyntax)
273 nativesyntax = "raw";
276 struct session_database *sdb = client_get_database(cl);
277 nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
281 if (syntax == 0 && esn == 0)
282 client_show_immediate(cl->resultset, client_get_database(cl),
284 error_handler, record_handler,
285 binary, nativesyntax);
288 struct show_raw *rr, **rrp;
294 rr = xmalloc(sizeof(*rr));
295 rr->position = position;
298 rr->error_handler = error_handler;
299 rr->record_handler = record_handler;
302 rr->syntax = xstrdup(syntax);
306 rr->esn = xstrdup(esn);
310 assert(nativesyntax);
311 rr->nativesyntax = xstrdup(nativesyntax);
315 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
319 if (cl->state == Client_Failed)
321 client_show_raw_error(cl, "client failed");
323 else if (cl->state == Client_Disconnected)
325 client_show_raw_error(cl, "client disconnected");
329 client_send_raw_present(cl);
335 static void client_show_raw_delete(struct show_raw *r)
339 xfree(r->nativesyntax);
343 void client_show_raw_remove(struct client *cl, void *data)
345 struct show_raw *rr = data;
346 struct show_raw **rrp = &cl->show_raw;
352 client_show_raw_delete(rr);
356 void client_show_raw_dequeue(struct client *cl)
358 struct show_raw *rr = cl->show_raw;
360 cl->show_raw = rr->next;
361 client_show_raw_delete(rr);
364 static void client_show_raw_error(struct client *cl, const char *addinfo)
368 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
369 client_show_raw_dequeue(cl);
373 static void client_send_raw_present(struct client *cl)
375 struct session_database *sdb = client_get_database(cl);
376 struct connection *co = client_get_connection(cl);
377 ZOOM_resultset set = cl->resultset;
379 int offset = cl->show_raw->position;
380 const char *syntax = 0;
381 const char *elements = 0;
383 assert(cl->show_raw);
386 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
387 client_get_id(cl), 1, offset);
389 if (cl->show_raw->syntax)
390 syntax = cl->show_raw->syntax;
392 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
393 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
395 if (cl->show_raw->esn)
396 elements = cl->show_raw->esn;
398 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
399 if (elements && *elements)
400 ZOOM_resultset_option_set(set, "elementSetName", elements);
402 ZOOM_resultset_records(set, 0, offset-1, 1);
403 cl->show_raw->active = 1;
405 connection_continue(co);
408 static int nativesyntax_to_type(const char *s, char *type,
413 if (!strncmp(s, "iso2709", 7))
415 const char *cp = strchr(s, ';');
416 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
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");
423 else /* pass verbatim to ZOOM - including "xml" */
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 client_report_facets(cl, resultset);
550 cl->record_offset = cl->startrecs;
551 cl->hits = ZOOM_resultset_size(resultset);
552 yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, cl->hits);
554 client_suggestions_destroy(cl);
555 cl->suggestions = client_suggestions_create(ZOOM_resultset_option_get(resultset, "suggestions"));
559 void client_got_records(struct client *cl)
561 struct session *se = cl->session;
564 if (reclist_get_num_records(se->reclist) > 0)
567 session_alert_watch(se, SESSION_WATCH_SHOW);
568 session_alert_watch(se, SESSION_WATCH_BYTARGET);
569 session_alert_watch(se, SESSION_WATCH_TERMLIST);
570 session_alert_watch(se, SESSION_WATCH_RECORD);
576 static void client_record_ingest(struct client *cl)
578 const char *msg, *addinfo;
580 ZOOM_resultset resultset = cl->resultset;
581 int offset = cl->record_offset;
582 if ((rec = ZOOM_resultset_record_immediate(resultset, offset)))
585 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), cl->record_offset);
595 struct session_database *sdb = client_get_database(cl);
596 NMEM nmem = nmem_create();
600 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
601 if (nativesyntax_to_type(s, type, rec))
602 yaz_log(YLOG_WARN, "Failed to determine record type");
603 xmlrec = ZOOM_record_get(rec, type, NULL);
605 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
609 /* OK = 0, -1 = failure, -2 = Filtered */
610 int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem);
612 yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl));
621 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d", offset);
625 void client_record_response(struct client *cl)
627 struct connection *co = cl->connection;
628 ZOOM_connection link = connection_get_link(co);
629 ZOOM_resultset resultset = cl->resultset;
630 const char *error, *addinfo;
632 if (ZOOM_connection_error(link, &error, &addinfo))
634 client_set_state(cl, Client_Error);
635 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
636 error, addinfo, client_get_id(cl));
640 if (cl->show_raw && cl->show_raw->active)
643 if ((rec = ZOOM_resultset_record_immediate(
644 resultset, cl->show_raw->position-1)))
646 cl->show_raw->active = 0;
647 ingest_raw_record(cl, rec);
651 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
652 cl->show_raw->position-1);
657 client_record_ingest(cl);
662 int client_reingest(struct client *cl)
664 int i = cl->startrecs;
665 int to = cl->record_offset;
668 cl->record_offset = i;
670 client_record_ingest(cl);
674 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
676 struct session_database *sdb = client_get_database(cl);
678 WRBUF w = wrbuf_alloc();
682 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
684 const char *p = strchr(s->name + 3, ':');
687 yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
689 else if (s->value && s->value[0])
691 wrbuf_puts(w, "@attr 1=");
692 yaz_encode_pqf_term(w, s->value, strlen(s->value));
697 yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
698 ZOOM_connection_option_set(link, "facets",
699 wrbuf_len(w) ? wrbuf_cstr(w) : 0);
703 int client_has_facet(struct client *cl, const char *name)
705 struct session_database *sdb = client_get_database(cl);
708 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
710 const char *p = strchr(s->name + 3, ':');
711 if (p && !strcmp(name, p + 1))
717 static const char *get_strategy_plus_sort(struct client *l, const char *field)
719 struct session_database *sdb = client_get_database(l);
722 const char *strategy_plus_sort = 0;
724 for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
726 char *p = strchr(s->name + 3, ':');
729 yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
733 if (!strcmp(p, field))
735 strategy_plus_sort = s->value;
739 return strategy_plus_sort;
742 int client_parse_init(struct client *cl, int same_search)
744 cl->same_search = same_search;
748 int client_parse_range(struct client *cl, const char *startrecs, const char *maxrecs)
750 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
753 cl->maxrecs = atoi(maxrecs);
756 if (startrecs && atoi(startrecs) != cl->startrecs)
759 cl->startrecs = atoi(startrecs);
764 int client_start_search(struct client *cl)
766 struct session_database *sdb = client_get_database(cl);
767 struct connection *co = client_get_connection(cl);
768 ZOOM_connection link = connection_get_link(co);
769 struct session *se = client_get_session(cl);
771 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
772 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
773 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
774 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
775 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
776 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
777 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
778 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
779 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
780 const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
782 char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
784 int present_chunk = 20; // Default chunk size
785 int rc_prep_connection;
788 yaz_gettimeofday(&tval);
791 if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
792 present_chunk = atoi(opt_present_chunk);
793 yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
797 client_prep_connection(cl, se->service->z3950_operation_timeout,
798 se->service->z3950_session_timeout,
799 se->service->server->iochan_man,
801 /* Nothing has changed and we already have a result */
802 if (cl->same_search == 1 && rc_prep_connection == 2)
804 session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
805 return client_reingest(cl);
807 else if (!rc_prep_connection)
809 session_log(se, YLOG_LOG, "client %s FAILED to search: No connection.", client_get_id(cl));
812 session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
817 if (extra_args && *extra_args)
818 ZOOM_connection_option_set(link, "extraArgs", extra_args);
821 cl->preferred = atoi(opt_preferred);
823 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
824 client_get_id(cl), cl->preferred);
828 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
830 ZOOM_connection_option_set(link, "piggyback", "1");
832 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
833 if (*opt_sru && *opt_elements)
834 ZOOM_connection_option_set(link, "schema", opt_elements);
835 else if (*opt_elements)
836 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
838 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
840 if (opt_maxrecs && *opt_maxrecs)
842 cl->maxrecs = atoi(opt_maxrecs);
845 /* convert back to string representation used in ZOOM API */
846 sprintf(maxrecs_str, "%d", cl->maxrecs);
847 ZOOM_connection_option_set(link, "count", maxrecs_str);
849 /* A present_chunk less than 1 will disable chunking. */
850 if (present_chunk > 0 && cl->maxrecs > present_chunk) {
851 sprintf(present_chunk_str, "%d", present_chunk);
852 ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
853 yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
856 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
857 yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
859 sprintf(startrecs_str, "%d", cl->startrecs);
860 ZOOM_connection_option_set(link, "start", startrecs_str);
862 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
863 /* facets definition is in PQF */
864 client_set_facets_request(cl, link);
866 query = ZOOM_query_create();
869 yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl), cl->cqlquery);
870 ZOOM_query_cql(query, cl->cqlquery);
872 ZOOM_query_sortby(query, opt_sort);
876 yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), cl->pquery);
878 ZOOM_query_prefix(query, cl->pquery);
880 // TODO check for re-ingest / re-search
882 yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
883 client_set_state(cl, Client_Working);
885 cl->record_offset = 0;
886 rs = ZOOM_connection_search(link, query);
887 ZOOM_query_destroy(query);
888 ZOOM_resultset_destroy(cl->resultset);
890 connection_continue(co);
894 struct client *client_create(const char *id)
896 struct client *cl = xmalloc(sizeof(*cl));
906 cl->record_offset = 0;
909 cl->state = Client_Disconnected;
914 pazpar2_mutex_create(&cl->mutex, "client");
917 cl->facet_limits = 0;
919 cl->id = xstrdup(id);
925 void client_lock(struct client *c)
927 yaz_mutex_enter(c->mutex);
930 void client_unlock(struct client *c)
932 yaz_mutex_leave(c->mutex);
935 void client_incref(struct client *c)
937 pazpar2_incref(&c->ref_count, c->mutex);
938 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
939 c, client_get_id(c), c->ref_count);
942 int client_destroy(struct client *c)
946 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
947 c, client_get_id(c), c->ref_count);
948 if (!pazpar2_decref(&c->ref_count, c->mutex))
957 assert(!c->connection);
958 facet_limits_destroy(c->facet_limits);
962 ZOOM_resultset_destroy(c->resultset);
964 yaz_mutex_destroy(&c->mutex);
973 void client_set_connection(struct client *cl, struct connection *con)
976 ZOOM_resultset_release(cl->resultset);
979 assert(cl->connection == 0);
980 cl->connection = con;
985 cl->connection = con;
990 void client_disconnect(struct client *cl)
992 if (cl->state != Client_Idle)
993 client_set_state(cl, Client_Disconnected);
994 client_set_connection(cl, 0);
998 // Initialize CCL map for a target
999 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1001 struct session_database *sdb = client_get_database(cl);
1008 res = ccl_qual_dup(base_bibset);
1010 res = ccl_qual_mk();
1011 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1013 const char *addinfo = 0;
1014 char *p = strchr(s->name + 3, ':');
1017 WRBUF w = wrbuf_alloc();
1018 wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1019 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1020 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG, wrbuf_cstr(w));
1021 client_set_state_nb(cl, Client_Error);
1027 if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1029 WRBUF w = wrbuf_alloc();
1031 wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1032 s->name, p, addinfo);
1033 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1034 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG, wrbuf_cstr(w));
1035 client_set_state_nb(cl, Client_Error);
1044 // returns a xmalloced CQL query corresponding to the pquery in client
1045 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1047 cql_transform_t cqlt = cql_transform_create();
1049 WRBUF wrb = wrbuf_alloc();
1052 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1054 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1058 r = xstrdup(wrbuf_cstr(wrb));
1061 cql_transform_close(cqlt);
1065 // returns a xmalloced SOLR query corresponding to the pquery in client
1066 // TODO Could prob. be merge with the similar make_cqlquery
1067 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1069 solr_transform_t sqlt = solr_transform_create();
1071 WRBUF wrb = wrbuf_alloc();
1074 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1076 yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1080 r = xstrdup(wrbuf_cstr(wrb));
1083 solr_transform_close(sqlt);
1087 const char *client_get_facet_limit_local(struct client *cl,
1088 struct session_database *sdb,
1090 NMEM nmem, int *num, char ***values)
1092 const char *name = 0;
1093 const char *value = 0;
1094 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1096 struct setting *s = 0;
1098 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1100 const char *p = strchr(s->name + 3, ':');
1101 if (p && !strcmp(p + 1, name) && s->value &&
1102 !strncmp(s->value, "local:", 6))
1104 const char *cp = s->value + 6;
1108 nmem_strsplit_escape2(nmem, "|", value, values,
1111 return *cp ? cp : name;
1118 static int apply_limit(struct session_database *sdb,
1119 facet_limits_t facet_limits,
1120 WRBUF w_pqf, CCL_bibset ccl_map)
1127 NMEM nmem_tmp = nmem_create();
1128 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1130 struct setting *s = 0;
1131 nmem_reset(nmem_tmp);
1132 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1134 const char *p = strchr(s->name + 3, ':');
1135 if (p && !strcmp(p + 1, name) && s->value)
1139 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1142 if (!strncmp(s->value, "rpn:", 4))
1144 const char *pqf = s->value + 4;
1146 wrbuf_puts(w_pqf, "@and ");
1147 wrbuf_puts(w_pqf, pqf);
1148 wrbuf_puts(w_pqf, " ");
1149 for (i = 0; i < num; i++)
1152 wrbuf_puts(w_pqf, "@or ");
1153 yaz_encode_pqf_term(w_pqf, values[i],
1157 else if (!strncmp(s->value, "ccl:", 4))
1159 const char *ccl = s->value + 4;
1160 WRBUF ccl_w = wrbuf_alloc();
1161 for (i = 0; i < num; i++)
1164 struct ccl_rpn_node *cn;
1166 wrbuf_rewind(ccl_w);
1167 wrbuf_puts(ccl_w, ccl);
1168 wrbuf_puts(ccl_w, "=\"");
1169 wrbuf_puts(ccl_w, values[i]);
1170 wrbuf_puts(ccl_w, "\"");
1172 cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1177 wrbuf_printf(w_pqf, "@and ");
1179 /* or multiple values.. could be bad if last CCL
1180 parse fails, but this is unlikely to happen */
1182 wrbuf_printf(w_pqf, "@or ");
1183 ccl_pquery(w_pqf, cn);
1187 wrbuf_destroy(ccl_w);
1189 else if (!strncmp(s->value, "local:", 6)) {
1194 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1195 sdb->database->id, s->value);
1196 ret = -1; /* bad limitmap */
1203 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1204 (sdb->database ? sdb->database->id : "<no id>"), name);
1207 nmem_destroy(nmem_tmp);
1211 // Parse the query given the settings specific to this client
1212 // return 0 if query is OK but different from before
1213 // return 1 if query is OK but same as before
1214 // return -1 on query error
1215 // return -2 on limit error
1216 int client_parse_query(struct client *cl, const char *query,
1217 facet_limits_t facet_limits,
1220 struct session *se = client_get_session(cl);
1221 struct session_database *sdb = client_get_database(cl);
1222 struct ccl_rpn_node *cn;
1225 CCL_bibset ccl_map = prepare_cclmap(cl, bibset);
1226 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1227 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1228 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1229 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1237 w_ccl = wrbuf_alloc();
1238 wrbuf_puts(w_ccl, query);
1240 w_pqf = wrbuf_alloc();
1243 wrbuf_puts(w_pqf, pqf_prefix);
1244 wrbuf_puts(w_pqf, " ");
1247 if (apply_limit(sdb, facet_limits, w_pqf, ccl_map))
1249 ccl_qual_rm(&ccl_map);
1253 facet_limits_destroy(cl->facet_limits);
1254 cl->facet_limits = facet_limits_dup(facet_limits);
1256 yaz_log(YLOG_LOG, "Client %s: CCL query: %s", client_get_id(cl), wrbuf_cstr(w_ccl));
1257 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1258 ccl_qual_rm(&ccl_map);
1261 client_set_state(cl, Client_Error);
1262 session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1265 wrbuf_destroy(w_ccl);
1266 wrbuf_destroy(w_pqf);
1269 wrbuf_destroy(w_ccl);
1271 if (!pqf_strftime || !*pqf_strftime)
1272 ccl_pquery(w_pqf, cn);
1275 time_t cur_time = time(0);
1276 struct tm *tm = localtime(&cur_time);
1278 const char *cp = tmp_str;
1280 /* see man strftime(3) for things .. In particular %% gets converted
1281 to %.. And That's our original query .. */
1282 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1286 ccl_pquery(w_pqf, cn);
1288 wrbuf_putc(w_pqf, cp[0]);
1292 /* Compares query and limit with old one. If different we need to research */
1293 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1296 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1299 wrbuf_destroy(w_pqf);
1301 xfree(cl->cqlquery);
1304 odr_out = odr_createmem(ODR_ENCODE);
1305 zquery = p_query_rpn(odr_out, cl->pquery);
1309 session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1310 client_get_id(cl), cl->pquery);
1315 session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1316 client_get_id(cl), cl->pquery);
1318 /* Support for PQF on SRU targets. */
1319 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1321 if (!strcmp(sru, "solr"))
1322 cl->cqlquery = make_solrquery(cl, zquery);
1324 cl->cqlquery = make_cqlquery(cl, zquery);
1329 odr_destroy(odr_out);
1331 /* TODO FIX Not thread safe */
1334 // Initialize relevance structure with query terms
1335 se->relevance = relevance_create_ccl(se->service->charsets, cn,
1336 se->service->rank_cluster,
1337 se->service->rank_follow,
1338 se->service->rank_lead,
1339 se->service->rank_length);
1345 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp)
1347 struct session *se = client_get_session(cl);
1349 { /* first entry is current sorting ! */
1350 const char *sort_strategy_and_spec =
1351 get_strategy_plus_sort(cl, se->sorted_results->name);
1353 int increasing = se->sorted_results->increasing;
1354 // int type = se->sorted_results->type;
1355 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1358 strcpy(spec, sort_strategy_and_spec);
1359 p = strchr(spec, ':');
1362 *p++ = '\0'; /* cut the string in two */
1369 yaz_log(YLOG_LOG, "Client %s: applying sorting %s %s", client_get_id(cl), spec, p);
1370 if (!cl->sort_spec || strcmp(cl->sort_spec, spec))
1371 cl->same_search = 0;
1372 cl->sort_spec = nmem_strdup(se->nmem, spec);
1379 void client_set_session(struct client *cl, struct session *se)
1384 int client_is_active(struct client *cl)
1386 if (cl->connection && (cl->state == Client_Connecting ||
1387 cl->state == Client_Working))
1392 int client_is_active_preferred(struct client *cl)
1394 /* only count if this is a preferred target. */
1397 /* TODO No sure this the condition that Seb wants */
1398 if (cl->connection && (cl->state == Client_Connecting ||
1399 cl->state == Client_Working))
1404 Odr_int client_get_hits(struct client *cl)
1409 Odr_int client_get_approximation(struct client *cl)
1411 if (cl->record_offset > 0) {
1412 Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered)) / cl->record_offset + 5) /10;
1413 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);
1419 int client_get_num_records(struct client *cl)
1421 return cl->record_offset;
1424 int client_get_num_records_filtered(struct client *cl)
1426 return cl->filtered;
1429 void client_set_diagnostic(struct client *cl, int diagnostic,
1430 const char *addinfo)
1432 cl->diagnostic = diagnostic;
1436 cl->addinfo = xstrdup(addinfo);
1439 int client_get_diagnostic(struct client *cl, const char **addinfo)
1442 *addinfo = cl->addinfo;
1443 return cl->diagnostic;
1446 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1449 struct suggestions *suggestions = cl->suggestions;
1452 //yaz_log(YLOG_DEBUG, "No suggestions found");
1455 if (suggestions->passthrough) {
1456 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", suggestions->passthrough);
1457 return suggestions->passthrough;
1459 if (suggestions->num == 0) {
1463 for (idx = 0; idx < suggestions->num; idx++) {
1464 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1465 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1466 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1467 wrbuf_puts(wrbuf, "</suggest>\n");
1470 wrbuf_puts(wrbuf, "/>\n");
1473 return wrbuf_cstr(wrbuf);
1477 void client_set_database(struct client *cl, struct session_database *db)
1482 const char *client_get_id(struct client *cl)
1487 int client_get_maxrecs(struct client *cl)
1492 void client_set_preferred(struct client *cl, int v)
1498 struct suggestions* client_suggestions_create(const char* suggestions_string)
1502 struct suggestions *suggestions;
1503 if (suggestions_string == 0 || suggestions_string[0] == 0 )
1505 nmem = nmem_create();
1506 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1507 yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1509 suggestions->nmem = nmem;
1510 suggestions->num = 0;
1511 suggestions->misspelled = 0;
1512 suggestions->suggest = 0;
1513 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1515 if (suggestions_string)
1516 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1517 &suggestions->num, 1, '\\', 0);
1518 /* Set up misspelled array */
1519 suggestions->misspelled = (char **) nmem_malloc(nmem, suggestions->num * sizeof(**suggestions->misspelled));
1520 /* replace = with \0 .. for each item */
1521 for (i = 0; i < suggestions->num; i++)
1523 char *cp = strchr(suggestions->suggest[i], '=');
1526 suggestions->misspelled[i] = cp+1;
1532 static void client_suggestions_destroy(struct client *cl)
1534 NMEM nmem = cl->suggestions->nmem;
1535 cl->suggestions = 0;
1539 int client_test_sort_order(struct client *cl, struct reclist_sortparms *sp)
1541 //TODO implement correctly.
1547 * c-file-style: "Stroustrup"
1548 * indent-tabs-mode: nil
1550 * vim: shiftwidth=4 tabstop=8 expandtab