1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2009 Index Data
4 Pazpar2 is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
40 #include <yaz/marcdisp.h>
41 #include <yaz/comstack.h>
42 #include <yaz/tcpip.h>
43 #include <yaz/proto.h>
44 #include <yaz/readconf.h>
45 #include <yaz/pquery.h>
46 #include <yaz/otherinfo.h>
47 #include <yaz/yaz-util.h>
49 #include <yaz/query-charset.h>
50 #include <yaz/querytowrbuf.h>
51 #include <yaz/oid_db.h>
52 #include <yaz/diagbib1.h>
53 #include <yaz/snprintf.h>
54 #include <yaz/rpn2cql.h>
58 #include <yaz/timing.h>
64 #include "connection.h"
67 /** \brief Represents client state for a connection to one search target */
69 struct session_database *database;
70 struct connection *connection;
71 struct session *session;
72 char *pquery; // Current search
73 char *cqlquery; // used for SRU targets only
77 enum client_state state;
78 struct show_raw *show_raw;
79 struct client *next; // next client in session or next in free list
83 int active; // whether this request has been sent to the server
88 void (*error_handler)(void *data, const char *addinfo);
89 void (*record_handler)(void *data, const char *buf, size_t sz);
91 struct show_raw *next;
94 static const char *client_states[] = {
100 "Client_Disconnected"
103 static struct client *client_freelist = 0;
105 const char *client_get_state_str(struct client *cl)
107 return client_states[cl->state];
110 enum client_state client_get_state(struct client *cl)
115 void client_set_state(struct client *cl, enum client_state st)
120 int no_active = session_active_clients(cl->session);
122 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
126 static void client_show_raw_error(struct client *cl, const char *addinfo);
128 // Close connection and set state to error
129 void client_fatal(struct client *cl)
131 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
132 connection_destroy(cl->connection);
133 client_set_state(cl, Client_Error);
136 struct connection *client_get_connection(struct client *cl)
138 return cl->connection;
141 struct session_database *client_get_database(struct client *cl)
146 struct session *client_get_session(struct client *cl)
151 const char *client_get_pquery(struct client *cl)
156 static void client_send_raw_present(struct client *cl);
157 static int nativesyntax_to_type(struct session_database *sdb, char *type,
160 static void client_show_immediate(struct client *cl, int position,
162 void (*error_handler)(void *data, const char *addinfo),
163 void (*record_handler)(void *data, const char *buf,
167 struct connection *co = cl->connection;
168 struct session_database *sdb = client_get_database(cl);
169 ZOOM_resultset resultset = 0;
177 resultset = connection_get_resultset(co);
180 error_handler(data, "no resultset");
183 rec = ZOOM_resultset_record(resultset, position-1);
186 error_handler(data, "no record");
192 nativesyntax_to_type(sdb, type, rec);
193 buf = ZOOM_record_get(rec, type, &len);
196 error_handler(data, "no record");
199 record_handler(data, buf, len);
203 int client_show_raw_begin(struct client *cl, int position,
204 const char *syntax, const char *esn,
206 void (*error_handler)(void *data, const char *addinfo),
207 void (*record_handler)(void *data, const char *buf,
214 if (syntax == 0 && esn == 0)
215 client_show_immediate(cl, position, data,
216 error_handler, record_handler,
220 struct show_raw *rr, **rrp;
221 rr = xmalloc(sizeof(*rr));
222 rr->position = position;
225 rr->error_handler = error_handler;
226 rr->record_handler = record_handler;
229 rr->syntax = xstrdup(syntax);
233 rr->esn = xstrdup(esn);
238 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
242 if (cl->state == Client_Failed)
244 client_show_raw_error(cl, "client failed");
246 else if (cl->state == Client_Disconnected)
248 client_show_raw_error(cl, "client disconnected");
252 client_send_raw_present(cl);
258 void client_show_raw_remove(struct client *cl, void *data)
260 struct show_raw *rr = data;
261 struct show_raw **rrp = &cl->show_raw;
271 void client_show_raw_dequeue(struct client *cl)
273 struct show_raw *rr = cl->show_raw;
275 cl->show_raw = rr->next;
279 static void client_show_raw_error(struct client *cl, const char *addinfo)
283 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
284 client_show_raw_dequeue(cl);
288 static void client_send_raw_present(struct client *cl)
290 struct session_database *sdb = client_get_database(cl);
291 struct connection *co = client_get_connection(cl);
292 ZOOM_resultset set = connection_get_resultset(co);
294 int offset = cl->show_raw->position;
295 const char *syntax = 0;
296 const char *elements = 0;
298 assert(cl->show_raw);
301 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
302 client_get_url(cl), 1, offset);
304 if (cl->show_raw->syntax)
305 syntax = cl->show_raw->syntax;
307 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
308 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
310 if (cl->show_raw->esn)
311 elements = cl->show_raw->esn;
313 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
314 if (elements && *elements)
315 ZOOM_resultset_option_set(set, "elementSetName", elements);
317 ZOOM_resultset_records(set, 0, offset-1, 1);
318 cl->show_raw->active = 1;
320 connection_continue(co);
323 static int nativesyntax_to_type(struct session_database *sdb, char *type,
326 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
330 if (!strncmp(s, "iso2709", 7))
332 const char *cp = strchr(s, ';');
333 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
335 else if (!strncmp(s, "xml", 3))
343 else /* attempt to deduce structure */
345 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
348 if (!strcmp(syntax, "XML"))
353 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
355 strcpy(type, "xml; charset=marc8-s");
364 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
370 if (cl->show_raw->binary)
374 struct session_database *sdb = client_get_database(cl);
375 nativesyntax_to_type(sdb, type, rec);
378 buf = ZOOM_record_get(rec, type, &len);
379 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
380 client_show_raw_dequeue(cl);
383 void client_search_response(struct client *cl)
385 struct connection *co = cl->connection;
386 struct session *se = cl->session;
387 ZOOM_connection link = connection_get_link(co);
388 ZOOM_resultset resultset = connection_get_resultset(co);
389 const char *error, *addinfo;
391 if (ZOOM_connection_error(link, &error, &addinfo))
394 client_set_state(cl, Client_Error);
395 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
396 error, addinfo, client_get_url(cl));
400 cl->record_offset = 0;
401 cl->hits = ZOOM_resultset_size(resultset);
402 se->total_hits += cl->hits;
407 void client_record_response(struct client *cl)
409 struct connection *co = cl->connection;
410 ZOOM_connection link = connection_get_link(co);
411 ZOOM_resultset resultset = connection_get_resultset(co);
412 const char *error, *addinfo;
414 if (ZOOM_connection_error(link, &error, &addinfo))
416 client_set_state(cl, Client_Error);
417 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
418 error, addinfo, client_get_url(cl));
423 const char *msg, *addinfo;
425 if (cl->show_raw && cl->show_raw->active)
427 if ((rec = ZOOM_resultset_record(resultset,
428 cl->show_raw->position-1)))
430 cl->show_raw->active = 0;
431 ingest_raw_record(cl, rec);
435 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
436 cl->show_raw->position-1);
441 int offset = cl->record_offset;
442 if ((rec = ZOOM_resultset_record(resultset, offset)))
445 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
446 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
447 error, addinfo, client_get_url(cl),
451 struct session_database *sdb = client_get_database(cl);
454 if (nativesyntax_to_type(sdb, type, rec))
455 yaz_log(YLOG_WARN, "Failed to determine record type");
456 if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
458 if (ingest_record(cl, xmlrec, cl->record_offset))
460 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
461 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
464 yaz_log(YLOG_WARN, "Failed to ingest");
467 yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
473 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
480 void client_start_search(struct client *cl)
482 struct session_database *sdb = client_get_database(cl);
483 struct connection *co = client_get_connection(cl);
484 ZOOM_connection link = connection_get_link(co);
486 char *databaseName = sdb->database->databases[0];
487 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
488 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
489 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
490 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
491 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
492 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
497 cl->record_offset = 0;
499 client_set_state(cl, Client_Working);
502 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
504 ZOOM_connection_option_set(link, "piggyback", "1");
506 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
507 if (*opt_sru && *opt_elements)
508 ZOOM_connection_option_set(link, "schema", opt_elements);
509 else if (*opt_elements)
510 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
512 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
514 ZOOM_connection_option_set(link, "count", opt_maxrecs);
518 sprintf(n, "%d", global_parameters.toget);
519 ZOOM_connection_option_set(link, "count", n);
522 ZOOM_connection_option_set(link, "databaseName", databaseName);
524 ZOOM_connection_option_set(link, "presentChunk", "20");
528 ZOOM_query q = ZOOM_query_create();
529 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
530 ZOOM_query_cql(q, cl->cqlquery);
531 rs = ZOOM_connection_search(link, q);
532 ZOOM_query_destroy(q);
536 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
537 rs = ZOOM_connection_search_pqf(link, cl->pquery);
539 connection_set_resultset(co, rs);
540 connection_continue(co);
543 struct client *client_create(void)
549 client_freelist = client_freelist->next;
552 r = xmalloc(sizeof(struct client));
559 r->record_offset = 0;
561 r->state = Client_Disconnected;
567 void client_destroy(struct client *c)
569 struct session *se = c->session;
570 if (c == se->clients)
571 se->clients = c->next;
575 for (cc = se->clients; cc && cc->next != c; cc = cc->next)
584 connection_release(c->connection);
585 c->next = client_freelist;
589 void client_set_connection(struct client *cl, struct connection *con)
591 cl->connection = con;
594 void client_disconnect(struct client *cl)
596 if (cl->state != Client_Idle)
597 client_set_state(cl, Client_Disconnected);
598 client_set_connection(cl, 0);
601 // Extract terms from query into null-terminated termlist
602 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
606 pull_terms(nmem, query, termlist, &num);
610 // Initialize CCL map for a target
611 static CCL_bibset prepare_cclmap(struct client *cl)
613 struct session_database *sdb = client_get_database(cl);
620 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
622 char *p = strchr(s->name + 3, ':');
625 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
630 ccl_qual_fitem(res, s->value, p);
635 // returns a xmalloced CQL query corresponding to the pquery in client
636 static char *make_cqlquery(struct client *cl)
638 cql_transform_t cqlt = cql_transform_create();
641 WRBUF wrb = wrbuf_alloc();
644 zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
645 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
647 yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
650 r = xstrdup(wrbuf_cstr(wrb));
653 odr_reset(global_parameters.odr_out); // releases the zquery
654 cql_transform_close(cqlt);
658 // Parse the query given the settings specific to this client
659 int client_parse_query(struct client *cl, const char *query)
661 struct session *se = client_get_session(cl);
662 struct session_database *sdb = client_get_database(cl);
663 struct ccl_rpn_node *cn;
665 CCL_bibset ccl_map = prepare_cclmap(cl);
666 const char *sru = session_setting_oneval(sdb, PZ_SRU);
667 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
672 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
673 ccl_qual_rm(&ccl_map);
676 client_set_state(cl, Client_Error);
677 yaz_log(YLOG_WARN, "Failed to parse query for %s",
678 client_get_database(cl)->database->url);
681 wrbuf_rewind(se->wrbuf);
684 wrbuf_puts(se->wrbuf, pqf_prefix);
685 wrbuf_puts(se->wrbuf, " ");
687 ccl_pquery(se->wrbuf, cn);
689 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
694 if (!(cl->cqlquery = make_cqlquery(cl)))
702 // Initialize relevance structure with query terms
704 extract_terms(se->nmem, cn, p);
705 se->relevance = relevance_create(
706 global_parameters.server->relevance_pct,
707 se->nmem, (const char **) p,
708 se->expected_maxrecs);
715 void client_set_session(struct client *cl, struct session *se)
718 cl->next = se->clients;
722 int client_is_active(struct client *cl)
724 if (cl->connection && (cl->state == Client_Connecting ||
725 cl->state == Client_Working))
730 struct client *client_next_in_session(struct client *cl)
738 int client_get_hits(struct client *cl)
743 int client_get_num_records(struct client *cl)
745 return cl->record_offset;
748 int client_get_diagnostic(struct client *cl)
750 return cl->diagnostic;
753 void client_set_database(struct client *cl, struct session_database *db)
758 struct host *client_get_host(struct client *cl)
760 return client_get_database(cl)->database->host;
763 const char *client_get_url(struct client *cl)
765 return client_get_database(cl)->database->url;
771 * c-file-style: "Stroustrup"
772 * indent-tabs-mode: nil
774 * vim: shiftwidth=4 tabstop=8 expandtab