1 /* $Id: client.c,v 1.6 2007-06-02 04:32:28 quinn 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 #if YAZ_VERSIONL >= 0x020163
49 #include <yaz/oid_db.h>
58 #include <yaz/timing.h>
61 #include <netinet/in.h>
66 #include "connection.h"
69 /** \brief Represents client state for a connection to one search target */
71 struct session_database *database;
72 struct connection *connection;
73 struct session *session;
74 char *pquery; // Current search
78 int requestid; // ID of current outstanding request
80 enum client_state state;
81 struct client *next; // next client in session or next in free list
84 static const char *client_states[] = {
88 "Client_Initializing",
93 "Client_Disconnected",
97 static struct client *client_freelist = 0;
99 static int send_apdu(struct client *c, Z_APDU *a)
101 return connection_send_apdu(client_get_connection(c), a);
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 // Close connection and set state to error
121 void client_fatal(struct client *cl)
123 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
124 connection_destroy(cl->connection);
125 cl->state = Client_Error;
128 struct connection *client_get_connection(struct client *cl)
130 return cl->connection;
133 struct session_database *client_get_database(struct client *cl)
138 struct session *client_get_session(struct client *cl)
143 const char *client_get_pquery(struct client *cl)
148 void client_set_requestid(struct client *cl, int id)
153 void client_send_present(struct client *cl)
155 struct session_database *sdb = client_get_database(cl);
156 Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest);
158 int start = cl->records + 1;
161 toget = global_parameters.chunk;
162 if (toget > global_parameters.toget - cl->records)
163 toget = global_parameters.toget - cl->records;
164 if (toget > cl->hits - cl->records)
165 toget = cl->hits - cl->records;
167 yaz_log(YLOG_DEBUG, "Trying to present %d records\n", toget);
169 a->u.presentRequest->resultSetStartPoint = &start;
170 a->u.presentRequest->numberOfRecordsRequested = &toget;
172 a->u.presentRequest->resultSetId = "Default";
174 if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
176 #if YAZ_VERSIONL >= 0x020163
177 a->u.presentRequest->preferredRecordSyntax =
178 yaz_string_to_oid_odr(yaz_oid_std(),
179 CLASS_RECSYN, recsyn,
180 global_parameters.odr_out);
182 a->u.presentRequest->preferredRecordSyntax =
183 yaz_str_to_z3950oid(global_parameters.odr_out,
184 CLASS_RECSYN, recsyn);
188 if (send_apdu(cl, a) >= 0)
189 cl->state = Client_Presenting;
191 cl->state = Client_Error;
192 odr_reset(global_parameters.odr_out);
196 void client_send_search(struct client *cl)
198 struct session *se = client_get_session(cl);
199 struct session_database *sdb = client_get_database(cl);
200 Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_searchRequest);
204 int ssub = 0, lslb = 100000, mspn = 10;
208 yaz_iconv_t iconv = 0;
210 yaz_log(YLOG_DEBUG, "Sending search to %s", sdb->database->url);
212 // constructing RPN query
213 a->u.searchRequest->query = zquery = odr_malloc(global_parameters.odr_out,
215 zquery->which = Z_Query_type_1;
216 zquery->u.type_1 = p_query_rpn(global_parameters.odr_out,
217 client_get_pquery(cl));
219 // converting to target encoding
220 if ((queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING))){
221 iconv = yaz_iconv_open(queryenc, "UTF-8");
223 yaz_query_charset_convert_rpnquery(zquery->u.type_1,
224 global_parameters.odr_out,
226 yaz_iconv_close(iconv);
228 yaz_log(YLOG_WARN, "Query encoding failed %s %s",
229 client_get_database(cl)->database->url, queryenc);
232 for (ndb = 0; sdb->database->databases[ndb]; ndb++)
234 databaselist = odr_malloc(global_parameters.odr_out, sizeof(char*) * ndb);
235 for (ndb = 0; sdb->database->databases[ndb]; ndb++)
236 databaselist[ndb] = sdb->database->databases[ndb];
238 if (!(piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK)) || *piggyback == '1')
240 if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
242 #if YAZ_VERSIONL >= 0x020163
243 a->u.searchRequest->preferredRecordSyntax =
244 yaz_string_to_oid_odr(yaz_oid_std(),
245 CLASS_RECSYN, recsyn,
246 global_parameters.odr_out);
248 a->u.searchRequest->preferredRecordSyntax =
249 yaz_str_to_z3950oid(global_parameters.odr_out,
250 CLASS_RECSYN, recsyn);
253 a->u.searchRequest->smallSetUpperBound = &ssub;
254 a->u.searchRequest->largeSetLowerBound = &lslb;
255 a->u.searchRequest->mediumSetPresentNumber = &mspn;
257 a->u.searchRequest->resultSetName = "Default";
258 a->u.searchRequest->databaseNames = databaselist;
259 a->u.searchRequest->num_databaseNames = ndb;
262 { //scope for sending and logging queries
263 WRBUF wbquery = wrbuf_alloc();
264 yaz_query_to_wrbuf(wbquery, a->u.searchRequest->query);
267 if (send_apdu(cl, a) >= 0)
269 client_set_state(cl, Client_Searching);
270 client_set_requestid(cl, se->requestid);
271 yaz_log(YLOG_LOG, "SearchRequest %s %s %s",
272 client_get_database(cl)->database->url,
273 queryenc ? queryenc : "UTF-8",
274 wrbuf_cstr(wbquery));
277 client_set_state(cl, Client_Error);
278 yaz_log(YLOG_WARN, "Failed SearchRequest %s %s %s",
279 client_get_database(cl)->database->url,
280 queryenc ? queryenc : "UTF-8",
281 wrbuf_cstr(wbquery));
284 wrbuf_destroy(wbquery);
287 odr_reset(global_parameters.odr_out);
290 void client_init_response(struct client *cl, Z_APDU *a)
292 Z_InitResponse *r = a->u.initResponse;
294 yaz_log(YLOG_DEBUG, "Init response %s", cl->database->database->url);
298 cl->state = Client_Idle;
301 cl->state = Client_Failed; // FIXME need to do something to the connection
305 static void ingest_records(struct client *cl, Z_Records *r)
308 yaz_timing_t t = yaz_timing_create();
311 struct session *s = client_get_session(cl);
312 Z_NamePlusRecordList *rlist;
315 if (r->which != Z_Records_DBOSD)
317 rlist = r->u.databaseOrSurDiagnostics;
318 for (i = 0; i < rlist->num_records; i++)
320 Z_NamePlusRecord *npr = rlist->records[i];
323 if (npr->which != Z_NamePlusRecord_databaseRecord)
326 "Unexpected record type, probably diagnostic %s",
327 cl->database->database->url);
331 rec = ingest_record(cl, npr->u.databaseRecord, cl->records);
335 if (rlist->num_records)
336 session_alert_watch(s, SESSION_WATCH_RECORDS);
340 yaz_log(YLOG_LOG, "ingest_records %6.5f %3.2f %3.2f",
341 yaz_timing_get_real(t), yaz_timing_get_user(t),
342 yaz_timing_get_sys(t));
343 yaz_timing_destroy(&t);
348 void client_search_response(struct client *cl, Z_APDU *a)
350 struct session *se = cl->session;
351 Z_SearchResponse *r = a->u.searchResponse;
353 yaz_log(YLOG_DEBUG, "Search response %s (status=%d)",
354 cl->database->database->url, *r->searchStatus);
356 if (*r->searchStatus)
358 cl->hits = *r->resultCount;
359 se->total_hits += cl->hits;
360 if (r->presentStatus && !*r->presentStatus && r->records)
362 yaz_log(YLOG_DEBUG, "Records in search response %s",
363 cl->database->database->url);
364 ingest_records(cl, r->records);
366 cl->state = Client_Idle;
371 cl->state = Client_Error;
373 Z_Records *recs = r->records;
374 if (recs->which == Z_Records_NSD)
377 "Search response: Non-surrogate diagnostic %s (%d)",
378 cl->database->database->url,
379 *recs->u.nonSurrogateDiagnostic->condition);
380 cl->diagnostic = *recs->u.nonSurrogateDiagnostic->condition;
381 cl->state = Client_Error;
387 void client_present_response(struct client *cl, Z_APDU *a)
389 Z_PresentResponse *r = a->u.presentResponse;
392 Z_Records *recs = r->records;
393 if (recs->which == Z_Records_NSD)
395 yaz_log(YLOG_WARN, "Non-surrogate diagnostic %s",
396 cl->database->database->url);
397 cl->diagnostic = *recs->u.nonSurrogateDiagnostic->condition;
398 cl->state = Client_Error;
402 if (!*r->presentStatus && cl->state != Client_Error)
404 yaz_log(YLOG_DEBUG, "Good Present response %s",
405 cl->database->database->url);
406 ingest_records(cl, r->records);
407 cl->state = Client_Idle;
409 else if (*r->presentStatus)
411 yaz_log(YLOG_WARN, "Bad Present response %s",
412 cl->database->database->url);
413 cl->state = Client_Error;
417 void client_close_response(struct client *cl, Z_APDU *a)
419 struct connection *co = cl->connection;
420 /* Z_Close *r = a->u.close; */
422 yaz_log(YLOG_WARN, "Close response %s", cl->database->database->url);
424 cl->state = Client_Failed;
425 connection_destroy(co);
428 int client_is_our_response(struct client *cl)
430 struct session *se = client_get_session(cl);
432 if (cl && (cl->requestid == se->requestid ||
433 cl->state == Client_Initializing))
438 // Set authentication token in init if one is set for the client
439 // TODO: Extend this to handle other schemes than open (should be simple)
440 static void init_authentication(struct client *cl, Z_InitRequest *req)
442 struct session_database *sdb = client_get_database(cl);
443 char *auth = session_setting_oneval(sdb, PZ_AUTHENTICATION);
447 struct connection *co = client_get_connection(cl);
448 struct session *se = client_get_session(cl);
449 Z_IdAuthentication *idAuth = odr_malloc(global_parameters.odr_out,
451 idAuth->which = Z_IdAuthentication_open;
452 idAuth->u.open = auth;
453 req->idAuthentication = idAuth;
454 connection_set_authentication(co, nmem_strdup(se->session_nmem, auth));
458 static void client_init_request(struct client *cl)
460 Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_initRequest);
462 a->u.initRequest->implementationId = global_parameters.implementationId;
463 a->u.initRequest->implementationName = global_parameters.implementationName;
464 a->u.initRequest->implementationVersion =
465 global_parameters.implementationVersion;
466 ODR_MASK_SET(a->u.initRequest->options, Z_Options_search);
467 ODR_MASK_SET(a->u.initRequest->options, Z_Options_present);
468 ODR_MASK_SET(a->u.initRequest->options, Z_Options_namedResultSets);
470 ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_1);
471 ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_2);
472 ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_3);
474 init_authentication(cl, a->u.initRequest);
476 /* add virtual host if tunneling through Z39.50 proxy */
478 if (0 < strlen(global_parameters.zproxy_override)
479 && 0 < strlen(client_get_database(cl)->database->url))
481 #if YAZ_VERSIONL >= 0x020163
482 yaz_oi_set_string_oid(&a->u.initRequest->otherInfo,
483 global_parameters.odr_out,
484 yaz_oid_userinfo_proxy,
485 1, client_get_database(cl)->database->url);
487 yaz_oi_set_string_oidval(&a->u.initRequest->otherInfo,
488 global_parameters.odr_out, VAL_PROXY,
489 1, client_get_database(cl->database)->url);
493 if (send_apdu(cl, a) >= 0)
494 client_set_state(cl, Client_Initializing);
496 client_set_state(cl, Client_Error);
497 odr_reset(global_parameters.odr_out);
500 void client_continue(struct client *cl)
502 if (cl->state == Client_Connected) {
503 client_init_request(cl);
506 if (cl->state == Client_Idle)
508 struct session *se = client_get_session(cl);
509 if (cl->requestid != se->requestid && cl->pquery) {
510 client_send_search(cl);
512 else if (cl->hits > 0 && cl->records < global_parameters.toget &&
513 cl->records < cl->hits) {
514 client_send_present(cl);
519 struct client *client_create(void)
525 client_freelist = client_freelist->next;
528 r = xmalloc(sizeof(struct client));
538 r->state = Client_Disconnected;
543 void client_destroy(struct client *c)
545 struct session *se = c->session;
546 if (c == se->clients)
547 se->clients = c->next;
551 for (cc = se->clients; cc && cc->next != c; cc = cc->next)
557 connection_release(c->connection);
558 c->next = client_freelist;
562 void client_set_connection(struct client *cl, struct connection *con)
564 cl->connection = con;
567 void client_disconnect(struct client *cl)
569 if (cl->state != Client_Idle)
570 cl->state = Client_Disconnected;
571 client_set_connection(cl, 0);
574 // Extract terms from query into null-terminated termlist
575 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
579 pull_terms(nmem, query, termlist, &num);
583 // Initialize CCL map for a target
584 static CCL_bibset prepare_cclmap(struct client *cl)
586 struct session_database *sdb = client_get_database(cl);
593 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
595 char *p = strchr(s->name + 3, ':');
598 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
603 ccl_qual_fitem(res, s->value, p);
608 // Parse the query given the settings specific to this client
609 int client_parse_query(struct client *cl, const char *query)
611 struct session *se = client_get_session(cl);
612 struct ccl_rpn_node *cn;
614 CCL_bibset ccl_map = prepare_cclmap(cl);
618 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
619 ccl_qual_rm(&ccl_map);
622 cl->state = Client_Error;
623 yaz_log(YLOG_WARN, "Failed to parse query for %s",
624 client_get_database(cl)->database->url);
627 wrbuf_rewind(se->wrbuf);
628 ccl_pquery(se->wrbuf, cn);
630 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
634 // Initialize relevance structure with query terms
636 extract_terms(se->nmem, cn, p);
637 se->relevance = relevance_create(client_get_database(cl)->pct,
638 se->nmem, (const char **) p,
639 se->expected_maxrecs);
646 void client_set_session(struct client *cl, struct session *se)
649 cl->next = se->clients;
653 int client_is_active(struct client *cl)
655 if (cl->connection && (cl->state == Client_Connecting ||
656 cl->state == Client_Initializing ||
657 cl->state == Client_Searching ||
658 cl->state == Client_Presenting))
663 struct client *client_next_in_session(struct client *cl)
671 int client_get_hits(struct client *cl)
676 int client_get_num_records(struct client *cl)
681 int client_get_diagnostic(struct client *cl)
683 return cl->diagnostic;
686 void client_set_database(struct client *cl, struct session_database *db)
691 struct host *client_get_host(struct client *cl)
693 return client_get_database(cl)->database->host;
696 const char *client_get_url(struct client *cl)
698 return client_get_database(cl)->database->url;
704 * indent-tabs-mode: nil
706 * vim: shiftwidth=4 tabstop=8 expandtab