2 * Copyright (C) 1995-2006, Index Data ApS
3 * See the file LICENSE for details.
5 * $Id: seshigh.c,v 1.105 2006-12-04 14:56:55 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.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
888 rr.query->u.type_1 = 0;
890 if (srw_req->query_type == Z_SRW_query_type_cql)
892 if (assoc->server && assoc->server->cql_transform)
894 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
895 assoc->server->cql_transform,
899 yaz_add_srw_diagnostic(assoc->encode,
900 &srw_res->diagnostics,
901 &srw_res->num_diagnostics,
907 /* CQL query to backend. Wrap it - Z39.50 style */
908 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
909 ext->direct_reference = odr_getoidbystr(assoc->decode,
910 "1.2.840.10003.16.2");
911 ext->indirect_reference = 0;
913 ext->which = Z_External_CQL;
914 ext->u.cql = srw_req->query.cql;
916 rr.query->which = Z_Query_type_104;
917 rr.query->u.type_104 = ext;
920 else if (srw_req->query_type == Z_SRW_query_type_pqf)
922 Z_RPNQuery *RPNquery;
923 YAZ_PQF_Parser pqf_parser;
925 pqf_parser = yaz_pqf_create ();
927 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
933 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
934 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
935 code, pqf_msg, (long) off);
936 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
939 rr.query->which = Z_Query_type_1;
940 rr.query->u.type_1 = RPNquery;
942 yaz_pqf_destroy (pqf_parser);
946 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
947 &srw_res->num_diagnostics,
948 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
950 if (rr.query->u.type_1)
952 rr.stream = assoc->encode;
953 rr.decode = assoc->decode;
954 rr.print = assoc->print;
956 if ( srw_req->sort.sortKeys )
957 rr.srw_sortKeys = odr_strdup(assoc->encode,
958 srw_req->sort.sortKeys );
959 rr.association = assoc;
965 yaz_log_zquery_level(log_requestdetail,rr.query);
967 (assoc->init->bend_search)(assoc->backend, &rr);
970 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
976 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
977 yaz_add_srw_diagnostic(assoc->encode,
978 &srw_res->diagnostics,
979 &srw_res->num_diagnostics,
980 srw_error, rr.errstring);
985 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
986 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
988 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
989 start, number, rr.hits);
991 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
994 srw_res->resultSetId =
995 odr_strdup(assoc->encode, rr.srw_setname );
996 srw_res->resultSetIdleTime =
997 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1000 if ((rr.hits > 0 && start > rr.hits) || start < 1)
1002 yaz_add_srw_diagnostic(
1004 &srw_res->diagnostics, &srw_res->num_diagnostics,
1005 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1007 else if (number > 0)
1011 if (start + number > rr.hits)
1012 number = rr.hits - start + 1;
1014 /* Call bend_present if defined */
1015 if (assoc->init->bend_present)
1017 bend_present_rr *bprr = (bend_present_rr*)
1018 odr_malloc (assoc->decode, sizeof(*bprr));
1019 bprr->setname = "default";
1020 bprr->start = start;
1021 bprr->number = number;
1022 bprr->format = VAL_TEXT_XML;
1023 if (srw_req->recordSchema)
1025 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1026 sizeof(*bprr->comp));
1027 bprr->comp->which = Z_RecordComp_simple;
1028 bprr->comp->u.simple = (Z_ElementSetNames *)
1029 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1030 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1031 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1037 bprr->stream = assoc->encode;
1038 bprr->referenceId = 0;
1039 bprr->print = assoc->print;
1040 bprr->request = req;
1041 bprr->association = assoc;
1043 bprr->errstring = NULL;
1044 (*assoc->init->bend_present)(assoc->backend, bprr);
1050 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1051 yaz_add_srw_diagnostic(assoc->encode,
1052 &srw_res->diagnostics,
1053 &srw_res->num_diagnostics,
1054 srw_error, bprr->errstring);
1062 int packing = Z_SRW_recordPacking_string;
1063 if (srw_req->recordPacking){
1064 if (!strcmp(srw_req->recordPacking, "xml"))
1065 packing = Z_SRW_recordPacking_XML;
1066 if (!strcmp(srw_req->recordPacking, "url"))
1067 packing = Z_SRW_recordPacking_URL;
1069 srw_res->records = (Z_SRW_record *)
1070 odr_malloc(assoc->encode,
1071 number * sizeof(*srw_res->records));
1073 srw_res->extra_records = (Z_SRW_extra_record **)
1074 odr_malloc(assoc->encode,
1075 number*sizeof(*srw_res->extra_records));
1077 for (i = 0; i<number; i++)
1080 const char *addinfo = 0;
1082 srw_res->records[j].recordPacking = packing;
1083 srw_res->records[j].recordData_buf = 0;
1084 srw_res->extra_records[j] = 0;
1085 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1086 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1087 srw_res->records + j,
1091 yaz_add_srw_diagnostic(assoc->encode,
1092 &srw_res->diagnostics,
1093 &srw_res->num_diagnostics,
1094 yaz_diag_bib1_to_srw (errcode),
1099 if (srw_res->records[j].recordData_buf)
1102 srw_res->num_records = j;
1104 srw_res->records = 0;
1112 const char *querystr = "?";
1113 const char *querytype = "?";
1114 WRBUF wr = wrbuf_alloc();
1116 switch (srw_req->query_type)
1118 case Z_SRW_query_type_cql:
1120 querystr = srw_req->query.cql;
1122 case Z_SRW_query_type_pqf:
1124 querystr = srw_req->query.pqf;
1127 wrbuf_printf(wr, "SRWSearch ");
1128 wrbuf_printf(wr, srw_req->database);
1129 wrbuf_printf(wr, " ");
1130 if (srw_res->num_diagnostics)
1131 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1132 else if (*http_code != 200)
1133 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1134 else if (srw_res->numberOfRecords)
1136 wrbuf_printf(wr, "OK %d",
1137 (srw_res->numberOfRecords ?
1138 *srw_res->numberOfRecords : 0));
1140 wrbuf_printf(wr, " %s %d+%d",
1141 (srw_res->resultSetId ?
1142 srw_res->resultSetId : "-"),
1143 (srw_req->startRecord ? *srw_req->startRecord : 1),
1144 srw_res->num_records);
1145 yaz_log(log_request, "%s %s: %s", wrbuf_buf(wr), querytype, querystr);
1150 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1153 xmlNodePtr ptr = rr->server_node_ptr;
1156 for (ptr = ptr->children; ptr; ptr = ptr->next)
1158 if (ptr->type != XML_ELEMENT_NODE)
1160 if (!strcmp((const char *) ptr->name, "explain"))
1163 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1167 ptr = xmlCopyNode(ptr, 1);
1169 xmlDocSetRootElement(doc, ptr);
1171 xmlDocDumpMemory(doc, &buf_out, &len);
1172 content = (char*) odr_malloc(rr->stream, 1+len);
1173 memcpy(content, buf_out, len);
1174 content[len] = '\0';
1178 rr->explain_buf = content;
1186 static void srw_bend_explain(association *assoc, request *req,
1188 Z_SRW_explainResponse *srw_res,
1191 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1192 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1194 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1199 rr.stream = assoc->encode;
1200 rr.decode = assoc->decode;
1201 rr.print = assoc->print;
1203 rr.database = srw_req->database;
1205 rr.server_node_ptr = assoc->server->server_node_ptr;
1207 rr.server_node_ptr = 0;
1208 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1209 if (assoc->init->bend_explain)
1210 (*assoc->init->bend_explain)(assoc->backend, &rr);
1212 srw_bend_explain_default(assoc->backend, &rr);
1216 int packing = Z_SRW_recordPacking_string;
1217 if (srw_req->recordPacking)
1219 if (!strcmp(srw_req->recordPacking, "xml"))
1220 packing = Z_SRW_recordPacking_XML;
1221 else if (!strcmp(srw_req->recordPacking, "url"))
1222 packing = Z_SRW_recordPacking_URL;
1224 srw_res->record.recordSchema = rr.schema;
1225 srw_res->record.recordPacking = packing;
1226 srw_res->record.recordData_buf = rr.explain_buf;
1227 srw_res->record.recordData_len = strlen(rr.explain_buf);
1228 srw_res->record.recordPosition = 0;
1234 static void srw_bend_scan(association *assoc, request *req,
1236 Z_SRW_scanResponse *srw_res,
1239 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1240 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1243 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1244 if (srw_res->num_diagnostics == 0 && assoc->init)
1246 struct scan_entry *save_entries;
1248 bend_scan_rr *bsrr = (bend_scan_rr *)
1249 odr_malloc (assoc->encode, sizeof(*bsrr));
1250 bsrr->num_bases = 1;
1251 bsrr->basenames = &srw_req->database;
1253 bsrr->num_entries = srw_req->maximumTerms ?
1254 *srw_req->maximumTerms : 10;
1255 bsrr->term_position = srw_req->responsePosition ?
1256 *srw_req->responsePosition : 1;
1259 bsrr->errstring = 0;
1260 bsrr->referenceId = 0;
1261 bsrr->stream = assoc->encode;
1262 bsrr->print = assoc->print;
1263 bsrr->step_size = odr_intdup(assoc->decode, 0);
1266 if (bsrr->num_entries > 0)
1269 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1271 for (i = 0; i<bsrr->num_entries; i++)
1273 bsrr->entries[i].term = 0;
1274 bsrr->entries[i].occurrences = 0;
1275 bsrr->entries[i].errcode = 0;
1276 bsrr->entries[i].errstring = 0;
1277 bsrr->entries[i].display_term = 0;
1280 save_entries = bsrr->entries; /* save it so we can compare later */
1282 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1283 assoc->init->bend_scan)
1285 Odr_oid *scan_attributeSet = 0;
1287 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1289 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1291 srw_req->scanClause.pqf);
1292 if (scan_attributeSet &&
1293 (attset = oid_getentbyoid(scan_attributeSet)) &&
1294 (attset->oclass == CLASS_ATTSET ||
1295 attset->oclass == CLASS_GENERAL))
1296 bsrr->attributeset = attset->value;
1298 bsrr->attributeset = VAL_NONE;
1299 yaz_pqf_destroy(pqf_parser);
1300 bsrr->scanClause = 0;
1301 ((int (*)(void *, bend_scan_rr *))
1302 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1304 else if (srw_req->query_type == Z_SRW_query_type_cql
1305 && assoc->init->bend_scan && assoc->server
1306 && assoc->server->cql_transform)
1309 bsrr->scanClause = 0;
1310 bsrr->attributeset = VAL_NONE;
1311 bsrr->term = odr_malloc(assoc->decode, sizeof(*bsrr->term));
1312 srw_error = cql2pqf_scan(assoc->encode,
1313 srw_req->scanClause.cql,
1314 assoc->server->cql_transform,
1317 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1318 &srw_res->num_diagnostics,
1322 ((int (*)(void *, bend_scan_rr *))
1323 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1326 else if (srw_req->query_type == Z_SRW_query_type_cql
1327 && assoc->init->bend_srw_scan)
1330 bsrr->attributeset = VAL_NONE;
1331 bsrr->scanClause = srw_req->scanClause.cql;
1332 ((int (*)(void *, bend_scan_rr *))
1333 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1337 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1338 &srw_res->num_diagnostics,
1339 YAZ_SRW_UNSUPP_OPERATION, "scan");
1344 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1349 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1351 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1352 &srw_res->num_diagnostics,
1353 srw_error, bsrr->errstring);
1355 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1358 srw_res->terms = (Z_SRW_scanTerm*)
1359 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1362 srw_res->num_terms = bsrr->num_entries;
1363 for (i = 0; i<bsrr->num_entries; i++)
1365 Z_SRW_scanTerm *t = srw_res->terms + i;
1366 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1367 t->numberOfRecords =
1368 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1370 if (save_entries == bsrr->entries &&
1371 bsrr->entries[i].display_term)
1373 /* the entries was _not_ set by the handler. So it's
1374 safe to test for new member display_term. It is
1377 t->displayTerm = odr_strdup(assoc->encode,
1378 bsrr->entries[i].display_term);
1386 WRBUF wr = wrbuf_alloc();
1387 const char *querytype = 0;
1388 const char *querystr = 0;
1390 switch(srw_req->query_type)
1392 case Z_SRW_query_type_pqf:
1394 querystr = srw_req->scanClause.pqf;
1396 case Z_SRW_query_type_cql:
1398 querystr = srw_req->scanClause.cql;
1401 querytype = "UNKNOWN";
1405 wrbuf_printf(wr, "SRWScan ");
1406 wrbuf_printf(wr, srw_req->database);
1407 wrbuf_printf(wr, " ");
1409 if (srw_res->num_diagnostics)
1410 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1411 else if (srw_res->num_terms)
1412 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1414 wrbuf_printf(wr, "OK - - ");
1416 wrbuf_printf(wr, "%d+%d+0 ",
1417 (srw_req->responsePosition ?
1418 *srw_req->responsePosition : 1),
1419 (srw_req->maximumTerms ?
1420 *srw_req->maximumTerms : 1));
1421 /* there is no step size in SRU/W ??? */
1422 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1423 yaz_log(log_request, "%s ", wrbuf_buf(wr) );
1429 static void srw_bend_update(association *assoc, request *req,
1431 Z_SRW_updateResponse *srw_res,
1434 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1435 yaz_log(YLOG_DEBUG, "Got SRW UpdateRequest");
1436 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1438 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1443 rr.stream = assoc->encode;
1444 rr.print = assoc->print;
1446 rr.basenames = &srw_req->database;
1447 rr.operation = srw_req->operation;
1448 rr.operation_status = "failed";
1450 rr.record_version = 0;
1451 rr.record_checksum = 0;
1452 rr.record_old_version = 0;
1453 rr.record_packing = "xml";
1454 rr.record_schema = 0;
1456 rr.request_extra_record = 0;
1457 rr.response_extra_record = 0;
1458 rr.extra_request_data = 0;
1459 rr.extra_response_data = 0;
1464 if ( rr.operation == 0 ){
1465 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1466 &srw_res->num_diagnostics,
1470 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1471 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1472 if ( !strcmp( rr.operation, "delete" ) ){
1473 if ( !srw_req->recordId ){
1474 if ( srw_req->record.recordData_len ){
1475 if ( srw_req->record.recordSchema == 0 ){
1476 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1477 &srw_res->num_diagnostics,
1478 9, "recordSchema" );
1481 rr.record_schema = odr_strdup(assoc->encode,
1482 srw_req->record.recordSchema );
1484 switch (srw_req->record.recordPacking)
1486 case Z_SRW_recordPacking_string:
1487 rr.record_packing = "string";
1489 case Z_SRW_recordPacking_XML:
1490 rr.record_packing = "xml";
1492 case Z_SRW_recordPacking_URL:
1493 rr.record_packing = "url";
1496 rr.record_data = odr_strdupn(assoc->encode,
1497 srw_req->record.recordData_buf,
1498 srw_req->record.recordData_len );
1499 rr.request_extra_record = srw_req->extra_record;
1502 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1503 &srw_res->num_diagnostics,
1504 9, "recordIdentifier OR recordData" );
1508 rr.record_id = srw_req->recordId;
1509 if ( srw_req->record.recordData_len ){
1510 yaz_add_sru_update_diagnostic(assoc->encode,
1511 &srw_res->diagnostics,
1512 &srw_res->num_diagnostics,
1516 if ( srw_req->recordVersion ){
1517 rr.record_version = odr_strdup( assoc->encode,
1518 srw_req->recordVersion );
1521 if ( srw_req->recordOldVersion ){
1522 rr.record_old_version = odr_strdup(assoc->encode,
1523 srw_req->recordOldVersion );
1525 if ( srw_req->extraRequestData ){
1526 rr.extra_request_data = odr_strdup(assoc->encode,
1527 srw_req->extraRequestData );
1530 else if ( !strcmp( rr.operation, "replace" ) ){
1531 if ( !srw_req->recordId ){
1532 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1533 &srw_res->num_diagnostics,
1534 9, "recordIdentifier" );
1537 rr.record_id = srw_req->recordId;
1539 if ( srw_req->record.recordSchema == 0 ){
1540 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1541 &srw_res->num_diagnostics,
1542 9, "recordSchema" );
1545 rr.record_schema = odr_strdup(assoc->encode,
1546 srw_req->record.recordSchema );
1548 switch (srw_req->record.recordPacking)
1550 case Z_SRW_recordPacking_string:
1551 rr.record_packing = "string";
1553 case Z_SRW_recordPacking_XML:
1554 rr.record_packing = "xml";
1556 case Z_SRW_recordPacking_URL:
1557 rr.record_packing = "url";
1560 if ( srw_req->record.recordData_len ){
1561 rr.record_data = odr_strdupn(assoc->encode,
1562 srw_req->record.recordData_buf,
1563 srw_req->record.recordData_len );
1564 rr.request_extra_record = srw_req->extra_record;
1567 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1568 &srw_res->num_diagnostics,
1571 if (srw_req->extraRequestData)
1572 rr.extra_request_data = odr_strdup(assoc->encode,
1573 srw_req->extraRequestData );
1575 else if (!strcmp( rr.operation, "insert" ) ) {
1576 rr.record_id = srw_req->recordId;
1577 if ( srw_req->record.recordSchema == 0 ){
1578 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1579 &srw_res->num_diagnostics,
1580 9, "recordSchema" );
1583 rr.record_schema = odr_strdup(assoc->encode,
1584 srw_req->record.recordSchema);
1586 switch (srw_req->record.recordPacking)
1588 case Z_SRW_recordPacking_string:
1589 rr.record_packing = "string";
1591 case Z_SRW_recordPacking_XML:
1592 rr.record_packing = "xml";
1594 case Z_SRW_recordPacking_URL:
1595 rr.record_packing = "url";
1599 if (srw_req->record.recordData_len)
1601 rr.record_data = odr_strdupn(assoc->encode,
1602 srw_req->record.recordData_buf,
1603 srw_req->record.recordData_len );
1604 rr.request_extra_record = srw_req->extra_record;
1607 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1608 &srw_res->num_diagnostics,
1610 if ( srw_req->extraRequestData )
1611 rr.extra_request_data = odr_strdup(assoc->encode,
1612 srw_req->extraRequestData );
1615 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1616 &srw_res->num_diagnostics,
1617 100, rr.operation );
1619 if (srw_res->num_diagnostics == 0)
1621 if ( assoc->init->bend_srw_update)
1622 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1624 yaz_log( YLOG_WARN, "Got No Update function!");
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->recordVersion = rr.record_version;
1639 srw_res->recordChecksum = rr.record_checksum;
1640 srw_res->extraResponseData = rr.extra_response_data;
1641 srw_res->record.recordPosition = 0;
1642 if (srw_res->num_diagnostics == 0 && rr.record_data)
1644 srw_res->record.recordSchema = rr.record_schema;
1645 srw_res->record.recordPacking = srw_req->record.recordPacking;
1646 srw_res->record.recordData_buf = rr.record_data;
1647 srw_res->record.recordData_len = strlen(rr.record_data);
1648 srw_res->extra_record = rr.response_extra_record;
1652 srw_res->record.recordData_len = 0;
1657 /* check if path is OK (1); BAD (0) */
1658 static int check_path(const char *path)
1662 if (strstr(path, ".."))
1667 static char *read_file(const char *fname, ODR o, int *sz)
1670 FILE *inf = fopen(fname, "rb");
1674 fseek(inf, 0L, SEEK_END);
1677 buf = odr_malloc(o, *sz);
1678 fread(buf, 1, *sz, inf);
1683 static void process_http_request(association *assoc, request *req)
1685 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1686 ODR o = assoc->encode;
1687 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1689 Z_SOAP *soap_package = 0;
1692 Z_HTTP_Response *hres = 0;
1694 const char *stylesheet = 0; /* for now .. set later */
1695 Z_SRW_diagnostic *diagnostic = 0;
1696 int num_diagnostic = 0;
1697 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1699 if (!control_association(assoc, host, 0))
1701 p = z_get_HTTP_Response(o, 404);
1704 if (r == 2 && assoc->server && assoc->server->docpath
1705 && hreq->path[0] == '/'
1707 /* check if path is a proper prefix of documentroot */
1708 strncmp(hreq->path+1, assoc->server->docpath,
1709 strlen(assoc->server->docpath))
1712 if (!check_path(hreq->path))
1714 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1715 p = z_get_HTTP_Response(o, 404);
1719 int content_size = 0;
1720 char *content_buf = read_file(hreq->path+1, o, &content_size);
1723 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1724 p = z_get_HTTP_Response(o, 404);
1728 const char *ctype = 0;
1729 yaz_mime_types types = yaz_mime_types_create();
1731 yaz_mime_types_add(types, "xsl", "application/xml");
1732 yaz_mime_types_add(types, "xml", "application/xml");
1733 yaz_mime_types_add(types, "css", "text/css");
1734 yaz_mime_types_add(types, "html", "text/html");
1735 yaz_mime_types_add(types, "htm", "text/html");
1736 yaz_mime_types_add(types, "txt", "text/plain");
1737 yaz_mime_types_add(types, "js", "application/x-javascript");
1739 yaz_mime_types_add(types, "gif", "image/gif");
1740 yaz_mime_types_add(types, "png", "image/png");
1741 yaz_mime_types_add(types, "jpg", "image/jpeg");
1742 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1744 ctype = yaz_mime_lookup_fname(types, hreq->path);
1747 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1748 p = z_get_HTTP_Response(o, 404);
1752 p = z_get_HTTP_Response(o, 200);
1753 hres = p->u.HTTP_Response;
1754 hres->content_buf = content_buf;
1755 hres->content_len = content_size;
1756 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1758 yaz_mime_types_destroy(types);
1766 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1767 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1769 if (r == 2) /* not taken */
1771 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1772 &diagnostic, &num_diagnostic);
1773 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1775 if (r == 0) /* decode SRW/SRU OK .. */
1777 int http_code = 200;
1778 if (sr->which == Z_SRW_searchRetrieve_request)
1781 yaz_srw_get(assoc->encode, Z_SRW_searchRetrieve_response);
1783 stylesheet = sr->u.request->stylesheet;
1786 res->u.response->diagnostics = diagnostic;
1787 res->u.response->num_diagnostics = num_diagnostic;
1791 srw_bend_search(assoc, req, sr, res->u.response,
1794 if (http_code == 200)
1795 soap_package->u.generic->p = res;
1797 else if (sr->which == Z_SRW_explain_request)
1799 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_explain_response);
1800 stylesheet = sr->u.explain_request->stylesheet;
1803 res->u.explain_response->diagnostics = diagnostic;
1804 res->u.explain_response->num_diagnostics = num_diagnostic;
1806 srw_bend_explain(assoc, req, sr,
1807 res->u.explain_response, &http_code);
1808 if (http_code == 200)
1809 soap_package->u.generic->p = res;
1811 else if (sr->which == Z_SRW_scan_request)
1813 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_scan_response);
1814 stylesheet = sr->u.scan_request->stylesheet;
1817 res->u.scan_response->diagnostics = diagnostic;
1818 res->u.scan_response->num_diagnostics = num_diagnostic;
1820 srw_bend_scan(assoc, req, sr,
1821 res->u.scan_response, &http_code);
1822 if (http_code == 200)
1823 soap_package->u.generic->p = res;
1825 else if (sr->which == Z_SRW_update_request)
1827 Z_SRW_PDU *res = yaz_srw_get(o, Z_SRW_update_response);
1828 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1831 res->u.update_response->diagnostics = diagnostic;
1832 res->u.update_response->num_diagnostics = num_diagnostic;
1834 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1835 srw_bend_update(assoc, req, sr,
1836 res->u.update_response, &http_code);
1837 if (http_code == 200)
1838 soap_package->u.generic->p = res;
1842 yaz_log(log_request, "SOAP ERROR");
1843 /* FIXME - what error, what query */
1845 z_soap_error(assoc->encode, soap_package,
1846 "SOAP-ENV:Client", "Bad method", 0);
1848 if (http_code == 200 || http_code == 500)
1850 static Z_SOAP_Handler soap_handlers[4] = {
1852 {"http://www.loc.gov/zing/srw/", 0,
1853 (Z_SOAP_fun) yaz_srw_codec},
1854 {"http://www.loc.gov/zing/srw/v1.0/", 0,
1855 (Z_SOAP_fun) yaz_srw_codec},
1856 {"http://www.loc.gov/zing/srw/update/", 0,
1857 (Z_SOAP_fun) yaz_ucp_codec},
1863 p = z_get_HTTP_Response(o, 200);
1864 hres = p->u.HTTP_Response;
1866 if (!stylesheet && assoc->server)
1867 stylesheet = assoc->server->stylesheet;
1869 /* empty stylesheet means NO stylesheet */
1870 if (stylesheet && *stylesheet == '\0')
1873 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1874 &hres->content_buf, &hres->content_len,
1875 soap_handlers, charset, stylesheet);
1876 hres->code = http_code;
1878 strcpy(ctype, "text/xml");
1881 strcat(ctype, "; charset=");
1882 strcat(ctype, charset);
1884 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1887 p = z_get_HTTP_Response(o, http_code);
1891 p = z_get_HTTP_Response(o, 500);
1892 hres = p->u.HTTP_Response;
1893 if (!strcmp(hreq->version, "1.0"))
1895 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1896 if (v && !strcmp(v, "Keep-Alive"))
1900 hres->version = "1.0";
1904 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1905 if (v && !strcmp(v, "close"))
1909 hres->version = "1.1";
1913 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1914 assoc->state = ASSOC_DEAD;
1915 assoc->cs_get_mask = 0;
1920 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1922 if (alive && isdigit(*(const unsigned char *) alive))
1926 if (t < 0 || t > 3600)
1928 iochan_settimeout(assoc->client_chan,t);
1929 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1931 process_gdu_response(assoc, req, p);
1934 static void process_gdu_request(association *assoc, request *req)
1936 if (req->gdu_request->which == Z_GDU_Z3950)
1939 req->apdu_request = req->gdu_request->u.z3950;
1940 if (process_z_request(assoc, req, &msg) < 0)
1941 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1943 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1944 process_http_request(assoc, req);
1947 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1952 * Initiate request processing.
1954 static int process_z_request(association *assoc, request *req, char **msg)
1960 *msg = "Unknown Error";
1961 assert(req && req->state == REQUEST_IDLE);
1962 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1964 *msg = "Missing InitRequest";
1967 switch (req->apdu_request->which)
1969 case Z_APDU_initRequest:
1970 res = process_initRequest(assoc, req); break;
1971 case Z_APDU_searchRequest:
1972 res = process_searchRequest(assoc, req, &fd); break;
1973 case Z_APDU_presentRequest:
1974 res = process_presentRequest(assoc, req, &fd); break;
1975 case Z_APDU_scanRequest:
1976 if (assoc->init->bend_scan)
1977 res = process_scanRequest(assoc, req, &fd);
1980 *msg = "Cannot handle Scan APDU";
1984 case Z_APDU_extendedServicesRequest:
1985 if (assoc->init->bend_esrequest)
1986 res = process_ESRequest(assoc, req, &fd);
1989 *msg = "Cannot handle Extended Services APDU";
1993 case Z_APDU_sortRequest:
1994 if (assoc->init->bend_sort)
1995 res = process_sortRequest(assoc, req, &fd);
1998 *msg = "Cannot handle Sort APDU";
2003 process_close(assoc, req);
2005 case Z_APDU_deleteResultSetRequest:
2006 if (assoc->init->bend_delete)
2007 res = process_deleteRequest(assoc, req, &fd);
2010 *msg = "Cannot handle Delete APDU";
2014 case Z_APDU_segmentRequest:
2015 if (assoc->init->bend_segment)
2017 res = process_segmentRequest (assoc, req);
2021 *msg = "Cannot handle Segment APDU";
2025 case Z_APDU_triggerResourceControlRequest:
2028 *msg = "Bad APDU received";
2033 yaz_log(YLOG_DEBUG, " result immediately available");
2034 retval = process_z_response(assoc, req, res);
2038 yaz_log(YLOG_DEBUG, " result unavailble");
2041 else /* no result yet - one will be provided later */
2045 /* Set up an I/O handler for the fd supplied by the backend */
2047 yaz_log(YLOG_DEBUG, " establishing handler for result");
2048 req->state = REQUEST_PENDING;
2049 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2051 iochan_setdata(chan, assoc);
2058 * Handle message from the backend.
2060 void backend_response(IOCHAN i, int event)
2062 association *assoc = (association *)iochan_getdata(i);
2063 request *req = request_head(&assoc->incoming);
2067 yaz_log(YLOG_DEBUG, "backend_response");
2068 assert(assoc && req && req->state != REQUEST_IDLE);
2069 /* determine what it is we're waiting for */
2070 switch (req->apdu_request->which)
2072 case Z_APDU_searchRequest:
2073 res = response_searchRequest(assoc, req, 0, &fd); break;
2075 case Z_APDU_presentRequest:
2076 res = response_presentRequest(assoc, req, 0, &fd); break;
2077 case Z_APDU_scanRequest:
2078 res = response_scanRequest(assoc, req, 0, &fd); break;
2081 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2084 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2086 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2087 do_close(assoc, Z_Close_systemProblem, 0);
2091 else if (!res) /* no result yet - try again later */
2093 yaz_log(YLOG_DEBUG, " no result yet");
2094 iochan_setfd(i, fd); /* in case fd has changed */
2099 * Encode response, and transfer the request structure to the outgoing queue.
2101 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2103 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2107 if (!z_GDU(assoc->print, &res, 0, 0))
2108 yaz_log(YLOG_WARN, "ODR print error: %s",
2109 odr_errmsg(odr_geterror(assoc->print)));
2110 odr_reset(assoc->print);
2112 if (!z_GDU(assoc->encode, &res, 0, 0))
2114 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2115 odr_errmsg(odr_geterror(assoc->decode)),
2116 odr_getelement(assoc->decode));
2119 req->response = odr_getbuf(assoc->encode, &req->len_response,
2120 &req->size_response);
2121 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2122 odr_reset(assoc->encode);
2123 req->state = REQUEST_IDLE;
2124 request_enq(&assoc->outgoing, req);
2125 /* turn the work over to the ir_session handler */
2126 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2127 assoc->cs_put_mask = EVENT_OUTPUT;
2128 /* Is there more work to be done? give that to the input handler too */
2131 req = request_head(&assoc->incoming);
2132 if (req && req->state == REQUEST_IDLE)
2134 yaz_log(YLOG_LOG, "process next request 3");
2135 request_deq(&assoc->incoming);
2136 process_gdu_request(assoc, req);
2145 * Encode response, and transfer the request structure to the outgoing queue.
2147 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2149 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2150 gres->which = Z_GDU_Z3950;
2151 gres->u.z3950 = res;
2153 return process_gdu_response(assoc, req, gres);
2156 static char *get_vhost(Z_OtherInformation *otherInfo)
2158 return yaz_oi_get_string_oidval(&otherInfo, VAL_PROXY, 1, 0);
2162 * Handle init request.
2163 * At the moment, we don't check the options
2164 * anywhere else in the code - we just try not to do anything that would
2165 * break a naive client. We'll toss 'em into the association block when
2166 * we need them there.
2168 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2170 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2171 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2172 Z_InitResponse *resp = apdu->u.initResponse;
2173 bend_initresult *binitres;
2176 statserv_options_block *cb = 0; /* by default no control for backend */
2178 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2179 cb = statserv_getcontrol(); /* got control block for backend */
2181 if (cb && assoc->backend)
2182 (*cb->bend_close)(assoc->backend);
2184 yaz_log(log_requestdetail, "Got initRequest");
2185 if (req->implementationId)
2186 yaz_log(log_requestdetail, "Id: %s",
2187 req->implementationId);
2188 if (req->implementationName)
2189 yaz_log(log_requestdetail, "Name: %s",
2190 req->implementationName);
2191 if (req->implementationVersion)
2192 yaz_log(log_requestdetail, "Version: %s",
2193 req->implementationVersion);
2195 assoc_init_reset(assoc);
2197 assoc->init->auth = req->idAuthentication;
2198 assoc->init->referenceId = req->referenceId;
2200 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2202 Z_CharSetandLanguageNegotiation *negotiation =
2203 yaz_get_charneg_record (req->otherInfo);
2205 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2206 assoc->init->charneg_request = negotiation;
2212 if (req->implementationVersion)
2213 yaz_log(log_requestdetail, "Config: %s",
2216 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2218 /* we have a backend control block, so call that init function */
2219 if (!(binitres = (*cb->bend_init)(assoc->init)))
2221 yaz_log(YLOG_WARN, "Bad response from backend.");
2224 assoc->backend = binitres->handle;
2228 /* no backend. return error */
2229 binitres = odr_malloc(assoc->encode, sizeof(*binitres));
2230 binitres->errstring = 0;
2231 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2232 iochan_settimeout(assoc->client_chan, 10);
2234 if ((assoc->init->bend_sort))
2235 yaz_log (YLOG_DEBUG, "Sort handler installed");
2236 if ((assoc->init->bend_search))
2237 yaz_log (YLOG_DEBUG, "Search handler installed");
2238 if ((assoc->init->bend_present))
2239 yaz_log (YLOG_DEBUG, "Present handler installed");
2240 if ((assoc->init->bend_esrequest))
2241 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2242 if ((assoc->init->bend_delete))
2243 yaz_log (YLOG_DEBUG, "Delete handler installed");
2244 if ((assoc->init->bend_scan))
2245 yaz_log (YLOG_DEBUG, "Scan handler installed");
2246 if ((assoc->init->bend_segment))
2247 yaz_log (YLOG_DEBUG, "Segment handler installed");
2249 resp->referenceId = req->referenceId;
2251 /* let's tell the client what we can do */
2252 if (ODR_MASK_GET(req->options, Z_Options_search))
2254 ODR_MASK_SET(resp->options, Z_Options_search);
2255 strcat(options, "srch");
2257 if (ODR_MASK_GET(req->options, Z_Options_present))
2259 ODR_MASK_SET(resp->options, Z_Options_present);
2260 strcat(options, " prst");
2262 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2263 assoc->init->bend_delete)
2265 ODR_MASK_SET(resp->options, Z_Options_delSet);
2266 strcat(options, " del");
2268 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2269 assoc->init->bend_esrequest)
2271 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2272 strcat (options, " extendedServices");
2274 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2276 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2277 strcat(options, " namedresults");
2279 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2281 ODR_MASK_SET(resp->options, Z_Options_scan);
2282 strcat(options, " scan");
2284 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2286 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2287 strcat(options, " concurrop");
2289 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2291 ODR_MASK_SET(resp->options, Z_Options_sort);
2292 strcat(options, " sort");
2295 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel)
2296 && assoc->init->charneg_response)
2298 Z_OtherInformation **p;
2299 Z_OtherInformationUnit *p0;
2301 yaz_oi_APDU(apdu, &p);
2303 if ((p0=yaz_oi_update(p, assoc->encode, NULL, 0, 0))) {
2304 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2306 p0->which = Z_OtherInfo_externallyDefinedInfo;
2307 p0->information.externallyDefinedInfo =
2308 assoc->init->charneg_response;
2310 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2311 strcat(options, " negotiation");
2314 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2315 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2317 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2319 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2320 assoc->version = 1; /* 1 & 2 are equivalent */
2322 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2324 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2327 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2329 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2333 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2335 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2336 assoc->maximumRecordSize = *req->maximumRecordSize;
2338 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2339 assoc->preferredMessageSize = *req->preferredMessageSize;
2341 resp->preferredMessageSize = &assoc->preferredMessageSize;
2342 resp->maximumRecordSize = &assoc->maximumRecordSize;
2344 resp->implementationId = odr_prepend(assoc->encode,
2345 assoc->init->implementation_id,
2346 resp->implementationId);
2348 resp->implementationName = odr_prepend(assoc->encode,
2349 assoc->init->implementation_name,
2350 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2352 version = odr_strdup(assoc->encode, "$Revision: 1.105 $");
2353 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2354 version[strlen(version)-2] = '\0';
2355 resp->implementationVersion = odr_prepend(assoc->encode,
2356 assoc->init->implementation_version,
2357 odr_prepend(assoc->encode, &version[11],
2358 resp->implementationVersion));
2360 if (binitres->errcode)
2362 assoc->state = ASSOC_DEAD;
2363 resp->userInformationField =
2364 init_diagnostics(assoc->encode, binitres->errcode,
2365 binitres->errstring);
2370 if (!req->idAuthentication)
2371 yaz_log(log_request, "Auth none");
2372 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2374 const char *open = req->idAuthentication->u.open;
2375 const char *slash = strchr(open, '/');
2381 yaz_log(log_request, "Auth open %.*s", len, open);
2383 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2385 const char *user = req->idAuthentication->u.idPass->userId;
2386 const char *group = req->idAuthentication->u.idPass->groupId;
2387 yaz_log(log_request, "Auth idPass %s %s",
2388 user ? user : "-", group ? group : "-");
2390 else if (req->idAuthentication->which
2391 == Z_IdAuthentication_anonymous)
2393 yaz_log(log_request, "Auth anonymous");
2397 yaz_log(log_request, "Auth other");
2402 WRBUF wr = wrbuf_alloc();
2403 wrbuf_printf(wr, "Init ");
2404 if (binitres->errcode)
2405 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2407 wrbuf_printf(wr, "OK -");
2408 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2409 (req->implementationId ? req->implementationId :"-"),
2410 (req->implementationName ?
2411 req->implementationName : "-"),
2412 (req->implementationVersion ?
2413 req->implementationVersion : "-")
2415 yaz_log(log_request, "%s", wrbuf_buf(wr));
2422 * Set the specified `errcode' and `errstring' into a UserInfo-1
2423 * external to be returned to the client in accordance with Z35.90
2424 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2425 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2427 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2429 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2430 addinfo ? " -- " : "", addinfo ? addinfo : "");
2431 return zget_init_diagnostics(odr, error, addinfo);
2435 * nonsurrogate diagnostic record.
2437 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2439 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2441 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2442 addinfo ? " -- " : "", addinfo ? addinfo : "");
2444 rec->which = Z_Records_NSD;
2445 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2451 * surrogate diagnostic.
2453 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2455 int error, const char *addinfo)
2457 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2458 addinfo ? " -- " : "", addinfo ? addinfo : "");
2459 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2462 static Z_Records *pack_records(association *a, char *setname, int start,
2463 int *num, Z_RecordComposition *comp,
2464 int *next, int *pres, oid_value format,
2465 Z_ReferenceId *referenceId,
2466 int *oid, int *errcode)
2468 int recno, total_length = 0, toget = *num, dumped_records = 0;
2469 Z_Records *records =
2470 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2471 Z_NamePlusRecordList *reclist =
2472 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2473 Z_NamePlusRecord **list =
2474 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2476 records->which = Z_Records_DBOSD;
2477 records->u.databaseOrSurDiagnostics = reclist;
2478 reclist->num_records = 0;
2479 reclist->records = list;
2480 *pres = Z_PresentStatus_success;
2484 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2485 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2486 a->maximumRecordSize);
2487 for (recno = start; reclist->num_records < toget; recno++)
2490 Z_NamePlusRecord *thisrec;
2491 int this_length = 0;
2493 * we get the number of bytes allocated on the stream before any
2494 * allocation done by the backend - this should give us a reasonable
2495 * idea of the total size of the data so far.
2497 total_length = odr_total(a->encode) - dumped_records;
2503 freq.last_in_set = 0;
2504 freq.setname = setname;
2505 freq.surrogate_flag = 0;
2506 freq.number = recno;
2508 freq.request_format = format;
2509 freq.request_format_raw = oid;
2510 freq.output_format = format;
2511 freq.output_format_raw = 0;
2512 freq.stream = a->encode;
2513 freq.print = a->print;
2514 freq.referenceId = referenceId;
2517 retrieve_fetch(a, &freq);
2519 *next = freq.last_in_set ? 0 : recno + 1;
2521 /* backend should be able to signal whether error is system-wide
2522 or only pertaining to current record */
2525 if (!freq.surrogate_flag)
2528 *pres = Z_PresentStatus_failure;
2529 /* for 'present request out of range',
2530 set addinfo to record position if not set */
2531 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2532 freq.errstring == 0)
2534 sprintf (s, "%d", recno);
2538 *errcode = freq.errcode;
2539 return diagrec(a, freq.errcode, freq.errstring);
2541 reclist->records[reclist->num_records] =
2542 surrogatediagrec(a, freq.basename, freq.errcode,
2544 reclist->num_records++;
2547 if (freq.record == 0) /* no error and no record ? */
2549 *next = 0; /* signal end-of-set and stop */
2553 this_length = freq.len;
2555 this_length = odr_total(a->encode) - total_length - dumped_records;
2556 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2557 this_length, total_length, dumped_records);
2558 if (a->preferredMessageSize > 0 &&
2559 this_length + total_length > a->preferredMessageSize)
2561 /* record is small enough, really */
2562 if (this_length <= a->preferredMessageSize && recno > start)
2564 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2565 *pres = Z_PresentStatus_partial_2;
2568 /* record can only be fetched by itself */
2569 if (this_length < a->maximumRecordSize)
2571 yaz_log(log_requestdetail, " Record > prefmsgsz");
2574 yaz_log(YLOG_DEBUG, " Dropped it");
2575 reclist->records[reclist->num_records] =
2576 surrogatediagrec(a, freq.basename, 16, 0);
2577 reclist->num_records++;
2578 dumped_records += this_length;
2582 else /* too big entirely */
2584 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2585 this_length, a->maximumRecordSize);
2586 reclist->records[reclist->num_records] =
2587 surrogatediagrec(a, freq.basename, 17, 0);
2588 reclist->num_records++;
2589 dumped_records += this_length;
2594 if (!(thisrec = (Z_NamePlusRecord *)
2595 odr_malloc(a->encode, sizeof(*thisrec))))
2598 thisrec->databaseName = odr_strdup(a->encode, freq.basename);
2600 thisrec->databaseName = 0;
2601 thisrec->which = Z_NamePlusRecord_databaseRecord;
2603 if (freq.output_format_raw)
2605 struct oident *ident = oid_getentbyoid(freq.output_format_raw);
2606 freq.output_format = ident->value;
2608 thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
2609 freq.record, freq.len);
2610 if (!thisrec->u.databaseRecord)
2612 reclist->records[reclist->num_records] = thisrec;
2613 reclist->num_records++;
2615 *num = reclist->num_records;
2619 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2622 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2623 bend_search_rr *bsrr =
2624 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2626 yaz_log(log_requestdetail, "Got SearchRequest.");
2628 bsrr->request = reqb;
2629 bsrr->association = assoc;
2630 bsrr->referenceId = req->referenceId;
2631 save_referenceId (reqb, bsrr->referenceId);
2632 bsrr->srw_sortKeys = 0;
2633 bsrr->srw_setname = 0;
2634 bsrr->srw_setnameIdleTime = 0;
2636 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2637 if (req->databaseNames)
2640 for (i = 0; i < req->num_databaseNames; i++)
2641 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
2644 yaz_log_zquery_level(log_requestdetail,req->query);
2646 if (assoc->init->bend_search)
2648 bsrr->setname = req->resultSetName;
2649 bsrr->replace_set = *req->replaceIndicator;
2650 bsrr->num_bases = req->num_databaseNames;
2651 bsrr->basenames = req->databaseNames;
2652 bsrr->query = req->query;
2653 bsrr->stream = assoc->encode;
2654 nmem_transfer(bsrr->stream->mem, reqb->request_mem);
2655 bsrr->decode = assoc->decode;
2656 bsrr->print = assoc->print;
2659 bsrr->errstring = NULL;
2660 bsrr->search_info = NULL;
2662 if (assoc->server && assoc->server->cql_transform
2663 && req->query->which == Z_Query_type_104
2664 && req->query->u.type_104->which == Z_External_CQL)
2666 /* have a CQL query and a CQL to PQF transform .. */
2668 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2669 assoc->server->cql_transform, bsrr->query);
2671 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2674 (assoc->init->bend_search)(assoc->backend, bsrr);
2675 if (!bsrr->request) /* backend not ready with the search response */
2676 return 0; /* should not be used any more */
2680 /* FIXME - make a diagnostic for it */
2681 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2683 return response_searchRequest(assoc, reqb, bsrr, fd);
2686 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2689 * Prepare a searchresponse based on the backend results. We probably want
2690 * to look at making the fetching of records nonblocking as well, but
2691 * so far, we'll keep things simple.
2692 * If bsrt is null, that means we're called in response to a communications
2693 * event, and we'll have to get the response for ourselves.
2695 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2696 bend_search_rr *bsrt, int *fd)
2698 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2699 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2700 Z_SearchResponse *resp = (Z_SearchResponse *)
2701 odr_malloc (assoc->encode, sizeof(*resp));
2702 int *nulint = odr_intdup (assoc->encode, 0);
2703 bool_t *sr = odr_intdup(assoc->encode, 1);
2704 int *next = odr_intdup(assoc->encode, 0);
2705 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2708 apdu->which = Z_APDU_searchResponse;
2709 apdu->u.searchResponse = resp;
2710 resp->referenceId = req->referenceId;
2711 resp->additionalSearchInfo = 0;
2712 resp->otherInfo = 0;
2714 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2716 yaz_log(YLOG_FATAL, "Bad result from backend");
2719 else if (bsrt->errcode)
2721 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2722 resp->resultCount = nulint;
2723 resp->numberOfRecordsReturned = nulint;
2724 resp->nextResultSetPosition = nulint;
2725 resp->searchStatus = nulint;
2726 resp->resultSetStatus = none;
2727 resp->presentStatus = 0;
2731 int *toget = odr_intdup(assoc->encode, 0);
2732 int *presst = odr_intdup(assoc->encode, 0);
2733 Z_RecordComposition comp, *compp = 0;
2735 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2738 resp->resultCount = &bsrt->hits;
2740 comp.which = Z_RecordComp_simple;
2741 /* how many records does the user agent want, then? */
2742 if (bsrt->hits <= *req->smallSetUpperBound)
2744 *toget = bsrt->hits;
2745 if ((comp.u.simple = req->smallSetElementSetNames))
2748 else if (bsrt->hits < *req->largeSetLowerBound)
2750 *toget = *req->mediumSetPresentNumber;
2751 if (*toget > bsrt->hits)
2752 *toget = bsrt->hits;
2753 if ((comp.u.simple = req->mediumSetElementSetNames))
2759 if (*toget && !resp->records)
2764 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2767 form = prefformat->value;
2769 /* Call bend_present if defined */
2770 if (assoc->init->bend_present)
2772 bend_present_rr *bprr = (bend_present_rr *)
2773 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2774 bprr->setname = req->resultSetName;
2776 bprr->number = *toget;
2777 bprr->format = form;
2779 bprr->referenceId = req->referenceId;
2780 bprr->stream = assoc->encode;
2781 bprr->print = assoc->print;
2782 bprr->request = reqb;
2783 bprr->association = assoc;
2785 bprr->errstring = NULL;
2786 (*assoc->init->bend_present)(assoc->backend, bprr);
2792 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2793 *resp->presentStatus = Z_PresentStatus_failure;
2798 resp->records = pack_records(assoc, req->resultSetName, 1,
2799 toget, compp, next, presst, form, req->referenceId,
2800 req->preferredRecordSyntax, NULL);
2803 resp->numberOfRecordsReturned = toget;
2804 returnedrecs = *toget;
2805 resp->nextResultSetPosition = next;
2806 resp->searchStatus = sr;
2807 resp->resultSetStatus = 0;
2808 resp->presentStatus = presst;
2812 if (*resp->resultCount)
2814 resp->numberOfRecordsReturned = nulint;
2815 resp->nextResultSetPosition = next;
2816 resp->searchStatus = sr;
2817 resp->resultSetStatus = 0;
2818 resp->presentStatus = 0;
2821 resp->additionalSearchInfo = bsrt->search_info;
2826 WRBUF wr = wrbuf_alloc();
2828 for (i = 0 ; i < req->num_databaseNames; i++){
2830 wrbuf_printf(wr, "+");
2831 wrbuf_printf(wr, req->databaseNames[i]);
2833 wrbuf_printf(wr, " ");
2836 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2838 wrbuf_printf(wr, "OK %d", bsrt->hits);
2839 wrbuf_printf(wr, " %s 1+%d ",
2840 req->resultSetName, returnedrecs);
2841 yaz_query_to_wrbuf(wr, req->query);
2843 yaz_log(log_request, "Search %s", wrbuf_buf(wr));
2850 * Maybe we got a little over-friendly when we designed bend_fetch to
2851 * get only one record at a time. Some backends can optimise multiple-record
2852 * fetches, and at any rate, there is some overhead involved in
2853 * all that selecting and hopping around. Problem is, of course, that the
2854 * frontend can't know ahead of time how many records it'll need to
2855 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2856 * is downright lousy as a bulk data transfer protocol.
2858 * To start with, we'll do the fetching of records from the backend
2859 * in one operation: To save some trips in and out of the event-handler,
2860 * and to simplify the interface to pack_records. At any rate, asynch
2861 * operation is more fun in operations that have an unpredictable execution
2862 * speed - which is normally more true for search than for present.
2864 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2867 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2871 Z_PresentResponse *resp;
2875 const char *errstring = 0;
2877 yaz_log(log_requestdetail, "Got PresentRequest.");
2879 if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
2882 form = prefformat->value;
2883 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2885 resp->presentStatus = odr_intdup(assoc->encode, 0);
2886 if (assoc->init->bend_present)
2888 bend_present_rr *bprr = (bend_present_rr *)
2889 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2890 bprr->setname = req->resultSetId;
2891 bprr->start = *req->resultSetStartPoint;
2892 bprr->number = *req->numberOfRecordsRequested;
2893 bprr->format = form;
2894 bprr->comp = req->recordComposition;
2895 bprr->referenceId = req->referenceId;
2896 bprr->stream = assoc->encode;
2897 bprr->print = assoc->print;
2898 bprr->request = reqb;
2899 bprr->association = assoc;
2901 bprr->errstring = NULL;
2902 (*assoc->init->bend_present)(assoc->backend, bprr);
2905 return 0; /* should not happen */
2908 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2909 *resp->presentStatus = Z_PresentStatus_failure;
2910 errcode = bprr->errcode;
2911 errstring = bprr->errstring;
2914 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2915 next = odr_intdup(assoc->encode, 0);
2916 num = odr_intdup(assoc->encode, 0);
2918 apdu->which = Z_APDU_presentResponse;
2919 apdu->u.presentResponse = resp;
2920 resp->referenceId = req->referenceId;
2921 resp->otherInfo = 0;
2925 *num = *req->numberOfRecordsRequested;
2927 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2928 num, req->recordComposition, next,
2929 resp->presentStatus,
2930 form, req->referenceId, req->preferredRecordSyntax,
2935 WRBUF wr = wrbuf_alloc();
2936 wrbuf_printf(wr, "Present ");
2938 if (*resp->presentStatus == Z_PresentStatus_failure)
2939 wrbuf_printf(wr, "ERROR %d ", errcode);
2940 else if (*resp->presentStatus == Z_PresentStatus_success)
2941 wrbuf_printf(wr, "OK - ");
2943 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2945 wrbuf_printf(wr, " %s %d+%d ",
2946 req->resultSetId, *req->resultSetStartPoint,
2947 *req->numberOfRecordsRequested);
2948 yaz_log(log_request, "%s", wrbuf_buf(wr) );
2953 resp->numberOfRecordsReturned = num;
2954 resp->nextResultSetPosition = next;
2960 * Scan was implemented rather in a hurry, and with support for only the basic
2961 * elements of the service in the backend API. Suggestions are welcome.
2963 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2965 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2966 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2967 Z_ScanResponse *res = (Z_ScanResponse *)
2968 odr_malloc (assoc->encode, sizeof(*res));
2969 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2970 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2971 Z_ListEntries *ents = (Z_ListEntries *)
2972 odr_malloc (assoc->encode, sizeof(*ents));
2973 Z_DiagRecs *diagrecs_p = NULL;
2975 bend_scan_rr *bsrr = (bend_scan_rr *)
2976 odr_malloc (assoc->encode, sizeof(*bsrr));
2977 struct scan_entry *save_entries;
2979 yaz_log(log_requestdetail, "Got ScanRequest");
2981 apdu->which = Z_APDU_scanResponse;
2982 apdu->u.scanResponse = res;
2983 res->referenceId = req->referenceId;
2985 /* if step is absent, set it to 0 */
2986 res->stepSize = odr_intdup(assoc->encode, 0);
2988 *res->stepSize = *req->stepSize;
2990 res->scanStatus = scanStatus;
2991 res->numberOfEntriesReturned = numberOfEntriesReturned;
2992 res->positionOfTerm = 0;
2993 res->entries = ents;
2994 ents->num_entries = 0;
2995 ents->entries = NULL;
2996 ents->num_nonsurrogateDiagnostics = 0;
2997 ents->nonsurrogateDiagnostics = NULL;
2998 res->attributeSet = 0;
3001 if (req->databaseNames)
3004 for (i = 0; i < req->num_databaseNames; i++)
3005 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
3007 bsrr->scanClause = 0;
3009 bsrr->errstring = 0;
3010 bsrr->num_bases = req->num_databaseNames;
3011 bsrr->basenames = req->databaseNames;
3012 bsrr->num_entries = *req->numberOfTermsRequested;
3013 bsrr->term = req->termListAndStartPoint;
3014 bsrr->referenceId = req->referenceId;
3015 bsrr->stream = assoc->encode;
3016 bsrr->print = assoc->print;
3017 bsrr->step_size = res->stepSize;
3019 /* For YAZ 2.0 and earlier it was the backend handler that
3020 initialized entries (member display_term did not exist)
3021 YAZ 2.0 and later sets 'entries' and initialize all members
3022 including 'display_term'. If YAZ 2.0 or later sees that
3023 entries was modified - we assume that it is an old handler and
3024 that 'display_term' is _not_ set.
3026 if (bsrr->num_entries > 0)
3029 bsrr->entries = odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3031 for (i = 0; i<bsrr->num_entries; i++)
3033 bsrr->entries[i].term = 0;
3034 bsrr->entries[i].occurrences = 0;
3035 bsrr->entries[i].errcode = 0;
3036 bsrr->entries[i].errstring = 0;
3037 bsrr->entries[i].display_term = 0;
3040 save_entries = bsrr->entries; /* save it so we can compare later */
3042 if (req->attributeSet &&
3043 (attset = oid_getentbyoid(req->attributeSet)) &&
3044 (attset->oclass == CLASS_ATTSET || attset->oclass == CLASS_GENERAL))
3045 bsrr->attributeset = attset->value;
3047 bsrr->attributeset = VAL_NONE;
3048 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3049 bsrr->attributeset);
3050 bsrr->term_position = req->preferredPositionInResponse ?
3051 *req->preferredPositionInResponse : 1;
3053 ((int (*)(void *, bend_scan_rr *))
3054 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3057 diagrecs_p = zget_DiagRecs(assoc->encode,
3058 bsrr->errcode, bsrr->errstring);
3062 Z_Entry **tab = (Z_Entry **)
3063 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3065 if (bsrr->status == BEND_SCAN_PARTIAL)
3066 *scanStatus = Z_Scan_partial_5;
3068 *scanStatus = Z_Scan_success;
3069 ents->entries = tab;
3070 ents->num_entries = bsrr->num_entries;
3071 res->numberOfEntriesReturned = &ents->num_entries;
3072 res->positionOfTerm = &bsrr->term_position;
3073 for (i = 0; i < bsrr->num_entries; i++)
3079 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3080 if (bsrr->entries[i].occurrences >= 0)
3082 e->which = Z_Entry_termInfo;
3083 e->u.termInfo = t = (Z_TermInfo *)
3084 odr_malloc(assoc->encode, sizeof(*t));
3085 t->suggestedAttributes = 0;
3087 if (save_entries == bsrr->entries &&
3088 bsrr->entries[i].display_term)
3090 /* the entries was _not_ set by the handler. So it's
3091 safe to test for new member display_term. It is
3094 t->displayTerm = odr_strdup(assoc->encode,
3095 bsrr->entries[i].display_term);
3097 t->alternativeTerm = 0;
3098 t->byAttributes = 0;
3099 t->otherTermInfo = 0;
3100 t->globalOccurrences = &bsrr->entries[i].occurrences;
3101 t->term = (Z_Term *)
3102 odr_malloc(assoc->encode, sizeof(*t->term));
3103 t->term->which = Z_Term_general;
3104 t->term->u.general = o =
3105 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3106 o->buf = (unsigned char *)
3107 odr_malloc(assoc->encode, o->len = o->size =
3108 strlen(bsrr->entries[i].term));
3109 memcpy(o->buf, bsrr->entries[i].term, o->len);
3110 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3111 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3115 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3116 bsrr->entries[i].errcode,
3117 bsrr->entries[i].errstring);
3118 assert (drecs->num_diagRecs == 1);
3119 e->which = Z_Entry_surrogateDiagnostic;
3120 assert (drecs->diagRecs[0]);
3121 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3127 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3128 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3133 WRBUF wr = wrbuf_alloc();
3134 wrbuf_printf(wr, "Scan ");
3135 for (i = 0 ; i < req->num_databaseNames; i++){
3137 wrbuf_printf(wr, "+");
3138 wrbuf_printf(wr, req->databaseNames[i]);
3140 wrbuf_printf(wr, " ");
3143 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3144 wrbuf_printf(wr, " ");
3147 wrbuf_printf(wr, "OK ");
3148 /* else if (*res->scanStatus == Z_Scan_success) */
3149 /* wrbuf_printf(wr, "OK "); */
3151 /* wrbuf_printf(wr, "Partial "); */
3153 if (*res->numberOfEntriesReturned)
3154 wrbuf_printf(wr, "%d - ", *res->numberOfEntriesReturned);
3156 wrbuf_printf(wr, "0 - ");
3158 wrbuf_printf(wr, "%d+%d+%d ",
3159 (req->preferredPositionInResponse ?
3160 *req->preferredPositionInResponse : 1),
3161 *req->numberOfTermsRequested,
3162 (res->stepSize ? *res->stepSize : 1));
3164 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3165 bsrr->attributeset);
3166 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3172 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3176 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3177 Z_SortResponse *res = (Z_SortResponse *)
3178 odr_malloc (assoc->encode, sizeof(*res));
3179 bend_sort_rr *bsrr = (bend_sort_rr *)
3180 odr_malloc (assoc->encode, sizeof(*bsrr));
3182 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3184 yaz_log(log_requestdetail, "Got SortRequest.");
3186 bsrr->num_input_setnames = req->num_inputResultSetNames;
3187 for (i=0;i<req->num_inputResultSetNames;i++)
3188 yaz_log(log_requestdetail, "Input resultset: '%s'",
3189 req->inputResultSetNames[i]);
3190 bsrr->input_setnames = req->inputResultSetNames;
3191 bsrr->referenceId = req->referenceId;
3192 bsrr->output_setname = req->sortedResultSetName;
3193 yaz_log(log_requestdetail, "Output resultset: '%s'",
3194 req->sortedResultSetName);
3195 bsrr->sort_sequence = req->sortSequence;
3196 /*FIXME - dump those sequences too */
3197 bsrr->stream = assoc->encode;
3198 bsrr->print = assoc->print;
3200 bsrr->sort_status = Z_SortResponse_failure;
3202 bsrr->errstring = 0;
3204 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3206 res->referenceId = bsrr->referenceId;
3207 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3208 res->resultSetStatus = 0;
3211 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3212 bsrr->errcode, bsrr->errstring);
3213 res->diagnostics = dr->diagRecs;
3214 res->num_diagnostics = dr->num_diagRecs;
3218 res->num_diagnostics = 0;
3219 res->diagnostics = 0;
3221 res->resultCount = 0;
3224 apdu->which = Z_APDU_sortResponse;
3225 apdu->u.sortResponse = res;
3228 WRBUF wr = wrbuf_alloc();
3229 wrbuf_printf(wr, "Sort ");
3231 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3233 wrbuf_printf(wr, "OK -");
3234 wrbuf_printf(wr, " (");
3235 for (i = 0; i<req->num_inputResultSetNames; i++)
3238 wrbuf_printf(wr, "+");
3239 wrbuf_printf(wr, req->inputResultSetNames[i]);
3241 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3243 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3249 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3253 Z_DeleteResultSetRequest *req =
3254 reqb->apdu_request->u.deleteResultSetRequest;
3255 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3256 odr_malloc (assoc->encode, sizeof(*res));
3257 bend_delete_rr *bdrr = (bend_delete_rr *)
3258 odr_malloc (assoc->encode, sizeof(*bdrr));
3259 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3261 yaz_log(log_requestdetail, "Got DeleteRequest.");
3263 bdrr->num_setnames = req->num_resultSetList;
3264 bdrr->setnames = req->resultSetList;
3265 for (i = 0; i<req->num_resultSetList; i++)
3266 yaz_log(log_requestdetail, "resultset: '%s'",
3267 req->resultSetList[i]);
3268 bdrr->stream = assoc->encode;
3269 bdrr->print = assoc->print;
3270 bdrr->function = *req->deleteFunction;
3271 bdrr->referenceId = req->referenceId;
3273 if (bdrr->num_setnames > 0)
3275 bdrr->statuses = (int*)
3276 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3277 bdrr->num_setnames);
3278 for (i = 0; i < bdrr->num_setnames; i++)
3279 bdrr->statuses[i] = 0;
3281 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3283 res->referenceId = req->referenceId;
3285 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3287 res->deleteListStatuses = 0;
3288 if (bdrr->num_setnames > 0)
3291 res->deleteListStatuses = (Z_ListStatuses *)
3292 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3293 res->deleteListStatuses->num = bdrr->num_setnames;
3294 res->deleteListStatuses->elements =
3296 odr_malloc (assoc->encode,
3297 sizeof(*res->deleteListStatuses->elements) *
3298 bdrr->num_setnames);
3299 for (i = 0; i<bdrr->num_setnames; i++)
3301 res->deleteListStatuses->elements[i] =
3303 odr_malloc (assoc->encode,
3304 sizeof(**res->deleteListStatuses->elements));
3305 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3306 res->deleteListStatuses->elements[i]->id =
3307 odr_strdup (assoc->encode, bdrr->setnames[i]);
3310 res->numberNotDeleted = 0;
3311 res->bulkStatuses = 0;
3312 res->deleteMessage = 0;
3315 apdu->which = Z_APDU_deleteResultSetResponse;
3316 apdu->u.deleteResultSetResponse = res;
3319 WRBUF wr = wrbuf_alloc();
3320 wrbuf_printf(wr, "Delete ");
3321 if (bdrr->delete_status)
3322 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3324 wrbuf_printf(wr, "OK -");
3325 for (i = 0; i<req->num_resultSetList; i++)
3326 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3327 yaz_log(log_request, "%s", wrbuf_buf(wr) );
3333 static void process_close(association *assoc, request *reqb)
3335 Z_Close *req = reqb->apdu_request->u.close;
3336 static char *reasons[] =
3343 "securityViolation",
3350 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3351 reasons[*req->closeReason], req->diagnosticInformation ?
3352 req->diagnosticInformation : "NULL");
3353 if (assoc->version < 3) /* to make do_force respond with close */
3355 do_close_req(assoc, Z_Close_finished,
3356 "Association terminated by client", reqb);
3357 yaz_log(log_request,"Close OK");
3360 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3364 reqb->len_refid = refid->len;
3365 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3366 memcpy (reqb->refid, refid->buf, refid->len);
3370 reqb->len_refid = 0;
3375 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3377 process_z_response (a, req, res);
3380 bend_request bend_request_mk (bend_association a)
3382 request *nreq = request_get (&a->outgoing);
3383 nreq->request_mem = nmem_create ();
3387 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3392 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3393 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3394 id->len = id->size = req->len_refid;
3395 memcpy (id->buf, req->refid, req->len_refid);
3399 void bend_request_destroy (bend_request *req)
3401 nmem_destroy((*req)->request_mem);
3402 request_release(*req);
3406 int bend_backend_respond (bend_association a, bend_request req)
3410 r = process_z_request (a, req, &msg);
3412 yaz_log (YLOG_WARN, "%s", msg);
3416 void bend_request_setdata(bend_request r, void *p)
3421 void *bend_request_getdata(bend_request r)
3423 return r->clientData;
3426 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3428 bend_segment_rr req;
3430 req.segment = reqb->apdu_request->u.segmentRequest;
3431 req.stream = assoc->encode;
3432 req.decode = assoc->decode;
3433 req.print = assoc->print;
3434 req.association = assoc;
3436 (*assoc->init->bend_segment)(assoc->backend, &req);
3441 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3443 bend_esrequest_rr esrequest;
3444 const char *ext_name = "unknown";
3446 Z_ExtendedServicesRequest *req =
3447 reqb->apdu_request->u.extendedServicesRequest;
3448 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3450 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3452 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3453 esrequest.stream = assoc->encode;
3454 esrequest.decode = assoc->decode;
3455 esrequest.print = assoc->print;
3456 esrequest.errcode = 0;
3457 esrequest.errstring = NULL;
3458 esrequest.request = reqb;
3459 esrequest.association = assoc;
3460 esrequest.taskPackage = 0;
3461 esrequest.referenceId = req->referenceId;
3464 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3466 switch(esrequest.esr->taskSpecificParameters->which)
3468 case Z_External_itemOrder:
3469 ext_name = "ItemOrder"; break;
3470 case Z_External_update:
3471 ext_name = "Update"; break;
3472 case Z_External_update0:
3473 ext_name = "Update0"; break;
3474 case Z_External_ESAdmin:
3475 ext_name = "Admin"; break;
3480 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3482 /* If the response is being delayed, return NULL */
3483 if (esrequest.request == NULL)
3486 resp->referenceId = req->referenceId;
3488 if (esrequest.errcode == -1)
3490 /* Backend service indicates request will be processed */
3491 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3492 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3494 else if (esrequest.errcode == 0)
3496 /* Backend service indicates request will be processed */
3497 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3498 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3502 Z_DiagRecs *diagRecs =
3503 zget_DiagRecs(assoc->encode, esrequest.errcode,
3504 esrequest.errstring);
3505 /* Backend indicates error, request will not be processed */
3506 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3507 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3508 resp->num_diagnostics = diagRecs->num_diagRecs;
3509 resp->diagnostics = diagRecs->diagRecs;
3512 WRBUF wr = wrbuf_alloc();
3513 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3514 yaz_log(log_request, "EsRequest %s", wrbuf_buf(wr) );
3519 /* Do something with the members of bend_extendedservice */
3520 if (esrequest.taskPackage)
3521 resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
3522 (const char *) esrequest.taskPackage,
3524 yaz_log(YLOG_DEBUG,"Send the result apdu");
3528 int bend_assoc_is_alive(bend_association assoc)
3530 if (assoc->state == ASSOC_DEAD)
3531 return 0; /* already marked as dead. Don't check I/O chan anymore */
3533 return iochan_is_alive(assoc->client_chan);
3540 * indent-tabs-mode: nil
3542 * vim: shiftwidth=4 tabstop=8 expandtab