2 * Copyright (c) 1995-2000, Index Data
3 * See the file LICENSE for details.
6 * Revision 1.108 2000-09-04 08:58:15 adam
7 * Added prefix yaz_ for most logging utility functions.
9 * Revision 1.107 2000/08/31 10:20:12 adam
10 * Added member request_format and output_format for backend fetch method.
12 * Revision 1.106 2000/08/31 09:51:25 adam
13 * Added record_syntax member for fetch method (raw OID).
15 * Revision 1.105 2000/07/06 10:38:47 adam
16 * Enhanced option --enable-tcpd.
18 * Revision 1.104 2000/04/05 07:39:55 adam
19 * Added shared library support (libtool).
21 * Revision 1.103 2000/03/20 19:06:25 adam
22 * Added Segment request for fronend server. Work on admin for client.
24 * Revision 1.102 2000/03/15 12:59:49 adam
25 * Added handle member to statserv_control.
27 * Revision 1.101 2000/01/12 14:36:07 adam
28 * Added printing stream (ODR) for backend functions.
30 * Revision 1.100 1999/12/16 23:36:19 adam
31 * Implemented ILL protocol. Minor updates ASN.1 compiler.
33 * Revision 1.99 1999/11/30 13:47:12 adam
34 * Improved installation. Moved header files to include/yaz.
36 * Revision 1.98 1999/11/29 15:12:27 adam
37 * Changed the way implementationName - and version is set.
39 * Revision 1.96 1999/11/04 14:58:44 adam
40 * Added status elements for backend delete result set handler.
41 * Updated delete result result set command for client.
43 * Revision 1.95 1999/10/11 10:01:24 adam
44 * Implemented bend_sort_rr handler for frontend server.
46 * Revision 1.94 1999/08/27 09:40:32 adam
47 * Renamed logf function to yaz_log. Removed VC++ project files.
49 * Revision 1.93 1999/07/06 12:17:15 adam
50 * Added option -1 that runs server once (for profiling purposes).
52 * Revision 1.92 1999/06/17 10:54:45 adam
53 * Added facility to specify implementation version - and name
56 * Revision 1.91 1999/06/01 14:29:12 adam
57 * Work on Extended Services.
59 * Revision 1.90 1999/05/27 13:02:20 adam
60 * Assigned OID for old DB Update (VAL_DBUPDATE0).
62 * Revision 1.89 1999/05/26 15:24:26 adam
63 * Fixed minor bugs regarding DB Update (introduced by previous commit).
65 * Revision 1.88 1999/04/20 09:56:48 adam
66 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
67 * Modified all encoders/decoders to reflect this change.
69 * Revision 1.87 1999/03/31 11:18:25 adam
70 * Implemented odr_strdup. Added Reference ID to backend server API.
72 * Revision 1.86 1999/02/02 13:57:38 adam
73 * Uses preprocessor define WIN32 instead of WINDOWS to build code
74 * for Microsoft WIN32.
76 * Revision 1.85 1998/11/17 09:52:59 adam
77 * Fixed minor bug (introduced by previous commit).
79 * Revision 1.84 1998/11/16 16:02:32 adam
80 * Added loggin utilies, log_rpn_query and log_scan_term. These used
81 * to be part of Zebra.
83 * Revision 1.83 1998/11/03 10:09:36 adam
84 * Fixed bug regarding YC.
86 * Revision 1.82 1998/10/20 14:00:30 quinn
89 * Revision 1.81 1998/10/13 16:12:24 adam
90 * Added support for Surrogate Diagnostics for Scan Term entries.
92 * Revision 1.80 1998/09/02 12:41:53 adam
93 * Added decode stream in bend search structures.
95 * Revision 1.79 1998/08/19 16:10:08 adam
96 * Changed som member names of DeleteResultSetRequest/Response.
98 * Revision 1.78 1998/08/03 10:23:55 adam
99 * Fixed bug regarding Options for Sort.
101 * Revision 1.77 1998/07/20 12:38:42 adam
102 * Implemented delete result set service to server API.
104 * Revision 1.76 1998/05/27 16:57:07 adam
105 * Support for surrogate diagnostic records added for bend_fetch.
107 * Revision 1.75 1998/05/18 10:13:07 adam
108 * Fixed call to es_request handler - extra argument was passed.
110 * Revision 1.74 1998/03/31 15:13:20 adam
111 * Development towards compiled ASN.1.
113 * Revision 1.73 1998/03/31 11:07:45 adam
114 * Furhter work on UNIverse resource report.
115 * Added Extended Services handling in frontend server.
117 * Revision 1.72 1998/02/11 11:53:35 adam
118 * Changed code so that it compiles as C++.
120 * Revision 1.71 1998/02/10 11:03:57 adam
121 * Added support for extended handlers in backend server interface.
123 * Revision 1.70 1998/01/29 13:15:35 adam
124 * Implemented sort for the backend interface.
126 * Revision 1.69 1997/09/30 11:48:12 adam
127 * Fixed bug introduced by previous commit.
129 * Revision 1.68 1997/09/29 13:18:59 adam
130 * Added function, oid_ent_to_oid, to replace the function
131 * oid_getoidbyent, which is not thread safe.
133 * Revision 1.67 1997/09/17 12:10:40 adam
136 * Revision 1.66 1997/09/05 15:26:44 adam
137 * Added ODR encode in search and scen bend request structures.
138 * Fixed a few enums that caused trouble with C++.
140 * Revision 1.65 1997/09/01 08:53:01 adam
141 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
142 * moved a separate directory. MSV5.0 project server.dsp created.
143 * As an option, the server can now operate as an NT service.
145 * Revision 1.64 1997/04/30 08:52:11 quinn
148 * Revision 1.63 1996/10/11 11:57:26 quinn
151 * Revision 1.62 1996/07/06 19:58:35 quinn
152 * System headerfiles gathered in yconfig
154 * Revision 1.61 1996/06/10 08:56:16 quinn
157 * Revision 1.60 1996/05/30 11:03:10 quinn
158 * Fixed NextresultSetPosition bug fixed.
160 * Revision 1.59 1996/05/14 09:26:46 quinn
161 * Added attribute set to scan backend
163 * Revision 1.58 1996/02/20 12:53:04 quinn
166 * Revision 1.57 1996/01/02 08:57:47 quinn
167 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
169 * Revision 1.56 1995/12/14 11:09:57 quinn
172 * Revision 1.55 1995/11/08 17:41:37 quinn
175 * Revision 1.54 1995/11/08 15:11:29 quinn
176 * Log of close transmit.
178 * Revision 1.53 1995/11/01 13:54:58 quinn
181 * Revision 1.52 1995/11/01 12:19:13 quinn
182 * Second attempt to fix same bug.
184 * Revision 1.50 1995/10/25 16:58:32 quinn
187 * Revision 1.49 1995/10/16 13:51:53 quinn
188 * Changes to provide Especs to the backend.
190 * Revision 1.48 1995/10/06 08:51:20 quinn
191 * Added Write-buffer.
193 * Revision 1.47 1995/08/29 14:24:16 quinn
194 * Added second half of close-handshake
196 * Revision 1.46 1995/08/29 11:17:58 quinn
197 * Added code to receive close
199 * Revision 1.45 1995/08/21 09:11:00 quinn
200 * Smallish fixes to suppport new formats.
202 * Revision 1.44 1995/08/17 12:45:25 quinn
203 * Fixed minor problems with GRS-1. Added support in c&s.
205 * Revision 1.43 1995/08/15 12:00:31 quinn
208 * Revision 1.42 1995/08/15 11:16:50 quinn
210 * Revision 1.41 1995/08/02 10:23:06 quinn
213 * Revision 1.40 1995/07/31 14:34:26 quinn
214 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
216 * Revision 1.39 1995/06/27 13:21:00 quinn
219 * Revision 1.38 1995/06/19 12:39:11 quinn
220 * Fixed bug in timeout code. Added BER dumper.
222 * Revision 1.37 1995/06/16 13:16:14 quinn
223 * Fixed Defaultdiagformat.
225 * Revision 1.36 1995/06/16 10:31:36 quinn
226 * Added session timeout.
228 * Revision 1.35 1995/06/15 07:45:14 quinn
231 * Revision 1.34 1995/06/14 15:26:46 quinn
232 * *** empty log message ***
234 * Revision 1.33 1995/06/06 14:57:05 quinn
235 * Better diagnostics.
237 * Revision 1.32 1995/06/06 08:41:44 quinn
238 * Better diagnostics.
240 * Revision 1.31 1995/06/06 08:15:37 quinn
243 * Revision 1.30 1995/06/05 10:53:32 quinn
244 * Added a better SCAN.
246 * Revision 1.29 1995/06/01 11:25:03 quinn
249 * Revision 1.28 1995/06/01 11:21:01 quinn
250 * Attempting to fix a bug in pack-records. replaced break with continue
251 * for large records, according to standard.
253 * Revision 1.27 1995/05/29 08:12:06 quinn
256 * Revision 1.26 1995/05/18 13:02:12 quinn
259 * Revision 1.25 1995/05/17 08:42:26 quinn
260 * Transfer auth info to backend. Allow backend to reject init gracefully.
262 * Revision 1.24 1995/05/16 08:51:04 quinn
263 * License, documentation, and memory fixes
265 * Revision 1.23 1995/05/15 13:25:10 quinn
268 * Revision 1.22 1995/05/15 11:56:39 quinn
269 * Asynchronous facilities. Restructuring of seshigh code.
271 * Revision 1.21 1995/05/02 08:53:19 quinn
272 * Trying in vain to fix comm with ISODE
274 * Revision 1.20 1995/04/20 15:13:00 quinn
277 * Revision 1.19 1995/04/18 08:15:34 quinn
278 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
279 * neater. We'll make the same change for decoding one day.
281 * Revision 1.18 1995/04/17 11:28:25 quinn
284 * Revision 1.17 1995/04/10 10:23:36 quinn
285 * Some work to add scan and other things.
287 * Revision 1.16 1995/03/31 09:18:55 quinn
290 * Revision 1.15 1995/03/30 14:03:23 quinn
291 * Added RFC1006 as separate library
293 * Revision 1.14 1995/03/30 12:18:17 quinn
296 * Revision 1.13 1995/03/30 09:09:24 quinn
297 * Added state-handle and some support for asynchronous activities.
299 * Revision 1.12 1995/03/29 15:40:16 quinn
300 * Ongoing work. Statserv is now dynamic by default
302 * Revision 1.11 1995/03/28 09:16:21 quinn
303 * Added record packing to the search request
305 * Revision 1.10 1995/03/27 08:34:24 quinn
306 * Added dynamic server functionality.
307 * Released bindings to session.c (is now redundant)
309 * Revision 1.9 1995/03/22 15:01:26 quinn
310 * Adjusting record packing.
312 * Revision 1.8 1995/03/22 10:13:21 quinn
313 * Working on record packer
315 * Revision 1.7 1995/03/21 15:53:31 quinn
318 * Revision 1.6 1995/03/21 12:30:09 quinn
319 * Beginning to add support for record packing.
321 * Revision 1.5 1995/03/17 10:44:13 quinn
322 * Added catch of null-string in makediagrec
324 * Revision 1.4 1995/03/17 10:18:08 quinn
325 * Added memory management.
327 * Revision 1.3 1995/03/16 17:42:39 quinn
330 * Revision 1.2 1995/03/16 13:29:01 quinn
331 * Partitioned server.
333 * Revision 1.1 1995/03/15 16:02:10 quinn
334 * Modded session.c to seshigh.c
339 * Frontend server logic.
341 * This code receives incoming APDUs, and handles client requests by means
342 * of the backend API.
344 * Some of the code is getting quite involved, compared to simpler servers -
345 * primarily because it is asynchronous both in the communication with
346 * the user and the backend. We think the complexity will pay off in
347 * the form of greater flexibility when more asynchronous facilities
350 * Memory management has become somewhat involved. In the simple case, where
351 * only one PDU is pending at a time, it will simply reuse the same memory,
352 * once it has found its working size. When we enable multiple concurrent
353 * operations, perhaps even with multiple parallel calls to the backend, it
354 * will maintain a pool of buffers for encoding and decoding, trying to
355 * minimize memory allocation/deallocation during normal operation.
357 * TODOs include (and will be done in order of public interest):
359 * Support for EXPLAIN - provide simple meta-database system.
360 * Support for access control.
361 * Support for resource control.
362 * Support for extended services - primarily Item Order.
363 * Rest of Z39.50-1994
376 #include <yaz/yconfig.h>
377 #include <yaz/xmalloc.h>
378 #include <yaz/comstack.h>
381 #include <yaz/proto.h>
384 #include <yaz/logrpn.h>
385 #include <yaz/statserv.h>
387 #include <yaz/backend.h>
389 static int process_request(association *assoc, request *req, char **msg);
390 void backend_response(IOCHAN i, int event);
391 static int process_response(association *assoc, request *req, Z_APDU *res);
392 static Z_APDU *process_initRequest(association *assoc, request *reqb);
393 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
395 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
396 bend_search_rr *bsrr, int *fd);
397 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
399 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
400 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
401 static void process_close(association *assoc, request *reqb);
402 void save_referenceId (request *reqb, Z_ReferenceId *refid);
403 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
405 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
407 static FILE *apduf = 0; /* for use in static mode */
408 static statserv_options_block *control_block = 0;
410 /* Chas: Added in from DALI */
411 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
412 /* Chas: End of addition from DALI */
415 * Create and initialize a new association-handle.
416 * channel : iochannel for the current line.
417 * link : communications channel.
418 * Returns: 0 or a new association handle.
420 association *create_association(IOCHAN channel, COMSTACK link)
425 control_block = statserv_getcontrol();
426 if (!(anew = (association *)xmalloc(sizeof(*anew))))
429 anew->client_chan = channel;
430 anew->client_link = link;
431 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
432 !(anew->encode = odr_createmem(ODR_ENCODE)))
434 if (*control_block->apdufile)
439 strcpy(filename, control_block->apdufile);
440 if (!(anew->print = odr_createmem(ODR_PRINT)))
442 if (*control_block->apdufile != '-')
444 strcpy(filename, control_block->apdufile);
445 if (!control_block->dynamic)
449 if (!(apduf = fopen(filename, "w")))
451 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
454 setvbuf(apduf, 0, _IONBF, 0);
460 sprintf(filename + strlen(filename), ".%d", getpid());
461 if (!(f = fopen(filename, "w")))
463 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
466 setvbuf(f, 0, _IONBF, 0);
468 odr_setprint(anew->print, f);
473 anew->input_buffer = 0;
474 anew->input_buffer_len = 0;
476 anew->state = ASSOC_NEW;
477 request_initq(&anew->incoming);
478 request_initq(&anew->outgoing);
479 anew->proto = cs_getproto(link);
484 * Free association and release resources.
486 void destroy_association(association *h)
488 statserv_options_block *cb = statserv_getcontrol();
491 odr_destroy(h->decode);
492 odr_destroy(h->encode);
494 odr_destroy(h->print);
496 xfree(h->input_buffer);
498 (*cb->bend_close)(h->backend);
499 while (request_deq(&h->incoming));
500 while (request_deq(&h->outgoing));
501 request_delq(&h->incoming);
502 request_delq(&h->outgoing);
504 if (control_block && control_block->one_shot)
508 static void do_close_req(association *a, int reason, char *message,
512 Z_Close *cls = zget_Close(a->encode);
514 /* Purge request queue */
515 while (request_deq(&a->incoming));
516 while (request_deq(&a->outgoing));
519 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
520 reason, message ? message : "none");
521 apdu.which = Z_APDU_close;
523 *cls->closeReason = reason;
524 cls->diagnosticInformation = message;
525 process_response(a, req, &apdu);
526 iochan_settimeout(a->client_chan, 60);
530 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
531 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
533 a->state = ASSOC_DEAD;
536 static void do_close(association *a, int reason, char *message)
538 do_close_req (a, reason, message, request_get(&a->outgoing));
542 * This is where PDUs from the client are read and the further
543 * processing is initiated. Flow of control moves down through the
544 * various process_* functions below, until the encoded result comes back up
545 * to the output handler in here.
547 * h : the I/O channel that has an outstanding event.
548 * event : the current outstanding event.
550 void ir_session(IOCHAN h, int event)
553 association *assoc = (association *)iochan_getdata(h);
554 COMSTACK conn = assoc->client_link;
557 assert(h && conn && assoc);
558 if (event == EVENT_TIMEOUT)
560 if (assoc->state != ASSOC_UP)
562 yaz_log(LOG_LOG, "Final timeout - closing connection.");
564 destroy_association(assoc);
569 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
570 do_close(assoc, Z_Close_lackOfActivity, 0);
574 if (event & EVENT_INPUT || event & EVENT_WORK) /* input */
576 if (event & EVENT_INPUT)
578 yaz_log(LOG_DEBUG, "ir_session (input)");
579 assert(assoc && conn);
580 /* We aren't speaking to this fellow */
581 if (assoc->state == ASSOC_DEAD)
583 yaz_log(LOG_LOG, "Closed connection after reject");
585 destroy_association(assoc);
589 if ((res = cs_get(conn, &assoc->input_buffer,
590 &assoc->input_buffer_len)) <= 0)
592 yaz_log(LOG_LOG, "Connection closed by client");
594 destroy_association(assoc);
598 else if (res == 1) /* incomplete read - wait for more */
600 if (cs_more(conn)) /* more stuff - call us again later, please */
601 iochan_setevent(h, EVENT_INPUT);
603 /* we got a complete PDU. Let's decode it */
604 yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
605 req = request_get(&assoc->incoming); /* get a new request structure */
606 odr_reset(assoc->decode);
607 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
608 if (!z_APDU(assoc->decode, &req->request, 0, 0))
610 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
611 odr_errmsg(odr_geterror(assoc->decode)),
612 odr_offset(assoc->decode));
613 yaz_log(LOG_LOG, "PDU dump:");
614 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
615 do_close(assoc, Z_Close_protocolError, "Malformed package");
618 req->request_mem = odr_extract_mem(assoc->decode);
619 if (assoc->print && !z_APDU(assoc->print, &req->request, 0, 0))
621 yaz_log(LOG_WARN, "ODR print error: %s",
622 odr_errmsg(odr_geterror(assoc->print)));
623 odr_reset(assoc->print);
625 request_enq(&assoc->incoming, req);
628 /* can we do something yet? */
629 req = request_head(&assoc->incoming);
630 if (req->state == REQUEST_IDLE)
633 request_deq(&assoc->incoming);
634 if (process_request(assoc, req, &msg) < 0)
635 do_close_req(assoc, Z_Close_systemProblem, msg, req);
638 if (event & EVENT_OUTPUT)
640 request *req = request_head(&assoc->outgoing);
642 yaz_log(LOG_DEBUG, "ir_session (output)");
643 req->state = REQUEST_PENDING;
644 switch (res = cs_put(conn, req->response, req->len_response))
647 yaz_log(LOG_LOG, "Connection closed by client");
649 destroy_association(assoc);
652 case 0: /* all sent - release the request structure */
653 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
654 nmem_destroy(req->request_mem);
655 request_deq(&assoc->outgoing);
656 request_release(req);
657 if (!request_head(&assoc->outgoing))
658 iochan_clearflag(h, EVENT_OUTPUT);
660 /* value of 1 -- partial send -- is simply ignored */
663 if (event & EVENT_EXCEPT)
665 yaz_log(LOG_DEBUG, "ir_session (exception)");
667 destroy_association(assoc);
673 * Initiate request processing.
675 static int process_request(association *assoc, request *req, char **msg)
681 *msg = "Unknown Error";
682 assert(req && req->state == REQUEST_IDLE);
683 if (req->request->which != Z_APDU_initRequest && !assoc->init)
685 *msg = "Missing InitRequest";
688 switch (req->request->which)
690 case Z_APDU_initRequest:
691 res = process_initRequest(assoc, req); break;
692 case Z_APDU_searchRequest:
693 res = process_searchRequest(assoc, req, &fd); break;
694 case Z_APDU_presentRequest:
695 res = process_presentRequest(assoc, req, &fd); break;
696 case Z_APDU_scanRequest:
697 if (assoc->init->bend_scan)
698 res = process_scanRequest(assoc, req, &fd);
701 *msg = "Cannot handle Scan APDU";
705 case Z_APDU_extendedServicesRequest:
706 if (assoc->init->bend_esrequest)
707 res = process_ESRequest(assoc, req, &fd);
710 *msg = "Cannot handle Extended Services APDU";
714 case Z_APDU_sortRequest:
715 if (assoc->init->bend_sort)
716 res = process_sortRequest(assoc, req, &fd);
719 *msg = "Cannot handle Sort APDU";
724 process_close(assoc, req);
726 case Z_APDU_deleteResultSetRequest:
727 if (assoc->init->bend_delete)
728 res = process_deleteRequest(assoc, req, &fd);
731 *msg = "Cannot handle Delete APDU";
735 case Z_APDU_segmentRequest:
736 if (assoc->init->bend_segment)
738 res = process_segmentRequest (assoc, req);
742 *msg = "Cannot handle Segment APDU";
747 *msg = "Bad APDU received";
752 yaz_log(LOG_DEBUG, " result immediately available");
753 retval = process_response(assoc, req, res);
757 yaz_log(LOG_DEBUG, " result unavailble");
760 else /* no result yet - one will be provided later */
764 /* Set up an I/O handler for the fd supplied by the backend */
766 yaz_log(LOG_DEBUG, " establishing handler for result");
767 req->state = REQUEST_PENDING;
768 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
770 iochan_setdata(chan, assoc);
777 * Handle message from the backend.
779 void backend_response(IOCHAN i, int event)
781 association *assoc = (association *)iochan_getdata(i);
782 request *req = request_head(&assoc->incoming);
786 yaz_log(LOG_DEBUG, "backend_response");
787 assert(assoc && req && req->state != REQUEST_IDLE);
788 /* determine what it is we're waiting for */
789 switch (req->request->which)
791 case Z_APDU_searchRequest:
792 res = response_searchRequest(assoc, req, 0, &fd); break;
794 case Z_APDU_presentRequest:
795 res = response_presentRequest(assoc, req, 0, &fd); break;
796 case Z_APDU_scanRequest:
797 res = response_scanRequest(assoc, req, 0, &fd); break;
800 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
803 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
805 yaz_log(LOG_LOG, "Fatal error when talking to backend");
806 do_close(assoc, Z_Close_systemProblem, 0);
810 else if (!res) /* no result yet - try again later */
812 yaz_log(LOG_DEBUG, " no result yet");
813 iochan_setfd(i, fd); /* in case fd has changed */
818 * Encode response, and transfer the request structure to the outgoing queue.
820 static int process_response(association *assoc, request *req, Z_APDU *res)
822 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
823 if (!z_APDU(assoc->encode, &res, 0, 0))
825 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
826 odr_errmsg(odr_geterror(assoc->decode)));
827 odr_reset(assoc->encode);
830 req->response = odr_getbuf(assoc->encode, &req->len_response,
831 &req->size_response);
832 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
833 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
835 yaz_log(LOG_WARN, "ODR print error: %s",
836 odr_errmsg(odr_geterror(assoc->print)));
837 odr_reset(assoc->print);
839 odr_reset(assoc->encode);
840 req->state = REQUEST_IDLE;
841 request_enq(&assoc->outgoing, req);
842 /* turn the work over to the ir_session handler */
843 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
844 /* Is there more work to be done? give that to the input handler too */
846 if (request_head(&assoc->incoming))
848 yaz_log (LOG_DEBUG, "more work to be done");
849 iochan_setevent(assoc->client_chan, EVENT_WORK);
856 * Handle init request.
857 * At the moment, we don't check the options
858 * anywhere else in the code - we just try not to do anything that would
859 * break a naive client. We'll toss 'em into the association block when
860 * we need them there.
862 static Z_APDU *process_initRequest(association *assoc, request *reqb)
864 statserv_options_block *cb = statserv_getcontrol();
865 Z_InitRequest *req = reqb->request->u.initRequest;
866 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
867 Z_InitResponse *resp = apdu->u.initResponse;
868 bend_initresult *binitres;
872 assoc->init = xmalloc (sizeof(*assoc->init));
874 yaz_log(LOG_LOG, "Got initRequest");
875 if (req->implementationId)
876 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
877 if (req->implementationName)
878 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
879 if (req->implementationVersion)
880 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
882 assoc->init->stream = assoc->encode;
883 assoc->init->print = assoc->print;
884 assoc->init->auth = req->idAuthentication;
885 assoc->init->referenceId = req->referenceId;
886 assoc->init->implementation_version = 0;
887 assoc->init->implementation_name = 0;
888 assoc->init->bend_sort = NULL;
889 assoc->init->bend_search = NULL;
890 assoc->init->bend_present = NULL;
891 assoc->init->bend_esrequest = NULL;
892 assoc->init->bend_delete = NULL;
893 assoc->init->bend_scan = NULL;
894 assoc->init->bend_segment = NULL;
895 assoc->init->bend_fetch = NULL;
896 if (!(binitres = (*cb->bend_init)(assoc->init)))
898 yaz_log(LOG_WARN, "Bad response from backend.");
902 assoc->backend = binitres->handle;
903 if ((assoc->init->bend_sort))
904 yaz_log (LOG_DEBUG, "Sort handler installed");
905 if ((assoc->init->bend_search))
906 yaz_log (LOG_DEBUG, "Search handler installed");
907 if ((assoc->init->bend_present))
908 yaz_log (LOG_DEBUG, "Present handler installed");
909 if ((assoc->init->bend_esrequest))
910 yaz_log (LOG_DEBUG, "ESRequest handler installed");
911 if ((assoc->init->bend_delete))
912 yaz_log (LOG_DEBUG, "Delete handler installed");
913 if ((assoc->init->bend_scan))
914 yaz_log (LOG_DEBUG, "Scan handler installed");
915 if ((assoc->init->bend_segment))
916 yaz_log (LOG_DEBUG, "Segment handler installed");
918 resp->referenceId = req->referenceId;
920 /* let's tell the client what we can do */
921 if (ODR_MASK_GET(req->options, Z_Options_search))
923 ODR_MASK_SET(resp->options, Z_Options_search);
924 strcat(options, "srch");
926 if (ODR_MASK_GET(req->options, Z_Options_present))
928 ODR_MASK_SET(resp->options, Z_Options_present);
929 strcat(options, " prst");
931 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
932 assoc->init->bend_delete)
934 ODR_MASK_SET(resp->options, Z_Options_delSet);
935 strcat(options, " del");
937 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
938 assoc->init->bend_esrequest)
940 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
941 strcat (options, " extendedServices");
943 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
945 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
946 strcat(options, " namedresults");
948 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
950 ODR_MASK_SET(resp->options, Z_Options_scan);
951 strcat(options, " scan");
953 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
955 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
956 strcat(options, " concurop");
958 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
960 ODR_MASK_SET(resp->options, Z_Options_sort);
961 strcat(options, " sort");
963 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
965 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
966 assoc->version = 2; /* 1 & 2 are equivalent */
968 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
970 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
973 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
975 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
978 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
979 assoc->maximumRecordSize = *req->maximumRecordSize;
980 if (assoc->maximumRecordSize > control_block->maxrecordsize)
981 assoc->maximumRecordSize = control_block->maxrecordsize;
982 assoc->preferredMessageSize = *req->preferredMessageSize;
983 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
984 assoc->preferredMessageSize = assoc->maximumRecordSize;
985 resp->preferredMessageSize = &assoc->preferredMessageSize;
986 resp->maximumRecordSize = &assoc->maximumRecordSize;
988 resp->implementationName = "GFS";
990 if (assoc->init->implementation_name)
993 odr_malloc (assoc->encode,
994 strlen(assoc->init->implementation_name) + 10 +
995 strlen(resp->implementationName));
996 sprintf (nv, "%s / %s",
997 resp->implementationName, assoc->init->implementation_name);
998 resp->implementationName = nv;
1000 if (assoc->init->implementation_version)
1003 odr_malloc (assoc->encode,
1004 strlen(assoc->init->implementation_version) + 10 +
1005 strlen(resp->implementationVersion));
1006 sprintf (nv, "YAZ %s / %s",
1007 resp->implementationVersion,
1008 assoc->init->implementation_version);
1009 resp->implementationVersion = nv;
1012 if (binitres->errcode)
1014 yaz_log(LOG_LOG, "Connection rejected by backend.");
1016 assoc->state = ASSOC_DEAD;
1019 assoc->state = ASSOC_UP;
1024 * These functions should be merged.
1027 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo)
1030 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1031 dr->u.v2Addinfo = addinfo ? addinfo : "";
1033 dr->which = Z_DiagForm_v2AddInfo;
1034 dr->addinfo = addinfo ? addinfo : "";
1039 * nonsurrogate diagnostic record.
1041 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
1044 Z_Records *rec = (Z_Records *)
1045 odr_malloc (assoc->encode, sizeof(*rec));
1048 odr_malloc (assoc->encode, sizeof(*err));
1049 Z_DiagRec *drec = (Z_DiagRec *)
1050 odr_malloc (assoc->encode, sizeof(*drec));
1051 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1052 odr_malloc (assoc->encode, sizeof(*dr));
1054 bib1.proto = assoc->proto;
1055 bib1.oclass = CLASS_DIAGSET;
1056 bib1.value = VAL_BIB1;
1058 yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
1061 rec->which = Z_Records_NSD;
1063 rec->u.nonSurrogateDiagnostic = dr;
1065 rec->u.nonSurrogateDiagnostic = drec;
1066 drec->which = Z_DiagRec_defaultFormat;
1067 drec->u.defaultFormat = dr;
1069 dr->diagnosticSetId =
1070 odr_oiddup (assoc->encode, oid_ent_to_oid(&bib1, oid));
1071 dr->condition = err;
1072 set_addinfo (dr, addinfo);
1077 * surrogate diagnostic.
1079 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1080 int error, char *addinfo)
1083 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1084 odr_malloc (assoc->encode, sizeof(*rec));
1085 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1087 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1088 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1089 odr_malloc (assoc->encode, sizeof(*dr));
1091 bib1.proto = assoc->proto;
1092 bib1.oclass = CLASS_DIAGSET;
1093 bib1.value = VAL_BIB1;
1095 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1097 rec->databaseName = dbname;
1098 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1099 rec->u.surrogateDiagnostic = drec;
1100 drec->which = Z_DiagRec_defaultFormat;
1101 drec->u.defaultFormat = dr;
1102 dr->diagnosticSetId = odr_oiddup (assoc->encode,
1103 oid_ent_to_oid(&bib1, oid));
1104 dr->condition = err;
1105 set_addinfo (dr, addinfo);
1111 * multiple nonsurrogate diagnostics.
1113 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1116 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1117 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1119 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1120 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1121 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)odr_malloc (assoc->encode, sizeof(*rec));
1123 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1124 bib1.proto = assoc->proto;
1125 bib1.oclass = CLASS_DIAGSET;
1126 bib1.value = VAL_BIB1;
1129 recs->num_diagRecs = 1;
1130 recs->diagRecs = recp;
1132 drec->which = Z_DiagRec_defaultFormat;
1133 drec->u.defaultFormat = rec;
1135 rec->diagnosticSetId = odr_oiddup (assoc->encode,
1136 oid_ent_to_oid(&bib1, oid));
1137 rec->condition = err;
1140 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1141 rec->u.v2Addinfo = addinfo ? addinfo : "";
1143 rec->which = Z_DiagForm_v2AddInfo;
1144 rec->addinfo = addinfo ? addinfo : "";
1149 static Z_Records *pack_records(association *a, char *setname, int start,
1150 int *num, Z_RecordComposition *comp,
1151 int *next, int *pres, oid_value format,
1152 Z_ReferenceId *referenceId,
1155 int recno, total_length = 0, toget = *num, dumped_records = 0;
1156 Z_Records *records =
1157 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1158 Z_NamePlusRecordList *reclist =
1159 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1160 Z_NamePlusRecord **list =
1161 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1163 records->which = Z_Records_DBOSD;
1164 records->u.databaseOrSurDiagnostics = reclist;
1165 reclist->num_records = 0;
1166 reclist->records = list;
1167 *pres = Z_PRES_SUCCESS;
1171 yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
1172 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1173 a->maximumRecordSize);
1174 for (recno = start; reclist->num_records < toget; recno++)
1177 Z_NamePlusRecord *thisrec;
1178 int this_length = 0;
1180 * we get the number of bytes allocated on the stream before any
1181 * allocation done by the backend - this should give us a reasonable
1182 * idea of the total size of the data so far.
1184 total_length = odr_total(a->encode) - dumped_records;
1190 freq.last_in_set = 0;
1191 freq.setname = setname;
1192 freq.surrogate_flag = 0;
1193 freq.number = recno;
1195 freq.request_format = format;
1196 freq.request_format_raw = oid;
1197 freq.output_format = format;
1198 freq.output_format_raw = 0;
1199 freq.stream = a->encode;
1200 freq.print = a->print;
1201 freq.surrogate_flag = 0;
1202 freq.referenceId = referenceId;
1203 (*a->init->bend_fetch)(a->backend, &freq);
1204 /* backend should be able to signal whether error is system-wide
1205 or only pertaining to current record */
1208 if (!freq.surrogate_flag)
1210 *pres = Z_PRES_FAILURE;
1211 return diagrec(a, freq.errcode, freq.errstring);
1213 reclist->records[reclist->num_records] =
1214 surrogatediagrec(a, freq.basename, freq.errcode,
1216 reclist->num_records++;
1217 *next = freq.last_in_set ? 0 : recno + 1;
1221 this_length = freq.len;
1223 this_length = odr_total(a->encode) - total_length;
1224 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1225 this_length, total_length);
1226 if (this_length + total_length > a->preferredMessageSize)
1228 /* record is small enough, really */
1229 if (this_length <= a->preferredMessageSize)
1231 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1232 *pres = Z_PRES_PARTIAL_2;
1235 /* record can only be fetched by itself */
1236 if (this_length < a->maximumRecordSize)
1238 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1241 yaz_log(LOG_DEBUG, " Dropped it");
1242 reclist->records[reclist->num_records] =
1243 surrogatediagrec(a, freq.basename, 16, 0);
1244 reclist->num_records++;
1245 *next = freq.last_in_set ? 0 : recno + 1;
1246 dumped_records += this_length;
1250 else /* too big entirely */
1252 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
1253 reclist->records[reclist->num_records] =
1254 surrogatediagrec(a, freq.basename, 17, 0);
1255 reclist->num_records++;
1256 *next = freq.last_in_set ? 0 : recno + 1;
1257 dumped_records += this_length;
1262 if (!(thisrec = (Z_NamePlusRecord *)
1263 odr_malloc(a->encode, sizeof(*thisrec))))
1265 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1266 strlen(freq.basename) + 1)))
1268 strcpy(thisrec->databaseName, freq.basename);
1269 thisrec->which = Z_NamePlusRecord_databaseRecord;
1271 if (freq.output_format_raw)
1273 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
1274 freq.output_format = ident->value;
1276 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
1277 freq.record, freq.len);
1278 if (!thisrec->u.databaseRecord)
1280 reclist->records[reclist->num_records] = thisrec;
1281 reclist->num_records++;
1282 *next = freq.last_in_set ? 0 : recno + 1;
1284 *num = reclist->num_records;
1288 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1291 Z_SearchRequest *req = reqb->request->u.searchRequest;
1292 bend_search_rr *bsrr =
1293 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1295 yaz_log(LOG_LOG, "Got SearchRequest.");
1297 bsrr->request = reqb;
1298 bsrr->association = assoc;
1299 bsrr->referenceId = req->referenceId;
1300 save_referenceId (reqb, bsrr->referenceId);
1302 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1303 if (req->databaseNames)
1306 for (i = 0; i < req->num_databaseNames; i++)
1307 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1309 switch (req->query->which)
1311 case Z_Query_type_1: case Z_Query_type_101:
1312 log_rpn_query (req->query->u.type_1);
1314 if (assoc->init->bend_search)
1316 bsrr->setname = req->resultSetName;
1317 bsrr->replace_set = *req->replaceIndicator;
1318 bsrr->num_bases = req->num_databaseNames;
1319 bsrr->basenames = req->databaseNames;
1320 bsrr->query = req->query;
1321 bsrr->stream = assoc->encode;
1322 bsrr->decode = assoc->decode;
1323 bsrr->print = assoc->print;
1326 bsrr->errstring = NULL;
1327 (assoc->init->bend_search)(assoc->backend, bsrr);
1334 bend_searchrequest bsrq;
1335 bend_searchresult *bsrt;
1337 bsrq.setname = req->resultSetName;
1338 bsrq.replace_set = *req->replaceIndicator;
1339 bsrq.num_bases = req->num_databaseNames;
1340 bsrq.basenames = req->databaseNames;
1341 bsrq.query = req->query;
1342 bsrq.referenceId = req->referenceId;
1343 bsrq.stream = assoc->encode;
1344 bsrq.decode = assoc->decode;
1345 bsrq.print = assoc->print;
1346 if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1348 bsrr->hits = bsrt->hits;
1349 bsrr->errcode = bsrt->errcode;
1350 bsrr->errstring = bsrt->errstring;
1353 return response_searchRequest(assoc, reqb, bsrr, fd);
1356 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1359 * Prepare a searchresponse based on the backend results. We probably want
1360 * to look at making the fetching of records nonblocking as well, but
1361 * so far, we'll keep things simple.
1362 * If bsrt is null, that means we're called in response to a communications
1363 * event, and we'll have to get the response for ourselves.
1365 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1366 bend_search_rr *bsrt, int *fd)
1368 Z_SearchRequest *req = reqb->request->u.searchRequest;
1369 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1370 Z_SearchResponse *resp = (Z_SearchResponse *)
1371 odr_malloc (assoc->encode, sizeof(*resp));
1372 int *nulint = (int *)odr_malloc (assoc->encode, sizeof(*nulint));
1373 bool_t *sr = (bool_t *)odr_malloc (assoc->encode, sizeof(*sr));
1374 int *next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1375 int *none = (int *)odr_malloc (assoc->encode, sizeof(*none));
1382 apdu->which = Z_APDU_searchResponse;
1383 apdu->u.searchResponse = resp;
1384 resp->referenceId = req->referenceId;
1385 resp->additionalSearchInfo = 0;
1386 resp->otherInfo = 0;
1388 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1390 yaz_log(LOG_FATAL, "Bad result from backend");
1393 else if (bsrt->errcode)
1395 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1396 resp->resultCount = nulint;
1397 resp->numberOfRecordsReturned = nulint;
1398 resp->nextResultSetPosition = nulint;
1399 resp->searchStatus = nulint;
1400 resp->resultSetStatus = none;
1401 resp->presentStatus = 0;
1405 int *toget = (int *)odr_malloc (assoc->encode, sizeof(*toget));
1406 int *presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1407 Z_RecordComposition comp, *compp = 0;
1412 resp->resultCount = &bsrt->hits;
1414 comp.which = Z_RecordComp_simple;
1415 /* how many records does the user agent want, then? */
1416 if (bsrt->hits <= *req->smallSetUpperBound)
1418 *toget = bsrt->hits;
1419 if ((comp.u.simple = req->smallSetElementSetNames))
1422 else if (bsrt->hits < *req->largeSetLowerBound)
1424 *toget = *req->mediumSetPresentNumber;
1425 if (*toget > bsrt->hits)
1426 *toget = bsrt->hits;
1427 if ((comp.u.simple = req->mediumSetElementSetNames))
1433 if (*toget && !resp->records)
1438 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1439 prefformat->oclass != CLASS_RECSYN)
1442 form = prefformat->value;
1443 resp->records = pack_records(assoc, req->resultSetName, 1,
1444 toget, compp, next, presst, form, req->referenceId,
1445 req->preferredRecordSyntax);
1448 resp->numberOfRecordsReturned = toget;
1449 resp->nextResultSetPosition = next;
1450 resp->searchStatus = sr;
1451 resp->resultSetStatus = 0;
1452 resp->presentStatus = presst;
1456 if (*resp->resultCount)
1458 resp->numberOfRecordsReturned = nulint;
1459 resp->nextResultSetPosition = next;
1460 resp->searchStatus = sr;
1461 resp->resultSetStatus = 0;
1462 resp->presentStatus = 0;
1469 * Maybe we got a little over-friendly when we designed bend_fetch to
1470 * get only one record at a time. Some backends can optimise multiple-record
1471 * fetches, and at any rate, there is some overhead involved in
1472 * all that selecting and hopping around. Problem is, of course, that the
1473 * frontend can't know ahead of time how many records it'll need to
1474 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1475 * is downright lousy as a bulk data transfer protocol.
1477 * To start with, we'll do the fetching of records from the backend
1478 * in one operation: To save some trips in and out of the event-handler,
1479 * and to simplify the interface to pack_records. At any rate, asynch
1480 * operation is more fun in operations that have an unpredictable execution
1481 * speed - which is normally more true for search than for present.
1483 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1486 Z_PresentRequest *req = reqb->request->u.presentRequest;
1490 Z_PresentResponse *resp;
1495 yaz_log(LOG_LOG, "Got PresentRequest.");
1497 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1498 prefformat->oclass != CLASS_RECSYN)
1501 form = prefformat->value;
1502 if (assoc->init->bend_present)
1504 bend_present_rr *bprr = (bend_present_rr *)
1505 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1506 bprr->setname = req->resultSetId;
1507 bprr->start = *req->resultSetStartPoint;
1508 bprr->number = *req->numberOfRecordsRequested;
1509 bprr->format = form;
1510 bprr->comp = req->recordComposition;
1511 bprr->referenceId = req->referenceId;
1512 bprr->stream = assoc->encode;
1513 bprr->print = assoc->print;
1514 bprr->request = reqb;
1515 bprr->association = assoc;
1517 bprr->errstring = NULL;
1518 (*assoc->init->bend_present)(assoc->backend, bprr);
1523 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1524 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1525 presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1526 next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1527 num = (int *)odr_malloc (assoc->encode, sizeof(*num));
1530 *num = *req->numberOfRecordsRequested;
1532 apdu->which = Z_APDU_presentResponse;
1533 apdu->u.presentResponse = resp;
1534 resp->referenceId = req->referenceId;
1535 resp->otherInfo = 0;
1538 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1539 num, req->recordComposition, next, presst, form,
1540 req->referenceId, req->preferredRecordSyntax);
1543 resp->numberOfRecordsReturned = num;
1544 resp->presentStatus = presst;
1545 resp->nextResultSetPosition = next;
1551 static int bend_default_scan (void *handle, bend_scan_rr *rr)
1553 bend_scanrequest srq;
1554 bend_scanresult *srs;
1556 srq.num_bases = rr->num_bases;
1557 srq.basenames = rr->basenames;
1558 srq.attributeset = rr->attributeset;
1559 srq.referenceId = rr->referenceId;
1560 srq.term = rr->term;
1561 srq.term_position = rr->term_position;
1562 srq.num_entries = rr->num_entries;
1563 srq.stream = rr->stream;
1564 srq.print = rr->print;
1566 srs = bend_scan(handle, &srq, 0);
1568 rr->term_position = srs->term_position;
1569 rr->num_entries = srs->num_entries;
1570 rr->entries = srs->entries;
1571 rr->status = srs->status;
1572 rr->errcode = srs->errcode;
1573 rr->errstring = srs->errstring;
1579 * Scan was implemented rather in a hurry, and with support for only the basic
1580 * elements of the service in the backend API. Suggestions are welcome.
1582 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1584 Z_ScanRequest *req = reqb->request->u.scanRequest;
1585 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1586 Z_ScanResponse *res = (Z_ScanResponse *)
1587 odr_malloc (assoc->encode, sizeof(*res));
1588 int *scanStatus = (int *)
1589 odr_malloc (assoc->encode, sizeof(*scanStatus));
1590 int *numberOfEntriesReturned = (int *)
1591 odr_malloc (assoc->encode, sizeof(*numberOfEntriesReturned));
1592 Z_ListEntries *ents = (Z_ListEntries *)
1593 odr_malloc (assoc->encode, sizeof(*ents));
1594 Z_DiagRecs *diagrecs_p = NULL;
1598 yaz_log(LOG_LOG, "Got ScanRequest");
1599 *scanStatus = Z_Scan_failure;
1600 *numberOfEntriesReturned = 0;
1602 apdu->which = Z_APDU_scanResponse;
1603 apdu->u.scanResponse = res;
1604 res->referenceId = req->referenceId;
1606 res->scanStatus = scanStatus;
1607 res->numberOfEntriesReturned = numberOfEntriesReturned;
1608 res->positionOfTerm = 0;
1609 res->entries = ents;
1610 ents->num_entries = 0;
1611 ents->entries = NULL;
1612 ents->num_nonsurrogateDiagnostics = 0;
1613 ents->nonsurrogateDiagnostics = NULL;
1614 res->attributeSet = 0;
1617 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1618 attent->oclass != CLASS_ATTSET
1619 || attent->value != VAL_BIB1))
1620 diagrecs_p = diagrecs(assoc, 121, 0);
1621 else if (req->stepSize && *req->stepSize > 0)
1622 diagrecs_p = diagrecs(assoc, 205, 0);
1625 bend_scan_rr *bsrr = (bend_scan_rr *)
1626 odr_malloc (assoc->encode, sizeof(*bsrr));
1627 if (req->databaseNames)
1630 for (i = 0; i < req->num_databaseNames; i++)
1631 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1633 bsrr->num_bases = req->num_databaseNames;
1634 bsrr->basenames = req->databaseNames;
1635 bsrr->num_entries = *req->numberOfTermsRequested;
1636 bsrr->term = req->termListAndStartPoint;
1637 bsrr->referenceId = req->referenceId;
1638 bsrr->stream = assoc->encode;
1639 bsrr->print = assoc->print;
1640 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1641 attset->oclass != CLASS_RECSYN)
1642 bsrr->attributeset = VAL_NONE;
1644 bsrr->attributeset = attset->value;
1645 log_scan_term (req->termListAndStartPoint, attset->value);
1646 bsrr->term_position = req->preferredPositionInResponse ?
1647 *req->preferredPositionInResponse : 1;
1648 ((int (*)(void *, bend_scan_rr *))
1649 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1651 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1655 Z_Entry **tab = (Z_Entry **)
1656 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1658 if (bsrr->status == BEND_SCAN_PARTIAL)
1659 *scanStatus = Z_Scan_partial_5;
1661 *scanStatus = Z_Scan_success;
1662 ents->entries = tab;
1663 ents->num_entries = bsrr->num_entries;
1664 res->numberOfEntriesReturned = &ents->num_entries;
1665 res->positionOfTerm = &bsrr->term_position;
1666 for (i = 0; i < bsrr->num_entries; i++)
1672 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1673 if (bsrr->entries[i].occurrences >= 0)
1675 e->which = Z_Entry_termInfo;
1676 e->u.termInfo = t = (Z_TermInfo *)
1677 odr_malloc(assoc->encode, sizeof(*t));
1678 t->suggestedAttributes = 0;
1680 t->alternativeTerm = 0;
1681 t->byAttributes = 0;
1682 t->otherTermInfo = 0;
1683 t->globalOccurrences = &bsrr->entries[i].occurrences;
1684 t->term = (Z_Term *)
1685 odr_malloc(assoc->encode, sizeof(*t->term));
1686 t->term->which = Z_Term_general;
1687 t->term->u.general = o =
1688 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1689 o->buf = (unsigned char *)
1690 odr_malloc(assoc->encode, o->len = o->size =
1691 strlen(bsrr->entries[i].term));
1692 memcpy(o->buf, bsrr->entries[i].term, o->len);
1693 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1694 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1698 Z_DiagRecs *drecs = diagrecs (assoc,
1699 bsrr->entries[i].errcode,
1700 bsrr->entries[i].errstring);
1701 assert (drecs->num_diagRecs == 1);
1702 e->which = Z_Entry_surrogateDiagnostic;
1703 assert (drecs->diagRecs[0]);
1704 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1711 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1712 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1717 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1720 Z_SortRequest *req = reqb->request->u.sortRequest;
1721 Z_SortResponse *res = (Z_SortResponse *)
1722 odr_malloc (assoc->encode, sizeof(*res));
1723 bend_sort_rr *bsrr = (bend_sort_rr *)
1724 odr_malloc (assoc->encode, sizeof(*bsrr));
1726 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1728 yaz_log(LOG_LOG, "Got SortRequest.");
1731 bsrr->num_input_setnames = req->num_inputResultSetNames;
1732 bsrr->input_setnames = req->inputResultSetNames;
1734 bsrr->num_input_setnames = req->inputResultSetNames->num_strings;
1735 bsrr->input_setnames = req->inputResultSetNames->strings;
1737 bsrr->referenceId = req->referenceId;
1738 bsrr->output_setname = req->sortedResultSetName;
1739 bsrr->sort_sequence = req->sortSequence;
1740 bsrr->stream = assoc->encode;
1741 bsrr->print = assoc->print;
1743 bsrr->sort_status = Z_SortStatus_failure;
1745 bsrr->errstring = 0;
1747 (*assoc->init->bend_sort)(assoc->backend, bsrr);
1749 res->referenceId = bsrr->referenceId;
1750 res->sortStatus = (int *)
1751 odr_malloc (assoc->encode, sizeof(*res->sortStatus));
1752 *res->sortStatus = bsrr->sort_status;
1753 res->resultSetStatus = 0;
1756 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1758 res->diagnostics = dr->diagRecs;
1759 res->num_diagnostics = dr->num_diagRecs;
1761 res->diagnostics = dr;
1767 res->num_diagnostics = 0;
1769 res->diagnostics = 0;
1773 apdu->which = Z_APDU_sortResponse;
1774 apdu->u.sortResponse = res;
1778 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1781 Z_DeleteResultSetRequest *req = reqb->request->u.deleteResultSetRequest;
1782 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1783 odr_malloc (assoc->encode, sizeof(*res));
1784 bend_delete_rr *bdrr = (bend_delete_rr *)
1785 odr_malloc (assoc->encode, sizeof(*bdrr));
1786 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1788 yaz_log(LOG_LOG, "Got DeleteRequest.");
1790 bdrr->num_setnames = req->num_resultSetList;
1791 bdrr->setnames = req->resultSetList;
1792 bdrr->stream = assoc->encode;
1793 bdrr->print = assoc->print;
1794 bdrr->function = *req->deleteFunction;
1795 bdrr->referenceId = req->referenceId;
1797 if (bdrr->num_setnames > 0)
1800 bdrr->statuses = odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1801 bdrr->num_setnames);
1802 for (i = 0; i < bdrr->num_setnames; i++)
1803 bdrr->statuses[i] = 0;
1805 (*assoc->init->bend_delete)(assoc->backend, bdrr);
1807 res->referenceId = req->referenceId;
1809 res->deleteOperationStatus = (int *)
1810 odr_malloc (assoc->encode, sizeof(*res->deleteOperationStatus));
1811 *res->deleteOperationStatus = bdrr->delete_status;
1813 res->deleteListStatuses = 0;
1814 if (bdrr->num_setnames > 0)
1817 res->deleteListStatuses = odr_malloc(assoc->encode,
1818 sizeof(*res->deleteListStatuses));
1819 res->deleteListStatuses->num = bdrr->num_setnames;
1820 res->deleteListStatuses->elements =
1821 odr_malloc (assoc->encode,
1822 sizeof(*res->deleteListStatuses->elements) *
1823 bdrr->num_setnames);
1824 for (i = 0; i<bdrr->num_setnames; i++)
1826 res->deleteListStatuses->elements[i] =
1827 odr_malloc (assoc->encode,
1828 sizeof(**res->deleteListStatuses->elements));
1829 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1830 res->deleteListStatuses->elements[i]->id =
1831 odr_strdup (assoc->encode, bdrr->setnames[i]);
1835 res->numberNotDeleted = 0;
1836 res->bulkStatuses = 0;
1837 res->deleteMessage = 0;
1840 apdu->which = Z_APDU_deleteResultSetResponse;
1841 apdu->u.deleteResultSetResponse = res;
1845 static void process_close(association *assoc, request *reqb)
1847 Z_Close *req = reqb->request->u.close;
1848 static char *reasons[] =
1855 "securityViolation",
1862 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1863 reasons[*req->closeReason], req->diagnosticInformation ?
1864 req->diagnosticInformation : "NULL");
1865 if (assoc->version < 3) /* to make do_force respond with close */
1867 do_close_req(assoc, Z_Close_finished,
1868 "Association terminated by client", reqb);
1871 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1875 reqb->len_refid = refid->len;
1876 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1877 memcpy (reqb->refid, refid->buf, refid->len);
1881 reqb->len_refid = 0;
1886 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1888 process_response (a, req, res);
1891 bend_request bend_request_mk (bend_association a)
1893 request *nreq = request_get (&a->outgoing);
1894 nreq->request_mem = nmem_create ();
1898 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1903 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1904 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1905 id->len = id->size = req->len_refid;
1906 memcpy (id->buf, req->refid, req->len_refid);
1910 void bend_request_destroy (bend_request *req)
1912 nmem_destroy((*req)->request_mem);
1913 request_release(*req);
1917 int bend_backend_respond (bend_association a, bend_request req)
1921 r = process_request (a, req, &msg);
1923 logf (LOG_WARN, "%s", msg);
1927 void bend_request_setdata(bend_request r, void *p)
1932 void *bend_request_getdata(bend_request r)
1934 return r->clientData;
1937 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
1939 bend_segment_rr request;
1941 request.segment = reqb->request->u.segmentRequest;
1942 request.stream = assoc->encode;
1943 request.decode = assoc->decode;
1944 request.print = assoc->print;
1945 request.association = assoc;
1947 (*assoc->init->bend_segment)(assoc->backend, &request);
1952 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
1954 bend_esrequest_rr esrequest;
1956 Z_ExtendedServicesRequest *req = reqb->request->u.extendedServicesRequest;
1957 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
1959 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
1961 yaz_log(LOG_DEBUG,"inside Process esRequest");
1963 esrequest.esr = reqb->request->u.extendedServicesRequest;
1964 esrequest.stream = assoc->encode;
1965 esrequest.decode = assoc->decode;
1966 esrequest.print = assoc->print;
1967 esrequest.errcode = 0;
1968 esrequest.errstring = NULL;
1969 esrequest.request = reqb;
1970 esrequest.association = assoc;
1971 esrequest.referenceId = req->referenceId;
1973 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
1975 /* If the response is being delayed, return NULL */
1976 if (esrequest.request == NULL)
1979 resp->referenceId = req->referenceId;
1981 if (esrequest.errcode == -1)
1983 /* Backend service indicates request will be processed */
1984 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
1985 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
1987 else if (esrequest.errcode == 0)
1989 /* Backend service indicates request will be processed */
1990 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
1991 *resp->operationStatus = Z_ExtendedServicesResponse_done;
1995 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
1996 esrequest.errstring);
1998 /* Backend indicates error, request will not be processed */
1999 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
2000 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
2001 resp->num_diagnostics = diagRecs->num_diagRecs;
2002 resp->diagnostics = diagRecs->diagRecs;
2004 /* Do something with the members of bend_extendedservice */
2006 yaz_log(LOG_DEBUG,"Send the result apdu");