/* 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
*/
/** \file client.c
- \brief Z39.50 client
+ \brief Z39.50 client
*/
#if HAVE_CONFIG_H
#if HAVE_UNISTD_H
#include <unistd.h>
#endif
+#ifdef WIN32
+#include <windows.h>
+#endif
#include <signal.h>
#include <assert.h>
#include <yaz/snprintf.h>
#include <yaz/rpn2cql.h>
#include <yaz/rpn2solr.h>
+#include <yaz/gettimeofday.h>
#define USE_TIMING 0
#if USE_TIMING
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;
+ char *message;
int preferred;
struct suggestions *suggestions;
enum client_state state;
YAZ_MUTEX mutex;
int ref_count;
char *id;
+ facet_limits_t facet_limits;
+ int same_search;
+ char *sort_strategy;
+ char *sort_criteria;
};
struct suggestions {
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;
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;
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);
}
}
}
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];
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)
{
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;
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");
{
xfree(r->syntax);
xfree(r->esn);
+ xfree(r->nativesyntax);
xfree(r);
}
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))
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 */
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);
ZOOM_resultset resultset = cl->resultset;
const char *error, *addinfo = 0;
-
+
if (ZOOM_connection_error(link, &error, &addinfo))
{
cl->hits = 0;
}
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);
+ 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"));
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;
+ struct session *se = client_get_session(cl);
+
+ if ((rec = ZOOM_resultset_record_immediate(resultset, cl->record_offset)))
+ {
+ int offset = ++cl->record_offset;
+ if (cl->session == 0) {
+ /* no operation */
+ }
+ else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
+ {
+ session_log(se, YLOG_WARN, "Record error %s (%s): %s #%d",
+ msg, addinfo, client_get_id(cl), 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))
+ 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);
+ }
+ }
+ else
+ {
+ session_log(se, YLOG_WARN, "Got NULL record from %s #%d",
+ client_get_id(cl), cl->record_offset);
}
}
}
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);
}
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_id(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_id(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_id(cl));
- }
- nmem_destroy(nmem);
- }
- }
- else
- {
- yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
- offset);
- }
+ client_record_ingest(cl);
}
}
}
+int 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);
+ return 0;
+}
+
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)
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);
return 0;
}
-void client_start_search(struct client *cl, const char *sort_strategy_and_spec,
- int increasing)
+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;
+}
+
+int client_parse_init(struct client *cl, int same_search)
+{
+ cl->same_search = same_search;
+ return 0;
+}
+
+/*
+ * 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);
+ }
+
+ if (startrecs && atoi(startrecs) != cl->startrecs)
+ {
+ cl->same_search = 0;
+ cl->startrecs = atoi(startrecs);
+ }
+
+ return 0;
+}
+
+int 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 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_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];
- ZOOM_query q;
+ 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);
+ }
+ 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)
+ {
+ session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
+ return client_reingest(cl);
+ }
+ else if (!rc_prep_connection)
+ {
+ session_log(se, YLOG_LOG, "client %s FAILED to search: No connection.", client_get_id(cl));
+ return -1;
+ }
+ co = client_get_connection(cl);
+ assert(cl);
+ link = connection_get_link(co);
assert(link);
- cl->record_offset = 0;
+ 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);
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);
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);
/* facets definition is in PQF */
client_set_facets_request(cl, link);
- q = ZOOM_query_create();
+ query = ZOOM_query_create();
if (cl->cqlquery)
{
- yaz_log(YLOG_LOG, "Search %s CQL: %s", client_get_id(cl),
- cl->cqlquery);
- ZOOM_query_cql(q, 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(q, opt_sort);
+ ZOOM_query_sortby(query, opt_sort);
}
else
{
- yaz_log(YLOG_LOG, "Search %s PQF: %s", client_get_id(cl), cl->pquery);
-
- ZOOM_query_prefix(q, cl->pquery);
+ yaz_log(YLOG_LOG, "Client %s: Search PQF: %s", client_get_id(cl), cl->pquery);
+
+ ZOOM_query_prefix(query, cl->pquery);
}
- if (sort_strategy_and_spec &&
- strlen(sort_strategy_and_spec) < 40 /* spec below */)
- {
- 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, "applying %s %s", spec, p);
- ZOOM_query_sortby2(q, spec, p);
- }
+ if (cl->sort_strategy && cl->sort_criteria) {
+ yaz_log(YLOG_LOG, "Client %s: Setting 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);
}
- rs = ZOOM_connection_search(link, q);
- ZOOM_query_destroy(q);
+
+ 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;
}
struct client *client_create(const char *id)
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;
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);
-
+
return cl;
}
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)
{
// 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;
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)
+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);
- if (zquery == 0) {
- yaz_log(YLOG_WARN, "Failed to generate RPN from PQF: %s", cl->pquery);
- return 0;
- }
- 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 from PQF %s, code=%d", cl->pquery, status);
- r = 0;
+ yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
}
else
{
r = xstrdup(wrbuf_cstr(wrb));
}
wrbuf_destroy(wrb);
- odr_destroy(odr_out);
solr_transform_close(sqlt);
return r;
}
-static void apply_limit(struct session_database *sdb,
- facet_limits_t facet_limits,
- WRBUF w_pqf, WRBUF w_ccl)
+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, ':');
{
char **values = 0;
int i, num = 0;
+ char **cvalues = 0;
+ int j, cnum = 0;
nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
&num, 1, '\\', 1);
- if (!strncmp(s->value, "rpn:", 4))
- {
- const char *pqf = s->value + 4;
+ nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues,
+ &cnum, 1, '\\', 1);
- wrbuf_puts(w_pqf, "@and ");
- wrbuf_puts(w_pqf, pqf);
- wrbuf_puts(w_pqf, " ");
- for (i = 0; i < num; i++)
+ for (j = 0; ret == 0 && j < cnum; j++)
+ {
+ const char *cvalue = cvalues[j];
+ while (*cvalue == ' ')
+ cvalue++;
+ if (!strncmp(cvalue, "rpn:", 4))
{
- if (i < num - 1)
- wrbuf_puts(w_pqf, "@or ");
- yaz_encode_pqf_term(w_pqf, values[i],
- strlen(values[i]));
+ 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(s->value, "ccl:", 4))
- {
- const char *ccl = s->value + 4;
-
- wrbuf_puts(w_ccl, " and (");
-
- for (i = 0; i < num; i++)
+ else if (!strncmp(cvalue, "ccl:", 4))
{
- if (i)
- wrbuf_puts(w_ccl, " or ");
- wrbuf_puts(w_ccl, ccl);
- wrbuf_puts(w_ccl, "=\"");
- wrbuf_puts(w_ccl, values[i]);
- wrbuf_puts(w_ccl, "\"");
+ 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);
}
- wrbuf_puts(w_ccl, ")");
-
+ 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;
}
- break;
}
}
- nmem_reset(nmem_tmp);
if (!s)
{
- yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
- (sdb->database ? sdb->database->id : "<no id>"), name);
+ 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 : "<no id>"), name);
+ }
}
}
nmem_destroy(nmem_tmp);
+ return ret;
}
-
+
// Parse the query given the settings specific to this client
+// 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)
{
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;
- cl->hits = -1;
w_ccl = wrbuf_alloc();
wrbuf_puts(w_ccl, query);
wrbuf_puts(w_pqf, " ");
}
- apply_limit(sdb, facet_limits, w_pqf, w_ccl);
+ 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, "CCL query: %s", wrbuf_cstr(w_ccl));
+ 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)
{
client_set_state(cl, Client_Error);
- session_log(se, YLOG_WARN, "Failed to parse CCL query '%s' for %s",
- wrbuf_cstr(w_ccl),
- client_get_id(cl));
+ 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_putc(w_pqf, cp[0]);
}
}
- xfree(cl->pquery);
- cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
- wrbuf_destroy(w_pqf);
- yaz_log(YLOG_LOG, "PQF query: %s", cl->pquery);
+ /* 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;
- /* 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;
+ 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
- se->relevance = relevance_create_ccl(
- se->service->charsets, se->nmem, cn);
+ 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 (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)
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 *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)
+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;
}
struct suggestions *suggestions = cl->suggestions;
if (!suggestions) {
- yaz_log(YLOG_DEBUG, "No suggestions found");
+ //yaz_log(YLOG_DEBUG, "No suggestions found");
return "";
}
if (suggestions->passthrough) {
return cl->id;
}
-void client_set_maxrecs(struct client *cl, int v)
-{
- cl->maxrecs = v;
-}
-
int client_get_maxrecs(struct client *cl)
{
return cl->maxrecs;
}
-void client_set_startrecs(struct client *cl, int v)
-{
- cl->startrecs = v;
-}
-
void client_set_preferred(struct client *cl, int v)
{
cl->preferred = v;
int i;
NMEM nmem;
struct suggestions *suggestions;
- if (suggestions_string == 0)
+ 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);
+ yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
suggestions->nmem = nmem;
suggestions->num = 0;
nmem_destroy(nmem);
}
+int client_test_sort_order(struct client *cl, struct reclist_sortparms *sp)
+{
+ //TODO implement correctly.
+ return 1;
+}
/*
* Local variables:
* c-basic-offset: 4