1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 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>
77 #include <yaz/query-charset.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 if (assoc->state != ASSOC_DEAD)
473 yaz_log(YLOG_WARN, "ir_session (exception)");
475 destroy_association(assoc);
480 static int process_z_request(association *assoc, request *req, char **msg);
483 static void assoc_init_reset(association *assoc, const char *peer_name1)
485 const char *peer_name2 = cs_addrstr(assoc->client_link);
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;
517 assoc->init->peer_name = (char *)
518 odr_malloc(assoc->encode,
519 (peer_name1 ? strlen(peer_name1) : 0)
520 + 4 + strlen(peer_name2));
521 strcpy(assoc->init->peer_name, "");
524 strcat(assoc->init->peer_name, peer_name1);
525 strcat(assoc->init->peer_name, ", ");
527 strcat(assoc->init->peer_name, peer_name2);
529 yaz_log(log_requestdetail, "peer %s", assoc->init->peer_name);
532 static int srw_bend_init(association *assoc, Z_HTTP_Header *headers,
533 Z_SRW_diagnostic **d, int *num, Z_SRW_PDU *sr)
535 statserv_options_block *cb = statserv_getcontrol();
538 const char *encoding = "UTF-8";
540 bend_initresult *binitres;
542 yaz_log(log_requestdetail, "srw_bend_init config=%s", cb->configname);
543 assoc_init_reset(assoc, z_HTTP_header_lookup(headers, "X-Forwarded-For"));
547 Z_IdAuthentication *auth = (Z_IdAuthentication *)
548 odr_malloc(assoc->decode, sizeof(*auth));
551 len = strlen(sr->username) + 1;
553 len += strlen(sr->password) + 2;
554 yaz_log(log_requestdetail, "username=%s password-len=%ld",
556 (sr->password ? strlen(sr->password) : 0));
557 auth->which = Z_IdAuthentication_open;
558 auth->u.open = (char *) odr_malloc(assoc->decode, len);
559 strcpy(auth->u.open, sr->username);
560 if (sr->password && *sr->password)
562 strcat(auth->u.open, "/");
563 strcat(auth->u.open, sr->password);
565 assoc->init->auth = auth;
569 ce = yaz_set_proposal_charneg(assoc->decode, &encoding, 1, 0, 0, 1);
570 assoc->init->charneg_request = ce->u.charNeg3;
573 if (!(binitres = (*cb->bend_init)(assoc->init)))
575 assoc->state = ASSOC_DEAD;
576 yaz_add_srw_diagnostic(assoc->encode, d, num,
577 YAZ_SRW_AUTHENTICATION_ERROR, 0);
580 assoc->backend = binitres->handle;
581 assoc->init->auth = 0;
582 if (binitres->errcode)
584 int srw_code = yaz_diag_bib1_to_srw(binitres->errcode);
585 assoc->state = ASSOC_DEAD;
586 yaz_add_srw_diagnostic(assoc->encode, d, num, srw_code,
587 binitres->errstring);
595 static int retrieve_fetch(association *assoc, bend_fetch_rr *rr)
598 yaz_record_conv_t rc = 0;
599 const char *match_schema = 0;
600 Odr_oid *match_syntax = 0;
605 const char *input_schema = yaz_get_esn(rr->comp);
606 Odr_oid *input_syntax_raw = rr->request_format;
608 const char *backend_schema = 0;
609 Odr_oid *backend_syntax = 0;
611 r = yaz_retrieval_request(assoc->server->retrieval,
619 if (r == -1) /* error ? */
621 const char *details = yaz_retrieval_get_error(
622 assoc->server->retrieval);
624 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
626 rr->errstring = odr_strdup(rr->stream, details);
629 else if (r == 1 || r == 3)
631 const char *details = input_schema;
633 YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
635 rr->errstring = odr_strdup(rr->stream, details);
640 rr->errcode = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
641 if (input_syntax_raw)
643 char oidbuf[OID_STR_MAX];
644 oid_oid_to_dotstring(input_syntax_raw, oidbuf);
645 rr->errstring = odr_strdup(rr->stream, oidbuf);
651 yaz_set_esn(&rr->comp, backend_schema, odr_getmem(rr->stream));
654 rr->request_format = backend_syntax;
656 (*assoc->init->bend_fetch)(assoc->backend, rr);
657 if (rc && rr->record && rr->errcode == 0)
658 { /* post conversion must take place .. */
659 WRBUF output_record = wrbuf_alloc();
661 const char *details = 0;
664 r = yaz_record_conv_record(rc, rr->record, rr->len, output_record);
666 details = yaz_record_conv_get_error(rc);
668 else if (rr->len == -1 && rr->output_format &&
669 !oid_oidcmp(rr->output_format, yaz_oid_recsyn_opac))
671 r = yaz_record_conv_opac_record(
672 rc, (Z_OPACRecord *) rr->record, output_record);
674 details = yaz_record_conv_get_error(rc);
676 if (r == 0 && match_syntax &&
677 !oid_oidcmp(match_syntax, yaz_oid_recsyn_opac))
679 yaz_marc_t mt = yaz_marc_create();
680 Z_OPACRecord *opac = 0;
681 if (yaz_xml_to_opac(mt, wrbuf_buf(output_record),
682 wrbuf_len(output_record),
683 &opac, 0 /* iconv */, rr->stream->mem, 0)
687 rr->record = (char *) opac;
691 details = "XML to OPAC conversion failed";
694 yaz_marc_destroy(mt);
698 rr->len = wrbuf_len(output_record);
699 rr->record = (char *) odr_malloc(rr->stream, rr->len);
700 memcpy(rr->record, wrbuf_buf(output_record), rr->len);
704 rr->errcode = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
705 rr->surrogate_flag = 1;
707 rr->errstring = odr_strdup(rr->stream, details);
709 wrbuf_destroy(output_record);
712 rr->output_format = match_syntax;
714 rr->schema = odr_strdup(rr->stream, match_schema);
716 (*assoc->init->bend_fetch)(assoc->backend, rr);
721 static int srw_bend_fetch(association *assoc, int pos,
722 Z_SRW_searchRetrieveRequest *srw_req,
723 Z_SRW_record *record,
724 const char **addinfo, int *last_in_set)
727 ODR o = assoc->encode;
729 rr.setname = "default";
732 rr.request_format = odr_oiddup(assoc->decode, yaz_oid_recsyn_xml);
734 rr.comp = (Z_RecordComposition *)
735 odr_malloc(assoc->decode, sizeof(*rr.comp));
736 rr.comp->which = Z_RecordComp_complex;
737 rr.comp->u.complex = (Z_CompSpec *)
738 odr_malloc(assoc->decode, sizeof(Z_CompSpec));
739 rr.comp->u.complex->selectAlternativeSyntax = (bool_t *)
740 odr_malloc(assoc->encode, sizeof(bool_t));
741 *rr.comp->u.complex->selectAlternativeSyntax = 0;
742 rr.comp->u.complex->num_dbSpecific = 0;
743 rr.comp->u.complex->dbSpecific = 0;
744 rr.comp->u.complex->num_recordSyntax = 0;
745 rr.comp->u.complex->recordSyntax = 0;
747 rr.comp->u.complex->generic = (Z_Specification *)
748 odr_malloc(assoc->decode, sizeof(Z_Specification));
750 /* schema uri = recordSchema (or NULL if recordSchema is not given) */
751 rr.comp->u.complex->generic->which = Z_Schema_uri;
752 rr.comp->u.complex->generic->schema.uri = srw_req->recordSchema;
754 /* ESN = recordSchema if recordSchema is present */
755 rr.comp->u.complex->generic->elementSpec = 0;
756 if (srw_req->recordSchema)
758 rr.comp->u.complex->generic->elementSpec =
759 (Z_ElementSpec *) odr_malloc(assoc->encode, sizeof(Z_ElementSpec));
760 rr.comp->u.complex->generic->elementSpec->which =
761 Z_ElementSpec_elementSetName;
762 rr.comp->u.complex->generic->elementSpec->u.elementSetName =
763 srw_req->recordSchema;
766 rr.stream = assoc->encode;
767 rr.print = assoc->print;
775 rr.surrogate_flag = 0;
776 rr.schema = srw_req->recordSchema;
778 if (!assoc->init->bend_fetch)
781 retrieve_fetch(assoc, &rr);
783 *last_in_set = rr.last_in_set;
785 if (rr.errcode && rr.surrogate_flag)
787 int code = yaz_diag_bib1_to_srw(rr.errcode);
788 yaz_mk_sru_surrogate(o, record, pos, code, rr.errstring);
791 else if (rr.len >= 0)
793 record->recordData_buf = rr.record;
794 record->recordData_len = rr.len;
795 record->recordPosition = odr_intdup(o, pos);
796 record->recordSchema = odr_strdup_null(
797 o, rr.schema ? rr.schema : srw_req->recordSchema);
801 *addinfo = rr.errstring;
807 static int cql2pqf(ODR odr, const char *cql, cql_transform_t ct,
808 Z_Query *query_result, char **sortkeys_p)
810 /* have a CQL query and CQL to PQF transform .. */
811 CQL_parser cp = cql_parser_create();
815 WRBUF rpn_buf = wrbuf_alloc();
818 r = cql_parser_string(cp, cql);
821 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
825 struct cql_node *cn = cql_parser_result(cp);
828 r = cql_transform(ct, cn, wrbuf_vp_puts, rpn_buf);
830 srw_errcode = cql_transform_error(ct, &add);
834 int r = cql_sortby_to_sortkeys_buf(cn, out, sizeof(out)-1);
839 yaz_log(log_requestdetail, "srw_sortKeys '%s'", out);
840 *sortkeys_p = odr_strdup(odr, out);
844 yaz_log(log_requestdetail, "failed to create srw_sortKeys");
845 srw_errcode = YAZ_SRW_UNSUPP_SORT_TYPE;
851 /* Syntax & transform OK. */
852 /* Convert PQF string to Z39.50 to RPN query struct */
853 YAZ_PQF_Parser pp = yaz_pqf_create();
854 Z_RPNQuery *rpnquery = yaz_pqf_parse(pp, odr, wrbuf_cstr(rpn_buf));
859 int code = yaz_pqf_error(pp, &pqf_msg, &off);
860 yaz_log(YLOG_WARN, "PQF Parser Error %s (code %d)",
862 srw_errcode = YAZ_SRW_QUERY_SYNTAX_ERROR;
866 query_result->which = Z_Query_type_1;
867 query_result->u.type_1 = rpnquery;
871 cql_parser_destroy(cp);
872 wrbuf_destroy(rpn_buf);
876 static int cql2pqf_scan(ODR odr, const char *cql, cql_transform_t ct,
877 Z_AttributesPlusTerm *result)
882 int srw_error = cql2pqf(odr, cql, ct, &query, &sortkeys);
885 if (query.which != Z_Query_type_1 && query.which != Z_Query_type_101)
886 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* bad query type */
887 rpn = query.u.type_1;
888 if (!rpn->RPNStructure)
889 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be structure */
890 if (rpn->RPNStructure->which != Z_RPNStructure_simple)
891 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be simple */
892 if (rpn->RPNStructure->u.simple->which != Z_Operand_APT)
893 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* must be be attributes + term */
894 memcpy(result, rpn->RPNStructure->u.simple->u.attributesPlusTerm,
900 static int ccl2pqf(ODR odr, const Odr_oct *ccl, CCL_bibset bibset,
901 bend_search_rr *bsrr)
904 struct ccl_rpn_node *node;
907 ccl0 = odr_strdupn(odr, (char*) ccl->buf, ccl->len);
908 if ((node = ccl_find_str(bibset, ccl0, &errcode, &pos)) == 0)
910 bsrr->errstring = (char*) ccl_err_msg(errcode);
911 return YAZ_SRW_QUERY_SYNTAX_ERROR; /* Query syntax error */
914 bsrr->query->which = Z_Query_type_1;
915 bsrr->query->u.type_1 = ccl_rpn_query(odr, node);
919 static void srw_bend_search(association *assoc,
920 Z_HTTP_Header *headers,
925 Z_SRW_searchRetrieveResponse *srw_res = res->u.response;
928 Z_SRW_searchRetrieveRequest *srw_req = sr->u.request;
931 yaz_log(log_requestdetail, "Got SRW SearchRetrieveRequest");
932 srw_bend_init(assoc, headers,
933 &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
934 if (srw_res->num_diagnostics == 0 && assoc->init)
937 rr.setname = "default";
940 rr.basenames = &srw_req->database;
944 rr.srw_setnameIdleTime = 0;
945 rr.estimated_hit_count = 0;
946 rr.partial_resultset = 0;
947 rr.query = (Z_Query *) odr_malloc(assoc->decode, sizeof(*rr.query));
948 rr.query->u.type_1 = 0;
949 rr.extra_args = sr->extra_args;
950 rr.extra_response_data = 0;
951 rr.present_number = srw_req->maximumRecords ?
952 *srw_req->maximumRecords : 0;
954 if (!srw_req->queryType || !strcmp(srw_req->queryType, "cql"))
956 if (assoc->server && assoc->server->cql_transform)
958 int srw_errcode = cql2pqf(assoc->encode, srw_req->query,
959 assoc->server->cql_transform,
965 yaz_add_srw_diagnostic(assoc->encode,
966 &srw_res->diagnostics,
967 &srw_res->num_diagnostics,
973 /* CQL query to backend. Wrap it - Z39.50 style */
974 ext = (Z_External *) odr_malloc(assoc->decode, sizeof(*ext));
975 ext->direct_reference = odr_getoidbystr(assoc->decode,
976 "1.2.840.10003.16.2");
977 ext->indirect_reference = 0;
979 ext->which = Z_External_CQL;
980 ext->u.cql = srw_req->query;
982 rr.query->which = Z_Query_type_104;
983 rr.query->u.type_104 = ext;
986 else if (!strcmp(srw_req->queryType, "pqf"))
988 Z_RPNQuery *RPNquery;
989 YAZ_PQF_Parser pqf_parser;
991 pqf_parser = yaz_pqf_create();
993 RPNquery = yaz_pqf_parse(pqf_parser, assoc->decode, srw_req->query);
998 int code = yaz_pqf_error(pqf_parser, &pqf_msg, &off);
999 yaz_log(log_requestdetail, "Parse error %d %s near offset %ld",
1000 code, pqf_msg, (long) off);
1001 srw_error = YAZ_SRW_QUERY_SYNTAX_ERROR;
1004 rr.query->which = Z_Query_type_1;
1005 rr.query->u.type_1 = RPNquery;
1007 yaz_pqf_destroy(pqf_parser);
1011 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1012 &srw_res->num_diagnostics,
1013 YAZ_SRW_UNSUPP_QUERY_TYPE, 0);
1015 if (rr.query->u.type_1)
1017 rr.stream = assoc->encode;
1018 rr.decode = assoc->decode;
1019 rr.print = assoc->print;
1020 if (srw_req->sort.sortKeys)
1021 rr.srw_sortKeys = odr_strdup(assoc->encode,
1022 srw_req->sort.sortKeys);
1023 rr.association = assoc;
1028 rr.search_input = 0;
1030 if (srw_req->facetList)
1031 yaz_oi_set_facetlist(&rr.search_input, assoc->encode,
1032 srw_req->facetList);
1034 yaz_log_zquery_level(log_requestdetail,rr.query);
1036 (assoc->init->bend_search)(assoc->backend, &rr);
1039 if (rr.errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1045 srw_error = yaz_diag_bib1_to_srw(rr.errcode);
1046 yaz_add_srw_diagnostic(assoc->encode,
1047 &srw_res->diagnostics,
1048 &srw_res->num_diagnostics,
1049 srw_error, rr.errstring);
1054 int number = srw_req->maximumRecords ?
1055 odr_int_to_int(*srw_req->maximumRecords) : 0;
1056 int start = srw_req->startRecord ?
1057 odr_int_to_int(*srw_req->startRecord) : 1;
1059 yaz_log(log_requestdetail, "Request to pack %d+%d out of "
1061 start, number, rr.hits);
1063 srw_res->numberOfRecords = odr_intdup(assoc->encode, rr.hits);
1066 srw_res->resultSetId =
1067 odr_strdup(assoc->encode, rr.srw_setname );
1068 srw_res->resultSetIdleTime =
1069 odr_intdup(assoc->encode, *rr.srw_setnameIdleTime );
1072 srw_res->facetList = yaz_oi_get_facetlist(&rr.search_info);
1073 if (start > rr.hits || start < 1)
1075 /* if hits<=0 and start=1 we don't return a diagnostic */
1077 yaz_add_srw_diagnostic(
1079 &srw_res->diagnostics, &srw_res->num_diagnostics,
1080 YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
1082 else if (number > 0)
1086 if (start + number > rr.hits)
1087 number = odr_int_to_int(rr.hits) - start + 1;
1089 /* Call bend_present if defined */
1090 if (assoc->init->bend_present)
1092 bend_present_rr *bprr = (bend_present_rr*)
1093 odr_malloc(assoc->decode, sizeof(*bprr));
1094 bprr->setname = "default";
1095 bprr->start = start;
1096 bprr->number = number;
1097 if (srw_req->recordSchema)
1099 bprr->comp = (Z_RecordComposition *) odr_malloc(assoc->decode,
1100 sizeof(*bprr->comp));
1101 bprr->comp->which = Z_RecordComp_simple;
1102 bprr->comp->u.simple = (Z_ElementSetNames *)
1103 odr_malloc(assoc->decode, sizeof(Z_ElementSetNames));
1104 bprr->comp->u.simple->which = Z_ElementSetNames_generic;
1105 bprr->comp->u.simple->u.generic = srw_req->recordSchema;
1111 bprr->stream = assoc->encode;
1112 bprr->referenceId = 0;
1113 bprr->print = assoc->print;
1114 bprr->association = assoc;
1116 bprr->errstring = NULL;
1117 (*assoc->init->bend_present)(assoc->backend, bprr);
1121 srw_error = yaz_diag_bib1_to_srw(bprr->errcode);
1122 yaz_add_srw_diagnostic(assoc->encode,
1123 &srw_res->diagnostics,
1124 &srw_res->num_diagnostics,
1125 srw_error, bprr->errstring);
1133 int packing = Z_SRW_recordPacking_string;
1134 if (srw_req->recordPacking)
1137 yaz_srw_str_to_pack(srw_req->recordPacking);
1139 packing = Z_SRW_recordPacking_string;
1141 srw_res->records = (Z_SRW_record *)
1142 odr_malloc(assoc->encode,
1143 number * sizeof(*srw_res->records));
1145 srw_res->extra_records = (Z_SRW_extra_record **)
1146 odr_malloc(assoc->encode,
1147 number*sizeof(*srw_res->extra_records));
1149 for (i = 0; i<number; i++)
1152 int last_in_set = 0;
1153 const char *addinfo = 0;
1155 srw_res->records[j].recordPacking = packing;
1156 srw_res->records[j].recordData_buf = 0;
1157 srw_res->extra_records[j] = 0;
1158 yaz_log(YLOG_DEBUG, "srw_bend_fetch %d", i+start);
1159 errcode = srw_bend_fetch(assoc, i+start, srw_req,
1160 srw_res->records + j,
1161 &addinfo, &last_in_set);
1164 yaz_add_srw_diagnostic(assoc->encode,
1165 &srw_res->diagnostics,
1166 &srw_res->num_diagnostics,
1167 yaz_diag_bib1_to_srw(errcode),
1172 if (srw_res->records[j].recordData_buf)
1177 srw_res->num_records = j;
1179 srw_res->records = 0;
1182 if (rr.extra_response_data)
1184 res->extraResponseData_buf = rr.extra_response_data;
1185 res->extraResponseData_len = strlen(rr.extra_response_data);
1187 if (strcmp(res->srw_version, "2.") > 0)
1189 if (rr.estimated_hit_count)
1190 srw_res->resultCountPrecision =
1191 odr_strdup(assoc->encode, "estimate");
1192 else if (rr.partial_resultset)
1193 srw_res->resultCountPrecision =
1194 odr_strdup(assoc->encode, "minimum");
1196 srw_res->resultCountPrecision =
1197 odr_strdup(assoc->encode, "exact");
1199 else if (rr.estimated_hit_count || rr.partial_resultset)
1201 yaz_add_srw_diagnostic(
1203 &srw_res->diagnostics,
1204 &srw_res->num_diagnostics,
1205 YAZ_SRW_RESULT_SET_CREATED_WITH_VALID_PARTIAL_RESULTS_AVAILABLE,
1213 WRBUF wr = wrbuf_alloc();
1215 wrbuf_printf(wr, "SRWSearch %s ", srw_req->database);
1216 if (srw_res->num_diagnostics)
1217 wrbuf_printf(wr, "ERROR %s", srw_res->diagnostics[0].uri);
1218 else if (*http_code != 200)
1219 wrbuf_printf(wr, "ERROR info:http/%d", *http_code);
1220 else if (srw_res->numberOfRecords)
1222 wrbuf_printf(wr, "OK " ODR_INT_PRINTF,
1223 (srw_res->numberOfRecords ?
1224 *srw_res->numberOfRecords : 0));
1226 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+%d",
1227 (srw_res->resultSetId ?
1228 srw_res->resultSetId : "-"),
1229 (srw_req->startRecord ? *srw_req->startRecord : 1),
1230 srw_res->num_records);
1231 yaz_log(log_request, "%s %s: %s", wrbuf_cstr(wr), srw_req->queryType,
1237 static char *srw_bend_explain_default(bend_explain_rr *rr)
1240 xmlNodePtr ptr = (xmlNode *) rr->server_node_ptr;
1243 for (ptr = ptr->children; ptr; ptr = ptr->next)
1245 if (ptr->type != XML_ELEMENT_NODE)
1247 if (!strcmp((const char *) ptr->name, "explain"))
1250 xmlDocPtr doc = xmlNewDoc(BAD_CAST "1.0");
1254 ptr = xmlCopyNode(ptr, 1);
1256 xmlDocSetRootElement(doc, ptr);
1258 xmlDocDumpMemory(doc, &buf_out, &len);
1259 content = (char*) odr_malloc(rr->stream, 1+len);
1260 memcpy(content, buf_out, len);
1261 content[len] = '\0';
1265 rr->explain_buf = content;
1273 static void srw_bend_explain(association *assoc,
1274 Z_HTTP_Header *headers,
1276 Z_SRW_explainResponse *srw_res,
1279 Z_SRW_explainRequest *srw_req = sr->u.explain_request;
1280 yaz_log(log_requestdetail, "Got SRW ExplainRequest");
1281 srw_bend_init(assoc, headers,
1282 &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1283 if (!assoc->init && srw_res->num_diagnostics == 0)
1289 rr.stream = assoc->encode;
1290 rr.decode = assoc->decode;
1291 rr.print = assoc->print;
1293 rr.database = srw_req->database;
1295 rr.server_node_ptr = assoc->server->server_node_ptr;
1297 rr.server_node_ptr = 0;
1298 rr.schema = "http://explain.z3950.org/dtd/2.0/";
1299 if (assoc->init->bend_explain)
1300 (*assoc->init->bend_explain)(assoc->backend, &rr);
1302 srw_bend_explain_default(&rr);
1306 int packing = Z_SRW_recordPacking_string;
1307 if (srw_req->recordPacking)
1310 yaz_srw_str_to_pack(srw_req->recordPacking);
1312 packing = Z_SRW_recordPacking_string;
1314 srw_res->record.recordSchema = rr.schema;
1315 srw_res->record.recordPacking = packing;
1316 srw_res->record.recordData_buf = rr.explain_buf;
1317 srw_res->record.recordData_len = strlen(rr.explain_buf);
1318 srw_res->record.recordPosition = 0;
1324 static void srw_bend_scan(association *assoc,
1325 Z_HTTP_Header *headers,
1330 Z_SRW_scanRequest *srw_req = sr->u.scan_request;
1331 Z_SRW_scanResponse *srw_res = res->u.scan_response;
1332 yaz_log(log_requestdetail, "Got SRW ScanRequest");
1335 srw_bend_init(assoc, headers,
1336 &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1337 if (srw_res->num_diagnostics == 0 && assoc->init)
1340 struct scan_entry *save_entries;
1342 bend_scan_rr *bsrr = (bend_scan_rr *)
1343 odr_malloc(assoc->encode, sizeof(*bsrr));
1344 bsrr->num_bases = 1;
1345 bsrr->basenames = &srw_req->database;
1347 bsrr->num_entries = srw_req->maximumTerms ?
1348 odr_int_to_int(*srw_req->maximumTerms) : 10;
1349 bsrr->term_position = srw_req->responsePosition ?
1350 odr_int_to_int(*srw_req->responsePosition) : 1;
1353 bsrr->errstring = 0;
1354 bsrr->referenceId = 0;
1355 bsrr->stream = assoc->encode;
1356 bsrr->print = assoc->print;
1357 bsrr->step_size = &step_size;
1360 bsrr->extra_args = sr->extra_args;
1361 bsrr->extra_response_data = 0;
1363 if (bsrr->num_entries > 0)
1366 bsrr->entries = (struct scan_entry *)
1367 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
1369 for (i = 0; i<bsrr->num_entries; i++)
1371 bsrr->entries[i].term = 0;
1372 bsrr->entries[i].occurrences = 0;
1373 bsrr->entries[i].errcode = 0;
1374 bsrr->entries[i].errstring = 0;
1375 bsrr->entries[i].display_term = 0;
1378 save_entries = bsrr->entries; /* save it so we can compare later */
1380 if (srw_req->queryType && !strcmp(srw_req->queryType, "pqf") &&
1381 assoc->init->bend_scan)
1383 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1385 bsrr->term = yaz_pqf_scan(pqf_parser, assoc->decode,
1386 &bsrr->attributeset,
1387 srw_req->scanClause);
1388 yaz_pqf_destroy(pqf_parser);
1389 bsrr->scanClause = 0;
1390 ((int (*)(void *, bend_scan_rr *))
1391 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1393 else if ((!srw_req->queryType || !strcmp(srw_req->queryType, "cql"))
1394 && assoc->init->bend_scan && assoc->server
1395 && assoc->server->cql_transform)
1398 bsrr->scanClause = 0;
1399 bsrr->attributeset = 0;
1400 bsrr->term = (Z_AttributesPlusTerm *)
1401 odr_malloc(assoc->decode, sizeof(*bsrr->term));
1402 srw_error = cql2pqf_scan(assoc->encode,
1403 srw_req->scanClause,
1404 assoc->server->cql_transform,
1407 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1408 &srw_res->num_diagnostics,
1412 ((int (*)(void *, bend_scan_rr *))
1413 (*assoc->init->bend_scan))(assoc->backend, bsrr);
1416 else if ((!srw_req->queryType || !strcmp(srw_req->queryType, "cql"))
1417 && assoc->init->bend_srw_scan)
1420 bsrr->attributeset = 0;
1421 bsrr->scanClause = srw_req->scanClause;
1422 ((int (*)(void *, bend_scan_rr *))
1423 (*assoc->init->bend_srw_scan))(assoc->backend, bsrr);
1427 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1428 &srw_res->num_diagnostics,
1429 YAZ_SRW_UNSUPP_OPERATION, "scan");
1431 if (bsrr->extra_response_data)
1433 res->extraResponseData_buf = bsrr->extra_response_data;
1434 res->extraResponseData_len = strlen(bsrr->extra_response_data);
1439 if (bsrr->errcode == YAZ_BIB1_DATABASE_UNAVAILABLE)
1444 srw_error = yaz_diag_bib1_to_srw(bsrr->errcode);
1446 yaz_add_srw_diagnostic(assoc->encode, &srw_res->diagnostics,
1447 &srw_res->num_diagnostics,
1448 srw_error, bsrr->errstring);
1450 else if (srw_res->num_diagnostics == 0 && bsrr->num_entries)
1453 srw_res->terms = (Z_SRW_scanTerm*)
1454 odr_malloc(assoc->encode, sizeof(*srw_res->terms) *
1457 srw_res->num_terms = bsrr->num_entries;
1458 for (i = 0; i<bsrr->num_entries; i++)
1460 Z_SRW_scanTerm *t = srw_res->terms + i;
1461 t->value = odr_strdup(assoc->encode, bsrr->entries[i].term);
1462 t->numberOfRecords =
1463 odr_intdup(assoc->encode, bsrr->entries[i].occurrences);
1465 if (save_entries == bsrr->entries &&
1466 bsrr->entries[i].display_term)
1468 /* the entries was _not_ set by the handler. So it's
1469 safe to test for new member display_term. It is
1472 t->displayTerm = odr_strdup(assoc->encode,
1473 bsrr->entries[i].display_term);
1481 WRBUF wr = wrbuf_alloc();
1482 wrbuf_printf(wr, "SRWScan %s ", srw_req->database);
1484 if (srw_res->num_diagnostics)
1485 wrbuf_printf(wr, "ERROR %s - ", srw_res->diagnostics[0].uri);
1486 else if (srw_res->num_terms)
1487 wrbuf_printf(wr, "OK %d - ", srw_res->num_terms);
1489 wrbuf_printf(wr, "OK - - ");
1491 wrbuf_printf(wr, ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
1492 (srw_req->responsePosition ?
1493 *srw_req->responsePosition : 1),
1494 (srw_req->maximumTerms ?
1495 *srw_req->maximumTerms : 1));
1496 /* there is no step size in SRU/W ??? */
1497 wrbuf_printf(wr, "%s: %s ", srw_req->queryType, srw_req->scanClause);
1498 yaz_log(log_request, "%s ", wrbuf_cstr(wr) );
1504 static void srw_bend_update(association *assoc,
1505 Z_HTTP_Header *headers,
1507 Z_SRW_updateResponse *srw_res,
1510 Z_SRW_updateRequest *srw_req = sr->u.update_request;
1511 yaz_log(log_session, "SRWUpdate action=%s", srw_req->operation);
1512 yaz_log(YLOG_DEBUG, "num_diag = %d", srw_res->num_diagnostics );
1513 srw_bend_init(assoc, headers,
1514 &srw_res->diagnostics, &srw_res->num_diagnostics, sr);
1515 if (!assoc->init && srw_res->num_diagnostics == 0)
1520 Z_SRW_extra_record *extra = srw_req->extra_record;
1522 rr.stream = assoc->encode;
1523 rr.print = assoc->print;
1525 rr.basenames = &srw_req->database;
1526 rr.operation = srw_req->operation;
1527 rr.operation_status = "failed";
1529 rr.record_versions = 0;
1530 rr.num_versions = 0;
1531 rr.record_packing = "string";
1532 rr.record_schema = 0;
1534 rr.extra_record_data = 0;
1535 rr.extra_request_data = 0;
1536 rr.extra_response_data = 0;
1542 if (rr.operation == 0)
1544 yaz_add_sru_update_diagnostic(
1545 assoc->encode, &srw_res->diagnostics,
1546 &srw_res->num_diagnostics,
1547 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1551 yaz_log(YLOG_DEBUG, "basename = %s", rr.basenames[0] );
1552 yaz_log(YLOG_DEBUG, "Operation = %s", rr.operation );
1553 if (!strcmp( rr.operation, "delete"))
1555 if (srw_req->record && !srw_req->record->recordSchema)
1557 rr.record_schema = odr_strdup(
1559 srw_req->record->recordSchema);
1561 if (srw_req->record)
1563 rr.record_data = odr_strdupn(
1565 srw_req->record->recordData_buf,
1566 srw_req->record->recordData_len );
1568 if (extra && extra->extraRecordData_len)
1570 rr.extra_record_data = odr_strdupn(
1572 extra->extraRecordData_buf,
1573 extra->extraRecordData_len );
1575 if (srw_req->recordId)
1576 rr.record_id = srw_req->recordId;
1577 else if (extra && extra->recordIdentifier)
1578 rr.record_id = extra->recordIdentifier;
1580 else if (!strcmp(rr.operation, "replace"))
1582 if (srw_req->recordId)
1583 rr.record_id = srw_req->recordId;
1584 else if (extra && extra->recordIdentifier)
1585 rr.record_id = extra->recordIdentifier;
1588 yaz_add_sru_update_diagnostic(
1589 assoc->encode, &srw_res->diagnostics,
1590 &srw_res->num_diagnostics,
1591 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1592 "recordIdentifier");
1594 if (!srw_req->record)
1596 yaz_add_sru_update_diagnostic(
1597 assoc->encode, &srw_res->diagnostics,
1598 &srw_res->num_diagnostics,
1599 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1604 if (srw_req->record->recordSchema)
1605 rr.record_schema = odr_strdup(
1606 assoc->encode, srw_req->record->recordSchema);
1607 if (srw_req->record->recordData_len )
1609 rr.record_data = odr_strdupn(assoc->encode,
1610 srw_req->record->recordData_buf,
1611 srw_req->record->recordData_len );
1615 yaz_add_sru_update_diagnostic(
1616 assoc->encode, &srw_res->diagnostics,
1617 &srw_res->num_diagnostics,
1618 YAZ_SRU_UPDATE_MISSING_MANDATORY_ELEMENT_RECORD_REJECTED,
1622 if (extra && extra->extraRecordData_len)
1624 rr.extra_record_data = odr_strdupn(
1626 extra->extraRecordData_buf,
1627 extra->extraRecordData_len );
1630 else if (!strcmp(rr.operation, "insert"))
1632 if (srw_req->recordId)
1633 rr.record_id = srw_req->recordId;
1635 rr.record_id = extra->recordIdentifier;
1637 if (srw_req->record)
1639 if (srw_req->record->recordSchema)
1640 rr.record_schema = odr_strdup(
1641 assoc->encode, srw_req->record->recordSchema);
1643 if (srw_req->record->recordData_len)
1644 rr.record_data = odr_strdupn(
1646 srw_req->record->recordData_buf,
1647 srw_req->record->recordData_len );
1649 if (extra && extra->extraRecordData_len)
1651 rr.extra_record_data = odr_strdupn(
1653 extra->extraRecordData_buf,
1654 extra->extraRecordData_len );
1658 yaz_add_sru_update_diagnostic(assoc->encode, &srw_res->diagnostics,
1659 &srw_res->num_diagnostics,
1660 YAZ_SRU_UPDATE_INVALID_ACTION,
1663 if (srw_req->record)
1665 const char *pack_str =
1666 yaz_srw_pack_to_str(srw_req->record->recordPacking);
1668 rr.record_packing = odr_strdup(assoc->encode, pack_str);
1671 if (srw_req->num_recordVersions)
1673 rr.record_versions = srw_req->recordVersions;
1674 rr.num_versions = srw_req->num_recordVersions;
1676 if (srw_req->extraRequestData_len)
1678 rr.extra_request_data = odr_strdupn(assoc->encode,
1679 srw_req->extraRequestData_buf,
1680 srw_req->extraRequestData_len );
1682 if (srw_res->num_diagnostics == 0)
1684 if ( assoc->init->bend_srw_update)
1685 (*assoc->init->bend_srw_update)(assoc->backend, &rr);
1687 yaz_add_sru_update_diagnostic(
1688 assoc->encode, &srw_res->diagnostics,
1689 &srw_res->num_diagnostics,
1690 YAZ_SRU_UPDATE_UNSPECIFIED_DATABASE_ERROR,
1691 "No Update backend handler");
1695 yaz_add_srw_diagnostic_uri(assoc->encode,
1696 &srw_res->diagnostics,
1697 &srw_res->num_diagnostics,
1701 srw_res->recordId = rr.record_id;
1702 srw_res->operationStatus = rr.operation_status;
1703 srw_res->recordVersions = rr.record_versions;
1704 srw_res->num_recordVersions = rr.num_versions;
1705 if (srw_res->extraResponseData_len)
1707 srw_res->extraResponseData_buf = rr.extra_response_data;
1708 srw_res->extraResponseData_len = strlen(rr.extra_response_data);
1710 if (srw_res->num_diagnostics == 0 && rr.record_data)
1712 srw_res->record = yaz_srw_get_record(assoc->encode);
1713 srw_res->record->recordSchema = rr.record_schema;
1714 if (rr.record_packing)
1716 int pack = yaz_srw_str_to_pack(rr.record_packing);
1720 pack = Z_SRW_recordPacking_string;
1721 yaz_log(YLOG_WARN, "Back packing %s from backend",
1724 srw_res->record->recordPacking = pack;
1726 srw_res->record->recordData_buf = rr.record_data;
1727 srw_res->record->recordData_len = strlen(rr.record_data);
1728 if (rr.extra_record_data)
1730 Z_SRW_extra_record *ex =
1731 yaz_srw_get_extra_record(assoc->encode);
1732 srw_res->extra_record = ex;
1733 ex->extraRecordData_buf = rr.extra_record_data;
1734 ex->extraRecordData_len = strlen(rr.extra_record_data);
1740 /* check if path is OK (1); BAD (0) */
1741 static int check_path(const char *path)
1745 if (strstr(path, ".."))
1750 static char *read_file(const char *fname, ODR o, size_t *sz)
1753 FILE *inf = fopen(fname, "rb");
1757 fseek(inf, 0L, SEEK_END);
1760 buf = (char *) odr_malloc(o, *sz);
1761 if (fread(buf, 1, *sz, inf) != *sz)
1762 yaz_log(YLOG_WARN|YLOG_ERRNO, "short read %s", fname);
1767 static void process_http_request(association *assoc, request *req)
1769 Z_HTTP_Request *hreq = req->gdu_request->u.HTTP_Request;
1770 ODR o = assoc->encode;
1771 int r = 2; /* 2=NOT TAKEN, 1=TAKEN, 0=SOAP TAKEN */
1773 Z_SOAP *soap_package = 0;
1776 Z_HTTP_Response *hres = 0;
1778 const char *stylesheet = 0; /* for now .. set later */
1779 Z_SRW_diagnostic *diagnostic = 0;
1780 int num_diagnostic = 0;
1781 const char *host = z_HTTP_header_lookup(hreq->headers, "Host");
1783 yaz_log(log_request, "%s %s HTTP/%s", hreq->method, hreq->path, hreq->version);
1784 if (!control_association(assoc, host, 0))
1786 p = z_get_HTTP_Response(o, 404);
1789 if (r == 2 && assoc->server && assoc->server->docpath
1790 && hreq->path[0] == '/'
1792 /* check if path is a proper prefix of documentroot */
1793 strncmp(hreq->path+1, assoc->server->docpath,
1794 strlen(assoc->server->docpath))
1797 if (!check_path(hreq->path))
1799 yaz_log(YLOG_LOG, "File %s access forbidden", hreq->path+1);
1800 p = z_get_HTTP_Response(o, 404);
1804 size_t content_size = 0;
1805 char *content_buf = read_file(hreq->path+1, o, &content_size);
1808 yaz_log(YLOG_LOG, "File %s not found", hreq->path+1);
1809 p = z_get_HTTP_Response(o, 404);
1813 const char *ctype = 0;
1814 yaz_mime_types types = yaz_mime_types_create();
1816 yaz_mime_types_add(types, "xsl", "application/xml");
1817 yaz_mime_types_add(types, "xml", "application/xml");
1818 yaz_mime_types_add(types, "css", "text/css");
1819 yaz_mime_types_add(types, "html", "text/html");
1820 yaz_mime_types_add(types, "htm", "text/html");
1821 yaz_mime_types_add(types, "txt", "text/plain");
1822 yaz_mime_types_add(types, "js", "application/x-javascript");
1824 yaz_mime_types_add(types, "gif", "image/gif");
1825 yaz_mime_types_add(types, "png", "image/png");
1826 yaz_mime_types_add(types, "jpg", "image/jpeg");
1827 yaz_mime_types_add(types, "jpeg", "image/jpeg");
1829 ctype = yaz_mime_lookup_fname(types, hreq->path);
1832 yaz_log(YLOG_LOG, "No mime type for %s", hreq->path+1);
1833 p = z_get_HTTP_Response(o, 404);
1837 p = z_get_HTTP_Response(o, 200);
1838 hres = p->u.HTTP_Response;
1839 hres->content_buf = content_buf;
1840 hres->content_len = content_size;
1841 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1843 yaz_mime_types_destroy(types);
1851 r = yaz_srw_decode(hreq, &sr, &soap_package, assoc->decode, &charset);
1852 yaz_log(YLOG_DEBUG, "yaz_srw_decode returned %d", r);
1854 if (r == 2) /* not taken */
1856 r = yaz_sru_decode(hreq, &sr, &soap_package, assoc->decode, &charset,
1857 &diagnostic, &num_diagnostic);
1858 yaz_log(YLOG_DEBUG, "yaz_sru_decode returned %d", r);
1860 if (r == 0) /* decode SRW/SRU OK .. */
1862 int http_code = 200;
1863 if (sr->which == Z_SRW_searchRetrieve_request)
1866 yaz_srw_get_pdu_e(assoc->encode, Z_SRW_searchRetrieve_response,
1868 stylesheet = sr->u.request->stylesheet;
1871 res->u.response->diagnostics = diagnostic;
1872 res->u.response->num_diagnostics = num_diagnostic;
1876 srw_bend_search(assoc, hreq->headers, sr, res, &http_code);
1878 if (http_code == 200)
1879 soap_package->u.generic->p = res;
1881 else if (sr->which == Z_SRW_explain_request)
1883 Z_SRW_PDU *res = yaz_srw_get_pdu_e(o, Z_SRW_explain_response, sr);
1884 stylesheet = sr->u.explain_request->stylesheet;
1887 res->u.explain_response->diagnostics = diagnostic;
1888 res->u.explain_response->num_diagnostics = num_diagnostic;
1890 srw_bend_explain(assoc, hreq->headers,
1891 sr, res->u.explain_response, &http_code);
1892 if (http_code == 200)
1893 soap_package->u.generic->p = res;
1895 else if (sr->which == Z_SRW_scan_request)
1897 Z_SRW_PDU *res = yaz_srw_get_pdu_e(o, Z_SRW_scan_response, sr);
1898 stylesheet = sr->u.scan_request->stylesheet;
1901 res->u.scan_response->diagnostics = diagnostic;
1902 res->u.scan_response->num_diagnostics = num_diagnostic;
1904 srw_bend_scan(assoc, hreq->headers, sr, res, &http_code);
1905 if (http_code == 200)
1906 soap_package->u.generic->p = res;
1908 else if (sr->which == Z_SRW_update_request)
1910 Z_SRW_PDU *res = yaz_srw_get_pdu(o, Z_SRW_update_response,
1912 yaz_log(YLOG_DEBUG, "handling SRW UpdateRequest");
1915 res->u.update_response->diagnostics = diagnostic;
1916 res->u.update_response->num_diagnostics = num_diagnostic;
1918 yaz_log(YLOG_DEBUG, "num_diag = %d", res->u.update_response->num_diagnostics );
1919 srw_bend_update(assoc, hreq->headers,
1920 sr, res->u.update_response, &http_code);
1921 if (http_code == 200)
1922 soap_package->u.generic->p = res;
1926 yaz_log(log_request, "SOAP ERROR");
1927 /* FIXME - what error, what query */
1929 z_soap_error(assoc->encode, soap_package,
1930 "SOAP-ENV:Client", "Bad method", 0);
1932 if (http_code == 200 || http_code == 500)
1934 static Z_SOAP_Handler soap_handlers[4] = {
1936 {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec},
1937 {YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec},
1938 {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec},
1943 p = z_get_HTTP_Response(o, 200);
1944 hres = p->u.HTTP_Response;
1946 if (!stylesheet && assoc->server)
1947 stylesheet = assoc->server->stylesheet;
1949 /* empty stylesheet means NO stylesheet */
1950 if (stylesheet && *stylesheet == '\0')
1953 z_soap_codec_enc_xsl(assoc->encode, &soap_package,
1954 &hres->content_buf, &hres->content_len,
1955 soap_handlers, charset, stylesheet);
1956 hres->code = http_code;
1958 strcpy(ctype, "text/xml");
1959 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
1962 p = z_get_HTTP_Response(o, http_code);
1966 p = z_get_HTTP_Response(o, 500);
1967 hres = p->u.HTTP_Response;
1968 if (!strcmp(hreq->version, "1.0"))
1970 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1971 if (v && !strcmp(v, "Keep-Alive"))
1975 hres->version = "1.0";
1979 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1980 if (v && !strcmp(v, "close"))
1984 hres->version = "1.1";
1986 if (!keepalive || !assoc->last_control->keepalive)
1988 z_HTTP_header_add(o, &hres->headers, "Connection", "close");
1989 assoc->state = ASSOC_DEAD;
1990 assoc->cs_get_mask = 0;
1995 const char *alive = z_HTTP_header_lookup(hreq->headers, "Keep-Alive");
1997 if (alive && yaz_isdigit(*(const unsigned char *) alive))
2001 if (t < 0 || t > 3600)
2003 iochan_settimeout(assoc->client_chan,t);
2004 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
2006 process_gdu_response(assoc, req, p);
2009 static void process_gdu_request(association *assoc, request *req)
2011 if (req->gdu_request->which == Z_GDU_Z3950)
2014 req->apdu_request = req->gdu_request->u.z3950;
2015 if (process_z_request(assoc, req, &msg) < 0)
2016 do_close_req(assoc, Z_Close_systemProblem, msg, req);
2018 else if (req->gdu_request->which == Z_GDU_HTTP_Request)
2019 process_http_request(assoc, req);
2022 do_close_req(assoc, Z_Close_systemProblem, "bad protocol packet", req);
2027 * Initiate request processing.
2029 static int process_z_request(association *assoc, request *req, char **msg)
2034 *msg = "Unknown Error";
2035 assert(req && req->state == REQUEST_IDLE);
2036 if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
2038 *msg = "Missing InitRequest";
2041 switch (req->apdu_request->which)
2043 case Z_APDU_initRequest:
2044 res = process_initRequest(assoc, req); break;
2045 case Z_APDU_searchRequest:
2046 res = process_searchRequest(assoc, req); break;
2047 case Z_APDU_presentRequest:
2048 res = process_presentRequest(assoc, req); break;
2049 case Z_APDU_scanRequest:
2050 if (assoc->init->bend_scan)
2051 res = process_scanRequest(assoc, req);
2054 *msg = "Cannot handle Scan APDU";
2058 case Z_APDU_extendedServicesRequest:
2059 if (assoc->init->bend_esrequest)
2060 res = process_ESRequest(assoc, req);
2063 *msg = "Cannot handle Extended Services APDU";
2067 case Z_APDU_sortRequest:
2068 if (assoc->init->bend_sort)
2069 res = process_sortRequest(assoc, req);
2072 *msg = "Cannot handle Sort APDU";
2077 process_close(assoc, req);
2079 case Z_APDU_deleteResultSetRequest:
2080 if (assoc->init->bend_delete)
2081 res = process_deleteRequest(assoc, req);
2084 *msg = "Cannot handle Delete APDU";
2088 case Z_APDU_segmentRequest:
2089 if (assoc->init->bend_segment)
2091 res = process_segmentRequest(assoc, req);
2095 *msg = "Cannot handle Segment APDU";
2099 case Z_APDU_triggerResourceControlRequest:
2102 *msg = "Bad APDU received";
2107 yaz_log(YLOG_DEBUG, " result immediately available");
2108 retval = process_z_response(assoc, req, res);
2112 yaz_log(YLOG_DEBUG, " result unavailable");
2119 * Encode response, and transfer the request structure to the outgoing queue.
2121 static int process_gdu_response(association *assoc, request *req, Z_GDU *res)
2123 odr_setbuf(assoc->encode, req->response, req->size_response, 1);
2127 if (!z_GDU(assoc->print, &res, 0, 0))
2128 yaz_log(YLOG_WARN, "ODR print error: %s",
2129 odr_errmsg(odr_geterror(assoc->print)));
2130 odr_reset(assoc->print);
2132 if (!z_GDU(assoc->encode, &res, 0, 0))
2134 yaz_log(YLOG_WARN, "ODR error when encoding PDU: %s [element %s]",
2135 odr_errmsg(odr_geterror(assoc->decode)),
2136 odr_getelement(assoc->decode));
2139 req->response = odr_getbuf(assoc->encode, &req->len_response,
2140 &req->size_response);
2141 odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
2142 odr_reset(assoc->encode);
2143 req->state = REQUEST_IDLE;
2144 request_enq(&assoc->outgoing, req);
2145 /* turn the work over to the ir_session handler */
2146 iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
2147 assoc->cs_put_mask = EVENT_OUTPUT;
2148 /* Is there more work to be done? give that to the input handler too */
2151 req = request_head(&assoc->incoming);
2152 if (req && req->state == REQUEST_IDLE)
2154 request_deq(&assoc->incoming);
2155 process_gdu_request(assoc, req);
2164 * Encode response, and transfer the request structure to the outgoing queue.
2166 static int process_z_response(association *assoc, request *req, Z_APDU *res)
2168 Z_GDU *gres = (Z_GDU *) odr_malloc(assoc->encode, sizeof(*gres));
2169 gres->which = Z_GDU_Z3950;
2170 gres->u.z3950 = res;
2172 return process_gdu_response(assoc, req, gres);
2175 static char *get_vhost(Z_OtherInformation *otherInfo)
2177 return yaz_oi_get_string_oid(&otherInfo, yaz_oid_userinfo_proxy, 1, 0);
2181 * Handle init request.
2182 * At the moment, we don't check the options
2183 * anywhere else in the code - we just try not to do anything that would
2184 * break a naive client. We'll toss 'em into the association block when
2185 * we need them there.
2187 static Z_APDU *process_initRequest(association *assoc, request *reqb)
2189 Z_InitRequest *req = reqb->apdu_request->u.initRequest;
2190 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
2191 Z_InitResponse *resp = apdu->u.initResponse;
2192 bend_initresult *binitres;
2194 statserv_options_block *cb = 0; /* by default no control for backend */
2196 if (control_association(assoc, get_vhost(req->otherInfo), 1))
2197 cb = statserv_getcontrol(); /* got control block for backend */
2199 if (cb && assoc->backend)
2200 (*cb->bend_close)(assoc->backend);
2202 yaz_log(log_requestdetail, "Got initRequest");
2203 if (req->implementationId)
2204 yaz_log(log_requestdetail, "Id: %s",
2205 req->implementationId);
2206 if (req->implementationName)
2207 yaz_log(log_requestdetail, "Name: %s",
2208 req->implementationName);
2209 if (req->implementationVersion)
2210 yaz_log(log_requestdetail, "Version: %s",
2211 req->implementationVersion);
2213 assoc_init_reset(assoc,
2214 yaz_oi_get_string_oid(&req->otherInfo,
2215 yaz_oid_userinfo_client_ip, 1, 0));
2216 assoc->init->auth = req->idAuthentication;
2217 assoc->init->referenceId = req->referenceId;
2219 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2221 Z_CharSetandLanguageNegotiation *negotiation =
2222 yaz_get_charneg_record (req->otherInfo);
2224 negotiation->which == Z_CharSetandLanguageNegotiation_proposal)
2225 assoc->init->charneg_request = negotiation;
2228 /* by default named_result_sets is 0 .. Enable it if client asks for it. */
2229 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
2230 assoc->init->named_result_sets = 1;
2235 if (req->implementationVersion)
2236 yaz_log(log_requestdetail, "Config: %s",
2239 iochan_settimeout(assoc->client_chan, cb->idle_timeout);
2241 /* we have a backend control block, so call that init function */
2242 if (!(binitres = (*cb->bend_init)(assoc->init)))
2244 yaz_log(YLOG_WARN, "Bad response from backend.");
2247 assoc->backend = binitres->handle;
2251 /* no backend. return error */
2252 binitres = (bend_initresult *)
2253 odr_malloc(assoc->encode, sizeof(*binitres));
2254 binitres->errstring = 0;
2255 binitres->errcode = YAZ_BIB1_PERMANENT_SYSTEM_ERROR;
2256 iochan_settimeout(assoc->client_chan, 10);
2258 if ((assoc->init->bend_sort))
2259 yaz_log(YLOG_DEBUG, "Sort handler installed");
2260 if ((assoc->init->bend_search))
2261 yaz_log(YLOG_DEBUG, "Search handler installed");
2262 if ((assoc->init->bend_present))
2263 yaz_log(YLOG_DEBUG, "Present handler installed");
2264 if ((assoc->init->bend_esrequest))
2265 yaz_log(YLOG_DEBUG, "ESRequest handler installed");
2266 if ((assoc->init->bend_delete))
2267 yaz_log(YLOG_DEBUG, "Delete handler installed");
2268 if ((assoc->init->bend_scan))
2269 yaz_log(YLOG_DEBUG, "Scan handler installed");
2270 if ((assoc->init->bend_segment))
2271 yaz_log(YLOG_DEBUG, "Segment handler installed");
2273 resp->referenceId = req->referenceId;
2275 /* let's tell the client what we can do */
2276 if (ODR_MASK_GET(req->options, Z_Options_search))
2278 ODR_MASK_SET(resp->options, Z_Options_search);
2279 strcat(options, "srch");
2281 if (ODR_MASK_GET(req->options, Z_Options_present))
2283 ODR_MASK_SET(resp->options, Z_Options_present);
2284 strcat(options, " prst");
2286 if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
2287 assoc->init->bend_delete)
2289 ODR_MASK_SET(resp->options, Z_Options_delSet);
2290 strcat(options, " del");
2292 if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
2293 assoc->init->bend_esrequest)
2295 ODR_MASK_SET(resp->options, Z_Options_extendedServices);
2296 strcat(options, " extendedServices");
2298 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets)
2299 && assoc->init->named_result_sets)
2301 ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
2302 strcat(options, " namedresults");
2304 if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
2306 ODR_MASK_SET(resp->options, Z_Options_scan);
2307 strcat(options, " scan");
2309 if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
2311 ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
2312 strcat(options, " concurrop");
2314 if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
2316 ODR_MASK_SET(resp->options, Z_Options_sort);
2317 strcat(options, " sort");
2320 if (ODR_MASK_GET(req->options, Z_Options_negotiationModel))
2322 Z_OtherInformationUnit *p0;
2324 if (!assoc->init->charneg_response)
2326 if (assoc->init->query_charset)
2328 assoc->init->charneg_response = yaz_set_response_charneg(
2329 assoc->encode, assoc->init->query_charset, 0,
2330 assoc->init->records_in_same_charset);
2334 yaz_log(YLOG_WARN, "default query_charset not defined by backend");
2337 if (assoc->init->charneg_response
2338 && (p0=yaz_oi_update(&resp->otherInfo, assoc->encode, NULL, 0, 0)))
2340 p0->which = Z_OtherInfo_externallyDefinedInfo;
2341 p0->information.externallyDefinedInfo =
2342 assoc->init->charneg_response;
2343 ODR_MASK_SET(resp->options, Z_Options_negotiationModel);
2344 strcat(options, " negotiation");
2347 if (ODR_MASK_GET(req->options, Z_Options_triggerResourceCtrl))
2348 ODR_MASK_SET(resp->options, Z_Options_triggerResourceCtrl);
2350 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
2352 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
2353 assoc->version = 1; /* 1 & 2 are equivalent */
2355 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
2357 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
2360 if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
2362 ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
2366 yaz_log(log_requestdetail, "Negotiated to v%d: %s", assoc->version, options);
2368 if (*req->maximumRecordSize < assoc->maximumRecordSize)
2369 assoc->maximumRecordSize = odr_int_to_int(*req->maximumRecordSize);
2371 if (*req->preferredMessageSize < assoc->preferredMessageSize)
2372 assoc->preferredMessageSize = odr_int_to_int(*req->preferredMessageSize);
2374 resp->preferredMessageSize =
2375 odr_intdup(assoc->encode, assoc->preferredMessageSize);
2376 resp->maximumRecordSize =
2377 odr_intdup(assoc->encode, assoc->maximumRecordSize);
2379 resp->implementationId = odr_prepend(assoc->encode,
2380 assoc->init->implementation_id,
2381 resp->implementationId);
2383 resp->implementationVersion = odr_prepend(assoc->encode,
2384 assoc->init->implementation_version,
2385 resp->implementationVersion);
2387 resp->implementationName = odr_prepend(assoc->encode,
2388 assoc->init->implementation_name,
2389 odr_prepend(assoc->encode, "GFS", resp->implementationName));
2391 if (binitres->errcode)
2393 assoc->state = ASSOC_DEAD;
2394 resp->userInformationField =
2395 init_diagnostics(assoc->encode, binitres->errcode,
2396 binitres->errstring);
2400 assoc->state = ASSOC_UP;
2404 if (!req->idAuthentication)
2405 yaz_log(log_request, "Auth none");
2406 else if (req->idAuthentication->which == Z_IdAuthentication_open)
2408 const char *open = req->idAuthentication->u.open;
2409 const char *slash = strchr(open, '/');
2415 yaz_log(log_request, "Auth open %.*s", len, open);
2417 else if (req->idAuthentication->which == Z_IdAuthentication_idPass)
2419 const char *user = req->idAuthentication->u.idPass->userId;
2420 const char *group = req->idAuthentication->u.idPass->groupId;
2421 yaz_log(log_request, "Auth idPass %s %s",
2422 user ? user : "-", group ? group : "-");
2424 else if (req->idAuthentication->which
2425 == Z_IdAuthentication_anonymous)
2427 yaz_log(log_request, "Auth anonymous");
2431 yaz_log(log_request, "Auth other");
2436 WRBUF wr = wrbuf_alloc();
2437 wrbuf_printf(wr, "Init ");
2438 if (binitres->errcode)
2439 wrbuf_printf(wr, "ERROR %d", binitres->errcode);
2441 wrbuf_printf(wr, "OK -");
2442 wrbuf_printf(wr, " ID:%s Name:%s Version:%s",
2443 (req->implementationId ? req->implementationId :"-"),
2444 (req->implementationName ?
2445 req->implementationName : "-"),
2446 (req->implementationVersion ?
2447 req->implementationVersion : "-")
2449 yaz_log(log_request, "%s", wrbuf_cstr(wr));
2456 * Set the specified `errcode' and `errstring' into a UserInfo-1
2457 * external to be returned to the client in accordance with Z35.90
2458 * Implementor Agreement 5 (Returning diagnostics in an InitResponse):
2459 * http://lcweb.loc.gov/z3950/agency/agree/initdiag.html
2461 static Z_External *init_diagnostics(ODR odr, int error, const char *addinfo)
2463 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2464 addinfo ? " -- " : "", addinfo ? addinfo : "");
2465 return zget_init_diagnostics(odr, error, addinfo);
2469 * nonsurrogate diagnostic record.
2471 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
2473 Z_Records *rec = (Z_Records *) odr_malloc(assoc->encode, sizeof(*rec));
2475 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2476 addinfo ? " -- " : "", addinfo ? addinfo : "");
2478 rec->which = Z_Records_NSD;
2479 rec->u.nonSurrogateDiagnostic = zget_DefaultDiagFormat(assoc->encode,
2485 * surrogate diagnostic.
2487 static Z_NamePlusRecord *surrogatediagrec(association *assoc,
2489 int error, const char *addinfo)
2491 yaz_log(log_requestdetail, "[%d] %s%s%s", error, diagbib1_str(error),
2492 addinfo ? " -- " : "", addinfo ? addinfo : "");
2493 return zget_surrogateDiagRec(assoc->encode, dbname, error, addinfo);
2496 static Z_Records *pack_records(association *a, char *setname, Odr_int start,
2497 Odr_int *num, Z_RecordComposition *comp,
2498 Odr_int *next, Odr_int *pres,
2499 Z_ReferenceId *referenceId,
2500 Odr_oid *oid, int *errcode)
2503 Odr_int dumped_records = 0;
2504 int toget = odr_int_to_int(*num);
2505 Z_Records *records =
2506 (Z_Records *) odr_malloc(a->encode, sizeof(*records));
2507 Z_NamePlusRecordList *reclist =
2508 (Z_NamePlusRecordList *) odr_malloc(a->encode, sizeof(*reclist));
2510 records->which = Z_Records_DBOSD;
2511 records->u.databaseOrSurDiagnostics = reclist;
2512 reclist->num_records = 0;
2515 return diagrec(a, YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE, 0);
2516 else if (toget == 0)
2517 reclist->records = odr_nullval();
2519 reclist->records = (Z_NamePlusRecord **)
2520 odr_malloc(a->encode, sizeof(*reclist->records) * toget);
2522 *pres = Z_PresentStatus_success;
2526 yaz_log(log_requestdetail, "Request to pack " ODR_INT_PRINTF "+%d %s", start, toget, setname);
2527 yaz_log(log_requestdetail, "pms=%d, mrs=%d", a->preferredMessageSize,
2528 a->maximumRecordSize);
2529 for (recno = odr_int_to_int(start); reclist->num_records < toget; recno++)
2532 Z_NamePlusRecord *thisrec;
2533 Odr_int this_length = 0;
2535 * we get the number of bytes allocated on the stream before any
2536 * allocation done by the backend - this should give us a reasonable
2537 * idea of the total size of the data so far.
2539 Odr_int total_length = odr_total(a->encode) - dumped_records;
2545 freq.last_in_set = 0;
2546 freq.setname = setname;
2547 freq.surrogate_flag = 0;
2548 freq.number = recno;
2550 freq.request_format = oid;
2551 freq.output_format = 0;
2552 freq.stream = a->encode;
2553 freq.print = a->print;
2554 freq.referenceId = referenceId;
2557 retrieve_fetch(a, &freq);
2559 *next = freq.last_in_set ? 0 : recno + 1;
2563 if (!freq.surrogate_flag) /* non-surrogate diagnostic i.e. global */
2566 *pres = Z_PresentStatus_failure;
2567 /* for 'present request out of range',
2568 set addinfo to record position if not set */
2569 if (freq.errcode == YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE &&
2570 freq.errstring == 0)
2572 sprintf(s, "%d", recno);
2576 *errcode = freq.errcode;
2577 return diagrec(a, freq.errcode, freq.errstring);
2579 reclist->records[reclist->num_records] =
2580 surrogatediagrec(a, freq.basename, freq.errcode,
2582 reclist->num_records++;
2585 if (freq.record == 0) /* no error and no record ? */
2587 *pres = Z_PresentStatus_partial_4;
2588 *next = 0; /* signal end-of-set and stop */
2592 this_length = freq.len;
2594 this_length = odr_total(a->encode) - total_length - dumped_records;
2595 yaz_log(log_requestdetail, " fetched record, len=" ODR_INT_PRINTF
2596 " total=" ODR_INT_PRINTF " dumped=" ODR_INT_PRINTF,
2597 this_length, total_length, dumped_records);
2598 if (a->preferredMessageSize > 0 &&
2599 this_length + total_length > a->preferredMessageSize)
2601 /* record is small enough, really */
2602 if (this_length <= a->preferredMessageSize && recno > start)
2604 yaz_log(log_requestdetail, " Dropped last normal-sized record");
2605 *pres = Z_PresentStatus_partial_2;
2610 /* record can only be fetched by itself */
2611 if (this_length < a->maximumRecordSize)
2613 yaz_log(log_requestdetail, " Record > prefmsgsz");
2616 yaz_log(YLOG_DEBUG, " Dropped it");
2617 reclist->records[reclist->num_records] =
2620 YAZ_BIB1_RECORD_EXCEEDS_PREFERRED_MESSAGE_SIZE, 0);
2621 reclist->num_records++;
2622 dumped_records += this_length;
2626 else /* too big entirely */
2628 yaz_log(log_requestdetail, "Record > maxrcdsz "
2629 "this=" ODR_INT_PRINTF " max=%d",
2630 this_length, a->maximumRecordSize);
2631 reclist->records[reclist->num_records] =
2634 YAZ_BIB1_RECORD_EXCEEDS_MAXIMUM_RECORD_SIZE, 0);
2635 reclist->num_records++;
2636 dumped_records += this_length;
2641 if (!(thisrec = (Z_NamePlusRecord *)
2642 odr_malloc(a->encode, sizeof(*thisrec))))
2644 thisrec->databaseName = odr_strdup_null(a->encode, freq.basename);
2645 thisrec->which = Z_NamePlusRecord_databaseRecord;
2647 if (!freq.output_format)
2649 yaz_log(YLOG_WARN, "bend_fetch output_format not set");
2652 thisrec->u.databaseRecord = z_ext_record_oid(
2653 a->encode, freq.output_format, freq.record, freq.len);
2654 if (!thisrec->u.databaseRecord)
2656 reclist->records[reclist->num_records] = thisrec;
2657 reclist->num_records++;
2658 if (freq.last_in_set)
2661 *num = reclist->num_records;
2665 static Z_APDU *process_searchRequest(association *assoc, request *reqb)
2667 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2668 bend_search_rr *bsrr =
2669 (bend_search_rr *)nmem_malloc(reqb->request_mem, sizeof(*bsrr));
2671 yaz_log(log_requestdetail, "Got SearchRequest.");
2672 bsrr->association = assoc;
2673 bsrr->referenceId = req->referenceId;
2674 bsrr->srw_sortKeys = 0;
2675 bsrr->srw_setname = 0;
2676 bsrr->srw_setnameIdleTime = 0;
2677 bsrr->estimated_hit_count = 0;
2678 bsrr->partial_resultset = 0;
2679 bsrr->extra_args = 0;
2680 bsrr->extra_response_data = 0;
2682 yaz_log(log_requestdetail, "ResultSet '%s'", req->resultSetName);
2683 if (req->databaseNames)
2686 for (i = 0; i < req->num_databaseNames; i++)
2687 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
2690 yaz_log_zquery_level(log_requestdetail,req->query);
2692 if (assoc->init->bend_search)
2694 bsrr->setname = req->resultSetName;
2695 bsrr->replace_set = *req->replaceIndicator;
2696 bsrr->num_bases = req->num_databaseNames;
2697 bsrr->basenames = req->databaseNames;
2698 bsrr->query = req->query;
2699 bsrr->stream = assoc->encode;
2700 nmem_transfer(odr_getmem(bsrr->stream), reqb->request_mem);
2701 bsrr->decode = assoc->decode;
2702 bsrr->print = assoc->print;
2705 bsrr->errstring = NULL;
2706 bsrr->search_info = NULL;
2707 bsrr->search_input = req->additionalSearchInfo;
2708 if (!bsrr->search_input)
2709 bsrr->search_input = req->otherInfo;
2710 bsrr->present_number = *req->mediumSetPresentNumber;
2712 if (assoc->server && assoc->server->client_query_charset &&
2713 req->query->which == Z_Query_type_1)
2716 yaz_iconv_open("UTF-8", assoc->server->client_query_charset);
2719 yaz_query_charset_convert_rpnquery(req->query->u.type_1,
2721 yaz_iconv_close(cd);
2725 if (assoc->server && assoc->server->cql_transform
2726 && req->query->which == Z_Query_type_104
2727 && req->query->u.type_104->which == Z_External_CQL)
2729 /* have a CQL query and a CQL to PQF transform .. */
2731 cql2pqf(bsrr->stream, req->query->u.type_104->u.cql,
2732 assoc->server->cql_transform, bsrr->query,
2733 &bsrr->srw_sortKeys);
2735 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2738 if (assoc->server && assoc->server->ccl_transform
2739 && req->query->which == Z_Query_type_2) /*CCL*/
2741 /* have a CCL query and a CCL to PQF transform .. */
2743 ccl2pqf(bsrr->stream, req->query->u.type_2,
2744 assoc->server->ccl_transform, bsrr);
2746 bsrr->errcode = yaz_diag_srw_to_bib1(srw_errcode);
2750 (assoc->init->bend_search)(assoc->backend, bsrr);
2754 /* FIXME - make a diagnostic for it */
2755 yaz_log(YLOG_WARN,"Search not supported ?!?!");
2757 return response_searchRequest(assoc, reqb, bsrr);
2761 * Prepare a searchresponse based on the backend results. We probably want
2762 * to look at making the fetching of records nonblocking as well, but
2763 * so far, we'll keep things simple.
2764 * If bsrt is null, that means we're called in response to a communications
2765 * event, and we'll have to get the response for ourselves.
2767 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
2768 bend_search_rr *bsrt)
2770 Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
2771 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2772 Z_SearchResponse *resp = (Z_SearchResponse *)
2773 odr_malloc(assoc->encode, sizeof(*resp));
2774 Odr_int *nulint = odr_intdup(assoc->encode, 0);
2775 Odr_int *next = odr_intdup(assoc->encode, 0);
2776 Odr_int *none = odr_intdup(assoc->encode, Z_SearchResponse_none);
2777 Odr_int returnedrecs = 0;
2779 apdu->which = Z_APDU_searchResponse;
2780 apdu->u.searchResponse = resp;
2781 resp->referenceId = req->referenceId;
2782 resp->additionalSearchInfo = 0;
2783 resp->otherInfo = 0;
2786 yaz_log(YLOG_FATAL, "Bad result from backend");
2789 else if (bsrt->errcode)
2791 resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
2792 resp->resultCount = nulint;
2793 resp->numberOfRecordsReturned = nulint;
2794 resp->nextResultSetPosition = nulint;
2795 resp->searchStatus = odr_booldup(assoc->encode, 0);
2796 resp->resultSetStatus = none;
2797 resp->presentStatus = 0;
2801 bool_t *sr = odr_booldup(assoc->encode, 1);
2802 Odr_int *toget = odr_intdup(assoc->encode, 0);
2803 Z_RecordComposition comp, *compp = 0;
2805 yaz_log(log_requestdetail, "resultCount: " ODR_INT_PRINTF, bsrt->hits);
2808 resp->resultCount = &bsrt->hits;
2810 comp.which = Z_RecordComp_simple;
2811 /* how many records does the user agent want, then? */
2814 else if (bsrt->hits <= *req->smallSetUpperBound)
2816 *toget = bsrt->hits;
2817 if ((comp.u.simple = req->smallSetElementSetNames))
2820 else if (bsrt->hits < *req->largeSetLowerBound)
2822 *toget = *req->mediumSetPresentNumber;
2823 if (*toget > bsrt->hits)
2824 *toget = bsrt->hits;
2825 if ((comp.u.simple = req->mediumSetElementSetNames))
2831 if (*toget && !resp->records)
2833 Odr_int *presst = odr_intdup(assoc->encode, 0);
2834 /* Call bend_present if defined */
2835 if (assoc->init->bend_present)
2837 bend_present_rr *bprr = (bend_present_rr *)
2838 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2839 bprr->setname = req->resultSetName;
2841 bprr->number = odr_int_to_int(*toget);
2842 bprr->format = req->preferredRecordSyntax;
2844 bprr->referenceId = req->referenceId;
2845 bprr->stream = assoc->encode;
2846 bprr->print = assoc->print;
2847 bprr->association = assoc;
2849 bprr->errstring = NULL;
2850 (*assoc->init->bend_present)(assoc->backend, bprr);
2854 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2855 *resp->presentStatus = Z_PresentStatus_failure;
2860 resp->records = pack_records(
2861 assoc, req->resultSetName, 1,
2862 toget, compp, next, presst, req->referenceId,
2863 req->preferredRecordSyntax, NULL);
2866 resp->numberOfRecordsReturned = toget;
2867 returnedrecs = *toget;
2868 resp->presentStatus = presst;
2872 if (*resp->resultCount)
2874 resp->numberOfRecordsReturned = nulint;
2875 resp->presentStatus = 0;
2877 resp->nextResultSetPosition = next;
2878 resp->searchStatus = sr;
2879 resp->resultSetStatus = 0;
2880 if (bsrt->estimated_hit_count)
2882 resp->resultSetStatus = odr_intdup(assoc->encode,
2883 Z_SearchResponse_estimate);
2885 else if (bsrt->partial_resultset)
2887 resp->resultSetStatus = odr_intdup(assoc->encode,
2888 Z_SearchResponse_subset);
2891 resp->additionalSearchInfo = bsrt->search_info;
2896 WRBUF wr = wrbuf_alloc();
2898 for (i = 0 ; i < req->num_databaseNames; i++)
2901 wrbuf_printf(wr, "+");
2902 wrbuf_puts(wr, req->databaseNames[i]);
2904 wrbuf_printf(wr, " ");
2907 wrbuf_printf(wr, "ERROR %d", bsrt->errcode);
2909 wrbuf_printf(wr, "OK " ODR_INT_PRINTF, bsrt->hits);
2910 wrbuf_printf(wr, " %s 1+" ODR_INT_PRINTF " ",
2911 req->resultSetName, returnedrecs);
2912 yaz_query_to_wrbuf(wr, req->query);
2914 yaz_log(log_request, "Search %s", wrbuf_cstr(wr));
2921 * Maybe we got a little over-friendly when we designed bend_fetch to
2922 * get only one record at a time. Some backends can optimise multiple-record
2923 * fetches, and at any rate, there is some overhead involved in
2924 * all that selecting and hopping around. Problem is, of course, that the
2925 * frontend can't know ahead of time how many records it'll need to
2926 * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
2927 * is downright lousy as a bulk data transfer protocol.
2929 * To start with, we'll do the fetching of records from the backend
2930 * in one operation: To save some trips in and out of the event-handler,
2931 * and to simplify the interface to pack_records. At any rate, asynch
2932 * operation is more fun in operations that have an unpredictable execution
2933 * speed - which is normally more true for search than for present.
2935 static Z_APDU *process_presentRequest(association *assoc, request *reqb)
2937 Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
2939 Z_PresentResponse *resp;
2944 yaz_log(log_requestdetail, "Got PresentRequest.");
2946 resp = (Z_PresentResponse *)odr_malloc(assoc->encode, sizeof(*resp));
2948 resp->presentStatus = odr_intdup(assoc->encode, 0);
2949 if (assoc->init->bend_present)
2951 bend_present_rr *bprr = (bend_present_rr *)
2952 nmem_malloc(reqb->request_mem, sizeof(*bprr));
2953 bprr->setname = req->resultSetId;
2954 bprr->start = odr_int_to_int(*req->resultSetStartPoint);
2955 bprr->number = odr_int_to_int(*req->numberOfRecordsRequested);
2956 bprr->format = req->preferredRecordSyntax;
2957 bprr->comp = req->recordComposition;
2958 bprr->referenceId = req->referenceId;
2959 bprr->stream = assoc->encode;
2960 bprr->print = assoc->print;
2961 bprr->association = assoc;
2963 bprr->errstring = NULL;
2964 (*assoc->init->bend_present)(assoc->backend, bprr);
2968 resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
2969 *resp->presentStatus = Z_PresentStatus_failure;
2970 errcode = bprr->errcode;
2973 apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
2974 next = odr_intdup(assoc->encode, 0);
2975 num = odr_intdup(assoc->encode, 0);
2977 apdu->which = Z_APDU_presentResponse;
2978 apdu->u.presentResponse = resp;
2979 resp->referenceId = req->referenceId;
2980 resp->otherInfo = 0;
2984 *num = *req->numberOfRecordsRequested;
2986 pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
2987 num, req->recordComposition, next,
2988 resp->presentStatus,
2989 req->referenceId, req->preferredRecordSyntax,
2994 WRBUF wr = wrbuf_alloc();
2995 wrbuf_printf(wr, "Present ");
2997 if (*resp->presentStatus == Z_PresentStatus_failure)
2998 wrbuf_printf(wr, "ERROR %d ", errcode);
2999 else if (*resp->presentStatus == Z_PresentStatus_success)
3000 wrbuf_printf(wr, "OK - ");
3002 wrbuf_printf(wr, "Partial " ODR_INT_PRINTF " - ",
3003 *resp->presentStatus);
3005 wrbuf_printf(wr, " %s " ODR_INT_PRINTF "+" ODR_INT_PRINTF " ",
3006 req->resultSetId, *req->resultSetStartPoint,
3007 *req->numberOfRecordsRequested);
3008 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3013 resp->numberOfRecordsReturned = num;
3014 resp->nextResultSetPosition = next;
3020 * Scan was implemented rather in a hurry, and with support for only the basic
3021 * elements of the service in the backend API. Suggestions are welcome.
3023 static Z_APDU *process_scanRequest(association *assoc, request *reqb)
3025 Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
3026 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3027 Z_ScanResponse *res = (Z_ScanResponse *)
3028 odr_malloc(assoc->encode, sizeof(*res));
3029 Odr_int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
3030 Odr_int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
3031 Z_ListEntries *ents = (Z_ListEntries *)
3032 odr_malloc(assoc->encode, sizeof(*ents));
3033 Z_DiagRecs *diagrecs_p = NULL;
3034 bend_scan_rr *bsrr = (bend_scan_rr *)
3035 odr_malloc(assoc->encode, sizeof(*bsrr));
3036 struct scan_entry *save_entries;
3039 yaz_log(log_requestdetail, "Got ScanRequest");
3041 apdu->which = Z_APDU_scanResponse;
3042 apdu->u.scanResponse = res;
3043 res->referenceId = req->referenceId;
3045 /* if step is absent, set it to 0 */
3047 step_size = odr_int_to_int(*req->stepSize);
3050 res->scanStatus = scanStatus;
3051 res->numberOfEntriesReturned = numberOfEntriesReturned;
3052 res->positionOfTerm = 0;
3053 res->entries = ents;
3054 ents->num_entries = 0;
3055 ents->entries = NULL;
3056 ents->num_nonsurrogateDiagnostics = 0;
3057 ents->nonsurrogateDiagnostics = NULL;
3058 res->attributeSet = 0;
3061 if (req->databaseNames)
3064 for (i = 0; i < req->num_databaseNames; i++)
3065 yaz_log(log_requestdetail, "Database '%s'", req->databaseNames[i]);
3067 bsrr->scanClause = 0;
3069 bsrr->errstring = 0;
3070 bsrr->num_bases = req->num_databaseNames;
3071 bsrr->basenames = req->databaseNames;
3072 bsrr->num_entries = odr_int_to_int(*req->numberOfTermsRequested);
3073 bsrr->term = req->termListAndStartPoint;
3074 bsrr->referenceId = req->referenceId;
3075 bsrr->stream = assoc->encode;
3076 bsrr->print = assoc->print;
3077 bsrr->step_size = &step_size;
3078 bsrr->setname = yaz_oi_get_string_oid(&req->otherInfo,
3079 yaz_oid_userinfo_scan_set, 1, 0);
3081 bsrr->extra_args = 0;
3082 bsrr->extra_response_data = 0;
3083 /* For YAZ 2.0 and earlier it was the backend handler that
3084 initialized entries (member display_term did not exist)
3085 YAZ 2.0 and later sets 'entries' and initialize all members
3086 including 'display_term'. If YAZ 2.0 or later sees that
3087 entries was modified - we assume that it is an old handler and
3088 that 'display_term' is _not_ set.
3090 if (bsrr->num_entries > 0)
3093 bsrr->entries = (struct scan_entry *)
3094 odr_malloc(assoc->decode, sizeof(*bsrr->entries) *
3096 for (i = 0; i<bsrr->num_entries; i++)
3098 bsrr->entries[i].term = 0;
3099 bsrr->entries[i].occurrences = 0;
3100 bsrr->entries[i].errcode = 0;
3101 bsrr->entries[i].errstring = 0;
3102 bsrr->entries[i].display_term = 0;
3105 save_entries = bsrr->entries; /* save it so we can compare later */
3107 bsrr->attributeset = req->attributeSet;
3108 log_scan_term_level(log_requestdetail, req->termListAndStartPoint,
3109 bsrr->attributeset);
3110 bsrr->term_position = req->preferredPositionInResponse ?
3111 odr_int_to_int(*req->preferredPositionInResponse) : 1;
3113 ((int (*)(void *, bend_scan_rr *))
3114 (*assoc->init->bend_scan))(assoc->backend, bsrr);
3117 diagrecs_p = zget_DiagRecs(assoc->encode,
3118 bsrr->errcode, bsrr->errstring);
3122 Z_Entry **tab = (Z_Entry **)
3123 odr_malloc(assoc->encode, sizeof(*tab) * bsrr->num_entries);
3125 if (bsrr->status == BEND_SCAN_PARTIAL)
3126 *scanStatus = Z_Scan_partial_5;
3128 *scanStatus = Z_Scan_success;
3129 res->stepSize = odr_intdup(assoc->encode, step_size);
3130 ents->entries = tab;
3131 ents->num_entries = bsrr->num_entries;
3132 res->numberOfEntriesReturned = odr_intdup(assoc->encode,
3134 res->positionOfTerm = odr_intdup(assoc->encode, bsrr->term_position);
3135 for (i = 0; i < bsrr->num_entries; i++)
3140 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
3141 if (bsrr->entries[i].occurrences >= 0)
3143 e->which = Z_Entry_termInfo;
3144 e->u.termInfo = t = (Z_TermInfo *)
3145 odr_malloc(assoc->encode, sizeof(*t));
3146 t->suggestedAttributes = 0;
3148 if (save_entries == bsrr->entries &&
3149 bsrr->entries[i].display_term)
3151 /* the entries was _not_ set by the handler. So it's
3152 safe to test for new member display_term. It is
3155 t->displayTerm = odr_strdup(assoc->encode,
3156 bsrr->entries[i].display_term);
3158 t->alternativeTerm = 0;
3159 t->byAttributes = 0;
3160 t->otherTermInfo = 0;
3161 t->globalOccurrences = &bsrr->entries[i].occurrences;
3162 t->term = (Z_Term *)
3163 odr_malloc(assoc->encode, sizeof(*t->term));
3164 t->term->which = Z_Term_general;
3165 t->term->u.general =
3166 odr_create_Odr_oct(assoc->encode,
3167 bsrr->entries[i].term,
3168 strlen(bsrr->entries[i].term));
3169 yaz_log(YLOG_DEBUG, " term #%d: '%s' (" ODR_INT_PRINTF ")", i,
3170 bsrr->entries[i].term, bsrr->entries[i].occurrences);
3174 Z_DiagRecs *drecs = zget_DiagRecs(assoc->encode,
3175 bsrr->entries[i].errcode,
3176 bsrr->entries[i].errstring);
3177 assert(drecs->num_diagRecs == 1);
3178 e->which = Z_Entry_surrogateDiagnostic;
3179 assert(drecs->diagRecs[0]);
3180 e->u.surrogateDiagnostic = drecs->diagRecs[0];
3186 ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
3187 ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
3192 WRBUF wr = wrbuf_alloc();
3193 wrbuf_printf(wr, "Scan ");
3194 for (i = 0 ; i < req->num_databaseNames; i++)
3197 wrbuf_printf(wr, "+");
3198 wrbuf_puts(wr, req->databaseNames[i]);
3201 wrbuf_printf(wr, " ");
3204 wr_diag(wr, bsrr->errcode, bsrr->errstring);
3206 wrbuf_printf(wr, "OK");
3208 wrbuf_printf(wr, " " ODR_INT_PRINTF " - " ODR_INT_PRINTF "+"
3209 ODR_INT_PRINTF "+" ODR_INT_PRINTF,
3210 res->numberOfEntriesReturned ?
3211 *res->numberOfEntriesReturned : 0,
3212 (req->preferredPositionInResponse ?
3213 *req->preferredPositionInResponse : 1),
3214 *req->numberOfTermsRequested,
3215 (res->stepSize ? *res->stepSize : 1));
3218 wrbuf_printf(wr, "+%s", bsrr->setname);
3220 wrbuf_printf(wr, " ");
3221 yaz_scan_to_wrbuf(wr, req->termListAndStartPoint,
3222 bsrr->attributeset);
3223 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3229 static Z_APDU *process_sortRequest(association *assoc, request *reqb)
3232 Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
3233 Z_SortResponse *res = (Z_SortResponse *)
3234 odr_malloc(assoc->encode, sizeof(*res));
3235 bend_sort_rr *bsrr = (bend_sort_rr *)
3236 odr_malloc(assoc->encode, sizeof(*bsrr));
3238 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3240 yaz_log(log_requestdetail, "Got SortRequest.");
3242 bsrr->num_input_setnames = req->num_inputResultSetNames;
3243 for (i=0;i<req->num_inputResultSetNames;i++)
3244 yaz_log(log_requestdetail, "Input resultset: '%s'",
3245 req->inputResultSetNames[i]);
3246 bsrr->input_setnames = req->inputResultSetNames;
3247 bsrr->referenceId = req->referenceId;
3248 bsrr->output_setname = req->sortedResultSetName;
3249 yaz_log(log_requestdetail, "Output resultset: '%s'",
3250 req->sortedResultSetName);
3251 bsrr->sort_sequence = req->sortSequence;
3252 /*FIXME - dump those sequences too */
3253 bsrr->stream = assoc->encode;
3254 bsrr->print = assoc->print;
3256 bsrr->sort_status = Z_SortResponse_failure;
3258 bsrr->errstring = 0;
3260 (*assoc->init->bend_sort)(assoc->backend, bsrr);
3262 res->referenceId = bsrr->referenceId;
3263 res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
3264 res->resultSetStatus = 0;
3267 Z_DiagRecs *dr = zget_DiagRecs(assoc->encode,
3268 bsrr->errcode, bsrr->errstring);
3269 res->diagnostics = dr->diagRecs;
3270 res->num_diagnostics = dr->num_diagRecs;
3274 res->num_diagnostics = 0;
3275 res->diagnostics = 0;
3277 res->resultCount = 0;
3280 apdu->which = Z_APDU_sortResponse;
3281 apdu->u.sortResponse = res;
3284 WRBUF wr = wrbuf_alloc();
3285 wrbuf_printf(wr, "Sort ");
3287 wrbuf_printf(wr, " ERROR %d", bsrr->errcode);
3289 wrbuf_printf(wr, "OK -");
3290 wrbuf_printf(wr, " (");
3291 for (i = 0; i<req->num_inputResultSetNames; i++)
3294 wrbuf_printf(wr, "+");
3295 wrbuf_puts(wr, req->inputResultSetNames[i]);
3297 wrbuf_printf(wr, ")->%s ",req->sortedResultSetName);
3299 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3305 static Z_APDU *process_deleteRequest(association *assoc, request *reqb)
3308 Z_DeleteResultSetRequest *req =
3309 reqb->apdu_request->u.deleteResultSetRequest;
3310 Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
3311 odr_malloc(assoc->encode, sizeof(*res));
3312 bend_delete_rr *bdrr = (bend_delete_rr *)
3313 odr_malloc(assoc->encode, sizeof(*bdrr));
3314 Z_APDU *apdu = (Z_APDU *)odr_malloc(assoc->encode, sizeof(*apdu));
3316 yaz_log(log_requestdetail, "Got DeleteRequest.");
3318 bdrr->num_setnames = req->num_resultSetList;
3319 bdrr->setnames = req->resultSetList;
3320 for (i = 0; i<req->num_resultSetList; i++)
3321 yaz_log(log_requestdetail, "resultset: '%s'",
3322 req->resultSetList[i]);
3323 bdrr->stream = assoc->encode;
3324 bdrr->print = assoc->print;
3325 bdrr->function = odr_int_to_int(*req->deleteFunction);
3326 bdrr->referenceId = req->referenceId;
3328 if (bdrr->num_setnames > 0)
3330 bdrr->statuses = (int*)
3331 odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
3332 bdrr->num_setnames);
3333 for (i = 0; i < bdrr->num_setnames; i++)
3334 bdrr->statuses[i] = 0;
3336 (*assoc->init->bend_delete)(assoc->backend, bdrr);
3338 res->referenceId = req->referenceId;
3340 res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
3342 res->deleteListStatuses = 0;
3343 if (bdrr->num_setnames > 0)
3346 res->deleteListStatuses = (Z_ListStatuses *)
3347 odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
3348 res->deleteListStatuses->num = bdrr->num_setnames;
3349 res->deleteListStatuses->elements =
3351 odr_malloc(assoc->encode,
3352 sizeof(*res->deleteListStatuses->elements) *
3353 bdrr->num_setnames);
3354 for (i = 0; i<bdrr->num_setnames; i++)
3356 res->deleteListStatuses->elements[i] =
3358 odr_malloc(assoc->encode,
3359 sizeof(**res->deleteListStatuses->elements));
3360 res->deleteListStatuses->elements[i]->status =
3361 odr_intdup(assoc->encode, bdrr->statuses[i]);
3362 res->deleteListStatuses->elements[i]->id =
3363 odr_strdup(assoc->encode, bdrr->setnames[i]);
3366 res->numberNotDeleted = 0;
3367 res->bulkStatuses = 0;
3368 res->deleteMessage = 0;
3371 apdu->which = Z_APDU_deleteResultSetResponse;
3372 apdu->u.deleteResultSetResponse = res;
3375 WRBUF wr = wrbuf_alloc();
3376 wrbuf_printf(wr, "Delete ");
3377 if (bdrr->delete_status)
3378 wrbuf_printf(wr, "ERROR %d", bdrr->delete_status);
3380 wrbuf_printf(wr, "OK -");
3381 for (i = 0; i<req->num_resultSetList; i++)
3382 wrbuf_printf(wr, " %s ", req->resultSetList[i]);
3383 yaz_log(log_request, "%s", wrbuf_cstr(wr) );
3389 static void process_close(association *assoc, request *reqb)
3391 Z_Close *req = reqb->apdu_request->u.close;
3392 static char *reasons[] =
3399 "securityViolation",
3406 yaz_log(log_requestdetail, "Got Close, reason %s, message %s",
3407 reasons[*req->closeReason], req->diagnosticInformation ?
3408 req->diagnosticInformation : "NULL");
3409 if (assoc->version < 3) /* to make do_force respond with close */
3411 do_close_req(assoc, Z_Close_finished,
3412 "Association terminated by client", reqb);
3413 yaz_log(log_request,"Close OK");
3416 static Z_APDU *process_segmentRequest(association *assoc, request *reqb)
3418 bend_segment_rr req;
3420 req.segment = reqb->apdu_request->u.segmentRequest;
3421 req.stream = assoc->encode;
3422 req.decode = assoc->decode;
3423 req.print = assoc->print;
3424 req.association = assoc;
3426 (*assoc->init->bend_segment)(assoc->backend, &req);
3431 static Z_APDU *process_ESRequest(association *assoc, request *reqb)
3433 bend_esrequest_rr esrequest;
3434 const char *ext_name = "unknown";
3436 Z_ExtendedServicesRequest *req =
3437 reqb->apdu_request->u.extendedServicesRequest;
3438 Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
3440 Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
3442 esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
3443 esrequest.stream = assoc->encode;
3444 esrequest.decode = assoc->decode;
3445 esrequest.print = assoc->print;
3446 esrequest.errcode = 0;
3447 esrequest.errstring = NULL;
3448 esrequest.association = assoc;
3449 esrequest.taskPackage = 0;
3450 esrequest.referenceId = req->referenceId;
3452 if (esrequest.esr && esrequest.esr->taskSpecificParameters)
3454 switch(esrequest.esr->taskSpecificParameters->which)
3456 case Z_External_itemOrder:
3457 ext_name = "ItemOrder"; break;
3458 case Z_External_update:
3459 ext_name = "Update"; break;
3460 case Z_External_update0:
3461 ext_name = "Update0"; break;
3462 case Z_External_ESAdmin:
3463 ext_name = "Admin"; break;
3468 (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
3470 resp->referenceId = req->referenceId;
3472 if (esrequest.errcode == -1)
3474 /* Backend service indicates request will be processed */
3475 yaz_log(log_request, "Extended Service: %s (accepted)", ext_name);
3476 *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
3478 else if (esrequest.errcode == 0)
3480 /* Backend service indicates request will be processed */
3481 yaz_log(log_request, "Extended Service: %s (done)", ext_name);
3482 *resp->operationStatus = Z_ExtendedServicesResponse_done;
3486 Z_DiagRecs *diagRecs =
3487 zget_DiagRecs(assoc->encode, esrequest.errcode,
3488 esrequest.errstring);
3489 /* Backend indicates error, request will not be processed */
3490 yaz_log(log_request, "Extended Service: %s (failed)", ext_name);
3491 *resp->operationStatus = Z_ExtendedServicesResponse_failure;
3492 resp->num_diagnostics = diagRecs->num_diagRecs;
3493 resp->diagnostics = diagRecs->diagRecs;
3496 WRBUF wr = wrbuf_alloc();
3497 wrbuf_diags(wr, resp->num_diagnostics, resp->diagnostics);
3498 yaz_log(log_request, "EsRequest %s", wrbuf_cstr(wr) );
3503 /* Do something with the members of bend_extendedservice */
3504 if (esrequest.taskPackage)
3506 resp->taskPackage = z_ext_record_oid(
3507 assoc->encode, yaz_oid_recsyn_extended,
3508 (const char *) esrequest.taskPackage, -1);
3510 yaz_log(YLOG_DEBUG,"Send the result apdu");
3514 int bend_assoc_is_alive(bend_association assoc)
3516 if (assoc->state == ASSOC_DEAD)
3517 return 0; /* already marked as dead. Don't check I/O chan anymore */
3519 return iochan_is_alive(assoc->client_chan);
3526 * c-file-style: "Stroustrup"
3527 * indent-tabs-mode: nil
3529 * vim: shiftwidth=4 tabstop=8 expandtab