1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2013 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.
38 #include <sys/types.h>
46 #define S_ISREG(x) (x & _S_IFREG)
55 #include <libxml/parser.h>
56 #include <libxml/tree.h>
59 #include <yaz/xmalloc.h>
60 #include <yaz/comstack.h>
64 #include <yaz/proto.h>
65 #include <yaz/oid_db.h>
67 #include <yaz/logrpn.h>
68 #include <yaz/querytowrbuf.h>
69 #include <yaz/statserv.h>
70 #include <yaz/diagbib1.h>
71 #include <yaz/charneg.h>
72 #include <yaz/otherinfo.h>
73 #include <yaz/yaz-util.h>
74 #include <yaz/pquery.h>
75 #include <yaz/oid_db.h>
78 #include <yaz/backend.h>
79 #include <yaz/yaz-ccl.h>
81 static void process_gdu_request(association *assoc, request *req);
82 static int process_z_request(association *assoc, request *req, char **msg);
83 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
84 static int process_z_response(association *assoc, request *req, Z_APDU *res);
85 static Z_APDU *process_initRequest(association *assoc, request *reqb);
86 static Z_External *init_diagnostics(ODR odr, int errcode,
87 const char *errstring);
88 static Z_APDU *process_searchRequest(association *assoc, request *reqb);
89 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
90 bend_search_rr *bsrr);
91 static Z_APDU *process_presentRequest(association *assoc, request *reqb);
92 static Z_APDU *process_scanRequest(association *assoc, request *reqb);
93 static Z_APDU *process_sortRequest(association *assoc, request *reqb);
94 static void process_close(association *assoc, request *reqb);
95 static Z_APDU *process_deleteRequest(association *assoc, request *reqb);
96 static Z_APDU *process_segmentRequest(association *assoc, request *reqb);
97 static Z_APDU *process_ESRequest(association *assoc, request *reqb);
99 /* dynamic logging levels */
100 static int logbits_set = 0;
101 static int log_session = 0; /* one-line logs for session */
102 static int log_sessiondetail = 0; /* more detailed stuff */
103 static int log_request = 0; /* one-line logs for requests */
104 static int log_requestdetail = 0; /* more detailed stuff */
106 /** get_logbits sets global loglevel bits */
107 static void get_logbits(void)
108 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
112 log_session = yaz_log_module_level("session");
113 log_sessiondetail = yaz_log_module_level("sessiondetail");
114 log_request = yaz_log_module_level("request");
115 log_requestdetail = yaz_log_module_level("requestdetail");
119 static void wr_diag(WRBUF w, int error, const char *addinfo)
121 wrbuf_printf(w, "ERROR %d+", error);
122 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
126 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
131 static int odr_int_to_int(Odr_int v)
135 else if (v <= INT_MIN)
142 * Create and initialize a new association-handle.
143 * channel : iochannel for the current line.
144 * link : communications channel.
145 * Returns: 0 or a new association handle.
147 association *create_association(IOCHAN channel, COMSTACK link,
148 const char *apdufile)
154 if (!(anew = (association *)xmalloc(sizeof(*anew))))
158 anew->last_control = 0;
159 anew->client_chan = channel;
160 anew->client_link = link;
161 anew->cs_get_mask = 0;
162 anew->cs_put_mask = 0;
163 anew->cs_accept_mask = 0;
164 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
165 !(anew->encode = odr_createmem(ODR_ENCODE)))
167 if (apdufile && *apdufile)
171 if (!(anew->print = odr_createmem(ODR_PRINT)))
173 if (*apdufile == '@')
175 odr_setprint(anew->print, yaz_log_file());
177 else if (*apdufile != '-')
180 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
181 if (!(f = fopen(filename, "w")))
183 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
186 setvbuf(f, 0, _IONBF, 0);
187 odr_setprint(anew->print, f);
192 anew->input_buffer = 0;
193 anew->input_buffer_len = 0;
195 anew->state = ASSOC_NEW;
196 request_initq(&anew->incoming);
197 request_initq(&anew->outgoing);
198 anew->proto = cs_getproto(link);
204 * Free association and release resources.
206 void destroy_association(association *h)
208 statserv_options_block *cb = statserv_getcontrol();
212 odr_destroy(h->decode);
213 odr_destroy(h->encode);
215 odr_destroy(h->print);
217 xfree(h->input_buffer);
219 (*cb->bend_close)(h->backend);
220 while ((req = request_deq(&h->incoming)))
221 request_release(req);
222 while ((req = request_deq(&h->outgoing)))
223 request_release(req);
224 request_delq(&h->incoming);
225 request_delq(&h->outgoing);
227 xmalloc_trav("session closed");
230 static void do_close_req(association *a, int reason, char *message,
233 Z_APDU *apdu = zget_APDU(a->encode, Z_APDU_close);
234 Z_Close *cls = apdu->u.close;
236 /* Purge request queue */
237 while (request_deq(&a->incoming));
238 while (request_deq(&a->outgoing));
241 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
242 reason, message ? message : "none");
243 *cls->closeReason = reason;
244 cls->diagnosticInformation = message;
245 process_z_response(a, req, apdu);
246 iochan_settimeout(a->client_chan, 20);
250 request_release(req);
251 yaz_log(log_requestdetail, "v2 client. No Close PDU");
252 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
255 a->state = ASSOC_DEAD;
258 static void do_close(association *a, int reason, char *message)
260 request *req = request_get(&a->outgoing);
261 do_close_req(a, reason, message, req);
265 int ir_read(IOCHAN h, int event)
267 association *assoc = (association *)iochan_getdata(h);
268 COMSTACK conn = assoc->client_link;
271 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
273 /* We aren't speaking to this fellow */
274 if (assoc->state == ASSOC_DEAD)
276 yaz_log(log_session, "Connection closed - end of session");
278 destroy_association(assoc);
282 assoc->cs_get_mask = EVENT_INPUT;
286 int res = cs_get(conn, &assoc->input_buffer,
287 &assoc->input_buffer_len);
288 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
290 yaz_log(log_session, "Connection error: %s res=%d",
291 cs_errmsg(cs_errno(conn)), res);
292 req = request_get(&assoc->incoming); /* get a new request */
293 do_close_req(assoc, Z_Close_protocolError,
294 "Incoming package too large", req);
299 assoc->state = ASSOC_DEAD;
300 yaz_log(log_session, "Connection closed by client");
303 else if (res == 1) /* incomplete read - wait for more */
305 if (conn->io_pending & CS_WANT_WRITE)
306 assoc->cs_get_mask |= EVENT_OUTPUT;
307 iochan_setflag(h, assoc->cs_get_mask);
310 /* we got a complete PDU. Let's decode it */
311 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
312 assoc->input_buffer[0] & 0xff,
313 assoc->input_buffer[1] & 0xff,
314 assoc->input_buffer[2] & 0xff);
315 req = request_get(&assoc->incoming); /* get a new request */
316 odr_reset(assoc->decode);
317 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
318 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
320 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
322 odr_errmsg(odr_geterror(assoc->decode)),
323 odr_getelement(assoc->decode),
324 (long) odr_offset(assoc->decode));
325 if (assoc->decode->error != OHTTP)
327 yaz_log(YLOG_WARN, "PDU dump:");
328 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
329 request_release(req);
330 do_close(assoc, Z_Close_protocolError, "Malformed package");
334 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
335 assoc->state = ASSOC_DEAD;
336 process_gdu_response(assoc, req, p);
340 req->request_mem = odr_extract_mem(assoc->decode);
343 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
344 yaz_log(YLOG_WARN, "ODR print error: %s",
345 odr_errmsg(odr_geterror(assoc->print)));
346 odr_reset(assoc->print);
348 request_enq(&assoc->incoming, req);
350 while (cs_more(conn));
356 * This is where PDUs from the client are read and the further
357 * processing is initiated. Flow of control moves down through the
358 * various process_* functions below, until the encoded result comes back up
359 * to the output handler in here.
361 * h : the I/O channel that has an outstanding event.
362 * event : the current outstanding event.
364 void ir_session(IOCHAN h, int event)
367 association *assoc = (association *)iochan_getdata(h);
368 COMSTACK conn = assoc->client_link;
371 assert(h && conn && assoc);
372 if (event == EVENT_TIMEOUT)
374 if (assoc->state != ASSOC_UP)
376 yaz_log(log_session, "Timeout. Closing connection");
377 /* do we need to lod this at all */
379 destroy_association(assoc);
384 yaz_log(log_sessiondetail, "Timeout. Sending Z39.50 Close");
385 do_close(assoc, Z_Close_lackOfActivity, 0);
389 if (event & assoc->cs_accept_mask)
391 if (!cs_accept(conn))
393 yaz_log(YLOG_WARN, "accept failed");
394 destroy_association(assoc);
398 iochan_clearflag(h, EVENT_OUTPUT);
399 if (conn->io_pending)
400 { /* cs_accept didn't complete */
401 assoc->cs_accept_mask =
402 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
403 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
405 iochan_setflag(h, assoc->cs_accept_mask);
408 { /* cs_accept completed. Prepare for reading (cs_get) */
409 assoc->cs_accept_mask = 0;
410 assoc->cs_get_mask = EVENT_INPUT;
411 iochan_setflag(h, assoc->cs_get_mask);
415 if (event & assoc->cs_get_mask) /* input */
417 if (!ir_read(h, event))
419 req = request_head(&assoc->incoming);
420 if (req->state == REQUEST_IDLE)
422 request_deq(&assoc->incoming);
423 process_gdu_request(assoc, req);
426 if (event & assoc->cs_put_mask)
428 request *req = request_head(&assoc->outgoing);
430 assoc->cs_put_mask = 0;
431 yaz_log(YLOG_DEBUG, "ir_session (output)");
432 req->state = REQUEST_PENDING;
433 switch (res = cs_put(conn, req->response, req->len_response))
436 yaz_log(log_sessiondetail, "Connection closed by client");
438 destroy_association(assoc);
441 case 0: /* all sent - release the request structure */
442 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
444 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
447 request_deq(&assoc->outgoing);
448 request_release(req);
449 if (!request_head(&assoc->outgoing))
450 { /* restore mask for cs_get operation ... */
451 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
452 iochan_setflag(h, assoc->cs_get_mask);
453 if (assoc->state == ASSOC_DEAD)
454 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
458 assoc->cs_put_mask = EVENT_OUTPUT;
462 if (conn->io_pending & CS_WANT_WRITE)
463 assoc->cs_put_mask |= EVENT_OUTPUT;
464 if (conn->io_pending & CS_WANT_READ)
465 assoc->cs_put_mask |= EVENT_INPUT;
466 iochan_setflag(h, assoc->cs_put_mask);
469 if (event & EVENT_EXCEPT)
471 yaz_log(YLOG_WARN, "ir_session (exception)");
473 destroy_association(assoc);
478 static int process_z_request(association *assoc, request *req, char **msg);
481 static void assoc_init_reset(association *assoc)
484 assoc->init = (bend_initrequest *) xmalloc(sizeof(*assoc->init));
486 assoc->init->stream = assoc->encode;
487 assoc->init->print = assoc->print;
488 assoc->init->auth = 0;
489 assoc->init->referenceId = 0;
490 assoc->init->implementation_version = 0;
491 assoc->init->implementation_id = 0;
492 assoc->init->implementation_name = 0;
493 assoc->init->query_charset = 0;
494 assoc->init->records_in_same_charset = 0;
495 assoc->init->bend_sort = NULL;
496 assoc->init->bend_search = NULL;
497 assoc->init->bend_present = NULL;
498 assoc->init->bend_esrequest = NULL;
499 assoc->init->bend_delete = NULL;
500 assoc->init->bend_scan = NULL;
501 assoc->init->bend_segment = NULL;
502 assoc->init->bend_fetch = NULL;
503 assoc->init->bend_explain = NULL;
504 assoc->init->bend_srw_scan = NULL;
505 assoc->init->bend_srw_update = NULL;
506 assoc->init->named_result_sets = 0;
508 assoc->init->charneg_request = NULL;
509 assoc->init->charneg_response = NULL;
511 assoc->init->decode = assoc->decode;
512 assoc->init->peer_name =
513 odr_strdup(assoc->encode, cs_addrstr(assoc->client_link));
515 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
518 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
520 statserv_options_block *cb = statserv_getcontrol();
523 const char *encoding = "UTF-8";
525 bend_initresult *binitres;
527 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
528 assoc_init_reset(assoc);
532 Z_IdAuthentication *auth = (Z_IdAuthentication *)
533 odr_malloc(assoc->decode, sizeof(*auth));
536 len = strlen(sr->username) + 1;
538 len += strlen(sr->password) + 2;
539 yaz_log(log_requestdetail, "username=%s password-len=%ld",
541 (sr->password ? strlen(sr->password) : 0));
542 auth->which = Z_IdAuthentication_open;
543 auth->u.open = (char *) odr_malloc(assoc->decode, len);
544 strcpy(auth->u.open, sr->username);
545 if (sr->password && *sr->password)
547 strcat(auth->u.open, "/");
548 strcat(auth->u.open, sr->password);
550 assoc->init->auth = auth;
554 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
555 assoc->init->charneg_request = ce->u.charNeg3;
558 if (!(binitres = (*cb->bend_init)(assoc->init)))
560 assoc->state = ASSOC_DEAD;
561 yaz_add_srw_diagnostic(assoc->encode, d, num,
562 YAZ_SRW_AUTHENTICATION_ERROR, 0);
565 assoc->backend = binitres->handle;
566 assoc->init->auth = 0;
567 if (binitres->errcode)
569 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
570 assoc->state = ASSOC_DEAD;
571 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
572 binitres->errstring);
580 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
583 yaz_record_conv_t rc = 0;
584 const char *match_schema = 0;
585 Odr_oid *match_syntax = 0;
590 const char *input_schema = yaz_get_esn(rr->comp);
591 Odr_oid *input_syntax_raw = rr->request_format;
593 const char *backend_schema = 0;
594 Odr_oid *backend_syntax = 0;
596 r = yaz_retrieval_request(assoc->server->retrieval,
604 if (r == -1) /* error ? */
606 const char *details = yaz_retrieval_get_error(
607 assoc->server->retrieval);
609 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
611 rr->errstring = odr_strdup(rr->stream, details);
614 else if (r == 1 || r == 3)
616 const char *details = input_schema;
618 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
620 rr->errstring = odr_strdup(rr->stream, details);
625 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
626 if (input_syntax_raw)
628 char oidbuf[OID_STR_MAX];
629 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
630 rr->errstring = odr_strdup(rr->stream, oidbuf);
636 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
639 rr->request_format = backend_syntax;
641 (*assoc->init->bend_fetch)(assoc->backend, rr);
642 if (rc && rr->record && rr->errcode == 0)
643 { /* post conversion must take place .. */
644 WRBUF output_record = wrbuf_alloc();
646 const char *details = 0;
649 r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
651 details = yaz_record_conv_get_error(rc);
653 else if (rr->len == -1 && rr->output_format &&
654 !oid_oidcmp(rr->output_format, yaz_oid_recsyn_opac))
656 r = yaz_record_conv_opac_record(
657 rc, (Z_OPACRecord *) rr->record, output_record);
659 details = yaz_record_conv_get_error(rc);
661 if (r == 0 && match_syntax &&
662 !oid_oidcmp(match_syntax, yaz_oid_recsyn_opac))
664 yaz_marc_t mt = yaz_marc_create();
665 Z_OPACRecord *opac = 0;
666 if (yaz_xml_to_opac(mt, wrbuf_buf(output_record),
667 wrbuf_len(output_record),
668 &opac, 0 /* iconv */, rr->stream->mem, 0)
672 rr->record = (char *) opac;
676 details = "XML to OPAC conversion failed";
679 yaz_marc_destroy(mt);
683 rr->len = wrbuf_len(output_record);
684 rr->record = (char *) odr_malloc(rr->stream, rr->len);
685 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
689 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
691 rr->errstring = odr_strdup(rr->stream, details);
693 wrbuf_destroy(output_record);
696 rr->output_format = match_syntax;
698 rr->schema = odr_strdup(rr->stream, match_schema);
700 (*assoc->init->bend_fetch)(assoc->backend, rr);
705 static int srw_bend_fetch(association *assoc, int pos,
706 Z_SRW_searchRetrieveRequest *srw_req,
707 Z_SRW_record *record,
708 const char **addinfo, int *last_in_set)
711 ODR o = assoc->encode;
713 rr.setname = "default";
716 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
718 rr.comp = (Z_RecordComposition *)
719 odr_malloc(assoc->decode, sizeof(*rr.comp));
720 rr.comp->which = Z_RecordComp_complex;
721 rr.comp->u.complex = (Z_CompSpec *)
722 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
723 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
724 odr_malloc(assoc->encode, sizeof(bool_t));
725 *rr.comp->u.complex->selectAlternativeSyntax = 0;
726 rr.comp->u.complex->num_dbSpecific = 0;
727 rr.comp->u.complex->dbSpecific = 0;
728 rr.comp->u.complex->num_recordSyntax = 0;
729 rr.comp->u.complex->recordSyntax = 0;
731 rr.comp->u.complex->generic = (Z_Specification *)
732 odr_malloc(assoc->decode, sizeof(Z_Specification));
734 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
735 rr.comp->u.complex->generic->which = Z_Schema_uri;
736 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
738 /* ESN = recordSchema if recordSchema is present */
739 rr.comp->u.complex->generic->elementSpec = 0;
740 if (srw_req->recordSchema)
742 rr.comp->u.complex->generic->elementSpec =
743 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
744 rr.comp->u.complex->generic->elementSpec->which =
745 Z_ElementSpec_elementSetName;
746 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
747 srw_req->recordSchema;
750 rr.stream = assoc->encode;
751 rr.print = assoc->print;
759 rr.surrogate_flag = 0;
760 rr.schema = srw_req->recordSchema;
762 if (!assoc->init->bend_fetch)
765 retrieve_fetch(assoc, &rr);
767 *last_in_set = rr.last_in_set;
769 if (rr.errcode && rr.surrogate_flag)
771 int code = yaz_diag_bib1_to_srw(rr.errcode);
772 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
775 else if (rr.len >= 0)
777 record->recordData_buf = rr.record;
778 record->recordData_len = rr.len;
779 record->recordPosition = odr_intdup(o, pos);
780 record->recordSchema = odr_strdup_null(
781 o, rr.schema ? rr.schema : srw_req->recordSchema);
785 *addinfo = rr.errstring;
791 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
792 Z_Query *query_result, char **sortkeys_p)
794 /* have a CQL query and CQL to PQF transform .. */
795 CQL_parser cp = cql_parser_create();
799 WRBUF rpn_buf = wrbuf_alloc();
802 r = cql_parser_string(cp, cql);
805 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
809 struct cql_node *cn = cql_parser_result(cp);
812 r = cql_transform(ct, cn, wrbuf_vp_puts, rpn_buf);
814 srw_errcode = cql_transform_error(ct, &add);
818 int r = cql_sortby_to_sortkeys_buf(cn, out, sizeof(out)-1);
823 yaz_log(log_requestdetail, "srw_sortKeys '%s'", out);
824 *sortkeys_p = odr_strdup(odr, out);
828 yaz_log(log_requestdetail, "failed to create srw_sortKeys");
829 srw_errcode = YAZ_SRW_UNSUPP_SORT_TYPE;
835 /* Syntax & transform OK. */
836 /* Convert PQF string to Z39.50 to RPN query struct */
837 YAZ_PQF_Parser pp = yaz_pqf_create();
838 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, wrbuf_cstr(rpn_buf));
843 int code = yaz_pqf_error(pp, &pqf_msg, &off);
844 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
846 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
850 query_result->which = Z_Query_type_1;
851 query_result->u.type_1 = rpnquery;
855 cql_parser_destroy(cp);
856 wrbuf_destroy(rpn_buf);
860 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
861 Z_AttributesPlusTerm *result)
866 int srw_error = cql2pqf(odr, cql, ct, &query, &sortkeys);
869 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
870 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
871 rpn = query.u.type_1;
872 if (!rpn->RPNStructure)
873 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
874 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
875 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
876 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
877 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
878 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
884 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
885 bend_search_rr *bsrr)
888 struct ccl_rpn_node *node;
891 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
892 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0)
894 bsrr->errstring = (char*) ccl_err_msg(errcode);
895 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
898 bsrr->query->which = Z_Query_type_1;
899 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
903 static void srw_bend_search(association *assoc,
908 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
911 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
914 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
915 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
916 if (srw_res->num_diagnostics == 0 && assoc->init)
919 rr.setname = "default";
922 rr.basenames = &srw_req->database;
926 rr.srw_setnameIdleTime = 0;
927 rr.estimated_hit_count = 0;
928 rr.partial_resultset = 0;
929 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
930 rr.query->u.type_1 = 0;
931 rr.extra_args = sr->extra_args;
932 rr.extra_response_data = 0;
933 rr.present_number = srw_req->maximumRecords ?
934 *srw_req->maximumRecords : 0;
936 if (srw_req->query_type == Z_SRW_query_type_cql)
938 if (assoc->server && assoc->server->cql_transform)
940 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
941 assoc->server->cql_transform,
947 yaz_add_srw_diagnostic(assoc->encode,
948 &srw_res->diagnostics,
949 &srw_res->num_diagnostics,
955 /* CQL query to backend. Wrap it - Z39.50 style */
956 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
957 ext->direct_reference = odr_getoidbystr(assoc->decode,
958 "1.2.840.10003.16.2");
959 ext->indirect_reference = 0;
961 ext->which = Z_External_CQL;
962 ext->u.cql = srw_req->query.cql;
964 rr.query->which = Z_Query_type_104;
965 rr.query->u.type_104 = ext;
968 else if (srw_req->query_type == Z_SRW_query_type_pqf)
970 Z_RPNQuery *RPNquery;
971 YAZ_PQF_Parser pqf_parser;
973 pqf_parser = yaz_pqf_create();
975 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
981 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
982 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
983 code, pqf_msg, (long) off);
984 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
987 rr.query->which = Z_Query_type_1;
988 rr.query->u.type_1 = RPNquery;
990 yaz_pqf_destroy(pqf_parser);
994 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
995 &srw_res->num_diagnostics,
996 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
998 if (rr.query->u.type_1)
1000 rr.stream = assoc->encode;
1001 rr.decode = assoc->decode;
1002 rr.print = assoc->print;
1003 if (srw_req->sort.sortKeys)
1004 rr.srw_sortKeys = odr_strdup(assoc->encode,
1005 srw_req->sort.sortKeys);
1006 rr.association = assoc;
1011 rr.search_input = 0;
1012 yaz_log_zquery_level(log_requestdetail,rr.query);
1014 (assoc->init->bend_search)(assoc->backend, &rr);
1017 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1023 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
1024 yaz_add_srw_diagnostic(assoc->encode,
1025 &srw_res->diagnostics,
1026 &srw_res->num_diagnostics,
1027 srw_error, rr.errstring);
1032 int number = srw_req->maximumRecords ?
1033 odr_int_to_int(*srw_req->maximumRecords) : 0;
1034 int start = srw_req->startRecord ?
1035 odr_int_to_int(*srw_req->startRecord) : 1;
1037 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
1039 start, number, rr.hits);
1041 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1044 srw_res->resultSetId =
1045 odr_strdup(assoc->encode, rr.srw_setname );
1046 srw_res->resultSetIdleTime =
1047 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1050 if (start > rr.hits || start < 1)
1052 /* if hits<=0 and start=1 we don't return a diagnostic */
1054 yaz_add_srw_diagnostic(
1056 &srw_res->diagnostics, &srw_res->num_diagnostics,
1057 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1059 else if (number > 0)
1063 if (start + number > rr.hits)
1064 number = odr_int_to_int(rr.hits) - start + 1;
1066 /* Call bend_present if defined */
1067 if (assoc->init->bend_present)
1069 bend_present_rr *bprr = (bend_present_rr*)
1070 odr_malloc(assoc->decode, sizeof(*bprr));
1071 bprr->setname = "default";
1072 bprr->start = start;
1073 bprr->number = number;
1074 if (srw_req->recordSchema)
1076 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1077 sizeof(*bprr->comp));
1078 bprr->comp->which = Z_RecordComp_simple;
1079 bprr->comp->u.simple = (Z_ElementSetNames *)
1080 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1081 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1082 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1088 bprr->stream = assoc->encode;
1089 bprr->referenceId = 0;
1090 bprr->print = assoc->print;
1091 bprr->association = assoc;
1093 bprr->errstring = NULL;
1094 (*assoc->init->bend_present)(assoc->backend, bprr);
1098 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1099 yaz_add_srw_diagnostic(assoc->encode,
1100 &srw_res->diagnostics,
1101 &srw_res->num_diagnostics,
1102 srw_error, bprr->errstring);
1110 int packing = Z_SRW_recordPacking_string;
1111 if (srw_req->recordPacking)
1114 yaz_srw_str_to_pack(srw_req->recordPacking);
1116 packing = Z_SRW_recordPacking_string;
1118 srw_res->records = (Z_SRW_record *)
1119 odr_malloc(assoc->encode,
1120 number * sizeof(*srw_res->records));
1122 srw_res->extra_records = (Z_SRW_extra_record **)
1123 odr_malloc(assoc->encode,
1124 number*sizeof(*srw_res->extra_records));
1126 for (i = 0; i<number; i++)
1129 int last_in_set = 0;
1130 const char *addinfo = 0;
1132 srw_res->records[j].recordPacking = packing;
1133 srw_res->records[j].recordData_buf = 0;
1134 srw_res->extra_records[j] = 0;
1135 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1136 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1137 srw_res->records + j,
1138 &addinfo, &last_in_set);
1141 yaz_add_srw_diagnostic(assoc->encode,
1142 &srw_res->diagnostics,
1143 &srw_res->num_diagnostics,
1144 yaz_diag_bib1_to_srw(errcode),
1149 if (srw_res->records[j].recordData_buf)
1154 srw_res->num_records = j;
1156 srw_res->records = 0;
1159 if (rr.extra_response_data)
1161 res->extraResponseData_buf = rr.extra_response_data;
1162 res->extraResponseData_len = strlen(rr.extra_response_data);
1164 if (rr.estimated_hit_count || rr.partial_resultset)
1166 yaz_add_srw_diagnostic(
1168 &srw_res->diagnostics,
1169 &srw_res->num_diagnostics,
1170 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1178 const char *querystr = "?";
1179 const char *querytype = "?";
1180 WRBUF wr = wrbuf_alloc();
1182 switch (srw_req->query_type)
1184 case Z_SRW_query_type_cql:
1186 querystr = srw_req->query.cql;
1188 case Z_SRW_query_type_pqf:
1190 querystr = srw_req->query.pqf;
1193 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1194 if (srw_res->num_diagnostics)
1195 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1196 else if (*http_code != 200)
1197 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1198 else if (srw_res->numberOfRecords)
1200 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1201 (srw_res->numberOfRecords ?
1202 *srw_res->numberOfRecords : 0));
1204 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+%d",
1205 (srw_res->resultSetId ?
1206 srw_res->resultSetId : "-"),
1207 (srw_req->startRecord ? *srw_req->startRecord : 1),
1208 srw_res->num_records);
1209 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1214 static char *srw_bend_explain_default(bend_explain_rr *rr)
1217 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1220 for (ptr = ptr->children; ptr; ptr = ptr->next)
1222 if (ptr->type != XML_ELEMENT_NODE)
1224 if (!strcmp((const char *) ptr->name, "explain"))
1227 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1231 ptr = xmlCopyNode(ptr, 1);
1233 xmlDocSetRootElement(doc, ptr);
1235 xmlDocDumpMemory(doc, &buf_out, &len);
1236 content = (char*) odr_malloc(rr->stream, 1+len);
1237 memcpy(content, buf_out, len);
1238 content[len] = '\0';
1242 rr->explain_buf = content;
1250 static void srw_bend_explain(association *assoc,
1252 Z_SRW_explainResponse *srw_res,
1255 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1256 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1258 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1263 rr.stream = assoc->encode;
1264 rr.decode = assoc->decode;
1265 rr.print = assoc->print;
1267 rr.database = srw_req->database;
1269 rr.server_node_ptr = assoc->server->server_node_ptr;
1271 rr.server_node_ptr = 0;
1272 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1273 if (assoc->init->bend_explain)
1274 (*assoc->init->bend_explain)(assoc->backend, &rr);
1276 srw_bend_explain_default(&rr);
1280 int packing = Z_SRW_recordPacking_string;
1281 if (srw_req->recordPacking)
1284 yaz_srw_str_to_pack(srw_req->recordPacking);
1286 packing = Z_SRW_recordPacking_string;
1288 srw_res->record.recordSchema = rr.schema;
1289 srw_res->record.recordPacking = packing;
1290 srw_res->record.recordData_buf = rr.explain_buf;
1291 srw_res->record.recordData_len = strlen(rr.explain_buf);
1292 srw_res->record.recordPosition = 0;
1298 static void srw_bend_scan(association *assoc,
1303 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1304 Z_SRW_scanResponse *srw_res = res->u.scan_response;
1305 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1308 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1309 if (srw_res->num_diagnostics == 0 && assoc->init)
1312 struct scan_entry *save_entries;
1314 bend_scan_rr *bsrr = (bend_scan_rr *)
1315 odr_malloc(assoc->encode, sizeof(*bsrr));
1316 bsrr->num_bases = 1;
1317 bsrr->basenames = &srw_req->database;
1319 bsrr->num_entries = srw_req->maximumTerms ?
1320 odr_int_to_int(*srw_req->maximumTerms) : 10;
1321 bsrr->term_position = srw_req->responsePosition ?
1322 odr_int_to_int(*srw_req->responsePosition) : 1;
1325 bsrr->errstring = 0;
1326 bsrr->referenceId = 0;
1327 bsrr->stream = assoc->encode;
1328 bsrr->print = assoc->print;
1329 bsrr->step_size = &step_size;
1332 bsrr->extra_response_data = 0;
1334 if (bsrr->num_entries > 0)
1337 bsrr->entries = (struct scan_entry *)
1338 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1340 for (i = 0; i<bsrr->num_entries; i++)
1342 bsrr->entries[i].term = 0;
1343 bsrr->entries[i].occurrences = 0;
1344 bsrr->entries[i].errcode = 0;
1345 bsrr->entries[i].errstring = 0;
1346 bsrr->entries[i].display_term = 0;
1349 save_entries = bsrr->entries; /* save it so we can compare later */
1351 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1352 assoc->init->bend_scan)
1354 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1356 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1357 &bsrr->attributeset,
1358 srw_req->scanClause.pqf);
1359 yaz_pqf_destroy(pqf_parser);
1360 bsrr->scanClause = 0;
1361 ((int (*)(void *, bend_scan_rr *))
1362 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1364 else if (srw_req->query_type == Z_SRW_query_type_cql
1365 && assoc->init->bend_scan && assoc->server
1366 && assoc->server->cql_transform)
1369 bsrr->scanClause = 0;
1370 bsrr->attributeset = 0;
1371 bsrr->term = (Z_AttributesPlusTerm *)
1372 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1373 srw_error = cql2pqf_scan(assoc->encode,
1374 srw_req->scanClause.cql,
1375 assoc->server->cql_transform,
1378 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1379 &srw_res->num_diagnostics,
1383 ((int (*)(void *, bend_scan_rr *))
1384 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1387 else if (srw_req->query_type == Z_SRW_query_type_cql
1388 && assoc->init->bend_srw_scan)
1391 bsrr->attributeset = 0;
1392 bsrr->scanClause = srw_req->scanClause.cql;
1393 ((int (*)(void *, bend_scan_rr *))
1394 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1398 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1399 &srw_res->num_diagnostics,
1400 YAZ_SRW_UNSUPP_OPERATION, "scan");
1402 if (bsrr->extra_response_data)
1404 res->extraResponseData_buf = bsrr->extra_response_data;
1405 res->extraResponseData_len = strlen(bsrr->extra_response_data);
1410 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1415 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1417 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1418 &srw_res->num_diagnostics,
1419 srw_error, bsrr->errstring);
1421 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1424 srw_res->terms = (Z_SRW_scanTerm*)
1425 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1428 srw_res->num_terms = bsrr->num_entries;
1429 for (i = 0; i<bsrr->num_entries; i++)
1431 Z_SRW_scanTerm *t = srw_res->terms + i;
1432 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1433 t->numberOfRecords =
1434 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1436 if (save_entries == bsrr->entries &&
1437 bsrr->entries[i].display_term)
1439 /* the entries was _not_ set by the handler. So it's
1440 safe to test for new member display_term. It is
1443 t->displayTerm = odr_strdup(assoc->encode,
1444 bsrr->entries[i].display_term);
1452 WRBUF wr = wrbuf_alloc();
1453 const char *querytype = 0;
1454 const char *querystr = 0;
1456 switch(srw_req->query_type)
1458 case Z_SRW_query_type_pqf:
1460 querystr = srw_req->scanClause.pqf;
1462 case Z_SRW_query_type_cql:
1464 querystr = srw_req->scanClause.cql;
1467 querytype = "UNKNOWN";
1471 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1473 if (srw_res->num_diagnostics)
1474 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1475 else if (srw_res->num_terms)
1476 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1478 wrbuf_printf(wr, "OK - - ");
1480 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1481 (srw_req->responsePosition ?
1482 *srw_req->responsePosition : 1),
1483 (srw_req->maximumTerms ?
1484 *srw_req->maximumTerms : 1));
1485 /* there is no step size in SRU/W ??? */
1486 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1487 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1493 static void srw_bend_update(association *assoc,
1495 Z_SRW_updateResponse *srw_res,
1498 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1499 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1500 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1502 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1506 Z_SRW_extra_record *extra = srw_req->extra_record;
1508 rr.stream = assoc->encode;
1509 rr.print = assoc->print;
1511 rr.basenames = &srw_req->database;
1512 rr.operation = srw_req->operation;
1513 rr.operation_status = "failed";
1515 rr.record_versions = 0;
1516 rr.num_versions = 0;
1517 rr.record_packing = "string";
1518 rr.record_schema = 0;
1520 rr.extra_record_data = 0;
1521 rr.extra_request_data = 0;
1522 rr.extra_response_data = 0;
1528 if (rr.operation == 0)
1530 yaz_add_sru_update_diagnostic(
1531 assoc->encode, &srw_res->diagnostics,
1532 &srw_res->num_diagnostics,
1533 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1537 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1538 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1539 if (!strcmp( rr.operation, "delete"))
1541 if (srw_req->record && !srw_req->record->recordSchema)
1543 rr.record_schema = odr_strdup(
1545 srw_req->record->recordSchema);
1547 if (srw_req->record)
1549 rr.record_data = odr_strdupn(
1551 srw_req->record->recordData_buf,
1552 srw_req->record->recordData_len );
1554 if (extra && extra->extraRecordData_len)
1556 rr.extra_record_data = odr_strdupn(
1558 extra->extraRecordData_buf,
1559 extra->extraRecordData_len );
1561 if (srw_req->recordId)
1562 rr.record_id = srw_req->recordId;
1563 else if (extra && extra->recordIdentifier)
1564 rr.record_id = extra->recordIdentifier;
1566 else if (!strcmp(rr.operation, "replace"))
1568 if (srw_req->recordId)
1569 rr.record_id = srw_req->recordId;
1570 else if (extra && extra->recordIdentifier)
1571 rr.record_id = extra->recordIdentifier;
1574 yaz_add_sru_update_diagnostic(
1575 assoc->encode, &srw_res->diagnostics,
1576 &srw_res->num_diagnostics,
1577 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1578 "recordIdentifier");
1580 if (!srw_req->record)
1582 yaz_add_sru_update_diagnostic(
1583 assoc->encode, &srw_res->diagnostics,
1584 &srw_res->num_diagnostics,
1585 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1590 if (srw_req->record->recordSchema)
1591 rr.record_schema = odr_strdup(
1592 assoc->encode, srw_req->record->recordSchema);
1593 if (srw_req->record->recordData_len )
1595 rr.record_data = odr_strdupn(assoc->encode,
1596 srw_req->record->recordData_buf,
1597 srw_req->record->recordData_len );
1601 yaz_add_sru_update_diagnostic(
1602 assoc->encode, &srw_res->diagnostics,
1603 &srw_res->num_diagnostics,
1604 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1608 if (extra && extra->extraRecordData_len)
1610 rr.extra_record_data = odr_strdupn(
1612 extra->extraRecordData_buf,
1613 extra->extraRecordData_len );
1616 else if (!strcmp(rr.operation, "insert"))
1618 if (srw_req->recordId)
1619 rr.record_id = srw_req->recordId;
1621 rr.record_id = extra->recordIdentifier;
1623 if (srw_req->record)
1625 if (srw_req->record->recordSchema)
1626 rr.record_schema = odr_strdup(
1627 assoc->encode, srw_req->record->recordSchema);
1629 if (srw_req->record->recordData_len)
1630 rr.record_data = odr_strdupn(
1632 srw_req->record->recordData_buf,
1633 srw_req->record->recordData_len );
1635 if (extra && extra->extraRecordData_len)
1637 rr.extra_record_data = odr_strdupn(
1639 extra->extraRecordData_buf,
1640 extra->extraRecordData_len );
1644 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1645 &srw_res->num_diagnostics,
1646 YAZ_SRU_UPDATE_INVALID_ACTION,
1649 if (srw_req->record)
1651 const char *pack_str =
1652 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1654 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1657 if (srw_req->num_recordVersions)
1659 rr.record_versions = srw_req->recordVersions;
1660 rr.num_versions = srw_req->num_recordVersions;
1662 if (srw_req->extraRequestData_len)
1664 rr.extra_request_data = odr_strdupn(assoc->encode,
1665 srw_req->extraRequestData_buf,
1666 srw_req->extraRequestData_len );
1668 if (srw_res->num_diagnostics == 0)
1670 if ( assoc->init->bend_srw_update)
1671 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1673 yaz_add_sru_update_diagnostic(
1674 assoc->encode, &srw_res->diagnostics,
1675 &srw_res->num_diagnostics,
1676 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1677 "No Update backend handler");
1681 yaz_add_srw_diagnostic_uri(assoc->encode,
1682 &srw_res->diagnostics,
1683 &srw_res->num_diagnostics,
1687 srw_res->recordId = rr.record_id;
1688 srw_res->operationStatus = rr.operation_status;
1689 srw_res->recordVersions = rr.record_versions;
1690 srw_res->num_recordVersions = rr.num_versions;
1691 if (srw_res->extraResponseData_len)
1693 srw_res->extraResponseData_buf = rr.extra_response_data;
1694 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1696 if (srw_res->num_diagnostics == 0 && rr.record_data)
1698 srw_res->record = yaz_srw_get_record(assoc->encode);
1699 srw_res->record->recordSchema = rr.record_schema;
1700 if (rr.record_packing)
1702 int pack = yaz_srw_str_to_pack(rr.record_packing);
1706 pack = Z_SRW_recordPacking_string;
1707 yaz_log(YLOG_WARN, "Back packing %s from backend",
1710 srw_res->record->recordPacking = pack;
1712 srw_res->record->recordData_buf = rr.record_data;
1713 srw_res->record->recordData_len = strlen(rr.record_data);
1714 if (rr.extra_record_data)
1716 Z_SRW_extra_record *ex =
1717 yaz_srw_get_extra_record(assoc->encode);
1718 srw_res->extra_record = ex;
1719 ex->extraRecordData_buf = rr.extra_record_data;
1720 ex->extraRecordData_len = strlen(rr.extra_record_data);
1726 /* check if path is OK (1); BAD (0) */
1727 static int check_path(const char *path)
1731 if (strstr(path, ".."))
1736 static char *read_file(const char *fname, ODR o, size_t *sz)
1739 FILE *inf = fopen(fname, "rb");
1743 fseek(inf, 0L, SEEK_END);
1746 buf = (char *) odr_malloc(o, *sz);
1747 if (fread(buf, 1, *sz, inf) != *sz)
1748 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1753 static void process_http_request(association *assoc, request *req)
1755 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1756 ODR o = assoc->encode;
1757 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1759 Z_SOAP *soap_package = 0;
1762 Z_HTTP_Response *hres = 0;
1764 const char *stylesheet = 0; /* for now .. set later */
1765 Z_SRW_diagnostic *diagnostic = 0;
1766 int num_diagnostic = 0;
1767 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1769 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1770 if (!control_association(assoc, host, 0))
1772 p = z_get_HTTP_Response(o, 404);
1775 if (r == 2 && assoc->server && assoc->server->docpath
1776 && hreq->path[0] == '/'
1778 /* check if path is a proper prefix of documentroot */
1779 strncmp(hreq->path+1, assoc->server->docpath,
1780 strlen(assoc->server->docpath))
1783 if (!check_path(hreq->path))
1785 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1786 p = z_get_HTTP_Response(o, 404);
1790 size_t content_size = 0;
1791 char *content_buf = read_file(hreq->path+1, o, &content_size);
1794 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1795 p = z_get_HTTP_Response(o, 404);
1799 const char *ctype = 0;
1800 yaz_mime_types types = yaz_mime_types_create();
1802 yaz_mime_types_add(types, "xsl", "application/xml");
1803 yaz_mime_types_add(types, "xml", "application/xml");
1804 yaz_mime_types_add(types, "css", "text/css");
1805 yaz_mime_types_add(types, "html", "text/html");
1806 yaz_mime_types_add(types, "htm", "text/html");
1807 yaz_mime_types_add(types, "txt", "text/plain");
1808 yaz_mime_types_add(types, "js", "application/x-javascript");
1810 yaz_mime_types_add(types, "gif", "image/gif");
1811 yaz_mime_types_add(types, "png", "image/png");
1812 yaz_mime_types_add(types, "jpg", "image/jpeg");
1813 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1815 ctype = yaz_mime_lookup_fname(types, hreq->path);
1818 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1819 p = z_get_HTTP_Response(o, 404);
1823 p = z_get_HTTP_Response(o, 200);
1824 hres = p->u.HTTP_Response;
1825 hres->content_buf = content_buf;
1826 hres->content_len = content_size;
1827 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1829 yaz_mime_types_destroy(types);
1837 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1838 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1840 if (r == 2) /* not taken */
1842 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1843 &diagnostic, &num_diagnostic);
1844 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1846 if (r == 0) /* decode SRW/SRU OK .. */
1848 int http_code = 200;
1849 if (sr->which == Z_SRW_searchRetrieve_request)
1852 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1854 stylesheet = sr->u.request->stylesheet;
1857 res->u.response->diagnostics = diagnostic;
1858 res->u.response->num_diagnostics = num_diagnostic;
1862 srw_bend_search(assoc, sr, res, &http_code);
1864 if (http_code == 200)
1865 soap_package->u.generic->p = res;
1867 else if (sr->which == Z_SRW_explain_request)
1869 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1871 stylesheet = sr->u.explain_request->stylesheet;
1874 res->u.explain_response->diagnostics = diagnostic;
1875 res->u.explain_response->num_diagnostics = num_diagnostic;
1877 srw_bend_explain(assoc, sr, res->u.explain_response, &http_code);
1878 if (http_code == 200)
1879 soap_package->u.generic->p = res;
1881 else if (sr->which == Z_SRW_scan_request)
1883 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1885 stylesheet = sr->u.scan_request->stylesheet;
1888 res->u.scan_response->diagnostics = diagnostic;
1889 res->u.scan_response->num_diagnostics = num_diagnostic;
1891 srw_bend_scan(assoc, sr, res, &http_code);
1892 if (http_code == 200)
1893 soap_package->u.generic->p = res;
1895 else if (sr->which == Z_SRW_update_request)
1897 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1899 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1902 res->u.update_response->diagnostics = diagnostic;
1903 res->u.update_response->num_diagnostics = num_diagnostic;
1905 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1906 srw_bend_update(assoc, sr, res->u.update_response, &http_code);
1907 if (http_code == 200)
1908 soap_package->u.generic->p = res;
1912 yaz_log(log_request, "SOAP ERROR");
1913 /* FIXME - what error, what query */
1915 z_soap_error(assoc->encode, soap_package,
1916 "SOAP-ENV:Client", "Bad method", 0);
1918 if (http_code == 200 || http_code == 500)
1920 static Z_SOAP_Handler soap_handlers[4] = {
1922 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1923 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1924 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1929 p = z_get_HTTP_Response(o, 200);
1930 hres = p->u.HTTP_Response;
1932 if (!stylesheet && assoc->server)
1933 stylesheet = assoc->server->stylesheet;
1935 /* empty stylesheet means NO stylesheet */
1936 if (stylesheet && *stylesheet == '\0')
1939 z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1940 &hres->content_buf, &hres->content_len,
1941 soap_handlers, charset, stylesheet);
1942 hres->code = http_code;
1944 strcpy(ctype, "text/xml");
1945 if (charset && strlen(charset) < sizeof(ctype)-30)
1947 strcat(ctype, "; charset=");
1948 strcat(ctype, charset);
1950 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1953 p = z_get_HTTP_Response(o, http_code);
1957 p = z_get_HTTP_Response(o, 500);
1958 hres = p->u.HTTP_Response;
1959 if (!strcmp(hreq->version, "1.0"))
1961 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1962 if (v && !strcmp(v, "Keep-Alive"))
1966 hres->version = "1.0";
1970 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1971 if (v && !strcmp(v, "close"))
1975 hres->version = "1.1";
1977 if (!keepalive || !assoc->last_control->keepalive)
1979 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1980 assoc->state = ASSOC_DEAD;
1981 assoc->cs_get_mask = 0;
1986 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1988 if (alive && yaz_isdigit(*(const unsigned char *) alive))
1992 if (t < 0 || t > 3600)
1994 iochan_settimeout(assoc->client_chan,t);
1995 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1997 process_gdu_response(assoc, req, p);
2000 static void process_gdu_request(association *assoc, request *req)
2002 if (req->gdu_request->which == Z_GDU_Z3950)
2005 req->apdu_request = req->gdu_request->u.z3950;
2006 if (process_z_request(assoc, req, &msg) < 0)
2007 do_close_req(assoc, Z_Close_systemProblem, msg, req);
2009 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
2010 process_http_request(assoc, req);
2013 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
2018 * Initiate request processing.
2020 static int process_z_request(association *assoc, request *req, char **msg)
2025 *msg = "Unknown Error";
2026 assert(req && req->state == REQUEST_IDLE);
2027 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
2029 *msg = "Missing InitRequest";
2032 switch (req->apdu_request->which)
2034 case Z_APDU_initRequest:
2035 res = process_initRequest(assoc, req); break;
2036 case Z_APDU_searchRequest:
2037 res = process_searchRequest(assoc, req); break;
2038 case Z_APDU_presentRequest:
2039 res = process_presentRequest(assoc, req); break;
2040 case Z_APDU_scanRequest:
2041 if (assoc->init->bend_scan)
2042 res = process_scanRequest(assoc, req);
2045 *msg = "Cannot handle Scan APDU";
2049 case Z_APDU_extendedServicesRequest:
2050 if (assoc->init->bend_esrequest)
2051 res = process_ESRequest(assoc, req);
2054 *msg = "Cannot handle Extended Services APDU";
2058 case Z_APDU_sortRequest:
2059 if (assoc->init->bend_sort)
2060 res = process_sortRequest(assoc, req);
2063 *msg = "Cannot handle Sort APDU";
2068 process_close(assoc, req);
2070 case Z_APDU_deleteResultSetRequest:
2071 if (assoc->init->bend_delete)
2072 res = process_deleteRequest(assoc, req);
2075 *msg = "Cannot handle Delete APDU";
2079 case Z_APDU_segmentRequest:
2080 if (assoc->init->bend_segment)
2082 res = process_segmentRequest(assoc, req);
2086 *msg = "Cannot handle Segment APDU";
2090 case Z_APDU_triggerResourceControlRequest:
2093 *msg = "Bad APDU received";
2098 yaz_log(YLOG_DEBUG, " result immediately available");
2099 retval = process_z_response(assoc, req, res);
2103 yaz_log(YLOG_DEBUG, " result unavailable");
2110 * Encode response, and transfer the request structure to the outgoing queue.
2112 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2114 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2118 if (!z_GDU(assoc->print, &res, 0, 0))
2119 yaz_log(YLOG_WARN, "ODR print error: %s",
2120 odr_errmsg(odr_geterror(assoc->print)));
2121 odr_reset(assoc->print);
2123 if (!z_GDU(assoc->encode, &res, 0, 0))
2125 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2126 odr_errmsg(odr_geterror(assoc->decode)),
2127 odr_getelement(assoc->decode));
2130 req->response = odr_getbuf(assoc->encode, &req->len_response,
2131 &req->size_response);
2132 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2133 odr_reset(assoc->encode);
2134 req->state = REQUEST_IDLE;
2135 request_enq(&assoc->outgoing, req);
2136 /* turn the work over to the ir_session handler */
2137 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2138 assoc->cs_put_mask = EVENT_OUTPUT;
2139 /* Is there more work to be done? give that to the input handler too */
2142 req = request_head(&assoc->incoming);
2143 if (req && req->state == REQUEST_IDLE)
2145 request_deq(&assoc->incoming);
2146 process_gdu_request(assoc, req);
2155 * Encode response, and transfer the request structure to the outgoing queue.
2157 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2159 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*gres));
2160 gres->which = Z_GDU_Z3950;
2161 gres->u.z3950 = res;
2163 return process_gdu_response(assoc, req, gres);
2166 static char *get_vhost(Z_OtherInformation *otherInfo)
2168 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2172 * Handle init request.
2173 * At the moment, we don't check the options
2174 * anywhere else in the code - we just try not to do anything that would
2175 * break a naive client. We'll toss 'em into the association block when
2176 * we need them there.
2178 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2180 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2181 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2182 Z_InitResponse *resp = apdu->u.initResponse;
2183 bend_initresult *binitres;
2185 statserv_options_block *cb = 0; /* by default no control for backend */
2187 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2188 cb = statserv_getcontrol(); /* got control block for backend */
2190 if (cb && assoc->backend)
2191 (*cb->bend_close)(assoc->backend);
2193 yaz_log(log_requestdetail, "Got initRequest");
2194 if (req->implementationId)
2195 yaz_log(log_requestdetail, "Id: %s",
2196 req->implementationId);
2197 if (req->implementationName)
2198 yaz_log(log_requestdetail, "Name: %s",
2199 req->implementationName);
2200 if (req->implementationVersion)
2201 yaz_log(log_requestdetail, "Version: %s",
2202 req->implementationVersion);
2204 assoc_init_reset(assoc);
2206 assoc->init->auth = req->idAuthentication;
2207 assoc->init->referenceId = req->referenceId;
2209 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2211 Z_CharSetandLanguageNegotiation *negotiation =
2212 yaz_get_charneg_record (req->otherInfo);
2214 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2215 assoc->init->charneg_request = negotiation;
2218 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2219 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2220 assoc->init->named_result_sets = 1;
2225 if (req->implementationVersion)
2226 yaz_log(log_requestdetail, "Config: %s",
2229 iochan_settimeout(assoc->client_chan, cb->idle_timeout);
2231 /* we have a backend control block, so call that init function */
2232 if (!(binitres = (*cb->bend_init)(assoc->init)))
2234 yaz_log(YLOG_WARN, "Bad response from backend.");
2237 assoc->backend = binitres->handle;
2241 /* no backend. return error */
2242 binitres = (bend_initresult *)
2243 odr_malloc(assoc->encode, sizeof(*binitres));
2244 binitres->errstring = 0;
2245 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2246 iochan_settimeout(assoc->client_chan, 10);
2248 if ((assoc->init->bend_sort))
2249 yaz_log(YLOG_DEBUG, "Sort handler installed");
2250 if ((assoc->init->bend_search))
2251 yaz_log(YLOG_DEBUG, "Search handler installed");
2252 if ((assoc->init->bend_present))
2253 yaz_log(YLOG_DEBUG, "Present handler installed");
2254 if ((assoc->init->bend_esrequest))
2255 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2256 if ((assoc->init->bend_delete))
2257 yaz_log(YLOG_DEBUG, "Delete handler installed");
2258 if ((assoc->init->bend_scan))
2259 yaz_log(YLOG_DEBUG, "Scan handler installed");
2260 if ((assoc->init->bend_segment))
2261 yaz_log(YLOG_DEBUG, "Segment handler installed");
2263 resp->referenceId = req->referenceId;
2265 /* let's tell the client what we can do */
2266 if (ODR_MASK_GET(req->options, Z_Options_search))
2268 ODR_MASK_SET(resp->options, Z_Options_search);
2269 strcat(options, "srch");
2271 if (ODR_MASK_GET(req->options, Z_Options_present))
2273 ODR_MASK_SET(resp->options, Z_Options_present);
2274 strcat(options, " prst");
2276 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2277 assoc->init->bend_delete)
2279 ODR_MASK_SET(resp->options, Z_Options_delSet);
2280 strcat(options, " del");
2282 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2283 assoc->init->bend_esrequest)
2285 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2286 strcat(options, " extendedServices");
2288 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2289 && assoc->init->named_result_sets)
2291 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2292 strcat(options, " namedresults");
2294 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2296 ODR_MASK_SET(resp->options, Z_Options_scan);
2297 strcat(options, " scan");
2299 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2301 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2302 strcat(options, " concurrop");
2304 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2306 ODR_MASK_SET(resp->options, Z_Options_sort);
2307 strcat(options, " sort");
2310 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2312 Z_OtherInformationUnit *p0;
2314 if (!assoc->init->charneg_response)
2316 if (assoc->init->query_charset)
2318 assoc->init->charneg_response = yaz_set_response_charneg(
2319 assoc->encode, assoc->init->query_charset, 0,
2320 assoc->init->records_in_same_charset);
2324 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2327 if (assoc->init->charneg_response
2328 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2330 p0->which = Z_OtherInfo_externallyDefinedInfo;
2331 p0->information.externallyDefinedInfo =
2332 assoc->init->charneg_response;
2333 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2334 strcat(options, " negotiation");
2337 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2338 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2340 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2342 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2343 assoc->version = 1; /* 1 & 2 are equivalent */
2345 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2347 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2350 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2352 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2356 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2358 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2359 assoc->maximumRecordSize = odr_int_to_int(*req->maximumRecordSize);
2361 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2362 assoc->preferredMessageSize = odr_int_to_int(*req->preferredMessageSize);
2364 resp->preferredMessageSize =
2365 odr_intdup(assoc->encode, assoc->preferredMessageSize);
2366 resp->maximumRecordSize =
2367 odr_intdup(assoc->encode, assoc->maximumRecordSize);
2369 resp->implementationId = odr_prepend(assoc->encode,
2370 assoc->init->implementation_id,
2371 resp->implementationId);
2373 resp->implementationVersion = odr_prepend(assoc->encode,
2374 assoc->init->implementation_version,
2375 resp->implementationVersion);
2377 resp->implementationName = odr_prepend(assoc->encode,
2378 assoc->init->implementation_name,
2379 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2381 if (binitres->errcode)
2383 assoc->state = ASSOC_DEAD;
2384 resp->userInformationField =
2385 init_diagnostics(assoc->encode, binitres->errcode,
2386 binitres->errstring);
2390 assoc->state = ASSOC_UP;
2394 if (!req->idAuthentication)
2395 yaz_log(log_request, "Auth none");
2396 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2398 const char *open = req->idAuthentication->u.open;
2399 const char *slash = strchr(open, '/');
2405 yaz_log(log_request, "Auth open %.*s", len, open);
2407 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2409 const char *user = req->idAuthentication->u.idPass->userId;
2410 const char *group = req->idAuthentication->u.idPass->groupId;
2411 yaz_log(log_request, "Auth idPass %s %s",
2412 user ? user : "-", group ? group : "-");
2414 else if (req->idAuthentication->which
2415 == Z_IdAuthentication_anonymous)
2417 yaz_log(log_request, "Auth anonymous");
2421 yaz_log(log_request, "Auth other");
2426 WRBUF wr = wrbuf_alloc();
2427 wrbuf_printf(wr, "Init ");
2428 if (binitres->errcode)
2429 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2431 wrbuf_printf(wr, "OK -");
2432 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2433 (req->implementationId ? req->implementationId :"-"),
2434 (req->implementationName ?
2435 req->implementationName : "-"),
2436 (req->implementationVersion ?
2437 req->implementationVersion : "-")
2439 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2446 * Set the specified `errcode' and `errstring' into a UserInfo-1
2447 * external to be returned to the client in accordance with Z35.90
2448 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2449 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2451 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2453 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2454 addinfo ? " -- " : "", addinfo ? addinfo : "");
2455 return zget_init_diagnostics(odr, error, addinfo);
2459 * nonsurrogate diagnostic record.
2461 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2463 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2465 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2466 addinfo ? " -- " : "", addinfo ? addinfo : "");
2468 rec->which = Z_Records_NSD;
2469 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2475 * surrogate diagnostic.
2477 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2479 int error, const char *addinfo)
2481 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2482 addinfo ? " -- " : "", addinfo ? addinfo : "");
2483 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2486 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2487 Odr_int *num, Z_RecordComposition *comp,
2488 Odr_int *next, Odr_int *pres,
2489 Z_ReferenceId *referenceId,
2490 Odr_oid *oid, int *errcode)
2492 int recno, total_length = 0, dumped_records = 0;
2493 int toget = odr_int_to_int(*num);
2494 Z_Records *records =
2495 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2496 Z_NamePlusRecordList *reclist =
2497 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2499 records->which = Z_Records_DBOSD;
2500 records->u.databaseOrSurDiagnostics = reclist;
2501 reclist->num_records = 0;
2504 return diagrec(a, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, 0);
2505 else if (toget == 0)
2506 reclist->records = odr_nullval();
2508 reclist->records = (Z_NamePlusRecord **)
2509 odr_malloc(a->encode, sizeof(*reclist->records) * toget);
2511 *pres = Z_PresentStatus_success;
2515 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2516 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2517 a->maximumRecordSize);
2518 for (recno = odr_int_to_int(start); reclist->num_records < toget; recno++)
2521 Z_NamePlusRecord *thisrec;
2522 int this_length = 0;
2524 * we get the number of bytes allocated on the stream before any
2525 * allocation done by the backend - this should give us a reasonable
2526 * idea of the total size of the data so far.
2528 total_length = odr_total(a->encode) - dumped_records;
2534 freq.last_in_set = 0;
2535 freq.setname = setname;
2536 freq.surrogate_flag = 0;
2537 freq.number = recno;
2539 freq.request_format = oid;
2540 freq.output_format = 0;
2541 freq.stream = a->encode;
2542 freq.print = a->print;
2543 freq.referenceId = referenceId;
2546 retrieve_fetch(a, &freq);
2548 *next = freq.last_in_set ? 0 : recno + 1;
2552 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2555 *pres = Z_PresentStatus_failure;
2556 /* for 'present request out of range',
2557 set addinfo to record position if not set */
2558 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2559 freq.errstring == 0)
2561 sprintf(s, "%d", recno);
2565 *errcode = freq.errcode;
2566 return diagrec(a, freq.errcode, freq.errstring);
2568 reclist->records[reclist->num_records] =
2569 surrogatediagrec(a, freq.basename, freq.errcode,
2571 reclist->num_records++;
2574 if (freq.record == 0) /* no error and no record ? */
2576 *pres = Z_PresentStatus_partial_4;
2577 *next = 0; /* signal end-of-set and stop */
2581 this_length = freq.len;
2583 this_length = odr_total(a->encode) - total_length - dumped_records;
2584 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2585 this_length, total_length, dumped_records);
2586 if (a->preferredMessageSize > 0 &&
2587 this_length + total_length > a->preferredMessageSize)
2589 /* record is small enough, really */
2590 if (this_length <= a->preferredMessageSize && recno > start)
2592 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2593 *pres = Z_PresentStatus_partial_2;
2598 /* record can only be fetched by itself */
2599 if (this_length < a->maximumRecordSize)
2601 yaz_log(log_requestdetail, " Record > prefmsgsz");
2604 yaz_log(YLOG_DEBUG, " Dropped it");
2605 reclist->records[reclist->num_records] =
2608 YAZ_BIB1_RECORD_EXCEEDS_PREFERRED_MESSAGE_SIZE, 0);
2609 reclist->num_records++;
2610 dumped_records += this_length;
2614 else /* too big entirely */
2616 yaz_log(log_requestdetail, "Record > maxrcdsz "
2618 this_length, a->maximumRecordSize);
2619 reclist->records[reclist->num_records] =
2622 YAZ_BIB1_RECORD_EXCEEDS_MAXIMUM_RECORD_SIZE, 0);
2623 reclist->num_records++;
2624 dumped_records += this_length;
2629 if (!(thisrec = (Z_NamePlusRecord *)
2630 odr_malloc(a->encode, sizeof(*thisrec))))
2632 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2633 thisrec->which = Z_NamePlusRecord_databaseRecord;
2635 if (!freq.output_format)
2637 yaz_log(YLOG_WARN, "bend_fetch output_format not set");
2640 thisrec->u.databaseRecord = z_ext_record_oid(
2641 a->encode, freq.output_format, freq.record, freq.len);
2642 if (!thisrec->u.databaseRecord)
2644 reclist->records[reclist->num_records] = thisrec;
2645 reclist->num_records++;
2646 if (freq.last_in_set)
2649 *num = reclist->num_records;
2653 static Z_APDU *process_searchRequest(association *assoc, request *reqb)
2655 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2656 bend_search_rr *bsrr =
2657 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2659 yaz_log(log_requestdetail, "Got SearchRequest.");
2660 bsrr->association = assoc;
2661 bsrr->referenceId = req->referenceId;
2662 bsrr->srw_sortKeys = 0;
2663 bsrr->srw_setname = 0;
2664 bsrr->srw_setnameIdleTime = 0;
2665 bsrr->estimated_hit_count = 0;
2666 bsrr->partial_resultset = 0;
2667 bsrr->extra_args = 0;
2668 bsrr->extra_response_data = 0;
2670 yaz_log(log_requestdetail, "ResultSet '%s'", req->resultSetName);
2671 if (req->databaseNames)
2674 for (i = 0; i < req->num_databaseNames; i++)
2675 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2678 yaz_log_zquery_level(log_requestdetail,req->query);
2680 if (assoc->init->bend_search)
2682 bsrr->setname = req->resultSetName;
2683 bsrr->replace_set = *req->replaceIndicator;
2684 bsrr->num_bases = req->num_databaseNames;
2685 bsrr->basenames = req->databaseNames;
2686 bsrr->query = req->query;
2687 bsrr->stream = assoc->encode;
2688 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2689 bsrr->decode = assoc->decode;
2690 bsrr->print = assoc->print;
2693 bsrr->errstring = NULL;
2694 bsrr->search_info = NULL;
2695 bsrr->search_input = req->otherInfo;
2696 bsrr->present_number = *req->mediumSetPresentNumber;
2698 if (assoc->server && assoc->server->cql_transform
2699 && req->query->which == Z_Query_type_104
2700 && req->query->u.type_104->which == Z_External_CQL)
2702 /* have a CQL query and a CQL to PQF transform .. */
2704 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2705 assoc->server->cql_transform, bsrr->query,
2706 &bsrr->srw_sortKeys);
2708 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2711 if (assoc->server && assoc->server->ccl_transform
2712 && req->query->which == Z_Query_type_2) /*CCL*/
2714 /* have a CCL query and a CCL to PQF transform .. */
2716 ccl2pqf(bsrr->stream, req->query->u.type_2,
2717 assoc->server->ccl_transform, bsrr);
2719 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2723 (assoc->init->bend_search)(assoc->backend, bsrr);
2727 /* FIXME - make a diagnostic for it */
2728 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2730 return response_searchRequest(assoc, reqb, bsrr);
2734 * Prepare a searchresponse based on the backend results. We probably want
2735 * to look at making the fetching of records nonblocking as well, but
2736 * so far, we'll keep things simple.
2737 * If bsrt is null, that means we're called in response to a communications
2738 * event, and we'll have to get the response for ourselves.
2740 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2741 bend_search_rr *bsrt)
2743 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2744 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2745 Z_SearchResponse *resp = (Z_SearchResponse *)
2746 odr_malloc(assoc->encode, sizeof(*resp));
2747 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2748 Odr_int *next = odr_intdup(assoc->encode, 0);
2749 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2750 Odr_int returnedrecs = 0;
2752 apdu->which = Z_APDU_searchResponse;
2753 apdu->u.searchResponse = resp;
2754 resp->referenceId = req->referenceId;
2755 resp->additionalSearchInfo = 0;
2756 resp->otherInfo = 0;
2759 yaz_log(YLOG_FATAL, "Bad result from backend");
2762 else if (bsrt->errcode)
2764 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2765 resp->resultCount = nulint;
2766 resp->numberOfRecordsReturned = nulint;
2767 resp->nextResultSetPosition = nulint;
2768 resp->searchStatus = odr_booldup(assoc->encode, 0);
2769 resp->resultSetStatus = none;
2770 resp->presentStatus = 0;
2774 bool_t *sr = odr_booldup(assoc->encode, 1);
2775 Odr_int *toget = odr_intdup(assoc->encode, 0);
2776 Z_RecordComposition comp, *compp = 0;
2778 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2781 resp->resultCount = &bsrt->hits;
2783 comp.which = Z_RecordComp_simple;
2784 /* how many records does the user agent want, then? */
2787 else if (bsrt->hits <= *req->smallSetUpperBound)
2789 *toget = bsrt->hits;
2790 if ((comp.u.simple = req->smallSetElementSetNames))
2793 else if (bsrt->hits < *req->largeSetLowerBound)
2795 *toget = *req->mediumSetPresentNumber;
2796 if (*toget > bsrt->hits)
2797 *toget = bsrt->hits;
2798 if ((comp.u.simple = req->mediumSetElementSetNames))
2804 if (*toget && !resp->records)
2806 Odr_int *presst = odr_intdup(assoc->encode, 0);
2807 /* Call bend_present if defined */
2808 if (assoc->init->bend_present)
2810 bend_present_rr *bprr = (bend_present_rr *)
2811 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2812 bprr->setname = req->resultSetName;
2814 bprr->number = odr_int_to_int(*toget);
2815 bprr->format = req->preferredRecordSyntax;
2817 bprr->referenceId = req->referenceId;
2818 bprr->stream = assoc->encode;
2819 bprr->print = assoc->print;
2820 bprr->association = assoc;
2822 bprr->errstring = NULL;
2823 (*assoc->init->bend_present)(assoc->backend, bprr);
2827 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2828 *resp->presentStatus = Z_PresentStatus_failure;
2833 resp->records = pack_records(
2834 assoc, req->resultSetName, 1,
2835 toget, compp, next, presst, req->referenceId,
2836 req->preferredRecordSyntax, NULL);
2839 resp->numberOfRecordsReturned = toget;
2840 returnedrecs = *toget;
2841 resp->presentStatus = presst;
2845 if (*resp->resultCount)
2847 resp->numberOfRecordsReturned = nulint;
2848 resp->presentStatus = 0;
2850 resp->nextResultSetPosition = next;
2851 resp->searchStatus = sr;
2852 resp->resultSetStatus = 0;
2853 if (bsrt->estimated_hit_count)
2855 resp->resultSetStatus = odr_intdup(assoc->encode,
2856 Z_SearchResponse_estimate);
2858 else if (bsrt->partial_resultset)
2860 resp->resultSetStatus = odr_intdup(assoc->encode,
2861 Z_SearchResponse_subset);
2864 resp->additionalSearchInfo = bsrt->search_info;
2869 WRBUF wr = wrbuf_alloc();
2871 for (i = 0 ; i < req->num_databaseNames; i++)
2874 wrbuf_printf(wr, "+");
2875 wrbuf_puts(wr, req->databaseNames[i]);
2877 wrbuf_printf(wr, " ");
2880 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2882 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2883 wrbuf_printf(wr, " %s 1+" ODR_INT_PRINTF " ",
2884 req->resultSetName, returnedrecs);
2885 yaz_query_to_wrbuf(wr, req->query);
2887 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2894 * Maybe we got a little over-friendly when we designed bend_fetch to
2895 * get only one record at a time. Some backends can optimise multiple-record
2896 * fetches, and at any rate, there is some overhead involved in
2897 * all that selecting and hopping around. Problem is, of course, that the
2898 * frontend can't know ahead of time how many records it'll need to
2899 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2900 * is downright lousy as a bulk data transfer protocol.
2902 * To start with, we'll do the fetching of records from the backend
2903 * in one operation: To save some trips in and out of the event-handler,
2904 * and to simplify the interface to pack_records. At any rate, asynch
2905 * operation is more fun in operations that have an unpredictable execution
2906 * speed - which is normally more true for search than for present.
2908 static Z_APDU *process_presentRequest(association *assoc, request *reqb)
2910 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2912 Z_PresentResponse *resp;
2917 yaz_log(log_requestdetail, "Got PresentRequest.");
2919 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2921 resp->presentStatus = odr_intdup(assoc->encode, 0);
2922 if (assoc->init->bend_present)
2924 bend_present_rr *bprr = (bend_present_rr *)
2925 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2926 bprr->setname = req->resultSetId;
2927 bprr->start = odr_int_to_int(*req->resultSetStartPoint);
2928 bprr->number = odr_int_to_int(*req->numberOfRecordsRequested);
2929 bprr->format = req->preferredRecordSyntax;
2930 bprr->comp = req->recordComposition;
2931 bprr->referenceId = req->referenceId;
2932 bprr->stream = assoc->encode;
2933 bprr->print = assoc->print;
2934 bprr->association = assoc;
2936 bprr->errstring = NULL;
2937 (*assoc->init->bend_present)(assoc->backend, bprr);
2941 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2942 *resp->presentStatus = Z_PresentStatus_failure;
2943 errcode = bprr->errcode;
2946 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2947 next = odr_intdup(assoc->encode, 0);
2948 num = odr_intdup(assoc->encode, 0);
2950 apdu->which = Z_APDU_presentResponse;
2951 apdu->u.presentResponse = resp;
2952 resp->referenceId = req->referenceId;
2953 resp->otherInfo = 0;
2957 *num = *req->numberOfRecordsRequested;
2959 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2960 num, req->recordComposition, next,
2961 resp->presentStatus,
2962 req->referenceId, req->preferredRecordSyntax,
2967 WRBUF wr = wrbuf_alloc();
2968 wrbuf_printf(wr, "Present ");
2970 if (*resp->presentStatus == Z_PresentStatus_failure)
2971 wrbuf_printf(wr, "ERROR %d ", errcode);
2972 else if (*resp->presentStatus == Z_PresentStatus_success)
2973 wrbuf_printf(wr, "OK - ");
2975 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2976 *resp->presentStatus);
2978 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2979 req->resultSetId, *req->resultSetStartPoint,
2980 *req->numberOfRecordsRequested);
2981 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2986 resp->numberOfRecordsReturned = num;
2987 resp->nextResultSetPosition = next;
2993 * Scan was implemented rather in a hurry, and with support for only the basic
2994 * elements of the service in the backend API. Suggestions are welcome.
2996 static Z_APDU *process_scanRequest(association *assoc, request *reqb)
2998 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2999 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3000 Z_ScanResponse *res = (Z_ScanResponse *)
3001 odr_malloc(assoc->encode, sizeof(*res));
3002 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
3003 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
3004 Z_ListEntries *ents = (Z_ListEntries *)
3005 odr_malloc(assoc->encode, sizeof(*ents));
3006 Z_DiagRecs *diagrecs_p = NULL;
3007 bend_scan_rr *bsrr = (bend_scan_rr *)
3008 odr_malloc(assoc->encode, sizeof(*bsrr));
3009 struct scan_entry *save_entries;
3012 yaz_log(log_requestdetail, "Got ScanRequest");
3014 apdu->which = Z_APDU_scanResponse;
3015 apdu->u.scanResponse = res;
3016 res->referenceId = req->referenceId;
3018 /* if step is absent, set it to 0 */
3020 step_size = odr_int_to_int(*req->stepSize);
3023 res->scanStatus = scanStatus;
3024 res->numberOfEntriesReturned = numberOfEntriesReturned;
3025 res->positionOfTerm = 0;
3026 res->entries = ents;
3027 ents->num_entries = 0;
3028 ents->entries = NULL;
3029 ents->num_nonsurrogateDiagnostics = 0;
3030 ents->nonsurrogateDiagnostics = NULL;
3031 res->attributeSet = 0;
3034 if (req->databaseNames)
3037 for (i = 0; i < req->num_databaseNames; i++)
3038 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
3040 bsrr->scanClause = 0;
3042 bsrr->errstring = 0;
3043 bsrr->num_bases = req->num_databaseNames;
3044 bsrr->basenames = req->databaseNames;
3045 bsrr->num_entries = odr_int_to_int(*req->numberOfTermsRequested);
3046 bsrr->term = req->termListAndStartPoint;
3047 bsrr->referenceId = req->referenceId;
3048 bsrr->stream = assoc->encode;
3049 bsrr->print = assoc->print;
3050 bsrr->step_size = &step_size;
3051 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
3052 yaz_oid_userinfo_scan_set, 1, 0);
3054 bsrr->extra_response_data = 0;
3055 /* For YAZ 2.0 and earlier it was the backend handler that
3056 initialized entries (member display_term did not exist)
3057 YAZ 2.0 and later sets 'entries' and initialize all members
3058 including 'display_term'. If YAZ 2.0 or later sees that
3059 entries was modified - we assume that it is an old handler and
3060 that 'display_term' is _not_ set.
3062 if (bsrr->num_entries > 0)
3065 bsrr->entries = (struct scan_entry *)
3066 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3068 for (i = 0; i<bsrr->num_entries; i++)
3070 bsrr->entries[i].term = 0;
3071 bsrr->entries[i].occurrences = 0;
3072 bsrr->entries[i].errcode = 0;
3073 bsrr->entries[i].errstring = 0;
3074 bsrr->entries[i].display_term = 0;
3077 save_entries = bsrr->entries; /* save it so we can compare later */
3079 bsrr->attributeset = req->attributeSet;
3080 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3081 bsrr->attributeset);
3082 bsrr->term_position = req->preferredPositionInResponse ?
3083 odr_int_to_int(*req->preferredPositionInResponse) : 1;
3085 ((int (*)(void *, bend_scan_rr *))
3086 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3089 diagrecs_p = zget_DiagRecs(assoc->encode,
3090 bsrr->errcode, bsrr->errstring);
3094 Z_Entry **tab = (Z_Entry **)
3095 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3097 if (bsrr->status == BEND_SCAN_PARTIAL)
3098 *scanStatus = Z_Scan_partial_5;
3100 *scanStatus = Z_Scan_success;
3101 res->stepSize = odr_intdup(assoc->encode, step_size);
3102 ents->entries = tab;
3103 ents->num_entries = bsrr->num_entries;
3104 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3106 res->positionOfTerm = odr_intdup(assoc->encode, bsrr->term_position);
3107 for (i = 0; i < bsrr->num_entries; i++)
3113 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3114 if (bsrr->entries[i].occurrences >= 0)
3116 e->which = Z_Entry_termInfo;
3117 e->u.termInfo = t = (Z_TermInfo *)
3118 odr_malloc(assoc->encode, sizeof(*t));
3119 t->suggestedAttributes = 0;
3121 if (save_entries == bsrr->entries &&
3122 bsrr->entries[i].display_term)
3124 /* the entries was _not_ set by the handler. So it's
3125 safe to test for new member display_term. It is
3128 t->displayTerm = odr_strdup(assoc->encode,
3129 bsrr->entries[i].display_term);
3131 t->alternativeTerm = 0;
3132 t->byAttributes = 0;
3133 t->otherTermInfo = 0;
3134 t->globalOccurrences = &bsrr->entries[i].occurrences;
3135 t->term = (Z_Term *)
3136 odr_malloc(assoc->encode, sizeof(*t->term));
3137 t->term->which = Z_Term_general;
3138 t->term->u.general = o =
3139 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3140 o->buf = (unsigned char *)
3141 odr_malloc(assoc->encode, o->len = o->size =
3142 strlen(bsrr->entries[i].term));
3143 memcpy(o->buf, bsrr->entries[i].term, o->len);
3144 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3145 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3149 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3150 bsrr->entries[i].errcode,
3151 bsrr->entries[i].errstring);
3152 assert(drecs->num_diagRecs == 1);
3153 e->which = Z_Entry_surrogateDiagnostic;
3154 assert(drecs->diagRecs[0]);
3155 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3161 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3162 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3167 WRBUF wr = wrbuf_alloc();
3168 wrbuf_printf(wr, "Scan ");
3169 for (i = 0 ; i < req->num_databaseNames; i++)
3172 wrbuf_printf(wr, "+");
3173 wrbuf_puts(wr, req->databaseNames[i]);
3176 wrbuf_printf(wr, " ");
3179 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3181 wrbuf_printf(wr, "OK");
3183 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3184 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3185 res->numberOfEntriesReturned ?
3186 *res->numberOfEntriesReturned : 0,
3187 (req->preferredPositionInResponse ?
3188 *req->preferredPositionInResponse : 1),
3189 *req->numberOfTermsRequested,
3190 (res->stepSize ? *res->stepSize : 1));
3193 wrbuf_printf(wr, "+%s", bsrr->setname);
3195 wrbuf_printf(wr, " ");
3196 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3197 bsrr->attributeset);
3198 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3204 static Z_APDU *process_sortRequest(association *assoc, request *reqb)
3207 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3208 Z_SortResponse *res = (Z_SortResponse *)
3209 odr_malloc(assoc->encode, sizeof(*res));
3210 bend_sort_rr *bsrr = (bend_sort_rr *)
3211 odr_malloc(assoc->encode, sizeof(*bsrr));
3213 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3215 yaz_log(log_requestdetail, "Got SortRequest.");
3217 bsrr->num_input_setnames = req->num_inputResultSetNames;
3218 for (i=0;i<req->num_inputResultSetNames;i++)
3219 yaz_log(log_requestdetail, "Input resultset: '%s'",
3220 req->inputResultSetNames[i]);
3221 bsrr->input_setnames = req->inputResultSetNames;
3222 bsrr->referenceId = req->referenceId;
3223 bsrr->output_setname = req->sortedResultSetName;
3224 yaz_log(log_requestdetail, "Output resultset: '%s'",
3225 req->sortedResultSetName);
3226 bsrr->sort_sequence = req->sortSequence;
3227 /*FIXME - dump those sequences too */
3228 bsrr->stream = assoc->encode;
3229 bsrr->print = assoc->print;
3231 bsrr->sort_status = Z_SortResponse_failure;
3233 bsrr->errstring = 0;
3235 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3237 res->referenceId = bsrr->referenceId;
3238 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3239 res->resultSetStatus = 0;
3242 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3243 bsrr->errcode, bsrr->errstring);
3244 res->diagnostics = dr->diagRecs;
3245 res->num_diagnostics = dr->num_diagRecs;
3249 res->num_diagnostics = 0;
3250 res->diagnostics = 0;
3252 res->resultCount = 0;
3255 apdu->which = Z_APDU_sortResponse;
3256 apdu->u.sortResponse = res;
3259 WRBUF wr = wrbuf_alloc();
3260 wrbuf_printf(wr, "Sort ");
3262 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3264 wrbuf_printf(wr, "OK -");
3265 wrbuf_printf(wr, " (");
3266 for (i = 0; i<req->num_inputResultSetNames; i++)
3269 wrbuf_printf(wr, "+");
3270 wrbuf_puts(wr, req->inputResultSetNames[i]);
3272 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3274 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3280 static Z_APDU *process_deleteRequest(association *assoc, request *reqb)
3283 Z_DeleteResultSetRequest *req =
3284 reqb->apdu_request->u.deleteResultSetRequest;
3285 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3286 odr_malloc(assoc->encode, sizeof(*res));
3287 bend_delete_rr *bdrr = (bend_delete_rr *)
3288 odr_malloc(assoc->encode, sizeof(*bdrr));
3289 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3291 yaz_log(log_requestdetail, "Got DeleteRequest.");
3293 bdrr->num_setnames = req->num_resultSetList;
3294 bdrr->setnames = req->resultSetList;
3295 for (i = 0; i<req->num_resultSetList; i++)
3296 yaz_log(log_requestdetail, "resultset: '%s'",
3297 req->resultSetList[i]);
3298 bdrr->stream = assoc->encode;
3299 bdrr->print = assoc->print;
3300 bdrr->function = odr_int_to_int(*req->deleteFunction);
3301 bdrr->referenceId = req->referenceId;
3303 if (bdrr->num_setnames > 0)
3305 bdrr->statuses = (int*)
3306 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3307 bdrr->num_setnames);
3308 for (i = 0; i < bdrr->num_setnames; i++)
3309 bdrr->statuses[i] = 0;
3311 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3313 res->referenceId = req->referenceId;
3315 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3317 res->deleteListStatuses = 0;
3318 if (bdrr->num_setnames > 0)
3321 res->deleteListStatuses = (Z_ListStatuses *)
3322 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3323 res->deleteListStatuses->num = bdrr->num_setnames;
3324 res->deleteListStatuses->elements =
3326 odr_malloc(assoc->encode,
3327 sizeof(*res->deleteListStatuses->elements) *
3328 bdrr->num_setnames);
3329 for (i = 0; i<bdrr->num_setnames; i++)
3331 res->deleteListStatuses->elements[i] =
3333 odr_malloc(assoc->encode,
3334 sizeof(**res->deleteListStatuses->elements));
3335 res->deleteListStatuses->elements[i]->status =
3336 odr_intdup(assoc->encode, bdrr->statuses[i]);
3337 res->deleteListStatuses->elements[i]->id =
3338 odr_strdup(assoc->encode, bdrr->setnames[i]);
3341 res->numberNotDeleted = 0;
3342 res->bulkStatuses = 0;
3343 res->deleteMessage = 0;
3346 apdu->which = Z_APDU_deleteResultSetResponse;
3347 apdu->u.deleteResultSetResponse = res;
3350 WRBUF wr = wrbuf_alloc();
3351 wrbuf_printf(wr, "Delete ");
3352 if (bdrr->delete_status)
3353 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3355 wrbuf_printf(wr, "OK -");
3356 for (i = 0; i<req->num_resultSetList; i++)
3357 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3358 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3364 static void process_close(association *assoc, request *reqb)
3366 Z_Close *req = reqb->apdu_request->u.close;
3367 static char *reasons[] =
3374 "securityViolation",
3381 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3382 reasons[*req->closeReason], req->diagnosticInformation ?
3383 req->diagnosticInformation : "NULL");
3384 if (assoc->version < 3) /* to make do_force respond with close */
3386 do_close_req(assoc, Z_Close_finished,
3387 "Association terminated by client", reqb);
3388 yaz_log(log_request,"Close OK");
3391 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3393 bend_segment_rr req;
3395 req.segment = reqb->apdu_request->u.segmentRequest;
3396 req.stream = assoc->encode;
3397 req.decode = assoc->decode;
3398 req.print = assoc->print;
3399 req.association = assoc;
3401 (*assoc->init->bend_segment)(assoc->backend, &req);
3406 static Z_APDU *process_ESRequest(association *assoc, request *reqb)
3408 bend_esrequest_rr esrequest;
3409 const char *ext_name = "unknown";
3411 Z_ExtendedServicesRequest *req =
3412 reqb->apdu_request->u.extendedServicesRequest;
3413 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3415 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3417 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3418 esrequest.stream = assoc->encode;
3419 esrequest.decode = assoc->decode;
3420 esrequest.print = assoc->print;
3421 esrequest.errcode = 0;
3422 esrequest.errstring = NULL;
3423 esrequest.association = assoc;
3424 esrequest.taskPackage = 0;
3425 esrequest.referenceId = req->referenceId;
3427 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3429 switch(esrequest.esr->taskSpecificParameters->which)
3431 case Z_External_itemOrder:
3432 ext_name = "ItemOrder"; break;
3433 case Z_External_update:
3434 ext_name = "Update"; break;
3435 case Z_External_update0:
3436 ext_name = "Update0"; break;
3437 case Z_External_ESAdmin:
3438 ext_name = "Admin"; break;
3443 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3445 resp->referenceId = req->referenceId;
3447 if (esrequest.errcode == -1)
3449 /* Backend service indicates request will be processed */
3450 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3451 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3453 else if (esrequest.errcode == 0)
3455 /* Backend service indicates request will be processed */
3456 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3457 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3461 Z_DiagRecs *diagRecs =
3462 zget_DiagRecs(assoc->encode, esrequest.errcode,
3463 esrequest.errstring);
3464 /* Backend indicates error, request will not be processed */
3465 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3466 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3467 resp->num_diagnostics = diagRecs->num_diagRecs;
3468 resp->diagnostics = diagRecs->diagRecs;
3471 WRBUF wr = wrbuf_alloc();
3472 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3473 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3478 /* Do something with the members of bend_extendedservice */
3479 if (esrequest.taskPackage)
3481 resp->taskPackage = z_ext_record_oid(
3482 assoc->encode, yaz_oid_recsyn_extended,
3483 (const char *) esrequest.taskPackage, -1);
3485 yaz_log(YLOG_DEBUG,"Send the result apdu");
3489 int bend_assoc_is_alive(bend_association assoc)
3491 if (assoc->state == ASSOC_DEAD)
3492 return 0; /* already marked as dead. Don't check I/O chan anymore */
3494 return iochan_is_alive(assoc->client_chan);
3501 * c-file-style: "Stroustrup"
3502 * indent-tabs-mode: nil
3504 * vim: shiftwidth=4 tabstop=8 expandtab