1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2009 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;
512 assoc->init->named_result_sets = 0;
514 assoc->init->charneg_request = NULL;
515 assoc->init->charneg_response = NULL;
517 assoc->init->decode = assoc->decode;
518 assoc->init->peer_name =
519 odr_strdup(assoc->encode, cs_addrstr(assoc->client_link));
521 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
524 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
526 statserv_options_block *cb = statserv_getcontrol();
529 const char *encoding = "UTF-8";
531 bend_initresult *binitres;
533 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
534 assoc_init_reset(assoc);
538 Z_IdAuthentication *auth = (Z_IdAuthentication *)
539 odr_malloc(assoc->decode, sizeof(*auth));
542 len = strlen(sr->username) + 1;
544 len += strlen(sr->password) + 2;
545 auth->which = Z_IdAuthentication_open;
546 auth->u.open = (char *) odr_malloc(assoc->decode, len);
547 strcpy(auth->u.open, sr->username);
548 if (sr->password && *sr->password)
550 strcat(auth->u.open, "/");
551 strcat(auth->u.open, sr->password);
553 assoc->init->auth = auth;
557 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
558 assoc->init->charneg_request = ce->u.charNeg3;
561 if (!(binitres = (*cb->bend_init)(assoc->init)))
563 assoc->state = ASSOC_DEAD;
564 yaz_add_srw_diagnostic(assoc->encode, d, num,
565 YAZ_SRW_AUTHENTICATION_ERROR, 0);
568 assoc->backend = binitres->handle;
569 assoc->init->auth = 0;
570 if (binitres->errcode)
572 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
573 assoc->state = ASSOC_DEAD;
574 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
575 binitres->errstring);
583 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
586 yaz_record_conv_t rc = 0;
587 const char *match_schema = 0;
588 Odr_oid *match_syntax = 0;
593 const char *input_schema = yaz_get_esn(rr->comp);
594 Odr_oid *input_syntax_raw = rr->request_format;
596 const char *backend_schema = 0;
597 Odr_oid *backend_syntax = 0;
599 r = yaz_retrieval_request(assoc->server->retrieval,
607 if (r == -1) /* error ? */
609 const char *details = yaz_retrieval_get_error(
610 assoc->server->retrieval);
612 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
614 rr->errstring = odr_strdup(rr->stream, details);
617 else if (r == 1 || r == 3)
619 const char *details = input_schema;
621 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
623 rr->errstring = odr_strdup(rr->stream, details);
628 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
629 if (input_syntax_raw)
631 char oidbuf[OID_STR_MAX];
632 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
633 rr->errstring = odr_strdup(rr->stream, oidbuf);
639 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
642 rr->request_format = backend_syntax;
644 (*assoc->init->bend_fetch)(assoc->backend, rr);
645 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
646 { /* post conversion must take place .. */
647 WRBUF output_record = wrbuf_alloc();
648 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
651 const char *details = yaz_record_conv_get_error(rc);
652 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
654 rr->errstring = odr_strdup(rr->stream, details);
658 rr->len = wrbuf_len(output_record);
659 rr->record = (char *) odr_malloc(rr->stream, rr->len);
660 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
662 wrbuf_destroy(output_record);
665 rr->output_format = match_syntax;
667 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 "
977 start, number, rr.hits);
979 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
982 srw_res->resultSetId =
983 odr_strdup(assoc->encode, rr.srw_setname );
984 srw_res->resultSetIdleTime =
985 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
988 if (start > rr.hits || start < 1)
990 /* if hits<=0 and start=1 we don't return a diagnostic */
992 yaz_add_srw_diagnostic(
994 &srw_res->diagnostics, &srw_res->num_diagnostics,
995 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1001 if (start + number > rr.hits)
1002 number = rr.hits - start + 1;
1004 /* Call bend_present if defined */
1005 if (assoc->init->bend_present)
1007 bend_present_rr *bprr = (bend_present_rr*)
1008 odr_malloc(assoc->decode, sizeof(*bprr));
1009 bprr->setname = "default";
1010 bprr->start = start;
1011 bprr->number = number;
1012 if (srw_req->recordSchema)
1014 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1015 sizeof(*bprr->comp));
1016 bprr->comp->which = Z_RecordComp_simple;
1017 bprr->comp->u.simple = (Z_ElementSetNames *)
1018 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1019 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1020 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1026 bprr->stream = assoc->encode;
1027 bprr->referenceId = 0;
1028 bprr->print = assoc->print;
1029 bprr->request = req;
1030 bprr->association = assoc;
1032 bprr->errstring = NULL;
1033 (*assoc->init->bend_present)(assoc->backend, bprr);
1039 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1040 yaz_add_srw_diagnostic(assoc->encode,
1041 &srw_res->diagnostics,
1042 &srw_res->num_diagnostics,
1043 srw_error, bprr->errstring);
1051 int packing = Z_SRW_recordPacking_string;
1052 if (srw_req->recordPacking)
1055 yaz_srw_str_to_pack(srw_req->recordPacking);
1057 packing = Z_SRW_recordPacking_string;
1059 srw_res->records = (Z_SRW_record *)
1060 odr_malloc(assoc->encode,
1061 number * sizeof(*srw_res->records));
1063 srw_res->extra_records = (Z_SRW_extra_record **)
1064 odr_malloc(assoc->encode,
1065 number*sizeof(*srw_res->extra_records));
1067 for (i = 0; i<number; i++)
1070 const char *addinfo = 0;
1072 srw_res->records[j].recordPacking = packing;
1073 srw_res->records[j].recordData_buf = 0;
1074 srw_res->extra_records[j] = 0;
1075 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1076 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1077 srw_res->records + j,
1081 yaz_add_srw_diagnostic(assoc->encode,
1082 &srw_res->diagnostics,
1083 &srw_res->num_diagnostics,
1084 yaz_diag_bib1_to_srw(errcode),
1089 if (srw_res->records[j].recordData_buf)
1092 srw_res->num_records = j;
1094 srw_res->records = 0;
1097 if (rr.estimated_hit_count || rr.partial_resultset)
1099 yaz_add_srw_diagnostic(
1101 &srw_res->diagnostics,
1102 &srw_res->num_diagnostics,
1103 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1111 const char *querystr = "?";
1112 const char *querytype = "?";
1113 WRBUF wr = wrbuf_alloc();
1115 switch (srw_req->query_type)
1117 case Z_SRW_query_type_cql:
1119 querystr = srw_req->query.cql;
1121 case Z_SRW_query_type_pqf:
1123 querystr = srw_req->query.pqf;
1126 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1127 if (srw_res->num_diagnostics)
1128 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1129 else if (*http_code != 200)
1130 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1131 else if (srw_res->numberOfRecords)
1133 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1134 (srw_res->numberOfRecords ?
1135 *srw_res->numberOfRecords : 0));
1137 wrbuf_printf(wr, " %s " ODR_INT_PRINTF " +%d",
1138 (srw_res->resultSetId ?
1139 srw_res->resultSetId : "-"),
1140 (srw_req->startRecord ? *srw_req->startRecord : 1),
1141 srw_res->num_records);
1142 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1147 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1150 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1153 for (ptr = ptr->children; ptr; ptr = ptr->next)
1155 if (ptr->type != XML_ELEMENT_NODE)
1157 if (!strcmp((const char *) ptr->name, "explain"))
1160 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1164 ptr = xmlCopyNode(ptr, 1);
1166 xmlDocSetRootElement(doc, ptr);
1168 xmlDocDumpMemory(doc, &buf_out, &len);
1169 content = (char*) odr_malloc(rr->stream, 1+len);
1170 memcpy(content, buf_out, len);
1171 content[len] = '\0';
1175 rr->explain_buf = content;
1183 static void srw_bend_explain(association *assoc, request *req,
1185 Z_SRW_explainResponse *srw_res,
1188 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1189 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1191 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1196 rr.stream = assoc->encode;
1197 rr.decode = assoc->decode;
1198 rr.print = assoc->print;
1200 rr.database = srw_req->database;
1202 rr.server_node_ptr = assoc->server->server_node_ptr;
1204 rr.server_node_ptr = 0;
1205 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1206 if (assoc->init->bend_explain)
1207 (*assoc->init->bend_explain)(assoc->backend, &rr);
1209 srw_bend_explain_default(assoc->backend, &rr);
1213 int packing = Z_SRW_recordPacking_string;
1214 if (srw_req->recordPacking)
1217 yaz_srw_str_to_pack(srw_req->recordPacking);
1219 packing = Z_SRW_recordPacking_string;
1221 srw_res->record.recordSchema = rr.schema;
1222 srw_res->record.recordPacking = packing;
1223 srw_res->record.recordData_buf = rr.explain_buf;
1224 srw_res->record.recordData_len = strlen(rr.explain_buf);
1225 srw_res->record.recordPosition = 0;
1231 static void srw_bend_scan(association *assoc, request *req,
1233 Z_SRW_scanResponse *srw_res,
1236 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1237 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1240 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1241 if (srw_res->num_diagnostics == 0 && assoc->init)
1243 struct scan_entry *save_entries;
1245 bend_scan_rr *bsrr = (bend_scan_rr *)
1246 odr_malloc(assoc->encode, sizeof(*bsrr));
1247 bsrr->num_bases = 1;
1248 bsrr->basenames = &srw_req->database;
1250 bsrr->num_entries = srw_req->maximumTerms ?
1251 *srw_req->maximumTerms : 10;
1252 bsrr->term_position = srw_req->responsePosition ?
1253 *srw_req->responsePosition : 1;
1256 bsrr->errstring = 0;
1257 bsrr->referenceId = 0;
1258 bsrr->stream = assoc->encode;
1259 bsrr->print = assoc->print;
1260 bsrr->step_size = odr_intdup(assoc->decode, 0);
1264 if (bsrr->num_entries > 0)
1267 bsrr->entries = (struct scan_entry *)
1268 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1270 for (i = 0; i<bsrr->num_entries; i++)
1272 bsrr->entries[i].term = 0;
1273 bsrr->entries[i].occurrences = 0;
1274 bsrr->entries[i].errcode = 0;
1275 bsrr->entries[i].errstring = 0;
1276 bsrr->entries[i].display_term = 0;
1279 save_entries = bsrr->entries; /* save it so we can compare later */
1281 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1282 assoc->init->bend_scan)
1284 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1286 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1287 &bsrr->attributeset,
1288 srw_req->scanClause.pqf);
1289 yaz_pqf_destroy(pqf_parser);
1290 bsrr->scanClause = 0;
1291 ((int (*)(void *, bend_scan_rr *))
1292 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1294 else if (srw_req->query_type == Z_SRW_query_type_cql
1295 && assoc->init->bend_scan && assoc->server
1296 && assoc->server->cql_transform)
1299 bsrr->scanClause = 0;
1300 bsrr->attributeset = 0;
1301 bsrr->term = (Z_AttributesPlusTerm *)
1302 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1303 srw_error = cql2pqf_scan(assoc->encode,
1304 srw_req->scanClause.cql,
1305 assoc->server->cql_transform,
1308 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1309 &srw_res->num_diagnostics,
1313 ((int (*)(void *, bend_scan_rr *))
1314 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1317 else if (srw_req->query_type == Z_SRW_query_type_cql
1318 && assoc->init->bend_srw_scan)
1321 bsrr->attributeset = 0;
1322 bsrr->scanClause = srw_req->scanClause.cql;
1323 ((int (*)(void *, bend_scan_rr *))
1324 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1328 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1329 &srw_res->num_diagnostics,
1330 YAZ_SRW_UNSUPP_OPERATION, "scan");
1335 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1340 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1342 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1343 &srw_res->num_diagnostics,
1344 srw_error, bsrr->errstring);
1346 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1349 srw_res->terms = (Z_SRW_scanTerm*)
1350 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1353 srw_res->num_terms = bsrr->num_entries;
1354 for (i = 0; i<bsrr->num_entries; i++)
1356 Z_SRW_scanTerm *t = srw_res->terms + i;
1357 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1358 t->numberOfRecords =
1359 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1361 if (save_entries == bsrr->entries &&
1362 bsrr->entries[i].display_term)
1364 /* the entries was _not_ set by the handler. So it's
1365 safe to test for new member display_term. It is
1368 t->displayTerm = odr_strdup(assoc->encode,
1369 bsrr->entries[i].display_term);
1377 WRBUF wr = wrbuf_alloc();
1378 const char *querytype = 0;
1379 const char *querystr = 0;
1381 switch(srw_req->query_type)
1383 case Z_SRW_query_type_pqf:
1385 querystr = srw_req->scanClause.pqf;
1387 case Z_SRW_query_type_cql:
1389 querystr = srw_req->scanClause.cql;
1392 querytype = "UNKNOWN";
1396 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1398 if (srw_res->num_diagnostics)
1399 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1400 else if (srw_res->num_terms)
1401 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1403 wrbuf_printf(wr, "OK - - ");
1405 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1406 (srw_req->responsePosition ?
1407 *srw_req->responsePosition : 1),
1408 (srw_req->maximumTerms ?
1409 *srw_req->maximumTerms : 1));
1410 /* there is no step size in SRU/W ??? */
1411 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1412 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1418 static void srw_bend_update(association *assoc, request *req,
1420 Z_SRW_updateResponse *srw_res,
1423 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1424 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1425 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1427 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1431 Z_SRW_extra_record *extra = srw_req->extra_record;
1433 rr.stream = assoc->encode;
1434 rr.print = assoc->print;
1436 rr.basenames = &srw_req->database;
1437 rr.operation = srw_req->operation;
1438 rr.operation_status = "failed";
1440 rr.record_versions = 0;
1441 rr.num_versions = 0;
1442 rr.record_packing = "string";
1443 rr.record_schema = 0;
1445 rr.extra_record_data = 0;
1446 rr.extra_request_data = 0;
1447 rr.extra_response_data = 0;
1453 if (rr.operation == 0)
1455 yaz_add_sru_update_diagnostic(
1456 assoc->encode, &srw_res->diagnostics,
1457 &srw_res->num_diagnostics,
1458 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1462 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1463 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1464 if (!strcmp( rr.operation, "delete"))
1466 if (srw_req->record && !srw_req->record->recordSchema)
1468 rr.record_schema = odr_strdup(
1470 srw_req->record->recordSchema);
1472 if (srw_req->record)
1474 rr.record_data = odr_strdupn(
1476 srw_req->record->recordData_buf,
1477 srw_req->record->recordData_len );
1479 if (extra && extra->extraRecordData_len)
1481 rr.extra_record_data = odr_strdupn(
1483 extra->extraRecordData_buf,
1484 extra->extraRecordData_len );
1486 if (srw_req->recordId)
1487 rr.record_id = srw_req->recordId;
1488 else if (extra && extra->recordIdentifier)
1489 rr.record_id = extra->recordIdentifier;
1491 else if (!strcmp(rr.operation, "replace"))
1493 if (srw_req->recordId)
1494 rr.record_id = srw_req->recordId;
1495 else if (extra && extra->recordIdentifier)
1496 rr.record_id = extra->recordIdentifier;
1499 yaz_add_sru_update_diagnostic(
1500 assoc->encode, &srw_res->diagnostics,
1501 &srw_res->num_diagnostics,
1502 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1503 "recordIdentifier");
1505 if (!srw_req->record)
1507 yaz_add_sru_update_diagnostic(
1508 assoc->encode, &srw_res->diagnostics,
1509 &srw_res->num_diagnostics,
1510 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1515 if (srw_req->record->recordSchema)
1516 rr.record_schema = odr_strdup(
1517 assoc->encode, srw_req->record->recordSchema);
1518 if (srw_req->record->recordData_len )
1520 rr.record_data = odr_strdupn(assoc->encode,
1521 srw_req->record->recordData_buf,
1522 srw_req->record->recordData_len );
1526 yaz_add_sru_update_diagnostic(
1527 assoc->encode, &srw_res->diagnostics,
1528 &srw_res->num_diagnostics,
1529 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1533 if (extra && extra->extraRecordData_len)
1535 rr.extra_record_data = odr_strdupn(
1537 extra->extraRecordData_buf,
1538 extra->extraRecordData_len );
1541 else if (!strcmp(rr.operation, "insert"))
1543 if (srw_req->recordId)
1544 rr.record_id = srw_req->recordId;
1546 rr.record_id = extra->recordIdentifier;
1548 if (srw_req->record)
1550 if (srw_req->record->recordSchema)
1551 rr.record_schema = odr_strdup(
1552 assoc->encode, srw_req->record->recordSchema);
1554 if (srw_req->record->recordData_len)
1555 rr.record_data = odr_strdupn(
1557 srw_req->record->recordData_buf,
1558 srw_req->record->recordData_len );
1560 if (extra && extra->extraRecordData_len)
1562 rr.extra_record_data = odr_strdupn(
1564 extra->extraRecordData_buf,
1565 extra->extraRecordData_len );
1569 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1570 &srw_res->num_diagnostics,
1571 YAZ_SRU_UPDATE_INVALID_ACTION,
1574 if (srw_req->record)
1576 const char *pack_str =
1577 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1579 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1582 if (srw_req->num_recordVersions)
1584 rr.record_versions = srw_req->recordVersions;
1585 rr.num_versions = srw_req->num_recordVersions;
1587 if (srw_req->extraRequestData_len)
1589 rr.extra_request_data = odr_strdupn(assoc->encode,
1590 srw_req->extraRequestData_buf,
1591 srw_req->extraRequestData_len );
1593 if (srw_res->num_diagnostics == 0)
1595 if ( assoc->init->bend_srw_update)
1596 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1598 yaz_add_sru_update_diagnostic(
1599 assoc->encode, &srw_res->diagnostics,
1600 &srw_res->num_diagnostics,
1601 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1602 "No Update backend handler");
1606 yaz_add_srw_diagnostic_uri(assoc->encode,
1607 &srw_res->diagnostics,
1608 &srw_res->num_diagnostics,
1612 srw_res->recordId = rr.record_id;
1613 srw_res->operationStatus = rr.operation_status;
1614 srw_res->recordVersions = rr.record_versions;
1615 srw_res->num_recordVersions = rr.num_versions;
1616 if (srw_res->extraResponseData_len)
1618 srw_res->extraResponseData_buf = rr.extra_response_data;
1619 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1621 if (srw_res->num_diagnostics == 0 && rr.record_data)
1623 srw_res->record = yaz_srw_get_record(assoc->encode);
1624 srw_res->record->recordSchema = rr.record_schema;
1625 if (rr.record_packing)
1627 int pack = yaz_srw_str_to_pack(rr.record_packing);
1631 pack = Z_SRW_recordPacking_string;
1632 yaz_log(YLOG_WARN, "Back packing %s from backend",
1635 srw_res->record->recordPacking = pack;
1637 srw_res->record->recordData_buf = rr.record_data;
1638 srw_res->record->recordData_len = strlen(rr.record_data);
1639 if (rr.extra_record_data)
1641 Z_SRW_extra_record *ex =
1642 yaz_srw_get_extra_record(assoc->encode);
1643 srw_res->extra_record = ex;
1644 ex->extraRecordData_buf = rr.extra_record_data;
1645 ex->extraRecordData_len = strlen(rr.extra_record_data);
1651 /* check if path is OK (1); BAD (0) */
1652 static int check_path(const char *path)
1656 if (strstr(path, ".."))
1661 static char *read_file(const char *fname, ODR o, size_t *sz)
1664 FILE *inf = fopen(fname, "rb");
1668 fseek(inf, 0L, SEEK_END);
1671 buf = (char *) odr_malloc(o, *sz);
1672 if (fread(buf, 1, *sz, inf) != *sz)
1673 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1678 static void process_http_request(association *assoc, request *req)
1680 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1681 ODR o = assoc->encode;
1682 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1684 Z_SOAP *soap_package = 0;
1687 Z_HTTP_Response *hres = 0;
1689 const char *stylesheet = 0; /* for now .. set later */
1690 Z_SRW_diagnostic *diagnostic = 0;
1691 int num_diagnostic = 0;
1692 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1694 if (!control_association(assoc, host, 0))
1696 p = z_get_HTTP_Response(o, 404);
1699 if (r == 2 && assoc->server && assoc->server->docpath
1700 && hreq->path[0] == '/'
1702 /* check if path is a proper prefix of documentroot */
1703 strncmp(hreq->path+1, assoc->server->docpath,
1704 strlen(assoc->server->docpath))
1707 if (!check_path(hreq->path))
1709 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1710 p = z_get_HTTP_Response(o, 404);
1714 size_t content_size = 0;
1715 char *content_buf = read_file(hreq->path+1, o, &content_size);
1718 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1719 p = z_get_HTTP_Response(o, 404);
1723 const char *ctype = 0;
1724 yaz_mime_types types = yaz_mime_types_create();
1726 yaz_mime_types_add(types, "xsl", "application/xml");
1727 yaz_mime_types_add(types, "xml", "application/xml");
1728 yaz_mime_types_add(types, "css", "text/css");
1729 yaz_mime_types_add(types, "html", "text/html");
1730 yaz_mime_types_add(types, "htm", "text/html");
1731 yaz_mime_types_add(types, "txt", "text/plain");
1732 yaz_mime_types_add(types, "js", "application/x-javascript");
1734 yaz_mime_types_add(types, "gif", "image/gif");
1735 yaz_mime_types_add(types, "png", "image/png");
1736 yaz_mime_types_add(types, "jpg", "image/jpeg");
1737 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1739 ctype = yaz_mime_lookup_fname(types, hreq->path);
1742 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1743 p = z_get_HTTP_Response(o, 404);
1747 p = z_get_HTTP_Response(o, 200);
1748 hres = p->u.HTTP_Response;
1749 hres->content_buf = content_buf;
1750 hres->content_len = content_size;
1751 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1753 yaz_mime_types_destroy(types);
1761 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1762 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1764 if (r == 2) /* not taken */
1766 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1767 &diagnostic, &num_diagnostic);
1768 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1770 if (r == 0) /* decode SRW/SRU OK .. */
1772 int http_code = 200;
1773 if (sr->which == Z_SRW_searchRetrieve_request)
1776 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1778 stylesheet = sr->u.request->stylesheet;
1781 res->u.response->diagnostics = diagnostic;
1782 res->u.response->num_diagnostics = num_diagnostic;
1786 srw_bend_search(assoc, req, sr, res->u.response,
1789 if (http_code == 200)
1790 soap_package->u.generic->p = res;
1792 else if (sr->which == Z_SRW_explain_request)
1794 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1796 stylesheet = sr->u.explain_request->stylesheet;
1799 res->u.explain_response->diagnostics = diagnostic;
1800 res->u.explain_response->num_diagnostics = num_diagnostic;
1802 srw_bend_explain(assoc, req, sr,
1803 res->u.explain_response, &http_code);
1804 if (http_code == 200)
1805 soap_package->u.generic->p = res;
1807 else if (sr->which == Z_SRW_scan_request)
1809 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1811 stylesheet = sr->u.scan_request->stylesheet;
1814 res->u.scan_response->diagnostics = diagnostic;
1815 res->u.scan_response->num_diagnostics = num_diagnostic;
1817 srw_bend_scan(assoc, req, sr,
1818 res->u.scan_response, &http_code);
1819 if (http_code == 200)
1820 soap_package->u.generic->p = res;
1822 else if (sr->which == Z_SRW_update_request)
1824 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1826 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1829 res->u.update_response->diagnostics = diagnostic;
1830 res->u.update_response->num_diagnostics = num_diagnostic;
1832 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1833 srw_bend_update(assoc, req, sr,
1834 res->u.update_response, &http_code);
1835 if (http_code == 200)
1836 soap_package->u.generic->p = res;
1840 yaz_log(log_request, "SOAP ERROR");
1841 /* FIXME - what error, what query */
1843 z_soap_error(assoc->encode, soap_package,
1844 "SOAP-ENV:Client", "Bad method", 0);
1846 if (http_code == 200 || http_code == 500)
1848 static Z_SOAP_Handler soap_handlers[4] = {
1850 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1851 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1852 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1858 p = z_get_HTTP_Response(o, 200);
1859 hres = p->u.HTTP_Response;
1861 if (!stylesheet && assoc->server)
1862 stylesheet = assoc->server->stylesheet;
1864 /* empty stylesheet means NO stylesheet */
1865 if (stylesheet && *stylesheet == '\0')
1868 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1869 &hres->content_buf, &hres->content_len,
1870 soap_handlers, charset, stylesheet);
1871 hres->code = http_code;
1873 strcpy(ctype, "text/xml");
1874 if (charset && strlen(charset) < sizeof(ctype)-30)
1876 strcat(ctype, "; charset=");
1877 strcat(ctype, charset);
1879 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1882 p = z_get_HTTP_Response(o, http_code);
1886 p = z_get_HTTP_Response(o, 500);
1887 hres = p->u.HTTP_Response;
1888 if (!strcmp(hreq->version, "1.0"))
1890 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1891 if (v && !strcmp(v, "Keep-Alive"))
1895 hres->version = "1.0";
1899 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1900 if (v && !strcmp(v, "close"))
1904 hres->version = "1.1";
1908 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1909 assoc->state = ASSOC_DEAD;
1910 assoc->cs_get_mask = 0;
1915 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1917 if (alive && isdigit(*(const unsigned char *) alive))
1921 if (t < 0 || t > 3600)
1923 iochan_settimeout(assoc->client_chan,t);
1924 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1926 process_gdu_response(assoc, req, p);
1929 static void process_gdu_request(association *assoc, request *req)
1931 if (req->gdu_request->which == Z_GDU_Z3950)
1934 req->apdu_request = req->gdu_request->u.z3950;
1935 if (process_z_request(assoc, req, &msg) < 0)
1936 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1938 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1939 process_http_request(assoc, req);
1942 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1947 * Initiate request processing.
1949 static int process_z_request(association *assoc, request *req, char **msg)
1955 *msg = "Unknown Error";
1956 assert(req && req->state == REQUEST_IDLE);
1957 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1959 *msg = "Missing InitRequest";
1962 switch (req->apdu_request->which)
1964 case Z_APDU_initRequest:
1965 res = process_initRequest(assoc, req); break;
1966 case Z_APDU_searchRequest:
1967 res = process_searchRequest(assoc, req, &fd); break;
1968 case Z_APDU_presentRequest:
1969 res = process_presentRequest(assoc, req, &fd); break;
1970 case Z_APDU_scanRequest:
1971 if (assoc->init->bend_scan)
1972 res = process_scanRequest(assoc, req, &fd);
1975 *msg = "Cannot handle Scan APDU";
1979 case Z_APDU_extendedServicesRequest:
1980 if (assoc->init->bend_esrequest)
1981 res = process_ESRequest(assoc, req, &fd);
1984 *msg = "Cannot handle Extended Services APDU";
1988 case Z_APDU_sortRequest:
1989 if (assoc->init->bend_sort)
1990 res = process_sortRequest(assoc, req, &fd);
1993 *msg = "Cannot handle Sort APDU";
1998 process_close(assoc, req);
2000 case Z_APDU_deleteResultSetRequest:
2001 if (assoc->init->bend_delete)
2002 res = process_deleteRequest(assoc, req, &fd);
2005 *msg = "Cannot handle Delete APDU";
2009 case Z_APDU_segmentRequest:
2010 if (assoc->init->bend_segment)
2012 res = process_segmentRequest(assoc, req);
2016 *msg = "Cannot handle Segment APDU";
2020 case Z_APDU_triggerResourceControlRequest:
2023 *msg = "Bad APDU received";
2028 yaz_log(YLOG_DEBUG, " result immediately available");
2029 retval = process_z_response(assoc, req, res);
2033 yaz_log(YLOG_DEBUG, " result unavailble");
2036 else /* no result yet - one will be provided later */
2040 /* Set up an I/O handler for the fd supplied by the backend */
2042 yaz_log(YLOG_DEBUG, " establishing handler for result");
2043 req->state = REQUEST_PENDING;
2044 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2046 iochan_setdata(chan, assoc);
2053 * Handle message from the backend.
2055 void backend_response(IOCHAN i, int event)
2057 association *assoc = (association *)iochan_getdata(i);
2058 request *req = request_head(&assoc->incoming);
2062 yaz_log(YLOG_DEBUG, "backend_response");
2063 assert(assoc && req && req->state != REQUEST_IDLE);
2064 /* determine what it is we're waiting for */
2065 switch (req->apdu_request->which)
2067 case Z_APDU_searchRequest:
2068 res = response_searchRequest(assoc, req, 0, &fd); break;
2070 case Z_APDU_presentRequest:
2071 res = response_presentRequest(assoc, req, 0, &fd); break;
2072 case Z_APDU_scanRequest:
2073 res = response_scanRequest(assoc, req, 0, &fd); break;
2076 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2079 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2081 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2082 do_close(assoc, Z_Close_systemProblem, 0);
2086 else if (!res) /* no result yet - try again later */
2088 yaz_log(YLOG_DEBUG, " no result yet");
2089 iochan_setfd(i, fd); /* in case fd has changed */
2094 * Encode response, and transfer the request structure to the outgoing queue.
2096 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2098 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2102 if (!z_GDU(assoc->print, &res, 0, 0))
2103 yaz_log(YLOG_WARN, "ODR print error: %s",
2104 odr_errmsg(odr_geterror(assoc->print)));
2105 odr_reset(assoc->print);
2107 if (!z_GDU(assoc->encode, &res, 0, 0))
2109 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2110 odr_errmsg(odr_geterror(assoc->decode)),
2111 odr_getelement(assoc->decode));
2114 req->response = odr_getbuf(assoc->encode, &req->len_response,
2115 &req->size_response);
2116 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2117 odr_reset(assoc->encode);
2118 req->state = REQUEST_IDLE;
2119 request_enq(&assoc->outgoing, req);
2120 /* turn the work over to the ir_session handler */
2121 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2122 assoc->cs_put_mask = EVENT_OUTPUT;
2123 /* Is there more work to be done? give that to the input handler too */
2126 req = request_head(&assoc->incoming);
2127 if (req && req->state == REQUEST_IDLE)
2129 request_deq(&assoc->incoming);
2130 process_gdu_request(assoc, req);
2139 * Encode response, and transfer the request structure to the outgoing queue.
2141 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2143 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2144 gres->which = Z_GDU_Z3950;
2145 gres->u.z3950 = res;
2147 return process_gdu_response(assoc, req, gres);
2150 static char *get_vhost(Z_OtherInformation *otherInfo)
2152 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2156 * Handle init request.
2157 * At the moment, we don't check the options
2158 * anywhere else in the code - we just try not to do anything that would
2159 * break a naive client. We'll toss 'em into the association block when
2160 * we need them there.
2162 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2164 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2165 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2166 Z_InitResponse *resp = apdu->u.initResponse;
2167 bend_initresult *binitres;
2169 statserv_options_block *cb = 0; /* by default no control for backend */
2171 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2172 cb = statserv_getcontrol(); /* got control block for backend */
2174 if (cb && assoc->backend)
2175 (*cb->bend_close)(assoc->backend);
2177 yaz_log(log_requestdetail, "Got initRequest");
2178 if (req->implementationId)
2179 yaz_log(log_requestdetail, "Id: %s",
2180 req->implementationId);
2181 if (req->implementationName)
2182 yaz_log(log_requestdetail, "Name: %s",
2183 req->implementationName);
2184 if (req->implementationVersion)
2185 yaz_log(log_requestdetail, "Version: %s",
2186 req->implementationVersion);
2188 assoc_init_reset(assoc);
2190 assoc->init->auth = req->idAuthentication;
2191 assoc->init->referenceId = req->referenceId;
2193 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2195 Z_CharSetandLanguageNegotiation *negotiation =
2196 yaz_get_charneg_record (req->otherInfo);
2198 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2199 assoc->init->charneg_request = negotiation;
2202 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2203 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2204 assoc->init->named_result_sets = 1;
2209 if (req->implementationVersion)
2210 yaz_log(log_requestdetail, "Config: %s",
2213 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2215 /* we have a backend control block, so call that init function */
2216 if (!(binitres = (*cb->bend_init)(assoc->init)))
2218 yaz_log(YLOG_WARN, "Bad response from backend.");
2221 assoc->backend = binitres->handle;
2225 /* no backend. return error */
2226 binitres = (bend_initresult *)
2227 odr_malloc(assoc->encode, sizeof(*binitres));
2228 binitres->errstring = 0;
2229 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2230 iochan_settimeout(assoc->client_chan, 10);
2232 if ((assoc->init->bend_sort))
2233 yaz_log(YLOG_DEBUG, "Sort handler installed");
2234 if ((assoc->init->bend_search))
2235 yaz_log(YLOG_DEBUG, "Search handler installed");
2236 if ((assoc->init->bend_present))
2237 yaz_log(YLOG_DEBUG, "Present handler installed");
2238 if ((assoc->init->bend_esrequest))
2239 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2240 if ((assoc->init->bend_delete))
2241 yaz_log(YLOG_DEBUG, "Delete handler installed");
2242 if ((assoc->init->bend_scan))
2243 yaz_log(YLOG_DEBUG, "Scan handler installed");
2244 if ((assoc->init->bend_segment))
2245 yaz_log(YLOG_DEBUG, "Segment handler installed");
2247 resp->referenceId = req->referenceId;
2249 /* let's tell the client what we can do */
2250 if (ODR_MASK_GET(req->options, Z_Options_search))
2252 ODR_MASK_SET(resp->options, Z_Options_search);
2253 strcat(options, "srch");
2255 if (ODR_MASK_GET(req->options, Z_Options_present))
2257 ODR_MASK_SET(resp->options, Z_Options_present);
2258 strcat(options, " prst");
2260 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2261 assoc->init->bend_delete)
2263 ODR_MASK_SET(resp->options, Z_Options_delSet);
2264 strcat(options, " del");
2266 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2267 assoc->init->bend_esrequest)
2269 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2270 strcat(options, " extendedServices");
2272 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2273 && assoc->init->named_result_sets)
2275 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2276 strcat(options, " namedresults");
2278 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2280 ODR_MASK_SET(resp->options, Z_Options_scan);
2281 strcat(options, " scan");
2283 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2285 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2286 strcat(options, " concurrop");
2288 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2290 ODR_MASK_SET(resp->options, Z_Options_sort);
2291 strcat(options, " sort");
2294 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2296 Z_OtherInformationUnit *p0;
2298 if (!assoc->init->charneg_response)
2300 if (assoc->init->query_charset)
2302 assoc->init->charneg_response = yaz_set_response_charneg(
2303 assoc->encode, assoc->init->query_charset, 0,
2304 assoc->init->records_in_same_charset);
2308 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2311 if (assoc->init->charneg_response
2312 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2314 p0->which = Z_OtherInfo_externallyDefinedInfo;
2315 p0->information.externallyDefinedInfo =
2316 assoc->init->charneg_response;
2317 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2318 strcat(options, " negotiation");
2321 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2322 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2324 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2326 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2327 assoc->version = 1; /* 1 & 2 are equivalent */
2329 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2331 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2334 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2336 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2340 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2342 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2343 assoc->maximumRecordSize = *req->maximumRecordSize;
2345 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2346 assoc->preferredMessageSize = *req->preferredMessageSize;
2348 resp->preferredMessageSize = &assoc->preferredMessageSize;
2349 resp->maximumRecordSize = &assoc->maximumRecordSize;
2351 resp->implementationId = odr_prepend(assoc->encode,
2352 assoc->init->implementation_id,
2353 resp->implementationId);
2355 resp->implementationName = odr_prepend(assoc->encode,
2356 assoc->init->implementation_name,
2357 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2359 if (binitres->errcode)
2361 assoc->state = ASSOC_DEAD;
2362 resp->userInformationField =
2363 init_diagnostics(assoc->encode, binitres->errcode,
2364 binitres->errstring);
2369 if (!req->idAuthentication)
2370 yaz_log(log_request, "Auth none");
2371 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2373 const char *open = req->idAuthentication->u.open;
2374 const char *slash = strchr(open, '/');
2380 yaz_log(log_request, "Auth open %.*s", len, open);
2382 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2384 const char *user = req->idAuthentication->u.idPass->userId;
2385 const char *group = req->idAuthentication->u.idPass->groupId;
2386 yaz_log(log_request, "Auth idPass %s %s",
2387 user ? user : "-", group ? group : "-");
2389 else if (req->idAuthentication->which
2390 == Z_IdAuthentication_anonymous)
2392 yaz_log(log_request, "Auth anonymous");
2396 yaz_log(log_request, "Auth other");
2401 WRBUF wr = wrbuf_alloc();
2402 wrbuf_printf(wr, "Init ");
2403 if (binitres->errcode)
2404 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2406 wrbuf_printf(wr, "OK -");
2407 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2408 (req->implementationId ? req->implementationId :"-"),
2409 (req->implementationName ?
2410 req->implementationName : "-"),
2411 (req->implementationVersion ?
2412 req->implementationVersion : "-")
2414 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2421 * Set the specified `errcode' and `errstring' into a UserInfo-1
2422 * external to be returned to the client in accordance with Z35.90
2423 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2424 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2426 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2428 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2429 addinfo ? " -- " : "", addinfo ? addinfo : "");
2430 return zget_init_diagnostics(odr, error, addinfo);
2434 * nonsurrogate diagnostic record.
2436 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2438 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2440 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2441 addinfo ? " -- " : "", addinfo ? addinfo : "");
2443 rec->which = Z_Records_NSD;
2444 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2450 * surrogate diagnostic.
2452 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2454 int error, const char *addinfo)
2456 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2457 addinfo ? " -- " : "", addinfo ? addinfo : "");
2458 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2461 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2462 Odr_int *num, Z_RecordComposition *comp,
2463 Odr_int *next, Odr_int *pres,
2464 Z_ReferenceId *referenceId,
2465 Odr_oid *oid, int *errcode)
2467 int recno, total_length = 0, toget = *num, dumped_records = 0;
2468 Z_Records *records =
2469 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2470 Z_NamePlusRecordList *reclist =
2471 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2472 Z_NamePlusRecord **list =
2473 (Z_NamePlusRecord **) odr_malloc(a->encode, sizeof(*list) * toget);
2475 records->which = Z_Records_DBOSD;
2476 records->u.databaseOrSurDiagnostics = reclist;
2477 reclist->num_records = 0;
2478 reclist->records = list;
2479 *pres = Z_PresentStatus_success;
2483 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2484 yaz_log(log_requestdetail, "pms=" ODR_INT_PRINTF
2485 ", mrs=" ODR_INT_PRINTF, a->preferredMessageSize,
2486 a->maximumRecordSize);
2487 for (recno = start; reclist->num_records < toget; recno++)
2490 Z_NamePlusRecord *thisrec;
2491 int this_length = 0;
2493 * we get the number of bytes allocated on the stream before any
2494 * allocation done by the backend - this should give us a reasonable
2495 * idea of the total size of the data so far.
2497 total_length = odr_total(a->encode) - dumped_records;
2503 freq.last_in_set = 0;
2504 freq.setname = setname;
2505 freq.surrogate_flag = 0;
2506 freq.number = recno;
2508 freq.request_format = oid;
2509 freq.output_format = 0;
2510 freq.stream = a->encode;
2511 freq.print = a->print;
2512 freq.referenceId = referenceId;
2515 retrieve_fetch(a, &freq);
2517 *next = freq.last_in_set ? 0 : recno + 1;
2521 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2524 *pres = Z_PresentStatus_failure;
2525 /* for 'present request out of range',
2526 set addinfo to record position if not set */
2527 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2528 freq.errstring == 0)
2530 sprintf (s, "%d", recno);
2534 *errcode = freq.errcode;
2535 return diagrec(a, freq.errcode, freq.errstring);
2537 reclist->records[reclist->num_records] =
2538 surrogatediagrec(a, freq.basename, freq.errcode,
2540 reclist->num_records++;
2543 if (freq.record == 0) /* no error and no record ? */
2545 *next = 0; /* signal end-of-set and stop */
2549 this_length = freq.len;
2551 this_length = odr_total(a->encode) - total_length - dumped_records;
2552 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2553 this_length, total_length, dumped_records);
2554 if (a->preferredMessageSize > 0 &&
2555 this_length + total_length > a->preferredMessageSize)
2557 /* record is small enough, really */
2558 if (this_length <= a->preferredMessageSize && recno > start)
2560 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2561 *pres = Z_PresentStatus_partial_2;
2564 /* record can only be fetched by itself */
2565 if (this_length < a->maximumRecordSize)
2567 yaz_log(log_requestdetail, " Record > prefmsgsz");
2570 yaz_log(YLOG_DEBUG, " Dropped it");
2571 reclist->records[reclist->num_records] =
2572 surrogatediagrec(a, freq.basename, 16, 0);
2573 reclist->num_records++;
2574 dumped_records += this_length;
2578 else /* too big entirely */
2580 yaz_log(log_requestdetail, "Record > maxrcdsz "
2581 "this=%d max=" ODR_INT_PRINTF,
2582 this_length, a->maximumRecordSize);
2583 reclist->records[reclist->num_records] =
2584 surrogatediagrec(a, freq.basename, 17, 0);
2585 reclist->num_records++;
2586 dumped_records += this_length;
2591 if (!(thisrec = (Z_NamePlusRecord *)
2592 odr_malloc(a->encode, sizeof(*thisrec))))
2594 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2595 thisrec->which = Z_NamePlusRecord_databaseRecord;
2597 if (!freq.output_format)
2598 freq.output_format = freq.request_format;
2599 thisrec->u.databaseRecord = z_ext_record_oid(
2600 a->encode, freq.output_format, freq.record, freq.len);
2601 if (!thisrec->u.databaseRecord)
2603 reclist->records[reclist->num_records] = thisrec;
2604 reclist->num_records++;
2606 *num = reclist->num_records;
2610 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2613 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2614 bend_search_rr *bsrr =
2615 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2617 yaz_log(log_requestdetail, "Got SearchRequest.");
2619 bsrr->request = reqb;
2620 bsrr->association = assoc;
2621 bsrr->referenceId = req->referenceId;
2622 save_referenceId (reqb, bsrr->referenceId);
2623 bsrr->srw_sortKeys = 0;
2624 bsrr->srw_setname = 0;
2625 bsrr->srw_setnameIdleTime = 0;
2626 bsrr->estimated_hit_count = 0;
2627 bsrr->partial_resultset = 0;
2629 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2630 if (req->databaseNames)
2633 for (i = 0; i < req->num_databaseNames; i++)
2634 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2637 yaz_log_zquery_level(log_requestdetail,req->query);
2639 if (assoc->init->bend_search)
2641 bsrr->setname = req->resultSetName;
2642 bsrr->replace_set = *req->replaceIndicator;
2643 bsrr->num_bases = req->num_databaseNames;
2644 bsrr->basenames = req->databaseNames;
2645 bsrr->query = req->query;
2646 bsrr->stream = assoc->encode;
2647 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2648 bsrr->decode = assoc->decode;
2649 bsrr->print = assoc->print;
2652 bsrr->errstring = NULL;
2653 bsrr->search_info = NULL;
2655 if (assoc->server && assoc->server->cql_transform
2656 && req->query->which == Z_Query_type_104
2657 && req->query->u.type_104->which == Z_External_CQL)
2659 /* have a CQL query and a CQL to PQF transform .. */
2661 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2662 assoc->server->cql_transform, bsrr->query);
2664 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2667 if (assoc->server && assoc->server->ccl_transform
2668 && req->query->which == Z_Query_type_2) /*CCL*/
2670 /* have a CCL query and a CCL to PQF transform .. */
2672 ccl2pqf(bsrr->stream, req->query->u.type_2,
2673 assoc->server->ccl_transform, bsrr);
2675 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2679 (assoc->init->bend_search)(assoc->backend, bsrr);
2680 if (!bsrr->request) /* backend not ready with the search response */
2681 return 0; /* should not be used any more */
2685 /* FIXME - make a diagnostic for it */
2686 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2688 return response_searchRequest(assoc, reqb, bsrr, fd);
2691 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2694 * Prepare a searchresponse based on the backend results. We probably want
2695 * to look at making the fetching of records nonblocking as well, but
2696 * so far, we'll keep things simple.
2697 * If bsrt is null, that means we're called in response to a communications
2698 * event, and we'll have to get the response for ourselves.
2700 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2701 bend_search_rr *bsrt, int *fd)
2703 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2704 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2705 Z_SearchResponse *resp = (Z_SearchResponse *)
2706 odr_malloc(assoc->encode, sizeof(*resp));
2707 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2708 Odr_int *next = odr_intdup(assoc->encode, 0);
2709 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2710 int returnedrecs = 0;
2712 apdu->which = Z_APDU_searchResponse;
2713 apdu->u.searchResponse = resp;
2714 resp->referenceId = req->referenceId;
2715 resp->additionalSearchInfo = 0;
2716 resp->otherInfo = 0;
2718 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2720 yaz_log(YLOG_FATAL, "Bad result from backend");
2723 else if (bsrt->errcode)
2725 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2726 resp->resultCount = nulint;
2727 resp->numberOfRecordsReturned = nulint;
2728 resp->nextResultSetPosition = nulint;
2729 resp->searchStatus = odr_booldup(assoc->encode, 0);
2730 resp->resultSetStatus = none;
2731 resp->presentStatus = 0;
2735 bool_t *sr = odr_booldup(assoc->encode, 1);
2736 Odr_int *toget = odr_intdup(assoc->encode, 0);
2737 Z_RecordComposition comp, *compp = 0;
2739 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2742 resp->resultCount = &bsrt->hits;
2744 comp.which = Z_RecordComp_simple;
2745 /* how many records does the user agent want, then? */
2746 if (bsrt->hits <= *req->smallSetUpperBound)
2748 *toget = bsrt->hits;
2749 if ((comp.u.simple = req->smallSetElementSetNames))
2752 else if (bsrt->hits < *req->largeSetLowerBound)
2754 *toget = *req->mediumSetPresentNumber;
2755 if (*toget > bsrt->hits)
2756 *toget = bsrt->hits;
2757 if ((comp.u.simple = req->mediumSetElementSetNames))
2763 if (*toget && !resp->records)
2765 Odr_int *presst = odr_intdup(assoc->encode, 0);
2766 /* Call bend_present if defined */
2767 if (assoc->init->bend_present)
2769 bend_present_rr *bprr = (bend_present_rr *)
2770 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2771 bprr->setname = req->resultSetName;
2773 bprr->number = *toget;
2774 bprr->format = req->preferredRecordSyntax;
2776 bprr->referenceId = req->referenceId;
2777 bprr->stream = assoc->encode;
2778 bprr->print = assoc->print;
2779 bprr->request = reqb;
2780 bprr->association = assoc;
2782 bprr->errstring = NULL;
2783 (*assoc->init->bend_present)(assoc->backend, bprr);
2789 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2790 *resp->presentStatus = Z_PresentStatus_failure;
2795 resp->records = pack_records(
2796 assoc, req->resultSetName, 1,
2797 toget, compp, next, presst, req->referenceId,
2798 req->preferredRecordSyntax, NULL);
2801 resp->numberOfRecordsReturned = toget;
2802 returnedrecs = *toget;
2803 resp->presentStatus = presst;
2807 if (*resp->resultCount)
2809 resp->numberOfRecordsReturned = nulint;
2810 resp->presentStatus = 0;
2812 resp->nextResultSetPosition = next;
2813 resp->searchStatus = sr;
2814 resp->resultSetStatus = 0;
2815 if (bsrt->estimated_hit_count)
2817 resp->resultSetStatus = odr_intdup(assoc->encode,
2818 Z_SearchResponse_estimate);
2820 else if (bsrt->partial_resultset)
2822 resp->resultSetStatus = odr_intdup(assoc->encode,
2823 Z_SearchResponse_subset);
2826 resp->additionalSearchInfo = bsrt->search_info;
2831 WRBUF wr = wrbuf_alloc();
2833 for (i = 0 ; i < req->num_databaseNames; i++){
2835 wrbuf_printf(wr, "+");
2836 wrbuf_puts(wr, req->databaseNames[i]);
2838 wrbuf_printf(wr, " ");
2841 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2843 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2844 wrbuf_printf(wr, " %s 1+%d ",
2845 req->resultSetName, returnedrecs);
2846 yaz_query_to_wrbuf(wr, req->query);
2848 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2855 * Maybe we got a little over-friendly when we designed bend_fetch to
2856 * get only one record at a time. Some backends can optimise multiple-record
2857 * fetches, and at any rate, there is some overhead involved in
2858 * all that selecting and hopping around. Problem is, of course, that the
2859 * frontend can't know ahead of time how many records it'll need to
2860 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2861 * is downright lousy as a bulk data transfer protocol.
2863 * To start with, we'll do the fetching of records from the backend
2864 * in one operation: To save some trips in and out of the event-handler,
2865 * and to simplify the interface to pack_records. At any rate, asynch
2866 * operation is more fun in operations that have an unpredictable execution
2867 * speed - which is normally more true for search than for present.
2869 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2872 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2874 Z_PresentResponse *resp;
2878 const char *errstring = 0;
2880 yaz_log(log_requestdetail, "Got PresentRequest.");
2882 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2884 resp->presentStatus = odr_intdup(assoc->encode, 0);
2885 if (assoc->init->bend_present)
2887 bend_present_rr *bprr = (bend_present_rr *)
2888 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2889 bprr->setname = req->resultSetId;
2890 bprr->start = *req->resultSetStartPoint;
2891 bprr->number = *req->numberOfRecordsRequested;
2892 bprr->format = req->preferredRecordSyntax;
2893 bprr->comp = req->recordComposition;
2894 bprr->referenceId = req->referenceId;
2895 bprr->stream = assoc->encode;
2896 bprr->print = assoc->print;
2897 bprr->request = reqb;
2898 bprr->association = assoc;
2900 bprr->errstring = NULL;
2901 (*assoc->init->bend_present)(assoc->backend, bprr);
2904 return 0; /* should not happen */
2907 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2908 *resp->presentStatus = Z_PresentStatus_failure;
2909 errcode = bprr->errcode;
2910 errstring = bprr->errstring;
2913 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2914 next = odr_intdup(assoc->encode, 0);
2915 num = odr_intdup(assoc->encode, 0);
2917 apdu->which = Z_APDU_presentResponse;
2918 apdu->u.presentResponse = resp;
2919 resp->referenceId = req->referenceId;
2920 resp->otherInfo = 0;
2924 *num = *req->numberOfRecordsRequested;
2926 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2927 num, req->recordComposition, next,
2928 resp->presentStatus,
2929 req->referenceId, req->preferredRecordSyntax,
2934 WRBUF wr = wrbuf_alloc();
2935 wrbuf_printf(wr, "Present ");
2937 if (*resp->presentStatus == Z_PresentStatus_failure)
2938 wrbuf_printf(wr, "ERROR %d ", errcode);
2939 else if (*resp->presentStatus == Z_PresentStatus_success)
2940 wrbuf_printf(wr, "OK - ");
2942 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2943 *resp->presentStatus);
2945 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2946 req->resultSetId, *req->resultSetStartPoint,
2947 *req->numberOfRecordsRequested);
2948 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2953 resp->numberOfRecordsReturned = num;
2954 resp->nextResultSetPosition = next;
2960 * Scan was implemented rather in a hurry, and with support for only the basic
2961 * elements of the service in the backend API. Suggestions are welcome.
2963 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2965 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2966 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2967 Z_ScanResponse *res = (Z_ScanResponse *)
2968 odr_malloc(assoc->encode, sizeof(*res));
2969 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2970 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2971 Z_ListEntries *ents = (Z_ListEntries *)
2972 odr_malloc(assoc->encode, sizeof(*ents));
2973 Z_DiagRecs *diagrecs_p = NULL;
2974 bend_scan_rr *bsrr = (bend_scan_rr *)
2975 odr_malloc(assoc->encode, sizeof(*bsrr));
2976 struct scan_entry *save_entries;
2978 yaz_log(log_requestdetail, "Got ScanRequest");
2980 apdu->which = Z_APDU_scanResponse;
2981 apdu->u.scanResponse = res;
2982 res->referenceId = req->referenceId;
2984 /* if step is absent, set it to 0 */
2985 res->stepSize = odr_intdup(assoc->encode, 0);
2987 *res->stepSize = *req->stepSize;
2989 res->scanStatus = scanStatus;
2990 res->numberOfEntriesReturned = numberOfEntriesReturned;
2991 res->positionOfTerm = 0;
2992 res->entries = ents;
2993 ents->num_entries = 0;
2994 ents->entries = NULL;
2995 ents->num_nonsurrogateDiagnostics = 0;
2996 ents->nonsurrogateDiagnostics = NULL;
2997 res->attributeSet = 0;
3000 if (req->databaseNames)
3003 for (i = 0; i < req->num_databaseNames; i++)
3004 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
3006 bsrr->scanClause = 0;
3008 bsrr->errstring = 0;
3009 bsrr->num_bases = req->num_databaseNames;
3010 bsrr->basenames = req->databaseNames;
3011 bsrr->num_entries = *req->numberOfTermsRequested;
3012 bsrr->term = req->termListAndStartPoint;
3013 bsrr->referenceId = req->referenceId;
3014 bsrr->stream = assoc->encode;
3015 bsrr->print = assoc->print;
3016 bsrr->step_size = res->stepSize;
3017 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
3018 yaz_oid_userinfo_scan_set, 1, 0);
3020 /* For YAZ 2.0 and earlier it was the backend handler that
3021 initialized entries (member display_term did not exist)
3022 YAZ 2.0 and later sets 'entries' and initialize all members
3023 including 'display_term'. If YAZ 2.0 or later sees that
3024 entries was modified - we assume that it is an old handler and
3025 that 'display_term' is _not_ set.
3027 if (bsrr->num_entries > 0)
3030 bsrr->entries = (struct scan_entry *)
3031 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3033 for (i = 0; i<bsrr->num_entries; i++)
3035 bsrr->entries[i].term = 0;
3036 bsrr->entries[i].occurrences = 0;
3037 bsrr->entries[i].errcode = 0;
3038 bsrr->entries[i].errstring = 0;
3039 bsrr->entries[i].display_term = 0;
3042 save_entries = bsrr->entries; /* save it so we can compare later */
3044 bsrr->attributeset = req->attributeSet;
3045 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3046 bsrr->attributeset);
3047 bsrr->term_position = req->preferredPositionInResponse ?
3048 *req->preferredPositionInResponse : 1;
3050 ((int (*)(void *, bend_scan_rr *))
3051 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3054 diagrecs_p = zget_DiagRecs(assoc->encode,
3055 bsrr->errcode, bsrr->errstring);
3059 Z_Entry **tab = (Z_Entry **)
3060 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3062 if (bsrr->status == BEND_SCAN_PARTIAL)
3063 *scanStatus = Z_Scan_partial_5;
3065 *scanStatus = Z_Scan_success;
3066 ents->entries = tab;
3067 ents->num_entries = bsrr->num_entries;
3068 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3070 res->positionOfTerm = &bsrr->term_position;
3071 for (i = 0; i < bsrr->num_entries; i++)
3077 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3078 if (bsrr->entries[i].occurrences >= 0)
3080 e->which = Z_Entry_termInfo;
3081 e->u.termInfo = t = (Z_TermInfo *)
3082 odr_malloc(assoc->encode, sizeof(*t));
3083 t->suggestedAttributes = 0;
3085 if (save_entries == bsrr->entries &&
3086 bsrr->entries[i].display_term)
3088 /* the entries was _not_ set by the handler. So it's
3089 safe to test for new member display_term. It is
3092 t->displayTerm = odr_strdup(assoc->encode,
3093 bsrr->entries[i].display_term);
3095 t->alternativeTerm = 0;
3096 t->byAttributes = 0;
3097 t->otherTermInfo = 0;
3098 t->globalOccurrences = &bsrr->entries[i].occurrences;
3099 t->term = (Z_Term *)
3100 odr_malloc(assoc->encode, sizeof(*t->term));
3101 t->term->which = Z_Term_general;
3102 t->term->u.general = o =
3103 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3104 o->buf = (unsigned char *)
3105 odr_malloc(assoc->encode, o->len = o->size =
3106 strlen(bsrr->entries[i].term));
3107 memcpy(o->buf, bsrr->entries[i].term, o->len);
3108 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3109 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3113 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3114 bsrr->entries[i].errcode,
3115 bsrr->entries[i].errstring);
3116 assert(drecs->num_diagRecs == 1);
3117 e->which = Z_Entry_surrogateDiagnostic;
3118 assert(drecs->diagRecs[0]);
3119 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3125 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3126 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3131 WRBUF wr = wrbuf_alloc();
3132 wrbuf_printf(wr, "Scan ");
3133 for (i = 0 ; i < req->num_databaseNames; i++)
3136 wrbuf_printf(wr, "+");
3137 wrbuf_puts(wr, req->databaseNames[i]);
3140 wrbuf_printf(wr, " ");
3143 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3145 wrbuf_printf(wr, "OK");
3147 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3148 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3149 res->numberOfEntriesReturned ?
3150 *res->numberOfEntriesReturned : 0,
3151 (req->preferredPositionInResponse ?
3152 *req->preferredPositionInResponse : 1),
3153 *req->numberOfTermsRequested,
3154 (res->stepSize ? *res->stepSize : 1));
3157 wrbuf_printf(wr, "+%s", bsrr->setname);
3159 wrbuf_printf(wr, " ");
3160 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3161 bsrr->attributeset);
3162 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3168 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3172 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3173 Z_SortResponse *res = (Z_SortResponse *)
3174 odr_malloc(assoc->encode, sizeof(*res));
3175 bend_sort_rr *bsrr = (bend_sort_rr *)
3176 odr_malloc(assoc->encode, sizeof(*bsrr));
3178 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3180 yaz_log(log_requestdetail, "Got SortRequest.");
3182 bsrr->num_input_setnames = req->num_inputResultSetNames;
3183 for (i=0;i<req->num_inputResultSetNames;i++)
3184 yaz_log(log_requestdetail, "Input resultset: '%s'",
3185 req->inputResultSetNames[i]);
3186 bsrr->input_setnames = req->inputResultSetNames;
3187 bsrr->referenceId = req->referenceId;
3188 bsrr->output_setname = req->sortedResultSetName;
3189 yaz_log(log_requestdetail, "Output resultset: '%s'",
3190 req->sortedResultSetName);
3191 bsrr->sort_sequence = req->sortSequence;
3192 /*FIXME - dump those sequences too */
3193 bsrr->stream = assoc->encode;
3194 bsrr->print = assoc->print;
3196 bsrr->sort_status = Z_SortResponse_failure;
3198 bsrr->errstring = 0;
3200 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3202 res->referenceId = bsrr->referenceId;
3203 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3204 res->resultSetStatus = 0;
3207 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3208 bsrr->errcode, bsrr->errstring);
3209 res->diagnostics = dr->diagRecs;
3210 res->num_diagnostics = dr->num_diagRecs;
3214 res->num_diagnostics = 0;
3215 res->diagnostics = 0;
3217 res->resultCount = 0;
3220 apdu->which = Z_APDU_sortResponse;
3221 apdu->u.sortResponse = res;
3224 WRBUF wr = wrbuf_alloc();
3225 wrbuf_printf(wr, "Sort ");
3227 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3229 wrbuf_printf(wr, "OK -");
3230 wrbuf_printf(wr, " (");
3231 for (i = 0; i<req->num_inputResultSetNames; i++)
3234 wrbuf_printf(wr, "+");
3235 wrbuf_puts(wr, req->inputResultSetNames[i]);
3237 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3239 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3245 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3249 Z_DeleteResultSetRequest *req =
3250 reqb->apdu_request->u.deleteResultSetRequest;
3251 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3252 odr_malloc(assoc->encode, sizeof(*res));
3253 bend_delete_rr *bdrr = (bend_delete_rr *)
3254 odr_malloc(assoc->encode, sizeof(*bdrr));
3255 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3257 yaz_log(log_requestdetail, "Got DeleteRequest.");
3259 bdrr->num_setnames = req->num_resultSetList;
3260 bdrr->setnames = req->resultSetList;
3261 for (i = 0; i<req->num_resultSetList; i++)
3262 yaz_log(log_requestdetail, "resultset: '%s'",
3263 req->resultSetList[i]);
3264 bdrr->stream = assoc->encode;
3265 bdrr->print = assoc->print;
3266 bdrr->function = *req->deleteFunction;
3267 bdrr->referenceId = req->referenceId;
3269 if (bdrr->num_setnames > 0)
3271 bdrr->statuses = (Odr_int*)
3272 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3273 bdrr->num_setnames);
3274 for (i = 0; i < bdrr->num_setnames; i++)
3275 bdrr->statuses[i] = 0;
3277 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3279 res->referenceId = req->referenceId;
3281 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3283 res->deleteListStatuses = 0;
3284 if (bdrr->num_setnames > 0)
3287 res->deleteListStatuses = (Z_ListStatuses *)
3288 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3289 res->deleteListStatuses->num = bdrr->num_setnames;
3290 res->deleteListStatuses->elements =
3292 odr_malloc(assoc->encode,
3293 sizeof(*res->deleteListStatuses->elements) *
3294 bdrr->num_setnames);
3295 for (i = 0; i<bdrr->num_setnames; i++)
3297 res->deleteListStatuses->elements[i] =
3299 odr_malloc(assoc->encode,
3300 sizeof(**res->deleteListStatuses->elements));
3301 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3302 res->deleteListStatuses->elements[i]->id =
3303 odr_strdup(assoc->encode, bdrr->setnames[i]);
3306 res->numberNotDeleted = 0;
3307 res->bulkStatuses = 0;
3308 res->deleteMessage = 0;
3311 apdu->which = Z_APDU_deleteResultSetResponse;
3312 apdu->u.deleteResultSetResponse = res;
3315 WRBUF wr = wrbuf_alloc();
3316 wrbuf_printf(wr, "Delete ");
3317 if (bdrr->delete_status)
3318 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3320 wrbuf_printf(wr, "OK -");
3321 for (i = 0; i<req->num_resultSetList; i++)
3322 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3323 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3329 static void process_close(association *assoc, request *reqb)
3331 Z_Close *req = reqb->apdu_request->u.close;
3332 static char *reasons[] =
3339 "securityViolation",
3346 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3347 reasons[*req->closeReason], req->diagnosticInformation ?
3348 req->diagnosticInformation : "NULL");
3349 if (assoc->version < 3) /* to make do_force respond with close */
3351 do_close_req(assoc, Z_Close_finished,
3352 "Association terminated by client", reqb);
3353 yaz_log(log_request,"Close OK");
3356 void save_referenceId(request *reqb, Z_ReferenceId *refid)
3360 reqb->len_refid = refid->len;
3361 reqb->refid = (char *)nmem_malloc(reqb->request_mem, refid->len);
3362 memcpy(reqb->refid, refid->buf, refid->len);
3366 reqb->len_refid = 0;
3371 void bend_request_send(bend_association a, bend_request req, Z_APDU *res)
3373 process_z_response(a, req, res);
3376 bend_request bend_request_mk(bend_association a)
3378 request *nreq = request_get(&a->outgoing);
3379 nreq->request_mem = nmem_create();
3383 Z_ReferenceId *bend_request_getid(ODR odr, bend_request req)
3388 id = (Odr_oct *)odr_malloc(odr, sizeof(*odr));
3389 id->buf = (unsigned char *)odr_malloc(odr, req->len_refid);
3390 id->len = id->size = req->len_refid;
3391 memcpy(id->buf, req->refid, req->len_refid);
3395 void bend_request_destroy(bend_request *req)
3397 nmem_destroy((*req)->request_mem);
3398 request_release(*req);
3402 int bend_backend_respond(bend_association a, bend_request req)
3406 r = process_z_request(a, req, &msg);
3408 yaz_log(YLOG_WARN, "%s", msg);
3412 void bend_request_setdata(bend_request r, void *p)
3417 void *bend_request_getdata(bend_request r)
3419 return r->clientData;
3422 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3424 bend_segment_rr req;
3426 req.segment = reqb->apdu_request->u.segmentRequest;
3427 req.stream = assoc->encode;
3428 req.decode = assoc->decode;
3429 req.print = assoc->print;
3430 req.association = assoc;
3432 (*assoc->init->bend_segment)(assoc->backend, &req);
3437 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3439 bend_esrequest_rr esrequest;
3440 const char *ext_name = "unknown";
3442 Z_ExtendedServicesRequest *req =
3443 reqb->apdu_request->u.extendedServicesRequest;
3444 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3446 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3448 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3449 esrequest.stream = assoc->encode;
3450 esrequest.decode = assoc->decode;
3451 esrequest.print = assoc->print;
3452 esrequest.errcode = 0;
3453 esrequest.errstring = NULL;
3454 esrequest.request = reqb;
3455 esrequest.association = assoc;
3456 esrequest.taskPackage = 0;
3457 esrequest.referenceId = req->referenceId;
3460 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3462 switch(esrequest.esr->taskSpecificParameters->which)
3464 case Z_External_itemOrder:
3465 ext_name = "ItemOrder"; break;
3466 case Z_External_update:
3467 ext_name = "Update"; break;
3468 case Z_External_update0:
3469 ext_name = "Update0"; break;
3470 case Z_External_ESAdmin:
3471 ext_name = "Admin"; break;
3476 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3478 /* If the response is being delayed, return NULL */
3479 if (esrequest.request == NULL)
3482 resp->referenceId = req->referenceId;
3484 if (esrequest.errcode == -1)
3486 /* Backend service indicates request will be processed */
3487 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3488 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3490 else if (esrequest.errcode == 0)
3492 /* Backend service indicates request will be processed */
3493 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3494 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3498 Z_DiagRecs *diagRecs =
3499 zget_DiagRecs(assoc->encode, esrequest.errcode,
3500 esrequest.errstring);
3501 /* Backend indicates error, request will not be processed */
3502 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3503 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3504 resp->num_diagnostics = diagRecs->num_diagRecs;
3505 resp->diagnostics = diagRecs->diagRecs;
3508 WRBUF wr = wrbuf_alloc();
3509 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3510 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3515 /* Do something with the members of bend_extendedservice */
3516 if (esrequest.taskPackage)
3518 resp->taskPackage = z_ext_record_oid(
3519 assoc->encode, yaz_oid_recsyn_extended,
3520 (const char *) esrequest.taskPackage, -1);
3522 yaz_log(YLOG_DEBUG,"Send the result apdu");
3526 int bend_assoc_is_alive(bend_association assoc)
3528 if (assoc->state == ASSOC_DEAD)
3529 return 0; /* already marked as dead. Don't check I/O chan anymore */
3531 return iochan_is_alive(assoc->client_chan);
3538 * c-file-style: "Stroustrup"
3539 * indent-tabs-mode: nil
3541 * vim: shiftwidth=4 tabstop=8 expandtab