2 * Copyright (c) 1995-2000, Index Data
3 * See the file LICENSE for details.
6 * Revision 1.101 2000-01-12 14:36:07 adam
7 * Added printing stream (ODR) for backend functions.
9 * Revision 1.100 1999/12/16 23:36:19 adam
10 * Implemented ILL protocol. Minor updates ASN.1 compiler.
12 * Revision 1.99 1999/11/30 13:47:12 adam
13 * Improved installation. Moved header files to include/yaz.
15 * Revision 1.98 1999/11/29 15:12:27 adam
16 * Changed the way implementationName - and version is set.
18 * Revision 1.96 1999/11/04 14:58:44 adam
19 * Added status elements for backend delete result set handler.
20 * Updated delete result result set command for client.
22 * Revision 1.95 1999/10/11 10:01:24 adam
23 * Implemented bend_sort_rr handler for frontend server.
25 * Revision 1.94 1999/08/27 09:40:32 adam
26 * Renamed logf function to yaz_log. Removed VC++ project files.
28 * Revision 1.93 1999/07/06 12:17:15 adam
29 * Added option -1 that runs server once (for profiling purposes).
31 * Revision 1.92 1999/06/17 10:54:45 adam
32 * Added facility to specify implementation version - and name
35 * Revision 1.91 1999/06/01 14:29:12 adam
36 * Work on Extended Services.
38 * Revision 1.90 1999/05/27 13:02:20 adam
39 * Assigned OID for old DB Update (VAL_DBUPDATE0).
41 * Revision 1.89 1999/05/26 15:24:26 adam
42 * Fixed minor bugs regarding DB Update (introduced by previous commit).
44 * Revision 1.88 1999/04/20 09:56:48 adam
45 * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
46 * Modified all encoders/decoders to reflect this change.
48 * Revision 1.87 1999/03/31 11:18:25 adam
49 * Implemented odr_strdup. Added Reference ID to backend server API.
51 * Revision 1.86 1999/02/02 13:57:38 adam
52 * Uses preprocessor define WIN32 instead of WINDOWS to build code
53 * for Microsoft WIN32.
55 * Revision 1.85 1998/11/17 09:52:59 adam
56 * Fixed minor bug (introduced by previous commit).
58 * Revision 1.84 1998/11/16 16:02:32 adam
59 * Added loggin utilies, log_rpn_query and log_scan_term. These used
60 * to be part of Zebra.
62 * Revision 1.83 1998/11/03 10:09:36 adam
63 * Fixed bug regarding YC.
65 * Revision 1.82 1998/10/20 14:00:30 quinn
68 * Revision 1.81 1998/10/13 16:12:24 adam
69 * Added support for Surrogate Diagnostics for Scan Term entries.
71 * Revision 1.80 1998/09/02 12:41:53 adam
72 * Added decode stream in bend search structures.
74 * Revision 1.79 1998/08/19 16:10:08 adam
75 * Changed som member names of DeleteResultSetRequest/Response.
77 * Revision 1.78 1998/08/03 10:23:55 adam
78 * Fixed bug regarding Options for Sort.
80 * Revision 1.77 1998/07/20 12:38:42 adam
81 * Implemented delete result set service to server API.
83 * Revision 1.76 1998/05/27 16:57:07 adam
84 * Support for surrogate diagnostic records added for bend_fetch.
86 * Revision 1.75 1998/05/18 10:13:07 adam
87 * Fixed call to es_request handler - extra argument was passed.
89 * Revision 1.74 1998/03/31 15:13:20 adam
90 * Development towards compiled ASN.1.
92 * Revision 1.73 1998/03/31 11:07:45 adam
93 * Furhter work on UNIverse resource report.
94 * Added Extended Services handling in frontend server.
96 * Revision 1.72 1998/02/11 11:53:35 adam
97 * Changed code so that it compiles as C++.
99 * Revision 1.71 1998/02/10 11:03:57 adam
100 * Added support for extended handlers in backend server interface.
102 * Revision 1.70 1998/01/29 13:15:35 adam
103 * Implemented sort for the backend interface.
105 * Revision 1.69 1997/09/30 11:48:12 adam
106 * Fixed bug introduced by previous commit.
108 * Revision 1.68 1997/09/29 13:18:59 adam
109 * Added function, oid_ent_to_oid, to replace the function
110 * oid_getoidbyent, which is not thread safe.
112 * Revision 1.67 1997/09/17 12:10:40 adam
115 * Revision 1.66 1997/09/05 15:26:44 adam
116 * Added ODR encode in search and scen bend request structures.
117 * Fixed a few enums that caused trouble with C++.
119 * Revision 1.65 1997/09/01 08:53:01 adam
120 * New windows NT/95 port using MSV5.0. The test server 'ztest' was
121 * moved a separate directory. MSV5.0 project server.dsp created.
122 * As an option, the server can now operate as an NT service.
124 * Revision 1.64 1997/04/30 08:52:11 quinn
127 * Revision 1.63 1996/10/11 11:57:26 quinn
130 * Revision 1.62 1996/07/06 19:58:35 quinn
131 * System headerfiles gathered in yconfig
133 * Revision 1.61 1996/06/10 08:56:16 quinn
136 * Revision 1.60 1996/05/30 11:03:10 quinn
137 * Fixed NextresultSetPosition bug fixed.
139 * Revision 1.59 1996/05/14 09:26:46 quinn
140 * Added attribute set to scan backend
142 * Revision 1.58 1996/02/20 12:53:04 quinn
145 * Revision 1.57 1996/01/02 08:57:47 quinn
146 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
148 * Revision 1.56 1995/12/14 11:09:57 quinn
151 * Revision 1.55 1995/11/08 17:41:37 quinn
154 * Revision 1.54 1995/11/08 15:11:29 quinn
155 * Log of close transmit.
157 * Revision 1.53 1995/11/01 13:54:58 quinn
160 * Revision 1.52 1995/11/01 12:19:13 quinn
161 * Second attempt to fix same bug.
163 * Revision 1.50 1995/10/25 16:58:32 quinn
166 * Revision 1.49 1995/10/16 13:51:53 quinn
167 * Changes to provide Especs to the backend.
169 * Revision 1.48 1995/10/06 08:51:20 quinn
170 * Added Write-buffer.
172 * Revision 1.47 1995/08/29 14:24:16 quinn
173 * Added second half of close-handshake
175 * Revision 1.46 1995/08/29 11:17:58 quinn
176 * Added code to receive close
178 * Revision 1.45 1995/08/21 09:11:00 quinn
179 * Smallish fixes to suppport new formats.
181 * Revision 1.44 1995/08/17 12:45:25 quinn
182 * Fixed minor problems with GRS-1. Added support in c&s.
184 * Revision 1.43 1995/08/15 12:00:31 quinn
187 * Revision 1.42 1995/08/15 11:16:50 quinn
189 * Revision 1.41 1995/08/02 10:23:06 quinn
192 * Revision 1.40 1995/07/31 14:34:26 quinn
193 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
195 * Revision 1.39 1995/06/27 13:21:00 quinn
198 * Revision 1.38 1995/06/19 12:39:11 quinn
199 * Fixed bug in timeout code. Added BER dumper.
201 * Revision 1.37 1995/06/16 13:16:14 quinn
202 * Fixed Defaultdiagformat.
204 * Revision 1.36 1995/06/16 10:31:36 quinn
205 * Added session timeout.
207 * Revision 1.35 1995/06/15 07:45:14 quinn
210 * Revision 1.34 1995/06/14 15:26:46 quinn
211 * *** empty log message ***
213 * Revision 1.33 1995/06/06 14:57:05 quinn
214 * Better diagnostics.
216 * Revision 1.32 1995/06/06 08:41:44 quinn
217 * Better diagnostics.
219 * Revision 1.31 1995/06/06 08:15:37 quinn
222 * Revision 1.30 1995/06/05 10:53:32 quinn
223 * Added a better SCAN.
225 * Revision 1.29 1995/06/01 11:25:03 quinn
228 * Revision 1.28 1995/06/01 11:21:01 quinn
229 * Attempting to fix a bug in pack-records. replaced break with continue
230 * for large records, according to standard.
232 * Revision 1.27 1995/05/29 08:12:06 quinn
235 * Revision 1.26 1995/05/18 13:02:12 quinn
238 * Revision 1.25 1995/05/17 08:42:26 quinn
239 * Transfer auth info to backend. Allow backend to reject init gracefully.
241 * Revision 1.24 1995/05/16 08:51:04 quinn
242 * License, documentation, and memory fixes
244 * Revision 1.23 1995/05/15 13:25:10 quinn
247 * Revision 1.22 1995/05/15 11:56:39 quinn
248 * Asynchronous facilities. Restructuring of seshigh code.
250 * Revision 1.21 1995/05/02 08:53:19 quinn
251 * Trying in vain to fix comm with ISODE
253 * Revision 1.20 1995/04/20 15:13:00 quinn
256 * Revision 1.19 1995/04/18 08:15:34 quinn
257 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
258 * neater. We'll make the same change for decoding one day.
260 * Revision 1.18 1995/04/17 11:28:25 quinn
263 * Revision 1.17 1995/04/10 10:23:36 quinn
264 * Some work to add scan and other things.
266 * Revision 1.16 1995/03/31 09:18:55 quinn
269 * Revision 1.15 1995/03/30 14:03:23 quinn
270 * Added RFC1006 as separate library
272 * Revision 1.14 1995/03/30 12:18:17 quinn
275 * Revision 1.13 1995/03/30 09:09:24 quinn
276 * Added state-handle and some support for asynchronous activities.
278 * Revision 1.12 1995/03/29 15:40:16 quinn
279 * Ongoing work. Statserv is now dynamic by default
281 * Revision 1.11 1995/03/28 09:16:21 quinn
282 * Added record packing to the search request
284 * Revision 1.10 1995/03/27 08:34:24 quinn
285 * Added dynamic server functionality.
286 * Released bindings to session.c (is now redundant)
288 * Revision 1.9 1995/03/22 15:01:26 quinn
289 * Adjusting record packing.
291 * Revision 1.8 1995/03/22 10:13:21 quinn
292 * Working on record packer
294 * Revision 1.7 1995/03/21 15:53:31 quinn
297 * Revision 1.6 1995/03/21 12:30:09 quinn
298 * Beginning to add support for record packing.
300 * Revision 1.5 1995/03/17 10:44:13 quinn
301 * Added catch of null-string in makediagrec
303 * Revision 1.4 1995/03/17 10:18:08 quinn
304 * Added memory management.
306 * Revision 1.3 1995/03/16 17:42:39 quinn
309 * Revision 1.2 1995/03/16 13:29:01 quinn
310 * Partitioned server.
312 * Revision 1.1 1995/03/15 16:02:10 quinn
313 * Modded session.c to seshigh.c
318 * Frontend server logic.
320 * This code receives incoming APDUs, and handles client requests by means
321 * of the backend API.
323 * Some of the code is getting quite involved, compared to simpler servers -
324 * primarily because it is asynchronous both in the communication with
325 * the user and the backend. We think the complexity will pay off in
326 * the form of greater flexibility when more asynchronous facilities
329 * Memory management has become somewhat involved. In the simple case, where
330 * only one PDU is pending at a time, it will simply reuse the same memory,
331 * once it has found its working size. When we enable multiple concurrent
332 * operations, perhaps even with multiple parallel calls to the backend, it
333 * will maintain a pool of buffers for encoding and decoding, trying to
334 * minimize memory allocation/deallocation during normal operation.
336 * TODOs include (and will be done in order of public interest):
338 * Support for EXPLAIN - provide simple meta-database system.
339 * Support for access control.
340 * Support for resource control.
341 * Support for extended services - primarily Item Order.
342 * Rest of Z39.50-1994
355 #include <yaz/yconfig.h>
356 #include <yaz/xmalloc.h>
357 #include <yaz/comstack.h>
360 #include <yaz/proto.h>
363 #include <yaz/logrpn.h>
364 #include <yaz/statserv.h>
366 #include <yaz/backend.h>
368 static int process_request(association *assoc, request *req, char **msg);
369 void backend_response(IOCHAN i, int event);
370 static int process_response(association *assoc, request *req, Z_APDU *res);
371 static Z_APDU *process_initRequest(association *assoc, request *reqb);
372 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
374 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
375 bend_search_rr *bsrr, int *fd);
376 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
378 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
379 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
380 static void process_close(association *assoc, request *reqb);
381 void save_referenceId (request *reqb, Z_ReferenceId *refid);
382 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
384 static int bend_default_scan (void *handle, bend_scan_rr *rr);
386 static FILE *apduf = 0; /* for use in static mode */
387 static statserv_options_block *control_block = 0;
389 /* Chas: Added in from DALI */
390 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
391 /* Chas: End of addition from DALI */
394 * Create and initialize a new association-handle.
395 * channel : iochannel for the current line.
396 * link : communications channel.
397 * Returns: 0 or a new association handle.
399 association *create_association(IOCHAN channel, COMSTACK link)
404 control_block = statserv_getcontrol();
405 if (!(anew = (association *)xmalloc(sizeof(*anew))))
407 anew->client_chan = channel;
408 anew->client_link = link;
409 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
410 !(anew->encode = odr_createmem(ODR_ENCODE)))
412 if (*control_block->apdufile)
417 strcpy(filename, control_block->apdufile);
418 if (!(anew->print = odr_createmem(ODR_PRINT)))
420 if (*control_block->apdufile != '-')
422 strcpy(filename, control_block->apdufile);
423 if (!control_block->dynamic)
427 if (!(apduf = fopen(filename, "w")))
429 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
432 setvbuf(apduf, 0, _IONBF, 0);
438 sprintf(filename + strlen(filename), ".%d", getpid());
439 if (!(f = fopen(filename, "w")))
441 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
444 setvbuf(f, 0, _IONBF, 0);
446 odr_setprint(anew->print, f);
451 anew->input_buffer = 0;
452 anew->input_buffer_len = 0;
454 anew->state = ASSOC_NEW;
455 request_initq(&anew->incoming);
456 request_initq(&anew->outgoing);
457 anew->proto = cs_getproto(link);
462 * Free association and release resources.
464 void destroy_association(association *h)
466 odr_destroy(h->decode);
467 odr_destroy(h->encode);
469 odr_destroy(h->print);
471 xfree(h->input_buffer);
473 bend_close(h->backend);
474 while (request_deq(&h->incoming));
475 while (request_deq(&h->outgoing));
476 request_delq(&h->incoming);
477 request_delq(&h->outgoing);
479 if (control_block && control_block->one_shot)
483 static void do_close_req(association *a, int reason, char *message,
487 Z_Close *cls = zget_Close(a->encode);
489 /* Purge request queue */
490 while (request_deq(&a->incoming));
491 while (request_deq(&a->outgoing));
494 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
495 reason, message ? message : "none");
496 apdu.which = Z_APDU_close;
498 *cls->closeReason = reason;
499 cls->diagnosticInformation = message;
500 process_response(a, req, &apdu);
501 iochan_settimeout(a->client_chan, 60);
505 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
506 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
508 a->state = ASSOC_DEAD;
511 static void do_close(association *a, int reason, char *message)
513 do_close_req (a, reason, message, request_get(&a->outgoing));
517 * This is where PDUs from the client are read and the further
518 * processing is initiated. Flow of control moves down through the
519 * various process_* functions below, until the encoded result comes back up
520 * to the output handler in here.
522 * h : the I/O channel that has an outstanding event.
523 * event : the current outstanding event.
525 void ir_session(IOCHAN h, int event)
528 association *assoc = (association *)iochan_getdata(h);
529 COMSTACK conn = assoc->client_link;
532 assert(h && conn && assoc);
533 if (event == EVENT_TIMEOUT)
535 if (assoc->state != ASSOC_UP)
537 yaz_log(LOG_LOG, "Final timeout - closing connection.");
539 destroy_association(assoc);
544 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
545 do_close(assoc, Z_Close_lackOfActivity, 0);
549 if (event & EVENT_INPUT || event & EVENT_WORK) /* input */
551 if (event & EVENT_INPUT)
553 yaz_log(LOG_DEBUG, "ir_session (input)");
554 assert(assoc && conn);
555 /* We aren't speaking to this fellow */
556 if (assoc->state == ASSOC_DEAD)
558 yaz_log(LOG_LOG, "Closed connection after reject");
560 destroy_association(assoc);
564 if ((res = cs_get(conn, &assoc->input_buffer,
565 &assoc->input_buffer_len)) <= 0)
567 yaz_log(LOG_LOG, "Connection closed by client");
569 destroy_association(assoc);
573 else if (res == 1) /* incomplete read - wait for more */
575 if (cs_more(conn)) /* more stuff - call us again later, please */
576 iochan_setevent(h, EVENT_INPUT);
578 /* we got a complete PDU. Let's decode it */
579 yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
580 req = request_get(&assoc->incoming); /* get a new request structure */
581 odr_reset(assoc->decode);
582 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
583 if (!z_APDU(assoc->decode, &req->request, 0, 0))
585 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
586 odr_errmsg(odr_geterror(assoc->decode)),
587 odr_offset(assoc->decode));
588 yaz_log(LOG_LOG, "PDU dump:");
589 odr_dumpBER(log_file(), assoc->input_buffer, res);
590 do_close(assoc, Z_Close_protocolError, "Malformed package");
593 req->request_mem = odr_extract_mem(assoc->decode);
594 if (assoc->print && !z_APDU(assoc->print, &req->request, 0, 0))
596 yaz_log(LOG_WARN, "ODR print error: %s",
597 odr_errmsg(odr_geterror(assoc->print)));
598 odr_reset(assoc->print);
600 request_enq(&assoc->incoming, req);
603 /* can we do something yet? */
604 req = request_head(&assoc->incoming);
605 if (req->state == REQUEST_IDLE)
608 request_deq(&assoc->incoming);
609 if (process_request(assoc, req, &msg) < 0)
610 do_close_req(assoc, Z_Close_systemProblem, msg, req);
613 if (event & EVENT_OUTPUT)
615 request *req = request_head(&assoc->outgoing);
617 yaz_log(LOG_DEBUG, "ir_session (output)");
618 req->state = REQUEST_PENDING;
619 switch (res = cs_put(conn, req->response, req->len_response))
622 yaz_log(LOG_LOG, "Connection closed by client");
624 destroy_association(assoc);
627 case 0: /* all sent - release the request structure */
628 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
629 nmem_destroy(req->request_mem);
630 request_deq(&assoc->outgoing);
631 request_release(req);
632 if (!request_head(&assoc->outgoing))
633 iochan_clearflag(h, EVENT_OUTPUT);
635 /* value of 1 -- partial send -- is simply ignored */
638 if (event & EVENT_EXCEPT)
640 yaz_log(LOG_DEBUG, "ir_session (exception)");
642 destroy_association(assoc);
648 * Initiate request processing.
650 static int process_request(association *assoc, request *req, char **msg)
656 *msg = "Unknown Error";
657 assert(req && req->state == REQUEST_IDLE);
658 switch (req->request->which)
660 case Z_APDU_initRequest:
661 res = process_initRequest(assoc, req); break;
662 case Z_APDU_searchRequest:
663 res = process_searchRequest(assoc, req, &fd); break;
664 case Z_APDU_presentRequest:
665 res = process_presentRequest(assoc, req, &fd); break;
666 case Z_APDU_scanRequest:
667 if (assoc->bend_scan)
668 res = process_scanRequest(assoc, req, &fd);
671 *msg = "Cannot handle Scan APDU";
675 case Z_APDU_extendedServicesRequest:
676 if (assoc->bend_esrequest)
677 res = process_ESRequest(assoc, req, &fd);
680 *msg = "Cannot handle Extended Services APDU";
684 case Z_APDU_sortRequest:
685 if (assoc->bend_sort)
686 res = process_sortRequest(assoc, req, &fd);
689 *msg = "Cannot handle Sort APDU";
694 process_close(assoc, req);
696 case Z_APDU_deleteResultSetRequest:
697 if (assoc->bend_delete)
698 res = process_deleteRequest(assoc, req, &fd);
701 *msg = "Cannot handle Delete APDU";
706 *msg = "Bad APDU received";
711 yaz_log(LOG_DEBUG, " result immediately available");
712 retval = process_response(assoc, req, res);
716 yaz_log(LOG_DEBUG, " result unavailble");
719 else /* no result yet - one will be provided later */
723 /* Set up an I/O handler for the fd supplied by the backend */
725 yaz_log(LOG_DEBUG, " establishing handler for result");
726 req->state = REQUEST_PENDING;
727 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
729 iochan_setdata(chan, assoc);
736 * Handle message from the backend.
738 void backend_response(IOCHAN i, int event)
740 association *assoc = (association *)iochan_getdata(i);
741 request *req = request_head(&assoc->incoming);
745 yaz_log(LOG_DEBUG, "backend_response");
746 assert(assoc && req && req->state != REQUEST_IDLE);
747 /* determine what it is we're waiting for */
748 switch (req->request->which)
750 case Z_APDU_searchRequest:
751 res = response_searchRequest(assoc, req, 0, &fd); break;
753 case Z_APDU_presentRequest:
754 res = response_presentRequest(assoc, req, 0, &fd); break;
755 case Z_APDU_scanRequest:
756 res = response_scanRequest(assoc, req, 0, &fd); break;
759 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
762 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
764 yaz_log(LOG_LOG, "Fatal error when talking to backend");
765 do_close(assoc, Z_Close_systemProblem, 0);
769 else if (!res) /* no result yet - try again later */
771 yaz_log(LOG_DEBUG, " no result yet");
772 iochan_setfd(i, fd); /* in case fd has changed */
777 * Encode response, and transfer the request structure to the outgoing queue.
779 static int process_response(association *assoc, request *req, Z_APDU *res)
781 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
782 if (!z_APDU(assoc->encode, &res, 0, 0))
784 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
785 odr_errmsg(odr_geterror(assoc->decode)));
786 odr_reset(assoc->encode);
789 req->response = odr_getbuf(assoc->encode, &req->len_response,
790 &req->size_response);
791 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
792 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
794 yaz_log(LOG_WARN, "ODR print error: %s",
795 odr_errmsg(odr_geterror(assoc->print)));
796 odr_reset(assoc->print);
798 odr_reset(assoc->encode);
799 req->state = REQUEST_IDLE;
800 request_enq(&assoc->outgoing, req);
801 /* turn the work over to the ir_session handler */
802 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
803 /* Is there more work to be done? give that to the input handler too */
805 if (request_head(&assoc->incoming))
807 yaz_log (LOG_DEBUG, "more work to be done");
808 iochan_setevent(assoc->client_chan, EVENT_WORK);
815 * Handle init request.
816 * At the moment, we don't check the options
817 * anywhere else in the code - we just try not to do anything that would
818 * break a naive client. We'll toss 'em into the association block when
819 * we need them there.
821 static Z_APDU *process_initRequest(association *assoc, request *reqb)
823 Z_InitRequest *req = reqb->request->u.initRequest;
824 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
825 Z_InitResponse *resp = apdu->u.initResponse;
826 bend_initrequest binitreq;
827 bend_initresult *binitres;
830 yaz_log(LOG_LOG, "Got initRequest");
831 if (req->implementationId)
832 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
833 if (req->implementationName)
834 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
835 if (req->implementationVersion)
836 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
838 binitreq.stream = assoc->encode;
839 binitreq.print = assoc->print;
840 binitreq.configname = "default-config";
841 binitreq.auth = req->idAuthentication;
842 binitreq.referenceId = req->referenceId;
843 binitreq.implementation_version = 0;
844 binitreq.implementation_name = 0;
845 binitreq.bend_sort = NULL;
846 binitreq.bend_search = NULL;
847 binitreq.bend_present = NULL;
848 binitreq.bend_esrequest = NULL;
849 binitreq.bend_delete = NULL;
850 binitreq.bend_scan = bend_default_scan;
851 if (!(binitres = bend_init(&binitreq)))
853 yaz_log(LOG_WARN, "Bad response from backend.");
857 assoc->backend = binitres->handle;
858 if ((assoc->bend_sort = (int (*)())binitreq.bend_sort))
859 yaz_log (LOG_DEBUG, "Sort handler installed");
860 if ((assoc->bend_search = (int (*)())binitreq.bend_search))
861 yaz_log (LOG_DEBUG, "Search handler installed");
862 if ((assoc->bend_present = (int (*)())binitreq.bend_present))
863 yaz_log (LOG_DEBUG, "Present handler installed");
864 if ((assoc->bend_esrequest = (int (*)())binitreq.bend_esrequest))
865 yaz_log (LOG_DEBUG, "ESRequest handler installed");
866 if ((assoc->bend_delete = (int (*)())binitreq.bend_delete))
867 yaz_log (LOG_DEBUG, "Delete handler installed");
868 if ((assoc->bend_scan = (int (*)())binitreq.bend_scan))
869 yaz_log (LOG_DEBUG, "Scan handler installed");
871 resp->referenceId = req->referenceId;
873 /* let's tell the client what we can do */
874 if (ODR_MASK_GET(req->options, Z_Options_search))
876 ODR_MASK_SET(resp->options, Z_Options_search);
877 strcat(options, "srch");
879 if (ODR_MASK_GET(req->options, Z_Options_present))
881 ODR_MASK_SET(resp->options, Z_Options_present);
882 strcat(options, " prst");
884 if (ODR_MASK_GET(req->options, Z_Options_delSet) && binitreq.bend_delete)
886 ODR_MASK_SET(resp->options, Z_Options_delSet);
887 strcat(options, " del");
889 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
890 binitreq.bend_esrequest)
892 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
893 strcat (options, " extendedServices");
895 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
897 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
898 strcat(options, " namedresults");
900 if (ODR_MASK_GET(req->options, Z_Options_scan) && binitreq.bend_scan)
902 ODR_MASK_SET(resp->options, Z_Options_scan);
903 strcat(options, " scan");
905 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
907 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
908 strcat(options, " concurop");
910 if (ODR_MASK_GET(req->options, Z_Options_sort) && binitreq.bend_sort)
912 ODR_MASK_SET(resp->options, Z_Options_sort);
913 strcat(options, " sort");
915 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
917 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
918 assoc->version = 2; /* 1 & 2 are equivalent */
920 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
922 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
925 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
927 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
930 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
931 assoc->maximumRecordSize = *req->maximumRecordSize;
932 if (assoc->maximumRecordSize > control_block->maxrecordsize)
933 assoc->maximumRecordSize = control_block->maxrecordsize;
934 assoc->preferredMessageSize = *req->preferredMessageSize;
935 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
936 assoc->preferredMessageSize = assoc->maximumRecordSize;
937 resp->preferredMessageSize = &assoc->preferredMessageSize;
938 resp->maximumRecordSize = &assoc->maximumRecordSize;
940 resp->implementationName = "GFS";
942 if (binitreq.implementation_name)
945 odr_malloc (assoc->encode,
946 strlen(binitreq.implementation_name) + 10 +
947 strlen(resp->implementationName));
948 sprintf (nv, "%s / %s",
949 resp->implementationName, binitreq.implementation_name);
950 resp->implementationName = nv;
952 if (binitreq.implementation_version)
955 odr_malloc (assoc->encode,
956 strlen(binitreq.implementation_version) + 10 +
957 strlen(resp->implementationVersion));
958 sprintf (nv, "YAZ %s / %s",
959 resp->implementationVersion, binitreq.implementation_version);
960 resp->implementationVersion = nv;
963 if (binitres->errcode)
965 yaz_log(LOG_LOG, "Connection rejected by backend.");
967 assoc->state = ASSOC_DEAD;
970 assoc->state = ASSOC_UP;
975 * These functions should be merged.
978 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo)
981 dr->which = Z_DefaultDiagFormat_v2Addinfo;
982 dr->u.v2Addinfo = addinfo ? addinfo : "";
984 dr->which = Z_DiagForm_v2AddInfo;
985 dr->addinfo = addinfo ? addinfo : "";
990 * nonsurrogate diagnostic record.
992 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
995 Z_Records *rec = (Z_Records *)
996 odr_malloc (assoc->encode, sizeof(*rec));
999 odr_malloc (assoc->encode, sizeof(*err));
1000 Z_DiagRec *drec = (Z_DiagRec *)
1001 odr_malloc (assoc->encode, sizeof(*drec));
1002 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1003 odr_malloc (assoc->encode, sizeof(*dr));
1005 bib1.proto = assoc->proto;
1006 bib1.oclass = CLASS_DIAGSET;
1007 bib1.value = VAL_BIB1;
1009 yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
1012 rec->which = Z_Records_NSD;
1014 rec->u.nonSurrogateDiagnostic = dr;
1016 rec->u.nonSurrogateDiagnostic = drec;
1017 drec->which = Z_DiagRec_defaultFormat;
1018 drec->u.defaultFormat = dr;
1020 dr->diagnosticSetId =
1021 odr_oiddup (assoc->encode, oid_ent_to_oid(&bib1, oid));
1022 dr->condition = err;
1023 set_addinfo (dr, addinfo);
1028 * surrogate diagnostic.
1030 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1031 int error, char *addinfo)
1034 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1035 odr_malloc (assoc->encode, sizeof(*rec));
1036 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1038 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1039 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1040 odr_malloc (assoc->encode, sizeof(*dr));
1042 bib1.proto = assoc->proto;
1043 bib1.oclass = CLASS_DIAGSET;
1044 bib1.value = VAL_BIB1;
1046 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1048 rec->databaseName = dbname;
1049 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1050 rec->u.surrogateDiagnostic = drec;
1051 drec->which = Z_DiagRec_defaultFormat;
1052 drec->u.defaultFormat = dr;
1053 dr->diagnosticSetId = odr_oiddup (assoc->encode,
1054 oid_ent_to_oid(&bib1, oid));
1055 dr->condition = err;
1056 set_addinfo (dr, addinfo);
1062 * multiple nonsurrogate diagnostics.
1064 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1067 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1068 int *err = (int *)odr_malloc (assoc->encode, sizeof(*err));
1070 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1071 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1072 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)odr_malloc (assoc->encode, sizeof(*rec));
1074 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1075 bib1.proto = assoc->proto;
1076 bib1.oclass = CLASS_DIAGSET;
1077 bib1.value = VAL_BIB1;
1080 recs->num_diagRecs = 1;
1081 recs->diagRecs = recp;
1083 drec->which = Z_DiagRec_defaultFormat;
1084 drec->u.defaultFormat = rec;
1086 rec->diagnosticSetId = odr_oiddup (assoc->encode,
1087 oid_ent_to_oid(&bib1, oid));
1088 rec->condition = err;
1091 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1092 rec->u.v2Addinfo = addinfo ? addinfo : "";
1094 rec->which = Z_DiagForm_v2AddInfo;
1095 rec->addinfo = addinfo ? addinfo : "";
1100 static Z_Records *pack_records(association *a, char *setname, int start,
1101 int *num, Z_RecordComposition *comp,
1102 int *next, int *pres, oid_value format,
1103 Z_ReferenceId *referenceId)
1105 int recno, total_length = 0, toget = *num, dumped_records = 0;
1106 Z_Records *records =
1107 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1108 Z_NamePlusRecordList *reclist =
1109 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1110 Z_NamePlusRecord **list =
1111 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1113 records->which = Z_Records_DBOSD;
1114 records->u.databaseOrSurDiagnostics = reclist;
1115 reclist->num_records = 0;
1116 reclist->records = list;
1117 *pres = Z_PRES_SUCCESS;
1121 yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
1122 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1123 a->maximumRecordSize);
1124 for (recno = start; reclist->num_records < toget; recno++)
1126 bend_fetchrequest freq;
1127 bend_fetchresult *fres;
1128 Z_NamePlusRecord *thisrec;
1129 int this_length = 0;
1131 * we get the number of bytes allocated on the stream before any
1132 * allocation done by the backend - this should give us a reasonable
1133 * idea of the total size of the data so far.
1135 total_length = odr_total(a->encode) - dumped_records;
1136 freq.setname = setname;
1137 freq.number = recno;
1139 freq.format = format;
1140 freq.stream = a->encode;
1141 freq.print = a->print;
1142 freq.surrogate_flag = 0;
1143 freq.referenceId = referenceId;
1144 if (!(fres = bend_fetch(a->backend, &freq, 0)))
1146 *pres = Z_PRES_FAILURE;
1147 return diagrec(a, 2, "Backend interface problem");
1149 /* backend should be able to signal whether error is system-wide
1150 or only pertaining to current record */
1153 if (!freq.surrogate_flag)
1155 *pres = Z_PRES_FAILURE;
1156 return diagrec(a, fres->errcode, fres->errstring);
1158 reclist->records[reclist->num_records] =
1159 surrogatediagrec(a, fres->basename, fres->errcode,
1161 reclist->num_records++;
1162 *next = fres->last_in_set ? 0 : recno + 1;
1166 this_length = fres->len;
1168 this_length = odr_total(a->encode) - total_length;
1169 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1170 this_length, total_length);
1171 if (this_length + total_length > a->preferredMessageSize)
1173 /* record is small enough, really */
1174 if (this_length <= a->preferredMessageSize)
1176 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1177 *pres = Z_PRES_PARTIAL_2;
1180 /* record can only be fetched by itself */
1181 if (this_length < a->maximumRecordSize)
1183 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1186 yaz_log(LOG_DEBUG, " Dropped it");
1187 reclist->records[reclist->num_records] =
1188 surrogatediagrec(a, fres->basename, 16, 0);
1189 reclist->num_records++;
1190 *next = fres->last_in_set ? 0 : recno + 1;
1191 dumped_records += this_length;
1195 else /* too big entirely */
1197 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
1198 reclist->records[reclist->num_records] =
1199 surrogatediagrec(a, fres->basename, 17, 0);
1200 reclist->num_records++;
1201 *next = fres->last_in_set ? 0 : recno + 1;
1202 dumped_records += this_length;
1207 if (!(thisrec = (Z_NamePlusRecord *)
1208 odr_malloc(a->encode, sizeof(*thisrec))))
1210 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1211 strlen(fres->basename) + 1)))
1213 strcpy(thisrec->databaseName, fres->basename);
1214 thisrec->which = Z_NamePlusRecord_databaseRecord;
1215 thisrec->u.databaseRecord = z_ext_record(a->encode, fres->format,
1216 fres->record, fres->len);
1217 if (!thisrec->u.databaseRecord)
1219 reclist->records[reclist->num_records] = thisrec;
1220 reclist->num_records++;
1221 *next = fres->last_in_set ? 0 : recno + 1;
1223 *num = reclist->num_records;
1227 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1230 Z_SearchRequest *req = reqb->request->u.searchRequest;
1231 bend_search_rr *bsrr =
1232 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1234 yaz_log(LOG_LOG, "Got SearchRequest.");
1236 bsrr->request = reqb;
1237 bsrr->association = assoc;
1238 bsrr->referenceId = req->referenceId;
1239 save_referenceId (reqb, bsrr->referenceId);
1241 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1242 if (req->databaseNames)
1245 for (i = 0; i < req->num_databaseNames; i++)
1246 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1248 switch (req->query->which)
1250 case Z_Query_type_1: case Z_Query_type_101:
1251 log_rpn_query (req->query->u.type_1);
1253 if (assoc->bend_search)
1255 bsrr->setname = req->resultSetName;
1256 bsrr->replace_set = *req->replaceIndicator;
1257 bsrr->num_bases = req->num_databaseNames;
1258 bsrr->basenames = req->databaseNames;
1259 bsrr->query = req->query;
1260 bsrr->stream = assoc->encode;
1261 bsrr->decode = assoc->decode;
1262 bsrr->print = assoc->print;
1265 bsrr->errstring = NULL;
1266 ((int (*)(void *, bend_search_rr *))(assoc->bend_search))
1267 (assoc->backend, bsrr);
1273 bend_searchrequest bsrq;
1274 bend_searchresult *bsrt;
1276 bsrq.setname = req->resultSetName;
1277 bsrq.replace_set = *req->replaceIndicator;
1278 bsrq.num_bases = req->num_databaseNames;
1279 bsrq.basenames = req->databaseNames;
1280 bsrq.query = req->query;
1281 bsrq.referenceId = req->referenceId;
1282 bsrq.stream = assoc->encode;
1283 bsrq.decode = assoc->decode;
1284 bsrq.print = assoc->print;
1285 if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1287 bsrr->hits = bsrt->hits;
1288 bsrr->errcode = bsrt->errcode;
1289 bsrr->errstring = bsrt->errstring;
1291 return response_searchRequest(assoc, reqb, bsrr, fd);
1294 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1297 * Prepare a searchresponse based on the backend results. We probably want
1298 * to look at making the fetching of records nonblocking as well, but
1299 * so far, we'll keep things simple.
1300 * If bsrt is null, that means we're called in response to a communications
1301 * event, and we'll have to get the response for ourselves.
1303 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1304 bend_search_rr *bsrt, int *fd)
1306 Z_SearchRequest *req = reqb->request->u.searchRequest;
1307 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1308 Z_SearchResponse *resp = (Z_SearchResponse *)
1309 odr_malloc (assoc->encode, sizeof(*resp));
1310 int *nulint = (int *)odr_malloc (assoc->encode, sizeof(*nulint));
1311 bool_t *sr = (bool_t *)odr_malloc (assoc->encode, sizeof(*sr));
1312 int *next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1313 int *none = (int *)odr_malloc (assoc->encode, sizeof(*none));
1320 apdu->which = Z_APDU_searchResponse;
1321 apdu->u.searchResponse = resp;
1322 resp->referenceId = req->referenceId;
1323 resp->additionalSearchInfo = 0;
1324 resp->otherInfo = 0;
1326 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1328 yaz_log(LOG_FATAL, "Bad result from backend");
1331 else if (bsrt->errcode)
1333 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1334 resp->resultCount = nulint;
1335 resp->numberOfRecordsReturned = nulint;
1336 resp->nextResultSetPosition = nulint;
1337 resp->searchStatus = nulint;
1338 resp->resultSetStatus = none;
1339 resp->presentStatus = 0;
1343 int *toget = (int *)odr_malloc (assoc->encode, sizeof(*toget));
1344 int *presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1345 Z_RecordComposition comp, *compp = 0;
1350 resp->resultCount = &bsrt->hits;
1352 comp.which = Z_RecordComp_simple;
1353 /* how many records does the user agent want, then? */
1354 if (bsrt->hits <= *req->smallSetUpperBound)
1356 *toget = bsrt->hits;
1357 if ((comp.u.simple = req->smallSetElementSetNames))
1360 else if (bsrt->hits < *req->largeSetLowerBound)
1362 *toget = *req->mediumSetPresentNumber;
1363 if (*toget > bsrt->hits)
1364 *toget = bsrt->hits;
1365 if ((comp.u.simple = req->mediumSetElementSetNames))
1371 if (*toget && !resp->records)
1376 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1377 prefformat->oclass != CLASS_RECSYN)
1380 form = prefformat->value;
1381 resp->records = pack_records(assoc, req->resultSetName, 1,
1382 toget, compp, next, presst, form, req->referenceId);
1385 resp->numberOfRecordsReturned = toget;
1386 resp->nextResultSetPosition = next;
1387 resp->searchStatus = sr;
1388 resp->resultSetStatus = 0;
1389 resp->presentStatus = presst;
1393 if (*resp->resultCount)
1395 resp->numberOfRecordsReturned = nulint;
1396 resp->nextResultSetPosition = next;
1397 resp->searchStatus = sr;
1398 resp->resultSetStatus = 0;
1399 resp->presentStatus = 0;
1406 * Maybe we got a little over-friendly when we designed bend_fetch to
1407 * get only one record at a time. Some backends can optimise multiple-record
1408 * fetches, and at any rate, there is some overhead involved in
1409 * all that selecting and hopping around. Problem is, of course, that the
1410 * frontend can't know ahead of time how many records it'll need to
1411 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1412 * is downright lousy as a bulk data transfer protocol.
1414 * To start with, we'll do the fetching of records from the backend
1415 * in one operation: To save some trips in and out of the event-handler,
1416 * and to simplify the interface to pack_records. At any rate, asynch
1417 * operation is more fun in operations that have an unpredictable execution
1418 * speed - which is normally more true for search than for present.
1420 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1423 Z_PresentRequest *req = reqb->request->u.presentRequest;
1427 Z_PresentResponse *resp;
1432 yaz_log(LOG_LOG, "Got PresentRequest.");
1434 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1435 prefformat->oclass != CLASS_RECSYN)
1438 form = prefformat->value;
1439 if (assoc->bend_present)
1441 bend_present_rr *bprr = (bend_present_rr *)
1442 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1443 bprr->setname = req->resultSetId;
1444 bprr->start = *req->resultSetStartPoint;
1445 bprr->number = *req->numberOfRecordsRequested;
1446 bprr->format = form;
1447 bprr->comp = req->recordComposition;
1448 bprr->referenceId = req->referenceId;
1449 bprr->stream = assoc->encode;
1450 bprr->print = assoc->print;
1451 bprr->request = reqb;
1452 bprr->association = assoc;
1454 bprr->errstring = NULL;
1455 ((int (*)(void *, bend_present_rr *))(*assoc->bend_present))(
1456 assoc->backend, bprr);
1461 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1462 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1463 presst = (int *)odr_malloc (assoc->encode, sizeof(*presst));
1464 next = (int *)odr_malloc (assoc->encode, sizeof(*next));
1465 num = (int *)odr_malloc (assoc->encode, sizeof(*num));
1468 *num = *req->numberOfRecordsRequested;
1470 apdu->which = Z_APDU_presentResponse;
1471 apdu->u.presentResponse = resp;
1472 resp->referenceId = req->referenceId;
1473 resp->otherInfo = 0;
1476 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1477 num, req->recordComposition, next, presst, form,
1481 resp->numberOfRecordsReturned = num;
1482 resp->presentStatus = presst;
1483 resp->nextResultSetPosition = next;
1488 static int bend_default_scan (void *handle, bend_scan_rr *rr)
1490 bend_scanrequest srq;
1491 bend_scanresult *srs;
1493 srq.num_bases = rr->num_bases;
1494 srq.basenames = rr->basenames;
1495 srq.attributeset = rr->attributeset;
1496 srq.referenceId = rr->referenceId;
1497 srq.term = rr->term;
1498 srq.term_position = rr->term_position;
1499 srq.num_entries = rr->num_entries;
1500 srq.stream = rr->stream;
1501 srq.print = rr->print;
1503 srs = bend_scan(handle, &srq, 0);
1505 rr->term_position = srs->term_position;
1506 rr->num_entries = srs->num_entries;
1507 rr->entries = srs->entries;
1508 rr->status = srs->status;
1509 rr->errcode = srs->errcode;
1510 rr->errstring = srs->errstring;
1515 * Scan was implemented rather in a hurry, and with support for only the basic
1516 * elements of the service in the backend API. Suggestions are welcome.
1518 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1520 Z_ScanRequest *req = reqb->request->u.scanRequest;
1521 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1522 Z_ScanResponse *res = (Z_ScanResponse *)
1523 odr_malloc (assoc->encode, sizeof(*res));
1524 int *scanStatus = (int *)
1525 odr_malloc (assoc->encode, sizeof(*scanStatus));
1526 int *numberOfEntriesReturned = (int *)
1527 odr_malloc (assoc->encode, sizeof(*numberOfEntriesReturned));
1528 Z_ListEntries *ents = (Z_ListEntries *)
1529 odr_malloc (assoc->encode, sizeof(*ents));
1530 Z_DiagRecs *diagrecs_p = NULL;
1534 yaz_log(LOG_LOG, "Got ScanRequest");
1535 *scanStatus = Z_Scan_failure;
1536 *numberOfEntriesReturned = 0;
1538 apdu->which = Z_APDU_scanResponse;
1539 apdu->u.scanResponse = res;
1540 res->referenceId = req->referenceId;
1542 res->scanStatus = scanStatus;
1543 res->numberOfEntriesReturned = numberOfEntriesReturned;
1544 res->positionOfTerm = 0;
1545 res->entries = ents;
1546 ents->num_entries = 0;
1547 ents->entries = NULL;
1548 ents->num_nonsurrogateDiagnostics = 0;
1549 ents->nonsurrogateDiagnostics = NULL;
1550 res->attributeSet = 0;
1553 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1554 attent->oclass != CLASS_ATTSET
1555 || attent->value != VAL_BIB1))
1556 diagrecs_p = diagrecs(assoc, 121, 0);
1557 else if (req->stepSize && *req->stepSize > 0)
1558 diagrecs_p = diagrecs(assoc, 205, 0);
1561 bend_scan_rr *bsrr = (bend_scan_rr *)
1562 odr_malloc (assoc->encode, sizeof(*bsrr));
1563 if (req->databaseNames)
1566 for (i = 0; i < req->num_databaseNames; i++)
1567 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1569 bsrr->num_bases = req->num_databaseNames;
1570 bsrr->basenames = req->databaseNames;
1571 bsrr->num_entries = *req->numberOfTermsRequested;
1572 bsrr->term = req->termListAndStartPoint;
1573 bsrr->referenceId = req->referenceId;
1574 bsrr->stream = assoc->encode;
1575 bsrr->print = assoc->print;
1576 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1577 attset->oclass != CLASS_RECSYN)
1578 bsrr->attributeset = VAL_NONE;
1580 bsrr->attributeset = attset->value;
1581 log_scan_term (req->termListAndStartPoint, attset->value);
1582 bsrr->term_position = req->preferredPositionInResponse ?
1583 *req->preferredPositionInResponse : 1;
1584 ((int (*)(void *, bend_scan_rr *))(*assoc->bend_scan))(assoc->backend,
1587 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1591 Z_Entry **tab = (Z_Entry **)
1592 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1594 if (bsrr->status == BEND_SCAN_PARTIAL)
1595 *scanStatus = Z_Scan_partial_5;
1597 *scanStatus = Z_Scan_success;
1598 ents->entries = tab;
1599 ents->num_entries = bsrr->num_entries;
1600 res->numberOfEntriesReturned = &ents->num_entries;
1601 res->positionOfTerm = &bsrr->term_position;
1602 for (i = 0; i < bsrr->num_entries; i++)
1608 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1609 if (bsrr->entries[i].occurrences >= 0)
1611 e->which = Z_Entry_termInfo;
1612 e->u.termInfo = t = (Z_TermInfo *)
1613 odr_malloc(assoc->encode, sizeof(*t));
1614 t->suggestedAttributes = 0;
1616 t->alternativeTerm = 0;
1617 t->byAttributes = 0;
1618 t->otherTermInfo = 0;
1619 t->globalOccurrences = &bsrr->entries[i].occurrences;
1620 t->term = (Z_Term *)
1621 odr_malloc(assoc->encode, sizeof(*t->term));
1622 t->term->which = Z_Term_general;
1623 t->term->u.general = o =
1624 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1625 o->buf = (unsigned char *)
1626 odr_malloc(assoc->encode, o->len = o->size =
1627 strlen(bsrr->entries[i].term));
1628 memcpy(o->buf, bsrr->entries[i].term, o->len);
1629 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1630 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1634 Z_DiagRecs *drecs = diagrecs (assoc,
1635 bsrr->entries[i].errcode,
1636 bsrr->entries[i].errstring);
1637 assert (drecs->num_diagRecs == 1);
1638 e->which = Z_Entry_surrogateDiagnostic;
1639 assert (drecs->diagRecs[0]);
1640 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1647 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1648 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1653 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1656 Z_SortRequest *req = reqb->request->u.sortRequest;
1657 Z_SortResponse *res = (Z_SortResponse *)
1658 odr_malloc (assoc->encode, sizeof(*res));
1659 bend_sort_rr *bsrr = (bend_sort_rr *)
1660 odr_malloc (assoc->encode, sizeof(*bsrr));
1662 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1664 yaz_log(LOG_LOG, "Got SortRequest.");
1667 bsrr->num_input_setnames = req->num_inputResultSetNames;
1668 bsrr->input_setnames = req->inputResultSetNames;
1670 bsrr->num_input_setnames = req->inputResultSetNames->num_strings;
1671 bsrr->input_setnames = req->inputResultSetNames->strings;
1673 bsrr->referenceId = req->referenceId;
1674 bsrr->output_setname = req->sortedResultSetName;
1675 bsrr->sort_sequence = req->sortSequence;
1676 bsrr->stream = assoc->encode;
1677 bsrr->print = assoc->print;
1679 bsrr->sort_status = Z_SortStatus_failure;
1681 bsrr->errstring = 0;
1683 ((int (*)(void *, bend_sort_rr *))(*assoc->bend_sort))(assoc->backend,
1686 res->referenceId = bsrr->referenceId;
1687 res->sortStatus = (int *)
1688 odr_malloc (assoc->encode, sizeof(*res->sortStatus));
1689 *res->sortStatus = bsrr->sort_status;
1690 res->resultSetStatus = 0;
1693 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1695 res->diagnostics = dr->diagRecs;
1696 res->num_diagnostics = dr->num_diagRecs;
1698 res->diagnostics = dr;
1704 res->num_diagnostics = 0;
1706 res->diagnostics = 0;
1710 apdu->which = Z_APDU_sortResponse;
1711 apdu->u.sortResponse = res;
1715 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1718 Z_DeleteResultSetRequest *req = reqb->request->u.deleteResultSetRequest;
1719 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1720 odr_malloc (assoc->encode, sizeof(*res));
1721 bend_delete_rr *bdrr = (bend_delete_rr *)
1722 odr_malloc (assoc->encode, sizeof(*bdrr));
1723 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1725 yaz_log(LOG_LOG, "Got DeleteRequest.");
1727 bdrr->num_setnames = req->num_resultSetList;
1728 bdrr->setnames = req->resultSetList;
1729 bdrr->stream = assoc->encode;
1730 bdrr->print = assoc->print;
1731 bdrr->function = *req->deleteFunction;
1732 bdrr->referenceId = req->referenceId;
1734 if (bdrr->num_setnames > 0)
1737 bdrr->statuses = odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1738 bdrr->num_setnames);
1739 for (i = 0; i < bdrr->num_setnames; i++)
1740 bdrr->statuses[i] = 0;
1742 ((int (*)(void *, bend_delete_rr *))
1743 (*assoc->bend_delete))(assoc->backend, bdrr);
1745 res->referenceId = req->referenceId;
1747 res->deleteOperationStatus = (int *)
1748 odr_malloc (assoc->encode, sizeof(*res->deleteOperationStatus));
1749 *res->deleteOperationStatus = bdrr->delete_status;
1751 res->deleteListStatuses = 0;
1752 if (bdrr->num_setnames > 0)
1755 res->deleteListStatuses = odr_malloc(assoc->encode,
1756 sizeof(*res->deleteListStatuses));
1757 res->deleteListStatuses->num = bdrr->num_setnames;
1758 res->deleteListStatuses->elements =
1759 odr_malloc (assoc->encode,
1760 sizeof(*res->deleteListStatuses->elements) *
1761 bdrr->num_setnames);
1762 for (i = 0; i<bdrr->num_setnames; i++)
1764 res->deleteListStatuses->elements[i] =
1765 odr_malloc (assoc->encode,
1766 sizeof(**res->deleteListStatuses->elements));
1767 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1768 res->deleteListStatuses->elements[i]->id =
1769 odr_strdup (assoc->encode, bdrr->setnames[i]);
1773 res->numberNotDeleted = 0;
1774 res->bulkStatuses = 0;
1775 res->deleteMessage = 0;
1778 apdu->which = Z_APDU_deleteResultSetResponse;
1779 apdu->u.deleteResultSetResponse = res;
1783 static void process_close(association *assoc, request *reqb)
1785 Z_Close *req = reqb->request->u.close;
1786 static char *reasons[] =
1793 "securityViolation",
1800 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1801 reasons[*req->closeReason], req->diagnosticInformation ?
1802 req->diagnosticInformation : "NULL");
1803 if (assoc->version < 3) /* to make do_force respond with close */
1805 do_close_req(assoc, Z_Close_finished,
1806 "Association terminated by client", reqb);
1809 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1813 reqb->len_refid = refid->len;
1814 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1815 memcpy (reqb->refid, refid->buf, refid->len);
1819 reqb->len_refid = 0;
1824 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1826 process_response (a, req, res);
1829 bend_request bend_request_mk (bend_association a)
1831 request *nreq = request_get (&a->outgoing);
1832 nreq->request_mem = nmem_create ();
1836 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1841 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1842 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1843 id->len = id->size = req->len_refid;
1844 memcpy (id->buf, req->refid, req->len_refid);
1848 void bend_request_destroy (bend_request *req)
1850 nmem_destroy((*req)->request_mem);
1851 request_release(*req);
1855 int bend_backend_respond (bend_association a, bend_request req)
1859 r = process_request (a, req, &msg);
1861 logf (LOG_WARN, "%s", msg);
1865 void bend_request_setdata(bend_request r, void *p)
1870 void *bend_request_getdata(bend_request r)
1872 return r->clientData;
1875 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
1877 bend_esrequest_rr esrequest;
1879 Z_ExtendedServicesRequest *req = reqb->request->u.extendedServicesRequest;
1880 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
1882 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
1884 yaz_log(LOG_DEBUG,"inside Process esRequest");
1886 esrequest.esr = reqb->request->u.extendedServicesRequest;
1887 esrequest.stream = assoc->encode;
1888 esrequest.decode = assoc->decode;
1889 esrequest.print = assoc->print;
1890 esrequest.errcode = 0;
1891 esrequest.errstring = NULL;
1892 esrequest.request = reqb;
1893 esrequest.association = assoc;
1894 esrequest.referenceId = req->referenceId;
1896 ((int (*)(void *, bend_esrequest_rr *))(*assoc->bend_esrequest))
1897 (assoc->backend, &esrequest);
1899 /* If the response is being delayed, return NULL */
1900 if (esrequest.request == NULL)
1903 resp->referenceId = req->referenceId;
1905 if (esrequest.errcode == -1)
1907 /* Backend service indicates request will be processed */
1908 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
1909 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
1911 else if (esrequest.errcode == 0)
1913 /* Backend service indicates request will be processed */
1914 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
1915 *resp->operationStatus = Z_ExtendedServicesResponse_done;
1919 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
1920 esrequest.errstring);
1922 /* Backend indicates error, request will not be processed */
1923 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
1924 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
1925 resp->num_diagnostics = diagRecs->num_diagRecs;
1926 resp->diagnostics = diagRecs->diagRecs;
1928 /* Do something with the members of bend_extendedservice */
1930 yaz_log(LOG_DEBUG,"Send the result apdu");