2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.97 2006-09-01 12:40:44 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);
522 assoc->maximumRecordSize = 3000000;
523 assoc->preferredMessageSize = 3000000;
527 Z_IdAuthentication *auth = odr_malloc(assoc->decode, sizeof(*auth));
530 len = strlen(sr->username) + 1;
532 len += strlen(sr->password) + 2;
533 auth->which = Z_IdAuthentication_open;
534 auth->u.open = odr_malloc(assoc->decode, len);
535 strcpy(auth->u.open, sr->username);
536 if (sr->password && *sr->password)
538 strcat(auth->u.open, "/");
539 strcat(auth->u.open, sr->password);
541 assoc->init->auth = auth;
545 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
546 assoc->init->charneg_request = ce->u.charNeg3;
549 if (!(binitres = (*cb->bend_init)(assoc->init)))
551 assoc->state = ASSOC_DEAD;
552 yaz_add_srw_diagnostic(assoc->encode, d, num,
553 YAZ_SRW_AUTHENTICATION_ERROR, 0);
556 assoc->backend = binitres->handle;
557 assoc->init->auth = 0;
558 if (binitres->errcode)
560 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
561 assoc->state = ASSOC_DEAD;
562 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
563 binitres->errstring);
571 static const char *get_esn(Z_RecordComposition *comp)
573 if (comp && comp->which == Z_RecordComp_complex)
575 if (comp->u.complex->generic
576 && comp->u.complex->generic->elementSpec
577 && (comp->u.complex->generic->elementSpec->which ==
578 Z_ElementSpec_elementSetName))
579 return comp->u.complex->generic->elementSpec->u.elementSetName;
581 else if (comp && comp->which == Z_RecordComp_simple &&
582 comp->u.simple->which == Z_ElementSetNames_generic)
583 return comp->u.simple->u.generic;
587 static void set_esn(Z_RecordComposition **comp_p, const char *esn, NMEM nmem)
589 Z_RecordComposition *comp = nmem_malloc(nmem, sizeof(*comp));
591 comp->which = Z_RecordComp_simple;
592 comp->u.simple = nmem_malloc(nmem, sizeof(*comp->u.simple));
593 comp->u.simple->which = Z_ElementSetNames_generic;
594 comp->u.simple->u.generic = nmem_strdup(nmem, esn);
598 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
601 yaz_record_conv_t rc = 0;
602 const char *match_schema = 0;
603 int *match_syntax = 0;
608 const char *input_schema = get_esn(rr->comp);
609 Odr_oid *input_syntax_raw = rr->request_format_raw;
611 const char *backend_schema = 0;
612 Odr_oid *backend_syntax = 0;
614 r = yaz_retrieval_request(assoc->server->retrieval,
622 if (r == -1) /* error ? */
624 const char *details = yaz_retrieval_get_error(
625 assoc->server->retrieval);
627 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
629 rr->errstring = odr_strdup(rr->stream, details);
632 else if (r == 1 || r == 3)
634 const char *details = input_schema;
635 rr->errcode = YAZ_BIB1_ELEMENT_SET_NAMES_UNSUPP;
637 rr->errstring = odr_strdup(rr->stream, details);
642 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
643 if (input_syntax_raw)
645 char oidbuf[OID_STR_MAX];
646 oid_to_dotstring(input_syntax_raw, oidbuf);
647 rr->errstring = odr_strdup(rr->stream, oidbuf);
653 set_esn(&rr->comp, backend_schema, rr->stream->mem);
657 oident *oident_syntax = oid_getentbyoid(backend_syntax);
659 rr->request_format_raw = backend_syntax;
662 rr->request_format = oident_syntax->value;
664 rr->request_format = VAL_NONE;
667 (*assoc->init->bend_fetch)(assoc->backend, rr);
668 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
669 { /* post conversion must take place .. */
670 WRBUF output_record = wrbuf_alloc();
671 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
674 const char *details = yaz_record_conv_get_error(rc);
675 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
677 rr->errstring = odr_strdup(rr->stream, details);
681 rr->len = wrbuf_len(output_record);
682 rr->record = odr_malloc(rr->stream, rr->len);
683 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
685 wrbuf_free(output_record, 1);
689 struct oident *oi = oid_getentbyoid(match_syntax);
690 rr->output_format = oi ? oi->value : VAL_NONE;
691 rr->output_format_raw = match_syntax;
694 rr->schema = odr_strdup(rr->stream, match_schema);
697 (*assoc->init->bend_fetch)(assoc->backend, rr);
701 static int srw_bend_fetch(association *assoc, int pos,
702 Z_SRW_searchRetrieveRequest *srw_req,
703 Z_SRW_record *record,
704 const char **addinfo)
707 ODR o = assoc->encode;
709 rr.setname = "default";
712 rr.request_format = VAL_TEXT_XML;
713 rr.request_format_raw = yaz_oidval_to_z3950oid(assoc->decode,
716 rr.comp = (Z_RecordComposition *)
717 odr_malloc(assoc->decode, sizeof(*rr.comp));
718 rr.comp->which = Z_RecordComp_complex;
719 rr.comp->u.complex = (Z_CompSpec *)
720 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
721 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
722 odr_malloc(assoc->encode, sizeof(bool_t));
723 *rr.comp->u.complex->selectAlternativeSyntax = 0;
724 rr.comp->u.complex->num_dbSpecific = 0;
725 rr.comp->u.complex->dbSpecific = 0;
726 rr.comp->u.complex->num_recordSyntax = 0;
727 rr.comp->u.complex->recordSyntax = 0;
729 rr.comp->u.complex->generic = (Z_Specification *)
730 odr_malloc(assoc->decode, sizeof(Z_Specification));
732 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
733 rr.comp->u.complex->generic->which = Z_Schema_uri;
734 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
736 /* ESN = recordSchema if recordSchema is present */
737 rr.comp->u.complex->generic->elementSpec = 0;
738 if (srw_req->recordSchema)
740 rr.comp->u.complex->generic->elementSpec =
741 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
742 rr.comp->u.complex->generic->elementSpec->which =
743 Z_ElementSpec_elementSetName;
744 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
745 srw_req->recordSchema;
748 rr.stream = assoc->encode;
749 rr.print = assoc->print;
757 rr.surrogate_flag = 0;
758 rr.schema = srw_req->recordSchema;
760 if (!assoc->init->bend_fetch)
763 retrieve_fetch(assoc, &rr);
765 if (rr.errcode && rr.surrogate_flag)
767 int code = yaz_diag_bib1_to_srw(rr.errcode);
768 const char *message = yaz_diag_srw_str(code);
771 len += strlen(message);
773 len += strlen(rr.errstring);
775 record->recordData_buf = odr_malloc(o, len);
777 sprintf(record->recordData_buf, "<diagnostic "
778 "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
779 " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
781 sprintf(record->recordData_buf + strlen(record->recordData_buf),
782 " <details>%s</details>\n", rr.errstring);
784 sprintf(record->recordData_buf + strlen(record->recordData_buf),
785 " <message>%s</message>\n", message);
786 sprintf(record->recordData_buf + strlen(record->recordData_buf),
788 record->recordData_len = strlen(record->recordData_buf);
789 record->recordPosition = odr_intdup(o, pos);
790 record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
793 else if (rr.len >= 0)
795 record->recordData_buf = rr.record;
796 record->recordData_len = rr.len;
797 record->recordPosition = odr_intdup(o, pos);
799 record->recordSchema = odr_strdup(o, rr.schema);
801 record->recordSchema = 0;
805 *addinfo = rr.errstring;
811 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
812 Z_Query *query_result)
814 /* have a CQL query and CQL to PQF transform .. */
815 CQL_parser cp = cql_parser_create();
821 r = cql_parser_string(cp, cql);
824 /* CQL syntax error */
830 r = cql_transform_buf(ct,
831 cql_parser_result(cp),
832 rpn_buf, sizeof(rpn_buf)-1);
834 srw_errcode = cql_transform_error(ct, &add);
838 /* Syntax & transform OK. */
839 /* Convert PQF string to Z39.50 to RPN query struct */
840 YAZ_PQF_Parser pp = yaz_pqf_create();
841 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
846 int code = yaz_pqf_error(pp, &pqf_msg, &off);
847 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
853 query_result->which = Z_Query_type_1;
854 query_result->u.type_1 = rpnquery;
858 cql_parser_destroy(cp);
862 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
863 Z_AttributesPlusTerm *result)
867 int srw_error = cql2pqf(odr, cql, ct, &query);
870 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
871 return 10; /* bad query type */
872 rpn = query.u.type_1;
873 if (!rpn->RPNStructure)
874 return 10; /* must be structure */
875 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
876 return 10; /* must be simple */
877 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
878 return 10; /* must be attributes plus term node .. */
879 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
884 static void srw_bend_search(association *assoc, request *req,
886 Z_SRW_searchRetrieveResponse *srw_res,
891 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
894 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
895 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
896 if (srw_res->num_diagnostics == 0 && assoc->init)
899 rr.setname = "default";
902 rr.basenames = &srw_req->database;
906 rr.srw_setnameIdleTime = 0;
907 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
908 rr.query->u.type_1 = 0;
910 if (srw_req->query_type == Z_SRW_query_type_cql)
912 if (assoc->server && assoc->server->cql_transform)
914 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
915 assoc->server->cql_transform,
919 yaz_add_srw_diagnostic(assoc->encode,
920 &srw_res->diagnostics,
921 &srw_res->num_diagnostics,
927 /* CQL query to backend. Wrap it - Z39.50 style */
928 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
929 ext->direct_reference = odr_getoidbystr(assoc->decode,
930 "1.2.840.10003.16.2");
931 ext->indirect_reference = 0;
933 ext->which = Z_External_CQL;
934 ext->u.cql = srw_req->query.cql;
936 rr.query->which = Z_Query_type_104;
937 rr.query->u.type_104 = ext;
940 else if (srw_req->query_type == Z_SRW_query_type_pqf)
942 Z_RPNQuery *RPNquery;
943 YAZ_PQF_Parser pqf_parser;
945 pqf_parser = yaz_pqf_create ();
947 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
953 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
954 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
955 code, pqf_msg, (long) off);
956 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
959 rr.query->which = Z_Query_type_1;
960 rr.query->u.type_1 = RPNquery;
962 yaz_pqf_destroy (pqf_parser);
966 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
967 &srw_res->num_diagnostics,
968 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
970 if (rr.query->u.type_1)
972 rr.stream = assoc->encode;
973 rr.decode = assoc->decode;
974 rr.print = assoc->print;
976 if ( srw_req->sort.sortKeys )
977 rr.srw_sortKeys = odr_strdup(assoc->encode,
978 srw_req->sort.sortKeys );
979 rr.association = assoc;
985 yaz_log_zquery_level(log_requestdetail,rr.query);
987 (assoc->init->bend_search)(assoc->backend, &rr);
990 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
996 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
997 yaz_add_srw_diagnostic(assoc->encode,
998 &srw_res->diagnostics,
999 &srw_res->num_diagnostics,
1000 srw_error, rr.errstring);
1005 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
1006 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
1008 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
1009 start, number, rr.hits);
1011 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1014 srw_res->resultSetId =
1015 odr_strdup(assoc->encode, rr.srw_setname );
1016 srw_res->resultSetIdleTime =
1017 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1023 if (start > rr.hits)
1025 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1026 &srw_res->num_diagnostics,
1027 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1032 if (start + number > rr.hits)
1033 number = rr.hits - start + 1;
1035 /* Call bend_present if defined */
1036 if (assoc->init->bend_present)
1038 bend_present_rr *bprr = (bend_present_rr*)
1039 odr_malloc (assoc->decode, sizeof(*bprr));
1040 bprr->setname = "default";
1041 bprr->start = start;
1042 bprr->number = number;
1043 bprr->format = VAL_TEXT_XML;
1044 if (srw_req->recordSchema)
1046 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1047 sizeof(*bprr->comp));
1048 bprr->comp->which = Z_RecordComp_simple;
1049 bprr->comp->u.simple = (Z_ElementSetNames *)
1050 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1051 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1052 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1058 bprr->stream = assoc->encode;
1059 bprr->referenceId = 0;
1060 bprr->print = assoc->print;
1061 bprr->request = req;
1062 bprr->association = assoc;
1064 bprr->errstring = NULL;
1065 (*assoc->init->bend_present)(assoc->backend, bprr);
1071 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1072 yaz_add_srw_diagnostic(assoc->encode,
1073 &srw_res->diagnostics,
1074 &srw_res->num_diagnostics,
1075 srw_error, bprr->errstring);
1083 int packing = Z_SRW_recordPacking_string;
1084 if (srw_req->recordPacking){
1085 if (!strcmp(srw_req->recordPacking, "xml"))
1086 packing = Z_SRW_recordPacking_XML;
1087 if (!strcmp(srw_req->recordPacking, "url"))
1088 packing = Z_SRW_recordPacking_URL;
1090 srw_res->records = (Z_SRW_record *)
1091 odr_malloc(assoc->encode,
1092 number * sizeof(*srw_res->records));
1094 srw_res->extra_records = (Z_SRW_extra_record **)
1095 odr_malloc(assoc->encode,
1096 number*sizeof(*srw_res->extra_records));
1098 for (i = 0; i<number; i++)
1101 const char *addinfo = 0;
1103 srw_res->records[j].recordPacking = packing;
1104 srw_res->records[j].recordData_buf = 0;
1105 srw_res->extra_records[j] = 0;
1106 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1107 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1108 srw_res->records + j,
1112 yaz_add_srw_diagnostic(assoc->encode,
1113 &srw_res->diagnostics,
1114 &srw_res->num_diagnostics,
1115 yaz_diag_bib1_to_srw (errcode),
1120 if (srw_res->records[j].recordData_buf)
1123 srw_res->num_records = j;
1125 srw_res->records = 0;
1134 const char *querystr = "?";
1135 const char *querytype = "?";
1136 WRBUF wr = wrbuf_alloc();
1138 switch (srw_req->query_type)
1140 case Z_SRW_query_type_cql:
1142 querystr = srw_req->query.cql;
1144 case Z_SRW_query_type_pqf:
1146 querystr = srw_req->query.pqf;
1149 wrbuf_printf(wr, "SRWSearch ");
1150 wrbuf_printf(wr, srw_req->database);
1151 wrbuf_printf(wr, " ");
1152 if (srw_res->num_diagnostics)
1153 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1154 else if (*http_code != 200)
1155 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1156 else if (srw_res->numberOfRecords)
1158 wrbuf_printf(wr, "OK %d",
1159 (srw_res->numberOfRecords ?
1160 *srw_res->numberOfRecords : 0));
1162 wrbuf_printf(wr, " %s %d+%d",
1163 (srw_res->resultSetId ?
1164 srw_res->resultSetId : "-"),
1165 (srw_req->startRecord ? *srw_req->startRecord : 1),
1166 srw_res->num_records);
1167 yaz_log(log_request, "%s %s: %s", wrbuf_buf(wr), querytype, querystr);
1172 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1175 xmlNodePtr ptr = rr->server_node_ptr;
1178 for (ptr = ptr->children; ptr; ptr = ptr->next)
1180 if (ptr->type != XML_ELEMENT_NODE)
1182 if (!strcmp((const char *) ptr->name, "explain"))
1185 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1189 ptr = xmlCopyNode(ptr, 1);
1191 xmlDocSetRootElement(doc, ptr);
1193 xmlDocDumpMemory(doc, &buf_out, &len);
1194 content = (char*) odr_malloc(rr->stream, 1+len);
1195 memcpy(content, buf_out, len);
1196 content[len] = '\0';
1200 rr->explain_buf = content;
1208 static void srw_bend_explain(association *assoc, request *req,
1210 Z_SRW_explainResponse *srw_res,
1213 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1214 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1216 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1221 rr.stream = assoc->encode;
1222 rr.decode = assoc->decode;
1223 rr.print = assoc->print;
1225 rr.database = srw_req->database;
1227 rr.server_node_ptr = assoc->server->server_node_ptr;
1229 rr.server_node_ptr = 0;
1230 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1231 if (assoc->init->bend_explain)
1232 (*assoc->init->bend_explain)(assoc->backend, &rr);
1234 srw_bend_explain_default(assoc->backend, &rr);
1238 int packing = Z_SRW_recordPacking_string;
1239 if (srw_req->recordPacking)
1241 if (!strcmp(srw_req->recordPacking, "xml"))
1242 packing = Z_SRW_recordPacking_XML;
1243 else if (!strcmp(srw_req->recordPacking, "url"))
1244 packing = Z_SRW_recordPacking_URL;
1246 srw_res->record.recordSchema = rr.schema;
1247 srw_res->record.recordPacking = packing;
1248 srw_res->record.recordData_buf = rr.explain_buf;
1249 srw_res->record.recordData_len = strlen(rr.explain_buf);
1250 srw_res->record.recordPosition = 0;
1256 static void srw_bend_scan(association *assoc, request *req,
1258 Z_SRW_scanResponse *srw_res,
1261 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1262 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1265 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1266 if (srw_res->num_diagnostics == 0 && assoc->init)
1268 struct scan_entry *save_entries;
1270 bend_scan_rr *bsrr = (bend_scan_rr *)
1271 odr_malloc (assoc->encode, sizeof(*bsrr));
1272 bsrr->num_bases = 1;
1273 bsrr->basenames = &srw_req->database;
1275 bsrr->num_entries = srw_req->maximumTerms ?
1276 *srw_req->maximumTerms : 10;
1277 bsrr->term_position = srw_req->responsePosition ?
1278 *srw_req->responsePosition : 1;
1281 bsrr->errstring = 0;
1282 bsrr->referenceId = 0;
1283 bsrr->stream = assoc->encode;
1284 bsrr->print = assoc->print;
1285 bsrr->step_size = odr_intdup(assoc->decode, 0);
1288 if (bsrr->num_entries > 0)
1291 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1293 for (i = 0; i<bsrr->num_entries; i++)
1295 bsrr->entries[i].term = 0;
1296 bsrr->entries[i].occurrences = 0;
1297 bsrr->entries[i].errcode = 0;
1298 bsrr->entries[i].errstring = 0;
1299 bsrr->entries[i].display_term = 0;
1302 save_entries = bsrr->entries; /* save it so we can compare later */
1304 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1305 assoc->init->bend_scan)
1307 Odr_oid *scan_attributeSet = 0;
1309 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1311 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1313 srw_req->scanClause.pqf);
1314 if (scan_attributeSet &&
1315 (attset = oid_getentbyoid(scan_attributeSet)) &&
1316 (attset->oclass == CLASS_ATTSET ||
1317 attset->oclass == CLASS_GENERAL))
1318 bsrr->attributeset = attset->value;
1320 bsrr->attributeset = VAL_NONE;
1321 yaz_pqf_destroy(pqf_parser);
1322 bsrr->scanClause = 0;
1323 ((int (*)(void *, bend_scan_rr *))
1324 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1326 else if (srw_req->query_type == Z_SRW_query_type_cql
1327 && assoc->init->bend_scan && assoc->server
1328 && assoc->server->cql_transform)
1331 bsrr->scanClause = 0;
1332 bsrr->attributeset = VAL_NONE;
1333 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1334 srw_error = cql2pqf_scan(assoc->encode,
1335 srw_req->scanClause.cql,
1336 assoc->server->cql_transform,
1339 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1340 &srw_res->num_diagnostics,
1344 ((int (*)(void *, bend_scan_rr *))
1345 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1348 else if (srw_req->query_type == Z_SRW_query_type_cql
1349 && assoc->init->bend_srw_scan)
1352 bsrr->attributeset = VAL_NONE;
1353 bsrr->scanClause = srw_req->scanClause.cql;
1354 ((int (*)(void *, bend_scan_rr *))
1355 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1359 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1360 &srw_res->num_diagnostics,
1361 YAZ_SRW_UNSUPP_OPERATION, "scan");
1366 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1371 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1373 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1374 &srw_res->num_diagnostics,
1375 srw_error, bsrr->errstring);
1377 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1380 srw_res->terms = (Z_SRW_scanTerm*)
1381 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1384 srw_res->num_terms = bsrr->num_entries;
1385 for (i = 0; i<bsrr->num_entries; i++)
1387 Z_SRW_scanTerm *t = srw_res->terms + i;
1388 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1389 t->numberOfRecords =
1390 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1392 if (save_entries == bsrr->entries &&
1393 bsrr->entries[i].display_term)
1395 /* the entries was _not_ set by the handler. So it's
1396 safe to test for new member display_term. It is
1399 t->displayTerm = odr_strdup(assoc->encode,
1400 bsrr->entries[i].display_term);
1408 WRBUF wr = wrbuf_alloc();
1409 const char *querytype = 0;
1410 const char *querystr = 0;
1412 switch(srw_req->query_type)
1414 case Z_SRW_query_type_pqf:
1416 querystr = srw_req->scanClause.pqf;
1418 case Z_SRW_query_type_cql:
1420 querystr = srw_req->scanClause.cql;
1423 querytype = "UNKNOWN";
1427 wrbuf_printf(wr, "SRWScan ");
1428 wrbuf_printf(wr, srw_req->database);
1429 wrbuf_printf(wr, " ");
1431 if (srw_res->num_diagnostics)
1432 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1433 else if (srw_res->num_terms)
1434 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1436 wrbuf_printf(wr, "OK - - ");
1438 wrbuf_printf(wr, "%d+%d+0 ",
1439 (srw_req->responsePosition ?
1440 *srw_req->responsePosition : 1),
1441 (srw_req->maximumTerms ?
1442 *srw_req->maximumTerms : 1));
1443 /* there is no step size in SRU/W ??? */
1444 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1445 yaz_log(log_request, "%s ", wrbuf_buf(wr) );
1451 static void srw_bend_update(association *assoc, request *req,
1453 Z_SRW_updateResponse *srw_res,
1456 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1457 yaz_log(YLOG_DEBUG, "Got SRW UpdateRequest");
1458 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1460 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1465 rr.stream = assoc->encode;
1466 rr.print = assoc->print;
1468 rr.basenames = &srw_req->database;
1469 rr.operation = srw_req->operation;
1470 rr.operation_status = "failed";
1472 rr.record_version = 0;
1473 rr.record_checksum = 0;
1474 rr.record_old_version = 0;
1475 rr.record_packing = "xml";
1476 rr.record_schema = 0;
1478 rr.request_extra_record = 0;
1479 rr.response_extra_record = 0;
1480 rr.extra_request_data = 0;
1481 rr.extra_response_data = 0;
1486 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1487 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1488 if ( !strcmp( rr.operation, "delete" ) ){
1489 if ( !srw_req->recordId ){
1490 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1491 &srw_res->num_diagnostics,
1495 rr.record_id = srw_req->recordId;
1497 if ( !srw_req->recordVersion ){
1498 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1499 &srw_res->num_diagnostics,
1500 7, "recordVersion" );
1503 rr.record_version = odr_strdup( assoc->encode,
1504 srw_req->recordVersion );
1507 if ( srw_req->recordOldVersion ){
1508 rr.record_old_version = odr_strdup(assoc->encode,
1509 srw_req->recordOldVersion );
1511 if ( srw_req->extraRequestData ){
1512 rr.extra_request_data = odr_strdup(assoc->encode,
1513 srw_req->extraRequestData );
1516 else if ( !strcmp( rr.operation, "replace" ) ){
1517 if ( !srw_req->recordId ){
1518 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1519 &srw_res->num_diagnostics,
1523 rr.record_id = srw_req->recordId;
1525 if ( srw_req->record.recordSchema == 0 ){
1526 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1527 &srw_res->num_diagnostics,
1528 7, "recordSchema" );
1531 rr.record_schema = odr_strdup(assoc->encode,
1532 srw_req->record.recordSchema );
1534 switch (srw_req->record.recordPacking)
1536 case Z_SRW_recordPacking_string:
1537 rr.record_packing = "string";
1539 case Z_SRW_recordPacking_XML:
1540 rr.record_packing = "xml";
1542 case Z_SRW_recordPacking_URL:
1543 rr.record_packing = "url";
1546 if ( srw_req->record.recordData_len ){
1547 rr.record_data = odr_strdupn(assoc->encode,
1548 srw_req->record.recordData_buf,
1549 srw_req->record.recordData_len );
1550 rr.request_extra_record = srw_req->extra_record;
1553 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1554 &srw_res->num_diagnostics,
1557 if (srw_req->extraRequestData)
1558 rr.extra_request_data = odr_strdup(assoc->encode,
1559 srw_req->extraRequestData );
1561 else if ( !strcmp( rr.operation, "insert" ) )
1563 rr.record_id = srw_req->recordId;
1564 if ( srw_req->record.recordSchema == 0 ){
1565 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1566 &srw_res->num_diagnostics,
1567 7, "recordSchema" );
1570 rr.record_schema = odr_strdup(assoc->encode,
1571 srw_req->record.recordSchema);
1573 switch (srw_req->record.recordPacking)
1575 case Z_SRW_recordPacking_string:
1576 rr.record_packing = "string";
1578 case Z_SRW_recordPacking_XML:
1579 rr.record_packing = "xml";
1581 case Z_SRW_recordPacking_URL:
1582 rr.record_packing = "url";
1586 if (srw_req->record.recordData_len)
1588 rr.record_data = odr_strdupn(assoc->encode,
1589 srw_req->record.recordData_buf,
1590 srw_req->record.recordData_len );
1591 rr.request_extra_record = srw_req->extra_record;
1594 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1595 &srw_res->num_diagnostics,
1597 if ( srw_req->extraRequestData )
1598 rr.extra_request_data = odr_strdup(assoc->encode,
1599 srw_req->extraRequestData );
1601 if (srw_res->num_diagnostics == 0)
1603 if ( assoc->init->bend_srw_update)
1604 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1606 yaz_log( YLOG_WARN, "Got No Update function!");
1612 yaz_add_srw_diagnostic_uri(assoc->encode,
1613 &srw_res->diagnostics,
1614 &srw_res->num_diagnostics,
1618 srw_res->recordId = rr.record_id;
1619 srw_res->operationStatus = rr.operation_status;
1620 srw_res->recordVersion = rr.record_version;
1621 srw_res->recordChecksum = rr.record_checksum;
1622 srw_res->extraResponseData = rr.extra_response_data;
1623 srw_res->record.recordPosition = 0;
1624 if (srw_res->num_diagnostics == 0 && rr.record_data)
1626 srw_res->record.recordSchema = rr.record_schema;
1627 srw_res->record.recordPacking = srw_req->record.recordPacking;
1628 srw_res->record.recordData_buf = rr.record_data;
1629 srw_res->record.recordData_len = strlen(rr.record_data);
1630 srw_res->extra_record = rr.response_extra_record;
1634 srw_res->record.recordData_len = 0;
1639 /* check if path is OK (1); BAD (0) */
1640 static int check_path(const char *path)
1644 if (strstr(path, ".."))
1649 static char *read_file(const char *fname, ODR o, int *sz)
1652 FILE *inf = fopen(fname, "rb");
1656 fseek(inf, 0L, SEEK_END);
1659 buf = odr_malloc(o, *sz);
1660 fread(buf, 1, *sz, inf);
1665 static void process_http_request(association *assoc, request *req)
1667 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1668 ODR o = assoc->encode;
1669 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1671 Z_SOAP *soap_package = 0;
1674 Z_HTTP_Response *hres = 0;
1676 const char *stylesheet = 0; /* for now .. set later */
1677 Z_SRW_diagnostic *diagnostic = 0;
1678 int num_diagnostic = 0;
1679 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1681 if (!control_association(assoc, host, 0))
1683 p = z_get_HTTP_Response(o, 404);
1686 if (r == 2 && assoc->server && assoc->server->docpath
1687 && hreq->path[0] == '/'
1689 /* check if path is a proper prefix of documentroot */
1690 strncmp(hreq->path+1, assoc->server->docpath,
1691 strlen(assoc->server->docpath))
1694 if (!check_path(hreq->path))
1696 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1697 p = z_get_HTTP_Response(o, 404);
1701 int content_size = 0;
1702 char *content_buf = read_file(hreq->path+1, o, &content_size);
1705 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1706 p = z_get_HTTP_Response(o, 404);
1710 const char *ctype = 0;
1711 yaz_mime_types types = yaz_mime_types_create();
1713 yaz_mime_types_add(types, "xsl", "application/xml");
1714 yaz_mime_types_add(types, "xml", "application/xml");
1715 yaz_mime_types_add(types, "css", "text/css");
1716 yaz_mime_types_add(types, "html", "text/html");
1717 yaz_mime_types_add(types, "htm", "text/html");
1718 yaz_mime_types_add(types, "txt", "text/plain");
1719 yaz_mime_types_add(types, "js", "application/x-javascript");
1721 yaz_mime_types_add(types, "gif", "image/gif");
1722 yaz_mime_types_add(types, "png", "image/png");
1723 yaz_mime_types_add(types, "jpg", "image/jpeg");
1724 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1726 ctype = yaz_mime_lookup_fname(types, hreq->path);
1729 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1730 p = z_get_HTTP_Response(o, 404);
1734 p = z_get_HTTP_Response(o, 200);
1735 hres = p->u.HTTP_Response;
1736 hres->content_buf = content_buf;
1737 hres->content_len = content_size;
1738 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1740 yaz_mime_types_destroy(types);
1748 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1749 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1751 if (r == 2) /* not taken */
1753 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1754 &diagnostic, &num_diagnostic);
1755 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1757 if (r == 0) /* decode SRW/SRU OK .. */
1759 int http_code = 200;
1760 if (sr->which == Z_SRW_searchRetrieve_request)
1763 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1765 stylesheet = sr->u.request->stylesheet;
1768 res->u.response->diagnostics = diagnostic;
1769 res->u.response->num_diagnostics = num_diagnostic;
1773 srw_bend_search(assoc, req, sr, res->u.response,
1776 if (http_code == 200)
1777 soap_package->u.generic->p = res;
1779 else if (sr->which == Z_SRW_explain_request)
1781 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1782 stylesheet = sr->u.explain_request->stylesheet;
1785 res->u.explain_response->diagnostics = diagnostic;
1786 res->u.explain_response->num_diagnostics = num_diagnostic;
1788 srw_bend_explain(assoc, req, sr,
1789 res->u.explain_response, &http_code);
1790 if (http_code == 200)
1791 soap_package->u.generic->p = res;
1793 else if (sr->which == Z_SRW_scan_request)
1795 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1796 stylesheet = sr->u.scan_request->stylesheet;
1799 res->u.scan_response->diagnostics = diagnostic;
1800 res->u.scan_response->num_diagnostics = num_diagnostic;
1802 srw_bend_scan(assoc, req, sr,
1803 res->u.scan_response, &http_code);
1804 if (http_code == 200)
1805 soap_package->u.generic->p = res;
1807 else if (sr->which == Z_SRW_update_request)
1809 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1810 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1813 res->u.update_response->diagnostics = diagnostic;
1814 res->u.update_response->num_diagnostics = num_diagnostic;
1816 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1817 srw_bend_update(assoc, req, sr,
1818 res->u.update_response, &http_code);
1819 if (http_code == 200)
1820 soap_package->u.generic->p = res;
1824 yaz_log(log_request, "SOAP ERROR");
1825 /* FIXME - what error, what query */
1827 z_soap_error(assoc->encode, soap_package,
1828 "SOAP-ENV:Client", "Bad method", 0);
1830 if (http_code == 200 || http_code == 500)
1832 static Z_SOAP_Handler soap_handlers[4] = {
1834 {"http://www.loc.gov/zing/srw/", 0,
1835 (Z_SOAP_fun) yaz_srw_codec},
1836 {"http://www.loc.gov/zing/srw/v1.0/", 0,
1837 (Z_SOAP_fun) yaz_srw_codec},
1838 {"http://www.loc.gov/zing/srw/update/", 0,
1839 (Z_SOAP_fun) yaz_ucp_codec},
1845 p = z_get_HTTP_Response(o, 200);
1846 hres = p->u.HTTP_Response;
1848 if (!stylesheet && assoc->server)
1849 stylesheet = assoc->server->stylesheet;
1851 /* empty stylesheet means NO stylesheet */
1852 if (stylesheet && *stylesheet == '\0')
1855 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1856 &hres->content_buf, &hres->content_len,
1857 soap_handlers, charset, stylesheet);
1858 hres->code = http_code;
1860 strcpy(ctype, "text/xml");
1863 strcat(ctype, "; charset=");
1864 strcat(ctype, charset);
1866 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1869 p = z_get_HTTP_Response(o, http_code);
1873 p = z_get_HTTP_Response(o, 500);
1874 hres = p->u.HTTP_Response;
1875 if (!strcmp(hreq->version, "1.0"))
1877 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1878 if (v && !strcmp(v, "Keep-Alive"))
1882 hres->version = "1.0";
1886 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1887 if (v && !strcmp(v, "close"))
1891 hres->version = "1.1";
1895 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1896 assoc->state = ASSOC_DEAD;
1897 assoc->cs_get_mask = 0;
1902 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1904 if (alive && isdigit(*(const unsigned char *) alive))
1908 if (t < 0 || t > 3600)
1910 iochan_settimeout(assoc->client_chan,t);
1911 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1913 process_gdu_response(assoc, req, p);
1916 static void process_gdu_request(association *assoc, request *req)
1918 if (req->gdu_request->which == Z_GDU_Z3950)
1921 req->apdu_request = req->gdu_request->u.z3950;
1922 if (process_z_request(assoc, req, &msg) < 0)
1923 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1925 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1926 process_http_request(assoc, req);
1929 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1934 * Initiate request processing.
1936 static int process_z_request(association *assoc, request *req, char **msg)
1942 *msg = "Unknown Error";
1943 assert(req && req->state == REQUEST_IDLE);
1944 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1946 *msg = "Missing InitRequest";
1949 switch (req->apdu_request->which)
1951 case Z_APDU_initRequest:
1952 res = process_initRequest(assoc, req); break;
1953 case Z_APDU_searchRequest:
1954 res = process_searchRequest(assoc, req, &fd); break;
1955 case Z_APDU_presentRequest:
1956 res = process_presentRequest(assoc, req, &fd); break;
1957 case Z_APDU_scanRequest:
1958 if (assoc->init->bend_scan)
1959 res = process_scanRequest(assoc, req, &fd);
1962 *msg = "Cannot handle Scan APDU";
1966 case Z_APDU_extendedServicesRequest:
1967 if (assoc->init->bend_esrequest)
1968 res = process_ESRequest(assoc, req, &fd);
1971 *msg = "Cannot handle Extended Services APDU";
1975 case Z_APDU_sortRequest:
1976 if (assoc->init->bend_sort)
1977 res = process_sortRequest(assoc, req, &fd);
1980 *msg = "Cannot handle Sort APDU";
1985 process_close(assoc, req);
1987 case Z_APDU_deleteResultSetRequest:
1988 if (assoc->init->bend_delete)
1989 res = process_deleteRequest(assoc, req, &fd);
1992 *msg = "Cannot handle Delete APDU";
1996 case Z_APDU_segmentRequest:
1997 if (assoc->init->bend_segment)
1999 res = process_segmentRequest (assoc, req);
2003 *msg = "Cannot handle Segment APDU";
2007 case Z_APDU_triggerResourceControlRequest:
2010 *msg = "Bad APDU received";
2015 yaz_log(YLOG_DEBUG, " result immediately available");
2016 retval = process_z_response(assoc, req, res);
2020 yaz_log(YLOG_DEBUG, " result unavailble");
2023 else /* no result yet - one will be provided later */
2027 /* Set up an I/O handler for the fd supplied by the backend */
2029 yaz_log(YLOG_DEBUG, " establishing handler for result");
2030 req->state = REQUEST_PENDING;
2031 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2033 iochan_setdata(chan, assoc);
2040 * Handle message from the backend.
2042 void backend_response(IOCHAN i, int event)
2044 association *assoc = (association *)iochan_getdata(i);
2045 request *req = request_head(&assoc->incoming);
2049 yaz_log(YLOG_DEBUG, "backend_response");
2050 assert(assoc && req && req->state != REQUEST_IDLE);
2051 /* determine what it is we're waiting for */
2052 switch (req->apdu_request->which)
2054 case Z_APDU_searchRequest:
2055 res = response_searchRequest(assoc, req, 0, &fd); break;
2057 case Z_APDU_presentRequest:
2058 res = response_presentRequest(assoc, req, 0, &fd); break;
2059 case Z_APDU_scanRequest:
2060 res = response_scanRequest(assoc, req, 0, &fd); break;
2063 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2066 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2068 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2069 do_close(assoc, Z_Close_systemProblem, 0);
2073 else if (!res) /* no result yet - try again later */
2075 yaz_log(YLOG_DEBUG, " no result yet");
2076 iochan_setfd(i, fd); /* in case fd has changed */
2081 * Encode response, and transfer the request structure to the outgoing queue.
2083 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2085 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2089 if (!z_GDU(assoc->print, &res, 0, 0))
2090 yaz_log(YLOG_WARN, "ODR print error: %s",
2091 odr_errmsg(odr_geterror(assoc->print)));
2092 odr_reset(assoc->print);
2094 if (!z_GDU(assoc->encode, &res, 0, 0))
2096 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2097 odr_errmsg(odr_geterror(assoc->decode)),
2098 odr_getelement(assoc->decode));
2101 req->response = odr_getbuf(assoc->encode, &req->len_response,
2102 &req->size_response);
2103 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2104 odr_reset(assoc->encode);
2105 req->state = REQUEST_IDLE;
2106 request_enq(&assoc->outgoing, req);
2107 /* turn the work over to the ir_session handler */
2108 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2109 assoc->cs_put_mask = EVENT_OUTPUT;
2110 /* Is there more work to be done? give that to the input handler too */
2112 if (request_head(&assoc->incoming))
2114 yaz_log (YLOG_DEBUG, "more work to be done");
2115 iochan_setevent(assoc->client_chan, EVENT_WORK);
2122 * Encode response, and transfer the request structure to the outgoing queue.
2124 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2126 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2127 gres->which = Z_GDU_Z3950;
2128 gres->u.z3950 = res;
2130 return process_gdu_response(assoc, req, gres);
2133 static char *get_vhost(Z_OtherInformation *otherInfo)
2135 return yaz_oi_get_string_oidval(&otherInfo, VAL_PROXY, 1, 0);
2139 * Handle init request.
2140 * At the moment, we don't check the options
2141 * anywhere else in the code - we just try not to do anything that would
2142 * break a naive client. We'll toss 'em into the association block when
2143 * we need them there.
2145 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2147 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2148 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2149 Z_InitResponse *resp = apdu->u.initResponse;
2150 bend_initresult *binitres;
2153 statserv_options_block *cb = 0; /* by default no control for backend */
2155 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2156 cb = statserv_getcontrol(); /* got control block for backend */
2158 if (cb && assoc->backend)
2159 (*cb->bend_close)(assoc->backend);
2161 yaz_log(log_requestdetail, "Got initRequest");
2162 if (req->implementationId)
2163 yaz_log(log_requestdetail, "Id: %s",
2164 req->implementationId);
2165 if (req->implementationName)
2166 yaz_log(log_requestdetail, "Name: %s",
2167 req->implementationName);
2168 if (req->implementationVersion)
2169 yaz_log(log_requestdetail, "Version: %s",
2170 req->implementationVersion);
2172 assoc_init_reset(assoc);
2174 assoc->init->auth = req->idAuthentication;
2175 assoc->init->referenceId = req->referenceId;
2177 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2179 Z_CharSetandLanguageNegotiation *negotiation =
2180 yaz_get_charneg_record (req->otherInfo);
2182 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2183 assoc->init->charneg_request = negotiation;
2189 if (req->implementationVersion)
2190 yaz_log(log_requestdetail, "Config: %s",
2193 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2195 /* we have a backend control block, so call that init function */
2196 if (!(binitres = (*cb->bend_init)(assoc->init)))
2198 yaz_log(YLOG_WARN, "Bad response from backend.");
2201 assoc->backend = binitres->handle;
2205 /* no backend. return error */
2206 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2207 binitres->errstring = 0;
2208 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2209 iochan_settimeout(assoc->client_chan, 10);
2211 if ((assoc->init->bend_sort))
2212 yaz_log (YLOG_DEBUG, "Sort handler installed");
2213 if ((assoc->init->bend_search))
2214 yaz_log (YLOG_DEBUG, "Search handler installed");
2215 if ((assoc->init->bend_present))
2216 yaz_log (YLOG_DEBUG, "Present handler installed");
2217 if ((assoc->init->bend_esrequest))
2218 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2219 if ((assoc->init->bend_delete))
2220 yaz_log (YLOG_DEBUG, "Delete handler installed");
2221 if ((assoc->init->bend_scan))
2222 yaz_log (YLOG_DEBUG, "Scan handler installed");
2223 if ((assoc->init->bend_segment))
2224 yaz_log (YLOG_DEBUG, "Segment handler installed");
2226 resp->referenceId = req->referenceId;
2228 /* let's tell the client what we can do */
2229 if (ODR_MASK_GET(req->options, Z_Options_search))
2231 ODR_MASK_SET(resp->options, Z_Options_search);
2232 strcat(options, "srch");
2234 if (ODR_MASK_GET(req->options, Z_Options_present))
2236 ODR_MASK_SET(resp->options, Z_Options_present);
2237 strcat(options, " prst");
2239 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2240 assoc->init->bend_delete)
2242 ODR_MASK_SET(resp->options, Z_Options_delSet);
2243 strcat(options, " del");
2245 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2246 assoc->init->bend_esrequest)
2248 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2249 strcat (options, " extendedServices");
2251 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2253 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2254 strcat(options, " namedresults");
2256 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2258 ODR_MASK_SET(resp->options, Z_Options_scan);
2259 strcat(options, " scan");
2261 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2263 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2264 strcat(options, " concurrop");
2266 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2268 ODR_MASK_SET(resp->options, Z_Options_sort);
2269 strcat(options, " sort");
2272 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
2273 && assoc->init->charneg_response)
2275 Z_OtherInformation **p;
2276 Z_OtherInformationUnit *p0;
2278 yaz_oi_APDU(apdu, &p);
2280 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2281 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2283 p0->which = Z_OtherInfo_externallyDefinedInfo;
2284 p0->information.externallyDefinedInfo =
2285 assoc->init->charneg_response;
2287 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2288 strcat(options, " negotiation");
2291 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2292 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2294 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2296 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2297 assoc->version = 1; /* 1 & 2 are equivalent */
2299 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2301 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2304 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2306 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2310 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2311 assoc->maximumRecordSize = *req->maximumRecordSize;
2313 if (cb && assoc->maximumRecordSize > cb->maxrecordsize)
2314 assoc->maximumRecordSize = cb->maxrecordsize;
2315 assoc->preferredMessageSize = *req->preferredMessageSize;
2316 if (assoc->preferredMessageSize > assoc->maximumRecordSize)
2317 assoc->preferredMessageSize = assoc->maximumRecordSize;
2319 resp->preferredMessageSize = &assoc->preferredMessageSize;
2320 resp->maximumRecordSize = &assoc->maximumRecordSize;
2322 resp->implementationId = odr_prepend(assoc->encode,
2323 assoc->init->implementation_id,
2324 resp->implementationId);
2326 resp->implementationName = odr_prepend(assoc->encode,
2327 assoc->init->implementation_name,
2328 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2330 version = odr_strdup(assoc->encode, "$Revision: 1.97 $");
2331 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2332 version[strlen(version)-2] = '\0';
2333 resp->implementationVersion = odr_prepend(assoc->encode,
2334 assoc->init->implementation_version,
2335 odr_prepend(assoc->encode, &version[11],
2336 resp->implementationVersion));
2338 if (binitres->errcode)
2340 assoc->state = ASSOC_DEAD;
2341 resp->userInformationField =
2342 init_diagnostics(assoc->encode, binitres->errcode,
2343 binitres->errstring);
2348 if (!req->idAuthentication)
2349 yaz_log(log_request, "Auth none");
2350 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2352 const char *open = req->idAuthentication->u.open;
2353 const char *slash = strchr(open, '/');
2359 yaz_log(log_request, "Auth open %.*s", len, open);
2361 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2363 const char *user = req->idAuthentication->u.idPass->userId;
2364 const char *group = req->idAuthentication->u.idPass->groupId;
2365 yaz_log(log_request, "Auth idPass %s %s",
2366 user ? user : "-", group ? group : "-");
2368 else if (req->idAuthentication->which
2369 == Z_IdAuthentication_anonymous)
2371 yaz_log(log_request, "Auth anonymous");
2375 yaz_log(log_request, "Auth other");
2380 WRBUF wr = wrbuf_alloc();
2381 wrbuf_printf(wr, "Init ");
2382 if (binitres->errcode)
2383 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2385 wrbuf_printf(wr, "OK -");
2386 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2387 (req->implementationId ? req->implementationId :"-"),
2388 (req->implementationName ?
2389 req->implementationName : "-"),
2390 (req->implementationVersion ?
2391 req->implementationVersion : "-")
2393 yaz_log(log_request, "%s", wrbuf_buf(wr));
2400 * Set the specified `errcode' and `errstring' into a UserInfo-1
2401 * external to be returned to the client in accordance with Z35.90
2402 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2403 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2405 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2407 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2408 addinfo ? " -- " : "", addinfo ? addinfo : "");
2409 return zget_init_diagnostics(odr, error, addinfo);
2413 * nonsurrogate diagnostic record.
2415 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2417 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2419 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2420 addinfo ? " -- " : "", addinfo ? addinfo : "");
2422 rec->which = Z_Records_NSD;
2423 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2429 * surrogate diagnostic.
2431 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2433 int error, const char *addinfo)
2435 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2436 addinfo ? " -- " : "", addinfo ? addinfo : "");
2437 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2440 static Z_Records *pack_records(association *a, char *setname, int start,
2441 int *num, Z_RecordComposition *comp,
2442 int *next, int *pres, oid_value format,
2443 Z_ReferenceId *referenceId,
2444 int *oid, int *errcode)
2446 int recno, total_length = 0, toget = *num, dumped_records = 0;
2447 Z_Records *records =
2448 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2449 Z_NamePlusRecordList *reclist =
2450 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2451 Z_NamePlusRecord **list =
2452 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2454 records->which = Z_Records_DBOSD;
2455 records->u.databaseOrSurDiagnostics = reclist;
2456 reclist->num_records = 0;
2457 reclist->records = list;
2458 *pres = Z_PresentStatus_success;
2462 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2463 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2464 a->maximumRecordSize);
2465 for (recno = start; reclist->num_records < toget; recno++)
2468 Z_NamePlusRecord *thisrec;
2469 int this_length = 0;
2471 * we get the number of bytes allocated on the stream before any
2472 * allocation done by the backend - this should give us a reasonable
2473 * idea of the total size of the data so far.
2475 total_length = odr_total(a->encode) - dumped_records;
2481 freq.last_in_set = 0;
2482 freq.setname = setname;
2483 freq.surrogate_flag = 0;
2484 freq.number = recno;
2486 freq.request_format = format;
2487 freq.request_format_raw = oid;
2488 freq.output_format = format;
2489 freq.output_format_raw = 0;
2490 freq.stream = a->encode;
2491 freq.print = a->print;
2492 freq.referenceId = referenceId;
2495 retrieve_fetch(a, &freq);
2497 *next = freq.last_in_set ? 0 : recno + 1;
2499 /* backend should be able to signal whether error is system-wide
2500 or only pertaining to current record */
2503 if (!freq.surrogate_flag)
2506 *pres = Z_PresentStatus_failure;
2507 /* for 'present request out of range',
2508 set addinfo to record position if not set */
2509 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2510 freq.errstring == 0)
2512 sprintf (s, "%d", recno);
2516 *errcode = freq.errcode;
2517 return diagrec(a, freq.errcode, freq.errstring);
2519 reclist->records[reclist->num_records] =
2520 surrogatediagrec(a, freq.basename, freq.errcode,
2522 reclist->num_records++;
2525 if (freq.record == 0) /* no error and no record ? */
2527 *next = 0; /* signal end-of-set and stop */
2531 this_length = freq.len;
2533 this_length = odr_total(a->encode) - total_length - dumped_records;
2534 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2535 this_length, total_length, dumped_records);
2536 if (a->preferredMessageSize > 0 &&
2537 this_length + total_length > a->preferredMessageSize)
2539 /* record is small enough, really */
2540 if (this_length <= a->preferredMessageSize && recno > start)
2542 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2543 *pres = Z_PresentStatus_partial_2;
2546 /* record can only be fetched by itself */
2547 if (this_length < a->maximumRecordSize)
2549 yaz_log(log_requestdetail, " Record > prefmsgsz");
2552 yaz_log(YLOG_DEBUG, " Dropped it");
2553 reclist->records[reclist->num_records] =
2554 surrogatediagrec(a, freq.basename, 16, 0);
2555 reclist->num_records++;
2556 dumped_records += this_length;
2560 else /* too big entirely */
2562 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2563 this_length, a->maximumRecordSize);
2564 reclist->records[reclist->num_records] =
2565 surrogatediagrec(a, freq.basename, 17, 0);
2566 reclist->num_records++;
2567 dumped_records += this_length;
2572 if (!(thisrec = (Z_NamePlusRecord *)
2573 odr_malloc(a->encode, sizeof(*thisrec))))
2576 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2578 thisrec->databaseName = 0;
2579 thisrec->which = Z_NamePlusRecord_databaseRecord;
2581 if (freq.output_format_raw)
2583 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
2584 freq.output_format = ident->value;
2586 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
2587 freq.record, freq.len);
2588 if (!thisrec->u.databaseRecord)
2590 reclist->records[reclist->num_records] = thisrec;
2591 reclist->num_records++;
2593 *num = reclist->num_records;
2597 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2600 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2601 bend_search_rr *bsrr =
2602 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2604 yaz_log(log_requestdetail, "Got SearchRequest.");
2606 bsrr->request = reqb;
2607 bsrr->association = assoc;
2608 bsrr->referenceId = req->referenceId;
2609 save_referenceId (reqb, bsrr->referenceId);
2610 bsrr->srw_sortKeys = 0;
2611 bsrr->srw_setname = 0;
2612 bsrr->srw_setnameIdleTime = 0;
2614 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2615 if (req->databaseNames)
2618 for (i = 0; i < req->num_databaseNames; i++)
2619 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2622 yaz_log_zquery_level(log_requestdetail,req->query);
2624 if (assoc->init->bend_search)
2626 bsrr->setname = req->resultSetName;
2627 bsrr->replace_set = *req->replaceIndicator;
2628 bsrr->num_bases = req->num_databaseNames;
2629 bsrr->basenames = req->databaseNames;
2630 bsrr->query = req->query;
2631 bsrr->stream = assoc->encode;
2632 nmem_transfer(bsrr->stream->mem, reqb->request_mem);
2633 bsrr->decode = assoc->decode;
2634 bsrr->print = assoc->print;
2637 bsrr->errstring = NULL;
2638 bsrr->search_info = NULL;
2640 if (assoc->server && assoc->server->cql_transform
2641 && req->query->which == Z_Query_type_104
2642 && req->query->u.type_104->which == Z_External_CQL)
2644 /* have a CQL query and a CQL to PQF transform .. */
2646 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2647 assoc->server->cql_transform, bsrr->query);
2649 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2652 (assoc->init->bend_search)(assoc->backend, bsrr);
2653 if (!bsrr->request) /* backend not ready with the search response */
2654 return 0; /* should not be used any more */
2658 /* FIXME - make a diagnostic for it */
2659 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2661 return response_searchRequest(assoc, reqb, bsrr, fd);
2664 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2667 * Prepare a searchresponse based on the backend results. We probably want
2668 * to look at making the fetching of records nonblocking as well, but
2669 * so far, we'll keep things simple.
2670 * If bsrt is null, that means we're called in response to a communications
2671 * event, and we'll have to get the response for ourselves.
2673 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2674 bend_search_rr *bsrt, int *fd)
2676 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2677 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2678 Z_SearchResponse *resp = (Z_SearchResponse *)
2679 odr_malloc (assoc->encode, sizeof(*resp));
2680 int *nulint = odr_intdup (assoc->encode, 0);
2681 bool_t *sr = odr_intdup(assoc->encode, 1);
2682 int *next = odr_intdup(assoc->encode, 0);
2683 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2686 apdu->which = Z_APDU_searchResponse;
2687 apdu->u.searchResponse = resp;
2688 resp->referenceId = req->referenceId;
2689 resp->additionalSearchInfo = 0;
2690 resp->otherInfo = 0;
2692 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2694 yaz_log(YLOG_FATAL, "Bad result from backend");
2697 else if (bsrt->errcode)
2699 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2700 resp->resultCount = nulint;
2701 resp->numberOfRecordsReturned = nulint;
2702 resp->nextResultSetPosition = nulint;
2703 resp->searchStatus = nulint;
2704 resp->resultSetStatus = none;
2705 resp->presentStatus = 0;
2709 int *toget = odr_intdup(assoc->encode, 0);
2710 int *presst = odr_intdup(assoc->encode, 0);
2711 Z_RecordComposition comp, *compp = 0;
2713 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2716 resp->resultCount = &bsrt->hits;
2718 comp.which = Z_RecordComp_simple;
2719 /* how many records does the user agent want, then? */
2720 if (bsrt->hits <= *req->smallSetUpperBound)
2722 *toget = bsrt->hits;
2723 if ((comp.u.simple = req->smallSetElementSetNames))
2726 else if (bsrt->hits < *req->largeSetLowerBound)
2728 *toget = *req->mediumSetPresentNumber;
2729 if (*toget > bsrt->hits)
2730 *toget = bsrt->hits;
2731 if ((comp.u.simple = req->mediumSetElementSetNames))
2737 if (*toget && !resp->records)
2742 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2745 form = prefformat->value;
2747 /* Call bend_present if defined */
2748 if (assoc->init->bend_present)
2750 bend_present_rr *bprr = (bend_present_rr *)
2751 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2752 bprr->setname = req->resultSetName;
2754 bprr->number = *toget;
2755 bprr->format = form;
2757 bprr->referenceId = req->referenceId;
2758 bprr->stream = assoc->encode;
2759 bprr->print = assoc->print;
2760 bprr->request = reqb;
2761 bprr->association = assoc;
2763 bprr->errstring = NULL;
2764 (*assoc->init->bend_present)(assoc->backend, bprr);
2770 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2771 *resp->presentStatus = Z_PresentStatus_failure;
2776 resp->records = pack_records(assoc, req->resultSetName, 1,
2777 toget, compp, next, presst, form, req->referenceId,
2778 req->preferredRecordSyntax, NULL);
2781 resp->numberOfRecordsReturned = toget;
2782 returnedrecs = *toget;
2783 resp->nextResultSetPosition = next;
2784 resp->searchStatus = sr;
2785 resp->resultSetStatus = 0;
2786 resp->presentStatus = presst;
2790 if (*resp->resultCount)
2792 resp->numberOfRecordsReturned = nulint;
2793 resp->nextResultSetPosition = next;
2794 resp->searchStatus = sr;
2795 resp->resultSetStatus = 0;
2796 resp->presentStatus = 0;
2799 resp->additionalSearchInfo = bsrt->search_info;
2804 WRBUF wr = wrbuf_alloc();
2806 for (i = 0 ; i < req->num_databaseNames; i++){
2808 wrbuf_printf(wr, "+");
2809 wrbuf_printf(wr, req->databaseNames[i]);
2811 wrbuf_printf(wr, " ");
2814 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2816 wrbuf_printf(wr, "OK %d", bsrt->hits);
2817 wrbuf_printf(wr, " %s 1+%d ",
2818 req->resultSetName, returnedrecs);
2819 yaz_query_to_wrbuf(wr, req->query);
2821 yaz_log(log_request, "Search %s", wrbuf_buf(wr));
2828 * Maybe we got a little over-friendly when we designed bend_fetch to
2829 * get only one record at a time. Some backends can optimise multiple-record
2830 * fetches, and at any rate, there is some overhead involved in
2831 * all that selecting and hopping around. Problem is, of course, that the
2832 * frontend can't know ahead of time how many records it'll need to
2833 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2834 * is downright lousy as a bulk data transfer protocol.
2836 * To start with, we'll do the fetching of records from the backend
2837 * in one operation: To save some trips in and out of the event-handler,
2838 * and to simplify the interface to pack_records. At any rate, asynch
2839 * operation is more fun in operations that have an unpredictable execution
2840 * speed - which is normally more true for search than for present.
2842 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2845 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2849 Z_PresentResponse *resp;
2853 const char *errstring = 0;
2855 yaz_log(log_requestdetail, "Got PresentRequest.");
2857 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2860 form = prefformat->value;
2861 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2863 resp->presentStatus = odr_intdup(assoc->encode, 0);
2864 if (assoc->init->bend_present)
2866 bend_present_rr *bprr = (bend_present_rr *)
2867 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2868 bprr->setname = req->resultSetId;
2869 bprr->start = *req->resultSetStartPoint;
2870 bprr->number = *req->numberOfRecordsRequested;
2871 bprr->format = form;
2872 bprr->comp = req->recordComposition;
2873 bprr->referenceId = req->referenceId;
2874 bprr->stream = assoc->encode;
2875 bprr->print = assoc->print;
2876 bprr->request = reqb;
2877 bprr->association = assoc;
2879 bprr->errstring = NULL;
2880 (*assoc->init->bend_present)(assoc->backend, bprr);
2883 return 0; /* should not happen */
2886 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2887 *resp->presentStatus = Z_PresentStatus_failure;
2888 errcode = bprr->errcode;
2889 errstring = bprr->errstring;
2892 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2893 next = odr_intdup(assoc->encode, 0);
2894 num = odr_intdup(assoc->encode, 0);
2896 apdu->which = Z_APDU_presentResponse;
2897 apdu->u.presentResponse = resp;
2898 resp->referenceId = req->referenceId;
2899 resp->otherInfo = 0;
2903 *num = *req->numberOfRecordsRequested;
2905 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2906 num, req->recordComposition, next,
2907 resp->presentStatus,
2908 form, req->referenceId, req->preferredRecordSyntax,
2913 WRBUF wr = wrbuf_alloc();
2914 wrbuf_printf(wr, "Present ");
2916 if (*resp->presentStatus == Z_PresentStatus_failure)
2917 wrbuf_printf(wr, "ERROR %d ", errcode);
2918 else if (*resp->presentStatus == Z_PresentStatus_success)
2919 wrbuf_printf(wr, "OK - ");
2921 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2923 wrbuf_printf(wr, " %s %d+%d ",
2924 req->resultSetId, *req->resultSetStartPoint,
2925 *req->numberOfRecordsRequested);
2926 yaz_log(log_request, "%s", wrbuf_buf(wr) );
2931 resp->numberOfRecordsReturned = num;
2932 resp->nextResultSetPosition = next;
2938 * Scan was implemented rather in a hurry, and with support for only the basic
2939 * elements of the service in the backend API. Suggestions are welcome.
2941 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2943 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2944 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2945 Z_ScanResponse *res = (Z_ScanResponse *)
2946 odr_malloc (assoc->encode, sizeof(*res));
2947 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2948 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2949 Z_ListEntries *ents = (Z_ListEntries *)
2950 odr_malloc (assoc->encode, sizeof(*ents));
2951 Z_DiagRecs *diagrecs_p = NULL;
2953 bend_scan_rr *bsrr = (bend_scan_rr *)
2954 odr_malloc (assoc->encode, sizeof(*bsrr));
2955 struct scan_entry *save_entries;
2957 yaz_log(log_requestdetail, "Got ScanRequest");
2959 apdu->which = Z_APDU_scanResponse;
2960 apdu->u.scanResponse = res;
2961 res->referenceId = req->referenceId;
2963 /* if step is absent, set it to 0 */
2964 res->stepSize = odr_intdup(assoc->encode, 0);
2966 *res->stepSize = *req->stepSize;
2968 res->scanStatus = scanStatus;
2969 res->numberOfEntriesReturned = numberOfEntriesReturned;
2970 res->positionOfTerm = 0;
2971 res->entries = ents;
2972 ents->num_entries = 0;
2973 ents->entries = NULL;
2974 ents->num_nonsurrogateDiagnostics = 0;
2975 ents->nonsurrogateDiagnostics = NULL;
2976 res->attributeSet = 0;
2979 if (req->databaseNames)
2982 for (i = 0; i < req->num_databaseNames; i++)
2983 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2985 bsrr->scanClause = 0;
2987 bsrr->errstring = 0;
2988 bsrr->num_bases = req->num_databaseNames;
2989 bsrr->basenames = req->databaseNames;
2990 bsrr->num_entries = *req->numberOfTermsRequested;
2991 bsrr->term = req->termListAndStartPoint;
2992 bsrr->referenceId = req->referenceId;
2993 bsrr->stream = assoc->encode;
2994 bsrr->print = assoc->print;
2995 bsrr->step_size = res->stepSize;
2997 /* For YAZ 2.0 and earlier it was the backend handler that
2998 initialized entries (member display_term did not exist)
2999 YAZ 2.0 and later sets 'entries' and initialize all members
3000 including 'display_term'. If YAZ 2.0 or later sees that
3001 entries was modified - we assume that it is an old handler and
3002 that 'display_term' is _not_ set.
3004 if (bsrr->num_entries > 0)
3007 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3009 for (i = 0; i<bsrr->num_entries; i++)
3011 bsrr->entries[i].term = 0;
3012 bsrr->entries[i].occurrences = 0;
3013 bsrr->entries[i].errcode = 0;
3014 bsrr->entries[i].errstring = 0;
3015 bsrr->entries[i].display_term = 0;
3018 save_entries = bsrr->entries; /* save it so we can compare later */
3020 if (req->attributeSet &&
3021 (attset = oid_getentbyoid(req->attributeSet)) &&
3022 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
3023 bsrr->attributeset = attset->value;
3025 bsrr->attributeset = VAL_NONE;
3026 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3027 bsrr->attributeset);
3028 bsrr->term_position = req->preferredPositionInResponse ?
3029 *req->preferredPositionInResponse : 1;
3031 ((int (*)(void *, bend_scan_rr *))
3032 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3035 diagrecs_p = zget_DiagRecs(assoc->encode,
3036 bsrr->errcode, bsrr->errstring);
3040 Z_Entry **tab = (Z_Entry **)
3041 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3043 if (bsrr->status == BEND_SCAN_PARTIAL)
3044 *scanStatus = Z_Scan_partial_5;
3046 *scanStatus = Z_Scan_success;
3047 ents->entries = tab;
3048 ents->num_entries = bsrr->num_entries;
3049 res->numberOfEntriesReturned = &ents->num_entries;
3050 res->positionOfTerm = &bsrr->term_position;
3051 for (i = 0; i < bsrr->num_entries; i++)
3057 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3058 if (bsrr->entries[i].occurrences >= 0)
3060 e->which = Z_Entry_termInfo;
3061 e->u.termInfo = t = (Z_TermInfo *)
3062 odr_malloc(assoc->encode, sizeof(*t));
3063 t->suggestedAttributes = 0;
3065 if (save_entries == bsrr->entries &&
3066 bsrr->entries[i].display_term)
3068 /* the entries was _not_ set by the handler. So it's
3069 safe to test for new member display_term. It is
3072 t->displayTerm = odr_strdup(assoc->encode,
3073 bsrr->entries[i].display_term);
3075 t->alternativeTerm = 0;
3076 t->byAttributes = 0;
3077 t->otherTermInfo = 0;
3078 t->globalOccurrences = &bsrr->entries[i].occurrences;
3079 t->term = (Z_Term *)
3080 odr_malloc(assoc->encode, sizeof(*t->term));
3081 t->term->which = Z_Term_general;
3082 t->term->u.general = o =
3083 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3084 o->buf = (unsigned char *)
3085 odr_malloc(assoc->encode, o->len = o->size =
3086 strlen(bsrr->entries[i].term));
3087 memcpy(o->buf, bsrr->entries[i].term, o->len);
3088 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3089 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3093 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3094 bsrr->entries[i].errcode,
3095 bsrr->entries[i].errstring);
3096 assert (drecs->num_diagRecs == 1);
3097 e->which = Z_Entry_surrogateDiagnostic;
3098 assert (drecs->diagRecs[0]);
3099 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3105 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3106 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3111 WRBUF wr = wrbuf_alloc();
3112 wrbuf_printf(wr, "Scan ");
3113 for (i = 0 ; i < req->num_databaseNames; i++){
3115 wrbuf_printf(wr, "+");
3116 wrbuf_printf(wr, req->databaseNames[i]);
3118 wrbuf_printf(wr, " ");
3121 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3122 wrbuf_printf(wr, " ");
3125 wrbuf_printf(wr, "OK ");
3126 /* else if (*res->scanStatus == Z_Scan_success) */
3127 /* wrbuf_printf(wr, "OK "); */
3129 /* wrbuf_printf(wr, "Partial "); */
3131 if (*res->numberOfEntriesReturned)
3132 wrbuf_printf(wr, "%d - ", *res->numberOfEntriesReturned);
3134 wrbuf_printf(wr, "0 - ");
3136 wrbuf_printf(wr, "%d+%d+%d ",
3137 (req->preferredPositionInResponse ?
3138 *req->preferredPositionInResponse : 1),
3139 *req->numberOfTermsRequested,
3140 (res->stepSize ? *res->stepSize : 1));
3142 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3143 bsrr->attributeset);
3144 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3150 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3154 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3155 Z_SortResponse *res = (Z_SortResponse *)
3156 odr_malloc (assoc->encode, sizeof(*res));
3157 bend_sort_rr *bsrr = (bend_sort_rr *)
3158 odr_malloc (assoc->encode, sizeof(*bsrr));
3160 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3162 yaz_log(log_requestdetail, "Got SortRequest.");
3164 bsrr->num_input_setnames = req->num_inputResultSetNames;
3165 for (i=0;i<req->num_inputResultSetNames;i++)
3166 yaz_log(log_requestdetail, "Input resultset: '%s'",
3167 req->inputResultSetNames[i]);
3168 bsrr->input_setnames = req->inputResultSetNames;
3169 bsrr->referenceId = req->referenceId;
3170 bsrr->output_setname = req->sortedResultSetName;
3171 yaz_log(log_requestdetail, "Output resultset: '%s'",
3172 req->sortedResultSetName);
3173 bsrr->sort_sequence = req->sortSequence;
3174 /*FIXME - dump those sequences too */
3175 bsrr->stream = assoc->encode;
3176 bsrr->print = assoc->print;
3178 bsrr->sort_status = Z_SortResponse_failure;
3180 bsrr->errstring = 0;
3182 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3184 res->referenceId = bsrr->referenceId;
3185 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3186 res->resultSetStatus = 0;
3189 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3190 bsrr->errcode, bsrr->errstring);
3191 res->diagnostics = dr->diagRecs;
3192 res->num_diagnostics = dr->num_diagRecs;
3196 res->num_diagnostics = 0;
3197 res->diagnostics = 0;
3199 res->resultCount = 0;
3202 apdu->which = Z_APDU_sortResponse;
3203 apdu->u.sortResponse = res;
3206 WRBUF wr = wrbuf_alloc();
3207 wrbuf_printf(wr, "Sort ");
3209 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3211 wrbuf_printf(wr, "OK -");
3212 wrbuf_printf(wr, " (");
3213 for (i = 0; i<req->num_inputResultSetNames; i++)
3216 wrbuf_printf(wr, "+");
3217 wrbuf_printf(wr, req->inputResultSetNames[i]);
3219 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3221 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3227 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3231 Z_DeleteResultSetRequest *req =
3232 reqb->apdu_request->u.deleteResultSetRequest;
3233 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3234 odr_malloc (assoc->encode, sizeof(*res));
3235 bend_delete_rr *bdrr = (bend_delete_rr *)
3236 odr_malloc (assoc->encode, sizeof(*bdrr));
3237 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3239 yaz_log(log_requestdetail, "Got DeleteRequest.");
3241 bdrr->num_setnames = req->num_resultSetList;
3242 bdrr->setnames = req->resultSetList;
3243 for (i = 0; i<req->num_resultSetList; i++)
3244 yaz_log(log_requestdetail, "resultset: '%s'",
3245 req->resultSetList[i]);
3246 bdrr->stream = assoc->encode;
3247 bdrr->print = assoc->print;
3248 bdrr->function = *req->deleteFunction;
3249 bdrr->referenceId = req->referenceId;
3251 if (bdrr->num_setnames > 0)
3253 bdrr->statuses = (int*)
3254 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3255 bdrr->num_setnames);
3256 for (i = 0; i < bdrr->num_setnames; i++)
3257 bdrr->statuses[i] = 0;
3259 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3261 res->referenceId = req->referenceId;
3263 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3265 res->deleteListStatuses = 0;
3266 if (bdrr->num_setnames > 0)
3269 res->deleteListStatuses = (Z_ListStatuses *)
3270 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3271 res->deleteListStatuses->num = bdrr->num_setnames;
3272 res->deleteListStatuses->elements =
3274 odr_malloc (assoc->encode,
3275 sizeof(*res->deleteListStatuses->elements) *
3276 bdrr->num_setnames);
3277 for (i = 0; i<bdrr->num_setnames; i++)
3279 res->deleteListStatuses->elements[i] =
3281 odr_malloc (assoc->encode,
3282 sizeof(**res->deleteListStatuses->elements));
3283 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3284 res->deleteListStatuses->elements[i]->id =
3285 odr_strdup (assoc->encode, bdrr->setnames[i]);
3288 res->numberNotDeleted = 0;
3289 res->bulkStatuses = 0;
3290 res->deleteMessage = 0;
3293 apdu->which = Z_APDU_deleteResultSetResponse;
3294 apdu->u.deleteResultSetResponse = res;
3297 WRBUF wr = wrbuf_alloc();
3298 wrbuf_printf(wr, "Delete ");
3299 if (bdrr->delete_status)
3300 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3302 wrbuf_printf(wr, "OK -");
3303 for (i = 0; i<req->num_resultSetList; i++)
3304 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3305 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3311 static void process_close(association *assoc, request *reqb)
3313 Z_Close *req = reqb->apdu_request->u.close;
3314 static char *reasons[] =
3321 "securityViolation",
3328 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3329 reasons[*req->closeReason], req->diagnosticInformation ?
3330 req->diagnosticInformation : "NULL");
3331 if (assoc->version < 3) /* to make do_force respond with close */
3333 do_close_req(assoc, Z_Close_finished,
3334 "Association terminated by client", reqb);
3335 yaz_log(log_request,"Close OK");
3338 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3342 reqb->len_refid = refid->len;
3343 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3344 memcpy (reqb->refid, refid->buf, refid->len);
3348 reqb->len_refid = 0;
3353 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3355 process_z_response (a, req, res);
3358 bend_request bend_request_mk (bend_association a)
3360 request *nreq = request_get (&a->outgoing);
3361 nreq->request_mem = nmem_create ();
3365 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3370 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3371 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3372 id->len = id->size = req->len_refid;
3373 memcpy (id->buf, req->refid, req->len_refid);
3377 void bend_request_destroy (bend_request *req)
3379 nmem_destroy((*req)->request_mem);
3380 request_release(*req);
3384 int bend_backend_respond (bend_association a, bend_request req)
3388 r = process_z_request (a, req, &msg);
3390 yaz_log (YLOG_WARN, "%s", msg);
3394 void bend_request_setdata(bend_request r, void *p)
3399 void *bend_request_getdata(bend_request r)
3401 return r->clientData;
3404 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3406 bend_segment_rr req;
3408 req.segment = reqb->apdu_request->u.segmentRequest;
3409 req.stream = assoc->encode;
3410 req.decode = assoc->decode;
3411 req.print = assoc->print;
3412 req.association = assoc;
3414 (*assoc->init->bend_segment)(assoc->backend, &req);
3419 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3421 bend_esrequest_rr esrequest;
3422 const char *ext_name = "unknown";
3424 Z_ExtendedServicesRequest *req =
3425 reqb->apdu_request->u.extendedServicesRequest;
3426 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3428 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3430 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3431 esrequest.stream = assoc->encode;
3432 esrequest.decode = assoc->decode;
3433 esrequest.print = assoc->print;
3434 esrequest.errcode = 0;
3435 esrequest.errstring = NULL;
3436 esrequest.request = reqb;
3437 esrequest.association = assoc;
3438 esrequest.taskPackage = 0;
3439 esrequest.referenceId = req->referenceId;
3442 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3444 switch(esrequest.esr->taskSpecificParameters->which)
3446 case Z_External_itemOrder:
3447 ext_name = "ItemOrder"; break;
3448 case Z_External_update:
3449 ext_name = "Update"; break;
3450 case Z_External_update0:
3451 ext_name = "Update0"; break;
3452 case Z_External_ESAdmin:
3453 ext_name = "Admin"; break;
3458 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3460 /* If the response is being delayed, return NULL */
3461 if (esrequest.request == NULL)
3464 resp->referenceId = req->referenceId;
3466 if (esrequest.errcode == -1)
3468 /* Backend service indicates request will be processed */
3469 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3470 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3472 else if (esrequest.errcode == 0)
3474 /* Backend service indicates request will be processed */
3475 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3476 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3480 Z_DiagRecs *diagRecs =
3481 zget_DiagRecs(assoc->encode, esrequest.errcode,
3482 esrequest.errstring);
3483 /* Backend indicates error, request will not be processed */
3484 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3485 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3486 resp->num_diagnostics = diagRecs->num_diagRecs;
3487 resp->diagnostics = diagRecs->diagRecs;
3490 WRBUF wr = wrbuf_alloc();
3491 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3492 yaz_log(log_request, "EsRequest %s", wrbuf_buf(wr) );
3497 /* Do something with the members of bend_extendedservice */
3498 if (esrequest.taskPackage)
3499 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
3500 (const char *) esrequest.taskPackage,
3502 yaz_log(YLOG_DEBUG,"Send the result apdu");
3509 * indent-tabs-mode: nil
3511 * vim: shiftwidth=4 tabstop=8 expandtab