2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.103 2006-10-27 11:22:09 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 if (assoc->server && assoc->server->cql_transform)
911 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
912 assoc->server->cql_transform,
916 yaz_add_srw_diagnostic(assoc->encode,
917 &srw_res->diagnostics,
918 &srw_res->num_diagnostics,
924 /* CQL query to backend. Wrap it - Z39.50 style */
925 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
926 ext->direct_reference = odr_getoidbystr(assoc->decode,
927 "1.2.840.10003.16.2");
928 ext->indirect_reference = 0;
930 ext->which = Z_External_CQL;
931 ext->u.cql = srw_req->query.cql;
933 rr.query->which = Z_Query_type_104;
934 rr.query->u.type_104 = ext;
937 else if (srw_req->query_type == Z_SRW_query_type_pqf)
939 Z_RPNQuery *RPNquery;
940 YAZ_PQF_Parser pqf_parser;
942 pqf_parser = yaz_pqf_create ();
944 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
950 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
951 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
952 code, pqf_msg, (long) off);
953 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
956 rr.query->which = Z_Query_type_1;
957 rr.query->u.type_1 = RPNquery;
959 yaz_pqf_destroy (pqf_parser);
963 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
964 &srw_res->num_diagnostics,
965 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
967 if (rr.query->u.type_1)
969 rr.stream = assoc->encode;
970 rr.decode = assoc->decode;
971 rr.print = assoc->print;
973 if ( srw_req->sort.sortKeys )
974 rr.srw_sortKeys = odr_strdup(assoc->encode,
975 srw_req->sort.sortKeys );
976 rr.association = assoc;
982 yaz_log_zquery_level(log_requestdetail,rr.query);
984 (assoc->init->bend_search)(assoc->backend, &rr);
987 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
993 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
994 yaz_add_srw_diagnostic(assoc->encode,
995 &srw_res->diagnostics,
996 &srw_res->num_diagnostics,
997 srw_error, rr.errstring);
1002 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
1003 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
1005 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
1006 start, number, rr.hits);
1008 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1011 srw_res->resultSetId =
1012 odr_strdup(assoc->encode, rr.srw_setname );
1013 srw_res->resultSetIdleTime =
1014 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1017 if ((rr.hits > 0 && start > rr.hits) || start < 1)
1019 yaz_add_srw_diagnostic(
1021 &srw_res->diagnostics, &srw_res->num_diagnostics,
1022 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1024 else if (number > 0)
1028 if (start + number > rr.hits)
1029 number = rr.hits - start + 1;
1031 /* Call bend_present if defined */
1032 if (assoc->init->bend_present)
1034 bend_present_rr *bprr = (bend_present_rr*)
1035 odr_malloc (assoc->decode, sizeof(*bprr));
1036 bprr->setname = "default";
1037 bprr->start = start;
1038 bprr->number = number;
1039 bprr->format = VAL_TEXT_XML;
1040 if (srw_req->recordSchema)
1042 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1043 sizeof(*bprr->comp));
1044 bprr->comp->which = Z_RecordComp_simple;
1045 bprr->comp->u.simple = (Z_ElementSetNames *)
1046 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1047 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1048 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1054 bprr->stream = assoc->encode;
1055 bprr->referenceId = 0;
1056 bprr->print = assoc->print;
1057 bprr->request = req;
1058 bprr->association = assoc;
1060 bprr->errstring = NULL;
1061 (*assoc->init->bend_present)(assoc->backend, bprr);
1067 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1068 yaz_add_srw_diagnostic(assoc->encode,
1069 &srw_res->diagnostics,
1070 &srw_res->num_diagnostics,
1071 srw_error, bprr->errstring);
1079 int packing = Z_SRW_recordPacking_string;
1080 if (srw_req->recordPacking){
1081 if (!strcmp(srw_req->recordPacking, "xml"))
1082 packing = Z_SRW_recordPacking_XML;
1083 if (!strcmp(srw_req->recordPacking, "url"))
1084 packing = Z_SRW_recordPacking_URL;
1086 srw_res->records = (Z_SRW_record *)
1087 odr_malloc(assoc->encode,
1088 number * sizeof(*srw_res->records));
1090 srw_res->extra_records = (Z_SRW_extra_record **)
1091 odr_malloc(assoc->encode,
1092 number*sizeof(*srw_res->extra_records));
1094 for (i = 0; i<number; i++)
1097 const char *addinfo = 0;
1099 srw_res->records[j].recordPacking = packing;
1100 srw_res->records[j].recordData_buf = 0;
1101 srw_res->extra_records[j] = 0;
1102 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1103 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1104 srw_res->records + j,
1108 yaz_add_srw_diagnostic(assoc->encode,
1109 &srw_res->diagnostics,
1110 &srw_res->num_diagnostics,
1111 yaz_diag_bib1_to_srw (errcode),
1116 if (srw_res->records[j].recordData_buf)
1119 srw_res->num_records = j;
1121 srw_res->records = 0;
1129 const char *querystr = "?";
1130 const char *querytype = "?";
1131 WRBUF wr = wrbuf_alloc();
1133 switch (srw_req->query_type)
1135 case Z_SRW_query_type_cql:
1137 querystr = srw_req->query.cql;
1139 case Z_SRW_query_type_pqf:
1141 querystr = srw_req->query.pqf;
1144 wrbuf_printf(wr, "SRWSearch ");
1145 wrbuf_printf(wr, srw_req->database);
1146 wrbuf_printf(wr, " ");
1147 if (srw_res->num_diagnostics)
1148 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1149 else if (*http_code != 200)
1150 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1151 else if (srw_res->numberOfRecords)
1153 wrbuf_printf(wr, "OK %d",
1154 (srw_res->numberOfRecords ?
1155 *srw_res->numberOfRecords : 0));
1157 wrbuf_printf(wr, " %s %d+%d",
1158 (srw_res->resultSetId ?
1159 srw_res->resultSetId : "-"),
1160 (srw_req->startRecord ? *srw_req->startRecord : 1),
1161 srw_res->num_records);
1162 yaz_log(log_request, "%s %s: %s", wrbuf_buf(wr), querytype, querystr);
1167 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1170 xmlNodePtr ptr = rr->server_node_ptr;
1173 for (ptr = ptr->children; ptr; ptr = ptr->next)
1175 if (ptr->type != XML_ELEMENT_NODE)
1177 if (!strcmp((const char *) ptr->name, "explain"))
1180 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1184 ptr = xmlCopyNode(ptr, 1);
1186 xmlDocSetRootElement(doc, ptr);
1188 xmlDocDumpMemory(doc, &buf_out, &len);
1189 content = (char*) odr_malloc(rr->stream, 1+len);
1190 memcpy(content, buf_out, len);
1191 content[len] = '\0';
1195 rr->explain_buf = content;
1203 static void srw_bend_explain(association *assoc, request *req,
1205 Z_SRW_explainResponse *srw_res,
1208 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1209 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1211 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1216 rr.stream = assoc->encode;
1217 rr.decode = assoc->decode;
1218 rr.print = assoc->print;
1220 rr.database = srw_req->database;
1222 rr.server_node_ptr = assoc->server->server_node_ptr;
1224 rr.server_node_ptr = 0;
1225 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1226 if (assoc->init->bend_explain)
1227 (*assoc->init->bend_explain)(assoc->backend, &rr);
1229 srw_bend_explain_default(assoc->backend, &rr);
1233 int packing = Z_SRW_recordPacking_string;
1234 if (srw_req->recordPacking)
1236 if (!strcmp(srw_req->recordPacking, "xml"))
1237 packing = Z_SRW_recordPacking_XML;
1238 else if (!strcmp(srw_req->recordPacking, "url"))
1239 packing = Z_SRW_recordPacking_URL;
1241 srw_res->record.recordSchema = rr.schema;
1242 srw_res->record.recordPacking = packing;
1243 srw_res->record.recordData_buf = rr.explain_buf;
1244 srw_res->record.recordData_len = strlen(rr.explain_buf);
1245 srw_res->record.recordPosition = 0;
1251 static void srw_bend_scan(association *assoc, request *req,
1253 Z_SRW_scanResponse *srw_res,
1256 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1257 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1260 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1261 if (srw_res->num_diagnostics == 0 && assoc->init)
1263 struct scan_entry *save_entries;
1265 bend_scan_rr *bsrr = (bend_scan_rr *)
1266 odr_malloc (assoc->encode, sizeof(*bsrr));
1267 bsrr->num_bases = 1;
1268 bsrr->basenames = &srw_req->database;
1270 bsrr->num_entries = srw_req->maximumTerms ?
1271 *srw_req->maximumTerms : 10;
1272 bsrr->term_position = srw_req->responsePosition ?
1273 *srw_req->responsePosition : 1;
1276 bsrr->errstring = 0;
1277 bsrr->referenceId = 0;
1278 bsrr->stream = assoc->encode;
1279 bsrr->print = assoc->print;
1280 bsrr->step_size = odr_intdup(assoc->decode, 0);
1283 if (bsrr->num_entries > 0)
1286 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1288 for (i = 0; i<bsrr->num_entries; i++)
1290 bsrr->entries[i].term = 0;
1291 bsrr->entries[i].occurrences = 0;
1292 bsrr->entries[i].errcode = 0;
1293 bsrr->entries[i].errstring = 0;
1294 bsrr->entries[i].display_term = 0;
1297 save_entries = bsrr->entries; /* save it so we can compare later */
1299 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1300 assoc->init->bend_scan)
1302 Odr_oid *scan_attributeSet = 0;
1304 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1306 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1308 srw_req->scanClause.pqf);
1309 if (scan_attributeSet &&
1310 (attset = oid_getentbyoid(scan_attributeSet)) &&
1311 (attset->oclass == CLASS_ATTSET ||
1312 attset->oclass == CLASS_GENERAL))
1313 bsrr->attributeset = attset->value;
1315 bsrr->attributeset = VAL_NONE;
1316 yaz_pqf_destroy(pqf_parser);
1317 bsrr->scanClause = 0;
1318 ((int (*)(void *, bend_scan_rr *))
1319 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1321 else if (srw_req->query_type == Z_SRW_query_type_cql
1322 && assoc->init->bend_scan && assoc->server
1323 && assoc->server->cql_transform)
1326 bsrr->scanClause = 0;
1327 bsrr->attributeset = VAL_NONE;
1328 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1329 srw_error = cql2pqf_scan(assoc->encode,
1330 srw_req->scanClause.cql,
1331 assoc->server->cql_transform,
1334 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1335 &srw_res->num_diagnostics,
1339 ((int (*)(void *, bend_scan_rr *))
1340 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1343 else if (srw_req->query_type == Z_SRW_query_type_cql
1344 && assoc->init->bend_srw_scan)
1347 bsrr->attributeset = VAL_NONE;
1348 bsrr->scanClause = srw_req->scanClause.cql;
1349 ((int (*)(void *, bend_scan_rr *))
1350 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1354 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1355 &srw_res->num_diagnostics,
1356 YAZ_SRW_UNSUPP_OPERATION, "scan");
1361 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1366 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1368 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1369 &srw_res->num_diagnostics,
1370 srw_error, bsrr->errstring);
1372 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1375 srw_res->terms = (Z_SRW_scanTerm*)
1376 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1379 srw_res->num_terms = bsrr->num_entries;
1380 for (i = 0; i<bsrr->num_entries; i++)
1382 Z_SRW_scanTerm *t = srw_res->terms + i;
1383 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1384 t->numberOfRecords =
1385 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1387 if (save_entries == bsrr->entries &&
1388 bsrr->entries[i].display_term)
1390 /* the entries was _not_ set by the handler. So it's
1391 safe to test for new member display_term. It is
1394 t->displayTerm = odr_strdup(assoc->encode,
1395 bsrr->entries[i].display_term);
1403 WRBUF wr = wrbuf_alloc();
1404 const char *querytype = 0;
1405 const char *querystr = 0;
1407 switch(srw_req->query_type)
1409 case Z_SRW_query_type_pqf:
1411 querystr = srw_req->scanClause.pqf;
1413 case Z_SRW_query_type_cql:
1415 querystr = srw_req->scanClause.cql;
1418 querytype = "UNKNOWN";
1422 wrbuf_printf(wr, "SRWScan ");
1423 wrbuf_printf(wr, srw_req->database);
1424 wrbuf_printf(wr, " ");
1426 if (srw_res->num_diagnostics)
1427 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1428 else if (srw_res->num_terms)
1429 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1431 wrbuf_printf(wr, "OK - - ");
1433 wrbuf_printf(wr, "%d+%d+0 ",
1434 (srw_req->responsePosition ?
1435 *srw_req->responsePosition : 1),
1436 (srw_req->maximumTerms ?
1437 *srw_req->maximumTerms : 1));
1438 /* there is no step size in SRU/W ??? */
1439 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1440 yaz_log(log_request, "%s ", wrbuf_buf(wr) );
1446 static void srw_bend_update(association *assoc, request *req,
1448 Z_SRW_updateResponse *srw_res,
1451 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1452 yaz_log(YLOG_DEBUG, "Got SRW UpdateRequest");
1453 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1455 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1460 rr.stream = assoc->encode;
1461 rr.print = assoc->print;
1463 rr.basenames = &srw_req->database;
1464 rr.operation = srw_req->operation;
1465 rr.operation_status = "failed";
1467 rr.record_version = 0;
1468 rr.record_checksum = 0;
1469 rr.record_old_version = 0;
1470 rr.record_packing = "xml";
1471 rr.record_schema = 0;
1473 rr.request_extra_record = 0;
1474 rr.response_extra_record = 0;
1475 rr.extra_request_data = 0;
1476 rr.extra_response_data = 0;
1481 if ( rr.operation == 0 ){
1482 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1483 &srw_res->num_diagnostics,
1487 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1488 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1489 if ( !strcmp( rr.operation, "delete" ) ){
1490 if ( !srw_req->recordId ){
1491 if ( srw_req->record.recordData_len ){
1492 if ( srw_req->record.recordSchema == 0 ){
1493 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1494 &srw_res->num_diagnostics,
1495 9, "recordSchema" );
1498 rr.record_schema = odr_strdup(assoc->encode,
1499 srw_req->record.recordSchema );
1501 switch (srw_req->record.recordPacking)
1503 case Z_SRW_recordPacking_string:
1504 rr.record_packing = "string";
1506 case Z_SRW_recordPacking_XML:
1507 rr.record_packing = "xml";
1509 case Z_SRW_recordPacking_URL:
1510 rr.record_packing = "url";
1513 rr.record_data = odr_strdupn(assoc->encode,
1514 srw_req->record.recordData_buf,
1515 srw_req->record.recordData_len );
1516 rr.request_extra_record = srw_req->extra_record;
1519 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1520 &srw_res->num_diagnostics,
1521 9, "recordIdentifier OR recordData" );
1525 rr.record_id = srw_req->recordId;
1526 if ( srw_req->record.recordData_len ){
1527 yaz_add_sru_update_diagnostic(assoc->encode,
1528 &srw_res->diagnostics,
1529 &srw_res->num_diagnostics,
1533 if ( srw_req->recordVersion ){
1534 rr.record_version = odr_strdup( assoc->encode,
1535 srw_req->recordVersion );
1538 if ( srw_req->recordOldVersion ){
1539 rr.record_old_version = odr_strdup(assoc->encode,
1540 srw_req->recordOldVersion );
1542 if ( srw_req->extraRequestData ){
1543 rr.extra_request_data = odr_strdup(assoc->encode,
1544 srw_req->extraRequestData );
1547 else if ( !strcmp( rr.operation, "replace" ) ){
1548 if ( !srw_req->recordId ){
1549 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1550 &srw_res->num_diagnostics,
1551 9, "recordIdentifier" );
1554 rr.record_id = srw_req->recordId;
1556 if ( srw_req->record.recordSchema == 0 ){
1557 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1558 &srw_res->num_diagnostics,
1559 9, "recordSchema" );
1562 rr.record_schema = odr_strdup(assoc->encode,
1563 srw_req->record.recordSchema );
1565 switch (srw_req->record.recordPacking)
1567 case Z_SRW_recordPacking_string:
1568 rr.record_packing = "string";
1570 case Z_SRW_recordPacking_XML:
1571 rr.record_packing = "xml";
1573 case Z_SRW_recordPacking_URL:
1574 rr.record_packing = "url";
1577 if ( srw_req->record.recordData_len ){
1578 rr.record_data = odr_strdupn(assoc->encode,
1579 srw_req->record.recordData_buf,
1580 srw_req->record.recordData_len );
1581 rr.request_extra_record = srw_req->extra_record;
1584 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1585 &srw_res->num_diagnostics,
1588 if (srw_req->extraRequestData)
1589 rr.extra_request_data = odr_strdup(assoc->encode,
1590 srw_req->extraRequestData );
1592 else if (!strcmp( rr.operation, "insert" ) ) {
1593 rr.record_id = srw_req->recordId;
1594 if ( srw_req->record.recordSchema == 0 ){
1595 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1596 &srw_res->num_diagnostics,
1597 9, "recordSchema" );
1600 rr.record_schema = odr_strdup(assoc->encode,
1601 srw_req->record.recordSchema);
1603 switch (srw_req->record.recordPacking)
1605 case Z_SRW_recordPacking_string:
1606 rr.record_packing = "string";
1608 case Z_SRW_recordPacking_XML:
1609 rr.record_packing = "xml";
1611 case Z_SRW_recordPacking_URL:
1612 rr.record_packing = "url";
1616 if (srw_req->record.recordData_len)
1618 rr.record_data = odr_strdupn(assoc->encode,
1619 srw_req->record.recordData_buf,
1620 srw_req->record.recordData_len );
1621 rr.request_extra_record = srw_req->extra_record;
1624 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1625 &srw_res->num_diagnostics,
1627 if ( srw_req->extraRequestData )
1628 rr.extra_request_data = odr_strdup(assoc->encode,
1629 srw_req->extraRequestData );
1632 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1633 &srw_res->num_diagnostics,
1634 100, rr.operation );
1636 if (srw_res->num_diagnostics == 0)
1638 if ( assoc->init->bend_srw_update)
1639 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1641 yaz_log( YLOG_WARN, "Got No Update function!");
1647 yaz_add_srw_diagnostic_uri(assoc->encode,
1648 &srw_res->diagnostics,
1649 &srw_res->num_diagnostics,
1653 srw_res->recordId = rr.record_id;
1654 srw_res->operationStatus = rr.operation_status;
1655 srw_res->recordVersion = rr.record_version;
1656 srw_res->recordChecksum = rr.record_checksum;
1657 srw_res->extraResponseData = rr.extra_response_data;
1658 srw_res->record.recordPosition = 0;
1659 if (srw_res->num_diagnostics == 0 && rr.record_data)
1661 srw_res->record.recordSchema = rr.record_schema;
1662 srw_res->record.recordPacking = srw_req->record.recordPacking;
1663 srw_res->record.recordData_buf = rr.record_data;
1664 srw_res->record.recordData_len = strlen(rr.record_data);
1665 srw_res->extra_record = rr.response_extra_record;
1669 srw_res->record.recordData_len = 0;
1674 /* check if path is OK (1); BAD (0) */
1675 static int check_path(const char *path)
1679 if (strstr(path, ".."))
1684 static char *read_file(const char *fname, ODR o, int *sz)
1687 FILE *inf = fopen(fname, "rb");
1691 fseek(inf, 0L, SEEK_END);
1694 buf = odr_malloc(o, *sz);
1695 fread(buf, 1, *sz, inf);
1700 static void process_http_request(association *assoc, request *req)
1702 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1703 ODR o = assoc->encode;
1704 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1706 Z_SOAP *soap_package = 0;
1709 Z_HTTP_Response *hres = 0;
1711 const char *stylesheet = 0; /* for now .. set later */
1712 Z_SRW_diagnostic *diagnostic = 0;
1713 int num_diagnostic = 0;
1714 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1716 if (!control_association(assoc, host, 0))
1718 p = z_get_HTTP_Response(o, 404);
1721 if (r == 2 && assoc->server && assoc->server->docpath
1722 && hreq->path[0] == '/'
1724 /* check if path is a proper prefix of documentroot */
1725 strncmp(hreq->path+1, assoc->server->docpath,
1726 strlen(assoc->server->docpath))
1729 if (!check_path(hreq->path))
1731 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1732 p = z_get_HTTP_Response(o, 404);
1736 int content_size = 0;
1737 char *content_buf = read_file(hreq->path+1, o, &content_size);
1740 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1741 p = z_get_HTTP_Response(o, 404);
1745 const char *ctype = 0;
1746 yaz_mime_types types = yaz_mime_types_create();
1748 yaz_mime_types_add(types, "xsl", "application/xml");
1749 yaz_mime_types_add(types, "xml", "application/xml");
1750 yaz_mime_types_add(types, "css", "text/css");
1751 yaz_mime_types_add(types, "html", "text/html");
1752 yaz_mime_types_add(types, "htm", "text/html");
1753 yaz_mime_types_add(types, "txt", "text/plain");
1754 yaz_mime_types_add(types, "js", "application/x-javascript");
1756 yaz_mime_types_add(types, "gif", "image/gif");
1757 yaz_mime_types_add(types, "png", "image/png");
1758 yaz_mime_types_add(types, "jpg", "image/jpeg");
1759 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1761 ctype = yaz_mime_lookup_fname(types, hreq->path);
1764 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1765 p = z_get_HTTP_Response(o, 404);
1769 p = z_get_HTTP_Response(o, 200);
1770 hres = p->u.HTTP_Response;
1771 hres->content_buf = content_buf;
1772 hres->content_len = content_size;
1773 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1775 yaz_mime_types_destroy(types);
1783 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1784 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1786 if (r == 2) /* not taken */
1788 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1789 &diagnostic, &num_diagnostic);
1790 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1792 if (r == 0) /* decode SRW/SRU OK .. */
1794 int http_code = 200;
1795 if (sr->which == Z_SRW_searchRetrieve_request)
1798 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1800 stylesheet = sr->u.request->stylesheet;
1803 res->u.response->diagnostics = diagnostic;
1804 res->u.response->num_diagnostics = num_diagnostic;
1808 srw_bend_search(assoc, req, sr, res->u.response,
1811 if (http_code == 200)
1812 soap_package->u.generic->p = res;
1814 else if (sr->which == Z_SRW_explain_request)
1816 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1817 stylesheet = sr->u.explain_request->stylesheet;
1820 res->u.explain_response->diagnostics = diagnostic;
1821 res->u.explain_response->num_diagnostics = num_diagnostic;
1823 srw_bend_explain(assoc, req, sr,
1824 res->u.explain_response, &http_code);
1825 if (http_code == 200)
1826 soap_package->u.generic->p = res;
1828 else if (sr->which == Z_SRW_scan_request)
1830 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1831 stylesheet = sr->u.scan_request->stylesheet;
1834 res->u.scan_response->diagnostics = diagnostic;
1835 res->u.scan_response->num_diagnostics = num_diagnostic;
1837 srw_bend_scan(assoc, req, sr,
1838 res->u.scan_response, &http_code);
1839 if (http_code == 200)
1840 soap_package->u.generic->p = res;
1842 else if (sr->which == Z_SRW_update_request)
1844 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1845 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1848 res->u.update_response->diagnostics = diagnostic;
1849 res->u.update_response->num_diagnostics = num_diagnostic;
1851 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1852 srw_bend_update(assoc, req, sr,
1853 res->u.update_response, &http_code);
1854 if (http_code == 200)
1855 soap_package->u.generic->p = res;
1859 yaz_log(log_request, "SOAP ERROR");
1860 /* FIXME - what error, what query */
1862 z_soap_error(assoc->encode, soap_package,
1863 "SOAP-ENV:Client", "Bad method", 0);
1865 if (http_code == 200 || http_code == 500)
1867 static Z_SOAP_Handler soap_handlers[4] = {
1869 {"http://www.loc.gov/zing/srw/", 0,
1870 (Z_SOAP_fun) yaz_srw_codec},
1871 {"http://www.loc.gov/zing/srw/v1.0/", 0,
1872 (Z_SOAP_fun) yaz_srw_codec},
1873 {"http://www.loc.gov/zing/srw/update/", 0,
1874 (Z_SOAP_fun) yaz_ucp_codec},
1880 p = z_get_HTTP_Response(o, 200);
1881 hres = p->u.HTTP_Response;
1883 if (!stylesheet && assoc->server)
1884 stylesheet = assoc->server->stylesheet;
1886 /* empty stylesheet means NO stylesheet */
1887 if (stylesheet && *stylesheet == '\0')
1890 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1891 &hres->content_buf, &hres->content_len,
1892 soap_handlers, charset, stylesheet);
1893 hres->code = http_code;
1895 strcpy(ctype, "text/xml");
1898 strcat(ctype, "; charset=");
1899 strcat(ctype, charset);
1901 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1904 p = z_get_HTTP_Response(o, http_code);
1908 p = z_get_HTTP_Response(o, 500);
1909 hres = p->u.HTTP_Response;
1910 if (!strcmp(hreq->version, "1.0"))
1912 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1913 if (v && !strcmp(v, "Keep-Alive"))
1917 hres->version = "1.0";
1921 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1922 if (v && !strcmp(v, "close"))
1926 hres->version = "1.1";
1930 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1931 assoc->state = ASSOC_DEAD;
1932 assoc->cs_get_mask = 0;
1937 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1939 if (alive && isdigit(*(const unsigned char *) alive))
1943 if (t < 0 || t > 3600)
1945 iochan_settimeout(assoc->client_chan,t);
1946 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1948 process_gdu_response(assoc, req, p);
1951 static void process_gdu_request(association *assoc, request *req)
1953 if (req->gdu_request->which == Z_GDU_Z3950)
1956 req->apdu_request = req->gdu_request->u.z3950;
1957 if (process_z_request(assoc, req, &msg) < 0)
1958 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1960 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1961 process_http_request(assoc, req);
1964 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1969 * Initiate request processing.
1971 static int process_z_request(association *assoc, request *req, char **msg)
1977 *msg = "Unknown Error";
1978 assert(req && req->state == REQUEST_IDLE);
1979 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1981 *msg = "Missing InitRequest";
1984 switch (req->apdu_request->which)
1986 case Z_APDU_initRequest:
1987 res = process_initRequest(assoc, req); break;
1988 case Z_APDU_searchRequest:
1989 res = process_searchRequest(assoc, req, &fd); break;
1990 case Z_APDU_presentRequest:
1991 res = process_presentRequest(assoc, req, &fd); break;
1992 case Z_APDU_scanRequest:
1993 if (assoc->init->bend_scan)
1994 res = process_scanRequest(assoc, req, &fd);
1997 *msg = "Cannot handle Scan APDU";
2001 case Z_APDU_extendedServicesRequest:
2002 if (assoc->init->bend_esrequest)
2003 res = process_ESRequest(assoc, req, &fd);
2006 *msg = "Cannot handle Extended Services APDU";
2010 case Z_APDU_sortRequest:
2011 if (assoc->init->bend_sort)
2012 res = process_sortRequest(assoc, req, &fd);
2015 *msg = "Cannot handle Sort APDU";
2020 process_close(assoc, req);
2022 case Z_APDU_deleteResultSetRequest:
2023 if (assoc->init->bend_delete)
2024 res = process_deleteRequest(assoc, req, &fd);
2027 *msg = "Cannot handle Delete APDU";
2031 case Z_APDU_segmentRequest:
2032 if (assoc->init->bend_segment)
2034 res = process_segmentRequest (assoc, req);
2038 *msg = "Cannot handle Segment APDU";
2042 case Z_APDU_triggerResourceControlRequest:
2045 *msg = "Bad APDU received";
2050 yaz_log(YLOG_DEBUG, " result immediately available");
2051 retval = process_z_response(assoc, req, res);
2055 yaz_log(YLOG_DEBUG, " result unavailble");
2058 else /* no result yet - one will be provided later */
2062 /* Set up an I/O handler for the fd supplied by the backend */
2064 yaz_log(YLOG_DEBUG, " establishing handler for result");
2065 req->state = REQUEST_PENDING;
2066 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2068 iochan_setdata(chan, assoc);
2075 * Handle message from the backend.
2077 void backend_response(IOCHAN i, int event)
2079 association *assoc = (association *)iochan_getdata(i);
2080 request *req = request_head(&assoc->incoming);
2084 yaz_log(YLOG_DEBUG, "backend_response");
2085 assert(assoc && req && req->state != REQUEST_IDLE);
2086 /* determine what it is we're waiting for */
2087 switch (req->apdu_request->which)
2089 case Z_APDU_searchRequest:
2090 res = response_searchRequest(assoc, req, 0, &fd); break;
2092 case Z_APDU_presentRequest:
2093 res = response_presentRequest(assoc, req, 0, &fd); break;
2094 case Z_APDU_scanRequest:
2095 res = response_scanRequest(assoc, req, 0, &fd); break;
2098 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2101 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2103 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2104 do_close(assoc, Z_Close_systemProblem, 0);
2108 else if (!res) /* no result yet - try again later */
2110 yaz_log(YLOG_DEBUG, " no result yet");
2111 iochan_setfd(i, fd); /* in case fd has changed */
2116 * Encode response, and transfer the request structure to the outgoing queue.
2118 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2120 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2124 if (!z_GDU(assoc->print, &res, 0, 0))
2125 yaz_log(YLOG_WARN, "ODR print error: %s",
2126 odr_errmsg(odr_geterror(assoc->print)));
2127 odr_reset(assoc->print);
2129 if (!z_GDU(assoc->encode, &res, 0, 0))
2131 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2132 odr_errmsg(odr_geterror(assoc->decode)),
2133 odr_getelement(assoc->decode));
2136 req->response = odr_getbuf(assoc->encode, &req->len_response,
2137 &req->size_response);
2138 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2139 odr_reset(assoc->encode);
2140 req->state = REQUEST_IDLE;
2141 request_enq(&assoc->outgoing, req);
2142 /* turn the work over to the ir_session handler */
2143 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2144 assoc->cs_put_mask = EVENT_OUTPUT;
2145 /* Is there more work to be done? give that to the input handler too */
2147 if (request_head(&assoc->incoming))
2149 yaz_log (YLOG_DEBUG, "more work to be done");
2150 iochan_setevent(assoc->client_chan, EVENT_WORK);
2157 * Encode response, and transfer the request structure to the outgoing queue.
2159 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2161 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2162 gres->which = Z_GDU_Z3950;
2163 gres->u.z3950 = res;
2165 return process_gdu_response(assoc, req, gres);
2168 static char *get_vhost(Z_OtherInformation *otherInfo)
2170 return yaz_oi_get_string_oidval(&otherInfo, VAL_PROXY, 1, 0);
2174 * Handle init request.
2175 * At the moment, we don't check the options
2176 * anywhere else in the code - we just try not to do anything that would
2177 * break a naive client. We'll toss 'em into the association block when
2178 * we need them there.
2180 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2182 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2183 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2184 Z_InitResponse *resp = apdu->u.initResponse;
2185 bend_initresult *binitres;
2188 statserv_options_block *cb = 0; /* by default no control for backend */
2190 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2191 cb = statserv_getcontrol(); /* got control block for backend */
2193 if (cb && assoc->backend)
2194 (*cb->bend_close)(assoc->backend);
2196 yaz_log(log_requestdetail, "Got initRequest");
2197 if (req->implementationId)
2198 yaz_log(log_requestdetail, "Id: %s",
2199 req->implementationId);
2200 if (req->implementationName)
2201 yaz_log(log_requestdetail, "Name: %s",
2202 req->implementationName);
2203 if (req->implementationVersion)
2204 yaz_log(log_requestdetail, "Version: %s",
2205 req->implementationVersion);
2207 assoc_init_reset(assoc);
2209 assoc->init->auth = req->idAuthentication;
2210 assoc->init->referenceId = req->referenceId;
2212 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2214 Z_CharSetandLanguageNegotiation *negotiation =
2215 yaz_get_charneg_record (req->otherInfo);
2217 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2218 assoc->init->charneg_request = negotiation;
2224 if (req->implementationVersion)
2225 yaz_log(log_requestdetail, "Config: %s",
2228 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2230 /* we have a backend control block, so call that init function */
2231 if (!(binitres = (*cb->bend_init)(assoc->init)))
2233 yaz_log(YLOG_WARN, "Bad response from backend.");
2236 assoc->backend = binitres->handle;
2240 /* no backend. return error */
2241 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2242 binitres->errstring = 0;
2243 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2244 iochan_settimeout(assoc->client_chan, 10);
2246 if ((assoc->init->bend_sort))
2247 yaz_log (YLOG_DEBUG, "Sort handler installed");
2248 if ((assoc->init->bend_search))
2249 yaz_log (YLOG_DEBUG, "Search handler installed");
2250 if ((assoc->init->bend_present))
2251 yaz_log (YLOG_DEBUG, "Present handler installed");
2252 if ((assoc->init->bend_esrequest))
2253 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2254 if ((assoc->init->bend_delete))
2255 yaz_log (YLOG_DEBUG, "Delete handler installed");
2256 if ((assoc->init->bend_scan))
2257 yaz_log (YLOG_DEBUG, "Scan handler installed");
2258 if ((assoc->init->bend_segment))
2259 yaz_log (YLOG_DEBUG, "Segment handler installed");
2261 resp->referenceId = req->referenceId;
2263 /* let's tell the client what we can do */
2264 if (ODR_MASK_GET(req->options, Z_Options_search))
2266 ODR_MASK_SET(resp->options, Z_Options_search);
2267 strcat(options, "srch");
2269 if (ODR_MASK_GET(req->options, Z_Options_present))
2271 ODR_MASK_SET(resp->options, Z_Options_present);
2272 strcat(options, " prst");
2274 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2275 assoc->init->bend_delete)
2277 ODR_MASK_SET(resp->options, Z_Options_delSet);
2278 strcat(options, " del");
2280 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2281 assoc->init->bend_esrequest)
2283 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2284 strcat (options, " extendedServices");
2286 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2288 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2289 strcat(options, " namedresults");
2291 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2293 ODR_MASK_SET(resp->options, Z_Options_scan);
2294 strcat(options, " scan");
2296 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2298 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2299 strcat(options, " concurrop");
2301 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2303 ODR_MASK_SET(resp->options, Z_Options_sort);
2304 strcat(options, " sort");
2307 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
2308 && assoc->init->charneg_response)
2310 Z_OtherInformation **p;
2311 Z_OtherInformationUnit *p0;
2313 yaz_oi_APDU(apdu, &p);
2315 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2316 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2318 p0->which = Z_OtherInfo_externallyDefinedInfo;
2319 p0->information.externallyDefinedInfo =
2320 assoc->init->charneg_response;
2322 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2323 strcat(options, " negotiation");
2326 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2327 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2329 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2331 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2332 assoc->version = 1; /* 1 & 2 are equivalent */
2334 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2336 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2339 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2341 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2345 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2347 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2348 assoc->maximumRecordSize = *req->maximumRecordSize;
2350 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2351 assoc->preferredMessageSize = *req->preferredMessageSize;
2353 resp->preferredMessageSize = &assoc->preferredMessageSize;
2354 resp->maximumRecordSize = &assoc->maximumRecordSize;
2356 resp->implementationId = odr_prepend(assoc->encode,
2357 assoc->init->implementation_id,
2358 resp->implementationId);
2360 resp->implementationName = odr_prepend(assoc->encode,
2361 assoc->init->implementation_name,
2362 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2364 version = odr_strdup(assoc->encode, "$Revision: 1.103 $");
2365 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2366 version[strlen(version)-2] = '\0';
2367 resp->implementationVersion = odr_prepend(assoc->encode,
2368 assoc->init->implementation_version,
2369 odr_prepend(assoc->encode, &version[11],
2370 resp->implementationVersion));
2372 if (binitres->errcode)
2374 assoc->state = ASSOC_DEAD;
2375 resp->userInformationField =
2376 init_diagnostics(assoc->encode, binitres->errcode,
2377 binitres->errstring);
2382 if (!req->idAuthentication)
2383 yaz_log(log_request, "Auth none");
2384 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2386 const char *open = req->idAuthentication->u.open;
2387 const char *slash = strchr(open, '/');
2393 yaz_log(log_request, "Auth open %.*s", len, open);
2395 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2397 const char *user = req->idAuthentication->u.idPass->userId;
2398 const char *group = req->idAuthentication->u.idPass->groupId;
2399 yaz_log(log_request, "Auth idPass %s %s",
2400 user ? user : "-", group ? group : "-");
2402 else if (req->idAuthentication->which
2403 == Z_IdAuthentication_anonymous)
2405 yaz_log(log_request, "Auth anonymous");
2409 yaz_log(log_request, "Auth other");
2414 WRBUF wr = wrbuf_alloc();
2415 wrbuf_printf(wr, "Init ");
2416 if (binitres->errcode)
2417 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2419 wrbuf_printf(wr, "OK -");
2420 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2421 (req->implementationId ? req->implementationId :"-"),
2422 (req->implementationName ?
2423 req->implementationName : "-"),
2424 (req->implementationVersion ?
2425 req->implementationVersion : "-")
2427 yaz_log(log_request, "%s", wrbuf_buf(wr));
2434 * Set the specified `errcode' and `errstring' into a UserInfo-1
2435 * external to be returned to the client in accordance with Z35.90
2436 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2437 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2439 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2441 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2442 addinfo ? " -- " : "", addinfo ? addinfo : "");
2443 return zget_init_diagnostics(odr, error, addinfo);
2447 * nonsurrogate diagnostic record.
2449 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2451 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2453 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2454 addinfo ? " -- " : "", addinfo ? addinfo : "");
2456 rec->which = Z_Records_NSD;
2457 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2463 * surrogate diagnostic.
2465 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2467 int error, const char *addinfo)
2469 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2470 addinfo ? " -- " : "", addinfo ? addinfo : "");
2471 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2474 static Z_Records *pack_records(association *a, char *setname, int start,
2475 int *num, Z_RecordComposition *comp,
2476 int *next, int *pres, oid_value format,
2477 Z_ReferenceId *referenceId,
2478 int *oid, int *errcode)
2480 int recno, total_length = 0, toget = *num, dumped_records = 0;
2481 Z_Records *records =
2482 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2483 Z_NamePlusRecordList *reclist =
2484 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2485 Z_NamePlusRecord **list =
2486 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2488 records->which = Z_Records_DBOSD;
2489 records->u.databaseOrSurDiagnostics = reclist;
2490 reclist->num_records = 0;
2491 reclist->records = list;
2492 *pres = Z_PresentStatus_success;
2496 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2497 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2498 a->maximumRecordSize);
2499 for (recno = start; reclist->num_records < toget; recno++)
2502 Z_NamePlusRecord *thisrec;
2503 int this_length = 0;
2505 * we get the number of bytes allocated on the stream before any
2506 * allocation done by the backend - this should give us a reasonable
2507 * idea of the total size of the data so far.
2509 total_length = odr_total(a->encode) - dumped_records;
2515 freq.last_in_set = 0;
2516 freq.setname = setname;
2517 freq.surrogate_flag = 0;
2518 freq.number = recno;
2520 freq.request_format = format;
2521 freq.request_format_raw = oid;
2522 freq.output_format = format;
2523 freq.output_format_raw = 0;
2524 freq.stream = a->encode;
2525 freq.print = a->print;
2526 freq.referenceId = referenceId;
2529 retrieve_fetch(a, &freq);
2531 *next = freq.last_in_set ? 0 : recno + 1;
2533 /* backend should be able to signal whether error is system-wide
2534 or only pertaining to current record */
2537 if (!freq.surrogate_flag)
2540 *pres = Z_PresentStatus_failure;
2541 /* for 'present request out of range',
2542 set addinfo to record position if not set */
2543 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2544 freq.errstring == 0)
2546 sprintf (s, "%d", recno);
2550 *errcode = freq.errcode;
2551 return diagrec(a, freq.errcode, freq.errstring);
2553 reclist->records[reclist->num_records] =
2554 surrogatediagrec(a, freq.basename, freq.errcode,
2556 reclist->num_records++;
2559 if (freq.record == 0) /* no error and no record ? */
2561 *next = 0; /* signal end-of-set and stop */
2565 this_length = freq.len;
2567 this_length = odr_total(a->encode) - total_length - dumped_records;
2568 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2569 this_length, total_length, dumped_records);
2570 if (a->preferredMessageSize > 0 &&
2571 this_length + total_length > a->preferredMessageSize)
2573 /* record is small enough, really */
2574 if (this_length <= a->preferredMessageSize && recno > start)
2576 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2577 *pres = Z_PresentStatus_partial_2;
2580 /* record can only be fetched by itself */
2581 if (this_length < a->maximumRecordSize)
2583 yaz_log(log_requestdetail, " Record > prefmsgsz");
2586 yaz_log(YLOG_DEBUG, " Dropped it");
2587 reclist->records[reclist->num_records] =
2588 surrogatediagrec(a, freq.basename, 16, 0);
2589 reclist->num_records++;
2590 dumped_records += this_length;
2594 else /* too big entirely */
2596 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2597 this_length, a->maximumRecordSize);
2598 reclist->records[reclist->num_records] =
2599 surrogatediagrec(a, freq.basename, 17, 0);
2600 reclist->num_records++;
2601 dumped_records += this_length;
2606 if (!(thisrec = (Z_NamePlusRecord *)
2607 odr_malloc(a->encode, sizeof(*thisrec))))
2610 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2612 thisrec->databaseName = 0;
2613 thisrec->which = Z_NamePlusRecord_databaseRecord;
2615 if (freq.output_format_raw)
2617 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
2618 freq.output_format = ident->value;
2620 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
2621 freq.record, freq.len);
2622 if (!thisrec->u.databaseRecord)
2624 reclist->records[reclist->num_records] = thisrec;
2625 reclist->num_records++;
2627 *num = reclist->num_records;
2631 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2634 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2635 bend_search_rr *bsrr =
2636 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2638 yaz_log(log_requestdetail, "Got SearchRequest.");
2640 bsrr->request = reqb;
2641 bsrr->association = assoc;
2642 bsrr->referenceId = req->referenceId;
2643 save_referenceId (reqb, bsrr->referenceId);
2644 bsrr->srw_sortKeys = 0;
2645 bsrr->srw_setname = 0;
2646 bsrr->srw_setnameIdleTime = 0;
2648 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2649 if (req->databaseNames)
2652 for (i = 0; i < req->num_databaseNames; i++)
2653 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2656 yaz_log_zquery_level(log_requestdetail,req->query);
2658 if (assoc->init->bend_search)
2660 bsrr->setname = req->resultSetName;
2661 bsrr->replace_set = *req->replaceIndicator;
2662 bsrr->num_bases = req->num_databaseNames;
2663 bsrr->basenames = req->databaseNames;
2664 bsrr->query = req->query;
2665 bsrr->stream = assoc->encode;
2666 nmem_transfer(bsrr->stream->mem, reqb->request_mem);
2667 bsrr->decode = assoc->decode;
2668 bsrr->print = assoc->print;
2671 bsrr->errstring = NULL;
2672 bsrr->search_info = NULL;
2674 if (assoc->server && assoc->server->cql_transform
2675 && req->query->which == Z_Query_type_104
2676 && req->query->u.type_104->which == Z_External_CQL)
2678 /* have a CQL query and a CQL to PQF transform .. */
2680 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2681 assoc->server->cql_transform, bsrr->query);
2683 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2686 (assoc->init->bend_search)(assoc->backend, bsrr);
2687 if (!bsrr->request) /* backend not ready with the search response */
2688 return 0; /* should not be used any more */
2692 /* FIXME - make a diagnostic for it */
2693 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2695 return response_searchRequest(assoc, reqb, bsrr, fd);
2698 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2701 * Prepare a searchresponse based on the backend results. We probably want
2702 * to look at making the fetching of records nonblocking as well, but
2703 * so far, we'll keep things simple.
2704 * If bsrt is null, that means we're called in response to a communications
2705 * event, and we'll have to get the response for ourselves.
2707 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2708 bend_search_rr *bsrt, int *fd)
2710 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2711 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2712 Z_SearchResponse *resp = (Z_SearchResponse *)
2713 odr_malloc (assoc->encode, sizeof(*resp));
2714 int *nulint = odr_intdup (assoc->encode, 0);
2715 bool_t *sr = odr_intdup(assoc->encode, 1);
2716 int *next = odr_intdup(assoc->encode, 0);
2717 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2720 apdu->which = Z_APDU_searchResponse;
2721 apdu->u.searchResponse = resp;
2722 resp->referenceId = req->referenceId;
2723 resp->additionalSearchInfo = 0;
2724 resp->otherInfo = 0;
2726 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2728 yaz_log(YLOG_FATAL, "Bad result from backend");
2731 else if (bsrt->errcode)
2733 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2734 resp->resultCount = nulint;
2735 resp->numberOfRecordsReturned = nulint;
2736 resp->nextResultSetPosition = nulint;
2737 resp->searchStatus = nulint;
2738 resp->resultSetStatus = none;
2739 resp->presentStatus = 0;
2743 int *toget = odr_intdup(assoc->encode, 0);
2744 int *presst = odr_intdup(assoc->encode, 0);
2745 Z_RecordComposition comp, *compp = 0;
2747 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2750 resp->resultCount = &bsrt->hits;
2752 comp.which = Z_RecordComp_simple;
2753 /* how many records does the user agent want, then? */
2754 if (bsrt->hits <= *req->smallSetUpperBound)
2756 *toget = bsrt->hits;
2757 if ((comp.u.simple = req->smallSetElementSetNames))
2760 else if (bsrt->hits < *req->largeSetLowerBound)
2762 *toget = *req->mediumSetPresentNumber;
2763 if (*toget > bsrt->hits)
2764 *toget = bsrt->hits;
2765 if ((comp.u.simple = req->mediumSetElementSetNames))
2771 if (*toget && !resp->records)
2776 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2779 form = prefformat->value;
2781 /* Call bend_present if defined */
2782 if (assoc->init->bend_present)
2784 bend_present_rr *bprr = (bend_present_rr *)
2785 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2786 bprr->setname = req->resultSetName;
2788 bprr->number = *toget;
2789 bprr->format = form;
2791 bprr->referenceId = req->referenceId;
2792 bprr->stream = assoc->encode;
2793 bprr->print = assoc->print;
2794 bprr->request = reqb;
2795 bprr->association = assoc;
2797 bprr->errstring = NULL;
2798 (*assoc->init->bend_present)(assoc->backend, bprr);
2804 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2805 *resp->presentStatus = Z_PresentStatus_failure;
2810 resp->records = pack_records(assoc, req->resultSetName, 1,
2811 toget, compp, next, presst, form, req->referenceId,
2812 req->preferredRecordSyntax, NULL);
2815 resp->numberOfRecordsReturned = toget;
2816 returnedrecs = *toget;
2817 resp->nextResultSetPosition = next;
2818 resp->searchStatus = sr;
2819 resp->resultSetStatus = 0;
2820 resp->presentStatus = presst;
2824 if (*resp->resultCount)
2826 resp->numberOfRecordsReturned = nulint;
2827 resp->nextResultSetPosition = next;
2828 resp->searchStatus = sr;
2829 resp->resultSetStatus = 0;
2830 resp->presentStatus = 0;
2833 resp->additionalSearchInfo = bsrt->search_info;
2838 WRBUF wr = wrbuf_alloc();
2840 for (i = 0 ; i < req->num_databaseNames; i++){
2842 wrbuf_printf(wr, "+");
2843 wrbuf_printf(wr, req->databaseNames[i]);
2845 wrbuf_printf(wr, " ");
2848 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2850 wrbuf_printf(wr, "OK %d", bsrt->hits);
2851 wrbuf_printf(wr, " %s 1+%d ",
2852 req->resultSetName, returnedrecs);
2853 yaz_query_to_wrbuf(wr, req->query);
2855 yaz_log(log_request, "Search %s", wrbuf_buf(wr));
2862 * Maybe we got a little over-friendly when we designed bend_fetch to
2863 * get only one record at a time. Some backends can optimise multiple-record
2864 * fetches, and at any rate, there is some overhead involved in
2865 * all that selecting and hopping around. Problem is, of course, that the
2866 * frontend can't know ahead of time how many records it'll need to
2867 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2868 * is downright lousy as a bulk data transfer protocol.
2870 * To start with, we'll do the fetching of records from the backend
2871 * in one operation: To save some trips in and out of the event-handler,
2872 * and to simplify the interface to pack_records. At any rate, asynch
2873 * operation is more fun in operations that have an unpredictable execution
2874 * speed - which is normally more true for search than for present.
2876 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2879 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2883 Z_PresentResponse *resp;
2887 const char *errstring = 0;
2889 yaz_log(log_requestdetail, "Got PresentRequest.");
2891 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2894 form = prefformat->value;
2895 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2897 resp->presentStatus = odr_intdup(assoc->encode, 0);
2898 if (assoc->init->bend_present)
2900 bend_present_rr *bprr = (bend_present_rr *)
2901 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2902 bprr->setname = req->resultSetId;
2903 bprr->start = *req->resultSetStartPoint;
2904 bprr->number = *req->numberOfRecordsRequested;
2905 bprr->format = form;
2906 bprr->comp = req->recordComposition;
2907 bprr->referenceId = req->referenceId;
2908 bprr->stream = assoc->encode;
2909 bprr->print = assoc->print;
2910 bprr->request = reqb;
2911 bprr->association = assoc;
2913 bprr->errstring = NULL;
2914 (*assoc->init->bend_present)(assoc->backend, bprr);
2917 return 0; /* should not happen */
2920 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2921 *resp->presentStatus = Z_PresentStatus_failure;
2922 errcode = bprr->errcode;
2923 errstring = bprr->errstring;
2926 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2927 next = odr_intdup(assoc->encode, 0);
2928 num = odr_intdup(assoc->encode, 0);
2930 apdu->which = Z_APDU_presentResponse;
2931 apdu->u.presentResponse = resp;
2932 resp->referenceId = req->referenceId;
2933 resp->otherInfo = 0;
2937 *num = *req->numberOfRecordsRequested;
2939 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2940 num, req->recordComposition, next,
2941 resp->presentStatus,
2942 form, req->referenceId, req->preferredRecordSyntax,
2947 WRBUF wr = wrbuf_alloc();
2948 wrbuf_printf(wr, "Present ");
2950 if (*resp->presentStatus == Z_PresentStatus_failure)
2951 wrbuf_printf(wr, "ERROR %d ", errcode);
2952 else if (*resp->presentStatus == Z_PresentStatus_success)
2953 wrbuf_printf(wr, "OK - ");
2955 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2957 wrbuf_printf(wr, " %s %d+%d ",
2958 req->resultSetId, *req->resultSetStartPoint,
2959 *req->numberOfRecordsRequested);
2960 yaz_log(log_request, "%s", wrbuf_buf(wr) );
2965 resp->numberOfRecordsReturned = num;
2966 resp->nextResultSetPosition = next;
2972 * Scan was implemented rather in a hurry, and with support for only the basic
2973 * elements of the service in the backend API. Suggestions are welcome.
2975 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2977 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2978 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2979 Z_ScanResponse *res = (Z_ScanResponse *)
2980 odr_malloc (assoc->encode, sizeof(*res));
2981 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2982 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2983 Z_ListEntries *ents = (Z_ListEntries *)
2984 odr_malloc (assoc->encode, sizeof(*ents));
2985 Z_DiagRecs *diagrecs_p = NULL;
2987 bend_scan_rr *bsrr = (bend_scan_rr *)
2988 odr_malloc (assoc->encode, sizeof(*bsrr));
2989 struct scan_entry *save_entries;
2991 yaz_log(log_requestdetail, "Got ScanRequest");
2993 apdu->which = Z_APDU_scanResponse;
2994 apdu->u.scanResponse = res;
2995 res->referenceId = req->referenceId;
2997 /* if step is absent, set it to 0 */
2998 res->stepSize = odr_intdup(assoc->encode, 0);
3000 *res->stepSize = *req->stepSize;
3002 res->scanStatus = scanStatus;
3003 res->numberOfEntriesReturned = numberOfEntriesReturned;
3004 res->positionOfTerm = 0;
3005 res->entries = ents;
3006 ents->num_entries = 0;
3007 ents->entries = NULL;
3008 ents->num_nonsurrogateDiagnostics = 0;
3009 ents->nonsurrogateDiagnostics = NULL;
3010 res->attributeSet = 0;
3013 if (req->databaseNames)
3016 for (i = 0; i < req->num_databaseNames; i++)
3017 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
3019 bsrr->scanClause = 0;
3021 bsrr->errstring = 0;
3022 bsrr->num_bases = req->num_databaseNames;
3023 bsrr->basenames = req->databaseNames;
3024 bsrr->num_entries = *req->numberOfTermsRequested;
3025 bsrr->term = req->termListAndStartPoint;
3026 bsrr->referenceId = req->referenceId;
3027 bsrr->stream = assoc->encode;
3028 bsrr->print = assoc->print;
3029 bsrr->step_size = res->stepSize;
3031 /* For YAZ 2.0 and earlier it was the backend handler that
3032 initialized entries (member display_term did not exist)
3033 YAZ 2.0 and later sets 'entries' and initialize all members
3034 including 'display_term'. If YAZ 2.0 or later sees that
3035 entries was modified - we assume that it is an old handler and
3036 that 'display_term' is _not_ set.
3038 if (bsrr->num_entries > 0)
3041 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3043 for (i = 0; i<bsrr->num_entries; i++)
3045 bsrr->entries[i].term = 0;
3046 bsrr->entries[i].occurrences = 0;
3047 bsrr->entries[i].errcode = 0;
3048 bsrr->entries[i].errstring = 0;
3049 bsrr->entries[i].display_term = 0;
3052 save_entries = bsrr->entries; /* save it so we can compare later */
3054 if (req->attributeSet &&
3055 (attset = oid_getentbyoid(req->attributeSet)) &&
3056 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
3057 bsrr->attributeset = attset->value;
3059 bsrr->attributeset = VAL_NONE;
3060 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3061 bsrr->attributeset);
3062 bsrr->term_position = req->preferredPositionInResponse ?
3063 *req->preferredPositionInResponse : 1;
3065 ((int (*)(void *, bend_scan_rr *))
3066 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3069 diagrecs_p = zget_DiagRecs(assoc->encode,
3070 bsrr->errcode, bsrr->errstring);
3074 Z_Entry **tab = (Z_Entry **)
3075 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3077 if (bsrr->status == BEND_SCAN_PARTIAL)
3078 *scanStatus = Z_Scan_partial_5;
3080 *scanStatus = Z_Scan_success;
3081 ents->entries = tab;
3082 ents->num_entries = bsrr->num_entries;
3083 res->numberOfEntriesReturned = &ents->num_entries;
3084 res->positionOfTerm = &bsrr->term_position;
3085 for (i = 0; i < bsrr->num_entries; i++)
3091 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3092 if (bsrr->entries[i].occurrences >= 0)
3094 e->which = Z_Entry_termInfo;
3095 e->u.termInfo = t = (Z_TermInfo *)
3096 odr_malloc(assoc->encode, sizeof(*t));
3097 t->suggestedAttributes = 0;
3099 if (save_entries == bsrr->entries &&
3100 bsrr->entries[i].display_term)
3102 /* the entries was _not_ set by the handler. So it's
3103 safe to test for new member display_term. It is
3106 t->displayTerm = odr_strdup(assoc->encode,
3107 bsrr->entries[i].display_term);
3109 t->alternativeTerm = 0;
3110 t->byAttributes = 0;
3111 t->otherTermInfo = 0;
3112 t->globalOccurrences = &bsrr->entries[i].occurrences;
3113 t->term = (Z_Term *)
3114 odr_malloc(assoc->encode, sizeof(*t->term));
3115 t->term->which = Z_Term_general;
3116 t->term->u.general = o =
3117 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3118 o->buf = (unsigned char *)
3119 odr_malloc(assoc->encode, o->len = o->size =
3120 strlen(bsrr->entries[i].term));
3121 memcpy(o->buf, bsrr->entries[i].term, o->len);
3122 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3123 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3127 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3128 bsrr->entries[i].errcode,
3129 bsrr->entries[i].errstring);
3130 assert (drecs->num_diagRecs == 1);
3131 e->which = Z_Entry_surrogateDiagnostic;
3132 assert (drecs->diagRecs[0]);
3133 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3139 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3140 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3145 WRBUF wr = wrbuf_alloc();
3146 wrbuf_printf(wr, "Scan ");
3147 for (i = 0 ; i < req->num_databaseNames; i++){
3149 wrbuf_printf(wr, "+");
3150 wrbuf_printf(wr, req->databaseNames[i]);
3152 wrbuf_printf(wr, " ");
3155 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3156 wrbuf_printf(wr, " ");
3159 wrbuf_printf(wr, "OK ");
3160 /* else if (*res->scanStatus == Z_Scan_success) */
3161 /* wrbuf_printf(wr, "OK "); */
3163 /* wrbuf_printf(wr, "Partial "); */
3165 if (*res->numberOfEntriesReturned)
3166 wrbuf_printf(wr, "%d - ", *res->numberOfEntriesReturned);
3168 wrbuf_printf(wr, "0 - ");
3170 wrbuf_printf(wr, "%d+%d+%d ",
3171 (req->preferredPositionInResponse ?
3172 *req->preferredPositionInResponse : 1),
3173 *req->numberOfTermsRequested,
3174 (res->stepSize ? *res->stepSize : 1));
3176 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3177 bsrr->attributeset);
3178 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3184 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3188 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3189 Z_SortResponse *res = (Z_SortResponse *)
3190 odr_malloc (assoc->encode, sizeof(*res));
3191 bend_sort_rr *bsrr = (bend_sort_rr *)
3192 odr_malloc (assoc->encode, sizeof(*bsrr));
3194 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3196 yaz_log(log_requestdetail, "Got SortRequest.");
3198 bsrr->num_input_setnames = req->num_inputResultSetNames;
3199 for (i=0;i<req->num_inputResultSetNames;i++)
3200 yaz_log(log_requestdetail, "Input resultset: '%s'",
3201 req->inputResultSetNames[i]);
3202 bsrr->input_setnames = req->inputResultSetNames;
3203 bsrr->referenceId = req->referenceId;
3204 bsrr->output_setname = req->sortedResultSetName;
3205 yaz_log(log_requestdetail, "Output resultset: '%s'",
3206 req->sortedResultSetName);
3207 bsrr->sort_sequence = req->sortSequence;
3208 /*FIXME - dump those sequences too */
3209 bsrr->stream = assoc->encode;
3210 bsrr->print = assoc->print;
3212 bsrr->sort_status = Z_SortResponse_failure;
3214 bsrr->errstring = 0;
3216 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3218 res->referenceId = bsrr->referenceId;
3219 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3220 res->resultSetStatus = 0;
3223 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3224 bsrr->errcode, bsrr->errstring);
3225 res->diagnostics = dr->diagRecs;
3226 res->num_diagnostics = dr->num_diagRecs;
3230 res->num_diagnostics = 0;
3231 res->diagnostics = 0;
3233 res->resultCount = 0;
3236 apdu->which = Z_APDU_sortResponse;
3237 apdu->u.sortResponse = res;
3240 WRBUF wr = wrbuf_alloc();
3241 wrbuf_printf(wr, "Sort ");
3243 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3245 wrbuf_printf(wr, "OK -");
3246 wrbuf_printf(wr, " (");
3247 for (i = 0; i<req->num_inputResultSetNames; i++)
3250 wrbuf_printf(wr, "+");
3251 wrbuf_printf(wr, req->inputResultSetNames[i]);
3253 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3255 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3261 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3265 Z_DeleteResultSetRequest *req =
3266 reqb->apdu_request->u.deleteResultSetRequest;
3267 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3268 odr_malloc (assoc->encode, sizeof(*res));
3269 bend_delete_rr *bdrr = (bend_delete_rr *)
3270 odr_malloc (assoc->encode, sizeof(*bdrr));
3271 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3273 yaz_log(log_requestdetail, "Got DeleteRequest.");
3275 bdrr->num_setnames = req->num_resultSetList;
3276 bdrr->setnames = req->resultSetList;
3277 for (i = 0; i<req->num_resultSetList; i++)
3278 yaz_log(log_requestdetail, "resultset: '%s'",
3279 req->resultSetList[i]);
3280 bdrr->stream = assoc->encode;
3281 bdrr->print = assoc->print;
3282 bdrr->function = *req->deleteFunction;
3283 bdrr->referenceId = req->referenceId;
3285 if (bdrr->num_setnames > 0)
3287 bdrr->statuses = (int*)
3288 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3289 bdrr->num_setnames);
3290 for (i = 0; i < bdrr->num_setnames; i++)
3291 bdrr->statuses[i] = 0;
3293 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3295 res->referenceId = req->referenceId;
3297 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3299 res->deleteListStatuses = 0;
3300 if (bdrr->num_setnames > 0)
3303 res->deleteListStatuses = (Z_ListStatuses *)
3304 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3305 res->deleteListStatuses->num = bdrr->num_setnames;
3306 res->deleteListStatuses->elements =
3308 odr_malloc (assoc->encode,
3309 sizeof(*res->deleteListStatuses->elements) *
3310 bdrr->num_setnames);
3311 for (i = 0; i<bdrr->num_setnames; i++)
3313 res->deleteListStatuses->elements[i] =
3315 odr_malloc (assoc->encode,
3316 sizeof(**res->deleteListStatuses->elements));
3317 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3318 res->deleteListStatuses->elements[i]->id =
3319 odr_strdup (assoc->encode, bdrr->setnames[i]);
3322 res->numberNotDeleted = 0;
3323 res->bulkStatuses = 0;
3324 res->deleteMessage = 0;
3327 apdu->which = Z_APDU_deleteResultSetResponse;
3328 apdu->u.deleteResultSetResponse = res;
3331 WRBUF wr = wrbuf_alloc();
3332 wrbuf_printf(wr, "Delete ");
3333 if (bdrr->delete_status)
3334 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3336 wrbuf_printf(wr, "OK -");
3337 for (i = 0; i<req->num_resultSetList; i++)
3338 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3339 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3345 static void process_close(association *assoc, request *reqb)
3347 Z_Close *req = reqb->apdu_request->u.close;
3348 static char *reasons[] =
3355 "securityViolation",
3362 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3363 reasons[*req->closeReason], req->diagnosticInformation ?
3364 req->diagnosticInformation : "NULL");
3365 if (assoc->version < 3) /* to make do_force respond with close */
3367 do_close_req(assoc, Z_Close_finished,
3368 "Association terminated by client", reqb);
3369 yaz_log(log_request,"Close OK");
3372 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3376 reqb->len_refid = refid->len;
3377 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3378 memcpy (reqb->refid, refid->buf, refid->len);
3382 reqb->len_refid = 0;
3387 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3389 process_z_response (a, req, res);
3392 bend_request bend_request_mk (bend_association a)
3394 request *nreq = request_get (&a->outgoing);
3395 nreq->request_mem = nmem_create ();
3399 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3404 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3405 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3406 id->len = id->size = req->len_refid;
3407 memcpy (id->buf, req->refid, req->len_refid);
3411 void bend_request_destroy (bend_request *req)
3413 nmem_destroy((*req)->request_mem);
3414 request_release(*req);
3418 int bend_backend_respond (bend_association a, bend_request req)
3422 r = process_z_request (a, req, &msg);
3424 yaz_log (YLOG_WARN, "%s", msg);
3428 void bend_request_setdata(bend_request r, void *p)
3433 void *bend_request_getdata(bend_request r)
3435 return r->clientData;
3438 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3440 bend_segment_rr req;
3442 req.segment = reqb->apdu_request->u.segmentRequest;
3443 req.stream = assoc->encode;
3444 req.decode = assoc->decode;
3445 req.print = assoc->print;
3446 req.association = assoc;
3448 (*assoc->init->bend_segment)(assoc->backend, &req);
3453 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3455 bend_esrequest_rr esrequest;
3456 const char *ext_name = "unknown";
3458 Z_ExtendedServicesRequest *req =
3459 reqb->apdu_request->u.extendedServicesRequest;
3460 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3462 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3464 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3465 esrequest.stream = assoc->encode;
3466 esrequest.decode = assoc->decode;
3467 esrequest.print = assoc->print;
3468 esrequest.errcode = 0;
3469 esrequest.errstring = NULL;
3470 esrequest.request = reqb;
3471 esrequest.association = assoc;
3472 esrequest.taskPackage = 0;
3473 esrequest.referenceId = req->referenceId;
3476 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3478 switch(esrequest.esr->taskSpecificParameters->which)
3480 case Z_External_itemOrder:
3481 ext_name = "ItemOrder"; break;
3482 case Z_External_update:
3483 ext_name = "Update"; break;
3484 case Z_External_update0:
3485 ext_name = "Update0"; break;
3486 case Z_External_ESAdmin:
3487 ext_name = "Admin"; break;
3492 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3494 /* If the response is being delayed, return NULL */
3495 if (esrequest.request == NULL)
3498 resp->referenceId = req->referenceId;
3500 if (esrequest.errcode == -1)
3502 /* Backend service indicates request will be processed */
3503 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3504 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3506 else if (esrequest.errcode == 0)
3508 /* Backend service indicates request will be processed */
3509 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3510 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3514 Z_DiagRecs *diagRecs =
3515 zget_DiagRecs(assoc->encode, esrequest.errcode,
3516 esrequest.errstring);
3517 /* Backend indicates error, request will not be processed */
3518 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3519 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3520 resp->num_diagnostics = diagRecs->num_diagRecs;
3521 resp->diagnostics = diagRecs->diagRecs;
3524 WRBUF wr = wrbuf_alloc();
3525 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3526 yaz_log(log_request, "EsRequest %s", wrbuf_buf(wr) );
3531 /* Do something with the members of bend_extendedservice */
3532 if (esrequest.taskPackage)
3533 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
3534 (const char *) esrequest.taskPackage,
3536 yaz_log(YLOG_DEBUG,"Send the result apdu");
3543 * indent-tabs-mode: nil
3545 * vim: shiftwidth=4 tabstop=8 expandtab