2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.98 2006-09-06 09:35:41 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; /* one-line logs for session */
106 static int log_sessiondetail = 0; /* more detailed stuff */
107 static int log_request = 0; /* one-line logs for requests */
108 static int log_requestdetail = 0; /* more detailed stuff */
110 /** get_logbits sets global loglevel bits */
111 static void get_logbits()
112 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
116 log_session = yaz_log_module_level("session");
117 log_sessiondetail = yaz_log_module_level("sessiondetail");
118 log_request = yaz_log_module_level("request");
119 log_requestdetail = yaz_log_module_level("requestdetail");
125 static void wr_diag(WRBUF w, int error, const char *addinfo)
127 wrbuf_printf(w, "ERROR %d+", error);
128 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
131 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
139 * Create and initialize a new association-handle.
140 * channel : iochannel for the current line.
141 * link : communications channel.
142 * Returns: 0 or a new association handle.
144 association *create_association(IOCHAN channel, COMSTACK link,
145 const char *apdufile)
151 if (!(anew = (association *)xmalloc(sizeof(*anew))))
155 anew->last_control = 0;
156 anew->client_chan = channel;
157 anew->client_link = link;
158 anew->cs_get_mask = 0;
159 anew->cs_put_mask = 0;
160 anew->cs_accept_mask = 0;
161 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
162 !(anew->encode = odr_createmem(ODR_ENCODE)))
164 if (apdufile && *apdufile)
168 if (!(anew->print = odr_createmem(ODR_PRINT)))
170 if (*apdufile == '@')
172 odr_setprint(anew->print, yaz_log_file());
174 else if (*apdufile != '-')
177 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
178 if (!(f = fopen(filename, "w")))
180 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
183 setvbuf(f, 0, _IONBF, 0);
184 odr_setprint(anew->print, f);
189 anew->input_buffer = 0;
190 anew->input_buffer_len = 0;
192 anew->state = ASSOC_NEW;
193 request_initq(&anew->incoming);
194 request_initq(&anew->outgoing);
195 anew->proto = cs_getproto(link);
201 * Free association and release resources.
203 void destroy_association(association *h)
205 statserv_options_block *cb = statserv_getcontrol();
209 odr_destroy(h->decode);
210 odr_destroy(h->encode);
212 odr_destroy(h->print);
214 xfree(h->input_buffer);
216 (*cb->bend_close)(h->backend);
217 while ((req = request_deq(&h->incoming)))
218 request_release(req);
219 while ((req = request_deq(&h->outgoing)))
220 request_release(req);
221 request_delq(&h->incoming);
222 request_delq(&h->outgoing);
224 xmalloc_trav("session closed");
225 if (cb && cb->one_shot)
231 static void do_close_req(association *a, int reason, char *message,
235 Z_Close *cls = zget_Close(a->encode);
237 /* Purge request queue */
238 while (request_deq(&a->incoming));
239 while (request_deq(&a->outgoing));
242 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
243 reason, message ? message : "none");
244 apdu.which = Z_APDU_close;
246 *cls->closeReason = reason;
247 cls->diagnosticInformation = message;
248 process_z_response(a, req, &apdu);
249 iochan_settimeout(a->client_chan, 20);
253 request_release(req);
254 yaz_log(log_requestdetail, "v2 client. No Close PDU");
255 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
258 a->state = ASSOC_DEAD;
261 static void do_close(association *a, int reason, char *message)
263 request *req = request_get(&a->outgoing);
264 do_close_req (a, reason, message, req);
268 * This is where PDUs from the client are read and the further
269 * processing is initiated. Flow of control moves down through the
270 * various process_* functions below, until the encoded result comes back up
271 * to the output handler in here.
273 * h : the I/O channel that has an outstanding event.
274 * event : the current outstanding event.
276 void ir_session(IOCHAN h, int event)
279 association *assoc = (association *)iochan_getdata(h);
280 COMSTACK conn = assoc->client_link;
283 assert(h && conn && assoc);
284 if (event == EVENT_TIMEOUT)
286 if (assoc->state != ASSOC_UP)
288 yaz_log(YLOG_DEBUG, "Final timeout - closing connection.");
289 /* do we need to lod this at all */
291 destroy_association(assoc);
296 yaz_log(log_sessiondetail,
297 "Session idle too long. Sending close.");
298 do_close(assoc, Z_Close_lackOfActivity, 0);
302 if (event & assoc->cs_accept_mask)
304 if (!cs_accept (conn))
306 yaz_log (YLOG_WARN, "accept failed");
307 destroy_association(assoc);
310 iochan_clearflag (h, EVENT_OUTPUT);
311 if (conn->io_pending)
312 { /* cs_accept didn't complete */
313 assoc->cs_accept_mask =
314 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
315 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
317 iochan_setflag (h, assoc->cs_accept_mask);
320 { /* cs_accept completed. Prepare for reading (cs_get) */
321 assoc->cs_accept_mask = 0;
322 assoc->cs_get_mask = EVENT_INPUT;
323 iochan_setflag (h, assoc->cs_get_mask);
327 if ((event & assoc->cs_get_mask) || (event & EVENT_WORK)) /* input */
329 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
331 yaz_log(YLOG_DEBUG, "ir_session (input)");
332 /* We aren't speaking to this fellow */
333 if (assoc->state == ASSOC_DEAD)
335 yaz_log(log_sessiondetail, "Connection closed - end of session");
337 destroy_association(assoc);
341 assoc->cs_get_mask = EVENT_INPUT;
342 res = cs_get(conn, &assoc->input_buffer,
343 &assoc->input_buffer_len);
344 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
346 yaz_log(log_session, "Connection error: %s res=%d",
347 cs_errmsg(cs_errno(conn)), res);
348 req = request_get(&assoc->incoming); /* get a new request */
349 do_close_req(assoc, Z_Close_protocolError,
350 "Incoming package too large", req);
355 yaz_log(log_sessiondetail, "Connection closed by client");
357 destroy_association(assoc);
361 else if (res == 1) /* incomplete read - wait for more */
363 if (conn->io_pending & CS_WANT_WRITE)
364 assoc->cs_get_mask |= EVENT_OUTPUT;
365 iochan_setflag(h, assoc->cs_get_mask);
368 if (cs_more(conn)) /* more stuff - call us again later, please */
369 iochan_setevent(h, EVENT_INPUT);
371 /* we got a complete PDU. Let's decode it */
372 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
373 assoc->input_buffer[0] & 0xff,
374 assoc->input_buffer[1] & 0xff,
375 assoc->input_buffer[2] & 0xff);
376 req = request_get(&assoc->incoming); /* get a new request */
377 odr_reset(assoc->decode);
378 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
379 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
381 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
383 odr_errmsg(odr_geterror(assoc->decode)),
384 odr_getelement(assoc->decode),
385 (long) odr_offset(assoc->decode));
386 if (assoc->decode->error != OHTTP)
388 yaz_log(YLOG_WARN, "PDU dump:");
389 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
390 request_release(req);
391 do_close(assoc, Z_Close_protocolError, "Malformed package");
395 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
396 assoc->state = ASSOC_DEAD;
397 process_gdu_response(assoc, req, p);
401 req->request_mem = odr_extract_mem(assoc->decode);
404 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
405 yaz_log(YLOG_WARN, "ODR print error: %s",
406 odr_errmsg(odr_geterror(assoc->print)));
407 odr_reset(assoc->print);
409 request_enq(&assoc->incoming, req);
412 /* can we do something yet? */
413 req = request_head(&assoc->incoming);
414 if (req->state == REQUEST_IDLE)
416 request_deq(&assoc->incoming);
417 process_gdu_request(assoc, req);
420 if (event & assoc->cs_put_mask)
422 request *req = request_head(&assoc->outgoing);
424 assoc->cs_put_mask = 0;
425 yaz_log(YLOG_DEBUG, "ir_session (output)");
426 req->state = REQUEST_PENDING;
427 switch (res = cs_put(conn, req->response, req->len_response))
430 yaz_log(log_sessiondetail, "Connection closed by client");
432 destroy_association(assoc);
435 case 0: /* all sent - release the request structure */
436 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
438 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
441 nmem_destroy(req->request_mem);
442 request_deq(&assoc->outgoing);
443 request_release(req);
444 if (!request_head(&assoc->outgoing))
445 { /* restore mask for cs_get operation ... */
446 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
447 iochan_setflag(h, assoc->cs_get_mask);
448 if (assoc->state == ASSOC_DEAD)
449 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
453 assoc->cs_put_mask = EVENT_OUTPUT;
457 if (conn->io_pending & CS_WANT_WRITE)
458 assoc->cs_put_mask |= EVENT_OUTPUT;
459 if (conn->io_pending & CS_WANT_READ)
460 assoc->cs_put_mask |= EVENT_INPUT;
461 iochan_setflag(h, assoc->cs_put_mask);
464 if (event & EVENT_EXCEPT)
466 yaz_log(YLOG_WARN, "ir_session (exception)");
468 destroy_association(assoc);
473 static int process_z_request(association *assoc, request *req, char **msg);
476 static void assoc_init_reset(association *assoc)
479 assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
481 assoc->init->stream = assoc->encode;
482 assoc->init->print = assoc->print;
483 assoc->init->auth = 0;
484 assoc->init->referenceId = 0;
485 assoc->init->implementation_version = 0;
486 assoc->init->implementation_id = 0;
487 assoc->init->implementation_name = 0;
488 assoc->init->bend_sort = NULL;
489 assoc->init->bend_search = NULL;
490 assoc->init->bend_present = NULL;
491 assoc->init->bend_esrequest = NULL;
492 assoc->init->bend_delete = NULL;
493 assoc->init->bend_scan = NULL;
494 assoc->init->bend_segment = NULL;
495 assoc->init->bend_fetch = NULL;
496 assoc->init->bend_explain = NULL;
497 assoc->init->bend_srw_scan = NULL;
498 assoc->init->bend_srw_update = NULL;
500 assoc->init->charneg_request = NULL;
501 assoc->init->charneg_response = NULL;
503 assoc->init->decode = assoc->decode;
504 assoc->init->peer_name =
505 odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
507 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
510 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
512 statserv_options_block *cb = statserv_getcontrol();
515 const char *encoding = "UTF-8";
517 bend_initresult *binitres;
519 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
520 assoc_init_reset(assoc);
524 Z_IdAuthentication *auth = odr_malloc(assoc->decode, sizeof(*auth));
527 len = strlen(sr->username) + 1;
529 len += strlen(sr->password) + 2;
530 auth->which = Z_IdAuthentication_open;
531 auth->u.open = odr_malloc(assoc->decode, len);
532 strcpy(auth->u.open, sr->username);
533 if (sr->password && *sr->password)
535 strcat(auth->u.open, "/");
536 strcat(auth->u.open, sr->password);
538 assoc->init->auth = auth;
542 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
543 assoc->init->charneg_request = ce->u.charNeg3;
546 if (!(binitres = (*cb->bend_init)(assoc->init)))
548 assoc->state = ASSOC_DEAD;
549 yaz_add_srw_diagnostic(assoc->encode, d, num,
550 YAZ_SRW_AUTHENTICATION_ERROR, 0);
553 assoc->backend = binitres->handle;
554 assoc->init->auth = 0;
555 if (binitres->errcode)
557 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
558 assoc->state = ASSOC_DEAD;
559 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
560 binitres->errstring);
568 static const char *get_esn(Z_RecordComposition *comp)
570 if (comp && comp->which == Z_RecordComp_complex)
572 if (comp->u.complex->generic
573 && comp->u.complex->generic->elementSpec
574 && (comp->u.complex->generic->elementSpec->which ==
575 Z_ElementSpec_elementSetName))
576 return comp->u.complex->generic->elementSpec->u.elementSetName;
578 else if (comp && comp->which == Z_RecordComp_simple &&
579 comp->u.simple->which == Z_ElementSetNames_generic)
580 return comp->u.simple->u.generic;
584 static void set_esn(Z_RecordComposition **comp_p, const char *esn, NMEM nmem)
586 Z_RecordComposition *comp = nmem_malloc(nmem, sizeof(*comp));
588 comp->which = Z_RecordComp_simple;
589 comp->u.simple = nmem_malloc(nmem, sizeof(*comp->u.simple));
590 comp->u.simple->which = Z_ElementSetNames_generic;
591 comp->u.simple->u.generic = nmem_strdup(nmem, esn);
595 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
598 yaz_record_conv_t rc = 0;
599 const char *match_schema = 0;
600 int *match_syntax = 0;
605 const char *input_schema = get_esn(rr->comp);
606 Odr_oid *input_syntax_raw = rr->request_format_raw;
608 const char *backend_schema = 0;
609 Odr_oid *backend_syntax = 0;
611 r = yaz_retrieval_request(assoc->server->retrieval,
619 if (r == -1) /* error ? */
621 const char *details = yaz_retrieval_get_error(
622 assoc->server->retrieval);
624 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
626 rr->errstring = odr_strdup(rr->stream, details);
629 else if (r == 1 || r == 3)
631 const char *details = input_schema;
632 rr->errcode = YAZ_BIB1_ELEMENT_SET_NAMES_UNSUPP;
634 rr->errstring = odr_strdup(rr->stream, details);
639 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
640 if (input_syntax_raw)
642 char oidbuf[OID_STR_MAX];
643 oid_to_dotstring(input_syntax_raw, oidbuf);
644 rr->errstring = odr_strdup(rr->stream, oidbuf);
650 set_esn(&rr->comp, backend_schema, rr->stream->mem);
654 oident *oident_syntax = oid_getentbyoid(backend_syntax);
656 rr->request_format_raw = backend_syntax;
659 rr->request_format = oident_syntax->value;
661 rr->request_format = VAL_NONE;
664 (*assoc->init->bend_fetch)(assoc->backend, rr);
665 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
666 { /* post conversion must take place .. */
667 WRBUF output_record = wrbuf_alloc();
668 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
671 const char *details = yaz_record_conv_get_error(rc);
672 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
674 rr->errstring = odr_strdup(rr->stream, details);
678 rr->len = wrbuf_len(output_record);
679 rr->record = odr_malloc(rr->stream, rr->len);
680 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
682 wrbuf_free(output_record, 1);
686 struct oident *oi = oid_getentbyoid(match_syntax);
687 rr->output_format = oi ? oi->value : VAL_NONE;
688 rr->output_format_raw = match_syntax;
691 rr->schema = odr_strdup(rr->stream, match_schema);
694 (*assoc->init->bend_fetch)(assoc->backend, rr);
698 static int srw_bend_fetch(association *assoc, int pos,
699 Z_SRW_searchRetrieveRequest *srw_req,
700 Z_SRW_record *record,
701 const char **addinfo)
704 ODR o = assoc->encode;
706 rr.setname = "default";
709 rr.request_format = VAL_TEXT_XML;
710 rr.request_format_raw = yaz_oidval_to_z3950oid(assoc->decode,
713 rr.comp = (Z_RecordComposition *)
714 odr_malloc(assoc->decode, sizeof(*rr.comp));
715 rr.comp->which = Z_RecordComp_complex;
716 rr.comp->u.complex = (Z_CompSpec *)
717 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
718 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
719 odr_malloc(assoc->encode, sizeof(bool_t));
720 *rr.comp->u.complex->selectAlternativeSyntax = 0;
721 rr.comp->u.complex->num_dbSpecific = 0;
722 rr.comp->u.complex->dbSpecific = 0;
723 rr.comp->u.complex->num_recordSyntax = 0;
724 rr.comp->u.complex->recordSyntax = 0;
726 rr.comp->u.complex->generic = (Z_Specification *)
727 odr_malloc(assoc->decode, sizeof(Z_Specification));
729 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
730 rr.comp->u.complex->generic->which = Z_Schema_uri;
731 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
733 /* ESN = recordSchema if recordSchema is present */
734 rr.comp->u.complex->generic->elementSpec = 0;
735 if (srw_req->recordSchema)
737 rr.comp->u.complex->generic->elementSpec =
738 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
739 rr.comp->u.complex->generic->elementSpec->which =
740 Z_ElementSpec_elementSetName;
741 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
742 srw_req->recordSchema;
745 rr.stream = assoc->encode;
746 rr.print = assoc->print;
754 rr.surrogate_flag = 0;
755 rr.schema = srw_req->recordSchema;
757 if (!assoc->init->bend_fetch)
760 retrieve_fetch(assoc, &rr);
762 if (rr.errcode && rr.surrogate_flag)
764 int code = yaz_diag_bib1_to_srw(rr.errcode);
765 const char *message = yaz_diag_srw_str(code);
768 len += strlen(message);
770 len += strlen(rr.errstring);
772 record->recordData_buf = odr_malloc(o, len);
774 sprintf(record->recordData_buf, "<diagnostic "
775 "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
776 " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
778 sprintf(record->recordData_buf + strlen(record->recordData_buf),
779 " <details>%s</details>\n", rr.errstring);
781 sprintf(record->recordData_buf + strlen(record->recordData_buf),
782 " <message>%s</message>\n", message);
783 sprintf(record->recordData_buf + strlen(record->recordData_buf),
785 record->recordData_len = strlen(record->recordData_buf);
786 record->recordPosition = odr_intdup(o, pos);
787 record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
790 else if (rr.len >= 0)
792 record->recordData_buf = rr.record;
793 record->recordData_len = rr.len;
794 record->recordPosition = odr_intdup(o, pos);
796 record->recordSchema = odr_strdup(o, rr.schema);
798 record->recordSchema = 0;
802 *addinfo = rr.errstring;
808 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
809 Z_Query *query_result)
811 /* have a CQL query and CQL to PQF transform .. */
812 CQL_parser cp = cql_parser_create();
818 r = cql_parser_string(cp, cql);
821 /* CQL syntax error */
827 r = cql_transform_buf(ct,
828 cql_parser_result(cp),
829 rpn_buf, sizeof(rpn_buf)-1);
831 srw_errcode = cql_transform_error(ct, &add);
835 /* Syntax & transform OK. */
836 /* Convert PQF string to Z39.50 to RPN query struct */
837 YAZ_PQF_Parser pp = yaz_pqf_create();
838 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
843 int code = yaz_pqf_error(pp, &pqf_msg, &off);
844 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
850 query_result->which = Z_Query_type_1;
851 query_result->u.type_1 = rpnquery;
855 cql_parser_destroy(cp);
859 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
860 Z_AttributesPlusTerm *result)
864 int srw_error = cql2pqf(odr, cql, ct, &query);
867 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
868 return 10; /* bad query type */
869 rpn = query.u.type_1;
870 if (!rpn->RPNStructure)
871 return 10; /* must be structure */
872 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
873 return 10; /* must be simple */
874 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
875 return 10; /* must be attributes plus term node .. */
876 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
881 static void srw_bend_search(association *assoc, request *req,
883 Z_SRW_searchRetrieveResponse *srw_res,
888 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
891 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
892 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
893 if (srw_res->num_diagnostics == 0 && assoc->init)
896 rr.setname = "default";
899 rr.basenames = &srw_req->database;
903 rr.srw_setnameIdleTime = 0;
904 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
905 rr.query->u.type_1 = 0;
907 if (srw_req->query_type == Z_SRW_query_type_cql)
909 if (assoc->server && assoc->server->cql_transform)
911 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
912 assoc->server->cql_transform,
916 yaz_add_srw_diagnostic(assoc->encode,
917 &srw_res->diagnostics,
918 &srw_res->num_diagnostics,
924 /* CQL query to backend. Wrap it - Z39.50 style */
925 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
926 ext->direct_reference = odr_getoidbystr(assoc->decode,
927 "1.2.840.10003.16.2");
928 ext->indirect_reference = 0;
930 ext->which = Z_External_CQL;
931 ext->u.cql = srw_req->query.cql;
933 rr.query->which = Z_Query_type_104;
934 rr.query->u.type_104 = ext;
937 else if (srw_req->query_type == Z_SRW_query_type_pqf)
939 Z_RPNQuery *RPNquery;
940 YAZ_PQF_Parser pqf_parser;
942 pqf_parser = yaz_pqf_create ();
944 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
950 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
951 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
952 code, pqf_msg, (long) off);
953 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
956 rr.query->which = Z_Query_type_1;
957 rr.query->u.type_1 = RPNquery;
959 yaz_pqf_destroy (pqf_parser);
963 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
964 &srw_res->num_diagnostics,
965 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
967 if (rr.query->u.type_1)
969 rr.stream = assoc->encode;
970 rr.decode = assoc->decode;
971 rr.print = assoc->print;
973 if ( srw_req->sort.sortKeys )
974 rr.srw_sortKeys = odr_strdup(assoc->encode,
975 srw_req->sort.sortKeys );
976 rr.association = assoc;
982 yaz_log_zquery_level(log_requestdetail,rr.query);
984 (assoc->init->bend_search)(assoc->backend, &rr);
987 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
993 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
994 yaz_add_srw_diagnostic(assoc->encode,
995 &srw_res->diagnostics,
996 &srw_res->num_diagnostics,
997 srw_error, rr.errstring);
1002 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
1003 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
1005 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
1006 start, number, rr.hits);
1008 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1011 srw_res->resultSetId =
1012 odr_strdup(assoc->encode, rr.srw_setname );
1013 srw_res->resultSetIdleTime =
1014 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1020 if (start > rr.hits)
1022 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1023 &srw_res->num_diagnostics,
1024 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1029 if (start + number > rr.hits)
1030 number = rr.hits - start + 1;
1032 /* Call bend_present if defined */
1033 if (assoc->init->bend_present)
1035 bend_present_rr *bprr = (bend_present_rr*)
1036 odr_malloc (assoc->decode, sizeof(*bprr));
1037 bprr->setname = "default";
1038 bprr->start = start;
1039 bprr->number = number;
1040 bprr->format = VAL_TEXT_XML;
1041 if (srw_req->recordSchema)
1043 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1044 sizeof(*bprr->comp));
1045 bprr->comp->which = Z_RecordComp_simple;
1046 bprr->comp->u.simple = (Z_ElementSetNames *)
1047 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1048 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1049 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1055 bprr->stream = assoc->encode;
1056 bprr->referenceId = 0;
1057 bprr->print = assoc->print;
1058 bprr->request = req;
1059 bprr->association = assoc;
1061 bprr->errstring = NULL;
1062 (*assoc->init->bend_present)(assoc->backend, bprr);
1068 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1069 yaz_add_srw_diagnostic(assoc->encode,
1070 &srw_res->diagnostics,
1071 &srw_res->num_diagnostics,
1072 srw_error, bprr->errstring);
1080 int packing = Z_SRW_recordPacking_string;
1081 if (srw_req->recordPacking){
1082 if (!strcmp(srw_req->recordPacking, "xml"))
1083 packing = Z_SRW_recordPacking_XML;
1084 if (!strcmp(srw_req->recordPacking, "url"))
1085 packing = Z_SRW_recordPacking_URL;
1087 srw_res->records = (Z_SRW_record *)
1088 odr_malloc(assoc->encode,
1089 number * sizeof(*srw_res->records));
1091 srw_res->extra_records = (Z_SRW_extra_record **)
1092 odr_malloc(assoc->encode,
1093 number*sizeof(*srw_res->extra_records));
1095 for (i = 0; i<number; i++)
1098 const char *addinfo = 0;
1100 srw_res->records[j].recordPacking = packing;
1101 srw_res->records[j].recordData_buf = 0;
1102 srw_res->extra_records[j] = 0;
1103 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1104 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1105 srw_res->records + j,
1109 yaz_add_srw_diagnostic(assoc->encode,
1110 &srw_res->diagnostics,
1111 &srw_res->num_diagnostics,
1112 yaz_diag_bib1_to_srw (errcode),
1117 if (srw_res->records[j].recordData_buf)
1120 srw_res->num_records = j;
1122 srw_res->records = 0;
1131 const char *querystr = "?";
1132 const char *querytype = "?";
1133 WRBUF wr = wrbuf_alloc();
1135 switch (srw_req->query_type)
1137 case Z_SRW_query_type_cql:
1139 querystr = srw_req->query.cql;
1141 case Z_SRW_query_type_pqf:
1143 querystr = srw_req->query.pqf;
1146 wrbuf_printf(wr, "SRWSearch ");
1147 wrbuf_printf(wr, srw_req->database);
1148 wrbuf_printf(wr, " ");
1149 if (srw_res->num_diagnostics)
1150 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1151 else if (*http_code != 200)
1152 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1153 else if (srw_res->numberOfRecords)
1155 wrbuf_printf(wr, "OK %d",
1156 (srw_res->numberOfRecords ?
1157 *srw_res->numberOfRecords : 0));
1159 wrbuf_printf(wr, " %s %d+%d",
1160 (srw_res->resultSetId ?
1161 srw_res->resultSetId : "-"),
1162 (srw_req->startRecord ? *srw_req->startRecord : 1),
1163 srw_res->num_records);
1164 yaz_log(log_request, "%s %s: %s", wrbuf_buf(wr), querytype, querystr);
1169 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1172 xmlNodePtr ptr = rr->server_node_ptr;
1175 for (ptr = ptr->children; ptr; ptr = ptr->next)
1177 if (ptr->type != XML_ELEMENT_NODE)
1179 if (!strcmp((const char *) ptr->name, "explain"))
1182 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1186 ptr = xmlCopyNode(ptr, 1);
1188 xmlDocSetRootElement(doc, ptr);
1190 xmlDocDumpMemory(doc, &buf_out, &len);
1191 content = (char*) odr_malloc(rr->stream, 1+len);
1192 memcpy(content, buf_out, len);
1193 content[len] = '\0';
1197 rr->explain_buf = content;
1205 static void srw_bend_explain(association *assoc, request *req,
1207 Z_SRW_explainResponse *srw_res,
1210 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1211 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1213 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1218 rr.stream = assoc->encode;
1219 rr.decode = assoc->decode;
1220 rr.print = assoc->print;
1222 rr.database = srw_req->database;
1224 rr.server_node_ptr = assoc->server->server_node_ptr;
1226 rr.server_node_ptr = 0;
1227 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1228 if (assoc->init->bend_explain)
1229 (*assoc->init->bend_explain)(assoc->backend, &rr);
1231 srw_bend_explain_default(assoc->backend, &rr);
1235 int packing = Z_SRW_recordPacking_string;
1236 if (srw_req->recordPacking)
1238 if (!strcmp(srw_req->recordPacking, "xml"))
1239 packing = Z_SRW_recordPacking_XML;
1240 else if (!strcmp(srw_req->recordPacking, "url"))
1241 packing = Z_SRW_recordPacking_URL;
1243 srw_res->record.recordSchema = rr.schema;
1244 srw_res->record.recordPacking = packing;
1245 srw_res->record.recordData_buf = rr.explain_buf;
1246 srw_res->record.recordData_len = strlen(rr.explain_buf);
1247 srw_res->record.recordPosition = 0;
1253 static void srw_bend_scan(association *assoc, request *req,
1255 Z_SRW_scanResponse *srw_res,
1258 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1259 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1262 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1263 if (srw_res->num_diagnostics == 0 && assoc->init)
1265 struct scan_entry *save_entries;
1267 bend_scan_rr *bsrr = (bend_scan_rr *)
1268 odr_malloc (assoc->encode, sizeof(*bsrr));
1269 bsrr->num_bases = 1;
1270 bsrr->basenames = &srw_req->database;
1272 bsrr->num_entries = srw_req->maximumTerms ?
1273 *srw_req->maximumTerms : 10;
1274 bsrr->term_position = srw_req->responsePosition ?
1275 *srw_req->responsePosition : 1;
1278 bsrr->errstring = 0;
1279 bsrr->referenceId = 0;
1280 bsrr->stream = assoc->encode;
1281 bsrr->print = assoc->print;
1282 bsrr->step_size = odr_intdup(assoc->decode, 0);
1285 if (bsrr->num_entries > 0)
1288 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1290 for (i = 0; i<bsrr->num_entries; i++)
1292 bsrr->entries[i].term = 0;
1293 bsrr->entries[i].occurrences = 0;
1294 bsrr->entries[i].errcode = 0;
1295 bsrr->entries[i].errstring = 0;
1296 bsrr->entries[i].display_term = 0;
1299 save_entries = bsrr->entries; /* save it so we can compare later */
1301 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1302 assoc->init->bend_scan)
1304 Odr_oid *scan_attributeSet = 0;
1306 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1308 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1310 srw_req->scanClause.pqf);
1311 if (scan_attributeSet &&
1312 (attset = oid_getentbyoid(scan_attributeSet)) &&
1313 (attset->oclass == CLASS_ATTSET ||
1314 attset->oclass == CLASS_GENERAL))
1315 bsrr->attributeset = attset->value;
1317 bsrr->attributeset = VAL_NONE;
1318 yaz_pqf_destroy(pqf_parser);
1319 bsrr->scanClause = 0;
1320 ((int (*)(void *, bend_scan_rr *))
1321 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1323 else if (srw_req->query_type == Z_SRW_query_type_cql
1324 && assoc->init->bend_scan && assoc->server
1325 && assoc->server->cql_transform)
1328 bsrr->scanClause = 0;
1329 bsrr->attributeset = VAL_NONE;
1330 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1331 srw_error = cql2pqf_scan(assoc->encode,
1332 srw_req->scanClause.cql,
1333 assoc->server->cql_transform,
1336 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1337 &srw_res->num_diagnostics,
1341 ((int (*)(void *, bend_scan_rr *))
1342 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1345 else if (srw_req->query_type == Z_SRW_query_type_cql
1346 && assoc->init->bend_srw_scan)
1349 bsrr->attributeset = VAL_NONE;
1350 bsrr->scanClause = srw_req->scanClause.cql;
1351 ((int (*)(void *, bend_scan_rr *))
1352 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1356 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1357 &srw_res->num_diagnostics,
1358 YAZ_SRW_UNSUPP_OPERATION, "scan");
1363 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1368 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1370 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1371 &srw_res->num_diagnostics,
1372 srw_error, bsrr->errstring);
1374 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1377 srw_res->terms = (Z_SRW_scanTerm*)
1378 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1381 srw_res->num_terms = bsrr->num_entries;
1382 for (i = 0; i<bsrr->num_entries; i++)
1384 Z_SRW_scanTerm *t = srw_res->terms + i;
1385 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1386 t->numberOfRecords =
1387 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1389 if (save_entries == bsrr->entries &&
1390 bsrr->entries[i].display_term)
1392 /* the entries was _not_ set by the handler. So it's
1393 safe to test for new member display_term. It is
1396 t->displayTerm = odr_strdup(assoc->encode,
1397 bsrr->entries[i].display_term);
1405 WRBUF wr = wrbuf_alloc();
1406 const char *querytype = 0;
1407 const char *querystr = 0;
1409 switch(srw_req->query_type)
1411 case Z_SRW_query_type_pqf:
1413 querystr = srw_req->scanClause.pqf;
1415 case Z_SRW_query_type_cql:
1417 querystr = srw_req->scanClause.cql;
1420 querytype = "UNKNOWN";
1424 wrbuf_printf(wr, "SRWScan ");
1425 wrbuf_printf(wr, srw_req->database);
1426 wrbuf_printf(wr, " ");
1428 if (srw_res->num_diagnostics)
1429 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1430 else if (srw_res->num_terms)
1431 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1433 wrbuf_printf(wr, "OK - - ");
1435 wrbuf_printf(wr, "%d+%d+0 ",
1436 (srw_req->responsePosition ?
1437 *srw_req->responsePosition : 1),
1438 (srw_req->maximumTerms ?
1439 *srw_req->maximumTerms : 1));
1440 /* there is no step size in SRU/W ??? */
1441 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1442 yaz_log(log_request, "%s ", wrbuf_buf(wr) );
1448 static void srw_bend_update(association *assoc, request *req,
1450 Z_SRW_updateResponse *srw_res,
1453 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1454 yaz_log(YLOG_DEBUG, "Got SRW UpdateRequest");
1455 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1457 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1462 rr.stream = assoc->encode;
1463 rr.print = assoc->print;
1465 rr.basenames = &srw_req->database;
1466 rr.operation = srw_req->operation;
1467 rr.operation_status = "failed";
1469 rr.record_version = 0;
1470 rr.record_checksum = 0;
1471 rr.record_old_version = 0;
1472 rr.record_packing = "xml";
1473 rr.record_schema = 0;
1475 rr.request_extra_record = 0;
1476 rr.response_extra_record = 0;
1477 rr.extra_request_data = 0;
1478 rr.extra_response_data = 0;
1483 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1484 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1485 if ( !strcmp( rr.operation, "delete" ) ){
1486 if ( !srw_req->recordId ){
1487 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1488 &srw_res->num_diagnostics,
1492 rr.record_id = srw_req->recordId;
1494 if ( !srw_req->recordVersion ){
1495 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1496 &srw_res->num_diagnostics,
1497 7, "recordVersion" );
1500 rr.record_version = odr_strdup( assoc->encode,
1501 srw_req->recordVersion );
1504 if ( srw_req->recordOldVersion ){
1505 rr.record_old_version = odr_strdup(assoc->encode,
1506 srw_req->recordOldVersion );
1508 if ( srw_req->extraRequestData ){
1509 rr.extra_request_data = odr_strdup(assoc->encode,
1510 srw_req->extraRequestData );
1513 else if ( !strcmp( rr.operation, "replace" ) ){
1514 if ( !srw_req->recordId ){
1515 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1516 &srw_res->num_diagnostics,
1520 rr.record_id = srw_req->recordId;
1522 if ( srw_req->record.recordSchema == 0 ){
1523 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1524 &srw_res->num_diagnostics,
1525 7, "recordSchema" );
1528 rr.record_schema = odr_strdup(assoc->encode,
1529 srw_req->record.recordSchema );
1531 switch (srw_req->record.recordPacking)
1533 case Z_SRW_recordPacking_string:
1534 rr.record_packing = "string";
1536 case Z_SRW_recordPacking_XML:
1537 rr.record_packing = "xml";
1539 case Z_SRW_recordPacking_URL:
1540 rr.record_packing = "url";
1543 if ( srw_req->record.recordData_len ){
1544 rr.record_data = odr_strdupn(assoc->encode,
1545 srw_req->record.recordData_buf,
1546 srw_req->record.recordData_len );
1547 rr.request_extra_record = srw_req->extra_record;
1550 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1551 &srw_res->num_diagnostics,
1554 if (srw_req->extraRequestData)
1555 rr.extra_request_data = odr_strdup(assoc->encode,
1556 srw_req->extraRequestData );
1558 else if ( !strcmp( rr.operation, "insert" ) )
1560 rr.record_id = srw_req->recordId;
1561 if ( srw_req->record.recordSchema == 0 ){
1562 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1563 &srw_res->num_diagnostics,
1564 7, "recordSchema" );
1567 rr.record_schema = odr_strdup(assoc->encode,
1568 srw_req->record.recordSchema);
1570 switch (srw_req->record.recordPacking)
1572 case Z_SRW_recordPacking_string:
1573 rr.record_packing = "string";
1575 case Z_SRW_recordPacking_XML:
1576 rr.record_packing = "xml";
1578 case Z_SRW_recordPacking_URL:
1579 rr.record_packing = "url";
1583 if (srw_req->record.recordData_len)
1585 rr.record_data = odr_strdupn(assoc->encode,
1586 srw_req->record.recordData_buf,
1587 srw_req->record.recordData_len );
1588 rr.request_extra_record = srw_req->extra_record;
1591 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1592 &srw_res->num_diagnostics,
1594 if ( srw_req->extraRequestData )
1595 rr.extra_request_data = odr_strdup(assoc->encode,
1596 srw_req->extraRequestData );
1598 if (srw_res->num_diagnostics == 0)
1600 if ( assoc->init->bend_srw_update)
1601 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1603 yaz_log( YLOG_WARN, "Got No Update function!");
1609 yaz_add_srw_diagnostic_uri(assoc->encode,
1610 &srw_res->diagnostics,
1611 &srw_res->num_diagnostics,
1615 srw_res->recordId = rr.record_id;
1616 srw_res->operationStatus = rr.operation_status;
1617 srw_res->recordVersion = rr.record_version;
1618 srw_res->recordChecksum = rr.record_checksum;
1619 srw_res->extraResponseData = rr.extra_response_data;
1620 srw_res->record.recordPosition = 0;
1621 if (srw_res->num_diagnostics == 0 && rr.record_data)
1623 srw_res->record.recordSchema = rr.record_schema;
1624 srw_res->record.recordPacking = srw_req->record.recordPacking;
1625 srw_res->record.recordData_buf = rr.record_data;
1626 srw_res->record.recordData_len = strlen(rr.record_data);
1627 srw_res->extra_record = rr.response_extra_record;
1631 srw_res->record.recordData_len = 0;
1636 /* check if path is OK (1); BAD (0) */
1637 static int check_path(const char *path)
1641 if (strstr(path, ".."))
1646 static char *read_file(const char *fname, ODR o, int *sz)
1649 FILE *inf = fopen(fname, "rb");
1653 fseek(inf, 0L, SEEK_END);
1656 buf = odr_malloc(o, *sz);
1657 fread(buf, 1, *sz, inf);
1662 static void process_http_request(association *assoc, request *req)
1664 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1665 ODR o = assoc->encode;
1666 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1668 Z_SOAP *soap_package = 0;
1671 Z_HTTP_Response *hres = 0;
1673 const char *stylesheet = 0; /* for now .. set later */
1674 Z_SRW_diagnostic *diagnostic = 0;
1675 int num_diagnostic = 0;
1676 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1678 if (!control_association(assoc, host, 0))
1680 p = z_get_HTTP_Response(o, 404);
1683 if (r == 2 && assoc->server && assoc->server->docpath
1684 && hreq->path[0] == '/'
1686 /* check if path is a proper prefix of documentroot */
1687 strncmp(hreq->path+1, assoc->server->docpath,
1688 strlen(assoc->server->docpath))
1691 if (!check_path(hreq->path))
1693 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1694 p = z_get_HTTP_Response(o, 404);
1698 int content_size = 0;
1699 char *content_buf = read_file(hreq->path+1, o, &content_size);
1702 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1703 p = z_get_HTTP_Response(o, 404);
1707 const char *ctype = 0;
1708 yaz_mime_types types = yaz_mime_types_create();
1710 yaz_mime_types_add(types, "xsl", "application/xml");
1711 yaz_mime_types_add(types, "xml", "application/xml");
1712 yaz_mime_types_add(types, "css", "text/css");
1713 yaz_mime_types_add(types, "html", "text/html");
1714 yaz_mime_types_add(types, "htm", "text/html");
1715 yaz_mime_types_add(types, "txt", "text/plain");
1716 yaz_mime_types_add(types, "js", "application/x-javascript");
1718 yaz_mime_types_add(types, "gif", "image/gif");
1719 yaz_mime_types_add(types, "png", "image/png");
1720 yaz_mime_types_add(types, "jpg", "image/jpeg");
1721 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1723 ctype = yaz_mime_lookup_fname(types, hreq->path);
1726 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1727 p = z_get_HTTP_Response(o, 404);
1731 p = z_get_HTTP_Response(o, 200);
1732 hres = p->u.HTTP_Response;
1733 hres->content_buf = content_buf;
1734 hres->content_len = content_size;
1735 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1737 yaz_mime_types_destroy(types);
1745 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1746 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1748 if (r == 2) /* not taken */
1750 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1751 &diagnostic, &num_diagnostic);
1752 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1754 if (r == 0) /* decode SRW/SRU OK .. */
1756 int http_code = 200;
1757 if (sr->which == Z_SRW_searchRetrieve_request)
1760 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1762 stylesheet = sr->u.request->stylesheet;
1765 res->u.response->diagnostics = diagnostic;
1766 res->u.response->num_diagnostics = num_diagnostic;
1770 srw_bend_search(assoc, req, sr, res->u.response,
1773 if (http_code == 200)
1774 soap_package->u.generic->p = res;
1776 else if (sr->which == Z_SRW_explain_request)
1778 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1779 stylesheet = sr->u.explain_request->stylesheet;
1782 res->u.explain_response->diagnostics = diagnostic;
1783 res->u.explain_response->num_diagnostics = num_diagnostic;
1785 srw_bend_explain(assoc, req, sr,
1786 res->u.explain_response, &http_code);
1787 if (http_code == 200)
1788 soap_package->u.generic->p = res;
1790 else if (sr->which == Z_SRW_scan_request)
1792 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1793 stylesheet = sr->u.scan_request->stylesheet;
1796 res->u.scan_response->diagnostics = diagnostic;
1797 res->u.scan_response->num_diagnostics = num_diagnostic;
1799 srw_bend_scan(assoc, req, sr,
1800 res->u.scan_response, &http_code);
1801 if (http_code == 200)
1802 soap_package->u.generic->p = res;
1804 else if (sr->which == Z_SRW_update_request)
1806 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1807 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1810 res->u.update_response->diagnostics = diagnostic;
1811 res->u.update_response->num_diagnostics = num_diagnostic;
1813 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1814 srw_bend_update(assoc, req, sr,
1815 res->u.update_response, &http_code);
1816 if (http_code == 200)
1817 soap_package->u.generic->p = res;
1821 yaz_log(log_request, "SOAP ERROR");
1822 /* FIXME - what error, what query */
1824 z_soap_error(assoc->encode, soap_package,
1825 "SOAP-ENV:Client", "Bad method", 0);
1827 if (http_code == 200 || http_code == 500)
1829 static Z_SOAP_Handler soap_handlers[4] = {
1831 {"http://www.loc.gov/zing/srw/", 0,
1832 (Z_SOAP_fun) yaz_srw_codec},
1833 {"http://www.loc.gov/zing/srw/v1.0/", 0,
1834 (Z_SOAP_fun) yaz_srw_codec},
1835 {"http://www.loc.gov/zing/srw/update/", 0,
1836 (Z_SOAP_fun) yaz_ucp_codec},
1842 p = z_get_HTTP_Response(o, 200);
1843 hres = p->u.HTTP_Response;
1845 if (!stylesheet && assoc->server)
1846 stylesheet = assoc->server->stylesheet;
1848 /* empty stylesheet means NO stylesheet */
1849 if (stylesheet && *stylesheet == '\0')
1852 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1853 &hres->content_buf, &hres->content_len,
1854 soap_handlers, charset, stylesheet);
1855 hres->code = http_code;
1857 strcpy(ctype, "text/xml");
1860 strcat(ctype, "; charset=");
1861 strcat(ctype, charset);
1863 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1866 p = z_get_HTTP_Response(o, http_code);
1870 p = z_get_HTTP_Response(o, 500);
1871 hres = p->u.HTTP_Response;
1872 if (!strcmp(hreq->version, "1.0"))
1874 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1875 if (v && !strcmp(v, "Keep-Alive"))
1879 hres->version = "1.0";
1883 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1884 if (v && !strcmp(v, "close"))
1888 hres->version = "1.1";
1892 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1893 assoc->state = ASSOC_DEAD;
1894 assoc->cs_get_mask = 0;
1899 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1901 if (alive && isdigit(*(const unsigned char *) alive))
1905 if (t < 0 || t > 3600)
1907 iochan_settimeout(assoc->client_chan,t);
1908 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1910 process_gdu_response(assoc, req, p);
1913 static void process_gdu_request(association *assoc, request *req)
1915 if (req->gdu_request->which == Z_GDU_Z3950)
1918 req->apdu_request = req->gdu_request->u.z3950;
1919 if (process_z_request(assoc, req, &msg) < 0)
1920 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1922 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1923 process_http_request(assoc, req);
1926 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1931 * Initiate request processing.
1933 static int process_z_request(association *assoc, request *req, char **msg)
1939 *msg = "Unknown Error";
1940 assert(req && req->state == REQUEST_IDLE);
1941 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1943 *msg = "Missing InitRequest";
1946 switch (req->apdu_request->which)
1948 case Z_APDU_initRequest:
1949 res = process_initRequest(assoc, req); break;
1950 case Z_APDU_searchRequest:
1951 res = process_searchRequest(assoc, req, &fd); break;
1952 case Z_APDU_presentRequest:
1953 res = process_presentRequest(assoc, req, &fd); break;
1954 case Z_APDU_scanRequest:
1955 if (assoc->init->bend_scan)
1956 res = process_scanRequest(assoc, req, &fd);
1959 *msg = "Cannot handle Scan APDU";
1963 case Z_APDU_extendedServicesRequest:
1964 if (assoc->init->bend_esrequest)
1965 res = process_ESRequest(assoc, req, &fd);
1968 *msg = "Cannot handle Extended Services APDU";
1972 case Z_APDU_sortRequest:
1973 if (assoc->init->bend_sort)
1974 res = process_sortRequest(assoc, req, &fd);
1977 *msg = "Cannot handle Sort APDU";
1982 process_close(assoc, req);
1984 case Z_APDU_deleteResultSetRequest:
1985 if (assoc->init->bend_delete)
1986 res = process_deleteRequest(assoc, req, &fd);
1989 *msg = "Cannot handle Delete APDU";
1993 case Z_APDU_segmentRequest:
1994 if (assoc->init->bend_segment)
1996 res = process_segmentRequest (assoc, req);
2000 *msg = "Cannot handle Segment APDU";
2004 case Z_APDU_triggerResourceControlRequest:
2007 *msg = "Bad APDU received";
2012 yaz_log(YLOG_DEBUG, " result immediately available");
2013 retval = process_z_response(assoc, req, res);
2017 yaz_log(YLOG_DEBUG, " result unavailble");
2020 else /* no result yet - one will be provided later */
2024 /* Set up an I/O handler for the fd supplied by the backend */
2026 yaz_log(YLOG_DEBUG, " establishing handler for result");
2027 req->state = REQUEST_PENDING;
2028 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2030 iochan_setdata(chan, assoc);
2037 * Handle message from the backend.
2039 void backend_response(IOCHAN i, int event)
2041 association *assoc = (association *)iochan_getdata(i);
2042 request *req = request_head(&assoc->incoming);
2046 yaz_log(YLOG_DEBUG, "backend_response");
2047 assert(assoc && req && req->state != REQUEST_IDLE);
2048 /* determine what it is we're waiting for */
2049 switch (req->apdu_request->which)
2051 case Z_APDU_searchRequest:
2052 res = response_searchRequest(assoc, req, 0, &fd); break;
2054 case Z_APDU_presentRequest:
2055 res = response_presentRequest(assoc, req, 0, &fd); break;
2056 case Z_APDU_scanRequest:
2057 res = response_scanRequest(assoc, req, 0, &fd); break;
2060 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2063 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2065 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2066 do_close(assoc, Z_Close_systemProblem, 0);
2070 else if (!res) /* no result yet - try again later */
2072 yaz_log(YLOG_DEBUG, " no result yet");
2073 iochan_setfd(i, fd); /* in case fd has changed */
2078 * Encode response, and transfer the request structure to the outgoing queue.
2080 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2082 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2086 if (!z_GDU(assoc->print, &res, 0, 0))
2087 yaz_log(YLOG_WARN, "ODR print error: %s",
2088 odr_errmsg(odr_geterror(assoc->print)));
2089 odr_reset(assoc->print);
2091 if (!z_GDU(assoc->encode, &res, 0, 0))
2093 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2094 odr_errmsg(odr_geterror(assoc->decode)),
2095 odr_getelement(assoc->decode));
2098 req->response = odr_getbuf(assoc->encode, &req->len_response,
2099 &req->size_response);
2100 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2101 odr_reset(assoc->encode);
2102 req->state = REQUEST_IDLE;
2103 request_enq(&assoc->outgoing, req);
2104 /* turn the work over to the ir_session handler */
2105 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2106 assoc->cs_put_mask = EVENT_OUTPUT;
2107 /* Is there more work to be done? give that to the input handler too */
2109 if (request_head(&assoc->incoming))
2111 yaz_log (YLOG_DEBUG, "more work to be done");
2112 iochan_setevent(assoc->client_chan, EVENT_WORK);
2119 * Encode response, and transfer the request structure to the outgoing queue.
2121 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2123 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2124 gres->which = Z_GDU_Z3950;
2125 gres->u.z3950 = res;
2127 return process_gdu_response(assoc, req, gres);
2130 static char *get_vhost(Z_OtherInformation *otherInfo)
2132 return yaz_oi_get_string_oidval(&otherInfo, VAL_PROXY, 1, 0);
2136 * Handle init request.
2137 * At the moment, we don't check the options
2138 * anywhere else in the code - we just try not to do anything that would
2139 * break a naive client. We'll toss 'em into the association block when
2140 * we need them there.
2142 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2144 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2145 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2146 Z_InitResponse *resp = apdu->u.initResponse;
2147 bend_initresult *binitres;
2150 statserv_options_block *cb = 0; /* by default no control for backend */
2152 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2153 cb = statserv_getcontrol(); /* got control block for backend */
2155 if (cb && assoc->backend)
2156 (*cb->bend_close)(assoc->backend);
2158 yaz_log(log_requestdetail, "Got initRequest");
2159 if (req->implementationId)
2160 yaz_log(log_requestdetail, "Id: %s",
2161 req->implementationId);
2162 if (req->implementationName)
2163 yaz_log(log_requestdetail, "Name: %s",
2164 req->implementationName);
2165 if (req->implementationVersion)
2166 yaz_log(log_requestdetail, "Version: %s",
2167 req->implementationVersion);
2169 assoc_init_reset(assoc);
2171 assoc->init->auth = req->idAuthentication;
2172 assoc->init->referenceId = req->referenceId;
2174 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2176 Z_CharSetandLanguageNegotiation *negotiation =
2177 yaz_get_charneg_record (req->otherInfo);
2179 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2180 assoc->init->charneg_request = negotiation;
2186 if (req->implementationVersion)
2187 yaz_log(log_requestdetail, "Config: %s",
2190 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2192 /* we have a backend control block, so call that init function */
2193 if (!(binitres = (*cb->bend_init)(assoc->init)))
2195 yaz_log(YLOG_WARN, "Bad response from backend.");
2198 assoc->backend = binitres->handle;
2202 /* no backend. return error */
2203 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2204 binitres->errstring = 0;
2205 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2206 iochan_settimeout(assoc->client_chan, 10);
2208 if ((assoc->init->bend_sort))
2209 yaz_log (YLOG_DEBUG, "Sort handler installed");
2210 if ((assoc->init->bend_search))
2211 yaz_log (YLOG_DEBUG, "Search handler installed");
2212 if ((assoc->init->bend_present))
2213 yaz_log (YLOG_DEBUG, "Present handler installed");
2214 if ((assoc->init->bend_esrequest))
2215 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2216 if ((assoc->init->bend_delete))
2217 yaz_log (YLOG_DEBUG, "Delete handler installed");
2218 if ((assoc->init->bend_scan))
2219 yaz_log (YLOG_DEBUG, "Scan handler installed");
2220 if ((assoc->init->bend_segment))
2221 yaz_log (YLOG_DEBUG, "Segment handler installed");
2223 resp->referenceId = req->referenceId;
2225 /* let's tell the client what we can do */
2226 if (ODR_MASK_GET(req->options, Z_Options_search))
2228 ODR_MASK_SET(resp->options, Z_Options_search);
2229 strcat(options, "srch");
2231 if (ODR_MASK_GET(req->options, Z_Options_present))
2233 ODR_MASK_SET(resp->options, Z_Options_present);
2234 strcat(options, " prst");
2236 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2237 assoc->init->bend_delete)
2239 ODR_MASK_SET(resp->options, Z_Options_delSet);
2240 strcat(options, " del");
2242 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2243 assoc->init->bend_esrequest)
2245 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2246 strcat (options, " extendedServices");
2248 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2250 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2251 strcat(options, " namedresults");
2253 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2255 ODR_MASK_SET(resp->options, Z_Options_scan);
2256 strcat(options, " scan");
2258 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2260 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2261 strcat(options, " concurrop");
2263 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2265 ODR_MASK_SET(resp->options, Z_Options_sort);
2266 strcat(options, " sort");
2269 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
2270 && assoc->init->charneg_response)
2272 Z_OtherInformation **p;
2273 Z_OtherInformationUnit *p0;
2275 yaz_oi_APDU(apdu, &p);
2277 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2278 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2280 p0->which = Z_OtherInfo_externallyDefinedInfo;
2281 p0->information.externallyDefinedInfo =
2282 assoc->init->charneg_response;
2284 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2285 strcat(options, " negotiation");
2288 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2289 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2291 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2293 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2294 assoc->version = 1; /* 1 & 2 are equivalent */
2296 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2298 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2301 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2303 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2307 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2309 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2310 assoc->maximumRecordSize = *req->maximumRecordSize;
2312 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2313 assoc->preferredMessageSize = *req->preferredMessageSize;
2315 resp->preferredMessageSize = &assoc->preferredMessageSize;
2316 resp->maximumRecordSize = &assoc->maximumRecordSize;
2318 resp->implementationId = odr_prepend(assoc->encode,
2319 assoc->init->implementation_id,
2320 resp->implementationId);
2322 resp->implementationName = odr_prepend(assoc->encode,
2323 assoc->init->implementation_name,
2324 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2326 version = odr_strdup(assoc->encode, "$Revision: 1.98 $");
2327 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2328 version[strlen(version)-2] = '\0';
2329 resp->implementationVersion = odr_prepend(assoc->encode,
2330 assoc->init->implementation_version,
2331 odr_prepend(assoc->encode, &version[11],
2332 resp->implementationVersion));
2334 if (binitres->errcode)
2336 assoc->state = ASSOC_DEAD;
2337 resp->userInformationField =
2338 init_diagnostics(assoc->encode, binitres->errcode,
2339 binitres->errstring);
2344 if (!req->idAuthentication)
2345 yaz_log(log_request, "Auth none");
2346 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2348 const char *open = req->idAuthentication->u.open;
2349 const char *slash = strchr(open, '/');
2355 yaz_log(log_request, "Auth open %.*s", len, open);
2357 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2359 const char *user = req->idAuthentication->u.idPass->userId;
2360 const char *group = req->idAuthentication->u.idPass->groupId;
2361 yaz_log(log_request, "Auth idPass %s %s",
2362 user ? user : "-", group ? group : "-");
2364 else if (req->idAuthentication->which
2365 == Z_IdAuthentication_anonymous)
2367 yaz_log(log_request, "Auth anonymous");
2371 yaz_log(log_request, "Auth other");
2376 WRBUF wr = wrbuf_alloc();
2377 wrbuf_printf(wr, "Init ");
2378 if (binitres->errcode)
2379 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2381 wrbuf_printf(wr, "OK -");
2382 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2383 (req->implementationId ? req->implementationId :"-"),
2384 (req->implementationName ?
2385 req->implementationName : "-"),
2386 (req->implementationVersion ?
2387 req->implementationVersion : "-")
2389 yaz_log(log_request, "%s", wrbuf_buf(wr));
2396 * Set the specified `errcode' and `errstring' into a UserInfo-1
2397 * external to be returned to the client in accordance with Z35.90
2398 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2399 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2401 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2403 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2404 addinfo ? " -- " : "", addinfo ? addinfo : "");
2405 return zget_init_diagnostics(odr, error, addinfo);
2409 * nonsurrogate diagnostic record.
2411 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2413 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2415 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2416 addinfo ? " -- " : "", addinfo ? addinfo : "");
2418 rec->which = Z_Records_NSD;
2419 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2425 * surrogate diagnostic.
2427 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2429 int error, const char *addinfo)
2431 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2432 addinfo ? " -- " : "", addinfo ? addinfo : "");
2433 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2436 static Z_Records *pack_records(association *a, char *setname, int start,
2437 int *num, Z_RecordComposition *comp,
2438 int *next, int *pres, oid_value format,
2439 Z_ReferenceId *referenceId,
2440 int *oid, int *errcode)
2442 int recno, total_length = 0, toget = *num, dumped_records = 0;
2443 Z_Records *records =
2444 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2445 Z_NamePlusRecordList *reclist =
2446 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2447 Z_NamePlusRecord **list =
2448 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2450 records->which = Z_Records_DBOSD;
2451 records->u.databaseOrSurDiagnostics = reclist;
2452 reclist->num_records = 0;
2453 reclist->records = list;
2454 *pres = Z_PresentStatus_success;
2458 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2459 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2460 a->maximumRecordSize);
2461 for (recno = start; reclist->num_records < toget; recno++)
2464 Z_NamePlusRecord *thisrec;
2465 int this_length = 0;
2467 * we get the number of bytes allocated on the stream before any
2468 * allocation done by the backend - this should give us a reasonable
2469 * idea of the total size of the data so far.
2471 total_length = odr_total(a->encode) - dumped_records;
2477 freq.last_in_set = 0;
2478 freq.setname = setname;
2479 freq.surrogate_flag = 0;
2480 freq.number = recno;
2482 freq.request_format = format;
2483 freq.request_format_raw = oid;
2484 freq.output_format = format;
2485 freq.output_format_raw = 0;
2486 freq.stream = a->encode;
2487 freq.print = a->print;
2488 freq.referenceId = referenceId;
2491 retrieve_fetch(a, &freq);
2493 *next = freq.last_in_set ? 0 : recno + 1;
2495 /* backend should be able to signal whether error is system-wide
2496 or only pertaining to current record */
2499 if (!freq.surrogate_flag)
2502 *pres = Z_PresentStatus_failure;
2503 /* for 'present request out of range',
2504 set addinfo to record position if not set */
2505 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2506 freq.errstring == 0)
2508 sprintf (s, "%d", recno);
2512 *errcode = freq.errcode;
2513 return diagrec(a, freq.errcode, freq.errstring);
2515 reclist->records[reclist->num_records] =
2516 surrogatediagrec(a, freq.basename, freq.errcode,
2518 reclist->num_records++;
2521 if (freq.record == 0) /* no error and no record ? */
2523 *next = 0; /* signal end-of-set and stop */
2527 this_length = freq.len;
2529 this_length = odr_total(a->encode) - total_length - dumped_records;
2530 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2531 this_length, total_length, dumped_records);
2532 if (a->preferredMessageSize > 0 &&
2533 this_length + total_length > a->preferredMessageSize)
2535 /* record is small enough, really */
2536 if (this_length <= a->preferredMessageSize && recno > start)
2538 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2539 *pres = Z_PresentStatus_partial_2;
2542 /* record can only be fetched by itself */
2543 if (this_length < a->maximumRecordSize)
2545 yaz_log(log_requestdetail, " Record > prefmsgsz");
2548 yaz_log(YLOG_DEBUG, " Dropped it");
2549 reclist->records[reclist->num_records] =
2550 surrogatediagrec(a, freq.basename, 16, 0);
2551 reclist->num_records++;
2552 dumped_records += this_length;
2556 else /* too big entirely */
2558 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2559 this_length, a->maximumRecordSize);
2560 reclist->records[reclist->num_records] =
2561 surrogatediagrec(a, freq.basename, 17, 0);
2562 reclist->num_records++;
2563 dumped_records += this_length;
2568 if (!(thisrec = (Z_NamePlusRecord *)
2569 odr_malloc(a->encode, sizeof(*thisrec))))
2572 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2574 thisrec->databaseName = 0;
2575 thisrec->which = Z_NamePlusRecord_databaseRecord;
2577 if (freq.output_format_raw)
2579 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
2580 freq.output_format = ident->value;
2582 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
2583 freq.record, freq.len);
2584 if (!thisrec->u.databaseRecord)
2586 reclist->records[reclist->num_records] = thisrec;
2587 reclist->num_records++;
2589 *num = reclist->num_records;
2593 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2596 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2597 bend_search_rr *bsrr =
2598 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2600 yaz_log(log_requestdetail, "Got SearchRequest.");
2602 bsrr->request = reqb;
2603 bsrr->association = assoc;
2604 bsrr->referenceId = req->referenceId;
2605 save_referenceId (reqb, bsrr->referenceId);
2606 bsrr->srw_sortKeys = 0;
2607 bsrr->srw_setname = 0;
2608 bsrr->srw_setnameIdleTime = 0;
2610 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2611 if (req->databaseNames)
2614 for (i = 0; i < req->num_databaseNames; i++)
2615 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2618 yaz_log_zquery_level(log_requestdetail,req->query);
2620 if (assoc->init->bend_search)
2622 bsrr->setname = req->resultSetName;
2623 bsrr->replace_set = *req->replaceIndicator;
2624 bsrr->num_bases = req->num_databaseNames;
2625 bsrr->basenames = req->databaseNames;
2626 bsrr->query = req->query;
2627 bsrr->stream = assoc->encode;
2628 nmem_transfer(bsrr->stream->mem, reqb->request_mem);
2629 bsrr->decode = assoc->decode;
2630 bsrr->print = assoc->print;
2633 bsrr->errstring = NULL;
2634 bsrr->search_info = NULL;
2636 if (assoc->server && assoc->server->cql_transform
2637 && req->query->which == Z_Query_type_104
2638 && req->query->u.type_104->which == Z_External_CQL)
2640 /* have a CQL query and a CQL to PQF transform .. */
2642 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2643 assoc->server->cql_transform, bsrr->query);
2645 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2648 (assoc->init->bend_search)(assoc->backend, bsrr);
2649 if (!bsrr->request) /* backend not ready with the search response */
2650 return 0; /* should not be used any more */
2654 /* FIXME - make a diagnostic for it */
2655 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2657 return response_searchRequest(assoc, reqb, bsrr, fd);
2660 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2663 * Prepare a searchresponse based on the backend results. We probably want
2664 * to look at making the fetching of records nonblocking as well, but
2665 * so far, we'll keep things simple.
2666 * If bsrt is null, that means we're called in response to a communications
2667 * event, and we'll have to get the response for ourselves.
2669 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2670 bend_search_rr *bsrt, int *fd)
2672 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2673 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2674 Z_SearchResponse *resp = (Z_SearchResponse *)
2675 odr_malloc (assoc->encode, sizeof(*resp));
2676 int *nulint = odr_intdup (assoc->encode, 0);
2677 bool_t *sr = odr_intdup(assoc->encode, 1);
2678 int *next = odr_intdup(assoc->encode, 0);
2679 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2682 apdu->which = Z_APDU_searchResponse;
2683 apdu->u.searchResponse = resp;
2684 resp->referenceId = req->referenceId;
2685 resp->additionalSearchInfo = 0;
2686 resp->otherInfo = 0;
2688 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2690 yaz_log(YLOG_FATAL, "Bad result from backend");
2693 else if (bsrt->errcode)
2695 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2696 resp->resultCount = nulint;
2697 resp->numberOfRecordsReturned = nulint;
2698 resp->nextResultSetPosition = nulint;
2699 resp->searchStatus = nulint;
2700 resp->resultSetStatus = none;
2701 resp->presentStatus = 0;
2705 int *toget = odr_intdup(assoc->encode, 0);
2706 int *presst = odr_intdup(assoc->encode, 0);
2707 Z_RecordComposition comp, *compp = 0;
2709 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2712 resp->resultCount = &bsrt->hits;
2714 comp.which = Z_RecordComp_simple;
2715 /* how many records does the user agent want, then? */
2716 if (bsrt->hits <= *req->smallSetUpperBound)
2718 *toget = bsrt->hits;
2719 if ((comp.u.simple = req->smallSetElementSetNames))
2722 else if (bsrt->hits < *req->largeSetLowerBound)
2724 *toget = *req->mediumSetPresentNumber;
2725 if (*toget > bsrt->hits)
2726 *toget = bsrt->hits;
2727 if ((comp.u.simple = req->mediumSetElementSetNames))
2733 if (*toget && !resp->records)
2738 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2741 form = prefformat->value;
2743 /* Call bend_present if defined */
2744 if (assoc->init->bend_present)
2746 bend_present_rr *bprr = (bend_present_rr *)
2747 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2748 bprr->setname = req->resultSetName;
2750 bprr->number = *toget;
2751 bprr->format = form;
2753 bprr->referenceId = req->referenceId;
2754 bprr->stream = assoc->encode;
2755 bprr->print = assoc->print;
2756 bprr->request = reqb;
2757 bprr->association = assoc;
2759 bprr->errstring = NULL;
2760 (*assoc->init->bend_present)(assoc->backend, bprr);
2766 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2767 *resp->presentStatus = Z_PresentStatus_failure;
2772 resp->records = pack_records(assoc, req->resultSetName, 1,
2773 toget, compp, next, presst, form, req->referenceId,
2774 req->preferredRecordSyntax, NULL);
2777 resp->numberOfRecordsReturned = toget;
2778 returnedrecs = *toget;
2779 resp->nextResultSetPosition = next;
2780 resp->searchStatus = sr;
2781 resp->resultSetStatus = 0;
2782 resp->presentStatus = presst;
2786 if (*resp->resultCount)
2788 resp->numberOfRecordsReturned = nulint;
2789 resp->nextResultSetPosition = next;
2790 resp->searchStatus = sr;
2791 resp->resultSetStatus = 0;
2792 resp->presentStatus = 0;
2795 resp->additionalSearchInfo = bsrt->search_info;
2800 WRBUF wr = wrbuf_alloc();
2802 for (i = 0 ; i < req->num_databaseNames; i++){
2804 wrbuf_printf(wr, "+");
2805 wrbuf_printf(wr, req->databaseNames[i]);
2807 wrbuf_printf(wr, " ");
2810 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2812 wrbuf_printf(wr, "OK %d", bsrt->hits);
2813 wrbuf_printf(wr, " %s 1+%d ",
2814 req->resultSetName, returnedrecs);
2815 yaz_query_to_wrbuf(wr, req->query);
2817 yaz_log(log_request, "Search %s", wrbuf_buf(wr));
2824 * Maybe we got a little over-friendly when we designed bend_fetch to
2825 * get only one record at a time. Some backends can optimise multiple-record
2826 * fetches, and at any rate, there is some overhead involved in
2827 * all that selecting and hopping around. Problem is, of course, that the
2828 * frontend can't know ahead of time how many records it'll need to
2829 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2830 * is downright lousy as a bulk data transfer protocol.
2832 * To start with, we'll do the fetching of records from the backend
2833 * in one operation: To save some trips in and out of the event-handler,
2834 * and to simplify the interface to pack_records. At any rate, asynch
2835 * operation is more fun in operations that have an unpredictable execution
2836 * speed - which is normally more true for search than for present.
2838 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2841 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2845 Z_PresentResponse *resp;
2849 const char *errstring = 0;
2851 yaz_log(log_requestdetail, "Got PresentRequest.");
2853 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2856 form = prefformat->value;
2857 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2859 resp->presentStatus = odr_intdup(assoc->encode, 0);
2860 if (assoc->init->bend_present)
2862 bend_present_rr *bprr = (bend_present_rr *)
2863 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2864 bprr->setname = req->resultSetId;
2865 bprr->start = *req->resultSetStartPoint;
2866 bprr->number = *req->numberOfRecordsRequested;
2867 bprr->format = form;
2868 bprr->comp = req->recordComposition;
2869 bprr->referenceId = req->referenceId;
2870 bprr->stream = assoc->encode;
2871 bprr->print = assoc->print;
2872 bprr->request = reqb;
2873 bprr->association = assoc;
2875 bprr->errstring = NULL;
2876 (*assoc->init->bend_present)(assoc->backend, bprr);
2879 return 0; /* should not happen */
2882 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2883 *resp->presentStatus = Z_PresentStatus_failure;
2884 errcode = bprr->errcode;
2885 errstring = bprr->errstring;
2888 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2889 next = odr_intdup(assoc->encode, 0);
2890 num = odr_intdup(assoc->encode, 0);
2892 apdu->which = Z_APDU_presentResponse;
2893 apdu->u.presentResponse = resp;
2894 resp->referenceId = req->referenceId;
2895 resp->otherInfo = 0;
2899 *num = *req->numberOfRecordsRequested;
2901 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2902 num, req->recordComposition, next,
2903 resp->presentStatus,
2904 form, req->referenceId, req->preferredRecordSyntax,
2909 WRBUF wr = wrbuf_alloc();
2910 wrbuf_printf(wr, "Present ");
2912 if (*resp->presentStatus == Z_PresentStatus_failure)
2913 wrbuf_printf(wr, "ERROR %d ", errcode);
2914 else if (*resp->presentStatus == Z_PresentStatus_success)
2915 wrbuf_printf(wr, "OK - ");
2917 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2919 wrbuf_printf(wr, " %s %d+%d ",
2920 req->resultSetId, *req->resultSetStartPoint,
2921 *req->numberOfRecordsRequested);
2922 yaz_log(log_request, "%s", wrbuf_buf(wr) );
2927 resp->numberOfRecordsReturned = num;
2928 resp->nextResultSetPosition = next;
2934 * Scan was implemented rather in a hurry, and with support for only the basic
2935 * elements of the service in the backend API. Suggestions are welcome.
2937 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2939 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2940 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2941 Z_ScanResponse *res = (Z_ScanResponse *)
2942 odr_malloc (assoc->encode, sizeof(*res));
2943 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2944 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2945 Z_ListEntries *ents = (Z_ListEntries *)
2946 odr_malloc (assoc->encode, sizeof(*ents));
2947 Z_DiagRecs *diagrecs_p = NULL;
2949 bend_scan_rr *bsrr = (bend_scan_rr *)
2950 odr_malloc (assoc->encode, sizeof(*bsrr));
2951 struct scan_entry *save_entries;
2953 yaz_log(log_requestdetail, "Got ScanRequest");
2955 apdu->which = Z_APDU_scanResponse;
2956 apdu->u.scanResponse = res;
2957 res->referenceId = req->referenceId;
2959 /* if step is absent, set it to 0 */
2960 res->stepSize = odr_intdup(assoc->encode, 0);
2962 *res->stepSize = *req->stepSize;
2964 res->scanStatus = scanStatus;
2965 res->numberOfEntriesReturned = numberOfEntriesReturned;
2966 res->positionOfTerm = 0;
2967 res->entries = ents;
2968 ents->num_entries = 0;
2969 ents->entries = NULL;
2970 ents->num_nonsurrogateDiagnostics = 0;
2971 ents->nonsurrogateDiagnostics = NULL;
2972 res->attributeSet = 0;
2975 if (req->databaseNames)
2978 for (i = 0; i < req->num_databaseNames; i++)
2979 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2981 bsrr->scanClause = 0;
2983 bsrr->errstring = 0;
2984 bsrr->num_bases = req->num_databaseNames;
2985 bsrr->basenames = req->databaseNames;
2986 bsrr->num_entries = *req->numberOfTermsRequested;
2987 bsrr->term = req->termListAndStartPoint;
2988 bsrr->referenceId = req->referenceId;
2989 bsrr->stream = assoc->encode;
2990 bsrr->print = assoc->print;
2991 bsrr->step_size = res->stepSize;
2993 /* For YAZ 2.0 and earlier it was the backend handler that
2994 initialized entries (member display_term did not exist)
2995 YAZ 2.0 and later sets 'entries' and initialize all members
2996 including 'display_term'. If YAZ 2.0 or later sees that
2997 entries was modified - we assume that it is an old handler and
2998 that 'display_term' is _not_ set.
3000 if (bsrr->num_entries > 0)
3003 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3005 for (i = 0; i<bsrr->num_entries; i++)
3007 bsrr->entries[i].term = 0;
3008 bsrr->entries[i].occurrences = 0;
3009 bsrr->entries[i].errcode = 0;
3010 bsrr->entries[i].errstring = 0;
3011 bsrr->entries[i].display_term = 0;
3014 save_entries = bsrr->entries; /* save it so we can compare later */
3016 if (req->attributeSet &&
3017 (attset = oid_getentbyoid(req->attributeSet)) &&
3018 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
3019 bsrr->attributeset = attset->value;
3021 bsrr->attributeset = VAL_NONE;
3022 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3023 bsrr->attributeset);
3024 bsrr->term_position = req->preferredPositionInResponse ?
3025 *req->preferredPositionInResponse : 1;
3027 ((int (*)(void *, bend_scan_rr *))
3028 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3031 diagrecs_p = zget_DiagRecs(assoc->encode,
3032 bsrr->errcode, bsrr->errstring);
3036 Z_Entry **tab = (Z_Entry **)
3037 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3039 if (bsrr->status == BEND_SCAN_PARTIAL)
3040 *scanStatus = Z_Scan_partial_5;
3042 *scanStatus = Z_Scan_success;
3043 ents->entries = tab;
3044 ents->num_entries = bsrr->num_entries;
3045 res->numberOfEntriesReturned = &ents->num_entries;
3046 res->positionOfTerm = &bsrr->term_position;
3047 for (i = 0; i < bsrr->num_entries; i++)
3053 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3054 if (bsrr->entries[i].occurrences >= 0)
3056 e->which = Z_Entry_termInfo;
3057 e->u.termInfo = t = (Z_TermInfo *)
3058 odr_malloc(assoc->encode, sizeof(*t));
3059 t->suggestedAttributes = 0;
3061 if (save_entries == bsrr->entries &&
3062 bsrr->entries[i].display_term)
3064 /* the entries was _not_ set by the handler. So it's
3065 safe to test for new member display_term. It is
3068 t->displayTerm = odr_strdup(assoc->encode,
3069 bsrr->entries[i].display_term);
3071 t->alternativeTerm = 0;
3072 t->byAttributes = 0;
3073 t->otherTermInfo = 0;
3074 t->globalOccurrences = &bsrr->entries[i].occurrences;
3075 t->term = (Z_Term *)
3076 odr_malloc(assoc->encode, sizeof(*t->term));
3077 t->term->which = Z_Term_general;
3078 t->term->u.general = o =
3079 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3080 o->buf = (unsigned char *)
3081 odr_malloc(assoc->encode, o->len = o->size =
3082 strlen(bsrr->entries[i].term));
3083 memcpy(o->buf, bsrr->entries[i].term, o->len);
3084 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3085 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3089 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3090 bsrr->entries[i].errcode,
3091 bsrr->entries[i].errstring);
3092 assert (drecs->num_diagRecs == 1);
3093 e->which = Z_Entry_surrogateDiagnostic;
3094 assert (drecs->diagRecs[0]);
3095 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3101 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3102 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3107 WRBUF wr = wrbuf_alloc();
3108 wrbuf_printf(wr, "Scan ");
3109 for (i = 0 ; i < req->num_databaseNames; i++){
3111 wrbuf_printf(wr, "+");
3112 wrbuf_printf(wr, req->databaseNames[i]);
3114 wrbuf_printf(wr, " ");
3117 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3118 wrbuf_printf(wr, " ");
3121 wrbuf_printf(wr, "OK ");
3122 /* else if (*res->scanStatus == Z_Scan_success) */
3123 /* wrbuf_printf(wr, "OK "); */
3125 /* wrbuf_printf(wr, "Partial "); */
3127 if (*res->numberOfEntriesReturned)
3128 wrbuf_printf(wr, "%d - ", *res->numberOfEntriesReturned);
3130 wrbuf_printf(wr, "0 - ");
3132 wrbuf_printf(wr, "%d+%d+%d ",
3133 (req->preferredPositionInResponse ?
3134 *req->preferredPositionInResponse : 1),
3135 *req->numberOfTermsRequested,
3136 (res->stepSize ? *res->stepSize : 1));
3138 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3139 bsrr->attributeset);
3140 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3146 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3150 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3151 Z_SortResponse *res = (Z_SortResponse *)
3152 odr_malloc (assoc->encode, sizeof(*res));
3153 bend_sort_rr *bsrr = (bend_sort_rr *)
3154 odr_malloc (assoc->encode, sizeof(*bsrr));
3156 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3158 yaz_log(log_requestdetail, "Got SortRequest.");
3160 bsrr->num_input_setnames = req->num_inputResultSetNames;
3161 for (i=0;i<req->num_inputResultSetNames;i++)
3162 yaz_log(log_requestdetail, "Input resultset: '%s'",
3163 req->inputResultSetNames[i]);
3164 bsrr->input_setnames = req->inputResultSetNames;
3165 bsrr->referenceId = req->referenceId;
3166 bsrr->output_setname = req->sortedResultSetName;
3167 yaz_log(log_requestdetail, "Output resultset: '%s'",
3168 req->sortedResultSetName);
3169 bsrr->sort_sequence = req->sortSequence;
3170 /*FIXME - dump those sequences too */
3171 bsrr->stream = assoc->encode;
3172 bsrr->print = assoc->print;
3174 bsrr->sort_status = Z_SortResponse_failure;
3176 bsrr->errstring = 0;
3178 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3180 res->referenceId = bsrr->referenceId;
3181 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3182 res->resultSetStatus = 0;
3185 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3186 bsrr->errcode, bsrr->errstring);
3187 res->diagnostics = dr->diagRecs;
3188 res->num_diagnostics = dr->num_diagRecs;
3192 res->num_diagnostics = 0;
3193 res->diagnostics = 0;
3195 res->resultCount = 0;
3198 apdu->which = Z_APDU_sortResponse;
3199 apdu->u.sortResponse = res;
3202 WRBUF wr = wrbuf_alloc();
3203 wrbuf_printf(wr, "Sort ");
3205 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3207 wrbuf_printf(wr, "OK -");
3208 wrbuf_printf(wr, " (");
3209 for (i = 0; i<req->num_inputResultSetNames; i++)
3212 wrbuf_printf(wr, "+");
3213 wrbuf_printf(wr, req->inputResultSetNames[i]);
3215 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3217 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3223 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3227 Z_DeleteResultSetRequest *req =
3228 reqb->apdu_request->u.deleteResultSetRequest;
3229 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3230 odr_malloc (assoc->encode, sizeof(*res));
3231 bend_delete_rr *bdrr = (bend_delete_rr *)
3232 odr_malloc (assoc->encode, sizeof(*bdrr));
3233 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3235 yaz_log(log_requestdetail, "Got DeleteRequest.");
3237 bdrr->num_setnames = req->num_resultSetList;
3238 bdrr->setnames = req->resultSetList;
3239 for (i = 0; i<req->num_resultSetList; i++)
3240 yaz_log(log_requestdetail, "resultset: '%s'",
3241 req->resultSetList[i]);
3242 bdrr->stream = assoc->encode;
3243 bdrr->print = assoc->print;
3244 bdrr->function = *req->deleteFunction;
3245 bdrr->referenceId = req->referenceId;
3247 if (bdrr->num_setnames > 0)
3249 bdrr->statuses = (int*)
3250 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3251 bdrr->num_setnames);
3252 for (i = 0; i < bdrr->num_setnames; i++)
3253 bdrr->statuses[i] = 0;
3255 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3257 res->referenceId = req->referenceId;
3259 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3261 res->deleteListStatuses = 0;
3262 if (bdrr->num_setnames > 0)
3265 res->deleteListStatuses = (Z_ListStatuses *)
3266 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3267 res->deleteListStatuses->num = bdrr->num_setnames;
3268 res->deleteListStatuses->elements =
3270 odr_malloc (assoc->encode,
3271 sizeof(*res->deleteListStatuses->elements) *
3272 bdrr->num_setnames);
3273 for (i = 0; i<bdrr->num_setnames; i++)
3275 res->deleteListStatuses->elements[i] =
3277 odr_malloc (assoc->encode,
3278 sizeof(**res->deleteListStatuses->elements));
3279 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3280 res->deleteListStatuses->elements[i]->id =
3281 odr_strdup (assoc->encode, bdrr->setnames[i]);
3284 res->numberNotDeleted = 0;
3285 res->bulkStatuses = 0;
3286 res->deleteMessage = 0;
3289 apdu->which = Z_APDU_deleteResultSetResponse;
3290 apdu->u.deleteResultSetResponse = res;
3293 WRBUF wr = wrbuf_alloc();
3294 wrbuf_printf(wr, "Delete ");
3295 if (bdrr->delete_status)
3296 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3298 wrbuf_printf(wr, "OK -");
3299 for (i = 0; i<req->num_resultSetList; i++)
3300 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3301 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3307 static void process_close(association *assoc, request *reqb)
3309 Z_Close *req = reqb->apdu_request->u.close;
3310 static char *reasons[] =
3317 "securityViolation",
3324 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3325 reasons[*req->closeReason], req->diagnosticInformation ?
3326 req->diagnosticInformation : "NULL");
3327 if (assoc->version < 3) /* to make do_force respond with close */
3329 do_close_req(assoc, Z_Close_finished,
3330 "Association terminated by client", reqb);
3331 yaz_log(log_request,"Close OK");
3334 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3338 reqb->len_refid = refid->len;
3339 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3340 memcpy (reqb->refid, refid->buf, refid->len);
3344 reqb->len_refid = 0;
3349 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3351 process_z_response (a, req, res);
3354 bend_request bend_request_mk (bend_association a)
3356 request *nreq = request_get (&a->outgoing);
3357 nreq->request_mem = nmem_create ();
3361 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3366 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3367 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3368 id->len = id->size = req->len_refid;
3369 memcpy (id->buf, req->refid, req->len_refid);
3373 void bend_request_destroy (bend_request *req)
3375 nmem_destroy((*req)->request_mem);
3376 request_release(*req);
3380 int bend_backend_respond (bend_association a, bend_request req)
3384 r = process_z_request (a, req, &msg);
3386 yaz_log (YLOG_WARN, "%s", msg);
3390 void bend_request_setdata(bend_request r, void *p)
3395 void *bend_request_getdata(bend_request r)
3397 return r->clientData;
3400 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3402 bend_segment_rr req;
3404 req.segment = reqb->apdu_request->u.segmentRequest;
3405 req.stream = assoc->encode;
3406 req.decode = assoc->decode;
3407 req.print = assoc->print;
3408 req.association = assoc;
3410 (*assoc->init->bend_segment)(assoc->backend, &req);
3415 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3417 bend_esrequest_rr esrequest;
3418 const char *ext_name = "unknown";
3420 Z_ExtendedServicesRequest *req =
3421 reqb->apdu_request->u.extendedServicesRequest;
3422 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3424 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3426 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3427 esrequest.stream = assoc->encode;
3428 esrequest.decode = assoc->decode;
3429 esrequest.print = assoc->print;
3430 esrequest.errcode = 0;
3431 esrequest.errstring = NULL;
3432 esrequest.request = reqb;
3433 esrequest.association = assoc;
3434 esrequest.taskPackage = 0;
3435 esrequest.referenceId = req->referenceId;
3438 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3440 switch(esrequest.esr->taskSpecificParameters->which)
3442 case Z_External_itemOrder:
3443 ext_name = "ItemOrder"; break;
3444 case Z_External_update:
3445 ext_name = "Update"; break;
3446 case Z_External_update0:
3447 ext_name = "Update0"; break;
3448 case Z_External_ESAdmin:
3449 ext_name = "Admin"; break;
3454 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3456 /* If the response is being delayed, return NULL */
3457 if (esrequest.request == NULL)
3460 resp->referenceId = req->referenceId;
3462 if (esrequest.errcode == -1)
3464 /* Backend service indicates request will be processed */
3465 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3466 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3468 else if (esrequest.errcode == 0)
3470 /* Backend service indicates request will be processed */
3471 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3472 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3476 Z_DiagRecs *diagRecs =
3477 zget_DiagRecs(assoc->encode, esrequest.errcode,
3478 esrequest.errstring);
3479 /* Backend indicates error, request will not be processed */
3480 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3481 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3482 resp->num_diagnostics = diagRecs->num_diagRecs;
3483 resp->diagnostics = diagRecs->diagRecs;
3486 WRBUF wr = wrbuf_alloc();
3487 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3488 yaz_log(log_request, "EsRequest %s", wrbuf_buf(wr) );
3493 /* Do something with the members of bend_extendedservice */
3494 if (esrequest.taskPackage)
3495 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
3496 (const char *) esrequest.taskPackage,
3498 yaz_log(YLOG_DEBUG,"Send the result apdu");
3505 * indent-tabs-mode: nil
3507 * vim: shiftwidth=4 tabstop=8 expandtab