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, char **sortkeys_p)
760 /* have a CQL query and CQL to PQF transform .. */
761 CQL_parser cp = cql_parser_create();
768 r = cql_parser_string(cp, cql);
771 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
775 struct cql_node *cn = cql_parser_result(cp);
778 r = cql_transform_buf(ct, cn, rpn_buf, sizeof(rpn_buf)-1);
780 srw_errcode = cql_transform_error(ct, &add);
784 int r = cql_sortby_to_sortkeys_buf(cn, out, sizeof(out)-1);
789 yaz_log (log_requestdetail, "srw_sortKeys '%s'", out);
790 *sortkeys_p = odr_strdup(odr, out);
794 yaz_log(log_requestdetail, "failed to create srw_sortKeys");
795 srw_errcode = YAZ_SRW_UNSUPP_SORT_TYPE;
801 /* Syntax & transform OK. */
802 /* Convert PQF string to Z39.50 to RPN query struct */
803 YAZ_PQF_Parser pp = yaz_pqf_create();
804 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
809 int code = yaz_pqf_error(pp, &pqf_msg, &off);
810 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
812 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
816 query_result->which = Z_Query_type_1;
817 query_result->u.type_1 = rpnquery;
821 cql_parser_destroy(cp);
825 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
826 Z_AttributesPlusTerm *result)
831 int srw_error = cql2pqf(odr, cql, ct, &query, &sortkeys);
834 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
835 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
836 rpn = query.u.type_1;
837 if (!rpn->RPNStructure)
838 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
839 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
840 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
841 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
842 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
843 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
849 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
850 bend_search_rr *bsrr)
853 struct ccl_rpn_node *node;
856 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
857 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0)
859 bsrr->errstring = (char*) ccl_err_msg(errcode);
860 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
863 bsrr->query->which = Z_Query_type_1;
864 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
868 static void srw_bend_search(association *assoc,
873 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
876 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
879 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
880 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
881 if (srw_res->num_diagnostics == 0 && assoc->init)
884 rr.setname = "default";
887 rr.basenames = &srw_req->database;
891 rr.srw_setnameIdleTime = 0;
892 rr.estimated_hit_count = 0;
893 rr.partial_resultset = 0;
894 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
895 rr.query->u.type_1 = 0;
896 rr.extra_args = sr->extra_args;
897 rr.extra_response_data = 0;
899 if (srw_req->query_type == Z_SRW_query_type_cql)
901 if (assoc->server && assoc->server->cql_transform)
903 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
904 assoc->server->cql_transform,
910 yaz_add_srw_diagnostic(assoc->encode,
911 &srw_res->diagnostics,
912 &srw_res->num_diagnostics,
918 /* CQL query to backend. Wrap it - Z39.50 style */
919 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
920 ext->direct_reference = odr_getoidbystr(assoc->decode,
921 "1.2.840.10003.16.2");
922 ext->indirect_reference = 0;
924 ext->which = Z_External_CQL;
925 ext->u.cql = srw_req->query.cql;
927 rr.query->which = Z_Query_type_104;
928 rr.query->u.type_104 = ext;
931 else if (srw_req->query_type == Z_SRW_query_type_pqf)
933 Z_RPNQuery *RPNquery;
934 YAZ_PQF_Parser pqf_parser;
936 pqf_parser = yaz_pqf_create();
938 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
944 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
945 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
946 code, pqf_msg, (long) off);
947 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
950 rr.query->which = Z_Query_type_1;
951 rr.query->u.type_1 = RPNquery;
953 yaz_pqf_destroy(pqf_parser);
957 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
958 &srw_res->num_diagnostics,
959 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
961 if (rr.query->u.type_1)
963 rr.stream = assoc->encode;
964 rr.decode = assoc->decode;
965 rr.print = assoc->print;
966 if (srw_req->sort.sortKeys)
967 rr.srw_sortKeys = odr_strdup(assoc->encode,
968 srw_req->sort.sortKeys);
969 rr.association = assoc;
975 yaz_log_zquery_level(log_requestdetail,rr.query);
977 (assoc->init->bend_search)(assoc->backend, &rr);
980 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
986 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
987 yaz_add_srw_diagnostic(assoc->encode,
988 &srw_res->diagnostics,
989 &srw_res->num_diagnostics,
990 srw_error, rr.errstring);
995 int number = srw_req->maximumRecords ?
996 odr_int_to_int(*srw_req->maximumRecords) : 0;
997 int start = srw_req->startRecord ?
998 odr_int_to_int(*srw_req->startRecord) : 1;
1000 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
1002 start, number, rr.hits);
1004 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1007 srw_res->resultSetId =
1008 odr_strdup(assoc->encode, rr.srw_setname );
1009 srw_res->resultSetIdleTime =
1010 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1013 if (start > rr.hits || start < 1)
1015 /* if hits<=0 and start=1 we don't return a diagnostic */
1017 yaz_add_srw_diagnostic(
1019 &srw_res->diagnostics, &srw_res->num_diagnostics,
1020 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1022 else if (number > 0)
1026 if (start + number > rr.hits)
1027 number = odr_int_to_int(rr.hits) - start + 1;
1029 /* Call bend_present if defined */
1030 if (assoc->init->bend_present)
1032 bend_present_rr *bprr = (bend_present_rr*)
1033 odr_malloc(assoc->decode, sizeof(*bprr));
1034 bprr->setname = "default";
1035 bprr->start = start;
1036 bprr->number = number;
1037 if (srw_req->recordSchema)
1039 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1040 sizeof(*bprr->comp));
1041 bprr->comp->which = Z_RecordComp_simple;
1042 bprr->comp->u.simple = (Z_ElementSetNames *)
1043 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1044 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1045 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1051 bprr->stream = assoc->encode;
1052 bprr->referenceId = 0;
1053 bprr->print = assoc->print;
1054 bprr->association = assoc;
1056 bprr->errstring = NULL;
1057 (*assoc->init->bend_present)(assoc->backend, bprr);
1061 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1062 yaz_add_srw_diagnostic(assoc->encode,
1063 &srw_res->diagnostics,
1064 &srw_res->num_diagnostics,
1065 srw_error, bprr->errstring);
1073 int packing = Z_SRW_recordPacking_string;
1074 if (srw_req->recordPacking)
1077 yaz_srw_str_to_pack(srw_req->recordPacking);
1079 packing = Z_SRW_recordPacking_string;
1081 srw_res->records = (Z_SRW_record *)
1082 odr_malloc(assoc->encode,
1083 number * sizeof(*srw_res->records));
1085 srw_res->extra_records = (Z_SRW_extra_record **)
1086 odr_malloc(assoc->encode,
1087 number*sizeof(*srw_res->extra_records));
1089 for (i = 0; i<number; i++)
1092 const char *addinfo = 0;
1094 srw_res->records[j].recordPacking = packing;
1095 srw_res->records[j].recordData_buf = 0;
1096 srw_res->extra_records[j] = 0;
1097 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1098 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1099 srw_res->records + j,
1103 yaz_add_srw_diagnostic(assoc->encode,
1104 &srw_res->diagnostics,
1105 &srw_res->num_diagnostics,
1106 yaz_diag_bib1_to_srw(errcode),
1111 if (srw_res->records[j].recordData_buf)
1114 srw_res->num_records = j;
1116 srw_res->records = 0;
1119 if (rr.extra_response_data)
1121 res->extraResponseData_buf = rr.extra_response_data;
1122 res->extraResponseData_len = strlen(rr.extra_response_data);
1124 if (rr.estimated_hit_count || rr.partial_resultset)
1126 yaz_add_srw_diagnostic(
1128 &srw_res->diagnostics,
1129 &srw_res->num_diagnostics,
1130 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1138 const char *querystr = "?";
1139 const char *querytype = "?";
1140 WRBUF wr = wrbuf_alloc();
1142 switch (srw_req->query_type)
1144 case Z_SRW_query_type_cql:
1146 querystr = srw_req->query.cql;
1148 case Z_SRW_query_type_pqf:
1150 querystr = srw_req->query.pqf;
1153 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1154 if (srw_res->num_diagnostics)
1155 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1156 else if (*http_code != 200)
1157 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1158 else if (srw_res->numberOfRecords)
1160 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1161 (srw_res->numberOfRecords ?
1162 *srw_res->numberOfRecords : 0));
1164 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+%d",
1165 (srw_res->resultSetId ?
1166 srw_res->resultSetId : "-"),
1167 (srw_req->startRecord ? *srw_req->startRecord : 1),
1168 srw_res->num_records);
1169 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1174 static char *srw_bend_explain_default(bend_explain_rr *rr)
1177 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1180 for (ptr = ptr->children; ptr; ptr = ptr->next)
1182 if (ptr->type != XML_ELEMENT_NODE)
1184 if (!strcmp((const char *) ptr->name, "explain"))
1187 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1191 ptr = xmlCopyNode(ptr, 1);
1193 xmlDocSetRootElement(doc, ptr);
1195 xmlDocDumpMemory(doc, &buf_out, &len);
1196 content = (char*) odr_malloc(rr->stream, 1+len);
1197 memcpy(content, buf_out, len);
1198 content[len] = '\0';
1202 rr->explain_buf = content;
1210 static void srw_bend_explain(association *assoc,
1212 Z_SRW_explainResponse *srw_res,
1215 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1216 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1218 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1223 rr.stream = assoc->encode;
1224 rr.decode = assoc->decode;
1225 rr.print = assoc->print;
1227 rr.database = srw_req->database;
1229 rr.server_node_ptr = assoc->server->server_node_ptr;
1231 rr.server_node_ptr = 0;
1232 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1233 if (assoc->init->bend_explain)
1234 (*assoc->init->bend_explain)(assoc->backend, &rr);
1236 srw_bend_explain_default(&rr);
1240 int packing = Z_SRW_recordPacking_string;
1241 if (srw_req->recordPacking)
1244 yaz_srw_str_to_pack(srw_req->recordPacking);
1246 packing = Z_SRW_recordPacking_string;
1248 srw_res->record.recordSchema = rr.schema;
1249 srw_res->record.recordPacking = packing;
1250 srw_res->record.recordData_buf = rr.explain_buf;
1251 srw_res->record.recordData_len = strlen(rr.explain_buf);
1252 srw_res->record.recordPosition = 0;
1258 static void srw_bend_scan(association *assoc,
1260 Z_SRW_scanResponse *srw_res,
1263 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1264 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1267 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1268 if (srw_res->num_diagnostics == 0 && assoc->init)
1271 struct scan_entry *save_entries;
1273 bend_scan_rr *bsrr = (bend_scan_rr *)
1274 odr_malloc(assoc->encode, sizeof(*bsrr));
1275 bsrr->num_bases = 1;
1276 bsrr->basenames = &srw_req->database;
1278 bsrr->num_entries = srw_req->maximumTerms ?
1279 odr_int_to_int(*srw_req->maximumTerms) : 10;
1280 bsrr->term_position = srw_req->responsePosition ?
1281 odr_int_to_int(*srw_req->responsePosition) : 1;
1284 bsrr->errstring = 0;
1285 bsrr->referenceId = 0;
1286 bsrr->stream = assoc->encode;
1287 bsrr->print = assoc->print;
1288 bsrr->step_size = &step_size;
1292 if (bsrr->num_entries > 0)
1295 bsrr->entries = (struct scan_entry *)
1296 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1298 for (i = 0; i<bsrr->num_entries; i++)
1300 bsrr->entries[i].term = 0;
1301 bsrr->entries[i].occurrences = 0;
1302 bsrr->entries[i].errcode = 0;
1303 bsrr->entries[i].errstring = 0;
1304 bsrr->entries[i].display_term = 0;
1307 save_entries = bsrr->entries; /* save it so we can compare later */
1309 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1310 assoc->init->bend_scan)
1312 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1314 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1315 &bsrr->attributeset,
1316 srw_req->scanClause.pqf);
1317 yaz_pqf_destroy(pqf_parser);
1318 bsrr->scanClause = 0;
1319 ((int (*)(void *, bend_scan_rr *))
1320 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1322 else if (srw_req->query_type == Z_SRW_query_type_cql
1323 && assoc->init->bend_scan && assoc->server
1324 && assoc->server->cql_transform)
1327 bsrr->scanClause = 0;
1328 bsrr->attributeset = 0;
1329 bsrr->term = (Z_AttributesPlusTerm *)
1330 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1331 srw_error = cql2pqf_scan(assoc->encode,
1332 srw_req->scanClause.cql,
1333 assoc->server->cql_transform,
1336 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1337 &srw_res->num_diagnostics,
1341 ((int (*)(void *, bend_scan_rr *))
1342 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1345 else if (srw_req->query_type == Z_SRW_query_type_cql
1346 && assoc->init->bend_srw_scan)
1349 bsrr->attributeset = 0;
1350 bsrr->scanClause = srw_req->scanClause.cql;
1351 ((int (*)(void *, bend_scan_rr *))
1352 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1356 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1357 &srw_res->num_diagnostics,
1358 YAZ_SRW_UNSUPP_OPERATION, "scan");
1363 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1368 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1370 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1371 &srw_res->num_diagnostics,
1372 srw_error, bsrr->errstring);
1374 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1377 srw_res->terms = (Z_SRW_scanTerm*)
1378 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1381 srw_res->num_terms = bsrr->num_entries;
1382 for (i = 0; i<bsrr->num_entries; i++)
1384 Z_SRW_scanTerm *t = srw_res->terms + i;
1385 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1386 t->numberOfRecords =
1387 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1389 if (save_entries == bsrr->entries &&
1390 bsrr->entries[i].display_term)
1392 /* the entries was _not_ set by the handler. So it's
1393 safe to test for new member display_term. It is
1396 t->displayTerm = odr_strdup(assoc->encode,
1397 bsrr->entries[i].display_term);
1405 WRBUF wr = wrbuf_alloc();
1406 const char *querytype = 0;
1407 const char *querystr = 0;
1409 switch(srw_req->query_type)
1411 case Z_SRW_query_type_pqf:
1413 querystr = srw_req->scanClause.pqf;
1415 case Z_SRW_query_type_cql:
1417 querystr = srw_req->scanClause.cql;
1420 querytype = "UNKNOWN";
1424 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1426 if (srw_res->num_diagnostics)
1427 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1428 else if (srw_res->num_terms)
1429 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1431 wrbuf_printf(wr, "OK - - ");
1433 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1434 (srw_req->responsePosition ?
1435 *srw_req->responsePosition : 1),
1436 (srw_req->maximumTerms ?
1437 *srw_req->maximumTerms : 1));
1438 /* there is no step size in SRU/W ??? */
1439 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1440 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1446 static void srw_bend_update(association *assoc,
1448 Z_SRW_updateResponse *srw_res,
1451 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1452 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1453 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1455 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1459 Z_SRW_extra_record *extra = srw_req->extra_record;
1461 rr.stream = assoc->encode;
1462 rr.print = assoc->print;
1464 rr.basenames = &srw_req->database;
1465 rr.operation = srw_req->operation;
1466 rr.operation_status = "failed";
1468 rr.record_versions = 0;
1469 rr.num_versions = 0;
1470 rr.record_packing = "string";
1471 rr.record_schema = 0;
1473 rr.extra_record_data = 0;
1474 rr.extra_request_data = 0;
1475 rr.extra_response_data = 0;
1481 if (rr.operation == 0)
1483 yaz_add_sru_update_diagnostic(
1484 assoc->encode, &srw_res->diagnostics,
1485 &srw_res->num_diagnostics,
1486 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1490 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1491 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1492 if (!strcmp( rr.operation, "delete"))
1494 if (srw_req->record && !srw_req->record->recordSchema)
1496 rr.record_schema = odr_strdup(
1498 srw_req->record->recordSchema);
1500 if (srw_req->record)
1502 rr.record_data = odr_strdupn(
1504 srw_req->record->recordData_buf,
1505 srw_req->record->recordData_len );
1507 if (extra && extra->extraRecordData_len)
1509 rr.extra_record_data = odr_strdupn(
1511 extra->extraRecordData_buf,
1512 extra->extraRecordData_len );
1514 if (srw_req->recordId)
1515 rr.record_id = srw_req->recordId;
1516 else if (extra && extra->recordIdentifier)
1517 rr.record_id = extra->recordIdentifier;
1519 else if (!strcmp(rr.operation, "replace"))
1521 if (srw_req->recordId)
1522 rr.record_id = srw_req->recordId;
1523 else if (extra && extra->recordIdentifier)
1524 rr.record_id = extra->recordIdentifier;
1527 yaz_add_sru_update_diagnostic(
1528 assoc->encode, &srw_res->diagnostics,
1529 &srw_res->num_diagnostics,
1530 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1531 "recordIdentifier");
1533 if (!srw_req->record)
1535 yaz_add_sru_update_diagnostic(
1536 assoc->encode, &srw_res->diagnostics,
1537 &srw_res->num_diagnostics,
1538 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1543 if (srw_req->record->recordSchema)
1544 rr.record_schema = odr_strdup(
1545 assoc->encode, srw_req->record->recordSchema);
1546 if (srw_req->record->recordData_len )
1548 rr.record_data = odr_strdupn(assoc->encode,
1549 srw_req->record->recordData_buf,
1550 srw_req->record->recordData_len );
1554 yaz_add_sru_update_diagnostic(
1555 assoc->encode, &srw_res->diagnostics,
1556 &srw_res->num_diagnostics,
1557 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1561 if (extra && extra->extraRecordData_len)
1563 rr.extra_record_data = odr_strdupn(
1565 extra->extraRecordData_buf,
1566 extra->extraRecordData_len );
1569 else if (!strcmp(rr.operation, "insert"))
1571 if (srw_req->recordId)
1572 rr.record_id = srw_req->recordId;
1574 rr.record_id = extra->recordIdentifier;
1576 if (srw_req->record)
1578 if (srw_req->record->recordSchema)
1579 rr.record_schema = odr_strdup(
1580 assoc->encode, srw_req->record->recordSchema);
1582 if (srw_req->record->recordData_len)
1583 rr.record_data = odr_strdupn(
1585 srw_req->record->recordData_buf,
1586 srw_req->record->recordData_len );
1588 if (extra && extra->extraRecordData_len)
1590 rr.extra_record_data = odr_strdupn(
1592 extra->extraRecordData_buf,
1593 extra->extraRecordData_len );
1597 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1598 &srw_res->num_diagnostics,
1599 YAZ_SRU_UPDATE_INVALID_ACTION,
1602 if (srw_req->record)
1604 const char *pack_str =
1605 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1607 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1610 if (srw_req->num_recordVersions)
1612 rr.record_versions = srw_req->recordVersions;
1613 rr.num_versions = srw_req->num_recordVersions;
1615 if (srw_req->extraRequestData_len)
1617 rr.extra_request_data = odr_strdupn(assoc->encode,
1618 srw_req->extraRequestData_buf,
1619 srw_req->extraRequestData_len );
1621 if (srw_res->num_diagnostics == 0)
1623 if ( assoc->init->bend_srw_update)
1624 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1626 yaz_add_sru_update_diagnostic(
1627 assoc->encode, &srw_res->diagnostics,
1628 &srw_res->num_diagnostics,
1629 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1630 "No Update backend handler");
1634 yaz_add_srw_diagnostic_uri(assoc->encode,
1635 &srw_res->diagnostics,
1636 &srw_res->num_diagnostics,
1640 srw_res->recordId = rr.record_id;
1641 srw_res->operationStatus = rr.operation_status;
1642 srw_res->recordVersions = rr.record_versions;
1643 srw_res->num_recordVersions = rr.num_versions;
1644 if (srw_res->extraResponseData_len)
1646 srw_res->extraResponseData_buf = rr.extra_response_data;
1647 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1649 if (srw_res->num_diagnostics == 0 && rr.record_data)
1651 srw_res->record = yaz_srw_get_record(assoc->encode);
1652 srw_res->record->recordSchema = rr.record_schema;
1653 if (rr.record_packing)
1655 int pack = yaz_srw_str_to_pack(rr.record_packing);
1659 pack = Z_SRW_recordPacking_string;
1660 yaz_log(YLOG_WARN, "Back packing %s from backend",
1663 srw_res->record->recordPacking = pack;
1665 srw_res->record->recordData_buf = rr.record_data;
1666 srw_res->record->recordData_len = strlen(rr.record_data);
1667 if (rr.extra_record_data)
1669 Z_SRW_extra_record *ex =
1670 yaz_srw_get_extra_record(assoc->encode);
1671 srw_res->extra_record = ex;
1672 ex->extraRecordData_buf = rr.extra_record_data;
1673 ex->extraRecordData_len = strlen(rr.extra_record_data);
1679 /* check if path is OK (1); BAD (0) */
1680 static int check_path(const char *path)
1684 if (strstr(path, ".."))
1689 static char *read_file(const char *fname, ODR o, size_t *sz)
1692 FILE *inf = fopen(fname, "rb");
1696 fseek(inf, 0L, SEEK_END);
1699 buf = (char *) odr_malloc(o, *sz);
1700 if (fread(buf, 1, *sz, inf) != *sz)
1701 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1706 static void process_http_request(association *assoc, request *req)
1708 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1709 ODR o = assoc->encode;
1710 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1712 Z_SOAP *soap_package = 0;
1715 Z_HTTP_Response *hres = 0;
1717 const char *stylesheet = 0; /* for now .. set later */
1718 Z_SRW_diagnostic *diagnostic = 0;
1719 int num_diagnostic = 0;
1720 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1722 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1723 if (!control_association(assoc, host, 0))
1725 p = z_get_HTTP_Response(o, 404);
1728 if (r == 2 && assoc->server && assoc->server->docpath
1729 && hreq->path[0] == '/'
1731 /* check if path is a proper prefix of documentroot */
1732 strncmp(hreq->path+1, assoc->server->docpath,
1733 strlen(assoc->server->docpath))
1736 if (!check_path(hreq->path))
1738 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1739 p = z_get_HTTP_Response(o, 404);
1743 size_t content_size = 0;
1744 char *content_buf = read_file(hreq->path+1, o, &content_size);
1747 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1748 p = z_get_HTTP_Response(o, 404);
1752 const char *ctype = 0;
1753 yaz_mime_types types = yaz_mime_types_create();
1755 yaz_mime_types_add(types, "xsl", "application/xml");
1756 yaz_mime_types_add(types, "xml", "application/xml");
1757 yaz_mime_types_add(types, "css", "text/css");
1758 yaz_mime_types_add(types, "html", "text/html");
1759 yaz_mime_types_add(types, "htm", "text/html");
1760 yaz_mime_types_add(types, "txt", "text/plain");
1761 yaz_mime_types_add(types, "js", "application/x-javascript");
1763 yaz_mime_types_add(types, "gif", "image/gif");
1764 yaz_mime_types_add(types, "png", "image/png");
1765 yaz_mime_types_add(types, "jpg", "image/jpeg");
1766 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1768 ctype = yaz_mime_lookup_fname(types, hreq->path);
1771 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1772 p = z_get_HTTP_Response(o, 404);
1776 p = z_get_HTTP_Response(o, 200);
1777 hres = p->u.HTTP_Response;
1778 hres->content_buf = content_buf;
1779 hres->content_len = content_size;
1780 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1782 yaz_mime_types_destroy(types);
1790 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1791 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1793 if (r == 2) /* not taken */
1795 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1796 &diagnostic, &num_diagnostic);
1797 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1799 if (r == 0) /* decode SRW/SRU OK .. */
1801 int http_code = 200;
1802 if (sr->which == Z_SRW_searchRetrieve_request)
1805 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1807 stylesheet = sr->u.request->stylesheet;
1810 res->u.response->diagnostics = diagnostic;
1811 res->u.response->num_diagnostics = num_diagnostic;
1815 srw_bend_search(assoc, sr, res, &http_code);
1817 if (http_code == 200)
1818 soap_package->u.generic->p = res;
1820 else if (sr->which == Z_SRW_explain_request)
1822 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1824 stylesheet = sr->u.explain_request->stylesheet;
1827 res->u.explain_response->diagnostics = diagnostic;
1828 res->u.explain_response->num_diagnostics = num_diagnostic;
1830 srw_bend_explain(assoc, sr, res->u.explain_response, &http_code);
1831 if (http_code == 200)
1832 soap_package->u.generic->p = res;
1834 else if (sr->which == Z_SRW_scan_request)
1836 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1838 stylesheet = sr->u.scan_request->stylesheet;
1841 res->u.scan_response->diagnostics = diagnostic;
1842 res->u.scan_response->num_diagnostics = num_diagnostic;
1844 srw_bend_scan(assoc, sr, res->u.scan_response, &http_code);
1845 if (http_code == 200)
1846 soap_package->u.generic->p = res;
1848 else if (sr->which == Z_SRW_update_request)
1850 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1852 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1855 res->u.update_response->diagnostics = diagnostic;
1856 res->u.update_response->num_diagnostics = num_diagnostic;
1858 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1859 srw_bend_update(assoc, sr, res->u.update_response, &http_code);
1860 if (http_code == 200)
1861 soap_package->u.generic->p = res;
1865 yaz_log(log_request, "SOAP ERROR");
1866 /* FIXME - what error, what query */
1868 z_soap_error(assoc->encode, soap_package,
1869 "SOAP-ENV:Client", "Bad method", 0);
1871 if (http_code == 200 || http_code == 500)
1873 static Z_SOAP_Handler soap_handlers[4] = {
1875 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1876 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1877 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1882 p = z_get_HTTP_Response(o, 200);
1883 hres = p->u.HTTP_Response;
1885 if (!stylesheet && assoc->server)
1886 stylesheet = assoc->server->stylesheet;
1888 /* empty stylesheet means NO stylesheet */
1889 if (stylesheet && *stylesheet == '\0')
1892 z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1893 &hres->content_buf, &hres->content_len,
1894 soap_handlers, charset, stylesheet);
1895 hres->code = http_code;
1897 strcpy(ctype, "text/xml");
1898 if (charset && strlen(charset) < sizeof(ctype)-30)
1900 strcat(ctype, "; charset=");
1901 strcat(ctype, charset);
1903 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1906 p = z_get_HTTP_Response(o, http_code);
1910 p = z_get_HTTP_Response(o, 500);
1911 hres = p->u.HTTP_Response;
1912 if (!strcmp(hreq->version, "1.0"))
1914 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1915 if (v && !strcmp(v, "Keep-Alive"))
1919 hres->version = "1.0";
1923 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1924 if (v && !strcmp(v, "close"))
1928 hres->version = "1.1";
1930 if (!keepalive || !assoc->last_control->keepalive)
1932 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1933 assoc->state = ASSOC_DEAD;
1934 assoc->cs_get_mask = 0;
1939 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1941 if (alive && yaz_isdigit(*(const unsigned char *) alive))
1945 if (t < 0 || t > 3600)
1947 iochan_settimeout(assoc->client_chan,t);
1948 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1950 process_gdu_response(assoc, req, p);
1953 static void process_gdu_request(association *assoc, request *req)
1955 if (req->gdu_request->which == Z_GDU_Z3950)
1958 req->apdu_request = req->gdu_request->u.z3950;
1959 if (process_z_request(assoc, req, &msg) < 0)
1960 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1962 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1963 process_http_request(assoc, req);
1966 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1971 * Initiate request processing.
1973 static int process_z_request(association *assoc, request *req, char **msg)
1978 *msg = "Unknown Error";
1979 assert(req && req->state == REQUEST_IDLE);
1980 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1982 *msg = "Missing InitRequest";
1985 switch (req->apdu_request->which)
1987 case Z_APDU_initRequest:
1988 res = process_initRequest(assoc, req); break;
1989 case Z_APDU_searchRequest:
1990 res = process_searchRequest(assoc, req); break;
1991 case Z_APDU_presentRequest:
1992 res = process_presentRequest(assoc, req); break;
1993 case Z_APDU_scanRequest:
1994 if (assoc->init->bend_scan)
1995 res = process_scanRequest(assoc, req);
1998 *msg = "Cannot handle Scan APDU";
2002 case Z_APDU_extendedServicesRequest:
2003 if (assoc->init->bend_esrequest)
2004 res = process_ESRequest(assoc, req);
2007 *msg = "Cannot handle Extended Services APDU";
2011 case Z_APDU_sortRequest:
2012 if (assoc->init->bend_sort)
2013 res = process_sortRequest(assoc, req);
2016 *msg = "Cannot handle Sort APDU";
2021 process_close(assoc, req);
2023 case Z_APDU_deleteResultSetRequest:
2024 if (assoc->init->bend_delete)
2025 res = process_deleteRequest(assoc, req);
2028 *msg = "Cannot handle Delete APDU";
2032 case Z_APDU_segmentRequest:
2033 if (assoc->init->bend_segment)
2035 res = process_segmentRequest(assoc, req);
2039 *msg = "Cannot handle Segment APDU";
2043 case Z_APDU_triggerResourceControlRequest:
2046 *msg = "Bad APDU received";
2051 yaz_log(YLOG_DEBUG, " result immediately available");
2052 retval = process_z_response(assoc, req, res);
2056 yaz_log(YLOG_DEBUG, " result unavailable");
2063 * Encode response, and transfer the request structure to the outgoing queue.
2065 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2067 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2071 if (!z_GDU(assoc->print, &res, 0, 0))
2072 yaz_log(YLOG_WARN, "ODR print error: %s",
2073 odr_errmsg(odr_geterror(assoc->print)));
2074 odr_reset(assoc->print);
2076 if (!z_GDU(assoc->encode, &res, 0, 0))
2078 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2079 odr_errmsg(odr_geterror(assoc->decode)),
2080 odr_getelement(assoc->decode));
2083 req->response = odr_getbuf(assoc->encode, &req->len_response,
2084 &req->size_response);
2085 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2086 odr_reset(assoc->encode);
2087 req->state = REQUEST_IDLE;
2088 request_enq(&assoc->outgoing, req);
2089 /* turn the work over to the ir_session handler */
2090 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2091 assoc->cs_put_mask = EVENT_OUTPUT;
2092 /* Is there more work to be done? give that to the input handler too */
2095 req = request_head(&assoc->incoming);
2096 if (req && req->state == REQUEST_IDLE)
2098 request_deq(&assoc->incoming);
2099 process_gdu_request(assoc, req);
2108 * Encode response, and transfer the request structure to the outgoing queue.
2110 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2112 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*gres));
2113 gres->which = Z_GDU_Z3950;
2114 gres->u.z3950 = res;
2116 return process_gdu_response(assoc, req, gres);
2119 static char *get_vhost(Z_OtherInformation *otherInfo)
2121 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2125 * Handle init request.
2126 * At the moment, we don't check the options
2127 * anywhere else in the code - we just try not to do anything that would
2128 * break a naive client. We'll toss 'em into the association block when
2129 * we need them there.
2131 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2133 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2134 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2135 Z_InitResponse *resp = apdu->u.initResponse;
2136 bend_initresult *binitres;
2138 statserv_options_block *cb = 0; /* by default no control for backend */
2140 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2141 cb = statserv_getcontrol(); /* got control block for backend */
2143 if (cb && assoc->backend)
2144 (*cb->bend_close)(assoc->backend);
2146 yaz_log(log_requestdetail, "Got initRequest");
2147 if (req->implementationId)
2148 yaz_log(log_requestdetail, "Id: %s",
2149 req->implementationId);
2150 if (req->implementationName)
2151 yaz_log(log_requestdetail, "Name: %s",
2152 req->implementationName);
2153 if (req->implementationVersion)
2154 yaz_log(log_requestdetail, "Version: %s",
2155 req->implementationVersion);
2157 assoc_init_reset(assoc);
2159 assoc->init->auth = req->idAuthentication;
2160 assoc->init->referenceId = req->referenceId;
2162 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2164 Z_CharSetandLanguageNegotiation *negotiation =
2165 yaz_get_charneg_record (req->otherInfo);
2167 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2168 assoc->init->charneg_request = negotiation;
2171 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2172 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2173 assoc->init->named_result_sets = 1;
2178 if (req->implementationVersion)
2179 yaz_log(log_requestdetail, "Config: %s",
2182 iochan_settimeout(assoc->client_chan, cb->idle_timeout);
2184 /* we have a backend control block, so call that init function */
2185 if (!(binitres = (*cb->bend_init)(assoc->init)))
2187 yaz_log(YLOG_WARN, "Bad response from backend.");
2190 assoc->backend = binitres->handle;
2194 /* no backend. return error */
2195 binitres = (bend_initresult *)
2196 odr_malloc(assoc->encode, sizeof(*binitres));
2197 binitres->errstring = 0;
2198 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2199 iochan_settimeout(assoc->client_chan, 10);
2201 if ((assoc->init->bend_sort))
2202 yaz_log(YLOG_DEBUG, "Sort handler installed");
2203 if ((assoc->init->bend_search))
2204 yaz_log(YLOG_DEBUG, "Search handler installed");
2205 if ((assoc->init->bend_present))
2206 yaz_log(YLOG_DEBUG, "Present handler installed");
2207 if ((assoc->init->bend_esrequest))
2208 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2209 if ((assoc->init->bend_delete))
2210 yaz_log(YLOG_DEBUG, "Delete handler installed");
2211 if ((assoc->init->bend_scan))
2212 yaz_log(YLOG_DEBUG, "Scan handler installed");
2213 if ((assoc->init->bend_segment))
2214 yaz_log(YLOG_DEBUG, "Segment handler installed");
2216 resp->referenceId = req->referenceId;
2218 /* let's tell the client what we can do */
2219 if (ODR_MASK_GET(req->options, Z_Options_search))
2221 ODR_MASK_SET(resp->options, Z_Options_search);
2222 strcat(options, "srch");
2224 if (ODR_MASK_GET(req->options, Z_Options_present))
2226 ODR_MASK_SET(resp->options, Z_Options_present);
2227 strcat(options, " prst");
2229 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2230 assoc->init->bend_delete)
2232 ODR_MASK_SET(resp->options, Z_Options_delSet);
2233 strcat(options, " del");
2235 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2236 assoc->init->bend_esrequest)
2238 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2239 strcat(options, " extendedServices");
2241 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2242 && assoc->init->named_result_sets)
2244 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2245 strcat(options, " namedresults");
2247 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2249 ODR_MASK_SET(resp->options, Z_Options_scan);
2250 strcat(options, " scan");
2252 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2254 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2255 strcat(options, " concurrop");
2257 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2259 ODR_MASK_SET(resp->options, Z_Options_sort);
2260 strcat(options, " sort");
2263 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2265 Z_OtherInformationUnit *p0;
2267 if (!assoc->init->charneg_response)
2269 if (assoc->init->query_charset)
2271 assoc->init->charneg_response = yaz_set_response_charneg(
2272 assoc->encode, assoc->init->query_charset, 0,
2273 assoc->init->records_in_same_charset);
2277 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2280 if (assoc->init->charneg_response
2281 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2283 p0->which = Z_OtherInfo_externallyDefinedInfo;
2284 p0->information.externallyDefinedInfo =
2285 assoc->init->charneg_response;
2286 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2287 strcat(options, " negotiation");
2290 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2291 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2293 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2295 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2296 assoc->version = 1; /* 1 & 2 are equivalent */
2298 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2300 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2303 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2305 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2309 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2311 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2312 assoc->maximumRecordSize = odr_int_to_int(*req->maximumRecordSize);
2314 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2315 assoc->preferredMessageSize = odr_int_to_int(*req->preferredMessageSize);
2317 resp->preferredMessageSize =
2318 odr_intdup(assoc->encode, assoc->preferredMessageSize);
2319 resp->maximumRecordSize =
2320 odr_intdup(assoc->encode, assoc->maximumRecordSize);
2322 resp->implementationId = odr_prepend(assoc->encode,
2323 assoc->init->implementation_id,
2324 resp->implementationId);
2326 resp->implementationName = odr_prepend(assoc->encode,
2327 assoc->init->implementation_name,
2328 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2330 if (binitres->errcode)
2332 assoc->state = ASSOC_DEAD;
2333 resp->userInformationField =
2334 init_diagnostics(assoc->encode, binitres->errcode,
2335 binitres->errstring);
2339 assoc->state = ASSOC_UP;
2343 if (!req->idAuthentication)
2344 yaz_log(log_request, "Auth none");
2345 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2347 const char *open = req->idAuthentication->u.open;
2348 const char *slash = strchr(open, '/');
2354 yaz_log(log_request, "Auth open %.*s", len, open);
2356 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2358 const char *user = req->idAuthentication->u.idPass->userId;
2359 const char *group = req->idAuthentication->u.idPass->groupId;
2360 yaz_log(log_request, "Auth idPass %s %s",
2361 user ? user : "-", group ? group : "-");
2363 else if (req->idAuthentication->which
2364 == Z_IdAuthentication_anonymous)
2366 yaz_log(log_request, "Auth anonymous");
2370 yaz_log(log_request, "Auth other");
2375 WRBUF wr = wrbuf_alloc();
2376 wrbuf_printf(wr, "Init ");
2377 if (binitres->errcode)
2378 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2380 wrbuf_printf(wr, "OK -");
2381 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2382 (req->implementationId ? req->implementationId :"-"),
2383 (req->implementationName ?
2384 req->implementationName : "-"),
2385 (req->implementationVersion ?
2386 req->implementationVersion : "-")
2388 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2395 * Set the specified `errcode' and `errstring' into a UserInfo-1
2396 * external to be returned to the client in accordance with Z35.90
2397 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2398 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2400 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2402 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2403 addinfo ? " -- " : "", addinfo ? addinfo : "");
2404 return zget_init_diagnostics(odr, error, addinfo);
2408 * nonsurrogate diagnostic record.
2410 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2412 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2414 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2415 addinfo ? " -- " : "", addinfo ? addinfo : "");
2417 rec->which = Z_Records_NSD;
2418 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2424 * surrogate diagnostic.
2426 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2428 int error, const char *addinfo)
2430 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2431 addinfo ? " -- " : "", addinfo ? addinfo : "");
2432 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2435 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2436 Odr_int *num, Z_RecordComposition *comp,
2437 Odr_int *next, Odr_int *pres,
2438 Z_ReferenceId *referenceId,
2439 Odr_oid *oid, int *errcode)
2441 int recno, total_length = 0, dumped_records = 0;
2442 int toget = odr_int_to_int(*num);
2443 Z_Records *records =
2444 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2445 Z_NamePlusRecordList *reclist =
2446 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2448 records->which = Z_Records_DBOSD;
2449 records->u.databaseOrSurDiagnostics = reclist;
2450 reclist->num_records = 0;
2453 return diagrec(a, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, 0);
2454 else if (toget == 0)
2455 reclist->records = odr_nullval();
2457 reclist->records = (Z_NamePlusRecord **)
2458 odr_malloc(a->encode, sizeof(*reclist->records) * toget);
2460 *pres = Z_PresentStatus_success;
2464 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2465 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2466 a->maximumRecordSize);
2467 for (recno = odr_int_to_int(start); reclist->num_records < toget; recno++)
2470 Z_NamePlusRecord *thisrec;
2471 int this_length = 0;
2473 * we get the number of bytes allocated on the stream before any
2474 * allocation done by the backend - this should give us a reasonable
2475 * idea of the total size of the data so far.
2477 total_length = odr_total(a->encode) - dumped_records;
2483 freq.last_in_set = 0;
2484 freq.setname = setname;
2485 freq.surrogate_flag = 0;
2486 freq.number = recno;
2488 freq.request_format = oid;
2489 freq.output_format = 0;
2490 freq.stream = a->encode;
2491 freq.print = a->print;
2492 freq.referenceId = referenceId;
2495 retrieve_fetch(a, &freq);
2497 *next = freq.last_in_set ? 0 : recno + 1;
2501 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2504 *pres = Z_PresentStatus_failure;
2505 /* for 'present request out of range',
2506 set addinfo to record position if not set */
2507 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2508 freq.errstring == 0)
2510 sprintf(s, "%d", recno);
2514 *errcode = freq.errcode;
2515 return diagrec(a, freq.errcode, freq.errstring);
2517 reclist->records[reclist->num_records] =
2518 surrogatediagrec(a, freq.basename, freq.errcode,
2520 reclist->num_records++;
2523 if (freq.record == 0) /* no error and no record ? */
2525 *pres = Z_PresentStatus_partial_4;
2526 *next = 0; /* signal end-of-set and stop */
2530 this_length = freq.len;
2532 this_length = odr_total(a->encode) - total_length - dumped_records;
2533 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2534 this_length, total_length, dumped_records);
2535 if (a->preferredMessageSize > 0 &&
2536 this_length + total_length > a->preferredMessageSize)
2538 /* record is small enough, really */
2539 if (this_length <= a->preferredMessageSize && recno > start)
2541 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2542 *pres = Z_PresentStatus_partial_2;
2547 /* record can only be fetched by itself */
2548 if (this_length < a->maximumRecordSize)
2550 yaz_log(log_requestdetail, " Record > prefmsgsz");
2553 yaz_log(YLOG_DEBUG, " Dropped it");
2554 reclist->records[reclist->num_records] =
2557 YAZ_BIB1_RECORD_EXCEEDS_PREFERRED_MESSAGE_SIZE, 0);
2558 reclist->num_records++;
2559 dumped_records += this_length;
2563 else /* too big entirely */
2565 yaz_log(log_requestdetail, "Record > maxrcdsz "
2567 this_length, a->maximumRecordSize);
2568 reclist->records[reclist->num_records] =
2571 YAZ_BIB1_RECORD_EXCEEDS_MAXIMUM_RECORD_SIZE, 0);
2572 reclist->num_records++;
2573 dumped_records += this_length;
2578 if (!(thisrec = (Z_NamePlusRecord *)
2579 odr_malloc(a->encode, sizeof(*thisrec))))
2581 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2582 thisrec->which = Z_NamePlusRecord_databaseRecord;
2584 if (!freq.output_format)
2586 yaz_log(YLOG_WARN, "bend_fetch output_format not set");
2589 thisrec->u.databaseRecord = z_ext_record_oid(
2590 a->encode, freq.output_format, freq.record, freq.len);
2591 if (!thisrec->u.databaseRecord)
2593 reclist->records[reclist->num_records] = thisrec;
2594 reclist->num_records++;
2596 *num = reclist->num_records;
2600 static Z_APDU *process_searchRequest(association *assoc, request *reqb)
2602 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2603 bend_search_rr *bsrr =
2604 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2606 yaz_log(log_requestdetail, "Got SearchRequest.");
2607 bsrr->association = assoc;
2608 bsrr->referenceId = req->referenceId;
2609 bsrr->srw_sortKeys = 0;
2610 bsrr->srw_setname = 0;
2611 bsrr->srw_setnameIdleTime = 0;
2612 bsrr->estimated_hit_count = 0;
2613 bsrr->partial_resultset = 0;
2614 bsrr->extra_args = 0;
2615 bsrr->extra_response_data = 0;
2617 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2618 if (req->databaseNames)
2621 for (i = 0; i < req->num_databaseNames; i++)
2622 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2625 yaz_log_zquery_level(log_requestdetail,req->query);
2627 if (assoc->init->bend_search)
2629 bsrr->setname = req->resultSetName;
2630 bsrr->replace_set = *req->replaceIndicator;
2631 bsrr->num_bases = req->num_databaseNames;
2632 bsrr->basenames = req->databaseNames;
2633 bsrr->query = req->query;
2634 bsrr->stream = assoc->encode;
2635 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2636 bsrr->decode = assoc->decode;
2637 bsrr->print = assoc->print;
2640 bsrr->errstring = NULL;
2641 bsrr->search_info = NULL;
2642 bsrr->search_input = req->otherInfo;
2644 if (assoc->server && assoc->server->cql_transform
2645 && req->query->which == Z_Query_type_104
2646 && req->query->u.type_104->which == Z_External_CQL)
2648 /* have a CQL query and a CQL to PQF transform .. */
2650 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2651 assoc->server->cql_transform, bsrr->query,
2652 &bsrr->srw_sortKeys);
2654 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2657 if (assoc->server && assoc->server->ccl_transform
2658 && req->query->which == Z_Query_type_2) /*CCL*/
2660 /* have a CCL query and a CCL to PQF transform .. */
2662 ccl2pqf(bsrr->stream, req->query->u.type_2,
2663 assoc->server->ccl_transform, bsrr);
2665 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2669 (assoc->init->bend_search)(assoc->backend, bsrr);
2673 /* FIXME - make a diagnostic for it */
2674 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2676 return response_searchRequest(assoc, reqb, bsrr);
2680 * Prepare a searchresponse based on the backend results. We probably want
2681 * to look at making the fetching of records nonblocking as well, but
2682 * so far, we'll keep things simple.
2683 * If bsrt is null, that means we're called in response to a communications
2684 * event, and we'll have to get the response for ourselves.
2686 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2687 bend_search_rr *bsrt)
2689 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2690 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2691 Z_SearchResponse *resp = (Z_SearchResponse *)
2692 odr_malloc(assoc->encode, sizeof(*resp));
2693 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2694 Odr_int *next = odr_intdup(assoc->encode, 0);
2695 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2696 Odr_int returnedrecs = 0;
2698 apdu->which = Z_APDU_searchResponse;
2699 apdu->u.searchResponse = resp;
2700 resp->referenceId = req->referenceId;
2701 resp->additionalSearchInfo = 0;
2702 resp->otherInfo = 0;
2705 yaz_log(YLOG_FATAL, "Bad result from backend");
2708 else if (bsrt->errcode)
2710 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2711 resp->resultCount = nulint;
2712 resp->numberOfRecordsReturned = nulint;
2713 resp->nextResultSetPosition = nulint;
2714 resp->searchStatus = odr_booldup(assoc->encode, 0);
2715 resp->resultSetStatus = none;
2716 resp->presentStatus = 0;
2720 bool_t *sr = odr_booldup(assoc->encode, 1);
2721 Odr_int *toget = odr_intdup(assoc->encode, 0);
2722 Z_RecordComposition comp, *compp = 0;
2724 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2727 resp->resultCount = &bsrt->hits;
2729 comp.which = Z_RecordComp_simple;
2730 /* how many records does the user agent want, then? */
2733 else if (bsrt->hits <= *req->smallSetUpperBound)
2735 *toget = bsrt->hits;
2736 if ((comp.u.simple = req->smallSetElementSetNames))
2739 else if (bsrt->hits < *req->largeSetLowerBound)
2741 *toget = *req->mediumSetPresentNumber;
2742 if (*toget > bsrt->hits)
2743 *toget = bsrt->hits;
2744 if ((comp.u.simple = req->mediumSetElementSetNames))
2750 if (*toget && !resp->records)
2752 Odr_int *presst = odr_intdup(assoc->encode, 0);
2753 /* Call bend_present if defined */
2754 if (assoc->init->bend_present)
2756 bend_present_rr *bprr = (bend_present_rr *)
2757 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2758 bprr->setname = req->resultSetName;
2760 bprr->number = odr_int_to_int(*toget);
2761 bprr->format = req->preferredRecordSyntax;
2763 bprr->referenceId = req->referenceId;
2764 bprr->stream = assoc->encode;
2765 bprr->print = assoc->print;
2766 bprr->association = assoc;
2768 bprr->errstring = NULL;
2769 (*assoc->init->bend_present)(assoc->backend, bprr);
2773 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2774 *resp->presentStatus = Z_PresentStatus_failure;
2779 resp->records = pack_records(
2780 assoc, req->resultSetName, 1,
2781 toget, compp, next, presst, req->referenceId,
2782 req->preferredRecordSyntax, NULL);
2785 resp->numberOfRecordsReturned = toget;
2786 returnedrecs = *toget;
2787 resp->presentStatus = presst;
2791 if (*resp->resultCount)
2793 resp->numberOfRecordsReturned = nulint;
2794 resp->presentStatus = 0;
2796 resp->nextResultSetPosition = next;
2797 resp->searchStatus = sr;
2798 resp->resultSetStatus = 0;
2799 if (bsrt->estimated_hit_count)
2801 resp->resultSetStatus = odr_intdup(assoc->encode,
2802 Z_SearchResponse_estimate);
2804 else if (bsrt->partial_resultset)
2806 resp->resultSetStatus = odr_intdup(assoc->encode,
2807 Z_SearchResponse_subset);
2810 resp->additionalSearchInfo = bsrt->search_info;
2815 WRBUF wr = wrbuf_alloc();
2817 for (i = 0 ; i < req->num_databaseNames; i++)
2820 wrbuf_printf(wr, "+");
2821 wrbuf_puts(wr, req->databaseNames[i]);
2823 wrbuf_printf(wr, " ");
2826 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2828 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2829 wrbuf_printf(wr, " %s 1+" ODR_INT_PRINTF " ",
2830 req->resultSetName, returnedrecs);
2831 yaz_query_to_wrbuf(wr, req->query);
2833 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2840 * Maybe we got a little over-friendly when we designed bend_fetch to
2841 * get only one record at a time. Some backends can optimise multiple-record
2842 * fetches, and at any rate, there is some overhead involved in
2843 * all that selecting and hopping around. Problem is, of course, that the
2844 * frontend can't know ahead of time how many records it'll need to
2845 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2846 * is downright lousy as a bulk data transfer protocol.
2848 * To start with, we'll do the fetching of records from the backend
2849 * in one operation: To save some trips in and out of the event-handler,
2850 * and to simplify the interface to pack_records. At any rate, asynch
2851 * operation is more fun in operations that have an unpredictable execution
2852 * speed - which is normally more true for search than for present.
2854 static Z_APDU *process_presentRequest(association *assoc, request *reqb)
2856 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2858 Z_PresentResponse *resp;
2863 yaz_log(log_requestdetail, "Got PresentRequest.");
2865 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2867 resp->presentStatus = odr_intdup(assoc->encode, 0);
2868 if (assoc->init->bend_present)
2870 bend_present_rr *bprr = (bend_present_rr *)
2871 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2872 bprr->setname = req->resultSetId;
2873 bprr->start = odr_int_to_int(*req->resultSetStartPoint);
2874 bprr->number = odr_int_to_int(*req->numberOfRecordsRequested);
2875 bprr->format = req->preferredRecordSyntax;
2876 bprr->comp = req->recordComposition;
2877 bprr->referenceId = req->referenceId;
2878 bprr->stream = assoc->encode;
2879 bprr->print = assoc->print;
2880 bprr->association = assoc;
2882 bprr->errstring = NULL;
2883 (*assoc->init->bend_present)(assoc->backend, bprr);
2887 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2888 *resp->presentStatus = Z_PresentStatus_failure;
2889 errcode = bprr->errcode;
2892 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2893 next = odr_intdup(assoc->encode, 0);
2894 num = odr_intdup(assoc->encode, 0);
2896 apdu->which = Z_APDU_presentResponse;
2897 apdu->u.presentResponse = resp;
2898 resp->referenceId = req->referenceId;
2899 resp->otherInfo = 0;
2903 *num = *req->numberOfRecordsRequested;
2905 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2906 num, req->recordComposition, next,
2907 resp->presentStatus,
2908 req->referenceId, req->preferredRecordSyntax,
2913 WRBUF wr = wrbuf_alloc();
2914 wrbuf_printf(wr, "Present ");
2916 if (*resp->presentStatus == Z_PresentStatus_failure)
2917 wrbuf_printf(wr, "ERROR %d ", errcode);
2918 else if (*resp->presentStatus == Z_PresentStatus_success)
2919 wrbuf_printf(wr, "OK - ");
2921 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2922 *resp->presentStatus);
2924 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2925 req->resultSetId, *req->resultSetStartPoint,
2926 *req->numberOfRecordsRequested);
2927 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2932 resp->numberOfRecordsReturned = num;
2933 resp->nextResultSetPosition = next;
2939 * Scan was implemented rather in a hurry, and with support for only the basic
2940 * elements of the service in the backend API. Suggestions are welcome.
2942 static Z_APDU *process_scanRequest(association *assoc, request *reqb)
2944 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2945 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2946 Z_ScanResponse *res = (Z_ScanResponse *)
2947 odr_malloc(assoc->encode, sizeof(*res));
2948 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2949 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2950 Z_ListEntries *ents = (Z_ListEntries *)
2951 odr_malloc(assoc->encode, sizeof(*ents));
2952 Z_DiagRecs *diagrecs_p = NULL;
2953 bend_scan_rr *bsrr = (bend_scan_rr *)
2954 odr_malloc(assoc->encode, sizeof(*bsrr));
2955 struct scan_entry *save_entries;
2958 yaz_log(log_requestdetail, "Got ScanRequest");
2960 apdu->which = Z_APDU_scanResponse;
2961 apdu->u.scanResponse = res;
2962 res->referenceId = req->referenceId;
2964 /* if step is absent, set it to 0 */
2966 step_size = odr_int_to_int(*req->stepSize);
2969 res->scanStatus = scanStatus;
2970 res->numberOfEntriesReturned = numberOfEntriesReturned;
2971 res->positionOfTerm = 0;
2972 res->entries = ents;
2973 ents->num_entries = 0;
2974 ents->entries = NULL;
2975 ents->num_nonsurrogateDiagnostics = 0;
2976 ents->nonsurrogateDiagnostics = NULL;
2977 res->attributeSet = 0;
2980 if (req->databaseNames)
2983 for (i = 0; i < req->num_databaseNames; i++)
2984 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2986 bsrr->scanClause = 0;
2988 bsrr->errstring = 0;
2989 bsrr->num_bases = req->num_databaseNames;
2990 bsrr->basenames = req->databaseNames;
2991 bsrr->num_entries = odr_int_to_int(*req->numberOfTermsRequested);
2992 bsrr->term = req->termListAndStartPoint;
2993 bsrr->referenceId = req->referenceId;
2994 bsrr->stream = assoc->encode;
2995 bsrr->print = assoc->print;
2996 bsrr->step_size = &step_size;
2997 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
2998 yaz_oid_userinfo_scan_set, 1, 0);
3000 /* For YAZ 2.0 and earlier it was the backend handler that
3001 initialized entries (member display_term did not exist)
3002 YAZ 2.0 and later sets 'entries' and initialize all members
3003 including 'display_term'. If YAZ 2.0 or later sees that
3004 entries was modified - we assume that it is an old handler and
3005 that 'display_term' is _not_ set.
3007 if (bsrr->num_entries > 0)
3010 bsrr->entries = (struct scan_entry *)
3011 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3013 for (i = 0; i<bsrr->num_entries; i++)
3015 bsrr->entries[i].term = 0;
3016 bsrr->entries[i].occurrences = 0;
3017 bsrr->entries[i].errcode = 0;
3018 bsrr->entries[i].errstring = 0;
3019 bsrr->entries[i].display_term = 0;
3022 save_entries = bsrr->entries; /* save it so we can compare later */
3024 bsrr->attributeset = req->attributeSet;
3025 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3026 bsrr->attributeset);
3027 bsrr->term_position = req->preferredPositionInResponse ?
3028 odr_int_to_int(*req->preferredPositionInResponse) : 1;
3030 ((int (*)(void *, bend_scan_rr *))
3031 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3034 diagrecs_p = zget_DiagRecs(assoc->encode,
3035 bsrr->errcode, bsrr->errstring);
3039 Z_Entry **tab = (Z_Entry **)
3040 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3042 if (bsrr->status == BEND_SCAN_PARTIAL)
3043 *scanStatus = Z_Scan_partial_5;
3045 *scanStatus = Z_Scan_success;
3046 res->stepSize = odr_intdup(assoc->encode, step_size);
3047 ents->entries = tab;
3048 ents->num_entries = bsrr->num_entries;
3049 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3051 res->positionOfTerm = odr_intdup(assoc->encode, bsrr->term_position);
3052 for (i = 0; i < bsrr->num_entries; i++)
3058 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3059 if (bsrr->entries[i].occurrences >= 0)
3061 e->which = Z_Entry_termInfo;
3062 e->u.termInfo = t = (Z_TermInfo *)
3063 odr_malloc(assoc->encode, sizeof(*t));
3064 t->suggestedAttributes = 0;
3066 if (save_entries == bsrr->entries &&
3067 bsrr->entries[i].display_term)
3069 /* the entries was _not_ set by the handler. So it's
3070 safe to test for new member display_term. It is
3073 t->displayTerm = odr_strdup(assoc->encode,
3074 bsrr->entries[i].display_term);
3076 t->alternativeTerm = 0;
3077 t->byAttributes = 0;
3078 t->otherTermInfo = 0;
3079 t->globalOccurrences = &bsrr->entries[i].occurrences;
3080 t->term = (Z_Term *)
3081 odr_malloc(assoc->encode, sizeof(*t->term));
3082 t->term->which = Z_Term_general;
3083 t->term->u.general = o =
3084 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3085 o->buf = (unsigned char *)
3086 odr_malloc(assoc->encode, o->len = o->size =
3087 strlen(bsrr->entries[i].term));
3088 memcpy(o->buf, bsrr->entries[i].term, o->len);
3089 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3090 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3094 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3095 bsrr->entries[i].errcode,
3096 bsrr->entries[i].errstring);
3097 assert(drecs->num_diagRecs == 1);
3098 e->which = Z_Entry_surrogateDiagnostic;
3099 assert(drecs->diagRecs[0]);
3100 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3106 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3107 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3112 WRBUF wr = wrbuf_alloc();
3113 wrbuf_printf(wr, "Scan ");
3114 for (i = 0 ; i < req->num_databaseNames; i++)
3117 wrbuf_printf(wr, "+");
3118 wrbuf_puts(wr, req->databaseNames[i]);
3121 wrbuf_printf(wr, " ");
3124 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3126 wrbuf_printf(wr, "OK");
3128 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3129 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3130 res->numberOfEntriesReturned ?
3131 *res->numberOfEntriesReturned : 0,
3132 (req->preferredPositionInResponse ?
3133 *req->preferredPositionInResponse : 1),
3134 *req->numberOfTermsRequested,
3135 (res->stepSize ? *res->stepSize : 1));
3138 wrbuf_printf(wr, "+%s", bsrr->setname);
3140 wrbuf_printf(wr, " ");
3141 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3142 bsrr->attributeset);
3143 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3149 static Z_APDU *process_sortRequest(association *assoc, request *reqb)
3152 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3153 Z_SortResponse *res = (Z_SortResponse *)
3154 odr_malloc(assoc->encode, sizeof(*res));
3155 bend_sort_rr *bsrr = (bend_sort_rr *)
3156 odr_malloc(assoc->encode, sizeof(*bsrr));
3158 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3160 yaz_log(log_requestdetail, "Got SortRequest.");
3162 bsrr->num_input_setnames = req->num_inputResultSetNames;
3163 for (i=0;i<req->num_inputResultSetNames;i++)
3164 yaz_log(log_requestdetail, "Input resultset: '%s'",
3165 req->inputResultSetNames[i]);
3166 bsrr->input_setnames = req->inputResultSetNames;
3167 bsrr->referenceId = req->referenceId;
3168 bsrr->output_setname = req->sortedResultSetName;
3169 yaz_log(log_requestdetail, "Output resultset: '%s'",
3170 req->sortedResultSetName);
3171 bsrr->sort_sequence = req->sortSequence;
3172 /*FIXME - dump those sequences too */
3173 bsrr->stream = assoc->encode;
3174 bsrr->print = assoc->print;
3176 bsrr->sort_status = Z_SortResponse_failure;
3178 bsrr->errstring = 0;
3180 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3182 res->referenceId = bsrr->referenceId;
3183 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3184 res->resultSetStatus = 0;
3187 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3188 bsrr->errcode, bsrr->errstring);
3189 res->diagnostics = dr->diagRecs;
3190 res->num_diagnostics = dr->num_diagRecs;
3194 res->num_diagnostics = 0;
3195 res->diagnostics = 0;
3197 res->resultCount = 0;
3200 apdu->which = Z_APDU_sortResponse;
3201 apdu->u.sortResponse = res;
3204 WRBUF wr = wrbuf_alloc();
3205 wrbuf_printf(wr, "Sort ");
3207 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3209 wrbuf_printf(wr, "OK -");
3210 wrbuf_printf(wr, " (");
3211 for (i = 0; i<req->num_inputResultSetNames; i++)
3214 wrbuf_printf(wr, "+");
3215 wrbuf_puts(wr, req->inputResultSetNames[i]);
3217 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3219 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3225 static Z_APDU *process_deleteRequest(association *assoc, request *reqb)
3228 Z_DeleteResultSetRequest *req =
3229 reqb->apdu_request->u.deleteResultSetRequest;
3230 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3231 odr_malloc(assoc->encode, sizeof(*res));
3232 bend_delete_rr *bdrr = (bend_delete_rr *)
3233 odr_malloc(assoc->encode, sizeof(*bdrr));
3234 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3236 yaz_log(log_requestdetail, "Got DeleteRequest.");
3238 bdrr->num_setnames = req->num_resultSetList;
3239 bdrr->setnames = req->resultSetList;
3240 for (i = 0; i<req->num_resultSetList; i++)
3241 yaz_log(log_requestdetail, "resultset: '%s'",
3242 req->resultSetList[i]);
3243 bdrr->stream = assoc->encode;
3244 bdrr->print = assoc->print;
3245 bdrr->function = odr_int_to_int(*req->deleteFunction);
3246 bdrr->referenceId = req->referenceId;
3248 if (bdrr->num_setnames > 0)
3250 bdrr->statuses = (int*)
3251 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3252 bdrr->num_setnames);
3253 for (i = 0; i < bdrr->num_setnames; i++)
3254 bdrr->statuses[i] = 0;
3256 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3258 res->referenceId = req->referenceId;
3260 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3262 res->deleteListStatuses = 0;
3263 if (bdrr->num_setnames > 0)
3266 res->deleteListStatuses = (Z_ListStatuses *)
3267 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3268 res->deleteListStatuses->num = bdrr->num_setnames;
3269 res->deleteListStatuses->elements =
3271 odr_malloc(assoc->encode,
3272 sizeof(*res->deleteListStatuses->elements) *
3273 bdrr->num_setnames);
3274 for (i = 0; i<bdrr->num_setnames; i++)
3276 res->deleteListStatuses->elements[i] =
3278 odr_malloc(assoc->encode,
3279 sizeof(**res->deleteListStatuses->elements));
3280 res->deleteListStatuses->elements[i]->status =
3281 odr_intdup(assoc->encode, bdrr->statuses[i]);
3282 res->deleteListStatuses->elements[i]->id =
3283 odr_strdup(assoc->encode, bdrr->setnames[i]);
3286 res->numberNotDeleted = 0;
3287 res->bulkStatuses = 0;
3288 res->deleteMessage = 0;
3291 apdu->which = Z_APDU_deleteResultSetResponse;
3292 apdu->u.deleteResultSetResponse = res;
3295 WRBUF wr = wrbuf_alloc();
3296 wrbuf_printf(wr, "Delete ");
3297 if (bdrr->delete_status)
3298 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3300 wrbuf_printf(wr, "OK -");
3301 for (i = 0; i<req->num_resultSetList; i++)
3302 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3303 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3309 static void process_close(association *assoc, request *reqb)
3311 Z_Close *req = reqb->apdu_request->u.close;
3312 static char *reasons[] =
3319 "securityViolation",
3326 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3327 reasons[*req->closeReason], req->diagnosticInformation ?
3328 req->diagnosticInformation : "NULL");
3329 if (assoc->version < 3) /* to make do_force respond with close */
3331 do_close_req(assoc, Z_Close_finished,
3332 "Association terminated by client", reqb);
3333 yaz_log(log_request,"Close OK");
3336 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3338 bend_segment_rr req;
3340 req.segment = reqb->apdu_request->u.segmentRequest;
3341 req.stream = assoc->encode;
3342 req.decode = assoc->decode;
3343 req.print = assoc->print;
3344 req.association = assoc;
3346 (*assoc->init->bend_segment)(assoc->backend, &req);
3351 static Z_APDU *process_ESRequest(association *assoc, request *reqb)
3353 bend_esrequest_rr esrequest;
3354 const char *ext_name = "unknown";
3356 Z_ExtendedServicesRequest *req =
3357 reqb->apdu_request->u.extendedServicesRequest;
3358 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3360 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3362 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3363 esrequest.stream = assoc->encode;
3364 esrequest.decode = assoc->decode;
3365 esrequest.print = assoc->print;
3366 esrequest.errcode = 0;
3367 esrequest.errstring = NULL;
3368 esrequest.association = assoc;
3369 esrequest.taskPackage = 0;
3370 esrequest.referenceId = req->referenceId;
3372 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3374 switch(esrequest.esr->taskSpecificParameters->which)
3376 case Z_External_itemOrder:
3377 ext_name = "ItemOrder"; break;
3378 case Z_External_update:
3379 ext_name = "Update"; break;
3380 case Z_External_update0:
3381 ext_name = "Update0"; break;
3382 case Z_External_ESAdmin:
3383 ext_name = "Admin"; break;
3388 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3390 resp->referenceId = req->referenceId;
3392 if (esrequest.errcode == -1)
3394 /* Backend service indicates request will be processed */
3395 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3396 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3398 else if (esrequest.errcode == 0)
3400 /* Backend service indicates request will be processed */
3401 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3402 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3406 Z_DiagRecs *diagRecs =
3407 zget_DiagRecs(assoc->encode, esrequest.errcode,
3408 esrequest.errstring);
3409 /* Backend indicates error, request will not be processed */
3410 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3411 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3412 resp->num_diagnostics = diagRecs->num_diagRecs;
3413 resp->diagnostics = diagRecs->diagRecs;
3416 WRBUF wr = wrbuf_alloc();
3417 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3418 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3423 /* Do something with the members of bend_extendedservice */
3424 if (esrequest.taskPackage)
3426 resp->taskPackage = z_ext_record_oid(
3427 assoc->encode, yaz_oid_recsyn_extended,
3428 (const char *) esrequest.taskPackage, -1);
3430 yaz_log(YLOG_DEBUG,"Send the result apdu");
3434 int bend_assoc_is_alive(bend_association assoc)
3436 if (assoc->state == ASSOC_DEAD)
3437 return 0; /* already marked as dead. Don't check I/O chan anymore */
3439 return iochan_is_alive(assoc->client_chan);
3446 * c-file-style: "Stroustrup"
3447 * indent-tabs-mode: nil
3449 * vim: shiftwidth=4 tabstop=8 expandtab