2 * Copyright (c) 1995-2000, Index Data
3 * See the file LICENSE for details.
6 * Revision 1.106 2000-08-31 09:51:25 adam
7 * Added record_syntax member for fetch method (raw OID).
9 * Revision 1.105 2000/07/06 10:38:47 adam
10 * Enhanced option --enable-tcpd.
12 * Revision 1.104 2000/04/05 07:39:55 adam
13 * Added shared library support (libtool).
15 * Revision 1.103 2000/03/20 19:06:25 adam
16 * Added Segment request for fronend server. Work on admin for client.
18 * Revision 1.102 2000/03/15 12:59:49 adam
19 * Added handle member to statserv_control.
21 * Revision 1.101 2000/01/12 14:36:07 adam
22 * Added printing stream (ODR) for backend functions.
24 * Revision 1.100 1999/12/16 23:36:19 adam
25 * Implemented ILL protocol. Minor updates ASN.1 compiler.
27 * Revision 1.99 1999/11/30 13:47:12 adam
28 * Improved installation. Moved header files to include/yaz.
30 * Revision 1.98 1999/11/29 15:12:27 adam
31 * Changed the way implementationName - and version is set.
33 * Revision 1.96 1999/11/04 14:58:44 adam
34 * Added status elements for backend delete result set handler.
35 * Updated delete result result set command for client.
37 * Revision 1.95 1999/10/11 10:01:24 adam
38 * Implemented bend_sort_rr handler for frontend server.
40 * Revision 1.94 1999/08/27 09:40:32 adam
41 * Renamed logf function to yaz_log. Removed VC++ project files.
43 * Revision 1.93 1999/07/06 12:17:15 adam
44 * Added option -1 that runs server once (for profiling purposes).
46 * Revision 1.92 1999/06/17 10:54:45 adam
47 * Added facility to specify implementation version - and name
50 * Revision 1.91 1999/06/01 14:29:12 adam
51 * Work on Extended Services.
53 * Revision 1.90 1999/05/27 13:02:20 adam
54 * Assigned OID for old DB Update (VAL_DBUPDATE0).
56 * Revision 1.89 1999/05/26 15:24:26 adam
57 * Fixed minor bugs regarding DB Update (introduced by previous commit).
59 * Revision 1.88 1999/04/20 09:56:48 adam
60 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
61 * Modified all encoders/decoders to reflect this change.
63 * Revision 1.87 1999/03/31 11:18:25 adam
64 * Implemented odr_strdup. Added Reference ID to backend server API.
66 * Revision 1.86 1999/02/02 13:57:38 adam
67 * Uses preprocessor define WIN32 instead of WINDOWS to build code
68 * for Microsoft WIN32.
70 * Revision 1.85 1998/11/17 09:52:59 adam
71 * Fixed minor bug (introduced by previous commit).
73 * Revision 1.84 1998/11/16 16:02:32 adam
74 * Added loggin utilies, log_rpn_query and log_scan_term. These used
75 * to be part of Zebra.
77 * Revision 1.83 1998/11/03 10:09:36 adam
78 * Fixed bug regarding YC.
80 * Revision 1.82 1998/10/20 14:00:30 quinn
83 * Revision 1.81 1998/10/13 16:12:24 adam
84 * Added support for Surrogate Diagnostics for Scan Term entries.
86 * Revision 1.80 1998/09/02 12:41:53 adam
87 * Added decode stream in bend search structures.
89 * Revision 1.79 1998/08/19 16:10:08 adam
90 * Changed som member names of DeleteResultSetRequest/Response.
92 * Revision 1.78 1998/08/03 10:23:55 adam
93 * Fixed bug regarding Options for Sort.
95 * Revision 1.77 1998/07/20 12:38:42 adam
96 * Implemented delete result set service to server API.
98 * Revision 1.76 1998/05/27 16:57:07 adam
99 * Support for surrogate diagnostic records added for bend_fetch.
101 * Revision 1.75 1998/05/18 10:13:07 adam
102 * Fixed call to es_request handler - extra argument was passed.
104 * Revision 1.74 1998/03/31 15:13:20 adam
105 * Development towards compiled ASN.1.
107 * Revision 1.73 1998/03/31 11:07:45 adam
108 * Furhter work on UNIverse resource report.
109 * Added Extended Services handling in frontend server.
111 * Revision 1.72 1998/02/11 11:53:35 adam
112 * Changed code so that it compiles as C++.
114 * Revision 1.71 1998/02/10 11:03:57 adam
115 * Added support for extended handlers in backend server interface.
117 * Revision 1.70 1998/01/29 13:15:35 adam
118 * Implemented sort for the backend interface.
120 * Revision 1.69 1997/09/30 11:48:12 adam
121 * Fixed bug introduced by previous commit.
123 * Revision 1.68 1997/09/29 13:18:59 adam
124 * Added function, oid_ent_to_oid, to replace the function
125 * oid_getoidbyent, which is not thread safe.
127 * Revision 1.67 1997/09/17 12:10:40 adam
130 * Revision 1.66 1997/09/05 15:26:44 adam
131 * Added ODR encode in search and scen bend request structures.
132 * Fixed a few enums that caused trouble with C++.
134 * Revision 1.65 1997/09/01 08:53:01 adam
135 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
136 * moved a separate directory. MSV5.0 project server.dsp created.
137 * As an option, the server can now operate as an NT service.
139 * Revision 1.64 1997/04/30 08:52:11 quinn
142 * Revision 1.63 1996/10/11 11:57:26 quinn
145 * Revision 1.62 1996/07/06 19:58:35 quinn
146 * System headerfiles gathered in yconfig
148 * Revision 1.61 1996/06/10 08:56:16 quinn
151 * Revision 1.60 1996/05/30 11:03:10 quinn
152 * Fixed NextresultSetPosition bug fixed.
154 * Revision 1.59 1996/05/14 09:26:46 quinn
155 * Added attribute set to scan backend
157 * Revision 1.58 1996/02/20 12:53:04 quinn
160 * Revision 1.57 1996/01/02 08:57:47 quinn
161 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
163 * Revision 1.56 1995/12/14 11:09:57 quinn
166 * Revision 1.55 1995/11/08 17:41:37 quinn
169 * Revision 1.54 1995/11/08 15:11:29 quinn
170 * Log of close transmit.
172 * Revision 1.53 1995/11/01 13:54:58 quinn
175 * Revision 1.52 1995/11/01 12:19:13 quinn
176 * Second attempt to fix same bug.
178 * Revision 1.50 1995/10/25 16:58:32 quinn
181 * Revision 1.49 1995/10/16 13:51:53 quinn
182 * Changes to provide Especs to the backend.
184 * Revision 1.48 1995/10/06 08:51:20 quinn
185 * Added Write-buffer.
187 * Revision 1.47 1995/08/29 14:24:16 quinn
188 * Added second half of close-handshake
190 * Revision 1.46 1995/08/29 11:17:58 quinn
191 * Added code to receive close
193 * Revision 1.45 1995/08/21 09:11:00 quinn
194 * Smallish fixes to suppport new formats.
196 * Revision 1.44 1995/08/17 12:45:25 quinn
197 * Fixed minor problems with GRS-1. Added support in c&s.
199 * Revision 1.43 1995/08/15 12:00:31 quinn
202 * Revision 1.42 1995/08/15 11:16:50 quinn
204 * Revision 1.41 1995/08/02 10:23:06 quinn
207 * Revision 1.40 1995/07/31 14:34:26 quinn
208 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
210 * Revision 1.39 1995/06/27 13:21:00 quinn
213 * Revision 1.38 1995/06/19 12:39:11 quinn
214 * Fixed bug in timeout code. Added BER dumper.
216 * Revision 1.37 1995/06/16 13:16:14 quinn
217 * Fixed Defaultdiagformat.
219 * Revision 1.36 1995/06/16 10:31:36 quinn
220 * Added session timeout.
222 * Revision 1.35 1995/06/15 07:45:14 quinn
225 * Revision 1.34 1995/06/14 15:26:46 quinn
226 * *** empty log message ***
228 * Revision 1.33 1995/06/06 14:57:05 quinn
229 * Better diagnostics.
231 * Revision 1.32 1995/06/06 08:41:44 quinn
232 * Better diagnostics.
234 * Revision 1.31 1995/06/06 08:15:37 quinn
237 * Revision 1.30 1995/06/05 10:53:32 quinn
238 * Added a better SCAN.
240 * Revision 1.29 1995/06/01 11:25:03 quinn
243 * Revision 1.28 1995/06/01 11:21:01 quinn
244 * Attempting to fix a bug in pack-records. replaced break with continue
245 * for large records, according to standard.
247 * Revision 1.27 1995/05/29 08:12:06 quinn
250 * Revision 1.26 1995/05/18 13:02:12 quinn
253 * Revision 1.25 1995/05/17 08:42:26 quinn
254 * Transfer auth info to backend. Allow backend to reject init gracefully.
256 * Revision 1.24 1995/05/16 08:51:04 quinn
257 * License, documentation, and memory fixes
259 * Revision 1.23 1995/05/15 13:25:10 quinn
262 * Revision 1.22 1995/05/15 11:56:39 quinn
263 * Asynchronous facilities. Restructuring of seshigh code.
265 * Revision 1.21 1995/05/02 08:53:19 quinn
266 * Trying in vain to fix comm with ISODE
268 * Revision 1.20 1995/04/20 15:13:00 quinn
271 * Revision 1.19 1995/04/18 08:15:34 quinn
272 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
273 * neater. We'll make the same change for decoding one day.
275 * Revision 1.18 1995/04/17 11:28:25 quinn
278 * Revision 1.17 1995/04/10 10:23:36 quinn
279 * Some work to add scan and other things.
281 * Revision 1.16 1995/03/31 09:18:55 quinn
284 * Revision 1.15 1995/03/30 14:03:23 quinn
285 * Added RFC1006 as separate library
287 * Revision 1.14 1995/03/30 12:18:17 quinn
290 * Revision 1.13 1995/03/30 09:09:24 quinn
291 * Added state-handle and some support for asynchronous activities.
293 * Revision 1.12 1995/03/29 15:40:16 quinn
294 * Ongoing work. Statserv is now dynamic by default
296 * Revision 1.11 1995/03/28 09:16:21 quinn
297 * Added record packing to the search request
299 * Revision 1.10 1995/03/27 08:34:24 quinn
300 * Added dynamic server functionality.
301 * Released bindings to session.c (is now redundant)
303 * Revision 1.9 1995/03/22 15:01:26 quinn
304 * Adjusting record packing.
306 * Revision 1.8 1995/03/22 10:13:21 quinn
307 * Working on record packer
309 * Revision 1.7 1995/03/21 15:53:31 quinn
312 * Revision 1.6 1995/03/21 12:30:09 quinn
313 * Beginning to add support for record packing.
315 * Revision 1.5 1995/03/17 10:44:13 quinn
316 * Added catch of null-string in makediagrec
318 * Revision 1.4 1995/03/17 10:18:08 quinn
319 * Added memory management.
321 * Revision 1.3 1995/03/16 17:42:39 quinn
324 * Revision 1.2 1995/03/16 13:29:01 quinn
325 * Partitioned server.
327 * Revision 1.1 1995/03/15 16:02:10 quinn
328 * Modded session.c to seshigh.c
333 * Frontend server logic.
335 * This code receives incoming APDUs, and handles client requests by means
336 * of the backend API.
338 * Some of the code is getting quite involved, compared to simpler servers -
339 * primarily because it is asynchronous both in the communication with
340 * the user and the backend. We think the complexity will pay off in
341 * the form of greater flexibility when more asynchronous facilities
344 * Memory management has become somewhat involved. In the simple case, where
345 * only one PDU is pending at a time, it will simply reuse the same memory,
346 * once it has found its working size. When we enable multiple concurrent
347 * operations, perhaps even with multiple parallel calls to the backend, it
348 * will maintain a pool of buffers for encoding and decoding, trying to
349 * minimize memory allocation/deallocation during normal operation.
351 * TODOs include (and will be done in order of public interest):
353 * Support for EXPLAIN - provide simple meta-database system.
354 * Support for access control.
355 * Support for resource control.
356 * Support for extended services - primarily Item Order.
357 * Rest of Z39.50-1994
370 #include <yaz/yconfig.h>
371 #include <yaz/xmalloc.h>
372 #include <yaz/comstack.h>
375 #include <yaz/proto.h>
378 #include <yaz/logrpn.h>
379 #include <yaz/statserv.h>
381 #include <yaz/backend.h>
383 static int process_request(association *assoc, request *req, char **msg);
384 void backend_response(IOCHAN i, int event);
385 static int process_response(association *assoc, request *req, Z_APDU *res);
386 static Z_APDU *process_initRequest(association *assoc, request *reqb);
387 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
389 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
390 bend_search_rr *bsrr, int *fd);
391 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
393 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
394 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
395 static void process_close(association *assoc, request *reqb);
396 void save_referenceId (request *reqb, Z_ReferenceId *refid);
397 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
399 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
401 static FILE *apduf = 0; /* for use in static mode */
402 static statserv_options_block *control_block = 0;
404 /* Chas: Added in from DALI */
405 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
406 /* Chas: End of addition from DALI */
409 * Create and initialize a new association-handle.
410 * channel : iochannel for the current line.
411 * link : communications channel.
412 * Returns: 0 or a new association handle.
414 association *create_association(IOCHAN channel, COMSTACK link)
419 control_block = statserv_getcontrol();
420 if (!(anew = (association *)xmalloc(sizeof(*anew))))
423 anew->client_chan = channel;
424 anew->client_link = link;
425 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
426 !(anew->encode = odr_createmem(ODR_ENCODE)))
428 if (*control_block->apdufile)
433 strcpy(filename, control_block->apdufile);
434 if (!(anew->print = odr_createmem(ODR_PRINT)))
436 if (*control_block->apdufile != '-')
438 strcpy(filename, control_block->apdufile);
439 if (!control_block->dynamic)
443 if (!(apduf = fopen(filename, "w")))
445 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
448 setvbuf(apduf, 0, _IONBF, 0);
454 sprintf(filename + strlen(filename), ".%d", getpid());
455 if (!(f = fopen(filename, "w")))
457 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
460 setvbuf(f, 0, _IONBF, 0);
462 odr_setprint(anew->print, f);
467 anew->input_buffer = 0;
468 anew->input_buffer_len = 0;
470 anew->state = ASSOC_NEW;
471 request_initq(&anew->incoming);
472 request_initq(&anew->outgoing);
473 anew->proto = cs_getproto(link);
478 * Free association and release resources.
480 void destroy_association(association *h)
482 statserv_options_block *cb = statserv_getcontrol();
485 odr_destroy(h->decode);
486 odr_destroy(h->encode);
488 odr_destroy(h->print);
490 xfree(h->input_buffer);
492 (*cb->bend_close)(h->backend);
493 while (request_deq(&h->incoming));
494 while (request_deq(&h->outgoing));
495 request_delq(&h->incoming);
496 request_delq(&h->outgoing);
498 if (control_block && control_block->one_shot)
502 static void do_close_req(association *a, int reason, char *message,
506 Z_Close *cls = zget_Close(a->encode);
508 /* Purge request queue */
509 while (request_deq(&a->incoming));
510 while (request_deq(&a->outgoing));
513 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
514 reason, message ? message : "none");
515 apdu.which = Z_APDU_close;
517 *cls->closeReason = reason;
518 cls->diagnosticInformation = message;
519 process_response(a, req, &apdu);
520 iochan_settimeout(a->client_chan, 60);
524 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
525 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
527 a->state = ASSOC_DEAD;
530 static void do_close(association *a, int reason, char *message)
532 do_close_req (a, reason, message, request_get(&a->outgoing));
536 * This is where PDUs from the client are read and the further
537 * processing is initiated. Flow of control moves down through the
538 * various process_* functions below, until the encoded result comes back up
539 * to the output handler in here.
541 * h : the I/O channel that has an outstanding event.
542 * event : the current outstanding event.
544 void ir_session(IOCHAN h, int event)
547 association *assoc = (association *)iochan_getdata(h);
548 COMSTACK conn = assoc->client_link;
551 assert(h && conn && assoc);
552 if (event == EVENT_TIMEOUT)
554 if (assoc->state != ASSOC_UP)
556 yaz_log(LOG_LOG, "Final timeout - closing connection.");
558 destroy_association(assoc);
563 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
564 do_close(assoc, Z_Close_lackOfActivity, 0);
568 if (event & EVENT_INPUT || event & EVENT_WORK) /* input */
570 if (event & EVENT_INPUT)
572 yaz_log(LOG_DEBUG, "ir_session (input)");
573 assert(assoc && conn);
574 /* We aren't speaking to this fellow */
575 if (assoc->state == ASSOC_DEAD)
577 yaz_log(LOG_LOG, "Closed connection after reject");
579 destroy_association(assoc);
583 if ((res = cs_get(conn, &assoc->input_buffer,
584 &assoc->input_buffer_len)) <= 0)
586 yaz_log(LOG_LOG, "Connection closed by client");
588 destroy_association(assoc);
592 else if (res == 1) /* incomplete read - wait for more */
594 if (cs_more(conn)) /* more stuff - call us again later, please */
595 iochan_setevent(h, EVENT_INPUT);
597 /* we got a complete PDU. Let's decode it */
598 yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
599 req = request_get(&assoc->incoming); /* get a new request structure */
600 odr_reset(assoc->decode);
601 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
602 if (!z_APDU(assoc->decode, &req->request, 0, 0))
604 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
605 odr_errmsg(odr_geterror(assoc->decode)),
606 odr_offset(assoc->decode));
607 yaz_log(LOG_LOG, "PDU dump:");
608 odr_dumpBER(log_file(), assoc->input_buffer, res);
609 do_close(assoc, Z_Close_protocolError, "Malformed package");
612 req->request_mem = odr_extract_mem(assoc->decode);
613 if (assoc->print && !z_APDU(assoc->print, &req->request, 0, 0))
615 yaz_log(LOG_WARN, "ODR print error: %s",
616 odr_errmsg(odr_geterror(assoc->print)));
617 odr_reset(assoc->print);
619 request_enq(&assoc->incoming, req);
622 /* can we do something yet? */
623 req = request_head(&assoc->incoming);
624 if (req->state == REQUEST_IDLE)
627 request_deq(&assoc->incoming);
628 if (process_request(assoc, req, &msg) < 0)
629 do_close_req(assoc, Z_Close_systemProblem, msg, req);
632 if (event & EVENT_OUTPUT)
634 request *req = request_head(&assoc->outgoing);
636 yaz_log(LOG_DEBUG, "ir_session (output)");
637 req->state = REQUEST_PENDING;
638 switch (res = cs_put(conn, req->response, req->len_response))
641 yaz_log(LOG_LOG, "Connection closed by client");
643 destroy_association(assoc);
646 case 0: /* all sent - release the request structure */
647 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
648 nmem_destroy(req->request_mem);
649 request_deq(&assoc->outgoing);
650 request_release(req);
651 if (!request_head(&assoc->outgoing))
652 iochan_clearflag(h, EVENT_OUTPUT);
654 /* value of 1 -- partial send -- is simply ignored */
657 if (event & EVENT_EXCEPT)
659 yaz_log(LOG_DEBUG, "ir_session (exception)");
661 destroy_association(assoc);
667 * Initiate request processing.
669 static int process_request(association *assoc, request *req, char **msg)
675 *msg = "Unknown Error";
676 assert(req && req->state == REQUEST_IDLE);
677 if (req->request->which != Z_APDU_initRequest && !assoc->init)
679 *msg = "Missing InitRequest";
682 switch (req->request->which)
684 case Z_APDU_initRequest:
685 res = process_initRequest(assoc, req); break;
686 case Z_APDU_searchRequest:
687 res = process_searchRequest(assoc, req, &fd); break;
688 case Z_APDU_presentRequest:
689 res = process_presentRequest(assoc, req, &fd); break;
690 case Z_APDU_scanRequest:
691 if (assoc->init->bend_scan)
692 res = process_scanRequest(assoc, req, &fd);
695 *msg = "Cannot handle Scan APDU";
699 case Z_APDU_extendedServicesRequest:
700 if (assoc->init->bend_esrequest)
701 res = process_ESRequest(assoc, req, &fd);
704 *msg = "Cannot handle Extended Services APDU";
708 case Z_APDU_sortRequest:
709 if (assoc->init->bend_sort)
710 res = process_sortRequest(assoc, req, &fd);
713 *msg = "Cannot handle Sort APDU";
718 process_close(assoc, req);
720 case Z_APDU_deleteResultSetRequest:
721 if (assoc->init->bend_delete)
722 res = process_deleteRequest(assoc, req, &fd);
725 *msg = "Cannot handle Delete APDU";
729 case Z_APDU_segmentRequest:
730 if (assoc->init->bend_segment)
732 res = process_segmentRequest (assoc, req);
736 *msg = "Cannot handle Segment APDU";
741 *msg = "Bad APDU received";
746 yaz_log(LOG_DEBUG, " result immediately available");
747 retval = process_response(assoc, req, res);
751 yaz_log(LOG_DEBUG, " result unavailble");
754 else /* no result yet - one will be provided later */
758 /* Set up an I/O handler for the fd supplied by the backend */
760 yaz_log(LOG_DEBUG, " establishing handler for result");
761 req->state = REQUEST_PENDING;
762 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
764 iochan_setdata(chan, assoc);
771 * Handle message from the backend.
773 void backend_response(IOCHAN i, int event)
775 association *assoc = (association *)iochan_getdata(i);
776 request *req = request_head(&assoc->incoming);
780 yaz_log(LOG_DEBUG, "backend_response");
781 assert(assoc && req && req->state != REQUEST_IDLE);
782 /* determine what it is we're waiting for */
783 switch (req->request->which)
785 case Z_APDU_searchRequest:
786 res = response_searchRequest(assoc, req, 0, &fd); break;
788 case Z_APDU_presentRequest:
789 res = response_presentRequest(assoc, req, 0, &fd); break;
790 case Z_APDU_scanRequest:
791 res = response_scanRequest(assoc, req, 0, &fd); break;
794 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
797 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
799 yaz_log(LOG_LOG, "Fatal error when talking to backend");
800 do_close(assoc, Z_Close_systemProblem, 0);
804 else if (!res) /* no result yet - try again later */
806 yaz_log(LOG_DEBUG, " no result yet");
807 iochan_setfd(i, fd); /* in case fd has changed */
812 * Encode response, and transfer the request structure to the outgoing queue.
814 static int process_response(association *assoc, request *req, Z_APDU *res)
816 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
817 if (!z_APDU(assoc->encode, &res, 0, 0))
819 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
820 odr_errmsg(odr_geterror(assoc->decode)));
821 odr_reset(assoc->encode);
824 req->response = odr_getbuf(assoc->encode, &req->len_response,
825 &req->size_response);
826 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
827 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
829 yaz_log(LOG_WARN, "ODR print error: %s",
830 odr_errmsg(odr_geterror(assoc->print)));
831 odr_reset(assoc->print);
833 odr_reset(assoc->encode);
834 req->state = REQUEST_IDLE;
835 request_enq(&assoc->outgoing, req);
836 /* turn the work over to the ir_session handler */
837 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
838 /* Is there more work to be done? give that to the input handler too */
840 if (request_head(&assoc->incoming))
842 yaz_log (LOG_DEBUG, "more work to be done");
843 iochan_setevent(assoc->client_chan, EVENT_WORK);
850 * Handle init request.
851 * At the moment, we don't check the options
852 * anywhere else in the code - we just try not to do anything that would
853 * break a naive client. We'll toss 'em into the association block when
854 * we need them there.
856 static Z_APDU *process_initRequest(association *assoc, request *reqb)
858 statserv_options_block *cb = statserv_getcontrol();
859 Z_InitRequest *req = reqb->request->u.initRequest;
860 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
861 Z_InitResponse *resp = apdu->u.initResponse;
862 bend_initresult *binitres;
866 assoc->init = xmalloc (sizeof(*assoc->init));
868 yaz_log(LOG_LOG, "Got initRequest");
869 if (req->implementationId)
870 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
871 if (req->implementationName)
872 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
873 if (req->implementationVersion)
874 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
876 assoc->init->stream = assoc->encode;
877 assoc->init->print = assoc->print;
878 assoc->init->auth = req->idAuthentication;
879 assoc->init->referenceId = req->referenceId;
880 assoc->init->implementation_version = 0;
881 assoc->init->implementation_name = 0;
882 assoc->init->bend_sort = NULL;
883 assoc->init->bend_search = NULL;
884 assoc->init->bend_present = NULL;
885 assoc->init->bend_esrequest = NULL;
886 assoc->init->bend_delete = NULL;
887 assoc->init->bend_scan = NULL;
888 assoc->init->bend_segment = NULL;
889 assoc->init->bend_fetch = NULL;
890 if (!(binitres = (*cb->bend_init)(assoc->init)))
892 yaz_log(LOG_WARN, "Bad response from backend.");
896 assoc->backend = binitres->handle;
897 if ((assoc->init->bend_sort))
898 yaz_log (LOG_DEBUG, "Sort handler installed");
899 if ((assoc->init->bend_search))
900 yaz_log (LOG_DEBUG, "Search handler installed");
901 if ((assoc->init->bend_present))
902 yaz_log (LOG_DEBUG, "Present handler installed");
903 if ((assoc->init->bend_esrequest))
904 yaz_log (LOG_DEBUG, "ESRequest handler installed");
905 if ((assoc->init->bend_delete))
906 yaz_log (LOG_DEBUG, "Delete handler installed");
907 if ((assoc->init->bend_scan))
908 yaz_log (LOG_DEBUG, "Scan handler installed");
909 if ((assoc->init->bend_segment))
910 yaz_log (LOG_DEBUG, "Segment handler installed");
912 resp->referenceId = req->referenceId;
914 /* let's tell the client what we can do */
915 if (ODR_MASK_GET(req->options, Z_Options_search))
917 ODR_MASK_SET(resp->options, Z_Options_search);
918 strcat(options, "srch");
920 if (ODR_MASK_GET(req->options, Z_Options_present))
922 ODR_MASK_SET(resp->options, Z_Options_present);
923 strcat(options, " prst");
925 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
926 assoc->init->bend_delete)
928 ODR_MASK_SET(resp->options, Z_Options_delSet);
929 strcat(options, " del");
931 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
932 assoc->init->bend_esrequest)
934 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
935 strcat (options, " extendedServices");
937 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
939 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
940 strcat(options, " namedresults");
942 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
944 ODR_MASK_SET(resp->options, Z_Options_scan);
945 strcat(options, " scan");
947 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
949 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
950 strcat(options, " concurop");
952 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
954 ODR_MASK_SET(resp->options, Z_Options_sort);
955 strcat(options, " sort");
957 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
959 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
960 assoc->version = 2; /* 1 & 2 are equivalent */
962 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
964 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
967 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
969 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
972 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
973 assoc->maximumRecordSize = *req->maximumRecordSize;
974 if (assoc->maximumRecordSize > control_block->maxrecordsize)
975 assoc->maximumRecordSize = control_block->maxrecordsize;
976 assoc->preferredMessageSize = *req->preferredMessageSize;
977 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
978 assoc->preferredMessageSize = assoc->maximumRecordSize;
979 resp->preferredMessageSize = &assoc->preferredMessageSize;
980 resp->maximumRecordSize = &assoc->maximumRecordSize;
982 resp->implementationName = "GFS";
984 if (assoc->init->implementation_name)
987 odr_malloc (assoc->encode,
988 strlen(assoc->init->implementation_name) + 10 +
989 strlen(resp->implementationName));
990 sprintf (nv, "%s / %s",
991 resp->implementationName, assoc->init->implementation_name);
992 resp->implementationName = nv;
994 if (assoc->init->implementation_version)
997 odr_malloc (assoc->encode,
998 strlen(assoc->init->implementation_version) + 10 +
999 strlen(resp->implementationVersion));
1000 sprintf (nv, "YAZ %s / %s",
1001 resp->implementationVersion,
1002 assoc->init->implementation_version);
1003 resp->implementationVersion = nv;
1006 if (binitres->errcode)
1008 yaz_log(LOG_LOG, "Connection rejected by backend.");
1010 assoc->state = ASSOC_DEAD;
1013 assoc->state = ASSOC_UP;
1018 * These functions should be merged.
1021 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo)
1024 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1025 dr->u.v2Addinfo = addinfo ? addinfo : "";
1027 dr->which = Z_DiagForm_v2AddInfo;
1028 dr->addinfo = addinfo ? addinfo : "";
1033 * nonsurrogate diagnostic record.
1035 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
1038 Z_Records *rec = (Z_Records *)
1039 odr_malloc (assoc->encode, sizeof(*rec));
1042 odr_malloc (assoc->encode, sizeof(*err));
1043 Z_DiagRec *drec = (Z_DiagRec *)
1044 odr_malloc (assoc->encode, sizeof(*drec));
1045 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1046 odr_malloc (assoc->encode, sizeof(*dr));
1048 bib1.proto = assoc->proto;
1049 bib1.oclass = CLASS_DIAGSET;
1050 bib1.value = VAL_BIB1;
1052 yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
1055 rec->which = Z_Records_NSD;
1057 rec->u.nonSurrogateDiagnostic = dr;
1059 rec->u.nonSurrogateDiagnostic = drec;
1060 drec->which = Z_DiagRec_defaultFormat;
1061 drec->u.defaultFormat = dr;
1063 dr->diagnosticSetId =
1064 odr_oiddup (assoc->encode, oid_ent_to_oid(&bib1, oid));
1065 dr->condition = err;
1066 set_addinfo (dr, addinfo);
1071 * surrogate diagnostic.
1073 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1074 int error, char *addinfo)
1077 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1078 odr_malloc (assoc->encode, sizeof(*rec));
1079 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1081 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1082 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1083 odr_malloc (assoc->encode, sizeof(*dr));
1085 bib1.proto = assoc->proto;
1086 bib1.oclass = CLASS_DIAGSET;
1087 bib1.value = VAL_BIB1;
1089 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1091 rec->databaseName = dbname;
1092 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1093 rec->u.surrogateDiagnostic = drec;
1094 drec->which = Z_DiagRec_defaultFormat;
1095 drec->u.defaultFormat = dr;
1096 dr->diagnosticSetId = odr_oiddup (assoc->encode,
1097 oid_ent_to_oid(&bib1, oid));
1098 dr->condition = err;
1099 set_addinfo (dr, addinfo);
1105 * multiple nonsurrogate diagnostics.
1107 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1110 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1111 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1113 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1114 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1115 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)odr_malloc (assoc->encode, sizeof(*rec));
1117 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1118 bib1.proto = assoc->proto;
1119 bib1.oclass = CLASS_DIAGSET;
1120 bib1.value = VAL_BIB1;
1123 recs->num_diagRecs = 1;
1124 recs->diagRecs = recp;
1126 drec->which = Z_DiagRec_defaultFormat;
1127 drec->u.defaultFormat = rec;
1129 rec->diagnosticSetId = odr_oiddup (assoc->encode,
1130 oid_ent_to_oid(&bib1, oid));
1131 rec->condition = err;
1134 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1135 rec->u.v2Addinfo = addinfo ? addinfo : "";
1137 rec->which = Z_DiagForm_v2AddInfo;
1138 rec->addinfo = addinfo ? addinfo : "";
1143 static Z_Records *pack_records(association *a, char *setname, int start,
1144 int *num, Z_RecordComposition *comp,
1145 int *next, int *pres, oid_value format,
1146 Z_ReferenceId *referenceId,
1149 int recno, total_length = 0, toget = *num, dumped_records = 0;
1150 Z_Records *records =
1151 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1152 Z_NamePlusRecordList *reclist =
1153 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1154 Z_NamePlusRecord **list =
1155 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1157 records->which = Z_Records_DBOSD;
1158 records->u.databaseOrSurDiagnostics = reclist;
1159 reclist->num_records = 0;
1160 reclist->records = list;
1161 *pres = Z_PRES_SUCCESS;
1165 yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
1166 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1167 a->maximumRecordSize);
1168 for (recno = start; reclist->num_records < toget; recno++)
1171 Z_NamePlusRecord *thisrec;
1172 int this_length = 0;
1174 * we get the number of bytes allocated on the stream before any
1175 * allocation done by the backend - this should give us a reasonable
1176 * idea of the total size of the data so far.
1178 total_length = odr_total(a->encode) - dumped_records;
1184 freq.last_in_set = 0;
1185 freq.setname = setname;
1186 freq.surrogate_flag = 0;
1187 freq.number = recno;
1189 freq.request_format = format;
1190 freq.record_syntax = oid;
1191 freq.output_format = 0;
1192 freq.stream = a->encode;
1193 freq.print = a->print;
1194 freq.surrogate_flag = 0;
1195 freq.referenceId = referenceId;
1196 (*a->init->bend_fetch)(a->backend, &freq);
1197 /* backend should be able to signal whether error is system-wide
1198 or only pertaining to current record */
1201 if (!freq.surrogate_flag)
1203 *pres = Z_PRES_FAILURE;
1204 return diagrec(a, freq.errcode, freq.errstring);
1206 reclist->records[reclist->num_records] =
1207 surrogatediagrec(a, freq.basename, freq.errcode,
1209 reclist->num_records++;
1210 *next = freq.last_in_set ? 0 : recno + 1;
1214 this_length = freq.len;
1216 this_length = odr_total(a->encode) - total_length;
1217 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1218 this_length, total_length);
1219 if (this_length + total_length > a->preferredMessageSize)
1221 /* record is small enough, really */
1222 if (this_length <= a->preferredMessageSize)
1224 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1225 *pres = Z_PRES_PARTIAL_2;
1228 /* record can only be fetched by itself */
1229 if (this_length < a->maximumRecordSize)
1231 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1234 yaz_log(LOG_DEBUG, " Dropped it");
1235 reclist->records[reclist->num_records] =
1236 surrogatediagrec(a, freq.basename, 16, 0);
1237 reclist->num_records++;
1238 *next = freq.last_in_set ? 0 : recno + 1;
1239 dumped_records += this_length;
1243 else /* too big entirely */
1245 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
1246 reclist->records[reclist->num_records] =
1247 surrogatediagrec(a, freq.basename, 17, 0);
1248 reclist->num_records++;
1249 *next = freq.last_in_set ? 0 : recno + 1;
1250 dumped_records += this_length;
1255 if (!(thisrec = (Z_NamePlusRecord *)
1256 odr_malloc(a->encode, sizeof(*thisrec))))
1258 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1259 strlen(freq.basename) + 1)))
1261 strcpy(thisrec->databaseName, freq.basename);
1262 thisrec->which = Z_NamePlusRecord_databaseRecord;
1263 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
1264 freq.record, freq.len);
1265 if (!thisrec->u.databaseRecord)
1267 reclist->records[reclist->num_records] = thisrec;
1268 reclist->num_records++;
1269 *next = freq.last_in_set ? 0 : recno + 1;
1271 *num = reclist->num_records;
1275 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1278 Z_SearchRequest *req = reqb->request->u.searchRequest;
1279 bend_search_rr *bsrr =
1280 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1282 yaz_log(LOG_LOG, "Got SearchRequest.");
1284 bsrr->request = reqb;
1285 bsrr->association = assoc;
1286 bsrr->referenceId = req->referenceId;
1287 save_referenceId (reqb, bsrr->referenceId);
1289 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1290 if (req->databaseNames)
1293 for (i = 0; i < req->num_databaseNames; i++)
1294 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1296 switch (req->query->which)
1298 case Z_Query_type_1: case Z_Query_type_101:
1299 log_rpn_query (req->query->u.type_1);
1301 if (assoc->init->bend_search)
1303 bsrr->setname = req->resultSetName;
1304 bsrr->replace_set = *req->replaceIndicator;
1305 bsrr->num_bases = req->num_databaseNames;
1306 bsrr->basenames = req->databaseNames;
1307 bsrr->query = req->query;
1308 bsrr->stream = assoc->encode;
1309 bsrr->decode = assoc->decode;
1310 bsrr->print = assoc->print;
1313 bsrr->errstring = NULL;
1314 (assoc->init->bend_search)(assoc->backend, bsrr);
1321 bend_searchrequest bsrq;
1322 bend_searchresult *bsrt;
1324 bsrq.setname = req->resultSetName;
1325 bsrq.replace_set = *req->replaceIndicator;
1326 bsrq.num_bases = req->num_databaseNames;
1327 bsrq.basenames = req->databaseNames;
1328 bsrq.query = req->query;
1329 bsrq.referenceId = req->referenceId;
1330 bsrq.stream = assoc->encode;
1331 bsrq.decode = assoc->decode;
1332 bsrq.print = assoc->print;
1333 if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1335 bsrr->hits = bsrt->hits;
1336 bsrr->errcode = bsrt->errcode;
1337 bsrr->errstring = bsrt->errstring;
1340 return response_searchRequest(assoc, reqb, bsrr, fd);
1343 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1346 * Prepare a searchresponse based on the backend results. We probably want
1347 * to look at making the fetching of records nonblocking as well, but
1348 * so far, we'll keep things simple.
1349 * If bsrt is null, that means we're called in response to a communications
1350 * event, and we'll have to get the response for ourselves.
1352 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1353 bend_search_rr *bsrt, int *fd)
1355 Z_SearchRequest *req = reqb->request->u.searchRequest;
1356 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1357 Z_SearchResponse *resp = (Z_SearchResponse *)
1358 odr_malloc (assoc->encode, sizeof(*resp));
1359 int *nulint = (int *)odr_malloc (assoc->encode, sizeof(*nulint));
1360 bool_t *sr = (bool_t *)odr_malloc (assoc->encode, sizeof(*sr));
1361 int *next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1362 int *none = (int *)odr_malloc (assoc->encode, sizeof(*none));
1369 apdu->which = Z_APDU_searchResponse;
1370 apdu->u.searchResponse = resp;
1371 resp->referenceId = req->referenceId;
1372 resp->additionalSearchInfo = 0;
1373 resp->otherInfo = 0;
1375 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1377 yaz_log(LOG_FATAL, "Bad result from backend");
1380 else if (bsrt->errcode)
1382 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1383 resp->resultCount = nulint;
1384 resp->numberOfRecordsReturned = nulint;
1385 resp->nextResultSetPosition = nulint;
1386 resp->searchStatus = nulint;
1387 resp->resultSetStatus = none;
1388 resp->presentStatus = 0;
1392 int *toget = (int *)odr_malloc (assoc->encode, sizeof(*toget));
1393 int *presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1394 Z_RecordComposition comp, *compp = 0;
1399 resp->resultCount = &bsrt->hits;
1401 comp.which = Z_RecordComp_simple;
1402 /* how many records does the user agent want, then? */
1403 if (bsrt->hits <= *req->smallSetUpperBound)
1405 *toget = bsrt->hits;
1406 if ((comp.u.simple = req->smallSetElementSetNames))
1409 else if (bsrt->hits < *req->largeSetLowerBound)
1411 *toget = *req->mediumSetPresentNumber;
1412 if (*toget > bsrt->hits)
1413 *toget = bsrt->hits;
1414 if ((comp.u.simple = req->mediumSetElementSetNames))
1420 if (*toget && !resp->records)
1425 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1426 prefformat->oclass != CLASS_RECSYN)
1429 form = prefformat->value;
1430 resp->records = pack_records(assoc, req->resultSetName, 1,
1431 toget, compp, next, presst, form, req->referenceId,
1432 req->preferredRecordSyntax);
1435 resp->numberOfRecordsReturned = toget;
1436 resp->nextResultSetPosition = next;
1437 resp->searchStatus = sr;
1438 resp->resultSetStatus = 0;
1439 resp->presentStatus = presst;
1443 if (*resp->resultCount)
1445 resp->numberOfRecordsReturned = nulint;
1446 resp->nextResultSetPosition = next;
1447 resp->searchStatus = sr;
1448 resp->resultSetStatus = 0;
1449 resp->presentStatus = 0;
1456 * Maybe we got a little over-friendly when we designed bend_fetch to
1457 * get only one record at a time. Some backends can optimise multiple-record
1458 * fetches, and at any rate, there is some overhead involved in
1459 * all that selecting and hopping around. Problem is, of course, that the
1460 * frontend can't know ahead of time how many records it'll need to
1461 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1462 * is downright lousy as a bulk data transfer protocol.
1464 * To start with, we'll do the fetching of records from the backend
1465 * in one operation: To save some trips in and out of the event-handler,
1466 * and to simplify the interface to pack_records. At any rate, asynch
1467 * operation is more fun in operations that have an unpredictable execution
1468 * speed - which is normally more true for search than for present.
1470 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1473 Z_PresentRequest *req = reqb->request->u.presentRequest;
1477 Z_PresentResponse *resp;
1482 yaz_log(LOG_LOG, "Got PresentRequest.");
1484 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1485 prefformat->oclass != CLASS_RECSYN)
1488 form = prefformat->value;
1489 if (assoc->init->bend_present)
1491 bend_present_rr *bprr = (bend_present_rr *)
1492 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1493 bprr->setname = req->resultSetId;
1494 bprr->start = *req->resultSetStartPoint;
1495 bprr->number = *req->numberOfRecordsRequested;
1496 bprr->format = form;
1497 bprr->record_syntax = req->preferredRecordSyntax;
1498 bprr->comp = req->recordComposition;
1499 bprr->referenceId = req->referenceId;
1500 bprr->stream = assoc->encode;
1501 bprr->print = assoc->print;
1502 bprr->request = reqb;
1503 bprr->association = assoc;
1505 bprr->errstring = NULL;
1506 (*assoc->init->bend_present)(assoc->backend, bprr);
1511 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1512 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1513 presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1514 next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1515 num = (int *)odr_malloc (assoc->encode, sizeof(*num));
1518 *num = *req->numberOfRecordsRequested;
1520 apdu->which = Z_APDU_presentResponse;
1521 apdu->u.presentResponse = resp;
1522 resp->referenceId = req->referenceId;
1523 resp->otherInfo = 0;
1526 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1527 num, req->recordComposition, next, presst, form,
1528 req->referenceId, req->preferredRecordSyntax);
1531 resp->numberOfRecordsReturned = num;
1532 resp->presentStatus = presst;
1533 resp->nextResultSetPosition = next;
1539 static int bend_default_scan (void *handle, bend_scan_rr *rr)
1541 bend_scanrequest srq;
1542 bend_scanresult *srs;
1544 srq.num_bases = rr->num_bases;
1545 srq.basenames = rr->basenames;
1546 srq.attributeset = rr->attributeset;
1547 srq.referenceId = rr->referenceId;
1548 srq.term = rr->term;
1549 srq.term_position = rr->term_position;
1550 srq.num_entries = rr->num_entries;
1551 srq.stream = rr->stream;
1552 srq.print = rr->print;
1554 srs = bend_scan(handle, &srq, 0);
1556 rr->term_position = srs->term_position;
1557 rr->num_entries = srs->num_entries;
1558 rr->entries = srs->entries;
1559 rr->status = srs->status;
1560 rr->errcode = srs->errcode;
1561 rr->errstring = srs->errstring;
1567 * Scan was implemented rather in a hurry, and with support for only the basic
1568 * elements of the service in the backend API. Suggestions are welcome.
1570 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1572 Z_ScanRequest *req = reqb->request->u.scanRequest;
1573 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1574 Z_ScanResponse *res = (Z_ScanResponse *)
1575 odr_malloc (assoc->encode, sizeof(*res));
1576 int *scanStatus = (int *)
1577 odr_malloc (assoc->encode, sizeof(*scanStatus));
1578 int *numberOfEntriesReturned = (int *)
1579 odr_malloc (assoc->encode, sizeof(*numberOfEntriesReturned));
1580 Z_ListEntries *ents = (Z_ListEntries *)
1581 odr_malloc (assoc->encode, sizeof(*ents));
1582 Z_DiagRecs *diagrecs_p = NULL;
1586 yaz_log(LOG_LOG, "Got ScanRequest");
1587 *scanStatus = Z_Scan_failure;
1588 *numberOfEntriesReturned = 0;
1590 apdu->which = Z_APDU_scanResponse;
1591 apdu->u.scanResponse = res;
1592 res->referenceId = req->referenceId;
1594 res->scanStatus = scanStatus;
1595 res->numberOfEntriesReturned = numberOfEntriesReturned;
1596 res->positionOfTerm = 0;
1597 res->entries = ents;
1598 ents->num_entries = 0;
1599 ents->entries = NULL;
1600 ents->num_nonsurrogateDiagnostics = 0;
1601 ents->nonsurrogateDiagnostics = NULL;
1602 res->attributeSet = 0;
1605 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1606 attent->oclass != CLASS_ATTSET
1607 || attent->value != VAL_BIB1))
1608 diagrecs_p = diagrecs(assoc, 121, 0);
1609 else if (req->stepSize && *req->stepSize > 0)
1610 diagrecs_p = diagrecs(assoc, 205, 0);
1613 bend_scan_rr *bsrr = (bend_scan_rr *)
1614 odr_malloc (assoc->encode, sizeof(*bsrr));
1615 if (req->databaseNames)
1618 for (i = 0; i < req->num_databaseNames; i++)
1619 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1621 bsrr->num_bases = req->num_databaseNames;
1622 bsrr->basenames = req->databaseNames;
1623 bsrr->num_entries = *req->numberOfTermsRequested;
1624 bsrr->term = req->termListAndStartPoint;
1625 bsrr->referenceId = req->referenceId;
1626 bsrr->stream = assoc->encode;
1627 bsrr->print = assoc->print;
1628 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1629 attset->oclass != CLASS_RECSYN)
1630 bsrr->attributeset = VAL_NONE;
1632 bsrr->attributeset = attset->value;
1633 log_scan_term (req->termListAndStartPoint, attset->value);
1634 bsrr->term_position = req->preferredPositionInResponse ?
1635 *req->preferredPositionInResponse : 1;
1636 ((int (*)(void *, bend_scan_rr *))
1637 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1639 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1643 Z_Entry **tab = (Z_Entry **)
1644 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1646 if (bsrr->status == BEND_SCAN_PARTIAL)
1647 *scanStatus = Z_Scan_partial_5;
1649 *scanStatus = Z_Scan_success;
1650 ents->entries = tab;
1651 ents->num_entries = bsrr->num_entries;
1652 res->numberOfEntriesReturned = &ents->num_entries;
1653 res->positionOfTerm = &bsrr->term_position;
1654 for (i = 0; i < bsrr->num_entries; i++)
1660 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1661 if (bsrr->entries[i].occurrences >= 0)
1663 e->which = Z_Entry_termInfo;
1664 e->u.termInfo = t = (Z_TermInfo *)
1665 odr_malloc(assoc->encode, sizeof(*t));
1666 t->suggestedAttributes = 0;
1668 t->alternativeTerm = 0;
1669 t->byAttributes = 0;
1670 t->otherTermInfo = 0;
1671 t->globalOccurrences = &bsrr->entries[i].occurrences;
1672 t->term = (Z_Term *)
1673 odr_malloc(assoc->encode, sizeof(*t->term));
1674 t->term->which = Z_Term_general;
1675 t->term->u.general = o =
1676 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1677 o->buf = (unsigned char *)
1678 odr_malloc(assoc->encode, o->len = o->size =
1679 strlen(bsrr->entries[i].term));
1680 memcpy(o->buf, bsrr->entries[i].term, o->len);
1681 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1682 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1686 Z_DiagRecs *drecs = diagrecs (assoc,
1687 bsrr->entries[i].errcode,
1688 bsrr->entries[i].errstring);
1689 assert (drecs->num_diagRecs == 1);
1690 e->which = Z_Entry_surrogateDiagnostic;
1691 assert (drecs->diagRecs[0]);
1692 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1699 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1700 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1705 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1708 Z_SortRequest *req = reqb->request->u.sortRequest;
1709 Z_SortResponse *res = (Z_SortResponse *)
1710 odr_malloc (assoc->encode, sizeof(*res));
1711 bend_sort_rr *bsrr = (bend_sort_rr *)
1712 odr_malloc (assoc->encode, sizeof(*bsrr));
1714 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1716 yaz_log(LOG_LOG, "Got SortRequest.");
1719 bsrr->num_input_setnames = req->num_inputResultSetNames;
1720 bsrr->input_setnames = req->inputResultSetNames;
1722 bsrr->num_input_setnames = req->inputResultSetNames->num_strings;
1723 bsrr->input_setnames = req->inputResultSetNames->strings;
1725 bsrr->referenceId = req->referenceId;
1726 bsrr->output_setname = req->sortedResultSetName;
1727 bsrr->sort_sequence = req->sortSequence;
1728 bsrr->stream = assoc->encode;
1729 bsrr->print = assoc->print;
1731 bsrr->sort_status = Z_SortStatus_failure;
1733 bsrr->errstring = 0;
1735 (*assoc->init->bend_sort)(assoc->backend, bsrr);
1737 res->referenceId = bsrr->referenceId;
1738 res->sortStatus = (int *)
1739 odr_malloc (assoc->encode, sizeof(*res->sortStatus));
1740 *res->sortStatus = bsrr->sort_status;
1741 res->resultSetStatus = 0;
1744 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1746 res->diagnostics = dr->diagRecs;
1747 res->num_diagnostics = dr->num_diagRecs;
1749 res->diagnostics = dr;
1755 res->num_diagnostics = 0;
1757 res->diagnostics = 0;
1761 apdu->which = Z_APDU_sortResponse;
1762 apdu->u.sortResponse = res;
1766 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1769 Z_DeleteResultSetRequest *req = reqb->request->u.deleteResultSetRequest;
1770 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1771 odr_malloc (assoc->encode, sizeof(*res));
1772 bend_delete_rr *bdrr = (bend_delete_rr *)
1773 odr_malloc (assoc->encode, sizeof(*bdrr));
1774 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1776 yaz_log(LOG_LOG, "Got DeleteRequest.");
1778 bdrr->num_setnames = req->num_resultSetList;
1779 bdrr->setnames = req->resultSetList;
1780 bdrr->stream = assoc->encode;
1781 bdrr->print = assoc->print;
1782 bdrr->function = *req->deleteFunction;
1783 bdrr->referenceId = req->referenceId;
1785 if (bdrr->num_setnames > 0)
1788 bdrr->statuses = odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1789 bdrr->num_setnames);
1790 for (i = 0; i < bdrr->num_setnames; i++)
1791 bdrr->statuses[i] = 0;
1793 (*assoc->init->bend_delete)(assoc->backend, bdrr);
1795 res->referenceId = req->referenceId;
1797 res->deleteOperationStatus = (int *)
1798 odr_malloc (assoc->encode, sizeof(*res->deleteOperationStatus));
1799 *res->deleteOperationStatus = bdrr->delete_status;
1801 res->deleteListStatuses = 0;
1802 if (bdrr->num_setnames > 0)
1805 res->deleteListStatuses = odr_malloc(assoc->encode,
1806 sizeof(*res->deleteListStatuses));
1807 res->deleteListStatuses->num = bdrr->num_setnames;
1808 res->deleteListStatuses->elements =
1809 odr_malloc (assoc->encode,
1810 sizeof(*res->deleteListStatuses->elements) *
1811 bdrr->num_setnames);
1812 for (i = 0; i<bdrr->num_setnames; i++)
1814 res->deleteListStatuses->elements[i] =
1815 odr_malloc (assoc->encode,
1816 sizeof(**res->deleteListStatuses->elements));
1817 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1818 res->deleteListStatuses->elements[i]->id =
1819 odr_strdup (assoc->encode, bdrr->setnames[i]);
1823 res->numberNotDeleted = 0;
1824 res->bulkStatuses = 0;
1825 res->deleteMessage = 0;
1828 apdu->which = Z_APDU_deleteResultSetResponse;
1829 apdu->u.deleteResultSetResponse = res;
1833 static void process_close(association *assoc, request *reqb)
1835 Z_Close *req = reqb->request->u.close;
1836 static char *reasons[] =
1843 "securityViolation",
1850 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1851 reasons[*req->closeReason], req->diagnosticInformation ?
1852 req->diagnosticInformation : "NULL");
1853 if (assoc->version < 3) /* to make do_force respond with close */
1855 do_close_req(assoc, Z_Close_finished,
1856 "Association terminated by client", reqb);
1859 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1863 reqb->len_refid = refid->len;
1864 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1865 memcpy (reqb->refid, refid->buf, refid->len);
1869 reqb->len_refid = 0;
1874 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1876 process_response (a, req, res);
1879 bend_request bend_request_mk (bend_association a)
1881 request *nreq = request_get (&a->outgoing);
1882 nreq->request_mem = nmem_create ();
1886 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1891 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1892 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1893 id->len = id->size = req->len_refid;
1894 memcpy (id->buf, req->refid, req->len_refid);
1898 void bend_request_destroy (bend_request *req)
1900 nmem_destroy((*req)->request_mem);
1901 request_release(*req);
1905 int bend_backend_respond (bend_association a, bend_request req)
1909 r = process_request (a, req, &msg);
1911 logf (LOG_WARN, "%s", msg);
1915 void bend_request_setdata(bend_request r, void *p)
1920 void *bend_request_getdata(bend_request r)
1922 return r->clientData;
1925 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
1927 bend_segment_rr request;
1929 request.segment = reqb->request->u.segmentRequest;
1930 request.stream = assoc->encode;
1931 request.decode = assoc->decode;
1932 request.print = assoc->print;
1933 request.association = assoc;
1935 (*assoc->init->bend_segment)(assoc->backend, &request);
1940 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
1942 bend_esrequest_rr esrequest;
1944 Z_ExtendedServicesRequest *req = reqb->request->u.extendedServicesRequest;
1945 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
1947 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
1949 yaz_log(LOG_DEBUG,"inside Process esRequest");
1951 esrequest.esr = reqb->request->u.extendedServicesRequest;
1952 esrequest.stream = assoc->encode;
1953 esrequest.decode = assoc->decode;
1954 esrequest.print = assoc->print;
1955 esrequest.errcode = 0;
1956 esrequest.errstring = NULL;
1957 esrequest.request = reqb;
1958 esrequest.association = assoc;
1959 esrequest.referenceId = req->referenceId;
1961 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
1963 /* If the response is being delayed, return NULL */
1964 if (esrequest.request == NULL)
1967 resp->referenceId = req->referenceId;
1969 if (esrequest.errcode == -1)
1971 /* Backend service indicates request will be processed */
1972 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
1973 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
1975 else if (esrequest.errcode == 0)
1977 /* Backend service indicates request will be processed */
1978 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
1979 *resp->operationStatus = Z_ExtendedServicesResponse_done;
1983 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
1984 esrequest.errstring);
1986 /* Backend indicates error, request will not be processed */
1987 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
1988 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
1989 resp->num_diagnostics = diagRecs->num_diagRecs;
1990 resp->diagnostics = diagRecs->diagRecs;
1992 /* Do something with the members of bend_extendedservice */
1994 yaz_log(LOG_DEBUG,"Send the result apdu");