2 * Copyright (c) 1995-2000, Index Data
3 * See the file LICENSE for details.
6 * Revision 1.111 2000-11-23 10:58:32 adam
7 * SSL comstack support. Separate POSIX thread support library.
9 * Revision 1.110 2000/10/02 13:05:32 adam
10 * Fixed bug introduced by previous commit.
12 * Revision 1.109 2000/10/02 11:07:44 adam
13 * Added peer_name member for bend_init handler. Changed the YAZ
14 * client so that tcp: can be avoided in target spec.
16 * Revision 1.108 2000/09/04 08:58:15 adam
17 * Added prefix yaz_ for most logging utility functions.
19 * Revision 1.107 2000/08/31 10:20:12 adam
20 * Added member request_format and output_format for backend fetch method.
22 * Revision 1.106 2000/08/31 09:51:25 adam
23 * Added record_syntax member for fetch method (raw OID).
25 * Revision 1.105 2000/07/06 10:38:47 adam
26 * Enhanced option --enable-tcpd.
28 * Revision 1.104 2000/04/05 07:39:55 adam
29 * Added shared library support (libtool).
31 * Revision 1.103 2000/03/20 19:06:25 adam
32 * Added Segment request for fronend server. Work on admin for client.
34 * Revision 1.102 2000/03/15 12:59:49 adam
35 * Added handle member to statserv_control.
37 * Revision 1.101 2000/01/12 14:36:07 adam
38 * Added printing stream (ODR) for backend functions.
40 * Revision 1.100 1999/12/16 23:36:19 adam
41 * Implemented ILL protocol. Minor updates ASN.1 compiler.
43 * Revision 1.99 1999/11/30 13:47:12 adam
44 * Improved installation. Moved header files to include/yaz.
46 * Revision 1.98 1999/11/29 15:12:27 adam
47 * Changed the way implementationName - and version is set.
49 * Revision 1.96 1999/11/04 14:58:44 adam
50 * Added status elements for backend delete result set handler.
51 * Updated delete result result set command for client.
53 * Revision 1.95 1999/10/11 10:01:24 adam
54 * Implemented bend_sort_rr handler for frontend server.
56 * Revision 1.94 1999/08/27 09:40:32 adam
57 * Renamed logf function to yaz_log. Removed VC++ project files.
59 * Revision 1.93 1999/07/06 12:17:15 adam
60 * Added option -1 that runs server once (for profiling purposes).
62 * Revision 1.92 1999/06/17 10:54:45 adam
63 * Added facility to specify implementation version - and name
66 * Revision 1.91 1999/06/01 14:29:12 adam
67 * Work on Extended Services.
69 * Revision 1.90 1999/05/27 13:02:20 adam
70 * Assigned OID for old DB Update (VAL_DBUPDATE0).
72 * Revision 1.89 1999/05/26 15:24:26 adam
73 * Fixed minor bugs regarding DB Update (introduced by previous commit).
75 * Revision 1.88 1999/04/20 09:56:48 adam
76 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
77 * Modified all encoders/decoders to reflect this change.
79 * Revision 1.87 1999/03/31 11:18:25 adam
80 * Implemented odr_strdup. Added Reference ID to backend server API.
82 * Revision 1.86 1999/02/02 13:57:38 adam
83 * Uses preprocessor define WIN32 instead of WINDOWS to build code
84 * for Microsoft WIN32.
86 * Revision 1.85 1998/11/17 09:52:59 adam
87 * Fixed minor bug (introduced by previous commit).
89 * Revision 1.84 1998/11/16 16:02:32 adam
90 * Added loggin utilies, log_rpn_query and log_scan_term. These used
91 * to be part of Zebra.
93 * Revision 1.83 1998/11/03 10:09:36 adam
94 * Fixed bug regarding YC.
96 * Revision 1.82 1998/10/20 14:00:30 quinn
99 * Revision 1.81 1998/10/13 16:12:24 adam
100 * Added support for Surrogate Diagnostics for Scan Term entries.
102 * Revision 1.80 1998/09/02 12:41:53 adam
103 * Added decode stream in bend search structures.
105 * Revision 1.79 1998/08/19 16:10:08 adam
106 * Changed som member names of DeleteResultSetRequest/Response.
108 * Revision 1.78 1998/08/03 10:23:55 adam
109 * Fixed bug regarding Options for Sort.
111 * Revision 1.77 1998/07/20 12:38:42 adam
112 * Implemented delete result set service to server API.
114 * Revision 1.76 1998/05/27 16:57:07 adam
115 * Support for surrogate diagnostic records added for bend_fetch.
117 * Revision 1.75 1998/05/18 10:13:07 adam
118 * Fixed call to es_request handler - extra argument was passed.
120 * Revision 1.74 1998/03/31 15:13:20 adam
121 * Development towards compiled ASN.1.
123 * Revision 1.73 1998/03/31 11:07:45 adam
124 * Furhter work on UNIverse resource report.
125 * Added Extended Services handling in frontend server.
127 * Revision 1.72 1998/02/11 11:53:35 adam
128 * Changed code so that it compiles as C++.
130 * Revision 1.71 1998/02/10 11:03:57 adam
131 * Added support for extended handlers in backend server interface.
133 * Revision 1.70 1998/01/29 13:15:35 adam
134 * Implemented sort for the backend interface.
136 * Revision 1.69 1997/09/30 11:48:12 adam
137 * Fixed bug introduced by previous commit.
139 * Revision 1.68 1997/09/29 13:18:59 adam
140 * Added function, oid_ent_to_oid, to replace the function
141 * oid_getoidbyent, which is not thread safe.
143 * Revision 1.67 1997/09/17 12:10:40 adam
146 * Revision 1.66 1997/09/05 15:26:44 adam
147 * Added ODR encode in search and scen bend request structures.
148 * Fixed a few enums that caused trouble with C++.
150 * Revision 1.65 1997/09/01 08:53:01 adam
151 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
152 * moved a separate directory. MSV5.0 project server.dsp created.
153 * As an option, the server can now operate as an NT service.
155 * Revision 1.64 1997/04/30 08:52:11 quinn
158 * Revision 1.63 1996/10/11 11:57:26 quinn
161 * Revision 1.62 1996/07/06 19:58:35 quinn
162 * System headerfiles gathered in yconfig
164 * Revision 1.61 1996/06/10 08:56:16 quinn
167 * Revision 1.60 1996/05/30 11:03:10 quinn
168 * Fixed NextresultSetPosition bug fixed.
170 * Revision 1.59 1996/05/14 09:26:46 quinn
171 * Added attribute set to scan backend
173 * Revision 1.58 1996/02/20 12:53:04 quinn
176 * Revision 1.57 1996/01/02 08:57:47 quinn
177 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
179 * Revision 1.56 1995/12/14 11:09:57 quinn
182 * Revision 1.55 1995/11/08 17:41:37 quinn
185 * Revision 1.54 1995/11/08 15:11:29 quinn
186 * Log of close transmit.
188 * Revision 1.53 1995/11/01 13:54:58 quinn
191 * Revision 1.52 1995/11/01 12:19:13 quinn
192 * Second attempt to fix same bug.
194 * Revision 1.50 1995/10/25 16:58:32 quinn
197 * Revision 1.49 1995/10/16 13:51:53 quinn
198 * Changes to provide Especs to the backend.
200 * Revision 1.48 1995/10/06 08:51:20 quinn
201 * Added Write-buffer.
203 * Revision 1.47 1995/08/29 14:24:16 quinn
204 * Added second half of close-handshake
206 * Revision 1.46 1995/08/29 11:17:58 quinn
207 * Added code to receive close
209 * Revision 1.45 1995/08/21 09:11:00 quinn
210 * Smallish fixes to suppport new formats.
212 * Revision 1.44 1995/08/17 12:45:25 quinn
213 * Fixed minor problems with GRS-1. Added support in c&s.
215 * Revision 1.43 1995/08/15 12:00:31 quinn
218 * Revision 1.42 1995/08/15 11:16:50 quinn
220 * Revision 1.41 1995/08/02 10:23:06 quinn
223 * Revision 1.40 1995/07/31 14:34:26 quinn
224 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
226 * Revision 1.39 1995/06/27 13:21:00 quinn
229 * Revision 1.38 1995/06/19 12:39:11 quinn
230 * Fixed bug in timeout code. Added BER dumper.
232 * Revision 1.37 1995/06/16 13:16:14 quinn
233 * Fixed Defaultdiagformat.
235 * Revision 1.36 1995/06/16 10:31:36 quinn
236 * Added session timeout.
238 * Revision 1.35 1995/06/15 07:45:14 quinn
241 * Revision 1.34 1995/06/14 15:26:46 quinn
242 * *** empty log message ***
244 * Revision 1.33 1995/06/06 14:57:05 quinn
245 * Better diagnostics.
247 * Revision 1.32 1995/06/06 08:41:44 quinn
248 * Better diagnostics.
250 * Revision 1.31 1995/06/06 08:15:37 quinn
253 * Revision 1.30 1995/06/05 10:53:32 quinn
254 * Added a better SCAN.
256 * Revision 1.29 1995/06/01 11:25:03 quinn
259 * Revision 1.28 1995/06/01 11:21:01 quinn
260 * Attempting to fix a bug in pack-records. replaced break with continue
261 * for large records, according to standard.
263 * Revision 1.27 1995/05/29 08:12:06 quinn
266 * Revision 1.26 1995/05/18 13:02:12 quinn
269 * Revision 1.25 1995/05/17 08:42:26 quinn
270 * Transfer auth info to backend. Allow backend to reject init gracefully.
272 * Revision 1.24 1995/05/16 08:51:04 quinn
273 * License, documentation, and memory fixes
275 * Revision 1.23 1995/05/15 13:25:10 quinn
278 * Revision 1.22 1995/05/15 11:56:39 quinn
279 * Asynchronous facilities. Restructuring of seshigh code.
281 * Revision 1.21 1995/05/02 08:53:19 quinn
282 * Trying in vain to fix comm with ISODE
284 * Revision 1.20 1995/04/20 15:13:00 quinn
287 * Revision 1.19 1995/04/18 08:15:34 quinn
288 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
289 * neater. We'll make the same change for decoding one day.
291 * Revision 1.18 1995/04/17 11:28:25 quinn
294 * Revision 1.17 1995/04/10 10:23:36 quinn
295 * Some work to add scan and other things.
297 * Revision 1.16 1995/03/31 09:18:55 quinn
300 * Revision 1.15 1995/03/30 14:03:23 quinn
301 * Added RFC1006 as separate library
303 * Revision 1.14 1995/03/30 12:18:17 quinn
306 * Revision 1.13 1995/03/30 09:09:24 quinn
307 * Added state-handle and some support for asynchronous activities.
309 * Revision 1.12 1995/03/29 15:40:16 quinn
310 * Ongoing work. Statserv is now dynamic by default
312 * Revision 1.11 1995/03/28 09:16:21 quinn
313 * Added record packing to the search request
315 * Revision 1.10 1995/03/27 08:34:24 quinn
316 * Added dynamic server functionality.
317 * Released bindings to session.c (is now redundant)
319 * Revision 1.9 1995/03/22 15:01:26 quinn
320 * Adjusting record packing.
322 * Revision 1.8 1995/03/22 10:13:21 quinn
323 * Working on record packer
325 * Revision 1.7 1995/03/21 15:53:31 quinn
328 * Revision 1.6 1995/03/21 12:30:09 quinn
329 * Beginning to add support for record packing.
331 * Revision 1.5 1995/03/17 10:44:13 quinn
332 * Added catch of null-string in makediagrec
334 * Revision 1.4 1995/03/17 10:18:08 quinn
335 * Added memory management.
337 * Revision 1.3 1995/03/16 17:42:39 quinn
340 * Revision 1.2 1995/03/16 13:29:01 quinn
341 * Partitioned server.
343 * Revision 1.1 1995/03/15 16:02:10 quinn
344 * Modded session.c to seshigh.c
349 * Frontend server logic.
351 * This code receives incoming APDUs, and handles client requests by means
352 * of the backend API.
354 * Some of the code is getting quite involved, compared to simpler servers -
355 * primarily because it is asynchronous both in the communication with
356 * the user and the backend. We think the complexity will pay off in
357 * the form of greater flexibility when more asynchronous facilities
360 * Memory management has become somewhat involved. In the simple case, where
361 * only one PDU is pending at a time, it will simply reuse the same memory,
362 * once it has found its working size. When we enable multiple concurrent
363 * operations, perhaps even with multiple parallel calls to the backend, it
364 * will maintain a pool of buffers for encoding and decoding, trying to
365 * minimize memory allocation/deallocation during normal operation.
367 * TODOs include (and will be done in order of public interest):
369 * Support for EXPLAIN - provide simple meta-database system.
370 * Support for access control.
371 * Support for resource control.
372 * Support for extended services - primarily Item Order.
373 * Rest of Z39.50-1994
386 #include <yaz/yconfig.h>
387 #include <yaz/xmalloc.h>
388 #include <yaz/comstack.h>
391 #include <yaz/proto.h>
394 #include <yaz/logrpn.h>
395 #include <yaz/statserv.h>
397 #include <yaz/backend.h>
399 static int process_request(association *assoc, request *req, char **msg);
400 void backend_response(IOCHAN i, int event);
401 static int process_response(association *assoc, request *req, Z_APDU *res);
402 static Z_APDU *process_initRequest(association *assoc, request *reqb);
403 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
405 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
406 bend_search_rr *bsrr, int *fd);
407 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
409 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
410 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
411 static void process_close(association *assoc, request *reqb);
412 void save_referenceId (request *reqb, Z_ReferenceId *refid);
413 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
415 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
417 static FILE *apduf = 0; /* for use in static mode */
418 static statserv_options_block *control_block = 0;
420 /* Chas: Added in from DALI */
421 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
422 /* Chas: End of addition from DALI */
425 * Create and initialize a new association-handle.
426 * channel : iochannel for the current line.
427 * link : communications channel.
428 * Returns: 0 or a new association handle.
430 association *create_association(IOCHAN channel, COMSTACK link)
435 control_block = statserv_getcontrol();
436 if (!(anew = (association *)xmalloc(sizeof(*anew))))
439 anew->client_chan = channel;
440 anew->client_link = link;
441 anew->cs_get_mask = 0;
442 anew->cs_put_mask = 0;
443 anew->cs_accept_mask = 0;
444 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
445 !(anew->encode = odr_createmem(ODR_ENCODE)))
447 if (*control_block->apdufile)
452 strcpy(filename, control_block->apdufile);
453 if (!(anew->print = odr_createmem(ODR_PRINT)))
455 if (*control_block->apdufile != '-')
457 strcpy(filename, control_block->apdufile);
458 if (!control_block->dynamic)
462 if (!(apduf = fopen(filename, "w")))
464 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
467 setvbuf(apduf, 0, _IONBF, 0);
473 sprintf(filename + strlen(filename), ".%d", getpid());
474 if (!(f = fopen(filename, "w")))
476 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
479 setvbuf(f, 0, _IONBF, 0);
481 odr_setprint(anew->print, f);
486 anew->input_buffer = 0;
487 anew->input_buffer_len = 0;
489 anew->state = ASSOC_NEW;
490 request_initq(&anew->incoming);
491 request_initq(&anew->outgoing);
492 anew->proto = cs_getproto(link);
497 * Free association and release resources.
499 void destroy_association(association *h)
501 statserv_options_block *cb = statserv_getcontrol();
504 odr_destroy(h->decode);
505 odr_destroy(h->encode);
507 odr_destroy(h->print);
509 xfree(h->input_buffer);
511 (*cb->bend_close)(h->backend);
512 while (request_deq(&h->incoming));
513 while (request_deq(&h->outgoing));
514 request_delq(&h->incoming);
515 request_delq(&h->outgoing);
517 if (control_block && control_block->one_shot)
521 static void do_close_req(association *a, int reason, char *message,
525 Z_Close *cls = zget_Close(a->encode);
527 /* Purge request queue */
528 while (request_deq(&a->incoming));
529 while (request_deq(&a->outgoing));
532 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
533 reason, message ? message : "none");
534 apdu.which = Z_APDU_close;
536 *cls->closeReason = reason;
537 cls->diagnosticInformation = message;
538 process_response(a, req, &apdu);
539 iochan_settimeout(a->client_chan, 60);
543 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
544 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
546 a->state = ASSOC_DEAD;
549 static void do_close(association *a, int reason, char *message)
551 do_close_req (a, reason, message, request_get(&a->outgoing));
555 * This is where PDUs from the client are read and the further
556 * processing is initiated. Flow of control moves down through the
557 * various process_* functions below, until the encoded result comes back up
558 * to the output handler in here.
560 * h : the I/O channel that has an outstanding event.
561 * event : the current outstanding event.
563 void ir_session(IOCHAN h, int event)
566 association *assoc = (association *)iochan_getdata(h);
567 COMSTACK conn = assoc->client_link;
570 assert(h && conn && assoc);
571 if (event == EVENT_TIMEOUT)
573 if (assoc->state != ASSOC_UP)
575 yaz_log(LOG_LOG, "Final timeout - closing connection.");
577 destroy_association(assoc);
582 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
583 do_close(assoc, Z_Close_lackOfActivity, 0);
587 if (event & assoc->cs_accept_mask)
589 yaz_log (LOG_DEBUG, "ir_session (accept)");
590 if (!cs_accept (conn))
592 yaz_log (LOG_LOG, "accept failed");
593 destroy_association(assoc);
596 iochan_clearflag (h, EVENT_OUTPUT|EVENT_OUTPUT);
597 if (conn->io_pending)
598 { /* cs_accept didn't complete */
599 assoc->cs_accept_mask =
600 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
601 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
603 iochan_setflag (h, assoc->cs_accept_mask);
606 { /* cs_accept completed. Prepare for reading (cs_get) */
607 assoc->cs_accept_mask = 0;
608 assoc->cs_get_mask = EVENT_INPUT;
609 iochan_setflag (h, assoc->cs_get_mask);
613 if ((event & assoc->cs_get_mask) || (event & EVENT_WORK)) /* input */
615 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
617 yaz_log(LOG_DEBUG, "ir_session (input)");
618 /* We aren't speaking to this fellow */
619 if (assoc->state == ASSOC_DEAD)
621 yaz_log(LOG_LOG, "Closed connection after reject");
623 destroy_association(assoc);
627 assoc->cs_get_mask = EVENT_INPUT;
628 if ((res = cs_get(conn, &assoc->input_buffer,
629 &assoc->input_buffer_len)) <= 0)
631 yaz_log(LOG_LOG, "Connection closed by client");
633 destroy_association(assoc);
637 else if (res == 1) /* incomplete read - wait for more */
639 if (conn->io_pending & CS_WANT_WRITE)
640 assoc->cs_get_mask |= EVENT_OUTPUT;
641 iochan_setflag(h, assoc->cs_get_mask);
644 if (cs_more(conn)) /* more stuff - call us again later, please */
645 iochan_setevent(h, EVENT_INPUT);
647 /* we got a complete PDU. Let's decode it */
648 yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
649 req = request_get(&assoc->incoming); /* get a new request structure */
650 odr_reset(assoc->decode);
651 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
652 if (!z_APDU(assoc->decode, &req->request, 0, 0))
654 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
655 odr_errmsg(odr_geterror(assoc->decode)),
656 odr_offset(assoc->decode));
657 yaz_log(LOG_LOG, "PDU dump:");
658 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
659 do_close(assoc, Z_Close_protocolError, "Malformed package");
662 req->request_mem = odr_extract_mem(assoc->decode);
663 if (assoc->print && !z_APDU(assoc->print, &req->request, 0, 0))
665 yaz_log(LOG_WARN, "ODR print error: %s",
666 odr_errmsg(odr_geterror(assoc->print)));
667 odr_reset(assoc->print);
669 request_enq(&assoc->incoming, req);
672 /* can we do something yet? */
673 req = request_head(&assoc->incoming);
674 if (req->state == REQUEST_IDLE)
677 request_deq(&assoc->incoming);
678 if (process_request(assoc, req, &msg) < 0)
679 do_close_req(assoc, Z_Close_systemProblem, msg, req);
682 if (event & assoc->cs_put_mask)
684 request *req = request_head(&assoc->outgoing);
686 assoc->cs_put_mask = 0;
687 yaz_log(LOG_DEBUG, "ir_session (output)");
688 req->state = REQUEST_PENDING;
689 switch (res = cs_put(conn, req->response, req->len_response))
692 yaz_log(LOG_LOG, "Connection closed by client");
694 destroy_association(assoc);
697 case 0: /* all sent - release the request structure */
698 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
699 nmem_destroy(req->request_mem);
700 request_deq(&assoc->outgoing);
701 request_release(req);
702 if (!request_head(&assoc->outgoing))
703 { /* restore mask for cs_get operation ... */
704 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
705 iochan_setflag(h, assoc->cs_get_mask);
709 if (conn->io_pending & CS_WANT_WRITE)
710 assoc->cs_put_mask |= EVENT_OUTPUT;
711 if (conn->io_pending & CS_WANT_READ)
712 assoc->cs_put_mask |= EVENT_INPUT;
713 iochan_setflag(h, assoc->cs_put_mask);
716 if (event & EVENT_EXCEPT)
718 yaz_log(LOG_LOG, "ir_session (exception)");
720 destroy_association(assoc);
726 * Initiate request processing.
728 static int process_request(association *assoc, request *req, char **msg)
734 *msg = "Unknown Error";
735 assert(req && req->state == REQUEST_IDLE);
736 if (req->request->which != Z_APDU_initRequest && !assoc->init)
738 *msg = "Missing InitRequest";
741 switch (req->request->which)
743 case Z_APDU_initRequest:
744 res = process_initRequest(assoc, req); break;
745 case Z_APDU_searchRequest:
746 res = process_searchRequest(assoc, req, &fd); break;
747 case Z_APDU_presentRequest:
748 res = process_presentRequest(assoc, req, &fd); break;
749 case Z_APDU_scanRequest:
750 if (assoc->init->bend_scan)
751 res = process_scanRequest(assoc, req, &fd);
754 *msg = "Cannot handle Scan APDU";
758 case Z_APDU_extendedServicesRequest:
759 if (assoc->init->bend_esrequest)
760 res = process_ESRequest(assoc, req, &fd);
763 *msg = "Cannot handle Extended Services APDU";
767 case Z_APDU_sortRequest:
768 if (assoc->init->bend_sort)
769 res = process_sortRequest(assoc, req, &fd);
772 *msg = "Cannot handle Sort APDU";
777 process_close(assoc, req);
779 case Z_APDU_deleteResultSetRequest:
780 if (assoc->init->bend_delete)
781 res = process_deleteRequest(assoc, req, &fd);
784 *msg = "Cannot handle Delete APDU";
788 case Z_APDU_segmentRequest:
789 if (assoc->init->bend_segment)
791 res = process_segmentRequest (assoc, req);
795 *msg = "Cannot handle Segment APDU";
800 *msg = "Bad APDU received";
805 yaz_log(LOG_DEBUG, " result immediately available");
806 retval = process_response(assoc, req, res);
810 yaz_log(LOG_DEBUG, " result unavailble");
813 else /* no result yet - one will be provided later */
817 /* Set up an I/O handler for the fd supplied by the backend */
819 yaz_log(LOG_DEBUG, " establishing handler for result");
820 req->state = REQUEST_PENDING;
821 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
823 iochan_setdata(chan, assoc);
830 * Handle message from the backend.
832 void backend_response(IOCHAN i, int event)
834 association *assoc = (association *)iochan_getdata(i);
835 request *req = request_head(&assoc->incoming);
839 yaz_log(LOG_DEBUG, "backend_response");
840 assert(assoc && req && req->state != REQUEST_IDLE);
841 /* determine what it is we're waiting for */
842 switch (req->request->which)
844 case Z_APDU_searchRequest:
845 res = response_searchRequest(assoc, req, 0, &fd); break;
847 case Z_APDU_presentRequest:
848 res = response_presentRequest(assoc, req, 0, &fd); break;
849 case Z_APDU_scanRequest:
850 res = response_scanRequest(assoc, req, 0, &fd); break;
853 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
856 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
858 yaz_log(LOG_LOG, "Fatal error when talking to backend");
859 do_close(assoc, Z_Close_systemProblem, 0);
863 else if (!res) /* no result yet - try again later */
865 yaz_log(LOG_DEBUG, " no result yet");
866 iochan_setfd(i, fd); /* in case fd has changed */
871 * Encode response, and transfer the request structure to the outgoing queue.
873 static int process_response(association *assoc, request *req, Z_APDU *res)
875 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
876 if (!z_APDU(assoc->encode, &res, 0, 0))
878 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
879 odr_errmsg(odr_geterror(assoc->decode)));
880 odr_reset(assoc->encode);
883 req->response = odr_getbuf(assoc->encode, &req->len_response,
884 &req->size_response);
885 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
886 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
888 yaz_log(LOG_WARN, "ODR print error: %s",
889 odr_errmsg(odr_geterror(assoc->print)));
890 odr_reset(assoc->print);
892 odr_reset(assoc->encode);
893 req->state = REQUEST_IDLE;
894 request_enq(&assoc->outgoing, req);
895 /* turn the work over to the ir_session handler */
896 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
897 assoc->cs_put_mask = EVENT_OUTPUT;
898 /* Is there more work to be done? give that to the input handler too */
900 if (request_head(&assoc->incoming))
902 yaz_log (LOG_DEBUG, "more work to be done");
903 iochan_setevent(assoc->client_chan, EVENT_WORK);
910 * Handle init request.
911 * At the moment, we don't check the options
912 * anywhere else in the code - we just try not to do anything that would
913 * break a naive client. We'll toss 'em into the association block when
914 * we need them there.
916 static Z_APDU *process_initRequest(association *assoc, request *reqb)
918 statserv_options_block *cb = statserv_getcontrol();
919 Z_InitRequest *req = reqb->request->u.initRequest;
920 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
921 Z_InitResponse *resp = apdu->u.initResponse;
922 bend_initresult *binitres;
926 assoc->init = xmalloc (sizeof(*assoc->init));
928 yaz_log(LOG_LOG, "Got initRequest");
929 if (req->implementationId)
930 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
931 if (req->implementationName)
932 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
933 if (req->implementationVersion)
934 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
936 assoc->init->stream = assoc->encode;
937 assoc->init->print = assoc->print;
938 assoc->init->auth = req->idAuthentication;
939 assoc->init->referenceId = req->referenceId;
940 assoc->init->implementation_version = 0;
941 assoc->init->implementation_name = 0;
942 assoc->init->bend_sort = NULL;
943 assoc->init->bend_search = NULL;
944 assoc->init->bend_present = NULL;
945 assoc->init->bend_esrequest = NULL;
946 assoc->init->bend_delete = NULL;
947 assoc->init->bend_scan = NULL;
948 assoc->init->bend_segment = NULL;
949 assoc->init->bend_fetch = NULL;
951 assoc->init->peer_name =
952 odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
953 if (!(binitres = (*cb->bend_init)(assoc->init)))
955 yaz_log(LOG_WARN, "Bad response from backend.");
959 assoc->backend = binitres->handle;
960 if ((assoc->init->bend_sort))
961 yaz_log (LOG_DEBUG, "Sort handler installed");
962 if ((assoc->init->bend_search))
963 yaz_log (LOG_DEBUG, "Search handler installed");
964 if ((assoc->init->bend_present))
965 yaz_log (LOG_DEBUG, "Present handler installed");
966 if ((assoc->init->bend_esrequest))
967 yaz_log (LOG_DEBUG, "ESRequest handler installed");
968 if ((assoc->init->bend_delete))
969 yaz_log (LOG_DEBUG, "Delete handler installed");
970 if ((assoc->init->bend_scan))
971 yaz_log (LOG_DEBUG, "Scan handler installed");
972 if ((assoc->init->bend_segment))
973 yaz_log (LOG_DEBUG, "Segment handler installed");
975 resp->referenceId = req->referenceId;
977 /* let's tell the client what we can do */
978 if (ODR_MASK_GET(req->options, Z_Options_search))
980 ODR_MASK_SET(resp->options, Z_Options_search);
981 strcat(options, "srch");
983 if (ODR_MASK_GET(req->options, Z_Options_present))
985 ODR_MASK_SET(resp->options, Z_Options_present);
986 strcat(options, " prst");
988 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
989 assoc->init->bend_delete)
991 ODR_MASK_SET(resp->options, Z_Options_delSet);
992 strcat(options, " del");
994 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
995 assoc->init->bend_esrequest)
997 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
998 strcat (options, " extendedServices");
1000 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
1002 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
1003 strcat(options, " namedresults");
1005 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
1007 ODR_MASK_SET(resp->options, Z_Options_scan);
1008 strcat(options, " scan");
1010 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
1012 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
1013 strcat(options, " concurop");
1015 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
1017 ODR_MASK_SET(resp->options, Z_Options_sort);
1018 strcat(options, " sort");
1020 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
1022 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
1023 assoc->version = 2; /* 1 & 2 are equivalent */
1025 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
1027 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
1030 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
1032 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
1035 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
1036 assoc->maximumRecordSize = *req->maximumRecordSize;
1037 if (assoc->maximumRecordSize > control_block->maxrecordsize)
1038 assoc->maximumRecordSize = control_block->maxrecordsize;
1039 assoc->preferredMessageSize = *req->preferredMessageSize;
1040 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
1041 assoc->preferredMessageSize = assoc->maximumRecordSize;
1044 assoc->maximumRecordSize = 3000000;
1045 assoc->preferredMessageSize = 3000000;
1048 resp->preferredMessageSize = &assoc->preferredMessageSize;
1049 resp->maximumRecordSize = &assoc->maximumRecordSize;
1051 resp->implementationName = "GFS";
1053 if (assoc->init->implementation_name)
1056 odr_malloc (assoc->encode,
1057 strlen(assoc->init->implementation_name) + 10 +
1058 strlen(resp->implementationName));
1059 sprintf (nv, "%s / %s",
1060 resp->implementationName, assoc->init->implementation_name);
1061 resp->implementationName = nv;
1063 if (assoc->init->implementation_version)
1066 odr_malloc (assoc->encode,
1067 strlen(assoc->init->implementation_version) + 10 +
1068 strlen(resp->implementationVersion));
1069 sprintf (nv, "YAZ %s / %s",
1070 resp->implementationVersion,
1071 assoc->init->implementation_version);
1072 resp->implementationVersion = nv;
1075 if (binitres->errcode)
1077 yaz_log(LOG_LOG, "Connection rejected by backend.");
1079 assoc->state = ASSOC_DEAD;
1082 assoc->state = ASSOC_UP;
1087 * These functions should be merged.
1090 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo)
1093 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1094 dr->u.v2Addinfo = addinfo ? addinfo : "";
1096 dr->which = Z_DiagForm_v2AddInfo;
1097 dr->addinfo = addinfo ? addinfo : "";
1102 * nonsurrogate diagnostic record.
1104 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
1107 Z_Records *rec = (Z_Records *)
1108 odr_malloc (assoc->encode, sizeof(*rec));
1111 odr_malloc (assoc->encode, sizeof(*err));
1112 Z_DiagRec *drec = (Z_DiagRec *)
1113 odr_malloc (assoc->encode, sizeof(*drec));
1114 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1115 odr_malloc (assoc->encode, sizeof(*dr));
1117 bib1.proto = assoc->proto;
1118 bib1.oclass = CLASS_DIAGSET;
1119 bib1.value = VAL_BIB1;
1121 yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
1124 rec->which = Z_Records_NSD;
1126 rec->u.nonSurrogateDiagnostic = dr;
1128 rec->u.nonSurrogateDiagnostic = drec;
1129 drec->which = Z_DiagRec_defaultFormat;
1130 drec->u.defaultFormat = dr;
1132 dr->diagnosticSetId =
1133 odr_oiddup (assoc->encode, oid_ent_to_oid(&bib1, oid));
1134 dr->condition = err;
1135 set_addinfo (dr, addinfo);
1140 * surrogate diagnostic.
1142 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1143 int error, char *addinfo)
1146 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1147 odr_malloc (assoc->encode, sizeof(*rec));
1148 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1150 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1151 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1152 odr_malloc (assoc->encode, sizeof(*dr));
1154 bib1.proto = assoc->proto;
1155 bib1.oclass = CLASS_DIAGSET;
1156 bib1.value = VAL_BIB1;
1158 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1160 rec->databaseName = dbname;
1161 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1162 rec->u.surrogateDiagnostic = drec;
1163 drec->which = Z_DiagRec_defaultFormat;
1164 drec->u.defaultFormat = dr;
1165 dr->diagnosticSetId = odr_oiddup (assoc->encode,
1166 oid_ent_to_oid(&bib1, oid));
1167 dr->condition = err;
1168 set_addinfo (dr, addinfo);
1174 * multiple nonsurrogate diagnostics.
1176 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1179 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1180 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1182 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1183 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1184 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)odr_malloc (assoc->encode, sizeof(*rec));
1186 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1187 bib1.proto = assoc->proto;
1188 bib1.oclass = CLASS_DIAGSET;
1189 bib1.value = VAL_BIB1;
1192 recs->num_diagRecs = 1;
1193 recs->diagRecs = recp;
1195 drec->which = Z_DiagRec_defaultFormat;
1196 drec->u.defaultFormat = rec;
1198 rec->diagnosticSetId = odr_oiddup (assoc->encode,
1199 oid_ent_to_oid(&bib1, oid));
1200 rec->condition = err;
1203 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1204 rec->u.v2Addinfo = addinfo ? addinfo : "";
1206 rec->which = Z_DiagForm_v2AddInfo;
1207 rec->addinfo = addinfo ? addinfo : "";
1212 static Z_Records *pack_records(association *a, char *setname, int start,
1213 int *num, Z_RecordComposition *comp,
1214 int *next, int *pres, oid_value format,
1215 Z_ReferenceId *referenceId,
1218 int recno, total_length = 0, toget = *num, dumped_records = 0;
1219 Z_Records *records =
1220 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1221 Z_NamePlusRecordList *reclist =
1222 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1223 Z_NamePlusRecord **list =
1224 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1226 records->which = Z_Records_DBOSD;
1227 records->u.databaseOrSurDiagnostics = reclist;
1228 reclist->num_records = 0;
1229 reclist->records = list;
1230 *pres = Z_PRES_SUCCESS;
1234 yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
1235 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1236 a->maximumRecordSize);
1237 for (recno = start; reclist->num_records < toget; recno++)
1240 Z_NamePlusRecord *thisrec;
1241 int this_length = 0;
1243 * we get the number of bytes allocated on the stream before any
1244 * allocation done by the backend - this should give us a reasonable
1245 * idea of the total size of the data so far.
1247 total_length = odr_total(a->encode) - dumped_records;
1253 freq.last_in_set = 0;
1254 freq.setname = setname;
1255 freq.surrogate_flag = 0;
1256 freq.number = recno;
1258 freq.request_format = format;
1259 freq.request_format_raw = oid;
1260 freq.output_format = format;
1261 freq.output_format_raw = 0;
1262 freq.stream = a->encode;
1263 freq.print = a->print;
1264 freq.surrogate_flag = 0;
1265 freq.referenceId = referenceId;
1266 (*a->init->bend_fetch)(a->backend, &freq);
1267 /* backend should be able to signal whether error is system-wide
1268 or only pertaining to current record */
1271 if (!freq.surrogate_flag)
1273 *pres = Z_PRES_FAILURE;
1274 return diagrec(a, freq.errcode, freq.errstring);
1276 reclist->records[reclist->num_records] =
1277 surrogatediagrec(a, freq.basename, freq.errcode,
1279 reclist->num_records++;
1280 *next = freq.last_in_set ? 0 : recno + 1;
1284 this_length = freq.len;
1286 this_length = odr_total(a->encode) - total_length;
1287 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1288 this_length, total_length);
1289 if (this_length + total_length > a->preferredMessageSize)
1291 /* record is small enough, really */
1292 if (this_length <= a->preferredMessageSize)
1294 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1295 *pres = Z_PRES_PARTIAL_2;
1298 /* record can only be fetched by itself */
1299 if (this_length < a->maximumRecordSize)
1301 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1304 yaz_log(LOG_DEBUG, " Dropped it");
1305 reclist->records[reclist->num_records] =
1306 surrogatediagrec(a, freq.basename, 16, 0);
1307 reclist->num_records++;
1308 *next = freq.last_in_set ? 0 : recno + 1;
1309 dumped_records += this_length;
1313 else /* too big entirely */
1315 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
1316 reclist->records[reclist->num_records] =
1317 surrogatediagrec(a, freq.basename, 17, 0);
1318 reclist->num_records++;
1319 *next = freq.last_in_set ? 0 : recno + 1;
1320 dumped_records += this_length;
1325 if (!(thisrec = (Z_NamePlusRecord *)
1326 odr_malloc(a->encode, sizeof(*thisrec))))
1328 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1329 strlen(freq.basename) + 1)))
1331 strcpy(thisrec->databaseName, freq.basename);
1332 thisrec->which = Z_NamePlusRecord_databaseRecord;
1334 if (freq.output_format_raw)
1336 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
1337 freq.output_format = ident->value;
1339 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
1340 freq.record, freq.len);
1341 if (!thisrec->u.databaseRecord)
1343 reclist->records[reclist->num_records] = thisrec;
1344 reclist->num_records++;
1345 *next = freq.last_in_set ? 0 : recno + 1;
1347 *num = reclist->num_records;
1351 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1354 Z_SearchRequest *req = reqb->request->u.searchRequest;
1355 bend_search_rr *bsrr =
1356 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1358 yaz_log(LOG_LOG, "Got SearchRequest.");
1360 bsrr->request = reqb;
1361 bsrr->association = assoc;
1362 bsrr->referenceId = req->referenceId;
1363 save_referenceId (reqb, bsrr->referenceId);
1365 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1366 if (req->databaseNames)
1369 for (i = 0; i < req->num_databaseNames; i++)
1370 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1372 switch (req->query->which)
1374 case Z_Query_type_1: case Z_Query_type_101:
1375 log_rpn_query (req->query->u.type_1);
1377 if (assoc->init->bend_search)
1379 bsrr->setname = req->resultSetName;
1380 bsrr->replace_set = *req->replaceIndicator;
1381 bsrr->num_bases = req->num_databaseNames;
1382 bsrr->basenames = req->databaseNames;
1383 bsrr->query = req->query;
1384 bsrr->stream = assoc->encode;
1385 bsrr->decode = assoc->decode;
1386 bsrr->print = assoc->print;
1389 bsrr->errstring = NULL;
1390 (assoc->init->bend_search)(assoc->backend, bsrr);
1397 bend_searchrequest bsrq;
1398 bend_searchresult *bsrt;
1400 bsrq.setname = req->resultSetName;
1401 bsrq.replace_set = *req->replaceIndicator;
1402 bsrq.num_bases = req->num_databaseNames;
1403 bsrq.basenames = req->databaseNames;
1404 bsrq.query = req->query;
1405 bsrq.referenceId = req->referenceId;
1406 bsrq.stream = assoc->encode;
1407 bsrq.decode = assoc->decode;
1408 bsrq.print = assoc->print;
1409 if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1411 bsrr->hits = bsrt->hits;
1412 bsrr->errcode = bsrt->errcode;
1413 bsrr->errstring = bsrt->errstring;
1416 return response_searchRequest(assoc, reqb, bsrr, fd);
1419 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1422 * Prepare a searchresponse based on the backend results. We probably want
1423 * to look at making the fetching of records nonblocking as well, but
1424 * so far, we'll keep things simple.
1425 * If bsrt is null, that means we're called in response to a communications
1426 * event, and we'll have to get the response for ourselves.
1428 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1429 bend_search_rr *bsrt, int *fd)
1431 Z_SearchRequest *req = reqb->request->u.searchRequest;
1432 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1433 Z_SearchResponse *resp = (Z_SearchResponse *)
1434 odr_malloc (assoc->encode, sizeof(*resp));
1435 int *nulint = (int *)odr_malloc (assoc->encode, sizeof(*nulint));
1436 bool_t *sr = (bool_t *)odr_malloc (assoc->encode, sizeof(*sr));
1437 int *next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1438 int *none = (int *)odr_malloc (assoc->encode, sizeof(*none));
1445 apdu->which = Z_APDU_searchResponse;
1446 apdu->u.searchResponse = resp;
1447 resp->referenceId = req->referenceId;
1448 resp->additionalSearchInfo = 0;
1449 resp->otherInfo = 0;
1451 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1453 yaz_log(LOG_FATAL, "Bad result from backend");
1456 else if (bsrt->errcode)
1458 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1459 resp->resultCount = nulint;
1460 resp->numberOfRecordsReturned = nulint;
1461 resp->nextResultSetPosition = nulint;
1462 resp->searchStatus = nulint;
1463 resp->resultSetStatus = none;
1464 resp->presentStatus = 0;
1468 int *toget = (int *)odr_malloc (assoc->encode, sizeof(*toget));
1469 int *presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1470 Z_RecordComposition comp, *compp = 0;
1475 resp->resultCount = &bsrt->hits;
1477 comp.which = Z_RecordComp_simple;
1478 /* how many records does the user agent want, then? */
1479 if (bsrt->hits <= *req->smallSetUpperBound)
1481 *toget = bsrt->hits;
1482 if ((comp.u.simple = req->smallSetElementSetNames))
1485 else if (bsrt->hits < *req->largeSetLowerBound)
1487 *toget = *req->mediumSetPresentNumber;
1488 if (*toget > bsrt->hits)
1489 *toget = bsrt->hits;
1490 if ((comp.u.simple = req->mediumSetElementSetNames))
1496 if (*toget && !resp->records)
1501 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1502 prefformat->oclass != CLASS_RECSYN)
1505 form = prefformat->value;
1506 resp->records = pack_records(assoc, req->resultSetName, 1,
1507 toget, compp, next, presst, form, req->referenceId,
1508 req->preferredRecordSyntax);
1511 resp->numberOfRecordsReturned = toget;
1512 resp->nextResultSetPosition = next;
1513 resp->searchStatus = sr;
1514 resp->resultSetStatus = 0;
1515 resp->presentStatus = presst;
1519 if (*resp->resultCount)
1521 resp->numberOfRecordsReturned = nulint;
1522 resp->nextResultSetPosition = next;
1523 resp->searchStatus = sr;
1524 resp->resultSetStatus = 0;
1525 resp->presentStatus = 0;
1532 * Maybe we got a little over-friendly when we designed bend_fetch to
1533 * get only one record at a time. Some backends can optimise multiple-record
1534 * fetches, and at any rate, there is some overhead involved in
1535 * all that selecting and hopping around. Problem is, of course, that the
1536 * frontend can't know ahead of time how many records it'll need to
1537 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1538 * is downright lousy as a bulk data transfer protocol.
1540 * To start with, we'll do the fetching of records from the backend
1541 * in one operation: To save some trips in and out of the event-handler,
1542 * and to simplify the interface to pack_records. At any rate, asynch
1543 * operation is more fun in operations that have an unpredictable execution
1544 * speed - which is normally more true for search than for present.
1546 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1549 Z_PresentRequest *req = reqb->request->u.presentRequest;
1553 Z_PresentResponse *resp;
1558 yaz_log(LOG_LOG, "Got PresentRequest.");
1560 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1561 prefformat->oclass != CLASS_RECSYN)
1564 form = prefformat->value;
1565 if (assoc->init->bend_present)
1567 bend_present_rr *bprr = (bend_present_rr *)
1568 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1569 bprr->setname = req->resultSetId;
1570 bprr->start = *req->resultSetStartPoint;
1571 bprr->number = *req->numberOfRecordsRequested;
1572 bprr->format = form;
1573 bprr->comp = req->recordComposition;
1574 bprr->referenceId = req->referenceId;
1575 bprr->stream = assoc->encode;
1576 bprr->print = assoc->print;
1577 bprr->request = reqb;
1578 bprr->association = assoc;
1580 bprr->errstring = NULL;
1581 (*assoc->init->bend_present)(assoc->backend, bprr);
1586 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1587 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1588 presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1589 next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1590 num = (int *)odr_malloc (assoc->encode, sizeof(*num));
1593 *num = *req->numberOfRecordsRequested;
1595 apdu->which = Z_APDU_presentResponse;
1596 apdu->u.presentResponse = resp;
1597 resp->referenceId = req->referenceId;
1598 resp->otherInfo = 0;
1601 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1602 num, req->recordComposition, next, presst, form,
1603 req->referenceId, req->preferredRecordSyntax);
1606 resp->numberOfRecordsReturned = num;
1607 resp->presentStatus = presst;
1608 resp->nextResultSetPosition = next;
1614 static int bend_default_scan (void *handle, bend_scan_rr *rr)
1616 bend_scanrequest srq;
1617 bend_scanresult *srs;
1619 srq.num_bases = rr->num_bases;
1620 srq.basenames = rr->basenames;
1621 srq.attributeset = rr->attributeset;
1622 srq.referenceId = rr->referenceId;
1623 srq.term = rr->term;
1624 srq.term_position = rr->term_position;
1625 srq.num_entries = rr->num_entries;
1626 srq.stream = rr->stream;
1627 srq.print = rr->print;
1629 srs = bend_scan(handle, &srq, 0);
1631 rr->term_position = srs->term_position;
1632 rr->num_entries = srs->num_entries;
1633 rr->entries = srs->entries;
1634 rr->status = srs->status;
1635 rr->errcode = srs->errcode;
1636 rr->errstring = srs->errstring;
1642 * Scan was implemented rather in a hurry, and with support for only the basic
1643 * elements of the service in the backend API. Suggestions are welcome.
1645 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1647 Z_ScanRequest *req = reqb->request->u.scanRequest;
1648 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1649 Z_ScanResponse *res = (Z_ScanResponse *)
1650 odr_malloc (assoc->encode, sizeof(*res));
1651 int *scanStatus = (int *)
1652 odr_malloc (assoc->encode, sizeof(*scanStatus));
1653 int *numberOfEntriesReturned = (int *)
1654 odr_malloc (assoc->encode, sizeof(*numberOfEntriesReturned));
1655 Z_ListEntries *ents = (Z_ListEntries *)
1656 odr_malloc (assoc->encode, sizeof(*ents));
1657 Z_DiagRecs *diagrecs_p = NULL;
1661 yaz_log(LOG_LOG, "Got ScanRequest");
1662 *scanStatus = Z_Scan_failure;
1663 *numberOfEntriesReturned = 0;
1665 apdu->which = Z_APDU_scanResponse;
1666 apdu->u.scanResponse = res;
1667 res->referenceId = req->referenceId;
1669 res->scanStatus = scanStatus;
1670 res->numberOfEntriesReturned = numberOfEntriesReturned;
1671 res->positionOfTerm = 0;
1672 res->entries = ents;
1673 ents->num_entries = 0;
1674 ents->entries = NULL;
1675 ents->num_nonsurrogateDiagnostics = 0;
1676 ents->nonsurrogateDiagnostics = NULL;
1677 res->attributeSet = 0;
1680 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1681 attent->oclass != CLASS_ATTSET
1682 || attent->value != VAL_BIB1))
1683 diagrecs_p = diagrecs(assoc, 121, 0);
1684 else if (req->stepSize && *req->stepSize > 0)
1685 diagrecs_p = diagrecs(assoc, 205, 0);
1688 bend_scan_rr *bsrr = (bend_scan_rr *)
1689 odr_malloc (assoc->encode, sizeof(*bsrr));
1690 if (req->databaseNames)
1693 for (i = 0; i < req->num_databaseNames; i++)
1694 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1696 bsrr->num_bases = req->num_databaseNames;
1697 bsrr->basenames = req->databaseNames;
1698 bsrr->num_entries = *req->numberOfTermsRequested;
1699 bsrr->term = req->termListAndStartPoint;
1700 bsrr->referenceId = req->referenceId;
1701 bsrr->stream = assoc->encode;
1702 bsrr->print = assoc->print;
1703 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1704 attset->oclass != CLASS_RECSYN)
1705 bsrr->attributeset = VAL_NONE;
1707 bsrr->attributeset = attset->value;
1708 log_scan_term (req->termListAndStartPoint, attset->value);
1709 bsrr->term_position = req->preferredPositionInResponse ?
1710 *req->preferredPositionInResponse : 1;
1711 ((int (*)(void *, bend_scan_rr *))
1712 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1714 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1718 Z_Entry **tab = (Z_Entry **)
1719 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1721 if (bsrr->status == BEND_SCAN_PARTIAL)
1722 *scanStatus = Z_Scan_partial_5;
1724 *scanStatus = Z_Scan_success;
1725 ents->entries = tab;
1726 ents->num_entries = bsrr->num_entries;
1727 res->numberOfEntriesReturned = &ents->num_entries;
1728 res->positionOfTerm = &bsrr->term_position;
1729 for (i = 0; i < bsrr->num_entries; i++)
1735 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1736 if (bsrr->entries[i].occurrences >= 0)
1738 e->which = Z_Entry_termInfo;
1739 e->u.termInfo = t = (Z_TermInfo *)
1740 odr_malloc(assoc->encode, sizeof(*t));
1741 t->suggestedAttributes = 0;
1743 t->alternativeTerm = 0;
1744 t->byAttributes = 0;
1745 t->otherTermInfo = 0;
1746 t->globalOccurrences = &bsrr->entries[i].occurrences;
1747 t->term = (Z_Term *)
1748 odr_malloc(assoc->encode, sizeof(*t->term));
1749 t->term->which = Z_Term_general;
1750 t->term->u.general = o =
1751 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1752 o->buf = (unsigned char *)
1753 odr_malloc(assoc->encode, o->len = o->size =
1754 strlen(bsrr->entries[i].term));
1755 memcpy(o->buf, bsrr->entries[i].term, o->len);
1756 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1757 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1761 Z_DiagRecs *drecs = diagrecs (assoc,
1762 bsrr->entries[i].errcode,
1763 bsrr->entries[i].errstring);
1764 assert (drecs->num_diagRecs == 1);
1765 e->which = Z_Entry_surrogateDiagnostic;
1766 assert (drecs->diagRecs[0]);
1767 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1774 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1775 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1780 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1783 Z_SortRequest *req = reqb->request->u.sortRequest;
1784 Z_SortResponse *res = (Z_SortResponse *)
1785 odr_malloc (assoc->encode, sizeof(*res));
1786 bend_sort_rr *bsrr = (bend_sort_rr *)
1787 odr_malloc (assoc->encode, sizeof(*bsrr));
1789 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1791 yaz_log(LOG_LOG, "Got SortRequest.");
1794 bsrr->num_input_setnames = req->num_inputResultSetNames;
1795 bsrr->input_setnames = req->inputResultSetNames;
1797 bsrr->num_input_setnames = req->inputResultSetNames->num_strings;
1798 bsrr->input_setnames = req->inputResultSetNames->strings;
1800 bsrr->referenceId = req->referenceId;
1801 bsrr->output_setname = req->sortedResultSetName;
1802 bsrr->sort_sequence = req->sortSequence;
1803 bsrr->stream = assoc->encode;
1804 bsrr->print = assoc->print;
1806 bsrr->sort_status = Z_SortStatus_failure;
1808 bsrr->errstring = 0;
1810 (*assoc->init->bend_sort)(assoc->backend, bsrr);
1812 res->referenceId = bsrr->referenceId;
1813 res->sortStatus = (int *)
1814 odr_malloc (assoc->encode, sizeof(*res->sortStatus));
1815 *res->sortStatus = bsrr->sort_status;
1816 res->resultSetStatus = 0;
1819 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1821 res->diagnostics = dr->diagRecs;
1822 res->num_diagnostics = dr->num_diagRecs;
1824 res->diagnostics = dr;
1830 res->num_diagnostics = 0;
1832 res->diagnostics = 0;
1836 apdu->which = Z_APDU_sortResponse;
1837 apdu->u.sortResponse = res;
1841 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1844 Z_DeleteResultSetRequest *req = reqb->request->u.deleteResultSetRequest;
1845 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1846 odr_malloc (assoc->encode, sizeof(*res));
1847 bend_delete_rr *bdrr = (bend_delete_rr *)
1848 odr_malloc (assoc->encode, sizeof(*bdrr));
1849 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1851 yaz_log(LOG_LOG, "Got DeleteRequest.");
1853 bdrr->num_setnames = req->num_resultSetList;
1854 bdrr->setnames = req->resultSetList;
1855 bdrr->stream = assoc->encode;
1856 bdrr->print = assoc->print;
1857 bdrr->function = *req->deleteFunction;
1858 bdrr->referenceId = req->referenceId;
1860 if (bdrr->num_setnames > 0)
1863 bdrr->statuses = odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1864 bdrr->num_setnames);
1865 for (i = 0; i < bdrr->num_setnames; i++)
1866 bdrr->statuses[i] = 0;
1868 (*assoc->init->bend_delete)(assoc->backend, bdrr);
1870 res->referenceId = req->referenceId;
1872 res->deleteOperationStatus = (int *)
1873 odr_malloc (assoc->encode, sizeof(*res->deleteOperationStatus));
1874 *res->deleteOperationStatus = bdrr->delete_status;
1876 res->deleteListStatuses = 0;
1877 if (bdrr->num_setnames > 0)
1880 res->deleteListStatuses = odr_malloc(assoc->encode,
1881 sizeof(*res->deleteListStatuses));
1882 res->deleteListStatuses->num = bdrr->num_setnames;
1883 res->deleteListStatuses->elements =
1884 odr_malloc (assoc->encode,
1885 sizeof(*res->deleteListStatuses->elements) *
1886 bdrr->num_setnames);
1887 for (i = 0; i<bdrr->num_setnames; i++)
1889 res->deleteListStatuses->elements[i] =
1890 odr_malloc (assoc->encode,
1891 sizeof(**res->deleteListStatuses->elements));
1892 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1893 res->deleteListStatuses->elements[i]->id =
1894 odr_strdup (assoc->encode, bdrr->setnames[i]);
1898 res->numberNotDeleted = 0;
1899 res->bulkStatuses = 0;
1900 res->deleteMessage = 0;
1903 apdu->which = Z_APDU_deleteResultSetResponse;
1904 apdu->u.deleteResultSetResponse = res;
1908 static void process_close(association *assoc, request *reqb)
1910 Z_Close *req = reqb->request->u.close;
1911 static char *reasons[] =
1918 "securityViolation",
1925 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1926 reasons[*req->closeReason], req->diagnosticInformation ?
1927 req->diagnosticInformation : "NULL");
1928 if (assoc->version < 3) /* to make do_force respond with close */
1930 do_close_req(assoc, Z_Close_finished,
1931 "Association terminated by client", reqb);
1934 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1938 reqb->len_refid = refid->len;
1939 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1940 memcpy (reqb->refid, refid->buf, refid->len);
1944 reqb->len_refid = 0;
1949 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1951 process_response (a, req, res);
1954 bend_request bend_request_mk (bend_association a)
1956 request *nreq = request_get (&a->outgoing);
1957 nreq->request_mem = nmem_create ();
1961 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1966 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1967 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1968 id->len = id->size = req->len_refid;
1969 memcpy (id->buf, req->refid, req->len_refid);
1973 void bend_request_destroy (bend_request *req)
1975 nmem_destroy((*req)->request_mem);
1976 request_release(*req);
1980 int bend_backend_respond (bend_association a, bend_request req)
1984 r = process_request (a, req, &msg);
1986 logf (LOG_WARN, "%s", msg);
1990 void bend_request_setdata(bend_request r, void *p)
1995 void *bend_request_getdata(bend_request r)
1997 return r->clientData;
2000 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
2002 bend_segment_rr request;
2004 request.segment = reqb->request->u.segmentRequest;
2005 request.stream = assoc->encode;
2006 request.decode = assoc->decode;
2007 request.print = assoc->print;
2008 request.association = assoc;
2010 (*assoc->init->bend_segment)(assoc->backend, &request);
2015 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
2017 bend_esrequest_rr esrequest;
2019 Z_ExtendedServicesRequest *req = reqb->request->u.extendedServicesRequest;
2020 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
2022 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
2024 yaz_log(LOG_DEBUG,"inside Process esRequest");
2026 esrequest.esr = reqb->request->u.extendedServicesRequest;
2027 esrequest.stream = assoc->encode;
2028 esrequest.decode = assoc->decode;
2029 esrequest.print = assoc->print;
2030 esrequest.errcode = 0;
2031 esrequest.errstring = NULL;
2032 esrequest.request = reqb;
2033 esrequest.association = assoc;
2034 esrequest.referenceId = req->referenceId;
2036 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
2038 /* If the response is being delayed, return NULL */
2039 if (esrequest.request == NULL)
2042 resp->referenceId = req->referenceId;
2044 if (esrequest.errcode == -1)
2046 /* Backend service indicates request will be processed */
2047 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
2048 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
2050 else if (esrequest.errcode == 0)
2052 /* Backend service indicates request will be processed */
2053 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
2054 *resp->operationStatus = Z_ExtendedServicesResponse_done;
2058 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
2059 esrequest.errstring);
2061 /* Backend indicates error, request will not be processed */
2062 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
2063 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
2064 resp->num_diagnostics = diagRecs->num_diagRecs;
2065 resp->diagnostics = diagRecs->diagRecs;
2067 /* Do something with the members of bend_extendedservice */
2069 yaz_log(LOG_DEBUG,"Send the result apdu");