/* This file is part of Pazpar2.
- Copyright (C) 2006-2008 Index Data
+ Copyright (C) 2006-2011 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
#if HAVE_CONFIG_H
#include <config.h>
#endif
-
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#if HAVE_UNISTD_H
#include <unistd.h>
#endif
-#if HAVE_SYS_SOCKET_H
-#include <sys/socket.h>
-#endif
-#if HAVE_NETDB_H
-#include <netdb.h>
-#endif
#include <signal.h>
-#include <ctype.h>
#include <assert.h>
#include <yaz/marcdisp.h>
#include <yaz/diagbib1.h>
#include <yaz/snprintf.h>
#include <yaz/rpn2cql.h>
+#include <yaz/rpn2solr.h>
#define USE_TIMING 0
#if USE_TIMING
#include <yaz/timing.h>
#endif
-#if HAVE_NETINET_IN_H
-#include <netinet/in.h>
-#endif
-
-#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 no_clients_total = 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;
+ if (delta > 0)
+ no_clients_total += 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);
+}
+
+int clients_count_total(void) {
+ int total = 0;
+ if (!g_mutex)
+ return 0;
+ yaz_mutex_enter(g_mutex);
+ total = no_clients_total;
+ yaz_mutex_leave(g_mutex);
+ return total;
+}
+
/** \brief Represents client state for a connection to one search target */
struct client {
struct session *session;
char *pquery; // Current search
char *cqlquery; // used for SRU targets only
- int hits;
- int records;
- int setno;
- int requestid; // ID of current outstanding request
+ Odr_int hits;
+ int record_offset;
+ int maxrecs;
+ int startrecs;
int diagnostic;
+ int preferred;
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;
+ /* copy of database->url */
+ char *url;
};
struct show_raw {
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_Continue"
+ "Client_Disconnected"
};
-static struct client *client_freelist = 0;
-
const char *client_get_state_str(struct client *cl)
{
return client_states[cl->state];
void client_set_state(struct client *cl, enum client_state st)
{
+ int was_active = 0;
+ if (client_is_active(cl))
+ was_active = 1;
cl->state = st;
- if (cl->session)
+ /* 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)
{
+
int no_active = session_active_clients(cl->session);
- if (no_active == 0)
+ yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d", client_get_url(cl), no_active);
+ if (no_active == 0) {
session_alert_watch(cl->session, SESSION_WATCH_SHOW);
+ session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
+ }
}
}
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);
-}
-
struct connection *client_get_connection(struct client *cl)
{
return cl->connection;
return cl->pquery;
}
-void client_set_requestid(struct client *cl, int id)
+static void client_send_raw_present(struct client *cl);
+static int nativesyntax_to_type(struct session_database *sdb, 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)
{
- 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(resultset, position-1);
+ if (!rec)
+ {
+ error_handler(data, "no record");
+ return;
+ }
+ if (binary)
+ strcpy(type, "raw");
+ else
+ nativesyntax_to_type(sdb, type, rec);
+ buf = ZOOM_record_get(rec, type, &len);
+ if (!buf)
+ {
+ error_handler(data, "no record");
+ return;
+ }
+ record_handler(data, buf, len);
+}
-static void client_send_raw_present(struct client *cl);
int client_show_raw_begin(struct client *cl, int position,
const char *syntax, const char *esn,
void (*error_handler)(void *data, const char *addinfo),
void (*record_handler)(void *data, const char *buf,
size_t sz),
- void **data2,
int binary)
{
- struct show_raw *rr, **rrp;
- if (!cl->connection)
- { /* the client has no connection */
- return -1;
- }
- rr = xmalloc(sizeof(*rr));
- *data2 = 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;
- 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");
- }
+ if (syntax == 0 && esn == 0)
+ client_show_immediate(cl->resultset, client_get_database(cl),
+ position, data,
+ error_handler, record_handler,
+ binary);
else
{
- client_send_raw_present(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;
+ 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;
}
+static void client_show_raw_delete(struct show_raw *r)
+{
+ xfree(r->syntax);
+ xfree(r->esn);
+ xfree(r);
+}
+
void client_show_raw_remove(struct client *cl, void *data)
{
struct show_raw *rr = data;
if (*rrp)
{
*rrp = rr->next;
- xfree(rr);
+ client_show_raw_delete(rr);
}
}
struct show_raw *rr = cl->show_raw;
cl->show_raw = rr->next;
- xfree(rr);
+ client_show_raw_delete(rr);
}
static void client_show_raw_error(struct client *cl, const char *addinfo)
{
struct session_database *sdb = client_get_database(cl);
struct connection *co = client_get_connection(cl);
- ZOOM_resultset set = connection_get_resultset(co);
+ ZOOM_resultset set = cl->resultset;
int offset = cl->show_raw->position;
const char *syntax = 0;
connection_continue(co);
}
-static int nativesyntax_to_type(struct session_database *sdb, char *type)
+static int nativesyntax_to_type(struct session_database *sdb, char *type,
+ ZOOM_record rec)
{
const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
{
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;
return 0;
}
- return -1;
+ else /* attempt to deduce structure */
+ {
+ const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
+ if (syntax)
+ {
+ if (!strcmp(syntax, "XML"))
+ {
+ 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");
+ return 0;
+ }
+ else return -1;
+ }
+ else return -1;
+ }
+}
+
+/**
+ * TODO Consider thread safety!!!
+ *
+ */
+int client_report_facets(struct client *cl, ZOOM_resultset rs) {
+ int facet_idx;
+ ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
+ int facet_num;
+ struct session *se = client_get_session(cl);
+ facet_num = ZOOM_resultset_facets_size(rs);
+ yaz_log(YLOG_DEBUG, "client_report_facets: %d", facet_num);
+
+ for (facet_idx = 0; facet_idx < facet_num; facet_idx++) {
+ const char *name = ZOOM_facet_field_name(facets[facet_idx]);
+ 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, name, term, freq);
+ }
+ }
+
+ return 0;
}
static void ingest_raw_record(struct client *cl, ZOOM_record rec)
else
{
struct session_database *sdb = client_get_database(cl);
- nativesyntax_to_type(sdb, type);
+ nativesyntax_to_type(sdb, type, rec);
}
buf = ZOOM_record_get(rec, type, &len);
client_show_raw_dequeue(cl);
}
+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));
+ if (se)
+ {
+ client_unlock(cl);
+ 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.");
+
+ client_lock(cl);
+ }
+ else
+ yaz_log(YLOG_WARN, "client_check_preferred_watch: %s. No session!", client_get_url(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 = connection_get_resultset(co);
- const char *error, *addinfo;
+ ZOOM_resultset resultset = cl->resultset;
+ const char *error, *addinfo = 0;
+
if (ZOOM_connection_error(link, &error, &addinfo))
{
cl->hits = 0;
- cl->state = Client_Error;
+ 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_url(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);
- se->total_hits += cl->hits;
+ if (se) {
+ se->total_hits += cl->hits;
+ yaz_log(YLOG_DEBUG, "client_search_response: total hits "
+ ODR_INT_PRINTF, se->total_hits);
+ }
}
}
+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);
+ }
+}
void client_record_response(struct client *cl)
{
struct connection *co = cl->connection;
ZOOM_connection link = connection_get_link(co);
- ZOOM_resultset resultset = connection_get_resultset(co);
+ ZOOM_resultset resultset = cl->resultset;
const char *error, *addinfo;
- yaz_log(YLOG_LOG, "client_record_response");
if (ZOOM_connection_error(link, &error, &addinfo))
{
- cl->state = Client_Error;
+ client_set_state(cl, Client_Error);
yaz_log(YLOG_WARN, "Search error %s (%s): %s",
error, addinfo, client_get_url(cl));
}
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
{
- int offset = cl->records;
+ int offset = cl->record_offset;
if ((rec = ZOOM_resultset_record(resultset, offset)))
{
- yaz_log(YLOG_LOG, "Record with offset %d", offset);
-
- cl->records++;
- if (ZOOM_record_error(rec, &msg, &addinfo, 0))
+ 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)",
- error, addinfo, client_get_url(cl), cl->records);
+ 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];
- nativesyntax_to_type(sdb, type);
- if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
+
+ 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
{
- if (ingest_record(cl, xmlrec, cl->records))
- {
- session_alert_watch(cl->session, SESSION_WATCH_SHOW);
- session_alert_watch(cl->session, SESSION_WATCH_RECORD);
- }
- else
- yaz_log(YLOG_WARN, "Failed to ingest");
+ /* 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));
}
- else
- yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
+ nmem_destroy(nmem);
}
+ }
+ else
+ {
+ yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
+ offset);
+ }
+ }
+ }
+}
+
+static int client_set_facets_request(struct client *cl, ZOOM_connection link)
+{
+ struct session_database *sdb = client_get_database(cl);
+ const char *opt_facet_term_sort = session_setting_oneval(sdb, PZ_TERMLIST_TERM_SORT);
+ const char *opt_facet_term_count = session_setting_oneval(sdb, PZ_TERMLIST_TERM_COUNT);
+ /* Future record filtering on target */
+ /* const char *opt_facet_record_filter = session_setting_oneval(sdb, PZ_RECORDFILTER); */
+
+ /* Disable when no count is set */
+ /* TODO Verify: Do we need to reset the ZOOM facets if a ZOOM Connection is being reused??? */
+ if (opt_facet_term_count && *opt_facet_term_count)
+ {
+ int index = 0;
+ struct session *session = client_get_session(cl);
+ struct conf_service *service = session->service;
+ int num = service->num_metadata;
+ WRBUF wrbuf = wrbuf_alloc();
+ yaz_log(YLOG_DEBUG, "Facet settings, sort: %s count: %s",
+ opt_facet_term_sort, opt_facet_term_count);
+ for (index = 0; index < num; index++)
+ {
+ struct conf_metadata *conf_meta = &service->metadata[index];
+ if (conf_meta->termlist)
+ {
+ if (wrbuf_len(wrbuf))
+ wrbuf_puts(wrbuf, ", ");
+ wrbuf_printf(wrbuf, "@attr 1=%s", conf_meta->name);
+
+ if (opt_facet_term_sort && *opt_facet_term_sort)
+ wrbuf_printf(wrbuf, " @attr 2=%s", opt_facet_term_sort);
+ wrbuf_printf(wrbuf, " @attr 3=%s", opt_facet_term_count);
}
}
- if (!rec)
- yaz_log(YLOG_WARN, "Expected record, but got NULL");
+ if (wrbuf_len(wrbuf))
+ {
+ yaz_log(YLOG_LOG, "Setting ZOOM facets option: %s", wrbuf_cstr(wrbuf));
+ ZOOM_connection_option_set(link, "facets", wrbuf_cstr(wrbuf));
+ return 1;
+ }
+ }
+ return 0;
+}
+
+int client_has_facet(struct client *cl, const char *name) {
+ ZOOM_facet_field facet_field;
+ if (!cl || !cl->resultset || !name) {
+ return 0;
+ }
+ facet_field = ZOOM_resultset_get_facet_field(cl->resultset, name);
+ if (facet_field) {
+ return 1;
}
+ return 0;
}
+
void client_start_search(struct client *cl)
{
struct session_database *sdb = client_get_database(cl);
ZOOM_connection link = connection_get_link(co);
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);
- 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_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);
+ char maxrecs_str[24], startrecs_str[24];
assert(link);
cl->hits = -1;
- cl->records = 0;
+ cl->record_offset = 0;
cl->diagnostic = 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", sdb->database->url, cl->preferred);
+ }
+ client_set_state(cl, Client_Working);
+
if (*opt_piggyback)
ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
else
ZOOM_connection_option_set(link, "elementSetName", opt_elements);
if (*opt_requestsyn)
ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
- if (*opt_maxrecs)
- ZOOM_connection_option_set(link, "count", opt_maxrecs);
- else
+
+ if (opt_maxrecs && *opt_maxrecs)
{
- char n[128];
- sprintf(n, "%d", global_parameters.toget);
- ZOOM_connection_option_set(link, "count", n);
+ cl->maxrecs = atoi(opt_maxrecs);
}
+
+ /* convert back to string representation used in ZOOM API */
+ 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
+ ZOOM_connection_option_set(link, "presentChunk", 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);
- ZOOM_connection_option_set(link, "presentChunk", "20");
+ /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
+ /* facets definition is in PQF */
+ client_set_facets_request(cl, link);
if (cl->cqlquery)
{
ZOOM_query q = ZOOM_query_create();
+ yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, 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);
- connection_set_resultset(co, rs);
+ }
+ ZOOM_resultset_destroy(cl->resultset);
+ cl->resultset = rs;
connection_continue(co);
}
struct client *client_create(void)
{
- struct client *r;
- if (client_freelist)
- {
- r = client_freelist;
- client_freelist = client_freelist->next;
- }
- else
- r = xmalloc(sizeof(struct client));
- r->pquery = 0;
- r->cqlquery = 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;
+ struct client *cl = xmalloc(sizeof(*cl));
+ cl->maxrecs = 100;
+ cl->startrecs = 0;
+ cl->pquery = 0;
+ cl->cqlquery = 0;
+ cl->database = 0;
+ cl->connection = 0;
+ cl->session = 0;
+ cl->hits = 0;
+ cl->record_offset = 0;
+ cl->diagnostic = 0;
+ cl->state = Client_Disconnected;
+ cl->show_raw = 0;
+ cl->resultset = 0;
+ cl->mutex = 0;
+ pazpar2_mutex_create(&cl->mutex, "client");
+ cl->preferred = 0;
+ cl->ref_count = 1;
+ cl->url = 0;
+ client_use(1);
+
+ return cl;
}
-void client_destroy(struct client *c)
+void client_lock(struct client *c)
{
- struct session *se = c->session;
- if (c == se->clients)
- se->clients = c->next;
- else
+ yaz_mutex_enter(c->mutex);
+}
+
+void client_unlock(struct client *c)
+{
+ yaz_mutex_leave(c->mutex);
+ sleep(1);
+}
+
+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);
+}
+
+int client_destroy(struct client *c)
+{
+ if (c)
{
- struct client *cc;
- for (cc = se->clients; cc && cc->next != c; cc = cc->next)
- ;
- if (cc)
- cc->next = c->next;
+ yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
+ c, client_get_url(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);
+ assert(!c->connection);
+
+ if (c->resultset)
+ {
+ ZOOM_resultset_destroy(c->resultset);
+ }
+ yaz_mutex_destroy(&c->mutex);
+ xfree(c);
+ client_use(-1);
+ return 1;
+ }
}
- xfree(c->pquery);
- xfree(c->cqlquery);
-
- if (c->connection)
- connection_release(c->connection);
- c->next = client_freelist;
- client_freelist = c;
+ return 0;
}
void client_set_connection(struct client *cl, struct connection *con)
{
- cl->connection = con;
+ if (cl->resultset)
+ ZOOM_resultset_release(cl->resultset);
+ if (con)
+ {
+ assert(cl->connection == 0);
+ cl->connection = con;
+ client_incref(cl);
+ }
+ else
+ {
+ cl->connection = con;
+ client_destroy(cl);
+ }
}
void client_disconnect(struct client *cl)
char *r;
WRBUF wrb = wrbuf_alloc();
int status;
+ ODR odr_out = odr_createmem(ODR_ENCODE);
- zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
+ 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);
- return 0;
+ yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
+ r = 0;
}
- r = xstrdup(wrbuf_cstr(wrb));
-
+ else
+ {
+ r = xstrdup(wrbuf_cstr(wrb));
+ }
wrbuf_destroy(wrb);
- odr_reset(global_parameters.odr_out); // releases the zquery
+ 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)
+{
+ solr_transform_t sqlt = solr_transform_create();
+ Z_RPNQuery *zquery;
+ char *r;
+ 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;
+}
+
// Parse the query given the settings specific to this client
int client_parse_query(struct client *cl, const char *query)
{
struct session *se = client_get_session(cl);
struct session_database *sdb = client_get_database(cl);
struct ccl_rpn_node *cn;
+ struct ccl_rpn_node *cn_recordfilter = 0;
int cerror, cpos;
CCL_bibset ccl_map = prepare_cclmap(cl);
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);
+ /* Collected, Mixed, Remote */
+ const char *option_recordfilter = session_setting_oneval(sdb, PZ_OPTION_RECORDFILTER);
+ const char *record_filter = session_setting_oneval(sdb, PZ_RECORDFILTER);
if (!ccl_map)
return -1;
+ yaz_log(YLOG_DEBUG, "query: %s", query);
cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
+ if (strcmp("remote", option_recordfilter) == 0 && record_filter != 0 && record_filter[0] != 0) {
+ int cerror, cpos;
+ yaz_log(YLOG_DEBUG, "record_filter: %s", record_filter);
+ cn_recordfilter = ccl_find_str(ccl_map, record_filter, &cerror, &cpos);
+ if (!cn_recordfilter)
+ session_log(se, YLOG_WARN, "Failed to parse CCL record filter '%s' for %s",
+ record_filter, client_get_database(cl)->database->url);
+ }
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);
+ 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);
return -1;
}
wrbuf_rewind(se->wrbuf);
- ccl_pquery(se->wrbuf, cn);
+ if (*pqf_prefix)
+ {
+ wrbuf_puts(se->wrbuf, pqf_prefix);
+ wrbuf_puts(se->wrbuf, " ");
+ }
+
+ if (cn_recordfilter) {
+ wrbuf_puts(se->wrbuf, "@and ");
+ ccl_pquery(se->wrbuf, cn_recordfilter);
+ wrbuf_puts(se->wrbuf, " ");
+ }
+
+ if (!pqf_strftime || !*pqf_strftime)
+ ccl_pquery(se->wrbuf, 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(se->wrbuf, cn);
+ else
+ wrbuf_putc(se->wrbuf, cp[0]);
+ }
+ }
xfree(cl->pquery);
cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
+ yaz_log(YLOG_DEBUG, "PQF query: %s", cl->pquery);
+
xfree(cl->cqlquery);
- if (*sru)
+
+ /* Support for PQF on SRU targets. */
+ /* TODO Refactor */
+ yaz_log(YLOG_DEBUG, "Query syntax: %s", query_syntax);
+ if (strcmp(query_syntax, "pqf") != 0 && *sru)
{
- if (!(cl->cqlquery = make_cqlquery(cl)))
- return -1;
+ if (!strcmp(sru, "solr")) {
+ if (!(cl->cqlquery = make_solrquery(cl)))
+ return -1;
+ }
+ else {
+ if (!(cl->cqlquery = make_cqlquery(cl)))
+ return -1;
+ }
}
else
cl->cqlquery = 0;
+ /* 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->service->relevance_pct,
+ se->nmem, (const char **) p);
}
ccl_rpn_delete(cn);
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_Continue ||
- cl->state == Client_Connecting ||
+ if (cl->connection && (cl->state == Client_Connecting ||
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;
-
}
-int client_get_hits(struct client *cl)
+
+Odr_int client_get_hits(struct client *cl)
{
return cl->hits;
}
int client_get_num_records(struct client *cl)
{
- return cl->records;
+ return cl->record_offset;
+}
+
+void client_set_diagnostic(struct client *cl, int diagnostic)
+{
+ cl->diagnostic = diagnostic;
}
int client_get_diagnostic(struct client *cl)
void client_set_database(struct client *cl, struct session_database *db)
{
cl->database = db;
+ /* Copy the URL for safe logging even after session is gone */
+ if (db) {
+ cl->url = xstrdup(db->database->url);
+ }
}
struct host *client_get_host(struct client *cl)
const char *client_get_url(struct client *cl)
{
- return client_get_database(cl)->database->url;
+ if (cl->url)
+ return cl->url;
+ else
+ /* This must not happen anymore, as the url is present until destruction of client */
+ return "NOURL";
+}
+
+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;
+}
+
+
/*
* Local variables:
* c-basic-offset: 4
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
* End:
* vim: shiftwidth=4 tabstop=8 expandtab
*/
+