2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.122 2007-06-05 06:52:23 adam Exp $
9 * \brief Implements GFS session logic.
11 * Frontend server logic.
13 * This code receives incoming APDUs, and handles client requests by means
16 * Some of the code is getting quite involved, compared to simpler servers -
17 * primarily because it is asynchronous both in the communication with
18 * the user and the backend. We think the complexity will pay off in
19 * the form of greater flexibility when more asynchronous facilities
22 * Memory management has become somewhat involved. In the simple case, where
23 * only one PDU is pending at a time, it will simply reuse the same memory,
24 * once it has found its working size. When we enable multiple concurrent
25 * operations, perhaps even with multiple parallel calls to the backend, it
26 * will maintain a pool of buffers for encoding and decoding, trying to
27 * minimize memory allocation/deallocation during normal operation.
37 #include <sys/types.h>
45 #define S_ISREG(x) (x & _S_IFREG)
54 #include <libxml/parser.h>
55 #include <libxml/tree.h>
58 #include <yaz/yconfig.h>
59 #include <yaz/xmalloc.h>
60 #include <yaz/comstack.h>
64 #include <yaz/proto.h>
65 #include <yaz/oid_db.h>
67 #include <yaz/logrpn.h>
68 #include <yaz/querytowrbuf.h>
69 #include <yaz/statserv.h>
70 #include <yaz/diagbib1.h>
71 #include <yaz/charneg.h>
72 #include <yaz/otherinfo.h>
73 #include <yaz/yaz-util.h>
74 #include <yaz/pquery.h>
75 #include <yaz/oid_db.h>
78 #include <yaz/backend.h>
80 static void process_gdu_request(association *assoc, request *req);
81 static int process_z_request(association *assoc, request *req, char **msg);
82 void backend_response(IOCHAN i, int event);
83 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
84 static int process_z_response(association *assoc, request *req, Z_APDU *res);
85 static Z_APDU *process_initRequest(association *assoc, request *reqb);
86 static Z_External *init_diagnostics(ODR odr, int errcode,
87 const char *errstring);
88 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
90 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
91 bend_search_rr *bsrr, int *fd);
92 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
94 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
95 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
96 static void process_close(association *assoc, request *reqb);
97 void save_referenceId (request *reqb, Z_ReferenceId *refid);
98 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
100 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
102 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
104 /* dynamic logging levels */
105 static int logbits_set = 0;
106 static int log_session = 0; /* one-line logs for session */
107 static int log_sessiondetail = 0; /* more detailed stuff */
108 static int log_request = 0; /* one-line logs for requests */
109 static int log_requestdetail = 0; /* more detailed stuff */
111 /** get_logbits sets global loglevel bits */
112 static void get_logbits(void)
113 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
117 log_session = yaz_log_module_level("session");
118 log_sessiondetail = yaz_log_module_level("sessiondetail");
119 log_request = yaz_log_module_level("request");
120 log_requestdetail = yaz_log_module_level("requestdetail");
126 static void wr_diag(WRBUF w, int error, const char *addinfo)
128 wrbuf_printf(w, "ERROR %d+", error);
129 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
132 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
140 * Create and initialize a new association-handle.
141 * channel : iochannel for the current line.
142 * link : communications channel.
143 * Returns: 0 or a new association handle.
145 association *create_association(IOCHAN channel, COMSTACK link,
146 const char *apdufile)
152 if (!(anew = (association *)xmalloc(sizeof(*anew))))
156 anew->last_control = 0;
157 anew->client_chan = channel;
158 anew->client_link = link;
159 anew->cs_get_mask = 0;
160 anew->cs_put_mask = 0;
161 anew->cs_accept_mask = 0;
162 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
163 !(anew->encode = odr_createmem(ODR_ENCODE)))
165 if (apdufile && *apdufile)
169 if (!(anew->print = odr_createmem(ODR_PRINT)))
171 if (*apdufile == '@')
173 odr_setprint(anew->print, yaz_log_file());
175 else if (*apdufile != '-')
178 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
179 if (!(f = fopen(filename, "w")))
181 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
184 setvbuf(f, 0, _IONBF, 0);
185 odr_setprint(anew->print, f);
190 anew->input_buffer = 0;
191 anew->input_buffer_len = 0;
193 anew->state = ASSOC_NEW;
194 request_initq(&anew->incoming);
195 request_initq(&anew->outgoing);
196 anew->proto = cs_getproto(link);
202 * Free association and release resources.
204 void destroy_association(association *h)
206 statserv_options_block *cb = statserv_getcontrol();
210 odr_destroy(h->decode);
211 odr_destroy(h->encode);
213 odr_destroy(h->print);
215 xfree(h->input_buffer);
217 (*cb->bend_close)(h->backend);
218 while ((req = request_deq(&h->incoming)))
219 request_release(req);
220 while ((req = request_deq(&h->outgoing)))
221 request_release(req);
222 request_delq(&h->incoming);
223 request_delq(&h->outgoing);
225 xmalloc_trav("session closed");
226 if (cb && cb->one_shot)
232 static void do_close_req(association *a, int reason, char *message,
236 Z_Close *cls = zget_Close(a->encode);
238 /* Purge request queue */
239 while (request_deq(&a->incoming));
240 while (request_deq(&a->outgoing));
243 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
244 reason, message ? message : "none");
245 apdu.which = Z_APDU_close;
247 *cls->closeReason = reason;
248 cls->diagnosticInformation = message;
249 process_z_response(a, req, &apdu);
250 iochan_settimeout(a->client_chan, 20);
254 request_release(req);
255 yaz_log(log_requestdetail, "v2 client. No Close PDU");
256 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
259 a->state = ASSOC_DEAD;
262 static void do_close(association *a, int reason, char *message)
264 request *req = request_get(&a->outgoing);
265 do_close_req (a, reason, message, req);
269 int ir_read(IOCHAN h, int event)
271 association *assoc = (association *)iochan_getdata(h);
272 COMSTACK conn = assoc->client_link;
275 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
277 yaz_log(YLOG_DEBUG, "ir_session (input)");
278 /* We aren't speaking to this fellow */
279 if (assoc->state == ASSOC_DEAD)
281 yaz_log(log_sessiondetail, "Connection closed - end of session");
283 destroy_association(assoc);
287 assoc->cs_get_mask = EVENT_INPUT;
291 int res = cs_get(conn, &assoc->input_buffer,
292 &assoc->input_buffer_len);
293 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
295 yaz_log(log_session, "Connection error: %s res=%d",
296 cs_errmsg(cs_errno(conn)), res);
297 req = request_get(&assoc->incoming); /* get a new request */
298 do_close_req(assoc, Z_Close_protocolError,
299 "Incoming package too large", req);
304 yaz_log(log_session, "Connection closed by client");
305 assoc->state = ASSOC_DEAD;
308 else if (res == 1) /* incomplete read - wait for more */
310 if (conn->io_pending & CS_WANT_WRITE)
311 assoc->cs_get_mask |= EVENT_OUTPUT;
312 iochan_setflag(h, assoc->cs_get_mask);
315 /* we got a complete PDU. Let's decode it */
316 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
317 assoc->input_buffer[0] & 0xff,
318 assoc->input_buffer[1] & 0xff,
319 assoc->input_buffer[2] & 0xff);
320 req = request_get(&assoc->incoming); /* get a new request */
321 odr_reset(assoc->decode);
322 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
323 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
325 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
327 odr_errmsg(odr_geterror(assoc->decode)),
328 odr_getelement(assoc->decode),
329 (long) odr_offset(assoc->decode));
330 if (assoc->decode->error != OHTTP)
332 yaz_log(YLOG_WARN, "PDU dump:");
333 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
334 request_release(req);
335 do_close(assoc, Z_Close_protocolError, "Malformed package");
339 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
340 assoc->state = ASSOC_DEAD;
341 process_gdu_response(assoc, req, p);
345 req->request_mem = odr_extract_mem(assoc->decode);
348 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
349 yaz_log(YLOG_WARN, "ODR print error: %s",
350 odr_errmsg(odr_geterror(assoc->print)));
351 odr_reset(assoc->print);
353 request_enq(&assoc->incoming, req);
355 while (cs_more(conn));
361 * This is where PDUs from the client are read and the further
362 * processing is initiated. Flow of control moves down through the
363 * various process_* functions below, until the encoded result comes back up
364 * to the output handler in here.
366 * h : the I/O channel that has an outstanding event.
367 * event : the current outstanding event.
369 void ir_session(IOCHAN h, int event)
372 association *assoc = (association *)iochan_getdata(h);
373 COMSTACK conn = assoc->client_link;
376 assert(h && conn && assoc);
377 if (event == EVENT_TIMEOUT)
379 if (assoc->state != ASSOC_UP)
381 yaz_log(YLOG_DEBUG, "Final timeout - closing connection.");
382 /* do we need to lod this at all */
384 destroy_association(assoc);
389 yaz_log(log_sessiondetail,
390 "Session idle too long. Sending close.");
391 do_close(assoc, Z_Close_lackOfActivity, 0);
395 if (event & assoc->cs_accept_mask)
397 if (!cs_accept (conn))
399 yaz_log (YLOG_WARN, "accept failed");
400 destroy_association(assoc);
403 iochan_clearflag (h, EVENT_OUTPUT);
404 if (conn->io_pending)
405 { /* cs_accept didn't complete */
406 assoc->cs_accept_mask =
407 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
408 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
410 iochan_setflag (h, assoc->cs_accept_mask);
413 { /* cs_accept completed. Prepare for reading (cs_get) */
414 assoc->cs_accept_mask = 0;
415 assoc->cs_get_mask = EVENT_INPUT;
416 iochan_setflag (h, assoc->cs_get_mask);
420 if (event & assoc->cs_get_mask) /* input */
422 if (!ir_read(h, event))
424 req = request_head(&assoc->incoming);
425 if (req->state == REQUEST_IDLE)
427 request_deq(&assoc->incoming);
428 process_gdu_request(assoc, req);
431 if (event & assoc->cs_put_mask)
433 request *req = request_head(&assoc->outgoing);
435 assoc->cs_put_mask = 0;
436 yaz_log(YLOG_DEBUG, "ir_session (output)");
437 req->state = REQUEST_PENDING;
438 switch (res = cs_put(conn, req->response, req->len_response))
441 yaz_log(log_sessiondetail, "Connection closed by client");
443 destroy_association(assoc);
446 case 0: /* all sent - release the request structure */
447 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
449 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
452 nmem_destroy(req->request_mem);
453 request_deq(&assoc->outgoing);
454 request_release(req);
455 if (!request_head(&assoc->outgoing))
456 { /* restore mask for cs_get operation ... */
457 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
458 iochan_setflag(h, assoc->cs_get_mask);
459 if (assoc->state == ASSOC_DEAD)
460 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
464 assoc->cs_put_mask = EVENT_OUTPUT;
468 if (conn->io_pending & CS_WANT_WRITE)
469 assoc->cs_put_mask |= EVENT_OUTPUT;
470 if (conn->io_pending & CS_WANT_READ)
471 assoc->cs_put_mask |= EVENT_INPUT;
472 iochan_setflag(h, assoc->cs_put_mask);
475 if (event & EVENT_EXCEPT)
477 yaz_log(YLOG_WARN, "ir_session (exception)");
479 destroy_association(assoc);
484 static int process_z_request(association *assoc, request *req, char **msg);
487 static void assoc_init_reset(association *assoc)
490 assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
492 assoc->init->stream = assoc->encode;
493 assoc->init->print = assoc->print;
494 assoc->init->auth = 0;
495 assoc->init->referenceId = 0;
496 assoc->init->implementation_version = 0;
497 assoc->init->implementation_id = 0;
498 assoc->init->implementation_name = 0;
499 assoc->init->query_charset = 0;
500 assoc->init->records_in_same_charset = 0;
501 assoc->init->bend_sort = NULL;
502 assoc->init->bend_search = NULL;
503 assoc->init->bend_present = NULL;
504 assoc->init->bend_esrequest = NULL;
505 assoc->init->bend_delete = NULL;
506 assoc->init->bend_scan = NULL;
507 assoc->init->bend_segment = NULL;
508 assoc->init->bend_fetch = NULL;
509 assoc->init->bend_explain = NULL;
510 assoc->init->bend_srw_scan = NULL;
511 assoc->init->bend_srw_update = NULL;
513 assoc->init->charneg_request = NULL;
514 assoc->init->charneg_response = NULL;
516 assoc->init->decode = assoc->decode;
517 assoc->init->peer_name =
518 odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
520 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
523 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
525 statserv_options_block *cb = statserv_getcontrol();
528 const char *encoding = "UTF-8";
530 bend_initresult *binitres;
532 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
533 assoc_init_reset(assoc);
537 Z_IdAuthentication *auth = (Z_IdAuthentication *)
538 odr_malloc(assoc->decode, sizeof(*auth));
541 len = strlen(sr->username) + 1;
543 len += strlen(sr->password) + 2;
544 auth->which = Z_IdAuthentication_open;
545 auth->u.open = (char *) odr_malloc(assoc->decode, len);
546 strcpy(auth->u.open, sr->username);
547 if (sr->password && *sr->password)
549 strcat(auth->u.open, "/");
550 strcat(auth->u.open, sr->password);
552 assoc->init->auth = auth;
556 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
557 assoc->init->charneg_request = ce->u.charNeg3;
560 if (!(binitres = (*cb->bend_init)(assoc->init)))
562 assoc->state = ASSOC_DEAD;
563 yaz_add_srw_diagnostic(assoc->encode, d, num,
564 YAZ_SRW_AUTHENTICATION_ERROR, 0);
567 assoc->backend = binitres->handle;
568 assoc->init->auth = 0;
569 if (binitres->errcode)
571 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
572 assoc->state = ASSOC_DEAD;
573 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
574 binitres->errstring);
582 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
585 yaz_record_conv_t rc = 0;
586 const char *match_schema = 0;
587 Odr_oid *match_syntax = 0;
592 const char *input_schema = yaz_get_esn(rr->comp);
593 Odr_oid *input_syntax_raw = rr->request_format;
595 const char *backend_schema = 0;
596 Odr_oid *backend_syntax = 0;
598 r = yaz_retrieval_request(assoc->server->retrieval,
606 if (r == -1) /* error ? */
608 const char *details = yaz_retrieval_get_error(
609 assoc->server->retrieval);
611 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
613 rr->errstring = odr_strdup(rr->stream, details);
616 else if (r == 1 || r == 3)
618 const char *details = input_schema;
620 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
622 rr->errstring = odr_strdup(rr->stream, details);
627 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
628 if (input_syntax_raw)
630 char oidbuf[OID_STR_MAX];
631 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
632 rr->errstring = odr_strdup(rr->stream, oidbuf);
638 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
641 rr->request_format = backend_syntax;
643 (*assoc->init->bend_fetch)(assoc->backend, rr);
644 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
645 { /* post conversion must take place .. */
646 WRBUF output_record = wrbuf_alloc();
647 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
650 const char *details = yaz_record_conv_get_error(rc);
651 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
653 rr->errstring = odr_strdup(rr->stream, details);
657 rr->len = wrbuf_len(output_record);
658 rr->record = (char *) odr_malloc(rr->stream, rr->len);
659 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
661 wrbuf_destroy(output_record);
664 rr->output_format = match_syntax;
666 rr->schema = odr_strdup(rr->stream, match_schema);
669 (*assoc->init->bend_fetch)(assoc->backend, rr);
674 static int srw_bend_fetch(association *assoc, int pos,
675 Z_SRW_searchRetrieveRequest *srw_req,
676 Z_SRW_record *record,
677 const char **addinfo)
680 ODR o = assoc->encode;
682 rr.setname = "default";
685 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
687 rr.comp = (Z_RecordComposition *)
688 odr_malloc(assoc->decode, sizeof(*rr.comp));
689 rr.comp->which = Z_RecordComp_complex;
690 rr.comp->u.complex = (Z_CompSpec *)
691 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
692 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
693 odr_malloc(assoc->encode, sizeof(bool_t));
694 *rr.comp->u.complex->selectAlternativeSyntax = 0;
695 rr.comp->u.complex->num_dbSpecific = 0;
696 rr.comp->u.complex->dbSpecific = 0;
697 rr.comp->u.complex->num_recordSyntax = 0;
698 rr.comp->u.complex->recordSyntax = 0;
700 rr.comp->u.complex->generic = (Z_Specification *)
701 odr_malloc(assoc->decode, sizeof(Z_Specification));
703 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
704 rr.comp->u.complex->generic->which = Z_Schema_uri;
705 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
707 /* ESN = recordSchema if recordSchema is present */
708 rr.comp->u.complex->generic->elementSpec = 0;
709 if (srw_req->recordSchema)
711 rr.comp->u.complex->generic->elementSpec =
712 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
713 rr.comp->u.complex->generic->elementSpec->which =
714 Z_ElementSpec_elementSetName;
715 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
716 srw_req->recordSchema;
719 rr.stream = assoc->encode;
720 rr.print = assoc->print;
728 rr.surrogate_flag = 0;
729 rr.schema = srw_req->recordSchema;
731 if (!assoc->init->bend_fetch)
734 retrieve_fetch(assoc, &rr);
736 if (rr.errcode && rr.surrogate_flag)
738 int code = yaz_diag_bib1_to_srw(rr.errcode);
739 const char *message = yaz_diag_srw_str(code);
742 len += strlen(message);
744 len += strlen(rr.errstring);
746 record->recordData_buf = (char *) odr_malloc(o, len);
748 sprintf(record->recordData_buf, "<diagnostic "
749 "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
750 " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
752 sprintf(record->recordData_buf + strlen(record->recordData_buf),
753 " <details>%s</details>\n", rr.errstring);
755 sprintf(record->recordData_buf + strlen(record->recordData_buf),
756 " <message>%s</message>\n", message);
757 sprintf(record->recordData_buf + strlen(record->recordData_buf),
759 record->recordData_len = strlen(record->recordData_buf);
760 record->recordPosition = odr_intdup(o, pos);
761 record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
764 else if (rr.len >= 0)
766 record->recordData_buf = rr.record;
767 record->recordData_len = rr.len;
768 record->recordPosition = odr_intdup(o, pos);
770 record->recordSchema = odr_strdup(o, rr.schema);
772 record->recordSchema = 0;
776 *addinfo = rr.errstring;
782 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
783 Z_Query *query_result)
785 /* have a CQL query and CQL to PQF transform .. */
786 CQL_parser cp = cql_parser_create();
792 r = cql_parser_string(cp, cql);
795 /* CQL syntax error */
801 r = cql_transform_buf(ct,
802 cql_parser_result(cp),
803 rpn_buf, sizeof(rpn_buf)-1);
805 srw_errcode = cql_transform_error(ct, &add);
809 /* Syntax & transform OK. */
810 /* Convert PQF string to Z39.50 to RPN query struct */
811 YAZ_PQF_Parser pp = yaz_pqf_create();
812 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
817 int code = yaz_pqf_error(pp, &pqf_msg, &off);
818 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
824 query_result->which = Z_Query_type_1;
825 query_result->u.type_1 = rpnquery;
829 cql_parser_destroy(cp);
833 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
834 Z_AttributesPlusTerm *result)
838 int srw_error = cql2pqf(odr, cql, ct, &query);
841 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
842 return 10; /* bad query type */
843 rpn = query.u.type_1;
844 if (!rpn->RPNStructure)
845 return 10; /* must be structure */
846 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
847 return 10; /* must be simple */
848 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
849 return 10; /* must be attributes plus term node .. */
850 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
855 static void srw_bend_search(association *assoc, request *req,
857 Z_SRW_searchRetrieveResponse *srw_res,
862 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
865 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
866 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
867 if (srw_res->num_diagnostics == 0 && assoc->init)
870 rr.setname = "default";
873 rr.basenames = &srw_req->database;
877 rr.srw_setnameIdleTime = 0;
878 rr.estimated_hit_count = 0;
879 rr.partial_resultset = 0;
880 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
881 rr.query->u.type_1 = 0;
883 if (srw_req->query_type == Z_SRW_query_type_cql)
885 if (assoc->server && assoc->server->cql_transform)
887 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
888 assoc->server->cql_transform,
892 yaz_add_srw_diagnostic(assoc->encode,
893 &srw_res->diagnostics,
894 &srw_res->num_diagnostics,
900 /* CQL query to backend. Wrap it - Z39.50 style */
901 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
902 ext->direct_reference = odr_getoidbystr(assoc->decode,
903 "1.2.840.10003.16.2");
904 ext->indirect_reference = 0;
906 ext->which = Z_External_CQL;
907 ext->u.cql = srw_req->query.cql;
909 rr.query->which = Z_Query_type_104;
910 rr.query->u.type_104 = ext;
913 else if (srw_req->query_type == Z_SRW_query_type_pqf)
915 Z_RPNQuery *RPNquery;
916 YAZ_PQF_Parser pqf_parser;
918 pqf_parser = yaz_pqf_create ();
920 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
926 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
927 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
928 code, pqf_msg, (long) off);
929 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
932 rr.query->which = Z_Query_type_1;
933 rr.query->u.type_1 = RPNquery;
935 yaz_pqf_destroy (pqf_parser);
939 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
940 &srw_res->num_diagnostics,
941 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
943 if (rr.query->u.type_1)
945 rr.stream = assoc->encode;
946 rr.decode = assoc->decode;
947 rr.print = assoc->print;
949 if ( srw_req->sort.sortKeys )
950 rr.srw_sortKeys = odr_strdup(assoc->encode,
951 srw_req->sort.sortKeys );
952 rr.association = assoc;
958 yaz_log_zquery_level(log_requestdetail,rr.query);
960 (assoc->init->bend_search)(assoc->backend, &rr);
963 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
969 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
970 yaz_add_srw_diagnostic(assoc->encode,
971 &srw_res->diagnostics,
972 &srw_res->num_diagnostics,
973 srw_error, rr.errstring);
978 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
979 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
981 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
982 start, number, rr.hits);
984 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
987 srw_res->resultSetId =
988 odr_strdup(assoc->encode, rr.srw_setname );
989 srw_res->resultSetIdleTime =
990 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
993 if ((rr.hits > 0 && start > rr.hits) || start < 1)
995 yaz_add_srw_diagnostic(
997 &srw_res->diagnostics, &srw_res->num_diagnostics,
998 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1000 else if (number > 0)
1004 if (start + number > rr.hits)
1005 number = rr.hits - start + 1;
1007 /* Call bend_present if defined */
1008 if (assoc->init->bend_present)
1010 bend_present_rr *bprr = (bend_present_rr*)
1011 odr_malloc (assoc->decode, sizeof(*bprr));
1012 bprr->setname = "default";
1013 bprr->start = start;
1014 bprr->number = number;
1015 if (srw_req->recordSchema)
1017 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1018 sizeof(*bprr->comp));
1019 bprr->comp->which = Z_RecordComp_simple;
1020 bprr->comp->u.simple = (Z_ElementSetNames *)
1021 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1022 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1023 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1029 bprr->stream = assoc->encode;
1030 bprr->referenceId = 0;
1031 bprr->print = assoc->print;
1032 bprr->request = req;
1033 bprr->association = assoc;
1035 bprr->errstring = NULL;
1036 (*assoc->init->bend_present)(assoc->backend, bprr);
1042 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1043 yaz_add_srw_diagnostic(assoc->encode,
1044 &srw_res->diagnostics,
1045 &srw_res->num_diagnostics,
1046 srw_error, bprr->errstring);
1054 int packing = Z_SRW_recordPacking_string;
1055 if (srw_req->recordPacking)
1058 yaz_srw_str_to_pack(srw_req->recordPacking);
1060 packing = Z_SRW_recordPacking_string;
1062 srw_res->records = (Z_SRW_record *)
1063 odr_malloc(assoc->encode,
1064 number * sizeof(*srw_res->records));
1066 srw_res->extra_records = (Z_SRW_extra_record **)
1067 odr_malloc(assoc->encode,
1068 number*sizeof(*srw_res->extra_records));
1070 for (i = 0; i<number; i++)
1073 const char *addinfo = 0;
1075 srw_res->records[j].recordPacking = packing;
1076 srw_res->records[j].recordData_buf = 0;
1077 srw_res->extra_records[j] = 0;
1078 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1079 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1080 srw_res->records + j,
1084 yaz_add_srw_diagnostic(assoc->encode,
1085 &srw_res->diagnostics,
1086 &srw_res->num_diagnostics,
1087 yaz_diag_bib1_to_srw (errcode),
1092 if (srw_res->records[j].recordData_buf)
1095 srw_res->num_records = j;
1097 srw_res->records = 0;
1100 if (rr.estimated_hit_count || rr.partial_resultset)
1102 yaz_add_srw_diagnostic(
1104 &srw_res->diagnostics,
1105 &srw_res->num_diagnostics,
1106 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1114 const char *querystr = "?";
1115 const char *querytype = "?";
1116 WRBUF wr = wrbuf_alloc();
1118 switch (srw_req->query_type)
1120 case Z_SRW_query_type_cql:
1122 querystr = srw_req->query.cql;
1124 case Z_SRW_query_type_pqf:
1126 querystr = srw_req->query.pqf;
1129 wrbuf_printf(wr, "SRWSearch ");
1130 wrbuf_printf(wr, srw_req->database);
1131 wrbuf_printf(wr, " ");
1132 if (srw_res->num_diagnostics)
1133 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1134 else if (*http_code != 200)
1135 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1136 else if (srw_res->numberOfRecords)
1138 wrbuf_printf(wr, "OK %d",
1139 (srw_res->numberOfRecords ?
1140 *srw_res->numberOfRecords : 0));
1142 wrbuf_printf(wr, " %s %d+%d",
1143 (srw_res->resultSetId ?
1144 srw_res->resultSetId : "-"),
1145 (srw_req->startRecord ? *srw_req->startRecord : 1),
1146 srw_res->num_records);
1147 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1152 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1155 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1158 for (ptr = ptr->children; ptr; ptr = ptr->next)
1160 if (ptr->type != XML_ELEMENT_NODE)
1162 if (!strcmp((const char *) ptr->name, "explain"))
1165 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1169 ptr = xmlCopyNode(ptr, 1);
1171 xmlDocSetRootElement(doc, ptr);
1173 xmlDocDumpMemory(doc, &buf_out, &len);
1174 content = (char*) odr_malloc(rr->stream, 1+len);
1175 memcpy(content, buf_out, len);
1176 content[len] = '\0';
1180 rr->explain_buf = content;
1188 static void srw_bend_explain(association *assoc, request *req,
1190 Z_SRW_explainResponse *srw_res,
1193 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1194 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1196 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1201 rr.stream = assoc->encode;
1202 rr.decode = assoc->decode;
1203 rr.print = assoc->print;
1205 rr.database = srw_req->database;
1207 rr.server_node_ptr = assoc->server->server_node_ptr;
1209 rr.server_node_ptr = 0;
1210 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1211 if (assoc->init->bend_explain)
1212 (*assoc->init->bend_explain)(assoc->backend, &rr);
1214 srw_bend_explain_default(assoc->backend, &rr);
1218 int packing = Z_SRW_recordPacking_string;
1219 if (srw_req->recordPacking)
1222 yaz_srw_str_to_pack(srw_req->recordPacking);
1224 packing = Z_SRW_recordPacking_string;
1226 srw_res->record.recordSchema = rr.schema;
1227 srw_res->record.recordPacking = packing;
1228 srw_res->record.recordData_buf = rr.explain_buf;
1229 srw_res->record.recordData_len = strlen(rr.explain_buf);
1230 srw_res->record.recordPosition = 0;
1236 static void srw_bend_scan(association *assoc, request *req,
1238 Z_SRW_scanResponse *srw_res,
1241 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1242 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1245 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1246 if (srw_res->num_diagnostics == 0 && assoc->init)
1248 struct scan_entry *save_entries;
1250 bend_scan_rr *bsrr = (bend_scan_rr *)
1251 odr_malloc (assoc->encode, sizeof(*bsrr));
1252 bsrr->num_bases = 1;
1253 bsrr->basenames = &srw_req->database;
1255 bsrr->num_entries = srw_req->maximumTerms ?
1256 *srw_req->maximumTerms : 10;
1257 bsrr->term_position = srw_req->responsePosition ?
1258 *srw_req->responsePosition : 1;
1261 bsrr->errstring = 0;
1262 bsrr->referenceId = 0;
1263 bsrr->stream = assoc->encode;
1264 bsrr->print = assoc->print;
1265 bsrr->step_size = odr_intdup(assoc->decode, 0);
1269 if (bsrr->num_entries > 0)
1272 bsrr->entries = (struct scan_entry *)
1273 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1275 for (i = 0; i<bsrr->num_entries; i++)
1277 bsrr->entries[i].term = 0;
1278 bsrr->entries[i].occurrences = 0;
1279 bsrr->entries[i].errcode = 0;
1280 bsrr->entries[i].errstring = 0;
1281 bsrr->entries[i].display_term = 0;
1284 save_entries = bsrr->entries; /* save it so we can compare later */
1286 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1287 assoc->init->bend_scan)
1289 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1291 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1292 &bsrr->attributeset,
1293 srw_req->scanClause.pqf);
1294 yaz_pqf_destroy(pqf_parser);
1295 bsrr->scanClause = 0;
1296 ((int (*)(void *, bend_scan_rr *))
1297 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1299 else if (srw_req->query_type == Z_SRW_query_type_cql
1300 && assoc->init->bend_scan && assoc->server
1301 && assoc->server->cql_transform)
1304 bsrr->scanClause = 0;
1305 bsrr->attributeset = 0;
1306 bsrr->term = (Z_AttributesPlusTerm *)
1307 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1308 srw_error = cql2pqf_scan(assoc->encode,
1309 srw_req->scanClause.cql,
1310 assoc->server->cql_transform,
1313 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1314 &srw_res->num_diagnostics,
1318 ((int (*)(void *, bend_scan_rr *))
1319 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1322 else if (srw_req->query_type == Z_SRW_query_type_cql
1323 && assoc->init->bend_srw_scan)
1326 bsrr->attributeset = 0;
1327 bsrr->scanClause = srw_req->scanClause.cql;
1328 ((int (*)(void *, bend_scan_rr *))
1329 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1333 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1334 &srw_res->num_diagnostics,
1335 YAZ_SRW_UNSUPP_OPERATION, "scan");
1340 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1345 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1347 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1348 &srw_res->num_diagnostics,
1349 srw_error, bsrr->errstring);
1351 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1354 srw_res->terms = (Z_SRW_scanTerm*)
1355 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1358 srw_res->num_terms = bsrr->num_entries;
1359 for (i = 0; i<bsrr->num_entries; i++)
1361 Z_SRW_scanTerm *t = srw_res->terms + i;
1362 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1363 t->numberOfRecords =
1364 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1366 if (save_entries == bsrr->entries &&
1367 bsrr->entries[i].display_term)
1369 /* the entries was _not_ set by the handler. So it's
1370 safe to test for new member display_term. It is
1373 t->displayTerm = odr_strdup(assoc->encode,
1374 bsrr->entries[i].display_term);
1382 WRBUF wr = wrbuf_alloc();
1383 const char *querytype = 0;
1384 const char *querystr = 0;
1386 switch(srw_req->query_type)
1388 case Z_SRW_query_type_pqf:
1390 querystr = srw_req->scanClause.pqf;
1392 case Z_SRW_query_type_cql:
1394 querystr = srw_req->scanClause.cql;
1397 querytype = "UNKNOWN";
1401 wrbuf_printf(wr, "SRWScan ");
1402 wrbuf_printf(wr, srw_req->database);
1403 wrbuf_printf(wr, " ");
1405 if (srw_res->num_diagnostics)
1406 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1407 else if (srw_res->num_terms)
1408 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1410 wrbuf_printf(wr, "OK - - ");
1412 wrbuf_printf(wr, "%d+%d+0 ",
1413 (srw_req->responsePosition ?
1414 *srw_req->responsePosition : 1),
1415 (srw_req->maximumTerms ?
1416 *srw_req->maximumTerms : 1));
1417 /* there is no step size in SRU/W ??? */
1418 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1419 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1425 static void srw_bend_update(association *assoc, request *req,
1427 Z_SRW_updateResponse *srw_res,
1430 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1431 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1432 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1434 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1438 Z_SRW_extra_record *extra = srw_req->extra_record;
1440 rr.stream = assoc->encode;
1441 rr.print = assoc->print;
1443 rr.basenames = &srw_req->database;
1444 rr.operation = srw_req->operation;
1445 rr.operation_status = "failed";
1447 rr.record_versions = 0;
1448 rr.num_versions = 0;
1449 rr.record_packing = "string";
1450 rr.record_schema = 0;
1452 rr.extra_record_data = 0;
1453 rr.extra_request_data = 0;
1454 rr.extra_response_data = 0;
1460 if (rr.operation == 0)
1462 yaz_add_sru_update_diagnostic(
1463 assoc->encode, &srw_res->diagnostics,
1464 &srw_res->num_diagnostics,
1465 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1469 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1470 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1471 if (!strcmp( rr.operation, "delete"))
1473 if (srw_req->record && !srw_req->record->recordSchema)
1475 rr.record_schema = odr_strdup(
1477 srw_req->record->recordSchema);
1479 if (srw_req->record)
1481 rr.record_data = odr_strdupn(
1483 srw_req->record->recordData_buf,
1484 srw_req->record->recordData_len );
1486 if (extra && extra->extraRecordData_len)
1488 rr.extra_record_data = odr_strdupn(
1490 extra->extraRecordData_buf,
1491 extra->extraRecordData_len );
1493 if (srw_req->recordId)
1494 rr.record_id = srw_req->recordId;
1495 else if (extra && extra->recordIdentifier)
1496 rr.record_id = extra->recordIdentifier;
1498 else if (!strcmp(rr.operation, "replace"))
1500 if (srw_req->recordId)
1501 rr.record_id = srw_req->recordId;
1502 else if (extra && extra->recordIdentifier)
1503 rr.record_id = extra->recordIdentifier;
1506 yaz_add_sru_update_diagnostic(
1507 assoc->encode, &srw_res->diagnostics,
1508 &srw_res->num_diagnostics,
1509 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1510 "recordIdentifier");
1512 if (!srw_req->record)
1514 yaz_add_sru_update_diagnostic(
1515 assoc->encode, &srw_res->diagnostics,
1516 &srw_res->num_diagnostics,
1517 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1522 if (srw_req->record->recordSchema)
1523 rr.record_schema = odr_strdup(
1524 assoc->encode, srw_req->record->recordSchema);
1525 if (srw_req->record->recordData_len )
1527 rr.record_data = odr_strdupn(assoc->encode,
1528 srw_req->record->recordData_buf,
1529 srw_req->record->recordData_len );
1533 yaz_add_sru_update_diagnostic(
1534 assoc->encode, &srw_res->diagnostics,
1535 &srw_res->num_diagnostics,
1536 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1540 if (extra && extra->extraRecordData_len)
1542 rr.extra_record_data = odr_strdupn(
1544 extra->extraRecordData_buf,
1545 extra->extraRecordData_len );
1548 else if (!strcmp(rr.operation, "insert"))
1550 if (srw_req->recordId)
1551 rr.record_id = srw_req->recordId;
1553 rr.record_id = extra->recordIdentifier;
1555 if (srw_req->record)
1557 if (srw_req->record->recordSchema)
1558 rr.record_schema = odr_strdup(
1559 assoc->encode, srw_req->record->recordSchema);
1561 if (srw_req->record->recordData_len)
1562 rr.record_data = odr_strdupn(
1564 srw_req->record->recordData_buf,
1565 srw_req->record->recordData_len );
1567 if (extra && extra->extraRecordData_len)
1569 rr.extra_record_data = odr_strdupn(
1571 extra->extraRecordData_buf,
1572 extra->extraRecordData_len );
1576 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1577 &srw_res->num_diagnostics,
1578 YAZ_SRU_UPDATE_INVALID_ACTION,
1581 if (srw_req->record)
1583 const char *pack_str =
1584 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1586 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1589 if (srw_req->num_recordVersions)
1591 rr.record_versions = srw_req->recordVersions;
1592 rr.num_versions = srw_req->num_recordVersions;
1594 if (srw_req->extraRequestData_len)
1596 rr.extra_request_data = odr_strdupn(assoc->encode,
1597 srw_req->extraRequestData_buf,
1598 srw_req->extraRequestData_len );
1600 if (srw_res->num_diagnostics == 0)
1602 if ( assoc->init->bend_srw_update)
1603 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1605 yaz_add_sru_update_diagnostic(
1606 assoc->encode, &srw_res->diagnostics,
1607 &srw_res->num_diagnostics,
1608 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1609 "No Update backend handler");
1613 yaz_add_srw_diagnostic_uri(assoc->encode,
1614 &srw_res->diagnostics,
1615 &srw_res->num_diagnostics,
1619 srw_res->recordId = rr.record_id;
1620 srw_res->operationStatus = rr.operation_status;
1621 srw_res->recordVersions = rr.record_versions;
1622 srw_res->num_recordVersions = rr.num_versions;
1623 if (srw_res->extraResponseData_len)
1625 srw_res->extraResponseData_buf = rr.extra_response_data;
1626 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1628 if (srw_res->num_diagnostics == 0 && rr.record_data)
1630 srw_res->record = yaz_srw_get_record(assoc->encode);
1631 srw_res->record->recordSchema = rr.record_schema;
1632 if (rr.record_packing)
1634 int pack = yaz_srw_str_to_pack(rr.record_packing);
1638 pack = Z_SRW_recordPacking_string;
1639 yaz_log(YLOG_WARN, "Back packing %s from backend",
1642 srw_res->record->recordPacking = pack;
1644 srw_res->record->recordData_buf = rr.record_data;
1645 srw_res->record->recordData_len = strlen(rr.record_data);
1646 if (rr.extra_record_data)
1648 Z_SRW_extra_record *ex =
1649 yaz_srw_get_extra_record(assoc->encode);
1650 srw_res->extra_record = ex;
1651 ex->extraRecordData_buf = rr.extra_record_data;
1652 ex->extraRecordData_len = strlen(rr.extra_record_data);
1658 /* check if path is OK (1); BAD (0) */
1659 static int check_path(const char *path)
1663 if (strstr(path, ".."))
1668 static char *read_file(const char *fname, ODR o, int *sz)
1671 FILE *inf = fopen(fname, "rb");
1675 fseek(inf, 0L, SEEK_END);
1678 buf = (char *) odr_malloc(o, *sz);
1679 fread(buf, 1, *sz, inf);
1684 static void process_http_request(association *assoc, request *req)
1686 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1687 ODR o = assoc->encode;
1688 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1690 Z_SOAP *soap_package = 0;
1693 Z_HTTP_Response *hres = 0;
1695 const char *stylesheet = 0; /* for now .. set later */
1696 Z_SRW_diagnostic *diagnostic = 0;
1697 int num_diagnostic = 0;
1698 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1700 if (!control_association(assoc, host, 0))
1702 p = z_get_HTTP_Response(o, 404);
1705 if (r == 2 && assoc->server && assoc->server->docpath
1706 && hreq->path[0] == '/'
1708 /* check if path is a proper prefix of documentroot */
1709 strncmp(hreq->path+1, assoc->server->docpath,
1710 strlen(assoc->server->docpath))
1713 if (!check_path(hreq->path))
1715 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1716 p = z_get_HTTP_Response(o, 404);
1720 int content_size = 0;
1721 char *content_buf = read_file(hreq->path+1, o, &content_size);
1724 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1725 p = z_get_HTTP_Response(o, 404);
1729 const char *ctype = 0;
1730 yaz_mime_types types = yaz_mime_types_create();
1732 yaz_mime_types_add(types, "xsl", "application/xml");
1733 yaz_mime_types_add(types, "xml", "application/xml");
1734 yaz_mime_types_add(types, "css", "text/css");
1735 yaz_mime_types_add(types, "html", "text/html");
1736 yaz_mime_types_add(types, "htm", "text/html");
1737 yaz_mime_types_add(types, "txt", "text/plain");
1738 yaz_mime_types_add(types, "js", "application/x-javascript");
1740 yaz_mime_types_add(types, "gif", "image/gif");
1741 yaz_mime_types_add(types, "png", "image/png");
1742 yaz_mime_types_add(types, "jpg", "image/jpeg");
1743 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1745 ctype = yaz_mime_lookup_fname(types, hreq->path);
1748 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1749 p = z_get_HTTP_Response(o, 404);
1753 p = z_get_HTTP_Response(o, 200);
1754 hres = p->u.HTTP_Response;
1755 hres->content_buf = content_buf;
1756 hres->content_len = content_size;
1757 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1759 yaz_mime_types_destroy(types);
1767 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1768 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1770 if (r == 2) /* not taken */
1772 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1773 &diagnostic, &num_diagnostic);
1774 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1776 if (r == 0) /* decode SRW/SRU OK .. */
1778 int http_code = 200;
1779 if (sr->which == Z_SRW_searchRetrieve_request)
1782 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1784 stylesheet = sr->u.request->stylesheet;
1787 res->u.response->diagnostics = diagnostic;
1788 res->u.response->num_diagnostics = num_diagnostic;
1792 srw_bend_search(assoc, req, sr, res->u.response,
1795 if (http_code == 200)
1796 soap_package->u.generic->p = res;
1798 else if (sr->which == Z_SRW_explain_request)
1800 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1801 stylesheet = sr->u.explain_request->stylesheet;
1804 res->u.explain_response->diagnostics = diagnostic;
1805 res->u.explain_response->num_diagnostics = num_diagnostic;
1807 srw_bend_explain(assoc, req, sr,
1808 res->u.explain_response, &http_code);
1809 if (http_code == 200)
1810 soap_package->u.generic->p = res;
1812 else if (sr->which == Z_SRW_scan_request)
1814 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1815 stylesheet = sr->u.scan_request->stylesheet;
1818 res->u.scan_response->diagnostics = diagnostic;
1819 res->u.scan_response->num_diagnostics = num_diagnostic;
1821 srw_bend_scan(assoc, req, sr,
1822 res->u.scan_response, &http_code);
1823 if (http_code == 200)
1824 soap_package->u.generic->p = res;
1826 else if (sr->which == Z_SRW_update_request)
1828 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1829 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1832 res->u.update_response->diagnostics = diagnostic;
1833 res->u.update_response->num_diagnostics = num_diagnostic;
1835 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1836 srw_bend_update(assoc, req, sr,
1837 res->u.update_response, &http_code);
1838 if (http_code == 200)
1839 soap_package->u.generic->p = res;
1843 yaz_log(log_request, "SOAP ERROR");
1844 /* FIXME - what error, what query */
1846 z_soap_error(assoc->encode, soap_package,
1847 "SOAP-ENV:Client", "Bad method", 0);
1849 if (http_code == 200 || http_code == 500)
1851 static Z_SOAP_Handler soap_handlers[4] = {
1853 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1854 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1855 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1861 p = z_get_HTTP_Response(o, 200);
1862 hres = p->u.HTTP_Response;
1864 if (!stylesheet && assoc->server)
1865 stylesheet = assoc->server->stylesheet;
1867 /* empty stylesheet means NO stylesheet */
1868 if (stylesheet && *stylesheet == '\0')
1871 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1872 &hres->content_buf, &hres->content_len,
1873 soap_handlers, charset, stylesheet);
1874 hres->code = http_code;
1876 strcpy(ctype, "text/xml");
1877 if (charset && strlen(charset) < sizeof(ctype)-30)
1879 strcat(ctype, "; charset=");
1880 strcat(ctype, charset);
1882 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1885 p = z_get_HTTP_Response(o, http_code);
1889 p = z_get_HTTP_Response(o, 500);
1890 hres = p->u.HTTP_Response;
1891 if (!strcmp(hreq->version, "1.0"))
1893 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1894 if (v && !strcmp(v, "Keep-Alive"))
1898 hres->version = "1.0";
1902 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1903 if (v && !strcmp(v, "close"))
1907 hres->version = "1.1";
1911 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1912 assoc->state = ASSOC_DEAD;
1913 assoc->cs_get_mask = 0;
1918 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1920 if (alive && isdigit(*(const unsigned char *) alive))
1924 if (t < 0 || t > 3600)
1926 iochan_settimeout(assoc->client_chan,t);
1927 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1929 process_gdu_response(assoc, req, p);
1932 static void process_gdu_request(association *assoc, request *req)
1934 if (req->gdu_request->which == Z_GDU_Z3950)
1937 req->apdu_request = req->gdu_request->u.z3950;
1938 if (process_z_request(assoc, req, &msg) < 0)
1939 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1941 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1942 process_http_request(assoc, req);
1945 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1950 * Initiate request processing.
1952 static int process_z_request(association *assoc, request *req, char **msg)
1958 *msg = "Unknown Error";
1959 assert(req && req->state == REQUEST_IDLE);
1960 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1962 *msg = "Missing InitRequest";
1965 switch (req->apdu_request->which)
1967 case Z_APDU_initRequest:
1968 res = process_initRequest(assoc, req); break;
1969 case Z_APDU_searchRequest:
1970 res = process_searchRequest(assoc, req, &fd); break;
1971 case Z_APDU_presentRequest:
1972 res = process_presentRequest(assoc, req, &fd); break;
1973 case Z_APDU_scanRequest:
1974 if (assoc->init->bend_scan)
1975 res = process_scanRequest(assoc, req, &fd);
1978 *msg = "Cannot handle Scan APDU";
1982 case Z_APDU_extendedServicesRequest:
1983 if (assoc->init->bend_esrequest)
1984 res = process_ESRequest(assoc, req, &fd);
1987 *msg = "Cannot handle Extended Services APDU";
1991 case Z_APDU_sortRequest:
1992 if (assoc->init->bend_sort)
1993 res = process_sortRequest(assoc, req, &fd);
1996 *msg = "Cannot handle Sort APDU";
2001 process_close(assoc, req);
2003 case Z_APDU_deleteResultSetRequest:
2004 if (assoc->init->bend_delete)
2005 res = process_deleteRequest(assoc, req, &fd);
2008 *msg = "Cannot handle Delete APDU";
2012 case Z_APDU_segmentRequest:
2013 if (assoc->init->bend_segment)
2015 res = process_segmentRequest (assoc, req);
2019 *msg = "Cannot handle Segment APDU";
2023 case Z_APDU_triggerResourceControlRequest:
2026 *msg = "Bad APDU received";
2031 yaz_log(YLOG_DEBUG, " result immediately available");
2032 retval = process_z_response(assoc, req, res);
2036 yaz_log(YLOG_DEBUG, " result unavailble");
2039 else /* no result yet - one will be provided later */
2043 /* Set up an I/O handler for the fd supplied by the backend */
2045 yaz_log(YLOG_DEBUG, " establishing handler for result");
2046 req->state = REQUEST_PENDING;
2047 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2049 iochan_setdata(chan, assoc);
2056 * Handle message from the backend.
2058 void backend_response(IOCHAN i, int event)
2060 association *assoc = (association *)iochan_getdata(i);
2061 request *req = request_head(&assoc->incoming);
2065 yaz_log(YLOG_DEBUG, "backend_response");
2066 assert(assoc && req && req->state != REQUEST_IDLE);
2067 /* determine what it is we're waiting for */
2068 switch (req->apdu_request->which)
2070 case Z_APDU_searchRequest:
2071 res = response_searchRequest(assoc, req, 0, &fd); break;
2073 case Z_APDU_presentRequest:
2074 res = response_presentRequest(assoc, req, 0, &fd); break;
2075 case Z_APDU_scanRequest:
2076 res = response_scanRequest(assoc, req, 0, &fd); break;
2079 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2082 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2084 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2085 do_close(assoc, Z_Close_systemProblem, 0);
2089 else if (!res) /* no result yet - try again later */
2091 yaz_log(YLOG_DEBUG, " no result yet");
2092 iochan_setfd(i, fd); /* in case fd has changed */
2097 * Encode response, and transfer the request structure to the outgoing queue.
2099 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2101 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2105 if (!z_GDU(assoc->print, &res, 0, 0))
2106 yaz_log(YLOG_WARN, "ODR print error: %s",
2107 odr_errmsg(odr_geterror(assoc->print)));
2108 odr_reset(assoc->print);
2110 if (!z_GDU(assoc->encode, &res, 0, 0))
2112 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2113 odr_errmsg(odr_geterror(assoc->decode)),
2114 odr_getelement(assoc->decode));
2117 req->response = odr_getbuf(assoc->encode, &req->len_response,
2118 &req->size_response);
2119 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2120 odr_reset(assoc->encode);
2121 req->state = REQUEST_IDLE;
2122 request_enq(&assoc->outgoing, req);
2123 /* turn the work over to the ir_session handler */
2124 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2125 assoc->cs_put_mask = EVENT_OUTPUT;
2126 /* Is there more work to be done? give that to the input handler too */
2129 req = request_head(&assoc->incoming);
2130 if (req && req->state == REQUEST_IDLE)
2132 request_deq(&assoc->incoming);
2133 process_gdu_request(assoc, req);
2142 * Encode response, and transfer the request structure to the outgoing queue.
2144 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2146 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2147 gres->which = Z_GDU_Z3950;
2148 gres->u.z3950 = res;
2150 return process_gdu_response(assoc, req, gres);
2153 static char *get_vhost(Z_OtherInformation *otherInfo)
2155 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2159 * Handle init request.
2160 * At the moment, we don't check the options
2161 * anywhere else in the code - we just try not to do anything that would
2162 * break a naive client. We'll toss 'em into the association block when
2163 * we need them there.
2165 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2167 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2168 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2169 Z_InitResponse *resp = apdu->u.initResponse;
2170 bend_initresult *binitres;
2173 statserv_options_block *cb = 0; /* by default no control for backend */
2175 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2176 cb = statserv_getcontrol(); /* got control block for backend */
2178 if (cb && assoc->backend)
2179 (*cb->bend_close)(assoc->backend);
2181 yaz_log(log_requestdetail, "Got initRequest");
2182 if (req->implementationId)
2183 yaz_log(log_requestdetail, "Id: %s",
2184 req->implementationId);
2185 if (req->implementationName)
2186 yaz_log(log_requestdetail, "Name: %s",
2187 req->implementationName);
2188 if (req->implementationVersion)
2189 yaz_log(log_requestdetail, "Version: %s",
2190 req->implementationVersion);
2192 assoc_init_reset(assoc);
2194 assoc->init->auth = req->idAuthentication;
2195 assoc->init->referenceId = req->referenceId;
2197 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2199 Z_CharSetandLanguageNegotiation *negotiation =
2200 yaz_get_charneg_record (req->otherInfo);
2202 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2203 assoc->init->charneg_request = negotiation;
2209 if (req->implementationVersion)
2210 yaz_log(log_requestdetail, "Config: %s",
2213 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2215 /* we have a backend control block, so call that init function */
2216 if (!(binitres = (*cb->bend_init)(assoc->init)))
2218 yaz_log(YLOG_WARN, "Bad response from backend.");
2221 assoc->backend = binitres->handle;
2225 /* no backend. return error */
2226 binitres = (bend_initresult *)
2227 odr_malloc(assoc->encode, sizeof(*binitres));
2228 binitres->errstring = 0;
2229 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2230 iochan_settimeout(assoc->client_chan, 10);
2232 if ((assoc->init->bend_sort))
2233 yaz_log (YLOG_DEBUG, "Sort handler installed");
2234 if ((assoc->init->bend_search))
2235 yaz_log (YLOG_DEBUG, "Search handler installed");
2236 if ((assoc->init->bend_present))
2237 yaz_log (YLOG_DEBUG, "Present handler installed");
2238 if ((assoc->init->bend_esrequest))
2239 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2240 if ((assoc->init->bend_delete))
2241 yaz_log (YLOG_DEBUG, "Delete handler installed");
2242 if ((assoc->init->bend_scan))
2243 yaz_log (YLOG_DEBUG, "Scan handler installed");
2244 if ((assoc->init->bend_segment))
2245 yaz_log (YLOG_DEBUG, "Segment handler installed");
2247 resp->referenceId = req->referenceId;
2249 /* let's tell the client what we can do */
2250 if (ODR_MASK_GET(req->options, Z_Options_search))
2252 ODR_MASK_SET(resp->options, Z_Options_search);
2253 strcat(options, "srch");
2255 if (ODR_MASK_GET(req->options, Z_Options_present))
2257 ODR_MASK_SET(resp->options, Z_Options_present);
2258 strcat(options, " prst");
2260 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2261 assoc->init->bend_delete)
2263 ODR_MASK_SET(resp->options, Z_Options_delSet);
2264 strcat(options, " del");
2266 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2267 assoc->init->bend_esrequest)
2269 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2270 strcat (options, " extendedServices");
2272 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2274 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2275 strcat(options, " namedresults");
2277 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2279 ODR_MASK_SET(resp->options, Z_Options_scan);
2280 strcat(options, " scan");
2282 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2284 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2285 strcat(options, " concurrop");
2287 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2289 ODR_MASK_SET(resp->options, Z_Options_sort);
2290 strcat(options, " sort");
2293 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2295 Z_OtherInformationUnit *p0;
2297 if (!assoc->init->charneg_response)
2299 if (assoc->init->query_charset)
2301 assoc->init->charneg_response = yaz_set_response_charneg(
2302 assoc->encode, assoc->init->query_charset, 0,
2303 assoc->init->records_in_same_charset);
2307 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2310 if (assoc->init->charneg_response
2311 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2313 p0->which = Z_OtherInfo_externallyDefinedInfo;
2314 p0->information.externallyDefinedInfo =
2315 assoc->init->charneg_response;
2316 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2317 strcat(options, " negotiation");
2320 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2321 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2323 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2325 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2326 assoc->version = 1; /* 1 & 2 are equivalent */
2328 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2330 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2333 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2335 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2339 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2341 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2342 assoc->maximumRecordSize = *req->maximumRecordSize;
2344 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2345 assoc->preferredMessageSize = *req->preferredMessageSize;
2347 resp->preferredMessageSize = &assoc->preferredMessageSize;
2348 resp->maximumRecordSize = &assoc->maximumRecordSize;
2350 resp->implementationId = odr_prepend(assoc->encode,
2351 assoc->init->implementation_id,
2352 resp->implementationId);
2354 resp->implementationName = odr_prepend(assoc->encode,
2355 assoc->init->implementation_name,
2356 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2358 version = odr_strdup(assoc->encode, "$Revision: 1.122 $");
2359 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2360 version[strlen(version)-2] = '\0';
2361 resp->implementationVersion = odr_prepend(assoc->encode,
2362 assoc->init->implementation_version,
2363 odr_prepend(assoc->encode, &version[11],
2364 resp->implementationVersion));
2366 if (binitres->errcode)
2368 assoc->state = ASSOC_DEAD;
2369 resp->userInformationField =
2370 init_diagnostics(assoc->encode, binitres->errcode,
2371 binitres->errstring);
2376 if (!req->idAuthentication)
2377 yaz_log(log_request, "Auth none");
2378 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2380 const char *open = req->idAuthentication->u.open;
2381 const char *slash = strchr(open, '/');
2387 yaz_log(log_request, "Auth open %.*s", len, open);
2389 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2391 const char *user = req->idAuthentication->u.idPass->userId;
2392 const char *group = req->idAuthentication->u.idPass->groupId;
2393 yaz_log(log_request, "Auth idPass %s %s",
2394 user ? user : "-", group ? group : "-");
2396 else if (req->idAuthentication->which
2397 == Z_IdAuthentication_anonymous)
2399 yaz_log(log_request, "Auth anonymous");
2403 yaz_log(log_request, "Auth other");
2408 WRBUF wr = wrbuf_alloc();
2409 wrbuf_printf(wr, "Init ");
2410 if (binitres->errcode)
2411 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2413 wrbuf_printf(wr, "OK -");
2414 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2415 (req->implementationId ? req->implementationId :"-"),
2416 (req->implementationName ?
2417 req->implementationName : "-"),
2418 (req->implementationVersion ?
2419 req->implementationVersion : "-")
2421 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2428 * Set the specified `errcode' and `errstring' into a UserInfo-1
2429 * external to be returned to the client in accordance with Z35.90
2430 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2431 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2433 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2435 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2436 addinfo ? " -- " : "", addinfo ? addinfo : "");
2437 return zget_init_diagnostics(odr, error, addinfo);
2441 * nonsurrogate diagnostic record.
2443 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2445 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2447 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2448 addinfo ? " -- " : "", addinfo ? addinfo : "");
2450 rec->which = Z_Records_NSD;
2451 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2457 * surrogate diagnostic.
2459 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2461 int error, const char *addinfo)
2463 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2464 addinfo ? " -- " : "", addinfo ? addinfo : "");
2465 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2468 static Z_Records *pack_records(association *a, char *setname, int start,
2469 int *num, Z_RecordComposition *comp,
2470 int *next, int *pres,
2471 Z_ReferenceId *referenceId,
2472 Odr_oid *oid, int *errcode)
2474 int recno, total_length = 0, toget = *num, dumped_records = 0;
2475 Z_Records *records =
2476 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2477 Z_NamePlusRecordList *reclist =
2478 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2479 Z_NamePlusRecord **list =
2480 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2482 records->which = Z_Records_DBOSD;
2483 records->u.databaseOrSurDiagnostics = reclist;
2484 reclist->num_records = 0;
2485 reclist->records = list;
2486 *pres = Z_PresentStatus_success;
2490 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2491 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2492 a->maximumRecordSize);
2493 for (recno = start; reclist->num_records < toget; recno++)
2496 Z_NamePlusRecord *thisrec;
2497 int this_length = 0;
2499 * we get the number of bytes allocated on the stream before any
2500 * allocation done by the backend - this should give us a reasonable
2501 * idea of the total size of the data so far.
2503 total_length = odr_total(a->encode) - dumped_records;
2509 freq.last_in_set = 0;
2510 freq.setname = setname;
2511 freq.surrogate_flag = 0;
2512 freq.number = recno;
2514 freq.request_format = oid;
2515 freq.output_format = 0;
2516 freq.stream = a->encode;
2517 freq.print = a->print;
2518 freq.referenceId = referenceId;
2521 retrieve_fetch(a, &freq);
2523 *next = freq.last_in_set ? 0 : recno + 1;
2525 /* backend should be able to signal whether error is system-wide
2526 or only pertaining to current record */
2529 if (!freq.surrogate_flag)
2532 *pres = Z_PresentStatus_failure;
2533 /* for 'present request out of range',
2534 set addinfo to record position if not set */
2535 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2536 freq.errstring == 0)
2538 sprintf (s, "%d", recno);
2542 *errcode = freq.errcode;
2543 return diagrec(a, freq.errcode, freq.errstring);
2545 reclist->records[reclist->num_records] =
2546 surrogatediagrec(a, freq.basename, freq.errcode,
2548 reclist->num_records++;
2551 if (freq.record == 0) /* no error and no record ? */
2553 *next = 0; /* signal end-of-set and stop */
2557 this_length = freq.len;
2559 this_length = odr_total(a->encode) - total_length - dumped_records;
2560 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2561 this_length, total_length, dumped_records);
2562 if (a->preferredMessageSize > 0 &&
2563 this_length + total_length > a->preferredMessageSize)
2565 /* record is small enough, really */
2566 if (this_length <= a->preferredMessageSize && recno > start)
2568 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2569 *pres = Z_PresentStatus_partial_2;
2572 /* record can only be fetched by itself */
2573 if (this_length < a->maximumRecordSize)
2575 yaz_log(log_requestdetail, " Record > prefmsgsz");
2578 yaz_log(YLOG_DEBUG, " Dropped it");
2579 reclist->records[reclist->num_records] =
2580 surrogatediagrec(a, freq.basename, 16, 0);
2581 reclist->num_records++;
2582 dumped_records += this_length;
2586 else /* too big entirely */
2588 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2589 this_length, a->maximumRecordSize);
2590 reclist->records[reclist->num_records] =
2591 surrogatediagrec(a, freq.basename, 17, 0);
2592 reclist->num_records++;
2593 dumped_records += this_length;
2598 if (!(thisrec = (Z_NamePlusRecord *)
2599 odr_malloc(a->encode, sizeof(*thisrec))))
2602 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2604 thisrec->databaseName = 0;
2605 thisrec->which = Z_NamePlusRecord_databaseRecord;
2607 if (!freq.output_format)
2608 freq.output_format = freq.request_format;
2609 thisrec->u.databaseRecord = z_ext_record_oid(
2610 a->encode, freq.output_format, freq.record, freq.len);
2611 if (!thisrec->u.databaseRecord)
2613 reclist->records[reclist->num_records] = thisrec;
2614 reclist->num_records++;
2616 *num = reclist->num_records;
2620 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2623 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2624 bend_search_rr *bsrr =
2625 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2627 yaz_log(log_requestdetail, "Got SearchRequest.");
2629 bsrr->request = reqb;
2630 bsrr->association = assoc;
2631 bsrr->referenceId = req->referenceId;
2632 save_referenceId (reqb, bsrr->referenceId);
2633 bsrr->srw_sortKeys = 0;
2634 bsrr->srw_setname = 0;
2635 bsrr->srw_setnameIdleTime = 0;
2636 bsrr->estimated_hit_count = 0;
2637 bsrr->partial_resultset = 0;
2639 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2640 if (req->databaseNames)
2643 for (i = 0; i < req->num_databaseNames; i++)
2644 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2647 yaz_log_zquery_level(log_requestdetail,req->query);
2649 if (assoc->init->bend_search)
2651 bsrr->setname = req->resultSetName;
2652 bsrr->replace_set = *req->replaceIndicator;
2653 bsrr->num_bases = req->num_databaseNames;
2654 bsrr->basenames = req->databaseNames;
2655 bsrr->query = req->query;
2656 bsrr->stream = assoc->encode;
2657 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2658 bsrr->decode = assoc->decode;
2659 bsrr->print = assoc->print;
2662 bsrr->errstring = NULL;
2663 bsrr->search_info = NULL;
2665 if (assoc->server && assoc->server->cql_transform
2666 && req->query->which == Z_Query_type_104
2667 && req->query->u.type_104->which == Z_External_CQL)
2669 /* have a CQL query and a CQL to PQF transform .. */
2671 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2672 assoc->server->cql_transform, bsrr->query);
2674 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2677 (assoc->init->bend_search)(assoc->backend, bsrr);
2678 if (!bsrr->request) /* backend not ready with the search response */
2679 return 0; /* should not be used any more */
2683 /* FIXME - make a diagnostic for it */
2684 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2686 return response_searchRequest(assoc, reqb, bsrr, fd);
2689 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2692 * Prepare a searchresponse based on the backend results. We probably want
2693 * to look at making the fetching of records nonblocking as well, but
2694 * so far, we'll keep things simple.
2695 * If bsrt is null, that means we're called in response to a communications
2696 * event, and we'll have to get the response for ourselves.
2698 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2699 bend_search_rr *bsrt, int *fd)
2701 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2702 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2703 Z_SearchResponse *resp = (Z_SearchResponse *)
2704 odr_malloc (assoc->encode, sizeof(*resp));
2705 int *nulint = odr_intdup (assoc->encode, 0);
2706 int *next = odr_intdup(assoc->encode, 0);
2707 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2708 int returnedrecs = 0;
2710 apdu->which = Z_APDU_searchResponse;
2711 apdu->u.searchResponse = resp;
2712 resp->referenceId = req->referenceId;
2713 resp->additionalSearchInfo = 0;
2714 resp->otherInfo = 0;
2716 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2718 yaz_log(YLOG_FATAL, "Bad result from backend");
2721 else if (bsrt->errcode)
2723 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2724 resp->resultCount = nulint;
2725 resp->numberOfRecordsReturned = nulint;
2726 resp->nextResultSetPosition = nulint;
2727 resp->searchStatus = nulint;
2728 resp->resultSetStatus = none;
2729 resp->presentStatus = 0;
2733 bool_t *sr = odr_intdup(assoc->encode, 1);
2734 int *toget = odr_intdup(assoc->encode, 0);
2735 Z_RecordComposition comp, *compp = 0;
2737 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2740 resp->resultCount = &bsrt->hits;
2742 comp.which = Z_RecordComp_simple;
2743 /* how many records does the user agent want, then? */
2744 if (bsrt->hits <= *req->smallSetUpperBound)
2746 *toget = bsrt->hits;
2747 if ((comp.u.simple = req->smallSetElementSetNames))
2750 else if (bsrt->hits < *req->largeSetLowerBound)
2752 *toget = *req->mediumSetPresentNumber;
2753 if (*toget > bsrt->hits)
2754 *toget = bsrt->hits;
2755 if ((comp.u.simple = req->mediumSetElementSetNames))
2761 if (*toget && !resp->records)
2763 int *presst = odr_intdup(assoc->encode, 0);
2764 /* Call bend_present if defined */
2765 if (assoc->init->bend_present)
2767 bend_present_rr *bprr = (bend_present_rr *)
2768 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2769 bprr->setname = req->resultSetName;
2771 bprr->number = *toget;
2772 bprr->format = req->preferredRecordSyntax;
2774 bprr->referenceId = req->referenceId;
2775 bprr->stream = assoc->encode;
2776 bprr->print = assoc->print;
2777 bprr->request = reqb;
2778 bprr->association = assoc;
2780 bprr->errstring = NULL;
2781 (*assoc->init->bend_present)(assoc->backend, bprr);
2787 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2788 *resp->presentStatus = Z_PresentStatus_failure;
2793 resp->records = pack_records(
2794 assoc, req->resultSetName, 1,
2795 toget, compp, next, presst, req->referenceId,
2796 req->preferredRecordSyntax, NULL);
2799 resp->numberOfRecordsReturned = toget;
2800 returnedrecs = *toget;
2801 resp->presentStatus = presst;
2805 if (*resp->resultCount)
2807 resp->numberOfRecordsReturned = nulint;
2808 resp->presentStatus = 0;
2810 resp->nextResultSetPosition = next;
2811 resp->searchStatus = sr;
2812 resp->resultSetStatus = 0;
2813 if (bsrt->estimated_hit_count)
2815 resp->resultSetStatus = odr_intdup(assoc->encode,
2816 Z_SearchResponse_estimate);
2818 else if (bsrt->partial_resultset)
2820 resp->resultSetStatus = odr_intdup(assoc->encode,
2821 Z_SearchResponse_subset);
2824 resp->additionalSearchInfo = bsrt->search_info;
2829 WRBUF wr = wrbuf_alloc();
2831 for (i = 0 ; i < req->num_databaseNames; i++){
2833 wrbuf_printf(wr, "+");
2834 wrbuf_printf(wr, req->databaseNames[i]);
2836 wrbuf_printf(wr, " ");
2839 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2841 wrbuf_printf(wr, "OK %d", bsrt->hits);
2842 wrbuf_printf(wr, " %s 1+%d ",
2843 req->resultSetName, returnedrecs);
2844 yaz_query_to_wrbuf(wr, req->query);
2846 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2853 * Maybe we got a little over-friendly when we designed bend_fetch to
2854 * get only one record at a time. Some backends can optimise multiple-record
2855 * fetches, and at any rate, there is some overhead involved in
2856 * all that selecting and hopping around. Problem is, of course, that the
2857 * frontend can't know ahead of time how many records it'll need to
2858 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2859 * is downright lousy as a bulk data transfer protocol.
2861 * To start with, we'll do the fetching of records from the backend
2862 * in one operation: To save some trips in and out of the event-handler,
2863 * and to simplify the interface to pack_records. At any rate, asynch
2864 * operation is more fun in operations that have an unpredictable execution
2865 * speed - which is normally more true for search than for present.
2867 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2870 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2872 Z_PresentResponse *resp;
2876 const char *errstring = 0;
2878 yaz_log(log_requestdetail, "Got PresentRequest.");
2880 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2882 resp->presentStatus = odr_intdup(assoc->encode, 0);
2883 if (assoc->init->bend_present)
2885 bend_present_rr *bprr = (bend_present_rr *)
2886 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2887 bprr->setname = req->resultSetId;
2888 bprr->start = *req->resultSetStartPoint;
2889 bprr->number = *req->numberOfRecordsRequested;
2890 bprr->format = req->preferredRecordSyntax;
2891 bprr->comp = req->recordComposition;
2892 bprr->referenceId = req->referenceId;
2893 bprr->stream = assoc->encode;
2894 bprr->print = assoc->print;
2895 bprr->request = reqb;
2896 bprr->association = assoc;
2898 bprr->errstring = NULL;
2899 (*assoc->init->bend_present)(assoc->backend, bprr);
2902 return 0; /* should not happen */
2905 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2906 *resp->presentStatus = Z_PresentStatus_failure;
2907 errcode = bprr->errcode;
2908 errstring = bprr->errstring;
2911 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2912 next = odr_intdup(assoc->encode, 0);
2913 num = odr_intdup(assoc->encode, 0);
2915 apdu->which = Z_APDU_presentResponse;
2916 apdu->u.presentResponse = resp;
2917 resp->referenceId = req->referenceId;
2918 resp->otherInfo = 0;
2922 *num = *req->numberOfRecordsRequested;
2924 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2925 num, req->recordComposition, next,
2926 resp->presentStatus,
2927 req->referenceId, req->preferredRecordSyntax,
2932 WRBUF wr = wrbuf_alloc();
2933 wrbuf_printf(wr, "Present ");
2935 if (*resp->presentStatus == Z_PresentStatus_failure)
2936 wrbuf_printf(wr, "ERROR %d ", errcode);
2937 else if (*resp->presentStatus == Z_PresentStatus_success)
2938 wrbuf_printf(wr, "OK - ");
2940 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2942 wrbuf_printf(wr, " %s %d+%d ",
2943 req->resultSetId, *req->resultSetStartPoint,
2944 *req->numberOfRecordsRequested);
2945 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2950 resp->numberOfRecordsReturned = num;
2951 resp->nextResultSetPosition = next;
2957 * Scan was implemented rather in a hurry, and with support for only the basic
2958 * elements of the service in the backend API. Suggestions are welcome.
2960 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2962 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2963 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2964 Z_ScanResponse *res = (Z_ScanResponse *)
2965 odr_malloc (assoc->encode, sizeof(*res));
2966 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2967 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2968 Z_ListEntries *ents = (Z_ListEntries *)
2969 odr_malloc (assoc->encode, sizeof(*ents));
2970 Z_DiagRecs *diagrecs_p = NULL;
2971 bend_scan_rr *bsrr = (bend_scan_rr *)
2972 odr_malloc (assoc->encode, sizeof(*bsrr));
2973 struct scan_entry *save_entries;
2975 yaz_log(log_requestdetail, "Got ScanRequest");
2977 apdu->which = Z_APDU_scanResponse;
2978 apdu->u.scanResponse = res;
2979 res->referenceId = req->referenceId;
2981 /* if step is absent, set it to 0 */
2982 res->stepSize = odr_intdup(assoc->encode, 0);
2984 *res->stepSize = *req->stepSize;
2986 res->scanStatus = scanStatus;
2987 res->numberOfEntriesReturned = numberOfEntriesReturned;
2988 res->positionOfTerm = 0;
2989 res->entries = ents;
2990 ents->num_entries = 0;
2991 ents->entries = NULL;
2992 ents->num_nonsurrogateDiagnostics = 0;
2993 ents->nonsurrogateDiagnostics = NULL;
2994 res->attributeSet = 0;
2997 if (req->databaseNames)
3000 for (i = 0; i < req->num_databaseNames; i++)
3001 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
3003 bsrr->scanClause = 0;
3005 bsrr->errstring = 0;
3006 bsrr->num_bases = req->num_databaseNames;
3007 bsrr->basenames = req->databaseNames;
3008 bsrr->num_entries = *req->numberOfTermsRequested;
3009 bsrr->term = req->termListAndStartPoint;
3010 bsrr->referenceId = req->referenceId;
3011 bsrr->stream = assoc->encode;
3012 bsrr->print = assoc->print;
3013 bsrr->step_size = res->stepSize;
3014 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
3015 yaz_oid_userinfo_scan_set, 1, 0);
3017 /* For YAZ 2.0 and earlier it was the backend handler that
3018 initialized entries (member display_term did not exist)
3019 YAZ 2.0 and later sets 'entries' and initialize all members
3020 including 'display_term'. If YAZ 2.0 or later sees that
3021 entries was modified - we assume that it is an old handler and
3022 that 'display_term' is _not_ set.
3024 if (bsrr->num_entries > 0)
3027 bsrr->entries = (struct scan_entry *)
3028 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3030 for (i = 0; i<bsrr->num_entries; i++)
3032 bsrr->entries[i].term = 0;
3033 bsrr->entries[i].occurrences = 0;
3034 bsrr->entries[i].errcode = 0;
3035 bsrr->entries[i].errstring = 0;
3036 bsrr->entries[i].display_term = 0;
3039 save_entries = bsrr->entries; /* save it so we can compare later */
3041 bsrr->attributeset = req->attributeSet;
3042 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3043 bsrr->attributeset);
3044 bsrr->term_position = req->preferredPositionInResponse ?
3045 *req->preferredPositionInResponse : 1;
3047 ((int (*)(void *, bend_scan_rr *))
3048 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3051 diagrecs_p = zget_DiagRecs(assoc->encode,
3052 bsrr->errcode, bsrr->errstring);
3056 Z_Entry **tab = (Z_Entry **)
3057 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3059 if (bsrr->status == BEND_SCAN_PARTIAL)
3060 *scanStatus = Z_Scan_partial_5;
3062 *scanStatus = Z_Scan_success;
3063 ents->entries = tab;
3064 ents->num_entries = bsrr->num_entries;
3065 res->numberOfEntriesReturned = &ents->num_entries;
3066 res->positionOfTerm = &bsrr->term_position;
3067 for (i = 0; i < bsrr->num_entries; i++)
3073 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3074 if (bsrr->entries[i].occurrences >= 0)
3076 e->which = Z_Entry_termInfo;
3077 e->u.termInfo = t = (Z_TermInfo *)
3078 odr_malloc(assoc->encode, sizeof(*t));
3079 t->suggestedAttributes = 0;
3081 if (save_entries == bsrr->entries &&
3082 bsrr->entries[i].display_term)
3084 /* the entries was _not_ set by the handler. So it's
3085 safe to test for new member display_term. It is
3088 t->displayTerm = odr_strdup(assoc->encode,
3089 bsrr->entries[i].display_term);
3091 t->alternativeTerm = 0;
3092 t->byAttributes = 0;
3093 t->otherTermInfo = 0;
3094 t->globalOccurrences = &bsrr->entries[i].occurrences;
3095 t->term = (Z_Term *)
3096 odr_malloc(assoc->encode, sizeof(*t->term));
3097 t->term->which = Z_Term_general;
3098 t->term->u.general = o =
3099 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3100 o->buf = (unsigned char *)
3101 odr_malloc(assoc->encode, o->len = o->size =
3102 strlen(bsrr->entries[i].term));
3103 memcpy(o->buf, bsrr->entries[i].term, o->len);
3104 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3105 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3109 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3110 bsrr->entries[i].errcode,
3111 bsrr->entries[i].errstring);
3112 assert (drecs->num_diagRecs == 1);
3113 e->which = Z_Entry_surrogateDiagnostic;
3114 assert (drecs->diagRecs[0]);
3115 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3121 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3122 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3127 WRBUF wr = wrbuf_alloc();
3128 wrbuf_printf(wr, "Scan ");
3129 for (i = 0 ; i < req->num_databaseNames; i++)
3132 wrbuf_printf(wr, "+");
3133 wrbuf_printf(wr, req->databaseNames[i]);
3136 wrbuf_printf(wr, " ");
3139 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3141 wrbuf_printf(wr, "OK");
3143 wrbuf_printf(wr, " %d - %d+%d+%d",
3144 res->numberOfEntriesReturned ?
3145 *res->numberOfEntriesReturned : 0,
3146 (req->preferredPositionInResponse ?
3147 *req->preferredPositionInResponse : 1),
3148 *req->numberOfTermsRequested,
3149 (res->stepSize ? *res->stepSize : 1));
3152 wrbuf_printf(wr, "+%s", bsrr->setname);
3154 wrbuf_printf(wr, " ");
3155 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3156 bsrr->attributeset);
3157 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3163 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3167 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3168 Z_SortResponse *res = (Z_SortResponse *)
3169 odr_malloc (assoc->encode, sizeof(*res));
3170 bend_sort_rr *bsrr = (bend_sort_rr *)
3171 odr_malloc (assoc->encode, sizeof(*bsrr));
3173 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3175 yaz_log(log_requestdetail, "Got SortRequest.");
3177 bsrr->num_input_setnames = req->num_inputResultSetNames;
3178 for (i=0;i<req->num_inputResultSetNames;i++)
3179 yaz_log(log_requestdetail, "Input resultset: '%s'",
3180 req->inputResultSetNames[i]);
3181 bsrr->input_setnames = req->inputResultSetNames;
3182 bsrr->referenceId = req->referenceId;
3183 bsrr->output_setname = req->sortedResultSetName;
3184 yaz_log(log_requestdetail, "Output resultset: '%s'",
3185 req->sortedResultSetName);
3186 bsrr->sort_sequence = req->sortSequence;
3187 /*FIXME - dump those sequences too */
3188 bsrr->stream = assoc->encode;
3189 bsrr->print = assoc->print;
3191 bsrr->sort_status = Z_SortResponse_failure;
3193 bsrr->errstring = 0;
3195 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3197 res->referenceId = bsrr->referenceId;
3198 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3199 res->resultSetStatus = 0;
3202 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3203 bsrr->errcode, bsrr->errstring);
3204 res->diagnostics = dr->diagRecs;
3205 res->num_diagnostics = dr->num_diagRecs;
3209 res->num_diagnostics = 0;
3210 res->diagnostics = 0;
3212 res->resultCount = 0;
3215 apdu->which = Z_APDU_sortResponse;
3216 apdu->u.sortResponse = res;
3219 WRBUF wr = wrbuf_alloc();
3220 wrbuf_printf(wr, "Sort ");
3222 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3224 wrbuf_printf(wr, "OK -");
3225 wrbuf_printf(wr, " (");
3226 for (i = 0; i<req->num_inputResultSetNames; i++)
3229 wrbuf_printf(wr, "+");
3230 wrbuf_printf(wr, req->inputResultSetNames[i]);
3232 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3234 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3240 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3244 Z_DeleteResultSetRequest *req =
3245 reqb->apdu_request->u.deleteResultSetRequest;
3246 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3247 odr_malloc (assoc->encode, sizeof(*res));
3248 bend_delete_rr *bdrr = (bend_delete_rr *)
3249 odr_malloc (assoc->encode, sizeof(*bdrr));
3250 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3252 yaz_log(log_requestdetail, "Got DeleteRequest.");
3254 bdrr->num_setnames = req->num_resultSetList;
3255 bdrr->setnames = req->resultSetList;
3256 for (i = 0; i<req->num_resultSetList; i++)
3257 yaz_log(log_requestdetail, "resultset: '%s'",
3258 req->resultSetList[i]);
3259 bdrr->stream = assoc->encode;
3260 bdrr->print = assoc->print;
3261 bdrr->function = *req->deleteFunction;
3262 bdrr->referenceId = req->referenceId;
3264 if (bdrr->num_setnames > 0)
3266 bdrr->statuses = (int*)
3267 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3268 bdrr->num_setnames);
3269 for (i = 0; i < bdrr->num_setnames; i++)
3270 bdrr->statuses[i] = 0;
3272 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3274 res->referenceId = req->referenceId;
3276 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3278 res->deleteListStatuses = 0;
3279 if (bdrr->num_setnames > 0)
3282 res->deleteListStatuses = (Z_ListStatuses *)
3283 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3284 res->deleteListStatuses->num = bdrr->num_setnames;
3285 res->deleteListStatuses->elements =
3287 odr_malloc (assoc->encode,
3288 sizeof(*res->deleteListStatuses->elements) *
3289 bdrr->num_setnames);
3290 for (i = 0; i<bdrr->num_setnames; i++)
3292 res->deleteListStatuses->elements[i] =
3294 odr_malloc (assoc->encode,
3295 sizeof(**res->deleteListStatuses->elements));
3296 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3297 res->deleteListStatuses->elements[i]->id =
3298 odr_strdup (assoc->encode, bdrr->setnames[i]);
3301 res->numberNotDeleted = 0;
3302 res->bulkStatuses = 0;
3303 res->deleteMessage = 0;
3306 apdu->which = Z_APDU_deleteResultSetResponse;
3307 apdu->u.deleteResultSetResponse = res;
3310 WRBUF wr = wrbuf_alloc();
3311 wrbuf_printf(wr, "Delete ");
3312 if (bdrr->delete_status)
3313 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3315 wrbuf_printf(wr, "OK -");
3316 for (i = 0; i<req->num_resultSetList; i++)
3317 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3318 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3324 static void process_close(association *assoc, request *reqb)
3326 Z_Close *req = reqb->apdu_request->u.close;
3327 static char *reasons[] =
3334 "securityViolation",
3341 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3342 reasons[*req->closeReason], req->diagnosticInformation ?
3343 req->diagnosticInformation : "NULL");
3344 if (assoc->version < 3) /* to make do_force respond with close */
3346 do_close_req(assoc, Z_Close_finished,
3347 "Association terminated by client", reqb);
3348 yaz_log(log_request,"Close OK");
3351 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3355 reqb->len_refid = refid->len;
3356 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3357 memcpy (reqb->refid, refid->buf, refid->len);
3361 reqb->len_refid = 0;
3366 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3368 process_z_response (a, req, res);
3371 bend_request bend_request_mk (bend_association a)
3373 request *nreq = request_get (&a->outgoing);
3374 nreq->request_mem = nmem_create ();
3378 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3383 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3384 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3385 id->len = id->size = req->len_refid;
3386 memcpy (id->buf, req->refid, req->len_refid);
3390 void bend_request_destroy (bend_request *req)
3392 nmem_destroy((*req)->request_mem);
3393 request_release(*req);
3397 int bend_backend_respond (bend_association a, bend_request req)
3401 r = process_z_request (a, req, &msg);
3403 yaz_log (YLOG_WARN, "%s", msg);
3407 void bend_request_setdata(bend_request r, void *p)
3412 void *bend_request_getdata(bend_request r)
3414 return r->clientData;
3417 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3419 bend_segment_rr req;
3421 req.segment = reqb->apdu_request->u.segmentRequest;
3422 req.stream = assoc->encode;
3423 req.decode = assoc->decode;
3424 req.print = assoc->print;
3425 req.association = assoc;
3427 (*assoc->init->bend_segment)(assoc->backend, &req);
3432 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3434 bend_esrequest_rr esrequest;
3435 const char *ext_name = "unknown";
3437 Z_ExtendedServicesRequest *req =
3438 reqb->apdu_request->u.extendedServicesRequest;
3439 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3441 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3443 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3444 esrequest.stream = assoc->encode;
3445 esrequest.decode = assoc->decode;
3446 esrequest.print = assoc->print;
3447 esrequest.errcode = 0;
3448 esrequest.errstring = NULL;
3449 esrequest.request = reqb;
3450 esrequest.association = assoc;
3451 esrequest.taskPackage = 0;
3452 esrequest.referenceId = req->referenceId;
3455 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3457 switch(esrequest.esr->taskSpecificParameters->which)
3459 case Z_External_itemOrder:
3460 ext_name = "ItemOrder"; break;
3461 case Z_External_update:
3462 ext_name = "Update"; break;
3463 case Z_External_update0:
3464 ext_name = "Update0"; break;
3465 case Z_External_ESAdmin:
3466 ext_name = "Admin"; break;
3471 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3473 /* If the response is being delayed, return NULL */
3474 if (esrequest.request == NULL)
3477 resp->referenceId = req->referenceId;
3479 if (esrequest.errcode == -1)
3481 /* Backend service indicates request will be processed */
3482 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3483 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3485 else if (esrequest.errcode == 0)
3487 /* Backend service indicates request will be processed */
3488 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3489 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3493 Z_DiagRecs *diagRecs =
3494 zget_DiagRecs(assoc->encode, esrequest.errcode,
3495 esrequest.errstring);
3496 /* Backend indicates error, request will not be processed */
3497 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3498 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3499 resp->num_diagnostics = diagRecs->num_diagRecs;
3500 resp->diagnostics = diagRecs->diagRecs;
3503 WRBUF wr = wrbuf_alloc();
3504 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3505 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3510 /* Do something with the members of bend_extendedservice */
3511 if (esrequest.taskPackage)
3513 resp->taskPackage = z_ext_record_oid(
3514 assoc->encode, yaz_oid_recsyn_extended,
3515 (const char *) esrequest.taskPackage, -1
3518 yaz_log(YLOG_DEBUG,"Send the result apdu");
3522 int bend_assoc_is_alive(bend_association assoc)
3524 if (assoc->state == ASSOC_DEAD)
3525 return 0; /* already marked as dead. Don't check I/O chan anymore */
3527 return iochan_is_alive(assoc->client_chan);
3534 * indent-tabs-mode: nil
3536 * vim: shiftwidth=4 tabstop=8 expandtab