1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2011 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.
38 #include <sys/types.h>
46 #define S_ISREG(x) (x & _S_IFREG)
55 #include <libxml/parser.h>
56 #include <libxml/tree.h>
59 #include <yaz/xmalloc.h>
60 #include <yaz/comstack.h>
64 #include <yaz/proto.h>
65 #include <yaz/oid_db.h>
67 #include <yaz/logrpn.h>
68 #include <yaz/querytowrbuf.h>
69 #include <yaz/statserv.h>
70 #include <yaz/diagbib1.h>
71 #include <yaz/charneg.h>
72 #include <yaz/otherinfo.h>
73 #include <yaz/yaz-util.h>
74 #include <yaz/pquery.h>
75 #include <yaz/oid_db.h>
78 #include <yaz/backend.h>
79 #include <yaz/yaz-ccl.h>
81 static void process_gdu_request(association *assoc, request *req);
82 static int process_z_request(association *assoc, request *req, char **msg);
83 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
84 static int process_z_response(association *assoc, request *req, Z_APDU *res);
85 static Z_APDU *process_initRequest(association *assoc, request *reqb);
86 static Z_External *init_diagnostics(ODR odr, int errcode,
87 const char *errstring);
88 static Z_APDU *process_searchRequest(association *assoc, request *reqb);
89 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
90 bend_search_rr *bsrr);
91 static Z_APDU *process_presentRequest(association *assoc, request *reqb);
92 static Z_APDU *process_scanRequest(association *assoc, request *reqb);
93 static Z_APDU *process_sortRequest(association *assoc, request *reqb);
94 static void process_close(association *assoc, request *reqb);
95 static Z_APDU *process_deleteRequest(association *assoc, request *reqb);
96 static Z_APDU *process_segmentRequest(association *assoc, request *reqb);
97 static Z_APDU *process_ESRequest(association *assoc, request *reqb);
99 /* dynamic logging levels */
100 static int logbits_set = 0;
101 static int log_session = 0; /* one-line logs for session */
102 static int log_sessiondetail = 0; /* more detailed stuff */
103 static int log_request = 0; /* one-line logs for requests */
104 static int log_requestdetail = 0; /* more detailed stuff */
106 /** get_logbits sets global loglevel bits */
107 static void get_logbits(void)
108 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
112 log_session = yaz_log_module_level("session");
113 log_sessiondetail = yaz_log_module_level("sessiondetail");
114 log_request = yaz_log_module_level("request");
115 log_requestdetail = yaz_log_module_level("requestdetail");
119 static void wr_diag(WRBUF w, int error, const char *addinfo)
121 wrbuf_printf(w, "ERROR %d+", error);
122 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
126 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
131 static int odr_int_to_int(Odr_int v)
135 else if (v <= INT_MIN)
142 * Create and initialize a new association-handle.
143 * channel : iochannel for the current line.
144 * link : communications channel.
145 * Returns: 0 or a new association handle.
147 association *create_association(IOCHAN channel, COMSTACK link,
148 const char *apdufile)
154 if (!(anew = (association *)xmalloc(sizeof(*anew))))
158 anew->last_control = 0;
159 anew->client_chan = channel;
160 anew->client_link = link;
161 anew->cs_get_mask = 0;
162 anew->cs_put_mask = 0;
163 anew->cs_accept_mask = 0;
164 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
165 !(anew->encode = odr_createmem(ODR_ENCODE)))
167 if (apdufile && *apdufile)
171 if (!(anew->print = odr_createmem(ODR_PRINT)))
173 if (*apdufile == '@')
175 odr_setprint(anew->print, yaz_log_file());
177 else if (*apdufile != '-')
180 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
181 if (!(f = fopen(filename, "w")))
183 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
186 setvbuf(f, 0, _IONBF, 0);
187 odr_setprint(anew->print, f);
192 anew->input_buffer = 0;
193 anew->input_buffer_len = 0;
195 anew->state = ASSOC_NEW;
196 request_initq(&anew->incoming);
197 request_initq(&anew->outgoing);
198 anew->proto = cs_getproto(link);
204 * Free association and release resources.
206 void destroy_association(association *h)
208 statserv_options_block *cb = statserv_getcontrol();
212 odr_destroy(h->decode);
213 odr_destroy(h->encode);
215 odr_destroy(h->print);
217 xfree(h->input_buffer);
219 (*cb->bend_close)(h->backend);
220 while ((req = request_deq(&h->incoming)))
221 request_release(req);
222 while ((req = request_deq(&h->outgoing)))
223 request_release(req);
224 request_delq(&h->incoming);
225 request_delq(&h->outgoing);
227 xmalloc_trav("session closed");
230 static void do_close_req(association *a, int reason, char *message,
233 Z_APDU *apdu = zget_APDU(a->encode, Z_APDU_close);
234 Z_Close *cls = apdu->u.close;
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 *cls->closeReason = reason;
244 cls->diagnosticInformation = message;
245 process_z_response(a, req, apdu);
246 iochan_settimeout(a->client_chan, 20);
250 request_release(req);
251 yaz_log(log_requestdetail, "v2 client. No Close PDU");
252 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
255 a->state = ASSOC_DEAD;
258 static void do_close(association *a, int reason, char *message)
260 request *req = request_get(&a->outgoing);
261 do_close_req(a, reason, message, req);
265 int ir_read(IOCHAN h, int event)
267 association *assoc = (association *)iochan_getdata(h);
268 COMSTACK conn = assoc->client_link;
271 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
273 yaz_log(YLOG_DEBUG, "ir_session (input)");
274 /* We aren't speaking to this fellow */
275 if (assoc->state == ASSOC_DEAD)
277 yaz_log(log_sessiondetail, "Connection closed - end of session");
279 destroy_association(assoc);
283 assoc->cs_get_mask = EVENT_INPUT;
287 int res = cs_get(conn, &assoc->input_buffer,
288 &assoc->input_buffer_len);
289 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
291 yaz_log(log_session, "Connection error: %s res=%d",
292 cs_errmsg(cs_errno(conn)), res);
293 req = request_get(&assoc->incoming); /* get a new request */
294 do_close_req(assoc, Z_Close_protocolError,
295 "Incoming package too large", req);
300 yaz_log(log_session, "Connection closed by client");
302 destroy_association(assoc);
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 yaz_log(log_requestdetail, "username=%s password-len=%ld",
545 (sr->password ? strlen(sr->password) : 0));
546 auth->which = Z_IdAuthentication_open;
547 auth->u.open = (char *) odr_malloc(assoc->decode, len);
548 strcpy(auth->u.open, sr->username);
549 if (sr->password && *sr->password)
551 strcat(auth->u.open, "/");
552 strcat(auth->u.open, sr->password);
554 assoc->init->auth = auth;
558 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
559 assoc->init->charneg_request = ce->u.charNeg3;
562 if (!(binitres = (*cb->bend_init)(assoc->init)))
564 assoc->state = ASSOC_DEAD;
565 yaz_add_srw_diagnostic(assoc->encode, d, num,
566 YAZ_SRW_AUTHENTICATION_ERROR, 0);
569 assoc->backend = binitres->handle;
570 assoc->init->auth = 0;
571 if (binitres->errcode)
573 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
574 assoc->state = ASSOC_DEAD;
575 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
576 binitres->errstring);
584 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
587 yaz_record_conv_t rc = 0;
588 const char *match_schema = 0;
589 Odr_oid *match_syntax = 0;
594 const char *input_schema = yaz_get_esn(rr->comp);
595 Odr_oid *input_syntax_raw = rr->request_format;
597 const char *backend_schema = 0;
598 Odr_oid *backend_syntax = 0;
600 r = yaz_retrieval_request(assoc->server->retrieval,
608 if (r == -1) /* error ? */
610 const char *details = yaz_retrieval_get_error(
611 assoc->server->retrieval);
613 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
615 rr->errstring = odr_strdup(rr->stream, details);
618 else if (r == 1 || r == 3)
620 const char *details = input_schema;
622 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
624 rr->errstring = odr_strdup(rr->stream, details);
629 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
630 if (input_syntax_raw)
632 char oidbuf[OID_STR_MAX];
633 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
634 rr->errstring = odr_strdup(rr->stream, oidbuf);
640 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
643 rr->request_format = backend_syntax;
645 (*assoc->init->bend_fetch)(assoc->backend, rr);
646 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
647 { /* post conversion must take place .. */
648 WRBUF output_record = wrbuf_alloc();
649 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
652 const char *details = yaz_record_conv_get_error(rc);
653 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
655 rr->errstring = odr_strdup(rr->stream, details);
659 rr->len = wrbuf_len(output_record);
660 rr->record = (char *) odr_malloc(rr->stream, rr->len);
661 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
663 wrbuf_destroy(output_record);
666 rr->output_format = match_syntax;
668 rr->schema = odr_strdup(rr->stream, match_schema);
670 (*assoc->init->bend_fetch)(assoc->backend, rr);
675 static int srw_bend_fetch(association *assoc, int pos,
676 Z_SRW_searchRetrieveRequest *srw_req,
677 Z_SRW_record *record,
678 const char **addinfo)
681 ODR o = assoc->encode;
683 rr.setname = "default";
686 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
688 rr.comp = (Z_RecordComposition *)
689 odr_malloc(assoc->decode, sizeof(*rr.comp));
690 rr.comp->which = Z_RecordComp_complex;
691 rr.comp->u.complex = (Z_CompSpec *)
692 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
693 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
694 odr_malloc(assoc->encode, sizeof(bool_t));
695 *rr.comp->u.complex->selectAlternativeSyntax = 0;
696 rr.comp->u.complex->num_dbSpecific = 0;
697 rr.comp->u.complex->dbSpecific = 0;
698 rr.comp->u.complex->num_recordSyntax = 0;
699 rr.comp->u.complex->recordSyntax = 0;
701 rr.comp->u.complex->generic = (Z_Specification *)
702 odr_malloc(assoc->decode, sizeof(Z_Specification));
704 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
705 rr.comp->u.complex->generic->which = Z_Schema_uri;
706 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
708 /* ESN = recordSchema if recordSchema is present */
709 rr.comp->u.complex->generic->elementSpec = 0;
710 if (srw_req->recordSchema)
712 rr.comp->u.complex->generic->elementSpec =
713 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
714 rr.comp->u.complex->generic->elementSpec->which =
715 Z_ElementSpec_elementSetName;
716 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
717 srw_req->recordSchema;
720 rr.stream = assoc->encode;
721 rr.print = assoc->print;
729 rr.surrogate_flag = 0;
730 rr.schema = srw_req->recordSchema;
732 if (!assoc->init->bend_fetch)
735 retrieve_fetch(assoc, &rr);
737 if (rr.errcode && rr.surrogate_flag)
739 int code = yaz_diag_bib1_to_srw(rr.errcode);
740 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
743 else if (rr.len >= 0)
745 record->recordData_buf = rr.record;
746 record->recordData_len = rr.len;
747 record->recordPosition = odr_intdup(o, pos);
748 record->recordSchema = odr_strdup_null(
749 o, rr.schema ? rr.schema : srw_req->recordSchema);
753 *addinfo = rr.errstring;
759 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
760 Z_Query *query_result, char **sortkeys_p)
762 /* have a CQL query and CQL to PQF transform .. */
763 CQL_parser cp = cql_parser_create();
770 r = cql_parser_string(cp, cql);
773 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
777 struct cql_node *cn = cql_parser_result(cp);
780 r = cql_transform_buf(ct, cn, rpn_buf, sizeof(rpn_buf)-1);
782 srw_errcode = cql_transform_error(ct, &add);
786 int r = cql_sortby_to_sortkeys_buf(cn, out, sizeof(out)-1);
791 yaz_log (log_requestdetail, "srw_sortKeys '%s'", out);
792 *sortkeys_p = odr_strdup(odr, out);
796 yaz_log(log_requestdetail, "failed to create srw_sortKeys");
797 srw_errcode = YAZ_SRW_UNSUPP_SORT_TYPE;
803 /* Syntax & transform OK. */
804 /* Convert PQF string to Z39.50 to RPN query struct */
805 YAZ_PQF_Parser pp = yaz_pqf_create();
806 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
811 int code = yaz_pqf_error(pp, &pqf_msg, &off);
812 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
814 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
818 query_result->which = Z_Query_type_1;
819 query_result->u.type_1 = rpnquery;
823 cql_parser_destroy(cp);
827 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
828 Z_AttributesPlusTerm *result)
833 int srw_error = cql2pqf(odr, cql, ct, &query, &sortkeys);
836 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
837 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
838 rpn = query.u.type_1;
839 if (!rpn->RPNStructure)
840 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
841 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
842 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
843 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
844 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
845 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
851 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
852 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)
861 bsrr->errstring = (char*) ccl_err_msg(errcode);
862 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
865 bsrr->query->which = Z_Query_type_1;
866 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
870 static void srw_bend_search(association *assoc,
875 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
878 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
881 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
882 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
883 if (srw_res->num_diagnostics == 0 && assoc->init)
886 rr.setname = "default";
889 rr.basenames = &srw_req->database;
893 rr.srw_setnameIdleTime = 0;
894 rr.estimated_hit_count = 0;
895 rr.partial_resultset = 0;
896 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
897 rr.query->u.type_1 = 0;
898 rr.extra_args = sr->extra_args;
899 rr.extra_response_data = 0;
901 if (srw_req->query_type == Z_SRW_query_type_cql)
903 if (assoc->server && assoc->server->cql_transform)
905 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
906 assoc->server->cql_transform,
912 yaz_add_srw_diagnostic(assoc->encode,
913 &srw_res->diagnostics,
914 &srw_res->num_diagnostics,
920 /* CQL query to backend. Wrap it - Z39.50 style */
921 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
922 ext->direct_reference = odr_getoidbystr(assoc->decode,
923 "1.2.840.10003.16.2");
924 ext->indirect_reference = 0;
926 ext->which = Z_External_CQL;
927 ext->u.cql = srw_req->query.cql;
929 rr.query->which = Z_Query_type_104;
930 rr.query->u.type_104 = ext;
933 else if (srw_req->query_type == Z_SRW_query_type_pqf)
935 Z_RPNQuery *RPNquery;
936 YAZ_PQF_Parser pqf_parser;
938 pqf_parser = yaz_pqf_create();
940 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
946 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
947 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
948 code, pqf_msg, (long) off);
949 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
952 rr.query->which = Z_Query_type_1;
953 rr.query->u.type_1 = RPNquery;
955 yaz_pqf_destroy(pqf_parser);
959 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
960 &srw_res->num_diagnostics,
961 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
963 if (rr.query->u.type_1)
965 rr.stream = assoc->encode;
966 rr.decode = assoc->decode;
967 rr.print = assoc->print;
968 if (srw_req->sort.sortKeys)
969 rr.srw_sortKeys = odr_strdup(assoc->encode,
970 srw_req->sort.sortKeys);
971 rr.association = assoc;
977 yaz_log_zquery_level(log_requestdetail,rr.query);
979 (assoc->init->bend_search)(assoc->backend, &rr);
982 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
988 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
989 yaz_add_srw_diagnostic(assoc->encode,
990 &srw_res->diagnostics,
991 &srw_res->num_diagnostics,
992 srw_error, rr.errstring);
997 int number = srw_req->maximumRecords ?
998 odr_int_to_int(*srw_req->maximumRecords) : 0;
999 int start = srw_req->startRecord ?
1000 odr_int_to_int(*srw_req->startRecord) : 1;
1002 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
1004 start, number, rr.hits);
1006 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1009 srw_res->resultSetId =
1010 odr_strdup(assoc->encode, rr.srw_setname );
1011 srw_res->resultSetIdleTime =
1012 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1015 if (start > rr.hits || start < 1)
1017 /* if hits<=0 and start=1 we don't return a diagnostic */
1019 yaz_add_srw_diagnostic(
1021 &srw_res->diagnostics, &srw_res->num_diagnostics,
1022 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1024 else if (number > 0)
1028 if (start + number > rr.hits)
1029 number = odr_int_to_int(rr.hits) - start + 1;
1031 /* Call bend_present if defined */
1032 if (assoc->init->bend_present)
1034 bend_present_rr *bprr = (bend_present_rr*)
1035 odr_malloc(assoc->decode, sizeof(*bprr));
1036 bprr->setname = "default";
1037 bprr->start = start;
1038 bprr->number = number;
1039 if (srw_req->recordSchema)
1041 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1042 sizeof(*bprr->comp));
1043 bprr->comp->which = Z_RecordComp_simple;
1044 bprr->comp->u.simple = (Z_ElementSetNames *)
1045 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1046 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1047 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1053 bprr->stream = assoc->encode;
1054 bprr->referenceId = 0;
1055 bprr->print = assoc->print;
1056 bprr->association = assoc;
1058 bprr->errstring = NULL;
1059 (*assoc->init->bend_present)(assoc->backend, bprr);
1063 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1064 yaz_add_srw_diagnostic(assoc->encode,
1065 &srw_res->diagnostics,
1066 &srw_res->num_diagnostics,
1067 srw_error, bprr->errstring);
1075 int packing = Z_SRW_recordPacking_string;
1076 if (srw_req->recordPacking)
1079 yaz_srw_str_to_pack(srw_req->recordPacking);
1081 packing = Z_SRW_recordPacking_string;
1083 srw_res->records = (Z_SRW_record *)
1084 odr_malloc(assoc->encode,
1085 number * sizeof(*srw_res->records));
1087 srw_res->extra_records = (Z_SRW_extra_record **)
1088 odr_malloc(assoc->encode,
1089 number*sizeof(*srw_res->extra_records));
1091 for (i = 0; i<number; i++)
1094 const char *addinfo = 0;
1096 srw_res->records[j].recordPacking = packing;
1097 srw_res->records[j].recordData_buf = 0;
1098 srw_res->extra_records[j] = 0;
1099 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1100 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1101 srw_res->records + j,
1105 yaz_add_srw_diagnostic(assoc->encode,
1106 &srw_res->diagnostics,
1107 &srw_res->num_diagnostics,
1108 yaz_diag_bib1_to_srw(errcode),
1113 if (srw_res->records[j].recordData_buf)
1116 srw_res->num_records = j;
1118 srw_res->records = 0;
1121 if (rr.extra_response_data)
1123 res->extraResponseData_buf = rr.extra_response_data;
1124 res->extraResponseData_len = strlen(rr.extra_response_data);
1126 if (rr.estimated_hit_count || rr.partial_resultset)
1128 yaz_add_srw_diagnostic(
1130 &srw_res->diagnostics,
1131 &srw_res->num_diagnostics,
1132 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1140 const char *querystr = "?";
1141 const char *querytype = "?";
1142 WRBUF wr = wrbuf_alloc();
1144 switch (srw_req->query_type)
1146 case Z_SRW_query_type_cql:
1148 querystr = srw_req->query.cql;
1150 case Z_SRW_query_type_pqf:
1152 querystr = srw_req->query.pqf;
1155 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1156 if (srw_res->num_diagnostics)
1157 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1158 else if (*http_code != 200)
1159 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1160 else if (srw_res->numberOfRecords)
1162 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1163 (srw_res->numberOfRecords ?
1164 *srw_res->numberOfRecords : 0));
1166 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+%d",
1167 (srw_res->resultSetId ?
1168 srw_res->resultSetId : "-"),
1169 (srw_req->startRecord ? *srw_req->startRecord : 1),
1170 srw_res->num_records);
1171 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1176 static char *srw_bend_explain_default(bend_explain_rr *rr)
1179 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1182 for (ptr = ptr->children; ptr; ptr = ptr->next)
1184 if (ptr->type != XML_ELEMENT_NODE)
1186 if (!strcmp((const char *) ptr->name, "explain"))
1189 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1193 ptr = xmlCopyNode(ptr, 1);
1195 xmlDocSetRootElement(doc, ptr);
1197 xmlDocDumpMemory(doc, &buf_out, &len);
1198 content = (char*) odr_malloc(rr->stream, 1+len);
1199 memcpy(content, buf_out, len);
1200 content[len] = '\0';
1204 rr->explain_buf = content;
1212 static void srw_bend_explain(association *assoc,
1214 Z_SRW_explainResponse *srw_res,
1217 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1218 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1220 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1225 rr.stream = assoc->encode;
1226 rr.decode = assoc->decode;
1227 rr.print = assoc->print;
1229 rr.database = srw_req->database;
1231 rr.server_node_ptr = assoc->server->server_node_ptr;
1233 rr.server_node_ptr = 0;
1234 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1235 if (assoc->init->bend_explain)
1236 (*assoc->init->bend_explain)(assoc->backend, &rr);
1238 srw_bend_explain_default(&rr);
1242 int packing = Z_SRW_recordPacking_string;
1243 if (srw_req->recordPacking)
1246 yaz_srw_str_to_pack(srw_req->recordPacking);
1248 packing = Z_SRW_recordPacking_string;
1250 srw_res->record.recordSchema = rr.schema;
1251 srw_res->record.recordPacking = packing;
1252 srw_res->record.recordData_buf = rr.explain_buf;
1253 srw_res->record.recordData_len = strlen(rr.explain_buf);
1254 srw_res->record.recordPosition = 0;
1260 static void srw_bend_scan(association *assoc,
1262 Z_SRW_scanResponse *srw_res,
1265 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1266 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1269 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1270 if (srw_res->num_diagnostics == 0 && assoc->init)
1273 struct scan_entry *save_entries;
1275 bend_scan_rr *bsrr = (bend_scan_rr *)
1276 odr_malloc(assoc->encode, sizeof(*bsrr));
1277 bsrr->num_bases = 1;
1278 bsrr->basenames = &srw_req->database;
1280 bsrr->num_entries = srw_req->maximumTerms ?
1281 odr_int_to_int(*srw_req->maximumTerms) : 10;
1282 bsrr->term_position = srw_req->responsePosition ?
1283 odr_int_to_int(*srw_req->responsePosition) : 1;
1286 bsrr->errstring = 0;
1287 bsrr->referenceId = 0;
1288 bsrr->stream = assoc->encode;
1289 bsrr->print = assoc->print;
1290 bsrr->step_size = &step_size;
1294 if (bsrr->num_entries > 0)
1297 bsrr->entries = (struct scan_entry *)
1298 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1300 for (i = 0; i<bsrr->num_entries; i++)
1302 bsrr->entries[i].term = 0;
1303 bsrr->entries[i].occurrences = 0;
1304 bsrr->entries[i].errcode = 0;
1305 bsrr->entries[i].errstring = 0;
1306 bsrr->entries[i].display_term = 0;
1309 save_entries = bsrr->entries; /* save it so we can compare later */
1311 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1312 assoc->init->bend_scan)
1314 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1316 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1317 &bsrr->attributeset,
1318 srw_req->scanClause.pqf);
1319 yaz_pqf_destroy(pqf_parser);
1320 bsrr->scanClause = 0;
1321 ((int (*)(void *, bend_scan_rr *))
1322 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1324 else if (srw_req->query_type == Z_SRW_query_type_cql
1325 && assoc->init->bend_scan && assoc->server
1326 && assoc->server->cql_transform)
1329 bsrr->scanClause = 0;
1330 bsrr->attributeset = 0;
1331 bsrr->term = (Z_AttributesPlusTerm *)
1332 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1333 srw_error = cql2pqf_scan(assoc->encode,
1334 srw_req->scanClause.cql,
1335 assoc->server->cql_transform,
1338 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1339 &srw_res->num_diagnostics,
1343 ((int (*)(void *, bend_scan_rr *))
1344 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1347 else if (srw_req->query_type == Z_SRW_query_type_cql
1348 && assoc->init->bend_srw_scan)
1351 bsrr->attributeset = 0;
1352 bsrr->scanClause = srw_req->scanClause.cql;
1353 ((int (*)(void *, bend_scan_rr *))
1354 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1358 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1359 &srw_res->num_diagnostics,
1360 YAZ_SRW_UNSUPP_OPERATION, "scan");
1365 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1370 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1372 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1373 &srw_res->num_diagnostics,
1374 srw_error, bsrr->errstring);
1376 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1379 srw_res->terms = (Z_SRW_scanTerm*)
1380 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1383 srw_res->num_terms = bsrr->num_entries;
1384 for (i = 0; i<bsrr->num_entries; i++)
1386 Z_SRW_scanTerm *t = srw_res->terms + i;
1387 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1388 t->numberOfRecords =
1389 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1391 if (save_entries == bsrr->entries &&
1392 bsrr->entries[i].display_term)
1394 /* the entries was _not_ set by the handler. So it's
1395 safe to test for new member display_term. It is
1398 t->displayTerm = odr_strdup(assoc->encode,
1399 bsrr->entries[i].display_term);
1407 WRBUF wr = wrbuf_alloc();
1408 const char *querytype = 0;
1409 const char *querystr = 0;
1411 switch(srw_req->query_type)
1413 case Z_SRW_query_type_pqf:
1415 querystr = srw_req->scanClause.pqf;
1417 case Z_SRW_query_type_cql:
1419 querystr = srw_req->scanClause.cql;
1422 querytype = "UNKNOWN";
1426 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1428 if (srw_res->num_diagnostics)
1429 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1430 else if (srw_res->num_terms)
1431 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1433 wrbuf_printf(wr, "OK - - ");
1435 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1436 (srw_req->responsePosition ?
1437 *srw_req->responsePosition : 1),
1438 (srw_req->maximumTerms ?
1439 *srw_req->maximumTerms : 1));
1440 /* there is no step size in SRU/W ??? */
1441 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1442 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1448 static void srw_bend_update(association *assoc,
1450 Z_SRW_updateResponse *srw_res,
1453 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1454 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1455 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1457 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1461 Z_SRW_extra_record *extra = srw_req->extra_record;
1463 rr.stream = assoc->encode;
1464 rr.print = assoc->print;
1466 rr.basenames = &srw_req->database;
1467 rr.operation = srw_req->operation;
1468 rr.operation_status = "failed";
1470 rr.record_versions = 0;
1471 rr.num_versions = 0;
1472 rr.record_packing = "string";
1473 rr.record_schema = 0;
1475 rr.extra_record_data = 0;
1476 rr.extra_request_data = 0;
1477 rr.extra_response_data = 0;
1483 if (rr.operation == 0)
1485 yaz_add_sru_update_diagnostic(
1486 assoc->encode, &srw_res->diagnostics,
1487 &srw_res->num_diagnostics,
1488 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1492 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1493 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1494 if (!strcmp( rr.operation, "delete"))
1496 if (srw_req->record && !srw_req->record->recordSchema)
1498 rr.record_schema = odr_strdup(
1500 srw_req->record->recordSchema);
1502 if (srw_req->record)
1504 rr.record_data = odr_strdupn(
1506 srw_req->record->recordData_buf,
1507 srw_req->record->recordData_len );
1509 if (extra && extra->extraRecordData_len)
1511 rr.extra_record_data = odr_strdupn(
1513 extra->extraRecordData_buf,
1514 extra->extraRecordData_len );
1516 if (srw_req->recordId)
1517 rr.record_id = srw_req->recordId;
1518 else if (extra && extra->recordIdentifier)
1519 rr.record_id = extra->recordIdentifier;
1521 else if (!strcmp(rr.operation, "replace"))
1523 if (srw_req->recordId)
1524 rr.record_id = srw_req->recordId;
1525 else if (extra && extra->recordIdentifier)
1526 rr.record_id = extra->recordIdentifier;
1529 yaz_add_sru_update_diagnostic(
1530 assoc->encode, &srw_res->diagnostics,
1531 &srw_res->num_diagnostics,
1532 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1533 "recordIdentifier");
1535 if (!srw_req->record)
1537 yaz_add_sru_update_diagnostic(
1538 assoc->encode, &srw_res->diagnostics,
1539 &srw_res->num_diagnostics,
1540 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1545 if (srw_req->record->recordSchema)
1546 rr.record_schema = odr_strdup(
1547 assoc->encode, srw_req->record->recordSchema);
1548 if (srw_req->record->recordData_len )
1550 rr.record_data = odr_strdupn(assoc->encode,
1551 srw_req->record->recordData_buf,
1552 srw_req->record->recordData_len );
1556 yaz_add_sru_update_diagnostic(
1557 assoc->encode, &srw_res->diagnostics,
1558 &srw_res->num_diagnostics,
1559 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1563 if (extra && extra->extraRecordData_len)
1565 rr.extra_record_data = odr_strdupn(
1567 extra->extraRecordData_buf,
1568 extra->extraRecordData_len );
1571 else if (!strcmp(rr.operation, "insert"))
1573 if (srw_req->recordId)
1574 rr.record_id = srw_req->recordId;
1576 rr.record_id = extra->recordIdentifier;
1578 if (srw_req->record)
1580 if (srw_req->record->recordSchema)
1581 rr.record_schema = odr_strdup(
1582 assoc->encode, srw_req->record->recordSchema);
1584 if (srw_req->record->recordData_len)
1585 rr.record_data = odr_strdupn(
1587 srw_req->record->recordData_buf,
1588 srw_req->record->recordData_len );
1590 if (extra && extra->extraRecordData_len)
1592 rr.extra_record_data = odr_strdupn(
1594 extra->extraRecordData_buf,
1595 extra->extraRecordData_len );
1599 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1600 &srw_res->num_diagnostics,
1601 YAZ_SRU_UPDATE_INVALID_ACTION,
1604 if (srw_req->record)
1606 const char *pack_str =
1607 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1609 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1612 if (srw_req->num_recordVersions)
1614 rr.record_versions = srw_req->recordVersions;
1615 rr.num_versions = srw_req->num_recordVersions;
1617 if (srw_req->extraRequestData_len)
1619 rr.extra_request_data = odr_strdupn(assoc->encode,
1620 srw_req->extraRequestData_buf,
1621 srw_req->extraRequestData_len );
1623 if (srw_res->num_diagnostics == 0)
1625 if ( assoc->init->bend_srw_update)
1626 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1628 yaz_add_sru_update_diagnostic(
1629 assoc->encode, &srw_res->diagnostics,
1630 &srw_res->num_diagnostics,
1631 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1632 "No Update backend handler");
1636 yaz_add_srw_diagnostic_uri(assoc->encode,
1637 &srw_res->diagnostics,
1638 &srw_res->num_diagnostics,
1642 srw_res->recordId = rr.record_id;
1643 srw_res->operationStatus = rr.operation_status;
1644 srw_res->recordVersions = rr.record_versions;
1645 srw_res->num_recordVersions = rr.num_versions;
1646 if (srw_res->extraResponseData_len)
1648 srw_res->extraResponseData_buf = rr.extra_response_data;
1649 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1651 if (srw_res->num_diagnostics == 0 && rr.record_data)
1653 srw_res->record = yaz_srw_get_record(assoc->encode);
1654 srw_res->record->recordSchema = rr.record_schema;
1655 if (rr.record_packing)
1657 int pack = yaz_srw_str_to_pack(rr.record_packing);
1661 pack = Z_SRW_recordPacking_string;
1662 yaz_log(YLOG_WARN, "Back packing %s from backend",
1665 srw_res->record->recordPacking = pack;
1667 srw_res->record->recordData_buf = rr.record_data;
1668 srw_res->record->recordData_len = strlen(rr.record_data);
1669 if (rr.extra_record_data)
1671 Z_SRW_extra_record *ex =
1672 yaz_srw_get_extra_record(assoc->encode);
1673 srw_res->extra_record = ex;
1674 ex->extraRecordData_buf = rr.extra_record_data;
1675 ex->extraRecordData_len = strlen(rr.extra_record_data);
1681 /* check if path is OK (1); BAD (0) */
1682 static int check_path(const char *path)
1686 if (strstr(path, ".."))
1691 static char *read_file(const char *fname, ODR o, size_t *sz)
1694 FILE *inf = fopen(fname, "rb");
1698 fseek(inf, 0L, SEEK_END);
1701 buf = (char *) odr_malloc(o, *sz);
1702 if (fread(buf, 1, *sz, inf) != *sz)
1703 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1708 static void process_http_request(association *assoc, request *req)
1710 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1711 ODR o = assoc->encode;
1712 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1714 Z_SOAP *soap_package = 0;
1717 Z_HTTP_Response *hres = 0;
1719 const char *stylesheet = 0; /* for now .. set later */
1720 Z_SRW_diagnostic *diagnostic = 0;
1721 int num_diagnostic = 0;
1722 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1724 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1725 if (!control_association(assoc, host, 0))
1727 p = z_get_HTTP_Response(o, 404);
1730 if (r == 2 && assoc->server && assoc->server->docpath
1731 && hreq->path[0] == '/'
1733 /* check if path is a proper prefix of documentroot */
1734 strncmp(hreq->path+1, assoc->server->docpath,
1735 strlen(assoc->server->docpath))
1738 if (!check_path(hreq->path))
1740 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1741 p = z_get_HTTP_Response(o, 404);
1745 size_t content_size = 0;
1746 char *content_buf = read_file(hreq->path+1, o, &content_size);
1749 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1750 p = z_get_HTTP_Response(o, 404);
1754 const char *ctype = 0;
1755 yaz_mime_types types = yaz_mime_types_create();
1757 yaz_mime_types_add(types, "xsl", "application/xml");
1758 yaz_mime_types_add(types, "xml", "application/xml");
1759 yaz_mime_types_add(types, "css", "text/css");
1760 yaz_mime_types_add(types, "html", "text/html");
1761 yaz_mime_types_add(types, "htm", "text/html");
1762 yaz_mime_types_add(types, "txt", "text/plain");
1763 yaz_mime_types_add(types, "js", "application/x-javascript");
1765 yaz_mime_types_add(types, "gif", "image/gif");
1766 yaz_mime_types_add(types, "png", "image/png");
1767 yaz_mime_types_add(types, "jpg", "image/jpeg");
1768 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1770 ctype = yaz_mime_lookup_fname(types, hreq->path);
1773 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1774 p = z_get_HTTP_Response(o, 404);
1778 p = z_get_HTTP_Response(o, 200);
1779 hres = p->u.HTTP_Response;
1780 hres->content_buf = content_buf;
1781 hres->content_len = content_size;
1782 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1784 yaz_mime_types_destroy(types);
1792 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1793 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1795 if (r == 2) /* not taken */
1797 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1798 &diagnostic, &num_diagnostic);
1799 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1801 if (r == 0) /* decode SRW/SRU OK .. */
1803 int http_code = 200;
1804 if (sr->which == Z_SRW_searchRetrieve_request)
1807 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1809 stylesheet = sr->u.request->stylesheet;
1812 res->u.response->diagnostics = diagnostic;
1813 res->u.response->num_diagnostics = num_diagnostic;
1817 srw_bend_search(assoc, sr, res, &http_code);
1819 if (http_code == 200)
1820 soap_package->u.generic->p = res;
1822 else if (sr->which == Z_SRW_explain_request)
1824 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1826 stylesheet = sr->u.explain_request->stylesheet;
1829 res->u.explain_response->diagnostics = diagnostic;
1830 res->u.explain_response->num_diagnostics = num_diagnostic;
1832 srw_bend_explain(assoc, sr, res->u.explain_response, &http_code);
1833 if (http_code == 200)
1834 soap_package->u.generic->p = res;
1836 else if (sr->which == Z_SRW_scan_request)
1838 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1840 stylesheet = sr->u.scan_request->stylesheet;
1843 res->u.scan_response->diagnostics = diagnostic;
1844 res->u.scan_response->num_diagnostics = num_diagnostic;
1846 srw_bend_scan(assoc, sr, res->u.scan_response, &http_code);
1847 if (http_code == 200)
1848 soap_package->u.generic->p = res;
1850 else if (sr->which == Z_SRW_update_request)
1852 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1854 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1857 res->u.update_response->diagnostics = diagnostic;
1858 res->u.update_response->num_diagnostics = num_diagnostic;
1860 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1861 srw_bend_update(assoc, sr, res->u.update_response, &http_code);
1862 if (http_code == 200)
1863 soap_package->u.generic->p = res;
1867 yaz_log(log_request, "SOAP ERROR");
1868 /* FIXME - what error, what query */
1870 z_soap_error(assoc->encode, soap_package,
1871 "SOAP-ENV:Client", "Bad method", 0);
1873 if (http_code == 200 || http_code == 500)
1875 static Z_SOAP_Handler soap_handlers[4] = {
1877 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1878 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1879 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1884 p = z_get_HTTP_Response(o, 200);
1885 hres = p->u.HTTP_Response;
1887 if (!stylesheet && assoc->server)
1888 stylesheet = assoc->server->stylesheet;
1890 /* empty stylesheet means NO stylesheet */
1891 if (stylesheet && *stylesheet == '\0')
1894 z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1895 &hres->content_buf, &hres->content_len,
1896 soap_handlers, charset, stylesheet);
1897 hres->code = http_code;
1899 strcpy(ctype, "text/xml");
1900 if (charset && strlen(charset) < sizeof(ctype)-30)
1902 strcat(ctype, "; charset=");
1903 strcat(ctype, charset);
1905 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1908 p = z_get_HTTP_Response(o, http_code);
1912 p = z_get_HTTP_Response(o, 500);
1913 hres = p->u.HTTP_Response;
1914 if (!strcmp(hreq->version, "1.0"))
1916 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1917 if (v && !strcmp(v, "Keep-Alive"))
1921 hres->version = "1.0";
1925 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1926 if (v && !strcmp(v, "close"))
1930 hres->version = "1.1";
1932 if (!keepalive || !assoc->last_control->keepalive)
1934 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1935 assoc->state = ASSOC_DEAD;
1936 assoc->cs_get_mask = 0;
1941 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1943 if (alive && yaz_isdigit(*(const unsigned char *) alive))
1947 if (t < 0 || t > 3600)
1949 iochan_settimeout(assoc->client_chan,t);
1950 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1952 process_gdu_response(assoc, req, p);
1955 static void process_gdu_request(association *assoc, request *req)
1957 if (req->gdu_request->which == Z_GDU_Z3950)
1960 req->apdu_request = req->gdu_request->u.z3950;
1961 if (process_z_request(assoc, req, &msg) < 0)
1962 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1964 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1965 process_http_request(assoc, req);
1968 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1973 * Initiate request processing.
1975 static int process_z_request(association *assoc, request *req, char **msg)
1980 *msg = "Unknown Error";
1981 assert(req && req->state == REQUEST_IDLE);
1982 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1984 *msg = "Missing InitRequest";
1987 switch (req->apdu_request->which)
1989 case Z_APDU_initRequest:
1990 res = process_initRequest(assoc, req); break;
1991 case Z_APDU_searchRequest:
1992 res = process_searchRequest(assoc, req); break;
1993 case Z_APDU_presentRequest:
1994 res = process_presentRequest(assoc, req); break;
1995 case Z_APDU_scanRequest:
1996 if (assoc->init->bend_scan)
1997 res = process_scanRequest(assoc, req);
2000 *msg = "Cannot handle Scan APDU";
2004 case Z_APDU_extendedServicesRequest:
2005 if (assoc->init->bend_esrequest)
2006 res = process_ESRequest(assoc, req);
2009 *msg = "Cannot handle Extended Services APDU";
2013 case Z_APDU_sortRequest:
2014 if (assoc->init->bend_sort)
2015 res = process_sortRequest(assoc, req);
2018 *msg = "Cannot handle Sort APDU";
2023 process_close(assoc, req);
2025 case Z_APDU_deleteResultSetRequest:
2026 if (assoc->init->bend_delete)
2027 res = process_deleteRequest(assoc, req);
2030 *msg = "Cannot handle Delete APDU";
2034 case Z_APDU_segmentRequest:
2035 if (assoc->init->bend_segment)
2037 res = process_segmentRequest(assoc, req);
2041 *msg = "Cannot handle Segment APDU";
2045 case Z_APDU_triggerResourceControlRequest:
2048 *msg = "Bad APDU received";
2053 yaz_log(YLOG_DEBUG, " result immediately available");
2054 retval = process_z_response(assoc, req, res);
2058 yaz_log(YLOG_DEBUG, " result unavailable");
2065 * Encode response, and transfer the request structure to the outgoing queue.
2067 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2069 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2073 if (!z_GDU(assoc->print, &res, 0, 0))
2074 yaz_log(YLOG_WARN, "ODR print error: %s",
2075 odr_errmsg(odr_geterror(assoc->print)));
2076 odr_reset(assoc->print);
2078 if (!z_GDU(assoc->encode, &res, 0, 0))
2080 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2081 odr_errmsg(odr_geterror(assoc->decode)),
2082 odr_getelement(assoc->decode));
2085 req->response = odr_getbuf(assoc->encode, &req->len_response,
2086 &req->size_response);
2087 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2088 odr_reset(assoc->encode);
2089 req->state = REQUEST_IDLE;
2090 request_enq(&assoc->outgoing, req);
2091 /* turn the work over to the ir_session handler */
2092 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2093 assoc->cs_put_mask = EVENT_OUTPUT;
2094 /* Is there more work to be done? give that to the input handler too */
2097 req = request_head(&assoc->incoming);
2098 if (req && req->state == REQUEST_IDLE)
2100 request_deq(&assoc->incoming);
2101 process_gdu_request(assoc, req);
2110 * Encode response, and transfer the request structure to the outgoing queue.
2112 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2114 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*gres));
2115 gres->which = Z_GDU_Z3950;
2116 gres->u.z3950 = res;
2118 return process_gdu_response(assoc, req, gres);
2121 static char *get_vhost(Z_OtherInformation *otherInfo)
2123 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2127 * Handle init request.
2128 * At the moment, we don't check the options
2129 * anywhere else in the code - we just try not to do anything that would
2130 * break a naive client. We'll toss 'em into the association block when
2131 * we need them there.
2133 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2135 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2136 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2137 Z_InitResponse *resp = apdu->u.initResponse;
2138 bend_initresult *binitres;
2140 statserv_options_block *cb = 0; /* by default no control for backend */
2142 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2143 cb = statserv_getcontrol(); /* got control block for backend */
2145 if (cb && assoc->backend)
2146 (*cb->bend_close)(assoc->backend);
2148 yaz_log(log_requestdetail, "Got initRequest");
2149 if (req->implementationId)
2150 yaz_log(log_requestdetail, "Id: %s",
2151 req->implementationId);
2152 if (req->implementationName)
2153 yaz_log(log_requestdetail, "Name: %s",
2154 req->implementationName);
2155 if (req->implementationVersion)
2156 yaz_log(log_requestdetail, "Version: %s",
2157 req->implementationVersion);
2159 assoc_init_reset(assoc);
2161 assoc->init->auth = req->idAuthentication;
2162 assoc->init->referenceId = req->referenceId;
2164 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2166 Z_CharSetandLanguageNegotiation *negotiation =
2167 yaz_get_charneg_record (req->otherInfo);
2169 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2170 assoc->init->charneg_request = negotiation;
2173 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2174 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2175 assoc->init->named_result_sets = 1;
2180 if (req->implementationVersion)
2181 yaz_log(log_requestdetail, "Config: %s",
2184 iochan_settimeout(assoc->client_chan, cb->idle_timeout);
2186 /* we have a backend control block, so call that init function */
2187 if (!(binitres = (*cb->bend_init)(assoc->init)))
2189 yaz_log(YLOG_WARN, "Bad response from backend.");
2192 assoc->backend = binitres->handle;
2196 /* no backend. return error */
2197 binitres = (bend_initresult *)
2198 odr_malloc(assoc->encode, sizeof(*binitres));
2199 binitres->errstring = 0;
2200 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2201 iochan_settimeout(assoc->client_chan, 10);
2203 if ((assoc->init->bend_sort))
2204 yaz_log(YLOG_DEBUG, "Sort handler installed");
2205 if ((assoc->init->bend_search))
2206 yaz_log(YLOG_DEBUG, "Search handler installed");
2207 if ((assoc->init->bend_present))
2208 yaz_log(YLOG_DEBUG, "Present handler installed");
2209 if ((assoc->init->bend_esrequest))
2210 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2211 if ((assoc->init->bend_delete))
2212 yaz_log(YLOG_DEBUG, "Delete handler installed");
2213 if ((assoc->init->bend_scan))
2214 yaz_log(YLOG_DEBUG, "Scan handler installed");
2215 if ((assoc->init->bend_segment))
2216 yaz_log(YLOG_DEBUG, "Segment handler installed");
2218 resp->referenceId = req->referenceId;
2220 /* let's tell the client what we can do */
2221 if (ODR_MASK_GET(req->options, Z_Options_search))
2223 ODR_MASK_SET(resp->options, Z_Options_search);
2224 strcat(options, "srch");
2226 if (ODR_MASK_GET(req->options, Z_Options_present))
2228 ODR_MASK_SET(resp->options, Z_Options_present);
2229 strcat(options, " prst");
2231 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2232 assoc->init->bend_delete)
2234 ODR_MASK_SET(resp->options, Z_Options_delSet);
2235 strcat(options, " del");
2237 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2238 assoc->init->bend_esrequest)
2240 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2241 strcat(options, " extendedServices");
2243 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2244 && assoc->init->named_result_sets)
2246 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2247 strcat(options, " namedresults");
2249 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2251 ODR_MASK_SET(resp->options, Z_Options_scan);
2252 strcat(options, " scan");
2254 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2256 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2257 strcat(options, " concurrop");
2259 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2261 ODR_MASK_SET(resp->options, Z_Options_sort);
2262 strcat(options, " sort");
2265 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2267 Z_OtherInformationUnit *p0;
2269 if (!assoc->init->charneg_response)
2271 if (assoc->init->query_charset)
2273 assoc->init->charneg_response = yaz_set_response_charneg(
2274 assoc->encode, assoc->init->query_charset, 0,
2275 assoc->init->records_in_same_charset);
2279 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2282 if (assoc->init->charneg_response
2283 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2285 p0->which = Z_OtherInfo_externallyDefinedInfo;
2286 p0->information.externallyDefinedInfo =
2287 assoc->init->charneg_response;
2288 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2289 strcat(options, " negotiation");
2292 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2293 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2295 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2297 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2298 assoc->version = 1; /* 1 & 2 are equivalent */
2300 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2302 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2305 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2307 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2311 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2313 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2314 assoc->maximumRecordSize = odr_int_to_int(*req->maximumRecordSize);
2316 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2317 assoc->preferredMessageSize = odr_int_to_int(*req->preferredMessageSize);
2319 resp->preferredMessageSize =
2320 odr_intdup(assoc->encode, assoc->preferredMessageSize);
2321 resp->maximumRecordSize =
2322 odr_intdup(assoc->encode, assoc->maximumRecordSize);
2324 resp->implementationId = odr_prepend(assoc->encode,
2325 assoc->init->implementation_id,
2326 resp->implementationId);
2328 resp->implementationName = odr_prepend(assoc->encode,
2329 assoc->init->implementation_name,
2330 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2332 if (binitres->errcode)
2334 assoc->state = ASSOC_DEAD;
2335 resp->userInformationField =
2336 init_diagnostics(assoc->encode, binitres->errcode,
2337 binitres->errstring);
2341 assoc->state = ASSOC_UP;
2345 if (!req->idAuthentication)
2346 yaz_log(log_request, "Auth none");
2347 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2349 const char *open = req->idAuthentication->u.open;
2350 const char *slash = strchr(open, '/');
2356 yaz_log(log_request, "Auth open %.*s", len, open);
2358 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2360 const char *user = req->idAuthentication->u.idPass->userId;
2361 const char *group = req->idAuthentication->u.idPass->groupId;
2362 yaz_log(log_request, "Auth idPass %s %s",
2363 user ? user : "-", group ? group : "-");
2365 else if (req->idAuthentication->which
2366 == Z_IdAuthentication_anonymous)
2368 yaz_log(log_request, "Auth anonymous");
2372 yaz_log(log_request, "Auth other");
2377 WRBUF wr = wrbuf_alloc();
2378 wrbuf_printf(wr, "Init ");
2379 if (binitres->errcode)
2380 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2382 wrbuf_printf(wr, "OK -");
2383 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2384 (req->implementationId ? req->implementationId :"-"),
2385 (req->implementationName ?
2386 req->implementationName : "-"),
2387 (req->implementationVersion ?
2388 req->implementationVersion : "-")
2390 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2397 * Set the specified `errcode' and `errstring' into a UserInfo-1
2398 * external to be returned to the client in accordance with Z35.90
2399 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2400 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2402 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2404 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2405 addinfo ? " -- " : "", addinfo ? addinfo : "");
2406 return zget_init_diagnostics(odr, error, addinfo);
2410 * nonsurrogate diagnostic record.
2412 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2414 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2416 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2417 addinfo ? " -- " : "", addinfo ? addinfo : "");
2419 rec->which = Z_Records_NSD;
2420 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2426 * surrogate diagnostic.
2428 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2430 int error, const char *addinfo)
2432 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2433 addinfo ? " -- " : "", addinfo ? addinfo : "");
2434 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2437 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2438 Odr_int *num, Z_RecordComposition *comp,
2439 Odr_int *next, Odr_int *pres,
2440 Z_ReferenceId *referenceId,
2441 Odr_oid *oid, int *errcode)
2443 int recno, total_length = 0, dumped_records = 0;
2444 int toget = odr_int_to_int(*num);
2445 Z_Records *records =
2446 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2447 Z_NamePlusRecordList *reclist =
2448 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2450 records->which = Z_Records_DBOSD;
2451 records->u.databaseOrSurDiagnostics = reclist;
2452 reclist->num_records = 0;
2455 return diagrec(a, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, 0);
2456 else if (toget == 0)
2457 reclist->records = odr_nullval();
2459 reclist->records = (Z_NamePlusRecord **)
2460 odr_malloc(a->encode, sizeof(*reclist->records) * toget);
2462 *pres = Z_PresentStatus_success;
2466 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2467 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2468 a->maximumRecordSize);
2469 for (recno = odr_int_to_int(start); reclist->num_records < toget; recno++)
2472 Z_NamePlusRecord *thisrec;
2473 int this_length = 0;
2475 * we get the number of bytes allocated on the stream before any
2476 * allocation done by the backend - this should give us a reasonable
2477 * idea of the total size of the data so far.
2479 total_length = odr_total(a->encode) - dumped_records;
2485 freq.last_in_set = 0;
2486 freq.setname = setname;
2487 freq.surrogate_flag = 0;
2488 freq.number = recno;
2490 freq.request_format = oid;
2491 freq.output_format = 0;
2492 freq.stream = a->encode;
2493 freq.print = a->print;
2494 freq.referenceId = referenceId;
2497 retrieve_fetch(a, &freq);
2499 *next = freq.last_in_set ? 0 : recno + 1;
2503 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2506 *pres = Z_PresentStatus_failure;
2507 /* for 'present request out of range',
2508 set addinfo to record position if not set */
2509 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2510 freq.errstring == 0)
2512 sprintf(s, "%d", recno);
2516 *errcode = freq.errcode;
2517 return diagrec(a, freq.errcode, freq.errstring);
2519 reclist->records[reclist->num_records] =
2520 surrogatediagrec(a, freq.basename, freq.errcode,
2522 reclist->num_records++;
2525 if (freq.record == 0) /* no error and no record ? */
2527 *pres = Z_PresentStatus_partial_4;
2528 *next = 0; /* signal end-of-set and stop */
2532 this_length = freq.len;
2534 this_length = odr_total(a->encode) - total_length - dumped_records;
2535 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2536 this_length, total_length, dumped_records);
2537 if (a->preferredMessageSize > 0 &&
2538 this_length + total_length > a->preferredMessageSize)
2540 /* record is small enough, really */
2541 if (this_length <= a->preferredMessageSize && recno > start)
2543 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2544 *pres = Z_PresentStatus_partial_2;
2549 /* record can only be fetched by itself */
2550 if (this_length < a->maximumRecordSize)
2552 yaz_log(log_requestdetail, " Record > prefmsgsz");
2555 yaz_log(YLOG_DEBUG, " Dropped it");
2556 reclist->records[reclist->num_records] =
2559 YAZ_BIB1_RECORD_EXCEEDS_PREFERRED_MESSAGE_SIZE, 0);
2560 reclist->num_records++;
2561 dumped_records += this_length;
2565 else /* too big entirely */
2567 yaz_log(log_requestdetail, "Record > maxrcdsz "
2569 this_length, a->maximumRecordSize);
2570 reclist->records[reclist->num_records] =
2573 YAZ_BIB1_RECORD_EXCEEDS_MAXIMUM_RECORD_SIZE, 0);
2574 reclist->num_records++;
2575 dumped_records += this_length;
2580 if (!(thisrec = (Z_NamePlusRecord *)
2581 odr_malloc(a->encode, sizeof(*thisrec))))
2583 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2584 thisrec->which = Z_NamePlusRecord_databaseRecord;
2586 if (!freq.output_format)
2588 yaz_log(YLOG_WARN, "bend_fetch output_format not set");
2591 thisrec->u.databaseRecord = z_ext_record_oid(
2592 a->encode, freq.output_format, freq.record, freq.len);
2593 if (!thisrec->u.databaseRecord)
2595 reclist->records[reclist->num_records] = thisrec;
2596 reclist->num_records++;
2598 *num = reclist->num_records;
2602 static Z_APDU *process_searchRequest(association *assoc, request *reqb)
2604 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2605 bend_search_rr *bsrr =
2606 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2608 yaz_log(log_requestdetail, "Got SearchRequest.");
2609 bsrr->association = assoc;
2610 bsrr->referenceId = req->referenceId;
2611 bsrr->srw_sortKeys = 0;
2612 bsrr->srw_setname = 0;
2613 bsrr->srw_setnameIdleTime = 0;
2614 bsrr->estimated_hit_count = 0;
2615 bsrr->partial_resultset = 0;
2616 bsrr->extra_args = 0;
2617 bsrr->extra_response_data = 0;
2619 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2620 if (req->databaseNames)
2623 for (i = 0; i < req->num_databaseNames; i++)
2624 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2627 yaz_log_zquery_level(log_requestdetail,req->query);
2629 if (assoc->init->bend_search)
2631 bsrr->setname = req->resultSetName;
2632 bsrr->replace_set = *req->replaceIndicator;
2633 bsrr->num_bases = req->num_databaseNames;
2634 bsrr->basenames = req->databaseNames;
2635 bsrr->query = req->query;
2636 bsrr->stream = assoc->encode;
2637 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2638 bsrr->decode = assoc->decode;
2639 bsrr->print = assoc->print;
2642 bsrr->errstring = NULL;
2643 bsrr->search_info = NULL;
2644 bsrr->search_input = req->otherInfo;
2646 if (assoc->server && assoc->server->cql_transform
2647 && req->query->which == Z_Query_type_104
2648 && req->query->u.type_104->which == Z_External_CQL)
2650 /* have a CQL query and a CQL to PQF transform .. */
2652 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2653 assoc->server->cql_transform, bsrr->query,
2654 &bsrr->srw_sortKeys);
2656 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2659 if (assoc->server && assoc->server->ccl_transform
2660 && req->query->which == Z_Query_type_2) /*CCL*/
2662 /* have a CCL query and a CCL to PQF transform .. */
2664 ccl2pqf(bsrr->stream, req->query->u.type_2,
2665 assoc->server->ccl_transform, bsrr);
2667 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2671 (assoc->init->bend_search)(assoc->backend, bsrr);
2675 /* FIXME - make a diagnostic for it */
2676 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2678 return response_searchRequest(assoc, reqb, bsrr);
2682 * Prepare a searchresponse based on the backend results. We probably want
2683 * to look at making the fetching of records nonblocking as well, but
2684 * so far, we'll keep things simple.
2685 * If bsrt is null, that means we're called in response to a communications
2686 * event, and we'll have to get the response for ourselves.
2688 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2689 bend_search_rr *bsrt)
2691 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2692 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2693 Z_SearchResponse *resp = (Z_SearchResponse *)
2694 odr_malloc(assoc->encode, sizeof(*resp));
2695 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2696 Odr_int *next = odr_intdup(assoc->encode, 0);
2697 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2698 Odr_int returnedrecs = 0;
2700 apdu->which = Z_APDU_searchResponse;
2701 apdu->u.searchResponse = resp;
2702 resp->referenceId = req->referenceId;
2703 resp->additionalSearchInfo = 0;
2704 resp->otherInfo = 0;
2707 yaz_log(YLOG_FATAL, "Bad result from backend");
2710 else if (bsrt->errcode)
2712 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2713 resp->resultCount = nulint;
2714 resp->numberOfRecordsReturned = nulint;
2715 resp->nextResultSetPosition = nulint;
2716 resp->searchStatus = odr_booldup(assoc->encode, 0);
2717 resp->resultSetStatus = none;
2718 resp->presentStatus = 0;
2722 bool_t *sr = odr_booldup(assoc->encode, 1);
2723 Odr_int *toget = odr_intdup(assoc->encode, 0);
2724 Z_RecordComposition comp, *compp = 0;
2726 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2729 resp->resultCount = &bsrt->hits;
2731 comp.which = Z_RecordComp_simple;
2732 /* how many records does the user agent want, then? */
2735 else if (bsrt->hits <= *req->smallSetUpperBound)
2737 *toget = bsrt->hits;
2738 if ((comp.u.simple = req->smallSetElementSetNames))
2741 else if (bsrt->hits < *req->largeSetLowerBound)
2743 *toget = *req->mediumSetPresentNumber;
2744 if (*toget > bsrt->hits)
2745 *toget = bsrt->hits;
2746 if ((comp.u.simple = req->mediumSetElementSetNames))
2752 if (*toget && !resp->records)
2754 Odr_int *presst = odr_intdup(assoc->encode, 0);
2755 /* Call bend_present if defined */
2756 if (assoc->init->bend_present)
2758 bend_present_rr *bprr = (bend_present_rr *)
2759 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2760 bprr->setname = req->resultSetName;
2762 bprr->number = odr_int_to_int(*toget);
2763 bprr->format = req->preferredRecordSyntax;
2765 bprr->referenceId = req->referenceId;
2766 bprr->stream = assoc->encode;
2767 bprr->print = assoc->print;
2768 bprr->association = assoc;
2770 bprr->errstring = NULL;
2771 (*assoc->init->bend_present)(assoc->backend, bprr);
2775 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2776 *resp->presentStatus = Z_PresentStatus_failure;
2781 resp->records = pack_records(
2782 assoc, req->resultSetName, 1,
2783 toget, compp, next, presst, req->referenceId,
2784 req->preferredRecordSyntax, NULL);
2787 resp->numberOfRecordsReturned = toget;
2788 returnedrecs = *toget;
2789 resp->presentStatus = presst;
2793 if (*resp->resultCount)
2795 resp->numberOfRecordsReturned = nulint;
2796 resp->presentStatus = 0;
2798 resp->nextResultSetPosition = next;
2799 resp->searchStatus = sr;
2800 resp->resultSetStatus = 0;
2801 if (bsrt->estimated_hit_count)
2803 resp->resultSetStatus = odr_intdup(assoc->encode,
2804 Z_SearchResponse_estimate);
2806 else if (bsrt->partial_resultset)
2808 resp->resultSetStatus = odr_intdup(assoc->encode,
2809 Z_SearchResponse_subset);
2812 resp->additionalSearchInfo = bsrt->search_info;
2817 WRBUF wr = wrbuf_alloc();
2819 for (i = 0 ; i < req->num_databaseNames; i++)
2822 wrbuf_printf(wr, "+");
2823 wrbuf_puts(wr, req->databaseNames[i]);
2825 wrbuf_printf(wr, " ");
2828 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2830 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2831 wrbuf_printf(wr, " %s 1+" ODR_INT_PRINTF " ",
2832 req->resultSetName, returnedrecs);
2833 yaz_query_to_wrbuf(wr, req->query);
2835 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2842 * Maybe we got a little over-friendly when we designed bend_fetch to
2843 * get only one record at a time. Some backends can optimise multiple-record
2844 * fetches, and at any rate, there is some overhead involved in
2845 * all that selecting and hopping around. Problem is, of course, that the
2846 * frontend can't know ahead of time how many records it'll need to
2847 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2848 * is downright lousy as a bulk data transfer protocol.
2850 * To start with, we'll do the fetching of records from the backend
2851 * in one operation: To save some trips in and out of the event-handler,
2852 * and to simplify the interface to pack_records. At any rate, asynch
2853 * operation is more fun in operations that have an unpredictable execution
2854 * speed - which is normally more true for search than for present.
2856 static Z_APDU *process_presentRequest(association *assoc, request *reqb)
2858 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2860 Z_PresentResponse *resp;
2865 yaz_log(log_requestdetail, "Got PresentRequest.");
2867 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2869 resp->presentStatus = odr_intdup(assoc->encode, 0);
2870 if (assoc->init->bend_present)
2872 bend_present_rr *bprr = (bend_present_rr *)
2873 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2874 bprr->setname = req->resultSetId;
2875 bprr->start = odr_int_to_int(*req->resultSetStartPoint);
2876 bprr->number = odr_int_to_int(*req->numberOfRecordsRequested);
2877 bprr->format = req->preferredRecordSyntax;
2878 bprr->comp = req->recordComposition;
2879 bprr->referenceId = req->referenceId;
2880 bprr->stream = assoc->encode;
2881 bprr->print = assoc->print;
2882 bprr->association = assoc;
2884 bprr->errstring = NULL;
2885 (*assoc->init->bend_present)(assoc->backend, bprr);
2889 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2890 *resp->presentStatus = Z_PresentStatus_failure;
2891 errcode = bprr->errcode;
2894 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2895 next = odr_intdup(assoc->encode, 0);
2896 num = odr_intdup(assoc->encode, 0);
2898 apdu->which = Z_APDU_presentResponse;
2899 apdu->u.presentResponse = resp;
2900 resp->referenceId = req->referenceId;
2901 resp->otherInfo = 0;
2905 *num = *req->numberOfRecordsRequested;
2907 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2908 num, req->recordComposition, next,
2909 resp->presentStatus,
2910 req->referenceId, req->preferredRecordSyntax,
2915 WRBUF wr = wrbuf_alloc();
2916 wrbuf_printf(wr, "Present ");
2918 if (*resp->presentStatus == Z_PresentStatus_failure)
2919 wrbuf_printf(wr, "ERROR %d ", errcode);
2920 else if (*resp->presentStatus == Z_PresentStatus_success)
2921 wrbuf_printf(wr, "OK - ");
2923 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2924 *resp->presentStatus);
2926 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2927 req->resultSetId, *req->resultSetStartPoint,
2928 *req->numberOfRecordsRequested);
2929 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2934 resp->numberOfRecordsReturned = num;
2935 resp->nextResultSetPosition = next;
2941 * Scan was implemented rather in a hurry, and with support for only the basic
2942 * elements of the service in the backend API. Suggestions are welcome.
2944 static Z_APDU *process_scanRequest(association *assoc, request *reqb)
2946 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2947 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2948 Z_ScanResponse *res = (Z_ScanResponse *)
2949 odr_malloc(assoc->encode, sizeof(*res));
2950 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2951 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2952 Z_ListEntries *ents = (Z_ListEntries *)
2953 odr_malloc(assoc->encode, sizeof(*ents));
2954 Z_DiagRecs *diagrecs_p = NULL;
2955 bend_scan_rr *bsrr = (bend_scan_rr *)
2956 odr_malloc(assoc->encode, sizeof(*bsrr));
2957 struct scan_entry *save_entries;
2960 yaz_log(log_requestdetail, "Got ScanRequest");
2962 apdu->which = Z_APDU_scanResponse;
2963 apdu->u.scanResponse = res;
2964 res->referenceId = req->referenceId;
2966 /* if step is absent, set it to 0 */
2968 step_size = odr_int_to_int(*req->stepSize);
2971 res->scanStatus = scanStatus;
2972 res->numberOfEntriesReturned = numberOfEntriesReturned;
2973 res->positionOfTerm = 0;
2974 res->entries = ents;
2975 ents->num_entries = 0;
2976 ents->entries = NULL;
2977 ents->num_nonsurrogateDiagnostics = 0;
2978 ents->nonsurrogateDiagnostics = NULL;
2979 res->attributeSet = 0;
2982 if (req->databaseNames)
2985 for (i = 0; i < req->num_databaseNames; i++)
2986 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2988 bsrr->scanClause = 0;
2990 bsrr->errstring = 0;
2991 bsrr->num_bases = req->num_databaseNames;
2992 bsrr->basenames = req->databaseNames;
2993 bsrr->num_entries = odr_int_to_int(*req->numberOfTermsRequested);
2994 bsrr->term = req->termListAndStartPoint;
2995 bsrr->referenceId = req->referenceId;
2996 bsrr->stream = assoc->encode;
2997 bsrr->print = assoc->print;
2998 bsrr->step_size = &step_size;
2999 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
3000 yaz_oid_userinfo_scan_set, 1, 0);
3002 /* For YAZ 2.0 and earlier it was the backend handler that
3003 initialized entries (member display_term did not exist)
3004 YAZ 2.0 and later sets 'entries' and initialize all members
3005 including 'display_term'. If YAZ 2.0 or later sees that
3006 entries was modified - we assume that it is an old handler and
3007 that 'display_term' is _not_ set.
3009 if (bsrr->num_entries > 0)
3012 bsrr->entries = (struct scan_entry *)
3013 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3015 for (i = 0; i<bsrr->num_entries; i++)
3017 bsrr->entries[i].term = 0;
3018 bsrr->entries[i].occurrences = 0;
3019 bsrr->entries[i].errcode = 0;
3020 bsrr->entries[i].errstring = 0;
3021 bsrr->entries[i].display_term = 0;
3024 save_entries = bsrr->entries; /* save it so we can compare later */
3026 bsrr->attributeset = req->attributeSet;
3027 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3028 bsrr->attributeset);
3029 bsrr->term_position = req->preferredPositionInResponse ?
3030 odr_int_to_int(*req->preferredPositionInResponse) : 1;
3032 ((int (*)(void *, bend_scan_rr *))
3033 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3036 diagrecs_p = zget_DiagRecs(assoc->encode,
3037 bsrr->errcode, bsrr->errstring);
3041 Z_Entry **tab = (Z_Entry **)
3042 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3044 if (bsrr->status == BEND_SCAN_PARTIAL)
3045 *scanStatus = Z_Scan_partial_5;
3047 *scanStatus = Z_Scan_success;
3048 res->stepSize = odr_intdup(assoc->encode, step_size);
3049 ents->entries = tab;
3050 ents->num_entries = bsrr->num_entries;
3051 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3053 res->positionOfTerm = odr_intdup(assoc->encode, bsrr->term_position);
3054 for (i = 0; i < bsrr->num_entries; i++)
3060 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3061 if (bsrr->entries[i].occurrences >= 0)
3063 e->which = Z_Entry_termInfo;
3064 e->u.termInfo = t = (Z_TermInfo *)
3065 odr_malloc(assoc->encode, sizeof(*t));
3066 t->suggestedAttributes = 0;
3068 if (save_entries == bsrr->entries &&
3069 bsrr->entries[i].display_term)
3071 /* the entries was _not_ set by the handler. So it's
3072 safe to test for new member display_term. It is
3075 t->displayTerm = odr_strdup(assoc->encode,
3076 bsrr->entries[i].display_term);
3078 t->alternativeTerm = 0;
3079 t->byAttributes = 0;
3080 t->otherTermInfo = 0;
3081 t->globalOccurrences = &bsrr->entries[i].occurrences;
3082 t->term = (Z_Term *)
3083 odr_malloc(assoc->encode, sizeof(*t->term));
3084 t->term->which = Z_Term_general;
3085 t->term->u.general = o =
3086 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3087 o->buf = (unsigned char *)
3088 odr_malloc(assoc->encode, o->len = o->size =
3089 strlen(bsrr->entries[i].term));
3090 memcpy(o->buf, bsrr->entries[i].term, o->len);
3091 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3092 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3096 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3097 bsrr->entries[i].errcode,
3098 bsrr->entries[i].errstring);
3099 assert(drecs->num_diagRecs == 1);
3100 e->which = Z_Entry_surrogateDiagnostic;
3101 assert(drecs->diagRecs[0]);
3102 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3108 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3109 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3114 WRBUF wr = wrbuf_alloc();
3115 wrbuf_printf(wr, "Scan ");
3116 for (i = 0 ; i < req->num_databaseNames; i++)
3119 wrbuf_printf(wr, "+");
3120 wrbuf_puts(wr, req->databaseNames[i]);
3123 wrbuf_printf(wr, " ");
3126 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3128 wrbuf_printf(wr, "OK");
3130 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3131 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3132 res->numberOfEntriesReturned ?
3133 *res->numberOfEntriesReturned : 0,
3134 (req->preferredPositionInResponse ?
3135 *req->preferredPositionInResponse : 1),
3136 *req->numberOfTermsRequested,
3137 (res->stepSize ? *res->stepSize : 1));
3140 wrbuf_printf(wr, "+%s", bsrr->setname);
3142 wrbuf_printf(wr, " ");
3143 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3144 bsrr->attributeset);
3145 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3151 static Z_APDU *process_sortRequest(association *assoc, request *reqb)
3154 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3155 Z_SortResponse *res = (Z_SortResponse *)
3156 odr_malloc(assoc->encode, sizeof(*res));
3157 bend_sort_rr *bsrr = (bend_sort_rr *)
3158 odr_malloc(assoc->encode, sizeof(*bsrr));
3160 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3162 yaz_log(log_requestdetail, "Got SortRequest.");
3164 bsrr->num_input_setnames = req->num_inputResultSetNames;
3165 for (i=0;i<req->num_inputResultSetNames;i++)
3166 yaz_log(log_requestdetail, "Input resultset: '%s'",
3167 req->inputResultSetNames[i]);
3168 bsrr->input_setnames = req->inputResultSetNames;
3169 bsrr->referenceId = req->referenceId;
3170 bsrr->output_setname = req->sortedResultSetName;
3171 yaz_log(log_requestdetail, "Output resultset: '%s'",
3172 req->sortedResultSetName);
3173 bsrr->sort_sequence = req->sortSequence;
3174 /*FIXME - dump those sequences too */
3175 bsrr->stream = assoc->encode;
3176 bsrr->print = assoc->print;
3178 bsrr->sort_status = Z_SortResponse_failure;
3180 bsrr->errstring = 0;
3182 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3184 res->referenceId = bsrr->referenceId;
3185 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3186 res->resultSetStatus = 0;
3189 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3190 bsrr->errcode, bsrr->errstring);
3191 res->diagnostics = dr->diagRecs;
3192 res->num_diagnostics = dr->num_diagRecs;
3196 res->num_diagnostics = 0;
3197 res->diagnostics = 0;
3199 res->resultCount = 0;
3202 apdu->which = Z_APDU_sortResponse;
3203 apdu->u.sortResponse = res;
3206 WRBUF wr = wrbuf_alloc();
3207 wrbuf_printf(wr, "Sort ");
3209 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3211 wrbuf_printf(wr, "OK -");
3212 wrbuf_printf(wr, " (");
3213 for (i = 0; i<req->num_inputResultSetNames; i++)
3216 wrbuf_printf(wr, "+");
3217 wrbuf_puts(wr, req->inputResultSetNames[i]);
3219 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3221 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3227 static Z_APDU *process_deleteRequest(association *assoc, request *reqb)
3230 Z_DeleteResultSetRequest *req =
3231 reqb->apdu_request->u.deleteResultSetRequest;
3232 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3233 odr_malloc(assoc->encode, sizeof(*res));
3234 bend_delete_rr *bdrr = (bend_delete_rr *)
3235 odr_malloc(assoc->encode, sizeof(*bdrr));
3236 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3238 yaz_log(log_requestdetail, "Got DeleteRequest.");
3240 bdrr->num_setnames = req->num_resultSetList;
3241 bdrr->setnames = req->resultSetList;
3242 for (i = 0; i<req->num_resultSetList; i++)
3243 yaz_log(log_requestdetail, "resultset: '%s'",
3244 req->resultSetList[i]);
3245 bdrr->stream = assoc->encode;
3246 bdrr->print = assoc->print;
3247 bdrr->function = odr_int_to_int(*req->deleteFunction);
3248 bdrr->referenceId = req->referenceId;
3250 if (bdrr->num_setnames > 0)
3252 bdrr->statuses = (int*)
3253 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3254 bdrr->num_setnames);
3255 for (i = 0; i < bdrr->num_setnames; i++)
3256 bdrr->statuses[i] = 0;
3258 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3260 res->referenceId = req->referenceId;
3262 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3264 res->deleteListStatuses = 0;
3265 if (bdrr->num_setnames > 0)
3268 res->deleteListStatuses = (Z_ListStatuses *)
3269 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3270 res->deleteListStatuses->num = bdrr->num_setnames;
3271 res->deleteListStatuses->elements =
3273 odr_malloc(assoc->encode,
3274 sizeof(*res->deleteListStatuses->elements) *
3275 bdrr->num_setnames);
3276 for (i = 0; i<bdrr->num_setnames; i++)
3278 res->deleteListStatuses->elements[i] =
3280 odr_malloc(assoc->encode,
3281 sizeof(**res->deleteListStatuses->elements));
3282 res->deleteListStatuses->elements[i]->status =
3283 odr_intdup(assoc->encode, bdrr->statuses[i]);
3284 res->deleteListStatuses->elements[i]->id =
3285 odr_strdup(assoc->encode, bdrr->setnames[i]);
3288 res->numberNotDeleted = 0;
3289 res->bulkStatuses = 0;
3290 res->deleteMessage = 0;
3293 apdu->which = Z_APDU_deleteResultSetResponse;
3294 apdu->u.deleteResultSetResponse = res;
3297 WRBUF wr = wrbuf_alloc();
3298 wrbuf_printf(wr, "Delete ");
3299 if (bdrr->delete_status)
3300 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3302 wrbuf_printf(wr, "OK -");
3303 for (i = 0; i<req->num_resultSetList; i++)
3304 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3305 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3311 static void process_close(association *assoc, request *reqb)
3313 Z_Close *req = reqb->apdu_request->u.close;
3314 static char *reasons[] =
3321 "securityViolation",
3328 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3329 reasons[*req->closeReason], req->diagnosticInformation ?
3330 req->diagnosticInformation : "NULL");
3331 if (assoc->version < 3) /* to make do_force respond with close */
3333 do_close_req(assoc, Z_Close_finished,
3334 "Association terminated by client", reqb);
3335 yaz_log(log_request,"Close OK");
3338 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3340 bend_segment_rr req;
3342 req.segment = reqb->apdu_request->u.segmentRequest;
3343 req.stream = assoc->encode;
3344 req.decode = assoc->decode;
3345 req.print = assoc->print;
3346 req.association = assoc;
3348 (*assoc->init->bend_segment)(assoc->backend, &req);
3353 static Z_APDU *process_ESRequest(association *assoc, request *reqb)
3355 bend_esrequest_rr esrequest;
3356 const char *ext_name = "unknown";
3358 Z_ExtendedServicesRequest *req =
3359 reqb->apdu_request->u.extendedServicesRequest;
3360 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3362 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3364 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3365 esrequest.stream = assoc->encode;
3366 esrequest.decode = assoc->decode;
3367 esrequest.print = assoc->print;
3368 esrequest.errcode = 0;
3369 esrequest.errstring = NULL;
3370 esrequest.association = assoc;
3371 esrequest.taskPackage = 0;
3372 esrequest.referenceId = req->referenceId;
3374 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3376 switch(esrequest.esr->taskSpecificParameters->which)
3378 case Z_External_itemOrder:
3379 ext_name = "ItemOrder"; break;
3380 case Z_External_update:
3381 ext_name = "Update"; break;
3382 case Z_External_update0:
3383 ext_name = "Update0"; break;
3384 case Z_External_ESAdmin:
3385 ext_name = "Admin"; break;
3390 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3392 resp->referenceId = req->referenceId;
3394 if (esrequest.errcode == -1)
3396 /* Backend service indicates request will be processed */
3397 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3398 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3400 else if (esrequest.errcode == 0)
3402 /* Backend service indicates request will be processed */
3403 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3404 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3408 Z_DiagRecs *diagRecs =
3409 zget_DiagRecs(assoc->encode, esrequest.errcode,
3410 esrequest.errstring);
3411 /* Backend indicates error, request will not be processed */
3412 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3413 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3414 resp->num_diagnostics = diagRecs->num_diagRecs;
3415 resp->diagnostics = diagRecs->diagRecs;
3418 WRBUF wr = wrbuf_alloc();
3419 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3420 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3425 /* Do something with the members of bend_extendedservice */
3426 if (esrequest.taskPackage)
3428 resp->taskPackage = z_ext_record_oid(
3429 assoc->encode, yaz_oid_recsyn_extended,
3430 (const char *) esrequest.taskPackage, -1);
3432 yaz_log(YLOG_DEBUG,"Send the result apdu");
3436 int bend_assoc_is_alive(bend_association assoc)
3438 if (assoc->state == ASSOC_DEAD)
3439 return 0; /* already marked as dead. Don't check I/O chan anymore */
3441 return iochan_is_alive(assoc->client_chan);
3448 * c-file-style: "Stroustrup"
3449 * indent-tabs-mode: nil
3451 * vim: shiftwidth=4 tabstop=8 expandtab