1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2012 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 && rr->len > 0)
643 { /* post conversion must take place .. */
644 WRBUF output_record = wrbuf_alloc();
645 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
648 const char *details = yaz_record_conv_get_error(rc);
649 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
651 rr->errstring = odr_strdup(rr->stream, details);
655 rr->len = wrbuf_len(output_record);
656 rr->record = (char *) odr_malloc(rr->stream, rr->len);
657 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
659 wrbuf_destroy(output_record);
662 rr->output_format = match_syntax;
664 rr->schema = odr_strdup(rr->stream, match_schema);
666 (*assoc->init->bend_fetch)(assoc->backend, rr);
671 static int srw_bend_fetch(association *assoc, int pos,
672 Z_SRW_searchRetrieveRequest *srw_req,
673 Z_SRW_record *record,
674 const char **addinfo)
677 ODR o = assoc->encode;
679 rr.setname = "default";
682 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
684 rr.comp = (Z_RecordComposition *)
685 odr_malloc(assoc->decode, sizeof(*rr.comp));
686 rr.comp->which = Z_RecordComp_complex;
687 rr.comp->u.complex = (Z_CompSpec *)
688 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
689 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
690 odr_malloc(assoc->encode, sizeof(bool_t));
691 *rr.comp->u.complex->selectAlternativeSyntax = 0;
692 rr.comp->u.complex->num_dbSpecific = 0;
693 rr.comp->u.complex->dbSpecific = 0;
694 rr.comp->u.complex->num_recordSyntax = 0;
695 rr.comp->u.complex->recordSyntax = 0;
697 rr.comp->u.complex->generic = (Z_Specification *)
698 odr_malloc(assoc->decode, sizeof(Z_Specification));
700 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
701 rr.comp->u.complex->generic->which = Z_Schema_uri;
702 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
704 /* ESN = recordSchema if recordSchema is present */
705 rr.comp->u.complex->generic->elementSpec = 0;
706 if (srw_req->recordSchema)
708 rr.comp->u.complex->generic->elementSpec =
709 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
710 rr.comp->u.complex->generic->elementSpec->which =
711 Z_ElementSpec_elementSetName;
712 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
713 srw_req->recordSchema;
716 rr.stream = assoc->encode;
717 rr.print = assoc->print;
725 rr.surrogate_flag = 0;
726 rr.schema = srw_req->recordSchema;
728 if (!assoc->init->bend_fetch)
731 retrieve_fetch(assoc, &rr);
733 if (rr.errcode && rr.surrogate_flag)
735 int code = yaz_diag_bib1_to_srw(rr.errcode);
736 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
739 else if (rr.len >= 0)
741 record->recordData_buf = rr.record;
742 record->recordData_len = rr.len;
743 record->recordPosition = odr_intdup(o, pos);
744 record->recordSchema = odr_strdup_null(
745 o, rr.schema ? rr.schema : srw_req->recordSchema);
749 *addinfo = rr.errstring;
755 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
756 Z_Query *query_result, char **sortkeys_p)
758 /* have a CQL query and CQL to PQF transform .. */
759 CQL_parser cp = cql_parser_create();
766 r = cql_parser_string(cp, cql);
769 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
773 struct cql_node *cn = cql_parser_result(cp);
776 r = cql_transform_buf(ct, cn, rpn_buf, sizeof(rpn_buf)-1);
778 srw_errcode = cql_transform_error(ct, &add);
782 int r = cql_sortby_to_sortkeys_buf(cn, out, sizeof(out)-1);
787 yaz_log(log_requestdetail, "srw_sortKeys '%s'", out);
788 *sortkeys_p = odr_strdup(odr, out);
792 yaz_log(log_requestdetail, "failed to create srw_sortKeys");
793 srw_errcode = YAZ_SRW_UNSUPP_SORT_TYPE;
799 /* Syntax & transform OK. */
800 /* Convert PQF string to Z39.50 to RPN query struct */
801 YAZ_PQF_Parser pp = yaz_pqf_create();
802 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
807 int code = yaz_pqf_error(pp, &pqf_msg, &off);
808 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
810 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
814 query_result->which = Z_Query_type_1;
815 query_result->u.type_1 = rpnquery;
819 cql_parser_destroy(cp);
823 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
824 Z_AttributesPlusTerm *result)
829 int srw_error = cql2pqf(odr, cql, ct, &query, &sortkeys);
832 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
833 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
834 rpn = query.u.type_1;
835 if (!rpn->RPNStructure)
836 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
837 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
838 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
839 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
840 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
841 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
847 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
848 bend_search_rr *bsrr)
851 struct ccl_rpn_node *node;
854 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
855 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0)
857 bsrr->errstring = (char*) ccl_err_msg(errcode);
858 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
861 bsrr->query->which = Z_Query_type_1;
862 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
866 static void srw_bend_search(association *assoc,
871 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
874 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
877 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
878 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
879 if (srw_res->num_diagnostics == 0 && assoc->init)
882 rr.setname = "default";
885 rr.basenames = &srw_req->database;
889 rr.srw_setnameIdleTime = 0;
890 rr.estimated_hit_count = 0;
891 rr.partial_resultset = 0;
892 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
893 rr.query->u.type_1 = 0;
894 rr.extra_args = sr->extra_args;
895 rr.extra_response_data = 0;
897 if (srw_req->query_type == Z_SRW_query_type_cql)
899 if (assoc->server && assoc->server->cql_transform)
901 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
902 assoc->server->cql_transform,
908 yaz_add_srw_diagnostic(assoc->encode,
909 &srw_res->diagnostics,
910 &srw_res->num_diagnostics,
916 /* CQL query to backend. Wrap it - Z39.50 style */
917 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
918 ext->direct_reference = odr_getoidbystr(assoc->decode,
919 "1.2.840.10003.16.2");
920 ext->indirect_reference = 0;
922 ext->which = Z_External_CQL;
923 ext->u.cql = srw_req->query.cql;
925 rr.query->which = Z_Query_type_104;
926 rr.query->u.type_104 = ext;
929 else if (srw_req->query_type == Z_SRW_query_type_pqf)
931 Z_RPNQuery *RPNquery;
932 YAZ_PQF_Parser pqf_parser;
934 pqf_parser = yaz_pqf_create();
936 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
942 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
943 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
944 code, pqf_msg, (long) off);
945 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
948 rr.query->which = Z_Query_type_1;
949 rr.query->u.type_1 = RPNquery;
951 yaz_pqf_destroy(pqf_parser);
955 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
956 &srw_res->num_diagnostics,
957 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
959 if (rr.query->u.type_1)
961 rr.stream = assoc->encode;
962 rr.decode = assoc->decode;
963 rr.print = assoc->print;
964 if (srw_req->sort.sortKeys)
965 rr.srw_sortKeys = odr_strdup(assoc->encode,
966 srw_req->sort.sortKeys);
967 rr.association = assoc;
973 yaz_log_zquery_level(log_requestdetail,rr.query);
975 (assoc->init->bend_search)(assoc->backend, &rr);
978 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
984 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
985 yaz_add_srw_diagnostic(assoc->encode,
986 &srw_res->diagnostics,
987 &srw_res->num_diagnostics,
988 srw_error, rr.errstring);
993 int number = srw_req->maximumRecords ?
994 odr_int_to_int(*srw_req->maximumRecords) : 0;
995 int start = srw_req->startRecord ?
996 odr_int_to_int(*srw_req->startRecord) : 1;
998 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
1000 start, number, rr.hits);
1002 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1005 srw_res->resultSetId =
1006 odr_strdup(assoc->encode, rr.srw_setname );
1007 srw_res->resultSetIdleTime =
1008 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1011 if (start > rr.hits || start < 1)
1013 /* if hits<=0 and start=1 we don't return a diagnostic */
1015 yaz_add_srw_diagnostic(
1017 &srw_res->diagnostics, &srw_res->num_diagnostics,
1018 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1020 else if (number > 0)
1024 if (start + number > rr.hits)
1025 number = odr_int_to_int(rr.hits) - start + 1;
1027 /* Call bend_present if defined */
1028 if (assoc->init->bend_present)
1030 bend_present_rr *bprr = (bend_present_rr*)
1031 odr_malloc(assoc->decode, sizeof(*bprr));
1032 bprr->setname = "default";
1033 bprr->start = start;
1034 bprr->number = number;
1035 if (srw_req->recordSchema)
1037 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1038 sizeof(*bprr->comp));
1039 bprr->comp->which = Z_RecordComp_simple;
1040 bprr->comp->u.simple = (Z_ElementSetNames *)
1041 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1042 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1043 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1049 bprr->stream = assoc->encode;
1050 bprr->referenceId = 0;
1051 bprr->print = assoc->print;
1052 bprr->association = assoc;
1054 bprr->errstring = NULL;
1055 (*assoc->init->bend_present)(assoc->backend, bprr);
1059 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1060 yaz_add_srw_diagnostic(assoc->encode,
1061 &srw_res->diagnostics,
1062 &srw_res->num_diagnostics,
1063 srw_error, bprr->errstring);
1071 int packing = Z_SRW_recordPacking_string;
1072 if (srw_req->recordPacking)
1075 yaz_srw_str_to_pack(srw_req->recordPacking);
1077 packing = Z_SRW_recordPacking_string;
1079 srw_res->records = (Z_SRW_record *)
1080 odr_malloc(assoc->encode,
1081 number * sizeof(*srw_res->records));
1083 srw_res->extra_records = (Z_SRW_extra_record **)
1084 odr_malloc(assoc->encode,
1085 number*sizeof(*srw_res->extra_records));
1087 for (i = 0; i<number; i++)
1090 const char *addinfo = 0;
1092 srw_res->records[j].recordPacking = packing;
1093 srw_res->records[j].recordData_buf = 0;
1094 srw_res->extra_records[j] = 0;
1095 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1096 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1097 srw_res->records + j,
1101 yaz_add_srw_diagnostic(assoc->encode,
1102 &srw_res->diagnostics,
1103 &srw_res->num_diagnostics,
1104 yaz_diag_bib1_to_srw(errcode),
1109 if (srw_res->records[j].recordData_buf)
1112 srw_res->num_records = j;
1114 srw_res->records = 0;
1117 if (rr.extra_response_data)
1119 res->extraResponseData_buf = rr.extra_response_data;
1120 res->extraResponseData_len = strlen(rr.extra_response_data);
1122 if (rr.estimated_hit_count || rr.partial_resultset)
1124 yaz_add_srw_diagnostic(
1126 &srw_res->diagnostics,
1127 &srw_res->num_diagnostics,
1128 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1136 const char *querystr = "?";
1137 const char *querytype = "?";
1138 WRBUF wr = wrbuf_alloc();
1140 switch (srw_req->query_type)
1142 case Z_SRW_query_type_cql:
1144 querystr = srw_req->query.cql;
1146 case Z_SRW_query_type_pqf:
1148 querystr = srw_req->query.pqf;
1151 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1152 if (srw_res->num_diagnostics)
1153 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1154 else if (*http_code != 200)
1155 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1156 else if (srw_res->numberOfRecords)
1158 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1159 (srw_res->numberOfRecords ?
1160 *srw_res->numberOfRecords : 0));
1162 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+%d",
1163 (srw_res->resultSetId ?
1164 srw_res->resultSetId : "-"),
1165 (srw_req->startRecord ? *srw_req->startRecord : 1),
1166 srw_res->num_records);
1167 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1172 static char *srw_bend_explain_default(bend_explain_rr *rr)
1175 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1178 for (ptr = ptr->children; ptr; ptr = ptr->next)
1180 if (ptr->type != XML_ELEMENT_NODE)
1182 if (!strcmp((const char *) ptr->name, "explain"))
1185 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1189 ptr = xmlCopyNode(ptr, 1);
1191 xmlDocSetRootElement(doc, ptr);
1193 xmlDocDumpMemory(doc, &buf_out, &len);
1194 content = (char*) odr_malloc(rr->stream, 1+len);
1195 memcpy(content, buf_out, len);
1196 content[len] = '\0';
1200 rr->explain_buf = content;
1208 static void srw_bend_explain(association *assoc,
1210 Z_SRW_explainResponse *srw_res,
1213 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1214 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1216 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1221 rr.stream = assoc->encode;
1222 rr.decode = assoc->decode;
1223 rr.print = assoc->print;
1225 rr.database = srw_req->database;
1227 rr.server_node_ptr = assoc->server->server_node_ptr;
1229 rr.server_node_ptr = 0;
1230 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1231 if (assoc->init->bend_explain)
1232 (*assoc->init->bend_explain)(assoc->backend, &rr);
1234 srw_bend_explain_default(&rr);
1238 int packing = Z_SRW_recordPacking_string;
1239 if (srw_req->recordPacking)
1242 yaz_srw_str_to_pack(srw_req->recordPacking);
1244 packing = Z_SRW_recordPacking_string;
1246 srw_res->record.recordSchema = rr.schema;
1247 srw_res->record.recordPacking = packing;
1248 srw_res->record.recordData_buf = rr.explain_buf;
1249 srw_res->record.recordData_len = strlen(rr.explain_buf);
1250 srw_res->record.recordPosition = 0;
1256 static void srw_bend_scan(association *assoc,
1258 Z_SRW_scanResponse *srw_res,
1261 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1262 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1265 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1266 if (srw_res->num_diagnostics == 0 && assoc->init)
1269 struct scan_entry *save_entries;
1271 bend_scan_rr *bsrr = (bend_scan_rr *)
1272 odr_malloc(assoc->encode, sizeof(*bsrr));
1273 bsrr->num_bases = 1;
1274 bsrr->basenames = &srw_req->database;
1276 bsrr->num_entries = srw_req->maximumTerms ?
1277 odr_int_to_int(*srw_req->maximumTerms) : 10;
1278 bsrr->term_position = srw_req->responsePosition ?
1279 odr_int_to_int(*srw_req->responsePosition) : 1;
1282 bsrr->errstring = 0;
1283 bsrr->referenceId = 0;
1284 bsrr->stream = assoc->encode;
1285 bsrr->print = assoc->print;
1286 bsrr->step_size = &step_size;
1290 if (bsrr->num_entries > 0)
1293 bsrr->entries = (struct scan_entry *)
1294 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1296 for (i = 0; i<bsrr->num_entries; i++)
1298 bsrr->entries[i].term = 0;
1299 bsrr->entries[i].occurrences = 0;
1300 bsrr->entries[i].errcode = 0;
1301 bsrr->entries[i].errstring = 0;
1302 bsrr->entries[i].display_term = 0;
1305 save_entries = bsrr->entries; /* save it so we can compare later */
1307 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1308 assoc->init->bend_scan)
1310 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1312 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1313 &bsrr->attributeset,
1314 srw_req->scanClause.pqf);
1315 yaz_pqf_destroy(pqf_parser);
1316 bsrr->scanClause = 0;
1317 ((int (*)(void *, bend_scan_rr *))
1318 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1320 else if (srw_req->query_type == Z_SRW_query_type_cql
1321 && assoc->init->bend_scan && assoc->server
1322 && assoc->server->cql_transform)
1325 bsrr->scanClause = 0;
1326 bsrr->attributeset = 0;
1327 bsrr->term = (Z_AttributesPlusTerm *)
1328 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1329 srw_error = cql2pqf_scan(assoc->encode,
1330 srw_req->scanClause.cql,
1331 assoc->server->cql_transform,
1334 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1335 &srw_res->num_diagnostics,
1339 ((int (*)(void *, bend_scan_rr *))
1340 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1343 else if (srw_req->query_type == Z_SRW_query_type_cql
1344 && assoc->init->bend_srw_scan)
1347 bsrr->attributeset = 0;
1348 bsrr->scanClause = srw_req->scanClause.cql;
1349 ((int (*)(void *, bend_scan_rr *))
1350 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1354 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1355 &srw_res->num_diagnostics,
1356 YAZ_SRW_UNSUPP_OPERATION, "scan");
1361 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1366 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1368 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1369 &srw_res->num_diagnostics,
1370 srw_error, bsrr->errstring);
1372 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1375 srw_res->terms = (Z_SRW_scanTerm*)
1376 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1379 srw_res->num_terms = bsrr->num_entries;
1380 for (i = 0; i<bsrr->num_entries; i++)
1382 Z_SRW_scanTerm *t = srw_res->terms + i;
1383 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1384 t->numberOfRecords =
1385 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1387 if (save_entries == bsrr->entries &&
1388 bsrr->entries[i].display_term)
1390 /* the entries was _not_ set by the handler. So it's
1391 safe to test for new member display_term. It is
1394 t->displayTerm = odr_strdup(assoc->encode,
1395 bsrr->entries[i].display_term);
1403 WRBUF wr = wrbuf_alloc();
1404 const char *querytype = 0;
1405 const char *querystr = 0;
1407 switch(srw_req->query_type)
1409 case Z_SRW_query_type_pqf:
1411 querystr = srw_req->scanClause.pqf;
1413 case Z_SRW_query_type_cql:
1415 querystr = srw_req->scanClause.cql;
1418 querytype = "UNKNOWN";
1422 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1424 if (srw_res->num_diagnostics)
1425 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1426 else if (srw_res->num_terms)
1427 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1429 wrbuf_printf(wr, "OK - - ");
1431 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1432 (srw_req->responsePosition ?
1433 *srw_req->responsePosition : 1),
1434 (srw_req->maximumTerms ?
1435 *srw_req->maximumTerms : 1));
1436 /* there is no step size in SRU/W ??? */
1437 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1438 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1444 static void srw_bend_update(association *assoc,
1446 Z_SRW_updateResponse *srw_res,
1449 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1450 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1451 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1453 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1457 Z_SRW_extra_record *extra = srw_req->extra_record;
1459 rr.stream = assoc->encode;
1460 rr.print = assoc->print;
1462 rr.basenames = &srw_req->database;
1463 rr.operation = srw_req->operation;
1464 rr.operation_status = "failed";
1466 rr.record_versions = 0;
1467 rr.num_versions = 0;
1468 rr.record_packing = "string";
1469 rr.record_schema = 0;
1471 rr.extra_record_data = 0;
1472 rr.extra_request_data = 0;
1473 rr.extra_response_data = 0;
1479 if (rr.operation == 0)
1481 yaz_add_sru_update_diagnostic(
1482 assoc->encode, &srw_res->diagnostics,
1483 &srw_res->num_diagnostics,
1484 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1488 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1489 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1490 if (!strcmp( rr.operation, "delete"))
1492 if (srw_req->record && !srw_req->record->recordSchema)
1494 rr.record_schema = odr_strdup(
1496 srw_req->record->recordSchema);
1498 if (srw_req->record)
1500 rr.record_data = odr_strdupn(
1502 srw_req->record->recordData_buf,
1503 srw_req->record->recordData_len );
1505 if (extra && extra->extraRecordData_len)
1507 rr.extra_record_data = odr_strdupn(
1509 extra->extraRecordData_buf,
1510 extra->extraRecordData_len );
1512 if (srw_req->recordId)
1513 rr.record_id = srw_req->recordId;
1514 else if (extra && extra->recordIdentifier)
1515 rr.record_id = extra->recordIdentifier;
1517 else if (!strcmp(rr.operation, "replace"))
1519 if (srw_req->recordId)
1520 rr.record_id = srw_req->recordId;
1521 else if (extra && extra->recordIdentifier)
1522 rr.record_id = extra->recordIdentifier;
1525 yaz_add_sru_update_diagnostic(
1526 assoc->encode, &srw_res->diagnostics,
1527 &srw_res->num_diagnostics,
1528 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1529 "recordIdentifier");
1531 if (!srw_req->record)
1533 yaz_add_sru_update_diagnostic(
1534 assoc->encode, &srw_res->diagnostics,
1535 &srw_res->num_diagnostics,
1536 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1541 if (srw_req->record->recordSchema)
1542 rr.record_schema = odr_strdup(
1543 assoc->encode, srw_req->record->recordSchema);
1544 if (srw_req->record->recordData_len )
1546 rr.record_data = odr_strdupn(assoc->encode,
1547 srw_req->record->recordData_buf,
1548 srw_req->record->recordData_len );
1552 yaz_add_sru_update_diagnostic(
1553 assoc->encode, &srw_res->diagnostics,
1554 &srw_res->num_diagnostics,
1555 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1559 if (extra && extra->extraRecordData_len)
1561 rr.extra_record_data = odr_strdupn(
1563 extra->extraRecordData_buf,
1564 extra->extraRecordData_len );
1567 else if (!strcmp(rr.operation, "insert"))
1569 if (srw_req->recordId)
1570 rr.record_id = srw_req->recordId;
1572 rr.record_id = extra->recordIdentifier;
1574 if (srw_req->record)
1576 if (srw_req->record->recordSchema)
1577 rr.record_schema = odr_strdup(
1578 assoc->encode, srw_req->record->recordSchema);
1580 if (srw_req->record->recordData_len)
1581 rr.record_data = odr_strdupn(
1583 srw_req->record->recordData_buf,
1584 srw_req->record->recordData_len );
1586 if (extra && extra->extraRecordData_len)
1588 rr.extra_record_data = odr_strdupn(
1590 extra->extraRecordData_buf,
1591 extra->extraRecordData_len );
1595 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1596 &srw_res->num_diagnostics,
1597 YAZ_SRU_UPDATE_INVALID_ACTION,
1600 if (srw_req->record)
1602 const char *pack_str =
1603 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1605 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1608 if (srw_req->num_recordVersions)
1610 rr.record_versions = srw_req->recordVersions;
1611 rr.num_versions = srw_req->num_recordVersions;
1613 if (srw_req->extraRequestData_len)
1615 rr.extra_request_data = odr_strdupn(assoc->encode,
1616 srw_req->extraRequestData_buf,
1617 srw_req->extraRequestData_len );
1619 if (srw_res->num_diagnostics == 0)
1621 if ( assoc->init->bend_srw_update)
1622 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1624 yaz_add_sru_update_diagnostic(
1625 assoc->encode, &srw_res->diagnostics,
1626 &srw_res->num_diagnostics,
1627 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1628 "No Update backend handler");
1632 yaz_add_srw_diagnostic_uri(assoc->encode,
1633 &srw_res->diagnostics,
1634 &srw_res->num_diagnostics,
1638 srw_res->recordId = rr.record_id;
1639 srw_res->operationStatus = rr.operation_status;
1640 srw_res->recordVersions = rr.record_versions;
1641 srw_res->num_recordVersions = rr.num_versions;
1642 if (srw_res->extraResponseData_len)
1644 srw_res->extraResponseData_buf = rr.extra_response_data;
1645 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1647 if (srw_res->num_diagnostics == 0 && rr.record_data)
1649 srw_res->record = yaz_srw_get_record(assoc->encode);
1650 srw_res->record->recordSchema = rr.record_schema;
1651 if (rr.record_packing)
1653 int pack = yaz_srw_str_to_pack(rr.record_packing);
1657 pack = Z_SRW_recordPacking_string;
1658 yaz_log(YLOG_WARN, "Back packing %s from backend",
1661 srw_res->record->recordPacking = pack;
1663 srw_res->record->recordData_buf = rr.record_data;
1664 srw_res->record->recordData_len = strlen(rr.record_data);
1665 if (rr.extra_record_data)
1667 Z_SRW_extra_record *ex =
1668 yaz_srw_get_extra_record(assoc->encode);
1669 srw_res->extra_record = ex;
1670 ex->extraRecordData_buf = rr.extra_record_data;
1671 ex->extraRecordData_len = strlen(rr.extra_record_data);
1677 /* check if path is OK (1); BAD (0) */
1678 static int check_path(const char *path)
1682 if (strstr(path, ".."))
1687 static char *read_file(const char *fname, ODR o, size_t *sz)
1690 FILE *inf = fopen(fname, "rb");
1694 fseek(inf, 0L, SEEK_END);
1697 buf = (char *) odr_malloc(o, *sz);
1698 if (fread(buf, 1, *sz, inf) != *sz)
1699 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1704 static void process_http_request(association *assoc, request *req)
1706 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1707 ODR o = assoc->encode;
1708 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1710 Z_SOAP *soap_package = 0;
1713 Z_HTTP_Response *hres = 0;
1715 const char *stylesheet = 0; /* for now .. set later */
1716 Z_SRW_diagnostic *diagnostic = 0;
1717 int num_diagnostic = 0;
1718 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1720 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1721 if (!control_association(assoc, host, 0))
1723 p = z_get_HTTP_Response(o, 404);
1726 if (r == 2 && assoc->server && assoc->server->docpath
1727 && hreq->path[0] == '/'
1729 /* check if path is a proper prefix of documentroot */
1730 strncmp(hreq->path+1, assoc->server->docpath,
1731 strlen(assoc->server->docpath))
1734 if (!check_path(hreq->path))
1736 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1737 p = z_get_HTTP_Response(o, 404);
1741 size_t content_size = 0;
1742 char *content_buf = read_file(hreq->path+1, o, &content_size);
1745 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1746 p = z_get_HTTP_Response(o, 404);
1750 const char *ctype = 0;
1751 yaz_mime_types types = yaz_mime_types_create();
1753 yaz_mime_types_add(types, "xsl", "application/xml");
1754 yaz_mime_types_add(types, "xml", "application/xml");
1755 yaz_mime_types_add(types, "css", "text/css");
1756 yaz_mime_types_add(types, "html", "text/html");
1757 yaz_mime_types_add(types, "htm", "text/html");
1758 yaz_mime_types_add(types, "txt", "text/plain");
1759 yaz_mime_types_add(types, "js", "application/x-javascript");
1761 yaz_mime_types_add(types, "gif", "image/gif");
1762 yaz_mime_types_add(types, "png", "image/png");
1763 yaz_mime_types_add(types, "jpg", "image/jpeg");
1764 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1766 ctype = yaz_mime_lookup_fname(types, hreq->path);
1769 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1770 p = z_get_HTTP_Response(o, 404);
1774 p = z_get_HTTP_Response(o, 200);
1775 hres = p->u.HTTP_Response;
1776 hres->content_buf = content_buf;
1777 hres->content_len = content_size;
1778 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1780 yaz_mime_types_destroy(types);
1788 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1789 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1791 if (r == 2) /* not taken */
1793 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1794 &diagnostic, &num_diagnostic);
1795 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1797 if (r == 0) /* decode SRW/SRU OK .. */
1799 int http_code = 200;
1800 if (sr->which == Z_SRW_searchRetrieve_request)
1803 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1805 stylesheet = sr->u.request->stylesheet;
1808 res->u.response->diagnostics = diagnostic;
1809 res->u.response->num_diagnostics = num_diagnostic;
1813 srw_bend_search(assoc, sr, res, &http_code);
1815 if (http_code == 200)
1816 soap_package->u.generic->p = res;
1818 else if (sr->which == Z_SRW_explain_request)
1820 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1822 stylesheet = sr->u.explain_request->stylesheet;
1825 res->u.explain_response->diagnostics = diagnostic;
1826 res->u.explain_response->num_diagnostics = num_diagnostic;
1828 srw_bend_explain(assoc, sr, res->u.explain_response, &http_code);
1829 if (http_code == 200)
1830 soap_package->u.generic->p = res;
1832 else if (sr->which == Z_SRW_scan_request)
1834 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1836 stylesheet = sr->u.scan_request->stylesheet;
1839 res->u.scan_response->diagnostics = diagnostic;
1840 res->u.scan_response->num_diagnostics = num_diagnostic;
1842 srw_bend_scan(assoc, sr, res->u.scan_response, &http_code);
1843 if (http_code == 200)
1844 soap_package->u.generic->p = res;
1846 else if (sr->which == Z_SRW_update_request)
1848 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1850 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1853 res->u.update_response->diagnostics = diagnostic;
1854 res->u.update_response->num_diagnostics = num_diagnostic;
1856 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1857 srw_bend_update(assoc, sr, res->u.update_response, &http_code);
1858 if (http_code == 200)
1859 soap_package->u.generic->p = res;
1863 yaz_log(log_request, "SOAP ERROR");
1864 /* FIXME - what error, what query */
1866 z_soap_error(assoc->encode, soap_package,
1867 "SOAP-ENV:Client", "Bad method", 0);
1869 if (http_code == 200 || http_code == 500)
1871 static Z_SOAP_Handler soap_handlers[4] = {
1873 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1874 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1875 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1880 p = z_get_HTTP_Response(o, 200);
1881 hres = p->u.HTTP_Response;
1883 if (!stylesheet && assoc->server)
1884 stylesheet = assoc->server->stylesheet;
1886 /* empty stylesheet means NO stylesheet */
1887 if (stylesheet && *stylesheet == '\0')
1890 z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1891 &hres->content_buf, &hres->content_len,
1892 soap_handlers, charset, stylesheet);
1893 hres->code = http_code;
1895 strcpy(ctype, "text/xml");
1896 if (charset && strlen(charset) < sizeof(ctype)-30)
1898 strcat(ctype, "; charset=");
1899 strcat(ctype, charset);
1901 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1904 p = z_get_HTTP_Response(o, http_code);
1908 p = z_get_HTTP_Response(o, 500);
1909 hres = p->u.HTTP_Response;
1910 if (!strcmp(hreq->version, "1.0"))
1912 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1913 if (v && !strcmp(v, "Keep-Alive"))
1917 hres->version = "1.0";
1921 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1922 if (v && !strcmp(v, "close"))
1926 hres->version = "1.1";
1928 if (!keepalive || !assoc->last_control->keepalive)
1930 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1931 assoc->state = ASSOC_DEAD;
1932 assoc->cs_get_mask = 0;
1937 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1939 if (alive && yaz_isdigit(*(const unsigned char *) alive))
1943 if (t < 0 || t > 3600)
1945 iochan_settimeout(assoc->client_chan,t);
1946 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1948 process_gdu_response(assoc, req, p);
1951 static void process_gdu_request(association *assoc, request *req)
1953 if (req->gdu_request->which == Z_GDU_Z3950)
1956 req->apdu_request = req->gdu_request->u.z3950;
1957 if (process_z_request(assoc, req, &msg) < 0)
1958 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1960 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1961 process_http_request(assoc, req);
1964 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1969 * Initiate request processing.
1971 static int process_z_request(association *assoc, request *req, char **msg)
1976 *msg = "Unknown Error";
1977 assert(req && req->state == REQUEST_IDLE);
1978 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1980 *msg = "Missing InitRequest";
1983 switch (req->apdu_request->which)
1985 case Z_APDU_initRequest:
1986 res = process_initRequest(assoc, req); break;
1987 case Z_APDU_searchRequest:
1988 res = process_searchRequest(assoc, req); break;
1989 case Z_APDU_presentRequest:
1990 res = process_presentRequest(assoc, req); break;
1991 case Z_APDU_scanRequest:
1992 if (assoc->init->bend_scan)
1993 res = process_scanRequest(assoc, req);
1996 *msg = "Cannot handle Scan APDU";
2000 case Z_APDU_extendedServicesRequest:
2001 if (assoc->init->bend_esrequest)
2002 res = process_ESRequest(assoc, req);
2005 *msg = "Cannot handle Extended Services APDU";
2009 case Z_APDU_sortRequest:
2010 if (assoc->init->bend_sort)
2011 res = process_sortRequest(assoc, req);
2014 *msg = "Cannot handle Sort APDU";
2019 process_close(assoc, req);
2021 case Z_APDU_deleteResultSetRequest:
2022 if (assoc->init->bend_delete)
2023 res = process_deleteRequest(assoc, req);
2026 *msg = "Cannot handle Delete APDU";
2030 case Z_APDU_segmentRequest:
2031 if (assoc->init->bend_segment)
2033 res = process_segmentRequest(assoc, req);
2037 *msg = "Cannot handle Segment APDU";
2041 case Z_APDU_triggerResourceControlRequest:
2044 *msg = "Bad APDU received";
2049 yaz_log(YLOG_DEBUG, " result immediately available");
2050 retval = process_z_response(assoc, req, res);
2054 yaz_log(YLOG_DEBUG, " result unavailable");
2061 * Encode response, and transfer the request structure to the outgoing queue.
2063 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2065 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2069 if (!z_GDU(assoc->print, &res, 0, 0))
2070 yaz_log(YLOG_WARN, "ODR print error: %s",
2071 odr_errmsg(odr_geterror(assoc->print)));
2072 odr_reset(assoc->print);
2074 if (!z_GDU(assoc->encode, &res, 0, 0))
2076 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2077 odr_errmsg(odr_geterror(assoc->decode)),
2078 odr_getelement(assoc->decode));
2081 req->response = odr_getbuf(assoc->encode, &req->len_response,
2082 &req->size_response);
2083 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2084 odr_reset(assoc->encode);
2085 req->state = REQUEST_IDLE;
2086 request_enq(&assoc->outgoing, req);
2087 /* turn the work over to the ir_session handler */
2088 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2089 assoc->cs_put_mask = EVENT_OUTPUT;
2090 /* Is there more work to be done? give that to the input handler too */
2093 req = request_head(&assoc->incoming);
2094 if (req && req->state == REQUEST_IDLE)
2096 request_deq(&assoc->incoming);
2097 process_gdu_request(assoc, req);
2106 * Encode response, and transfer the request structure to the outgoing queue.
2108 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2110 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*gres));
2111 gres->which = Z_GDU_Z3950;
2112 gres->u.z3950 = res;
2114 return process_gdu_response(assoc, req, gres);
2117 static char *get_vhost(Z_OtherInformation *otherInfo)
2119 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2123 * Handle init request.
2124 * At the moment, we don't check the options
2125 * anywhere else in the code - we just try not to do anything that would
2126 * break a naive client. We'll toss 'em into the association block when
2127 * we need them there.
2129 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2131 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2132 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2133 Z_InitResponse *resp = apdu->u.initResponse;
2134 bend_initresult *binitres;
2136 statserv_options_block *cb = 0; /* by default no control for backend */
2138 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2139 cb = statserv_getcontrol(); /* got control block for backend */
2141 if (cb && assoc->backend)
2142 (*cb->bend_close)(assoc->backend);
2144 yaz_log(log_requestdetail, "Got initRequest");
2145 if (req->implementationId)
2146 yaz_log(log_requestdetail, "Id: %s",
2147 req->implementationId);
2148 if (req->implementationName)
2149 yaz_log(log_requestdetail, "Name: %s",
2150 req->implementationName);
2151 if (req->implementationVersion)
2152 yaz_log(log_requestdetail, "Version: %s",
2153 req->implementationVersion);
2155 assoc_init_reset(assoc);
2157 assoc->init->auth = req->idAuthentication;
2158 assoc->init->referenceId = req->referenceId;
2160 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2162 Z_CharSetandLanguageNegotiation *negotiation =
2163 yaz_get_charneg_record (req->otherInfo);
2165 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2166 assoc->init->charneg_request = negotiation;
2169 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2170 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2171 assoc->init->named_result_sets = 1;
2176 if (req->implementationVersion)
2177 yaz_log(log_requestdetail, "Config: %s",
2180 iochan_settimeout(assoc->client_chan, cb->idle_timeout);
2182 /* we have a backend control block, so call that init function */
2183 if (!(binitres = (*cb->bend_init)(assoc->init)))
2185 yaz_log(YLOG_WARN, "Bad response from backend.");
2188 assoc->backend = binitres->handle;
2192 /* no backend. return error */
2193 binitres = (bend_initresult *)
2194 odr_malloc(assoc->encode, sizeof(*binitres));
2195 binitres->errstring = 0;
2196 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2197 iochan_settimeout(assoc->client_chan, 10);
2199 if ((assoc->init->bend_sort))
2200 yaz_log(YLOG_DEBUG, "Sort handler installed");
2201 if ((assoc->init->bend_search))
2202 yaz_log(YLOG_DEBUG, "Search handler installed");
2203 if ((assoc->init->bend_present))
2204 yaz_log(YLOG_DEBUG, "Present handler installed");
2205 if ((assoc->init->bend_esrequest))
2206 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2207 if ((assoc->init->bend_delete))
2208 yaz_log(YLOG_DEBUG, "Delete handler installed");
2209 if ((assoc->init->bend_scan))
2210 yaz_log(YLOG_DEBUG, "Scan handler installed");
2211 if ((assoc->init->bend_segment))
2212 yaz_log(YLOG_DEBUG, "Segment handler installed");
2214 resp->referenceId = req->referenceId;
2216 /* let's tell the client what we can do */
2217 if (ODR_MASK_GET(req->options, Z_Options_search))
2219 ODR_MASK_SET(resp->options, Z_Options_search);
2220 strcat(options, "srch");
2222 if (ODR_MASK_GET(req->options, Z_Options_present))
2224 ODR_MASK_SET(resp->options, Z_Options_present);
2225 strcat(options, " prst");
2227 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2228 assoc->init->bend_delete)
2230 ODR_MASK_SET(resp->options, Z_Options_delSet);
2231 strcat(options, " del");
2233 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2234 assoc->init->bend_esrequest)
2236 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2237 strcat(options, " extendedServices");
2239 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2240 && assoc->init->named_result_sets)
2242 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2243 strcat(options, " namedresults");
2245 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2247 ODR_MASK_SET(resp->options, Z_Options_scan);
2248 strcat(options, " scan");
2250 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2252 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2253 strcat(options, " concurrop");
2255 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2257 ODR_MASK_SET(resp->options, Z_Options_sort);
2258 strcat(options, " sort");
2261 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2263 Z_OtherInformationUnit *p0;
2265 if (!assoc->init->charneg_response)
2267 if (assoc->init->query_charset)
2269 assoc->init->charneg_response = yaz_set_response_charneg(
2270 assoc->encode, assoc->init->query_charset, 0,
2271 assoc->init->records_in_same_charset);
2275 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2278 if (assoc->init->charneg_response
2279 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2281 p0->which = Z_OtherInfo_externallyDefinedInfo;
2282 p0->information.externallyDefinedInfo =
2283 assoc->init->charneg_response;
2284 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2285 strcat(options, " negotiation");
2288 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2289 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2291 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2293 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2294 assoc->version = 1; /* 1 & 2 are equivalent */
2296 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2298 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2301 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2303 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2307 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2309 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2310 assoc->maximumRecordSize = odr_int_to_int(*req->maximumRecordSize);
2312 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2313 assoc->preferredMessageSize = odr_int_to_int(*req->preferredMessageSize);
2315 resp->preferredMessageSize =
2316 odr_intdup(assoc->encode, assoc->preferredMessageSize);
2317 resp->maximumRecordSize =
2318 odr_intdup(assoc->encode, assoc->maximumRecordSize);
2320 resp->implementationId = odr_prepend(assoc->encode,
2321 assoc->init->implementation_id,
2322 resp->implementationId);
2324 resp->implementationName = odr_prepend(assoc->encode,
2325 assoc->init->implementation_name,
2326 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2328 if (binitres->errcode)
2330 assoc->state = ASSOC_DEAD;
2331 resp->userInformationField =
2332 init_diagnostics(assoc->encode, binitres->errcode,
2333 binitres->errstring);
2337 assoc->state = ASSOC_UP;
2341 if (!req->idAuthentication)
2342 yaz_log(log_request, "Auth none");
2343 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2345 const char *open = req->idAuthentication->u.open;
2346 const char *slash = strchr(open, '/');
2352 yaz_log(log_request, "Auth open %.*s", len, open);
2354 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2356 const char *user = req->idAuthentication->u.idPass->userId;
2357 const char *group = req->idAuthentication->u.idPass->groupId;
2358 yaz_log(log_request, "Auth idPass %s %s",
2359 user ? user : "-", group ? group : "-");
2361 else if (req->idAuthentication->which
2362 == Z_IdAuthentication_anonymous)
2364 yaz_log(log_request, "Auth anonymous");
2368 yaz_log(log_request, "Auth other");
2373 WRBUF wr = wrbuf_alloc();
2374 wrbuf_printf(wr, "Init ");
2375 if (binitres->errcode)
2376 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2378 wrbuf_printf(wr, "OK -");
2379 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2380 (req->implementationId ? req->implementationId :"-"),
2381 (req->implementationName ?
2382 req->implementationName : "-"),
2383 (req->implementationVersion ?
2384 req->implementationVersion : "-")
2386 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2393 * Set the specified `errcode' and `errstring' into a UserInfo-1
2394 * external to be returned to the client in accordance with Z35.90
2395 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2396 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2398 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2400 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2401 addinfo ? " -- " : "", addinfo ? addinfo : "");
2402 return zget_init_diagnostics(odr, error, addinfo);
2406 * nonsurrogate diagnostic record.
2408 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2410 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2412 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2413 addinfo ? " -- " : "", addinfo ? addinfo : "");
2415 rec->which = Z_Records_NSD;
2416 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2422 * surrogate diagnostic.
2424 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2426 int error, const char *addinfo)
2428 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2429 addinfo ? " -- " : "", addinfo ? addinfo : "");
2430 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2433 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2434 Odr_int *num, Z_RecordComposition *comp,
2435 Odr_int *next, Odr_int *pres,
2436 Z_ReferenceId *referenceId,
2437 Odr_oid *oid, int *errcode)
2439 int recno, total_length = 0, dumped_records = 0;
2440 int toget = odr_int_to_int(*num);
2441 Z_Records *records =
2442 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2443 Z_NamePlusRecordList *reclist =
2444 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2446 records->which = Z_Records_DBOSD;
2447 records->u.databaseOrSurDiagnostics = reclist;
2448 reclist->num_records = 0;
2451 return diagrec(a, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, 0);
2452 else if (toget == 0)
2453 reclist->records = odr_nullval();
2455 reclist->records = (Z_NamePlusRecord **)
2456 odr_malloc(a->encode, sizeof(*reclist->records) * toget);
2458 *pres = Z_PresentStatus_success;
2462 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2463 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2464 a->maximumRecordSize);
2465 for (recno = odr_int_to_int(start); reclist->num_records < toget; recno++)
2468 Z_NamePlusRecord *thisrec;
2469 int this_length = 0;
2471 * we get the number of bytes allocated on the stream before any
2472 * allocation done by the backend - this should give us a reasonable
2473 * idea of the total size of the data so far.
2475 total_length = odr_total(a->encode) - dumped_records;
2481 freq.last_in_set = 0;
2482 freq.setname = setname;
2483 freq.surrogate_flag = 0;
2484 freq.number = recno;
2486 freq.request_format = oid;
2487 freq.output_format = 0;
2488 freq.stream = a->encode;
2489 freq.print = a->print;
2490 freq.referenceId = referenceId;
2493 retrieve_fetch(a, &freq);
2495 *next = freq.last_in_set ? 0 : recno + 1;
2499 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2502 *pres = Z_PresentStatus_failure;
2503 /* for 'present request out of range',
2504 set addinfo to record position if not set */
2505 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2506 freq.errstring == 0)
2508 sprintf(s, "%d", recno);
2512 *errcode = freq.errcode;
2513 return diagrec(a, freq.errcode, freq.errstring);
2515 reclist->records[reclist->num_records] =
2516 surrogatediagrec(a, freq.basename, freq.errcode,
2518 reclist->num_records++;
2521 if (freq.record == 0) /* no error and no record ? */
2523 *pres = Z_PresentStatus_partial_4;
2524 *next = 0; /* signal end-of-set and stop */
2528 this_length = freq.len;
2530 this_length = odr_total(a->encode) - total_length - dumped_records;
2531 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2532 this_length, total_length, dumped_records);
2533 if (a->preferredMessageSize > 0 &&
2534 this_length + total_length > a->preferredMessageSize)
2536 /* record is small enough, really */
2537 if (this_length <= a->preferredMessageSize && recno > start)
2539 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2540 *pres = Z_PresentStatus_partial_2;
2545 /* record can only be fetched by itself */
2546 if (this_length < a->maximumRecordSize)
2548 yaz_log(log_requestdetail, " Record > prefmsgsz");
2551 yaz_log(YLOG_DEBUG, " Dropped it");
2552 reclist->records[reclist->num_records] =
2555 YAZ_BIB1_RECORD_EXCEEDS_PREFERRED_MESSAGE_SIZE, 0);
2556 reclist->num_records++;
2557 dumped_records += this_length;
2561 else /* too big entirely */
2563 yaz_log(log_requestdetail, "Record > maxrcdsz "
2565 this_length, a->maximumRecordSize);
2566 reclist->records[reclist->num_records] =
2569 YAZ_BIB1_RECORD_EXCEEDS_MAXIMUM_RECORD_SIZE, 0);
2570 reclist->num_records++;
2571 dumped_records += this_length;
2576 if (!(thisrec = (Z_NamePlusRecord *)
2577 odr_malloc(a->encode, sizeof(*thisrec))))
2579 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2580 thisrec->which = Z_NamePlusRecord_databaseRecord;
2582 if (!freq.output_format)
2584 yaz_log(YLOG_WARN, "bend_fetch output_format not set");
2587 thisrec->u.databaseRecord = z_ext_record_oid(
2588 a->encode, freq.output_format, freq.record, freq.len);
2589 if (!thisrec->u.databaseRecord)
2591 reclist->records[reclist->num_records] = thisrec;
2592 reclist->num_records++;
2594 *num = reclist->num_records;
2598 static Z_APDU *process_searchRequest(association *assoc, request *reqb)
2600 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2601 bend_search_rr *bsrr =
2602 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2604 yaz_log(log_requestdetail, "Got SearchRequest.");
2605 bsrr->association = assoc;
2606 bsrr->referenceId = req->referenceId;
2607 bsrr->srw_sortKeys = 0;
2608 bsrr->srw_setname = 0;
2609 bsrr->srw_setnameIdleTime = 0;
2610 bsrr->estimated_hit_count = 0;
2611 bsrr->partial_resultset = 0;
2612 bsrr->extra_args = 0;
2613 bsrr->extra_response_data = 0;
2615 yaz_log(log_requestdetail, "ResultSet '%s'", req->resultSetName);
2616 if (req->databaseNames)
2619 for (i = 0; i < req->num_databaseNames; i++)
2620 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2623 yaz_log_zquery_level(log_requestdetail,req->query);
2625 if (assoc->init->bend_search)
2627 bsrr->setname = req->resultSetName;
2628 bsrr->replace_set = *req->replaceIndicator;
2629 bsrr->num_bases = req->num_databaseNames;
2630 bsrr->basenames = req->databaseNames;
2631 bsrr->query = req->query;
2632 bsrr->stream = assoc->encode;
2633 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2634 bsrr->decode = assoc->decode;
2635 bsrr->print = assoc->print;
2638 bsrr->errstring = NULL;
2639 bsrr->search_info = NULL;
2640 bsrr->search_input = req->otherInfo;
2642 if (assoc->server && assoc->server->cql_transform
2643 && req->query->which == Z_Query_type_104
2644 && req->query->u.type_104->which == Z_External_CQL)
2646 /* have a CQL query and a CQL to PQF transform .. */
2648 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2649 assoc->server->cql_transform, bsrr->query,
2650 &bsrr->srw_sortKeys);
2652 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2655 if (assoc->server && assoc->server->ccl_transform
2656 && req->query->which == Z_Query_type_2) /*CCL*/
2658 /* have a CCL query and a CCL to PQF transform .. */
2660 ccl2pqf(bsrr->stream, req->query->u.type_2,
2661 assoc->server->ccl_transform, bsrr);
2663 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2667 (assoc->init->bend_search)(assoc->backend, bsrr);
2671 /* FIXME - make a diagnostic for it */
2672 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2674 return response_searchRequest(assoc, reqb, bsrr);
2678 * Prepare a searchresponse based on the backend results. We probably want
2679 * to look at making the fetching of records nonblocking as well, but
2680 * so far, we'll keep things simple.
2681 * If bsrt is null, that means we're called in response to a communications
2682 * event, and we'll have to get the response for ourselves.
2684 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2685 bend_search_rr *bsrt)
2687 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2688 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2689 Z_SearchResponse *resp = (Z_SearchResponse *)
2690 odr_malloc(assoc->encode, sizeof(*resp));
2691 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2692 Odr_int *next = odr_intdup(assoc->encode, 0);
2693 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2694 Odr_int returnedrecs = 0;
2696 apdu->which = Z_APDU_searchResponse;
2697 apdu->u.searchResponse = resp;
2698 resp->referenceId = req->referenceId;
2699 resp->additionalSearchInfo = 0;
2700 resp->otherInfo = 0;
2703 yaz_log(YLOG_FATAL, "Bad result from backend");
2706 else if (bsrt->errcode)
2708 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2709 resp->resultCount = nulint;
2710 resp->numberOfRecordsReturned = nulint;
2711 resp->nextResultSetPosition = nulint;
2712 resp->searchStatus = odr_booldup(assoc->encode, 0);
2713 resp->resultSetStatus = none;
2714 resp->presentStatus = 0;
2718 bool_t *sr = odr_booldup(assoc->encode, 1);
2719 Odr_int *toget = odr_intdup(assoc->encode, 0);
2720 Z_RecordComposition comp, *compp = 0;
2722 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2725 resp->resultCount = &bsrt->hits;
2727 comp.which = Z_RecordComp_simple;
2728 /* how many records does the user agent want, then? */
2731 else if (bsrt->hits <= *req->smallSetUpperBound)
2733 *toget = bsrt->hits;
2734 if ((comp.u.simple = req->smallSetElementSetNames))
2737 else if (bsrt->hits < *req->largeSetLowerBound)
2739 *toget = *req->mediumSetPresentNumber;
2740 if (*toget > bsrt->hits)
2741 *toget = bsrt->hits;
2742 if ((comp.u.simple = req->mediumSetElementSetNames))
2748 if (*toget && !resp->records)
2750 Odr_int *presst = odr_intdup(assoc->encode, 0);
2751 /* Call bend_present if defined */
2752 if (assoc->init->bend_present)
2754 bend_present_rr *bprr = (bend_present_rr *)
2755 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2756 bprr->setname = req->resultSetName;
2758 bprr->number = odr_int_to_int(*toget);
2759 bprr->format = req->preferredRecordSyntax;
2761 bprr->referenceId = req->referenceId;
2762 bprr->stream = assoc->encode;
2763 bprr->print = assoc->print;
2764 bprr->association = assoc;
2766 bprr->errstring = NULL;
2767 (*assoc->init->bend_present)(assoc->backend, bprr);
2771 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2772 *resp->presentStatus = Z_PresentStatus_failure;
2777 resp->records = pack_records(
2778 assoc, req->resultSetName, 1,
2779 toget, compp, next, presst, req->referenceId,
2780 req->preferredRecordSyntax, NULL);
2783 resp->numberOfRecordsReturned = toget;
2784 returnedrecs = *toget;
2785 resp->presentStatus = presst;
2789 if (*resp->resultCount)
2791 resp->numberOfRecordsReturned = nulint;
2792 resp->presentStatus = 0;
2794 resp->nextResultSetPosition = next;
2795 resp->searchStatus = sr;
2796 resp->resultSetStatus = 0;
2797 if (bsrt->estimated_hit_count)
2799 resp->resultSetStatus = odr_intdup(assoc->encode,
2800 Z_SearchResponse_estimate);
2802 else if (bsrt->partial_resultset)
2804 resp->resultSetStatus = odr_intdup(assoc->encode,
2805 Z_SearchResponse_subset);
2808 resp->additionalSearchInfo = bsrt->search_info;
2813 WRBUF wr = wrbuf_alloc();
2815 for (i = 0 ; i < req->num_databaseNames; i++)
2818 wrbuf_printf(wr, "+");
2819 wrbuf_puts(wr, req->databaseNames[i]);
2821 wrbuf_printf(wr, " ");
2824 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2826 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2827 wrbuf_printf(wr, " %s 1+" ODR_INT_PRINTF " ",
2828 req->resultSetName, returnedrecs);
2829 yaz_query_to_wrbuf(wr, req->query);
2831 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2838 * Maybe we got a little over-friendly when we designed bend_fetch to
2839 * get only one record at a time. Some backends can optimise multiple-record
2840 * fetches, and at any rate, there is some overhead involved in
2841 * all that selecting and hopping around. Problem is, of course, that the
2842 * frontend can't know ahead of time how many records it'll need to
2843 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2844 * is downright lousy as a bulk data transfer protocol.
2846 * To start with, we'll do the fetching of records from the backend
2847 * in one operation: To save some trips in and out of the event-handler,
2848 * and to simplify the interface to pack_records. At any rate, asynch
2849 * operation is more fun in operations that have an unpredictable execution
2850 * speed - which is normally more true for search than for present.
2852 static Z_APDU *process_presentRequest(association *assoc, request *reqb)
2854 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2856 Z_PresentResponse *resp;
2861 yaz_log(log_requestdetail, "Got PresentRequest.");
2863 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2865 resp->presentStatus = odr_intdup(assoc->encode, 0);
2866 if (assoc->init->bend_present)
2868 bend_present_rr *bprr = (bend_present_rr *)
2869 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2870 bprr->setname = req->resultSetId;
2871 bprr->start = odr_int_to_int(*req->resultSetStartPoint);
2872 bprr->number = odr_int_to_int(*req->numberOfRecordsRequested);
2873 bprr->format = req->preferredRecordSyntax;
2874 bprr->comp = req->recordComposition;
2875 bprr->referenceId = req->referenceId;
2876 bprr->stream = assoc->encode;
2877 bprr->print = assoc->print;
2878 bprr->association = assoc;
2880 bprr->errstring = NULL;
2881 (*assoc->init->bend_present)(assoc->backend, bprr);
2885 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2886 *resp->presentStatus = Z_PresentStatus_failure;
2887 errcode = bprr->errcode;
2890 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2891 next = odr_intdup(assoc->encode, 0);
2892 num = odr_intdup(assoc->encode, 0);
2894 apdu->which = Z_APDU_presentResponse;
2895 apdu->u.presentResponse = resp;
2896 resp->referenceId = req->referenceId;
2897 resp->otherInfo = 0;
2901 *num = *req->numberOfRecordsRequested;
2903 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2904 num, req->recordComposition, next,
2905 resp->presentStatus,
2906 req->referenceId, req->preferredRecordSyntax,
2911 WRBUF wr = wrbuf_alloc();
2912 wrbuf_printf(wr, "Present ");
2914 if (*resp->presentStatus == Z_PresentStatus_failure)
2915 wrbuf_printf(wr, "ERROR %d ", errcode);
2916 else if (*resp->presentStatus == Z_PresentStatus_success)
2917 wrbuf_printf(wr, "OK - ");
2919 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2920 *resp->presentStatus);
2922 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2923 req->resultSetId, *req->resultSetStartPoint,
2924 *req->numberOfRecordsRequested);
2925 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2930 resp->numberOfRecordsReturned = num;
2931 resp->nextResultSetPosition = next;
2937 * Scan was implemented rather in a hurry, and with support for only the basic
2938 * elements of the service in the backend API. Suggestions are welcome.
2940 static Z_APDU *process_scanRequest(association *assoc, request *reqb)
2942 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2943 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2944 Z_ScanResponse *res = (Z_ScanResponse *)
2945 odr_malloc(assoc->encode, sizeof(*res));
2946 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2947 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2948 Z_ListEntries *ents = (Z_ListEntries *)
2949 odr_malloc(assoc->encode, sizeof(*ents));
2950 Z_DiagRecs *diagrecs_p = NULL;
2951 bend_scan_rr *bsrr = (bend_scan_rr *)
2952 odr_malloc(assoc->encode, sizeof(*bsrr));
2953 struct scan_entry *save_entries;
2956 yaz_log(log_requestdetail, "Got ScanRequest");
2958 apdu->which = Z_APDU_scanResponse;
2959 apdu->u.scanResponse = res;
2960 res->referenceId = req->referenceId;
2962 /* if step is absent, set it to 0 */
2964 step_size = odr_int_to_int(*req->stepSize);
2967 res->scanStatus = scanStatus;
2968 res->numberOfEntriesReturned = numberOfEntriesReturned;
2969 res->positionOfTerm = 0;
2970 res->entries = ents;
2971 ents->num_entries = 0;
2972 ents->entries = NULL;
2973 ents->num_nonsurrogateDiagnostics = 0;
2974 ents->nonsurrogateDiagnostics = NULL;
2975 res->attributeSet = 0;
2978 if (req->databaseNames)
2981 for (i = 0; i < req->num_databaseNames; i++)
2982 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2984 bsrr->scanClause = 0;
2986 bsrr->errstring = 0;
2987 bsrr->num_bases = req->num_databaseNames;
2988 bsrr->basenames = req->databaseNames;
2989 bsrr->num_entries = odr_int_to_int(*req->numberOfTermsRequested);
2990 bsrr->term = req->termListAndStartPoint;
2991 bsrr->referenceId = req->referenceId;
2992 bsrr->stream = assoc->encode;
2993 bsrr->print = assoc->print;
2994 bsrr->step_size = &step_size;
2995 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
2996 yaz_oid_userinfo_scan_set, 1, 0);
2998 /* For YAZ 2.0 and earlier it was the backend handler that
2999 initialized entries (member display_term did not exist)
3000 YAZ 2.0 and later sets 'entries' and initialize all members
3001 including 'display_term'. If YAZ 2.0 or later sees that
3002 entries was modified - we assume that it is an old handler and
3003 that 'display_term' is _not_ set.
3005 if (bsrr->num_entries > 0)
3008 bsrr->entries = (struct scan_entry *)
3009 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3011 for (i = 0; i<bsrr->num_entries; i++)
3013 bsrr->entries[i].term = 0;
3014 bsrr->entries[i].occurrences = 0;
3015 bsrr->entries[i].errcode = 0;
3016 bsrr->entries[i].errstring = 0;
3017 bsrr->entries[i].display_term = 0;
3020 save_entries = bsrr->entries; /* save it so we can compare later */
3022 bsrr->attributeset = req->attributeSet;
3023 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3024 bsrr->attributeset);
3025 bsrr->term_position = req->preferredPositionInResponse ?
3026 odr_int_to_int(*req->preferredPositionInResponse) : 1;
3028 ((int (*)(void *, bend_scan_rr *))
3029 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3032 diagrecs_p = zget_DiagRecs(assoc->encode,
3033 bsrr->errcode, bsrr->errstring);
3037 Z_Entry **tab = (Z_Entry **)
3038 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3040 if (bsrr->status == BEND_SCAN_PARTIAL)
3041 *scanStatus = Z_Scan_partial_5;
3043 *scanStatus = Z_Scan_success;
3044 res->stepSize = odr_intdup(assoc->encode, step_size);
3045 ents->entries = tab;
3046 ents->num_entries = bsrr->num_entries;
3047 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3049 res->positionOfTerm = odr_intdup(assoc->encode, bsrr->term_position);
3050 for (i = 0; i < bsrr->num_entries; i++)
3056 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3057 if (bsrr->entries[i].occurrences >= 0)
3059 e->which = Z_Entry_termInfo;
3060 e->u.termInfo = t = (Z_TermInfo *)
3061 odr_malloc(assoc->encode, sizeof(*t));
3062 t->suggestedAttributes = 0;
3064 if (save_entries == bsrr->entries &&
3065 bsrr->entries[i].display_term)
3067 /* the entries was _not_ set by the handler. So it's
3068 safe to test for new member display_term. It is
3071 t->displayTerm = odr_strdup(assoc->encode,
3072 bsrr->entries[i].display_term);
3074 t->alternativeTerm = 0;
3075 t->byAttributes = 0;
3076 t->otherTermInfo = 0;
3077 t->globalOccurrences = &bsrr->entries[i].occurrences;
3078 t->term = (Z_Term *)
3079 odr_malloc(assoc->encode, sizeof(*t->term));
3080 t->term->which = Z_Term_general;
3081 t->term->u.general = o =
3082 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3083 o->buf = (unsigned char *)
3084 odr_malloc(assoc->encode, o->len = o->size =
3085 strlen(bsrr->entries[i].term));
3086 memcpy(o->buf, bsrr->entries[i].term, o->len);
3087 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3088 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3092 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3093 bsrr->entries[i].errcode,
3094 bsrr->entries[i].errstring);
3095 assert(drecs->num_diagRecs == 1);
3096 e->which = Z_Entry_surrogateDiagnostic;
3097 assert(drecs->diagRecs[0]);
3098 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3104 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3105 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3110 WRBUF wr = wrbuf_alloc();
3111 wrbuf_printf(wr, "Scan ");
3112 for (i = 0 ; i < req->num_databaseNames; i++)
3115 wrbuf_printf(wr, "+");
3116 wrbuf_puts(wr, req->databaseNames[i]);
3119 wrbuf_printf(wr, " ");
3122 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3124 wrbuf_printf(wr, "OK");
3126 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3127 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3128 res->numberOfEntriesReturned ?
3129 *res->numberOfEntriesReturned : 0,
3130 (req->preferredPositionInResponse ?
3131 *req->preferredPositionInResponse : 1),
3132 *req->numberOfTermsRequested,
3133 (res->stepSize ? *res->stepSize : 1));
3136 wrbuf_printf(wr, "+%s", bsrr->setname);
3138 wrbuf_printf(wr, " ");
3139 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3140 bsrr->attributeset);
3141 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3147 static Z_APDU *process_sortRequest(association *assoc, request *reqb)
3150 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3151 Z_SortResponse *res = (Z_SortResponse *)
3152 odr_malloc(assoc->encode, sizeof(*res));
3153 bend_sort_rr *bsrr = (bend_sort_rr *)
3154 odr_malloc(assoc->encode, sizeof(*bsrr));
3156 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3158 yaz_log(log_requestdetail, "Got SortRequest.");
3160 bsrr->num_input_setnames = req->num_inputResultSetNames;
3161 for (i=0;i<req->num_inputResultSetNames;i++)
3162 yaz_log(log_requestdetail, "Input resultset: '%s'",
3163 req->inputResultSetNames[i]);
3164 bsrr->input_setnames = req->inputResultSetNames;
3165 bsrr->referenceId = req->referenceId;
3166 bsrr->output_setname = req->sortedResultSetName;
3167 yaz_log(log_requestdetail, "Output resultset: '%s'",
3168 req->sortedResultSetName);
3169 bsrr->sort_sequence = req->sortSequence;
3170 /*FIXME - dump those sequences too */
3171 bsrr->stream = assoc->encode;
3172 bsrr->print = assoc->print;
3174 bsrr->sort_status = Z_SortResponse_failure;
3176 bsrr->errstring = 0;
3178 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3180 res->referenceId = bsrr->referenceId;
3181 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3182 res->resultSetStatus = 0;
3185 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3186 bsrr->errcode, bsrr->errstring);
3187 res->diagnostics = dr->diagRecs;
3188 res->num_diagnostics = dr->num_diagRecs;
3192 res->num_diagnostics = 0;
3193 res->diagnostics = 0;
3195 res->resultCount = 0;
3198 apdu->which = Z_APDU_sortResponse;
3199 apdu->u.sortResponse = res;
3202 WRBUF wr = wrbuf_alloc();
3203 wrbuf_printf(wr, "Sort ");
3205 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3207 wrbuf_printf(wr, "OK -");
3208 wrbuf_printf(wr, " (");
3209 for (i = 0; i<req->num_inputResultSetNames; i++)
3212 wrbuf_printf(wr, "+");
3213 wrbuf_puts(wr, req->inputResultSetNames[i]);
3215 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3217 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3223 static Z_APDU *process_deleteRequest(association *assoc, request *reqb)
3226 Z_DeleteResultSetRequest *req =
3227 reqb->apdu_request->u.deleteResultSetRequest;
3228 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3229 odr_malloc(assoc->encode, sizeof(*res));
3230 bend_delete_rr *bdrr = (bend_delete_rr *)
3231 odr_malloc(assoc->encode, sizeof(*bdrr));
3232 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3234 yaz_log(log_requestdetail, "Got DeleteRequest.");
3236 bdrr->num_setnames = req->num_resultSetList;
3237 bdrr->setnames = req->resultSetList;
3238 for (i = 0; i<req->num_resultSetList; i++)
3239 yaz_log(log_requestdetail, "resultset: '%s'",
3240 req->resultSetList[i]);
3241 bdrr->stream = assoc->encode;
3242 bdrr->print = assoc->print;
3243 bdrr->function = odr_int_to_int(*req->deleteFunction);
3244 bdrr->referenceId = req->referenceId;
3246 if (bdrr->num_setnames > 0)
3248 bdrr->statuses = (int*)
3249 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3250 bdrr->num_setnames);
3251 for (i = 0; i < bdrr->num_setnames; i++)
3252 bdrr->statuses[i] = 0;
3254 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3256 res->referenceId = req->referenceId;
3258 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3260 res->deleteListStatuses = 0;
3261 if (bdrr->num_setnames > 0)
3264 res->deleteListStatuses = (Z_ListStatuses *)
3265 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3266 res->deleteListStatuses->num = bdrr->num_setnames;
3267 res->deleteListStatuses->elements =
3269 odr_malloc(assoc->encode,
3270 sizeof(*res->deleteListStatuses->elements) *
3271 bdrr->num_setnames);
3272 for (i = 0; i<bdrr->num_setnames; i++)
3274 res->deleteListStatuses->elements[i] =
3276 odr_malloc(assoc->encode,
3277 sizeof(**res->deleteListStatuses->elements));
3278 res->deleteListStatuses->elements[i]->status =
3279 odr_intdup(assoc->encode, bdrr->statuses[i]);
3280 res->deleteListStatuses->elements[i]->id =
3281 odr_strdup(assoc->encode, bdrr->setnames[i]);
3284 res->numberNotDeleted = 0;
3285 res->bulkStatuses = 0;
3286 res->deleteMessage = 0;
3289 apdu->which = Z_APDU_deleteResultSetResponse;
3290 apdu->u.deleteResultSetResponse = res;
3293 WRBUF wr = wrbuf_alloc();
3294 wrbuf_printf(wr, "Delete ");
3295 if (bdrr->delete_status)
3296 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3298 wrbuf_printf(wr, "OK -");
3299 for (i = 0; i<req->num_resultSetList; i++)
3300 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3301 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3307 static void process_close(association *assoc, request *reqb)
3309 Z_Close *req = reqb->apdu_request->u.close;
3310 static char *reasons[] =
3317 "securityViolation",
3324 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3325 reasons[*req->closeReason], req->diagnosticInformation ?
3326 req->diagnosticInformation : "NULL");
3327 if (assoc->version < 3) /* to make do_force respond with close */
3329 do_close_req(assoc, Z_Close_finished,
3330 "Association terminated by client", reqb);
3331 yaz_log(log_request,"Close OK");
3334 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3336 bend_segment_rr req;
3338 req.segment = reqb->apdu_request->u.segmentRequest;
3339 req.stream = assoc->encode;
3340 req.decode = assoc->decode;
3341 req.print = assoc->print;
3342 req.association = assoc;
3344 (*assoc->init->bend_segment)(assoc->backend, &req);
3349 static Z_APDU *process_ESRequest(association *assoc, request *reqb)
3351 bend_esrequest_rr esrequest;
3352 const char *ext_name = "unknown";
3354 Z_ExtendedServicesRequest *req =
3355 reqb->apdu_request->u.extendedServicesRequest;
3356 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3358 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3360 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3361 esrequest.stream = assoc->encode;
3362 esrequest.decode = assoc->decode;
3363 esrequest.print = assoc->print;
3364 esrequest.errcode = 0;
3365 esrequest.errstring = NULL;
3366 esrequest.association = assoc;
3367 esrequest.taskPackage = 0;
3368 esrequest.referenceId = req->referenceId;
3370 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3372 switch(esrequest.esr->taskSpecificParameters->which)
3374 case Z_External_itemOrder:
3375 ext_name = "ItemOrder"; break;
3376 case Z_External_update:
3377 ext_name = "Update"; break;
3378 case Z_External_update0:
3379 ext_name = "Update0"; break;
3380 case Z_External_ESAdmin:
3381 ext_name = "Admin"; break;
3386 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3388 resp->referenceId = req->referenceId;
3390 if (esrequest.errcode == -1)
3392 /* Backend service indicates request will be processed */
3393 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3394 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3396 else if (esrequest.errcode == 0)
3398 /* Backend service indicates request will be processed */
3399 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3400 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3404 Z_DiagRecs *diagRecs =
3405 zget_DiagRecs(assoc->encode, esrequest.errcode,
3406 esrequest.errstring);
3407 /* Backend indicates error, request will not be processed */
3408 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3409 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3410 resp->num_diagnostics = diagRecs->num_diagRecs;
3411 resp->diagnostics = diagRecs->diagRecs;
3414 WRBUF wr = wrbuf_alloc();
3415 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3416 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3421 /* Do something with the members of bend_extendedservice */
3422 if (esrequest.taskPackage)
3424 resp->taskPackage = z_ext_record_oid(
3425 assoc->encode, yaz_oid_recsyn_extended,
3426 (const char *) esrequest.taskPackage, -1);
3428 yaz_log(YLOG_DEBUG,"Send the result apdu");
3432 int bend_assoc_is_alive(bend_association assoc)
3434 if (assoc->state == ASSOC_DEAD)
3435 return 0; /* already marked as dead. Don't check I/O chan anymore */
3437 return iochan_is_alive(assoc->client_chan);
3444 * c-file-style: "Stroustrup"
3445 * indent-tabs-mode: nil
3447 * vim: shiftwidth=4 tabstop=8 expandtab