1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2009 Index Data
3 * See the file LICENSE for details.
7 * \brief Implements GFS session logic.
9 * Frontend server logic.
11 * This code receives incoming APDUs, and handles client requests by means
14 * Some of the code is getting quite involved, compared to simpler servers -
15 * primarily because it is asynchronous both in the communication with
16 * the user and the backend. We think the complexity will pay off in
17 * the form of greater flexibility when more asynchronous facilities
20 * Memory management has become somewhat involved. In the simple case, where
21 * only one PDU is pending at a time, it will simply reuse the same memory,
22 * once it has found its working size. When we enable multiple concurrent
23 * operations, perhaps even with multiple parallel calls to the backend, it
24 * will maintain a pool of buffers for encoding and decoding, trying to
25 * minimize memory allocation/deallocation during normal operation.
35 #include <sys/types.h>
43 #define S_ISREG(x) (x & _S_IFREG)
52 #include <libxml/parser.h>
53 #include <libxml/tree.h>
56 #include <yaz/yconfig.h>
57 #include <yaz/xmalloc.h>
58 #include <yaz/comstack.h>
62 #include <yaz/proto.h>
63 #include <yaz/oid_db.h>
65 #include <yaz/logrpn.h>
66 #include <yaz/querytowrbuf.h>
67 #include <yaz/statserv.h>
68 #include <yaz/diagbib1.h>
69 #include <yaz/charneg.h>
70 #include <yaz/otherinfo.h>
71 #include <yaz/yaz-util.h>
72 #include <yaz/pquery.h>
73 #include <yaz/oid_db.h>
76 #include <yaz/backend.h>
77 #include <yaz/yaz-ccl.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(log_session, "Timeout. Closing connection");
381 /* do we need to lod this at all */
383 destroy_association(assoc);
388 yaz_log(log_sessiondetail, "Timeout. Sending Z39.50 Close");
389 do_close(assoc, Z_Close_lackOfActivity, 0);
393 if (event & assoc->cs_accept_mask)
395 if (!cs_accept(conn))
397 yaz_log(YLOG_WARN, "accept failed");
398 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->query_charset = 0;
499 assoc->init->records_in_same_charset = 0;
500 assoc->init->bend_sort = NULL;
501 assoc->init->bend_search = NULL;
502 assoc->init->bend_present = NULL;
503 assoc->init->bend_esrequest = NULL;
504 assoc->init->bend_delete = NULL;
505 assoc->init->bend_scan = NULL;
506 assoc->init->bend_segment = NULL;
507 assoc->init->bend_fetch = NULL;
508 assoc->init->bend_explain = NULL;
509 assoc->init->bend_srw_scan = NULL;
510 assoc->init->bend_srw_update = NULL;
511 assoc->init->named_result_sets = 0;
513 assoc->init->charneg_request = NULL;
514 assoc->init->charneg_response = NULL;
516 assoc->init->decode = assoc->decode;
517 assoc->init->peer_name =
518 odr_strdup(assoc->encode, cs_addrstr(assoc->client_link));
520 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
523 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
525 statserv_options_block *cb = statserv_getcontrol();
528 const char *encoding = "UTF-8";
530 bend_initresult *binitres;
532 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
533 assoc_init_reset(assoc);
537 Z_IdAuthentication *auth = (Z_IdAuthentication *)
538 odr_malloc(assoc->decode, sizeof(*auth));
541 len = strlen(sr->username) + 1;
543 len += strlen(sr->password) + 2;
544 auth->which = Z_IdAuthentication_open;
545 auth->u.open = (char *) odr_malloc(assoc->decode, len);
546 strcpy(auth->u.open, sr->username);
547 if (sr->password && *sr->password)
549 strcat(auth->u.open, "/");
550 strcat(auth->u.open, sr->password);
552 assoc->init->auth = auth;
556 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
557 assoc->init->charneg_request = ce->u.charNeg3;
560 if (!(binitres = (*cb->bend_init)(assoc->init)))
562 assoc->state = ASSOC_DEAD;
563 yaz_add_srw_diagnostic(assoc->encode, d, num,
564 YAZ_SRW_AUTHENTICATION_ERROR, 0);
567 assoc->backend = binitres->handle;
568 assoc->init->auth = 0;
569 if (binitres->errcode)
571 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
572 assoc->state = ASSOC_DEAD;
573 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
574 binitres->errstring);
582 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
585 yaz_record_conv_t rc = 0;
586 const char *match_schema = 0;
587 Odr_oid *match_syntax = 0;
592 const char *input_schema = yaz_get_esn(rr->comp);
593 Odr_oid *input_syntax_raw = rr->request_format;
595 const char *backend_schema = 0;
596 Odr_oid *backend_syntax = 0;
598 r = yaz_retrieval_request(assoc->server->retrieval,
606 if (r == -1) /* error ? */
608 const char *details = yaz_retrieval_get_error(
609 assoc->server->retrieval);
611 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
613 rr->errstring = odr_strdup(rr->stream, details);
616 else if (r == 1 || r == 3)
618 const char *details = input_schema;
620 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
622 rr->errstring = odr_strdup(rr->stream, details);
627 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
628 if (input_syntax_raw)
630 char oidbuf[OID_STR_MAX];
631 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
632 rr->errstring = odr_strdup(rr->stream, oidbuf);
638 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
641 rr->request_format = backend_syntax;
643 (*assoc->init->bend_fetch)(assoc->backend, rr);
644 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
645 { /* post conversion must take place .. */
646 WRBUF output_record = wrbuf_alloc();
647 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
650 const char *details = yaz_record_conv_get_error(rc);
651 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
653 rr->errstring = odr_strdup(rr->stream, details);
657 rr->len = wrbuf_len(output_record);
658 rr->record = (char *) odr_malloc(rr->stream, rr->len);
659 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
661 wrbuf_destroy(output_record);
664 rr->output_format = match_syntax;
666 rr->schema = odr_strdup(rr->stream, match_schema);
668 (*assoc->init->bend_fetch)(assoc->backend, rr);
673 static int srw_bend_fetch(association *assoc, int pos,
674 Z_SRW_searchRetrieveRequest *srw_req,
675 Z_SRW_record *record,
676 const char **addinfo)
679 ODR o = assoc->encode;
681 rr.setname = "default";
684 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
686 rr.comp = (Z_RecordComposition *)
687 odr_malloc(assoc->decode, sizeof(*rr.comp));
688 rr.comp->which = Z_RecordComp_complex;
689 rr.comp->u.complex = (Z_CompSpec *)
690 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
691 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
692 odr_malloc(assoc->encode, sizeof(bool_t));
693 *rr.comp->u.complex->selectAlternativeSyntax = 0;
694 rr.comp->u.complex->num_dbSpecific = 0;
695 rr.comp->u.complex->dbSpecific = 0;
696 rr.comp->u.complex->num_recordSyntax = 0;
697 rr.comp->u.complex->recordSyntax = 0;
699 rr.comp->u.complex->generic = (Z_Specification *)
700 odr_malloc(assoc->decode, sizeof(Z_Specification));
702 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
703 rr.comp->u.complex->generic->which = Z_Schema_uri;
704 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
706 /* ESN = recordSchema if recordSchema is present */
707 rr.comp->u.complex->generic->elementSpec = 0;
708 if (srw_req->recordSchema)
710 rr.comp->u.complex->generic->elementSpec =
711 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
712 rr.comp->u.complex->generic->elementSpec->which =
713 Z_ElementSpec_elementSetName;
714 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
715 srw_req->recordSchema;
718 rr.stream = assoc->encode;
719 rr.print = assoc->print;
727 rr.surrogate_flag = 0;
728 rr.schema = srw_req->recordSchema;
730 if (!assoc->init->bend_fetch)
733 retrieve_fetch(assoc, &rr);
735 if (rr.errcode && rr.surrogate_flag)
737 int code = yaz_diag_bib1_to_srw(rr.errcode);
738 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
741 else if (rr.len >= 0)
743 record->recordData_buf = rr.record;
744 record->recordData_len = rr.len;
745 record->recordPosition = odr_intdup(o, pos);
746 record->recordSchema = odr_strdup_null(
747 o, rr.schema ? rr.schema : srw_req->recordSchema);
751 *addinfo = rr.errstring;
757 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
758 Z_Query *query_result)
760 /* have a CQL query and CQL to PQF transform .. */
761 CQL_parser cp = cql_parser_create();
767 r = cql_parser_string(cp, cql);
770 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
775 r = cql_transform_buf(ct,
776 cql_parser_result(cp),
777 rpn_buf, sizeof(rpn_buf)-1);
779 srw_errcode = cql_transform_error(ct, &add);
783 /* Syntax & transform OK. */
784 /* Convert PQF string to Z39.50 to RPN query struct */
785 YAZ_PQF_Parser pp = yaz_pqf_create();
786 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
791 int code = yaz_pqf_error(pp, &pqf_msg, &off);
792 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
794 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
798 query_result->which = Z_Query_type_1;
799 query_result->u.type_1 = rpnquery;
803 cql_parser_destroy(cp);
807 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
808 Z_AttributesPlusTerm *result)
812 int srw_error = cql2pqf(odr, cql, ct, &query);
815 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
816 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
817 rpn = query.u.type_1;
818 if (!rpn->RPNStructure)
819 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
820 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
821 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
822 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
823 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
824 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
830 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
831 bend_search_rr *bsrr) {
833 struct ccl_rpn_node *node;
836 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
837 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0) {
838 bsrr->errstring = (char*) ccl_err_msg(errcode);
839 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
842 bsrr->query->which = Z_Query_type_1;
843 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
848 static void srw_bend_search(association *assoc, request *req,
853 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
856 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
859 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
860 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
861 if (srw_res->num_diagnostics == 0 && assoc->init)
864 rr.setname = "default";
867 rr.basenames = &srw_req->database;
871 rr.srw_setnameIdleTime = 0;
872 rr.estimated_hit_count = 0;
873 rr.partial_resultset = 0;
874 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
875 rr.query->u.type_1 = 0;
876 rr.extra_args = sr->extra_args;
877 rr.extra_response_data = 0;
879 if (srw_req->query_type == Z_SRW_query_type_cql)
881 if (assoc->server && assoc->server->cql_transform)
883 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
884 assoc->server->cql_transform,
888 yaz_add_srw_diagnostic(assoc->encode,
889 &srw_res->diagnostics,
890 &srw_res->num_diagnostics,
896 /* CQL query to backend. Wrap it - Z39.50 style */
897 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
898 ext->direct_reference = odr_getoidbystr(assoc->decode,
899 "1.2.840.10003.16.2");
900 ext->indirect_reference = 0;
902 ext->which = Z_External_CQL;
903 ext->u.cql = srw_req->query.cql;
905 rr.query->which = Z_Query_type_104;
906 rr.query->u.type_104 = ext;
909 else if (srw_req->query_type == Z_SRW_query_type_pqf)
911 Z_RPNQuery *RPNquery;
912 YAZ_PQF_Parser pqf_parser;
914 pqf_parser = yaz_pqf_create();
916 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
922 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
923 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
924 code, pqf_msg, (long) off);
925 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
928 rr.query->which = Z_Query_type_1;
929 rr.query->u.type_1 = RPNquery;
931 yaz_pqf_destroy(pqf_parser);
935 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
936 &srw_res->num_diagnostics,
937 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
939 if (rr.query->u.type_1)
941 rr.stream = assoc->encode;
942 rr.decode = assoc->decode;
943 rr.print = assoc->print;
945 if ( srw_req->sort.sortKeys )
946 rr.srw_sortKeys = odr_strdup(assoc->encode,
947 srw_req->sort.sortKeys );
948 rr.association = assoc;
954 yaz_log_zquery_level(log_requestdetail,rr.query);
956 (assoc->init->bend_search)(assoc->backend, &rr);
959 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
965 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
966 yaz_add_srw_diagnostic(assoc->encode,
967 &srw_res->diagnostics,
968 &srw_res->num_diagnostics,
969 srw_error, rr.errstring);
974 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
975 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
977 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
979 start, number, rr.hits);
981 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
984 srw_res->resultSetId =
985 odr_strdup(assoc->encode, rr.srw_setname );
986 srw_res->resultSetIdleTime =
987 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
990 if (start > rr.hits || start < 1)
992 /* if hits<=0 and start=1 we don't return a diagnostic */
994 yaz_add_srw_diagnostic(
996 &srw_res->diagnostics, &srw_res->num_diagnostics,
997 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1003 if (start + number > rr.hits)
1004 number = rr.hits - start + 1;
1006 /* Call bend_present if defined */
1007 if (assoc->init->bend_present)
1009 bend_present_rr *bprr = (bend_present_rr*)
1010 odr_malloc(assoc->decode, sizeof(*bprr));
1011 bprr->setname = "default";
1012 bprr->start = start;
1013 bprr->number = number;
1014 if (srw_req->recordSchema)
1016 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1017 sizeof(*bprr->comp));
1018 bprr->comp->which = Z_RecordComp_simple;
1019 bprr->comp->u.simple = (Z_ElementSetNames *)
1020 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1021 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1022 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1028 bprr->stream = assoc->encode;
1029 bprr->referenceId = 0;
1030 bprr->print = assoc->print;
1031 bprr->request = req;
1032 bprr->association = assoc;
1034 bprr->errstring = NULL;
1035 (*assoc->init->bend_present)(assoc->backend, bprr);
1041 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1042 yaz_add_srw_diagnostic(assoc->encode,
1043 &srw_res->diagnostics,
1044 &srw_res->num_diagnostics,
1045 srw_error, bprr->errstring);
1053 int packing = Z_SRW_recordPacking_string;
1054 if (srw_req->recordPacking)
1057 yaz_srw_str_to_pack(srw_req->recordPacking);
1059 packing = Z_SRW_recordPacking_string;
1061 srw_res->records = (Z_SRW_record *)
1062 odr_malloc(assoc->encode,
1063 number * sizeof(*srw_res->records));
1065 srw_res->extra_records = (Z_SRW_extra_record **)
1066 odr_malloc(assoc->encode,
1067 number*sizeof(*srw_res->extra_records));
1069 for (i = 0; i<number; i++)
1072 const char *addinfo = 0;
1074 srw_res->records[j].recordPacking = packing;
1075 srw_res->records[j].recordData_buf = 0;
1076 srw_res->extra_records[j] = 0;
1077 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1078 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1079 srw_res->records + j,
1083 yaz_add_srw_diagnostic(assoc->encode,
1084 &srw_res->diagnostics,
1085 &srw_res->num_diagnostics,
1086 yaz_diag_bib1_to_srw(errcode),
1091 if (srw_res->records[j].recordData_buf)
1094 srw_res->num_records = j;
1096 srw_res->records = 0;
1099 if (rr.extra_response_data)
1101 res->extraResponseData_buf = rr.extra_response_data;
1102 res->extraResponseData_len = strlen(rr.extra_response_data);
1104 if (rr.estimated_hit_count || rr.partial_resultset)
1106 yaz_add_srw_diagnostic(
1108 &srw_res->diagnostics,
1109 &srw_res->num_diagnostics,
1110 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1118 const char *querystr = "?";
1119 const char *querytype = "?";
1120 WRBUF wr = wrbuf_alloc();
1122 switch (srw_req->query_type)
1124 case Z_SRW_query_type_cql:
1126 querystr = srw_req->query.cql;
1128 case Z_SRW_query_type_pqf:
1130 querystr = srw_req->query.pqf;
1133 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1134 if (srw_res->num_diagnostics)
1135 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1136 else if (*http_code != 200)
1137 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1138 else if (srw_res->numberOfRecords)
1140 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1141 (srw_res->numberOfRecords ?
1142 *srw_res->numberOfRecords : 0));
1144 wrbuf_printf(wr, " %s " ODR_INT_PRINTF " +%d",
1145 (srw_res->resultSetId ?
1146 srw_res->resultSetId : "-"),
1147 (srw_req->startRecord ? *srw_req->startRecord : 1),
1148 srw_res->num_records);
1149 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1154 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1157 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1160 for (ptr = ptr->children; ptr; ptr = ptr->next)
1162 if (ptr->type != XML_ELEMENT_NODE)
1164 if (!strcmp((const char *) ptr->name, "explain"))
1167 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1171 ptr = xmlCopyNode(ptr, 1);
1173 xmlDocSetRootElement(doc, ptr);
1175 xmlDocDumpMemory(doc, &buf_out, &len);
1176 content = (char*) odr_malloc(rr->stream, 1+len);
1177 memcpy(content, buf_out, len);
1178 content[len] = '\0';
1182 rr->explain_buf = content;
1190 static void srw_bend_explain(association *assoc, request *req,
1192 Z_SRW_explainResponse *srw_res,
1195 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1196 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1198 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1203 rr.stream = assoc->encode;
1204 rr.decode = assoc->decode;
1205 rr.print = assoc->print;
1207 rr.database = srw_req->database;
1209 rr.server_node_ptr = assoc->server->server_node_ptr;
1211 rr.server_node_ptr = 0;
1212 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1213 if (assoc->init->bend_explain)
1214 (*assoc->init->bend_explain)(assoc->backend, &rr);
1216 srw_bend_explain_default(assoc->backend, &rr);
1220 int packing = Z_SRW_recordPacking_string;
1221 if (srw_req->recordPacking)
1224 yaz_srw_str_to_pack(srw_req->recordPacking);
1226 packing = Z_SRW_recordPacking_string;
1228 srw_res->record.recordSchema = rr.schema;
1229 srw_res->record.recordPacking = packing;
1230 srw_res->record.recordData_buf = rr.explain_buf;
1231 srw_res->record.recordData_len = strlen(rr.explain_buf);
1232 srw_res->record.recordPosition = 0;
1238 static void srw_bend_scan(association *assoc, request *req,
1240 Z_SRW_scanResponse *srw_res,
1243 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1244 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1247 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1248 if (srw_res->num_diagnostics == 0 && assoc->init)
1250 struct scan_entry *save_entries;
1252 bend_scan_rr *bsrr = (bend_scan_rr *)
1253 odr_malloc(assoc->encode, sizeof(*bsrr));
1254 bsrr->num_bases = 1;
1255 bsrr->basenames = &srw_req->database;
1257 bsrr->num_entries = srw_req->maximumTerms ?
1258 *srw_req->maximumTerms : 10;
1259 bsrr->term_position = srw_req->responsePosition ?
1260 *srw_req->responsePosition : 1;
1263 bsrr->errstring = 0;
1264 bsrr->referenceId = 0;
1265 bsrr->stream = assoc->encode;
1266 bsrr->print = assoc->print;
1267 bsrr->step_size = odr_intdup(assoc->decode, 0);
1271 if (bsrr->num_entries > 0)
1274 bsrr->entries = (struct scan_entry *)
1275 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1277 for (i = 0; i<bsrr->num_entries; i++)
1279 bsrr->entries[i].term = 0;
1280 bsrr->entries[i].occurrences = 0;
1281 bsrr->entries[i].errcode = 0;
1282 bsrr->entries[i].errstring = 0;
1283 bsrr->entries[i].display_term = 0;
1286 save_entries = bsrr->entries; /* save it so we can compare later */
1288 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1289 assoc->init->bend_scan)
1291 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1293 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1294 &bsrr->attributeset,
1295 srw_req->scanClause.pqf);
1296 yaz_pqf_destroy(pqf_parser);
1297 bsrr->scanClause = 0;
1298 ((int (*)(void *, bend_scan_rr *))
1299 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1301 else if (srw_req->query_type == Z_SRW_query_type_cql
1302 && assoc->init->bend_scan && assoc->server
1303 && assoc->server->cql_transform)
1306 bsrr->scanClause = 0;
1307 bsrr->attributeset = 0;
1308 bsrr->term = (Z_AttributesPlusTerm *)
1309 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1310 srw_error = cql2pqf_scan(assoc->encode,
1311 srw_req->scanClause.cql,
1312 assoc->server->cql_transform,
1315 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1316 &srw_res->num_diagnostics,
1320 ((int (*)(void *, bend_scan_rr *))
1321 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1324 else if (srw_req->query_type == Z_SRW_query_type_cql
1325 && assoc->init->bend_srw_scan)
1328 bsrr->attributeset = 0;
1329 bsrr->scanClause = srw_req->scanClause.cql;
1330 ((int (*)(void *, bend_scan_rr *))
1331 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1335 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1336 &srw_res->num_diagnostics,
1337 YAZ_SRW_UNSUPP_OPERATION, "scan");
1342 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1347 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1349 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1350 &srw_res->num_diagnostics,
1351 srw_error, bsrr->errstring);
1353 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1356 srw_res->terms = (Z_SRW_scanTerm*)
1357 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1360 srw_res->num_terms = bsrr->num_entries;
1361 for (i = 0; i<bsrr->num_entries; i++)
1363 Z_SRW_scanTerm *t = srw_res->terms + i;
1364 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1365 t->numberOfRecords =
1366 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1368 if (save_entries == bsrr->entries &&
1369 bsrr->entries[i].display_term)
1371 /* the entries was _not_ set by the handler. So it's
1372 safe to test for new member display_term. It is
1375 t->displayTerm = odr_strdup(assoc->encode,
1376 bsrr->entries[i].display_term);
1384 WRBUF wr = wrbuf_alloc();
1385 const char *querytype = 0;
1386 const char *querystr = 0;
1388 switch(srw_req->query_type)
1390 case Z_SRW_query_type_pqf:
1392 querystr = srw_req->scanClause.pqf;
1394 case Z_SRW_query_type_cql:
1396 querystr = srw_req->scanClause.cql;
1399 querytype = "UNKNOWN";
1403 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1405 if (srw_res->num_diagnostics)
1406 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1407 else if (srw_res->num_terms)
1408 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1410 wrbuf_printf(wr, "OK - - ");
1412 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1413 (srw_req->responsePosition ?
1414 *srw_req->responsePosition : 1),
1415 (srw_req->maximumTerms ?
1416 *srw_req->maximumTerms : 1));
1417 /* there is no step size in SRU/W ??? */
1418 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1419 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1425 static void srw_bend_update(association *assoc, request *req,
1427 Z_SRW_updateResponse *srw_res,
1430 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1431 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1432 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1434 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1438 Z_SRW_extra_record *extra = srw_req->extra_record;
1440 rr.stream = assoc->encode;
1441 rr.print = assoc->print;
1443 rr.basenames = &srw_req->database;
1444 rr.operation = srw_req->operation;
1445 rr.operation_status = "failed";
1447 rr.record_versions = 0;
1448 rr.num_versions = 0;
1449 rr.record_packing = "string";
1450 rr.record_schema = 0;
1452 rr.extra_record_data = 0;
1453 rr.extra_request_data = 0;
1454 rr.extra_response_data = 0;
1460 if (rr.operation == 0)
1462 yaz_add_sru_update_diagnostic(
1463 assoc->encode, &srw_res->diagnostics,
1464 &srw_res->num_diagnostics,
1465 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1469 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1470 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1471 if (!strcmp( rr.operation, "delete"))
1473 if (srw_req->record && !srw_req->record->recordSchema)
1475 rr.record_schema = odr_strdup(
1477 srw_req->record->recordSchema);
1479 if (srw_req->record)
1481 rr.record_data = odr_strdupn(
1483 srw_req->record->recordData_buf,
1484 srw_req->record->recordData_len );
1486 if (extra && extra->extraRecordData_len)
1488 rr.extra_record_data = odr_strdupn(
1490 extra->extraRecordData_buf,
1491 extra->extraRecordData_len );
1493 if (srw_req->recordId)
1494 rr.record_id = srw_req->recordId;
1495 else if (extra && extra->recordIdentifier)
1496 rr.record_id = extra->recordIdentifier;
1498 else if (!strcmp(rr.operation, "replace"))
1500 if (srw_req->recordId)
1501 rr.record_id = srw_req->recordId;
1502 else if (extra && extra->recordIdentifier)
1503 rr.record_id = extra->recordIdentifier;
1506 yaz_add_sru_update_diagnostic(
1507 assoc->encode, &srw_res->diagnostics,
1508 &srw_res->num_diagnostics,
1509 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1510 "recordIdentifier");
1512 if (!srw_req->record)
1514 yaz_add_sru_update_diagnostic(
1515 assoc->encode, &srw_res->diagnostics,
1516 &srw_res->num_diagnostics,
1517 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1522 if (srw_req->record->recordSchema)
1523 rr.record_schema = odr_strdup(
1524 assoc->encode, srw_req->record->recordSchema);
1525 if (srw_req->record->recordData_len )
1527 rr.record_data = odr_strdupn(assoc->encode,
1528 srw_req->record->recordData_buf,
1529 srw_req->record->recordData_len );
1533 yaz_add_sru_update_diagnostic(
1534 assoc->encode, &srw_res->diagnostics,
1535 &srw_res->num_diagnostics,
1536 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1540 if (extra && extra->extraRecordData_len)
1542 rr.extra_record_data = odr_strdupn(
1544 extra->extraRecordData_buf,
1545 extra->extraRecordData_len );
1548 else if (!strcmp(rr.operation, "insert"))
1550 if (srw_req->recordId)
1551 rr.record_id = srw_req->recordId;
1553 rr.record_id = extra->recordIdentifier;
1555 if (srw_req->record)
1557 if (srw_req->record->recordSchema)
1558 rr.record_schema = odr_strdup(
1559 assoc->encode, srw_req->record->recordSchema);
1561 if (srw_req->record->recordData_len)
1562 rr.record_data = odr_strdupn(
1564 srw_req->record->recordData_buf,
1565 srw_req->record->recordData_len );
1567 if (extra && extra->extraRecordData_len)
1569 rr.extra_record_data = odr_strdupn(
1571 extra->extraRecordData_buf,
1572 extra->extraRecordData_len );
1576 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1577 &srw_res->num_diagnostics,
1578 YAZ_SRU_UPDATE_INVALID_ACTION,
1581 if (srw_req->record)
1583 const char *pack_str =
1584 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1586 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1589 if (srw_req->num_recordVersions)
1591 rr.record_versions = srw_req->recordVersions;
1592 rr.num_versions = srw_req->num_recordVersions;
1594 if (srw_req->extraRequestData_len)
1596 rr.extra_request_data = odr_strdupn(assoc->encode,
1597 srw_req->extraRequestData_buf,
1598 srw_req->extraRequestData_len );
1600 if (srw_res->num_diagnostics == 0)
1602 if ( assoc->init->bend_srw_update)
1603 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1605 yaz_add_sru_update_diagnostic(
1606 assoc->encode, &srw_res->diagnostics,
1607 &srw_res->num_diagnostics,
1608 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1609 "No Update backend handler");
1613 yaz_add_srw_diagnostic_uri(assoc->encode,
1614 &srw_res->diagnostics,
1615 &srw_res->num_diagnostics,
1619 srw_res->recordId = rr.record_id;
1620 srw_res->operationStatus = rr.operation_status;
1621 srw_res->recordVersions = rr.record_versions;
1622 srw_res->num_recordVersions = rr.num_versions;
1623 if (srw_res->extraResponseData_len)
1625 srw_res->extraResponseData_buf = rr.extra_response_data;
1626 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1628 if (srw_res->num_diagnostics == 0 && rr.record_data)
1630 srw_res->record = yaz_srw_get_record(assoc->encode);
1631 srw_res->record->recordSchema = rr.record_schema;
1632 if (rr.record_packing)
1634 int pack = yaz_srw_str_to_pack(rr.record_packing);
1638 pack = Z_SRW_recordPacking_string;
1639 yaz_log(YLOG_WARN, "Back packing %s from backend",
1642 srw_res->record->recordPacking = pack;
1644 srw_res->record->recordData_buf = rr.record_data;
1645 srw_res->record->recordData_len = strlen(rr.record_data);
1646 if (rr.extra_record_data)
1648 Z_SRW_extra_record *ex =
1649 yaz_srw_get_extra_record(assoc->encode);
1650 srw_res->extra_record = ex;
1651 ex->extraRecordData_buf = rr.extra_record_data;
1652 ex->extraRecordData_len = strlen(rr.extra_record_data);
1658 /* check if path is OK (1); BAD (0) */
1659 static int check_path(const char *path)
1663 if (strstr(path, ".."))
1668 static char *read_file(const char *fname, ODR o, size_t *sz)
1671 FILE *inf = fopen(fname, "rb");
1675 fseek(inf, 0L, SEEK_END);
1678 buf = (char *) odr_malloc(o, *sz);
1679 if (fread(buf, 1, *sz, inf) != *sz)
1680 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1685 static void process_http_request(association *assoc, request *req)
1687 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1688 ODR o = assoc->encode;
1689 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1691 Z_SOAP *soap_package = 0;
1694 Z_HTTP_Response *hres = 0;
1696 const char *stylesheet = 0; /* for now .. set later */
1697 Z_SRW_diagnostic *diagnostic = 0;
1698 int num_diagnostic = 0;
1699 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1701 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1702 if (!control_association(assoc, host, 0))
1704 p = z_get_HTTP_Response(o, 404);
1707 if (r == 2 && assoc->server && assoc->server->docpath
1708 && hreq->path[0] == '/'
1710 /* check if path is a proper prefix of documentroot */
1711 strncmp(hreq->path+1, assoc->server->docpath,
1712 strlen(assoc->server->docpath))
1715 if (!check_path(hreq->path))
1717 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1718 p = z_get_HTTP_Response(o, 404);
1722 size_t content_size = 0;
1723 char *content_buf = read_file(hreq->path+1, o, &content_size);
1726 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1727 p = z_get_HTTP_Response(o, 404);
1731 const char *ctype = 0;
1732 yaz_mime_types types = yaz_mime_types_create();
1734 yaz_mime_types_add(types, "xsl", "application/xml");
1735 yaz_mime_types_add(types, "xml", "application/xml");
1736 yaz_mime_types_add(types, "css", "text/css");
1737 yaz_mime_types_add(types, "html", "text/html");
1738 yaz_mime_types_add(types, "htm", "text/html");
1739 yaz_mime_types_add(types, "txt", "text/plain");
1740 yaz_mime_types_add(types, "js", "application/x-javascript");
1742 yaz_mime_types_add(types, "gif", "image/gif");
1743 yaz_mime_types_add(types, "png", "image/png");
1744 yaz_mime_types_add(types, "jpg", "image/jpeg");
1745 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1747 ctype = yaz_mime_lookup_fname(types, hreq->path);
1750 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1751 p = z_get_HTTP_Response(o, 404);
1755 p = z_get_HTTP_Response(o, 200);
1756 hres = p->u.HTTP_Response;
1757 hres->content_buf = content_buf;
1758 hres->content_len = content_size;
1759 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1761 yaz_mime_types_destroy(types);
1769 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1770 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1772 if (r == 2) /* not taken */
1774 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1775 &diagnostic, &num_diagnostic);
1776 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1778 if (r == 0) /* decode SRW/SRU OK .. */
1780 int http_code = 200;
1781 if (sr->which == Z_SRW_searchRetrieve_request)
1784 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1786 stylesheet = sr->u.request->stylesheet;
1789 res->u.response->diagnostics = diagnostic;
1790 res->u.response->num_diagnostics = num_diagnostic;
1794 srw_bend_search(assoc, req, sr, res, &http_code);
1796 if (http_code == 200)
1797 soap_package->u.generic->p = res;
1799 else if (sr->which == Z_SRW_explain_request)
1801 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1803 stylesheet = sr->u.explain_request->stylesheet;
1806 res->u.explain_response->diagnostics = diagnostic;
1807 res->u.explain_response->num_diagnostics = num_diagnostic;
1809 srw_bend_explain(assoc, req, sr,
1810 res->u.explain_response, &http_code);
1811 if (http_code == 200)
1812 soap_package->u.generic->p = res;
1814 else if (sr->which == Z_SRW_scan_request)
1816 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1818 stylesheet = sr->u.scan_request->stylesheet;
1821 res->u.scan_response->diagnostics = diagnostic;
1822 res->u.scan_response->num_diagnostics = num_diagnostic;
1824 srw_bend_scan(assoc, req, sr,
1825 res->u.scan_response, &http_code);
1826 if (http_code == 200)
1827 soap_package->u.generic->p = res;
1829 else if (sr->which == Z_SRW_update_request)
1831 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1833 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1836 res->u.update_response->diagnostics = diagnostic;
1837 res->u.update_response->num_diagnostics = num_diagnostic;
1839 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1840 srw_bend_update(assoc, req, sr,
1841 res->u.update_response, &http_code);
1842 if (http_code == 200)
1843 soap_package->u.generic->p = res;
1847 yaz_log(log_request, "SOAP ERROR");
1848 /* FIXME - what error, what query */
1850 z_soap_error(assoc->encode, soap_package,
1851 "SOAP-ENV:Client", "Bad method", 0);
1853 if (http_code == 200 || http_code == 500)
1855 static Z_SOAP_Handler soap_handlers[4] = {
1857 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1858 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1859 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1865 p = z_get_HTTP_Response(o, 200);
1866 hres = p->u.HTTP_Response;
1868 if (!stylesheet && assoc->server)
1869 stylesheet = assoc->server->stylesheet;
1871 /* empty stylesheet means NO stylesheet */
1872 if (stylesheet && *stylesheet == '\0')
1875 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1876 &hres->content_buf, &hres->content_len,
1877 soap_handlers, charset, stylesheet);
1878 hres->code = http_code;
1880 strcpy(ctype, "text/xml");
1881 if (charset && strlen(charset) < sizeof(ctype)-30)
1883 strcat(ctype, "; charset=");
1884 strcat(ctype, charset);
1886 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1889 p = z_get_HTTP_Response(o, http_code);
1893 p = z_get_HTTP_Response(o, 500);
1894 hres = p->u.HTTP_Response;
1895 if (!strcmp(hreq->version, "1.0"))
1897 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1898 if (v && !strcmp(v, "Keep-Alive"))
1902 hres->version = "1.0";
1906 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1907 if (v && !strcmp(v, "close"))
1911 hres->version = "1.1";
1915 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1916 assoc->state = ASSOC_DEAD;
1917 assoc->cs_get_mask = 0;
1922 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1924 if (alive && isdigit(*(const unsigned char *) alive))
1928 if (t < 0 || t > 3600)
1930 iochan_settimeout(assoc->client_chan,t);
1931 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1933 process_gdu_response(assoc, req, p);
1936 static void process_gdu_request(association *assoc, request *req)
1938 if (req->gdu_request->which == Z_GDU_Z3950)
1941 req->apdu_request = req->gdu_request->u.z3950;
1942 if (process_z_request(assoc, req, &msg) < 0)
1943 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1945 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1946 process_http_request(assoc, req);
1949 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1954 * Initiate request processing.
1956 static int process_z_request(association *assoc, request *req, char **msg)
1962 *msg = "Unknown Error";
1963 assert(req && req->state == REQUEST_IDLE);
1964 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1966 *msg = "Missing InitRequest";
1969 switch (req->apdu_request->which)
1971 case Z_APDU_initRequest:
1972 res = process_initRequest(assoc, req); break;
1973 case Z_APDU_searchRequest:
1974 res = process_searchRequest(assoc, req, &fd); break;
1975 case Z_APDU_presentRequest:
1976 res = process_presentRequest(assoc, req, &fd); break;
1977 case Z_APDU_scanRequest:
1978 if (assoc->init->bend_scan)
1979 res = process_scanRequest(assoc, req, &fd);
1982 *msg = "Cannot handle Scan APDU";
1986 case Z_APDU_extendedServicesRequest:
1987 if (assoc->init->bend_esrequest)
1988 res = process_ESRequest(assoc, req, &fd);
1991 *msg = "Cannot handle Extended Services APDU";
1995 case Z_APDU_sortRequest:
1996 if (assoc->init->bend_sort)
1997 res = process_sortRequest(assoc, req, &fd);
2000 *msg = "Cannot handle Sort APDU";
2005 process_close(assoc, req);
2007 case Z_APDU_deleteResultSetRequest:
2008 if (assoc->init->bend_delete)
2009 res = process_deleteRequest(assoc, req, &fd);
2012 *msg = "Cannot handle Delete APDU";
2016 case Z_APDU_segmentRequest:
2017 if (assoc->init->bend_segment)
2019 res = process_segmentRequest(assoc, req);
2023 *msg = "Cannot handle Segment APDU";
2027 case Z_APDU_triggerResourceControlRequest:
2030 *msg = "Bad APDU received";
2035 yaz_log(YLOG_DEBUG, " result immediately available");
2036 retval = process_z_response(assoc, req, res);
2040 yaz_log(YLOG_DEBUG, " result unavailble");
2043 else /* no result yet - one will be provided later */
2047 /* Set up an I/O handler for the fd supplied by the backend */
2049 yaz_log(YLOG_DEBUG, " establishing handler for result");
2050 req->state = REQUEST_PENDING;
2051 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2053 iochan_setdata(chan, assoc);
2060 * Handle message from the backend.
2062 void backend_response(IOCHAN i, int event)
2064 association *assoc = (association *)iochan_getdata(i);
2065 request *req = request_head(&assoc->incoming);
2069 yaz_log(YLOG_DEBUG, "backend_response");
2070 assert(assoc && req && req->state != REQUEST_IDLE);
2071 /* determine what it is we're waiting for */
2072 switch (req->apdu_request->which)
2074 case Z_APDU_searchRequest:
2075 res = response_searchRequest(assoc, req, 0, &fd); break;
2077 case Z_APDU_presentRequest:
2078 res = response_presentRequest(assoc, req, 0, &fd); break;
2079 case Z_APDU_scanRequest:
2080 res = response_scanRequest(assoc, req, 0, &fd); break;
2083 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2086 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2088 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2089 do_close(assoc, Z_Close_systemProblem, 0);
2093 else if (!res) /* no result yet - try again later */
2095 yaz_log(YLOG_DEBUG, " no result yet");
2096 iochan_setfd(i, fd); /* in case fd has changed */
2101 * Encode response, and transfer the request structure to the outgoing queue.
2103 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2105 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2109 if (!z_GDU(assoc->print, &res, 0, 0))
2110 yaz_log(YLOG_WARN, "ODR print error: %s",
2111 odr_errmsg(odr_geterror(assoc->print)));
2112 odr_reset(assoc->print);
2114 if (!z_GDU(assoc->encode, &res, 0, 0))
2116 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2117 odr_errmsg(odr_geterror(assoc->decode)),
2118 odr_getelement(assoc->decode));
2121 req->response = odr_getbuf(assoc->encode, &req->len_response,
2122 &req->size_response);
2123 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2124 odr_reset(assoc->encode);
2125 req->state = REQUEST_IDLE;
2126 request_enq(&assoc->outgoing, req);
2127 /* turn the work over to the ir_session handler */
2128 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2129 assoc->cs_put_mask = EVENT_OUTPUT;
2130 /* Is there more work to be done? give that to the input handler too */
2133 req = request_head(&assoc->incoming);
2134 if (req && req->state == REQUEST_IDLE)
2136 request_deq(&assoc->incoming);
2137 process_gdu_request(assoc, req);
2146 * Encode response, and transfer the request structure to the outgoing queue.
2148 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2150 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2151 gres->which = Z_GDU_Z3950;
2152 gres->u.z3950 = res;
2154 return process_gdu_response(assoc, req, gres);
2157 static char *get_vhost(Z_OtherInformation *otherInfo)
2159 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2163 * Handle init request.
2164 * At the moment, we don't check the options
2165 * anywhere else in the code - we just try not to do anything that would
2166 * break a naive client. We'll toss 'em into the association block when
2167 * we need them there.
2169 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2171 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2172 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2173 Z_InitResponse *resp = apdu->u.initResponse;
2174 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;
2209 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2210 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2211 assoc->init->named_result_sets = 1;
2216 if (req->implementationVersion)
2217 yaz_log(log_requestdetail, "Config: %s",
2220 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2222 /* we have a backend control block, so call that init function */
2223 if (!(binitres = (*cb->bend_init)(assoc->init)))
2225 yaz_log(YLOG_WARN, "Bad response from backend.");
2228 assoc->backend = binitres->handle;
2232 /* no backend. return error */
2233 binitres = (bend_initresult *)
2234 odr_malloc(assoc->encode, sizeof(*binitres));
2235 binitres->errstring = 0;
2236 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2237 iochan_settimeout(assoc->client_chan, 10);
2239 if ((assoc->init->bend_sort))
2240 yaz_log(YLOG_DEBUG, "Sort handler installed");
2241 if ((assoc->init->bend_search))
2242 yaz_log(YLOG_DEBUG, "Search handler installed");
2243 if ((assoc->init->bend_present))
2244 yaz_log(YLOG_DEBUG, "Present handler installed");
2245 if ((assoc->init->bend_esrequest))
2246 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2247 if ((assoc->init->bend_delete))
2248 yaz_log(YLOG_DEBUG, "Delete handler installed");
2249 if ((assoc->init->bend_scan))
2250 yaz_log(YLOG_DEBUG, "Scan handler installed");
2251 if ((assoc->init->bend_segment))
2252 yaz_log(YLOG_DEBUG, "Segment handler installed");
2254 resp->referenceId = req->referenceId;
2256 /* let's tell the client what we can do */
2257 if (ODR_MASK_GET(req->options, Z_Options_search))
2259 ODR_MASK_SET(resp->options, Z_Options_search);
2260 strcat(options, "srch");
2262 if (ODR_MASK_GET(req->options, Z_Options_present))
2264 ODR_MASK_SET(resp->options, Z_Options_present);
2265 strcat(options, " prst");
2267 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2268 assoc->init->bend_delete)
2270 ODR_MASK_SET(resp->options, Z_Options_delSet);
2271 strcat(options, " del");
2273 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2274 assoc->init->bend_esrequest)
2276 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2277 strcat(options, " extendedServices");
2279 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2280 && assoc->init->named_result_sets)
2282 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2283 strcat(options, " namedresults");
2285 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2287 ODR_MASK_SET(resp->options, Z_Options_scan);
2288 strcat(options, " scan");
2290 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2292 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2293 strcat(options, " concurrop");
2295 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2297 ODR_MASK_SET(resp->options, Z_Options_sort);
2298 strcat(options, " sort");
2301 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2303 Z_OtherInformationUnit *p0;
2305 if (!assoc->init->charneg_response)
2307 if (assoc->init->query_charset)
2309 assoc->init->charneg_response = yaz_set_response_charneg(
2310 assoc->encode, assoc->init->query_charset, 0,
2311 assoc->init->records_in_same_charset);
2315 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2318 if (assoc->init->charneg_response
2319 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2321 p0->which = Z_OtherInfo_externallyDefinedInfo;
2322 p0->information.externallyDefinedInfo =
2323 assoc->init->charneg_response;
2324 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2325 strcat(options, " negotiation");
2328 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2329 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2331 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2333 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2334 assoc->version = 1; /* 1 & 2 are equivalent */
2336 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2338 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2341 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2343 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2347 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2349 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2350 assoc->maximumRecordSize = *req->maximumRecordSize;
2352 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2353 assoc->preferredMessageSize = *req->preferredMessageSize;
2355 resp->preferredMessageSize = &assoc->preferredMessageSize;
2356 resp->maximumRecordSize = &assoc->maximumRecordSize;
2358 resp->implementationId = odr_prepend(assoc->encode,
2359 assoc->init->implementation_id,
2360 resp->implementationId);
2362 resp->implementationName = odr_prepend(assoc->encode,
2363 assoc->init->implementation_name,
2364 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2366 if (binitres->errcode)
2368 assoc->state = ASSOC_DEAD;
2369 resp->userInformationField =
2370 init_diagnostics(assoc->encode, binitres->errcode,
2371 binitres->errstring);
2375 assoc->state = ASSOC_UP;
2379 if (!req->idAuthentication)
2380 yaz_log(log_request, "Auth none");
2381 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2383 const char *open = req->idAuthentication->u.open;
2384 const char *slash = strchr(open, '/');
2390 yaz_log(log_request, "Auth open %.*s", len, open);
2392 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2394 const char *user = req->idAuthentication->u.idPass->userId;
2395 const char *group = req->idAuthentication->u.idPass->groupId;
2396 yaz_log(log_request, "Auth idPass %s %s",
2397 user ? user : "-", group ? group : "-");
2399 else if (req->idAuthentication->which
2400 == Z_IdAuthentication_anonymous)
2402 yaz_log(log_request, "Auth anonymous");
2406 yaz_log(log_request, "Auth other");
2411 WRBUF wr = wrbuf_alloc();
2412 wrbuf_printf(wr, "Init ");
2413 if (binitres->errcode)
2414 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2416 wrbuf_printf(wr, "OK -");
2417 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2418 (req->implementationId ? req->implementationId :"-"),
2419 (req->implementationName ?
2420 req->implementationName : "-"),
2421 (req->implementationVersion ?
2422 req->implementationVersion : "-")
2424 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2431 * Set the specified `errcode' and `errstring' into a UserInfo-1
2432 * external to be returned to the client in accordance with Z35.90
2433 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2434 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2436 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2438 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2439 addinfo ? " -- " : "", addinfo ? addinfo : "");
2440 return zget_init_diagnostics(odr, error, addinfo);
2444 * nonsurrogate diagnostic record.
2446 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2448 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2450 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2451 addinfo ? " -- " : "", addinfo ? addinfo : "");
2453 rec->which = Z_Records_NSD;
2454 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2460 * surrogate diagnostic.
2462 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2464 int error, const char *addinfo)
2466 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2467 addinfo ? " -- " : "", addinfo ? addinfo : "");
2468 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2471 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2472 Odr_int *num, Z_RecordComposition *comp,
2473 Odr_int *next, Odr_int *pres,
2474 Z_ReferenceId *referenceId,
2475 Odr_oid *oid, int *errcode)
2477 int recno, total_length = 0, toget = *num, dumped_records = 0;
2478 Z_Records *records =
2479 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2480 Z_NamePlusRecordList *reclist =
2481 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2482 Z_NamePlusRecord **list =
2483 (Z_NamePlusRecord **) odr_malloc(a->encode, sizeof(*list) * toget);
2485 records->which = Z_Records_DBOSD;
2486 records->u.databaseOrSurDiagnostics = reclist;
2487 reclist->num_records = 0;
2488 reclist->records = list;
2489 *pres = Z_PresentStatus_success;
2493 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2494 yaz_log(log_requestdetail, "pms=" ODR_INT_PRINTF
2495 ", mrs=" ODR_INT_PRINTF, a->preferredMessageSize,
2496 a->maximumRecordSize);
2497 for (recno = start; reclist->num_records < toget; recno++)
2500 Z_NamePlusRecord *thisrec;
2501 int this_length = 0;
2503 * we get the number of bytes allocated on the stream before any
2504 * allocation done by the backend - this should give us a reasonable
2505 * idea of the total size of the data so far.
2507 total_length = odr_total(a->encode) - dumped_records;
2513 freq.last_in_set = 0;
2514 freq.setname = setname;
2515 freq.surrogate_flag = 0;
2516 freq.number = recno;
2518 freq.request_format = oid;
2519 freq.output_format = 0;
2520 freq.stream = a->encode;
2521 freq.print = a->print;
2522 freq.referenceId = referenceId;
2525 retrieve_fetch(a, &freq);
2527 *next = freq.last_in_set ? 0 : recno + 1;
2531 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2534 *pres = Z_PresentStatus_failure;
2535 /* for 'present request out of range',
2536 set addinfo to record position if not set */
2537 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2538 freq.errstring == 0)
2540 sprintf (s, "%d", recno);
2544 *errcode = freq.errcode;
2545 return diagrec(a, freq.errcode, freq.errstring);
2547 reclist->records[reclist->num_records] =
2548 surrogatediagrec(a, freq.basename, freq.errcode,
2550 reclist->num_records++;
2553 if (freq.record == 0) /* no error and no record ? */
2555 *next = 0; /* signal end-of-set and stop */
2559 this_length = freq.len;
2561 this_length = odr_total(a->encode) - total_length - dumped_records;
2562 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2563 this_length, total_length, dumped_records);
2564 if (a->preferredMessageSize > 0 &&
2565 this_length + total_length > a->preferredMessageSize)
2567 /* record is small enough, really */
2568 if (this_length <= a->preferredMessageSize && recno > start)
2570 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2571 *pres = Z_PresentStatus_partial_2;
2574 /* record can only be fetched by itself */
2575 if (this_length < a->maximumRecordSize)
2577 yaz_log(log_requestdetail, " Record > prefmsgsz");
2580 yaz_log(YLOG_DEBUG, " Dropped it");
2581 reclist->records[reclist->num_records] =
2582 surrogatediagrec(a, freq.basename, 16, 0);
2583 reclist->num_records++;
2584 dumped_records += this_length;
2588 else /* too big entirely */
2590 yaz_log(log_requestdetail, "Record > maxrcdsz "
2591 "this=%d max=" ODR_INT_PRINTF,
2592 this_length, a->maximumRecordSize);
2593 reclist->records[reclist->num_records] =
2594 surrogatediagrec(a, freq.basename, 17, 0);
2595 reclist->num_records++;
2596 dumped_records += this_length;
2601 if (!(thisrec = (Z_NamePlusRecord *)
2602 odr_malloc(a->encode, sizeof(*thisrec))))
2604 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2605 thisrec->which = Z_NamePlusRecord_databaseRecord;
2607 if (!freq.output_format)
2608 freq.output_format = freq.request_format;
2609 thisrec->u.databaseRecord = z_ext_record_oid(
2610 a->encode, freq.output_format, freq.record, freq.len);
2611 if (!thisrec->u.databaseRecord)
2613 reclist->records[reclist->num_records] = thisrec;
2614 reclist->num_records++;
2616 *num = reclist->num_records;
2620 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2623 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2624 bend_search_rr *bsrr =
2625 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2627 yaz_log(log_requestdetail, "Got SearchRequest.");
2629 bsrr->request = reqb;
2630 bsrr->association = assoc;
2631 bsrr->referenceId = req->referenceId;
2632 save_referenceId (reqb, bsrr->referenceId);
2633 bsrr->srw_sortKeys = 0;
2634 bsrr->srw_setname = 0;
2635 bsrr->srw_setnameIdleTime = 0;
2636 bsrr->estimated_hit_count = 0;
2637 bsrr->partial_resultset = 0;
2638 bsrr->extra_args = 0;
2639 bsrr->extra_response_data = 0;
2641 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2642 if (req->databaseNames)
2645 for (i = 0; i < req->num_databaseNames; i++)
2646 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2649 yaz_log_zquery_level(log_requestdetail,req->query);
2651 if (assoc->init->bend_search)
2653 bsrr->setname = req->resultSetName;
2654 bsrr->replace_set = *req->replaceIndicator;
2655 bsrr->num_bases = req->num_databaseNames;
2656 bsrr->basenames = req->databaseNames;
2657 bsrr->query = req->query;
2658 bsrr->stream = assoc->encode;
2659 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2660 bsrr->decode = assoc->decode;
2661 bsrr->print = assoc->print;
2664 bsrr->errstring = NULL;
2665 bsrr->search_info = NULL;
2667 if (assoc->server && assoc->server->cql_transform
2668 && req->query->which == Z_Query_type_104
2669 && req->query->u.type_104->which == Z_External_CQL)
2671 /* have a CQL query and a CQL to PQF transform .. */
2673 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2674 assoc->server->cql_transform, bsrr->query);
2676 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2679 if (assoc->server && assoc->server->ccl_transform
2680 && req->query->which == Z_Query_type_2) /*CCL*/
2682 /* have a CCL query and a CCL to PQF transform .. */
2684 ccl2pqf(bsrr->stream, req->query->u.type_2,
2685 assoc->server->ccl_transform, bsrr);
2687 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2691 (assoc->init->bend_search)(assoc->backend, bsrr);
2692 if (!bsrr->request) /* backend not ready with the search response */
2693 return 0; /* should not be used any more */
2697 /* FIXME - make a diagnostic for it */
2698 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2700 return response_searchRequest(assoc, reqb, bsrr, fd);
2703 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2706 * Prepare a searchresponse based on the backend results. We probably want
2707 * to look at making the fetching of records nonblocking as well, but
2708 * so far, we'll keep things simple.
2709 * If bsrt is null, that means we're called in response to a communications
2710 * event, and we'll have to get the response for ourselves.
2712 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2713 bend_search_rr *bsrt, int *fd)
2715 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2716 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2717 Z_SearchResponse *resp = (Z_SearchResponse *)
2718 odr_malloc(assoc->encode, sizeof(*resp));
2719 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2720 Odr_int *next = odr_intdup(assoc->encode, 0);
2721 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2722 int returnedrecs = 0;
2724 apdu->which = Z_APDU_searchResponse;
2725 apdu->u.searchResponse = resp;
2726 resp->referenceId = req->referenceId;
2727 resp->additionalSearchInfo = 0;
2728 resp->otherInfo = 0;
2730 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2732 yaz_log(YLOG_FATAL, "Bad result from backend");
2735 else if (bsrt->errcode)
2737 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2738 resp->resultCount = nulint;
2739 resp->numberOfRecordsReturned = nulint;
2740 resp->nextResultSetPosition = nulint;
2741 resp->searchStatus = odr_booldup(assoc->encode, 0);
2742 resp->resultSetStatus = none;
2743 resp->presentStatus = 0;
2747 bool_t *sr = odr_booldup(assoc->encode, 1);
2748 Odr_int *toget = odr_intdup(assoc->encode, 0);
2749 Z_RecordComposition comp, *compp = 0;
2751 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2754 resp->resultCount = &bsrt->hits;
2756 comp.which = Z_RecordComp_simple;
2757 /* how many records does the user agent want, then? */
2758 if (bsrt->hits <= *req->smallSetUpperBound)
2760 *toget = bsrt->hits;
2761 if ((comp.u.simple = req->smallSetElementSetNames))
2764 else if (bsrt->hits < *req->largeSetLowerBound)
2766 *toget = *req->mediumSetPresentNumber;
2767 if (*toget > bsrt->hits)
2768 *toget = bsrt->hits;
2769 if ((comp.u.simple = req->mediumSetElementSetNames))
2775 if (*toget && !resp->records)
2777 Odr_int *presst = odr_intdup(assoc->encode, 0);
2778 /* Call bend_present if defined */
2779 if (assoc->init->bend_present)
2781 bend_present_rr *bprr = (bend_present_rr *)
2782 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2783 bprr->setname = req->resultSetName;
2785 bprr->number = *toget;
2786 bprr->format = req->preferredRecordSyntax;
2788 bprr->referenceId = req->referenceId;
2789 bprr->stream = assoc->encode;
2790 bprr->print = assoc->print;
2791 bprr->request = reqb;
2792 bprr->association = assoc;
2794 bprr->errstring = NULL;
2795 (*assoc->init->bend_present)(assoc->backend, bprr);
2801 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2802 *resp->presentStatus = Z_PresentStatus_failure;
2807 resp->records = pack_records(
2808 assoc, req->resultSetName, 1,
2809 toget, compp, next, presst, req->referenceId,
2810 req->preferredRecordSyntax, NULL);
2813 resp->numberOfRecordsReturned = toget;
2814 returnedrecs = *toget;
2815 resp->presentStatus = presst;
2819 if (*resp->resultCount)
2821 resp->numberOfRecordsReturned = nulint;
2822 resp->presentStatus = 0;
2824 resp->nextResultSetPosition = next;
2825 resp->searchStatus = sr;
2826 resp->resultSetStatus = 0;
2827 if (bsrt->estimated_hit_count)
2829 resp->resultSetStatus = odr_intdup(assoc->encode,
2830 Z_SearchResponse_estimate);
2832 else if (bsrt->partial_resultset)
2834 resp->resultSetStatus = odr_intdup(assoc->encode,
2835 Z_SearchResponse_subset);
2838 resp->additionalSearchInfo = bsrt->search_info;
2843 WRBUF wr = wrbuf_alloc();
2845 for (i = 0 ; i < req->num_databaseNames; i++){
2847 wrbuf_printf(wr, "+");
2848 wrbuf_puts(wr, req->databaseNames[i]);
2850 wrbuf_printf(wr, " ");
2853 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2855 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2856 wrbuf_printf(wr, " %s 1+%d ",
2857 req->resultSetName, returnedrecs);
2858 yaz_query_to_wrbuf(wr, req->query);
2860 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2867 * Maybe we got a little over-friendly when we designed bend_fetch to
2868 * get only one record at a time. Some backends can optimise multiple-record
2869 * fetches, and at any rate, there is some overhead involved in
2870 * all that selecting and hopping around. Problem is, of course, that the
2871 * frontend can't know ahead of time how many records it'll need to
2872 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2873 * is downright lousy as a bulk data transfer protocol.
2875 * To start with, we'll do the fetching of records from the backend
2876 * in one operation: To save some trips in and out of the event-handler,
2877 * and to simplify the interface to pack_records. At any rate, asynch
2878 * operation is more fun in operations that have an unpredictable execution
2879 * speed - which is normally more true for search than for present.
2881 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2884 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2886 Z_PresentResponse *resp;
2890 const char *errstring = 0;
2892 yaz_log(log_requestdetail, "Got PresentRequest.");
2894 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2896 resp->presentStatus = odr_intdup(assoc->encode, 0);
2897 if (assoc->init->bend_present)
2899 bend_present_rr *bprr = (bend_present_rr *)
2900 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2901 bprr->setname = req->resultSetId;
2902 bprr->start = *req->resultSetStartPoint;
2903 bprr->number = *req->numberOfRecordsRequested;
2904 bprr->format = req->preferredRecordSyntax;
2905 bprr->comp = req->recordComposition;
2906 bprr->referenceId = req->referenceId;
2907 bprr->stream = assoc->encode;
2908 bprr->print = assoc->print;
2909 bprr->request = reqb;
2910 bprr->association = assoc;
2912 bprr->errstring = NULL;
2913 (*assoc->init->bend_present)(assoc->backend, bprr);
2916 return 0; /* should not happen */
2919 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2920 *resp->presentStatus = Z_PresentStatus_failure;
2921 errcode = bprr->errcode;
2922 errstring = bprr->errstring;
2925 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2926 next = odr_intdup(assoc->encode, 0);
2927 num = odr_intdup(assoc->encode, 0);
2929 apdu->which = Z_APDU_presentResponse;
2930 apdu->u.presentResponse = resp;
2931 resp->referenceId = req->referenceId;
2932 resp->otherInfo = 0;
2936 *num = *req->numberOfRecordsRequested;
2938 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2939 num, req->recordComposition, next,
2940 resp->presentStatus,
2941 req->referenceId, req->preferredRecordSyntax,
2946 WRBUF wr = wrbuf_alloc();
2947 wrbuf_printf(wr, "Present ");
2949 if (*resp->presentStatus == Z_PresentStatus_failure)
2950 wrbuf_printf(wr, "ERROR %d ", errcode);
2951 else if (*resp->presentStatus == Z_PresentStatus_success)
2952 wrbuf_printf(wr, "OK - ");
2954 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2955 *resp->presentStatus);
2957 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2958 req->resultSetId, *req->resultSetStartPoint,
2959 *req->numberOfRecordsRequested);
2960 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2965 resp->numberOfRecordsReturned = num;
2966 resp->nextResultSetPosition = next;
2972 * Scan was implemented rather in a hurry, and with support for only the basic
2973 * elements of the service in the backend API. Suggestions are welcome.
2975 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2977 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2978 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2979 Z_ScanResponse *res = (Z_ScanResponse *)
2980 odr_malloc(assoc->encode, sizeof(*res));
2981 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2982 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2983 Z_ListEntries *ents = (Z_ListEntries *)
2984 odr_malloc(assoc->encode, sizeof(*ents));
2985 Z_DiagRecs *diagrecs_p = NULL;
2986 bend_scan_rr *bsrr = (bend_scan_rr *)
2987 odr_malloc(assoc->encode, sizeof(*bsrr));
2988 struct scan_entry *save_entries;
2990 yaz_log(log_requestdetail, "Got ScanRequest");
2992 apdu->which = Z_APDU_scanResponse;
2993 apdu->u.scanResponse = res;
2994 res->referenceId = req->referenceId;
2996 /* if step is absent, set it to 0 */
2997 res->stepSize = odr_intdup(assoc->encode, 0);
2999 *res->stepSize = *req->stepSize;
3001 res->scanStatus = scanStatus;
3002 res->numberOfEntriesReturned = numberOfEntriesReturned;
3003 res->positionOfTerm = 0;
3004 res->entries = ents;
3005 ents->num_entries = 0;
3006 ents->entries = NULL;
3007 ents->num_nonsurrogateDiagnostics = 0;
3008 ents->nonsurrogateDiagnostics = NULL;
3009 res->attributeSet = 0;
3012 if (req->databaseNames)
3015 for (i = 0; i < req->num_databaseNames; i++)
3016 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
3018 bsrr->scanClause = 0;
3020 bsrr->errstring = 0;
3021 bsrr->num_bases = req->num_databaseNames;
3022 bsrr->basenames = req->databaseNames;
3023 bsrr->num_entries = *req->numberOfTermsRequested;
3024 bsrr->term = req->termListAndStartPoint;
3025 bsrr->referenceId = req->referenceId;
3026 bsrr->stream = assoc->encode;
3027 bsrr->print = assoc->print;
3028 bsrr->step_size = res->stepSize;
3029 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
3030 yaz_oid_userinfo_scan_set, 1, 0);
3032 /* For YAZ 2.0 and earlier it was the backend handler that
3033 initialized entries (member display_term did not exist)
3034 YAZ 2.0 and later sets 'entries' and initialize all members
3035 including 'display_term'. If YAZ 2.0 or later sees that
3036 entries was modified - we assume that it is an old handler and
3037 that 'display_term' is _not_ set.
3039 if (bsrr->num_entries > 0)
3042 bsrr->entries = (struct scan_entry *)
3043 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3045 for (i = 0; i<bsrr->num_entries; i++)
3047 bsrr->entries[i].term = 0;
3048 bsrr->entries[i].occurrences = 0;
3049 bsrr->entries[i].errcode = 0;
3050 bsrr->entries[i].errstring = 0;
3051 bsrr->entries[i].display_term = 0;
3054 save_entries = bsrr->entries; /* save it so we can compare later */
3056 bsrr->attributeset = req->attributeSet;
3057 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3058 bsrr->attributeset);
3059 bsrr->term_position = req->preferredPositionInResponse ?
3060 *req->preferredPositionInResponse : 1;
3062 ((int (*)(void *, bend_scan_rr *))
3063 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3066 diagrecs_p = zget_DiagRecs(assoc->encode,
3067 bsrr->errcode, bsrr->errstring);
3071 Z_Entry **tab = (Z_Entry **)
3072 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3074 if (bsrr->status == BEND_SCAN_PARTIAL)
3075 *scanStatus = Z_Scan_partial_5;
3077 *scanStatus = Z_Scan_success;
3078 ents->entries = tab;
3079 ents->num_entries = bsrr->num_entries;
3080 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3082 res->positionOfTerm = &bsrr->term_position;
3083 for (i = 0; i < bsrr->num_entries; i++)
3089 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3090 if (bsrr->entries[i].occurrences >= 0)
3092 e->which = Z_Entry_termInfo;
3093 e->u.termInfo = t = (Z_TermInfo *)
3094 odr_malloc(assoc->encode, sizeof(*t));
3095 t->suggestedAttributes = 0;
3097 if (save_entries == bsrr->entries &&
3098 bsrr->entries[i].display_term)
3100 /* the entries was _not_ set by the handler. So it's
3101 safe to test for new member display_term. It is
3104 t->displayTerm = odr_strdup(assoc->encode,
3105 bsrr->entries[i].display_term);
3107 t->alternativeTerm = 0;
3108 t->byAttributes = 0;
3109 t->otherTermInfo = 0;
3110 t->globalOccurrences = &bsrr->entries[i].occurrences;
3111 t->term = (Z_Term *)
3112 odr_malloc(assoc->encode, sizeof(*t->term));
3113 t->term->which = Z_Term_general;
3114 t->term->u.general = o =
3115 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3116 o->buf = (unsigned char *)
3117 odr_malloc(assoc->encode, o->len = o->size =
3118 strlen(bsrr->entries[i].term));
3119 memcpy(o->buf, bsrr->entries[i].term, o->len);
3120 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3121 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3125 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3126 bsrr->entries[i].errcode,
3127 bsrr->entries[i].errstring);
3128 assert(drecs->num_diagRecs == 1);
3129 e->which = Z_Entry_surrogateDiagnostic;
3130 assert(drecs->diagRecs[0]);
3131 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3137 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3138 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3143 WRBUF wr = wrbuf_alloc();
3144 wrbuf_printf(wr, "Scan ");
3145 for (i = 0 ; i < req->num_databaseNames; i++)
3148 wrbuf_printf(wr, "+");
3149 wrbuf_puts(wr, req->databaseNames[i]);
3152 wrbuf_printf(wr, " ");
3155 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3157 wrbuf_printf(wr, "OK");
3159 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3160 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3161 res->numberOfEntriesReturned ?
3162 *res->numberOfEntriesReturned : 0,
3163 (req->preferredPositionInResponse ?
3164 *req->preferredPositionInResponse : 1),
3165 *req->numberOfTermsRequested,
3166 (res->stepSize ? *res->stepSize : 1));
3169 wrbuf_printf(wr, "+%s", bsrr->setname);
3171 wrbuf_printf(wr, " ");
3172 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3173 bsrr->attributeset);
3174 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3180 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3184 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3185 Z_SortResponse *res = (Z_SortResponse *)
3186 odr_malloc(assoc->encode, sizeof(*res));
3187 bend_sort_rr *bsrr = (bend_sort_rr *)
3188 odr_malloc(assoc->encode, sizeof(*bsrr));
3190 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3192 yaz_log(log_requestdetail, "Got SortRequest.");
3194 bsrr->num_input_setnames = req->num_inputResultSetNames;
3195 for (i=0;i<req->num_inputResultSetNames;i++)
3196 yaz_log(log_requestdetail, "Input resultset: '%s'",
3197 req->inputResultSetNames[i]);
3198 bsrr->input_setnames = req->inputResultSetNames;
3199 bsrr->referenceId = req->referenceId;
3200 bsrr->output_setname = req->sortedResultSetName;
3201 yaz_log(log_requestdetail, "Output resultset: '%s'",
3202 req->sortedResultSetName);
3203 bsrr->sort_sequence = req->sortSequence;
3204 /*FIXME - dump those sequences too */
3205 bsrr->stream = assoc->encode;
3206 bsrr->print = assoc->print;
3208 bsrr->sort_status = Z_SortResponse_failure;
3210 bsrr->errstring = 0;
3212 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3214 res->referenceId = bsrr->referenceId;
3215 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3216 res->resultSetStatus = 0;
3219 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3220 bsrr->errcode, bsrr->errstring);
3221 res->diagnostics = dr->diagRecs;
3222 res->num_diagnostics = dr->num_diagRecs;
3226 res->num_diagnostics = 0;
3227 res->diagnostics = 0;
3229 res->resultCount = 0;
3232 apdu->which = Z_APDU_sortResponse;
3233 apdu->u.sortResponse = res;
3236 WRBUF wr = wrbuf_alloc();
3237 wrbuf_printf(wr, "Sort ");
3239 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3241 wrbuf_printf(wr, "OK -");
3242 wrbuf_printf(wr, " (");
3243 for (i = 0; i<req->num_inputResultSetNames; i++)
3246 wrbuf_printf(wr, "+");
3247 wrbuf_puts(wr, req->inputResultSetNames[i]);
3249 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3251 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3257 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3261 Z_DeleteResultSetRequest *req =
3262 reqb->apdu_request->u.deleteResultSetRequest;
3263 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3264 odr_malloc(assoc->encode, sizeof(*res));
3265 bend_delete_rr *bdrr = (bend_delete_rr *)
3266 odr_malloc(assoc->encode, sizeof(*bdrr));
3267 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3269 yaz_log(log_requestdetail, "Got DeleteRequest.");
3271 bdrr->num_setnames = req->num_resultSetList;
3272 bdrr->setnames = req->resultSetList;
3273 for (i = 0; i<req->num_resultSetList; i++)
3274 yaz_log(log_requestdetail, "resultset: '%s'",
3275 req->resultSetList[i]);
3276 bdrr->stream = assoc->encode;
3277 bdrr->print = assoc->print;
3278 bdrr->function = *req->deleteFunction;
3279 bdrr->referenceId = req->referenceId;
3281 if (bdrr->num_setnames > 0)
3283 bdrr->statuses = (Odr_int*)
3284 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3285 bdrr->num_setnames);
3286 for (i = 0; i < bdrr->num_setnames; i++)
3287 bdrr->statuses[i] = 0;
3289 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3291 res->referenceId = req->referenceId;
3293 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3295 res->deleteListStatuses = 0;
3296 if (bdrr->num_setnames > 0)
3299 res->deleteListStatuses = (Z_ListStatuses *)
3300 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3301 res->deleteListStatuses->num = bdrr->num_setnames;
3302 res->deleteListStatuses->elements =
3304 odr_malloc(assoc->encode,
3305 sizeof(*res->deleteListStatuses->elements) *
3306 bdrr->num_setnames);
3307 for (i = 0; i<bdrr->num_setnames; i++)
3309 res->deleteListStatuses->elements[i] =
3311 odr_malloc(assoc->encode,
3312 sizeof(**res->deleteListStatuses->elements));
3313 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3314 res->deleteListStatuses->elements[i]->id =
3315 odr_strdup(assoc->encode, bdrr->setnames[i]);
3318 res->numberNotDeleted = 0;
3319 res->bulkStatuses = 0;
3320 res->deleteMessage = 0;
3323 apdu->which = Z_APDU_deleteResultSetResponse;
3324 apdu->u.deleteResultSetResponse = res;
3327 WRBUF wr = wrbuf_alloc();
3328 wrbuf_printf(wr, "Delete ");
3329 if (bdrr->delete_status)
3330 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3332 wrbuf_printf(wr, "OK -");
3333 for (i = 0; i<req->num_resultSetList; i++)
3334 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3335 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3341 static void process_close(association *assoc, request *reqb)
3343 Z_Close *req = reqb->apdu_request->u.close;
3344 static char *reasons[] =
3351 "securityViolation",
3358 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3359 reasons[*req->closeReason], req->diagnosticInformation ?
3360 req->diagnosticInformation : "NULL");
3361 if (assoc->version < 3) /* to make do_force respond with close */
3363 do_close_req(assoc, Z_Close_finished,
3364 "Association terminated by client", reqb);
3365 yaz_log(log_request,"Close OK");
3368 void save_referenceId(request *reqb, Z_ReferenceId *refid)
3372 reqb->len_refid = refid->len;
3373 reqb->refid = (char *)nmem_malloc(reqb->request_mem, refid->len);
3374 memcpy(reqb->refid, refid->buf, refid->len);
3378 reqb->len_refid = 0;
3383 void bend_request_send(bend_association a, bend_request req, Z_APDU *res)
3385 process_z_response(a, req, res);
3388 bend_request bend_request_mk(bend_association a)
3390 request *nreq = request_get(&a->outgoing);
3391 nreq->request_mem = nmem_create();
3395 Z_ReferenceId *bend_request_getid(ODR odr, bend_request req)
3400 id = (Odr_oct *)odr_malloc(odr, sizeof(*odr));
3401 id->buf = (unsigned char *)odr_malloc(odr, req->len_refid);
3402 id->len = id->size = req->len_refid;
3403 memcpy(id->buf, req->refid, req->len_refid);
3407 void bend_request_destroy(bend_request *req)
3409 nmem_destroy((*req)->request_mem);
3410 request_release(*req);
3414 int bend_backend_respond(bend_association a, bend_request req)
3418 r = process_z_request(a, req, &msg);
3420 yaz_log(YLOG_WARN, "%s", msg);
3424 void bend_request_setdata(bend_request r, void *p)
3429 void *bend_request_getdata(bend_request r)
3431 return r->clientData;
3434 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3436 bend_segment_rr req;
3438 req.segment = reqb->apdu_request->u.segmentRequest;
3439 req.stream = assoc->encode;
3440 req.decode = assoc->decode;
3441 req.print = assoc->print;
3442 req.association = assoc;
3444 (*assoc->init->bend_segment)(assoc->backend, &req);
3449 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3451 bend_esrequest_rr esrequest;
3452 const char *ext_name = "unknown";
3454 Z_ExtendedServicesRequest *req =
3455 reqb->apdu_request->u.extendedServicesRequest;
3456 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3458 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3460 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3461 esrequest.stream = assoc->encode;
3462 esrequest.decode = assoc->decode;
3463 esrequest.print = assoc->print;
3464 esrequest.errcode = 0;
3465 esrequest.errstring = NULL;
3466 esrequest.request = reqb;
3467 esrequest.association = assoc;
3468 esrequest.taskPackage = 0;
3469 esrequest.referenceId = req->referenceId;
3472 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3474 switch(esrequest.esr->taskSpecificParameters->which)
3476 case Z_External_itemOrder:
3477 ext_name = "ItemOrder"; break;
3478 case Z_External_update:
3479 ext_name = "Update"; break;
3480 case Z_External_update0:
3481 ext_name = "Update0"; break;
3482 case Z_External_ESAdmin:
3483 ext_name = "Admin"; break;
3488 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3490 /* If the response is being delayed, return NULL */
3491 if (esrequest.request == NULL)
3494 resp->referenceId = req->referenceId;
3496 if (esrequest.errcode == -1)
3498 /* Backend service indicates request will be processed */
3499 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3500 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3502 else if (esrequest.errcode == 0)
3504 /* Backend service indicates request will be processed */
3505 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3506 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3510 Z_DiagRecs *diagRecs =
3511 zget_DiagRecs(assoc->encode, esrequest.errcode,
3512 esrequest.errstring);
3513 /* Backend indicates error, request will not be processed */
3514 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3515 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3516 resp->num_diagnostics = diagRecs->num_diagRecs;
3517 resp->diagnostics = diagRecs->diagRecs;
3520 WRBUF wr = wrbuf_alloc();
3521 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3522 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3527 /* Do something with the members of bend_extendedservice */
3528 if (esrequest.taskPackage)
3530 resp->taskPackage = z_ext_record_oid(
3531 assoc->encode, yaz_oid_recsyn_extended,
3532 (const char *) esrequest.taskPackage, -1);
3534 yaz_log(YLOG_DEBUG,"Send the result apdu");
3538 int bend_assoc_is_alive(bend_association assoc)
3540 if (assoc->state == ASSOC_DEAD)
3541 return 0; /* already marked as dead. Don't check I/O chan anymore */
3543 return iochan_is_alive(assoc->client_chan);
3550 * c-file-style: "Stroustrup"
3551 * indent-tabs-mode: nil
3553 * vim: shiftwidth=4 tabstop=8 expandtab