2 * Copyright (c) 1995, Index Data
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.59 1996-05-14 09:26:46 quinn
8 * Added attribute set to scan backend
10 * Revision 1.58 1996/02/20 12:53:04 quinn
13 * Revision 1.57 1996/01/02 08:57:47 quinn
14 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
16 * Revision 1.56 1995/12/14 11:09:57 quinn
19 * Revision 1.55 1995/11/08 17:41:37 quinn
22 * Revision 1.54 1995/11/08 15:11:29 quinn
23 * Log of close transmit.
25 * Revision 1.53 1995/11/01 13:54:58 quinn
28 * Revision 1.52 1995/11/01 12:19:13 quinn
29 * Second attempt to fix same bug.
31 * Revision 1.50 1995/10/25 16:58:32 quinn
34 * Revision 1.49 1995/10/16 13:51:53 quinn
35 * Changes to provide Especs to the backend.
37 * Revision 1.48 1995/10/06 08:51:20 quinn
40 * Revision 1.47 1995/08/29 14:24:16 quinn
41 * Added second half of close-handshake
43 * Revision 1.46 1995/08/29 11:17:58 quinn
44 * Added code to receive close
46 * Revision 1.45 1995/08/21 09:11:00 quinn
47 * Smallish fixes to suppport new formats.
49 * Revision 1.44 1995/08/17 12:45:25 quinn
50 * Fixed minor problems with GRS-1. Added support in c&s.
52 * Revision 1.43 1995/08/15 12:00:31 quinn
55 * Revision 1.42 1995/08/15 11:16:50 quinn
57 * Revision 1.41 1995/08/02 10:23:06 quinn
60 * Revision 1.40 1995/07/31 14:34:26 quinn
61 * Fixed bug in process_searchResponse (numberOfRecordsReturned).
63 * Revision 1.39 1995/06/27 13:21:00 quinn
66 * Revision 1.38 1995/06/19 12:39:11 quinn
67 * Fixed bug in timeout code. Added BER dumper.
69 * Revision 1.37 1995/06/16 13:16:14 quinn
70 * Fixed Defaultdiagformat.
72 * Revision 1.36 1995/06/16 10:31:36 quinn
73 * Added session timeout.
75 * Revision 1.35 1995/06/15 07:45:14 quinn
78 * Revision 1.34 1995/06/14 15:26:46 quinn
79 * *** empty log message ***
81 * Revision 1.33 1995/06/06 14:57:05 quinn
84 * Revision 1.32 1995/06/06 08:41:44 quinn
87 * Revision 1.31 1995/06/06 08:15:37 quinn
90 * Revision 1.30 1995/06/05 10:53:32 quinn
91 * Added a better SCAN.
93 * Revision 1.29 1995/06/01 11:25:03 quinn
96 * Revision 1.28 1995/06/01 11:21:01 quinn
97 * Attempting to fix a bug in pack-records. replaced break with continue
98 * for large records, according to standard.
100 * Revision 1.27 1995/05/29 08:12:06 quinn
103 * Revision 1.26 1995/05/18 13:02:12 quinn
106 * Revision 1.25 1995/05/17 08:42:26 quinn
107 * Transfer auth info to backend. Allow backend to reject init gracefully.
109 * Revision 1.24 1995/05/16 08:51:04 quinn
110 * License, documentation, and memory fixes
112 * Revision 1.23 1995/05/15 13:25:10 quinn
115 * Revision 1.22 1995/05/15 11:56:39 quinn
116 * Asynchronous facilities. Restructuring of seshigh code.
118 * Revision 1.21 1995/05/02 08:53:19 quinn
119 * Trying in vain to fix comm with ISODE
121 * Revision 1.20 1995/04/20 15:13:00 quinn
124 * Revision 1.19 1995/04/18 08:15:34 quinn
125 * Added dynamic memory allocation on encoding (whew). Code is now somewhat
126 * neater. We'll make the same change for decoding one day.
128 * Revision 1.18 1995/04/17 11:28:25 quinn
131 * Revision 1.17 1995/04/10 10:23:36 quinn
132 * Some work to add scan and other things.
134 * Revision 1.16 1995/03/31 09:18:55 quinn
137 * Revision 1.15 1995/03/30 14:03:23 quinn
138 * Added RFC1006 as separate library
140 * Revision 1.14 1995/03/30 12:18:17 quinn
143 * Revision 1.13 1995/03/30 09:09:24 quinn
144 * Added state-handle and some support for asynchronous activities.
146 * Revision 1.12 1995/03/29 15:40:16 quinn
147 * Ongoing work. Statserv is now dynamic by default
149 * Revision 1.11 1995/03/28 09:16:21 quinn
150 * Added record packing to the search request
152 * Revision 1.10 1995/03/27 08:34:24 quinn
153 * Added dynamic server functionality.
154 * Released bindings to session.c (is now redundant)
156 * Revision 1.9 1995/03/22 15:01:26 quinn
157 * Adjusting record packing.
159 * Revision 1.8 1995/03/22 10:13:21 quinn
160 * Working on record packer
162 * Revision 1.7 1995/03/21 15:53:31 quinn
165 * Revision 1.6 1995/03/21 12:30:09 quinn
166 * Beginning to add support for record packing.
168 * Revision 1.5 1995/03/17 10:44:13 quinn
169 * Added catch of null-string in makediagrec
171 * Revision 1.4 1995/03/17 10:18:08 quinn
172 * Added memory management.
174 * Revision 1.3 1995/03/16 17:42:39 quinn
177 * Revision 1.2 1995/03/16 13:29:01 quinn
178 * Partitioned server.
180 * Revision 1.1 1995/03/15 16:02:10 quinn
181 * Modded session.c to seshigh.c
186 * Frontend server logic.
188 * This code receives incoming APDUs, and handles client requests by means
189 * of the backend API.
191 * Some of the code is getting quite involved, compared to simpler servers -
192 * primarily because it is asynchronous both in the communication with
193 * the user and the backend. We think the complexity will pay off in
194 * the form of greater flexibility when more asynchronous facilities
197 * Memory management has become somewhat involved. In the simple case, where
198 * only one PDU is pending at a time, it will simply reuse the same memory,
199 * once it has found its working size. When we enable multiple concurrent
200 * operations, perhaps even with multiple parallel calls to the backend, it
201 * will maintain a pool of buffers for encoding and decoding, trying to
202 * minimize memory allocation/deallocation during normal operation.
204 * TODOs include (and will be done in order of public interest):
206 * Support for EXPLAIN - provide simple meta-database system.
207 * Support for access control.
208 * Support for resource control.
209 * Support for extended services - primarily Item Order.
210 * Rest of Z39.50-1994
218 #include <sys/time.h>
221 #include <comstack.h>
227 #include <statserv.h>
231 static int process_request(association *assoc);
232 void backend_response(IOCHAN i, int event);
233 static int process_response(association *assoc, request *req, Z_APDU *res);
234 static Z_APDU *process_initRequest(association *assoc, request *reqb);
235 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
237 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
238 bend_searchresult *bsrt, int *fd);
239 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
241 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
242 static void process_close(association *assoc, request *reqb);
244 static FILE *apduf = 0; /* for use in static mode */
245 static statserv_options_block *control_block = 0;
248 * Create and initialize a new association-handle.
249 * channel : iochannel for the current line.
250 * link : communications channel.
251 * Returns: 0 or a new association handle.
253 association *create_association(IOCHAN channel, COMSTACK link)
258 control_block = statserv_getcontrol();
259 if (!(new = xmalloc(sizeof(*new))))
261 new->client_chan = channel;
262 new->client_link = link;
263 if (!(new->decode = odr_createmem(ODR_DECODE)) ||
264 !(new->encode = odr_createmem(ODR_ENCODE)))
266 if (*control_block->apdufile)
271 strcpy(filename, control_block->apdufile);
272 if (!(new->print = odr_createmem(ODR_PRINT)))
274 if (*control_block->apdufile != '-')
276 strcpy(filename, control_block->apdufile);
277 if (!control_block->dynamic)
281 if (!(apduf = fopen(filename, "w")))
283 logf(LOG_WARN|LOG_ERRNO, "%s", filename);
286 setvbuf(apduf, 0, _IONBF, 0);
292 sprintf(filename + strlen(filename), ".%d", getpid());
293 if (!(f = fopen(filename, "w")))
295 logf(LOG_WARN|LOG_ERRNO, "%s", filename);
298 setvbuf(f, 0, _IONBF, 0);
300 odr_setprint(new->print, f);
305 new->input_buffer = 0;
306 new->input_buffer_len = 0;
308 new->state = ASSOC_NEW;
309 request_initq(&new->incoming);
310 request_initq(&new->outgoing);
311 new->proto = cs_getproto(link);
316 * Free association and release resources.
318 void destroy_association(association *h)
320 odr_destroy(h->decode);
321 odr_destroy(h->encode);
323 odr_destroy(h->print);
325 xfree(h->input_buffer);
327 bend_close(h->backend);
328 while (request_deq(&h->incoming));
329 while (request_deq(&h->outgoing));
333 static void do_close(association *a, int reason, char *message)
336 Z_Close *cls = zget_Close(a->encode);
337 request *req = request_get();
339 /* Purge request queue */
340 while (request_deq(&a->incoming));
341 while (request_deq(&a->outgoing));
344 logf(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
345 reason, message ? message : "none");
346 apdu.which = Z_APDU_close;
348 *cls->closeReason = reason;
349 cls->diagnosticInformation = message;
350 process_response(a, req, &apdu);
351 iochan_settimeout(a->client_chan, 60);
355 logf(LOG_DEBUG, "v2 client. No Close PDU");
356 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
358 a->state = ASSOC_DEAD;
362 * This is where PDUs from the client are read and the further
363 * processing is initiated. Flow of control moves down through the
364 * various process_* functions below, until the encoded result comes back up
365 * to the output handler in here.
367 * h : the I/O channel that has an outstanding event.
368 * event : the current outstanding event.
370 void ir_session(IOCHAN h, int event)
373 association *assoc = iochan_getdata(h);
374 COMSTACK conn = assoc->client_link;
377 assert(h && conn && assoc);
378 if (event == EVENT_TIMEOUT)
380 if (assoc->state != ASSOC_UP)
382 logf(LOG_LOG, "Final timeout - closing connection.");
384 destroy_association(assoc);
389 logf(LOG_LOG, "Session idle too long. Sending close.");
390 do_close(assoc, Z_Close_lackOfActivity, 0);
394 if (event & EVENT_INPUT || event & EVENT_WORK) /* input */
396 if (event & EVENT_INPUT)
398 logf(LOG_DEBUG, "ir_session (input)");
399 assert(assoc && conn);
400 /* We aren't speaking to this fellow */
401 if (assoc->state == ASSOC_DEAD)
403 logf(LOG_LOG, "Closed connection after reject");
405 destroy_association(assoc);
409 if ((res = cs_get(conn, &assoc->input_buffer,
410 &assoc->input_buffer_len)) <= 0)
412 logf(LOG_LOG, "Connection closed by client");
414 destroy_association(assoc);
418 else if (res == 1) /* incomplete read - wait for more */
420 if (cs_more(conn)) /* more stuff - call us again later, please */
421 iochan_setevent(h, EVENT_INPUT);
423 /* we got a complete PDU. Let's decode it */
424 logf(LOG_DEBUG, "Got PDU, %d bytes", res);
425 req = request_get(); /* get a new request structure */
426 odr_reset(assoc->decode);
427 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
428 if (!z_APDU(assoc->decode, &req->request, 0))
430 logf(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
431 odr_errlist[odr_geterror(assoc->decode)],
432 odr_offset(assoc->decode));
433 logf(LOG_LOG, "PDU dump:");
434 odr_dumpBER(log_file(), assoc->input_buffer, res);
435 do_close(assoc, Z_Close_protocolError, "Malformed package");
438 req->request_mem = odr_extract_mem(assoc->decode);
439 if (assoc->print && !z_APDU(assoc->print, &req->request, 0))
441 logf(LOG_WARN, "ODR print error: %s",
442 odr_errlist[odr_geterror(assoc->print)]);
443 odr_reset(assoc->print);
445 request_enq(&assoc->incoming, req);
448 /* can we do something yet? */
449 req = request_head(&assoc->incoming);
450 if (req->state == REQUEST_IDLE)
451 if (process_request(assoc) < 0)
452 do_close(assoc, Z_Close_systemProblem, "Unknown error");
454 if (event & EVENT_OUTPUT)
456 request *req = request_head(&assoc->outgoing);
458 logf(LOG_DEBUG, "ir_session (output)");
459 req->state = REQUEST_PENDING;
460 switch (res = cs_put(conn, req->response, req->len_response))
463 logf(LOG_LOG, "Connection closed by client");
465 destroy_association(assoc);
468 case 0: /* all sent - release the request structure */
469 logf(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
470 nmem_destroy(req->request_mem);
471 request_deq(&assoc->outgoing);
472 request_release(req);
473 if (!request_head(&assoc->outgoing))
474 iochan_clearflag(h, EVENT_OUTPUT);
476 /* value of 1 -- partial send -- is simply ignored */
479 if (event & EVENT_EXCEPT)
481 logf(LOG_DEBUG, "ir_session (exception)");
483 destroy_association(assoc);
489 * Initiate request processing.
491 static int process_request(association *assoc)
493 request *req = request_head(&assoc->incoming);
497 logf(LOG_DEBUG, "process_request");
498 assert(req && req->state == REQUEST_IDLE);
499 switch (req->request->which)
501 case Z_APDU_initRequest:
502 res = process_initRequest(assoc, req); break;
503 case Z_APDU_searchRequest:
504 res = process_searchRequest(assoc, req, &fd); break;
505 case Z_APDU_presentRequest:
506 res = process_presentRequest(assoc, req, &fd); break;
507 case Z_APDU_scanRequest:
508 res = process_scanRequest(assoc, req, &fd); break;
510 process_close(assoc, req); return 0;
512 logf(LOG_WARN, "Bad APDU received");
517 logf(LOG_DEBUG, " result immediately available");
518 return process_response(assoc, req, res);
522 logf(LOG_WARN, " bad result");
525 else /* no result yet - one will be provided later */
529 /* Set up an I/O handler for the fd supplied by the backend */
531 logf(LOG_DEBUG, " establishing handler for result");
532 req->state = REQUEST_PENDING;
533 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
535 iochan_setdata(chan, assoc);
541 * Handle message from the backend.
543 void backend_response(IOCHAN i, int event)
545 association *assoc = iochan_getdata(i);
546 request *req = request_head(&assoc->incoming);
550 logf(LOG_DEBUG, "backend_response");
551 assert(assoc && req && req->state != REQUEST_IDLE);
552 /* determine what it is we're waiting for */
553 switch (req->request->which)
555 case Z_APDU_searchRequest:
556 res = response_searchRequest(assoc, req, 0, &fd); break;
558 case Z_APDU_presentRequest:
559 res = response_presentRequest(assoc, req, 0, &fd); break;
560 case Z_APDU_scanRequest:
561 res = response_scanRequest(assoc, req, 0, &fd); break;
564 logf(LOG_WARN, "Serious programmer's lapse or bug");
567 if ((res && process_response(assoc, req, res) < 0) || fd < 0)
569 logf(LOG_LOG, "Fatal error when talking to backend");
570 do_close(assoc, Z_Close_systemProblem, 0);
574 else if (!res) /* no result yet - try again later */
576 logf(LOG_DEBUG, " no result yet");
577 iochan_setfd(i, fd); /* in case fd has changed */
582 * Encode response, and transfer the request structure to the outgoing queue.
584 static int process_response(association *assoc, request *req, Z_APDU *res)
586 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
587 if (!z_APDU(assoc->encode, &res, 0))
589 logf(LOG_WARN, "ODR error when encoding response: %s",
590 odr_errlist[odr_geterror(assoc->decode)]);
591 odr_reset(assoc->encode);
594 req->response = odr_getbuf(assoc->encode, &req->len_response,
595 &req->size_response);
596 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
597 odr_reset(assoc->encode);
598 if (assoc->print && !z_APDU(assoc->print, &res, 0))
600 logf(LOG_WARN, "ODR print error: %s",
601 odr_errlist[odr_geterror(assoc->print)]);
602 odr_reset(assoc->print);
604 /* change this when we make the backend reentrant */
605 if (req == request_head(&assoc->incoming))
607 req->state = REQUEST_IDLE;
608 request_deq(&assoc->incoming);
610 request_enq(&assoc->outgoing, req);
611 /* turn the work over to the ir_session handler */
612 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
613 /* Is there more work to be done? give that to the input handler too */
614 if (request_head(&assoc->incoming))
615 iochan_setevent(assoc->client_chan, EVENT_WORK);
620 * Handle init request.
621 * At the moment, we don't check the options
622 * anywhere else in the code - we just try not to do anything that would
623 * break a naive client. We'll toss 'em into the association block when
624 * we need them there.
626 static Z_APDU *process_initRequest(association *assoc, request *reqb)
628 Z_InitRequest *req = reqb->request->u.initRequest;
629 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
630 Z_InitResponse *resp = apdu->u.initResponse;
631 bend_initrequest binitreq;
632 bend_initresult *binitres;
635 logf(LOG_LOG, "Got initRequest");
636 if (req->implementationId)
637 logf(LOG_LOG, "Id: %s", req->implementationId);
638 if (req->implementationName)
639 logf(LOG_LOG, "Name: %s", req->implementationName);
640 if (req->implementationVersion)
641 logf(LOG_LOG, "Version: %s", req->implementationVersion);
643 binitreq.configname = "default-config";
644 binitreq.auth = req->idAuthentication;
645 if (!(binitres = bend_init(&binitreq)))
647 logf(LOG_WARN, "Bad response from backend.");
651 assoc->backend = binitres->handle;
652 resp->referenceId = req->referenceId;
654 /* let's tell the client what we can do */
655 if (ODR_MASK_GET(req->options, Z_Options_search))
657 ODR_MASK_SET(resp->options, Z_Options_search);
658 strcat(options, "srch");
660 if (ODR_MASK_GET(req->options, Z_Options_present))
662 ODR_MASK_SET(resp->options, Z_Options_present);
663 strcat(options, " prst");
666 if (ODR_MASK_GET(req->options, Z_Options_delSet))
668 ODR_MASK_SET(&options, Z_Options_delSet);
669 strcat(options, " del");
672 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
674 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
675 strcat(options, " namedresults");
677 if (ODR_MASK_GET(req->options, Z_Options_scan))
679 ODR_MASK_SET(resp->options, Z_Options_scan);
680 strcat(options, " scan");
682 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
684 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
685 strcat(options, " concurop");
688 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
690 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
691 assoc->version = 2; /* 1 & 2 are equivalent */
693 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
695 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
698 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
700 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
703 logf(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
704 assoc->maximumRecordSize = *req->maximumRecordSize;
705 if (assoc->maximumRecordSize > control_block->maxrecordsize)
706 assoc->maximumRecordSize = control_block->maxrecordsize;
707 assoc->preferredMessageSize = *req->preferredMessageSize;
708 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
709 assoc->preferredMessageSize = assoc->maximumRecordSize;
710 resp->preferredMessageSize = &assoc->preferredMessageSize;
711 resp->maximumRecordSize = &assoc->maximumRecordSize;
712 resp->implementationName = "Index Data/YAZ Generic Frontend Server";
713 if (binitres->errcode)
715 logf(LOG_LOG, "Connection rejected by backend.");
717 assoc->state = ASSOC_DEAD;
720 assoc->state = ASSOC_UP;
725 * These functions should be merged.
729 * nonsurrogate diagnostic record.
731 static Z_Records *diagrec(oid_proto proto, int error, char *addinfo)
733 static Z_Records rec;
737 static Z_DiagRec drec;
738 static Z_DefaultDiagFormat dr;
744 bib1.oclass = CLASS_DIAGSET;
745 bib1.value = VAL_BIB1;
747 logf(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
750 rec.which = Z_Records_NSD;
752 rec.u.nonSurrogateDiagnostic = &drec;
753 drec.which = Z_DiagRec_defaultFormat;
754 drec.u.defaultFormat = &dr;
756 rec.u.nonSurrogateDiagnostic = &dr;
758 dr.diagnosticSetId = oid_getoidbyent(&bib1);
760 dr.which = Z_DiagForm_v2AddInfo;
761 dr.addinfo = addinfo ? addinfo : "";
766 * surrogate diagnostic.
768 static Z_NamePlusRecord *surrogatediagrec(oid_proto proto, char *dbname,
769 int error, char *addinfo)
771 static Z_NamePlusRecord rec;
775 static Z_DiagRec drec;
776 static Z_DefaultDiagFormat dr;
782 bib1.oclass = CLASS_DIAGSET;
783 bib1.value = VAL_BIB1;
785 logf(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
787 rec.databaseName = dbname;
788 rec.which = Z_NamePlusRecord_surrogateDiagnostic;
790 rec.u.surrogateDiagnostic = &drec;
791 drec.which = Z_DiagRec_defaultFormat;
792 drec.u.defaultFormat = &dr;
794 rec.u.surrogateDiagnostic = &dr;
796 dr.diagnosticSetId = oid_getoidbyent(&bib1);
798 dr.which = Z_DiagForm_v2AddInfo;
799 dr.addinfo = addinfo ? addinfo : "";
804 * multiple nonsurrogate diagnostics.
806 static Z_DiagRecs *diagrecs(oid_proto proto, int error, char *addinfo)
808 static Z_DiagRecs recs;
812 static Z_DiagRec *recp[1], drec;
813 static Z_DefaultDiagFormat rec;
815 static Z_DiagRec *recp[1], rec;
818 logf(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo);
820 bib1.oclass = CLASS_DIAGSET;
821 bib1.value = VAL_BIB1;
824 recs.num_diagRecs = 1;
825 recs.diagRecs = recp;
828 drec.which = Z_DiagRec_defaultFormat;
829 drec.u.defaultFormat = &rec;
833 rec.diagnosticSetId = oid_getoidbyent(&bib1);
834 rec.condition = &err;
835 rec.which = Z_DiagForm_v2AddInfo;
836 rec.addinfo = addinfo ? addinfo : "";
840 #define MAX_RECORDS 256
842 static Z_Records *pack_records(association *a, char *setname, int start,
843 int *num, Z_RecordComposition *comp,
844 int *next, int *pres, oid_value format)
846 int recno, total_length = 0, toget = *num;
847 static Z_Records records;
848 static Z_NamePlusRecordList reclist;
849 static Z_NamePlusRecord *list[MAX_RECORDS];
852 records.which = Z_Records_DBOSD;
853 records.u.databaseOrSurDiagnostics = &reclist;
854 reclist.num_records = 0;
855 reclist.records = list;
856 *pres = Z_PRES_SUCCESS;
860 logf(LOG_DEBUG, "Request to pack %d+%d", start, toget);
861 logf(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
862 a->maximumRecordSize);
863 for (recno = start; reclist.num_records < toget; recno++)
865 bend_fetchrequest freq;
866 bend_fetchresult *fres;
867 Z_NamePlusRecord *thisrec;
868 Z_DatabaseRecord *thisext;
872 * we get the number of bytes allocated on the stream before any
873 * allocation done by the backend - this should give us a reasonable
874 * idea of the total size of the data so far.
876 total_length = odr_total(a->encode);
877 if (reclist.num_records == MAX_RECORDS - 1)
879 *pres = Z_PRES_PARTIAL_2;
882 freq.setname = setname;
885 freq.format = format;
886 freq.stream = a->encode;
887 if (!(fres = bend_fetch(a->backend, &freq, 0)))
889 *pres = Z_PRES_FAILURE;
890 return diagrec(a->proto, 2, "Backend interface problem");
892 /* backend should be able to signal whether error is system-wide
893 or only pertaining to current record */
896 *pres = Z_PRES_FAILURE;
897 return diagrec(a->proto, fres->errcode, fres->errstring);
900 this_length = fres->len;
902 this_length = odr_total(a->encode) - total_length;
903 logf(LOG_DEBUG, " fetched record, len=%d, total=%d",
904 this_length, total_length);
905 if (this_length + total_length > a->preferredMessageSize)
907 /* record is small enough, really */
908 if (this_length <= a->preferredMessageSize)
910 logf(LOG_DEBUG, " Dropped last normal-sized record");
911 *pres = Z_PRES_PARTIAL_2;
914 /* record can only be fetched by itself */
915 if (this_length < a->maximumRecordSize)
917 logf(LOG_DEBUG, " Record > prefmsgsz");
920 logf(LOG_DEBUG, " Dropped it");
921 reclist.records[reclist.num_records] =
922 surrogatediagrec(a->proto, fres->basename, 16, 0);
923 reclist.num_records++;
927 else /* too big entirely */
929 logf(LOG_DEBUG, "Record > maxrcdsz");
930 reclist.records[reclist.num_records] =
931 surrogatediagrec(a->proto, fres->basename, 17, 0);
932 reclist.num_records++;
936 if (!(thisrec = odr_malloc(a->encode, sizeof(*thisrec))))
938 if (!(thisrec->databaseName = odr_malloc(a->encode,
939 strlen(fres->basename) + 1)))
941 strcpy(thisrec->databaseName, fres->basename);
942 thisrec->which = Z_NamePlusRecord_databaseRecord;
943 if (!(thisrec->u.databaseRecord = thisext = odr_malloc(a->encode,
944 sizeof(Z_DatabaseRecord))))
946 recform.proto = a->proto;
947 recform.oclass = CLASS_RECSYN;
948 recform.value = fres->format;
949 thisext->direct_reference = odr_oiddup(a->encode,
950 oid_getoidbyent(&recform));
951 thisext->indirect_reference = 0;
952 thisext->descriptor = 0;
953 if (fres->len < 0) /* Structured data */
955 switch (fres->format)
957 case VAL_SUTRS: thisext->which = Z_External_sutrs; break;
958 case VAL_GRS1: thisext->which = Z_External_grs1; break;
959 case VAL_EXPLAIN: thisext->which = Z_External_explainRecord;
963 logf(LOG_FATAL, "Unknown structured format from backend.");
968 * We cheat on the pointers here. Obviously, the record field
969 * of the backend-fetch structure should have been a union for
970 * correctness, but we're stuck with this for backwards
973 thisext->u.grs1 = (Z_GenericRecord*) fres->record;
975 else if (fres->format == VAL_SUTRS) /* SUTRS is a single-ASN.1-type */
977 Odr_oct *sutrs = odr_malloc(a->encode, sizeof(*sutrs));
979 thisext->which = Z_External_sutrs;
980 thisext->u.sutrs = sutrs;
981 sutrs->buf = odr_malloc(a->encode, fres->len);
982 sutrs->len = sutrs->size = fres->len;
983 memcpy(sutrs->buf, fres->record, fres->len);
985 else /* octet-aligned record. */
987 thisext->which = Z_External_octet;
988 if (!(thisext->u.octet_aligned = odr_malloc(a->encode,
991 if (!(thisext->u.octet_aligned->buf = odr_malloc(a->encode,
994 memcpy(thisext->u.octet_aligned->buf, fres->record, fres->len);
995 thisext->u.octet_aligned->len = thisext->u.octet_aligned->size =
998 reclist.records[reclist.num_records] = thisrec;
999 reclist.num_records++;
1000 *next = fres->last_in_set ? 0 : recno + 1;
1002 *num = reclist.num_records;
1006 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1009 Z_SearchRequest *req = reqb->request->u.searchRequest;
1010 bend_searchrequest bsrq;
1011 bend_searchresult *bsrt;
1013 logf(LOG_LOG, "Got SearchRequest.");
1015 bsrq.setname = req->resultSetName;
1016 bsrq.replace_set = *req->replaceIndicator;
1017 bsrq.num_bases = req->num_databaseNames;
1018 bsrq.basenames = req->databaseNames;
1019 bsrq.query = req->query;
1021 if (!(bsrt = bend_search(assoc->backend, &bsrq, fd)))
1023 return response_searchRequest(assoc, reqb, bsrt, fd);
1026 bend_searchresult *bend_searchresponse(void *handle) {return 0;}
1029 * Prepare a searchresponse based on the backend results. We probably want
1030 * to look at making the fetching of records nonblocking as well, but
1031 * so far, we'll keep things simple.
1032 * If bsrt is null, that means we're called in response to a communications
1033 * event, and we'll have to get the response for ourselves.
1035 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1036 bend_searchresult *bsrt, int *fd)
1038 Z_SearchRequest *req = reqb->request->u.searchRequest;
1040 static Z_SearchResponse resp;
1041 static int nulint = 0;
1042 static bool_t sr = 1;
1043 static int next = 0;
1044 static int none = Z_RES_NONE;
1046 apdu.which = Z_APDU_searchResponse;
1047 apdu.u.searchResponse = &resp;
1048 resp.referenceId = req->referenceId;
1050 resp.additionalSearchInfo = 0;
1054 if (!bsrt && !(bsrt = bend_searchresponse(assoc->backend)))
1056 logf(LOG_FATAL, "Bad result from backend");
1059 else if (bsrt->errcode)
1061 resp.records = diagrec(assoc->proto, bsrt->errcode,
1063 resp.resultCount = &nulint;
1064 resp.numberOfRecordsReturned = &nulint;
1065 resp.nextResultSetPosition = &nulint;
1066 resp.searchStatus = &nulint;
1067 resp.resultSetStatus = &none;
1068 resp.presentStatus = 0;
1073 Z_RecordComposition comp, *compp = 0;
1074 static int presst = 0;
1077 resp.resultCount = &bsrt->hits;
1079 comp.which = Z_RecordComp_simple;
1080 /* how many records does the user agent want, then? */
1081 if (bsrt->hits <= *req->smallSetUpperBound)
1084 if ((comp.u.simple = req->smallSetElementSetNames))
1087 else if (bsrt->hits < *req->largeSetLowerBound)
1089 toget = *req->mediumSetPresentNumber;
1090 if (toget > bsrt->hits)
1092 if ((comp.u.simple = req->mediumSetElementSetNames))
1098 if (toget && !resp.records)
1103 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1104 prefformat->oclass != CLASS_RECSYN)
1107 form = prefformat->value;
1108 resp.records = pack_records(assoc, req->resultSetName, 1,
1109 &toget, compp, &next, &presst, form);
1112 resp.numberOfRecordsReturned = &toget;
1113 resp.nextResultSetPosition = &next;
1114 resp.searchStatus = &sr;
1115 resp.resultSetStatus = 0;
1116 resp.presentStatus = &presst;
1120 if (*resp.resultCount)
1122 resp.numberOfRecordsReturned = &nulint;
1123 resp.nextResultSetPosition = &next;
1124 resp.searchStatus = &sr;
1125 resp.resultSetStatus = 0;
1126 resp.presentStatus = 0;
1133 * Maybe we got a little over-friendly when we designed bend_fetch to
1134 * get only one record at a time. Some backends can optimise multiple-record
1135 * fetches, and at any rate, there is some overhead involved in
1136 * all that selecting and hopping around. Problem is, of course, that the
1137 * frontend can't know ahead of time how many records it'll need to
1138 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1139 * is downright lousy as a bulk data transfer protocol.
1141 * To start with, we'll do the fetching of records from the backend
1142 * in one operation: To save some trips in and out of the event-handler,
1143 * and to simplify the interface to pack_records. At any rate, asynch
1144 * operation is more fun in operations that have an unpredictable execution
1145 * speed - which is normally more true for search than for present.
1147 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1150 Z_PresentRequest *req = reqb->request->u.presentRequest;
1152 static Z_PresentResponse resp;
1153 static int presst, next, num;
1158 logf(LOG_LOG, "Got PresentRequest.");
1159 apdu.which = Z_APDU_presentResponse;
1160 apdu.u.presentResponse = &resp;
1161 resp.referenceId = req->referenceId;
1166 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)) ||
1167 prefformat->oclass != CLASS_RECSYN)
1170 form = prefformat->value;
1171 num = *req->numberOfRecordsRequested;
1172 resp.records = pack_records(assoc, req->resultSetId,
1173 *req->resultSetStartPoint, &num, req->recordComposition, &next,
1177 resp.numberOfRecordsReturned = #
1178 resp.presentStatus = &presst;
1179 resp.nextResultSetPosition = &next;
1185 * Scan was implemented rather in a hurry, and with support for only the basic
1186 * elements of the service in the backend API. Suggestions are welcome.
1188 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1190 Z_ScanRequest *req = reqb->request->u.scanRequest;
1192 static Z_ScanResponse res;
1193 static int scanStatus = Z_Scan_failure;
1194 static int numberOfEntriesReturned = 0;
1196 static Z_ListEntries ents;
1197 #define SCAN_MAX_ENTRIES 200
1198 static Z_Entry *tab[SCAN_MAX_ENTRIES];
1199 bend_scanrequest srq;
1200 bend_scanresult *srs;
1203 logf(LOG_LOG, "Got scanrequest");
1204 apdu.which = Z_APDU_scanResponse;
1205 apdu.u.scanResponse = &res;
1206 res.referenceId = req->referenceId;
1208 res.scanStatus = &scanStatus;
1209 res.numberOfEntriesReturned = &numberOfEntriesReturned;
1210 res.positionOfTerm = 0;
1211 res.entries = &ents;
1212 ents.which = Z_ListEntries_nonSurrogateDiagnostics;
1213 res.attributeSet = 0;
1218 if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1219 attent->oclass != CLASS_ATTSET || attent->value != VAL_BIB1))
1220 ents.u.nonSurrogateDiagnostics = diagrecs(assoc->proto, 121, 0);
1221 else if (req->stepSize && *req->stepSize > 0)
1222 ents.u.nonSurrogateDiagnostics = diagrecs(assoc->proto, 205, 0);
1225 if (req->termListAndStartPoint->term->which == Z_Term_general)
1226 logf(LOG_DEBUG, " term: '%.*s'",
1227 req->termListAndStartPoint->term->u.general->len,
1228 req->termListAndStartPoint->term->u.general->buf);
1229 srq.num_bases = req->num_databaseNames;
1230 srq.basenames = req->databaseNames;
1231 srq.num_entries = *req->numberOfTermsRequested;
1232 srq.term = req->termListAndStartPoint;
1233 if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1234 attset->oclass != CLASS_RECSYN)
1235 srq.attributeset = VAL_NONE;
1237 srq.attributeset = attset->value;
1238 srq.term_position = req->preferredPositionInResponse ?
1239 *req->preferredPositionInResponse : 1;
1240 if (!(srs = bend_scan(assoc->backend, &srq, 0)))
1241 ents.u.nonSurrogateDiagnostics = diagrecs(assoc->proto, 2, 0);
1242 else if (srs->errcode)
1243 ents.u.nonSurrogateDiagnostics = diagrecs(assoc->proto,
1244 srs->errcode, srs->errstring);
1248 static Z_Entries list;
1250 if (srs->status == BEND_SCAN_PARTIAL)
1251 scanStatus = Z_Scan_partial_5;
1253 scanStatus = Z_Scan_success;
1254 ents.which = Z_ListEntries_entries;
1255 ents.u.entries = &list;
1257 for (i = 0; i < srs->num_entries; i++)
1263 if (i >= SCAN_MAX_ENTRIES)
1265 scanStatus = Z_Scan_partial_4;
1268 list.entries[i] = e = odr_malloc(assoc->encode, sizeof(*e));
1269 e->which = Z_Entry_termInfo;
1270 e->u.termInfo = t = odr_malloc(assoc->encode, sizeof(*t));
1271 t->suggestedAttributes = 0;
1273 t->alternativeTerm = 0;
1274 t->byAttributes = 0;
1275 t->otherTermInfo = 0;
1276 t->globalOccurrences = &srs->entries[i].occurrences;
1277 t->term = odr_malloc(assoc->encode, sizeof(*t->term));
1278 t->term->which = Z_Term_general;
1279 t->term->u.general = o = odr_malloc(assoc->encode,
1281 o->buf = odr_malloc(assoc->encode, o->len = o->size =
1282 strlen(srs->entries[i].term));
1283 memcpy(o->buf, srs->entries[i].term, o->len);
1284 logf(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1285 srs->entries[i].term, srs->entries[i].occurrences);
1287 list.num_entries = i;
1288 res.numberOfEntriesReturned = &list.num_entries;
1289 res.positionOfTerm = &srs->term_position;
1296 static void process_close(association *assoc, request *reqb)
1298 Z_Close *req = reqb->request->u.close;
1299 static char *reasons[] =
1306 "securityViolation",
1313 logf(LOG_LOG, "Got close, reason %s, message %s",
1314 reasons[*req->closeReason], req->diagnosticInformation ?
1315 req->diagnosticInformation : "NULL");
1316 if (assoc->version < 3) /* to make do_force respond with close */
1318 do_close(assoc, Z_Close_finished, "Association terminated by client");