2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.101 2006-10-24 08:07:02 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(void)
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 yaz_log(YLOG_LOG, "CQL string=%s", srw_req->query.cql);
910 if (assoc->server && assoc->server->cql_transform)
912 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
913 assoc->server->cql_transform,
917 yaz_add_srw_diagnostic(assoc->encode,
918 &srw_res->diagnostics,
919 &srw_res->num_diagnostics,
925 /* CQL query to backend. Wrap it - Z39.50 style */
926 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
927 ext->direct_reference = odr_getoidbystr(assoc->decode,
928 "1.2.840.10003.16.2");
929 ext->indirect_reference = 0;
931 ext->which = Z_External_CQL;
932 ext->u.cql = srw_req->query.cql;
934 rr.query->which = Z_Query_type_104;
935 rr.query->u.type_104 = ext;
938 else if (srw_req->query_type == Z_SRW_query_type_pqf)
940 Z_RPNQuery *RPNquery;
941 YAZ_PQF_Parser pqf_parser;
943 pqf_parser = yaz_pqf_create ();
945 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
951 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
952 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
953 code, pqf_msg, (long) off);
954 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
957 rr.query->which = Z_Query_type_1;
958 rr.query->u.type_1 = RPNquery;
960 yaz_pqf_destroy (pqf_parser);
964 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
965 &srw_res->num_diagnostics,
966 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
968 if (rr.query->u.type_1)
970 rr.stream = assoc->encode;
971 rr.decode = assoc->decode;
972 rr.print = assoc->print;
974 if ( srw_req->sort.sortKeys )
975 rr.srw_sortKeys = odr_strdup(assoc->encode,
976 srw_req->sort.sortKeys );
977 rr.association = assoc;
983 yaz_log_zquery_level(log_requestdetail,rr.query);
985 (assoc->init->bend_search)(assoc->backend, &rr);
988 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
994 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
995 yaz_add_srw_diagnostic(assoc->encode,
996 &srw_res->diagnostics,
997 &srw_res->num_diagnostics,
998 srw_error, rr.errstring);
1003 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
1004 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
1006 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
1007 start, number, rr.hits);
1009 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1012 srw_res->resultSetId =
1013 odr_strdup(assoc->encode, rr.srw_setname );
1014 srw_res->resultSetIdleTime =
1015 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1018 if (start > rr.hits || start < 1)
1020 yaz_add_srw_diagnostic(
1022 &srw_res->diagnostics, &srw_res->num_diagnostics,
1023 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1025 else if (number > 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;
1130 const char *querystr = "?";
1131 const char *querytype = "?";
1132 WRBUF wr = wrbuf_alloc();
1134 switch (srw_req->query_type)
1136 case Z_SRW_query_type_cql:
1138 querystr = srw_req->query.cql;
1140 case Z_SRW_query_type_pqf:
1142 querystr = srw_req->query.pqf;
1145 wrbuf_printf(wr, "SRWSearch ");
1146 wrbuf_printf(wr, srw_req->database);
1147 wrbuf_printf(wr, " ");
1148 if (srw_res->num_diagnostics)
1149 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1150 else if (*http_code != 200)
1151 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1152 else if (srw_res->numberOfRecords)
1154 wrbuf_printf(wr, "OK %d",
1155 (srw_res->numberOfRecords ?
1156 *srw_res->numberOfRecords : 0));
1158 wrbuf_printf(wr, " %s %d+%d",
1159 (srw_res->resultSetId ?
1160 srw_res->resultSetId : "-"),
1161 (srw_req->startRecord ? *srw_req->startRecord : 1),
1162 srw_res->num_records);
1163 yaz_log(log_request, "%s %s: %s", wrbuf_buf(wr), querytype, querystr);
1168 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1171 xmlNodePtr ptr = rr->server_node_ptr;
1174 for (ptr = ptr->children; ptr; ptr = ptr->next)
1176 if (ptr->type != XML_ELEMENT_NODE)
1178 if (!strcmp((const char *) ptr->name, "explain"))
1181 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1185 ptr = xmlCopyNode(ptr, 1);
1187 xmlDocSetRootElement(doc, ptr);
1189 xmlDocDumpMemory(doc, &buf_out, &len);
1190 content = (char*) odr_malloc(rr->stream, 1+len);
1191 memcpy(content, buf_out, len);
1192 content[len] = '\0';
1196 rr->explain_buf = content;
1204 static void srw_bend_explain(association *assoc, request *req,
1206 Z_SRW_explainResponse *srw_res,
1209 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1210 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1212 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1217 rr.stream = assoc->encode;
1218 rr.decode = assoc->decode;
1219 rr.print = assoc->print;
1221 rr.database = srw_req->database;
1223 rr.server_node_ptr = assoc->server->server_node_ptr;
1225 rr.server_node_ptr = 0;
1226 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1227 if (assoc->init->bend_explain)
1228 (*assoc->init->bend_explain)(assoc->backend, &rr);
1230 srw_bend_explain_default(assoc->backend, &rr);
1234 int packing = Z_SRW_recordPacking_string;
1235 if (srw_req->recordPacking)
1237 if (!strcmp(srw_req->recordPacking, "xml"))
1238 packing = Z_SRW_recordPacking_XML;
1239 else if (!strcmp(srw_req->recordPacking, "url"))
1240 packing = Z_SRW_recordPacking_URL;
1242 srw_res->record.recordSchema = rr.schema;
1243 srw_res->record.recordPacking = packing;
1244 srw_res->record.recordData_buf = rr.explain_buf;
1245 srw_res->record.recordData_len = strlen(rr.explain_buf);
1246 srw_res->record.recordPosition = 0;
1252 static void srw_bend_scan(association *assoc, request *req,
1254 Z_SRW_scanResponse *srw_res,
1257 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1258 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1261 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1262 if (srw_res->num_diagnostics == 0 && assoc->init)
1264 struct scan_entry *save_entries;
1266 bend_scan_rr *bsrr = (bend_scan_rr *)
1267 odr_malloc (assoc->encode, sizeof(*bsrr));
1268 bsrr->num_bases = 1;
1269 bsrr->basenames = &srw_req->database;
1271 bsrr->num_entries = srw_req->maximumTerms ?
1272 *srw_req->maximumTerms : 10;
1273 bsrr->term_position = srw_req->responsePosition ?
1274 *srw_req->responsePosition : 1;
1277 bsrr->errstring = 0;
1278 bsrr->referenceId = 0;
1279 bsrr->stream = assoc->encode;
1280 bsrr->print = assoc->print;
1281 bsrr->step_size = odr_intdup(assoc->decode, 0);
1284 if (bsrr->num_entries > 0)
1287 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1289 for (i = 0; i<bsrr->num_entries; i++)
1291 bsrr->entries[i].term = 0;
1292 bsrr->entries[i].occurrences = 0;
1293 bsrr->entries[i].errcode = 0;
1294 bsrr->entries[i].errstring = 0;
1295 bsrr->entries[i].display_term = 0;
1298 save_entries = bsrr->entries; /* save it so we can compare later */
1300 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1301 assoc->init->bend_scan)
1303 Odr_oid *scan_attributeSet = 0;
1305 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1307 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1309 srw_req->scanClause.pqf);
1310 if (scan_attributeSet &&
1311 (attset = oid_getentbyoid(scan_attributeSet)) &&
1312 (attset->oclass == CLASS_ATTSET ||
1313 attset->oclass == CLASS_GENERAL))
1314 bsrr->attributeset = attset->value;
1316 bsrr->attributeset = VAL_NONE;
1317 yaz_pqf_destroy(pqf_parser);
1318 bsrr->scanClause = 0;
1319 ((int (*)(void *, bend_scan_rr *))
1320 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1322 else if (srw_req->query_type == Z_SRW_query_type_cql
1323 && assoc->init->bend_scan && assoc->server
1324 && assoc->server->cql_transform)
1327 bsrr->scanClause = 0;
1328 bsrr->attributeset = VAL_NONE;
1329 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1330 srw_error = cql2pqf_scan(assoc->encode,
1331 srw_req->scanClause.cql,
1332 assoc->server->cql_transform,
1335 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1336 &srw_res->num_diagnostics,
1340 ((int (*)(void *, bend_scan_rr *))
1341 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1344 else if (srw_req->query_type == Z_SRW_query_type_cql
1345 && assoc->init->bend_srw_scan)
1348 bsrr->attributeset = VAL_NONE;
1349 bsrr->scanClause = srw_req->scanClause.cql;
1350 ((int (*)(void *, bend_scan_rr *))
1351 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1355 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1356 &srw_res->num_diagnostics,
1357 YAZ_SRW_UNSUPP_OPERATION, "scan");
1362 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1367 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1369 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1370 &srw_res->num_diagnostics,
1371 srw_error, bsrr->errstring);
1373 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1376 srw_res->terms = (Z_SRW_scanTerm*)
1377 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1380 srw_res->num_terms = bsrr->num_entries;
1381 for (i = 0; i<bsrr->num_entries; i++)
1383 Z_SRW_scanTerm *t = srw_res->terms + i;
1384 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1385 t->numberOfRecords =
1386 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1388 if (save_entries == bsrr->entries &&
1389 bsrr->entries[i].display_term)
1391 /* the entries was _not_ set by the handler. So it's
1392 safe to test for new member display_term. It is
1395 t->displayTerm = odr_strdup(assoc->encode,
1396 bsrr->entries[i].display_term);
1404 WRBUF wr = wrbuf_alloc();
1405 const char *querytype = 0;
1406 const char *querystr = 0;
1408 switch(srw_req->query_type)
1410 case Z_SRW_query_type_pqf:
1412 querystr = srw_req->scanClause.pqf;
1414 case Z_SRW_query_type_cql:
1416 querystr = srw_req->scanClause.cql;
1419 querytype = "UNKNOWN";
1423 wrbuf_printf(wr, "SRWScan ");
1424 wrbuf_printf(wr, srw_req->database);
1425 wrbuf_printf(wr, " ");
1427 if (srw_res->num_diagnostics)
1428 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1429 else if (srw_res->num_terms)
1430 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1432 wrbuf_printf(wr, "OK - - ");
1434 wrbuf_printf(wr, "%d+%d+0 ",
1435 (srw_req->responsePosition ?
1436 *srw_req->responsePosition : 1),
1437 (srw_req->maximumTerms ?
1438 *srw_req->maximumTerms : 1));
1439 /* there is no step size in SRU/W ??? */
1440 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1441 yaz_log(log_request, "%s ", wrbuf_buf(wr) );
1447 static void srw_bend_update(association *assoc, request *req,
1449 Z_SRW_updateResponse *srw_res,
1452 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1453 yaz_log(YLOG_DEBUG, "Got SRW UpdateRequest");
1454 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1456 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1461 rr.stream = assoc->encode;
1462 rr.print = assoc->print;
1464 rr.basenames = &srw_req->database;
1465 rr.operation = srw_req->operation;
1466 rr.operation_status = "failed";
1468 rr.record_version = 0;
1469 rr.record_checksum = 0;
1470 rr.record_old_version = 0;
1471 rr.record_packing = "xml";
1472 rr.record_schema = 0;
1474 rr.request_extra_record = 0;
1475 rr.response_extra_record = 0;
1476 rr.extra_request_data = 0;
1477 rr.extra_response_data = 0;
1482 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1483 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1484 if ( !strcmp( rr.operation, "delete" ) ){
1485 if ( !srw_req->recordId ){
1486 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1487 &srw_res->num_diagnostics,
1491 rr.record_id = srw_req->recordId;
1493 if ( !srw_req->recordVersion ){
1494 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1495 &srw_res->num_diagnostics,
1496 7, "recordVersion" );
1499 rr.record_version = odr_strdup( assoc->encode,
1500 srw_req->recordVersion );
1503 if ( srw_req->recordOldVersion ){
1504 rr.record_old_version = odr_strdup(assoc->encode,
1505 srw_req->recordOldVersion );
1507 if ( srw_req->extraRequestData ){
1508 rr.extra_request_data = odr_strdup(assoc->encode,
1509 srw_req->extraRequestData );
1512 else if ( !strcmp( rr.operation, "replace" ) ){
1513 if ( !srw_req->recordId ){
1514 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1515 &srw_res->num_diagnostics,
1519 rr.record_id = srw_req->recordId;
1521 if ( srw_req->record.recordSchema == 0 ){
1522 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1523 &srw_res->num_diagnostics,
1524 7, "recordSchema" );
1527 rr.record_schema = odr_strdup(assoc->encode,
1528 srw_req->record.recordSchema );
1530 switch (srw_req->record.recordPacking)
1532 case Z_SRW_recordPacking_string:
1533 rr.record_packing = "string";
1535 case Z_SRW_recordPacking_XML:
1536 rr.record_packing = "xml";
1538 case Z_SRW_recordPacking_URL:
1539 rr.record_packing = "url";
1542 if ( srw_req->record.recordData_len ){
1543 rr.record_data = odr_strdupn(assoc->encode,
1544 srw_req->record.recordData_buf,
1545 srw_req->record.recordData_len );
1546 rr.request_extra_record = srw_req->extra_record;
1549 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1550 &srw_res->num_diagnostics,
1553 if (srw_req->extraRequestData)
1554 rr.extra_request_data = odr_strdup(assoc->encode,
1555 srw_req->extraRequestData );
1557 else if ( !strcmp( rr.operation, "insert" ) )
1559 rr.record_id = srw_req->recordId;
1560 if ( srw_req->record.recordSchema == 0 ){
1561 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1562 &srw_res->num_diagnostics,
1563 7, "recordSchema" );
1566 rr.record_schema = odr_strdup(assoc->encode,
1567 srw_req->record.recordSchema);
1569 switch (srw_req->record.recordPacking)
1571 case Z_SRW_recordPacking_string:
1572 rr.record_packing = "string";
1574 case Z_SRW_recordPacking_XML:
1575 rr.record_packing = "xml";
1577 case Z_SRW_recordPacking_URL:
1578 rr.record_packing = "url";
1582 if (srw_req->record.recordData_len)
1584 rr.record_data = odr_strdupn(assoc->encode,
1585 srw_req->record.recordData_buf,
1586 srw_req->record.recordData_len );
1587 rr.request_extra_record = srw_req->extra_record;
1590 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1591 &srw_res->num_diagnostics,
1593 if ( srw_req->extraRequestData )
1594 rr.extra_request_data = odr_strdup(assoc->encode,
1595 srw_req->extraRequestData );
1597 if (srw_res->num_diagnostics == 0)
1599 if ( assoc->init->bend_srw_update)
1600 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1602 yaz_log( YLOG_WARN, "Got No Update function!");
1608 yaz_add_srw_diagnostic_uri(assoc->encode,
1609 &srw_res->diagnostics,
1610 &srw_res->num_diagnostics,
1614 srw_res->recordId = rr.record_id;
1615 srw_res->operationStatus = rr.operation_status;
1616 srw_res->recordVersion = rr.record_version;
1617 srw_res->recordChecksum = rr.record_checksum;
1618 srw_res->extraResponseData = rr.extra_response_data;
1619 srw_res->record.recordPosition = 0;
1620 if (srw_res->num_diagnostics == 0 && rr.record_data)
1622 srw_res->record.recordSchema = rr.record_schema;
1623 srw_res->record.recordPacking = srw_req->record.recordPacking;
1624 srw_res->record.recordData_buf = rr.record_data;
1625 srw_res->record.recordData_len = strlen(rr.record_data);
1626 srw_res->extra_record = rr.response_extra_record;
1630 srw_res->record.recordData_len = 0;
1635 /* check if path is OK (1); BAD (0) */
1636 static int check_path(const char *path)
1640 if (strstr(path, ".."))
1645 static char *read_file(const char *fname, ODR o, int *sz)
1648 FILE *inf = fopen(fname, "rb");
1652 fseek(inf, 0L, SEEK_END);
1655 buf = odr_malloc(o, *sz);
1656 fread(buf, 1, *sz, inf);
1661 static void process_http_request(association *assoc, request *req)
1663 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1664 ODR o = assoc->encode;
1665 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1667 Z_SOAP *soap_package = 0;
1670 Z_HTTP_Response *hres = 0;
1672 const char *stylesheet = 0; /* for now .. set later */
1673 Z_SRW_diagnostic *diagnostic = 0;
1674 int num_diagnostic = 0;
1675 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1677 if (!control_association(assoc, host, 0))
1679 p = z_get_HTTP_Response(o, 404);
1682 if (r == 2 && assoc->server && assoc->server->docpath
1683 && hreq->path[0] == '/'
1685 /* check if path is a proper prefix of documentroot */
1686 strncmp(hreq->path+1, assoc->server->docpath,
1687 strlen(assoc->server->docpath))
1690 if (!check_path(hreq->path))
1692 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1693 p = z_get_HTTP_Response(o, 404);
1697 int content_size = 0;
1698 char *content_buf = read_file(hreq->path+1, o, &content_size);
1701 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1702 p = z_get_HTTP_Response(o, 404);
1706 const char *ctype = 0;
1707 yaz_mime_types types = yaz_mime_types_create();
1709 yaz_mime_types_add(types, "xsl", "application/xml");
1710 yaz_mime_types_add(types, "xml", "application/xml");
1711 yaz_mime_types_add(types, "css", "text/css");
1712 yaz_mime_types_add(types, "html", "text/html");
1713 yaz_mime_types_add(types, "htm", "text/html");
1714 yaz_mime_types_add(types, "txt", "text/plain");
1715 yaz_mime_types_add(types, "js", "application/x-javascript");
1717 yaz_mime_types_add(types, "gif", "image/gif");
1718 yaz_mime_types_add(types, "png", "image/png");
1719 yaz_mime_types_add(types, "jpg", "image/jpeg");
1720 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1722 ctype = yaz_mime_lookup_fname(types, hreq->path);
1725 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1726 p = z_get_HTTP_Response(o, 404);
1730 p = z_get_HTTP_Response(o, 200);
1731 hres = p->u.HTTP_Response;
1732 hres->content_buf = content_buf;
1733 hres->content_len = content_size;
1734 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1736 yaz_mime_types_destroy(types);
1744 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1745 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1747 if (r == 2) /* not taken */
1749 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1750 &diagnostic, &num_diagnostic);
1751 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1753 if (r == 0) /* decode SRW/SRU OK .. */
1755 int http_code = 200;
1756 if (sr->which == Z_SRW_searchRetrieve_request)
1759 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1761 stylesheet = sr->u.request->stylesheet;
1764 res->u.response->diagnostics = diagnostic;
1765 res->u.response->num_diagnostics = num_diagnostic;
1769 srw_bend_search(assoc, req, sr, res->u.response,
1772 if (http_code == 200)
1773 soap_package->u.generic->p = res;
1775 else if (sr->which == Z_SRW_explain_request)
1777 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1778 stylesheet = sr->u.explain_request->stylesheet;
1781 res->u.explain_response->diagnostics = diagnostic;
1782 res->u.explain_response->num_diagnostics = num_diagnostic;
1784 srw_bend_explain(assoc, req, sr,
1785 res->u.explain_response, &http_code);
1786 if (http_code == 200)
1787 soap_package->u.generic->p = res;
1789 else if (sr->which == Z_SRW_scan_request)
1791 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1792 stylesheet = sr->u.scan_request->stylesheet;
1795 res->u.scan_response->diagnostics = diagnostic;
1796 res->u.scan_response->num_diagnostics = num_diagnostic;
1798 srw_bend_scan(assoc, req, sr,
1799 res->u.scan_response, &http_code);
1800 if (http_code == 200)
1801 soap_package->u.generic->p = res;
1803 else if (sr->which == Z_SRW_update_request)
1805 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1806 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1809 res->u.update_response->diagnostics = diagnostic;
1810 res->u.update_response->num_diagnostics = num_diagnostic;
1812 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1813 srw_bend_update(assoc, req, sr,
1814 res->u.update_response, &http_code);
1815 if (http_code == 200)
1816 soap_package->u.generic->p = res;
1820 yaz_log(log_request, "SOAP ERROR");
1821 /* FIXME - what error, what query */
1823 z_soap_error(assoc->encode, soap_package,
1824 "SOAP-ENV:Client", "Bad method", 0);
1826 if (http_code == 200 || http_code == 500)
1828 static Z_SOAP_Handler soap_handlers[4] = {
1830 {"http://www.loc.gov/zing/srw/", 0,
1831 (Z_SOAP_fun) yaz_srw_codec},
1832 {"http://www.loc.gov/zing/srw/v1.0/", 0,
1833 (Z_SOAP_fun) yaz_srw_codec},
1834 {"http://www.loc.gov/zing/srw/update/", 0,
1835 (Z_SOAP_fun) yaz_ucp_codec},
1841 p = z_get_HTTP_Response(o, 200);
1842 hres = p->u.HTTP_Response;
1844 if (!stylesheet && assoc->server)
1845 stylesheet = assoc->server->stylesheet;
1847 /* empty stylesheet means NO stylesheet */
1848 if (stylesheet && *stylesheet == '\0')
1851 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1852 &hres->content_buf, &hres->content_len,
1853 soap_handlers, charset, stylesheet);
1854 hres->code = http_code;
1856 strcpy(ctype, "text/xml");
1859 strcat(ctype, "; charset=");
1860 strcat(ctype, charset);
1862 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1865 p = z_get_HTTP_Response(o, http_code);
1869 p = z_get_HTTP_Response(o, 500);
1870 hres = p->u.HTTP_Response;
1871 if (!strcmp(hreq->version, "1.0"))
1873 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1874 if (v && !strcmp(v, "Keep-Alive"))
1878 hres->version = "1.0";
1882 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1883 if (v && !strcmp(v, "close"))
1887 hres->version = "1.1";
1891 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1892 assoc->state = ASSOC_DEAD;
1893 assoc->cs_get_mask = 0;
1898 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1900 if (alive && isdigit(*(const unsigned char *) alive))
1904 if (t < 0 || t > 3600)
1906 iochan_settimeout(assoc->client_chan,t);
1907 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1909 process_gdu_response(assoc, req, p);
1912 static void process_gdu_request(association *assoc, request *req)
1914 if (req->gdu_request->which == Z_GDU_Z3950)
1917 req->apdu_request = req->gdu_request->u.z3950;
1918 if (process_z_request(assoc, req, &msg) < 0)
1919 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1921 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1922 process_http_request(assoc, req);
1925 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1930 * Initiate request processing.
1932 static int process_z_request(association *assoc, request *req, char **msg)
1938 *msg = "Unknown Error";
1939 assert(req && req->state == REQUEST_IDLE);
1940 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1942 *msg = "Missing InitRequest";
1945 switch (req->apdu_request->which)
1947 case Z_APDU_initRequest:
1948 res = process_initRequest(assoc, req); break;
1949 case Z_APDU_searchRequest:
1950 res = process_searchRequest(assoc, req, &fd); break;
1951 case Z_APDU_presentRequest:
1952 res = process_presentRequest(assoc, req, &fd); break;
1953 case Z_APDU_scanRequest:
1954 if (assoc->init->bend_scan)
1955 res = process_scanRequest(assoc, req, &fd);
1958 *msg = "Cannot handle Scan APDU";
1962 case Z_APDU_extendedServicesRequest:
1963 if (assoc->init->bend_esrequest)
1964 res = process_ESRequest(assoc, req, &fd);
1967 *msg = "Cannot handle Extended Services APDU";
1971 case Z_APDU_sortRequest:
1972 if (assoc->init->bend_sort)
1973 res = process_sortRequest(assoc, req, &fd);
1976 *msg = "Cannot handle Sort APDU";
1981 process_close(assoc, req);
1983 case Z_APDU_deleteResultSetRequest:
1984 if (assoc->init->bend_delete)
1985 res = process_deleteRequest(assoc, req, &fd);
1988 *msg = "Cannot handle Delete APDU";
1992 case Z_APDU_segmentRequest:
1993 if (assoc->init->bend_segment)
1995 res = process_segmentRequest (assoc, req);
1999 *msg = "Cannot handle Segment APDU";
2003 case Z_APDU_triggerResourceControlRequest:
2006 *msg = "Bad APDU received";
2011 yaz_log(YLOG_DEBUG, " result immediately available");
2012 retval = process_z_response(assoc, req, res);
2016 yaz_log(YLOG_DEBUG, " result unavailble");
2019 else /* no result yet - one will be provided later */
2023 /* Set up an I/O handler for the fd supplied by the backend */
2025 yaz_log(YLOG_DEBUG, " establishing handler for result");
2026 req->state = REQUEST_PENDING;
2027 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2029 iochan_setdata(chan, assoc);
2036 * Handle message from the backend.
2038 void backend_response(IOCHAN i, int event)
2040 association *assoc = (association *)iochan_getdata(i);
2041 request *req = request_head(&assoc->incoming);
2045 yaz_log(YLOG_DEBUG, "backend_response");
2046 assert(assoc && req && req->state != REQUEST_IDLE);
2047 /* determine what it is we're waiting for */
2048 switch (req->apdu_request->which)
2050 case Z_APDU_searchRequest:
2051 res = response_searchRequest(assoc, req, 0, &fd); break;
2053 case Z_APDU_presentRequest:
2054 res = response_presentRequest(assoc, req, 0, &fd); break;
2055 case Z_APDU_scanRequest:
2056 res = response_scanRequest(assoc, req, 0, &fd); break;
2059 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2062 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2064 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2065 do_close(assoc, Z_Close_systemProblem, 0);
2069 else if (!res) /* no result yet - try again later */
2071 yaz_log(YLOG_DEBUG, " no result yet");
2072 iochan_setfd(i, fd); /* in case fd has changed */
2077 * Encode response, and transfer the request structure to the outgoing queue.
2079 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2081 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2085 if (!z_GDU(assoc->print, &res, 0, 0))
2086 yaz_log(YLOG_WARN, "ODR print error: %s",
2087 odr_errmsg(odr_geterror(assoc->print)));
2088 odr_reset(assoc->print);
2090 if (!z_GDU(assoc->encode, &res, 0, 0))
2092 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2093 odr_errmsg(odr_geterror(assoc->decode)),
2094 odr_getelement(assoc->decode));
2097 req->response = odr_getbuf(assoc->encode, &req->len_response,
2098 &req->size_response);
2099 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2100 odr_reset(assoc->encode);
2101 req->state = REQUEST_IDLE;
2102 request_enq(&assoc->outgoing, req);
2103 /* turn the work over to the ir_session handler */
2104 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2105 assoc->cs_put_mask = EVENT_OUTPUT;
2106 /* Is there more work to be done? give that to the input handler too */
2108 if (request_head(&assoc->incoming))
2110 yaz_log (YLOG_DEBUG, "more work to be done");
2111 iochan_setevent(assoc->client_chan, EVENT_WORK);
2118 * Encode response, and transfer the request structure to the outgoing queue.
2120 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2122 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2123 gres->which = Z_GDU_Z3950;
2124 gres->u.z3950 = res;
2126 return process_gdu_response(assoc, req, gres);
2129 static char *get_vhost(Z_OtherInformation *otherInfo)
2131 return yaz_oi_get_string_oidval(&otherInfo, VAL_PROXY, 1, 0);
2135 * Handle init request.
2136 * At the moment, we don't check the options
2137 * anywhere else in the code - we just try not to do anything that would
2138 * break a naive client. We'll toss 'em into the association block when
2139 * we need them there.
2141 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2143 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2144 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2145 Z_InitResponse *resp = apdu->u.initResponse;
2146 bend_initresult *binitres;
2149 statserv_options_block *cb = 0; /* by default no control for backend */
2151 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2152 cb = statserv_getcontrol(); /* got control block for backend */
2154 if (cb && assoc->backend)
2155 (*cb->bend_close)(assoc->backend);
2157 yaz_log(log_requestdetail, "Got initRequest");
2158 if (req->implementationId)
2159 yaz_log(log_requestdetail, "Id: %s",
2160 req->implementationId);
2161 if (req->implementationName)
2162 yaz_log(log_requestdetail, "Name: %s",
2163 req->implementationName);
2164 if (req->implementationVersion)
2165 yaz_log(log_requestdetail, "Version: %s",
2166 req->implementationVersion);
2168 assoc_init_reset(assoc);
2170 assoc->init->auth = req->idAuthentication;
2171 assoc->init->referenceId = req->referenceId;
2173 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2175 Z_CharSetandLanguageNegotiation *negotiation =
2176 yaz_get_charneg_record (req->otherInfo);
2178 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2179 assoc->init->charneg_request = negotiation;
2185 if (req->implementationVersion)
2186 yaz_log(log_requestdetail, "Config: %s",
2189 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2191 /* we have a backend control block, so call that init function */
2192 if (!(binitres = (*cb->bend_init)(assoc->init)))
2194 yaz_log(YLOG_WARN, "Bad response from backend.");
2197 assoc->backend = binitres->handle;
2201 /* no backend. return error */
2202 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2203 binitres->errstring = 0;
2204 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2205 iochan_settimeout(assoc->client_chan, 10);
2207 if ((assoc->init->bend_sort))
2208 yaz_log (YLOG_DEBUG, "Sort handler installed");
2209 if ((assoc->init->bend_search))
2210 yaz_log (YLOG_DEBUG, "Search handler installed");
2211 if ((assoc->init->bend_present))
2212 yaz_log (YLOG_DEBUG, "Present handler installed");
2213 if ((assoc->init->bend_esrequest))
2214 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2215 if ((assoc->init->bend_delete))
2216 yaz_log (YLOG_DEBUG, "Delete handler installed");
2217 if ((assoc->init->bend_scan))
2218 yaz_log (YLOG_DEBUG, "Scan handler installed");
2219 if ((assoc->init->bend_segment))
2220 yaz_log (YLOG_DEBUG, "Segment handler installed");
2222 resp->referenceId = req->referenceId;
2224 /* let's tell the client what we can do */
2225 if (ODR_MASK_GET(req->options, Z_Options_search))
2227 ODR_MASK_SET(resp->options, Z_Options_search);
2228 strcat(options, "srch");
2230 if (ODR_MASK_GET(req->options, Z_Options_present))
2232 ODR_MASK_SET(resp->options, Z_Options_present);
2233 strcat(options, " prst");
2235 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2236 assoc->init->bend_delete)
2238 ODR_MASK_SET(resp->options, Z_Options_delSet);
2239 strcat(options, " del");
2241 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2242 assoc->init->bend_esrequest)
2244 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2245 strcat (options, " extendedServices");
2247 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2249 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2250 strcat(options, " namedresults");
2252 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2254 ODR_MASK_SET(resp->options, Z_Options_scan);
2255 strcat(options, " scan");
2257 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2259 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2260 strcat(options, " concurrop");
2262 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2264 ODR_MASK_SET(resp->options, Z_Options_sort);
2265 strcat(options, " sort");
2268 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
2269 && assoc->init->charneg_response)
2271 Z_OtherInformation **p;
2272 Z_OtherInformationUnit *p0;
2274 yaz_oi_APDU(apdu, &p);
2276 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2277 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2279 p0->which = Z_OtherInfo_externallyDefinedInfo;
2280 p0->information.externallyDefinedInfo =
2281 assoc->init->charneg_response;
2283 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2284 strcat(options, " negotiation");
2287 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2288 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2290 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2292 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2293 assoc->version = 1; /* 1 & 2 are equivalent */
2295 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2297 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2300 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2302 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2306 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2308 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2309 assoc->maximumRecordSize = *req->maximumRecordSize;
2311 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2312 assoc->preferredMessageSize = *req->preferredMessageSize;
2314 resp->preferredMessageSize = &assoc->preferredMessageSize;
2315 resp->maximumRecordSize = &assoc->maximumRecordSize;
2317 resp->implementationId = odr_prepend(assoc->encode,
2318 assoc->init->implementation_id,
2319 resp->implementationId);
2321 resp->implementationName = odr_prepend(assoc->encode,
2322 assoc->init->implementation_name,
2323 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2325 version = odr_strdup(assoc->encode, "$Revision: 1.101 $");
2326 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2327 version[strlen(version)-2] = '\0';
2328 resp->implementationVersion = odr_prepend(assoc->encode,
2329 assoc->init->implementation_version,
2330 odr_prepend(assoc->encode, &version[11],
2331 resp->implementationVersion));
2333 if (binitres->errcode)
2335 assoc->state = ASSOC_DEAD;
2336 resp->userInformationField =
2337 init_diagnostics(assoc->encode, binitres->errcode,
2338 binitres->errstring);
2343 if (!req->idAuthentication)
2344 yaz_log(log_request, "Auth none");
2345 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2347 const char *open = req->idAuthentication->u.open;
2348 const char *slash = strchr(open, '/');
2354 yaz_log(log_request, "Auth open %.*s", len, open);
2356 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2358 const char *user = req->idAuthentication->u.idPass->userId;
2359 const char *group = req->idAuthentication->u.idPass->groupId;
2360 yaz_log(log_request, "Auth idPass %s %s",
2361 user ? user : "-", group ? group : "-");
2363 else if (req->idAuthentication->which
2364 == Z_IdAuthentication_anonymous)
2366 yaz_log(log_request, "Auth anonymous");
2370 yaz_log(log_request, "Auth other");
2375 WRBUF wr = wrbuf_alloc();
2376 wrbuf_printf(wr, "Init ");
2377 if (binitres->errcode)
2378 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2380 wrbuf_printf(wr, "OK -");
2381 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2382 (req->implementationId ? req->implementationId :"-"),
2383 (req->implementationName ?
2384 req->implementationName : "-"),
2385 (req->implementationVersion ?
2386 req->implementationVersion : "-")
2388 yaz_log(log_request, "%s", wrbuf_buf(wr));
2395 * Set the specified `errcode' and `errstring' into a UserInfo-1
2396 * external to be returned to the client in accordance with Z35.90
2397 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2398 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2400 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2402 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2403 addinfo ? " -- " : "", addinfo ? addinfo : "");
2404 return zget_init_diagnostics(odr, error, addinfo);
2408 * nonsurrogate diagnostic record.
2410 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2412 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2414 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2415 addinfo ? " -- " : "", addinfo ? addinfo : "");
2417 rec->which = Z_Records_NSD;
2418 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2424 * surrogate diagnostic.
2426 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2428 int error, const char *addinfo)
2430 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2431 addinfo ? " -- " : "", addinfo ? addinfo : "");
2432 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2435 static Z_Records *pack_records(association *a, char *setname, int start,
2436 int *num, Z_RecordComposition *comp,
2437 int *next, int *pres, oid_value format,
2438 Z_ReferenceId *referenceId,
2439 int *oid, int *errcode)
2441 int recno, total_length = 0, toget = *num, dumped_records = 0;
2442 Z_Records *records =
2443 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2444 Z_NamePlusRecordList *reclist =
2445 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2446 Z_NamePlusRecord **list =
2447 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2449 records->which = Z_Records_DBOSD;
2450 records->u.databaseOrSurDiagnostics = reclist;
2451 reclist->num_records = 0;
2452 reclist->records = list;
2453 *pres = Z_PresentStatus_success;
2457 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2458 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2459 a->maximumRecordSize);
2460 for (recno = start; reclist->num_records < toget; recno++)
2463 Z_NamePlusRecord *thisrec;
2464 int this_length = 0;
2466 * we get the number of bytes allocated on the stream before any
2467 * allocation done by the backend - this should give us a reasonable
2468 * idea of the total size of the data so far.
2470 total_length = odr_total(a->encode) - dumped_records;
2476 freq.last_in_set = 0;
2477 freq.setname = setname;
2478 freq.surrogate_flag = 0;
2479 freq.number = recno;
2481 freq.request_format = format;
2482 freq.request_format_raw = oid;
2483 freq.output_format = format;
2484 freq.output_format_raw = 0;
2485 freq.stream = a->encode;
2486 freq.print = a->print;
2487 freq.referenceId = referenceId;
2490 retrieve_fetch(a, &freq);
2492 *next = freq.last_in_set ? 0 : recno + 1;
2494 /* backend should be able to signal whether error is system-wide
2495 or only pertaining to current record */
2498 if (!freq.surrogate_flag)
2501 *pres = Z_PresentStatus_failure;
2502 /* for 'present request out of range',
2503 set addinfo to record position if not set */
2504 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2505 freq.errstring == 0)
2507 sprintf (s, "%d", recno);
2511 *errcode = freq.errcode;
2512 return diagrec(a, freq.errcode, freq.errstring);
2514 reclist->records[reclist->num_records] =
2515 surrogatediagrec(a, freq.basename, freq.errcode,
2517 reclist->num_records++;
2520 if (freq.record == 0) /* no error and no record ? */
2522 *next = 0; /* signal end-of-set and stop */
2526 this_length = freq.len;
2528 this_length = odr_total(a->encode) - total_length - dumped_records;
2529 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2530 this_length, total_length, dumped_records);
2531 if (a->preferredMessageSize > 0 &&
2532 this_length + total_length > a->preferredMessageSize)
2534 /* record is small enough, really */
2535 if (this_length <= a->preferredMessageSize && recno > start)
2537 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2538 *pres = Z_PresentStatus_partial_2;
2541 /* record can only be fetched by itself */
2542 if (this_length < a->maximumRecordSize)
2544 yaz_log(log_requestdetail, " Record > prefmsgsz");
2547 yaz_log(YLOG_DEBUG, " Dropped it");
2548 reclist->records[reclist->num_records] =
2549 surrogatediagrec(a, freq.basename, 16, 0);
2550 reclist->num_records++;
2551 dumped_records += this_length;
2555 else /* too big entirely */
2557 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2558 this_length, a->maximumRecordSize);
2559 reclist->records[reclist->num_records] =
2560 surrogatediagrec(a, freq.basename, 17, 0);
2561 reclist->num_records++;
2562 dumped_records += this_length;
2567 if (!(thisrec = (Z_NamePlusRecord *)
2568 odr_malloc(a->encode, sizeof(*thisrec))))
2571 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2573 thisrec->databaseName = 0;
2574 thisrec->which = Z_NamePlusRecord_databaseRecord;
2576 if (freq.output_format_raw)
2578 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
2579 freq.output_format = ident->value;
2581 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
2582 freq.record, freq.len);
2583 if (!thisrec->u.databaseRecord)
2585 reclist->records[reclist->num_records] = thisrec;
2586 reclist->num_records++;
2588 *num = reclist->num_records;
2592 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2595 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2596 bend_search_rr *bsrr =
2597 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2599 yaz_log(log_requestdetail, "Got SearchRequest.");
2601 bsrr->request = reqb;
2602 bsrr->association = assoc;
2603 bsrr->referenceId = req->referenceId;
2604 save_referenceId (reqb, bsrr->referenceId);
2605 bsrr->srw_sortKeys = 0;
2606 bsrr->srw_setname = 0;
2607 bsrr->srw_setnameIdleTime = 0;
2609 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2610 if (req->databaseNames)
2613 for (i = 0; i < req->num_databaseNames; i++)
2614 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2617 yaz_log_zquery_level(log_requestdetail,req->query);
2619 if (assoc->init->bend_search)
2621 bsrr->setname = req->resultSetName;
2622 bsrr->replace_set = *req->replaceIndicator;
2623 bsrr->num_bases = req->num_databaseNames;
2624 bsrr->basenames = req->databaseNames;
2625 bsrr->query = req->query;
2626 bsrr->stream = assoc->encode;
2627 nmem_transfer(bsrr->stream->mem, reqb->request_mem);
2628 bsrr->decode = assoc->decode;
2629 bsrr->print = assoc->print;
2632 bsrr->errstring = NULL;
2633 bsrr->search_info = NULL;
2635 if (assoc->server && assoc->server->cql_transform
2636 && req->query->which == Z_Query_type_104
2637 && req->query->u.type_104->which == Z_External_CQL)
2639 /* have a CQL query and a CQL to PQF transform .. */
2641 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2642 assoc->server->cql_transform, bsrr->query);
2644 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2647 (assoc->init->bend_search)(assoc->backend, bsrr);
2648 if (!bsrr->request) /* backend not ready with the search response */
2649 return 0; /* should not be used any more */
2653 /* FIXME - make a diagnostic for it */
2654 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2656 return response_searchRequest(assoc, reqb, bsrr, fd);
2659 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2662 * Prepare a searchresponse based on the backend results. We probably want
2663 * to look at making the fetching of records nonblocking as well, but
2664 * so far, we'll keep things simple.
2665 * If bsrt is null, that means we're called in response to a communications
2666 * event, and we'll have to get the response for ourselves.
2668 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2669 bend_search_rr *bsrt, int *fd)
2671 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2672 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2673 Z_SearchResponse *resp = (Z_SearchResponse *)
2674 odr_malloc (assoc->encode, sizeof(*resp));
2675 int *nulint = odr_intdup (assoc->encode, 0);
2676 bool_t *sr = odr_intdup(assoc->encode, 1);
2677 int *next = odr_intdup(assoc->encode, 0);
2678 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2681 apdu->which = Z_APDU_searchResponse;
2682 apdu->u.searchResponse = resp;
2683 resp->referenceId = req->referenceId;
2684 resp->additionalSearchInfo = 0;
2685 resp->otherInfo = 0;
2687 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2689 yaz_log(YLOG_FATAL, "Bad result from backend");
2692 else if (bsrt->errcode)
2694 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2695 resp->resultCount = nulint;
2696 resp->numberOfRecordsReturned = nulint;
2697 resp->nextResultSetPosition = nulint;
2698 resp->searchStatus = nulint;
2699 resp->resultSetStatus = none;
2700 resp->presentStatus = 0;
2704 int *toget = odr_intdup(assoc->encode, 0);
2705 int *presst = odr_intdup(assoc->encode, 0);
2706 Z_RecordComposition comp, *compp = 0;
2708 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2711 resp->resultCount = &bsrt->hits;
2713 comp.which = Z_RecordComp_simple;
2714 /* how many records does the user agent want, then? */
2715 if (bsrt->hits <= *req->smallSetUpperBound)
2717 *toget = bsrt->hits;
2718 if ((comp.u.simple = req->smallSetElementSetNames))
2721 else if (bsrt->hits < *req->largeSetLowerBound)
2723 *toget = *req->mediumSetPresentNumber;
2724 if (*toget > bsrt->hits)
2725 *toget = bsrt->hits;
2726 if ((comp.u.simple = req->mediumSetElementSetNames))
2732 if (*toget && !resp->records)
2737 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2740 form = prefformat->value;
2742 /* Call bend_present if defined */
2743 if (assoc->init->bend_present)
2745 bend_present_rr *bprr = (bend_present_rr *)
2746 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2747 bprr->setname = req->resultSetName;
2749 bprr->number = *toget;
2750 bprr->format = form;
2752 bprr->referenceId = req->referenceId;
2753 bprr->stream = assoc->encode;
2754 bprr->print = assoc->print;
2755 bprr->request = reqb;
2756 bprr->association = assoc;
2758 bprr->errstring = NULL;
2759 (*assoc->init->bend_present)(assoc->backend, bprr);
2765 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2766 *resp->presentStatus = Z_PresentStatus_failure;
2771 resp->records = pack_records(assoc, req->resultSetName, 1,
2772 toget, compp, next, presst, form, req->referenceId,
2773 req->preferredRecordSyntax, NULL);
2776 resp->numberOfRecordsReturned = toget;
2777 returnedrecs = *toget;
2778 resp->nextResultSetPosition = next;
2779 resp->searchStatus = sr;
2780 resp->resultSetStatus = 0;
2781 resp->presentStatus = presst;
2785 if (*resp->resultCount)
2787 resp->numberOfRecordsReturned = nulint;
2788 resp->nextResultSetPosition = next;
2789 resp->searchStatus = sr;
2790 resp->resultSetStatus = 0;
2791 resp->presentStatus = 0;
2794 resp->additionalSearchInfo = bsrt->search_info;
2799 WRBUF wr = wrbuf_alloc();
2801 for (i = 0 ; i < req->num_databaseNames; i++){
2803 wrbuf_printf(wr, "+");
2804 wrbuf_printf(wr, req->databaseNames[i]);
2806 wrbuf_printf(wr, " ");
2809 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2811 wrbuf_printf(wr, "OK %d", bsrt->hits);
2812 wrbuf_printf(wr, " %s 1+%d ",
2813 req->resultSetName, returnedrecs);
2814 yaz_query_to_wrbuf(wr, req->query);
2816 yaz_log(log_request, "Search %s", wrbuf_buf(wr));
2823 * Maybe we got a little over-friendly when we designed bend_fetch to
2824 * get only one record at a time. Some backends can optimise multiple-record
2825 * fetches, and at any rate, there is some overhead involved in
2826 * all that selecting and hopping around. Problem is, of course, that the
2827 * frontend can't know ahead of time how many records it'll need to
2828 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2829 * is downright lousy as a bulk data transfer protocol.
2831 * To start with, we'll do the fetching of records from the backend
2832 * in one operation: To save some trips in and out of the event-handler,
2833 * and to simplify the interface to pack_records. At any rate, asynch
2834 * operation is more fun in operations that have an unpredictable execution
2835 * speed - which is normally more true for search than for present.
2837 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2840 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2844 Z_PresentResponse *resp;
2848 const char *errstring = 0;
2850 yaz_log(log_requestdetail, "Got PresentRequest.");
2852 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2855 form = prefformat->value;
2856 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2858 resp->presentStatus = odr_intdup(assoc->encode, 0);
2859 if (assoc->init->bend_present)
2861 bend_present_rr *bprr = (bend_present_rr *)
2862 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2863 bprr->setname = req->resultSetId;
2864 bprr->start = *req->resultSetStartPoint;
2865 bprr->number = *req->numberOfRecordsRequested;
2866 bprr->format = form;
2867 bprr->comp = req->recordComposition;
2868 bprr->referenceId = req->referenceId;
2869 bprr->stream = assoc->encode;
2870 bprr->print = assoc->print;
2871 bprr->request = reqb;
2872 bprr->association = assoc;
2874 bprr->errstring = NULL;
2875 (*assoc->init->bend_present)(assoc->backend, bprr);
2878 return 0; /* should not happen */
2881 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2882 *resp->presentStatus = Z_PresentStatus_failure;
2883 errcode = bprr->errcode;
2884 errstring = bprr->errstring;
2887 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2888 next = odr_intdup(assoc->encode, 0);
2889 num = odr_intdup(assoc->encode, 0);
2891 apdu->which = Z_APDU_presentResponse;
2892 apdu->u.presentResponse = resp;
2893 resp->referenceId = req->referenceId;
2894 resp->otherInfo = 0;
2898 *num = *req->numberOfRecordsRequested;
2900 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2901 num, req->recordComposition, next,
2902 resp->presentStatus,
2903 form, req->referenceId, req->preferredRecordSyntax,
2908 WRBUF wr = wrbuf_alloc();
2909 wrbuf_printf(wr, "Present ");
2911 if (*resp->presentStatus == Z_PresentStatus_failure)
2912 wrbuf_printf(wr, "ERROR %d ", errcode);
2913 else if (*resp->presentStatus == Z_PresentStatus_success)
2914 wrbuf_printf(wr, "OK - ");
2916 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2918 wrbuf_printf(wr, " %s %d+%d ",
2919 req->resultSetId, *req->resultSetStartPoint,
2920 *req->numberOfRecordsRequested);
2921 yaz_log(log_request, "%s", wrbuf_buf(wr) );
2926 resp->numberOfRecordsReturned = num;
2927 resp->nextResultSetPosition = next;
2933 * Scan was implemented rather in a hurry, and with support for only the basic
2934 * elements of the service in the backend API. Suggestions are welcome.
2936 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2938 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2939 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2940 Z_ScanResponse *res = (Z_ScanResponse *)
2941 odr_malloc (assoc->encode, sizeof(*res));
2942 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2943 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2944 Z_ListEntries *ents = (Z_ListEntries *)
2945 odr_malloc (assoc->encode, sizeof(*ents));
2946 Z_DiagRecs *diagrecs_p = NULL;
2948 bend_scan_rr *bsrr = (bend_scan_rr *)
2949 odr_malloc (assoc->encode, sizeof(*bsrr));
2950 struct scan_entry *save_entries;
2952 yaz_log(log_requestdetail, "Got ScanRequest");
2954 apdu->which = Z_APDU_scanResponse;
2955 apdu->u.scanResponse = res;
2956 res->referenceId = req->referenceId;
2958 /* if step is absent, set it to 0 */
2959 res->stepSize = odr_intdup(assoc->encode, 0);
2961 *res->stepSize = *req->stepSize;
2963 res->scanStatus = scanStatus;
2964 res->numberOfEntriesReturned = numberOfEntriesReturned;
2965 res->positionOfTerm = 0;
2966 res->entries = ents;
2967 ents->num_entries = 0;
2968 ents->entries = NULL;
2969 ents->num_nonsurrogateDiagnostics = 0;
2970 ents->nonsurrogateDiagnostics = NULL;
2971 res->attributeSet = 0;
2974 if (req->databaseNames)
2977 for (i = 0; i < req->num_databaseNames; i++)
2978 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2980 bsrr->scanClause = 0;
2982 bsrr->errstring = 0;
2983 bsrr->num_bases = req->num_databaseNames;
2984 bsrr->basenames = req->databaseNames;
2985 bsrr->num_entries = *req->numberOfTermsRequested;
2986 bsrr->term = req->termListAndStartPoint;
2987 bsrr->referenceId = req->referenceId;
2988 bsrr->stream = assoc->encode;
2989 bsrr->print = assoc->print;
2990 bsrr->step_size = res->stepSize;
2992 /* For YAZ 2.0 and earlier it was the backend handler that
2993 initialized entries (member display_term did not exist)
2994 YAZ 2.0 and later sets 'entries' and initialize all members
2995 including 'display_term'. If YAZ 2.0 or later sees that
2996 entries was modified - we assume that it is an old handler and
2997 that 'display_term' is _not_ set.
2999 if (bsrr->num_entries > 0)
3002 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3004 for (i = 0; i<bsrr->num_entries; i++)
3006 bsrr->entries[i].term = 0;
3007 bsrr->entries[i].occurrences = 0;
3008 bsrr->entries[i].errcode = 0;
3009 bsrr->entries[i].errstring = 0;
3010 bsrr->entries[i].display_term = 0;
3013 save_entries = bsrr->entries; /* save it so we can compare later */
3015 if (req->attributeSet &&
3016 (attset = oid_getentbyoid(req->attributeSet)) &&
3017 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
3018 bsrr->attributeset = attset->value;
3020 bsrr->attributeset = VAL_NONE;
3021 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3022 bsrr->attributeset);
3023 bsrr->term_position = req->preferredPositionInResponse ?
3024 *req->preferredPositionInResponse : 1;
3026 ((int (*)(void *, bend_scan_rr *))
3027 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3030 diagrecs_p = zget_DiagRecs(assoc->encode,
3031 bsrr->errcode, bsrr->errstring);
3035 Z_Entry **tab = (Z_Entry **)
3036 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3038 if (bsrr->status == BEND_SCAN_PARTIAL)
3039 *scanStatus = Z_Scan_partial_5;
3041 *scanStatus = Z_Scan_success;
3042 ents->entries = tab;
3043 ents->num_entries = bsrr->num_entries;
3044 res->numberOfEntriesReturned = &ents->num_entries;
3045 res->positionOfTerm = &bsrr->term_position;
3046 for (i = 0; i < bsrr->num_entries; i++)
3052 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3053 if (bsrr->entries[i].occurrences >= 0)
3055 e->which = Z_Entry_termInfo;
3056 e->u.termInfo = t = (Z_TermInfo *)
3057 odr_malloc(assoc->encode, sizeof(*t));
3058 t->suggestedAttributes = 0;
3060 if (save_entries == bsrr->entries &&
3061 bsrr->entries[i].display_term)
3063 /* the entries was _not_ set by the handler. So it's
3064 safe to test for new member display_term. It is
3067 t->displayTerm = odr_strdup(assoc->encode,
3068 bsrr->entries[i].display_term);
3070 t->alternativeTerm = 0;
3071 t->byAttributes = 0;
3072 t->otherTermInfo = 0;
3073 t->globalOccurrences = &bsrr->entries[i].occurrences;
3074 t->term = (Z_Term *)
3075 odr_malloc(assoc->encode, sizeof(*t->term));
3076 t->term->which = Z_Term_general;
3077 t->term->u.general = o =
3078 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3079 o->buf = (unsigned char *)
3080 odr_malloc(assoc->encode, o->len = o->size =
3081 strlen(bsrr->entries[i].term));
3082 memcpy(o->buf, bsrr->entries[i].term, o->len);
3083 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3084 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3088 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3089 bsrr->entries[i].errcode,
3090 bsrr->entries[i].errstring);
3091 assert (drecs->num_diagRecs == 1);
3092 e->which = Z_Entry_surrogateDiagnostic;
3093 assert (drecs->diagRecs[0]);
3094 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3100 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3101 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3106 WRBUF wr = wrbuf_alloc();
3107 wrbuf_printf(wr, "Scan ");
3108 for (i = 0 ; i < req->num_databaseNames; i++){
3110 wrbuf_printf(wr, "+");
3111 wrbuf_printf(wr, req->databaseNames[i]);
3113 wrbuf_printf(wr, " ");
3116 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3117 wrbuf_printf(wr, " ");
3120 wrbuf_printf(wr, "OK ");
3121 /* else if (*res->scanStatus == Z_Scan_success) */
3122 /* wrbuf_printf(wr, "OK "); */
3124 /* wrbuf_printf(wr, "Partial "); */
3126 if (*res->numberOfEntriesReturned)
3127 wrbuf_printf(wr, "%d - ", *res->numberOfEntriesReturned);
3129 wrbuf_printf(wr, "0 - ");
3131 wrbuf_printf(wr, "%d+%d+%d ",
3132 (req->preferredPositionInResponse ?
3133 *req->preferredPositionInResponse : 1),
3134 *req->numberOfTermsRequested,
3135 (res->stepSize ? *res->stepSize : 1));
3137 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3138 bsrr->attributeset);
3139 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3145 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3149 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3150 Z_SortResponse *res = (Z_SortResponse *)
3151 odr_malloc (assoc->encode, sizeof(*res));
3152 bend_sort_rr *bsrr = (bend_sort_rr *)
3153 odr_malloc (assoc->encode, sizeof(*bsrr));
3155 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3157 yaz_log(log_requestdetail, "Got SortRequest.");
3159 bsrr->num_input_setnames = req->num_inputResultSetNames;
3160 for (i=0;i<req->num_inputResultSetNames;i++)
3161 yaz_log(log_requestdetail, "Input resultset: '%s'",
3162 req->inputResultSetNames[i]);
3163 bsrr->input_setnames = req->inputResultSetNames;
3164 bsrr->referenceId = req->referenceId;
3165 bsrr->output_setname = req->sortedResultSetName;
3166 yaz_log(log_requestdetail, "Output resultset: '%s'",
3167 req->sortedResultSetName);
3168 bsrr->sort_sequence = req->sortSequence;
3169 /*FIXME - dump those sequences too */
3170 bsrr->stream = assoc->encode;
3171 bsrr->print = assoc->print;
3173 bsrr->sort_status = Z_SortResponse_failure;
3175 bsrr->errstring = 0;
3177 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3179 res->referenceId = bsrr->referenceId;
3180 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3181 res->resultSetStatus = 0;
3184 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3185 bsrr->errcode, bsrr->errstring);
3186 res->diagnostics = dr->diagRecs;
3187 res->num_diagnostics = dr->num_diagRecs;
3191 res->num_diagnostics = 0;
3192 res->diagnostics = 0;
3194 res->resultCount = 0;
3197 apdu->which = Z_APDU_sortResponse;
3198 apdu->u.sortResponse = res;
3201 WRBUF wr = wrbuf_alloc();
3202 wrbuf_printf(wr, "Sort ");
3204 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3206 wrbuf_printf(wr, "OK -");
3207 wrbuf_printf(wr, " (");
3208 for (i = 0; i<req->num_inputResultSetNames; i++)
3211 wrbuf_printf(wr, "+");
3212 wrbuf_printf(wr, req->inputResultSetNames[i]);
3214 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3216 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3222 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3226 Z_DeleteResultSetRequest *req =
3227 reqb->apdu_request->u.deleteResultSetRequest;
3228 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3229 odr_malloc (assoc->encode, sizeof(*res));
3230 bend_delete_rr *bdrr = (bend_delete_rr *)
3231 odr_malloc (assoc->encode, sizeof(*bdrr));
3232 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3234 yaz_log(log_requestdetail, "Got DeleteRequest.");
3236 bdrr->num_setnames = req->num_resultSetList;
3237 bdrr->setnames = req->resultSetList;
3238 for (i = 0; i<req->num_resultSetList; i++)
3239 yaz_log(log_requestdetail, "resultset: '%s'",
3240 req->resultSetList[i]);
3241 bdrr->stream = assoc->encode;
3242 bdrr->print = assoc->print;
3243 bdrr->function = *req->deleteFunction;
3244 bdrr->referenceId = req->referenceId;
3246 if (bdrr->num_setnames > 0)
3248 bdrr->statuses = (int*)
3249 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3250 bdrr->num_setnames);
3251 for (i = 0; i < bdrr->num_setnames; i++)
3252 bdrr->statuses[i] = 0;
3254 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3256 res->referenceId = req->referenceId;
3258 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3260 res->deleteListStatuses = 0;
3261 if (bdrr->num_setnames > 0)
3264 res->deleteListStatuses = (Z_ListStatuses *)
3265 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3266 res->deleteListStatuses->num = bdrr->num_setnames;
3267 res->deleteListStatuses->elements =
3269 odr_malloc (assoc->encode,
3270 sizeof(*res->deleteListStatuses->elements) *
3271 bdrr->num_setnames);
3272 for (i = 0; i<bdrr->num_setnames; i++)
3274 res->deleteListStatuses->elements[i] =
3276 odr_malloc (assoc->encode,
3277 sizeof(**res->deleteListStatuses->elements));
3278 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3279 res->deleteListStatuses->elements[i]->id =
3280 odr_strdup (assoc->encode, bdrr->setnames[i]);
3283 res->numberNotDeleted = 0;
3284 res->bulkStatuses = 0;
3285 res->deleteMessage = 0;
3288 apdu->which = Z_APDU_deleteResultSetResponse;
3289 apdu->u.deleteResultSetResponse = res;
3292 WRBUF wr = wrbuf_alloc();
3293 wrbuf_printf(wr, "Delete ");
3294 if (bdrr->delete_status)
3295 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3297 wrbuf_printf(wr, "OK -");
3298 for (i = 0; i<req->num_resultSetList; i++)
3299 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3300 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3306 static void process_close(association *assoc, request *reqb)
3308 Z_Close *req = reqb->apdu_request->u.close;
3309 static char *reasons[] =
3316 "securityViolation",
3323 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3324 reasons[*req->closeReason], req->diagnosticInformation ?
3325 req->diagnosticInformation : "NULL");
3326 if (assoc->version < 3) /* to make do_force respond with close */
3328 do_close_req(assoc, Z_Close_finished,
3329 "Association terminated by client", reqb);
3330 yaz_log(log_request,"Close OK");
3333 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3337 reqb->len_refid = refid->len;
3338 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3339 memcpy (reqb->refid, refid->buf, refid->len);
3343 reqb->len_refid = 0;
3348 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3350 process_z_response (a, req, res);
3353 bend_request bend_request_mk (bend_association a)
3355 request *nreq = request_get (&a->outgoing);
3356 nreq->request_mem = nmem_create ();
3360 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3365 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3366 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3367 id->len = id->size = req->len_refid;
3368 memcpy (id->buf, req->refid, req->len_refid);
3372 void bend_request_destroy (bend_request *req)
3374 nmem_destroy((*req)->request_mem);
3375 request_release(*req);
3379 int bend_backend_respond (bend_association a, bend_request req)
3383 r = process_z_request (a, req, &msg);
3385 yaz_log (YLOG_WARN, "%s", msg);
3389 void bend_request_setdata(bend_request r, void *p)
3394 void *bend_request_getdata(bend_request r)
3396 return r->clientData;
3399 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3401 bend_segment_rr req;
3403 req.segment = reqb->apdu_request->u.segmentRequest;
3404 req.stream = assoc->encode;
3405 req.decode = assoc->decode;
3406 req.print = assoc->print;
3407 req.association = assoc;
3409 (*assoc->init->bend_segment)(assoc->backend, &req);
3414 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3416 bend_esrequest_rr esrequest;
3417 const char *ext_name = "unknown";
3419 Z_ExtendedServicesRequest *req =
3420 reqb->apdu_request->u.extendedServicesRequest;
3421 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3423 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3425 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3426 esrequest.stream = assoc->encode;
3427 esrequest.decode = assoc->decode;
3428 esrequest.print = assoc->print;
3429 esrequest.errcode = 0;
3430 esrequest.errstring = NULL;
3431 esrequest.request = reqb;
3432 esrequest.association = assoc;
3433 esrequest.taskPackage = 0;
3434 esrequest.referenceId = req->referenceId;
3437 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3439 switch(esrequest.esr->taskSpecificParameters->which)
3441 case Z_External_itemOrder:
3442 ext_name = "ItemOrder"; break;
3443 case Z_External_update:
3444 ext_name = "Update"; break;
3445 case Z_External_update0:
3446 ext_name = "Update0"; break;
3447 case Z_External_ESAdmin:
3448 ext_name = "Admin"; break;
3453 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3455 /* If the response is being delayed, return NULL */
3456 if (esrequest.request == NULL)
3459 resp->referenceId = req->referenceId;
3461 if (esrequest.errcode == -1)
3463 /* Backend service indicates request will be processed */
3464 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3465 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3467 else if (esrequest.errcode == 0)
3469 /* Backend service indicates request will be processed */
3470 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3471 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3475 Z_DiagRecs *diagRecs =
3476 zget_DiagRecs(assoc->encode, esrequest.errcode,
3477 esrequest.errstring);
3478 /* Backend indicates error, request will not be processed */
3479 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3480 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3481 resp->num_diagnostics = diagRecs->num_diagRecs;
3482 resp->diagnostics = diagRecs->diagRecs;
3485 WRBUF wr = wrbuf_alloc();
3486 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3487 yaz_log(log_request, "EsRequest %s", wrbuf_buf(wr) );
3492 /* Do something with the members of bend_extendedservice */
3493 if (esrequest.taskPackage)
3494 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
3495 (const char *) esrequest.taskPackage,
3497 yaz_log(YLOG_DEBUG,"Send the result apdu");
3504 * indent-tabs-mode: nil
3506 * vim: shiftwidth=4 tabstop=8 expandtab