2 * Copyright (c) 1995-2001, Index Data
3 * See the file LICENSE for details.
6 * Revision 1.117 2001-06-13 20:47:40 adam
7 * When error is returned from present handler, non-surrogate diagnostic
8 * is returned in present response (and fetch handler is no longer called).
10 * Revision 1.116 2001/05/16 07:21:36 adam
11 * Accept any OID for record syntax.
13 * Revision 1.115 2001/03/25 21:55:12 adam
14 * Added odr_intdup. Ztest server returns TaskPackage for ItemUpdate.
16 * Revision 1.114 2001/02/21 13:46:53 adam
19 * Revision 1.113 2001/01/30 21:34:17 adam
20 * Added step-size for Scan backend interface.
22 * Revision 1.112 2001/01/29 09:38:22 adam
23 * Fixed bug that made the frontend server crash when no attribute set
24 * was specified for scan.
26 * Revision 1.111 2000/11/23 10:58:32 adam
27 * SSL comstack support. Separate POSIX thread support library.
29 * Revision 1.110 2000/10/02 13:05:32 adam
30 * Fixed bug introduced by previous commit.
32 * Revision 1.109 2000/10/02 11:07:44 adam
33 * Added peer_name member for bend_init handler. Changed the YAZ
34 * client so that tcp: can be avoided in target spec.
36 * Revision 1.108 2000/09/04 08:58:15 adam
37 * Added prefix yaz_ for most logging utility functions.
39 * Revision 1.107 2000/08/31 10:20:12 adam
40 * Added member request_format and output_format for backend fetch method.
42 * Revision 1.106 2000/08/31 09:51:25 adam
43 * Added record_syntax member for fetch method (raw OID).
45 * Revision 1.105 2000/07/06 10:38:47 adam
46 * Enhanced option --enable-tcpd.
48 * Revision 1.104 2000/04/05 07:39:55 adam
49 * Added shared library support (libtool).
51 * Revision 1.103 2000/03/20 19:06:25 adam
52 * Added Segment request for fronend server. Work on admin for client.
54 * Revision 1.102 2000/03/15 12:59:49 adam
55 * Added handle member to statserv_control.
57 * Revision 1.101 2000/01/12 14:36:07 adam
58 * Added printing stream (ODR) for backend functions.
60 * Revision 1.100 1999/12/16 23:36:19 adam
61 * Implemented ILL protocol. Minor updates ASN.1 compiler.
63 * Revision 1.99 1999/11/30 13:47:12 adam
64 * Improved installation. Moved header files to include/yaz.
66 * Revision 1.98 1999/11/29 15:12:27 adam
67 * Changed the way implementationName - and version is set.
69 * Revision 1.96 1999/11/04 14:58:44 adam
70 * Added status elements for backend delete result set handler.
71 * Updated delete result result set command for client.
73 * Revision 1.95 1999/10/11 10:01:24 adam
74 * Implemented bend_sort_rr handler for frontend server.
76 * Revision 1.94 1999/08/27 09:40:32 adam
77 * Renamed logf function to yaz_log. Removed VC++ project files.
79 * Revision 1.93 1999/07/06 12:17:15 adam
80 * Added option -1 that runs server once (for profiling purposes).
82 * Revision 1.92 1999/06/17 10:54:45 adam
83 * Added facility to specify implementation version - and name
86 * Revision 1.91 1999/06/01 14:29:12 adam
87 * Work on Extended Services.
89 * Revision 1.90 1999/05/27 13:02:20 adam
90 * Assigned OID for old DB Update (VAL_DBUPDATE0).
92 * Revision 1.89 1999/05/26 15:24:26 adam
93 * Fixed minor bugs regarding DB Update (introduced by previous commit).
95 * Revision 1.88 1999/04/20 09:56:48 adam
96 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
97 * Modified all encoders/decoders to reflect this change.
99 * Revision 1.87 1999/03/31 11:18:25 adam
100 * Implemented odr_strdup. Added Reference ID to backend server API.
102 * Revision 1.86 1999/02/02 13:57:38 adam
103 * Uses preprocessor define WIN32 instead of WINDOWS to build code
104 * for Microsoft WIN32.
106 * Revision 1.85 1998/11/17 09:52:59 adam
107 * Fixed minor bug (introduced by previous commit).
109 * Revision 1.84 1998/11/16 16:02:32 adam
110 * Added loggin utilies, log_rpn_query and log_scan_term. These used
111 * to be part of Zebra.
113 * Revision 1.83 1998/11/03 10:09:36 adam
114 * Fixed bug regarding YC.
116 * Revision 1.82 1998/10/20 14:00:30 quinn
119 * Revision 1.81 1998/10/13 16:12:24 adam
120 * Added support for Surrogate Diagnostics for Scan Term entries.
122 * Revision 1.80 1998/09/02 12:41:53 adam
123 * Added decode stream in bend search structures.
125 * Revision 1.79 1998/08/19 16:10:08 adam
126 * Changed som member names of DeleteResultSetRequest/Response.
128 * Revision 1.78 1998/08/03 10:23:55 adam
129 * Fixed bug regarding Options for Sort.
131 * Revision 1.77 1998/07/20 12:38:42 adam
132 * Implemented delete result set service to server API.
134 * Revision 1.76 1998/05/27 16:57:07 adam
135 * Support for surrogate diagnostic records added for bend_fetch.
137 * Revision 1.75 1998/05/18 10:13:07 adam
138 * Fixed call to es_request handler - extra argument was passed.
140 * Revision 1.74 1998/03/31 15:13:20 adam
141 * Development towards compiled ASN.1.
143 * Revision 1.73 1998/03/31 11:07:45 adam
144 * Furhter work on UNIverse resource report.
145 * Added Extended Services handling in frontend server.
147 * Revision 1.72 1998/02/11 11:53:35 adam
148 * Changed code so that it compiles as C++.
150 * Revision 1.71 1998/02/10 11:03:57 adam
151 * Added support for extended handlers in backend server interface.
153 * Revision 1.70 1998/01/29 13:15:35 adam
154 * Implemented sort for the backend interface.
156 * Revision 1.69 1997/09/30 11:48:12 adam
157 * Fixed bug introduced by previous commit.
159 * Revision 1.68 1997/09/29 13:18:59 adam
160 * Added function, oid_ent_to_oid, to replace the function
161 * oid_getoidbyent, which is not thread safe.
163 * Revision 1.67 1997/09/17 12:10:40 adam
166 * Revision 1.66 1997/09/05 15:26:44 adam
167 * Added ODR encode in search and scen bend request structures.
168 * Fixed a few enums that caused trouble with C++.
170 * Revision 1.65 1997/09/01 08:53:01 adam
171 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
172 * moved a separate directory. MSV5.0 project server.dsp created.
173 * As an option, the server can now operate as an NT service.
175 * Revision 1.64 1997/04/30 08:52:11 quinn
178 * Revision 1.63 1996/10/11 11:57:26 quinn
181 * Revision 1.62 1996/07/06 19:58:35 quinn
182 * System headerfiles gathered in yconfig
184 * Revision 1.61 1996/06/10 08:56:16 quinn
187 * Revision 1.60 1996/05/30 11:03:10 quinn
188 * Fixed NextresultSetPosition bug fixed.
190 * Revision 1.59 1996/05/14 09:26:46 quinn
191 * Added attribute set to scan backend
193 * Revision 1.58 1996/02/20 12:53:04 quinn
196 * Revision 1.57 1996/01/02 08:57:47 quinn
197 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
199 * Revision 1.56 1995/12/14 11:09:57 quinn
202 * Revision 1.55 1995/11/08 17:41:37 quinn
205 * Revision 1.54 1995/11/08 15:11:29 quinn
206 * Log of close transmit.
208 * Revision 1.53 1995/11/01 13:54:58 quinn
211 * Revision 1.52 1995/11/01 12:19:13 quinn
212 * Second attempt to fix same bug.
214 * Revision 1.50 1995/10/25 16:58:32 quinn
217 * Revision 1.49 1995/10/16 13:51:53 quinn
218 * Changes to provide Especs to the backend.
220 * Revision 1.48 1995/10/06 08:51:20 quinn
221 * Added Write-buffer.
223 * Revision 1.47 1995/08/29 14:24:16 quinn
224 * Added second half of close-handshake
226 * Revision 1.46 1995/08/29 11:17:58 quinn
227 * Added code to receive close
229 * Revision 1.45 1995/08/21 09:11:00 quinn
230 * Smallish fixes to suppport new formats.
232 * Revision 1.44 1995/08/17 12:45:25 quinn
233 * Fixed minor problems with GRS-1. Added support in c&s.
235 * Revision 1.43 1995/08/15 12:00:31 quinn
238 * Revision 1.42 1995/08/15 11:16:50 quinn
240 * Revision 1.41 1995/08/02 10:23:06 quinn
243 * Revision 1.40 1995/07/31 14:34:26 quinn
244 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
246 * Revision 1.39 1995/06/27 13:21:00 quinn
249 * Revision 1.38 1995/06/19 12:39:11 quinn
250 * Fixed bug in timeout code. Added BER dumper.
252 * Revision 1.37 1995/06/16 13:16:14 quinn
253 * Fixed Defaultdiagformat.
255 * Revision 1.36 1995/06/16 10:31:36 quinn
256 * Added session timeout.
258 * Revision 1.35 1995/06/15 07:45:14 quinn
261 * Revision 1.34 1995/06/14 15:26:46 quinn
262 * *** empty log message ***
264 * Revision 1.33 1995/06/06 14:57:05 quinn
265 * Better diagnostics.
267 * Revision 1.32 1995/06/06 08:41:44 quinn
268 * Better diagnostics.
270 * Revision 1.31 1995/06/06 08:15:37 quinn
273 * Revision 1.30 1995/06/05 10:53:32 quinn
274 * Added a better SCAN.
276 * Revision 1.29 1995/06/01 11:25:03 quinn
279 * Revision 1.28 1995/06/01 11:21:01 quinn
280 * Attempting to fix a bug in pack-records. replaced break with continue
281 * for large records, according to standard.
283 * Revision 1.27 1995/05/29 08:12:06 quinn
286 * Revision 1.26 1995/05/18 13:02:12 quinn
289 * Revision 1.25 1995/05/17 08:42:26 quinn
290 * Transfer auth info to backend. Allow backend to reject init gracefully.
292 * Revision 1.24 1995/05/16 08:51:04 quinn
293 * License, documentation, and memory fixes
295 * Revision 1.23 1995/05/15 13:25:10 quinn
298 * Revision 1.22 1995/05/15 11:56:39 quinn
299 * Asynchronous facilities. Restructuring of seshigh code.
301 * Revision 1.21 1995/05/02 08:53:19 quinn
302 * Trying in vain to fix comm with ISODE
304 * Revision 1.20 1995/04/20 15:13:00 quinn
307 * Revision 1.19 1995/04/18 08:15:34 quinn
308 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
309 * neater. We'll make the same change for decoding one day.
311 * Revision 1.18 1995/04/17 11:28:25 quinn
314 * Revision 1.17 1995/04/10 10:23:36 quinn
315 * Some work to add scan and other things.
317 * Revision 1.16 1995/03/31 09:18:55 quinn
320 * Revision 1.15 1995/03/30 14:03:23 quinn
321 * Added RFC1006 as separate library
323 * Revision 1.14 1995/03/30 12:18:17 quinn
326 * Revision 1.13 1995/03/30 09:09:24 quinn
327 * Added state-handle and some support for asynchronous activities.
329 * Revision 1.12 1995/03/29 15:40:16 quinn
330 * Ongoing work. Statserv is now dynamic by default
332 * Revision 1.11 1995/03/28 09:16:21 quinn
333 * Added record packing to the search request
335 * Revision 1.10 1995/03/27 08:34:24 quinn
336 * Added dynamic server functionality.
337 * Released bindings to session.c (is now redundant)
339 * Revision 1.9 1995/03/22 15:01:26 quinn
340 * Adjusting record packing.
342 * Revision 1.8 1995/03/22 10:13:21 quinn
343 * Working on record packer
345 * Revision 1.7 1995/03/21 15:53:31 quinn
348 * Revision 1.6 1995/03/21 12:30:09 quinn
349 * Beginning to add support for record packing.
351 * Revision 1.5 1995/03/17 10:44:13 quinn
352 * Added catch of null-string in makediagrec
354 * Revision 1.4 1995/03/17 10:18:08 quinn
355 * Added memory management.
357 * Revision 1.3 1995/03/16 17:42:39 quinn
360 * Revision 1.2 1995/03/16 13:29:01 quinn
361 * Partitioned server.
363 * Revision 1.1 1995/03/15 16:02:10 quinn
364 * Modded session.c to seshigh.c
369 * Frontend server logic.
371 * This code receives incoming APDUs, and handles client requests by means
372 * of the backend API.
374 * Some of the code is getting quite involved, compared to simpler servers -
375 * primarily because it is asynchronous both in the communication with
376 * the user and the backend. We think the complexity will pay off in
377 * the form of greater flexibility when more asynchronous facilities
380 * Memory management has become somewhat involved. In the simple case, where
381 * only one PDU is pending at a time, it will simply reuse the same memory,
382 * once it has found its working size. When we enable multiple concurrent
383 * operations, perhaps even with multiple parallel calls to the backend, it
384 * will maintain a pool of buffers for encoding and decoding, trying to
385 * minimize memory allocation/deallocation during normal operation.
387 * TODOs include (and will be done in order of public interest):
389 * Support for EXPLAIN - provide simple meta-database system.
390 * Support for access control.
391 * Support for resource control.
392 * Support for extended services - primarily Item Order.
393 * Rest of Z39.50-1994
406 #include <yaz/yconfig.h>
407 #include <yaz/xmalloc.h>
408 #include <yaz/comstack.h>
411 #include <yaz/proto.h>
414 #include <yaz/logrpn.h>
415 #include <yaz/statserv.h>
417 #include <yaz/backend.h>
419 static int process_request(association *assoc, request *req, char **msg);
420 void backend_response(IOCHAN i, int event);
421 static int process_response(association *assoc, request *req, Z_APDU *res);
422 static Z_APDU *process_initRequest(association *assoc, request *reqb);
423 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
425 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
426 bend_search_rr *bsrr, int *fd);
427 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
429 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
430 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
431 static void process_close(association *assoc, request *reqb);
432 void save_referenceId (request *reqb, Z_ReferenceId *refid);
433 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
435 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
437 static FILE *apduf = 0; /* for use in static mode */
438 static statserv_options_block *control_block = 0;
440 /* Chas: Added in from DALI */
441 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
442 /* Chas: End of addition from DALI */
445 * Create and initialize a new association-handle.
446 * channel : iochannel for the current line.
447 * link : communications channel.
448 * Returns: 0 or a new association handle.
450 association *create_association(IOCHAN channel, COMSTACK link)
455 control_block = statserv_getcontrol();
456 if (!(anew = (association *)xmalloc(sizeof(*anew))))
459 anew->client_chan = channel;
460 anew->client_link = link;
461 anew->cs_get_mask = 0;
462 anew->cs_put_mask = 0;
463 anew->cs_accept_mask = 0;
464 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
465 !(anew->encode = odr_createmem(ODR_ENCODE)))
467 if (*control_block->apdufile)
472 strcpy(filename, control_block->apdufile);
473 if (!(anew->print = odr_createmem(ODR_PRINT)))
475 if (*control_block->apdufile != '-')
477 strcpy(filename, control_block->apdufile);
478 if (!control_block->dynamic)
482 if (!(apduf = fopen(filename, "w")))
484 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
487 setvbuf(apduf, 0, _IONBF, 0);
493 sprintf(filename + strlen(filename), ".%d", getpid());
494 if (!(f = fopen(filename, "w")))
496 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
499 setvbuf(f, 0, _IONBF, 0);
501 odr_setprint(anew->print, f);
506 anew->input_buffer = 0;
507 anew->input_buffer_len = 0;
509 anew->state = ASSOC_NEW;
510 request_initq(&anew->incoming);
511 request_initq(&anew->outgoing);
512 anew->proto = cs_getproto(link);
517 * Free association and release resources.
519 void destroy_association(association *h)
521 statserv_options_block *cb = statserv_getcontrol();
524 odr_destroy(h->decode);
525 odr_destroy(h->encode);
527 odr_destroy(h->print);
529 xfree(h->input_buffer);
531 (*cb->bend_close)(h->backend);
532 while (request_deq(&h->incoming));
533 while (request_deq(&h->outgoing));
534 request_delq(&h->incoming);
535 request_delq(&h->outgoing);
537 if (control_block && control_block->one_shot)
541 static void do_close_req(association *a, int reason, char *message,
545 Z_Close *cls = zget_Close(a->encode);
547 /* Purge request queue */
548 while (request_deq(&a->incoming));
549 while (request_deq(&a->outgoing));
552 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
553 reason, message ? message : "none");
554 apdu.which = Z_APDU_close;
556 *cls->closeReason = reason;
557 cls->diagnosticInformation = message;
558 process_response(a, req, &apdu);
559 iochan_settimeout(a->client_chan, 60);
563 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
564 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
566 a->state = ASSOC_DEAD;
569 static void do_close(association *a, int reason, char *message)
571 do_close_req (a, reason, message, request_get(&a->outgoing));
575 * This is where PDUs from the client are read and the further
576 * processing is initiated. Flow of control moves down through the
577 * various process_* functions below, until the encoded result comes back up
578 * to the output handler in here.
580 * h : the I/O channel that has an outstanding event.
581 * event : the current outstanding event.
583 void ir_session(IOCHAN h, int event)
586 association *assoc = (association *)iochan_getdata(h);
587 COMSTACK conn = assoc->client_link;
590 assert(h && conn && assoc);
591 if (event == EVENT_TIMEOUT)
593 if (assoc->state != ASSOC_UP)
595 yaz_log(LOG_LOG, "Final timeout - closing connection.");
597 destroy_association(assoc);
602 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
603 do_close(assoc, Z_Close_lackOfActivity, 0);
607 if (event & assoc->cs_accept_mask)
609 yaz_log (LOG_DEBUG, "ir_session (accept)");
610 if (!cs_accept (conn))
612 yaz_log (LOG_LOG, "accept failed");
613 destroy_association(assoc);
616 iochan_clearflag (h, EVENT_OUTPUT|EVENT_OUTPUT);
617 if (conn->io_pending)
618 { /* cs_accept didn't complete */
619 assoc->cs_accept_mask =
620 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
621 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
623 iochan_setflag (h, assoc->cs_accept_mask);
626 { /* cs_accept completed. Prepare for reading (cs_get) */
627 assoc->cs_accept_mask = 0;
628 assoc->cs_get_mask = EVENT_INPUT;
629 iochan_setflag (h, assoc->cs_get_mask);
633 if ((event & assoc->cs_get_mask) || (event & EVENT_WORK)) /* input */
635 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
637 yaz_log(LOG_DEBUG, "ir_session (input)");
638 /* We aren't speaking to this fellow */
639 if (assoc->state == ASSOC_DEAD)
641 yaz_log(LOG_LOG, "Closed connection after reject");
643 destroy_association(assoc);
647 assoc->cs_get_mask = EVENT_INPUT;
648 if ((res = cs_get(conn, &assoc->input_buffer,
649 &assoc->input_buffer_len)) <= 0)
651 yaz_log(LOG_LOG, "Connection closed by client");
653 destroy_association(assoc);
657 else if (res == 1) /* incomplete read - wait for more */
659 if (conn->io_pending & CS_WANT_WRITE)
660 assoc->cs_get_mask |= EVENT_OUTPUT;
661 iochan_setflag(h, assoc->cs_get_mask);
664 if (cs_more(conn)) /* more stuff - call us again later, please */
665 iochan_setevent(h, EVENT_INPUT);
667 /* we got a complete PDU. Let's decode it */
668 yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
669 req = request_get(&assoc->incoming); /* get a new request structure */
670 odr_reset(assoc->decode);
671 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
672 if (!z_APDU(assoc->decode, &req->request, 0, 0))
674 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
675 odr_errmsg(odr_geterror(assoc->decode)),
676 odr_offset(assoc->decode));
677 yaz_log(LOG_LOG, "PDU dump:");
678 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
679 do_close(assoc, Z_Close_protocolError, "Malformed package");
682 req->request_mem = odr_extract_mem(assoc->decode);
683 if (assoc->print && !z_APDU(assoc->print, &req->request, 0, 0))
685 yaz_log(LOG_WARN, "ODR print error: %s",
686 odr_errmsg(odr_geterror(assoc->print)));
687 odr_reset(assoc->print);
689 request_enq(&assoc->incoming, req);
692 /* can we do something yet? */
693 req = request_head(&assoc->incoming);
694 if (req->state == REQUEST_IDLE)
697 request_deq(&assoc->incoming);
698 if (process_request(assoc, req, &msg) < 0)
699 do_close_req(assoc, Z_Close_systemProblem, msg, req);
702 if (event & assoc->cs_put_mask)
704 request *req = request_head(&assoc->outgoing);
706 assoc->cs_put_mask = 0;
707 yaz_log(LOG_DEBUG, "ir_session (output)");
708 req->state = REQUEST_PENDING;
709 switch (res = cs_put(conn, req->response, req->len_response))
712 yaz_log(LOG_LOG, "Connection closed by client");
714 destroy_association(assoc);
717 case 0: /* all sent - release the request structure */
718 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
719 nmem_destroy(req->request_mem);
720 request_deq(&assoc->outgoing);
721 request_release(req);
722 if (!request_head(&assoc->outgoing))
723 { /* restore mask for cs_get operation ... */
724 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
725 iochan_setflag(h, assoc->cs_get_mask);
729 if (conn->io_pending & CS_WANT_WRITE)
730 assoc->cs_put_mask |= EVENT_OUTPUT;
731 if (conn->io_pending & CS_WANT_READ)
732 assoc->cs_put_mask |= EVENT_INPUT;
733 iochan_setflag(h, assoc->cs_put_mask);
736 if (event & EVENT_EXCEPT)
738 yaz_log(LOG_LOG, "ir_session (exception)");
740 destroy_association(assoc);
746 * Initiate request processing.
748 static int process_request(association *assoc, request *req, char **msg)
754 *msg = "Unknown Error";
755 assert(req && req->state == REQUEST_IDLE);
756 if (req->request->which != Z_APDU_initRequest && !assoc->init)
758 *msg = "Missing InitRequest";
761 switch (req->request->which)
763 case Z_APDU_initRequest:
764 res = process_initRequest(assoc, req); break;
765 case Z_APDU_searchRequest:
766 res = process_searchRequest(assoc, req, &fd); break;
767 case Z_APDU_presentRequest:
768 res = process_presentRequest(assoc, req, &fd); break;
769 case Z_APDU_scanRequest:
770 if (assoc->init->bend_scan)
771 res = process_scanRequest(assoc, req, &fd);
774 *msg = "Cannot handle Scan APDU";
778 case Z_APDU_extendedServicesRequest:
779 if (assoc->init->bend_esrequest)
780 res = process_ESRequest(assoc, req, &fd);
783 *msg = "Cannot handle Extended Services APDU";
787 case Z_APDU_sortRequest:
788 if (assoc->init->bend_sort)
789 res = process_sortRequest(assoc, req, &fd);
792 *msg = "Cannot handle Sort APDU";
797 process_close(assoc, req);
799 case Z_APDU_deleteResultSetRequest:
800 if (assoc->init->bend_delete)
801 res = process_deleteRequest(assoc, req, &fd);
804 *msg = "Cannot handle Delete APDU";
808 case Z_APDU_segmentRequest:
809 if (assoc->init->bend_segment)
811 res = process_segmentRequest (assoc, req);
815 *msg = "Cannot handle Segment APDU";
820 *msg = "Bad APDU received";
825 yaz_log(LOG_DEBUG, " result immediately available");
826 retval = process_response(assoc, req, res);
830 yaz_log(LOG_DEBUG, " result unavailble");
833 else /* no result yet - one will be provided later */
837 /* Set up an I/O handler for the fd supplied by the backend */
839 yaz_log(LOG_DEBUG, " establishing handler for result");
840 req->state = REQUEST_PENDING;
841 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
843 iochan_setdata(chan, assoc);
850 * Handle message from the backend.
852 void backend_response(IOCHAN i, int event)
854 association *assoc = (association *)iochan_getdata(i);
855 request *req = request_head(&assoc->incoming);
859 yaz_log(LOG_DEBUG, "backend_response");
860 assert(assoc && req && req->state != REQUEST_IDLE);
861 /* determine what it is we're waiting for */
862 switch (req->request->which)
864 case Z_APDU_searchRequest:
865 res = response_searchRequest(assoc, req, 0, &fd); break;
867 case Z_APDU_presentRequest:
868 res = response_presentRequest(assoc, req, 0, &fd); break;
869 case Z_APDU_scanRequest:
870 res = response_scanRequest(assoc, req, 0, &fd); break;
873 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
876 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
878 yaz_log(LOG_LOG, "Fatal error when talking to backend");
879 do_close(assoc, Z_Close_systemProblem, 0);
883 else if (!res) /* no result yet - try again later */
885 yaz_log(LOG_DEBUG, " no result yet");
886 iochan_setfd(i, fd); /* in case fd has changed */
891 * Encode response, and transfer the request structure to the outgoing queue.
893 static int process_response(association *assoc, request *req, Z_APDU *res)
895 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
897 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
899 yaz_log(LOG_WARN, "ODR print error: %s",
900 odr_errmsg(odr_geterror(assoc->print)));
901 odr_reset(assoc->print);
903 if (!z_APDU(assoc->encode, &res, 0, 0))
905 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
906 odr_errmsg(odr_geterror(assoc->decode)));
909 req->response = odr_getbuf(assoc->encode, &req->len_response,
910 &req->size_response);
911 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
912 odr_reset(assoc->encode);
913 req->state = REQUEST_IDLE;
914 request_enq(&assoc->outgoing, req);
915 /* turn the work over to the ir_session handler */
916 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
917 assoc->cs_put_mask = EVENT_OUTPUT;
918 /* Is there more work to be done? give that to the input handler too */
920 if (request_head(&assoc->incoming))
922 yaz_log (LOG_DEBUG, "more work to be done");
923 iochan_setevent(assoc->client_chan, EVENT_WORK);
930 * Handle init request.
931 * At the moment, we don't check the options
932 * anywhere else in the code - we just try not to do anything that would
933 * break a naive client. We'll toss 'em into the association block when
934 * we need them there.
936 static Z_APDU *process_initRequest(association *assoc, request *reqb)
938 statserv_options_block *cb = statserv_getcontrol();
939 Z_InitRequest *req = reqb->request->u.initRequest;
940 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
941 Z_InitResponse *resp = apdu->u.initResponse;
942 bend_initresult *binitres;
946 assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
948 yaz_log(LOG_LOG, "Got initRequest");
949 if (req->implementationId)
950 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
951 if (req->implementationName)
952 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
953 if (req->implementationVersion)
954 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
956 assoc->init->stream = assoc->encode;
957 assoc->init->print = assoc->print;
958 assoc->init->auth = req->idAuthentication;
959 assoc->init->referenceId = req->referenceId;
960 assoc->init->implementation_version = 0;
961 assoc->init->implementation_name = 0;
962 assoc->init->bend_sort = NULL;
963 assoc->init->bend_search = NULL;
964 assoc->init->bend_present = NULL;
965 assoc->init->bend_esrequest = NULL;
966 assoc->init->bend_delete = NULL;
967 assoc->init->bend_scan = NULL;
968 assoc->init->bend_segment = NULL;
969 assoc->init->bend_fetch = NULL;
971 assoc->init->peer_name =
972 odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
973 if (!(binitres = (*cb->bend_init)(assoc->init)))
975 yaz_log(LOG_WARN, "Bad response from backend.");
979 assoc->backend = binitres->handle;
980 if ((assoc->init->bend_sort))
981 yaz_log (LOG_DEBUG, "Sort handler installed");
982 if ((assoc->init->bend_search))
983 yaz_log (LOG_DEBUG, "Search handler installed");
984 if ((assoc->init->bend_present))
985 yaz_log (LOG_DEBUG, "Present handler installed");
986 if ((assoc->init->bend_esrequest))
987 yaz_log (LOG_DEBUG, "ESRequest handler installed");
988 if ((assoc->init->bend_delete))
989 yaz_log (LOG_DEBUG, "Delete handler installed");
990 if ((assoc->init->bend_scan))
991 yaz_log (LOG_DEBUG, "Scan handler installed");
992 if ((assoc->init->bend_segment))
993 yaz_log (LOG_DEBUG, "Segment handler installed");
995 resp->referenceId = req->referenceId;
997 /* let's tell the client what we can do */
998 if (ODR_MASK_GET(req->options, Z_Options_search))
1000 ODR_MASK_SET(resp->options, Z_Options_search);
1001 strcat(options, "srch");
1003 if (ODR_MASK_GET(req->options, Z_Options_present))
1005 ODR_MASK_SET(resp->options, Z_Options_present);
1006 strcat(options, " prst");
1008 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
1009 assoc->init->bend_delete)
1011 ODR_MASK_SET(resp->options, Z_Options_delSet);
1012 strcat(options, " del");
1014 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
1015 assoc->init->bend_esrequest)
1017 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
1018 strcat (options, " extendedServices");
1020 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
1022 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
1023 strcat(options, " namedresults");
1025 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
1027 ODR_MASK_SET(resp->options, Z_Options_scan);
1028 strcat(options, " scan");
1030 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
1032 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
1033 strcat(options, " concurop");
1035 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
1037 ODR_MASK_SET(resp->options, Z_Options_sort);
1038 strcat(options, " sort");
1040 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
1042 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
1043 assoc->version = 2; /* 1 & 2 are equivalent */
1045 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
1047 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
1050 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
1052 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
1055 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
1056 assoc->maximumRecordSize = *req->maximumRecordSize;
1057 if (assoc->maximumRecordSize > control_block->maxrecordsize)
1058 assoc->maximumRecordSize = control_block->maxrecordsize;
1059 assoc->preferredMessageSize = *req->preferredMessageSize;
1060 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
1061 assoc->preferredMessageSize = assoc->maximumRecordSize;
1064 assoc->maximumRecordSize = 3000000;
1065 assoc->preferredMessageSize = 3000000;
1068 resp->preferredMessageSize = &assoc->preferredMessageSize;
1069 resp->maximumRecordSize = &assoc->maximumRecordSize;
1071 resp->implementationName = "GFS";
1073 if (assoc->init->implementation_name)
1076 odr_malloc (assoc->encode,
1077 strlen(assoc->init->implementation_name) + 10 +
1078 strlen(resp->implementationName));
1079 sprintf (nv, "%s / %s",
1080 resp->implementationName, assoc->init->implementation_name);
1081 resp->implementationName = nv;
1083 if (assoc->init->implementation_version)
1086 odr_malloc (assoc->encode,
1087 strlen(assoc->init->implementation_version) + 10 +
1088 strlen(resp->implementationVersion));
1089 sprintf (nv, "YAZ %s / %s",
1090 resp->implementationVersion,
1091 assoc->init->implementation_version);
1092 resp->implementationVersion = nv;
1095 if (binitres->errcode)
1097 yaz_log(LOG_LOG, "Connection rejected by backend.");
1099 assoc->state = ASSOC_DEAD;
1102 assoc->state = ASSOC_UP;
1107 * These functions should be merged.
1110 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo, ODR odr)
1113 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1114 dr->u.v2Addinfo = odr_strdup (odr, addinfo ? addinfo : "");
1116 dr->which = Z_DiagForm_v2AddInfo;
1117 dr->addinfo = odr_strdup (odr, addinfo ? addinfo : "");
1122 * nonsurrogate diagnostic record.
1124 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
1127 Z_Records *rec = (Z_Records *)
1128 odr_malloc (assoc->encode, sizeof(*rec));
1130 int *err = odr_intdup(assoc->encode, error);
1131 Z_DiagRec *drec = (Z_DiagRec *)
1132 odr_malloc (assoc->encode, sizeof(*drec));
1133 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1134 odr_malloc (assoc->encode, sizeof(*dr));
1136 bib1.proto = assoc->proto;
1137 bib1.oclass = CLASS_DIAGSET;
1138 bib1.value = VAL_BIB1;
1140 yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
1142 rec->which = Z_Records_NSD;
1144 rec->u.nonSurrogateDiagnostic = dr;
1146 rec->u.nonSurrogateDiagnostic = drec;
1147 drec->which = Z_DiagRec_defaultFormat;
1148 drec->u.defaultFormat = dr;
1150 dr->diagnosticSetId =
1151 odr_oiddup (assoc->encode, oid_ent_to_oid(&bib1, oid));
1152 dr->condition = err;
1153 set_addinfo (dr, addinfo, assoc->encode);
1158 * surrogate diagnostic.
1160 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1161 int error, char *addinfo)
1164 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1165 odr_malloc (assoc->encode, sizeof(*rec));
1166 int *err = odr_intdup(assoc->encode, error);
1168 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1169 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1170 odr_malloc (assoc->encode, sizeof(*dr));
1172 bib1.proto = assoc->proto;
1173 bib1.oclass = CLASS_DIAGSET;
1174 bib1.value = VAL_BIB1;
1176 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1177 rec->databaseName = dbname;
1178 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1179 rec->u.surrogateDiagnostic = drec;
1180 drec->which = Z_DiagRec_defaultFormat;
1181 drec->u.defaultFormat = dr;
1182 dr->diagnosticSetId = odr_oiddup (assoc->encode,
1183 oid_ent_to_oid(&bib1, oid));
1184 dr->condition = err;
1185 set_addinfo (dr, addinfo, assoc->encode);
1191 * multiple nonsurrogate diagnostics.
1193 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1196 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1197 int *err = odr_intdup(assoc->encode, error);
1199 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1200 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1201 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)odr_malloc (assoc->encode, sizeof(*rec));
1203 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1204 bib1.proto = assoc->proto;
1205 bib1.oclass = CLASS_DIAGSET;
1206 bib1.value = VAL_BIB1;
1208 recs->num_diagRecs = 1;
1209 recs->diagRecs = recp;
1211 drec->which = Z_DiagRec_defaultFormat;
1212 drec->u.defaultFormat = rec;
1214 rec->diagnosticSetId = odr_oiddup (assoc->encode,
1215 oid_ent_to_oid(&bib1, oid));
1216 rec->condition = err;
1219 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1220 rec->u.v2Addinfo = odr_strdup (assoc->encode, addinfo ? addinfo : "");
1222 rec->which = Z_DiagForm_v2AddInfo;
1223 rec->addinfo = odr_strdup (assoc->encode, addinfo ? addinfo : "");
1228 static Z_Records *pack_records(association *a, char *setname, int start,
1229 int *num, Z_RecordComposition *comp,
1230 int *next, int *pres, oid_value format,
1231 Z_ReferenceId *referenceId,
1234 int recno, total_length = 0, toget = *num, dumped_records = 0;
1235 Z_Records *records =
1236 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1237 Z_NamePlusRecordList *reclist =
1238 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1239 Z_NamePlusRecord **list =
1240 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1242 records->which = Z_Records_DBOSD;
1243 records->u.databaseOrSurDiagnostics = reclist;
1244 reclist->num_records = 0;
1245 reclist->records = list;
1246 *pres = Z_PRES_SUCCESS;
1250 yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
1251 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1252 a->maximumRecordSize);
1253 for (recno = start; reclist->num_records < toget; recno++)
1256 Z_NamePlusRecord *thisrec;
1257 int this_length = 0;
1259 * we get the number of bytes allocated on the stream before any
1260 * allocation done by the backend - this should give us a reasonable
1261 * idea of the total size of the data so far.
1263 total_length = odr_total(a->encode) - dumped_records;
1269 freq.last_in_set = 0;
1270 freq.setname = setname;
1271 freq.surrogate_flag = 0;
1272 freq.number = recno;
1274 freq.request_format = format;
1275 freq.request_format_raw = oid;
1276 freq.output_format = format;
1277 freq.output_format_raw = 0;
1278 freq.stream = a->encode;
1279 freq.print = a->print;
1280 freq.surrogate_flag = 0;
1281 freq.referenceId = referenceId;
1282 (*a->init->bend_fetch)(a->backend, &freq);
1283 /* backend should be able to signal whether error is system-wide
1284 or only pertaining to current record */
1287 if (!freq.surrogate_flag)
1289 *pres = Z_PRES_FAILURE;
1290 return diagrec(a, freq.errcode, freq.errstring);
1292 reclist->records[reclist->num_records] =
1293 surrogatediagrec(a, freq.basename, freq.errcode,
1295 reclist->num_records++;
1296 *next = freq.last_in_set ? 0 : recno + 1;
1300 this_length = freq.len;
1302 this_length = odr_total(a->encode) - total_length;
1303 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1304 this_length, total_length);
1305 if (this_length + total_length > a->preferredMessageSize)
1307 /* record is small enough, really */
1308 if (this_length <= a->preferredMessageSize)
1310 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1311 *pres = Z_PRES_PARTIAL_2;
1314 /* record can only be fetched by itself */
1315 if (this_length < a->maximumRecordSize)
1317 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1320 yaz_log(LOG_DEBUG, " Dropped it");
1321 reclist->records[reclist->num_records] =
1322 surrogatediagrec(a, freq.basename, 16, 0);
1323 reclist->num_records++;
1324 *next = freq.last_in_set ? 0 : recno + 1;
1325 dumped_records += this_length;
1329 else /* too big entirely */
1331 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
1332 reclist->records[reclist->num_records] =
1333 surrogatediagrec(a, freq.basename, 17, 0);
1334 reclist->num_records++;
1335 *next = freq.last_in_set ? 0 : recno + 1;
1336 dumped_records += this_length;
1341 if (!(thisrec = (Z_NamePlusRecord *)
1342 odr_malloc(a->encode, sizeof(*thisrec))))
1344 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1345 strlen(freq.basename) + 1)))
1347 strcpy(thisrec->databaseName, freq.basename);
1348 thisrec->which = Z_NamePlusRecord_databaseRecord;
1350 if (freq.output_format_raw)
1352 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
1353 freq.output_format = ident->value;
1355 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
1356 freq.record, freq.len);
1357 if (!thisrec->u.databaseRecord)
1359 reclist->records[reclist->num_records] = thisrec;
1360 reclist->num_records++;
1361 *next = freq.last_in_set ? 0 : recno + 1;
1363 *num = reclist->num_records;
1367 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1370 Z_SearchRequest *req = reqb->request->u.searchRequest;
1371 bend_search_rr *bsrr =
1372 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1374 yaz_log(LOG_LOG, "Got SearchRequest.");
1376 bsrr->request = reqb;
1377 bsrr->association = assoc;
1378 bsrr->referenceId = req->referenceId;
1379 save_referenceId (reqb, bsrr->referenceId);
1381 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1382 if (req->databaseNames)
1385 for (i = 0; i < req->num_databaseNames; i++)
1386 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1388 switch (req->query->which)
1390 case Z_Query_type_1: case Z_Query_type_101:
1391 log_rpn_query (req->query->u.type_1);
1393 if (assoc->init->bend_search)
1395 bsrr->setname = req->resultSetName;
1396 bsrr->replace_set = *req->replaceIndicator;
1397 bsrr->num_bases = req->num_databaseNames;
1398 bsrr->basenames = req->databaseNames;
1399 bsrr->query = req->query;
1400 bsrr->stream = assoc->encode;
1401 bsrr->decode = assoc->decode;
1402 bsrr->print = assoc->print;
1405 bsrr->errstring = NULL;
1406 (assoc->init->bend_search)(assoc->backend, bsrr);
1413 bend_searchrequest bsrq;
1414 bend_searchresult *bsrt;
1416 bsrq.setname = req->resultSetName;
1417 bsrq.replace_set = *req->replaceIndicator;
1418 bsrq.num_bases = req->num_databaseNames;
1419 bsrq.basenames = req->databaseNames;
1420 bsrq.query = req->query;
1421 bsrq.referenceId = req->referenceId;
1422 bsrq.stream = assoc->encode;
1423 bsrq.decode = assoc->decode;
1424 bsrq.print = assoc->print;
1425 if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1427 bsrr->hits = bsrt->hits;
1428 bsrr->errcode = bsrt->errcode;
1429 bsrr->errstring = bsrt->errstring;
1432 return response_searchRequest(assoc, reqb, bsrr, fd);
1435 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1438 * Prepare a searchresponse based on the backend results. We probably want
1439 * to look at making the fetching of records nonblocking as well, but
1440 * so far, we'll keep things simple.
1441 * If bsrt is null, that means we're called in response to a communications
1442 * event, and we'll have to get the response for ourselves.
1444 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1445 bend_search_rr *bsrt, int *fd)
1447 Z_SearchRequest *req = reqb->request->u.searchRequest;
1448 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1449 Z_SearchResponse *resp = (Z_SearchResponse *)
1450 odr_malloc (assoc->encode, sizeof(*resp));
1451 int *nulint = odr_intdup (assoc->encode, 0);
1452 bool_t *sr = odr_intdup(assoc->encode, 1);
1453 int *next = odr_intdup(assoc->encode, 0);
1454 int *none = odr_intdup(assoc->encode, Z_RES_NONE);
1456 apdu->which = Z_APDU_searchResponse;
1457 apdu->u.searchResponse = resp;
1458 resp->referenceId = req->referenceId;
1459 resp->additionalSearchInfo = 0;
1460 resp->otherInfo = 0;
1462 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1464 yaz_log(LOG_FATAL, "Bad result from backend");
1467 else if (bsrt->errcode)
1469 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1470 resp->resultCount = nulint;
1471 resp->numberOfRecordsReturned = nulint;
1472 resp->nextResultSetPosition = nulint;
1473 resp->searchStatus = nulint;
1474 resp->resultSetStatus = none;
1475 resp->presentStatus = 0;
1479 int *toget = odr_intdup(assoc->encode, 0);
1480 int *presst = odr_intdup(assoc->encode, 0);
1481 Z_RecordComposition comp, *compp = 0;
1484 resp->resultCount = &bsrt->hits;
1486 comp.which = Z_RecordComp_simple;
1487 /* how many records does the user agent want, then? */
1488 if (bsrt->hits <= *req->smallSetUpperBound)
1490 *toget = bsrt->hits;
1491 if ((comp.u.simple = req->smallSetElementSetNames))
1494 else if (bsrt->hits < *req->largeSetLowerBound)
1496 *toget = *req->mediumSetPresentNumber;
1497 if (*toget > bsrt->hits)
1498 *toget = bsrt->hits;
1499 if ((comp.u.simple = req->mediumSetElementSetNames))
1505 if (*toget && !resp->records)
1510 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
1513 form = prefformat->value;
1514 resp->records = pack_records(assoc, req->resultSetName, 1,
1515 toget, compp, next, presst, form, req->referenceId,
1516 req->preferredRecordSyntax);
1519 resp->numberOfRecordsReturned = toget;
1520 resp->nextResultSetPosition = next;
1521 resp->searchStatus = sr;
1522 resp->resultSetStatus = 0;
1523 resp->presentStatus = presst;
1527 if (*resp->resultCount)
1529 resp->numberOfRecordsReturned = nulint;
1530 resp->nextResultSetPosition = next;
1531 resp->searchStatus = sr;
1532 resp->resultSetStatus = 0;
1533 resp->presentStatus = 0;
1540 * Maybe we got a little over-friendly when we designed bend_fetch to
1541 * get only one record at a time. Some backends can optimise multiple-record
1542 * fetches, and at any rate, there is some overhead involved in
1543 * all that selecting and hopping around. Problem is, of course, that the
1544 * frontend can't know ahead of time how many records it'll need to
1545 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1546 * is downright lousy as a bulk data transfer protocol.
1548 * To start with, we'll do the fetching of records from the backend
1549 * in one operation: To save some trips in and out of the event-handler,
1550 * and to simplify the interface to pack_records. At any rate, asynch
1551 * operation is more fun in operations that have an unpredictable execution
1552 * speed - which is normally more true for search than for present.
1554 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1557 Z_PresentRequest *req = reqb->request->u.presentRequest;
1561 Z_PresentResponse *resp;
1565 yaz_log(LOG_LOG, "Got PresentRequest.");
1567 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
1570 form = prefformat->value;
1571 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1573 resp->presentStatus = odr_intdup(assoc->encode, 0);
1574 if (assoc->init->bend_present)
1576 bend_present_rr *bprr = (bend_present_rr *)
1577 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1578 bprr->setname = req->resultSetId;
1579 bprr->start = *req->resultSetStartPoint;
1580 bprr->number = *req->numberOfRecordsRequested;
1581 bprr->format = form;
1582 bprr->comp = req->recordComposition;
1583 bprr->referenceId = req->referenceId;
1584 bprr->stream = assoc->encode;
1585 bprr->print = assoc->print;
1586 bprr->request = reqb;
1587 bprr->association = assoc;
1589 bprr->errstring = NULL;
1590 (*assoc->init->bend_present)(assoc->backend, bprr);
1596 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
1597 *resp->presentStatus = Z_PRES_FAILURE;
1600 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1601 next = odr_intdup(assoc->encode, 0);
1602 num = odr_intdup(assoc->encode, 0);
1604 apdu->which = Z_APDU_presentResponse;
1605 apdu->u.presentResponse = resp;
1606 resp->referenceId = req->referenceId;
1607 resp->otherInfo = 0;
1611 *num = *req->numberOfRecordsRequested;
1613 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1614 num, req->recordComposition, next, resp->presentStatus,
1615 form, req->referenceId, req->preferredRecordSyntax);
1619 resp->numberOfRecordsReturned = num;
1620 resp->nextResultSetPosition = next;
1626 * Scan was implemented rather in a hurry, and with support for only the basic
1627 * elements of the service in the backend API. Suggestions are welcome.
1629 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1631 Z_ScanRequest *req = reqb->request->u.scanRequest;
1632 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1633 Z_ScanResponse *res = (Z_ScanResponse *)
1634 odr_malloc (assoc->encode, sizeof(*res));
1635 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
1636 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
1637 Z_ListEntries *ents = (Z_ListEntries *)
1638 odr_malloc (assoc->encode, sizeof(*ents));
1639 Z_DiagRecs *diagrecs_p = NULL;
1643 yaz_log(LOG_LOG, "Got ScanRequest");
1645 apdu->which = Z_APDU_scanResponse;
1646 apdu->u.scanResponse = res;
1647 res->referenceId = req->referenceId;
1648 res->stepSize = odr_intdup(assoc->encode, 0);
1651 *res->stepSize = *req->stepSize;
1652 res->scanStatus = scanStatus;
1653 res->numberOfEntriesReturned = numberOfEntriesReturned;
1654 res->positionOfTerm = 0;
1655 res->entries = ents;
1656 ents->num_entries = 0;
1657 ents->entries = NULL;
1658 ents->num_nonsurrogateDiagnostics = 0;
1659 ents->nonsurrogateDiagnostics = NULL;
1660 res->attributeSet = 0;
1663 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1664 attent->oclass != CLASS_ATTSET
1665 || attent->value != VAL_BIB1))
1666 diagrecs_p = diagrecs(assoc, 121, 0);
1667 else if (req->stepSize && *req->stepSize > 0)
1668 diagrecs_p = diagrecs(assoc, 205, 0);
1671 bend_scan_rr *bsrr = (bend_scan_rr *)
1672 odr_malloc (assoc->encode, sizeof(*bsrr));
1673 if (req->databaseNames)
1676 for (i = 0; i < req->num_databaseNames; i++)
1677 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1679 bsrr->num_bases = req->num_databaseNames;
1680 bsrr->basenames = req->databaseNames;
1681 bsrr->num_entries = *req->numberOfTermsRequested;
1682 bsrr->term = req->termListAndStartPoint;
1683 bsrr->referenceId = req->referenceId;
1684 bsrr->stream = assoc->encode;
1685 bsrr->print = assoc->print;
1686 bsrr->step_size = res->stepSize;
1687 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1688 attset->oclass != CLASS_RECSYN)
1689 bsrr->attributeset = VAL_NONE;
1691 bsrr->attributeset = attset->value;
1692 log_scan_term (req->termListAndStartPoint, bsrr->attributeset);
1693 bsrr->term_position = req->preferredPositionInResponse ?
1694 *req->preferredPositionInResponse : 1;
1695 ((int (*)(void *, bend_scan_rr *))
1696 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1698 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1702 Z_Entry **tab = (Z_Entry **)
1703 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1705 if (bsrr->status == BEND_SCAN_PARTIAL)
1706 *scanStatus = Z_Scan_partial_5;
1708 *scanStatus = Z_Scan_success;
1709 ents->entries = tab;
1710 ents->num_entries = bsrr->num_entries;
1711 res->numberOfEntriesReturned = &ents->num_entries;
1712 res->positionOfTerm = &bsrr->term_position;
1713 for (i = 0; i < bsrr->num_entries; i++)
1719 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1720 if (bsrr->entries[i].occurrences >= 0)
1722 e->which = Z_Entry_termInfo;
1723 e->u.termInfo = t = (Z_TermInfo *)
1724 odr_malloc(assoc->encode, sizeof(*t));
1725 t->suggestedAttributes = 0;
1727 t->alternativeTerm = 0;
1728 t->byAttributes = 0;
1729 t->otherTermInfo = 0;
1730 t->globalOccurrences = &bsrr->entries[i].occurrences;
1731 t->term = (Z_Term *)
1732 odr_malloc(assoc->encode, sizeof(*t->term));
1733 t->term->which = Z_Term_general;
1734 t->term->u.general = o =
1735 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1736 o->buf = (unsigned char *)
1737 odr_malloc(assoc->encode, o->len = o->size =
1738 strlen(bsrr->entries[i].term));
1739 memcpy(o->buf, bsrr->entries[i].term, o->len);
1740 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1741 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1745 Z_DiagRecs *drecs = diagrecs (assoc,
1746 bsrr->entries[i].errcode,
1747 bsrr->entries[i].errstring);
1748 assert (drecs->num_diagRecs == 1);
1749 e->which = Z_Entry_surrogateDiagnostic;
1750 assert (drecs->diagRecs[0]);
1751 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1758 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1759 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1764 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1767 Z_SortRequest *req = reqb->request->u.sortRequest;
1768 Z_SortResponse *res = (Z_SortResponse *)
1769 odr_malloc (assoc->encode, sizeof(*res));
1770 bend_sort_rr *bsrr = (bend_sort_rr *)
1771 odr_malloc (assoc->encode, sizeof(*bsrr));
1773 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1775 yaz_log(LOG_LOG, "Got SortRequest.");
1778 bsrr->num_input_setnames = req->num_inputResultSetNames;
1779 bsrr->input_setnames = req->inputResultSetNames;
1781 bsrr->num_input_setnames = req->inputResultSetNames->num_strings;
1782 bsrr->input_setnames = req->inputResultSetNames->strings;
1784 bsrr->referenceId = req->referenceId;
1785 bsrr->output_setname = req->sortedResultSetName;
1786 bsrr->sort_sequence = req->sortSequence;
1787 bsrr->stream = assoc->encode;
1788 bsrr->print = assoc->print;
1790 bsrr->sort_status = Z_SortStatus_failure;
1792 bsrr->errstring = 0;
1794 (*assoc->init->bend_sort)(assoc->backend, bsrr);
1796 res->referenceId = bsrr->referenceId;
1797 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
1798 res->resultSetStatus = 0;
1801 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1803 res->diagnostics = dr->diagRecs;
1804 res->num_diagnostics = dr->num_diagRecs;
1806 res->diagnostics = dr;
1812 res->num_diagnostics = 0;
1814 res->diagnostics = 0;
1818 apdu->which = Z_APDU_sortResponse;
1819 apdu->u.sortResponse = res;
1823 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1826 Z_DeleteResultSetRequest *req = reqb->request->u.deleteResultSetRequest;
1827 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1828 odr_malloc (assoc->encode, sizeof(*res));
1829 bend_delete_rr *bdrr = (bend_delete_rr *)
1830 odr_malloc (assoc->encode, sizeof(*bdrr));
1831 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1833 yaz_log(LOG_LOG, "Got DeleteRequest.");
1835 bdrr->num_setnames = req->num_resultSetList;
1836 bdrr->setnames = req->resultSetList;
1837 bdrr->stream = assoc->encode;
1838 bdrr->print = assoc->print;
1839 bdrr->function = *req->deleteFunction;
1840 bdrr->referenceId = req->referenceId;
1842 if (bdrr->num_setnames > 0)
1845 bdrr->statuses = (int*)
1846 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1847 bdrr->num_setnames);
1848 for (i = 0; i < bdrr->num_setnames; i++)
1849 bdrr->statuses[i] = 0;
1851 (*assoc->init->bend_delete)(assoc->backend, bdrr);
1853 res->referenceId = req->referenceId;
1855 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
1857 res->deleteListStatuses = 0;
1858 if (bdrr->num_setnames > 0)
1861 res->deleteListStatuses = (Z_ListStatuses *)
1862 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
1863 res->deleteListStatuses->num = bdrr->num_setnames;
1864 res->deleteListStatuses->elements =
1866 odr_malloc (assoc->encode,
1867 sizeof(*res->deleteListStatuses->elements) *
1868 bdrr->num_setnames);
1869 for (i = 0; i<bdrr->num_setnames; i++)
1871 res->deleteListStatuses->elements[i] =
1873 odr_malloc (assoc->encode,
1874 sizeof(**res->deleteListStatuses->elements));
1875 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1876 res->deleteListStatuses->elements[i]->id =
1877 odr_strdup (assoc->encode, bdrr->setnames[i]);
1881 res->numberNotDeleted = 0;
1882 res->bulkStatuses = 0;
1883 res->deleteMessage = 0;
1886 apdu->which = Z_APDU_deleteResultSetResponse;
1887 apdu->u.deleteResultSetResponse = res;
1891 static void process_close(association *assoc, request *reqb)
1893 Z_Close *req = reqb->request->u.close;
1894 static char *reasons[] =
1901 "securityViolation",
1908 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1909 reasons[*req->closeReason], req->diagnosticInformation ?
1910 req->diagnosticInformation : "NULL");
1911 if (assoc->version < 3) /* to make do_force respond with close */
1913 do_close_req(assoc, Z_Close_finished,
1914 "Association terminated by client", reqb);
1917 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1921 reqb->len_refid = refid->len;
1922 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1923 memcpy (reqb->refid, refid->buf, refid->len);
1927 reqb->len_refid = 0;
1932 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1934 process_response (a, req, res);
1937 bend_request bend_request_mk (bend_association a)
1939 request *nreq = request_get (&a->outgoing);
1940 nreq->request_mem = nmem_create ();
1944 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1949 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1950 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1951 id->len = id->size = req->len_refid;
1952 memcpy (id->buf, req->refid, req->len_refid);
1956 void bend_request_destroy (bend_request *req)
1958 nmem_destroy((*req)->request_mem);
1959 request_release(*req);
1963 int bend_backend_respond (bend_association a, bend_request req)
1967 r = process_request (a, req, &msg);
1969 logf (LOG_WARN, "%s", msg);
1973 void bend_request_setdata(bend_request r, void *p)
1978 void *bend_request_getdata(bend_request r)
1980 return r->clientData;
1983 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
1985 bend_segment_rr request;
1987 request.segment = reqb->request->u.segmentRequest;
1988 request.stream = assoc->encode;
1989 request.decode = assoc->decode;
1990 request.print = assoc->print;
1991 request.association = assoc;
1993 (*assoc->init->bend_segment)(assoc->backend, &request);
1998 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
2000 bend_esrequest_rr esrequest;
2002 Z_ExtendedServicesRequest *req = reqb->request->u.extendedServicesRequest;
2003 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
2005 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
2007 yaz_log(LOG_DEBUG,"inside Process esRequest");
2009 esrequest.esr = reqb->request->u.extendedServicesRequest;
2010 esrequest.stream = assoc->encode;
2011 esrequest.decode = assoc->decode;
2012 esrequest.print = assoc->print;
2013 esrequest.errcode = 0;
2014 esrequest.errstring = NULL;
2015 esrequest.request = reqb;
2016 esrequest.association = assoc;
2017 esrequest.taskPackage = 0;
2018 esrequest.referenceId = req->referenceId;
2020 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
2022 /* If the response is being delayed, return NULL */
2023 if (esrequest.request == NULL)
2026 resp->referenceId = req->referenceId;
2028 if (esrequest.errcode == -1)
2030 /* Backend service indicates request will be processed */
2031 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
2032 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
2034 else if (esrequest.errcode == 0)
2036 /* Backend service indicates request will be processed */
2037 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
2038 *resp->operationStatus = Z_ExtendedServicesResponse_done;
2042 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
2043 esrequest.errstring);
2045 /* Backend indicates error, request will not be processed */
2046 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
2047 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
2048 resp->num_diagnostics = diagRecs->num_diagRecs;
2049 resp->diagnostics = diagRecs->diagRecs;
2051 /* Do something with the members of bend_extendedservice */
2052 if (esrequest.taskPackage)
2053 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
2054 (const char *) esrequest.taskPackage,
2056 yaz_log(LOG_DEBUG,"Send the result apdu");