X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fclient.c;h=00d92adf7bf3adad28d80e17a0a2f8a77102e464;hb=446f32183265d59ee79e2859376c598fa24408e0;hp=16099ba7d13782bf2071fa3468863853fd0d7ca2;hpb=5b3c0fa381448c474b59959e0443870f2e6bc7ef;p=pazpar2-moved-to-github.git diff --git a/src/client.c b/src/client.c index 16099ba..00d92ad 100644 --- a/src/client.c +++ b/src/client.c @@ -1,5 +1,5 @@ /* This file is part of Pazpar2. - Copyright (C) 2006-2011 Index Data + Copyright (C) 2006-2012 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 @@ -18,7 +18,7 @@ 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 @@ -108,19 +108,30 @@ struct client { struct session *session; char *pquery; // Current search char *cqlquery; // used for SRU targets only + char *addinfo; // diagnostic info for most resent error Odr_int hits; int record_offset; + int filtered; // When using local:, this will count the number of filtered records. int maxrecs; int startrecs; int diagnostic; int preferred; + struct suggestions *suggestions; enum client_state state; struct show_raw *show_raw; ZOOM_resultset resultset; YAZ_MUTEX mutex; int ref_count; - /* copy of database->url */ - char *url; + char *id; + facet_limits_t facet_limits; +}; + +struct suggestions { + NMEM nmem; + int num; + char **misspelled; + char **suggest; + char *passthrough; }; struct show_raw { @@ -129,6 +140,7 @@ struct show_raw { 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; @@ -154,6 +166,11 @@ enum client_state client_get_state(struct client *cl) return cl->state; } +void client_set_state_nb(struct client *cl, enum client_state st) +{ + cl->state = st; +} + void client_set_state(struct client *cl, enum client_state st) { int was_active = 0; @@ -167,9 +184,12 @@ void client_set_state(struct client *cl, enum client_state st) { int no_active = session_active_clients(cl->session); - yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d", client_get_url(cl), no_active); + 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); } } @@ -198,15 +218,15 @@ const char *client_get_pquery(struct client *cl) } static void client_send_raw_present(struct client *cl); -static int nativesyntax_to_type(struct session_database *sdb, char *type, - ZOOM_record rec); +static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec); 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) + int binary, + const char *nativesyntax) { ZOOM_record rec = 0; char type[80]; @@ -218,16 +238,13 @@ static void client_show_immediate( error_handler(data, "no resultset"); return; } - rec = ZOOM_resultset_record(resultset, position-1); + rec = ZOOM_resultset_record_immediate(resultset, position-1); if (!rec) { error_handler(data, "no record"); return; } - if (binary) - strcpy(type, "raw"); - else - nativesyntax_to_type(sdb, type, rec); + nativesyntax_to_type(nativesyntax, type, rec); buf = ZOOM_record_get(rec, type, &len); if (!buf) { @@ -244,20 +261,32 @@ int client_show_raw_begin(struct client *cl, int position, void (*error_handler)(void *data, const char *addinfo), void (*record_handler)(void *data, const char *buf, size_t sz), - int binary) + int binary, + const char *nativesyntax) { + if (!nativesyntax) + { + 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); + binary, nativesyntax); else { struct show_raw *rr, **rrp; if (!cl->connection) return -1; - + rr = xmalloc(sizeof(*rr)); rr->position = position; @@ -274,12 +303,16 @@ int client_show_raw_begin(struct client *cl, int position, 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"); @@ -300,6 +333,7 @@ static void client_show_raw_delete(struct show_raw *r) { xfree(r->syntax); xfree(r->esn); + xfree(r->nativesyntax); xfree(r); } @@ -347,7 +381,7 @@ static void client_send_raw_present(struct client *cl) assert(set); yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d", - client_get_url(cl), 1, offset); + client_get_id(cl), 1, offset); if (cl->show_raw->syntax) syntax = cl->show_raw->syntax; @@ -368,11 +402,9 @@ static void client_send_raw_present(struct client *cl) connection_continue(co); } -static int nativesyntax_to_type(struct session_database *sdb, char *type, +static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec) { - const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX); - if (s && *s) { if (!strncmp(s, "iso2709", 7)) @@ -380,17 +412,13 @@ static int nativesyntax_to_type(struct session_database *sdb, char *type, const char *cp = strchr(s, ';'); yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s"); } - else if (!strncmp(s, "xml", 3)) - { - strcpy(type, "xml"); - } else if (!strncmp(s, "txml", 4)) { const char *cp = strchr(s, ';'); yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s"); } - else - return -1; + else /* pass verbatim to ZOOM - including "xml" */ + strcpy(type, s); return 0; } else /* attempt to deduce structure */ @@ -403,11 +431,6 @@ static int nativesyntax_to_type(struct session_database *sdb, char *type, strcpy(type, "xml"); return 0; } - else if (!strcmp(syntax, "TXML")) - { - strcpy(type, "txml"); - return 0; - } else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21")) { strcpy(type, "xml; charset=marc8-s"); @@ -473,14 +496,7 @@ static void ingest_raw_record(struct client *cl, ZOOM_record rec) int len; char type[80]; - if (cl->show_raw->binary) - strcpy(type, "raw"); - else - { - struct session_database *sdb = client_get_database(cl); - nativesyntax_to_type(sdb, type, rec); - } - + 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); @@ -489,7 +505,7 @@ static void ingest_raw_record(struct client *cl, ZOOM_record rec) void client_check_preferred_watch(struct client *cl) { struct session *se = cl->session; - yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_url(cl)); + yaz_log(YLOG_DEBUG, "client_check_preferred_watch: %s ", client_get_id(cl)); if (se) { client_unlock(cl); @@ -503,38 +519,37 @@ void client_check_preferred_watch(struct client *cl) client_lock(cl); } else - yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_url(cl)); + 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_search_response(struct client *cl) { struct connection *co = cl->connection; - struct session *se = cl->session; 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_url(cl)); + error, addinfo, client_get_id(cl)); } else { - yaz_log(YLOG_DEBUG, "client_search_response: hits " - ODR_INT_PRINTF, cl->hits); client_report_facets(cl, resultset); cl->record_offset = cl->startrecs; cl->hits = ZOOM_resultset_size(resultset); - if (se) { - se->total_hits += cl->hits; - yaz_log(YLOG_DEBUG, "client_search_response: total hits " - ODR_INT_PRINTF, se->total_hits); - } + 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")); } } @@ -543,10 +558,65 @@ void client_got_records(struct client *cl) struct session *se = cl->session; if (se) { - client_unlock(cl); - session_alert_watch(se, SESSION_WATCH_SHOW); - session_alert_watch(se, SESSION_WATCH_RECORD); - client_lock(cl); + 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); + } + } +} + +static void client_record_ingest(struct client *cl) +{ + const char *msg, *addinfo; + ZOOM_record rec = 0; + ZOOM_resultset resultset = cl->resultset; + int offset = cl->record_offset; + if ((rec = ZOOM_resultset_record_immediate(resultset, offset))) + { + cl->record_offset++; + if (cl->session == 0) { + /* no operation */ + } + else if (ZOOM_record_error(rec, &msg, &addinfo, 0)) + { + yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)", + msg, addinfo, client_get_id(cl), cl->record_offset); + } + else + { + 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)) + yaz_log(YLOG_WARN, "Failed to determine record type"); + xmlrec = ZOOM_record_get(rec, type, NULL); + if (!xmlrec) + yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s", + client_get_id(cl)); + else + { + /* OK = 0, -1 = failure, -2 = Filtered */ + int rc = ingest_record(cl, xmlrec, cl->record_offset, nmem); + if (rc == -1) + yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_id(cl)); + if (rc == -2) + cl->filtered += 1; + } + nmem_destroy(nmem); + } + } + else + { + yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d", + offset); } } @@ -561,17 +631,15 @@ void client_record_response(struct client *cl) { client_set_state(cl, Client_Error); yaz_log(YLOG_WARN, "Search error %s (%s): %s", - error, addinfo, client_get_url(cl)); + error, addinfo, client_get_id(cl)); } else { - ZOOM_record rec = 0; - const char *msg, *addinfo; - if (cl->show_raw && cl->show_raw->active) { - if ((rec = ZOOM_resultset_record(resultset, - cl->show_raw->position-1))) + 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); @@ -584,55 +652,28 @@ void client_record_response(struct client *cl) } else { - int offset = cl->record_offset; - if ((rec = ZOOM_resultset_record(resultset, offset))) - { - cl->record_offset++; - if (cl->session == 0) - ; - else if (ZOOM_record_error(rec, &msg, &addinfo, 0)) - { - yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)", - msg, addinfo, client_get_url(cl), - cl->record_offset); - } - else - { - struct session_database *sdb = client_get_database(cl); - NMEM nmem = nmem_create(); - const char *xmlrec; - char type[80]; - - if (nativesyntax_to_type(sdb, type, rec)) - yaz_log(YLOG_WARN, "Failed to determine record type"); - xmlrec = ZOOM_record_get(rec, type, NULL); - if (!xmlrec) - yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s", - client_get_url(cl)); - else - { - /* OK = 0, -1 = failure, -2 = Filtered */ - if (ingest_record(cl, xmlrec, cl->record_offset, nmem) == -1) - yaz_log(YLOG_WARN, "Failed to ingest from %s", client_get_url(cl)); - } - nmem_destroy(nmem); - } - } - else - { - yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d", - offset); - } + client_record_ingest(cl); } } } +void client_reingest(struct client *cl) +{ + int i = cl->startrecs; + int to = cl->record_offset; + cl->filtered = 0; + + cl->record_offset = i; + for (; i < to; i++) + client_record_ingest(cl); +} + static void client_set_facets_request(struct client *cl, ZOOM_connection link) { struct session_database *sdb = client_get_database(cl); WRBUF w = wrbuf_alloc(); - + struct setting *s; for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next) @@ -650,7 +691,7 @@ static void client_set_facets_request(struct client *cl, ZOOM_connection link) wrbuf_puts(w, ","); } } - yaz_log(YLOG_LOG, "using facets str: %s", wrbuf_cstr(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); @@ -670,13 +711,38 @@ int client_has_facet(struct client *cl, const char *name) return 0; } +static const char *get_strategy_plus_sort(struct client *l, const char *field) +{ + struct session_database *sdb = client_get_database(l); + struct setting *s; + + const char *strategy_plus_sort = 0; + + for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next) + { + char *p = strchr(s->name + 3, ':'); + if (!p) + { + yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name); + continue; + } + p++; + if (!strcmp(p, field)) + { + strategy_plus_sort = s->value; + break; + } + } + return strategy_plus_sort; +} + void client_start_search(struct client *cl) { struct session_database *sdb = client_get_database(cl); struct connection *co = client_get_connection(cl); ZOOM_connection link = connection_get_link(co); + struct session *se = client_get_session(cl); ZOOM_resultset rs; - char *databaseName = sdb->database->databases[0]; 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); @@ -686,13 +752,18 @@ void client_start_search(struct client *cl) 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); - char maxrecs_str[24], startrecs_str[24]; - + const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK); + ZOOM_query q; + char maxrecs_str[24], startrecs_str[24], present_chunk_str[24]; + int present_chunk = 20; // Default chunk size + 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); + } assert(link); - cl->hits = -1; - cl->record_offset = 0; cl->diagnostic = 0; + cl->filtered = 0; if (extra_args && *extra_args) ZOOM_connection_option_set(link, "extraArgs", extra_args); @@ -700,9 +771,9 @@ void client_start_search(struct client *cl) if (opt_preferred) { cl->preferred = atoi(opt_preferred); if (cl->preferred) - yaz_log(YLOG_LOG, "Target %s has preferred status: %d", sdb->database->url, cl->preferred); + yaz_log(YLOG_LOG, "Target %s has preferred status: %d", + client_get_id(cl), cl->preferred); } - client_set_state(cl, Client_Working); if (*opt_piggyback) ZOOM_connection_option_set(link, "piggyback", opt_piggyback); @@ -726,64 +797,112 @@ void client_start_search(struct client *cl) sprintf(maxrecs_str, "%d", cl->maxrecs); ZOOM_connection_option_set(link, "count", maxrecs_str); - if (cl->maxrecs > 20) - ZOOM_connection_option_set(link, "presentChunk", "20"); - else + /* 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); - if (databaseName) - ZOOM_connection_option_set(link, "databaseName", databaseName); - /* TODO Verify does it break something for CQL targets(non-SOLR) ? */ /* facets definition is in PQF */ client_set_facets_request(cl, link); + q = ZOOM_query_create(); if (cl->cqlquery) { - ZOOM_query q = ZOOM_query_create(); - yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery); + yaz_log(YLOG_LOG, "Client %s: Search CQL: %s", client_get_id(cl), cl->cqlquery); ZOOM_query_cql(q, cl->cqlquery); if (*opt_sort) ZOOM_query_sortby(q, opt_sort); - rs = ZOOM_connection_search(link, q); - ZOOM_query_destroy(q); } else { - yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery); - rs = ZOOM_connection_search_pqf(link, cl->pquery); + yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), cl->pquery); + + ZOOM_query_prefix(q, cl->pquery); } + if (se->sorted_results) + { /* first entry is current sorting ! */ + const char *sort_strategy_and_spec = + get_strategy_plus_sort(cl, se->sorted_results->field); + int increasing = se->sorted_results->increasing; + // int position = se->sorted_results->position; + if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40) + { + char spec[50], *p; + strcpy(spec, sort_strategy_and_spec); + p = strchr(spec, ':'); + if (p) + { + *p++ = '\0'; /* cut the string in two */ + while (*p == ' ') + p++; + if (increasing) + strcat(p, " <"); + else + strcat(p, " >"); + yaz_log(YLOG_LOG, "Client %s: applying sorting %s %s", client_get_id(cl), spec, p); + ZOOM_query_sortby2(q, spec, p); + } + } + else + { + /* no native sorting.. If this is not the first search, then + skip it entirely */ + if (se->sorted_results->next) + { + yaz_log(YLOG_DEBUG,"Client %s: Do not (re)search anyway", client_get_id(cl)); + ZOOM_query_destroy(q); + return; + } + } + } + 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, q); + ZOOM_query_destroy(q); ZOOM_resultset_destroy(cl->resultset); cl->resultset = rs; connection_continue(co); } -struct client *client_create(void) +struct client *client_create(const char *id) { struct client *cl = xmalloc(sizeof(*cl)); cl->maxrecs = 100; cl->startrecs = 0; cl->pquery = 0; cl->cqlquery = 0; + cl->addinfo = 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->url = 0; + cl->facet_limits = 0; + assert(id); + cl->id = xstrdup(id); client_use(1); - + return cl; } @@ -801,7 +920,7 @@ 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_url(c), c->ref_count); + c, client_get_id(c), c->ref_count); } int client_destroy(struct client *c) @@ -809,15 +928,18 @@ int client_destroy(struct client *c) if (c) { yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d", - c, client_get_url(c), c->ref_count); + c, client_get_id(c), c->ref_count); if (!pazpar2_decref(&c->ref_count, c->mutex)) { xfree(c->pquery); c->pquery = 0; xfree(c->cqlquery); c->cqlquery = 0; - xfree(c->url); + xfree(c->addinfo); + c->addinfo = 0; + xfree(c->id); assert(!c->connection); + facet_limits_destroy(c->facet_limits); if (c->resultset) { @@ -856,17 +978,9 @@ void client_disconnect(struct client *cl) 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; @@ -874,7 +988,10 @@ 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) { char *p = strchr(s->name + 3, ':'); @@ -891,96 +1008,247 @@ static CCL_bibset prepare_cclmap(struct client *cl) } // returns a xmalloced CQL query corresponding to the pquery in client -static char *make_cqlquery(struct client *cl) +static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery) { cql_transform_t cqlt = cql_transform_create(); - Z_RPNQuery *zquery; - char *r; + char *r = 0; WRBUF wrb = wrbuf_alloc(); int status; - ODR odr_out = odr_createmem(ODR_ENCODE); - zquery = p_query_rpn(odr_out, cl->pquery); - yaz_log(YLOG_LOG, "PQF: %s", cl->pquery); if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery))) { yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status); - r = 0; } else { r = xstrdup(wrbuf_cstr(wrb)); - } + } wrbuf_destroy(wrb); - odr_destroy(odr_out); 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) +static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery) { solr_transform_t sqlt = solr_transform_create(); - Z_RPNQuery *zquery; - char *r; + char *r = 0; WRBUF wrb = wrbuf_alloc(); int status; - ODR odr_out = odr_createmem(ODR_ENCODE); - zquery = p_query_rpn(odr_out, cl->pquery); - yaz_log(YLOG_LOG, "PQF: %s", cl->pquery); if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery))) { yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status); - r = 0; } else { r = xstrdup(wrbuf_cstr(wrb)); } wrbuf_destroy(wrb); - odr_destroy(odr_out); 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 && + !strncmp(s->value, "local:", 6)) + { + const char *cp = s->value + 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) +{ + 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); + 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; + nmem_strsplit_escape2(nmem_tmp, "|", value, &values, + &num, 1, '\\', 1); + + if (!strncmp(s->value, "rpn:", 4)) + { + const char *pqf = s->value + 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(s->value, "ccl:", 4)) + { + const char *ccl = s->value + 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(s->value, "local:", 6)) { + /* no operation */ + } + else + { + yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'", + sdb->database->id, s->value); + ret = -1; /* bad limitmap */ + } + break; + } + } + if (!s) + { + 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) +// return 0 if query is OK but different from before +// return 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 *startrecs, const char *maxrecs, + CCL_bibset bibset) { struct session *se = client_get_session(cl); 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, 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); - const char *record_filter = session_setting_oneval(sdb, PZ_RECORDFILTER); + WRBUF w_ccl, w_pqf; + int ret_value = 1; + Z_RPNQuery *zquery; + if (!ccl_map) return -1; - yaz_log(YLOG_DEBUG, "query: %s", query); - cn = ccl_find_str(ccl_map, query, &cerror, &cpos); + if (maxrecs && atoi(maxrecs) != cl->maxrecs) + { + ret_value = 0; + cl->maxrecs = atoi(maxrecs); + } + + if (startrecs && atoi(startrecs) != cl->startrecs) + { + ret_value = 0; + cl->startrecs = atoi(startrecs); + } + + 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, " "); + } + + if (apply_limit(sdb, facet_limits, w_pqf, ccl_map)) + { + 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", client_get_id(cl), wrbuf_cstr(w_ccl)); + cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos); ccl_qual_rm(&ccl_map); if (!cn) { client_set_state(cl, Client_Error); - session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s", - query, - client_get_database(cl)->database->url); + 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); - if (*pqf_prefix) - { - wrbuf_puts(se->wrbuf, pqf_prefix); - wrbuf_puts(se->wrbuf, " "); - } + wrbuf_destroy(w_ccl); if (!pqf_strftime || !*pqf_strftime) - ccl_pquery(se->wrbuf, cn); + ccl_pquery(w_pqf, cn); else { time_t cur_time = time(0); @@ -994,48 +1262,62 @@ int client_parse_query(struct client *cl, const char *query) for (; *cp; cp++) { if (cp[0] == '%') - ccl_pquery(se->wrbuf, cn); + ccl_pquery(w_pqf, cn); else - wrbuf_putc(se->wrbuf, cp[0]); + wrbuf_putc(w_pqf, cp[0]); } } - xfree(cl->pquery); - cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf)); - yaz_log(YLOG_DEBUG, "PQF query: %s", cl->pquery); + if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf))) + { + xfree(cl->pquery); + cl->pquery = xstrdup(wrbuf_cstr(w_pqf)); + ret_value = 0; + } + wrbuf_destroy(w_pqf); xfree(cl->cqlquery); + cl->cqlquery = 0; - /* Support for PQF on SRU targets. */ - /* TODO Refactor */ - yaz_log(YLOG_DEBUG, "Query syntax: %s", query_syntax); - if (strcmp(query_syntax, "pqf") != 0 && *sru) + odr_out = odr_createmem(ODR_ENCODE); + zquery = p_query_rpn(odr_out, cl->pquery); + if (!zquery) { - if (!strcmp(sru, "solr")) { - if (!(cl->cqlquery = make_solrquery(cl))) - return -1; - } - else { - if (!(cl->cqlquery = make_cqlquery(cl))) - return -1; - } + + session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s", + client_get_id(cl), cl->pquery); + ret_value = -1; } else - cl->cqlquery = 0; + { + 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) + ret_value = -1; + } + } + 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( - se->service->relevance_pct, - se->nmem, (const char **) p); + 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; } void client_set_session(struct client *cl, struct session *se) @@ -1063,53 +1345,87 @@ int client_is_active_preferred(struct client *cl) return 0; } - Odr_int client_get_hits(struct client *cl) { return cl->hits; } +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->record_offset; } -void client_set_diagnostic(struct client *cl, int diagnostic) +int client_get_num_records_filtered(struct client *cl) +{ + return cl->filtered; +} + +void client_set_diagnostic(struct client *cl, int diagnostic, + const char *addinfo) { cl->diagnostic = diagnostic; + xfree(cl->addinfo); + cl->addinfo = 0; + if (addinfo) + cl->addinfo = xstrdup(addinfo); } -int client_get_diagnostic(struct client *cl) +int client_get_diagnostic(struct client *cl, const char **addinfo) { + if (addinfo) + *addinfo = cl->addinfo; return cl->diagnostic; } -void client_set_database(struct client *cl, struct session_database *db) +const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf) { - cl->database = db; - /* Copy the URL for safe logging even after session is gone */ - if (db) { - cl->url = xstrdup(db->database->url); + /* int idx; */ + struct suggestions *suggestions = cl->suggestions; + + if (!suggestions) { + //yaz_log(YLOG_DEBUG, "No suggestions found"); + 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); } -struct host *client_get_host(struct client *cl) -{ - return client_get_database(cl)->database->host; -} -const char *client_get_url(struct client *cl) +void client_set_database(struct client *cl, struct session_database *db) { - if (cl->url) - return cl->url; - else - /* This must not happen anymore, as the url is present until destruction of client */ - return "NOURL"; + cl->database = db; } -void client_set_maxrecs(struct client *cl, int v) +const char *client_get_id(struct client *cl) { - cl->maxrecs = v; + return cl->id; } int client_get_maxrecs(struct client *cl) @@ -1117,16 +1433,52 @@ int client_get_maxrecs(struct client *cl) return cl->maxrecs; } -void client_set_startrecs(struct client *cl, int v) +void client_set_preferred(struct client *cl, int v) { - cl->startrecs = v; + cl->preferred = v; } -void client_set_preferred(struct client *cl, int v) + +struct suggestions* client_suggestions_create(const char* suggestions_string) { - cl->preferred = v; + 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: