2 * Copyright (c) 1995-2000, Index Data
3 * See the file LICENSE for details.
6 * Revision 1.105 2000-07-06 10:38:47 adam
7 * Enhanced option --enable-tcpd.
9 * Revision 1.104 2000/04/05 07:39:55 adam
10 * Added shared library support (libtool).
12 * Revision 1.103 2000/03/20 19:06:25 adam
13 * Added Segment request for fronend server. Work on admin for client.
15 * Revision 1.102 2000/03/15 12:59:49 adam
16 * Added handle member to statserv_control.
18 * Revision 1.101 2000/01/12 14:36:07 adam
19 * Added printing stream (ODR) for backend functions.
21 * Revision 1.100 1999/12/16 23:36:19 adam
22 * Implemented ILL protocol. Minor updates ASN.1 compiler.
24 * Revision 1.99 1999/11/30 13:47:12 adam
25 * Improved installation. Moved header files to include/yaz.
27 * Revision 1.98 1999/11/29 15:12:27 adam
28 * Changed the way implementationName - and version is set.
30 * Revision 1.96 1999/11/04 14:58:44 adam
31 * Added status elements for backend delete result set handler.
32 * Updated delete result result set command for client.
34 * Revision 1.95 1999/10/11 10:01:24 adam
35 * Implemented bend_sort_rr handler for frontend server.
37 * Revision 1.94 1999/08/27 09:40:32 adam
38 * Renamed logf function to yaz_log. Removed VC++ project files.
40 * Revision 1.93 1999/07/06 12:17:15 adam
41 * Added option -1 that runs server once (for profiling purposes).
43 * Revision 1.92 1999/06/17 10:54:45 adam
44 * Added facility to specify implementation version - and name
47 * Revision 1.91 1999/06/01 14:29:12 adam
48 * Work on Extended Services.
50 * Revision 1.90 1999/05/27 13:02:20 adam
51 * Assigned OID for old DB Update (VAL_DBUPDATE0).
53 * Revision 1.89 1999/05/26 15:24:26 adam
54 * Fixed minor bugs regarding DB Update (introduced by previous commit).
56 * Revision 1.88 1999/04/20 09:56:48 adam
57 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
58 * Modified all encoders/decoders to reflect this change.
60 * Revision 1.87 1999/03/31 11:18:25 adam
61 * Implemented odr_strdup. Added Reference ID to backend server API.
63 * Revision 1.86 1999/02/02 13:57:38 adam
64 * Uses preprocessor define WIN32 instead of WINDOWS to build code
65 * for Microsoft WIN32.
67 * Revision 1.85 1998/11/17 09:52:59 adam
68 * Fixed minor bug (introduced by previous commit).
70 * Revision 1.84 1998/11/16 16:02:32 adam
71 * Added loggin utilies, log_rpn_query and log_scan_term. These used
72 * to be part of Zebra.
74 * Revision 1.83 1998/11/03 10:09:36 adam
75 * Fixed bug regarding YC.
77 * Revision 1.82 1998/10/20 14:00:30 quinn
80 * Revision 1.81 1998/10/13 16:12:24 adam
81 * Added support for Surrogate Diagnostics for Scan Term entries.
83 * Revision 1.80 1998/09/02 12:41:53 adam
84 * Added decode stream in bend search structures.
86 * Revision 1.79 1998/08/19 16:10:08 adam
87 * Changed som member names of DeleteResultSetRequest/Response.
89 * Revision 1.78 1998/08/03 10:23:55 adam
90 * Fixed bug regarding Options for Sort.
92 * Revision 1.77 1998/07/20 12:38:42 adam
93 * Implemented delete result set service to server API.
95 * Revision 1.76 1998/05/27 16:57:07 adam
96 * Support for surrogate diagnostic records added for bend_fetch.
98 * Revision 1.75 1998/05/18 10:13:07 adam
99 * Fixed call to es_request handler - extra argument was passed.
101 * Revision 1.74 1998/03/31 15:13:20 adam
102 * Development towards compiled ASN.1.
104 * Revision 1.73 1998/03/31 11:07:45 adam
105 * Furhter work on UNIverse resource report.
106 * Added Extended Services handling in frontend server.
108 * Revision 1.72 1998/02/11 11:53:35 adam
109 * Changed code so that it compiles as C++.
111 * Revision 1.71 1998/02/10 11:03:57 adam
112 * Added support for extended handlers in backend server interface.
114 * Revision 1.70 1998/01/29 13:15:35 adam
115 * Implemented sort for the backend interface.
117 * Revision 1.69 1997/09/30 11:48:12 adam
118 * Fixed bug introduced by previous commit.
120 * Revision 1.68 1997/09/29 13:18:59 adam
121 * Added function, oid_ent_to_oid, to replace the function
122 * oid_getoidbyent, which is not thread safe.
124 * Revision 1.67 1997/09/17 12:10:40 adam
127 * Revision 1.66 1997/09/05 15:26:44 adam
128 * Added ODR encode in search and scen bend request structures.
129 * Fixed a few enums that caused trouble with C++.
131 * Revision 1.65 1997/09/01 08:53:01 adam
132 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
133 * moved a separate directory. MSV5.0 project server.dsp created.
134 * As an option, the server can now operate as an NT service.
136 * Revision 1.64 1997/04/30 08:52:11 quinn
139 * Revision 1.63 1996/10/11 11:57:26 quinn
142 * Revision 1.62 1996/07/06 19:58:35 quinn
143 * System headerfiles gathered in yconfig
145 * Revision 1.61 1996/06/10 08:56:16 quinn
148 * Revision 1.60 1996/05/30 11:03:10 quinn
149 * Fixed NextresultSetPosition bug fixed.
151 * Revision 1.59 1996/05/14 09:26:46 quinn
152 * Added attribute set to scan backend
154 * Revision 1.58 1996/02/20 12:53:04 quinn
157 * Revision 1.57 1996/01/02 08:57:47 quinn
158 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
160 * Revision 1.56 1995/12/14 11:09:57 quinn
163 * Revision 1.55 1995/11/08 17:41:37 quinn
166 * Revision 1.54 1995/11/08 15:11:29 quinn
167 * Log of close transmit.
169 * Revision 1.53 1995/11/01 13:54:58 quinn
172 * Revision 1.52 1995/11/01 12:19:13 quinn
173 * Second attempt to fix same bug.
175 * Revision 1.50 1995/10/25 16:58:32 quinn
178 * Revision 1.49 1995/10/16 13:51:53 quinn
179 * Changes to provide Especs to the backend.
181 * Revision 1.48 1995/10/06 08:51:20 quinn
182 * Added Write-buffer.
184 * Revision 1.47 1995/08/29 14:24:16 quinn
185 * Added second half of close-handshake
187 * Revision 1.46 1995/08/29 11:17:58 quinn
188 * Added code to receive close
190 * Revision 1.45 1995/08/21 09:11:00 quinn
191 * Smallish fixes to suppport new formats.
193 * Revision 1.44 1995/08/17 12:45:25 quinn
194 * Fixed minor problems with GRS-1. Added support in c&s.
196 * Revision 1.43 1995/08/15 12:00:31 quinn
199 * Revision 1.42 1995/08/15 11:16:50 quinn
201 * Revision 1.41 1995/08/02 10:23:06 quinn
204 * Revision 1.40 1995/07/31 14:34:26 quinn
205 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
207 * Revision 1.39 1995/06/27 13:21:00 quinn
210 * Revision 1.38 1995/06/19 12:39:11 quinn
211 * Fixed bug in timeout code. Added BER dumper.
213 * Revision 1.37 1995/06/16 13:16:14 quinn
214 * Fixed Defaultdiagformat.
216 * Revision 1.36 1995/06/16 10:31:36 quinn
217 * Added session timeout.
219 * Revision 1.35 1995/06/15 07:45:14 quinn
222 * Revision 1.34 1995/06/14 15:26:46 quinn
223 * *** empty log message ***
225 * Revision 1.33 1995/06/06 14:57:05 quinn
226 * Better diagnostics.
228 * Revision 1.32 1995/06/06 08:41:44 quinn
229 * Better diagnostics.
231 * Revision 1.31 1995/06/06 08:15:37 quinn
234 * Revision 1.30 1995/06/05 10:53:32 quinn
235 * Added a better SCAN.
237 * Revision 1.29 1995/06/01 11:25:03 quinn
240 * Revision 1.28 1995/06/01 11:21:01 quinn
241 * Attempting to fix a bug in pack-records. replaced break with continue
242 * for large records, according to standard.
244 * Revision 1.27 1995/05/29 08:12:06 quinn
247 * Revision 1.26 1995/05/18 13:02:12 quinn
250 * Revision 1.25 1995/05/17 08:42:26 quinn
251 * Transfer auth info to backend. Allow backend to reject init gracefully.
253 * Revision 1.24 1995/05/16 08:51:04 quinn
254 * License, documentation, and memory fixes
256 * Revision 1.23 1995/05/15 13:25:10 quinn
259 * Revision 1.22 1995/05/15 11:56:39 quinn
260 * Asynchronous facilities. Restructuring of seshigh code.
262 * Revision 1.21 1995/05/02 08:53:19 quinn
263 * Trying in vain to fix comm with ISODE
265 * Revision 1.20 1995/04/20 15:13:00 quinn
268 * Revision 1.19 1995/04/18 08:15:34 quinn
269 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
270 * neater. We'll make the same change for decoding one day.
272 * Revision 1.18 1995/04/17 11:28:25 quinn
275 * Revision 1.17 1995/04/10 10:23:36 quinn
276 * Some work to add scan and other things.
278 * Revision 1.16 1995/03/31 09:18:55 quinn
281 * Revision 1.15 1995/03/30 14:03:23 quinn
282 * Added RFC1006 as separate library
284 * Revision 1.14 1995/03/30 12:18:17 quinn
287 * Revision 1.13 1995/03/30 09:09:24 quinn
288 * Added state-handle and some support for asynchronous activities.
290 * Revision 1.12 1995/03/29 15:40:16 quinn
291 * Ongoing work. Statserv is now dynamic by default
293 * Revision 1.11 1995/03/28 09:16:21 quinn
294 * Added record packing to the search request
296 * Revision 1.10 1995/03/27 08:34:24 quinn
297 * Added dynamic server functionality.
298 * Released bindings to session.c (is now redundant)
300 * Revision 1.9 1995/03/22 15:01:26 quinn
301 * Adjusting record packing.
303 * Revision 1.8 1995/03/22 10:13:21 quinn
304 * Working on record packer
306 * Revision 1.7 1995/03/21 15:53:31 quinn
309 * Revision 1.6 1995/03/21 12:30:09 quinn
310 * Beginning to add support for record packing.
312 * Revision 1.5 1995/03/17 10:44:13 quinn
313 * Added catch of null-string in makediagrec
315 * Revision 1.4 1995/03/17 10:18:08 quinn
316 * Added memory management.
318 * Revision 1.3 1995/03/16 17:42:39 quinn
321 * Revision 1.2 1995/03/16 13:29:01 quinn
322 * Partitioned server.
324 * Revision 1.1 1995/03/15 16:02:10 quinn
325 * Modded session.c to seshigh.c
330 * Frontend server logic.
332 * This code receives incoming APDUs, and handles client requests by means
333 * of the backend API.
335 * Some of the code is getting quite involved, compared to simpler servers -
336 * primarily because it is asynchronous both in the communication with
337 * the user and the backend. We think the complexity will pay off in
338 * the form of greater flexibility when more asynchronous facilities
341 * Memory management has become somewhat involved. In the simple case, where
342 * only one PDU is pending at a time, it will simply reuse the same memory,
343 * once it has found its working size. When we enable multiple concurrent
344 * operations, perhaps even with multiple parallel calls to the backend, it
345 * will maintain a pool of buffers for encoding and decoding, trying to
346 * minimize memory allocation/deallocation during normal operation.
348 * TODOs include (and will be done in order of public interest):
350 * Support for EXPLAIN - provide simple meta-database system.
351 * Support for access control.
352 * Support for resource control.
353 * Support for extended services - primarily Item Order.
354 * Rest of Z39.50-1994
367 #include <yaz/yconfig.h>
368 #include <yaz/xmalloc.h>
369 #include <yaz/comstack.h>
372 #include <yaz/proto.h>
375 #include <yaz/logrpn.h>
376 #include <yaz/statserv.h>
378 #include <yaz/backend.h>
380 static int process_request(association *assoc, request *req, char **msg);
381 void backend_response(IOCHAN i, int event);
382 static int process_response(association *assoc, request *req, Z_APDU *res);
383 static Z_APDU *process_initRequest(association *assoc, request *reqb);
384 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
386 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
387 bend_search_rr *bsrr, int *fd);
388 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
390 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
391 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
392 static void process_close(association *assoc, request *reqb);
393 void save_referenceId (request *reqb, Z_ReferenceId *refid);
394 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
396 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
398 static FILE *apduf = 0; /* for use in static mode */
399 static statserv_options_block *control_block = 0;
401 /* Chas: Added in from DALI */
402 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
403 /* Chas: End of addition from DALI */
406 * Create and initialize a new association-handle.
407 * channel : iochannel for the current line.
408 * link : communications channel.
409 * Returns: 0 or a new association handle.
411 association *create_association(IOCHAN channel, COMSTACK link)
416 control_block = statserv_getcontrol();
417 if (!(anew = (association *)xmalloc(sizeof(*anew))))
420 anew->client_chan = channel;
421 anew->client_link = link;
422 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
423 !(anew->encode = odr_createmem(ODR_ENCODE)))
425 if (*control_block->apdufile)
430 strcpy(filename, control_block->apdufile);
431 if (!(anew->print = odr_createmem(ODR_PRINT)))
433 if (*control_block->apdufile != '-')
435 strcpy(filename, control_block->apdufile);
436 if (!control_block->dynamic)
440 if (!(apduf = fopen(filename, "w")))
442 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
445 setvbuf(apduf, 0, _IONBF, 0);
451 sprintf(filename + strlen(filename), ".%d", getpid());
452 if (!(f = fopen(filename, "w")))
454 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
457 setvbuf(f, 0, _IONBF, 0);
459 odr_setprint(anew->print, f);
464 anew->input_buffer = 0;
465 anew->input_buffer_len = 0;
467 anew->state = ASSOC_NEW;
468 request_initq(&anew->incoming);
469 request_initq(&anew->outgoing);
470 anew->proto = cs_getproto(link);
475 * Free association and release resources.
477 void destroy_association(association *h)
479 statserv_options_block *cb = statserv_getcontrol();
482 odr_destroy(h->decode);
483 odr_destroy(h->encode);
485 odr_destroy(h->print);
487 xfree(h->input_buffer);
489 (*cb->bend_close)(h->backend);
490 while (request_deq(&h->incoming));
491 while (request_deq(&h->outgoing));
492 request_delq(&h->incoming);
493 request_delq(&h->outgoing);
495 if (control_block && control_block->one_shot)
499 static void do_close_req(association *a, int reason, char *message,
503 Z_Close *cls = zget_Close(a->encode);
505 /* Purge request queue */
506 while (request_deq(&a->incoming));
507 while (request_deq(&a->outgoing));
510 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
511 reason, message ? message : "none");
512 apdu.which = Z_APDU_close;
514 *cls->closeReason = reason;
515 cls->diagnosticInformation = message;
516 process_response(a, req, &apdu);
517 iochan_settimeout(a->client_chan, 60);
521 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
522 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
524 a->state = ASSOC_DEAD;
527 static void do_close(association *a, int reason, char *message)
529 do_close_req (a, reason, message, request_get(&a->outgoing));
533 * This is where PDUs from the client are read and the further
534 * processing is initiated. Flow of control moves down through the
535 * various process_* functions below, until the encoded result comes back up
536 * to the output handler in here.
538 * h : the I/O channel that has an outstanding event.
539 * event : the current outstanding event.
541 void ir_session(IOCHAN h, int event)
544 association *assoc = (association *)iochan_getdata(h);
545 COMSTACK conn = assoc->client_link;
548 assert(h && conn && assoc);
549 if (event == EVENT_TIMEOUT)
551 if (assoc->state != ASSOC_UP)
553 yaz_log(LOG_LOG, "Final timeout - closing connection.");
555 destroy_association(assoc);
560 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
561 do_close(assoc, Z_Close_lackOfActivity, 0);
565 if (event & EVENT_INPUT || event & EVENT_WORK) /* input */
567 if (event & EVENT_INPUT)
569 yaz_log(LOG_DEBUG, "ir_session (input)");
570 assert(assoc && conn);
571 /* We aren't speaking to this fellow */
572 if (assoc->state == ASSOC_DEAD)
574 yaz_log(LOG_LOG, "Closed connection after reject");
576 destroy_association(assoc);
580 if ((res = cs_get(conn, &assoc->input_buffer,
581 &assoc->input_buffer_len)) <= 0)
583 yaz_log(LOG_LOG, "Connection closed by client");
585 destroy_association(assoc);
589 else if (res == 1) /* incomplete read - wait for more */
591 if (cs_more(conn)) /* more stuff - call us again later, please */
592 iochan_setevent(h, EVENT_INPUT);
594 /* we got a complete PDU. Let's decode it */
595 yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
596 req = request_get(&assoc->incoming); /* get a new request structure */
597 odr_reset(assoc->decode);
598 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
599 if (!z_APDU(assoc->decode, &req->request, 0, 0))
601 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
602 odr_errmsg(odr_geterror(assoc->decode)),
603 odr_offset(assoc->decode));
604 yaz_log(LOG_LOG, "PDU dump:");
605 odr_dumpBER(log_file(), assoc->input_buffer, res);
606 do_close(assoc, Z_Close_protocolError, "Malformed package");
609 req->request_mem = odr_extract_mem(assoc->decode);
610 if (assoc->print && !z_APDU(assoc->print, &req->request, 0, 0))
612 yaz_log(LOG_WARN, "ODR print error: %s",
613 odr_errmsg(odr_geterror(assoc->print)));
614 odr_reset(assoc->print);
616 request_enq(&assoc->incoming, req);
619 /* can we do something yet? */
620 req = request_head(&assoc->incoming);
621 if (req->state == REQUEST_IDLE)
624 request_deq(&assoc->incoming);
625 if (process_request(assoc, req, &msg) < 0)
626 do_close_req(assoc, Z_Close_systemProblem, msg, req);
629 if (event & EVENT_OUTPUT)
631 request *req = request_head(&assoc->outgoing);
633 yaz_log(LOG_DEBUG, "ir_session (output)");
634 req->state = REQUEST_PENDING;
635 switch (res = cs_put(conn, req->response, req->len_response))
638 yaz_log(LOG_LOG, "Connection closed by client");
640 destroy_association(assoc);
643 case 0: /* all sent - release the request structure */
644 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
645 nmem_destroy(req->request_mem);
646 request_deq(&assoc->outgoing);
647 request_release(req);
648 if (!request_head(&assoc->outgoing))
649 iochan_clearflag(h, EVENT_OUTPUT);
651 /* value of 1 -- partial send -- is simply ignored */
654 if (event & EVENT_EXCEPT)
656 yaz_log(LOG_DEBUG, "ir_session (exception)");
658 destroy_association(assoc);
664 * Initiate request processing.
666 static int process_request(association *assoc, request *req, char **msg)
672 *msg = "Unknown Error";
673 assert(req && req->state == REQUEST_IDLE);
674 if (req->request->which != Z_APDU_initRequest && !assoc->init)
676 *msg = "Missing InitRequest";
679 switch (req->request->which)
681 case Z_APDU_initRequest:
682 res = process_initRequest(assoc, req); break;
683 case Z_APDU_searchRequest:
684 res = process_searchRequest(assoc, req, &fd); break;
685 case Z_APDU_presentRequest:
686 res = process_presentRequest(assoc, req, &fd); break;
687 case Z_APDU_scanRequest:
688 if (assoc->init->bend_scan)
689 res = process_scanRequest(assoc, req, &fd);
692 *msg = "Cannot handle Scan APDU";
696 case Z_APDU_extendedServicesRequest:
697 if (assoc->init->bend_esrequest)
698 res = process_ESRequest(assoc, req, &fd);
701 *msg = "Cannot handle Extended Services APDU";
705 case Z_APDU_sortRequest:
706 if (assoc->init->bend_sort)
707 res = process_sortRequest(assoc, req, &fd);
710 *msg = "Cannot handle Sort APDU";
715 process_close(assoc, req);
717 case Z_APDU_deleteResultSetRequest:
718 if (assoc->init->bend_delete)
719 res = process_deleteRequest(assoc, req, &fd);
722 *msg = "Cannot handle Delete APDU";
726 case Z_APDU_segmentRequest:
727 if (assoc->init->bend_segment)
729 res = process_segmentRequest (assoc, req);
733 *msg = "Cannot handle Segment APDU";
738 *msg = "Bad APDU received";
743 yaz_log(LOG_DEBUG, " result immediately available");
744 retval = process_response(assoc, req, res);
748 yaz_log(LOG_DEBUG, " result unavailble");
751 else /* no result yet - one will be provided later */
755 /* Set up an I/O handler for the fd supplied by the backend */
757 yaz_log(LOG_DEBUG, " establishing handler for result");
758 req->state = REQUEST_PENDING;
759 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
761 iochan_setdata(chan, assoc);
768 * Handle message from the backend.
770 void backend_response(IOCHAN i, int event)
772 association *assoc = (association *)iochan_getdata(i);
773 request *req = request_head(&assoc->incoming);
777 yaz_log(LOG_DEBUG, "backend_response");
778 assert(assoc && req && req->state != REQUEST_IDLE);
779 /* determine what it is we're waiting for */
780 switch (req->request->which)
782 case Z_APDU_searchRequest:
783 res = response_searchRequest(assoc, req, 0, &fd); break;
785 case Z_APDU_presentRequest:
786 res = response_presentRequest(assoc, req, 0, &fd); break;
787 case Z_APDU_scanRequest:
788 res = response_scanRequest(assoc, req, 0, &fd); break;
791 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
794 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
796 yaz_log(LOG_LOG, "Fatal error when talking to backend");
797 do_close(assoc, Z_Close_systemProblem, 0);
801 else if (!res) /* no result yet - try again later */
803 yaz_log(LOG_DEBUG, " no result yet");
804 iochan_setfd(i, fd); /* in case fd has changed */
809 * Encode response, and transfer the request structure to the outgoing queue.
811 static int process_response(association *assoc, request *req, Z_APDU *res)
813 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
814 if (!z_APDU(assoc->encode, &res, 0, 0))
816 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
817 odr_errmsg(odr_geterror(assoc->decode)));
818 odr_reset(assoc->encode);
821 req->response = odr_getbuf(assoc->encode, &req->len_response,
822 &req->size_response);
823 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
824 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
826 yaz_log(LOG_WARN, "ODR print error: %s",
827 odr_errmsg(odr_geterror(assoc->print)));
828 odr_reset(assoc->print);
830 odr_reset(assoc->encode);
831 req->state = REQUEST_IDLE;
832 request_enq(&assoc->outgoing, req);
833 /* turn the work over to the ir_session handler */
834 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
835 /* Is there more work to be done? give that to the input handler too */
837 if (request_head(&assoc->incoming))
839 yaz_log (LOG_DEBUG, "more work to be done");
840 iochan_setevent(assoc->client_chan, EVENT_WORK);
847 * Handle init request.
848 * At the moment, we don't check the options
849 * anywhere else in the code - we just try not to do anything that would
850 * break a naive client. We'll toss 'em into the association block when
851 * we need them there.
853 static Z_APDU *process_initRequest(association *assoc, request *reqb)
855 statserv_options_block *cb = statserv_getcontrol();
856 Z_InitRequest *req = reqb->request->u.initRequest;
857 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
858 Z_InitResponse *resp = apdu->u.initResponse;
859 bend_initresult *binitres;
863 assoc->init = xmalloc (sizeof(*assoc->init));
865 yaz_log(LOG_LOG, "Got initRequest");
866 if (req->implementationId)
867 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
868 if (req->implementationName)
869 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
870 if (req->implementationVersion)
871 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
873 assoc->init->stream = assoc->encode;
874 assoc->init->print = assoc->print;
875 assoc->init->auth = req->idAuthentication;
876 assoc->init->referenceId = req->referenceId;
877 assoc->init->implementation_version = 0;
878 assoc->init->implementation_name = 0;
879 assoc->init->bend_sort = NULL;
880 assoc->init->bend_search = NULL;
881 assoc->init->bend_present = NULL;
882 assoc->init->bend_esrequest = NULL;
883 assoc->init->bend_delete = NULL;
884 assoc->init->bend_scan = NULL;
885 assoc->init->bend_segment = NULL;
886 assoc->init->bend_fetch = NULL;
887 if (!(binitres = (*cb->bend_init)(assoc->init)))
889 yaz_log(LOG_WARN, "Bad response from backend.");
893 assoc->backend = binitres->handle;
894 if ((assoc->init->bend_sort))
895 yaz_log (LOG_DEBUG, "Sort handler installed");
896 if ((assoc->init->bend_search))
897 yaz_log (LOG_DEBUG, "Search handler installed");
898 if ((assoc->init->bend_present))
899 yaz_log (LOG_DEBUG, "Present handler installed");
900 if ((assoc->init->bend_esrequest))
901 yaz_log (LOG_DEBUG, "ESRequest handler installed");
902 if ((assoc->init->bend_delete))
903 yaz_log (LOG_DEBUG, "Delete handler installed");
904 if ((assoc->init->bend_scan))
905 yaz_log (LOG_DEBUG, "Scan handler installed");
906 if ((assoc->init->bend_segment))
907 yaz_log (LOG_DEBUG, "Segment handler installed");
909 resp->referenceId = req->referenceId;
911 /* let's tell the client what we can do */
912 if (ODR_MASK_GET(req->options, Z_Options_search))
914 ODR_MASK_SET(resp->options, Z_Options_search);
915 strcat(options, "srch");
917 if (ODR_MASK_GET(req->options, Z_Options_present))
919 ODR_MASK_SET(resp->options, Z_Options_present);
920 strcat(options, " prst");
922 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
923 assoc->init->bend_delete)
925 ODR_MASK_SET(resp->options, Z_Options_delSet);
926 strcat(options, " del");
928 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
929 assoc->init->bend_esrequest)
931 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
932 strcat (options, " extendedServices");
934 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
936 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
937 strcat(options, " namedresults");
939 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
941 ODR_MASK_SET(resp->options, Z_Options_scan);
942 strcat(options, " scan");
944 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
946 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
947 strcat(options, " concurop");
949 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
951 ODR_MASK_SET(resp->options, Z_Options_sort);
952 strcat(options, " sort");
954 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
956 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
957 assoc->version = 2; /* 1 & 2 are equivalent */
959 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
961 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
964 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
966 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
969 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
970 assoc->maximumRecordSize = *req->maximumRecordSize;
971 if (assoc->maximumRecordSize > control_block->maxrecordsize)
972 assoc->maximumRecordSize = control_block->maxrecordsize;
973 assoc->preferredMessageSize = *req->preferredMessageSize;
974 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
975 assoc->preferredMessageSize = assoc->maximumRecordSize;
976 resp->preferredMessageSize = &assoc->preferredMessageSize;
977 resp->maximumRecordSize = &assoc->maximumRecordSize;
979 resp->implementationName = "GFS";
981 if (assoc->init->implementation_name)
984 odr_malloc (assoc->encode,
985 strlen(assoc->init->implementation_name) + 10 +
986 strlen(resp->implementationName));
987 sprintf (nv, "%s / %s",
988 resp->implementationName, assoc->init->implementation_name);
989 resp->implementationName = nv;
991 if (assoc->init->implementation_version)
994 odr_malloc (assoc->encode,
995 strlen(assoc->init->implementation_version) + 10 +
996 strlen(resp->implementationVersion));
997 sprintf (nv, "YAZ %s / %s",
998 resp->implementationVersion,
999 assoc->init->implementation_version);
1000 resp->implementationVersion = nv;
1003 if (binitres->errcode)
1005 yaz_log(LOG_LOG, "Connection rejected by backend.");
1007 assoc->state = ASSOC_DEAD;
1010 assoc->state = ASSOC_UP;
1015 * These functions should be merged.
1018 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo)
1021 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1022 dr->u.v2Addinfo = addinfo ? addinfo : "";
1024 dr->which = Z_DiagForm_v2AddInfo;
1025 dr->addinfo = addinfo ? addinfo : "";
1030 * nonsurrogate diagnostic record.
1032 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
1035 Z_Records *rec = (Z_Records *)
1036 odr_malloc (assoc->encode, sizeof(*rec));
1039 odr_malloc (assoc->encode, sizeof(*err));
1040 Z_DiagRec *drec = (Z_DiagRec *)
1041 odr_malloc (assoc->encode, sizeof(*drec));
1042 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1043 odr_malloc (assoc->encode, sizeof(*dr));
1045 bib1.proto = assoc->proto;
1046 bib1.oclass = CLASS_DIAGSET;
1047 bib1.value = VAL_BIB1;
1049 yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
1052 rec->which = Z_Records_NSD;
1054 rec->u.nonSurrogateDiagnostic = dr;
1056 rec->u.nonSurrogateDiagnostic = drec;
1057 drec->which = Z_DiagRec_defaultFormat;
1058 drec->u.defaultFormat = dr;
1060 dr->diagnosticSetId =
1061 odr_oiddup (assoc->encode, oid_ent_to_oid(&bib1, oid));
1062 dr->condition = err;
1063 set_addinfo (dr, addinfo);
1068 * surrogate diagnostic.
1070 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1071 int error, char *addinfo)
1074 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1075 odr_malloc (assoc->encode, sizeof(*rec));
1076 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1078 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1079 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1080 odr_malloc (assoc->encode, sizeof(*dr));
1082 bib1.proto = assoc->proto;
1083 bib1.oclass = CLASS_DIAGSET;
1084 bib1.value = VAL_BIB1;
1086 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1088 rec->databaseName = dbname;
1089 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1090 rec->u.surrogateDiagnostic = drec;
1091 drec->which = Z_DiagRec_defaultFormat;
1092 drec->u.defaultFormat = dr;
1093 dr->diagnosticSetId = odr_oiddup (assoc->encode,
1094 oid_ent_to_oid(&bib1, oid));
1095 dr->condition = err;
1096 set_addinfo (dr, addinfo);
1102 * multiple nonsurrogate diagnostics.
1104 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1107 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1108 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1110 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1111 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1112 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)odr_malloc (assoc->encode, sizeof(*rec));
1114 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1115 bib1.proto = assoc->proto;
1116 bib1.oclass = CLASS_DIAGSET;
1117 bib1.value = VAL_BIB1;
1120 recs->num_diagRecs = 1;
1121 recs->diagRecs = recp;
1123 drec->which = Z_DiagRec_defaultFormat;
1124 drec->u.defaultFormat = rec;
1126 rec->diagnosticSetId = odr_oiddup (assoc->encode,
1127 oid_ent_to_oid(&bib1, oid));
1128 rec->condition = err;
1131 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1132 rec->u.v2Addinfo = addinfo ? addinfo : "";
1134 rec->which = Z_DiagForm_v2AddInfo;
1135 rec->addinfo = addinfo ? addinfo : "";
1140 static Z_Records *pack_records(association *a, char *setname, int start,
1141 int *num, Z_RecordComposition *comp,
1142 int *next, int *pres, oid_value format,
1143 Z_ReferenceId *referenceId)
1145 int recno, total_length = 0, toget = *num, dumped_records = 0;
1146 Z_Records *records =
1147 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1148 Z_NamePlusRecordList *reclist =
1149 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1150 Z_NamePlusRecord **list =
1151 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1153 records->which = Z_Records_DBOSD;
1154 records->u.databaseOrSurDiagnostics = reclist;
1155 reclist->num_records = 0;
1156 reclist->records = list;
1157 *pres = Z_PRES_SUCCESS;
1161 yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
1162 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1163 a->maximumRecordSize);
1164 for (recno = start; reclist->num_records < toget; recno++)
1167 Z_NamePlusRecord *thisrec;
1168 int this_length = 0;
1170 * we get the number of bytes allocated on the stream before any
1171 * allocation done by the backend - this should give us a reasonable
1172 * idea of the total size of the data so far.
1174 total_length = odr_total(a->encode) - dumped_records;
1180 freq.last_in_set = 0;
1181 freq.setname = setname;
1182 freq.surrogate_flag = 0;
1183 freq.number = recno;
1185 freq.request_format = format;
1186 freq.output_format = 0;
1187 freq.stream = a->encode;
1188 freq.print = a->print;
1189 freq.surrogate_flag = 0;
1190 freq.referenceId = referenceId;
1191 (*a->init->bend_fetch)(a->backend, &freq);
1192 /* backend should be able to signal whether error is system-wide
1193 or only pertaining to current record */
1196 if (!freq.surrogate_flag)
1198 *pres = Z_PRES_FAILURE;
1199 return diagrec(a, freq.errcode, freq.errstring);
1201 reclist->records[reclist->num_records] =
1202 surrogatediagrec(a, freq.basename, freq.errcode,
1204 reclist->num_records++;
1205 *next = freq.last_in_set ? 0 : recno + 1;
1209 this_length = freq.len;
1211 this_length = odr_total(a->encode) - total_length;
1212 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1213 this_length, total_length);
1214 if (this_length + total_length > a->preferredMessageSize)
1216 /* record is small enough, really */
1217 if (this_length <= a->preferredMessageSize)
1219 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1220 *pres = Z_PRES_PARTIAL_2;
1223 /* record can only be fetched by itself */
1224 if (this_length < a->maximumRecordSize)
1226 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1229 yaz_log(LOG_DEBUG, " Dropped it");
1230 reclist->records[reclist->num_records] =
1231 surrogatediagrec(a, freq.basename, 16, 0);
1232 reclist->num_records++;
1233 *next = freq.last_in_set ? 0 : recno + 1;
1234 dumped_records += this_length;
1238 else /* too big entirely */
1240 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
1241 reclist->records[reclist->num_records] =
1242 surrogatediagrec(a, freq.basename, 17, 0);
1243 reclist->num_records++;
1244 *next = freq.last_in_set ? 0 : recno + 1;
1245 dumped_records += this_length;
1250 if (!(thisrec = (Z_NamePlusRecord *)
1251 odr_malloc(a->encode, sizeof(*thisrec))))
1253 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1254 strlen(freq.basename) + 1)))
1256 strcpy(thisrec->databaseName, freq.basename);
1257 thisrec->which = Z_NamePlusRecord_databaseRecord;
1258 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
1259 freq.record, freq.len);
1260 if (!thisrec->u.databaseRecord)
1262 reclist->records[reclist->num_records] = thisrec;
1263 reclist->num_records++;
1264 *next = freq.last_in_set ? 0 : recno + 1;
1266 *num = reclist->num_records;
1270 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1273 Z_SearchRequest *req = reqb->request->u.searchRequest;
1274 bend_search_rr *bsrr =
1275 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1277 yaz_log(LOG_LOG, "Got SearchRequest.");
1279 bsrr->request = reqb;
1280 bsrr->association = assoc;
1281 bsrr->referenceId = req->referenceId;
1282 save_referenceId (reqb, bsrr->referenceId);
1284 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1285 if (req->databaseNames)
1288 for (i = 0; i < req->num_databaseNames; i++)
1289 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1291 switch (req->query->which)
1293 case Z_Query_type_1: case Z_Query_type_101:
1294 log_rpn_query (req->query->u.type_1);
1296 if (assoc->init->bend_search)
1298 bsrr->setname = req->resultSetName;
1299 bsrr->replace_set = *req->replaceIndicator;
1300 bsrr->num_bases = req->num_databaseNames;
1301 bsrr->basenames = req->databaseNames;
1302 bsrr->query = req->query;
1303 bsrr->stream = assoc->encode;
1304 bsrr->decode = assoc->decode;
1305 bsrr->print = assoc->print;
1308 bsrr->errstring = NULL;
1309 (assoc->init->bend_search)(assoc->backend, bsrr);
1316 bend_searchrequest bsrq;
1317 bend_searchresult *bsrt;
1319 bsrq.setname = req->resultSetName;
1320 bsrq.replace_set = *req->replaceIndicator;
1321 bsrq.num_bases = req->num_databaseNames;
1322 bsrq.basenames = req->databaseNames;
1323 bsrq.query = req->query;
1324 bsrq.referenceId = req->referenceId;
1325 bsrq.stream = assoc->encode;
1326 bsrq.decode = assoc->decode;
1327 bsrq.print = assoc->print;
1328 if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1330 bsrr->hits = bsrt->hits;
1331 bsrr->errcode = bsrt->errcode;
1332 bsrr->errstring = bsrt->errstring;
1335 return response_searchRequest(assoc, reqb, bsrr, fd);
1338 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1341 * Prepare a searchresponse based on the backend results. We probably want
1342 * to look at making the fetching of records nonblocking as well, but
1343 * so far, we'll keep things simple.
1344 * If bsrt is null, that means we're called in response to a communications
1345 * event, and we'll have to get the response for ourselves.
1347 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1348 bend_search_rr *bsrt, int *fd)
1350 Z_SearchRequest *req = reqb->request->u.searchRequest;
1351 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1352 Z_SearchResponse *resp = (Z_SearchResponse *)
1353 odr_malloc (assoc->encode, sizeof(*resp));
1354 int *nulint = (int *)odr_malloc (assoc->encode, sizeof(*nulint));
1355 bool_t *sr = (bool_t *)odr_malloc (assoc->encode, sizeof(*sr));
1356 int *next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1357 int *none = (int *)odr_malloc (assoc->encode, sizeof(*none));
1364 apdu->which = Z_APDU_searchResponse;
1365 apdu->u.searchResponse = resp;
1366 resp->referenceId = req->referenceId;
1367 resp->additionalSearchInfo = 0;
1368 resp->otherInfo = 0;
1370 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1372 yaz_log(LOG_FATAL, "Bad result from backend");
1375 else if (bsrt->errcode)
1377 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1378 resp->resultCount = nulint;
1379 resp->numberOfRecordsReturned = nulint;
1380 resp->nextResultSetPosition = nulint;
1381 resp->searchStatus = nulint;
1382 resp->resultSetStatus = none;
1383 resp->presentStatus = 0;
1387 int *toget = (int *)odr_malloc (assoc->encode, sizeof(*toget));
1388 int *presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1389 Z_RecordComposition comp, *compp = 0;
1394 resp->resultCount = &bsrt->hits;
1396 comp.which = Z_RecordComp_simple;
1397 /* how many records does the user agent want, then? */
1398 if (bsrt->hits <= *req->smallSetUpperBound)
1400 *toget = bsrt->hits;
1401 if ((comp.u.simple = req->smallSetElementSetNames))
1404 else if (bsrt->hits < *req->largeSetLowerBound)
1406 *toget = *req->mediumSetPresentNumber;
1407 if (*toget > bsrt->hits)
1408 *toget = bsrt->hits;
1409 if ((comp.u.simple = req->mediumSetElementSetNames))
1415 if (*toget && !resp->records)
1420 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1421 prefformat->oclass != CLASS_RECSYN)
1424 form = prefformat->value;
1425 resp->records = pack_records(assoc, req->resultSetName, 1,
1426 toget, compp, next, presst, form, req->referenceId);
1429 resp->numberOfRecordsReturned = toget;
1430 resp->nextResultSetPosition = next;
1431 resp->searchStatus = sr;
1432 resp->resultSetStatus = 0;
1433 resp->presentStatus = presst;
1437 if (*resp->resultCount)
1439 resp->numberOfRecordsReturned = nulint;
1440 resp->nextResultSetPosition = next;
1441 resp->searchStatus = sr;
1442 resp->resultSetStatus = 0;
1443 resp->presentStatus = 0;
1450 * Maybe we got a little over-friendly when we designed bend_fetch to
1451 * get only one record at a time. Some backends can optimise multiple-record
1452 * fetches, and at any rate, there is some overhead involved in
1453 * all that selecting and hopping around. Problem is, of course, that the
1454 * frontend can't know ahead of time how many records it'll need to
1455 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1456 * is downright lousy as a bulk data transfer protocol.
1458 * To start with, we'll do the fetching of records from the backend
1459 * in one operation: To save some trips in and out of the event-handler,
1460 * and to simplify the interface to pack_records. At any rate, asynch
1461 * operation is more fun in operations that have an unpredictable execution
1462 * speed - which is normally more true for search than for present.
1464 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1467 Z_PresentRequest *req = reqb->request->u.presentRequest;
1471 Z_PresentResponse *resp;
1476 yaz_log(LOG_LOG, "Got PresentRequest.");
1478 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1479 prefformat->oclass != CLASS_RECSYN)
1482 form = prefformat->value;
1483 if (assoc->init->bend_present)
1485 bend_present_rr *bprr = (bend_present_rr *)
1486 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1487 bprr->setname = req->resultSetId;
1488 bprr->start = *req->resultSetStartPoint;
1489 bprr->number = *req->numberOfRecordsRequested;
1490 bprr->format = form;
1491 bprr->comp = req->recordComposition;
1492 bprr->referenceId = req->referenceId;
1493 bprr->stream = assoc->encode;
1494 bprr->print = assoc->print;
1495 bprr->request = reqb;
1496 bprr->association = assoc;
1498 bprr->errstring = NULL;
1499 (*assoc->init->bend_present)(assoc->backend, bprr);
1504 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1505 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1506 presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1507 next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1508 num = (int *)odr_malloc (assoc->encode, sizeof(*num));
1511 *num = *req->numberOfRecordsRequested;
1513 apdu->which = Z_APDU_presentResponse;
1514 apdu->u.presentResponse = resp;
1515 resp->referenceId = req->referenceId;
1516 resp->otherInfo = 0;
1519 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1520 num, req->recordComposition, next, presst, form,
1524 resp->numberOfRecordsReturned = num;
1525 resp->presentStatus = presst;
1526 resp->nextResultSetPosition = next;
1532 static int bend_default_scan (void *handle, bend_scan_rr *rr)
1534 bend_scanrequest srq;
1535 bend_scanresult *srs;
1537 srq.num_bases = rr->num_bases;
1538 srq.basenames = rr->basenames;
1539 srq.attributeset = rr->attributeset;
1540 srq.referenceId = rr->referenceId;
1541 srq.term = rr->term;
1542 srq.term_position = rr->term_position;
1543 srq.num_entries = rr->num_entries;
1544 srq.stream = rr->stream;
1545 srq.print = rr->print;
1547 srs = bend_scan(handle, &srq, 0);
1549 rr->term_position = srs->term_position;
1550 rr->num_entries = srs->num_entries;
1551 rr->entries = srs->entries;
1552 rr->status = srs->status;
1553 rr->errcode = srs->errcode;
1554 rr->errstring = srs->errstring;
1560 * Scan was implemented rather in a hurry, and with support for only the basic
1561 * elements of the service in the backend API. Suggestions are welcome.
1563 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1565 Z_ScanRequest *req = reqb->request->u.scanRequest;
1566 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1567 Z_ScanResponse *res = (Z_ScanResponse *)
1568 odr_malloc (assoc->encode, sizeof(*res));
1569 int *scanStatus = (int *)
1570 odr_malloc (assoc->encode, sizeof(*scanStatus));
1571 int *numberOfEntriesReturned = (int *)
1572 odr_malloc (assoc->encode, sizeof(*numberOfEntriesReturned));
1573 Z_ListEntries *ents = (Z_ListEntries *)
1574 odr_malloc (assoc->encode, sizeof(*ents));
1575 Z_DiagRecs *diagrecs_p = NULL;
1579 yaz_log(LOG_LOG, "Got ScanRequest");
1580 *scanStatus = Z_Scan_failure;
1581 *numberOfEntriesReturned = 0;
1583 apdu->which = Z_APDU_scanResponse;
1584 apdu->u.scanResponse = res;
1585 res->referenceId = req->referenceId;
1587 res->scanStatus = scanStatus;
1588 res->numberOfEntriesReturned = numberOfEntriesReturned;
1589 res->positionOfTerm = 0;
1590 res->entries = ents;
1591 ents->num_entries = 0;
1592 ents->entries = NULL;
1593 ents->num_nonsurrogateDiagnostics = 0;
1594 ents->nonsurrogateDiagnostics = NULL;
1595 res->attributeSet = 0;
1598 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1599 attent->oclass != CLASS_ATTSET
1600 || attent->value != VAL_BIB1))
1601 diagrecs_p = diagrecs(assoc, 121, 0);
1602 else if (req->stepSize && *req->stepSize > 0)
1603 diagrecs_p = diagrecs(assoc, 205, 0);
1606 bend_scan_rr *bsrr = (bend_scan_rr *)
1607 odr_malloc (assoc->encode, sizeof(*bsrr));
1608 if (req->databaseNames)
1611 for (i = 0; i < req->num_databaseNames; i++)
1612 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1614 bsrr->num_bases = req->num_databaseNames;
1615 bsrr->basenames = req->databaseNames;
1616 bsrr->num_entries = *req->numberOfTermsRequested;
1617 bsrr->term = req->termListAndStartPoint;
1618 bsrr->referenceId = req->referenceId;
1619 bsrr->stream = assoc->encode;
1620 bsrr->print = assoc->print;
1621 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1622 attset->oclass != CLASS_RECSYN)
1623 bsrr->attributeset = VAL_NONE;
1625 bsrr->attributeset = attset->value;
1626 log_scan_term (req->termListAndStartPoint, attset->value);
1627 bsrr->term_position = req->preferredPositionInResponse ?
1628 *req->preferredPositionInResponse : 1;
1629 ((int (*)(void *, bend_scan_rr *))
1630 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1632 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1636 Z_Entry **tab = (Z_Entry **)
1637 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1639 if (bsrr->status == BEND_SCAN_PARTIAL)
1640 *scanStatus = Z_Scan_partial_5;
1642 *scanStatus = Z_Scan_success;
1643 ents->entries = tab;
1644 ents->num_entries = bsrr->num_entries;
1645 res->numberOfEntriesReturned = &ents->num_entries;
1646 res->positionOfTerm = &bsrr->term_position;
1647 for (i = 0; i < bsrr->num_entries; i++)
1653 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1654 if (bsrr->entries[i].occurrences >= 0)
1656 e->which = Z_Entry_termInfo;
1657 e->u.termInfo = t = (Z_TermInfo *)
1658 odr_malloc(assoc->encode, sizeof(*t));
1659 t->suggestedAttributes = 0;
1661 t->alternativeTerm = 0;
1662 t->byAttributes = 0;
1663 t->otherTermInfo = 0;
1664 t->globalOccurrences = &bsrr->entries[i].occurrences;
1665 t->term = (Z_Term *)
1666 odr_malloc(assoc->encode, sizeof(*t->term));
1667 t->term->which = Z_Term_general;
1668 t->term->u.general = o =
1669 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1670 o->buf = (unsigned char *)
1671 odr_malloc(assoc->encode, o->len = o->size =
1672 strlen(bsrr->entries[i].term));
1673 memcpy(o->buf, bsrr->entries[i].term, o->len);
1674 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1675 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1679 Z_DiagRecs *drecs = diagrecs (assoc,
1680 bsrr->entries[i].errcode,
1681 bsrr->entries[i].errstring);
1682 assert (drecs->num_diagRecs == 1);
1683 e->which = Z_Entry_surrogateDiagnostic;
1684 assert (drecs->diagRecs[0]);
1685 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1692 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1693 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1698 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1701 Z_SortRequest *req = reqb->request->u.sortRequest;
1702 Z_SortResponse *res = (Z_SortResponse *)
1703 odr_malloc (assoc->encode, sizeof(*res));
1704 bend_sort_rr *bsrr = (bend_sort_rr *)
1705 odr_malloc (assoc->encode, sizeof(*bsrr));
1707 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1709 yaz_log(LOG_LOG, "Got SortRequest.");
1712 bsrr->num_input_setnames = req->num_inputResultSetNames;
1713 bsrr->input_setnames = req->inputResultSetNames;
1715 bsrr->num_input_setnames = req->inputResultSetNames->num_strings;
1716 bsrr->input_setnames = req->inputResultSetNames->strings;
1718 bsrr->referenceId = req->referenceId;
1719 bsrr->output_setname = req->sortedResultSetName;
1720 bsrr->sort_sequence = req->sortSequence;
1721 bsrr->stream = assoc->encode;
1722 bsrr->print = assoc->print;
1724 bsrr->sort_status = Z_SortStatus_failure;
1726 bsrr->errstring = 0;
1728 (*assoc->init->bend_sort)(assoc->backend, bsrr);
1730 res->referenceId = bsrr->referenceId;
1731 res->sortStatus = (int *)
1732 odr_malloc (assoc->encode, sizeof(*res->sortStatus));
1733 *res->sortStatus = bsrr->sort_status;
1734 res->resultSetStatus = 0;
1737 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1739 res->diagnostics = dr->diagRecs;
1740 res->num_diagnostics = dr->num_diagRecs;
1742 res->diagnostics = dr;
1748 res->num_diagnostics = 0;
1750 res->diagnostics = 0;
1754 apdu->which = Z_APDU_sortResponse;
1755 apdu->u.sortResponse = res;
1759 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1762 Z_DeleteResultSetRequest *req = reqb->request->u.deleteResultSetRequest;
1763 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1764 odr_malloc (assoc->encode, sizeof(*res));
1765 bend_delete_rr *bdrr = (bend_delete_rr *)
1766 odr_malloc (assoc->encode, sizeof(*bdrr));
1767 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1769 yaz_log(LOG_LOG, "Got DeleteRequest.");
1771 bdrr->num_setnames = req->num_resultSetList;
1772 bdrr->setnames = req->resultSetList;
1773 bdrr->stream = assoc->encode;
1774 bdrr->print = assoc->print;
1775 bdrr->function = *req->deleteFunction;
1776 bdrr->referenceId = req->referenceId;
1778 if (bdrr->num_setnames > 0)
1781 bdrr->statuses = odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1782 bdrr->num_setnames);
1783 for (i = 0; i < bdrr->num_setnames; i++)
1784 bdrr->statuses[i] = 0;
1786 (*assoc->init->bend_delete)(assoc->backend, bdrr);
1788 res->referenceId = req->referenceId;
1790 res->deleteOperationStatus = (int *)
1791 odr_malloc (assoc->encode, sizeof(*res->deleteOperationStatus));
1792 *res->deleteOperationStatus = bdrr->delete_status;
1794 res->deleteListStatuses = 0;
1795 if (bdrr->num_setnames > 0)
1798 res->deleteListStatuses = odr_malloc(assoc->encode,
1799 sizeof(*res->deleteListStatuses));
1800 res->deleteListStatuses->num = bdrr->num_setnames;
1801 res->deleteListStatuses->elements =
1802 odr_malloc (assoc->encode,
1803 sizeof(*res->deleteListStatuses->elements) *
1804 bdrr->num_setnames);
1805 for (i = 0; i<bdrr->num_setnames; i++)
1807 res->deleteListStatuses->elements[i] =
1808 odr_malloc (assoc->encode,
1809 sizeof(**res->deleteListStatuses->elements));
1810 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1811 res->deleteListStatuses->elements[i]->id =
1812 odr_strdup (assoc->encode, bdrr->setnames[i]);
1816 res->numberNotDeleted = 0;
1817 res->bulkStatuses = 0;
1818 res->deleteMessage = 0;
1821 apdu->which = Z_APDU_deleteResultSetResponse;
1822 apdu->u.deleteResultSetResponse = res;
1826 static void process_close(association *assoc, request *reqb)
1828 Z_Close *req = reqb->request->u.close;
1829 static char *reasons[] =
1836 "securityViolation",
1843 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1844 reasons[*req->closeReason], req->diagnosticInformation ?
1845 req->diagnosticInformation : "NULL");
1846 if (assoc->version < 3) /* to make do_force respond with close */
1848 do_close_req(assoc, Z_Close_finished,
1849 "Association terminated by client", reqb);
1852 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1856 reqb->len_refid = refid->len;
1857 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1858 memcpy (reqb->refid, refid->buf, refid->len);
1862 reqb->len_refid = 0;
1867 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1869 process_response (a, req, res);
1872 bend_request bend_request_mk (bend_association a)
1874 request *nreq = request_get (&a->outgoing);
1875 nreq->request_mem = nmem_create ();
1879 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1884 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1885 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1886 id->len = id->size = req->len_refid;
1887 memcpy (id->buf, req->refid, req->len_refid);
1891 void bend_request_destroy (bend_request *req)
1893 nmem_destroy((*req)->request_mem);
1894 request_release(*req);
1898 int bend_backend_respond (bend_association a, bend_request req)
1902 r = process_request (a, req, &msg);
1904 logf (LOG_WARN, "%s", msg);
1908 void bend_request_setdata(bend_request r, void *p)
1913 void *bend_request_getdata(bend_request r)
1915 return r->clientData;
1918 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
1920 bend_segment_rr request;
1922 request.segment = reqb->request->u.segmentRequest;
1923 request.stream = assoc->encode;
1924 request.decode = assoc->decode;
1925 request.print = assoc->print;
1926 request.association = assoc;
1928 (*assoc->init->bend_segment)(assoc->backend, &request);
1933 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
1935 bend_esrequest_rr esrequest;
1937 Z_ExtendedServicesRequest *req = reqb->request->u.extendedServicesRequest;
1938 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
1940 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
1942 yaz_log(LOG_DEBUG,"inside Process esRequest");
1944 esrequest.esr = reqb->request->u.extendedServicesRequest;
1945 esrequest.stream = assoc->encode;
1946 esrequest.decode = assoc->decode;
1947 esrequest.print = assoc->print;
1948 esrequest.errcode = 0;
1949 esrequest.errstring = NULL;
1950 esrequest.request = reqb;
1951 esrequest.association = assoc;
1952 esrequest.referenceId = req->referenceId;
1954 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
1956 /* If the response is being delayed, return NULL */
1957 if (esrequest.request == NULL)
1960 resp->referenceId = req->referenceId;
1962 if (esrequest.errcode == -1)
1964 /* Backend service indicates request will be processed */
1965 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
1966 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
1968 else if (esrequest.errcode == 0)
1970 /* Backend service indicates request will be processed */
1971 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
1972 *resp->operationStatus = Z_ExtendedServicesResponse_done;
1976 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
1977 esrequest.errstring);
1979 /* Backend indicates error, request will not be processed */
1980 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
1981 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
1982 resp->num_diagnostics = diagRecs->num_diagRecs;
1983 resp->diagnostics = diagRecs->diagRecs;
1985 /* Do something with the members of bend_extendedservice */
1987 yaz_log(LOG_DEBUG,"Send the result apdu");