1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2010 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements GFS session logic.
9 * Frontend server logic.
11 * This code receives incoming APDUs, and handles client requests by means
14 * Some of the code is getting quite involved, compared to simpler servers -
15 * primarily because it is asynchronous both in the communication with
16 * the user and the backend. We think the complexity will pay off in
17 * the form of greater flexibility when more asynchronous facilities
20 * Memory management has become somewhat involved. In the simple case, where
21 * only one PDU is pending at a time, it will simply reuse the same memory,
22 * once it has found its working size. When we enable multiple concurrent
23 * operations, perhaps even with multiple parallel calls to the backend, it
24 * will maintain a pool of buffers for encoding and decoding, trying to
25 * minimize memory allocation/deallocation during normal operation.
36 #include <sys/types.h>
44 #define S_ISREG(x) (x & _S_IFREG)
53 #include <libxml/parser.h>
54 #include <libxml/tree.h>
57 #include <yaz/yconfig.h>
58 #include <yaz/xmalloc.h>
59 #include <yaz/comstack.h>
63 #include <yaz/proto.h>
64 #include <yaz/oid_db.h>
66 #include <yaz/logrpn.h>
67 #include <yaz/querytowrbuf.h>
68 #include <yaz/statserv.h>
69 #include <yaz/diagbib1.h>
70 #include <yaz/charneg.h>
71 #include <yaz/otherinfo.h>
72 #include <yaz/yaz-util.h>
73 #include <yaz/pquery.h>
74 #include <yaz/oid_db.h>
77 #include <yaz/backend.h>
78 #include <yaz/yaz-ccl.h>
80 static void process_gdu_request(association *assoc, request *req);
81 static int process_z_request(association *assoc, request *req, char **msg);
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);
88 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
89 bend_search_rr *bsrr);
90 static Z_APDU *process_presentRequest(association *assoc, request *reqb);
91 static Z_APDU *process_scanRequest(association *assoc, request *reqb);
92 static Z_APDU *process_sortRequest(association *assoc, request *reqb);
93 static void process_close(association *assoc, request *reqb);
94 static Z_APDU *process_deleteRequest(association *assoc, request *reqb);
95 static Z_APDU *process_segmentRequest(association *assoc, request *reqb);
96 static Z_APDU *process_ESRequest(association *assoc, request *reqb);
98 /* dynamic logging levels */
99 static int logbits_set = 0;
100 static int log_session = 0; /* one-line logs for session */
101 static int log_sessiondetail = 0; /* more detailed stuff */
102 static int log_request = 0; /* one-line logs for requests */
103 static int log_requestdetail = 0; /* more detailed stuff */
105 /** get_logbits sets global loglevel bits */
106 static void get_logbits(void)
107 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
111 log_session = yaz_log_module_level("session");
112 log_sessiondetail = yaz_log_module_level("sessiondetail");
113 log_request = yaz_log_module_level("request");
114 log_requestdetail = yaz_log_module_level("requestdetail");
118 static void wr_diag(WRBUF w, int error, const char *addinfo)
120 wrbuf_printf(w, "ERROR %d+", error);
121 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
125 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
131 * Create and initialize a new association-handle.
132 * channel : iochannel for the current line.
133 * link : communications channel.
134 * Returns: 0 or a new association handle.
136 association *create_association(IOCHAN channel, COMSTACK link,
137 const char *apdufile)
143 if (!(anew = (association *)xmalloc(sizeof(*anew))))
147 anew->last_control = 0;
148 anew->client_chan = channel;
149 anew->client_link = link;
150 anew->cs_get_mask = 0;
151 anew->cs_put_mask = 0;
152 anew->cs_accept_mask = 0;
153 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
154 !(anew->encode = odr_createmem(ODR_ENCODE)))
156 if (apdufile && *apdufile)
160 if (!(anew->print = odr_createmem(ODR_PRINT)))
162 if (*apdufile == '@')
164 odr_setprint(anew->print, yaz_log_file());
166 else if (*apdufile != '-')
169 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
170 if (!(f = fopen(filename, "w")))
172 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
175 setvbuf(f, 0, _IONBF, 0);
176 odr_setprint(anew->print, f);
181 anew->input_buffer = 0;
182 anew->input_buffer_len = 0;
184 anew->state = ASSOC_NEW;
185 request_initq(&anew->incoming);
186 request_initq(&anew->outgoing);
187 anew->proto = cs_getproto(link);
193 * Free association and release resources.
195 void destroy_association(association *h)
197 statserv_options_block *cb = statserv_getcontrol();
201 odr_destroy(h->decode);
202 odr_destroy(h->encode);
204 odr_destroy(h->print);
206 xfree(h->input_buffer);
208 (*cb->bend_close)(h->backend);
209 while ((req = request_deq(&h->incoming)))
210 request_release(req);
211 while ((req = request_deq(&h->outgoing)))
212 request_release(req);
213 request_delq(&h->incoming);
214 request_delq(&h->outgoing);
216 xmalloc_trav("session closed");
217 if (cb && cb->one_shot)
223 static void do_close_req(association *a, int reason, char *message,
226 Z_APDU *apdu = zget_APDU(a->encode, Z_APDU_close);
227 Z_Close *cls = apdu->u.close;
229 /* Purge request queue */
230 while (request_deq(&a->incoming));
231 while (request_deq(&a->outgoing));
234 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
235 reason, message ? message : "none");
236 *cls->closeReason = reason;
237 cls->diagnosticInformation = message;
238 process_z_response(a, req, apdu);
239 iochan_settimeout(a->client_chan, 20);
243 request_release(req);
244 yaz_log(log_requestdetail, "v2 client. No Close PDU");
245 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
248 a->state = ASSOC_DEAD;
251 static void do_close(association *a, int reason, char *message)
253 request *req = request_get(&a->outgoing);
254 do_close_req(a, reason, message, req);
258 int ir_read(IOCHAN h, int event)
260 association *assoc = (association *)iochan_getdata(h);
261 COMSTACK conn = assoc->client_link;
264 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
266 yaz_log(YLOG_DEBUG, "ir_session (input)");
267 /* We aren't speaking to this fellow */
268 if (assoc->state == ASSOC_DEAD)
270 yaz_log(log_sessiondetail, "Connection closed - end of session");
272 destroy_association(assoc);
276 assoc->cs_get_mask = EVENT_INPUT;
280 int res = cs_get(conn, &assoc->input_buffer,
281 &assoc->input_buffer_len);
282 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
284 yaz_log(log_session, "Connection error: %s res=%d",
285 cs_errmsg(cs_errno(conn)), res);
286 req = request_get(&assoc->incoming); /* get a new request */
287 do_close_req(assoc, Z_Close_protocolError,
288 "Incoming package too large", req);
293 yaz_log(log_session, "Connection closed by client");
294 assoc->state = ASSOC_DEAD;
297 else if (res == 1) /* incomplete read - wait for more */
299 if (conn->io_pending & CS_WANT_WRITE)
300 assoc->cs_get_mask |= EVENT_OUTPUT;
301 iochan_setflag(h, assoc->cs_get_mask);
304 /* we got a complete PDU. Let's decode it */
305 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
306 assoc->input_buffer[0] & 0xff,
307 assoc->input_buffer[1] & 0xff,
308 assoc->input_buffer[2] & 0xff);
309 req = request_get(&assoc->incoming); /* get a new request */
310 odr_reset(assoc->decode);
311 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
312 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
314 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
316 odr_errmsg(odr_geterror(assoc->decode)),
317 odr_getelement(assoc->decode),
318 (long) odr_offset(assoc->decode));
319 if (assoc->decode->error != OHTTP)
321 yaz_log(YLOG_WARN, "PDU dump:");
322 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
323 request_release(req);
324 do_close(assoc, Z_Close_protocolError, "Malformed package");
328 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
329 assoc->state = ASSOC_DEAD;
330 process_gdu_response(assoc, req, p);
334 req->request_mem = odr_extract_mem(assoc->decode);
337 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
338 yaz_log(YLOG_WARN, "ODR print error: %s",
339 odr_errmsg(odr_geterror(assoc->print)));
340 odr_reset(assoc->print);
342 request_enq(&assoc->incoming, req);
344 while (cs_more(conn));
350 * This is where PDUs from the client are read and the further
351 * processing is initiated. Flow of control moves down through the
352 * various process_* functions below, until the encoded result comes back up
353 * to the output handler in here.
355 * h : the I/O channel that has an outstanding event.
356 * event : the current outstanding event.
358 void ir_session(IOCHAN h, int event)
361 association *assoc = (association *)iochan_getdata(h);
362 COMSTACK conn = assoc->client_link;
365 assert(h && conn && assoc);
366 if (event == EVENT_TIMEOUT)
368 if (assoc->state != ASSOC_UP)
370 yaz_log(log_session, "Timeout. Closing connection");
371 /* do we need to lod this at all */
373 destroy_association(assoc);
378 yaz_log(log_sessiondetail, "Timeout. Sending Z39.50 Close");
379 do_close(assoc, Z_Close_lackOfActivity, 0);
383 if (event & assoc->cs_accept_mask)
385 if (!cs_accept(conn))
387 yaz_log(YLOG_WARN, "accept failed");
388 destroy_association(assoc);
392 iochan_clearflag(h, EVENT_OUTPUT);
393 if (conn->io_pending)
394 { /* cs_accept didn't complete */
395 assoc->cs_accept_mask =
396 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
397 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
399 iochan_setflag(h, assoc->cs_accept_mask);
402 { /* cs_accept completed. Prepare for reading (cs_get) */
403 assoc->cs_accept_mask = 0;
404 assoc->cs_get_mask = EVENT_INPUT;
405 iochan_setflag(h, assoc->cs_get_mask);
409 if (event & assoc->cs_get_mask) /* input */
411 if (!ir_read(h, event))
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->query_charset = 0;
489 assoc->init->records_in_same_charset = 0;
490 assoc->init->bend_sort = NULL;
491 assoc->init->bend_search = NULL;
492 assoc->init->bend_present = NULL;
493 assoc->init->bend_esrequest = NULL;
494 assoc->init->bend_delete = NULL;
495 assoc->init->bend_scan = NULL;
496 assoc->init->bend_segment = NULL;
497 assoc->init->bend_fetch = NULL;
498 assoc->init->bend_explain = NULL;
499 assoc->init->bend_srw_scan = NULL;
500 assoc->init->bend_srw_update = NULL;
501 assoc->init->named_result_sets = 0;
503 assoc->init->charneg_request = NULL;
504 assoc->init->charneg_response = NULL;
506 assoc->init->decode = assoc->decode;
507 assoc->init->peer_name =
508 odr_strdup(assoc->encode, cs_addrstr(assoc->client_link));
510 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
513 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
515 statserv_options_block *cb = statserv_getcontrol();
518 const char *encoding = "UTF-8";
520 bend_initresult *binitres;
522 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
523 assoc_init_reset(assoc);
527 Z_IdAuthentication *auth = (Z_IdAuthentication *)
528 odr_malloc(assoc->decode, sizeof(*auth));
531 len = strlen(sr->username) + 1;
533 len += strlen(sr->password) + 2;
534 auth->which = Z_IdAuthentication_open;
535 auth->u.open = (char *) odr_malloc(assoc->decode, len);
536 strcpy(auth->u.open, sr->username);
537 if (sr->password && *sr->password)
539 strcat(auth->u.open, "/");
540 strcat(auth->u.open, sr->password);
542 assoc->init->auth = auth;
546 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
547 assoc->init->charneg_request = ce->u.charNeg3;
550 if (!(binitres = (*cb->bend_init)(assoc->init)))
552 assoc->state = ASSOC_DEAD;
553 yaz_add_srw_diagnostic(assoc->encode, d, num,
554 YAZ_SRW_AUTHENTICATION_ERROR, 0);
557 assoc->backend = binitres->handle;
558 assoc->init->auth = 0;
559 if (binitres->errcode)
561 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
562 assoc->state = ASSOC_DEAD;
563 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
564 binitres->errstring);
572 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
575 yaz_record_conv_t rc = 0;
576 const char *match_schema = 0;
577 Odr_oid *match_syntax = 0;
582 const char *input_schema = yaz_get_esn(rr->comp);
583 Odr_oid *input_syntax_raw = rr->request_format;
585 const char *backend_schema = 0;
586 Odr_oid *backend_syntax = 0;
588 r = yaz_retrieval_request(assoc->server->retrieval,
596 if (r == -1) /* error ? */
598 const char *details = yaz_retrieval_get_error(
599 assoc->server->retrieval);
601 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
603 rr->errstring = odr_strdup(rr->stream, details);
606 else if (r == 1 || r == 3)
608 const char *details = input_schema;
610 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
612 rr->errstring = odr_strdup(rr->stream, details);
617 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
618 if (input_syntax_raw)
620 char oidbuf[OID_STR_MAX];
621 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
622 rr->errstring = odr_strdup(rr->stream, oidbuf);
628 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
631 rr->request_format = backend_syntax;
633 (*assoc->init->bend_fetch)(assoc->backend, rr);
634 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
635 { /* post conversion must take place .. */
636 WRBUF output_record = wrbuf_alloc();
637 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
640 const char *details = yaz_record_conv_get_error(rc);
641 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
643 rr->errstring = odr_strdup(rr->stream, details);
647 rr->len = wrbuf_len(output_record);
648 rr->record = (char *) odr_malloc(rr->stream, rr->len);
649 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
651 wrbuf_destroy(output_record);
654 rr->output_format = match_syntax;
656 rr->schema = odr_strdup(rr->stream, match_schema);
658 (*assoc->init->bend_fetch)(assoc->backend, rr);
663 static int srw_bend_fetch(association *assoc, int pos,
664 Z_SRW_searchRetrieveRequest *srw_req,
665 Z_SRW_record *record,
666 const char **addinfo)
669 ODR o = assoc->encode;
671 rr.setname = "default";
674 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
676 rr.comp = (Z_RecordComposition *)
677 odr_malloc(assoc->decode, sizeof(*rr.comp));
678 rr.comp->which = Z_RecordComp_complex;
679 rr.comp->u.complex = (Z_CompSpec *)
680 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
681 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
682 odr_malloc(assoc->encode, sizeof(bool_t));
683 *rr.comp->u.complex->selectAlternativeSyntax = 0;
684 rr.comp->u.complex->num_dbSpecific = 0;
685 rr.comp->u.complex->dbSpecific = 0;
686 rr.comp->u.complex->num_recordSyntax = 0;
687 rr.comp->u.complex->recordSyntax = 0;
689 rr.comp->u.complex->generic = (Z_Specification *)
690 odr_malloc(assoc->decode, sizeof(Z_Specification));
692 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
693 rr.comp->u.complex->generic->which = Z_Schema_uri;
694 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
696 /* ESN = recordSchema if recordSchema is present */
697 rr.comp->u.complex->generic->elementSpec = 0;
698 if (srw_req->recordSchema)
700 rr.comp->u.complex->generic->elementSpec =
701 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
702 rr.comp->u.complex->generic->elementSpec->which =
703 Z_ElementSpec_elementSetName;
704 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
705 srw_req->recordSchema;
708 rr.stream = assoc->encode;
709 rr.print = assoc->print;
717 rr.surrogate_flag = 0;
718 rr.schema = srw_req->recordSchema;
720 if (!assoc->init->bend_fetch)
723 retrieve_fetch(assoc, &rr);
725 if (rr.errcode && rr.surrogate_flag)
727 int code = yaz_diag_bib1_to_srw(rr.errcode);
728 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
731 else if (rr.len >= 0)
733 record->recordData_buf = rr.record;
734 record->recordData_len = rr.len;
735 record->recordPosition = odr_intdup(o, pos);
736 record->recordSchema = odr_strdup_null(
737 o, rr.schema ? rr.schema : srw_req->recordSchema);
741 *addinfo = rr.errstring;
747 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
748 Z_Query *query_result)
750 /* have a CQL query and CQL to PQF transform .. */
751 CQL_parser cp = cql_parser_create();
757 r = cql_parser_string(cp, cql);
760 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
765 r = cql_transform_buf(ct,
766 cql_parser_result(cp),
767 rpn_buf, sizeof(rpn_buf)-1);
769 srw_errcode = cql_transform_error(ct, &add);
773 /* Syntax & transform OK. */
774 /* Convert PQF string to Z39.50 to RPN query struct */
775 YAZ_PQF_Parser pp = yaz_pqf_create();
776 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
781 int code = yaz_pqf_error(pp, &pqf_msg, &off);
782 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
784 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
788 query_result->which = Z_Query_type_1;
789 query_result->u.type_1 = rpnquery;
793 cql_parser_destroy(cp);
797 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
798 Z_AttributesPlusTerm *result)
802 int srw_error = cql2pqf(odr, cql, ct, &query);
805 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
806 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
807 rpn = query.u.type_1;
808 if (!rpn->RPNStructure)
809 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
810 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
811 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
812 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
813 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
814 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
820 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
821 bend_search_rr *bsrr)
824 struct ccl_rpn_node *node;
827 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
828 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0)
830 bsrr->errstring = (char*) ccl_err_msg(errcode);
831 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
834 bsrr->query->which = Z_Query_type_1;
835 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
839 static int odr_int_to_int(Odr_int v)
843 else if (v <= INT_MIN)
848 static void srw_bend_search(association *assoc, request *req,
853 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
856 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
859 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
860 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
861 if (srw_res->num_diagnostics == 0 && assoc->init)
864 rr.setname = "default";
867 rr.basenames = &srw_req->database;
871 rr.srw_setnameIdleTime = 0;
872 rr.estimated_hit_count = 0;
873 rr.partial_resultset = 0;
874 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
875 rr.query->u.type_1 = 0;
876 rr.extra_args = sr->extra_args;
877 rr.extra_response_data = 0;
879 if (srw_req->query_type == Z_SRW_query_type_cql)
881 if (assoc->server && assoc->server->cql_transform)
883 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
884 assoc->server->cql_transform,
888 yaz_add_srw_diagnostic(assoc->encode,
889 &srw_res->diagnostics,
890 &srw_res->num_diagnostics,
896 /* CQL query to backend. Wrap it - Z39.50 style */
897 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
898 ext->direct_reference = odr_getoidbystr(assoc->decode,
899 "1.2.840.10003.16.2");
900 ext->indirect_reference = 0;
902 ext->which = Z_External_CQL;
903 ext->u.cql = srw_req->query.cql;
905 rr.query->which = Z_Query_type_104;
906 rr.query->u.type_104 = ext;
909 else if (srw_req->query_type == Z_SRW_query_type_pqf)
911 Z_RPNQuery *RPNquery;
912 YAZ_PQF_Parser pqf_parser;
914 pqf_parser = yaz_pqf_create();
916 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
922 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
923 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
924 code, pqf_msg, (long) off);
925 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
928 rr.query->which = Z_Query_type_1;
929 rr.query->u.type_1 = RPNquery;
931 yaz_pqf_destroy(pqf_parser);
935 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
936 &srw_res->num_diagnostics,
937 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
939 if (rr.query->u.type_1)
941 rr.stream = assoc->encode;
942 rr.decode = assoc->decode;
943 rr.print = assoc->print;
944 if ( srw_req->sort.sortKeys )
945 rr.srw_sortKeys = odr_strdup(assoc->encode,
946 srw_req->sort.sortKeys );
947 rr.association = assoc;
952 yaz_log_zquery_level(log_requestdetail,rr.query);
954 (assoc->init->bend_search)(assoc->backend, &rr);
957 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
963 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
964 yaz_add_srw_diagnostic(assoc->encode,
965 &srw_res->diagnostics,
966 &srw_res->num_diagnostics,
967 srw_error, rr.errstring);
972 int number = srw_req->maximumRecords ?
973 odr_int_to_int(*srw_req->maximumRecords) : 0;
974 int start = srw_req->startRecord ?
975 odr_int_to_int(*srw_req->startRecord) : 1;
977 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
979 start, number, rr.hits);
981 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
984 srw_res->resultSetId =
985 odr_strdup(assoc->encode, rr.srw_setname );
986 srw_res->resultSetIdleTime =
987 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
990 if (start > rr.hits || start < 1)
992 /* if hits<=0 and start=1 we don't return a diagnostic */
994 yaz_add_srw_diagnostic(
996 &srw_res->diagnostics, &srw_res->num_diagnostics,
997 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1003 if (start + number > rr.hits)
1004 number = odr_int_to_int(rr.hits) - start + 1;
1006 /* Call bend_present if defined */
1007 if (assoc->init->bend_present)
1009 bend_present_rr *bprr = (bend_present_rr*)
1010 odr_malloc(assoc->decode, sizeof(*bprr));
1011 bprr->setname = "default";
1012 bprr->start = start;
1013 bprr->number = number;
1014 if (srw_req->recordSchema)
1016 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1017 sizeof(*bprr->comp));
1018 bprr->comp->which = Z_RecordComp_simple;
1019 bprr->comp->u.simple = (Z_ElementSetNames *)
1020 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1021 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1022 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1028 bprr->stream = assoc->encode;
1029 bprr->referenceId = 0;
1030 bprr->print = assoc->print;
1031 bprr->association = assoc;
1033 bprr->errstring = NULL;
1034 (*assoc->init->bend_present)(assoc->backend, bprr);
1038 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1039 yaz_add_srw_diagnostic(assoc->encode,
1040 &srw_res->diagnostics,
1041 &srw_res->num_diagnostics,
1042 srw_error, bprr->errstring);
1050 int packing = Z_SRW_recordPacking_string;
1051 if (srw_req->recordPacking)
1054 yaz_srw_str_to_pack(srw_req->recordPacking);
1056 packing = Z_SRW_recordPacking_string;
1058 srw_res->records = (Z_SRW_record *)
1059 odr_malloc(assoc->encode,
1060 number * sizeof(*srw_res->records));
1062 srw_res->extra_records = (Z_SRW_extra_record **)
1063 odr_malloc(assoc->encode,
1064 number*sizeof(*srw_res->extra_records));
1066 for (i = 0; i<number; i++)
1069 const char *addinfo = 0;
1071 srw_res->records[j].recordPacking = packing;
1072 srw_res->records[j].recordData_buf = 0;
1073 srw_res->extra_records[j] = 0;
1074 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1075 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1076 srw_res->records + j,
1080 yaz_add_srw_diagnostic(assoc->encode,
1081 &srw_res->diagnostics,
1082 &srw_res->num_diagnostics,
1083 yaz_diag_bib1_to_srw(errcode),
1088 if (srw_res->records[j].recordData_buf)
1091 srw_res->num_records = j;
1093 srw_res->records = 0;
1096 if (rr.extra_response_data)
1098 res->extraResponseData_buf = rr.extra_response_data;
1099 res->extraResponseData_len = strlen(rr.extra_response_data);
1101 if (rr.estimated_hit_count || rr.partial_resultset)
1103 yaz_add_srw_diagnostic(
1105 &srw_res->diagnostics,
1106 &srw_res->num_diagnostics,
1107 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1115 const char *querystr = "?";
1116 const char *querytype = "?";
1117 WRBUF wr = wrbuf_alloc();
1119 switch (srw_req->query_type)
1121 case Z_SRW_query_type_cql:
1123 querystr = srw_req->query.cql;
1125 case Z_SRW_query_type_pqf:
1127 querystr = srw_req->query.pqf;
1130 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1131 if (srw_res->num_diagnostics)
1132 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1133 else if (*http_code != 200)
1134 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1135 else if (srw_res->numberOfRecords)
1137 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1138 (srw_res->numberOfRecords ?
1139 *srw_res->numberOfRecords : 0));
1141 wrbuf_printf(wr, " %s " ODR_INT_PRINTF " +%d",
1142 (srw_res->resultSetId ?
1143 srw_res->resultSetId : "-"),
1144 (srw_req->startRecord ? *srw_req->startRecord : 1),
1145 srw_res->num_records);
1146 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1151 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1154 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1157 for (ptr = ptr->children; ptr; ptr = ptr->next)
1159 if (ptr->type != XML_ELEMENT_NODE)
1161 if (!strcmp((const char *) ptr->name, "explain"))
1164 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1168 ptr = xmlCopyNode(ptr, 1);
1170 xmlDocSetRootElement(doc, ptr);
1172 xmlDocDumpMemory(doc, &buf_out, &len);
1173 content = (char*) odr_malloc(rr->stream, 1+len);
1174 memcpy(content, buf_out, len);
1175 content[len] = '\0';
1179 rr->explain_buf = content;
1187 static void srw_bend_explain(association *assoc, request *req,
1189 Z_SRW_explainResponse *srw_res,
1192 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1193 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1195 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1200 rr.stream = assoc->encode;
1201 rr.decode = assoc->decode;
1202 rr.print = assoc->print;
1204 rr.database = srw_req->database;
1206 rr.server_node_ptr = assoc->server->server_node_ptr;
1208 rr.server_node_ptr = 0;
1209 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1210 if (assoc->init->bend_explain)
1211 (*assoc->init->bend_explain)(assoc->backend, &rr);
1213 srw_bend_explain_default(assoc->backend, &rr);
1217 int packing = Z_SRW_recordPacking_string;
1218 if (srw_req->recordPacking)
1221 yaz_srw_str_to_pack(srw_req->recordPacking);
1223 packing = Z_SRW_recordPacking_string;
1225 srw_res->record.recordSchema = rr.schema;
1226 srw_res->record.recordPacking = packing;
1227 srw_res->record.recordData_buf = rr.explain_buf;
1228 srw_res->record.recordData_len = strlen(rr.explain_buf);
1229 srw_res->record.recordPosition = 0;
1235 static void srw_bend_scan(association *assoc, request *req,
1237 Z_SRW_scanResponse *srw_res,
1240 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1241 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1244 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1245 if (srw_res->num_diagnostics == 0 && assoc->init)
1248 struct scan_entry *save_entries;
1250 bend_scan_rr *bsrr = (bend_scan_rr *)
1251 odr_malloc(assoc->encode, sizeof(*bsrr));
1252 bsrr->num_bases = 1;
1253 bsrr->basenames = &srw_req->database;
1255 bsrr->num_entries = srw_req->maximumTerms ?
1256 odr_int_to_int(*srw_req->maximumTerms) : 10;
1257 bsrr->term_position = srw_req->responsePosition ?
1258 odr_int_to_int(*srw_req->responsePosition) : 1;
1261 bsrr->errstring = 0;
1262 bsrr->referenceId = 0;
1263 bsrr->stream = assoc->encode;
1264 bsrr->print = assoc->print;
1265 bsrr->step_size = &step_size;
1269 if (bsrr->num_entries > 0)
1272 bsrr->entries = (struct scan_entry *)
1273 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1275 for (i = 0; i<bsrr->num_entries; i++)
1277 bsrr->entries[i].term = 0;
1278 bsrr->entries[i].occurrences = 0;
1279 bsrr->entries[i].errcode = 0;
1280 bsrr->entries[i].errstring = 0;
1281 bsrr->entries[i].display_term = 0;
1284 save_entries = bsrr->entries; /* save it so we can compare later */
1286 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1287 assoc->init->bend_scan)
1289 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1291 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1292 &bsrr->attributeset,
1293 srw_req->scanClause.pqf);
1294 yaz_pqf_destroy(pqf_parser);
1295 bsrr->scanClause = 0;
1296 ((int (*)(void *, bend_scan_rr *))
1297 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1299 else if (srw_req->query_type == Z_SRW_query_type_cql
1300 && assoc->init->bend_scan && assoc->server
1301 && assoc->server->cql_transform)
1304 bsrr->scanClause = 0;
1305 bsrr->attributeset = 0;
1306 bsrr->term = (Z_AttributesPlusTerm *)
1307 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1308 srw_error = cql2pqf_scan(assoc->encode,
1309 srw_req->scanClause.cql,
1310 assoc->server->cql_transform,
1313 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1314 &srw_res->num_diagnostics,
1318 ((int (*)(void *, bend_scan_rr *))
1319 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1322 else if (srw_req->query_type == Z_SRW_query_type_cql
1323 && assoc->init->bend_srw_scan)
1326 bsrr->attributeset = 0;
1327 bsrr->scanClause = srw_req->scanClause.cql;
1328 ((int (*)(void *, bend_scan_rr *))
1329 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1333 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1334 &srw_res->num_diagnostics,
1335 YAZ_SRW_UNSUPP_OPERATION, "scan");
1340 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1345 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1347 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1348 &srw_res->num_diagnostics,
1349 srw_error, bsrr->errstring);
1351 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1354 srw_res->terms = (Z_SRW_scanTerm*)
1355 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1358 srw_res->num_terms = bsrr->num_entries;
1359 for (i = 0; i<bsrr->num_entries; i++)
1361 Z_SRW_scanTerm *t = srw_res->terms + i;
1362 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1363 t->numberOfRecords =
1364 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1366 if (save_entries == bsrr->entries &&
1367 bsrr->entries[i].display_term)
1369 /* the entries was _not_ set by the handler. So it's
1370 safe to test for new member display_term. It is
1373 t->displayTerm = odr_strdup(assoc->encode,
1374 bsrr->entries[i].display_term);
1382 WRBUF wr = wrbuf_alloc();
1383 const char *querytype = 0;
1384 const char *querystr = 0;
1386 switch(srw_req->query_type)
1388 case Z_SRW_query_type_pqf:
1390 querystr = srw_req->scanClause.pqf;
1392 case Z_SRW_query_type_cql:
1394 querystr = srw_req->scanClause.cql;
1397 querytype = "UNKNOWN";
1401 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1403 if (srw_res->num_diagnostics)
1404 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1405 else if (srw_res->num_terms)
1406 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1408 wrbuf_printf(wr, "OK - - ");
1410 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1411 (srw_req->responsePosition ?
1412 *srw_req->responsePosition : 1),
1413 (srw_req->maximumTerms ?
1414 *srw_req->maximumTerms : 1));
1415 /* there is no step size in SRU/W ??? */
1416 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1417 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1423 static void srw_bend_update(association *assoc, request *req,
1425 Z_SRW_updateResponse *srw_res,
1428 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1429 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1430 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1432 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1436 Z_SRW_extra_record *extra = srw_req->extra_record;
1438 rr.stream = assoc->encode;
1439 rr.print = assoc->print;
1441 rr.basenames = &srw_req->database;
1442 rr.operation = srw_req->operation;
1443 rr.operation_status = "failed";
1445 rr.record_versions = 0;
1446 rr.num_versions = 0;
1447 rr.record_packing = "string";
1448 rr.record_schema = 0;
1450 rr.extra_record_data = 0;
1451 rr.extra_request_data = 0;
1452 rr.extra_response_data = 0;
1458 if (rr.operation == 0)
1460 yaz_add_sru_update_diagnostic(
1461 assoc->encode, &srw_res->diagnostics,
1462 &srw_res->num_diagnostics,
1463 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1467 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1468 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1469 if (!strcmp( rr.operation, "delete"))
1471 if (srw_req->record && !srw_req->record->recordSchema)
1473 rr.record_schema = odr_strdup(
1475 srw_req->record->recordSchema);
1477 if (srw_req->record)
1479 rr.record_data = odr_strdupn(
1481 srw_req->record->recordData_buf,
1482 srw_req->record->recordData_len );
1484 if (extra && extra->extraRecordData_len)
1486 rr.extra_record_data = odr_strdupn(
1488 extra->extraRecordData_buf,
1489 extra->extraRecordData_len );
1491 if (srw_req->recordId)
1492 rr.record_id = srw_req->recordId;
1493 else if (extra && extra->recordIdentifier)
1494 rr.record_id = extra->recordIdentifier;
1496 else if (!strcmp(rr.operation, "replace"))
1498 if (srw_req->recordId)
1499 rr.record_id = srw_req->recordId;
1500 else if (extra && extra->recordIdentifier)
1501 rr.record_id = extra->recordIdentifier;
1504 yaz_add_sru_update_diagnostic(
1505 assoc->encode, &srw_res->diagnostics,
1506 &srw_res->num_diagnostics,
1507 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1508 "recordIdentifier");
1510 if (!srw_req->record)
1512 yaz_add_sru_update_diagnostic(
1513 assoc->encode, &srw_res->diagnostics,
1514 &srw_res->num_diagnostics,
1515 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1520 if (srw_req->record->recordSchema)
1521 rr.record_schema = odr_strdup(
1522 assoc->encode, srw_req->record->recordSchema);
1523 if (srw_req->record->recordData_len )
1525 rr.record_data = odr_strdupn(assoc->encode,
1526 srw_req->record->recordData_buf,
1527 srw_req->record->recordData_len );
1531 yaz_add_sru_update_diagnostic(
1532 assoc->encode, &srw_res->diagnostics,
1533 &srw_res->num_diagnostics,
1534 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1538 if (extra && extra->extraRecordData_len)
1540 rr.extra_record_data = odr_strdupn(
1542 extra->extraRecordData_buf,
1543 extra->extraRecordData_len );
1546 else if (!strcmp(rr.operation, "insert"))
1548 if (srw_req->recordId)
1549 rr.record_id = srw_req->recordId;
1551 rr.record_id = extra->recordIdentifier;
1553 if (srw_req->record)
1555 if (srw_req->record->recordSchema)
1556 rr.record_schema = odr_strdup(
1557 assoc->encode, srw_req->record->recordSchema);
1559 if (srw_req->record->recordData_len)
1560 rr.record_data = odr_strdupn(
1562 srw_req->record->recordData_buf,
1563 srw_req->record->recordData_len );
1565 if (extra && extra->extraRecordData_len)
1567 rr.extra_record_data = odr_strdupn(
1569 extra->extraRecordData_buf,
1570 extra->extraRecordData_len );
1574 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1575 &srw_res->num_diagnostics,
1576 YAZ_SRU_UPDATE_INVALID_ACTION,
1579 if (srw_req->record)
1581 const char *pack_str =
1582 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1584 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1587 if (srw_req->num_recordVersions)
1589 rr.record_versions = srw_req->recordVersions;
1590 rr.num_versions = srw_req->num_recordVersions;
1592 if (srw_req->extraRequestData_len)
1594 rr.extra_request_data = odr_strdupn(assoc->encode,
1595 srw_req->extraRequestData_buf,
1596 srw_req->extraRequestData_len );
1598 if (srw_res->num_diagnostics == 0)
1600 if ( assoc->init->bend_srw_update)
1601 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1603 yaz_add_sru_update_diagnostic(
1604 assoc->encode, &srw_res->diagnostics,
1605 &srw_res->num_diagnostics,
1606 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1607 "No Update backend handler");
1611 yaz_add_srw_diagnostic_uri(assoc->encode,
1612 &srw_res->diagnostics,
1613 &srw_res->num_diagnostics,
1617 srw_res->recordId = rr.record_id;
1618 srw_res->operationStatus = rr.operation_status;
1619 srw_res->recordVersions = rr.record_versions;
1620 srw_res->num_recordVersions = rr.num_versions;
1621 if (srw_res->extraResponseData_len)
1623 srw_res->extraResponseData_buf = rr.extra_response_data;
1624 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1626 if (srw_res->num_diagnostics == 0 && rr.record_data)
1628 srw_res->record = yaz_srw_get_record(assoc->encode);
1629 srw_res->record->recordSchema = rr.record_schema;
1630 if (rr.record_packing)
1632 int pack = yaz_srw_str_to_pack(rr.record_packing);
1636 pack = Z_SRW_recordPacking_string;
1637 yaz_log(YLOG_WARN, "Back packing %s from backend",
1640 srw_res->record->recordPacking = pack;
1642 srw_res->record->recordData_buf = rr.record_data;
1643 srw_res->record->recordData_len = strlen(rr.record_data);
1644 if (rr.extra_record_data)
1646 Z_SRW_extra_record *ex =
1647 yaz_srw_get_extra_record(assoc->encode);
1648 srw_res->extra_record = ex;
1649 ex->extraRecordData_buf = rr.extra_record_data;
1650 ex->extraRecordData_len = strlen(rr.extra_record_data);
1656 /* check if path is OK (1); BAD (0) */
1657 static int check_path(const char *path)
1661 if (strstr(path, ".."))
1666 static char *read_file(const char *fname, ODR o, size_t *sz)
1669 FILE *inf = fopen(fname, "rb");
1673 fseek(inf, 0L, SEEK_END);
1676 buf = (char *) odr_malloc(o, *sz);
1677 if (fread(buf, 1, *sz, inf) != *sz)
1678 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1683 static void process_http_request(association *assoc, request *req)
1685 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1686 ODR o = assoc->encode;
1687 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1689 Z_SOAP *soap_package = 0;
1692 Z_HTTP_Response *hres = 0;
1694 const char *stylesheet = 0; /* for now .. set later */
1695 Z_SRW_diagnostic *diagnostic = 0;
1696 int num_diagnostic = 0;
1697 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1699 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1700 if (!control_association(assoc, host, 0))
1702 p = z_get_HTTP_Response(o, 404);
1705 if (r == 2 && assoc->server && assoc->server->docpath
1706 && hreq->path[0] == '/'
1708 /* check if path is a proper prefix of documentroot */
1709 strncmp(hreq->path+1, assoc->server->docpath,
1710 strlen(assoc->server->docpath))
1713 if (!check_path(hreq->path))
1715 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1716 p = z_get_HTTP_Response(o, 404);
1720 size_t content_size = 0;
1721 char *content_buf = read_file(hreq->path+1, o, &content_size);
1724 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1725 p = z_get_HTTP_Response(o, 404);
1729 const char *ctype = 0;
1730 yaz_mime_types types = yaz_mime_types_create();
1732 yaz_mime_types_add(types, "xsl", "application/xml");
1733 yaz_mime_types_add(types, "xml", "application/xml");
1734 yaz_mime_types_add(types, "css", "text/css");
1735 yaz_mime_types_add(types, "html", "text/html");
1736 yaz_mime_types_add(types, "htm", "text/html");
1737 yaz_mime_types_add(types, "txt", "text/plain");
1738 yaz_mime_types_add(types, "js", "application/x-javascript");
1740 yaz_mime_types_add(types, "gif", "image/gif");
1741 yaz_mime_types_add(types, "png", "image/png");
1742 yaz_mime_types_add(types, "jpg", "image/jpeg");
1743 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1745 ctype = yaz_mime_lookup_fname(types, hreq->path);
1748 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1749 p = z_get_HTTP_Response(o, 404);
1753 p = z_get_HTTP_Response(o, 200);
1754 hres = p->u.HTTP_Response;
1755 hres->content_buf = content_buf;
1756 hres->content_len = content_size;
1757 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1759 yaz_mime_types_destroy(types);
1767 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1768 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1770 if (r == 2) /* not taken */
1772 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1773 &diagnostic, &num_diagnostic);
1774 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1776 if (r == 0) /* decode SRW/SRU OK .. */
1778 int http_code = 200;
1779 if (sr->which == Z_SRW_searchRetrieve_request)
1782 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1784 stylesheet = sr->u.request->stylesheet;
1787 res->u.response->diagnostics = diagnostic;
1788 res->u.response->num_diagnostics = num_diagnostic;
1792 srw_bend_search(assoc, req, sr, res, &http_code);
1794 if (http_code == 200)
1795 soap_package->u.generic->p = res;
1797 else if (sr->which == Z_SRW_explain_request)
1799 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1801 stylesheet = sr->u.explain_request->stylesheet;
1804 res->u.explain_response->diagnostics = diagnostic;
1805 res->u.explain_response->num_diagnostics = num_diagnostic;
1807 srw_bend_explain(assoc, req, sr,
1808 res->u.explain_response, &http_code);
1809 if (http_code == 200)
1810 soap_package->u.generic->p = res;
1812 else if (sr->which == Z_SRW_scan_request)
1814 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1816 stylesheet = sr->u.scan_request->stylesheet;
1819 res->u.scan_response->diagnostics = diagnostic;
1820 res->u.scan_response->num_diagnostics = num_diagnostic;
1822 srw_bend_scan(assoc, req, sr,
1823 res->u.scan_response, &http_code);
1824 if (http_code == 200)
1825 soap_package->u.generic->p = res;
1827 else if (sr->which == Z_SRW_update_request)
1829 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1831 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1834 res->u.update_response->diagnostics = diagnostic;
1835 res->u.update_response->num_diagnostics = num_diagnostic;
1837 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1838 srw_bend_update(assoc, req, sr,
1839 res->u.update_response, &http_code);
1840 if (http_code == 200)
1841 soap_package->u.generic->p = res;
1845 yaz_log(log_request, "SOAP ERROR");
1846 /* FIXME - what error, what query */
1848 z_soap_error(assoc->encode, soap_package,
1849 "SOAP-ENV:Client", "Bad method", 0);
1851 if (http_code == 200 || http_code == 500)
1853 static Z_SOAP_Handler soap_handlers[4] = {
1855 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1856 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1857 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1863 p = z_get_HTTP_Response(o, 200);
1864 hres = p->u.HTTP_Response;
1866 if (!stylesheet && assoc->server)
1867 stylesheet = assoc->server->stylesheet;
1869 /* empty stylesheet means NO stylesheet */
1870 if (stylesheet && *stylesheet == '\0')
1873 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1874 &hres->content_buf, &hres->content_len,
1875 soap_handlers, charset, stylesheet);
1876 hres->code = http_code;
1878 strcpy(ctype, "text/xml");
1879 if (charset && strlen(charset) < sizeof(ctype)-30)
1881 strcat(ctype, "; charset=");
1882 strcat(ctype, charset);
1884 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1887 p = z_get_HTTP_Response(o, http_code);
1891 p = z_get_HTTP_Response(o, 500);
1892 hres = p->u.HTTP_Response;
1893 if (!strcmp(hreq->version, "1.0"))
1895 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1896 if (v && !strcmp(v, "Keep-Alive"))
1900 hres->version = "1.0";
1904 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1905 if (v && !strcmp(v, "close"))
1909 hres->version = "1.1";
1913 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1914 assoc->state = ASSOC_DEAD;
1915 assoc->cs_get_mask = 0;
1920 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1922 if (alive && isdigit(*(const unsigned char *) alive))
1926 if (t < 0 || t > 3600)
1928 iochan_settimeout(assoc->client_chan,t);
1929 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1931 process_gdu_response(assoc, req, p);
1934 static void process_gdu_request(association *assoc, request *req)
1936 if (req->gdu_request->which == Z_GDU_Z3950)
1939 req->apdu_request = req->gdu_request->u.z3950;
1940 if (process_z_request(assoc, req, &msg) < 0)
1941 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1943 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1944 process_http_request(assoc, req);
1947 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1952 * Initiate request processing.
1954 static int process_z_request(association *assoc, request *req, char **msg)
1959 *msg = "Unknown Error";
1960 assert(req && req->state == REQUEST_IDLE);
1961 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1963 *msg = "Missing InitRequest";
1966 switch (req->apdu_request->which)
1968 case Z_APDU_initRequest:
1969 res = process_initRequest(assoc, req); break;
1970 case Z_APDU_searchRequest:
1971 res = process_searchRequest(assoc, req); break;
1972 case Z_APDU_presentRequest:
1973 res = process_presentRequest(assoc, req); break;
1974 case Z_APDU_scanRequest:
1975 if (assoc->init->bend_scan)
1976 res = process_scanRequest(assoc, req);
1979 *msg = "Cannot handle Scan APDU";
1983 case Z_APDU_extendedServicesRequest:
1984 if (assoc->init->bend_esrequest)
1985 res = process_ESRequest(assoc, req);
1988 *msg = "Cannot handle Extended Services APDU";
1992 case Z_APDU_sortRequest:
1993 if (assoc->init->bend_sort)
1994 res = process_sortRequest(assoc, req);
1997 *msg = "Cannot handle Sort APDU";
2002 process_close(assoc, req);
2004 case Z_APDU_deleteResultSetRequest:
2005 if (assoc->init->bend_delete)
2006 res = process_deleteRequest(assoc, req);
2009 *msg = "Cannot handle Delete APDU";
2013 case Z_APDU_segmentRequest:
2014 if (assoc->init->bend_segment)
2016 res = process_segmentRequest(assoc, req);
2020 *msg = "Cannot handle Segment APDU";
2024 case Z_APDU_triggerResourceControlRequest:
2027 *msg = "Bad APDU received";
2032 yaz_log(YLOG_DEBUG, " result immediately available");
2033 retval = process_z_response(assoc, req, res);
2037 yaz_log(YLOG_DEBUG, " result unavailble");
2044 * Encode response, and transfer the request structure to the outgoing queue.
2046 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2048 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2052 if (!z_GDU(assoc->print, &res, 0, 0))
2053 yaz_log(YLOG_WARN, "ODR print error: %s",
2054 odr_errmsg(odr_geterror(assoc->print)));
2055 odr_reset(assoc->print);
2057 if (!z_GDU(assoc->encode, &res, 0, 0))
2059 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2060 odr_errmsg(odr_geterror(assoc->decode)),
2061 odr_getelement(assoc->decode));
2064 req->response = odr_getbuf(assoc->encode, &req->len_response,
2065 &req->size_response);
2066 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2067 odr_reset(assoc->encode);
2068 req->state = REQUEST_IDLE;
2069 request_enq(&assoc->outgoing, req);
2070 /* turn the work over to the ir_session handler */
2071 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2072 assoc->cs_put_mask = EVENT_OUTPUT;
2073 /* Is there more work to be done? give that to the input handler too */
2076 req = request_head(&assoc->incoming);
2077 if (req && req->state == REQUEST_IDLE)
2079 request_deq(&assoc->incoming);
2080 process_gdu_request(assoc, req);
2089 * Encode response, and transfer the request structure to the outgoing queue.
2091 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2093 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2094 gres->which = Z_GDU_Z3950;
2095 gres->u.z3950 = res;
2097 return process_gdu_response(assoc, req, gres);
2100 static char *get_vhost(Z_OtherInformation *otherInfo)
2102 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2106 * Handle init request.
2107 * At the moment, we don't check the options
2108 * anywhere else in the code - we just try not to do anything that would
2109 * break a naive client. We'll toss 'em into the association block when
2110 * we need them there.
2112 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2114 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2115 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2116 Z_InitResponse *resp = apdu->u.initResponse;
2117 bend_initresult *binitres;
2119 statserv_options_block *cb = 0; /* by default no control for backend */
2121 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2122 cb = statserv_getcontrol(); /* got control block for backend */
2124 if (cb && assoc->backend)
2125 (*cb->bend_close)(assoc->backend);
2127 yaz_log(log_requestdetail, "Got initRequest");
2128 if (req->implementationId)
2129 yaz_log(log_requestdetail, "Id: %s",
2130 req->implementationId);
2131 if (req->implementationName)
2132 yaz_log(log_requestdetail, "Name: %s",
2133 req->implementationName);
2134 if (req->implementationVersion)
2135 yaz_log(log_requestdetail, "Version: %s",
2136 req->implementationVersion);
2138 assoc_init_reset(assoc);
2140 assoc->init->auth = req->idAuthentication;
2141 assoc->init->referenceId = req->referenceId;
2143 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2145 Z_CharSetandLanguageNegotiation *negotiation =
2146 yaz_get_charneg_record (req->otherInfo);
2148 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2149 assoc->init->charneg_request = negotiation;
2152 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2153 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2154 assoc->init->named_result_sets = 1;
2159 if (req->implementationVersion)
2160 yaz_log(log_requestdetail, "Config: %s",
2163 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2165 /* we have a backend control block, so call that init function */
2166 if (!(binitres = (*cb->bend_init)(assoc->init)))
2168 yaz_log(YLOG_WARN, "Bad response from backend.");
2171 assoc->backend = binitres->handle;
2175 /* no backend. return error */
2176 binitres = (bend_initresult *)
2177 odr_malloc(assoc->encode, sizeof(*binitres));
2178 binitres->errstring = 0;
2179 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2180 iochan_settimeout(assoc->client_chan, 10);
2182 if ((assoc->init->bend_sort))
2183 yaz_log(YLOG_DEBUG, "Sort handler installed");
2184 if ((assoc->init->bend_search))
2185 yaz_log(YLOG_DEBUG, "Search handler installed");
2186 if ((assoc->init->bend_present))
2187 yaz_log(YLOG_DEBUG, "Present handler installed");
2188 if ((assoc->init->bend_esrequest))
2189 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2190 if ((assoc->init->bend_delete))
2191 yaz_log(YLOG_DEBUG, "Delete handler installed");
2192 if ((assoc->init->bend_scan))
2193 yaz_log(YLOG_DEBUG, "Scan handler installed");
2194 if ((assoc->init->bend_segment))
2195 yaz_log(YLOG_DEBUG, "Segment handler installed");
2197 resp->referenceId = req->referenceId;
2199 /* let's tell the client what we can do */
2200 if (ODR_MASK_GET(req->options, Z_Options_search))
2202 ODR_MASK_SET(resp->options, Z_Options_search);
2203 strcat(options, "srch");
2205 if (ODR_MASK_GET(req->options, Z_Options_present))
2207 ODR_MASK_SET(resp->options, Z_Options_present);
2208 strcat(options, " prst");
2210 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2211 assoc->init->bend_delete)
2213 ODR_MASK_SET(resp->options, Z_Options_delSet);
2214 strcat(options, " del");
2216 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2217 assoc->init->bend_esrequest)
2219 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2220 strcat(options, " extendedServices");
2222 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2223 && assoc->init->named_result_sets)
2225 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2226 strcat(options, " namedresults");
2228 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2230 ODR_MASK_SET(resp->options, Z_Options_scan);
2231 strcat(options, " scan");
2233 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2235 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2236 strcat(options, " concurrop");
2238 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2240 ODR_MASK_SET(resp->options, Z_Options_sort);
2241 strcat(options, " sort");
2244 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2246 Z_OtherInformationUnit *p0;
2248 if (!assoc->init->charneg_response)
2250 if (assoc->init->query_charset)
2252 assoc->init->charneg_response = yaz_set_response_charneg(
2253 assoc->encode, assoc->init->query_charset, 0,
2254 assoc->init->records_in_same_charset);
2258 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2261 if (assoc->init->charneg_response
2262 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2264 p0->which = Z_OtherInfo_externallyDefinedInfo;
2265 p0->information.externallyDefinedInfo =
2266 assoc->init->charneg_response;
2267 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2268 strcat(options, " negotiation");
2271 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2272 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2274 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2276 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2277 assoc->version = 1; /* 1 & 2 are equivalent */
2279 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2281 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2284 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2286 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2290 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2292 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2293 assoc->maximumRecordSize = *req->maximumRecordSize;
2295 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2296 assoc->preferredMessageSize = *req->preferredMessageSize;
2298 resp->preferredMessageSize =
2299 odr_intdup(assoc->encode, assoc->preferredMessageSize);
2300 resp->maximumRecordSize =
2301 odr_intdup(assoc->encode, assoc->maximumRecordSize);
2303 resp->implementationId = odr_prepend(assoc->encode,
2304 assoc->init->implementation_id,
2305 resp->implementationId);
2307 resp->implementationName = odr_prepend(assoc->encode,
2308 assoc->init->implementation_name,
2309 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2311 if (binitres->errcode)
2313 assoc->state = ASSOC_DEAD;
2314 resp->userInformationField =
2315 init_diagnostics(assoc->encode, binitres->errcode,
2316 binitres->errstring);
2320 assoc->state = ASSOC_UP;
2324 if (!req->idAuthentication)
2325 yaz_log(log_request, "Auth none");
2326 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2328 const char *open = req->idAuthentication->u.open;
2329 const char *slash = strchr(open, '/');
2335 yaz_log(log_request, "Auth open %.*s", len, open);
2337 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2339 const char *user = req->idAuthentication->u.idPass->userId;
2340 const char *group = req->idAuthentication->u.idPass->groupId;
2341 yaz_log(log_request, "Auth idPass %s %s",
2342 user ? user : "-", group ? group : "-");
2344 else if (req->idAuthentication->which
2345 == Z_IdAuthentication_anonymous)
2347 yaz_log(log_request, "Auth anonymous");
2351 yaz_log(log_request, "Auth other");
2356 WRBUF wr = wrbuf_alloc();
2357 wrbuf_printf(wr, "Init ");
2358 if (binitres->errcode)
2359 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2361 wrbuf_printf(wr, "OK -");
2362 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2363 (req->implementationId ? req->implementationId :"-"),
2364 (req->implementationName ?
2365 req->implementationName : "-"),
2366 (req->implementationVersion ?
2367 req->implementationVersion : "-")
2369 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2376 * Set the specified `errcode' and `errstring' into a UserInfo-1
2377 * external to be returned to the client in accordance with Z35.90
2378 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2379 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2381 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2383 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2384 addinfo ? " -- " : "", addinfo ? addinfo : "");
2385 return zget_init_diagnostics(odr, error, addinfo);
2389 * nonsurrogate diagnostic record.
2391 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2393 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2395 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2396 addinfo ? " -- " : "", addinfo ? addinfo : "");
2398 rec->which = Z_Records_NSD;
2399 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2405 * surrogate diagnostic.
2407 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2409 int error, const char *addinfo)
2411 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2412 addinfo ? " -- " : "", addinfo ? addinfo : "");
2413 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2416 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2417 Odr_int *num, Z_RecordComposition *comp,
2418 Odr_int *next, Odr_int *pres,
2419 Z_ReferenceId *referenceId,
2420 Odr_oid *oid, int *errcode)
2422 int recno, total_length = 0, dumped_records = 0;
2423 int toget = odr_int_to_int(*num);
2424 Z_Records *records =
2425 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2426 Z_NamePlusRecordList *reclist =
2427 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2428 Z_NamePlusRecord **list =
2429 (Z_NamePlusRecord **) odr_malloc(a->encode, sizeof(*list) * toget);
2431 records->which = Z_Records_DBOSD;
2432 records->u.databaseOrSurDiagnostics = reclist;
2433 reclist->num_records = 0;
2434 reclist->records = list;
2435 *pres = Z_PresentStatus_success;
2439 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2440 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2441 a->maximumRecordSize);
2442 for (recno = odr_int_to_int(start); reclist->num_records < toget; recno++)
2445 Z_NamePlusRecord *thisrec;
2446 int this_length = 0;
2448 * we get the number of bytes allocated on the stream before any
2449 * allocation done by the backend - this should give us a reasonable
2450 * idea of the total size of the data so far.
2452 total_length = odr_total(a->encode) - dumped_records;
2458 freq.last_in_set = 0;
2459 freq.setname = setname;
2460 freq.surrogate_flag = 0;
2461 freq.number = recno;
2463 freq.request_format = oid;
2464 freq.output_format = 0;
2465 freq.stream = a->encode;
2466 freq.print = a->print;
2467 freq.referenceId = referenceId;
2470 retrieve_fetch(a, &freq);
2472 *next = freq.last_in_set ? 0 : recno + 1;
2476 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2479 *pres = Z_PresentStatus_failure;
2480 /* for 'present request out of range',
2481 set addinfo to record position if not set */
2482 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2483 freq.errstring == 0)
2485 sprintf(s, "%d", recno);
2489 *errcode = freq.errcode;
2490 return diagrec(a, freq.errcode, freq.errstring);
2492 reclist->records[reclist->num_records] =
2493 surrogatediagrec(a, freq.basename, freq.errcode,
2495 reclist->num_records++;
2498 if (freq.record == 0) /* no error and no record ? */
2500 *next = 0; /* signal end-of-set and stop */
2504 this_length = freq.len;
2506 this_length = odr_total(a->encode) - total_length - dumped_records;
2507 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2508 this_length, total_length, dumped_records);
2509 if (a->preferredMessageSize > 0 &&
2510 this_length + total_length > a->preferredMessageSize)
2512 /* record is small enough, really */
2513 if (this_length <= a->preferredMessageSize && recno > start)
2515 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2516 *pres = Z_PresentStatus_partial_2;
2519 /* record can only be fetched by itself */
2520 if (this_length < a->maximumRecordSize)
2522 yaz_log(log_requestdetail, " Record > prefmsgsz");
2525 yaz_log(YLOG_DEBUG, " Dropped it");
2526 reclist->records[reclist->num_records] =
2527 surrogatediagrec(a, freq.basename, 16, 0);
2528 reclist->num_records++;
2529 dumped_records += this_length;
2533 else /* too big entirely */
2535 yaz_log(log_requestdetail, "Record > maxrcdsz "
2537 this_length, a->maximumRecordSize);
2538 reclist->records[reclist->num_records] =
2539 surrogatediagrec(a, freq.basename, 17, 0);
2540 reclist->num_records++;
2541 dumped_records += this_length;
2546 if (!(thisrec = (Z_NamePlusRecord *)
2547 odr_malloc(a->encode, sizeof(*thisrec))))
2549 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2550 thisrec->which = Z_NamePlusRecord_databaseRecord;
2552 if (!freq.output_format)
2553 freq.output_format = freq.request_format;
2554 thisrec->u.databaseRecord = z_ext_record_oid(
2555 a->encode, freq.output_format, freq.record, freq.len);
2556 if (!thisrec->u.databaseRecord)
2558 reclist->records[reclist->num_records] = thisrec;
2559 reclist->num_records++;
2561 *num = reclist->num_records;
2565 static Z_APDU *process_searchRequest(association *assoc, request *reqb)
2567 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2568 bend_search_rr *bsrr =
2569 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2571 yaz_log(log_requestdetail, "Got SearchRequest.");
2572 bsrr->association = assoc;
2573 bsrr->referenceId = req->referenceId;
2574 bsrr->srw_sortKeys = 0;
2575 bsrr->srw_setname = 0;
2576 bsrr->srw_setnameIdleTime = 0;
2577 bsrr->estimated_hit_count = 0;
2578 bsrr->partial_resultset = 0;
2579 bsrr->extra_args = 0;
2580 bsrr->extra_response_data = 0;
2582 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2583 if (req->databaseNames)
2586 for (i = 0; i < req->num_databaseNames; i++)
2587 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2590 yaz_log_zquery_level(log_requestdetail,req->query);
2592 if (assoc->init->bend_search)
2594 bsrr->setname = req->resultSetName;
2595 bsrr->replace_set = *req->replaceIndicator;
2596 bsrr->num_bases = req->num_databaseNames;
2597 bsrr->basenames = req->databaseNames;
2598 bsrr->query = req->query;
2599 bsrr->stream = assoc->encode;
2600 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2601 bsrr->decode = assoc->decode;
2602 bsrr->print = assoc->print;
2605 bsrr->errstring = NULL;
2606 bsrr->search_info = NULL;
2608 if (assoc->server && assoc->server->cql_transform
2609 && req->query->which == Z_Query_type_104
2610 && req->query->u.type_104->which == Z_External_CQL)
2612 /* have a CQL query and a CQL to PQF transform .. */
2614 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2615 assoc->server->cql_transform, bsrr->query);
2617 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2620 if (assoc->server && assoc->server->ccl_transform
2621 && req->query->which == Z_Query_type_2) /*CCL*/
2623 /* have a CCL query and a CCL to PQF transform .. */
2625 ccl2pqf(bsrr->stream, req->query->u.type_2,
2626 assoc->server->ccl_transform, bsrr);
2628 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2632 (assoc->init->bend_search)(assoc->backend, bsrr);
2636 /* FIXME - make a diagnostic for it */
2637 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2639 return response_searchRequest(assoc, reqb, bsrr);
2643 * Prepare a searchresponse based on the backend results. We probably want
2644 * to look at making the fetching of records nonblocking as well, but
2645 * so far, we'll keep things simple.
2646 * If bsrt is null, that means we're called in response to a communications
2647 * event, and we'll have to get the response for ourselves.
2649 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2650 bend_search_rr *bsrt)
2652 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2653 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2654 Z_SearchResponse *resp = (Z_SearchResponse *)
2655 odr_malloc(assoc->encode, sizeof(*resp));
2656 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2657 Odr_int *next = odr_intdup(assoc->encode, 0);
2658 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2659 Odr_int returnedrecs = 0;
2661 apdu->which = Z_APDU_searchResponse;
2662 apdu->u.searchResponse = resp;
2663 resp->referenceId = req->referenceId;
2664 resp->additionalSearchInfo = 0;
2665 resp->otherInfo = 0;
2668 yaz_log(YLOG_FATAL, "Bad result from backend");
2671 else if (bsrt->errcode)
2673 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2674 resp->resultCount = nulint;
2675 resp->numberOfRecordsReturned = nulint;
2676 resp->nextResultSetPosition = nulint;
2677 resp->searchStatus = odr_booldup(assoc->encode, 0);
2678 resp->resultSetStatus = none;
2679 resp->presentStatus = 0;
2683 bool_t *sr = odr_booldup(assoc->encode, 1);
2684 Odr_int *toget = odr_intdup(assoc->encode, 0);
2685 Z_RecordComposition comp, *compp = 0;
2687 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2690 resp->resultCount = &bsrt->hits;
2692 comp.which = Z_RecordComp_simple;
2693 /* how many records does the user agent want, then? */
2696 else if (bsrt->hits <= *req->smallSetUpperBound)
2698 *toget = bsrt->hits;
2699 if ((comp.u.simple = req->smallSetElementSetNames))
2702 else if (bsrt->hits < *req->largeSetLowerBound)
2704 *toget = *req->mediumSetPresentNumber;
2705 if (*toget > bsrt->hits)
2706 *toget = bsrt->hits;
2707 if ((comp.u.simple = req->mediumSetElementSetNames))
2713 if (*toget && !resp->records)
2715 Odr_int *presst = odr_intdup(assoc->encode, 0);
2716 /* Call bend_present if defined */
2717 if (assoc->init->bend_present)
2719 bend_present_rr *bprr = (bend_present_rr *)
2720 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2721 bprr->setname = req->resultSetName;
2723 bprr->number = odr_int_to_int(*toget);
2724 bprr->format = req->preferredRecordSyntax;
2726 bprr->referenceId = req->referenceId;
2727 bprr->stream = assoc->encode;
2728 bprr->print = assoc->print;
2729 bprr->association = assoc;
2731 bprr->errstring = NULL;
2732 (*assoc->init->bend_present)(assoc->backend, bprr);
2736 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2737 *resp->presentStatus = Z_PresentStatus_failure;
2742 resp->records = pack_records(
2743 assoc, req->resultSetName, 1,
2744 toget, compp, next, presst, req->referenceId,
2745 req->preferredRecordSyntax, NULL);
2748 resp->numberOfRecordsReturned = toget;
2749 returnedrecs = *toget;
2750 resp->presentStatus = presst;
2754 if (*resp->resultCount)
2756 resp->numberOfRecordsReturned = nulint;
2757 resp->presentStatus = 0;
2759 resp->nextResultSetPosition = next;
2760 resp->searchStatus = sr;
2761 resp->resultSetStatus = 0;
2762 if (bsrt->estimated_hit_count)
2764 resp->resultSetStatus = odr_intdup(assoc->encode,
2765 Z_SearchResponse_estimate);
2767 else if (bsrt->partial_resultset)
2769 resp->resultSetStatus = odr_intdup(assoc->encode,
2770 Z_SearchResponse_subset);
2773 resp->additionalSearchInfo = bsrt->search_info;
2778 WRBUF wr = wrbuf_alloc();
2780 for (i = 0 ; i < req->num_databaseNames; i++)
2783 wrbuf_printf(wr, "+");
2784 wrbuf_puts(wr, req->databaseNames[i]);
2786 wrbuf_printf(wr, " ");
2789 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2791 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2792 wrbuf_printf(wr, " %s 1+" ODR_INT_PRINTF " ",
2793 req->resultSetName, returnedrecs);
2794 yaz_query_to_wrbuf(wr, req->query);
2796 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2803 * Maybe we got a little over-friendly when we designed bend_fetch to
2804 * get only one record at a time. Some backends can optimise multiple-record
2805 * fetches, and at any rate, there is some overhead involved in
2806 * all that selecting and hopping around. Problem is, of course, that the
2807 * frontend can't know ahead of time how many records it'll need to
2808 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2809 * is downright lousy as a bulk data transfer protocol.
2811 * To start with, we'll do the fetching of records from the backend
2812 * in one operation: To save some trips in and out of the event-handler,
2813 * and to simplify the interface to pack_records. At any rate, asynch
2814 * operation is more fun in operations that have an unpredictable execution
2815 * speed - which is normally more true for search than for present.
2817 static Z_APDU *process_presentRequest(association *assoc, request *reqb)
2819 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2821 Z_PresentResponse *resp;
2825 const char *errstring = 0;
2827 yaz_log(log_requestdetail, "Got PresentRequest.");
2829 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2831 resp->presentStatus = odr_intdup(assoc->encode, 0);
2832 if (assoc->init->bend_present)
2834 bend_present_rr *bprr = (bend_present_rr *)
2835 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2836 bprr->setname = req->resultSetId;
2837 bprr->start = odr_int_to_int(*req->resultSetStartPoint);
2838 bprr->number = odr_int_to_int(*req->numberOfRecordsRequested);
2839 bprr->format = req->preferredRecordSyntax;
2840 bprr->comp = req->recordComposition;
2841 bprr->referenceId = req->referenceId;
2842 bprr->stream = assoc->encode;
2843 bprr->print = assoc->print;
2844 bprr->association = assoc;
2846 bprr->errstring = NULL;
2847 (*assoc->init->bend_present)(assoc->backend, bprr);
2851 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2852 *resp->presentStatus = Z_PresentStatus_failure;
2853 errcode = bprr->errcode;
2854 errstring = bprr->errstring;
2857 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2858 next = odr_intdup(assoc->encode, 0);
2859 num = odr_intdup(assoc->encode, 0);
2861 apdu->which = Z_APDU_presentResponse;
2862 apdu->u.presentResponse = resp;
2863 resp->referenceId = req->referenceId;
2864 resp->otherInfo = 0;
2868 *num = *req->numberOfRecordsRequested;
2870 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2871 num, req->recordComposition, next,
2872 resp->presentStatus,
2873 req->referenceId, req->preferredRecordSyntax,
2878 WRBUF wr = wrbuf_alloc();
2879 wrbuf_printf(wr, "Present ");
2881 if (*resp->presentStatus == Z_PresentStatus_failure)
2882 wrbuf_printf(wr, "ERROR %d ", errcode);
2883 else if (*resp->presentStatus == Z_PresentStatus_success)
2884 wrbuf_printf(wr, "OK - ");
2886 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2887 *resp->presentStatus);
2889 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2890 req->resultSetId, *req->resultSetStartPoint,
2891 *req->numberOfRecordsRequested);
2892 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2897 resp->numberOfRecordsReturned = num;
2898 resp->nextResultSetPosition = next;
2904 * Scan was implemented rather in a hurry, and with support for only the basic
2905 * elements of the service in the backend API. Suggestions are welcome.
2907 static Z_APDU *process_scanRequest(association *assoc, request *reqb)
2909 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2910 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2911 Z_ScanResponse *res = (Z_ScanResponse *)
2912 odr_malloc(assoc->encode, sizeof(*res));
2913 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2914 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2915 Z_ListEntries *ents = (Z_ListEntries *)
2916 odr_malloc(assoc->encode, sizeof(*ents));
2917 Z_DiagRecs *diagrecs_p = NULL;
2918 bend_scan_rr *bsrr = (bend_scan_rr *)
2919 odr_malloc(assoc->encode, sizeof(*bsrr));
2920 struct scan_entry *save_entries;
2923 yaz_log(log_requestdetail, "Got ScanRequest");
2925 apdu->which = Z_APDU_scanResponse;
2926 apdu->u.scanResponse = res;
2927 res->referenceId = req->referenceId;
2929 /* if step is absent, set it to 0 */
2931 step_size = odr_int_to_int(*req->stepSize);
2933 res->scanStatus = scanStatus;
2934 res->numberOfEntriesReturned = numberOfEntriesReturned;
2935 res->positionOfTerm = 0;
2936 res->entries = ents;
2937 ents->num_entries = 0;
2938 ents->entries = NULL;
2939 ents->num_nonsurrogateDiagnostics = 0;
2940 ents->nonsurrogateDiagnostics = NULL;
2941 res->attributeSet = 0;
2944 if (req->databaseNames)
2947 for (i = 0; i < req->num_databaseNames; i++)
2948 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2950 bsrr->scanClause = 0;
2952 bsrr->errstring = 0;
2953 bsrr->num_bases = req->num_databaseNames;
2954 bsrr->basenames = req->databaseNames;
2955 bsrr->num_entries = odr_int_to_int(*req->numberOfTermsRequested);
2956 bsrr->term = req->termListAndStartPoint;
2957 bsrr->referenceId = req->referenceId;
2958 bsrr->stream = assoc->encode;
2959 bsrr->print = assoc->print;
2960 bsrr->step_size = &step_size;
2961 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
2962 yaz_oid_userinfo_scan_set, 1, 0);
2964 /* For YAZ 2.0 and earlier it was the backend handler that
2965 initialized entries (member display_term did not exist)
2966 YAZ 2.0 and later sets 'entries' and initialize all members
2967 including 'display_term'. If YAZ 2.0 or later sees that
2968 entries was modified - we assume that it is an old handler and
2969 that 'display_term' is _not_ set.
2971 if (bsrr->num_entries > 0)
2974 bsrr->entries = (struct scan_entry *)
2975 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
2977 for (i = 0; i<bsrr->num_entries; i++)
2979 bsrr->entries[i].term = 0;
2980 bsrr->entries[i].occurrences = 0;
2981 bsrr->entries[i].errcode = 0;
2982 bsrr->entries[i].errstring = 0;
2983 bsrr->entries[i].display_term = 0;
2986 save_entries = bsrr->entries; /* save it so we can compare later */
2988 bsrr->attributeset = req->attributeSet;
2989 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
2990 bsrr->attributeset);
2991 bsrr->term_position = req->preferredPositionInResponse ?
2992 odr_int_to_int(*req->preferredPositionInResponse) : 1;
2994 ((int (*)(void *, bend_scan_rr *))
2995 (*assoc->init->bend_scan))(assoc->backend, bsrr);
2998 diagrecs_p = zget_DiagRecs(assoc->encode,
2999 bsrr->errcode, bsrr->errstring);
3003 Z_Entry **tab = (Z_Entry **)
3004 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3006 if (bsrr->status == BEND_SCAN_PARTIAL)
3007 *scanStatus = Z_Scan_partial_5;
3009 *scanStatus = Z_Scan_success;
3010 res->stepSize = odr_intdup(assoc->encode, step_size);
3011 ents->entries = tab;
3012 ents->num_entries = bsrr->num_entries;
3013 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3015 res->positionOfTerm = odr_intdup(assoc->encode, bsrr->term_position);
3016 for (i = 0; i < bsrr->num_entries; i++)
3022 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3023 if (bsrr->entries[i].occurrences >= 0)
3025 e->which = Z_Entry_termInfo;
3026 e->u.termInfo = t = (Z_TermInfo *)
3027 odr_malloc(assoc->encode, sizeof(*t));
3028 t->suggestedAttributes = 0;
3030 if (save_entries == bsrr->entries &&
3031 bsrr->entries[i].display_term)
3033 /* the entries was _not_ set by the handler. So it's
3034 safe to test for new member display_term. It is
3037 t->displayTerm = odr_strdup(assoc->encode,
3038 bsrr->entries[i].display_term);
3040 t->alternativeTerm = 0;
3041 t->byAttributes = 0;
3042 t->otherTermInfo = 0;
3043 t->globalOccurrences = &bsrr->entries[i].occurrences;
3044 t->term = (Z_Term *)
3045 odr_malloc(assoc->encode, sizeof(*t->term));
3046 t->term->which = Z_Term_general;
3047 t->term->u.general = o =
3048 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3049 o->buf = (unsigned char *)
3050 odr_malloc(assoc->encode, o->len = o->size =
3051 strlen(bsrr->entries[i].term));
3052 memcpy(o->buf, bsrr->entries[i].term, o->len);
3053 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3054 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3058 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3059 bsrr->entries[i].errcode,
3060 bsrr->entries[i].errstring);
3061 assert(drecs->num_diagRecs == 1);
3062 e->which = Z_Entry_surrogateDiagnostic;
3063 assert(drecs->diagRecs[0]);
3064 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3070 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3071 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3076 WRBUF wr = wrbuf_alloc();
3077 wrbuf_printf(wr, "Scan ");
3078 for (i = 0 ; i < req->num_databaseNames; i++)
3081 wrbuf_printf(wr, "+");
3082 wrbuf_puts(wr, req->databaseNames[i]);
3085 wrbuf_printf(wr, " ");
3088 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3090 wrbuf_printf(wr, "OK");
3092 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3093 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3094 res->numberOfEntriesReturned ?
3095 *res->numberOfEntriesReturned : 0,
3096 (req->preferredPositionInResponse ?
3097 *req->preferredPositionInResponse : 1),
3098 *req->numberOfTermsRequested,
3099 (res->stepSize ? *res->stepSize : 1));
3102 wrbuf_printf(wr, "+%s", bsrr->setname);
3104 wrbuf_printf(wr, " ");
3105 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3106 bsrr->attributeset);
3107 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3113 static Z_APDU *process_sortRequest(association *assoc, request *reqb)
3116 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3117 Z_SortResponse *res = (Z_SortResponse *)
3118 odr_malloc(assoc->encode, sizeof(*res));
3119 bend_sort_rr *bsrr = (bend_sort_rr *)
3120 odr_malloc(assoc->encode, sizeof(*bsrr));
3122 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3124 yaz_log(log_requestdetail, "Got SortRequest.");
3126 bsrr->num_input_setnames = req->num_inputResultSetNames;
3127 for (i=0;i<req->num_inputResultSetNames;i++)
3128 yaz_log(log_requestdetail, "Input resultset: '%s'",
3129 req->inputResultSetNames[i]);
3130 bsrr->input_setnames = req->inputResultSetNames;
3131 bsrr->referenceId = req->referenceId;
3132 bsrr->output_setname = req->sortedResultSetName;
3133 yaz_log(log_requestdetail, "Output resultset: '%s'",
3134 req->sortedResultSetName);
3135 bsrr->sort_sequence = req->sortSequence;
3136 /*FIXME - dump those sequences too */
3137 bsrr->stream = assoc->encode;
3138 bsrr->print = assoc->print;
3140 bsrr->sort_status = Z_SortResponse_failure;
3142 bsrr->errstring = 0;
3144 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3146 res->referenceId = bsrr->referenceId;
3147 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3148 res->resultSetStatus = 0;
3151 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3152 bsrr->errcode, bsrr->errstring);
3153 res->diagnostics = dr->diagRecs;
3154 res->num_diagnostics = dr->num_diagRecs;
3158 res->num_diagnostics = 0;
3159 res->diagnostics = 0;
3161 res->resultCount = 0;
3164 apdu->which = Z_APDU_sortResponse;
3165 apdu->u.sortResponse = res;
3168 WRBUF wr = wrbuf_alloc();
3169 wrbuf_printf(wr, "Sort ");
3171 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3173 wrbuf_printf(wr, "OK -");
3174 wrbuf_printf(wr, " (");
3175 for (i = 0; i<req->num_inputResultSetNames; i++)
3178 wrbuf_printf(wr, "+");
3179 wrbuf_puts(wr, req->inputResultSetNames[i]);
3181 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3183 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3189 static Z_APDU *process_deleteRequest(association *assoc, request *reqb)
3192 Z_DeleteResultSetRequest *req =
3193 reqb->apdu_request->u.deleteResultSetRequest;
3194 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3195 odr_malloc(assoc->encode, sizeof(*res));
3196 bend_delete_rr *bdrr = (bend_delete_rr *)
3197 odr_malloc(assoc->encode, sizeof(*bdrr));
3198 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3200 yaz_log(log_requestdetail, "Got DeleteRequest.");
3202 bdrr->num_setnames = req->num_resultSetList;
3203 bdrr->setnames = req->resultSetList;
3204 for (i = 0; i<req->num_resultSetList; i++)
3205 yaz_log(log_requestdetail, "resultset: '%s'",
3206 req->resultSetList[i]);
3207 bdrr->stream = assoc->encode;
3208 bdrr->print = assoc->print;
3209 bdrr->function = odr_int_to_int(*req->deleteFunction);
3210 bdrr->referenceId = req->referenceId;
3212 if (bdrr->num_setnames > 0)
3214 bdrr->statuses = (int*)
3215 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3216 bdrr->num_setnames);
3217 for (i = 0; i < bdrr->num_setnames; i++)
3218 bdrr->statuses[i] = 0;
3220 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3222 res->referenceId = req->referenceId;
3224 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3226 res->deleteListStatuses = 0;
3227 if (bdrr->num_setnames > 0)
3230 res->deleteListStatuses = (Z_ListStatuses *)
3231 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3232 res->deleteListStatuses->num = bdrr->num_setnames;
3233 res->deleteListStatuses->elements =
3235 odr_malloc(assoc->encode,
3236 sizeof(*res->deleteListStatuses->elements) *
3237 bdrr->num_setnames);
3238 for (i = 0; i<bdrr->num_setnames; i++)
3240 res->deleteListStatuses->elements[i] =
3242 odr_malloc(assoc->encode,
3243 sizeof(**res->deleteListStatuses->elements));
3244 res->deleteListStatuses->elements[i]->status =
3245 odr_intdup(assoc->encode, bdrr->statuses[i]);
3246 res->deleteListStatuses->elements[i]->id =
3247 odr_strdup(assoc->encode, bdrr->setnames[i]);
3250 res->numberNotDeleted = 0;
3251 res->bulkStatuses = 0;
3252 res->deleteMessage = 0;
3255 apdu->which = Z_APDU_deleteResultSetResponse;
3256 apdu->u.deleteResultSetResponse = res;
3259 WRBUF wr = wrbuf_alloc();
3260 wrbuf_printf(wr, "Delete ");
3261 if (bdrr->delete_status)
3262 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3264 wrbuf_printf(wr, "OK -");
3265 for (i = 0; i<req->num_resultSetList; i++)
3266 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3267 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3273 static void process_close(association *assoc, request *reqb)
3275 Z_Close *req = reqb->apdu_request->u.close;
3276 static char *reasons[] =
3283 "securityViolation",
3290 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3291 reasons[*req->closeReason], req->diagnosticInformation ?
3292 req->diagnosticInformation : "NULL");
3293 if (assoc->version < 3) /* to make do_force respond with close */
3295 do_close_req(assoc, Z_Close_finished,
3296 "Association terminated by client", reqb);
3297 yaz_log(log_request,"Close OK");
3300 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3302 bend_segment_rr req;
3304 req.segment = reqb->apdu_request->u.segmentRequest;
3305 req.stream = assoc->encode;
3306 req.decode = assoc->decode;
3307 req.print = assoc->print;
3308 req.association = assoc;
3310 (*assoc->init->bend_segment)(assoc->backend, &req);
3315 static Z_APDU *process_ESRequest(association *assoc, request *reqb)
3317 bend_esrequest_rr esrequest;
3318 const char *ext_name = "unknown";
3320 Z_ExtendedServicesRequest *req =
3321 reqb->apdu_request->u.extendedServicesRequest;
3322 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3324 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3326 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3327 esrequest.stream = assoc->encode;
3328 esrequest.decode = assoc->decode;
3329 esrequest.print = assoc->print;
3330 esrequest.errcode = 0;
3331 esrequest.errstring = NULL;
3332 esrequest.association = assoc;
3333 esrequest.taskPackage = 0;
3334 esrequest.referenceId = req->referenceId;
3336 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3338 switch(esrequest.esr->taskSpecificParameters->which)
3340 case Z_External_itemOrder:
3341 ext_name = "ItemOrder"; break;
3342 case Z_External_update:
3343 ext_name = "Update"; break;
3344 case Z_External_update0:
3345 ext_name = "Update0"; break;
3346 case Z_External_ESAdmin:
3347 ext_name = "Admin"; break;
3352 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3354 resp->referenceId = req->referenceId;
3356 if (esrequest.errcode == -1)
3358 /* Backend service indicates request will be processed */
3359 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3360 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3362 else if (esrequest.errcode == 0)
3364 /* Backend service indicates request will be processed */
3365 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3366 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3370 Z_DiagRecs *diagRecs =
3371 zget_DiagRecs(assoc->encode, esrequest.errcode,
3372 esrequest.errstring);
3373 /* Backend indicates error, request will not be processed */
3374 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3375 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3376 resp->num_diagnostics = diagRecs->num_diagRecs;
3377 resp->diagnostics = diagRecs->diagRecs;
3380 WRBUF wr = wrbuf_alloc();
3381 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3382 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3387 /* Do something with the members of bend_extendedservice */
3388 if (esrequest.taskPackage)
3390 resp->taskPackage = z_ext_record_oid(
3391 assoc->encode, yaz_oid_recsyn_extended,
3392 (const char *) esrequest.taskPackage, -1);
3394 yaz_log(YLOG_DEBUG,"Send the result apdu");
3398 int bend_assoc_is_alive(bend_association assoc)
3400 if (assoc->state == ASSOC_DEAD)
3401 return 0; /* already marked as dead. Don't check I/O chan anymore */
3403 return iochan_is_alive(assoc->client_chan);
3410 * c-file-style: "Stroustrup"
3411 * indent-tabs-mode: nil
3413 * vim: shiftwidth=4 tabstop=8 expandtab