1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2008 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
38 #include <sys/socket.h>
47 #include <yaz/marcdisp.h>
48 #include <yaz/comstack.h>
49 #include <yaz/tcpip.h>
50 #include <yaz/proto.h>
51 #include <yaz/readconf.h>
52 #include <yaz/pquery.h>
53 #include <yaz/otherinfo.h>
54 #include <yaz/yaz-util.h>
56 #include <yaz/query-charset.h>
57 #include <yaz/querytowrbuf.h>
58 #include <yaz/oid_db.h>
59 #include <yaz/diagbib1.h>
60 #include <yaz/snprintf.h>
64 #include <yaz/timing.h>
68 #include <netinet/in.h>
74 #include "connection.h"
77 /** \brief Represents client state for a connection to one search target */
79 struct session_database *database;
80 struct connection *connection;
81 struct session *session;
82 char *pquery; // Current search
86 int requestid; // ID of current outstanding request
88 enum client_state state;
89 struct show_raw *show_raw;
90 struct client *next; // next client in session or next in free list
94 int active; // whether this request has been sent to the server
99 void (*error_handler)(void *data, const char *addinfo);
100 void (*record_handler)(void *data, const char *buf, size_t sz);
102 struct show_raw *next;
105 static const char *client_states[] = {
109 "Client_Initializing",
114 "Client_Disconnected",
119 static struct client *client_freelist = 0;
121 const char *client_get_state_str(struct client *cl)
123 return client_states[cl->state];
126 enum client_state client_get_state(struct client *cl)
131 void client_set_state(struct client *cl, enum client_state st)
136 int no_active = session_active_clients(cl->session);
138 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
142 static void client_show_raw_error(struct client *cl, const char *addinfo);
144 // Close connection and set state to error
145 void client_fatal(struct client *cl)
147 //client_show_raw_error(cl, "client connection failure");
148 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
149 connection_destroy(cl->connection);
150 client_set_state(cl, Client_Error);
153 struct connection *client_get_connection(struct client *cl)
155 return cl->connection;
158 struct session_database *client_get_database(struct client *cl)
163 struct session *client_get_session(struct client *cl)
168 const char *client_get_pquery(struct client *cl)
173 void client_set_requestid(struct client *cl, int id)
179 static void client_send_raw_present(struct client *cl);
181 int client_show_raw_begin(struct client *cl, int position,
182 const char *syntax, const char *esn,
184 void (*error_handler)(void *data, const char *addinfo),
185 void (*record_handler)(void *data, const char *buf,
190 struct show_raw *rr, **rrp;
192 { /* the client has no connection */
195 rr = xmalloc(sizeof(*rr));
197 rr->position = position;
200 rr->error_handler = error_handler;
201 rr->record_handler = record_handler;
204 rr->syntax = xstrdup(syntax);
208 rr->esn = xstrdup(esn);
213 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
217 if (cl->state == Client_Failed)
219 client_show_raw_error(cl, "client failed");
221 else if (cl->state == Client_Disconnected)
223 client_show_raw_error(cl, "client disconnected");
227 client_send_raw_present(cl);
232 void client_show_raw_remove(struct client *cl, void *data)
234 struct show_raw *rr = data;
235 struct show_raw **rrp = &cl->show_raw;
245 void client_show_raw_dequeue(struct client *cl)
247 struct show_raw *rr = cl->show_raw;
249 cl->show_raw = rr->next;
253 static void client_show_raw_error(struct client *cl, const char *addinfo)
257 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
258 client_show_raw_dequeue(cl);
262 static void client_show_raw_cancel(struct client *cl)
266 cl->show_raw->error_handler(cl->show_raw->data, "cancel");
267 client_show_raw_dequeue(cl);
271 static void client_send_raw_present(struct client *cl)
273 struct session_database *sdb = client_get_database(cl);
274 struct connection *co = client_get_connection(cl);
275 ZOOM_resultset set = connection_get_resultset(co);
277 int offset = cl->show_raw->position;
278 const char *syntax = 0;
279 const char *elements = 0;
281 assert(cl->show_raw);
284 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
285 client_get_url(cl), 1, offset);
287 if (cl->show_raw->syntax)
288 syntax = cl->show_raw->syntax;
290 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
291 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
293 if (cl->show_raw->esn)
294 elements = cl->show_raw->esn;
296 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
297 if (elements && *elements)
298 ZOOM_resultset_option_set(set, "elementSetName", elements);
300 ZOOM_resultset_records(set, 0, offset-1, 1);
301 cl->show_raw->active = 1;
303 connection_continue(co);
306 static int nativesyntax_to_type(struct session_database *sdb, char *type)
308 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
312 if (!strncmp(s, "iso2709", 7))
314 const char *cp = strchr(s, ';');
315 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
317 else if (!strncmp(s, "xml", 3))
323 yaz_log(YLOG_LOG, "Returned type %s", type);
329 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
335 if (cl->show_raw->binary)
339 struct session_database *sdb = client_get_database(cl);
340 nativesyntax_to_type(sdb, type);
343 buf = ZOOM_record_get(rec, type, &len);
344 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
345 client_show_raw_dequeue(cl);
350 static void ingest_raw_records(struct client *cl, Z_Records *r)
352 Z_NamePlusRecordList *rlist;
353 Z_NamePlusRecord *npr;
357 if (r->which != Z_Records_DBOSD)
359 client_show_raw_error(cl, "non-surrogate diagnostics");
363 rlist = r->u.databaseOrSurDiagnostics;
364 if (rlist->num_records != 1 || !rlist->records || !rlist->records[0])
366 client_show_raw_error(cl, "no records");
369 npr = rlist->records[0];
370 if (npr->which != Z_NamePlusRecord_databaseRecord)
372 client_show_raw_error(cl, "surrogate diagnostic");
376 if (cl->show_raw && cl->show_raw->binary)
378 Z_External *rec = npr->u.databaseRecord;
379 if (rec->which == Z_External_octet)
381 cl->show_raw->record_handler(cl->show_raw->data,
383 rec->u.octet_aligned->buf,
384 rec->u.octet_aligned->len);
385 client_show_raw_dequeue(cl);
388 client_show_raw_error(cl, "no records");
391 doc = record_to_xml(client_get_database(cl), npr->u.databaseRecord);
394 client_show_raw_error(cl, "unable to convert record to xml");
398 xmlDocDumpMemory(doc, &buf_out, &len_out);
403 cl->show_raw->record_handler(cl->show_raw->data,
404 (const char *) buf_out, len_out);
405 client_show_raw_dequeue(cl);
410 #endif // RETIRED show raw
412 void client_search_response(struct client *cl)
414 struct connection *co = cl->connection;
415 struct session *se = cl->session;
416 ZOOM_connection link = connection_get_link(co);
417 ZOOM_resultset resultset = connection_get_resultset(co);
418 const char *error, *addinfo;
420 if (ZOOM_connection_error(link, &error, &addinfo))
423 cl->state = Client_Error;
424 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
425 error, addinfo, client_get_url(cl));
429 cl->hits = ZOOM_resultset_size(resultset);
430 se->total_hits += cl->hits;
435 void client_record_response(struct client *cl)
437 struct connection *co = cl->connection;
438 ZOOM_connection link = connection_get_link(co);
439 ZOOM_resultset resultset = connection_get_resultset(co);
440 const char *error, *addinfo;
442 yaz_log(YLOG_LOG, "client_record_response");
443 if (ZOOM_connection_error(link, &error, &addinfo))
445 cl->state = Client_Error;
446 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
447 error, addinfo, client_get_url(cl));
452 const char *msg, *addinfo;
454 yaz_log(YLOG_LOG, "show_raw=%p show_raw->active=%d",
455 cl->show_raw, cl->show_raw ? cl->show_raw->active : 0);
456 if (cl->show_raw && cl->show_raw->active)
458 if ((rec = ZOOM_resultset_record(resultset,
459 cl->show_raw->position-1)))
461 cl->show_raw->active = 0;
462 ingest_raw_record(cl, rec);
467 int offset = cl->records;
468 if ((rec = ZOOM_resultset_record(resultset, offset)))
470 yaz_log(YLOG_LOG, "Record with offset %d", offset);
473 if (ZOOM_record_error(rec, &msg, &addinfo, 0))
474 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
475 error, addinfo, client_get_url(cl), cl->records);
478 struct session_database *sdb = client_get_database(cl);
481 nativesyntax_to_type(sdb, type);
482 if ((xmlrec = ZOOM_record_get(rec, type, NULL)))
484 if (ingest_record(cl, xmlrec, cl->records))
486 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
487 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
490 yaz_log(YLOG_WARN, "Failed to ingest");
493 yaz_log(YLOG_WARN, "Failed to extract ZOOM record");
499 yaz_log(YLOG_WARN, "Expected record, but got NULL");
505 void client_present_response(struct client *cl, Z_APDU *a)
507 Z_PresentResponse *r = a->u.presentResponse;
508 Z_Records *recs = r->records;
510 if (recs && recs->which == Z_Records_NSD)
512 WRBUF w = wrbuf_alloc();
514 Z_DiagRec dr, *dr_p = &dr;
515 dr.which = Z_DiagRec_defaultFormat;
516 dr.u.defaultFormat = recs->u.nonSurrogateDiagnostic;
518 wrbuf_printf(w, "Present response NSD %s: ",
519 cl->database->database->url);
521 cl->diagnostic = diag_to_wrbuf(&dr_p, 1, w);
523 yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
525 cl->state = Client_Error;
528 client_show_raw_error(cl, "non surrogate diagnostics");
530 else if (recs && recs->which == Z_Records_multipleNSD)
532 WRBUF w = wrbuf_alloc();
534 wrbuf_printf(w, "Present response multipleNSD %s: ",
535 cl->database->database->url);
537 diag_to_wrbuf(recs->u.multipleNonSurDiagnostics->diagRecs,
538 recs->u.multipleNonSurDiagnostics->num_diagRecs,
540 yaz_log(YLOG_WARN, "%s", wrbuf_cstr(w));
541 cl->state = Client_Error;
544 else if (recs && !*r->presentStatus && cl->state != Client_Error)
546 yaz_log(YLOG_DEBUG, "Good Present response %s",
547 cl->database->database->url);
549 // we can mix show raw and normal show ..
550 if (cl->show_raw && cl->show_raw->active)
552 cl->show_raw->active = 0; // no longer active
553 ingest_raw_records(cl, recs);
556 ingest_records(cl, recs);
557 cl->state = Client_Continue;
559 else if (*r->presentStatus)
561 yaz_log(YLOG_WARN, "Bad Present response %s",
562 cl->database->database->url);
563 cl->state = Client_Error;
564 client_show_raw_error(cl, "bad present response");
568 void client_close_response(struct client *cl, Z_APDU *a)
570 struct connection *co = cl->connection;
571 /* Z_Close *r = a->u.close; */
573 yaz_log(YLOG_WARN, "Close response %s", cl->database->database->url);
575 cl->state = Client_Failed;
576 connection_destroy(co);
579 #endif // RETIRED show raw
582 int client_is_our_response(struct client *cl)
584 struct session *se = client_get_session(cl);
586 if (cl && (cl->requestid == se->requestid ||
587 cl->state == Client_Initializing))
593 void client_start_search(struct client *cl)
595 struct session_database *sdb = client_get_database(cl);
596 struct connection *co = client_get_connection(cl);
597 ZOOM_connection link = connection_get_link(co);
599 char *databaseName = sdb->database->databases[0];
600 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
601 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
602 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
603 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
604 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
613 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
615 ZOOM_connection_option_set(link, "piggyback", "1");
617 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
619 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
621 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
623 ZOOM_connection_option_set(link, "count", opt_maxrecs);
627 sprintf(n, "%d", global_parameters.toget);
628 ZOOM_connection_option_set(link, "count", n);
630 if (!databaseName || !*databaseName)
631 databaseName = "Default";
632 ZOOM_connection_option_set(link, "databaseName", databaseName);
634 ZOOM_connection_option_set(link, "presentChunk", "20");
636 rs = ZOOM_connection_search_pqf(link, cl->pquery);
637 connection_set_resultset(co, rs);
638 connection_continue(co);
641 struct client *client_create(void)
647 client_freelist = client_freelist->next;
650 r = xmalloc(sizeof(struct client));
660 r->state = Client_Disconnected;
666 void client_destroy(struct client *c)
668 struct session *se = c->session;
669 if (c == se->clients)
670 se->clients = c->next;
674 for (cc = se->clients; cc && cc->next != c; cc = cc->next)
682 connection_release(c->connection);
683 c->next = client_freelist;
687 void client_set_connection(struct client *cl, struct connection *con)
689 cl->connection = con;
692 void client_disconnect(struct client *cl)
694 if (cl->state != Client_Idle)
695 client_set_state(cl, Client_Disconnected);
696 client_set_connection(cl, 0);
699 // Extract terms from query into null-terminated termlist
700 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
704 pull_terms(nmem, query, termlist, &num);
708 // Initialize CCL map for a target
709 static CCL_bibset prepare_cclmap(struct client *cl)
711 struct session_database *sdb = client_get_database(cl);
718 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
720 char *p = strchr(s->name + 3, ':');
723 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
728 ccl_qual_fitem(res, s->value, p);
733 // Parse the query given the settings specific to this client
734 int client_parse_query(struct client *cl, const char *query)
736 struct session *se = client_get_session(cl);
737 struct ccl_rpn_node *cn;
739 CCL_bibset ccl_map = prepare_cclmap(cl);
744 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
745 ccl_qual_rm(&ccl_map);
748 cl->state = Client_Error;
749 yaz_log(YLOG_WARN, "Failed to parse query for %s",
750 client_get_database(cl)->database->url);
753 wrbuf_rewind(se->wrbuf);
754 ccl_pquery(se->wrbuf, cn);
756 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
760 // Initialize relevance structure with query terms
762 extract_terms(se->nmem, cn, p);
763 se->relevance = relevance_create(
764 global_parameters.server->relevance_pct,
765 se->nmem, (const char **) p,
766 se->expected_maxrecs);
773 void client_set_session(struct client *cl, struct session *se)
776 cl->next = se->clients;
780 int client_is_active(struct client *cl)
782 if (cl->connection && (cl->state == Client_Continue ||
783 cl->state == Client_Connecting ||
784 cl->state == Client_Working))
789 struct client *client_next_in_session(struct client *cl)
797 int client_get_hits(struct client *cl)
802 int client_get_num_records(struct client *cl)
807 int client_get_diagnostic(struct client *cl)
809 return cl->diagnostic;
812 void client_set_database(struct client *cl, struct session_database *db)
817 struct host *client_get_host(struct client *cl)
819 return client_get_database(cl)->database->host;
822 const char *client_get_url(struct client *cl)
824 return client_get_database(cl)->database->url;
830 * indent-tabs-mode: nil
832 * vim: shiftwidth=4 tabstop=8 expandtab