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(log_session, "Timeout. Closing connection");
381 /* do we need to lod this at all */
383 destroy_association(assoc);
388 yaz_log(log_sessiondetail, "Timeout. Sending Z39.50 Close");
389 do_close(assoc, Z_Close_lackOfActivity, 0);
393 if (event & assoc->cs_accept_mask)
395 if (!cs_accept(conn))
397 yaz_log(YLOG_WARN, "accept failed");
398 destroy_association(assoc);
402 iochan_clearflag(h, EVENT_OUTPUT);
403 if (conn->io_pending)
404 { /* cs_accept didn't complete */
405 assoc->cs_accept_mask =
406 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
407 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
409 iochan_setflag(h, assoc->cs_accept_mask);
412 { /* cs_accept completed. Prepare for reading (cs_get) */
413 assoc->cs_accept_mask = 0;
414 assoc->cs_get_mask = EVENT_INPUT;
415 iochan_setflag(h, assoc->cs_get_mask);
419 if (event & assoc->cs_get_mask) /* input */
421 if (!ir_read(h, event))
423 req = request_head(&assoc->incoming);
424 if (req->state == REQUEST_IDLE)
426 request_deq(&assoc->incoming);
427 process_gdu_request(assoc, req);
430 if (event & assoc->cs_put_mask)
432 request *req = request_head(&assoc->outgoing);
434 assoc->cs_put_mask = 0;
435 yaz_log(YLOG_DEBUG, "ir_session (output)");
436 req->state = REQUEST_PENDING;
437 switch (res = cs_put(conn, req->response, req->len_response))
440 yaz_log(log_sessiondetail, "Connection closed by client");
442 destroy_association(assoc);
445 case 0: /* all sent - release the request structure */
446 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
448 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
451 nmem_destroy(req->request_mem);
452 request_deq(&assoc->outgoing);
453 request_release(req);
454 if (!request_head(&assoc->outgoing))
455 { /* restore mask for cs_get operation ... */
456 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
457 iochan_setflag(h, assoc->cs_get_mask);
458 if (assoc->state == ASSOC_DEAD)
459 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
463 assoc->cs_put_mask = EVENT_OUTPUT;
467 if (conn->io_pending & CS_WANT_WRITE)
468 assoc->cs_put_mask |= EVENT_OUTPUT;
469 if (conn->io_pending & CS_WANT_READ)
470 assoc->cs_put_mask |= EVENT_INPUT;
471 iochan_setflag(h, assoc->cs_put_mask);
474 if (event & EVENT_EXCEPT)
476 yaz_log(YLOG_WARN, "ir_session (exception)");
478 destroy_association(assoc);
483 static int process_z_request(association *assoc, request *req, char **msg);
486 static void assoc_init_reset(association *assoc)
489 assoc->init = (bend_initrequest *) xmalloc(sizeof(*assoc->init));
491 assoc->init->stream = assoc->encode;
492 assoc->init->print = assoc->print;
493 assoc->init->auth = 0;
494 assoc->init->referenceId = 0;
495 assoc->init->implementation_version = 0;
496 assoc->init->implementation_id = 0;
497 assoc->init->implementation_name = 0;
498 assoc->init->query_charset = 0;
499 assoc->init->records_in_same_charset = 0;
500 assoc->init->bend_sort = NULL;
501 assoc->init->bend_search = NULL;
502 assoc->init->bend_present = NULL;
503 assoc->init->bend_esrequest = NULL;
504 assoc->init->bend_delete = NULL;
505 assoc->init->bend_scan = NULL;
506 assoc->init->bend_segment = NULL;
507 assoc->init->bend_fetch = NULL;
508 assoc->init->bend_explain = NULL;
509 assoc->init->bend_srw_scan = NULL;
510 assoc->init->bend_srw_update = NULL;
511 assoc->init->named_result_sets = 0;
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);
668 (*assoc->init->bend_fetch)(assoc->backend, rr);
673 static int srw_bend_fetch(association *assoc, int pos,
674 Z_SRW_searchRetrieveRequest *srw_req,
675 Z_SRW_record *record,
676 const char **addinfo)
679 ODR o = assoc->encode;
681 rr.setname = "default";
684 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
686 rr.comp = (Z_RecordComposition *)
687 odr_malloc(assoc->decode, sizeof(*rr.comp));
688 rr.comp->which = Z_RecordComp_complex;
689 rr.comp->u.complex = (Z_CompSpec *)
690 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
691 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
692 odr_malloc(assoc->encode, sizeof(bool_t));
693 *rr.comp->u.complex->selectAlternativeSyntax = 0;
694 rr.comp->u.complex->num_dbSpecific = 0;
695 rr.comp->u.complex->dbSpecific = 0;
696 rr.comp->u.complex->num_recordSyntax = 0;
697 rr.comp->u.complex->recordSyntax = 0;
699 rr.comp->u.complex->generic = (Z_Specification *)
700 odr_malloc(assoc->decode, sizeof(Z_Specification));
702 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
703 rr.comp->u.complex->generic->which = Z_Schema_uri;
704 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
706 /* ESN = recordSchema if recordSchema is present */
707 rr.comp->u.complex->generic->elementSpec = 0;
708 if (srw_req->recordSchema)
710 rr.comp->u.complex->generic->elementSpec =
711 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
712 rr.comp->u.complex->generic->elementSpec->which =
713 Z_ElementSpec_elementSetName;
714 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
715 srw_req->recordSchema;
718 rr.stream = assoc->encode;
719 rr.print = assoc->print;
727 rr.surrogate_flag = 0;
728 rr.schema = srw_req->recordSchema;
730 if (!assoc->init->bend_fetch)
733 retrieve_fetch(assoc, &rr);
735 if (rr.errcode && rr.surrogate_flag)
737 int code = yaz_diag_bib1_to_srw(rr.errcode);
738 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
741 else if (rr.len >= 0)
743 record->recordData_buf = rr.record;
744 record->recordData_len = rr.len;
745 record->recordPosition = odr_intdup(o, pos);
746 record->recordSchema = odr_strdup_null(
747 o, rr.schema ? rr.schema : srw_req->recordSchema);
751 *addinfo = rr.errstring;
757 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
758 Z_Query *query_result)
760 /* have a CQL query and CQL to PQF transform .. */
761 CQL_parser cp = cql_parser_create();
767 r = cql_parser_string(cp, cql);
770 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
775 r = cql_transform_buf(ct,
776 cql_parser_result(cp),
777 rpn_buf, sizeof(rpn_buf)-1);
779 srw_errcode = cql_transform_error(ct, &add);
783 /* Syntax & transform OK. */
784 /* Convert PQF string to Z39.50 to RPN query struct */
785 YAZ_PQF_Parser pp = yaz_pqf_create();
786 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
791 int code = yaz_pqf_error(pp, &pqf_msg, &off);
792 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
794 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
798 query_result->which = Z_Query_type_1;
799 query_result->u.type_1 = rpnquery;
803 cql_parser_destroy(cp);
807 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
808 Z_AttributesPlusTerm *result)
812 int srw_error = cql2pqf(odr, cql, ct, &query);
815 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
816 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
817 rpn = query.u.type_1;
818 if (!rpn->RPNStructure)
819 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
820 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
821 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
822 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
823 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
824 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
830 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
831 bend_search_rr *bsrr) {
833 struct ccl_rpn_node *node;
836 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
837 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0) {
838 bsrr->errstring = (char*) ccl_err_msg(errcode);
839 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
842 bsrr->query->which = Z_Query_type_1;
843 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
848 static void srw_bend_search(association *assoc, request *req,
850 Z_SRW_searchRetrieveResponse *srw_res,
855 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
858 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
859 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
860 if (srw_res->num_diagnostics == 0 && assoc->init)
863 rr.setname = "default";
866 rr.basenames = &srw_req->database;
870 rr.srw_setnameIdleTime = 0;
871 rr.estimated_hit_count = 0;
872 rr.partial_resultset = 0;
873 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
874 rr.query->u.type_1 = 0;
876 if (srw_req->query_type == Z_SRW_query_type_cql)
878 if (assoc->server && assoc->server->cql_transform)
880 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
881 assoc->server->cql_transform,
885 yaz_add_srw_diagnostic(assoc->encode,
886 &srw_res->diagnostics,
887 &srw_res->num_diagnostics,
893 /* CQL query to backend. Wrap it - Z39.50 style */
894 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
895 ext->direct_reference = odr_getoidbystr(assoc->decode,
896 "1.2.840.10003.16.2");
897 ext->indirect_reference = 0;
899 ext->which = Z_External_CQL;
900 ext->u.cql = srw_req->query.cql;
902 rr.query->which = Z_Query_type_104;
903 rr.query->u.type_104 = ext;
906 else if (srw_req->query_type == Z_SRW_query_type_pqf)
908 Z_RPNQuery *RPNquery;
909 YAZ_PQF_Parser pqf_parser;
911 pqf_parser = yaz_pqf_create();
913 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
919 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
920 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
921 code, pqf_msg, (long) off);
922 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
925 rr.query->which = Z_Query_type_1;
926 rr.query->u.type_1 = RPNquery;
928 yaz_pqf_destroy(pqf_parser);
932 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
933 &srw_res->num_diagnostics,
934 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
936 if (rr.query->u.type_1)
938 rr.stream = assoc->encode;
939 rr.decode = assoc->decode;
940 rr.print = assoc->print;
942 if ( srw_req->sort.sortKeys )
943 rr.srw_sortKeys = odr_strdup(assoc->encode,
944 srw_req->sort.sortKeys );
945 rr.association = assoc;
951 yaz_log_zquery_level(log_requestdetail,rr.query);
953 (assoc->init->bend_search)(assoc->backend, &rr);
956 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
962 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
963 yaz_add_srw_diagnostic(assoc->encode,
964 &srw_res->diagnostics,
965 &srw_res->num_diagnostics,
966 srw_error, rr.errstring);
971 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
972 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
974 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
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 %s ", srw_req->database);
1126 if (srw_res->num_diagnostics)
1127 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1128 else if (*http_code != 200)
1129 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1130 else if (srw_res->numberOfRecords)
1132 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1133 (srw_res->numberOfRecords ?
1134 *srw_res->numberOfRecords : 0));
1136 wrbuf_printf(wr, " %s " ODR_INT_PRINTF " +%d",
1137 (srw_res->resultSetId ?
1138 srw_res->resultSetId : "-"),
1139 (srw_req->startRecord ? *srw_req->startRecord : 1),
1140 srw_res->num_records);
1141 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1146 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1149 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1152 for (ptr = ptr->children; ptr; ptr = ptr->next)
1154 if (ptr->type != XML_ELEMENT_NODE)
1156 if (!strcmp((const char *) ptr->name, "explain"))
1159 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1163 ptr = xmlCopyNode(ptr, 1);
1165 xmlDocSetRootElement(doc, ptr);
1167 xmlDocDumpMemory(doc, &buf_out, &len);
1168 content = (char*) odr_malloc(rr->stream, 1+len);
1169 memcpy(content, buf_out, len);
1170 content[len] = '\0';
1174 rr->explain_buf = content;
1182 static void srw_bend_explain(association *assoc, request *req,
1184 Z_SRW_explainResponse *srw_res,
1187 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1188 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1190 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1195 rr.stream = assoc->encode;
1196 rr.decode = assoc->decode;
1197 rr.print = assoc->print;
1199 rr.database = srw_req->database;
1201 rr.server_node_ptr = assoc->server->server_node_ptr;
1203 rr.server_node_ptr = 0;
1204 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1205 if (assoc->init->bend_explain)
1206 (*assoc->init->bend_explain)(assoc->backend, &rr);
1208 srw_bend_explain_default(assoc->backend, &rr);
1212 int packing = Z_SRW_recordPacking_string;
1213 if (srw_req->recordPacking)
1216 yaz_srw_str_to_pack(srw_req->recordPacking);
1218 packing = Z_SRW_recordPacking_string;
1220 srw_res->record.recordSchema = rr.schema;
1221 srw_res->record.recordPacking = packing;
1222 srw_res->record.recordData_buf = rr.explain_buf;
1223 srw_res->record.recordData_len = strlen(rr.explain_buf);
1224 srw_res->record.recordPosition = 0;
1230 static void srw_bend_scan(association *assoc, request *req,
1232 Z_SRW_scanResponse *srw_res,
1235 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1236 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1239 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1240 if (srw_res->num_diagnostics == 0 && assoc->init)
1242 struct scan_entry *save_entries;
1244 bend_scan_rr *bsrr = (bend_scan_rr *)
1245 odr_malloc(assoc->encode, sizeof(*bsrr));
1246 bsrr->num_bases = 1;
1247 bsrr->basenames = &srw_req->database;
1249 bsrr->num_entries = srw_req->maximumTerms ?
1250 *srw_req->maximumTerms : 10;
1251 bsrr->term_position = srw_req->responsePosition ?
1252 *srw_req->responsePosition : 1;
1255 bsrr->errstring = 0;
1256 bsrr->referenceId = 0;
1257 bsrr->stream = assoc->encode;
1258 bsrr->print = assoc->print;
1259 bsrr->step_size = odr_intdup(assoc->decode, 0);
1263 if (bsrr->num_entries > 0)
1266 bsrr->entries = (struct scan_entry *)
1267 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1269 for (i = 0; i<bsrr->num_entries; i++)
1271 bsrr->entries[i].term = 0;
1272 bsrr->entries[i].occurrences = 0;
1273 bsrr->entries[i].errcode = 0;
1274 bsrr->entries[i].errstring = 0;
1275 bsrr->entries[i].display_term = 0;
1278 save_entries = bsrr->entries; /* save it so we can compare later */
1280 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1281 assoc->init->bend_scan)
1283 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1285 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1286 &bsrr->attributeset,
1287 srw_req->scanClause.pqf);
1288 yaz_pqf_destroy(pqf_parser);
1289 bsrr->scanClause = 0;
1290 ((int (*)(void *, bend_scan_rr *))
1291 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1293 else if (srw_req->query_type == Z_SRW_query_type_cql
1294 && assoc->init->bend_scan && assoc->server
1295 && assoc->server->cql_transform)
1298 bsrr->scanClause = 0;
1299 bsrr->attributeset = 0;
1300 bsrr->term = (Z_AttributesPlusTerm *)
1301 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1302 srw_error = cql2pqf_scan(assoc->encode,
1303 srw_req->scanClause.cql,
1304 assoc->server->cql_transform,
1307 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1308 &srw_res->num_diagnostics,
1312 ((int (*)(void *, bend_scan_rr *))
1313 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1316 else if (srw_req->query_type == Z_SRW_query_type_cql
1317 && assoc->init->bend_srw_scan)
1320 bsrr->attributeset = 0;
1321 bsrr->scanClause = srw_req->scanClause.cql;
1322 ((int (*)(void *, bend_scan_rr *))
1323 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1327 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1328 &srw_res->num_diagnostics,
1329 YAZ_SRW_UNSUPP_OPERATION, "scan");
1334 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1339 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1341 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1342 &srw_res->num_diagnostics,
1343 srw_error, bsrr->errstring);
1345 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1348 srw_res->terms = (Z_SRW_scanTerm*)
1349 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1352 srw_res->num_terms = bsrr->num_entries;
1353 for (i = 0; i<bsrr->num_entries; i++)
1355 Z_SRW_scanTerm *t = srw_res->terms + i;
1356 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1357 t->numberOfRecords =
1358 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1360 if (save_entries == bsrr->entries &&
1361 bsrr->entries[i].display_term)
1363 /* the entries was _not_ set by the handler. So it's
1364 safe to test for new member display_term. It is
1367 t->displayTerm = odr_strdup(assoc->encode,
1368 bsrr->entries[i].display_term);
1376 WRBUF wr = wrbuf_alloc();
1377 const char *querytype = 0;
1378 const char *querystr = 0;
1380 switch(srw_req->query_type)
1382 case Z_SRW_query_type_pqf:
1384 querystr = srw_req->scanClause.pqf;
1386 case Z_SRW_query_type_cql:
1388 querystr = srw_req->scanClause.cql;
1391 querytype = "UNKNOWN";
1395 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1397 if (srw_res->num_diagnostics)
1398 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1399 else if (srw_res->num_terms)
1400 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1402 wrbuf_printf(wr, "OK - - ");
1404 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1405 (srw_req->responsePosition ?
1406 *srw_req->responsePosition : 1),
1407 (srw_req->maximumTerms ?
1408 *srw_req->maximumTerms : 1));
1409 /* there is no step size in SRU/W ??? */
1410 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1411 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1417 static void srw_bend_update(association *assoc, request *req,
1419 Z_SRW_updateResponse *srw_res,
1422 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1423 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1424 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1426 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1430 Z_SRW_extra_record *extra = srw_req->extra_record;
1432 rr.stream = assoc->encode;
1433 rr.print = assoc->print;
1435 rr.basenames = &srw_req->database;
1436 rr.operation = srw_req->operation;
1437 rr.operation_status = "failed";
1439 rr.record_versions = 0;
1440 rr.num_versions = 0;
1441 rr.record_packing = "string";
1442 rr.record_schema = 0;
1444 rr.extra_record_data = 0;
1445 rr.extra_request_data = 0;
1446 rr.extra_response_data = 0;
1452 if (rr.operation == 0)
1454 yaz_add_sru_update_diagnostic(
1455 assoc->encode, &srw_res->diagnostics,
1456 &srw_res->num_diagnostics,
1457 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1461 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1462 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1463 if (!strcmp( rr.operation, "delete"))
1465 if (srw_req->record && !srw_req->record->recordSchema)
1467 rr.record_schema = odr_strdup(
1469 srw_req->record->recordSchema);
1471 if (srw_req->record)
1473 rr.record_data = odr_strdupn(
1475 srw_req->record->recordData_buf,
1476 srw_req->record->recordData_len );
1478 if (extra && extra->extraRecordData_len)
1480 rr.extra_record_data = odr_strdupn(
1482 extra->extraRecordData_buf,
1483 extra->extraRecordData_len );
1485 if (srw_req->recordId)
1486 rr.record_id = srw_req->recordId;
1487 else if (extra && extra->recordIdentifier)
1488 rr.record_id = extra->recordIdentifier;
1490 else if (!strcmp(rr.operation, "replace"))
1492 if (srw_req->recordId)
1493 rr.record_id = srw_req->recordId;
1494 else if (extra && extra->recordIdentifier)
1495 rr.record_id = extra->recordIdentifier;
1498 yaz_add_sru_update_diagnostic(
1499 assoc->encode, &srw_res->diagnostics,
1500 &srw_res->num_diagnostics,
1501 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1502 "recordIdentifier");
1504 if (!srw_req->record)
1506 yaz_add_sru_update_diagnostic(
1507 assoc->encode, &srw_res->diagnostics,
1508 &srw_res->num_diagnostics,
1509 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1514 if (srw_req->record->recordSchema)
1515 rr.record_schema = odr_strdup(
1516 assoc->encode, srw_req->record->recordSchema);
1517 if (srw_req->record->recordData_len )
1519 rr.record_data = odr_strdupn(assoc->encode,
1520 srw_req->record->recordData_buf,
1521 srw_req->record->recordData_len );
1525 yaz_add_sru_update_diagnostic(
1526 assoc->encode, &srw_res->diagnostics,
1527 &srw_res->num_diagnostics,
1528 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1532 if (extra && extra->extraRecordData_len)
1534 rr.extra_record_data = odr_strdupn(
1536 extra->extraRecordData_buf,
1537 extra->extraRecordData_len );
1540 else if (!strcmp(rr.operation, "insert"))
1542 if (srw_req->recordId)
1543 rr.record_id = srw_req->recordId;
1545 rr.record_id = extra->recordIdentifier;
1547 if (srw_req->record)
1549 if (srw_req->record->recordSchema)
1550 rr.record_schema = odr_strdup(
1551 assoc->encode, srw_req->record->recordSchema);
1553 if (srw_req->record->recordData_len)
1554 rr.record_data = odr_strdupn(
1556 srw_req->record->recordData_buf,
1557 srw_req->record->recordData_len );
1559 if (extra && extra->extraRecordData_len)
1561 rr.extra_record_data = odr_strdupn(
1563 extra->extraRecordData_buf,
1564 extra->extraRecordData_len );
1568 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1569 &srw_res->num_diagnostics,
1570 YAZ_SRU_UPDATE_INVALID_ACTION,
1573 if (srw_req->record)
1575 const char *pack_str =
1576 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1578 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1581 if (srw_req->num_recordVersions)
1583 rr.record_versions = srw_req->recordVersions;
1584 rr.num_versions = srw_req->num_recordVersions;
1586 if (srw_req->extraRequestData_len)
1588 rr.extra_request_data = odr_strdupn(assoc->encode,
1589 srw_req->extraRequestData_buf,
1590 srw_req->extraRequestData_len );
1592 if (srw_res->num_diagnostics == 0)
1594 if ( assoc->init->bend_srw_update)
1595 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1597 yaz_add_sru_update_diagnostic(
1598 assoc->encode, &srw_res->diagnostics,
1599 &srw_res->num_diagnostics,
1600 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1601 "No Update backend handler");
1605 yaz_add_srw_diagnostic_uri(assoc->encode,
1606 &srw_res->diagnostics,
1607 &srw_res->num_diagnostics,
1611 srw_res->recordId = rr.record_id;
1612 srw_res->operationStatus = rr.operation_status;
1613 srw_res->recordVersions = rr.record_versions;
1614 srw_res->num_recordVersions = rr.num_versions;
1615 if (srw_res->extraResponseData_len)
1617 srw_res->extraResponseData_buf = rr.extra_response_data;
1618 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1620 if (srw_res->num_diagnostics == 0 && rr.record_data)
1622 srw_res->record = yaz_srw_get_record(assoc->encode);
1623 srw_res->record->recordSchema = rr.record_schema;
1624 if (rr.record_packing)
1626 int pack = yaz_srw_str_to_pack(rr.record_packing);
1630 pack = Z_SRW_recordPacking_string;
1631 yaz_log(YLOG_WARN, "Back packing %s from backend",
1634 srw_res->record->recordPacking = pack;
1636 srw_res->record->recordData_buf = rr.record_data;
1637 srw_res->record->recordData_len = strlen(rr.record_data);
1638 if (rr.extra_record_data)
1640 Z_SRW_extra_record *ex =
1641 yaz_srw_get_extra_record(assoc->encode);
1642 srw_res->extra_record = ex;
1643 ex->extraRecordData_buf = rr.extra_record_data;
1644 ex->extraRecordData_len = strlen(rr.extra_record_data);
1650 /* check if path is OK (1); BAD (0) */
1651 static int check_path(const char *path)
1655 if (strstr(path, ".."))
1660 static char *read_file(const char *fname, ODR o, size_t *sz)
1663 FILE *inf = fopen(fname, "rb");
1667 fseek(inf, 0L, SEEK_END);
1670 buf = (char *) odr_malloc(o, *sz);
1671 if (fread(buf, 1, *sz, inf) != *sz)
1672 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1677 static void process_http_request(association *assoc, request *req)
1679 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1680 ODR o = assoc->encode;
1681 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1683 Z_SOAP *soap_package = 0;
1686 Z_HTTP_Response *hres = 0;
1688 const char *stylesheet = 0; /* for now .. set later */
1689 Z_SRW_diagnostic *diagnostic = 0;
1690 int num_diagnostic = 0;
1691 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1693 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
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);
2368 assoc->state = ASSOC_UP;
2372 if (!req->idAuthentication)
2373 yaz_log(log_request, "Auth none");
2374 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2376 const char *open = req->idAuthentication->u.open;
2377 const char *slash = strchr(open, '/');
2383 yaz_log(log_request, "Auth open %.*s", len, open);
2385 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2387 const char *user = req->idAuthentication->u.idPass->userId;
2388 const char *group = req->idAuthentication->u.idPass->groupId;
2389 yaz_log(log_request, "Auth idPass %s %s",
2390 user ? user : "-", group ? group : "-");
2392 else if (req->idAuthentication->which
2393 == Z_IdAuthentication_anonymous)
2395 yaz_log(log_request, "Auth anonymous");
2399 yaz_log(log_request, "Auth other");
2404 WRBUF wr = wrbuf_alloc();
2405 wrbuf_printf(wr, "Init ");
2406 if (binitres->errcode)
2407 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2409 wrbuf_printf(wr, "OK -");
2410 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2411 (req->implementationId ? req->implementationId :"-"),
2412 (req->implementationName ?
2413 req->implementationName : "-"),
2414 (req->implementationVersion ?
2415 req->implementationVersion : "-")
2417 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2424 * Set the specified `errcode' and `errstring' into a UserInfo-1
2425 * external to be returned to the client in accordance with Z35.90
2426 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2427 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2429 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2431 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2432 addinfo ? " -- " : "", addinfo ? addinfo : "");
2433 return zget_init_diagnostics(odr, error, addinfo);
2437 * nonsurrogate diagnostic record.
2439 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2441 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2443 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2444 addinfo ? " -- " : "", addinfo ? addinfo : "");
2446 rec->which = Z_Records_NSD;
2447 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2453 * surrogate diagnostic.
2455 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2457 int error, const char *addinfo)
2459 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2460 addinfo ? " -- " : "", addinfo ? addinfo : "");
2461 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2464 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2465 Odr_int *num, Z_RecordComposition *comp,
2466 Odr_int *next, Odr_int *pres,
2467 Z_ReferenceId *referenceId,
2468 Odr_oid *oid, int *errcode)
2470 int recno, total_length = 0, toget = *num, dumped_records = 0;
2471 Z_Records *records =
2472 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2473 Z_NamePlusRecordList *reclist =
2474 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2475 Z_NamePlusRecord **list =
2476 (Z_NamePlusRecord **) odr_malloc(a->encode, sizeof(*list) * toget);
2478 records->which = Z_Records_DBOSD;
2479 records->u.databaseOrSurDiagnostics = reclist;
2480 reclist->num_records = 0;
2481 reclist->records = list;
2482 *pres = Z_PresentStatus_success;
2486 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2487 yaz_log(log_requestdetail, "pms=" ODR_INT_PRINTF
2488 ", mrs=" ODR_INT_PRINTF, a->preferredMessageSize,
2489 a->maximumRecordSize);
2490 for (recno = start; reclist->num_records < toget; recno++)
2493 Z_NamePlusRecord *thisrec;
2494 int this_length = 0;
2496 * we get the number of bytes allocated on the stream before any
2497 * allocation done by the backend - this should give us a reasonable
2498 * idea of the total size of the data so far.
2500 total_length = odr_total(a->encode) - dumped_records;
2506 freq.last_in_set = 0;
2507 freq.setname = setname;
2508 freq.surrogate_flag = 0;
2509 freq.number = recno;
2511 freq.request_format = oid;
2512 freq.output_format = 0;
2513 freq.stream = a->encode;
2514 freq.print = a->print;
2515 freq.referenceId = referenceId;
2518 retrieve_fetch(a, &freq);
2520 *next = freq.last_in_set ? 0 : recno + 1;
2524 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2527 *pres = Z_PresentStatus_failure;
2528 /* for 'present request out of range',
2529 set addinfo to record position if not set */
2530 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2531 freq.errstring == 0)
2533 sprintf (s, "%d", recno);
2537 *errcode = freq.errcode;
2538 return diagrec(a, freq.errcode, freq.errstring);
2540 reclist->records[reclist->num_records] =
2541 surrogatediagrec(a, freq.basename, freq.errcode,
2543 reclist->num_records++;
2546 if (freq.record == 0) /* no error and no record ? */
2548 *next = 0; /* signal end-of-set and stop */
2552 this_length = freq.len;
2554 this_length = odr_total(a->encode) - total_length - dumped_records;
2555 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2556 this_length, total_length, dumped_records);
2557 if (a->preferredMessageSize > 0 &&
2558 this_length + total_length > a->preferredMessageSize)
2560 /* record is small enough, really */
2561 if (this_length <= a->preferredMessageSize && recno > start)
2563 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2564 *pres = Z_PresentStatus_partial_2;
2567 /* record can only be fetched by itself */
2568 if (this_length < a->maximumRecordSize)
2570 yaz_log(log_requestdetail, " Record > prefmsgsz");
2573 yaz_log(YLOG_DEBUG, " Dropped it");
2574 reclist->records[reclist->num_records] =
2575 surrogatediagrec(a, freq.basename, 16, 0);
2576 reclist->num_records++;
2577 dumped_records += this_length;
2581 else /* too big entirely */
2583 yaz_log(log_requestdetail, "Record > maxrcdsz "
2584 "this=%d max=" ODR_INT_PRINTF,
2585 this_length, a->maximumRecordSize);
2586 reclist->records[reclist->num_records] =
2587 surrogatediagrec(a, freq.basename, 17, 0);
2588 reclist->num_records++;
2589 dumped_records += this_length;
2594 if (!(thisrec = (Z_NamePlusRecord *)
2595 odr_malloc(a->encode, sizeof(*thisrec))))
2597 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2598 thisrec->which = Z_NamePlusRecord_databaseRecord;
2600 if (!freq.output_format)
2601 freq.output_format = freq.request_format;
2602 thisrec->u.databaseRecord = z_ext_record_oid(
2603 a->encode, freq.output_format, freq.record, freq.len);
2604 if (!thisrec->u.databaseRecord)
2606 reclist->records[reclist->num_records] = thisrec;
2607 reclist->num_records++;
2609 *num = reclist->num_records;
2613 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2616 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2617 bend_search_rr *bsrr =
2618 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2620 yaz_log(log_requestdetail, "Got SearchRequest.");
2622 bsrr->request = reqb;
2623 bsrr->association = assoc;
2624 bsrr->referenceId = req->referenceId;
2625 save_referenceId (reqb, bsrr->referenceId);
2626 bsrr->srw_sortKeys = 0;
2627 bsrr->srw_setname = 0;
2628 bsrr->srw_setnameIdleTime = 0;
2629 bsrr->estimated_hit_count = 0;
2630 bsrr->partial_resultset = 0;
2632 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2633 if (req->databaseNames)
2636 for (i = 0; i < req->num_databaseNames; i++)
2637 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2640 yaz_log_zquery_level(log_requestdetail,req->query);
2642 if (assoc->init->bend_search)
2644 bsrr->setname = req->resultSetName;
2645 bsrr->replace_set = *req->replaceIndicator;
2646 bsrr->num_bases = req->num_databaseNames;
2647 bsrr->basenames = req->databaseNames;
2648 bsrr->query = req->query;
2649 bsrr->stream = assoc->encode;
2650 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2651 bsrr->decode = assoc->decode;
2652 bsrr->print = assoc->print;
2655 bsrr->errstring = NULL;
2656 bsrr->search_info = NULL;
2658 if (assoc->server && assoc->server->cql_transform
2659 && req->query->which == Z_Query_type_104
2660 && req->query->u.type_104->which == Z_External_CQL)
2662 /* have a CQL query and a CQL to PQF transform .. */
2664 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2665 assoc->server->cql_transform, bsrr->query);
2667 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2670 if (assoc->server && assoc->server->ccl_transform
2671 && req->query->which == Z_Query_type_2) /*CCL*/
2673 /* have a CCL query and a CCL to PQF transform .. */
2675 ccl2pqf(bsrr->stream, req->query->u.type_2,
2676 assoc->server->ccl_transform, bsrr);
2678 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2682 (assoc->init->bend_search)(assoc->backend, bsrr);
2683 if (!bsrr->request) /* backend not ready with the search response */
2684 return 0; /* should not be used any more */
2688 /* FIXME - make a diagnostic for it */
2689 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2691 return response_searchRequest(assoc, reqb, bsrr, fd);
2694 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2697 * Prepare a searchresponse based on the backend results. We probably want
2698 * to look at making the fetching of records nonblocking as well, but
2699 * so far, we'll keep things simple.
2700 * If bsrt is null, that means we're called in response to a communications
2701 * event, and we'll have to get the response for ourselves.
2703 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2704 bend_search_rr *bsrt, int *fd)
2706 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2707 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2708 Z_SearchResponse *resp = (Z_SearchResponse *)
2709 odr_malloc(assoc->encode, sizeof(*resp));
2710 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2711 Odr_int *next = odr_intdup(assoc->encode, 0);
2712 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2713 int returnedrecs = 0;
2715 apdu->which = Z_APDU_searchResponse;
2716 apdu->u.searchResponse = resp;
2717 resp->referenceId = req->referenceId;
2718 resp->additionalSearchInfo = 0;
2719 resp->otherInfo = 0;
2721 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2723 yaz_log(YLOG_FATAL, "Bad result from backend");
2726 else if (bsrt->errcode)
2728 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2729 resp->resultCount = nulint;
2730 resp->numberOfRecordsReturned = nulint;
2731 resp->nextResultSetPosition = nulint;
2732 resp->searchStatus = odr_booldup(assoc->encode, 0);
2733 resp->resultSetStatus = none;
2734 resp->presentStatus = 0;
2738 bool_t *sr = odr_booldup(assoc->encode, 1);
2739 Odr_int *toget = odr_intdup(assoc->encode, 0);
2740 Z_RecordComposition comp, *compp = 0;
2742 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2745 resp->resultCount = &bsrt->hits;
2747 comp.which = Z_RecordComp_simple;
2748 /* how many records does the user agent want, then? */
2749 if (bsrt->hits <= *req->smallSetUpperBound)
2751 *toget = bsrt->hits;
2752 if ((comp.u.simple = req->smallSetElementSetNames))
2755 else if (bsrt->hits < *req->largeSetLowerBound)
2757 *toget = *req->mediumSetPresentNumber;
2758 if (*toget > bsrt->hits)
2759 *toget = bsrt->hits;
2760 if ((comp.u.simple = req->mediumSetElementSetNames))
2766 if (*toget && !resp->records)
2768 Odr_int *presst = odr_intdup(assoc->encode, 0);
2769 /* Call bend_present if defined */
2770 if (assoc->init->bend_present)
2772 bend_present_rr *bprr = (bend_present_rr *)
2773 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2774 bprr->setname = req->resultSetName;
2776 bprr->number = *toget;
2777 bprr->format = req->preferredRecordSyntax;
2779 bprr->referenceId = req->referenceId;
2780 bprr->stream = assoc->encode;
2781 bprr->print = assoc->print;
2782 bprr->request = reqb;
2783 bprr->association = assoc;
2785 bprr->errstring = NULL;
2786 (*assoc->init->bend_present)(assoc->backend, bprr);
2792 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2793 *resp->presentStatus = Z_PresentStatus_failure;
2798 resp->records = pack_records(
2799 assoc, req->resultSetName, 1,
2800 toget, compp, next, presst, req->referenceId,
2801 req->preferredRecordSyntax, NULL);
2804 resp->numberOfRecordsReturned = toget;
2805 returnedrecs = *toget;
2806 resp->presentStatus = presst;
2810 if (*resp->resultCount)
2812 resp->numberOfRecordsReturned = nulint;
2813 resp->presentStatus = 0;
2815 resp->nextResultSetPosition = next;
2816 resp->searchStatus = sr;
2817 resp->resultSetStatus = 0;
2818 if (bsrt->estimated_hit_count)
2820 resp->resultSetStatus = odr_intdup(assoc->encode,
2821 Z_SearchResponse_estimate);
2823 else if (bsrt->partial_resultset)
2825 resp->resultSetStatus = odr_intdup(assoc->encode,
2826 Z_SearchResponse_subset);
2829 resp->additionalSearchInfo = bsrt->search_info;
2834 WRBUF wr = wrbuf_alloc();
2836 for (i = 0 ; i < req->num_databaseNames; i++){
2838 wrbuf_printf(wr, "+");
2839 wrbuf_puts(wr, req->databaseNames[i]);
2841 wrbuf_printf(wr, " ");
2844 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2846 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2847 wrbuf_printf(wr, " %s 1+%d ",
2848 req->resultSetName, returnedrecs);
2849 yaz_query_to_wrbuf(wr, req->query);
2851 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2858 * Maybe we got a little over-friendly when we designed bend_fetch to
2859 * get only one record at a time. Some backends can optimise multiple-record
2860 * fetches, and at any rate, there is some overhead involved in
2861 * all that selecting and hopping around. Problem is, of course, that the
2862 * frontend can't know ahead of time how many records it'll need to
2863 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2864 * is downright lousy as a bulk data transfer protocol.
2866 * To start with, we'll do the fetching of records from the backend
2867 * in one operation: To save some trips in and out of the event-handler,
2868 * and to simplify the interface to pack_records. At any rate, asynch
2869 * operation is more fun in operations that have an unpredictable execution
2870 * speed - which is normally more true for search than for present.
2872 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2875 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2877 Z_PresentResponse *resp;
2881 const char *errstring = 0;
2883 yaz_log(log_requestdetail, "Got PresentRequest.");
2885 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2887 resp->presentStatus = odr_intdup(assoc->encode, 0);
2888 if (assoc->init->bend_present)
2890 bend_present_rr *bprr = (bend_present_rr *)
2891 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2892 bprr->setname = req->resultSetId;
2893 bprr->start = *req->resultSetStartPoint;
2894 bprr->number = *req->numberOfRecordsRequested;
2895 bprr->format = req->preferredRecordSyntax;
2896 bprr->comp = req->recordComposition;
2897 bprr->referenceId = req->referenceId;
2898 bprr->stream = assoc->encode;
2899 bprr->print = assoc->print;
2900 bprr->request = reqb;
2901 bprr->association = assoc;
2903 bprr->errstring = NULL;
2904 (*assoc->init->bend_present)(assoc->backend, bprr);
2907 return 0; /* should not happen */
2910 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2911 *resp->presentStatus = Z_PresentStatus_failure;
2912 errcode = bprr->errcode;
2913 errstring = bprr->errstring;
2916 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2917 next = odr_intdup(assoc->encode, 0);
2918 num = odr_intdup(assoc->encode, 0);
2920 apdu->which = Z_APDU_presentResponse;
2921 apdu->u.presentResponse = resp;
2922 resp->referenceId = req->referenceId;
2923 resp->otherInfo = 0;
2927 *num = *req->numberOfRecordsRequested;
2929 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2930 num, req->recordComposition, next,
2931 resp->presentStatus,
2932 req->referenceId, req->preferredRecordSyntax,
2937 WRBUF wr = wrbuf_alloc();
2938 wrbuf_printf(wr, "Present ");
2940 if (*resp->presentStatus == Z_PresentStatus_failure)
2941 wrbuf_printf(wr, "ERROR %d ", errcode);
2942 else if (*resp->presentStatus == Z_PresentStatus_success)
2943 wrbuf_printf(wr, "OK - ");
2945 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2946 *resp->presentStatus);
2948 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
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 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2973 Odr_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 = odr_intdup(assoc->encode,
3073 res->positionOfTerm = &bsrr->term_position;
3074 for (i = 0; i < bsrr->num_entries; i++)
3080 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3081 if (bsrr->entries[i].occurrences >= 0)
3083 e->which = Z_Entry_termInfo;
3084 e->u.termInfo = t = (Z_TermInfo *)
3085 odr_malloc(assoc->encode, sizeof(*t));
3086 t->suggestedAttributes = 0;
3088 if (save_entries == bsrr->entries &&
3089 bsrr->entries[i].display_term)
3091 /* the entries was _not_ set by the handler. So it's
3092 safe to test for new member display_term. It is
3095 t->displayTerm = odr_strdup(assoc->encode,
3096 bsrr->entries[i].display_term);
3098 t->alternativeTerm = 0;
3099 t->byAttributes = 0;
3100 t->otherTermInfo = 0;
3101 t->globalOccurrences = &bsrr->entries[i].occurrences;
3102 t->term = (Z_Term *)
3103 odr_malloc(assoc->encode, sizeof(*t->term));
3104 t->term->which = Z_Term_general;
3105 t->term->u.general = o =
3106 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3107 o->buf = (unsigned char *)
3108 odr_malloc(assoc->encode, o->len = o->size =
3109 strlen(bsrr->entries[i].term));
3110 memcpy(o->buf, bsrr->entries[i].term, o->len);
3111 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3112 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3116 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3117 bsrr->entries[i].errcode,
3118 bsrr->entries[i].errstring);
3119 assert(drecs->num_diagRecs == 1);
3120 e->which = Z_Entry_surrogateDiagnostic;
3121 assert(drecs->diagRecs[0]);
3122 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3128 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3129 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3134 WRBUF wr = wrbuf_alloc();
3135 wrbuf_printf(wr, "Scan ");
3136 for (i = 0 ; i < req->num_databaseNames; i++)
3139 wrbuf_printf(wr, "+");
3140 wrbuf_puts(wr, req->databaseNames[i]);
3143 wrbuf_printf(wr, " ");
3146 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3148 wrbuf_printf(wr, "OK");
3150 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3151 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3152 res->numberOfEntriesReturned ?
3153 *res->numberOfEntriesReturned : 0,
3154 (req->preferredPositionInResponse ?
3155 *req->preferredPositionInResponse : 1),
3156 *req->numberOfTermsRequested,
3157 (res->stepSize ? *res->stepSize : 1));
3160 wrbuf_printf(wr, "+%s", bsrr->setname);
3162 wrbuf_printf(wr, " ");
3163 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3164 bsrr->attributeset);
3165 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3171 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3175 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3176 Z_SortResponse *res = (Z_SortResponse *)
3177 odr_malloc(assoc->encode, sizeof(*res));
3178 bend_sort_rr *bsrr = (bend_sort_rr *)
3179 odr_malloc(assoc->encode, sizeof(*bsrr));
3181 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3183 yaz_log(log_requestdetail, "Got SortRequest.");
3185 bsrr->num_input_setnames = req->num_inputResultSetNames;
3186 for (i=0;i<req->num_inputResultSetNames;i++)
3187 yaz_log(log_requestdetail, "Input resultset: '%s'",
3188 req->inputResultSetNames[i]);
3189 bsrr->input_setnames = req->inputResultSetNames;
3190 bsrr->referenceId = req->referenceId;
3191 bsrr->output_setname = req->sortedResultSetName;
3192 yaz_log(log_requestdetail, "Output resultset: '%s'",
3193 req->sortedResultSetName);
3194 bsrr->sort_sequence = req->sortSequence;
3195 /*FIXME - dump those sequences too */
3196 bsrr->stream = assoc->encode;
3197 bsrr->print = assoc->print;
3199 bsrr->sort_status = Z_SortResponse_failure;
3201 bsrr->errstring = 0;
3203 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3205 res->referenceId = bsrr->referenceId;
3206 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3207 res->resultSetStatus = 0;
3210 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3211 bsrr->errcode, bsrr->errstring);
3212 res->diagnostics = dr->diagRecs;
3213 res->num_diagnostics = dr->num_diagRecs;
3217 res->num_diagnostics = 0;
3218 res->diagnostics = 0;
3220 res->resultCount = 0;
3223 apdu->which = Z_APDU_sortResponse;
3224 apdu->u.sortResponse = res;
3227 WRBUF wr = wrbuf_alloc();
3228 wrbuf_printf(wr, "Sort ");
3230 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3232 wrbuf_printf(wr, "OK -");
3233 wrbuf_printf(wr, " (");
3234 for (i = 0; i<req->num_inputResultSetNames; i++)
3237 wrbuf_printf(wr, "+");
3238 wrbuf_puts(wr, req->inputResultSetNames[i]);
3240 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3242 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3248 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3252 Z_DeleteResultSetRequest *req =
3253 reqb->apdu_request->u.deleteResultSetRequest;
3254 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3255 odr_malloc(assoc->encode, sizeof(*res));
3256 bend_delete_rr *bdrr = (bend_delete_rr *)
3257 odr_malloc(assoc->encode, sizeof(*bdrr));
3258 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3260 yaz_log(log_requestdetail, "Got DeleteRequest.");
3262 bdrr->num_setnames = req->num_resultSetList;
3263 bdrr->setnames = req->resultSetList;
3264 for (i = 0; i<req->num_resultSetList; i++)
3265 yaz_log(log_requestdetail, "resultset: '%s'",
3266 req->resultSetList[i]);
3267 bdrr->stream = assoc->encode;
3268 bdrr->print = assoc->print;
3269 bdrr->function = *req->deleteFunction;
3270 bdrr->referenceId = req->referenceId;
3272 if (bdrr->num_setnames > 0)
3274 bdrr->statuses = (Odr_int*)
3275 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3276 bdrr->num_setnames);
3277 for (i = 0; i < bdrr->num_setnames; i++)
3278 bdrr->statuses[i] = 0;
3280 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3282 res->referenceId = req->referenceId;
3284 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3286 res->deleteListStatuses = 0;
3287 if (bdrr->num_setnames > 0)
3290 res->deleteListStatuses = (Z_ListStatuses *)
3291 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3292 res->deleteListStatuses->num = bdrr->num_setnames;
3293 res->deleteListStatuses->elements =
3295 odr_malloc(assoc->encode,
3296 sizeof(*res->deleteListStatuses->elements) *
3297 bdrr->num_setnames);
3298 for (i = 0; i<bdrr->num_setnames; i++)
3300 res->deleteListStatuses->elements[i] =
3302 odr_malloc(assoc->encode,
3303 sizeof(**res->deleteListStatuses->elements));
3304 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3305 res->deleteListStatuses->elements[i]->id =
3306 odr_strdup(assoc->encode, bdrr->setnames[i]);
3309 res->numberNotDeleted = 0;
3310 res->bulkStatuses = 0;
3311 res->deleteMessage = 0;
3314 apdu->which = Z_APDU_deleteResultSetResponse;
3315 apdu->u.deleteResultSetResponse = res;
3318 WRBUF wr = wrbuf_alloc();
3319 wrbuf_printf(wr, "Delete ");
3320 if (bdrr->delete_status)
3321 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3323 wrbuf_printf(wr, "OK -");
3324 for (i = 0; i<req->num_resultSetList; i++)
3325 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3326 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3332 static void process_close(association *assoc, request *reqb)
3334 Z_Close *req = reqb->apdu_request->u.close;
3335 static char *reasons[] =
3342 "securityViolation",
3349 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3350 reasons[*req->closeReason], req->diagnosticInformation ?
3351 req->diagnosticInformation : "NULL");
3352 if (assoc->version < 3) /* to make do_force respond with close */
3354 do_close_req(assoc, Z_Close_finished,
3355 "Association terminated by client", reqb);
3356 yaz_log(log_request,"Close OK");
3359 void save_referenceId(request *reqb, Z_ReferenceId *refid)
3363 reqb->len_refid = refid->len;
3364 reqb->refid = (char *)nmem_malloc(reqb->request_mem, refid->len);
3365 memcpy(reqb->refid, refid->buf, refid->len);
3369 reqb->len_refid = 0;
3374 void bend_request_send(bend_association a, bend_request req, Z_APDU *res)
3376 process_z_response(a, req, res);
3379 bend_request bend_request_mk(bend_association a)
3381 request *nreq = request_get(&a->outgoing);
3382 nreq->request_mem = nmem_create();
3386 Z_ReferenceId *bend_request_getid(ODR odr, bend_request req)
3391 id = (Odr_oct *)odr_malloc(odr, sizeof(*odr));
3392 id->buf = (unsigned char *)odr_malloc(odr, req->len_refid);
3393 id->len = id->size = req->len_refid;
3394 memcpy(id->buf, req->refid, req->len_refid);
3398 void bend_request_destroy(bend_request *req)
3400 nmem_destroy((*req)->request_mem);
3401 request_release(*req);
3405 int bend_backend_respond(bend_association a, bend_request req)
3409 r = process_z_request(a, req, &msg);
3411 yaz_log(YLOG_WARN, "%s", msg);
3415 void bend_request_setdata(bend_request r, void *p)
3420 void *bend_request_getdata(bend_request r)
3422 return r->clientData;
3425 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3427 bend_segment_rr req;
3429 req.segment = reqb->apdu_request->u.segmentRequest;
3430 req.stream = assoc->encode;
3431 req.decode = assoc->decode;
3432 req.print = assoc->print;
3433 req.association = assoc;
3435 (*assoc->init->bend_segment)(assoc->backend, &req);
3440 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3442 bend_esrequest_rr esrequest;
3443 const char *ext_name = "unknown";
3445 Z_ExtendedServicesRequest *req =
3446 reqb->apdu_request->u.extendedServicesRequest;
3447 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3449 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3451 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3452 esrequest.stream = assoc->encode;
3453 esrequest.decode = assoc->decode;
3454 esrequest.print = assoc->print;
3455 esrequest.errcode = 0;
3456 esrequest.errstring = NULL;
3457 esrequest.request = reqb;
3458 esrequest.association = assoc;
3459 esrequest.taskPackage = 0;
3460 esrequest.referenceId = req->referenceId;
3463 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3465 switch(esrequest.esr->taskSpecificParameters->which)
3467 case Z_External_itemOrder:
3468 ext_name = "ItemOrder"; break;
3469 case Z_External_update:
3470 ext_name = "Update"; break;
3471 case Z_External_update0:
3472 ext_name = "Update0"; break;
3473 case Z_External_ESAdmin:
3474 ext_name = "Admin"; break;
3479 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3481 /* If the response is being delayed, return NULL */
3482 if (esrequest.request == NULL)
3485 resp->referenceId = req->referenceId;
3487 if (esrequest.errcode == -1)
3489 /* Backend service indicates request will be processed */
3490 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3491 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3493 else if (esrequest.errcode == 0)
3495 /* Backend service indicates request will be processed */
3496 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3497 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3501 Z_DiagRecs *diagRecs =
3502 zget_DiagRecs(assoc->encode, esrequest.errcode,
3503 esrequest.errstring);
3504 /* Backend indicates error, request will not be processed */
3505 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3506 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3507 resp->num_diagnostics = diagRecs->num_diagRecs;
3508 resp->diagnostics = diagRecs->diagRecs;
3511 WRBUF wr = wrbuf_alloc();
3512 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3513 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3518 /* Do something with the members of bend_extendedservice */
3519 if (esrequest.taskPackage)
3521 resp->taskPackage = z_ext_record_oid(
3522 assoc->encode, yaz_oid_recsyn_extended,
3523 (const char *) esrequest.taskPackage, -1);
3525 yaz_log(YLOG_DEBUG,"Send the result apdu");
3529 int bend_assoc_is_alive(bend_association assoc)
3531 if (assoc->state == ASSOC_DEAD)
3532 return 0; /* already marked as dead. Don't check I/O chan anymore */
3534 return iochan_is_alive(assoc->client_chan);
3541 * c-file-style: "Stroustrup"
3542 * indent-tabs-mode: nil
3544 * vim: shiftwidth=4 tabstop=8 expandtab