2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.110 2007-02-24 18:44:54 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);
682 static int srw_bend_fetch(association *assoc, int pos,
683 Z_SRW_searchRetrieveRequest *srw_req,
684 Z_SRW_record *record,
685 const char **addinfo)
688 ODR o = assoc->encode;
690 rr.setname = "default";
693 rr.request_format = VAL_TEXT_XML;
694 rr.request_format_raw = yaz_oidval_to_z3950oid(assoc->decode,
697 rr.comp = (Z_RecordComposition *)
698 odr_malloc(assoc->decode, sizeof(*rr.comp));
699 rr.comp->which = Z_RecordComp_complex;
700 rr.comp->u.complex = (Z_CompSpec *)
701 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
702 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
703 odr_malloc(assoc->encode, sizeof(bool_t));
704 *rr.comp->u.complex->selectAlternativeSyntax = 0;
705 rr.comp->u.complex->num_dbSpecific = 0;
706 rr.comp->u.complex->dbSpecific = 0;
707 rr.comp->u.complex->num_recordSyntax = 0;
708 rr.comp->u.complex->recordSyntax = 0;
710 rr.comp->u.complex->generic = (Z_Specification *)
711 odr_malloc(assoc->decode, sizeof(Z_Specification));
713 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
714 rr.comp->u.complex->generic->which = Z_Schema_uri;
715 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
717 /* ESN = recordSchema if recordSchema is present */
718 rr.comp->u.complex->generic->elementSpec = 0;
719 if (srw_req->recordSchema)
721 rr.comp->u.complex->generic->elementSpec =
722 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
723 rr.comp->u.complex->generic->elementSpec->which =
724 Z_ElementSpec_elementSetName;
725 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
726 srw_req->recordSchema;
729 rr.stream = assoc->encode;
730 rr.print = assoc->print;
738 rr.surrogate_flag = 0;
739 rr.schema = srw_req->recordSchema;
741 if (!assoc->init->bend_fetch)
744 retrieve_fetch(assoc, &rr);
746 if (rr.errcode && rr.surrogate_flag)
748 int code = yaz_diag_bib1_to_srw(rr.errcode);
749 const char *message = yaz_diag_srw_str(code);
752 len += strlen(message);
754 len += strlen(rr.errstring);
756 record->recordData_buf = odr_malloc(o, len);
758 sprintf(record->recordData_buf, "<diagnostic "
759 "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
760 " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
762 sprintf(record->recordData_buf + strlen(record->recordData_buf),
763 " <details>%s</details>\n", rr.errstring);
765 sprintf(record->recordData_buf + strlen(record->recordData_buf),
766 " <message>%s</message>\n", message);
767 sprintf(record->recordData_buf + strlen(record->recordData_buf),
769 record->recordData_len = strlen(record->recordData_buf);
770 record->recordPosition = odr_intdup(o, pos);
771 record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
774 else if (rr.len >= 0)
776 record->recordData_buf = rr.record;
777 record->recordData_len = rr.len;
778 record->recordPosition = odr_intdup(o, pos);
780 record->recordSchema = odr_strdup(o, rr.schema);
782 record->recordSchema = 0;
786 *addinfo = rr.errstring;
792 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
793 Z_Query *query_result)
795 /* have a CQL query and CQL to PQF transform .. */
796 CQL_parser cp = cql_parser_create();
802 r = cql_parser_string(cp, cql);
805 /* CQL syntax error */
811 r = cql_transform_buf(ct,
812 cql_parser_result(cp),
813 rpn_buf, sizeof(rpn_buf)-1);
815 srw_errcode = cql_transform_error(ct, &add);
819 /* Syntax & transform OK. */
820 /* Convert PQF string to Z39.50 to RPN query struct */
821 YAZ_PQF_Parser pp = yaz_pqf_create();
822 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
827 int code = yaz_pqf_error(pp, &pqf_msg, &off);
828 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
834 query_result->which = Z_Query_type_1;
835 query_result->u.type_1 = rpnquery;
839 cql_parser_destroy(cp);
843 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
844 Z_AttributesPlusTerm *result)
848 int srw_error = cql2pqf(odr, cql, ct, &query);
851 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
852 return 10; /* bad query type */
853 rpn = query.u.type_1;
854 if (!rpn->RPNStructure)
855 return 10; /* must be structure */
856 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
857 return 10; /* must be simple */
858 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
859 return 10; /* must be attributes plus term node .. */
860 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
865 static void srw_bend_search(association *assoc, request *req,
867 Z_SRW_searchRetrieveResponse *srw_res,
872 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
875 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
876 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
877 if (srw_res->num_diagnostics == 0 && assoc->init)
880 rr.setname = "default";
883 rr.basenames = &srw_req->database;
887 rr.srw_setnameIdleTime = 0;
888 rr.estimated_hit_count = 0;
889 rr.partial_resultset = 0;
890 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
891 rr.query->u.type_1 = 0;
893 if (srw_req->query_type == Z_SRW_query_type_cql)
895 if (assoc->server && assoc->server->cql_transform)
897 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
898 assoc->server->cql_transform,
902 yaz_add_srw_diagnostic(assoc->encode,
903 &srw_res->diagnostics,
904 &srw_res->num_diagnostics,
910 /* CQL query to backend. Wrap it - Z39.50 style */
911 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
912 ext->direct_reference = odr_getoidbystr(assoc->decode,
913 "1.2.840.10003.16.2");
914 ext->indirect_reference = 0;
916 ext->which = Z_External_CQL;
917 ext->u.cql = srw_req->query.cql;
919 rr.query->which = Z_Query_type_104;
920 rr.query->u.type_104 = ext;
923 else if (srw_req->query_type == Z_SRW_query_type_pqf)
925 Z_RPNQuery *RPNquery;
926 YAZ_PQF_Parser pqf_parser;
928 pqf_parser = yaz_pqf_create ();
930 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
936 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
937 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
938 code, pqf_msg, (long) off);
939 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
942 rr.query->which = Z_Query_type_1;
943 rr.query->u.type_1 = RPNquery;
945 yaz_pqf_destroy (pqf_parser);
949 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
950 &srw_res->num_diagnostics,
951 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
953 if (rr.query->u.type_1)
955 rr.stream = assoc->encode;
956 rr.decode = assoc->decode;
957 rr.print = assoc->print;
959 if ( srw_req->sort.sortKeys )
960 rr.srw_sortKeys = odr_strdup(assoc->encode,
961 srw_req->sort.sortKeys );
962 rr.association = assoc;
968 yaz_log_zquery_level(log_requestdetail,rr.query);
970 (assoc->init->bend_search)(assoc->backend, &rr);
973 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
979 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
980 yaz_add_srw_diagnostic(assoc->encode,
981 &srw_res->diagnostics,
982 &srw_res->num_diagnostics,
983 srw_error, rr.errstring);
988 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
989 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
991 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
992 start, number, rr.hits);
994 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
997 srw_res->resultSetId =
998 odr_strdup(assoc->encode, rr.srw_setname );
999 srw_res->resultSetIdleTime =
1000 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1003 if ((rr.hits > 0 && start > rr.hits) || start < 1)
1005 yaz_add_srw_diagnostic(
1007 &srw_res->diagnostics, &srw_res->num_diagnostics,
1008 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1010 else if (number > 0)
1014 if (start + number > rr.hits)
1015 number = rr.hits - start + 1;
1017 /* Call bend_present if defined */
1018 if (assoc->init->bend_present)
1020 bend_present_rr *bprr = (bend_present_rr*)
1021 odr_malloc (assoc->decode, sizeof(*bprr));
1022 bprr->setname = "default";
1023 bprr->start = start;
1024 bprr->number = number;
1025 bprr->format = VAL_TEXT_XML;
1026 if (srw_req->recordSchema)
1028 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1029 sizeof(*bprr->comp));
1030 bprr->comp->which = Z_RecordComp_simple;
1031 bprr->comp->u.simple = (Z_ElementSetNames *)
1032 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1033 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1034 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1040 bprr->stream = assoc->encode;
1041 bprr->referenceId = 0;
1042 bprr->print = assoc->print;
1043 bprr->request = req;
1044 bprr->association = assoc;
1046 bprr->errstring = NULL;
1047 (*assoc->init->bend_present)(assoc->backend, bprr);
1053 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1054 yaz_add_srw_diagnostic(assoc->encode,
1055 &srw_res->diagnostics,
1056 &srw_res->num_diagnostics,
1057 srw_error, bprr->errstring);
1065 int packing = Z_SRW_recordPacking_string;
1066 if (srw_req->recordPacking)
1069 yaz_srw_str_to_pack(srw_req->recordPacking);
1071 packing = Z_SRW_recordPacking_string;
1073 srw_res->records = (Z_SRW_record *)
1074 odr_malloc(assoc->encode,
1075 number * sizeof(*srw_res->records));
1077 srw_res->extra_records = (Z_SRW_extra_record **)
1078 odr_malloc(assoc->encode,
1079 number*sizeof(*srw_res->extra_records));
1081 for (i = 0; i<number; i++)
1084 const char *addinfo = 0;
1086 srw_res->records[j].recordPacking = packing;
1087 srw_res->records[j].recordData_buf = 0;
1088 srw_res->extra_records[j] = 0;
1089 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1090 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1091 srw_res->records + j,
1095 yaz_add_srw_diagnostic(assoc->encode,
1096 &srw_res->diagnostics,
1097 &srw_res->num_diagnostics,
1098 yaz_diag_bib1_to_srw (errcode),
1103 if (srw_res->records[j].recordData_buf)
1106 srw_res->num_records = j;
1108 srw_res->records = 0;
1111 if (rr.estimated_hit_count || rr.partial_resultset)
1113 yaz_add_srw_diagnostic(
1115 &srw_res->diagnostics,
1116 &srw_res->num_diagnostics,
1117 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1125 const char *querystr = "?";
1126 const char *querytype = "?";
1127 WRBUF wr = wrbuf_alloc();
1129 switch (srw_req->query_type)
1131 case Z_SRW_query_type_cql:
1133 querystr = srw_req->query.cql;
1135 case Z_SRW_query_type_pqf:
1137 querystr = srw_req->query.pqf;
1140 wrbuf_printf(wr, "SRWSearch ");
1141 wrbuf_printf(wr, srw_req->database);
1142 wrbuf_printf(wr, " ");
1143 if (srw_res->num_diagnostics)
1144 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1145 else if (*http_code != 200)
1146 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1147 else if (srw_res->numberOfRecords)
1149 wrbuf_printf(wr, "OK %d",
1150 (srw_res->numberOfRecords ?
1151 *srw_res->numberOfRecords : 0));
1153 wrbuf_printf(wr, " %s %d+%d",
1154 (srw_res->resultSetId ?
1155 srw_res->resultSetId : "-"),
1156 (srw_req->startRecord ? *srw_req->startRecord : 1),
1157 srw_res->num_records);
1158 yaz_log(log_request, "%s %s: %s", wrbuf_buf(wr), querytype, querystr);
1163 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1166 xmlNodePtr ptr = rr->server_node_ptr;
1169 for (ptr = ptr->children; ptr; ptr = ptr->next)
1171 if (ptr->type != XML_ELEMENT_NODE)
1173 if (!strcmp((const char *) ptr->name, "explain"))
1176 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1180 ptr = xmlCopyNode(ptr, 1);
1182 xmlDocSetRootElement(doc, ptr);
1184 xmlDocDumpMemory(doc, &buf_out, &len);
1185 content = (char*) odr_malloc(rr->stream, 1+len);
1186 memcpy(content, buf_out, len);
1187 content[len] = '\0';
1191 rr->explain_buf = content;
1199 static void srw_bend_explain(association *assoc, request *req,
1201 Z_SRW_explainResponse *srw_res,
1204 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1205 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1207 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1212 rr.stream = assoc->encode;
1213 rr.decode = assoc->decode;
1214 rr.print = assoc->print;
1216 rr.database = srw_req->database;
1218 rr.server_node_ptr = assoc->server->server_node_ptr;
1220 rr.server_node_ptr = 0;
1221 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1222 if (assoc->init->bend_explain)
1223 (*assoc->init->bend_explain)(assoc->backend, &rr);
1225 srw_bend_explain_default(assoc->backend, &rr);
1229 int packing = Z_SRW_recordPacking_string;
1230 if (srw_req->recordPacking)
1233 yaz_srw_str_to_pack(srw_req->recordPacking);
1235 packing = Z_SRW_recordPacking_string;
1237 srw_res->record.recordSchema = rr.schema;
1238 srw_res->record.recordPacking = packing;
1239 srw_res->record.recordData_buf = rr.explain_buf;
1240 srw_res->record.recordData_len = strlen(rr.explain_buf);
1241 srw_res->record.recordPosition = 0;
1247 static void srw_bend_scan(association *assoc, request *req,
1249 Z_SRW_scanResponse *srw_res,
1252 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1253 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1256 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1257 if (srw_res->num_diagnostics == 0 && assoc->init)
1259 struct scan_entry *save_entries;
1261 bend_scan_rr *bsrr = (bend_scan_rr *)
1262 odr_malloc (assoc->encode, sizeof(*bsrr));
1263 bsrr->num_bases = 1;
1264 bsrr->basenames = &srw_req->database;
1266 bsrr->num_entries = srw_req->maximumTerms ?
1267 *srw_req->maximumTerms : 10;
1268 bsrr->term_position = srw_req->responsePosition ?
1269 *srw_req->responsePosition : 1;
1272 bsrr->errstring = 0;
1273 bsrr->referenceId = 0;
1274 bsrr->stream = assoc->encode;
1275 bsrr->print = assoc->print;
1276 bsrr->step_size = odr_intdup(assoc->decode, 0);
1279 if (bsrr->num_entries > 0)
1282 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1284 for (i = 0; i<bsrr->num_entries; i++)
1286 bsrr->entries[i].term = 0;
1287 bsrr->entries[i].occurrences = 0;
1288 bsrr->entries[i].errcode = 0;
1289 bsrr->entries[i].errstring = 0;
1290 bsrr->entries[i].display_term = 0;
1293 save_entries = bsrr->entries; /* save it so we can compare later */
1295 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1296 assoc->init->bend_scan)
1298 Odr_oid *scan_attributeSet = 0;
1300 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1302 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1304 srw_req->scanClause.pqf);
1305 if (scan_attributeSet &&
1306 (attset = oid_getentbyoid(scan_attributeSet)) &&
1307 (attset->oclass == CLASS_ATTSET ||
1308 attset->oclass == CLASS_GENERAL))
1309 bsrr->attributeset = attset->value;
1311 bsrr->attributeset = VAL_NONE;
1312 yaz_pqf_destroy(pqf_parser);
1313 bsrr->scanClause = 0;
1314 ((int (*)(void *, bend_scan_rr *))
1315 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1317 else if (srw_req->query_type == Z_SRW_query_type_cql
1318 && assoc->init->bend_scan && assoc->server
1319 && assoc->server->cql_transform)
1322 bsrr->scanClause = 0;
1323 bsrr->attributeset = VAL_NONE;
1324 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1325 srw_error = cql2pqf_scan(assoc->encode,
1326 srw_req->scanClause.cql,
1327 assoc->server->cql_transform,
1330 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1331 &srw_res->num_diagnostics,
1335 ((int (*)(void *, bend_scan_rr *))
1336 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1339 else if (srw_req->query_type == Z_SRW_query_type_cql
1340 && assoc->init->bend_srw_scan)
1343 bsrr->attributeset = VAL_NONE;
1344 bsrr->scanClause = srw_req->scanClause.cql;
1345 ((int (*)(void *, bend_scan_rr *))
1346 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1350 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1351 &srw_res->num_diagnostics,
1352 YAZ_SRW_UNSUPP_OPERATION, "scan");
1357 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1362 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1364 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1365 &srw_res->num_diagnostics,
1366 srw_error, bsrr->errstring);
1368 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1371 srw_res->terms = (Z_SRW_scanTerm*)
1372 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1375 srw_res->num_terms = bsrr->num_entries;
1376 for (i = 0; i<bsrr->num_entries; i++)
1378 Z_SRW_scanTerm *t = srw_res->terms + i;
1379 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1380 t->numberOfRecords =
1381 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1383 if (save_entries == bsrr->entries &&
1384 bsrr->entries[i].display_term)
1386 /* the entries was _not_ set by the handler. So it's
1387 safe to test for new member display_term. It is
1390 t->displayTerm = odr_strdup(assoc->encode,
1391 bsrr->entries[i].display_term);
1399 WRBUF wr = wrbuf_alloc();
1400 const char *querytype = 0;
1401 const char *querystr = 0;
1403 switch(srw_req->query_type)
1405 case Z_SRW_query_type_pqf:
1407 querystr = srw_req->scanClause.pqf;
1409 case Z_SRW_query_type_cql:
1411 querystr = srw_req->scanClause.cql;
1414 querytype = "UNKNOWN";
1418 wrbuf_printf(wr, "SRWScan ");
1419 wrbuf_printf(wr, srw_req->database);
1420 wrbuf_printf(wr, " ");
1422 if (srw_res->num_diagnostics)
1423 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1424 else if (srw_res->num_terms)
1425 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1427 wrbuf_printf(wr, "OK - - ");
1429 wrbuf_printf(wr, "%d+%d+0 ",
1430 (srw_req->responsePosition ?
1431 *srw_req->responsePosition : 1),
1432 (srw_req->maximumTerms ?
1433 *srw_req->maximumTerms : 1));
1434 /* there is no step size in SRU/W ??? */
1435 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1436 yaz_log(log_request, "%s ", wrbuf_buf(wr) );
1442 static void srw_bend_update(association *assoc, request *req,
1444 Z_SRW_updateResponse *srw_res,
1447 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1448 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1449 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1451 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1455 Z_SRW_extra_record *extra = srw_req->extra_record;
1457 rr.stream = assoc->encode;
1458 rr.print = assoc->print;
1460 rr.basenames = &srw_req->database;
1461 rr.operation = srw_req->operation;
1462 rr.operation_status = "failed";
1464 rr.record_versions = 0;
1465 rr.num_versions = 0;
1466 rr.record_packing = "string";
1467 rr.record_schema = 0;
1469 rr.extra_record_data = 0;
1470 rr.extra_request_data = 0;
1471 rr.extra_response_data = 0;
1477 if (rr.operation == 0)
1479 yaz_add_sru_update_diagnostic(
1480 assoc->encode, &srw_res->diagnostics,
1481 &srw_res->num_diagnostics,
1482 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1486 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1487 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1488 if (!strcmp( rr.operation, "delete"))
1490 if (srw_req->record && !srw_req->record->recordSchema)
1492 rr.record_schema = odr_strdup(
1494 srw_req->record->recordSchema);
1496 if (srw_req->record)
1498 rr.record_data = odr_strdupn(
1500 srw_req->record->recordData_buf,
1501 srw_req->record->recordData_len );
1503 if (extra && extra->extraRecordData_len)
1505 rr.extra_record_data = odr_strdupn(
1507 extra->extraRecordData_buf,
1508 extra->extraRecordData_len );
1510 if (srw_req->recordId)
1511 rr.record_id = srw_req->recordId;
1512 else if (extra && extra->recordIdentifier)
1513 rr.record_id = extra->recordIdentifier;
1515 else if (!strcmp(rr.operation, "replace"))
1517 if (srw_req->recordId)
1518 rr.record_id = srw_req->recordId;
1519 else if (extra && extra->recordIdentifier)
1520 rr.record_id = extra->recordIdentifier;
1523 yaz_add_sru_update_diagnostic(
1524 assoc->encode, &srw_res->diagnostics,
1525 &srw_res->num_diagnostics,
1526 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1527 "recordIdentifier");
1529 if (!srw_req->record)
1531 yaz_add_sru_update_diagnostic(
1532 assoc->encode, &srw_res->diagnostics,
1533 &srw_res->num_diagnostics,
1534 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1539 if (srw_req->record->recordSchema)
1540 rr.record_schema = odr_strdup(
1541 assoc->encode, srw_req->record->recordSchema);
1542 if (srw_req->record->recordData_len )
1544 rr.record_data = odr_strdupn(assoc->encode,
1545 srw_req->record->recordData_buf,
1546 srw_req->record->recordData_len );
1550 yaz_add_sru_update_diagnostic(
1551 assoc->encode, &srw_res->diagnostics,
1552 &srw_res->num_diagnostics,
1553 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1557 if (extra && extra->extraRecordData_len)
1559 rr.extra_record_data = odr_strdupn(
1561 extra->extraRecordData_buf,
1562 extra->extraRecordData_len );
1565 else if (!strcmp(rr.operation, "insert"))
1567 if (srw_req->recordId)
1568 rr.record_id = srw_req->recordId;
1570 rr.record_id = extra->recordIdentifier;
1572 if (srw_req->record)
1574 if (srw_req->record->recordSchema)
1575 rr.record_schema = odr_strdup(
1576 assoc->encode, srw_req->record->recordSchema);
1578 if (srw_req->record->recordData_len)
1579 rr.record_data = odr_strdupn(
1581 srw_req->record->recordData_buf,
1582 srw_req->record->recordData_len );
1584 if (extra && extra->extraRecordData_len)
1586 rr.extra_record_data = odr_strdupn(
1588 extra->extraRecordData_buf,
1589 extra->extraRecordData_len );
1593 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1594 &srw_res->num_diagnostics,
1595 YAZ_SRU_UPDATE_INVALID_ACTION,
1598 if (srw_req->record)
1600 const char *pack_str =
1601 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1603 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1606 if (srw_req->num_recordVersions)
1608 rr.record_versions = srw_req->recordVersions;
1609 rr.num_versions = srw_req->num_recordVersions;
1611 if (srw_req->extraRequestData_len)
1613 rr.extra_request_data = odr_strdupn(assoc->encode,
1614 srw_req->extraRequestData_buf,
1615 srw_req->extraRequestData_len );
1617 if (srw_res->num_diagnostics == 0)
1619 if ( assoc->init->bend_srw_update)
1620 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1622 yaz_add_sru_update_diagnostic(
1623 assoc->encode, &srw_res->diagnostics,
1624 &srw_res->num_diagnostics,
1625 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1626 "No Update backend handler");
1630 yaz_add_srw_diagnostic_uri(assoc->encode,
1631 &srw_res->diagnostics,
1632 &srw_res->num_diagnostics,
1636 srw_res->recordId = rr.record_id;
1637 srw_res->operationStatus = rr.operation_status;
1638 srw_res->recordVersions = rr.record_versions;
1639 srw_res->num_recordVersions = rr.num_versions;
1640 if (srw_res->extraResponseData_len)
1642 srw_res->extraResponseData_buf = rr.extra_response_data;
1643 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1645 if (srw_res->num_diagnostics == 0 && rr.record_data)
1647 srw_res->record = yaz_srw_get_record(assoc->encode);
1648 srw_res->record->recordSchema = rr.record_schema;
1649 if (rr.record_packing)
1651 int pack = yaz_srw_str_to_pack(rr.record_packing);
1655 pack = Z_SRW_recordPacking_string;
1656 yaz_log(YLOG_WARN, "Back packing %s from backend",
1659 srw_res->record->recordPacking = pack;
1661 srw_res->record->recordData_buf = rr.record_data;
1662 srw_res->record->recordData_len = strlen(rr.record_data);
1663 if (rr.extra_record_data)
1665 Z_SRW_extra_record *ex =
1666 yaz_srw_get_extra_record(assoc->encode);
1667 srw_res->extra_record = ex;
1668 ex->extraRecordData_buf = rr.extra_record_data;
1669 ex->extraRecordData_len = strlen(rr.extra_record_data);
1675 /* check if path is OK (1); BAD (0) */
1676 static int check_path(const char *path)
1680 if (strstr(path, ".."))
1685 static char *read_file(const char *fname, ODR o, int *sz)
1688 FILE *inf = fopen(fname, "rb");
1692 fseek(inf, 0L, SEEK_END);
1695 buf = odr_malloc(o, *sz);
1696 fread(buf, 1, *sz, inf);
1701 static void process_http_request(association *assoc, request *req)
1703 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1704 ODR o = assoc->encode;
1705 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1707 Z_SOAP *soap_package = 0;
1710 Z_HTTP_Response *hres = 0;
1712 const char *stylesheet = 0; /* for now .. set later */
1713 Z_SRW_diagnostic *diagnostic = 0;
1714 int num_diagnostic = 0;
1715 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1717 if (!control_association(assoc, host, 0))
1719 p = z_get_HTTP_Response(o, 404);
1722 if (r == 2 && assoc->server && assoc->server->docpath
1723 && hreq->path[0] == '/'
1725 /* check if path is a proper prefix of documentroot */
1726 strncmp(hreq->path+1, assoc->server->docpath,
1727 strlen(assoc->server->docpath))
1730 if (!check_path(hreq->path))
1732 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1733 p = z_get_HTTP_Response(o, 404);
1737 int content_size = 0;
1738 char *content_buf = read_file(hreq->path+1, o, &content_size);
1741 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1742 p = z_get_HTTP_Response(o, 404);
1746 const char *ctype = 0;
1747 yaz_mime_types types = yaz_mime_types_create();
1749 yaz_mime_types_add(types, "xsl", "application/xml");
1750 yaz_mime_types_add(types, "xml", "application/xml");
1751 yaz_mime_types_add(types, "css", "text/css");
1752 yaz_mime_types_add(types, "html", "text/html");
1753 yaz_mime_types_add(types, "htm", "text/html");
1754 yaz_mime_types_add(types, "txt", "text/plain");
1755 yaz_mime_types_add(types, "js", "application/x-javascript");
1757 yaz_mime_types_add(types, "gif", "image/gif");
1758 yaz_mime_types_add(types, "png", "image/png");
1759 yaz_mime_types_add(types, "jpg", "image/jpeg");
1760 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1762 ctype = yaz_mime_lookup_fname(types, hreq->path);
1765 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1766 p = z_get_HTTP_Response(o, 404);
1770 p = z_get_HTTP_Response(o, 200);
1771 hres = p->u.HTTP_Response;
1772 hres->content_buf = content_buf;
1773 hres->content_len = content_size;
1774 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1776 yaz_mime_types_destroy(types);
1784 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1785 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1787 if (r == 2) /* not taken */
1789 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1790 &diagnostic, &num_diagnostic);
1791 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1793 if (r == 0) /* decode SRW/SRU OK .. */
1795 int http_code = 200;
1796 if (sr->which == Z_SRW_searchRetrieve_request)
1799 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1801 stylesheet = sr->u.request->stylesheet;
1804 res->u.response->diagnostics = diagnostic;
1805 res->u.response->num_diagnostics = num_diagnostic;
1809 srw_bend_search(assoc, req, sr, res->u.response,
1812 if (http_code == 200)
1813 soap_package->u.generic->p = res;
1815 else if (sr->which == Z_SRW_explain_request)
1817 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1818 stylesheet = sr->u.explain_request->stylesheet;
1821 res->u.explain_response->diagnostics = diagnostic;
1822 res->u.explain_response->num_diagnostics = num_diagnostic;
1824 srw_bend_explain(assoc, req, sr,
1825 res->u.explain_response, &http_code);
1826 if (http_code == 200)
1827 soap_package->u.generic->p = res;
1829 else if (sr->which == Z_SRW_scan_request)
1831 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1832 stylesheet = sr->u.scan_request->stylesheet;
1835 res->u.scan_response->diagnostics = diagnostic;
1836 res->u.scan_response->num_diagnostics = num_diagnostic;
1838 srw_bend_scan(assoc, req, sr,
1839 res->u.scan_response, &http_code);
1840 if (http_code == 200)
1841 soap_package->u.generic->p = res;
1843 else if (sr->which == Z_SRW_update_request)
1845 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1846 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1849 res->u.update_response->diagnostics = diagnostic;
1850 res->u.update_response->num_diagnostics = num_diagnostic;
1852 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1853 srw_bend_update(assoc, req, sr,
1854 res->u.update_response, &http_code);
1855 if (http_code == 200)
1856 soap_package->u.generic->p = res;
1860 yaz_log(log_request, "SOAP ERROR");
1861 /* FIXME - what error, what query */
1863 z_soap_error(assoc->encode, soap_package,
1864 "SOAP-ENV:Client", "Bad method", 0);
1866 if (http_code == 200 || http_code == 500)
1868 static Z_SOAP_Handler soap_handlers[4] = {
1870 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1871 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1872 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1878 p = z_get_HTTP_Response(o, 200);
1879 hres = p->u.HTTP_Response;
1881 if (!stylesheet && assoc->server)
1882 stylesheet = assoc->server->stylesheet;
1884 /* empty stylesheet means NO stylesheet */
1885 if (stylesheet && *stylesheet == '\0')
1888 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1889 &hres->content_buf, &hres->content_len,
1890 soap_handlers, charset, stylesheet);
1891 hres->code = http_code;
1893 strcpy(ctype, "text/xml");
1896 strcat(ctype, "; charset=");
1897 strcat(ctype, charset);
1899 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1902 p = z_get_HTTP_Response(o, http_code);
1906 p = z_get_HTTP_Response(o, 500);
1907 hres = p->u.HTTP_Response;
1908 if (!strcmp(hreq->version, "1.0"))
1910 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1911 if (v && !strcmp(v, "Keep-Alive"))
1915 hres->version = "1.0";
1919 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1920 if (v && !strcmp(v, "close"))
1924 hres->version = "1.1";
1928 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1929 assoc->state = ASSOC_DEAD;
1930 assoc->cs_get_mask = 0;
1935 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1937 if (alive && isdigit(*(const unsigned char *) alive))
1941 if (t < 0 || t > 3600)
1943 iochan_settimeout(assoc->client_chan,t);
1944 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1946 process_gdu_response(assoc, req, p);
1949 static void process_gdu_request(association *assoc, request *req)
1951 if (req->gdu_request->which == Z_GDU_Z3950)
1954 req->apdu_request = req->gdu_request->u.z3950;
1955 if (process_z_request(assoc, req, &msg) < 0)
1956 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1958 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1959 process_http_request(assoc, req);
1962 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1967 * Initiate request processing.
1969 static int process_z_request(association *assoc, request *req, char **msg)
1975 *msg = "Unknown Error";
1976 assert(req && req->state == REQUEST_IDLE);
1977 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1979 *msg = "Missing InitRequest";
1982 switch (req->apdu_request->which)
1984 case Z_APDU_initRequest:
1985 res = process_initRequest(assoc, req); break;
1986 case Z_APDU_searchRequest:
1987 res = process_searchRequest(assoc, req, &fd); break;
1988 case Z_APDU_presentRequest:
1989 res = process_presentRequest(assoc, req, &fd); break;
1990 case Z_APDU_scanRequest:
1991 if (assoc->init->bend_scan)
1992 res = process_scanRequest(assoc, req, &fd);
1995 *msg = "Cannot handle Scan APDU";
1999 case Z_APDU_extendedServicesRequest:
2000 if (assoc->init->bend_esrequest)
2001 res = process_ESRequest(assoc, req, &fd);
2004 *msg = "Cannot handle Extended Services APDU";
2008 case Z_APDU_sortRequest:
2009 if (assoc->init->bend_sort)
2010 res = process_sortRequest(assoc, req, &fd);
2013 *msg = "Cannot handle Sort APDU";
2018 process_close(assoc, req);
2020 case Z_APDU_deleteResultSetRequest:
2021 if (assoc->init->bend_delete)
2022 res = process_deleteRequest(assoc, req, &fd);
2025 *msg = "Cannot handle Delete APDU";
2029 case Z_APDU_segmentRequest:
2030 if (assoc->init->bend_segment)
2032 res = process_segmentRequest (assoc, req);
2036 *msg = "Cannot handle Segment APDU";
2040 case Z_APDU_triggerResourceControlRequest:
2043 *msg = "Bad APDU received";
2048 yaz_log(YLOG_DEBUG, " result immediately available");
2049 retval = process_z_response(assoc, req, res);
2053 yaz_log(YLOG_DEBUG, " result unavailble");
2056 else /* no result yet - one will be provided later */
2060 /* Set up an I/O handler for the fd supplied by the backend */
2062 yaz_log(YLOG_DEBUG, " establishing handler for result");
2063 req->state = REQUEST_PENDING;
2064 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2066 iochan_setdata(chan, assoc);
2073 * Handle message from the backend.
2075 void backend_response(IOCHAN i, int event)
2077 association *assoc = (association *)iochan_getdata(i);
2078 request *req = request_head(&assoc->incoming);
2082 yaz_log(YLOG_DEBUG, "backend_response");
2083 assert(assoc && req && req->state != REQUEST_IDLE);
2084 /* determine what it is we're waiting for */
2085 switch (req->apdu_request->which)
2087 case Z_APDU_searchRequest:
2088 res = response_searchRequest(assoc, req, 0, &fd); break;
2090 case Z_APDU_presentRequest:
2091 res = response_presentRequest(assoc, req, 0, &fd); break;
2092 case Z_APDU_scanRequest:
2093 res = response_scanRequest(assoc, req, 0, &fd); break;
2096 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2099 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2101 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2102 do_close(assoc, Z_Close_systemProblem, 0);
2106 else if (!res) /* no result yet - try again later */
2108 yaz_log(YLOG_DEBUG, " no result yet");
2109 iochan_setfd(i, fd); /* in case fd has changed */
2114 * Encode response, and transfer the request structure to the outgoing queue.
2116 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2118 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2122 if (!z_GDU(assoc->print, &res, 0, 0))
2123 yaz_log(YLOG_WARN, "ODR print error: %s",
2124 odr_errmsg(odr_geterror(assoc->print)));
2125 odr_reset(assoc->print);
2127 if (!z_GDU(assoc->encode, &res, 0, 0))
2129 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2130 odr_errmsg(odr_geterror(assoc->decode)),
2131 odr_getelement(assoc->decode));
2134 req->response = odr_getbuf(assoc->encode, &req->len_response,
2135 &req->size_response);
2136 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2137 odr_reset(assoc->encode);
2138 req->state = REQUEST_IDLE;
2139 request_enq(&assoc->outgoing, req);
2140 /* turn the work over to the ir_session handler */
2141 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2142 assoc->cs_put_mask = EVENT_OUTPUT;
2143 /* Is there more work to be done? give that to the input handler too */
2146 req = request_head(&assoc->incoming);
2147 if (req && req->state == REQUEST_IDLE)
2149 request_deq(&assoc->incoming);
2150 process_gdu_request(assoc, req);
2159 * Encode response, and transfer the request structure to the outgoing queue.
2161 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2163 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2164 gres->which = Z_GDU_Z3950;
2165 gres->u.z3950 = res;
2167 return process_gdu_response(assoc, req, gres);
2170 static char *get_vhost(Z_OtherInformation *otherInfo)
2172 return yaz_oi_get_string_oidval(&otherInfo, VAL_PROXY, 1, 0);
2176 * Handle init request.
2177 * At the moment, we don't check the options
2178 * anywhere else in the code - we just try not to do anything that would
2179 * break a naive client. We'll toss 'em into the association block when
2180 * we need them there.
2182 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2184 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2185 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2186 Z_InitResponse *resp = apdu->u.initResponse;
2187 bend_initresult *binitres;
2190 statserv_options_block *cb = 0; /* by default no control for backend */
2192 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2193 cb = statserv_getcontrol(); /* got control block for backend */
2195 if (cb && assoc->backend)
2196 (*cb->bend_close)(assoc->backend);
2198 yaz_log(log_requestdetail, "Got initRequest");
2199 if (req->implementationId)
2200 yaz_log(log_requestdetail, "Id: %s",
2201 req->implementationId);
2202 if (req->implementationName)
2203 yaz_log(log_requestdetail, "Name: %s",
2204 req->implementationName);
2205 if (req->implementationVersion)
2206 yaz_log(log_requestdetail, "Version: %s",
2207 req->implementationVersion);
2209 assoc_init_reset(assoc);
2211 assoc->init->auth = req->idAuthentication;
2212 assoc->init->referenceId = req->referenceId;
2214 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2216 Z_CharSetandLanguageNegotiation *negotiation =
2217 yaz_get_charneg_record (req->otherInfo);
2219 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2220 assoc->init->charneg_request = negotiation;
2226 if (req->implementationVersion)
2227 yaz_log(log_requestdetail, "Config: %s",
2230 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2232 /* we have a backend control block, so call that init function */
2233 if (!(binitres = (*cb->bend_init)(assoc->init)))
2235 yaz_log(YLOG_WARN, "Bad response from backend.");
2238 assoc->backend = binitres->handle;
2242 /* no backend. return error */
2243 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2244 binitres->errstring = 0;
2245 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2246 iochan_settimeout(assoc->client_chan, 10);
2248 if ((assoc->init->bend_sort))
2249 yaz_log (YLOG_DEBUG, "Sort handler installed");
2250 if ((assoc->init->bend_search))
2251 yaz_log (YLOG_DEBUG, "Search handler installed");
2252 if ((assoc->init->bend_present))
2253 yaz_log (YLOG_DEBUG, "Present handler installed");
2254 if ((assoc->init->bend_esrequest))
2255 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2256 if ((assoc->init->bend_delete))
2257 yaz_log (YLOG_DEBUG, "Delete handler installed");
2258 if ((assoc->init->bend_scan))
2259 yaz_log (YLOG_DEBUG, "Scan handler installed");
2260 if ((assoc->init->bend_segment))
2261 yaz_log (YLOG_DEBUG, "Segment handler installed");
2263 resp->referenceId = req->referenceId;
2265 /* let's tell the client what we can do */
2266 if (ODR_MASK_GET(req->options, Z_Options_search))
2268 ODR_MASK_SET(resp->options, Z_Options_search);
2269 strcat(options, "srch");
2271 if (ODR_MASK_GET(req->options, Z_Options_present))
2273 ODR_MASK_SET(resp->options, Z_Options_present);
2274 strcat(options, " prst");
2276 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2277 assoc->init->bend_delete)
2279 ODR_MASK_SET(resp->options, Z_Options_delSet);
2280 strcat(options, " del");
2282 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2283 assoc->init->bend_esrequest)
2285 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2286 strcat (options, " extendedServices");
2288 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2290 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2291 strcat(options, " namedresults");
2293 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2295 ODR_MASK_SET(resp->options, Z_Options_scan);
2296 strcat(options, " scan");
2298 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2300 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2301 strcat(options, " concurrop");
2303 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2305 ODR_MASK_SET(resp->options, Z_Options_sort);
2306 strcat(options, " sort");
2309 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
2310 && assoc->init->charneg_response)
2312 Z_OtherInformation **p;
2313 Z_OtherInformationUnit *p0;
2315 yaz_oi_APDU(apdu, &p);
2317 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2318 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2320 p0->which = Z_OtherInfo_externallyDefinedInfo;
2321 p0->information.externallyDefinedInfo =
2322 assoc->init->charneg_response;
2324 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2325 strcat(options, " negotiation");
2328 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2329 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2331 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2333 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2334 assoc->version = 1; /* 1 & 2 are equivalent */
2336 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2338 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2341 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2343 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2347 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2349 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2350 assoc->maximumRecordSize = *req->maximumRecordSize;
2352 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2353 assoc->preferredMessageSize = *req->preferredMessageSize;
2355 resp->preferredMessageSize = &assoc->preferredMessageSize;
2356 resp->maximumRecordSize = &assoc->maximumRecordSize;
2358 resp->implementationId = odr_prepend(assoc->encode,
2359 assoc->init->implementation_id,
2360 resp->implementationId);
2362 resp->implementationName = odr_prepend(assoc->encode,
2363 assoc->init->implementation_name,
2364 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2366 version = odr_strdup(assoc->encode, "$Revision: 1.110 $");
2367 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2368 version[strlen(version)-2] = '\0';
2369 resp->implementationVersion = odr_prepend(assoc->encode,
2370 assoc->init->implementation_version,
2371 odr_prepend(assoc->encode, &version[11],
2372 resp->implementationVersion));
2374 if (binitres->errcode)
2376 assoc->state = ASSOC_DEAD;
2377 resp->userInformationField =
2378 init_diagnostics(assoc->encode, binitres->errcode,
2379 binitres->errstring);
2384 if (!req->idAuthentication)
2385 yaz_log(log_request, "Auth none");
2386 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2388 const char *open = req->idAuthentication->u.open;
2389 const char *slash = strchr(open, '/');
2395 yaz_log(log_request, "Auth open %.*s", len, open);
2397 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2399 const char *user = req->idAuthentication->u.idPass->userId;
2400 const char *group = req->idAuthentication->u.idPass->groupId;
2401 yaz_log(log_request, "Auth idPass %s %s",
2402 user ? user : "-", group ? group : "-");
2404 else if (req->idAuthentication->which
2405 == Z_IdAuthentication_anonymous)
2407 yaz_log(log_request, "Auth anonymous");
2411 yaz_log(log_request, "Auth other");
2416 WRBUF wr = wrbuf_alloc();
2417 wrbuf_printf(wr, "Init ");
2418 if (binitres->errcode)
2419 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2421 wrbuf_printf(wr, "OK -");
2422 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2423 (req->implementationId ? req->implementationId :"-"),
2424 (req->implementationName ?
2425 req->implementationName : "-"),
2426 (req->implementationVersion ?
2427 req->implementationVersion : "-")
2429 yaz_log(log_request, "%s", wrbuf_buf(wr));
2436 * Set the specified `errcode' and `errstring' into a UserInfo-1
2437 * external to be returned to the client in accordance with Z35.90
2438 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2439 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2441 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2443 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2444 addinfo ? " -- " : "", addinfo ? addinfo : "");
2445 return zget_init_diagnostics(odr, error, addinfo);
2449 * nonsurrogate diagnostic record.
2451 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2453 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2455 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2456 addinfo ? " -- " : "", addinfo ? addinfo : "");
2458 rec->which = Z_Records_NSD;
2459 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2465 * surrogate diagnostic.
2467 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2469 int error, const char *addinfo)
2471 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2472 addinfo ? " -- " : "", addinfo ? addinfo : "");
2473 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2476 static Z_Records *pack_records(association *a, char *setname, int start,
2477 int *num, Z_RecordComposition *comp,
2478 int *next, int *pres, oid_value format,
2479 Z_ReferenceId *referenceId,
2480 int *oid, int *errcode)
2482 int recno, total_length = 0, toget = *num, dumped_records = 0;
2483 Z_Records *records =
2484 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2485 Z_NamePlusRecordList *reclist =
2486 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2487 Z_NamePlusRecord **list =
2488 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2490 records->which = Z_Records_DBOSD;
2491 records->u.databaseOrSurDiagnostics = reclist;
2492 reclist->num_records = 0;
2493 reclist->records = list;
2494 *pres = Z_PresentStatus_success;
2498 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2499 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2500 a->maximumRecordSize);
2501 for (recno = start; reclist->num_records < toget; recno++)
2504 Z_NamePlusRecord *thisrec;
2505 int this_length = 0;
2507 * we get the number of bytes allocated on the stream before any
2508 * allocation done by the backend - this should give us a reasonable
2509 * idea of the total size of the data so far.
2511 total_length = odr_total(a->encode) - dumped_records;
2517 freq.last_in_set = 0;
2518 freq.setname = setname;
2519 freq.surrogate_flag = 0;
2520 freq.number = recno;
2522 freq.request_format = format;
2523 freq.request_format_raw = oid;
2524 freq.output_format = format;
2525 freq.output_format_raw = 0;
2526 freq.stream = a->encode;
2527 freq.print = a->print;
2528 freq.referenceId = referenceId;
2531 retrieve_fetch(a, &freq);
2533 *next = freq.last_in_set ? 0 : recno + 1;
2535 /* backend should be able to signal whether error is system-wide
2536 or only pertaining to current record */
2539 if (!freq.surrogate_flag)
2542 *pres = Z_PresentStatus_failure;
2543 /* for 'present request out of range',
2544 set addinfo to record position if not set */
2545 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2546 freq.errstring == 0)
2548 sprintf (s, "%d", recno);
2552 *errcode = freq.errcode;
2553 return diagrec(a, freq.errcode, freq.errstring);
2555 reclist->records[reclist->num_records] =
2556 surrogatediagrec(a, freq.basename, freq.errcode,
2558 reclist->num_records++;
2561 if (freq.record == 0) /* no error and no record ? */
2563 *next = 0; /* signal end-of-set and stop */
2567 this_length = freq.len;
2569 this_length = odr_total(a->encode) - total_length - dumped_records;
2570 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2571 this_length, total_length, dumped_records);
2572 if (a->preferredMessageSize > 0 &&
2573 this_length + total_length > a->preferredMessageSize)
2575 /* record is small enough, really */
2576 if (this_length <= a->preferredMessageSize && recno > start)
2578 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2579 *pres = Z_PresentStatus_partial_2;
2582 /* record can only be fetched by itself */
2583 if (this_length < a->maximumRecordSize)
2585 yaz_log(log_requestdetail, " Record > prefmsgsz");
2588 yaz_log(YLOG_DEBUG, " Dropped it");
2589 reclist->records[reclist->num_records] =
2590 surrogatediagrec(a, freq.basename, 16, 0);
2591 reclist->num_records++;
2592 dumped_records += this_length;
2596 else /* too big entirely */
2598 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2599 this_length, a->maximumRecordSize);
2600 reclist->records[reclist->num_records] =
2601 surrogatediagrec(a, freq.basename, 17, 0);
2602 reclist->num_records++;
2603 dumped_records += this_length;
2608 if (!(thisrec = (Z_NamePlusRecord *)
2609 odr_malloc(a->encode, sizeof(*thisrec))))
2612 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2614 thisrec->databaseName = 0;
2615 thisrec->which = Z_NamePlusRecord_databaseRecord;
2617 if (freq.output_format_raw)
2619 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
2620 freq.output_format = ident->value;
2622 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
2623 freq.record, freq.len);
2624 if (!thisrec->u.databaseRecord)
2626 reclist->records[reclist->num_records] = thisrec;
2627 reclist->num_records++;
2629 *num = reclist->num_records;
2633 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2636 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2637 bend_search_rr *bsrr =
2638 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2640 yaz_log(log_requestdetail, "Got SearchRequest.");
2642 bsrr->request = reqb;
2643 bsrr->association = assoc;
2644 bsrr->referenceId = req->referenceId;
2645 save_referenceId (reqb, bsrr->referenceId);
2646 bsrr->srw_sortKeys = 0;
2647 bsrr->srw_setname = 0;
2648 bsrr->srw_setnameIdleTime = 0;
2649 bsrr->estimated_hit_count = 0;
2650 bsrr->partial_resultset = 0;
2652 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2653 if (req->databaseNames)
2656 for (i = 0; i < req->num_databaseNames; i++)
2657 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2660 yaz_log_zquery_level(log_requestdetail,req->query);
2662 if (assoc->init->bend_search)
2664 bsrr->setname = req->resultSetName;
2665 bsrr->replace_set = *req->replaceIndicator;
2666 bsrr->num_bases = req->num_databaseNames;
2667 bsrr->basenames = req->databaseNames;
2668 bsrr->query = req->query;
2669 bsrr->stream = assoc->encode;
2670 nmem_transfer(bsrr->stream->mem, reqb->request_mem);
2671 bsrr->decode = assoc->decode;
2672 bsrr->print = assoc->print;
2675 bsrr->errstring = NULL;
2676 bsrr->search_info = NULL;
2678 if (assoc->server && assoc->server->cql_transform
2679 && req->query->which == Z_Query_type_104
2680 && req->query->u.type_104->which == Z_External_CQL)
2682 /* have a CQL query and a CQL to PQF transform .. */
2684 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2685 assoc->server->cql_transform, bsrr->query);
2687 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2690 (assoc->init->bend_search)(assoc->backend, bsrr);
2691 if (!bsrr->request) /* backend not ready with the search response */
2692 return 0; /* should not be used any more */
2696 /* FIXME - make a diagnostic for it */
2697 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2699 return response_searchRequest(assoc, reqb, bsrr, fd);
2702 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2705 * Prepare a searchresponse based on the backend results. We probably want
2706 * to look at making the fetching of records nonblocking as well, but
2707 * so far, we'll keep things simple.
2708 * If bsrt is null, that means we're called in response to a communications
2709 * event, and we'll have to get the response for ourselves.
2711 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2712 bend_search_rr *bsrt, int *fd)
2714 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2715 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2716 Z_SearchResponse *resp = (Z_SearchResponse *)
2717 odr_malloc (assoc->encode, sizeof(*resp));
2718 int *nulint = odr_intdup (assoc->encode, 0);
2719 int *next = odr_intdup(assoc->encode, 0);
2720 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2721 int returnedrecs = 0;
2723 apdu->which = Z_APDU_searchResponse;
2724 apdu->u.searchResponse = resp;
2725 resp->referenceId = req->referenceId;
2726 resp->additionalSearchInfo = 0;
2727 resp->otherInfo = 0;
2729 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2731 yaz_log(YLOG_FATAL, "Bad result from backend");
2734 else if (bsrt->errcode)
2736 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2737 resp->resultCount = nulint;
2738 resp->numberOfRecordsReturned = nulint;
2739 resp->nextResultSetPosition = nulint;
2740 resp->searchStatus = nulint;
2741 resp->resultSetStatus = none;
2742 resp->presentStatus = 0;
2746 bool_t *sr = odr_intdup(assoc->encode, 1);
2747 int *toget = odr_intdup(assoc->encode, 0);
2748 Z_RecordComposition comp, *compp = 0;
2750 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2753 resp->resultCount = &bsrt->hits;
2755 comp.which = Z_RecordComp_simple;
2756 /* how many records does the user agent want, then? */
2757 if (bsrt->hits <= *req->smallSetUpperBound)
2759 *toget = bsrt->hits;
2760 if ((comp.u.simple = req->smallSetElementSetNames))
2763 else if (bsrt->hits < *req->largeSetLowerBound)
2765 *toget = *req->mediumSetPresentNumber;
2766 if (*toget > bsrt->hits)
2767 *toget = bsrt->hits;
2768 if ((comp.u.simple = req->mediumSetElementSetNames))
2774 if (*toget && !resp->records)
2778 int *presst = odr_intdup(assoc->encode, 0);
2780 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2783 form = prefformat->value;
2785 /* Call bend_present if defined */
2786 if (assoc->init->bend_present)
2788 bend_present_rr *bprr = (bend_present_rr *)
2789 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2790 bprr->setname = req->resultSetName;
2792 bprr->number = *toget;
2793 bprr->format = form;
2795 bprr->referenceId = req->referenceId;
2796 bprr->stream = assoc->encode;
2797 bprr->print = assoc->print;
2798 bprr->request = reqb;
2799 bprr->association = assoc;
2801 bprr->errstring = NULL;
2802 (*assoc->init->bend_present)(assoc->backend, bprr);
2808 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2809 *resp->presentStatus = Z_PresentStatus_failure;
2814 resp->records = pack_records(assoc, req->resultSetName, 1,
2815 toget, compp, next, presst, form, req->referenceId,
2816 req->preferredRecordSyntax, NULL);
2819 resp->numberOfRecordsReturned = toget;
2820 returnedrecs = *toget;
2821 resp->presentStatus = presst;
2825 if (*resp->resultCount)
2827 resp->numberOfRecordsReturned = nulint;
2828 resp->presentStatus = 0;
2830 resp->nextResultSetPosition = next;
2831 resp->searchStatus = sr;
2832 resp->resultSetStatus = 0;
2833 if (bsrt->estimated_hit_count)
2835 resp->resultSetStatus = odr_intdup(assoc->encode,
2836 Z_SearchResponse_estimate);
2838 else if (bsrt->partial_resultset)
2840 resp->resultSetStatus = odr_intdup(assoc->encode,
2841 Z_SearchResponse_subset);
2844 resp->additionalSearchInfo = bsrt->search_info;
2849 WRBUF wr = wrbuf_alloc();
2851 for (i = 0 ; i < req->num_databaseNames; i++){
2853 wrbuf_printf(wr, "+");
2854 wrbuf_printf(wr, req->databaseNames[i]);
2856 wrbuf_printf(wr, " ");
2859 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2861 wrbuf_printf(wr, "OK %d", bsrt->hits);
2862 wrbuf_printf(wr, " %s 1+%d ",
2863 req->resultSetName, returnedrecs);
2864 yaz_query_to_wrbuf(wr, req->query);
2866 yaz_log(log_request, "Search %s", wrbuf_buf(wr));
2873 * Maybe we got a little over-friendly when we designed bend_fetch to
2874 * get only one record at a time. Some backends can optimise multiple-record
2875 * fetches, and at any rate, there is some overhead involved in
2876 * all that selecting and hopping around. Problem is, of course, that the
2877 * frontend can't know ahead of time how many records it'll need to
2878 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2879 * is downright lousy as a bulk data transfer protocol.
2881 * To start with, we'll do the fetching of records from the backend
2882 * in one operation: To save some trips in and out of the event-handler,
2883 * and to simplify the interface to pack_records. At any rate, asynch
2884 * operation is more fun in operations that have an unpredictable execution
2885 * speed - which is normally more true for search than for present.
2887 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2890 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2894 Z_PresentResponse *resp;
2898 const char *errstring = 0;
2900 yaz_log(log_requestdetail, "Got PresentRequest.");
2902 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2905 form = prefformat->value;
2906 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2908 resp->presentStatus = odr_intdup(assoc->encode, 0);
2909 if (assoc->init->bend_present)
2911 bend_present_rr *bprr = (bend_present_rr *)
2912 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2913 bprr->setname = req->resultSetId;
2914 bprr->start = *req->resultSetStartPoint;
2915 bprr->number = *req->numberOfRecordsRequested;
2916 bprr->format = form;
2917 bprr->comp = req->recordComposition;
2918 bprr->referenceId = req->referenceId;
2919 bprr->stream = assoc->encode;
2920 bprr->print = assoc->print;
2921 bprr->request = reqb;
2922 bprr->association = assoc;
2924 bprr->errstring = NULL;
2925 (*assoc->init->bend_present)(assoc->backend, bprr);
2928 return 0; /* should not happen */
2931 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2932 *resp->presentStatus = Z_PresentStatus_failure;
2933 errcode = bprr->errcode;
2934 errstring = bprr->errstring;
2937 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2938 next = odr_intdup(assoc->encode, 0);
2939 num = odr_intdup(assoc->encode, 0);
2941 apdu->which = Z_APDU_presentResponse;
2942 apdu->u.presentResponse = resp;
2943 resp->referenceId = req->referenceId;
2944 resp->otherInfo = 0;
2948 *num = *req->numberOfRecordsRequested;
2950 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2951 num, req->recordComposition, next,
2952 resp->presentStatus,
2953 form, req->referenceId, req->preferredRecordSyntax,
2958 WRBUF wr = wrbuf_alloc();
2959 wrbuf_printf(wr, "Present ");
2961 if (*resp->presentStatus == Z_PresentStatus_failure)
2962 wrbuf_printf(wr, "ERROR %d ", errcode);
2963 else if (*resp->presentStatus == Z_PresentStatus_success)
2964 wrbuf_printf(wr, "OK - ");
2966 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2968 wrbuf_printf(wr, " %s %d+%d ",
2969 req->resultSetId, *req->resultSetStartPoint,
2970 *req->numberOfRecordsRequested);
2971 yaz_log(log_request, "%s", wrbuf_buf(wr) );
2976 resp->numberOfRecordsReturned = num;
2977 resp->nextResultSetPosition = next;
2983 * Scan was implemented rather in a hurry, and with support for only the basic
2984 * elements of the service in the backend API. Suggestions are welcome.
2986 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2988 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2989 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2990 Z_ScanResponse *res = (Z_ScanResponse *)
2991 odr_malloc (assoc->encode, sizeof(*res));
2992 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2993 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2994 Z_ListEntries *ents = (Z_ListEntries *)
2995 odr_malloc (assoc->encode, sizeof(*ents));
2996 Z_DiagRecs *diagrecs_p = NULL;
2998 bend_scan_rr *bsrr = (bend_scan_rr *)
2999 odr_malloc (assoc->encode, sizeof(*bsrr));
3000 struct scan_entry *save_entries;
3002 yaz_log(log_requestdetail, "Got ScanRequest");
3004 apdu->which = Z_APDU_scanResponse;
3005 apdu->u.scanResponse = res;
3006 res->referenceId = req->referenceId;
3008 /* if step is absent, set it to 0 */
3009 res->stepSize = odr_intdup(assoc->encode, 0);
3011 *res->stepSize = *req->stepSize;
3013 res->scanStatus = scanStatus;
3014 res->numberOfEntriesReturned = numberOfEntriesReturned;
3015 res->positionOfTerm = 0;
3016 res->entries = ents;
3017 ents->num_entries = 0;
3018 ents->entries = NULL;
3019 ents->num_nonsurrogateDiagnostics = 0;
3020 ents->nonsurrogateDiagnostics = NULL;
3021 res->attributeSet = 0;
3024 if (req->databaseNames)
3027 for (i = 0; i < req->num_databaseNames; i++)
3028 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
3030 bsrr->scanClause = 0;
3032 bsrr->errstring = 0;
3033 bsrr->num_bases = req->num_databaseNames;
3034 bsrr->basenames = req->databaseNames;
3035 bsrr->num_entries = *req->numberOfTermsRequested;
3036 bsrr->term = req->termListAndStartPoint;
3037 bsrr->referenceId = req->referenceId;
3038 bsrr->stream = assoc->encode;
3039 bsrr->print = assoc->print;
3040 bsrr->step_size = res->stepSize;
3042 /* For YAZ 2.0 and earlier it was the backend handler that
3043 initialized entries (member display_term did not exist)
3044 YAZ 2.0 and later sets 'entries' and initialize all members
3045 including 'display_term'. If YAZ 2.0 or later sees that
3046 entries was modified - we assume that it is an old handler and
3047 that 'display_term' is _not_ set.
3049 if (bsrr->num_entries > 0)
3052 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3054 for (i = 0; i<bsrr->num_entries; i++)
3056 bsrr->entries[i].term = 0;
3057 bsrr->entries[i].occurrences = 0;
3058 bsrr->entries[i].errcode = 0;
3059 bsrr->entries[i].errstring = 0;
3060 bsrr->entries[i].display_term = 0;
3063 save_entries = bsrr->entries; /* save it so we can compare later */
3065 if (req->attributeSet &&
3066 (attset = oid_getentbyoid(req->attributeSet)) &&
3067 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
3068 bsrr->attributeset = attset->value;
3070 bsrr->attributeset = VAL_NONE;
3071 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3072 bsrr->attributeset);
3073 bsrr->term_position = req->preferredPositionInResponse ?
3074 *req->preferredPositionInResponse : 1;
3076 ((int (*)(void *, bend_scan_rr *))
3077 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3080 diagrecs_p = zget_DiagRecs(assoc->encode,
3081 bsrr->errcode, bsrr->errstring);
3085 Z_Entry **tab = (Z_Entry **)
3086 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3088 if (bsrr->status == BEND_SCAN_PARTIAL)
3089 *scanStatus = Z_Scan_partial_5;
3091 *scanStatus = Z_Scan_success;
3092 ents->entries = tab;
3093 ents->num_entries = bsrr->num_entries;
3094 res->numberOfEntriesReturned = &ents->num_entries;
3095 res->positionOfTerm = &bsrr->term_position;
3096 for (i = 0; i < bsrr->num_entries; i++)
3102 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3103 if (bsrr->entries[i].occurrences >= 0)
3105 e->which = Z_Entry_termInfo;
3106 e->u.termInfo = t = (Z_TermInfo *)
3107 odr_malloc(assoc->encode, sizeof(*t));
3108 t->suggestedAttributes = 0;
3110 if (save_entries == bsrr->entries &&
3111 bsrr->entries[i].display_term)
3113 /* the entries was _not_ set by the handler. So it's
3114 safe to test for new member display_term. It is
3117 t->displayTerm = odr_strdup(assoc->encode,
3118 bsrr->entries[i].display_term);
3120 t->alternativeTerm = 0;
3121 t->byAttributes = 0;
3122 t->otherTermInfo = 0;
3123 t->globalOccurrences = &bsrr->entries[i].occurrences;
3124 t->term = (Z_Term *)
3125 odr_malloc(assoc->encode, sizeof(*t->term));
3126 t->term->which = Z_Term_general;
3127 t->term->u.general = o =
3128 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3129 o->buf = (unsigned char *)
3130 odr_malloc(assoc->encode, o->len = o->size =
3131 strlen(bsrr->entries[i].term));
3132 memcpy(o->buf, bsrr->entries[i].term, o->len);
3133 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3134 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3138 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3139 bsrr->entries[i].errcode,
3140 bsrr->entries[i].errstring);
3141 assert (drecs->num_diagRecs == 1);
3142 e->which = Z_Entry_surrogateDiagnostic;
3143 assert (drecs->diagRecs[0]);
3144 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3150 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3151 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3156 WRBUF wr = wrbuf_alloc();
3157 wrbuf_printf(wr, "Scan ");
3158 for (i = 0 ; i < req->num_databaseNames; i++){
3160 wrbuf_printf(wr, "+");
3161 wrbuf_printf(wr, req->databaseNames[i]);
3163 wrbuf_printf(wr, " ");
3166 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3167 wrbuf_printf(wr, " ");
3170 wrbuf_printf(wr, "OK ");
3171 /* else if (*res->scanStatus == Z_Scan_success) */
3172 /* wrbuf_printf(wr, "OK "); */
3174 /* wrbuf_printf(wr, "Partial "); */
3176 if (*res->numberOfEntriesReturned)
3177 wrbuf_printf(wr, "%d - ", *res->numberOfEntriesReturned);
3179 wrbuf_printf(wr, "0 - ");
3181 wrbuf_printf(wr, "%d+%d+%d ",
3182 (req->preferredPositionInResponse ?
3183 *req->preferredPositionInResponse : 1),
3184 *req->numberOfTermsRequested,
3185 (res->stepSize ? *res->stepSize : 1));
3187 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3188 bsrr->attributeset);
3189 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3195 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3199 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3200 Z_SortResponse *res = (Z_SortResponse *)
3201 odr_malloc (assoc->encode, sizeof(*res));
3202 bend_sort_rr *bsrr = (bend_sort_rr *)
3203 odr_malloc (assoc->encode, sizeof(*bsrr));
3205 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3207 yaz_log(log_requestdetail, "Got SortRequest.");
3209 bsrr->num_input_setnames = req->num_inputResultSetNames;
3210 for (i=0;i<req->num_inputResultSetNames;i++)
3211 yaz_log(log_requestdetail, "Input resultset: '%s'",
3212 req->inputResultSetNames[i]);
3213 bsrr->input_setnames = req->inputResultSetNames;
3214 bsrr->referenceId = req->referenceId;
3215 bsrr->output_setname = req->sortedResultSetName;
3216 yaz_log(log_requestdetail, "Output resultset: '%s'",
3217 req->sortedResultSetName);
3218 bsrr->sort_sequence = req->sortSequence;
3219 /*FIXME - dump those sequences too */
3220 bsrr->stream = assoc->encode;
3221 bsrr->print = assoc->print;
3223 bsrr->sort_status = Z_SortResponse_failure;
3225 bsrr->errstring = 0;
3227 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3229 res->referenceId = bsrr->referenceId;
3230 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3231 res->resultSetStatus = 0;
3234 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3235 bsrr->errcode, bsrr->errstring);
3236 res->diagnostics = dr->diagRecs;
3237 res->num_diagnostics = dr->num_diagRecs;
3241 res->num_diagnostics = 0;
3242 res->diagnostics = 0;
3244 res->resultCount = 0;
3247 apdu->which = Z_APDU_sortResponse;
3248 apdu->u.sortResponse = res;
3251 WRBUF wr = wrbuf_alloc();
3252 wrbuf_printf(wr, "Sort ");
3254 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3256 wrbuf_printf(wr, "OK -");
3257 wrbuf_printf(wr, " (");
3258 for (i = 0; i<req->num_inputResultSetNames; i++)
3261 wrbuf_printf(wr, "+");
3262 wrbuf_printf(wr, req->inputResultSetNames[i]);
3264 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3266 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3272 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3276 Z_DeleteResultSetRequest *req =
3277 reqb->apdu_request->u.deleteResultSetRequest;
3278 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3279 odr_malloc (assoc->encode, sizeof(*res));
3280 bend_delete_rr *bdrr = (bend_delete_rr *)
3281 odr_malloc (assoc->encode, sizeof(*bdrr));
3282 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3284 yaz_log(log_requestdetail, "Got DeleteRequest.");
3286 bdrr->num_setnames = req->num_resultSetList;
3287 bdrr->setnames = req->resultSetList;
3288 for (i = 0; i<req->num_resultSetList; i++)
3289 yaz_log(log_requestdetail, "resultset: '%s'",
3290 req->resultSetList[i]);
3291 bdrr->stream = assoc->encode;
3292 bdrr->print = assoc->print;
3293 bdrr->function = *req->deleteFunction;
3294 bdrr->referenceId = req->referenceId;
3296 if (bdrr->num_setnames > 0)
3298 bdrr->statuses = (int*)
3299 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3300 bdrr->num_setnames);
3301 for (i = 0; i < bdrr->num_setnames; i++)
3302 bdrr->statuses[i] = 0;
3304 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3306 res->referenceId = req->referenceId;
3308 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3310 res->deleteListStatuses = 0;
3311 if (bdrr->num_setnames > 0)
3314 res->deleteListStatuses = (Z_ListStatuses *)
3315 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3316 res->deleteListStatuses->num = bdrr->num_setnames;
3317 res->deleteListStatuses->elements =
3319 odr_malloc (assoc->encode,
3320 sizeof(*res->deleteListStatuses->elements) *
3321 bdrr->num_setnames);
3322 for (i = 0; i<bdrr->num_setnames; i++)
3324 res->deleteListStatuses->elements[i] =
3326 odr_malloc (assoc->encode,
3327 sizeof(**res->deleteListStatuses->elements));
3328 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3329 res->deleteListStatuses->elements[i]->id =
3330 odr_strdup (assoc->encode, bdrr->setnames[i]);
3333 res->numberNotDeleted = 0;
3334 res->bulkStatuses = 0;
3335 res->deleteMessage = 0;
3338 apdu->which = Z_APDU_deleteResultSetResponse;
3339 apdu->u.deleteResultSetResponse = res;
3342 WRBUF wr = wrbuf_alloc();
3343 wrbuf_printf(wr, "Delete ");
3344 if (bdrr->delete_status)
3345 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3347 wrbuf_printf(wr, "OK -");
3348 for (i = 0; i<req->num_resultSetList; i++)
3349 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3350 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3356 static void process_close(association *assoc, request *reqb)
3358 Z_Close *req = reqb->apdu_request->u.close;
3359 static char *reasons[] =
3366 "securityViolation",
3373 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3374 reasons[*req->closeReason], req->diagnosticInformation ?
3375 req->diagnosticInformation : "NULL");
3376 if (assoc->version < 3) /* to make do_force respond with close */
3378 do_close_req(assoc, Z_Close_finished,
3379 "Association terminated by client", reqb);
3380 yaz_log(log_request,"Close OK");
3383 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3387 reqb->len_refid = refid->len;
3388 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3389 memcpy (reqb->refid, refid->buf, refid->len);
3393 reqb->len_refid = 0;
3398 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3400 process_z_response (a, req, res);
3403 bend_request bend_request_mk (bend_association a)
3405 request *nreq = request_get (&a->outgoing);
3406 nreq->request_mem = nmem_create ();
3410 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3415 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3416 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3417 id->len = id->size = req->len_refid;
3418 memcpy (id->buf, req->refid, req->len_refid);
3422 void bend_request_destroy (bend_request *req)
3424 nmem_destroy((*req)->request_mem);
3425 request_release(*req);
3429 int bend_backend_respond (bend_association a, bend_request req)
3433 r = process_z_request (a, req, &msg);
3435 yaz_log (YLOG_WARN, "%s", msg);
3439 void bend_request_setdata(bend_request r, void *p)
3444 void *bend_request_getdata(bend_request r)
3446 return r->clientData;
3449 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3451 bend_segment_rr req;
3453 req.segment = reqb->apdu_request->u.segmentRequest;
3454 req.stream = assoc->encode;
3455 req.decode = assoc->decode;
3456 req.print = assoc->print;
3457 req.association = assoc;
3459 (*assoc->init->bend_segment)(assoc->backend, &req);
3464 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3466 bend_esrequest_rr esrequest;
3467 const char *ext_name = "unknown";
3469 Z_ExtendedServicesRequest *req =
3470 reqb->apdu_request->u.extendedServicesRequest;
3471 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3473 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3475 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3476 esrequest.stream = assoc->encode;
3477 esrequest.decode = assoc->decode;
3478 esrequest.print = assoc->print;
3479 esrequest.errcode = 0;
3480 esrequest.errstring = NULL;
3481 esrequest.request = reqb;
3482 esrequest.association = assoc;
3483 esrequest.taskPackage = 0;
3484 esrequest.referenceId = req->referenceId;
3487 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3489 switch(esrequest.esr->taskSpecificParameters->which)
3491 case Z_External_itemOrder:
3492 ext_name = "ItemOrder"; break;
3493 case Z_External_update:
3494 ext_name = "Update"; break;
3495 case Z_External_update0:
3496 ext_name = "Update0"; break;
3497 case Z_External_ESAdmin:
3498 ext_name = "Admin"; break;
3503 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3505 /* If the response is being delayed, return NULL */
3506 if (esrequest.request == NULL)
3509 resp->referenceId = req->referenceId;
3511 if (esrequest.errcode == -1)
3513 /* Backend service indicates request will be processed */
3514 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3515 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3517 else if (esrequest.errcode == 0)
3519 /* Backend service indicates request will be processed */
3520 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3521 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3525 Z_DiagRecs *diagRecs =
3526 zget_DiagRecs(assoc->encode, esrequest.errcode,
3527 esrequest.errstring);
3528 /* Backend indicates error, request will not be processed */
3529 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3530 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3531 resp->num_diagnostics = diagRecs->num_diagRecs;
3532 resp->diagnostics = diagRecs->diagRecs;
3535 WRBUF wr = wrbuf_alloc();
3536 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3537 yaz_log(log_request, "EsRequest %s", wrbuf_buf(wr) );
3542 /* Do something with the members of bend_extendedservice */
3543 if (esrequest.taskPackage)
3544 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
3545 (const char *) esrequest.taskPackage,
3547 yaz_log(YLOG_DEBUG,"Send the result apdu");
3551 int bend_assoc_is_alive(bend_association assoc)
3553 if (assoc->state == ASSOC_DEAD)
3554 return 0; /* already marked as dead. Don't check I/O chan anymore */
3556 return iochan_is_alive(assoc->client_chan);
3563 * indent-tabs-mode: nil
3565 * vim: shiftwidth=4 tabstop=8 expandtab