1 /* $Id: client.c,v 1.11 2007-06-15 19:35:17 adam Exp $
2 Copyright (c) 2006-2007, Index Data.
4 This file is part of Pazpar2.
6 Pazpar2 is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2, or (at your option) any later
11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with Pazpar2; see the file LICENSE. If not, write to the
18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
31 #include <sys/socket.h>
37 #include <yaz/marcdisp.h>
38 #include <yaz/comstack.h>
39 #include <yaz/tcpip.h>
40 #include <yaz/proto.h>
41 #include <yaz/readconf.h>
42 #include <yaz/pquery.h>
43 #include <yaz/otherinfo.h>
44 #include <yaz/yaz-util.h>
46 #include <yaz/query-charset.h>
47 #include <yaz/querytowrbuf.h>
48 #include <yaz/oid_db.h>
56 #include <yaz/timing.h>
59 #include <netinet/in.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
76 int requestid; // ID of current outstanding request
78 enum client_state state;
79 struct show_raw *show_raw;
80 struct client *next; // next client in session or next in free list
84 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);
93 static const char *client_states[] = {
97 "Client_Initializing",
102 "Client_Disconnected",
106 static struct client *client_freelist = 0;
108 static int send_apdu(struct client *c, Z_APDU *a)
110 return connection_send_apdu(client_get_connection(c), a);
114 const char *client_get_state_str(struct client *cl)
116 return client_states[cl->state];
119 enum client_state client_get_state(struct client *cl)
124 void client_set_state(struct client *cl, enum client_state st)
129 static void client_show_raw_error(struct client *cl, const char *addinfo);
131 // Close connection and set state to error
132 void client_fatal(struct client *cl)
134 client_show_raw_error(cl, "client connection failure");
135 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
136 connection_destroy(cl->connection);
137 cl->state = Client_Error;
140 struct connection *client_get_connection(struct client *cl)
142 return cl->connection;
145 struct session_database *client_get_database(struct client *cl)
150 struct session *client_get_session(struct client *cl)
155 const char *client_get_pquery(struct client *cl)
160 void client_set_requestid(struct client *cl, int id)
165 int client_show_raw_begin(struct client *cl, int position,
166 const char *syntax, const char *esn,
168 void (*error_handler)(void *data, const char *addinfo),
169 void (*record_handler)(void *data, const char *buf,
174 cl->show_raw = xmalloc(sizeof(*cl->show_raw));
175 cl->show_raw->position = position;
176 cl->show_raw->active = 0;
177 cl->show_raw->data = data;
178 cl->show_raw->error_handler = error_handler;
179 cl->show_raw->record_handler = record_handler;
181 cl->show_raw->syntax = xstrdup(syntax);
183 cl->show_raw->syntax = 0;
185 cl->show_raw->esn = xstrdup(esn);
187 cl->show_raw->esn = 0;
192 void client_show_raw_reset(struct client *cl)
198 static void client_show_raw_error(struct client *cl, const char *addinfo)
202 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
203 client_show_raw_reset(cl);
207 static void client_show_raw_cancel(struct client *cl)
211 cl->show_raw->error_handler(cl->show_raw->data, "cancel");
212 client_show_raw_reset(cl);
216 void client_send_raw_present(struct client *cl)
218 Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest);
220 int start = cl->show_raw->position;
222 assert(cl->show_raw);
224 yaz_log(YLOG_DEBUG, "Trying to present %d record(s) from %d",
227 a->u.presentRequest->resultSetStartPoint = &start;
228 a->u.presentRequest->numberOfRecordsRequested = &toget;
230 if (cl->show_raw->syntax) // syntax is optional
231 a->u.presentRequest->preferredRecordSyntax =
232 yaz_string_to_oid_odr(yaz_oid_std(),
233 CLASS_RECSYN, cl->show_raw->syntax,
234 global_parameters.odr_out);
235 if (cl->show_raw->esn) // element set is optional
237 Z_ElementSetNames *elementSetNames =
238 odr_malloc(global_parameters.odr_out, sizeof(*elementSetNames));
239 Z_RecordComposition *compo =
240 odr_malloc(global_parameters.odr_out, sizeof(*compo));
241 a->u.presentRequest->recordComposition = compo;
243 compo->which = Z_RecordComp_simple;
244 compo->u.simple = elementSetNames;
246 elementSetNames->which = Z_ElementSetNames_generic;
247 elementSetNames->u.generic =
248 odr_strdup(global_parameters.odr_out, cl->show_raw->esn);
250 if (send_apdu(cl, a) >= 0)
252 cl->show_raw->active = 1;
253 cl->state = Client_Presenting;
257 client_show_raw_error(cl, "send_apdu failed");
258 cl->state = Client_Error;
260 odr_reset(global_parameters.odr_out);
263 void client_send_present(struct client *cl)
265 struct session_database *sdb = client_get_database(cl);
266 Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest);
268 int start = cl->records + 1;
271 toget = global_parameters.chunk;
272 if (toget > global_parameters.toget - cl->records)
273 toget = global_parameters.toget - cl->records;
274 if (toget > cl->hits - cl->records)
275 toget = cl->hits - cl->records;
277 yaz_log(YLOG_DEBUG, "Trying to present %d record(s) from %d",
280 a->u.presentRequest->resultSetStartPoint = &start;
281 a->u.presentRequest->numberOfRecordsRequested = &toget;
283 if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
285 a->u.presentRequest->preferredRecordSyntax =
286 yaz_string_to_oid_odr(yaz_oid_std(),
287 CLASS_RECSYN, recsyn,
288 global_parameters.odr_out);
291 if (send_apdu(cl, a) >= 0)
292 cl->state = Client_Presenting;
294 cl->state = Client_Error;
295 odr_reset(global_parameters.odr_out);
299 void client_send_search(struct client *cl)
301 struct session *se = client_get_session(cl);
302 struct session_database *sdb = client_get_database(cl);
303 Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_searchRequest);
307 int ssub = 0, lslb = 100000, mspn = 10;
311 yaz_iconv_t iconv = 0;
313 yaz_log(YLOG_DEBUG, "Sending search to %s", sdb->database->url);
316 // constructing RPN query
317 a->u.searchRequest->query = zquery = odr_malloc(global_parameters.odr_out,
319 zquery->which = Z_Query_type_1;
320 zquery->u.type_1 = p_query_rpn(global_parameters.odr_out,
321 client_get_pquery(cl));
323 // converting to target encoding
324 if ((queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING))){
325 iconv = yaz_iconv_open(queryenc, "UTF-8");
327 yaz_query_charset_convert_rpnquery(zquery->u.type_1,
328 global_parameters.odr_out,
330 yaz_iconv_close(iconv);
332 yaz_log(YLOG_WARN, "Query encoding failed %s %s",
333 client_get_database(cl)->database->url, queryenc);
336 for (ndb = 0; sdb->database->databases[ndb]; ndb++)
338 databaselist = odr_malloc(global_parameters.odr_out, sizeof(char*) * ndb);
339 for (ndb = 0; sdb->database->databases[ndb]; ndb++)
340 databaselist[ndb] = sdb->database->databases[ndb];
342 if (!(piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK))
343 || *piggyback == '1')
345 if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
347 a->u.searchRequest->preferredRecordSyntax =
348 yaz_string_to_oid_odr(yaz_oid_std(),
349 CLASS_RECSYN, recsyn,
350 global_parameters.odr_out);
352 a->u.searchRequest->smallSetUpperBound = &ssub;
353 a->u.searchRequest->largeSetLowerBound = &lslb;
354 a->u.searchRequest->mediumSetPresentNumber = &mspn;
356 a->u.searchRequest->databaseNames = databaselist;
357 a->u.searchRequest->num_databaseNames = ndb;
360 { //scope for sending and logging queries
361 WRBUF wbquery = wrbuf_alloc();
362 yaz_query_to_wrbuf(wbquery, a->u.searchRequest->query);
365 if (send_apdu(cl, a) >= 0)
367 client_set_state(cl, Client_Searching);
368 client_set_requestid(cl, se->requestid);
369 yaz_log(YLOG_LOG, "SearchRequest %s %s %s",
370 client_get_database(cl)->database->url,
371 queryenc ? queryenc : "UTF-8",
372 wrbuf_cstr(wbquery));
375 client_set_state(cl, Client_Error);
376 yaz_log(YLOG_WARN, "Failed SearchRequest %s %s %s",
377 client_get_database(cl)->database->url,
378 queryenc ? queryenc : "UTF-8",
379 wrbuf_cstr(wbquery));
382 wrbuf_destroy(wbquery);
385 odr_reset(global_parameters.odr_out);
388 void client_init_response(struct client *cl, Z_APDU *a)
390 Z_InitResponse *r = a->u.initResponse;
392 yaz_log(YLOG_DEBUG, "Init response %s", cl->database->database->url);
396 cl->state = Client_Idle;
399 cl->state = Client_Failed; // FIXME need to do something to the connection
403 static void ingest_raw_records(struct client *cl, Z_Records *r)
405 Z_NamePlusRecordList *rlist;
406 Z_NamePlusRecord *npr;
410 if (r->which != Z_Records_DBOSD)
412 client_show_raw_error(cl, "non-surrogate diagnostics");
416 rlist = r->u.databaseOrSurDiagnostics;
417 if (rlist->num_records != 1 || !rlist->records || !rlist->records[0])
419 client_show_raw_error(cl, "no records");
422 npr = rlist->records[0];
423 if (npr->which != Z_NamePlusRecord_databaseRecord)
425 client_show_raw_error(cl, "surrogate diagnostic");
429 doc = record_to_xml(client_get_database(cl), npr->u.databaseRecord);
432 client_show_raw_error(cl, "unable to convert record to xml");
436 xmlDocDumpMemory(doc, &buf_out, &len_out);
439 cl->show_raw->record_handler(cl->show_raw->data,
440 (const char *) buf_out, len_out);
447 static void ingest_records(struct client *cl, Z_Records *r)
450 yaz_timing_t t = yaz_timing_create();
453 struct session *s = client_get_session(cl);
454 Z_NamePlusRecordList *rlist;
457 if (r->which != Z_Records_DBOSD)
459 rlist = r->u.databaseOrSurDiagnostics;
460 for (i = 0; i < rlist->num_records; i++)
462 Z_NamePlusRecord *npr = rlist->records[i];
465 if (npr->which != Z_NamePlusRecord_databaseRecord)
468 "Unexpected record type, probably diagnostic %s",
469 cl->database->database->url);
473 rec = ingest_record(cl, npr->u.databaseRecord, cl->records);
477 if (rlist->num_records)
478 session_alert_watch(s, SESSION_WATCH_RECORDS);
482 yaz_log(YLOG_LOG, "ingest_records %6.5f %3.2f %3.2f",
483 yaz_timing_get_real(t), yaz_timing_get_user(t),
484 yaz_timing_get_sys(t));
485 yaz_timing_destroy(&t);
490 void client_search_response(struct client *cl, Z_APDU *a)
492 struct session *se = cl->session;
493 Z_SearchResponse *r = a->u.searchResponse;
495 yaz_log(YLOG_DEBUG, "Search response %s (status=%d)",
496 cl->database->database->url, *r->searchStatus);
498 if (*r->searchStatus)
500 cl->hits = *r->resultCount;
501 se->total_hits += cl->hits;
502 if (r->presentStatus && !*r->presentStatus && r->records)
504 yaz_log(YLOG_DEBUG, "Records in search response %s",
505 cl->database->database->url);
506 ingest_records(cl, r->records);
508 cl->state = Client_Idle;
513 cl->state = Client_Error;
515 Z_Records *recs = r->records;
516 if (recs->which == Z_Records_NSD)
519 "Search response: Non-surrogate diagnostic %s (%d)",
520 cl->database->database->url,
521 *recs->u.nonSurrogateDiagnostic->condition);
522 cl->diagnostic = *recs->u.nonSurrogateDiagnostic->condition;
523 cl->state = Client_Error;
529 void client_present_response(struct client *cl, Z_APDU *a)
531 Z_PresentResponse *r = a->u.presentResponse;
534 Z_Records *recs = r->records;
535 if (recs->which == Z_Records_NSD)
537 yaz_log(YLOG_WARN, "Non-surrogate diagnostic %s",
538 cl->database->database->url);
539 cl->diagnostic = *recs->u.nonSurrogateDiagnostic->condition;
540 cl->state = Client_Error;
541 client_show_raw_error(cl, "non surrogate diagnostics");
545 if (!*r->presentStatus && cl->state != Client_Error)
547 yaz_log(YLOG_DEBUG, "Good Present response %s",
548 cl->database->database->url);
550 // we can mix show raw and normal show ..
551 if (cl->show_raw && cl->show_raw->active)
553 cl->show_raw->active = 0; // no longer active
554 ingest_raw_records(cl, r->records);
557 ingest_records(cl, r->records);
558 cl->state = Client_Idle;
560 else if (*r->presentStatus)
562 yaz_log(YLOG_WARN, "Bad Present response %s",
563 cl->database->database->url);
564 cl->state = Client_Error;
565 client_show_raw_error(cl, "bad present response");
569 void client_close_response(struct client *cl, Z_APDU *a)
571 struct connection *co = cl->connection;
572 /* Z_Close *r = a->u.close; */
574 yaz_log(YLOG_WARN, "Close response %s", cl->database->database->url);
576 cl->state = Client_Failed;
577 connection_destroy(co);
580 int client_is_our_response(struct client *cl)
582 struct session *se = client_get_session(cl);
584 if (cl && (cl->requestid == se->requestid ||
585 cl->state == Client_Initializing))
590 // Set authentication token in init if one is set for the client
591 // TODO: Extend this to handle other schemes than open (should be simple)
592 static void init_authentication(struct client *cl, Z_InitRequest *req)
594 struct session_database *sdb = client_get_database(cl);
595 char *auth = session_setting_oneval(sdb, PZ_AUTHENTICATION);
599 struct connection *co = client_get_connection(cl);
600 struct session *se = client_get_session(cl);
601 Z_IdAuthentication *idAuth = odr_malloc(global_parameters.odr_out,
603 idAuth->which = Z_IdAuthentication_open;
604 idAuth->u.open = auth;
605 req->idAuthentication = idAuth;
606 connection_set_authentication(co, nmem_strdup(se->session_nmem, auth));
610 static void init_zproxy(struct client *cl, Z_InitRequest *req)
612 struct session_database *sdb = client_get_database(cl);
613 char *ztarget = sdb->database->url;
614 //char *ztarget = sdb->url;
615 char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
618 yaz_oi_set_string_oid(&req->otherInfo,
619 global_parameters.odr_out,
620 yaz_oid_userinfo_proxy,
625 static void client_init_request(struct client *cl)
627 Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_initRequest);
629 a->u.initRequest->implementationId = global_parameters.implementationId;
630 a->u.initRequest->implementationName = global_parameters.implementationName;
631 a->u.initRequest->implementationVersion =
632 global_parameters.implementationVersion;
633 ODR_MASK_SET(a->u.initRequest->options, Z_Options_search);
634 ODR_MASK_SET(a->u.initRequest->options, Z_Options_present);
635 ODR_MASK_SET(a->u.initRequest->options, Z_Options_namedResultSets);
637 ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_1);
638 ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_2);
639 ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_3);
641 init_authentication(cl, a->u.initRequest);
642 init_zproxy(cl, a->u.initRequest);
644 if (send_apdu(cl, a) >= 0)
645 client_set_state(cl, Client_Initializing);
647 client_set_state(cl, Client_Error);
648 odr_reset(global_parameters.odr_out);
651 void client_continue(struct client *cl)
653 if (cl->state == Client_Connected) {
654 client_init_request(cl);
657 if (cl->state == Client_Idle)
659 struct session *se = client_get_session(cl);
660 if (cl->requestid != se->requestid && cl->pquery) {
661 // we'll have to abort this because result set is to be deleted
662 client_show_raw_cancel(cl);
663 client_send_search(cl);
665 else if (cl->show_raw)
667 client_send_raw_present(cl);
669 else if (cl->hits > 0 && cl->records < global_parameters.toget &&
670 cl->records < cl->hits) {
671 client_send_present(cl);
676 struct client *client_create(void)
682 client_freelist = client_freelist->next;
685 r = xmalloc(sizeof(struct client));
695 r->state = Client_Disconnected;
701 void client_destroy(struct client *c)
703 struct session *se = c->session;
704 if (c == se->clients)
705 se->clients = c->next;
709 for (cc = se->clients; cc && cc->next != c; cc = cc->next)
717 connection_release(c->connection);
718 c->next = client_freelist;
722 void client_set_connection(struct client *cl, struct connection *con)
724 cl->connection = con;
727 void client_disconnect(struct client *cl)
729 if (cl->state != Client_Idle)
730 cl->state = Client_Disconnected;
731 client_set_connection(cl, 0);
734 // Extract terms from query into null-terminated termlist
735 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
739 pull_terms(nmem, query, termlist, &num);
743 // Initialize CCL map for a target
744 static CCL_bibset prepare_cclmap(struct client *cl)
746 struct session_database *sdb = client_get_database(cl);
753 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
755 char *p = strchr(s->name + 3, ':');
758 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
763 ccl_qual_fitem(res, s->value, p);
768 // Parse the query given the settings specific to this client
769 int client_parse_query(struct client *cl, const char *query)
771 struct session *se = client_get_session(cl);
772 struct ccl_rpn_node *cn;
774 CCL_bibset ccl_map = prepare_cclmap(cl);
778 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
779 ccl_qual_rm(&ccl_map);
782 cl->state = Client_Error;
783 yaz_log(YLOG_WARN, "Failed to parse query for %s",
784 client_get_database(cl)->database->url);
787 wrbuf_rewind(se->wrbuf);
788 ccl_pquery(se->wrbuf, cn);
790 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
794 // Initialize relevance structure with query terms
796 extract_terms(se->nmem, cn, p);
797 se->relevance = relevance_create(client_get_database(cl)->pct,
798 se->nmem, (const char **) p,
799 se->expected_maxrecs);
806 void client_set_session(struct client *cl, struct session *se)
809 cl->next = se->clients;
813 int client_is_active(struct client *cl)
815 if (cl->connection && (cl->state == Client_Connecting ||
816 cl->state == Client_Initializing ||
817 cl->state == Client_Searching ||
818 cl->state == Client_Presenting))
823 struct client *client_next_in_session(struct client *cl)
831 int client_get_hits(struct client *cl)
836 int client_get_num_records(struct client *cl)
841 int client_get_diagnostic(struct client *cl)
843 return cl->diagnostic;
846 void client_set_database(struct client *cl, struct session_database *db)
851 struct host *client_get_host(struct client *cl)
853 return client_get_database(cl)->database->host;
856 const char *client_get_url(struct client *cl)
858 return client_get_database(cl)->database->url;
864 * indent-tabs-mode: nil
866 * vim: shiftwidth=4 tabstop=8 expandtab