2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.111 2007-03-13 09:12:09 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 int ir_read(IOCHAN h, int event)
270 association *assoc = (association *)iochan_getdata(h);
271 COMSTACK conn = assoc->client_link;
274 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
276 yaz_log(YLOG_DEBUG, "ir_session (input)");
277 /* We aren't speaking to this fellow */
278 if (assoc->state == ASSOC_DEAD)
280 yaz_log(log_sessiondetail, "Connection closed - end of session");
282 destroy_association(assoc);
286 assoc->cs_get_mask = EVENT_INPUT;
290 int res = cs_get(conn, &assoc->input_buffer,
291 &assoc->input_buffer_len);
292 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
294 yaz_log(log_session, "Connection error: %s res=%d",
295 cs_errmsg(cs_errno(conn)), res);
296 req = request_get(&assoc->incoming); /* get a new request */
297 do_close_req(assoc, Z_Close_protocolError,
298 "Incoming package too large", req);
303 yaz_log(log_session, "Connection closed by client");
304 assoc->state = ASSOC_DEAD;
307 else if (res == 1) /* incomplete read - wait for more */
309 if (conn->io_pending & CS_WANT_WRITE)
310 assoc->cs_get_mask |= EVENT_OUTPUT;
311 iochan_setflag(h, assoc->cs_get_mask);
314 /* we got a complete PDU. Let's decode it */
315 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
316 assoc->input_buffer[0] & 0xff,
317 assoc->input_buffer[1] & 0xff,
318 assoc->input_buffer[2] & 0xff);
319 req = request_get(&assoc->incoming); /* get a new request */
320 odr_reset(assoc->decode);
321 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
322 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
324 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
326 odr_errmsg(odr_geterror(assoc->decode)),
327 odr_getelement(assoc->decode),
328 (long) odr_offset(assoc->decode));
329 if (assoc->decode->error != OHTTP)
331 yaz_log(YLOG_WARN, "PDU dump:");
332 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
333 request_release(req);
334 do_close(assoc, Z_Close_protocolError, "Malformed package");
338 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
339 assoc->state = ASSOC_DEAD;
340 process_gdu_response(assoc, req, p);
344 req->request_mem = odr_extract_mem(assoc->decode);
347 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
348 yaz_log(YLOG_WARN, "ODR print error: %s",
349 odr_errmsg(odr_geterror(assoc->print)));
350 odr_reset(assoc->print);
352 request_enq(&assoc->incoming, req);
354 while (cs_more(conn));
360 * This is where PDUs from the client are read and the further
361 * processing is initiated. Flow of control moves down through the
362 * various process_* functions below, until the encoded result comes back up
363 * to the output handler in here.
365 * h : the I/O channel that has an outstanding event.
366 * event : the current outstanding event.
368 void ir_session(IOCHAN h, int event)
371 association *assoc = (association *)iochan_getdata(h);
372 COMSTACK conn = assoc->client_link;
375 assert(h && conn && assoc);
376 if (event == EVENT_TIMEOUT)
378 if (assoc->state != ASSOC_UP)
380 yaz_log(YLOG_DEBUG, "Final timeout - closing connection.");
381 /* do we need to lod this at all */
383 destroy_association(assoc);
388 yaz_log(log_sessiondetail,
389 "Session idle too long. Sending close.");
390 do_close(assoc, Z_Close_lackOfActivity, 0);
394 if (event & assoc->cs_accept_mask)
396 if (!cs_accept (conn))
398 yaz_log (YLOG_WARN, "accept failed");
399 destroy_association(assoc);
402 iochan_clearflag (h, EVENT_OUTPUT);
403 if (conn->io_pending)
404 { /* cs_accept didn't complete */
405 assoc->cs_accept_mask =
406 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
407 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
409 iochan_setflag (h, assoc->cs_accept_mask);
412 { /* cs_accept completed. Prepare for reading (cs_get) */
413 assoc->cs_accept_mask = 0;
414 assoc->cs_get_mask = EVENT_INPUT;
415 iochan_setflag (h, assoc->cs_get_mask);
419 if (event & assoc->cs_get_mask) /* input */
421 if (!ir_read(h, event))
423 req = request_head(&assoc->incoming);
424 if (req->state == REQUEST_IDLE)
426 request_deq(&assoc->incoming);
427 process_gdu_request(assoc, req);
430 if (event & assoc->cs_put_mask)
432 request *req = request_head(&assoc->outgoing);
434 assoc->cs_put_mask = 0;
435 yaz_log(YLOG_DEBUG, "ir_session (output)");
436 req->state = REQUEST_PENDING;
437 switch (res = cs_put(conn, req->response, req->len_response))
440 yaz_log(log_sessiondetail, "Connection closed by client");
442 destroy_association(assoc);
445 case 0: /* all sent - release the request structure */
446 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
448 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
451 nmem_destroy(req->request_mem);
452 request_deq(&assoc->outgoing);
453 request_release(req);
454 if (!request_head(&assoc->outgoing))
455 { /* restore mask for cs_get operation ... */
456 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
457 iochan_setflag(h, assoc->cs_get_mask);
458 if (assoc->state == ASSOC_DEAD)
459 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
463 assoc->cs_put_mask = EVENT_OUTPUT;
467 if (conn->io_pending & CS_WANT_WRITE)
468 assoc->cs_put_mask |= EVENT_OUTPUT;
469 if (conn->io_pending & CS_WANT_READ)
470 assoc->cs_put_mask |= EVENT_INPUT;
471 iochan_setflag(h, assoc->cs_put_mask);
474 if (event & EVENT_EXCEPT)
476 yaz_log(YLOG_WARN, "ir_session (exception)");
478 destroy_association(assoc);
483 static int process_z_request(association *assoc, request *req, char **msg);
486 static void assoc_init_reset(association *assoc)
489 assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
491 assoc->init->stream = assoc->encode;
492 assoc->init->print = assoc->print;
493 assoc->init->auth = 0;
494 assoc->init->referenceId = 0;
495 assoc->init->implementation_version = 0;
496 assoc->init->implementation_id = 0;
497 assoc->init->implementation_name = 0;
498 assoc->init->bend_sort = NULL;
499 assoc->init->bend_search = NULL;
500 assoc->init->bend_present = NULL;
501 assoc->init->bend_esrequest = NULL;
502 assoc->init->bend_delete = NULL;
503 assoc->init->bend_scan = NULL;
504 assoc->init->bend_segment = NULL;
505 assoc->init->bend_fetch = NULL;
506 assoc->init->bend_explain = NULL;
507 assoc->init->bend_srw_scan = NULL;
508 assoc->init->bend_srw_update = NULL;
510 assoc->init->charneg_request = NULL;
511 assoc->init->charneg_response = NULL;
513 assoc->init->decode = assoc->decode;
514 assoc->init->peer_name =
515 odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
517 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
520 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
522 statserv_options_block *cb = statserv_getcontrol();
525 const char *encoding = "UTF-8";
527 bend_initresult *binitres;
529 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
530 assoc_init_reset(assoc);
534 Z_IdAuthentication *auth = odr_malloc(assoc->decode, sizeof(*auth));
537 len = strlen(sr->username) + 1;
539 len += strlen(sr->password) + 2;
540 auth->which = Z_IdAuthentication_open;
541 auth->u.open = odr_malloc(assoc->decode, len);
542 strcpy(auth->u.open, sr->username);
543 if (sr->password && *sr->password)
545 strcat(auth->u.open, "/");
546 strcat(auth->u.open, sr->password);
548 assoc->init->auth = auth;
552 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
553 assoc->init->charneg_request = ce->u.charNeg3;
556 if (!(binitres = (*cb->bend_init)(assoc->init)))
558 assoc->state = ASSOC_DEAD;
559 yaz_add_srw_diagnostic(assoc->encode, d, num,
560 YAZ_SRW_AUTHENTICATION_ERROR, 0);
563 assoc->backend = binitres->handle;
564 assoc->init->auth = 0;
565 if (binitres->errcode)
567 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
568 assoc->state = ASSOC_DEAD;
569 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
570 binitres->errstring);
578 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
581 yaz_record_conv_t rc = 0;
582 const char *match_schema = 0;
583 int *match_syntax = 0;
588 const char *input_schema = yaz_get_esn(rr->comp);
589 Odr_oid *input_syntax_raw = rr->request_format_raw;
591 const char *backend_schema = 0;
592 Odr_oid *backend_syntax = 0;
594 r = yaz_retrieval_request(assoc->server->retrieval,
602 if (r == -1) /* error ? */
604 const char *details = yaz_retrieval_get_error(
605 assoc->server->retrieval);
607 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
609 rr->errstring = odr_strdup(rr->stream, details);
612 else if (r == 1 || r == 3)
614 const char *details = input_schema;
616 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
618 rr->errstring = odr_strdup(rr->stream, details);
623 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
624 if (input_syntax_raw)
626 char oidbuf[OID_STR_MAX];
627 oid_to_dotstring(input_syntax_raw, oidbuf);
628 rr->errstring = odr_strdup(rr->stream, oidbuf);
634 yaz_set_esn(&rr->comp, backend_schema, rr->stream->mem);
638 oident *oident_syntax = oid_getentbyoid(backend_syntax);
640 rr->request_format_raw = backend_syntax;
643 rr->request_format = oident_syntax->value;
645 rr->request_format = VAL_NONE;
648 (*assoc->init->bend_fetch)(assoc->backend, rr);
649 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
650 { /* post conversion must take place .. */
651 WRBUF output_record = wrbuf_alloc();
652 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
655 const char *details = yaz_record_conv_get_error(rc);
656 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
658 rr->errstring = odr_strdup(rr->stream, details);
662 rr->len = wrbuf_len(output_record);
663 rr->record = odr_malloc(rr->stream, rr->len);
664 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
666 wrbuf_free(output_record, 1);
670 struct oident *oi = oid_getentbyoid(match_syntax);
671 rr->output_format = oi ? oi->value : VAL_NONE;
672 rr->output_format_raw = match_syntax;
675 rr->schema = odr_strdup(rr->stream, match_schema);
678 (*assoc->init->bend_fetch)(assoc->backend, rr);
683 static int srw_bend_fetch(association *assoc, int pos,
684 Z_SRW_searchRetrieveRequest *srw_req,
685 Z_SRW_record *record,
686 const char **addinfo)
689 ODR o = assoc->encode;
691 rr.setname = "default";
694 rr.request_format = VAL_TEXT_XML;
695 rr.request_format_raw = yaz_oidval_to_z3950oid(assoc->decode,
698 rr.comp = (Z_RecordComposition *)
699 odr_malloc(assoc->decode, sizeof(*rr.comp));
700 rr.comp->which = Z_RecordComp_complex;
701 rr.comp->u.complex = (Z_CompSpec *)
702 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
703 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
704 odr_malloc(assoc->encode, sizeof(bool_t));
705 *rr.comp->u.complex->selectAlternativeSyntax = 0;
706 rr.comp->u.complex->num_dbSpecific = 0;
707 rr.comp->u.complex->dbSpecific = 0;
708 rr.comp->u.complex->num_recordSyntax = 0;
709 rr.comp->u.complex->recordSyntax = 0;
711 rr.comp->u.complex->generic = (Z_Specification *)
712 odr_malloc(assoc->decode, sizeof(Z_Specification));
714 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
715 rr.comp->u.complex->generic->which = Z_Schema_uri;
716 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
718 /* ESN = recordSchema if recordSchema is present */
719 rr.comp->u.complex->generic->elementSpec = 0;
720 if (srw_req->recordSchema)
722 rr.comp->u.complex->generic->elementSpec =
723 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
724 rr.comp->u.complex->generic->elementSpec->which =
725 Z_ElementSpec_elementSetName;
726 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
727 srw_req->recordSchema;
730 rr.stream = assoc->encode;
731 rr.print = assoc->print;
739 rr.surrogate_flag = 0;
740 rr.schema = srw_req->recordSchema;
742 if (!assoc->init->bend_fetch)
745 retrieve_fetch(assoc, &rr);
747 if (rr.errcode && rr.surrogate_flag)
749 int code = yaz_diag_bib1_to_srw(rr.errcode);
750 const char *message = yaz_diag_srw_str(code);
753 len += strlen(message);
755 len += strlen(rr.errstring);
757 record->recordData_buf = odr_malloc(o, len);
759 sprintf(record->recordData_buf, "<diagnostic "
760 "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
761 " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
763 sprintf(record->recordData_buf + strlen(record->recordData_buf),
764 " <details>%s</details>\n", rr.errstring);
766 sprintf(record->recordData_buf + strlen(record->recordData_buf),
767 " <message>%s</message>\n", message);
768 sprintf(record->recordData_buf + strlen(record->recordData_buf),
770 record->recordData_len = strlen(record->recordData_buf);
771 record->recordPosition = odr_intdup(o, pos);
772 record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
775 else if (rr.len >= 0)
777 record->recordData_buf = rr.record;
778 record->recordData_len = rr.len;
779 record->recordPosition = odr_intdup(o, pos);
781 record->recordSchema = odr_strdup(o, rr.schema);
783 record->recordSchema = 0;
787 *addinfo = rr.errstring;
793 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
794 Z_Query *query_result)
796 /* have a CQL query and CQL to PQF transform .. */
797 CQL_parser cp = cql_parser_create();
803 r = cql_parser_string(cp, cql);
806 /* CQL syntax error */
812 r = cql_transform_buf(ct,
813 cql_parser_result(cp),
814 rpn_buf, sizeof(rpn_buf)-1);
816 srw_errcode = cql_transform_error(ct, &add);
820 /* Syntax & transform OK. */
821 /* Convert PQF string to Z39.50 to RPN query struct */
822 YAZ_PQF_Parser pp = yaz_pqf_create();
823 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
828 int code = yaz_pqf_error(pp, &pqf_msg, &off);
829 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
835 query_result->which = Z_Query_type_1;
836 query_result->u.type_1 = rpnquery;
840 cql_parser_destroy(cp);
844 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
845 Z_AttributesPlusTerm *result)
849 int srw_error = cql2pqf(odr, cql, ct, &query);
852 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
853 return 10; /* bad query type */
854 rpn = query.u.type_1;
855 if (!rpn->RPNStructure)
856 return 10; /* must be structure */
857 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
858 return 10; /* must be simple */
859 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
860 return 10; /* must be attributes plus term node .. */
861 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
866 static void srw_bend_search(association *assoc, request *req,
868 Z_SRW_searchRetrieveResponse *srw_res,
873 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
876 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
877 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
878 if (srw_res->num_diagnostics == 0 && assoc->init)
881 rr.setname = "default";
884 rr.basenames = &srw_req->database;
888 rr.srw_setnameIdleTime = 0;
889 rr.estimated_hit_count = 0;
890 rr.partial_resultset = 0;
891 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
892 rr.query->u.type_1 = 0;
894 if (srw_req->query_type == Z_SRW_query_type_cql)
896 if (assoc->server && assoc->server->cql_transform)
898 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
899 assoc->server->cql_transform,
903 yaz_add_srw_diagnostic(assoc->encode,
904 &srw_res->diagnostics,
905 &srw_res->num_diagnostics,
911 /* CQL query to backend. Wrap it - Z39.50 style */
912 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
913 ext->direct_reference = odr_getoidbystr(assoc->decode,
914 "1.2.840.10003.16.2");
915 ext->indirect_reference = 0;
917 ext->which = Z_External_CQL;
918 ext->u.cql = srw_req->query.cql;
920 rr.query->which = Z_Query_type_104;
921 rr.query->u.type_104 = ext;
924 else if (srw_req->query_type == Z_SRW_query_type_pqf)
926 Z_RPNQuery *RPNquery;
927 YAZ_PQF_Parser pqf_parser;
929 pqf_parser = yaz_pqf_create ();
931 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
937 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
938 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
939 code, pqf_msg, (long) off);
940 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
943 rr.query->which = Z_Query_type_1;
944 rr.query->u.type_1 = RPNquery;
946 yaz_pqf_destroy (pqf_parser);
950 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
951 &srw_res->num_diagnostics,
952 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
954 if (rr.query->u.type_1)
956 rr.stream = assoc->encode;
957 rr.decode = assoc->decode;
958 rr.print = assoc->print;
960 if ( srw_req->sort.sortKeys )
961 rr.srw_sortKeys = odr_strdup(assoc->encode,
962 srw_req->sort.sortKeys );
963 rr.association = assoc;
969 yaz_log_zquery_level(log_requestdetail,rr.query);
971 (assoc->init->bend_search)(assoc->backend, &rr);
974 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
980 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
981 yaz_add_srw_diagnostic(assoc->encode,
982 &srw_res->diagnostics,
983 &srw_res->num_diagnostics,
984 srw_error, rr.errstring);
989 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
990 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
992 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
993 start, number, rr.hits);
995 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
998 srw_res->resultSetId =
999 odr_strdup(assoc->encode, rr.srw_setname );
1000 srw_res->resultSetIdleTime =
1001 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1004 if ((rr.hits > 0 && start > rr.hits) || start < 1)
1006 yaz_add_srw_diagnostic(
1008 &srw_res->diagnostics, &srw_res->num_diagnostics,
1009 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1011 else if (number > 0)
1015 if (start + number > rr.hits)
1016 number = rr.hits - start + 1;
1018 /* Call bend_present if defined */
1019 if (assoc->init->bend_present)
1021 bend_present_rr *bprr = (bend_present_rr*)
1022 odr_malloc (assoc->decode, sizeof(*bprr));
1023 bprr->setname = "default";
1024 bprr->start = start;
1025 bprr->number = number;
1026 bprr->format = VAL_TEXT_XML;
1027 if (srw_req->recordSchema)
1029 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1030 sizeof(*bprr->comp));
1031 bprr->comp->which = Z_RecordComp_simple;
1032 bprr->comp->u.simple = (Z_ElementSetNames *)
1033 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1034 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1035 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1041 bprr->stream = assoc->encode;
1042 bprr->referenceId = 0;
1043 bprr->print = assoc->print;
1044 bprr->request = req;
1045 bprr->association = assoc;
1047 bprr->errstring = NULL;
1048 (*assoc->init->bend_present)(assoc->backend, bprr);
1054 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1055 yaz_add_srw_diagnostic(assoc->encode,
1056 &srw_res->diagnostics,
1057 &srw_res->num_diagnostics,
1058 srw_error, bprr->errstring);
1066 int packing = Z_SRW_recordPacking_string;
1067 if (srw_req->recordPacking)
1070 yaz_srw_str_to_pack(srw_req->recordPacking);
1072 packing = Z_SRW_recordPacking_string;
1074 srw_res->records = (Z_SRW_record *)
1075 odr_malloc(assoc->encode,
1076 number * sizeof(*srw_res->records));
1078 srw_res->extra_records = (Z_SRW_extra_record **)
1079 odr_malloc(assoc->encode,
1080 number*sizeof(*srw_res->extra_records));
1082 for (i = 0; i<number; i++)
1085 const char *addinfo = 0;
1087 srw_res->records[j].recordPacking = packing;
1088 srw_res->records[j].recordData_buf = 0;
1089 srw_res->extra_records[j] = 0;
1090 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1091 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1092 srw_res->records + j,
1096 yaz_add_srw_diagnostic(assoc->encode,
1097 &srw_res->diagnostics,
1098 &srw_res->num_diagnostics,
1099 yaz_diag_bib1_to_srw (errcode),
1104 if (srw_res->records[j].recordData_buf)
1107 srw_res->num_records = j;
1109 srw_res->records = 0;
1112 if (rr.estimated_hit_count || rr.partial_resultset)
1114 yaz_add_srw_diagnostic(
1116 &srw_res->diagnostics,
1117 &srw_res->num_diagnostics,
1118 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1126 const char *querystr = "?";
1127 const char *querytype = "?";
1128 WRBUF wr = wrbuf_alloc();
1130 switch (srw_req->query_type)
1132 case Z_SRW_query_type_cql:
1134 querystr = srw_req->query.cql;
1136 case Z_SRW_query_type_pqf:
1138 querystr = srw_req->query.pqf;
1141 wrbuf_printf(wr, "SRWSearch ");
1142 wrbuf_printf(wr, srw_req->database);
1143 wrbuf_printf(wr, " ");
1144 if (srw_res->num_diagnostics)
1145 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1146 else if (*http_code != 200)
1147 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1148 else if (srw_res->numberOfRecords)
1150 wrbuf_printf(wr, "OK %d",
1151 (srw_res->numberOfRecords ?
1152 *srw_res->numberOfRecords : 0));
1154 wrbuf_printf(wr, " %s %d+%d",
1155 (srw_res->resultSetId ?
1156 srw_res->resultSetId : "-"),
1157 (srw_req->startRecord ? *srw_req->startRecord : 1),
1158 srw_res->num_records);
1159 yaz_log(log_request, "%s %s: %s", wrbuf_buf(wr), querytype, querystr);
1164 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1167 xmlNodePtr ptr = rr->server_node_ptr;
1170 for (ptr = ptr->children; ptr; ptr = ptr->next)
1172 if (ptr->type != XML_ELEMENT_NODE)
1174 if (!strcmp((const char *) ptr->name, "explain"))
1177 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1181 ptr = xmlCopyNode(ptr, 1);
1183 xmlDocSetRootElement(doc, ptr);
1185 xmlDocDumpMemory(doc, &buf_out, &len);
1186 content = (char*) odr_malloc(rr->stream, 1+len);
1187 memcpy(content, buf_out, len);
1188 content[len] = '\0';
1192 rr->explain_buf = content;
1200 static void srw_bend_explain(association *assoc, request *req,
1202 Z_SRW_explainResponse *srw_res,
1205 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1206 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1208 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1213 rr.stream = assoc->encode;
1214 rr.decode = assoc->decode;
1215 rr.print = assoc->print;
1217 rr.database = srw_req->database;
1219 rr.server_node_ptr = assoc->server->server_node_ptr;
1221 rr.server_node_ptr = 0;
1222 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1223 if (assoc->init->bend_explain)
1224 (*assoc->init->bend_explain)(assoc->backend, &rr);
1226 srw_bend_explain_default(assoc->backend, &rr);
1230 int packing = Z_SRW_recordPacking_string;
1231 if (srw_req->recordPacking)
1234 yaz_srw_str_to_pack(srw_req->recordPacking);
1236 packing = Z_SRW_recordPacking_string;
1238 srw_res->record.recordSchema = rr.schema;
1239 srw_res->record.recordPacking = packing;
1240 srw_res->record.recordData_buf = rr.explain_buf;
1241 srw_res->record.recordData_len = strlen(rr.explain_buf);
1242 srw_res->record.recordPosition = 0;
1248 static void srw_bend_scan(association *assoc, request *req,
1250 Z_SRW_scanResponse *srw_res,
1253 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1254 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1257 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1258 if (srw_res->num_diagnostics == 0 && assoc->init)
1260 struct scan_entry *save_entries;
1262 bend_scan_rr *bsrr = (bend_scan_rr *)
1263 odr_malloc (assoc->encode, sizeof(*bsrr));
1264 bsrr->num_bases = 1;
1265 bsrr->basenames = &srw_req->database;
1267 bsrr->num_entries = srw_req->maximumTerms ?
1268 *srw_req->maximumTerms : 10;
1269 bsrr->term_position = srw_req->responsePosition ?
1270 *srw_req->responsePosition : 1;
1273 bsrr->errstring = 0;
1274 bsrr->referenceId = 0;
1275 bsrr->stream = assoc->encode;
1276 bsrr->print = assoc->print;
1277 bsrr->step_size = odr_intdup(assoc->decode, 0);
1280 if (bsrr->num_entries > 0)
1283 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1285 for (i = 0; i<bsrr->num_entries; i++)
1287 bsrr->entries[i].term = 0;
1288 bsrr->entries[i].occurrences = 0;
1289 bsrr->entries[i].errcode = 0;
1290 bsrr->entries[i].errstring = 0;
1291 bsrr->entries[i].display_term = 0;
1294 save_entries = bsrr->entries; /* save it so we can compare later */
1296 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1297 assoc->init->bend_scan)
1299 Odr_oid *scan_attributeSet = 0;
1301 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1303 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1305 srw_req->scanClause.pqf);
1306 if (scan_attributeSet &&
1307 (attset = oid_getentbyoid(scan_attributeSet)) &&
1308 (attset->oclass == CLASS_ATTSET ||
1309 attset->oclass == CLASS_GENERAL))
1310 bsrr->attributeset = attset->value;
1312 bsrr->attributeset = VAL_NONE;
1313 yaz_pqf_destroy(pqf_parser);
1314 bsrr->scanClause = 0;
1315 ((int (*)(void *, bend_scan_rr *))
1316 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1318 else if (srw_req->query_type == Z_SRW_query_type_cql
1319 && assoc->init->bend_scan && assoc->server
1320 && assoc->server->cql_transform)
1323 bsrr->scanClause = 0;
1324 bsrr->attributeset = VAL_NONE;
1325 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1326 srw_error = cql2pqf_scan(assoc->encode,
1327 srw_req->scanClause.cql,
1328 assoc->server->cql_transform,
1331 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1332 &srw_res->num_diagnostics,
1336 ((int (*)(void *, bend_scan_rr *))
1337 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1340 else if (srw_req->query_type == Z_SRW_query_type_cql
1341 && assoc->init->bend_srw_scan)
1344 bsrr->attributeset = VAL_NONE;
1345 bsrr->scanClause = srw_req->scanClause.cql;
1346 ((int (*)(void *, bend_scan_rr *))
1347 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1351 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1352 &srw_res->num_diagnostics,
1353 YAZ_SRW_UNSUPP_OPERATION, "scan");
1358 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1363 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1365 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1366 &srw_res->num_diagnostics,
1367 srw_error, bsrr->errstring);
1369 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1372 srw_res->terms = (Z_SRW_scanTerm*)
1373 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1376 srw_res->num_terms = bsrr->num_entries;
1377 for (i = 0; i<bsrr->num_entries; i++)
1379 Z_SRW_scanTerm *t = srw_res->terms + i;
1380 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1381 t->numberOfRecords =
1382 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1384 if (save_entries == bsrr->entries &&
1385 bsrr->entries[i].display_term)
1387 /* the entries was _not_ set by the handler. So it's
1388 safe to test for new member display_term. It is
1391 t->displayTerm = odr_strdup(assoc->encode,
1392 bsrr->entries[i].display_term);
1400 WRBUF wr = wrbuf_alloc();
1401 const char *querytype = 0;
1402 const char *querystr = 0;
1404 switch(srw_req->query_type)
1406 case Z_SRW_query_type_pqf:
1408 querystr = srw_req->scanClause.pqf;
1410 case Z_SRW_query_type_cql:
1412 querystr = srw_req->scanClause.cql;
1415 querytype = "UNKNOWN";
1419 wrbuf_printf(wr, "SRWScan ");
1420 wrbuf_printf(wr, srw_req->database);
1421 wrbuf_printf(wr, " ");
1423 if (srw_res->num_diagnostics)
1424 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1425 else if (srw_res->num_terms)
1426 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1428 wrbuf_printf(wr, "OK - - ");
1430 wrbuf_printf(wr, "%d+%d+0 ",
1431 (srw_req->responsePosition ?
1432 *srw_req->responsePosition : 1),
1433 (srw_req->maximumTerms ?
1434 *srw_req->maximumTerms : 1));
1435 /* there is no step size in SRU/W ??? */
1436 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1437 yaz_log(log_request, "%s ", wrbuf_buf(wr) );
1443 static void srw_bend_update(association *assoc, request *req,
1445 Z_SRW_updateResponse *srw_res,
1448 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1449 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1450 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1452 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1456 Z_SRW_extra_record *extra = srw_req->extra_record;
1458 rr.stream = assoc->encode;
1459 rr.print = assoc->print;
1461 rr.basenames = &srw_req->database;
1462 rr.operation = srw_req->operation;
1463 rr.operation_status = "failed";
1465 rr.record_versions = 0;
1466 rr.num_versions = 0;
1467 rr.record_packing = "string";
1468 rr.record_schema = 0;
1470 rr.extra_record_data = 0;
1471 rr.extra_request_data = 0;
1472 rr.extra_response_data = 0;
1478 if (rr.operation == 0)
1480 yaz_add_sru_update_diagnostic(
1481 assoc->encode, &srw_res->diagnostics,
1482 &srw_res->num_diagnostics,
1483 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1487 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1488 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1489 if (!strcmp( rr.operation, "delete"))
1491 if (srw_req->record && !srw_req->record->recordSchema)
1493 rr.record_schema = odr_strdup(
1495 srw_req->record->recordSchema);
1497 if (srw_req->record)
1499 rr.record_data = odr_strdupn(
1501 srw_req->record->recordData_buf,
1502 srw_req->record->recordData_len );
1504 if (extra && extra->extraRecordData_len)
1506 rr.extra_record_data = odr_strdupn(
1508 extra->extraRecordData_buf,
1509 extra->extraRecordData_len );
1511 if (srw_req->recordId)
1512 rr.record_id = srw_req->recordId;
1513 else if (extra && extra->recordIdentifier)
1514 rr.record_id = extra->recordIdentifier;
1516 else if (!strcmp(rr.operation, "replace"))
1518 if (srw_req->recordId)
1519 rr.record_id = srw_req->recordId;
1520 else if (extra && extra->recordIdentifier)
1521 rr.record_id = extra->recordIdentifier;
1524 yaz_add_sru_update_diagnostic(
1525 assoc->encode, &srw_res->diagnostics,
1526 &srw_res->num_diagnostics,
1527 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1528 "recordIdentifier");
1530 if (!srw_req->record)
1532 yaz_add_sru_update_diagnostic(
1533 assoc->encode, &srw_res->diagnostics,
1534 &srw_res->num_diagnostics,
1535 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1540 if (srw_req->record->recordSchema)
1541 rr.record_schema = odr_strdup(
1542 assoc->encode, srw_req->record->recordSchema);
1543 if (srw_req->record->recordData_len )
1545 rr.record_data = odr_strdupn(assoc->encode,
1546 srw_req->record->recordData_buf,
1547 srw_req->record->recordData_len );
1551 yaz_add_sru_update_diagnostic(
1552 assoc->encode, &srw_res->diagnostics,
1553 &srw_res->num_diagnostics,
1554 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1558 if (extra && extra->extraRecordData_len)
1560 rr.extra_record_data = odr_strdupn(
1562 extra->extraRecordData_buf,
1563 extra->extraRecordData_len );
1566 else if (!strcmp(rr.operation, "insert"))
1568 if (srw_req->recordId)
1569 rr.record_id = srw_req->recordId;
1571 rr.record_id = extra->recordIdentifier;
1573 if (srw_req->record)
1575 if (srw_req->record->recordSchema)
1576 rr.record_schema = odr_strdup(
1577 assoc->encode, srw_req->record->recordSchema);
1579 if (srw_req->record->recordData_len)
1580 rr.record_data = odr_strdupn(
1582 srw_req->record->recordData_buf,
1583 srw_req->record->recordData_len );
1585 if (extra && extra->extraRecordData_len)
1587 rr.extra_record_data = odr_strdupn(
1589 extra->extraRecordData_buf,
1590 extra->extraRecordData_len );
1594 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1595 &srw_res->num_diagnostics,
1596 YAZ_SRU_UPDATE_INVALID_ACTION,
1599 if (srw_req->record)
1601 const char *pack_str =
1602 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1604 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1607 if (srw_req->num_recordVersions)
1609 rr.record_versions = srw_req->recordVersions;
1610 rr.num_versions = srw_req->num_recordVersions;
1612 if (srw_req->extraRequestData_len)
1614 rr.extra_request_data = odr_strdupn(assoc->encode,
1615 srw_req->extraRequestData_buf,
1616 srw_req->extraRequestData_len );
1618 if (srw_res->num_diagnostics == 0)
1620 if ( assoc->init->bend_srw_update)
1621 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1623 yaz_add_sru_update_diagnostic(
1624 assoc->encode, &srw_res->diagnostics,
1625 &srw_res->num_diagnostics,
1626 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1627 "No Update backend handler");
1631 yaz_add_srw_diagnostic_uri(assoc->encode,
1632 &srw_res->diagnostics,
1633 &srw_res->num_diagnostics,
1637 srw_res->recordId = rr.record_id;
1638 srw_res->operationStatus = rr.operation_status;
1639 srw_res->recordVersions = rr.record_versions;
1640 srw_res->num_recordVersions = rr.num_versions;
1641 if (srw_res->extraResponseData_len)
1643 srw_res->extraResponseData_buf = rr.extra_response_data;
1644 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1646 if (srw_res->num_diagnostics == 0 && rr.record_data)
1648 srw_res->record = yaz_srw_get_record(assoc->encode);
1649 srw_res->record->recordSchema = rr.record_schema;
1650 if (rr.record_packing)
1652 int pack = yaz_srw_str_to_pack(rr.record_packing);
1656 pack = Z_SRW_recordPacking_string;
1657 yaz_log(YLOG_WARN, "Back packing %s from backend",
1660 srw_res->record->recordPacking = pack;
1662 srw_res->record->recordData_buf = rr.record_data;
1663 srw_res->record->recordData_len = strlen(rr.record_data);
1664 if (rr.extra_record_data)
1666 Z_SRW_extra_record *ex =
1667 yaz_srw_get_extra_record(assoc->encode);
1668 srw_res->extra_record = ex;
1669 ex->extraRecordData_buf = rr.extra_record_data;
1670 ex->extraRecordData_len = strlen(rr.extra_record_data);
1676 /* check if path is OK (1); BAD (0) */
1677 static int check_path(const char *path)
1681 if (strstr(path, ".."))
1686 static char *read_file(const char *fname, ODR o, int *sz)
1689 FILE *inf = fopen(fname, "rb");
1693 fseek(inf, 0L, SEEK_END);
1696 buf = odr_malloc(o, *sz);
1697 fread(buf, 1, *sz, inf);
1702 static void process_http_request(association *assoc, request *req)
1704 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1705 ODR o = assoc->encode;
1706 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1708 Z_SOAP *soap_package = 0;
1711 Z_HTTP_Response *hres = 0;
1713 const char *stylesheet = 0; /* for now .. set later */
1714 Z_SRW_diagnostic *diagnostic = 0;
1715 int num_diagnostic = 0;
1716 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1718 if (!control_association(assoc, host, 0))
1720 p = z_get_HTTP_Response(o, 404);
1723 if (r == 2 && assoc->server && assoc->server->docpath
1724 && hreq->path[0] == '/'
1726 /* check if path is a proper prefix of documentroot */
1727 strncmp(hreq->path+1, assoc->server->docpath,
1728 strlen(assoc->server->docpath))
1731 if (!check_path(hreq->path))
1733 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1734 p = z_get_HTTP_Response(o, 404);
1738 int content_size = 0;
1739 char *content_buf = read_file(hreq->path+1, o, &content_size);
1742 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1743 p = z_get_HTTP_Response(o, 404);
1747 const char *ctype = 0;
1748 yaz_mime_types types = yaz_mime_types_create();
1750 yaz_mime_types_add(types, "xsl", "application/xml");
1751 yaz_mime_types_add(types, "xml", "application/xml");
1752 yaz_mime_types_add(types, "css", "text/css");
1753 yaz_mime_types_add(types, "html", "text/html");
1754 yaz_mime_types_add(types, "htm", "text/html");
1755 yaz_mime_types_add(types, "txt", "text/plain");
1756 yaz_mime_types_add(types, "js", "application/x-javascript");
1758 yaz_mime_types_add(types, "gif", "image/gif");
1759 yaz_mime_types_add(types, "png", "image/png");
1760 yaz_mime_types_add(types, "jpg", "image/jpeg");
1761 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1763 ctype = yaz_mime_lookup_fname(types, hreq->path);
1766 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1767 p = z_get_HTTP_Response(o, 404);
1771 p = z_get_HTTP_Response(o, 200);
1772 hres = p->u.HTTP_Response;
1773 hres->content_buf = content_buf;
1774 hres->content_len = content_size;
1775 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1777 yaz_mime_types_destroy(types);
1785 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1786 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1788 if (r == 2) /* not taken */
1790 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1791 &diagnostic, &num_diagnostic);
1792 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1794 if (r == 0) /* decode SRW/SRU OK .. */
1796 int http_code = 200;
1797 if (sr->which == Z_SRW_searchRetrieve_request)
1800 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1802 stylesheet = sr->u.request->stylesheet;
1805 res->u.response->diagnostics = diagnostic;
1806 res->u.response->num_diagnostics = num_diagnostic;
1810 srw_bend_search(assoc, req, sr, res->u.response,
1813 if (http_code == 200)
1814 soap_package->u.generic->p = res;
1816 else if (sr->which == Z_SRW_explain_request)
1818 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1819 stylesheet = sr->u.explain_request->stylesheet;
1822 res->u.explain_response->diagnostics = diagnostic;
1823 res->u.explain_response->num_diagnostics = num_diagnostic;
1825 srw_bend_explain(assoc, req, sr,
1826 res->u.explain_response, &http_code);
1827 if (http_code == 200)
1828 soap_package->u.generic->p = res;
1830 else if (sr->which == Z_SRW_scan_request)
1832 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1833 stylesheet = sr->u.scan_request->stylesheet;
1836 res->u.scan_response->diagnostics = diagnostic;
1837 res->u.scan_response->num_diagnostics = num_diagnostic;
1839 srw_bend_scan(assoc, req, sr,
1840 res->u.scan_response, &http_code);
1841 if (http_code == 200)
1842 soap_package->u.generic->p = res;
1844 else if (sr->which == Z_SRW_update_request)
1846 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1847 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1850 res->u.update_response->diagnostics = diagnostic;
1851 res->u.update_response->num_diagnostics = num_diagnostic;
1853 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1854 srw_bend_update(assoc, req, sr,
1855 res->u.update_response, &http_code);
1856 if (http_code == 200)
1857 soap_package->u.generic->p = res;
1861 yaz_log(log_request, "SOAP ERROR");
1862 /* FIXME - what error, what query */
1864 z_soap_error(assoc->encode, soap_package,
1865 "SOAP-ENV:Client", "Bad method", 0);
1867 if (http_code == 200 || http_code == 500)
1869 static Z_SOAP_Handler soap_handlers[4] = {
1871 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1872 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1873 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1879 p = z_get_HTTP_Response(o, 200);
1880 hres = p->u.HTTP_Response;
1882 if (!stylesheet && assoc->server)
1883 stylesheet = assoc->server->stylesheet;
1885 /* empty stylesheet means NO stylesheet */
1886 if (stylesheet && *stylesheet == '\0')
1889 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1890 &hres->content_buf, &hres->content_len,
1891 soap_handlers, charset, stylesheet);
1892 hres->code = http_code;
1894 strcpy(ctype, "text/xml");
1897 strcat(ctype, "; charset=");
1898 strcat(ctype, charset);
1900 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1903 p = z_get_HTTP_Response(o, http_code);
1907 p = z_get_HTTP_Response(o, 500);
1908 hres = p->u.HTTP_Response;
1909 if (!strcmp(hreq->version, "1.0"))
1911 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1912 if (v && !strcmp(v, "Keep-Alive"))
1916 hres->version = "1.0";
1920 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1921 if (v && !strcmp(v, "close"))
1925 hres->version = "1.1";
1929 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1930 assoc->state = ASSOC_DEAD;
1931 assoc->cs_get_mask = 0;
1936 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1938 if (alive && isdigit(*(const unsigned char *) alive))
1942 if (t < 0 || t > 3600)
1944 iochan_settimeout(assoc->client_chan,t);
1945 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1947 process_gdu_response(assoc, req, p);
1950 static void process_gdu_request(association *assoc, request *req)
1952 if (req->gdu_request->which == Z_GDU_Z3950)
1955 req->apdu_request = req->gdu_request->u.z3950;
1956 if (process_z_request(assoc, req, &msg) < 0)
1957 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1959 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1960 process_http_request(assoc, req);
1963 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1968 * Initiate request processing.
1970 static int process_z_request(association *assoc, request *req, char **msg)
1976 *msg = "Unknown Error";
1977 assert(req && req->state == REQUEST_IDLE);
1978 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1980 *msg = "Missing InitRequest";
1983 switch (req->apdu_request->which)
1985 case Z_APDU_initRequest:
1986 res = process_initRequest(assoc, req); break;
1987 case Z_APDU_searchRequest:
1988 res = process_searchRequest(assoc, req, &fd); break;
1989 case Z_APDU_presentRequest:
1990 res = process_presentRequest(assoc, req, &fd); break;
1991 case Z_APDU_scanRequest:
1992 if (assoc->init->bend_scan)
1993 res = process_scanRequest(assoc, req, &fd);
1996 *msg = "Cannot handle Scan APDU";
2000 case Z_APDU_extendedServicesRequest:
2001 if (assoc->init->bend_esrequest)
2002 res = process_ESRequest(assoc, req, &fd);
2005 *msg = "Cannot handle Extended Services APDU";
2009 case Z_APDU_sortRequest:
2010 if (assoc->init->bend_sort)
2011 res = process_sortRequest(assoc, req, &fd);
2014 *msg = "Cannot handle Sort APDU";
2019 process_close(assoc, req);
2021 case Z_APDU_deleteResultSetRequest:
2022 if (assoc->init->bend_delete)
2023 res = process_deleteRequest(assoc, req, &fd);
2026 *msg = "Cannot handle Delete APDU";
2030 case Z_APDU_segmentRequest:
2031 if (assoc->init->bend_segment)
2033 res = process_segmentRequest (assoc, req);
2037 *msg = "Cannot handle Segment APDU";
2041 case Z_APDU_triggerResourceControlRequest:
2044 *msg = "Bad APDU received";
2049 yaz_log(YLOG_DEBUG, " result immediately available");
2050 retval = process_z_response(assoc, req, res);
2054 yaz_log(YLOG_DEBUG, " result unavailble");
2057 else /* no result yet - one will be provided later */
2061 /* Set up an I/O handler for the fd supplied by the backend */
2063 yaz_log(YLOG_DEBUG, " establishing handler for result");
2064 req->state = REQUEST_PENDING;
2065 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2067 iochan_setdata(chan, assoc);
2074 * Handle message from the backend.
2076 void backend_response(IOCHAN i, int event)
2078 association *assoc = (association *)iochan_getdata(i);
2079 request *req = request_head(&assoc->incoming);
2083 yaz_log(YLOG_DEBUG, "backend_response");
2084 assert(assoc && req && req->state != REQUEST_IDLE);
2085 /* determine what it is we're waiting for */
2086 switch (req->apdu_request->which)
2088 case Z_APDU_searchRequest:
2089 res = response_searchRequest(assoc, req, 0, &fd); break;
2091 case Z_APDU_presentRequest:
2092 res = response_presentRequest(assoc, req, 0, &fd); break;
2093 case Z_APDU_scanRequest:
2094 res = response_scanRequest(assoc, req, 0, &fd); break;
2097 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2100 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2102 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2103 do_close(assoc, Z_Close_systemProblem, 0);
2107 else if (!res) /* no result yet - try again later */
2109 yaz_log(YLOG_DEBUG, " no result yet");
2110 iochan_setfd(i, fd); /* in case fd has changed */
2115 * Encode response, and transfer the request structure to the outgoing queue.
2117 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2119 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2123 if (!z_GDU(assoc->print, &res, 0, 0))
2124 yaz_log(YLOG_WARN, "ODR print error: %s",
2125 odr_errmsg(odr_geterror(assoc->print)));
2126 odr_reset(assoc->print);
2128 if (!z_GDU(assoc->encode, &res, 0, 0))
2130 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2131 odr_errmsg(odr_geterror(assoc->decode)),
2132 odr_getelement(assoc->decode));
2135 req->response = odr_getbuf(assoc->encode, &req->len_response,
2136 &req->size_response);
2137 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2138 odr_reset(assoc->encode);
2139 req->state = REQUEST_IDLE;
2140 request_enq(&assoc->outgoing, req);
2141 /* turn the work over to the ir_session handler */
2142 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2143 assoc->cs_put_mask = EVENT_OUTPUT;
2144 /* Is there more work to be done? give that to the input handler too */
2147 req = request_head(&assoc->incoming);
2148 if (req && req->state == REQUEST_IDLE)
2150 request_deq(&assoc->incoming);
2151 process_gdu_request(assoc, req);
2160 * Encode response, and transfer the request structure to the outgoing queue.
2162 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2164 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2165 gres->which = Z_GDU_Z3950;
2166 gres->u.z3950 = res;
2168 return process_gdu_response(assoc, req, gres);
2171 static char *get_vhost(Z_OtherInformation *otherInfo)
2173 return yaz_oi_get_string_oidval(&otherInfo, VAL_PROXY, 1, 0);
2177 * Handle init request.
2178 * At the moment, we don't check the options
2179 * anywhere else in the code - we just try not to do anything that would
2180 * break a naive client. We'll toss 'em into the association block when
2181 * we need them there.
2183 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2185 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2186 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2187 Z_InitResponse *resp = apdu->u.initResponse;
2188 bend_initresult *binitres;
2191 statserv_options_block *cb = 0; /* by default no control for backend */
2193 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2194 cb = statserv_getcontrol(); /* got control block for backend */
2196 if (cb && assoc->backend)
2197 (*cb->bend_close)(assoc->backend);
2199 yaz_log(log_requestdetail, "Got initRequest");
2200 if (req->implementationId)
2201 yaz_log(log_requestdetail, "Id: %s",
2202 req->implementationId);
2203 if (req->implementationName)
2204 yaz_log(log_requestdetail, "Name: %s",
2205 req->implementationName);
2206 if (req->implementationVersion)
2207 yaz_log(log_requestdetail, "Version: %s",
2208 req->implementationVersion);
2210 assoc_init_reset(assoc);
2212 assoc->init->auth = req->idAuthentication;
2213 assoc->init->referenceId = req->referenceId;
2215 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2217 Z_CharSetandLanguageNegotiation *negotiation =
2218 yaz_get_charneg_record (req->otherInfo);
2220 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2221 assoc->init->charneg_request = negotiation;
2227 if (req->implementationVersion)
2228 yaz_log(log_requestdetail, "Config: %s",
2231 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2233 /* we have a backend control block, so call that init function */
2234 if (!(binitres = (*cb->bend_init)(assoc->init)))
2236 yaz_log(YLOG_WARN, "Bad response from backend.");
2239 assoc->backend = binitres->handle;
2243 /* no backend. return error */
2244 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2245 binitres->errstring = 0;
2246 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2247 iochan_settimeout(assoc->client_chan, 10);
2249 if ((assoc->init->bend_sort))
2250 yaz_log (YLOG_DEBUG, "Sort handler installed");
2251 if ((assoc->init->bend_search))
2252 yaz_log (YLOG_DEBUG, "Search handler installed");
2253 if ((assoc->init->bend_present))
2254 yaz_log (YLOG_DEBUG, "Present handler installed");
2255 if ((assoc->init->bend_esrequest))
2256 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2257 if ((assoc->init->bend_delete))
2258 yaz_log (YLOG_DEBUG, "Delete handler installed");
2259 if ((assoc->init->bend_scan))
2260 yaz_log (YLOG_DEBUG, "Scan handler installed");
2261 if ((assoc->init->bend_segment))
2262 yaz_log (YLOG_DEBUG, "Segment handler installed");
2264 resp->referenceId = req->referenceId;
2266 /* let's tell the client what we can do */
2267 if (ODR_MASK_GET(req->options, Z_Options_search))
2269 ODR_MASK_SET(resp->options, Z_Options_search);
2270 strcat(options, "srch");
2272 if (ODR_MASK_GET(req->options, Z_Options_present))
2274 ODR_MASK_SET(resp->options, Z_Options_present);
2275 strcat(options, " prst");
2277 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2278 assoc->init->bend_delete)
2280 ODR_MASK_SET(resp->options, Z_Options_delSet);
2281 strcat(options, " del");
2283 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2284 assoc->init->bend_esrequest)
2286 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2287 strcat (options, " extendedServices");
2289 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2291 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2292 strcat(options, " namedresults");
2294 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2296 ODR_MASK_SET(resp->options, Z_Options_scan);
2297 strcat(options, " scan");
2299 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2301 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2302 strcat(options, " concurrop");
2304 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2306 ODR_MASK_SET(resp->options, Z_Options_sort);
2307 strcat(options, " sort");
2310 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
2311 && assoc->init->charneg_response)
2313 Z_OtherInformation **p;
2314 Z_OtherInformationUnit *p0;
2316 yaz_oi_APDU(apdu, &p);
2318 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2319 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2321 p0->which = Z_OtherInfo_externallyDefinedInfo;
2322 p0->information.externallyDefinedInfo =
2323 assoc->init->charneg_response;
2325 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2326 strcat(options, " negotiation");
2329 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2330 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2332 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2334 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2335 assoc->version = 1; /* 1 & 2 are equivalent */
2337 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2339 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2342 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2344 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2348 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2350 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2351 assoc->maximumRecordSize = *req->maximumRecordSize;
2353 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2354 assoc->preferredMessageSize = *req->preferredMessageSize;
2356 resp->preferredMessageSize = &assoc->preferredMessageSize;
2357 resp->maximumRecordSize = &assoc->maximumRecordSize;
2359 resp->implementationId = odr_prepend(assoc->encode,
2360 assoc->init->implementation_id,
2361 resp->implementationId);
2363 resp->implementationName = odr_prepend(assoc->encode,
2364 assoc->init->implementation_name,
2365 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2367 version = odr_strdup(assoc->encode, "$Revision: 1.111 $");
2368 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2369 version[strlen(version)-2] = '\0';
2370 resp->implementationVersion = odr_prepend(assoc->encode,
2371 assoc->init->implementation_version,
2372 odr_prepend(assoc->encode, &version[11],
2373 resp->implementationVersion));
2375 if (binitres->errcode)
2377 assoc->state = ASSOC_DEAD;
2378 resp->userInformationField =
2379 init_diagnostics(assoc->encode, binitres->errcode,
2380 binitres->errstring);
2385 if (!req->idAuthentication)
2386 yaz_log(log_request, "Auth none");
2387 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2389 const char *open = req->idAuthentication->u.open;
2390 const char *slash = strchr(open, '/');
2396 yaz_log(log_request, "Auth open %.*s", len, open);
2398 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2400 const char *user = req->idAuthentication->u.idPass->userId;
2401 const char *group = req->idAuthentication->u.idPass->groupId;
2402 yaz_log(log_request, "Auth idPass %s %s",
2403 user ? user : "-", group ? group : "-");
2405 else if (req->idAuthentication->which
2406 == Z_IdAuthentication_anonymous)
2408 yaz_log(log_request, "Auth anonymous");
2412 yaz_log(log_request, "Auth other");
2417 WRBUF wr = wrbuf_alloc();
2418 wrbuf_printf(wr, "Init ");
2419 if (binitres->errcode)
2420 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2422 wrbuf_printf(wr, "OK -");
2423 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2424 (req->implementationId ? req->implementationId :"-"),
2425 (req->implementationName ?
2426 req->implementationName : "-"),
2427 (req->implementationVersion ?
2428 req->implementationVersion : "-")
2430 yaz_log(log_request, "%s", wrbuf_buf(wr));
2437 * Set the specified `errcode' and `errstring' into a UserInfo-1
2438 * external to be returned to the client in accordance with Z35.90
2439 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2440 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2442 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2444 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2445 addinfo ? " -- " : "", addinfo ? addinfo : "");
2446 return zget_init_diagnostics(odr, error, addinfo);
2450 * nonsurrogate diagnostic record.
2452 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2454 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2456 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2457 addinfo ? " -- " : "", addinfo ? addinfo : "");
2459 rec->which = Z_Records_NSD;
2460 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2466 * surrogate diagnostic.
2468 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2470 int error, const char *addinfo)
2472 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2473 addinfo ? " -- " : "", addinfo ? addinfo : "");
2474 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2477 static Z_Records *pack_records(association *a, char *setname, int start,
2478 int *num, Z_RecordComposition *comp,
2479 int *next, int *pres, oid_value format,
2480 Z_ReferenceId *referenceId,
2481 int *oid, int *errcode)
2483 int recno, total_length = 0, toget = *num, dumped_records = 0;
2484 Z_Records *records =
2485 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2486 Z_NamePlusRecordList *reclist =
2487 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2488 Z_NamePlusRecord **list =
2489 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2491 records->which = Z_Records_DBOSD;
2492 records->u.databaseOrSurDiagnostics = reclist;
2493 reclist->num_records = 0;
2494 reclist->records = list;
2495 *pres = Z_PresentStatus_success;
2499 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2500 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2501 a->maximumRecordSize);
2502 for (recno = start; reclist->num_records < toget; recno++)
2505 Z_NamePlusRecord *thisrec;
2506 int this_length = 0;
2508 * we get the number of bytes allocated on the stream before any
2509 * allocation done by the backend - this should give us a reasonable
2510 * idea of the total size of the data so far.
2512 total_length = odr_total(a->encode) - dumped_records;
2518 freq.last_in_set = 0;
2519 freq.setname = setname;
2520 freq.surrogate_flag = 0;
2521 freq.number = recno;
2523 freq.request_format = format;
2524 freq.request_format_raw = oid;
2525 freq.output_format = format;
2526 freq.output_format_raw = 0;
2527 freq.stream = a->encode;
2528 freq.print = a->print;
2529 freq.referenceId = referenceId;
2532 retrieve_fetch(a, &freq);
2534 *next = freq.last_in_set ? 0 : recno + 1;
2536 /* backend should be able to signal whether error is system-wide
2537 or only pertaining to current record */
2540 if (!freq.surrogate_flag)
2543 *pres = Z_PresentStatus_failure;
2544 /* for 'present request out of range',
2545 set addinfo to record position if not set */
2546 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2547 freq.errstring == 0)
2549 sprintf (s, "%d", recno);
2553 *errcode = freq.errcode;
2554 return diagrec(a, freq.errcode, freq.errstring);
2556 reclist->records[reclist->num_records] =
2557 surrogatediagrec(a, freq.basename, freq.errcode,
2559 reclist->num_records++;
2562 if (freq.record == 0) /* no error and no record ? */
2564 *next = 0; /* signal end-of-set and stop */
2568 this_length = freq.len;
2570 this_length = odr_total(a->encode) - total_length - dumped_records;
2571 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2572 this_length, total_length, dumped_records);
2573 if (a->preferredMessageSize > 0 &&
2574 this_length + total_length > a->preferredMessageSize)
2576 /* record is small enough, really */
2577 if (this_length <= a->preferredMessageSize && recno > start)
2579 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2580 *pres = Z_PresentStatus_partial_2;
2583 /* record can only be fetched by itself */
2584 if (this_length < a->maximumRecordSize)
2586 yaz_log(log_requestdetail, " Record > prefmsgsz");
2589 yaz_log(YLOG_DEBUG, " Dropped it");
2590 reclist->records[reclist->num_records] =
2591 surrogatediagrec(a, freq.basename, 16, 0);
2592 reclist->num_records++;
2593 dumped_records += this_length;
2597 else /* too big entirely */
2599 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2600 this_length, a->maximumRecordSize);
2601 reclist->records[reclist->num_records] =
2602 surrogatediagrec(a, freq.basename, 17, 0);
2603 reclist->num_records++;
2604 dumped_records += this_length;
2609 if (!(thisrec = (Z_NamePlusRecord *)
2610 odr_malloc(a->encode, sizeof(*thisrec))))
2613 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2615 thisrec->databaseName = 0;
2616 thisrec->which = Z_NamePlusRecord_databaseRecord;
2618 if (freq.output_format_raw)
2620 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
2621 freq.output_format = ident->value;
2623 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
2624 freq.record, freq.len);
2625 if (!thisrec->u.databaseRecord)
2627 reclist->records[reclist->num_records] = thisrec;
2628 reclist->num_records++;
2630 *num = reclist->num_records;
2634 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2637 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2638 bend_search_rr *bsrr =
2639 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2641 yaz_log(log_requestdetail, "Got SearchRequest.");
2643 bsrr->request = reqb;
2644 bsrr->association = assoc;
2645 bsrr->referenceId = req->referenceId;
2646 save_referenceId (reqb, bsrr->referenceId);
2647 bsrr->srw_sortKeys = 0;
2648 bsrr->srw_setname = 0;
2649 bsrr->srw_setnameIdleTime = 0;
2650 bsrr->estimated_hit_count = 0;
2651 bsrr->partial_resultset = 0;
2653 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2654 if (req->databaseNames)
2657 for (i = 0; i < req->num_databaseNames; i++)
2658 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2661 yaz_log_zquery_level(log_requestdetail,req->query);
2663 if (assoc->init->bend_search)
2665 bsrr->setname = req->resultSetName;
2666 bsrr->replace_set = *req->replaceIndicator;
2667 bsrr->num_bases = req->num_databaseNames;
2668 bsrr->basenames = req->databaseNames;
2669 bsrr->query = req->query;
2670 bsrr->stream = assoc->encode;
2671 nmem_transfer(bsrr->stream->mem, reqb->request_mem);
2672 bsrr->decode = assoc->decode;
2673 bsrr->print = assoc->print;
2676 bsrr->errstring = NULL;
2677 bsrr->search_info = NULL;
2679 if (assoc->server && assoc->server->cql_transform
2680 && req->query->which == Z_Query_type_104
2681 && req->query->u.type_104->which == Z_External_CQL)
2683 /* have a CQL query and a CQL to PQF transform .. */
2685 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2686 assoc->server->cql_transform, bsrr->query);
2688 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2691 (assoc->init->bend_search)(assoc->backend, bsrr);
2692 if (!bsrr->request) /* backend not ready with the search response */
2693 return 0; /* should not be used any more */
2697 /* FIXME - make a diagnostic for it */
2698 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2700 return response_searchRequest(assoc, reqb, bsrr, fd);
2703 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2706 * Prepare a searchresponse based on the backend results. We probably want
2707 * to look at making the fetching of records nonblocking as well, but
2708 * so far, we'll keep things simple.
2709 * If bsrt is null, that means we're called in response to a communications
2710 * event, and we'll have to get the response for ourselves.
2712 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2713 bend_search_rr *bsrt, int *fd)
2715 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2716 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2717 Z_SearchResponse *resp = (Z_SearchResponse *)
2718 odr_malloc (assoc->encode, sizeof(*resp));
2719 int *nulint = odr_intdup (assoc->encode, 0);
2720 int *next = odr_intdup(assoc->encode, 0);
2721 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2722 int returnedrecs = 0;
2724 apdu->which = Z_APDU_searchResponse;
2725 apdu->u.searchResponse = resp;
2726 resp->referenceId = req->referenceId;
2727 resp->additionalSearchInfo = 0;
2728 resp->otherInfo = 0;
2730 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2732 yaz_log(YLOG_FATAL, "Bad result from backend");
2735 else if (bsrt->errcode)
2737 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2738 resp->resultCount = nulint;
2739 resp->numberOfRecordsReturned = nulint;
2740 resp->nextResultSetPosition = nulint;
2741 resp->searchStatus = nulint;
2742 resp->resultSetStatus = none;
2743 resp->presentStatus = 0;
2747 bool_t *sr = odr_intdup(assoc->encode, 1);
2748 int *toget = odr_intdup(assoc->encode, 0);
2749 Z_RecordComposition comp, *compp = 0;
2751 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2754 resp->resultCount = &bsrt->hits;
2756 comp.which = Z_RecordComp_simple;
2757 /* how many records does the user agent want, then? */
2758 if (bsrt->hits <= *req->smallSetUpperBound)
2760 *toget = bsrt->hits;
2761 if ((comp.u.simple = req->smallSetElementSetNames))
2764 else if (bsrt->hits < *req->largeSetLowerBound)
2766 *toget = *req->mediumSetPresentNumber;
2767 if (*toget > bsrt->hits)
2768 *toget = bsrt->hits;
2769 if ((comp.u.simple = req->mediumSetElementSetNames))
2775 if (*toget && !resp->records)
2779 int *presst = odr_intdup(assoc->encode, 0);
2781 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2784 form = prefformat->value;
2786 /* Call bend_present if defined */
2787 if (assoc->init->bend_present)
2789 bend_present_rr *bprr = (bend_present_rr *)
2790 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2791 bprr->setname = req->resultSetName;
2793 bprr->number = *toget;
2794 bprr->format = form;
2796 bprr->referenceId = req->referenceId;
2797 bprr->stream = assoc->encode;
2798 bprr->print = assoc->print;
2799 bprr->request = reqb;
2800 bprr->association = assoc;
2802 bprr->errstring = NULL;
2803 (*assoc->init->bend_present)(assoc->backend, bprr);
2809 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2810 *resp->presentStatus = Z_PresentStatus_failure;
2815 resp->records = pack_records(assoc, req->resultSetName, 1,
2816 toget, compp, next, presst, form, req->referenceId,
2817 req->preferredRecordSyntax, NULL);
2820 resp->numberOfRecordsReturned = toget;
2821 returnedrecs = *toget;
2822 resp->presentStatus = presst;
2826 if (*resp->resultCount)
2828 resp->numberOfRecordsReturned = nulint;
2829 resp->presentStatus = 0;
2831 resp->nextResultSetPosition = next;
2832 resp->searchStatus = sr;
2833 resp->resultSetStatus = 0;
2834 if (bsrt->estimated_hit_count)
2836 resp->resultSetStatus = odr_intdup(assoc->encode,
2837 Z_SearchResponse_estimate);
2839 else if (bsrt->partial_resultset)
2841 resp->resultSetStatus = odr_intdup(assoc->encode,
2842 Z_SearchResponse_subset);
2845 resp->additionalSearchInfo = bsrt->search_info;
2850 WRBUF wr = wrbuf_alloc();
2852 for (i = 0 ; i < req->num_databaseNames; i++){
2854 wrbuf_printf(wr, "+");
2855 wrbuf_printf(wr, req->databaseNames[i]);
2857 wrbuf_printf(wr, " ");
2860 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2862 wrbuf_printf(wr, "OK %d", bsrt->hits);
2863 wrbuf_printf(wr, " %s 1+%d ",
2864 req->resultSetName, returnedrecs);
2865 yaz_query_to_wrbuf(wr, req->query);
2867 yaz_log(log_request, "Search %s", wrbuf_buf(wr));
2874 * Maybe we got a little over-friendly when we designed bend_fetch to
2875 * get only one record at a time. Some backends can optimise multiple-record
2876 * fetches, and at any rate, there is some overhead involved in
2877 * all that selecting and hopping around. Problem is, of course, that the
2878 * frontend can't know ahead of time how many records it'll need to
2879 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2880 * is downright lousy as a bulk data transfer protocol.
2882 * To start with, we'll do the fetching of records from the backend
2883 * in one operation: To save some trips in and out of the event-handler,
2884 * and to simplify the interface to pack_records. At any rate, asynch
2885 * operation is more fun in operations that have an unpredictable execution
2886 * speed - which is normally more true for search than for present.
2888 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2891 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2895 Z_PresentResponse *resp;
2899 const char *errstring = 0;
2901 yaz_log(log_requestdetail, "Got PresentRequest.");
2903 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2906 form = prefformat->value;
2907 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2909 resp->presentStatus = odr_intdup(assoc->encode, 0);
2910 if (assoc->init->bend_present)
2912 bend_present_rr *bprr = (bend_present_rr *)
2913 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2914 bprr->setname = req->resultSetId;
2915 bprr->start = *req->resultSetStartPoint;
2916 bprr->number = *req->numberOfRecordsRequested;
2917 bprr->format = form;
2918 bprr->comp = req->recordComposition;
2919 bprr->referenceId = req->referenceId;
2920 bprr->stream = assoc->encode;
2921 bprr->print = assoc->print;
2922 bprr->request = reqb;
2923 bprr->association = assoc;
2925 bprr->errstring = NULL;
2926 (*assoc->init->bend_present)(assoc->backend, bprr);
2929 return 0; /* should not happen */
2932 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2933 *resp->presentStatus = Z_PresentStatus_failure;
2934 errcode = bprr->errcode;
2935 errstring = bprr->errstring;
2938 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2939 next = odr_intdup(assoc->encode, 0);
2940 num = odr_intdup(assoc->encode, 0);
2942 apdu->which = Z_APDU_presentResponse;
2943 apdu->u.presentResponse = resp;
2944 resp->referenceId = req->referenceId;
2945 resp->otherInfo = 0;
2949 *num = *req->numberOfRecordsRequested;
2951 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2952 num, req->recordComposition, next,
2953 resp->presentStatus,
2954 form, req->referenceId, req->preferredRecordSyntax,
2959 WRBUF wr = wrbuf_alloc();
2960 wrbuf_printf(wr, "Present ");
2962 if (*resp->presentStatus == Z_PresentStatus_failure)
2963 wrbuf_printf(wr, "ERROR %d ", errcode);
2964 else if (*resp->presentStatus == Z_PresentStatus_success)
2965 wrbuf_printf(wr, "OK - ");
2967 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2969 wrbuf_printf(wr, " %s %d+%d ",
2970 req->resultSetId, *req->resultSetStartPoint,
2971 *req->numberOfRecordsRequested);
2972 yaz_log(log_request, "%s", wrbuf_buf(wr) );
2977 resp->numberOfRecordsReturned = num;
2978 resp->nextResultSetPosition = next;
2984 * Scan was implemented rather in a hurry, and with support for only the basic
2985 * elements of the service in the backend API. Suggestions are welcome.
2987 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2989 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2990 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2991 Z_ScanResponse *res = (Z_ScanResponse *)
2992 odr_malloc (assoc->encode, sizeof(*res));
2993 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2994 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2995 Z_ListEntries *ents = (Z_ListEntries *)
2996 odr_malloc (assoc->encode, sizeof(*ents));
2997 Z_DiagRecs *diagrecs_p = NULL;
2999 bend_scan_rr *bsrr = (bend_scan_rr *)
3000 odr_malloc (assoc->encode, sizeof(*bsrr));
3001 struct scan_entry *save_entries;
3003 yaz_log(log_requestdetail, "Got ScanRequest");
3005 apdu->which = Z_APDU_scanResponse;
3006 apdu->u.scanResponse = res;
3007 res->referenceId = req->referenceId;
3009 /* if step is absent, set it to 0 */
3010 res->stepSize = odr_intdup(assoc->encode, 0);
3012 *res->stepSize = *req->stepSize;
3014 res->scanStatus = scanStatus;
3015 res->numberOfEntriesReturned = numberOfEntriesReturned;
3016 res->positionOfTerm = 0;
3017 res->entries = ents;
3018 ents->num_entries = 0;
3019 ents->entries = NULL;
3020 ents->num_nonsurrogateDiagnostics = 0;
3021 ents->nonsurrogateDiagnostics = NULL;
3022 res->attributeSet = 0;
3025 if (req->databaseNames)
3028 for (i = 0; i < req->num_databaseNames; i++)
3029 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
3031 bsrr->scanClause = 0;
3033 bsrr->errstring = 0;
3034 bsrr->num_bases = req->num_databaseNames;
3035 bsrr->basenames = req->databaseNames;
3036 bsrr->num_entries = *req->numberOfTermsRequested;
3037 bsrr->term = req->termListAndStartPoint;
3038 bsrr->referenceId = req->referenceId;
3039 bsrr->stream = assoc->encode;
3040 bsrr->print = assoc->print;
3041 bsrr->step_size = res->stepSize;
3043 /* For YAZ 2.0 and earlier it was the backend handler that
3044 initialized entries (member display_term did not exist)
3045 YAZ 2.0 and later sets 'entries' and initialize all members
3046 including 'display_term'. If YAZ 2.0 or later sees that
3047 entries was modified - we assume that it is an old handler and
3048 that 'display_term' is _not_ set.
3050 if (bsrr->num_entries > 0)
3053 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3055 for (i = 0; i<bsrr->num_entries; i++)
3057 bsrr->entries[i].term = 0;
3058 bsrr->entries[i].occurrences = 0;
3059 bsrr->entries[i].errcode = 0;
3060 bsrr->entries[i].errstring = 0;
3061 bsrr->entries[i].display_term = 0;
3064 save_entries = bsrr->entries; /* save it so we can compare later */
3066 if (req->attributeSet &&
3067 (attset = oid_getentbyoid(req->attributeSet)) &&
3068 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
3069 bsrr->attributeset = attset->value;
3071 bsrr->attributeset = VAL_NONE;
3072 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3073 bsrr->attributeset);
3074 bsrr->term_position = req->preferredPositionInResponse ?
3075 *req->preferredPositionInResponse : 1;
3077 ((int (*)(void *, bend_scan_rr *))
3078 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3081 diagrecs_p = zget_DiagRecs(assoc->encode,
3082 bsrr->errcode, bsrr->errstring);
3086 Z_Entry **tab = (Z_Entry **)
3087 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3089 if (bsrr->status == BEND_SCAN_PARTIAL)
3090 *scanStatus = Z_Scan_partial_5;
3092 *scanStatus = Z_Scan_success;
3093 ents->entries = tab;
3094 ents->num_entries = bsrr->num_entries;
3095 res->numberOfEntriesReturned = &ents->num_entries;
3096 res->positionOfTerm = &bsrr->term_position;
3097 for (i = 0; i < bsrr->num_entries; i++)
3103 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3104 if (bsrr->entries[i].occurrences >= 0)
3106 e->which = Z_Entry_termInfo;
3107 e->u.termInfo = t = (Z_TermInfo *)
3108 odr_malloc(assoc->encode, sizeof(*t));
3109 t->suggestedAttributes = 0;
3111 if (save_entries == bsrr->entries &&
3112 bsrr->entries[i].display_term)
3114 /* the entries was _not_ set by the handler. So it's
3115 safe to test for new member display_term. It is
3118 t->displayTerm = odr_strdup(assoc->encode,
3119 bsrr->entries[i].display_term);
3121 t->alternativeTerm = 0;
3122 t->byAttributes = 0;
3123 t->otherTermInfo = 0;
3124 t->globalOccurrences = &bsrr->entries[i].occurrences;
3125 t->term = (Z_Term *)
3126 odr_malloc(assoc->encode, sizeof(*t->term));
3127 t->term->which = Z_Term_general;
3128 t->term->u.general = o =
3129 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3130 o->buf = (unsigned char *)
3131 odr_malloc(assoc->encode, o->len = o->size =
3132 strlen(bsrr->entries[i].term));
3133 memcpy(o->buf, bsrr->entries[i].term, o->len);
3134 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3135 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3139 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3140 bsrr->entries[i].errcode,
3141 bsrr->entries[i].errstring);
3142 assert (drecs->num_diagRecs == 1);
3143 e->which = Z_Entry_surrogateDiagnostic;
3144 assert (drecs->diagRecs[0]);
3145 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3151 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3152 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3157 WRBUF wr = wrbuf_alloc();
3158 wrbuf_printf(wr, "Scan ");
3159 for (i = 0 ; i < req->num_databaseNames; i++){
3161 wrbuf_printf(wr, "+");
3162 wrbuf_printf(wr, req->databaseNames[i]);
3164 wrbuf_printf(wr, " ");
3167 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3168 wrbuf_printf(wr, " ");
3171 wrbuf_printf(wr, "OK ");
3172 /* else if (*res->scanStatus == Z_Scan_success) */
3173 /* wrbuf_printf(wr, "OK "); */
3175 /* wrbuf_printf(wr, "Partial "); */
3177 if (*res->numberOfEntriesReturned)
3178 wrbuf_printf(wr, "%d - ", *res->numberOfEntriesReturned);
3180 wrbuf_printf(wr, "0 - ");
3182 wrbuf_printf(wr, "%d+%d+%d ",
3183 (req->preferredPositionInResponse ?
3184 *req->preferredPositionInResponse : 1),
3185 *req->numberOfTermsRequested,
3186 (res->stepSize ? *res->stepSize : 1));
3188 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3189 bsrr->attributeset);
3190 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3196 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3200 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3201 Z_SortResponse *res = (Z_SortResponse *)
3202 odr_malloc (assoc->encode, sizeof(*res));
3203 bend_sort_rr *bsrr = (bend_sort_rr *)
3204 odr_malloc (assoc->encode, sizeof(*bsrr));
3206 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3208 yaz_log(log_requestdetail, "Got SortRequest.");
3210 bsrr->num_input_setnames = req->num_inputResultSetNames;
3211 for (i=0;i<req->num_inputResultSetNames;i++)
3212 yaz_log(log_requestdetail, "Input resultset: '%s'",
3213 req->inputResultSetNames[i]);
3214 bsrr->input_setnames = req->inputResultSetNames;
3215 bsrr->referenceId = req->referenceId;
3216 bsrr->output_setname = req->sortedResultSetName;
3217 yaz_log(log_requestdetail, "Output resultset: '%s'",
3218 req->sortedResultSetName);
3219 bsrr->sort_sequence = req->sortSequence;
3220 /*FIXME - dump those sequences too */
3221 bsrr->stream = assoc->encode;
3222 bsrr->print = assoc->print;
3224 bsrr->sort_status = Z_SortResponse_failure;
3226 bsrr->errstring = 0;
3228 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3230 res->referenceId = bsrr->referenceId;
3231 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3232 res->resultSetStatus = 0;
3235 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3236 bsrr->errcode, bsrr->errstring);
3237 res->diagnostics = dr->diagRecs;
3238 res->num_diagnostics = dr->num_diagRecs;
3242 res->num_diagnostics = 0;
3243 res->diagnostics = 0;
3245 res->resultCount = 0;
3248 apdu->which = Z_APDU_sortResponse;
3249 apdu->u.sortResponse = res;
3252 WRBUF wr = wrbuf_alloc();
3253 wrbuf_printf(wr, "Sort ");
3255 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3257 wrbuf_printf(wr, "OK -");
3258 wrbuf_printf(wr, " (");
3259 for (i = 0; i<req->num_inputResultSetNames; i++)
3262 wrbuf_printf(wr, "+");
3263 wrbuf_printf(wr, req->inputResultSetNames[i]);
3265 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3267 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3273 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3277 Z_DeleteResultSetRequest *req =
3278 reqb->apdu_request->u.deleteResultSetRequest;
3279 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3280 odr_malloc (assoc->encode, sizeof(*res));
3281 bend_delete_rr *bdrr = (bend_delete_rr *)
3282 odr_malloc (assoc->encode, sizeof(*bdrr));
3283 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3285 yaz_log(log_requestdetail, "Got DeleteRequest.");
3287 bdrr->num_setnames = req->num_resultSetList;
3288 bdrr->setnames = req->resultSetList;
3289 for (i = 0; i<req->num_resultSetList; i++)
3290 yaz_log(log_requestdetail, "resultset: '%s'",
3291 req->resultSetList[i]);
3292 bdrr->stream = assoc->encode;
3293 bdrr->print = assoc->print;
3294 bdrr->function = *req->deleteFunction;
3295 bdrr->referenceId = req->referenceId;
3297 if (bdrr->num_setnames > 0)
3299 bdrr->statuses = (int*)
3300 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3301 bdrr->num_setnames);
3302 for (i = 0; i < bdrr->num_setnames; i++)
3303 bdrr->statuses[i] = 0;
3305 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3307 res->referenceId = req->referenceId;
3309 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3311 res->deleteListStatuses = 0;
3312 if (bdrr->num_setnames > 0)
3315 res->deleteListStatuses = (Z_ListStatuses *)
3316 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3317 res->deleteListStatuses->num = bdrr->num_setnames;
3318 res->deleteListStatuses->elements =
3320 odr_malloc (assoc->encode,
3321 sizeof(*res->deleteListStatuses->elements) *
3322 bdrr->num_setnames);
3323 for (i = 0; i<bdrr->num_setnames; i++)
3325 res->deleteListStatuses->elements[i] =
3327 odr_malloc (assoc->encode,
3328 sizeof(**res->deleteListStatuses->elements));
3329 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3330 res->deleteListStatuses->elements[i]->id =
3331 odr_strdup (assoc->encode, bdrr->setnames[i]);
3334 res->numberNotDeleted = 0;
3335 res->bulkStatuses = 0;
3336 res->deleteMessage = 0;
3339 apdu->which = Z_APDU_deleteResultSetResponse;
3340 apdu->u.deleteResultSetResponse = res;
3343 WRBUF wr = wrbuf_alloc();
3344 wrbuf_printf(wr, "Delete ");
3345 if (bdrr->delete_status)
3346 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3348 wrbuf_printf(wr, "OK -");
3349 for (i = 0; i<req->num_resultSetList; i++)
3350 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3351 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3357 static void process_close(association *assoc, request *reqb)
3359 Z_Close *req = reqb->apdu_request->u.close;
3360 static char *reasons[] =
3367 "securityViolation",
3374 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3375 reasons[*req->closeReason], req->diagnosticInformation ?
3376 req->diagnosticInformation : "NULL");
3377 if (assoc->version < 3) /* to make do_force respond with close */
3379 do_close_req(assoc, Z_Close_finished,
3380 "Association terminated by client", reqb);
3381 yaz_log(log_request,"Close OK");
3384 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3388 reqb->len_refid = refid->len;
3389 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3390 memcpy (reqb->refid, refid->buf, refid->len);
3394 reqb->len_refid = 0;
3399 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3401 process_z_response (a, req, res);
3404 bend_request bend_request_mk (bend_association a)
3406 request *nreq = request_get (&a->outgoing);
3407 nreq->request_mem = nmem_create ();
3411 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3416 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3417 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3418 id->len = id->size = req->len_refid;
3419 memcpy (id->buf, req->refid, req->len_refid);
3423 void bend_request_destroy (bend_request *req)
3425 nmem_destroy((*req)->request_mem);
3426 request_release(*req);
3430 int bend_backend_respond (bend_association a, bend_request req)
3434 r = process_z_request (a, req, &msg);
3436 yaz_log (YLOG_WARN, "%s", msg);
3440 void bend_request_setdata(bend_request r, void *p)
3445 void *bend_request_getdata(bend_request r)
3447 return r->clientData;
3450 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3452 bend_segment_rr req;
3454 req.segment = reqb->apdu_request->u.segmentRequest;
3455 req.stream = assoc->encode;
3456 req.decode = assoc->decode;
3457 req.print = assoc->print;
3458 req.association = assoc;
3460 (*assoc->init->bend_segment)(assoc->backend, &req);
3465 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3467 bend_esrequest_rr esrequest;
3468 const char *ext_name = "unknown";
3470 Z_ExtendedServicesRequest *req =
3471 reqb->apdu_request->u.extendedServicesRequest;
3472 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3474 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3476 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3477 esrequest.stream = assoc->encode;
3478 esrequest.decode = assoc->decode;
3479 esrequest.print = assoc->print;
3480 esrequest.errcode = 0;
3481 esrequest.errstring = NULL;
3482 esrequest.request = reqb;
3483 esrequest.association = assoc;
3484 esrequest.taskPackage = 0;
3485 esrequest.referenceId = req->referenceId;
3488 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3490 switch(esrequest.esr->taskSpecificParameters->which)
3492 case Z_External_itemOrder:
3493 ext_name = "ItemOrder"; break;
3494 case Z_External_update:
3495 ext_name = "Update"; break;
3496 case Z_External_update0:
3497 ext_name = "Update0"; break;
3498 case Z_External_ESAdmin:
3499 ext_name = "Admin"; break;
3504 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3506 /* If the response is being delayed, return NULL */
3507 if (esrequest.request == NULL)
3510 resp->referenceId = req->referenceId;
3512 if (esrequest.errcode == -1)
3514 /* Backend service indicates request will be processed */
3515 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3516 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3518 else if (esrequest.errcode == 0)
3520 /* Backend service indicates request will be processed */
3521 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3522 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3526 Z_DiagRecs *diagRecs =
3527 zget_DiagRecs(assoc->encode, esrequest.errcode,
3528 esrequest.errstring);
3529 /* Backend indicates error, request will not be processed */
3530 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3531 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3532 resp->num_diagnostics = diagRecs->num_diagRecs;
3533 resp->diagnostics = diagRecs->diagRecs;
3536 WRBUF wr = wrbuf_alloc();
3537 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3538 yaz_log(log_request, "EsRequest %s", wrbuf_buf(wr) );
3543 /* Do something with the members of bend_extendedservice */
3544 if (esrequest.taskPackage)
3545 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
3546 (const char *) esrequest.taskPackage,
3548 yaz_log(YLOG_DEBUG,"Send the result apdu");
3552 int bend_assoc_is_alive(bend_association assoc)
3554 if (assoc->state == ASSOC_DEAD)
3555 return 0; /* already marked as dead. Don't check I/O chan anymore */
3557 return iochan_is_alive(assoc->client_chan);
3564 * indent-tabs-mode: nil
3566 * vim: shiftwidth=4 tabstop=8 expandtab