2 * Copyright (C) 1995-2005, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.104 2006-11-14 08:37:38 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>
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>
77 #include <yaz/backend.h>
79 static void process_gdu_request(association *assoc, request *req);
80 static int process_z_request(association *assoc, request *req, char **msg);
81 void backend_response(IOCHAN i, int event);
82 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
83 static int process_z_response(association *assoc, request *req, Z_APDU *res);
84 static Z_APDU *process_initRequest(association *assoc, request *reqb);
85 static Z_External *init_diagnostics(ODR odr, int errcode,
86 const char *errstring);
87 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
89 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
90 bend_search_rr *bsrr, int *fd);
91 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
93 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
94 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
95 static void process_close(association *assoc, request *reqb);
96 void save_referenceId (request *reqb, Z_ReferenceId *refid);
97 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
99 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
101 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
103 /* dynamic logging levels */
104 static int logbits_set = 0;
105 static int log_session = 0; /* one-line logs for session */
106 static int log_sessiondetail = 0; /* more detailed stuff */
107 static int log_request = 0; /* one-line logs for requests */
108 static int log_requestdetail = 0; /* more detailed stuff */
110 /** get_logbits sets global loglevel bits */
111 static void get_logbits(void)
112 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
116 log_session = yaz_log_module_level("session");
117 log_sessiondetail = yaz_log_module_level("sessiondetail");
118 log_request = yaz_log_module_level("request");
119 log_requestdetail = yaz_log_module_level("requestdetail");
125 static void wr_diag(WRBUF w, int error, const char *addinfo)
127 wrbuf_printf(w, "ERROR %d+", error);
128 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
131 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
139 * Create and initialize a new association-handle.
140 * channel : iochannel for the current line.
141 * link : communications channel.
142 * Returns: 0 or a new association handle.
144 association *create_association(IOCHAN channel, COMSTACK link,
145 const char *apdufile)
151 if (!(anew = (association *)xmalloc(sizeof(*anew))))
155 anew->last_control = 0;
156 anew->client_chan = channel;
157 anew->client_link = link;
158 anew->cs_get_mask = 0;
159 anew->cs_put_mask = 0;
160 anew->cs_accept_mask = 0;
161 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
162 !(anew->encode = odr_createmem(ODR_ENCODE)))
164 if (apdufile && *apdufile)
168 if (!(anew->print = odr_createmem(ODR_PRINT)))
170 if (*apdufile == '@')
172 odr_setprint(anew->print, yaz_log_file());
174 else if (*apdufile != '-')
177 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
178 if (!(f = fopen(filename, "w")))
180 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
183 setvbuf(f, 0, _IONBF, 0);
184 odr_setprint(anew->print, f);
189 anew->input_buffer = 0;
190 anew->input_buffer_len = 0;
192 anew->state = ASSOC_NEW;
193 request_initq(&anew->incoming);
194 request_initq(&anew->outgoing);
195 anew->proto = cs_getproto(link);
201 * Free association and release resources.
203 void destroy_association(association *h)
205 statserv_options_block *cb = statserv_getcontrol();
209 odr_destroy(h->decode);
210 odr_destroy(h->encode);
212 odr_destroy(h->print);
214 xfree(h->input_buffer);
216 (*cb->bend_close)(h->backend);
217 while ((req = request_deq(&h->incoming)))
218 request_release(req);
219 while ((req = request_deq(&h->outgoing)))
220 request_release(req);
221 request_delq(&h->incoming);
222 request_delq(&h->outgoing);
224 xmalloc_trav("session closed");
225 if (cb && cb->one_shot)
231 static void do_close_req(association *a, int reason, char *message,
235 Z_Close *cls = zget_Close(a->encode);
237 /* Purge request queue */
238 while (request_deq(&a->incoming));
239 while (request_deq(&a->outgoing));
242 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
243 reason, message ? message : "none");
244 apdu.which = Z_APDU_close;
246 *cls->closeReason = reason;
247 cls->diagnosticInformation = message;
248 process_z_response(a, req, &apdu);
249 iochan_settimeout(a->client_chan, 20);
253 request_release(req);
254 yaz_log(log_requestdetail, "v2 client. No Close PDU");
255 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
258 a->state = ASSOC_DEAD;
261 static void do_close(association *a, int reason, char *message)
263 request *req = request_get(&a->outgoing);
264 do_close_req (a, reason, message, req);
268 * This is where PDUs from the client are read and the further
269 * processing is initiated. Flow of control moves down through the
270 * various process_* functions below, until the encoded result comes back up
271 * to the output handler in here.
273 * h : the I/O channel that has an outstanding event.
274 * event : the current outstanding event.
276 void ir_session(IOCHAN h, int event)
279 association *assoc = (association *)iochan_getdata(h);
280 COMSTACK conn = assoc->client_link;
283 assert(h && conn && assoc);
284 if (event == EVENT_TIMEOUT)
286 if (assoc->state != ASSOC_UP)
288 yaz_log(YLOG_DEBUG, "Final timeout - closing connection.");
289 /* do we need to lod this at all */
291 destroy_association(assoc);
296 yaz_log(log_sessiondetail,
297 "Session idle too long. Sending close.");
298 do_close(assoc, Z_Close_lackOfActivity, 0);
302 if (event & assoc->cs_accept_mask)
304 if (!cs_accept (conn))
306 yaz_log (YLOG_WARN, "accept failed");
307 destroy_association(assoc);
310 iochan_clearflag (h, EVENT_OUTPUT);
311 if (conn->io_pending)
312 { /* cs_accept didn't complete */
313 assoc->cs_accept_mask =
314 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
315 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
317 iochan_setflag (h, assoc->cs_accept_mask);
320 { /* cs_accept completed. Prepare for reading (cs_get) */
321 assoc->cs_accept_mask = 0;
322 assoc->cs_get_mask = EVENT_INPUT;
323 iochan_setflag (h, assoc->cs_get_mask);
327 if ((event & assoc->cs_get_mask) || (event & EVENT_WORK)) /* input */
329 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
331 yaz_log(YLOG_DEBUG, "ir_session (input)");
332 /* We aren't speaking to this fellow */
333 if (assoc->state == ASSOC_DEAD)
335 yaz_log(log_sessiondetail, "Connection closed - end of session");
337 destroy_association(assoc);
341 assoc->cs_get_mask = EVENT_INPUT;
342 res = cs_get(conn, &assoc->input_buffer,
343 &assoc->input_buffer_len);
344 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
346 yaz_log(log_session, "Connection error: %s res=%d",
347 cs_errmsg(cs_errno(conn)), res);
348 req = request_get(&assoc->incoming); /* get a new request */
349 do_close_req(assoc, Z_Close_protocolError,
350 "Incoming package too large", req);
355 yaz_log(log_sessiondetail, "Connection closed by client");
357 destroy_association(assoc);
361 else if (res == 1) /* incomplete read - wait for more */
363 if (conn->io_pending & CS_WANT_WRITE)
364 assoc->cs_get_mask |= EVENT_OUTPUT;
365 iochan_setflag(h, assoc->cs_get_mask);
368 if (cs_more(conn)) /* more stuff - call us again later, please */
369 iochan_setevent(h, EVENT_INPUT);
371 /* we got a complete PDU. Let's decode it */
372 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
373 assoc->input_buffer[0] & 0xff,
374 assoc->input_buffer[1] & 0xff,
375 assoc->input_buffer[2] & 0xff);
376 req = request_get(&assoc->incoming); /* get a new request */
377 odr_reset(assoc->decode);
378 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
379 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
381 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
383 odr_errmsg(odr_geterror(assoc->decode)),
384 odr_getelement(assoc->decode),
385 (long) odr_offset(assoc->decode));
386 if (assoc->decode->error != OHTTP)
388 yaz_log(YLOG_WARN, "PDU dump:");
389 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
390 request_release(req);
391 do_close(assoc, Z_Close_protocolError, "Malformed package");
395 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
396 assoc->state = ASSOC_DEAD;
397 process_gdu_response(assoc, req, p);
401 req->request_mem = odr_extract_mem(assoc->decode);
404 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
405 yaz_log(YLOG_WARN, "ODR print error: %s",
406 odr_errmsg(odr_geterror(assoc->print)));
407 odr_reset(assoc->print);
409 request_enq(&assoc->incoming, req);
412 /* can we do something yet? */
413 req = request_head(&assoc->incoming);
414 if (req->state == REQUEST_IDLE)
416 request_deq(&assoc->incoming);
417 process_gdu_request(assoc, req);
420 if (event & assoc->cs_put_mask)
422 request *req = request_head(&assoc->outgoing);
424 assoc->cs_put_mask = 0;
425 yaz_log(YLOG_DEBUG, "ir_session (output)");
426 req->state = REQUEST_PENDING;
427 switch (res = cs_put(conn, req->response, req->len_response))
430 yaz_log(log_sessiondetail, "Connection closed by client");
432 destroy_association(assoc);
435 case 0: /* all sent - release the request structure */
436 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
438 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
441 nmem_destroy(req->request_mem);
442 request_deq(&assoc->outgoing);
443 request_release(req);
444 if (!request_head(&assoc->outgoing))
445 { /* restore mask for cs_get operation ... */
446 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
447 iochan_setflag(h, assoc->cs_get_mask);
448 if (assoc->state == ASSOC_DEAD)
449 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
453 assoc->cs_put_mask = EVENT_OUTPUT;
457 if (conn->io_pending & CS_WANT_WRITE)
458 assoc->cs_put_mask |= EVENT_OUTPUT;
459 if (conn->io_pending & CS_WANT_READ)
460 assoc->cs_put_mask |= EVENT_INPUT;
461 iochan_setflag(h, assoc->cs_put_mask);
464 if (event & EVENT_EXCEPT)
466 yaz_log(YLOG_WARN, "ir_session (exception)");
468 destroy_association(assoc);
473 static int process_z_request(association *assoc, request *req, char **msg);
476 static void assoc_init_reset(association *assoc)
479 assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
481 assoc->init->stream = assoc->encode;
482 assoc->init->print = assoc->print;
483 assoc->init->auth = 0;
484 assoc->init->referenceId = 0;
485 assoc->init->implementation_version = 0;
486 assoc->init->implementation_id = 0;
487 assoc->init->implementation_name = 0;
488 assoc->init->bend_sort = NULL;
489 assoc->init->bend_search = NULL;
490 assoc->init->bend_present = NULL;
491 assoc->init->bend_esrequest = NULL;
492 assoc->init->bend_delete = NULL;
493 assoc->init->bend_scan = NULL;
494 assoc->init->bend_segment = NULL;
495 assoc->init->bend_fetch = NULL;
496 assoc->init->bend_explain = NULL;
497 assoc->init->bend_srw_scan = NULL;
498 assoc->init->bend_srw_update = NULL;
500 assoc->init->charneg_request = NULL;
501 assoc->init->charneg_response = NULL;
503 assoc->init->decode = assoc->decode;
504 assoc->init->peer_name =
505 odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
507 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
510 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
512 statserv_options_block *cb = statserv_getcontrol();
515 const char *encoding = "UTF-8";
517 bend_initresult *binitres;
519 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
520 assoc_init_reset(assoc);
524 Z_IdAuthentication *auth = odr_malloc(assoc->decode, sizeof(*auth));
527 len = strlen(sr->username) + 1;
529 len += strlen(sr->password) + 2;
530 auth->which = Z_IdAuthentication_open;
531 auth->u.open = odr_malloc(assoc->decode, len);
532 strcpy(auth->u.open, sr->username);
533 if (sr->password && *sr->password)
535 strcat(auth->u.open, "/");
536 strcat(auth->u.open, sr->password);
538 assoc->init->auth = auth;
542 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
543 assoc->init->charneg_request = ce->u.charNeg3;
546 if (!(binitres = (*cb->bend_init)(assoc->init)))
548 assoc->state = ASSOC_DEAD;
549 yaz_add_srw_diagnostic(assoc->encode, d, num,
550 YAZ_SRW_AUTHENTICATION_ERROR, 0);
553 assoc->backend = binitres->handle;
554 assoc->init->auth = 0;
555 if (binitres->errcode)
557 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
558 assoc->state = ASSOC_DEAD;
559 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
560 binitres->errstring);
568 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
571 yaz_record_conv_t rc = 0;
572 const char *match_schema = 0;
573 int *match_syntax = 0;
578 const char *input_schema = yaz_get_esn(rr->comp);
579 Odr_oid *input_syntax_raw = rr->request_format_raw;
581 const char *backend_schema = 0;
582 Odr_oid *backend_syntax = 0;
584 r = yaz_retrieval_request(assoc->server->retrieval,
592 if (r == -1) /* error ? */
594 const char *details = yaz_retrieval_get_error(
595 assoc->server->retrieval);
597 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
599 rr->errstring = odr_strdup(rr->stream, details);
602 else if (r == 1 || r == 3)
604 const char *details = input_schema;
605 rr->errcode = YAZ_BIB1_ELEMENT_SET_NAMES_UNSUPP;
607 rr->errstring = odr_strdup(rr->stream, details);
612 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
613 if (input_syntax_raw)
615 char oidbuf[OID_STR_MAX];
616 oid_to_dotstring(input_syntax_raw, oidbuf);
617 rr->errstring = odr_strdup(rr->stream, oidbuf);
623 yaz_set_esn(&rr->comp, backend_schema, rr->stream->mem);
627 oident *oident_syntax = oid_getentbyoid(backend_syntax);
629 rr->request_format_raw = backend_syntax;
632 rr->request_format = oident_syntax->value;
634 rr->request_format = VAL_NONE;
637 (*assoc->init->bend_fetch)(assoc->backend, rr);
638 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
639 { /* post conversion must take place .. */
640 WRBUF output_record = wrbuf_alloc();
641 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
644 const char *details = yaz_record_conv_get_error(rc);
645 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
647 rr->errstring = odr_strdup(rr->stream, details);
651 rr->len = wrbuf_len(output_record);
652 rr->record = odr_malloc(rr->stream, rr->len);
653 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
655 wrbuf_free(output_record, 1);
659 struct oident *oi = oid_getentbyoid(match_syntax);
660 rr->output_format = oi ? oi->value : VAL_NONE;
661 rr->output_format_raw = match_syntax;
664 rr->schema = odr_strdup(rr->stream, match_schema);
667 (*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 = VAL_TEXT_XML;
683 rr.request_format_raw = yaz_oidval_to_z3950oid(assoc->decode,
686 rr.comp = (Z_RecordComposition *)
687 odr_malloc(assoc->decode, sizeof(*rr.comp));
688 rr.comp->which = Z_RecordComp_complex;
689 rr.comp->u.complex = (Z_CompSpec *)
690 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
691 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
692 odr_malloc(assoc->encode, sizeof(bool_t));
693 *rr.comp->u.complex->selectAlternativeSyntax = 0;
694 rr.comp->u.complex->num_dbSpecific = 0;
695 rr.comp->u.complex->dbSpecific = 0;
696 rr.comp->u.complex->num_recordSyntax = 0;
697 rr.comp->u.complex->recordSyntax = 0;
699 rr.comp->u.complex->generic = (Z_Specification *)
700 odr_malloc(assoc->decode, sizeof(Z_Specification));
702 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
703 rr.comp->u.complex->generic->which = Z_Schema_uri;
704 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
706 /* ESN = recordSchema if recordSchema is present */
707 rr.comp->u.complex->generic->elementSpec = 0;
708 if (srw_req->recordSchema)
710 rr.comp->u.complex->generic->elementSpec =
711 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
712 rr.comp->u.complex->generic->elementSpec->which =
713 Z_ElementSpec_elementSetName;
714 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
715 srw_req->recordSchema;
718 rr.stream = assoc->encode;
719 rr.print = assoc->print;
727 rr.surrogate_flag = 0;
728 rr.schema = srw_req->recordSchema;
730 if (!assoc->init->bend_fetch)
733 retrieve_fetch(assoc, &rr);
735 if (rr.errcode && rr.surrogate_flag)
737 int code = yaz_diag_bib1_to_srw(rr.errcode);
738 const char *message = yaz_diag_srw_str(code);
741 len += strlen(message);
743 len += strlen(rr.errstring);
745 record->recordData_buf = odr_malloc(o, len);
747 sprintf(record->recordData_buf, "<diagnostic "
748 "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
749 " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
751 sprintf(record->recordData_buf + strlen(record->recordData_buf),
752 " <details>%s</details>\n", rr.errstring);
754 sprintf(record->recordData_buf + strlen(record->recordData_buf),
755 " <message>%s</message>\n", message);
756 sprintf(record->recordData_buf + strlen(record->recordData_buf),
758 record->recordData_len = strlen(record->recordData_buf);
759 record->recordPosition = odr_intdup(o, pos);
760 record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
763 else if (rr.len >= 0)
765 record->recordData_buf = rr.record;
766 record->recordData_len = rr.len;
767 record->recordPosition = odr_intdup(o, pos);
769 record->recordSchema = odr_strdup(o, rr.schema);
771 record->recordSchema = 0;
775 *addinfo = rr.errstring;
781 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
782 Z_Query *query_result)
784 /* have a CQL query and CQL to PQF transform .. */
785 CQL_parser cp = cql_parser_create();
791 r = cql_parser_string(cp, cql);
794 /* CQL syntax error */
800 r = cql_transform_buf(ct,
801 cql_parser_result(cp),
802 rpn_buf, sizeof(rpn_buf)-1);
804 srw_errcode = cql_transform_error(ct, &add);
808 /* Syntax & transform OK. */
809 /* Convert PQF string to Z39.50 to RPN query struct */
810 YAZ_PQF_Parser pp = yaz_pqf_create();
811 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
816 int code = yaz_pqf_error(pp, &pqf_msg, &off);
817 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
823 query_result->which = Z_Query_type_1;
824 query_result->u.type_1 = rpnquery;
828 cql_parser_destroy(cp);
832 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
833 Z_AttributesPlusTerm *result)
837 int srw_error = cql2pqf(odr, cql, ct, &query);
840 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
841 return 10; /* bad query type */
842 rpn = query.u.type_1;
843 if (!rpn->RPNStructure)
844 return 10; /* must be structure */
845 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
846 return 10; /* must be simple */
847 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
848 return 10; /* must be attributes plus term node .. */
849 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
854 static void srw_bend_search(association *assoc, request *req,
856 Z_SRW_searchRetrieveResponse *srw_res,
861 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
864 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
865 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
866 if (srw_res->num_diagnostics == 0 && assoc->init)
869 rr.setname = "default";
872 rr.basenames = &srw_req->database;
876 rr.srw_setnameIdleTime = 0;
877 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
878 rr.query->u.type_1 = 0;
880 if (srw_req->query_type == Z_SRW_query_type_cql)
882 if (assoc->server && assoc->server->cql_transform)
884 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
885 assoc->server->cql_transform,
889 yaz_add_srw_diagnostic(assoc->encode,
890 &srw_res->diagnostics,
891 &srw_res->num_diagnostics,
897 /* CQL query to backend. Wrap it - Z39.50 style */
898 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
899 ext->direct_reference = odr_getoidbystr(assoc->decode,
900 "1.2.840.10003.16.2");
901 ext->indirect_reference = 0;
903 ext->which = Z_External_CQL;
904 ext->u.cql = srw_req->query.cql;
906 rr.query->which = Z_Query_type_104;
907 rr.query->u.type_104 = ext;
910 else if (srw_req->query_type == Z_SRW_query_type_pqf)
912 Z_RPNQuery *RPNquery;
913 YAZ_PQF_Parser pqf_parser;
915 pqf_parser = yaz_pqf_create ();
917 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
923 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
924 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
925 code, pqf_msg, (long) off);
926 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
929 rr.query->which = Z_Query_type_1;
930 rr.query->u.type_1 = RPNquery;
932 yaz_pqf_destroy (pqf_parser);
936 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
937 &srw_res->num_diagnostics,
938 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
940 if (rr.query->u.type_1)
942 rr.stream = assoc->encode;
943 rr.decode = assoc->decode;
944 rr.print = assoc->print;
946 if ( srw_req->sort.sortKeys )
947 rr.srw_sortKeys = odr_strdup(assoc->encode,
948 srw_req->sort.sortKeys );
949 rr.association = assoc;
955 yaz_log_zquery_level(log_requestdetail,rr.query);
957 (assoc->init->bend_search)(assoc->backend, &rr);
960 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
966 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
967 yaz_add_srw_diagnostic(assoc->encode,
968 &srw_res->diagnostics,
969 &srw_res->num_diagnostics,
970 srw_error, rr.errstring);
975 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
976 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
978 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
979 start, number, rr.hits);
981 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
984 srw_res->resultSetId =
985 odr_strdup(assoc->encode, rr.srw_setname );
986 srw_res->resultSetIdleTime =
987 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
990 if ((rr.hits > 0 && start > rr.hits) || start < 1)
992 yaz_add_srw_diagnostic(
994 &srw_res->diagnostics, &srw_res->num_diagnostics,
995 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1001 if (start + number > rr.hits)
1002 number = rr.hits - start + 1;
1004 /* Call bend_present if defined */
1005 if (assoc->init->bend_present)
1007 bend_present_rr *bprr = (bend_present_rr*)
1008 odr_malloc (assoc->decode, sizeof(*bprr));
1009 bprr->setname = "default";
1010 bprr->start = start;
1011 bprr->number = number;
1012 bprr->format = VAL_TEXT_XML;
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){
1054 if (!strcmp(srw_req->recordPacking, "xml"))
1055 packing = Z_SRW_recordPacking_XML;
1056 if (!strcmp(srw_req->recordPacking, "url"))
1057 packing = Z_SRW_recordPacking_URL;
1059 srw_res->records = (Z_SRW_record *)
1060 odr_malloc(assoc->encode,
1061 number * sizeof(*srw_res->records));
1063 srw_res->extra_records = (Z_SRW_extra_record **)
1064 odr_malloc(assoc->encode,
1065 number*sizeof(*srw_res->extra_records));
1067 for (i = 0; i<number; i++)
1070 const char *addinfo = 0;
1072 srw_res->records[j].recordPacking = packing;
1073 srw_res->records[j].recordData_buf = 0;
1074 srw_res->extra_records[j] = 0;
1075 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1076 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1077 srw_res->records + j,
1081 yaz_add_srw_diagnostic(assoc->encode,
1082 &srw_res->diagnostics,
1083 &srw_res->num_diagnostics,
1084 yaz_diag_bib1_to_srw (errcode),
1089 if (srw_res->records[j].recordData_buf)
1092 srw_res->num_records = j;
1094 srw_res->records = 0;
1102 const char *querystr = "?";
1103 const char *querytype = "?";
1104 WRBUF wr = wrbuf_alloc();
1106 switch (srw_req->query_type)
1108 case Z_SRW_query_type_cql:
1110 querystr = srw_req->query.cql;
1112 case Z_SRW_query_type_pqf:
1114 querystr = srw_req->query.pqf;
1117 wrbuf_printf(wr, "SRWSearch ");
1118 wrbuf_printf(wr, srw_req->database);
1119 wrbuf_printf(wr, " ");
1120 if (srw_res->num_diagnostics)
1121 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1122 else if (*http_code != 200)
1123 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1124 else if (srw_res->numberOfRecords)
1126 wrbuf_printf(wr, "OK %d",
1127 (srw_res->numberOfRecords ?
1128 *srw_res->numberOfRecords : 0));
1130 wrbuf_printf(wr, " %s %d+%d",
1131 (srw_res->resultSetId ?
1132 srw_res->resultSetId : "-"),
1133 (srw_req->startRecord ? *srw_req->startRecord : 1),
1134 srw_res->num_records);
1135 yaz_log(log_request, "%s %s: %s", wrbuf_buf(wr), querytype, querystr);
1140 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1143 xmlNodePtr ptr = rr->server_node_ptr;
1146 for (ptr = ptr->children; ptr; ptr = ptr->next)
1148 if (ptr->type != XML_ELEMENT_NODE)
1150 if (!strcmp((const char *) ptr->name, "explain"))
1153 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1157 ptr = xmlCopyNode(ptr, 1);
1159 xmlDocSetRootElement(doc, ptr);
1161 xmlDocDumpMemory(doc, &buf_out, &len);
1162 content = (char*) odr_malloc(rr->stream, 1+len);
1163 memcpy(content, buf_out, len);
1164 content[len] = '\0';
1168 rr->explain_buf = content;
1176 static void srw_bend_explain(association *assoc, request *req,
1178 Z_SRW_explainResponse *srw_res,
1181 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1182 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1184 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1189 rr.stream = assoc->encode;
1190 rr.decode = assoc->decode;
1191 rr.print = assoc->print;
1193 rr.database = srw_req->database;
1195 rr.server_node_ptr = assoc->server->server_node_ptr;
1197 rr.server_node_ptr = 0;
1198 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1199 if (assoc->init->bend_explain)
1200 (*assoc->init->bend_explain)(assoc->backend, &rr);
1202 srw_bend_explain_default(assoc->backend, &rr);
1206 int packing = Z_SRW_recordPacking_string;
1207 if (srw_req->recordPacking)
1209 if (!strcmp(srw_req->recordPacking, "xml"))
1210 packing = Z_SRW_recordPacking_XML;
1211 else if (!strcmp(srw_req->recordPacking, "url"))
1212 packing = Z_SRW_recordPacking_URL;
1214 srw_res->record.recordSchema = rr.schema;
1215 srw_res->record.recordPacking = packing;
1216 srw_res->record.recordData_buf = rr.explain_buf;
1217 srw_res->record.recordData_len = strlen(rr.explain_buf);
1218 srw_res->record.recordPosition = 0;
1224 static void srw_bend_scan(association *assoc, request *req,
1226 Z_SRW_scanResponse *srw_res,
1229 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1230 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1233 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1234 if (srw_res->num_diagnostics == 0 && assoc->init)
1236 struct scan_entry *save_entries;
1238 bend_scan_rr *bsrr = (bend_scan_rr *)
1239 odr_malloc (assoc->encode, sizeof(*bsrr));
1240 bsrr->num_bases = 1;
1241 bsrr->basenames = &srw_req->database;
1243 bsrr->num_entries = srw_req->maximumTerms ?
1244 *srw_req->maximumTerms : 10;
1245 bsrr->term_position = srw_req->responsePosition ?
1246 *srw_req->responsePosition : 1;
1249 bsrr->errstring = 0;
1250 bsrr->referenceId = 0;
1251 bsrr->stream = assoc->encode;
1252 bsrr->print = assoc->print;
1253 bsrr->step_size = odr_intdup(assoc->decode, 0);
1256 if (bsrr->num_entries > 0)
1259 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1261 for (i = 0; i<bsrr->num_entries; i++)
1263 bsrr->entries[i].term = 0;
1264 bsrr->entries[i].occurrences = 0;
1265 bsrr->entries[i].errcode = 0;
1266 bsrr->entries[i].errstring = 0;
1267 bsrr->entries[i].display_term = 0;
1270 save_entries = bsrr->entries; /* save it so we can compare later */
1272 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1273 assoc->init->bend_scan)
1275 Odr_oid *scan_attributeSet = 0;
1277 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1279 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1281 srw_req->scanClause.pqf);
1282 if (scan_attributeSet &&
1283 (attset = oid_getentbyoid(scan_attributeSet)) &&
1284 (attset->oclass == CLASS_ATTSET ||
1285 attset->oclass == CLASS_GENERAL))
1286 bsrr->attributeset = attset->value;
1288 bsrr->attributeset = VAL_NONE;
1289 yaz_pqf_destroy(pqf_parser);
1290 bsrr->scanClause = 0;
1291 ((int (*)(void *, bend_scan_rr *))
1292 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1294 else if (srw_req->query_type == Z_SRW_query_type_cql
1295 && assoc->init->bend_scan && assoc->server
1296 && assoc->server->cql_transform)
1299 bsrr->scanClause = 0;
1300 bsrr->attributeset = VAL_NONE;
1301 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1302 srw_error = cql2pqf_scan(assoc->encode,
1303 srw_req->scanClause.cql,
1304 assoc->server->cql_transform,
1307 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1308 &srw_res->num_diagnostics,
1312 ((int (*)(void *, bend_scan_rr *))
1313 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1316 else if (srw_req->query_type == Z_SRW_query_type_cql
1317 && assoc->init->bend_srw_scan)
1320 bsrr->attributeset = VAL_NONE;
1321 bsrr->scanClause = srw_req->scanClause.cql;
1322 ((int (*)(void *, bend_scan_rr *))
1323 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1327 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1328 &srw_res->num_diagnostics,
1329 YAZ_SRW_UNSUPP_OPERATION, "scan");
1334 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1339 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1341 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1342 &srw_res->num_diagnostics,
1343 srw_error, bsrr->errstring);
1345 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1348 srw_res->terms = (Z_SRW_scanTerm*)
1349 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1352 srw_res->num_terms = bsrr->num_entries;
1353 for (i = 0; i<bsrr->num_entries; i++)
1355 Z_SRW_scanTerm *t = srw_res->terms + i;
1356 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1357 t->numberOfRecords =
1358 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1360 if (save_entries == bsrr->entries &&
1361 bsrr->entries[i].display_term)
1363 /* the entries was _not_ set by the handler. So it's
1364 safe to test for new member display_term. It is
1367 t->displayTerm = odr_strdup(assoc->encode,
1368 bsrr->entries[i].display_term);
1376 WRBUF wr = wrbuf_alloc();
1377 const char *querytype = 0;
1378 const char *querystr = 0;
1380 switch(srw_req->query_type)
1382 case Z_SRW_query_type_pqf:
1384 querystr = srw_req->scanClause.pqf;
1386 case Z_SRW_query_type_cql:
1388 querystr = srw_req->scanClause.cql;
1391 querytype = "UNKNOWN";
1395 wrbuf_printf(wr, "SRWScan ");
1396 wrbuf_printf(wr, srw_req->database);
1397 wrbuf_printf(wr, " ");
1399 if (srw_res->num_diagnostics)
1400 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1401 else if (srw_res->num_terms)
1402 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1404 wrbuf_printf(wr, "OK - - ");
1406 wrbuf_printf(wr, "%d+%d+0 ",
1407 (srw_req->responsePosition ?
1408 *srw_req->responsePosition : 1),
1409 (srw_req->maximumTerms ?
1410 *srw_req->maximumTerms : 1));
1411 /* there is no step size in SRU/W ??? */
1412 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1413 yaz_log(log_request, "%s ", wrbuf_buf(wr) );
1419 static void srw_bend_update(association *assoc, request *req,
1421 Z_SRW_updateResponse *srw_res,
1424 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1425 yaz_log(YLOG_DEBUG, "Got SRW UpdateRequest");
1426 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1428 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1433 rr.stream = assoc->encode;
1434 rr.print = assoc->print;
1436 rr.basenames = &srw_req->database;
1437 rr.operation = srw_req->operation;
1438 rr.operation_status = "failed";
1440 rr.record_version = 0;
1441 rr.record_checksum = 0;
1442 rr.record_old_version = 0;
1443 rr.record_packing = "xml";
1444 rr.record_schema = 0;
1446 rr.request_extra_record = 0;
1447 rr.response_extra_record = 0;
1448 rr.extra_request_data = 0;
1449 rr.extra_response_data = 0;
1454 if ( rr.operation == 0 ){
1455 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1456 &srw_res->num_diagnostics,
1460 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1461 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1462 if ( !strcmp( rr.operation, "delete" ) ){
1463 if ( !srw_req->recordId ){
1464 if ( srw_req->record.recordData_len ){
1465 if ( srw_req->record.recordSchema == 0 ){
1466 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1467 &srw_res->num_diagnostics,
1468 9, "recordSchema" );
1471 rr.record_schema = odr_strdup(assoc->encode,
1472 srw_req->record.recordSchema );
1474 switch (srw_req->record.recordPacking)
1476 case Z_SRW_recordPacking_string:
1477 rr.record_packing = "string";
1479 case Z_SRW_recordPacking_XML:
1480 rr.record_packing = "xml";
1482 case Z_SRW_recordPacking_URL:
1483 rr.record_packing = "url";
1486 rr.record_data = odr_strdupn(assoc->encode,
1487 srw_req->record.recordData_buf,
1488 srw_req->record.recordData_len );
1489 rr.request_extra_record = srw_req->extra_record;
1492 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1493 &srw_res->num_diagnostics,
1494 9, "recordIdentifier OR recordData" );
1498 rr.record_id = srw_req->recordId;
1499 if ( srw_req->record.recordData_len ){
1500 yaz_add_sru_update_diagnostic(assoc->encode,
1501 &srw_res->diagnostics,
1502 &srw_res->num_diagnostics,
1506 if ( srw_req->recordVersion ){
1507 rr.record_version = odr_strdup( assoc->encode,
1508 srw_req->recordVersion );
1511 if ( srw_req->recordOldVersion ){
1512 rr.record_old_version = odr_strdup(assoc->encode,
1513 srw_req->recordOldVersion );
1515 if ( srw_req->extraRequestData ){
1516 rr.extra_request_data = odr_strdup(assoc->encode,
1517 srw_req->extraRequestData );
1520 else if ( !strcmp( rr.operation, "replace" ) ){
1521 if ( !srw_req->recordId ){
1522 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1523 &srw_res->num_diagnostics,
1524 9, "recordIdentifier" );
1527 rr.record_id = srw_req->recordId;
1529 if ( srw_req->record.recordSchema == 0 ){
1530 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1531 &srw_res->num_diagnostics,
1532 9, "recordSchema" );
1535 rr.record_schema = odr_strdup(assoc->encode,
1536 srw_req->record.recordSchema );
1538 switch (srw_req->record.recordPacking)
1540 case Z_SRW_recordPacking_string:
1541 rr.record_packing = "string";
1543 case Z_SRW_recordPacking_XML:
1544 rr.record_packing = "xml";
1546 case Z_SRW_recordPacking_URL:
1547 rr.record_packing = "url";
1550 if ( srw_req->record.recordData_len ){
1551 rr.record_data = odr_strdupn(assoc->encode,
1552 srw_req->record.recordData_buf,
1553 srw_req->record.recordData_len );
1554 rr.request_extra_record = srw_req->extra_record;
1557 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1558 &srw_res->num_diagnostics,
1561 if (srw_req->extraRequestData)
1562 rr.extra_request_data = odr_strdup(assoc->encode,
1563 srw_req->extraRequestData );
1565 else if (!strcmp( rr.operation, "insert" ) ) {
1566 rr.record_id = srw_req->recordId;
1567 if ( srw_req->record.recordSchema == 0 ){
1568 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1569 &srw_res->num_diagnostics,
1570 9, "recordSchema" );
1573 rr.record_schema = odr_strdup(assoc->encode,
1574 srw_req->record.recordSchema);
1576 switch (srw_req->record.recordPacking)
1578 case Z_SRW_recordPacking_string:
1579 rr.record_packing = "string";
1581 case Z_SRW_recordPacking_XML:
1582 rr.record_packing = "xml";
1584 case Z_SRW_recordPacking_URL:
1585 rr.record_packing = "url";
1589 if (srw_req->record.recordData_len)
1591 rr.record_data = odr_strdupn(assoc->encode,
1592 srw_req->record.recordData_buf,
1593 srw_req->record.recordData_len );
1594 rr.request_extra_record = srw_req->extra_record;
1597 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1598 &srw_res->num_diagnostics,
1600 if ( srw_req->extraRequestData )
1601 rr.extra_request_data = odr_strdup(assoc->encode,
1602 srw_req->extraRequestData );
1605 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1606 &srw_res->num_diagnostics,
1607 100, rr.operation );
1609 if (srw_res->num_diagnostics == 0)
1611 if ( assoc->init->bend_srw_update)
1612 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1614 yaz_log( YLOG_WARN, "Got No Update function!");
1620 yaz_add_srw_diagnostic_uri(assoc->encode,
1621 &srw_res->diagnostics,
1622 &srw_res->num_diagnostics,
1626 srw_res->recordId = rr.record_id;
1627 srw_res->operationStatus = rr.operation_status;
1628 srw_res->recordVersion = rr.record_version;
1629 srw_res->recordChecksum = rr.record_checksum;
1630 srw_res->extraResponseData = rr.extra_response_data;
1631 srw_res->record.recordPosition = 0;
1632 if (srw_res->num_diagnostics == 0 && rr.record_data)
1634 srw_res->record.recordSchema = rr.record_schema;
1635 srw_res->record.recordPacking = srw_req->record.recordPacking;
1636 srw_res->record.recordData_buf = rr.record_data;
1637 srw_res->record.recordData_len = strlen(rr.record_data);
1638 srw_res->extra_record = rr.response_extra_record;
1642 srw_res->record.recordData_len = 0;
1647 /* check if path is OK (1); BAD (0) */
1648 static int check_path(const char *path)
1652 if (strstr(path, ".."))
1657 static char *read_file(const char *fname, ODR o, int *sz)
1660 FILE *inf = fopen(fname, "rb");
1664 fseek(inf, 0L, SEEK_END);
1667 buf = odr_malloc(o, *sz);
1668 fread(buf, 1, *sz, inf);
1673 static void process_http_request(association *assoc, request *req)
1675 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1676 ODR o = assoc->encode;
1677 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1679 Z_SOAP *soap_package = 0;
1682 Z_HTTP_Response *hres = 0;
1684 const char *stylesheet = 0; /* for now .. set later */
1685 Z_SRW_diagnostic *diagnostic = 0;
1686 int num_diagnostic = 0;
1687 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1689 if (!control_association(assoc, host, 0))
1691 p = z_get_HTTP_Response(o, 404);
1694 if (r == 2 && assoc->server && assoc->server->docpath
1695 && hreq->path[0] == '/'
1697 /* check if path is a proper prefix of documentroot */
1698 strncmp(hreq->path+1, assoc->server->docpath,
1699 strlen(assoc->server->docpath))
1702 if (!check_path(hreq->path))
1704 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1705 p = z_get_HTTP_Response(o, 404);
1709 int content_size = 0;
1710 char *content_buf = read_file(hreq->path+1, o, &content_size);
1713 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1714 p = z_get_HTTP_Response(o, 404);
1718 const char *ctype = 0;
1719 yaz_mime_types types = yaz_mime_types_create();
1721 yaz_mime_types_add(types, "xsl", "application/xml");
1722 yaz_mime_types_add(types, "xml", "application/xml");
1723 yaz_mime_types_add(types, "css", "text/css");
1724 yaz_mime_types_add(types, "html", "text/html");
1725 yaz_mime_types_add(types, "htm", "text/html");
1726 yaz_mime_types_add(types, "txt", "text/plain");
1727 yaz_mime_types_add(types, "js", "application/x-javascript");
1729 yaz_mime_types_add(types, "gif", "image/gif");
1730 yaz_mime_types_add(types, "png", "image/png");
1731 yaz_mime_types_add(types, "jpg", "image/jpeg");
1732 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1734 ctype = yaz_mime_lookup_fname(types, hreq->path);
1737 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1738 p = z_get_HTTP_Response(o, 404);
1742 p = z_get_HTTP_Response(o, 200);
1743 hres = p->u.HTTP_Response;
1744 hres->content_buf = content_buf;
1745 hres->content_len = content_size;
1746 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1748 yaz_mime_types_destroy(types);
1756 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1757 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1759 if (r == 2) /* not taken */
1761 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1762 &diagnostic, &num_diagnostic);
1763 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1765 if (r == 0) /* decode SRW/SRU OK .. */
1767 int http_code = 200;
1768 if (sr->which == Z_SRW_searchRetrieve_request)
1771 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1773 stylesheet = sr->u.request->stylesheet;
1776 res->u.response->diagnostics = diagnostic;
1777 res->u.response->num_diagnostics = num_diagnostic;
1781 srw_bend_search(assoc, req, sr, res->u.response,
1784 if (http_code == 200)
1785 soap_package->u.generic->p = res;
1787 else if (sr->which == Z_SRW_explain_request)
1789 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1790 stylesheet = sr->u.explain_request->stylesheet;
1793 res->u.explain_response->diagnostics = diagnostic;
1794 res->u.explain_response->num_diagnostics = num_diagnostic;
1796 srw_bend_explain(assoc, req, sr,
1797 res->u.explain_response, &http_code);
1798 if (http_code == 200)
1799 soap_package->u.generic->p = res;
1801 else if (sr->which == Z_SRW_scan_request)
1803 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1804 stylesheet = sr->u.scan_request->stylesheet;
1807 res->u.scan_response->diagnostics = diagnostic;
1808 res->u.scan_response->num_diagnostics = num_diagnostic;
1810 srw_bend_scan(assoc, req, sr,
1811 res->u.scan_response, &http_code);
1812 if (http_code == 200)
1813 soap_package->u.generic->p = res;
1815 else if (sr->which == Z_SRW_update_request)
1817 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1818 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1821 res->u.update_response->diagnostics = diagnostic;
1822 res->u.update_response->num_diagnostics = num_diagnostic;
1824 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1825 srw_bend_update(assoc, req, sr,
1826 res->u.update_response, &http_code);
1827 if (http_code == 200)
1828 soap_package->u.generic->p = res;
1832 yaz_log(log_request, "SOAP ERROR");
1833 /* FIXME - what error, what query */
1835 z_soap_error(assoc->encode, soap_package,
1836 "SOAP-ENV:Client", "Bad method", 0);
1838 if (http_code == 200 || http_code == 500)
1840 static Z_SOAP_Handler soap_handlers[4] = {
1842 {"http://www.loc.gov/zing/srw/", 0,
1843 (Z_SOAP_fun) yaz_srw_codec},
1844 {"http://www.loc.gov/zing/srw/v1.0/", 0,
1845 (Z_SOAP_fun) yaz_srw_codec},
1846 {"http://www.loc.gov/zing/srw/update/", 0,
1847 (Z_SOAP_fun) yaz_ucp_codec},
1853 p = z_get_HTTP_Response(o, 200);
1854 hres = p->u.HTTP_Response;
1856 if (!stylesheet && assoc->server)
1857 stylesheet = assoc->server->stylesheet;
1859 /* empty stylesheet means NO stylesheet */
1860 if (stylesheet && *stylesheet == '\0')
1863 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1864 &hres->content_buf, &hres->content_len,
1865 soap_handlers, charset, stylesheet);
1866 hres->code = http_code;
1868 strcpy(ctype, "text/xml");
1871 strcat(ctype, "; charset=");
1872 strcat(ctype, charset);
1874 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1877 p = z_get_HTTP_Response(o, http_code);
1881 p = z_get_HTTP_Response(o, 500);
1882 hres = p->u.HTTP_Response;
1883 if (!strcmp(hreq->version, "1.0"))
1885 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1886 if (v && !strcmp(v, "Keep-Alive"))
1890 hres->version = "1.0";
1894 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1895 if (v && !strcmp(v, "close"))
1899 hres->version = "1.1";
1903 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1904 assoc->state = ASSOC_DEAD;
1905 assoc->cs_get_mask = 0;
1910 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1912 if (alive && isdigit(*(const unsigned char *) alive))
1916 if (t < 0 || t > 3600)
1918 iochan_settimeout(assoc->client_chan,t);
1919 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1921 process_gdu_response(assoc, req, p);
1924 static void process_gdu_request(association *assoc, request *req)
1926 if (req->gdu_request->which == Z_GDU_Z3950)
1929 req->apdu_request = req->gdu_request->u.z3950;
1930 if (process_z_request(assoc, req, &msg) < 0)
1931 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1933 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1934 process_http_request(assoc, req);
1937 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1942 * Initiate request processing.
1944 static int process_z_request(association *assoc, request *req, char **msg)
1950 *msg = "Unknown Error";
1951 assert(req && req->state == REQUEST_IDLE);
1952 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1954 *msg = "Missing InitRequest";
1957 switch (req->apdu_request->which)
1959 case Z_APDU_initRequest:
1960 res = process_initRequest(assoc, req); break;
1961 case Z_APDU_searchRequest:
1962 res = process_searchRequest(assoc, req, &fd); break;
1963 case Z_APDU_presentRequest:
1964 res = process_presentRequest(assoc, req, &fd); break;
1965 case Z_APDU_scanRequest:
1966 if (assoc->init->bend_scan)
1967 res = process_scanRequest(assoc, req, &fd);
1970 *msg = "Cannot handle Scan APDU";
1974 case Z_APDU_extendedServicesRequest:
1975 if (assoc->init->bend_esrequest)
1976 res = process_ESRequest(assoc, req, &fd);
1979 *msg = "Cannot handle Extended Services APDU";
1983 case Z_APDU_sortRequest:
1984 if (assoc->init->bend_sort)
1985 res = process_sortRequest(assoc, req, &fd);
1988 *msg = "Cannot handle Sort APDU";
1993 process_close(assoc, req);
1995 case Z_APDU_deleteResultSetRequest:
1996 if (assoc->init->bend_delete)
1997 res = process_deleteRequest(assoc, req, &fd);
2000 *msg = "Cannot handle Delete APDU";
2004 case Z_APDU_segmentRequest:
2005 if (assoc->init->bend_segment)
2007 res = process_segmentRequest (assoc, req);
2011 *msg = "Cannot handle Segment APDU";
2015 case Z_APDU_triggerResourceControlRequest:
2018 *msg = "Bad APDU received";
2023 yaz_log(YLOG_DEBUG, " result immediately available");
2024 retval = process_z_response(assoc, req, res);
2028 yaz_log(YLOG_DEBUG, " result unavailble");
2031 else /* no result yet - one will be provided later */
2035 /* Set up an I/O handler for the fd supplied by the backend */
2037 yaz_log(YLOG_DEBUG, " establishing handler for result");
2038 req->state = REQUEST_PENDING;
2039 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2041 iochan_setdata(chan, assoc);
2048 * Handle message from the backend.
2050 void backend_response(IOCHAN i, int event)
2052 association *assoc = (association *)iochan_getdata(i);
2053 request *req = request_head(&assoc->incoming);
2057 yaz_log(YLOG_DEBUG, "backend_response");
2058 assert(assoc && req && req->state != REQUEST_IDLE);
2059 /* determine what it is we're waiting for */
2060 switch (req->apdu_request->which)
2062 case Z_APDU_searchRequest:
2063 res = response_searchRequest(assoc, req, 0, &fd); break;
2065 case Z_APDU_presentRequest:
2066 res = response_presentRequest(assoc, req, 0, &fd); break;
2067 case Z_APDU_scanRequest:
2068 res = response_scanRequest(assoc, req, 0, &fd); break;
2071 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2074 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2076 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2077 do_close(assoc, Z_Close_systemProblem, 0);
2081 else if (!res) /* no result yet - try again later */
2083 yaz_log(YLOG_DEBUG, " no result yet");
2084 iochan_setfd(i, fd); /* in case fd has changed */
2089 * Encode response, and transfer the request structure to the outgoing queue.
2091 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2093 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2097 if (!z_GDU(assoc->print, &res, 0, 0))
2098 yaz_log(YLOG_WARN, "ODR print error: %s",
2099 odr_errmsg(odr_geterror(assoc->print)));
2100 odr_reset(assoc->print);
2102 if (!z_GDU(assoc->encode, &res, 0, 0))
2104 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2105 odr_errmsg(odr_geterror(assoc->decode)),
2106 odr_getelement(assoc->decode));
2109 req->response = odr_getbuf(assoc->encode, &req->len_response,
2110 &req->size_response);
2111 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2112 odr_reset(assoc->encode);
2113 req->state = REQUEST_IDLE;
2114 request_enq(&assoc->outgoing, req);
2115 /* turn the work over to the ir_session handler */
2116 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2117 assoc->cs_put_mask = EVENT_OUTPUT;
2118 /* Is there more work to be done? give that to the input handler too */
2120 if (request_head(&assoc->incoming))
2122 yaz_log (YLOG_DEBUG, "more work to be done");
2123 iochan_setevent(assoc->client_chan, EVENT_WORK);
2130 * Encode response, and transfer the request structure to the outgoing queue.
2132 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2134 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2135 gres->which = Z_GDU_Z3950;
2136 gres->u.z3950 = res;
2138 return process_gdu_response(assoc, req, gres);
2141 static char *get_vhost(Z_OtherInformation *otherInfo)
2143 return yaz_oi_get_string_oidval(&otherInfo, VAL_PROXY, 1, 0);
2147 * Handle init request.
2148 * At the moment, we don't check the options
2149 * anywhere else in the code - we just try not to do anything that would
2150 * break a naive client. We'll toss 'em into the association block when
2151 * we need them there.
2153 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2155 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2156 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2157 Z_InitResponse *resp = apdu->u.initResponse;
2158 bend_initresult *binitres;
2161 statserv_options_block *cb = 0; /* by default no control for backend */
2163 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2164 cb = statserv_getcontrol(); /* got control block for backend */
2166 if (cb && assoc->backend)
2167 (*cb->bend_close)(assoc->backend);
2169 yaz_log(log_requestdetail, "Got initRequest");
2170 if (req->implementationId)
2171 yaz_log(log_requestdetail, "Id: %s",
2172 req->implementationId);
2173 if (req->implementationName)
2174 yaz_log(log_requestdetail, "Name: %s",
2175 req->implementationName);
2176 if (req->implementationVersion)
2177 yaz_log(log_requestdetail, "Version: %s",
2178 req->implementationVersion);
2180 assoc_init_reset(assoc);
2182 assoc->init->auth = req->idAuthentication;
2183 assoc->init->referenceId = req->referenceId;
2185 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2187 Z_CharSetandLanguageNegotiation *negotiation =
2188 yaz_get_charneg_record (req->otherInfo);
2190 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2191 assoc->init->charneg_request = negotiation;
2197 if (req->implementationVersion)
2198 yaz_log(log_requestdetail, "Config: %s",
2201 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2203 /* we have a backend control block, so call that init function */
2204 if (!(binitres = (*cb->bend_init)(assoc->init)))
2206 yaz_log(YLOG_WARN, "Bad response from backend.");
2209 assoc->backend = binitres->handle;
2213 /* no backend. return error */
2214 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2215 binitres->errstring = 0;
2216 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2217 iochan_settimeout(assoc->client_chan, 10);
2219 if ((assoc->init->bend_sort))
2220 yaz_log (YLOG_DEBUG, "Sort handler installed");
2221 if ((assoc->init->bend_search))
2222 yaz_log (YLOG_DEBUG, "Search handler installed");
2223 if ((assoc->init->bend_present))
2224 yaz_log (YLOG_DEBUG, "Present handler installed");
2225 if ((assoc->init->bend_esrequest))
2226 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2227 if ((assoc->init->bend_delete))
2228 yaz_log (YLOG_DEBUG, "Delete handler installed");
2229 if ((assoc->init->bend_scan))
2230 yaz_log (YLOG_DEBUG, "Scan handler installed");
2231 if ((assoc->init->bend_segment))
2232 yaz_log (YLOG_DEBUG, "Segment handler installed");
2234 resp->referenceId = req->referenceId;
2236 /* let's tell the client what we can do */
2237 if (ODR_MASK_GET(req->options, Z_Options_search))
2239 ODR_MASK_SET(resp->options, Z_Options_search);
2240 strcat(options, "srch");
2242 if (ODR_MASK_GET(req->options, Z_Options_present))
2244 ODR_MASK_SET(resp->options, Z_Options_present);
2245 strcat(options, " prst");
2247 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2248 assoc->init->bend_delete)
2250 ODR_MASK_SET(resp->options, Z_Options_delSet);
2251 strcat(options, " del");
2253 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2254 assoc->init->bend_esrequest)
2256 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2257 strcat (options, " extendedServices");
2259 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2261 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2262 strcat(options, " namedresults");
2264 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2266 ODR_MASK_SET(resp->options, Z_Options_scan);
2267 strcat(options, " scan");
2269 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2271 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2272 strcat(options, " concurrop");
2274 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2276 ODR_MASK_SET(resp->options, Z_Options_sort);
2277 strcat(options, " sort");
2280 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
2281 && assoc->init->charneg_response)
2283 Z_OtherInformation **p;
2284 Z_OtherInformationUnit *p0;
2286 yaz_oi_APDU(apdu, &p);
2288 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2289 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2291 p0->which = Z_OtherInfo_externallyDefinedInfo;
2292 p0->information.externallyDefinedInfo =
2293 assoc->init->charneg_response;
2295 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2296 strcat(options, " negotiation");
2299 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2300 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2302 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2304 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2305 assoc->version = 1; /* 1 & 2 are equivalent */
2307 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2309 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2312 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2314 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2318 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2320 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2321 assoc->maximumRecordSize = *req->maximumRecordSize;
2323 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2324 assoc->preferredMessageSize = *req->preferredMessageSize;
2326 resp->preferredMessageSize = &assoc->preferredMessageSize;
2327 resp->maximumRecordSize = &assoc->maximumRecordSize;
2329 resp->implementationId = odr_prepend(assoc->encode,
2330 assoc->init->implementation_id,
2331 resp->implementationId);
2333 resp->implementationName = odr_prepend(assoc->encode,
2334 assoc->init->implementation_name,
2335 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2337 version = odr_strdup(assoc->encode, "$Revision: 1.104 $");
2338 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2339 version[strlen(version)-2] = '\0';
2340 resp->implementationVersion = odr_prepend(assoc->encode,
2341 assoc->init->implementation_version,
2342 odr_prepend(assoc->encode, &version[11],
2343 resp->implementationVersion));
2345 if (binitres->errcode)
2347 assoc->state = ASSOC_DEAD;
2348 resp->userInformationField =
2349 init_diagnostics(assoc->encode, binitres->errcode,
2350 binitres->errstring);
2355 if (!req->idAuthentication)
2356 yaz_log(log_request, "Auth none");
2357 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2359 const char *open = req->idAuthentication->u.open;
2360 const char *slash = strchr(open, '/');
2366 yaz_log(log_request, "Auth open %.*s", len, open);
2368 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2370 const char *user = req->idAuthentication->u.idPass->userId;
2371 const char *group = req->idAuthentication->u.idPass->groupId;
2372 yaz_log(log_request, "Auth idPass %s %s",
2373 user ? user : "-", group ? group : "-");
2375 else if (req->idAuthentication->which
2376 == Z_IdAuthentication_anonymous)
2378 yaz_log(log_request, "Auth anonymous");
2382 yaz_log(log_request, "Auth other");
2387 WRBUF wr = wrbuf_alloc();
2388 wrbuf_printf(wr, "Init ");
2389 if (binitres->errcode)
2390 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2392 wrbuf_printf(wr, "OK -");
2393 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2394 (req->implementationId ? req->implementationId :"-"),
2395 (req->implementationName ?
2396 req->implementationName : "-"),
2397 (req->implementationVersion ?
2398 req->implementationVersion : "-")
2400 yaz_log(log_request, "%s", wrbuf_buf(wr));
2407 * Set the specified `errcode' and `errstring' into a UserInfo-1
2408 * external to be returned to the client in accordance with Z35.90
2409 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2410 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2412 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2414 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2415 addinfo ? " -- " : "", addinfo ? addinfo : "");
2416 return zget_init_diagnostics(odr, error, addinfo);
2420 * nonsurrogate diagnostic record.
2422 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2424 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2426 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2427 addinfo ? " -- " : "", addinfo ? addinfo : "");
2429 rec->which = Z_Records_NSD;
2430 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2436 * surrogate diagnostic.
2438 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2440 int error, const char *addinfo)
2442 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2443 addinfo ? " -- " : "", addinfo ? addinfo : "");
2444 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2447 static Z_Records *pack_records(association *a, char *setname, int start,
2448 int *num, Z_RecordComposition *comp,
2449 int *next, int *pres, oid_value format,
2450 Z_ReferenceId *referenceId,
2451 int *oid, int *errcode)
2453 int recno, total_length = 0, toget = *num, dumped_records = 0;
2454 Z_Records *records =
2455 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2456 Z_NamePlusRecordList *reclist =
2457 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2458 Z_NamePlusRecord **list =
2459 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2461 records->which = Z_Records_DBOSD;
2462 records->u.databaseOrSurDiagnostics = reclist;
2463 reclist->num_records = 0;
2464 reclist->records = list;
2465 *pres = Z_PresentStatus_success;
2469 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2470 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2471 a->maximumRecordSize);
2472 for (recno = start; reclist->num_records < toget; recno++)
2475 Z_NamePlusRecord *thisrec;
2476 int this_length = 0;
2478 * we get the number of bytes allocated on the stream before any
2479 * allocation done by the backend - this should give us a reasonable
2480 * idea of the total size of the data so far.
2482 total_length = odr_total(a->encode) - dumped_records;
2488 freq.last_in_set = 0;
2489 freq.setname = setname;
2490 freq.surrogate_flag = 0;
2491 freq.number = recno;
2493 freq.request_format = format;
2494 freq.request_format_raw = oid;
2495 freq.output_format = format;
2496 freq.output_format_raw = 0;
2497 freq.stream = a->encode;
2498 freq.print = a->print;
2499 freq.referenceId = referenceId;
2502 retrieve_fetch(a, &freq);
2504 *next = freq.last_in_set ? 0 : recno + 1;
2506 /* backend should be able to signal whether error is system-wide
2507 or only pertaining to current record */
2510 if (!freq.surrogate_flag)
2513 *pres = Z_PresentStatus_failure;
2514 /* for 'present request out of range',
2515 set addinfo to record position if not set */
2516 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2517 freq.errstring == 0)
2519 sprintf (s, "%d", recno);
2523 *errcode = freq.errcode;
2524 return diagrec(a, freq.errcode, freq.errstring);
2526 reclist->records[reclist->num_records] =
2527 surrogatediagrec(a, freq.basename, freq.errcode,
2529 reclist->num_records++;
2532 if (freq.record == 0) /* no error and no record ? */
2534 *next = 0; /* signal end-of-set and stop */
2538 this_length = freq.len;
2540 this_length = odr_total(a->encode) - total_length - dumped_records;
2541 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2542 this_length, total_length, dumped_records);
2543 if (a->preferredMessageSize > 0 &&
2544 this_length + total_length > a->preferredMessageSize)
2546 /* record is small enough, really */
2547 if (this_length <= a->preferredMessageSize && recno > start)
2549 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2550 *pres = Z_PresentStatus_partial_2;
2553 /* record can only be fetched by itself */
2554 if (this_length < a->maximumRecordSize)
2556 yaz_log(log_requestdetail, " Record > prefmsgsz");
2559 yaz_log(YLOG_DEBUG, " Dropped it");
2560 reclist->records[reclist->num_records] =
2561 surrogatediagrec(a, freq.basename, 16, 0);
2562 reclist->num_records++;
2563 dumped_records += this_length;
2567 else /* too big entirely */
2569 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2570 this_length, a->maximumRecordSize);
2571 reclist->records[reclist->num_records] =
2572 surrogatediagrec(a, freq.basename, 17, 0);
2573 reclist->num_records++;
2574 dumped_records += this_length;
2579 if (!(thisrec = (Z_NamePlusRecord *)
2580 odr_malloc(a->encode, sizeof(*thisrec))))
2583 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2585 thisrec->databaseName = 0;
2586 thisrec->which = Z_NamePlusRecord_databaseRecord;
2588 if (freq.output_format_raw)
2590 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
2591 freq.output_format = ident->value;
2593 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
2594 freq.record, freq.len);
2595 if (!thisrec->u.databaseRecord)
2597 reclist->records[reclist->num_records] = thisrec;
2598 reclist->num_records++;
2600 *num = reclist->num_records;
2604 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2607 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2608 bend_search_rr *bsrr =
2609 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2611 yaz_log(log_requestdetail, "Got SearchRequest.");
2613 bsrr->request = reqb;
2614 bsrr->association = assoc;
2615 bsrr->referenceId = req->referenceId;
2616 save_referenceId (reqb, bsrr->referenceId);
2617 bsrr->srw_sortKeys = 0;
2618 bsrr->srw_setname = 0;
2619 bsrr->srw_setnameIdleTime = 0;
2621 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2622 if (req->databaseNames)
2625 for (i = 0; i < req->num_databaseNames; i++)
2626 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2629 yaz_log_zquery_level(log_requestdetail,req->query);
2631 if (assoc->init->bend_search)
2633 bsrr->setname = req->resultSetName;
2634 bsrr->replace_set = *req->replaceIndicator;
2635 bsrr->num_bases = req->num_databaseNames;
2636 bsrr->basenames = req->databaseNames;
2637 bsrr->query = req->query;
2638 bsrr->stream = assoc->encode;
2639 nmem_transfer(bsrr->stream->mem, reqb->request_mem);
2640 bsrr->decode = assoc->decode;
2641 bsrr->print = assoc->print;
2644 bsrr->errstring = NULL;
2645 bsrr->search_info = NULL;
2647 if (assoc->server && assoc->server->cql_transform
2648 && req->query->which == Z_Query_type_104
2649 && req->query->u.type_104->which == Z_External_CQL)
2651 /* have a CQL query and a CQL to PQF transform .. */
2653 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2654 assoc->server->cql_transform, bsrr->query);
2656 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2659 (assoc->init->bend_search)(assoc->backend, bsrr);
2660 if (!bsrr->request) /* backend not ready with the search response */
2661 return 0; /* should not be used any more */
2665 /* FIXME - make a diagnostic for it */
2666 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2668 return response_searchRequest(assoc, reqb, bsrr, fd);
2671 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2674 * Prepare a searchresponse based on the backend results. We probably want
2675 * to look at making the fetching of records nonblocking as well, but
2676 * so far, we'll keep things simple.
2677 * If bsrt is null, that means we're called in response to a communications
2678 * event, and we'll have to get the response for ourselves.
2680 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2681 bend_search_rr *bsrt, int *fd)
2683 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2684 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2685 Z_SearchResponse *resp = (Z_SearchResponse *)
2686 odr_malloc (assoc->encode, sizeof(*resp));
2687 int *nulint = odr_intdup (assoc->encode, 0);
2688 bool_t *sr = odr_intdup(assoc->encode, 1);
2689 int *next = odr_intdup(assoc->encode, 0);
2690 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2693 apdu->which = Z_APDU_searchResponse;
2694 apdu->u.searchResponse = resp;
2695 resp->referenceId = req->referenceId;
2696 resp->additionalSearchInfo = 0;
2697 resp->otherInfo = 0;
2699 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2701 yaz_log(YLOG_FATAL, "Bad result from backend");
2704 else if (bsrt->errcode)
2706 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2707 resp->resultCount = nulint;
2708 resp->numberOfRecordsReturned = nulint;
2709 resp->nextResultSetPosition = nulint;
2710 resp->searchStatus = nulint;
2711 resp->resultSetStatus = none;
2712 resp->presentStatus = 0;
2716 int *toget = odr_intdup(assoc->encode, 0);
2717 int *presst = odr_intdup(assoc->encode, 0);
2718 Z_RecordComposition comp, *compp = 0;
2720 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2723 resp->resultCount = &bsrt->hits;
2725 comp.which = Z_RecordComp_simple;
2726 /* how many records does the user agent want, then? */
2727 if (bsrt->hits <= *req->smallSetUpperBound)
2729 *toget = bsrt->hits;
2730 if ((comp.u.simple = req->smallSetElementSetNames))
2733 else if (bsrt->hits < *req->largeSetLowerBound)
2735 *toget = *req->mediumSetPresentNumber;
2736 if (*toget > bsrt->hits)
2737 *toget = bsrt->hits;
2738 if ((comp.u.simple = req->mediumSetElementSetNames))
2744 if (*toget && !resp->records)
2749 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2752 form = prefformat->value;
2754 /* Call bend_present if defined */
2755 if (assoc->init->bend_present)
2757 bend_present_rr *bprr = (bend_present_rr *)
2758 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2759 bprr->setname = req->resultSetName;
2761 bprr->number = *toget;
2762 bprr->format = form;
2764 bprr->referenceId = req->referenceId;
2765 bprr->stream = assoc->encode;
2766 bprr->print = assoc->print;
2767 bprr->request = reqb;
2768 bprr->association = assoc;
2770 bprr->errstring = NULL;
2771 (*assoc->init->bend_present)(assoc->backend, bprr);
2777 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2778 *resp->presentStatus = Z_PresentStatus_failure;
2783 resp->records = pack_records(assoc, req->resultSetName, 1,
2784 toget, compp, next, presst, form, req->referenceId,
2785 req->preferredRecordSyntax, NULL);
2788 resp->numberOfRecordsReturned = toget;
2789 returnedrecs = *toget;
2790 resp->nextResultSetPosition = next;
2791 resp->searchStatus = sr;
2792 resp->resultSetStatus = 0;
2793 resp->presentStatus = presst;
2797 if (*resp->resultCount)
2799 resp->numberOfRecordsReturned = nulint;
2800 resp->nextResultSetPosition = next;
2801 resp->searchStatus = sr;
2802 resp->resultSetStatus = 0;
2803 resp->presentStatus = 0;
2806 resp->additionalSearchInfo = bsrt->search_info;
2811 WRBUF wr = wrbuf_alloc();
2813 for (i = 0 ; i < req->num_databaseNames; i++){
2815 wrbuf_printf(wr, "+");
2816 wrbuf_printf(wr, req->databaseNames[i]);
2818 wrbuf_printf(wr, " ");
2821 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2823 wrbuf_printf(wr, "OK %d", bsrt->hits);
2824 wrbuf_printf(wr, " %s 1+%d ",
2825 req->resultSetName, returnedrecs);
2826 yaz_query_to_wrbuf(wr, req->query);
2828 yaz_log(log_request, "Search %s", wrbuf_buf(wr));
2835 * Maybe we got a little over-friendly when we designed bend_fetch to
2836 * get only one record at a time. Some backends can optimise multiple-record
2837 * fetches, and at any rate, there is some overhead involved in
2838 * all that selecting and hopping around. Problem is, of course, that the
2839 * frontend can't know ahead of time how many records it'll need to
2840 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2841 * is downright lousy as a bulk data transfer protocol.
2843 * To start with, we'll do the fetching of records from the backend
2844 * in one operation: To save some trips in and out of the event-handler,
2845 * and to simplify the interface to pack_records. At any rate, asynch
2846 * operation is more fun in operations that have an unpredictable execution
2847 * speed - which is normally more true for search than for present.
2849 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2852 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2856 Z_PresentResponse *resp;
2860 const char *errstring = 0;
2862 yaz_log(log_requestdetail, "Got PresentRequest.");
2864 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2867 form = prefformat->value;
2868 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2870 resp->presentStatus = odr_intdup(assoc->encode, 0);
2871 if (assoc->init->bend_present)
2873 bend_present_rr *bprr = (bend_present_rr *)
2874 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2875 bprr->setname = req->resultSetId;
2876 bprr->start = *req->resultSetStartPoint;
2877 bprr->number = *req->numberOfRecordsRequested;
2878 bprr->format = form;
2879 bprr->comp = req->recordComposition;
2880 bprr->referenceId = req->referenceId;
2881 bprr->stream = assoc->encode;
2882 bprr->print = assoc->print;
2883 bprr->request = reqb;
2884 bprr->association = assoc;
2886 bprr->errstring = NULL;
2887 (*assoc->init->bend_present)(assoc->backend, bprr);
2890 return 0; /* should not happen */
2893 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2894 *resp->presentStatus = Z_PresentStatus_failure;
2895 errcode = bprr->errcode;
2896 errstring = bprr->errstring;
2899 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2900 next = odr_intdup(assoc->encode, 0);
2901 num = odr_intdup(assoc->encode, 0);
2903 apdu->which = Z_APDU_presentResponse;
2904 apdu->u.presentResponse = resp;
2905 resp->referenceId = req->referenceId;
2906 resp->otherInfo = 0;
2910 *num = *req->numberOfRecordsRequested;
2912 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2913 num, req->recordComposition, next,
2914 resp->presentStatus,
2915 form, req->referenceId, req->preferredRecordSyntax,
2920 WRBUF wr = wrbuf_alloc();
2921 wrbuf_printf(wr, "Present ");
2923 if (*resp->presentStatus == Z_PresentStatus_failure)
2924 wrbuf_printf(wr, "ERROR %d ", errcode);
2925 else if (*resp->presentStatus == Z_PresentStatus_success)
2926 wrbuf_printf(wr, "OK - ");
2928 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2930 wrbuf_printf(wr, " %s %d+%d ",
2931 req->resultSetId, *req->resultSetStartPoint,
2932 *req->numberOfRecordsRequested);
2933 yaz_log(log_request, "%s", wrbuf_buf(wr) );
2938 resp->numberOfRecordsReturned = num;
2939 resp->nextResultSetPosition = next;
2945 * Scan was implemented rather in a hurry, and with support for only the basic
2946 * elements of the service in the backend API. Suggestions are welcome.
2948 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2950 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2951 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2952 Z_ScanResponse *res = (Z_ScanResponse *)
2953 odr_malloc (assoc->encode, sizeof(*res));
2954 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2955 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2956 Z_ListEntries *ents = (Z_ListEntries *)
2957 odr_malloc (assoc->encode, sizeof(*ents));
2958 Z_DiagRecs *diagrecs_p = NULL;
2960 bend_scan_rr *bsrr = (bend_scan_rr *)
2961 odr_malloc (assoc->encode, sizeof(*bsrr));
2962 struct scan_entry *save_entries;
2964 yaz_log(log_requestdetail, "Got ScanRequest");
2966 apdu->which = Z_APDU_scanResponse;
2967 apdu->u.scanResponse = res;
2968 res->referenceId = req->referenceId;
2970 /* if step is absent, set it to 0 */
2971 res->stepSize = odr_intdup(assoc->encode, 0);
2973 *res->stepSize = *req->stepSize;
2975 res->scanStatus = scanStatus;
2976 res->numberOfEntriesReturned = numberOfEntriesReturned;
2977 res->positionOfTerm = 0;
2978 res->entries = ents;
2979 ents->num_entries = 0;
2980 ents->entries = NULL;
2981 ents->num_nonsurrogateDiagnostics = 0;
2982 ents->nonsurrogateDiagnostics = NULL;
2983 res->attributeSet = 0;
2986 if (req->databaseNames)
2989 for (i = 0; i < req->num_databaseNames; i++)
2990 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2992 bsrr->scanClause = 0;
2994 bsrr->errstring = 0;
2995 bsrr->num_bases = req->num_databaseNames;
2996 bsrr->basenames = req->databaseNames;
2997 bsrr->num_entries = *req->numberOfTermsRequested;
2998 bsrr->term = req->termListAndStartPoint;
2999 bsrr->referenceId = req->referenceId;
3000 bsrr->stream = assoc->encode;
3001 bsrr->print = assoc->print;
3002 bsrr->step_size = res->stepSize;
3004 /* For YAZ 2.0 and earlier it was the backend handler that
3005 initialized entries (member display_term did not exist)
3006 YAZ 2.0 and later sets 'entries' and initialize all members
3007 including 'display_term'. If YAZ 2.0 or later sees that
3008 entries was modified - we assume that it is an old handler and
3009 that 'display_term' is _not_ set.
3011 if (bsrr->num_entries > 0)
3014 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3016 for (i = 0; i<bsrr->num_entries; i++)
3018 bsrr->entries[i].term = 0;
3019 bsrr->entries[i].occurrences = 0;
3020 bsrr->entries[i].errcode = 0;
3021 bsrr->entries[i].errstring = 0;
3022 bsrr->entries[i].display_term = 0;
3025 save_entries = bsrr->entries; /* save it so we can compare later */
3027 if (req->attributeSet &&
3028 (attset = oid_getentbyoid(req->attributeSet)) &&
3029 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
3030 bsrr->attributeset = attset->value;
3032 bsrr->attributeset = VAL_NONE;
3033 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3034 bsrr->attributeset);
3035 bsrr->term_position = req->preferredPositionInResponse ?
3036 *req->preferredPositionInResponse : 1;
3038 ((int (*)(void *, bend_scan_rr *))
3039 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3042 diagrecs_p = zget_DiagRecs(assoc->encode,
3043 bsrr->errcode, bsrr->errstring);
3047 Z_Entry **tab = (Z_Entry **)
3048 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3050 if (bsrr->status == BEND_SCAN_PARTIAL)
3051 *scanStatus = Z_Scan_partial_5;
3053 *scanStatus = Z_Scan_success;
3054 ents->entries = tab;
3055 ents->num_entries = bsrr->num_entries;
3056 res->numberOfEntriesReturned = &ents->num_entries;
3057 res->positionOfTerm = &bsrr->term_position;
3058 for (i = 0; i < bsrr->num_entries; i++)
3064 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3065 if (bsrr->entries[i].occurrences >= 0)
3067 e->which = Z_Entry_termInfo;
3068 e->u.termInfo = t = (Z_TermInfo *)
3069 odr_malloc(assoc->encode, sizeof(*t));
3070 t->suggestedAttributes = 0;
3072 if (save_entries == bsrr->entries &&
3073 bsrr->entries[i].display_term)
3075 /* the entries was _not_ set by the handler. So it's
3076 safe to test for new member display_term. It is
3079 t->displayTerm = odr_strdup(assoc->encode,
3080 bsrr->entries[i].display_term);
3082 t->alternativeTerm = 0;
3083 t->byAttributes = 0;
3084 t->otherTermInfo = 0;
3085 t->globalOccurrences = &bsrr->entries[i].occurrences;
3086 t->term = (Z_Term *)
3087 odr_malloc(assoc->encode, sizeof(*t->term));
3088 t->term->which = Z_Term_general;
3089 t->term->u.general = o =
3090 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3091 o->buf = (unsigned char *)
3092 odr_malloc(assoc->encode, o->len = o->size =
3093 strlen(bsrr->entries[i].term));
3094 memcpy(o->buf, bsrr->entries[i].term, o->len);
3095 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3096 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3100 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3101 bsrr->entries[i].errcode,
3102 bsrr->entries[i].errstring);
3103 assert (drecs->num_diagRecs == 1);
3104 e->which = Z_Entry_surrogateDiagnostic;
3105 assert (drecs->diagRecs[0]);
3106 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3112 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3113 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3118 WRBUF wr = wrbuf_alloc();
3119 wrbuf_printf(wr, "Scan ");
3120 for (i = 0 ; i < req->num_databaseNames; i++){
3122 wrbuf_printf(wr, "+");
3123 wrbuf_printf(wr, req->databaseNames[i]);
3125 wrbuf_printf(wr, " ");
3128 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3129 wrbuf_printf(wr, " ");
3132 wrbuf_printf(wr, "OK ");
3133 /* else if (*res->scanStatus == Z_Scan_success) */
3134 /* wrbuf_printf(wr, "OK "); */
3136 /* wrbuf_printf(wr, "Partial "); */
3138 if (*res->numberOfEntriesReturned)
3139 wrbuf_printf(wr, "%d - ", *res->numberOfEntriesReturned);
3141 wrbuf_printf(wr, "0 - ");
3143 wrbuf_printf(wr, "%d+%d+%d ",
3144 (req->preferredPositionInResponse ?
3145 *req->preferredPositionInResponse : 1),
3146 *req->numberOfTermsRequested,
3147 (res->stepSize ? *res->stepSize : 1));
3149 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3150 bsrr->attributeset);
3151 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3157 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3161 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3162 Z_SortResponse *res = (Z_SortResponse *)
3163 odr_malloc (assoc->encode, sizeof(*res));
3164 bend_sort_rr *bsrr = (bend_sort_rr *)
3165 odr_malloc (assoc->encode, sizeof(*bsrr));
3167 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3169 yaz_log(log_requestdetail, "Got SortRequest.");
3171 bsrr->num_input_setnames = req->num_inputResultSetNames;
3172 for (i=0;i<req->num_inputResultSetNames;i++)
3173 yaz_log(log_requestdetail, "Input resultset: '%s'",
3174 req->inputResultSetNames[i]);
3175 bsrr->input_setnames = req->inputResultSetNames;
3176 bsrr->referenceId = req->referenceId;
3177 bsrr->output_setname = req->sortedResultSetName;
3178 yaz_log(log_requestdetail, "Output resultset: '%s'",
3179 req->sortedResultSetName);
3180 bsrr->sort_sequence = req->sortSequence;
3181 /*FIXME - dump those sequences too */
3182 bsrr->stream = assoc->encode;
3183 bsrr->print = assoc->print;
3185 bsrr->sort_status = Z_SortResponse_failure;
3187 bsrr->errstring = 0;
3189 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3191 res->referenceId = bsrr->referenceId;
3192 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3193 res->resultSetStatus = 0;
3196 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3197 bsrr->errcode, bsrr->errstring);
3198 res->diagnostics = dr->diagRecs;
3199 res->num_diagnostics = dr->num_diagRecs;
3203 res->num_diagnostics = 0;
3204 res->diagnostics = 0;
3206 res->resultCount = 0;
3209 apdu->which = Z_APDU_sortResponse;
3210 apdu->u.sortResponse = res;
3213 WRBUF wr = wrbuf_alloc();
3214 wrbuf_printf(wr, "Sort ");
3216 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3218 wrbuf_printf(wr, "OK -");
3219 wrbuf_printf(wr, " (");
3220 for (i = 0; i<req->num_inputResultSetNames; i++)
3223 wrbuf_printf(wr, "+");
3224 wrbuf_printf(wr, req->inputResultSetNames[i]);
3226 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3228 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3234 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3238 Z_DeleteResultSetRequest *req =
3239 reqb->apdu_request->u.deleteResultSetRequest;
3240 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3241 odr_malloc (assoc->encode, sizeof(*res));
3242 bend_delete_rr *bdrr = (bend_delete_rr *)
3243 odr_malloc (assoc->encode, sizeof(*bdrr));
3244 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3246 yaz_log(log_requestdetail, "Got DeleteRequest.");
3248 bdrr->num_setnames = req->num_resultSetList;
3249 bdrr->setnames = req->resultSetList;
3250 for (i = 0; i<req->num_resultSetList; i++)
3251 yaz_log(log_requestdetail, "resultset: '%s'",
3252 req->resultSetList[i]);
3253 bdrr->stream = assoc->encode;
3254 bdrr->print = assoc->print;
3255 bdrr->function = *req->deleteFunction;
3256 bdrr->referenceId = req->referenceId;
3258 if (bdrr->num_setnames > 0)
3260 bdrr->statuses = (int*)
3261 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3262 bdrr->num_setnames);
3263 for (i = 0; i < bdrr->num_setnames; i++)
3264 bdrr->statuses[i] = 0;
3266 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3268 res->referenceId = req->referenceId;
3270 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3272 res->deleteListStatuses = 0;
3273 if (bdrr->num_setnames > 0)
3276 res->deleteListStatuses = (Z_ListStatuses *)
3277 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3278 res->deleteListStatuses->num = bdrr->num_setnames;
3279 res->deleteListStatuses->elements =
3281 odr_malloc (assoc->encode,
3282 sizeof(*res->deleteListStatuses->elements) *
3283 bdrr->num_setnames);
3284 for (i = 0; i<bdrr->num_setnames; i++)
3286 res->deleteListStatuses->elements[i] =
3288 odr_malloc (assoc->encode,
3289 sizeof(**res->deleteListStatuses->elements));
3290 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3291 res->deleteListStatuses->elements[i]->id =
3292 odr_strdup (assoc->encode, bdrr->setnames[i]);
3295 res->numberNotDeleted = 0;
3296 res->bulkStatuses = 0;
3297 res->deleteMessage = 0;
3300 apdu->which = Z_APDU_deleteResultSetResponse;
3301 apdu->u.deleteResultSetResponse = res;
3304 WRBUF wr = wrbuf_alloc();
3305 wrbuf_printf(wr, "Delete ");
3306 if (bdrr->delete_status)
3307 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3309 wrbuf_printf(wr, "OK -");
3310 for (i = 0; i<req->num_resultSetList; i++)
3311 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3312 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3318 static void process_close(association *assoc, request *reqb)
3320 Z_Close *req = reqb->apdu_request->u.close;
3321 static char *reasons[] =
3328 "securityViolation",
3335 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3336 reasons[*req->closeReason], req->diagnosticInformation ?
3337 req->diagnosticInformation : "NULL");
3338 if (assoc->version < 3) /* to make do_force respond with close */
3340 do_close_req(assoc, Z_Close_finished,
3341 "Association terminated by client", reqb);
3342 yaz_log(log_request,"Close OK");
3345 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3349 reqb->len_refid = refid->len;
3350 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3351 memcpy (reqb->refid, refid->buf, refid->len);
3355 reqb->len_refid = 0;
3360 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3362 process_z_response (a, req, res);
3365 bend_request bend_request_mk (bend_association a)
3367 request *nreq = request_get (&a->outgoing);
3368 nreq->request_mem = nmem_create ();
3372 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3377 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3378 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3379 id->len = id->size = req->len_refid;
3380 memcpy (id->buf, req->refid, req->len_refid);
3384 void bend_request_destroy (bend_request *req)
3386 nmem_destroy((*req)->request_mem);
3387 request_release(*req);
3391 int bend_backend_respond (bend_association a, bend_request req)
3395 r = process_z_request (a, req, &msg);
3397 yaz_log (YLOG_WARN, "%s", msg);
3401 void bend_request_setdata(bend_request r, void *p)
3406 void *bend_request_getdata(bend_request r)
3408 return r->clientData;
3411 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3413 bend_segment_rr req;
3415 req.segment = reqb->apdu_request->u.segmentRequest;
3416 req.stream = assoc->encode;
3417 req.decode = assoc->decode;
3418 req.print = assoc->print;
3419 req.association = assoc;
3421 (*assoc->init->bend_segment)(assoc->backend, &req);
3426 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3428 bend_esrequest_rr esrequest;
3429 const char *ext_name = "unknown";
3431 Z_ExtendedServicesRequest *req =
3432 reqb->apdu_request->u.extendedServicesRequest;
3433 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3435 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3437 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3438 esrequest.stream = assoc->encode;
3439 esrequest.decode = assoc->decode;
3440 esrequest.print = assoc->print;
3441 esrequest.errcode = 0;
3442 esrequest.errstring = NULL;
3443 esrequest.request = reqb;
3444 esrequest.association = assoc;
3445 esrequest.taskPackage = 0;
3446 esrequest.referenceId = req->referenceId;
3449 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3451 switch(esrequest.esr->taskSpecificParameters->which)
3453 case Z_External_itemOrder:
3454 ext_name = "ItemOrder"; break;
3455 case Z_External_update:
3456 ext_name = "Update"; break;
3457 case Z_External_update0:
3458 ext_name = "Update0"; break;
3459 case Z_External_ESAdmin:
3460 ext_name = "Admin"; break;
3465 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3467 /* If the response is being delayed, return NULL */
3468 if (esrequest.request == NULL)
3471 resp->referenceId = req->referenceId;
3473 if (esrequest.errcode == -1)
3475 /* Backend service indicates request will be processed */
3476 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3477 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3479 else if (esrequest.errcode == 0)
3481 /* Backend service indicates request will be processed */
3482 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3483 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3487 Z_DiagRecs *diagRecs =
3488 zget_DiagRecs(assoc->encode, esrequest.errcode,
3489 esrequest.errstring);
3490 /* Backend indicates error, request will not be processed */
3491 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3492 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3493 resp->num_diagnostics = diagRecs->num_diagRecs;
3494 resp->diagnostics = diagRecs->diagRecs;
3497 WRBUF wr = wrbuf_alloc();
3498 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3499 yaz_log(log_request, "EsRequest %s", wrbuf_buf(wr) );
3504 /* Do something with the members of bend_extendedservice */
3505 if (esrequest.taskPackage)
3506 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
3507 (const char *) esrequest.taskPackage,
3509 yaz_log(YLOG_DEBUG,"Send the result apdu");
3516 * indent-tabs-mode: nil
3518 * vim: shiftwidth=4 tabstop=8 expandtab