X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fclient.c;h=33f5efa1a445eb1a181ce3a03b3ea9bf66f0dfa9;hb=b4e2292424ace7d7065ed2001e5e0a8f2d8f5daf;hp=048c95c85d352bab5ea152608c32392f8129441b;hpb=f17753536a7a1ab86f518b7705ed3a2b3216c0e5;p=pazpar2-moved-to-github.git diff --git a/src/client.c b/src/client.c index 048c95c..fbfc564 100644 --- a/src/client.c +++ b/src/client.c @@ -1,7 +1,5 @@ -/* $Id: client.c,v 1.22 2007-09-19 13:23:35 adam Exp $ - Copyright (c) 2006-2007, Index Data. - -This file is part of Pazpar2. +/* This file is part of Pazpar2. + Copyright (C) Index Data Pazpar2 is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free @@ -14,24 +12,31 @@ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License -along with Pazpar2; see the file LICENSE. If not, write to the -Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA -02111-1307, USA. - */ +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +*/ /** \file client.c - \brief Z39.50 client + \brief Z39.50 client */ +#if HAVE_CONFIG_H +#include +#endif #include #include #include +#if HAVE_SYS_TIME_H #include +#endif +#if HAVE_UNISTD_H #include -#include -#include +#endif +#ifdef WIN32 +#include +#endif #include -#include #include #include @@ -47,23 +52,46 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA #include #include #include - -#if HAVE_CONFIG_H -#include "cconfig.h" -#endif +#include +#include +#include +#include #define USE_TIMING 0 #if USE_TIMING #include #endif -#include - -#include "pazpar2.h" - +#include "ppmutex.h" +#include "session.h" +#include "parameters.h" #include "client.h" #include "connection.h" #include "settings.h" +#include "relevance.h" +#include "incref.h" + +static YAZ_MUTEX g_mutex = 0; +static int no_clients = 0; + +static int client_use(int delta) +{ + int clients; + if (!g_mutex) + yaz_mutex_create(&g_mutex); + yaz_mutex_enter(g_mutex); + no_clients += delta; + clients = no_clients; + yaz_mutex_leave(g_mutex); + yaz_log(YLOG_DEBUG, "%s clients=%d", + delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients); + return clients; +} + +int clients_count(void) +{ + return client_use(0); +} /** \brief Represents client state for a connection to one search target */ struct client { @@ -71,59 +99,60 @@ struct client { struct connection *connection; struct session *session; char *pquery; // Current search - int hits; - int records; - int setno; - int requestid; // ID of current outstanding request + char *cqlquery; // used for SRU targets only + char *addinfo; // diagnostic info for most resent error + Odr_int hits; + int record_offset; + int show_stat_no; + int filtered; // When using local:, this will count the number of filtered records. + int maxrecs; + int startrecs; int diagnostic; + char *message; + int preferred; + struct suggestions *suggestions; enum client_state state; struct show_raw *show_raw; - struct client *next; // next client in session or next in free list + ZOOM_resultset resultset; + YAZ_MUTEX mutex; + int ref_count; + char *id; + facet_limits_t facet_limits; + int same_search; + char *sort_strategy; + char *sort_criteria; +}; + +struct suggestions { + NMEM nmem; + int num; + char **misspelled; + char **suggest; + char *passthrough; }; struct show_raw { int active; // whether this request has been sent to the server int position; + int binary; char *syntax; char *esn; + char *nativesyntax; void (*error_handler)(void *data, const char *addinfo); void (*record_handler)(void *data, const char *buf, size_t sz); void *data; + struct show_raw *next; }; static const char *client_states[] = { "Client_Connecting", - "Client_Connected", "Client_Idle", - "Client_Initializing", - "Client_Searching", - "Client_Presenting", + "Client_Working", "Client_Error", "Client_Failed", - "Client_Disconnected", - "Client_Stopped" + "Client_Disconnected" }; -static struct client *client_freelist = 0; - -static int send_apdu(struct client *c, Z_APDU *a) -{ - struct session_database *sdb = client_get_database(c); - const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG); - if (apdulog && *apdulog && *apdulog != '0') - { - ODR p = odr_createmem(ODR_PRINT); - yaz_log(YLOG_LOG, "send APDU %s", client_get_url(c)); - - odr_setprint(p, yaz_log_file()); - z_APDU(p, &a, 0, 0); - odr_setprint(p, stderr); - odr_destroy(p); - } - return connection_send_apdu(client_get_connection(c), a); -} - - const char *client_get_state_str(struct client *cl) { return client_states[cl->state]; @@ -134,76 +163,36 @@ enum client_state client_get_state(struct client *cl) return cl->state; } -void client_set_state(struct client *cl, enum client_state st) +void client_set_state_nb(struct client *cl, enum client_state st) { cl->state = st; - if (cl->session) - { - int no_active = session_active_clients(cl->session); - if (no_active == 0) - session_alert_watch(cl->session, SESSION_WATCH_SHOW); - } -} - -static void client_show_raw_error(struct client *cl, const char *addinfo); - -// Close connection and set state to error -void client_fatal(struct client *cl) -{ - client_show_raw_error(cl, "client connection failure"); - yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl)); - connection_destroy(cl->connection); - client_set_state(cl, Client_Error); } - -static int diag_to_wrbuf(Z_DiagRec **pp, int num, WRBUF w) +void client_set_state(struct client *cl, enum client_state st) { - int code = 0; - int i; - for (i = 0; istate = st; + /* If client is going from being active to inactive and all clients + are now idle we fire a watch for the session . The assumption is + that session is not mutex locked if client is already active */ + if (was_active && !client_is_active(cl) && cl->session) { - Z_DiagRec *p = pp[i]; - if (i) - wrbuf_puts(w, "; "); - if (p->which != Z_DiagRec_defaultFormat) - { - wrbuf_puts(w, "? Not in default format"); - } - else - { - Z_DefaultDiagFormat *r = p->u.defaultFormat; - - if (!r->diagnosticSetId) - wrbuf_puts(w, "? Missing diagset"); - else - { - oid_class oclass; - char diag_name_buf[OID_STR_MAX]; - const char *diag_name = 0; - diag_name = yaz_oid_to_string_buf - (r->diagnosticSetId, &oclass, diag_name_buf); - wrbuf_puts(w, diag_name); - } - if (!code) - code = *r->condition; - wrbuf_printf(w, " %d %s", *r->condition, - diagbib1_str(*r->condition)); - switch (r->which) - { - case Z_DefaultDiagFormat_v2Addinfo: - wrbuf_printf(w, " -- v2 addinfo '%s'", r->u.v2Addinfo); - break; - case Z_DefaultDiagFormat_v3Addinfo: - wrbuf_printf(w, " -- v3 addinfo '%s'", r->u.v3Addinfo); - break; - } + + int no_active = session_active_clients(cl->session); + yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d", + client_get_id(cl), no_active); + if (no_active == 0) { + session_alert_watch(cl->session, SESSION_WATCH_SHOW); + session_alert_watch(cl->session, SESSION_WATCH_BYTARGET); + session_alert_watch(cl->session, SESSION_WATCH_TERMLIST); + session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF); } } - return code; } - +static void client_show_raw_error(struct client *cl, const char *addinfo); struct connection *client_get_connection(struct client *cl) { @@ -220,691 +209,881 @@ struct session *client_get_session(struct client *cl) return cl->session; } -const char *client_get_pquery(struct client *cl) -{ - return cl->pquery; -} +static void client_send_raw_present(struct client *cl); +static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec); -void client_set_requestid(struct client *cl, int id) +static void client_show_immediate( + ZOOM_resultset resultset, struct session_database *sdb, int position, + void *data, + void (*error_handler)(void *data, const char *addinfo), + void (*record_handler)(void *data, const char *buf, size_t sz), + int binary, + const char *nativesyntax) { - cl->requestid = id; + ZOOM_record rec = 0; + char type[80]; + const char *buf; + int len; + + if (!resultset) + { + error_handler(data, "no resultset"); + return; + } + rec = ZOOM_resultset_record_immediate(resultset, position-1); + if (!rec) + { + error_handler(data, "no record"); + return; + } + nativesyntax_to_type(nativesyntax, type, rec); + buf = ZOOM_record_get(rec, type, &len); + if (!buf) + { + error_handler(data, "no record"); + return; + } + record_handler(data, buf, len); } + int client_show_raw_begin(struct client *cl, int position, const char *syntax, const char *esn, void *data, void (*error_handler)(void *data, const char *addinfo), void (*record_handler)(void *data, const char *buf, - size_t sz)) + size_t sz), + int binary, + const char *nativesyntax) { - if (cl->show_raw) - return -1; - cl->show_raw = xmalloc(sizeof(*cl->show_raw)); - cl->show_raw->position = position; - cl->show_raw->active = 0; - cl->show_raw->data = data; - cl->show_raw->error_handler = error_handler; - cl->show_raw->record_handler = record_handler; - if (syntax) - cl->show_raw->syntax = xstrdup(syntax); - else - cl->show_raw->syntax = 0; - if (esn) - cl->show_raw->esn = xstrdup(esn); - else - cl->show_raw->esn = 0; - - - if (cl->state == Client_Failed) - { - client_show_raw_error(cl, "client failed"); - } - else if (cl->state == Client_Disconnected) + if (!nativesyntax) { - client_show_raw_error(cl, "client disconnected"); + if (binary) + nativesyntax = "raw"; + else + { + struct session_database *sdb = client_get_database(cl); + nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX); + } } + + if (syntax == 0 && esn == 0) + client_show_immediate(cl->resultset, client_get_database(cl), + position, data, + error_handler, record_handler, + binary, nativesyntax); else { - client_continue(cl); + struct show_raw *rr, **rrp; + + if (!cl->connection) + return -1; + + + rr = xmalloc(sizeof(*rr)); + rr->position = position; + rr->active = 0; + rr->data = data; + rr->error_handler = error_handler; + rr->record_handler = record_handler; + rr->binary = binary; + if (syntax) + rr->syntax = xstrdup(syntax); + else + rr->syntax = 0; + if (esn) + rr->esn = xstrdup(esn); + else + rr->esn = 0; + + assert(nativesyntax); + rr->nativesyntax = xstrdup(nativesyntax); + + rr->next = 0; + + for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next) + ; + *rrp = rr; + + if (cl->state == Client_Failed) + { + client_show_raw_error(cl, "client failed"); + } + else if (cl->state == Client_Disconnected) + { + client_show_raw_error(cl, "client disconnected"); + } + else + { + client_send_raw_present(cl); + } } return 0; } -void client_show_raw_reset(struct client *cl) +static void client_show_raw_delete(struct show_raw *r) { - xfree(cl->show_raw); - cl->show_raw = 0; + xfree(r->syntax); + xfree(r->esn); + xfree(r->nativesyntax); + xfree(r); } -static void client_show_raw_error(struct client *cl, const char *addinfo) +void client_show_raw_remove(struct client *cl, void *data) { - if (cl->show_raw) + struct show_raw *rr = data; + struct show_raw **rrp = &cl->show_raw; + while (*rrp != rr) + rrp = &(*rrp)->next; + if (*rrp) { - cl->show_raw->error_handler(cl->show_raw->data, addinfo); - client_show_raw_reset(cl); + *rrp = rr->next; + client_show_raw_delete(rr); } } -static void client_show_raw_cancel(struct client *cl) +static void client_show_raw_dequeue(struct client *cl) { - if (cl->show_raw) - { - cl->show_raw->error_handler(cl->show_raw->data, "cancel"); - client_show_raw_reset(cl); - } -} + struct show_raw *rr = cl->show_raw; -static void client_present_syntax(Z_APDU *a, const char *syntax) -{ - // empty string for syntax OMITS preferredRecordSyntax (OPTIONAL) - if (syntax && *syntax) - a->u.presentRequest->preferredRecordSyntax = - yaz_string_to_oid_odr(yaz_oid_std(), - CLASS_RECSYN, syntax, - global_parameters.odr_out); + cl->show_raw = rr->next; + client_show_raw_delete(rr); } -static void client_present_elements(Z_APDU *a, const char *elements) +static void client_show_raw_error(struct client *cl, const char *addinfo) { - if (elements && *elements) // element set is optional + while (cl->show_raw) { - Z_ElementSetNames *elementSetNames = - odr_malloc(global_parameters.odr_out, sizeof(*elementSetNames)); - Z_RecordComposition *compo = - odr_malloc(global_parameters.odr_out, sizeof(*compo)); - a->u.presentRequest->recordComposition = compo; - - compo->which = Z_RecordComp_simple; - compo->u.simple = elementSetNames; - - elementSetNames->which = Z_ElementSetNames_generic; - elementSetNames->u.generic = - odr_strdup(global_parameters.odr_out, elements); + cl->show_raw->error_handler(cl->show_raw->data, addinfo); + client_show_raw_dequeue(cl); } } -void client_send_raw_present(struct client *cl) +static void client_send_raw_present(struct client *cl) { struct session_database *sdb = client_get_database(cl); - Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest); - int toget = 1; - int start = cl->show_raw->position; + struct connection *co = client_get_connection(cl); + ZOOM_resultset set = cl->resultset; + + int offset = cl->show_raw->position; const char *syntax = 0; const char *elements = 0; assert(cl->show_raw); + assert(set); yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d", - client_get_url(cl), toget, start); - - a->u.presentRequest->resultSetStartPoint = &start; - a->u.presentRequest->numberOfRecordsRequested = &toget; + client_get_id(cl), 1, offset); if (cl->show_raw->syntax) syntax = cl->show_raw->syntax; else syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX); + ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax); - client_present_syntax(a, syntax); if (cl->show_raw->esn) elements = cl->show_raw->esn; else elements = session_setting_oneval(sdb, PZ_ELEMENTS); - client_present_elements(a, elements); + if (elements && *elements) + ZOOM_resultset_option_set(set, "elementSetName", elements); + + ZOOM_resultset_records(set, 0, offset-1, 1); + cl->show_raw->active = 1; + + connection_continue(co); +} - if (send_apdu(cl, a) >= 0) +static int nativesyntax_to_type(const char *s, char *type, + ZOOM_record rec) +{ + if (s && *s) { - cl->show_raw->active = 1; - cl->state = Client_Presenting; + if (!strncmp(s, "iso2709", 7)) + { + const char *cp = strchr(s, ';'); + yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s"); + } + else if (!strncmp(s, "txml", 4)) + { + const char *cp = strchr(s, ';'); + yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s"); + } + else /* pass verbatim to ZOOM - including "xml" */ + strcpy(type, s); + return 0; } - else + else /* attempt to deduce structure */ { - client_show_raw_error(cl, "send_apdu failed"); - cl->state = Client_Error; + const char *syntax = ZOOM_record_get(rec, "syntax", NULL); + if (syntax) + { + if (!strcmp(syntax, "XML")) + { + strcpy(type, "xml"); + return 0; + } + else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21")) + { + strcpy(type, "xml; charset=marc8-s"); + return 0; + } + else return -1; + } + else return -1; } - odr_reset(global_parameters.odr_out); } -void client_send_present(struct client *cl) +/** + * TODO Consider thread safety!!! + * + */ +static void client_report_facets(struct client *cl, ZOOM_resultset rs) { struct session_database *sdb = client_get_database(cl); - Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest); - int toget; - int start = cl->records + 1; - const char *syntax = 0; - const char *elements = 0; - - toget = global_parameters.chunk; - if (toget > global_parameters.toget - cl->records) - toget = global_parameters.toget - cl->records; - if (toget > cl->hits - cl->records) - toget = cl->hits - cl->records; + ZOOM_facet_field *facets = ZOOM_resultset_facets(rs); - yaz_log(YLOG_DEBUG, "Trying to present %d record(s) from %d", - toget, start); + if (sdb && facets) + { + struct session *se = client_get_session(cl); + int facet_num = ZOOM_resultset_facets_size(rs); + struct setting *s; - a->u.presentRequest->resultSetStartPoint = &start; - a->u.presentRequest->numberOfRecordsRequested = &toget; + for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next) + { + const char *p = strchr(s->name + 3, ':'); + if (p && p[1] && s->value && s->value[0]) + { + int facet_idx; + p++; /* p now holds logical facet name */ + for (facet_idx = 0; facet_idx < facet_num; facet_idx++) + { + const char *native_name = + ZOOM_facet_field_name(facets[facet_idx]); + if (native_name && !strcmp(s->value, native_name)) + { + size_t term_idx; + size_t term_num = + ZOOM_facet_field_term_count(facets[facet_idx]); + for (term_idx = 0; term_idx < term_num; term_idx++ ) + { + int freq; + const char *term = + ZOOM_facet_field_get_term(facets[facet_idx], + term_idx, &freq); + if (term) + add_facet(se, p, term, freq); + } + break; + } + } + } + } + } +} - syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX); - client_present_syntax(a, syntax); +static void ingest_raw_record(struct client *cl, ZOOM_record rec) +{ + const char *buf; + int len; + char type[80]; + + nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec); + buf = ZOOM_record_get(rec, type, &len); + cl->show_raw->record_handler(cl->show_raw->data, buf, len); + client_show_raw_dequeue(cl); +} - elements = session_setting_oneval(sdb, PZ_ELEMENTS); - client_present_elements(a, elements); +void client_check_preferred_watch(struct client *cl) +{ + struct session *se = cl->session; + yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl)); + if (se) + { + client_unlock(cl); + /* TODO possible threading issue. Session can have been destroyed */ + if (session_is_preferred_clients_ready(se)) { + session_alert_watch(se, SESSION_WATCH_SHOW_PREF); + } + else + yaz_log(YLOG_DEBUG, "client_check_preferred_watch: Still locked on preferred targets."); - if (send_apdu(cl, a) >= 0) - cl->state = Client_Presenting; + client_lock(cl); + } else - cl->state = Client_Error; - odr_reset(global_parameters.odr_out); + yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_id(cl)); + } +struct suggestions* client_suggestions_create(const char* suggestions_string); +static void client_suggestions_destroy(struct client *cl); -void client_send_search(struct client *cl) +void client_search_response(struct client *cl) { - struct session *se = client_get_session(cl); - struct session_database *sdb = client_get_database(cl); - Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_searchRequest); - int ndb; - char **databaselist; - Z_Query *zquery; - int ssub = 0, lslb = 100000, mspn = 10; - const char *piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK); - const char *queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING); - - yaz_log(YLOG_DEBUG, "Sending search to %s", sdb->database->url); - - - // constructing RPN query - a->u.searchRequest->query = zquery = odr_malloc(global_parameters.odr_out, - sizeof(Z_Query)); - zquery->which = Z_Query_type_1; - zquery->u.type_1 = p_query_rpn(global_parameters.odr_out, - client_get_pquery(cl)); - - // converting to target encoding - if (queryenc && *queryenc) + struct connection *co = cl->connection; + ZOOM_connection link = connection_get_link(co); + ZOOM_resultset resultset = cl->resultset; + + const char *error, *addinfo = 0; + + if (ZOOM_connection_error(link, &error, &addinfo)) + { + cl->hits = 0; + client_set_state(cl, Client_Error); + yaz_log(YLOG_WARN, "Search error %s (%s): %s", + error, addinfo, client_get_id(cl)); + } + else { - yaz_iconv_t iconv = yaz_iconv_open(queryenc, "UTF-8"); - if (iconv){ - yaz_query_charset_convert_rpnquery(zquery->u.type_1, - global_parameters.odr_out, - iconv); - yaz_iconv_close(iconv); - } else - yaz_log(YLOG_WARN, "Query encoding failed %s %s", - client_get_database(cl)->database->url, queryenc); + client_report_facets(cl, resultset); + cl->record_offset = cl->startrecs; + cl->hits = ZOOM_resultset_size(resultset); + yaz_log(YLOG_DEBUG, "client_search_response: hits " ODR_INT_PRINTF, + cl->hits); + if (cl->suggestions) + client_suggestions_destroy(cl); + cl->suggestions = + client_suggestions_create(ZOOM_resultset_option_get( + resultset, "suggestions")); } +} + +void client_got_records(struct client *cl) +{ + struct session *se = cl->session; + if (se) + { + if (reclist_get_num_records(se->reclist) > 0) + { + client_unlock(cl); + session_alert_watch(se, SESSION_WATCH_SHOW); + session_alert_watch(se, SESSION_WATCH_BYTARGET); + session_alert_watch(se, SESSION_WATCH_TERMLIST); + session_alert_watch(se, SESSION_WATCH_RECORD); + client_lock(cl); + } + } +} - for (ndb = 0; sdb->database->databases[ndb]; ndb++) - ; - databaselist = odr_malloc(global_parameters.odr_out, sizeof(char*) * ndb); - for (ndb = 0; sdb->database->databases[ndb]; ndb++) - databaselist[ndb] = sdb->database->databases[ndb]; +static void client_record_ingest(struct client *cl) +{ + const char *msg, *addinfo; + ZOOM_record rec = 0; + ZOOM_resultset resultset = cl->resultset; + struct session *se = client_get_session(cl); - if (!piggyback || *piggyback == '1') + if ((rec = ZOOM_resultset_record_immediate(resultset, cl->record_offset))) { - const char *elements = session_setting_oneval(sdb, PZ_ELEMENTS); - const char *recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX); - if (recsyn && *recsyn) + int offset = ++cl->record_offset; + if (cl->session == 0) + ; /* no operation */ + else if (ZOOM_record_error(rec, &msg, &addinfo, 0)) { - a->u.searchRequest->preferredRecordSyntax = - yaz_string_to_oid_odr(yaz_oid_std(), - CLASS_RECSYN, recsyn, - global_parameters.odr_out); + session_log(se, YLOG_WARN, "Record error %s (%s): %s #%d", + msg, addinfo, client_get_id(cl), offset); } - if (elements && *elements) + else { - Z_ElementSetNames *esn = - odr_malloc(global_parameters.odr_out, sizeof(*esn)); - esn->which = Z_ElementSetNames_generic; - esn->u.generic = odr_strdup(global_parameters.odr_out, elements); - - a->u.searchRequest->smallSetElementSetNames = esn; - a->u.searchRequest->mediumSetElementSetNames = esn; + struct session_database *sdb = client_get_database(cl); + NMEM nmem = nmem_create(); + const char *xmlrec; + char type[80]; + + const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX); + if (nativesyntax_to_type(s, type, rec)) + session_log(se, YLOG_WARN, "Failed to determine record type"); + xmlrec = ZOOM_record_get(rec, type, NULL); + if (!xmlrec) + { + const char *rec_syn = ZOOM_record_get(rec, "syntax", NULL); + session_log(se, YLOG_WARN, "ZOOM_record_get failed from %s #%d", + client_get_id(cl), offset); + session_log(se, YLOG_LOG, "pz:nativesyntax=%s . " + "ZOOM record type=%s . Actual record syntax=%s", + s ? s : "null", type, + rec_syn ? rec_syn : "null"); + } + else + { + /* OK = 0, -1 = failure, -2 = Filtered */ + int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem); + if (rc == -1) + { + const char *rec_syn = ZOOM_record_get(rec, "syntax", NULL); + session_log(se, YLOG_WARN, + "Failed to ingest record from %s #%d", + client_get_id(cl), offset); + session_log(se, YLOG_LOG, "pz:nativesyntax=%s . " + "ZOOM record type=%s . Actual record syntax=%s", + s ? s : "null", type, + rec_syn ? rec_syn : "null"); + } + if (rc == -2) + cl->filtered += 1; + } + nmem_destroy(nmem); } - a->u.searchRequest->smallSetUpperBound = &ssub; - a->u.searchRequest->largeSetLowerBound = &lslb; - a->u.searchRequest->mediumSetPresentNumber = &mspn; } - a->u.searchRequest->databaseNames = databaselist; - a->u.searchRequest->num_databaseNames = ndb; - - - { //scope for sending and logging queries - WRBUF wbquery = wrbuf_alloc(); - yaz_query_to_wrbuf(wbquery, a->u.searchRequest->query); + else + { + session_log(se, YLOG_WARN, "Got NULL record from %s #%d", + client_get_id(cl), cl->record_offset); + } +} +void client_record_response(struct client *cl, int *got_records) +{ + struct connection *co = cl->connection; + ZOOM_connection link = connection_get_link(co); + ZOOM_resultset resultset = cl->resultset; + const char *error, *addinfo; - if (send_apdu(cl, a) >= 0) + if (ZOOM_connection_error(link, &error, &addinfo)) + { + client_set_state(cl, Client_Error); + yaz_log(YLOG_WARN, "Search error %s (%s): %s", + error, addinfo, client_get_id(cl)); + } + else + { + if (cl->show_raw && cl->show_raw->active) { - client_set_state(cl, Client_Searching); - client_set_requestid(cl, se->requestid); - yaz_log(YLOG_LOG, "SearchRequest %s %s %s", - client_get_database(cl)->database->url, - queryenc ? queryenc : "UTF-8", - wrbuf_cstr(wbquery)); + ZOOM_record rec = 0; + if ((rec = ZOOM_resultset_record_immediate( + resultset, cl->show_raw->position-1))) + { + cl->show_raw->active = 0; + ingest_raw_record(cl, rec); + } + else + { + yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d", + cl->show_raw->position-1); + } } - else { - client_set_state(cl, Client_Error); - yaz_log(YLOG_WARN, "Failed SearchRequest %s %s %s", - client_get_database(cl)->database->url, - queryenc ? queryenc : "UTF-8", - wrbuf_cstr(wbquery)); + else + { + client_record_ingest(cl); + *got_records = 1; } - - wrbuf_destroy(wbquery); - } - - odr_reset(global_parameters.odr_out); + } } -void client_init_response(struct client *cl, Z_APDU *a) +int client_reingest(struct client *cl) { - Z_InitResponse *r = a->u.initResponse; - - yaz_log(YLOG_DEBUG, "Init response %s", cl->database->database->url); + int i = cl->startrecs; + int to = cl->record_offset; + cl->filtered = 0; - if (*r->result) - cl->state = Client_Idle; - else - cl->state = Client_Failed; // FIXME need to do something to the connection + cl->record_offset = i; + for (; i < to; i++) + client_record_ingest(cl); + return 0; } - -static void ingest_raw_records(struct client *cl, Z_Records *r) +static void client_set_facets_request(struct client *cl, ZOOM_connection link) { - Z_NamePlusRecordList *rlist; - Z_NamePlusRecord *npr; - xmlDoc *doc; - xmlChar *buf_out; - int len_out; - if (r->which != Z_Records_DBOSD) - { - client_show_raw_error(cl, "non-surrogate diagnostics"); - return; - } + struct session_database *sdb = client_get_database(cl); - rlist = r->u.databaseOrSurDiagnostics; - if (rlist->num_records != 1 || !rlist->records || !rlist->records[0]) - { - client_show_raw_error(cl, "no records"); - return; - } - npr = rlist->records[0]; - if (npr->which != Z_NamePlusRecord_databaseRecord) - { - client_show_raw_error(cl, "surrogate diagnostic"); - return; - } + WRBUF w = wrbuf_alloc(); + + struct setting *s; - doc = record_to_xml(client_get_database(cl), npr->u.databaseRecord); - if (!doc) + for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next) { - client_show_raw_error(cl, "unable to convert record to xml"); - return; + const char *p = strchr(s->name + 3, ':'); + if (!p) + { + yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name); + } + else if (s->value && s->value[0]) + { + wrbuf_puts(w, "@attr 1="); + yaz_encode_pqf_term(w, s->value, strlen(s->value)); + if (s->next) + wrbuf_puts(w, ","); + } } + yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w)); + ZOOM_connection_option_set(link, "facets", + wrbuf_len(w) ? wrbuf_cstr(w) : 0); + wrbuf_destroy(w); +} - xmlDocDumpMemory(doc, &buf_out, &len_out); - xmlFreeDoc(doc); +int client_has_facet(struct client *cl, const char *name) +{ + struct session_database *sdb = client_get_database(cl); + struct setting *s; - cl->show_raw->record_handler(cl->show_raw->data, - (const char *) buf_out, len_out); - - xmlFree(buf_out); - xfree(cl->show_raw); - cl->show_raw = 0; + for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next) + { + const char *p = strchr(s->name + 3, ':'); + if (p && !strcmp(name, p + 1)) + return 1; + } + return 0; } -static void ingest_records(struct client *cl, Z_Records *r) +static const char *get_strategy_plus_sort(struct client *l, const char *field) { -#if USE_TIMING - yaz_timing_t t = yaz_timing_create(); -#endif - struct record *rec; - struct session *s = client_get_session(cl); - Z_NamePlusRecordList *rlist; - int i; + struct session_database *sdb = client_get_database(l); + struct setting *s; - if (r->which != Z_Records_DBOSD) - return; - rlist = r->u.databaseOrSurDiagnostics; - for (i = 0; i < rlist->num_records; i++) - { - Z_NamePlusRecord *npr = rlist->records[i]; + const char *strategy_plus_sort = 0; - cl->records++; - if (npr->which != Z_NamePlusRecord_databaseRecord) + for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next) + { + char *p = strchr(s->name + 3, ':'); + if (!p) { - yaz_log(YLOG_WARN, - "Unexpected record type, probably diagnostic %s", - cl->database->database->url); + yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name); continue; } - - rec = ingest_record(cl, npr->u.databaseRecord, cl->records); - if (!rec) - continue; + p++; + if (!strcmp(p, field)) + { + strategy_plus_sort = s->value; + break; + } } - if (rlist->num_records) - session_alert_watch(s, SESSION_WATCH_SHOW); - if (rlist->num_records) - session_alert_watch(s, SESSION_WATCH_RECORD); - -#if USE_TIMING - yaz_timing_stop(t); - yaz_log(YLOG_LOG, "ingest_records %6.5f %3.2f %3.2f", - yaz_timing_get_real(t), yaz_timing_get_user(t), - yaz_timing_get_sys(t)); - yaz_timing_destroy(&t); -#endif + return strategy_plus_sort; } +void client_update_show_stat(struct client *cl, int cmd) +{ + if (cmd == 0) + cl->show_stat_no = 0; + else if (cmd == 1) + cl->show_stat_no++; +} -void client_search_response(struct client *cl, Z_APDU *a) +int client_fetch_more(struct client *cl) { - struct session *se = cl->session; - Z_SearchResponse *r = a->u.searchResponse; + struct session_database *sdb = client_get_database(cl); + const char *str; + int extend_recs = 0; + int number = cl->hits - cl->record_offset; + + str = session_setting_oneval(sdb, PZ_EXTENDRECS); + if (!str || !*str) + return 0; + + extend_recs = atoi(str); - yaz_log(YLOG_DEBUG, "Search response %s (status=%d)", - cl->database->database->url, *r->searchStatus); + yaz_log(YLOG_LOG, "cl=%s show_stat_no=%d got=%d", + client_get_id(cl), cl->show_stat_no, cl->record_offset); + if (cl->show_stat_no < cl->record_offset) + return 0; + yaz_log(YLOG_LOG, "cl=%s Trying to fetch more", client_get_id(cl)); - if (*r->searchStatus) + if (number > extend_recs) + number = extend_recs; + if (number > 0) { - cl->hits = *r->resultCount; - if (cl->hits < 0) - { - yaz_log(YLOG_WARN, "Target %s returns hit count %d", - cl->database->database->url, cl->hits); - } - else - se->total_hits += cl->hits; - if (r->presentStatus && !*r->presentStatus && r->records) - { - yaz_log(YLOG_DEBUG, "Records in search response %s", - cl->database->database->url); - ingest_records(cl, r->records); - } - cl->state = Client_Idle; + ZOOM_resultset set = cl->resultset; + struct connection *co = client_get_connection(cl); + + str = session_setting_oneval(sdb, PZ_REQUESTSYNTAX); + ZOOM_resultset_option_set(set, "preferredRecordSyntax", str); + str = session_setting_oneval(sdb, PZ_ELEMENTS); + if (str && *str) + ZOOM_resultset_option_set(set, "elementSetName", str); + + ZOOM_resultset_records(set, 0, cl->record_offset, number); + client_set_state(cl, Client_Working); + connection_continue(co); + return 1; } else - { /*"FAILED"*/ - Z_Records *recs = r->records; - cl->hits = 0; - cl->state = Client_Error; - if (recs && recs->which == Z_Records_NSD) - { - WRBUF w = wrbuf_alloc(); - - Z_DiagRec dr, *dr_p = &dr; - dr.which = Z_DiagRec_defaultFormat; - dr.u.defaultFormat = recs->u.nonSurrogateDiagnostic; - - wrbuf_printf(w, "Search response NSD %s: ", - cl->database->database->url); - - cl->diagnostic = diag_to_wrbuf(&dr_p, 1, w); + { + yaz_log(YLOG_LOG, "cl=%s. OK no more in total set", client_get_id(cl)); + } + return 0; +} - yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w)); +int client_parse_init(struct client *cl, int same_search) +{ + cl->same_search = same_search; + return 0; +} - cl->state = Client_Error; - wrbuf_destroy(w); - } - else if (recs && recs->which == Z_Records_multipleNSD) - { - WRBUF w = wrbuf_alloc(); +/* + * TODO consider how to extend the range + * */ +int client_parse_range(struct client *cl, const char *startrecs, + const char *maxrecs) +{ + if (maxrecs && atoi(maxrecs) != cl->maxrecs) + { + cl->same_search = 0; + cl->maxrecs = atoi(maxrecs); + } - wrbuf_printf(w, "Search response multipleNSD %s: ", - cl->database->database->url); - cl->diagnostic = - diag_to_wrbuf(recs->u.multipleNonSurDiagnostics->diagRecs, - recs->u.multipleNonSurDiagnostics->num_diagRecs, - w); - yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w)); - cl->state = Client_Error; - wrbuf_destroy(w); - } + if (startrecs && atoi(startrecs) != cl->startrecs) + { + cl->same_search = 0; + cl->startrecs = atoi(startrecs); } + + return 0; } -void client_present_response(struct client *cl, Z_APDU *a) +int client_start_search(struct client *cl) { - Z_PresentResponse *r = a->u.presentResponse; - Z_Records *recs = r->records; - - if (recs && recs->which == Z_Records_NSD) - { - WRBUF w = wrbuf_alloc(); - - Z_DiagRec dr, *dr_p = &dr; - dr.which = Z_DiagRec_defaultFormat; - dr.u.defaultFormat = recs->u.nonSurrogateDiagnostic; - - wrbuf_printf(w, "Present response NSD %s: ", - cl->database->database->url); - - cl->diagnostic = diag_to_wrbuf(&dr_p, 1, w); - - yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w)); - - cl->state = Client_Error; - wrbuf_destroy(w); - - client_show_raw_error(cl, "non surrogate diagnostics"); + struct session_database *sdb = client_get_database(cl); + struct connection *co = 0; + ZOOM_connection link = 0; + struct session *se = client_get_session(cl); + ZOOM_resultset rs; + const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK); + const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING); + const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS); + const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX); + const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS); + const char *opt_sru = session_setting_oneval(sdb, PZ_SRU); + const char *opt_sort = session_setting_oneval(sdb, PZ_SORT); + const char *opt_preferred = session_setting_oneval(sdb, PZ_PREFERRED); + const char *extra_args = session_setting_oneval(sdb, PZ_EXTRA_ARGS); + const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK); + ZOOM_query query; + char maxrecs_str[24], startrecs_str[24], present_chunk_str[24]; + struct timeval tval; + int present_chunk = 20; // Default chunk size + int rc_prep_connection; + + + yaz_gettimeofday(&tval); + tval.tv_sec += 5; + + if (opt_present_chunk && strcmp(opt_present_chunk,"")) { + present_chunk = atoi(opt_present_chunk); + yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk); } - else if (recs && recs->which == Z_Records_multipleNSD) + rc_prep_connection = + client_prep_connection(cl, se->service->z3950_operation_timeout, + se->service->z3950_session_timeout, + se->service->server->iochan_man, + &tval); + /* Nothing has changed and we already have a result */ + if (cl->same_search == 1 && rc_prep_connection == 2) { - WRBUF w = wrbuf_alloc(); - - wrbuf_printf(w, "Present response multipleNSD %s: ", - cl->database->database->url); - cl->diagnostic = - diag_to_wrbuf(recs->u.multipleNonSurDiagnostics->diagRecs, - recs->u.multipleNonSurDiagnostics->num_diagRecs, - w); - yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w)); - cl->state = Client_Error; - wrbuf_destroy(w); + session_log(se, YLOG_LOG, "client %s resuse result", client_get_id(cl)); + return client_reingest(cl); } - else if (recs && !*r->presentStatus && cl->state != Client_Error) + else if (!rc_prep_connection) { - yaz_log(YLOG_DEBUG, "Good Present response %s", - cl->database->database->url); + session_log(se, YLOG_LOG, "client %s postponing search: No connection", + client_get_id(cl)); + client_set_state_nb(cl, Client_Working); + return -1; + } + co = client_get_connection(cl); + assert(cl); + link = connection_get_link(co); + assert(link); - // we can mix show raw and normal show .. - if (cl->show_raw && cl->show_raw->active) - { - cl->show_raw->active = 0; // no longer active - ingest_raw_records(cl, recs); - } - else - ingest_records(cl, recs); - cl->state = Client_Idle; + session_log(se, YLOG_LOG, "client %s new search", client_get_id(cl)); + + cl->diagnostic = 0; + cl->filtered = 0; + + if (extra_args && *extra_args) + ZOOM_connection_option_set(link, "extraArgs", extra_args); + + if (opt_preferred) { + cl->preferred = atoi(opt_preferred); + if (cl->preferred) + yaz_log(YLOG_LOG, "Target %s has preferred status: %d", + client_get_id(cl), cl->preferred); } - else if (*r->presentStatus) + + if (*opt_piggyback) + ZOOM_connection_option_set(link, "piggyback", opt_piggyback); + else + ZOOM_connection_option_set(link, "piggyback", "1"); + if (*opt_queryenc) + ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc); + if (*opt_sru && *opt_elements) + ZOOM_connection_option_set(link, "schema", opt_elements); + else if (*opt_elements) + ZOOM_connection_option_set(link, "elementSetName", opt_elements); + if (*opt_requestsyn) + ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn); + + if (opt_maxrecs && *opt_maxrecs) { - yaz_log(YLOG_WARN, "Bad Present response %s", - cl->database->database->url); - cl->state = Client_Error; - client_show_raw_error(cl, "bad present response"); + cl->maxrecs = atoi(opt_maxrecs); } -} -void client_close_response(struct client *cl, Z_APDU *a) -{ - struct connection *co = cl->connection; - /* Z_Close *r = a->u.close; */ + /* convert back to string representation used in ZOOM API */ + sprintf(maxrecs_str, "%d", cl->maxrecs); + ZOOM_connection_option_set(link, "count", maxrecs_str); - yaz_log(YLOG_WARN, "Close response %s", cl->database->database->url); + /* A present_chunk less than 1 will disable chunking. */ + if (present_chunk > 0 && cl->maxrecs > present_chunk) { + sprintf(present_chunk_str, "%d", present_chunk); + ZOOM_connection_option_set(link, "presentChunk", present_chunk_str); + yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str); + } + else { + ZOOM_connection_option_set(link, "presentChunk", maxrecs_str); + yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str); + } + sprintf(startrecs_str, "%d", cl->startrecs); + ZOOM_connection_option_set(link, "start", startrecs_str); - cl->state = Client_Failed; - connection_destroy(co); -} + /* TODO Verify does it break something for CQL targets(non-SOLR) ? */ + /* facets definition is in PQF */ + client_set_facets_request(cl, link); -int client_is_our_response(struct client *cl) -{ - struct session *se = client_get_session(cl); + query = ZOOM_query_create(); + if (cl->cqlquery) + { + yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl), + cl->cqlquery); + ZOOM_query_cql(query, cl->cqlquery); + if (*opt_sort) + ZOOM_query_sortby(query, opt_sort); + } + else + { + yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), + cl->pquery); - if (cl && (cl->requestid == se->requestid || - cl->state == Client_Initializing)) - return 1; + ZOOM_query_prefix(query, cl->pquery); + } + if (cl->sort_strategy && cl->sort_criteria) { + yaz_log(YLOG_LOG, "Client %s: " + "Set ZOOM sort strategy and criteria: %s %s", + client_get_id(cl), cl->sort_strategy, cl->sort_criteria); + ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria); + } + + yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl)); + client_set_state(cl, Client_Working); + cl->hits = 0; + cl->record_offset = 0; + rs = ZOOM_connection_search(link, query); + ZOOM_query_destroy(query); + ZOOM_resultset_destroy(cl->resultset); + cl->resultset = rs; + connection_continue(co); return 0; } -// Set authentication token in init if one is set for the client -// TODO: Extend this to handle other schemes than open (should be simple) -static void init_authentication(struct client *cl, Z_InitRequest *req) +struct client *client_create(const char *id) { - struct session_database *sdb = client_get_database(cl); - const char *auth = session_setting_oneval(sdb, PZ_AUTHENTICATION); - - if (*auth) - { - struct connection *co = client_get_connection(cl); - struct session *se = client_get_session(cl); - Z_IdAuthentication *idAuth = odr_malloc(global_parameters.odr_out, - sizeof(*idAuth)); - idAuth->which = Z_IdAuthentication_open; - idAuth->u.open = odr_strdup(global_parameters.odr_out, auth); - req->idAuthentication = idAuth; - connection_set_authentication(co, nmem_strdup(se->session_nmem, auth)); - } + struct client *cl = xmalloc(sizeof(*cl)); + cl->maxrecs = 100; + cl->startrecs = 0; + cl->pquery = 0; + cl->cqlquery = 0; + cl->addinfo = 0; + cl->message = 0; + cl->database = 0; + cl->connection = 0; + cl->session = 0; + cl->hits = 0; + cl->record_offset = 0; + cl->filtered = 0; + cl->diagnostic = 0; + cl->state = Client_Disconnected; + cl->show_raw = 0; + cl->resultset = 0; + cl->suggestions = 0; + cl->mutex = 0; + pazpar2_mutex_create(&cl->mutex, "client"); + cl->preferred = 0; + cl->ref_count = 1; + cl->facet_limits = 0; + cl->sort_strategy = 0; + cl->sort_criteria = 0; + assert(id); + cl->id = xstrdup(id); + client_use(1); + + yaz_log(YLOG_DEBUG, "client_create c=%p %s", cl, id); + return cl; } -static void init_zproxy(struct client *cl, Z_InitRequest *req) +void client_lock(struct client *c) { - struct session_database *sdb = client_get_database(cl); - char *ztarget = sdb->database->url; - //char *ztarget = sdb->url; - const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY); - - if (*zproxy) - yaz_oi_set_string_oid(&req->otherInfo, - global_parameters.odr_out, - yaz_oid_userinfo_proxy, - 1, ztarget); + yaz_mutex_enter(c->mutex); } - -static void client_init_request(struct client *cl) +void client_unlock(struct client *c) { - Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_initRequest); - - a->u.initRequest->implementationId = global_parameters.implementationId; - a->u.initRequest->implementationName = global_parameters.implementationName; - a->u.initRequest->implementationVersion = - global_parameters.implementationVersion; - ODR_MASK_SET(a->u.initRequest->options, Z_Options_search); - ODR_MASK_SET(a->u.initRequest->options, Z_Options_present); - ODR_MASK_SET(a->u.initRequest->options, Z_Options_namedResultSets); - - ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_1); - ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_2); - ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_3); - - init_authentication(cl, a->u.initRequest); - init_zproxy(cl, a->u.initRequest); + yaz_mutex_leave(c->mutex); +} - if (send_apdu(cl, a) >= 0) - client_set_state(cl, Client_Initializing); - else - client_set_state(cl, Client_Error); - odr_reset(global_parameters.odr_out); +void client_incref(struct client *c) +{ + pazpar2_incref(&c->ref_count, c->mutex); + yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d", + c, client_get_id(c), c->ref_count); } -void client_continue(struct client *cl) +int client_destroy(struct client *c) { - if (cl->state == Client_Connected) { - client_init_request(cl); - } - if (cl->state == Client_Idle) + if (c) { - struct session *se = client_get_session(cl); - if (cl->requestid != se->requestid && cl->pquery) { - // we'll have to abort this because result set is to be deleted - client_show_raw_cancel(cl); - client_send_search(cl); - } - else if (cl->show_raw) + yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d", + c, client_get_id(c), c->ref_count); + if (!pazpar2_decref(&c->ref_count, c->mutex)) { - client_send_raw_present(cl); - } - else if (cl->hits > 0 && cl->records < global_parameters.toget && - cl->records < cl->hits) { - client_send_present(cl); + xfree(c->pquery); + c->pquery = 0; + xfree(c->cqlquery); + c->cqlquery = 0; + xfree(c->addinfo); + c->addinfo = 0; + xfree(c->message); + c->message = 0; + xfree(c->id); + xfree(c->sort_strategy); + xfree(c->sort_criteria); + assert(!c->connection); + facet_limits_destroy(c->facet_limits); + + if (c->resultset) + { + ZOOM_resultset_destroy(c->resultset); + } + yaz_mutex_destroy(&c->mutex); + xfree(c); + client_use(-1); + return 1; } } + return 0; } -struct client *client_create(void) +void client_set_connection(struct client *cl, struct connection *con) { - struct client *r; - if (client_freelist) + if (cl->resultset) + ZOOM_resultset_release(cl->resultset); + if (con) { - r = client_freelist; - client_freelist = client_freelist->next; + assert(cl->connection == 0); + cl->connection = con; + client_incref(cl); } else - r = xmalloc(sizeof(struct client)); - r->pquery = 0; - r->database = 0; - r->connection = 0; - r->session = 0; - r->hits = 0; - r->records = 0; - r->setno = 0; - r->requestid = -1; - r->diagnostic = 0; - r->state = Client_Disconnected; - r->show_raw = 0; - r->next = 0; - return r; -} - -void client_destroy(struct client *c) -{ - struct session *se = c->session; - if (c == se->clients) - se->clients = c->next; - else { - struct client *cc; - for (cc = se->clients; cc && cc->next != c; cc = cc->next) - ; - if (cc) - cc->next = c->next; + cl->connection = con; + client_destroy(cl); } - xfree(c->pquery); - - if (c->connection) - connection_release(c->connection); - c->next = client_freelist; - client_freelist = c; -} - -void client_set_connection(struct client *cl, struct connection *con) -{ - cl->connection = con; } void client_disconnect(struct client *cl) { if (cl->state != Client_Idle) - cl->state = Client_Disconnected; + client_set_state(cl, Client_Disconnected); client_set_connection(cl, 0); } -// Extract terms from query into null-terminated termlist -static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist) -{ - int num = 0; - - pull_terms(nmem, query, termlist, &num); - termlist[num] = 0; -} - // Initialize CCL map for a target -static CCL_bibset prepare_cclmap(struct client *cl) +static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset) { struct session_database *sdb = client_get_database(cl); struct setting *s; @@ -912,121 +1091,640 @@ static CCL_bibset prepare_cclmap(struct client *cl) if (!sdb->settings) return 0; - res = ccl_qual_mk(); + if (base_bibset) + res = ccl_qual_dup(base_bibset); + else + res = ccl_qual_mk(); for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next) { + const char *addinfo = 0; char *p = strchr(s->name + 3, ':'); if (!p) { - yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name); + WRBUF w = wrbuf_alloc(); + wrbuf_printf(w, "Malformed cclmap. name=%s", s->name); + yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w)); + client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG, + ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG), + wrbuf_cstr(w)); + client_set_state_nb(cl, Client_Error); ccl_qual_rm(&res); + wrbuf_destroy(w); return 0; } p++; - ccl_qual_fitem(res, s->value, p); + if (ccl_qual_fitem2(res, s->value, p, &addinfo)) + { + WRBUF w = wrbuf_alloc(); + + wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)", + s->name, p, addinfo); + yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w)); + client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG, + ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG), + wrbuf_cstr(w)); + client_set_state_nb(cl, Client_Error); + ccl_qual_rm(&res); + wrbuf_destroy(w); + return 0; + } } return res; } +// returns a xmalloced CQL query corresponding to the pquery in client +static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery) +{ + cql_transform_t cqlt = cql_transform_create(); + char *r = 0; + WRBUF wrb = wrbuf_alloc(); + int status; + + if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery))) + { + yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status); + } + else + { + r = xstrdup(wrbuf_cstr(wrb)); + } + wrbuf_destroy(wrb); + cql_transform_close(cqlt); + return r; +} + +// returns a xmalloced SOLR query corresponding to the pquery in client +// TODO Could prob. be merge with the similar make_cqlquery +static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery) +{ + solr_transform_t sqlt = solr_transform_create(); + char *r = 0; + WRBUF wrb = wrbuf_alloc(); + int status; + + if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery))) + { + yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status); + } + else + { + r = xstrdup(wrbuf_cstr(wrb)); + } + wrbuf_destroy(wrb); + solr_transform_close(sqlt); + return r; +} + +const char *client_get_facet_limit_local(struct client *cl, + struct session_database *sdb, + int *l, + NMEM nmem, int *num, char ***values) +{ + const char *name = 0; + const char *value = 0; + for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++) + { + struct setting *s = 0; + + for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next) + { + const char *p = strchr(s->name + 3, ':'); + if (p && !strcmp(p + 1, name) && s->value) + { + int j, cnum; + char **cvalues; + nmem_strsplit_escape2(nmem, ",", s->value, &cvalues, + &cnum, 1, '\\', 1); + for (j = 0; j < cnum; j++) + { + const char *cvalue = cvalues[j]; + while (*cvalue == ' ') + cvalue++; + if (!strncmp(cvalue, "local:", 6)) + { + const char *cp = cvalue + 6; + while (*cp == ' ') + cp++; + nmem_strsplit_escape2(nmem, "|", value, values, + num, 1, '\\', 1); + (*l)++; + return *cp ? cp : name; + } + } + } + } + } + return 0; +} + +static int apply_limit(struct session_database *sdb, + facet_limits_t facet_limits, + WRBUF w_pqf, CCL_bibset ccl_map, + struct conf_service *service) +{ + int ret = 0; + int i = 0; + const char *name; + const char *value; + + NMEM nmem_tmp = nmem_create(); + for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++) + { + struct setting *s = 0; + nmem_reset(nmem_tmp); + /* name="pz:limitmap:author" value="rpn:@attr 1=4|local:other" */ + for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next) + { + const char *p = strchr(s->name + 3, ':'); + if (p && !strcmp(p + 1, name) && s->value) + { + char **values = 0; + int i, num = 0; + char **cvalues = 0; + int j, cnum = 0; + nmem_strsplit_escape2(nmem_tmp, "|", value, &values, + &num, 1, '\\', 1); + + nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues, + &cnum, 1, '\\', 1); + + for (j = 0; ret == 0 && j < cnum; j++) + { + const char *cvalue = cvalues[j]; + while (*cvalue == ' ') + cvalue++; + if (!strncmp(cvalue, "rpn:", 4)) + { + const char *pqf = cvalue + 4; + wrbuf_puts(w_pqf, "@and "); + wrbuf_puts(w_pqf, pqf); + wrbuf_puts(w_pqf, " "); + for (i = 0; i < num; i++) + { + if (i < num - 1) + wrbuf_puts(w_pqf, "@or "); + yaz_encode_pqf_term(w_pqf, values[i], + strlen(values[i])); + } + } + else if (!strncmp(cvalue, "ccl:", 4)) + { + const char *ccl = cvalue + 4; + WRBUF ccl_w = wrbuf_alloc(); + for (i = 0; i < num; i++) + { + int cerror, cpos; + struct ccl_rpn_node *cn; + wrbuf_rewind(ccl_w); + wrbuf_puts(ccl_w, ccl); + wrbuf_puts(ccl_w, "=\""); + wrbuf_puts(ccl_w, values[i]); + wrbuf_puts(ccl_w, "\""); + + cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w), + &cerror, &cpos); + if (cn) + { + if (i == 0) + wrbuf_printf(w_pqf, "@and "); + + /* or multiple values.. could be bad if last + CCL parse fails, but this is unlikely to + happen */ + if (i < num - 1) + wrbuf_printf(w_pqf, "@or "); + ccl_pquery(w_pqf, cn); + ccl_rpn_delete(cn); + } + } + wrbuf_destroy(ccl_w); + } + else if (!strncmp(cvalue, "local:", 6)) { + /* no operation */ + } + else + { + yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'", + sdb->database->id, cvalue); + ret = -1; /* bad limitmap */ + } + } + break; + } + } + if (!s) + { + int i; + for (i = 0; i < service->num_metadata; i++) + { + struct conf_metadata *md = service->metadata + i; + if (!strcmp(md->name, name) && md->limitcluster) + { + yaz_log(YLOG_LOG, "limitcluster in use for %s", + md->name); + break; + } + } + if (i == service->num_metadata) + { + yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined", + (sdb->database ? sdb->database->id : ""), name); + } + } + } + nmem_destroy(nmem_tmp); + return ret; +} + // Parse the query given the settings specific to this client -int client_parse_query(struct client *cl, const char *query) +// client variable same_search is set as below as well as returned: +// 0 if query is OK but different from before +// 1 if query is OK but same as before +// return -1 on query error +// return -2 on limit error +int client_parse_query(struct client *cl, const char *query, + facet_limits_t facet_limits, const char **error_msg) { struct session *se = client_get_session(cl); + struct conf_service *service = se->service; + struct session_database *sdb = client_get_database(cl); struct ccl_rpn_node *cn; int cerror, cpos; - CCL_bibset ccl_map = prepare_cclmap(cl); + ODR odr_out; + CCL_bibset ccl_map = prepare_cclmap(cl, service->ccl_bibset); + const char *sru = session_setting_oneval(sdb, PZ_SRU); + const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX); + const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME); + const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX); + WRBUF w_ccl, w_pqf; + int ret_value = 1; + Z_RPNQuery *zquery; if (!ccl_map) - return -1; + return -3; + + w_ccl = wrbuf_alloc(); + wrbuf_puts(w_ccl, query); + + w_pqf = wrbuf_alloc(); + if (*pqf_prefix) + { + wrbuf_puts(w_pqf, pqf_prefix); + wrbuf_puts(w_pqf, " "); + } - cn = ccl_find_str(ccl_map, query, &cerror, &cpos); + if (apply_limit(sdb, facet_limits, w_pqf, ccl_map, service)) + { + ccl_qual_rm(&ccl_map); + return -2; + } + + facet_limits_destroy(cl->facet_limits); + cl->facet_limits = facet_limits_dup(facet_limits); + + yaz_log(YLOG_LOG, "Client %s: CCL query: %s limit: %s", + client_get_id(cl), wrbuf_cstr(w_ccl), wrbuf_cstr(w_pqf)); + cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos); ccl_qual_rm(&ccl_map); if (!cn) { - cl->state = Client_Error; - yaz_log(YLOG_WARN, "Failed to parse query for %s", - client_get_database(cl)->database->url); + if (error_msg) + *error_msg = ccl_err_msg(cerror); + client_set_state(cl, Client_Error); + session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'", + client_get_id(cl), + wrbuf_cstr(w_ccl)); + wrbuf_destroy(w_ccl); + wrbuf_destroy(w_pqf); return -1; } - wrbuf_rewind(se->wrbuf); - ccl_pquery(se->wrbuf, cn); - xfree(cl->pquery); - cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf)); + wrbuf_destroy(w_ccl); + + if (!pqf_strftime || !*pqf_strftime) + ccl_pquery(w_pqf, cn); + else + { + time_t cur_time = time(0); + struct tm *tm = localtime(&cur_time); + char tmp_str[300]; + const char *cp = tmp_str; + + /* see man strftime(3) for things .. In particular %% gets converted + to %.. And That's our original query .. */ + strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm); + for (; *cp; cp++) + { + if (cp[0] == '%') + ccl_pquery(w_pqf, cn); + else + wrbuf_putc(w_pqf, cp[0]); + } + } + + /* Compares query and limit with old one. If different we need to research */ + if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf))) + { + if (cl->pquery) + session_log(se, YLOG_LOG, "Client %s: " + "Re-search due query/limit change: %s to %s", + client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf)); + xfree(cl->pquery); + cl->pquery = xstrdup(wrbuf_cstr(w_pqf)); + // return value is no longer used. + ret_value = 0; + // Need to (re)search + cl->same_search= 0; + } + wrbuf_destroy(w_pqf); + + xfree(cl->cqlquery); + cl->cqlquery = 0; + + odr_out = odr_createmem(ODR_ENCODE); + zquery = p_query_rpn(odr_out, cl->pquery); + if (!zquery) + { + + session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s", + client_get_id(cl), cl->pquery); + ret_value = -1; + *error_msg = "Invalid PQF after CCL to PQF conversion"; + } + else + { + session_log(se, YLOG_LOG, "PQF for Client %s: %s", + client_get_id(cl), cl->pquery); + + /* Support for PQF on SRU targets. */ + if (strcmp(query_syntax, "pqf") != 0 && *sru) + { + if (!strcmp(sru, "solr")) + cl->cqlquery = make_solrquery(cl, zquery); + else + cl->cqlquery = make_cqlquery(cl, zquery); + if (!cl->cqlquery) + { + *error_msg = "Cannot convert PQF to Solr/CQL"; + ret_value = -1; + } + else + session_log(se, YLOG_LOG, "Client %s native query: %s (%s)", + client_get_id(cl), cl->cqlquery, sru); + } + } + odr_destroy(odr_out); + /* TODO FIX Not thread safe */ if (!se->relevance) { // Initialize relevance structure with query terms - char *p[512]; - extract_terms(se->nmem, cn, p); - se->relevance = relevance_create( - global_parameters.server->relevance_pct, - se->nmem, (const char **) p, - se->expected_maxrecs); + se->relevance = relevance_create_ccl(se->service->charsets, cn, + se->service->rank_cluster, + se->service->rank_follow, + se->service->rank_lead, + se->service->rank_length); } - ccl_rpn_delete(cn); - return 0; + return ret_value; +} + +int client_parse_sort(struct client *cl, struct reclist_sortparms *sp) +{ + if (sp) + { + const char *sort_strategy_and_spec = + get_strategy_plus_sort(cl, sp->name); + int increasing = sp->increasing; + if (!strcmp(sp->name, "relevance")) + increasing = 1; + if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40) + { + char strategy[50], *p; + strcpy(strategy, sort_strategy_and_spec); + p = strchr(strategy, ':'); + if (p) + { + // Split the string in two + *p++ = 0; + while (*p == ' ') + p++; + if (increasing) + strcat(p, " <"); + else + strcat(p, " >"); + yaz_log(YLOG_LOG, "Client %s: " + "applying sorting %s %s", client_get_id(cl), + strategy, p); + if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy)) + cl->same_search = 0; + if (!cl->sort_criteria || strcmp(cl->sort_criteria, p)) + cl->same_search = 0; + if (cl->same_search == 0) { + xfree(cl->sort_strategy); + cl->sort_strategy = xstrdup(strategy); + xfree(cl->sort_criteria); + cl->sort_criteria = xstrdup(p); + } + } + else { + yaz_log(YLOG_LOG, "Client %s: " + "Invalid sort strategy and spec found %s", + client_get_id(cl), sort_strategy_and_spec); + xfree(cl->sort_strategy); + cl->sort_strategy = 0; + xfree(cl->sort_criteria); + cl->sort_criteria = 0; + } + } + else + { + yaz_log(YLOG_DEBUG, "Client %s: " + "No sort strategy and spec found.", client_get_id(cl)); + xfree(cl->sort_strategy); + cl->sort_strategy = 0; + xfree(cl->sort_criteria); + cl->sort_criteria = 0; + } + + } + return !cl->same_search; } void client_set_session(struct client *cl, struct session *se) { cl->session = se; - cl->next = se->clients; - se->clients = cl; } int client_is_active(struct client *cl) { if (cl->connection && (cl->state == Client_Connecting || - cl->state == Client_Initializing || - cl->state == Client_Searching || - cl->state == Client_Presenting)) + cl->state == Client_Working)) return 1; return 0; } -struct client *client_next_in_session(struct client *cl) +int client_is_active_preferred(struct client *cl) { - if (cl) - return cl->next; + /* only count if this is a preferred target. */ + if (!cl->preferred) + return 0; + /* TODO No sure this the condition that Seb wants */ + if (cl->connection && (cl->state == Client_Connecting || + cl->state == Client_Working)) + return 1; return 0; +} +Odr_int client_get_hits(struct client *cl) +{ + return cl->hits; } -int client_get_hits(struct client *cl) +Odr_int client_get_approximation(struct client *cl) { + if (cl->record_offset > 0) + { + Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered)) + / cl->record_offset + 5) /10; + 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); + return approx; + } return cl->hits; } int client_get_num_records(struct client *cl) { - return cl->records; + return cl->record_offset; } -int client_get_diagnostic(struct client *cl) +int client_get_num_records_filtered(struct client *cl) { + return cl->filtered; +} + +void client_set_diagnostic(struct client *cl, int diagnostic, + const char *message, const char *addinfo) +{ + cl->diagnostic = diagnostic; + xfree(cl->message); + cl->message = xstrdup(message); + xfree(cl->addinfo); + cl->addinfo = 0; + if (addinfo) + cl->addinfo = xstrdup(addinfo); +} + +int client_get_diagnostic(struct client *cl, const char **message, + const char **addinfo) +{ + if (message) + *message = cl->message; + if (addinfo) + *addinfo = cl->addinfo; return cl->diagnostic; } +const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf) +{ + /* int idx; */ + struct suggestions *suggestions = cl->suggestions; + + if (!suggestions) + return ""; + if (suggestions->passthrough) + { + yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n", + suggestions->passthrough); + return suggestions->passthrough; + } + if (suggestions->num == 0) + return ""; + /* + for (idx = 0; idx < suggestions->num; idx++) { + wrbuf_printf(wrbuf, "suggest[idx]); + if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) { + wrbuf_puts(wrbuf, suggestions->misspelled[idx]); + wrbuf_puts(wrbuf, "\n"); + } + else + wrbuf_puts(wrbuf, "/>\n"); + } + */ + return wrbuf_cstr(wrbuf); +} + + void client_set_database(struct client *cl, struct session_database *db) { cl->database = db; } -struct host *client_get_host(struct client *cl) +const char *client_get_id(struct client *cl) { - return client_get_database(cl)->database->host; + return cl->id; } -const char *client_get_url(struct client *cl) +int client_get_maxrecs(struct client *cl) { - return client_get_database(cl)->database->url; + return cl->maxrecs; +} + +void client_set_preferred(struct client *cl, int v) +{ + cl->preferred = v; +} + + +struct suggestions* client_suggestions_create(const char* suggestions_string) +{ + int i; + NMEM nmem; + struct suggestions *suggestions; + if (suggestions_string == 0 || suggestions_string[0] == 0 ) + return 0; + nmem = nmem_create(); + suggestions = nmem_malloc(nmem, sizeof(*suggestions)); + yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string); + + suggestions->nmem = nmem; + suggestions->num = 0; + suggestions->misspelled = 0; + suggestions->suggest = 0; + suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string); + + if (suggestions_string) + nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest, + &suggestions->num, 1, '\\', 0); + /* Set up misspelled array */ + suggestions->misspelled = (char **) + nmem_malloc(nmem, suggestions->num * sizeof(*suggestions->misspelled)); + /* replace = with \0 .. for each item */ + for (i = 0; i < suggestions->num; i++) + { + char *cp = strchr(suggestions->suggest[i], '='); + if (cp) { + *cp = '\0'; + suggestions->misspelled[i] = cp+1; + } + } + return suggestions; +} + +static void client_suggestions_destroy(struct client *cl) +{ + NMEM nmem = cl->suggestions->nmem; + cl->suggestions = 0; + nmem_destroy(nmem); } /* * Local variables: * c-basic-offset: 4 + * c-file-style: "Stroustrup" * indent-tabs-mode: nil * End: * vim: shiftwidth=4 tabstop=8 expandtab */ +