2 * Copyright (C) 1995-2007, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.109 2007-01-16 14:12:38 adam Exp $
9 * \brief Implements GFS session logic.
11 * Frontend server logic.
13 * This code receives incoming APDUs, and handles client requests by means
16 * Some of the code is getting quite involved, compared to simpler servers -
17 * primarily because it is asynchronous both in the communication with
18 * the user and the backend. We think the complexity will pay off in
19 * the form of greater flexibility when more asynchronous facilities
22 * Memory management has become somewhat involved. In the simple case, where
23 * only one PDU is pending at a time, it will simply reuse the same memory,
24 * once it has found its working size. When we enable multiple concurrent
25 * operations, perhaps even with multiple parallel calls to the backend, it
26 * will maintain a pool of buffers for encoding and decoding, trying to
27 * minimize memory allocation/deallocation during normal operation.
37 #include <sys/types.h>
45 #define S_ISREG(x) (x & _S_IFREG)
54 #include <libxml/parser.h>
55 #include <libxml/tree.h>
58 #include <yaz/yconfig.h>
59 #include <yaz/xmalloc.h>
60 #include <yaz/comstack.h>
64 #include <yaz/proto.h>
67 #include <yaz/logrpn.h>
68 #include <yaz/querytowrbuf.h>
69 #include <yaz/statserv.h>
70 #include <yaz/diagbib1.h>
71 #include <yaz/charneg.h>
72 #include <yaz/otherinfo.h>
73 #include <yaz/yaz-util.h>
74 #include <yaz/pquery.h>
77 #include <yaz/backend.h>
79 static void process_gdu_request(association *assoc, request *req);
80 static int process_z_request(association *assoc, request *req, char **msg);
81 void backend_response(IOCHAN i, int event);
82 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
83 static int process_z_response(association *assoc, request *req, Z_APDU *res);
84 static Z_APDU *process_initRequest(association *assoc, request *reqb);
85 static Z_External *init_diagnostics(ODR odr, int errcode,
86 const char *errstring);
87 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
89 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
90 bend_search_rr *bsrr, int *fd);
91 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
93 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
94 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
95 static void process_close(association *assoc, request *reqb);
96 void save_referenceId (request *reqb, Z_ReferenceId *refid);
97 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
99 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
101 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
103 /* dynamic logging levels */
104 static int logbits_set = 0;
105 static int log_session = 0; /* one-line logs for session */
106 static int log_sessiondetail = 0; /* more detailed stuff */
107 static int log_request = 0; /* one-line logs for requests */
108 static int log_requestdetail = 0; /* more detailed stuff */
110 /** get_logbits sets global loglevel bits */
111 static void get_logbits(void)
112 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
116 log_session = yaz_log_module_level("session");
117 log_sessiondetail = yaz_log_module_level("sessiondetail");
118 log_request = yaz_log_module_level("request");
119 log_requestdetail = yaz_log_module_level("requestdetail");
125 static void wr_diag(WRBUF w, int error, const char *addinfo)
127 wrbuf_printf(w, "ERROR %d+", error);
128 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
131 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
139 * Create and initialize a new association-handle.
140 * channel : iochannel for the current line.
141 * link : communications channel.
142 * Returns: 0 or a new association handle.
144 association *create_association(IOCHAN channel, COMSTACK link,
145 const char *apdufile)
151 if (!(anew = (association *)xmalloc(sizeof(*anew))))
155 anew->last_control = 0;
156 anew->client_chan = channel;
157 anew->client_link = link;
158 anew->cs_get_mask = 0;
159 anew->cs_put_mask = 0;
160 anew->cs_accept_mask = 0;
161 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
162 !(anew->encode = odr_createmem(ODR_ENCODE)))
164 if (apdufile && *apdufile)
168 if (!(anew->print = odr_createmem(ODR_PRINT)))
170 if (*apdufile == '@')
172 odr_setprint(anew->print, yaz_log_file());
174 else if (*apdufile != '-')
177 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
178 if (!(f = fopen(filename, "w")))
180 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
183 setvbuf(f, 0, _IONBF, 0);
184 odr_setprint(anew->print, f);
189 anew->input_buffer = 0;
190 anew->input_buffer_len = 0;
192 anew->state = ASSOC_NEW;
193 request_initq(&anew->incoming);
194 request_initq(&anew->outgoing);
195 anew->proto = cs_getproto(link);
201 * Free association and release resources.
203 void destroy_association(association *h)
205 statserv_options_block *cb = statserv_getcontrol();
209 odr_destroy(h->decode);
210 odr_destroy(h->encode);
212 odr_destroy(h->print);
214 xfree(h->input_buffer);
216 (*cb->bend_close)(h->backend);
217 while ((req = request_deq(&h->incoming)))
218 request_release(req);
219 while ((req = request_deq(&h->outgoing)))
220 request_release(req);
221 request_delq(&h->incoming);
222 request_delq(&h->outgoing);
224 xmalloc_trav("session closed");
225 if (cb && cb->one_shot)
231 static void do_close_req(association *a, int reason, char *message,
235 Z_Close *cls = zget_Close(a->encode);
237 /* Purge request queue */
238 while (request_deq(&a->incoming));
239 while (request_deq(&a->outgoing));
242 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
243 reason, message ? message : "none");
244 apdu.which = Z_APDU_close;
246 *cls->closeReason = reason;
247 cls->diagnosticInformation = message;
248 process_z_response(a, req, &apdu);
249 iochan_settimeout(a->client_chan, 20);
253 request_release(req);
254 yaz_log(log_requestdetail, "v2 client. No Close PDU");
255 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
258 a->state = ASSOC_DEAD;
261 static void do_close(association *a, int reason, char *message)
263 request *req = request_get(&a->outgoing);
264 do_close_req (a, reason, message, req);
268 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;
615 rr->errcode = YAZ_BIB1_ELEMENT_SET_NAMES_UNSUPP;
617 rr->errstring = odr_strdup(rr->stream, details);
622 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
623 if (input_syntax_raw)
625 char oidbuf[OID_STR_MAX];
626 oid_to_dotstring(input_syntax_raw, oidbuf);
627 rr->errstring = odr_strdup(rr->stream, oidbuf);
633 yaz_set_esn(&rr->comp, backend_schema, rr->stream->mem);
637 oident *oident_syntax = oid_getentbyoid(backend_syntax);
639 rr->request_format_raw = backend_syntax;
642 rr->request_format = oident_syntax->value;
644 rr->request_format = VAL_NONE;
647 (*assoc->init->bend_fetch)(assoc->backend, rr);
648 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
649 { /* post conversion must take place .. */
650 WRBUF output_record = wrbuf_alloc();
651 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
654 const char *details = yaz_record_conv_get_error(rc);
655 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
657 rr->errstring = odr_strdup(rr->stream, details);
661 rr->len = wrbuf_len(output_record);
662 rr->record = odr_malloc(rr->stream, rr->len);
663 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
665 wrbuf_free(output_record, 1);
669 struct oident *oi = oid_getentbyoid(match_syntax);
670 rr->output_format = oi ? oi->value : VAL_NONE;
671 rr->output_format_raw = match_syntax;
674 rr->schema = odr_strdup(rr->stream, match_schema);
677 (*assoc->init->bend_fetch)(assoc->backend, rr);
681 static int srw_bend_fetch(association *assoc, int pos,
682 Z_SRW_searchRetrieveRequest *srw_req,
683 Z_SRW_record *record,
684 const char **addinfo)
687 ODR o = assoc->encode;
689 rr.setname = "default";
692 rr.request_format = VAL_TEXT_XML;
693 rr.request_format_raw = yaz_oidval_to_z3950oid(assoc->decode,
696 rr.comp = (Z_RecordComposition *)
697 odr_malloc(assoc->decode, sizeof(*rr.comp));
698 rr.comp->which = Z_RecordComp_complex;
699 rr.comp->u.complex = (Z_CompSpec *)
700 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
701 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
702 odr_malloc(assoc->encode, sizeof(bool_t));
703 *rr.comp->u.complex->selectAlternativeSyntax = 0;
704 rr.comp->u.complex->num_dbSpecific = 0;
705 rr.comp->u.complex->dbSpecific = 0;
706 rr.comp->u.complex->num_recordSyntax = 0;
707 rr.comp->u.complex->recordSyntax = 0;
709 rr.comp->u.complex->generic = (Z_Specification *)
710 odr_malloc(assoc->decode, sizeof(Z_Specification));
712 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
713 rr.comp->u.complex->generic->which = Z_Schema_uri;
714 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
716 /* ESN = recordSchema if recordSchema is present */
717 rr.comp->u.complex->generic->elementSpec = 0;
718 if (srw_req->recordSchema)
720 rr.comp->u.complex->generic->elementSpec =
721 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
722 rr.comp->u.complex->generic->elementSpec->which =
723 Z_ElementSpec_elementSetName;
724 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
725 srw_req->recordSchema;
728 rr.stream = assoc->encode;
729 rr.print = assoc->print;
737 rr.surrogate_flag = 0;
738 rr.schema = srw_req->recordSchema;
740 if (!assoc->init->bend_fetch)
743 retrieve_fetch(assoc, &rr);
745 if (rr.errcode && rr.surrogate_flag)
747 int code = yaz_diag_bib1_to_srw(rr.errcode);
748 const char *message = yaz_diag_srw_str(code);
751 len += strlen(message);
753 len += strlen(rr.errstring);
755 record->recordData_buf = odr_malloc(o, len);
757 sprintf(record->recordData_buf, "<diagnostic "
758 "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
759 " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
761 sprintf(record->recordData_buf + strlen(record->recordData_buf),
762 " <details>%s</details>\n", rr.errstring);
764 sprintf(record->recordData_buf + strlen(record->recordData_buf),
765 " <message>%s</message>\n", message);
766 sprintf(record->recordData_buf + strlen(record->recordData_buf),
768 record->recordData_len = strlen(record->recordData_buf);
769 record->recordPosition = odr_intdup(o, pos);
770 record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
773 else if (rr.len >= 0)
775 record->recordData_buf = rr.record;
776 record->recordData_len = rr.len;
777 record->recordPosition = odr_intdup(o, pos);
779 record->recordSchema = odr_strdup(o, rr.schema);
781 record->recordSchema = 0;
785 *addinfo = rr.errstring;
791 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
792 Z_Query *query_result)
794 /* have a CQL query and CQL to PQF transform .. */
795 CQL_parser cp = cql_parser_create();
801 r = cql_parser_string(cp, cql);
804 /* CQL syntax error */
810 r = cql_transform_buf(ct,
811 cql_parser_result(cp),
812 rpn_buf, sizeof(rpn_buf)-1);
814 srw_errcode = cql_transform_error(ct, &add);
818 /* Syntax & transform OK. */
819 /* Convert PQF string to Z39.50 to RPN query struct */
820 YAZ_PQF_Parser pp = yaz_pqf_create();
821 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
826 int code = yaz_pqf_error(pp, &pqf_msg, &off);
827 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
833 query_result->which = Z_Query_type_1;
834 query_result->u.type_1 = rpnquery;
838 cql_parser_destroy(cp);
842 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
843 Z_AttributesPlusTerm *result)
847 int srw_error = cql2pqf(odr, cql, ct, &query);
850 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
851 return 10; /* bad query type */
852 rpn = query.u.type_1;
853 if (!rpn->RPNStructure)
854 return 10; /* must be structure */
855 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
856 return 10; /* must be simple */
857 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
858 return 10; /* must be attributes plus term node .. */
859 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
864 static void srw_bend_search(association *assoc, request *req,
866 Z_SRW_searchRetrieveResponse *srw_res,
871 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
874 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
875 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
876 if (srw_res->num_diagnostics == 0 && assoc->init)
879 rr.setname = "default";
882 rr.basenames = &srw_req->database;
886 rr.srw_setnameIdleTime = 0;
887 rr.estimated_hit_count = 0;
888 rr.partial_resultset = 0;
889 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
890 rr.query->u.type_1 = 0;
892 if (srw_req->query_type == Z_SRW_query_type_cql)
894 if (assoc->server && assoc->server->cql_transform)
896 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
897 assoc->server->cql_transform,
901 yaz_add_srw_diagnostic(assoc->encode,
902 &srw_res->diagnostics,
903 &srw_res->num_diagnostics,
909 /* CQL query to backend. Wrap it - Z39.50 style */
910 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
911 ext->direct_reference = odr_getoidbystr(assoc->decode,
912 "1.2.840.10003.16.2");
913 ext->indirect_reference = 0;
915 ext->which = Z_External_CQL;
916 ext->u.cql = srw_req->query.cql;
918 rr.query->which = Z_Query_type_104;
919 rr.query->u.type_104 = ext;
922 else if (srw_req->query_type == Z_SRW_query_type_pqf)
924 Z_RPNQuery *RPNquery;
925 YAZ_PQF_Parser pqf_parser;
927 pqf_parser = yaz_pqf_create ();
929 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
935 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
936 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
937 code, pqf_msg, (long) off);
938 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
941 rr.query->which = Z_Query_type_1;
942 rr.query->u.type_1 = RPNquery;
944 yaz_pqf_destroy (pqf_parser);
948 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
949 &srw_res->num_diagnostics,
950 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
952 if (rr.query->u.type_1)
954 rr.stream = assoc->encode;
955 rr.decode = assoc->decode;
956 rr.print = assoc->print;
958 if ( srw_req->sort.sortKeys )
959 rr.srw_sortKeys = odr_strdup(assoc->encode,
960 srw_req->sort.sortKeys );
961 rr.association = assoc;
967 yaz_log_zquery_level(log_requestdetail,rr.query);
969 (assoc->init->bend_search)(assoc->backend, &rr);
972 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
978 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
979 yaz_add_srw_diagnostic(assoc->encode,
980 &srw_res->diagnostics,
981 &srw_res->num_diagnostics,
982 srw_error, rr.errstring);
987 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
988 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
990 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
991 start, number, rr.hits);
993 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
996 srw_res->resultSetId =
997 odr_strdup(assoc->encode, rr.srw_setname );
998 srw_res->resultSetIdleTime =
999 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1002 if ((rr.hits > 0 && start > rr.hits) || start < 1)
1004 yaz_add_srw_diagnostic(
1006 &srw_res->diagnostics, &srw_res->num_diagnostics,
1007 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1009 else if (number > 0)
1013 if (start + number > rr.hits)
1014 number = rr.hits - start + 1;
1016 /* Call bend_present if defined */
1017 if (assoc->init->bend_present)
1019 bend_present_rr *bprr = (bend_present_rr*)
1020 odr_malloc (assoc->decode, sizeof(*bprr));
1021 bprr->setname = "default";
1022 bprr->start = start;
1023 bprr->number = number;
1024 bprr->format = VAL_TEXT_XML;
1025 if (srw_req->recordSchema)
1027 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1028 sizeof(*bprr->comp));
1029 bprr->comp->which = Z_RecordComp_simple;
1030 bprr->comp->u.simple = (Z_ElementSetNames *)
1031 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1032 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1033 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1039 bprr->stream = assoc->encode;
1040 bprr->referenceId = 0;
1041 bprr->print = assoc->print;
1042 bprr->request = req;
1043 bprr->association = assoc;
1045 bprr->errstring = NULL;
1046 (*assoc->init->bend_present)(assoc->backend, bprr);
1052 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1053 yaz_add_srw_diagnostic(assoc->encode,
1054 &srw_res->diagnostics,
1055 &srw_res->num_diagnostics,
1056 srw_error, bprr->errstring);
1064 int packing = Z_SRW_recordPacking_string;
1065 if (srw_req->recordPacking)
1068 yaz_srw_str_to_pack(srw_req->recordPacking);
1070 packing = Z_SRW_recordPacking_string;
1072 srw_res->records = (Z_SRW_record *)
1073 odr_malloc(assoc->encode,
1074 number * sizeof(*srw_res->records));
1076 srw_res->extra_records = (Z_SRW_extra_record **)
1077 odr_malloc(assoc->encode,
1078 number*sizeof(*srw_res->extra_records));
1080 for (i = 0; i<number; i++)
1083 const char *addinfo = 0;
1085 srw_res->records[j].recordPacking = packing;
1086 srw_res->records[j].recordData_buf = 0;
1087 srw_res->extra_records[j] = 0;
1088 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1089 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1090 srw_res->records + j,
1094 yaz_add_srw_diagnostic(assoc->encode,
1095 &srw_res->diagnostics,
1096 &srw_res->num_diagnostics,
1097 yaz_diag_bib1_to_srw (errcode),
1102 if (srw_res->records[j].recordData_buf)
1105 srw_res->num_records = j;
1107 srw_res->records = 0;
1110 if (rr.estimated_hit_count || rr.partial_resultset)
1112 yaz_add_srw_diagnostic(
1114 &srw_res->diagnostics,
1115 &srw_res->num_diagnostics,
1116 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1124 const char *querystr = "?";
1125 const char *querytype = "?";
1126 WRBUF wr = wrbuf_alloc();
1128 switch (srw_req->query_type)
1130 case Z_SRW_query_type_cql:
1132 querystr = srw_req->query.cql;
1134 case Z_SRW_query_type_pqf:
1136 querystr = srw_req->query.pqf;
1139 wrbuf_printf(wr, "SRWSearch ");
1140 wrbuf_printf(wr, srw_req->database);
1141 wrbuf_printf(wr, " ");
1142 if (srw_res->num_diagnostics)
1143 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1144 else if (*http_code != 200)
1145 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1146 else if (srw_res->numberOfRecords)
1148 wrbuf_printf(wr, "OK %d",
1149 (srw_res->numberOfRecords ?
1150 *srw_res->numberOfRecords : 0));
1152 wrbuf_printf(wr, " %s %d+%d",
1153 (srw_res->resultSetId ?
1154 srw_res->resultSetId : "-"),
1155 (srw_req->startRecord ? *srw_req->startRecord : 1),
1156 srw_res->num_records);
1157 yaz_log(log_request, "%s %s: %s", wrbuf_buf(wr), querytype, querystr);
1162 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1165 xmlNodePtr ptr = rr->server_node_ptr;
1168 for (ptr = ptr->children; ptr; ptr = ptr->next)
1170 if (ptr->type != XML_ELEMENT_NODE)
1172 if (!strcmp((const char *) ptr->name, "explain"))
1175 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1179 ptr = xmlCopyNode(ptr, 1);
1181 xmlDocSetRootElement(doc, ptr);
1183 xmlDocDumpMemory(doc, &buf_out, &len);
1184 content = (char*) odr_malloc(rr->stream, 1+len);
1185 memcpy(content, buf_out, len);
1186 content[len] = '\0';
1190 rr->explain_buf = content;
1198 static void srw_bend_explain(association *assoc, request *req,
1200 Z_SRW_explainResponse *srw_res,
1203 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1204 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1206 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1211 rr.stream = assoc->encode;
1212 rr.decode = assoc->decode;
1213 rr.print = assoc->print;
1215 rr.database = srw_req->database;
1217 rr.server_node_ptr = assoc->server->server_node_ptr;
1219 rr.server_node_ptr = 0;
1220 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1221 if (assoc->init->bend_explain)
1222 (*assoc->init->bend_explain)(assoc->backend, &rr);
1224 srw_bend_explain_default(assoc->backend, &rr);
1228 int packing = Z_SRW_recordPacking_string;
1229 if (srw_req->recordPacking)
1232 yaz_srw_str_to_pack(srw_req->recordPacking);
1234 packing = Z_SRW_recordPacking_string;
1236 srw_res->record.recordSchema = rr.schema;
1237 srw_res->record.recordPacking = packing;
1238 srw_res->record.recordData_buf = rr.explain_buf;
1239 srw_res->record.recordData_len = strlen(rr.explain_buf);
1240 srw_res->record.recordPosition = 0;
1246 static void srw_bend_scan(association *assoc, request *req,
1248 Z_SRW_scanResponse *srw_res,
1251 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1252 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1255 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1256 if (srw_res->num_diagnostics == 0 && assoc->init)
1258 struct scan_entry *save_entries;
1260 bend_scan_rr *bsrr = (bend_scan_rr *)
1261 odr_malloc (assoc->encode, sizeof(*bsrr));
1262 bsrr->num_bases = 1;
1263 bsrr->basenames = &srw_req->database;
1265 bsrr->num_entries = srw_req->maximumTerms ?
1266 *srw_req->maximumTerms : 10;
1267 bsrr->term_position = srw_req->responsePosition ?
1268 *srw_req->responsePosition : 1;
1271 bsrr->errstring = 0;
1272 bsrr->referenceId = 0;
1273 bsrr->stream = assoc->encode;
1274 bsrr->print = assoc->print;
1275 bsrr->step_size = odr_intdup(assoc->decode, 0);
1278 if (bsrr->num_entries > 0)
1281 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1283 for (i = 0; i<bsrr->num_entries; i++)
1285 bsrr->entries[i].term = 0;
1286 bsrr->entries[i].occurrences = 0;
1287 bsrr->entries[i].errcode = 0;
1288 bsrr->entries[i].errstring = 0;
1289 bsrr->entries[i].display_term = 0;
1292 save_entries = bsrr->entries; /* save it so we can compare later */
1294 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1295 assoc->init->bend_scan)
1297 Odr_oid *scan_attributeSet = 0;
1299 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1301 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1303 srw_req->scanClause.pqf);
1304 if (scan_attributeSet &&
1305 (attset = oid_getentbyoid(scan_attributeSet)) &&
1306 (attset->oclass == CLASS_ATTSET ||
1307 attset->oclass == CLASS_GENERAL))
1308 bsrr->attributeset = attset->value;
1310 bsrr->attributeset = VAL_NONE;
1311 yaz_pqf_destroy(pqf_parser);
1312 bsrr->scanClause = 0;
1313 ((int (*)(void *, bend_scan_rr *))
1314 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1316 else if (srw_req->query_type == Z_SRW_query_type_cql
1317 && assoc->init->bend_scan && assoc->server
1318 && assoc->server->cql_transform)
1321 bsrr->scanClause = 0;
1322 bsrr->attributeset = VAL_NONE;
1323 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1324 srw_error = cql2pqf_scan(assoc->encode,
1325 srw_req->scanClause.cql,
1326 assoc->server->cql_transform,
1329 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1330 &srw_res->num_diagnostics,
1334 ((int (*)(void *, bend_scan_rr *))
1335 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1338 else if (srw_req->query_type == Z_SRW_query_type_cql
1339 && assoc->init->bend_srw_scan)
1342 bsrr->attributeset = VAL_NONE;
1343 bsrr->scanClause = srw_req->scanClause.cql;
1344 ((int (*)(void *, bend_scan_rr *))
1345 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1349 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1350 &srw_res->num_diagnostics,
1351 YAZ_SRW_UNSUPP_OPERATION, "scan");
1356 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1361 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1363 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1364 &srw_res->num_diagnostics,
1365 srw_error, bsrr->errstring);
1367 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1370 srw_res->terms = (Z_SRW_scanTerm*)
1371 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1374 srw_res->num_terms = bsrr->num_entries;
1375 for (i = 0; i<bsrr->num_entries; i++)
1377 Z_SRW_scanTerm *t = srw_res->terms + i;
1378 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1379 t->numberOfRecords =
1380 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1382 if (save_entries == bsrr->entries &&
1383 bsrr->entries[i].display_term)
1385 /* the entries was _not_ set by the handler. So it's
1386 safe to test for new member display_term. It is
1389 t->displayTerm = odr_strdup(assoc->encode,
1390 bsrr->entries[i].display_term);
1398 WRBUF wr = wrbuf_alloc();
1399 const char *querytype = 0;
1400 const char *querystr = 0;
1402 switch(srw_req->query_type)
1404 case Z_SRW_query_type_pqf:
1406 querystr = srw_req->scanClause.pqf;
1408 case Z_SRW_query_type_cql:
1410 querystr = srw_req->scanClause.cql;
1413 querytype = "UNKNOWN";
1417 wrbuf_printf(wr, "SRWScan ");
1418 wrbuf_printf(wr, srw_req->database);
1419 wrbuf_printf(wr, " ");
1421 if (srw_res->num_diagnostics)
1422 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1423 else if (srw_res->num_terms)
1424 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1426 wrbuf_printf(wr, "OK - - ");
1428 wrbuf_printf(wr, "%d+%d+0 ",
1429 (srw_req->responsePosition ?
1430 *srw_req->responsePosition : 1),
1431 (srw_req->maximumTerms ?
1432 *srw_req->maximumTerms : 1));
1433 /* there is no step size in SRU/W ??? */
1434 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1435 yaz_log(log_request, "%s ", wrbuf_buf(wr) );
1441 static void srw_bend_update(association *assoc, request *req,
1443 Z_SRW_updateResponse *srw_res,
1446 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1447 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1448 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1450 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1454 Z_SRW_extra_record *extra = srw_req->extra_record;
1456 rr.stream = assoc->encode;
1457 rr.print = assoc->print;
1459 rr.basenames = &srw_req->database;
1460 rr.operation = srw_req->operation;
1461 rr.operation_status = "failed";
1463 rr.record_versions = 0;
1464 rr.num_versions = 0;
1465 rr.record_packing = "string";
1466 rr.record_schema = 0;
1468 rr.extra_record_data = 0;
1469 rr.extra_request_data = 0;
1470 rr.extra_response_data = 0;
1476 if (rr.operation == 0)
1478 yaz_add_sru_update_diagnostic(
1479 assoc->encode, &srw_res->diagnostics,
1480 &srw_res->num_diagnostics,
1481 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1485 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1486 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1487 if (!strcmp( rr.operation, "delete"))
1489 if (srw_req->record && !srw_req->record->recordSchema)
1491 rr.record_schema = odr_strdup(
1493 srw_req->record->recordSchema);
1495 if (srw_req->record)
1497 rr.record_data = odr_strdupn(
1499 srw_req->record->recordData_buf,
1500 srw_req->record->recordData_len );
1502 if (extra && extra->extraRecordData_len)
1504 rr.extra_record_data = odr_strdupn(
1506 extra->extraRecordData_buf,
1507 extra->extraRecordData_len );
1509 if (srw_req->recordId)
1510 rr.record_id = srw_req->recordId;
1511 else if (extra && extra->recordIdentifier)
1512 rr.record_id = extra->recordIdentifier;
1514 else if (!strcmp(rr.operation, "replace"))
1516 if (srw_req->recordId)
1517 rr.record_id = srw_req->recordId;
1518 else if (extra && extra->recordIdentifier)
1519 rr.record_id = extra->recordIdentifier;
1522 yaz_add_sru_update_diagnostic(
1523 assoc->encode, &srw_res->diagnostics,
1524 &srw_res->num_diagnostics,
1525 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1526 "recordIdentifier");
1528 if (!srw_req->record)
1530 yaz_add_sru_update_diagnostic(
1531 assoc->encode, &srw_res->diagnostics,
1532 &srw_res->num_diagnostics,
1533 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1538 if (srw_req->record->recordSchema)
1539 rr.record_schema = odr_strdup(
1540 assoc->encode, srw_req->record->recordSchema);
1541 if (srw_req->record->recordData_len )
1543 rr.record_data = odr_strdupn(assoc->encode,
1544 srw_req->record->recordData_buf,
1545 srw_req->record->recordData_len );
1549 yaz_add_sru_update_diagnostic(
1550 assoc->encode, &srw_res->diagnostics,
1551 &srw_res->num_diagnostics,
1552 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1556 if (extra && extra->extraRecordData_len)
1558 rr.extra_record_data = odr_strdupn(
1560 extra->extraRecordData_buf,
1561 extra->extraRecordData_len );
1564 else if (!strcmp(rr.operation, "insert"))
1566 if (srw_req->recordId)
1567 rr.record_id = srw_req->recordId;
1569 rr.record_id = extra->recordIdentifier;
1571 if (srw_req->record)
1573 if (srw_req->record->recordSchema)
1574 rr.record_schema = odr_strdup(
1575 assoc->encode, srw_req->record->recordSchema);
1577 if (srw_req->record->recordData_len)
1578 rr.record_data = odr_strdupn(
1580 srw_req->record->recordData_buf,
1581 srw_req->record->recordData_len );
1583 if (extra && extra->extraRecordData_len)
1585 rr.extra_record_data = odr_strdupn(
1587 extra->extraRecordData_buf,
1588 extra->extraRecordData_len );
1592 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1593 &srw_res->num_diagnostics,
1594 YAZ_SRU_UPDATE_INVALID_ACTION,
1597 if (srw_req->record)
1599 const char *pack_str =
1600 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1602 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1605 if (srw_req->num_recordVersions)
1607 rr.record_versions = srw_req->recordVersions;
1608 rr.num_versions = srw_req->num_recordVersions;
1610 if (srw_req->extraRequestData_len)
1612 rr.extra_request_data = odr_strdupn(assoc->encode,
1613 srw_req->extraRequestData_buf,
1614 srw_req->extraRequestData_len );
1616 if (srw_res->num_diagnostics == 0)
1618 if ( assoc->init->bend_srw_update)
1619 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1621 yaz_add_sru_update_diagnostic(
1622 assoc->encode, &srw_res->diagnostics,
1623 &srw_res->num_diagnostics,
1624 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1625 "No Update backend handler");
1629 yaz_add_srw_diagnostic_uri(assoc->encode,
1630 &srw_res->diagnostics,
1631 &srw_res->num_diagnostics,
1635 srw_res->recordId = rr.record_id;
1636 srw_res->operationStatus = rr.operation_status;
1637 srw_res->recordVersions = rr.record_versions;
1638 srw_res->num_recordVersions = rr.num_versions;
1639 if (srw_res->extraResponseData_len)
1641 srw_res->extraResponseData_buf = rr.extra_response_data;
1642 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1644 if (srw_res->num_diagnostics == 0 && rr.record_data)
1646 srw_res->record = yaz_srw_get_record(assoc->encode);
1647 srw_res->record->recordSchema = rr.record_schema;
1648 if (rr.record_packing)
1650 int pack = yaz_srw_str_to_pack(rr.record_packing);
1654 pack = Z_SRW_recordPacking_string;
1655 yaz_log(YLOG_WARN, "Back packing %s from backend",
1658 srw_res->record->recordPacking = pack;
1660 srw_res->record->recordData_buf = rr.record_data;
1661 srw_res->record->recordData_len = strlen(rr.record_data);
1662 if (rr.extra_record_data)
1664 Z_SRW_extra_record *ex =
1665 yaz_srw_get_extra_record(assoc->encode);
1666 srw_res->extra_record = ex;
1667 ex->extraRecordData_buf = rr.extra_record_data;
1668 ex->extraRecordData_len = strlen(rr.extra_record_data);
1674 /* check if path is OK (1); BAD (0) */
1675 static int check_path(const char *path)
1679 if (strstr(path, ".."))
1684 static char *read_file(const char *fname, ODR o, int *sz)
1687 FILE *inf = fopen(fname, "rb");
1691 fseek(inf, 0L, SEEK_END);
1694 buf = odr_malloc(o, *sz);
1695 fread(buf, 1, *sz, inf);
1700 static void process_http_request(association *assoc, request *req)
1702 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1703 ODR o = assoc->encode;
1704 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1706 Z_SOAP *soap_package = 0;
1709 Z_HTTP_Response *hres = 0;
1711 const char *stylesheet = 0; /* for now .. set later */
1712 Z_SRW_diagnostic *diagnostic = 0;
1713 int num_diagnostic = 0;
1714 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1716 if (!control_association(assoc, host, 0))
1718 p = z_get_HTTP_Response(o, 404);
1721 if (r == 2 && assoc->server && assoc->server->docpath
1722 && hreq->path[0] == '/'
1724 /* check if path is a proper prefix of documentroot */
1725 strncmp(hreq->path+1, assoc->server->docpath,
1726 strlen(assoc->server->docpath))
1729 if (!check_path(hreq->path))
1731 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1732 p = z_get_HTTP_Response(o, 404);
1736 int content_size = 0;
1737 char *content_buf = read_file(hreq->path+1, o, &content_size);
1740 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1741 p = z_get_HTTP_Response(o, 404);
1745 const char *ctype = 0;
1746 yaz_mime_types types = yaz_mime_types_create();
1748 yaz_mime_types_add(types, "xsl", "application/xml");
1749 yaz_mime_types_add(types, "xml", "application/xml");
1750 yaz_mime_types_add(types, "css", "text/css");
1751 yaz_mime_types_add(types, "html", "text/html");
1752 yaz_mime_types_add(types, "htm", "text/html");
1753 yaz_mime_types_add(types, "txt", "text/plain");
1754 yaz_mime_types_add(types, "js", "application/x-javascript");
1756 yaz_mime_types_add(types, "gif", "image/gif");
1757 yaz_mime_types_add(types, "png", "image/png");
1758 yaz_mime_types_add(types, "jpg", "image/jpeg");
1759 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1761 ctype = yaz_mime_lookup_fname(types, hreq->path);
1764 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1765 p = z_get_HTTP_Response(o, 404);
1769 p = z_get_HTTP_Response(o, 200);
1770 hres = p->u.HTTP_Response;
1771 hres->content_buf = content_buf;
1772 hres->content_len = content_size;
1773 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1775 yaz_mime_types_destroy(types);
1783 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1784 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1786 if (r == 2) /* not taken */
1788 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1789 &diagnostic, &num_diagnostic);
1790 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1792 if (r == 0) /* decode SRW/SRU OK .. */
1794 int http_code = 200;
1795 if (sr->which == Z_SRW_searchRetrieve_request)
1798 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1800 stylesheet = sr->u.request->stylesheet;
1803 res->u.response->diagnostics = diagnostic;
1804 res->u.response->num_diagnostics = num_diagnostic;
1808 srw_bend_search(assoc, req, sr, res->u.response,
1811 if (http_code == 200)
1812 soap_package->u.generic->p = res;
1814 else if (sr->which == Z_SRW_explain_request)
1816 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1817 stylesheet = sr->u.explain_request->stylesheet;
1820 res->u.explain_response->diagnostics = diagnostic;
1821 res->u.explain_response->num_diagnostics = num_diagnostic;
1823 srw_bend_explain(assoc, req, sr,
1824 res->u.explain_response, &http_code);
1825 if (http_code == 200)
1826 soap_package->u.generic->p = res;
1828 else if (sr->which == Z_SRW_scan_request)
1830 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1831 stylesheet = sr->u.scan_request->stylesheet;
1834 res->u.scan_response->diagnostics = diagnostic;
1835 res->u.scan_response->num_diagnostics = num_diagnostic;
1837 srw_bend_scan(assoc, req, sr,
1838 res->u.scan_response, &http_code);
1839 if (http_code == 200)
1840 soap_package->u.generic->p = res;
1842 else if (sr->which == Z_SRW_update_request)
1844 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1845 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1848 res->u.update_response->diagnostics = diagnostic;
1849 res->u.update_response->num_diagnostics = num_diagnostic;
1851 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1852 srw_bend_update(assoc, req, sr,
1853 res->u.update_response, &http_code);
1854 if (http_code == 200)
1855 soap_package->u.generic->p = res;
1859 yaz_log(log_request, "SOAP ERROR");
1860 /* FIXME - what error, what query */
1862 z_soap_error(assoc->encode, soap_package,
1863 "SOAP-ENV:Client", "Bad method", 0);
1865 if (http_code == 200 || http_code == 500)
1867 static Z_SOAP_Handler soap_handlers[4] = {
1869 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1870 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1871 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1877 p = z_get_HTTP_Response(o, 200);
1878 hres = p->u.HTTP_Response;
1880 if (!stylesheet && assoc->server)
1881 stylesheet = assoc->server->stylesheet;
1883 /* empty stylesheet means NO stylesheet */
1884 if (stylesheet && *stylesheet == '\0')
1887 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1888 &hres->content_buf, &hres->content_len,
1889 soap_handlers, charset, stylesheet);
1890 hres->code = http_code;
1892 strcpy(ctype, "text/xml");
1895 strcat(ctype, "; charset=");
1896 strcat(ctype, charset);
1898 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1901 p = z_get_HTTP_Response(o, http_code);
1905 p = z_get_HTTP_Response(o, 500);
1906 hres = p->u.HTTP_Response;
1907 if (!strcmp(hreq->version, "1.0"))
1909 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1910 if (v && !strcmp(v, "Keep-Alive"))
1914 hres->version = "1.0";
1918 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1919 if (v && !strcmp(v, "close"))
1923 hres->version = "1.1";
1927 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1928 assoc->state = ASSOC_DEAD;
1929 assoc->cs_get_mask = 0;
1934 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1936 if (alive && isdigit(*(const unsigned char *) alive))
1940 if (t < 0 || t > 3600)
1942 iochan_settimeout(assoc->client_chan,t);
1943 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1945 process_gdu_response(assoc, req, p);
1948 static void process_gdu_request(association *assoc, request *req)
1950 if (req->gdu_request->which == Z_GDU_Z3950)
1953 req->apdu_request = req->gdu_request->u.z3950;
1954 if (process_z_request(assoc, req, &msg) < 0)
1955 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1957 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1958 process_http_request(assoc, req);
1961 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1966 * Initiate request processing.
1968 static int process_z_request(association *assoc, request *req, char **msg)
1974 *msg = "Unknown Error";
1975 assert(req && req->state == REQUEST_IDLE);
1976 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1978 *msg = "Missing InitRequest";
1981 switch (req->apdu_request->which)
1983 case Z_APDU_initRequest:
1984 res = process_initRequest(assoc, req); break;
1985 case Z_APDU_searchRequest:
1986 res = process_searchRequest(assoc, req, &fd); break;
1987 case Z_APDU_presentRequest:
1988 res = process_presentRequest(assoc, req, &fd); break;
1989 case Z_APDU_scanRequest:
1990 if (assoc->init->bend_scan)
1991 res = process_scanRequest(assoc, req, &fd);
1994 *msg = "Cannot handle Scan APDU";
1998 case Z_APDU_extendedServicesRequest:
1999 if (assoc->init->bend_esrequest)
2000 res = process_ESRequest(assoc, req, &fd);
2003 *msg = "Cannot handle Extended Services APDU";
2007 case Z_APDU_sortRequest:
2008 if (assoc->init->bend_sort)
2009 res = process_sortRequest(assoc, req, &fd);
2012 *msg = "Cannot handle Sort APDU";
2017 process_close(assoc, req);
2019 case Z_APDU_deleteResultSetRequest:
2020 if (assoc->init->bend_delete)
2021 res = process_deleteRequest(assoc, req, &fd);
2024 *msg = "Cannot handle Delete APDU";
2028 case Z_APDU_segmentRequest:
2029 if (assoc->init->bend_segment)
2031 res = process_segmentRequest (assoc, req);
2035 *msg = "Cannot handle Segment APDU";
2039 case Z_APDU_triggerResourceControlRequest:
2042 *msg = "Bad APDU received";
2047 yaz_log(YLOG_DEBUG, " result immediately available");
2048 retval = process_z_response(assoc, req, res);
2052 yaz_log(YLOG_DEBUG, " result unavailble");
2055 else /* no result yet - one will be provided later */
2059 /* Set up an I/O handler for the fd supplied by the backend */
2061 yaz_log(YLOG_DEBUG, " establishing handler for result");
2062 req->state = REQUEST_PENDING;
2063 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2065 iochan_setdata(chan, assoc);
2072 * Handle message from the backend.
2074 void backend_response(IOCHAN i, int event)
2076 association *assoc = (association *)iochan_getdata(i);
2077 request *req = request_head(&assoc->incoming);
2081 yaz_log(YLOG_DEBUG, "backend_response");
2082 assert(assoc && req && req->state != REQUEST_IDLE);
2083 /* determine what it is we're waiting for */
2084 switch (req->apdu_request->which)
2086 case Z_APDU_searchRequest:
2087 res = response_searchRequest(assoc, req, 0, &fd); break;
2089 case Z_APDU_presentRequest:
2090 res = response_presentRequest(assoc, req, 0, &fd); break;
2091 case Z_APDU_scanRequest:
2092 res = response_scanRequest(assoc, req, 0, &fd); break;
2095 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2098 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2100 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2101 do_close(assoc, Z_Close_systemProblem, 0);
2105 else if (!res) /* no result yet - try again later */
2107 yaz_log(YLOG_DEBUG, " no result yet");
2108 iochan_setfd(i, fd); /* in case fd has changed */
2113 * Encode response, and transfer the request structure to the outgoing queue.
2115 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2117 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2121 if (!z_GDU(assoc->print, &res, 0, 0))
2122 yaz_log(YLOG_WARN, "ODR print error: %s",
2123 odr_errmsg(odr_geterror(assoc->print)));
2124 odr_reset(assoc->print);
2126 if (!z_GDU(assoc->encode, &res, 0, 0))
2128 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2129 odr_errmsg(odr_geterror(assoc->decode)),
2130 odr_getelement(assoc->decode));
2133 req->response = odr_getbuf(assoc->encode, &req->len_response,
2134 &req->size_response);
2135 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2136 odr_reset(assoc->encode);
2137 req->state = REQUEST_IDLE;
2138 request_enq(&assoc->outgoing, req);
2139 /* turn the work over to the ir_session handler */
2140 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2141 assoc->cs_put_mask = EVENT_OUTPUT;
2142 /* Is there more work to be done? give that to the input handler too */
2145 req = request_head(&assoc->incoming);
2146 if (req && req->state == REQUEST_IDLE)
2148 request_deq(&assoc->incoming);
2149 process_gdu_request(assoc, req);
2158 * Encode response, and transfer the request structure to the outgoing queue.
2160 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2162 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2163 gres->which = Z_GDU_Z3950;
2164 gres->u.z3950 = res;
2166 return process_gdu_response(assoc, req, gres);
2169 static char *get_vhost(Z_OtherInformation *otherInfo)
2171 return yaz_oi_get_string_oidval(&otherInfo, VAL_PROXY, 1, 0);
2175 * Handle init request.
2176 * At the moment, we don't check the options
2177 * anywhere else in the code - we just try not to do anything that would
2178 * break a naive client. We'll toss 'em into the association block when
2179 * we need them there.
2181 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2183 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2184 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2185 Z_InitResponse *resp = apdu->u.initResponse;
2186 bend_initresult *binitres;
2189 statserv_options_block *cb = 0; /* by default no control for backend */
2191 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2192 cb = statserv_getcontrol(); /* got control block for backend */
2194 if (cb && assoc->backend)
2195 (*cb->bend_close)(assoc->backend);
2197 yaz_log(log_requestdetail, "Got initRequest");
2198 if (req->implementationId)
2199 yaz_log(log_requestdetail, "Id: %s",
2200 req->implementationId);
2201 if (req->implementationName)
2202 yaz_log(log_requestdetail, "Name: %s",
2203 req->implementationName);
2204 if (req->implementationVersion)
2205 yaz_log(log_requestdetail, "Version: %s",
2206 req->implementationVersion);
2208 assoc_init_reset(assoc);
2210 assoc->init->auth = req->idAuthentication;
2211 assoc->init->referenceId = req->referenceId;
2213 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2215 Z_CharSetandLanguageNegotiation *negotiation =
2216 yaz_get_charneg_record (req->otherInfo);
2218 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2219 assoc->init->charneg_request = negotiation;
2225 if (req->implementationVersion)
2226 yaz_log(log_requestdetail, "Config: %s",
2229 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2231 /* we have a backend control block, so call that init function */
2232 if (!(binitres = (*cb->bend_init)(assoc->init)))
2234 yaz_log(YLOG_WARN, "Bad response from backend.");
2237 assoc->backend = binitres->handle;
2241 /* no backend. return error */
2242 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2243 binitres->errstring = 0;
2244 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2245 iochan_settimeout(assoc->client_chan, 10);
2247 if ((assoc->init->bend_sort))
2248 yaz_log (YLOG_DEBUG, "Sort handler installed");
2249 if ((assoc->init->bend_search))
2250 yaz_log (YLOG_DEBUG, "Search handler installed");
2251 if ((assoc->init->bend_present))
2252 yaz_log (YLOG_DEBUG, "Present handler installed");
2253 if ((assoc->init->bend_esrequest))
2254 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2255 if ((assoc->init->bend_delete))
2256 yaz_log (YLOG_DEBUG, "Delete handler installed");
2257 if ((assoc->init->bend_scan))
2258 yaz_log (YLOG_DEBUG, "Scan handler installed");
2259 if ((assoc->init->bend_segment))
2260 yaz_log (YLOG_DEBUG, "Segment handler installed");
2262 resp->referenceId = req->referenceId;
2264 /* let's tell the client what we can do */
2265 if (ODR_MASK_GET(req->options, Z_Options_search))
2267 ODR_MASK_SET(resp->options, Z_Options_search);
2268 strcat(options, "srch");
2270 if (ODR_MASK_GET(req->options, Z_Options_present))
2272 ODR_MASK_SET(resp->options, Z_Options_present);
2273 strcat(options, " prst");
2275 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2276 assoc->init->bend_delete)
2278 ODR_MASK_SET(resp->options, Z_Options_delSet);
2279 strcat(options, " del");
2281 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2282 assoc->init->bend_esrequest)
2284 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2285 strcat (options, " extendedServices");
2287 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2289 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2290 strcat(options, " namedresults");
2292 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2294 ODR_MASK_SET(resp->options, Z_Options_scan);
2295 strcat(options, " scan");
2297 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2299 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2300 strcat(options, " concurrop");
2302 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2304 ODR_MASK_SET(resp->options, Z_Options_sort);
2305 strcat(options, " sort");
2308 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
2309 && assoc->init->charneg_response)
2311 Z_OtherInformation **p;
2312 Z_OtherInformationUnit *p0;
2314 yaz_oi_APDU(apdu, &p);
2316 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2317 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2319 p0->which = Z_OtherInfo_externallyDefinedInfo;
2320 p0->information.externallyDefinedInfo =
2321 assoc->init->charneg_response;
2323 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2324 strcat(options, " negotiation");
2327 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2328 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2330 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2332 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2333 assoc->version = 1; /* 1 & 2 are equivalent */
2335 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2337 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2340 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2342 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2346 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2348 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2349 assoc->maximumRecordSize = *req->maximumRecordSize;
2351 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2352 assoc->preferredMessageSize = *req->preferredMessageSize;
2354 resp->preferredMessageSize = &assoc->preferredMessageSize;
2355 resp->maximumRecordSize = &assoc->maximumRecordSize;
2357 resp->implementationId = odr_prepend(assoc->encode,
2358 assoc->init->implementation_id,
2359 resp->implementationId);
2361 resp->implementationName = odr_prepend(assoc->encode,
2362 assoc->init->implementation_name,
2363 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2365 version = odr_strdup(assoc->encode, "$Revision: 1.109 $");
2366 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2367 version[strlen(version)-2] = '\0';
2368 resp->implementationVersion = odr_prepend(assoc->encode,
2369 assoc->init->implementation_version,
2370 odr_prepend(assoc->encode, &version[11],
2371 resp->implementationVersion));
2373 if (binitres->errcode)
2375 assoc->state = ASSOC_DEAD;
2376 resp->userInformationField =
2377 init_diagnostics(assoc->encode, binitres->errcode,
2378 binitres->errstring);
2383 if (!req->idAuthentication)
2384 yaz_log(log_request, "Auth none");
2385 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2387 const char *open = req->idAuthentication->u.open;
2388 const char *slash = strchr(open, '/');
2394 yaz_log(log_request, "Auth open %.*s", len, open);
2396 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2398 const char *user = req->idAuthentication->u.idPass->userId;
2399 const char *group = req->idAuthentication->u.idPass->groupId;
2400 yaz_log(log_request, "Auth idPass %s %s",
2401 user ? user : "-", group ? group : "-");
2403 else if (req->idAuthentication->which
2404 == Z_IdAuthentication_anonymous)
2406 yaz_log(log_request, "Auth anonymous");
2410 yaz_log(log_request, "Auth other");
2415 WRBUF wr = wrbuf_alloc();
2416 wrbuf_printf(wr, "Init ");
2417 if (binitres->errcode)
2418 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2420 wrbuf_printf(wr, "OK -");
2421 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2422 (req->implementationId ? req->implementationId :"-"),
2423 (req->implementationName ?
2424 req->implementationName : "-"),
2425 (req->implementationVersion ?
2426 req->implementationVersion : "-")
2428 yaz_log(log_request, "%s", wrbuf_buf(wr));
2435 * Set the specified `errcode' and `errstring' into a UserInfo-1
2436 * external to be returned to the client in accordance with Z35.90
2437 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2438 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2440 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2442 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2443 addinfo ? " -- " : "", addinfo ? addinfo : "");
2444 return zget_init_diagnostics(odr, error, addinfo);
2448 * nonsurrogate diagnostic record.
2450 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2452 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2454 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2455 addinfo ? " -- " : "", addinfo ? addinfo : "");
2457 rec->which = Z_Records_NSD;
2458 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2464 * surrogate diagnostic.
2466 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2468 int error, const char *addinfo)
2470 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2471 addinfo ? " -- " : "", addinfo ? addinfo : "");
2472 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2475 static Z_Records *pack_records(association *a, char *setname, int start,
2476 int *num, Z_RecordComposition *comp,
2477 int *next, int *pres, oid_value format,
2478 Z_ReferenceId *referenceId,
2479 int *oid, int *errcode)
2481 int recno, total_length = 0, toget = *num, dumped_records = 0;
2482 Z_Records *records =
2483 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2484 Z_NamePlusRecordList *reclist =
2485 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2486 Z_NamePlusRecord **list =
2487 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2489 records->which = Z_Records_DBOSD;
2490 records->u.databaseOrSurDiagnostics = reclist;
2491 reclist->num_records = 0;
2492 reclist->records = list;
2493 *pres = Z_PresentStatus_success;
2497 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2498 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2499 a->maximumRecordSize);
2500 for (recno = start; reclist->num_records < toget; recno++)
2503 Z_NamePlusRecord *thisrec;
2504 int this_length = 0;
2506 * we get the number of bytes allocated on the stream before any
2507 * allocation done by the backend - this should give us a reasonable
2508 * idea of the total size of the data so far.
2510 total_length = odr_total(a->encode) - dumped_records;
2516 freq.last_in_set = 0;
2517 freq.setname = setname;
2518 freq.surrogate_flag = 0;
2519 freq.number = recno;
2521 freq.request_format = format;
2522 freq.request_format_raw = oid;
2523 freq.output_format = format;
2524 freq.output_format_raw = 0;
2525 freq.stream = a->encode;
2526 freq.print = a->print;
2527 freq.referenceId = referenceId;
2530 retrieve_fetch(a, &freq);
2532 *next = freq.last_in_set ? 0 : recno + 1;
2534 /* backend should be able to signal whether error is system-wide
2535 or only pertaining to current record */
2538 if (!freq.surrogate_flag)
2541 *pres = Z_PresentStatus_failure;
2542 /* for 'present request out of range',
2543 set addinfo to record position if not set */
2544 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2545 freq.errstring == 0)
2547 sprintf (s, "%d", recno);
2551 *errcode = freq.errcode;
2552 return diagrec(a, freq.errcode, freq.errstring);
2554 reclist->records[reclist->num_records] =
2555 surrogatediagrec(a, freq.basename, freq.errcode,
2557 reclist->num_records++;
2560 if (freq.record == 0) /* no error and no record ? */
2562 *next = 0; /* signal end-of-set and stop */
2566 this_length = freq.len;
2568 this_length = odr_total(a->encode) - total_length - dumped_records;
2569 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2570 this_length, total_length, dumped_records);
2571 if (a->preferredMessageSize > 0 &&
2572 this_length + total_length > a->preferredMessageSize)
2574 /* record is small enough, really */
2575 if (this_length <= a->preferredMessageSize && recno > start)
2577 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2578 *pres = Z_PresentStatus_partial_2;
2581 /* record can only be fetched by itself */
2582 if (this_length < a->maximumRecordSize)
2584 yaz_log(log_requestdetail, " Record > prefmsgsz");
2587 yaz_log(YLOG_DEBUG, " Dropped it");
2588 reclist->records[reclist->num_records] =
2589 surrogatediagrec(a, freq.basename, 16, 0);
2590 reclist->num_records++;
2591 dumped_records += this_length;
2595 else /* too big entirely */
2597 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2598 this_length, a->maximumRecordSize);
2599 reclist->records[reclist->num_records] =
2600 surrogatediagrec(a, freq.basename, 17, 0);
2601 reclist->num_records++;
2602 dumped_records += this_length;
2607 if (!(thisrec = (Z_NamePlusRecord *)
2608 odr_malloc(a->encode, sizeof(*thisrec))))
2611 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2613 thisrec->databaseName = 0;
2614 thisrec->which = Z_NamePlusRecord_databaseRecord;
2616 if (freq.output_format_raw)
2618 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
2619 freq.output_format = ident->value;
2621 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
2622 freq.record, freq.len);
2623 if (!thisrec->u.databaseRecord)
2625 reclist->records[reclist->num_records] = thisrec;
2626 reclist->num_records++;
2628 *num = reclist->num_records;
2632 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2635 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2636 bend_search_rr *bsrr =
2637 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2639 yaz_log(log_requestdetail, "Got SearchRequest.");
2641 bsrr->request = reqb;
2642 bsrr->association = assoc;
2643 bsrr->referenceId = req->referenceId;
2644 save_referenceId (reqb, bsrr->referenceId);
2645 bsrr->srw_sortKeys = 0;
2646 bsrr->srw_setname = 0;
2647 bsrr->srw_setnameIdleTime = 0;
2648 bsrr->estimated_hit_count = 0;
2649 bsrr->partial_resultset = 0;
2651 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2652 if (req->databaseNames)
2655 for (i = 0; i < req->num_databaseNames; i++)
2656 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2659 yaz_log_zquery_level(log_requestdetail,req->query);
2661 if (assoc->init->bend_search)
2663 bsrr->setname = req->resultSetName;
2664 bsrr->replace_set = *req->replaceIndicator;
2665 bsrr->num_bases = req->num_databaseNames;
2666 bsrr->basenames = req->databaseNames;
2667 bsrr->query = req->query;
2668 bsrr->stream = assoc->encode;
2669 nmem_transfer(bsrr->stream->mem, reqb->request_mem);
2670 bsrr->decode = assoc->decode;
2671 bsrr->print = assoc->print;
2674 bsrr->errstring = NULL;
2675 bsrr->search_info = NULL;
2677 if (assoc->server && assoc->server->cql_transform
2678 && req->query->which == Z_Query_type_104
2679 && req->query->u.type_104->which == Z_External_CQL)
2681 /* have a CQL query and a CQL to PQF transform .. */
2683 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2684 assoc->server->cql_transform, bsrr->query);
2686 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2689 (assoc->init->bend_search)(assoc->backend, bsrr);
2690 if (!bsrr->request) /* backend not ready with the search response */
2691 return 0; /* should not be used any more */
2695 /* FIXME - make a diagnostic for it */
2696 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2698 return response_searchRequest(assoc, reqb, bsrr, fd);
2701 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2704 * Prepare a searchresponse based on the backend results. We probably want
2705 * to look at making the fetching of records nonblocking as well, but
2706 * so far, we'll keep things simple.
2707 * If bsrt is null, that means we're called in response to a communications
2708 * event, and we'll have to get the response for ourselves.
2710 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2711 bend_search_rr *bsrt, int *fd)
2713 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2714 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2715 Z_SearchResponse *resp = (Z_SearchResponse *)
2716 odr_malloc (assoc->encode, sizeof(*resp));
2717 int *nulint = odr_intdup (assoc->encode, 0);
2718 int *next = odr_intdup(assoc->encode, 0);
2719 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2720 int returnedrecs = 0;
2722 apdu->which = Z_APDU_searchResponse;
2723 apdu->u.searchResponse = resp;
2724 resp->referenceId = req->referenceId;
2725 resp->additionalSearchInfo = 0;
2726 resp->otherInfo = 0;
2728 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2730 yaz_log(YLOG_FATAL, "Bad result from backend");
2733 else if (bsrt->errcode)
2735 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2736 resp->resultCount = nulint;
2737 resp->numberOfRecordsReturned = nulint;
2738 resp->nextResultSetPosition = nulint;
2739 resp->searchStatus = nulint;
2740 resp->resultSetStatus = none;
2741 resp->presentStatus = 0;
2745 bool_t *sr = odr_intdup(assoc->encode, 1);
2746 int *toget = odr_intdup(assoc->encode, 0);
2747 Z_RecordComposition comp, *compp = 0;
2749 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2752 resp->resultCount = &bsrt->hits;
2754 comp.which = Z_RecordComp_simple;
2755 /* how many records does the user agent want, then? */
2756 if (bsrt->hits <= *req->smallSetUpperBound)
2758 *toget = bsrt->hits;
2759 if ((comp.u.simple = req->smallSetElementSetNames))
2762 else if (bsrt->hits < *req->largeSetLowerBound)
2764 *toget = *req->mediumSetPresentNumber;
2765 if (*toget > bsrt->hits)
2766 *toget = bsrt->hits;
2767 if ((comp.u.simple = req->mediumSetElementSetNames))
2773 if (*toget && !resp->records)
2777 int *presst = odr_intdup(assoc->encode, 0);
2779 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2782 form = prefformat->value;
2784 /* Call bend_present if defined */
2785 if (assoc->init->bend_present)
2787 bend_present_rr *bprr = (bend_present_rr *)
2788 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2789 bprr->setname = req->resultSetName;
2791 bprr->number = *toget;
2792 bprr->format = form;
2794 bprr->referenceId = req->referenceId;
2795 bprr->stream = assoc->encode;
2796 bprr->print = assoc->print;
2797 bprr->request = reqb;
2798 bprr->association = assoc;
2800 bprr->errstring = NULL;
2801 (*assoc->init->bend_present)(assoc->backend, bprr);
2807 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2808 *resp->presentStatus = Z_PresentStatus_failure;
2813 resp->records = pack_records(assoc, req->resultSetName, 1,
2814 toget, compp, next, presst, form, req->referenceId,
2815 req->preferredRecordSyntax, NULL);
2818 resp->numberOfRecordsReturned = toget;
2819 returnedrecs = *toget;
2820 resp->presentStatus = presst;
2824 if (*resp->resultCount)
2826 resp->numberOfRecordsReturned = nulint;
2827 resp->presentStatus = 0;
2829 resp->nextResultSetPosition = next;
2830 resp->searchStatus = sr;
2831 resp->resultSetStatus = 0;
2832 if (bsrt->estimated_hit_count)
2834 resp->resultSetStatus = odr_intdup(assoc->encode,
2835 Z_SearchResponse_estimate);
2837 else if (bsrt->partial_resultset)
2839 resp->resultSetStatus = odr_intdup(assoc->encode,
2840 Z_SearchResponse_subset);
2843 resp->additionalSearchInfo = bsrt->search_info;
2848 WRBUF wr = wrbuf_alloc();
2850 for (i = 0 ; i < req->num_databaseNames; i++){
2852 wrbuf_printf(wr, "+");
2853 wrbuf_printf(wr, req->databaseNames[i]);
2855 wrbuf_printf(wr, " ");
2858 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2860 wrbuf_printf(wr, "OK %d", bsrt->hits);
2861 wrbuf_printf(wr, " %s 1+%d ",
2862 req->resultSetName, returnedrecs);
2863 yaz_query_to_wrbuf(wr, req->query);
2865 yaz_log(log_request, "Search %s", wrbuf_buf(wr));
2872 * Maybe we got a little over-friendly when we designed bend_fetch to
2873 * get only one record at a time. Some backends can optimise multiple-record
2874 * fetches, and at any rate, there is some overhead involved in
2875 * all that selecting and hopping around. Problem is, of course, that the
2876 * frontend can't know ahead of time how many records it'll need to
2877 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2878 * is downright lousy as a bulk data transfer protocol.
2880 * To start with, we'll do the fetching of records from the backend
2881 * in one operation: To save some trips in and out of the event-handler,
2882 * and to simplify the interface to pack_records. At any rate, asynch
2883 * operation is more fun in operations that have an unpredictable execution
2884 * speed - which is normally more true for search than for present.
2886 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2889 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2893 Z_PresentResponse *resp;
2897 const char *errstring = 0;
2899 yaz_log(log_requestdetail, "Got PresentRequest.");
2901 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2904 form = prefformat->value;
2905 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2907 resp->presentStatus = odr_intdup(assoc->encode, 0);
2908 if (assoc->init->bend_present)
2910 bend_present_rr *bprr = (bend_present_rr *)
2911 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2912 bprr->setname = req->resultSetId;
2913 bprr->start = *req->resultSetStartPoint;
2914 bprr->number = *req->numberOfRecordsRequested;
2915 bprr->format = form;
2916 bprr->comp = req->recordComposition;
2917 bprr->referenceId = req->referenceId;
2918 bprr->stream = assoc->encode;
2919 bprr->print = assoc->print;
2920 bprr->request = reqb;
2921 bprr->association = assoc;
2923 bprr->errstring = NULL;
2924 (*assoc->init->bend_present)(assoc->backend, bprr);
2927 return 0; /* should not happen */
2930 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2931 *resp->presentStatus = Z_PresentStatus_failure;
2932 errcode = bprr->errcode;
2933 errstring = bprr->errstring;
2936 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2937 next = odr_intdup(assoc->encode, 0);
2938 num = odr_intdup(assoc->encode, 0);
2940 apdu->which = Z_APDU_presentResponse;
2941 apdu->u.presentResponse = resp;
2942 resp->referenceId = req->referenceId;
2943 resp->otherInfo = 0;
2947 *num = *req->numberOfRecordsRequested;
2949 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2950 num, req->recordComposition, next,
2951 resp->presentStatus,
2952 form, req->referenceId, req->preferredRecordSyntax,
2957 WRBUF wr = wrbuf_alloc();
2958 wrbuf_printf(wr, "Present ");
2960 if (*resp->presentStatus == Z_PresentStatus_failure)
2961 wrbuf_printf(wr, "ERROR %d ", errcode);
2962 else if (*resp->presentStatus == Z_PresentStatus_success)
2963 wrbuf_printf(wr, "OK - ");
2965 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2967 wrbuf_printf(wr, " %s %d+%d ",
2968 req->resultSetId, *req->resultSetStartPoint,
2969 *req->numberOfRecordsRequested);
2970 yaz_log(log_request, "%s", wrbuf_buf(wr) );
2975 resp->numberOfRecordsReturned = num;
2976 resp->nextResultSetPosition = next;
2982 * Scan was implemented rather in a hurry, and with support for only the basic
2983 * elements of the service in the backend API. Suggestions are welcome.
2985 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2987 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2988 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2989 Z_ScanResponse *res = (Z_ScanResponse *)
2990 odr_malloc (assoc->encode, sizeof(*res));
2991 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2992 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2993 Z_ListEntries *ents = (Z_ListEntries *)
2994 odr_malloc (assoc->encode, sizeof(*ents));
2995 Z_DiagRecs *diagrecs_p = NULL;
2997 bend_scan_rr *bsrr = (bend_scan_rr *)
2998 odr_malloc (assoc->encode, sizeof(*bsrr));
2999 struct scan_entry *save_entries;
3001 yaz_log(log_requestdetail, "Got ScanRequest");
3003 apdu->which = Z_APDU_scanResponse;
3004 apdu->u.scanResponse = res;
3005 res->referenceId = req->referenceId;
3007 /* if step is absent, set it to 0 */
3008 res->stepSize = odr_intdup(assoc->encode, 0);
3010 *res->stepSize = *req->stepSize;
3012 res->scanStatus = scanStatus;
3013 res->numberOfEntriesReturned = numberOfEntriesReturned;
3014 res->positionOfTerm = 0;
3015 res->entries = ents;
3016 ents->num_entries = 0;
3017 ents->entries = NULL;
3018 ents->num_nonsurrogateDiagnostics = 0;
3019 ents->nonsurrogateDiagnostics = NULL;
3020 res->attributeSet = 0;
3023 if (req->databaseNames)
3026 for (i = 0; i < req->num_databaseNames; i++)
3027 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
3029 bsrr->scanClause = 0;
3031 bsrr->errstring = 0;
3032 bsrr->num_bases = req->num_databaseNames;
3033 bsrr->basenames = req->databaseNames;
3034 bsrr->num_entries = *req->numberOfTermsRequested;
3035 bsrr->term = req->termListAndStartPoint;
3036 bsrr->referenceId = req->referenceId;
3037 bsrr->stream = assoc->encode;
3038 bsrr->print = assoc->print;
3039 bsrr->step_size = res->stepSize;
3041 /* For YAZ 2.0 and earlier it was the backend handler that
3042 initialized entries (member display_term did not exist)
3043 YAZ 2.0 and later sets 'entries' and initialize all members
3044 including 'display_term'. If YAZ 2.0 or later sees that
3045 entries was modified - we assume that it is an old handler and
3046 that 'display_term' is _not_ set.
3048 if (bsrr->num_entries > 0)
3051 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3053 for (i = 0; i<bsrr->num_entries; i++)
3055 bsrr->entries[i].term = 0;
3056 bsrr->entries[i].occurrences = 0;
3057 bsrr->entries[i].errcode = 0;
3058 bsrr->entries[i].errstring = 0;
3059 bsrr->entries[i].display_term = 0;
3062 save_entries = bsrr->entries; /* save it so we can compare later */
3064 if (req->attributeSet &&
3065 (attset = oid_getentbyoid(req->attributeSet)) &&
3066 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
3067 bsrr->attributeset = attset->value;
3069 bsrr->attributeset = VAL_NONE;
3070 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3071 bsrr->attributeset);
3072 bsrr->term_position = req->preferredPositionInResponse ?
3073 *req->preferredPositionInResponse : 1;
3075 ((int (*)(void *, bend_scan_rr *))
3076 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3079 diagrecs_p = zget_DiagRecs(assoc->encode,
3080 bsrr->errcode, bsrr->errstring);
3084 Z_Entry **tab = (Z_Entry **)
3085 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3087 if (bsrr->status == BEND_SCAN_PARTIAL)
3088 *scanStatus = Z_Scan_partial_5;
3090 *scanStatus = Z_Scan_success;
3091 ents->entries = tab;
3092 ents->num_entries = bsrr->num_entries;
3093 res->numberOfEntriesReturned = &ents->num_entries;
3094 res->positionOfTerm = &bsrr->term_position;
3095 for (i = 0; i < bsrr->num_entries; i++)
3101 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3102 if (bsrr->entries[i].occurrences >= 0)
3104 e->which = Z_Entry_termInfo;
3105 e->u.termInfo = t = (Z_TermInfo *)
3106 odr_malloc(assoc->encode, sizeof(*t));
3107 t->suggestedAttributes = 0;
3109 if (save_entries == bsrr->entries &&
3110 bsrr->entries[i].display_term)
3112 /* the entries was _not_ set by the handler. So it's
3113 safe to test for new member display_term. It is
3116 t->displayTerm = odr_strdup(assoc->encode,
3117 bsrr->entries[i].display_term);
3119 t->alternativeTerm = 0;
3120 t->byAttributes = 0;
3121 t->otherTermInfo = 0;
3122 t->globalOccurrences = &bsrr->entries[i].occurrences;
3123 t->term = (Z_Term *)
3124 odr_malloc(assoc->encode, sizeof(*t->term));
3125 t->term->which = Z_Term_general;
3126 t->term->u.general = o =
3127 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3128 o->buf = (unsigned char *)
3129 odr_malloc(assoc->encode, o->len = o->size =
3130 strlen(bsrr->entries[i].term));
3131 memcpy(o->buf, bsrr->entries[i].term, o->len);
3132 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3133 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3137 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3138 bsrr->entries[i].errcode,
3139 bsrr->entries[i].errstring);
3140 assert (drecs->num_diagRecs == 1);
3141 e->which = Z_Entry_surrogateDiagnostic;
3142 assert (drecs->diagRecs[0]);
3143 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3149 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3150 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3155 WRBUF wr = wrbuf_alloc();
3156 wrbuf_printf(wr, "Scan ");
3157 for (i = 0 ; i < req->num_databaseNames; i++){
3159 wrbuf_printf(wr, "+");
3160 wrbuf_printf(wr, req->databaseNames[i]);
3162 wrbuf_printf(wr, " ");
3165 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3166 wrbuf_printf(wr, " ");
3169 wrbuf_printf(wr, "OK ");
3170 /* else if (*res->scanStatus == Z_Scan_success) */
3171 /* wrbuf_printf(wr, "OK "); */
3173 /* wrbuf_printf(wr, "Partial "); */
3175 if (*res->numberOfEntriesReturned)
3176 wrbuf_printf(wr, "%d - ", *res->numberOfEntriesReturned);
3178 wrbuf_printf(wr, "0 - ");
3180 wrbuf_printf(wr, "%d+%d+%d ",
3181 (req->preferredPositionInResponse ?
3182 *req->preferredPositionInResponse : 1),
3183 *req->numberOfTermsRequested,
3184 (res->stepSize ? *res->stepSize : 1));
3186 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3187 bsrr->attributeset);
3188 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3194 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3198 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3199 Z_SortResponse *res = (Z_SortResponse *)
3200 odr_malloc (assoc->encode, sizeof(*res));
3201 bend_sort_rr *bsrr = (bend_sort_rr *)
3202 odr_malloc (assoc->encode, sizeof(*bsrr));
3204 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3206 yaz_log(log_requestdetail, "Got SortRequest.");
3208 bsrr->num_input_setnames = req->num_inputResultSetNames;
3209 for (i=0;i<req->num_inputResultSetNames;i++)
3210 yaz_log(log_requestdetail, "Input resultset: '%s'",
3211 req->inputResultSetNames[i]);
3212 bsrr->input_setnames = req->inputResultSetNames;
3213 bsrr->referenceId = req->referenceId;
3214 bsrr->output_setname = req->sortedResultSetName;
3215 yaz_log(log_requestdetail, "Output resultset: '%s'",
3216 req->sortedResultSetName);
3217 bsrr->sort_sequence = req->sortSequence;
3218 /*FIXME - dump those sequences too */
3219 bsrr->stream = assoc->encode;
3220 bsrr->print = assoc->print;
3222 bsrr->sort_status = Z_SortResponse_failure;
3224 bsrr->errstring = 0;
3226 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3228 res->referenceId = bsrr->referenceId;
3229 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3230 res->resultSetStatus = 0;
3233 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3234 bsrr->errcode, bsrr->errstring);
3235 res->diagnostics = dr->diagRecs;
3236 res->num_diagnostics = dr->num_diagRecs;
3240 res->num_diagnostics = 0;
3241 res->diagnostics = 0;
3243 res->resultCount = 0;
3246 apdu->which = Z_APDU_sortResponse;
3247 apdu->u.sortResponse = res;
3250 WRBUF wr = wrbuf_alloc();
3251 wrbuf_printf(wr, "Sort ");
3253 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3255 wrbuf_printf(wr, "OK -");
3256 wrbuf_printf(wr, " (");
3257 for (i = 0; i<req->num_inputResultSetNames; i++)
3260 wrbuf_printf(wr, "+");
3261 wrbuf_printf(wr, req->inputResultSetNames[i]);
3263 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3265 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3271 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3275 Z_DeleteResultSetRequest *req =
3276 reqb->apdu_request->u.deleteResultSetRequest;
3277 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3278 odr_malloc (assoc->encode, sizeof(*res));
3279 bend_delete_rr *bdrr = (bend_delete_rr *)
3280 odr_malloc (assoc->encode, sizeof(*bdrr));
3281 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3283 yaz_log(log_requestdetail, "Got DeleteRequest.");
3285 bdrr->num_setnames = req->num_resultSetList;
3286 bdrr->setnames = req->resultSetList;
3287 for (i = 0; i<req->num_resultSetList; i++)
3288 yaz_log(log_requestdetail, "resultset: '%s'",
3289 req->resultSetList[i]);
3290 bdrr->stream = assoc->encode;
3291 bdrr->print = assoc->print;
3292 bdrr->function = *req->deleteFunction;
3293 bdrr->referenceId = req->referenceId;
3295 if (bdrr->num_setnames > 0)
3297 bdrr->statuses = (int*)
3298 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3299 bdrr->num_setnames);
3300 for (i = 0; i < bdrr->num_setnames; i++)
3301 bdrr->statuses[i] = 0;
3303 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3305 res->referenceId = req->referenceId;
3307 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3309 res->deleteListStatuses = 0;
3310 if (bdrr->num_setnames > 0)
3313 res->deleteListStatuses = (Z_ListStatuses *)
3314 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3315 res->deleteListStatuses->num = bdrr->num_setnames;
3316 res->deleteListStatuses->elements =
3318 odr_malloc (assoc->encode,
3319 sizeof(*res->deleteListStatuses->elements) *
3320 bdrr->num_setnames);
3321 for (i = 0; i<bdrr->num_setnames; i++)
3323 res->deleteListStatuses->elements[i] =
3325 odr_malloc (assoc->encode,
3326 sizeof(**res->deleteListStatuses->elements));
3327 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3328 res->deleteListStatuses->elements[i]->id =
3329 odr_strdup (assoc->encode, bdrr->setnames[i]);
3332 res->numberNotDeleted = 0;
3333 res->bulkStatuses = 0;
3334 res->deleteMessage = 0;
3337 apdu->which = Z_APDU_deleteResultSetResponse;
3338 apdu->u.deleteResultSetResponse = res;
3341 WRBUF wr = wrbuf_alloc();
3342 wrbuf_printf(wr, "Delete ");
3343 if (bdrr->delete_status)
3344 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3346 wrbuf_printf(wr, "OK -");
3347 for (i = 0; i<req->num_resultSetList; i++)
3348 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3349 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3355 static void process_close(association *assoc, request *reqb)
3357 Z_Close *req = reqb->apdu_request->u.close;
3358 static char *reasons[] =
3365 "securityViolation",
3372 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3373 reasons[*req->closeReason], req->diagnosticInformation ?
3374 req->diagnosticInformation : "NULL");
3375 if (assoc->version < 3) /* to make do_force respond with close */
3377 do_close_req(assoc, Z_Close_finished,
3378 "Association terminated by client", reqb);
3379 yaz_log(log_request,"Close OK");
3382 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3386 reqb->len_refid = refid->len;
3387 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3388 memcpy (reqb->refid, refid->buf, refid->len);
3392 reqb->len_refid = 0;
3397 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3399 process_z_response (a, req, res);
3402 bend_request bend_request_mk (bend_association a)
3404 request *nreq = request_get (&a->outgoing);
3405 nreq->request_mem = nmem_create ();
3409 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3414 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3415 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3416 id->len = id->size = req->len_refid;
3417 memcpy (id->buf, req->refid, req->len_refid);
3421 void bend_request_destroy (bend_request *req)
3423 nmem_destroy((*req)->request_mem);
3424 request_release(*req);
3428 int bend_backend_respond (bend_association a, bend_request req)
3432 r = process_z_request (a, req, &msg);
3434 yaz_log (YLOG_WARN, "%s", msg);
3438 void bend_request_setdata(bend_request r, void *p)
3443 void *bend_request_getdata(bend_request r)
3445 return r->clientData;
3448 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3450 bend_segment_rr req;
3452 req.segment = reqb->apdu_request->u.segmentRequest;
3453 req.stream = assoc->encode;
3454 req.decode = assoc->decode;
3455 req.print = assoc->print;
3456 req.association = assoc;
3458 (*assoc->init->bend_segment)(assoc->backend, &req);
3463 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3465 bend_esrequest_rr esrequest;
3466 const char *ext_name = "unknown";
3468 Z_ExtendedServicesRequest *req =
3469 reqb->apdu_request->u.extendedServicesRequest;
3470 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3472 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3474 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3475 esrequest.stream = assoc->encode;
3476 esrequest.decode = assoc->decode;
3477 esrequest.print = assoc->print;
3478 esrequest.errcode = 0;
3479 esrequest.errstring = NULL;
3480 esrequest.request = reqb;
3481 esrequest.association = assoc;
3482 esrequest.taskPackage = 0;
3483 esrequest.referenceId = req->referenceId;
3486 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3488 switch(esrequest.esr->taskSpecificParameters->which)
3490 case Z_External_itemOrder:
3491 ext_name = "ItemOrder"; break;
3492 case Z_External_update:
3493 ext_name = "Update"; break;
3494 case Z_External_update0:
3495 ext_name = "Update0"; break;
3496 case Z_External_ESAdmin:
3497 ext_name = "Admin"; break;
3502 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3504 /* If the response is being delayed, return NULL */
3505 if (esrequest.request == NULL)
3508 resp->referenceId = req->referenceId;
3510 if (esrequest.errcode == -1)
3512 /* Backend service indicates request will be processed */
3513 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3514 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3516 else if (esrequest.errcode == 0)
3518 /* Backend service indicates request will be processed */
3519 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3520 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3524 Z_DiagRecs *diagRecs =
3525 zget_DiagRecs(assoc->encode, esrequest.errcode,
3526 esrequest.errstring);
3527 /* Backend indicates error, request will not be processed */
3528 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3529 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3530 resp->num_diagnostics = diagRecs->num_diagRecs;
3531 resp->diagnostics = diagRecs->diagRecs;
3534 WRBUF wr = wrbuf_alloc();
3535 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3536 yaz_log(log_request, "EsRequest %s", wrbuf_buf(wr) );
3541 /* Do something with the members of bend_extendedservice */
3542 if (esrequest.taskPackage)
3543 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
3544 (const char *) esrequest.taskPackage,
3546 yaz_log(YLOG_DEBUG,"Send the result apdu");
3550 int bend_assoc_is_alive(bend_association assoc)
3552 if (assoc->state == ASSOC_DEAD)
3553 return 0; /* already marked as dead. Don't check I/O chan anymore */
3555 return iochan_is_alive(assoc->client_chan);
3562 * indent-tabs-mode: nil
3564 * vim: shiftwidth=4 tabstop=8 expandtab