2 * Copyright (c) 1995-2003, Index Data
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.136 2003-02-17 14:35:42 adam Exp $
9 * Frontend server logic.
11 * This code receives incoming APDUs, and handles client requests by means
14 * Some of the code is getting quite involved, compared to simpler servers -
15 * primarily because it is asynchronous both in the communication with
16 * the user and the backend. We think the complexity will pay off in
17 * the form of greater flexibility when more asynchronous facilities
20 * Memory management has become somewhat involved. In the simple case, where
21 * only one PDU is pending at a time, it will simply reuse the same memory,
22 * once it has found its working size. When we enable multiple concurrent
23 * operations, perhaps even with multiple parallel calls to the backend, it
24 * will maintain a pool of buffers for encoding and decoding, trying to
25 * minimize memory allocation/deallocation during normal operation.
31 #include <sys/types.h>
34 #define S_ISREG(x) (x & _S_IFREG)
42 #include <yaz/yconfig.h>
43 #include <yaz/xmalloc.h>
44 #include <yaz/comstack.h>
47 #include <yaz/proto.h>
50 #include <yaz/logrpn.h>
51 #include <yaz/statserv.h>
52 #include <yaz/diagbib1.h>
53 #include <yaz/charneg.h>
54 #include <yaz/otherinfo.h>
55 #include <yaz/yaz-util.h>
58 #include <yaz/backend.h>
60 static void process_gdu_request(association *assoc, request *req);
61 static int process_z_request(association *assoc, request *req, char **msg);
62 void backend_response(IOCHAN i, int event);
63 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
64 static int process_z_response(association *assoc, request *req, Z_APDU *res);
65 static Z_APDU *process_initRequest(association *assoc, request *reqb);
66 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
68 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
69 bend_search_rr *bsrr, int *fd);
70 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
72 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
73 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
74 static void process_close(association *assoc, request *reqb);
75 void save_referenceId (request *reqb, Z_ReferenceId *refid);
76 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
78 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
80 static FILE *apduf = 0; /* for use in static mode */
81 static statserv_options_block *control_block = 0;
83 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
86 * Create and initialize a new association-handle.
87 * channel : iochannel for the current line.
88 * link : communications channel.
89 * Returns: 0 or a new association handle.
91 association *create_association(IOCHAN channel, COMSTACK link)
96 control_block = statserv_getcontrol();
97 if (!(anew = (association *)xmalloc(sizeof(*anew))))
100 anew->client_chan = channel;
101 anew->client_link = link;
102 anew->cs_get_mask = 0;
103 anew->cs_put_mask = 0;
104 anew->cs_accept_mask = 0;
105 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
106 !(anew->encode = odr_createmem(ODR_ENCODE)))
108 if (*control_block->apdufile)
113 strcpy(filename, control_block->apdufile);
114 if (!(anew->print = odr_createmem(ODR_PRINT)))
116 if (*control_block->apdufile == '@')
118 odr_setprint(anew->print, yaz_log_file());
120 else if (*control_block->apdufile != '-')
122 strcpy(filename, control_block->apdufile);
123 if (!control_block->dynamic)
127 if (!(apduf = fopen(filename, "w")))
129 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
132 setvbuf(apduf, 0, _IONBF, 0);
138 sprintf(filename + strlen(filename), ".%d", getpid());
139 if (!(f = fopen(filename, "w")))
141 yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
144 setvbuf(f, 0, _IONBF, 0);
146 odr_setprint(anew->print, f);
151 anew->input_buffer = 0;
152 anew->input_buffer_len = 0;
154 anew->state = ASSOC_NEW;
155 request_initq(&anew->incoming);
156 request_initq(&anew->outgoing);
157 anew->proto = cs_getproto(link);
162 * Free association and release resources.
164 void destroy_association(association *h)
166 statserv_options_block *cb = statserv_getcontrol();
169 odr_destroy(h->decode);
170 odr_destroy(h->encode);
172 odr_destroy(h->print);
174 xfree(h->input_buffer);
176 (*cb->bend_close)(h->backend);
177 while (request_deq(&h->incoming));
178 while (request_deq(&h->outgoing));
179 request_delq(&h->incoming);
180 request_delq(&h->outgoing);
182 xmalloc_trav("session closed");
183 if (control_block && control_block->one_shot)
187 static void do_close_req(association *a, int reason, char *message,
191 Z_Close *cls = zget_Close(a->encode);
193 /* Purge request queue */
194 while (request_deq(&a->incoming));
195 while (request_deq(&a->outgoing));
198 yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
199 reason, message ? message : "none");
200 apdu.which = Z_APDU_close;
202 *cls->closeReason = reason;
203 cls->diagnosticInformation = message;
204 process_z_response(a, req, &apdu);
205 iochan_settimeout(a->client_chan, 60);
209 yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
210 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
212 a->state = ASSOC_DEAD;
215 static void do_close(association *a, int reason, char *message)
217 do_close_req (a, reason, message, request_get(&a->outgoing));
221 * This is where PDUs from the client are read and the further
222 * processing is initiated. Flow of control moves down through the
223 * various process_* functions below, until the encoded result comes back up
224 * to the output handler in here.
226 * h : the I/O channel that has an outstanding event.
227 * event : the current outstanding event.
229 void ir_session(IOCHAN h, int event)
232 association *assoc = (association *)iochan_getdata(h);
233 COMSTACK conn = assoc->client_link;
236 assert(h && conn && assoc);
237 if (event == EVENT_TIMEOUT)
239 if (assoc->state != ASSOC_UP)
241 yaz_log(LOG_LOG, "Final timeout - closing connection.");
243 destroy_association(assoc);
248 yaz_log(LOG_LOG, "Session idle too long. Sending close.");
249 do_close(assoc, Z_Close_lackOfActivity, 0);
253 if (event & assoc->cs_accept_mask)
255 yaz_log (LOG_DEBUG, "ir_session (accept)");
256 if (!cs_accept (conn))
258 yaz_log (LOG_LOG, "accept failed");
259 destroy_association(assoc);
262 iochan_clearflag (h, EVENT_OUTPUT|EVENT_OUTPUT);
263 if (conn->io_pending)
264 { /* cs_accept didn't complete */
265 assoc->cs_accept_mask =
266 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
267 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
269 iochan_setflag (h, assoc->cs_accept_mask);
272 { /* cs_accept completed. Prepare for reading (cs_get) */
273 assoc->cs_accept_mask = 0;
274 assoc->cs_get_mask = EVENT_INPUT;
275 iochan_setflag (h, assoc->cs_get_mask);
279 if ((event & assoc->cs_get_mask) || (event & EVENT_WORK)) /* input */
281 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
283 yaz_log(LOG_DEBUG, "ir_session (input)");
284 /* We aren't speaking to this fellow */
285 if (assoc->state == ASSOC_DEAD)
287 yaz_log(LOG_LOG, "Closed connection after reject");
289 destroy_association(assoc);
293 assoc->cs_get_mask = EVENT_INPUT;
294 if ((res = cs_get(conn, &assoc->input_buffer,
295 &assoc->input_buffer_len)) <= 0)
297 yaz_log(LOG_LOG, "Connection closed by client");
299 destroy_association(assoc);
303 else if (res == 1) /* incomplete read - wait for more */
305 if (conn->io_pending & CS_WANT_WRITE)
306 assoc->cs_get_mask |= EVENT_OUTPUT;
307 iochan_setflag(h, assoc->cs_get_mask);
310 if (cs_more(conn)) /* more stuff - call us again later, please */
311 iochan_setevent(h, EVENT_INPUT);
313 /* we got a complete PDU. Let's decode it */
314 yaz_log(LOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
315 assoc->input_buffer[0] & 0xff,
316 assoc->input_buffer[1] & 0xff,
317 assoc->input_buffer[2] & 0xff);
318 req = request_get(&assoc->incoming); /* get a new request structure */
319 odr_reset(assoc->decode);
320 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
321 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
323 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
324 odr_errmsg(odr_geterror(assoc->decode)),
325 odr_offset(assoc->decode));
326 if (assoc->decode->error != OHTTP)
328 yaz_log(LOG_LOG, "PDU dump:");
329 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
330 do_close(assoc, Z_Close_protocolError, "Malformed package");
334 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
335 assoc->state = ASSOC_DEAD;
336 process_gdu_response(assoc, req, p);
340 req->request_mem = odr_extract_mem(assoc->decode);
341 if (assoc->print && !z_GDU(assoc->print, &req->gdu_request, 0, 0))
343 yaz_log(LOG_WARN, "ODR print error: %s",
344 odr_errmsg(odr_geterror(assoc->print)));
345 odr_reset(assoc->print);
347 request_enq(&assoc->incoming, req);
350 /* can we do something yet? */
351 req = request_head(&assoc->incoming);
352 if (req->state == REQUEST_IDLE)
354 request_deq(&assoc->incoming);
355 process_gdu_request(assoc, req);
358 if (event & assoc->cs_put_mask)
360 request *req = request_head(&assoc->outgoing);
362 assoc->cs_put_mask = 0;
363 yaz_log(LOG_DEBUG, "ir_session (output)");
364 req->state = REQUEST_PENDING;
365 switch (res = cs_put(conn, req->response, req->len_response))
368 yaz_log(LOG_LOG, "Connection closed by client");
370 destroy_association(assoc);
373 case 0: /* all sent - release the request structure */
374 yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
376 yaz_log(LOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
379 nmem_destroy(req->request_mem);
380 request_deq(&assoc->outgoing);
381 request_release(req);
382 if (!request_head(&assoc->outgoing))
383 { /* restore mask for cs_get operation ... */
384 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
385 iochan_setflag(h, assoc->cs_get_mask);
386 yaz_log(LOG_LOG, "queue empty mask=%d", assoc->cs_get_mask);
387 if (assoc->state == ASSOC_DEAD)
388 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
392 assoc->cs_put_mask = EVENT_OUTPUT;
393 yaz_log(LOG_LOG, "queue not empty");
397 if (conn->io_pending & CS_WANT_WRITE)
398 assoc->cs_put_mask |= EVENT_OUTPUT;
399 if (conn->io_pending & CS_WANT_READ)
400 assoc->cs_put_mask |= EVENT_INPUT;
401 iochan_setflag(h, assoc->cs_put_mask);
404 if (event & EVENT_EXCEPT)
406 yaz_log(LOG_LOG, "ir_session (exception)");
408 destroy_association(assoc);
413 static int process_z_request(association *assoc, request *req, char **msg);
415 static int srw_bend_init(association *assoc)
417 bend_initresult *binitres;
418 statserv_options_block *cb = statserv_getcontrol();
420 assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
422 assoc->init->stream = assoc->encode;
423 assoc->init->print = assoc->print;
424 assoc->init->auth = 0;
425 assoc->init->referenceId = 0;
426 assoc->init->implementation_version = 0;
427 assoc->init->implementation_id = 0;
428 assoc->init->implementation_name = 0;
429 assoc->init->bend_sort = NULL;
430 assoc->init->bend_search = NULL;
431 assoc->init->bend_present = NULL;
432 assoc->init->bend_esrequest = NULL;
433 assoc->init->bend_delete = NULL;
434 assoc->init->bend_scan = NULL;
435 assoc->init->bend_segment = NULL;
436 assoc->init->bend_fetch = NULL;
437 assoc->init->charneg_request = NULL;
438 assoc->init->charneg_response = NULL;
439 assoc->init->decode = assoc->decode;
441 assoc->init->peer_name =
442 odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
443 if (!(binitres = (*cb->bend_init)(assoc->init)))
445 yaz_log(LOG_WARN, "Bad response from backend.");
448 assoc->backend = binitres->handle;
452 static void srw_bend_fetch(association *assoc, int pos,
453 Z_SRW_searchRetrieveRequest *srw_req,
454 Z_SRW_record *record)
457 ODR o = assoc->encode;
459 rr.setname = "default";
462 rr.request_format = VAL_TEXT_XML;
463 rr.request_format_raw = yaz_oidval_to_z3950oid(assoc->decode,
466 rr.comp = (Z_RecordComposition *)
467 odr_malloc(assoc->decode, sizeof(*rr.comp));
468 rr.comp->which = Z_RecordComp_complex;
469 rr.comp->u.complex = (Z_CompSpec *)
470 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
471 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
472 odr_malloc(assoc->encode, sizeof(bool_t));
473 *rr.comp->u.complex->selectAlternativeSyntax = 0;
474 rr.comp->u.complex->num_dbSpecific = 0;
475 rr.comp->u.complex->dbSpecific = 0;
476 rr.comp->u.complex->num_recordSyntax = 0;
477 rr.comp->u.complex->recordSyntax = 0;
479 rr.comp->u.complex->generic = (Z_Specification *)
480 odr_malloc(assoc->decode, sizeof(Z_Specification));
481 rr.comp->u.complex->generic->which = Z_Specification_uri;
482 rr.comp->u.complex->generic->u.uri = srw_req->recordSchema;
483 rr.comp->u.complex->generic->elementSpec = 0;
485 rr.stream = assoc->encode;
486 rr.print = assoc->print;
492 rr.output_format = VAL_TEXT_XML;
493 rr.output_format_raw = 0;
496 rr.surrogate_flag = 0;
498 (*assoc->init->bend_fetch)(assoc->backend, &rr);
502 record->recordData_buf = rr.record;
503 record->recordData_len = rr.len;
504 record->recordPosition = odr_intdup(o, pos);
505 record->recordSchema = 0;
506 if (srw_req->recordSchema)
507 record->recordSchema = odr_strdup(o, srw_req->recordSchema);
511 static void srw_bend_search(association *assoc, request *req,
512 Z_SRW_searchRetrieveRequest *srw_req,
513 Z_SRW_searchRetrieveResponse *srw_res)
515 char *base = "Default";
520 srw_bend_init(assoc);
522 rr.setname = "default";
525 rr.basenames = &srw_req->database;
528 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
529 ext->direct_reference = odr_getoidbystr(assoc->decode,
530 "1.2.840.10003.16.2");
531 ext->indirect_reference = 0;
533 ext->which = Z_External_CQL;
535 ext->u.cql = srw_req->query;
537 ext->u.cql = "noterm";
539 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
540 rr.query->which = Z_Query_type_104;
541 rr.query->u.type_104 = ext;
543 rr.stream = assoc->encode;
544 rr.decode = assoc->decode;
545 rr.print = assoc->print;
547 rr.association = assoc;
553 yaz_log_zquery(rr.query);
554 (assoc->init->bend_search)(assoc->backend, &rr);
555 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
558 srw_res->num_diagnostics = 1;
559 srw_res->diagnostics = (Z_SRW_diagnostic *)
560 odr_malloc(assoc->encode, sizeof(*srw_res->diagnostics));
561 srw_res->diagnostics[0].code =
562 odr_intdup(assoc->encode, rr.errcode);
563 srw_res->diagnostics[0].details = rr.errstring;
567 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
568 if (srw_req->maximumRecords && *srw_req->maximumRecords > 0)
570 int number = *srw_req->maximumRecords;
573 if (srw_req->startRecord)
574 start = *srw_req->startRecord;
575 if (start <= rr.hits)
578 if (start + number > rr.hits)
579 number = rr.hits - start + 1;
580 srw_res->records = (Z_SRW_record *)
581 odr_malloc(assoc->encode,
582 number * sizeof(*srw_res->records));
583 for (i = 0; i<number; i++)
585 srw_res->records[j].recordData_buf = 0;
586 srw_bend_fetch(assoc, i+start, srw_req,
587 srw_res->records + j);
588 if (srw_res->records[j].recordData_buf)
591 srw_res->num_records = j;
593 srw_res->records = 0;
594 yaz_log(LOG_LOG, "got %d records", j);
600 static void process_http_request(association *assoc, request *req)
602 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
603 ODR o = assoc->encode;
605 Z_HTTP_Response *hres = 0;
608 if (!strcmp(hreq->method, "GET"))
611 if (strlen(hreq->path) >= 5 && strlen(hreq->path) < 80 &&
612 !memcmp(hreq->path, "/doc/", 5))
617 strcpy(fpath, DOCDIR);
618 strcat(fpath, hreq->path+4);
619 f = fopen(fpath, "rb");
622 if (fstat(fileno(f), &sbuf) || !S_ISREG(sbuf.st_mode))
631 fseek(f, 0L, SEEK_END);
633 if (sz >= 0 && sz < 500000)
635 const char *ctype = "application/octet-stream";
638 p = z_get_HTTP_Response(o, 200);
639 hres = p->u.HTTP_Response;
640 hres->content_buf = (char *) odr_malloc(o, sz + 1);
641 hres->content_len = sz;
642 fseek(f, 0L, SEEK_SET);
643 fread(hres->content_buf, 1, sz, f);
644 if ((cp = strrchr(fpath, '.'))) {
646 if (!strcmp(cp, "png"))
648 else if (!strcmp(cp, "gif"))
650 else if (!strcmp(cp, "xml"))
652 else if (!strcmp(cp, "html"))
655 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
656 yaz_log(LOG_LOG, "OK send page %s size=%ld", fpath, sz);
662 if (!strcmp(hreq->path, "/"))
665 const char *doclink = "";
666 p = z_get_HTTP_Response(o, 200);
667 hres = p->u.HTTP_Response;
668 hres->content_buf = (char *) odr_malloc(o, 400);
670 if (stat(DOCDIR "/yaz.html", &sbuf) == 0 && S_ISREG(sbuf.st_mode))
671 doclink = "<P><A HREF=\"/doc/yaz.html\">Documentation</A></P>";
673 sprintf (hres->content_buf,
674 "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\n"
677 " <TITLE>YAZ " YAZ_VERSION "</TITLE>\n"
680 " <P><A HREF=\"http://www.indexdata.dk/yaz/\">YAZ</A> "
684 "</HTML>\n", doclink);
685 hres->content_len = strlen(hres->content_buf);
686 z_HTTP_header_add(o, &hres->headers, "Content-Type", "text/html");
690 p = z_get_HTTP_Response(o, 404);
693 else if (!strcmp(hreq->method, "POST"))
696 const char *content_type = z_HTTP_header_lookup(hreq->headers,
698 const char *soap_action = z_HTTP_header_lookup(hreq->headers,
700 if (content_type && soap_action &&
701 !yaz_strcmp_del("text/xml", content_type, "; "))
703 Z_SOAP *soap_package = 0;
707 static Z_SOAP_Handler soap_handlers[2] = {
708 {"http://www.loc.gov/zing/srw/v1.0/", 0,
709 (Z_SOAP_fun) yaz_srw_codec},
713 ret = z_soap_codec(assoc->decode, &soap_package,
714 &hreq->content_buf, &hreq->content_len,
717 if (!ret && soap_package->which == Z_SOAP_generic &&
718 soap_package->u.generic->no == 0)
721 Z_SRW_searchRetrieve *sr = soap_package->u.generic->p;
723 if (sr->which == Z_SRW_searchRetrieve_request)
725 Z_SRW_searchRetrieve *res =
726 yaz_srw_get(assoc->encode,
727 Z_SRW_searchRetrieve_response);
729 if (!sr->u.request->database)
731 const char *p0 = hreq->path, *p1;
734 p1 = strchr(p0, '?');
736 p1 = p0 + strlen(p0);
739 sr->u.request->database =
740 odr_malloc(assoc->decode, p1 - p0 + 1);
741 memcpy (sr->u.request->database, p0, p1 - p0);
742 sr->u.request->database[p1 - p0] = '\0';
745 sr->u.request->database = "Default";
747 srw_bend_search(assoc, req, sr->u.request,
750 soap_package->u.generic->p = res;
755 p = z_get_HTTP_Response(o, 200);
756 hres = p->u.HTTP_Response;
757 ret = z_soap_codec(assoc->encode, &soap_package,
758 &hres->content_buf, &hres->content_len,
760 hres->code = http_code;
761 z_HTTP_header_add(o, &hres->headers, "Content-Type", "text/xml");
764 if (!p) /* still no response ? */
765 p = z_get_HTTP_Response(o, 500);
769 p = z_get_HTTP_Response(o, 405);
770 hres = p->u.HTTP_Response;
772 z_HTTP_header_add(o, &hres->headers, "Allow", "GET, POST");
774 hres = p->u.HTTP_Response;
775 if (!strcmp(hreq->version, "1.0"))
777 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
778 if (v && !strcmp(v, "Keep-Alive"))
782 hres->version = "1.0";
786 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
787 if (v && !strcmp(v, "close"))
791 hres->version = "1.1";
795 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
796 assoc->state = ASSOC_DEAD;
800 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
802 process_gdu_response(assoc, req, p);
805 static void process_gdu_request(association *assoc, request *req)
807 if (req->gdu_request->which == Z_GDU_Z3950)
810 req->apdu_request = req->gdu_request->u.z3950;
811 if (process_z_request(assoc, req, &msg) < 0)
812 do_close_req(assoc, Z_Close_systemProblem, msg, req);
814 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
815 process_http_request(assoc, req);
818 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
823 * Initiate request processing.
825 static int process_z_request(association *assoc, request *req, char **msg)
831 *msg = "Unknown Error";
832 assert(req && req->state == REQUEST_IDLE);
833 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
835 *msg = "Missing InitRequest";
838 switch (req->apdu_request->which)
840 case Z_APDU_initRequest:
841 res = process_initRequest(assoc, req); break;
842 case Z_APDU_searchRequest:
843 res = process_searchRequest(assoc, req, &fd); break;
844 case Z_APDU_presentRequest:
845 res = process_presentRequest(assoc, req, &fd); break;
846 case Z_APDU_scanRequest:
847 if (assoc->init->bend_scan)
848 res = process_scanRequest(assoc, req, &fd);
851 *msg = "Cannot handle Scan APDU";
855 case Z_APDU_extendedServicesRequest:
856 if (assoc->init->bend_esrequest)
857 res = process_ESRequest(assoc, req, &fd);
860 *msg = "Cannot handle Extended Services APDU";
864 case Z_APDU_sortRequest:
865 if (assoc->init->bend_sort)
866 res = process_sortRequest(assoc, req, &fd);
869 *msg = "Cannot handle Sort APDU";
874 process_close(assoc, req);
876 case Z_APDU_deleteResultSetRequest:
877 if (assoc->init->bend_delete)
878 res = process_deleteRequest(assoc, req, &fd);
881 *msg = "Cannot handle Delete APDU";
885 case Z_APDU_segmentRequest:
886 if (assoc->init->bend_segment)
888 res = process_segmentRequest (assoc, req);
892 *msg = "Cannot handle Segment APDU";
897 *msg = "Bad APDU received";
902 yaz_log(LOG_DEBUG, " result immediately available");
903 retval = process_z_response(assoc, req, res);
907 yaz_log(LOG_DEBUG, " result unavailble");
910 else /* no result yet - one will be provided later */
914 /* Set up an I/O handler for the fd supplied by the backend */
916 yaz_log(LOG_DEBUG, " establishing handler for result");
917 req->state = REQUEST_PENDING;
918 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
920 iochan_setdata(chan, assoc);
927 * Handle message from the backend.
929 void backend_response(IOCHAN i, int event)
931 association *assoc = (association *)iochan_getdata(i);
932 request *req = request_head(&assoc->incoming);
936 yaz_log(LOG_DEBUG, "backend_response");
937 assert(assoc && req && req->state != REQUEST_IDLE);
938 /* determine what it is we're waiting for */
939 switch (req->apdu_request->which)
941 case Z_APDU_searchRequest:
942 res = response_searchRequest(assoc, req, 0, &fd); break;
944 case Z_APDU_presentRequest:
945 res = response_presentRequest(assoc, req, 0, &fd); break;
946 case Z_APDU_scanRequest:
947 res = response_scanRequest(assoc, req, 0, &fd); break;
950 yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
953 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
955 yaz_log(LOG_LOG, "Fatal error when talking to backend");
956 do_close(assoc, Z_Close_systemProblem, 0);
960 else if (!res) /* no result yet - try again later */
962 yaz_log(LOG_DEBUG, " no result yet");
963 iochan_setfd(i, fd); /* in case fd has changed */
968 * Encode response, and transfer the request structure to the outgoing queue.
970 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
972 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
974 if (assoc->print && !z_GDU(assoc->print, &res, 0, 0))
976 yaz_log(LOG_WARN, "ODR print error: %s",
977 odr_errmsg(odr_geterror(assoc->print)));
978 odr_reset(assoc->print);
980 if (!z_GDU(assoc->encode, &res, 0, 0))
982 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
983 odr_errmsg(odr_geterror(assoc->decode)));
986 req->response = odr_getbuf(assoc->encode, &req->len_response,
987 &req->size_response);
988 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
989 odr_reset(assoc->encode);
990 req->state = REQUEST_IDLE;
991 request_enq(&assoc->outgoing, req);
992 /* turn the work over to the ir_session handler */
993 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
994 assoc->cs_put_mask = EVENT_OUTPUT;
995 /* Is there more work to be done? give that to the input handler too */
997 if (request_head(&assoc->incoming))
999 yaz_log (LOG_DEBUG, "more work to be done");
1000 iochan_setevent(assoc->client_chan, EVENT_WORK);
1007 * Encode response, and transfer the request structure to the outgoing queue.
1009 static int process_z_response(association *assoc, request *req, Z_APDU *res)
1011 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
1013 if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
1015 yaz_log(LOG_WARN, "ODR print error: %s",
1016 odr_errmsg(odr_geterror(assoc->print)));
1017 odr_reset(assoc->print);
1019 if (!z_APDU(assoc->encode, &res, 0, 0))
1021 yaz_log(LOG_WARN, "ODR error when encoding response: %s",
1022 odr_errmsg(odr_geterror(assoc->decode)));
1025 req->response = odr_getbuf(assoc->encode, &req->len_response,
1026 &req->size_response);
1027 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
1028 odr_reset(assoc->encode);
1029 req->state = REQUEST_IDLE;
1030 request_enq(&assoc->outgoing, req);
1031 /* turn the work over to the ir_session handler */
1032 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
1033 assoc->cs_put_mask = EVENT_OUTPUT;
1034 /* Is there more work to be done? give that to the input handler too */
1036 if (request_head(&assoc->incoming))
1038 yaz_log (LOG_DEBUG, "more work to be done");
1039 iochan_setevent(assoc->client_chan, EVENT_WORK);
1046 * Handle init request.
1047 * At the moment, we don't check the options
1048 * anywhere else in the code - we just try not to do anything that would
1049 * break a naive client. We'll toss 'em into the association block when
1050 * we need them there.
1052 static Z_APDU *process_initRequest(association *assoc, request *reqb)
1054 statserv_options_block *cb = statserv_getcontrol();
1055 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
1056 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
1057 Z_InitResponse *resp = apdu->u.initResponse;
1058 bend_initresult *binitres;
1062 xfree (assoc->init);
1063 assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
1065 yaz_log(LOG_LOG, "Got initRequest");
1066 if (req->implementationId)
1067 yaz_log(LOG_LOG, "Id: %s", req->implementationId);
1068 if (req->implementationName)
1069 yaz_log(LOG_LOG, "Name: %s", req->implementationName);
1070 if (req->implementationVersion)
1071 yaz_log(LOG_LOG, "Version: %s", req->implementationVersion);
1073 assoc->init->stream = assoc->encode;
1074 assoc->init->print = assoc->print;
1075 assoc->init->auth = req->idAuthentication;
1076 assoc->init->referenceId = req->referenceId;
1077 assoc->init->implementation_version = 0;
1078 assoc->init->implementation_id = 0;
1079 assoc->init->implementation_name = 0;
1080 assoc->init->bend_sort = NULL;
1081 assoc->init->bend_search = NULL;
1082 assoc->init->bend_present = NULL;
1083 assoc->init->bend_esrequest = NULL;
1084 assoc->init->bend_delete = NULL;
1085 assoc->init->bend_scan = NULL;
1086 assoc->init->bend_segment = NULL;
1087 assoc->init->bend_fetch = NULL;
1088 assoc->init->charneg_request = NULL;
1089 assoc->init->charneg_response = NULL;
1090 assoc->init->decode = assoc->decode;
1092 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
1094 Z_CharSetandLanguageNegotiation *negotiation =
1095 yaz_get_charneg_record (req->otherInfo);
1096 if (negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
1097 assoc->init->charneg_request = negotiation;
1100 assoc->init->peer_name =
1101 odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
1102 if (!(binitres = (*cb->bend_init)(assoc->init)))
1104 yaz_log(LOG_WARN, "Bad response from backend.");
1108 assoc->backend = binitres->handle;
1109 if ((assoc->init->bend_sort))
1110 yaz_log (LOG_DEBUG, "Sort handler installed");
1111 if ((assoc->init->bend_search))
1112 yaz_log (LOG_DEBUG, "Search handler installed");
1113 if ((assoc->init->bend_present))
1114 yaz_log (LOG_DEBUG, "Present handler installed");
1115 if ((assoc->init->bend_esrequest))
1116 yaz_log (LOG_DEBUG, "ESRequest handler installed");
1117 if ((assoc->init->bend_delete))
1118 yaz_log (LOG_DEBUG, "Delete handler installed");
1119 if ((assoc->init->bend_scan))
1120 yaz_log (LOG_DEBUG, "Scan handler installed");
1121 if ((assoc->init->bend_segment))
1122 yaz_log (LOG_DEBUG, "Segment handler installed");
1124 resp->referenceId = req->referenceId;
1126 /* let's tell the client what we can do */
1127 if (ODR_MASK_GET(req->options, Z_Options_search))
1129 ODR_MASK_SET(resp->options, Z_Options_search);
1130 strcat(options, "srch");
1132 if (ODR_MASK_GET(req->options, Z_Options_present))
1134 ODR_MASK_SET(resp->options, Z_Options_present);
1135 strcat(options, " prst");
1137 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
1138 assoc->init->bend_delete)
1140 ODR_MASK_SET(resp->options, Z_Options_delSet);
1141 strcat(options, " del");
1143 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
1144 assoc->init->bend_esrequest)
1146 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
1147 strcat (options, " extendedServices");
1149 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
1151 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
1152 strcat(options, " namedresults");
1154 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
1156 ODR_MASK_SET(resp->options, Z_Options_scan);
1157 strcat(options, " scan");
1159 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
1161 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
1162 strcat(options, " concurrop");
1164 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
1166 ODR_MASK_SET(resp->options, Z_Options_sort);
1167 strcat(options, " sort");
1170 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
1171 && assoc->init->charneg_response)
1173 Z_OtherInformation **p;
1174 Z_OtherInformationUnit *p0;
1176 yaz_oi_APDU(apdu, &p);
1178 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
1179 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
1181 p0->which = Z_OtherInfo_externallyDefinedInfo;
1182 p0->information.externallyDefinedInfo =
1183 assoc->init->charneg_response;
1185 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
1186 strcat(options, " negotiation");
1189 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
1191 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
1192 assoc->version = 2; /* 1 & 2 are equivalent */
1194 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
1196 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
1199 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
1201 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
1205 yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
1206 assoc->maximumRecordSize = *req->maximumRecordSize;
1207 if (assoc->maximumRecordSize > control_block->maxrecordsize)
1208 assoc->maximumRecordSize = control_block->maxrecordsize;
1209 assoc->preferredMessageSize = *req->preferredMessageSize;
1210 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
1211 assoc->preferredMessageSize = assoc->maximumRecordSize;
1214 assoc->maximumRecordSize = 3000000;
1215 assoc->preferredMessageSize = 3000000;
1218 resp->preferredMessageSize = &assoc->preferredMessageSize;
1219 resp->maximumRecordSize = &assoc->maximumRecordSize;
1221 resp->implementationName = "GFS/YAZ";
1223 if (assoc->init->implementation_id)
1226 odr_malloc (assoc->encode,
1227 strlen(assoc->init->implementation_id) + 10 +
1228 strlen(resp->implementationId));
1229 sprintf (nv, "%s / %s",
1230 resp->implementationId, assoc->init->implementation_id);
1231 resp->implementationId = nv;
1233 if (assoc->init->implementation_name)
1236 odr_malloc (assoc->encode,
1237 strlen(assoc->init->implementation_name) + 10 +
1238 strlen(resp->implementationName));
1239 sprintf (nv, "%s / %s",
1240 resp->implementationName, assoc->init->implementation_name);
1241 resp->implementationName = nv;
1243 if (assoc->init->implementation_version)
1246 odr_malloc (assoc->encode,
1247 strlen(assoc->init->implementation_version) + 10 +
1248 strlen(resp->implementationVersion));
1249 sprintf (nv, "YAZ %s / %s",
1250 resp->implementationVersion,
1251 assoc->init->implementation_version);
1252 resp->implementationVersion = nv;
1255 if (binitres->errcode)
1257 yaz_log(LOG_LOG, "Connection rejected by backend.");
1259 assoc->state = ASSOC_DEAD;
1262 assoc->state = ASSOC_UP;
1267 * These functions should be merged.
1270 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo, ODR odr)
1272 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1273 dr->u.v2Addinfo = odr_strdup (odr, addinfo ? addinfo : "");
1277 * nonsurrogate diagnostic record.
1279 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
1281 Z_Records *rec = (Z_Records *)
1282 odr_malloc (assoc->encode, sizeof(*rec));
1283 int *err = odr_intdup(assoc->encode, error);
1284 Z_DiagRec *drec = (Z_DiagRec *)
1285 odr_malloc (assoc->encode, sizeof(*drec));
1286 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1287 odr_malloc (assoc->encode, sizeof(*dr));
1289 yaz_log(LOG_LOG, "[%d] %s %s%s", error, diagbib1_str(error),
1290 addinfo ? " -- " : "", addinfo ? addinfo : "");
1291 rec->which = Z_Records_NSD;
1292 rec->u.nonSurrogateDiagnostic = dr;
1293 dr->diagnosticSetId =
1294 yaz_oidval_to_z3950oid (assoc->encode, CLASS_DIAGSET, VAL_BIB1);
1295 dr->condition = err;
1296 set_addinfo (dr, addinfo, assoc->encode);
1301 * surrogate diagnostic.
1303 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
1304 int error, char *addinfo)
1306 Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
1307 odr_malloc (assoc->encode, sizeof(*rec));
1308 int *err = odr_intdup(assoc->encode, error);
1309 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1310 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1311 odr_malloc (assoc->encode, sizeof(*dr));
1313 yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
1314 rec->databaseName = dbname;
1315 rec->which = Z_NamePlusRecord_surrogateDiagnostic;
1316 rec->u.surrogateDiagnostic = drec;
1317 drec->which = Z_DiagRec_defaultFormat;
1318 drec->u.defaultFormat = dr;
1319 dr->diagnosticSetId =
1320 yaz_oidval_to_z3950oid (assoc->encode, CLASS_DIAGSET, VAL_BIB1);
1321 dr->condition = err;
1322 set_addinfo (dr, addinfo, assoc->encode);
1328 * multiple nonsurrogate diagnostics.
1330 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
1332 Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
1333 int *err = odr_intdup(assoc->encode, error);
1334 Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
1335 Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
1336 Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)
1337 odr_malloc (assoc->encode, sizeof(*rec));
1339 yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
1341 recs->num_diagRecs = 1;
1342 recs->diagRecs = recp;
1344 drec->which = Z_DiagRec_defaultFormat;
1345 drec->u.defaultFormat = rec;
1347 rec->diagnosticSetId =
1348 yaz_oidval_to_z3950oid (assoc->encode, CLASS_DIAGSET, VAL_BIB1);
1349 rec->condition = err;
1351 rec->which = Z_DefaultDiagFormat_v2Addinfo;
1352 rec->u.v2Addinfo = odr_strdup (assoc->encode, addinfo ? addinfo : "");
1356 static Z_Records *pack_records(association *a, char *setname, int start,
1357 int *num, Z_RecordComposition *comp,
1358 int *next, int *pres, oid_value format,
1359 Z_ReferenceId *referenceId,
1362 int recno, total_length = 0, toget = *num, dumped_records = 0;
1363 Z_Records *records =
1364 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
1365 Z_NamePlusRecordList *reclist =
1366 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
1367 Z_NamePlusRecord **list =
1368 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
1370 records->which = Z_Records_DBOSD;
1371 records->u.databaseOrSurDiagnostics = reclist;
1372 reclist->num_records = 0;
1373 reclist->records = list;
1374 *pres = Z_PRES_SUCCESS;
1378 yaz_log(LOG_LOG, "Request to pack %d+%d+%s", start, toget, setname);
1379 yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
1380 a->maximumRecordSize);
1381 for (recno = start; reclist->num_records < toget; recno++)
1384 Z_NamePlusRecord *thisrec;
1385 int this_length = 0;
1387 * we get the number of bytes allocated on the stream before any
1388 * allocation done by the backend - this should give us a reasonable
1389 * idea of the total size of the data so far.
1391 total_length = odr_total(a->encode) - dumped_records;
1397 freq.last_in_set = 0;
1398 freq.setname = setname;
1399 freq.surrogate_flag = 0;
1400 freq.number = recno;
1402 freq.request_format = format;
1403 freq.request_format_raw = oid;
1404 freq.output_format = format;
1405 freq.output_format_raw = 0;
1406 freq.stream = a->encode;
1407 freq.print = a->print;
1408 freq.surrogate_flag = 0;
1409 freq.referenceId = referenceId;
1410 (*a->init->bend_fetch)(a->backend, &freq);
1411 /* backend should be able to signal whether error is system-wide
1412 or only pertaining to current record */
1415 if (!freq.surrogate_flag)
1418 *pres = Z_PRES_FAILURE;
1419 /* for 'present request out of range',
1420 set addinfo to record position if not set */
1421 if (freq.errcode == 13 && freq.errstring == 0)
1423 sprintf (s, "%d", recno);
1426 return diagrec(a, freq.errcode, freq.errstring);
1428 reclist->records[reclist->num_records] =
1429 surrogatediagrec(a, freq.basename, freq.errcode,
1431 reclist->num_records++;
1432 *next = freq.last_in_set ? 0 : recno + 1;
1436 this_length = freq.len;
1438 this_length = odr_total(a->encode) - total_length;
1439 yaz_log(LOG_DEBUG, " fetched record, len=%d, total=%d",
1440 this_length, total_length);
1441 if (this_length + total_length > a->preferredMessageSize)
1443 /* record is small enough, really */
1444 if (this_length <= a->preferredMessageSize)
1446 yaz_log(LOG_DEBUG, " Dropped last normal-sized record");
1447 *pres = Z_PRES_PARTIAL_2;
1450 /* record can only be fetched by itself */
1451 if (this_length < a->maximumRecordSize)
1453 yaz_log(LOG_DEBUG, " Record > prefmsgsz");
1456 yaz_log(LOG_DEBUG, " Dropped it");
1457 reclist->records[reclist->num_records] =
1458 surrogatediagrec(a, freq.basename, 16, 0);
1459 reclist->num_records++;
1460 *next = freq.last_in_set ? 0 : recno + 1;
1461 dumped_records += this_length;
1465 else /* too big entirely */
1467 yaz_log(LOG_LOG, "Record > maxrcdsz this=%d max=%d", this_length, a->maximumRecordSize);
1468 reclist->records[reclist->num_records] =
1469 surrogatediagrec(a, freq.basename, 17, 0);
1470 reclist->num_records++;
1471 *next = freq.last_in_set ? 0 : recno + 1;
1472 dumped_records += this_length;
1477 if (!(thisrec = (Z_NamePlusRecord *)
1478 odr_malloc(a->encode, sizeof(*thisrec))))
1480 if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
1481 strlen(freq.basename) + 1)))
1483 strcpy(thisrec->databaseName, freq.basename);
1484 thisrec->which = Z_NamePlusRecord_databaseRecord;
1486 if (freq.output_format_raw)
1488 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
1489 freq.output_format = ident->value;
1491 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
1492 freq.record, freq.len);
1493 if (!thisrec->u.databaseRecord)
1495 reclist->records[reclist->num_records] = thisrec;
1496 reclist->num_records++;
1497 *next = freq.last_in_set ? 0 : recno + 1;
1499 *num = reclist->num_records;
1503 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
1506 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
1507 bend_search_rr *bsrr =
1508 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
1510 yaz_log(LOG_LOG, "Got SearchRequest.");
1512 bsrr->request = reqb;
1513 bsrr->association = assoc;
1514 bsrr->referenceId = req->referenceId;
1515 save_referenceId (reqb, bsrr->referenceId);
1517 yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
1518 if (req->databaseNames)
1521 for (i = 0; i < req->num_databaseNames; i++)
1522 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1524 yaz_log_zquery(req->query);
1526 if (assoc->init->bend_search)
1528 bsrr->setname = req->resultSetName;
1529 bsrr->replace_set = *req->replaceIndicator;
1530 bsrr->num_bases = req->num_databaseNames;
1531 bsrr->basenames = req->databaseNames;
1532 bsrr->query = req->query;
1533 bsrr->stream = assoc->encode;
1534 bsrr->decode = assoc->decode;
1535 bsrr->print = assoc->print;
1538 bsrr->errstring = NULL;
1539 bsrr->search_info = NULL;
1540 (assoc->init->bend_search)(assoc->backend, bsrr);
1544 return response_searchRequest(assoc, reqb, bsrr, fd);
1547 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1550 * Prepare a searchresponse based on the backend results. We probably want
1551 * to look at making the fetching of records nonblocking as well, but
1552 * so far, we'll keep things simple.
1553 * If bsrt is null, that means we're called in response to a communications
1554 * event, and we'll have to get the response for ourselves.
1556 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1557 bend_search_rr *bsrt, int *fd)
1559 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
1560 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1561 Z_SearchResponse *resp = (Z_SearchResponse *)
1562 odr_malloc (assoc->encode, sizeof(*resp));
1563 int *nulint = odr_intdup (assoc->encode, 0);
1564 bool_t *sr = odr_intdup(assoc->encode, 1);
1565 int *next = odr_intdup(assoc->encode, 0);
1566 int *none = odr_intdup(assoc->encode, Z_RES_NONE);
1568 apdu->which = Z_APDU_searchResponse;
1569 apdu->u.searchResponse = resp;
1570 resp->referenceId = req->referenceId;
1571 resp->additionalSearchInfo = 0;
1572 resp->otherInfo = 0;
1574 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1576 yaz_log(LOG_FATAL, "Bad result from backend");
1579 else if (bsrt->errcode)
1581 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1582 resp->resultCount = nulint;
1583 resp->numberOfRecordsReturned = nulint;
1584 resp->nextResultSetPosition = nulint;
1585 resp->searchStatus = nulint;
1586 resp->resultSetStatus = none;
1587 resp->presentStatus = 0;
1591 int *toget = odr_intdup(assoc->encode, 0);
1592 int *presst = odr_intdup(assoc->encode, 0);
1593 Z_RecordComposition comp, *compp = 0;
1595 yaz_log (LOG_LOG, "resultCount: %d", bsrt->hits);
1598 resp->resultCount = &bsrt->hits;
1600 comp.which = Z_RecordComp_simple;
1601 /* how many records does the user agent want, then? */
1602 if (bsrt->hits <= *req->smallSetUpperBound)
1604 *toget = bsrt->hits;
1605 if ((comp.u.simple = req->smallSetElementSetNames))
1608 else if (bsrt->hits < *req->largeSetLowerBound)
1610 *toget = *req->mediumSetPresentNumber;
1611 if (*toget > bsrt->hits)
1612 *toget = bsrt->hits;
1613 if ((comp.u.simple = req->mediumSetElementSetNames))
1619 if (*toget && !resp->records)
1624 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
1627 form = prefformat->value;
1628 resp->records = pack_records(assoc, req->resultSetName, 1,
1629 toget, compp, next, presst, form, req->referenceId,
1630 req->preferredRecordSyntax);
1633 resp->numberOfRecordsReturned = toget;
1634 resp->nextResultSetPosition = next;
1635 resp->searchStatus = sr;
1636 resp->resultSetStatus = 0;
1637 resp->presentStatus = presst;
1641 if (*resp->resultCount)
1643 resp->numberOfRecordsReturned = nulint;
1644 resp->nextResultSetPosition = next;
1645 resp->searchStatus = sr;
1646 resp->resultSetStatus = 0;
1647 resp->presentStatus = 0;
1650 resp->additionalSearchInfo = bsrt->search_info;
1655 * Maybe we got a little over-friendly when we designed bend_fetch to
1656 * get only one record at a time. Some backends can optimise multiple-record
1657 * fetches, and at any rate, there is some overhead involved in
1658 * all that selecting and hopping around. Problem is, of course, that the
1659 * frontend can't know ahead of time how many records it'll need to
1660 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1661 * is downright lousy as a bulk data transfer protocol.
1663 * To start with, we'll do the fetching of records from the backend
1664 * in one operation: To save some trips in and out of the event-handler,
1665 * and to simplify the interface to pack_records. At any rate, asynch
1666 * operation is more fun in operations that have an unpredictable execution
1667 * speed - which is normally more true for search than for present.
1669 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1672 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
1676 Z_PresentResponse *resp;
1680 yaz_log(LOG_LOG, "Got PresentRequest.");
1682 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
1685 form = prefformat->value;
1686 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1688 resp->presentStatus = odr_intdup(assoc->encode, 0);
1689 if (assoc->init->bend_present)
1691 bend_present_rr *bprr = (bend_present_rr *)
1692 nmem_malloc (reqb->request_mem, sizeof(*bprr));
1693 bprr->setname = req->resultSetId;
1694 bprr->start = *req->resultSetStartPoint;
1695 bprr->number = *req->numberOfRecordsRequested;
1696 bprr->format = form;
1697 bprr->comp = req->recordComposition;
1698 bprr->referenceId = req->referenceId;
1699 bprr->stream = assoc->encode;
1700 bprr->print = assoc->print;
1701 bprr->request = reqb;
1702 bprr->association = assoc;
1704 bprr->errstring = NULL;
1705 (*assoc->init->bend_present)(assoc->backend, bprr);
1711 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
1712 *resp->presentStatus = Z_PRES_FAILURE;
1715 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1716 next = odr_intdup(assoc->encode, 0);
1717 num = odr_intdup(assoc->encode, 0);
1719 apdu->which = Z_APDU_presentResponse;
1720 apdu->u.presentResponse = resp;
1721 resp->referenceId = req->referenceId;
1722 resp->otherInfo = 0;
1726 *num = *req->numberOfRecordsRequested;
1728 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1729 num, req->recordComposition, next, resp->presentStatus,
1730 form, req->referenceId, req->preferredRecordSyntax);
1734 resp->numberOfRecordsReturned = num;
1735 resp->nextResultSetPosition = next;
1741 * Scan was implemented rather in a hurry, and with support for only the basic
1742 * elements of the service in the backend API. Suggestions are welcome.
1744 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1746 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
1747 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1748 Z_ScanResponse *res = (Z_ScanResponse *)
1749 odr_malloc (assoc->encode, sizeof(*res));
1750 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
1751 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
1752 Z_ListEntries *ents = (Z_ListEntries *)
1753 odr_malloc (assoc->encode, sizeof(*ents));
1754 Z_DiagRecs *diagrecs_p = NULL;
1756 bend_scan_rr *bsrr = (bend_scan_rr *)
1757 odr_malloc (assoc->encode, sizeof(*bsrr));
1759 yaz_log(LOG_LOG, "Got ScanRequest");
1761 apdu->which = Z_APDU_scanResponse;
1762 apdu->u.scanResponse = res;
1763 res->referenceId = req->referenceId;
1765 /* if step is absent, set it to 0 */
1766 res->stepSize = odr_intdup(assoc->encode, 0);
1768 *res->stepSize = *req->stepSize;
1770 res->scanStatus = scanStatus;
1771 res->numberOfEntriesReturned = numberOfEntriesReturned;
1772 res->positionOfTerm = 0;
1773 res->entries = ents;
1774 ents->num_entries = 0;
1775 ents->entries = NULL;
1776 ents->num_nonsurrogateDiagnostics = 0;
1777 ents->nonsurrogateDiagnostics = NULL;
1778 res->attributeSet = 0;
1781 if (req->databaseNames)
1784 for (i = 0; i < req->num_databaseNames; i++)
1785 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1787 bsrr->num_bases = req->num_databaseNames;
1788 bsrr->basenames = req->databaseNames;
1789 bsrr->num_entries = *req->numberOfTermsRequested;
1790 bsrr->term = req->termListAndStartPoint;
1791 bsrr->referenceId = req->referenceId;
1792 bsrr->stream = assoc->encode;
1793 bsrr->print = assoc->print;
1794 bsrr->step_size = res->stepSize;
1795 if (req->attributeSet &&
1796 (attset = oid_getentbyoid(req->attributeSet)) &&
1797 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
1798 bsrr->attributeset = attset->value;
1800 bsrr->attributeset = VAL_NONE;
1801 log_scan_term (req->termListAndStartPoint, bsrr->attributeset);
1802 bsrr->term_position = req->preferredPositionInResponse ?
1803 *req->preferredPositionInResponse : 1;
1804 ((int (*)(void *, bend_scan_rr *))
1805 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1807 diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1811 Z_Entry **tab = (Z_Entry **)
1812 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1814 if (bsrr->status == BEND_SCAN_PARTIAL)
1815 *scanStatus = Z_Scan_partial_5;
1817 *scanStatus = Z_Scan_success;
1818 ents->entries = tab;
1819 ents->num_entries = bsrr->num_entries;
1820 res->numberOfEntriesReturned = &ents->num_entries;
1821 res->positionOfTerm = &bsrr->term_position;
1822 for (i = 0; i < bsrr->num_entries; i++)
1828 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1829 if (bsrr->entries[i].occurrences >= 0)
1831 e->which = Z_Entry_termInfo;
1832 e->u.termInfo = t = (Z_TermInfo *)
1833 odr_malloc(assoc->encode, sizeof(*t));
1834 t->suggestedAttributes = 0;
1836 t->alternativeTerm = 0;
1837 t->byAttributes = 0;
1838 t->otherTermInfo = 0;
1839 t->globalOccurrences = &bsrr->entries[i].occurrences;
1840 t->term = (Z_Term *)
1841 odr_malloc(assoc->encode, sizeof(*t->term));
1842 t->term->which = Z_Term_general;
1843 t->term->u.general = o =
1844 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1845 o->buf = (unsigned char *)
1846 odr_malloc(assoc->encode, o->len = o->size =
1847 strlen(bsrr->entries[i].term));
1848 memcpy(o->buf, bsrr->entries[i].term, o->len);
1849 yaz_log(LOG_DEBUG, " term #%d: '%s' (%d)", i,
1850 bsrr->entries[i].term, bsrr->entries[i].occurrences);
1854 Z_DiagRecs *drecs = diagrecs (assoc,
1855 bsrr->entries[i].errcode,
1856 bsrr->entries[i].errstring);
1857 assert (drecs->num_diagRecs == 1);
1858 e->which = Z_Entry_surrogateDiagnostic;
1859 assert (drecs->diagRecs[0]);
1860 e->u.surrogateDiagnostic = drecs->diagRecs[0];
1866 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1867 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1872 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1875 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
1876 Z_SortResponse *res = (Z_SortResponse *)
1877 odr_malloc (assoc->encode, sizeof(*res));
1878 bend_sort_rr *bsrr = (bend_sort_rr *)
1879 odr_malloc (assoc->encode, sizeof(*bsrr));
1881 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1883 yaz_log(LOG_LOG, "Got SortRequest.");
1885 bsrr->num_input_setnames = req->num_inputResultSetNames;
1886 bsrr->input_setnames = req->inputResultSetNames;
1887 bsrr->referenceId = req->referenceId;
1888 bsrr->output_setname = req->sortedResultSetName;
1889 bsrr->sort_sequence = req->sortSequence;
1890 bsrr->stream = assoc->encode;
1891 bsrr->print = assoc->print;
1893 bsrr->sort_status = Z_SortStatus_failure;
1895 bsrr->errstring = 0;
1897 (*assoc->init->bend_sort)(assoc->backend, bsrr);
1899 res->referenceId = bsrr->referenceId;
1900 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
1901 res->resultSetStatus = 0;
1904 Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1905 res->diagnostics = dr->diagRecs;
1906 res->num_diagnostics = dr->num_diagRecs;
1910 res->num_diagnostics = 0;
1911 res->diagnostics = 0;
1915 apdu->which = Z_APDU_sortResponse;
1916 apdu->u.sortResponse = res;
1920 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1923 Z_DeleteResultSetRequest *req =
1924 reqb->apdu_request->u.deleteResultSetRequest;
1925 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1926 odr_malloc (assoc->encode, sizeof(*res));
1927 bend_delete_rr *bdrr = (bend_delete_rr *)
1928 odr_malloc (assoc->encode, sizeof(*bdrr));
1929 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1931 yaz_log(LOG_LOG, "Got DeleteRequest.");
1933 bdrr->num_setnames = req->num_resultSetList;
1934 bdrr->setnames = req->resultSetList;
1935 bdrr->stream = assoc->encode;
1936 bdrr->print = assoc->print;
1937 bdrr->function = *req->deleteFunction;
1938 bdrr->referenceId = req->referenceId;
1940 if (bdrr->num_setnames > 0)
1943 bdrr->statuses = (int*)
1944 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1945 bdrr->num_setnames);
1946 for (i = 0; i < bdrr->num_setnames; i++)
1947 bdrr->statuses[i] = 0;
1949 (*assoc->init->bend_delete)(assoc->backend, bdrr);
1951 res->referenceId = req->referenceId;
1953 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
1955 res->deleteListStatuses = 0;
1956 if (bdrr->num_setnames > 0)
1959 res->deleteListStatuses = (Z_ListStatuses *)
1960 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
1961 res->deleteListStatuses->num = bdrr->num_setnames;
1962 res->deleteListStatuses->elements =
1964 odr_malloc (assoc->encode,
1965 sizeof(*res->deleteListStatuses->elements) *
1966 bdrr->num_setnames);
1967 for (i = 0; i<bdrr->num_setnames; i++)
1969 res->deleteListStatuses->elements[i] =
1971 odr_malloc (assoc->encode,
1972 sizeof(**res->deleteListStatuses->elements));
1973 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1974 res->deleteListStatuses->elements[i]->id =
1975 odr_strdup (assoc->encode, bdrr->setnames[i]);
1979 res->numberNotDeleted = 0;
1980 res->bulkStatuses = 0;
1981 res->deleteMessage = 0;
1984 apdu->which = Z_APDU_deleteResultSetResponse;
1985 apdu->u.deleteResultSetResponse = res;
1989 static void process_close(association *assoc, request *reqb)
1991 Z_Close *req = reqb->apdu_request->u.close;
1992 static char *reasons[] =
1999 "securityViolation",
2006 yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
2007 reasons[*req->closeReason], req->diagnosticInformation ?
2008 req->diagnosticInformation : "NULL");
2009 if (assoc->version < 3) /* to make do_force respond with close */
2011 do_close_req(assoc, Z_Close_finished,
2012 "Association terminated by client", reqb);
2015 void save_referenceId (request *reqb, Z_ReferenceId *refid)
2019 reqb->len_refid = refid->len;
2020 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
2021 memcpy (reqb->refid, refid->buf, refid->len);
2025 reqb->len_refid = 0;
2030 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
2032 process_z_response (a, req, res);
2035 bend_request bend_request_mk (bend_association a)
2037 request *nreq = request_get (&a->outgoing);
2038 nreq->request_mem = nmem_create ();
2042 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
2047 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
2048 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
2049 id->len = id->size = req->len_refid;
2050 memcpy (id->buf, req->refid, req->len_refid);
2054 void bend_request_destroy (bend_request *req)
2056 nmem_destroy((*req)->request_mem);
2057 request_release(*req);
2061 int bend_backend_respond (bend_association a, bend_request req)
2065 r = process_z_request (a, req, &msg);
2067 yaz_log (LOG_WARN, "%s", msg);
2071 void bend_request_setdata(bend_request r, void *p)
2076 void *bend_request_getdata(bend_request r)
2078 return r->clientData;
2081 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
2083 bend_segment_rr req;
2085 req.segment = reqb->apdu_request->u.segmentRequest;
2086 req.stream = assoc->encode;
2087 req.decode = assoc->decode;
2088 req.print = assoc->print;
2089 req.association = assoc;
2091 (*assoc->init->bend_segment)(assoc->backend, &req);
2096 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
2098 bend_esrequest_rr esrequest;
2100 Z_ExtendedServicesRequest *req =
2101 reqb->apdu_request->u.extendedServicesRequest;
2102 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
2104 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
2106 yaz_log(LOG_DEBUG,"inside Process esRequest");
2108 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
2109 esrequest.stream = assoc->encode;
2110 esrequest.decode = assoc->decode;
2111 esrequest.print = assoc->print;
2112 esrequest.errcode = 0;
2113 esrequest.errstring = NULL;
2114 esrequest.request = reqb;
2115 esrequest.association = assoc;
2116 esrequest.taskPackage = 0;
2117 esrequest.referenceId = req->referenceId;
2119 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
2121 /* If the response is being delayed, return NULL */
2122 if (esrequest.request == NULL)
2125 resp->referenceId = req->referenceId;
2127 if (esrequest.errcode == -1)
2129 /* Backend service indicates request will be processed */
2130 yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
2131 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
2133 else if (esrequest.errcode == 0)
2135 /* Backend service indicates request will be processed */
2136 yaz_log(LOG_DEBUG,"Request could be processed...Done !");
2137 *resp->operationStatus = Z_ExtendedServicesResponse_done;
2141 Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
2142 esrequest.errstring);
2144 /* Backend indicates error, request will not be processed */
2145 yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
2146 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
2147 resp->num_diagnostics = diagRecs->num_diagRecs;
2148 resp->diagnostics = diagRecs->diagRecs;
2150 /* Do something with the members of bend_extendedservice */
2151 if (esrequest.taskPackage)
2152 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
2153 (const char *) esrequest.taskPackage,
2155 yaz_log(LOG_DEBUG,"Send the result apdu");