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");
301 assoc->state = ASSOC_DEAD;
304 else if (res == 1) /* incomplete read - wait for more */
306 if (conn->io_pending & CS_WANT_WRITE)
307 assoc->cs_get_mask |= EVENT_OUTPUT;
308 iochan_setflag(h, assoc->cs_get_mask);
311 /* we got a complete PDU. Let's decode it */
312 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
313 assoc->input_buffer[0] & 0xff,
314 assoc->input_buffer[1] & 0xff,
315 assoc->input_buffer[2] & 0xff);
316 req = request_get(&assoc->incoming); /* get a new request */
317 odr_reset(assoc->decode);
318 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
319 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
321 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
323 odr_errmsg(odr_geterror(assoc->decode)),
324 odr_getelement(assoc->decode),
325 (long) odr_offset(assoc->decode));
326 if (assoc->decode->error != OHTTP)
328 yaz_log(YLOG_WARN, "PDU dump:");
329 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
330 request_release(req);
331 do_close(assoc, Z_Close_protocolError, "Malformed package");
335 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
336 assoc->state = ASSOC_DEAD;
337 process_gdu_response(assoc, req, p);
341 req->request_mem = odr_extract_mem(assoc->decode);
344 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
345 yaz_log(YLOG_WARN, "ODR print error: %s",
346 odr_errmsg(odr_geterror(assoc->print)));
347 odr_reset(assoc->print);
349 request_enq(&assoc->incoming, req);
351 while (cs_more(conn));
357 * This is where PDUs from the client are read and the further
358 * processing is initiated. Flow of control moves down through the
359 * various process_* functions below, until the encoded result comes back up
360 * to the output handler in here.
362 * h : the I/O channel that has an outstanding event.
363 * event : the current outstanding event.
365 void ir_session(IOCHAN h, int event)
368 association *assoc = (association *)iochan_getdata(h);
369 COMSTACK conn = assoc->client_link;
372 assert(h && conn && assoc);
373 if (event == EVENT_TIMEOUT)
375 if (assoc->state != ASSOC_UP)
377 yaz_log(log_session, "Timeout. Closing connection");
378 /* do we need to lod this at all */
380 destroy_association(assoc);
385 yaz_log(log_sessiondetail, "Timeout. Sending Z39.50 Close");
386 do_close(assoc, Z_Close_lackOfActivity, 0);
390 if (event & assoc->cs_accept_mask)
392 if (!cs_accept(conn))
394 yaz_log(YLOG_WARN, "accept failed");
395 destroy_association(assoc);
399 iochan_clearflag(h, EVENT_OUTPUT);
400 if (conn->io_pending)
401 { /* cs_accept didn't complete */
402 assoc->cs_accept_mask =
403 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
404 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
406 iochan_setflag(h, assoc->cs_accept_mask);
409 { /* cs_accept completed. Prepare for reading (cs_get) */
410 assoc->cs_accept_mask = 0;
411 assoc->cs_get_mask = EVENT_INPUT;
412 iochan_setflag(h, assoc->cs_get_mask);
416 if (event & assoc->cs_get_mask) /* input */
418 if (!ir_read(h, event))
420 req = request_head(&assoc->incoming);
421 if (req->state == REQUEST_IDLE)
423 request_deq(&assoc->incoming);
424 process_gdu_request(assoc, req);
427 if (event & assoc->cs_put_mask)
429 request *req = request_head(&assoc->outgoing);
431 assoc->cs_put_mask = 0;
432 yaz_log(YLOG_DEBUG, "ir_session (output)");
433 req->state = REQUEST_PENDING;
434 switch (res = cs_put(conn, req->response, req->len_response))
437 yaz_log(log_sessiondetail, "Connection closed by client");
439 destroy_association(assoc);
442 case 0: /* all sent - release the request structure */
443 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
445 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
448 nmem_destroy(req->request_mem);
449 request_deq(&assoc->outgoing);
450 request_release(req);
451 if (!request_head(&assoc->outgoing))
452 { /* restore mask for cs_get operation ... */
453 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
454 iochan_setflag(h, assoc->cs_get_mask);
455 if (assoc->state == ASSOC_DEAD)
456 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
460 assoc->cs_put_mask = EVENT_OUTPUT;
464 if (conn->io_pending & CS_WANT_WRITE)
465 assoc->cs_put_mask |= EVENT_OUTPUT;
466 if (conn->io_pending & CS_WANT_READ)
467 assoc->cs_put_mask |= EVENT_INPUT;
468 iochan_setflag(h, assoc->cs_put_mask);
471 if (event & EVENT_EXCEPT)
473 yaz_log(YLOG_WARN, "ir_session (exception)");
475 destroy_association(assoc);
480 static int process_z_request(association *assoc, request *req, char **msg);
483 static void assoc_init_reset(association *assoc)
486 assoc->init = (bend_initrequest *) xmalloc(sizeof(*assoc->init));
488 assoc->init->stream = assoc->encode;
489 assoc->init->print = assoc->print;
490 assoc->init->auth = 0;
491 assoc->init->referenceId = 0;
492 assoc->init->implementation_version = 0;
493 assoc->init->implementation_id = 0;
494 assoc->init->implementation_name = 0;
495 assoc->init->query_charset = 0;
496 assoc->init->records_in_same_charset = 0;
497 assoc->init->bend_sort = NULL;
498 assoc->init->bend_search = NULL;
499 assoc->init->bend_present = NULL;
500 assoc->init->bend_esrequest = NULL;
501 assoc->init->bend_delete = NULL;
502 assoc->init->bend_scan = NULL;
503 assoc->init->bend_segment = NULL;
504 assoc->init->bend_fetch = NULL;
505 assoc->init->bend_explain = NULL;
506 assoc->init->bend_srw_scan = NULL;
507 assoc->init->bend_srw_update = NULL;
508 assoc->init->named_result_sets = 0;
510 assoc->init->charneg_request = NULL;
511 assoc->init->charneg_response = NULL;
513 assoc->init->decode = assoc->decode;
514 assoc->init->peer_name =
515 odr_strdup(assoc->encode, cs_addrstr(assoc->client_link));
517 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
520 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
522 statserv_options_block *cb = statserv_getcontrol();
525 const char *encoding = "UTF-8";
527 bend_initresult *binitres;
529 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
530 assoc_init_reset(assoc);
534 Z_IdAuthentication *auth = (Z_IdAuthentication *)
535 odr_malloc(assoc->decode, sizeof(*auth));
538 len = strlen(sr->username) + 1;
540 len += strlen(sr->password) + 2;
541 yaz_log(log_requestdetail, "username=%s password-len=%ld",
543 (sr->password ? strlen(sr->password) : 0));
544 auth->which = Z_IdAuthentication_open;
545 auth->u.open = (char *) odr_malloc(assoc->decode, len);
546 strcpy(auth->u.open, sr->username);
547 if (sr->password && *sr->password)
549 strcat(auth->u.open, "/");
550 strcat(auth->u.open, sr->password);
552 assoc->init->auth = auth;
556 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
557 assoc->init->charneg_request = ce->u.charNeg3;
560 if (!(binitres = (*cb->bend_init)(assoc->init)))
562 assoc->state = ASSOC_DEAD;
563 yaz_add_srw_diagnostic(assoc->encode, d, num,
564 YAZ_SRW_AUTHENTICATION_ERROR, 0);
567 assoc->backend = binitres->handle;
568 assoc->init->auth = 0;
569 if (binitres->errcode)
571 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
572 assoc->state = ASSOC_DEAD;
573 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
574 binitres->errstring);
582 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
585 yaz_record_conv_t rc = 0;
586 const char *match_schema = 0;
587 Odr_oid *match_syntax = 0;
592 const char *input_schema = yaz_get_esn(rr->comp);
593 Odr_oid *input_syntax_raw = rr->request_format;
595 const char *backend_schema = 0;
596 Odr_oid *backend_syntax = 0;
598 r = yaz_retrieval_request(assoc->server->retrieval,
606 if (r == -1) /* error ? */
608 const char *details = yaz_retrieval_get_error(
609 assoc->server->retrieval);
611 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
613 rr->errstring = odr_strdup(rr->stream, details);
616 else if (r == 1 || r == 3)
618 const char *details = input_schema;
620 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
622 rr->errstring = odr_strdup(rr->stream, details);
627 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
628 if (input_syntax_raw)
630 char oidbuf[OID_STR_MAX];
631 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
632 rr->errstring = odr_strdup(rr->stream, oidbuf);
638 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
641 rr->request_format = backend_syntax;
643 (*assoc->init->bend_fetch)(assoc->backend, rr);
644 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
645 { /* post conversion must take place .. */
646 WRBUF output_record = wrbuf_alloc();
647 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
650 const char *details = yaz_record_conv_get_error(rc);
651 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
653 rr->errstring = odr_strdup(rr->stream, details);
657 rr->len = wrbuf_len(output_record);
658 rr->record = (char *) odr_malloc(rr->stream, rr->len);
659 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
661 wrbuf_destroy(output_record);
664 rr->output_format = match_syntax;
666 rr->schema = odr_strdup(rr->stream, match_schema);
668 (*assoc->init->bend_fetch)(assoc->backend, rr);
673 static int srw_bend_fetch(association *assoc, int pos,
674 Z_SRW_searchRetrieveRequest *srw_req,
675 Z_SRW_record *record,
676 const char **addinfo)
679 ODR o = assoc->encode;
681 rr.setname = "default";
684 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
686 rr.comp = (Z_RecordComposition *)
687 odr_malloc(assoc->decode, sizeof(*rr.comp));
688 rr.comp->which = Z_RecordComp_complex;
689 rr.comp->u.complex = (Z_CompSpec *)
690 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
691 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
692 odr_malloc(assoc->encode, sizeof(bool_t));
693 *rr.comp->u.complex->selectAlternativeSyntax = 0;
694 rr.comp->u.complex->num_dbSpecific = 0;
695 rr.comp->u.complex->dbSpecific = 0;
696 rr.comp->u.complex->num_recordSyntax = 0;
697 rr.comp->u.complex->recordSyntax = 0;
699 rr.comp->u.complex->generic = (Z_Specification *)
700 odr_malloc(assoc->decode, sizeof(Z_Specification));
702 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
703 rr.comp->u.complex->generic->which = Z_Schema_uri;
704 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
706 /* ESN = recordSchema if recordSchema is present */
707 rr.comp->u.complex->generic->elementSpec = 0;
708 if (srw_req->recordSchema)
710 rr.comp->u.complex->generic->elementSpec =
711 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
712 rr.comp->u.complex->generic->elementSpec->which =
713 Z_ElementSpec_elementSetName;
714 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
715 srw_req->recordSchema;
718 rr.stream = assoc->encode;
719 rr.print = assoc->print;
727 rr.surrogate_flag = 0;
728 rr.schema = srw_req->recordSchema;
730 if (!assoc->init->bend_fetch)
733 retrieve_fetch(assoc, &rr);
735 if (rr.errcode && rr.surrogate_flag)
737 int code = yaz_diag_bib1_to_srw(rr.errcode);
738 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
741 else if (rr.len >= 0)
743 record->recordData_buf = rr.record;
744 record->recordData_len = rr.len;
745 record->recordPosition = odr_intdup(o, pos);
746 record->recordSchema = odr_strdup_null(
747 o, rr.schema ? rr.schema : srw_req->recordSchema);
751 *addinfo = rr.errstring;
757 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
758 Z_Query *query_result)
760 /* have a CQL query and CQL to PQF transform .. */
761 CQL_parser cp = cql_parser_create();
767 r = cql_parser_string(cp, cql);
770 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
775 r = cql_transform_buf(ct,
776 cql_parser_result(cp),
777 rpn_buf, sizeof(rpn_buf)-1);
779 srw_errcode = cql_transform_error(ct, &add);
783 /* Syntax & transform OK. */
784 /* Convert PQF string to Z39.50 to RPN query struct */
785 YAZ_PQF_Parser pp = yaz_pqf_create();
786 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
791 int code = yaz_pqf_error(pp, &pqf_msg, &off);
792 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
794 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
798 query_result->which = Z_Query_type_1;
799 query_result->u.type_1 = rpnquery;
803 cql_parser_destroy(cp);
807 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
808 Z_AttributesPlusTerm *result)
812 int srw_error = cql2pqf(odr, cql, ct, &query);
815 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
816 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
817 rpn = query.u.type_1;
818 if (!rpn->RPNStructure)
819 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
820 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
821 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
822 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
823 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
824 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
830 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
831 bend_search_rr *bsrr)
834 struct ccl_rpn_node *node;
837 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
838 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0)
840 bsrr->errstring = (char*) ccl_err_msg(errcode);
841 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
844 bsrr->query->which = Z_Query_type_1;
845 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
849 static void srw_bend_search(association *assoc,
854 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
857 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
860 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
861 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
862 if (srw_res->num_diagnostics == 0 && assoc->init)
865 rr.setname = "default";
868 rr.basenames = &srw_req->database;
872 rr.srw_setnameIdleTime = 0;
873 rr.estimated_hit_count = 0;
874 rr.partial_resultset = 0;
875 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
876 rr.query->u.type_1 = 0;
877 rr.extra_args = sr->extra_args;
878 rr.extra_response_data = 0;
880 if (srw_req->query_type == Z_SRW_query_type_cql)
882 if (assoc->server && assoc->server->cql_transform)
884 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
885 assoc->server->cql_transform,
889 yaz_add_srw_diagnostic(assoc->encode,
890 &srw_res->diagnostics,
891 &srw_res->num_diagnostics,
897 /* CQL query to backend. Wrap it - Z39.50 style */
898 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
899 ext->direct_reference = odr_getoidbystr(assoc->decode,
900 "1.2.840.10003.16.2");
901 ext->indirect_reference = 0;
903 ext->which = Z_External_CQL;
904 ext->u.cql = srw_req->query.cql;
906 rr.query->which = Z_Query_type_104;
907 rr.query->u.type_104 = ext;
910 else if (srw_req->query_type == Z_SRW_query_type_pqf)
912 Z_RPNQuery *RPNquery;
913 YAZ_PQF_Parser pqf_parser;
915 pqf_parser = yaz_pqf_create();
917 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
923 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
924 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
925 code, pqf_msg, (long) off);
926 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
929 rr.query->which = Z_Query_type_1;
930 rr.query->u.type_1 = RPNquery;
932 yaz_pqf_destroy(pqf_parser);
936 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
937 &srw_res->num_diagnostics,
938 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
940 if (rr.query->u.type_1)
942 rr.stream = assoc->encode;
943 rr.decode = assoc->decode;
944 rr.print = assoc->print;
945 if ( srw_req->sort.sortKeys )
946 rr.srw_sortKeys = odr_strdup(assoc->encode,
947 srw_req->sort.sortKeys );
948 rr.association = assoc;
954 yaz_log_zquery_level(log_requestdetail,rr.query);
956 (assoc->init->bend_search)(assoc->backend, &rr);
959 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
965 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
966 yaz_add_srw_diagnostic(assoc->encode,
967 &srw_res->diagnostics,
968 &srw_res->num_diagnostics,
969 srw_error, rr.errstring);
974 int number = srw_req->maximumRecords ?
975 odr_int_to_int(*srw_req->maximumRecords) : 0;
976 int start = srw_req->startRecord ?
977 odr_int_to_int(*srw_req->startRecord) : 1;
979 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
981 start, number, rr.hits);
983 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
986 srw_res->resultSetId =
987 odr_strdup(assoc->encode, rr.srw_setname );
988 srw_res->resultSetIdleTime =
989 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
992 if (start > rr.hits || start < 1)
994 /* if hits<=0 and start=1 we don't return a diagnostic */
996 yaz_add_srw_diagnostic(
998 &srw_res->diagnostics, &srw_res->num_diagnostics,
999 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1001 else if (number > 0)
1005 if (start + number > rr.hits)
1006 number = odr_int_to_int(rr.hits) - start + 1;
1008 /* Call bend_present if defined */
1009 if (assoc->init->bend_present)
1011 bend_present_rr *bprr = (bend_present_rr*)
1012 odr_malloc(assoc->decode, sizeof(*bprr));
1013 bprr->setname = "default";
1014 bprr->start = start;
1015 bprr->number = number;
1016 if (srw_req->recordSchema)
1018 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1019 sizeof(*bprr->comp));
1020 bprr->comp->which = Z_RecordComp_simple;
1021 bprr->comp->u.simple = (Z_ElementSetNames *)
1022 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1023 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1024 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1030 bprr->stream = assoc->encode;
1031 bprr->referenceId = 0;
1032 bprr->print = assoc->print;
1033 bprr->association = assoc;
1035 bprr->errstring = NULL;
1036 (*assoc->init->bend_present)(assoc->backend, bprr);
1040 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1041 yaz_add_srw_diagnostic(assoc->encode,
1042 &srw_res->diagnostics,
1043 &srw_res->num_diagnostics,
1044 srw_error, bprr->errstring);
1052 int packing = Z_SRW_recordPacking_string;
1053 if (srw_req->recordPacking)
1056 yaz_srw_str_to_pack(srw_req->recordPacking);
1058 packing = Z_SRW_recordPacking_string;
1060 srw_res->records = (Z_SRW_record *)
1061 odr_malloc(assoc->encode,
1062 number * sizeof(*srw_res->records));
1064 srw_res->extra_records = (Z_SRW_extra_record **)
1065 odr_malloc(assoc->encode,
1066 number*sizeof(*srw_res->extra_records));
1068 for (i = 0; i<number; i++)
1071 const char *addinfo = 0;
1073 srw_res->records[j].recordPacking = packing;
1074 srw_res->records[j].recordData_buf = 0;
1075 srw_res->extra_records[j] = 0;
1076 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1077 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1078 srw_res->records + j,
1082 yaz_add_srw_diagnostic(assoc->encode,
1083 &srw_res->diagnostics,
1084 &srw_res->num_diagnostics,
1085 yaz_diag_bib1_to_srw(errcode),
1090 if (srw_res->records[j].recordData_buf)
1093 srw_res->num_records = j;
1095 srw_res->records = 0;
1098 if (rr.extra_response_data)
1100 res->extraResponseData_buf = rr.extra_response_data;
1101 res->extraResponseData_len = strlen(rr.extra_response_data);
1103 if (rr.estimated_hit_count || rr.partial_resultset)
1105 yaz_add_srw_diagnostic(
1107 &srw_res->diagnostics,
1108 &srw_res->num_diagnostics,
1109 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1117 const char *querystr = "?";
1118 const char *querytype = "?";
1119 WRBUF wr = wrbuf_alloc();
1121 switch (srw_req->query_type)
1123 case Z_SRW_query_type_cql:
1125 querystr = srw_req->query.cql;
1127 case Z_SRW_query_type_pqf:
1129 querystr = srw_req->query.pqf;
1132 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1133 if (srw_res->num_diagnostics)
1134 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1135 else if (*http_code != 200)
1136 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1137 else if (srw_res->numberOfRecords)
1139 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1140 (srw_res->numberOfRecords ?
1141 *srw_res->numberOfRecords : 0));
1143 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+%d",
1144 (srw_res->resultSetId ?
1145 srw_res->resultSetId : "-"),
1146 (srw_req->startRecord ? *srw_req->startRecord : 1),
1147 srw_res->num_records);
1148 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1153 static char *srw_bend_explain_default(bend_explain_rr *rr)
1156 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1159 for (ptr = ptr->children; ptr; ptr = ptr->next)
1161 if (ptr->type != XML_ELEMENT_NODE)
1163 if (!strcmp((const char *) ptr->name, "explain"))
1166 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1170 ptr = xmlCopyNode(ptr, 1);
1172 xmlDocSetRootElement(doc, ptr);
1174 xmlDocDumpMemory(doc, &buf_out, &len);
1175 content = (char*) odr_malloc(rr->stream, 1+len);
1176 memcpy(content, buf_out, len);
1177 content[len] = '\0';
1181 rr->explain_buf = content;
1189 static void srw_bend_explain(association *assoc,
1191 Z_SRW_explainResponse *srw_res,
1194 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1195 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1197 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1202 rr.stream = assoc->encode;
1203 rr.decode = assoc->decode;
1204 rr.print = assoc->print;
1206 rr.database = srw_req->database;
1208 rr.server_node_ptr = assoc->server->server_node_ptr;
1210 rr.server_node_ptr = 0;
1211 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1212 if (assoc->init->bend_explain)
1213 (*assoc->init->bend_explain)(assoc->backend, &rr);
1215 srw_bend_explain_default(&rr);
1219 int packing = Z_SRW_recordPacking_string;
1220 if (srw_req->recordPacking)
1223 yaz_srw_str_to_pack(srw_req->recordPacking);
1225 packing = Z_SRW_recordPacking_string;
1227 srw_res->record.recordSchema = rr.schema;
1228 srw_res->record.recordPacking = packing;
1229 srw_res->record.recordData_buf = rr.explain_buf;
1230 srw_res->record.recordData_len = strlen(rr.explain_buf);
1231 srw_res->record.recordPosition = 0;
1237 static void srw_bend_scan(association *assoc,
1239 Z_SRW_scanResponse *srw_res,
1242 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1243 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1246 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1247 if (srw_res->num_diagnostics == 0 && assoc->init)
1250 struct scan_entry *save_entries;
1252 bend_scan_rr *bsrr = (bend_scan_rr *)
1253 odr_malloc(assoc->encode, sizeof(*bsrr));
1254 bsrr->num_bases = 1;
1255 bsrr->basenames = &srw_req->database;
1257 bsrr->num_entries = srw_req->maximumTerms ?
1258 odr_int_to_int(*srw_req->maximumTerms) : 10;
1259 bsrr->term_position = srw_req->responsePosition ?
1260 odr_int_to_int(*srw_req->responsePosition) : 1;
1263 bsrr->errstring = 0;
1264 bsrr->referenceId = 0;
1265 bsrr->stream = assoc->encode;
1266 bsrr->print = assoc->print;
1267 bsrr->step_size = &step_size;
1271 if (bsrr->num_entries > 0)
1274 bsrr->entries = (struct scan_entry *)
1275 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1277 for (i = 0; i<bsrr->num_entries; i++)
1279 bsrr->entries[i].term = 0;
1280 bsrr->entries[i].occurrences = 0;
1281 bsrr->entries[i].errcode = 0;
1282 bsrr->entries[i].errstring = 0;
1283 bsrr->entries[i].display_term = 0;
1286 save_entries = bsrr->entries; /* save it so we can compare later */
1288 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1289 assoc->init->bend_scan)
1291 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1293 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1294 &bsrr->attributeset,
1295 srw_req->scanClause.pqf);
1296 yaz_pqf_destroy(pqf_parser);
1297 bsrr->scanClause = 0;
1298 ((int (*)(void *, bend_scan_rr *))
1299 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1301 else if (srw_req->query_type == Z_SRW_query_type_cql
1302 && assoc->init->bend_scan && assoc->server
1303 && assoc->server->cql_transform)
1306 bsrr->scanClause = 0;
1307 bsrr->attributeset = 0;
1308 bsrr->term = (Z_AttributesPlusTerm *)
1309 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1310 srw_error = cql2pqf_scan(assoc->encode,
1311 srw_req->scanClause.cql,
1312 assoc->server->cql_transform,
1315 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1316 &srw_res->num_diagnostics,
1320 ((int (*)(void *, bend_scan_rr *))
1321 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1324 else if (srw_req->query_type == Z_SRW_query_type_cql
1325 && assoc->init->bend_srw_scan)
1328 bsrr->attributeset = 0;
1329 bsrr->scanClause = srw_req->scanClause.cql;
1330 ((int (*)(void *, bend_scan_rr *))
1331 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1335 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1336 &srw_res->num_diagnostics,
1337 YAZ_SRW_UNSUPP_OPERATION, "scan");
1342 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1347 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1349 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1350 &srw_res->num_diagnostics,
1351 srw_error, bsrr->errstring);
1353 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1356 srw_res->terms = (Z_SRW_scanTerm*)
1357 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1360 srw_res->num_terms = bsrr->num_entries;
1361 for (i = 0; i<bsrr->num_entries; i++)
1363 Z_SRW_scanTerm *t = srw_res->terms + i;
1364 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1365 t->numberOfRecords =
1366 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1368 if (save_entries == bsrr->entries &&
1369 bsrr->entries[i].display_term)
1371 /* the entries was _not_ set by the handler. So it's
1372 safe to test for new member display_term. It is
1375 t->displayTerm = odr_strdup(assoc->encode,
1376 bsrr->entries[i].display_term);
1384 WRBUF wr = wrbuf_alloc();
1385 const char *querytype = 0;
1386 const char *querystr = 0;
1388 switch(srw_req->query_type)
1390 case Z_SRW_query_type_pqf:
1392 querystr = srw_req->scanClause.pqf;
1394 case Z_SRW_query_type_cql:
1396 querystr = srw_req->scanClause.cql;
1399 querytype = "UNKNOWN";
1403 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1405 if (srw_res->num_diagnostics)
1406 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1407 else if (srw_res->num_terms)
1408 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1410 wrbuf_printf(wr, "OK - - ");
1412 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1413 (srw_req->responsePosition ?
1414 *srw_req->responsePosition : 1),
1415 (srw_req->maximumTerms ?
1416 *srw_req->maximumTerms : 1));
1417 /* there is no step size in SRU/W ??? */
1418 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1419 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1425 static void srw_bend_update(association *assoc,
1427 Z_SRW_updateResponse *srw_res,
1430 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1431 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1432 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1434 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1438 Z_SRW_extra_record *extra = srw_req->extra_record;
1440 rr.stream = assoc->encode;
1441 rr.print = assoc->print;
1443 rr.basenames = &srw_req->database;
1444 rr.operation = srw_req->operation;
1445 rr.operation_status = "failed";
1447 rr.record_versions = 0;
1448 rr.num_versions = 0;
1449 rr.record_packing = "string";
1450 rr.record_schema = 0;
1452 rr.extra_record_data = 0;
1453 rr.extra_request_data = 0;
1454 rr.extra_response_data = 0;
1460 if (rr.operation == 0)
1462 yaz_add_sru_update_diagnostic(
1463 assoc->encode, &srw_res->diagnostics,
1464 &srw_res->num_diagnostics,
1465 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1469 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1470 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1471 if (!strcmp( rr.operation, "delete"))
1473 if (srw_req->record && !srw_req->record->recordSchema)
1475 rr.record_schema = odr_strdup(
1477 srw_req->record->recordSchema);
1479 if (srw_req->record)
1481 rr.record_data = odr_strdupn(
1483 srw_req->record->recordData_buf,
1484 srw_req->record->recordData_len );
1486 if (extra && extra->extraRecordData_len)
1488 rr.extra_record_data = odr_strdupn(
1490 extra->extraRecordData_buf,
1491 extra->extraRecordData_len );
1493 if (srw_req->recordId)
1494 rr.record_id = srw_req->recordId;
1495 else if (extra && extra->recordIdentifier)
1496 rr.record_id = extra->recordIdentifier;
1498 else if (!strcmp(rr.operation, "replace"))
1500 if (srw_req->recordId)
1501 rr.record_id = srw_req->recordId;
1502 else if (extra && extra->recordIdentifier)
1503 rr.record_id = extra->recordIdentifier;
1506 yaz_add_sru_update_diagnostic(
1507 assoc->encode, &srw_res->diagnostics,
1508 &srw_res->num_diagnostics,
1509 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1510 "recordIdentifier");
1512 if (!srw_req->record)
1514 yaz_add_sru_update_diagnostic(
1515 assoc->encode, &srw_res->diagnostics,
1516 &srw_res->num_diagnostics,
1517 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1522 if (srw_req->record->recordSchema)
1523 rr.record_schema = odr_strdup(
1524 assoc->encode, srw_req->record->recordSchema);
1525 if (srw_req->record->recordData_len )
1527 rr.record_data = odr_strdupn(assoc->encode,
1528 srw_req->record->recordData_buf,
1529 srw_req->record->recordData_len );
1533 yaz_add_sru_update_diagnostic(
1534 assoc->encode, &srw_res->diagnostics,
1535 &srw_res->num_diagnostics,
1536 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1540 if (extra && extra->extraRecordData_len)
1542 rr.extra_record_data = odr_strdupn(
1544 extra->extraRecordData_buf,
1545 extra->extraRecordData_len );
1548 else if (!strcmp(rr.operation, "insert"))
1550 if (srw_req->recordId)
1551 rr.record_id = srw_req->recordId;
1553 rr.record_id = extra->recordIdentifier;
1555 if (srw_req->record)
1557 if (srw_req->record->recordSchema)
1558 rr.record_schema = odr_strdup(
1559 assoc->encode, srw_req->record->recordSchema);
1561 if (srw_req->record->recordData_len)
1562 rr.record_data = odr_strdupn(
1564 srw_req->record->recordData_buf,
1565 srw_req->record->recordData_len );
1567 if (extra && extra->extraRecordData_len)
1569 rr.extra_record_data = odr_strdupn(
1571 extra->extraRecordData_buf,
1572 extra->extraRecordData_len );
1576 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1577 &srw_res->num_diagnostics,
1578 YAZ_SRU_UPDATE_INVALID_ACTION,
1581 if (srw_req->record)
1583 const char *pack_str =
1584 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1586 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1589 if (srw_req->num_recordVersions)
1591 rr.record_versions = srw_req->recordVersions;
1592 rr.num_versions = srw_req->num_recordVersions;
1594 if (srw_req->extraRequestData_len)
1596 rr.extra_request_data = odr_strdupn(assoc->encode,
1597 srw_req->extraRequestData_buf,
1598 srw_req->extraRequestData_len );
1600 if (srw_res->num_diagnostics == 0)
1602 if ( assoc->init->bend_srw_update)
1603 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1605 yaz_add_sru_update_diagnostic(
1606 assoc->encode, &srw_res->diagnostics,
1607 &srw_res->num_diagnostics,
1608 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1609 "No Update backend handler");
1613 yaz_add_srw_diagnostic_uri(assoc->encode,
1614 &srw_res->diagnostics,
1615 &srw_res->num_diagnostics,
1619 srw_res->recordId = rr.record_id;
1620 srw_res->operationStatus = rr.operation_status;
1621 srw_res->recordVersions = rr.record_versions;
1622 srw_res->num_recordVersions = rr.num_versions;
1623 if (srw_res->extraResponseData_len)
1625 srw_res->extraResponseData_buf = rr.extra_response_data;
1626 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1628 if (srw_res->num_diagnostics == 0 && rr.record_data)
1630 srw_res->record = yaz_srw_get_record(assoc->encode);
1631 srw_res->record->recordSchema = rr.record_schema;
1632 if (rr.record_packing)
1634 int pack = yaz_srw_str_to_pack(rr.record_packing);
1638 pack = Z_SRW_recordPacking_string;
1639 yaz_log(YLOG_WARN, "Back packing %s from backend",
1642 srw_res->record->recordPacking = pack;
1644 srw_res->record->recordData_buf = rr.record_data;
1645 srw_res->record->recordData_len = strlen(rr.record_data);
1646 if (rr.extra_record_data)
1648 Z_SRW_extra_record *ex =
1649 yaz_srw_get_extra_record(assoc->encode);
1650 srw_res->extra_record = ex;
1651 ex->extraRecordData_buf = rr.extra_record_data;
1652 ex->extraRecordData_len = strlen(rr.extra_record_data);
1658 /* check if path is OK (1); BAD (0) */
1659 static int check_path(const char *path)
1663 if (strstr(path, ".."))
1668 static char *read_file(const char *fname, ODR o, size_t *sz)
1671 FILE *inf = fopen(fname, "rb");
1675 fseek(inf, 0L, SEEK_END);
1678 buf = (char *) odr_malloc(o, *sz);
1679 if (fread(buf, 1, *sz, inf) != *sz)
1680 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1685 static void process_http_request(association *assoc, request *req)
1687 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1688 ODR o = assoc->encode;
1689 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1691 Z_SOAP *soap_package = 0;
1694 Z_HTTP_Response *hres = 0;
1696 const char *stylesheet = 0; /* for now .. set later */
1697 Z_SRW_diagnostic *diagnostic = 0;
1698 int num_diagnostic = 0;
1699 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1701 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1702 if (!control_association(assoc, host, 0))
1704 p = z_get_HTTP_Response(o, 404);
1707 if (r == 2 && assoc->server && assoc->server->docpath
1708 && hreq->path[0] == '/'
1710 /* check if path is a proper prefix of documentroot */
1711 strncmp(hreq->path+1, assoc->server->docpath,
1712 strlen(assoc->server->docpath))
1715 if (!check_path(hreq->path))
1717 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1718 p = z_get_HTTP_Response(o, 404);
1722 size_t content_size = 0;
1723 char *content_buf = read_file(hreq->path+1, o, &content_size);
1726 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1727 p = z_get_HTTP_Response(o, 404);
1731 const char *ctype = 0;
1732 yaz_mime_types types = yaz_mime_types_create();
1734 yaz_mime_types_add(types, "xsl", "application/xml");
1735 yaz_mime_types_add(types, "xml", "application/xml");
1736 yaz_mime_types_add(types, "css", "text/css");
1737 yaz_mime_types_add(types, "html", "text/html");
1738 yaz_mime_types_add(types, "htm", "text/html");
1739 yaz_mime_types_add(types, "txt", "text/plain");
1740 yaz_mime_types_add(types, "js", "application/x-javascript");
1742 yaz_mime_types_add(types, "gif", "image/gif");
1743 yaz_mime_types_add(types, "png", "image/png");
1744 yaz_mime_types_add(types, "jpg", "image/jpeg");
1745 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1747 ctype = yaz_mime_lookup_fname(types, hreq->path);
1750 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1751 p = z_get_HTTP_Response(o, 404);
1755 p = z_get_HTTP_Response(o, 200);
1756 hres = p->u.HTTP_Response;
1757 hres->content_buf = content_buf;
1758 hres->content_len = content_size;
1759 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1761 yaz_mime_types_destroy(types);
1769 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1770 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1772 if (r == 2) /* not taken */
1774 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1775 &diagnostic, &num_diagnostic);
1776 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1778 if (r == 0) /* decode SRW/SRU OK .. */
1780 int http_code = 200;
1781 if (sr->which == Z_SRW_searchRetrieve_request)
1784 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1786 stylesheet = sr->u.request->stylesheet;
1789 res->u.response->diagnostics = diagnostic;
1790 res->u.response->num_diagnostics = num_diagnostic;
1794 srw_bend_search(assoc, sr, res, &http_code);
1796 if (http_code == 200)
1797 soap_package->u.generic->p = res;
1799 else if (sr->which == Z_SRW_explain_request)
1801 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1803 stylesheet = sr->u.explain_request->stylesheet;
1806 res->u.explain_response->diagnostics = diagnostic;
1807 res->u.explain_response->num_diagnostics = num_diagnostic;
1809 srw_bend_explain(assoc, sr, res->u.explain_response, &http_code);
1810 if (http_code == 200)
1811 soap_package->u.generic->p = res;
1813 else if (sr->which == Z_SRW_scan_request)
1815 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1817 stylesheet = sr->u.scan_request->stylesheet;
1820 res->u.scan_response->diagnostics = diagnostic;
1821 res->u.scan_response->num_diagnostics = num_diagnostic;
1823 srw_bend_scan(assoc, sr, res->u.scan_response, &http_code);
1824 if (http_code == 200)
1825 soap_package->u.generic->p = res;
1827 else if (sr->which == Z_SRW_update_request)
1829 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1831 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1834 res->u.update_response->diagnostics = diagnostic;
1835 res->u.update_response->num_diagnostics = num_diagnostic;
1837 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1838 srw_bend_update(assoc, sr, res->u.update_response, &http_code);
1839 if (http_code == 200)
1840 soap_package->u.generic->p = res;
1844 yaz_log(log_request, "SOAP ERROR");
1845 /* FIXME - what error, what query */
1847 z_soap_error(assoc->encode, soap_package,
1848 "SOAP-ENV:Client", "Bad method", 0);
1850 if (http_code == 200 || http_code == 500)
1852 static Z_SOAP_Handler soap_handlers[4] = {
1854 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1855 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1856 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1862 p = z_get_HTTP_Response(o, 200);
1863 hres = p->u.HTTP_Response;
1865 if (!stylesheet && assoc->server)
1866 stylesheet = assoc->server->stylesheet;
1868 /* empty stylesheet means NO stylesheet */
1869 if (stylesheet && *stylesheet == '\0')
1872 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1873 &hres->content_buf, &hres->content_len,
1874 soap_handlers, charset, stylesheet);
1875 hres->code = http_code;
1877 strcpy(ctype, "text/xml");
1878 if (charset && strlen(charset) < sizeof(ctype)-30)
1880 strcat(ctype, "; charset=");
1881 strcat(ctype, charset);
1883 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1886 p = z_get_HTTP_Response(o, http_code);
1890 p = z_get_HTTP_Response(o, 500);
1891 hres = p->u.HTTP_Response;
1892 if (!strcmp(hreq->version, "1.0"))
1894 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1895 if (v && !strcmp(v, "Keep-Alive"))
1899 hres->version = "1.0";
1903 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1904 if (v && !strcmp(v, "close"))
1908 hres->version = "1.1";
1910 if (!keepalive || !assoc->last_control->keepalive)
1912 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1913 assoc->state = ASSOC_DEAD;
1914 assoc->cs_get_mask = 0;
1919 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1921 if (alive && yaz_isdigit(*(const unsigned char *) alive))
1925 if (t < 0 || t > 3600)
1927 iochan_settimeout(assoc->client_chan,t);
1928 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1930 process_gdu_response(assoc, req, p);
1933 static void process_gdu_request(association *assoc, request *req)
1935 if (req->gdu_request->which == Z_GDU_Z3950)
1938 req->apdu_request = req->gdu_request->u.z3950;
1939 if (process_z_request(assoc, req, &msg) < 0)
1940 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1942 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1943 process_http_request(assoc, req);
1946 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1951 * Initiate request processing.
1953 static int process_z_request(association *assoc, request *req, char **msg)
1958 *msg = "Unknown Error";
1959 assert(req && req->state == REQUEST_IDLE);
1960 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1962 *msg = "Missing InitRequest";
1965 switch (req->apdu_request->which)
1967 case Z_APDU_initRequest:
1968 res = process_initRequest(assoc, req); break;
1969 case Z_APDU_searchRequest:
1970 res = process_searchRequest(assoc, req); break;
1971 case Z_APDU_presentRequest:
1972 res = process_presentRequest(assoc, req); break;
1973 case Z_APDU_scanRequest:
1974 if (assoc->init->bend_scan)
1975 res = process_scanRequest(assoc, req);
1978 *msg = "Cannot handle Scan APDU";
1982 case Z_APDU_extendedServicesRequest:
1983 if (assoc->init->bend_esrequest)
1984 res = process_ESRequest(assoc, req);
1987 *msg = "Cannot handle Extended Services APDU";
1991 case Z_APDU_sortRequest:
1992 if (assoc->init->bend_sort)
1993 res = process_sortRequest(assoc, req);
1996 *msg = "Cannot handle Sort APDU";
2001 process_close(assoc, req);
2003 case Z_APDU_deleteResultSetRequest:
2004 if (assoc->init->bend_delete)
2005 res = process_deleteRequest(assoc, req);
2008 *msg = "Cannot handle Delete APDU";
2012 case Z_APDU_segmentRequest:
2013 if (assoc->init->bend_segment)
2015 res = process_segmentRequest(assoc, req);
2019 *msg = "Cannot handle Segment APDU";
2023 case Z_APDU_triggerResourceControlRequest:
2026 *msg = "Bad APDU received";
2031 yaz_log(YLOG_DEBUG, " result immediately available");
2032 retval = process_z_response(assoc, req, res);
2036 yaz_log(YLOG_DEBUG, " result unavailable");
2043 * Encode response, and transfer the request structure to the outgoing queue.
2045 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2047 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2051 if (!z_GDU(assoc->print, &res, 0, 0))
2052 yaz_log(YLOG_WARN, "ODR print error: %s",
2053 odr_errmsg(odr_geterror(assoc->print)));
2054 odr_reset(assoc->print);
2056 if (!z_GDU(assoc->encode, &res, 0, 0))
2058 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2059 odr_errmsg(odr_geterror(assoc->decode)),
2060 odr_getelement(assoc->decode));
2063 req->response = odr_getbuf(assoc->encode, &req->len_response,
2064 &req->size_response);
2065 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2066 odr_reset(assoc->encode);
2067 req->state = REQUEST_IDLE;
2068 request_enq(&assoc->outgoing, req);
2069 /* turn the work over to the ir_session handler */
2070 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2071 assoc->cs_put_mask = EVENT_OUTPUT;
2072 /* Is there more work to be done? give that to the input handler too */
2075 req = request_head(&assoc->incoming);
2076 if (req && req->state == REQUEST_IDLE)
2078 request_deq(&assoc->incoming);
2079 process_gdu_request(assoc, req);
2088 * Encode response, and transfer the request structure to the outgoing queue.
2090 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2092 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*gres));
2093 gres->which = Z_GDU_Z3950;
2094 gres->u.z3950 = res;
2096 return process_gdu_response(assoc, req, gres);
2099 static char *get_vhost(Z_OtherInformation *otherInfo)
2101 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2105 * Handle init request.
2106 * At the moment, we don't check the options
2107 * anywhere else in the code - we just try not to do anything that would
2108 * break a naive client. We'll toss 'em into the association block when
2109 * we need them there.
2111 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2113 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2114 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2115 Z_InitResponse *resp = apdu->u.initResponse;
2116 bend_initresult *binitres;
2118 statserv_options_block *cb = 0; /* by default no control for backend */
2120 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2121 cb = statserv_getcontrol(); /* got control block for backend */
2123 if (cb && assoc->backend)
2124 (*cb->bend_close)(assoc->backend);
2126 yaz_log(log_requestdetail, "Got initRequest");
2127 if (req->implementationId)
2128 yaz_log(log_requestdetail, "Id: %s",
2129 req->implementationId);
2130 if (req->implementationName)
2131 yaz_log(log_requestdetail, "Name: %s",
2132 req->implementationName);
2133 if (req->implementationVersion)
2134 yaz_log(log_requestdetail, "Version: %s",
2135 req->implementationVersion);
2137 assoc_init_reset(assoc);
2139 assoc->init->auth = req->idAuthentication;
2140 assoc->init->referenceId = req->referenceId;
2142 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2144 Z_CharSetandLanguageNegotiation *negotiation =
2145 yaz_get_charneg_record (req->otherInfo);
2147 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2148 assoc->init->charneg_request = negotiation;
2151 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2152 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2153 assoc->init->named_result_sets = 1;
2158 if (req->implementationVersion)
2159 yaz_log(log_requestdetail, "Config: %s",
2162 iochan_settimeout(assoc->client_chan, cb->idle_timeout);
2164 /* we have a backend control block, so call that init function */
2165 if (!(binitres = (*cb->bend_init)(assoc->init)))
2167 yaz_log(YLOG_WARN, "Bad response from backend.");
2170 assoc->backend = binitres->handle;
2174 /* no backend. return error */
2175 binitres = (bend_initresult *)
2176 odr_malloc(assoc->encode, sizeof(*binitres));
2177 binitres->errstring = 0;
2178 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2179 iochan_settimeout(assoc->client_chan, 10);
2181 if ((assoc->init->bend_sort))
2182 yaz_log(YLOG_DEBUG, "Sort handler installed");
2183 if ((assoc->init->bend_search))
2184 yaz_log(YLOG_DEBUG, "Search handler installed");
2185 if ((assoc->init->bend_present))
2186 yaz_log(YLOG_DEBUG, "Present handler installed");
2187 if ((assoc->init->bend_esrequest))
2188 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2189 if ((assoc->init->bend_delete))
2190 yaz_log(YLOG_DEBUG, "Delete handler installed");
2191 if ((assoc->init->bend_scan))
2192 yaz_log(YLOG_DEBUG, "Scan handler installed");
2193 if ((assoc->init->bend_segment))
2194 yaz_log(YLOG_DEBUG, "Segment handler installed");
2196 resp->referenceId = req->referenceId;
2198 /* let's tell the client what we can do */
2199 if (ODR_MASK_GET(req->options, Z_Options_search))
2201 ODR_MASK_SET(resp->options, Z_Options_search);
2202 strcat(options, "srch");
2204 if (ODR_MASK_GET(req->options, Z_Options_present))
2206 ODR_MASK_SET(resp->options, Z_Options_present);
2207 strcat(options, " prst");
2209 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2210 assoc->init->bend_delete)
2212 ODR_MASK_SET(resp->options, Z_Options_delSet);
2213 strcat(options, " del");
2215 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2216 assoc->init->bend_esrequest)
2218 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2219 strcat(options, " extendedServices");
2221 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2222 && assoc->init->named_result_sets)
2224 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2225 strcat(options, " namedresults");
2227 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2229 ODR_MASK_SET(resp->options, Z_Options_scan);
2230 strcat(options, " scan");
2232 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2234 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2235 strcat(options, " concurrop");
2237 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2239 ODR_MASK_SET(resp->options, Z_Options_sort);
2240 strcat(options, " sort");
2243 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2245 Z_OtherInformationUnit *p0;
2247 if (!assoc->init->charneg_response)
2249 if (assoc->init->query_charset)
2251 assoc->init->charneg_response = yaz_set_response_charneg(
2252 assoc->encode, assoc->init->query_charset, 0,
2253 assoc->init->records_in_same_charset);
2257 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2260 if (assoc->init->charneg_response
2261 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2263 p0->which = Z_OtherInfo_externallyDefinedInfo;
2264 p0->information.externallyDefinedInfo =
2265 assoc->init->charneg_response;
2266 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2267 strcat(options, " negotiation");
2270 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2271 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2273 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2275 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2276 assoc->version = 1; /* 1 & 2 are equivalent */
2278 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2280 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2283 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2285 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2289 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2291 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2292 assoc->maximumRecordSize = odr_int_to_int(*req->maximumRecordSize);
2294 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2295 assoc->preferredMessageSize = odr_int_to_int(*req->preferredMessageSize);
2297 resp->preferredMessageSize =
2298 odr_intdup(assoc->encode, assoc->preferredMessageSize);
2299 resp->maximumRecordSize =
2300 odr_intdup(assoc->encode, assoc->maximumRecordSize);
2302 resp->implementationId = odr_prepend(assoc->encode,
2303 assoc->init->implementation_id,
2304 resp->implementationId);
2306 resp->implementationName = odr_prepend(assoc->encode,
2307 assoc->init->implementation_name,
2308 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2310 if (binitres->errcode)
2312 assoc->state = ASSOC_DEAD;
2313 resp->userInformationField =
2314 init_diagnostics(assoc->encode, binitres->errcode,
2315 binitres->errstring);
2319 assoc->state = ASSOC_UP;
2323 if (!req->idAuthentication)
2324 yaz_log(log_request, "Auth none");
2325 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2327 const char *open = req->idAuthentication->u.open;
2328 const char *slash = strchr(open, '/');
2334 yaz_log(log_request, "Auth open %.*s", len, open);
2336 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2338 const char *user = req->idAuthentication->u.idPass->userId;
2339 const char *group = req->idAuthentication->u.idPass->groupId;
2340 yaz_log(log_request, "Auth idPass %s %s",
2341 user ? user : "-", group ? group : "-");
2343 else if (req->idAuthentication->which
2344 == Z_IdAuthentication_anonymous)
2346 yaz_log(log_request, "Auth anonymous");
2350 yaz_log(log_request, "Auth other");
2355 WRBUF wr = wrbuf_alloc();
2356 wrbuf_printf(wr, "Init ");
2357 if (binitres->errcode)
2358 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2360 wrbuf_printf(wr, "OK -");
2361 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2362 (req->implementationId ? req->implementationId :"-"),
2363 (req->implementationName ?
2364 req->implementationName : "-"),
2365 (req->implementationVersion ?
2366 req->implementationVersion : "-")
2368 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2375 * Set the specified `errcode' and `errstring' into a UserInfo-1
2376 * external to be returned to the client in accordance with Z35.90
2377 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2378 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2380 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2382 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2383 addinfo ? " -- " : "", addinfo ? addinfo : "");
2384 return zget_init_diagnostics(odr, error, addinfo);
2388 * nonsurrogate diagnostic record.
2390 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2392 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2394 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2395 addinfo ? " -- " : "", addinfo ? addinfo : "");
2397 rec->which = Z_Records_NSD;
2398 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2404 * surrogate diagnostic.
2406 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2408 int error, const char *addinfo)
2410 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2411 addinfo ? " -- " : "", addinfo ? addinfo : "");
2412 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2415 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2416 Odr_int *num, Z_RecordComposition *comp,
2417 Odr_int *next, Odr_int *pres,
2418 Z_ReferenceId *referenceId,
2419 Odr_oid *oid, int *errcode)
2421 int recno, total_length = 0, dumped_records = 0;
2422 int toget = odr_int_to_int(*num);
2423 Z_Records *records =
2424 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2425 Z_NamePlusRecordList *reclist =
2426 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2428 records->which = Z_Records_DBOSD;
2429 records->u.databaseOrSurDiagnostics = reclist;
2430 reclist->num_records = 0;
2433 return diagrec(a, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, 0);
2434 else if (toget == 0)
2435 reclist->records = odr_nullval();
2437 reclist->records = (Z_NamePlusRecord **)
2438 odr_malloc(a->encode, sizeof(*reclist->records) * toget);
2440 *pres = Z_PresentStatus_success;
2444 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2445 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2446 a->maximumRecordSize);
2447 for (recno = odr_int_to_int(start); reclist->num_records < toget; recno++)
2450 Z_NamePlusRecord *thisrec;
2451 int this_length = 0;
2453 * we get the number of bytes allocated on the stream before any
2454 * allocation done by the backend - this should give us a reasonable
2455 * idea of the total size of the data so far.
2457 total_length = odr_total(a->encode) - dumped_records;
2463 freq.last_in_set = 0;
2464 freq.setname = setname;
2465 freq.surrogate_flag = 0;
2466 freq.number = recno;
2468 freq.request_format = oid;
2469 freq.output_format = 0;
2470 freq.stream = a->encode;
2471 freq.print = a->print;
2472 freq.referenceId = referenceId;
2475 retrieve_fetch(a, &freq);
2477 *next = freq.last_in_set ? 0 : recno + 1;
2481 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2484 *pres = Z_PresentStatus_failure;
2485 /* for 'present request out of range',
2486 set addinfo to record position if not set */
2487 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2488 freq.errstring == 0)
2490 sprintf(s, "%d", recno);
2494 *errcode = freq.errcode;
2495 return diagrec(a, freq.errcode, freq.errstring);
2497 reclist->records[reclist->num_records] =
2498 surrogatediagrec(a, freq.basename, freq.errcode,
2500 reclist->num_records++;
2503 if (freq.record == 0) /* no error and no record ? */
2505 *pres = Z_PresentStatus_partial_4;
2506 *next = 0; /* signal end-of-set and stop */
2510 this_length = freq.len;
2512 this_length = odr_total(a->encode) - total_length - dumped_records;
2513 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2514 this_length, total_length, dumped_records);
2515 if (a->preferredMessageSize > 0 &&
2516 this_length + total_length > a->preferredMessageSize)
2518 /* record is small enough, really */
2519 if (this_length <= a->preferredMessageSize && recno > start)
2521 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2522 *pres = Z_PresentStatus_partial_2;
2527 /* record can only be fetched by itself */
2528 if (this_length < a->maximumRecordSize)
2530 yaz_log(log_requestdetail, " Record > prefmsgsz");
2533 yaz_log(YLOG_DEBUG, " Dropped it");
2534 reclist->records[reclist->num_records] =
2537 YAZ_BIB1_RECORD_EXCEEDS_PREFERRED_MESSAGE_SIZE, 0);
2538 reclist->num_records++;
2539 dumped_records += this_length;
2543 else /* too big entirely */
2545 yaz_log(log_requestdetail, "Record > maxrcdsz "
2547 this_length, a->maximumRecordSize);
2548 reclist->records[reclist->num_records] =
2551 YAZ_BIB1_RECORD_EXCEEDS_MAXIMUM_RECORD_SIZE, 0);
2552 reclist->num_records++;
2553 dumped_records += this_length;
2558 if (!(thisrec = (Z_NamePlusRecord *)
2559 odr_malloc(a->encode, sizeof(*thisrec))))
2561 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2562 thisrec->which = Z_NamePlusRecord_databaseRecord;
2564 if (!freq.output_format)
2566 yaz_log(YLOG_WARN, "bend_fetch output_format not set");
2569 thisrec->u.databaseRecord = z_ext_record_oid(
2570 a->encode, freq.output_format, freq.record, freq.len);
2571 if (!thisrec->u.databaseRecord)
2573 reclist->records[reclist->num_records] = thisrec;
2574 reclist->num_records++;
2576 *num = reclist->num_records;
2580 static Z_APDU *process_searchRequest(association *assoc, request *reqb)
2582 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2583 bend_search_rr *bsrr =
2584 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2586 yaz_log(log_requestdetail, "Got SearchRequest.");
2587 bsrr->association = assoc;
2588 bsrr->referenceId = req->referenceId;
2589 bsrr->srw_sortKeys = 0;
2590 bsrr->srw_setname = 0;
2591 bsrr->srw_setnameIdleTime = 0;
2592 bsrr->estimated_hit_count = 0;
2593 bsrr->partial_resultset = 0;
2594 bsrr->extra_args = 0;
2595 bsrr->extra_response_data = 0;
2597 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2598 if (req->databaseNames)
2601 for (i = 0; i < req->num_databaseNames; i++)
2602 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2605 yaz_log_zquery_level(log_requestdetail,req->query);
2607 if (assoc->init->bend_search)
2609 bsrr->setname = req->resultSetName;
2610 bsrr->replace_set = *req->replaceIndicator;
2611 bsrr->num_bases = req->num_databaseNames;
2612 bsrr->basenames = req->databaseNames;
2613 bsrr->query = req->query;
2614 bsrr->stream = assoc->encode;
2615 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2616 bsrr->decode = assoc->decode;
2617 bsrr->print = assoc->print;
2620 bsrr->errstring = NULL;
2621 bsrr->search_info = NULL;
2622 bsrr->search_input = req->otherInfo;
2624 if (assoc->server && assoc->server->cql_transform
2625 && req->query->which == Z_Query_type_104
2626 && req->query->u.type_104->which == Z_External_CQL)
2628 /* have a CQL query and a CQL to PQF transform .. */
2630 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2631 assoc->server->cql_transform, bsrr->query);
2633 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2636 if (assoc->server && assoc->server->ccl_transform
2637 && req->query->which == Z_Query_type_2) /*CCL*/
2639 /* have a CCL query and a CCL to PQF transform .. */
2641 ccl2pqf(bsrr->stream, req->query->u.type_2,
2642 assoc->server->ccl_transform, bsrr);
2644 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2648 (assoc->init->bend_search)(assoc->backend, bsrr);
2652 /* FIXME - make a diagnostic for it */
2653 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2655 return response_searchRequest(assoc, reqb, bsrr);
2659 * Prepare a searchresponse based on the backend results. We probably want
2660 * to look at making the fetching of records nonblocking as well, but
2661 * so far, we'll keep things simple.
2662 * If bsrt is null, that means we're called in response to a communications
2663 * event, and we'll have to get the response for ourselves.
2665 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2666 bend_search_rr *bsrt)
2668 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2669 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2670 Z_SearchResponse *resp = (Z_SearchResponse *)
2671 odr_malloc(assoc->encode, sizeof(*resp));
2672 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2673 Odr_int *next = odr_intdup(assoc->encode, 0);
2674 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2675 Odr_int returnedrecs = 0;
2677 apdu->which = Z_APDU_searchResponse;
2678 apdu->u.searchResponse = resp;
2679 resp->referenceId = req->referenceId;
2680 resp->additionalSearchInfo = 0;
2681 resp->otherInfo = 0;
2684 yaz_log(YLOG_FATAL, "Bad result from backend");
2687 else if (bsrt->errcode)
2689 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2690 resp->resultCount = nulint;
2691 resp->numberOfRecordsReturned = nulint;
2692 resp->nextResultSetPosition = nulint;
2693 resp->searchStatus = odr_booldup(assoc->encode, 0);
2694 resp->resultSetStatus = none;
2695 resp->presentStatus = 0;
2699 bool_t *sr = odr_booldup(assoc->encode, 1);
2700 Odr_int *toget = odr_intdup(assoc->encode, 0);
2701 Z_RecordComposition comp, *compp = 0;
2703 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2706 resp->resultCount = &bsrt->hits;
2708 comp.which = Z_RecordComp_simple;
2709 /* how many records does the user agent want, then? */
2712 else if (bsrt->hits <= *req->smallSetUpperBound)
2714 *toget = bsrt->hits;
2715 if ((comp.u.simple = req->smallSetElementSetNames))
2718 else if (bsrt->hits < *req->largeSetLowerBound)
2720 *toget = *req->mediumSetPresentNumber;
2721 if (*toget > bsrt->hits)
2722 *toget = bsrt->hits;
2723 if ((comp.u.simple = req->mediumSetElementSetNames))
2729 if (*toget && !resp->records)
2731 Odr_int *presst = odr_intdup(assoc->encode, 0);
2732 /* Call bend_present if defined */
2733 if (assoc->init->bend_present)
2735 bend_present_rr *bprr = (bend_present_rr *)
2736 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2737 bprr->setname = req->resultSetName;
2739 bprr->number = odr_int_to_int(*toget);
2740 bprr->format = req->preferredRecordSyntax;
2742 bprr->referenceId = req->referenceId;
2743 bprr->stream = assoc->encode;
2744 bprr->print = assoc->print;
2745 bprr->association = assoc;
2747 bprr->errstring = NULL;
2748 (*assoc->init->bend_present)(assoc->backend, bprr);
2752 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2753 *resp->presentStatus = Z_PresentStatus_failure;
2758 resp->records = pack_records(
2759 assoc, req->resultSetName, 1,
2760 toget, compp, next, presst, req->referenceId,
2761 req->preferredRecordSyntax, NULL);
2764 resp->numberOfRecordsReturned = toget;
2765 returnedrecs = *toget;
2766 resp->presentStatus = presst;
2770 if (*resp->resultCount)
2772 resp->numberOfRecordsReturned = nulint;
2773 resp->presentStatus = 0;
2775 resp->nextResultSetPosition = next;
2776 resp->searchStatus = sr;
2777 resp->resultSetStatus = 0;
2778 if (bsrt->estimated_hit_count)
2780 resp->resultSetStatus = odr_intdup(assoc->encode,
2781 Z_SearchResponse_estimate);
2783 else if (bsrt->partial_resultset)
2785 resp->resultSetStatus = odr_intdup(assoc->encode,
2786 Z_SearchResponse_subset);
2789 resp->additionalSearchInfo = bsrt->search_info;
2794 WRBUF wr = wrbuf_alloc();
2796 for (i = 0 ; i < req->num_databaseNames; i++)
2799 wrbuf_printf(wr, "+");
2800 wrbuf_puts(wr, req->databaseNames[i]);
2802 wrbuf_printf(wr, " ");
2805 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2807 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2808 wrbuf_printf(wr, " %s 1+" ODR_INT_PRINTF " ",
2809 req->resultSetName, returnedrecs);
2810 yaz_query_to_wrbuf(wr, req->query);
2812 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2819 * Maybe we got a little over-friendly when we designed bend_fetch to
2820 * get only one record at a time. Some backends can optimise multiple-record
2821 * fetches, and at any rate, there is some overhead involved in
2822 * all that selecting and hopping around. Problem is, of course, that the
2823 * frontend can't know ahead of time how many records it'll need to
2824 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2825 * is downright lousy as a bulk data transfer protocol.
2827 * To start with, we'll do the fetching of records from the backend
2828 * in one operation: To save some trips in and out of the event-handler,
2829 * and to simplify the interface to pack_records. At any rate, asynch
2830 * operation is more fun in operations that have an unpredictable execution
2831 * speed - which is normally more true for search than for present.
2833 static Z_APDU *process_presentRequest(association *assoc, request *reqb)
2835 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2837 Z_PresentResponse *resp;
2841 const char *errstring = 0;
2843 yaz_log(log_requestdetail, "Got PresentRequest.");
2845 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2847 resp->presentStatus = odr_intdup(assoc->encode, 0);
2848 if (assoc->init->bend_present)
2850 bend_present_rr *bprr = (bend_present_rr *)
2851 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2852 bprr->setname = req->resultSetId;
2853 bprr->start = odr_int_to_int(*req->resultSetStartPoint);
2854 bprr->number = odr_int_to_int(*req->numberOfRecordsRequested);
2855 bprr->format = req->preferredRecordSyntax;
2856 bprr->comp = req->recordComposition;
2857 bprr->referenceId = req->referenceId;
2858 bprr->stream = assoc->encode;
2859 bprr->print = assoc->print;
2860 bprr->association = assoc;
2862 bprr->errstring = NULL;
2863 (*assoc->init->bend_present)(assoc->backend, bprr);
2867 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2868 *resp->presentStatus = Z_PresentStatus_failure;
2869 errcode = bprr->errcode;
2870 errstring = bprr->errstring;
2873 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2874 next = odr_intdup(assoc->encode, 0);
2875 num = odr_intdup(assoc->encode, 0);
2877 apdu->which = Z_APDU_presentResponse;
2878 apdu->u.presentResponse = resp;
2879 resp->referenceId = req->referenceId;
2880 resp->otherInfo = 0;
2884 *num = *req->numberOfRecordsRequested;
2886 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2887 num, req->recordComposition, next,
2888 resp->presentStatus,
2889 req->referenceId, req->preferredRecordSyntax,
2894 WRBUF wr = wrbuf_alloc();
2895 wrbuf_printf(wr, "Present ");
2897 if (*resp->presentStatus == Z_PresentStatus_failure)
2898 wrbuf_printf(wr, "ERROR %d ", errcode);
2899 else if (*resp->presentStatus == Z_PresentStatus_success)
2900 wrbuf_printf(wr, "OK - ");
2902 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2903 *resp->presentStatus);
2905 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2906 req->resultSetId, *req->resultSetStartPoint,
2907 *req->numberOfRecordsRequested);
2908 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2913 resp->numberOfRecordsReturned = num;
2914 resp->nextResultSetPosition = next;
2920 * Scan was implemented rather in a hurry, and with support for only the basic
2921 * elements of the service in the backend API. Suggestions are welcome.
2923 static Z_APDU *process_scanRequest(association *assoc, request *reqb)
2925 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2926 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2927 Z_ScanResponse *res = (Z_ScanResponse *)
2928 odr_malloc(assoc->encode, sizeof(*res));
2929 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2930 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2931 Z_ListEntries *ents = (Z_ListEntries *)
2932 odr_malloc(assoc->encode, sizeof(*ents));
2933 Z_DiagRecs *diagrecs_p = NULL;
2934 bend_scan_rr *bsrr = (bend_scan_rr *)
2935 odr_malloc(assoc->encode, sizeof(*bsrr));
2936 struct scan_entry *save_entries;
2939 yaz_log(log_requestdetail, "Got ScanRequest");
2941 apdu->which = Z_APDU_scanResponse;
2942 apdu->u.scanResponse = res;
2943 res->referenceId = req->referenceId;
2945 /* if step is absent, set it to 0 */
2947 step_size = odr_int_to_int(*req->stepSize);
2949 res->scanStatus = scanStatus;
2950 res->numberOfEntriesReturned = numberOfEntriesReturned;
2951 res->positionOfTerm = 0;
2952 res->entries = ents;
2953 ents->num_entries = 0;
2954 ents->entries = NULL;
2955 ents->num_nonsurrogateDiagnostics = 0;
2956 ents->nonsurrogateDiagnostics = NULL;
2957 res->attributeSet = 0;
2960 if (req->databaseNames)
2963 for (i = 0; i < req->num_databaseNames; i++)
2964 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2966 bsrr->scanClause = 0;
2968 bsrr->errstring = 0;
2969 bsrr->num_bases = req->num_databaseNames;
2970 bsrr->basenames = req->databaseNames;
2971 bsrr->num_entries = odr_int_to_int(*req->numberOfTermsRequested);
2972 bsrr->term = req->termListAndStartPoint;
2973 bsrr->referenceId = req->referenceId;
2974 bsrr->stream = assoc->encode;
2975 bsrr->print = assoc->print;
2976 bsrr->step_size = &step_size;
2977 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
2978 yaz_oid_userinfo_scan_set, 1, 0);
2980 /* For YAZ 2.0 and earlier it was the backend handler that
2981 initialized entries (member display_term did not exist)
2982 YAZ 2.0 and later sets 'entries' and initialize all members
2983 including 'display_term'. If YAZ 2.0 or later sees that
2984 entries was modified - we assume that it is an old handler and
2985 that 'display_term' is _not_ set.
2987 if (bsrr->num_entries > 0)
2990 bsrr->entries = (struct scan_entry *)
2991 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
2993 for (i = 0; i<bsrr->num_entries; i++)
2995 bsrr->entries[i].term = 0;
2996 bsrr->entries[i].occurrences = 0;
2997 bsrr->entries[i].errcode = 0;
2998 bsrr->entries[i].errstring = 0;
2999 bsrr->entries[i].display_term = 0;
3002 save_entries = bsrr->entries; /* save it so we can compare later */
3004 bsrr->attributeset = req->attributeSet;
3005 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3006 bsrr->attributeset);
3007 bsrr->term_position = req->preferredPositionInResponse ?
3008 odr_int_to_int(*req->preferredPositionInResponse) : 1;
3010 ((int (*)(void *, bend_scan_rr *))
3011 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3014 diagrecs_p = zget_DiagRecs(assoc->encode,
3015 bsrr->errcode, bsrr->errstring);
3019 Z_Entry **tab = (Z_Entry **)
3020 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3022 if (bsrr->status == BEND_SCAN_PARTIAL)
3023 *scanStatus = Z_Scan_partial_5;
3025 *scanStatus = Z_Scan_success;
3026 res->stepSize = odr_intdup(assoc->encode, step_size);
3027 ents->entries = tab;
3028 ents->num_entries = bsrr->num_entries;
3029 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3031 res->positionOfTerm = odr_intdup(assoc->encode, bsrr->term_position);
3032 for (i = 0; i < bsrr->num_entries; i++)
3038 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3039 if (bsrr->entries[i].occurrences >= 0)
3041 e->which = Z_Entry_termInfo;
3042 e->u.termInfo = t = (Z_TermInfo *)
3043 odr_malloc(assoc->encode, sizeof(*t));
3044 t->suggestedAttributes = 0;
3046 if (save_entries == bsrr->entries &&
3047 bsrr->entries[i].display_term)
3049 /* the entries was _not_ set by the handler. So it's
3050 safe to test for new member display_term. It is
3053 t->displayTerm = odr_strdup(assoc->encode,
3054 bsrr->entries[i].display_term);
3056 t->alternativeTerm = 0;
3057 t->byAttributes = 0;
3058 t->otherTermInfo = 0;
3059 t->globalOccurrences = &bsrr->entries[i].occurrences;
3060 t->term = (Z_Term *)
3061 odr_malloc(assoc->encode, sizeof(*t->term));
3062 t->term->which = Z_Term_general;
3063 t->term->u.general = o =
3064 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3065 o->buf = (unsigned char *)
3066 odr_malloc(assoc->encode, o->len = o->size =
3067 strlen(bsrr->entries[i].term));
3068 memcpy(o->buf, bsrr->entries[i].term, o->len);
3069 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3070 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3074 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3075 bsrr->entries[i].errcode,
3076 bsrr->entries[i].errstring);
3077 assert(drecs->num_diagRecs == 1);
3078 e->which = Z_Entry_surrogateDiagnostic;
3079 assert(drecs->diagRecs[0]);
3080 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3086 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3087 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3092 WRBUF wr = wrbuf_alloc();
3093 wrbuf_printf(wr, "Scan ");
3094 for (i = 0 ; i < req->num_databaseNames; i++)
3097 wrbuf_printf(wr, "+");
3098 wrbuf_puts(wr, req->databaseNames[i]);
3101 wrbuf_printf(wr, " ");
3104 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3106 wrbuf_printf(wr, "OK");
3108 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3109 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3110 res->numberOfEntriesReturned ?
3111 *res->numberOfEntriesReturned : 0,
3112 (req->preferredPositionInResponse ?
3113 *req->preferredPositionInResponse : 1),
3114 *req->numberOfTermsRequested,
3115 (res->stepSize ? *res->stepSize : 1));
3118 wrbuf_printf(wr, "+%s", bsrr->setname);
3120 wrbuf_printf(wr, " ");
3121 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3122 bsrr->attributeset);
3123 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3129 static Z_APDU *process_sortRequest(association *assoc, request *reqb)
3132 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3133 Z_SortResponse *res = (Z_SortResponse *)
3134 odr_malloc(assoc->encode, sizeof(*res));
3135 bend_sort_rr *bsrr = (bend_sort_rr *)
3136 odr_malloc(assoc->encode, sizeof(*bsrr));
3138 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3140 yaz_log(log_requestdetail, "Got SortRequest.");
3142 bsrr->num_input_setnames = req->num_inputResultSetNames;
3143 for (i=0;i<req->num_inputResultSetNames;i++)
3144 yaz_log(log_requestdetail, "Input resultset: '%s'",
3145 req->inputResultSetNames[i]);
3146 bsrr->input_setnames = req->inputResultSetNames;
3147 bsrr->referenceId = req->referenceId;
3148 bsrr->output_setname = req->sortedResultSetName;
3149 yaz_log(log_requestdetail, "Output resultset: '%s'",
3150 req->sortedResultSetName);
3151 bsrr->sort_sequence = req->sortSequence;
3152 /*FIXME - dump those sequences too */
3153 bsrr->stream = assoc->encode;
3154 bsrr->print = assoc->print;
3156 bsrr->sort_status = Z_SortResponse_failure;
3158 bsrr->errstring = 0;
3160 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3162 res->referenceId = bsrr->referenceId;
3163 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3164 res->resultSetStatus = 0;
3167 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3168 bsrr->errcode, bsrr->errstring);
3169 res->diagnostics = dr->diagRecs;
3170 res->num_diagnostics = dr->num_diagRecs;
3174 res->num_diagnostics = 0;
3175 res->diagnostics = 0;
3177 res->resultCount = 0;
3180 apdu->which = Z_APDU_sortResponse;
3181 apdu->u.sortResponse = res;
3184 WRBUF wr = wrbuf_alloc();
3185 wrbuf_printf(wr, "Sort ");
3187 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3189 wrbuf_printf(wr, "OK -");
3190 wrbuf_printf(wr, " (");
3191 for (i = 0; i<req->num_inputResultSetNames; i++)
3194 wrbuf_printf(wr, "+");
3195 wrbuf_puts(wr, req->inputResultSetNames[i]);
3197 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3199 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3205 static Z_APDU *process_deleteRequest(association *assoc, request *reqb)
3208 Z_DeleteResultSetRequest *req =
3209 reqb->apdu_request->u.deleteResultSetRequest;
3210 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3211 odr_malloc(assoc->encode, sizeof(*res));
3212 bend_delete_rr *bdrr = (bend_delete_rr *)
3213 odr_malloc(assoc->encode, sizeof(*bdrr));
3214 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3216 yaz_log(log_requestdetail, "Got DeleteRequest.");
3218 bdrr->num_setnames = req->num_resultSetList;
3219 bdrr->setnames = req->resultSetList;
3220 for (i = 0; i<req->num_resultSetList; i++)
3221 yaz_log(log_requestdetail, "resultset: '%s'",
3222 req->resultSetList[i]);
3223 bdrr->stream = assoc->encode;
3224 bdrr->print = assoc->print;
3225 bdrr->function = odr_int_to_int(*req->deleteFunction);
3226 bdrr->referenceId = req->referenceId;
3228 if (bdrr->num_setnames > 0)
3230 bdrr->statuses = (int*)
3231 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3232 bdrr->num_setnames);
3233 for (i = 0; i < bdrr->num_setnames; i++)
3234 bdrr->statuses[i] = 0;
3236 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3238 res->referenceId = req->referenceId;
3240 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3242 res->deleteListStatuses = 0;
3243 if (bdrr->num_setnames > 0)
3246 res->deleteListStatuses = (Z_ListStatuses *)
3247 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3248 res->deleteListStatuses->num = bdrr->num_setnames;
3249 res->deleteListStatuses->elements =
3251 odr_malloc(assoc->encode,
3252 sizeof(*res->deleteListStatuses->elements) *
3253 bdrr->num_setnames);
3254 for (i = 0; i<bdrr->num_setnames; i++)
3256 res->deleteListStatuses->elements[i] =
3258 odr_malloc(assoc->encode,
3259 sizeof(**res->deleteListStatuses->elements));
3260 res->deleteListStatuses->elements[i]->status =
3261 odr_intdup(assoc->encode, bdrr->statuses[i]);
3262 res->deleteListStatuses->elements[i]->id =
3263 odr_strdup(assoc->encode, bdrr->setnames[i]);
3266 res->numberNotDeleted = 0;
3267 res->bulkStatuses = 0;
3268 res->deleteMessage = 0;
3271 apdu->which = Z_APDU_deleteResultSetResponse;
3272 apdu->u.deleteResultSetResponse = res;
3275 WRBUF wr = wrbuf_alloc();
3276 wrbuf_printf(wr, "Delete ");
3277 if (bdrr->delete_status)
3278 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3280 wrbuf_printf(wr, "OK -");
3281 for (i = 0; i<req->num_resultSetList; i++)
3282 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3283 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3289 static void process_close(association *assoc, request *reqb)
3291 Z_Close *req = reqb->apdu_request->u.close;
3292 static char *reasons[] =
3299 "securityViolation",
3306 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3307 reasons[*req->closeReason], req->diagnosticInformation ?
3308 req->diagnosticInformation : "NULL");
3309 if (assoc->version < 3) /* to make do_force respond with close */
3311 do_close_req(assoc, Z_Close_finished,
3312 "Association terminated by client", reqb);
3313 yaz_log(log_request,"Close OK");
3316 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3318 bend_segment_rr req;
3320 req.segment = reqb->apdu_request->u.segmentRequest;
3321 req.stream = assoc->encode;
3322 req.decode = assoc->decode;
3323 req.print = assoc->print;
3324 req.association = assoc;
3326 (*assoc->init->bend_segment)(assoc->backend, &req);
3331 static Z_APDU *process_ESRequest(association *assoc, request *reqb)
3333 bend_esrequest_rr esrequest;
3334 const char *ext_name = "unknown";
3336 Z_ExtendedServicesRequest *req =
3337 reqb->apdu_request->u.extendedServicesRequest;
3338 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3340 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3342 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3343 esrequest.stream = assoc->encode;
3344 esrequest.decode = assoc->decode;
3345 esrequest.print = assoc->print;
3346 esrequest.errcode = 0;
3347 esrequest.errstring = NULL;
3348 esrequest.association = assoc;
3349 esrequest.taskPackage = 0;
3350 esrequest.referenceId = req->referenceId;
3352 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3354 switch(esrequest.esr->taskSpecificParameters->which)
3356 case Z_External_itemOrder:
3357 ext_name = "ItemOrder"; break;
3358 case Z_External_update:
3359 ext_name = "Update"; break;
3360 case Z_External_update0:
3361 ext_name = "Update0"; break;
3362 case Z_External_ESAdmin:
3363 ext_name = "Admin"; break;
3368 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3370 resp->referenceId = req->referenceId;
3372 if (esrequest.errcode == -1)
3374 /* Backend service indicates request will be processed */
3375 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3376 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3378 else if (esrequest.errcode == 0)
3380 /* Backend service indicates request will be processed */
3381 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3382 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3386 Z_DiagRecs *diagRecs =
3387 zget_DiagRecs(assoc->encode, esrequest.errcode,
3388 esrequest.errstring);
3389 /* Backend indicates error, request will not be processed */
3390 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3391 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3392 resp->num_diagnostics = diagRecs->num_diagRecs;
3393 resp->diagnostics = diagRecs->diagRecs;
3396 WRBUF wr = wrbuf_alloc();
3397 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3398 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3403 /* Do something with the members of bend_extendedservice */
3404 if (esrequest.taskPackage)
3406 resp->taskPackage = z_ext_record_oid(
3407 assoc->encode, yaz_oid_recsyn_extended,
3408 (const char *) esrequest.taskPackage, -1);
3410 yaz_log(YLOG_DEBUG,"Send the result apdu");
3414 int bend_assoc_is_alive(bend_association assoc)
3416 if (assoc->state == ASSOC_DEAD)
3417 return 0; /* already marked as dead. Don't check I/O chan anymore */
3419 return iochan_is_alive(assoc->client_chan);
3426 * c-file-style: "Stroustrup"
3427 * indent-tabs-mode: nil
3429 * vim: shiftwidth=4 tabstop=8 expandtab