1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2013 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/facet.h>
60 #include <yaz/xmalloc.h>
61 #include <yaz/comstack.h>
65 #include <yaz/proto.h>
66 #include <yaz/oid_db.h>
68 #include <yaz/logrpn.h>
69 #include <yaz/querytowrbuf.h>
70 #include <yaz/statserv.h>
71 #include <yaz/diagbib1.h>
72 #include <yaz/charneg.h>
73 #include <yaz/otherinfo.h>
74 #include <yaz/yaz-util.h>
75 #include <yaz/pquery.h>
76 #include <yaz/oid_db.h>
79 #include <yaz/backend.h>
80 #include <yaz/yaz-ccl.h>
82 static void process_gdu_request(association *assoc, request *req);
83 static int process_z_request(association *assoc, request *req, char **msg);
84 static int process_gdu_response(association *assoc, request *req, Z_GDU *res);
85 static int process_z_response(association *assoc, request *req, Z_APDU *res);
86 static Z_APDU *process_initRequest(association *assoc, request *reqb);
87 static Z_External *init_diagnostics(ODR odr, int errcode,
88 const char *errstring);
89 static Z_APDU *process_searchRequest(association *assoc, request *reqb);
90 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
91 bend_search_rr *bsrr);
92 static Z_APDU *process_presentRequest(association *assoc, request *reqb);
93 static Z_APDU *process_scanRequest(association *assoc, request *reqb);
94 static Z_APDU *process_sortRequest(association *assoc, request *reqb);
95 static void process_close(association *assoc, request *reqb);
96 static Z_APDU *process_deleteRequest(association *assoc, request *reqb);
97 static Z_APDU *process_segmentRequest(association *assoc, request *reqb);
98 static Z_APDU *process_ESRequest(association *assoc, request *reqb);
100 /* dynamic logging levels */
101 static int logbits_set = 0;
102 static int log_session = 0; /* one-line logs for session */
103 static int log_sessiondetail = 0; /* more detailed stuff */
104 static int log_request = 0; /* one-line logs for requests */
105 static int log_requestdetail = 0; /* more detailed stuff */
107 /** get_logbits sets global loglevel bits */
108 static void get_logbits(void)
109 { /* needs to be called after parsing cmd-line args that can set loglevels!*/
113 log_session = yaz_log_module_level("session");
114 log_sessiondetail = yaz_log_module_level("sessiondetail");
115 log_request = yaz_log_module_level("request");
116 log_requestdetail = yaz_log_module_level("requestdetail");
120 static void wr_diag(WRBUF w, int error, const char *addinfo)
122 wrbuf_printf(w, "ERROR %d+", error);
123 wrbuf_puts_replace_char(w, diagbib1_str(error), ' ', '_');
127 wrbuf_puts_replace_char(w, addinfo, ' ', '_');
132 static int odr_int_to_int(Odr_int v)
136 else if (v <= INT_MIN)
143 * Create and initialize a new association-handle.
144 * channel : iochannel for the current line.
145 * link : communications channel.
146 * Returns: 0 or a new association handle.
148 association *create_association(IOCHAN channel, COMSTACK link,
149 const char *apdufile)
155 if (!(anew = (association *)xmalloc(sizeof(*anew))))
159 anew->last_control = 0;
160 anew->client_chan = channel;
161 anew->client_link = link;
162 anew->cs_get_mask = 0;
163 anew->cs_put_mask = 0;
164 anew->cs_accept_mask = 0;
165 if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
166 !(anew->encode = odr_createmem(ODR_ENCODE)))
168 if (apdufile && *apdufile)
172 if (!(anew->print = odr_createmem(ODR_PRINT)))
174 if (*apdufile == '@')
176 odr_setprint(anew->print, yaz_log_file());
178 else if (*apdufile != '-')
181 sprintf(filename, "%.200s.%ld", apdufile, (long)getpid());
182 if (!(f = fopen(filename, "w")))
184 yaz_log(YLOG_WARN|YLOG_ERRNO, "%s", filename);
187 setvbuf(f, 0, _IONBF, 0);
188 odr_setprint(anew->print, f);
193 anew->input_buffer = 0;
194 anew->input_buffer_len = 0;
196 anew->state = ASSOC_NEW;
197 request_initq(&anew->incoming);
198 request_initq(&anew->outgoing);
199 anew->proto = cs_getproto(link);
205 * Free association and release resources.
207 void destroy_association(association *h)
209 statserv_options_block *cb = statserv_getcontrol();
213 odr_destroy(h->decode);
214 odr_destroy(h->encode);
216 odr_destroy(h->print);
218 xfree(h->input_buffer);
220 (*cb->bend_close)(h->backend);
221 while ((req = request_deq(&h->incoming)))
222 request_release(req);
223 while ((req = request_deq(&h->outgoing)))
224 request_release(req);
225 request_delq(&h->incoming);
226 request_delq(&h->outgoing);
228 xmalloc_trav("session closed");
231 static void do_close_req(association *a, int reason, char *message,
234 Z_APDU *apdu = zget_APDU(a->encode, Z_APDU_close);
235 Z_Close *cls = apdu->u.close;
237 /* Purge request queue */
238 while (request_deq(&a->incoming));
239 while (request_deq(&a->outgoing));
242 yaz_log(log_requestdetail, "Sending Close PDU, reason=%d, message=%s",
243 reason, message ? message : "none");
244 *cls->closeReason = reason;
245 cls->diagnosticInformation = message;
246 process_z_response(a, req, apdu);
247 iochan_settimeout(a->client_chan, 20);
251 request_release(req);
252 yaz_log(log_requestdetail, "v2 client. No Close PDU");
253 iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
256 a->state = ASSOC_DEAD;
259 static void do_close(association *a, int reason, char *message)
261 request *req = request_get(&a->outgoing);
262 do_close_req(a, reason, message, req);
266 int ir_read(IOCHAN h, int event)
268 association *assoc = (association *)iochan_getdata(h);
269 COMSTACK conn = assoc->client_link;
272 if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
274 /* We aren't speaking to this fellow */
275 if (assoc->state == ASSOC_DEAD)
277 yaz_log(log_session, "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 assoc->state = ASSOC_DEAD;
301 yaz_log(log_session, "Connection closed by client");
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 request_deq(&assoc->outgoing);
449 request_release(req);
450 if (!request_head(&assoc->outgoing))
451 { /* restore mask for cs_get operation ... */
452 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
453 iochan_setflag(h, assoc->cs_get_mask);
454 if (assoc->state == ASSOC_DEAD)
455 iochan_setevent(assoc->client_chan, EVENT_TIMEOUT);
459 assoc->cs_put_mask = EVENT_OUTPUT;
463 if (conn->io_pending & CS_WANT_WRITE)
464 assoc->cs_put_mask |= EVENT_OUTPUT;
465 if (conn->io_pending & CS_WANT_READ)
466 assoc->cs_put_mask |= EVENT_INPUT;
467 iochan_setflag(h, assoc->cs_put_mask);
470 if (event & EVENT_EXCEPT)
472 yaz_log(YLOG_WARN, "ir_session (exception)");
474 destroy_association(assoc);
479 static int process_z_request(association *assoc, request *req, char **msg);
482 static void assoc_init_reset(association *assoc)
485 assoc->init = (bend_initrequest *) xmalloc(sizeof(*assoc->init));
487 assoc->init->stream = assoc->encode;
488 assoc->init->print = assoc->print;
489 assoc->init->auth = 0;
490 assoc->init->referenceId = 0;
491 assoc->init->implementation_version = 0;
492 assoc->init->implementation_id = 0;
493 assoc->init->implementation_name = 0;
494 assoc->init->query_charset = 0;
495 assoc->init->records_in_same_charset = 0;
496 assoc->init->bend_sort = NULL;
497 assoc->init->bend_search = NULL;
498 assoc->init->bend_present = NULL;
499 assoc->init->bend_esrequest = NULL;
500 assoc->init->bend_delete = NULL;
501 assoc->init->bend_scan = NULL;
502 assoc->init->bend_segment = NULL;
503 assoc->init->bend_fetch = NULL;
504 assoc->init->bend_explain = NULL;
505 assoc->init->bend_srw_scan = NULL;
506 assoc->init->bend_srw_update = NULL;
507 assoc->init->named_result_sets = 0;
509 assoc->init->charneg_request = NULL;
510 assoc->init->charneg_response = NULL;
512 assoc->init->decode = assoc->decode;
513 assoc->init->peer_name =
514 odr_strdup(assoc->encode, cs_addrstr(assoc->client_link));
516 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
519 static int srw_bend_init(association *assoc, Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
521 statserv_options_block *cb = statserv_getcontrol();
524 const char *encoding = "UTF-8";
526 bend_initresult *binitres;
528 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
529 assoc_init_reset(assoc);
533 Z_IdAuthentication *auth = (Z_IdAuthentication *)
534 odr_malloc(assoc->decode, sizeof(*auth));
537 len = strlen(sr->username) + 1;
539 len += strlen(sr->password) + 2;
540 yaz_log(log_requestdetail, "username=%s password-len=%ld",
542 (sr->password ? strlen(sr->password) : 0));
543 auth->which = Z_IdAuthentication_open;
544 auth->u.open = (char *) odr_malloc(assoc->decode, len);
545 strcpy(auth->u.open, sr->username);
546 if (sr->password && *sr->password)
548 strcat(auth->u.open, "/");
549 strcat(auth->u.open, sr->password);
551 assoc->init->auth = auth;
555 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
556 assoc->init->charneg_request = ce->u.charNeg3;
559 if (!(binitres = (*cb->bend_init)(assoc->init)))
561 assoc->state = ASSOC_DEAD;
562 yaz_add_srw_diagnostic(assoc->encode, d, num,
563 YAZ_SRW_AUTHENTICATION_ERROR, 0);
566 assoc->backend = binitres->handle;
567 assoc->init->auth = 0;
568 if (binitres->errcode)
570 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
571 assoc->state = ASSOC_DEAD;
572 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
573 binitres->errstring);
581 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
584 yaz_record_conv_t rc = 0;
585 const char *match_schema = 0;
586 Odr_oid *match_syntax = 0;
591 const char *input_schema = yaz_get_esn(rr->comp);
592 Odr_oid *input_syntax_raw = rr->request_format;
594 const char *backend_schema = 0;
595 Odr_oid *backend_syntax = 0;
597 r = yaz_retrieval_request(assoc->server->retrieval,
605 if (r == -1) /* error ? */
607 const char *details = yaz_retrieval_get_error(
608 assoc->server->retrieval);
610 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
612 rr->errstring = odr_strdup(rr->stream, details);
615 else if (r == 1 || r == 3)
617 const char *details = input_schema;
619 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
621 rr->errstring = odr_strdup(rr->stream, details);
626 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
627 if (input_syntax_raw)
629 char oidbuf[OID_STR_MAX];
630 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
631 rr->errstring = odr_strdup(rr->stream, oidbuf);
637 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
640 rr->request_format = backend_syntax;
642 (*assoc->init->bend_fetch)(assoc->backend, rr);
643 if (rc && rr->record && rr->errcode == 0)
644 { /* post conversion must take place .. */
645 WRBUF output_record = wrbuf_alloc();
647 const char *details = 0;
650 r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
652 details = yaz_record_conv_get_error(rc);
654 else if (rr->len == -1 && rr->output_format &&
655 !oid_oidcmp(rr->output_format, yaz_oid_recsyn_opac))
657 r = yaz_record_conv_opac_record(
658 rc, (Z_OPACRecord *) rr->record, output_record);
660 details = yaz_record_conv_get_error(rc);
662 if (r == 0 && match_syntax &&
663 !oid_oidcmp(match_syntax, yaz_oid_recsyn_opac))
665 yaz_marc_t mt = yaz_marc_create();
666 Z_OPACRecord *opac = 0;
667 if (yaz_xml_to_opac(mt, wrbuf_buf(output_record),
668 wrbuf_len(output_record),
669 &opac, 0 /* iconv */, rr->stream->mem, 0)
673 rr->record = (char *) opac;
677 details = "XML to OPAC conversion failed";
680 yaz_marc_destroy(mt);
684 rr->len = wrbuf_len(output_record);
685 rr->record = (char *) odr_malloc(rr->stream, rr->len);
686 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
690 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
692 rr->errstring = odr_strdup(rr->stream, details);
694 wrbuf_destroy(output_record);
697 rr->output_format = match_syntax;
699 rr->schema = odr_strdup(rr->stream, match_schema);
701 (*assoc->init->bend_fetch)(assoc->backend, rr);
706 static int srw_bend_fetch(association *assoc, int pos,
707 Z_SRW_searchRetrieveRequest *srw_req,
708 Z_SRW_record *record,
709 const char **addinfo, int *last_in_set)
712 ODR o = assoc->encode;
714 rr.setname = "default";
717 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
719 rr.comp = (Z_RecordComposition *)
720 odr_malloc(assoc->decode, sizeof(*rr.comp));
721 rr.comp->which = Z_RecordComp_complex;
722 rr.comp->u.complex = (Z_CompSpec *)
723 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
724 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
725 odr_malloc(assoc->encode, sizeof(bool_t));
726 *rr.comp->u.complex->selectAlternativeSyntax = 0;
727 rr.comp->u.complex->num_dbSpecific = 0;
728 rr.comp->u.complex->dbSpecific = 0;
729 rr.comp->u.complex->num_recordSyntax = 0;
730 rr.comp->u.complex->recordSyntax = 0;
732 rr.comp->u.complex->generic = (Z_Specification *)
733 odr_malloc(assoc->decode, sizeof(Z_Specification));
735 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
736 rr.comp->u.complex->generic->which = Z_Schema_uri;
737 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
739 /* ESN = recordSchema if recordSchema is present */
740 rr.comp->u.complex->generic->elementSpec = 0;
741 if (srw_req->recordSchema)
743 rr.comp->u.complex->generic->elementSpec =
744 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
745 rr.comp->u.complex->generic->elementSpec->which =
746 Z_ElementSpec_elementSetName;
747 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
748 srw_req->recordSchema;
751 rr.stream = assoc->encode;
752 rr.print = assoc->print;
760 rr.surrogate_flag = 0;
761 rr.schema = srw_req->recordSchema;
763 if (!assoc->init->bend_fetch)
766 retrieve_fetch(assoc, &rr);
768 *last_in_set = rr.last_in_set;
770 if (rr.errcode && rr.surrogate_flag)
772 int code = yaz_diag_bib1_to_srw(rr.errcode);
773 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
776 else if (rr.len >= 0)
778 record->recordData_buf = rr.record;
779 record->recordData_len = rr.len;
780 record->recordPosition = odr_intdup(o, pos);
781 record->recordSchema = odr_strdup_null(
782 o, rr.schema ? rr.schema : srw_req->recordSchema);
786 *addinfo = rr.errstring;
792 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
793 Z_Query *query_result, char **sortkeys_p)
795 /* have a CQL query and CQL to PQF transform .. */
796 CQL_parser cp = cql_parser_create();
800 WRBUF rpn_buf = wrbuf_alloc();
803 r = cql_parser_string(cp, cql);
806 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
810 struct cql_node *cn = cql_parser_result(cp);
813 r = cql_transform(ct, cn, wrbuf_vp_puts, rpn_buf);
815 srw_errcode = cql_transform_error(ct, &add);
819 int r = cql_sortby_to_sortkeys_buf(cn, out, sizeof(out)-1);
824 yaz_log(log_requestdetail, "srw_sortKeys '%s'", out);
825 *sortkeys_p = odr_strdup(odr, out);
829 yaz_log(log_requestdetail, "failed to create srw_sortKeys");
830 srw_errcode = YAZ_SRW_UNSUPP_SORT_TYPE;
836 /* Syntax & transform OK. */
837 /* Convert PQF string to Z39.50 to RPN query struct */
838 YAZ_PQF_Parser pp = yaz_pqf_create();
839 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, wrbuf_cstr(rpn_buf));
844 int code = yaz_pqf_error(pp, &pqf_msg, &off);
845 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
847 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
851 query_result->which = Z_Query_type_1;
852 query_result->u.type_1 = rpnquery;
856 cql_parser_destroy(cp);
857 wrbuf_destroy(rpn_buf);
861 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
862 Z_AttributesPlusTerm *result)
867 int srw_error = cql2pqf(odr, cql, ct, &query, &sortkeys);
870 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
871 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
872 rpn = query.u.type_1;
873 if (!rpn->RPNStructure)
874 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
875 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
876 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
877 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
878 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
879 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
885 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
886 bend_search_rr *bsrr)
889 struct ccl_rpn_node *node;
892 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
893 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0)
895 bsrr->errstring = (char*) ccl_err_msg(errcode);
896 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
899 bsrr->query->which = Z_Query_type_1;
900 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
904 static void srw_bend_search(association *assoc,
909 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
912 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
915 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
916 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
917 if (srw_res->num_diagnostics == 0 && assoc->init)
920 rr.setname = "default";
923 rr.basenames = &srw_req->database;
927 rr.srw_setnameIdleTime = 0;
928 rr.estimated_hit_count = 0;
929 rr.partial_resultset = 0;
930 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
931 rr.query->u.type_1 = 0;
932 rr.extra_args = sr->extra_args;
933 rr.extra_response_data = 0;
934 rr.present_number = srw_req->maximumRecords ?
935 *srw_req->maximumRecords : 0;
937 if (!srw_req->queryType || !strcmp(srw_req->queryType, "cql"))
939 if (assoc->server && assoc->server->cql_transform)
941 int srw_errcode = cql2pqf(assoc->encode, srw_req->query,
942 assoc->server->cql_transform,
948 yaz_add_srw_diagnostic(assoc->encode,
949 &srw_res->diagnostics,
950 &srw_res->num_diagnostics,
956 /* CQL query to backend. Wrap it - Z39.50 style */
957 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
958 ext->direct_reference = odr_getoidbystr(assoc->decode,
959 "1.2.840.10003.16.2");
960 ext->indirect_reference = 0;
962 ext->which = Z_External_CQL;
963 ext->u.cql = srw_req->query;
965 rr.query->which = Z_Query_type_104;
966 rr.query->u.type_104 = ext;
969 else if (!strcmp(srw_req->queryType, "pqf"))
971 Z_RPNQuery *RPNquery;
972 YAZ_PQF_Parser pqf_parser;
974 pqf_parser = yaz_pqf_create();
976 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode, srw_req->query);
981 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
982 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
983 code, pqf_msg, (long) off);
984 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
987 rr.query->which = Z_Query_type_1;
988 rr.query->u.type_1 = RPNquery;
990 yaz_pqf_destroy(pqf_parser);
994 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
995 &srw_res->num_diagnostics,
996 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
998 if (rr.query->u.type_1)
1000 rr.stream = assoc->encode;
1001 rr.decode = assoc->decode;
1002 rr.print = assoc->print;
1003 if (srw_req->sort.sortKeys)
1004 rr.srw_sortKeys = odr_strdup(assoc->encode,
1005 srw_req->sort.sortKeys);
1006 rr.association = assoc;
1011 rr.search_input = 0;
1013 if (srw_req->facetList)
1014 yaz_oi_set_facetlist(&rr.search_input, assoc->encode,
1015 srw_req->facetList);
1017 yaz_log_zquery_level(log_requestdetail,rr.query);
1019 (assoc->init->bend_search)(assoc->backend, &rr);
1022 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1028 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
1029 yaz_add_srw_diagnostic(assoc->encode,
1030 &srw_res->diagnostics,
1031 &srw_res->num_diagnostics,
1032 srw_error, rr.errstring);
1037 int number = srw_req->maximumRecords ?
1038 odr_int_to_int(*srw_req->maximumRecords) : 0;
1039 int start = srw_req->startRecord ?
1040 odr_int_to_int(*srw_req->startRecord) : 1;
1042 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
1044 start, number, rr.hits);
1046 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1049 srw_res->resultSetId =
1050 odr_strdup(assoc->encode, rr.srw_setname );
1051 srw_res->resultSetIdleTime =
1052 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1055 srw_res->facetList = yaz_oi_get_facetlist(&rr.search_info);
1056 if (start > rr.hits || start < 1)
1058 /* if hits<=0 and start=1 we don't return a diagnostic */
1060 yaz_add_srw_diagnostic(
1062 &srw_res->diagnostics, &srw_res->num_diagnostics,
1063 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1065 else if (number > 0)
1069 if (start + number > rr.hits)
1070 number = odr_int_to_int(rr.hits) - start + 1;
1072 /* Call bend_present if defined */
1073 if (assoc->init->bend_present)
1075 bend_present_rr *bprr = (bend_present_rr*)
1076 odr_malloc(assoc->decode, sizeof(*bprr));
1077 bprr->setname = "default";
1078 bprr->start = start;
1079 bprr->number = number;
1080 if (srw_req->recordSchema)
1082 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1083 sizeof(*bprr->comp));
1084 bprr->comp->which = Z_RecordComp_simple;
1085 bprr->comp->u.simple = (Z_ElementSetNames *)
1086 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1087 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1088 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1094 bprr->stream = assoc->encode;
1095 bprr->referenceId = 0;
1096 bprr->print = assoc->print;
1097 bprr->association = assoc;
1099 bprr->errstring = NULL;
1100 (*assoc->init->bend_present)(assoc->backend, bprr);
1104 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1105 yaz_add_srw_diagnostic(assoc->encode,
1106 &srw_res->diagnostics,
1107 &srw_res->num_diagnostics,
1108 srw_error, bprr->errstring);
1116 int packing = Z_SRW_recordPacking_string;
1117 if (srw_req->recordPacking)
1120 yaz_srw_str_to_pack(srw_req->recordPacking);
1122 packing = Z_SRW_recordPacking_string;
1124 srw_res->records = (Z_SRW_record *)
1125 odr_malloc(assoc->encode,
1126 number * sizeof(*srw_res->records));
1128 srw_res->extra_records = (Z_SRW_extra_record **)
1129 odr_malloc(assoc->encode,
1130 number*sizeof(*srw_res->extra_records));
1132 for (i = 0; i<number; i++)
1135 int last_in_set = 0;
1136 const char *addinfo = 0;
1138 srw_res->records[j].recordPacking = packing;
1139 srw_res->records[j].recordData_buf = 0;
1140 srw_res->extra_records[j] = 0;
1141 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1142 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1143 srw_res->records + j,
1144 &addinfo, &last_in_set);
1147 yaz_add_srw_diagnostic(assoc->encode,
1148 &srw_res->diagnostics,
1149 &srw_res->num_diagnostics,
1150 yaz_diag_bib1_to_srw(errcode),
1155 if (srw_res->records[j].recordData_buf)
1160 srw_res->num_records = j;
1162 srw_res->records = 0;
1165 if (rr.extra_response_data)
1167 res->extraResponseData_buf = rr.extra_response_data;
1168 res->extraResponseData_len = strlen(rr.extra_response_data);
1170 if (strcmp(res->srw_version, "2.") > 0)
1172 if (rr.estimated_hit_count)
1173 srw_res->resultCountPrecision =
1174 odr_strdup(assoc->encode, "estimate");
1175 else if (rr.partial_resultset)
1176 srw_res->resultCountPrecision =
1177 odr_strdup(assoc->encode, "minimum");
1179 srw_res->resultCountPrecision =
1180 odr_strdup(assoc->encode, "exact");
1182 else if (rr.estimated_hit_count || rr.partial_resultset)
1184 yaz_add_srw_diagnostic(
1186 &srw_res->diagnostics,
1187 &srw_res->num_diagnostics,
1188 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1196 WRBUF wr = wrbuf_alloc();
1198 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1199 if (srw_res->num_diagnostics)
1200 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1201 else if (*http_code != 200)
1202 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1203 else if (srw_res->numberOfRecords)
1205 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1206 (srw_res->numberOfRecords ?
1207 *srw_res->numberOfRecords : 0));
1209 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+%d",
1210 (srw_res->resultSetId ?
1211 srw_res->resultSetId : "-"),
1212 (srw_req->startRecord ? *srw_req->startRecord : 1),
1213 srw_res->num_records);
1214 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), srw_req->queryType,
1220 static char *srw_bend_explain_default(bend_explain_rr *rr)
1223 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1226 for (ptr = ptr->children; ptr; ptr = ptr->next)
1228 if (ptr->type != XML_ELEMENT_NODE)
1230 if (!strcmp((const char *) ptr->name, "explain"))
1233 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1237 ptr = xmlCopyNode(ptr, 1);
1239 xmlDocSetRootElement(doc, ptr);
1241 xmlDocDumpMemory(doc, &buf_out, &len);
1242 content = (char*) odr_malloc(rr->stream, 1+len);
1243 memcpy(content, buf_out, len);
1244 content[len] = '\0';
1248 rr->explain_buf = content;
1256 static void srw_bend_explain(association *assoc,
1258 Z_SRW_explainResponse *srw_res,
1261 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1262 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1263 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1264 if (!assoc->init && srw_res->num_diagnostics == 0)
1270 rr.stream = assoc->encode;
1271 rr.decode = assoc->decode;
1272 rr.print = assoc->print;
1274 rr.database = srw_req->database;
1276 rr.server_node_ptr = assoc->server->server_node_ptr;
1278 rr.server_node_ptr = 0;
1279 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1280 if (assoc->init->bend_explain)
1281 (*assoc->init->bend_explain)(assoc->backend, &rr);
1283 srw_bend_explain_default(&rr);
1287 int packing = Z_SRW_recordPacking_string;
1288 if (srw_req->recordPacking)
1291 yaz_srw_str_to_pack(srw_req->recordPacking);
1293 packing = Z_SRW_recordPacking_string;
1295 srw_res->record.recordSchema = rr.schema;
1296 srw_res->record.recordPacking = packing;
1297 srw_res->record.recordData_buf = rr.explain_buf;
1298 srw_res->record.recordData_len = strlen(rr.explain_buf);
1299 srw_res->record.recordPosition = 0;
1305 static void srw_bend_scan(association *assoc,
1310 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1311 Z_SRW_scanResponse *srw_res = res->u.scan_response;
1312 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1315 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1316 if (srw_res->num_diagnostics == 0 && assoc->init)
1319 struct scan_entry *save_entries;
1321 bend_scan_rr *bsrr = (bend_scan_rr *)
1322 odr_malloc(assoc->encode, sizeof(*bsrr));
1323 bsrr->num_bases = 1;
1324 bsrr->basenames = &srw_req->database;
1326 bsrr->num_entries = srw_req->maximumTerms ?
1327 odr_int_to_int(*srw_req->maximumTerms) : 10;
1328 bsrr->term_position = srw_req->responsePosition ?
1329 odr_int_to_int(*srw_req->responsePosition) : 1;
1332 bsrr->errstring = 0;
1333 bsrr->referenceId = 0;
1334 bsrr->stream = assoc->encode;
1335 bsrr->print = assoc->print;
1336 bsrr->step_size = &step_size;
1339 bsrr->extra_args = sr->extra_args;
1340 bsrr->extra_response_data = 0;
1342 if (bsrr->num_entries > 0)
1345 bsrr->entries = (struct scan_entry *)
1346 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1348 for (i = 0; i<bsrr->num_entries; i++)
1350 bsrr->entries[i].term = 0;
1351 bsrr->entries[i].occurrences = 0;
1352 bsrr->entries[i].errcode = 0;
1353 bsrr->entries[i].errstring = 0;
1354 bsrr->entries[i].display_term = 0;
1357 save_entries = bsrr->entries; /* save it so we can compare later */
1359 if (srw_req->queryType && !strcmp(srw_req->queryType, "pqf") &&
1360 assoc->init->bend_scan)
1362 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1364 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1365 &bsrr->attributeset,
1366 srw_req->scanClause);
1367 yaz_pqf_destroy(pqf_parser);
1368 bsrr->scanClause = 0;
1369 ((int (*)(void *, bend_scan_rr *))
1370 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1372 else if ((!srw_req->queryType || !strcmp(srw_req->queryType, "cql"))
1373 && assoc->init->bend_scan && assoc->server
1374 && assoc->server->cql_transform)
1377 bsrr->scanClause = 0;
1378 bsrr->attributeset = 0;
1379 bsrr->term = (Z_AttributesPlusTerm *)
1380 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1381 srw_error = cql2pqf_scan(assoc->encode,
1382 srw_req->scanClause,
1383 assoc->server->cql_transform,
1386 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1387 &srw_res->num_diagnostics,
1391 ((int (*)(void *, bend_scan_rr *))
1392 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1395 else if ((!srw_req->queryType || !strcmp(srw_req->queryType, "cql"))
1396 && assoc->init->bend_srw_scan)
1399 bsrr->attributeset = 0;
1400 bsrr->scanClause = srw_req->scanClause;
1401 ((int (*)(void *, bend_scan_rr *))
1402 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1406 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1407 &srw_res->num_diagnostics,
1408 YAZ_SRW_UNSUPP_OPERATION, "scan");
1410 if (bsrr->extra_response_data)
1412 res->extraResponseData_buf = bsrr->extra_response_data;
1413 res->extraResponseData_len = strlen(bsrr->extra_response_data);
1418 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1423 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1425 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1426 &srw_res->num_diagnostics,
1427 srw_error, bsrr->errstring);
1429 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1432 srw_res->terms = (Z_SRW_scanTerm*)
1433 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1436 srw_res->num_terms = bsrr->num_entries;
1437 for (i = 0; i<bsrr->num_entries; i++)
1439 Z_SRW_scanTerm *t = srw_res->terms + i;
1440 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1441 t->numberOfRecords =
1442 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1444 if (save_entries == bsrr->entries &&
1445 bsrr->entries[i].display_term)
1447 /* the entries was _not_ set by the handler. So it's
1448 safe to test for new member display_term. It is
1451 t->displayTerm = odr_strdup(assoc->encode,
1452 bsrr->entries[i].display_term);
1460 WRBUF wr = wrbuf_alloc();
1461 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1463 if (srw_res->num_diagnostics)
1464 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1465 else if (srw_res->num_terms)
1466 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1468 wrbuf_printf(wr, "OK - - ");
1470 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1471 (srw_req->responsePosition ?
1472 *srw_req->responsePosition : 1),
1473 (srw_req->maximumTerms ?
1474 *srw_req->maximumTerms : 1));
1475 /* there is no step size in SRU/W ??? */
1476 wrbuf_printf(wr, "%s: %s ", srw_req->queryType, srw_req->scanClause);
1477 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1483 static void srw_bend_update(association *assoc,
1485 Z_SRW_updateResponse *srw_res,
1488 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1489 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1490 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1491 srw_bend_init(assoc, &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1492 if (!assoc->init && srw_res->num_diagnostics == 0)
1497 Z_SRW_extra_record *extra = srw_req->extra_record;
1499 rr.stream = assoc->encode;
1500 rr.print = assoc->print;
1502 rr.basenames = &srw_req->database;
1503 rr.operation = srw_req->operation;
1504 rr.operation_status = "failed";
1506 rr.record_versions = 0;
1507 rr.num_versions = 0;
1508 rr.record_packing = "string";
1509 rr.record_schema = 0;
1511 rr.extra_record_data = 0;
1512 rr.extra_request_data = 0;
1513 rr.extra_response_data = 0;
1519 if (rr.operation == 0)
1521 yaz_add_sru_update_diagnostic(
1522 assoc->encode, &srw_res->diagnostics,
1523 &srw_res->num_diagnostics,
1524 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1528 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1529 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1530 if (!strcmp( rr.operation, "delete"))
1532 if (srw_req->record && !srw_req->record->recordSchema)
1534 rr.record_schema = odr_strdup(
1536 srw_req->record->recordSchema);
1538 if (srw_req->record)
1540 rr.record_data = odr_strdupn(
1542 srw_req->record->recordData_buf,
1543 srw_req->record->recordData_len );
1545 if (extra && extra->extraRecordData_len)
1547 rr.extra_record_data = odr_strdupn(
1549 extra->extraRecordData_buf,
1550 extra->extraRecordData_len );
1552 if (srw_req->recordId)
1553 rr.record_id = srw_req->recordId;
1554 else if (extra && extra->recordIdentifier)
1555 rr.record_id = extra->recordIdentifier;
1557 else if (!strcmp(rr.operation, "replace"))
1559 if (srw_req->recordId)
1560 rr.record_id = srw_req->recordId;
1561 else if (extra && extra->recordIdentifier)
1562 rr.record_id = extra->recordIdentifier;
1565 yaz_add_sru_update_diagnostic(
1566 assoc->encode, &srw_res->diagnostics,
1567 &srw_res->num_diagnostics,
1568 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1569 "recordIdentifier");
1571 if (!srw_req->record)
1573 yaz_add_sru_update_diagnostic(
1574 assoc->encode, &srw_res->diagnostics,
1575 &srw_res->num_diagnostics,
1576 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1581 if (srw_req->record->recordSchema)
1582 rr.record_schema = odr_strdup(
1583 assoc->encode, srw_req->record->recordSchema);
1584 if (srw_req->record->recordData_len )
1586 rr.record_data = odr_strdupn(assoc->encode,
1587 srw_req->record->recordData_buf,
1588 srw_req->record->recordData_len );
1592 yaz_add_sru_update_diagnostic(
1593 assoc->encode, &srw_res->diagnostics,
1594 &srw_res->num_diagnostics,
1595 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1599 if (extra && extra->extraRecordData_len)
1601 rr.extra_record_data = odr_strdupn(
1603 extra->extraRecordData_buf,
1604 extra->extraRecordData_len );
1607 else if (!strcmp(rr.operation, "insert"))
1609 if (srw_req->recordId)
1610 rr.record_id = srw_req->recordId;
1612 rr.record_id = extra->recordIdentifier;
1614 if (srw_req->record)
1616 if (srw_req->record->recordSchema)
1617 rr.record_schema = odr_strdup(
1618 assoc->encode, srw_req->record->recordSchema);
1620 if (srw_req->record->recordData_len)
1621 rr.record_data = odr_strdupn(
1623 srw_req->record->recordData_buf,
1624 srw_req->record->recordData_len );
1626 if (extra && extra->extraRecordData_len)
1628 rr.extra_record_data = odr_strdupn(
1630 extra->extraRecordData_buf,
1631 extra->extraRecordData_len );
1635 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1636 &srw_res->num_diagnostics,
1637 YAZ_SRU_UPDATE_INVALID_ACTION,
1640 if (srw_req->record)
1642 const char *pack_str =
1643 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1645 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1648 if (srw_req->num_recordVersions)
1650 rr.record_versions = srw_req->recordVersions;
1651 rr.num_versions = srw_req->num_recordVersions;
1653 if (srw_req->extraRequestData_len)
1655 rr.extra_request_data = odr_strdupn(assoc->encode,
1656 srw_req->extraRequestData_buf,
1657 srw_req->extraRequestData_len );
1659 if (srw_res->num_diagnostics == 0)
1661 if ( assoc->init->bend_srw_update)
1662 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1664 yaz_add_sru_update_diagnostic(
1665 assoc->encode, &srw_res->diagnostics,
1666 &srw_res->num_diagnostics,
1667 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1668 "No Update backend handler");
1672 yaz_add_srw_diagnostic_uri(assoc->encode,
1673 &srw_res->diagnostics,
1674 &srw_res->num_diagnostics,
1678 srw_res->recordId = rr.record_id;
1679 srw_res->operationStatus = rr.operation_status;
1680 srw_res->recordVersions = rr.record_versions;
1681 srw_res->num_recordVersions = rr.num_versions;
1682 if (srw_res->extraResponseData_len)
1684 srw_res->extraResponseData_buf = rr.extra_response_data;
1685 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1687 if (srw_res->num_diagnostics == 0 && rr.record_data)
1689 srw_res->record = yaz_srw_get_record(assoc->encode);
1690 srw_res->record->recordSchema = rr.record_schema;
1691 if (rr.record_packing)
1693 int pack = yaz_srw_str_to_pack(rr.record_packing);
1697 pack = Z_SRW_recordPacking_string;
1698 yaz_log(YLOG_WARN, "Back packing %s from backend",
1701 srw_res->record->recordPacking = pack;
1703 srw_res->record->recordData_buf = rr.record_data;
1704 srw_res->record->recordData_len = strlen(rr.record_data);
1705 if (rr.extra_record_data)
1707 Z_SRW_extra_record *ex =
1708 yaz_srw_get_extra_record(assoc->encode);
1709 srw_res->extra_record = ex;
1710 ex->extraRecordData_buf = rr.extra_record_data;
1711 ex->extraRecordData_len = strlen(rr.extra_record_data);
1717 /* check if path is OK (1); BAD (0) */
1718 static int check_path(const char *path)
1722 if (strstr(path, ".."))
1727 static char *read_file(const char *fname, ODR o, size_t *sz)
1730 FILE *inf = fopen(fname, "rb");
1734 fseek(inf, 0L, SEEK_END);
1737 buf = (char *) odr_malloc(o, *sz);
1738 if (fread(buf, 1, *sz, inf) != *sz)
1739 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1744 static void process_http_request(association *assoc, request *req)
1746 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1747 ODR o = assoc->encode;
1748 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1750 Z_SOAP *soap_package = 0;
1753 Z_HTTP_Response *hres = 0;
1755 const char *stylesheet = 0; /* for now .. set later */
1756 Z_SRW_diagnostic *diagnostic = 0;
1757 int num_diagnostic = 0;
1758 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1760 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1761 if (!control_association(assoc, host, 0))
1763 p = z_get_HTTP_Response(o, 404);
1766 if (r == 2 && assoc->server && assoc->server->docpath
1767 && hreq->path[0] == '/'
1769 /* check if path is a proper prefix of documentroot */
1770 strncmp(hreq->path+1, assoc->server->docpath,
1771 strlen(assoc->server->docpath))
1774 if (!check_path(hreq->path))
1776 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1777 p = z_get_HTTP_Response(o, 404);
1781 size_t content_size = 0;
1782 char *content_buf = read_file(hreq->path+1, o, &content_size);
1785 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1786 p = z_get_HTTP_Response(o, 404);
1790 const char *ctype = 0;
1791 yaz_mime_types types = yaz_mime_types_create();
1793 yaz_mime_types_add(types, "xsl", "application/xml");
1794 yaz_mime_types_add(types, "xml", "application/xml");
1795 yaz_mime_types_add(types, "css", "text/css");
1796 yaz_mime_types_add(types, "html", "text/html");
1797 yaz_mime_types_add(types, "htm", "text/html");
1798 yaz_mime_types_add(types, "txt", "text/plain");
1799 yaz_mime_types_add(types, "js", "application/x-javascript");
1801 yaz_mime_types_add(types, "gif", "image/gif");
1802 yaz_mime_types_add(types, "png", "image/png");
1803 yaz_mime_types_add(types, "jpg", "image/jpeg");
1804 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1806 ctype = yaz_mime_lookup_fname(types, hreq->path);
1809 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1810 p = z_get_HTTP_Response(o, 404);
1814 p = z_get_HTTP_Response(o, 200);
1815 hres = p->u.HTTP_Response;
1816 hres->content_buf = content_buf;
1817 hres->content_len = content_size;
1818 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1820 yaz_mime_types_destroy(types);
1828 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1829 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1831 if (r == 2) /* not taken */
1833 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1834 &diagnostic, &num_diagnostic);
1835 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1837 if (r == 0) /* decode SRW/SRU OK .. */
1839 int http_code = 200;
1840 if (sr->which == Z_SRW_searchRetrieve_request)
1843 yaz_srw_get_pdu(assoc->encode, Z_SRW_searchRetrieve_response,
1845 stylesheet = sr->u.request->stylesheet;
1848 res->u.response->diagnostics = diagnostic;
1849 res->u.response->num_diagnostics = num_diagnostic;
1853 srw_bend_search(assoc, sr, res, &http_code);
1855 if (http_code == 200)
1856 soap_package->u.generic->p = res;
1858 else if (sr->which == Z_SRW_explain_request)
1860 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_explain_response,
1862 stylesheet = sr->u.explain_request->stylesheet;
1865 res->u.explain_response->diagnostics = diagnostic;
1866 res->u.explain_response->num_diagnostics = num_diagnostic;
1868 srw_bend_explain(assoc, sr, res->u.explain_response, &http_code);
1869 if (http_code == 200)
1870 soap_package->u.generic->p = res;
1872 else if (sr->which == Z_SRW_scan_request)
1874 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_scan_response,
1876 stylesheet = sr->u.scan_request->stylesheet;
1879 res->u.scan_response->diagnostics = diagnostic;
1880 res->u.scan_response->num_diagnostics = num_diagnostic;
1882 srw_bend_scan(assoc, sr, res, &http_code);
1883 if (http_code == 200)
1884 soap_package->u.generic->p = res;
1886 else if (sr->which == Z_SRW_update_request)
1888 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1890 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1893 res->u.update_response->diagnostics = diagnostic;
1894 res->u.update_response->num_diagnostics = num_diagnostic;
1896 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1897 srw_bend_update(assoc, sr, res->u.update_response, &http_code);
1898 if (http_code == 200)
1899 soap_package->u.generic->p = res;
1903 yaz_log(log_request, "SOAP ERROR");
1904 /* FIXME - what error, what query */
1906 z_soap_error(assoc->encode, soap_package,
1907 "SOAP-ENV:Client", "Bad method", 0);
1909 if (http_code == 200 || http_code == 500)
1911 static Z_SOAP_Handler soap_handlers[4] = {
1913 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1914 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1915 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1920 p = z_get_HTTP_Response(o, 200);
1921 hres = p->u.HTTP_Response;
1923 if (!stylesheet && assoc->server)
1924 stylesheet = assoc->server->stylesheet;
1926 /* empty stylesheet means NO stylesheet */
1927 if (stylesheet && *stylesheet == '\0')
1930 z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1931 &hres->content_buf, &hres->content_len,
1932 soap_handlers, charset, stylesheet);
1933 hres->code = http_code;
1935 strcpy(ctype, "text/xml");
1936 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1939 p = z_get_HTTP_Response(o, http_code);
1943 p = z_get_HTTP_Response(o, 500);
1944 hres = p->u.HTTP_Response;
1945 if (!strcmp(hreq->version, "1.0"))
1947 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1948 if (v && !strcmp(v, "Keep-Alive"))
1952 hres->version = "1.0";
1956 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1957 if (v && !strcmp(v, "close"))
1961 hres->version = "1.1";
1963 if (!keepalive || !assoc->last_control->keepalive)
1965 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1966 assoc->state = ASSOC_DEAD;
1967 assoc->cs_get_mask = 0;
1972 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1974 if (alive && yaz_isdigit(*(const unsigned char *) alive))
1978 if (t < 0 || t > 3600)
1980 iochan_settimeout(assoc->client_chan,t);
1981 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
1983 process_gdu_response(assoc, req, p);
1986 static void process_gdu_request(association *assoc, request *req)
1988 if (req->gdu_request->which == Z_GDU_Z3950)
1991 req->apdu_request = req->gdu_request->u.z3950;
1992 if (process_z_request(assoc, req, &msg) < 0)
1993 do_close_req(assoc, Z_Close_systemProblem, msg, req);
1995 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
1996 process_http_request(assoc, req);
1999 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
2004 * Initiate request processing.
2006 static int process_z_request(association *assoc, request *req, char **msg)
2011 *msg = "Unknown Error";
2012 assert(req && req->state == REQUEST_IDLE);
2013 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
2015 *msg = "Missing InitRequest";
2018 switch (req->apdu_request->which)
2020 case Z_APDU_initRequest:
2021 res = process_initRequest(assoc, req); break;
2022 case Z_APDU_searchRequest:
2023 res = process_searchRequest(assoc, req); break;
2024 case Z_APDU_presentRequest:
2025 res = process_presentRequest(assoc, req); break;
2026 case Z_APDU_scanRequest:
2027 if (assoc->init->bend_scan)
2028 res = process_scanRequest(assoc, req);
2031 *msg = "Cannot handle Scan APDU";
2035 case Z_APDU_extendedServicesRequest:
2036 if (assoc->init->bend_esrequest)
2037 res = process_ESRequest(assoc, req);
2040 *msg = "Cannot handle Extended Services APDU";
2044 case Z_APDU_sortRequest:
2045 if (assoc->init->bend_sort)
2046 res = process_sortRequest(assoc, req);
2049 *msg = "Cannot handle Sort APDU";
2054 process_close(assoc, req);
2056 case Z_APDU_deleteResultSetRequest:
2057 if (assoc->init->bend_delete)
2058 res = process_deleteRequest(assoc, req);
2061 *msg = "Cannot handle Delete APDU";
2065 case Z_APDU_segmentRequest:
2066 if (assoc->init->bend_segment)
2068 res = process_segmentRequest(assoc, req);
2072 *msg = "Cannot handle Segment APDU";
2076 case Z_APDU_triggerResourceControlRequest:
2079 *msg = "Bad APDU received";
2084 yaz_log(YLOG_DEBUG, " result immediately available");
2085 retval = process_z_response(assoc, req, res);
2089 yaz_log(YLOG_DEBUG, " result unavailable");
2096 * Encode response, and transfer the request structure to the outgoing queue.
2098 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2100 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2104 if (!z_GDU(assoc->print, &res, 0, 0))
2105 yaz_log(YLOG_WARN, "ODR print error: %s",
2106 odr_errmsg(odr_geterror(assoc->print)));
2107 odr_reset(assoc->print);
2109 if (!z_GDU(assoc->encode, &res, 0, 0))
2111 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2112 odr_errmsg(odr_geterror(assoc->decode)),
2113 odr_getelement(assoc->decode));
2116 req->response = odr_getbuf(assoc->encode, &req->len_response,
2117 &req->size_response);
2118 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2119 odr_reset(assoc->encode);
2120 req->state = REQUEST_IDLE;
2121 request_enq(&assoc->outgoing, req);
2122 /* turn the work over to the ir_session handler */
2123 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2124 assoc->cs_put_mask = EVENT_OUTPUT;
2125 /* Is there more work to be done? give that to the input handler too */
2128 req = request_head(&assoc->incoming);
2129 if (req && req->state == REQUEST_IDLE)
2131 request_deq(&assoc->incoming);
2132 process_gdu_request(assoc, req);
2141 * Encode response, and transfer the request structure to the outgoing queue.
2143 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2145 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*gres));
2146 gres->which = Z_GDU_Z3950;
2147 gres->u.z3950 = res;
2149 return process_gdu_response(assoc, req, gres);
2152 static char *get_vhost(Z_OtherInformation *otherInfo)
2154 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2158 * Handle init request.
2159 * At the moment, we don't check the options
2160 * anywhere else in the code - we just try not to do anything that would
2161 * break a naive client. We'll toss 'em into the association block when
2162 * we need them there.
2164 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2166 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2167 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2168 Z_InitResponse *resp = apdu->u.initResponse;
2169 bend_initresult *binitres;
2171 statserv_options_block *cb = 0; /* by default no control for backend */
2173 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2174 cb = statserv_getcontrol(); /* got control block for backend */
2176 if (cb && assoc->backend)
2177 (*cb->bend_close)(assoc->backend);
2179 yaz_log(log_requestdetail, "Got initRequest");
2180 if (req->implementationId)
2181 yaz_log(log_requestdetail, "Id: %s",
2182 req->implementationId);
2183 if (req->implementationName)
2184 yaz_log(log_requestdetail, "Name: %s",
2185 req->implementationName);
2186 if (req->implementationVersion)
2187 yaz_log(log_requestdetail, "Version: %s",
2188 req->implementationVersion);
2190 assoc_init_reset(assoc);
2192 assoc->init->auth = req->idAuthentication;
2193 assoc->init->referenceId = req->referenceId;
2195 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2197 Z_CharSetandLanguageNegotiation *negotiation =
2198 yaz_get_charneg_record (req->otherInfo);
2200 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2201 assoc->init->charneg_request = negotiation;
2204 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2205 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2206 assoc->init->named_result_sets = 1;
2211 if (req->implementationVersion)
2212 yaz_log(log_requestdetail, "Config: %s",
2215 iochan_settimeout(assoc->client_chan, cb->idle_timeout);
2217 /* we have a backend control block, so call that init function */
2218 if (!(binitres = (*cb->bend_init)(assoc->init)))
2220 yaz_log(YLOG_WARN, "Bad response from backend.");
2223 assoc->backend = binitres->handle;
2227 /* no backend. return error */
2228 binitres = (bend_initresult *)
2229 odr_malloc(assoc->encode, sizeof(*binitres));
2230 binitres->errstring = 0;
2231 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2232 iochan_settimeout(assoc->client_chan, 10);
2234 if ((assoc->init->bend_sort))
2235 yaz_log(YLOG_DEBUG, "Sort handler installed");
2236 if ((assoc->init->bend_search))
2237 yaz_log(YLOG_DEBUG, "Search handler installed");
2238 if ((assoc->init->bend_present))
2239 yaz_log(YLOG_DEBUG, "Present handler installed");
2240 if ((assoc->init->bend_esrequest))
2241 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2242 if ((assoc->init->bend_delete))
2243 yaz_log(YLOG_DEBUG, "Delete handler installed");
2244 if ((assoc->init->bend_scan))
2245 yaz_log(YLOG_DEBUG, "Scan handler installed");
2246 if ((assoc->init->bend_segment))
2247 yaz_log(YLOG_DEBUG, "Segment handler installed");
2249 resp->referenceId = req->referenceId;
2251 /* let's tell the client what we can do */
2252 if (ODR_MASK_GET(req->options, Z_Options_search))
2254 ODR_MASK_SET(resp->options, Z_Options_search);
2255 strcat(options, "srch");
2257 if (ODR_MASK_GET(req->options, Z_Options_present))
2259 ODR_MASK_SET(resp->options, Z_Options_present);
2260 strcat(options, " prst");
2262 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2263 assoc->init->bend_delete)
2265 ODR_MASK_SET(resp->options, Z_Options_delSet);
2266 strcat(options, " del");
2268 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2269 assoc->init->bend_esrequest)
2271 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2272 strcat(options, " extendedServices");
2274 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2275 && assoc->init->named_result_sets)
2277 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2278 strcat(options, " namedresults");
2280 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2282 ODR_MASK_SET(resp->options, Z_Options_scan);
2283 strcat(options, " scan");
2285 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2287 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2288 strcat(options, " concurrop");
2290 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2292 ODR_MASK_SET(resp->options, Z_Options_sort);
2293 strcat(options, " sort");
2296 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2298 Z_OtherInformationUnit *p0;
2300 if (!assoc->init->charneg_response)
2302 if (assoc->init->query_charset)
2304 assoc->init->charneg_response = yaz_set_response_charneg(
2305 assoc->encode, assoc->init->query_charset, 0,
2306 assoc->init->records_in_same_charset);
2310 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2313 if (assoc->init->charneg_response
2314 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2316 p0->which = Z_OtherInfo_externallyDefinedInfo;
2317 p0->information.externallyDefinedInfo =
2318 assoc->init->charneg_response;
2319 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2320 strcat(options, " negotiation");
2323 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2324 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2326 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2328 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2329 assoc->version = 1; /* 1 & 2 are equivalent */
2331 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2333 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2336 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2338 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2342 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2344 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2345 assoc->maximumRecordSize = odr_int_to_int(*req->maximumRecordSize);
2347 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2348 assoc->preferredMessageSize = odr_int_to_int(*req->preferredMessageSize);
2350 resp->preferredMessageSize =
2351 odr_intdup(assoc->encode, assoc->preferredMessageSize);
2352 resp->maximumRecordSize =
2353 odr_intdup(assoc->encode, assoc->maximumRecordSize);
2355 resp->implementationId = odr_prepend(assoc->encode,
2356 assoc->init->implementation_id,
2357 resp->implementationId);
2359 resp->implementationVersion = odr_prepend(assoc->encode,
2360 assoc->init->implementation_version,
2361 resp->implementationVersion);
2363 resp->implementationName = odr_prepend(assoc->encode,
2364 assoc->init->implementation_name,
2365 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2367 if (binitres->errcode)
2369 assoc->state = ASSOC_DEAD;
2370 resp->userInformationField =
2371 init_diagnostics(assoc->encode, binitres->errcode,
2372 binitres->errstring);
2376 assoc->state = ASSOC_UP;
2380 if (!req->idAuthentication)
2381 yaz_log(log_request, "Auth none");
2382 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2384 const char *open = req->idAuthentication->u.open;
2385 const char *slash = strchr(open, '/');
2391 yaz_log(log_request, "Auth open %.*s", len, open);
2393 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2395 const char *user = req->idAuthentication->u.idPass->userId;
2396 const char *group = req->idAuthentication->u.idPass->groupId;
2397 yaz_log(log_request, "Auth idPass %s %s",
2398 user ? user : "-", group ? group : "-");
2400 else if (req->idAuthentication->which
2401 == Z_IdAuthentication_anonymous)
2403 yaz_log(log_request, "Auth anonymous");
2407 yaz_log(log_request, "Auth other");
2412 WRBUF wr = wrbuf_alloc();
2413 wrbuf_printf(wr, "Init ");
2414 if (binitres->errcode)
2415 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2417 wrbuf_printf(wr, "OK -");
2418 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2419 (req->implementationId ? req->implementationId :"-"),
2420 (req->implementationName ?
2421 req->implementationName : "-"),
2422 (req->implementationVersion ?
2423 req->implementationVersion : "-")
2425 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2432 * Set the specified `errcode' and `errstring' into a UserInfo-1
2433 * external to be returned to the client in accordance with Z35.90
2434 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2435 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2437 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2439 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2440 addinfo ? " -- " : "", addinfo ? addinfo : "");
2441 return zget_init_diagnostics(odr, error, addinfo);
2445 * nonsurrogate diagnostic record.
2447 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2449 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2451 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2452 addinfo ? " -- " : "", addinfo ? addinfo : "");
2454 rec->which = Z_Records_NSD;
2455 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2461 * surrogate diagnostic.
2463 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2465 int error, const char *addinfo)
2467 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2468 addinfo ? " -- " : "", addinfo ? addinfo : "");
2469 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2472 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2473 Odr_int *num, Z_RecordComposition *comp,
2474 Odr_int *next, Odr_int *pres,
2475 Z_ReferenceId *referenceId,
2476 Odr_oid *oid, int *errcode)
2478 int recno, total_length = 0, dumped_records = 0;
2479 int toget = odr_int_to_int(*num);
2480 Z_Records *records =
2481 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2482 Z_NamePlusRecordList *reclist =
2483 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2485 records->which = Z_Records_DBOSD;
2486 records->u.databaseOrSurDiagnostics = reclist;
2487 reclist->num_records = 0;
2490 return diagrec(a, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, 0);
2491 else if (toget == 0)
2492 reclist->records = odr_nullval();
2494 reclist->records = (Z_NamePlusRecord **)
2495 odr_malloc(a->encode, sizeof(*reclist->records) * toget);
2497 *pres = Z_PresentStatus_success;
2501 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2502 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2503 a->maximumRecordSize);
2504 for (recno = odr_int_to_int(start); reclist->num_records < toget; recno++)
2507 Z_NamePlusRecord *thisrec;
2508 int this_length = 0;
2510 * we get the number of bytes allocated on the stream before any
2511 * allocation done by the backend - this should give us a reasonable
2512 * idea of the total size of the data so far.
2514 total_length = odr_total(a->encode) - dumped_records;
2520 freq.last_in_set = 0;
2521 freq.setname = setname;
2522 freq.surrogate_flag = 0;
2523 freq.number = recno;
2525 freq.request_format = oid;
2526 freq.output_format = 0;
2527 freq.stream = a->encode;
2528 freq.print = a->print;
2529 freq.referenceId = referenceId;
2532 retrieve_fetch(a, &freq);
2534 *next = freq.last_in_set ? 0 : recno + 1;
2538 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2541 *pres = Z_PresentStatus_failure;
2542 /* for 'present request out of range',
2543 set addinfo to record position if not set */
2544 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2545 freq.errstring == 0)
2547 sprintf(s, "%d", recno);
2551 *errcode = freq.errcode;
2552 return diagrec(a, freq.errcode, freq.errstring);
2554 reclist->records[reclist->num_records] =
2555 surrogatediagrec(a, freq.basename, freq.errcode,
2557 reclist->num_records++;
2560 if (freq.record == 0) /* no error and no record ? */
2562 *pres = Z_PresentStatus_partial_4;
2563 *next = 0; /* signal end-of-set and stop */
2567 this_length = freq.len;
2569 this_length = odr_total(a->encode) - total_length - dumped_records;
2570 yaz_log(YLOG_DEBUG, " fetched record, len=%d, total=%d dumped=%d",
2571 this_length, total_length, dumped_records);
2572 if (a->preferredMessageSize > 0 &&
2573 this_length + total_length > a->preferredMessageSize)
2575 /* record is small enough, really */
2576 if (this_length <= a->preferredMessageSize && recno > start)
2578 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2579 *pres = Z_PresentStatus_partial_2;
2584 /* record can only be fetched by itself */
2585 if (this_length < a->maximumRecordSize)
2587 yaz_log(log_requestdetail, " Record > prefmsgsz");
2590 yaz_log(YLOG_DEBUG, " Dropped it");
2591 reclist->records[reclist->num_records] =
2594 YAZ_BIB1_RECORD_EXCEEDS_PREFERRED_MESSAGE_SIZE, 0);
2595 reclist->num_records++;
2596 dumped_records += this_length;
2600 else /* too big entirely */
2602 yaz_log(log_requestdetail, "Record > maxrcdsz "
2604 this_length, a->maximumRecordSize);
2605 reclist->records[reclist->num_records] =
2608 YAZ_BIB1_RECORD_EXCEEDS_MAXIMUM_RECORD_SIZE, 0);
2609 reclist->num_records++;
2610 dumped_records += this_length;
2615 if (!(thisrec = (Z_NamePlusRecord *)
2616 odr_malloc(a->encode, sizeof(*thisrec))))
2618 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2619 thisrec->which = Z_NamePlusRecord_databaseRecord;
2621 if (!freq.output_format)
2623 yaz_log(YLOG_WARN, "bend_fetch output_format not set");
2626 thisrec->u.databaseRecord = z_ext_record_oid(
2627 a->encode, freq.output_format, freq.record, freq.len);
2628 if (!thisrec->u.databaseRecord)
2630 reclist->records[reclist->num_records] = thisrec;
2631 reclist->num_records++;
2632 if (freq.last_in_set)
2635 *num = reclist->num_records;
2639 static Z_APDU *process_searchRequest(association *assoc, request *reqb)
2641 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2642 bend_search_rr *bsrr =
2643 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2645 yaz_log(log_requestdetail, "Got SearchRequest.");
2646 bsrr->association = assoc;
2647 bsrr->referenceId = req->referenceId;
2648 bsrr->srw_sortKeys = 0;
2649 bsrr->srw_setname = 0;
2650 bsrr->srw_setnameIdleTime = 0;
2651 bsrr->estimated_hit_count = 0;
2652 bsrr->partial_resultset = 0;
2653 bsrr->extra_args = 0;
2654 bsrr->extra_response_data = 0;
2656 yaz_log(log_requestdetail, "ResultSet '%s'", req->resultSetName);
2657 if (req->databaseNames)
2660 for (i = 0; i < req->num_databaseNames; i++)
2661 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2664 yaz_log_zquery_level(log_requestdetail,req->query);
2666 if (assoc->init->bend_search)
2668 bsrr->setname = req->resultSetName;
2669 bsrr->replace_set = *req->replaceIndicator;
2670 bsrr->num_bases = req->num_databaseNames;
2671 bsrr->basenames = req->databaseNames;
2672 bsrr->query = req->query;
2673 bsrr->stream = assoc->encode;
2674 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2675 bsrr->decode = assoc->decode;
2676 bsrr->print = assoc->print;
2679 bsrr->errstring = NULL;
2680 bsrr->search_info = NULL;
2681 bsrr->search_input = req->additionalSearchInfo;
2682 if (!bsrr->search_input)
2683 bsrr->search_input = req->otherInfo;
2684 bsrr->present_number = *req->mediumSetPresentNumber;
2686 if (assoc->server && assoc->server->cql_transform
2687 && req->query->which == Z_Query_type_104
2688 && req->query->u.type_104->which == Z_External_CQL)
2690 /* have a CQL query and a CQL to PQF transform .. */
2692 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2693 assoc->server->cql_transform, bsrr->query,
2694 &bsrr->srw_sortKeys);
2696 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2699 if (assoc->server && assoc->server->ccl_transform
2700 && req->query->which == Z_Query_type_2) /*CCL*/
2702 /* have a CCL query and a CCL to PQF transform .. */
2704 ccl2pqf(bsrr->stream, req->query->u.type_2,
2705 assoc->server->ccl_transform, bsrr);
2707 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2711 (assoc->init->bend_search)(assoc->backend, bsrr);
2715 /* FIXME - make a diagnostic for it */
2716 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2718 return response_searchRequest(assoc, reqb, bsrr);
2722 * Prepare a searchresponse based on the backend results. We probably want
2723 * to look at making the fetching of records nonblocking as well, but
2724 * so far, we'll keep things simple.
2725 * If bsrt is null, that means we're called in response to a communications
2726 * event, and we'll have to get the response for ourselves.
2728 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2729 bend_search_rr *bsrt)
2731 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2732 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2733 Z_SearchResponse *resp = (Z_SearchResponse *)
2734 odr_malloc(assoc->encode, sizeof(*resp));
2735 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2736 Odr_int *next = odr_intdup(assoc->encode, 0);
2737 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2738 Odr_int returnedrecs = 0;
2740 apdu->which = Z_APDU_searchResponse;
2741 apdu->u.searchResponse = resp;
2742 resp->referenceId = req->referenceId;
2743 resp->additionalSearchInfo = 0;
2744 resp->otherInfo = 0;
2747 yaz_log(YLOG_FATAL, "Bad result from backend");
2750 else if (bsrt->errcode)
2752 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2753 resp->resultCount = nulint;
2754 resp->numberOfRecordsReturned = nulint;
2755 resp->nextResultSetPosition = nulint;
2756 resp->searchStatus = odr_booldup(assoc->encode, 0);
2757 resp->resultSetStatus = none;
2758 resp->presentStatus = 0;
2762 bool_t *sr = odr_booldup(assoc->encode, 1);
2763 Odr_int *toget = odr_intdup(assoc->encode, 0);
2764 Z_RecordComposition comp, *compp = 0;
2766 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2769 resp->resultCount = &bsrt->hits;
2771 comp.which = Z_RecordComp_simple;
2772 /* how many records does the user agent want, then? */
2775 else if (bsrt->hits <= *req->smallSetUpperBound)
2777 *toget = bsrt->hits;
2778 if ((comp.u.simple = req->smallSetElementSetNames))
2781 else if (bsrt->hits < *req->largeSetLowerBound)
2783 *toget = *req->mediumSetPresentNumber;
2784 if (*toget > bsrt->hits)
2785 *toget = bsrt->hits;
2786 if ((comp.u.simple = req->mediumSetElementSetNames))
2792 if (*toget && !resp->records)
2794 Odr_int *presst = odr_intdup(assoc->encode, 0);
2795 /* Call bend_present if defined */
2796 if (assoc->init->bend_present)
2798 bend_present_rr *bprr = (bend_present_rr *)
2799 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2800 bprr->setname = req->resultSetName;
2802 bprr->number = odr_int_to_int(*toget);
2803 bprr->format = req->preferredRecordSyntax;
2805 bprr->referenceId = req->referenceId;
2806 bprr->stream = assoc->encode;
2807 bprr->print = assoc->print;
2808 bprr->association = assoc;
2810 bprr->errstring = NULL;
2811 (*assoc->init->bend_present)(assoc->backend, bprr);
2815 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2816 *resp->presentStatus = Z_PresentStatus_failure;
2821 resp->records = pack_records(
2822 assoc, req->resultSetName, 1,
2823 toget, compp, next, presst, req->referenceId,
2824 req->preferredRecordSyntax, NULL);
2827 resp->numberOfRecordsReturned = toget;
2828 returnedrecs = *toget;
2829 resp->presentStatus = presst;
2833 if (*resp->resultCount)
2835 resp->numberOfRecordsReturned = nulint;
2836 resp->presentStatus = 0;
2838 resp->nextResultSetPosition = next;
2839 resp->searchStatus = sr;
2840 resp->resultSetStatus = 0;
2841 if (bsrt->estimated_hit_count)
2843 resp->resultSetStatus = odr_intdup(assoc->encode,
2844 Z_SearchResponse_estimate);
2846 else if (bsrt->partial_resultset)
2848 resp->resultSetStatus = odr_intdup(assoc->encode,
2849 Z_SearchResponse_subset);
2852 resp->additionalSearchInfo = bsrt->search_info;
2857 WRBUF wr = wrbuf_alloc();
2859 for (i = 0 ; i < req->num_databaseNames; i++)
2862 wrbuf_printf(wr, "+");
2863 wrbuf_puts(wr, req->databaseNames[i]);
2865 wrbuf_printf(wr, " ");
2868 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2870 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2871 wrbuf_printf(wr, " %s 1+" ODR_INT_PRINTF " ",
2872 req->resultSetName, returnedrecs);
2873 yaz_query_to_wrbuf(wr, req->query);
2875 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2882 * Maybe we got a little over-friendly when we designed bend_fetch to
2883 * get only one record at a time. Some backends can optimise multiple-record
2884 * fetches, and at any rate, there is some overhead involved in
2885 * all that selecting and hopping around. Problem is, of course, that the
2886 * frontend can't know ahead of time how many records it'll need to
2887 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2888 * is downright lousy as a bulk data transfer protocol.
2890 * To start with, we'll do the fetching of records from the backend
2891 * in one operation: To save some trips in and out of the event-handler,
2892 * and to simplify the interface to pack_records. At any rate, asynch
2893 * operation is more fun in operations that have an unpredictable execution
2894 * speed - which is normally more true for search than for present.
2896 static Z_APDU *process_presentRequest(association *assoc, request *reqb)
2898 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2900 Z_PresentResponse *resp;
2905 yaz_log(log_requestdetail, "Got PresentRequest.");
2907 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2909 resp->presentStatus = odr_intdup(assoc->encode, 0);
2910 if (assoc->init->bend_present)
2912 bend_present_rr *bprr = (bend_present_rr *)
2913 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2914 bprr->setname = req->resultSetId;
2915 bprr->start = odr_int_to_int(*req->resultSetStartPoint);
2916 bprr->number = odr_int_to_int(*req->numberOfRecordsRequested);
2917 bprr->format = req->preferredRecordSyntax;
2918 bprr->comp = req->recordComposition;
2919 bprr->referenceId = req->referenceId;
2920 bprr->stream = assoc->encode;
2921 bprr->print = assoc->print;
2922 bprr->association = assoc;
2924 bprr->errstring = NULL;
2925 (*assoc->init->bend_present)(assoc->backend, bprr);
2929 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2930 *resp->presentStatus = Z_PresentStatus_failure;
2931 errcode = bprr->errcode;
2934 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2935 next = odr_intdup(assoc->encode, 0);
2936 num = odr_intdup(assoc->encode, 0);
2938 apdu->which = Z_APDU_presentResponse;
2939 apdu->u.presentResponse = resp;
2940 resp->referenceId = req->referenceId;
2941 resp->otherInfo = 0;
2945 *num = *req->numberOfRecordsRequested;
2947 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2948 num, req->recordComposition, next,
2949 resp->presentStatus,
2950 req->referenceId, req->preferredRecordSyntax,
2955 WRBUF wr = wrbuf_alloc();
2956 wrbuf_printf(wr, "Present ");
2958 if (*resp->presentStatus == Z_PresentStatus_failure)
2959 wrbuf_printf(wr, "ERROR %d ", errcode);
2960 else if (*resp->presentStatus == Z_PresentStatus_success)
2961 wrbuf_printf(wr, "OK - ");
2963 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
2964 *resp->presentStatus);
2966 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
2967 req->resultSetId, *req->resultSetStartPoint,
2968 *req->numberOfRecordsRequested);
2969 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
2974 resp->numberOfRecordsReturned = num;
2975 resp->nextResultSetPosition = next;
2981 * Scan was implemented rather in a hurry, and with support for only the basic
2982 * elements of the service in the backend API. Suggestions are welcome.
2984 static Z_APDU *process_scanRequest(association *assoc, request *reqb)
2986 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
2987 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2988 Z_ScanResponse *res = (Z_ScanResponse *)
2989 odr_malloc(assoc->encode, sizeof(*res));
2990 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
2991 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
2992 Z_ListEntries *ents = (Z_ListEntries *)
2993 odr_malloc(assoc->encode, sizeof(*ents));
2994 Z_DiagRecs *diagrecs_p = NULL;
2995 bend_scan_rr *bsrr = (bend_scan_rr *)
2996 odr_malloc(assoc->encode, sizeof(*bsrr));
2997 struct scan_entry *save_entries;
3000 yaz_log(log_requestdetail, "Got ScanRequest");
3002 apdu->which = Z_APDU_scanResponse;
3003 apdu->u.scanResponse = res;
3004 res->referenceId = req->referenceId;
3006 /* if step is absent, set it to 0 */
3008 step_size = odr_int_to_int(*req->stepSize);
3011 res->scanStatus = scanStatus;
3012 res->numberOfEntriesReturned = numberOfEntriesReturned;
3013 res->positionOfTerm = 0;
3014 res->entries = ents;
3015 ents->num_entries = 0;
3016 ents->entries = NULL;
3017 ents->num_nonsurrogateDiagnostics = 0;
3018 ents->nonsurrogateDiagnostics = NULL;
3019 res->attributeSet = 0;
3022 if (req->databaseNames)
3025 for (i = 0; i < req->num_databaseNames; i++)
3026 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
3028 bsrr->scanClause = 0;
3030 bsrr->errstring = 0;
3031 bsrr->num_bases = req->num_databaseNames;
3032 bsrr->basenames = req->databaseNames;
3033 bsrr->num_entries = odr_int_to_int(*req->numberOfTermsRequested);
3034 bsrr->term = req->termListAndStartPoint;
3035 bsrr->referenceId = req->referenceId;
3036 bsrr->stream = assoc->encode;
3037 bsrr->print = assoc->print;
3038 bsrr->step_size = &step_size;
3039 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
3040 yaz_oid_userinfo_scan_set, 1, 0);
3042 bsrr->extra_args = 0;
3043 bsrr->extra_response_data = 0;
3044 /* For YAZ 2.0 and earlier it was the backend handler that
3045 initialized entries (member display_term did not exist)
3046 YAZ 2.0 and later sets 'entries' and initialize all members
3047 including 'display_term'. If YAZ 2.0 or later sees that
3048 entries was modified - we assume that it is an old handler and
3049 that 'display_term' is _not_ set.
3051 if (bsrr->num_entries > 0)
3054 bsrr->entries = (struct scan_entry *)
3055 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3057 for (i = 0; i<bsrr->num_entries; i++)
3059 bsrr->entries[i].term = 0;
3060 bsrr->entries[i].occurrences = 0;
3061 bsrr->entries[i].errcode = 0;
3062 bsrr->entries[i].errstring = 0;
3063 bsrr->entries[i].display_term = 0;
3066 save_entries = bsrr->entries; /* save it so we can compare later */
3068 bsrr->attributeset = req->attributeSet;
3069 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3070 bsrr->attributeset);
3071 bsrr->term_position = req->preferredPositionInResponse ?
3072 odr_int_to_int(*req->preferredPositionInResponse) : 1;
3074 ((int (*)(void *, bend_scan_rr *))
3075 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3078 diagrecs_p = zget_DiagRecs(assoc->encode,
3079 bsrr->errcode, bsrr->errstring);
3083 Z_Entry **tab = (Z_Entry **)
3084 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3086 if (bsrr->status == BEND_SCAN_PARTIAL)
3087 *scanStatus = Z_Scan_partial_5;
3089 *scanStatus = Z_Scan_success;
3090 res->stepSize = odr_intdup(assoc->encode, step_size);
3091 ents->entries = tab;
3092 ents->num_entries = bsrr->num_entries;
3093 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3095 res->positionOfTerm = odr_intdup(assoc->encode, bsrr->term_position);
3096 for (i = 0; i < bsrr->num_entries; i++)
3101 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3102 if (bsrr->entries[i].occurrences >= 0)
3104 e->which = Z_Entry_termInfo;
3105 e->u.termInfo = t = (Z_TermInfo *)
3106 odr_malloc(assoc->encode, sizeof(*t));
3107 t->suggestedAttributes = 0;
3109 if (save_entries == bsrr->entries &&
3110 bsrr->entries[i].display_term)
3112 /* the entries was _not_ set by the handler. So it's
3113 safe to test for new member display_term. It is
3116 t->displayTerm = odr_strdup(assoc->encode,
3117 bsrr->entries[i].display_term);
3119 t->alternativeTerm = 0;
3120 t->byAttributes = 0;
3121 t->otherTermInfo = 0;
3122 t->globalOccurrences = &bsrr->entries[i].occurrences;
3123 t->term = (Z_Term *)
3124 odr_malloc(assoc->encode, sizeof(*t->term));
3125 t->term->which = Z_Term_general;
3126 t->term->u.general =
3127 odr_create_Odr_oct(assoc->encode,
3128 bsrr->entries[i].term,
3129 strlen(bsrr->entries[i].term));
3130 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3131 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3135 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3136 bsrr->entries[i].errcode,
3137 bsrr->entries[i].errstring);
3138 assert(drecs->num_diagRecs == 1);
3139 e->which = Z_Entry_surrogateDiagnostic;
3140 assert(drecs->diagRecs[0]);
3141 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3147 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3148 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3153 WRBUF wr = wrbuf_alloc();
3154 wrbuf_printf(wr, "Scan ");
3155 for (i = 0 ; i < req->num_databaseNames; i++)
3158 wrbuf_printf(wr, "+");
3159 wrbuf_puts(wr, req->databaseNames[i]);
3162 wrbuf_printf(wr, " ");
3165 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3167 wrbuf_printf(wr, "OK");
3169 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3170 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3171 res->numberOfEntriesReturned ?
3172 *res->numberOfEntriesReturned : 0,
3173 (req->preferredPositionInResponse ?
3174 *req->preferredPositionInResponse : 1),
3175 *req->numberOfTermsRequested,
3176 (res->stepSize ? *res->stepSize : 1));
3179 wrbuf_printf(wr, "+%s", bsrr->setname);
3181 wrbuf_printf(wr, " ");
3182 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3183 bsrr->attributeset);
3184 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3190 static Z_APDU *process_sortRequest(association *assoc, request *reqb)
3193 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3194 Z_SortResponse *res = (Z_SortResponse *)
3195 odr_malloc(assoc->encode, sizeof(*res));
3196 bend_sort_rr *bsrr = (bend_sort_rr *)
3197 odr_malloc(assoc->encode, sizeof(*bsrr));
3199 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3201 yaz_log(log_requestdetail, "Got SortRequest.");
3203 bsrr->num_input_setnames = req->num_inputResultSetNames;
3204 for (i=0;i<req->num_inputResultSetNames;i++)
3205 yaz_log(log_requestdetail, "Input resultset: '%s'",
3206 req->inputResultSetNames[i]);
3207 bsrr->input_setnames = req->inputResultSetNames;
3208 bsrr->referenceId = req->referenceId;
3209 bsrr->output_setname = req->sortedResultSetName;
3210 yaz_log(log_requestdetail, "Output resultset: '%s'",
3211 req->sortedResultSetName);
3212 bsrr->sort_sequence = req->sortSequence;
3213 /*FIXME - dump those sequences too */
3214 bsrr->stream = assoc->encode;
3215 bsrr->print = assoc->print;
3217 bsrr->sort_status = Z_SortResponse_failure;
3219 bsrr->errstring = 0;
3221 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3223 res->referenceId = bsrr->referenceId;
3224 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3225 res->resultSetStatus = 0;
3228 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3229 bsrr->errcode, bsrr->errstring);
3230 res->diagnostics = dr->diagRecs;
3231 res->num_diagnostics = dr->num_diagRecs;
3235 res->num_diagnostics = 0;
3236 res->diagnostics = 0;
3238 res->resultCount = 0;
3241 apdu->which = Z_APDU_sortResponse;
3242 apdu->u.sortResponse = res;
3245 WRBUF wr = wrbuf_alloc();
3246 wrbuf_printf(wr, "Sort ");
3248 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3250 wrbuf_printf(wr, "OK -");
3251 wrbuf_printf(wr, " (");
3252 for (i = 0; i<req->num_inputResultSetNames; i++)
3255 wrbuf_printf(wr, "+");
3256 wrbuf_puts(wr, req->inputResultSetNames[i]);
3258 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3260 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3266 static Z_APDU *process_deleteRequest(association *assoc, request *reqb)
3269 Z_DeleteResultSetRequest *req =
3270 reqb->apdu_request->u.deleteResultSetRequest;
3271 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3272 odr_malloc(assoc->encode, sizeof(*res));
3273 bend_delete_rr *bdrr = (bend_delete_rr *)
3274 odr_malloc(assoc->encode, sizeof(*bdrr));
3275 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3277 yaz_log(log_requestdetail, "Got DeleteRequest.");
3279 bdrr->num_setnames = req->num_resultSetList;
3280 bdrr->setnames = req->resultSetList;
3281 for (i = 0; i<req->num_resultSetList; i++)
3282 yaz_log(log_requestdetail, "resultset: '%s'",
3283 req->resultSetList[i]);
3284 bdrr->stream = assoc->encode;
3285 bdrr->print = assoc->print;
3286 bdrr->function = odr_int_to_int(*req->deleteFunction);
3287 bdrr->referenceId = req->referenceId;
3289 if (bdrr->num_setnames > 0)
3291 bdrr->statuses = (int*)
3292 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3293 bdrr->num_setnames);
3294 for (i = 0; i < bdrr->num_setnames; i++)
3295 bdrr->statuses[i] = 0;
3297 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3299 res->referenceId = req->referenceId;
3301 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3303 res->deleteListStatuses = 0;
3304 if (bdrr->num_setnames > 0)
3307 res->deleteListStatuses = (Z_ListStatuses *)
3308 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3309 res->deleteListStatuses->num = bdrr->num_setnames;
3310 res->deleteListStatuses->elements =
3312 odr_malloc(assoc->encode,
3313 sizeof(*res->deleteListStatuses->elements) *
3314 bdrr->num_setnames);
3315 for (i = 0; i<bdrr->num_setnames; i++)
3317 res->deleteListStatuses->elements[i] =
3319 odr_malloc(assoc->encode,
3320 sizeof(**res->deleteListStatuses->elements));
3321 res->deleteListStatuses->elements[i]->status =
3322 odr_intdup(assoc->encode, bdrr->statuses[i]);
3323 res->deleteListStatuses->elements[i]->id =
3324 odr_strdup(assoc->encode, bdrr->setnames[i]);
3327 res->numberNotDeleted = 0;
3328 res->bulkStatuses = 0;
3329 res->deleteMessage = 0;
3332 apdu->which = Z_APDU_deleteResultSetResponse;
3333 apdu->u.deleteResultSetResponse = res;
3336 WRBUF wr = wrbuf_alloc();
3337 wrbuf_printf(wr, "Delete ");
3338 if (bdrr->delete_status)
3339 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3341 wrbuf_printf(wr, "OK -");
3342 for (i = 0; i<req->num_resultSetList; i++)
3343 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3344 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3350 static void process_close(association *assoc, request *reqb)
3352 Z_Close *req = reqb->apdu_request->u.close;
3353 static char *reasons[] =
3360 "securityViolation",
3367 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3368 reasons[*req->closeReason], req->diagnosticInformation ?
3369 req->diagnosticInformation : "NULL");
3370 if (assoc->version < 3) /* to make do_force respond with close */
3372 do_close_req(assoc, Z_Close_finished,
3373 "Association terminated by client", reqb);
3374 yaz_log(log_request,"Close OK");
3377 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3379 bend_segment_rr req;
3381 req.segment = reqb->apdu_request->u.segmentRequest;
3382 req.stream = assoc->encode;
3383 req.decode = assoc->decode;
3384 req.print = assoc->print;
3385 req.association = assoc;
3387 (*assoc->init->bend_segment)(assoc->backend, &req);
3392 static Z_APDU *process_ESRequest(association *assoc, request *reqb)
3394 bend_esrequest_rr esrequest;
3395 const char *ext_name = "unknown";
3397 Z_ExtendedServicesRequest *req =
3398 reqb->apdu_request->u.extendedServicesRequest;
3399 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3401 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3403 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3404 esrequest.stream = assoc->encode;
3405 esrequest.decode = assoc->decode;
3406 esrequest.print = assoc->print;
3407 esrequest.errcode = 0;
3408 esrequest.errstring = NULL;
3409 esrequest.association = assoc;
3410 esrequest.taskPackage = 0;
3411 esrequest.referenceId = req->referenceId;
3413 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3415 switch(esrequest.esr->taskSpecificParameters->which)
3417 case Z_External_itemOrder:
3418 ext_name = "ItemOrder"; break;
3419 case Z_External_update:
3420 ext_name = "Update"; break;
3421 case Z_External_update0:
3422 ext_name = "Update0"; break;
3423 case Z_External_ESAdmin:
3424 ext_name = "Admin"; break;
3429 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3431 resp->referenceId = req->referenceId;
3433 if (esrequest.errcode == -1)
3435 /* Backend service indicates request will be processed */
3436 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3437 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3439 else if (esrequest.errcode == 0)
3441 /* Backend service indicates request will be processed */
3442 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3443 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3447 Z_DiagRecs *diagRecs =
3448 zget_DiagRecs(assoc->encode, esrequest.errcode,
3449 esrequest.errstring);
3450 /* Backend indicates error, request will not be processed */
3451 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3452 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3453 resp->num_diagnostics = diagRecs->num_diagRecs;
3454 resp->diagnostics = diagRecs->diagRecs;
3457 WRBUF wr = wrbuf_alloc();
3458 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3459 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3464 /* Do something with the members of bend_extendedservice */
3465 if (esrequest.taskPackage)
3467 resp->taskPackage = z_ext_record_oid(
3468 assoc->encode, yaz_oid_recsyn_extended,
3469 (const char *) esrequest.taskPackage, -1);
3471 yaz_log(YLOG_DEBUG,"Send the result apdu");
3475 int bend_assoc_is_alive(bend_association assoc)
3477 if (assoc->state == ASSOC_DEAD)
3478 return 0; /* already marked as dead. Don't check I/O chan anymore */
3480 return iochan_is_alive(assoc->client_chan);
3487 * c-file-style: "Stroustrup"
3488 * indent-tabs-mode: nil
3490 * vim: shiftwidth=4 tabstop=8 expandtab