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
80 ZOOM_resultset resultset;
84 int active; // whether this request has been sent to the server
89 void (*error_handler)(void *data, const char *addinfo);
90 void (*record_handler)(void *data, const char *buf, size_t sz);
92 struct show_raw *next;
95 static const char *client_states[] = {
101 "Client_Disconnected"
104 static struct client *client_freelist = 0;
106 const char *client_get_state_str(struct client *cl)
108 return client_states[cl->state];
111 enum client_state client_get_state(struct client *cl)
116 void client_set_state(struct client *cl, enum client_state st)
121 int no_active = session_active_clients(cl->session);
123 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
127 static void client_show_raw_error(struct client *cl, const char *addinfo);
129 // Close connection and set state to error
130 void client_fatal(struct client *cl)
132 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
133 connection_destroy(cl->connection);
134 client_set_state(cl, Client_Error);
137 struct connection *client_get_connection(struct client *cl)
139 return cl->connection;
142 struct session_database *client_get_database(struct client *cl)
147 struct session *client_get_session(struct client *cl)
152 const char *client_get_pquery(struct client *cl)
157 static void client_send_raw_present(struct client *cl);
158 static int nativesyntax_to_type(struct session_database *sdb, char *type,
161 static void client_show_immediate(
162 ZOOM_resultset resultset, struct session_database *sdb, int position,
164 void (*error_handler)(void *data, const char *addinfo),
165 void (*record_handler)(void *data, const char *buf, size_t sz),
175 error_handler(data, "no resultset");
178 rec = ZOOM_resultset_record(resultset, position-1);
181 error_handler(data, "no record");
187 nativesyntax_to_type(sdb, type, rec);
188 buf = ZOOM_record_get(rec, type, &len);
191 error_handler(data, "no record");
194 record_handler(data, buf, len);
198 int client_show_raw_begin(struct client *cl, int position,
199 const char *syntax, const char *esn,
201 void (*error_handler)(void *data, const char *addinfo),
202 void (*record_handler)(void *data, const char *buf,
206 if (syntax == 0 && esn == 0)
207 client_show_immediate(cl->resultset, client_get_database(cl),
209 error_handler, record_handler,
213 struct show_raw *rr, **rrp;
219 rr = xmalloc(sizeof(*rr));
220 rr->position = position;
223 rr->error_handler = error_handler;
224 rr->record_handler = record_handler;
227 rr->syntax = xstrdup(syntax);
231 rr->esn = xstrdup(esn);
236 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
240 if (cl->state == Client_Failed)
242 client_show_raw_error(cl, "client failed");
244 else if (cl->state == Client_Disconnected)
246 client_show_raw_error(cl, "client disconnected");
250 client_send_raw_present(cl);
256 void client_show_raw_remove(struct client *cl, void *data)
258 struct show_raw *rr = data;
259 struct show_raw **rrp = &cl->show_raw;
269 void client_show_raw_dequeue(struct client *cl)
271 struct show_raw *rr = cl->show_raw;
273 cl->show_raw = rr->next;
277 static void client_show_raw_error(struct client *cl, const char *addinfo)
281 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
282 client_show_raw_dequeue(cl);
286 static void client_send_raw_present(struct client *cl)
288 struct session_database *sdb = client_get_database(cl);
289 struct connection *co = client_get_connection(cl);
290 ZOOM_resultset set = cl->resultset;
292 int offset = cl->show_raw->position;
293 const char *syntax = 0;
294 const char *elements = 0;
296 assert(cl->show_raw);
299 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
300 client_get_url(cl), 1, offset);
302 if (cl->show_raw->syntax)
303 syntax = cl->show_raw->syntax;
305 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
306 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
308 if (cl->show_raw->esn)
309 elements = cl->show_raw->esn;
311 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
312 if (elements && *elements)
313 ZOOM_resultset_option_set(set, "elementSetName", elements);
315 ZOOM_resultset_records(set, 0, offset-1, 1);
316 cl->show_raw->active = 1;
318 connection_continue(co);
321 static int nativesyntax_to_type(struct session_database *sdb, char *type,
324 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
328 if (!strncmp(s, "iso2709", 7))
330 const char *cp = strchr(s, ';');
331 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
333 else if (!strncmp(s, "xml", 3))
341 else /* attempt to deduce structure */
343 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
346 if (!strcmp(syntax, "XML"))
351 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
353 strcpy(type, "xml; charset=marc8-s");
362 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
368 if (cl->show_raw->binary)
372 struct session_database *sdb = client_get_database(cl);
373 nativesyntax_to_type(sdb, type, rec);
376 buf = ZOOM_record_get(rec, type, &len);
377 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
378 client_show_raw_dequeue(cl);
381 void client_search_response(struct client *cl)
383 struct connection *co = cl->connection;
384 struct session *se = cl->session;
385 ZOOM_connection link = connection_get_link(co);
386 ZOOM_resultset resultset = cl->resultset;
387 const char *error, *addinfo;
389 if (ZOOM_connection_error(link, &error, &addinfo))
392 client_set_state(cl, Client_Error);
393 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
394 error, addinfo, client_get_url(cl));
398 cl->record_offset = 0;
399 cl->hits = ZOOM_resultset_size(resultset);
400 se->total_hits += cl->hits;
405 void client_record_response(struct client *cl)
407 struct connection *co = cl->connection;
408 ZOOM_connection link = connection_get_link(co);
409 ZOOM_resultset resultset = cl->resultset;
410 const char *error, *addinfo;
412 if (ZOOM_connection_error(link, &error, &addinfo))
414 client_set_state(cl, Client_Error);
415 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
416 error, addinfo, client_get_url(cl));
421 const char *msg, *addinfo;
423 if (cl->show_raw && cl->show_raw->active)
425 if ((rec = ZOOM_resultset_record(resultset,
426 cl->show_raw->position-1)))
428 cl->show_raw->active = 0;
429 ingest_raw_record(cl, rec);
433 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
434 cl->show_raw->position-1);
439 int offset = cl->record_offset;
440 if ((rec = ZOOM_resultset_record(resultset, offset)))
443 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
444 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
445 error, addinfo, client_get_url(cl),
449 struct session_database *sdb = client_get_database(cl);
452 if (nativesyntax_to_type(sdb, type, rec))
453 yaz_log(YLOG_WARN, "Failed to determine record type");
454 if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
456 if (ingest_record(cl, xmlrec, cl->record_offset))
458 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
459 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
462 yaz_log(YLOG_WARN, "Failed to ingest");
465 yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
471 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
478 void client_start_search(struct client *cl)
480 struct session_database *sdb = client_get_database(cl);
481 struct connection *co = client_get_connection(cl);
482 ZOOM_connection link = connection_get_link(co);
484 char *databaseName = sdb->database->databases[0];
485 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
486 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
487 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
488 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
489 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
490 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
495 cl->record_offset = 0;
497 client_set_state(cl, Client_Working);
500 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
502 ZOOM_connection_option_set(link, "piggyback", "1");
504 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
505 if (*opt_sru && *opt_elements)
506 ZOOM_connection_option_set(link, "schema", opt_elements);
507 else if (*opt_elements)
508 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
510 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
512 ZOOM_connection_option_set(link, "count", opt_maxrecs);
516 sprintf(n, "%d", global_parameters.toget);
517 ZOOM_connection_option_set(link, "count", n);
520 ZOOM_connection_option_set(link, "databaseName", databaseName);
522 ZOOM_connection_option_set(link, "presentChunk", "20");
526 ZOOM_query q = ZOOM_query_create();
527 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
528 ZOOM_query_cql(q, cl->cqlquery);
529 rs = ZOOM_connection_search(link, q);
530 ZOOM_query_destroy(q);
534 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
535 rs = ZOOM_connection_search_pqf(link, cl->pquery);
537 ZOOM_resultset_destroy(cl->resultset);
539 connection_continue(co);
542 struct client *client_create(void)
548 client_freelist = client_freelist->next;
551 r = xmalloc(sizeof(struct client));
558 r->record_offset = 0;
560 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);
586 ZOOM_resultset_destroy(c->resultset);
588 c->next = client_freelist;
592 void client_set_connection(struct client *cl, struct connection *con)
594 cl->connection = con;
597 void client_disconnect(struct client *cl)
599 if (cl->state != Client_Idle)
600 client_set_state(cl, Client_Disconnected);
601 client_set_connection(cl, 0);
604 // Extract terms from query into null-terminated termlist
605 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
609 pull_terms(nmem, query, termlist, &num);
613 // Initialize CCL map for a target
614 static CCL_bibset prepare_cclmap(struct client *cl)
616 struct session_database *sdb = client_get_database(cl);
623 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
625 char *p = strchr(s->name + 3, ':');
628 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
633 ccl_qual_fitem(res, s->value, p);
638 // returns a xmalloced CQL query corresponding to the pquery in client
639 static char *make_cqlquery(struct client *cl)
641 cql_transform_t cqlt = cql_transform_create();
644 WRBUF wrb = wrbuf_alloc();
647 zquery = p_query_rpn(global_parameters.odr_out, cl->pquery);
648 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
650 yaz_log(YLOG_WARN, "failed to generate CQL query, code=%d", status);
653 r = xstrdup(wrbuf_cstr(wrb));
656 odr_reset(global_parameters.odr_out); // releases the zquery
657 cql_transform_close(cqlt);
661 // Parse the query given the settings specific to this client
662 int client_parse_query(struct client *cl, const char *query)
664 struct session *se = client_get_session(cl);
665 struct session_database *sdb = client_get_database(cl);
666 struct ccl_rpn_node *cn;
668 CCL_bibset ccl_map = prepare_cclmap(cl);
669 const char *sru = session_setting_oneval(sdb, PZ_SRU);
670 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
675 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
676 ccl_qual_rm(&ccl_map);
679 client_set_state(cl, Client_Error);
680 yaz_log(YLOG_WARN, "Failed to parse query for %s",
681 client_get_database(cl)->database->url);
684 wrbuf_rewind(se->wrbuf);
687 wrbuf_puts(se->wrbuf, pqf_prefix);
688 wrbuf_puts(se->wrbuf, " ");
690 ccl_pquery(se->wrbuf, cn);
692 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
697 if (!(cl->cqlquery = make_cqlquery(cl)))
705 // Initialize relevance structure with query terms
707 extract_terms(se->nmem, cn, p);
708 se->relevance = relevance_create(
709 global_parameters.server->relevance_pct,
710 se->nmem, (const char **) p,
711 se->expected_maxrecs);
718 void client_set_session(struct client *cl, struct session *se)
721 cl->next = se->clients;
725 int client_is_active(struct client *cl)
727 if (cl->connection && (cl->state == Client_Connecting ||
728 cl->state == Client_Working))
733 struct client *client_next_in_session(struct client *cl)
741 int client_get_hits(struct client *cl)
746 int client_get_num_records(struct client *cl)
748 return cl->record_offset;
751 int client_get_diagnostic(struct client *cl)
753 return cl->diagnostic;
756 void client_set_database(struct client *cl, struct session_database *db)
761 struct host *client_get_host(struct client *cl)
763 return client_get_database(cl)->database->host;
766 const char *client_get_url(struct client *cl)
768 return client_get_database(cl)->database->url;
774 * c-file-style: "Stroustrup"
775 * indent-tabs-mode: nil
777 * vim: shiftwidth=4 tabstop=8 expandtab