2 * Copyright (c) 1995-2000, Index Data
3 * See the file LICENSE for details.
6 * Revision 1.103 2000-03-20 19:06:25 adam
7 * Added Segment request for fronend server. Work on admin for client.
9 * Revision 1.102 2000/03/15 12:59:49 adam
10 * Added handle member to statserv_control.
12 * Revision 1.101 2000/01/12 14:36:07 adam
13 * Added printing stream (ODR) for backend functions.
15 * Revision 1.100 1999/12/16 23:36:19 adam
16 * Implemented ILL protocol. Minor updates ASN.1 compiler.
18 * Revision 1.99 1999/11/30 13:47:12 adam
19 * Improved installation. Moved header files to include/yaz.
21 * Revision 1.98 1999/11/29 15:12:27 adam
22 * Changed the way implementationName - and version is set.
24 * Revision 1.96 1999/11/04 14:58:44 adam
25 * Added status elements for backend delete result set handler.
26 * Updated delete result result set command for client.
28 * Revision 1.95 1999/10/11 10:01:24 adam
29 * Implemented bend_sort_rr handler for frontend server.
31 * Revision 1.94 1999/08/27 09:40:32 adam
32 * Renamed logf function to yaz_log. Removed VC++ project files.
34 * Revision 1.93 1999/07/06 12:17:15 adam
35 * Added option -1 that runs server once (for profiling purposes).
37 * Revision 1.92 1999/06/17 10:54:45 adam
38 * Added facility to specify implementation version - and name
41 * Revision 1.91 1999/06/01 14:29:12 adam
42 * Work on Extended Services.
44 * Revision 1.90 1999/05/27 13:02:20 adam
45 * Assigned OID for old DB Update (VAL_DBUPDATE0).
47 * Revision 1.89 1999/05/26 15:24:26 adam
48 * Fixed minor bugs regarding DB Update (introduced by previous commit).
50 * Revision 1.88 1999/04/20 09:56:48 adam
51 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
52 * Modified all encoders/decoders to reflect this change.
54 * Revision 1.87 1999/03/31 11:18:25 adam
55 * Implemented odr_strdup. Added Reference ID to backend server API.
57 * Revision 1.86 1999/02/02 13:57:38 adam
58 * Uses preprocessor define WIN32 instead of WINDOWS to build code
59 * for Microsoft WIN32.
61 * Revision 1.85 1998/11/17 09:52:59 adam
62 * Fixed minor bug (introduced by previous commit).
64 * Revision 1.84 1998/11/16 16:02:32 adam
65 * Added loggin utilies, log_rpn_query and log_scan_term. These used
66 * to be part of Zebra.
68 * Revision 1.83 1998/11/03 10:09:36 adam
69 * Fixed bug regarding YC.
71 * Revision 1.82 1998/10/20 14:00:30 quinn
74 * Revision 1.81 1998/10/13 16:12:24 adam
75 * Added support for Surrogate Diagnostics for Scan Term entries.
77 * Revision 1.80 1998/09/02 12:41:53 adam
78 * Added decode stream in bend search structures.
80 * Revision 1.79 1998/08/19 16:10:08 adam
81 * Changed som member names of DeleteResultSetRequest/Response.
83 * Revision 1.78 1998/08/03 10:23:55 adam
84 * Fixed bug regarding Options for Sort.
86 * Revision 1.77 1998/07/20 12:38:42 adam
87 * Implemented delete result set service to server API.
89 * Revision 1.76 1998/05/27 16:57:07 adam
90 * Support for surrogate diagnostic records added for bend_fetch.
92 * Revision 1.75 1998/05/18 10:13:07 adam
93 * Fixed call to es_request handler - extra argument was passed.
95 * Revision 1.74 1998/03/31 15:13:20 adam
96 * Development towards compiled ASN.1.
98 * Revision 1.73 1998/03/31 11:07:45 adam
99 * Furhter work on UNIverse resource report.
100 * Added Extended Services handling in frontend server.
102 * Revision 1.72 1998/02/11 11:53:35 adam
103 * Changed code so that it compiles as C++.
105 * Revision 1.71 1998/02/10 11:03:57 adam
106 * Added support for extended handlers in backend server interface.
108 * Revision 1.70 1998/01/29 13:15:35 adam
109 * Implemented sort for the backend interface.
111 * Revision 1.69 1997/09/30 11:48:12 adam
112 * Fixed bug introduced by previous commit.
114 * Revision 1.68 1997/09/29 13:18:59 adam
115 * Added function, oid_ent_to_oid, to replace the function
116 * oid_getoidbyent, which is not thread safe.
118 * Revision 1.67 1997/09/17 12:10:40 adam
121 * Revision 1.66 1997/09/05 15:26:44 adam
122 * Added ODR encode in search and scen bend request structures.
123 * Fixed a few enums that caused trouble with C++.
125 * Revision 1.65 1997/09/01 08:53:01 adam
126 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
127 * moved a separate directory. MSV5.0 project server.dsp created.
128 * As an option, the server can now operate as an NT service.
130 * Revision 1.64 1997/04/30 08:52:11 quinn
133 * Revision 1.63 1996/10/11 11:57:26 quinn
136 * Revision 1.62 1996/07/06 19:58:35 quinn
137 * System headerfiles gathered in yconfig
139 * Revision 1.61 1996/06/10 08:56:16 quinn
142 * Revision 1.60 1996/05/30 11:03:10 quinn
143 * Fixed NextresultSetPosition bug fixed.
145 * Revision 1.59 1996/05/14 09:26:46 quinn
146 * Added attribute set to scan backend
148 * Revision 1.58 1996/02/20 12:53:04 quinn
151 * Revision 1.57 1996/01/02 08:57:47 quinn
152 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
154 * Revision 1.56 1995/12/14 11:09:57 quinn
157 * Revision 1.55 1995/11/08 17:41:37 quinn
160 * Revision 1.54 1995/11/08 15:11:29 quinn
161 * Log of close transmit.
163 * Revision 1.53 1995/11/01 13:54:58 quinn
166 * Revision 1.52 1995/11/01 12:19:13 quinn
167 * Second attempt to fix same bug.
169 * Revision 1.50 1995/10/25 16:58:32 quinn
172 * Revision 1.49 1995/10/16 13:51:53 quinn
173 * Changes to provide Especs to the backend.
175 * Revision 1.48 1995/10/06 08:51:20 quinn
176 * Added Write-buffer.
178 * Revision 1.47 1995/08/29 14:24:16 quinn
179 * Added second half of close-handshake
181 * Revision 1.46 1995/08/29 11:17:58 quinn
182 * Added code to receive close
184 * Revision 1.45 1995/08/21 09:11:00 quinn
185 * Smallish fixes to suppport new formats.
187 * Revision 1.44 1995/08/17 12:45:25 quinn
188 * Fixed minor problems with GRS-1. Added support in c&s.
190 * Revision 1.43 1995/08/15 12:00:31 quinn
193 * Revision 1.42 1995/08/15 11:16:50 quinn
195 * Revision 1.41 1995/08/02 10:23:06 quinn
198 * Revision 1.40 1995/07/31 14:34:26 quinn
199 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
201 * Revision 1.39 1995/06/27 13:21:00 quinn
204 * Revision 1.38 1995/06/19 12:39:11 quinn
205 * Fixed bug in timeout code. Added BER dumper.
207 * Revision 1.37 1995/06/16 13:16:14 quinn
208 * Fixed Defaultdiagformat.
210 * Revision 1.36 1995/06/16 10:31:36 quinn
211 * Added session timeout.
213 * Revision 1.35 1995/06/15 07:45:14 quinn
216 * Revision 1.34 1995/06/14 15:26:46 quinn
217 * *** empty log message ***
219 * Revision 1.33 1995/06/06 14:57:05 quinn
220 * Better diagnostics.
222 * Revision 1.32 1995/06/06 08:41:44 quinn
223 * Better diagnostics.
225 * Revision 1.31 1995/06/06 08:15:37 quinn
228 * Revision 1.30 1995/06/05 10:53:32 quinn
229 * Added a better SCAN.
231 * Revision 1.29 1995/06/01 11:25:03 quinn
234 * Revision 1.28 1995/06/01 11:21:01 quinn
235 * Attempting to fix a bug in pack-records. replaced break with continue
236 * for large records, according to standard.
238 * Revision 1.27 1995/05/29 08:12:06 quinn
241 * Revision 1.26 1995/05/18 13:02:12 quinn
244 * Revision 1.25 1995/05/17 08:42:26 quinn
245 * Transfer auth info to backend. Allow backend to reject init gracefully.
247 * Revision 1.24 1995/05/16 08:51:04 quinn
248 * License, documentation, and memory fixes
250 * Revision 1.23 1995/05/15 13:25:10 quinn
253 * Revision 1.22 1995/05/15 11:56:39 quinn
254 * Asynchronous facilities. Restructuring of seshigh code.
256 * Revision 1.21 1995/05/02 08:53:19 quinn
257 * Trying in vain to fix comm with ISODE
259 * Revision 1.20 1995/04/20 15:13:00 quinn
262 * Revision 1.19 1995/04/18 08:15:34 quinn
263 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
264 * neater. We'll make the same change for decoding one day.
266 * Revision 1.18 1995/04/17 11:28:25 quinn
269 * Revision 1.17 1995/04/10 10:23:36 quinn
270 * Some work to add scan and other things.
272 * Revision 1.16 1995/03/31 09:18:55 quinn
275 * Revision 1.15 1995/03/30 14:03:23 quinn
276 * Added RFC1006 as separate library
278 * Revision 1.14 1995/03/30 12:18:17 quinn
281 * Revision 1.13 1995/03/30 09:09:24 quinn
282 * Added state-handle and some support for asynchronous activities.
284 * Revision 1.12 1995/03/29 15:40:16 quinn
285 * Ongoing work. Statserv is now dynamic by default
287 * Revision 1.11 1995/03/28 09:16:21 quinn
288 * Added record packing to the search request
290 * Revision 1.10 1995/03/27 08:34:24 quinn
291 * Added dynamic server functionality.
292 * Released bindings to session.c (is now redundant)
294 * Revision 1.9 1995/03/22 15:01:26 quinn
295 * Adjusting record packing.
297 * Revision 1.8 1995/03/22 10:13:21 quinn
298 * Working on record packer
300 * Revision 1.7 1995/03/21 15:53:31 quinn
303 * Revision 1.6 1995/03/21 12:30:09 quinn
304 * Beginning to add support for record packing.
306 * Revision 1.5 1995/03/17 10:44:13 quinn
307 * Added catch of null-string in makediagrec
309 * Revision 1.4 1995/03/17 10:18:08 quinn
310 * Added memory management.
312 * Revision 1.3 1995/03/16 17:42:39 quinn
315 * Revision 1.2 1995/03/16 13:29:01 quinn
316 * Partitioned server.
318 * Revision 1.1 1995/03/15 16:02:10 quinn
319 * Modded session.c to seshigh.c
324 * Frontend server logic.
326 * This code receives incoming APDUs, and handles client requests by means
327 * of the backend API.
329 * Some of the code is getting quite involved, compared to simpler servers -
330 * primarily because it is asynchronous both in the communication with
331 * the user and the backend. We think the complexity will pay off in
332 * the form of greater flexibility when more asynchronous facilities
335 * Memory management has become somewhat involved. In the simple case, where
336 * only one PDU is pending at a time, it will simply reuse the same memory,
337 * once it has found its working size. When we enable multiple concurrent
338 * operations, perhaps even with multiple parallel calls to the backend, it
339 * will maintain a pool of buffers for encoding and decoding, trying to
340 * minimize memory allocation/deallocation during normal operation.
342 * TODOs include (and will be done in order of public interest):
344 * Support for EXPLAIN - provide simple meta-database system.
345 * Support for access control.
346 * Support for resource control.
347 * Support for extended services - primarily Item Order.
348 * Rest of Z39.50-1994
361 #include <yaz/yconfig.h>
362 #include <yaz/xmalloc.h>
363 #include <yaz/comstack.h>
366 #include <yaz/proto.h>
369 #include <yaz/logrpn.h>
370 #include <yaz/statserv.h>
372 #include <yaz/backend.h>
374 static int process_request(association *assoc, request *req, char **msg);
375 void backend_response(IOCHAN i, int event);
376 static int process_response(association *assoc, request *req, Z_APDU *res);
377 static Z_APDU *process_initRequest(association *assoc, request *reqb);
378 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
380 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
381 bend_search_rr *bsrr, int *fd);
382 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
384 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
385 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
386 static void process_close(association *assoc, request *reqb);
387 void save_referenceId (request *reqb, Z_ReferenceId *refid);
388 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
390 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
391 static int bend_default_scan (void *handle, bend_scan_rr *rr);
393 static FILE *apduf = 0; /* for use in static mode */
394 static statserv_options_block *control_block = 0;
396 /* Chas: Added in from DALI */
397 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
398 /* Chas: End of addition from DALI */
401 * Create and initialize a new association-handle.
402 * channel : iochannel for the current line.
403 * link : communications channel.
404 * Returns: 0 or a new association handle.
406 association *create_association(IOCHAN channel, COMSTACK link)
411 control_block = statserv_getcontrol();
412 if (!(anew = (association *)xmalloc(sizeof(*anew))))
414 anew->client_chan = channel;
415 anew->client_link = link;
416 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
417 !(anew->encode = odr_createmem(ODR_ENCODE)))
419 if (*control_block->apdufile)
424 strcpy(filename, control_block->apdufile);
425 if (!(anew->print = odr_createmem(ODR_PRINT)))
427 if (*control_block->apdufile != '-')
429 strcpy(filename, control_block->apdufile);
430 if (!control_block->dynamic)
434 if (!(apduf = fopen(filename, "w")))
436 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
439 setvbuf(apduf, 0, _IONBF, 0);
445 sprintf(filename + strlen(filename), ".%d", getpid());
446 if (!(f = fopen(filename, "w")))
448 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
451 setvbuf(f, 0, _IONBF, 0);
453 odr_setprint(anew->print, f);
458 anew->input_buffer = 0;
459 anew->input_buffer_len = 0;
461 anew->state = ASSOC_NEW;
462 request_initq(&anew->incoming);
463 request_initq(&anew->outgoing);
464 anew->proto = cs_getproto(link);
469 * Free association and release resources.
471 void destroy_association(association *h)
473 odr_destroy(h->decode);
474 odr_destroy(h->encode);
476 odr_destroy(h->print);
478 xfree(h->input_buffer);
480 bend_close(h->backend);
481 while (request_deq(&h->incoming));
482 while (request_deq(&h->outgoing));
483 request_delq(&h->incoming);
484 request_delq(&h->outgoing);
486 if (control_block && control_block->one_shot)
490 static void do_close_req(association *a, int reason, char *message,
494 Z_Close *cls = zget_Close(a->encode);
496 /* Purge request queue */
497 while (request_deq(&a->incoming));
498 while (request_deq(&a->outgoing));
501 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
502 reason, message ? message : "none");
503 apdu.which = Z_APDU_close;
505 *cls->closeReason = reason;
506 cls->diagnosticInformation = message;
507 process_response(a, req, &apdu);
508 iochan_settimeout(a->client_chan, 60);
512 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
513 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
515 a->state = ASSOC_DEAD;
518 static void do_close(association *a, int reason, char *message)
520 do_close_req (a, reason, message, request_get(&a->outgoing));
524 * This is where PDUs from the client are read and the further
525 * processing is initiated. Flow of control moves down through the
526 * various process_* functions below, until the encoded result comes back up
527 * to the output handler in here.
529 * h : the I/O channel that has an outstanding event.
530 * event : the current outstanding event.
532 void ir_session(IOCHAN h, int event)
535 association *assoc = (association *)iochan_getdata(h);
536 COMSTACK conn = assoc->client_link;
539 assert(h && conn && assoc);
540 if (event == EVENT_TIMEOUT)
542 if (assoc->state != ASSOC_UP)
544 yaz_log(LOG_LOG, "Final timeout - closing connection.");
546 destroy_association(assoc);
551 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
552 do_close(assoc, Z_Close_lackOfActivity, 0);
556 if (event & EVENT_INPUT || event & EVENT_WORK) /* input */
558 if (event & EVENT_INPUT)
560 yaz_log(LOG_DEBUG, "ir_session (input)");
561 assert(assoc && conn);
562 /* We aren't speaking to this fellow */
563 if (assoc->state == ASSOC_DEAD)
565 yaz_log(LOG_LOG, "Closed connection after reject");
567 destroy_association(assoc);
571 if ((res = cs_get(conn, &assoc->input_buffer,
572 &assoc->input_buffer_len)) <= 0)
574 yaz_log(LOG_LOG, "Connection closed by client");
576 destroy_association(assoc);
580 else if (res == 1) /* incomplete read - wait for more */
582 if (cs_more(conn)) /* more stuff - call us again later, please */
583 iochan_setevent(h, EVENT_INPUT);
585 /* we got a complete PDU. Let's decode it */
586 yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
587 req = request_get(&assoc->incoming); /* get a new request structure */
588 odr_reset(assoc->decode);
589 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
590 if (!z_APDU(assoc->decode, &req->request, 0, 0))
592 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
593 odr_errmsg(odr_geterror(assoc->decode)),
594 odr_offset(assoc->decode));
595 yaz_log(LOG_LOG, "PDU dump:");
596 odr_dumpBER(log_file(), assoc->input_buffer, res);
597 do_close(assoc, Z_Close_protocolError, "Malformed package");
600 req->request_mem = odr_extract_mem(assoc->decode);
601 if (assoc->print && !z_APDU(assoc->print, &req->request, 0, 0))
603 yaz_log(LOG_WARN, "ODR print error: %s",
604 odr_errmsg(odr_geterror(assoc->print)));
605 odr_reset(assoc->print);
607 request_enq(&assoc->incoming, req);
610 /* can we do something yet? */
611 req = request_head(&assoc->incoming);
612 if (req->state == REQUEST_IDLE)
615 request_deq(&assoc->incoming);
616 if (process_request(assoc, req, &msg) < 0)
617 do_close_req(assoc, Z_Close_systemProblem, msg, req);
620 if (event & EVENT_OUTPUT)
622 request *req = request_head(&assoc->outgoing);
624 yaz_log(LOG_DEBUG, "ir_session (output)");
625 req->state = REQUEST_PENDING;
626 switch (res = cs_put(conn, req->response, req->len_response))
629 yaz_log(LOG_LOG, "Connection closed by client");
631 destroy_association(assoc);
634 case 0: /* all sent - release the request structure */
635 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
636 nmem_destroy(req->request_mem);
637 request_deq(&assoc->outgoing);
638 request_release(req);
639 if (!request_head(&assoc->outgoing))
640 iochan_clearflag(h, EVENT_OUTPUT);
642 /* value of 1 -- partial send -- is simply ignored */
645 if (event & EVENT_EXCEPT)
647 yaz_log(LOG_DEBUG, "ir_session (exception)");
649 destroy_association(assoc);
655 * Initiate request processing.
657 static int process_request(association *assoc, request *req, char **msg)
663 *msg = "Unknown Error";
664 assert(req && req->state == REQUEST_IDLE);
665 switch (req->request->which)
667 case Z_APDU_initRequest:
668 res = process_initRequest(assoc, req); break;
669 case Z_APDU_searchRequest:
670 res = process_searchRequest(assoc, req, &fd); break;
671 case Z_APDU_presentRequest:
672 res = process_presentRequest(assoc, req, &fd); break;
673 case Z_APDU_scanRequest:
674 if (assoc->bend_scan)
675 res = process_scanRequest(assoc, req, &fd);
678 *msg = "Cannot handle Scan APDU";
682 case Z_APDU_extendedServicesRequest:
683 if (assoc->bend_esrequest)
684 res = process_ESRequest(assoc, req, &fd);
687 *msg = "Cannot handle Extended Services APDU";
691 case Z_APDU_sortRequest:
692 if (assoc->bend_sort)
693 res = process_sortRequest(assoc, req, &fd);
696 *msg = "Cannot handle Sort APDU";
701 process_close(assoc, req);
703 case Z_APDU_deleteResultSetRequest:
704 if (assoc->bend_delete)
705 res = process_deleteRequest(assoc, req, &fd);
708 *msg = "Cannot handle Delete APDU";
712 case Z_APDU_segmentRequest:
713 if (assoc->bend_segment)
715 res = process_segmentRequest (assoc, req);
719 *msg = "Cannot handle Segment APDU";
724 *msg = "Bad APDU received";
729 yaz_log(LOG_DEBUG, " result immediately available");
730 retval = process_response(assoc, req, res);
734 yaz_log(LOG_DEBUG, " result unavailble");
737 else /* no result yet - one will be provided later */
741 /* Set up an I/O handler for the fd supplied by the backend */
743 yaz_log(LOG_DEBUG, " establishing handler for result");
744 req->state = REQUEST_PENDING;
745 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
747 iochan_setdata(chan, assoc);
754 * Handle message from the backend.
756 void backend_response(IOCHAN i, int event)
758 association *assoc = (association *)iochan_getdata(i);
759 request *req = request_head(&assoc->incoming);
763 yaz_log(LOG_DEBUG, "backend_response");
764 assert(assoc && req && req->state != REQUEST_IDLE);
765 /* determine what it is we're waiting for */
766 switch (req->request->which)
768 case Z_APDU_searchRequest:
769 res = response_searchRequest(assoc, req, 0, &fd); break;
771 case Z_APDU_presentRequest:
772 res = response_presentRequest(assoc, req, 0, &fd); break;
773 case Z_APDU_scanRequest:
774 res = response_scanRequest(assoc, req, 0, &fd); break;
777 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
780 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
782 yaz_log(LOG_LOG, "Fatal error when talking to backend");
783 do_close(assoc, Z_Close_systemProblem, 0);
787 else if (!res) /* no result yet - try again later */
789 yaz_log(LOG_DEBUG, " no result yet");
790 iochan_setfd(i, fd); /* in case fd has changed */
795 * Encode response, and transfer the request structure to the outgoing queue.
797 static int process_response(association *assoc, request *req, Z_APDU *res)
799 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
800 if (!z_APDU(assoc->encode, &res, 0, 0))
802 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
803 odr_errmsg(odr_geterror(assoc->decode)));
804 odr_reset(assoc->encode);
807 req->response = odr_getbuf(assoc->encode, &req->len_response,
808 &req->size_response);
809 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
810 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
812 yaz_log(LOG_WARN, "ODR print error: %s",
813 odr_errmsg(odr_geterror(assoc->print)));
814 odr_reset(assoc->print);
816 odr_reset(assoc->encode);
817 req->state = REQUEST_IDLE;
818 request_enq(&assoc->outgoing, req);
819 /* turn the work over to the ir_session handler */
820 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
821 /* Is there more work to be done? give that to the input handler too */
823 if (request_head(&assoc->incoming))
825 yaz_log (LOG_DEBUG, "more work to be done");
826 iochan_setevent(assoc->client_chan, EVENT_WORK);
833 * Handle init request.
834 * At the moment, we don't check the options
835 * anywhere else in the code - we just try not to do anything that would
836 * break a naive client. We'll toss 'em into the association block when
837 * we need them there.
839 static Z_APDU *process_initRequest(association *assoc, request *reqb)
841 Z_InitRequest *req = reqb->request->u.initRequest;
842 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
843 Z_InitResponse *resp = apdu->u.initResponse;
844 bend_initrequest binitreq;
845 bend_initresult *binitres;
848 yaz_log(LOG_LOG, "Got initRequest");
849 if (req->implementationId)
850 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
851 if (req->implementationName)
852 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
853 if (req->implementationVersion)
854 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
856 binitreq.stream = assoc->encode;
857 binitreq.print = assoc->print;
858 binitreq.auth = req->idAuthentication;
859 binitreq.referenceId = req->referenceId;
860 binitreq.implementation_version = 0;
861 binitreq.implementation_name = 0;
862 binitreq.bend_sort = NULL;
863 binitreq.bend_search = NULL;
864 binitreq.bend_present = NULL;
865 binitreq.bend_esrequest = NULL;
866 binitreq.bend_delete = NULL;
867 binitreq.bend_scan = bend_default_scan;
868 binitreq.bend_segment = NULL;
869 if (!(binitres = bend_init(&binitreq)))
871 yaz_log(LOG_WARN, "Bad response from backend.");
875 assoc->backend = binitres->handle;
876 if ((assoc->bend_sort = (int (*)())binitreq.bend_sort))
877 yaz_log (LOG_DEBUG, "Sort handler installed");
878 if ((assoc->bend_search = (int (*)())binitreq.bend_search))
879 yaz_log (LOG_DEBUG, "Search handler installed");
880 if ((assoc->bend_present = (int (*)())binitreq.bend_present))
881 yaz_log (LOG_DEBUG, "Present handler installed");
882 if ((assoc->bend_esrequest = (int (*)())binitreq.bend_esrequest))
883 yaz_log (LOG_DEBUG, "ESRequest handler installed");
884 if ((assoc->bend_delete = (int (*)())binitreq.bend_delete))
885 yaz_log (LOG_DEBUG, "Delete handler installed");
886 if ((assoc->bend_scan = (int (*)())binitreq.bend_scan))
887 yaz_log (LOG_DEBUG, "Scan handler installed");
888 if ((assoc->bend_segment = (int (*)())binitreq.bend_segment))
889 yaz_log (LOG_DEBUG, "Segment handler installed");
891 resp->referenceId = req->referenceId;
893 /* let's tell the client what we can do */
894 if (ODR_MASK_GET(req->options, Z_Options_search))
896 ODR_MASK_SET(resp->options, Z_Options_search);
897 strcat(options, "srch");
899 if (ODR_MASK_GET(req->options, Z_Options_present))
901 ODR_MASK_SET(resp->options, Z_Options_present);
902 strcat(options, " prst");
904 if (ODR_MASK_GET(req->options, Z_Options_delSet) && binitreq.bend_delete)
906 ODR_MASK_SET(resp->options, Z_Options_delSet);
907 strcat(options, " del");
909 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
910 binitreq.bend_esrequest)
912 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
913 strcat (options, " extendedServices");
915 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
917 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
918 strcat(options, " namedresults");
920 if (ODR_MASK_GET(req->options, Z_Options_scan) && binitreq.bend_scan)
922 ODR_MASK_SET(resp->options, Z_Options_scan);
923 strcat(options, " scan");
925 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
927 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
928 strcat(options, " concurop");
930 if (ODR_MASK_GET(req->options, Z_Options_sort) && binitreq.bend_sort)
932 ODR_MASK_SET(resp->options, Z_Options_sort);
933 strcat(options, " sort");
935 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
937 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
938 assoc->version = 2; /* 1 & 2 are equivalent */
940 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
942 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
945 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
947 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
950 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
951 assoc->maximumRecordSize = *req->maximumRecordSize;
952 if (assoc->maximumRecordSize > control_block->maxrecordsize)
953 assoc->maximumRecordSize = control_block->maxrecordsize;
954 assoc->preferredMessageSize = *req->preferredMessageSize;
955 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
956 assoc->preferredMessageSize = assoc->maximumRecordSize;
957 resp->preferredMessageSize = &assoc->preferredMessageSize;
958 resp->maximumRecordSize = &assoc->maximumRecordSize;
960 resp->implementationName = "GFS";
962 if (binitreq.implementation_name)
965 odr_malloc (assoc->encode,
966 strlen(binitreq.implementation_name) + 10 +
967 strlen(resp->implementationName));
968 sprintf (nv, "%s / %s",
969 resp->implementationName, binitreq.implementation_name);
970 resp->implementationName = nv;
972 if (binitreq.implementation_version)
975 odr_malloc (assoc->encode,
976 strlen(binitreq.implementation_version) + 10 +
977 strlen(resp->implementationVersion));
978 sprintf (nv, "YAZ %s / %s",
979 resp->implementationVersion, binitreq.implementation_version);
980 resp->implementationVersion = nv;
983 if (binitres->errcode)
985 yaz_log(LOG_LOG, "Connection rejected by backend.");
987 assoc->state = ASSOC_DEAD;
990 assoc->state = ASSOC_UP;
995 * These functions should be merged.
998 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo)
1001 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1002 dr->u.v2Addinfo = addinfo ? addinfo : "";
1004 dr->which = Z_DiagForm_v2AddInfo;
1005 dr->addinfo = addinfo ? addinfo : "";
1010 * nonsurrogate diagnostic record.
1012 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
1015 Z_Records *rec = (Z_Records *)
1016 odr_malloc (assoc->encode, sizeof(*rec));
1019 odr_malloc (assoc->encode, sizeof(*err));
1020 Z_DiagRec *drec = (Z_DiagRec *)
1021 odr_malloc (assoc->encode, sizeof(*drec));
1022 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1023 odr_malloc (assoc->encode, sizeof(*dr));
1025 bib1.proto = assoc->proto;
1026 bib1.oclass = CLASS_DIAGSET;
1027 bib1.value = VAL_BIB1;
1029 yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
1032 rec->which = Z_Records_NSD;
1034 rec->u.nonSurrogateDiagnostic = dr;
1036 rec->u.nonSurrogateDiagnostic = drec;
1037 drec->which = Z_DiagRec_defaultFormat;
1038 drec->u.defaultFormat = dr;
1040 dr->diagnosticSetId =
1041 odr_oiddup (assoc->encode, oid_ent_to_oid(&bib1, oid));
1042 dr->condition = err;
1043 set_addinfo (dr, addinfo);
1048 * surrogate diagnostic.
1050 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1051 int error, char *addinfo)
1054 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1055 odr_malloc (assoc->encode, sizeof(*rec));
1056 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1058 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1059 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1060 odr_malloc (assoc->encode, sizeof(*dr));
1062 bib1.proto = assoc->proto;
1063 bib1.oclass = CLASS_DIAGSET;
1064 bib1.value = VAL_BIB1;
1066 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1068 rec->databaseName = dbname;
1069 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1070 rec->u.surrogateDiagnostic = drec;
1071 drec->which = Z_DiagRec_defaultFormat;
1072 drec->u.defaultFormat = dr;
1073 dr->diagnosticSetId = odr_oiddup (assoc->encode,
1074 oid_ent_to_oid(&bib1, oid));
1075 dr->condition = err;
1076 set_addinfo (dr, addinfo);
1082 * multiple nonsurrogate diagnostics.
1084 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1087 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1088 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1090 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1091 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1092 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)odr_malloc (assoc->encode, sizeof(*rec));
1094 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1095 bib1.proto = assoc->proto;
1096 bib1.oclass = CLASS_DIAGSET;
1097 bib1.value = VAL_BIB1;
1100 recs->num_diagRecs = 1;
1101 recs->diagRecs = recp;
1103 drec->which = Z_DiagRec_defaultFormat;
1104 drec->u.defaultFormat = rec;
1106 rec->diagnosticSetId = odr_oiddup (assoc->encode,
1107 oid_ent_to_oid(&bib1, oid));
1108 rec->condition = err;
1111 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1112 rec->u.v2Addinfo = addinfo ? addinfo : "";
1114 rec->which = Z_DiagForm_v2AddInfo;
1115 rec->addinfo = addinfo ? addinfo : "";
1120 static Z_Records *pack_records(association *a, char *setname, int start,
1121 int *num, Z_RecordComposition *comp,
1122 int *next, int *pres, oid_value format,
1123 Z_ReferenceId *referenceId)
1125 int recno, total_length = 0, toget = *num, dumped_records = 0;
1126 Z_Records *records =
1127 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1128 Z_NamePlusRecordList *reclist =
1129 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1130 Z_NamePlusRecord **list =
1131 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1133 records->which = Z_Records_DBOSD;
1134 records->u.databaseOrSurDiagnostics = reclist;
1135 reclist->num_records = 0;
1136 reclist->records = list;
1137 *pres = Z_PRES_SUCCESS;
1141 yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
1142 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1143 a->maximumRecordSize);
1144 for (recno = start; reclist->num_records < toget; recno++)
1146 bend_fetchrequest freq;
1147 bend_fetchresult *fres;
1148 Z_NamePlusRecord *thisrec;
1149 int this_length = 0;
1151 * we get the number of bytes allocated on the stream before any
1152 * allocation done by the backend - this should give us a reasonable
1153 * idea of the total size of the data so far.
1155 total_length = odr_total(a->encode) - dumped_records;
1156 freq.setname = setname;
1157 freq.number = recno;
1159 freq.format = format;
1160 freq.stream = a->encode;
1161 freq.print = a->print;
1162 freq.surrogate_flag = 0;
1163 freq.referenceId = referenceId;
1164 if (!(fres = bend_fetch(a->backend, &freq, 0)))
1166 *pres = Z_PRES_FAILURE;
1167 return diagrec(a, 2, "Backend interface problem");
1169 /* backend should be able to signal whether error is system-wide
1170 or only pertaining to current record */
1173 if (!freq.surrogate_flag)
1175 *pres = Z_PRES_FAILURE;
1176 return diagrec(a, fres->errcode, fres->errstring);
1178 reclist->records[reclist->num_records] =
1179 surrogatediagrec(a, fres->basename, fres->errcode,
1181 reclist->num_records++;
1182 *next = fres->last_in_set ? 0 : recno + 1;
1186 this_length = fres->len;
1188 this_length = odr_total(a->encode) - total_length;
1189 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1190 this_length, total_length);
1191 if (this_length + total_length > a->preferredMessageSize)
1193 /* record is small enough, really */
1194 if (this_length <= a->preferredMessageSize)
1196 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1197 *pres = Z_PRES_PARTIAL_2;
1200 /* record can only be fetched by itself */
1201 if (this_length < a->maximumRecordSize)
1203 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1206 yaz_log(LOG_DEBUG, " Dropped it");
1207 reclist->records[reclist->num_records] =
1208 surrogatediagrec(a, fres->basename, 16, 0);
1209 reclist->num_records++;
1210 *next = fres->last_in_set ? 0 : recno + 1;
1211 dumped_records += this_length;
1215 else /* too big entirely */
1217 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
1218 reclist->records[reclist->num_records] =
1219 surrogatediagrec(a, fres->basename, 17, 0);
1220 reclist->num_records++;
1221 *next = fres->last_in_set ? 0 : recno + 1;
1222 dumped_records += this_length;
1227 if (!(thisrec = (Z_NamePlusRecord *)
1228 odr_malloc(a->encode, sizeof(*thisrec))))
1230 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1231 strlen(fres->basename) + 1)))
1233 strcpy(thisrec->databaseName, fres->basename);
1234 thisrec->which = Z_NamePlusRecord_databaseRecord;
1235 thisrec->u.databaseRecord = z_ext_record(a->encode, fres->format,
1236 fres->record, fres->len);
1237 if (!thisrec->u.databaseRecord)
1239 reclist->records[reclist->num_records] = thisrec;
1240 reclist->num_records++;
1241 *next = fres->last_in_set ? 0 : recno + 1;
1243 *num = reclist->num_records;
1247 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1250 Z_SearchRequest *req = reqb->request->u.searchRequest;
1251 bend_search_rr *bsrr =
1252 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1254 yaz_log(LOG_LOG, "Got SearchRequest.");
1256 bsrr->request = reqb;
1257 bsrr->association = assoc;
1258 bsrr->referenceId = req->referenceId;
1259 save_referenceId (reqb, bsrr->referenceId);
1261 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1262 if (req->databaseNames)
1265 for (i = 0; i < req->num_databaseNames; i++)
1266 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1268 switch (req->query->which)
1270 case Z_Query_type_1: case Z_Query_type_101:
1271 log_rpn_query (req->query->u.type_1);
1273 if (assoc->bend_search)
1275 bsrr->setname = req->resultSetName;
1276 bsrr->replace_set = *req->replaceIndicator;
1277 bsrr->num_bases = req->num_databaseNames;
1278 bsrr->basenames = req->databaseNames;
1279 bsrr->query = req->query;
1280 bsrr->stream = assoc->encode;
1281 bsrr->decode = assoc->decode;
1282 bsrr->print = assoc->print;
1285 bsrr->errstring = NULL;
1286 ((int (*)(void *, bend_search_rr *))(assoc->bend_search))
1287 (assoc->backend, bsrr);
1293 bend_searchrequest bsrq;
1294 bend_searchresult *bsrt;
1296 bsrq.setname = req->resultSetName;
1297 bsrq.replace_set = *req->replaceIndicator;
1298 bsrq.num_bases = req->num_databaseNames;
1299 bsrq.basenames = req->databaseNames;
1300 bsrq.query = req->query;
1301 bsrq.referenceId = req->referenceId;
1302 bsrq.stream = assoc->encode;
1303 bsrq.decode = assoc->decode;
1304 bsrq.print = assoc->print;
1305 if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1307 bsrr->hits = bsrt->hits;
1308 bsrr->errcode = bsrt->errcode;
1309 bsrr->errstring = bsrt->errstring;
1311 return response_searchRequest(assoc, reqb, bsrr, fd);
1314 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1317 * Prepare a searchresponse based on the backend results. We probably want
1318 * to look at making the fetching of records nonblocking as well, but
1319 * so far, we'll keep things simple.
1320 * If bsrt is null, that means we're called in response to a communications
1321 * event, and we'll have to get the response for ourselves.
1323 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1324 bend_search_rr *bsrt, int *fd)
1326 Z_SearchRequest *req = reqb->request->u.searchRequest;
1327 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1328 Z_SearchResponse *resp = (Z_SearchResponse *)
1329 odr_malloc (assoc->encode, sizeof(*resp));
1330 int *nulint = (int *)odr_malloc (assoc->encode, sizeof(*nulint));
1331 bool_t *sr = (bool_t *)odr_malloc (assoc->encode, sizeof(*sr));
1332 int *next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1333 int *none = (int *)odr_malloc (assoc->encode, sizeof(*none));
1340 apdu->which = Z_APDU_searchResponse;
1341 apdu->u.searchResponse = resp;
1342 resp->referenceId = req->referenceId;
1343 resp->additionalSearchInfo = 0;
1344 resp->otherInfo = 0;
1346 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1348 yaz_log(LOG_FATAL, "Bad result from backend");
1351 else if (bsrt->errcode)
1353 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1354 resp->resultCount = nulint;
1355 resp->numberOfRecordsReturned = nulint;
1356 resp->nextResultSetPosition = nulint;
1357 resp->searchStatus = nulint;
1358 resp->resultSetStatus = none;
1359 resp->presentStatus = 0;
1363 int *toget = (int *)odr_malloc (assoc->encode, sizeof(*toget));
1364 int *presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1365 Z_RecordComposition comp, *compp = 0;
1370 resp->resultCount = &bsrt->hits;
1372 comp.which = Z_RecordComp_simple;
1373 /* how many records does the user agent want, then? */
1374 if (bsrt->hits <= *req->smallSetUpperBound)
1376 *toget = bsrt->hits;
1377 if ((comp.u.simple = req->smallSetElementSetNames))
1380 else if (bsrt->hits < *req->largeSetLowerBound)
1382 *toget = *req->mediumSetPresentNumber;
1383 if (*toget > bsrt->hits)
1384 *toget = bsrt->hits;
1385 if ((comp.u.simple = req->mediumSetElementSetNames))
1391 if (*toget && !resp->records)
1396 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1397 prefformat->oclass != CLASS_RECSYN)
1400 form = prefformat->value;
1401 resp->records = pack_records(assoc, req->resultSetName, 1,
1402 toget, compp, next, presst, form, req->referenceId);
1405 resp->numberOfRecordsReturned = toget;
1406 resp->nextResultSetPosition = next;
1407 resp->searchStatus = sr;
1408 resp->resultSetStatus = 0;
1409 resp->presentStatus = presst;
1413 if (*resp->resultCount)
1415 resp->numberOfRecordsReturned = nulint;
1416 resp->nextResultSetPosition = next;
1417 resp->searchStatus = sr;
1418 resp->resultSetStatus = 0;
1419 resp->presentStatus = 0;
1426 * Maybe we got a little over-friendly when we designed bend_fetch to
1427 * get only one record at a time. Some backends can optimise multiple-record
1428 * fetches, and at any rate, there is some overhead involved in
1429 * all that selecting and hopping around. Problem is, of course, that the
1430 * frontend can't know ahead of time how many records it'll need to
1431 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1432 * is downright lousy as a bulk data transfer protocol.
1434 * To start with, we'll do the fetching of records from the backend
1435 * in one operation: To save some trips in and out of the event-handler,
1436 * and to simplify the interface to pack_records. At any rate, asynch
1437 * operation is more fun in operations that have an unpredictable execution
1438 * speed - which is normally more true for search than for present.
1440 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1443 Z_PresentRequest *req = reqb->request->u.presentRequest;
1447 Z_PresentResponse *resp;
1452 yaz_log(LOG_LOG, "Got PresentRequest.");
1454 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1455 prefformat->oclass != CLASS_RECSYN)
1458 form = prefformat->value;
1459 if (assoc->bend_present)
1461 bend_present_rr *bprr = (bend_present_rr *)
1462 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1463 bprr->setname = req->resultSetId;
1464 bprr->start = *req->resultSetStartPoint;
1465 bprr->number = *req->numberOfRecordsRequested;
1466 bprr->format = form;
1467 bprr->comp = req->recordComposition;
1468 bprr->referenceId = req->referenceId;
1469 bprr->stream = assoc->encode;
1470 bprr->print = assoc->print;
1471 bprr->request = reqb;
1472 bprr->association = assoc;
1474 bprr->errstring = NULL;
1475 ((int (*)(void *, bend_present_rr *))(*assoc->bend_present))(
1476 assoc->backend, bprr);
1481 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1482 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1483 presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1484 next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1485 num = (int *)odr_malloc (assoc->encode, sizeof(*num));
1488 *num = *req->numberOfRecordsRequested;
1490 apdu->which = Z_APDU_presentResponse;
1491 apdu->u.presentResponse = resp;
1492 resp->referenceId = req->referenceId;
1493 resp->otherInfo = 0;
1496 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1497 num, req->recordComposition, next, presst, form,
1501 resp->numberOfRecordsReturned = num;
1502 resp->presentStatus = presst;
1503 resp->nextResultSetPosition = next;
1508 static int bend_default_scan (void *handle, bend_scan_rr *rr)
1510 bend_scanrequest srq;
1511 bend_scanresult *srs;
1513 srq.num_bases = rr->num_bases;
1514 srq.basenames = rr->basenames;
1515 srq.attributeset = rr->attributeset;
1516 srq.referenceId = rr->referenceId;
1517 srq.term = rr->term;
1518 srq.term_position = rr->term_position;
1519 srq.num_entries = rr->num_entries;
1520 srq.stream = rr->stream;
1521 srq.print = rr->print;
1523 srs = bend_scan(handle, &srq, 0);
1525 rr->term_position = srs->term_position;
1526 rr->num_entries = srs->num_entries;
1527 rr->entries = srs->entries;
1528 rr->status = srs->status;
1529 rr->errcode = srs->errcode;
1530 rr->errstring = srs->errstring;
1535 * Scan was implemented rather in a hurry, and with support for only the basic
1536 * elements of the service in the backend API. Suggestions are welcome.
1538 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1540 Z_ScanRequest *req = reqb->request->u.scanRequest;
1541 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1542 Z_ScanResponse *res = (Z_ScanResponse *)
1543 odr_malloc (assoc->encode, sizeof(*res));
1544 int *scanStatus = (int *)
1545 odr_malloc (assoc->encode, sizeof(*scanStatus));
1546 int *numberOfEntriesReturned = (int *)
1547 odr_malloc (assoc->encode, sizeof(*numberOfEntriesReturned));
1548 Z_ListEntries *ents = (Z_ListEntries *)
1549 odr_malloc (assoc->encode, sizeof(*ents));
1550 Z_DiagRecs *diagrecs_p = NULL;
1554 yaz_log(LOG_LOG, "Got ScanRequest");
1555 *scanStatus = Z_Scan_failure;
1556 *numberOfEntriesReturned = 0;
1558 apdu->which = Z_APDU_scanResponse;
1559 apdu->u.scanResponse = res;
1560 res->referenceId = req->referenceId;
1562 res->scanStatus = scanStatus;
1563 res->numberOfEntriesReturned = numberOfEntriesReturned;
1564 res->positionOfTerm = 0;
1565 res->entries = ents;
1566 ents->num_entries = 0;
1567 ents->entries = NULL;
1568 ents->num_nonsurrogateDiagnostics = 0;
1569 ents->nonsurrogateDiagnostics = NULL;
1570 res->attributeSet = 0;
1573 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1574 attent->oclass != CLASS_ATTSET
1575 || attent->value != VAL_BIB1))
1576 diagrecs_p = diagrecs(assoc, 121, 0);
1577 else if (req->stepSize && *req->stepSize > 0)
1578 diagrecs_p = diagrecs(assoc, 205, 0);
1581 bend_scan_rr *bsrr = (bend_scan_rr *)
1582 odr_malloc (assoc->encode, sizeof(*bsrr));
1583 if (req->databaseNames)
1586 for (i = 0; i < req->num_databaseNames; i++)
1587 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1589 bsrr->num_bases = req->num_databaseNames;
1590 bsrr->basenames = req->databaseNames;
1591 bsrr->num_entries = *req->numberOfTermsRequested;
1592 bsrr->term = req->termListAndStartPoint;
1593 bsrr->referenceId = req->referenceId;
1594 bsrr->stream = assoc->encode;
1595 bsrr->print = assoc->print;
1596 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1597 attset->oclass != CLASS_RECSYN)
1598 bsrr->attributeset = VAL_NONE;
1600 bsrr->attributeset = attset->value;
1601 log_scan_term (req->termListAndStartPoint, attset->value);
1602 bsrr->term_position = req->preferredPositionInResponse ?
1603 *req->preferredPositionInResponse : 1;
1604 ((int (*)(void *, bend_scan_rr *))(*assoc->bend_scan))(assoc->backend,
1607 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1611 Z_Entry **tab = (Z_Entry **)
1612 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1614 if (bsrr->status == BEND_SCAN_PARTIAL)
1615 *scanStatus = Z_Scan_partial_5;
1617 *scanStatus = Z_Scan_success;
1618 ents->entries = tab;
1619 ents->num_entries = bsrr->num_entries;
1620 res->numberOfEntriesReturned = &ents->num_entries;
1621 res->positionOfTerm = &bsrr->term_position;
1622 for (i = 0; i < bsrr->num_entries; i++)
1628 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1629 if (bsrr->entries[i].occurrences >= 0)
1631 e->which = Z_Entry_termInfo;
1632 e->u.termInfo = t = (Z_TermInfo *)
1633 odr_malloc(assoc->encode, sizeof(*t));
1634 t->suggestedAttributes = 0;
1636 t->alternativeTerm = 0;
1637 t->byAttributes = 0;
1638 t->otherTermInfo = 0;
1639 t->globalOccurrences = &bsrr->entries[i].occurrences;
1640 t->term = (Z_Term *)
1641 odr_malloc(assoc->encode, sizeof(*t->term));
1642 t->term->which = Z_Term_general;
1643 t->term->u.general = o =
1644 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1645 o->buf = (unsigned char *)
1646 odr_malloc(assoc->encode, o->len = o->size =
1647 strlen(bsrr->entries[i].term));
1648 memcpy(o->buf, bsrr->entries[i].term, o->len);
1649 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1650 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1654 Z_DiagRecs *drecs = diagrecs (assoc,
1655 bsrr->entries[i].errcode,
1656 bsrr->entries[i].errstring);
1657 assert (drecs->num_diagRecs == 1);
1658 e->which = Z_Entry_surrogateDiagnostic;
1659 assert (drecs->diagRecs[0]);
1660 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1667 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1668 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1673 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1676 Z_SortRequest *req = reqb->request->u.sortRequest;
1677 Z_SortResponse *res = (Z_SortResponse *)
1678 odr_malloc (assoc->encode, sizeof(*res));
1679 bend_sort_rr *bsrr = (bend_sort_rr *)
1680 odr_malloc (assoc->encode, sizeof(*bsrr));
1682 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1684 yaz_log(LOG_LOG, "Got SortRequest.");
1687 bsrr->num_input_setnames = req->num_inputResultSetNames;
1688 bsrr->input_setnames = req->inputResultSetNames;
1690 bsrr->num_input_setnames = req->inputResultSetNames->num_strings;
1691 bsrr->input_setnames = req->inputResultSetNames->strings;
1693 bsrr->referenceId = req->referenceId;
1694 bsrr->output_setname = req->sortedResultSetName;
1695 bsrr->sort_sequence = req->sortSequence;
1696 bsrr->stream = assoc->encode;
1697 bsrr->print = assoc->print;
1699 bsrr->sort_status = Z_SortStatus_failure;
1701 bsrr->errstring = 0;
1703 ((int (*)(void *, bend_sort_rr *))(*assoc->bend_sort))(assoc->backend,
1706 res->referenceId = bsrr->referenceId;
1707 res->sortStatus = (int *)
1708 odr_malloc (assoc->encode, sizeof(*res->sortStatus));
1709 *res->sortStatus = bsrr->sort_status;
1710 res->resultSetStatus = 0;
1713 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1715 res->diagnostics = dr->diagRecs;
1716 res->num_diagnostics = dr->num_diagRecs;
1718 res->diagnostics = dr;
1724 res->num_diagnostics = 0;
1726 res->diagnostics = 0;
1730 apdu->which = Z_APDU_sortResponse;
1731 apdu->u.sortResponse = res;
1735 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1738 Z_DeleteResultSetRequest *req = reqb->request->u.deleteResultSetRequest;
1739 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1740 odr_malloc (assoc->encode, sizeof(*res));
1741 bend_delete_rr *bdrr = (bend_delete_rr *)
1742 odr_malloc (assoc->encode, sizeof(*bdrr));
1743 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1745 yaz_log(LOG_LOG, "Got DeleteRequest.");
1747 bdrr->num_setnames = req->num_resultSetList;
1748 bdrr->setnames = req->resultSetList;
1749 bdrr->stream = assoc->encode;
1750 bdrr->print = assoc->print;
1751 bdrr->function = *req->deleteFunction;
1752 bdrr->referenceId = req->referenceId;
1754 if (bdrr->num_setnames > 0)
1757 bdrr->statuses = odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1758 bdrr->num_setnames);
1759 for (i = 0; i < bdrr->num_setnames; i++)
1760 bdrr->statuses[i] = 0;
1762 ((int (*)(void *, bend_delete_rr *))
1763 (*assoc->bend_delete))(assoc->backend, bdrr);
1765 res->referenceId = req->referenceId;
1767 res->deleteOperationStatus = (int *)
1768 odr_malloc (assoc->encode, sizeof(*res->deleteOperationStatus));
1769 *res->deleteOperationStatus = bdrr->delete_status;
1771 res->deleteListStatuses = 0;
1772 if (bdrr->num_setnames > 0)
1775 res->deleteListStatuses = odr_malloc(assoc->encode,
1776 sizeof(*res->deleteListStatuses));
1777 res->deleteListStatuses->num = bdrr->num_setnames;
1778 res->deleteListStatuses->elements =
1779 odr_malloc (assoc->encode,
1780 sizeof(*res->deleteListStatuses->elements) *
1781 bdrr->num_setnames);
1782 for (i = 0; i<bdrr->num_setnames; i++)
1784 res->deleteListStatuses->elements[i] =
1785 odr_malloc (assoc->encode,
1786 sizeof(**res->deleteListStatuses->elements));
1787 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1788 res->deleteListStatuses->elements[i]->id =
1789 odr_strdup (assoc->encode, bdrr->setnames[i]);
1793 res->numberNotDeleted = 0;
1794 res->bulkStatuses = 0;
1795 res->deleteMessage = 0;
1798 apdu->which = Z_APDU_deleteResultSetResponse;
1799 apdu->u.deleteResultSetResponse = res;
1803 static void process_close(association *assoc, request *reqb)
1805 Z_Close *req = reqb->request->u.close;
1806 static char *reasons[] =
1813 "securityViolation",
1820 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1821 reasons[*req->closeReason], req->diagnosticInformation ?
1822 req->diagnosticInformation : "NULL");
1823 if (assoc->version < 3) /* to make do_force respond with close */
1825 do_close_req(assoc, Z_Close_finished,
1826 "Association terminated by client", reqb);
1829 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1833 reqb->len_refid = refid->len;
1834 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1835 memcpy (reqb->refid, refid->buf, refid->len);
1839 reqb->len_refid = 0;
1844 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1846 process_response (a, req, res);
1849 bend_request bend_request_mk (bend_association a)
1851 request *nreq = request_get (&a->outgoing);
1852 nreq->request_mem = nmem_create ();
1856 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1861 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1862 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1863 id->len = id->size = req->len_refid;
1864 memcpy (id->buf, req->refid, req->len_refid);
1868 void bend_request_destroy (bend_request *req)
1870 nmem_destroy((*req)->request_mem);
1871 request_release(*req);
1875 int bend_backend_respond (bend_association a, bend_request req)
1879 r = process_request (a, req, &msg);
1881 logf (LOG_WARN, "%s", msg);
1885 void bend_request_setdata(bend_request r, void *p)
1890 void *bend_request_getdata(bend_request r)
1892 return r->clientData;
1895 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
1897 bend_segment_rr request;
1899 request.segment = reqb->request->u.segmentRequest;
1900 request.stream = assoc->encode;
1901 request.decode = assoc->decode;
1902 request.print = assoc->print;
1903 request.association = assoc;
1905 ((int (*)(void *, bend_segment_rr *))(*assoc->bend_segment))
1906 (assoc->backend, &request);
1911 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
1913 bend_esrequest_rr esrequest;
1915 Z_ExtendedServicesRequest *req = reqb->request->u.extendedServicesRequest;
1916 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
1918 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
1920 yaz_log(LOG_DEBUG,"inside Process esRequest");
1922 esrequest.esr = reqb->request->u.extendedServicesRequest;
1923 esrequest.stream = assoc->encode;
1924 esrequest.decode = assoc->decode;
1925 esrequest.print = assoc->print;
1926 esrequest.errcode = 0;
1927 esrequest.errstring = NULL;
1928 esrequest.request = reqb;
1929 esrequest.association = assoc;
1930 esrequest.referenceId = req->referenceId;
1932 ((int (*)(void *, bend_esrequest_rr *))(*assoc->bend_esrequest))
1933 (assoc->backend, &esrequest);
1935 /* If the response is being delayed, return NULL */
1936 if (esrequest.request == NULL)
1939 resp->referenceId = req->referenceId;
1941 if (esrequest.errcode == -1)
1943 /* Backend service indicates request will be processed */
1944 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
1945 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
1947 else if (esrequest.errcode == 0)
1949 /* Backend service indicates request will be processed */
1950 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
1951 *resp->operationStatus = Z_ExtendedServicesResponse_done;
1955 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
1956 esrequest.errstring);
1958 /* Backend indicates error, request will not be processed */
1959 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
1960 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
1961 resp->num_diagnostics = diagRecs->num_diagRecs;
1962 resp->diagnostics = diagRecs->diagRecs;
1964 /* Do something with the members of bend_extendedservice */
1966 yaz_log(LOG_DEBUG,"Send the result apdu");