-/* $Id: client.c,v 1.6 2007-06-02 04:32:28 quinn Exp $
- Copyright (c) 2006-2007, Index Data.
-
-This file is part of Pazpar2.
+/* This file is part of Pazpar2.
+ Copyright (C) 2006-2010 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 <pthread.h>
#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/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"
-#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 "ppmutex.h"
+#include "session.h"
+#include "parameters.h"
#include "client.h"
#include "connection.h"
#include "settings.h"
+#include "relevance.h"
+#include "incref.h"
+
+/* client counting (1) , disable client counting (0) */
+#if 1
+static YAZ_MUTEX g_mutex = 0;
+static int no_clients = 0;
+
+static void client_use(int delta)
+{
+ if (!g_mutex)
+ yaz_mutex_create(&g_mutex);
+ yaz_mutex_enter(g_mutex);
+ no_clients += delta;
+ yaz_mutex_leave(g_mutex);
+ yaz_log(YLOG_LOG, "%s clients=%d", delta > 0 ? "INC" : "DEC", no_clients);
+}
+#else
+#define client_use(x)
+#endif
/** \brief Represents client state for a connection to one search target */
struct client {
struct connection *connection;
struct session *session;
char *pquery; // Current search
- int hits;
- int records;
- int setno;
- int requestid; // ID of current outstanding request
+ char *cqlquery; // used for SRU targets only
+ Odr_int hits;
+ int record_offset;
+ int maxrecs;
+ int startrecs;
int diagnostic;
enum client_state state;
- struct client *next; // next client in session or next in free list
+ struct show_raw *show_raw;
+ ZOOM_resultset resultset;
+ YAZ_MUTEX mutex;
+ int ref_count;
+};
+
+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;
+ /* no need to check for all client being non-active if this one
+ already is. Note that session_active_clients also LOCKS session */
+#if 0
+ if (!client_is_active(cl) && cl->session)
+ {
+ int no_active = session_active_clients(cl->session);
+ if (no_active == 0)
+ session_alert_watch(cl->session, SESSION_WATCH_SHOW);
+ }
+#endif
}
-// Close connection and set state to error
-void client_fatal(struct client *cl)
-{
- yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
- connection_destroy(cl->connection);
- cl->state = Client_Error;
-}
+static void client_show_raw_error(struct client *cl, const char *addinfo);
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);
+static int nativesyntax_to_type(struct session_database *sdb, char *type,
+ ZOOM_record rec);
-void client_send_present(struct client *cl)
+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)
{
- 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;
-
- 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;
-
- yaz_log(YLOG_DEBUG, "Trying to present %d records\n", toget);
+ ZOOM_record rec = 0;
+ char type[80];
+ const char *buf;
+ int len;
- a->u.presentRequest->resultSetStartPoint = &start;
- a->u.presentRequest->numberOfRecordsRequested = &toget;
-
- a->u.presentRequest->resultSetId = "Default";
-
- if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
+ if (!resultset)
{
-#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
+ error_handler(data, "no resultset");
+ return;
}
-
- if (send_apdu(cl, a) >= 0)
- cl->state = Client_Presenting;
+ rec = ZOOM_resultset_record(resultset, position-1);
+ if (!rec)
+ {
+ error_handler(data, "no record");
+ return;
+ }
+ if (binary)
+ strcpy(type, "raw");
else
- cl->state = Client_Error;
- odr_reset(global_parameters.odr_out);
+ 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 client_send_search(struct client *cl)
+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),
+ int binary)
{
- 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);
- }
-
- 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];
-
- if (!(piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK)) || *piggyback == '1')
+ if (syntax == 0 && esn == 0)
+ client_show_immediate(cl->resultset, client_get_database(cl),
+ position, data,
+ error_handler, record_handler,
+ binary);
+ else
{
- 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;
+ struct show_raw *rr, **rrp;
+ if (!cl->connection)
+ return -1;
- { //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)
+ 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_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));
+ client_show_raw_error(cl, "client failed");
}
- 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 if (cl->state == Client_Disconnected)
+ {
+ client_show_raw_error(cl, "client disconnected");
}
-
- wrbuf_destroy(wbquery);
- }
+ else
+ {
+ client_send_raw_present(cl);
+ }
+ }
+ return 0;
+}
- odr_reset(global_parameters.odr_out);
+static void client_show_raw_delete(struct show_raw *r)
+{
+ xfree(r->syntax);
+ xfree(r->esn);
+ xfree(r);
}
-void client_init_response(struct client *cl, Z_APDU *a)
+void client_show_raw_remove(struct client *cl, void *data)
{
- Z_InitResponse *r = a->u.initResponse;
+ struct show_raw *rr = data;
+ struct show_raw **rrp = &cl->show_raw;
+ while (*rrp != rr)
+ rrp = &(*rrp)->next;
+ if (*rrp)
+ {
+ *rrp = rr->next;
+ client_show_raw_delete(rr);
+ }
+}
- yaz_log(YLOG_DEBUG, "Init response %s", cl->database->database->url);
+void client_show_raw_dequeue(struct client *cl)
+{
+ struct show_raw *rr = cl->show_raw;
- if (*r->result)
+ cl->show_raw = rr->next;
+ client_show_raw_delete(rr);
+}
+
+static void client_show_raw_error(struct client *cl, const char *addinfo)
+{
+ while (cl->show_raw)
{
- cl->state = Client_Idle;
+ cl->show_raw->error_handler(cl->show_raw->data, addinfo);
+ client_show_raw_dequeue(cl);
}
- else
- cl->state = Client_Failed; // FIXME need to do something to the connection
}
-
-static void ingest_records(struct client *cl, Z_Records *r)
+static void client_send_raw_present(struct client *cl)
{
-#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;
+ struct session_database *sdb = client_get_database(cl);
+ struct connection *co = client_get_connection(cl);
+ ZOOM_resultset set = cl->resultset;
- if (r->which != Z_Records_DBOSD)
- return;
- rlist = r->u.databaseOrSurDiagnostics;
- for (i = 0; i < rlist->num_records; i++)
- {
- Z_NamePlusRecord *npr = rlist->records[i];
+ int offset = cl->show_raw->position;
+ const char *syntax = 0;
+ const char *elements = 0;
- cl->records++;
- if (npr->which != Z_NamePlusRecord_databaseRecord)
- {
- yaz_log(YLOG_WARN,
- "Unexpected record type, probably diagnostic %s",
- cl->database->database->url);
- continue;
- }
+ assert(cl->show_raw);
+ assert(set);
- rec = ingest_record(cl, npr->u.databaseRecord, cl->records);
- if (!rec)
- continue;
- }
- if (rlist->num_records)
- session_alert_watch(s, SESSION_WATCH_RECORDS);
+ yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
+ client_get_url(cl), 1, offset);
-#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
-}
+ 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 (cl->show_raw->esn)
+ elements = cl->show_raw->esn;
+ else
+ 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_search_response(struct client *cl, Z_APDU *a)
-{
- struct session *se = cl->session;
- Z_SearchResponse *r = a->u.searchResponse;
+ connection_continue(co);
+}
- yaz_log(YLOG_DEBUG, "Search response %s (status=%d)",
- cl->database->database->url, *r->searchStatus);
+static int nativesyntax_to_type(struct session_database *sdb, char *type,
+ ZOOM_record rec)
+{
+ const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
- if (*r->searchStatus)
+ if (s && *s)
{
- cl->hits = *r->resultCount;
- se->total_hits += cl->hits;
- if (r->presentStatus && !*r->presentStatus && r->records)
+ 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))
{
- yaz_log(YLOG_DEBUG, "Records in search response %s",
- cl->database->database->url);
- ingest_records(cl, r->records);
+ strcpy(type, "xml");
}
- cl->state = Client_Idle;
+ 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;
}
- else
- { /*"FAILED"*/
- cl->hits = 0;
- cl->state = Client_Error;
- if (r->records) {
- Z_Records *recs = r->records;
- if (recs->which == Z_Records_NSD)
+ 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"))
{
- 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;
+ strcpy(type, "xml; charset=marc8-s");
+ return 0;
}
+ else return -1;
}
+ else return -1;
}
}
-void client_present_response(struct client *cl, Z_APDU *a)
+static void ingest_raw_record(struct client *cl, ZOOM_record rec)
{
- Z_PresentResponse *r = a->u.presentResponse;
+ const char *buf;
+ int len;
+ char type[80];
- if (r->records) {
- Z_Records *recs = r->records;
- if (recs->which == Z_Records_NSD)
- {
- yaz_log(YLOG_WARN, "Non-surrogate diagnostic %s",
- cl->database->database->url);
- cl->diagnostic = *recs->u.nonSurrogateDiagnostic->condition;
- cl->state = Client_Error;
- }
+ if (cl->show_raw->binary)
+ strcpy(type, "raw");
+ else
+ {
+ struct session_database *sdb = client_get_database(cl);
+ nativesyntax_to_type(sdb, type, rec);
}
- if (!*r->presentStatus && cl->state != Client_Error)
+ 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 = cl->resultset;
+ const char *error, *addinfo = 0;
+
+ if (ZOOM_connection_error(link, &error, &addinfo))
{
- yaz_log(YLOG_DEBUG, "Good Present response %s",
- cl->database->database->url);
- ingest_records(cl, r->records);
- cl->state = Client_Idle;
+ cl->hits = 0;
+ client_set_state(cl, Client_Error);
+ yaz_log(YLOG_WARN, "Search error %s (%s): %s",
+ error, addinfo, client_get_url(cl));
}
- else if (*r->presentStatus)
+ else
{
- yaz_log(YLOG_WARN, "Bad Present response %s",
- cl->database->database->url);
- cl->state = Client_Error;
+ cl->record_offset = cl->startrecs;
+ cl->hits = ZOOM_resultset_size(resultset);
+ if (se)
+ se->total_hits += cl->hits;
}
}
-void client_close_response(struct client *cl, Z_APDU *a)
+void client_got_records(struct client *cl)
{
- 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);
+ 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);
+ }
}
-int client_is_our_response(struct client *cl)
+void client_record_response(struct client *cl)
{
- struct session *se = client_get_session(cl);
+ struct connection *co = cl->connection;
+ ZOOM_connection link = connection_get_link(co);
+ ZOOM_resultset resultset = cl->resultset;
+ const char *error, *addinfo;
- if (cl && (cl->requestid == se->requestid ||
- cl->state == Client_Initializing))
- return 1;
- return 0;
+ if (ZOOM_connection_error(link, &error, &addinfo))
+ {
+ 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 = 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, "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 (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_url(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_url(cl));
+ else
+ {
+ if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
+ yaz_log(YLOG_WARN, "Failed to ingest from %s",
+ client_get_url(cl));
+ }
+ nmem_destroy(nmem);
+ }
+ }
+ else
+ {
+ yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
+ offset);
+ }
+ }
+ }
}
-// 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);
+ const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
+ char maxrecs_str[24], startrecs_str[24];
+
+ 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)
{
- 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));
+ sprintf(maxrecs_str, "%d", cl->maxrecs);
+ opt_maxrecs = maxrecs_str;
}
-}
+ ZOOM_connection_option_set(link, "count", opt_maxrecs);
-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);
+ if (atoi(opt_maxrecs) > 20)
+ ZOOM_connection_option_set(link, "presentChunk", "20");
+ else
+ ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
- 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);
+ sprintf(startrecs_str, "%d", cl->startrecs);
+ ZOOM_connection_option_set(link, "start", startrecs_str);
- init_authentication(cl, a->u.initRequest);
+ if (databaseName)
+ ZOOM_connection_option_set(link, "databaseName", databaseName);
- /* 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 (cl->cqlquery)
{
-#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
+ 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);
}
-
- 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->state == Client_Idle)
{
- struct session *se = client_get_session(cl);
- if (cl->requestid != se->requestid && cl->pquery) {
- client_send_search(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);
}
+ 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));
+ struct client *r = xmalloc(sizeof(*r));
+ r->maxrecs = 100;
+ r->startrecs = 0;
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->next = 0;
+ r->show_raw = 0;
+ r->resultset = 0;
+ r->mutex = 0;
+ pazpar2_mutex_create(&r->mutex, "client");
+
+ r->ref_count = 1;
+ client_use(1);
+
return r;
}
-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);
+}
+
+void client_incref(struct client *c)
+{
+ pazpar2_incref(&c->ref_count, c->mutex);
+ yaz_log(YLOG_LOG, "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_LOG, "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;
+ assert(!c->connection);
+ assert(!c->resultset);
+
+ yaz_mutex_destroy(&c->mutex);
+ xfree(c);
+ client_use(-1);
+ return 1;
+ }
}
- 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_destroy(cl->resultset);
+ cl->resultset = 0;
+ }
+ 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)
{
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;
+ 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;
+}
+
// 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);
+ const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
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;
- yaz_log(YLOG_WARN, "Failed to parse query for %s",
- client_get_database(cl)->database->url);
+ client_set_state(cl, Client_Error);
+ yaz_log(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 (!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));
+ 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(
+ 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_Connecting ||
- cl->state == Client_Initializing ||
- cl->state == Client_Searching ||
- cl->state == Client_Presenting))
+ cl->state == Client_Working))
return 1;
return 0;
}
-struct client *client_next_in_session(struct client *cl)
+Odr_int client_get_hits(struct client *cl)
{
- if (cl)
- return cl->next;
- return 0;
-
+ return cl->hits;
}
-int client_get_hits(struct client *cl)
+int client_get_num_records(struct client *cl)
{
- return cl->hits;
+ return cl->record_offset;
}
-int client_get_num_records(struct client *cl)
+void client_set_diagnostic(struct client *cl, int diagnostic)
{
- return cl->records;
+ cl->diagnostic = diagnostic;
}
int client_get_diagnostic(struct client *cl)
const char *client_get_url(struct client *cl)
{
- return client_get_database(cl)->database->url;
+ if (cl->database)
+ return client_get_database(cl)->database->url;
+ else
+ return "NOURL";
+}
+
+void client_set_maxrecs(struct client *cl, int v)
+{
+ cl->maxrecs = v;
+}
+
+void client_set_startrecs(struct client *cl, int v)
+{
+ cl->startrecs = v;
}
/*
* Local variables:
* c-basic-offset: 4
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
* End:
* vim: shiftwidth=4 tabstop=8 expandtab
*/
+
projects / pazpar2-moved-to-github.git / blobdiff