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.
39 #include <sys/types.h>
47 #define S_ISREG(x) (x & _S_IFREG)
56 #include <libxml/parser.h>
57 #include <libxml/tree.h>
60 #include <yaz/yconfig.h>
61 #include <yaz/xmalloc.h>
62 #include <yaz/comstack.h>
66 #include <yaz/proto.h>
67 #include <yaz/oid_db.h>
69 #include <yaz/logrpn.h>
70 #include <yaz/querytowrbuf.h>
71 #include <yaz/statserv.h>
72 #include <yaz/diagbib1.h>
73 #include <yaz/charneg.h>
74 #include <yaz/otherinfo.h>
75 #include <yaz/yaz-util.h>
76 #include <yaz/pquery.h>
77 #include <yaz/oid_db.h>
80 #include <yaz/backend.h>
81 #include <yaz/yaz-ccl.h>
83 static void process_gdu_request(association *assoc, request *req);
84 static int process_z_request(association *assoc, request *req, char **msg);
85 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
86 static int process_z_response(association *assoc, request *req, Z_APDU *res);
87 static Z_APDU *process_initRequest(association *assoc, request *reqb);
88 static Z_External *init_diagnostics(ODR odr, int errcode,
89 const char *errstring);
90 static Z_APDU *process_searchRequest(association *assoc, request *reqb);
91 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
92 bend_search_rr *bsrr);
93 static Z_APDU *process_presentRequest(association *assoc, request *reqb);
94 static Z_APDU *process_scanRequest(association *assoc, request *reqb);
95 static Z_APDU *process_sortRequest(association *assoc, request *reqb);
96 static void process_close(association *assoc, request *reqb);
97 static Z_APDU *process_deleteRequest(association *assoc, request *reqb);
98 static Z_APDU *process_segmentRequest(association *assoc, request *reqb);
99 static Z_APDU *process_ESRequest(association *assoc, request *reqb);
101 /* dynamic logging levels */
102 static int logbits_set = 0;
103 static int log_session = 0; /* one-line logs for session */
104 static int log_sessiondetail = 0; /* more detailed stuff */
105 static int log_request = 0; /* one-line logs for requests */
106 static int log_requestdetail = 0; /* more detailed stuff */
108 /** get_logbits sets global loglevel bits */
109 static void get_logbits(void)
110 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
114 log_session = yaz_log_module_level("session");
115 log_sessiondetail = yaz_log_module_level("sessiondetail");
116 log_request = yaz_log_module_level("request");
117 log_requestdetail = yaz_log_module_level("requestdetail");
121 static void wr_diag(WRBUF w, int error, const char *addinfo)
123 wrbuf_printf(w, "ERROR %d+", error);
124 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
128 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
133 static int odr_int_to_int(Odr_int v)
137 else if (v <= INT_MIN)
144 * Create and initialize a new association-handle.
145 * channel : iochannel for the current line.
146 * link : communications channel.
147 * Returns: 0 or a new association handle.
149 association *create_association(IOCHAN channel, COMSTACK link,
150 const char *apdufile)
156 if (!(anew = (association *)xmalloc(sizeof(*anew))))
160 anew->last_control = 0;
161 anew->client_chan = channel;
162 anew->client_link = link;
163 anew->cs_get_mask = 0;
164 anew->cs_put_mask = 0;
165 anew->cs_accept_mask = 0;
166 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
167 !(anew->encode = odr_createmem(ODR_ENCODE)))
169 if (apdufile && *apdufile)
173 if (!(anew->print = odr_createmem(ODR_PRINT)))
175 if (*apdufile == '@')
177 odr_setprint(anew->print, yaz_log_file());
179 else if (*apdufile != '-')
182 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
183 if (!(f = fopen(filename, "w")))
185 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
188 setvbuf(f, 0, _IONBF, 0);
189 odr_setprint(anew->print, f);
194 anew->input_buffer = 0;
195 anew->input_buffer_len = 0;
197 anew->state = ASSOC_NEW;
198 request_initq(&anew->incoming);
199 request_initq(&anew->outgoing);
200 anew->proto = cs_getproto(link);
206 * Free association and release resources.
208 void destroy_association(association *h)
210 statserv_options_block *cb = statserv_getcontrol();
214 odr_destroy(h->decode);
215 odr_destroy(h->encode);
217 odr_destroy(h->print);
219 xfree(h->input_buffer);
221 (*cb->bend_close)(h->backend);
222 while ((req = request_deq(&h->incoming)))
223 request_release(req);
224 while ((req = request_deq(&h->outgoing)))
225 request_release(req);
226 request_delq(&h->incoming);
227 request_delq(&h->outgoing);
229 xmalloc_trav("session closed");
232 static void do_close_req(association *a, int reason, char *message,
235 Z_APDU *apdu = zget_APDU(a->encode, Z_APDU_close);
236 Z_Close *cls = apdu->u.close;
238 /* Purge request queue */
239 while (request_deq(&a->incoming));
240 while (request_deq(&a->outgoing));
243 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
244 reason, message ? message : "none");
245 *cls->closeReason = reason;
246 cls->diagnosticInformation = message;
247 process_z_response(a, req, apdu);
248 iochan_settimeout(a->client_chan, 20);
252 request_release(req);
253 yaz_log(log_requestdetail, "v2 client. No Close PDU");
254 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
257 a->state = ASSOC_DEAD;
260 static void do_close(association *a, int reason, char *message)
262 request *req = request_get(&a->outgoing);
263 do_close_req(a, reason, message, req);
267 int ir_read(IOCHAN h, int event)
269 association *assoc = (association *)iochan_getdata(h);
270 COMSTACK conn = assoc->client_link;
273 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
275 yaz_log(YLOG_DEBUG, "ir_session (input)");
276 /* We aren't speaking to this fellow */
277 if (assoc->state == ASSOC_DEAD)
279 yaz_log(log_sessiondetail, "Connection closed - end of session");
281 destroy_association(assoc);
285 assoc->cs_get_mask = EVENT_INPUT;
289 int res = cs_get(conn, &assoc->input_buffer,
290 &assoc->input_buffer_len);
291 if (res < 0 && cs_errno(conn) == CSBUFSIZE)
293 yaz_log(log_session, "Connection error: %s res=%d",
294 cs_errmsg(cs_errno(conn)), res);
295 req = request_get(&assoc->incoming); /* get a new request */
296 do_close_req(assoc, Z_Close_protocolError,
297 "Incoming package too large", req);
302 yaz_log(log_session, "Connection closed by client");
303 assoc->state = ASSOC_DEAD;
306 else if (res == 1) /* incomplete read - wait for more */
308 if (conn->io_pending & CS_WANT_WRITE)
309 assoc->cs_get_mask |= EVENT_OUTPUT;
310 iochan_setflag(h, assoc->cs_get_mask);
313 /* we got a complete PDU. Let's decode it */
314 yaz_log(YLOG_DEBUG, "Got PDU, %d bytes: lead=%02X %02X %02X", res,
315 assoc->input_buffer[0] & 0xff,
316 assoc->input_buffer[1] & 0xff,
317 assoc->input_buffer[2] & 0xff);
318 req = request_get(&assoc->incoming); /* get a new request */
319 odr_reset(assoc->decode);
320 odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
321 if (!z_GDU(assoc->decode, &req->gdu_request, 0, 0))
323 yaz_log(YLOG_WARN, "ODR error on incoming PDU: %s [element %s] "
325 odr_errmsg(odr_geterror(assoc->decode)),
326 odr_getelement(assoc->decode),
327 (long) odr_offset(assoc->decode));
328 if (assoc->decode->error != OHTTP)
330 yaz_log(YLOG_WARN, "PDU dump:");
331 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
332 request_release(req);
333 do_close(assoc, Z_Close_protocolError, "Malformed package");
337 Z_GDU *p = z_get_HTTP_Response(assoc->encode, 400);
338 assoc->state = ASSOC_DEAD;
339 process_gdu_response(assoc, req, p);
343 req->request_mem = odr_extract_mem(assoc->decode);
346 if (!z_GDU(assoc->print, &req->gdu_request, 0, 0))
347 yaz_log(YLOG_WARN, "ODR print error: %s",
348 odr_errmsg(odr_geterror(assoc->print)));
349 odr_reset(assoc->print);
351 request_enq(&assoc->incoming, req);
353 while (cs_more(conn));
359 * This is where PDUs from the client are read and the further
360 * processing is initiated. Flow of control moves down through the
361 * various process_* functions below, until the encoded result comes back up
362 * to the output handler in here.
364 * h : the I/O channel that has an outstanding event.
365 * event : the current outstanding event.
367 void ir_session(IOCHAN h, int event)
370 association *assoc = (association *)iochan_getdata(h);
371 COMSTACK conn = assoc->client_link;
374 assert(h && conn && assoc);
375 if (event == EVENT_TIMEOUT)
377 if (assoc->state != ASSOC_UP)
379 yaz_log(log_session, "Timeout. Closing connection");
380 /* do we need to lod this at all */
382 destroy_association(assoc);
387 yaz_log(log_sessiondetail, "Timeout. Sending Z39.50 Close");
388 do_close(assoc, Z_Close_lackOfActivity, 0);
392 if (event & assoc->cs_accept_mask)
394 if (!cs_accept(conn))
396 yaz_log(YLOG_WARN, "accept failed");
397 destroy_association(assoc);
401 iochan_clearflag(h, EVENT_OUTPUT);
402 if (conn->io_pending)
403 { /* cs_accept didn't complete */
404 assoc->cs_accept_mask =
405 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
406 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
408 iochan_setflag(h, assoc->cs_accept_mask);
411 { /* cs_accept completed. Prepare for reading (cs_get) */
412 assoc->cs_accept_mask = 0;
413 assoc->cs_get_mask = EVENT_INPUT;
414 iochan_setflag(h, assoc->cs_get_mask);
418 if (event & assoc->cs_get_mask) /* input */
420 if (!ir_read(h, event))
422 req = request_head(&assoc->incoming);
423 if (req->state == REQUEST_IDLE)
425 request_deq(&assoc->incoming);
426 process_gdu_request(assoc, req);
429 if (event & assoc->cs_put_mask)
431 request *req = request_head(&assoc->outgoing);
433 assoc->cs_put_mask = 0;
434 yaz_log(YLOG_DEBUG, "ir_session (output)");
435 req->state = REQUEST_PENDING;
436 switch (res = cs_put(conn, req->response, req->len_response))
439 yaz_log(log_sessiondetail, "Connection closed by client");
441 destroy_association(assoc);
444 case 0: /* all sent - release the request structure */
445 yaz_log(YLOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
447 yaz_log(YLOG_DEBUG, "HTTP out:\n%.*s", req->len_response,
450 nmem_destroy(req->request_mem);
451 request_deq(&assoc->outgoing);
452 request_release(req);
453 if (!request_head(&assoc->outgoing))
454 { /* restore mask for cs_get operation ... */
455 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
456 iochan_setflag(h, assoc->cs_get_mask);
457 if (assoc->state == ASSOC_DEAD)
458 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
462 assoc->cs_put_mask = EVENT_OUTPUT;
466 if (conn->io_pending & CS_WANT_WRITE)
467 assoc->cs_put_mask |= EVENT_OUTPUT;
468 if (conn->io_pending & CS_WANT_READ)
469 assoc->cs_put_mask |= EVENT_INPUT;
470 iochan_setflag(h, assoc->cs_put_mask);
473 if (event & EVENT_EXCEPT)
475 yaz_log(YLOG_WARN, "ir_session (exception)");
477 destroy_association(assoc);
482 static int process_z_request(association *assoc, request *req, char **msg);
485 static void assoc_init_reset(association *assoc)
488 assoc->init = (bend_initrequest *) xmalloc(sizeof(*assoc->init));
490 assoc->init->stream = assoc->encode;
491 assoc->init->print = assoc->print;
492 assoc->init->auth = 0;
493 assoc->init->referenceId = 0;
494 assoc->init->implementation_version = 0;
495 assoc->init->implementation_id = 0;
496 assoc->init->implementation_name = 0;
497 assoc->init->query_charset = 0;
498 assoc->init->records_in_same_charset = 0;
499 assoc->init->bend_sort = NULL;
500 assoc->init->bend_search = NULL;
501 assoc->init->bend_present = NULL;
502 assoc->init->bend_esrequest = NULL;
503 assoc->init->bend_delete = NULL;
504 assoc->init->bend_scan = NULL;
505 assoc->init->bend_segment = NULL;
506 assoc->init->bend_fetch = NULL;
507 assoc->init->bend_explain = NULL;
508 assoc->init->bend_srw_scan = NULL;
509 assoc->init->bend_srw_update = NULL;
510 assoc->init->named_result_sets = 0;
512 assoc->init->charneg_request = NULL;
513 assoc->init->charneg_response = NULL;
515 assoc->init->decode = assoc->decode;
516 assoc->init->peer_name =
517 odr_strdup(assoc->encode, cs_addrstr(assoc->client_link));
519 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
522 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
524 statserv_options_block *cb = statserv_getcontrol();
527 const char *encoding = "UTF-8";
529 bend_initresult *binitres;
531 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
532 assoc_init_reset(assoc);
536 Z_IdAuthentication *auth = (Z_IdAuthentication *)
537 odr_malloc(assoc->decode, sizeof(*auth));
540 len = strlen(sr->username) + 1;
542 len += strlen(sr->password) + 2;
543 yaz_log(log_requestdetail, "username=%s password-len=%ld",
545 (sr->password ? strlen(sr->password) : 0));
546 auth->which = Z_IdAuthentication_open;
547 auth->u.open = (char *) odr_malloc(assoc->decode, len);
548 strcpy(auth->u.open, sr->username);
549 if (sr->password && *sr->password)
551 strcat(auth->u.open, "/");
552 strcat(auth->u.open, sr->password);
554 assoc->init->auth = auth;
558 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
559 assoc->init->charneg_request = ce->u.charNeg3;
562 if (!(binitres = (*cb->bend_init)(assoc->init)))
564 assoc->state = ASSOC_DEAD;
565 yaz_add_srw_diagnostic(assoc->encode, d, num,
566 YAZ_SRW_AUTHENTICATION_ERROR, 0);
569 assoc->backend = binitres->handle;
570 assoc->init->auth = 0;
571 if (binitres->errcode)
573 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
574 assoc->state = ASSOC_DEAD;
575 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
576 binitres->errstring);
584 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
587 yaz_record_conv_t rc = 0;
588 const char *match_schema = 0;
589 Odr_oid *match_syntax = 0;
594 const char *input_schema = yaz_get_esn(rr->comp);
595 Odr_oid *input_syntax_raw = rr->request_format;
597 const char *backend_schema = 0;
598 Odr_oid *backend_syntax = 0;
600 r = yaz_retrieval_request(assoc->server->retrieval,
608 if (r == -1) /* error ? */
610 const char *details = yaz_retrieval_get_error(
611 assoc->server->retrieval);
613 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
615 rr->errstring = odr_strdup(rr->stream, details);
618 else if (r == 1 || r == 3)
620 const char *details = input_schema;
622 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
624 rr->errstring = odr_strdup(rr->stream, details);
629 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
630 if (input_syntax_raw)
632 char oidbuf[OID_STR_MAX];
633 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
634 rr->errstring = odr_strdup(rr->stream, oidbuf);
640 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
643 rr->request_format = backend_syntax;
645 (*assoc->init->bend_fetch)(assoc->backend, rr);
646 if (rc && rr->record && rr->errcode == 0 && rr->len > 0)
647 { /* post conversion must take place .. */
648 WRBUF output_record = wrbuf_alloc();
649 int r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
652 const char *details = yaz_record_conv_get_error(rc);
653 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
655 rr->errstring = odr_strdup(rr->stream, details);
659 rr->len = wrbuf_len(output_record);
660 rr->record = (char *) odr_malloc(rr->stream, rr->len);
661 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
663 wrbuf_destroy(output_record);
666 rr->output_format = match_syntax;
668 rr->schema = odr_strdup(rr->stream, match_schema);
670 (*assoc->init->bend_fetch)(assoc->backend, rr);
675 static int srw_bend_fetch(association *assoc, int pos,
676 Z_SRW_searchRetrieveRequest *srw_req,
677 Z_SRW_record *record,
678 const char **addinfo)
681 ODR o = assoc->encode;
683 rr.setname = "default";
686 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
688 rr.comp = (Z_RecordComposition *)
689 odr_malloc(assoc->decode, sizeof(*rr.comp));
690 rr.comp->which = Z_RecordComp_complex;
691 rr.comp->u.complex = (Z_CompSpec *)
692 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
693 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
694 odr_malloc(assoc->encode, sizeof(bool_t));
695 *rr.comp->u.complex->selectAlternativeSyntax = 0;
696 rr.comp->u.complex->num_dbSpecific = 0;
697 rr.comp->u.complex->dbSpecific = 0;
698 rr.comp->u.complex->num_recordSyntax = 0;
699 rr.comp->u.complex->recordSyntax = 0;
701 rr.comp->u.complex->generic = (Z_Specification *)
702 odr_malloc(assoc->decode, sizeof(Z_Specification));
704 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
705 rr.comp->u.complex->generic->which = Z_Schema_uri;
706 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
708 /* ESN = recordSchema if recordSchema is present */
709 rr.comp->u.complex->generic->elementSpec = 0;
710 if (srw_req->recordSchema)
712 rr.comp->u.complex->generic->elementSpec =
713 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
714 rr.comp->u.complex->generic->elementSpec->which =
715 Z_ElementSpec_elementSetName;
716 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
717 srw_req->recordSchema;
720 rr.stream = assoc->encode;
721 rr.print = assoc->print;
729 rr.surrogate_flag = 0;
730 rr.schema = srw_req->recordSchema;
732 if (!assoc->init->bend_fetch)
735 retrieve_fetch(assoc, &rr);
737 if (rr.errcode && rr.surrogate_flag)
739 int code = yaz_diag_bib1_to_srw(rr.errcode);
740 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
743 else if (rr.len >= 0)
745 record->recordData_buf = rr.record;
746 record->recordData_len = rr.len;
747 record->recordPosition = odr_intdup(o, pos);
748 record->recordSchema = odr_strdup_null(
749 o, rr.schema ? rr.schema : srw_req->recordSchema);
753 *addinfo = rr.errstring;
759 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
760 Z_Query *query_result)
762 /* have a CQL query and CQL to PQF transform .. */
763 CQL_parser cp = cql_parser_create();
769 r = cql_parser_string(cp, cql);
772 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
777 r = cql_transform_buf(ct,
778 cql_parser_result(cp),
779 rpn_buf, sizeof(rpn_buf)-1);
781 srw_errcode = cql_transform_error(ct, &add);
785 /* Syntax & transform OK. */
786 /* Convert PQF string to Z39.50 to RPN query struct */
787 YAZ_PQF_Parser pp = yaz_pqf_create();
788 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, rpn_buf);
793 int code = yaz_pqf_error(pp, &pqf_msg, &off);
794 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
796 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
800 query_result->which = Z_Query_type_1;
801 query_result->u.type_1 = rpnquery;
805 cql_parser_destroy(cp);
809 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
810 Z_AttributesPlusTerm *result)
814 int srw_error = cql2pqf(odr, cql, ct, &query);
817 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
818 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
819 rpn = query.u.type_1;
820 if (!rpn->RPNStructure)
821 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
822 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
823 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
824 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
825 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
826 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
832 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
833 bend_search_rr *bsrr)
836 struct ccl_rpn_node *node;
839 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
840 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0)
842 bsrr->errstring = (char*) ccl_err_msg(errcode);
843 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
846 bsrr->query->which = Z_Query_type_1;
847 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
851 static void srw_bend_search(association *assoc,
856 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
859 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
862 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
863 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
864 if (srw_res->num_diagnostics == 0 && assoc->init)
867 rr.setname = "default";
870 rr.basenames = &srw_req->database;
874 rr.srw_setnameIdleTime = 0;
875 rr.estimated_hit_count = 0;
876 rr.partial_resultset = 0;
877 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
878 rr.query->u.type_1 = 0;
879 rr.extra_args = sr->extra_args;
880 rr.extra_response_data = 0;
882 if (srw_req->query_type == Z_SRW_query_type_cql)
884 if (assoc->server && assoc->server->cql_transform)
886 int srw_errcode = cql2pqf(assoc->encode, srw_req->query.cql,
887 assoc->server->cql_transform,
891 yaz_add_srw_diagnostic(assoc->encode,
892 &srw_res->diagnostics,
893 &srw_res->num_diagnostics,
899 /* CQL query to backend. Wrap it - Z39.50 style */
900 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
901 ext->direct_reference = odr_getoidbystr(assoc->decode,
902 "1.2.840.10003.16.2");
903 ext->indirect_reference = 0;
905 ext->which = Z_External_CQL;
906 ext->u.cql = srw_req->query.cql;
908 rr.query->which = Z_Query_type_104;
909 rr.query->u.type_104 = ext;
912 else if (srw_req->query_type == Z_SRW_query_type_pqf)
914 Z_RPNQuery *RPNquery;
915 YAZ_PQF_Parser pqf_parser;
917 pqf_parser = yaz_pqf_create();
919 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode,
925 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
926 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
927 code, pqf_msg, (long) off);
928 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
931 rr.query->which = Z_Query_type_1;
932 rr.query->u.type_1 = RPNquery;
934 yaz_pqf_destroy(pqf_parser);
938 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
939 &srw_res->num_diagnostics,
940 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
942 if (rr.query->u.type_1)
944 rr.stream = assoc->encode;
945 rr.decode = assoc->decode;
946 rr.print = assoc->print;
947 if ( srw_req->sort.sortKeys )
948 rr.srw_sortKeys = odr_strdup(assoc->encode,
949 srw_req->sort.sortKeys );
950 rr.association = assoc;
956 yaz_log_zquery_level(log_requestdetail,rr.query);
958 (assoc->init->bend_search)(assoc->backend, &rr);
961 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
967 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
968 yaz_add_srw_diagnostic(assoc->encode,
969 &srw_res->diagnostics,
970 &srw_res->num_diagnostics,
971 srw_error, rr.errstring);
976 int number = srw_req->maximumRecords ?
977 odr_int_to_int(*srw_req->maximumRecords) : 0;
978 int start = srw_req->startRecord ?
979 odr_int_to_int(*srw_req->startRecord) : 1;
981 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
983 start, number, rr.hits);
985 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
988 srw_res->resultSetId =
989 odr_strdup(assoc->encode, rr.srw_setname );
990 srw_res->resultSetIdleTime =
991 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
994 if (start > rr.hits || start < 1)
996 /* if hits<=0 and start=1 we don't return a diagnostic */
998 yaz_add_srw_diagnostic(
1000 &srw_res->diagnostics, &srw_res->num_diagnostics,
1001 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1003 else if (number > 0)
1007 if (start + number > rr.hits)
1008 number = odr_int_to_int(rr.hits) - start + 1;
1010 /* Call bend_present if defined */
1011 if (assoc->init->bend_present)
1013 bend_present_rr *bprr = (bend_present_rr*)
1014 odr_malloc(assoc->decode, sizeof(*bprr));
1015 bprr->setname = "default";
1016 bprr->start = start;
1017 bprr->number = number;
1018 if (srw_req->recordSchema)
1020 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1021 sizeof(*bprr->comp));
1022 bprr->comp->which = Z_RecordComp_simple;
1023 bprr->comp->u.simple = (Z_ElementSetNames *)
1024 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1025 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1026 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1032 bprr->stream = assoc->encode;
1033 bprr->referenceId = 0;
1034 bprr->print = assoc->print;
1035 bprr->association = assoc;
1037 bprr->errstring = NULL;
1038 (*assoc->init->bend_present)(assoc->backend, bprr);
1042 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1043 yaz_add_srw_diagnostic(assoc->encode,
1044 &srw_res->diagnostics,
1045 &srw_res->num_diagnostics,
1046 srw_error, bprr->errstring);
1054 int packing = Z_SRW_recordPacking_string;
1055 if (srw_req->recordPacking)
1058 yaz_srw_str_to_pack(srw_req->recordPacking);
1060 packing = Z_SRW_recordPacking_string;
1062 srw_res->records = (Z_SRW_record *)
1063 odr_malloc(assoc->encode,
1064 number * sizeof(*srw_res->records));
1066 srw_res->extra_records = (Z_SRW_extra_record **)
1067 odr_malloc(assoc->encode,
1068 number*sizeof(*srw_res->extra_records));
1070 for (i = 0; i<number; i++)
1073 const char *addinfo = 0;
1075 srw_res->records[j].recordPacking = packing;
1076 srw_res->records[j].recordData_buf = 0;
1077 srw_res->extra_records[j] = 0;
1078 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1079 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1080 srw_res->records + j,
1084 yaz_add_srw_diagnostic(assoc->encode,
1085 &srw_res->diagnostics,
1086 &srw_res->num_diagnostics,
1087 yaz_diag_bib1_to_srw(errcode),
1092 if (srw_res->records[j].recordData_buf)
1095 srw_res->num_records = j;
1097 srw_res->records = 0;
1100 if (rr.extra_response_data)
1102 res->extraResponseData_buf = rr.extra_response_data;
1103 res->extraResponseData_len = strlen(rr.extra_response_data);
1105 if (rr.estimated_hit_count || rr.partial_resultset)
1107 yaz_add_srw_diagnostic(
1109 &srw_res->diagnostics,
1110 &srw_res->num_diagnostics,
1111 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1119 const char *querystr = "?";
1120 const char *querytype = "?";
1121 WRBUF wr = wrbuf_alloc();
1123 switch (srw_req->query_type)
1125 case Z_SRW_query_type_cql:
1127 querystr = srw_req->query.cql;
1129 case Z_SRW_query_type_pqf:
1131 querystr = srw_req->query.pqf;
1134 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1135 if (srw_res->num_diagnostics)
1136 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1137 else if (*http_code != 200)
1138 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1139 else if (srw_res->numberOfRecords)
1141 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1142 (srw_res->numberOfRecords ?
1143 *srw_res->numberOfRecords : 0));
1145 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+%d",
1146 (srw_res->resultSetId ?
1147 srw_res->resultSetId : "-"),
1148 (srw_req->startRecord ? *srw_req->startRecord : 1),
1149 srw_res->num_records);
1150 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), querytype, querystr);
1155 static char *srw_bend_explain_default(bend_explain_rr *rr)
1158 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1161 for (ptr = ptr->children; ptr; ptr = ptr->next)
1163 if (ptr->type != XML_ELEMENT_NODE)
1165 if (!strcmp((const char *) ptr->name, "explain"))
1168 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1172 ptr = xmlCopyNode(ptr, 1);
1174 xmlDocSetRootElement(doc, ptr);
1176 xmlDocDumpMemory(doc, &buf_out, &len);
1177 content = (char*) odr_malloc(rr->stream, 1+len);
1178 memcpy(content, buf_out, len);
1179 content[len] = '\0';
1183 rr->explain_buf = content;
1191 static void srw_bend_explain(association *assoc,
1193 Z_SRW_explainResponse *srw_res,
1196 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1197 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1199 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1204 rr.stream = assoc->encode;
1205 rr.decode = assoc->decode;
1206 rr.print = assoc->print;
1208 rr.database = srw_req->database;
1210 rr.server_node_ptr = assoc->server->server_node_ptr;
1212 rr.server_node_ptr = 0;
1213 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1214 if (assoc->init->bend_explain)
1215 (*assoc->init->bend_explain)(assoc->backend, &rr);
1217 srw_bend_explain_default(&rr);
1221 int packing = Z_SRW_recordPacking_string;
1222 if (srw_req->recordPacking)
1225 yaz_srw_str_to_pack(srw_req->recordPacking);
1227 packing = Z_SRW_recordPacking_string;
1229 srw_res->record.recordSchema = rr.schema;
1230 srw_res->record.recordPacking = packing;
1231 srw_res->record.recordData_buf = rr.explain_buf;
1232 srw_res->record.recordData_len = strlen(rr.explain_buf);
1233 srw_res->record.recordPosition = 0;
1239 static void srw_bend_scan(association *assoc,
1241 Z_SRW_scanResponse *srw_res,
1244 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1245 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1248 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1249 if (srw_res->num_diagnostics == 0 && assoc->init)
1252 struct scan_entry *save_entries;
1254 bend_scan_rr *bsrr = (bend_scan_rr *)
1255 odr_malloc(assoc->encode, sizeof(*bsrr));
1256 bsrr->num_bases = 1;
1257 bsrr->basenames = &srw_req->database;
1259 bsrr->num_entries = srw_req->maximumTerms ?
1260 odr_int_to_int(*srw_req->maximumTerms) : 10;
1261 bsrr->term_position = srw_req->responsePosition ?
1262 odr_int_to_int(*srw_req->responsePosition) : 1;
1265 bsrr->errstring = 0;
1266 bsrr->referenceId = 0;
1267 bsrr->stream = assoc->encode;
1268 bsrr->print = assoc->print;
1269 bsrr->step_size = &step_size;
1273 if (bsrr->num_entries > 0)
1276 bsrr->entries = (struct scan_entry *)
1277 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1279 for (i = 0; i<bsrr->num_entries; i++)
1281 bsrr->entries[i].term = 0;
1282 bsrr->entries[i].occurrences = 0;
1283 bsrr->entries[i].errcode = 0;
1284 bsrr->entries[i].errstring = 0;
1285 bsrr->entries[i].display_term = 0;
1288 save_entries = bsrr->entries; /* save it so we can compare later */
1290 if (srw_req->query_type == Z_SRW_query_type_pqf &&
1291 assoc->init->bend_scan)
1293 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1295 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1296 &bsrr->attributeset,
1297 srw_req->scanClause.pqf);
1298 yaz_pqf_destroy(pqf_parser);
1299 bsrr->scanClause = 0;
1300 ((int (*)(void *, bend_scan_rr *))
1301 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1303 else if (srw_req->query_type == Z_SRW_query_type_cql
1304 && assoc->init->bend_scan && assoc->server
1305 && assoc->server->cql_transform)
1308 bsrr->scanClause = 0;
1309 bsrr->attributeset = 0;
1310 bsrr->term = (Z_AttributesPlusTerm *)
1311 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1312 srw_error = cql2pqf_scan(assoc->encode,
1313 srw_req->scanClause.cql,
1314 assoc->server->cql_transform,
1317 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1318 &srw_res->num_diagnostics,
1322 ((int (*)(void *, bend_scan_rr *))
1323 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1326 else if (srw_req->query_type == Z_SRW_query_type_cql
1327 && assoc->init->bend_srw_scan)
1330 bsrr->attributeset = 0;
1331 bsrr->scanClause = srw_req->scanClause.cql;
1332 ((int (*)(void *, bend_scan_rr *))
1333 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1337 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1338 &srw_res->num_diagnostics,
1339 YAZ_SRW_UNSUPP_OPERATION, "scan");
1344 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1349 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1351 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1352 &srw_res->num_diagnostics,
1353 srw_error, bsrr->errstring);
1355 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1358 srw_res->terms = (Z_SRW_scanTerm*)
1359 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1362 srw_res->num_terms = bsrr->num_entries;
1363 for (i = 0; i<bsrr->num_entries; i++)
1365 Z_SRW_scanTerm *t = srw_res->terms + i;
1366 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1367 t->numberOfRecords =
1368 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1370 if (save_entries == bsrr->entries &&
1371 bsrr->entries[i].display_term)
1373 /* the entries was _not_ set by the handler. So it's
1374 safe to test for new member display_term. It is
1377 t->displayTerm = odr_strdup(assoc->encode,
1378 bsrr->entries[i].display_term);
1386 WRBUF wr = wrbuf_alloc();
1387 const char *querytype = 0;
1388 const char *querystr = 0;
1390 switch(srw_req->query_type)
1392 case Z_SRW_query_type_pqf:
1394 querystr = srw_req->scanClause.pqf;
1396 case Z_SRW_query_type_cql:
1398 querystr = srw_req->scanClause.cql;
1401 querytype = "UNKNOWN";
1405 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1407 if (srw_res->num_diagnostics)
1408 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1409 else if (srw_res->num_terms)
1410 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1412 wrbuf_printf(wr, "OK - - ");
1414 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1415 (srw_req->responsePosition ?
1416 *srw_req->responsePosition : 1),
1417 (srw_req->maximumTerms ?
1418 *srw_req->maximumTerms : 1));
1419 /* there is no step size in SRU/W ??? */
1420 wrbuf_printf(wr, "%s: %s ", querytype, querystr);
1421 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1427 static void srw_bend_update(association *assoc,
1429 Z_SRW_updateResponse *srw_res,
1432 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1433 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1434 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1436 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1440 Z_SRW_extra_record *extra = srw_req->extra_record;
1442 rr.stream = assoc->encode;
1443 rr.print = assoc->print;
1445 rr.basenames = &srw_req->database;
1446 rr.operation = srw_req->operation;
1447 rr.operation_status = "failed";
1449 rr.record_versions = 0;
1450 rr.num_versions = 0;
1451 rr.record_packing = "string";
1452 rr.record_schema = 0;
1454 rr.extra_record_data = 0;
1455 rr.extra_request_data = 0;
1456 rr.extra_response_data = 0;
1462 if (rr.operation == 0)
1464 yaz_add_sru_update_diagnostic(
1465 assoc->encode, &srw_res->diagnostics,
1466 &srw_res->num_diagnostics,
1467 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1471 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1472 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1473 if (!strcmp( rr.operation, "delete"))
1475 if (srw_req->record && !srw_req->record->recordSchema)
1477 rr.record_schema = odr_strdup(
1479 srw_req->record->recordSchema);
1481 if (srw_req->record)
1483 rr.record_data = odr_strdupn(
1485 srw_req->record->recordData_buf,
1486 srw_req->record->recordData_len );
1488 if (extra && extra->extraRecordData_len)
1490 rr.extra_record_data = odr_strdupn(
1492 extra->extraRecordData_buf,
1493 extra->extraRecordData_len );
1495 if (srw_req->recordId)
1496 rr.record_id = srw_req->recordId;
1497 else if (extra && extra->recordIdentifier)
1498 rr.record_id = extra->recordIdentifier;
1500 else if (!strcmp(rr.operation, "replace"))
1502 if (srw_req->recordId)
1503 rr.record_id = srw_req->recordId;
1504 else if (extra && extra->recordIdentifier)
1505 rr.record_id = extra->recordIdentifier;
1508 yaz_add_sru_update_diagnostic(
1509 assoc->encode, &srw_res->diagnostics,
1510 &srw_res->num_diagnostics,
1511 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1512 "recordIdentifier");
1514 if (!srw_req->record)
1516 yaz_add_sru_update_diagnostic(
1517 assoc->encode, &srw_res->diagnostics,
1518 &srw_res->num_diagnostics,
1519 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1524 if (srw_req->record->recordSchema)
1525 rr.record_schema = odr_strdup(
1526 assoc->encode, srw_req->record->recordSchema);
1527 if (srw_req->record->recordData_len )
1529 rr.record_data = odr_strdupn(assoc->encode,
1530 srw_req->record->recordData_buf,
1531 srw_req->record->recordData_len );
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,
1542 if (extra && extra->extraRecordData_len)
1544 rr.extra_record_data = odr_strdupn(
1546 extra->extraRecordData_buf,
1547 extra->extraRecordData_len );
1550 else if (!strcmp(rr.operation, "insert"))
1552 if (srw_req->recordId)
1553 rr.record_id = srw_req->recordId;
1555 rr.record_id = extra->recordIdentifier;
1557 if (srw_req->record)
1559 if (srw_req->record->recordSchema)
1560 rr.record_schema = odr_strdup(
1561 assoc->encode, srw_req->record->recordSchema);
1563 if (srw_req->record->recordData_len)
1564 rr.record_data = odr_strdupn(
1566 srw_req->record->recordData_buf,
1567 srw_req->record->recordData_len );
1569 if (extra && extra->extraRecordData_len)
1571 rr.extra_record_data = odr_strdupn(
1573 extra->extraRecordData_buf,
1574 extra->extraRecordData_len );
1578 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1579 &srw_res->num_diagnostics,
1580 YAZ_SRU_UPDATE_INVALID_ACTION,
1583 if (srw_req->record)
1585 const char *pack_str =
1586 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1588 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1591 if (srw_req->num_recordVersions)
1593 rr.record_versions = srw_req->recordVersions;
1594 rr.num_versions = srw_req->num_recordVersions;
1596 if (srw_req->extraRequestData_len)
1598 rr.extra_request_data = odr_strdupn(assoc->encode,
1599 srw_req->extraRequestData_buf,
1600 srw_req->extraRequestData_len );
1602 if (srw_res->num_diagnostics == 0)
1604 if ( assoc->init->bend_srw_update)
1605 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1607 yaz_add_sru_update_diagnostic(
1608 assoc->encode, &srw_res->diagnostics,
1609 &srw_res->num_diagnostics,
1610 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1611 "No Update backend handler");
1615 yaz_add_srw_diagnostic_uri(assoc->encode,
1616 &srw_res->diagnostics,
1617 &srw_res->num_diagnostics,
1621 srw_res->recordId = rr.record_id;
1622 srw_res->operationStatus = rr.operation_status;
1623 srw_res->recordVersions = rr.record_versions;
1624 srw_res->num_recordVersions = rr.num_versions;
1625 if (srw_res->extraResponseData_len)
1627 srw_res->extraResponseData_buf = rr.extra_response_data;
1628 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1630 if (srw_res->num_diagnostics == 0 && rr.record_data)
1632 srw_res->record = yaz_srw_get_record(assoc->encode);
1633 srw_res->record->recordSchema = rr.record_schema;
1634 if (rr.record_packing)
1636 int pack = yaz_srw_str_to_pack(rr.record_packing);
1640 pack = Z_SRW_recordPacking_string;
1641 yaz_log(YLOG_WARN, "Back packing %s from backend",
1644 srw_res->record->recordPacking = pack;
1646 srw_res->record->recordData_buf = rr.record_data;
1647 srw_res->record->recordData_len = strlen(rr.record_data);
1648 if (rr.extra_record_data)
1650 Z_SRW_extra_record *ex =
1651 yaz_srw_get_extra_record(assoc->encode);
1652 srw_res->extra_record = ex;
1653 ex->extraRecordData_buf = rr.extra_record_data;
1654 ex->extraRecordData_len = strlen(rr.extra_record_data);
1660 /* check if path is OK (1); BAD (0) */
1661 static int check_path(const char *path)
1665 if (strstr(path, ".."))
1670 static char *read_file(const char *fname, ODR o, size_t *sz)
1673 FILE *inf = fopen(fname, "rb");
1677 fseek(inf, 0L, SEEK_END);
1680 buf = (char *) odr_malloc(o, *sz);
1681 if (fread(buf, 1, *sz, inf) != *sz)
1682 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1687 static void process_http_request(association *assoc, request *req)
1689 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1690 ODR o = assoc->encode;
1691 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1693 Z_SOAP *soap_package = 0;
1696 Z_HTTP_Response *hres = 0;
1698 const char *stylesheet = 0; /* for now .. set later */
1699 Z_SRW_diagnostic *diagnostic = 0;
1700 int num_diagnostic = 0;
1701 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1703 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1704 if (!control_association(assoc, host, 0))
1706 p = z_get_HTTP_Response(o, 404);
1709 if (r == 2 && assoc->server && assoc->server->docpath
1710 && hreq->path[0] == '/'
1712 /* check if path is a proper prefix of documentroot */
1713 strncmp(hreq->path+1, assoc->server->docpath,
1714 strlen(assoc->server->docpath))
1717 if (!check_path(hreq->path))
1719 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1720 p = z_get_HTTP_Response(o, 404);
1724 size_t content_size = 0;
1725 char *content_buf = read_file(hreq->path+1, o, &content_size);
1728 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1729 p = z_get_HTTP_Response(o, 404);
1733 const char *ctype = 0;
1734 yaz_mime_types types = yaz_mime_types_create();
1736 yaz_mime_types_add(types, "xsl", "application/xml");
1737 yaz_mime_types_add(types, "xml", "application/xml");
1738 yaz_mime_types_add(types, "css", "text/css");
1739 yaz_mime_types_add(types, "html", "text/html");
1740 yaz_mime_types_add(types, "htm", "text/html");
1741 yaz_mime_types_add(types, "txt", "text/plain");
1742 yaz_mime_types_add(types, "js", "application/x-javascript");
1744 yaz_mime_types_add(types, "gif", "image/gif");
1745 yaz_mime_types_add(types, "png", "image/png");
1746 yaz_mime_types_add(types, "jpg", "image/jpeg");
1747 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1749 ctype = yaz_mime_lookup_fname(types, hreq->path);
1752 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1753 p = z_get_HTTP_Response(o, 404);
1757 p = z_get_HTTP_Response(o, 200);
1758 hres = p->u.HTTP_Response;
1759 hres->content_buf = content_buf;
1760 hres->content_len = content_size;
1761 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1763 yaz_mime_types_destroy(types);
1771 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1772 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1774 if (r == 2) /* not taken */
1776 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1777 &diagnostic, &num_diagnostic);
1778 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1780 if (r == 0) /* decode SRW/SRU OK .. */
1782 int http_code = 200;
1783 if (sr->which == Z_SRW_searchRetrieve_request)
1786 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1788 stylesheet = sr->u.request->stylesheet;
1791 res->u.response->diagnostics = diagnostic;
1792 res->u.response->num_diagnostics = num_diagnostic;
1796 srw_bend_search(assoc, sr, res, &http_code);
1798 if (http_code == 200)
1799 soap_package->u.generic->p = res;
1801 else if (sr->which == Z_SRW_explain_request)
1803 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1805 stylesheet = sr->u.explain_request->stylesheet;
1808 res->u.explain_response->diagnostics = diagnostic;
1809 res->u.explain_response->num_diagnostics = num_diagnostic;
1811 srw_bend_explain(assoc, sr, res->u.explain_response, &http_code);
1812 if (http_code == 200)
1813 soap_package->u.generic->p = res;
1815 else if (sr->which == Z_SRW_scan_request)
1817 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1819 stylesheet = sr->u.scan_request->stylesheet;
1822 res->u.scan_response->diagnostics = diagnostic;
1823 res->u.scan_response->num_diagnostics = num_diagnostic;
1825 srw_bend_scan(assoc, sr, res->u.scan_response, &http_code);
1826 if (http_code == 200)
1827 soap_package->u.generic->p = res;
1829 else if (sr->which == Z_SRW_update_request)
1831 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1833 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1836 res->u.update_response->diagnostics = diagnostic;
1837 res->u.update_response->num_diagnostics = num_diagnostic;
1839 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1840 srw_bend_update(assoc, sr, res->u.update_response, &http_code);
1841 if (http_code == 200)
1842 soap_package->u.generic->p = res;
1846 yaz_log(log_request, "SOAP ERROR");
1847 /* FIXME - what error, what query */
1849 z_soap_error(assoc->encode, soap_package,
1850 "SOAP-ENV:Client", "Bad method", 0);
1852 if (http_code == 200 || http_code == 500)
1854 static Z_SOAP_Handler soap_handlers[4] = {
1856 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1857 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1858 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1864 p = z_get_HTTP_Response(o, 200);
1865 hres = p->u.HTTP_Response;
1867 if (!stylesheet && assoc->server)
1868 stylesheet = assoc->server->stylesheet;
1870 /* empty stylesheet means NO stylesheet */
1871 if (stylesheet && *stylesheet == '\0')
1874 ret = z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1875 &hres->content_buf, &hres->content_len,
1876 soap_handlers, charset, stylesheet);
1877 hres->code = http_code;
1879 strcpy(ctype, "text/xml");
1880 if (charset && strlen(charset) < sizeof(ctype)-30)
1882 strcat(ctype, "; charset=");
1883 strcat(ctype, charset);
1885 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1888 p = z_get_HTTP_Response(o, http_code);
1892 p = z_get_HTTP_Response(o, 500);
1893 hres = p->u.HTTP_Response;
1894 if (!strcmp(hreq->version, "1.0"))
1896 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1897 if (v && !strcmp(v, "Keep-Alive"))
1901 hres->version = "1.0";
1905 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1906 if (v && !strcmp(v, "close"))
1910 hres->version = "1.1";
1912 if (!keepalive || !assoc->last_control->keepalive)
1914 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1915 assoc->state = ASSOC_DEAD;
1916 assoc->cs_get_mask = 0;
1921 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1923 if (alive && isdigit(*(const unsigned char *) alive))
1927 if (t < 0 || t > 3600)
1929 iochan_settimeout(assoc->client_chan,t);
1930 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1932 process_gdu_response(assoc, req, p);
1935 static void process_gdu_request(association *assoc, request *req)
1937 if (req->gdu_request->which == Z_GDU_Z3950)
1940 req->apdu_request = req->gdu_request->u.z3950;
1941 if (process_z_request(assoc, req, &msg) < 0)
1942 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1944 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1945 process_http_request(assoc, req);
1948 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
1953 * Initiate request processing.
1955 static int process_z_request(association *assoc, request *req, char **msg)
1960 *msg = "Unknown Error";
1961 assert(req && req->state == REQUEST_IDLE);
1962 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
1964 *msg = "Missing InitRequest";
1967 switch (req->apdu_request->which)
1969 case Z_APDU_initRequest:
1970 res = process_initRequest(assoc, req); break;
1971 case Z_APDU_searchRequest:
1972 res = process_searchRequest(assoc, req); break;
1973 case Z_APDU_presentRequest:
1974 res = process_presentRequest(assoc, req); break;
1975 case Z_APDU_scanRequest:
1976 if (assoc->init->bend_scan)
1977 res = process_scanRequest(assoc, req);
1980 *msg = "Cannot handle Scan APDU";
1984 case Z_APDU_extendedServicesRequest:
1985 if (assoc->init->bend_esrequest)
1986 res = process_ESRequest(assoc, req);
1989 *msg = "Cannot handle Extended Services APDU";
1993 case Z_APDU_sortRequest:
1994 if (assoc->init->bend_sort)
1995 res = process_sortRequest(assoc, req);
1998 *msg = "Cannot handle Sort APDU";
2003 process_close(assoc, req);
2005 case Z_APDU_deleteResultSetRequest:
2006 if (assoc->init->bend_delete)
2007 res = process_deleteRequest(assoc, req);
2010 *msg = "Cannot handle Delete APDU";
2014 case Z_APDU_segmentRequest:
2015 if (assoc->init->bend_segment)
2017 res = process_segmentRequest(assoc, req);
2021 *msg = "Cannot handle Segment APDU";
2025 case Z_APDU_triggerResourceControlRequest:
2028 *msg = "Bad APDU received";
2033 yaz_log(YLOG_DEBUG, " result immediately available");
2034 retval = process_z_response(assoc, req, res);
2038 yaz_log(YLOG_DEBUG, " result unavailable");
2045 * Encode response, and transfer the request structure to the outgoing queue.
2047 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2049 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2053 if (!z_GDU(assoc->print, &res, 0, 0))
2054 yaz_log(YLOG_WARN, "ODR print error: %s",
2055 odr_errmsg(odr_geterror(assoc->print)));
2056 odr_reset(assoc->print);
2058 if (!z_GDU(assoc->encode, &res, 0, 0))
2060 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2061 odr_errmsg(odr_geterror(assoc->decode)),
2062 odr_getelement(assoc->decode));
2065 req->response = odr_getbuf(assoc->encode, &req->len_response,
2066 &req->size_response);
2067 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2068 odr_reset(assoc->encode);
2069 req->state = REQUEST_IDLE;
2070 request_enq(&assoc->outgoing, req);
2071 /* turn the work over to the ir_session handler */
2072 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2073 assoc->cs_put_mask = EVENT_OUTPUT;
2074 /* Is there more work to be done? give that to the input handler too */
2077 req = request_head(&assoc->incoming);
2078 if (req && req->state == REQUEST_IDLE)
2080 request_deq(&assoc->incoming);
2081 process_gdu_request(assoc, req);
2090 * Encode response, and transfer the request structure to the outgoing queue.
2092 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2094 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*gres));
2095 gres->which = Z_GDU_Z3950;
2096 gres->u.z3950 = res;
2098 return process_gdu_response(assoc, req, gres);
2101 static char *get_vhost(Z_OtherInformation *otherInfo)
2103 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2107 * Handle init request.
2108 * At the moment, we don't check the options
2109 * anywhere else in the code - we just try not to do anything that would
2110 * break a naive client. We'll toss 'em into the association block when
2111 * we need them there.
2113 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2115 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2116 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2117 Z_InitResponse *resp = apdu->u.initResponse;
2118 bend_initresult *binitres;
2120 statserv_options_block *cb = 0; /* by default no control for backend */
2122 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2123 cb = statserv_getcontrol(); /* got control block for backend */
2125 if (cb && assoc->backend)
2126 (*cb->bend_close)(assoc->backend);
2128 yaz_log(log_requestdetail, "Got initRequest");
2129 if (req->implementationId)
2130 yaz_log(log_requestdetail, "Id: %s",
2131 req->implementationId);
2132 if (req->implementationName)
2133 yaz_log(log_requestdetail, "Name: %s",
2134 req->implementationName);
2135 if (req->implementationVersion)
2136 yaz_log(log_requestdetail, "Version: %s",
2137 req->implementationVersion);
2139 assoc_init_reset(assoc);
2141 assoc->init->auth = req->idAuthentication;
2142 assoc->init->referenceId = req->referenceId;
2144 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2146 Z_CharSetandLanguageNegotiation *negotiation =
2147 yaz_get_charneg_record (req->otherInfo);
2149 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2150 assoc->init->charneg_request = negotiation;
2153 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2154 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2155 assoc->init->named_result_sets = 1;
2160 if (req->implementationVersion)
2161 yaz_log(log_requestdetail, "Config: %s",
2164 iochan_settimeout(assoc->client_chan, cb->idle_timeout);
2166 /* we have a backend control block, so call that init function */
2167 if (!(binitres = (*cb->bend_init)(assoc->init)))
2169 yaz_log(YLOG_WARN, "Bad response from backend.");
2172 assoc->backend = binitres->handle;
2176 /* no backend. return error */
2177 binitres = (bend_initresult *)
2178 odr_malloc(assoc->encode, sizeof(*binitres));
2179 binitres->errstring = 0;
2180 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2181 iochan_settimeout(assoc->client_chan, 10);
2183 if ((assoc->init->bend_sort))
2184 yaz_log(YLOG_DEBUG, "Sort handler installed");
2185 if ((assoc->init->bend_search))
2186 yaz_log(YLOG_DEBUG, "Search handler installed");
2187 if ((assoc->init->bend_present))
2188 yaz_log(YLOG_DEBUG, "Present handler installed");
2189 if ((assoc->init->bend_esrequest))
2190 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2191 if ((assoc->init->bend_delete))
2192 yaz_log(YLOG_DEBUG, "Delete handler installed");
2193 if ((assoc->init->bend_scan))
2194 yaz_log(YLOG_DEBUG, "Scan handler installed");
2195 if ((assoc->init->bend_segment))
2196 yaz_log(YLOG_DEBUG, "Segment handler installed");
2198 resp->referenceId = req->referenceId;
2200 /* let's tell the client what we can do */
2201 if (ODR_MASK_GET(req->options, Z_Options_search))
2203 ODR_MASK_SET(resp->options, Z_Options_search);
2204 strcat(options, "srch");
2206 if (ODR_MASK_GET(req->options, Z_Options_present))
2208 ODR_MASK_SET(resp->options, Z_Options_present);
2209 strcat(options, " prst");
2211 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2212 assoc->init->bend_delete)
2214 ODR_MASK_SET(resp->options, Z_Options_delSet);
2215 strcat(options, " del");
2217 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2218 assoc->init->bend_esrequest)
2220 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2221 strcat(options, " extendedServices");
2223 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2224 && assoc->init->named_result_sets)
2226 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2227 strcat(options, " namedresults");
2229 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2231 ODR_MASK_SET(resp->options, Z_Options_scan);
2232 strcat(options, " scan");
2234 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2236 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2237 strcat(options, " concurrop");
2239 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2241 ODR_MASK_SET(resp->options, Z_Options_sort);
2242 strcat(options, " sort");
2245 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2247 Z_OtherInformationUnit *p0;
2249 if (!assoc->init->charneg_response)
2251 if (assoc->init->query_charset)
2253 assoc->init->charneg_response = yaz_set_response_charneg(
2254 assoc->encode, assoc->init->query_charset, 0,
2255 assoc->init->records_in_same_charset);
2259 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2262 if (assoc->init->charneg_response
2263 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2265 p0->which = Z_OtherInfo_externallyDefinedInfo;
2266 p0->information.externallyDefinedInfo =
2267 assoc->init->charneg_response;
2268 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2269 strcat(options, " negotiation");
2272 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2273 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2275 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2277 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2278 assoc->version = 1; /* 1 & 2 are equivalent */
2280 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2282 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2285 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2287 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2291 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2293 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2294 assoc->maximumRecordSize = odr_int_to_int(*req->maximumRecordSize);
2296 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2297 assoc->preferredMessageSize = odr_int_to_int(*req->preferredMessageSize);
2299 resp->preferredMessageSize =
2300 odr_intdup(assoc->encode, assoc->preferredMessageSize);
2301 resp->maximumRecordSize =
2302 odr_intdup(assoc->encode, assoc->maximumRecordSize);
2304 resp->implementationId = odr_prepend(assoc->encode,
2305 assoc->init->implementation_id,
2306 resp->implementationId);
2308 resp->implementationName = odr_prepend(assoc->encode,
2309 assoc->init->implementation_name,
2310 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2312 if (binitres->errcode)
2314 assoc->state = ASSOC_DEAD;
2315 resp->userInformationField =
2316 init_diagnostics(assoc->encode, binitres->errcode,
2317 binitres->errstring);
2321 assoc->state = ASSOC_UP;
2325 if (!req->idAuthentication)
2326 yaz_log(log_request, "Auth none");
2327 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2329 const char *open = req->idAuthentication->u.open;
2330 const char *slash = strchr(open, '/');
2336 yaz_log(log_request, "Auth open %.*s", len, open);
2338 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2340 const char *user = req->idAuthentication->u.idPass->userId;
2341 const char *group = req->idAuthentication->u.idPass->groupId;
2342 yaz_log(log_request, "Auth idPass %s %s",
2343 user ? user : "-", group ? group : "-");
2345 else if (req->idAuthentication->which
2346 == Z_IdAuthentication_anonymous)
2348 yaz_log(log_request, "Auth anonymous");
2352 yaz_log(log_request, "Auth other");
2357 WRBUF wr = wrbuf_alloc();
2358 wrbuf_printf(wr, "Init ");
2359 if (binitres->errcode)
2360 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2362 wrbuf_printf(wr, "OK -");
2363 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2364 (req->implementationId ? req->implementationId :"-"),
2365 (req->implementationName ?
2366 req->implementationName : "-"),
2367 (req->implementationVersion ?
2368 req->implementationVersion : "-")
2370 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2377 * Set the specified `errcode' and `errstring' into a UserInfo-1
2378 * external to be returned to the client in accordance with Z35.90
2379 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2380 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2382 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2384 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2385 addinfo ? " -- " : "", addinfo ? addinfo : "");
2386 return zget_init_diagnostics(odr, error, addinfo);
2390 * nonsurrogate diagnostic record.
2392 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2394 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2396 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2397 addinfo ? " -- " : "", addinfo ? addinfo : "");
2399 rec->which = Z_Records_NSD;
2400 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2406 * surrogate diagnostic.
2408 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2410 int error, const char *addinfo)
2412 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2413 addinfo ? " -- " : "", addinfo ? addinfo : "");
2414 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2417 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2418 Odr_int *num, Z_RecordComposition *comp,
2419 Odr_int *next, Odr_int *pres,
2420 Z_ReferenceId *referenceId,
2421 Odr_oid *oid, int *errcode)
2423 int recno, total_length = 0, dumped_records = 0;
2424 int toget = odr_int_to_int(*num);
2425 Z_Records *records =
2426 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2427 Z_NamePlusRecordList *reclist =
2428 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2430 records->which = Z_Records_DBOSD;
2431 records->u.databaseOrSurDiagnostics = reclist;
2432 reclist->num_records = 0;
2435 return diagrec(a, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, 0);
2436 else if (toget == 0)
2437 reclist->records = odr_nullval();
2439 reclist->records = (Z_NamePlusRecord **)
2440 odr_malloc(a->encode, sizeof(*reclist->records) * toget);
2442 *pres = Z_PresentStatus_success;
2446 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2447 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2448 a->maximumRecordSize);
2449 for (recno = odr_int_to_int(start); reclist->num_records < toget; recno++)
2452 Z_NamePlusRecord *thisrec;
2453 int this_length = 0;
2455 * we get the number of bytes allocated on the stream before any
2456 * allocation done by the backend - this should give us a reasonable
2457 * idea of the total size of the data so far.
2459 total_length = odr_total(a->encode) - dumped_records;
2465 freq.last_in_set = 0;
2466 freq.setname = setname;
2467 freq.surrogate_flag = 0;
2468 freq.number = recno;
2470 freq.request_format = oid;
2471 freq.output_format = 0;
2472 freq.stream = a->encode;
2473 freq.print = a->print;
2474 freq.referenceId = referenceId;
2477 retrieve_fetch(a, &freq);
2479 *next = freq.last_in_set ? 0 : recno + 1;
2483 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2486 *pres = Z_PresentStatus_failure;
2487 /* for 'present request out of range',
2488 set addinfo to record position if not set */
2489 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2490 freq.errstring == 0)
2492 sprintf(s, "%d", recno);
2496 *errcode = freq.errcode;
2497 return diagrec(a, freq.errcode, freq.errstring);
2499 reclist->records[reclist->num_records] =
2500 surrogatediagrec(a, freq.basename, freq.errcode,
2502 reclist->num_records++;
2505 if (freq.record == 0) /* no error and no record ? */
2507 *pres = Z_PresentStatus_partial_4;
2508 *next = 0; /* signal end-of-set and stop */
2512 this_length = freq.len;
2514 this_length = odr_total(a->encode) - total_length - dumped_records;
2515 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2516 this_length, total_length, dumped_records);
2517 if (a->preferredMessageSize > 0 &&
2518 this_length + total_length > a->preferredMessageSize)
2520 /* record is small enough, really */
2521 if (this_length <= a->preferredMessageSize && recno > start)
2523 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2524 *pres = Z_PresentStatus_partial_2;
2529 /* record can only be fetched by itself */
2530 if (this_length < a->maximumRecordSize)
2532 yaz_log(log_requestdetail, " Record > prefmsgsz");
2535 yaz_log(YLOG_DEBUG, " Dropped it");
2536 reclist->records[reclist->num_records] =
2539 YAZ_BIB1_RECORD_EXCEEDS_PREFERRED_MESSAGE_SIZE, 0);
2540 reclist->num_records++;
2541 dumped_records += this_length;
2545 else /* too big entirely */
2547 yaz_log(log_requestdetail, "Record > maxrcdsz "
2549 this_length, a->maximumRecordSize);
2550 reclist->records[reclist->num_records] =
2553 YAZ_BIB1_RECORD_EXCEEDS_MAXIMUM_RECORD_SIZE, 0);
2554 reclist->num_records++;
2555 dumped_records += this_length;
2560 if (!(thisrec = (Z_NamePlusRecord *)
2561 odr_malloc(a->encode, sizeof(*thisrec))))
2563 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2564 thisrec->which = Z_NamePlusRecord_databaseRecord;
2566 if (!freq.output_format)
2568 yaz_log(YLOG_WARN, "bend_fetch output_format not set");
2571 thisrec->u.databaseRecord = z_ext_record_oid(
2572 a->encode, freq.output_format, freq.record, freq.len);
2573 if (!thisrec->u.databaseRecord)
2575 reclist->records[reclist->num_records] = thisrec;
2576 reclist->num_records++;
2578 *num = reclist->num_records;
2582 static Z_APDU *process_searchRequest(association *assoc, request *reqb)
2584 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2585 bend_search_rr *bsrr =
2586 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2588 yaz_log(log_requestdetail, "Got SearchRequest.");
2589 bsrr->association = assoc;
2590 bsrr->referenceId = req->referenceId;
2591 bsrr->srw_sortKeys = 0;
2592 bsrr->srw_setname = 0;
2593 bsrr->srw_setnameIdleTime = 0;
2594 bsrr->estimated_hit_count = 0;
2595 bsrr->partial_resultset = 0;
2596 bsrr->extra_args = 0;
2597 bsrr->extra_response_data = 0;
2599 yaz_log (log_requestdetail, "ResultSet '%s'", req->resultSetName);
2600 if (req->databaseNames)
2603 for (i = 0; i < req->num_databaseNames; i++)
2604 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2607 yaz_log_zquery_level(log_requestdetail,req->query);
2609 if (assoc->init->bend_search)
2611 bsrr->setname = req->resultSetName;
2612 bsrr->replace_set = *req->replaceIndicator;
2613 bsrr->num_bases = req->num_databaseNames;
2614 bsrr->basenames = req->databaseNames;
2615 bsrr->query = req->query;
2616 bsrr->stream = assoc->encode;
2617 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2618 bsrr->decode = assoc->decode;
2619 bsrr->print = assoc->print;
2622 bsrr->errstring = NULL;
2623 bsrr->search_info = NULL;
2624 bsrr->search_input = req->otherInfo;
2626 if (assoc->server && assoc->server->cql_transform
2627 && req->query->which == Z_Query_type_104
2628 && req->query->u.type_104->which == Z_External_CQL)
2630 /* have a CQL query and a CQL to PQF transform .. */
2632 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2633 assoc->server->cql_transform, bsrr->query);
2635 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2638 if (assoc->server && assoc->server->ccl_transform
2639 && req->query->which == Z_Query_type_2) /*CCL*/
2641 /* have a CCL query and a CCL to PQF transform .. */
2643 ccl2pqf(bsrr->stream, req->query->u.type_2,
2644 assoc->server->ccl_transform, bsrr);
2646 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2650 (assoc->init->bend_search)(assoc->backend, bsrr);
2654 /* FIXME - make a diagnostic for it */
2655 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2657 return response_searchRequest(assoc, reqb, bsrr);
2661 * Prepare a searchresponse based on the backend results. We probably want
2662 * to look at making the fetching of records nonblocking as well, but
2663 * so far, we'll keep things simple.
2664 * If bsrt is null, that means we're called in response to a communications
2665 * event, and we'll have to get the response for ourselves.
2667 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2668 bend_search_rr *bsrt)
2670 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2671 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2672 Z_SearchResponse *resp = (Z_SearchResponse *)
2673 odr_malloc(assoc->encode, sizeof(*resp));
2674 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2675 Odr_int *next = odr_intdup(assoc->encode, 0);
2676 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2677 Odr_int returnedrecs = 0;
2679 apdu->which = Z_APDU_searchResponse;
2680 apdu->u.searchResponse = resp;
2681 resp->referenceId = req->referenceId;
2682 resp->additionalSearchInfo = 0;
2683 resp->otherInfo = 0;
2686 yaz_log(YLOG_FATAL, "Bad result from backend");
2689 else if (bsrt->errcode)
2691 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2692 resp->resultCount = nulint;
2693 resp->numberOfRecordsReturned = nulint;
2694 resp->nextResultSetPosition = nulint;
2695 resp->searchStatus = odr_booldup(assoc->encode, 0);
2696 resp->resultSetStatus = none;
2697 resp->presentStatus = 0;
2701 bool_t *sr = odr_booldup(assoc->encode, 1);
2702 Odr_int *toget = odr_intdup(assoc->encode, 0);
2703 Z_RecordComposition comp, *compp = 0;
2705 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2708 resp->resultCount = &bsrt->hits;
2710 comp.which = Z_RecordComp_simple;
2711 /* how many records does the user agent want, then? */
2714 else if (bsrt->hits <= *req->smallSetUpperBound)
2716 *toget = bsrt->hits;
2717 if ((comp.u.simple = req->smallSetElementSetNames))
2720 else if (bsrt->hits < *req->largeSetLowerBound)
2722 *toget = *req->mediumSetPresentNumber;
2723 if (*toget > bsrt->hits)
2724 *toget = bsrt->hits;
2725 if ((comp.u.simple = req->mediumSetElementSetNames))
2731 if (*toget && !resp->records)
2733 Odr_int *presst = odr_intdup(assoc->encode, 0);
2734 /* Call bend_present if defined */
2735 if (assoc->init->bend_present)
2737 bend_present_rr *bprr = (bend_present_rr *)
2738 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2739 bprr->setname = req->resultSetName;
2741 bprr->number = odr_int_to_int(*toget);
2742 bprr->format = req->preferredRecordSyntax;
2744 bprr->referenceId = req->referenceId;
2745 bprr->stream = assoc->encode;
2746 bprr->print = assoc->print;
2747 bprr->association = assoc;
2749 bprr->errstring = NULL;
2750 (*assoc->init->bend_present)(assoc->backend, bprr);
2754 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2755 *resp->presentStatus = Z_PresentStatus_failure;
2760 resp->records = pack_records(
2761 assoc, req->resultSetName, 1,
2762 toget, compp, next, presst, req->referenceId,
2763 req->preferredRecordSyntax, NULL);
2766 resp->numberOfRecordsReturned = toget;
2767 returnedrecs = *toget;
2768 resp->presentStatus = presst;
2772 if (*resp->resultCount)
2774 resp->numberOfRecordsReturned = nulint;
2775 resp->presentStatus = 0;
2777 resp->nextResultSetPosition = next;
2778 resp->searchStatus = sr;
2779 resp->resultSetStatus = 0;
2780 if (bsrt->estimated_hit_count)
2782 resp->resultSetStatus = odr_intdup(assoc->encode,
2783 Z_SearchResponse_estimate);
2785 else if (bsrt->partial_resultset)
2787 resp->resultSetStatus = odr_intdup(assoc->encode,
2788 Z_SearchResponse_subset);
2791 resp->additionalSearchInfo = bsrt->search_info;
2796 WRBUF wr = wrbuf_alloc();
2798 for (i = 0 ; i < req->num_databaseNames; i++)
2801 wrbuf_printf(wr, "+");
2802 wrbuf_puts(wr, req->databaseNames[i]);
2804 wrbuf_printf(wr, " ");
2807 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2809 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2810 wrbuf_printf(wr, " %s 1+" ODR_INT_PRINTF " ",
2811 req->resultSetName, returnedrecs);
2812 yaz_query_to_wrbuf(wr, req->query);
2814 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2821 * Maybe we got a little over-friendly when we designed bend_fetch to
2822 * get only one record at a time. Some backends can optimise multiple-record
2823 * fetches, and at any rate, there is some overhead involved in
2824 * all that selecting and hopping around. Problem is, of course, that the
2825 * frontend can't know ahead of time how many records it'll need to
2826 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2827 * is downright lousy as a bulk data transfer protocol.
2829 * To start with, we'll do the fetching of records from the backend
2830 * in one operation: To save some trips in and out of the event-handler,
2831 * and to simplify the interface to pack_records. At any rate, asynch
2832 * operation is more fun in operations that have an unpredictable execution
2833 * speed - which is normally more true for search than for present.
2835 static Z_APDU *process_presentRequest(association *assoc, request *reqb)
2837 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2839 Z_PresentResponse *resp;
2843 const char *errstring = 0;
2845 yaz_log(log_requestdetail, "Got PresentRequest.");
2847 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2849 resp->presentStatus = odr_intdup(assoc->encode, 0);
2850 if (assoc->init->bend_present)
2852 bend_present_rr *bprr = (bend_present_rr *)
2853 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2854 bprr->setname = req->resultSetId;
2855 bprr->start = odr_int_to_int(*req->resultSetStartPoint);
2856 bprr->number = odr_int_to_int(*req->numberOfRecordsRequested);
2857 bprr->format = req->preferredRecordSyntax;
2858 bprr->comp = req->recordComposition;
2859 bprr->referenceId = req->referenceId;
2860 bprr->stream = assoc->encode;
2861 bprr->print = assoc->print;
2862 bprr->association = assoc;
2864 bprr->errstring = NULL;
2865 (*assoc->init->bend_present)(assoc->backend, bprr);
2869 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2870 *resp->presentStatus = Z_PresentStatus_failure;
2871 errcode = bprr->errcode;
2872 errstring = bprr->errstring;
2875 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2876 next = odr_intdup(assoc->encode, 0);
2877 num = odr_intdup(assoc->encode, 0);
2879 apdu->which = Z_APDU_presentResponse;
2880 apdu->u.presentResponse = resp;
2881 resp->referenceId = req->referenceId;
2882 resp->otherInfo = 0;
2886 *num = *req->numberOfRecordsRequested;
2888 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2889 num, req->recordComposition, next,
2890 resp->presentStatus,
2891 req->referenceId, req->preferredRecordSyntax,
2896 WRBUF wr = wrbuf_alloc();
2897 wrbuf_printf(wr, "Present ");
2899 if (*resp->presentStatus == Z_PresentStatus_failure)
2900 wrbuf_printf(wr, "ERROR %d ", errcode);
2901 else if (*resp->presentStatus == Z_PresentStatus_success)
2902 wrbuf_printf(wr, "OK - ");
2904 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2905 *resp->presentStatus);
2907 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2908 req->resultSetId, *req->resultSetStartPoint,
2909 *req->numberOfRecordsRequested);
2910 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2915 resp->numberOfRecordsReturned = num;
2916 resp->nextResultSetPosition = next;
2922 * Scan was implemented rather in a hurry, and with support for only the basic
2923 * elements of the service in the backend API. Suggestions are welcome.
2925 static Z_APDU *process_scanRequest(association *assoc, request *reqb)
2927 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2928 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2929 Z_ScanResponse *res = (Z_ScanResponse *)
2930 odr_malloc(assoc->encode, sizeof(*res));
2931 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2932 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2933 Z_ListEntries *ents = (Z_ListEntries *)
2934 odr_malloc(assoc->encode, sizeof(*ents));
2935 Z_DiagRecs *diagrecs_p = NULL;
2936 bend_scan_rr *bsrr = (bend_scan_rr *)
2937 odr_malloc(assoc->encode, sizeof(*bsrr));
2938 struct scan_entry *save_entries;
2941 yaz_log(log_requestdetail, "Got ScanRequest");
2943 apdu->which = Z_APDU_scanResponse;
2944 apdu->u.scanResponse = res;
2945 res->referenceId = req->referenceId;
2947 /* if step is absent, set it to 0 */
2949 step_size = odr_int_to_int(*req->stepSize);
2951 res->scanStatus = scanStatus;
2952 res->numberOfEntriesReturned = numberOfEntriesReturned;
2953 res->positionOfTerm = 0;
2954 res->entries = ents;
2955 ents->num_entries = 0;
2956 ents->entries = NULL;
2957 ents->num_nonsurrogateDiagnostics = 0;
2958 ents->nonsurrogateDiagnostics = NULL;
2959 res->attributeSet = 0;
2962 if (req->databaseNames)
2965 for (i = 0; i < req->num_databaseNames; i++)
2966 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2968 bsrr->scanClause = 0;
2970 bsrr->errstring = 0;
2971 bsrr->num_bases = req->num_databaseNames;
2972 bsrr->basenames = req->databaseNames;
2973 bsrr->num_entries = odr_int_to_int(*req->numberOfTermsRequested);
2974 bsrr->term = req->termListAndStartPoint;
2975 bsrr->referenceId = req->referenceId;
2976 bsrr->stream = assoc->encode;
2977 bsrr->print = assoc->print;
2978 bsrr->step_size = &step_size;
2979 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
2980 yaz_oid_userinfo_scan_set, 1, 0);
2982 /* For YAZ 2.0 and earlier it was the backend handler that
2983 initialized entries (member display_term did not exist)
2984 YAZ 2.0 and later sets 'entries' and initialize all members
2985 including 'display_term'. If YAZ 2.0 or later sees that
2986 entries was modified - we assume that it is an old handler and
2987 that 'display_term' is _not_ set.
2989 if (bsrr->num_entries > 0)
2992 bsrr->entries = (struct scan_entry *)
2993 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
2995 for (i = 0; i<bsrr->num_entries; i++)
2997 bsrr->entries[i].term = 0;
2998 bsrr->entries[i].occurrences = 0;
2999 bsrr->entries[i].errcode = 0;
3000 bsrr->entries[i].errstring = 0;
3001 bsrr->entries[i].display_term = 0;
3004 save_entries = bsrr->entries; /* save it so we can compare later */
3006 bsrr->attributeset = req->attributeSet;
3007 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3008 bsrr->attributeset);
3009 bsrr->term_position = req->preferredPositionInResponse ?
3010 odr_int_to_int(*req->preferredPositionInResponse) : 1;
3012 ((int (*)(void *, bend_scan_rr *))
3013 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3016 diagrecs_p = zget_DiagRecs(assoc->encode,
3017 bsrr->errcode, bsrr->errstring);
3021 Z_Entry **tab = (Z_Entry **)
3022 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3024 if (bsrr->status == BEND_SCAN_PARTIAL)
3025 *scanStatus = Z_Scan_partial_5;
3027 *scanStatus = Z_Scan_success;
3028 res->stepSize = odr_intdup(assoc->encode, step_size);
3029 ents->entries = tab;
3030 ents->num_entries = bsrr->num_entries;
3031 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3033 res->positionOfTerm = odr_intdup(assoc->encode, bsrr->term_position);
3034 for (i = 0; i < bsrr->num_entries; i++)
3040 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3041 if (bsrr->entries[i].occurrences >= 0)
3043 e->which = Z_Entry_termInfo;
3044 e->u.termInfo = t = (Z_TermInfo *)
3045 odr_malloc(assoc->encode, sizeof(*t));
3046 t->suggestedAttributes = 0;
3048 if (save_entries == bsrr->entries &&
3049 bsrr->entries[i].display_term)
3051 /* the entries was _not_ set by the handler. So it's
3052 safe to test for new member display_term. It is
3055 t->displayTerm = odr_strdup(assoc->encode,
3056 bsrr->entries[i].display_term);
3058 t->alternativeTerm = 0;
3059 t->byAttributes = 0;
3060 t->otherTermInfo = 0;
3061 t->globalOccurrences = &bsrr->entries[i].occurrences;
3062 t->term = (Z_Term *)
3063 odr_malloc(assoc->encode, sizeof(*t->term));
3064 t->term->which = Z_Term_general;
3065 t->term->u.general = o =
3066 (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
3067 o->buf = (unsigned char *)
3068 odr_malloc(assoc->encode, o->len = o->size =
3069 strlen(bsrr->entries[i].term));
3070 memcpy(o->buf, bsrr->entries[i].term, o->len);
3071 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3072 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3076 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3077 bsrr->entries[i].errcode,
3078 bsrr->entries[i].errstring);
3079 assert(drecs->num_diagRecs == 1);
3080 e->which = Z_Entry_surrogateDiagnostic;
3081 assert(drecs->diagRecs[0]);
3082 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3088 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3089 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3094 WRBUF wr = wrbuf_alloc();
3095 wrbuf_printf(wr, "Scan ");
3096 for (i = 0 ; i < req->num_databaseNames; i++)
3099 wrbuf_printf(wr, "+");
3100 wrbuf_puts(wr, req->databaseNames[i]);
3103 wrbuf_printf(wr, " ");
3106 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3108 wrbuf_printf(wr, "OK");
3110 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3111 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3112 res->numberOfEntriesReturned ?
3113 *res->numberOfEntriesReturned : 0,
3114 (req->preferredPositionInResponse ?
3115 *req->preferredPositionInResponse : 1),
3116 *req->numberOfTermsRequested,
3117 (res->stepSize ? *res->stepSize : 1));
3120 wrbuf_printf(wr, "+%s", bsrr->setname);
3122 wrbuf_printf(wr, " ");
3123 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3124 bsrr->attributeset);
3125 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3131 static Z_APDU *process_sortRequest(association *assoc, request *reqb)
3134 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3135 Z_SortResponse *res = (Z_SortResponse *)
3136 odr_malloc(assoc->encode, sizeof(*res));
3137 bend_sort_rr *bsrr = (bend_sort_rr *)
3138 odr_malloc(assoc->encode, sizeof(*bsrr));
3140 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3142 yaz_log(log_requestdetail, "Got SortRequest.");
3144 bsrr->num_input_setnames = req->num_inputResultSetNames;
3145 for (i=0;i<req->num_inputResultSetNames;i++)
3146 yaz_log(log_requestdetail, "Input resultset: '%s'",
3147 req->inputResultSetNames[i]);
3148 bsrr->input_setnames = req->inputResultSetNames;
3149 bsrr->referenceId = req->referenceId;
3150 bsrr->output_setname = req->sortedResultSetName;
3151 yaz_log(log_requestdetail, "Output resultset: '%s'",
3152 req->sortedResultSetName);
3153 bsrr->sort_sequence = req->sortSequence;
3154 /*FIXME - dump those sequences too */
3155 bsrr->stream = assoc->encode;
3156 bsrr->print = assoc->print;
3158 bsrr->sort_status = Z_SortResponse_failure;
3160 bsrr->errstring = 0;
3162 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3164 res->referenceId = bsrr->referenceId;
3165 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3166 res->resultSetStatus = 0;
3169 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3170 bsrr->errcode, bsrr->errstring);
3171 res->diagnostics = dr->diagRecs;
3172 res->num_diagnostics = dr->num_diagRecs;
3176 res->num_diagnostics = 0;
3177 res->diagnostics = 0;
3179 res->resultCount = 0;
3182 apdu->which = Z_APDU_sortResponse;
3183 apdu->u.sortResponse = res;
3186 WRBUF wr = wrbuf_alloc();
3187 wrbuf_printf(wr, "Sort ");
3189 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3191 wrbuf_printf(wr, "OK -");
3192 wrbuf_printf(wr, " (");
3193 for (i = 0; i<req->num_inputResultSetNames; i++)
3196 wrbuf_printf(wr, "+");
3197 wrbuf_puts(wr, req->inputResultSetNames[i]);
3199 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3201 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3207 static Z_APDU *process_deleteRequest(association *assoc, request *reqb)
3210 Z_DeleteResultSetRequest *req =
3211 reqb->apdu_request->u.deleteResultSetRequest;
3212 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3213 odr_malloc(assoc->encode, sizeof(*res));
3214 bend_delete_rr *bdrr = (bend_delete_rr *)
3215 odr_malloc(assoc->encode, sizeof(*bdrr));
3216 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3218 yaz_log(log_requestdetail, "Got DeleteRequest.");
3220 bdrr->num_setnames = req->num_resultSetList;
3221 bdrr->setnames = req->resultSetList;
3222 for (i = 0; i<req->num_resultSetList; i++)
3223 yaz_log(log_requestdetail, "resultset: '%s'",
3224 req->resultSetList[i]);
3225 bdrr->stream = assoc->encode;
3226 bdrr->print = assoc->print;
3227 bdrr->function = odr_int_to_int(*req->deleteFunction);
3228 bdrr->referenceId = req->referenceId;
3230 if (bdrr->num_setnames > 0)
3232 bdrr->statuses = (int*)
3233 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3234 bdrr->num_setnames);
3235 for (i = 0; i < bdrr->num_setnames; i++)
3236 bdrr->statuses[i] = 0;
3238 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3240 res->referenceId = req->referenceId;
3242 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3244 res->deleteListStatuses = 0;
3245 if (bdrr->num_setnames > 0)
3248 res->deleteListStatuses = (Z_ListStatuses *)
3249 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3250 res->deleteListStatuses->num = bdrr->num_setnames;
3251 res->deleteListStatuses->elements =
3253 odr_malloc(assoc->encode,
3254 sizeof(*res->deleteListStatuses->elements) *
3255 bdrr->num_setnames);
3256 for (i = 0; i<bdrr->num_setnames; i++)
3258 res->deleteListStatuses->elements[i] =
3260 odr_malloc(assoc->encode,
3261 sizeof(**res->deleteListStatuses->elements));
3262 res->deleteListStatuses->elements[i]->status =
3263 odr_intdup(assoc->encode, bdrr->statuses[i]);
3264 res->deleteListStatuses->elements[i]->id =
3265 odr_strdup(assoc->encode, bdrr->setnames[i]);
3268 res->numberNotDeleted = 0;
3269 res->bulkStatuses = 0;
3270 res->deleteMessage = 0;
3273 apdu->which = Z_APDU_deleteResultSetResponse;
3274 apdu->u.deleteResultSetResponse = res;
3277 WRBUF wr = wrbuf_alloc();
3278 wrbuf_printf(wr, "Delete ");
3279 if (bdrr->delete_status)
3280 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3282 wrbuf_printf(wr, "OK -");
3283 for (i = 0; i<req->num_resultSetList; i++)
3284 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3285 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3291 static void process_close(association *assoc, request *reqb)
3293 Z_Close *req = reqb->apdu_request->u.close;
3294 static char *reasons[] =
3301 "securityViolation",
3308 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3309 reasons[*req->closeReason], req->diagnosticInformation ?
3310 req->diagnosticInformation : "NULL");
3311 if (assoc->version < 3) /* to make do_force respond with close */
3313 do_close_req(assoc, Z_Close_finished,
3314 "Association terminated by client", reqb);
3315 yaz_log(log_request,"Close OK");
3318 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3320 bend_segment_rr req;
3322 req.segment = reqb->apdu_request->u.segmentRequest;
3323 req.stream = assoc->encode;
3324 req.decode = assoc->decode;
3325 req.print = assoc->print;
3326 req.association = assoc;
3328 (*assoc->init->bend_segment)(assoc->backend, &req);
3333 static Z_APDU *process_ESRequest(association *assoc, request *reqb)
3335 bend_esrequest_rr esrequest;
3336 const char *ext_name = "unknown";
3338 Z_ExtendedServicesRequest *req =
3339 reqb->apdu_request->u.extendedServicesRequest;
3340 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3342 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3344 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3345 esrequest.stream = assoc->encode;
3346 esrequest.decode = assoc->decode;
3347 esrequest.print = assoc->print;
3348 esrequest.errcode = 0;
3349 esrequest.errstring = NULL;
3350 esrequest.association = assoc;
3351 esrequest.taskPackage = 0;
3352 esrequest.referenceId = req->referenceId;
3354 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3356 switch(esrequest.esr->taskSpecificParameters->which)
3358 case Z_External_itemOrder:
3359 ext_name = "ItemOrder"; break;
3360 case Z_External_update:
3361 ext_name = "Update"; break;
3362 case Z_External_update0:
3363 ext_name = "Update0"; break;
3364 case Z_External_ESAdmin:
3365 ext_name = "Admin"; break;
3370 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3372 resp->referenceId = req->referenceId;
3374 if (esrequest.errcode == -1)
3376 /* Backend service indicates request will be processed */
3377 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3378 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3380 else if (esrequest.errcode == 0)
3382 /* Backend service indicates request will be processed */
3383 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3384 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3388 Z_DiagRecs *diagRecs =
3389 zget_DiagRecs(assoc->encode, esrequest.errcode,
3390 esrequest.errstring);
3391 /* Backend indicates error, request will not be processed */
3392 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3393 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3394 resp->num_diagnostics = diagRecs->num_diagRecs;
3395 resp->diagnostics = diagRecs->diagRecs;
3398 WRBUF wr = wrbuf_alloc();
3399 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3400 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3405 /* Do something with the members of bend_extendedservice */
3406 if (esrequest.taskPackage)
3408 resp->taskPackage = z_ext_record_oid(
3409 assoc->encode, yaz_oid_recsyn_extended,
3410 (const char *) esrequest.taskPackage, -1);
3412 yaz_log(YLOG_DEBUG,"Send the result apdu");
3416 int bend_assoc_is_alive(bend_association assoc)
3418 if (assoc->state == ASSOC_DEAD)
3419 return 0; /* already marked as dead. Don't check I/O chan anymore */
3421 return iochan_is_alive(assoc->client_chan);
3428 * c-file-style: "Stroustrup"
3429 * indent-tabs-mode: nil
3431 * vim: shiftwidth=4 tabstop=8 expandtab