2 * Copyright (c) 1995-1999, Index Data
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.100 1999-12-16 23:36:19 adam
8 * Implemented ILL protocol. Minor updates ASN.1 compiler.
10 * Revision 1.99 1999/11/30 13:47:12 adam
11 * Improved installation. Moved header files to include/yaz.
13 * Revision 1.98 1999/11/29 15:12:27 adam
14 * Changed the way implementationName - and version is set.
16 * Revision 1.96 1999/11/04 14:58:44 adam
17 * Added status elements for backend delete result set handler.
18 * Updated delete result result set command for client.
20 * Revision 1.95 1999/10/11 10:01:24 adam
21 * Implemented bend_sort_rr handler for frontend server.
23 * Revision 1.94 1999/08/27 09:40:32 adam
24 * Renamed logf function to yaz_log. Removed VC++ project files.
26 * Revision 1.93 1999/07/06 12:17:15 adam
27 * Added option -1 that runs server once (for profiling purposes).
29 * Revision 1.92 1999/06/17 10:54:45 adam
30 * Added facility to specify implementation version - and name
33 * Revision 1.91 1999/06/01 14:29:12 adam
34 * Work on Extended Services.
36 * Revision 1.90 1999/05/27 13:02:20 adam
37 * Assigned OID for old DB Update (VAL_DBUPDATE0).
39 * Revision 1.89 1999/05/26 15:24:26 adam
40 * Fixed minor bugs regarding DB Update (introduced by previous commit).
42 * Revision 1.88 1999/04/20 09:56:48 adam
43 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
44 * Modified all encoders/decoders to reflect this change.
46 * Revision 1.87 1999/03/31 11:18:25 adam
47 * Implemented odr_strdup. Added Reference ID to backend server API.
49 * Revision 1.86 1999/02/02 13:57:38 adam
50 * Uses preprocessor define WIN32 instead of WINDOWS to build code
51 * for Microsoft WIN32.
53 * Revision 1.85 1998/11/17 09:52:59 adam
54 * Fixed minor bug (introduced by previous commit).
56 * Revision 1.84 1998/11/16 16:02:32 adam
57 * Added loggin utilies, log_rpn_query and log_scan_term. These used
58 * to be part of Zebra.
60 * Revision 1.83 1998/11/03 10:09:36 adam
61 * Fixed bug regarding YC.
63 * Revision 1.82 1998/10/20 14:00:30 quinn
66 * Revision 1.81 1998/10/13 16:12:24 adam
67 * Added support for Surrogate Diagnostics for Scan Term entries.
69 * Revision 1.80 1998/09/02 12:41:53 adam
70 * Added decode stream in bend search structures.
72 * Revision 1.79 1998/08/19 16:10:08 adam
73 * Changed som member names of DeleteResultSetRequest/Response.
75 * Revision 1.78 1998/08/03 10:23:55 adam
76 * Fixed bug regarding Options for Sort.
78 * Revision 1.77 1998/07/20 12:38:42 adam
79 * Implemented delete result set service to server API.
81 * Revision 1.76 1998/05/27 16:57:07 adam
82 * Support for surrogate diagnostic records added for bend_fetch.
84 * Revision 1.75 1998/05/18 10:13:07 adam
85 * Fixed call to es_request handler - extra argument was passed.
87 * Revision 1.74 1998/03/31 15:13:20 adam
88 * Development towards compiled ASN.1.
90 * Revision 1.73 1998/03/31 11:07:45 adam
91 * Furhter work on UNIverse resource report.
92 * Added Extended Services handling in frontend server.
94 * Revision 1.72 1998/02/11 11:53:35 adam
95 * Changed code so that it compiles as C++.
97 * Revision 1.71 1998/02/10 11:03:57 adam
98 * Added support for extended handlers in backend server interface.
100 * Revision 1.70 1998/01/29 13:15:35 adam
101 * Implemented sort for the backend interface.
103 * Revision 1.69 1997/09/30 11:48:12 adam
104 * Fixed bug introduced by previous commit.
106 * Revision 1.68 1997/09/29 13:18:59 adam
107 * Added function, oid_ent_to_oid, to replace the function
108 * oid_getoidbyent, which is not thread safe.
110 * Revision 1.67 1997/09/17 12:10:40 adam
113 * Revision 1.66 1997/09/05 15:26:44 adam
114 * Added ODR encode in search and scen bend request structures.
115 * Fixed a few enums that caused trouble with C++.
117 * Revision 1.65 1997/09/01 08:53:01 adam
118 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
119 * moved a separate directory. MSV5.0 project server.dsp created.
120 * As an option, the server can now operate as an NT service.
122 * Revision 1.64 1997/04/30 08:52:11 quinn
125 * Revision 1.63 1996/10/11 11:57:26 quinn
128 * Revision 1.62 1996/07/06 19:58:35 quinn
129 * System headerfiles gathered in yconfig
131 * Revision 1.61 1996/06/10 08:56:16 quinn
134 * Revision 1.60 1996/05/30 11:03:10 quinn
135 * Fixed NextresultSetPosition bug fixed.
137 * Revision 1.59 1996/05/14 09:26:46 quinn
138 * Added attribute set to scan backend
140 * Revision 1.58 1996/02/20 12:53:04 quinn
143 * Revision 1.57 1996/01/02 08:57:47 quinn
144 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
146 * Revision 1.56 1995/12/14 11:09:57 quinn
149 * Revision 1.55 1995/11/08 17:41:37 quinn
152 * Revision 1.54 1995/11/08 15:11:29 quinn
153 * Log of close transmit.
155 * Revision 1.53 1995/11/01 13:54:58 quinn
158 * Revision 1.52 1995/11/01 12:19:13 quinn
159 * Second attempt to fix same bug.
161 * Revision 1.50 1995/10/25 16:58:32 quinn
164 * Revision 1.49 1995/10/16 13:51:53 quinn
165 * Changes to provide Especs to the backend.
167 * Revision 1.48 1995/10/06 08:51:20 quinn
168 * Added Write-buffer.
170 * Revision 1.47 1995/08/29 14:24:16 quinn
171 * Added second half of close-handshake
173 * Revision 1.46 1995/08/29 11:17:58 quinn
174 * Added code to receive close
176 * Revision 1.45 1995/08/21 09:11:00 quinn
177 * Smallish fixes to suppport new formats.
179 * Revision 1.44 1995/08/17 12:45:25 quinn
180 * Fixed minor problems with GRS-1. Added support in c&s.
182 * Revision 1.43 1995/08/15 12:00:31 quinn
185 * Revision 1.42 1995/08/15 11:16:50 quinn
187 * Revision 1.41 1995/08/02 10:23:06 quinn
190 * Revision 1.40 1995/07/31 14:34:26 quinn
191 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
193 * Revision 1.39 1995/06/27 13:21:00 quinn
196 * Revision 1.38 1995/06/19 12:39:11 quinn
197 * Fixed bug in timeout code. Added BER dumper.
199 * Revision 1.37 1995/06/16 13:16:14 quinn
200 * Fixed Defaultdiagformat.
202 * Revision 1.36 1995/06/16 10:31:36 quinn
203 * Added session timeout.
205 * Revision 1.35 1995/06/15 07:45:14 quinn
208 * Revision 1.34 1995/06/14 15:26:46 quinn
209 * *** empty log message ***
211 * Revision 1.33 1995/06/06 14:57:05 quinn
212 * Better diagnostics.
214 * Revision 1.32 1995/06/06 08:41:44 quinn
215 * Better diagnostics.
217 * Revision 1.31 1995/06/06 08:15:37 quinn
220 * Revision 1.30 1995/06/05 10:53:32 quinn
221 * Added a better SCAN.
223 * Revision 1.29 1995/06/01 11:25:03 quinn
226 * Revision 1.28 1995/06/01 11:21:01 quinn
227 * Attempting to fix a bug in pack-records. replaced break with continue
228 * for large records, according to standard.
230 * Revision 1.27 1995/05/29 08:12:06 quinn
233 * Revision 1.26 1995/05/18 13:02:12 quinn
236 * Revision 1.25 1995/05/17 08:42:26 quinn
237 * Transfer auth info to backend. Allow backend to reject init gracefully.
239 * Revision 1.24 1995/05/16 08:51:04 quinn
240 * License, documentation, and memory fixes
242 * Revision 1.23 1995/05/15 13:25:10 quinn
245 * Revision 1.22 1995/05/15 11:56:39 quinn
246 * Asynchronous facilities. Restructuring of seshigh code.
248 * Revision 1.21 1995/05/02 08:53:19 quinn
249 * Trying in vain to fix comm with ISODE
251 * Revision 1.20 1995/04/20 15:13:00 quinn
254 * Revision 1.19 1995/04/18 08:15:34 quinn
255 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
256 * neater. We'll make the same change for decoding one day.
258 * Revision 1.18 1995/04/17 11:28:25 quinn
261 * Revision 1.17 1995/04/10 10:23:36 quinn
262 * Some work to add scan and other things.
264 * Revision 1.16 1995/03/31 09:18:55 quinn
267 * Revision 1.15 1995/03/30 14:03:23 quinn
268 * Added RFC1006 as separate library
270 * Revision 1.14 1995/03/30 12:18:17 quinn
273 * Revision 1.13 1995/03/30 09:09:24 quinn
274 * Added state-handle and some support for asynchronous activities.
276 * Revision 1.12 1995/03/29 15:40:16 quinn
277 * Ongoing work. Statserv is now dynamic by default
279 * Revision 1.11 1995/03/28 09:16:21 quinn
280 * Added record packing to the search request
282 * Revision 1.10 1995/03/27 08:34:24 quinn
283 * Added dynamic server functionality.
284 * Released bindings to session.c (is now redundant)
286 * Revision 1.9 1995/03/22 15:01:26 quinn
287 * Adjusting record packing.
289 * Revision 1.8 1995/03/22 10:13:21 quinn
290 * Working on record packer
292 * Revision 1.7 1995/03/21 15:53:31 quinn
295 * Revision 1.6 1995/03/21 12:30:09 quinn
296 * Beginning to add support for record packing.
298 * Revision 1.5 1995/03/17 10:44:13 quinn
299 * Added catch of null-string in makediagrec
301 * Revision 1.4 1995/03/17 10:18:08 quinn
302 * Added memory management.
304 * Revision 1.3 1995/03/16 17:42:39 quinn
307 * Revision 1.2 1995/03/16 13:29:01 quinn
308 * Partitioned server.
310 * Revision 1.1 1995/03/15 16:02:10 quinn
311 * Modded session.c to seshigh.c
316 * Frontend server logic.
318 * This code receives incoming APDUs, and handles client requests by means
319 * of the backend API.
321 * Some of the code is getting quite involved, compared to simpler servers -
322 * primarily because it is asynchronous both in the communication with
323 * the user and the backend. We think the complexity will pay off in
324 * the form of greater flexibility when more asynchronous facilities
327 * Memory management has become somewhat involved. In the simple case, where
328 * only one PDU is pending at a time, it will simply reuse the same memory,
329 * once it has found its working size. When we enable multiple concurrent
330 * operations, perhaps even with multiple parallel calls to the backend, it
331 * will maintain a pool of buffers for encoding and decoding, trying to
332 * minimize memory allocation/deallocation during normal operation.
334 * TODOs include (and will be done in order of public interest):
336 * Support for EXPLAIN - provide simple meta-database system.
337 * Support for access control.
338 * Support for resource control.
339 * Support for extended services - primarily Item Order.
340 * Rest of Z39.50-1994
353 #include <yaz/yconfig.h>
354 #include <yaz/xmalloc.h>
355 #include <yaz/comstack.h>
358 #include <yaz/proto.h>
361 #include <yaz/logrpn.h>
362 #include <yaz/statserv.h>
364 #include <yaz/backend.h>
366 static int process_request(association *assoc, request *req, char **msg);
367 void backend_response(IOCHAN i, int event);
368 static int process_response(association *assoc, request *req, Z_APDU *res);
369 static Z_APDU *process_initRequest(association *assoc, request *reqb);
370 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
372 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
373 bend_search_rr *bsrr, int *fd);
374 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
376 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
377 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
378 static void process_close(association *assoc, request *reqb);
379 void save_referenceId (request *reqb, Z_ReferenceId *refid);
380 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
382 static int bend_default_scan (void *handle, bend_scan_rr *rr);
384 static FILE *apduf = 0; /* for use in static mode */
385 static statserv_options_block *control_block = 0;
387 /* Chas: Added in from DALI */
388 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
389 /* Chas: End of addition from DALI */
392 * Create and initialize a new association-handle.
393 * channel : iochannel for the current line.
394 * link : communications channel.
395 * Returns: 0 or a new association handle.
397 association *create_association(IOCHAN channel, COMSTACK link)
402 control_block = statserv_getcontrol();
403 if (!(anew = (association *)xmalloc(sizeof(*anew))))
405 anew->client_chan = channel;
406 anew->client_link = link;
407 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
408 !(anew->encode = odr_createmem(ODR_ENCODE)))
410 if (*control_block->apdufile)
415 strcpy(filename, control_block->apdufile);
416 if (!(anew->print = odr_createmem(ODR_PRINT)))
418 if (*control_block->apdufile != '-')
420 strcpy(filename, control_block->apdufile);
421 if (!control_block->dynamic)
425 if (!(apduf = fopen(filename, "w")))
427 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
430 setvbuf(apduf, 0, _IONBF, 0);
436 sprintf(filename + strlen(filename), ".%d", getpid());
437 if (!(f = fopen(filename, "w")))
439 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
442 setvbuf(f, 0, _IONBF, 0);
444 odr_setprint(anew->print, f);
449 anew->input_buffer = 0;
450 anew->input_buffer_len = 0;
452 anew->state = ASSOC_NEW;
453 request_initq(&anew->incoming);
454 request_initq(&anew->outgoing);
455 anew->proto = cs_getproto(link);
460 * Free association and release resources.
462 void destroy_association(association *h)
464 odr_destroy(h->decode);
465 odr_destroy(h->encode);
467 odr_destroy(h->print);
469 xfree(h->input_buffer);
471 bend_close(h->backend);
472 while (request_deq(&h->incoming));
473 while (request_deq(&h->outgoing));
474 request_delq(&h->incoming);
475 request_delq(&h->outgoing);
477 if (control_block && control_block->one_shot)
481 static void do_close_req(association *a, int reason, char *message,
485 Z_Close *cls = zget_Close(a->encode);
487 /* Purge request queue */
488 while (request_deq(&a->incoming));
489 while (request_deq(&a->outgoing));
492 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
493 reason, message ? message : "none");
494 apdu.which = Z_APDU_close;
496 *cls->closeReason = reason;
497 cls->diagnosticInformation = message;
498 process_response(a, req, &apdu);
499 iochan_settimeout(a->client_chan, 60);
503 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
504 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
506 a->state = ASSOC_DEAD;
509 static void do_close(association *a, int reason, char *message)
511 do_close_req (a, reason, message, request_get(&a->outgoing));
515 * This is where PDUs from the client are read and the further
516 * processing is initiated. Flow of control moves down through the
517 * various process_* functions below, until the encoded result comes back up
518 * to the output handler in here.
520 * h : the I/O channel that has an outstanding event.
521 * event : the current outstanding event.
523 void ir_session(IOCHAN h, int event)
526 association *assoc = (association *)iochan_getdata(h);
527 COMSTACK conn = assoc->client_link;
530 assert(h && conn && assoc);
531 if (event == EVENT_TIMEOUT)
533 if (assoc->state != ASSOC_UP)
535 yaz_log(LOG_LOG, "Final timeout - closing connection.");
537 destroy_association(assoc);
542 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
543 do_close(assoc, Z_Close_lackOfActivity, 0);
547 if (event & EVENT_INPUT || event & EVENT_WORK) /* input */
549 if (event & EVENT_INPUT)
551 yaz_log(LOG_DEBUG, "ir_session (input)");
552 assert(assoc && conn);
553 /* We aren't speaking to this fellow */
554 if (assoc->state == ASSOC_DEAD)
556 yaz_log(LOG_LOG, "Closed connection after reject");
558 destroy_association(assoc);
562 if ((res = cs_get(conn, &assoc->input_buffer,
563 &assoc->input_buffer_len)) <= 0)
565 yaz_log(LOG_LOG, "Connection closed by client");
567 destroy_association(assoc);
571 else if (res == 1) /* incomplete read - wait for more */
573 if (cs_more(conn)) /* more stuff - call us again later, please */
574 iochan_setevent(h, EVENT_INPUT);
576 /* we got a complete PDU. Let's decode it */
577 yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
578 req = request_get(&assoc->incoming); /* get a new request structure */
579 odr_reset(assoc->decode);
580 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
581 if (!z_APDU(assoc->decode, &req->request, 0, 0))
583 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
584 odr_errmsg(odr_geterror(assoc->decode)),
585 odr_offset(assoc->decode));
586 yaz_log(LOG_LOG, "PDU dump:");
587 odr_dumpBER(log_file(), assoc->input_buffer, res);
588 do_close(assoc, Z_Close_protocolError, "Malformed package");
591 req->request_mem = odr_extract_mem(assoc->decode);
592 if (assoc->print && !z_APDU(assoc->print, &req->request, 0, 0))
594 yaz_log(LOG_WARN, "ODR print error: %s",
595 odr_errmsg(odr_geterror(assoc->print)));
596 odr_reset(assoc->print);
598 request_enq(&assoc->incoming, req);
601 /* can we do something yet? */
602 req = request_head(&assoc->incoming);
603 if (req->state == REQUEST_IDLE)
606 request_deq(&assoc->incoming);
607 if (process_request(assoc, req, &msg) < 0)
608 do_close_req(assoc, Z_Close_systemProblem, msg, req);
611 if (event & EVENT_OUTPUT)
613 request *req = request_head(&assoc->outgoing);
615 yaz_log(LOG_DEBUG, "ir_session (output)");
616 req->state = REQUEST_PENDING;
617 switch (res = cs_put(conn, req->response, req->len_response))
620 yaz_log(LOG_LOG, "Connection closed by client");
622 destroy_association(assoc);
625 case 0: /* all sent - release the request structure */
626 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
627 nmem_destroy(req->request_mem);
628 request_deq(&assoc->outgoing);
629 request_release(req);
630 if (!request_head(&assoc->outgoing))
631 iochan_clearflag(h, EVENT_OUTPUT);
633 /* value of 1 -- partial send -- is simply ignored */
636 if (event & EVENT_EXCEPT)
638 yaz_log(LOG_DEBUG, "ir_session (exception)");
640 destroy_association(assoc);
646 * Initiate request processing.
648 static int process_request(association *assoc, request *req, char **msg)
654 *msg = "Unknown Error";
655 assert(req && req->state == REQUEST_IDLE);
656 switch (req->request->which)
658 case Z_APDU_initRequest:
659 res = process_initRequest(assoc, req); break;
660 case Z_APDU_searchRequest:
661 res = process_searchRequest(assoc, req, &fd); break;
662 case Z_APDU_presentRequest:
663 res = process_presentRequest(assoc, req, &fd); break;
664 case Z_APDU_scanRequest:
665 if (assoc->bend_scan)
666 res = process_scanRequest(assoc, req, &fd);
669 *msg = "Cannot handle Scan APDU";
673 case Z_APDU_extendedServicesRequest:
674 if (assoc->bend_esrequest)
675 res = process_ESRequest(assoc, req, &fd);
678 *msg = "Cannot handle Extended Services APDU";
682 case Z_APDU_sortRequest:
683 if (assoc->bend_sort)
684 res = process_sortRequest(assoc, req, &fd);
687 *msg = "Cannot handle Sort APDU";
692 process_close(assoc, req);
694 case Z_APDU_deleteResultSetRequest:
695 if (assoc->bend_delete)
696 res = process_deleteRequest(assoc, req, &fd);
699 *msg = "Cannot handle Delete APDU";
704 *msg = "Bad APDU received";
709 yaz_log(LOG_DEBUG, " result immediately available");
710 retval = process_response(assoc, req, res);
714 yaz_log(LOG_DEBUG, " result unavailble");
717 else /* no result yet - one will be provided later */
721 /* Set up an I/O handler for the fd supplied by the backend */
723 yaz_log(LOG_DEBUG, " establishing handler for result");
724 req->state = REQUEST_PENDING;
725 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
727 iochan_setdata(chan, assoc);
734 * Handle message from the backend.
736 void backend_response(IOCHAN i, int event)
738 association *assoc = (association *)iochan_getdata(i);
739 request *req = request_head(&assoc->incoming);
743 yaz_log(LOG_DEBUG, "backend_response");
744 assert(assoc && req && req->state != REQUEST_IDLE);
745 /* determine what it is we're waiting for */
746 switch (req->request->which)
748 case Z_APDU_searchRequest:
749 res = response_searchRequest(assoc, req, 0, &fd); break;
751 case Z_APDU_presentRequest:
752 res = response_presentRequest(assoc, req, 0, &fd); break;
753 case Z_APDU_scanRequest:
754 res = response_scanRequest(assoc, req, 0, &fd); break;
757 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
760 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
762 yaz_log(LOG_LOG, "Fatal error when talking to backend");
763 do_close(assoc, Z_Close_systemProblem, 0);
767 else if (!res) /* no result yet - try again later */
769 yaz_log(LOG_DEBUG, " no result yet");
770 iochan_setfd(i, fd); /* in case fd has changed */
775 * Encode response, and transfer the request structure to the outgoing queue.
777 static int process_response(association *assoc, request *req, Z_APDU *res)
779 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
780 if (!z_APDU(assoc->encode, &res, 0, 0))
782 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
783 odr_errmsg(odr_geterror(assoc->decode)));
784 odr_reset(assoc->encode);
787 req->response = odr_getbuf(assoc->encode, &req->len_response,
788 &req->size_response);
789 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
790 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
792 yaz_log(LOG_WARN, "ODR print error: %s",
793 odr_errmsg(odr_geterror(assoc->print)));
794 odr_reset(assoc->print);
796 odr_reset(assoc->encode);
797 req->state = REQUEST_IDLE;
798 request_enq(&assoc->outgoing, req);
799 /* turn the work over to the ir_session handler */
800 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
801 /* Is there more work to be done? give that to the input handler too */
803 if (request_head(&assoc->incoming))
805 yaz_log (LOG_DEBUG, "more work to be done");
806 iochan_setevent(assoc->client_chan, EVENT_WORK);
813 * Handle init request.
814 * At the moment, we don't check the options
815 * anywhere else in the code - we just try not to do anything that would
816 * break a naive client. We'll toss 'em into the association block when
817 * we need them there.
819 static Z_APDU *process_initRequest(association *assoc, request *reqb)
821 Z_InitRequest *req = reqb->request->u.initRequest;
822 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
823 Z_InitResponse *resp = apdu->u.initResponse;
824 bend_initrequest binitreq;
825 bend_initresult *binitres;
828 yaz_log(LOG_LOG, "Got initRequest");
829 if (req->implementationId)
830 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
831 if (req->implementationName)
832 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
833 if (req->implementationVersion)
834 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
836 binitreq.stream = assoc->encode;
837 binitreq.configname = "default-config";
838 binitreq.auth = req->idAuthentication;
839 binitreq.referenceId = req->referenceId;
840 binitreq.implementation_version = 0;
841 binitreq.implementation_name = 0;
842 binitreq.bend_sort = NULL;
843 binitreq.bend_search = NULL;
844 binitreq.bend_present = NULL;
845 binitreq.bend_esrequest = NULL;
846 binitreq.bend_delete = NULL;
847 binitreq.bend_scan = bend_default_scan;
848 if (!(binitres = bend_init(&binitreq)))
850 yaz_log(LOG_WARN, "Bad response from backend.");
854 assoc->backend = binitres->handle;
855 if ((assoc->bend_sort = (int (*)())binitreq.bend_sort))
856 yaz_log (LOG_DEBUG, "Sort handler installed");
857 if ((assoc->bend_search = (int (*)())binitreq.bend_search))
858 yaz_log (LOG_DEBUG, "Search handler installed");
859 if ((assoc->bend_present = (int (*)())binitreq.bend_present))
860 yaz_log (LOG_DEBUG, "Present handler installed");
861 if ((assoc->bend_esrequest = (int (*)())binitreq.bend_esrequest))
862 yaz_log (LOG_DEBUG, "ESRequest handler installed");
863 if ((assoc->bend_delete = (int (*)())binitreq.bend_delete))
864 yaz_log (LOG_DEBUG, "Delete handler installed");
865 if ((assoc->bend_scan = (int (*)())binitreq.bend_scan))
866 yaz_log (LOG_DEBUG, "Scan handler installed");
868 resp->referenceId = req->referenceId;
870 /* let's tell the client what we can do */
871 if (ODR_MASK_GET(req->options, Z_Options_search))
873 ODR_MASK_SET(resp->options, Z_Options_search);
874 strcat(options, "srch");
876 if (ODR_MASK_GET(req->options, Z_Options_present))
878 ODR_MASK_SET(resp->options, Z_Options_present);
879 strcat(options, " prst");
881 if (ODR_MASK_GET(req->options, Z_Options_delSet) && binitreq.bend_delete)
883 ODR_MASK_SET(resp->options, Z_Options_delSet);
884 strcat(options, " del");
886 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
887 binitreq.bend_esrequest)
889 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
890 strcat (options, " extendedServices");
892 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
894 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
895 strcat(options, " namedresults");
897 if (ODR_MASK_GET(req->options, Z_Options_scan) && binitreq.bend_scan)
899 ODR_MASK_SET(resp->options, Z_Options_scan);
900 strcat(options, " scan");
902 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
904 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
905 strcat(options, " concurop");
907 if (ODR_MASK_GET(req->options, Z_Options_sort) && binitreq.bend_sort)
909 ODR_MASK_SET(resp->options, Z_Options_sort);
910 strcat(options, " sort");
912 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
914 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
915 assoc->version = 2; /* 1 & 2 are equivalent */
917 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
919 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
922 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
924 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
927 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
928 assoc->maximumRecordSize = *req->maximumRecordSize;
929 if (assoc->maximumRecordSize > control_block->maxrecordsize)
930 assoc->maximumRecordSize = control_block->maxrecordsize;
931 assoc->preferredMessageSize = *req->preferredMessageSize;
932 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
933 assoc->preferredMessageSize = assoc->maximumRecordSize;
934 resp->preferredMessageSize = &assoc->preferredMessageSize;
935 resp->maximumRecordSize = &assoc->maximumRecordSize;
937 resp->implementationName = "GFS";
939 if (binitreq.implementation_name)
942 odr_malloc (assoc->encode,
943 strlen(binitreq.implementation_name) + 10 +
944 strlen(resp->implementationName));
945 sprintf (nv, "%s / %s",
946 resp->implementationName, binitreq.implementation_name);
947 resp->implementationName = nv;
949 if (binitreq.implementation_version)
952 odr_malloc (assoc->encode,
953 strlen(binitreq.implementation_version) + 10 +
954 strlen(resp->implementationVersion));
955 sprintf (nv, "YAZ %s / %s",
956 resp->implementationVersion, binitreq.implementation_version);
957 resp->implementationVersion = nv;
960 if (binitres->errcode)
962 yaz_log(LOG_LOG, "Connection rejected by backend.");
964 assoc->state = ASSOC_DEAD;
967 assoc->state = ASSOC_UP;
972 * These functions should be merged.
975 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo)
978 dr->which = Z_DefaultDiagFormat_v2Addinfo;
979 dr->u.v2Addinfo = addinfo ? addinfo : "";
981 dr->which = Z_DiagForm_v2AddInfo;
982 dr->addinfo = addinfo ? addinfo : "";
987 * nonsurrogate diagnostic record.
989 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
992 Z_Records *rec = (Z_Records *)
993 odr_malloc (assoc->encode, sizeof(*rec));
996 odr_malloc (assoc->encode, sizeof(*err));
997 Z_DiagRec *drec = (Z_DiagRec *)
998 odr_malloc (assoc->encode, sizeof(*drec));
999 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1000 odr_malloc (assoc->encode, sizeof(*dr));
1002 bib1.proto = assoc->proto;
1003 bib1.oclass = CLASS_DIAGSET;
1004 bib1.value = VAL_BIB1;
1006 yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
1009 rec->which = Z_Records_NSD;
1011 rec->u.nonSurrogateDiagnostic = dr;
1013 rec->u.nonSurrogateDiagnostic = drec;
1014 drec->which = Z_DiagRec_defaultFormat;
1015 drec->u.defaultFormat = dr;
1017 dr->diagnosticSetId =
1018 odr_oiddup (assoc->encode, oid_ent_to_oid(&bib1, oid));
1019 dr->condition = err;
1020 set_addinfo (dr, addinfo);
1025 * surrogate diagnostic.
1027 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1028 int error, char *addinfo)
1031 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1032 odr_malloc (assoc->encode, sizeof(*rec));
1033 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1035 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1036 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1037 odr_malloc (assoc->encode, sizeof(*dr));
1039 bib1.proto = assoc->proto;
1040 bib1.oclass = CLASS_DIAGSET;
1041 bib1.value = VAL_BIB1;
1043 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1045 rec->databaseName = dbname;
1046 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1047 rec->u.surrogateDiagnostic = drec;
1048 drec->which = Z_DiagRec_defaultFormat;
1049 drec->u.defaultFormat = dr;
1050 dr->diagnosticSetId = odr_oiddup (assoc->encode,
1051 oid_ent_to_oid(&bib1, oid));
1052 dr->condition = err;
1053 set_addinfo (dr, addinfo);
1059 * multiple nonsurrogate diagnostics.
1061 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1064 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1065 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1067 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1068 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1069 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)odr_malloc (assoc->encode, sizeof(*rec));
1071 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1072 bib1.proto = assoc->proto;
1073 bib1.oclass = CLASS_DIAGSET;
1074 bib1.value = VAL_BIB1;
1077 recs->num_diagRecs = 1;
1078 recs->diagRecs = recp;
1080 drec->which = Z_DiagRec_defaultFormat;
1081 drec->u.defaultFormat = rec;
1083 rec->diagnosticSetId = odr_oiddup (assoc->encode,
1084 oid_ent_to_oid(&bib1, oid));
1085 rec->condition = err;
1088 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1089 rec->u.v2Addinfo = addinfo ? addinfo : "";
1091 rec->which = Z_DiagForm_v2AddInfo;
1092 rec->addinfo = addinfo ? addinfo : "";
1097 static Z_Records *pack_records(association *a, char *setname, int start,
1098 int *num, Z_RecordComposition *comp,
1099 int *next, int *pres, oid_value format,
1100 Z_ReferenceId *referenceId)
1102 int recno, total_length = 0, toget = *num, dumped_records = 0;
1103 Z_Records *records =
1104 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1105 Z_NamePlusRecordList *reclist =
1106 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1107 Z_NamePlusRecord **list =
1108 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1110 records->which = Z_Records_DBOSD;
1111 records->u.databaseOrSurDiagnostics = reclist;
1112 reclist->num_records = 0;
1113 reclist->records = list;
1114 *pres = Z_PRES_SUCCESS;
1118 yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
1119 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1120 a->maximumRecordSize);
1121 for (recno = start; reclist->num_records < toget; recno++)
1123 bend_fetchrequest freq;
1124 bend_fetchresult *fres;
1125 Z_NamePlusRecord *thisrec;
1126 int this_length = 0;
1128 * we get the number of bytes allocated on the stream before any
1129 * allocation done by the backend - this should give us a reasonable
1130 * idea of the total size of the data so far.
1132 total_length = odr_total(a->encode) - dumped_records;
1133 freq.setname = setname;
1134 freq.number = recno;
1136 freq.format = format;
1137 freq.stream = a->encode;
1138 freq.surrogate_flag = 0;
1139 freq.referenceId = referenceId;
1140 if (!(fres = bend_fetch(a->backend, &freq, 0)))
1142 *pres = Z_PRES_FAILURE;
1143 return diagrec(a, 2, "Backend interface problem");
1145 /* backend should be able to signal whether error is system-wide
1146 or only pertaining to current record */
1149 if (!freq.surrogate_flag)
1151 *pres = Z_PRES_FAILURE;
1152 return diagrec(a, fres->errcode, fres->errstring);
1154 reclist->records[reclist->num_records] =
1155 surrogatediagrec(a, fres->basename, fres->errcode,
1157 reclist->num_records++;
1158 *next = fres->last_in_set ? 0 : recno + 1;
1162 this_length = fres->len;
1164 this_length = odr_total(a->encode) - total_length;
1165 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1166 this_length, total_length);
1167 if (this_length + total_length > a->preferredMessageSize)
1169 /* record is small enough, really */
1170 if (this_length <= a->preferredMessageSize)
1172 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1173 *pres = Z_PRES_PARTIAL_2;
1176 /* record can only be fetched by itself */
1177 if (this_length < a->maximumRecordSize)
1179 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1182 yaz_log(LOG_DEBUG, " Dropped it");
1183 reclist->records[reclist->num_records] =
1184 surrogatediagrec(a, fres->basename, 16, 0);
1185 reclist->num_records++;
1186 *next = fres->last_in_set ? 0 : recno + 1;
1187 dumped_records += this_length;
1191 else /* too big entirely */
1193 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
1194 reclist->records[reclist->num_records] =
1195 surrogatediagrec(a, fres->basename, 17, 0);
1196 reclist->num_records++;
1197 *next = fres->last_in_set ? 0 : recno + 1;
1198 dumped_records += this_length;
1203 if (!(thisrec = (Z_NamePlusRecord *)
1204 odr_malloc(a->encode, sizeof(*thisrec))))
1206 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1207 strlen(fres->basename) + 1)))
1209 strcpy(thisrec->databaseName, fres->basename);
1210 thisrec->which = Z_NamePlusRecord_databaseRecord;
1211 thisrec->u.databaseRecord = z_ext_record(a->encode, fres->format,
1212 fres->record, fres->len);
1213 if (!thisrec->u.databaseRecord)
1215 reclist->records[reclist->num_records] = thisrec;
1216 reclist->num_records++;
1217 *next = fres->last_in_set ? 0 : recno + 1;
1219 *num = reclist->num_records;
1223 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1226 Z_SearchRequest *req = reqb->request->u.searchRequest;
1227 bend_search_rr *bsrr =
1228 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1230 yaz_log(LOG_LOG, "Got SearchRequest.");
1232 bsrr->request = reqb;
1233 bsrr->association = assoc;
1234 bsrr->referenceId = req->referenceId;
1235 save_referenceId (reqb, bsrr->referenceId);
1237 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1238 if (req->databaseNames)
1241 for (i = 0; i < req->num_databaseNames; i++)
1242 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1244 switch (req->query->which)
1246 case Z_Query_type_1: case Z_Query_type_101:
1247 log_rpn_query (req->query->u.type_1);
1249 if (assoc->bend_search)
1251 bsrr->setname = req->resultSetName;
1252 bsrr->replace_set = *req->replaceIndicator;
1253 bsrr->num_bases = req->num_databaseNames;
1254 bsrr->basenames = req->databaseNames;
1255 bsrr->query = req->query;
1256 bsrr->stream = assoc->encode;
1257 bsrr->decode = assoc->decode;
1260 bsrr->errstring = NULL;
1261 ((int (*)(void *, bend_search_rr *))(assoc->bend_search))
1262 (assoc->backend, bsrr);
1268 bend_searchrequest bsrq;
1269 bend_searchresult *bsrt;
1271 bsrq.setname = req->resultSetName;
1272 bsrq.replace_set = *req->replaceIndicator;
1273 bsrq.num_bases = req->num_databaseNames;
1274 bsrq.basenames = req->databaseNames;
1275 bsrq.query = req->query;
1276 bsrq.referenceId = req->referenceId;
1277 bsrq.stream = assoc->encode;
1278 bsrq.decode = assoc->decode;
1279 if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1281 bsrr->hits = bsrt->hits;
1282 bsrr->errcode = bsrt->errcode;
1283 bsrr->errstring = bsrt->errstring;
1285 return response_searchRequest(assoc, reqb, bsrr, fd);
1288 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1291 * Prepare a searchresponse based on the backend results. We probably want
1292 * to look at making the fetching of records nonblocking as well, but
1293 * so far, we'll keep things simple.
1294 * If bsrt is null, that means we're called in response to a communications
1295 * event, and we'll have to get the response for ourselves.
1297 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1298 bend_search_rr *bsrt, int *fd)
1300 Z_SearchRequest *req = reqb->request->u.searchRequest;
1301 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1302 Z_SearchResponse *resp = (Z_SearchResponse *)
1303 odr_malloc (assoc->encode, sizeof(*resp));
1304 int *nulint = (int *)odr_malloc (assoc->encode, sizeof(*nulint));
1305 bool_t *sr = (bool_t *)odr_malloc (assoc->encode, sizeof(*sr));
1306 int *next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1307 int *none = (int *)odr_malloc (assoc->encode, sizeof(*none));
1314 apdu->which = Z_APDU_searchResponse;
1315 apdu->u.searchResponse = resp;
1316 resp->referenceId = req->referenceId;
1317 resp->additionalSearchInfo = 0;
1318 resp->otherInfo = 0;
1320 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1322 yaz_log(LOG_FATAL, "Bad result from backend");
1325 else if (bsrt->errcode)
1327 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1328 resp->resultCount = nulint;
1329 resp->numberOfRecordsReturned = nulint;
1330 resp->nextResultSetPosition = nulint;
1331 resp->searchStatus = nulint;
1332 resp->resultSetStatus = none;
1333 resp->presentStatus = 0;
1337 int *toget = (int *)odr_malloc (assoc->encode, sizeof(*toget));
1338 int *presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1339 Z_RecordComposition comp, *compp = 0;
1344 resp->resultCount = &bsrt->hits;
1346 comp.which = Z_RecordComp_simple;
1347 /* how many records does the user agent want, then? */
1348 if (bsrt->hits <= *req->smallSetUpperBound)
1350 *toget = bsrt->hits;
1351 if ((comp.u.simple = req->smallSetElementSetNames))
1354 else if (bsrt->hits < *req->largeSetLowerBound)
1356 *toget = *req->mediumSetPresentNumber;
1357 if (*toget > bsrt->hits)
1358 *toget = bsrt->hits;
1359 if ((comp.u.simple = req->mediumSetElementSetNames))
1365 if (*toget && !resp->records)
1370 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1371 prefformat->oclass != CLASS_RECSYN)
1374 form = prefformat->value;
1375 resp->records = pack_records(assoc, req->resultSetName, 1,
1376 toget, compp, next, presst, form, req->referenceId);
1379 resp->numberOfRecordsReturned = toget;
1380 resp->nextResultSetPosition = next;
1381 resp->searchStatus = sr;
1382 resp->resultSetStatus = 0;
1383 resp->presentStatus = presst;
1387 if (*resp->resultCount)
1389 resp->numberOfRecordsReturned = nulint;
1390 resp->nextResultSetPosition = next;
1391 resp->searchStatus = sr;
1392 resp->resultSetStatus = 0;
1393 resp->presentStatus = 0;
1400 * Maybe we got a little over-friendly when we designed bend_fetch to
1401 * get only one record at a time. Some backends can optimise multiple-record
1402 * fetches, and at any rate, there is some overhead involved in
1403 * all that selecting and hopping around. Problem is, of course, that the
1404 * frontend can't know ahead of time how many records it'll need to
1405 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1406 * is downright lousy as a bulk data transfer protocol.
1408 * To start with, we'll do the fetching of records from the backend
1409 * in one operation: To save some trips in and out of the event-handler,
1410 * and to simplify the interface to pack_records. At any rate, asynch
1411 * operation is more fun in operations that have an unpredictable execution
1412 * speed - which is normally more true for search than for present.
1414 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1417 Z_PresentRequest *req = reqb->request->u.presentRequest;
1421 Z_PresentResponse *resp;
1426 yaz_log(LOG_LOG, "Got PresentRequest.");
1428 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1429 prefformat->oclass != CLASS_RECSYN)
1432 form = prefformat->value;
1433 if (assoc->bend_present)
1435 bend_present_rr *bprr = (bend_present_rr *)
1436 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1437 bprr->setname = req->resultSetId;
1438 bprr->start = *req->resultSetStartPoint;
1439 bprr->number = *req->numberOfRecordsRequested;
1440 bprr->format = form;
1441 bprr->comp = req->recordComposition;
1442 bprr->referenceId = req->referenceId;
1443 bprr->stream = assoc->encode;
1444 bprr->request = reqb;
1445 bprr->association = assoc;
1447 bprr->errstring = NULL;
1448 ((int (*)(void *, bend_present_rr *))(*assoc->bend_present))(
1449 assoc->backend, bprr);
1454 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1455 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1456 presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1457 next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1458 num = (int *)odr_malloc (assoc->encode, sizeof(*num));
1461 *num = *req->numberOfRecordsRequested;
1463 apdu->which = Z_APDU_presentResponse;
1464 apdu->u.presentResponse = resp;
1465 resp->referenceId = req->referenceId;
1466 resp->otherInfo = 0;
1469 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1470 num, req->recordComposition, next, presst, form,
1474 resp->numberOfRecordsReturned = num;
1475 resp->presentStatus = presst;
1476 resp->nextResultSetPosition = next;
1481 static int bend_default_scan (void *handle, bend_scan_rr *rr)
1483 bend_scanrequest srq;
1484 bend_scanresult *srs;
1486 srq.num_bases = rr->num_bases;
1487 srq.basenames = rr->basenames;
1488 srq.attributeset = rr->attributeset;
1489 srq.referenceId = rr->referenceId;
1490 srq.term = rr->term;
1491 srq.term_position = rr->term_position;
1492 srq.num_entries = rr->num_entries;
1493 srq.stream = rr->stream;
1495 srs = bend_scan(handle, &srq, 0);
1497 rr->term_position = srs->term_position;
1498 rr->num_entries = srs->num_entries;
1499 rr->entries = srs->entries;
1500 rr->status = srs->status;
1501 rr->errcode = srs->errcode;
1502 rr->errstring = srs->errstring;
1507 * Scan was implemented rather in a hurry, and with support for only the basic
1508 * elements of the service in the backend API. Suggestions are welcome.
1510 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1512 Z_ScanRequest *req = reqb->request->u.scanRequest;
1513 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1514 Z_ScanResponse *res = (Z_ScanResponse *)
1515 odr_malloc (assoc->encode, sizeof(*res));
1516 int *scanStatus = (int *)
1517 odr_malloc (assoc->encode, sizeof(*scanStatus));
1518 int *numberOfEntriesReturned = (int *)
1519 odr_malloc (assoc->encode, sizeof(*numberOfEntriesReturned));
1520 Z_ListEntries *ents = (Z_ListEntries *)
1521 odr_malloc (assoc->encode, sizeof(*ents));
1522 Z_DiagRecs *diagrecs_p = NULL;
1526 yaz_log(LOG_LOG, "Got ScanRequest");
1527 *scanStatus = Z_Scan_failure;
1528 *numberOfEntriesReturned = 0;
1530 apdu->which = Z_APDU_scanResponse;
1531 apdu->u.scanResponse = res;
1532 res->referenceId = req->referenceId;
1534 res->scanStatus = scanStatus;
1535 res->numberOfEntriesReturned = numberOfEntriesReturned;
1536 res->positionOfTerm = 0;
1537 res->entries = ents;
1538 ents->num_entries = 0;
1539 ents->entries = NULL;
1540 ents->num_nonsurrogateDiagnostics = 0;
1541 ents->nonsurrogateDiagnostics = NULL;
1542 res->attributeSet = 0;
1545 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1546 attent->oclass != CLASS_ATTSET
1547 || attent->value != VAL_BIB1))
1548 diagrecs_p = diagrecs(assoc, 121, 0);
1549 else if (req->stepSize && *req->stepSize > 0)
1550 diagrecs_p = diagrecs(assoc, 205, 0);
1553 bend_scan_rr *bsrr = (bend_scan_rr *)
1554 odr_malloc (assoc->encode, sizeof(*bsrr));
1555 if (req->databaseNames)
1558 for (i = 0; i < req->num_databaseNames; i++)
1559 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1561 bsrr->num_bases = req->num_databaseNames;
1562 bsrr->basenames = req->databaseNames;
1563 bsrr->num_entries = *req->numberOfTermsRequested;
1564 bsrr->term = req->termListAndStartPoint;
1565 bsrr->referenceId = req->referenceId;
1566 bsrr->stream = assoc->encode;
1567 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1568 attset->oclass != CLASS_RECSYN)
1569 bsrr->attributeset = VAL_NONE;
1571 bsrr->attributeset = attset->value;
1572 log_scan_term (req->termListAndStartPoint, attset->value);
1573 bsrr->term_position = req->preferredPositionInResponse ?
1574 *req->preferredPositionInResponse : 1;
1575 ((int (*)(void *, bend_scan_rr *))(*assoc->bend_scan))(assoc->backend,
1578 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1582 Z_Entry **tab = (Z_Entry **)
1583 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1585 if (bsrr->status == BEND_SCAN_PARTIAL)
1586 *scanStatus = Z_Scan_partial_5;
1588 *scanStatus = Z_Scan_success;
1589 ents->entries = tab;
1590 ents->num_entries = bsrr->num_entries;
1591 res->numberOfEntriesReturned = &ents->num_entries;
1592 res->positionOfTerm = &bsrr->term_position;
1593 for (i = 0; i < bsrr->num_entries; i++)
1599 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1600 if (bsrr->entries[i].occurrences >= 0)
1602 e->which = Z_Entry_termInfo;
1603 e->u.termInfo = t = (Z_TermInfo *)
1604 odr_malloc(assoc->encode, sizeof(*t));
1605 t->suggestedAttributes = 0;
1607 t->alternativeTerm = 0;
1608 t->byAttributes = 0;
1609 t->otherTermInfo = 0;
1610 t->globalOccurrences = &bsrr->entries[i].occurrences;
1611 t->term = (Z_Term *)
1612 odr_malloc(assoc->encode, sizeof(*t->term));
1613 t->term->which = Z_Term_general;
1614 t->term->u.general = o =
1615 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1616 o->buf = (unsigned char *)
1617 odr_malloc(assoc->encode, o->len = o->size =
1618 strlen(bsrr->entries[i].term));
1619 memcpy(o->buf, bsrr->entries[i].term, o->len);
1620 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1621 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1625 Z_DiagRecs *drecs = diagrecs (assoc,
1626 bsrr->entries[i].errcode,
1627 bsrr->entries[i].errstring);
1628 assert (drecs->num_diagRecs == 1);
1629 e->which = Z_Entry_surrogateDiagnostic;
1630 assert (drecs->diagRecs[0]);
1631 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1638 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1639 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1644 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1647 Z_SortRequest *req = reqb->request->u.sortRequest;
1648 Z_SortResponse *res = (Z_SortResponse *)
1649 odr_malloc (assoc->encode, sizeof(*res));
1650 bend_sort_rr *bsrr = (bend_sort_rr *)
1651 odr_malloc (assoc->encode, sizeof(*bsrr));
1653 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1655 yaz_log(LOG_LOG, "Got SortRequest.");
1658 bsrr->num_input_setnames = req->num_inputResultSetNames;
1659 bsrr->input_setnames = req->inputResultSetNames;
1661 bsrr->num_input_setnames = req->inputResultSetNames->num_strings;
1662 bsrr->input_setnames = req->inputResultSetNames->strings;
1664 bsrr->referenceId = req->referenceId;
1665 bsrr->output_setname = req->sortedResultSetName;
1666 bsrr->sort_sequence = req->sortSequence;
1667 bsrr->stream = assoc->encode;
1669 bsrr->sort_status = Z_SortStatus_failure;
1671 bsrr->errstring = 0;
1673 ((int (*)(void *, bend_sort_rr *))(*assoc->bend_sort))(assoc->backend,
1676 res->referenceId = bsrr->referenceId;
1677 res->sortStatus = (int *)
1678 odr_malloc (assoc->encode, sizeof(*res->sortStatus));
1679 *res->sortStatus = bsrr->sort_status;
1680 res->resultSetStatus = 0;
1683 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1685 res->diagnostics = dr->diagRecs;
1686 res->num_diagnostics = dr->num_diagRecs;
1688 res->diagnostics = dr;
1694 res->num_diagnostics = 0;
1696 res->diagnostics = 0;
1700 apdu->which = Z_APDU_sortResponse;
1701 apdu->u.sortResponse = res;
1705 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1708 Z_DeleteResultSetRequest *req = reqb->request->u.deleteResultSetRequest;
1709 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1710 odr_malloc (assoc->encode, sizeof(*res));
1711 bend_delete_rr *bdrr = (bend_delete_rr *)
1712 odr_malloc (assoc->encode, sizeof(*bdrr));
1713 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1715 yaz_log(LOG_LOG, "Got DeleteRequest.");
1717 bdrr->num_setnames = req->num_resultSetList;
1718 bdrr->setnames = req->resultSetList;
1719 bdrr->stream = assoc->encode;
1720 bdrr->function = *req->deleteFunction;
1721 bdrr->referenceId = req->referenceId;
1723 if (bdrr->num_setnames > 0)
1726 bdrr->statuses = odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1727 bdrr->num_setnames);
1728 for (i = 0; i < bdrr->num_setnames; i++)
1729 bdrr->statuses[i] = 0;
1731 ((int (*)(void *, bend_delete_rr *))
1732 (*assoc->bend_delete))(assoc->backend, bdrr);
1734 res->referenceId = req->referenceId;
1736 res->deleteOperationStatus = (int *)
1737 odr_malloc (assoc->encode, sizeof(*res->deleteOperationStatus));
1738 *res->deleteOperationStatus = bdrr->delete_status;
1740 res->deleteListStatuses = 0;
1741 if (bdrr->num_setnames > 0)
1744 res->deleteListStatuses = odr_malloc(assoc->encode,
1745 sizeof(*res->deleteListStatuses));
1746 res->deleteListStatuses->num = bdrr->num_setnames;
1747 res->deleteListStatuses->elements =
1748 odr_malloc (assoc->encode,
1749 sizeof(*res->deleteListStatuses->elements) *
1750 bdrr->num_setnames);
1751 for (i = 0; i<bdrr->num_setnames; i++)
1753 res->deleteListStatuses->elements[i] =
1754 odr_malloc (assoc->encode,
1755 sizeof(**res->deleteListStatuses->elements));
1756 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1757 res->deleteListStatuses->elements[i]->id =
1758 odr_strdup (assoc->encode, bdrr->setnames[i]);
1762 res->numberNotDeleted = 0;
1763 res->bulkStatuses = 0;
1764 res->deleteMessage = 0;
1767 apdu->which = Z_APDU_deleteResultSetResponse;
1768 apdu->u.deleteResultSetResponse = res;
1772 static void process_close(association *assoc, request *reqb)
1774 Z_Close *req = reqb->request->u.close;
1775 static char *reasons[] =
1782 "securityViolation",
1789 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1790 reasons[*req->closeReason], req->diagnosticInformation ?
1791 req->diagnosticInformation : "NULL");
1792 if (assoc->version < 3) /* to make do_force respond with close */
1794 do_close_req(assoc, Z_Close_finished,
1795 "Association terminated by client", reqb);
1798 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1802 reqb->len_refid = refid->len;
1803 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1804 memcpy (reqb->refid, refid->buf, refid->len);
1808 reqb->len_refid = 0;
1813 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1815 process_response (a, req, res);
1818 bend_request bend_request_mk (bend_association a)
1820 request *nreq = request_get (&a->outgoing);
1821 nreq->request_mem = nmem_create ();
1825 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1830 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1831 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1832 id->len = id->size = req->len_refid;
1833 memcpy (id->buf, req->refid, req->len_refid);
1837 void bend_request_destroy (bend_request *req)
1839 nmem_destroy((*req)->request_mem);
1840 request_release(*req);
1844 int bend_backend_respond (bend_association a, bend_request req)
1848 r = process_request (a, req, &msg);
1850 logf (LOG_WARN, "%s", msg);
1854 void bend_request_setdata(bend_request r, void *p)
1859 void *bend_request_getdata(bend_request r)
1861 return r->clientData;
1864 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
1866 bend_esrequest_rr esrequest;
1868 Z_ExtendedServicesRequest *req = reqb->request->u.extendedServicesRequest;
1869 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
1871 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
1873 yaz_log(LOG_DEBUG,"inside Process esRequest");
1875 esrequest.esr = reqb->request->u.extendedServicesRequest;
1876 esrequest.stream = assoc->encode;
1877 esrequest.decode = assoc->decode;
1878 esrequest.errcode = 0;
1879 esrequest.errstring = NULL;
1880 esrequest.request = reqb;
1881 esrequest.association = assoc;
1882 esrequest.referenceId = req->referenceId;
1884 ((int (*)(void *, bend_esrequest_rr *))(*assoc->bend_esrequest))
1885 (assoc->backend, &esrequest);
1887 /* If the response is being delayed, return NULL */
1888 if (esrequest.request == NULL)
1891 resp->referenceId = req->referenceId;
1893 if (esrequest.errcode == -1)
1895 /* Backend service indicates request will be processed */
1896 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
1897 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
1899 else if (esrequest.errcode == 0)
1901 /* Backend service indicates request will be processed */
1902 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
1903 *resp->operationStatus = Z_ExtendedServicesResponse_done;
1907 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
1908 esrequest.errstring);
1910 /* Backend indicates error, request will not be processed */
1911 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
1912 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
1913 resp->num_diagnostics = diagRecs->num_diagRecs;
1914 resp->diagnostics = diagRecs->diagRecs;
1916 /* Do something with the members of bend_extendedservice */
1918 yaz_log(LOG_DEBUG,"Send the result apdu");