-/* $Id: client.c,v 1.9 2007-06-15 06:45:39 adam Exp $
- Copyright (c) 2006-2007, Index Data.
-
-This file is part of Pazpar2.
+/* This file is part of Pazpar2.
+ 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
for more details.
You should have received a copy of the GNU General Public License
-along with Pazpar2; see the file LICENSE. If not, write to the
-Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
- */
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+*/
/** \file client.c
\brief Z39.50 client
*/
+#if HAVE_CONFIG_H
+#include <config.h>
+#endif
+
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
+#if HAVE_SYS_TIME_H
#include <sys/time.h>
+#endif
+#if HAVE_UNISTD_H
#include <unistd.h>
-#include <sys/socket.h>
-#include <netdb.h>
+#endif
#include <signal.h>
-#include <ctype.h>
#include <assert.h>
#include <yaz/marcdisp.h>
#include <yaz/query-charset.h>
#include <yaz/querytowrbuf.h>
#include <yaz/oid_db.h>
-
-#if HAVE_CONFIG_H
-#include "cconfig.h"
-#endif
+#include <yaz/diagbib1.h>
+#include <yaz/snprintf.h>
+#include <yaz/rpn2cql.h>
#define USE_TIMING 0
#if USE_TIMING
#include <yaz/timing.h>
#endif
-#include <netinet/in.h>
-
#include "pazpar2.h"
#include "client.h"
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 show_raw {
int active; // whether this request has been sent to the server
int position;
+ int binary;
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;
+ struct show_raw *next;
};
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_Disconnected"
};
static struct client *client_freelist = 0;
-static int send_apdu(struct client *c, Z_APDU *a)
-{
- return connection_send_apdu(client_get_connection(c), a);
-}
-
-
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)
{
cl->state = st;
+ if (cl->session)
+ {
+ int no_active = session_active_clients(cl->session);
+ if (no_active == 0)
+ session_alert_watch(cl->session, SESSION_WATCH_SHOW);
+ }
}
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;
+ client_set_state(cl, Client_Error);
}
struct connection *client_get_connection(struct client *cl)
return cl->pquery;
}
-void client_set_requestid(struct client *cl, int id)
-{
- cl->requestid = id;
-}
+static void client_send_raw_present(struct client *cl);
-int client_show_raw(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))
+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),
+ void **data2,
+ int binary)
{
- if (cl->show_raw)
+ struct show_raw *rr, **rrp;
+ if (!cl->connection)
+ { /* the client has no connection */
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;
+ }
+ 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)
- cl->show_raw->syntax = xstrdup(syntax);
+ rr->syntax = xstrdup(syntax);
else
- cl->show_raw->syntax = 0;
+ rr->syntax = 0;
if (esn)
- cl->show_raw->esn = xstrdup(esn);
+ rr->esn = xstrdup(esn);
else
- cl->show_raw->esn = 0;
- client_continue(cl);
- return 0;
-}
-
-static void client_show_raw_error(struct client *cl, const char *addinfo)
-{
- if (cl->show_raw)
+ rr->esn = 0;
+ rr->next = 0;
+
+ for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
+ ;
+ *rrp = rr;
+
+ if (cl->state == Client_Failed)
{
- cl->show_raw->error_handler(cl->show_raw->data, addinfo);
- xfree(cl->show_raw);
- cl->show_raw = 0;
+ 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)
+void client_show_raw_remove(struct client *cl, void *data)
{
- if (cl->show_raw)
+ struct show_raw *rr = data;
+ struct show_raw **rrp = &cl->show_raw;
+ while (*rrp != rr)
+ rrp = &(*rrp)->next;
+ if (*rrp)
{
- cl->show_raw->error_handler(cl->show_raw->data, "cancel");
- xfree(cl->show_raw);
- cl->show_raw = 0;
+ *rrp = rr->next;
+ xfree(rr);
}
}
-void client_send_raw_present(struct client *cl)
+void client_show_raw_dequeue(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_LOG, "Trying to present %d record(s) from %d",
- toget, start);
+ struct show_raw *rr = cl->show_raw;
- a->u.presentRequest->resultSetStartPoint = &start;
- a->u.presentRequest->numberOfRecordsRequested = &toget;
+ cl->show_raw = rr->next;
+ xfree(rr);
+}
- 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
+static void client_show_raw_error(struct client *cl, const char *addinfo)
+{
+ while (cl->show_raw)
{
- client_show_raw_error(cl, "send_apdu failed");
- cl->state = Client_Error;
+ cl->show_raw->error_handler(cl->show_raw->data, addinfo);
+ client_show_raw_dequeue(cl);
}
- odr_reset(global_parameters.odr_out);
}
-void client_send_present(struct client *cl)
+static void client_send_raw_present(struct client *cl)
{
struct session_database *sdb = client_get_database(cl);
- Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest);
- int toget;
- int start = cl->records + 1;
- char *recsyn;
+ struct connection *co = client_get_connection(cl);
+ ZOOM_resultset set = connection_get_resultset(co);
- toget = global_parameters.chunk;
- if (toget > global_parameters.toget - cl->records)
- toget = global_parameters.toget - cl->records;
- if (toget > cl->hits - cl->records)
- toget = cl->hits - cl->records;
+ int offset = cl->show_raw->position;
+ const char *syntax = 0;
+ const char *elements = 0;
- yaz_log(YLOG_DEBUG, "Trying to present %d record(s) from %d",
- toget, start);
+ assert(cl->show_raw);
+ assert(set);
- a->u.presentRequest->resultSetStartPoint = &start;
- a->u.presentRequest->numberOfRecordsRequested = &toget;
+ yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
+ client_get_url(cl), 1, offset);
- if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
- {
- a->u.presentRequest->preferredRecordSyntax =
- yaz_string_to_oid_odr(yaz_oid_std(),
- CLASS_RECSYN, recsyn,
- global_parameters.odr_out);
- }
+ if (cl->show_raw->syntax)
+ syntax = cl->show_raw->syntax;
+ else
+ syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
+ ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
- if (send_apdu(cl, a) >= 0)
- cl->state = Client_Presenting;
+ if (cl->show_raw->esn)
+ elements = cl->show_raw->esn;
else
- cl->state = Client_Error;
- odr_reset(global_parameters.odr_out);
-}
+ elements = session_setting_oneval(sdb, PZ_ELEMENTS);
+ if (elements && *elements)
+ ZOOM_resultset_option_set(set, "elementSetName", elements);
+ ZOOM_resultset_records(set, 0, offset-1, 1);
+ cl->show_raw->active = 1;
-void client_send_search(struct client *cl)
-{
- struct session *se = client_get_session(cl);
- struct session_database *sdb = client_get_database(cl);
- Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_searchRequest);
- int ndb;
- char **databaselist;
- Z_Query *zquery;
- int ssub = 0, lslb = 100000, mspn = 10;
- char *recsyn = 0;
- char *piggyback = 0;
- char *queryenc = 0;
- yaz_iconv_t iconv = 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));
- zquery->which = Z_Query_type_1;
- zquery->u.type_1 = p_query_rpn(global_parameters.odr_out,
- client_get_pquery(cl));
-
- // converting to target encoding
- if ((queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING))){
- iconv = yaz_iconv_open(queryenc, "UTF-8");
- if (iconv){
- yaz_query_charset_convert_rpnquery(zquery->u.type_1,
- global_parameters.odr_out,
- iconv);
- yaz_iconv_close(iconv);
- } else
- yaz_log(YLOG_WARN, "Query encoding failed %s %s",
- client_get_database(cl)->database->url, queryenc);
- }
+ connection_continue(co);
+}
- for (ndb = 0; sdb->database->databases[ndb]; ndb++)
- ;
- databaselist = odr_malloc(global_parameters.odr_out, sizeof(char*) * ndb);
- for (ndb = 0; sdb->database->databases[ndb]; ndb++)
- databaselist[ndb] = sdb->database->databases[ndb];
+static int nativesyntax_to_type(struct session_database *sdb, char *type, ZOOM_record rec)
+{
+ const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
- if (!(piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK))
- || *piggyback == '1')
+ if (s && *s)
{
- if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
+ if (!strncmp(s, "iso2709", 7))
{
- a->u.searchRequest->preferredRecordSyntax =
- yaz_string_to_oid_odr(yaz_oid_std(),
- CLASS_RECSYN, recsyn,
- global_parameters.odr_out);
+ const char *cp = strchr(s, ';');
+ yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
}
- 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;
-
-
- { //scope for sending and logging queries
- WRBUF wbquery = wrbuf_alloc();
- yaz_query_to_wrbuf(wbquery, a->u.searchRequest->query);
-
-
- if (send_apdu(cl, a) >= 0)
+ else if (!strncmp(s, "xml", 3))
{
- client_set_state(cl, Client_Searching);
- client_set_requestid(cl, se->requestid);
- yaz_log(YLOG_LOG, "SearchRequest %s %s %s",
- client_get_database(cl)->database->url,
- queryenc ? queryenc : "UTF-8",
- wrbuf_cstr(wbquery));
+ strcpy(type, "xml");
}
- else {
- client_set_state(cl, Client_Error);
- yaz_log(YLOG_WARN, "Failed SearchRequest %s %s %s",
- client_get_database(cl)->database->url,
- queryenc ? queryenc : "UTF-8",
- wrbuf_cstr(wbquery));
+ else
+ return -1;
+ return 0;
+ }
+ 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, "USmarc") || !strcmp(syntax, "MARC21"))
+ {
+ strcpy(type, "xml; charset=marc8-s");
+ return 0;
+ }
+ else return -1;
}
-
- wrbuf_destroy(wbquery);
- }
-
- odr_reset(global_parameters.odr_out);
+ else return -1;
+ }
}
-void client_init_response(struct client *cl, Z_APDU *a)
+static void ingest_raw_record(struct client *cl, ZOOM_record rec)
{
- Z_InitResponse *r = a->u.initResponse;
+ const char *buf;
+ int len;
+ char type[80];
- yaz_log(YLOG_DEBUG, "Init response %s", cl->database->database->url);
-
- if (*r->result)
+ if (cl->show_raw->binary)
+ strcpy(type, "raw");
+ else
{
- cl->state = Client_Idle;
+ struct session_database *sdb = client_get_database(cl);
+ nativesyntax_to_type(sdb, type, rec);
}
- else
- cl->state = Client_Failed; // FIXME need to do something to the connection
-}
+ buf = ZOOM_record_get(rec, type, &len);
+ cl->show_raw->record_handler(cl->show_raw->data, buf, len);
+ client_show_raw_dequeue(cl);
+}
-static void ingest_raw_records(struct client *cl, Z_Records *r)
+void client_search_response(struct client *cl)
{
- 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;
- }
+ 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;
- doc = record_to_xml(client_get_database(cl), npr->u.databaseRecord);
- if (!doc)
+ if (ZOOM_connection_error(link, &error, &addinfo))
{
- client_show_raw_error(cl, "unable to convert record to xml");
- return;
+ cl->hits = 0;
+ client_set_state(cl, Client_Error);
+ yaz_log(YLOG_WARN, "Search error %s (%s): %s",
+ error, addinfo, client_get_url(cl));
}
-
- xmlDocDumpMemory(doc, &buf_out, &len_out);
-
- cl->show_raw->record_handler(cl->show_raw->data,
- (const char *) buf_out, len_out);
-
- xmlFreeDoc(doc);
- xfree(cl->show_raw);
- cl->show_raw = 0;
-}
-
-static void ingest_records(struct client *cl, Z_Records *r)
-{
-#if USE_TIMING
- yaz_timing_t t = yaz_timing_create();
-#endif
- struct record *rec;
- struct session *s = client_get_session(cl);
- Z_NamePlusRecordList *rlist;
- int i;
-
- if (r->which != Z_Records_DBOSD)
- return;
- rlist = r->u.databaseOrSurDiagnostics;
- for (i = 0; i < rlist->num_records; i++)
+ else
{
- Z_NamePlusRecord *npr = rlist->records[i];
-
- cl->records++;
- if (npr->which != Z_NamePlusRecord_databaseRecord)
- {
- yaz_log(YLOG_WARN,
- "Unexpected record type, probably diagnostic %s",
- cl->database->database->url);
- continue;
- }
-
- rec = ingest_record(cl, npr->u.databaseRecord, cl->records);
- if (!rec)
- continue;
+ cl->record_offset = 0;
+ cl->hits = ZOOM_resultset_size(resultset);
+ se->total_hits += cl->hits;
}
- if (rlist->num_records)
- session_alert_watch(s, SESSION_WATCH_RECORDS);
-
-#if USE_TIMING
- yaz_timing_stop(t);
- yaz_log(YLOG_LOG, "ingest_records %6.5f %3.2f %3.2f",
- yaz_timing_get_real(t), yaz_timing_get_user(t),
- yaz_timing_get_sys(t));
- yaz_timing_destroy(&t);
-#endif
}
-void client_search_response(struct client *cl, Z_APDU *a)
+void client_record_response(struct client *cl)
{
- struct session *se = cl->session;
- Z_SearchResponse *r = a->u.searchResponse;
-
- yaz_log(YLOG_DEBUG, "Search response %s (status=%d)",
- cl->database->database->url, *r->searchStatus);
+ struct connection *co = cl->connection;
+ ZOOM_connection link = connection_get_link(co);
+ ZOOM_resultset resultset = connection_get_resultset(co);
+ const char *error, *addinfo;
- if (*r->searchStatus)
+ if (ZOOM_connection_error(link, &error, &addinfo))
{
- cl->hits = *r->resultCount;
- se->total_hits += cl->hits;
- if (r->presentStatus && !*r->presentStatus && r->records)
- {
- yaz_log(YLOG_DEBUG, "Records in search response %s",
- cl->database->database->url);
- ingest_records(cl, r->records);
- }
- cl->state = Client_Idle;
+ client_set_state(cl, Client_Error);
+ yaz_log(YLOG_WARN, "Search error %s (%s): %s",
+ error, addinfo, client_get_url(cl));
}
else
- { /*"FAILED"*/
- cl->hits = 0;
- cl->state = Client_Error;
- if (r->records) {
- Z_Records *recs = r->records;
- if (recs->which == Z_Records_NSD)
+ {
+ 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)))
+ {
+ cl->show_raw->active = 0;
+ ingest_raw_record(cl, rec);
+ }
+ else
{
- 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;
+ yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
+ cl->show_raw->position-1);
}
}
- }
-}
-
-void client_present_response(struct client *cl, Z_APDU *a)
-{
- Z_PresentResponse *r = a->u.presentResponse;
-
- if (r->records) {
- Z_Records *recs = r->records;
- if (recs->which == Z_Records_NSD)
+ else
{
- yaz_log(YLOG_WARN, "Non-surrogate diagnostic %s",
- cl->database->database->url);
- cl->diagnostic = *recs->u.nonSurrogateDiagnostic->condition;
- cl->state = Client_Error;
- client_show_raw_error(cl, "non surrogate diagnostics");
- }
- }
-
- if (!*r->presentStatus && cl->state != Client_Error)
- {
- yaz_log(YLOG_DEBUG, "Good Present response %s",
- cl->database->database->url);
+ 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
+ {
+ 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)))
+ {
+ 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 extract ZOOM record");
+ }
- // 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
+ {
+ yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
+ offset);
+ }
}
- 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");
}
}
-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);
-}
-
-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;
-}
-
-// Set authentication token in init if one is set for the client
-// TODO: Extend this to handle other schemes than open (should be simple)
-static void init_authentication(struct client *cl, Z_InitRequest *req)
+void client_start_search(struct client *cl)
{
struct session_database *sdb = client_get_database(cl);
- char *auth = session_setting_oneval(sdb, PZ_AUTHENTICATION);
-
- if (*auth)
+ struct connection *co = client_get_connection(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);
+
+ assert(link);
+
+ cl->hits = -1;
+ cl->record_offset = 0;
+ cl->diagnostic = 0;
+ client_set_state(cl, Client_Working);
+
+ if (*opt_piggyback)
+ ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
+ else
+ ZOOM_connection_option_set(link, "piggyback", "1");
+ if (*opt_queryenc)
+ ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
+ 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);
+ if (*opt_maxrecs)
+ ZOOM_connection_option_set(link, "count", opt_maxrecs);
+ else
{
- 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));
+ char n[128];
+ sprintf(n, "%d", global_parameters.toget);
+ ZOOM_connection_option_set(link, "count", n);
}
-}
-
-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);
-}
+ if (databaseName)
+ ZOOM_connection_option_set(link, "databaseName", databaseName);
+ ZOOM_connection_option_set(link, "presentChunk", "20");
-static void client_init_request(struct client *cl)
-{
- Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_initRequest);
-
- a->u.initRequest->implementationId = global_parameters.implementationId;
- a->u.initRequest->implementationName = global_parameters.implementationName;
- a->u.initRequest->implementationVersion =
- global_parameters.implementationVersion;
- ODR_MASK_SET(a->u.initRequest->options, Z_Options_search);
- ODR_MASK_SET(a->u.initRequest->options, Z_Options_present);
- ODR_MASK_SET(a->u.initRequest->options, Z_Options_namedResultSets);
-
- ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_1);
- ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_2);
- ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_3);
-
- init_authentication(cl, a->u.initRequest);
- init_zproxy(cl, a->u.initRequest);
-
- if (send_apdu(cl, a) >= 0)
- client_set_state(cl, Client_Initializing);
- else
- client_set_state(cl, Client_Error);
- odr_reset(global_parameters.odr_out);
-}
-
-void client_continue(struct client *cl)
-{
- if (cl->state == Client_Connected) {
- client_init_request(cl);
+ 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);
}
-
- if (cl->state == Client_Idle)
+ else
{
- 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);
- }
+ 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);
+ 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;
if (cc)
cc->next = c->next;
}
+ xfree(c->pquery);
+ xfree(c->cqlquery);
+
if (c->connection)
connection_release(c->connection);
c->next = client_freelist;
void client_disconnect(struct client *cl)
{
if (cl->state != Client_Idle)
- cl->state = Client_Disconnected;
+ client_set_state(cl, Client_Disconnected);
client_set_connection(cl, 0);
}
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;
+
+ zquery = p_query_rpn(global_parameters.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);
+ return 0;
+ }
+ r = xstrdup(wrbuf_cstr(wrb));
+
+ wrbuf_destroy(wrb);
+ odr_reset(global_parameters.odr_out); // releases the zquery
+ 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;
+
cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
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(client_get_database(cl)->pct,
- se->nmem, (const char **) p,
- se->expected_maxrecs);
+ se->relevance = relevance_create(
+ global_parameters.server->relevance_pct,
+ se->nmem, (const char **) p,
+ se->expected_maxrecs);
}
ccl_rpn_delete(cn);
int client_is_active(struct client *cl)
{
if (cl->connection && (cl->state == Client_Connecting ||
- cl->state == Client_Initializing ||
- cl->state == Client_Searching ||
- cl->state == Client_Presenting))
+ 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
*/
+