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 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
98 static Z_APDU *process_segmentRequest(association *assoc, request *reqb);
100 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
102 /* dynamic logging levels */
103 static int logbits_set = 0;
104 static int log_session = 0; /* one-line logs for session */
105 static int log_sessiondetail = 0; /* more detailed stuff */
106 static int log_request = 0; /* one-line logs for requests */
107 static int log_requestdetail = 0; /* more detailed stuff */
109 /** get_logbits sets global loglevel bits */
110 static void get_logbits(void)
111 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
115 log_session = yaz_log_module_level("session");
116 log_sessiondetail = yaz_log_module_level("sessiondetail");
117 log_request = yaz_log_module_level("request");
118 log_requestdetail = yaz_log_module_level("requestdetail");
124 static void wr_diag(WRBUF w, int error, const char *addinfo)
126 wrbuf_printf(w, "ERROR %d+", error);
127 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
130 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
138 * Create and initialize a new association-handle.
139 * channel : iochannel for the current line.
140 * link : communications channel.
141 * Returns: 0 or a new association handle.
143 association *create_association(IOCHAN channel, COMSTACK link,
144 const char *apdufile)
150 if (!(anew = (association *)xmalloc(sizeof(*anew))))
154 anew->last_control = 0;
155 anew->client_chan = channel;
156 anew->client_link = link;
157 anew->cs_get_mask = 0;
158 anew->cs_put_mask = 0;
159 anew->cs_accept_mask = 0;
160 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
161 !(anew->encode = odr_createmem(ODR_ENCODE)))
163 if (apdufile && *apdufile)
167 if (!(anew->print = odr_createmem(ODR_PRINT)))
169 if (*apdufile == '@')
171 odr_setprint(anew->print, yaz_log_file());
173 else if (*apdufile != '-')
176 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
177 if (!(f = fopen(filename, "w")))
179 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
182 setvbuf(f, 0, _IONBF, 0);
183 odr_setprint(anew->print, f);
188 anew->input_buffer = 0;
189 anew->input_buffer_len = 0;
191 anew->state = ASSOC_NEW;
192 request_initq(&anew->incoming);
193 request_initq(&anew->outgoing);
194 anew->proto = cs_getproto(link);
200 * Free association and release resources.
202 void destroy_association(association *h)
204 statserv_options_block *cb = statserv_getcontrol();
208 odr_destroy(h->decode);
209 odr_destroy(h->encode);
211 odr_destroy(h->print);
213 xfree(h->input_buffer);
215 (*cb->bend_close)(h->backend);
216 while ((req = request_deq(&h->incoming)))
217 request_release(req);
218 while ((req = request_deq(&h->outgoing)))
219 request_release(req);
220 request_delq(&h->incoming);
221 request_delq(&h->outgoing);
223 xmalloc_trav("session closed");
224 if (cb && cb->one_shot)
230 static void do_close_req(association *a, int reason, char *message,
234 Z_Close *cls = zget_Close(a->encode);
236 /* Purge request queue */
237 while (request_deq(&a->incoming));
238 while (request_deq(&a->outgoing));
241 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
242 reason, message ? message : "none");
243 apdu.which = Z_APDU_close;
245 *cls->closeReason = reason;
246 cls->diagnosticInformation = message;
247 process_z_response(a, req, &apdu);
248 iochan_settimeout(a->client_chan, 20);
252 request_release(req);
253 yaz_log(log_requestdetail, "v2 client. No Close PDU");
254 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
257 a->state = ASSOC_DEAD;
260 static void do_close(association *a, int reason, char *message)
262 request *req = request_get(&a->outgoing);
263 do_close_req (a, reason, message, req);
267 int ir_read(IOCHAN h, int event)
269 association *assoc = (association *)iochan_getdata(h);
270 COMSTACK conn = assoc->client_link;
273 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
275 yaz_log(YLOG_DEBUG, "ir_session (input)");
276 /* We aren't speaking to this fellow */
277 if (assoc->state == ASSOC_DEAD)
279 yaz_log(log_sessiondetail, "Connection closed - end of session");
281 destroy_association(assoc);
285 assoc->cs_get_mask = EVENT_INPUT;
289 int res = cs_get(conn, &assoc->input_buffer,
290 &assoc->input_buffer_len);
291 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
293 yaz_log(log_session, "Connection error: %s res=%d",
294 cs_errmsg(cs_errno(conn)), res);
295 req = request_get(&assoc->incoming); /* get a new request */
296 do_close_req(assoc, Z_Close_protocolError,
297 "Incoming package too large", req);
302 yaz_log(log_session, "Connection closed by client");
303 assoc->state = ASSOC_DEAD;
306 else if (res == 1) /* incomplete read - wait for more */
308 if (conn->io_pending & CS_WANT_WRITE)
309 assoc->cs_get_mask |= EVENT_OUTPUT;
310 iochan_setflag(h, assoc->cs_get_mask);
313 /* we got a complete PDU. Let's decode it */
314 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
315 assoc->input_buffer[0] & 0xff,
316 assoc->input_buffer[1] & 0xff,
317 assoc->input_buffer[2] & 0xff);
318 req = request_get(&assoc->incoming); /* get a new request */
319 odr_reset(assoc->decode);
320 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
321 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
323 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
325 odr_errmsg(odr_geterror(assoc->decode)),
326 odr_getelement(assoc->decode),
327 (long) odr_offset(assoc->decode));
328 if (assoc->decode->error != OHTTP)
330 yaz_log(YLOG_WARN, "PDU dump:");
331 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
332 request_release(req);
333 do_close(assoc, Z_Close_protocolError, "Malformed package");
337 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
338 assoc->state = ASSOC_DEAD;
339 process_gdu_response(assoc, req, p);
343 req->request_mem = odr_extract_mem(assoc->decode);
346 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
347 yaz_log(YLOG_WARN, "ODR print error: %s",
348 odr_errmsg(odr_geterror(assoc->print)));
349 odr_reset(assoc->print);
351 request_enq(&assoc->incoming, req);
353 while (cs_more(conn));
359 * This is where PDUs from the client are read and the further
360 * processing is initiated. Flow of control moves down through the
361 * various process_* functions below, until the encoded result comes back up
362 * to the output handler in here.
364 * h : the I/O channel that has an outstanding event.
365 * event : the current outstanding event.
367 void ir_session(IOCHAN h, int event)
370 association *assoc = (association *)iochan_getdata(h);
371 COMSTACK conn = assoc->client_link;
374 assert(h && conn && assoc);
375 if (event == EVENT_TIMEOUT)
377 if (assoc->state != ASSOC_UP)
379 yaz_log(log_session, "Timeout. Closing connection");
380 /* do we need to lod this at all */
382 destroy_association(assoc);
387 yaz_log(log_sessiondetail, "Timeout. Sending Z39.50 Close");
388 do_close(assoc, Z_Close_lackOfActivity, 0);
392 if (event & assoc->cs_accept_mask)
394 if (!cs_accept(conn))
396 yaz_log(YLOG_WARN, "accept failed");
397 destroy_association(assoc);
401 iochan_clearflag(h, EVENT_OUTPUT);
402 if (conn->io_pending)
403 { /* cs_accept didn't complete */
404 assoc->cs_accept_mask =
405 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
406 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
408 iochan_setflag(h, assoc->cs_accept_mask);
411 { /* cs_accept completed. Prepare for reading (cs_get) */
412 assoc->cs_accept_mask = 0;
413 assoc->cs_get_mask = EVENT_INPUT;
414 iochan_setflag(h, assoc->cs_get_mask);
418 if (event & assoc->cs_get_mask) /* input */
420 if (!ir_read(h, event))
422 req = request_head(&assoc->incoming);
423 if (req->state == REQUEST_IDLE)
425 request_deq(&assoc->incoming);
426 process_gdu_request(assoc, req);
429 if (event & assoc->cs_put_mask)
431 request *req = request_head(&assoc->outgoing);
433 assoc->cs_put_mask = 0;
434 yaz_log(YLOG_DEBUG, "ir_session (output)");
435 req->state = REQUEST_PENDING;
436 switch (res = cs_put(conn, req->response, req->len_response))
439 yaz_log(log_sessiondetail, "Connection closed by client");
441 destroy_association(assoc);
444 case 0: /* all sent - release the request structure */
445 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
447 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
450 nmem_destroy(req->request_mem);
451 request_deq(&assoc->outgoing);
452 request_release(req);
453 if (!request_head(&assoc->outgoing))
454 { /* restore mask for cs_get operation ... */
455 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
456 iochan_setflag(h, assoc->cs_get_mask);
457 if (assoc->state == ASSOC_DEAD)
458 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
462 assoc->cs_put_mask = EVENT_OUTPUT;
466 if (conn->io_pending & CS_WANT_WRITE)
467 assoc->cs_put_mask |= EVENT_OUTPUT;
468 if (conn->io_pending & CS_WANT_READ)
469 assoc->cs_put_mask |= EVENT_INPUT;
470 iochan_setflag(h, assoc->cs_put_mask);
473 if (event & EVENT_EXCEPT)
475 yaz_log(YLOG_WARN, "ir_session (exception)");
477 destroy_association(assoc);
482 static int process_z_request(association *assoc, request *req, char **msg);
485 static void assoc_init_reset(association *assoc)
488 assoc->init = (bend_initrequest *) xmalloc(sizeof(*assoc->init));
490 assoc->init->stream = assoc->encode;
491 assoc->init->print = assoc->print;
492 assoc->init->auth = 0;
493 assoc->init->referenceId = 0;
494 assoc->init->implementation_version = 0;
495 assoc->init->implementation_id = 0;
496 assoc->init->implementation_name = 0;
497 assoc->init->query_charset = 0;
498 assoc->init->records_in_same_charset = 0;
499 assoc->init->bend_sort = NULL;
500 assoc->init->bend_search = NULL;
501 assoc->init->bend_present = NULL;
502 assoc->init->bend_esrequest = NULL;
503 assoc->init->bend_delete = NULL;
504 assoc->init->bend_scan = NULL;
505 assoc->init->bend_segment = NULL;
506 assoc->init->bend_fetch = NULL;
507 assoc->init->bend_explain = NULL;
508 assoc->init->bend_srw_scan = NULL;
509 assoc->init->bend_srw_update = NULL;
510 assoc->init->named_result_sets = 0;
512 assoc->init->charneg_request = NULL;
513 assoc->init->charneg_response = NULL;
515 assoc->init->decode = assoc->decode;
516 assoc->init->peer_name =
517 odr_strdup(assoc->encode, cs_addrstr(assoc->client_link));
519 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
522 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
524 statserv_options_block *cb = statserv_getcontrol();
527 const char *encoding = "UTF-8";
529 bend_initresult *binitres;
531 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
532 assoc_init_reset(assoc);
536 Z_IdAuthentication *auth = (Z_IdAuthentication *)
537 odr_malloc(assoc->decode, sizeof(*auth));
540 len = strlen(sr->username) + 1;
542 len += strlen(sr->password) + 2;
543 auth->which = Z_IdAuthentication_open;
544 auth->u.open = (char *) odr_malloc(assoc->decode, len);
545 strcpy(auth->u.open, sr->username);
546 if (sr->password && *sr->password)
548 strcat(auth->u.open, "/");
549 strcat(auth->u.open, sr->password);
551 assoc->init->auth = auth;
555 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
556 assoc->init->charneg_request = ce->u.charNeg3;
559 if (!(binitres = (*cb->bend_init)(assoc->init)))
561 assoc->state = ASSOC_DEAD;
562 yaz_add_srw_diagnostic(assoc->encode, d, num,
563 YAZ_SRW_AUTHENTICATION_ERROR, 0);
566 assoc->backend = binitres->handle;
567 assoc->init->auth = 0;
568 if (binitres->errcode)
570 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
571 assoc->state = ASSOC_DEAD;
572 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
573 binitres->errstring);
581 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
584 yaz_record_conv_t rc = 0;
585 const char *match_schema = 0;
586 Odr_oid *match_syntax = 0;
591 const char *input_schema = yaz_get_esn(rr->comp);
592 Odr_oid *input_syntax_raw = rr->request_format;
594 const char *backend_schema = 0;
595 Odr_oid *backend_syntax = 0;
597 r = yaz_retrieval_request(assoc->server->retrieval,
605 if (r == -1) /* error ? */
607 const char *details = yaz_retrieval_get_error(
608 assoc->server->retrieval);
610 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
612 rr->errstring = odr_strdup(rr->stream, details);
615 else if (r == 1 || r == 3)
617 const char *details = input_schema;
619 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
621 rr->errstring = odr_strdup(rr->stream, details);
626 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
627 if (input_syntax_raw)
629 char oidbuf[OID_STR_MAX];
630 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
631 rr->errstring = odr_strdup(rr->stream, oidbuf);
637 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
640 rr->request_format = backend_syntax;
642 (*assoc->init->bend_fetch)(assoc->backend, rr);
643 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
644 { /* post conversion must take place .. */
645 WRBUF output_record = wrbuf_alloc();
646 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
649 const char *details = yaz_record_conv_get_error(rc);
650 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
652 rr->errstring = odr_strdup(rr->stream, details);
656 rr->len = wrbuf_len(output_record);
657 rr->record = (char *) odr_malloc(rr->stream, rr->len);
658 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
660 wrbuf_destroy(output_record);
663 rr->output_format = match_syntax;
665 rr->schema = odr_strdup(rr->stream, match_schema);
667 (*assoc->init->bend_fetch)(assoc->backend, rr);
672 static int srw_bend_fetch(association *assoc, int pos,
673 Z_SRW_searchRetrieveRequest *srw_req,
674 Z_SRW_record *record,
675 const char **addinfo)
678 ODR o = assoc->encode;
680 rr.setname = "default";
683 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
685 rr.comp = (Z_RecordComposition *)
686 odr_malloc(assoc->decode, sizeof(*rr.comp));
687 rr.comp->which = Z_RecordComp_complex;
688 rr.comp->u.complex = (Z_CompSpec *)
689 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
690 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
691 odr_malloc(assoc->encode, sizeof(bool_t));
692 *rr.comp->u.complex->selectAlternativeSyntax = 0;
693 rr.comp->u.complex->num_dbSpecific = 0;
694 rr.comp->u.complex->dbSpecific = 0;
695 rr.comp->u.complex->num_recordSyntax = 0;
696 rr.comp->u.complex->recordSyntax = 0;
698 rr.comp->u.complex->generic = (Z_Specification *)
699 odr_malloc(assoc->decode, sizeof(Z_Specification));
701 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
702 rr.comp->u.complex->generic->which = Z_Schema_uri;
703 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
705 /* ESN = recordSchema if recordSchema is present */
706 rr.comp->u.complex->generic->elementSpec = 0;
707 if (srw_req->recordSchema)
709 rr.comp->u.complex->generic->elementSpec =
710 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
711 rr.comp->u.complex->generic->elementSpec->which =
712 Z_ElementSpec_elementSetName;
713 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
714 srw_req->recordSchema;
717 rr.stream = assoc->encode;
718 rr.print = assoc->print;
726 rr.surrogate_flag = 0;
727 rr.schema = srw_req->recordSchema;
729 if (!assoc->init->bend_fetch)
732 retrieve_fetch(assoc, &rr);
734 if (rr.errcode && rr.surrogate_flag)
736 int code = yaz_diag_bib1_to_srw(rr.errcode);
737 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
740 else if (rr.len >= 0)
742 record->recordData_buf = rr.record;
743 record->recordData_len = rr.len;
744 record->recordPosition = odr_intdup(o, pos);
745 record->recordSchema = odr_strdup_null(
746 o, rr.schema ? rr.schema : srw_req->recordSchema);
750 *addinfo = rr.errstring;
756 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
757 Z_Query *query_result)
759 /* have a CQL query and CQL to PQF transform .. */
760 CQL_parser cp = cql_parser_create();
766 r = cql_parser_string(cp, cql);
769 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
774 r = cql_transform_buf(ct,
775 cql_parser_result(cp),
776 rpn_buf, sizeof(rpn_buf)-1);
778 srw_errcode = cql_transform_error(ct, &add);
782 /* Syntax & transform OK. */
783 /* Convert PQF string to Z39.50 to RPN query struct */
784 YAZ_PQF_Parser pp = yaz_pqf_create();
785 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
790 int code = yaz_pqf_error(pp, &pqf_msg, &off);
791 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
793 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
797 query_result->which = Z_Query_type_1;
798 query_result->u.type_1 = rpnquery;
802 cql_parser_destroy(cp);
806 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
807 Z_AttributesPlusTerm *result)
811 int srw_error = cql2pqf(odr, cql, ct, &query);
814 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
815 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
816 rpn = query.u.type_1;
817 if (!rpn->RPNStructure)
818 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
819 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
820 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
821 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
822 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
823 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
829 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
830 bend_search_rr *bsrr) {
832 struct ccl_rpn_node *node;
835 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
836 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0) {
837 bsrr->errstring = (char*) ccl_err_msg(errcode);
838 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
841 bsrr->query->which = Z_Query_type_1;
842 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
847 static void srw_bend_search(association *assoc, request *req,
852 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
855 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
858 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
859 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
860 if (srw_res->num_diagnostics == 0 && assoc->init)
863 rr.setname = "default";
866 rr.basenames = &srw_req->database;
870 rr.srw_setnameIdleTime = 0;
871 rr.estimated_hit_count = 0;
872 rr.partial_resultset = 0;
873 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
874 rr.query->u.type_1 = 0;
875 rr.extra_args = sr->extra_args;
876 rr.extra_response_data = 0;
878 if (srw_req->query_type == Z_SRW_query_type_cql)
880 if (assoc->server && assoc->server->cql_transform)
882 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
883 assoc->server->cql_transform,
887 yaz_add_srw_diagnostic(assoc->encode,
888 &srw_res->diagnostics,
889 &srw_res->num_diagnostics,
895 /* CQL query to backend. Wrap it - Z39.50 style */
896 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
897 ext->direct_reference = odr_getoidbystr(assoc->decode,
898 "1.2.840.10003.16.2");
899 ext->indirect_reference = 0;
901 ext->which = Z_External_CQL;
902 ext->u.cql = srw_req->query.cql;
904 rr.query->which = Z_Query_type_104;
905 rr.query->u.type_104 = ext;
908 else if (srw_req->query_type == Z_SRW_query_type_pqf)
910 Z_RPNQuery *RPNquery;
911 YAZ_PQF_Parser pqf_parser;
913 pqf_parser = yaz_pqf_create();
915 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
921 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
922 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
923 code, pqf_msg, (long) off);
924 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
927 rr.query->which = Z_Query_type_1;
928 rr.query->u.type_1 = RPNquery;
930 yaz_pqf_destroy(pqf_parser);
934 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
935 &srw_res->num_diagnostics,
936 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
938 if (rr.query->u.type_1)
940 rr.stream = assoc->encode;
941 rr.decode = assoc->decode;
942 rr.print = assoc->print;
944 if ( srw_req->sort.sortKeys )
945 rr.srw_sortKeys = odr_strdup(assoc->encode,
946 srw_req->sort.sortKeys );
947 rr.association = assoc;
953 yaz_log_zquery_level(log_requestdetail,rr.query);
955 (assoc->init->bend_search)(assoc->backend, &rr);
958 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
964 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
965 yaz_add_srw_diagnostic(assoc->encode,
966 &srw_res->diagnostics,
967 &srw_res->num_diagnostics,
968 srw_error, rr.errstring);
973 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
974 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
976 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
978 start, number, rr.hits);
980 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
983 srw_res->resultSetId =
984 odr_strdup(assoc->encode, rr.srw_setname );
985 srw_res->resultSetIdleTime =
986 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
989 if (start > rr.hits || start < 1)
991 /* if hits<=0 and start=1 we don't return a diagnostic */
993 yaz_add_srw_diagnostic(
995 &srw_res->diagnostics, &srw_res->num_diagnostics,
996 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1002 if (start + number > rr.hits)
1003 number = rr.hits - start + 1;
1005 /* Call bend_present if defined */
1006 if (assoc->init->bend_present)
1008 bend_present_rr *bprr = (bend_present_rr*)
1009 odr_malloc(assoc->decode, sizeof(*bprr));
1010 bprr->setname = "default";
1011 bprr->start = start;
1012 bprr->number = number;
1013 if (srw_req->recordSchema)
1015 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1016 sizeof(*bprr->comp));
1017 bprr->comp->which = Z_RecordComp_simple;
1018 bprr->comp->u.simple = (Z_ElementSetNames *)
1019 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1020 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1021 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1027 bprr->stream = assoc->encode;
1028 bprr->referenceId = 0;
1029 bprr->print = assoc->print;
1030 bprr->request = req;
1031 bprr->association = assoc;
1033 bprr->errstring = NULL;
1034 (*assoc->init->bend_present)(assoc->backend, bprr);
1040 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1041 yaz_add_srw_diagnostic(assoc->encode,
1042 &srw_res->diagnostics,
1043 &srw_res->num_diagnostics,
1044 srw_error, bprr->errstring);
1052 int packing = Z_SRW_recordPacking_string;
1053 if (srw_req->recordPacking)
1056 yaz_srw_str_to_pack(srw_req->recordPacking);
1058 packing = Z_SRW_recordPacking_string;
1060 srw_res->records = (Z_SRW_record *)
1061 odr_malloc(assoc->encode,
1062 number * sizeof(*srw_res->records));
1064 srw_res->extra_records = (Z_SRW_extra_record **)
1065 odr_malloc(assoc->encode,
1066 number*sizeof(*srw_res->extra_records));
1068 for (i = 0; i<number; i++)
1071 const char *addinfo = 0;
1073 srw_res->records[j].recordPacking = packing;
1074 srw_res->records[j].recordData_buf = 0;
1075 srw_res->extra_records[j] = 0;
1076 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1077 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1078 srw_res->records + j,
1082 yaz_add_srw_diagnostic(assoc->encode,
1083 &srw_res->diagnostics,
1084 &srw_res->num_diagnostics,
1085 yaz_diag_bib1_to_srw(errcode),
1090 if (srw_res->records[j].recordData_buf)
1093 srw_res->num_records = j;
1095 srw_res->records = 0;
1098 if (rr.extra_response_data)
1100 res->extraResponseData_buf = rr.extra_response_data;
1101 res->extraResponseData_len = strlen(rr.extra_response_data);
1103 if (rr.estimated_hit_count || rr.partial_resultset)
1105 yaz_add_srw_diagnostic(
1107 &srw_res->diagnostics,
1108 &srw_res->num_diagnostics,
1109 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1117 const char *querystr = "?";
1118 const char *querytype = "?";
1119 WRBUF wr = wrbuf_alloc();
1121 switch (srw_req->query_type)
1123 case Z_SRW_query_type_cql:
1125 querystr = srw_req->query.cql;
1127 case Z_SRW_query_type_pqf:
1129 querystr = srw_req->query.pqf;
1132 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1133 if (srw_res->num_diagnostics)
1134 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1135 else if (*http_code != 200)
1136 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1137 else if (srw_res->numberOfRecords)
1139 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1140 (srw_res->numberOfRecords ?
1141 *srw_res->numberOfRecords : 0));
1143 wrbuf_printf(wr, " %s " ODR_INT_PRINTF " +%d",
1144 (srw_res->resultSetId ?
1145 srw_res->resultSetId : "-"),
1146 (srw_req->startRecord ? *srw_req->startRecord : 1),
1147 srw_res->num_records);
1148 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1153 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1156 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1159 for (ptr = ptr->children; ptr; ptr = ptr->next)
1161 if (ptr->type != XML_ELEMENT_NODE)
1163 if (!strcmp((const char *) ptr->name, "explain"))
1166 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1170 ptr = xmlCopyNode(ptr, 1);
1172 xmlDocSetRootElement(doc, ptr);
1174 xmlDocDumpMemory(doc, &buf_out, &len);
1175 content = (char*) odr_malloc(rr->stream, 1+len);
1176 memcpy(content, buf_out, len);
1177 content[len] = '\0';
1181 rr->explain_buf = content;
1189 static void srw_bend_explain(association *assoc, request *req,
1191 Z_SRW_explainResponse *srw_res,
1194 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1195 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1197 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1202 rr.stream = assoc->encode;
1203 rr.decode = assoc->decode;
1204 rr.print = assoc->print;
1206 rr.database = srw_req->database;
1208 rr.server_node_ptr = assoc->server->server_node_ptr;
1210 rr.server_node_ptr = 0;
1211 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1212 if (assoc->init->bend_explain)
1213 (*assoc->init->bend_explain)(assoc->backend, &rr);
1215 srw_bend_explain_default(assoc->backend, &rr);
1219 int packing = Z_SRW_recordPacking_string;
1220 if (srw_req->recordPacking)
1223 yaz_srw_str_to_pack(srw_req->recordPacking);
1225 packing = Z_SRW_recordPacking_string;
1227 srw_res->record.recordSchema = rr.schema;
1228 srw_res->record.recordPacking = packing;
1229 srw_res->record.recordData_buf = rr.explain_buf;
1230 srw_res->record.recordData_len = strlen(rr.explain_buf);
1231 srw_res->record.recordPosition = 0;
1237 static void srw_bend_scan(association *assoc, request *req,
1239 Z_SRW_scanResponse *srw_res,
1242 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1243 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1246 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1247 if (srw_res->num_diagnostics == 0 && assoc->init)
1249 struct scan_entry *save_entries;
1251 bend_scan_rr *bsrr = (bend_scan_rr *)
1252 odr_malloc(assoc->encode, sizeof(*bsrr));
1253 bsrr->num_bases = 1;
1254 bsrr->basenames = &srw_req->database;
1256 bsrr->num_entries = srw_req->maximumTerms ?
1257 *srw_req->maximumTerms : 10;
1258 bsrr->term_position = srw_req->responsePosition ?
1259 *srw_req->responsePosition : 1;
1262 bsrr->errstring = 0;
1263 bsrr->referenceId = 0;
1264 bsrr->stream = assoc->encode;
1265 bsrr->print = assoc->print;
1266 bsrr->step_size = odr_intdup(assoc->decode, 0);
1270 if (bsrr->num_entries > 0)
1273 bsrr->entries = (struct scan_entry *)
1274 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1276 for (i = 0; i<bsrr->num_entries; i++)
1278 bsrr->entries[i].term = 0;
1279 bsrr->entries[i].occurrences = 0;
1280 bsrr->entries[i].errcode = 0;
1281 bsrr->entries[i].errstring = 0;
1282 bsrr->entries[i].display_term = 0;
1285 save_entries = bsrr->entries; /* save it so we can compare later */
1287 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1288 assoc->init->bend_scan)
1290 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1292 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1293 &bsrr->attributeset,
1294 srw_req->scanClause.pqf);
1295 yaz_pqf_destroy(pqf_parser);
1296 bsrr->scanClause = 0;
1297 ((int (*)(void *, bend_scan_rr *))
1298 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1300 else if (srw_req->query_type == Z_SRW_query_type_cql
1301 && assoc->init->bend_scan && assoc->server
1302 && assoc->server->cql_transform)
1305 bsrr->scanClause = 0;
1306 bsrr->attributeset = 0;
1307 bsrr->term = (Z_AttributesPlusTerm *)
1308 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1309 srw_error = cql2pqf_scan(assoc->encode,
1310 srw_req->scanClause.cql,
1311 assoc->server->cql_transform,
1314 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1315 &srw_res->num_diagnostics,
1319 ((int (*)(void *, bend_scan_rr *))
1320 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1323 else if (srw_req->query_type == Z_SRW_query_type_cql
1324 && assoc->init->bend_srw_scan)
1327 bsrr->attributeset = 0;
1328 bsrr->scanClause = srw_req->scanClause.cql;
1329 ((int (*)(void *, bend_scan_rr *))
1330 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1334 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1335 &srw_res->num_diagnostics,
1336 YAZ_SRW_UNSUPP_OPERATION, "scan");
1341 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1346 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1348 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1349 &srw_res->num_diagnostics,
1350 srw_error, bsrr->errstring);
1352 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1355 srw_res->terms = (Z_SRW_scanTerm*)
1356 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1359 srw_res->num_terms = bsrr->num_entries;
1360 for (i = 0; i<bsrr->num_entries; i++)
1362 Z_SRW_scanTerm *t = srw_res->terms + i;
1363 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1364 t->numberOfRecords =
1365 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1367 if (save_entries == bsrr->entries &&
1368 bsrr->entries[i].display_term)
1370 /* the entries was _not_ set by the handler. So it's
1371 safe to test for new member display_term. It is
1374 t->displayTerm = odr_strdup(assoc->encode,
1375 bsrr->entries[i].display_term);
1383 WRBUF wr = wrbuf_alloc();
1384 const char *querytype = 0;
1385 const char *querystr = 0;
1387 switch(srw_req->query_type)
1389 case Z_SRW_query_type_pqf:
1391 querystr = srw_req->scanClause.pqf;
1393 case Z_SRW_query_type_cql:
1395 querystr = srw_req->scanClause.cql;
1398 querytype = "UNKNOWN";
1402 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1404 if (srw_res->num_diagnostics)
1405 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1406 else if (srw_res->num_terms)
1407 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1409 wrbuf_printf(wr, "OK - - ");
1411 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1412 (srw_req->responsePosition ?
1413 *srw_req->responsePosition : 1),
1414 (srw_req->maximumTerms ?
1415 *srw_req->maximumTerms : 1));
1416 /* there is no step size in SRU/W ??? */
1417 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1418 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1424 static void srw_bend_update(association *assoc, request *req,
1426 Z_SRW_updateResponse *srw_res,
1429 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1430 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1431 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1433 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1437 Z_SRW_extra_record *extra = srw_req->extra_record;
1439 rr.stream = assoc->encode;
1440 rr.print = assoc->print;
1442 rr.basenames = &srw_req->database;
1443 rr.operation = srw_req->operation;
1444 rr.operation_status = "failed";
1446 rr.record_versions = 0;
1447 rr.num_versions = 0;
1448 rr.record_packing = "string";
1449 rr.record_schema = 0;
1451 rr.extra_record_data = 0;
1452 rr.extra_request_data = 0;
1453 rr.extra_response_data = 0;
1459 if (rr.operation == 0)
1461 yaz_add_sru_update_diagnostic(
1462 assoc->encode, &srw_res->diagnostics,
1463 &srw_res->num_diagnostics,
1464 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1468 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1469 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1470 if (!strcmp( rr.operation, "delete"))
1472 if (srw_req->record && !srw_req->record->recordSchema)
1474 rr.record_schema = odr_strdup(
1476 srw_req->record->recordSchema);
1478 if (srw_req->record)
1480 rr.record_data = odr_strdupn(
1482 srw_req->record->recordData_buf,
1483 srw_req->record->recordData_len );
1485 if (extra && extra->extraRecordData_len)
1487 rr.extra_record_data = odr_strdupn(
1489 extra->extraRecordData_buf,
1490 extra->extraRecordData_len );
1492 if (srw_req->recordId)
1493 rr.record_id = srw_req->recordId;
1494 else if (extra && extra->recordIdentifier)
1495 rr.record_id = extra->recordIdentifier;
1497 else if (!strcmp(rr.operation, "replace"))
1499 if (srw_req->recordId)
1500 rr.record_id = srw_req->recordId;
1501 else if (extra && extra->recordIdentifier)
1502 rr.record_id = extra->recordIdentifier;
1505 yaz_add_sru_update_diagnostic(
1506 assoc->encode, &srw_res->diagnostics,
1507 &srw_res->num_diagnostics,
1508 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1509 "recordIdentifier");
1511 if (!srw_req->record)
1513 yaz_add_sru_update_diagnostic(
1514 assoc->encode, &srw_res->diagnostics,
1515 &srw_res->num_diagnostics,
1516 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1521 if (srw_req->record->recordSchema)
1522 rr.record_schema = odr_strdup(
1523 assoc->encode, srw_req->record->recordSchema);
1524 if (srw_req->record->recordData_len )
1526 rr.record_data = odr_strdupn(assoc->encode,
1527 srw_req->record->recordData_buf,
1528 srw_req->record->recordData_len );
1532 yaz_add_sru_update_diagnostic(
1533 assoc->encode, &srw_res->diagnostics,
1534 &srw_res->num_diagnostics,
1535 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1539 if (extra && extra->extraRecordData_len)
1541 rr.extra_record_data = odr_strdupn(
1543 extra->extraRecordData_buf,
1544 extra->extraRecordData_len );
1547 else if (!strcmp(rr.operation, "insert"))
1549 if (srw_req->recordId)
1550 rr.record_id = srw_req->recordId;
1552 rr.record_id = extra->recordIdentifier;
1554 if (srw_req->record)
1556 if (srw_req->record->recordSchema)
1557 rr.record_schema = odr_strdup(
1558 assoc->encode, srw_req->record->recordSchema);
1560 if (srw_req->record->recordData_len)
1561 rr.record_data = odr_strdupn(
1563 srw_req->record->recordData_buf,
1564 srw_req->record->recordData_len );
1566 if (extra && extra->extraRecordData_len)
1568 rr.extra_record_data = odr_strdupn(
1570 extra->extraRecordData_buf,
1571 extra->extraRecordData_len );
1575 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1576 &srw_res->num_diagnostics,
1577 YAZ_SRU_UPDATE_INVALID_ACTION,
1580 if (srw_req->record)
1582 const char *pack_str =
1583 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1585 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1588 if (srw_req->num_recordVersions)
1590 rr.record_versions = srw_req->recordVersions;
1591 rr.num_versions = srw_req->num_recordVersions;
1593 if (srw_req->extraRequestData_len)
1595 rr.extra_request_data = odr_strdupn(assoc->encode,
1596 srw_req->extraRequestData_buf,
1597 srw_req->extraRequestData_len );
1599 if (srw_res->num_diagnostics == 0)
1601 if ( assoc->init->bend_srw_update)
1602 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1604 yaz_add_sru_update_diagnostic(
1605 assoc->encode, &srw_res->diagnostics,
1606 &srw_res->num_diagnostics,
1607 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1608 "No Update backend handler");
1612 yaz_add_srw_diagnostic_uri(assoc->encode,
1613 &srw_res->diagnostics,
1614 &srw_res->num_diagnostics,
1618 srw_res->recordId = rr.record_id;
1619 srw_res->operationStatus = rr.operation_status;
1620 srw_res->recordVersions = rr.record_versions;
1621 srw_res->num_recordVersions = rr.num_versions;
1622 if (srw_res->extraResponseData_len)
1624 srw_res->extraResponseData_buf = rr.extra_response_data;
1625 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1627 if (srw_res->num_diagnostics == 0 && rr.record_data)
1629 srw_res->record = yaz_srw_get_record(assoc->encode);
1630 srw_res->record->recordSchema = rr.record_schema;
1631 if (rr.record_packing)
1633 int pack = yaz_srw_str_to_pack(rr.record_packing);
1637 pack = Z_SRW_recordPacking_string;
1638 yaz_log(YLOG_WARN, "Back packing %s from backend",
1641 srw_res->record->recordPacking = pack;
1643 srw_res->record->recordData_buf = rr.record_data;
1644 srw_res->record->recordData_len = strlen(rr.record_data);
1645 if (rr.extra_record_data)
1647 Z_SRW_extra_record *ex =
1648 yaz_srw_get_extra_record(assoc->encode);
1649 srw_res->extra_record = ex;
1650 ex->extraRecordData_buf = rr.extra_record_data;
1651 ex->extraRecordData_len = strlen(rr.extra_record_data);
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, size_t *sz)
1670 FILE *inf = fopen(fname, "rb");
1674 fseek(inf, 0L, SEEK_END);
1677 buf = (char *) odr_malloc(o, *sz);
1678 if (fread(buf, 1, *sz, inf) != *sz)
1679 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1684 static void process_http_request(association *assoc, request *req)
1686 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1687 ODR o = assoc->encode;
1688 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1690 Z_SOAP *soap_package = 0;
1693 Z_HTTP_Response *hres = 0;
1695 const char *stylesheet = 0; /* for now .. set later */
1696 Z_SRW_diagnostic *diagnostic = 0;
1697 int num_diagnostic = 0;
1698 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1700 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1701 if (!control_association(assoc, host, 0))
1703 p = z_get_HTTP_Response(o, 404);
1706 if (r == 2 && assoc->server && assoc->server->docpath
1707 && hreq->path[0] == '/'
1709 /* check if path is a proper prefix of documentroot */
1710 strncmp(hreq->path+1, assoc->server->docpath,
1711 strlen(assoc->server->docpath))
1714 if (!check_path(hreq->path))
1716 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1717 p = z_get_HTTP_Response(o, 404);
1721 size_t content_size = 0;
1722 char *content_buf = read_file(hreq->path+1, o, &content_size);
1725 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1726 p = z_get_HTTP_Response(o, 404);
1730 const char *ctype = 0;
1731 yaz_mime_types types = yaz_mime_types_create();
1733 yaz_mime_types_add(types, "xsl", "application/xml");
1734 yaz_mime_types_add(types, "xml", "application/xml");
1735 yaz_mime_types_add(types, "css", "text/css");
1736 yaz_mime_types_add(types, "html", "text/html");
1737 yaz_mime_types_add(types, "htm", "text/html");
1738 yaz_mime_types_add(types, "txt", "text/plain");
1739 yaz_mime_types_add(types, "js", "application/x-javascript");
1741 yaz_mime_types_add(types, "gif", "image/gif");
1742 yaz_mime_types_add(types, "png", "image/png");
1743 yaz_mime_types_add(types, "jpg", "image/jpeg");
1744 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1746 ctype = yaz_mime_lookup_fname(types, hreq->path);
1749 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1750 p = z_get_HTTP_Response(o, 404);
1754 p = z_get_HTTP_Response(o, 200);
1755 hres = p->u.HTTP_Response;
1756 hres->content_buf = content_buf;
1757 hres->content_len = content_size;
1758 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1760 yaz_mime_types_destroy(types);
1768 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1769 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1771 if (r == 2) /* not taken */
1773 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1774 &diagnostic, &num_diagnostic);
1775 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1777 if (r == 0) /* decode SRW/SRU OK .. */
1779 int http_code = 200;
1780 if (sr->which == Z_SRW_searchRetrieve_request)
1783 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1785 stylesheet = sr->u.request->stylesheet;
1788 res->u.response->diagnostics = diagnostic;
1789 res->u.response->num_diagnostics = num_diagnostic;
1793 srw_bend_search(assoc, req, sr, res, &http_code);
1795 if (http_code == 200)
1796 soap_package->u.generic->p = res;
1798 else if (sr->which == Z_SRW_explain_request)
1800 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1802 stylesheet = sr->u.explain_request->stylesheet;
1805 res->u.explain_response->diagnostics = diagnostic;
1806 res->u.explain_response->num_diagnostics = num_diagnostic;
1808 srw_bend_explain(assoc, req, sr,
1809 res->u.explain_response, &http_code);
1810 if (http_code == 200)
1811 soap_package->u.generic->p = res;
1813 else if (sr->which == Z_SRW_scan_request)
1815 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1817 stylesheet = sr->u.scan_request->stylesheet;
1820 res->u.scan_response->diagnostics = diagnostic;
1821 res->u.scan_response->num_diagnostics = num_diagnostic;
1823 srw_bend_scan(assoc, req, sr,
1824 res->u.scan_response, &http_code);
1825 if (http_code == 200)
1826 soap_package->u.generic->p = res;
1828 else if (sr->which == Z_SRW_update_request)
1830 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1832 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1835 res->u.update_response->diagnostics = diagnostic;
1836 res->u.update_response->num_diagnostics = num_diagnostic;
1838 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1839 srw_bend_update(assoc, req, sr,
1840 res->u.update_response, &http_code);
1841 if (http_code == 200)
1842 soap_package->u.generic->p = res;
1846 yaz_log(log_request, "SOAP ERROR");
1847 /* FIXME - what error, what query */
1849 z_soap_error(assoc->encode, soap_package,
1850 "SOAP-ENV:Client", "Bad method", 0);
1852 if (http_code == 200 || http_code == 500)
1854 static Z_SOAP_Handler soap_handlers[4] = {
1856 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1857 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1858 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1864 p = z_get_HTTP_Response(o, 200);
1865 hres = p->u.HTTP_Response;
1867 if (!stylesheet && assoc->server)
1868 stylesheet = assoc->server->stylesheet;
1870 /* empty stylesheet means NO stylesheet */
1871 if (stylesheet && *stylesheet == '\0')
1874 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1875 &hres->content_buf, &hres->content_len,
1876 soap_handlers, charset, stylesheet);
1877 hres->code = http_code;
1879 strcpy(ctype, "text/xml");
1880 if (charset && strlen(charset) < sizeof(ctype)-30)
1882 strcat(ctype, "; charset=");
1883 strcat(ctype, charset);
1885 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1888 p = z_get_HTTP_Response(o, http_code);
1892 p = z_get_HTTP_Response(o, 500);
1893 hres = p->u.HTTP_Response;
1894 if (!strcmp(hreq->version, "1.0"))
1896 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1897 if (v && !strcmp(v, "Keep-Alive"))
1901 hres->version = "1.0";
1905 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1906 if (v && !strcmp(v, "close"))
1910 hres->version = "1.1";
1914 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1915 assoc->state = ASSOC_DEAD;
1916 assoc->cs_get_mask = 0;
1921 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1923 if (alive && isdigit(*(const unsigned char *) alive))
1927 if (t < 0 || t > 3600)
1929 iochan_settimeout(assoc->client_chan,t);
1930 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1932 process_gdu_response(assoc, req, p);
1935 static void process_gdu_request(association *assoc, request *req)
1937 if (req->gdu_request->which == Z_GDU_Z3950)
1940 req->apdu_request = req->gdu_request->u.z3950;
1941 if (process_z_request(assoc, req, &msg) < 0)
1942 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1944 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1945 process_http_request(assoc, req);
1948 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1953 * Initiate request processing.
1955 static int process_z_request(association *assoc, request *req, char **msg)
1961 *msg = "Unknown Error";
1962 assert(req && req->state == REQUEST_IDLE);
1963 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1965 *msg = "Missing InitRequest";
1968 switch (req->apdu_request->which)
1970 case Z_APDU_initRequest:
1971 res = process_initRequest(assoc, req); break;
1972 case Z_APDU_searchRequest:
1973 res = process_searchRequest(assoc, req, &fd); break;
1974 case Z_APDU_presentRequest:
1975 res = process_presentRequest(assoc, req, &fd); break;
1976 case Z_APDU_scanRequest:
1977 if (assoc->init->bend_scan)
1978 res = process_scanRequest(assoc, req, &fd);
1981 *msg = "Cannot handle Scan APDU";
1985 case Z_APDU_extendedServicesRequest:
1986 if (assoc->init->bend_esrequest)
1987 res = process_ESRequest(assoc, req, &fd);
1990 *msg = "Cannot handle Extended Services APDU";
1994 case Z_APDU_sortRequest:
1995 if (assoc->init->bend_sort)
1996 res = process_sortRequest(assoc, req, &fd);
1999 *msg = "Cannot handle Sort APDU";
2004 process_close(assoc, req);
2006 case Z_APDU_deleteResultSetRequest:
2007 if (assoc->init->bend_delete)
2008 res = process_deleteRequest(assoc, req, &fd);
2011 *msg = "Cannot handle Delete APDU";
2015 case Z_APDU_segmentRequest:
2016 if (assoc->init->bend_segment)
2018 res = process_segmentRequest(assoc, req);
2022 *msg = "Cannot handle Segment APDU";
2026 case Z_APDU_triggerResourceControlRequest:
2029 *msg = "Bad APDU received";
2034 yaz_log(YLOG_DEBUG, " result immediately available");
2035 retval = process_z_response(assoc, req, res);
2039 yaz_log(YLOG_DEBUG, " result unavailble");
2042 else /* no result yet - one will be provided later */
2046 /* Set up an I/O handler for the fd supplied by the backend */
2048 yaz_log(YLOG_DEBUG, " establishing handler for result");
2049 req->state = REQUEST_PENDING;
2050 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2052 iochan_setdata(chan, assoc);
2059 * Handle message from the backend.
2061 void backend_response(IOCHAN i, int event)
2063 association *assoc = (association *)iochan_getdata(i);
2064 request *req = request_head(&assoc->incoming);
2068 yaz_log(YLOG_DEBUG, "backend_response");
2069 assert(assoc && req && req->state != REQUEST_IDLE);
2070 /* determine what it is we're waiting for */
2071 switch (req->apdu_request->which)
2073 case Z_APDU_searchRequest:
2074 res = response_searchRequest(assoc, req, 0, &fd); break;
2076 case Z_APDU_presentRequest:
2077 res = response_presentRequest(assoc, req, 0, &fd); break;
2078 case Z_APDU_scanRequest:
2079 res = response_scanRequest(assoc, req, 0, &fd); break;
2082 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2085 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2087 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2088 do_close(assoc, Z_Close_systemProblem, 0);
2092 else if (!res) /* no result yet - try again later */
2094 yaz_log(YLOG_DEBUG, " no result yet");
2095 iochan_setfd(i, fd); /* in case fd has changed */
2100 * Encode response, and transfer the request structure to the outgoing queue.
2102 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2104 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2108 if (!z_GDU(assoc->print, &res, 0, 0))
2109 yaz_log(YLOG_WARN, "ODR print error: %s",
2110 odr_errmsg(odr_geterror(assoc->print)));
2111 odr_reset(assoc->print);
2113 if (!z_GDU(assoc->encode, &res, 0, 0))
2115 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2116 odr_errmsg(odr_geterror(assoc->decode)),
2117 odr_getelement(assoc->decode));
2120 req->response = odr_getbuf(assoc->encode, &req->len_response,
2121 &req->size_response);
2122 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2123 odr_reset(assoc->encode);
2124 req->state = REQUEST_IDLE;
2125 request_enq(&assoc->outgoing, req);
2126 /* turn the work over to the ir_session handler */
2127 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2128 assoc->cs_put_mask = EVENT_OUTPUT;
2129 /* Is there more work to be done? give that to the input handler too */
2132 req = request_head(&assoc->incoming);
2133 if (req && req->state == REQUEST_IDLE)
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_oid(&otherInfo, yaz_oid_userinfo_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;
2175 statserv_options_block *cb = 0; /* by default no control for backend */
2177 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2178 cb = statserv_getcontrol(); /* got control block for backend */
2180 if (cb && assoc->backend)
2181 (*cb->bend_close)(assoc->backend);
2183 yaz_log(log_requestdetail, "Got initRequest");
2184 if (req->implementationId)
2185 yaz_log(log_requestdetail, "Id: %s",
2186 req->implementationId);
2187 if (req->implementationName)
2188 yaz_log(log_requestdetail, "Name: %s",
2189 req->implementationName);
2190 if (req->implementationVersion)
2191 yaz_log(log_requestdetail, "Version: %s",
2192 req->implementationVersion);
2194 assoc_init_reset(assoc);
2196 assoc->init->auth = req->idAuthentication;
2197 assoc->init->referenceId = req->referenceId;
2199 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2201 Z_CharSetandLanguageNegotiation *negotiation =
2202 yaz_get_charneg_record (req->otherInfo);
2204 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2205 assoc->init->charneg_request = negotiation;
2208 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2209 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2210 assoc->init->named_result_sets = 1;
2215 if (req->implementationVersion)
2216 yaz_log(log_requestdetail, "Config: %s",
2219 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2221 /* we have a backend control block, so call that init function */
2222 if (!(binitres = (*cb->bend_init)(assoc->init)))
2224 yaz_log(YLOG_WARN, "Bad response from backend.");
2227 assoc->backend = binitres->handle;
2231 /* no backend. return error */
2232 binitres = (bend_initresult *)
2233 odr_malloc(assoc->encode, sizeof(*binitres));
2234 binitres->errstring = 0;
2235 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2236 iochan_settimeout(assoc->client_chan, 10);
2238 if ((assoc->init->bend_sort))
2239 yaz_log(YLOG_DEBUG, "Sort handler installed");
2240 if ((assoc->init->bend_search))
2241 yaz_log(YLOG_DEBUG, "Search handler installed");
2242 if ((assoc->init->bend_present))
2243 yaz_log(YLOG_DEBUG, "Present handler installed");
2244 if ((assoc->init->bend_esrequest))
2245 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2246 if ((assoc->init->bend_delete))
2247 yaz_log(YLOG_DEBUG, "Delete handler installed");
2248 if ((assoc->init->bend_scan))
2249 yaz_log(YLOG_DEBUG, "Scan handler installed");
2250 if ((assoc->init->bend_segment))
2251 yaz_log(YLOG_DEBUG, "Segment handler installed");
2253 resp->referenceId = req->referenceId;
2255 /* let's tell the client what we can do */
2256 if (ODR_MASK_GET(req->options, Z_Options_search))
2258 ODR_MASK_SET(resp->options, Z_Options_search);
2259 strcat(options, "srch");
2261 if (ODR_MASK_GET(req->options, Z_Options_present))
2263 ODR_MASK_SET(resp->options, Z_Options_present);
2264 strcat(options, " prst");
2266 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2267 assoc->init->bend_delete)
2269 ODR_MASK_SET(resp->options, Z_Options_delSet);
2270 strcat(options, " del");
2272 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2273 assoc->init->bend_esrequest)
2275 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2276 strcat(options, " extendedServices");
2278 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2279 && assoc->init->named_result_sets)
2281 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2282 strcat(options, " namedresults");
2284 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2286 ODR_MASK_SET(resp->options, Z_Options_scan);
2287 strcat(options, " scan");
2289 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2291 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2292 strcat(options, " concurrop");
2294 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2296 ODR_MASK_SET(resp->options, Z_Options_sort);
2297 strcat(options, " sort");
2300 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2302 Z_OtherInformationUnit *p0;
2304 if (!assoc->init->charneg_response)
2306 if (assoc->init->query_charset)
2308 assoc->init->charneg_response = yaz_set_response_charneg(
2309 assoc->encode, assoc->init->query_charset, 0,
2310 assoc->init->records_in_same_charset);
2314 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2317 if (assoc->init->charneg_response
2318 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2320 p0->which = Z_OtherInfo_externallyDefinedInfo;
2321 p0->information.externallyDefinedInfo =
2322 assoc->init->charneg_response;
2323 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2324 strcat(options, " negotiation");
2327 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2328 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2330 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2332 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2333 assoc->version = 1; /* 1 & 2 are equivalent */
2335 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2337 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2340 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2342 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2346 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2348 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2349 assoc->maximumRecordSize = *req->maximumRecordSize;
2351 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2352 assoc->preferredMessageSize = *req->preferredMessageSize;
2354 resp->preferredMessageSize = &assoc->preferredMessageSize;
2355 resp->maximumRecordSize = &assoc->maximumRecordSize;
2357 resp->implementationId = odr_prepend(assoc->encode,
2358 assoc->init->implementation_id,
2359 resp->implementationId);
2361 resp->implementationName = odr_prepend(assoc->encode,
2362 assoc->init->implementation_name,
2363 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2365 if (binitres->errcode)
2367 assoc->state = ASSOC_DEAD;
2368 resp->userInformationField =
2369 init_diagnostics(assoc->encode, binitres->errcode,
2370 binitres->errstring);
2374 assoc->state = ASSOC_UP;
2378 if (!req->idAuthentication)
2379 yaz_log(log_request, "Auth none");
2380 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2382 const char *open = req->idAuthentication->u.open;
2383 const char *slash = strchr(open, '/');
2389 yaz_log(log_request, "Auth open %.*s", len, open);
2391 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2393 const char *user = req->idAuthentication->u.idPass->userId;
2394 const char *group = req->idAuthentication->u.idPass->groupId;
2395 yaz_log(log_request, "Auth idPass %s %s",
2396 user ? user : "-", group ? group : "-");
2398 else if (req->idAuthentication->which
2399 == Z_IdAuthentication_anonymous)
2401 yaz_log(log_request, "Auth anonymous");
2405 yaz_log(log_request, "Auth other");
2410 WRBUF wr = wrbuf_alloc();
2411 wrbuf_printf(wr, "Init ");
2412 if (binitres->errcode)
2413 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2415 wrbuf_printf(wr, "OK -");
2416 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2417 (req->implementationId ? req->implementationId :"-"),
2418 (req->implementationName ?
2419 req->implementationName : "-"),
2420 (req->implementationVersion ?
2421 req->implementationVersion : "-")
2423 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2430 * Set the specified `errcode' and `errstring' into a UserInfo-1
2431 * external to be returned to the client in accordance with Z35.90
2432 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2433 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2435 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2437 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2438 addinfo ? " -- " : "", addinfo ? addinfo : "");
2439 return zget_init_diagnostics(odr, error, addinfo);
2443 * nonsurrogate diagnostic record.
2445 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2447 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2449 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2450 addinfo ? " -- " : "", addinfo ? addinfo : "");
2452 rec->which = Z_Records_NSD;
2453 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2459 * surrogate diagnostic.
2461 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2463 int error, const char *addinfo)
2465 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2466 addinfo ? " -- " : "", addinfo ? addinfo : "");
2467 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2470 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2471 Odr_int *num, Z_RecordComposition *comp,
2472 Odr_int *next, Odr_int *pres,
2473 Z_ReferenceId *referenceId,
2474 Odr_oid *oid, int *errcode)
2476 int recno, total_length = 0, toget = *num, dumped_records = 0;
2477 Z_Records *records =
2478 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2479 Z_NamePlusRecordList *reclist =
2480 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2481 Z_NamePlusRecord **list =
2482 (Z_NamePlusRecord **) odr_malloc(a->encode, sizeof(*list) * toget);
2484 records->which = Z_Records_DBOSD;
2485 records->u.databaseOrSurDiagnostics = reclist;
2486 reclist->num_records = 0;
2487 reclist->records = list;
2488 *pres = Z_PresentStatus_success;
2492 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2493 yaz_log(log_requestdetail, "pms=" ODR_INT_PRINTF
2494 ", mrs=" ODR_INT_PRINTF, a->preferredMessageSize,
2495 a->maximumRecordSize);
2496 for (recno = start; reclist->num_records < toget; recno++)
2499 Z_NamePlusRecord *thisrec;
2500 int this_length = 0;
2502 * we get the number of bytes allocated on the stream before any
2503 * allocation done by the backend - this should give us a reasonable
2504 * idea of the total size of the data so far.
2506 total_length = odr_total(a->encode) - dumped_records;
2512 freq.last_in_set = 0;
2513 freq.setname = setname;
2514 freq.surrogate_flag = 0;
2515 freq.number = recno;
2517 freq.request_format = oid;
2518 freq.output_format = 0;
2519 freq.stream = a->encode;
2520 freq.print = a->print;
2521 freq.referenceId = referenceId;
2524 retrieve_fetch(a, &freq);
2526 *next = freq.last_in_set ? 0 : recno + 1;
2530 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2533 *pres = Z_PresentStatus_failure;
2534 /* for 'present request out of range',
2535 set addinfo to record position if not set */
2536 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2537 freq.errstring == 0)
2539 sprintf (s, "%d", recno);
2543 *errcode = freq.errcode;
2544 return diagrec(a, freq.errcode, freq.errstring);
2546 reclist->records[reclist->num_records] =
2547 surrogatediagrec(a, freq.basename, freq.errcode,
2549 reclist->num_records++;
2552 if (freq.record == 0) /* no error and no record ? */
2554 *next = 0; /* signal end-of-set and stop */
2558 this_length = freq.len;
2560 this_length = odr_total(a->encode) - total_length - dumped_records;
2561 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2562 this_length, total_length, dumped_records);
2563 if (a->preferredMessageSize > 0 &&
2564 this_length + total_length > a->preferredMessageSize)
2566 /* record is small enough, really */
2567 if (this_length <= a->preferredMessageSize && recno > start)
2569 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2570 *pres = Z_PresentStatus_partial_2;
2573 /* record can only be fetched by itself */
2574 if (this_length < a->maximumRecordSize)
2576 yaz_log(log_requestdetail, " Record > prefmsgsz");
2579 yaz_log(YLOG_DEBUG, " Dropped it");
2580 reclist->records[reclist->num_records] =
2581 surrogatediagrec(a, freq.basename, 16, 0);
2582 reclist->num_records++;
2583 dumped_records += this_length;
2587 else /* too big entirely */
2589 yaz_log(log_requestdetail, "Record > maxrcdsz "
2590 "this=%d max=" ODR_INT_PRINTF,
2591 this_length, a->maximumRecordSize);
2592 reclist->records[reclist->num_records] =
2593 surrogatediagrec(a, freq.basename, 17, 0);
2594 reclist->num_records++;
2595 dumped_records += this_length;
2600 if (!(thisrec = (Z_NamePlusRecord *)
2601 odr_malloc(a->encode, sizeof(*thisrec))))
2603 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2604 thisrec->which = Z_NamePlusRecord_databaseRecord;
2606 if (!freq.output_format)
2607 freq.output_format = freq.request_format;
2608 thisrec->u.databaseRecord = z_ext_record_oid(
2609 a->encode, freq.output_format, 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 bsrr->srw_sortKeys = 0;
2632 bsrr->srw_setname = 0;
2633 bsrr->srw_setnameIdleTime = 0;
2634 bsrr->estimated_hit_count = 0;
2635 bsrr->partial_resultset = 0;
2636 bsrr->extra_args = 0;
2637 bsrr->extra_response_data = 0;
2639 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2640 if (req->databaseNames)
2643 for (i = 0; i < req->num_databaseNames; i++)
2644 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2647 yaz_log_zquery_level(log_requestdetail,req->query);
2649 if (assoc->init->bend_search)
2651 bsrr->setname = req->resultSetName;
2652 bsrr->replace_set = *req->replaceIndicator;
2653 bsrr->num_bases = req->num_databaseNames;
2654 bsrr->basenames = req->databaseNames;
2655 bsrr->query = req->query;
2656 bsrr->stream = assoc->encode;
2657 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2658 bsrr->decode = assoc->decode;
2659 bsrr->print = assoc->print;
2662 bsrr->errstring = NULL;
2663 bsrr->search_info = NULL;
2665 if (assoc->server && assoc->server->cql_transform
2666 && req->query->which == Z_Query_type_104
2667 && req->query->u.type_104->which == Z_External_CQL)
2669 /* have a CQL query and a CQL to PQF transform .. */
2671 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2672 assoc->server->cql_transform, bsrr->query);
2674 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2677 if (assoc->server && assoc->server->ccl_transform
2678 && req->query->which == Z_Query_type_2) /*CCL*/
2680 /* have a CCL query and a CCL to PQF transform .. */
2682 ccl2pqf(bsrr->stream, req->query->u.type_2,
2683 assoc->server->ccl_transform, bsrr);
2685 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2689 (assoc->init->bend_search)(assoc->backend, bsrr);
2690 if (!bsrr->request) /* backend not ready with the search response */
2691 return 0; /* should not be used any more */
2695 /* FIXME - make a diagnostic for it */
2696 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2698 return response_searchRequest(assoc, reqb, bsrr, fd);
2701 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2704 * Prepare a searchresponse based on the backend results. We probably want
2705 * to look at making the fetching of records nonblocking as well, but
2706 * so far, we'll keep things simple.
2707 * If bsrt is null, that means we're called in response to a communications
2708 * event, and we'll have to get the response for ourselves.
2710 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2711 bend_search_rr *bsrt, int *fd)
2713 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2714 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2715 Z_SearchResponse *resp = (Z_SearchResponse *)
2716 odr_malloc(assoc->encode, sizeof(*resp));
2717 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2718 Odr_int *next = odr_intdup(assoc->encode, 0);
2719 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2720 int returnedrecs = 0;
2722 apdu->which = Z_APDU_searchResponse;
2723 apdu->u.searchResponse = resp;
2724 resp->referenceId = req->referenceId;
2725 resp->additionalSearchInfo = 0;
2726 resp->otherInfo = 0;
2728 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2730 yaz_log(YLOG_FATAL, "Bad result from backend");
2733 else if (bsrt->errcode)
2735 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2736 resp->resultCount = nulint;
2737 resp->numberOfRecordsReturned = nulint;
2738 resp->nextResultSetPosition = nulint;
2739 resp->searchStatus = odr_booldup(assoc->encode, 0);
2740 resp->resultSetStatus = none;
2741 resp->presentStatus = 0;
2745 bool_t *sr = odr_booldup(assoc->encode, 1);
2746 Odr_int *toget = odr_intdup(assoc->encode, 0);
2747 Z_RecordComposition comp, *compp = 0;
2749 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2752 resp->resultCount = &bsrt->hits;
2754 comp.which = Z_RecordComp_simple;
2755 /* how many records does the user agent want, then? */
2758 else 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 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3370 bend_segment_rr req;
3372 req.segment = reqb->apdu_request->u.segmentRequest;
3373 req.stream = assoc->encode;
3374 req.decode = assoc->decode;
3375 req.print = assoc->print;
3376 req.association = assoc;
3378 (*assoc->init->bend_segment)(assoc->backend, &req);
3383 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3385 bend_esrequest_rr esrequest;
3386 const char *ext_name = "unknown";
3388 Z_ExtendedServicesRequest *req =
3389 reqb->apdu_request->u.extendedServicesRequest;
3390 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3392 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3394 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3395 esrequest.stream = assoc->encode;
3396 esrequest.decode = assoc->decode;
3397 esrequest.print = assoc->print;
3398 esrequest.errcode = 0;
3399 esrequest.errstring = NULL;
3400 esrequest.request = reqb;
3401 esrequest.association = assoc;
3402 esrequest.taskPackage = 0;
3403 esrequest.referenceId = req->referenceId;
3406 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3408 switch(esrequest.esr->taskSpecificParameters->which)
3410 case Z_External_itemOrder:
3411 ext_name = "ItemOrder"; break;
3412 case Z_External_update:
3413 ext_name = "Update"; break;
3414 case Z_External_update0:
3415 ext_name = "Update0"; break;
3416 case Z_External_ESAdmin:
3417 ext_name = "Admin"; break;
3422 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3424 /* If the response is being delayed, return NULL */
3425 if (esrequest.request == NULL)
3428 resp->referenceId = req->referenceId;
3430 if (esrequest.errcode == -1)
3432 /* Backend service indicates request will be processed */
3433 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3434 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3436 else if (esrequest.errcode == 0)
3438 /* Backend service indicates request will be processed */
3439 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3440 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3444 Z_DiagRecs *diagRecs =
3445 zget_DiagRecs(assoc->encode, esrequest.errcode,
3446 esrequest.errstring);
3447 /* Backend indicates error, request will not be processed */
3448 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3449 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3450 resp->num_diagnostics = diagRecs->num_diagRecs;
3451 resp->diagnostics = diagRecs->diagRecs;
3454 WRBUF wr = wrbuf_alloc();
3455 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3456 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3461 /* Do something with the members of bend_extendedservice */
3462 if (esrequest.taskPackage)
3464 resp->taskPackage = z_ext_record_oid(
3465 assoc->encode, yaz_oid_recsyn_extended,
3466 (const char *) esrequest.taskPackage, -1);
3468 yaz_log(YLOG_DEBUG,"Send the result apdu");
3472 int bend_assoc_is_alive(bend_association assoc)
3474 if (assoc->state == ASSOC_DEAD)
3475 return 0; /* already marked as dead. Don't check I/O chan anymore */
3477 return iochan_is_alive(assoc->client_chan);
3484 * c-file-style: "Stroustrup"
3485 * indent-tabs-mode: nil
3487 * vim: shiftwidth=4 tabstop=8 expandtab