2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.87 2006-06-20 21:20:51 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>
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>
77 #include <yaz/backend.h>
79 static void process_gdu_request(association *assoc, request *req);
80 static int process_z_request(association *assoc, request *req, char **msg);
81 void backend_response(IOCHAN i, int event);
82 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
83 static int process_z_response(association *assoc, request *req, Z_APDU *res);
84 static Z_APDU *process_initRequest(association *assoc, request *reqb);
85 static Z_External *init_diagnostics(ODR odr, int errcode,
86 const char *errstring);
87 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
89 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
90 bend_search_rr *bsrr, int *fd);
91 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
93 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
94 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
95 static void process_close(association *assoc, request *reqb);
96 void save_referenceId (request *reqb, Z_ReferenceId *refid);
97 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
99 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
101 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
103 /* dynamic logging levels */
104 static int logbits_set = 0;
105 static int log_session = 0;
106 static int log_request = 0; /* one-line logs for requests */
107 static int log_requestdetail = 0; /* more detailed stuff */
109 /** get_logbits sets global loglevel bits */
110 static void get_logbits()
111 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
115 log_session = yaz_log_module_level("session");
116 log_request = yaz_log_module_level("request");
117 log_requestdetail = yaz_log_module_level("requestdetail");
121 static void wr_diag(WRBUF w, int error, const char *addinfo)
123 wrbuf_printf(w, "ERROR [%d] %s%s%s",
124 error, diagbib1_str(error),
125 addinfo ? "--" : "", addinfo ? addinfo : "");
130 * Create and initialize a new association-handle.
131 * channel : iochannel for the current line.
132 * link : communications channel.
133 * Returns: 0 or a new association handle.
135 association *create_association(IOCHAN channel, COMSTACK link,
136 const char *apdufile)
142 if (!(anew = (association *)xmalloc(sizeof(*anew))))
146 anew->last_control = 0;
147 anew->client_chan = channel;
148 anew->client_link = link;
149 anew->cs_get_mask = 0;
150 anew->cs_put_mask = 0;
151 anew->cs_accept_mask = 0;
152 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
153 !(anew->encode = odr_createmem(ODR_ENCODE)))
155 if (apdufile && *apdufile)
159 if (!(anew->print = odr_createmem(ODR_PRINT)))
161 if (*apdufile == '@')
163 odr_setprint(anew->print, yaz_log_file());
165 else if (*apdufile != '-')
168 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
169 if (!(f = fopen(filename, "w")))
171 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
174 setvbuf(f, 0, _IONBF, 0);
175 odr_setprint(anew->print, f);
180 anew->input_buffer = 0;
181 anew->input_buffer_len = 0;
183 anew->state = ASSOC_NEW;
184 request_initq(&anew->incoming);
185 request_initq(&anew->outgoing);
186 anew->proto = cs_getproto(link);
192 * Free association and release resources.
194 void destroy_association(association *h)
196 statserv_options_block *cb = statserv_getcontrol();
200 odr_destroy(h->decode);
201 odr_destroy(h->encode);
203 odr_destroy(h->print);
205 xfree(h->input_buffer);
207 (*cb->bend_close)(h->backend);
208 while ((req = request_deq(&h->incoming)))
209 request_release(req);
210 while ((req = request_deq(&h->outgoing)))
211 request_release(req);
212 request_delq(&h->incoming);
213 request_delq(&h->outgoing);
215 xmalloc_trav("session closed");
216 if (cb && cb->one_shot)
222 static void do_close_req(association *a, int reason, char *message,
226 Z_Close *cls = zget_Close(a->encode);
228 /* Purge request queue */
229 while (request_deq(&a->incoming));
230 while (request_deq(&a->outgoing));
233 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
234 reason, message ? message : "none");
235 apdu.which = Z_APDU_close;
237 *cls->closeReason = reason;
238 cls->diagnosticInformation = message;
239 process_z_response(a, req, &apdu);
240 iochan_settimeout(a->client_chan, 20);
244 request_release(req);
245 yaz_log(log_requestdetail, "v2 client. No Close PDU");
246 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
249 a->state = ASSOC_DEAD;
252 static void do_close(association *a, int reason, char *message)
254 request *req = request_get(&a->outgoing);
255 do_close_req (a, reason, message, req);
259 * This is where PDUs from the client are read and the further
260 * processing is initiated. Flow of control moves down through the
261 * various process_* functions below, until the encoded result comes back up
262 * to the output handler in here.
264 * h : the I/O channel that has an outstanding event.
265 * event : the current outstanding event.
267 void ir_session(IOCHAN h, int event)
270 association *assoc = (association *)iochan_getdata(h);
271 COMSTACK conn = assoc->client_link;
274 assert(h && conn && assoc);
275 if (event == EVENT_TIMEOUT)
277 if (assoc->state != ASSOC_UP)
279 yaz_log(YLOG_DEBUG, "Final timeout - closing connection.");
280 /* do we need to lod this at all */
282 destroy_association(assoc);
287 yaz_log(log_session, "Session idle too long. Sending close.");
288 do_close(assoc, Z_Close_lackOfActivity, 0);
292 if (event & assoc->cs_accept_mask)
294 if (!cs_accept (conn))
296 yaz_log (YLOG_WARN, "accept failed");
297 destroy_association(assoc);
300 iochan_clearflag (h, EVENT_OUTPUT);
301 if (conn->io_pending)
302 { /* cs_accept didn't complete */
303 assoc->cs_accept_mask =
304 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
305 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
307 iochan_setflag (h, assoc->cs_accept_mask);
310 { /* cs_accept completed. Prepare for reading (cs_get) */
311 assoc->cs_accept_mask = 0;
312 assoc->cs_get_mask = EVENT_INPUT;
313 iochan_setflag (h, assoc->cs_get_mask);
317 if ((event & assoc->cs_get_mask) || (event & EVENT_WORK)) /* input */
319 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
321 yaz_log(YLOG_DEBUG, "ir_session (input)");
322 /* We aren't speaking to this fellow */
323 if (assoc->state == ASSOC_DEAD)
325 yaz_log(log_session, "Connection closed - end of session");
327 destroy_association(assoc);
331 assoc->cs_get_mask = EVENT_INPUT;
332 if ((res = cs_get(conn, &assoc->input_buffer,
333 &assoc->input_buffer_len)) <= 0)
335 yaz_log(log_session, "Connection closed by client");
337 destroy_association(assoc);
341 else if (res == 1) /* incomplete read - wait for more */
343 if (conn->io_pending & CS_WANT_WRITE)
344 assoc->cs_get_mask |= EVENT_OUTPUT;
345 iochan_setflag(h, assoc->cs_get_mask);
348 if (cs_more(conn)) /* more stuff - call us again later, please */
349 iochan_setevent(h, EVENT_INPUT);
351 /* we got a complete PDU. Let's decode it */
352 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
353 assoc->input_buffer[0] & 0xff,
354 assoc->input_buffer[1] & 0xff,
355 assoc->input_buffer[2] & 0xff);
356 req = request_get(&assoc->incoming); /* get a new request */
357 odr_reset(assoc->decode);
358 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
359 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
361 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
363 odr_errmsg(odr_geterror(assoc->decode)),
364 odr_getelement(assoc->decode),
365 (long) odr_offset(assoc->decode));
366 if (assoc->decode->error != OHTTP)
368 yaz_log(YLOG_WARN, "PDU dump:");
369 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
370 request_release(req);
371 do_close(assoc, Z_Close_protocolError,"Malformed package");
375 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
376 assoc->state = ASSOC_DEAD;
377 process_gdu_response(assoc, req, p);
381 req->request_mem = odr_extract_mem(assoc->decode);
384 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
385 yaz_log(YLOG_WARN, "ODR print error: %s",
386 odr_errmsg(odr_geterror(assoc->print)));
387 odr_reset(assoc->print);
389 request_enq(&assoc->incoming, req);
392 /* can we do something yet? */
393 req = request_head(&assoc->incoming);
394 if (req->state == REQUEST_IDLE)
396 request_deq(&assoc->incoming);
397 process_gdu_request(assoc, req);
400 if (event & assoc->cs_put_mask)
402 request *req = request_head(&assoc->outgoing);
404 assoc->cs_put_mask = 0;
405 yaz_log(YLOG_DEBUG, "ir_session (output)");
406 req->state = REQUEST_PENDING;
407 switch (res = cs_put(conn, req->response, req->len_response))
410 yaz_log(log_session, "Connection closed by client");
412 destroy_association(assoc);
415 case 0: /* all sent - release the request structure */
416 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
418 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
421 nmem_destroy(req->request_mem);
422 request_deq(&assoc->outgoing);
423 request_release(req);
424 if (!request_head(&assoc->outgoing))
425 { /* restore mask for cs_get operation ... */
426 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
427 iochan_setflag(h, assoc->cs_get_mask);
428 if (assoc->state == ASSOC_DEAD)
429 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
433 assoc->cs_put_mask = EVENT_OUTPUT;
437 if (conn->io_pending & CS_WANT_WRITE)
438 assoc->cs_put_mask |= EVENT_OUTPUT;
439 if (conn->io_pending & CS_WANT_READ)
440 assoc->cs_put_mask |= EVENT_INPUT;
441 iochan_setflag(h, assoc->cs_put_mask);
444 if (event & EVENT_EXCEPT)
446 yaz_log(YLOG_WARN, "ir_session (exception)");
448 destroy_association(assoc);
453 static int process_z_request(association *assoc, request *req, char **msg);
456 static void assoc_init_reset(association *assoc)
459 assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
461 assoc->init->stream = assoc->encode;
462 assoc->init->print = assoc->print;
463 assoc->init->auth = 0;
464 assoc->init->referenceId = 0;
465 assoc->init->implementation_version = 0;
466 assoc->init->implementation_id = 0;
467 assoc->init->implementation_name = 0;
468 assoc->init->bend_sort = NULL;
469 assoc->init->bend_search = NULL;
470 assoc->init->bend_present = NULL;
471 assoc->init->bend_esrequest = NULL;
472 assoc->init->bend_delete = NULL;
473 assoc->init->bend_scan = NULL;
474 assoc->init->bend_segment = NULL;
475 assoc->init->bend_fetch = NULL;
476 assoc->init->bend_explain = NULL;
477 assoc->init->bend_srw_scan = NULL;
478 assoc->init->bend_srw_update = NULL;
480 assoc->init->charneg_request = NULL;
481 assoc->init->charneg_response = NULL;
483 assoc->init->decode = assoc->decode;
484 assoc->init->peer_name =
485 odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
487 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
490 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
492 statserv_options_block *cb = statserv_getcontrol();
495 const char *encoding = "UTF-8";
497 bend_initresult *binitres;
499 yaz_log(YLOG_LOG, "srw_bend_init config=%s", cb->configname);
500 assoc_init_reset(assoc);
502 assoc->maximumRecordSize = 3000000;
503 assoc->preferredMessageSize = 3000000;
507 Z_IdAuthentication *auth = odr_malloc(assoc->decode, sizeof(*auth));
510 len = strlen(sr->username) + 1;
512 len += strlen(sr->password) + 2;
513 auth->which = Z_IdAuthentication_open;
514 auth->u.open = odr_malloc(assoc->decode, len);
515 strcpy(auth->u.open, sr->username);
516 if (sr->password && *sr->password)
518 strcat(auth->u.open, "/");
519 strcat(auth->u.open, sr->password);
521 assoc->init->auth = auth;
525 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
526 assoc->init->charneg_request = ce->u.charNeg3;
529 if (!(binitres = (*cb->bend_init)(assoc->init)))
531 assoc->state = ASSOC_DEAD;
532 yaz_add_srw_diagnostic(assoc->encode, d, num,
533 YAZ_SRW_AUTHENTICATION_ERROR, 0);
536 assoc->backend = binitres->handle;
537 assoc->init->auth = 0;
538 if (binitres->errcode)
540 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
541 assoc->state = ASSOC_DEAD;
542 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
543 binitres->errstring);
551 static const char *get_esn(Z_RecordComposition *comp)
553 if (comp && comp->which == Z_RecordComp_complex)
555 if (comp->u.complex->generic
556 && comp->u.complex->generic->elementSpec
557 && (comp->u.complex->generic->elementSpec->which ==
558 Z_ElementSpec_elementSetName))
559 return comp->u.complex->generic->elementSpec->u.elementSetName;
561 else if (comp && comp->which == Z_RecordComp_simple &&
562 comp->u.simple->which == Z_ElementSetNames_generic)
563 return comp->u.simple->u.generic;
567 static void set_esn(Z_RecordComposition **comp_p, const char *esn, NMEM nmem)
569 Z_RecordComposition *comp = nmem_malloc(nmem, sizeof(*comp));
571 comp->which = Z_RecordComp_simple;
572 comp->u.simple = nmem_malloc(nmem, sizeof(*comp->u.simple));
573 comp->u.simple->which = Z_ElementSetNames_generic;
574 comp->u.simple->u.generic = nmem_strdup(nmem, esn);
578 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
581 yaz_record_conv_t rc = 0;
582 const char *match_schema = 0;
583 int *match_syntax = 0;
588 const char *input_schema = get_esn(rr->comp);
589 Odr_oid *input_syntax_raw = rr->request_format_raw;
591 const char *backend_schema = 0;
592 Odr_oid *backend_syntax = 0;
594 r = yaz_retrieval_request(assoc->server->retrieval,
602 if (r == -1) /* error ? */
604 const char *details = yaz_retrieval_get_error(
605 assoc->server->retrieval);
607 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
609 rr->errstring = odr_strdup(rr->stream, details);
612 else if (r == 1 || r == 3)
614 const char *details = input_schema;
615 rr->errcode = YAZ_BIB1_ELEMENT_SET_NAMES_UNSUPP;
617 rr->errstring = odr_strdup(rr->stream, details);
622 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
623 if (input_syntax_raw)
625 char oidbuf[OID_STR_MAX];
626 oid_to_dotstring(input_syntax_raw, oidbuf);
627 rr->errstring = odr_strdup(rr->stream, oidbuf);
633 set_esn(&rr->comp, backend_schema, rr->stream->mem);
637 oident *oident_syntax = oid_getentbyoid(backend_syntax);
639 rr->request_format_raw = backend_syntax;
642 rr->request_format = oident_syntax->value;
644 rr->request_format = VAL_NONE;
647 (*assoc->init->bend_fetch)(assoc->backend, rr);
648 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
649 { /* post conversion must take place .. */
650 WRBUF output_record = wrbuf_alloc();
651 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
654 const char *details = yaz_record_conv_get_error(rc);
655 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
657 rr->errstring = odr_strdup(rr->stream, details);
661 rr->len = wrbuf_len(output_record);
662 rr->record = odr_malloc(rr->stream, rr->len);
663 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
665 wrbuf_free(output_record, 1);
669 struct oident *oi = oid_getentbyoid(match_syntax);
670 rr->output_format = oi ? oi->value : VAL_NONE;
671 rr->output_format_raw = match_syntax;
674 rr->schema = odr_strdup(rr->stream, match_schema);
677 (*assoc->init->bend_fetch)(assoc->backend, rr);
681 static int srw_bend_fetch(association *assoc, int pos,
682 Z_SRW_searchRetrieveRequest *srw_req,
683 Z_SRW_record *record)
686 ODR o = assoc->encode;
688 rr.setname = "default";
691 rr.request_format = VAL_TEXT_XML;
692 rr.request_format_raw = yaz_oidval_to_z3950oid(assoc->decode,
695 rr.comp = (Z_RecordComposition *)
696 odr_malloc(assoc->decode, sizeof(*rr.comp));
697 rr.comp->which = Z_RecordComp_complex;
698 rr.comp->u.complex = (Z_CompSpec *)
699 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
700 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
701 odr_malloc(assoc->encode, sizeof(bool_t));
702 *rr.comp->u.complex->selectAlternativeSyntax = 0;
703 rr.comp->u.complex->num_dbSpecific = 0;
704 rr.comp->u.complex->dbSpecific = 0;
705 rr.comp->u.complex->num_recordSyntax = 0;
706 rr.comp->u.complex->recordSyntax = 0;
708 rr.comp->u.complex->generic = (Z_Specification *)
709 odr_malloc(assoc->decode, sizeof(Z_Specification));
711 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
712 rr.comp->u.complex->generic->which = Z_Schema_uri;
713 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
715 /* ESN = recordSchema if recordSchema is present */
716 rr.comp->u.complex->generic->elementSpec = 0;
717 if (srw_req->recordSchema)
719 rr.comp->u.complex->generic->elementSpec =
720 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
721 rr.comp->u.complex->generic->elementSpec->which =
722 Z_ElementSpec_elementSetName;
723 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
724 srw_req->recordSchema;
727 rr.stream = assoc->encode;
728 rr.print = assoc->print;
736 rr.surrogate_flag = 0;
737 rr.schema = srw_req->recordSchema;
739 if (!assoc->init->bend_fetch)
742 retrieve_fetch(assoc, &rr);
744 if (rr.errcode && rr.surrogate_flag)
746 int code = yaz_diag_bib1_to_srw(rr.errcode);
747 const char *message = yaz_diag_srw_str(code);
750 len += strlen(message);
752 len += strlen(rr.errstring);
754 record->recordData_buf = odr_malloc(o, len);
756 sprintf(record->recordData_buf, "<diagnostic "
757 "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
758 " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
760 sprintf(record->recordData_buf + strlen(record->recordData_buf),
761 " <details>%s</details>\n", rr.errstring);
763 sprintf(record->recordData_buf + strlen(record->recordData_buf),
764 " <message>%s</message>\n", message);
765 sprintf(record->recordData_buf + strlen(record->recordData_buf),
767 record->recordData_len = strlen(record->recordData_buf);
768 record->recordPosition = odr_intdup(o, pos);
769 record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
772 else if (rr.len >= 0)
774 record->recordData_buf = rr.record;
775 record->recordData_len = rr.len;
776 record->recordPosition = odr_intdup(o, pos);
778 record->recordSchema = odr_strdup(o, rr.schema);
780 record->recordSchema = 0;
785 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
786 Z_Query *query_result)
788 /* have a CQL query and CQL to PQF transform .. */
789 CQL_parser cp = cql_parser_create();
795 r = cql_parser_string(cp, cql);
798 /* CQL syntax error */
804 r = cql_transform_buf(ct,
805 cql_parser_result(cp),
806 rpn_buf, sizeof(rpn_buf)-1);
808 srw_errcode = cql_transform_error(ct, &add);
812 /* Syntax & transform OK. */
813 /* Convert PQF string to Z39.50 to RPN query struct */
814 YAZ_PQF_Parser pp = yaz_pqf_create();
815 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
820 int code = yaz_pqf_error(pp, &pqf_msg, &off);
821 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
827 query_result->which = Z_Query_type_1;
828 query_result->u.type_1 = rpnquery;
832 cql_parser_destroy(cp);
836 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
837 Z_AttributesPlusTerm *result)
841 int srw_error = cql2pqf(odr, cql, ct, &query);
844 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
845 return 10; /* bad query type */
846 rpn = query.u.type_1;
847 if (!rpn->RPNStructure)
848 return 10; /* must be structure */
849 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
850 return 10; /* must be simple */
851 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
852 return 10; /* must be attributes plus term node .. */
853 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
858 static void srw_bend_search(association *assoc, request *req,
860 Z_SRW_searchRetrieveResponse *srw_res,
865 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
868 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
869 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
870 if (srw_res->num_diagnostics == 0 && assoc->init)
873 rr.setname = "default";
876 rr.basenames = &srw_req->database;
880 rr.srw_setnameIdleTime = 0;
881 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
882 rr.query->u.type_1 = 0;
884 if (srw_req->query_type == Z_SRW_query_type_cql)
886 if (assoc->server && assoc->server->cql_transform)
888 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
889 assoc->server->cql_transform,
893 yaz_add_srw_diagnostic(assoc->encode,
894 &srw_res->diagnostics,
895 &srw_res->num_diagnostics,
901 /* CQL query to backend. Wrap it - Z39.50 style */
902 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
903 ext->direct_reference = odr_getoidbystr(assoc->decode,
904 "1.2.840.10003.16.2");
905 ext->indirect_reference = 0;
907 ext->which = Z_External_CQL;
908 ext->u.cql = srw_req->query.cql;
910 rr.query->which = Z_Query_type_104;
911 rr.query->u.type_104 = ext;
914 else if (srw_req->query_type == Z_SRW_query_type_pqf)
916 Z_RPNQuery *RPNquery;
917 YAZ_PQF_Parser pqf_parser;
919 pqf_parser = yaz_pqf_create ();
921 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
927 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
928 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
929 code, pqf_msg, (long) off);
930 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
933 rr.query->which = Z_Query_type_1;
934 rr.query->u.type_1 = RPNquery;
936 yaz_pqf_destroy (pqf_parser);
940 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
941 &srw_res->num_diagnostics,
942 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
944 if (rr.query->u.type_1)
946 rr.stream = assoc->encode;
947 rr.decode = assoc->decode;
948 rr.print = assoc->print;
950 if ( srw_req->sort.sortKeys )
951 rr.srw_sortKeys = odr_strdup(assoc->encode,
952 srw_req->sort.sortKeys );
953 rr.association = assoc;
959 yaz_log_zquery_level(log_requestdetail,rr.query);
961 (assoc->init->bend_search)(assoc->backend, &rr);
964 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
970 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
971 yaz_add_srw_diagnostic(assoc->encode,
972 &srw_res->diagnostics,
973 &srw_res->num_diagnostics,
974 srw_error, rr.errstring);
979 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
980 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
982 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
983 start, number, rr.hits);
985 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
988 srw_res->resultSetId =
989 odr_strdup(assoc->encode, rr.srw_setname );
990 srw_res->resultSetIdleTime =
991 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
999 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1000 &srw_res->num_diagnostics,
1001 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1006 if (start + number > rr.hits)
1007 number = rr.hits - start + 1;
1009 /* Call bend_present if defined */
1010 if (assoc->init->bend_present)
1012 bend_present_rr *bprr = (bend_present_rr*)
1013 odr_malloc (assoc->decode, sizeof(*bprr));
1014 bprr->setname = "default";
1015 bprr->start = start;
1016 bprr->number = number;
1017 bprr->format = VAL_TEXT_XML;
1018 if (srw_req->recordSchema)
1020 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1021 sizeof(*bprr->comp));
1022 bprr->comp->which = Z_RecordComp_simple;
1023 bprr->comp->u.simple = (Z_ElementSetNames *)
1024 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1025 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1026 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1032 bprr->stream = assoc->encode;
1033 bprr->referenceId = 0;
1034 bprr->print = assoc->print;
1035 bprr->request = req;
1036 bprr->association = assoc;
1038 bprr->errstring = NULL;
1039 (*assoc->init->bend_present)(assoc->backend, bprr);
1045 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1046 yaz_add_srw_diagnostic(assoc->encode,
1047 &srw_res->diagnostics,
1048 &srw_res->num_diagnostics,
1049 srw_error, bprr->errstring);
1057 int packing = Z_SRW_recordPacking_string;
1058 if (srw_req->recordPacking){
1059 if (!strcmp(srw_req->recordPacking, "xml"))
1060 packing = Z_SRW_recordPacking_XML;
1061 if (!strcmp(srw_req->recordPacking, "url"))
1062 packing = Z_SRW_recordPacking_URL;
1064 srw_res->records = (Z_SRW_record *)
1065 odr_malloc(assoc->encode,
1066 number * sizeof(*srw_res->records));
1068 srw_res->extra_records = (Z_SRW_extra_record **)
1069 odr_malloc(assoc->encode,
1070 number*sizeof(*srw_res->extra_records));
1072 for (i = 0; i<number; i++)
1076 srw_res->records[j].recordPacking = packing;
1077 srw_res->records[j].recordData_buf = 0;
1078 srw_res->extra_records[j] = 0;
1079 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1080 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1081 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;
1106 const char *querystr = "?";
1107 const char *querytype = "?";
1108 WRBUF wr = wrbuf_alloc();
1110 switch (srw_req->query_type)
1112 case Z_SRW_query_type_cql:
1114 querystr = srw_req->query.cql;
1116 case Z_SRW_query_type_pqf:
1118 querystr = srw_req->query.pqf;
1121 wrbuf_printf(wr, "SRWSearch ");
1122 if (srw_res->num_diagnostics)
1123 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1124 else if (*http_code != 200)
1125 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1126 else if (srw_res->numberOfRecords)
1128 wrbuf_printf(wr, "OK %d",
1129 (srw_res->numberOfRecords ?
1130 *srw_res->numberOfRecords : 0));
1132 wrbuf_printf(wr, " %s %d+%d",
1133 (srw_res->resultSetId ?
1134 srw_res->resultSetId : "-"),
1135 (srw_req->startRecord ? *srw_req->startRecord : 1),
1136 srw_res->num_records);
1137 yaz_log(log_request, "%s %s: %s", wrbuf_buf(wr), querytype, querystr);
1142 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1145 xmlNodePtr ptr = rr->server_node_ptr;
1148 for (ptr = ptr->children; ptr; ptr = ptr->next)
1150 if (ptr->type != XML_ELEMENT_NODE)
1152 if (!strcmp((const char *) ptr->name, "explain"))
1155 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1159 ptr = xmlCopyNode(ptr, 1);
1161 xmlDocSetRootElement(doc, ptr);
1163 xmlDocDumpMemory(doc, &buf_out, &len);
1164 content = (char*) odr_malloc(rr->stream, 1+len);
1165 memcpy(content, buf_out, len);
1166 content[len] = '\0';
1170 rr->explain_buf = content;
1178 static void srw_bend_explain(association *assoc, request *req,
1180 Z_SRW_explainResponse *srw_res,
1183 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1184 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1186 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1191 rr.stream = assoc->encode;
1192 rr.decode = assoc->decode;
1193 rr.print = assoc->print;
1195 rr.database = srw_req->database;
1197 rr.server_node_ptr = assoc->server->server_node_ptr;
1199 rr.server_node_ptr = 0;
1200 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1201 if (assoc->init->bend_explain)
1202 (*assoc->init->bend_explain)(assoc->backend, &rr);
1204 srw_bend_explain_default(assoc->backend, &rr);
1208 int packing = Z_SRW_recordPacking_string;
1209 if (srw_req->recordPacking)
1211 if (!strcmp(srw_req->recordPacking, "xml"))
1212 packing = Z_SRW_recordPacking_XML;
1213 else if (!strcmp(srw_req->recordPacking, "url"))
1214 packing = Z_SRW_recordPacking_URL;
1216 srw_res->record.recordSchema = rr.schema;
1217 srw_res->record.recordPacking = packing;
1218 srw_res->record.recordData_buf = rr.explain_buf;
1219 srw_res->record.recordData_len = strlen(rr.explain_buf);
1220 srw_res->record.recordPosition = 0;
1226 static void srw_bend_scan(association *assoc, request *req,
1228 Z_SRW_scanResponse *srw_res,
1231 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1232 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1235 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1236 if (srw_res->num_diagnostics == 0 && assoc->init)
1238 struct scan_entry *save_entries;
1240 bend_scan_rr *bsrr = (bend_scan_rr *)
1241 odr_malloc (assoc->encode, sizeof(*bsrr));
1242 bsrr->num_bases = 1;
1243 bsrr->basenames = &srw_req->database;
1245 bsrr->num_entries = srw_req->maximumTerms ?
1246 *srw_req->maximumTerms : 10;
1247 bsrr->term_position = srw_req->responsePosition ?
1248 *srw_req->responsePosition : 1;
1251 bsrr->errstring = 0;
1252 bsrr->referenceId = 0;
1253 bsrr->stream = assoc->encode;
1254 bsrr->print = assoc->print;
1255 bsrr->step_size = odr_intdup(assoc->decode, 0);
1258 if (bsrr->num_entries > 0)
1261 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1263 for (i = 0; i<bsrr->num_entries; i++)
1265 bsrr->entries[i].term = 0;
1266 bsrr->entries[i].occurrences = 0;
1267 bsrr->entries[i].errcode = 0;
1268 bsrr->entries[i].errstring = 0;
1269 bsrr->entries[i].display_term = 0;
1272 save_entries = bsrr->entries; /* save it so we can compare later */
1274 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1275 assoc->init->bend_scan)
1277 Odr_oid *scan_attributeSet = 0;
1279 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1281 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1283 srw_req->scanClause.pqf);
1284 if (scan_attributeSet &&
1285 (attset = oid_getentbyoid(scan_attributeSet)) &&
1286 (attset->oclass == CLASS_ATTSET ||
1287 attset->oclass == CLASS_GENERAL))
1288 bsrr->attributeset = attset->value;
1290 bsrr->attributeset = VAL_NONE;
1291 yaz_pqf_destroy(pqf_parser);
1292 bsrr->scanClause = 0;
1293 ((int (*)(void *, bend_scan_rr *))
1294 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1296 else if (srw_req->query_type == Z_SRW_query_type_cql
1297 && assoc->init->bend_scan && assoc->server
1298 && assoc->server->cql_transform)
1301 bsrr->scanClause = 0;
1302 bsrr->attributeset = VAL_NONE;
1303 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1304 srw_error = cql2pqf_scan(assoc->encode,
1305 srw_req->scanClause.cql,
1306 assoc->server->cql_transform,
1309 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1310 &srw_res->num_diagnostics,
1314 ((int (*)(void *, bend_scan_rr *))
1315 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1318 else if (srw_req->query_type == Z_SRW_query_type_cql
1319 && assoc->init->bend_srw_scan)
1322 bsrr->attributeset = VAL_NONE;
1323 bsrr->scanClause = srw_req->scanClause.cql;
1324 ((int (*)(void *, bend_scan_rr *))
1325 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1329 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1330 &srw_res->num_diagnostics,
1331 YAZ_SRW_UNSUPP_OPERATION, "scan");
1336 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1341 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1343 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1344 &srw_res->num_diagnostics,
1345 srw_error, bsrr->errstring);
1347 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1350 srw_res->terms = (Z_SRW_scanTerm*)
1351 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1354 srw_res->num_terms = bsrr->num_entries;
1355 for (i = 0; i<bsrr->num_entries; i++)
1357 Z_SRW_scanTerm *t = srw_res->terms + i;
1358 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1359 t->numberOfRecords =
1360 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1362 if (save_entries == bsrr->entries &&
1363 bsrr->entries[i].display_term)
1365 /* the entries was _not_ set by the handler. So it's
1366 safe to test for new member display_term. It is
1369 t->displayTerm = odr_strdup(assoc->encode,
1370 bsrr->entries[i].display_term);
1378 WRBUF wr = wrbuf_alloc();
1379 const char *querytype = 0;
1380 const char *querystr = 0;
1382 switch(srw_req->query_type)
1384 case Z_SRW_query_type_pqf:
1386 querystr = srw_req->scanClause.pqf;
1388 case Z_SRW_query_type_cql:
1390 querystr = srw_req->scanClause.cql;
1393 querytype = "Unknown";
1396 wrbuf_printf(wr, "SRWScan %d+%d",
1397 (srw_req->responsePosition ?
1398 *srw_req->responsePosition : 1),
1399 (srw_req->maximumTerms ?
1400 *srw_req->maximumTerms : 1));
1401 if (srw_res->num_diagnostics)
1402 wrbuf_printf(wr, " ERROR %s", srw_res->diagnostics[0].uri);
1404 wrbuf_printf(wr, " OK -");
1405 wrbuf_printf(wr, " %s: %s", querytype, querystr);
1406 yaz_log(log_request, "%s", wrbuf_buf(wr) );
1412 static void srw_bend_update(association *assoc, request *req,
1414 Z_SRW_updateResponse *srw_res,
1417 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1418 yaz_log(YLOG_DEBUG, "Got SRW UpdateRequest");
1419 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1421 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1426 rr.stream = assoc->encode;
1427 rr.print = assoc->print;
1429 rr.basenames = &srw_req->database;
1430 rr.operation = srw_req->operation;
1431 rr.operation_status = "failed";
1433 rr.record_version = 0;
1434 rr.record_checksum = 0;
1435 rr.record_old_version = 0;
1436 rr.record_packing = "xml";
1437 rr.record_schema = 0;
1439 rr.request_extra_record = 0;
1440 rr.response_extra_record = 0;
1441 rr.extra_request_data = 0;
1442 rr.extra_response_data = 0;
1447 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1448 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1449 if ( !strcmp( rr.operation, "delete" ) ){
1450 if ( !srw_req->recordId ){
1451 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1452 &srw_res->num_diagnostics,
1456 rr.record_id = srw_req->recordId;
1458 if ( !srw_req->recordVersion ){
1459 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1460 &srw_res->num_diagnostics,
1461 7, "recordVersion" );
1464 rr.record_version = odr_strdup( assoc->encode,
1465 srw_req->recordVersion );
1468 if ( srw_req->recordOldVersion ){
1469 rr.record_old_version = odr_strdup(assoc->encode,
1470 srw_req->recordOldVersion );
1472 if ( srw_req->extraRequestData ){
1473 rr.extra_request_data = odr_strdup(assoc->encode,
1474 srw_req->extraRequestData );
1477 else if ( !strcmp( rr.operation, "replace" ) ){
1478 if ( !srw_req->recordId ){
1479 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1480 &srw_res->num_diagnostics,
1484 rr.record_id = srw_req->recordId;
1486 if ( srw_req->record.recordSchema == 0 ){
1487 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1488 &srw_res->num_diagnostics,
1489 7, "recordSchema" );
1492 rr.record_schema = odr_strdup(assoc->encode,
1493 srw_req->record.recordSchema );
1495 switch (srw_req->record.recordPacking)
1497 case Z_SRW_recordPacking_string:
1498 rr.record_packing = "string";
1500 case Z_SRW_recordPacking_XML:
1501 rr.record_packing = "xml";
1503 case Z_SRW_recordPacking_URL:
1504 rr.record_packing = "url";
1507 if ( srw_req->record.recordData_len ){
1508 rr.record_data = odr_strdupn(assoc->encode,
1509 srw_req->record.recordData_buf,
1510 srw_req->record.recordData_len );
1511 rr.request_extra_record = srw_req->extra_record;
1514 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1515 &srw_res->num_diagnostics,
1518 if (srw_req->extraRequestData)
1519 rr.extra_request_data = odr_strdup(assoc->encode,
1520 srw_req->extraRequestData );
1522 else if ( !strcmp( rr.operation, "insert" ) )
1524 rr.record_id = srw_req->recordId;
1525 if ( srw_req->record.recordSchema == 0 ){
1526 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1527 &srw_res->num_diagnostics,
1528 7, "recordSchema" );
1531 rr.record_schema = odr_strdup(assoc->encode,
1532 srw_req->record.recordSchema);
1534 switch (srw_req->record.recordPacking)
1536 case Z_SRW_recordPacking_string:
1537 rr.record_packing = "string";
1539 case Z_SRW_recordPacking_XML:
1540 rr.record_packing = "xml";
1542 case Z_SRW_recordPacking_URL:
1543 rr.record_packing = "url";
1547 if (srw_req->record.recordData_len)
1549 rr.record_data = odr_strdupn(assoc->encode,
1550 srw_req->record.recordData_buf,
1551 srw_req->record.recordData_len );
1552 rr.request_extra_record = srw_req->extra_record;
1555 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1556 &srw_res->num_diagnostics,
1558 if ( srw_req->extraRequestData )
1559 rr.extra_request_data = odr_strdup(assoc->encode,
1560 srw_req->extraRequestData );
1562 if (srw_res->num_diagnostics == 0)
1564 if ( assoc->init->bend_srw_update)
1565 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1567 yaz_log( YLOG_WARN, "Got No Update function!");
1573 yaz_add_srw_diagnostic_uri(assoc->encode,
1574 &srw_res->diagnostics,
1575 &srw_res->num_diagnostics,
1579 srw_res->recordId = rr.record_id;
1580 srw_res->operationStatus = rr.operation_status;
1581 srw_res->recordVersion = rr.record_version;
1582 srw_res->recordChecksum = rr.record_checksum;
1583 srw_res->extraResponseData = rr.extra_response_data;
1584 srw_res->record.recordPosition = 0;
1585 if (srw_res->num_diagnostics == 0 && rr.record_data)
1587 srw_res->record.recordSchema = rr.record_schema;
1588 srw_res->record.recordPacking = srw_req->record.recordPacking;
1589 srw_res->record.recordData_buf = rr.record_data;
1590 srw_res->record.recordData_len = strlen(rr.record_data);
1591 srw_res->extra_record = rr.response_extra_record;
1595 srw_res->record.recordData_len = 0;
1600 /* check if path is OK (1); BAD (0) */
1601 static int check_path(const char *path)
1605 if (strstr(path, ".."))
1610 static char *read_file(const char *fname, ODR o, int *sz)
1613 FILE *inf = fopen(fname, "rb");
1617 fseek(inf, 0L, SEEK_END);
1620 buf = odr_malloc(o, *sz);
1621 fread(buf, 1, *sz, inf);
1626 static void process_http_request(association *assoc, request *req)
1628 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1629 ODR o = assoc->encode;
1630 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1632 Z_SOAP *soap_package = 0;
1635 Z_HTTP_Response *hres = 0;
1637 const char *stylesheet = 0; /* for now .. set later */
1638 Z_SRW_diagnostic *diagnostic = 0;
1639 int num_diagnostic = 0;
1640 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1642 if (!control_association(assoc, host, 0))
1644 p = z_get_HTTP_Response(o, 404);
1647 if (r == 2 && assoc->server && assoc->server->docpath
1648 && hreq->path[0] == '/'
1650 /* check if path is a proper prefix of documentroot */
1651 strncmp(hreq->path+1, assoc->server->docpath,
1652 strlen(assoc->server->docpath))
1655 if (!check_path(hreq->path))
1657 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1658 p = z_get_HTTP_Response(o, 404);
1662 int content_size = 0;
1663 char *content_buf = read_file(hreq->path+1, o, &content_size);
1666 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1667 p = z_get_HTTP_Response(o, 404);
1671 const char *ctype = 0;
1672 yaz_mime_types types = yaz_mime_types_create();
1674 yaz_mime_types_add(types, "xsl", "application/xml");
1675 yaz_mime_types_add(types, "xml", "application/xml");
1676 yaz_mime_types_add(types, "css", "text/css");
1677 yaz_mime_types_add(types, "html", "text/html");
1678 yaz_mime_types_add(types, "htm", "text/html");
1679 yaz_mime_types_add(types, "txt", "text/plain");
1680 yaz_mime_types_add(types, "js", "application/x-javascript");
1682 yaz_mime_types_add(types, "gif", "image/gif");
1683 yaz_mime_types_add(types, "png", "image/png");
1684 yaz_mime_types_add(types, "jpg", "image/jpeg");
1685 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1687 ctype = yaz_mime_lookup_fname(types, hreq->path);
1690 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1691 p = z_get_HTTP_Response(o, 404);
1695 p = z_get_HTTP_Response(o, 200);
1696 hres = p->u.HTTP_Response;
1697 hres->content_buf = content_buf;
1698 hres->content_len = content_size;
1699 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1701 yaz_mime_types_destroy(types);
1709 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1710 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1712 if (r == 2) /* not taken */
1714 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1715 &diagnostic, &num_diagnostic);
1716 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1718 if (r == 0) /* decode SRW/SRU OK .. */
1720 int http_code = 200;
1721 if (sr->which == Z_SRW_searchRetrieve_request)
1724 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1726 stylesheet = sr->u.request->stylesheet;
1729 res->u.response->diagnostics = diagnostic;
1730 res->u.response->num_diagnostics = num_diagnostic;
1734 srw_bend_search(assoc, req, sr, res->u.response,
1737 if (http_code == 200)
1738 soap_package->u.generic->p = res;
1740 else if (sr->which == Z_SRW_explain_request)
1742 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1743 stylesheet = sr->u.explain_request->stylesheet;
1746 res->u.explain_response->diagnostics = diagnostic;
1747 res->u.explain_response->num_diagnostics = num_diagnostic;
1749 srw_bend_explain(assoc, req, sr,
1750 res->u.explain_response, &http_code);
1751 if (http_code == 200)
1752 soap_package->u.generic->p = res;
1754 else if (sr->which == Z_SRW_scan_request)
1756 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1757 stylesheet = sr->u.scan_request->stylesheet;
1760 res->u.scan_response->diagnostics = diagnostic;
1761 res->u.scan_response->num_diagnostics = num_diagnostic;
1763 srw_bend_scan(assoc, req, sr,
1764 res->u.scan_response, &http_code);
1765 if (http_code == 200)
1766 soap_package->u.generic->p = res;
1768 else if (sr->which == Z_SRW_update_request)
1770 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1771 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1774 res->u.update_response->diagnostics = diagnostic;
1775 res->u.update_response->num_diagnostics = num_diagnostic;
1777 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1778 srw_bend_update(assoc, req, sr,
1779 res->u.update_response, &http_code);
1780 if (http_code == 200)
1781 soap_package->u.generic->p = res;
1785 yaz_log(log_request, "SOAP ERROR");
1786 /* FIXME - what error, what query */
1788 z_soap_error(assoc->encode, soap_package,
1789 "SOAP-ENV:Client", "Bad method", 0);
1791 if (http_code == 200 || http_code == 500)
1793 static Z_SOAP_Handler soap_handlers[4] = {
1795 {"http://www.loc.gov/zing/srw/", 0,
1796 (Z_SOAP_fun) yaz_srw_codec},
1797 {"http://www.loc.gov/zing/srw/v1.0/", 0,
1798 (Z_SOAP_fun) yaz_srw_codec},
1799 {"http://www.loc.gov/zing/srw/update/", 0,
1800 (Z_SOAP_fun) yaz_ucp_codec},
1806 p = z_get_HTTP_Response(o, 200);
1807 hres = p->u.HTTP_Response;
1809 if (!stylesheet && assoc->server)
1810 stylesheet = assoc->server->stylesheet;
1812 /* empty stylesheet means NO stylesheet */
1813 if (stylesheet && *stylesheet == '\0')
1816 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1817 &hres->content_buf, &hres->content_len,
1818 soap_handlers, charset, stylesheet);
1819 hres->code = http_code;
1821 strcpy(ctype, "text/xml");
1824 strcat(ctype, "; charset=");
1825 strcat(ctype, charset);
1827 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1830 p = z_get_HTTP_Response(o, http_code);
1834 p = z_get_HTTP_Response(o, 500);
1835 hres = p->u.HTTP_Response;
1836 if (!strcmp(hreq->version, "1.0"))
1838 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1839 if (v && !strcmp(v, "Keep-Alive"))
1843 hres->version = "1.0";
1847 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1848 if (v && !strcmp(v, "close"))
1852 hres->version = "1.1";
1856 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1857 assoc->state = ASSOC_DEAD;
1858 assoc->cs_get_mask = 0;
1863 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1865 if (alive && isdigit(*(const unsigned char *) alive))
1869 if (t < 0 || t > 3600)
1871 iochan_settimeout(assoc->client_chan,t);
1872 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1874 process_gdu_response(assoc, req, p);
1877 static void process_gdu_request(association *assoc, request *req)
1879 if (req->gdu_request->which == Z_GDU_Z3950)
1882 req->apdu_request = req->gdu_request->u.z3950;
1883 if (process_z_request(assoc, req, &msg) < 0)
1884 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1886 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1887 process_http_request(assoc, req);
1890 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1895 * Initiate request processing.
1897 static int process_z_request(association *assoc, request *req, char **msg)
1903 *msg = "Unknown Error";
1904 assert(req && req->state == REQUEST_IDLE);
1905 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1907 *msg = "Missing InitRequest";
1910 switch (req->apdu_request->which)
1912 case Z_APDU_initRequest:
1913 res = process_initRequest(assoc, req); break;
1914 case Z_APDU_searchRequest:
1915 res = process_searchRequest(assoc, req, &fd); break;
1916 case Z_APDU_presentRequest:
1917 res = process_presentRequest(assoc, req, &fd); break;
1918 case Z_APDU_scanRequest:
1919 if (assoc->init->bend_scan)
1920 res = process_scanRequest(assoc, req, &fd);
1923 *msg = "Cannot handle Scan APDU";
1927 case Z_APDU_extendedServicesRequest:
1928 if (assoc->init->bend_esrequest)
1929 res = process_ESRequest(assoc, req, &fd);
1932 *msg = "Cannot handle Extended Services APDU";
1936 case Z_APDU_sortRequest:
1937 if (assoc->init->bend_sort)
1938 res = process_sortRequest(assoc, req, &fd);
1941 *msg = "Cannot handle Sort APDU";
1946 process_close(assoc, req);
1948 case Z_APDU_deleteResultSetRequest:
1949 if (assoc->init->bend_delete)
1950 res = process_deleteRequest(assoc, req, &fd);
1953 *msg = "Cannot handle Delete APDU";
1957 case Z_APDU_segmentRequest:
1958 if (assoc->init->bend_segment)
1960 res = process_segmentRequest (assoc, req);
1964 *msg = "Cannot handle Segment APDU";
1968 case Z_APDU_triggerResourceControlRequest:
1971 *msg = "Bad APDU received";
1976 yaz_log(YLOG_DEBUG, " result immediately available");
1977 retval = process_z_response(assoc, req, res);
1981 yaz_log(YLOG_DEBUG, " result unavailble");
1984 else /* no result yet - one will be provided later */
1988 /* Set up an I/O handler for the fd supplied by the backend */
1990 yaz_log(YLOG_DEBUG, " establishing handler for result");
1991 req->state = REQUEST_PENDING;
1992 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
1994 iochan_setdata(chan, assoc);
2001 * Handle message from the backend.
2003 void backend_response(IOCHAN i, int event)
2005 association *assoc = (association *)iochan_getdata(i);
2006 request *req = request_head(&assoc->incoming);
2010 yaz_log(YLOG_DEBUG, "backend_response");
2011 assert(assoc && req && req->state != REQUEST_IDLE);
2012 /* determine what it is we're waiting for */
2013 switch (req->apdu_request->which)
2015 case Z_APDU_searchRequest:
2016 res = response_searchRequest(assoc, req, 0, &fd); break;
2018 case Z_APDU_presentRequest:
2019 res = response_presentRequest(assoc, req, 0, &fd); break;
2020 case Z_APDU_scanRequest:
2021 res = response_scanRequest(assoc, req, 0, &fd); break;
2024 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2027 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2029 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2030 do_close(assoc, Z_Close_systemProblem, 0);
2034 else if (!res) /* no result yet - try again later */
2036 yaz_log(YLOG_DEBUG, " no result yet");
2037 iochan_setfd(i, fd); /* in case fd has changed */
2042 * Encode response, and transfer the request structure to the outgoing queue.
2044 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2046 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2050 if (!z_GDU(assoc->print, &res, 0, 0))
2051 yaz_log(YLOG_WARN, "ODR print error: %s",
2052 odr_errmsg(odr_geterror(assoc->print)));
2053 odr_reset(assoc->print);
2055 if (!z_GDU(assoc->encode, &res, 0, 0))
2057 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2058 odr_errmsg(odr_geterror(assoc->decode)),
2059 odr_getelement(assoc->decode));
2062 req->response = odr_getbuf(assoc->encode, &req->len_response,
2063 &req->size_response);
2064 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2065 odr_reset(assoc->encode);
2066 req->state = REQUEST_IDLE;
2067 request_enq(&assoc->outgoing, req);
2068 /* turn the work over to the ir_session handler */
2069 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2070 assoc->cs_put_mask = EVENT_OUTPUT;
2071 /* Is there more work to be done? give that to the input handler too */
2073 if (request_head(&assoc->incoming))
2075 yaz_log (YLOG_DEBUG, "more work to be done");
2076 iochan_setevent(assoc->client_chan, EVENT_WORK);
2083 * Encode response, and transfer the request structure to the outgoing queue.
2085 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2087 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2088 gres->which = Z_GDU_Z3950;
2089 gres->u.z3950 = res;
2091 return process_gdu_response(assoc, req, gres);
2094 static char *get_vhost(Z_OtherInformation *otherInfo)
2096 return yaz_oi_get_string_oidval(&otherInfo, VAL_PROXY, 1, 0);
2100 * Handle init request.
2101 * At the moment, we don't check the options
2102 * anywhere else in the code - we just try not to do anything that would
2103 * break a naive client. We'll toss 'em into the association block when
2104 * we need them there.
2106 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2108 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2109 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2110 Z_InitResponse *resp = apdu->u.initResponse;
2111 bend_initresult *binitres;
2114 statserv_options_block *cb = 0; /* by default no control for backend */
2116 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2117 cb = statserv_getcontrol(); /* got control block for backend */
2119 if (cb && assoc->backend)
2120 (*cb->bend_close)(assoc->backend);
2122 yaz_log(log_requestdetail, "Got initRequest");
2123 if (req->implementationId)
2124 yaz_log(log_requestdetail, "Id: %s",
2125 req->implementationId);
2126 if (req->implementationName)
2127 yaz_log(log_requestdetail, "Name: %s",
2128 req->implementationName);
2129 if (req->implementationVersion)
2130 yaz_log(log_requestdetail, "Version: %s",
2131 req->implementationVersion);
2133 assoc_init_reset(assoc);
2135 assoc->init->auth = req->idAuthentication;
2136 assoc->init->referenceId = req->referenceId;
2138 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2140 Z_CharSetandLanguageNegotiation *negotiation =
2141 yaz_get_charneg_record (req->otherInfo);
2143 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2144 assoc->init->charneg_request = negotiation;
2150 if (req->implementationVersion)
2151 yaz_log(log_requestdetail, "Config: %s",
2154 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2156 /* we have a backend control block, so call that init function */
2157 if (!(binitres = (*cb->bend_init)(assoc->init)))
2159 yaz_log(YLOG_WARN, "Bad response from backend.");
2162 assoc->backend = binitres->handle;
2166 /* no backend. return error */
2167 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2168 binitres->errstring = 0;
2169 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2170 iochan_settimeout(assoc->client_chan, 10);
2172 if ((assoc->init->bend_sort))
2173 yaz_log (YLOG_DEBUG, "Sort handler installed");
2174 if ((assoc->init->bend_search))
2175 yaz_log (YLOG_DEBUG, "Search handler installed");
2176 if ((assoc->init->bend_present))
2177 yaz_log (YLOG_DEBUG, "Present handler installed");
2178 if ((assoc->init->bend_esrequest))
2179 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2180 if ((assoc->init->bend_delete))
2181 yaz_log (YLOG_DEBUG, "Delete handler installed");
2182 if ((assoc->init->bend_scan))
2183 yaz_log (YLOG_DEBUG, "Scan handler installed");
2184 if ((assoc->init->bend_segment))
2185 yaz_log (YLOG_DEBUG, "Segment handler installed");
2187 resp->referenceId = req->referenceId;
2189 /* let's tell the client what we can do */
2190 if (ODR_MASK_GET(req->options, Z_Options_search))
2192 ODR_MASK_SET(resp->options, Z_Options_search);
2193 strcat(options, "srch");
2195 if (ODR_MASK_GET(req->options, Z_Options_present))
2197 ODR_MASK_SET(resp->options, Z_Options_present);
2198 strcat(options, " prst");
2200 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2201 assoc->init->bend_delete)
2203 ODR_MASK_SET(resp->options, Z_Options_delSet);
2204 strcat(options, " del");
2206 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2207 assoc->init->bend_esrequest)
2209 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2210 strcat (options, " extendedServices");
2212 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2214 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2215 strcat(options, " namedresults");
2217 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2219 ODR_MASK_SET(resp->options, Z_Options_scan);
2220 strcat(options, " scan");
2222 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2224 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2225 strcat(options, " concurrop");
2227 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2229 ODR_MASK_SET(resp->options, Z_Options_sort);
2230 strcat(options, " sort");
2233 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
2234 && assoc->init->charneg_response)
2236 Z_OtherInformation **p;
2237 Z_OtherInformationUnit *p0;
2239 yaz_oi_APDU(apdu, &p);
2241 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2242 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2244 p0->which = Z_OtherInfo_externallyDefinedInfo;
2245 p0->information.externallyDefinedInfo =
2246 assoc->init->charneg_response;
2248 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2249 strcat(options, " negotiation");
2252 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2253 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2255 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2257 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2258 assoc->version = 1; /* 1 & 2 are equivalent */
2260 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2262 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2265 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2267 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2271 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2272 assoc->maximumRecordSize = *req->maximumRecordSize;
2274 if (cb && assoc->maximumRecordSize > cb->maxrecordsize)
2275 assoc->maximumRecordSize = cb->maxrecordsize;
2276 assoc->preferredMessageSize = *req->preferredMessageSize;
2277 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
2278 assoc->preferredMessageSize = assoc->maximumRecordSize;
2280 resp->preferredMessageSize = &assoc->preferredMessageSize;
2281 resp->maximumRecordSize = &assoc->maximumRecordSize;
2283 resp->implementationId = odr_prepend(assoc->encode,
2284 assoc->init->implementation_id,
2285 resp->implementationId);
2287 resp->implementationName = odr_prepend(assoc->encode,
2288 assoc->init->implementation_name,
2289 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2291 version = odr_strdup(assoc->encode, "$Revision: 1.87 $");
2292 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2293 version[strlen(version)-2] = '\0';
2294 resp->implementationVersion = odr_prepend(assoc->encode,
2295 assoc->init->implementation_version,
2296 odr_prepend(assoc->encode, &version[11],
2297 resp->implementationVersion));
2299 if (binitres->errcode)
2301 assoc->state = ASSOC_DEAD;
2302 resp->userInformationField =
2303 init_diagnostics(assoc->encode, binitres->errcode,
2304 binitres->errstring);
2309 if (!req->idAuthentication)
2310 yaz_log(log_request, "Auth none");
2311 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2313 const char *open = req->idAuthentication->u.open;
2314 const char *slash = strchr(open, '/');
2320 yaz_log(log_request, "Auth open %.*s", len, open);
2322 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2324 const char *user = req->idAuthentication->u.idPass->userId;
2325 const char *group = req->idAuthentication->u.idPass->groupId;
2326 yaz_log(log_request, "Auth idPass %s %s",
2327 user ? user : "-", group ? group : "-");
2329 else if (req->idAuthentication->which
2330 == Z_IdAuthentication_anonymous)
2332 yaz_log(log_request, "Auth anonymous");
2336 yaz_log(log_request, "Auth other");
2341 WRBUF wr = wrbuf_alloc();
2342 wrbuf_printf(wr, "Init ");
2343 if (binitres->errcode)
2344 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2346 wrbuf_printf(wr, "OK -");
2347 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2348 (req->implementationId ? req->implementationId :"-"),
2349 (req->implementationName ?
2350 req->implementationName : "-"),
2351 (req->implementationVersion ?
2352 req->implementationVersion : "-")
2354 yaz_log(log_request, "%s", wrbuf_buf(wr));
2361 * Set the specified `errcode' and `errstring' into a UserInfo-1
2362 * external to be returned to the client in accordance with Z35.90
2363 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2364 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2366 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2368 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2369 addinfo ? " -- " : "", addinfo ? addinfo : "");
2370 return zget_init_diagnostics(odr, error, addinfo);
2374 * nonsurrogate diagnostic record.
2376 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2378 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2380 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2381 addinfo ? " -- " : "", addinfo ? addinfo : "");
2383 rec->which = Z_Records_NSD;
2384 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2390 * surrogate diagnostic.
2392 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2394 int error, const char *addinfo)
2396 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2397 addinfo ? " -- " : "", addinfo ? addinfo : "");
2398 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2401 static Z_Records *pack_records(association *a, char *setname, int start,
2402 int *num, Z_RecordComposition *comp,
2403 int *next, int *pres, oid_value format,
2404 Z_ReferenceId *referenceId,
2405 int *oid, int *errcode)
2407 int recno, total_length = 0, toget = *num, dumped_records = 0;
2408 Z_Records *records =
2409 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2410 Z_NamePlusRecordList *reclist =
2411 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2412 Z_NamePlusRecord **list =
2413 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2415 records->which = Z_Records_DBOSD;
2416 records->u.databaseOrSurDiagnostics = reclist;
2417 reclist->num_records = 0;
2418 reclist->records = list;
2419 *pres = Z_PresentStatus_success;
2423 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2424 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2425 a->maximumRecordSize);
2426 for (recno = start; reclist->num_records < toget; recno++)
2429 Z_NamePlusRecord *thisrec;
2430 int this_length = 0;
2432 * we get the number of bytes allocated on the stream before any
2433 * allocation done by the backend - this should give us a reasonable
2434 * idea of the total size of the data so far.
2436 total_length = odr_total(a->encode) - dumped_records;
2442 freq.last_in_set = 0;
2443 freq.setname = setname;
2444 freq.surrogate_flag = 0;
2445 freq.number = recno;
2447 freq.request_format = format;
2448 freq.request_format_raw = oid;
2449 freq.output_format = format;
2450 freq.output_format_raw = 0;
2451 freq.stream = a->encode;
2452 freq.print = a->print;
2453 freq.referenceId = referenceId;
2456 retrieve_fetch(a, &freq);
2458 *next = freq.last_in_set ? 0 : recno + 1;
2460 /* backend should be able to signal whether error is system-wide
2461 or only pertaining to current record */
2464 if (!freq.surrogate_flag)
2467 *pres = Z_PresentStatus_failure;
2468 /* for 'present request out of range',
2469 set addinfo to record position if not set */
2470 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2471 freq.errstring == 0)
2473 sprintf (s, "%d", recno);
2477 *errcode = freq.errcode;
2478 return diagrec(a, freq.errcode, freq.errstring);
2480 reclist->records[reclist->num_records] =
2481 surrogatediagrec(a, freq.basename, freq.errcode,
2483 reclist->num_records++;
2486 if (freq.record == 0) /* no error and no record ? */
2488 *next = 0; /* signal end-of-set and stop */
2492 this_length = freq.len;
2494 this_length = odr_total(a->encode) - total_length - dumped_records;
2495 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2496 this_length, total_length, dumped_records);
2497 if (a->preferredMessageSize > 0 &&
2498 this_length + total_length > a->preferredMessageSize)
2500 /* record is small enough, really */
2501 if (this_length <= a->preferredMessageSize && recno > start)
2503 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2504 *pres = Z_PresentStatus_partial_2;
2507 /* record can only be fetched by itself */
2508 if (this_length < a->maximumRecordSize)
2510 yaz_log(log_requestdetail, " Record > prefmsgsz");
2513 yaz_log(YLOG_DEBUG, " Dropped it");
2514 reclist->records[reclist->num_records] =
2515 surrogatediagrec(a, freq.basename, 16, 0);
2516 reclist->num_records++;
2517 dumped_records += this_length;
2521 else /* too big entirely */
2523 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2524 this_length, a->maximumRecordSize);
2525 reclist->records[reclist->num_records] =
2526 surrogatediagrec(a, freq.basename, 17, 0);
2527 reclist->num_records++;
2528 dumped_records += this_length;
2533 if (!(thisrec = (Z_NamePlusRecord *)
2534 odr_malloc(a->encode, sizeof(*thisrec))))
2537 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2539 thisrec->databaseName = 0;
2540 thisrec->which = Z_NamePlusRecord_databaseRecord;
2542 if (freq.output_format_raw)
2544 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
2545 freq.output_format = ident->value;
2547 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
2548 freq.record, freq.len);
2549 if (!thisrec->u.databaseRecord)
2551 reclist->records[reclist->num_records] = thisrec;
2552 reclist->num_records++;
2554 *num = reclist->num_records;
2558 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2561 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2562 bend_search_rr *bsrr =
2563 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2565 yaz_log(log_requestdetail, "Got SearchRequest.");
2567 bsrr->request = reqb;
2568 bsrr->association = assoc;
2569 bsrr->referenceId = req->referenceId;
2570 save_referenceId (reqb, bsrr->referenceId);
2571 bsrr->srw_sortKeys = 0;
2572 bsrr->srw_setname = 0;
2573 bsrr->srw_setnameIdleTime = 0;
2575 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2576 if (req->databaseNames)
2579 for (i = 0; i < req->num_databaseNames; i++)
2580 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2583 yaz_log_zquery_level(log_requestdetail,req->query);
2585 if (assoc->init->bend_search)
2587 bsrr->setname = req->resultSetName;
2588 bsrr->replace_set = *req->replaceIndicator;
2589 bsrr->num_bases = req->num_databaseNames;
2590 bsrr->basenames = req->databaseNames;
2591 bsrr->query = req->query;
2592 bsrr->stream = assoc->encode;
2593 nmem_transfer(bsrr->stream->mem, reqb->request_mem);
2594 bsrr->decode = assoc->decode;
2595 bsrr->print = assoc->print;
2598 bsrr->errstring = NULL;
2599 bsrr->search_info = NULL;
2601 if (assoc->server && assoc->server->cql_transform
2602 && req->query->which == Z_Query_type_104
2603 && req->query->u.type_104->which == Z_External_CQL)
2605 /* have a CQL query and a CQL to PQF transform .. */
2607 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2608 assoc->server->cql_transform, bsrr->query);
2610 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2613 (assoc->init->bend_search)(assoc->backend, bsrr);
2614 if (!bsrr->request) /* backend not ready with the search response */
2615 return 0; /* should not be used any more */
2619 /* FIXME - make a diagnostic for it */
2620 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2622 return response_searchRequest(assoc, reqb, bsrr, fd);
2625 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2628 * Prepare a searchresponse based on the backend results. We probably want
2629 * to look at making the fetching of records nonblocking as well, but
2630 * so far, we'll keep things simple.
2631 * If bsrt is null, that means we're called in response to a communications
2632 * event, and we'll have to get the response for ourselves.
2634 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2635 bend_search_rr *bsrt, int *fd)
2637 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2638 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2639 Z_SearchResponse *resp = (Z_SearchResponse *)
2640 odr_malloc (assoc->encode, sizeof(*resp));
2641 int *nulint = odr_intdup (assoc->encode, 0);
2642 bool_t *sr = odr_intdup(assoc->encode, 1);
2643 int *next = odr_intdup(assoc->encode, 0);
2644 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2647 apdu->which = Z_APDU_searchResponse;
2648 apdu->u.searchResponse = resp;
2649 resp->referenceId = req->referenceId;
2650 resp->additionalSearchInfo = 0;
2651 resp->otherInfo = 0;
2653 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2655 yaz_log(YLOG_FATAL, "Bad result from backend");
2658 else if (bsrt->errcode)
2660 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2661 resp->resultCount = nulint;
2662 resp->numberOfRecordsReturned = nulint;
2663 resp->nextResultSetPosition = nulint;
2664 resp->searchStatus = nulint;
2665 resp->resultSetStatus = none;
2666 resp->presentStatus = 0;
2670 int *toget = odr_intdup(assoc->encode, 0);
2671 int *presst = odr_intdup(assoc->encode, 0);
2672 Z_RecordComposition comp, *compp = 0;
2674 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2677 resp->resultCount = &bsrt->hits;
2679 comp.which = Z_RecordComp_simple;
2680 /* how many records does the user agent want, then? */
2681 if (bsrt->hits <= *req->smallSetUpperBound)
2683 *toget = bsrt->hits;
2684 if ((comp.u.simple = req->smallSetElementSetNames))
2687 else if (bsrt->hits < *req->largeSetLowerBound)
2689 *toget = *req->mediumSetPresentNumber;
2690 if (*toget > bsrt->hits)
2691 *toget = bsrt->hits;
2692 if ((comp.u.simple = req->mediumSetElementSetNames))
2698 if (*toget && !resp->records)
2703 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2706 form = prefformat->value;
2708 /* Call bend_present if defined */
2709 if (assoc->init->bend_present)
2711 bend_present_rr *bprr = (bend_present_rr *)
2712 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2713 bprr->setname = req->resultSetName;
2715 bprr->number = *toget;
2716 bprr->format = form;
2718 bprr->referenceId = req->referenceId;
2719 bprr->stream = assoc->encode;
2720 bprr->print = assoc->print;
2721 bprr->request = reqb;
2722 bprr->association = assoc;
2724 bprr->errstring = NULL;
2725 (*assoc->init->bend_present)(assoc->backend, bprr);
2731 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2732 *resp->presentStatus = Z_PresentStatus_failure;
2737 resp->records = pack_records(assoc, req->resultSetName, 1,
2738 toget, compp, next, presst, form, req->referenceId,
2739 req->preferredRecordSyntax, NULL);
2742 resp->numberOfRecordsReturned = toget;
2743 returnedrecs = *toget;
2744 resp->nextResultSetPosition = next;
2745 resp->searchStatus = sr;
2746 resp->resultSetStatus = 0;
2747 resp->presentStatus = presst;
2751 if (*resp->resultCount)
2753 resp->numberOfRecordsReturned = nulint;
2754 resp->nextResultSetPosition = next;
2755 resp->searchStatus = sr;
2756 resp->resultSetStatus = 0;
2757 resp->presentStatus = 0;
2760 resp->additionalSearchInfo = bsrt->search_info;
2764 WRBUF wr = wrbuf_alloc();
2766 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2768 wrbuf_printf(wr, "OK %d", bsrt->hits);
2769 wrbuf_printf(wr, " %s 1+%d ",
2770 req->resultSetName, returnedrecs);
2771 yaz_query_to_wrbuf(wr, req->query);
2773 yaz_log(log_request, "Search %s", wrbuf_buf(wr));
2780 * Maybe we got a little over-friendly when we designed bend_fetch to
2781 * get only one record at a time. Some backends can optimise multiple-record
2782 * fetches, and at any rate, there is some overhead involved in
2783 * all that selecting and hopping around. Problem is, of course, that the
2784 * frontend can't know ahead of time how many records it'll need to
2785 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2786 * is downright lousy as a bulk data transfer protocol.
2788 * To start with, we'll do the fetching of records from the backend
2789 * in one operation: To save some trips in and out of the event-handler,
2790 * and to simplify the interface to pack_records. At any rate, asynch
2791 * operation is more fun in operations that have an unpredictable execution
2792 * speed - which is normally more true for search than for present.
2794 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2797 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2801 Z_PresentResponse *resp;
2805 const char *errstring = 0;
2807 yaz_log(log_requestdetail, "Got PresentRequest.");
2809 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2812 form = prefformat->value;
2813 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2815 resp->presentStatus = odr_intdup(assoc->encode, 0);
2816 if (assoc->init->bend_present)
2818 bend_present_rr *bprr = (bend_present_rr *)
2819 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2820 bprr->setname = req->resultSetId;
2821 bprr->start = *req->resultSetStartPoint;
2822 bprr->number = *req->numberOfRecordsRequested;
2823 bprr->format = form;
2824 bprr->comp = req->recordComposition;
2825 bprr->referenceId = req->referenceId;
2826 bprr->stream = assoc->encode;
2827 bprr->print = assoc->print;
2828 bprr->request = reqb;
2829 bprr->association = assoc;
2831 bprr->errstring = NULL;
2832 (*assoc->init->bend_present)(assoc->backend, bprr);
2835 return 0; /* should not happen */
2838 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2839 *resp->presentStatus = Z_PresentStatus_failure;
2840 errcode = bprr->errcode;
2841 errstring = bprr->errstring;
2844 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2845 next = odr_intdup(assoc->encode, 0);
2846 num = odr_intdup(assoc->encode, 0);
2848 apdu->which = Z_APDU_presentResponse;
2849 apdu->u.presentResponse = resp;
2850 resp->referenceId = req->referenceId;
2851 resp->otherInfo = 0;
2855 *num = *req->numberOfRecordsRequested;
2857 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2858 num, req->recordComposition, next,
2859 resp->presentStatus,
2860 form, req->referenceId, req->preferredRecordSyntax,
2865 WRBUF wr = wrbuf_alloc();
2866 wrbuf_printf(wr, "Present ");
2868 if (*resp->presentStatus == Z_PresentStatus_failure)
2869 wrbuf_printf(wr, "ERROR %d", errcode);
2870 else if (*resp->presentStatus == Z_PresentStatus_success)
2871 wrbuf_printf(wr, "OK -");
2873 wrbuf_printf(wr, "Partial %d", *resp->presentStatus);
2875 wrbuf_printf(wr, " %s %d+%d ",
2876 req->resultSetId, *req->resultSetStartPoint,
2877 *req->numberOfRecordsRequested);
2878 yaz_log(log_request, "%s", wrbuf_buf(wr) );
2883 resp->numberOfRecordsReturned = num;
2884 resp->nextResultSetPosition = next;
2890 * Scan was implemented rather in a hurry, and with support for only the basic
2891 * elements of the service in the backend API. Suggestions are welcome.
2893 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2895 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2896 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2897 Z_ScanResponse *res = (Z_ScanResponse *)
2898 odr_malloc (assoc->encode, sizeof(*res));
2899 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2900 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2901 Z_ListEntries *ents = (Z_ListEntries *)
2902 odr_malloc (assoc->encode, sizeof(*ents));
2903 Z_DiagRecs *diagrecs_p = NULL;
2905 bend_scan_rr *bsrr = (bend_scan_rr *)
2906 odr_malloc (assoc->encode, sizeof(*bsrr));
2907 struct scan_entry *save_entries;
2909 yaz_log(log_requestdetail, "Got ScanRequest");
2911 apdu->which = Z_APDU_scanResponse;
2912 apdu->u.scanResponse = res;
2913 res->referenceId = req->referenceId;
2915 /* if step is absent, set it to 0 */
2916 res->stepSize = odr_intdup(assoc->encode, 0);
2918 *res->stepSize = *req->stepSize;
2920 res->scanStatus = scanStatus;
2921 res->numberOfEntriesReturned = numberOfEntriesReturned;
2922 res->positionOfTerm = 0;
2923 res->entries = ents;
2924 ents->num_entries = 0;
2925 ents->entries = NULL;
2926 ents->num_nonsurrogateDiagnostics = 0;
2927 ents->nonsurrogateDiagnostics = NULL;
2928 res->attributeSet = 0;
2931 if (req->databaseNames)
2934 for (i = 0; i < req->num_databaseNames; i++)
2935 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2937 bsrr->scanClause = 0;
2939 bsrr->errstring = 0;
2940 bsrr->num_bases = req->num_databaseNames;
2941 bsrr->basenames = req->databaseNames;
2942 bsrr->num_entries = *req->numberOfTermsRequested;
2943 bsrr->term = req->termListAndStartPoint;
2944 bsrr->referenceId = req->referenceId;
2945 bsrr->stream = assoc->encode;
2946 bsrr->print = assoc->print;
2947 bsrr->step_size = res->stepSize;
2949 /* For YAZ 2.0 and earlier it was the backend handler that
2950 initialized entries (member display_term did not exist)
2951 YAZ 2.0 and later sets 'entries' and initialize all members
2952 including 'display_term'. If YAZ 2.0 or later sees that
2953 entries was modified - we assume that it is an old handler and
2954 that 'display_term' is _not_ set.
2956 if (bsrr->num_entries > 0)
2959 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
2961 for (i = 0; i<bsrr->num_entries; i++)
2963 bsrr->entries[i].term = 0;
2964 bsrr->entries[i].occurrences = 0;
2965 bsrr->entries[i].errcode = 0;
2966 bsrr->entries[i].errstring = 0;
2967 bsrr->entries[i].display_term = 0;
2970 save_entries = bsrr->entries; /* save it so we can compare later */
2972 if (req->attributeSet &&
2973 (attset = oid_getentbyoid(req->attributeSet)) &&
2974 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
2975 bsrr->attributeset = attset->value;
2977 bsrr->attributeset = VAL_NONE;
2978 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
2979 bsrr->attributeset);
2980 bsrr->term_position = req->preferredPositionInResponse ?
2981 *req->preferredPositionInResponse : 1;
2983 ((int (*)(void *, bend_scan_rr *))
2984 (*assoc->init->bend_scan))(assoc->backend, bsrr);
2987 diagrecs_p = zget_DiagRecs(assoc->encode,
2988 bsrr->errcode, bsrr->errstring);
2992 Z_Entry **tab = (Z_Entry **)
2993 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
2995 if (bsrr->status == BEND_SCAN_PARTIAL)
2996 *scanStatus = Z_Scan_partial_5;
2998 *scanStatus = Z_Scan_success;
2999 ents->entries = tab;
3000 ents->num_entries = bsrr->num_entries;
3001 res->numberOfEntriesReturned = &ents->num_entries;
3002 res->positionOfTerm = &bsrr->term_position;
3003 for (i = 0; i < bsrr->num_entries; i++)
3009 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3010 if (bsrr->entries[i].occurrences >= 0)
3012 e->which = Z_Entry_termInfo;
3013 e->u.termInfo = t = (Z_TermInfo *)
3014 odr_malloc(assoc->encode, sizeof(*t));
3015 t->suggestedAttributes = 0;
3017 if (save_entries == bsrr->entries &&
3018 bsrr->entries[i].display_term)
3020 /* the entries was _not_ set by the handler. So it's
3021 safe to test for new member display_term. It is
3024 t->displayTerm = odr_strdup(assoc->encode,
3025 bsrr->entries[i].display_term);
3027 t->alternativeTerm = 0;
3028 t->byAttributes = 0;
3029 t->otherTermInfo = 0;
3030 t->globalOccurrences = &bsrr->entries[i].occurrences;
3031 t->term = (Z_Term *)
3032 odr_malloc(assoc->encode, sizeof(*t->term));
3033 t->term->which = Z_Term_general;
3034 t->term->u.general = o =
3035 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3036 o->buf = (unsigned char *)
3037 odr_malloc(assoc->encode, o->len = o->size =
3038 strlen(bsrr->entries[i].term));
3039 memcpy(o->buf, bsrr->entries[i].term, o->len);
3040 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3041 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3045 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3046 bsrr->entries[i].errcode,
3047 bsrr->entries[i].errstring);
3048 assert (drecs->num_diagRecs == 1);
3049 e->which = Z_Entry_surrogateDiagnostic;
3050 assert (drecs->diagRecs[0]);
3051 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3057 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3058 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3062 WRBUF wr = wrbuf_alloc();
3064 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3065 else if (*res->scanStatus == Z_Scan_success)
3066 wrbuf_printf(wr, "OK");
3068 wrbuf_printf(wr, "Partial");
3070 wrbuf_printf(wr, " %d+%d %d ",
3071 (req->preferredPositionInResponse ?
3072 *req->preferredPositionInResponse : 1),
3073 *req->numberOfTermsRequested,
3074 (res->stepSize ? *res->stepSize : 0));
3075 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3076 bsrr->attributeset);
3077 yaz_log(log_request, "Scan %s", wrbuf_buf(wr) );
3083 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3087 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3088 Z_SortResponse *res = (Z_SortResponse *)
3089 odr_malloc (assoc->encode, sizeof(*res));
3090 bend_sort_rr *bsrr = (bend_sort_rr *)
3091 odr_malloc (assoc->encode, sizeof(*bsrr));
3093 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3095 yaz_log(log_requestdetail, "Got SortRequest.");
3097 bsrr->num_input_setnames = req->num_inputResultSetNames;
3098 for (i=0;i<req->num_inputResultSetNames;i++)
3099 yaz_log(log_requestdetail, "Input resultset: '%s'",
3100 req->inputResultSetNames[i]);
3101 bsrr->input_setnames = req->inputResultSetNames;
3102 bsrr->referenceId = req->referenceId;
3103 bsrr->output_setname = req->sortedResultSetName;
3104 yaz_log(log_requestdetail, "Output resultset: '%s'",
3105 req->sortedResultSetName);
3106 bsrr->sort_sequence = req->sortSequence;
3107 /*FIXME - dump those sequences too */
3108 bsrr->stream = assoc->encode;
3109 bsrr->print = assoc->print;
3111 bsrr->sort_status = Z_SortResponse_failure;
3113 bsrr->errstring = 0;
3115 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3117 res->referenceId = bsrr->referenceId;
3118 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3119 res->resultSetStatus = 0;
3122 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3123 bsrr->errcode, bsrr->errstring);
3124 res->diagnostics = dr->diagRecs;
3125 res->num_diagnostics = dr->num_diagRecs;
3129 res->num_diagnostics = 0;
3130 res->diagnostics = 0;
3132 res->resultCount = 0;
3135 apdu->which = Z_APDU_sortResponse;
3136 apdu->u.sortResponse = res;
3139 WRBUF wr = wrbuf_alloc();
3140 wrbuf_printf(wr, "Sort ");
3142 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3144 wrbuf_printf(wr, "OK -");
3145 wrbuf_printf(wr, " (");
3146 for (i = 0; i<req->num_inputResultSetNames; i++)
3149 wrbuf_printf(wr, ",");
3150 wrbuf_printf(wr, req->inputResultSetNames[i]);
3152 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3154 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3160 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3164 Z_DeleteResultSetRequest *req =
3165 reqb->apdu_request->u.deleteResultSetRequest;
3166 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3167 odr_malloc (assoc->encode, sizeof(*res));
3168 bend_delete_rr *bdrr = (bend_delete_rr *)
3169 odr_malloc (assoc->encode, sizeof(*bdrr));
3170 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3172 yaz_log(log_requestdetail, "Got DeleteRequest.");
3174 bdrr->num_setnames = req->num_resultSetList;
3175 bdrr->setnames = req->resultSetList;
3176 for (i = 0; i<req->num_resultSetList; i++)
3177 yaz_log(log_requestdetail, "resultset: '%s'",
3178 req->resultSetList[i]);
3179 bdrr->stream = assoc->encode;
3180 bdrr->print = assoc->print;
3181 bdrr->function = *req->deleteFunction;
3182 bdrr->referenceId = req->referenceId;
3184 if (bdrr->num_setnames > 0)
3186 bdrr->statuses = (int*)
3187 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3188 bdrr->num_setnames);
3189 for (i = 0; i < bdrr->num_setnames; i++)
3190 bdrr->statuses[i] = 0;
3192 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3194 res->referenceId = req->referenceId;
3196 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3198 res->deleteListStatuses = 0;
3199 if (bdrr->num_setnames > 0)
3202 res->deleteListStatuses = (Z_ListStatuses *)
3203 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3204 res->deleteListStatuses->num = bdrr->num_setnames;
3205 res->deleteListStatuses->elements =
3207 odr_malloc (assoc->encode,
3208 sizeof(*res->deleteListStatuses->elements) *
3209 bdrr->num_setnames);
3210 for (i = 0; i<bdrr->num_setnames; i++)
3212 res->deleteListStatuses->elements[i] =
3214 odr_malloc (assoc->encode,
3215 sizeof(**res->deleteListStatuses->elements));
3216 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3217 res->deleteListStatuses->elements[i]->id =
3218 odr_strdup (assoc->encode, bdrr->setnames[i]);
3221 res->numberNotDeleted = 0;
3222 res->bulkStatuses = 0;
3223 res->deleteMessage = 0;
3226 apdu->which = Z_APDU_deleteResultSetResponse;
3227 apdu->u.deleteResultSetResponse = res;
3230 WRBUF wr = wrbuf_alloc();
3231 wrbuf_printf(wr, "Delete ");
3232 if (bdrr->delete_status)
3233 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3235 wrbuf_printf(wr, "OK -");
3236 for (i = 0; i<req->num_resultSetList; i++)
3237 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3238 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3244 static void process_close(association *assoc, request *reqb)
3246 Z_Close *req = reqb->apdu_request->u.close;
3247 static char *reasons[] =
3254 "securityViolation",
3261 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3262 reasons[*req->closeReason], req->diagnosticInformation ?
3263 req->diagnosticInformation : "NULL");
3264 if (assoc->version < 3) /* to make do_force respond with close */
3266 do_close_req(assoc, Z_Close_finished,
3267 "Association terminated by client", reqb);
3268 yaz_log(log_request,"Close OK");
3271 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3275 reqb->len_refid = refid->len;
3276 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3277 memcpy (reqb->refid, refid->buf, refid->len);
3281 reqb->len_refid = 0;
3286 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3288 process_z_response (a, req, res);
3291 bend_request bend_request_mk (bend_association a)
3293 request *nreq = request_get (&a->outgoing);
3294 nreq->request_mem = nmem_create ();
3298 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3303 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3304 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3305 id->len = id->size = req->len_refid;
3306 memcpy (id->buf, req->refid, req->len_refid);
3310 void bend_request_destroy (bend_request *req)
3312 nmem_destroy((*req)->request_mem);
3313 request_release(*req);
3317 int bend_backend_respond (bend_association a, bend_request req)
3321 r = process_z_request (a, req, &msg);
3323 yaz_log (YLOG_WARN, "%s", msg);
3327 void bend_request_setdata(bend_request r, void *p)
3332 void *bend_request_getdata(bend_request r)
3334 return r->clientData;
3337 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3339 bend_segment_rr req;
3341 req.segment = reqb->apdu_request->u.segmentRequest;
3342 req.stream = assoc->encode;
3343 req.decode = assoc->decode;
3344 req.print = assoc->print;
3345 req.association = assoc;
3347 (*assoc->init->bend_segment)(assoc->backend, &req);
3352 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3354 bend_esrequest_rr esrequest;
3355 const char *ext_name = "unknown";
3357 Z_ExtendedServicesRequest *req =
3358 reqb->apdu_request->u.extendedServicesRequest;
3359 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3361 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3363 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3364 esrequest.stream = assoc->encode;
3365 esrequest.decode = assoc->decode;
3366 esrequest.print = assoc->print;
3367 esrequest.errcode = 0;
3368 esrequest.errstring = NULL;
3369 esrequest.request = reqb;
3370 esrequest.association = assoc;
3371 esrequest.taskPackage = 0;
3372 esrequest.referenceId = req->referenceId;
3375 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3377 switch(esrequest.esr->taskSpecificParameters->which)
3379 case Z_External_itemOrder:
3380 ext_name = "ItemOrder"; break;
3381 case Z_External_update:
3382 ext_name = "Update"; break;
3383 case Z_External_update0:
3384 ext_name = "Update0"; break;
3385 case Z_External_ESAdmin:
3386 ext_name = "Admin"; break;
3391 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3393 /* If the response is being delayed, return NULL */
3394 if (esrequest.request == NULL)
3397 resp->referenceId = req->referenceId;
3399 if (esrequest.errcode == -1)
3401 /* Backend service indicates request will be processed */
3402 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3403 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3405 else if (esrequest.errcode == 0)
3407 /* Backend service indicates request will be processed */
3408 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3409 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3413 Z_DiagRecs *diagRecs =
3414 zget_DiagRecs(assoc->encode, esrequest.errcode,
3415 esrequest.errstring);
3416 /* Backend indicates error, request will not be processed */
3417 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3418 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3419 resp->num_diagnostics = diagRecs->num_diagRecs;
3420 resp->diagnostics = diagRecs->diagRecs;
3423 WRBUF wr = wrbuf_alloc();
3424 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3425 yaz_log(log_request, "EsRequest %s", wrbuf_buf(wr) );
3430 /* Do something with the members of bend_extendedservice */
3431 if (esrequest.taskPackage)
3432 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
3433 (const char *) esrequest.taskPackage,
3435 yaz_log(YLOG_DEBUG,"Send the result apdu");
3442 * indent-tabs-mode: nil
3444 * vim: shiftwidth=4 tabstop=8 expandtab