1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2010 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements GFS session logic.
9 * Frontend server logic.
11 * This code receives incoming APDUs, and handles client requests by means
14 * Some of the code is getting quite involved, compared to simpler servers -
15 * primarily because it is asynchronous both in the communication with
16 * the user and the backend. We think the complexity will pay off in
17 * the form of greater flexibility when more asynchronous facilities
20 * Memory management has become somewhat involved. In the simple case, where
21 * only one PDU is pending at a time, it will simply reuse the same memory,
22 * once it has found its working size. When we enable multiple concurrent
23 * operations, perhaps even with multiple parallel calls to the backend, it
24 * will maintain a pool of buffers for encoding and decoding, trying to
25 * minimize memory allocation/deallocation during normal operation.
36 #include <sys/types.h>
44 #define S_ISREG(x) (x & _S_IFREG)
53 #include <libxml/parser.h>
54 #include <libxml/tree.h>
57 #include <yaz/yconfig.h>
58 #include <yaz/xmalloc.h>
59 #include <yaz/comstack.h>
63 #include <yaz/proto.h>
64 #include <yaz/oid_db.h>
66 #include <yaz/logrpn.h>
67 #include <yaz/querytowrbuf.h>
68 #include <yaz/statserv.h>
69 #include <yaz/diagbib1.h>
70 #include <yaz/charneg.h>
71 #include <yaz/otherinfo.h>
72 #include <yaz/yaz-util.h>
73 #include <yaz/pquery.h>
74 #include <yaz/oid_db.h>
77 #include <yaz/backend.h>
78 #include <yaz/yaz-ccl.h>
80 static void process_gdu_request(association *assoc, request *req);
81 static int process_z_request(association *assoc, request *req, char **msg);
82 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
83 static int process_z_response(association *assoc, request *req, Z_APDU *res);
84 static Z_APDU *process_initRequest(association *assoc, request *reqb);
85 static Z_External *init_diagnostics(ODR odr, int errcode,
86 const char *errstring);
87 static Z_APDU *process_searchRequest(association *assoc, request *reqb);
88 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
89 bend_search_rr *bsrr);
90 static Z_APDU *process_presentRequest(association *assoc, request *reqb);
91 static Z_APDU *process_scanRequest(association *assoc, request *reqb);
92 static Z_APDU *process_sortRequest(association *assoc, request *reqb);
93 static void process_close(association *assoc, request *reqb);
94 static Z_APDU *process_deleteRequest(association *assoc, request *reqb);
95 static Z_APDU *process_segmentRequest(association *assoc, request *reqb);
96 static Z_APDU *process_ESRequest(association *assoc, request *reqb);
98 /* dynamic logging levels */
99 static int logbits_set = 0;
100 static int log_session = 0; /* one-line logs for session */
101 static int log_sessiondetail = 0; /* more detailed stuff */
102 static int log_request = 0; /* one-line logs for requests */
103 static int log_requestdetail = 0; /* more detailed stuff */
105 /** get_logbits sets global loglevel bits */
106 static void get_logbits(void)
107 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
111 log_session = yaz_log_module_level("session");
112 log_sessiondetail = yaz_log_module_level("sessiondetail");
113 log_request = yaz_log_module_level("request");
114 log_requestdetail = yaz_log_module_level("requestdetail");
118 static void wr_diag(WRBUF w, int error, const char *addinfo)
120 wrbuf_printf(w, "ERROR %d+", error);
121 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
125 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
130 static int odr_int_to_int(Odr_int v)
134 else if (v <= INT_MIN)
141 * Create and initialize a new association-handle.
142 * channel : iochannel for the current line.
143 * link : communications channel.
144 * Returns: 0 or a new association handle.
146 association *create_association(IOCHAN channel, COMSTACK link,
147 const char *apdufile)
153 if (!(anew = (association *)xmalloc(sizeof(*anew))))
157 anew->last_control = 0;
158 anew->client_chan = channel;
159 anew->client_link = link;
160 anew->cs_get_mask = 0;
161 anew->cs_put_mask = 0;
162 anew->cs_accept_mask = 0;
163 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
164 !(anew->encode = odr_createmem(ODR_ENCODE)))
166 if (apdufile && *apdufile)
170 if (!(anew->print = odr_createmem(ODR_PRINT)))
172 if (*apdufile == '@')
174 odr_setprint(anew->print, yaz_log_file());
176 else if (*apdufile != '-')
179 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
180 if (!(f = fopen(filename, "w")))
182 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
185 setvbuf(f, 0, _IONBF, 0);
186 odr_setprint(anew->print, f);
191 anew->input_buffer = 0;
192 anew->input_buffer_len = 0;
194 anew->state = ASSOC_NEW;
195 request_initq(&anew->incoming);
196 request_initq(&anew->outgoing);
197 anew->proto = cs_getproto(link);
203 * Free association and release resources.
205 void destroy_association(association *h)
207 statserv_options_block *cb = statserv_getcontrol();
211 odr_destroy(h->decode);
212 odr_destroy(h->encode);
214 odr_destroy(h->print);
216 xfree(h->input_buffer);
218 (*cb->bend_close)(h->backend);
219 while ((req = request_deq(&h->incoming)))
220 request_release(req);
221 while ((req = request_deq(&h->outgoing)))
222 request_release(req);
223 request_delq(&h->incoming);
224 request_delq(&h->outgoing);
226 xmalloc_trav("session closed");
227 if (cb && cb->one_shot)
233 static void do_close_req(association *a, int reason, char *message,
236 Z_APDU *apdu = zget_APDU(a->encode, Z_APDU_close);
237 Z_Close *cls = apdu->u.close;
239 /* Purge request queue */
240 while (request_deq(&a->incoming));
241 while (request_deq(&a->outgoing));
244 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
245 reason, message ? message : "none");
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)
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)
840 bsrr->errstring = (char*) ccl_err_msg(errcode);
841 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
844 bsrr->query->which = Z_Query_type_1;
845 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
849 static void srw_bend_search(association *assoc,
854 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
857 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
860 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
861 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
862 if (srw_res->num_diagnostics == 0 && assoc->init)
865 rr.setname = "default";
868 rr.basenames = &srw_req->database;
872 rr.srw_setnameIdleTime = 0;
873 rr.estimated_hit_count = 0;
874 rr.partial_resultset = 0;
875 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
876 rr.query->u.type_1 = 0;
877 rr.extra_args = sr->extra_args;
878 rr.extra_response_data = 0;
880 if (srw_req->query_type == Z_SRW_query_type_cql)
882 if (assoc->server && assoc->server->cql_transform)
884 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
885 assoc->server->cql_transform,
889 yaz_add_srw_diagnostic(assoc->encode,
890 &srw_res->diagnostics,
891 &srw_res->num_diagnostics,
897 /* CQL query to backend. Wrap it - Z39.50 style */
898 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
899 ext->direct_reference = odr_getoidbystr(assoc->decode,
900 "1.2.840.10003.16.2");
901 ext->indirect_reference = 0;
903 ext->which = Z_External_CQL;
904 ext->u.cql = srw_req->query.cql;
906 rr.query->which = Z_Query_type_104;
907 rr.query->u.type_104 = ext;
910 else if (srw_req->query_type == Z_SRW_query_type_pqf)
912 Z_RPNQuery *RPNquery;
913 YAZ_PQF_Parser pqf_parser;
915 pqf_parser = yaz_pqf_create();
917 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
923 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
924 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
925 code, pqf_msg, (long) off);
926 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
929 rr.query->which = Z_Query_type_1;
930 rr.query->u.type_1 = RPNquery;
932 yaz_pqf_destroy(pqf_parser);
936 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
937 &srw_res->num_diagnostics,
938 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
940 if (rr.query->u.type_1)
942 rr.stream = assoc->encode;
943 rr.decode = assoc->decode;
944 rr.print = assoc->print;
945 if ( srw_req->sort.sortKeys )
946 rr.srw_sortKeys = odr_strdup(assoc->encode,
947 srw_req->sort.sortKeys );
948 rr.association = assoc;
953 yaz_log_zquery_level(log_requestdetail,rr.query);
955 (assoc->init->bend_search)(assoc->backend, &rr);
958 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
964 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
965 yaz_add_srw_diagnostic(assoc->encode,
966 &srw_res->diagnostics,
967 &srw_res->num_diagnostics,
968 srw_error, rr.errstring);
973 int number = srw_req->maximumRecords ?
974 odr_int_to_int(*srw_req->maximumRecords) : 0;
975 int start = srw_req->startRecord ?
976 odr_int_to_int(*srw_req->startRecord) : 1;
978 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
980 start, number, rr.hits);
982 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
985 srw_res->resultSetId =
986 odr_strdup(assoc->encode, rr.srw_setname );
987 srw_res->resultSetIdleTime =
988 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
991 if (start > rr.hits || start < 1)
993 /* if hits<=0 and start=1 we don't return a diagnostic */
995 yaz_add_srw_diagnostic(
997 &srw_res->diagnostics, &srw_res->num_diagnostics,
998 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1000 else if (number > 0)
1004 if (start + number > rr.hits)
1005 number = odr_int_to_int(rr.hits) - start + 1;
1007 /* Call bend_present if defined */
1008 if (assoc->init->bend_present)
1010 bend_present_rr *bprr = (bend_present_rr*)
1011 odr_malloc(assoc->decode, sizeof(*bprr));
1012 bprr->setname = "default";
1013 bprr->start = start;
1014 bprr->number = number;
1015 if (srw_req->recordSchema)
1017 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1018 sizeof(*bprr->comp));
1019 bprr->comp->which = Z_RecordComp_simple;
1020 bprr->comp->u.simple = (Z_ElementSetNames *)
1021 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1022 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1023 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1029 bprr->stream = assoc->encode;
1030 bprr->referenceId = 0;
1031 bprr->print = assoc->print;
1032 bprr->association = assoc;
1034 bprr->errstring = NULL;
1035 (*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.extra_response_data)
1099 res->extraResponseData_buf = rr.extra_response_data;
1100 res->extraResponseData_len = strlen(rr.extra_response_data);
1102 if (rr.estimated_hit_count || rr.partial_resultset)
1104 yaz_add_srw_diagnostic(
1106 &srw_res->diagnostics,
1107 &srw_res->num_diagnostics,
1108 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1116 const char *querystr = "?";
1117 const char *querytype = "?";
1118 WRBUF wr = wrbuf_alloc();
1120 switch (srw_req->query_type)
1122 case Z_SRW_query_type_cql:
1124 querystr = srw_req->query.cql;
1126 case Z_SRW_query_type_pqf:
1128 querystr = srw_req->query.pqf;
1131 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1132 if (srw_res->num_diagnostics)
1133 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1134 else if (*http_code != 200)
1135 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1136 else if (srw_res->numberOfRecords)
1138 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1139 (srw_res->numberOfRecords ?
1140 *srw_res->numberOfRecords : 0));
1142 wrbuf_printf(wr, " %s " ODR_INT_PRINTF " +%d",
1143 (srw_res->resultSetId ?
1144 srw_res->resultSetId : "-"),
1145 (srw_req->startRecord ? *srw_req->startRecord : 1),
1146 srw_res->num_records);
1147 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1152 static char *srw_bend_explain_default(bend_explain_rr *rr)
1155 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1158 for (ptr = ptr->children; ptr; ptr = ptr->next)
1160 if (ptr->type != XML_ELEMENT_NODE)
1162 if (!strcmp((const char *) ptr->name, "explain"))
1165 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1169 ptr = xmlCopyNode(ptr, 1);
1171 xmlDocSetRootElement(doc, ptr);
1173 xmlDocDumpMemory(doc, &buf_out, &len);
1174 content = (char*) odr_malloc(rr->stream, 1+len);
1175 memcpy(content, buf_out, len);
1176 content[len] = '\0';
1180 rr->explain_buf = content;
1188 static void srw_bend_explain(association *assoc,
1190 Z_SRW_explainResponse *srw_res,
1193 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1194 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1196 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1201 rr.stream = assoc->encode;
1202 rr.decode = assoc->decode;
1203 rr.print = assoc->print;
1205 rr.database = srw_req->database;
1207 rr.server_node_ptr = assoc->server->server_node_ptr;
1209 rr.server_node_ptr = 0;
1210 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1211 if (assoc->init->bend_explain)
1212 (*assoc->init->bend_explain)(assoc->backend, &rr);
1214 srw_bend_explain_default(&rr);
1218 int packing = Z_SRW_recordPacking_string;
1219 if (srw_req->recordPacking)
1222 yaz_srw_str_to_pack(srw_req->recordPacking);
1224 packing = Z_SRW_recordPacking_string;
1226 srw_res->record.recordSchema = rr.schema;
1227 srw_res->record.recordPacking = packing;
1228 srw_res->record.recordData_buf = rr.explain_buf;
1229 srw_res->record.recordData_len = strlen(rr.explain_buf);
1230 srw_res->record.recordPosition = 0;
1236 static void srw_bend_scan(association *assoc,
1238 Z_SRW_scanResponse *srw_res,
1241 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1242 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1245 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1246 if (srw_res->num_diagnostics == 0 && assoc->init)
1249 struct scan_entry *save_entries;
1251 bend_scan_rr *bsrr = (bend_scan_rr *)
1252 odr_malloc(assoc->encode, sizeof(*bsrr));
1253 bsrr->num_bases = 1;
1254 bsrr->basenames = &srw_req->database;
1256 bsrr->num_entries = srw_req->maximumTerms ?
1257 odr_int_to_int(*srw_req->maximumTerms) : 10;
1258 bsrr->term_position = srw_req->responsePosition ?
1259 odr_int_to_int(*srw_req->responsePosition) : 1;
1262 bsrr->errstring = 0;
1263 bsrr->referenceId = 0;
1264 bsrr->stream = assoc->encode;
1265 bsrr->print = assoc->print;
1266 bsrr->step_size = &step_size;
1270 if (bsrr->num_entries > 0)
1273 bsrr->entries = (struct scan_entry *)
1274 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1276 for (i = 0; i<bsrr->num_entries; i++)
1278 bsrr->entries[i].term = 0;
1279 bsrr->entries[i].occurrences = 0;
1280 bsrr->entries[i].errcode = 0;
1281 bsrr->entries[i].errstring = 0;
1282 bsrr->entries[i].display_term = 0;
1285 save_entries = bsrr->entries; /* save it so we can compare later */
1287 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1288 assoc->init->bend_scan)
1290 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1292 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1293 &bsrr->attributeset,
1294 srw_req->scanClause.pqf);
1295 yaz_pqf_destroy(pqf_parser);
1296 bsrr->scanClause = 0;
1297 ((int (*)(void *, bend_scan_rr *))
1298 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1300 else if (srw_req->query_type == Z_SRW_query_type_cql
1301 && assoc->init->bend_scan && assoc->server
1302 && assoc->server->cql_transform)
1305 bsrr->scanClause = 0;
1306 bsrr->attributeset = 0;
1307 bsrr->term = (Z_AttributesPlusTerm *)
1308 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1309 srw_error = cql2pqf_scan(assoc->encode,
1310 srw_req->scanClause.cql,
1311 assoc->server->cql_transform,
1314 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1315 &srw_res->num_diagnostics,
1319 ((int (*)(void *, bend_scan_rr *))
1320 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1323 else if (srw_req->query_type == Z_SRW_query_type_cql
1324 && assoc->init->bend_srw_scan)
1327 bsrr->attributeset = 0;
1328 bsrr->scanClause = srw_req->scanClause.cql;
1329 ((int (*)(void *, bend_scan_rr *))
1330 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1334 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1335 &srw_res->num_diagnostics,
1336 YAZ_SRW_UNSUPP_OPERATION, "scan");
1341 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1346 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1348 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1349 &srw_res->num_diagnostics,
1350 srw_error, bsrr->errstring);
1352 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1355 srw_res->terms = (Z_SRW_scanTerm*)
1356 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1359 srw_res->num_terms = bsrr->num_entries;
1360 for (i = 0; i<bsrr->num_entries; i++)
1362 Z_SRW_scanTerm *t = srw_res->terms + i;
1363 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1364 t->numberOfRecords =
1365 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1367 if (save_entries == bsrr->entries &&
1368 bsrr->entries[i].display_term)
1370 /* the entries was _not_ set by the handler. So it's
1371 safe to test for new member display_term. It is
1374 t->displayTerm = odr_strdup(assoc->encode,
1375 bsrr->entries[i].display_term);
1383 WRBUF wr = wrbuf_alloc();
1384 const char *querytype = 0;
1385 const char *querystr = 0;
1387 switch(srw_req->query_type)
1389 case Z_SRW_query_type_pqf:
1391 querystr = srw_req->scanClause.pqf;
1393 case Z_SRW_query_type_cql:
1395 querystr = srw_req->scanClause.cql;
1398 querytype = "UNKNOWN";
1402 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1404 if (srw_res->num_diagnostics)
1405 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1406 else if (srw_res->num_terms)
1407 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1409 wrbuf_printf(wr, "OK - - ");
1411 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1412 (srw_req->responsePosition ?
1413 *srw_req->responsePosition : 1),
1414 (srw_req->maximumTerms ?
1415 *srw_req->maximumTerms : 1));
1416 /* there is no step size in SRU/W ??? */
1417 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1418 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1424 static void srw_bend_update(association *assoc,
1426 Z_SRW_updateResponse *srw_res,
1429 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1430 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1431 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1433 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1437 Z_SRW_extra_record *extra = srw_req->extra_record;
1439 rr.stream = assoc->encode;
1440 rr.print = assoc->print;
1442 rr.basenames = &srw_req->database;
1443 rr.operation = srw_req->operation;
1444 rr.operation_status = "failed";
1446 rr.record_versions = 0;
1447 rr.num_versions = 0;
1448 rr.record_packing = "string";
1449 rr.record_schema = 0;
1451 rr.extra_record_data = 0;
1452 rr.extra_request_data = 0;
1453 rr.extra_response_data = 0;
1459 if (rr.operation == 0)
1461 yaz_add_sru_update_diagnostic(
1462 assoc->encode, &srw_res->diagnostics,
1463 &srw_res->num_diagnostics,
1464 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1468 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1469 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1470 if (!strcmp( rr.operation, "delete"))
1472 if (srw_req->record && !srw_req->record->recordSchema)
1474 rr.record_schema = odr_strdup(
1476 srw_req->record->recordSchema);
1478 if (srw_req->record)
1480 rr.record_data = odr_strdupn(
1482 srw_req->record->recordData_buf,
1483 srw_req->record->recordData_len );
1485 if (extra && extra->extraRecordData_len)
1487 rr.extra_record_data = odr_strdupn(
1489 extra->extraRecordData_buf,
1490 extra->extraRecordData_len );
1492 if (srw_req->recordId)
1493 rr.record_id = srw_req->recordId;
1494 else if (extra && extra->recordIdentifier)
1495 rr.record_id = extra->recordIdentifier;
1497 else if (!strcmp(rr.operation, "replace"))
1499 if (srw_req->recordId)
1500 rr.record_id = srw_req->recordId;
1501 else if (extra && extra->recordIdentifier)
1502 rr.record_id = extra->recordIdentifier;
1505 yaz_add_sru_update_diagnostic(
1506 assoc->encode, &srw_res->diagnostics,
1507 &srw_res->num_diagnostics,
1508 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1509 "recordIdentifier");
1511 if (!srw_req->record)
1513 yaz_add_sru_update_diagnostic(
1514 assoc->encode, &srw_res->diagnostics,
1515 &srw_res->num_diagnostics,
1516 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1521 if (srw_req->record->recordSchema)
1522 rr.record_schema = odr_strdup(
1523 assoc->encode, srw_req->record->recordSchema);
1524 if (srw_req->record->recordData_len )
1526 rr.record_data = odr_strdupn(assoc->encode,
1527 srw_req->record->recordData_buf,
1528 srw_req->record->recordData_len );
1532 yaz_add_sru_update_diagnostic(
1533 assoc->encode, &srw_res->diagnostics,
1534 &srw_res->num_diagnostics,
1535 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1539 if (extra && extra->extraRecordData_len)
1541 rr.extra_record_data = odr_strdupn(
1543 extra->extraRecordData_buf,
1544 extra->extraRecordData_len );
1547 else if (!strcmp(rr.operation, "insert"))
1549 if (srw_req->recordId)
1550 rr.record_id = srw_req->recordId;
1552 rr.record_id = extra->recordIdentifier;
1554 if (srw_req->record)
1556 if (srw_req->record->recordSchema)
1557 rr.record_schema = odr_strdup(
1558 assoc->encode, srw_req->record->recordSchema);
1560 if (srw_req->record->recordData_len)
1561 rr.record_data = odr_strdupn(
1563 srw_req->record->recordData_buf,
1564 srw_req->record->recordData_len );
1566 if (extra && extra->extraRecordData_len)
1568 rr.extra_record_data = odr_strdupn(
1570 extra->extraRecordData_buf,
1571 extra->extraRecordData_len );
1575 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1576 &srw_res->num_diagnostics,
1577 YAZ_SRU_UPDATE_INVALID_ACTION,
1580 if (srw_req->record)
1582 const char *pack_str =
1583 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1585 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1588 if (srw_req->num_recordVersions)
1590 rr.record_versions = srw_req->recordVersions;
1591 rr.num_versions = srw_req->num_recordVersions;
1593 if (srw_req->extraRequestData_len)
1595 rr.extra_request_data = odr_strdupn(assoc->encode,
1596 srw_req->extraRequestData_buf,
1597 srw_req->extraRequestData_len );
1599 if (srw_res->num_diagnostics == 0)
1601 if ( assoc->init->bend_srw_update)
1602 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1604 yaz_add_sru_update_diagnostic(
1605 assoc->encode, &srw_res->diagnostics,
1606 &srw_res->num_diagnostics,
1607 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1608 "No Update backend handler");
1612 yaz_add_srw_diagnostic_uri(assoc->encode,
1613 &srw_res->diagnostics,
1614 &srw_res->num_diagnostics,
1618 srw_res->recordId = rr.record_id;
1619 srw_res->operationStatus = rr.operation_status;
1620 srw_res->recordVersions = rr.record_versions;
1621 srw_res->num_recordVersions = rr.num_versions;
1622 if (srw_res->extraResponseData_len)
1624 srw_res->extraResponseData_buf = rr.extra_response_data;
1625 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1627 if (srw_res->num_diagnostics == 0 && rr.record_data)
1629 srw_res->record = yaz_srw_get_record(assoc->encode);
1630 srw_res->record->recordSchema = rr.record_schema;
1631 if (rr.record_packing)
1633 int pack = yaz_srw_str_to_pack(rr.record_packing);
1637 pack = Z_SRW_recordPacking_string;
1638 yaz_log(YLOG_WARN, "Back packing %s from backend",
1641 srw_res->record->recordPacking = pack;
1643 srw_res->record->recordData_buf = rr.record_data;
1644 srw_res->record->recordData_len = strlen(rr.record_data);
1645 if (rr.extra_record_data)
1647 Z_SRW_extra_record *ex =
1648 yaz_srw_get_extra_record(assoc->encode);
1649 srw_res->extra_record = ex;
1650 ex->extraRecordData_buf = rr.extra_record_data;
1651 ex->extraRecordData_len = strlen(rr.extra_record_data);
1657 /* check if path is OK (1); BAD (0) */
1658 static int check_path(const char *path)
1662 if (strstr(path, ".."))
1667 static char *read_file(const char *fname, ODR o, size_t *sz)
1670 FILE *inf = fopen(fname, "rb");
1674 fseek(inf, 0L, SEEK_END);
1677 buf = (char *) odr_malloc(o, *sz);
1678 if (fread(buf, 1, *sz, inf) != *sz)
1679 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1684 static void process_http_request(association *assoc, request *req)
1686 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1687 ODR o = assoc->encode;
1688 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1690 Z_SOAP *soap_package = 0;
1693 Z_HTTP_Response *hres = 0;
1695 const char *stylesheet = 0; /* for now .. set later */
1696 Z_SRW_diagnostic *diagnostic = 0;
1697 int num_diagnostic = 0;
1698 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1700 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1701 if (!control_association(assoc, host, 0))
1703 p = z_get_HTTP_Response(o, 404);
1706 if (r == 2 && assoc->server && assoc->server->docpath
1707 && hreq->path[0] == '/'
1709 /* check if path is a proper prefix of documentroot */
1710 strncmp(hreq->path+1, assoc->server->docpath,
1711 strlen(assoc->server->docpath))
1714 if (!check_path(hreq->path))
1716 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1717 p = z_get_HTTP_Response(o, 404);
1721 size_t content_size = 0;
1722 char *content_buf = read_file(hreq->path+1, o, &content_size);
1725 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1726 p = z_get_HTTP_Response(o, 404);
1730 const char *ctype = 0;
1731 yaz_mime_types types = yaz_mime_types_create();
1733 yaz_mime_types_add(types, "xsl", "application/xml");
1734 yaz_mime_types_add(types, "xml", "application/xml");
1735 yaz_mime_types_add(types, "css", "text/css");
1736 yaz_mime_types_add(types, "html", "text/html");
1737 yaz_mime_types_add(types, "htm", "text/html");
1738 yaz_mime_types_add(types, "txt", "text/plain");
1739 yaz_mime_types_add(types, "js", "application/x-javascript");
1741 yaz_mime_types_add(types, "gif", "image/gif");
1742 yaz_mime_types_add(types, "png", "image/png");
1743 yaz_mime_types_add(types, "jpg", "image/jpeg");
1744 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1746 ctype = yaz_mime_lookup_fname(types, hreq->path);
1749 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1750 p = z_get_HTTP_Response(o, 404);
1754 p = z_get_HTTP_Response(o, 200);
1755 hres = p->u.HTTP_Response;
1756 hres->content_buf = content_buf;
1757 hres->content_len = content_size;
1758 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1760 yaz_mime_types_destroy(types);
1768 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1769 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1771 if (r == 2) /* not taken */
1773 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1774 &diagnostic, &num_diagnostic);
1775 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1777 if (r == 0) /* decode SRW/SRU OK .. */
1779 int http_code = 200;
1780 if (sr->which == Z_SRW_searchRetrieve_request)
1783 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1785 stylesheet = sr->u.request->stylesheet;
1788 res->u.response->diagnostics = diagnostic;
1789 res->u.response->num_diagnostics = num_diagnostic;
1793 srw_bend_search(assoc, sr, res, &http_code);
1795 if (http_code == 200)
1796 soap_package->u.generic->p = res;
1798 else if (sr->which == Z_SRW_explain_request)
1800 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1802 stylesheet = sr->u.explain_request->stylesheet;
1805 res->u.explain_response->diagnostics = diagnostic;
1806 res->u.explain_response->num_diagnostics = num_diagnostic;
1808 srw_bend_explain(assoc, sr, res->u.explain_response, &http_code);
1809 if (http_code == 200)
1810 soap_package->u.generic->p = res;
1812 else if (sr->which == Z_SRW_scan_request)
1814 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1816 stylesheet = sr->u.scan_request->stylesheet;
1819 res->u.scan_response->diagnostics = diagnostic;
1820 res->u.scan_response->num_diagnostics = num_diagnostic;
1822 srw_bend_scan(assoc, sr, res->u.scan_response, &http_code);
1823 if (http_code == 200)
1824 soap_package->u.generic->p = res;
1826 else if (sr->which == Z_SRW_update_request)
1828 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1830 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1833 res->u.update_response->diagnostics = diagnostic;
1834 res->u.update_response->num_diagnostics = num_diagnostic;
1836 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1837 srw_bend_update(assoc, sr, res->u.update_response, &http_code);
1838 if (http_code == 200)
1839 soap_package->u.generic->p = res;
1843 yaz_log(log_request, "SOAP ERROR");
1844 /* FIXME - what error, what query */
1846 z_soap_error(assoc->encode, soap_package,
1847 "SOAP-ENV:Client", "Bad method", 0);
1849 if (http_code == 200 || http_code == 500)
1851 static Z_SOAP_Handler soap_handlers[4] = {
1853 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1854 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1855 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1861 p = z_get_HTTP_Response(o, 200);
1862 hres = p->u.HTTP_Response;
1864 if (!stylesheet && assoc->server)
1865 stylesheet = assoc->server->stylesheet;
1867 /* empty stylesheet means NO stylesheet */
1868 if (stylesheet && *stylesheet == '\0')
1871 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1872 &hres->content_buf, &hres->content_len,
1873 soap_handlers, charset, stylesheet);
1874 hres->code = http_code;
1876 strcpy(ctype, "text/xml");
1877 if (charset && strlen(charset) < sizeof(ctype)-30)
1879 strcat(ctype, "; charset=");
1880 strcat(ctype, charset);
1882 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1885 p = z_get_HTTP_Response(o, http_code);
1889 p = z_get_HTTP_Response(o, 500);
1890 hres = p->u.HTTP_Response;
1891 if (!strcmp(hreq->version, "1.0"))
1893 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1894 if (v && !strcmp(v, "Keep-Alive"))
1898 hres->version = "1.0";
1902 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1903 if (v && !strcmp(v, "close"))
1907 hres->version = "1.1";
1911 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1912 assoc->state = ASSOC_DEAD;
1913 assoc->cs_get_mask = 0;
1918 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1920 if (alive && isdigit(*(const unsigned char *) alive))
1924 if (t < 0 || t > 3600)
1926 iochan_settimeout(assoc->client_chan,t);
1927 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1929 process_gdu_response(assoc, req, p);
1932 static void process_gdu_request(association *assoc, request *req)
1934 if (req->gdu_request->which == Z_GDU_Z3950)
1937 req->apdu_request = req->gdu_request->u.z3950;
1938 if (process_z_request(assoc, req, &msg) < 0)
1939 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1941 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1942 process_http_request(assoc, req);
1945 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1950 * Initiate request processing.
1952 static int process_z_request(association *assoc, request *req, char **msg)
1957 *msg = "Unknown Error";
1958 assert(req && req->state == REQUEST_IDLE);
1959 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1961 *msg = "Missing InitRequest";
1964 switch (req->apdu_request->which)
1966 case Z_APDU_initRequest:
1967 res = process_initRequest(assoc, req); break;
1968 case Z_APDU_searchRequest:
1969 res = process_searchRequest(assoc, req); break;
1970 case Z_APDU_presentRequest:
1971 res = process_presentRequest(assoc, req); break;
1972 case Z_APDU_scanRequest:
1973 if (assoc->init->bend_scan)
1974 res = process_scanRequest(assoc, req);
1977 *msg = "Cannot handle Scan APDU";
1981 case Z_APDU_extendedServicesRequest:
1982 if (assoc->init->bend_esrequest)
1983 res = process_ESRequest(assoc, req);
1986 *msg = "Cannot handle Extended Services APDU";
1990 case Z_APDU_sortRequest:
1991 if (assoc->init->bend_sort)
1992 res = process_sortRequest(assoc, req);
1995 *msg = "Cannot handle Sort APDU";
2000 process_close(assoc, req);
2002 case Z_APDU_deleteResultSetRequest:
2003 if (assoc->init->bend_delete)
2004 res = process_deleteRequest(assoc, req);
2007 *msg = "Cannot handle Delete APDU";
2011 case Z_APDU_segmentRequest:
2012 if (assoc->init->bend_segment)
2014 res = process_segmentRequest(assoc, req);
2018 *msg = "Cannot handle Segment APDU";
2022 case Z_APDU_triggerResourceControlRequest:
2025 *msg = "Bad APDU received";
2030 yaz_log(YLOG_DEBUG, " result immediately available");
2031 retval = process_z_response(assoc, req, res);
2035 yaz_log(YLOG_DEBUG, " result unavailble");
2042 * Encode response, and transfer the request structure to the outgoing queue.
2044 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2046 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2050 if (!z_GDU(assoc->print, &res, 0, 0))
2051 yaz_log(YLOG_WARN, "ODR print error: %s",
2052 odr_errmsg(odr_geterror(assoc->print)));
2053 odr_reset(assoc->print);
2055 if (!z_GDU(assoc->encode, &res, 0, 0))
2057 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2058 odr_errmsg(odr_geterror(assoc->decode)),
2059 odr_getelement(assoc->decode));
2062 req->response = odr_getbuf(assoc->encode, &req->len_response,
2063 &req->size_response);
2064 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2065 odr_reset(assoc->encode);
2066 req->state = REQUEST_IDLE;
2067 request_enq(&assoc->outgoing, req);
2068 /* turn the work over to the ir_session handler */
2069 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2070 assoc->cs_put_mask = EVENT_OUTPUT;
2071 /* Is there more work to be done? give that to the input handler too */
2074 req = request_head(&assoc->incoming);
2075 if (req && req->state == REQUEST_IDLE)
2077 request_deq(&assoc->incoming);
2078 process_gdu_request(assoc, req);
2087 * Encode response, and transfer the request structure to the outgoing queue.
2089 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2091 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*gres));
2092 gres->which = Z_GDU_Z3950;
2093 gres->u.z3950 = res;
2095 return process_gdu_response(assoc, req, gres);
2098 static char *get_vhost(Z_OtherInformation *otherInfo)
2100 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2104 * Handle init request.
2105 * At the moment, we don't check the options
2106 * anywhere else in the code - we just try not to do anything that would
2107 * break a naive client. We'll toss 'em into the association block when
2108 * we need them there.
2110 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2112 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2113 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2114 Z_InitResponse *resp = apdu->u.initResponse;
2115 bend_initresult *binitres;
2117 statserv_options_block *cb = 0; /* by default no control for backend */
2119 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2120 cb = statserv_getcontrol(); /* got control block for backend */
2122 if (cb && assoc->backend)
2123 (*cb->bend_close)(assoc->backend);
2125 yaz_log(log_requestdetail, "Got initRequest");
2126 if (req->implementationId)
2127 yaz_log(log_requestdetail, "Id: %s",
2128 req->implementationId);
2129 if (req->implementationName)
2130 yaz_log(log_requestdetail, "Name: %s",
2131 req->implementationName);
2132 if (req->implementationVersion)
2133 yaz_log(log_requestdetail, "Version: %s",
2134 req->implementationVersion);
2136 assoc_init_reset(assoc);
2138 assoc->init->auth = req->idAuthentication;
2139 assoc->init->referenceId = req->referenceId;
2141 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2143 Z_CharSetandLanguageNegotiation *negotiation =
2144 yaz_get_charneg_record (req->otherInfo);
2146 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2147 assoc->init->charneg_request = negotiation;
2150 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2151 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2152 assoc->init->named_result_sets = 1;
2157 if (req->implementationVersion)
2158 yaz_log(log_requestdetail, "Config: %s",
2161 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2163 /* we have a backend control block, so call that init function */
2164 if (!(binitres = (*cb->bend_init)(assoc->init)))
2166 yaz_log(YLOG_WARN, "Bad response from backend.");
2169 assoc->backend = binitres->handle;
2173 /* no backend. return error */
2174 binitres = (bend_initresult *)
2175 odr_malloc(assoc->encode, sizeof(*binitres));
2176 binitres->errstring = 0;
2177 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2178 iochan_settimeout(assoc->client_chan, 10);
2180 if ((assoc->init->bend_sort))
2181 yaz_log(YLOG_DEBUG, "Sort handler installed");
2182 if ((assoc->init->bend_search))
2183 yaz_log(YLOG_DEBUG, "Search handler installed");
2184 if ((assoc->init->bend_present))
2185 yaz_log(YLOG_DEBUG, "Present handler installed");
2186 if ((assoc->init->bend_esrequest))
2187 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2188 if ((assoc->init->bend_delete))
2189 yaz_log(YLOG_DEBUG, "Delete handler installed");
2190 if ((assoc->init->bend_scan))
2191 yaz_log(YLOG_DEBUG, "Scan handler installed");
2192 if ((assoc->init->bend_segment))
2193 yaz_log(YLOG_DEBUG, "Segment handler installed");
2195 resp->referenceId = req->referenceId;
2197 /* let's tell the client what we can do */
2198 if (ODR_MASK_GET(req->options, Z_Options_search))
2200 ODR_MASK_SET(resp->options, Z_Options_search);
2201 strcat(options, "srch");
2203 if (ODR_MASK_GET(req->options, Z_Options_present))
2205 ODR_MASK_SET(resp->options, Z_Options_present);
2206 strcat(options, " prst");
2208 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2209 assoc->init->bend_delete)
2211 ODR_MASK_SET(resp->options, Z_Options_delSet);
2212 strcat(options, " del");
2214 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2215 assoc->init->bend_esrequest)
2217 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2218 strcat(options, " extendedServices");
2220 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2221 && assoc->init->named_result_sets)
2223 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2224 strcat(options, " namedresults");
2226 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2228 ODR_MASK_SET(resp->options, Z_Options_scan);
2229 strcat(options, " scan");
2231 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2233 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2234 strcat(options, " concurrop");
2236 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2238 ODR_MASK_SET(resp->options, Z_Options_sort);
2239 strcat(options, " sort");
2242 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2244 Z_OtherInformationUnit *p0;
2246 if (!assoc->init->charneg_response)
2248 if (assoc->init->query_charset)
2250 assoc->init->charneg_response = yaz_set_response_charneg(
2251 assoc->encode, assoc->init->query_charset, 0,
2252 assoc->init->records_in_same_charset);
2256 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2259 if (assoc->init->charneg_response
2260 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2262 p0->which = Z_OtherInfo_externallyDefinedInfo;
2263 p0->information.externallyDefinedInfo =
2264 assoc->init->charneg_response;
2265 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2266 strcat(options, " negotiation");
2269 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2270 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2272 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2274 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2275 assoc->version = 1; /* 1 & 2 are equivalent */
2277 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2279 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2282 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2284 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2288 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2290 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2291 assoc->maximumRecordSize = odr_int_to_int(*req->maximumRecordSize);
2293 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2294 assoc->preferredMessageSize = odr_int_to_int(*req->preferredMessageSize);
2296 resp->preferredMessageSize =
2297 odr_intdup(assoc->encode, assoc->preferredMessageSize);
2298 resp->maximumRecordSize =
2299 odr_intdup(assoc->encode, assoc->maximumRecordSize);
2301 resp->implementationId = odr_prepend(assoc->encode,
2302 assoc->init->implementation_id,
2303 resp->implementationId);
2305 resp->implementationName = odr_prepend(assoc->encode,
2306 assoc->init->implementation_name,
2307 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2309 if (binitres->errcode)
2311 assoc->state = ASSOC_DEAD;
2312 resp->userInformationField =
2313 init_diagnostics(assoc->encode, binitres->errcode,
2314 binitres->errstring);
2318 assoc->state = ASSOC_UP;
2322 if (!req->idAuthentication)
2323 yaz_log(log_request, "Auth none");
2324 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2326 const char *open = req->idAuthentication->u.open;
2327 const char *slash = strchr(open, '/');
2333 yaz_log(log_request, "Auth open %.*s", len, open);
2335 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2337 const char *user = req->idAuthentication->u.idPass->userId;
2338 const char *group = req->idAuthentication->u.idPass->groupId;
2339 yaz_log(log_request, "Auth idPass %s %s",
2340 user ? user : "-", group ? group : "-");
2342 else if (req->idAuthentication->which
2343 == Z_IdAuthentication_anonymous)
2345 yaz_log(log_request, "Auth anonymous");
2349 yaz_log(log_request, "Auth other");
2354 WRBUF wr = wrbuf_alloc();
2355 wrbuf_printf(wr, "Init ");
2356 if (binitres->errcode)
2357 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2359 wrbuf_printf(wr, "OK -");
2360 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2361 (req->implementationId ? req->implementationId :"-"),
2362 (req->implementationName ?
2363 req->implementationName : "-"),
2364 (req->implementationVersion ?
2365 req->implementationVersion : "-")
2367 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2374 * Set the specified `errcode' and `errstring' into a UserInfo-1
2375 * external to be returned to the client in accordance with Z35.90
2376 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2377 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2379 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2381 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2382 addinfo ? " -- " : "", addinfo ? addinfo : "");
2383 return zget_init_diagnostics(odr, error, addinfo);
2387 * nonsurrogate diagnostic record.
2389 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2391 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2393 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2394 addinfo ? " -- " : "", addinfo ? addinfo : "");
2396 rec->which = Z_Records_NSD;
2397 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2403 * surrogate diagnostic.
2405 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2407 int error, const char *addinfo)
2409 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2410 addinfo ? " -- " : "", addinfo ? addinfo : "");
2411 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2414 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2415 Odr_int *num, Z_RecordComposition *comp,
2416 Odr_int *next, Odr_int *pres,
2417 Z_ReferenceId *referenceId,
2418 Odr_oid *oid, int *errcode)
2420 int recno, total_length = 0, dumped_records = 0;
2421 int toget = odr_int_to_int(*num);
2422 Z_Records *records =
2423 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2424 Z_NamePlusRecordList *reclist =
2425 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2427 records->which = Z_Records_DBOSD;
2428 records->u.databaseOrSurDiagnostics = reclist;
2429 reclist->num_records = 0;
2432 return diagrec(a, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, 0);
2433 else if (toget == 0)
2434 reclist->records = odr_nullval();
2436 reclist->records = (Z_NamePlusRecord **)
2437 odr_malloc(a->encode, sizeof(*reclist->records) * toget);
2439 *pres = Z_PresentStatus_success;
2443 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2444 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2445 a->maximumRecordSize);
2446 for (recno = odr_int_to_int(start); reclist->num_records < toget; recno++)
2449 Z_NamePlusRecord *thisrec;
2450 int this_length = 0;
2452 * we get the number of bytes allocated on the stream before any
2453 * allocation done by the backend - this should give us a reasonable
2454 * idea of the total size of the data so far.
2456 total_length = odr_total(a->encode) - dumped_records;
2462 freq.last_in_set = 0;
2463 freq.setname = setname;
2464 freq.surrogate_flag = 0;
2465 freq.number = recno;
2467 freq.request_format = oid;
2468 freq.output_format = 0;
2469 freq.stream = a->encode;
2470 freq.print = a->print;
2471 freq.referenceId = referenceId;
2474 retrieve_fetch(a, &freq);
2476 *next = freq.last_in_set ? 0 : recno + 1;
2480 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2483 *pres = Z_PresentStatus_failure;
2484 /* for 'present request out of range',
2485 set addinfo to record position if not set */
2486 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2487 freq.errstring == 0)
2489 sprintf(s, "%d", recno);
2493 *errcode = freq.errcode;
2494 return diagrec(a, freq.errcode, freq.errstring);
2496 reclist->records[reclist->num_records] =
2497 surrogatediagrec(a, freq.basename, freq.errcode,
2499 reclist->num_records++;
2502 if (freq.record == 0) /* no error and no record ? */
2504 *next = 0; /* signal end-of-set and stop */
2508 this_length = freq.len;
2510 this_length = odr_total(a->encode) - total_length - dumped_records;
2511 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2512 this_length, total_length, dumped_records);
2513 if (a->preferredMessageSize > 0 &&
2514 this_length + total_length > a->preferredMessageSize)
2516 /* record is small enough, really */
2517 if (this_length <= a->preferredMessageSize && recno > start)
2519 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2520 *pres = Z_PresentStatus_partial_2;
2525 /* record can only be fetched by itself */
2526 if (this_length < a->maximumRecordSize)
2528 yaz_log(log_requestdetail, " Record > prefmsgsz");
2531 yaz_log(YLOG_DEBUG, " Dropped it");
2532 reclist->records[reclist->num_records] =
2535 YAZ_BIB1_RECORD_EXCEEDS_PREFERRED_MESSAGE_SIZE, 0);
2536 reclist->num_records++;
2537 dumped_records += this_length;
2541 else /* too big entirely */
2543 yaz_log(log_requestdetail, "Record > maxrcdsz "
2545 this_length, a->maximumRecordSize);
2546 reclist->records[reclist->num_records] =
2549 YAZ_BIB1_RECORD_EXCEEDS_MAXIMUM_RECORD_SIZE, 0);
2550 reclist->num_records++;
2551 dumped_records += this_length;
2556 if (!(thisrec = (Z_NamePlusRecord *)
2557 odr_malloc(a->encode, sizeof(*thisrec))))
2559 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2560 thisrec->which = Z_NamePlusRecord_databaseRecord;
2562 if (!freq.output_format)
2563 freq.output_format = freq.request_format;
2564 thisrec->u.databaseRecord = z_ext_record_oid(
2565 a->encode, freq.output_format, freq.record, freq.len);
2566 if (!thisrec->u.databaseRecord)
2568 reclist->records[reclist->num_records] = thisrec;
2569 reclist->num_records++;
2571 *num = reclist->num_records;
2575 static Z_APDU *process_searchRequest(association *assoc, request *reqb)
2577 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2578 bend_search_rr *bsrr =
2579 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2581 yaz_log(log_requestdetail, "Got SearchRequest.");
2582 bsrr->association = assoc;
2583 bsrr->referenceId = req->referenceId;
2584 bsrr->srw_sortKeys = 0;
2585 bsrr->srw_setname = 0;
2586 bsrr->srw_setnameIdleTime = 0;
2587 bsrr->estimated_hit_count = 0;
2588 bsrr->partial_resultset = 0;
2589 bsrr->extra_args = 0;
2590 bsrr->extra_response_data = 0;
2592 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2593 if (req->databaseNames)
2596 for (i = 0; i < req->num_databaseNames; i++)
2597 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2600 yaz_log_zquery_level(log_requestdetail,req->query);
2602 if (assoc->init->bend_search)
2604 bsrr->setname = req->resultSetName;
2605 bsrr->replace_set = *req->replaceIndicator;
2606 bsrr->num_bases = req->num_databaseNames;
2607 bsrr->basenames = req->databaseNames;
2608 bsrr->query = req->query;
2609 bsrr->stream = assoc->encode;
2610 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2611 bsrr->decode = assoc->decode;
2612 bsrr->print = assoc->print;
2615 bsrr->errstring = NULL;
2616 bsrr->search_info = NULL;
2618 if (assoc->server && assoc->server->cql_transform
2619 && req->query->which == Z_Query_type_104
2620 && req->query->u.type_104->which == Z_External_CQL)
2622 /* have a CQL query and a CQL to PQF transform .. */
2624 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2625 assoc->server->cql_transform, bsrr->query);
2627 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2630 if (assoc->server && assoc->server->ccl_transform
2631 && req->query->which == Z_Query_type_2) /*CCL*/
2633 /* have a CCL query and a CCL to PQF transform .. */
2635 ccl2pqf(bsrr->stream, req->query->u.type_2,
2636 assoc->server->ccl_transform, bsrr);
2638 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2642 (assoc->init->bend_search)(assoc->backend, bsrr);
2646 /* FIXME - make a diagnostic for it */
2647 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2649 return response_searchRequest(assoc, reqb, bsrr);
2653 * Prepare a searchresponse based on the backend results. We probably want
2654 * to look at making the fetching of records nonblocking as well, but
2655 * so far, we'll keep things simple.
2656 * If bsrt is null, that means we're called in response to a communications
2657 * event, and we'll have to get the response for ourselves.
2659 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2660 bend_search_rr *bsrt)
2662 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2663 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2664 Z_SearchResponse *resp = (Z_SearchResponse *)
2665 odr_malloc(assoc->encode, sizeof(*resp));
2666 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2667 Odr_int *next = odr_intdup(assoc->encode, 0);
2668 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2669 Odr_int returnedrecs = 0;
2671 apdu->which = Z_APDU_searchResponse;
2672 apdu->u.searchResponse = resp;
2673 resp->referenceId = req->referenceId;
2674 resp->additionalSearchInfo = 0;
2675 resp->otherInfo = 0;
2678 yaz_log(YLOG_FATAL, "Bad result from backend");
2681 else if (bsrt->errcode)
2683 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2684 resp->resultCount = nulint;
2685 resp->numberOfRecordsReturned = nulint;
2686 resp->nextResultSetPosition = nulint;
2687 resp->searchStatus = odr_booldup(assoc->encode, 0);
2688 resp->resultSetStatus = none;
2689 resp->presentStatus = 0;
2693 bool_t *sr = odr_booldup(assoc->encode, 1);
2694 Odr_int *toget = odr_intdup(assoc->encode, 0);
2695 Z_RecordComposition comp, *compp = 0;
2697 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2700 resp->resultCount = &bsrt->hits;
2702 comp.which = Z_RecordComp_simple;
2703 /* how many records does the user agent want, then? */
2706 else if (bsrt->hits <= *req->smallSetUpperBound)
2708 *toget = bsrt->hits;
2709 if ((comp.u.simple = req->smallSetElementSetNames))
2712 else if (bsrt->hits < *req->largeSetLowerBound)
2714 *toget = *req->mediumSetPresentNumber;
2715 if (*toget > bsrt->hits)
2716 *toget = bsrt->hits;
2717 if ((comp.u.simple = req->mediumSetElementSetNames))
2723 if (*toget && !resp->records)
2725 Odr_int *presst = odr_intdup(assoc->encode, 0);
2726 /* Call bend_present if defined */
2727 if (assoc->init->bend_present)
2729 bend_present_rr *bprr = (bend_present_rr *)
2730 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2731 bprr->setname = req->resultSetName;
2733 bprr->number = odr_int_to_int(*toget);
2734 bprr->format = req->preferredRecordSyntax;
2736 bprr->referenceId = req->referenceId;
2737 bprr->stream = assoc->encode;
2738 bprr->print = assoc->print;
2739 bprr->association = assoc;
2741 bprr->errstring = NULL;
2742 (*assoc->init->bend_present)(assoc->backend, bprr);
2746 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2747 *resp->presentStatus = Z_PresentStatus_failure;
2752 resp->records = pack_records(
2753 assoc, req->resultSetName, 1,
2754 toget, compp, next, presst, req->referenceId,
2755 req->preferredRecordSyntax, NULL);
2758 resp->numberOfRecordsReturned = toget;
2759 returnedrecs = *toget;
2760 resp->presentStatus = presst;
2764 if (*resp->resultCount)
2766 resp->numberOfRecordsReturned = nulint;
2767 resp->presentStatus = 0;
2769 resp->nextResultSetPosition = next;
2770 resp->searchStatus = sr;
2771 resp->resultSetStatus = 0;
2772 if (bsrt->estimated_hit_count)
2774 resp->resultSetStatus = odr_intdup(assoc->encode,
2775 Z_SearchResponse_estimate);
2777 else if (bsrt->partial_resultset)
2779 resp->resultSetStatus = odr_intdup(assoc->encode,
2780 Z_SearchResponse_subset);
2783 resp->additionalSearchInfo = bsrt->search_info;
2788 WRBUF wr = wrbuf_alloc();
2790 for (i = 0 ; i < req->num_databaseNames; i++)
2793 wrbuf_printf(wr, "+");
2794 wrbuf_puts(wr, req->databaseNames[i]);
2796 wrbuf_printf(wr, " ");
2799 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2801 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2802 wrbuf_printf(wr, " %s 1+" ODR_INT_PRINTF " ",
2803 req->resultSetName, returnedrecs);
2804 yaz_query_to_wrbuf(wr, req->query);
2806 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2813 * Maybe we got a little over-friendly when we designed bend_fetch to
2814 * get only one record at a time. Some backends can optimise multiple-record
2815 * fetches, and at any rate, there is some overhead involved in
2816 * all that selecting and hopping around. Problem is, of course, that the
2817 * frontend can't know ahead of time how many records it'll need to
2818 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2819 * is downright lousy as a bulk data transfer protocol.
2821 * To start with, we'll do the fetching of records from the backend
2822 * in one operation: To save some trips in and out of the event-handler,
2823 * and to simplify the interface to pack_records. At any rate, asynch
2824 * operation is more fun in operations that have an unpredictable execution
2825 * speed - which is normally more true for search than for present.
2827 static Z_APDU *process_presentRequest(association *assoc, request *reqb)
2829 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2831 Z_PresentResponse *resp;
2835 const char *errstring = 0;
2837 yaz_log(log_requestdetail, "Got PresentRequest.");
2839 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2841 resp->presentStatus = odr_intdup(assoc->encode, 0);
2842 if (assoc->init->bend_present)
2844 bend_present_rr *bprr = (bend_present_rr *)
2845 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2846 bprr->setname = req->resultSetId;
2847 bprr->start = odr_int_to_int(*req->resultSetStartPoint);
2848 bprr->number = odr_int_to_int(*req->numberOfRecordsRequested);
2849 bprr->format = req->preferredRecordSyntax;
2850 bprr->comp = req->recordComposition;
2851 bprr->referenceId = req->referenceId;
2852 bprr->stream = assoc->encode;
2853 bprr->print = assoc->print;
2854 bprr->association = assoc;
2856 bprr->errstring = NULL;
2857 (*assoc->init->bend_present)(assoc->backend, bprr);
2861 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2862 *resp->presentStatus = Z_PresentStatus_failure;
2863 errcode = bprr->errcode;
2864 errstring = bprr->errstring;
2867 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2868 next = odr_intdup(assoc->encode, 0);
2869 num = odr_intdup(assoc->encode, 0);
2871 apdu->which = Z_APDU_presentResponse;
2872 apdu->u.presentResponse = resp;
2873 resp->referenceId = req->referenceId;
2874 resp->otherInfo = 0;
2878 *num = *req->numberOfRecordsRequested;
2880 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2881 num, req->recordComposition, next,
2882 resp->presentStatus,
2883 req->referenceId, req->preferredRecordSyntax,
2888 WRBUF wr = wrbuf_alloc();
2889 wrbuf_printf(wr, "Present ");
2891 if (*resp->presentStatus == Z_PresentStatus_failure)
2892 wrbuf_printf(wr, "ERROR %d ", errcode);
2893 else if (*resp->presentStatus == Z_PresentStatus_success)
2894 wrbuf_printf(wr, "OK - ");
2896 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2897 *resp->presentStatus);
2899 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2900 req->resultSetId, *req->resultSetStartPoint,
2901 *req->numberOfRecordsRequested);
2902 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2907 resp->numberOfRecordsReturned = num;
2908 resp->nextResultSetPosition = next;
2914 * Scan was implemented rather in a hurry, and with support for only the basic
2915 * elements of the service in the backend API. Suggestions are welcome.
2917 static Z_APDU *process_scanRequest(association *assoc, request *reqb)
2919 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2920 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2921 Z_ScanResponse *res = (Z_ScanResponse *)
2922 odr_malloc(assoc->encode, sizeof(*res));
2923 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2924 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2925 Z_ListEntries *ents = (Z_ListEntries *)
2926 odr_malloc(assoc->encode, sizeof(*ents));
2927 Z_DiagRecs *diagrecs_p = NULL;
2928 bend_scan_rr *bsrr = (bend_scan_rr *)
2929 odr_malloc(assoc->encode, sizeof(*bsrr));
2930 struct scan_entry *save_entries;
2933 yaz_log(log_requestdetail, "Got ScanRequest");
2935 apdu->which = Z_APDU_scanResponse;
2936 apdu->u.scanResponse = res;
2937 res->referenceId = req->referenceId;
2939 /* if step is absent, set it to 0 */
2941 step_size = odr_int_to_int(*req->stepSize);
2943 res->scanStatus = scanStatus;
2944 res->numberOfEntriesReturned = numberOfEntriesReturned;
2945 res->positionOfTerm = 0;
2946 res->entries = ents;
2947 ents->num_entries = 0;
2948 ents->entries = NULL;
2949 ents->num_nonsurrogateDiagnostics = 0;
2950 ents->nonsurrogateDiagnostics = NULL;
2951 res->attributeSet = 0;
2954 if (req->databaseNames)
2957 for (i = 0; i < req->num_databaseNames; i++)
2958 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2960 bsrr->scanClause = 0;
2962 bsrr->errstring = 0;
2963 bsrr->num_bases = req->num_databaseNames;
2964 bsrr->basenames = req->databaseNames;
2965 bsrr->num_entries = odr_int_to_int(*req->numberOfTermsRequested);
2966 bsrr->term = req->termListAndStartPoint;
2967 bsrr->referenceId = req->referenceId;
2968 bsrr->stream = assoc->encode;
2969 bsrr->print = assoc->print;
2970 bsrr->step_size = &step_size;
2971 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
2972 yaz_oid_userinfo_scan_set, 1, 0);
2974 /* For YAZ 2.0 and earlier it was the backend handler that
2975 initialized entries (member display_term did not exist)
2976 YAZ 2.0 and later sets 'entries' and initialize all members
2977 including 'display_term'. If YAZ 2.0 or later sees that
2978 entries was modified - we assume that it is an old handler and
2979 that 'display_term' is _not_ set.
2981 if (bsrr->num_entries > 0)
2984 bsrr->entries = (struct scan_entry *)
2985 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
2987 for (i = 0; i<bsrr->num_entries; i++)
2989 bsrr->entries[i].term = 0;
2990 bsrr->entries[i].occurrences = 0;
2991 bsrr->entries[i].errcode = 0;
2992 bsrr->entries[i].errstring = 0;
2993 bsrr->entries[i].display_term = 0;
2996 save_entries = bsrr->entries; /* save it so we can compare later */
2998 bsrr->attributeset = req->attributeSet;
2999 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3000 bsrr->attributeset);
3001 bsrr->term_position = req->preferredPositionInResponse ?
3002 odr_int_to_int(*req->preferredPositionInResponse) : 1;
3004 ((int (*)(void *, bend_scan_rr *))
3005 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3008 diagrecs_p = zget_DiagRecs(assoc->encode,
3009 bsrr->errcode, bsrr->errstring);
3013 Z_Entry **tab = (Z_Entry **)
3014 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3016 if (bsrr->status == BEND_SCAN_PARTIAL)
3017 *scanStatus = Z_Scan_partial_5;
3019 *scanStatus = Z_Scan_success;
3020 res->stepSize = odr_intdup(assoc->encode, step_size);
3021 ents->entries = tab;
3022 ents->num_entries = bsrr->num_entries;
3023 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3025 res->positionOfTerm = odr_intdup(assoc->encode, bsrr->term_position);
3026 for (i = 0; i < bsrr->num_entries; i++)
3032 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3033 if (bsrr->entries[i].occurrences >= 0)
3035 e->which = Z_Entry_termInfo;
3036 e->u.termInfo = t = (Z_TermInfo *)
3037 odr_malloc(assoc->encode, sizeof(*t));
3038 t->suggestedAttributes = 0;
3040 if (save_entries == bsrr->entries &&
3041 bsrr->entries[i].display_term)
3043 /* the entries was _not_ set by the handler. So it's
3044 safe to test for new member display_term. It is
3047 t->displayTerm = odr_strdup(assoc->encode,
3048 bsrr->entries[i].display_term);
3050 t->alternativeTerm = 0;
3051 t->byAttributes = 0;
3052 t->otherTermInfo = 0;
3053 t->globalOccurrences = &bsrr->entries[i].occurrences;
3054 t->term = (Z_Term *)
3055 odr_malloc(assoc->encode, sizeof(*t->term));
3056 t->term->which = Z_Term_general;
3057 t->term->u.general = o =
3058 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3059 o->buf = (unsigned char *)
3060 odr_malloc(assoc->encode, o->len = o->size =
3061 strlen(bsrr->entries[i].term));
3062 memcpy(o->buf, bsrr->entries[i].term, o->len);
3063 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3064 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3068 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3069 bsrr->entries[i].errcode,
3070 bsrr->entries[i].errstring);
3071 assert(drecs->num_diagRecs == 1);
3072 e->which = Z_Entry_surrogateDiagnostic;
3073 assert(drecs->diagRecs[0]);
3074 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3080 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3081 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3086 WRBUF wr = wrbuf_alloc();
3087 wrbuf_printf(wr, "Scan ");
3088 for (i = 0 ; i < req->num_databaseNames; i++)
3091 wrbuf_printf(wr, "+");
3092 wrbuf_puts(wr, req->databaseNames[i]);
3095 wrbuf_printf(wr, " ");
3098 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3100 wrbuf_printf(wr, "OK");
3102 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3103 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3104 res->numberOfEntriesReturned ?
3105 *res->numberOfEntriesReturned : 0,
3106 (req->preferredPositionInResponse ?
3107 *req->preferredPositionInResponse : 1),
3108 *req->numberOfTermsRequested,
3109 (res->stepSize ? *res->stepSize : 1));
3112 wrbuf_printf(wr, "+%s", bsrr->setname);
3114 wrbuf_printf(wr, " ");
3115 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3116 bsrr->attributeset);
3117 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3123 static Z_APDU *process_sortRequest(association *assoc, request *reqb)
3126 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3127 Z_SortResponse *res = (Z_SortResponse *)
3128 odr_malloc(assoc->encode, sizeof(*res));
3129 bend_sort_rr *bsrr = (bend_sort_rr *)
3130 odr_malloc(assoc->encode, sizeof(*bsrr));
3132 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3134 yaz_log(log_requestdetail, "Got SortRequest.");
3136 bsrr->num_input_setnames = req->num_inputResultSetNames;
3137 for (i=0;i<req->num_inputResultSetNames;i++)
3138 yaz_log(log_requestdetail, "Input resultset: '%s'",
3139 req->inputResultSetNames[i]);
3140 bsrr->input_setnames = req->inputResultSetNames;
3141 bsrr->referenceId = req->referenceId;
3142 bsrr->output_setname = req->sortedResultSetName;
3143 yaz_log(log_requestdetail, "Output resultset: '%s'",
3144 req->sortedResultSetName);
3145 bsrr->sort_sequence = req->sortSequence;
3146 /*FIXME - dump those sequences too */
3147 bsrr->stream = assoc->encode;
3148 bsrr->print = assoc->print;
3150 bsrr->sort_status = Z_SortResponse_failure;
3152 bsrr->errstring = 0;
3154 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3156 res->referenceId = bsrr->referenceId;
3157 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3158 res->resultSetStatus = 0;
3161 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3162 bsrr->errcode, bsrr->errstring);
3163 res->diagnostics = dr->diagRecs;
3164 res->num_diagnostics = dr->num_diagRecs;
3168 res->num_diagnostics = 0;
3169 res->diagnostics = 0;
3171 res->resultCount = 0;
3174 apdu->which = Z_APDU_sortResponse;
3175 apdu->u.sortResponse = res;
3178 WRBUF wr = wrbuf_alloc();
3179 wrbuf_printf(wr, "Sort ");
3181 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3183 wrbuf_printf(wr, "OK -");
3184 wrbuf_printf(wr, " (");
3185 for (i = 0; i<req->num_inputResultSetNames; i++)
3188 wrbuf_printf(wr, "+");
3189 wrbuf_puts(wr, req->inputResultSetNames[i]);
3191 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3193 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3199 static Z_APDU *process_deleteRequest(association *assoc, request *reqb)
3202 Z_DeleteResultSetRequest *req =
3203 reqb->apdu_request->u.deleteResultSetRequest;
3204 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3205 odr_malloc(assoc->encode, sizeof(*res));
3206 bend_delete_rr *bdrr = (bend_delete_rr *)
3207 odr_malloc(assoc->encode, sizeof(*bdrr));
3208 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3210 yaz_log(log_requestdetail, "Got DeleteRequest.");
3212 bdrr->num_setnames = req->num_resultSetList;
3213 bdrr->setnames = req->resultSetList;
3214 for (i = 0; i<req->num_resultSetList; i++)
3215 yaz_log(log_requestdetail, "resultset: '%s'",
3216 req->resultSetList[i]);
3217 bdrr->stream = assoc->encode;
3218 bdrr->print = assoc->print;
3219 bdrr->function = odr_int_to_int(*req->deleteFunction);
3220 bdrr->referenceId = req->referenceId;
3222 if (bdrr->num_setnames > 0)
3224 bdrr->statuses = (int*)
3225 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3226 bdrr->num_setnames);
3227 for (i = 0; i < bdrr->num_setnames; i++)
3228 bdrr->statuses[i] = 0;
3230 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3232 res->referenceId = req->referenceId;
3234 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3236 res->deleteListStatuses = 0;
3237 if (bdrr->num_setnames > 0)
3240 res->deleteListStatuses = (Z_ListStatuses *)
3241 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3242 res->deleteListStatuses->num = bdrr->num_setnames;
3243 res->deleteListStatuses->elements =
3245 odr_malloc(assoc->encode,
3246 sizeof(*res->deleteListStatuses->elements) *
3247 bdrr->num_setnames);
3248 for (i = 0; i<bdrr->num_setnames; i++)
3250 res->deleteListStatuses->elements[i] =
3252 odr_malloc(assoc->encode,
3253 sizeof(**res->deleteListStatuses->elements));
3254 res->deleteListStatuses->elements[i]->status =
3255 odr_intdup(assoc->encode, bdrr->statuses[i]);
3256 res->deleteListStatuses->elements[i]->id =
3257 odr_strdup(assoc->encode, bdrr->setnames[i]);
3260 res->numberNotDeleted = 0;
3261 res->bulkStatuses = 0;
3262 res->deleteMessage = 0;
3265 apdu->which = Z_APDU_deleteResultSetResponse;
3266 apdu->u.deleteResultSetResponse = res;
3269 WRBUF wr = wrbuf_alloc();
3270 wrbuf_printf(wr, "Delete ");
3271 if (bdrr->delete_status)
3272 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3274 wrbuf_printf(wr, "OK -");
3275 for (i = 0; i<req->num_resultSetList; i++)
3276 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3277 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3283 static void process_close(association *assoc, request *reqb)
3285 Z_Close *req = reqb->apdu_request->u.close;
3286 static char *reasons[] =
3293 "securityViolation",
3300 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3301 reasons[*req->closeReason], req->diagnosticInformation ?
3302 req->diagnosticInformation : "NULL");
3303 if (assoc->version < 3) /* to make do_force respond with close */
3305 do_close_req(assoc, Z_Close_finished,
3306 "Association terminated by client", reqb);
3307 yaz_log(log_request,"Close OK");
3310 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3312 bend_segment_rr req;
3314 req.segment = reqb->apdu_request->u.segmentRequest;
3315 req.stream = assoc->encode;
3316 req.decode = assoc->decode;
3317 req.print = assoc->print;
3318 req.association = assoc;
3320 (*assoc->init->bend_segment)(assoc->backend, &req);
3325 static Z_APDU *process_ESRequest(association *assoc, request *reqb)
3327 bend_esrequest_rr esrequest;
3328 const char *ext_name = "unknown";
3330 Z_ExtendedServicesRequest *req =
3331 reqb->apdu_request->u.extendedServicesRequest;
3332 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3334 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3336 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3337 esrequest.stream = assoc->encode;
3338 esrequest.decode = assoc->decode;
3339 esrequest.print = assoc->print;
3340 esrequest.errcode = 0;
3341 esrequest.errstring = NULL;
3342 esrequest.association = assoc;
3343 esrequest.taskPackage = 0;
3344 esrequest.referenceId = req->referenceId;
3346 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3348 switch(esrequest.esr->taskSpecificParameters->which)
3350 case Z_External_itemOrder:
3351 ext_name = "ItemOrder"; break;
3352 case Z_External_update:
3353 ext_name = "Update"; break;
3354 case Z_External_update0:
3355 ext_name = "Update0"; break;
3356 case Z_External_ESAdmin:
3357 ext_name = "Admin"; break;
3362 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3364 resp->referenceId = req->referenceId;
3366 if (esrequest.errcode == -1)
3368 /* Backend service indicates request will be processed */
3369 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3370 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3372 else if (esrequest.errcode == 0)
3374 /* Backend service indicates request will be processed */
3375 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3376 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3380 Z_DiagRecs *diagRecs =
3381 zget_DiagRecs(assoc->encode, esrequest.errcode,
3382 esrequest.errstring);
3383 /* Backend indicates error, request will not be processed */
3384 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3385 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3386 resp->num_diagnostics = diagRecs->num_diagRecs;
3387 resp->diagnostics = diagRecs->diagRecs;
3390 WRBUF wr = wrbuf_alloc();
3391 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3392 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3397 /* Do something with the members of bend_extendedservice */
3398 if (esrequest.taskPackage)
3400 resp->taskPackage = z_ext_record_oid(
3401 assoc->encode, yaz_oid_recsyn_extended,
3402 (const char *) esrequest.taskPackage, -1);
3404 yaz_log(YLOG_DEBUG,"Send the result apdu");
3408 int bend_assoc_is_alive(bend_association assoc)
3410 if (assoc->state == ASSOC_DEAD)
3411 return 0; /* already marked as dead. Don't check I/O chan anymore */
3413 return iochan_is_alive(assoc->client_chan);
3420 * c-file-style: "Stroustrup"
3421 * indent-tabs-mode: nil
3423 * vim: shiftwidth=4 tabstop=8 expandtab