-/* $Id: client.c,v 1.1 2007-04-23 21:05:23 adam Exp $
+/* $Id: client.c,v 1.11 2007-06-15 19:35:17 adam Exp $
Copyright (c) 2006-2007, Index Data.
This file is part of Pazpar2.
#include <yaz/nmem.h>
#include <yaz/query-charset.h>
#include <yaz/querytowrbuf.h>
-#if YAZ_VERSIONL >= 0x020163
#include <yaz/oid_db.h>
-#endif
#if HAVE_CONFIG_H
#include "cconfig.h"
#include "connection.h"
#include "settings.h"
-// Represents client state for a connection to one search target
+/** \brief Represents client state for a connection to one search target */
struct client {
struct session_database *database;
struct connection *connection;
int hits;
int records;
int setno;
- int requestid; // ID of current outstanding request
+ int requestid; // ID of current outstanding request
int diagnostic;
enum client_state state;
- struct client *next;
+ struct show_raw *show_raw;
+ struct client *next; // next client in session or next in free list
+};
+
+struct show_raw {
+ int active; // whether this request has been sent to the server
+ int position;
+ char *syntax;
+ char *esn;
+ void (*error_handler)(void *data, const char *addinfo);
+ void (*record_handler)(void *data, const char *buf, size_t sz);
+ void *data;
};
static const char *client_states[] = {
cl->state = st;
}
+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);
cl->state = Client_Error;
cl->requestid = id;
}
+int client_show_raw_begin(struct client *cl, int position,
+ const char *syntax, const char *esn,
+ void *data,
+ void (*error_handler)(void *data, const char *addinfo),
+ void (*record_handler)(void *data, const char *buf,
+ size_t sz))
+{
+ if (cl->show_raw)
+ return -1;
+ cl->show_raw = xmalloc(sizeof(*cl->show_raw));
+ cl->show_raw->position = position;
+ cl->show_raw->active = 0;
+ cl->show_raw->data = data;
+ cl->show_raw->error_handler = error_handler;
+ cl->show_raw->record_handler = record_handler;
+ if (syntax)
+ cl->show_raw->syntax = xstrdup(syntax);
+ else
+ cl->show_raw->syntax = 0;
+ if (esn)
+ cl->show_raw->esn = xstrdup(esn);
+ else
+ cl->show_raw->esn = 0;
+ client_continue(cl);
+ return 0;
+}
+
+void client_show_raw_reset(struct client *cl)
+{
+ xfree(cl->show_raw);
+ cl->show_raw = 0;
+}
+
+static void client_show_raw_error(struct client *cl, const char *addinfo)
+{
+ if (cl->show_raw)
+ {
+ cl->show_raw->error_handler(cl->show_raw->data, addinfo);
+ client_show_raw_reset(cl);
+ }
+}
+
+static void client_show_raw_cancel(struct client *cl)
+{
+ if (cl->show_raw)
+ {
+ cl->show_raw->error_handler(cl->show_raw->data, "cancel");
+ client_show_raw_reset(cl);
+ }
+}
+
+void client_send_raw_present(struct client *cl)
+{
+ Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest);
+ int toget = 1;
+ int start = cl->show_raw->position;
+
+ assert(cl->show_raw);
+
+ yaz_log(YLOG_DEBUG, "Trying to present %d record(s) from %d",
+ toget, start);
+
+ a->u.presentRequest->resultSetStartPoint = &start;
+ a->u.presentRequest->numberOfRecordsRequested = &toget;
+
+ if (cl->show_raw->syntax) // syntax is optional
+ a->u.presentRequest->preferredRecordSyntax =
+ yaz_string_to_oid_odr(yaz_oid_std(),
+ CLASS_RECSYN, cl->show_raw->syntax,
+ global_parameters.odr_out);
+ if (cl->show_raw->esn) // element set is optional
+ {
+ Z_ElementSetNames *elementSetNames =
+ odr_malloc(global_parameters.odr_out, sizeof(*elementSetNames));
+ Z_RecordComposition *compo =
+ odr_malloc(global_parameters.odr_out, sizeof(*compo));
+ a->u.presentRequest->recordComposition = compo;
+
+ compo->which = Z_RecordComp_simple;
+ compo->u.simple = elementSetNames;
+
+ elementSetNames->which = Z_ElementSetNames_generic;
+ elementSetNames->u.generic =
+ odr_strdup(global_parameters.odr_out, cl->show_raw->esn);
+ }
+ if (send_apdu(cl, a) >= 0)
+ {
+ cl->show_raw->active = 1;
+ cl->state = Client_Presenting;
+ }
+ else
+ {
+ client_show_raw_error(cl, "send_apdu failed");
+ cl->state = Client_Error;
+ }
+ odr_reset(global_parameters.odr_out);
+}
+
void client_send_present(struct client *cl)
{
struct session_database *sdb = client_get_database(cl);
if (toget > cl->hits - cl->records)
toget = cl->hits - cl->records;
- yaz_log(YLOG_DEBUG, "Trying to present %d records\n", toget);
+ yaz_log(YLOG_DEBUG, "Trying to present %d record(s) from %d",
+ toget, start);
a->u.presentRequest->resultSetStartPoint = &start;
a->u.presentRequest->numberOfRecordsRequested = &toget;
- a->u.presentRequest->resultSetId = "Default";
-
if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
{
-#if YAZ_VERSIONL >= 0x020163
a->u.presentRequest->preferredRecordSyntax =
yaz_string_to_oid_odr(yaz_oid_std(),
CLASS_RECSYN, recsyn,
global_parameters.odr_out);
-#else
- a->u.presentRequest->preferredRecordSyntax =
- yaz_str_to_z3950oid(global_parameters.odr_out,
- CLASS_RECSYN, recsyn);
-#endif
}
if (send_apdu(cl, a) >= 0)
yaz_log(YLOG_DEBUG, "Sending search to %s", sdb->database->url);
+
// constructing RPN query
a->u.searchRequest->query = zquery = odr_malloc(global_parameters.odr_out,
sizeof(Z_Query));
for (ndb = 0; sdb->database->databases[ndb]; ndb++)
databaselist[ndb] = sdb->database->databases[ndb];
- if (!(piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK)) || *piggyback == '1')
+ if (!(piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK))
+ || *piggyback == '1')
{
if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
{
-#if YAZ_VERSIONL >= 0x020163
a->u.searchRequest->preferredRecordSyntax =
yaz_string_to_oid_odr(yaz_oid_std(),
CLASS_RECSYN, recsyn,
global_parameters.odr_out);
-#else
- a->u.searchRequest->preferredRecordSyntax =
- yaz_str_to_z3950oid(global_parameters.odr_out,
- CLASS_RECSYN, recsyn);
-#endif
}
a->u.searchRequest->smallSetUpperBound = &ssub;
a->u.searchRequest->largeSetLowerBound = &lslb;
a->u.searchRequest->mediumSetPresentNumber = &mspn;
}
- a->u.searchRequest->resultSetName = "Default";
a->u.searchRequest->databaseNames = databaselist;
a->u.searchRequest->num_databaseNames = ndb;
}
+static void ingest_raw_records(struct client *cl, Z_Records *r)
+{
+ 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;
+ }
+
+ doc = record_to_xml(client_get_database(cl), npr->u.databaseRecord);
+ if (!doc)
+ {
+ client_show_raw_error(cl, "unable to convert record to xml");
+ return;
+ }
+
+ xmlDocDumpMemory(doc, &buf_out, &len_out);
+ xmlFreeDoc(doc);
+
+ cl->show_raw->record_handler(cl->show_raw->data,
+ (const char *) buf_out, len_out);
+
+ xmlFree(buf_out);
+ xfree(cl->show_raw);
+ cl->show_raw = 0;
+}
+
static void ingest_records(struct client *cl, Z_Records *r)
{
#if USE_TIMING
Z_Records *recs = r->records;
if (recs->which == Z_Records_NSD)
{
- yaz_log(YLOG_WARN,
- "Search response: Non-surrogate diagnostic %s",
- cl->database->database->url);
+ yaz_log(YLOG_WARN,
+ "Search response: Non-surrogate diagnostic %s (%d)",
+ cl->database->database->url,
+ *recs->u.nonSurrogateDiagnostic->condition);
cl->diagnostic = *recs->u.nonSurrogateDiagnostic->condition;
cl->state = Client_Error;
}
cl->database->database->url);
cl->diagnostic = *recs->u.nonSurrogateDiagnostic->condition;
cl->state = Client_Error;
+ client_show_raw_error(cl, "non surrogate diagnostics");
}
}
{
yaz_log(YLOG_DEBUG, "Good Present response %s",
cl->database->database->url);
- ingest_records(cl, r->records);
+
+ // 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, r->records);
+ }
+ else
+ ingest_records(cl, r->records);
cl->state = Client_Idle;
}
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");
}
}
struct session_database *sdb = client_get_database(cl);
char *auth = session_setting_oneval(sdb, PZ_AUTHENTICATION);
- if (auth)
+ if (*auth)
{
+ struct connection *co = client_get_connection(cl);
+ struct session *se = client_get_session(cl);
Z_IdAuthentication *idAuth = odr_malloc(global_parameters.odr_out,
sizeof(*idAuth));
idAuth->which = Z_IdAuthentication_open;
idAuth->u.open = auth;
req->idAuthentication = idAuth;
+ connection_set_authentication(co, nmem_strdup(se->session_nmem, auth));
}
}
+static void init_zproxy(struct client *cl, Z_InitRequest *req)
+{
+ struct session_database *sdb = client_get_database(cl);
+ char *ztarget = sdb->database->url;
+ //char *ztarget = sdb->url;
+ char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
+
+ if (*zproxy)
+ yaz_oi_set_string_oid(&req->otherInfo,
+ global_parameters.odr_out,
+ yaz_oid_userinfo_proxy,
+ 1, ztarget);
+}
+
+
static void client_init_request(struct client *cl)
{
Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_initRequest);
ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_3);
init_authentication(cl, a->u.initRequest);
-
- /* add virtual host if tunneling through Z39.50 proxy */
-
- if (0 < strlen(global_parameters.zproxy_override)
- && 0 < strlen(client_get_database(cl)->database->url))
- {
-#if YAZ_VERSIONL >= 0x020163
- yaz_oi_set_string_oid(&a->u.initRequest->otherInfo,
- global_parameters.odr_out,
- yaz_oid_userinfo_proxy,
- 1, client_get_database(cl)->database->url);
-#else
- yaz_oi_set_string_oidval(&a->u.initRequest->otherInfo,
- global_parameters.odr_out, VAL_PROXY,
- 1, client_get_database(cl->database)->url);
-#endif
- }
+ init_zproxy(cl, a->u.initRequest);
if (send_apdu(cl, a) >= 0)
client_set_state(cl, Client_Initializing);
{
struct session *se = client_get_session(cl);
if (cl->requestid != se->requestid && cl->pquery) {
+ // we'll have to abort this because result set is to be deleted
+ client_show_raw_cancel(cl);
client_send_search(cl);
}
+ else if (cl->show_raw)
+ {
+ client_send_raw_present(cl);
+ }
else if (cl->hits > 0 && cl->records < global_parameters.toget &&
cl->records < cl->hits) {
client_send_present(cl);
r->requestid = -1;
r->diagnostic = 0;
r->state = Client_Disconnected;
+ r->show_raw = 0;
r->next = 0;
return r;
}
if (cc)
cc->next = c->next;
}
+ xfree(c->pquery);
+
if (c->connection)
connection_release(c->connection);
c->next = client_freelist;
}
wrbuf_rewind(se->wrbuf);
ccl_pquery(se->wrbuf, cn);
- wrbuf_putc(se->wrbuf, '\0');
- if (cl->pquery)
- xfree(cl->pquery);
- cl->pquery = xstrdup(wrbuf_buf(se->wrbuf));
+ xfree(cl->pquery);
+ cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
if (!se->relevance)
{
// Initialize relevance structure with query terms
char *p[512];
extract_terms(se->nmem, cn, p);
- se->relevance = relevance_create(se->nmem, (const char **) p,
- se->expected_maxrecs);
+ se->relevance = relevance_create(client_get_database(cl)->pct,
+ se->nmem, (const char **) p,
+ se->expected_maxrecs);
}
ccl_rpn_delete(cn);