2 * Copyright (c) 1995-2000, Index Data
3 * See the file LICENSE for details.
6 * Revision 1.107 2000-08-31 10:20:12 adam
7 * Added member request_format and output_format for backend fetch method.
9 * Revision 1.106 2000/08/31 09:51:25 adam
10 * Added record_syntax member for fetch method (raw OID).
12 * Revision 1.105 2000/07/06 10:38:47 adam
13 * Enhanced option --enable-tcpd.
15 * Revision 1.104 2000/04/05 07:39:55 adam
16 * Added shared library support (libtool).
18 * Revision 1.103 2000/03/20 19:06:25 adam
19 * Added Segment request for fronend server. Work on admin for client.
21 * Revision 1.102 2000/03/15 12:59:49 adam
22 * Added handle member to statserv_control.
24 * Revision 1.101 2000/01/12 14:36:07 adam
25 * Added printing stream (ODR) for backend functions.
27 * Revision 1.100 1999/12/16 23:36:19 adam
28 * Implemented ILL protocol. Minor updates ASN.1 compiler.
30 * Revision 1.99 1999/11/30 13:47:12 adam
31 * Improved installation. Moved header files to include/yaz.
33 * Revision 1.98 1999/11/29 15:12:27 adam
34 * Changed the way implementationName - and version is set.
36 * Revision 1.96 1999/11/04 14:58:44 adam
37 * Added status elements for backend delete result set handler.
38 * Updated delete result result set command for client.
40 * Revision 1.95 1999/10/11 10:01:24 adam
41 * Implemented bend_sort_rr handler for frontend server.
43 * Revision 1.94 1999/08/27 09:40:32 adam
44 * Renamed logf function to yaz_log. Removed VC++ project files.
46 * Revision 1.93 1999/07/06 12:17:15 adam
47 * Added option -1 that runs server once (for profiling purposes).
49 * Revision 1.92 1999/06/17 10:54:45 adam
50 * Added facility to specify implementation version - and name
53 * Revision 1.91 1999/06/01 14:29:12 adam
54 * Work on Extended Services.
56 * Revision 1.90 1999/05/27 13:02:20 adam
57 * Assigned OID for old DB Update (VAL_DBUPDATE0).
59 * Revision 1.89 1999/05/26 15:24:26 adam
60 * Fixed minor bugs regarding DB Update (introduced by previous commit).
62 * Revision 1.88 1999/04/20 09:56:48 adam
63 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
64 * Modified all encoders/decoders to reflect this change.
66 * Revision 1.87 1999/03/31 11:18:25 adam
67 * Implemented odr_strdup. Added Reference ID to backend server API.
69 * Revision 1.86 1999/02/02 13:57:38 adam
70 * Uses preprocessor define WIN32 instead of WINDOWS to build code
71 * for Microsoft WIN32.
73 * Revision 1.85 1998/11/17 09:52:59 adam
74 * Fixed minor bug (introduced by previous commit).
76 * Revision 1.84 1998/11/16 16:02:32 adam
77 * Added loggin utilies, log_rpn_query and log_scan_term. These used
78 * to be part of Zebra.
80 * Revision 1.83 1998/11/03 10:09:36 adam
81 * Fixed bug regarding YC.
83 * Revision 1.82 1998/10/20 14:00:30 quinn
86 * Revision 1.81 1998/10/13 16:12:24 adam
87 * Added support for Surrogate Diagnostics for Scan Term entries.
89 * Revision 1.80 1998/09/02 12:41:53 adam
90 * Added decode stream in bend search structures.
92 * Revision 1.79 1998/08/19 16:10:08 adam
93 * Changed som member names of DeleteResultSetRequest/Response.
95 * Revision 1.78 1998/08/03 10:23:55 adam
96 * Fixed bug regarding Options for Sort.
98 * Revision 1.77 1998/07/20 12:38:42 adam
99 * Implemented delete result set service to server API.
101 * Revision 1.76 1998/05/27 16:57:07 adam
102 * Support for surrogate diagnostic records added for bend_fetch.
104 * Revision 1.75 1998/05/18 10:13:07 adam
105 * Fixed call to es_request handler - extra argument was passed.
107 * Revision 1.74 1998/03/31 15:13:20 adam
108 * Development towards compiled ASN.1.
110 * Revision 1.73 1998/03/31 11:07:45 adam
111 * Furhter work on UNIverse resource report.
112 * Added Extended Services handling in frontend server.
114 * Revision 1.72 1998/02/11 11:53:35 adam
115 * Changed code so that it compiles as C++.
117 * Revision 1.71 1998/02/10 11:03:57 adam
118 * Added support for extended handlers in backend server interface.
120 * Revision 1.70 1998/01/29 13:15:35 adam
121 * Implemented sort for the backend interface.
123 * Revision 1.69 1997/09/30 11:48:12 adam
124 * Fixed bug introduced by previous commit.
126 * Revision 1.68 1997/09/29 13:18:59 adam
127 * Added function, oid_ent_to_oid, to replace the function
128 * oid_getoidbyent, which is not thread safe.
130 * Revision 1.67 1997/09/17 12:10:40 adam
133 * Revision 1.66 1997/09/05 15:26:44 adam
134 * Added ODR encode in search and scen bend request structures.
135 * Fixed a few enums that caused trouble with C++.
137 * Revision 1.65 1997/09/01 08:53:01 adam
138 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
139 * moved a separate directory. MSV5.0 project server.dsp created.
140 * As an option, the server can now operate as an NT service.
142 * Revision 1.64 1997/04/30 08:52:11 quinn
145 * Revision 1.63 1996/10/11 11:57:26 quinn
148 * Revision 1.62 1996/07/06 19:58:35 quinn
149 * System headerfiles gathered in yconfig
151 * Revision 1.61 1996/06/10 08:56:16 quinn
154 * Revision 1.60 1996/05/30 11:03:10 quinn
155 * Fixed NextresultSetPosition bug fixed.
157 * Revision 1.59 1996/05/14 09:26:46 quinn
158 * Added attribute set to scan backend
160 * Revision 1.58 1996/02/20 12:53:04 quinn
163 * Revision 1.57 1996/01/02 08:57:47 quinn
164 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
166 * Revision 1.56 1995/12/14 11:09:57 quinn
169 * Revision 1.55 1995/11/08 17:41:37 quinn
172 * Revision 1.54 1995/11/08 15:11:29 quinn
173 * Log of close transmit.
175 * Revision 1.53 1995/11/01 13:54:58 quinn
178 * Revision 1.52 1995/11/01 12:19:13 quinn
179 * Second attempt to fix same bug.
181 * Revision 1.50 1995/10/25 16:58:32 quinn
184 * Revision 1.49 1995/10/16 13:51:53 quinn
185 * Changes to provide Especs to the backend.
187 * Revision 1.48 1995/10/06 08:51:20 quinn
188 * Added Write-buffer.
190 * Revision 1.47 1995/08/29 14:24:16 quinn
191 * Added second half of close-handshake
193 * Revision 1.46 1995/08/29 11:17:58 quinn
194 * Added code to receive close
196 * Revision 1.45 1995/08/21 09:11:00 quinn
197 * Smallish fixes to suppport new formats.
199 * Revision 1.44 1995/08/17 12:45:25 quinn
200 * Fixed minor problems with GRS-1. Added support in c&s.
202 * Revision 1.43 1995/08/15 12:00:31 quinn
205 * Revision 1.42 1995/08/15 11:16:50 quinn
207 * Revision 1.41 1995/08/02 10:23:06 quinn
210 * Revision 1.40 1995/07/31 14:34:26 quinn
211 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
213 * Revision 1.39 1995/06/27 13:21:00 quinn
216 * Revision 1.38 1995/06/19 12:39:11 quinn
217 * Fixed bug in timeout code. Added BER dumper.
219 * Revision 1.37 1995/06/16 13:16:14 quinn
220 * Fixed Defaultdiagformat.
222 * Revision 1.36 1995/06/16 10:31:36 quinn
223 * Added session timeout.
225 * Revision 1.35 1995/06/15 07:45:14 quinn
228 * Revision 1.34 1995/06/14 15:26:46 quinn
229 * *** empty log message ***
231 * Revision 1.33 1995/06/06 14:57:05 quinn
232 * Better diagnostics.
234 * Revision 1.32 1995/06/06 08:41:44 quinn
235 * Better diagnostics.
237 * Revision 1.31 1995/06/06 08:15:37 quinn
240 * Revision 1.30 1995/06/05 10:53:32 quinn
241 * Added a better SCAN.
243 * Revision 1.29 1995/06/01 11:25:03 quinn
246 * Revision 1.28 1995/06/01 11:21:01 quinn
247 * Attempting to fix a bug in pack-records. replaced break with continue
248 * for large records, according to standard.
250 * Revision 1.27 1995/05/29 08:12:06 quinn
253 * Revision 1.26 1995/05/18 13:02:12 quinn
256 * Revision 1.25 1995/05/17 08:42:26 quinn
257 * Transfer auth info to backend. Allow backend to reject init gracefully.
259 * Revision 1.24 1995/05/16 08:51:04 quinn
260 * License, documentation, and memory fixes
262 * Revision 1.23 1995/05/15 13:25:10 quinn
265 * Revision 1.22 1995/05/15 11:56:39 quinn
266 * Asynchronous facilities. Restructuring of seshigh code.
268 * Revision 1.21 1995/05/02 08:53:19 quinn
269 * Trying in vain to fix comm with ISODE
271 * Revision 1.20 1995/04/20 15:13:00 quinn
274 * Revision 1.19 1995/04/18 08:15:34 quinn
275 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
276 * neater. We'll make the same change for decoding one day.
278 * Revision 1.18 1995/04/17 11:28:25 quinn
281 * Revision 1.17 1995/04/10 10:23:36 quinn
282 * Some work to add scan and other things.
284 * Revision 1.16 1995/03/31 09:18:55 quinn
287 * Revision 1.15 1995/03/30 14:03:23 quinn
288 * Added RFC1006 as separate library
290 * Revision 1.14 1995/03/30 12:18:17 quinn
293 * Revision 1.13 1995/03/30 09:09:24 quinn
294 * Added state-handle and some support for asynchronous activities.
296 * Revision 1.12 1995/03/29 15:40:16 quinn
297 * Ongoing work. Statserv is now dynamic by default
299 * Revision 1.11 1995/03/28 09:16:21 quinn
300 * Added record packing to the search request
302 * Revision 1.10 1995/03/27 08:34:24 quinn
303 * Added dynamic server functionality.
304 * Released bindings to session.c (is now redundant)
306 * Revision 1.9 1995/03/22 15:01:26 quinn
307 * Adjusting record packing.
309 * Revision 1.8 1995/03/22 10:13:21 quinn
310 * Working on record packer
312 * Revision 1.7 1995/03/21 15:53:31 quinn
315 * Revision 1.6 1995/03/21 12:30:09 quinn
316 * Beginning to add support for record packing.
318 * Revision 1.5 1995/03/17 10:44:13 quinn
319 * Added catch of null-string in makediagrec
321 * Revision 1.4 1995/03/17 10:18:08 quinn
322 * Added memory management.
324 * Revision 1.3 1995/03/16 17:42:39 quinn
327 * Revision 1.2 1995/03/16 13:29:01 quinn
328 * Partitioned server.
330 * Revision 1.1 1995/03/15 16:02:10 quinn
331 * Modded session.c to seshigh.c
336 * Frontend server logic.
338 * This code receives incoming APDUs, and handles client requests by means
339 * of the backend API.
341 * Some of the code is getting quite involved, compared to simpler servers -
342 * primarily because it is asynchronous both in the communication with
343 * the user and the backend. We think the complexity will pay off in
344 * the form of greater flexibility when more asynchronous facilities
347 * Memory management has become somewhat involved. In the simple case, where
348 * only one PDU is pending at a time, it will simply reuse the same memory,
349 * once it has found its working size. When we enable multiple concurrent
350 * operations, perhaps even with multiple parallel calls to the backend, it
351 * will maintain a pool of buffers for encoding and decoding, trying to
352 * minimize memory allocation/deallocation during normal operation.
354 * TODOs include (and will be done in order of public interest):
356 * Support for EXPLAIN - provide simple meta-database system.
357 * Support for access control.
358 * Support for resource control.
359 * Support for extended services - primarily Item Order.
360 * Rest of Z39.50-1994
373 #include <yaz/yconfig.h>
374 #include <yaz/xmalloc.h>
375 #include <yaz/comstack.h>
378 #include <yaz/proto.h>
381 #include <yaz/logrpn.h>
382 #include <yaz/statserv.h>
384 #include <yaz/backend.h>
386 static int process_request(association *assoc, request *req, char **msg);
387 void backend_response(IOCHAN i, int event);
388 static int process_response(association *assoc, request *req, Z_APDU *res);
389 static Z_APDU *process_initRequest(association *assoc, request *reqb);
390 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
392 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
393 bend_search_rr *bsrr, int *fd);
394 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
396 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
397 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
398 static void process_close(association *assoc, request *reqb);
399 void save_referenceId (request *reqb, Z_ReferenceId *refid);
400 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
402 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
404 static FILE *apduf = 0; /* for use in static mode */
405 static statserv_options_block *control_block = 0;
407 /* Chas: Added in from DALI */
408 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
409 /* Chas: End of addition from DALI */
412 * Create and initialize a new association-handle.
413 * channel : iochannel for the current line.
414 * link : communications channel.
415 * Returns: 0 or a new association handle.
417 association *create_association(IOCHAN channel, COMSTACK link)
422 control_block = statserv_getcontrol();
423 if (!(anew = (association *)xmalloc(sizeof(*anew))))
426 anew->client_chan = channel;
427 anew->client_link = link;
428 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
429 !(anew->encode = odr_createmem(ODR_ENCODE)))
431 if (*control_block->apdufile)
436 strcpy(filename, control_block->apdufile);
437 if (!(anew->print = odr_createmem(ODR_PRINT)))
439 if (*control_block->apdufile != '-')
441 strcpy(filename, control_block->apdufile);
442 if (!control_block->dynamic)
446 if (!(apduf = fopen(filename, "w")))
448 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
451 setvbuf(apduf, 0, _IONBF, 0);
457 sprintf(filename + strlen(filename), ".%d", getpid());
458 if (!(f = fopen(filename, "w")))
460 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
463 setvbuf(f, 0, _IONBF, 0);
465 odr_setprint(anew->print, f);
470 anew->input_buffer = 0;
471 anew->input_buffer_len = 0;
473 anew->state = ASSOC_NEW;
474 request_initq(&anew->incoming);
475 request_initq(&anew->outgoing);
476 anew->proto = cs_getproto(link);
481 * Free association and release resources.
483 void destroy_association(association *h)
485 statserv_options_block *cb = statserv_getcontrol();
488 odr_destroy(h->decode);
489 odr_destroy(h->encode);
491 odr_destroy(h->print);
493 xfree(h->input_buffer);
495 (*cb->bend_close)(h->backend);
496 while (request_deq(&h->incoming));
497 while (request_deq(&h->outgoing));
498 request_delq(&h->incoming);
499 request_delq(&h->outgoing);
501 if (control_block && control_block->one_shot)
505 static void do_close_req(association *a, int reason, char *message,
509 Z_Close *cls = zget_Close(a->encode);
511 /* Purge request queue */
512 while (request_deq(&a->incoming));
513 while (request_deq(&a->outgoing));
516 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
517 reason, message ? message : "none");
518 apdu.which = Z_APDU_close;
520 *cls->closeReason = reason;
521 cls->diagnosticInformation = message;
522 process_response(a, req, &apdu);
523 iochan_settimeout(a->client_chan, 60);
527 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
528 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
530 a->state = ASSOC_DEAD;
533 static void do_close(association *a, int reason, char *message)
535 do_close_req (a, reason, message, request_get(&a->outgoing));
539 * This is where PDUs from the client are read and the further
540 * processing is initiated. Flow of control moves down through the
541 * various process_* functions below, until the encoded result comes back up
542 * to the output handler in here.
544 * h : the I/O channel that has an outstanding event.
545 * event : the current outstanding event.
547 void ir_session(IOCHAN h, int event)
550 association *assoc = (association *)iochan_getdata(h);
551 COMSTACK conn = assoc->client_link;
554 assert(h && conn && assoc);
555 if (event == EVENT_TIMEOUT)
557 if (assoc->state != ASSOC_UP)
559 yaz_log(LOG_LOG, "Final timeout - closing connection.");
561 destroy_association(assoc);
566 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
567 do_close(assoc, Z_Close_lackOfActivity, 0);
571 if (event & EVENT_INPUT || event & EVENT_WORK) /* input */
573 if (event & EVENT_INPUT)
575 yaz_log(LOG_DEBUG, "ir_session (input)");
576 assert(assoc && conn);
577 /* We aren't speaking to this fellow */
578 if (assoc->state == ASSOC_DEAD)
580 yaz_log(LOG_LOG, "Closed connection after reject");
582 destroy_association(assoc);
586 if ((res = cs_get(conn, &assoc->input_buffer,
587 &assoc->input_buffer_len)) <= 0)
589 yaz_log(LOG_LOG, "Connection closed by client");
591 destroy_association(assoc);
595 else if (res == 1) /* incomplete read - wait for more */
597 if (cs_more(conn)) /* more stuff - call us again later, please */
598 iochan_setevent(h, EVENT_INPUT);
600 /* we got a complete PDU. Let's decode it */
601 yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
602 req = request_get(&assoc->incoming); /* get a new request structure */
603 odr_reset(assoc->decode);
604 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
605 if (!z_APDU(assoc->decode, &req->request, 0, 0))
607 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
608 odr_errmsg(odr_geterror(assoc->decode)),
609 odr_offset(assoc->decode));
610 yaz_log(LOG_LOG, "PDU dump:");
611 odr_dumpBER(log_file(), assoc->input_buffer, res);
612 do_close(assoc, Z_Close_protocolError, "Malformed package");
615 req->request_mem = odr_extract_mem(assoc->decode);
616 if (assoc->print && !z_APDU(assoc->print, &req->request, 0, 0))
618 yaz_log(LOG_WARN, "ODR print error: %s",
619 odr_errmsg(odr_geterror(assoc->print)));
620 odr_reset(assoc->print);
622 request_enq(&assoc->incoming, req);
625 /* can we do something yet? */
626 req = request_head(&assoc->incoming);
627 if (req->state == REQUEST_IDLE)
630 request_deq(&assoc->incoming);
631 if (process_request(assoc, req, &msg) < 0)
632 do_close_req(assoc, Z_Close_systemProblem, msg, req);
635 if (event & EVENT_OUTPUT)
637 request *req = request_head(&assoc->outgoing);
639 yaz_log(LOG_DEBUG, "ir_session (output)");
640 req->state = REQUEST_PENDING;
641 switch (res = cs_put(conn, req->response, req->len_response))
644 yaz_log(LOG_LOG, "Connection closed by client");
646 destroy_association(assoc);
649 case 0: /* all sent - release the request structure */
650 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
651 nmem_destroy(req->request_mem);
652 request_deq(&assoc->outgoing);
653 request_release(req);
654 if (!request_head(&assoc->outgoing))
655 iochan_clearflag(h, EVENT_OUTPUT);
657 /* value of 1 -- partial send -- is simply ignored */
660 if (event & EVENT_EXCEPT)
662 yaz_log(LOG_DEBUG, "ir_session (exception)");
664 destroy_association(assoc);
670 * Initiate request processing.
672 static int process_request(association *assoc, request *req, char **msg)
678 *msg = "Unknown Error";
679 assert(req && req->state == REQUEST_IDLE);
680 if (req->request->which != Z_APDU_initRequest && !assoc->init)
682 *msg = "Missing InitRequest";
685 switch (req->request->which)
687 case Z_APDU_initRequest:
688 res = process_initRequest(assoc, req); break;
689 case Z_APDU_searchRequest:
690 res = process_searchRequest(assoc, req, &fd); break;
691 case Z_APDU_presentRequest:
692 res = process_presentRequest(assoc, req, &fd); break;
693 case Z_APDU_scanRequest:
694 if (assoc->init->bend_scan)
695 res = process_scanRequest(assoc, req, &fd);
698 *msg = "Cannot handle Scan APDU";
702 case Z_APDU_extendedServicesRequest:
703 if (assoc->init->bend_esrequest)
704 res = process_ESRequest(assoc, req, &fd);
707 *msg = "Cannot handle Extended Services APDU";
711 case Z_APDU_sortRequest:
712 if (assoc->init->bend_sort)
713 res = process_sortRequest(assoc, req, &fd);
716 *msg = "Cannot handle Sort APDU";
721 process_close(assoc, req);
723 case Z_APDU_deleteResultSetRequest:
724 if (assoc->init->bend_delete)
725 res = process_deleteRequest(assoc, req, &fd);
728 *msg = "Cannot handle Delete APDU";
732 case Z_APDU_segmentRequest:
733 if (assoc->init->bend_segment)
735 res = process_segmentRequest (assoc, req);
739 *msg = "Cannot handle Segment APDU";
744 *msg = "Bad APDU received";
749 yaz_log(LOG_DEBUG, " result immediately available");
750 retval = process_response(assoc, req, res);
754 yaz_log(LOG_DEBUG, " result unavailble");
757 else /* no result yet - one will be provided later */
761 /* Set up an I/O handler for the fd supplied by the backend */
763 yaz_log(LOG_DEBUG, " establishing handler for result");
764 req->state = REQUEST_PENDING;
765 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
767 iochan_setdata(chan, assoc);
774 * Handle message from the backend.
776 void backend_response(IOCHAN i, int event)
778 association *assoc = (association *)iochan_getdata(i);
779 request *req = request_head(&assoc->incoming);
783 yaz_log(LOG_DEBUG, "backend_response");
784 assert(assoc && req && req->state != REQUEST_IDLE);
785 /* determine what it is we're waiting for */
786 switch (req->request->which)
788 case Z_APDU_searchRequest:
789 res = response_searchRequest(assoc, req, 0, &fd); break;
791 case Z_APDU_presentRequest:
792 res = response_presentRequest(assoc, req, 0, &fd); break;
793 case Z_APDU_scanRequest:
794 res = response_scanRequest(assoc, req, 0, &fd); break;
797 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
800 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
802 yaz_log(LOG_LOG, "Fatal error when talking to backend");
803 do_close(assoc, Z_Close_systemProblem, 0);
807 else if (!res) /* no result yet - try again later */
809 yaz_log(LOG_DEBUG, " no result yet");
810 iochan_setfd(i, fd); /* in case fd has changed */
815 * Encode response, and transfer the request structure to the outgoing queue.
817 static int process_response(association *assoc, request *req, Z_APDU *res)
819 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
820 if (!z_APDU(assoc->encode, &res, 0, 0))
822 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
823 odr_errmsg(odr_geterror(assoc->decode)));
824 odr_reset(assoc->encode);
827 req->response = odr_getbuf(assoc->encode, &req->len_response,
828 &req->size_response);
829 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
830 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
832 yaz_log(LOG_WARN, "ODR print error: %s",
833 odr_errmsg(odr_geterror(assoc->print)));
834 odr_reset(assoc->print);
836 odr_reset(assoc->encode);
837 req->state = REQUEST_IDLE;
838 request_enq(&assoc->outgoing, req);
839 /* turn the work over to the ir_session handler */
840 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
841 /* Is there more work to be done? give that to the input handler too */
843 if (request_head(&assoc->incoming))
845 yaz_log (LOG_DEBUG, "more work to be done");
846 iochan_setevent(assoc->client_chan, EVENT_WORK);
853 * Handle init request.
854 * At the moment, we don't check the options
855 * anywhere else in the code - we just try not to do anything that would
856 * break a naive client. We'll toss 'em into the association block when
857 * we need them there.
859 static Z_APDU *process_initRequest(association *assoc, request *reqb)
861 statserv_options_block *cb = statserv_getcontrol();
862 Z_InitRequest *req = reqb->request->u.initRequest;
863 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
864 Z_InitResponse *resp = apdu->u.initResponse;
865 bend_initresult *binitres;
869 assoc->init = xmalloc (sizeof(*assoc->init));
871 yaz_log(LOG_LOG, "Got initRequest");
872 if (req->implementationId)
873 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
874 if (req->implementationName)
875 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
876 if (req->implementationVersion)
877 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
879 assoc->init->stream = assoc->encode;
880 assoc->init->print = assoc->print;
881 assoc->init->auth = req->idAuthentication;
882 assoc->init->referenceId = req->referenceId;
883 assoc->init->implementation_version = 0;
884 assoc->init->implementation_name = 0;
885 assoc->init->bend_sort = NULL;
886 assoc->init->bend_search = NULL;
887 assoc->init->bend_present = NULL;
888 assoc->init->bend_esrequest = NULL;
889 assoc->init->bend_delete = NULL;
890 assoc->init->bend_scan = NULL;
891 assoc->init->bend_segment = NULL;
892 assoc->init->bend_fetch = NULL;
893 if (!(binitres = (*cb->bend_init)(assoc->init)))
895 yaz_log(LOG_WARN, "Bad response from backend.");
899 assoc->backend = binitres->handle;
900 if ((assoc->init->bend_sort))
901 yaz_log (LOG_DEBUG, "Sort handler installed");
902 if ((assoc->init->bend_search))
903 yaz_log (LOG_DEBUG, "Search handler installed");
904 if ((assoc->init->bend_present))
905 yaz_log (LOG_DEBUG, "Present handler installed");
906 if ((assoc->init->bend_esrequest))
907 yaz_log (LOG_DEBUG, "ESRequest handler installed");
908 if ((assoc->init->bend_delete))
909 yaz_log (LOG_DEBUG, "Delete handler installed");
910 if ((assoc->init->bend_scan))
911 yaz_log (LOG_DEBUG, "Scan handler installed");
912 if ((assoc->init->bend_segment))
913 yaz_log (LOG_DEBUG, "Segment handler installed");
915 resp->referenceId = req->referenceId;
917 /* let's tell the client what we can do */
918 if (ODR_MASK_GET(req->options, Z_Options_search))
920 ODR_MASK_SET(resp->options, Z_Options_search);
921 strcat(options, "srch");
923 if (ODR_MASK_GET(req->options, Z_Options_present))
925 ODR_MASK_SET(resp->options, Z_Options_present);
926 strcat(options, " prst");
928 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
929 assoc->init->bend_delete)
931 ODR_MASK_SET(resp->options, Z_Options_delSet);
932 strcat(options, " del");
934 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
935 assoc->init->bend_esrequest)
937 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
938 strcat (options, " extendedServices");
940 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
942 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
943 strcat(options, " namedresults");
945 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
947 ODR_MASK_SET(resp->options, Z_Options_scan);
948 strcat(options, " scan");
950 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
952 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
953 strcat(options, " concurop");
955 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
957 ODR_MASK_SET(resp->options, Z_Options_sort);
958 strcat(options, " sort");
960 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
962 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
963 assoc->version = 2; /* 1 & 2 are equivalent */
965 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
967 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
970 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
972 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
975 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
976 assoc->maximumRecordSize = *req->maximumRecordSize;
977 if (assoc->maximumRecordSize > control_block->maxrecordsize)
978 assoc->maximumRecordSize = control_block->maxrecordsize;
979 assoc->preferredMessageSize = *req->preferredMessageSize;
980 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
981 assoc->preferredMessageSize = assoc->maximumRecordSize;
982 resp->preferredMessageSize = &assoc->preferredMessageSize;
983 resp->maximumRecordSize = &assoc->maximumRecordSize;
985 resp->implementationName = "GFS";
987 if (assoc->init->implementation_name)
990 odr_malloc (assoc->encode,
991 strlen(assoc->init->implementation_name) + 10 +
992 strlen(resp->implementationName));
993 sprintf (nv, "%s / %s",
994 resp->implementationName, assoc->init->implementation_name);
995 resp->implementationName = nv;
997 if (assoc->init->implementation_version)
1000 odr_malloc (assoc->encode,
1001 strlen(assoc->init->implementation_version) + 10 +
1002 strlen(resp->implementationVersion));
1003 sprintf (nv, "YAZ %s / %s",
1004 resp->implementationVersion,
1005 assoc->init->implementation_version);
1006 resp->implementationVersion = nv;
1009 if (binitres->errcode)
1011 yaz_log(LOG_LOG, "Connection rejected by backend.");
1013 assoc->state = ASSOC_DEAD;
1016 assoc->state = ASSOC_UP;
1021 * These functions should be merged.
1024 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo)
1027 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1028 dr->u.v2Addinfo = addinfo ? addinfo : "";
1030 dr->which = Z_DiagForm_v2AddInfo;
1031 dr->addinfo = addinfo ? addinfo : "";
1036 * nonsurrogate diagnostic record.
1038 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
1041 Z_Records *rec = (Z_Records *)
1042 odr_malloc (assoc->encode, sizeof(*rec));
1045 odr_malloc (assoc->encode, sizeof(*err));
1046 Z_DiagRec *drec = (Z_DiagRec *)
1047 odr_malloc (assoc->encode, sizeof(*drec));
1048 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1049 odr_malloc (assoc->encode, sizeof(*dr));
1051 bib1.proto = assoc->proto;
1052 bib1.oclass = CLASS_DIAGSET;
1053 bib1.value = VAL_BIB1;
1055 yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
1058 rec->which = Z_Records_NSD;
1060 rec->u.nonSurrogateDiagnostic = dr;
1062 rec->u.nonSurrogateDiagnostic = drec;
1063 drec->which = Z_DiagRec_defaultFormat;
1064 drec->u.defaultFormat = dr;
1066 dr->diagnosticSetId =
1067 odr_oiddup (assoc->encode, oid_ent_to_oid(&bib1, oid));
1068 dr->condition = err;
1069 set_addinfo (dr, addinfo);
1074 * surrogate diagnostic.
1076 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1077 int error, char *addinfo)
1080 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1081 odr_malloc (assoc->encode, sizeof(*rec));
1082 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1084 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1085 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1086 odr_malloc (assoc->encode, sizeof(*dr));
1088 bib1.proto = assoc->proto;
1089 bib1.oclass = CLASS_DIAGSET;
1090 bib1.value = VAL_BIB1;
1092 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1094 rec->databaseName = dbname;
1095 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1096 rec->u.surrogateDiagnostic = drec;
1097 drec->which = Z_DiagRec_defaultFormat;
1098 drec->u.defaultFormat = dr;
1099 dr->diagnosticSetId = odr_oiddup (assoc->encode,
1100 oid_ent_to_oid(&bib1, oid));
1101 dr->condition = err;
1102 set_addinfo (dr, addinfo);
1108 * multiple nonsurrogate diagnostics.
1110 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1113 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1114 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1116 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1117 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1118 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)odr_malloc (assoc->encode, sizeof(*rec));
1120 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1121 bib1.proto = assoc->proto;
1122 bib1.oclass = CLASS_DIAGSET;
1123 bib1.value = VAL_BIB1;
1126 recs->num_diagRecs = 1;
1127 recs->diagRecs = recp;
1129 drec->which = Z_DiagRec_defaultFormat;
1130 drec->u.defaultFormat = rec;
1132 rec->diagnosticSetId = odr_oiddup (assoc->encode,
1133 oid_ent_to_oid(&bib1, oid));
1134 rec->condition = err;
1137 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1138 rec->u.v2Addinfo = addinfo ? addinfo : "";
1140 rec->which = Z_DiagForm_v2AddInfo;
1141 rec->addinfo = addinfo ? addinfo : "";
1146 static Z_Records *pack_records(association *a, char *setname, int start,
1147 int *num, Z_RecordComposition *comp,
1148 int *next, int *pres, oid_value format,
1149 Z_ReferenceId *referenceId,
1152 int recno, total_length = 0, toget = *num, dumped_records = 0;
1153 Z_Records *records =
1154 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1155 Z_NamePlusRecordList *reclist =
1156 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1157 Z_NamePlusRecord **list =
1158 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1160 records->which = Z_Records_DBOSD;
1161 records->u.databaseOrSurDiagnostics = reclist;
1162 reclist->num_records = 0;
1163 reclist->records = list;
1164 *pres = Z_PRES_SUCCESS;
1168 yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
1169 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1170 a->maximumRecordSize);
1171 for (recno = start; reclist->num_records < toget; recno++)
1174 Z_NamePlusRecord *thisrec;
1175 int this_length = 0;
1177 * we get the number of bytes allocated on the stream before any
1178 * allocation done by the backend - this should give us a reasonable
1179 * idea of the total size of the data so far.
1181 total_length = odr_total(a->encode) - dumped_records;
1187 freq.last_in_set = 0;
1188 freq.setname = setname;
1189 freq.surrogate_flag = 0;
1190 freq.number = recno;
1192 freq.request_format = format;
1193 freq.request_format_raw = oid;
1194 freq.output_format = format;
1195 freq.output_format_raw = 0;
1196 freq.stream = a->encode;
1197 freq.print = a->print;
1198 freq.surrogate_flag = 0;
1199 freq.referenceId = referenceId;
1200 (*a->init->bend_fetch)(a->backend, &freq);
1201 /* backend should be able to signal whether error is system-wide
1202 or only pertaining to current record */
1205 if (!freq.surrogate_flag)
1207 *pres = Z_PRES_FAILURE;
1208 return diagrec(a, freq.errcode, freq.errstring);
1210 reclist->records[reclist->num_records] =
1211 surrogatediagrec(a, freq.basename, freq.errcode,
1213 reclist->num_records++;
1214 *next = freq.last_in_set ? 0 : recno + 1;
1218 this_length = freq.len;
1220 this_length = odr_total(a->encode) - total_length;
1221 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1222 this_length, total_length);
1223 if (this_length + total_length > a->preferredMessageSize)
1225 /* record is small enough, really */
1226 if (this_length <= a->preferredMessageSize)
1228 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1229 *pres = Z_PRES_PARTIAL_2;
1232 /* record can only be fetched by itself */
1233 if (this_length < a->maximumRecordSize)
1235 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1238 yaz_log(LOG_DEBUG, " Dropped it");
1239 reclist->records[reclist->num_records] =
1240 surrogatediagrec(a, freq.basename, 16, 0);
1241 reclist->num_records++;
1242 *next = freq.last_in_set ? 0 : recno + 1;
1243 dumped_records += this_length;
1247 else /* too big entirely */
1249 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
1250 reclist->records[reclist->num_records] =
1251 surrogatediagrec(a, freq.basename, 17, 0);
1252 reclist->num_records++;
1253 *next = freq.last_in_set ? 0 : recno + 1;
1254 dumped_records += this_length;
1259 if (!(thisrec = (Z_NamePlusRecord *)
1260 odr_malloc(a->encode, sizeof(*thisrec))))
1262 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1263 strlen(freq.basename) + 1)))
1265 strcpy(thisrec->databaseName, freq.basename);
1266 thisrec->which = Z_NamePlusRecord_databaseRecord;
1268 if (freq.output_format_raw)
1270 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
1271 freq.output_format = ident->value;
1273 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
1274 freq.record, freq.len);
1275 if (!thisrec->u.databaseRecord)
1277 reclist->records[reclist->num_records] = thisrec;
1278 reclist->num_records++;
1279 *next = freq.last_in_set ? 0 : recno + 1;
1281 *num = reclist->num_records;
1285 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1288 Z_SearchRequest *req = reqb->request->u.searchRequest;
1289 bend_search_rr *bsrr =
1290 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1292 yaz_log(LOG_LOG, "Got SearchRequest.");
1294 bsrr->request = reqb;
1295 bsrr->association = assoc;
1296 bsrr->referenceId = req->referenceId;
1297 save_referenceId (reqb, bsrr->referenceId);
1299 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1300 if (req->databaseNames)
1303 for (i = 0; i < req->num_databaseNames; i++)
1304 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1306 switch (req->query->which)
1308 case Z_Query_type_1: case Z_Query_type_101:
1309 log_rpn_query (req->query->u.type_1);
1311 if (assoc->init->bend_search)
1313 bsrr->setname = req->resultSetName;
1314 bsrr->replace_set = *req->replaceIndicator;
1315 bsrr->num_bases = req->num_databaseNames;
1316 bsrr->basenames = req->databaseNames;
1317 bsrr->query = req->query;
1318 bsrr->stream = assoc->encode;
1319 bsrr->decode = assoc->decode;
1320 bsrr->print = assoc->print;
1323 bsrr->errstring = NULL;
1324 (assoc->init->bend_search)(assoc->backend, bsrr);
1331 bend_searchrequest bsrq;
1332 bend_searchresult *bsrt;
1334 bsrq.setname = req->resultSetName;
1335 bsrq.replace_set = *req->replaceIndicator;
1336 bsrq.num_bases = req->num_databaseNames;
1337 bsrq.basenames = req->databaseNames;
1338 bsrq.query = req->query;
1339 bsrq.referenceId = req->referenceId;
1340 bsrq.stream = assoc->encode;
1341 bsrq.decode = assoc->decode;
1342 bsrq.print = assoc->print;
1343 if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1345 bsrr->hits = bsrt->hits;
1346 bsrr->errcode = bsrt->errcode;
1347 bsrr->errstring = bsrt->errstring;
1350 return response_searchRequest(assoc, reqb, bsrr, fd);
1353 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1356 * Prepare a searchresponse based on the backend results. We probably want
1357 * to look at making the fetching of records nonblocking as well, but
1358 * so far, we'll keep things simple.
1359 * If bsrt is null, that means we're called in response to a communications
1360 * event, and we'll have to get the response for ourselves.
1362 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1363 bend_search_rr *bsrt, int *fd)
1365 Z_SearchRequest *req = reqb->request->u.searchRequest;
1366 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1367 Z_SearchResponse *resp = (Z_SearchResponse *)
1368 odr_malloc (assoc->encode, sizeof(*resp));
1369 int *nulint = (int *)odr_malloc (assoc->encode, sizeof(*nulint));
1370 bool_t *sr = (bool_t *)odr_malloc (assoc->encode, sizeof(*sr));
1371 int *next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1372 int *none = (int *)odr_malloc (assoc->encode, sizeof(*none));
1379 apdu->which = Z_APDU_searchResponse;
1380 apdu->u.searchResponse = resp;
1381 resp->referenceId = req->referenceId;
1382 resp->additionalSearchInfo = 0;
1383 resp->otherInfo = 0;
1385 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1387 yaz_log(LOG_FATAL, "Bad result from backend");
1390 else if (bsrt->errcode)
1392 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1393 resp->resultCount = nulint;
1394 resp->numberOfRecordsReturned = nulint;
1395 resp->nextResultSetPosition = nulint;
1396 resp->searchStatus = nulint;
1397 resp->resultSetStatus = none;
1398 resp->presentStatus = 0;
1402 int *toget = (int *)odr_malloc (assoc->encode, sizeof(*toget));
1403 int *presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1404 Z_RecordComposition comp, *compp = 0;
1409 resp->resultCount = &bsrt->hits;
1411 comp.which = Z_RecordComp_simple;
1412 /* how many records does the user agent want, then? */
1413 if (bsrt->hits <= *req->smallSetUpperBound)
1415 *toget = bsrt->hits;
1416 if ((comp.u.simple = req->smallSetElementSetNames))
1419 else if (bsrt->hits < *req->largeSetLowerBound)
1421 *toget = *req->mediumSetPresentNumber;
1422 if (*toget > bsrt->hits)
1423 *toget = bsrt->hits;
1424 if ((comp.u.simple = req->mediumSetElementSetNames))
1430 if (*toget && !resp->records)
1435 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1436 prefformat->oclass != CLASS_RECSYN)
1439 form = prefformat->value;
1440 resp->records = pack_records(assoc, req->resultSetName, 1,
1441 toget, compp, next, presst, form, req->referenceId,
1442 req->preferredRecordSyntax);
1445 resp->numberOfRecordsReturned = toget;
1446 resp->nextResultSetPosition = next;
1447 resp->searchStatus = sr;
1448 resp->resultSetStatus = 0;
1449 resp->presentStatus = presst;
1453 if (*resp->resultCount)
1455 resp->numberOfRecordsReturned = nulint;
1456 resp->nextResultSetPosition = next;
1457 resp->searchStatus = sr;
1458 resp->resultSetStatus = 0;
1459 resp->presentStatus = 0;
1466 * Maybe we got a little over-friendly when we designed bend_fetch to
1467 * get only one record at a time. Some backends can optimise multiple-record
1468 * fetches, and at any rate, there is some overhead involved in
1469 * all that selecting and hopping around. Problem is, of course, that the
1470 * frontend can't know ahead of time how many records it'll need to
1471 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1472 * is downright lousy as a bulk data transfer protocol.
1474 * To start with, we'll do the fetching of records from the backend
1475 * in one operation: To save some trips in and out of the event-handler,
1476 * and to simplify the interface to pack_records. At any rate, asynch
1477 * operation is more fun in operations that have an unpredictable execution
1478 * speed - which is normally more true for search than for present.
1480 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1483 Z_PresentRequest *req = reqb->request->u.presentRequest;
1487 Z_PresentResponse *resp;
1492 yaz_log(LOG_LOG, "Got PresentRequest.");
1494 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1495 prefformat->oclass != CLASS_RECSYN)
1498 form = prefformat->value;
1499 if (assoc->init->bend_present)
1501 bend_present_rr *bprr = (bend_present_rr *)
1502 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1503 bprr->setname = req->resultSetId;
1504 bprr->start = *req->resultSetStartPoint;
1505 bprr->number = *req->numberOfRecordsRequested;
1506 bprr->format = form;
1507 bprr->comp = req->recordComposition;
1508 bprr->referenceId = req->referenceId;
1509 bprr->stream = assoc->encode;
1510 bprr->print = assoc->print;
1511 bprr->request = reqb;
1512 bprr->association = assoc;
1514 bprr->errstring = NULL;
1515 (*assoc->init->bend_present)(assoc->backend, bprr);
1520 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1521 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1522 presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1523 next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1524 num = (int *)odr_malloc (assoc->encode, sizeof(*num));
1527 *num = *req->numberOfRecordsRequested;
1529 apdu->which = Z_APDU_presentResponse;
1530 apdu->u.presentResponse = resp;
1531 resp->referenceId = req->referenceId;
1532 resp->otherInfo = 0;
1535 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1536 num, req->recordComposition, next, presst, form,
1537 req->referenceId, req->preferredRecordSyntax);
1540 resp->numberOfRecordsReturned = num;
1541 resp->presentStatus = presst;
1542 resp->nextResultSetPosition = next;
1548 static int bend_default_scan (void *handle, bend_scan_rr *rr)
1550 bend_scanrequest srq;
1551 bend_scanresult *srs;
1553 srq.num_bases = rr->num_bases;
1554 srq.basenames = rr->basenames;
1555 srq.attributeset = rr->attributeset;
1556 srq.referenceId = rr->referenceId;
1557 srq.term = rr->term;
1558 srq.term_position = rr->term_position;
1559 srq.num_entries = rr->num_entries;
1560 srq.stream = rr->stream;
1561 srq.print = rr->print;
1563 srs = bend_scan(handle, &srq, 0);
1565 rr->term_position = srs->term_position;
1566 rr->num_entries = srs->num_entries;
1567 rr->entries = srs->entries;
1568 rr->status = srs->status;
1569 rr->errcode = srs->errcode;
1570 rr->errstring = srs->errstring;
1576 * Scan was implemented rather in a hurry, and with support for only the basic
1577 * elements of the service in the backend API. Suggestions are welcome.
1579 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1581 Z_ScanRequest *req = reqb->request->u.scanRequest;
1582 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1583 Z_ScanResponse *res = (Z_ScanResponse *)
1584 odr_malloc (assoc->encode, sizeof(*res));
1585 int *scanStatus = (int *)
1586 odr_malloc (assoc->encode, sizeof(*scanStatus));
1587 int *numberOfEntriesReturned = (int *)
1588 odr_malloc (assoc->encode, sizeof(*numberOfEntriesReturned));
1589 Z_ListEntries *ents = (Z_ListEntries *)
1590 odr_malloc (assoc->encode, sizeof(*ents));
1591 Z_DiagRecs *diagrecs_p = NULL;
1595 yaz_log(LOG_LOG, "Got ScanRequest");
1596 *scanStatus = Z_Scan_failure;
1597 *numberOfEntriesReturned = 0;
1599 apdu->which = Z_APDU_scanResponse;
1600 apdu->u.scanResponse = res;
1601 res->referenceId = req->referenceId;
1603 res->scanStatus = scanStatus;
1604 res->numberOfEntriesReturned = numberOfEntriesReturned;
1605 res->positionOfTerm = 0;
1606 res->entries = ents;
1607 ents->num_entries = 0;
1608 ents->entries = NULL;
1609 ents->num_nonsurrogateDiagnostics = 0;
1610 ents->nonsurrogateDiagnostics = NULL;
1611 res->attributeSet = 0;
1614 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1615 attent->oclass != CLASS_ATTSET
1616 || attent->value != VAL_BIB1))
1617 diagrecs_p = diagrecs(assoc, 121, 0);
1618 else if (req->stepSize && *req->stepSize > 0)
1619 diagrecs_p = diagrecs(assoc, 205, 0);
1622 bend_scan_rr *bsrr = (bend_scan_rr *)
1623 odr_malloc (assoc->encode, sizeof(*bsrr));
1624 if (req->databaseNames)
1627 for (i = 0; i < req->num_databaseNames; i++)
1628 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1630 bsrr->num_bases = req->num_databaseNames;
1631 bsrr->basenames = req->databaseNames;
1632 bsrr->num_entries = *req->numberOfTermsRequested;
1633 bsrr->term = req->termListAndStartPoint;
1634 bsrr->referenceId = req->referenceId;
1635 bsrr->stream = assoc->encode;
1636 bsrr->print = assoc->print;
1637 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1638 attset->oclass != CLASS_RECSYN)
1639 bsrr->attributeset = VAL_NONE;
1641 bsrr->attributeset = attset->value;
1642 log_scan_term (req->termListAndStartPoint, attset->value);
1643 bsrr->term_position = req->preferredPositionInResponse ?
1644 *req->preferredPositionInResponse : 1;
1645 ((int (*)(void *, bend_scan_rr *))
1646 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1648 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1652 Z_Entry **tab = (Z_Entry **)
1653 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1655 if (bsrr->status == BEND_SCAN_PARTIAL)
1656 *scanStatus = Z_Scan_partial_5;
1658 *scanStatus = Z_Scan_success;
1659 ents->entries = tab;
1660 ents->num_entries = bsrr->num_entries;
1661 res->numberOfEntriesReturned = &ents->num_entries;
1662 res->positionOfTerm = &bsrr->term_position;
1663 for (i = 0; i < bsrr->num_entries; i++)
1669 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1670 if (bsrr->entries[i].occurrences >= 0)
1672 e->which = Z_Entry_termInfo;
1673 e->u.termInfo = t = (Z_TermInfo *)
1674 odr_malloc(assoc->encode, sizeof(*t));
1675 t->suggestedAttributes = 0;
1677 t->alternativeTerm = 0;
1678 t->byAttributes = 0;
1679 t->otherTermInfo = 0;
1680 t->globalOccurrences = &bsrr->entries[i].occurrences;
1681 t->term = (Z_Term *)
1682 odr_malloc(assoc->encode, sizeof(*t->term));
1683 t->term->which = Z_Term_general;
1684 t->term->u.general = o =
1685 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1686 o->buf = (unsigned char *)
1687 odr_malloc(assoc->encode, o->len = o->size =
1688 strlen(bsrr->entries[i].term));
1689 memcpy(o->buf, bsrr->entries[i].term, o->len);
1690 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1691 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1695 Z_DiagRecs *drecs = diagrecs (assoc,
1696 bsrr->entries[i].errcode,
1697 bsrr->entries[i].errstring);
1698 assert (drecs->num_diagRecs == 1);
1699 e->which = Z_Entry_surrogateDiagnostic;
1700 assert (drecs->diagRecs[0]);
1701 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1708 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1709 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1714 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1717 Z_SortRequest *req = reqb->request->u.sortRequest;
1718 Z_SortResponse *res = (Z_SortResponse *)
1719 odr_malloc (assoc->encode, sizeof(*res));
1720 bend_sort_rr *bsrr = (bend_sort_rr *)
1721 odr_malloc (assoc->encode, sizeof(*bsrr));
1723 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1725 yaz_log(LOG_LOG, "Got SortRequest.");
1728 bsrr->num_input_setnames = req->num_inputResultSetNames;
1729 bsrr->input_setnames = req->inputResultSetNames;
1731 bsrr->num_input_setnames = req->inputResultSetNames->num_strings;
1732 bsrr->input_setnames = req->inputResultSetNames->strings;
1734 bsrr->referenceId = req->referenceId;
1735 bsrr->output_setname = req->sortedResultSetName;
1736 bsrr->sort_sequence = req->sortSequence;
1737 bsrr->stream = assoc->encode;
1738 bsrr->print = assoc->print;
1740 bsrr->sort_status = Z_SortStatus_failure;
1742 bsrr->errstring = 0;
1744 (*assoc->init->bend_sort)(assoc->backend, bsrr);
1746 res->referenceId = bsrr->referenceId;
1747 res->sortStatus = (int *)
1748 odr_malloc (assoc->encode, sizeof(*res->sortStatus));
1749 *res->sortStatus = bsrr->sort_status;
1750 res->resultSetStatus = 0;
1753 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1755 res->diagnostics = dr->diagRecs;
1756 res->num_diagnostics = dr->num_diagRecs;
1758 res->diagnostics = dr;
1764 res->num_diagnostics = 0;
1766 res->diagnostics = 0;
1770 apdu->which = Z_APDU_sortResponse;
1771 apdu->u.sortResponse = res;
1775 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1778 Z_DeleteResultSetRequest *req = reqb->request->u.deleteResultSetRequest;
1779 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1780 odr_malloc (assoc->encode, sizeof(*res));
1781 bend_delete_rr *bdrr = (bend_delete_rr *)
1782 odr_malloc (assoc->encode, sizeof(*bdrr));
1783 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1785 yaz_log(LOG_LOG, "Got DeleteRequest.");
1787 bdrr->num_setnames = req->num_resultSetList;
1788 bdrr->setnames = req->resultSetList;
1789 bdrr->stream = assoc->encode;
1790 bdrr->print = assoc->print;
1791 bdrr->function = *req->deleteFunction;
1792 bdrr->referenceId = req->referenceId;
1794 if (bdrr->num_setnames > 0)
1797 bdrr->statuses = odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1798 bdrr->num_setnames);
1799 for (i = 0; i < bdrr->num_setnames; i++)
1800 bdrr->statuses[i] = 0;
1802 (*assoc->init->bend_delete)(assoc->backend, bdrr);
1804 res->referenceId = req->referenceId;
1806 res->deleteOperationStatus = (int *)
1807 odr_malloc (assoc->encode, sizeof(*res->deleteOperationStatus));
1808 *res->deleteOperationStatus = bdrr->delete_status;
1810 res->deleteListStatuses = 0;
1811 if (bdrr->num_setnames > 0)
1814 res->deleteListStatuses = odr_malloc(assoc->encode,
1815 sizeof(*res->deleteListStatuses));
1816 res->deleteListStatuses->num = bdrr->num_setnames;
1817 res->deleteListStatuses->elements =
1818 odr_malloc (assoc->encode,
1819 sizeof(*res->deleteListStatuses->elements) *
1820 bdrr->num_setnames);
1821 for (i = 0; i<bdrr->num_setnames; i++)
1823 res->deleteListStatuses->elements[i] =
1824 odr_malloc (assoc->encode,
1825 sizeof(**res->deleteListStatuses->elements));
1826 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1827 res->deleteListStatuses->elements[i]->id =
1828 odr_strdup (assoc->encode, bdrr->setnames[i]);
1832 res->numberNotDeleted = 0;
1833 res->bulkStatuses = 0;
1834 res->deleteMessage = 0;
1837 apdu->which = Z_APDU_deleteResultSetResponse;
1838 apdu->u.deleteResultSetResponse = res;
1842 static void process_close(association *assoc, request *reqb)
1844 Z_Close *req = reqb->request->u.close;
1845 static char *reasons[] =
1852 "securityViolation",
1859 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1860 reasons[*req->closeReason], req->diagnosticInformation ?
1861 req->diagnosticInformation : "NULL");
1862 if (assoc->version < 3) /* to make do_force respond with close */
1864 do_close_req(assoc, Z_Close_finished,
1865 "Association terminated by client", reqb);
1868 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1872 reqb->len_refid = refid->len;
1873 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1874 memcpy (reqb->refid, refid->buf, refid->len);
1878 reqb->len_refid = 0;
1883 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1885 process_response (a, req, res);
1888 bend_request bend_request_mk (bend_association a)
1890 request *nreq = request_get (&a->outgoing);
1891 nreq->request_mem = nmem_create ();
1895 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1900 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1901 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1902 id->len = id->size = req->len_refid;
1903 memcpy (id->buf, req->refid, req->len_refid);
1907 void bend_request_destroy (bend_request *req)
1909 nmem_destroy((*req)->request_mem);
1910 request_release(*req);
1914 int bend_backend_respond (bend_association a, bend_request req)
1918 r = process_request (a, req, &msg);
1920 logf (LOG_WARN, "%s", msg);
1924 void bend_request_setdata(bend_request r, void *p)
1929 void *bend_request_getdata(bend_request r)
1931 return r->clientData;
1934 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
1936 bend_segment_rr request;
1938 request.segment = reqb->request->u.segmentRequest;
1939 request.stream = assoc->encode;
1940 request.decode = assoc->decode;
1941 request.print = assoc->print;
1942 request.association = assoc;
1944 (*assoc->init->bend_segment)(assoc->backend, &request);
1949 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
1951 bend_esrequest_rr esrequest;
1953 Z_ExtendedServicesRequest *req = reqb->request->u.extendedServicesRequest;
1954 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
1956 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
1958 yaz_log(LOG_DEBUG,"inside Process esRequest");
1960 esrequest.esr = reqb->request->u.extendedServicesRequest;
1961 esrequest.stream = assoc->encode;
1962 esrequest.decode = assoc->decode;
1963 esrequest.print = assoc->print;
1964 esrequest.errcode = 0;
1965 esrequest.errstring = NULL;
1966 esrequest.request = reqb;
1967 esrequest.association = assoc;
1968 esrequest.referenceId = req->referenceId;
1970 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
1972 /* If the response is being delayed, return NULL */
1973 if (esrequest.request == NULL)
1976 resp->referenceId = req->referenceId;
1978 if (esrequest.errcode == -1)
1980 /* Backend service indicates request will be processed */
1981 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
1982 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
1984 else if (esrequest.errcode == 0)
1986 /* Backend service indicates request will be processed */
1987 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
1988 *resp->operationStatus = Z_ExtendedServicesResponse_done;
1992 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
1993 esrequest.errstring);
1995 /* Backend indicates error, request will not be processed */
1996 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
1997 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
1998 resp->num_diagnostics = diagRecs->num_diagRecs;
1999 resp->diagnostics = diagRecs->diagRecs;
2001 /* Do something with the members of bend_extendedservice */
2003 yaz_log(LOG_DEBUG,"Send the result apdu");