1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2008 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(YLOG_DEBUG, "Final timeout - closing connection.");
381 /* do we need to lod this at all */
383 destroy_association(assoc);
388 yaz_log(log_sessiondetail,
389 "Session idle too long. Sending close.");
390 do_close(assoc, Z_Close_lackOfActivity, 0);
394 if (event & assoc->cs_accept_mask)
396 if (!cs_accept (conn))
398 yaz_log (YLOG_WARN, "accept failed");
399 destroy_association(assoc);
402 iochan_clearflag (h, EVENT_OUTPUT);
403 if (conn->io_pending)
404 { /* cs_accept didn't complete */
405 assoc->cs_accept_mask =
406 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
407 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
409 iochan_setflag (h, assoc->cs_accept_mask);
412 { /* cs_accept completed. Prepare for reading (cs_get) */
413 assoc->cs_accept_mask = 0;
414 assoc->cs_get_mask = EVENT_INPUT;
415 iochan_setflag (h, assoc->cs_get_mask);
419 if (event & assoc->cs_get_mask) /* input */
421 if (!ir_read(h, event))
423 req = request_head(&assoc->incoming);
424 if (req->state == REQUEST_IDLE)
426 request_deq(&assoc->incoming);
427 process_gdu_request(assoc, req);
430 if (event & assoc->cs_put_mask)
432 request *req = request_head(&assoc->outgoing);
434 assoc->cs_put_mask = 0;
435 yaz_log(YLOG_DEBUG, "ir_session (output)");
436 req->state = REQUEST_PENDING;
437 switch (res = cs_put(conn, req->response, req->len_response))
440 yaz_log(log_sessiondetail, "Connection closed by client");
442 destroy_association(assoc);
445 case 0: /* all sent - release the request structure */
446 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
448 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
451 nmem_destroy(req->request_mem);
452 request_deq(&assoc->outgoing);
453 request_release(req);
454 if (!request_head(&assoc->outgoing))
455 { /* restore mask for cs_get operation ... */
456 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
457 iochan_setflag(h, assoc->cs_get_mask);
458 if (assoc->state == ASSOC_DEAD)
459 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
463 assoc->cs_put_mask = EVENT_OUTPUT;
467 if (conn->io_pending & CS_WANT_WRITE)
468 assoc->cs_put_mask |= EVENT_OUTPUT;
469 if (conn->io_pending & CS_WANT_READ)
470 assoc->cs_put_mask |= EVENT_INPUT;
471 iochan_setflag(h, assoc->cs_put_mask);
474 if (event & EVENT_EXCEPT)
476 yaz_log(YLOG_WARN, "ir_session (exception)");
478 destroy_association(assoc);
483 static int process_z_request(association *assoc, request *req, char **msg);
486 static void assoc_init_reset(association *assoc)
489 assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
491 assoc->init->stream = assoc->encode;
492 assoc->init->print = assoc->print;
493 assoc->init->auth = 0;
494 assoc->init->referenceId = 0;
495 assoc->init->implementation_version = 0;
496 assoc->init->implementation_id = 0;
497 assoc->init->implementation_name = 0;
498 assoc->init->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;
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);
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 const char *message = yaz_diag_srw_str(code);
741 len += strlen(message);
743 len += strlen(rr.errstring);
745 record->recordData_buf = (char *) odr_malloc(o, len);
747 sprintf(record->recordData_buf, "<diagnostic "
748 "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
749 " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
751 sprintf(record->recordData_buf + strlen(record->recordData_buf),
752 " <details>%s</details>\n", rr.errstring);
754 sprintf(record->recordData_buf + strlen(record->recordData_buf),
755 " <message>%s</message>\n", message);
756 sprintf(record->recordData_buf + strlen(record->recordData_buf),
758 record->recordData_len = strlen(record->recordData_buf);
759 record->recordPosition = odr_intdup(o, pos);
760 record->recordSchema = "info:srw/schema/1/diagnostics-v1.1";
763 else if (rr.len >= 0)
765 record->recordData_buf = rr.record;
766 record->recordData_len = rr.len;
767 record->recordPosition = odr_intdup(o, pos);
768 record->recordSchema = odr_strdup_null(o, rr.schema);
772 *addinfo = rr.errstring;
778 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
779 Z_Query *query_result)
781 /* have a CQL query and CQL to PQF transform .. */
782 CQL_parser cp = cql_parser_create();
788 r = cql_parser_string(cp, cql);
791 /* CQL syntax error */
797 r = cql_transform_buf(ct,
798 cql_parser_result(cp),
799 rpn_buf, sizeof(rpn_buf)-1);
801 srw_errcode = cql_transform_error(ct, &add);
805 /* Syntax & transform OK. */
806 /* Convert PQF string to Z39.50 to RPN query struct */
807 YAZ_PQF_Parser pp = yaz_pqf_create();
808 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
813 int code = yaz_pqf_error(pp, &pqf_msg, &off);
814 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
820 query_result->which = Z_Query_type_1;
821 query_result->u.type_1 = rpnquery;
825 cql_parser_destroy(cp);
829 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
830 Z_AttributesPlusTerm *result)
834 int srw_error = cql2pqf(odr, cql, ct, &query);
837 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
838 return 10; /* bad query type */
839 rpn = query.u.type_1;
840 if (!rpn->RPNStructure)
841 return 10; /* must be structure */
842 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
843 return 10; /* must be simple */
844 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
845 return 10; /* must be attributes plus term node .. */
846 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
852 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
853 bend_search_rr *bsrr) {
855 struct ccl_rpn_node *node;
858 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
859 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0) {
860 bsrr->errstring = (char*) ccl_err_msg(errcode);
861 return 10; /* Query syntax error */
864 bsrr->query->which = Z_Query_type_1;
865 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
870 static void srw_bend_search(association *assoc, request *req,
872 Z_SRW_searchRetrieveResponse *srw_res,
877 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
880 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
881 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
882 if (srw_res->num_diagnostics == 0 && assoc->init)
885 rr.setname = "default";
888 rr.basenames = &srw_req->database;
892 rr.srw_setnameIdleTime = 0;
893 rr.estimated_hit_count = 0;
894 rr.partial_resultset = 0;
895 rr.query = (Z_Query *) odr_malloc (assoc->decode, sizeof(*rr.query));
896 rr.query->u.type_1 = 0;
898 if (srw_req->query_type == Z_SRW_query_type_cql)
900 if (assoc->server && assoc->server->cql_transform)
902 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
903 assoc->server->cql_transform,
907 yaz_add_srw_diagnostic(assoc->encode,
908 &srw_res->diagnostics,
909 &srw_res->num_diagnostics,
915 /* CQL query to backend. Wrap it - Z39.50 style */
916 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
917 ext->direct_reference = odr_getoidbystr(assoc->decode,
918 "1.2.840.10003.16.2");
919 ext->indirect_reference = 0;
921 ext->which = Z_External_CQL;
922 ext->u.cql = srw_req->query.cql;
924 rr.query->which = Z_Query_type_104;
925 rr.query->u.type_104 = ext;
928 else if (srw_req->query_type == Z_SRW_query_type_pqf)
930 Z_RPNQuery *RPNquery;
931 YAZ_PQF_Parser pqf_parser;
933 pqf_parser = yaz_pqf_create ();
935 RPNquery = yaz_pqf_parse (pqf_parser, assoc->decode,
941 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
942 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
943 code, pqf_msg, (long) off);
944 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
947 rr.query->which = Z_Query_type_1;
948 rr.query->u.type_1 = RPNquery;
950 yaz_pqf_destroy (pqf_parser);
954 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
955 &srw_res->num_diagnostics,
956 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
958 if (rr.query->u.type_1)
960 rr.stream = assoc->encode;
961 rr.decode = assoc->decode;
962 rr.print = assoc->print;
964 if ( srw_req->sort.sortKeys )
965 rr.srw_sortKeys = odr_strdup(assoc->encode,
966 srw_req->sort.sortKeys );
967 rr.association = assoc;
973 yaz_log_zquery_level(log_requestdetail,rr.query);
975 (assoc->init->bend_search)(assoc->backend, &rr);
978 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
984 srw_error = yaz_diag_bib1_to_srw (rr.errcode);
985 yaz_add_srw_diagnostic(assoc->encode,
986 &srw_res->diagnostics,
987 &srw_res->num_diagnostics,
988 srw_error, rr.errstring);
993 int number = srw_req->maximumRecords ? *srw_req->maximumRecords : 0;
994 int start = srw_req->startRecord ? *srw_req->startRecord : 1;
996 yaz_log(log_requestdetail, "Request to pack %d+%d out of %d",
997 start, number, rr.hits);
999 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1002 srw_res->resultSetId =
1003 odr_strdup(assoc->encode, rr.srw_setname );
1004 srw_res->resultSetIdleTime =
1005 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1008 if (start > rr.hits || start < 1)
1010 /* if hits<=0 and start=1 we don't return a diagnostic */
1012 yaz_add_srw_diagnostic(
1014 &srw_res->diagnostics, &srw_res->num_diagnostics,
1015 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1017 else if (number > 0)
1021 if (start + number > rr.hits)
1022 number = rr.hits - start + 1;
1024 /* Call bend_present if defined */
1025 if (assoc->init->bend_present)
1027 bend_present_rr *bprr = (bend_present_rr*)
1028 odr_malloc (assoc->decode, sizeof(*bprr));
1029 bprr->setname = "default";
1030 bprr->start = start;
1031 bprr->number = number;
1032 if (srw_req->recordSchema)
1034 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1035 sizeof(*bprr->comp));
1036 bprr->comp->which = Z_RecordComp_simple;
1037 bprr->comp->u.simple = (Z_ElementSetNames *)
1038 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1039 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1040 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1046 bprr->stream = assoc->encode;
1047 bprr->referenceId = 0;
1048 bprr->print = assoc->print;
1049 bprr->request = req;
1050 bprr->association = assoc;
1052 bprr->errstring = NULL;
1053 (*assoc->init->bend_present)(assoc->backend, bprr);
1059 srw_error = yaz_diag_bib1_to_srw (bprr->errcode);
1060 yaz_add_srw_diagnostic(assoc->encode,
1061 &srw_res->diagnostics,
1062 &srw_res->num_diagnostics,
1063 srw_error, bprr->errstring);
1071 int packing = Z_SRW_recordPacking_string;
1072 if (srw_req->recordPacking)
1075 yaz_srw_str_to_pack(srw_req->recordPacking);
1077 packing = Z_SRW_recordPacking_string;
1079 srw_res->records = (Z_SRW_record *)
1080 odr_malloc(assoc->encode,
1081 number * sizeof(*srw_res->records));
1083 srw_res->extra_records = (Z_SRW_extra_record **)
1084 odr_malloc(assoc->encode,
1085 number*sizeof(*srw_res->extra_records));
1087 for (i = 0; i<number; i++)
1090 const char *addinfo = 0;
1092 srw_res->records[j].recordPacking = packing;
1093 srw_res->records[j].recordData_buf = 0;
1094 srw_res->extra_records[j] = 0;
1095 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1096 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1097 srw_res->records + j,
1101 yaz_add_srw_diagnostic(assoc->encode,
1102 &srw_res->diagnostics,
1103 &srw_res->num_diagnostics,
1104 yaz_diag_bib1_to_srw (errcode),
1109 if (srw_res->records[j].recordData_buf)
1112 srw_res->num_records = j;
1114 srw_res->records = 0;
1117 if (rr.estimated_hit_count || rr.partial_resultset)
1119 yaz_add_srw_diagnostic(
1121 &srw_res->diagnostics,
1122 &srw_res->num_diagnostics,
1123 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1131 const char *querystr = "?";
1132 const char *querytype = "?";
1133 WRBUF wr = wrbuf_alloc();
1135 switch (srw_req->query_type)
1137 case Z_SRW_query_type_cql:
1139 querystr = srw_req->query.cql;
1141 case Z_SRW_query_type_pqf:
1143 querystr = srw_req->query.pqf;
1146 wrbuf_printf(wr, "SRWSearch ");
1147 wrbuf_printf(wr, srw_req->database);
1148 wrbuf_printf(wr, " ");
1149 if (srw_res->num_diagnostics)
1150 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1151 else if (*http_code != 200)
1152 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1153 else if (srw_res->numberOfRecords)
1155 wrbuf_printf(wr, "OK %d",
1156 (srw_res->numberOfRecords ?
1157 *srw_res->numberOfRecords : 0));
1159 wrbuf_printf(wr, " %s %d+%d",
1160 (srw_res->resultSetId ?
1161 srw_res->resultSetId : "-"),
1162 (srw_req->startRecord ? *srw_req->startRecord : 1),
1163 srw_res->num_records);
1164 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1169 static char *srw_bend_explain_default(void *handle, bend_explain_rr *rr)
1172 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1175 for (ptr = ptr->children; ptr; ptr = ptr->next)
1177 if (ptr->type != XML_ELEMENT_NODE)
1179 if (!strcmp((const char *) ptr->name, "explain"))
1182 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1186 ptr = xmlCopyNode(ptr, 1);
1188 xmlDocSetRootElement(doc, ptr);
1190 xmlDocDumpMemory(doc, &buf_out, &len);
1191 content = (char*) odr_malloc(rr->stream, 1+len);
1192 memcpy(content, buf_out, len);
1193 content[len] = '\0';
1197 rr->explain_buf = content;
1205 static void srw_bend_explain(association *assoc, request *req,
1207 Z_SRW_explainResponse *srw_res,
1210 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1211 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1213 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1218 rr.stream = assoc->encode;
1219 rr.decode = assoc->decode;
1220 rr.print = assoc->print;
1222 rr.database = srw_req->database;
1224 rr.server_node_ptr = assoc->server->server_node_ptr;
1226 rr.server_node_ptr = 0;
1227 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1228 if (assoc->init->bend_explain)
1229 (*assoc->init->bend_explain)(assoc->backend, &rr);
1231 srw_bend_explain_default(assoc->backend, &rr);
1235 int packing = Z_SRW_recordPacking_string;
1236 if (srw_req->recordPacking)
1239 yaz_srw_str_to_pack(srw_req->recordPacking);
1241 packing = Z_SRW_recordPacking_string;
1243 srw_res->record.recordSchema = rr.schema;
1244 srw_res->record.recordPacking = packing;
1245 srw_res->record.recordData_buf = rr.explain_buf;
1246 srw_res->record.recordData_len = strlen(rr.explain_buf);
1247 srw_res->record.recordPosition = 0;
1253 static void srw_bend_scan(association *assoc, request *req,
1255 Z_SRW_scanResponse *srw_res,
1258 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1259 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1262 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1263 if (srw_res->num_diagnostics == 0 && assoc->init)
1265 struct scan_entry *save_entries;
1267 bend_scan_rr *bsrr = (bend_scan_rr *)
1268 odr_malloc (assoc->encode, sizeof(*bsrr));
1269 bsrr->num_bases = 1;
1270 bsrr->basenames = &srw_req->database;
1272 bsrr->num_entries = srw_req->maximumTerms ?
1273 *srw_req->maximumTerms : 10;
1274 bsrr->term_position = srw_req->responsePosition ?
1275 *srw_req->responsePosition : 1;
1278 bsrr->errstring = 0;
1279 bsrr->referenceId = 0;
1280 bsrr->stream = assoc->encode;
1281 bsrr->print = assoc->print;
1282 bsrr->step_size = odr_intdup(assoc->decode, 0);
1286 if (bsrr->num_entries > 0)
1289 bsrr->entries = (struct scan_entry *)
1290 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1292 for (i = 0; i<bsrr->num_entries; i++)
1294 bsrr->entries[i].term = 0;
1295 bsrr->entries[i].occurrences = 0;
1296 bsrr->entries[i].errcode = 0;
1297 bsrr->entries[i].errstring = 0;
1298 bsrr->entries[i].display_term = 0;
1301 save_entries = bsrr->entries; /* save it so we can compare later */
1303 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1304 assoc->init->bend_scan)
1306 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1308 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1309 &bsrr->attributeset,
1310 srw_req->scanClause.pqf);
1311 yaz_pqf_destroy(pqf_parser);
1312 bsrr->scanClause = 0;
1313 ((int (*)(void *, bend_scan_rr *))
1314 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1316 else if (srw_req->query_type == Z_SRW_query_type_cql
1317 && assoc->init->bend_scan && assoc->server
1318 && assoc->server->cql_transform)
1321 bsrr->scanClause = 0;
1322 bsrr->attributeset = 0;
1323 bsrr->term = (Z_AttributesPlusTerm *)
1324 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1325 srw_error = cql2pqf_scan(assoc->encode,
1326 srw_req->scanClause.cql,
1327 assoc->server->cql_transform,
1330 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1331 &srw_res->num_diagnostics,
1335 ((int (*)(void *, bend_scan_rr *))
1336 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1339 else if (srw_req->query_type == Z_SRW_query_type_cql
1340 && assoc->init->bend_srw_scan)
1343 bsrr->attributeset = 0;
1344 bsrr->scanClause = srw_req->scanClause.cql;
1345 ((int (*)(void *, bend_scan_rr *))
1346 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1350 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1351 &srw_res->num_diagnostics,
1352 YAZ_SRW_UNSUPP_OPERATION, "scan");
1357 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1362 srw_error = yaz_diag_bib1_to_srw (bsrr->errcode);
1364 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1365 &srw_res->num_diagnostics,
1366 srw_error, bsrr->errstring);
1368 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1371 srw_res->terms = (Z_SRW_scanTerm*)
1372 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1375 srw_res->num_terms = bsrr->num_entries;
1376 for (i = 0; i<bsrr->num_entries; i++)
1378 Z_SRW_scanTerm *t = srw_res->terms + i;
1379 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1380 t->numberOfRecords =
1381 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1383 if (save_entries == bsrr->entries &&
1384 bsrr->entries[i].display_term)
1386 /* the entries was _not_ set by the handler. So it's
1387 safe to test for new member display_term. It is
1390 t->displayTerm = odr_strdup(assoc->encode,
1391 bsrr->entries[i].display_term);
1399 WRBUF wr = wrbuf_alloc();
1400 const char *querytype = 0;
1401 const char *querystr = 0;
1403 switch(srw_req->query_type)
1405 case Z_SRW_query_type_pqf:
1407 querystr = srw_req->scanClause.pqf;
1409 case Z_SRW_query_type_cql:
1411 querystr = srw_req->scanClause.cql;
1414 querytype = "UNKNOWN";
1418 wrbuf_printf(wr, "SRWScan ");
1419 wrbuf_printf(wr, srw_req->database);
1420 wrbuf_printf(wr, " ");
1422 if (srw_res->num_diagnostics)
1423 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1424 else if (srw_res->num_terms)
1425 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1427 wrbuf_printf(wr, "OK - - ");
1429 wrbuf_printf(wr, "%d+%d+0 ",
1430 (srw_req->responsePosition ?
1431 *srw_req->responsePosition : 1),
1432 (srw_req->maximumTerms ?
1433 *srw_req->maximumTerms : 1));
1434 /* there is no step size in SRU/W ??? */
1435 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1436 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1442 static void srw_bend_update(association *assoc, request *req,
1444 Z_SRW_updateResponse *srw_res,
1447 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1448 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1449 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1451 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1455 Z_SRW_extra_record *extra = srw_req->extra_record;
1457 rr.stream = assoc->encode;
1458 rr.print = assoc->print;
1460 rr.basenames = &srw_req->database;
1461 rr.operation = srw_req->operation;
1462 rr.operation_status = "failed";
1464 rr.record_versions = 0;
1465 rr.num_versions = 0;
1466 rr.record_packing = "string";
1467 rr.record_schema = 0;
1469 rr.extra_record_data = 0;
1470 rr.extra_request_data = 0;
1471 rr.extra_response_data = 0;
1477 if (rr.operation == 0)
1479 yaz_add_sru_update_diagnostic(
1480 assoc->encode, &srw_res->diagnostics,
1481 &srw_res->num_diagnostics,
1482 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1486 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1487 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1488 if (!strcmp( rr.operation, "delete"))
1490 if (srw_req->record && !srw_req->record->recordSchema)
1492 rr.record_schema = odr_strdup(
1494 srw_req->record->recordSchema);
1496 if (srw_req->record)
1498 rr.record_data = odr_strdupn(
1500 srw_req->record->recordData_buf,
1501 srw_req->record->recordData_len );
1503 if (extra && extra->extraRecordData_len)
1505 rr.extra_record_data = odr_strdupn(
1507 extra->extraRecordData_buf,
1508 extra->extraRecordData_len );
1510 if (srw_req->recordId)
1511 rr.record_id = srw_req->recordId;
1512 else if (extra && extra->recordIdentifier)
1513 rr.record_id = extra->recordIdentifier;
1515 else if (!strcmp(rr.operation, "replace"))
1517 if (srw_req->recordId)
1518 rr.record_id = srw_req->recordId;
1519 else if (extra && extra->recordIdentifier)
1520 rr.record_id = extra->recordIdentifier;
1523 yaz_add_sru_update_diagnostic(
1524 assoc->encode, &srw_res->diagnostics,
1525 &srw_res->num_diagnostics,
1526 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1527 "recordIdentifier");
1529 if (!srw_req->record)
1531 yaz_add_sru_update_diagnostic(
1532 assoc->encode, &srw_res->diagnostics,
1533 &srw_res->num_diagnostics,
1534 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1539 if (srw_req->record->recordSchema)
1540 rr.record_schema = odr_strdup(
1541 assoc->encode, srw_req->record->recordSchema);
1542 if (srw_req->record->recordData_len )
1544 rr.record_data = odr_strdupn(assoc->encode,
1545 srw_req->record->recordData_buf,
1546 srw_req->record->recordData_len );
1550 yaz_add_sru_update_diagnostic(
1551 assoc->encode, &srw_res->diagnostics,
1552 &srw_res->num_diagnostics,
1553 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1557 if (extra && extra->extraRecordData_len)
1559 rr.extra_record_data = odr_strdupn(
1561 extra->extraRecordData_buf,
1562 extra->extraRecordData_len );
1565 else if (!strcmp(rr.operation, "insert"))
1567 if (srw_req->recordId)
1568 rr.record_id = srw_req->recordId;
1570 rr.record_id = extra->recordIdentifier;
1572 if (srw_req->record)
1574 if (srw_req->record->recordSchema)
1575 rr.record_schema = odr_strdup(
1576 assoc->encode, srw_req->record->recordSchema);
1578 if (srw_req->record->recordData_len)
1579 rr.record_data = odr_strdupn(
1581 srw_req->record->recordData_buf,
1582 srw_req->record->recordData_len );
1584 if (extra && extra->extraRecordData_len)
1586 rr.extra_record_data = odr_strdupn(
1588 extra->extraRecordData_buf,
1589 extra->extraRecordData_len );
1593 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1594 &srw_res->num_diagnostics,
1595 YAZ_SRU_UPDATE_INVALID_ACTION,
1598 if (srw_req->record)
1600 const char *pack_str =
1601 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1603 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1606 if (srw_req->num_recordVersions)
1608 rr.record_versions = srw_req->recordVersions;
1609 rr.num_versions = srw_req->num_recordVersions;
1611 if (srw_req->extraRequestData_len)
1613 rr.extra_request_data = odr_strdupn(assoc->encode,
1614 srw_req->extraRequestData_buf,
1615 srw_req->extraRequestData_len );
1617 if (srw_res->num_diagnostics == 0)
1619 if ( assoc->init->bend_srw_update)
1620 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1622 yaz_add_sru_update_diagnostic(
1623 assoc->encode, &srw_res->diagnostics,
1624 &srw_res->num_diagnostics,
1625 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1626 "No Update backend handler");
1630 yaz_add_srw_diagnostic_uri(assoc->encode,
1631 &srw_res->diagnostics,
1632 &srw_res->num_diagnostics,
1636 srw_res->recordId = rr.record_id;
1637 srw_res->operationStatus = rr.operation_status;
1638 srw_res->recordVersions = rr.record_versions;
1639 srw_res->num_recordVersions = rr.num_versions;
1640 if (srw_res->extraResponseData_len)
1642 srw_res->extraResponseData_buf = rr.extra_response_data;
1643 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1645 if (srw_res->num_diagnostics == 0 && rr.record_data)
1647 srw_res->record = yaz_srw_get_record(assoc->encode);
1648 srw_res->record->recordSchema = rr.record_schema;
1649 if (rr.record_packing)
1651 int pack = yaz_srw_str_to_pack(rr.record_packing);
1655 pack = Z_SRW_recordPacking_string;
1656 yaz_log(YLOG_WARN, "Back packing %s from backend",
1659 srw_res->record->recordPacking = pack;
1661 srw_res->record->recordData_buf = rr.record_data;
1662 srw_res->record->recordData_len = strlen(rr.record_data);
1663 if (rr.extra_record_data)
1665 Z_SRW_extra_record *ex =
1666 yaz_srw_get_extra_record(assoc->encode);
1667 srw_res->extra_record = ex;
1668 ex->extraRecordData_buf = rr.extra_record_data;
1669 ex->extraRecordData_len = strlen(rr.extra_record_data);
1675 /* check if path is OK (1); BAD (0) */
1676 static int check_path(const char *path)
1680 if (strstr(path, ".."))
1685 static char *read_file(const char *fname, ODR o, int *sz)
1688 FILE *inf = fopen(fname, "rb");
1692 fseek(inf, 0L, SEEK_END);
1695 buf = (char *) odr_malloc(o, *sz);
1696 fread(buf, 1, *sz, inf);
1701 static void process_http_request(association *assoc, request *req)
1703 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1704 ODR o = assoc->encode;
1705 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1707 Z_SOAP *soap_package = 0;
1710 Z_HTTP_Response *hres = 0;
1712 const char *stylesheet = 0; /* for now .. set later */
1713 Z_SRW_diagnostic *diagnostic = 0;
1714 int num_diagnostic = 0;
1715 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1717 if (!control_association(assoc, host, 0))
1719 p = z_get_HTTP_Response(o, 404);
1722 if (r == 2 && assoc->server && assoc->server->docpath
1723 && hreq->path[0] == '/'
1725 /* check if path is a proper prefix of documentroot */
1726 strncmp(hreq->path+1, assoc->server->docpath,
1727 strlen(assoc->server->docpath))
1730 if (!check_path(hreq->path))
1732 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1733 p = z_get_HTTP_Response(o, 404);
1737 int content_size = 0;
1738 char *content_buf = read_file(hreq->path+1, o, &content_size);
1741 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1742 p = z_get_HTTP_Response(o, 404);
1746 const char *ctype = 0;
1747 yaz_mime_types types = yaz_mime_types_create();
1749 yaz_mime_types_add(types, "xsl", "application/xml");
1750 yaz_mime_types_add(types, "xml", "application/xml");
1751 yaz_mime_types_add(types, "css", "text/css");
1752 yaz_mime_types_add(types, "html", "text/html");
1753 yaz_mime_types_add(types, "htm", "text/html");
1754 yaz_mime_types_add(types, "txt", "text/plain");
1755 yaz_mime_types_add(types, "js", "application/x-javascript");
1757 yaz_mime_types_add(types, "gif", "image/gif");
1758 yaz_mime_types_add(types, "png", "image/png");
1759 yaz_mime_types_add(types, "jpg", "image/jpeg");
1760 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1762 ctype = yaz_mime_lookup_fname(types, hreq->path);
1765 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1766 p = z_get_HTTP_Response(o, 404);
1770 p = z_get_HTTP_Response(o, 200);
1771 hres = p->u.HTTP_Response;
1772 hres->content_buf = content_buf;
1773 hres->content_len = content_size;
1774 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1776 yaz_mime_types_destroy(types);
1784 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1785 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1787 if (r == 2) /* not taken */
1789 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1790 &diagnostic, &num_diagnostic);
1791 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1793 if (r == 0) /* decode SRW/SRU OK .. */
1795 int http_code = 200;
1796 if (sr->which == Z_SRW_searchRetrieve_request)
1799 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1801 stylesheet = sr->u.request->stylesheet;
1804 res->u.response->diagnostics = diagnostic;
1805 res->u.response->num_diagnostics = num_diagnostic;
1809 srw_bend_search(assoc, req, sr, res->u.response,
1812 if (http_code == 200)
1813 soap_package->u.generic->p = res;
1815 else if (sr->which == Z_SRW_explain_request)
1817 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1819 stylesheet = sr->u.explain_request->stylesheet;
1822 res->u.explain_response->diagnostics = diagnostic;
1823 res->u.explain_response->num_diagnostics = num_diagnostic;
1825 srw_bend_explain(assoc, req, sr,
1826 res->u.explain_response, &http_code);
1827 if (http_code == 200)
1828 soap_package->u.generic->p = res;
1830 else if (sr->which == Z_SRW_scan_request)
1832 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1834 stylesheet = sr->u.scan_request->stylesheet;
1837 res->u.scan_response->diagnostics = diagnostic;
1838 res->u.scan_response->num_diagnostics = num_diagnostic;
1840 srw_bend_scan(assoc, req, sr,
1841 res->u.scan_response, &http_code);
1842 if (http_code == 200)
1843 soap_package->u.generic->p = res;
1845 else if (sr->which == Z_SRW_update_request)
1847 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1849 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1852 res->u.update_response->diagnostics = diagnostic;
1853 res->u.update_response->num_diagnostics = num_diagnostic;
1855 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1856 srw_bend_update(assoc, req, sr,
1857 res->u.update_response, &http_code);
1858 if (http_code == 200)
1859 soap_package->u.generic->p = res;
1863 yaz_log(log_request, "SOAP ERROR");
1864 /* FIXME - what error, what query */
1866 z_soap_error(assoc->encode, soap_package,
1867 "SOAP-ENV:Client", "Bad method", 0);
1869 if (http_code == 200 || http_code == 500)
1871 static Z_SOAP_Handler soap_handlers[4] = {
1873 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1874 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1875 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1881 p = z_get_HTTP_Response(o, 200);
1882 hres = p->u.HTTP_Response;
1884 if (!stylesheet && assoc->server)
1885 stylesheet = assoc->server->stylesheet;
1887 /* empty stylesheet means NO stylesheet */
1888 if (stylesheet && *stylesheet == '\0')
1891 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1892 &hres->content_buf, &hres->content_len,
1893 soap_handlers, charset, stylesheet);
1894 hres->code = http_code;
1896 strcpy(ctype, "text/xml");
1897 if (charset && strlen(charset) < sizeof(ctype)-30)
1899 strcat(ctype, "; charset=");
1900 strcat(ctype, charset);
1902 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1905 p = z_get_HTTP_Response(o, http_code);
1909 p = z_get_HTTP_Response(o, 500);
1910 hres = p->u.HTTP_Response;
1911 if (!strcmp(hreq->version, "1.0"))
1913 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1914 if (v && !strcmp(v, "Keep-Alive"))
1918 hres->version = "1.0";
1922 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1923 if (v && !strcmp(v, "close"))
1927 hres->version = "1.1";
1931 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1932 assoc->state = ASSOC_DEAD;
1933 assoc->cs_get_mask = 0;
1938 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1940 if (alive && isdigit(*(const unsigned char *) alive))
1944 if (t < 0 || t > 3600)
1946 iochan_settimeout(assoc->client_chan,t);
1947 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1949 process_gdu_response(assoc, req, p);
1952 static void process_gdu_request(association *assoc, request *req)
1954 if (req->gdu_request->which == Z_GDU_Z3950)
1957 req->apdu_request = req->gdu_request->u.z3950;
1958 if (process_z_request(assoc, req, &msg) < 0)
1959 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1961 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1962 process_http_request(assoc, req);
1965 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1970 * Initiate request processing.
1972 static int process_z_request(association *assoc, request *req, char **msg)
1978 *msg = "Unknown Error";
1979 assert(req && req->state == REQUEST_IDLE);
1980 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1982 *msg = "Missing InitRequest";
1985 switch (req->apdu_request->which)
1987 case Z_APDU_initRequest:
1988 res = process_initRequest(assoc, req); break;
1989 case Z_APDU_searchRequest:
1990 res = process_searchRequest(assoc, req, &fd); break;
1991 case Z_APDU_presentRequest:
1992 res = process_presentRequest(assoc, req, &fd); break;
1993 case Z_APDU_scanRequest:
1994 if (assoc->init->bend_scan)
1995 res = process_scanRequest(assoc, req, &fd);
1998 *msg = "Cannot handle Scan APDU";
2002 case Z_APDU_extendedServicesRequest:
2003 if (assoc->init->bend_esrequest)
2004 res = process_ESRequest(assoc, req, &fd);
2007 *msg = "Cannot handle Extended Services APDU";
2011 case Z_APDU_sortRequest:
2012 if (assoc->init->bend_sort)
2013 res = process_sortRequest(assoc, req, &fd);
2016 *msg = "Cannot handle Sort APDU";
2021 process_close(assoc, req);
2023 case Z_APDU_deleteResultSetRequest:
2024 if (assoc->init->bend_delete)
2025 res = process_deleteRequest(assoc, req, &fd);
2028 *msg = "Cannot handle Delete APDU";
2032 case Z_APDU_segmentRequest:
2033 if (assoc->init->bend_segment)
2035 res = process_segmentRequest (assoc, req);
2039 *msg = "Cannot handle Segment APDU";
2043 case Z_APDU_triggerResourceControlRequest:
2046 *msg = "Bad APDU received";
2051 yaz_log(YLOG_DEBUG, " result immediately available");
2052 retval = process_z_response(assoc, req, res);
2056 yaz_log(YLOG_DEBUG, " result unavailble");
2059 else /* no result yet - one will be provided later */
2063 /* Set up an I/O handler for the fd supplied by the backend */
2065 yaz_log(YLOG_DEBUG, " establishing handler for result");
2066 req->state = REQUEST_PENDING;
2067 if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT, 0)))
2069 iochan_setdata(chan, assoc);
2076 * Handle message from the backend.
2078 void backend_response(IOCHAN i, int event)
2080 association *assoc = (association *)iochan_getdata(i);
2081 request *req = request_head(&assoc->incoming);
2085 yaz_log(YLOG_DEBUG, "backend_response");
2086 assert(assoc && req && req->state != REQUEST_IDLE);
2087 /* determine what it is we're waiting for */
2088 switch (req->apdu_request->which)
2090 case Z_APDU_searchRequest:
2091 res = response_searchRequest(assoc, req, 0, &fd); break;
2093 case Z_APDU_presentRequest:
2094 res = response_presentRequest(assoc, req, 0, &fd); break;
2095 case Z_APDU_scanRequest:
2096 res = response_scanRequest(assoc, req, 0, &fd); break;
2099 yaz_log(YLOG_FATAL, "Serious programmer's lapse or bug");
2102 if ((res && process_z_response(assoc, req, res) < 0) || fd < 0)
2104 yaz_log(YLOG_WARN, "Fatal error when talking to backend");
2105 do_close(assoc, Z_Close_systemProblem, 0);
2109 else if (!res) /* no result yet - try again later */
2111 yaz_log(YLOG_DEBUG, " no result yet");
2112 iochan_setfd(i, fd); /* in case fd has changed */
2117 * Encode response, and transfer the request structure to the outgoing queue.
2119 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2121 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2125 if (!z_GDU(assoc->print, &res, 0, 0))
2126 yaz_log(YLOG_WARN, "ODR print error: %s",
2127 odr_errmsg(odr_geterror(assoc->print)));
2128 odr_reset(assoc->print);
2130 if (!z_GDU(assoc->encode, &res, 0, 0))
2132 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2133 odr_errmsg(odr_geterror(assoc->decode)),
2134 odr_getelement(assoc->decode));
2137 req->response = odr_getbuf(assoc->encode, &req->len_response,
2138 &req->size_response);
2139 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2140 odr_reset(assoc->encode);
2141 req->state = REQUEST_IDLE;
2142 request_enq(&assoc->outgoing, req);
2143 /* turn the work over to the ir_session handler */
2144 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2145 assoc->cs_put_mask = EVENT_OUTPUT;
2146 /* Is there more work to be done? give that to the input handler too */
2149 req = request_head(&assoc->incoming);
2150 if (req && req->state == REQUEST_IDLE)
2152 request_deq(&assoc->incoming);
2153 process_gdu_request(assoc, req);
2162 * Encode response, and transfer the request structure to the outgoing queue.
2164 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2166 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*res));
2167 gres->which = Z_GDU_Z3950;
2168 gres->u.z3950 = res;
2170 return process_gdu_response(assoc, req, gres);
2173 static char *get_vhost(Z_OtherInformation *otherInfo)
2175 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2179 * Handle init request.
2180 * At the moment, we don't check the options
2181 * anywhere else in the code - we just try not to do anything that would
2182 * break a naive client. We'll toss 'em into the association block when
2183 * we need them there.
2185 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2187 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2188 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2189 Z_InitResponse *resp = apdu->u.initResponse;
2190 bend_initresult *binitres;
2193 statserv_options_block *cb = 0; /* by default no control for backend */
2195 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2196 cb = statserv_getcontrol(); /* got control block for backend */
2198 if (cb && assoc->backend)
2199 (*cb->bend_close)(assoc->backend);
2201 yaz_log(log_requestdetail, "Got initRequest");
2202 if (req->implementationId)
2203 yaz_log(log_requestdetail, "Id: %s",
2204 req->implementationId);
2205 if (req->implementationName)
2206 yaz_log(log_requestdetail, "Name: %s",
2207 req->implementationName);
2208 if (req->implementationVersion)
2209 yaz_log(log_requestdetail, "Version: %s",
2210 req->implementationVersion);
2212 assoc_init_reset(assoc);
2214 assoc->init->auth = req->idAuthentication;
2215 assoc->init->referenceId = req->referenceId;
2217 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2219 Z_CharSetandLanguageNegotiation *negotiation =
2220 yaz_get_charneg_record (req->otherInfo);
2222 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2223 assoc->init->charneg_request = negotiation;
2229 if (req->implementationVersion)
2230 yaz_log(log_requestdetail, "Config: %s",
2233 iochan_settimeout(assoc->client_chan, cb->idle_timeout * 60);
2235 /* we have a backend control block, so call that init function */
2236 if (!(binitres = (*cb->bend_init)(assoc->init)))
2238 yaz_log(YLOG_WARN, "Bad response from backend.");
2241 assoc->backend = binitres->handle;
2245 /* no backend. return error */
2246 binitres = (bend_initresult *)
2247 odr_malloc(assoc->encode, sizeof(*binitres));
2248 binitres->errstring = 0;
2249 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2250 iochan_settimeout(assoc->client_chan, 10);
2252 if ((assoc->init->bend_sort))
2253 yaz_log (YLOG_DEBUG, "Sort handler installed");
2254 if ((assoc->init->bend_search))
2255 yaz_log (YLOG_DEBUG, "Search handler installed");
2256 if ((assoc->init->bend_present))
2257 yaz_log (YLOG_DEBUG, "Present handler installed");
2258 if ((assoc->init->bend_esrequest))
2259 yaz_log (YLOG_DEBUG, "ESRequest handler installed");
2260 if ((assoc->init->bend_delete))
2261 yaz_log (YLOG_DEBUG, "Delete handler installed");
2262 if ((assoc->init->bend_scan))
2263 yaz_log (YLOG_DEBUG, "Scan handler installed");
2264 if ((assoc->init->bend_segment))
2265 yaz_log (YLOG_DEBUG, "Segment handler installed");
2267 resp->referenceId = req->referenceId;
2269 /* let's tell the client what we can do */
2270 if (ODR_MASK_GET(req->options, Z_Options_search))
2272 ODR_MASK_SET(resp->options, Z_Options_search);
2273 strcat(options, "srch");
2275 if (ODR_MASK_GET(req->options, Z_Options_present))
2277 ODR_MASK_SET(resp->options, Z_Options_present);
2278 strcat(options, " prst");
2280 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2281 assoc->init->bend_delete)
2283 ODR_MASK_SET(resp->options, Z_Options_delSet);
2284 strcat(options, " del");
2286 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2287 assoc->init->bend_esrequest)
2289 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2290 strcat (options, " extendedServices");
2292 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2294 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2295 strcat(options, " namedresults");
2297 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2299 ODR_MASK_SET(resp->options, Z_Options_scan);
2300 strcat(options, " scan");
2302 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2304 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2305 strcat(options, " concurrop");
2307 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2309 ODR_MASK_SET(resp->options, Z_Options_sort);
2310 strcat(options, " sort");
2313 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2315 Z_OtherInformationUnit *p0;
2317 if (!assoc->init->charneg_response)
2319 if (assoc->init->query_charset)
2321 assoc->init->charneg_response = yaz_set_response_charneg(
2322 assoc->encode, assoc->init->query_charset, 0,
2323 assoc->init->records_in_same_charset);
2327 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2330 if (assoc->init->charneg_response
2331 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2333 p0->which = Z_OtherInfo_externallyDefinedInfo;
2334 p0->information.externallyDefinedInfo =
2335 assoc->init->charneg_response;
2336 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2337 strcat(options, " negotiation");
2340 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2341 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2343 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2345 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2346 assoc->version = 1; /* 1 & 2 are equivalent */
2348 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2350 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2353 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2355 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2359 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2361 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2362 assoc->maximumRecordSize = *req->maximumRecordSize;
2364 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2365 assoc->preferredMessageSize = *req->preferredMessageSize;
2367 resp->preferredMessageSize = &assoc->preferredMessageSize;
2368 resp->maximumRecordSize = &assoc->maximumRecordSize;
2370 resp->implementationId = odr_prepend(assoc->encode,
2371 assoc->init->implementation_id,
2372 resp->implementationId);
2374 resp->implementationName = odr_prepend(assoc->encode,
2375 assoc->init->implementation_name,
2376 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2378 version = odr_strdup(assoc->encode, "$Revision: 1.128 $");
2379 if (strlen(version) > 10) /* check for unexpanded CVS strings */
2380 version[strlen(version)-2] = '\0';
2381 resp->implementationVersion = odr_prepend(assoc->encode,
2382 assoc->init->implementation_version,
2383 odr_prepend(assoc->encode, &version[11],
2384 resp->implementationVersion));
2386 if (binitres->errcode)
2388 assoc->state = ASSOC_DEAD;
2389 resp->userInformationField =
2390 init_diagnostics(assoc->encode, binitres->errcode,
2391 binitres->errstring);
2396 if (!req->idAuthentication)
2397 yaz_log(log_request, "Auth none");
2398 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2400 const char *open = req->idAuthentication->u.open;
2401 const char *slash = strchr(open, '/');
2407 yaz_log(log_request, "Auth open %.*s", len, open);
2409 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2411 const char *user = req->idAuthentication->u.idPass->userId;
2412 const char *group = req->idAuthentication->u.idPass->groupId;
2413 yaz_log(log_request, "Auth idPass %s %s",
2414 user ? user : "-", group ? group : "-");
2416 else if (req->idAuthentication->which
2417 == Z_IdAuthentication_anonymous)
2419 yaz_log(log_request, "Auth anonymous");
2423 yaz_log(log_request, "Auth other");
2428 WRBUF wr = wrbuf_alloc();
2429 wrbuf_printf(wr, "Init ");
2430 if (binitres->errcode)
2431 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2433 wrbuf_printf(wr, "OK -");
2434 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2435 (req->implementationId ? req->implementationId :"-"),
2436 (req->implementationName ?
2437 req->implementationName : "-"),
2438 (req->implementationVersion ?
2439 req->implementationVersion : "-")
2441 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2448 * Set the specified `errcode' and `errstring' into a UserInfo-1
2449 * external to be returned to the client in accordance with Z35.90
2450 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2451 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2453 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2455 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2456 addinfo ? " -- " : "", addinfo ? addinfo : "");
2457 return zget_init_diagnostics(odr, error, addinfo);
2461 * nonsurrogate diagnostic record.
2463 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2465 Z_Records *rec = (Z_Records *) odr_malloc (assoc->encode, sizeof(*rec));
2467 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2468 addinfo ? " -- " : "", addinfo ? addinfo : "");
2470 rec->which = Z_Records_NSD;
2471 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2477 * surrogate diagnostic.
2479 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2481 int error, const char *addinfo)
2483 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2484 addinfo ? " -- " : "", addinfo ? addinfo : "");
2485 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2488 static Z_Records *pack_records(association *a, char *setname, int start,
2489 int *num, Z_RecordComposition *comp,
2490 int *next, int *pres,
2491 Z_ReferenceId *referenceId,
2492 Odr_oid *oid, int *errcode)
2494 int recno, total_length = 0, toget = *num, dumped_records = 0;
2495 Z_Records *records =
2496 (Z_Records *) odr_malloc (a->encode, sizeof(*records));
2497 Z_NamePlusRecordList *reclist =
2498 (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
2499 Z_NamePlusRecord **list =
2500 (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
2502 records->which = Z_Records_DBOSD;
2503 records->u.databaseOrSurDiagnostics = reclist;
2504 reclist->num_records = 0;
2505 reclist->records = list;
2506 *pres = Z_PresentStatus_success;
2510 yaz_log(log_requestdetail, "Request to pack %d+%d %s", start, toget, setname);
2511 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2512 a->maximumRecordSize);
2513 for (recno = start; reclist->num_records < toget; recno++)
2516 Z_NamePlusRecord *thisrec;
2517 int this_length = 0;
2519 * we get the number of bytes allocated on the stream before any
2520 * allocation done by the backend - this should give us a reasonable
2521 * idea of the total size of the data so far.
2523 total_length = odr_total(a->encode) - dumped_records;
2529 freq.last_in_set = 0;
2530 freq.setname = setname;
2531 freq.surrogate_flag = 0;
2532 freq.number = recno;
2534 freq.request_format = oid;
2535 freq.output_format = 0;
2536 freq.stream = a->encode;
2537 freq.print = a->print;
2538 freq.referenceId = referenceId;
2541 retrieve_fetch(a, &freq);
2543 *next = freq.last_in_set ? 0 : recno + 1;
2545 /* backend should be able to signal whether error is system-wide
2546 or only pertaining to current record */
2549 if (!freq.surrogate_flag)
2552 *pres = Z_PresentStatus_failure;
2553 /* for 'present request out of range',
2554 set addinfo to record position if not set */
2555 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2556 freq.errstring == 0)
2558 sprintf (s, "%d", recno);
2562 *errcode = freq.errcode;
2563 return diagrec(a, freq.errcode, freq.errstring);
2565 reclist->records[reclist->num_records] =
2566 surrogatediagrec(a, freq.basename, freq.errcode,
2568 reclist->num_records++;
2571 if (freq.record == 0) /* no error and no record ? */
2573 *next = 0; /* signal end-of-set and stop */
2577 this_length = freq.len;
2579 this_length = odr_total(a->encode) - total_length - dumped_records;
2580 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2581 this_length, total_length, dumped_records);
2582 if (a->preferredMessageSize > 0 &&
2583 this_length + total_length > a->preferredMessageSize)
2585 /* record is small enough, really */
2586 if (this_length <= a->preferredMessageSize && recno > start)
2588 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2589 *pres = Z_PresentStatus_partial_2;
2592 /* record can only be fetched by itself */
2593 if (this_length < a->maximumRecordSize)
2595 yaz_log(log_requestdetail, " Record > prefmsgsz");
2598 yaz_log(YLOG_DEBUG, " Dropped it");
2599 reclist->records[reclist->num_records] =
2600 surrogatediagrec(a, freq.basename, 16, 0);
2601 reclist->num_records++;
2602 dumped_records += this_length;
2606 else /* too big entirely */
2608 yaz_log(log_requestdetail, "Record > maxrcdsz this=%d max=%d",
2609 this_length, a->maximumRecordSize);
2610 reclist->records[reclist->num_records] =
2611 surrogatediagrec(a, freq.basename, 17, 0);
2612 reclist->num_records++;
2613 dumped_records += this_length;
2618 if (!(thisrec = (Z_NamePlusRecord *)
2619 odr_malloc(a->encode, sizeof(*thisrec))))
2621 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2622 thisrec->which = Z_NamePlusRecord_databaseRecord;
2624 if (!freq.output_format)
2625 freq.output_format = freq.request_format;
2626 thisrec->u.databaseRecord = z_ext_record_oid(
2627 a->encode, freq.output_format, freq.record, freq.len);
2628 if (!thisrec->u.databaseRecord)
2630 reclist->records[reclist->num_records] = thisrec;
2631 reclist->num_records++;
2633 *num = reclist->num_records;
2637 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
2640 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2641 bend_search_rr *bsrr =
2642 (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
2644 yaz_log(log_requestdetail, "Got SearchRequest.");
2646 bsrr->request = reqb;
2647 bsrr->association = assoc;
2648 bsrr->referenceId = req->referenceId;
2649 save_referenceId (reqb, bsrr->referenceId);
2650 bsrr->srw_sortKeys = 0;
2651 bsrr->srw_setname = 0;
2652 bsrr->srw_setnameIdleTime = 0;
2653 bsrr->estimated_hit_count = 0;
2654 bsrr->partial_resultset = 0;
2656 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2657 if (req->databaseNames)
2660 for (i = 0; i < req->num_databaseNames; i++)
2661 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2664 yaz_log_zquery_level(log_requestdetail,req->query);
2666 if (assoc->init->bend_search)
2668 bsrr->setname = req->resultSetName;
2669 bsrr->replace_set = *req->replaceIndicator;
2670 bsrr->num_bases = req->num_databaseNames;
2671 bsrr->basenames = req->databaseNames;
2672 bsrr->query = req->query;
2673 bsrr->stream = assoc->encode;
2674 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2675 bsrr->decode = assoc->decode;
2676 bsrr->print = assoc->print;
2679 bsrr->errstring = NULL;
2680 bsrr->search_info = NULL;
2682 if (assoc->server && assoc->server->cql_transform
2683 && req->query->which == Z_Query_type_104
2684 && req->query->u.type_104->which == Z_External_CQL)
2686 /* have a CQL query and a CQL to PQF transform .. */
2688 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2689 assoc->server->cql_transform, bsrr->query);
2691 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2694 if (assoc->server && assoc->server->ccl_transform
2695 && req->query->which == Z_Query_type_2) /*CCL*/
2697 /* have a CCL query and a CCL to PQF transform .. */
2699 ccl2pqf(bsrr->stream, req->query->u.type_2,
2700 assoc->server->ccl_transform, bsrr);
2702 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2706 (assoc->init->bend_search)(assoc->backend, bsrr);
2707 if (!bsrr->request) /* backend not ready with the search response */
2708 return 0; /* should not be used any more */
2712 /* FIXME - make a diagnostic for it */
2713 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2715 return response_searchRequest(assoc, reqb, bsrr, fd);
2718 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
2721 * Prepare a searchresponse based on the backend results. We probably want
2722 * to look at making the fetching of records nonblocking as well, but
2723 * so far, we'll keep things simple.
2724 * If bsrt is null, that means we're called in response to a communications
2725 * event, and we'll have to get the response for ourselves.
2727 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2728 bend_search_rr *bsrt, int *fd)
2730 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2731 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2732 Z_SearchResponse *resp = (Z_SearchResponse *)
2733 odr_malloc (assoc->encode, sizeof(*resp));
2734 int *nulint = odr_intdup (assoc->encode, 0);
2735 int *next = odr_intdup(assoc->encode, 0);
2736 int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2737 int returnedrecs = 0;
2739 apdu->which = Z_APDU_searchResponse;
2740 apdu->u.searchResponse = resp;
2741 resp->referenceId = req->referenceId;
2742 resp->additionalSearchInfo = 0;
2743 resp->otherInfo = 0;
2745 if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
2747 yaz_log(YLOG_FATAL, "Bad result from backend");
2750 else if (bsrt->errcode)
2752 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2753 resp->resultCount = nulint;
2754 resp->numberOfRecordsReturned = nulint;
2755 resp->nextResultSetPosition = nulint;
2756 resp->searchStatus = nulint;
2757 resp->resultSetStatus = none;
2758 resp->presentStatus = 0;
2762 bool_t *sr = odr_intdup(assoc->encode, 1);
2763 int *toget = odr_intdup(assoc->encode, 0);
2764 Z_RecordComposition comp, *compp = 0;
2766 yaz_log (log_requestdetail, "resultCount: %d", bsrt->hits);
2769 resp->resultCount = &bsrt->hits;
2771 comp.which = Z_RecordComp_simple;
2772 /* how many records does the user agent want, then? */
2773 if (bsrt->hits <= *req->smallSetUpperBound)
2775 *toget = bsrt->hits;
2776 if ((comp.u.simple = req->smallSetElementSetNames))
2779 else if (bsrt->hits < *req->largeSetLowerBound)
2781 *toget = *req->mediumSetPresentNumber;
2782 if (*toget > bsrt->hits)
2783 *toget = bsrt->hits;
2784 if ((comp.u.simple = req->mediumSetElementSetNames))
2790 if (*toget && !resp->records)
2792 int *presst = odr_intdup(assoc->encode, 0);
2793 /* Call bend_present if defined */
2794 if (assoc->init->bend_present)
2796 bend_present_rr *bprr = (bend_present_rr *)
2797 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2798 bprr->setname = req->resultSetName;
2800 bprr->number = *toget;
2801 bprr->format = req->preferredRecordSyntax;
2803 bprr->referenceId = req->referenceId;
2804 bprr->stream = assoc->encode;
2805 bprr->print = assoc->print;
2806 bprr->request = reqb;
2807 bprr->association = assoc;
2809 bprr->errstring = NULL;
2810 (*assoc->init->bend_present)(assoc->backend, bprr);
2816 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2817 *resp->presentStatus = Z_PresentStatus_failure;
2822 resp->records = pack_records(
2823 assoc, req->resultSetName, 1,
2824 toget, compp, next, presst, req->referenceId,
2825 req->preferredRecordSyntax, NULL);
2828 resp->numberOfRecordsReturned = toget;
2829 returnedrecs = *toget;
2830 resp->presentStatus = presst;
2834 if (*resp->resultCount)
2836 resp->numberOfRecordsReturned = nulint;
2837 resp->presentStatus = 0;
2839 resp->nextResultSetPosition = next;
2840 resp->searchStatus = sr;
2841 resp->resultSetStatus = 0;
2842 if (bsrt->estimated_hit_count)
2844 resp->resultSetStatus = odr_intdup(assoc->encode,
2845 Z_SearchResponse_estimate);
2847 else if (bsrt->partial_resultset)
2849 resp->resultSetStatus = odr_intdup(assoc->encode,
2850 Z_SearchResponse_subset);
2853 resp->additionalSearchInfo = bsrt->search_info;
2858 WRBUF wr = wrbuf_alloc();
2860 for (i = 0 ; i < req->num_databaseNames; i++){
2862 wrbuf_printf(wr, "+");
2863 wrbuf_printf(wr, req->databaseNames[i]);
2865 wrbuf_printf(wr, " ");
2868 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2870 wrbuf_printf(wr, "OK %d", bsrt->hits);
2871 wrbuf_printf(wr, " %s 1+%d ",
2872 req->resultSetName, returnedrecs);
2873 yaz_query_to_wrbuf(wr, req->query);
2875 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2882 * Maybe we got a little over-friendly when we designed bend_fetch to
2883 * get only one record at a time. Some backends can optimise multiple-record
2884 * fetches, and at any rate, there is some overhead involved in
2885 * all that selecting and hopping around. Problem is, of course, that the
2886 * frontend can't know ahead of time how many records it'll need to
2887 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2888 * is downright lousy as a bulk data transfer protocol.
2890 * To start with, we'll do the fetching of records from the backend
2891 * in one operation: To save some trips in and out of the event-handler,
2892 * and to simplify the interface to pack_records. At any rate, asynch
2893 * operation is more fun in operations that have an unpredictable execution
2894 * speed - which is normally more true for search than for present.
2896 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
2899 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2901 Z_PresentResponse *resp;
2905 const char *errstring = 0;
2907 yaz_log(log_requestdetail, "Got PresentRequest.");
2909 resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
2911 resp->presentStatus = odr_intdup(assoc->encode, 0);
2912 if (assoc->init->bend_present)
2914 bend_present_rr *bprr = (bend_present_rr *)
2915 nmem_malloc (reqb->request_mem, sizeof(*bprr));
2916 bprr->setname = req->resultSetId;
2917 bprr->start = *req->resultSetStartPoint;
2918 bprr->number = *req->numberOfRecordsRequested;
2919 bprr->format = req->preferredRecordSyntax;
2920 bprr->comp = req->recordComposition;
2921 bprr->referenceId = req->referenceId;
2922 bprr->stream = assoc->encode;
2923 bprr->print = assoc->print;
2924 bprr->request = reqb;
2925 bprr->association = assoc;
2927 bprr->errstring = NULL;
2928 (*assoc->init->bend_present)(assoc->backend, bprr);
2931 return 0; /* should not happen */
2934 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2935 *resp->presentStatus = Z_PresentStatus_failure;
2936 errcode = bprr->errcode;
2937 errstring = bprr->errstring;
2940 apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2941 next = odr_intdup(assoc->encode, 0);
2942 num = odr_intdup(assoc->encode, 0);
2944 apdu->which = Z_APDU_presentResponse;
2945 apdu->u.presentResponse = resp;
2946 resp->referenceId = req->referenceId;
2947 resp->otherInfo = 0;
2951 *num = *req->numberOfRecordsRequested;
2953 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2954 num, req->recordComposition, next,
2955 resp->presentStatus,
2956 req->referenceId, req->preferredRecordSyntax,
2961 WRBUF wr = wrbuf_alloc();
2962 wrbuf_printf(wr, "Present ");
2964 if (*resp->presentStatus == Z_PresentStatus_failure)
2965 wrbuf_printf(wr, "ERROR %d ", errcode);
2966 else if (*resp->presentStatus == Z_PresentStatus_success)
2967 wrbuf_printf(wr, "OK - ");
2969 wrbuf_printf(wr, "Partial %d - ", *resp->presentStatus);
2971 wrbuf_printf(wr, " %s %d+%d ",
2972 req->resultSetId, *req->resultSetStartPoint,
2973 *req->numberOfRecordsRequested);
2974 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2979 resp->numberOfRecordsReturned = num;
2980 resp->nextResultSetPosition = next;
2986 * Scan was implemented rather in a hurry, and with support for only the basic
2987 * elements of the service in the backend API. Suggestions are welcome.
2989 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
2991 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2992 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
2993 Z_ScanResponse *res = (Z_ScanResponse *)
2994 odr_malloc (assoc->encode, sizeof(*res));
2995 int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2996 int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2997 Z_ListEntries *ents = (Z_ListEntries *)
2998 odr_malloc (assoc->encode, sizeof(*ents));
2999 Z_DiagRecs *diagrecs_p = NULL;
3000 bend_scan_rr *bsrr = (bend_scan_rr *)
3001 odr_malloc (assoc->encode, sizeof(*bsrr));
3002 struct scan_entry *save_entries;
3004 yaz_log(log_requestdetail, "Got ScanRequest");
3006 apdu->which = Z_APDU_scanResponse;
3007 apdu->u.scanResponse = res;
3008 res->referenceId = req->referenceId;
3010 /* if step is absent, set it to 0 */
3011 res->stepSize = odr_intdup(assoc->encode, 0);
3013 *res->stepSize = *req->stepSize;
3015 res->scanStatus = scanStatus;
3016 res->numberOfEntriesReturned = numberOfEntriesReturned;
3017 res->positionOfTerm = 0;
3018 res->entries = ents;
3019 ents->num_entries = 0;
3020 ents->entries = NULL;
3021 ents->num_nonsurrogateDiagnostics = 0;
3022 ents->nonsurrogateDiagnostics = NULL;
3023 res->attributeSet = 0;
3026 if (req->databaseNames)
3029 for (i = 0; i < req->num_databaseNames; i++)
3030 yaz_log (log_requestdetail, "Database '%s'", req->databaseNames[i]);
3032 bsrr->scanClause = 0;
3034 bsrr->errstring = 0;
3035 bsrr->num_bases = req->num_databaseNames;
3036 bsrr->basenames = req->databaseNames;
3037 bsrr->num_entries = *req->numberOfTermsRequested;
3038 bsrr->term = req->termListAndStartPoint;
3039 bsrr->referenceId = req->referenceId;
3040 bsrr->stream = assoc->encode;
3041 bsrr->print = assoc->print;
3042 bsrr->step_size = res->stepSize;
3043 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
3044 yaz_oid_userinfo_scan_set, 1, 0);
3046 /* For YAZ 2.0 and earlier it was the backend handler that
3047 initialized entries (member display_term did not exist)
3048 YAZ 2.0 and later sets 'entries' and initialize all members
3049 including 'display_term'. If YAZ 2.0 or later sees that
3050 entries was modified - we assume that it is an old handler and
3051 that 'display_term' is _not_ set.
3053 if (bsrr->num_entries > 0)
3056 bsrr->entries = (struct scan_entry *)
3057 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3059 for (i = 0; i<bsrr->num_entries; i++)
3061 bsrr->entries[i].term = 0;
3062 bsrr->entries[i].occurrences = 0;
3063 bsrr->entries[i].errcode = 0;
3064 bsrr->entries[i].errstring = 0;
3065 bsrr->entries[i].display_term = 0;
3068 save_entries = bsrr->entries; /* save it so we can compare later */
3070 bsrr->attributeset = req->attributeSet;
3071 log_scan_term_level (log_requestdetail, req->termListAndStartPoint,
3072 bsrr->attributeset);
3073 bsrr->term_position = req->preferredPositionInResponse ?
3074 *req->preferredPositionInResponse : 1;
3076 ((int (*)(void *, bend_scan_rr *))
3077 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3080 diagrecs_p = zget_DiagRecs(assoc->encode,
3081 bsrr->errcode, bsrr->errstring);
3085 Z_Entry **tab = (Z_Entry **)
3086 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
3088 if (bsrr->status == BEND_SCAN_PARTIAL)
3089 *scanStatus = Z_Scan_partial_5;
3091 *scanStatus = Z_Scan_success;
3092 ents->entries = tab;
3093 ents->num_entries = bsrr->num_entries;
3094 res->numberOfEntriesReturned = &ents->num_entries;
3095 res->positionOfTerm = &bsrr->term_position;
3096 for (i = 0; i < bsrr->num_entries; i++)
3102 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3103 if (bsrr->entries[i].occurrences >= 0)
3105 e->which = Z_Entry_termInfo;
3106 e->u.termInfo = t = (Z_TermInfo *)
3107 odr_malloc(assoc->encode, sizeof(*t));
3108 t->suggestedAttributes = 0;
3110 if (save_entries == bsrr->entries &&
3111 bsrr->entries[i].display_term)
3113 /* the entries was _not_ set by the handler. So it's
3114 safe to test for new member display_term. It is
3117 t->displayTerm = odr_strdup(assoc->encode,
3118 bsrr->entries[i].display_term);
3120 t->alternativeTerm = 0;
3121 t->byAttributes = 0;
3122 t->otherTermInfo = 0;
3123 t->globalOccurrences = &bsrr->entries[i].occurrences;
3124 t->term = (Z_Term *)
3125 odr_malloc(assoc->encode, sizeof(*t->term));
3126 t->term->which = Z_Term_general;
3127 t->term->u.general = o =
3128 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3129 o->buf = (unsigned char *)
3130 odr_malloc(assoc->encode, o->len = o->size =
3131 strlen(bsrr->entries[i].term));
3132 memcpy(o->buf, bsrr->entries[i].term, o->len);
3133 yaz_log(YLOG_DEBUG, " term #%d: '%s' (%d)", i,
3134 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3138 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3139 bsrr->entries[i].errcode,
3140 bsrr->entries[i].errstring);
3141 assert (drecs->num_diagRecs == 1);
3142 e->which = Z_Entry_surrogateDiagnostic;
3143 assert (drecs->diagRecs[0]);
3144 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3150 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3151 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3156 WRBUF wr = wrbuf_alloc();
3157 wrbuf_printf(wr, "Scan ");
3158 for (i = 0 ; i < req->num_databaseNames; i++)
3161 wrbuf_printf(wr, "+");
3162 wrbuf_printf(wr, req->databaseNames[i]);
3165 wrbuf_printf(wr, " ");
3168 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3170 wrbuf_printf(wr, "OK");
3172 wrbuf_printf(wr, " %d - %d+%d+%d",
3173 res->numberOfEntriesReturned ?
3174 *res->numberOfEntriesReturned : 0,
3175 (req->preferredPositionInResponse ?
3176 *req->preferredPositionInResponse : 1),
3177 *req->numberOfTermsRequested,
3178 (res->stepSize ? *res->stepSize : 1));
3181 wrbuf_printf(wr, "+%s", bsrr->setname);
3183 wrbuf_printf(wr, " ");
3184 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3185 bsrr->attributeset);
3186 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3192 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
3196 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3197 Z_SortResponse *res = (Z_SortResponse *)
3198 odr_malloc (assoc->encode, sizeof(*res));
3199 bend_sort_rr *bsrr = (bend_sort_rr *)
3200 odr_malloc (assoc->encode, sizeof(*bsrr));
3202 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3204 yaz_log(log_requestdetail, "Got SortRequest.");
3206 bsrr->num_input_setnames = req->num_inputResultSetNames;
3207 for (i=0;i<req->num_inputResultSetNames;i++)
3208 yaz_log(log_requestdetail, "Input resultset: '%s'",
3209 req->inputResultSetNames[i]);
3210 bsrr->input_setnames = req->inputResultSetNames;
3211 bsrr->referenceId = req->referenceId;
3212 bsrr->output_setname = req->sortedResultSetName;
3213 yaz_log(log_requestdetail, "Output resultset: '%s'",
3214 req->sortedResultSetName);
3215 bsrr->sort_sequence = req->sortSequence;
3216 /*FIXME - dump those sequences too */
3217 bsrr->stream = assoc->encode;
3218 bsrr->print = assoc->print;
3220 bsrr->sort_status = Z_SortResponse_failure;
3222 bsrr->errstring = 0;
3224 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3226 res->referenceId = bsrr->referenceId;
3227 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3228 res->resultSetStatus = 0;
3231 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3232 bsrr->errcode, bsrr->errstring);
3233 res->diagnostics = dr->diagRecs;
3234 res->num_diagnostics = dr->num_diagRecs;
3238 res->num_diagnostics = 0;
3239 res->diagnostics = 0;
3241 res->resultCount = 0;
3244 apdu->which = Z_APDU_sortResponse;
3245 apdu->u.sortResponse = res;
3248 WRBUF wr = wrbuf_alloc();
3249 wrbuf_printf(wr, "Sort ");
3251 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3253 wrbuf_printf(wr, "OK -");
3254 wrbuf_printf(wr, " (");
3255 for (i = 0; i<req->num_inputResultSetNames; i++)
3258 wrbuf_printf(wr, "+");
3259 wrbuf_printf(wr, req->inputResultSetNames[i]);
3261 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3263 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3269 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
3273 Z_DeleteResultSetRequest *req =
3274 reqb->apdu_request->u.deleteResultSetRequest;
3275 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3276 odr_malloc (assoc->encode, sizeof(*res));
3277 bend_delete_rr *bdrr = (bend_delete_rr *)
3278 odr_malloc (assoc->encode, sizeof(*bdrr));
3279 Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
3281 yaz_log(log_requestdetail, "Got DeleteRequest.");
3283 bdrr->num_setnames = req->num_resultSetList;
3284 bdrr->setnames = req->resultSetList;
3285 for (i = 0; i<req->num_resultSetList; i++)
3286 yaz_log(log_requestdetail, "resultset: '%s'",
3287 req->resultSetList[i]);
3288 bdrr->stream = assoc->encode;
3289 bdrr->print = assoc->print;
3290 bdrr->function = *req->deleteFunction;
3291 bdrr->referenceId = req->referenceId;
3293 if (bdrr->num_setnames > 0)
3295 bdrr->statuses = (int*)
3296 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3297 bdrr->num_setnames);
3298 for (i = 0; i < bdrr->num_setnames; i++)
3299 bdrr->statuses[i] = 0;
3301 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3303 res->referenceId = req->referenceId;
3305 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3307 res->deleteListStatuses = 0;
3308 if (bdrr->num_setnames > 0)
3311 res->deleteListStatuses = (Z_ListStatuses *)
3312 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3313 res->deleteListStatuses->num = bdrr->num_setnames;
3314 res->deleteListStatuses->elements =
3316 odr_malloc (assoc->encode,
3317 sizeof(*res->deleteListStatuses->elements) *
3318 bdrr->num_setnames);
3319 for (i = 0; i<bdrr->num_setnames; i++)
3321 res->deleteListStatuses->elements[i] =
3323 odr_malloc (assoc->encode,
3324 sizeof(**res->deleteListStatuses->elements));
3325 res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
3326 res->deleteListStatuses->elements[i]->id =
3327 odr_strdup (assoc->encode, bdrr->setnames[i]);
3330 res->numberNotDeleted = 0;
3331 res->bulkStatuses = 0;
3332 res->deleteMessage = 0;
3335 apdu->which = Z_APDU_deleteResultSetResponse;
3336 apdu->u.deleteResultSetResponse = res;
3339 WRBUF wr = wrbuf_alloc();
3340 wrbuf_printf(wr, "Delete ");
3341 if (bdrr->delete_status)
3342 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3344 wrbuf_printf(wr, "OK -");
3345 for (i = 0; i<req->num_resultSetList; i++)
3346 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3347 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3353 static void process_close(association *assoc, request *reqb)
3355 Z_Close *req = reqb->apdu_request->u.close;
3356 static char *reasons[] =
3363 "securityViolation",
3370 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3371 reasons[*req->closeReason], req->diagnosticInformation ?
3372 req->diagnosticInformation : "NULL");
3373 if (assoc->version < 3) /* to make do_force respond with close */
3375 do_close_req(assoc, Z_Close_finished,
3376 "Association terminated by client", reqb);
3377 yaz_log(log_request,"Close OK");
3380 void save_referenceId (request *reqb, Z_ReferenceId *refid)
3384 reqb->len_refid = refid->len;
3385 reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
3386 memcpy (reqb->refid, refid->buf, refid->len);
3390 reqb->len_refid = 0;
3395 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
3397 process_z_response (a, req, res);
3400 bend_request bend_request_mk (bend_association a)
3402 request *nreq = request_get (&a->outgoing);
3403 nreq->request_mem = nmem_create ();
3407 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
3412 id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
3413 id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
3414 id->len = id->size = req->len_refid;
3415 memcpy (id->buf, req->refid, req->len_refid);
3419 void bend_request_destroy (bend_request *req)
3421 nmem_destroy((*req)->request_mem);
3422 request_release(*req);
3426 int bend_backend_respond (bend_association a, bend_request req)
3430 r = process_z_request (a, req, &msg);
3432 yaz_log (YLOG_WARN, "%s", msg);
3436 void bend_request_setdata(bend_request r, void *p)
3441 void *bend_request_getdata(bend_request r)
3443 return r->clientData;
3446 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
3448 bend_segment_rr req;
3450 req.segment = reqb->apdu_request->u.segmentRequest;
3451 req.stream = assoc->encode;
3452 req.decode = assoc->decode;
3453 req.print = assoc->print;
3454 req.association = assoc;
3456 (*assoc->init->bend_segment)(assoc->backend, &req);
3461 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
3463 bend_esrequest_rr esrequest;
3464 const char *ext_name = "unknown";
3466 Z_ExtendedServicesRequest *req =
3467 reqb->apdu_request->u.extendedServicesRequest;
3468 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3470 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3472 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3473 esrequest.stream = assoc->encode;
3474 esrequest.decode = assoc->decode;
3475 esrequest.print = assoc->print;
3476 esrequest.errcode = 0;
3477 esrequest.errstring = NULL;
3478 esrequest.request = reqb;
3479 esrequest.association = assoc;
3480 esrequest.taskPackage = 0;
3481 esrequest.referenceId = req->referenceId;
3484 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3486 switch(esrequest.esr->taskSpecificParameters->which)
3488 case Z_External_itemOrder:
3489 ext_name = "ItemOrder"; break;
3490 case Z_External_update:
3491 ext_name = "Update"; break;
3492 case Z_External_update0:
3493 ext_name = "Update0"; break;
3494 case Z_External_ESAdmin:
3495 ext_name = "Admin"; break;
3500 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3502 /* If the response is being delayed, return NULL */
3503 if (esrequest.request == NULL)
3506 resp->referenceId = req->referenceId;
3508 if (esrequest.errcode == -1)
3510 /* Backend service indicates request will be processed */
3511 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3512 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3514 else if (esrequest.errcode == 0)
3516 /* Backend service indicates request will be processed */
3517 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3518 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3522 Z_DiagRecs *diagRecs =
3523 zget_DiagRecs(assoc->encode, esrequest.errcode,
3524 esrequest.errstring);
3525 /* Backend indicates error, request will not be processed */
3526 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3527 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3528 resp->num_diagnostics = diagRecs->num_diagRecs;
3529 resp->diagnostics = diagRecs->diagRecs;
3532 WRBUF wr = wrbuf_alloc();
3533 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3534 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3539 /* Do something with the members of bend_extendedservice */
3540 if (esrequest.taskPackage)
3542 resp->taskPackage = z_ext_record_oid(
3543 assoc->encode, yaz_oid_recsyn_extended,
3544 (const char *) esrequest.taskPackage, -1
3547 yaz_log(YLOG_DEBUG,"Send the result apdu");
3551 int bend_assoc_is_alive(bend_association assoc)
3553 if (assoc->state == ASSOC_DEAD)
3554 return 0; /* already marked as dead. Don't check I/O chan anymore */
3556 return iochan_is_alive(assoc->client_chan);
3563 * indent-tabs-mode: nil
3565 * vim: shiftwidth=4 tabstop=8 expandtab