1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2008 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.
35 #include <sys/types.h>
43 #define S_ISREG(x) (x & _S_IFREG)
52 #include <libxml/parser.h>
53 #include <libxml/tree.h>
56 #include <yaz/yconfig.h>
57 #include <yaz/xmalloc.h>
58 #include <yaz/comstack.h>
62 #include <yaz/proto.h>
63 #include <yaz/oid_db.h>
65 #include <yaz/logrpn.h>
66 #include <yaz/querytowrbuf.h>
67 #include <yaz/statserv.h>
68 #include <yaz/diagbib1.h>
69 #include <yaz/charneg.h>
70 #include <yaz/otherinfo.h>
71 #include <yaz/yaz-util.h>
72 #include <yaz/pquery.h>
73 #include <yaz/oid_db.h>
76 #include <yaz/backend.h>
77 #include <yaz/yaz-ccl.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 int ir_read(IOCHAN h, int event)
270 association *assoc = (association *)iochan_getdata(h);
271 COMSTACK conn = assoc->client_link;
274 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
276 yaz_log(YLOG_DEBUG, "ir_session (input)");
277 /* We aren't speaking to this fellow */
278 if (assoc->state == ASSOC_DEAD)
280 yaz_log(log_sessiondetail, "Connection closed - end of session");
282 destroy_association(assoc);
286 assoc->cs_get_mask = EVENT_INPUT;
290 int res = cs_get(conn, &assoc->input_buffer,
291 &assoc->input_buffer_len);
292 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
294 yaz_log(log_session, "Connection error: %s res=%d",
295 cs_errmsg(cs_errno(conn)), res);
296 req = request_get(&assoc->incoming); /* get a new request */
297 do_close_req(assoc, Z_Close_protocolError,
298 "Incoming package too large", req);
303 yaz_log(log_session, "Connection closed by client");
304 assoc->state = ASSOC_DEAD;
307 else if (res == 1) /* incomplete read - wait for more */
309 if (conn->io_pending & CS_WANT_WRITE)
310 assoc->cs_get_mask |= EVENT_OUTPUT;
311 iochan_setflag(h, assoc->cs_get_mask);
314 /* we got a complete PDU. Let's decode it */
315 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
316 assoc->input_buffer[0] & 0xff,
317 assoc->input_buffer[1] & 0xff,
318 assoc->input_buffer[2] & 0xff);
319 req = request_get(&assoc->incoming); /* get a new request */
320 odr_reset(assoc->decode);
321 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
322 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
324 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
326 odr_errmsg(odr_geterror(assoc->decode)),
327 odr_getelement(assoc->decode),
328 (long) odr_offset(assoc->decode));
329 if (assoc->decode->error != OHTTP)
331 yaz_log(YLOG_WARN, "PDU dump:");
332 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
333 request_release(req);
334 do_close(assoc, Z_Close_protocolError, "Malformed package");
338 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
339 assoc->state = ASSOC_DEAD;
340 process_gdu_response(assoc, req, p);
344 req->request_mem = odr_extract_mem(assoc->decode);
347 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
348 yaz_log(YLOG_WARN, "ODR print error: %s",
349 odr_errmsg(odr_geterror(assoc->print)));
350 odr_reset(assoc->print);
352 request_enq(&assoc->incoming, req);
354 while (cs_more(conn));
360 * This is where PDUs from the client are read and the further
361 * processing is initiated. Flow of control moves down through the
362 * various process_* functions below, until the encoded result comes back up
363 * to the output handler in here.
365 * h : the I/O channel that has an outstanding event.
366 * event : the current outstanding event.
368 void ir_session(IOCHAN h, int event)
371 association *assoc = (association *)iochan_getdata(h);
372 COMSTACK conn = assoc->client_link;
375 assert(h && conn && assoc);
376 if (event == EVENT_TIMEOUT)
378 if (assoc->state != ASSOC_UP)
380 yaz_log(YLOG_DEBUG, "Final timeout - closing connection.");
381 /* do we need to lod this at all */
383 destroy_association(assoc);
388 yaz_log(log_sessiondetail,
389 "Session idle too long. Sending close.");
390 do_close(assoc, Z_Close_lackOfActivity, 0);
394 if (event & assoc->cs_accept_mask)
396 if (!cs_accept(conn))
398 yaz_log(YLOG_WARN, "accept failed");
399 destroy_association(assoc);
403 iochan_clearflag(h, EVENT_OUTPUT);
404 if (conn->io_pending)
405 { /* cs_accept didn't complete */
406 assoc->cs_accept_mask =
407 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
408 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
410 iochan_setflag(h, assoc->cs_accept_mask);
413 { /* cs_accept completed. Prepare for reading (cs_get) */
414 assoc->cs_accept_mask = 0;
415 assoc->cs_get_mask = EVENT_INPUT;
416 iochan_setflag(h, assoc->cs_get_mask);
420 if (event & assoc->cs_get_mask) /* input */
422 if (!ir_read(h, event))
424 req = request_head(&assoc->incoming);
425 if (req->state == REQUEST_IDLE)
427 request_deq(&assoc->incoming);
428 process_gdu_request(assoc, req);
431 if (event & assoc->cs_put_mask)
433 request *req = request_head(&assoc->outgoing);
435 assoc->cs_put_mask = 0;
436 yaz_log(YLOG_DEBUG, "ir_session (output)");
437 req->state = REQUEST_PENDING;
438 switch (res = cs_put(conn, req->response, req->len_response))
441 yaz_log(log_sessiondetail, "Connection closed by client");
443 destroy_association(assoc);
446 case 0: /* all sent - release the request structure */
447 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
449 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
452 nmem_destroy(req->request_mem);
453 request_deq(&assoc->outgoing);
454 request_release(req);
455 if (!request_head(&assoc->outgoing))
456 { /* restore mask for cs_get operation ... */
457 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
458 iochan_setflag(h, assoc->cs_get_mask);
459 if (assoc->state == ASSOC_DEAD)
460 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
464 assoc->cs_put_mask = EVENT_OUTPUT;
468 if (conn->io_pending & CS_WANT_WRITE)
469 assoc->cs_put_mask |= EVENT_OUTPUT;
470 if (conn->io_pending & CS_WANT_READ)
471 assoc->cs_put_mask |= EVENT_INPUT;
472 iochan_setflag(h, assoc->cs_put_mask);
475 if (event & EVENT_EXCEPT)
477 yaz_log(YLOG_WARN, "ir_session (exception)");
479 destroy_association(assoc);
484 static int process_z_request(association *assoc, request *req, char **msg);
487 static void assoc_init_reset(association *assoc)
490 assoc->init = (bend_initrequest *) xmalloc(sizeof(*assoc->init));
492 assoc->init->stream = assoc->encode;
493 assoc->init->print = assoc->print;
494 assoc->init->auth = 0;
495 assoc->init->referenceId = 0;
496 assoc->init->implementation_version = 0;
497 assoc->init->implementation_id = 0;
498 assoc->init->implementation_name = 0;
499 assoc->init->query_charset = 0;
500 assoc->init->records_in_same_charset = 0;
501 assoc->init->bend_sort = NULL;
502 assoc->init->bend_search = NULL;
503 assoc->init->bend_present = NULL;
504 assoc->init->bend_esrequest = NULL;
505 assoc->init->bend_delete = NULL;
506 assoc->init->bend_scan = NULL;
507 assoc->init->bend_segment = NULL;
508 assoc->init->bend_fetch = NULL;
509 assoc->init->bend_explain = NULL;
510 assoc->init->bend_srw_scan = NULL;
511 assoc->init->bend_srw_update = NULL;
513 assoc->init->charneg_request = NULL;
514 assoc->init->charneg_response = NULL;
516 assoc->init->decode = assoc->decode;
517 assoc->init->peer_name =
518 odr_strdup(assoc->encode, cs_addrstr(assoc->client_link));
520 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
523 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
525 statserv_options_block *cb = statserv_getcontrol();
528 const char *encoding = "UTF-8";
530 bend_initresult *binitres;
532 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
533 assoc_init_reset(assoc);
537 Z_IdAuthentication *auth = (Z_IdAuthentication *)
538 odr_malloc(assoc->decode, sizeof(*auth));
541 len = strlen(sr->username) + 1;
543 len += strlen(sr->password) + 2;
544 auth->which = Z_IdAuthentication_open;
545 auth->u.open = (char *) odr_malloc(assoc->decode, len);
546 strcpy(auth->u.open, sr->username);
547 if (sr->password && *sr->password)
549 strcat(auth->u.open, "/");
550 strcat(auth->u.open, sr->password);
552 assoc->init->auth = auth;
556 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
557 assoc->init->charneg_request = ce->u.charNeg3;
560 if (!(binitres = (*cb->bend_init)(assoc->init)))
562 assoc->state = ASSOC_DEAD;
563 yaz_add_srw_diagnostic(assoc->encode, d, num,
564 YAZ_SRW_AUTHENTICATION_ERROR, 0);
567 assoc->backend = binitres->handle;
568 assoc->init->auth = 0;
569 if (binitres->errcode)
571 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
572 assoc->state = ASSOC_DEAD;
573 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
574 binitres->errstring);
582 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
585 yaz_record_conv_t rc = 0;
586 const char *match_schema = 0;
587 Odr_oid *match_syntax = 0;
592 const char *input_schema = yaz_get_esn(rr->comp);
593 Odr_oid *input_syntax_raw = rr->request_format;
595 const char *backend_schema = 0;
596 Odr_oid *backend_syntax = 0;
598 r = yaz_retrieval_request(assoc->server->retrieval,
606 if (r == -1) /* error ? */
608 const char *details = yaz_retrieval_get_error(
609 assoc->server->retrieval);
611 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
613 rr->errstring = odr_strdup(rr->stream, details);
616 else if (r == 1 || r == 3)
618 const char *details = input_schema;
620 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
622 rr->errstring = odr_strdup(rr->stream, details);
627 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
628 if (input_syntax_raw)
630 char oidbuf[OID_STR_MAX];
631 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
632 rr->errstring = odr_strdup(rr->stream, oidbuf);
638 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
641 rr->request_format = backend_syntax;
643 (*assoc->init->bend_fetch)(assoc->backend, rr);
644 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
645 { /* post conversion must take place .. */
646 WRBUF output_record = wrbuf_alloc();
647 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
650 const char *details = yaz_record_conv_get_error(rc);
651 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
653 rr->errstring = odr_strdup(rr->stream, details);
657 rr->len = wrbuf_len(output_record);
658 rr->record = (char *) odr_malloc(rr->stream, rr->len);
659 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
661 wrbuf_destroy(output_record);
664 rr->output_format = match_syntax;
666 rr->schema = odr_strdup(rr->stream, match_schema);
669 (*assoc->init->bend_fetch)(assoc->backend, rr);
674 static int srw_bend_fetch(association *assoc, int pos,
675 Z_SRW_searchRetrieveRequest *srw_req,
676 Z_SRW_record *record,
677 const char **addinfo)
680 ODR o = assoc->encode;
682 rr.setname = "default";
685 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
687 rr.comp = (Z_RecordComposition *)
688 odr_malloc(assoc->decode, sizeof(*rr.comp));
689 rr.comp->which = Z_RecordComp_complex;
690 rr.comp->u.complex = (Z_CompSpec *)
691 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
692 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
693 odr_malloc(assoc->encode, sizeof(bool_t));
694 *rr.comp->u.complex->selectAlternativeSyntax = 0;
695 rr.comp->u.complex->num_dbSpecific = 0;
696 rr.comp->u.complex->dbSpecific = 0;
697 rr.comp->u.complex->num_recordSyntax = 0;
698 rr.comp->u.complex->recordSyntax = 0;
700 rr.comp->u.complex->generic = (Z_Specification *)
701 odr_malloc(assoc->decode, sizeof(Z_Specification));
703 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
704 rr.comp->u.complex->generic->which = Z_Schema_uri;
705 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
707 /* ESN = recordSchema if recordSchema is present */
708 rr.comp->u.complex->generic->elementSpec = 0;
709 if (srw_req->recordSchema)
711 rr.comp->u.complex->generic->elementSpec =
712 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
713 rr.comp->u.complex->generic->elementSpec->which =
714 Z_ElementSpec_elementSetName;
715 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
716 srw_req->recordSchema;
719 rr.stream = assoc->encode;
720 rr.print = assoc->print;
728 rr.surrogate_flag = 0;
729 rr.schema = srw_req->recordSchema;
731 if (!assoc->init->bend_fetch)
734 retrieve_fetch(assoc, &rr);
736 if (rr.errcode && rr.surrogate_flag)
738 int code = yaz_diag_bib1_to_srw(rr.errcode);
739 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
742 else if (rr.len >= 0)
744 record->recordData_buf = rr.record;
745 record->recordData_len = rr.len;
746 record->recordPosition = odr_intdup(o, pos);
747 record->recordSchema = odr_strdup_null(
748 o, rr.schema ? rr.schema : srw_req->recordSchema);
752 *addinfo = rr.errstring;
758 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
759 Z_Query *query_result)
761 /* have a CQL query and CQL to PQF transform .. */
762 CQL_parser cp = cql_parser_create();
768 r = cql_parser_string(cp, cql);
771 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
776 r = cql_transform_buf(ct,
777 cql_parser_result(cp),
778 rpn_buf, sizeof(rpn_buf)-1);
780 srw_errcode = cql_transform_error(ct, &add);
784 /* Syntax & transform OK. */
785 /* Convert PQF string to Z39.50 to RPN query struct */
786 YAZ_PQF_Parser pp = yaz_pqf_create();
787 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
792 int code = yaz_pqf_error(pp, &pqf_msg, &off);
793 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
795 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
799 query_result->which = Z_Query_type_1;
800 query_result->u.type_1 = rpnquery;
804 cql_parser_destroy(cp);
808 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
809 Z_AttributesPlusTerm *result)
813 int srw_error = cql2pqf(odr, cql, ct, &query);
816 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
817 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
818 rpn = query.u.type_1;
819 if (!rpn->RPNStructure)
820 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
821 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
822 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
823 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
824 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
825 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
831 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
832 bend_search_rr *bsrr) {
834 struct ccl_rpn_node *node;
837 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
838 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0) {
839 bsrr->errstring = (char*) ccl_err_msg(errcode);
840 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
843 bsrr->query->which = Z_Query_type_1;
844 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
849 static void srw_bend_search(association *assoc, request *req,
851 Z_SRW_searchRetrieveResponse *srw_res,
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;
877 if (srw_req->query_type == Z_SRW_query_type_cql)
879 if (assoc->server && assoc->server->cql_transform)
881 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
882 assoc->server->cql_transform,
886 yaz_add_srw_diagnostic(assoc->encode,
887 &srw_res->diagnostics,
888 &srw_res->num_diagnostics,
894 /* CQL query to backend. Wrap it - Z39.50 style */
895 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
896 ext->direct_reference = odr_getoidbystr(assoc->decode,
897 "1.2.840.10003.16.2");
898 ext->indirect_reference = 0;
900 ext->which = Z_External_CQL;
901 ext->u.cql = srw_req->query.cql;
903 rr.query->which = Z_Query_type_104;
904 rr.query->u.type_104 = ext;
907 else if (srw_req->query_type == Z_SRW_query_type_pqf)
909 Z_RPNQuery *RPNquery;
910 YAZ_PQF_Parser pqf_parser;
912 pqf_parser = yaz_pqf_create();
914 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
920 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
921 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
922 code, pqf_msg, (long) off);
923 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
926 rr.query->which = Z_Query_type_1;
927 rr.query->u.type_1 = RPNquery;
929 yaz_pqf_destroy(pqf_parser);
933 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
934 &srw_res->num_diagnostics,
935 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
937 if (rr.query->u.type_1)
939 rr.stream = assoc->encode;
940 rr.decode = assoc->decode;
941 rr.print = assoc->print;
943 if ( srw_req->sort.sortKeys )
944 rr.srw_sortKeys = odr_strdup(assoc->encode,
945 srw_req->sort.sortKeys );
946 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 ? *srw_req->maximumRecords : 0;
973 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
975 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
976 start, number, rr.hits);
978 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
981 srw_res->resultSetId =
982 odr_strdup(assoc->encode, rr.srw_setname );
983 srw_res->resultSetIdleTime =
984 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
987 if (start > rr.hits || start < 1)
989 /* if hits<=0 and start=1 we don't return a diagnostic */
991 yaz_add_srw_diagnostic(
993 &srw_res->diagnostics, &srw_res->num_diagnostics,
994 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1000 if (start + number > rr.hits)
1001 number = rr.hits - start + 1;
1003 /* Call bend_present if defined */
1004 if (assoc->init->bend_present)
1006 bend_present_rr *bprr = (bend_present_rr*)
1007 odr_malloc(assoc->decode, sizeof(*bprr));
1008 bprr->setname = "default";
1009 bprr->start = start;
1010 bprr->number = number;
1011 if (srw_req->recordSchema)
1013 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1014 sizeof(*bprr->comp));
1015 bprr->comp->which = Z_RecordComp_simple;
1016 bprr->comp->u.simple = (Z_ElementSetNames *)
1017 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1018 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1019 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1025 bprr->stream = assoc->encode;
1026 bprr->referenceId = 0;
1027 bprr->print = assoc->print;
1028 bprr->request = req;
1029 bprr->association = assoc;
1031 bprr->errstring = NULL;
1032 (*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.estimated_hit_count || rr.partial_resultset)
1098 yaz_add_srw_diagnostic(
1100 &srw_res->diagnostics,
1101 &srw_res->num_diagnostics,
1102 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1110 const char *querystr = "?";
1111 const char *querytype = "?";
1112 WRBUF wr = wrbuf_alloc();
1114 switch (srw_req->query_type)
1116 case Z_SRW_query_type_cql:
1118 querystr = srw_req->query.cql;
1120 case Z_SRW_query_type_pqf:
1122 querystr = srw_req->query.pqf;
1125 wrbuf_printf(wr, "SRWSearch ");
1126 wrbuf_printf(wr, srw_req->database);
1127 wrbuf_printf(wr, " ");
1128 if (srw_res->num_diagnostics)
1129 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1130 else if (*http_code != 200)
1131 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1132 else if (srw_res->numberOfRecords)
1134 wrbuf_printf(wr, "OK %d",
1135 (srw_res->numberOfRecords ?
1136 *srw_res->numberOfRecords : 0));
1138 wrbuf_printf(wr, " %s %d+%d",
1139 (srw_res->resultSetId ?
1140 srw_res->resultSetId : "-"),
1141 (srw_req->startRecord ? *srw_req->startRecord : 1),
1142 srw_res->num_records);
1143 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1148 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1151 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1154 for (ptr = ptr->children; ptr; ptr = ptr->next)
1156 if (ptr->type != XML_ELEMENT_NODE)
1158 if (!strcmp((const char *) ptr->name, "explain"))
1161 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1165 ptr = xmlCopyNode(ptr, 1);
1167 xmlDocSetRootElement(doc, ptr);
1169 xmlDocDumpMemory(doc, &buf_out, &len);
1170 content = (char*) odr_malloc(rr->stream, 1+len);
1171 memcpy(content, buf_out, len);
1172 content[len] = '\0';
1176 rr->explain_buf = content;
1184 static void srw_bend_explain(association *assoc, request *req,
1186 Z_SRW_explainResponse *srw_res,
1189 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1190 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1192 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1197 rr.stream = assoc->encode;
1198 rr.decode = assoc->decode;
1199 rr.print = assoc->print;
1201 rr.database = srw_req->database;
1203 rr.server_node_ptr = assoc->server->server_node_ptr;
1205 rr.server_node_ptr = 0;
1206 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1207 if (assoc->init->bend_explain)
1208 (*assoc->init->bend_explain)(assoc->backend, &rr);
1210 srw_bend_explain_default(assoc->backend, &rr);
1214 int packing = Z_SRW_recordPacking_string;
1215 if (srw_req->recordPacking)
1218 yaz_srw_str_to_pack(srw_req->recordPacking);
1220 packing = Z_SRW_recordPacking_string;
1222 srw_res->record.recordSchema = rr.schema;
1223 srw_res->record.recordPacking = packing;
1224 srw_res->record.recordData_buf = rr.explain_buf;
1225 srw_res->record.recordData_len = strlen(rr.explain_buf);
1226 srw_res->record.recordPosition = 0;
1232 static void srw_bend_scan(association *assoc, request *req,
1234 Z_SRW_scanResponse *srw_res,
1237 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1238 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1241 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1242 if (srw_res->num_diagnostics == 0 && assoc->init)
1244 struct scan_entry *save_entries;
1246 bend_scan_rr *bsrr = (bend_scan_rr *)
1247 odr_malloc(assoc->encode, sizeof(*bsrr));
1248 bsrr->num_bases = 1;
1249 bsrr->basenames = &srw_req->database;
1251 bsrr->num_entries = srw_req->maximumTerms ?
1252 *srw_req->maximumTerms : 10;
1253 bsrr->term_position = srw_req->responsePosition ?
1254 *srw_req->responsePosition : 1;
1257 bsrr->errstring = 0;
1258 bsrr->referenceId = 0;
1259 bsrr->stream = assoc->encode;
1260 bsrr->print = assoc->print;
1261 bsrr->step_size = odr_intdup(assoc->decode, 0);
1265 if (bsrr->num_entries > 0)
1268 bsrr->entries = (struct scan_entry *)
1269 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1271 for (i = 0; i<bsrr->num_entries; i++)
1273 bsrr->entries[i].term = 0;
1274 bsrr->entries[i].occurrences = 0;
1275 bsrr->entries[i].errcode = 0;
1276 bsrr->entries[i].errstring = 0;
1277 bsrr->entries[i].display_term = 0;
1280 save_entries = bsrr->entries; /* save it so we can compare later */
1282 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1283 assoc->init->bend_scan)
1285 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1287 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1288 &bsrr->attributeset,
1289 srw_req->scanClause.pqf);
1290 yaz_pqf_destroy(pqf_parser);
1291 bsrr->scanClause = 0;
1292 ((int (*)(void *, bend_scan_rr *))
1293 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1295 else if (srw_req->query_type == Z_SRW_query_type_cql
1296 && assoc->init->bend_scan && assoc->server
1297 && assoc->server->cql_transform)
1300 bsrr->scanClause = 0;
1301 bsrr->attributeset = 0;
1302 bsrr->term = (Z_AttributesPlusTerm *)
1303 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1304 srw_error = cql2pqf_scan(assoc->encode,
1305 srw_req->scanClause.cql,
1306 assoc->server->cql_transform,
1309 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1310 &srw_res->num_diagnostics,
1314 ((int (*)(void *, bend_scan_rr *))
1315 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1318 else if (srw_req->query_type == Z_SRW_query_type_cql
1319 && assoc->init->bend_srw_scan)
1322 bsrr->attributeset = 0;
1323 bsrr->scanClause = srw_req->scanClause.cql;
1324 ((int (*)(void *, bend_scan_rr *))
1325 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1329 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1330 &srw_res->num_diagnostics,
1331 YAZ_SRW_UNSUPP_OPERATION, "scan");
1336 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1341 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1343 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1344 &srw_res->num_diagnostics,
1345 srw_error, bsrr->errstring);
1347 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1350 srw_res->terms = (Z_SRW_scanTerm*)
1351 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1354 srw_res->num_terms = bsrr->num_entries;
1355 for (i = 0; i<bsrr->num_entries; i++)
1357 Z_SRW_scanTerm *t = srw_res->terms + i;
1358 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1359 t->numberOfRecords =
1360 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1362 if (save_entries == bsrr->entries &&
1363 bsrr->entries[i].display_term)
1365 /* the entries was _not_ set by the handler. So it's
1366 safe to test for new member display_term. It is
1369 t->displayTerm = odr_strdup(assoc->encode,
1370 bsrr->entries[i].display_term);
1378 WRBUF wr = wrbuf_alloc();
1379 const char *querytype = 0;
1380 const char *querystr = 0;
1382 switch(srw_req->query_type)
1384 case Z_SRW_query_type_pqf:
1386 querystr = srw_req->scanClause.pqf;
1388 case Z_SRW_query_type_cql:
1390 querystr = srw_req->scanClause.cql;
1393 querytype = "UNKNOWN";
1397 wrbuf_printf(wr, "SRWScan ");
1398 wrbuf_printf(wr, srw_req->database);
1399 wrbuf_printf(wr, " ");
1401 if (srw_res->num_diagnostics)
1402 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1403 else if (srw_res->num_terms)
1404 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1406 wrbuf_printf(wr, "OK - - ");
1408 wrbuf_printf(wr, "%d+%d+0 ",
1409 (srw_req->responsePosition ?
1410 *srw_req->responsePosition : 1),
1411 (srw_req->maximumTerms ?
1412 *srw_req->maximumTerms : 1));
1413 /* there is no step size in SRU/W ??? */
1414 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1415 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1421 static void srw_bend_update(association *assoc, request *req,
1423 Z_SRW_updateResponse *srw_res,
1426 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1427 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1428 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1430 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1434 Z_SRW_extra_record *extra = srw_req->extra_record;
1436 rr.stream = assoc->encode;
1437 rr.print = assoc->print;
1439 rr.basenames = &srw_req->database;
1440 rr.operation = srw_req->operation;
1441 rr.operation_status = "failed";
1443 rr.record_versions = 0;
1444 rr.num_versions = 0;
1445 rr.record_packing = "string";
1446 rr.record_schema = 0;
1448 rr.extra_record_data = 0;
1449 rr.extra_request_data = 0;
1450 rr.extra_response_data = 0;
1456 if (rr.operation == 0)
1458 yaz_add_sru_update_diagnostic(
1459 assoc->encode, &srw_res->diagnostics,
1460 &srw_res->num_diagnostics,
1461 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1465 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1466 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1467 if (!strcmp( rr.operation, "delete"))
1469 if (srw_req->record && !srw_req->record->recordSchema)
1471 rr.record_schema = odr_strdup(
1473 srw_req->record->recordSchema);
1475 if (srw_req->record)
1477 rr.record_data = odr_strdupn(
1479 srw_req->record->recordData_buf,
1480 srw_req->record->recordData_len );
1482 if (extra && extra->extraRecordData_len)
1484 rr.extra_record_data = odr_strdupn(
1486 extra->extraRecordData_buf,
1487 extra->extraRecordData_len );
1489 if (srw_req->recordId)
1490 rr.record_id = srw_req->recordId;
1491 else if (extra && extra->recordIdentifier)
1492 rr.record_id = extra->recordIdentifier;
1494 else if (!strcmp(rr.operation, "replace"))
1496 if (srw_req->recordId)
1497 rr.record_id = srw_req->recordId;
1498 else if (extra && extra->recordIdentifier)
1499 rr.record_id = extra->recordIdentifier;
1502 yaz_add_sru_update_diagnostic(
1503 assoc->encode, &srw_res->diagnostics,
1504 &srw_res->num_diagnostics,
1505 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1506 "recordIdentifier");
1508 if (!srw_req->record)
1510 yaz_add_sru_update_diagnostic(
1511 assoc->encode, &srw_res->diagnostics,
1512 &srw_res->num_diagnostics,
1513 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1518 if (srw_req->record->recordSchema)
1519 rr.record_schema = odr_strdup(
1520 assoc->encode, srw_req->record->recordSchema);
1521 if (srw_req->record->recordData_len )
1523 rr.record_data = odr_strdupn(assoc->encode,
1524 srw_req->record->recordData_buf,
1525 srw_req->record->recordData_len );
1529 yaz_add_sru_update_diagnostic(
1530 assoc->encode, &srw_res->diagnostics,
1531 &srw_res->num_diagnostics,
1532 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1536 if (extra && extra->extraRecordData_len)
1538 rr.extra_record_data = odr_strdupn(
1540 extra->extraRecordData_buf,
1541 extra->extraRecordData_len );
1544 else if (!strcmp(rr.operation, "insert"))
1546 if (srw_req->recordId)
1547 rr.record_id = srw_req->recordId;
1549 rr.record_id = extra->recordIdentifier;
1551 if (srw_req->record)
1553 if (srw_req->record->recordSchema)
1554 rr.record_schema = odr_strdup(
1555 assoc->encode, srw_req->record->recordSchema);
1557 if (srw_req->record->recordData_len)
1558 rr.record_data = odr_strdupn(
1560 srw_req->record->recordData_buf,
1561 srw_req->record->recordData_len );
1563 if (extra && extra->extraRecordData_len)
1565 rr.extra_record_data = odr_strdupn(
1567 extra->extraRecordData_buf,
1568 extra->extraRecordData_len );
1572 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1573 &srw_res->num_diagnostics,
1574 YAZ_SRU_UPDATE_INVALID_ACTION,
1577 if (srw_req->record)
1579 const char *pack_str =
1580 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1582 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1585 if (srw_req->num_recordVersions)
1587 rr.record_versions = srw_req->recordVersions;
1588 rr.num_versions = srw_req->num_recordVersions;
1590 if (srw_req->extraRequestData_len)
1592 rr.extra_request_data = odr_strdupn(assoc->encode,
1593 srw_req->extraRequestData_buf,
1594 srw_req->extraRequestData_len );
1596 if (srw_res->num_diagnostics == 0)
1598 if ( assoc->init->bend_srw_update)
1599 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1601 yaz_add_sru_update_diagnostic(
1602 assoc->encode, &srw_res->diagnostics,
1603 &srw_res->num_diagnostics,
1604 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1605 "No Update backend handler");
1609 yaz_add_srw_diagnostic_uri(assoc->encode,
1610 &srw_res->diagnostics,
1611 &srw_res->num_diagnostics,
1615 srw_res->recordId = rr.record_id;
1616 srw_res->operationStatus = rr.operation_status;
1617 srw_res->recordVersions = rr.record_versions;
1618 srw_res->num_recordVersions = rr.num_versions;
1619 if (srw_res->extraResponseData_len)
1621 srw_res->extraResponseData_buf = rr.extra_response_data;
1622 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1624 if (srw_res->num_diagnostics == 0 && rr.record_data)
1626 srw_res->record = yaz_srw_get_record(assoc->encode);
1627 srw_res->record->recordSchema = rr.record_schema;
1628 if (rr.record_packing)
1630 int pack = yaz_srw_str_to_pack(rr.record_packing);
1634 pack = Z_SRW_recordPacking_string;
1635 yaz_log(YLOG_WARN, "Back packing %s from backend",
1638 srw_res->record->recordPacking = pack;
1640 srw_res->record->recordData_buf = rr.record_data;
1641 srw_res->record->recordData_len = strlen(rr.record_data);
1642 if (rr.extra_record_data)
1644 Z_SRW_extra_record *ex =
1645 yaz_srw_get_extra_record(assoc->encode);
1646 srw_res->extra_record = ex;
1647 ex->extraRecordData_buf = rr.extra_record_data;
1648 ex->extraRecordData_len = strlen(rr.extra_record_data);
1654 /* check if path is OK (1); BAD (0) */
1655 static int check_path(const char *path)
1659 if (strstr(path, ".."))
1664 static char *read_file(const char *fname, ODR o, int *sz)
1667 FILE *inf = fopen(fname, "rb");
1671 fseek(inf, 0L, SEEK_END);
1674 buf = (char *) odr_malloc(o, *sz);
1675 fread(buf, 1, *sz, inf);
1680 static void process_http_request(association *assoc, request *req)
1682 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1683 ODR o = assoc->encode;
1684 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1686 Z_SOAP *soap_package = 0;
1689 Z_HTTP_Response *hres = 0;
1691 const char *stylesheet = 0; /* for now .. set later */
1692 Z_SRW_diagnostic *diagnostic = 0;
1693 int num_diagnostic = 0;
1694 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1696 if (!control_association(assoc, host, 0))
1698 p = z_get_HTTP_Response(o, 404);
1701 if (r == 2 && assoc->server && assoc->server->docpath
1702 && hreq->path[0] == '/'
1704 /* check if path is a proper prefix of documentroot */
1705 strncmp(hreq->path+1, assoc->server->docpath,
1706 strlen(assoc->server->docpath))
1709 if (!check_path(hreq->path))
1711 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1712 p = z_get_HTTP_Response(o, 404);
1716 int content_size = 0;
1717 char *content_buf = read_file(hreq->path+1, o, &content_size);
1720 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1721 p = z_get_HTTP_Response(o, 404);
1725 const char *ctype = 0;
1726 yaz_mime_types types = yaz_mime_types_create();
1728 yaz_mime_types_add(types, "xsl", "application/xml");
1729 yaz_mime_types_add(types, "xml", "application/xml");
1730 yaz_mime_types_add(types, "css", "text/css");
1731 yaz_mime_types_add(types, "html", "text/html");
1732 yaz_mime_types_add(types, "htm", "text/html");
1733 yaz_mime_types_add(types, "txt", "text/plain");
1734 yaz_mime_types_add(types, "js", "application/x-javascript");
1736 yaz_mime_types_add(types, "gif", "image/gif");
1737 yaz_mime_types_add(types, "png", "image/png");
1738 yaz_mime_types_add(types, "jpg", "image/jpeg");
1739 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1741 ctype = yaz_mime_lookup_fname(types, hreq->path);
1744 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1745 p = z_get_HTTP_Response(o, 404);
1749 p = z_get_HTTP_Response(o, 200);
1750 hres = p->u.HTTP_Response;
1751 hres->content_buf = content_buf;
1752 hres->content_len = content_size;
1753 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1755 yaz_mime_types_destroy(types);
1763 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1764 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1766 if (r == 2) /* not taken */
1768 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1769 &diagnostic, &num_diagnostic);
1770 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1772 if (r == 0) /* decode SRW/SRU OK .. */
1774 int http_code = 200;
1775 if (sr->which == Z_SRW_searchRetrieve_request)
1778 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1780 stylesheet = sr->u.request->stylesheet;
1783 res->u.response->diagnostics = diagnostic;
1784 res->u.response->num_diagnostics = num_diagnostic;
1788 srw_bend_search(assoc, req, sr, res->u.response,
1791 if (http_code == 200)
1792 soap_package->u.generic->p = res;
1794 else if (sr->which == Z_SRW_explain_request)
1796 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1798 stylesheet = sr->u.explain_request->stylesheet;
1801 res->u.explain_response->diagnostics = diagnostic;
1802 res->u.explain_response->num_diagnostics = num_diagnostic;
1804 srw_bend_explain(assoc, req, sr,
1805 res->u.explain_response, &http_code);
1806 if (http_code == 200)
1807 soap_package->u.generic->p = res;
1809 else if (sr->which == Z_SRW_scan_request)
1811 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1813 stylesheet = sr->u.scan_request->stylesheet;
1816 res->u.scan_response->diagnostics = diagnostic;
1817 res->u.scan_response->num_diagnostics = num_diagnostic;
1819 srw_bend_scan(assoc, req, sr,
1820 res->u.scan_response, &http_code);
1821 if (http_code == 200)
1822 soap_package->u.generic->p = res;
1824 else if (sr->which == Z_SRW_update_request)
1826 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1828 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1831 res->u.update_response->diagnostics = diagnostic;
1832 res->u.update_response->num_diagnostics = num_diagnostic;
1834 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1835 srw_bend_update(assoc, req, sr,
1836 res->u.update_response, &http_code);
1837 if (http_code == 200)
1838 soap_package->u.generic->p = res;
1842 yaz_log(log_request, "SOAP ERROR");
1843 /* FIXME - what error, what query */
1845 z_soap_error(assoc->encode, soap_package,
1846 "SOAP-ENV:Client", "Bad method", 0);
1848 if (http_code == 200 || http_code == 500)
1850 static Z_SOAP_Handler soap_handlers[4] = {
1852 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1853 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1854 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1860 p = z_get_HTTP_Response(o, 200);
1861 hres = p->u.HTTP_Response;
1863 if (!stylesheet && assoc->server)
1864 stylesheet = assoc->server->stylesheet;
1866 /* empty stylesheet means NO stylesheet */
1867 if (stylesheet && *stylesheet == '\0')
1870 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1871 &hres->content_buf, &hres->content_len,
1872 soap_handlers, charset, stylesheet);
1873 hres->code = http_code;
1875 strcpy(ctype, "text/xml");
1876 if (charset && strlen(charset) < sizeof(ctype)-30)
1878 strcat(ctype, "; charset=");
1879 strcat(ctype, charset);
1881 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1884 p = z_get_HTTP_Response(o, http_code);
1888 p = z_get_HTTP_Response(o, 500);
1889 hres = p->u.HTTP_Response;
1890 if (!strcmp(hreq->version, "1.0"))
1892 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1893 if (v && !strcmp(v, "Keep-Alive"))
1897 hres->version = "1.0";
1901 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1902 if (v && !strcmp(v, "close"))
1906 hres->version = "1.1";
1910 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1911 assoc->state = ASSOC_DEAD;
1912 assoc->cs_get_mask = 0;
1917 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1919 if (alive && isdigit(*(const unsigned char *) alive))
1923 if (t < 0 || t > 3600)
1925 iochan_settimeout(assoc->client_chan,t);
1926 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1928 process_gdu_response(assoc, req, p);
1931 static void process_gdu_request(association *assoc, request *req)
1933 if (req->gdu_request->which == Z_GDU_Z3950)
1936 req->apdu_request = req->gdu_request->u.z3950;
1937 if (process_z_request(assoc, req, &msg) < 0)
1938 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1940 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1941 process_http_request(assoc, req);
1944 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1949 * Initiate request processing.
1951 static int process_z_request(association *assoc, request *req, char **msg)
1957 *msg = "Unknown Error";
1958 assert(req && req->state == REQUEST_IDLE);
1959 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1961 *msg = "Missing InitRequest";
1964 switch (req->apdu_request->which)
1966 case Z_APDU_initRequest:
1967 res = process_initRequest(assoc, req); break;
1968 case Z_APDU_searchRequest:
1969 res = process_searchRequest(assoc, req, &fd); break;
1970 case Z_APDU_presentRequest:
1971 res = process_presentRequest(assoc, req, &fd); break;
1972 case Z_APDU_scanRequest:
1973 if (assoc->init->bend_scan)
1974 res = process_scanRequest(assoc, req, &fd);
1977 *msg = "Cannot handle Scan APDU";
1981 case Z_APDU_extendedServicesRequest:
1982 if (assoc->init->bend_esrequest)
1983 res = process_ESRequest(assoc, req, &fd);
1986 *msg = "Cannot handle Extended Services APDU";
1990 case Z_APDU_sortRequest:
1991 if (assoc->init->bend_sort)
1992 res = process_sortRequest(assoc, req, &fd);
1995 *msg = "Cannot handle Sort APDU";
2000 process_close(assoc, req);
2002 case Z_APDU_deleteResultSetRequest:
2003 if (assoc->init->bend_delete)
2004 res = process_deleteRequest(assoc, req, &fd);
2007 *msg = "Cannot handle Delete APDU";
2011 case Z_APDU_segmentRequest:
2012 if (assoc->init->bend_segment)
2014 res = process_segmentRequest(assoc, req);
2018 *msg = "Cannot handle Segment APDU";
2022 case Z_APDU_triggerResourceControlRequest:
2025 *msg = "Bad APDU received";
2030 yaz_log(YLOG_DEBUG, " result immediately available");
2031 retval = process_z_response(assoc, req, res);
2035 yaz_log(YLOG_DEBUG, " result unavailble");
2038 else /* no result yet - one will be provided later */
2042 /* Set up an I/O handler for the fd supplied by the backend */
2044 yaz_log(YLOG_DEBUG, " establishing handler for result");
2045 req->state = REQUEST_PENDING;
2046 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2048 iochan_setdata(chan, assoc);
2055 * Handle message from the backend.
2057 void backend_response(IOCHAN i, int event)
2059 association *assoc = (association *)iochan_getdata(i);
2060 request *req = request_head(&assoc->incoming);
2064 yaz_log(YLOG_DEBUG, "backend_response");
2065 assert(assoc && req && req->state != REQUEST_IDLE);
2066 /* determine what it is we're waiting for */
2067 switch (req->apdu_request->which)
2069 case Z_APDU_searchRequest:
2070 res = response_searchRequest(assoc, req, 0, &fd); break;
2072 case Z_APDU_presentRequest:
2073 res = response_presentRequest(assoc, req, 0, &fd); break;
2074 case Z_APDU_scanRequest:
2075 res = response_scanRequest(assoc, req, 0, &fd); break;
2078 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2081 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2083 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2084 do_close(assoc, Z_Close_systemProblem, 0);
2088 else if (!res) /* no result yet - try again later */
2090 yaz_log(YLOG_DEBUG, " no result yet");
2091 iochan_setfd(i, fd); /* in case fd has changed */
2096 * Encode response, and transfer the request structure to the outgoing queue.
2098 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2100 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2104 if (!z_GDU(assoc->print, &res, 0, 0))
2105 yaz_log(YLOG_WARN, "ODR print error: %s",
2106 odr_errmsg(odr_geterror(assoc->print)));
2107 odr_reset(assoc->print);
2109 if (!z_GDU(assoc->encode, &res, 0, 0))
2111 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2112 odr_errmsg(odr_geterror(assoc->decode)),
2113 odr_getelement(assoc->decode));
2116 req->response = odr_getbuf(assoc->encode, &req->len_response,
2117 &req->size_response);
2118 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2119 odr_reset(assoc->encode);
2120 req->state = REQUEST_IDLE;
2121 request_enq(&assoc->outgoing, req);
2122 /* turn the work over to the ir_session handler */
2123 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2124 assoc->cs_put_mask = EVENT_OUTPUT;
2125 /* Is there more work to be done? give that to the input handler too */
2128 req = request_head(&assoc->incoming);
2129 if (req && req->state == REQUEST_IDLE)
2131 request_deq(&assoc->incoming);
2132 process_gdu_request(assoc, req);
2141 * Encode response, and transfer the request structure to the outgoing queue.
2143 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2145 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2146 gres->which = Z_GDU_Z3950;
2147 gres->u.z3950 = res;
2149 return process_gdu_response(assoc, req, gres);
2152 static char *get_vhost(Z_OtherInformation *otherInfo)
2154 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2158 * Handle init request.
2159 * At the moment, we don't check the options
2160 * anywhere else in the code - we just try not to do anything that would
2161 * break a naive client. We'll toss 'em into the association block when
2162 * we need them there.
2164 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2166 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2167 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2168 Z_InitResponse *resp = apdu->u.initResponse;
2169 bend_initresult *binitres;
2172 statserv_options_block *cb = 0; /* by default no control for backend */
2174 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2175 cb = statserv_getcontrol(); /* got control block for backend */
2177 if (cb && assoc->backend)
2178 (*cb->bend_close)(assoc->backend);
2180 yaz_log(log_requestdetail, "Got initRequest");
2181 if (req->implementationId)
2182 yaz_log(log_requestdetail, "Id: %s",
2183 req->implementationId);
2184 if (req->implementationName)
2185 yaz_log(log_requestdetail, "Name: %s",
2186 req->implementationName);
2187 if (req->implementationVersion)
2188 yaz_log(log_requestdetail, "Version: %s",
2189 req->implementationVersion);
2191 assoc_init_reset(assoc);
2193 assoc->init->auth = req->idAuthentication;
2194 assoc->init->referenceId = req->referenceId;
2196 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2198 Z_CharSetandLanguageNegotiation *negotiation =
2199 yaz_get_charneg_record (req->otherInfo);
2201 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2202 assoc->init->charneg_request = negotiation;
2208 if (req->implementationVersion)
2209 yaz_log(log_requestdetail, "Config: %s",
2212 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2214 /* we have a backend control block, so call that init function */
2215 if (!(binitres = (*cb->bend_init)(assoc->init)))
2217 yaz_log(YLOG_WARN, "Bad response from backend.");
2220 assoc->backend = binitres->handle;
2224 /* no backend. return error */
2225 binitres = (bend_initresult *)
2226 odr_malloc(assoc->encode, sizeof(*binitres));
2227 binitres->errstring = 0;
2228 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2229 iochan_settimeout(assoc->client_chan, 10);
2231 if ((assoc->init->bend_sort))
2232 yaz_log(YLOG_DEBUG, "Sort handler installed");
2233 if ((assoc->init->bend_search))
2234 yaz_log(YLOG_DEBUG, "Search handler installed");
2235 if ((assoc->init->bend_present))
2236 yaz_log(YLOG_DEBUG, "Present handler installed");
2237 if ((assoc->init->bend_esrequest))
2238 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2239 if ((assoc->init->bend_delete))
2240 yaz_log(YLOG_DEBUG, "Delete handler installed");
2241 if ((assoc->init->bend_scan))
2242 yaz_log(YLOG_DEBUG, "Scan handler installed");
2243 if ((assoc->init->bend_segment))
2244 yaz_log(YLOG_DEBUG, "Segment handler installed");
2246 resp->referenceId = req->referenceId;
2248 /* let's tell the client what we can do */
2249 if (ODR_MASK_GET(req->options, Z_Options_search))
2251 ODR_MASK_SET(resp->options, Z_Options_search);
2252 strcat(options, "srch");
2254 if (ODR_MASK_GET(req->options, Z_Options_present))
2256 ODR_MASK_SET(resp->options, Z_Options_present);
2257 strcat(options, " prst");
2259 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2260 assoc->init->bend_delete)
2262 ODR_MASK_SET(resp->options, Z_Options_delSet);
2263 strcat(options, " del");
2265 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2266 assoc->init->bend_esrequest)
2268 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2269 strcat(options, " extendedServices");
2271 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2273 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2274 strcat(options, " namedresults");
2276 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2278 ODR_MASK_SET(resp->options, Z_Options_scan);
2279 strcat(options, " scan");
2281 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2283 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2284 strcat(options, " concurrop");
2286 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2288 ODR_MASK_SET(resp->options, Z_Options_sort);
2289 strcat(options, " sort");
2292 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2294 Z_OtherInformationUnit *p0;
2296 if (!assoc->init->charneg_response)
2298 if (assoc->init->query_charset)
2300 assoc->init->charneg_response = yaz_set_response_charneg(
2301 assoc->encode, assoc->init->query_charset, 0,
2302 assoc->init->records_in_same_charset);
2306 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2309 if (assoc->init->charneg_response
2310 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2312 p0->which = Z_OtherInfo_externallyDefinedInfo;
2313 p0->information.externallyDefinedInfo =
2314 assoc->init->charneg_response;
2315 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2316 strcat(options, " negotiation");
2319 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2320 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2322 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2324 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2325 assoc->version = 1; /* 1 & 2 are equivalent */
2327 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2329 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2332 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2334 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2338 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2340 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2341 assoc->maximumRecordSize = *req->maximumRecordSize;
2343 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2344 assoc->preferredMessageSize = *req->preferredMessageSize;
2346 resp->preferredMessageSize = &assoc->preferredMessageSize;
2347 resp->maximumRecordSize = &assoc->maximumRecordSize;
2349 resp->implementationId = odr_prepend(assoc->encode,
2350 assoc->init->implementation_id,
2351 resp->implementationId);
2353 resp->implementationName = odr_prepend(assoc->encode,
2354 assoc->init->implementation_name,
2355 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2357 version = odr_strdup(assoc->encode, "$Revision: 1.128 $");
2358 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2359 version[strlen(version)-2] = '\0';
2360 resp->implementationVersion = odr_prepend(assoc->encode,
2361 assoc->init->implementation_version,
2362 odr_prepend(assoc->encode, &version[11],
2363 resp->implementationVersion));
2365 if (binitres->errcode)
2367 assoc->state = ASSOC_DEAD;
2368 resp->userInformationField =
2369 init_diagnostics(assoc->encode, binitres->errcode,
2370 binitres->errstring);
2375 if (!req->idAuthentication)
2376 yaz_log(log_request, "Auth none");
2377 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2379 const char *open = req->idAuthentication->u.open;
2380 const char *slash = strchr(open, '/');
2386 yaz_log(log_request, "Auth open %.*s", len, open);
2388 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2390 const char *user = req->idAuthentication->u.idPass->userId;
2391 const char *group = req->idAuthentication->u.idPass->groupId;
2392 yaz_log(log_request, "Auth idPass %s %s",
2393 user ? user : "-", group ? group : "-");
2395 else if (req->idAuthentication->which
2396 == Z_IdAuthentication_anonymous)
2398 yaz_log(log_request, "Auth anonymous");
2402 yaz_log(log_request, "Auth other");
2407 WRBUF wr = wrbuf_alloc();
2408 wrbuf_printf(wr, "Init ");
2409 if (binitres->errcode)
2410 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2412 wrbuf_printf(wr, "OK -");
2413 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2414 (req->implementationId ? req->implementationId :"-"),
2415 (req->implementationName ?
2416 req->implementationName : "-"),
2417 (req->implementationVersion ?
2418 req->implementationVersion : "-")
2420 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2427 * Set the specified `errcode' and `errstring' into a UserInfo-1
2428 * external to be returned to the client in accordance with Z35.90
2429 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2430 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2432 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2434 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2435 addinfo ? " -- " : "", addinfo ? addinfo : "");
2436 return zget_init_diagnostics(odr, error, addinfo);
2440 * nonsurrogate diagnostic record.
2442 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2444 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2446 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2447 addinfo ? " -- " : "", addinfo ? addinfo : "");
2449 rec->which = Z_Records_NSD;
2450 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2456 * surrogate diagnostic.
2458 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2460 int error, const char *addinfo)
2462 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2463 addinfo ? " -- " : "", addinfo ? addinfo : "");
2464 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2467 static Z_Records *pack_records(association *a, char *setname, int start,
2468 int *num, Z_RecordComposition *comp,
2469 int *next, int *pres,
2470 Z_ReferenceId *referenceId,
2471 Odr_oid *oid, int *errcode)
2473 int recno, total_length = 0, toget = *num, dumped_records = 0;
2474 Z_Records *records =
2475 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2476 Z_NamePlusRecordList *reclist =
2477 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2478 Z_NamePlusRecord **list =
2479 (Z_NamePlusRecord **) odr_malloc(a->encode, sizeof(*list) * toget);
2481 records->which = Z_Records_DBOSD;
2482 records->u.databaseOrSurDiagnostics = reclist;
2483 reclist->num_records = 0;
2484 reclist->records = list;
2485 *pres = Z_PresentStatus_success;
2489 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2490 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2491 a->maximumRecordSize);
2492 for (recno = start; reclist->num_records < toget; recno++)
2495 Z_NamePlusRecord *thisrec;
2496 int this_length = 0;
2498 * we get the number of bytes allocated on the stream before any
2499 * allocation done by the backend - this should give us a reasonable
2500 * idea of the total size of the data so far.
2502 total_length = odr_total(a->encode) - dumped_records;
2508 freq.last_in_set = 0;
2509 freq.setname = setname;
2510 freq.surrogate_flag = 0;
2511 freq.number = recno;
2513 freq.request_format = oid;
2514 freq.output_format = 0;
2515 freq.stream = a->encode;
2516 freq.print = a->print;
2517 freq.referenceId = referenceId;
2520 retrieve_fetch(a, &freq);
2522 *next = freq.last_in_set ? 0 : recno + 1;
2526 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2529 *pres = Z_PresentStatus_failure;
2530 /* for 'present request out of range',
2531 set addinfo to record position if not set */
2532 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2533 freq.errstring == 0)
2535 sprintf (s, "%d", recno);
2539 *errcode = freq.errcode;
2540 return diagrec(a, freq.errcode, freq.errstring);
2542 reclist->records[reclist->num_records] =
2543 surrogatediagrec(a, freq.basename, freq.errcode,
2545 reclist->num_records++;
2548 if (freq.record == 0) /* no error and no record ? */
2550 *next = 0; /* signal end-of-set and stop */
2554 this_length = freq.len;
2556 this_length = odr_total(a->encode) - total_length - dumped_records;
2557 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2558 this_length, total_length, dumped_records);
2559 if (a->preferredMessageSize > 0 &&
2560 this_length + total_length > a->preferredMessageSize)
2562 /* record is small enough, really */
2563 if (this_length <= a->preferredMessageSize && recno > start)
2565 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2566 *pres = Z_PresentStatus_partial_2;
2569 /* record can only be fetched by itself */
2570 if (this_length < a->maximumRecordSize)
2572 yaz_log(log_requestdetail, " Record > prefmsgsz");
2575 yaz_log(YLOG_DEBUG, " Dropped it");
2576 reclist->records[reclist->num_records] =
2577 surrogatediagrec(a, freq.basename, 16, 0);
2578 reclist->num_records++;
2579 dumped_records += this_length;
2583 else /* too big entirely */
2585 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2586 this_length, a->maximumRecordSize);
2587 reclist->records[reclist->num_records] =
2588 surrogatediagrec(a, freq.basename, 17, 0);
2589 reclist->num_records++;
2590 dumped_records += this_length;
2595 if (!(thisrec = (Z_NamePlusRecord *)
2596 odr_malloc(a->encode, sizeof(*thisrec))))
2598 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2599 thisrec->which = Z_NamePlusRecord_databaseRecord;
2601 if (!freq.output_format)
2602 freq.output_format = freq.request_format;
2603 thisrec->u.databaseRecord = z_ext_record_oid(
2604 a->encode, freq.output_format, freq.record, freq.len);
2605 if (!thisrec->u.databaseRecord)
2607 reclist->records[reclist->num_records] = thisrec;
2608 reclist->num_records++;
2610 *num = reclist->num_records;
2614 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2617 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2618 bend_search_rr *bsrr =
2619 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2621 yaz_log(log_requestdetail, "Got SearchRequest.");
2623 bsrr->request = reqb;
2624 bsrr->association = assoc;
2625 bsrr->referenceId = req->referenceId;
2626 save_referenceId (reqb, bsrr->referenceId);
2627 bsrr->srw_sortKeys = 0;
2628 bsrr->srw_setname = 0;
2629 bsrr->srw_setnameIdleTime = 0;
2630 bsrr->estimated_hit_count = 0;
2631 bsrr->partial_resultset = 0;
2633 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2634 if (req->databaseNames)
2637 for (i = 0; i < req->num_databaseNames; i++)
2638 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2641 yaz_log_zquery_level(log_requestdetail,req->query);
2643 if (assoc->init->bend_search)
2645 bsrr->setname = req->resultSetName;
2646 bsrr->replace_set = *req->replaceIndicator;
2647 bsrr->num_bases = req->num_databaseNames;
2648 bsrr->basenames = req->databaseNames;
2649 bsrr->query = req->query;
2650 bsrr->stream = assoc->encode;
2651 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2652 bsrr->decode = assoc->decode;
2653 bsrr->print = assoc->print;
2656 bsrr->errstring = NULL;
2657 bsrr->search_info = NULL;
2659 if (assoc->server && assoc->server->cql_transform
2660 && req->query->which == Z_Query_type_104
2661 && req->query->u.type_104->which == Z_External_CQL)
2663 /* have a CQL query and a CQL to PQF transform .. */
2665 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2666 assoc->server->cql_transform, bsrr->query);
2668 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2671 if (assoc->server && assoc->server->ccl_transform
2672 && req->query->which == Z_Query_type_2) /*CCL*/
2674 /* have a CCL query and a CCL to PQF transform .. */
2676 ccl2pqf(bsrr->stream, req->query->u.type_2,
2677 assoc->server->ccl_transform, bsrr);
2679 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2683 (assoc->init->bend_search)(assoc->backend, bsrr);
2684 if (!bsrr->request) /* backend not ready with the search response */
2685 return 0; /* should not be used any more */
2689 /* FIXME - make a diagnostic for it */
2690 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2692 return response_searchRequest(assoc, reqb, bsrr, fd);
2695 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2698 * Prepare a searchresponse based on the backend results. We probably want
2699 * to look at making the fetching of records nonblocking as well, but
2700 * so far, we'll keep things simple.
2701 * If bsrt is null, that means we're called in response to a communications
2702 * event, and we'll have to get the response for ourselves.
2704 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2705 bend_search_rr *bsrt, int *fd)
2707 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2708 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2709 Z_SearchResponse *resp = (Z_SearchResponse *)
2710 odr_malloc(assoc->encode, sizeof(*resp));
2711 int *nulint = odr_intdup(assoc->encode, 0);
2712 int *next = odr_intdup(assoc->encode, 0);
2713 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2714 int returnedrecs = 0;
2716 apdu->which = Z_APDU_searchResponse;
2717 apdu->u.searchResponse = resp;
2718 resp->referenceId = req->referenceId;
2719 resp->additionalSearchInfo = 0;
2720 resp->otherInfo = 0;
2722 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2724 yaz_log(YLOG_FATAL, "Bad result from backend");
2727 else if (bsrt->errcode)
2729 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2730 resp->resultCount = nulint;
2731 resp->numberOfRecordsReturned = nulint;
2732 resp->nextResultSetPosition = nulint;
2733 resp->searchStatus = nulint;
2734 resp->resultSetStatus = none;
2735 resp->presentStatus = 0;
2739 bool_t *sr = odr_intdup(assoc->encode, 1);
2740 int *toget = odr_intdup(assoc->encode, 0);
2741 Z_RecordComposition comp, *compp = 0;
2743 yaz_log(log_requestdetail, "resultCount: %d", bsrt->hits);
2746 resp->resultCount = &bsrt->hits;
2748 comp.which = Z_RecordComp_simple;
2749 /* how many records does the user agent want, then? */
2750 if (bsrt->hits <= *req->smallSetUpperBound)
2752 *toget = bsrt->hits;
2753 if ((comp.u.simple = req->smallSetElementSetNames))
2756 else if (bsrt->hits < *req->largeSetLowerBound)
2758 *toget = *req->mediumSetPresentNumber;
2759 if (*toget > bsrt->hits)
2760 *toget = bsrt->hits;
2761 if ((comp.u.simple = req->mediumSetElementSetNames))
2767 if (*toget && !resp->records)
2769 int *presst = odr_intdup(assoc->encode, 0);
2770 /* Call bend_present if defined */
2771 if (assoc->init->bend_present)
2773 bend_present_rr *bprr = (bend_present_rr *)
2774 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2775 bprr->setname = req->resultSetName;
2777 bprr->number = *toget;
2778 bprr->format = req->preferredRecordSyntax;
2780 bprr->referenceId = req->referenceId;
2781 bprr->stream = assoc->encode;
2782 bprr->print = assoc->print;
2783 bprr->request = reqb;
2784 bprr->association = assoc;
2786 bprr->errstring = NULL;
2787 (*assoc->init->bend_present)(assoc->backend, bprr);
2793 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2794 *resp->presentStatus = Z_PresentStatus_failure;
2799 resp->records = pack_records(
2800 assoc, req->resultSetName, 1,
2801 toget, compp, next, presst, req->referenceId,
2802 req->preferredRecordSyntax, NULL);
2805 resp->numberOfRecordsReturned = toget;
2806 returnedrecs = *toget;
2807 resp->presentStatus = presst;
2811 if (*resp->resultCount)
2813 resp->numberOfRecordsReturned = nulint;
2814 resp->presentStatus = 0;
2816 resp->nextResultSetPosition = next;
2817 resp->searchStatus = sr;
2818 resp->resultSetStatus = 0;
2819 if (bsrt->estimated_hit_count)
2821 resp->resultSetStatus = odr_intdup(assoc->encode,
2822 Z_SearchResponse_estimate);
2824 else if (bsrt->partial_resultset)
2826 resp->resultSetStatus = odr_intdup(assoc->encode,
2827 Z_SearchResponse_subset);
2830 resp->additionalSearchInfo = bsrt->search_info;
2835 WRBUF wr = wrbuf_alloc();
2837 for (i = 0 ; i < req->num_databaseNames; i++){
2839 wrbuf_printf(wr, "+");
2840 wrbuf_printf(wr, req->databaseNames[i]);
2842 wrbuf_printf(wr, " ");
2845 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2847 wrbuf_printf(wr, "OK %d", bsrt->hits);
2848 wrbuf_printf(wr, " %s 1+%d ",
2849 req->resultSetName, returnedrecs);
2850 yaz_query_to_wrbuf(wr, req->query);
2852 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2859 * Maybe we got a little over-friendly when we designed bend_fetch to
2860 * get only one record at a time. Some backends can optimise multiple-record
2861 * fetches, and at any rate, there is some overhead involved in
2862 * all that selecting and hopping around. Problem is, of course, that the
2863 * frontend can't know ahead of time how many records it'll need to
2864 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2865 * is downright lousy as a bulk data transfer protocol.
2867 * To start with, we'll do the fetching of records from the backend
2868 * in one operation: To save some trips in and out of the event-handler,
2869 * and to simplify the interface to pack_records. At any rate, asynch
2870 * operation is more fun in operations that have an unpredictable execution
2871 * speed - which is normally more true for search than for present.
2873 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2876 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2878 Z_PresentResponse *resp;
2882 const char *errstring = 0;
2884 yaz_log(log_requestdetail, "Got PresentRequest.");
2886 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2888 resp->presentStatus = odr_intdup(assoc->encode, 0);
2889 if (assoc->init->bend_present)
2891 bend_present_rr *bprr = (bend_present_rr *)
2892 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2893 bprr->setname = req->resultSetId;
2894 bprr->start = *req->resultSetStartPoint;
2895 bprr->number = *req->numberOfRecordsRequested;
2896 bprr->format = req->preferredRecordSyntax;
2897 bprr->comp = req->recordComposition;
2898 bprr->referenceId = req->referenceId;
2899 bprr->stream = assoc->encode;
2900 bprr->print = assoc->print;
2901 bprr->request = reqb;
2902 bprr->association = assoc;
2904 bprr->errstring = NULL;
2905 (*assoc->init->bend_present)(assoc->backend, bprr);
2908 return 0; /* should not happen */
2911 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2912 *resp->presentStatus = Z_PresentStatus_failure;
2913 errcode = bprr->errcode;
2914 errstring = bprr->errstring;
2917 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2918 next = odr_intdup(assoc->encode, 0);
2919 num = odr_intdup(assoc->encode, 0);
2921 apdu->which = Z_APDU_presentResponse;
2922 apdu->u.presentResponse = resp;
2923 resp->referenceId = req->referenceId;
2924 resp->otherInfo = 0;
2928 *num = *req->numberOfRecordsRequested;
2930 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2931 num, req->recordComposition, next,
2932 resp->presentStatus,
2933 req->referenceId, req->preferredRecordSyntax,
2938 WRBUF wr = wrbuf_alloc();
2939 wrbuf_printf(wr, "Present ");
2941 if (*resp->presentStatus == Z_PresentStatus_failure)
2942 wrbuf_printf(wr, "ERROR %d ", errcode);
2943 else if (*resp->presentStatus == Z_PresentStatus_success)
2944 wrbuf_printf(wr, "OK - ");
2946 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2948 wrbuf_printf(wr, " %s %d+%d ",
2949 req->resultSetId, *req->resultSetStartPoint,
2950 *req->numberOfRecordsRequested);
2951 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2956 resp->numberOfRecordsReturned = num;
2957 resp->nextResultSetPosition = next;
2963 * Scan was implemented rather in a hurry, and with support for only the basic
2964 * elements of the service in the backend API. Suggestions are welcome.
2966 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2968 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2969 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2970 Z_ScanResponse *res = (Z_ScanResponse *)
2971 odr_malloc(assoc->encode, sizeof(*res));
2972 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2973 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2974 Z_ListEntries *ents = (Z_ListEntries *)
2975 odr_malloc(assoc->encode, sizeof(*ents));
2976 Z_DiagRecs *diagrecs_p = NULL;
2977 bend_scan_rr *bsrr = (bend_scan_rr *)
2978 odr_malloc(assoc->encode, sizeof(*bsrr));
2979 struct scan_entry *save_entries;
2981 yaz_log(log_requestdetail, "Got ScanRequest");
2983 apdu->which = Z_APDU_scanResponse;
2984 apdu->u.scanResponse = res;
2985 res->referenceId = req->referenceId;
2987 /* if step is absent, set it to 0 */
2988 res->stepSize = odr_intdup(assoc->encode, 0);
2990 *res->stepSize = *req->stepSize;
2992 res->scanStatus = scanStatus;
2993 res->numberOfEntriesReturned = numberOfEntriesReturned;
2994 res->positionOfTerm = 0;
2995 res->entries = ents;
2996 ents->num_entries = 0;
2997 ents->entries = NULL;
2998 ents->num_nonsurrogateDiagnostics = 0;
2999 ents->nonsurrogateDiagnostics = NULL;
3000 res->attributeSet = 0;
3003 if (req->databaseNames)
3006 for (i = 0; i < req->num_databaseNames; i++)
3007 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
3009 bsrr->scanClause = 0;
3011 bsrr->errstring = 0;
3012 bsrr->num_bases = req->num_databaseNames;
3013 bsrr->basenames = req->databaseNames;
3014 bsrr->num_entries = *req->numberOfTermsRequested;
3015 bsrr->term = req->termListAndStartPoint;
3016 bsrr->referenceId = req->referenceId;
3017 bsrr->stream = assoc->encode;
3018 bsrr->print = assoc->print;
3019 bsrr->step_size = res->stepSize;
3020 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
3021 yaz_oid_userinfo_scan_set, 1, 0);
3023 /* For YAZ 2.0 and earlier it was the backend handler that
3024 initialized entries (member display_term did not exist)
3025 YAZ 2.0 and later sets 'entries' and initialize all members
3026 including 'display_term'. If YAZ 2.0 or later sees that
3027 entries was modified - we assume that it is an old handler and
3028 that 'display_term' is _not_ set.
3030 if (bsrr->num_entries > 0)
3033 bsrr->entries = (struct scan_entry *)
3034 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3036 for (i = 0; i<bsrr->num_entries; i++)
3038 bsrr->entries[i].term = 0;
3039 bsrr->entries[i].occurrences = 0;
3040 bsrr->entries[i].errcode = 0;
3041 bsrr->entries[i].errstring = 0;
3042 bsrr->entries[i].display_term = 0;
3045 save_entries = bsrr->entries; /* save it so we can compare later */
3047 bsrr->attributeset = req->attributeSet;
3048 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3049 bsrr->attributeset);
3050 bsrr->term_position = req->preferredPositionInResponse ?
3051 *req->preferredPositionInResponse : 1;
3053 ((int (*)(void *, bend_scan_rr *))
3054 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3057 diagrecs_p = zget_DiagRecs(assoc->encode,
3058 bsrr->errcode, bsrr->errstring);
3062 Z_Entry **tab = (Z_Entry **)
3063 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3065 if (bsrr->status == BEND_SCAN_PARTIAL)
3066 *scanStatus = Z_Scan_partial_5;
3068 *scanStatus = Z_Scan_success;
3069 ents->entries = tab;
3070 ents->num_entries = bsrr->num_entries;
3071 res->numberOfEntriesReturned = &ents->num_entries;
3072 res->positionOfTerm = &bsrr->term_position;
3073 for (i = 0; i < bsrr->num_entries; i++)
3079 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3080 if (bsrr->entries[i].occurrences >= 0)
3082 e->which = Z_Entry_termInfo;
3083 e->u.termInfo = t = (Z_TermInfo *)
3084 odr_malloc(assoc->encode, sizeof(*t));
3085 t->suggestedAttributes = 0;
3087 if (save_entries == bsrr->entries &&
3088 bsrr->entries[i].display_term)
3090 /* the entries was _not_ set by the handler. So it's
3091 safe to test for new member display_term. It is
3094 t->displayTerm = odr_strdup(assoc->encode,
3095 bsrr->entries[i].display_term);
3097 t->alternativeTerm = 0;
3098 t->byAttributes = 0;
3099 t->otherTermInfo = 0;
3100 t->globalOccurrences = &bsrr->entries[i].occurrences;
3101 t->term = (Z_Term *)
3102 odr_malloc(assoc->encode, sizeof(*t->term));
3103 t->term->which = Z_Term_general;
3104 t->term->u.general = o =
3105 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3106 o->buf = (unsigned char *)
3107 odr_malloc(assoc->encode, o->len = o->size =
3108 strlen(bsrr->entries[i].term));
3109 memcpy(o->buf, bsrr->entries[i].term, o->len);
3110 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3111 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3115 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3116 bsrr->entries[i].errcode,
3117 bsrr->entries[i].errstring);
3118 assert(drecs->num_diagRecs == 1);
3119 e->which = Z_Entry_surrogateDiagnostic;
3120 assert(drecs->diagRecs[0]);
3121 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3127 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3128 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3133 WRBUF wr = wrbuf_alloc();
3134 wrbuf_printf(wr, "Scan ");
3135 for (i = 0 ; i < req->num_databaseNames; i++)
3138 wrbuf_printf(wr, "+");
3139 wrbuf_printf(wr, req->databaseNames[i]);
3142 wrbuf_printf(wr, " ");
3145 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3147 wrbuf_printf(wr, "OK");
3149 wrbuf_printf(wr, " %d - %d+%d+%d",
3150 res->numberOfEntriesReturned ?
3151 *res->numberOfEntriesReturned : 0,
3152 (req->preferredPositionInResponse ?
3153 *req->preferredPositionInResponse : 1),
3154 *req->numberOfTermsRequested,
3155 (res->stepSize ? *res->stepSize : 1));
3158 wrbuf_printf(wr, "+%s", bsrr->setname);
3160 wrbuf_printf(wr, " ");
3161 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3162 bsrr->attributeset);
3163 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3169 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3173 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3174 Z_SortResponse *res = (Z_SortResponse *)
3175 odr_malloc(assoc->encode, sizeof(*res));
3176 bend_sort_rr *bsrr = (bend_sort_rr *)
3177 odr_malloc(assoc->encode, sizeof(*bsrr));
3179 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3181 yaz_log(log_requestdetail, "Got SortRequest.");
3183 bsrr->num_input_setnames = req->num_inputResultSetNames;
3184 for (i=0;i<req->num_inputResultSetNames;i++)
3185 yaz_log(log_requestdetail, "Input resultset: '%s'",
3186 req->inputResultSetNames[i]);
3187 bsrr->input_setnames = req->inputResultSetNames;
3188 bsrr->referenceId = req->referenceId;
3189 bsrr->output_setname = req->sortedResultSetName;
3190 yaz_log(log_requestdetail, "Output resultset: '%s'",
3191 req->sortedResultSetName);
3192 bsrr->sort_sequence = req->sortSequence;
3193 /*FIXME - dump those sequences too */
3194 bsrr->stream = assoc->encode;
3195 bsrr->print = assoc->print;
3197 bsrr->sort_status = Z_SortResponse_failure;
3199 bsrr->errstring = 0;
3201 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3203 res->referenceId = bsrr->referenceId;
3204 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3205 res->resultSetStatus = 0;
3208 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3209 bsrr->errcode, bsrr->errstring);
3210 res->diagnostics = dr->diagRecs;
3211 res->num_diagnostics = dr->num_diagRecs;
3215 res->num_diagnostics = 0;
3216 res->diagnostics = 0;
3218 res->resultCount = 0;
3221 apdu->which = Z_APDU_sortResponse;
3222 apdu->u.sortResponse = res;
3225 WRBUF wr = wrbuf_alloc();
3226 wrbuf_printf(wr, "Sort ");
3228 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3230 wrbuf_printf(wr, "OK -");
3231 wrbuf_printf(wr, " (");
3232 for (i = 0; i<req->num_inputResultSetNames; i++)
3235 wrbuf_printf(wr, "+");
3236 wrbuf_printf(wr, req->inputResultSetNames[i]);
3238 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3240 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3246 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3250 Z_DeleteResultSetRequest *req =
3251 reqb->apdu_request->u.deleteResultSetRequest;
3252 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3253 odr_malloc(assoc->encode, sizeof(*res));
3254 bend_delete_rr *bdrr = (bend_delete_rr *)
3255 odr_malloc(assoc->encode, sizeof(*bdrr));
3256 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3258 yaz_log(log_requestdetail, "Got DeleteRequest.");
3260 bdrr->num_setnames = req->num_resultSetList;
3261 bdrr->setnames = req->resultSetList;
3262 for (i = 0; i<req->num_resultSetList; i++)
3263 yaz_log(log_requestdetail, "resultset: '%s'",
3264 req->resultSetList[i]);
3265 bdrr->stream = assoc->encode;
3266 bdrr->print = assoc->print;
3267 bdrr->function = *req->deleteFunction;
3268 bdrr->referenceId = req->referenceId;
3270 if (bdrr->num_setnames > 0)
3272 bdrr->statuses = (int*)
3273 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3274 bdrr->num_setnames);
3275 for (i = 0; i < bdrr->num_setnames; i++)
3276 bdrr->statuses[i] = 0;
3278 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3280 res->referenceId = req->referenceId;
3282 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3284 res->deleteListStatuses = 0;
3285 if (bdrr->num_setnames > 0)
3288 res->deleteListStatuses = (Z_ListStatuses *)
3289 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3290 res->deleteListStatuses->num = bdrr->num_setnames;
3291 res->deleteListStatuses->elements =
3293 odr_malloc(assoc->encode,
3294 sizeof(*res->deleteListStatuses->elements) *
3295 bdrr->num_setnames);
3296 for (i = 0; i<bdrr->num_setnames; i++)
3298 res->deleteListStatuses->elements[i] =
3300 odr_malloc(assoc->encode,
3301 sizeof(**res->deleteListStatuses->elements));
3302 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3303 res->deleteListStatuses->elements[i]->id =
3304 odr_strdup(assoc->encode, bdrr->setnames[i]);
3307 res->numberNotDeleted = 0;
3308 res->bulkStatuses = 0;
3309 res->deleteMessage = 0;
3312 apdu->which = Z_APDU_deleteResultSetResponse;
3313 apdu->u.deleteResultSetResponse = res;
3316 WRBUF wr = wrbuf_alloc();
3317 wrbuf_printf(wr, "Delete ");
3318 if (bdrr->delete_status)
3319 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3321 wrbuf_printf(wr, "OK -");
3322 for (i = 0; i<req->num_resultSetList; i++)
3323 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3324 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3330 static void process_close(association *assoc, request *reqb)
3332 Z_Close *req = reqb->apdu_request->u.close;
3333 static char *reasons[] =
3340 "securityViolation",
3347 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3348 reasons[*req->closeReason], req->diagnosticInformation ?
3349 req->diagnosticInformation : "NULL");
3350 if (assoc->version < 3) /* to make do_force respond with close */
3352 do_close_req(assoc, Z_Close_finished,
3353 "Association terminated by client", reqb);
3354 yaz_log(log_request,"Close OK");
3357 void save_referenceId(request *reqb, Z_ReferenceId *refid)
3361 reqb->len_refid = refid->len;
3362 reqb->refid = (char *)nmem_malloc(reqb->request_mem, refid->len);
3363 memcpy(reqb->refid, refid->buf, refid->len);
3367 reqb->len_refid = 0;
3372 void bend_request_send(bend_association a, bend_request req, Z_APDU *res)
3374 process_z_response(a, req, res);
3377 bend_request bend_request_mk(bend_association a)
3379 request *nreq = request_get(&a->outgoing);
3380 nreq->request_mem = nmem_create();
3384 Z_ReferenceId *bend_request_getid(ODR odr, bend_request req)
3389 id = (Odr_oct *)odr_malloc(odr, sizeof(*odr));
3390 id->buf = (unsigned char *)odr_malloc(odr, req->len_refid);
3391 id->len = id->size = req->len_refid;
3392 memcpy(id->buf, req->refid, req->len_refid);
3396 void bend_request_destroy(bend_request *req)
3398 nmem_destroy((*req)->request_mem);
3399 request_release(*req);
3403 int bend_backend_respond(bend_association a, bend_request req)
3407 r = process_z_request(a, req, &msg);
3409 yaz_log(YLOG_WARN, "%s", msg);
3413 void bend_request_setdata(bend_request r, void *p)
3418 void *bend_request_getdata(bend_request r)
3420 return r->clientData;
3423 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3425 bend_segment_rr req;
3427 req.segment = reqb->apdu_request->u.segmentRequest;
3428 req.stream = assoc->encode;
3429 req.decode = assoc->decode;
3430 req.print = assoc->print;
3431 req.association = assoc;
3433 (*assoc->init->bend_segment)(assoc->backend, &req);
3438 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3440 bend_esrequest_rr esrequest;
3441 const char *ext_name = "unknown";
3443 Z_ExtendedServicesRequest *req =
3444 reqb->apdu_request->u.extendedServicesRequest;
3445 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3447 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3449 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3450 esrequest.stream = assoc->encode;
3451 esrequest.decode = assoc->decode;
3452 esrequest.print = assoc->print;
3453 esrequest.errcode = 0;
3454 esrequest.errstring = NULL;
3455 esrequest.request = reqb;
3456 esrequest.association = assoc;
3457 esrequest.taskPackage = 0;
3458 esrequest.referenceId = req->referenceId;
3461 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3463 switch(esrequest.esr->taskSpecificParameters->which)
3465 case Z_External_itemOrder:
3466 ext_name = "ItemOrder"; break;
3467 case Z_External_update:
3468 ext_name = "Update"; break;
3469 case Z_External_update0:
3470 ext_name = "Update0"; break;
3471 case Z_External_ESAdmin:
3472 ext_name = "Admin"; break;
3477 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3479 /* If the response is being delayed, return NULL */
3480 if (esrequest.request == NULL)
3483 resp->referenceId = req->referenceId;
3485 if (esrequest.errcode == -1)
3487 /* Backend service indicates request will be processed */
3488 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3489 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3491 else if (esrequest.errcode == 0)
3493 /* Backend service indicates request will be processed */
3494 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3495 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3499 Z_DiagRecs *diagRecs =
3500 zget_DiagRecs(assoc->encode, esrequest.errcode,
3501 esrequest.errstring);
3502 /* Backend indicates error, request will not be processed */
3503 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3504 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3505 resp->num_diagnostics = diagRecs->num_diagRecs;
3506 resp->diagnostics = diagRecs->diagRecs;
3509 WRBUF wr = wrbuf_alloc();
3510 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3511 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3516 /* Do something with the members of bend_extendedservice */
3517 if (esrequest.taskPackage)
3519 resp->taskPackage = z_ext_record_oid(
3520 assoc->encode, yaz_oid_recsyn_extended,
3521 (const char *) esrequest.taskPackage, -1);
3523 yaz_log(YLOG_DEBUG,"Send the result apdu");
3527 int bend_assoc_is_alive(bend_association assoc)
3529 if (assoc->state == ASSOC_DEAD)
3530 return 0; /* already marked as dead. Don't check I/O chan anymore */
3532 return iochan_is_alive(assoc->client_chan);
3539 * indent-tabs-mode: nil
3541 * vim: shiftwidth=4 tabstop=8 expandtab