2 * Copyright (c) 1995-1999, Index Data
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.99 1999-11-30 13:47:12 adam
8 * Improved installation. Moved header files to include/yaz.
10 * Revision 1.98 1999/11/29 15:12:27 adam
11 * Changed the way implementationName - and version is set.
13 * Revision 1.96 1999/11/04 14:58:44 adam
14 * Added status elements for backend delete result set handler.
15 * Updated delete result result set command for client.
17 * Revision 1.95 1999/10/11 10:01:24 adam
18 * Implemented bend_sort_rr handler for frontend server.
20 * Revision 1.94 1999/08/27 09:40:32 adam
21 * Renamed logf function to yaz_log. Removed VC++ project files.
23 * Revision 1.93 1999/07/06 12:17:15 adam
24 * Added option -1 that runs server once (for profiling purposes).
26 * Revision 1.92 1999/06/17 10:54:45 adam
27 * Added facility to specify implementation version - and name
30 * Revision 1.91 1999/06/01 14:29:12 adam
31 * Work on Extended Services.
33 * Revision 1.90 1999/05/27 13:02:20 adam
34 * Assigned OID for old DB Update (VAL_DBUPDATE0).
36 * Revision 1.89 1999/05/26 15:24:26 adam
37 * Fixed minor bugs regarding DB Update (introduced by previous commit).
39 * Revision 1.88 1999/04/20 09:56:48 adam
40 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
41 * Modified all encoders/decoders to reflect this change.
43 * Revision 1.87 1999/03/31 11:18:25 adam
44 * Implemented odr_strdup. Added Reference ID to backend server API.
46 * Revision 1.86 1999/02/02 13:57:38 adam
47 * Uses preprocessor define WIN32 instead of WINDOWS to build code
48 * for Microsoft WIN32.
50 * Revision 1.85 1998/11/17 09:52:59 adam
51 * Fixed minor bug (introduced by previous commit).
53 * Revision 1.84 1998/11/16 16:02:32 adam
54 * Added loggin utilies, log_rpn_query and log_scan_term. These used
55 * to be part of Zebra.
57 * Revision 1.83 1998/11/03 10:09:36 adam
58 * Fixed bug regarding YC.
60 * Revision 1.82 1998/10/20 14:00:30 quinn
63 * Revision 1.81 1998/10/13 16:12:24 adam
64 * Added support for Surrogate Diagnostics for Scan Term entries.
66 * Revision 1.80 1998/09/02 12:41:53 adam
67 * Added decode stream in bend search structures.
69 * Revision 1.79 1998/08/19 16:10:08 adam
70 * Changed som member names of DeleteResultSetRequest/Response.
72 * Revision 1.78 1998/08/03 10:23:55 adam
73 * Fixed bug regarding Options for Sort.
75 * Revision 1.77 1998/07/20 12:38:42 adam
76 * Implemented delete result set service to server API.
78 * Revision 1.76 1998/05/27 16:57:07 adam
79 * Support for surrogate diagnostic records added for bend_fetch.
81 * Revision 1.75 1998/05/18 10:13:07 adam
82 * Fixed call to es_request handler - extra argument was passed.
84 * Revision 1.74 1998/03/31 15:13:20 adam
85 * Development towards compiled ASN.1.
87 * Revision 1.73 1998/03/31 11:07:45 adam
88 * Furhter work on UNIverse resource report.
89 * Added Extended Services handling in frontend server.
91 * Revision 1.72 1998/02/11 11:53:35 adam
92 * Changed code so that it compiles as C++.
94 * Revision 1.71 1998/02/10 11:03:57 adam
95 * Added support for extended handlers in backend server interface.
97 * Revision 1.70 1998/01/29 13:15:35 adam
98 * Implemented sort for the backend interface.
100 * Revision 1.69 1997/09/30 11:48:12 adam
101 * Fixed bug introduced by previous commit.
103 * Revision 1.68 1997/09/29 13:18:59 adam
104 * Added function, oid_ent_to_oid, to replace the function
105 * oid_getoidbyent, which is not thread safe.
107 * Revision 1.67 1997/09/17 12:10:40 adam
110 * Revision 1.66 1997/09/05 15:26:44 adam
111 * Added ODR encode in search and scen bend request structures.
112 * Fixed a few enums that caused trouble with C++.
114 * Revision 1.65 1997/09/01 08:53:01 adam
115 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
116 * moved a separate directory. MSV5.0 project server.dsp created.
117 * As an option, the server can now operate as an NT service.
119 * Revision 1.64 1997/04/30 08:52:11 quinn
122 * Revision 1.63 1996/10/11 11:57:26 quinn
125 * Revision 1.62 1996/07/06 19:58:35 quinn
126 * System headerfiles gathered in yconfig
128 * Revision 1.61 1996/06/10 08:56:16 quinn
131 * Revision 1.60 1996/05/30 11:03:10 quinn
132 * Fixed NextresultSetPosition bug fixed.
134 * Revision 1.59 1996/05/14 09:26:46 quinn
135 * Added attribute set to scan backend
137 * Revision 1.58 1996/02/20 12:53:04 quinn
140 * Revision 1.57 1996/01/02 08:57:47 quinn
141 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
143 * Revision 1.56 1995/12/14 11:09:57 quinn
146 * Revision 1.55 1995/11/08 17:41:37 quinn
149 * Revision 1.54 1995/11/08 15:11:29 quinn
150 * Log of close transmit.
152 * Revision 1.53 1995/11/01 13:54:58 quinn
155 * Revision 1.52 1995/11/01 12:19:13 quinn
156 * Second attempt to fix same bug.
158 * Revision 1.50 1995/10/25 16:58:32 quinn
161 * Revision 1.49 1995/10/16 13:51:53 quinn
162 * Changes to provide Especs to the backend.
164 * Revision 1.48 1995/10/06 08:51:20 quinn
165 * Added Write-buffer.
167 * Revision 1.47 1995/08/29 14:24:16 quinn
168 * Added second half of close-handshake
170 * Revision 1.46 1995/08/29 11:17:58 quinn
171 * Added code to receive close
173 * Revision 1.45 1995/08/21 09:11:00 quinn
174 * Smallish fixes to suppport new formats.
176 * Revision 1.44 1995/08/17 12:45:25 quinn
177 * Fixed minor problems with GRS-1. Added support in c&s.
179 * Revision 1.43 1995/08/15 12:00:31 quinn
182 * Revision 1.42 1995/08/15 11:16:50 quinn
184 * Revision 1.41 1995/08/02 10:23:06 quinn
187 * Revision 1.40 1995/07/31 14:34:26 quinn
188 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
190 * Revision 1.39 1995/06/27 13:21:00 quinn
193 * Revision 1.38 1995/06/19 12:39:11 quinn
194 * Fixed bug in timeout code. Added BER dumper.
196 * Revision 1.37 1995/06/16 13:16:14 quinn
197 * Fixed Defaultdiagformat.
199 * Revision 1.36 1995/06/16 10:31:36 quinn
200 * Added session timeout.
202 * Revision 1.35 1995/06/15 07:45:14 quinn
205 * Revision 1.34 1995/06/14 15:26:46 quinn
206 * *** empty log message ***
208 * Revision 1.33 1995/06/06 14:57:05 quinn
209 * Better diagnostics.
211 * Revision 1.32 1995/06/06 08:41:44 quinn
212 * Better diagnostics.
214 * Revision 1.31 1995/06/06 08:15:37 quinn
217 * Revision 1.30 1995/06/05 10:53:32 quinn
218 * Added a better SCAN.
220 * Revision 1.29 1995/06/01 11:25:03 quinn
223 * Revision 1.28 1995/06/01 11:21:01 quinn
224 * Attempting to fix a bug in pack-records. replaced break with continue
225 * for large records, according to standard.
227 * Revision 1.27 1995/05/29 08:12:06 quinn
230 * Revision 1.26 1995/05/18 13:02:12 quinn
233 * Revision 1.25 1995/05/17 08:42:26 quinn
234 * Transfer auth info to backend. Allow backend to reject init gracefully.
236 * Revision 1.24 1995/05/16 08:51:04 quinn
237 * License, documentation, and memory fixes
239 * Revision 1.23 1995/05/15 13:25:10 quinn
242 * Revision 1.22 1995/05/15 11:56:39 quinn
243 * Asynchronous facilities. Restructuring of seshigh code.
245 * Revision 1.21 1995/05/02 08:53:19 quinn
246 * Trying in vain to fix comm with ISODE
248 * Revision 1.20 1995/04/20 15:13:00 quinn
251 * Revision 1.19 1995/04/18 08:15:34 quinn
252 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
253 * neater. We'll make the same change for decoding one day.
255 * Revision 1.18 1995/04/17 11:28:25 quinn
258 * Revision 1.17 1995/04/10 10:23:36 quinn
259 * Some work to add scan and other things.
261 * Revision 1.16 1995/03/31 09:18:55 quinn
264 * Revision 1.15 1995/03/30 14:03:23 quinn
265 * Added RFC1006 as separate library
267 * Revision 1.14 1995/03/30 12:18:17 quinn
270 * Revision 1.13 1995/03/30 09:09:24 quinn
271 * Added state-handle and some support for asynchronous activities.
273 * Revision 1.12 1995/03/29 15:40:16 quinn
274 * Ongoing work. Statserv is now dynamic by default
276 * Revision 1.11 1995/03/28 09:16:21 quinn
277 * Added record packing to the search request
279 * Revision 1.10 1995/03/27 08:34:24 quinn
280 * Added dynamic server functionality.
281 * Released bindings to session.c (is now redundant)
283 * Revision 1.9 1995/03/22 15:01:26 quinn
284 * Adjusting record packing.
286 * Revision 1.8 1995/03/22 10:13:21 quinn
287 * Working on record packer
289 * Revision 1.7 1995/03/21 15:53:31 quinn
292 * Revision 1.6 1995/03/21 12:30:09 quinn
293 * Beginning to add support for record packing.
295 * Revision 1.5 1995/03/17 10:44:13 quinn
296 * Added catch of null-string in makediagrec
298 * Revision 1.4 1995/03/17 10:18:08 quinn
299 * Added memory management.
301 * Revision 1.3 1995/03/16 17:42:39 quinn
304 * Revision 1.2 1995/03/16 13:29:01 quinn
305 * Partitioned server.
307 * Revision 1.1 1995/03/15 16:02:10 quinn
308 * Modded session.c to seshigh.c
313 * Frontend server logic.
315 * This code receives incoming APDUs, and handles client requests by means
316 * of the backend API.
318 * Some of the code is getting quite involved, compared to simpler servers -
319 * primarily because it is asynchronous both in the communication with
320 * the user and the backend. We think the complexity will pay off in
321 * the form of greater flexibility when more asynchronous facilities
324 * Memory management has become somewhat involved. In the simple case, where
325 * only one PDU is pending at a time, it will simply reuse the same memory,
326 * once it has found its working size. When we enable multiple concurrent
327 * operations, perhaps even with multiple parallel calls to the backend, it
328 * will maintain a pool of buffers for encoding and decoding, trying to
329 * minimize memory allocation/deallocation during normal operation.
331 * TODOs include (and will be done in order of public interest):
333 * Support for EXPLAIN - provide simple meta-database system.
334 * Support for access control.
335 * Support for resource control.
336 * Support for extended services - primarily Item Order.
337 * Rest of Z39.50-1994
350 #include <yaz/yconfig.h>
351 #include <yaz/xmalloc.h>
352 #include <yaz/comstack.h>
355 #include <yaz/proto.h>
358 #include <yaz/logrpn.h>
359 #include <yaz/statserv.h>
361 #include <yaz/backend.h>
363 static int process_request(association *assoc, request *req, char **msg);
364 void backend_response(IOCHAN i, int event);
365 static int process_response(association *assoc, request *req, Z_APDU *res);
366 static Z_APDU *process_initRequest(association *assoc, request *reqb);
367 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
369 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
370 bend_search_rr *bsrr, int *fd);
371 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
373 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
374 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
375 static void process_close(association *assoc, request *reqb);
376 void save_referenceId (request *reqb, Z_ReferenceId *refid);
377 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
379 static int bend_default_scan (void *handle, bend_scan_rr *rr);
381 static FILE *apduf = 0; /* for use in static mode */
382 static statserv_options_block *control_block = 0;
384 /* Chas: Added in from DALI */
385 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
386 /* Chas: End of addition from DALI */
389 * Create and initialize a new association-handle.
390 * channel : iochannel for the current line.
391 * link : communications channel.
392 * Returns: 0 or a new association handle.
394 association *create_association(IOCHAN channel, COMSTACK link)
399 control_block = statserv_getcontrol();
400 if (!(anew = (association *)xmalloc(sizeof(*anew))))
402 anew->client_chan = channel;
403 anew->client_link = link;
404 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
405 !(anew->encode = odr_createmem(ODR_ENCODE)))
407 if (*control_block->apdufile)
412 strcpy(filename, control_block->apdufile);
413 if (!(anew->print = odr_createmem(ODR_PRINT)))
415 if (*control_block->apdufile != '-')
417 strcpy(filename, control_block->apdufile);
418 if (!control_block->dynamic)
422 if (!(apduf = fopen(filename, "w")))
424 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
427 setvbuf(apduf, 0, _IONBF, 0);
433 sprintf(filename + strlen(filename), ".%d", getpid());
434 if (!(f = fopen(filename, "w")))
436 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
439 setvbuf(f, 0, _IONBF, 0);
441 odr_setprint(anew->print, f);
446 anew->input_buffer = 0;
447 anew->input_buffer_len = 0;
449 anew->state = ASSOC_NEW;
450 request_initq(&anew->incoming);
451 request_initq(&anew->outgoing);
452 anew->proto = cs_getproto(link);
457 * Free association and release resources.
459 void destroy_association(association *h)
461 odr_destroy(h->decode);
462 odr_destroy(h->encode);
464 odr_destroy(h->print);
466 xfree(h->input_buffer);
468 bend_close(h->backend);
469 while (request_deq(&h->incoming));
470 while (request_deq(&h->outgoing));
471 request_delq(&h->incoming);
472 request_delq(&h->outgoing);
474 if (control_block && control_block->one_shot)
478 static void do_close_req(association *a, int reason, char *message,
482 Z_Close *cls = zget_Close(a->encode);
484 /* Purge request queue */
485 while (request_deq(&a->incoming));
486 while (request_deq(&a->outgoing));
489 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
490 reason, message ? message : "none");
491 apdu.which = Z_APDU_close;
493 *cls->closeReason = reason;
494 cls->diagnosticInformation = message;
495 process_response(a, req, &apdu);
496 iochan_settimeout(a->client_chan, 60);
500 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
501 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
503 a->state = ASSOC_DEAD;
506 static void do_close(association *a, int reason, char *message)
508 do_close_req (a, reason, message, request_get(&a->outgoing));
512 * This is where PDUs from the client are read and the further
513 * processing is initiated. Flow of control moves down through the
514 * various process_* functions below, until the encoded result comes back up
515 * to the output handler in here.
517 * h : the I/O channel that has an outstanding event.
518 * event : the current outstanding event.
520 void ir_session(IOCHAN h, int event)
523 association *assoc = (association *)iochan_getdata(h);
524 COMSTACK conn = assoc->client_link;
527 assert(h && conn && assoc);
528 if (event == EVENT_TIMEOUT)
530 if (assoc->state != ASSOC_UP)
532 yaz_log(LOG_LOG, "Final timeout - closing connection.");
534 destroy_association(assoc);
539 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
540 do_close(assoc, Z_Close_lackOfActivity, 0);
544 if (event & EVENT_INPUT || event & EVENT_WORK) /* input */
546 if (event & EVENT_INPUT)
548 yaz_log(LOG_DEBUG, "ir_session (input)");
549 assert(assoc && conn);
550 /* We aren't speaking to this fellow */
551 if (assoc->state == ASSOC_DEAD)
553 yaz_log(LOG_LOG, "Closed connection after reject");
555 destroy_association(assoc);
559 if ((res = cs_get(conn, &assoc->input_buffer,
560 &assoc->input_buffer_len)) <= 0)
562 yaz_log(LOG_LOG, "Connection closed by client");
564 destroy_association(assoc);
568 else if (res == 1) /* incomplete read - wait for more */
570 if (cs_more(conn)) /* more stuff - call us again later, please */
571 iochan_setevent(h, EVENT_INPUT);
573 /* we got a complete PDU. Let's decode it */
574 yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
575 req = request_get(&assoc->incoming); /* get a new request structure */
576 odr_reset(assoc->decode);
577 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
578 if (!z_APDU(assoc->decode, &req->request, 0, 0))
580 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
581 odr_errmsg(odr_geterror(assoc->decode)),
582 odr_offset(assoc->decode));
583 yaz_log(LOG_LOG, "PDU dump:");
584 odr_dumpBER(log_file(), assoc->input_buffer, res);
585 do_close(assoc, Z_Close_protocolError, "Malformed package");
588 req->request_mem = odr_extract_mem(assoc->decode);
589 if (assoc->print && !z_APDU(assoc->print, &req->request, 0, 0))
591 yaz_log(LOG_WARN, "ODR print error: %s",
592 odr_errmsg(odr_geterror(assoc->print)));
593 odr_reset(assoc->print);
595 request_enq(&assoc->incoming, req);
598 /* can we do something yet? */
599 req = request_head(&assoc->incoming);
600 if (req->state == REQUEST_IDLE)
603 request_deq(&assoc->incoming);
604 if (process_request(assoc, req, &msg) < 0)
605 do_close_req(assoc, Z_Close_systemProblem, msg, req);
608 if (event & EVENT_OUTPUT)
610 request *req = request_head(&assoc->outgoing);
612 yaz_log(LOG_DEBUG, "ir_session (output)");
613 req->state = REQUEST_PENDING;
614 switch (res = cs_put(conn, req->response, req->len_response))
617 yaz_log(LOG_LOG, "Connection closed by client");
619 destroy_association(assoc);
622 case 0: /* all sent - release the request structure */
623 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
624 nmem_destroy(req->request_mem);
625 request_deq(&assoc->outgoing);
626 request_release(req);
627 if (!request_head(&assoc->outgoing))
628 iochan_clearflag(h, EVENT_OUTPUT);
630 /* value of 1 -- partial send -- is simply ignored */
633 if (event & EVENT_EXCEPT)
635 yaz_log(LOG_DEBUG, "ir_session (exception)");
637 destroy_association(assoc);
643 * Initiate request processing.
645 static int process_request(association *assoc, request *req, char **msg)
651 *msg = "Unknown Error";
652 assert(req && req->state == REQUEST_IDLE);
653 switch (req->request->which)
655 case Z_APDU_initRequest:
656 res = process_initRequest(assoc, req); break;
657 case Z_APDU_searchRequest:
658 res = process_searchRequest(assoc, req, &fd); break;
659 case Z_APDU_presentRequest:
660 res = process_presentRequest(assoc, req, &fd); break;
661 case Z_APDU_scanRequest:
662 if (assoc->bend_scan)
663 res = process_scanRequest(assoc, req, &fd);
666 *msg = "Cannot handle Scan APDU";
670 case Z_APDU_extendedServicesRequest:
671 if (assoc->bend_esrequest)
672 res = process_ESRequest(assoc, req, &fd);
675 *msg = "Cannot handle Extended Services APDU";
679 case Z_APDU_sortRequest:
680 if (assoc->bend_sort)
681 res = process_sortRequest(assoc, req, &fd);
684 *msg = "Cannot handle Sort APDU";
689 process_close(assoc, req);
691 case Z_APDU_deleteResultSetRequest:
692 if (assoc->bend_delete)
693 res = process_deleteRequest(assoc, req, &fd);
696 *msg = "Cannot handle Delete APDU";
701 *msg = "Bad APDU received";
706 yaz_log(LOG_DEBUG, " result immediately available");
707 retval = process_response(assoc, req, res);
711 yaz_log(LOG_DEBUG, " result unavailble");
714 else /* no result yet - one will be provided later */
718 /* Set up an I/O handler for the fd supplied by the backend */
720 yaz_log(LOG_DEBUG, " establishing handler for result");
721 req->state = REQUEST_PENDING;
722 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
724 iochan_setdata(chan, assoc);
731 * Handle message from the backend.
733 void backend_response(IOCHAN i, int event)
735 association *assoc = (association *)iochan_getdata(i);
736 request *req = request_head(&assoc->incoming);
740 yaz_log(LOG_DEBUG, "backend_response");
741 assert(assoc && req && req->state != REQUEST_IDLE);
742 /* determine what it is we're waiting for */
743 switch (req->request->which)
745 case Z_APDU_searchRequest:
746 res = response_searchRequest(assoc, req, 0, &fd); break;
748 case Z_APDU_presentRequest:
749 res = response_presentRequest(assoc, req, 0, &fd); break;
750 case Z_APDU_scanRequest:
751 res = response_scanRequest(assoc, req, 0, &fd); break;
754 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
757 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
759 yaz_log(LOG_LOG, "Fatal error when talking to backend");
760 do_close(assoc, Z_Close_systemProblem, 0);
764 else if (!res) /* no result yet - try again later */
766 yaz_log(LOG_DEBUG, " no result yet");
767 iochan_setfd(i, fd); /* in case fd has changed */
772 * Encode response, and transfer the request structure to the outgoing queue.
774 static int process_response(association *assoc, request *req, Z_APDU *res)
776 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
777 if (!z_APDU(assoc->encode, &res, 0, 0))
779 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
780 odr_errmsg(odr_geterror(assoc->decode)));
781 odr_reset(assoc->encode);
784 req->response = odr_getbuf(assoc->encode, &req->len_response,
785 &req->size_response);
786 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
787 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
789 yaz_log(LOG_WARN, "ODR print error: %s",
790 odr_errmsg(odr_geterror(assoc->print)));
791 odr_reset(assoc->print);
793 odr_reset(assoc->encode);
794 req->state = REQUEST_IDLE;
795 request_enq(&assoc->outgoing, req);
796 /* turn the work over to the ir_session handler */
797 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
798 /* Is there more work to be done? give that to the input handler too */
800 if (request_head(&assoc->incoming))
802 yaz_log (LOG_DEBUG, "more work to be done");
803 iochan_setevent(assoc->client_chan, EVENT_WORK);
810 * Handle init request.
811 * At the moment, we don't check the options
812 * anywhere else in the code - we just try not to do anything that would
813 * break a naive client. We'll toss 'em into the association block when
814 * we need them there.
816 static Z_APDU *process_initRequest(association *assoc, request *reqb)
818 Z_InitRequest *req = reqb->request->u.initRequest;
819 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
820 Z_InitResponse *resp = apdu->u.initResponse;
821 bend_initrequest binitreq;
822 bend_initresult *binitres;
825 yaz_log(LOG_LOG, "Got initRequest");
826 if (req->implementationId)
827 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
828 if (req->implementationName)
829 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
830 if (req->implementationVersion)
831 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
833 binitreq.stream = assoc->encode;
834 binitreq.configname = "default-config";
835 binitreq.auth = req->idAuthentication;
836 binitreq.referenceId = req->referenceId;
837 binitreq.implementation_version = 0;
838 binitreq.implementation_name = 0;
839 binitreq.bend_sort = NULL;
840 binitreq.bend_search = NULL;
841 binitreq.bend_present = NULL;
842 binitreq.bend_esrequest = NULL;
843 binitreq.bend_delete = NULL;
844 binitreq.bend_scan = bend_default_scan;
845 if (!(binitres = bend_init(&binitreq)))
847 yaz_log(LOG_WARN, "Bad response from backend.");
851 assoc->backend = binitres->handle;
852 if ((assoc->bend_sort = (int (*)())binitreq.bend_sort))
853 yaz_log (LOG_DEBUG, "Sort handler installed");
854 if ((assoc->bend_search = (int (*)())binitreq.bend_search))
855 yaz_log (LOG_DEBUG, "Search handler installed");
856 if ((assoc->bend_present = (int (*)())binitreq.bend_present))
857 yaz_log (LOG_DEBUG, "Present handler installed");
858 if ((assoc->bend_esrequest = (int (*)())binitreq.bend_esrequest))
859 yaz_log (LOG_DEBUG, "ESRequest handler installed");
860 if ((assoc->bend_delete = (int (*)())binitreq.bend_delete))
861 yaz_log (LOG_DEBUG, "Delete handler installed");
862 if ((assoc->bend_scan = (int (*)())binitreq.bend_scan))
863 yaz_log (LOG_DEBUG, "Scan handler installed");
865 resp->referenceId = req->referenceId;
867 /* let's tell the client what we can do */
868 if (ODR_MASK_GET(req->options, Z_Options_search))
870 ODR_MASK_SET(resp->options, Z_Options_search);
871 strcat(options, "srch");
873 if (ODR_MASK_GET(req->options, Z_Options_present))
875 ODR_MASK_SET(resp->options, Z_Options_present);
876 strcat(options, " prst");
878 if (ODR_MASK_GET(req->options, Z_Options_delSet) && binitreq.bend_delete)
880 ODR_MASK_SET(resp->options, Z_Options_delSet);
881 strcat(options, " del");
883 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
884 binitreq.bend_esrequest)
886 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
887 strcat (options, " extendedServices");
889 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
891 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
892 strcat(options, " namedresults");
894 if (ODR_MASK_GET(req->options, Z_Options_scan) && binitreq.bend_scan)
896 ODR_MASK_SET(resp->options, Z_Options_scan);
897 strcat(options, " scan");
899 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
901 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
902 strcat(options, " concurop");
904 if (ODR_MASK_GET(req->options, Z_Options_sort) && binitreq.bend_sort)
906 ODR_MASK_SET(resp->options, Z_Options_sort);
907 strcat(options, " sort");
909 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
911 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
912 assoc->version = 2; /* 1 & 2 are equivalent */
914 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
916 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
919 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
921 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
924 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
925 assoc->maximumRecordSize = *req->maximumRecordSize;
926 if (assoc->maximumRecordSize > control_block->maxrecordsize)
927 assoc->maximumRecordSize = control_block->maxrecordsize;
928 assoc->preferredMessageSize = *req->preferredMessageSize;
929 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
930 assoc->preferredMessageSize = assoc->maximumRecordSize;
931 resp->preferredMessageSize = &assoc->preferredMessageSize;
932 resp->maximumRecordSize = &assoc->maximumRecordSize;
934 resp->implementationName = "GFS";
936 if (binitreq.implementation_name)
939 odr_malloc (assoc->encode,
940 strlen(binitreq.implementation_name) + 10 +
941 strlen(resp->implementationName));
942 sprintf (nv, "%s / %s",
943 resp->implementationName, binitreq.implementation_name);
944 resp->implementationName = nv;
946 if (binitreq.implementation_version)
949 odr_malloc (assoc->encode,
950 strlen(binitreq.implementation_version) + 10 +
951 strlen(resp->implementationVersion));
952 sprintf (nv, "YAZ %s / %s",
953 resp->implementationVersion, binitreq.implementation_version);
954 resp->implementationVersion = nv;
957 if (binitres->errcode)
959 yaz_log(LOG_LOG, "Connection rejected by backend.");
961 assoc->state = ASSOC_DEAD;
964 assoc->state = ASSOC_UP;
969 * These functions should be merged.
972 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo)
975 dr->which = Z_DefaultDiagFormat_v2Addinfo;
976 dr->u.v2Addinfo = addinfo ? addinfo : "";
978 dr->which = Z_DiagForm_v2AddInfo;
979 dr->addinfo = addinfo ? addinfo : "";
984 * nonsurrogate diagnostic record.
986 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
989 Z_Records *rec = (Z_Records *)
990 odr_malloc (assoc->encode, sizeof(*rec));
993 odr_malloc (assoc->encode, sizeof(*err));
994 Z_DiagRec *drec = (Z_DiagRec *)
995 odr_malloc (assoc->encode, sizeof(*drec));
996 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
997 odr_malloc (assoc->encode, sizeof(*dr));
999 bib1.proto = assoc->proto;
1000 bib1.oclass = CLASS_DIAGSET;
1001 bib1.value = VAL_BIB1;
1003 yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
1006 rec->which = Z_Records_NSD;
1008 rec->u.nonSurrogateDiagnostic = dr;
1010 rec->u.nonSurrogateDiagnostic = drec;
1011 drec->which = Z_DiagRec_defaultFormat;
1012 drec->u.defaultFormat = dr;
1014 dr->diagnosticSetId =
1015 odr_oiddup (assoc->encode, oid_ent_to_oid(&bib1, oid));
1016 dr->condition = err;
1017 set_addinfo (dr, addinfo);
1022 * surrogate diagnostic.
1024 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1025 int error, char *addinfo)
1028 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1029 odr_malloc (assoc->encode, sizeof(*rec));
1030 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1032 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1033 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1034 odr_malloc (assoc->encode, sizeof(*dr));
1036 bib1.proto = assoc->proto;
1037 bib1.oclass = CLASS_DIAGSET;
1038 bib1.value = VAL_BIB1;
1040 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1042 rec->databaseName = dbname;
1043 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1044 rec->u.surrogateDiagnostic = drec;
1045 drec->which = Z_DiagRec_defaultFormat;
1046 drec->u.defaultFormat = dr;
1047 dr->diagnosticSetId = odr_oiddup (assoc->encode,
1048 oid_ent_to_oid(&bib1, oid));
1049 dr->condition = err;
1050 set_addinfo (dr, addinfo);
1056 * multiple nonsurrogate diagnostics.
1058 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1061 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1062 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1064 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1065 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1066 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)odr_malloc (assoc->encode, sizeof(*rec));
1068 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1069 bib1.proto = assoc->proto;
1070 bib1.oclass = CLASS_DIAGSET;
1071 bib1.value = VAL_BIB1;
1074 recs->num_diagRecs = 1;
1075 recs->diagRecs = recp;
1077 drec->which = Z_DiagRec_defaultFormat;
1078 drec->u.defaultFormat = rec;
1080 rec->diagnosticSetId = odr_oiddup (assoc->encode,
1081 oid_ent_to_oid(&bib1, oid));
1082 rec->condition = err;
1085 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1086 rec->u.v2Addinfo = addinfo ? addinfo : "";
1088 rec->which = Z_DiagForm_v2AddInfo;
1089 rec->addinfo = addinfo ? addinfo : "";
1094 static Z_Records *pack_records(association *a, char *setname, int start,
1095 int *num, Z_RecordComposition *comp,
1096 int *next, int *pres, oid_value format,
1097 Z_ReferenceId *referenceId)
1099 int recno, total_length = 0, toget = *num, dumped_records = 0;
1100 Z_Records *records =
1101 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1102 Z_NamePlusRecordList *reclist =
1103 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1104 Z_NamePlusRecord **list =
1105 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1107 records->which = Z_Records_DBOSD;
1108 records->u.databaseOrSurDiagnostics = reclist;
1109 reclist->num_records = 0;
1110 reclist->records = list;
1111 *pres = Z_PRES_SUCCESS;
1115 yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
1116 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1117 a->maximumRecordSize);
1118 for (recno = start; reclist->num_records < toget; recno++)
1120 bend_fetchrequest freq;
1121 bend_fetchresult *fres;
1122 Z_NamePlusRecord *thisrec;
1123 int this_length = 0;
1125 * we get the number of bytes allocated on the stream before any
1126 * allocation done by the backend - this should give us a reasonable
1127 * idea of the total size of the data so far.
1129 total_length = odr_total(a->encode) - dumped_records;
1130 freq.setname = setname;
1131 freq.number = recno;
1133 freq.format = format;
1134 freq.stream = a->encode;
1135 freq.surrogate_flag = 0;
1136 freq.referenceId = referenceId;
1137 if (!(fres = bend_fetch(a->backend, &freq, 0)))
1139 *pres = Z_PRES_FAILURE;
1140 return diagrec(a, 2, "Backend interface problem");
1142 /* backend should be able to signal whether error is system-wide
1143 or only pertaining to current record */
1146 if (!freq.surrogate_flag)
1148 *pres = Z_PRES_FAILURE;
1149 return diagrec(a, fres->errcode, fres->errstring);
1151 reclist->records[reclist->num_records] =
1152 surrogatediagrec(a, fres->basename, fres->errcode,
1154 reclist->num_records++;
1155 *next = fres->last_in_set ? 0 : recno + 1;
1159 this_length = fres->len;
1161 this_length = odr_total(a->encode) - total_length;
1162 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1163 this_length, total_length);
1164 if (this_length + total_length > a->preferredMessageSize)
1166 /* record is small enough, really */
1167 if (this_length <= a->preferredMessageSize)
1169 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1170 *pres = Z_PRES_PARTIAL_2;
1173 /* record can only be fetched by itself */
1174 if (this_length < a->maximumRecordSize)
1176 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1179 yaz_log(LOG_DEBUG, " Dropped it");
1180 reclist->records[reclist->num_records] =
1181 surrogatediagrec(a, fres->basename, 16, 0);
1182 reclist->num_records++;
1183 *next = fres->last_in_set ? 0 : recno + 1;
1184 dumped_records += this_length;
1188 else /* too big entirely */
1190 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
1191 reclist->records[reclist->num_records] =
1192 surrogatediagrec(a, fres->basename, 17, 0);
1193 reclist->num_records++;
1194 *next = fres->last_in_set ? 0 : recno + 1;
1195 dumped_records += this_length;
1200 if (!(thisrec = (Z_NamePlusRecord *)
1201 odr_malloc(a->encode, sizeof(*thisrec))))
1203 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1204 strlen(fres->basename) + 1)))
1206 strcpy(thisrec->databaseName, fres->basename);
1207 thisrec->which = Z_NamePlusRecord_databaseRecord;
1208 thisrec->u.databaseRecord = z_ext_record(a->encode, fres->format,
1209 fres->record, fres->len);
1210 if (!thisrec->u.databaseRecord)
1212 reclist->records[reclist->num_records] = thisrec;
1213 reclist->num_records++;
1214 *next = fres->last_in_set ? 0 : recno + 1;
1216 *num = reclist->num_records;
1220 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1223 Z_SearchRequest *req = reqb->request->u.searchRequest;
1224 bend_search_rr *bsrr =
1225 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1227 yaz_log(LOG_LOG, "Got SearchRequest.");
1229 bsrr->request = reqb;
1230 bsrr->association = assoc;
1231 bsrr->referenceId = req->referenceId;
1232 save_referenceId (reqb, bsrr->referenceId);
1234 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1235 if (req->databaseNames)
1238 for (i = 0; i < req->num_databaseNames; i++)
1239 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1241 switch (req->query->which)
1243 case Z_Query_type_1: case Z_Query_type_101:
1244 log_rpn_query (req->query->u.type_1);
1246 if (assoc->bend_search)
1248 bsrr->setname = req->resultSetName;
1249 bsrr->replace_set = *req->replaceIndicator;
1250 bsrr->num_bases = req->num_databaseNames;
1251 bsrr->basenames = req->databaseNames;
1252 bsrr->query = req->query;
1253 bsrr->stream = assoc->encode;
1254 bsrr->decode = assoc->decode;
1257 bsrr->errstring = NULL;
1258 ((int (*)(void *, bend_search_rr *))(assoc->bend_search))
1259 (assoc->backend, bsrr);
1265 bend_searchrequest bsrq;
1266 bend_searchresult *bsrt;
1268 bsrq.setname = req->resultSetName;
1269 bsrq.replace_set = *req->replaceIndicator;
1270 bsrq.num_bases = req->num_databaseNames;
1271 bsrq.basenames = req->databaseNames;
1272 bsrq.query = req->query;
1273 bsrq.referenceId = req->referenceId;
1274 bsrq.stream = assoc->encode;
1275 bsrq.decode = assoc->decode;
1276 if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1278 bsrr->hits = bsrt->hits;
1279 bsrr->errcode = bsrt->errcode;
1280 bsrr->errstring = bsrt->errstring;
1282 return response_searchRequest(assoc, reqb, bsrr, fd);
1285 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1288 * Prepare a searchresponse based on the backend results. We probably want
1289 * to look at making the fetching of records nonblocking as well, but
1290 * so far, we'll keep things simple.
1291 * If bsrt is null, that means we're called in response to a communications
1292 * event, and we'll have to get the response for ourselves.
1294 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1295 bend_search_rr *bsrt, int *fd)
1297 Z_SearchRequest *req = reqb->request->u.searchRequest;
1298 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1299 Z_SearchResponse *resp = (Z_SearchResponse *)
1300 odr_malloc (assoc->encode, sizeof(*resp));
1301 int *nulint = (int *)odr_malloc (assoc->encode, sizeof(*nulint));
1302 bool_t *sr = (bool_t *)odr_malloc (assoc->encode, sizeof(*sr));
1303 int *next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1304 int *none = (int *)odr_malloc (assoc->encode, sizeof(*none));
1311 apdu->which = Z_APDU_searchResponse;
1312 apdu->u.searchResponse = resp;
1313 resp->referenceId = req->referenceId;
1314 resp->additionalSearchInfo = 0;
1315 resp->otherInfo = 0;
1317 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1319 yaz_log(LOG_FATAL, "Bad result from backend");
1322 else if (bsrt->errcode)
1324 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1325 resp->resultCount = nulint;
1326 resp->numberOfRecordsReturned = nulint;
1327 resp->nextResultSetPosition = nulint;
1328 resp->searchStatus = nulint;
1329 resp->resultSetStatus = none;
1330 resp->presentStatus = 0;
1334 int *toget = (int *)odr_malloc (assoc->encode, sizeof(*toget));
1335 int *presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1336 Z_RecordComposition comp, *compp = 0;
1341 resp->resultCount = &bsrt->hits;
1343 comp.which = Z_RecordComp_simple;
1344 /* how many records does the user agent want, then? */
1345 if (bsrt->hits <= *req->smallSetUpperBound)
1347 *toget = bsrt->hits;
1348 if ((comp.u.simple = req->smallSetElementSetNames))
1351 else if (bsrt->hits < *req->largeSetLowerBound)
1353 *toget = *req->mediumSetPresentNumber;
1354 if (*toget > bsrt->hits)
1355 *toget = bsrt->hits;
1356 if ((comp.u.simple = req->mediumSetElementSetNames))
1362 if (*toget && !resp->records)
1367 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1368 prefformat->oclass != CLASS_RECSYN)
1371 form = prefformat->value;
1372 resp->records = pack_records(assoc, req->resultSetName, 1,
1373 toget, compp, next, presst, form, req->referenceId);
1376 resp->numberOfRecordsReturned = toget;
1377 resp->nextResultSetPosition = next;
1378 resp->searchStatus = sr;
1379 resp->resultSetStatus = 0;
1380 resp->presentStatus = presst;
1384 if (*resp->resultCount)
1386 resp->numberOfRecordsReturned = nulint;
1387 resp->nextResultSetPosition = next;
1388 resp->searchStatus = sr;
1389 resp->resultSetStatus = 0;
1390 resp->presentStatus = 0;
1397 * Maybe we got a little over-friendly when we designed bend_fetch to
1398 * get only one record at a time. Some backends can optimise multiple-record
1399 * fetches, and at any rate, there is some overhead involved in
1400 * all that selecting and hopping around. Problem is, of course, that the
1401 * frontend can't know ahead of time how many records it'll need to
1402 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1403 * is downright lousy as a bulk data transfer protocol.
1405 * To start with, we'll do the fetching of records from the backend
1406 * in one operation: To save some trips in and out of the event-handler,
1407 * and to simplify the interface to pack_records. At any rate, asynch
1408 * operation is more fun in operations that have an unpredictable execution
1409 * speed - which is normally more true for search than for present.
1411 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1414 Z_PresentRequest *req = reqb->request->u.presentRequest;
1418 Z_PresentResponse *resp;
1423 yaz_log(LOG_LOG, "Got PresentRequest.");
1425 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1426 prefformat->oclass != CLASS_RECSYN)
1429 form = prefformat->value;
1430 if (assoc->bend_present)
1432 bend_present_rr *bprr = (bend_present_rr *)
1433 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1434 bprr->setname = req->resultSetId;
1435 bprr->start = *req->resultSetStartPoint;
1436 bprr->number = *req->numberOfRecordsRequested;
1437 bprr->format = form;
1438 bprr->comp = req->recordComposition;
1439 bprr->referenceId = req->referenceId;
1440 bprr->stream = assoc->encode;
1441 bprr->request = reqb;
1442 bprr->association = assoc;
1444 bprr->errstring = NULL;
1445 ((int (*)(void *, bend_present_rr *))(*assoc->bend_present))(
1446 assoc->backend, bprr);
1451 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1452 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1453 presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1454 next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1455 num = (int *)odr_malloc (assoc->encode, sizeof(*num));
1458 *num = *req->numberOfRecordsRequested;
1460 apdu->which = Z_APDU_presentResponse;
1461 apdu->u.presentResponse = resp;
1462 resp->referenceId = req->referenceId;
1463 resp->otherInfo = 0;
1466 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1467 num, req->recordComposition, next, presst, form,
1471 resp->numberOfRecordsReturned = num;
1472 resp->presentStatus = presst;
1473 resp->nextResultSetPosition = next;
1478 static int bend_default_scan (void *handle, bend_scan_rr *rr)
1480 bend_scanrequest srq;
1481 bend_scanresult *srs;
1483 srq.num_bases = rr->num_bases;
1484 srq.basenames = rr->basenames;
1485 srq.attributeset = rr->attributeset;
1486 srq.referenceId = rr->referenceId;
1487 srq.term = rr->term;
1488 srq.term_position = rr->term_position;
1489 srq.num_entries = rr->num_entries;
1490 srq.stream = rr->stream;
1492 srs = bend_scan(handle, &srq, 0);
1494 rr->term_position = srs->term_position;
1495 rr->num_entries = srs->num_entries;
1496 rr->entries = srs->entries;
1497 rr->status = srs->status;
1498 rr->errcode = srs->errcode;
1499 rr->errstring = srs->errstring;
1504 * Scan was implemented rather in a hurry, and with support for only the basic
1505 * elements of the service in the backend API. Suggestions are welcome.
1507 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1509 Z_ScanRequest *req = reqb->request->u.scanRequest;
1510 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1511 Z_ScanResponse *res = (Z_ScanResponse *)
1512 odr_malloc (assoc->encode, sizeof(*res));
1513 int *scanStatus = (int *)
1514 odr_malloc (assoc->encode, sizeof(*scanStatus));
1515 int *numberOfEntriesReturned = (int *)
1516 odr_malloc (assoc->encode, sizeof(*numberOfEntriesReturned));
1517 Z_ListEntries *ents = (Z_ListEntries *)
1518 odr_malloc (assoc->encode, sizeof(*ents));
1519 Z_DiagRecs *diagrecs_p = NULL;
1523 yaz_log(LOG_LOG, "Got ScanRequest");
1524 *scanStatus = Z_Scan_failure;
1525 *numberOfEntriesReturned = 0;
1527 apdu->which = Z_APDU_scanResponse;
1528 apdu->u.scanResponse = res;
1529 res->referenceId = req->referenceId;
1531 res->scanStatus = scanStatus;
1532 res->numberOfEntriesReturned = numberOfEntriesReturned;
1533 res->positionOfTerm = 0;
1534 res->entries = ents;
1535 ents->num_entries = 0;
1536 ents->entries = NULL;
1537 ents->num_nonsurrogateDiagnostics = 0;
1538 ents->nonsurrogateDiagnostics = NULL;
1539 res->attributeSet = 0;
1542 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1543 attent->oclass != CLASS_ATTSET
1544 || attent->value != VAL_BIB1))
1545 diagrecs_p = diagrecs(assoc, 121, 0);
1546 else if (req->stepSize && *req->stepSize > 0)
1547 diagrecs_p = diagrecs(assoc, 205, 0);
1550 bend_scan_rr *bsrr = (bend_scan_rr *)
1551 odr_malloc (assoc->encode, sizeof(*bsrr));
1552 if (req->databaseNames)
1555 for (i = 0; i < req->num_databaseNames; i++)
1556 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1558 bsrr->num_bases = req->num_databaseNames;
1559 bsrr->basenames = req->databaseNames;
1560 bsrr->num_entries = *req->numberOfTermsRequested;
1561 bsrr->term = req->termListAndStartPoint;
1562 bsrr->referenceId = req->referenceId;
1563 bsrr->stream = assoc->encode;
1564 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1565 attset->oclass != CLASS_RECSYN)
1566 bsrr->attributeset = VAL_NONE;
1568 bsrr->attributeset = attset->value;
1569 log_scan_term (req->termListAndStartPoint, attset->value);
1570 bsrr->term_position = req->preferredPositionInResponse ?
1571 *req->preferredPositionInResponse : 1;
1572 ((int (*)(void *, bend_scan_rr *))(*assoc->bend_scan))(assoc->backend,
1575 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1579 Z_Entry **tab = (Z_Entry **)
1580 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1582 if (bsrr->status == BEND_SCAN_PARTIAL)
1583 *scanStatus = Z_Scan_partial_5;
1585 *scanStatus = Z_Scan_success;
1586 ents->entries = tab;
1587 ents->num_entries = bsrr->num_entries;
1588 res->numberOfEntriesReturned = &ents->num_entries;
1589 res->positionOfTerm = &bsrr->term_position;
1590 for (i = 0; i < bsrr->num_entries; i++)
1596 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1597 if (bsrr->entries[i].occurrences >= 0)
1599 e->which = Z_Entry_termInfo;
1600 e->u.termInfo = t = (Z_TermInfo *)
1601 odr_malloc(assoc->encode, sizeof(*t));
1602 t->suggestedAttributes = 0;
1604 t->alternativeTerm = 0;
1605 t->byAttributes = 0;
1606 t->otherTermInfo = 0;
1607 t->globalOccurrences = &bsrr->entries[i].occurrences;
1608 t->term = (Z_Term *)
1609 odr_malloc(assoc->encode, sizeof(*t->term));
1610 t->term->which = Z_Term_general;
1611 t->term->u.general = o =
1612 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1613 o->buf = (unsigned char *)
1614 odr_malloc(assoc->encode, o->len = o->size =
1615 strlen(bsrr->entries[i].term));
1616 memcpy(o->buf, bsrr->entries[i].term, o->len);
1617 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1618 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1622 Z_DiagRecs *drecs = diagrecs (assoc,
1623 bsrr->entries[i].errcode,
1624 bsrr->entries[i].errstring);
1625 assert (drecs->num_diagRecs == 1);
1626 e->which = Z_Entry_surrogateDiagnostic;
1627 assert (drecs->diagRecs[0]);
1628 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1635 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1636 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1641 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1644 Z_SortRequest *req = reqb->request->u.sortRequest;
1645 Z_SortResponse *res = (Z_SortResponse *)
1646 odr_malloc (assoc->encode, sizeof(*res));
1647 bend_sort_rr *bsrr = (bend_sort_rr *)
1648 odr_malloc (assoc->encode, sizeof(*bsrr));
1650 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1652 yaz_log(LOG_LOG, "Got SortRequest.");
1655 bsrr->num_input_setnames = req->num_inputResultSetNames;
1656 bsrr->input_setnames = req->inputResultSetNames;
1658 bsrr->num_input_setnames = req->inputResultSetNames->num_strings;
1659 bsrr->input_setnames = req->inputResultSetNames->strings;
1661 bsrr->referenceId = req->referenceId;
1662 bsrr->output_setname = req->sortedResultSetName;
1663 bsrr->sort_sequence = req->sortSequence;
1664 bsrr->stream = assoc->encode;
1666 bsrr->sort_status = Z_SortStatus_failure;
1668 bsrr->errstring = 0;
1670 ((int (*)(void *, bend_sort_rr *))(*assoc->bend_sort))(assoc->backend,
1673 res->referenceId = bsrr->referenceId;
1674 res->sortStatus = (int *)
1675 odr_malloc (assoc->encode, sizeof(*res->sortStatus));
1676 *res->sortStatus = bsrr->sort_status;
1677 res->resultSetStatus = 0;
1680 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1682 res->diagnostics = dr->diagRecs;
1683 res->num_diagnostics = dr->num_diagRecs;
1685 res->diagnostics = dr;
1691 res->num_diagnostics = 0;
1693 res->diagnostics = 0;
1697 apdu->which = Z_APDU_sortResponse;
1698 apdu->u.sortResponse = res;
1702 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1705 Z_DeleteResultSetRequest *req = reqb->request->u.deleteResultSetRequest;
1706 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1707 odr_malloc (assoc->encode, sizeof(*res));
1708 bend_delete_rr *bdrr = (bend_delete_rr *)
1709 odr_malloc (assoc->encode, sizeof(*bdrr));
1710 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1712 yaz_log(LOG_LOG, "Got DeleteRequest.");
1714 bdrr->num_setnames = req->num_resultSetList;
1715 bdrr->setnames = req->resultSetList;
1716 bdrr->stream = assoc->encode;
1717 bdrr->function = *req->deleteFunction;
1718 bdrr->referenceId = req->referenceId;
1720 if (bdrr->num_setnames > 0)
1723 bdrr->statuses = odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1724 bdrr->num_setnames);
1725 for (i = 0; i < bdrr->num_setnames; i++)
1726 bdrr->statuses[i] = 0;
1728 ((int (*)(void *, bend_delete_rr *))
1729 (*assoc->bend_delete))(assoc->backend, bdrr);
1731 res->referenceId = req->referenceId;
1733 res->deleteOperationStatus = (int *)
1734 odr_malloc (assoc->encode, sizeof(*res->deleteOperationStatus));
1735 *res->deleteOperationStatus = bdrr->delete_status;
1737 res->deleteListStatuses = 0;
1738 if (bdrr->num_setnames > 0)
1741 res->deleteListStatuses = odr_malloc(assoc->encode,
1742 sizeof(*res->deleteListStatuses));
1743 res->deleteListStatuses->num = bdrr->num_setnames;
1744 res->deleteListStatuses->elements =
1745 odr_malloc (assoc->encode,
1746 sizeof(*res->deleteListStatuses->elements) *
1747 bdrr->num_setnames);
1748 for (i = 0; i<bdrr->num_setnames; i++)
1750 res->deleteListStatuses->elements[i] =
1751 odr_malloc (assoc->encode,
1752 sizeof(**res->deleteListStatuses->elements));
1753 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1754 res->deleteListStatuses->elements[i]->id =
1755 odr_strdup (assoc->encode, bdrr->setnames[i]);
1759 res->numberNotDeleted = 0;
1760 res->bulkStatuses = 0;
1761 res->deleteMessage = 0;
1764 apdu->which = Z_APDU_deleteResultSetResponse;
1765 apdu->u.deleteResultSetResponse = res;
1769 static void process_close(association *assoc, request *reqb)
1771 Z_Close *req = reqb->request->u.close;
1772 static char *reasons[] =
1779 "securityViolation",
1786 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1787 reasons[*req->closeReason], req->diagnosticInformation ?
1788 req->diagnosticInformation : "NULL");
1789 if (assoc->version < 3) /* to make do_force respond with close */
1791 do_close_req(assoc, Z_Close_finished,
1792 "Association terminated by client", reqb);
1795 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1799 reqb->len_refid = refid->len;
1800 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1801 memcpy (reqb->refid, refid->buf, refid->len);
1805 reqb->len_refid = 0;
1810 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1812 process_response (a, req, res);
1815 bend_request bend_request_mk (bend_association a)
1817 request *nreq = request_get (&a->outgoing);
1818 nreq->request_mem = nmem_create ();
1822 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1827 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1828 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1829 id->len = id->size = req->len_refid;
1830 memcpy (id->buf, req->refid, req->len_refid);
1834 void bend_request_destroy (bend_request *req)
1836 nmem_destroy((*req)->request_mem);
1837 request_release(*req);
1841 int bend_backend_respond (bend_association a, bend_request req)
1845 r = process_request (a, req, &msg);
1847 logf (LOG_WARN, "%s", msg);
1851 void bend_request_setdata(bend_request r, void *p)
1856 void *bend_request_getdata(bend_request r)
1858 return r->clientData;
1861 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
1863 bend_esrequest_rr esrequest;
1865 Z_ExtendedServicesRequest *req = reqb->request->u.extendedServicesRequest;
1866 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
1868 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
1870 yaz_log(LOG_DEBUG,"inside Process esRequest");
1872 esrequest.esr = reqb->request->u.extendedServicesRequest;
1873 esrequest.stream = assoc->encode;
1874 esrequest.errcode = 0;
1875 esrequest.errstring = NULL;
1876 esrequest.request = reqb;
1877 esrequest.association = assoc;
1878 esrequest.referenceId = req->referenceId;
1880 ((int (*)(void *, bend_esrequest_rr *))(*assoc->bend_esrequest))
1881 (assoc->backend, &esrequest);
1883 /* If the response is being delayed, return NULL */
1884 if (esrequest.request == NULL)
1887 resp->referenceId = req->referenceId;
1889 if (esrequest.errcode == -1)
1891 /* Backend service indicates request will be processed */
1892 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
1893 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
1895 else if (esrequest.errcode == 0)
1897 /* Backend service indicates request will be processed */
1898 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
1899 *resp->operationStatus = Z_ExtendedServicesResponse_done;
1903 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
1904 esrequest.errstring);
1906 /* Backend indicates error, request will not be processed */
1907 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
1908 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
1909 resp->num_diagnostics = diagRecs->num_diagRecs;
1910 resp->diagnostics = diagRecs->diagRecs;
1912 /* Do something with the members of bend_extendedservice */
1914 yaz_log(LOG_DEBUG,"Send the result apdu");