1 /* This file is part of Pazpar2.
2 Copyright (C) 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 #define XDOC_CACHE_SIZE 100
76 static YAZ_MUTEX g_mutex = 0;
77 static int no_clients = 0;
79 static int client_use(int delta)
83 yaz_mutex_create(&g_mutex);
84 yaz_mutex_enter(g_mutex);
87 yaz_mutex_leave(g_mutex);
88 yaz_log(YLOG_DEBUG, "%s clients=%d",
89 delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
93 int clients_count(void)
98 /** \brief Represents client state for a connection to one search target */
100 struct session_database *database;
101 struct connection *connection;
102 struct session *session;
103 char *pquery; // Current search
104 char *cqlquery; // used for SRU targets only
105 char *addinfo; // diagnostic info for most resent error
109 int filtered; /* number of records ignored for local filtering */
110 int ingest_failures; /* number of records where XSLT/other failed */
111 int record_failures; /* number of records where ZOOM reported error */
117 struct suggestions *suggestions;
118 enum client_state state;
119 struct show_raw *show_raw;
120 ZOOM_resultset resultset;
124 facet_limits_t facet_limits;
140 int active; // whether this request has been sent to the server
146 void (*error_handler)(void *data, const char *addinfo);
147 void (*record_handler)(void *data, const char *buf, size_t sz);
149 struct show_raw *next;
152 static const char *client_states[] = {
158 "Client_Disconnected"
161 const char *client_get_state_str(struct client *cl)
163 return client_states[cl->state];
166 enum client_state client_get_state(struct client *cl)
171 void client_set_state_nb(struct client *cl, enum client_state st)
176 void client_set_state(struct client *cl, enum client_state st)
179 if (client_is_active(cl))
182 /* If client is going from being active to inactive and all clients
183 are now idle we fire a watch for the session . The assumption is
184 that session is not mutex locked if client is already active */
185 if (was_active && !client_is_active(cl) && cl->session)
188 int no_active = session_active_clients(cl->session);
189 yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
190 client_get_id(cl), no_active);
191 if (no_active == 0) {
192 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
193 session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
194 session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
195 session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
200 static void client_init_xdoc(struct client *cl)
204 cl->xdoc = xmalloc(sizeof(*cl->xdoc) * XDOC_CACHE_SIZE);
205 for (i = 0; i < XDOC_CACHE_SIZE; i++)
209 static void client_destroy_xdoc(struct client *cl)
214 for (i = 0; i < XDOC_CACHE_SIZE; i++)
216 xmlFreeDoc(cl->xdoc[i]);
220 xmlDoc *client_get_xdoc(struct client *cl, int record_no)
223 if (record_no >= 0 && record_no < XDOC_CACHE_SIZE)
224 return cl->xdoc[record_no];
228 void client_store_xdoc(struct client *cl, int record_no, xmlDoc *xdoc)
231 if (record_no >= 0 && record_no < XDOC_CACHE_SIZE)
233 if (cl->xdoc[record_no])
234 xmlFreeDoc(cl->xdoc[record_no]);
235 cl->xdoc[record_no] = xdoc;
244 static void client_show_raw_error(struct client *cl, const char *addinfo);
246 struct connection *client_get_connection(struct client *cl)
248 return cl->connection;
251 struct session_database *client_get_database(struct client *cl)
256 struct session *client_get_session(struct client *cl)
261 static void client_send_raw_present(struct client *cl);
262 static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
264 static void client_show_immediate(
265 ZOOM_resultset resultset, struct session_database *sdb, int position,
267 void (*error_handler)(void *data, const char *addinfo),
268 void (*record_handler)(void *data, const char *buf, size_t sz),
270 const char *nativesyntax)
279 error_handler(data, "no resultset");
282 rec = ZOOM_resultset_record_immediate(resultset, position-1);
285 error_handler(data, "no record");
288 nativesyntax_to_type(nativesyntax, type, rec);
289 buf = ZOOM_record_get(rec, type, &len);
292 error_handler(data, "no record");
295 record_handler(data, buf, len);
299 int client_show_raw_begin(struct client *cl, int position,
300 const char *syntax, const char *esn,
302 void (*error_handler)(void *data, const char *addinfo),
303 void (*record_handler)(void *data, const char *buf,
306 const char *nativesyntax)
311 nativesyntax = "raw";
314 struct session_database *sdb = client_get_database(cl);
315 nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
319 if (syntax == 0 && esn == 0)
320 client_show_immediate(cl->resultset, client_get_database(cl),
322 error_handler, record_handler,
323 binary, nativesyntax);
326 struct show_raw *rr, **rrp;
332 rr = xmalloc(sizeof(*rr));
333 rr->position = position;
336 rr->error_handler = error_handler;
337 rr->record_handler = record_handler;
340 rr->syntax = xstrdup(syntax);
344 rr->esn = xstrdup(esn);
348 assert(nativesyntax);
349 rr->nativesyntax = xstrdup(nativesyntax);
353 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
357 if (cl->state == Client_Failed)
359 client_show_raw_error(cl, "client failed");
361 else if (cl->state == Client_Disconnected)
363 client_show_raw_error(cl, "client disconnected");
367 client_send_raw_present(cl);
373 static void client_show_raw_delete(struct show_raw *r)
377 xfree(r->nativesyntax);
381 void client_show_raw_remove(struct client *cl, void *data)
383 struct show_raw *rr = data;
384 struct show_raw **rrp = &cl->show_raw;
390 client_show_raw_delete(rr);
394 static void client_show_raw_dequeue(struct client *cl)
396 struct show_raw *rr = cl->show_raw;
398 cl->show_raw = rr->next;
399 client_show_raw_delete(rr);
402 static void client_show_raw_error(struct client *cl, const char *addinfo)
406 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
407 client_show_raw_dequeue(cl);
411 static void client_send_raw_present(struct client *cl)
413 struct session_database *sdb = client_get_database(cl);
414 struct connection *co = client_get_connection(cl);
415 ZOOM_resultset set = cl->resultset;
417 int offset = cl->show_raw->position;
418 const char *syntax = 0;
419 const char *elements = 0;
421 assert(cl->show_raw);
424 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
425 client_get_id(cl), 1, offset);
427 if (cl->show_raw->syntax)
428 syntax = cl->show_raw->syntax;
430 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
431 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
433 if (cl->show_raw->esn)
434 elements = cl->show_raw->esn;
436 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
437 if (elements && *elements)
438 ZOOM_resultset_option_set(set, "elementSetName", elements);
440 ZOOM_resultset_records(set, 0, offset-1, 1);
441 cl->show_raw->active = 1;
443 connection_continue(co);
446 static int nativesyntax_to_type(const char *s, char *type,
451 if (!strncmp(s, "iso2709", 7))
453 const char *cp = strchr(s, ';');
454 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
456 else if (!strncmp(s, "txml", 4))
458 const char *cp = strchr(s, ';');
459 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
461 else /* pass verbatim to ZOOM - including "xml" */
465 else /* attempt to deduce structure */
467 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
470 if (!strcmp(syntax, "XML"))
475 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
477 strcpy(type, "xml; charset=marc8-s");
487 * TODO Consider thread safety!!!
490 static void client_report_facets(struct client *cl, ZOOM_resultset rs)
492 struct session_database *sdb = client_get_database(cl);
493 ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
497 struct session *se = client_get_session(cl);
498 int facet_num = ZOOM_resultset_facets_size(rs);
501 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
503 const char *p = strchr(s->name + 3, ':');
504 if (p && p[1] && s->value && s->value[0])
507 p++; /* p now holds logical facet name */
508 for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
510 const char *native_name =
511 ZOOM_facet_field_name(facets[facet_idx]);
512 if (native_name && !strcmp(s->value, native_name))
516 ZOOM_facet_field_term_count(facets[facet_idx]);
517 for (term_idx = 0; term_idx < term_num; term_idx++ )
521 ZOOM_facet_field_get_term(facets[facet_idx],
524 add_facet(se, p, term, freq, cl);
534 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
540 nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
541 buf = ZOOM_record_get(rec, type, &len);
542 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
543 client_show_raw_dequeue(cl);
546 struct suggestions* client_suggestions_create(const char* suggestions_string);
547 static void client_suggestions_destroy(struct client *cl);
549 void client_search_response(struct client *cl)
551 struct connection *co = cl->connection;
552 ZOOM_connection link = connection_get_link(co);
553 ZOOM_resultset resultset = cl->resultset;
554 struct session *se = client_get_session(cl);
556 const char *error, *addinfo = 0;
558 if (ZOOM_connection_error(link, &error, &addinfo))
561 session_log(se, YLOG_WARN, "%s: Error %s (%s)",
562 client_get_id(cl), error, addinfo);
563 client_set_state(cl, Client_Error);
567 client_report_facets(cl, resultset);
568 cl->record_offset = cl->startrecs;
569 cl->hits = ZOOM_resultset_size(resultset);
570 session_log(se, YLOG_LOG, "%s: hits: " ODR_INT_PRINTF,
571 client_get_id(cl), cl->hits);
573 client_suggestions_destroy(cl);
575 client_suggestions_create(ZOOM_resultset_option_get(
576 resultset, "suggestions"));
580 void client_got_records(struct client *cl)
582 struct session *se = cl->session;
586 /* TODO possible threading issue. Session can have been destroyed */
587 if (session_is_preferred_clients_ready(se))
588 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
590 if (reclist_get_num_records(se->reclist) > 0)
593 session_alert_watch(se, SESSION_WATCH_SHOW);
594 session_alert_watch(se, SESSION_WATCH_BYTARGET);
595 session_alert_watch(se, SESSION_WATCH_TERMLIST);
596 session_alert_watch(se, SESSION_WATCH_RECORD);
602 static void client_record_ingest(struct client *cl)
604 const char *msg, *addinfo;
606 ZOOM_resultset resultset = cl->resultset;
607 struct session *se = client_get_session(cl);
609 int offset = cl->record_offset + 1; /* 0 versus 1 numbered offsets */
611 xdoc = client_get_xdoc(cl, offset);
616 NMEM nmem = nmem_create();
617 int rc = ingest_xml_record(cl, xdoc, offset, nmem, 1);
620 session_log(se, YLOG_WARN,
621 "%s: #%d: failed to ingest xdoc",
622 client_get_id(cl), offset);
623 cl->ingest_failures++;
630 else if ((rec = ZOOM_resultset_record_immediate(resultset,
633 if (cl->session == 0)
635 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
637 session_log(se, YLOG_WARN, "Record error %s (%s): %s #%d",
638 msg, addinfo, client_get_id(cl), offset);
639 cl->record_failures++;
643 struct session_database *sdb = client_get_database(cl);
644 NMEM nmem = nmem_create();
648 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
649 if (nativesyntax_to_type(s, type, rec))
650 session_log(se, YLOG_WARN, "Failed to determine record type");
651 xmlrec = ZOOM_record_get(rec, type, NULL);
654 const char *rec_syn = ZOOM_record_get(rec, "syntax", NULL);
655 session_log(se, YLOG_WARN, "%s: #%d: ZOOM_record_get failed",
656 client_get_id(cl), offset);
657 session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
658 "ZOOM record type=%s . Actual record syntax=%s",
659 s ? s : "null", type,
660 rec_syn ? rec_syn : "null");
661 cl->ingest_failures++;
665 /* OK = 0, -1 = failure, -2 = Filtered */
666 int rc = ingest_record(cl, xmlrec, offset, nmem);
669 const char *rec_syn = ZOOM_record_get(rec, "syntax", NULL);
670 session_log(se, YLOG_WARN,
671 "%s: #%d: failed to ingest record",
672 client_get_id(cl), offset);
673 session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
674 "ZOOM record type=%s . Actual record syntax=%s",
675 s ? s : "null", type,
676 rec_syn ? rec_syn : "null");
677 cl->ingest_failures++;
687 session_log(se, YLOG_WARN, "Got NULL record from %s #%d",
688 client_get_id(cl), offset);
693 void client_record_response(struct client *cl, int *got_records)
695 struct connection *co = cl->connection;
696 ZOOM_connection link = connection_get_link(co);
697 ZOOM_resultset resultset = cl->resultset;
698 const char *error, *addinfo;
700 if (ZOOM_connection_error(link, &error, &addinfo))
702 struct session *se = client_get_session(cl);
703 session_log(se, YLOG_WARN, "%s: Error %s (%s)",
704 client_get_id(cl), error, addinfo);
705 client_set_state(cl, Client_Error);
709 if (cl->show_raw && cl->show_raw->active)
712 if ((rec = ZOOM_resultset_record_immediate(
713 resultset, cl->show_raw->position-1)))
715 cl->show_raw->active = 0;
716 ingest_raw_record(cl, rec);
720 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
721 cl->show_raw->position-1);
726 client_record_ingest(cl);
732 int client_reingest(struct client *cl)
734 int i = cl->startrecs;
735 int to = cl->record_offset;
736 cl->record_failures = cl->ingest_failures = cl->filtered = 0;
738 cl->record_offset = i;
740 client_record_ingest(cl);
744 static void client_set_facets_request(struct client *cl, ZOOM_connection link)
746 struct session_database *sdb = client_get_database(cl);
748 WRBUF w = wrbuf_alloc();
752 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
754 const char *p = strchr(s->name + 3, ':');
757 yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
759 else if (s->value && s->value[0])
761 wrbuf_puts(w, "@attr 1=");
762 yaz_encode_pqf_term(w, s->value, strlen(s->value));
767 yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
768 ZOOM_connection_option_set(link, "facets",
769 wrbuf_len(w) ? wrbuf_cstr(w) : 0);
773 int client_has_facet(struct client *cl, const char *name)
775 struct session_database *sdb = client_get_database(cl);
778 for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
780 const char *p = strchr(s->name + 3, ':');
781 if ( !strncmp(p, ":split:", 7) )
783 if (p && !strcmp(name, p + 1))
789 static const char *get_strategy_plus_sort(struct client *l, const char *field)
791 struct session_database *sdb = client_get_database(l);
794 const char *strategy_plus_sort = 0;
796 for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
798 char *p = strchr(s->name + 3, ':');
801 yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
805 if (!strcmp(p, field))
807 strategy_plus_sort = s->value;
811 return strategy_plus_sort;
814 void client_update_show_stat(struct client *cl, int cmd)
817 cl->show_stat_no = 0;
822 int client_fetch_more(struct client *cl)
824 struct session_database *sdb = client_get_database(cl);
827 int number = cl->hits - cl->record_offset;
829 str = session_setting_oneval(sdb, PZ_EXTENDRECS);
833 extend_recs = atoi(str);
835 yaz_log(YLOG_LOG, "cl=%s show_stat_no=%d got=%d",
836 client_get_id(cl), cl->show_stat_no, cl->record_offset);
837 if (cl->show_stat_no < cl->record_offset)
839 yaz_log(YLOG_LOG, "cl=%s Trying to fetch more", client_get_id(cl));
841 if (number > extend_recs)
842 number = extend_recs;
845 ZOOM_resultset set = cl->resultset;
846 struct connection *co = client_get_connection(cl);
848 str = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
849 ZOOM_resultset_option_set(set, "preferredRecordSyntax", str);
850 str = session_setting_oneval(sdb, PZ_ELEMENTS);
852 ZOOM_resultset_option_set(set, "elementSetName", str);
854 ZOOM_resultset_records(set, 0, cl->record_offset, number);
855 client_set_state(cl, Client_Working);
856 connection_continue(co);
861 yaz_log(YLOG_LOG, "cl=%s. OK no more in total set", client_get_id(cl));
866 int client_parse_init(struct client *cl, int same_search)
868 cl->same_search = same_search;
873 * TODO consider how to extend the range
875 int client_parse_range(struct client *cl, const char *startrecs,
878 if (maxrecs && atoi(maxrecs) != cl->maxrecs)
881 cl->maxrecs = atoi(maxrecs);
884 if (startrecs && atoi(startrecs) != cl->startrecs)
887 cl->startrecs = atoi(startrecs);
893 const char *client_get_query(struct client *cl, const char **type, NMEM nmem)
898 return nmem_strdup(nmem, cl->pquery);
903 return nmem_strdup(nmem, cl->cqlquery);
909 int client_start_search(struct client *cl)
911 struct session_database *sdb = client_get_database(cl);
912 struct connection *co = 0;
913 ZOOM_connection link = 0;
914 struct session *se = client_get_session(cl);
916 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
917 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
918 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
919 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
920 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
921 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
922 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
923 const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED);
924 const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
925 const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
926 const char *opt_timeout = session_setting_oneval(sdb, PZ_TIMEOUT);
928 char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
930 int present_chunk = 20; // Default chunk size
931 int rc_prep_connection;
932 int operation_timeout = se->service->z3950_operation_timeout;
935 cl->record_failures = cl->ingest_failures = cl->filtered = 0;
937 yaz_gettimeofday(&tval);
940 if (opt_timeout && *opt_timeout)
941 operation_timeout = atoi(opt_timeout);
943 if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
944 present_chunk = atoi(opt_present_chunk);
945 yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
948 client_prep_connection(cl, operation_timeout,
949 se->service->z3950_session_timeout,
950 se->service->server->iochan_man,
952 /* Nothing has changed and we already have a result */
953 if (cl->same_search == 1 && rc_prep_connection == 2)
955 session_log(se, YLOG_LOG, "%s: reuse result", client_get_id(cl));
956 client_report_facets(cl, cl->resultset);
957 return client_reingest(cl);
959 else if (!rc_prep_connection)
961 session_log(se, YLOG_LOG, "%s: postponing search: No connection",
963 client_set_state_nb(cl, Client_Working);
966 co = client_get_connection(cl);
968 link = connection_get_link(co);
971 session_log(se, YLOG_LOG, "%s: new search", client_get_id(cl));
973 client_destroy_xdoc(cl);
974 client_init_xdoc(cl);
976 if (extra_args && *extra_args)
977 ZOOM_connection_option_set(link, "extraArgs", extra_args);
980 cl->preferred = atoi(opt_preferred);
982 yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
983 client_get_id(cl), cl->preferred);
987 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
989 ZOOM_connection_option_set(link, "piggyback", "1");
991 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
992 if (*opt_sru && *opt_elements)
993 ZOOM_connection_option_set(link, "schema", opt_elements);
994 else if (*opt_elements)
995 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
997 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
999 if (opt_maxrecs && *opt_maxrecs)
1001 cl->maxrecs = atoi(opt_maxrecs);
1004 /* convert back to string representation used in ZOOM API */
1005 sprintf(maxrecs_str, "%d", cl->maxrecs);
1006 ZOOM_connection_option_set(link, "count", maxrecs_str);
1008 /* A present_chunk less than 1 will disable chunking. */
1009 if (present_chunk > 0 && cl->maxrecs > present_chunk) {
1010 sprintf(present_chunk_str, "%d", present_chunk);
1011 ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
1012 yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
1015 ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
1016 yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
1018 sprintf(startrecs_str, "%d", cl->startrecs);
1019 ZOOM_connection_option_set(link, "start", startrecs_str);
1021 /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
1022 /* facets definition is in PQF */
1023 client_set_facets_request(cl, link);
1025 query = ZOOM_query_create();
1028 session_log(se, YLOG_LOG, "%s: Search CQL: %s", client_get_id(cl),
1030 ZOOM_query_cql(query, cl->cqlquery);
1032 ZOOM_query_sortby(query, opt_sort);
1036 session_log(se, YLOG_LOG, "%s: Search PQF: %s", client_get_id(cl),
1038 ZOOM_query_prefix(query, cl->pquery);
1040 if (cl->sort_strategy && cl->sort_criteria) {
1041 yaz_log(YLOG_LOG, "Client %s: "
1042 "Set ZOOM sort strategy and criteria: %s %s",
1043 client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
1044 ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
1047 yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
1048 client_set_state(cl, Client_Working);
1050 cl->record_offset = 0;
1051 rs = ZOOM_connection_search(link, query);
1052 ZOOM_query_destroy(query);
1053 ZOOM_resultset_destroy(cl->resultset);
1055 connection_continue(co);
1059 struct client *client_create(const char *id)
1061 struct client *cl = xmalloc(sizeof(*cl));
1072 cl->record_offset = 0;
1075 cl->state = Client_Disconnected;
1078 cl->suggestions = 0;
1080 pazpar2_mutex_create(&cl->mutex, "client");
1083 cl->facet_limits = 0;
1084 cl->sort_strategy = 0;
1085 cl->sort_criteria = 0;
1087 cl->id = xstrdup(id);
1088 client_init_xdoc(cl);
1091 yaz_log(YLOG_DEBUG, "client_create c=%p %s", cl, id);
1095 void client_lock(struct client *c)
1097 yaz_mutex_enter(c->mutex);
1100 void client_unlock(struct client *c)
1102 yaz_mutex_leave(c->mutex);
1105 void client_incref(struct client *c)
1107 pazpar2_incref(&c->ref_count, c->mutex);
1108 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
1109 c, client_get_id(c), c->ref_count);
1112 int client_destroy(struct client *c)
1116 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
1117 c, client_get_id(c), c->ref_count);
1118 if (!pazpar2_decref(&c->ref_count, c->mutex))
1129 xfree(c->sort_strategy);
1130 xfree(c->sort_criteria);
1131 assert(!c->connection);
1132 facet_limits_destroy(c->facet_limits);
1134 client_destroy_xdoc(c);
1137 ZOOM_resultset_destroy(c->resultset);
1139 yaz_mutex_destroy(&c->mutex);
1148 void client_set_connection(struct client *cl, struct connection *con)
1151 ZOOM_resultset_release(cl->resultset);
1154 assert(cl->connection == 0);
1155 cl->connection = con;
1161 cl->connection = con;
1167 void client_disconnect(struct client *cl)
1169 if (cl->state != Client_Idle)
1170 client_set_state(cl, Client_Disconnected);
1171 client_set_connection(cl, 0);
1174 void client_stop(struct client *cl)
1177 if (cl->state == Client_Working || cl->state == Client_Connecting)
1179 yaz_log(YLOG_LOG, "client_stop: %s release", client_get_id(cl));
1182 connection_release2(cl->connection);
1183 assert(cl->ref_count > 1);
1187 cl->state = Client_Disconnected;
1190 yaz_log(YLOG_LOG, "client_stop: %s ignore", client_get_id(cl));
1194 // Initialize CCL map for a target
1195 static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
1197 struct session_database *sdb = client_get_database(cl);
1204 res = ccl_qual_dup(base_bibset);
1206 res = ccl_qual_mk();
1207 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1209 const char *addinfo = 0;
1210 char *p = strchr(s->name + 3, ':');
1213 WRBUF w = wrbuf_alloc();
1214 wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
1215 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1216 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1217 ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1219 client_set_state_nb(cl, Client_Error);
1225 if (ccl_qual_fitem2(res, s->value, p, &addinfo))
1227 WRBUF w = wrbuf_alloc();
1229 wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
1230 s->name, p, addinfo);
1231 yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
1232 client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
1233 ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
1235 client_set_state_nb(cl, Client_Error);
1244 // returns a xmalloced CQL query corresponding to the pquery in client
1245 static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
1247 cql_transform_t cqlt = cql_transform_create();
1249 WRBUF wrb = wrbuf_alloc();
1252 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
1254 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
1258 r = xstrdup(wrbuf_cstr(wrb));
1261 cql_transform_close(cqlt);
1265 // returns a xmalloced SOLR query corresponding to the pquery in client
1266 // TODO Could prob. be merge with the similar make_cqlquery
1267 static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
1269 solr_transform_t sqlt = solr_transform_create();
1271 WRBUF wrb = wrbuf_alloc();
1274 if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
1276 yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
1280 r = xstrdup(wrbuf_cstr(wrb));
1283 solr_transform_close(sqlt);
1287 const char *client_get_facet_limit_local(struct client *cl,
1288 struct session_database *sdb,
1290 NMEM nmem, int *num, char ***values)
1292 const char *name = 0;
1293 const char *value = 0;
1294 for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
1296 struct setting *s = 0;
1298 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1300 const char *p = strchr(s->name + 3, ':');
1301 if (p && !strcmp(p + 1, name) && s->value)
1305 nmem_strsplit_escape2(nmem, ",", s->value, &cvalues,
1307 for (j = 0; j < cnum; j++)
1309 const char *cvalue = cvalues[j];
1310 while (*cvalue == ' ')
1312 if (!strncmp(cvalue, "local:", 6))
1314 const char *cp = cvalue + 6;
1317 nmem_strsplit_escape2(nmem, "|", value, values,
1320 return *cp ? cp : name;
1329 static void ccl_quote_map_term(CCL_bibset ccl_map, WRBUF w,
1334 for (cp = term; *cp; cp++)
1335 if ((*cp >= '0' && *cp <= '9') || strchr(" +-", *cp))
1340 wrbuf_puts(w, term);
1343 wrbuf_putc(w, '\"');
1344 for (cp = term; *cp; cp++)
1346 if (strchr( "\\\"", *cp))
1347 wrbuf_putc(w, '\\');
1350 wrbuf_putc(w, '\"');
1354 static int apply_limit(struct client *cl,
1355 facet_limits_t facet_limits,
1356 WRBUF w_pqf, CCL_bibset ccl_map,
1357 struct conf_service *service)
1363 struct session_database *sdb = client_get_database(cl);
1365 NMEM nmem_tmp = nmem_create();
1366 for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
1368 struct setting *s = 0;
1369 nmem_reset(nmem_tmp);
1370 /* name="pz:limitmap:author" value="rpn:@attr 1=4|local:other" */
1371 for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
1373 const char *p = strchr(s->name + 3, ':');
1374 if (p && !strcmp(p + 1, name) && s->value)
1380 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1383 for (i = 0; i < num; i++)
1385 const char *id = session_lookup_id_facet(cl->session,
1392 values[i] = nmem_strdup(nmem_tmp, id);
1394 "apply_limit: s='%s' found id '%s'",s->name,id );
1399 "apply_limit: %s: term '%s' not found, failing client",
1400 s->name, values[i] );
1405 nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues,
1408 for (j = 0; ret == 0 && j < cnum; j++)
1410 const char *cvalue = cvalues[j];
1411 while (*cvalue == ' ')
1413 if (!strncmp(cvalue, "rpn:", 4))
1415 const char *pqf = cvalue + 4;
1416 wrbuf_puts(w_pqf, "@and ");
1417 wrbuf_puts(w_pqf, pqf);
1418 wrbuf_puts(w_pqf, " ");
1419 for (i = 0; i < num; i++)
1422 wrbuf_puts(w_pqf, "@or ");
1423 yaz_encode_pqf_term(w_pqf, values[i],
1427 else if (!strncmp(cvalue, "ccl:", 4))
1429 const char *ccl = cvalue + 4;
1430 WRBUF ccl_w = wrbuf_alloc();
1431 for (i = 0; i < num; i++)
1434 struct ccl_rpn_node *cn;
1435 wrbuf_rewind(ccl_w);
1436 wrbuf_puts(ccl_w, ccl);
1437 wrbuf_putc(ccl_w, '=');
1438 ccl_quote_map_term(ccl_map, ccl_w, values[i]);
1439 cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
1444 wrbuf_printf(w_pqf, "@and ");
1446 /* or multiple values.. could be bad if last
1447 CCL parse fails, but this is unlikely to
1450 wrbuf_printf(w_pqf, "@or ");
1451 ccl_pquery(w_pqf, cn);
1455 wrbuf_destroy(ccl_w);
1457 else if (!strncmp(cvalue, "local:", 6)) {
1462 yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
1463 sdb->database->id, cvalue);
1464 ret = -1; /* bad limitmap */
1473 for (i = 0; i < service->num_metadata; i++)
1475 struct conf_metadata *md = service->metadata + i;
1476 if (!strcmp(md->name, name) && md->limitcluster)
1478 yaz_log(YLOG_LOG, "limitcluster in use for %s",
1483 if (i == service->num_metadata)
1485 yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
1486 (sdb->database ? sdb->database->id : "<no id>"), name);
1490 nmem_destroy(nmem_tmp);
1494 // Parse the query given the settings specific to this client
1495 // client variable same_search is set as below as well as returned:
1496 // 0 if query is OK but different from before
1497 // 1 if query is OK but same as before
1498 // return -1 on query error
1499 // return -2 on limit error
1500 int client_parse_query(struct client *cl, const char *query,
1501 facet_limits_t facet_limits, const char **error_msg)
1503 struct session *se = client_get_session(cl);
1504 struct conf_service *service = se->service;
1505 struct session_database *sdb = client_get_database(cl);
1506 struct ccl_rpn_node *cn;
1509 CCL_bibset ccl_map = prepare_cclmap(cl, service->ccl_bibset);
1510 const char *sru = session_setting_oneval(sdb, PZ_SRU);
1511 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
1512 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
1513 const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
1521 w_ccl = wrbuf_alloc();
1522 wrbuf_puts(w_ccl, query);
1524 w_pqf = wrbuf_alloc();
1527 wrbuf_puts(w_pqf, pqf_prefix);
1528 wrbuf_puts(w_pqf, " ");
1531 if (apply_limit(cl, facet_limits, w_pqf, ccl_map, service))
1533 ccl_qual_rm(&ccl_map);
1537 facet_limits_destroy(cl->facet_limits);
1538 cl->facet_limits = facet_limits_dup(facet_limits);
1540 yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s",
1541 client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf));
1542 cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
1543 ccl_qual_rm(&ccl_map);
1547 *error_msg = ccl_err_msg(cerror);
1548 client_set_state(cl, Client_Error);
1549 session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
1552 wrbuf_destroy(w_ccl);
1553 wrbuf_destroy(w_pqf);
1556 wrbuf_destroy(w_ccl);
1558 if (!pqf_strftime || !*pqf_strftime)
1559 ccl_pquery(w_pqf, cn);
1562 time_t cur_time = time(0);
1563 struct tm *tm = localtime(&cur_time);
1565 const char *cp = tmp_str;
1567 /* see man strftime(3) for things .. In particular %% gets converted
1568 to %.. And That's our original query .. */
1569 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
1573 ccl_pquery(w_pqf, cn);
1575 wrbuf_putc(w_pqf, cp[0]);
1579 /* Compares query and limit with old one. If different we need to research */
1580 if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
1583 session_log(se, YLOG_LOG, "Client %s: "
1584 "Re-search due query/limit change: %s to %s",
1585 client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
1587 cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
1588 // return value is no longer used.
1590 // Need to (re)search
1593 wrbuf_destroy(w_pqf);
1595 xfree(cl->cqlquery);
1598 odr_out = odr_createmem(ODR_ENCODE);
1599 zquery = p_query_rpn(odr_out, cl->pquery);
1603 session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
1604 client_get_id(cl), cl->pquery);
1606 *error_msg = "Invalid PQF after CCL to PQF conversion";
1610 session_log(se, YLOG_LOG, "PQF for Client %s: %s",
1611 client_get_id(cl), cl->pquery);
1613 /* Support for PQF on SRU targets. */
1614 if (strcmp(query_syntax, "pqf") != 0 && *sru)
1616 if (!strcmp(sru, "solr"))
1617 cl->cqlquery = make_solrquery(cl, zquery);
1619 cl->cqlquery = make_cqlquery(cl, zquery);
1622 *error_msg = "Cannot convert PQF to Solr/CQL";
1626 session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
1627 client_get_id(cl), cl->cqlquery, sru);
1630 odr_destroy(odr_out);
1632 /* TODO FIX Not thread safe */
1635 // Initialize relevance structure with query terms
1636 se->relevance = relevance_create_ccl(se->service->charsets, cn,
1637 se->service->rank_cluster,
1638 se->service->rank_follow,
1639 se->service->rank_lead,
1640 se->service->rank_length);
1646 int client_parse_sort(struct client *cl, struct reclist_sortparms *sp,
1653 const char *sort_strategy_and_spec =
1654 get_strategy_plus_sort(cl, sp->name);
1655 int increasing = sp->increasing;
1656 if (!strcmp(sp->name, "relevance"))
1658 if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
1660 char strategy[50], *p;
1661 strcpy(strategy, sort_strategy_and_spec);
1662 p = strchr(strategy, ':');
1665 // Split the string in two
1673 yaz_log(YLOG_LOG, "Client %s: "
1674 "applying sorting %s %s", client_get_id(cl),
1676 if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
1677 cl->same_search = 0;
1678 if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
1679 cl->same_search = 0;
1680 if (cl->same_search == 0) {
1681 xfree(cl->sort_strategy);
1682 cl->sort_strategy = xstrdup(strategy);
1683 xfree(cl->sort_criteria);
1684 cl->sort_criteria = xstrdup(p);
1690 yaz_log(YLOG_LOG, "Client %s: "
1691 "Invalid sort strategy and spec found %s",
1692 client_get_id(cl), sort_strategy_and_spec);
1693 xfree(cl->sort_strategy);
1694 cl->sort_strategy = 0;
1695 xfree(cl->sort_criteria);
1696 cl->sort_criteria = 0;
1701 yaz_log(YLOG_DEBUG, "Client %s: "
1702 "No sort strategy and spec found.", client_get_id(cl));
1703 xfree(cl->sort_strategy);
1704 cl->sort_strategy = 0;
1705 xfree(cl->sort_criteria);
1706 cl->sort_criteria = 0;
1710 return !cl->same_search;
1713 void client_set_session(struct client *cl, struct session *se)
1718 int client_is_active(struct client *cl)
1720 if (cl->connection && (cl->state == Client_Connecting ||
1721 cl->state == Client_Working))
1726 int client_is_active_preferred(struct client *cl)
1728 /* only count if this is a preferred target. */
1731 /* TODO No sure this the condition that Seb wants */
1732 if (cl->connection && (cl->state == Client_Connecting ||
1733 cl->state == Client_Working))
1738 Odr_int client_get_hits(struct client *cl)
1743 Odr_int client_get_approximation(struct client *cl)
1745 if (cl->record_offset > 0)
1747 Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered))
1748 / cl->record_offset + 5) /10;
1749 yaz_log(YLOG_DEBUG, "%s: Approx: %lld * %d / %d = %lld ",
1750 client_get_id(cl), cl->hits,
1751 cl->record_offset - cl->filtered, cl->record_offset, approx);
1757 int client_get_num_records(struct client *cl, int *filtered, int *ingest,
1761 *filtered = cl->filtered;
1763 *ingest = cl->ingest_failures;
1765 *failed = cl->record_failures;
1766 return cl->record_offset;
1769 void client_set_diagnostic(struct client *cl, int diagnostic,
1770 const char *message, const char *addinfo)
1772 cl->diagnostic = diagnostic;
1774 cl->message = xstrdup(message);
1778 cl->addinfo = xstrdup(addinfo);
1781 int client_get_diagnostic(struct client *cl, const char **message,
1782 const char **addinfo)
1785 *message = cl->message;
1787 *addinfo = cl->addinfo;
1788 return cl->diagnostic;
1791 const char *client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
1794 struct suggestions *suggestions = cl->suggestions;
1798 if (suggestions->passthrough)
1800 yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n",
1801 suggestions->passthrough);
1802 return suggestions->passthrough;
1804 if (suggestions->num == 0)
1807 for (idx = 0; idx < suggestions->num; idx++) {
1808 wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
1809 if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
1810 wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
1811 wrbuf_puts(wrbuf, "</suggest>\n");
1814 wrbuf_puts(wrbuf, "/>\n");
1817 return wrbuf_cstr(wrbuf);
1820 void client_set_database(struct client *cl, struct session_database *db)
1825 const char *client_get_id(struct client *cl)
1830 int client_get_maxrecs(struct client *cl)
1835 void client_set_preferred(struct client *cl, int v)
1841 struct suggestions* client_suggestions_create(const char* suggestions_string)
1845 struct suggestions *suggestions;
1846 if (suggestions_string == 0 || suggestions_string[0] == 0 )
1848 nmem = nmem_create();
1849 suggestions = nmem_malloc(nmem, sizeof(*suggestions));
1850 yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
1852 suggestions->nmem = nmem;
1853 suggestions->num = 0;
1854 suggestions->misspelled = 0;
1855 suggestions->suggest = 0;
1856 suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
1858 if (suggestions_string)
1859 nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
1860 &suggestions->num, 1, '\\', 0);
1861 /* Set up misspelled array */
1862 suggestions->misspelled = (char **)
1863 nmem_malloc(nmem, suggestions->num * sizeof(*suggestions->misspelled));
1864 /* replace = with \0 .. for each item */
1865 for (i = 0; i < suggestions->num; i++)
1867 char *cp = strchr(suggestions->suggest[i], '=');
1870 suggestions->misspelled[i] = cp+1;
1876 static void client_suggestions_destroy(struct client *cl)
1878 NMEM nmem = cl->suggestions->nmem;
1879 cl->suggestions = 0;
1886 * c-file-style: "Stroustrup"
1887 * indent-tabs-mode: nil
1889 * vim: shiftwidth=4 tabstop=8 expandtab