/* This file is part of Pazpar2.
- Copyright (C) 2006-2008 Index Data
+ Copyright (C) 2006-2009 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_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/querytowrbuf.h>
#include <yaz/oid_db.h>
#include <yaz/diagbib1.h>
+#include <yaz/snprintf.h>
+#include <yaz/rpn2cql.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 "client.h"
/** \brief Represents client state for a connection to one search target */
struct client {
struct session_database *database;
+ struct conf_server *server;
struct connection *connection;
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
+ int record_offset;
int diagnostic;
enum client_state state;
struct show_raw *show_raw;
struct client *next; // next client in session or next in free list
+ ZOOM_resultset resultset;
};
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;
+static struct client *client_freelist = 0; /* thread pr */
const char *client_get_state_str(struct client *cl)
{
// 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);
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);
}
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);
+ if (syntax == 0 && esn == 0)
+ client_show_immediate(cl->resultset, client_get_database(cl),
+ position, data,
+ error_handler, record_handler,
+ binary);
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");
+ 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_cancel(struct client *cl)
-{
- while (cl->show_raw)
- {
- cl->show_raw->error_handler(cl->show_raw->data, "cancel");
- client_show_raw_dequeue(cl);
- }
-}
-
-void client_send_raw_present(struct client *cl)
+static void client_send_raw_present(struct client *cl)
{
struct session_database *sdb = client_get_database(cl);
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;
elements = cl->show_raw->esn;
else
elements = session_setting_oneval(sdb, PZ_ELEMENTS);
- ZOOM_resultset_option_set(set, "elementSetName", elements);
+ if (elements && *elements)
+ ZOOM_resultset_option_set(set, "elementSetName", elements);
- ZOOM_resultset_records(set, 0, offset, 1);
+ ZOOM_resultset_records(set, 0, offset-1, 1);
cl->show_raw->active = 1;
-}
-#ifdef RETIRED
+ connection_continue(co);
+}
-static void ingest_raw_records(struct client *cl, Z_Records *r)
+static int nativesyntax_to_type(struct session_database *sdb, char *type,
+ ZOOM_record rec)
{
- Z_NamePlusRecordList *rlist;
- Z_NamePlusRecord *npr;
- xmlDoc *doc;
- xmlChar *buf_out;
- int len_out;
- if (r->which != Z_Records_DBOSD)
- {
- client_show_raw_error(cl, "non-surrogate diagnostics");
- return;
- }
-
- rlist = r->u.databaseOrSurDiagnostics;
- if (rlist->num_records != 1 || !rlist->records || !rlist->records[0])
- {
- client_show_raw_error(cl, "no records");
- return;
- }
- npr = rlist->records[0];
- if (npr->which != Z_NamePlusRecord_databaseRecord)
- {
- client_show_raw_error(cl, "surrogate diagnostic");
- return;
- }
+ const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
- if (cl->show_raw && cl->show_raw->binary)
+ if (s && *s)
{
- Z_External *rec = npr->u.databaseRecord;
- if (rec->which == Z_External_octet)
+ 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))
{
- cl->show_raw->record_handler(cl->show_raw->data,
- (const char *)
- rec->u.octet_aligned->buf,
- rec->u.octet_aligned->len);
- client_show_raw_dequeue(cl);
+ strcpy(type, "xml");
}
else
- client_show_raw_error(cl, "no records");
+ return -1;
+ return 0;
}
-
- doc = record_to_xml(client_get_database(cl), npr->u.databaseRecord);
- if (!doc)
+ else /* attempt to deduce structure */
{
- client_show_raw_error(cl, "unable to convert record to xml");
- return;
+ const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
+ if (syntax)
+ {
+ if (!strcmp(syntax, "XML"))
+ {
+ strcpy(type, "xml");
+ return 0;
+ }
+ else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
+ {
+ strcpy(type, "xml; charset=marc8-s");
+ return 0;
+ }
+ else return -1;
+ }
+ else return -1;
}
+}
- xmlDocDumpMemory(doc, &buf_out, &len_out);
- xmlFreeDoc(doc);
+static void ingest_raw_record(struct client *cl, ZOOM_record rec)
+{
+ const char *buf;
+ int len;
+ char type[80];
- if (cl->show_raw)
+ if (cl->show_raw->binary)
+ strcpy(type, "raw");
+ else
{
- cl->show_raw->record_handler(cl->show_raw->data,
- (const char *) buf_out, len_out);
- client_show_raw_dequeue(cl);
+ struct session_database *sdb = client_get_database(cl);
+ nativesyntax_to_type(sdb, type, rec);
}
- xmlFree(buf_out);
-}
-#endif // RETIRED show raw
+ buf = ZOOM_record_get(rec, type, &len);
+ cl->show_raw->record_handler(cl->show_raw->data, buf, len);
+ client_show_raw_dequeue(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);
+ ZOOM_resultset resultset = cl->resultset;
const char *error, *addinfo;
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));
}
else
{
+ cl->record_offset = 0;
cl->hits = ZOOM_resultset_size(resultset);
se->total_hits += cl->hits;
}
}
+
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;
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));
}
else
{
- ZOOM_record rec;
- int offset = cl->records;
+ ZOOM_record rec = 0;
const char *msg, *addinfo;
- if ((rec = ZOOM_resultset_record(resultset, offset)))
+ if (cl->show_raw && cl->show_raw->active)
{
- yaz_log(YLOG_LOG, "Record with offset %d", offset);
- cl->records++;
- 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);
+ if ((rec = ZOOM_resultset_record(resultset,
+ cl->show_raw->position-1)))
+ {
+ cl->show_raw->active = 0;
+ ingest_raw_record(cl, rec);
+ }
else
{
- struct session_database *sdb = client_get_database(cl);
- const char *xmlrec;
- char type[128] = "xml";
- const char *nativesyntax =
- session_setting_oneval(sdb, PZ_NATIVESYNTAX);
- char *cset;
-
- if (*nativesyntax && (cset = strchr(nativesyntax, ';')))
- sprintf(type, "xml; charset=%s", cset + 1);
-
- if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
+ yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
+ cl->show_raw->position-1);
+ }
+ }
+ else
+ {
+ int offset = cl->record_offset;
+ if ((rec = ZOOM_resultset_record(resultset, offset)))
+ {
+ cl->record_offset++;
+ 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->record_offset);
+ else
{
- if (ingest_record(cl, xmlrec, cl->records))
+ struct session_database *sdb = client_get_database(cl);
+ const char *xmlrec;
+ char type[80];
+ if (nativesyntax_to_type(sdb, type, rec))
+ yaz_log(YLOG_WARN, "Failed to determine record type");
+ if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
{
- session_alert_watch(cl->session, SESSION_WATCH_SHOW);
- session_alert_watch(cl->session, SESSION_WATCH_RECORD);
+ if (ingest_record(cl, xmlrec, cl->record_offset))
+ {
+ session_alert_watch(cl->session, SESSION_WATCH_SHOW);
+ session_alert_watch(cl->session, SESSION_WATCH_RECORD);
+ }
+ else
+ yaz_log(YLOG_WARN, "Failed to ingest");
}
else
- yaz_log(YLOG_WARN, "Failed to ingest");
+ yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
}
- else
- yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
}
+ else
+ {
+ yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
+ offset);
+ }
}
- else
- yaz_log(YLOG_WARN, "Expected record, but got NULL");
- }
-}
-
-#ifdef RETIRED
-
-void client_present_response(struct client *cl, Z_APDU *a)
-{
- Z_PresentResponse *r = a->u.presentResponse;
- Z_Records *recs = r->records;
-
- if (recs && recs->which == Z_Records_NSD)
- {
- WRBUF w = wrbuf_alloc();
-
- Z_DiagRec dr, *dr_p = &dr;
- dr.which = Z_DiagRec_defaultFormat;
- dr.u.defaultFormat = recs->u.nonSurrogateDiagnostic;
-
- wrbuf_printf(w, "Present response NSD %s: ",
- cl->database->database->url);
-
- cl->diagnostic = diag_to_wrbuf(&dr_p, 1, w);
-
- yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
-
- cl->state = Client_Error;
- wrbuf_destroy(w);
-
- client_show_raw_error(cl, "non surrogate diagnostics");
- }
- else if (recs && recs->which == Z_Records_multipleNSD)
- {
- WRBUF w = wrbuf_alloc();
-
- wrbuf_printf(w, "Present response multipleNSD %s: ",
- cl->database->database->url);
- cl->diagnostic =
- diag_to_wrbuf(recs->u.multipleNonSurDiagnostics->diagRecs,
- recs->u.multipleNonSurDiagnostics->num_diagRecs,
- w);
- yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
- cl->state = Client_Error;
- wrbuf_destroy(w);
- }
- else if (recs && !*r->presentStatus && cl->state != Client_Error)
- {
- yaz_log(YLOG_DEBUG, "Good Present response %s",
- cl->database->database->url);
-
- // we can mix show raw and normal show ..
- if (cl->show_raw && cl->show_raw->active)
- {
- cl->show_raw->active = 0; // no longer active
- ingest_raw_records(cl, recs);
- }
- else
- ingest_records(cl, recs);
- cl->state = Client_Continue;
- }
- else if (*r->presentStatus)
- {
- yaz_log(YLOG_WARN, "Bad Present response %s",
- cl->database->database->url);
- cl->state = Client_Error;
- client_show_raw_error(cl, "bad present response");
}
}
-void client_close_response(struct client *cl, Z_APDU *a)
-{
- struct connection *co = cl->connection;
- /* Z_Close *r = a->u.close; */
-
- yaz_log(YLOG_WARN, "Close response %s", cl->database->database->url);
-
- cl->state = Client_Failed;
- connection_destroy(co);
-}
-
-#endif // RETIRED show raw
-
-#ifdef RETIRED
-int client_is_our_response(struct client *cl)
-{
- struct session *se = client_get_session(cl);
-
- if (cl && (cl->requestid == se->requestid ||
- cl->state == Client_Initializing))
- return 1;
- return 0;
-}
-#endif
-
void client_start_search(struct client *cl)
{
struct session_database *sdb = client_get_database(cl);
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);
assert(link);
cl->hits = -1;
- cl->records = 0;
+ cl->record_offset = 0;
cl->diagnostic = 0;
+ client_set_state(cl, Client_Working);
if (*opt_piggyback)
ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
ZOOM_connection_option_set(link, "piggyback", "1");
if (*opt_queryenc)
ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
- if (*opt_elements)
+ if (*opt_sru && *opt_elements)
+ ZOOM_connection_option_set(link, "schema", opt_elements);
+ else if (*opt_elements)
ZOOM_connection_option_set(link, "elementSetName", opt_elements);
if (*opt_requestsyn)
ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
sprintf(n, "%d", global_parameters.toget);
ZOOM_connection_option_set(link, "count", n);
}
- if (!databaseName || !*databaseName)
- databaseName = "Default";
- ZOOM_connection_option_set(link, "databaseName", databaseName);
+ if (databaseName)
+ ZOOM_connection_option_set(link, "databaseName", databaseName);
ZOOM_connection_option_set(link, "presentChunk", "20");
-
- rs = ZOOM_connection_search_pqf(link, cl->pquery);
- connection_set_resultset(co, rs);
+
+ 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);
+ 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);
+ }
+ ZOOM_resultset_destroy(cl->resultset);
+ cl->resultset = rs;
+ connection_continue(co);
}
struct client *client_create(void)
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->record_offset = 0;
r->diagnostic = 0;
r->state = Client_Disconnected;
r->show_raw = 0;
+ r->resultset = 0;
r->next = 0;
return r;
}
cc->next = c->next;
}
xfree(c->pquery);
+ xfree(c->cqlquery);
if (c->connection)
connection_release(c->connection);
+
+ ZOOM_resultset_destroy(c->resultset);
+ c->resultset = 0;
c->next = client_freelist;
client_freelist = c;
}
return res;
}
+// returns a xmalloced CQL query corresponding to the pquery in client
+static char *make_cqlquery(struct client *cl)
+{
+ cql_transform_t cqlt = cql_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);
+ 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;
+}
+
// 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;
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);
if (!ccl_map)
return -1;
ccl_qual_rm(&ccl_map);
if (!cn)
{
- cl->state = Client_Error;
+ client_set_state(cl, Client_Error);
yaz_log(YLOG_WARN, "Failed to parse query for %s",
client_get_database(cl)->database->url);
return -1;
}
wrbuf_rewind(se->wrbuf);
+ if (*pqf_prefix)
+ {
+ wrbuf_puts(se->wrbuf, pqf_prefix);
+ wrbuf_puts(se->wrbuf, " ");
+ }
ccl_pquery(se->wrbuf, cn);
xfree(cl->pquery);
cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
+ xfree(cl->cqlquery);
+ if (*sru)
+ {
+ if (!(cl->cqlquery = make_cqlquery(cl)))
+ return -1;
+ }
+ else
+ cl->cqlquery = 0;
+
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->service->relevance_pct,
se->nmem, (const char **) p,
se->expected_maxrecs);
}
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;
int client_get_num_records(struct client *cl)
{
- return cl->records;
+ return cl->record_offset;
}
int client_get_diagnostic(struct client *cl)
/*
* Local variables:
* c-basic-offset: 4
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
* End:
* vim: shiftwidth=4 tabstop=8 expandtab
*/
+