2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.116 2007-05-02 11:53:25 adam Exp $
9 * \brief Implements GFS session logic.
11 * Frontend server logic.
13 * This code receives incoming APDUs, and handles client requests by means
16 * Some of the code is getting quite involved, compared to simpler servers -
17 * primarily because it is asynchronous both in the communication with
18 * the user and the backend. We think the complexity will pay off in
19 * the form of greater flexibility when more asynchronous facilities
22 * Memory management has become somewhat involved. In the simple case, where
23 * only one PDU is pending at a time, it will simply reuse the same memory,
24 * once it has found its working size. When we enable multiple concurrent
25 * operations, perhaps even with multiple parallel calls to the backend, it
26 * will maintain a pool of buffers for encoding and decoding, trying to
27 * minimize memory allocation/deallocation during normal operation.
37 #include <sys/types.h>
45 #define S_ISREG(x) (x & _S_IFREG)
54 #include <libxml/parser.h>
55 #include <libxml/tree.h>
58 #include <yaz/yconfig.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>
80 static void process_gdu_request(association *assoc, request *req);
81 static int process_z_request(association *assoc, request *req, char **msg);
82 void backend_response(IOCHAN i, int event);
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,
90 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
91 bend_search_rr *bsrr, int *fd);
92 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
94 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
95 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
96 static void process_close(association *assoc, request *reqb);
97 void save_referenceId (request *reqb, Z_ReferenceId *refid);
98 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
100 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
102 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
104 /* dynamic logging levels */
105 static int logbits_set = 0;
106 static int log_session = 0; /* one-line logs for session */
107 static int log_sessiondetail = 0; /* more detailed stuff */
108 static int log_request = 0; /* one-line logs for requests */
109 static int log_requestdetail = 0; /* more detailed stuff */
111 /** get_logbits sets global loglevel bits */
112 static void get_logbits(void)
113 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
117 log_session = yaz_log_module_level("session");
118 log_sessiondetail = yaz_log_module_level("sessiondetail");
119 log_request = yaz_log_module_level("request");
120 log_requestdetail = yaz_log_module_level("requestdetail");
126 static void wr_diag(WRBUF w, int error, const char *addinfo)
128 wrbuf_printf(w, "ERROR %d+", error);
129 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
132 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
140 * Create and initialize a new association-handle.
141 * channel : iochannel for the current line.
142 * link : communications channel.
143 * Returns: 0 or a new association handle.
145 association *create_association(IOCHAN channel, COMSTACK link,
146 const char *apdufile)
152 if (!(anew = (association *)xmalloc(sizeof(*anew))))
156 anew->last_control = 0;
157 anew->client_chan = channel;
158 anew->client_link = link;
159 anew->cs_get_mask = 0;
160 anew->cs_put_mask = 0;
161 anew->cs_accept_mask = 0;
162 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
163 !(anew->encode = odr_createmem(ODR_ENCODE)))
165 if (apdufile && *apdufile)
169 if (!(anew->print = odr_createmem(ODR_PRINT)))
171 if (*apdufile == '@')
173 odr_setprint(anew->print, yaz_log_file());
175 else if (*apdufile != '-')
178 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
179 if (!(f = fopen(filename, "w")))
181 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
184 setvbuf(f, 0, _IONBF, 0);
185 odr_setprint(anew->print, f);
190 anew->input_buffer = 0;
191 anew->input_buffer_len = 0;
193 anew->state = ASSOC_NEW;
194 request_initq(&anew->incoming);
195 request_initq(&anew->outgoing);
196 anew->proto = cs_getproto(link);
202 * Free association and release resources.
204 void destroy_association(association *h)
206 statserv_options_block *cb = statserv_getcontrol();
210 odr_destroy(h->decode);
211 odr_destroy(h->encode);
213 odr_destroy(h->print);
215 xfree(h->input_buffer);
217 (*cb->bend_close)(h->backend);
218 while ((req = request_deq(&h->incoming)))
219 request_release(req);
220 while ((req = request_deq(&h->outgoing)))
221 request_release(req);
222 request_delq(&h->incoming);
223 request_delq(&h->outgoing);
225 xmalloc_trav("session closed");
226 if (cb && cb->one_shot)
232 static void do_close_req(association *a, int reason, char *message,
236 Z_Close *cls = zget_Close(a->encode);
238 /* Purge request queue */
239 while (request_deq(&a->incoming));
240 while (request_deq(&a->outgoing));
243 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
244 reason, message ? message : "none");
245 apdu.which = Z_APDU_close;
247 *cls->closeReason = reason;
248 cls->diagnosticInformation = message;
249 process_z_response(a, req, &apdu);
250 iochan_settimeout(a->client_chan, 20);
254 request_release(req);
255 yaz_log(log_requestdetail, "v2 client. No Close PDU");
256 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
259 a->state = ASSOC_DEAD;
262 static void do_close(association *a, int reason, char *message)
264 request *req = request_get(&a->outgoing);
265 do_close_req (a, reason, message, req);
269 int ir_read(IOCHAN h, int event)
271 association *assoc = (association *)iochan_getdata(h);
272 COMSTACK conn = assoc->client_link;
275 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
277 yaz_log(YLOG_DEBUG, "ir_session (input)");
278 /* We aren't speaking to this fellow */
279 if (assoc->state == ASSOC_DEAD)
281 yaz_log(log_sessiondetail, "Connection closed - end of session");
283 destroy_association(assoc);
287 assoc->cs_get_mask = EVENT_INPUT;
291 int res = cs_get(conn, &assoc->input_buffer,
292 &assoc->input_buffer_len);
293 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
295 yaz_log(log_session, "Connection error: %s res=%d",
296 cs_errmsg(cs_errno(conn)), res);
297 req = request_get(&assoc->incoming); /* get a new request */
298 do_close_req(assoc, Z_Close_protocolError,
299 "Incoming package too large", req);
304 yaz_log(log_session, "Connection closed by client");
305 assoc->state = ASSOC_DEAD;
308 else if (res == 1) /* incomplete read - wait for more */
310 if (conn->io_pending & CS_WANT_WRITE)
311 assoc->cs_get_mask |= EVENT_OUTPUT;
312 iochan_setflag(h, assoc->cs_get_mask);
315 /* we got a complete PDU. Let's decode it */
316 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
317 assoc->input_buffer[0] & 0xff,
318 assoc->input_buffer[1] & 0xff,
319 assoc->input_buffer[2] & 0xff);
320 req = request_get(&assoc->incoming); /* get a new request */
321 odr_reset(assoc->decode);
322 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
323 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
325 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
327 odr_errmsg(odr_geterror(assoc->decode)),
328 odr_getelement(assoc->decode),
329 (long) odr_offset(assoc->decode));
330 if (assoc->decode->error != OHTTP)
332 yaz_log(YLOG_WARN, "PDU dump:");
333 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
334 request_release(req);
335 do_close(assoc, Z_Close_protocolError, "Malformed package");
339 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
340 assoc->state = ASSOC_DEAD;
341 process_gdu_response(assoc, req, p);
345 req->request_mem = odr_extract_mem(assoc->decode);
348 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
349 yaz_log(YLOG_WARN, "ODR print error: %s",
350 odr_errmsg(odr_geterror(assoc->print)));
351 odr_reset(assoc->print);
353 request_enq(&assoc->incoming, req);
355 while (cs_more(conn));
361 * This is where PDUs from the client are read and the further
362 * processing is initiated. Flow of control moves down through the
363 * various process_* functions below, until the encoded result comes back up
364 * to the output handler in here.
366 * h : the I/O channel that has an outstanding event.
367 * event : the current outstanding event.
369 void ir_session(IOCHAN h, int event)
372 association *assoc = (association *)iochan_getdata(h);
373 COMSTACK conn = assoc->client_link;
376 assert(h && conn && assoc);
377 if (event == EVENT_TIMEOUT)
379 if (assoc->state != ASSOC_UP)
381 yaz_log(YLOG_DEBUG, "Final timeout - closing connection.");
382 /* do we need to lod this at all */
384 destroy_association(assoc);
389 yaz_log(log_sessiondetail,
390 "Session idle too long. Sending close.");
391 do_close(assoc, Z_Close_lackOfActivity, 0);
395 if (event & assoc->cs_accept_mask)
397 if (!cs_accept (conn))
399 yaz_log (YLOG_WARN, "accept failed");
400 destroy_association(assoc);
403 iochan_clearflag (h, EVENT_OUTPUT);
404 if (conn->io_pending)
405 { /* cs_accept didn't complete */
406 assoc->cs_accept_mask =
407 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
408 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
410 iochan_setflag (h, assoc->cs_accept_mask);
413 { /* cs_accept completed. Prepare for reading (cs_get) */
414 assoc->cs_accept_mask = 0;
415 assoc->cs_get_mask = EVENT_INPUT;
416 iochan_setflag (h, assoc->cs_get_mask);
420 if (event & assoc->cs_get_mask) /* input */
422 if (!ir_read(h, event))
424 req = request_head(&assoc->incoming);
425 if (req->state == REQUEST_IDLE)
427 request_deq(&assoc->incoming);
428 process_gdu_request(assoc, req);
431 if (event & assoc->cs_put_mask)
433 request *req = request_head(&assoc->outgoing);
435 assoc->cs_put_mask = 0;
436 yaz_log(YLOG_DEBUG, "ir_session (output)");
437 req->state = REQUEST_PENDING;
438 switch (res = cs_put(conn, req->response, req->len_response))
441 yaz_log(log_sessiondetail, "Connection closed by client");
443 destroy_association(assoc);
446 case 0: /* all sent - release the request structure */
447 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
449 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
452 nmem_destroy(req->request_mem);
453 request_deq(&assoc->outgoing);
454 request_release(req);
455 if (!request_head(&assoc->outgoing))
456 { /* restore mask for cs_get operation ... */
457 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
458 iochan_setflag(h, assoc->cs_get_mask);
459 if (assoc->state == ASSOC_DEAD)
460 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
464 assoc->cs_put_mask = EVENT_OUTPUT;
468 if (conn->io_pending & CS_WANT_WRITE)
469 assoc->cs_put_mask |= EVENT_OUTPUT;
470 if (conn->io_pending & CS_WANT_READ)
471 assoc->cs_put_mask |= EVENT_INPUT;
472 iochan_setflag(h, assoc->cs_put_mask);
475 if (event & EVENT_EXCEPT)
477 yaz_log(YLOG_WARN, "ir_session (exception)");
479 destroy_association(assoc);
484 static int process_z_request(association *assoc, request *req, char **msg);
487 static void assoc_init_reset(association *assoc)
490 assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
492 assoc->init->stream = assoc->encode;
493 assoc->init->print = assoc->print;
494 assoc->init->auth = 0;
495 assoc->init->referenceId = 0;
496 assoc->init->implementation_version = 0;
497 assoc->init->implementation_id = 0;
498 assoc->init->implementation_name = 0;
499 assoc->init->query_charset = 0;
500 assoc->init->bend_sort = NULL;
501 assoc->init->bend_search = NULL;
502 assoc->init->bend_present = NULL;
503 assoc->init->bend_esrequest = NULL;
504 assoc->init->bend_delete = NULL;
505 assoc->init->bend_scan = NULL;
506 assoc->init->bend_segment = NULL;
507 assoc->init->bend_fetch = NULL;
508 assoc->init->bend_explain = NULL;
509 assoc->init->bend_srw_scan = NULL;
510 assoc->init->bend_srw_update = NULL;
512 assoc->init->charneg_request = NULL;
513 assoc->init->charneg_response = NULL;
515 assoc->init->decode = assoc->decode;
516 assoc->init->peer_name =
517 odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
519 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
522 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
524 statserv_options_block *cb = statserv_getcontrol();
527 const char *encoding = "UTF-8";
529 bend_initresult *binitres;
531 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
532 assoc_init_reset(assoc);
536 Z_IdAuthentication *auth = odr_malloc(assoc->decode, sizeof(*auth));
539 len = strlen(sr->username) + 1;
541 len += strlen(sr->password) + 2;
542 auth->which = Z_IdAuthentication_open;
543 auth->u.open = 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 int *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 = 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);
667 (*assoc->init->bend_fetch)(assoc->backend, rr);
672 static int srw_bend_fetch(association *assoc, int pos,
673 Z_SRW_searchRetrieveRequest *srw_req,
674 Z_SRW_record *record,
675 const char **addinfo)
678 ODR o = assoc->encode;
680 rr.setname = "default";
683 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
685 rr.comp = (Z_RecordComposition *)
686 odr_malloc(assoc->decode, sizeof(*rr.comp));
687 rr.comp->which = Z_RecordComp_complex;
688 rr.comp->u.complex = (Z_CompSpec *)
689 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
690 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
691 odr_malloc(assoc->encode, sizeof(bool_t));
692 *rr.comp->u.complex->selectAlternativeSyntax = 0;
693 rr.comp->u.complex->num_dbSpecific = 0;
694 rr.comp->u.complex->dbSpecific = 0;
695 rr.comp->u.complex->num_recordSyntax = 0;
696 rr.comp->u.complex->recordSyntax = 0;
698 rr.comp->u.complex->generic = (Z_Specification *)
699 odr_malloc(assoc->decode, sizeof(Z_Specification));
701 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
702 rr.comp->u.complex->generic->which = Z_Schema_uri;
703 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
705 /* ESN = recordSchema if recordSchema is present */
706 rr.comp->u.complex->generic->elementSpec = 0;
707 if (srw_req->recordSchema)
709 rr.comp->u.complex->generic->elementSpec =
710 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
711 rr.comp->u.complex->generic->elementSpec->which =
712 Z_ElementSpec_elementSetName;
713 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
714 srw_req->recordSchema;
717 rr.stream = assoc->encode;
718 rr.print = assoc->print;
726 rr.surrogate_flag = 0;
727 rr.schema = srw_req->recordSchema;
729 if (!assoc->init->bend_fetch)
732 retrieve_fetch(assoc, &rr);
734 if (rr.errcode && rr.surrogate_flag)
736 int code = yaz_diag_bib1_to_srw(rr.errcode);
737 const char *message = yaz_diag_srw_str(code);
740 len += strlen(message);
742 len += strlen(rr.errstring);
744 record->recordData_buf = odr_malloc(o, len);
746 sprintf(record->recordData_buf, "<diagnostic "
747 "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
748 " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
750 sprintf(record->recordData_buf + strlen(record->recordData_buf),
751 " <details>%s</details>\n", rr.errstring);
753 sprintf(record->recordData_buf + strlen(record->recordData_buf),
754 " <message>%s</message>\n", message);
755 sprintf(record->recordData_buf + strlen(record->recordData_buf),
757 record->recordData_len = strlen(record->recordData_buf);
758 record->recordPosition = odr_intdup(o, pos);
759 record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
762 else if (rr.len >= 0)
764 record->recordData_buf = rr.record;
765 record->recordData_len = rr.len;
766 record->recordPosition = odr_intdup(o, pos);
768 record->recordSchema = odr_strdup(o, rr.schema);
770 record->recordSchema = 0;
774 *addinfo = rr.errstring;
780 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
781 Z_Query *query_result)
783 /* have a CQL query and CQL to PQF transform .. */
784 CQL_parser cp = cql_parser_create();
790 r = cql_parser_string(cp, cql);
793 /* CQL syntax error */
799 r = cql_transform_buf(ct,
800 cql_parser_result(cp),
801 rpn_buf, sizeof(rpn_buf)-1);
803 srw_errcode = cql_transform_error(ct, &add);
807 /* Syntax & transform OK. */
808 /* Convert PQF string to Z39.50 to RPN query struct */
809 YAZ_PQF_Parser pp = yaz_pqf_create();
810 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
815 int code = yaz_pqf_error(pp, &pqf_msg, &off);
816 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
822 query_result->which = Z_Query_type_1;
823 query_result->u.type_1 = rpnquery;
827 cql_parser_destroy(cp);
831 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
832 Z_AttributesPlusTerm *result)
836 int srw_error = cql2pqf(odr, cql, ct, &query);
839 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
840 return 10; /* bad query type */
841 rpn = query.u.type_1;
842 if (!rpn->RPNStructure)
843 return 10; /* must be structure */
844 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
845 return 10; /* must be simple */
846 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
847 return 10; /* must be attributes plus term node .. */
848 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
853 static void srw_bend_search(association *assoc, request *req,
855 Z_SRW_searchRetrieveResponse *srw_res,
860 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
863 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
864 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
865 if (srw_res->num_diagnostics == 0 && assoc->init)
868 rr.setname = "default";
871 rr.basenames = &srw_req->database;
875 rr.srw_setnameIdleTime = 0;
876 rr.estimated_hit_count = 0;
877 rr.partial_resultset = 0;
878 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
879 rr.query->u.type_1 = 0;
881 if (srw_req->query_type == Z_SRW_query_type_cql)
883 if (assoc->server && assoc->server->cql_transform)
885 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
886 assoc->server->cql_transform,
890 yaz_add_srw_diagnostic(assoc->encode,
891 &srw_res->diagnostics,
892 &srw_res->num_diagnostics,
898 /* CQL query to backend. Wrap it - Z39.50 style */
899 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
900 ext->direct_reference = odr_getoidbystr(assoc->decode,
901 "1.2.840.10003.16.2");
902 ext->indirect_reference = 0;
904 ext->which = Z_External_CQL;
905 ext->u.cql = srw_req->query.cql;
907 rr.query->which = Z_Query_type_104;
908 rr.query->u.type_104 = ext;
911 else if (srw_req->query_type == Z_SRW_query_type_pqf)
913 Z_RPNQuery *RPNquery;
914 YAZ_PQF_Parser pqf_parser;
916 pqf_parser = yaz_pqf_create ();
918 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
924 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
925 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
926 code, pqf_msg, (long) off);
927 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
930 rr.query->which = Z_Query_type_1;
931 rr.query->u.type_1 = RPNquery;
933 yaz_pqf_destroy (pqf_parser);
937 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
938 &srw_res->num_diagnostics,
939 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
941 if (rr.query->u.type_1)
943 rr.stream = assoc->encode;
944 rr.decode = assoc->decode;
945 rr.print = assoc->print;
947 if ( srw_req->sort.sortKeys )
948 rr.srw_sortKeys = odr_strdup(assoc->encode,
949 srw_req->sort.sortKeys );
950 rr.association = assoc;
956 yaz_log_zquery_level(log_requestdetail,rr.query);
958 (assoc->init->bend_search)(assoc->backend, &rr);
961 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
967 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
968 yaz_add_srw_diagnostic(assoc->encode,
969 &srw_res->diagnostics,
970 &srw_res->num_diagnostics,
971 srw_error, rr.errstring);
976 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
977 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
979 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
980 start, number, rr.hits);
982 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
985 srw_res->resultSetId =
986 odr_strdup(assoc->encode, rr.srw_setname );
987 srw_res->resultSetIdleTime =
988 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
991 if ((rr.hits > 0 && start > rr.hits) || start < 1)
993 yaz_add_srw_diagnostic(
995 &srw_res->diagnostics, &srw_res->num_diagnostics,
996 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1002 if (start + number > rr.hits)
1003 number = rr.hits - start + 1;
1005 /* Call bend_present if defined */
1006 if (assoc->init->bend_present)
1008 bend_present_rr *bprr = (bend_present_rr*)
1009 odr_malloc (assoc->decode, sizeof(*bprr));
1010 bprr->setname = "default";
1011 bprr->start = start;
1012 bprr->number = number;
1013 if (srw_req->recordSchema)
1015 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1016 sizeof(*bprr->comp));
1017 bprr->comp->which = Z_RecordComp_simple;
1018 bprr->comp->u.simple = (Z_ElementSetNames *)
1019 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1020 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1021 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1027 bprr->stream = assoc->encode;
1028 bprr->referenceId = 0;
1029 bprr->print = assoc->print;
1030 bprr->request = req;
1031 bprr->association = assoc;
1033 bprr->errstring = NULL;
1034 (*assoc->init->bend_present)(assoc->backend, bprr);
1040 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1041 yaz_add_srw_diagnostic(assoc->encode,
1042 &srw_res->diagnostics,
1043 &srw_res->num_diagnostics,
1044 srw_error, bprr->errstring);
1052 int packing = Z_SRW_recordPacking_string;
1053 if (srw_req->recordPacking)
1056 yaz_srw_str_to_pack(srw_req->recordPacking);
1058 packing = Z_SRW_recordPacking_string;
1060 srw_res->records = (Z_SRW_record *)
1061 odr_malloc(assoc->encode,
1062 number * sizeof(*srw_res->records));
1064 srw_res->extra_records = (Z_SRW_extra_record **)
1065 odr_malloc(assoc->encode,
1066 number*sizeof(*srw_res->extra_records));
1068 for (i = 0; i<number; i++)
1071 const char *addinfo = 0;
1073 srw_res->records[j].recordPacking = packing;
1074 srw_res->records[j].recordData_buf = 0;
1075 srw_res->extra_records[j] = 0;
1076 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1077 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1078 srw_res->records + j,
1082 yaz_add_srw_diagnostic(assoc->encode,
1083 &srw_res->diagnostics,
1084 &srw_res->num_diagnostics,
1085 yaz_diag_bib1_to_srw (errcode),
1090 if (srw_res->records[j].recordData_buf)
1093 srw_res->num_records = j;
1095 srw_res->records = 0;
1098 if (rr.estimated_hit_count || rr.partial_resultset)
1100 yaz_add_srw_diagnostic(
1102 &srw_res->diagnostics,
1103 &srw_res->num_diagnostics,
1104 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1112 const char *querystr = "?";
1113 const char *querytype = "?";
1114 WRBUF wr = wrbuf_alloc();
1116 switch (srw_req->query_type)
1118 case Z_SRW_query_type_cql:
1120 querystr = srw_req->query.cql;
1122 case Z_SRW_query_type_pqf:
1124 querystr = srw_req->query.pqf;
1127 wrbuf_printf(wr, "SRWSearch ");
1128 wrbuf_printf(wr, srw_req->database);
1129 wrbuf_printf(wr, " ");
1130 if (srw_res->num_diagnostics)
1131 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1132 else if (*http_code != 200)
1133 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1134 else if (srw_res->numberOfRecords)
1136 wrbuf_printf(wr, "OK %d",
1137 (srw_res->numberOfRecords ?
1138 *srw_res->numberOfRecords : 0));
1140 wrbuf_printf(wr, " %s %d+%d",
1141 (srw_res->resultSetId ?
1142 srw_res->resultSetId : "-"),
1143 (srw_req->startRecord ? *srw_req->startRecord : 1),
1144 srw_res->num_records);
1145 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1150 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1153 xmlNodePtr ptr = rr->server_node_ptr;
1156 for (ptr = ptr->children; ptr; ptr = ptr->next)
1158 if (ptr->type != XML_ELEMENT_NODE)
1160 if (!strcmp((const char *) ptr->name, "explain"))
1163 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1167 ptr = xmlCopyNode(ptr, 1);
1169 xmlDocSetRootElement(doc, ptr);
1171 xmlDocDumpMemory(doc, &buf_out, &len);
1172 content = (char*) odr_malloc(rr->stream, 1+len);
1173 memcpy(content, buf_out, len);
1174 content[len] = '\0';
1178 rr->explain_buf = content;
1186 static void srw_bend_explain(association *assoc, request *req,
1188 Z_SRW_explainResponse *srw_res,
1191 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1192 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1194 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1199 rr.stream = assoc->encode;
1200 rr.decode = assoc->decode;
1201 rr.print = assoc->print;
1203 rr.database = srw_req->database;
1205 rr.server_node_ptr = assoc->server->server_node_ptr;
1207 rr.server_node_ptr = 0;
1208 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1209 if (assoc->init->bend_explain)
1210 (*assoc->init->bend_explain)(assoc->backend, &rr);
1212 srw_bend_explain_default(assoc->backend, &rr);
1216 int packing = Z_SRW_recordPacking_string;
1217 if (srw_req->recordPacking)
1220 yaz_srw_str_to_pack(srw_req->recordPacking);
1222 packing = Z_SRW_recordPacking_string;
1224 srw_res->record.recordSchema = rr.schema;
1225 srw_res->record.recordPacking = packing;
1226 srw_res->record.recordData_buf = rr.explain_buf;
1227 srw_res->record.recordData_len = strlen(rr.explain_buf);
1228 srw_res->record.recordPosition = 0;
1234 static void srw_bend_scan(association *assoc, request *req,
1236 Z_SRW_scanResponse *srw_res,
1239 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1240 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1243 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1244 if (srw_res->num_diagnostics == 0 && assoc->init)
1246 struct scan_entry *save_entries;
1248 bend_scan_rr *bsrr = (bend_scan_rr *)
1249 odr_malloc (assoc->encode, sizeof(*bsrr));
1250 bsrr->num_bases = 1;
1251 bsrr->basenames = &srw_req->database;
1253 bsrr->num_entries = srw_req->maximumTerms ?
1254 *srw_req->maximumTerms : 10;
1255 bsrr->term_position = srw_req->responsePosition ?
1256 *srw_req->responsePosition : 1;
1259 bsrr->errstring = 0;
1260 bsrr->referenceId = 0;
1261 bsrr->stream = assoc->encode;
1262 bsrr->print = assoc->print;
1263 bsrr->step_size = odr_intdup(assoc->decode, 0);
1266 if (bsrr->num_entries > 0)
1269 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1271 for (i = 0; i<bsrr->num_entries; i++)
1273 bsrr->entries[i].term = 0;
1274 bsrr->entries[i].occurrences = 0;
1275 bsrr->entries[i].errcode = 0;
1276 bsrr->entries[i].errstring = 0;
1277 bsrr->entries[i].display_term = 0;
1280 save_entries = bsrr->entries; /* save it so we can compare later */
1282 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1283 assoc->init->bend_scan)
1285 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1287 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1288 &bsrr->attributeset,
1289 srw_req->scanClause.pqf);
1290 yaz_pqf_destroy(pqf_parser);
1291 bsrr->scanClause = 0;
1292 ((int (*)(void *, bend_scan_rr *))
1293 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1295 else if (srw_req->query_type == Z_SRW_query_type_cql
1296 && assoc->init->bend_scan && assoc->server
1297 && assoc->server->cql_transform)
1300 bsrr->scanClause = 0;
1301 bsrr->attributeset = 0;
1302 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1303 srw_error = cql2pqf_scan(assoc->encode,
1304 srw_req->scanClause.cql,
1305 assoc->server->cql_transform,
1308 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1309 &srw_res->num_diagnostics,
1313 ((int (*)(void *, bend_scan_rr *))
1314 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1317 else if (srw_req->query_type == Z_SRW_query_type_cql
1318 && assoc->init->bend_srw_scan)
1321 bsrr->attributeset = 0;
1322 bsrr->scanClause = srw_req->scanClause.cql;
1323 ((int (*)(void *, bend_scan_rr *))
1324 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1328 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1329 &srw_res->num_diagnostics,
1330 YAZ_SRW_UNSUPP_OPERATION, "scan");
1335 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1340 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1342 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1343 &srw_res->num_diagnostics,
1344 srw_error, bsrr->errstring);
1346 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1349 srw_res->terms = (Z_SRW_scanTerm*)
1350 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1353 srw_res->num_terms = bsrr->num_entries;
1354 for (i = 0; i<bsrr->num_entries; i++)
1356 Z_SRW_scanTerm *t = srw_res->terms + i;
1357 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1358 t->numberOfRecords =
1359 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1361 if (save_entries == bsrr->entries &&
1362 bsrr->entries[i].display_term)
1364 /* the entries was _not_ set by the handler. So it's
1365 safe to test for new member display_term. It is
1368 t->displayTerm = odr_strdup(assoc->encode,
1369 bsrr->entries[i].display_term);
1377 WRBUF wr = wrbuf_alloc();
1378 const char *querytype = 0;
1379 const char *querystr = 0;
1381 switch(srw_req->query_type)
1383 case Z_SRW_query_type_pqf:
1385 querystr = srw_req->scanClause.pqf;
1387 case Z_SRW_query_type_cql:
1389 querystr = srw_req->scanClause.cql;
1392 querytype = "UNKNOWN";
1396 wrbuf_printf(wr, "SRWScan ");
1397 wrbuf_printf(wr, srw_req->database);
1398 wrbuf_printf(wr, " ");
1400 if (srw_res->num_diagnostics)
1401 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1402 else if (srw_res->num_terms)
1403 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1405 wrbuf_printf(wr, "OK - - ");
1407 wrbuf_printf(wr, "%d+%d+0 ",
1408 (srw_req->responsePosition ?
1409 *srw_req->responsePosition : 1),
1410 (srw_req->maximumTerms ?
1411 *srw_req->maximumTerms : 1));
1412 /* there is no step size in SRU/W ??? */
1413 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1414 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1420 static void srw_bend_update(association *assoc, request *req,
1422 Z_SRW_updateResponse *srw_res,
1425 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1426 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1427 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1429 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1433 Z_SRW_extra_record *extra = srw_req->extra_record;
1435 rr.stream = assoc->encode;
1436 rr.print = assoc->print;
1438 rr.basenames = &srw_req->database;
1439 rr.operation = srw_req->operation;
1440 rr.operation_status = "failed";
1442 rr.record_versions = 0;
1443 rr.num_versions = 0;
1444 rr.record_packing = "string";
1445 rr.record_schema = 0;
1447 rr.extra_record_data = 0;
1448 rr.extra_request_data = 0;
1449 rr.extra_response_data = 0;
1455 if (rr.operation == 0)
1457 yaz_add_sru_update_diagnostic(
1458 assoc->encode, &srw_res->diagnostics,
1459 &srw_res->num_diagnostics,
1460 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1464 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1465 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1466 if (!strcmp( rr.operation, "delete"))
1468 if (srw_req->record && !srw_req->record->recordSchema)
1470 rr.record_schema = odr_strdup(
1472 srw_req->record->recordSchema);
1474 if (srw_req->record)
1476 rr.record_data = odr_strdupn(
1478 srw_req->record->recordData_buf,
1479 srw_req->record->recordData_len );
1481 if (extra && extra->extraRecordData_len)
1483 rr.extra_record_data = odr_strdupn(
1485 extra->extraRecordData_buf,
1486 extra->extraRecordData_len );
1488 if (srw_req->recordId)
1489 rr.record_id = srw_req->recordId;
1490 else if (extra && extra->recordIdentifier)
1491 rr.record_id = extra->recordIdentifier;
1493 else if (!strcmp(rr.operation, "replace"))
1495 if (srw_req->recordId)
1496 rr.record_id = srw_req->recordId;
1497 else if (extra && extra->recordIdentifier)
1498 rr.record_id = extra->recordIdentifier;
1501 yaz_add_sru_update_diagnostic(
1502 assoc->encode, &srw_res->diagnostics,
1503 &srw_res->num_diagnostics,
1504 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1505 "recordIdentifier");
1507 if (!srw_req->record)
1509 yaz_add_sru_update_diagnostic(
1510 assoc->encode, &srw_res->diagnostics,
1511 &srw_res->num_diagnostics,
1512 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1517 if (srw_req->record->recordSchema)
1518 rr.record_schema = odr_strdup(
1519 assoc->encode, srw_req->record->recordSchema);
1520 if (srw_req->record->recordData_len )
1522 rr.record_data = odr_strdupn(assoc->encode,
1523 srw_req->record->recordData_buf,
1524 srw_req->record->recordData_len );
1528 yaz_add_sru_update_diagnostic(
1529 assoc->encode, &srw_res->diagnostics,
1530 &srw_res->num_diagnostics,
1531 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1535 if (extra && extra->extraRecordData_len)
1537 rr.extra_record_data = odr_strdupn(
1539 extra->extraRecordData_buf,
1540 extra->extraRecordData_len );
1543 else if (!strcmp(rr.operation, "insert"))
1545 if (srw_req->recordId)
1546 rr.record_id = srw_req->recordId;
1548 rr.record_id = extra->recordIdentifier;
1550 if (srw_req->record)
1552 if (srw_req->record->recordSchema)
1553 rr.record_schema = odr_strdup(
1554 assoc->encode, srw_req->record->recordSchema);
1556 if (srw_req->record->recordData_len)
1557 rr.record_data = odr_strdupn(
1559 srw_req->record->recordData_buf,
1560 srw_req->record->recordData_len );
1562 if (extra && extra->extraRecordData_len)
1564 rr.extra_record_data = odr_strdupn(
1566 extra->extraRecordData_buf,
1567 extra->extraRecordData_len );
1571 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1572 &srw_res->num_diagnostics,
1573 YAZ_SRU_UPDATE_INVALID_ACTION,
1576 if (srw_req->record)
1578 const char *pack_str =
1579 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1581 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1584 if (srw_req->num_recordVersions)
1586 rr.record_versions = srw_req->recordVersions;
1587 rr.num_versions = srw_req->num_recordVersions;
1589 if (srw_req->extraRequestData_len)
1591 rr.extra_request_data = odr_strdupn(assoc->encode,
1592 srw_req->extraRequestData_buf,
1593 srw_req->extraRequestData_len );
1595 if (srw_res->num_diagnostics == 0)
1597 if ( assoc->init->bend_srw_update)
1598 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1600 yaz_add_sru_update_diagnostic(
1601 assoc->encode, &srw_res->diagnostics,
1602 &srw_res->num_diagnostics,
1603 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1604 "No Update backend handler");
1608 yaz_add_srw_diagnostic_uri(assoc->encode,
1609 &srw_res->diagnostics,
1610 &srw_res->num_diagnostics,
1614 srw_res->recordId = rr.record_id;
1615 srw_res->operationStatus = rr.operation_status;
1616 srw_res->recordVersions = rr.record_versions;
1617 srw_res->num_recordVersions = rr.num_versions;
1618 if (srw_res->extraResponseData_len)
1620 srw_res->extraResponseData_buf = rr.extra_response_data;
1621 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1623 if (srw_res->num_diagnostics == 0 && rr.record_data)
1625 srw_res->record = yaz_srw_get_record(assoc->encode);
1626 srw_res->record->recordSchema = rr.record_schema;
1627 if (rr.record_packing)
1629 int pack = yaz_srw_str_to_pack(rr.record_packing);
1633 pack = Z_SRW_recordPacking_string;
1634 yaz_log(YLOG_WARN, "Back packing %s from backend",
1637 srw_res->record->recordPacking = pack;
1639 srw_res->record->recordData_buf = rr.record_data;
1640 srw_res->record->recordData_len = strlen(rr.record_data);
1641 if (rr.extra_record_data)
1643 Z_SRW_extra_record *ex =
1644 yaz_srw_get_extra_record(assoc->encode);
1645 srw_res->extra_record = ex;
1646 ex->extraRecordData_buf = rr.extra_record_data;
1647 ex->extraRecordData_len = strlen(rr.extra_record_data);
1653 /* check if path is OK (1); BAD (0) */
1654 static int check_path(const char *path)
1658 if (strstr(path, ".."))
1663 static char *read_file(const char *fname, ODR o, int *sz)
1666 FILE *inf = fopen(fname, "rb");
1670 fseek(inf, 0L, SEEK_END);
1673 buf = odr_malloc(o, *sz);
1674 fread(buf, 1, *sz, inf);
1679 static void process_http_request(association *assoc, request *req)
1681 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1682 ODR o = assoc->encode;
1683 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1685 Z_SOAP *soap_package = 0;
1688 Z_HTTP_Response *hres = 0;
1690 const char *stylesheet = 0; /* for now .. set later */
1691 Z_SRW_diagnostic *diagnostic = 0;
1692 int num_diagnostic = 0;
1693 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1695 if (!control_association(assoc, host, 0))
1697 p = z_get_HTTP_Response(o, 404);
1700 if (r == 2 && assoc->server && assoc->server->docpath
1701 && hreq->path[0] == '/'
1703 /* check if path is a proper prefix of documentroot */
1704 strncmp(hreq->path+1, assoc->server->docpath,
1705 strlen(assoc->server->docpath))
1708 if (!check_path(hreq->path))
1710 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1711 p = z_get_HTTP_Response(o, 404);
1715 int content_size = 0;
1716 char *content_buf = read_file(hreq->path+1, o, &content_size);
1719 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1720 p = z_get_HTTP_Response(o, 404);
1724 const char *ctype = 0;
1725 yaz_mime_types types = yaz_mime_types_create();
1727 yaz_mime_types_add(types, "xsl", "application/xml");
1728 yaz_mime_types_add(types, "xml", "application/xml");
1729 yaz_mime_types_add(types, "css", "text/css");
1730 yaz_mime_types_add(types, "html", "text/html");
1731 yaz_mime_types_add(types, "htm", "text/html");
1732 yaz_mime_types_add(types, "txt", "text/plain");
1733 yaz_mime_types_add(types, "js", "application/x-javascript");
1735 yaz_mime_types_add(types, "gif", "image/gif");
1736 yaz_mime_types_add(types, "png", "image/png");
1737 yaz_mime_types_add(types, "jpg", "image/jpeg");
1738 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1740 ctype = yaz_mime_lookup_fname(types, hreq->path);
1743 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1744 p = z_get_HTTP_Response(o, 404);
1748 p = z_get_HTTP_Response(o, 200);
1749 hres = p->u.HTTP_Response;
1750 hres->content_buf = content_buf;
1751 hres->content_len = content_size;
1752 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1754 yaz_mime_types_destroy(types);
1762 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1763 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1765 if (r == 2) /* not taken */
1767 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1768 &diagnostic, &num_diagnostic);
1769 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1771 if (r == 0) /* decode SRW/SRU OK .. */
1773 int http_code = 200;
1774 if (sr->which == Z_SRW_searchRetrieve_request)
1777 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1779 stylesheet = sr->u.request->stylesheet;
1782 res->u.response->diagnostics = diagnostic;
1783 res->u.response->num_diagnostics = num_diagnostic;
1787 srw_bend_search(assoc, req, sr, res->u.response,
1790 if (http_code == 200)
1791 soap_package->u.generic->p = res;
1793 else if (sr->which == Z_SRW_explain_request)
1795 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1796 stylesheet = sr->u.explain_request->stylesheet;
1799 res->u.explain_response->diagnostics = diagnostic;
1800 res->u.explain_response->num_diagnostics = num_diagnostic;
1802 srw_bend_explain(assoc, req, sr,
1803 res->u.explain_response, &http_code);
1804 if (http_code == 200)
1805 soap_package->u.generic->p = res;
1807 else if (sr->which == Z_SRW_scan_request)
1809 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1810 stylesheet = sr->u.scan_request->stylesheet;
1813 res->u.scan_response->diagnostics = diagnostic;
1814 res->u.scan_response->num_diagnostics = num_diagnostic;
1816 srw_bend_scan(assoc, req, sr,
1817 res->u.scan_response, &http_code);
1818 if (http_code == 200)
1819 soap_package->u.generic->p = res;
1821 else if (sr->which == Z_SRW_update_request)
1823 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1824 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1827 res->u.update_response->diagnostics = diagnostic;
1828 res->u.update_response->num_diagnostics = num_diagnostic;
1830 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1831 srw_bend_update(assoc, req, sr,
1832 res->u.update_response, &http_code);
1833 if (http_code == 200)
1834 soap_package->u.generic->p = res;
1838 yaz_log(log_request, "SOAP ERROR");
1839 /* FIXME - what error, what query */
1841 z_soap_error(assoc->encode, soap_package,
1842 "SOAP-ENV:Client", "Bad method", 0);
1844 if (http_code == 200 || http_code == 500)
1846 static Z_SOAP_Handler soap_handlers[4] = {
1848 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1849 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1850 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1856 p = z_get_HTTP_Response(o, 200);
1857 hres = p->u.HTTP_Response;
1859 if (!stylesheet && assoc->server)
1860 stylesheet = assoc->server->stylesheet;
1862 /* empty stylesheet means NO stylesheet */
1863 if (stylesheet && *stylesheet == '\0')
1866 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1867 &hres->content_buf, &hres->content_len,
1868 soap_handlers, charset, stylesheet);
1869 hres->code = http_code;
1871 strcpy(ctype, "text/xml");
1874 strcat(ctype, "; charset=");
1875 strcat(ctype, charset);
1877 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1880 p = z_get_HTTP_Response(o, http_code);
1884 p = z_get_HTTP_Response(o, 500);
1885 hres = p->u.HTTP_Response;
1886 if (!strcmp(hreq->version, "1.0"))
1888 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1889 if (v && !strcmp(v, "Keep-Alive"))
1893 hres->version = "1.0";
1897 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1898 if (v && !strcmp(v, "close"))
1902 hres->version = "1.1";
1906 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1907 assoc->state = ASSOC_DEAD;
1908 assoc->cs_get_mask = 0;
1913 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1915 if (alive && isdigit(*(const unsigned char *) alive))
1919 if (t < 0 || t > 3600)
1921 iochan_settimeout(assoc->client_chan,t);
1922 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1924 process_gdu_response(assoc, req, p);
1927 static void process_gdu_request(association *assoc, request *req)
1929 if (req->gdu_request->which == Z_GDU_Z3950)
1932 req->apdu_request = req->gdu_request->u.z3950;
1933 if (process_z_request(assoc, req, &msg) < 0)
1934 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1936 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1937 process_http_request(assoc, req);
1940 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1945 * Initiate request processing.
1947 static int process_z_request(association *assoc, request *req, char **msg)
1953 *msg = "Unknown Error";
1954 assert(req && req->state == REQUEST_IDLE);
1955 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1957 *msg = "Missing InitRequest";
1960 switch (req->apdu_request->which)
1962 case Z_APDU_initRequest:
1963 res = process_initRequest(assoc, req); break;
1964 case Z_APDU_searchRequest:
1965 res = process_searchRequest(assoc, req, &fd); break;
1966 case Z_APDU_presentRequest:
1967 res = process_presentRequest(assoc, req, &fd); break;
1968 case Z_APDU_scanRequest:
1969 if (assoc->init->bend_scan)
1970 res = process_scanRequest(assoc, req, &fd);
1973 *msg = "Cannot handle Scan APDU";
1977 case Z_APDU_extendedServicesRequest:
1978 if (assoc->init->bend_esrequest)
1979 res = process_ESRequest(assoc, req, &fd);
1982 *msg = "Cannot handle Extended Services APDU";
1986 case Z_APDU_sortRequest:
1987 if (assoc->init->bend_sort)
1988 res = process_sortRequest(assoc, req, &fd);
1991 *msg = "Cannot handle Sort APDU";
1996 process_close(assoc, req);
1998 case Z_APDU_deleteResultSetRequest:
1999 if (assoc->init->bend_delete)
2000 res = process_deleteRequest(assoc, req, &fd);
2003 *msg = "Cannot handle Delete APDU";
2007 case Z_APDU_segmentRequest:
2008 if (assoc->init->bend_segment)
2010 res = process_segmentRequest (assoc, req);
2014 *msg = "Cannot handle Segment APDU";
2018 case Z_APDU_triggerResourceControlRequest:
2021 *msg = "Bad APDU received";
2026 yaz_log(YLOG_DEBUG, " result immediately available");
2027 retval = process_z_response(assoc, req, res);
2031 yaz_log(YLOG_DEBUG, " result unavailble");
2034 else /* no result yet - one will be provided later */
2038 /* Set up an I/O handler for the fd supplied by the backend */
2040 yaz_log(YLOG_DEBUG, " establishing handler for result");
2041 req->state = REQUEST_PENDING;
2042 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2044 iochan_setdata(chan, assoc);
2051 * Handle message from the backend.
2053 void backend_response(IOCHAN i, int event)
2055 association *assoc = (association *)iochan_getdata(i);
2056 request *req = request_head(&assoc->incoming);
2060 yaz_log(YLOG_DEBUG, "backend_response");
2061 assert(assoc && req && req->state != REQUEST_IDLE);
2062 /* determine what it is we're waiting for */
2063 switch (req->apdu_request->which)
2065 case Z_APDU_searchRequest:
2066 res = response_searchRequest(assoc, req, 0, &fd); break;
2068 case Z_APDU_presentRequest:
2069 res = response_presentRequest(assoc, req, 0, &fd); break;
2070 case Z_APDU_scanRequest:
2071 res = response_scanRequest(assoc, req, 0, &fd); break;
2074 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2077 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2079 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2080 do_close(assoc, Z_Close_systemProblem, 0);
2084 else if (!res) /* no result yet - try again later */
2086 yaz_log(YLOG_DEBUG, " no result yet");
2087 iochan_setfd(i, fd); /* in case fd has changed */
2092 * Encode response, and transfer the request structure to the outgoing queue.
2094 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2096 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2100 if (!z_GDU(assoc->print, &res, 0, 0))
2101 yaz_log(YLOG_WARN, "ODR print error: %s",
2102 odr_errmsg(odr_geterror(assoc->print)));
2103 odr_reset(assoc->print);
2105 if (!z_GDU(assoc->encode, &res, 0, 0))
2107 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2108 odr_errmsg(odr_geterror(assoc->decode)),
2109 odr_getelement(assoc->decode));
2112 req->response = odr_getbuf(assoc->encode, &req->len_response,
2113 &req->size_response);
2114 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2115 odr_reset(assoc->encode);
2116 req->state = REQUEST_IDLE;
2117 request_enq(&assoc->outgoing, req);
2118 /* turn the work over to the ir_session handler */
2119 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2120 assoc->cs_put_mask = EVENT_OUTPUT;
2121 /* Is there more work to be done? give that to the input handler too */
2124 req = request_head(&assoc->incoming);
2125 if (req && req->state == REQUEST_IDLE)
2127 request_deq(&assoc->incoming);
2128 process_gdu_request(assoc, req);
2137 * Encode response, and transfer the request structure to the outgoing queue.
2139 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2141 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2142 gres->which = Z_GDU_Z3950;
2143 gres->u.z3950 = res;
2145 return process_gdu_response(assoc, req, gres);
2148 static char *get_vhost(Z_OtherInformation *otherInfo)
2150 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2154 * Handle init request.
2155 * At the moment, we don't check the options
2156 * anywhere else in the code - we just try not to do anything that would
2157 * break a naive client. We'll toss 'em into the association block when
2158 * we need them there.
2160 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2162 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2163 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2164 Z_InitResponse *resp = apdu->u.initResponse;
2165 bend_initresult *binitres;
2168 statserv_options_block *cb = 0; /* by default no control for backend */
2170 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2171 cb = statserv_getcontrol(); /* got control block for backend */
2173 if (cb && assoc->backend)
2174 (*cb->bend_close)(assoc->backend);
2176 yaz_log(log_requestdetail, "Got initRequest");
2177 if (req->implementationId)
2178 yaz_log(log_requestdetail, "Id: %s",
2179 req->implementationId);
2180 if (req->implementationName)
2181 yaz_log(log_requestdetail, "Name: %s",
2182 req->implementationName);
2183 if (req->implementationVersion)
2184 yaz_log(log_requestdetail, "Version: %s",
2185 req->implementationVersion);
2187 assoc_init_reset(assoc);
2189 assoc->init->auth = req->idAuthentication;
2190 assoc->init->referenceId = req->referenceId;
2192 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2194 Z_CharSetandLanguageNegotiation *negotiation =
2195 yaz_get_charneg_record (req->otherInfo);
2197 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2198 assoc->init->charneg_request = negotiation;
2204 if (req->implementationVersion)
2205 yaz_log(log_requestdetail, "Config: %s",
2208 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2210 /* we have a backend control block, so call that init function */
2211 if (!(binitres = (*cb->bend_init)(assoc->init)))
2213 yaz_log(YLOG_WARN, "Bad response from backend.");
2216 assoc->backend = binitres->handle;
2220 /* no backend. return error */
2221 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2222 binitres->errstring = 0;
2223 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2224 iochan_settimeout(assoc->client_chan, 10);
2226 if ((assoc->init->bend_sort))
2227 yaz_log (YLOG_DEBUG, "Sort handler installed");
2228 if ((assoc->init->bend_search))
2229 yaz_log (YLOG_DEBUG, "Search handler installed");
2230 if ((assoc->init->bend_present))
2231 yaz_log (YLOG_DEBUG, "Present handler installed");
2232 if ((assoc->init->bend_esrequest))
2233 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2234 if ((assoc->init->bend_delete))
2235 yaz_log (YLOG_DEBUG, "Delete handler installed");
2236 if ((assoc->init->bend_scan))
2237 yaz_log (YLOG_DEBUG, "Scan handler installed");
2238 if ((assoc->init->bend_segment))
2239 yaz_log (YLOG_DEBUG, "Segment handler installed");
2241 resp->referenceId = req->referenceId;
2243 /* let's tell the client what we can do */
2244 if (ODR_MASK_GET(req->options, Z_Options_search))
2246 ODR_MASK_SET(resp->options, Z_Options_search);
2247 strcat(options, "srch");
2249 if (ODR_MASK_GET(req->options, Z_Options_present))
2251 ODR_MASK_SET(resp->options, Z_Options_present);
2252 strcat(options, " prst");
2254 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2255 assoc->init->bend_delete)
2257 ODR_MASK_SET(resp->options, Z_Options_delSet);
2258 strcat(options, " del");
2260 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2261 assoc->init->bend_esrequest)
2263 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2264 strcat (options, " extendedServices");
2266 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2268 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2269 strcat(options, " namedresults");
2271 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2273 ODR_MASK_SET(resp->options, Z_Options_scan);
2274 strcat(options, " scan");
2276 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2278 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2279 strcat(options, " concurrop");
2281 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2283 ODR_MASK_SET(resp->options, Z_Options_sort);
2284 strcat(options, " sort");
2287 if (!assoc->init->charneg_response && !assoc->init->charneg_request)
2289 if (assoc->init->query_charset)
2291 assoc->init->charneg_response = yaz_set_response_charneg(
2292 assoc->encode, assoc->init->query_charset, 0, 0);
2296 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2299 if (assoc->init->charneg_response
2300 && ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2302 Z_OtherInformation **p;
2303 Z_OtherInformationUnit *p0;
2305 yaz_oi_APDU(apdu, &p);
2307 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2308 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2310 p0->which = Z_OtherInfo_externallyDefinedInfo;
2311 p0->information.externallyDefinedInfo =
2312 assoc->init->charneg_response;
2314 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2315 strcat(options, " negotiation");
2317 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2318 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2320 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2322 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2323 assoc->version = 1; /* 1 & 2 are equivalent */
2325 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2327 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2330 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2332 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2336 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2338 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2339 assoc->maximumRecordSize = *req->maximumRecordSize;
2341 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2342 assoc->preferredMessageSize = *req->preferredMessageSize;
2344 resp->preferredMessageSize = &assoc->preferredMessageSize;
2345 resp->maximumRecordSize = &assoc->maximumRecordSize;
2347 resp->implementationId = odr_prepend(assoc->encode,
2348 assoc->init->implementation_id,
2349 resp->implementationId);
2351 resp->implementationName = odr_prepend(assoc->encode,
2352 assoc->init->implementation_name,
2353 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2355 version = odr_strdup(assoc->encode, "$Revision: 1.116 $");
2356 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2357 version[strlen(version)-2] = '\0';
2358 resp->implementationVersion = odr_prepend(assoc->encode,
2359 assoc->init->implementation_version,
2360 odr_prepend(assoc->encode, &version[11],
2361 resp->implementationVersion));
2363 if (binitres->errcode)
2365 assoc->state = ASSOC_DEAD;
2366 resp->userInformationField =
2367 init_diagnostics(assoc->encode, binitres->errcode,
2368 binitres->errstring);
2373 if (!req->idAuthentication)
2374 yaz_log(log_request, "Auth none");
2375 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2377 const char *open = req->idAuthentication->u.open;
2378 const char *slash = strchr(open, '/');
2384 yaz_log(log_request, "Auth open %.*s", len, open);
2386 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2388 const char *user = req->idAuthentication->u.idPass->userId;
2389 const char *group = req->idAuthentication->u.idPass->groupId;
2390 yaz_log(log_request, "Auth idPass %s %s",
2391 user ? user : "-", group ? group : "-");
2393 else if (req->idAuthentication->which
2394 == Z_IdAuthentication_anonymous)
2396 yaz_log(log_request, "Auth anonymous");
2400 yaz_log(log_request, "Auth other");
2405 WRBUF wr = wrbuf_alloc();
2406 wrbuf_printf(wr, "Init ");
2407 if (binitres->errcode)
2408 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2410 wrbuf_printf(wr, "OK -");
2411 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2412 (req->implementationId ? req->implementationId :"-"),
2413 (req->implementationName ?
2414 req->implementationName : "-"),
2415 (req->implementationVersion ?
2416 req->implementationVersion : "-")
2418 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2425 * Set the specified `errcode' and `errstring' into a UserInfo-1
2426 * external to be returned to the client in accordance with Z35.90
2427 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2428 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2430 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2432 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2433 addinfo ? " -- " : "", addinfo ? addinfo : "");
2434 return zget_init_diagnostics(odr, error, addinfo);
2438 * nonsurrogate diagnostic record.
2440 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2442 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2444 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2445 addinfo ? " -- " : "", addinfo ? addinfo : "");
2447 rec->which = Z_Records_NSD;
2448 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2454 * surrogate diagnostic.
2456 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2458 int error, const char *addinfo)
2460 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2461 addinfo ? " -- " : "", addinfo ? addinfo : "");
2462 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2465 static Z_Records *pack_records(association *a, char *setname, int start,
2466 int *num, Z_RecordComposition *comp,
2467 int *next, int *pres,
2468 Z_ReferenceId *referenceId,
2469 int *oid, int *errcode)
2471 int recno, total_length = 0, toget = *num, dumped_records = 0;
2472 Z_Records *records =
2473 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2474 Z_NamePlusRecordList *reclist =
2475 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2476 Z_NamePlusRecord **list =
2477 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2479 records->which = Z_Records_DBOSD;
2480 records->u.databaseOrSurDiagnostics = reclist;
2481 reclist->num_records = 0;
2482 reclist->records = list;
2483 *pres = Z_PresentStatus_success;
2487 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2488 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2489 a->maximumRecordSize);
2490 for (recno = start; reclist->num_records < toget; recno++)
2493 Z_NamePlusRecord *thisrec;
2494 int this_length = 0;
2496 * we get the number of bytes allocated on the stream before any
2497 * allocation done by the backend - this should give us a reasonable
2498 * idea of the total size of the data so far.
2500 total_length = odr_total(a->encode) - dumped_records;
2506 freq.last_in_set = 0;
2507 freq.setname = setname;
2508 freq.surrogate_flag = 0;
2509 freq.number = recno;
2511 freq.request_format = oid;
2512 freq.output_format = 0;
2513 freq.stream = a->encode;
2514 freq.print = a->print;
2515 freq.referenceId = referenceId;
2518 retrieve_fetch(a, &freq);
2520 *next = freq.last_in_set ? 0 : recno + 1;
2522 /* backend should be able to signal whether error is system-wide
2523 or only pertaining to current record */
2526 if (!freq.surrogate_flag)
2529 *pres = Z_PresentStatus_failure;
2530 /* for 'present request out of range',
2531 set addinfo to record position if not set */
2532 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2533 freq.errstring == 0)
2535 sprintf (s, "%d", recno);
2539 *errcode = freq.errcode;
2540 return diagrec(a, freq.errcode, freq.errstring);
2542 reclist->records[reclist->num_records] =
2543 surrogatediagrec(a, freq.basename, freq.errcode,
2545 reclist->num_records++;
2548 if (freq.record == 0) /* no error and no record ? */
2550 *next = 0; /* signal end-of-set and stop */
2554 this_length = freq.len;
2556 this_length = odr_total(a->encode) - total_length - dumped_records;
2557 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2558 this_length, total_length, dumped_records);
2559 if (a->preferredMessageSize > 0 &&
2560 this_length + total_length > a->preferredMessageSize)
2562 /* record is small enough, really */
2563 if (this_length <= a->preferredMessageSize && recno > start)
2565 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2566 *pres = Z_PresentStatus_partial_2;
2569 /* record can only be fetched by itself */
2570 if (this_length < a->maximumRecordSize)
2572 yaz_log(log_requestdetail, " Record > prefmsgsz");
2575 yaz_log(YLOG_DEBUG, " Dropped it");
2576 reclist->records[reclist->num_records] =
2577 surrogatediagrec(a, freq.basename, 16, 0);
2578 reclist->num_records++;
2579 dumped_records += this_length;
2583 else /* too big entirely */
2585 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2586 this_length, a->maximumRecordSize);
2587 reclist->records[reclist->num_records] =
2588 surrogatediagrec(a, freq.basename, 17, 0);
2589 reclist->num_records++;
2590 dumped_records += this_length;
2595 if (!(thisrec = (Z_NamePlusRecord *)
2596 odr_malloc(a->encode, sizeof(*thisrec))))
2599 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2601 thisrec->databaseName = 0;
2602 thisrec->which = Z_NamePlusRecord_databaseRecord;
2604 if (!freq.output_format)
2605 freq.output_format = freq.request_format;
2606 thisrec->u.databaseRecord = z_ext_record_oid(
2607 a->encode, freq.output_format, freq.record, freq.len);
2608 if (!thisrec->u.databaseRecord)
2610 reclist->records[reclist->num_records] = thisrec;
2611 reclist->num_records++;
2613 *num = reclist->num_records;
2617 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2620 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2621 bend_search_rr *bsrr =
2622 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2624 yaz_log(log_requestdetail, "Got SearchRequest.");
2626 bsrr->request = reqb;
2627 bsrr->association = assoc;
2628 bsrr->referenceId = req->referenceId;
2629 save_referenceId (reqb, bsrr->referenceId);
2630 bsrr->srw_sortKeys = 0;
2631 bsrr->srw_setname = 0;
2632 bsrr->srw_setnameIdleTime = 0;
2633 bsrr->estimated_hit_count = 0;
2634 bsrr->partial_resultset = 0;
2636 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2637 if (req->databaseNames)
2640 for (i = 0; i < req->num_databaseNames; i++)
2641 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2644 yaz_log_zquery_level(log_requestdetail,req->query);
2646 if (assoc->init->bend_search)
2648 bsrr->setname = req->resultSetName;
2649 bsrr->replace_set = *req->replaceIndicator;
2650 bsrr->num_bases = req->num_databaseNames;
2651 bsrr->basenames = req->databaseNames;
2652 bsrr->query = req->query;
2653 bsrr->stream = assoc->encode;
2654 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2655 bsrr->decode = assoc->decode;
2656 bsrr->print = assoc->print;
2659 bsrr->errstring = NULL;
2660 bsrr->search_info = NULL;
2662 if (assoc->server && assoc->server->cql_transform
2663 && req->query->which == Z_Query_type_104
2664 && req->query->u.type_104->which == Z_External_CQL)
2666 /* have a CQL query and a CQL to PQF transform .. */
2668 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2669 assoc->server->cql_transform, bsrr->query);
2671 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2674 (assoc->init->bend_search)(assoc->backend, bsrr);
2675 if (!bsrr->request) /* backend not ready with the search response */
2676 return 0; /* should not be used any more */
2680 /* FIXME - make a diagnostic for it */
2681 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2683 return response_searchRequest(assoc, reqb, bsrr, fd);
2686 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2689 * Prepare a searchresponse based on the backend results. We probably want
2690 * to look at making the fetching of records nonblocking as well, but
2691 * so far, we'll keep things simple.
2692 * If bsrt is null, that means we're called in response to a communications
2693 * event, and we'll have to get the response for ourselves.
2695 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2696 bend_search_rr *bsrt, int *fd)
2698 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2699 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2700 Z_SearchResponse *resp = (Z_SearchResponse *)
2701 odr_malloc (assoc->encode, sizeof(*resp));
2702 int *nulint = odr_intdup (assoc->encode, 0);
2703 int *next = odr_intdup(assoc->encode, 0);
2704 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2705 int returnedrecs = 0;
2707 apdu->which = Z_APDU_searchResponse;
2708 apdu->u.searchResponse = resp;
2709 resp->referenceId = req->referenceId;
2710 resp->additionalSearchInfo = 0;
2711 resp->otherInfo = 0;
2713 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2715 yaz_log(YLOG_FATAL, "Bad result from backend");
2718 else if (bsrt->errcode)
2720 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2721 resp->resultCount = nulint;
2722 resp->numberOfRecordsReturned = nulint;
2723 resp->nextResultSetPosition = nulint;
2724 resp->searchStatus = nulint;
2725 resp->resultSetStatus = none;
2726 resp->presentStatus = 0;
2730 bool_t *sr = odr_intdup(assoc->encode, 1);
2731 int *toget = odr_intdup(assoc->encode, 0);
2732 Z_RecordComposition comp, *compp = 0;
2734 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2737 resp->resultCount = &bsrt->hits;
2739 comp.which = Z_RecordComp_simple;
2740 /* how many records does the user agent want, then? */
2741 if (bsrt->hits <= *req->smallSetUpperBound)
2743 *toget = bsrt->hits;
2744 if ((comp.u.simple = req->smallSetElementSetNames))
2747 else if (bsrt->hits < *req->largeSetLowerBound)
2749 *toget = *req->mediumSetPresentNumber;
2750 if (*toget > bsrt->hits)
2751 *toget = bsrt->hits;
2752 if ((comp.u.simple = req->mediumSetElementSetNames))
2758 if (*toget && !resp->records)
2760 int *presst = odr_intdup(assoc->encode, 0);
2761 /* Call bend_present if defined */
2762 if (assoc->init->bend_present)
2764 bend_present_rr *bprr = (bend_present_rr *)
2765 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2766 bprr->setname = req->resultSetName;
2768 bprr->number = *toget;
2769 bprr->format = req->preferredRecordSyntax;
2771 bprr->referenceId = req->referenceId;
2772 bprr->stream = assoc->encode;
2773 bprr->print = assoc->print;
2774 bprr->request = reqb;
2775 bprr->association = assoc;
2777 bprr->errstring = NULL;
2778 (*assoc->init->bend_present)(assoc->backend, bprr);
2784 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2785 *resp->presentStatus = Z_PresentStatus_failure;
2790 resp->records = pack_records(
2791 assoc, req->resultSetName, 1,
2792 toget, compp, next, presst, req->referenceId,
2793 req->preferredRecordSyntax, NULL);
2796 resp->numberOfRecordsReturned = toget;
2797 returnedrecs = *toget;
2798 resp->presentStatus = presst;
2802 if (*resp->resultCount)
2804 resp->numberOfRecordsReturned = nulint;
2805 resp->presentStatus = 0;
2807 resp->nextResultSetPosition = next;
2808 resp->searchStatus = sr;
2809 resp->resultSetStatus = 0;
2810 if (bsrt->estimated_hit_count)
2812 resp->resultSetStatus = odr_intdup(assoc->encode,
2813 Z_SearchResponse_estimate);
2815 else if (bsrt->partial_resultset)
2817 resp->resultSetStatus = odr_intdup(assoc->encode,
2818 Z_SearchResponse_subset);
2821 resp->additionalSearchInfo = bsrt->search_info;
2826 WRBUF wr = wrbuf_alloc();
2828 for (i = 0 ; i < req->num_databaseNames; i++){
2830 wrbuf_printf(wr, "+");
2831 wrbuf_printf(wr, req->databaseNames[i]);
2833 wrbuf_printf(wr, " ");
2836 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2838 wrbuf_printf(wr, "OK %d", bsrt->hits);
2839 wrbuf_printf(wr, " %s 1+%d ",
2840 req->resultSetName, returnedrecs);
2841 yaz_query_to_wrbuf(wr, req->query);
2843 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2850 * Maybe we got a little over-friendly when we designed bend_fetch to
2851 * get only one record at a time. Some backends can optimise multiple-record
2852 * fetches, and at any rate, there is some overhead involved in
2853 * all that selecting and hopping around. Problem is, of course, that the
2854 * frontend can't know ahead of time how many records it'll need to
2855 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2856 * is downright lousy as a bulk data transfer protocol.
2858 * To start with, we'll do the fetching of records from the backend
2859 * in one operation: To save some trips in and out of the event-handler,
2860 * and to simplify the interface to pack_records. At any rate, asynch
2861 * operation is more fun in operations that have an unpredictable execution
2862 * speed - which is normally more true for search than for present.
2864 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2867 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2869 Z_PresentResponse *resp;
2873 const char *errstring = 0;
2875 yaz_log(log_requestdetail, "Got PresentRequest.");
2877 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2879 resp->presentStatus = odr_intdup(assoc->encode, 0);
2880 if (assoc->init->bend_present)
2882 bend_present_rr *bprr = (bend_present_rr *)
2883 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2884 bprr->setname = req->resultSetId;
2885 bprr->start = *req->resultSetStartPoint;
2886 bprr->number = *req->numberOfRecordsRequested;
2887 bprr->format = req->preferredRecordSyntax;
2888 bprr->comp = req->recordComposition;
2889 bprr->referenceId = req->referenceId;
2890 bprr->stream = assoc->encode;
2891 bprr->print = assoc->print;
2892 bprr->request = reqb;
2893 bprr->association = assoc;
2895 bprr->errstring = NULL;
2896 (*assoc->init->bend_present)(assoc->backend, bprr);
2899 return 0; /* should not happen */
2902 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2903 *resp->presentStatus = Z_PresentStatus_failure;
2904 errcode = bprr->errcode;
2905 errstring = bprr->errstring;
2908 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2909 next = odr_intdup(assoc->encode, 0);
2910 num = odr_intdup(assoc->encode, 0);
2912 apdu->which = Z_APDU_presentResponse;
2913 apdu->u.presentResponse = resp;
2914 resp->referenceId = req->referenceId;
2915 resp->otherInfo = 0;
2919 *num = *req->numberOfRecordsRequested;
2921 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2922 num, req->recordComposition, next,
2923 resp->presentStatus,
2924 req->referenceId, req->preferredRecordSyntax,
2929 WRBUF wr = wrbuf_alloc();
2930 wrbuf_printf(wr, "Present ");
2932 if (*resp->presentStatus == Z_PresentStatus_failure)
2933 wrbuf_printf(wr, "ERROR %d ", errcode);
2934 else if (*resp->presentStatus == Z_PresentStatus_success)
2935 wrbuf_printf(wr, "OK - ");
2937 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2939 wrbuf_printf(wr, " %s %d+%d ",
2940 req->resultSetId, *req->resultSetStartPoint,
2941 *req->numberOfRecordsRequested);
2942 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2947 resp->numberOfRecordsReturned = num;
2948 resp->nextResultSetPosition = next;
2954 * Scan was implemented rather in a hurry, and with support for only the basic
2955 * elements of the service in the backend API. Suggestions are welcome.
2957 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2959 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2960 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2961 Z_ScanResponse *res = (Z_ScanResponse *)
2962 odr_malloc (assoc->encode, sizeof(*res));
2963 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2964 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2965 Z_ListEntries *ents = (Z_ListEntries *)
2966 odr_malloc (assoc->encode, sizeof(*ents));
2967 Z_DiagRecs *diagrecs_p = NULL;
2968 bend_scan_rr *bsrr = (bend_scan_rr *)
2969 odr_malloc (assoc->encode, sizeof(*bsrr));
2970 struct scan_entry *save_entries;
2972 yaz_log(log_requestdetail, "Got ScanRequest");
2974 apdu->which = Z_APDU_scanResponse;
2975 apdu->u.scanResponse = res;
2976 res->referenceId = req->referenceId;
2978 /* if step is absent, set it to 0 */
2979 res->stepSize = odr_intdup(assoc->encode, 0);
2981 *res->stepSize = *req->stepSize;
2983 res->scanStatus = scanStatus;
2984 res->numberOfEntriesReturned = numberOfEntriesReturned;
2985 res->positionOfTerm = 0;
2986 res->entries = ents;
2987 ents->num_entries = 0;
2988 ents->entries = NULL;
2989 ents->num_nonsurrogateDiagnostics = 0;
2990 ents->nonsurrogateDiagnostics = NULL;
2991 res->attributeSet = 0;
2994 if (req->databaseNames)
2997 for (i = 0; i < req->num_databaseNames; i++)
2998 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
3000 bsrr->scanClause = 0;
3002 bsrr->errstring = 0;
3003 bsrr->num_bases = req->num_databaseNames;
3004 bsrr->basenames = req->databaseNames;
3005 bsrr->num_entries = *req->numberOfTermsRequested;
3006 bsrr->term = req->termListAndStartPoint;
3007 bsrr->referenceId = req->referenceId;
3008 bsrr->stream = assoc->encode;
3009 bsrr->print = assoc->print;
3010 bsrr->step_size = res->stepSize;
3012 /* For YAZ 2.0 and earlier it was the backend handler that
3013 initialized entries (member display_term did not exist)
3014 YAZ 2.0 and later sets 'entries' and initialize all members
3015 including 'display_term'. If YAZ 2.0 or later sees that
3016 entries was modified - we assume that it is an old handler and
3017 that 'display_term' is _not_ set.
3019 if (bsrr->num_entries > 0)
3022 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3024 for (i = 0; i<bsrr->num_entries; i++)
3026 bsrr->entries[i].term = 0;
3027 bsrr->entries[i].occurrences = 0;
3028 bsrr->entries[i].errcode = 0;
3029 bsrr->entries[i].errstring = 0;
3030 bsrr->entries[i].display_term = 0;
3033 save_entries = bsrr->entries; /* save it so we can compare later */
3035 bsrr->attributeset = req->attributeSet;
3036 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3037 bsrr->attributeset);
3038 bsrr->term_position = req->preferredPositionInResponse ?
3039 *req->preferredPositionInResponse : 1;
3041 ((int (*)(void *, bend_scan_rr *))
3042 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3045 diagrecs_p = zget_DiagRecs(assoc->encode,
3046 bsrr->errcode, bsrr->errstring);
3050 Z_Entry **tab = (Z_Entry **)
3051 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3053 if (bsrr->status == BEND_SCAN_PARTIAL)
3054 *scanStatus = Z_Scan_partial_5;
3056 *scanStatus = Z_Scan_success;
3057 ents->entries = tab;
3058 ents->num_entries = bsrr->num_entries;
3059 res->numberOfEntriesReturned = &ents->num_entries;
3060 res->positionOfTerm = &bsrr->term_position;
3061 for (i = 0; i < bsrr->num_entries; i++)
3067 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3068 if (bsrr->entries[i].occurrences >= 0)
3070 e->which = Z_Entry_termInfo;
3071 e->u.termInfo = t = (Z_TermInfo *)
3072 odr_malloc(assoc->encode, sizeof(*t));
3073 t->suggestedAttributes = 0;
3075 if (save_entries == bsrr->entries &&
3076 bsrr->entries[i].display_term)
3078 /* the entries was _not_ set by the handler. So it's
3079 safe to test for new member display_term. It is
3082 t->displayTerm = odr_strdup(assoc->encode,
3083 bsrr->entries[i].display_term);
3085 t->alternativeTerm = 0;
3086 t->byAttributes = 0;
3087 t->otherTermInfo = 0;
3088 t->globalOccurrences = &bsrr->entries[i].occurrences;
3089 t->term = (Z_Term *)
3090 odr_malloc(assoc->encode, sizeof(*t->term));
3091 t->term->which = Z_Term_general;
3092 t->term->u.general = o =
3093 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3094 o->buf = (unsigned char *)
3095 odr_malloc(assoc->encode, o->len = o->size =
3096 strlen(bsrr->entries[i].term));
3097 memcpy(o->buf, bsrr->entries[i].term, o->len);
3098 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3099 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3103 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3104 bsrr->entries[i].errcode,
3105 bsrr->entries[i].errstring);
3106 assert (drecs->num_diagRecs == 1);
3107 e->which = Z_Entry_surrogateDiagnostic;
3108 assert (drecs->diagRecs[0]);
3109 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3115 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3116 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3121 WRBUF wr = wrbuf_alloc();
3122 wrbuf_printf(wr, "Scan ");
3123 for (i = 0 ; i < req->num_databaseNames; i++){
3125 wrbuf_printf(wr, "+");
3126 wrbuf_printf(wr, req->databaseNames[i]);
3128 wrbuf_printf(wr, " ");
3131 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3132 wrbuf_printf(wr, " ");
3135 wrbuf_printf(wr, "OK ");
3136 /* else if (*res->scanStatus == Z_Scan_success) */
3137 /* wrbuf_printf(wr, "OK "); */
3139 /* wrbuf_printf(wr, "Partial "); */
3141 if (*res->numberOfEntriesReturned)
3142 wrbuf_printf(wr, "%d - ", *res->numberOfEntriesReturned);
3144 wrbuf_printf(wr, "0 - ");
3146 wrbuf_printf(wr, "%d+%d+%d ",
3147 (req->preferredPositionInResponse ?
3148 *req->preferredPositionInResponse : 1),
3149 *req->numberOfTermsRequested,
3150 (res->stepSize ? *res->stepSize : 1));
3152 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3153 bsrr->attributeset);
3154 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3160 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3164 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3165 Z_SortResponse *res = (Z_SortResponse *)
3166 odr_malloc (assoc->encode, sizeof(*res));
3167 bend_sort_rr *bsrr = (bend_sort_rr *)
3168 odr_malloc (assoc->encode, sizeof(*bsrr));
3170 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3172 yaz_log(log_requestdetail, "Got SortRequest.");
3174 bsrr->num_input_setnames = req->num_inputResultSetNames;
3175 for (i=0;i<req->num_inputResultSetNames;i++)
3176 yaz_log(log_requestdetail, "Input resultset: '%s'",
3177 req->inputResultSetNames[i]);
3178 bsrr->input_setnames = req->inputResultSetNames;
3179 bsrr->referenceId = req->referenceId;
3180 bsrr->output_setname = req->sortedResultSetName;
3181 yaz_log(log_requestdetail, "Output resultset: '%s'",
3182 req->sortedResultSetName);
3183 bsrr->sort_sequence = req->sortSequence;
3184 /*FIXME - dump those sequences too */
3185 bsrr->stream = assoc->encode;
3186 bsrr->print = assoc->print;
3188 bsrr->sort_status = Z_SortResponse_failure;
3190 bsrr->errstring = 0;
3192 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3194 res->referenceId = bsrr->referenceId;
3195 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3196 res->resultSetStatus = 0;
3199 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3200 bsrr->errcode, bsrr->errstring);
3201 res->diagnostics = dr->diagRecs;
3202 res->num_diagnostics = dr->num_diagRecs;
3206 res->num_diagnostics = 0;
3207 res->diagnostics = 0;
3209 res->resultCount = 0;
3212 apdu->which = Z_APDU_sortResponse;
3213 apdu->u.sortResponse = res;
3216 WRBUF wr = wrbuf_alloc();
3217 wrbuf_printf(wr, "Sort ");
3219 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3221 wrbuf_printf(wr, "OK -");
3222 wrbuf_printf(wr, " (");
3223 for (i = 0; i<req->num_inputResultSetNames; i++)
3226 wrbuf_printf(wr, "+");
3227 wrbuf_printf(wr, req->inputResultSetNames[i]);
3229 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3231 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3237 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3241 Z_DeleteResultSetRequest *req =
3242 reqb->apdu_request->u.deleteResultSetRequest;
3243 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3244 odr_malloc (assoc->encode, sizeof(*res));
3245 bend_delete_rr *bdrr = (bend_delete_rr *)
3246 odr_malloc (assoc->encode, sizeof(*bdrr));
3247 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3249 yaz_log(log_requestdetail, "Got DeleteRequest.");
3251 bdrr->num_setnames = req->num_resultSetList;
3252 bdrr->setnames = req->resultSetList;
3253 for (i = 0; i<req->num_resultSetList; i++)
3254 yaz_log(log_requestdetail, "resultset: '%s'",
3255 req->resultSetList[i]);
3256 bdrr->stream = assoc->encode;
3257 bdrr->print = assoc->print;
3258 bdrr->function = *req->deleteFunction;
3259 bdrr->referenceId = req->referenceId;
3261 if (bdrr->num_setnames > 0)
3263 bdrr->statuses = (int*)
3264 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3265 bdrr->num_setnames);
3266 for (i = 0; i < bdrr->num_setnames; i++)
3267 bdrr->statuses[i] = 0;
3269 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3271 res->referenceId = req->referenceId;
3273 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3275 res->deleteListStatuses = 0;
3276 if (bdrr->num_setnames > 0)
3279 res->deleteListStatuses = (Z_ListStatuses *)
3280 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3281 res->deleteListStatuses->num = bdrr->num_setnames;
3282 res->deleteListStatuses->elements =
3284 odr_malloc (assoc->encode,
3285 sizeof(*res->deleteListStatuses->elements) *
3286 bdrr->num_setnames);
3287 for (i = 0; i<bdrr->num_setnames; i++)
3289 res->deleteListStatuses->elements[i] =
3291 odr_malloc (assoc->encode,
3292 sizeof(**res->deleteListStatuses->elements));
3293 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3294 res->deleteListStatuses->elements[i]->id =
3295 odr_strdup (assoc->encode, bdrr->setnames[i]);
3298 res->numberNotDeleted = 0;
3299 res->bulkStatuses = 0;
3300 res->deleteMessage = 0;
3303 apdu->which = Z_APDU_deleteResultSetResponse;
3304 apdu->u.deleteResultSetResponse = res;
3307 WRBUF wr = wrbuf_alloc();
3308 wrbuf_printf(wr, "Delete ");
3309 if (bdrr->delete_status)
3310 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3312 wrbuf_printf(wr, "OK -");
3313 for (i = 0; i<req->num_resultSetList; i++)
3314 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3315 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3321 static void process_close(association *assoc, request *reqb)
3323 Z_Close *req = reqb->apdu_request->u.close;
3324 static char *reasons[] =
3331 "securityViolation",
3338 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3339 reasons[*req->closeReason], req->diagnosticInformation ?
3340 req->diagnosticInformation : "NULL");
3341 if (assoc->version < 3) /* to make do_force respond with close */
3343 do_close_req(assoc, Z_Close_finished,
3344 "Association terminated by client", reqb);
3345 yaz_log(log_request,"Close OK");
3348 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3352 reqb->len_refid = refid->len;
3353 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3354 memcpy (reqb->refid, refid->buf, refid->len);
3358 reqb->len_refid = 0;
3363 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3365 process_z_response (a, req, res);
3368 bend_request bend_request_mk (bend_association a)
3370 request *nreq = request_get (&a->outgoing);
3371 nreq->request_mem = nmem_create ();
3375 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3380 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3381 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3382 id->len = id->size = req->len_refid;
3383 memcpy (id->buf, req->refid, req->len_refid);
3387 void bend_request_destroy (bend_request *req)
3389 nmem_destroy((*req)->request_mem);
3390 request_release(*req);
3394 int bend_backend_respond (bend_association a, bend_request req)
3398 r = process_z_request (a, req, &msg);
3400 yaz_log (YLOG_WARN, "%s", msg);
3404 void bend_request_setdata(bend_request r, void *p)
3409 void *bend_request_getdata(bend_request r)
3411 return r->clientData;
3414 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3416 bend_segment_rr req;
3418 req.segment = reqb->apdu_request->u.segmentRequest;
3419 req.stream = assoc->encode;
3420 req.decode = assoc->decode;
3421 req.print = assoc->print;
3422 req.association = assoc;
3424 (*assoc->init->bend_segment)(assoc->backend, &req);
3429 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3431 bend_esrequest_rr esrequest;
3432 const char *ext_name = "unknown";
3434 Z_ExtendedServicesRequest *req =
3435 reqb->apdu_request->u.extendedServicesRequest;
3436 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3438 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3440 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3441 esrequest.stream = assoc->encode;
3442 esrequest.decode = assoc->decode;
3443 esrequest.print = assoc->print;
3444 esrequest.errcode = 0;
3445 esrequest.errstring = NULL;
3446 esrequest.request = reqb;
3447 esrequest.association = assoc;
3448 esrequest.taskPackage = 0;
3449 esrequest.referenceId = req->referenceId;
3452 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3454 switch(esrequest.esr->taskSpecificParameters->which)
3456 case Z_External_itemOrder:
3457 ext_name = "ItemOrder"; break;
3458 case Z_External_update:
3459 ext_name = "Update"; break;
3460 case Z_External_update0:
3461 ext_name = "Update0"; break;
3462 case Z_External_ESAdmin:
3463 ext_name = "Admin"; break;
3468 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3470 /* If the response is being delayed, return NULL */
3471 if (esrequest.request == NULL)
3474 resp->referenceId = req->referenceId;
3476 if (esrequest.errcode == -1)
3478 /* Backend service indicates request will be processed */
3479 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3480 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3482 else if (esrequest.errcode == 0)
3484 /* Backend service indicates request will be processed */
3485 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3486 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3490 Z_DiagRecs *diagRecs =
3491 zget_DiagRecs(assoc->encode, esrequest.errcode,
3492 esrequest.errstring);
3493 /* Backend indicates error, request will not be processed */
3494 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3495 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3496 resp->num_diagnostics = diagRecs->num_diagRecs;
3497 resp->diagnostics = diagRecs->diagRecs;
3500 WRBUF wr = wrbuf_alloc();
3501 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3502 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3507 /* Do something with the members of bend_extendedservice */
3508 if (esrequest.taskPackage)
3510 resp->taskPackage = z_ext_record_oid(
3511 assoc->encode, yaz_oid_recsyn_extended,
3512 (const char *) esrequest.taskPackage, -1
3515 yaz_log(YLOG_DEBUG,"Send the result apdu");
3519 int bend_assoc_is_alive(bend_association assoc)
3521 if (assoc->state == ASSOC_DEAD)
3522 return 0; /* already marked as dead. Don't check I/O chan anymore */
3524 return iochan_is_alive(assoc->client_chan);
3531 * indent-tabs-mode: nil
3533 * vim: shiftwidth=4 tabstop=8 expandtab