2 * Copyright (c) 1998-2004, Index Data.
3 * See the file LICENSE for details.
5 * $Id: yaz-proxy.cpp,v 1.90 2004-01-15 15:47:52 adam Exp $
12 #include <yaz/marcdisp.h>
13 #include <yaz/yaz-iconv.h>
15 #include <yaz/diagbib1.h>
16 #include <yaz++/proxy.h>
17 #include <yaz/pquery.h>
20 #include <libxslt/xsltutils.h>
21 #include <libxslt/transform.h>
24 static const char *apdu_name(Z_APDU *apdu)
28 case Z_APDU_initRequest:
30 case Z_APDU_initResponse:
31 return "initResponse";
32 case Z_APDU_searchRequest:
33 return "searchRequest";
34 case Z_APDU_searchResponse:
35 return "searchResponse";
36 case Z_APDU_presentRequest:
37 return "presentRequest";
38 case Z_APDU_presentResponse:
39 return "presentResponse";
40 case Z_APDU_deleteResultSetRequest:
41 return "deleteResultSetRequest";
42 case Z_APDU_deleteResultSetResponse:
43 return "deleteResultSetResponse";
44 case Z_APDU_scanRequest:
46 case Z_APDU_scanResponse:
47 return "scanResponse";
48 case Z_APDU_sortRequest:
50 case Z_APDU_sortResponse:
51 return "sortResponse";
52 case Z_APDU_extendedServicesRequest:
53 return "extendedServicesRequest";
54 case Z_APDU_extendedServicesResponse:
55 return "extendedServicesResponse";
62 static const char *gdu_name(Z_GDU *gdu)
67 return apdu_name(gdu->u.z3950);
68 case Z_GDU_HTTP_Request:
69 return "HTTP Request";
70 case Z_GDU_HTTP_Response:
71 return "HTTP Response";
73 return "Unknown request/response";
76 Yaz_Proxy::Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable,
78 Yaz_Z_Assoc(the_PDU_Observable), m_bw_stat(60), m_pdu_stat(60)
80 m_PDU_Observable = the_PDU_Observable;
85 m_keepalive_limit_bw = 500000;
86 m_keepalive_limit_pdu = 1000;
89 m_proxy_authentication = 0;
93 m_client_idletime = 600;
94 m_target_idletime = 600;
95 m_optimize = xstrdup ("1");
96 strcpy(m_session_str, "0 ");
98 m_bytes_sent = m_bytes_recv = 0;
102 m_max_record_retrieve = 0;
106 m_invalid_session = 0;
109 m_stylesheet_schema = 0;
110 m_s2z_stylesheet = 0;
112 m_initRequest_apdu = 0;
113 m_initRequest_mem = 0;
114 m_initRequest_options = 0;
115 m_initRequest_version = 0;
116 m_apdu_invalid_session = 0;
117 m_mem_invalid_session = 0;
119 m_s2z_odr_search = 0;
121 m_s2z_search_apdu = 0;
122 m_s2z_present_apdu = 0;
123 m_http_keepalive = 0;
126 m_s2z_packing = Z_SRW_recordPacking_string;
127 m_time_tv.tv_sec = 0;
128 m_time_tv.tv_usec = 0;
131 Yaz_Proxy::~Yaz_Proxy()
133 yaz_log(LOG_LOG, "%sClosed %d/%d sent/recv bytes total", m_session_str,
134 m_bytes_sent, m_bytes_recv);
135 nmem_destroy(m_initRequest_mem);
136 nmem_destroy(m_mem_invalid_session);
137 xfree (m_proxyTarget);
138 xfree (m_default_target);
139 xfree (m_proxy_authentication);
141 xfree (m_stylesheet_schema);
144 odr_destroy(m_s2z_odr_init);
145 if (m_s2z_odr_search)
146 odr_destroy(m_s2z_odr_search);
150 int Yaz_Proxy::set_config(const char *config)
153 m_config = new Yaz_ProxyConfig();
154 xfree(m_config_fname);
155 m_config_fname = xstrdup(config);
156 int r = m_config->read_xml(config);
158 m_config->get_generic_info(&m_log_mask, &m_max_clients);
162 void Yaz_Proxy::set_default_target(const char *target)
164 xfree (m_default_target);
165 m_default_target = 0;
167 m_default_target = (char *) xstrdup (target);
170 void Yaz_Proxy::set_proxy_authentication (const char *auth)
172 xfree (m_proxy_authentication);
173 m_proxy_authentication = 0;
175 m_proxy_authentication = (char *) xstrdup (auth);
178 Yaz_ProxyConfig *Yaz_Proxy::check_reconfigure()
181 return m_parent->check_reconfigure();
183 Yaz_ProxyConfig *cfg = m_config;
186 yaz_log(LOG_LOG, "reconfigure");
188 if (m_config_fname && cfg)
190 yaz_log(LOG_LOG, "reconfigure config %s", m_config_fname);
191 int r = cfg->read_xml(m_config_fname);
193 yaz_log(LOG_WARN, "reconfigure failed");
197 cfg->get_generic_info(&m_log_mask, &m_max_clients);
201 yaz_log(LOG_LOG, "reconfigure");
207 IYaz_PDU_Observer *Yaz_Proxy::sessionNotify(IYaz_PDU_Observable
208 *the_PDU_Observable, int fd)
211 Yaz_Proxy *new_proxy = new Yaz_Proxy(the_PDU_Observable, this);
212 new_proxy->m_config = 0;
213 new_proxy->m_config_fname = 0;
214 new_proxy->timeout(m_client_idletime);
215 new_proxy->m_target_idletime = m_target_idletime;
216 new_proxy->set_default_target(m_default_target);
217 new_proxy->m_max_clients = m_max_clients;
218 new_proxy->m_log_mask = m_log_mask;
219 new_proxy->set_APDU_log(get_APDU_log());
220 if (m_log_mask & PROXY_LOG_APDU_CLIENT)
221 new_proxy->set_APDU_yazlog(1);
223 new_proxy->set_APDU_yazlog(0);
224 new_proxy->set_proxy_authentication(m_proxy_authentication);
225 sprintf(new_proxy->m_session_str, "%ld:%d ", (long) time(0), m_session_no);
227 yaz_log (LOG_LOG, "%sNew session %s", new_proxy->m_session_str,
228 the_PDU_Observable->getpeername());
232 char *Yaz_Proxy::get_cookie(Z_OtherInformation **otherInfo)
235 Z_OtherInformationUnit *oi;
237 ent.proto = PROTO_Z3950;
238 ent.oclass = CLASS_USERINFO;
239 ent.value = (oid_value) VAL_COOKIE;
240 assert (oid_ent_to_oid (&ent, oid));
242 if (oid_ent_to_oid (&ent, oid) &&
243 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
244 oi->which == Z_OtherInfo_characterInfo)
245 return oi->information.characterInfo;
249 char *Yaz_Proxy::get_proxy(Z_OtherInformation **otherInfo)
252 Z_OtherInformationUnit *oi;
254 ent.proto = PROTO_Z3950;
255 ent.oclass = CLASS_USERINFO;
256 ent.value = (oid_value) VAL_PROXY;
257 if (oid_ent_to_oid (&ent, oid) &&
258 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
259 oi->which == Z_OtherInfo_characterInfo)
260 return oi->information.characterInfo;
264 const char *Yaz_Proxy::load_balance(const char **url)
266 int zurl_in_use[MAX_ZURL_PLEX];
270 for (i = 0; i<MAX_ZURL_PLEX; i++)
272 for (c = m_parent->m_clientPool; c; c = c->m_next)
274 for (i = 0; url[i]; i++)
275 if (!strcmp(url[i], c->get_hostname()))
280 for (i = 0; url[i]; i++)
282 yaz_log(LOG_DEBUG, "%szurl=%s use=%d",
283 m_session_str, url[i], zurl_in_use[i]);
284 if (min > zurl_in_use[i])
287 min = zurl_in_use[i];
293 Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu, const char *cookie,
294 const char *proxy_host)
297 Yaz_Proxy *parent = m_parent;
298 Yaz_ProxyClient *c = m_client;
302 const char *url[MAX_ZURL_PLEX];
303 Yaz_ProxyConfig *cfg = check_reconfigure();
307 /* only to be enabled for debugging... */
308 if (!strcmp(proxy_host, "stop"))
311 xfree(m_default_target);
312 m_default_target = xstrdup(proxy_host);
313 proxy_host = m_default_target;
315 int client_idletime = -1;
316 const char *cql2rpn_fname = 0;
317 url[0] = m_default_target;
322 cfg->get_target_info(proxy_host, url, &m_bw_max,
323 &m_pdu_max, &m_max_record_retrieve,
324 &m_target_idletime, &client_idletime,
325 &parent->m_max_clients,
326 &m_keepalive_limit_bw,
327 &m_keepalive_limit_pdu,
331 if (client_idletime != -1)
333 m_client_idletime = client_idletime;
334 timeout(m_client_idletime);
337 m_cql2rpn.set_pqf_file(cql2rpn_fname);
340 yaz_log(LOG_LOG, "%sNo default target", m_session_str);
343 // we don't handle multiplexing for cookie session, so we just
344 // pick the first one in this case (anonymous users will be able
345 // to use any backend)
346 if (cookie && *cookie)
347 m_proxyTarget = (char*) xstrdup(url[0]);
349 m_proxyTarget = (char*) xstrdup(load_balance(url));
351 if (cookie && *cookie)
352 { // search in sessions with a cookie
353 for (c = parent->m_clientPool; c; c = c->m_next)
356 assert (*c->m_prev == c);
357 if (c->m_cookie && !strcmp(cookie,c->m_cookie) &&
358 !strcmp(m_proxyTarget, c->get_hostname()))
361 // The following handles "cancel"
362 // If connection is busy (waiting for PDU) and
363 // we have an initRequest we can safely do re-open
364 if (c->m_waiting && apdu->which == Z_APDU_initRequest)
366 yaz_log (LOG_LOG, "%s REOPEN target=%s", m_session_str,
373 c->m_last_resultCount = 0;
374 c->m_sr_transform = 0;
376 c->m_resultSetStartPoint = 0;
377 c->m_target_idletime = m_target_idletime;
378 if (c->client(m_proxyTarget))
385 c->m_seqno = parent->m_seqno;
386 if (c->m_server && c->m_server != this)
387 c->m_server->m_client = 0;
390 yaz_log (LOG_DEBUG, "get_client 1 %p %p", this, c);
397 // don't have a client session yet. Search in session w/o cookie
398 for (c = parent->m_clientPool; c; c = c->m_next)
401 assert (*c->m_prev == c);
402 if (c->m_server == 0 && c->m_cookie == 0 &&
404 !strcmp(m_proxyTarget, c->get_hostname()))
407 yaz_log (LOG_LOG, "%sREUSE %s",
408 m_session_str, c->get_hostname());
410 c->m_seqno = parent->m_seqno;
411 assert(c->m_server == 0);
414 if (parent->m_log_mask & PROXY_LOG_APDU_SERVER)
415 c->set_APDU_yazlog(1);
417 c->set_APDU_yazlog(0);
429 if (apdu->which != Z_APDU_initRequest)
431 yaz_log (LOG_LOG, "%sno init request as first PDU", m_session_str);
434 Z_InitRequest *initRequest = apdu->u.initRequest;
436 if (!initRequest->idAuthentication)
438 if (m_proxy_authentication)
440 initRequest->idAuthentication =
441 (Z_IdAuthentication *)
442 odr_malloc (odr_encode(),
443 sizeof(*initRequest->idAuthentication));
444 initRequest->idAuthentication->which =
445 Z_IdAuthentication_open;
446 initRequest->idAuthentication->u.open =
447 odr_strdup (odr_encode(), m_proxy_authentication);
450 // go through list of clients - and find the lowest/oldest one.
451 Yaz_ProxyClient *c_min = 0;
453 int no_of_clients = 0;
454 if (parent->m_clientPool)
455 yaz_log (LOG_DEBUG, "Existing sessions");
456 for (c = parent->m_clientPool; c; c = c->m_next)
458 yaz_log (LOG_DEBUG, " Session %-3d wait=%d %s cookie=%s", c->m_seqno,
459 c->m_waiting, c->get_hostname(),
460 c->m_cookie ? c->m_cookie : "");
462 if (min_seq < 0 || c->m_seqno < min_seq)
464 min_seq = c->m_seqno;
468 if (no_of_clients >= parent->m_max_clients)
471 if (c->m_waiting || strcmp(m_proxyTarget, c->get_hostname()))
473 yaz_log (LOG_LOG, "%sMAXCLIENTS Destroy %d",
474 m_session_str, c->m_seqno);
475 if (c->m_server && c->m_server != this)
481 yaz_log (LOG_LOG, "%sMAXCLIENTS Reuse %d %d %s",
483 c->m_seqno, parent->m_seqno, c->get_hostname());
487 c->m_cookie = xstrdup(cookie);
488 c->m_seqno = parent->m_seqno;
489 if (c->m_server && c->m_server != this)
491 c->m_server->m_client = 0;
495 c->m_target_idletime = m_target_idletime;
496 c->timeout(m_target_idletime);
498 if (parent->m_log_mask & PROXY_LOG_APDU_SERVER)
499 c->set_APDU_yazlog(1);
501 c->set_APDU_yazlog(0);
508 yaz_log (LOG_LOG, "%sNEW %d %s",
509 m_session_str, parent->m_seqno, m_proxyTarget);
510 c = new Yaz_ProxyClient(m_PDU_Observable->clone(), parent);
511 c->m_next = parent->m_clientPool;
513 c->m_next->m_prev = &c->m_next;
514 parent->m_clientPool = c;
515 c->m_prev = &parent->m_clientPool;
521 c->m_cookie = xstrdup(cookie);
523 c->m_seqno = parent->m_seqno;
525 c->m_last_resultCount = 0;
528 c->m_sr_transform = 0;
530 c->m_resultSetStartPoint = 0;
532 if (c->client(m_proxyTarget))
537 c->m_target_idletime = m_target_idletime;
540 if (parent->m_log_mask & PROXY_LOG_APDU_SERVER)
541 c->set_APDU_yazlog(1);
543 c->set_APDU_yazlog(0);
545 yaz_log (LOG_DEBUG, "get_client 3 %p %p", this, c);
549 void Yaz_Proxy::display_diagrecs(Z_DiagRec **pp, int num)
552 for (i = 0; i<num; i++)
555 Z_DefaultDiagFormat *r;
556 Z_DiagRec *p = pp[i];
557 if (p->which != Z_DiagRec_defaultFormat)
559 yaz_log(LOG_LOG, "%sError no diagnostics", m_session_str);
563 r = p->u.defaultFormat;
564 if (!(ent = oid_getentbyoid(r->diagnosticSetId)) ||
565 ent->oclass != CLASS_DIAGSET || ent->value != VAL_BIB1)
566 yaz_log(LOG_LOG, "%sError unknown diagnostic set", m_session_str);
569 case Z_DefaultDiagFormat_v2Addinfo:
570 yaz_log(LOG_LOG, "%sError %d %s:%s",
572 *r->condition, diagbib1_str(*r->condition),
575 case Z_DefaultDiagFormat_v3Addinfo:
576 yaz_log(LOG_LOG, "%sError %d %s:%s",
578 *r->condition, diagbib1_str(*r->condition),
585 void Yaz_Proxy::convert_xsl(Z_NamePlusRecordList *p)
587 if (!m_stylesheet_schema)
589 xsltStylesheetPtr xsp;
591 xsp = xsltParseStylesheetFile((const xmlChar *) m_stylesheet_schema);
594 for (i = 0; i < p->num_records; i++)
596 Z_NamePlusRecord *npr = p->records[i];
597 if (npr->which == Z_NamePlusRecord_databaseRecord)
599 Z_External *r = npr->u.databaseRecord;
600 if (r->which == Z_External_octet)
602 xmlDocPtr res, doc = xmlParseMemory(
603 (char*) r->u.octet_aligned->buf,
604 r->u.octet_aligned->len);
606 res = xsltApplyStylesheet(xsp, doc, 0);
610 xmlDocDumpFormatMemory (res, &out_buf, &out_len, 1);
612 p->records[i]->u.databaseRecord =
613 z_ext_record(odr_encode(), VAL_TEXT_XML,
614 (char*) out_buf, out_len);
621 xsltFreeStylesheet(xsp);
624 void Yaz_Proxy::convert_to_marcxml(Z_NamePlusRecordList *p)
628 yaz_marc_t mt = yaz_marc_create();
629 yaz_marc_xml(mt, YAZ_MARC_MARCXML);
630 for (i = 0; i < p->num_records; i++)
632 Z_NamePlusRecord *npr = p->records[i];
633 if (npr->which == Z_NamePlusRecord_databaseRecord)
635 Z_External *r = npr->u.databaseRecord;
636 if (r->which == Z_External_octet)
640 if (yaz_marc_decode_buf(mt, (char*) r->u.octet_aligned->buf,
641 r->u.octet_aligned->len,
644 yaz_iconv_t cd = yaz_iconv_open("UTF-8", "MARC-8");
645 WRBUF wrbuf = wrbuf_alloc();
648 size_t inbytesleft = rlen;
649 const char *inp = result;
650 while (cd && inbytesleft)
652 size_t outbytesleft = sizeof(outbuf);
656 r = yaz_iconv (cd, (char**) &inp,
658 &outp, &outbytesleft);
659 if (r == (size_t) (-1))
661 int e = yaz_iconv_error(cd);
662 if (e != YAZ_ICONV_E2BIG)
664 yaz_log(LOG_WARN, "conversion failure");
668 wrbuf_write(wrbuf, outbuf, outp - outbuf);
673 npr->u.databaseRecord = z_ext_record(odr_encode(),
677 wrbuf_free(wrbuf, 1);
682 yaz_marc_destroy(mt);
685 void Yaz_Proxy::logtime()
687 if (m_time_tv.tv_sec)
690 gettimeofday(&tv, 0);
691 long diff = (tv.tv_sec - m_time_tv.tv_sec)*1000000 +
692 (tv.tv_usec - m_time_tv.tv_usec);
694 yaz_log(LOG_LOG, "%sElapsed %ld.%03ld", m_session_str,
695 diff/1000000, (diff/1000)%1000);
697 m_time_tv.tv_sec = 0;
698 m_time_tv.tv_usec = 0;
701 int Yaz_Proxy::send_http_response(int code)
703 ODR o = odr_encode();
704 Z_GDU *gdu = z_get_HTTP_Response(o, code);
705 Z_HTTP_Response *hres = gdu->u.HTTP_Response;
707 hres->version = odr_strdup(o, m_http_version);
708 m_http_keepalive = 0;
709 if (m_log_mask & PROXY_LOG_REQ_CLIENT)
711 yaz_log (LOG_LOG, "%sSending %s to client", m_session_str,
715 int r = send_GDU(gdu, &len);
720 int Yaz_Proxy::send_srw_response(Z_SRW_PDU *srw_pdu)
722 ODR o = odr_encode();
723 const char *ctype = "text/xml";
724 Z_GDU *gdu = z_get_HTTP_Response(o, 200);
725 Z_HTTP_Response *hres = gdu->u.HTTP_Response;
727 hres->version = odr_strdup(o, m_http_version);
728 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
729 if (m_http_keepalive)
730 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
732 static Z_SOAP_Handler soap_handlers[2] = {
734 {"http://www.loc.gov/zing/srw/", 0,
735 (Z_SOAP_fun) yaz_srw_codec},
740 Z_SOAP *soap_package = (Z_SOAP*) odr_malloc(o, sizeof(Z_SOAP));
741 soap_package->which = Z_SOAP_generic;
742 soap_package->u.generic =
743 (Z_SOAP_Generic *) odr_malloc(o, sizeof(*soap_package->u.generic));
744 soap_package->u.generic->no = 0;
745 soap_package->u.generic->ns = soap_handlers[0].ns;
746 soap_package->u.generic->p = (void *) srw_pdu;
747 soap_package->ns = m_soap_ns;
748 z_soap_codec_enc_xsl(o, &soap_package,
749 &hres->content_buf, &hres->content_len,
750 soap_handlers, 0, m_s2z_stylesheet);
751 if (m_log_mask & PROXY_LOG_REQ_CLIENT)
753 yaz_log (LOG_LOG, "%sSending %s to client", m_session_str,
757 int r = send_GDU(gdu, &len);
762 int Yaz_Proxy::send_to_srw_client_error(int srw_error, const char *add)
764 ODR o = odr_encode();
765 Z_SRW_PDU *srw_pdu = yaz_srw_get(o, Z_SRW_searchRetrieve_response);
766 Z_SRW_searchRetrieveResponse *srw_res = srw_pdu->u.response;
768 srw_res->num_diagnostics = 1;
769 srw_res->diagnostics = (Z_SRW_diagnostic *)
770 odr_malloc(o, sizeof(*srw_res->diagnostics));
771 srw_res->diagnostics[0].code = odr_intdup(o, srw_error);
772 srw_res->diagnostics[0].details = add ? odr_strdup(o, add) : 0;
773 return send_srw_response(srw_pdu);
776 int Yaz_Proxy::z_to_srw_diag(ODR o, Z_SRW_searchRetrieveResponse *srw_res,
777 Z_DefaultDiagFormat *ddf)
779 int bib1_code = *ddf->condition;
780 if (bib1_code == 109)
782 srw_res->num_diagnostics = 1;
783 srw_res->diagnostics = (Z_SRW_diagnostic *)
784 odr_malloc(o, sizeof(*srw_res->diagnostics));
785 srw_res->diagnostics[0].code =
786 odr_intdup(o, yaz_diag_bib1_to_srw(*ddf->condition));
787 srw_res->diagnostics[0].details = ddf->u.v2Addinfo;
791 int Yaz_Proxy::send_to_srw_client_ok(int hits, Z_Records *records, int start)
793 ODR o = odr_encode();
794 Z_SRW_PDU *srw_pdu = yaz_srw_get(o, Z_SRW_searchRetrieve_response);
795 Z_SRW_searchRetrieveResponse *srw_res = srw_pdu->u.response;
797 srw_res->numberOfRecords = odr_intdup (o, hits);
798 if (records && records->which == Z_Records_DBOSD)
800 srw_res->num_records =
801 records->u.databaseOrSurDiagnostics->num_records;
803 srw_res->records = (Z_SRW_record *)
804 odr_malloc(o, srw_res->num_records * sizeof(Z_SRW_record));
805 for (i = 0; i < srw_res->num_records; i++)
807 Z_NamePlusRecord *npr = records->u.databaseOrSurDiagnostics->records[i];
808 if (npr->which != Z_NamePlusRecord_databaseRecord)
810 srw_res->records[i].recordSchema = "diagnostic";
811 srw_res->records[i].recordPacking = m_s2z_packing;
812 srw_res->records[i].recordData_buf = "67";
813 srw_res->records[i].recordData_len = 2;
814 srw_res->records[i].recordPosition = odr_intdup(o, i+start);
817 Z_External *r = npr->u.databaseRecord;
818 oident *ent = oid_getentbyoid(r->direct_reference);
819 if (r->which == Z_External_octet && ent->value == VAL_TEXT_XML)
821 srw_res->records[i].recordSchema = m_schema;
822 srw_res->records[i].recordPacking = m_s2z_packing;
823 srw_res->records[i].recordData_buf = (char*)
824 r->u.octet_aligned->buf;
825 srw_res->records[i].recordData_len = r->u.octet_aligned->len;
826 srw_res->records[i].recordPosition = odr_intdup(o, i+start);
830 srw_res->records[i].recordSchema = "diagnostic";
831 srw_res->records[i].recordPacking = m_s2z_packing;
832 srw_res->records[i].recordData_buf = "67";
833 srw_res->records[i].recordData_len = 2;
834 srw_res->records[i].recordPosition = odr_intdup(o, i+start);
838 if (records && records->which == Z_Records_NSD)
841 http_code = z_to_srw_diag(odr_encode(), srw_res,
842 records->u.nonSurrogateDiagnostic);
844 return send_http_response(http_code);
846 return send_srw_response(srw_pdu);
850 int Yaz_Proxy::send_srw_explain_response(Z_SRW_diagnostic *diagnostics,
853 Z_SRW_PDU *res = yaz_srw_get(odr_encode(), Z_SRW_explain_response);
854 Z_SRW_explainResponse *er = res->u.explain_response;
856 Yaz_ProxyConfig *cfg = check_reconfigure();
860 char *b = cfg->get_explain(odr_encode(), 0 /* target */,
864 er->record.recordData_buf = b;
865 er->record.recordData_len = len;
866 er->record.recordPacking = m_s2z_packing;
869 er->diagnostics = diagnostics;
870 er->num_diagnostics = num_diagnostics;
871 return send_srw_response(res);
874 int Yaz_Proxy::send_PDU_convert(Z_APDU *apdu, int *len)
878 if (apdu->which == Z_APDU_initResponse)
880 Z_InitResponse *res = apdu->u.initResponse;
881 if (*res->result == 0)
883 send_to_srw_client_error(3, 0);
885 else if (!m_s2z_search_apdu)
887 send_srw_explain_response(0, 0);
891 handle_incoming_Z_PDU(m_s2z_search_apdu);
894 else if (m_s2z_search_apdu && apdu->which == Z_APDU_searchResponse)
896 m_s2z_search_apdu = 0;
897 Z_SearchResponse *res = apdu->u.searchResponse;
898 m_s2z_hit_count = *res->resultCount;
899 if (res->records && res->records->which == Z_Records_NSD)
901 send_to_srw_client_ok(0, res->records, 1);
903 else if (m_s2z_present_apdu && m_s2z_hit_count > 0)
906 Z_PresentRequest *pr = m_s2z_present_apdu->u.presentRequest;
908 if (*pr->resultSetStartPoint <= m_s2z_hit_count)
910 if (*pr->numberOfRecordsRequested+ *pr->resultSetStartPoint
912 *pr->numberOfRecordsRequested =
913 1 + m_s2z_hit_count - *pr->resultSetStartPoint;
915 handle_incoming_Z_PDU(m_s2z_present_apdu);
919 m_s2z_present_apdu = 0;
920 send_to_srw_client_ok(m_s2z_hit_count, res->records, 1);
923 else if (m_s2z_present_apdu && apdu->which == Z_APDU_presentResponse)
926 *m_s2z_present_apdu->u.presentRequest->resultSetStartPoint;
928 m_s2z_present_apdu = 0;
929 Z_PresentResponse *res = apdu->u.presentResponse;
930 send_to_srw_client_ok(m_s2z_hit_count, res->records, start);
935 if (m_log_mask & PROXY_LOG_REQ_CLIENT)
936 yaz_log (LOG_LOG, "%sSending %s to client", m_session_str,
938 int r = send_Z_PDU(apdu, len);
945 int Yaz_Proxy::send_to_client(Z_APDU *apdu)
948 int kill_session = 0;
949 if (apdu->which == Z_APDU_searchResponse)
951 Z_SearchResponse *sr = apdu->u.searchResponse;
952 Z_Records *p = sr->records;
953 if (p && p->which == Z_Records_NSD)
955 Z_DiagRec dr, *dr_p = &dr;
956 dr.which = Z_DiagRec_defaultFormat;
957 dr.u.defaultFormat = p->u.nonSurrogateDiagnostic;
959 *sr->searchStatus = 0;
960 display_diagrecs(&dr_p, 1);
964 if (p && p->which == Z_Records_DBOSD)
967 convert_to_marcxml(p->u.databaseOrSurDiagnostics);
968 convert_xsl(p->u.databaseOrSurDiagnostics);
972 yaz_log(LOG_LOG, "%s%d hits", m_session_str,
974 if (*sr->resultCount < 0)
976 m_invalid_session = 1;
979 *sr->searchStatus = 0;
981 create_nonSurrogateDiagnostics(odr_encode(), 2, 0);
982 *sr->resultCount = 0;
987 else if (apdu->which == Z_APDU_presentResponse)
989 Z_PresentResponse *sr = apdu->u.presentResponse;
990 Z_Records *p = sr->records;
991 if (p && p->which == Z_Records_NSD)
993 Z_DiagRec dr, *dr_p = &dr;
994 dr.which = Z_DiagRec_defaultFormat;
995 dr.u.defaultFormat = p->u.nonSurrogateDiagnostic;
996 if (*sr->presentStatus == Z_PresentStatus_success)
997 *sr->presentStatus = Z_PresentStatus_failure;
998 display_diagrecs(&dr_p, 1);
1000 if (p && p->which == Z_Records_DBOSD)
1003 convert_to_marcxml(p->u.databaseOrSurDiagnostics);
1004 convert_xsl(p->u.databaseOrSurDiagnostics);
1007 else if (apdu->which == Z_APDU_initResponse)
1009 if (m_initRequest_options)
1012 (Odr_bitmask *)odr_malloc(odr_encode(),
1013 sizeof(Odr_bitmask));
1014 ODR_MASK_ZERO(nopt);
1017 for (i = 0; i<24; i++)
1018 if (ODR_MASK_GET(m_initRequest_options, i) &&
1019 ODR_MASK_GET(apdu->u.initResponse->options, i))
1020 ODR_MASK_SET(nopt, i);
1021 apdu->u.initResponse->options = nopt;
1023 if (m_initRequest_version)
1025 Z_ProtocolVersion *nopt =
1026 (Odr_bitmask *)odr_malloc(odr_encode(),
1027 sizeof(Odr_bitmask));
1028 ODR_MASK_ZERO(nopt);
1031 for (i = 0; i<8; i++)
1032 if (ODR_MASK_GET(m_initRequest_version, i) &&
1033 ODR_MASK_GET(apdu->u.initResponse->protocolVersion, i))
1034 ODR_MASK_SET(nopt, i);
1035 apdu->u.initResponse->protocolVersion = nopt;
1038 int r = send_PDU_convert(apdu, &len);
1041 m_bytes_sent += len;
1042 m_bw_stat.add_bytes(len);
1047 m_parent->pre_init();
1051 if (!m_http_keepalive)
1064 int Yaz_ProxyClient::send_to_target(Z_APDU *apdu)
1067 const char *apdu_name_tmp = apdu_name(apdu);
1068 int r = send_Z_PDU(apdu, &len);
1069 if (m_root->get_log_mask() & PROXY_LOG_REQ_SERVER)
1070 yaz_log (LOG_LOG, "%sSending %s to %s %d bytes",
1072 apdu_name_tmp, get_hostname(), len);
1073 m_bytes_sent += len;
1077 Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
1079 if (apdu->which == Z_APDU_presentRequest)
1081 Z_PresentRequest *pr = apdu->u.presentRequest;
1082 int toget = *pr->numberOfRecordsRequested;
1083 int start = *pr->resultSetStartPoint;
1085 yaz_log(LOG_LOG, "%sPresent %s %d+%d", m_session_str,
1086 pr->resultSetId, start, toget);
1088 if (*m_parent->m_optimize == '0')
1091 if (!m_client->m_last_resultSetId)
1093 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1094 new_apdu->u.presentResponse->records =
1095 create_nonSurrogateDiagnostics(odr_encode(), 30,
1097 send_to_client(new_apdu);
1100 if (!strcmp(m_client->m_last_resultSetId, pr->resultSetId))
1102 if (start+toget-1 > m_client->m_last_resultCount)
1104 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1105 new_apdu->u.presentResponse->records =
1106 create_nonSurrogateDiagnostics(odr_encode(), 13, 0);
1107 send_to_client(new_apdu);
1110 Z_NamePlusRecordList *npr;
1111 if (m_client->m_cache.lookup (odr_encode(), &npr, start, toget,
1112 pr->preferredRecordSyntax,
1113 pr->recordComposition))
1115 yaz_log (LOG_LOG, "%sReturned cached records for present request",
1117 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1118 new_apdu->u.presentResponse->referenceId = pr->referenceId;
1120 new_apdu->u.presentResponse->numberOfRecordsReturned
1121 = odr_intdup(odr_encode(), toget);
1123 new_apdu->u.presentResponse->records = (Z_Records*)
1124 odr_malloc(odr_encode(), sizeof(Z_Records));
1125 new_apdu->u.presentResponse->records->which = Z_Records_DBOSD;
1126 new_apdu->u.presentResponse->records->u.databaseOrSurDiagnostics = npr;
1127 new_apdu->u.presentResponse->nextResultSetPosition =
1128 odr_intdup(odr_encode(), start+toget);
1130 send_to_client(new_apdu);
1136 if (apdu->which != Z_APDU_searchRequest)
1138 Z_SearchRequest *sr = apdu->u.searchRequest;
1139 Yaz_Z_Query *this_query = new Yaz_Z_Query;
1140 Yaz_Z_Databases this_databases;
1142 this_databases.set(sr->num_databaseNames, (const char **)
1145 this_query->set_Z_Query(sr->query);
1147 char query_str[120];
1148 this_query->print(query_str, sizeof(query_str)-1);
1149 yaz_log(LOG_LOG, "%sSearch %s", m_session_str, query_str);
1151 if (*m_parent->m_optimize != '0' &&
1152 m_client->m_last_ok && m_client->m_last_query &&
1153 m_client->m_last_query->match(this_query) &&
1154 !strcmp(m_client->m_last_resultSetId, sr->resultSetName) &&
1155 m_client->m_last_databases.match(this_databases))
1158 if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
1159 m_client->m_last_resultCount < *sr->largeSetLowerBound)
1161 Z_NamePlusRecordList *npr;
1162 int toget = *sr->mediumSetPresentNumber;
1163 Z_RecordComposition *comp = 0;
1165 if (toget > m_client->m_last_resultCount)
1166 toget = m_client->m_last_resultCount;
1168 if (sr->mediumSetElementSetNames)
1170 comp = (Z_RecordComposition *)
1171 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
1172 comp->which = Z_RecordComp_simple;
1173 comp->u.simple = sr->mediumSetElementSetNames;
1176 if (m_client->m_cache.lookup (odr_encode(), &npr, 1, toget,
1177 sr->preferredRecordSyntax, comp))
1179 yaz_log (LOG_LOG, "%sReturned cached records for medium set",
1181 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1182 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1183 new_apdu->u.searchResponse->resultCount =
1184 &m_client->m_last_resultCount;
1186 new_apdu->u.searchResponse->numberOfRecordsReturned
1187 = odr_intdup(odr_encode(), toget);
1189 new_apdu->u.searchResponse->presentStatus =
1190 odr_intdup(odr_encode(), Z_PresentStatus_success);
1191 new_apdu->u.searchResponse->records = (Z_Records*)
1192 odr_malloc(odr_encode(), sizeof(Z_Records));
1193 new_apdu->u.searchResponse->records->which = Z_Records_DBOSD;
1194 new_apdu->u.searchResponse->records->u.databaseOrSurDiagnostics = npr;
1195 new_apdu->u.searchResponse->nextResultSetPosition =
1196 odr_intdup(odr_encode(), toget+1);
1197 send_to_client(new_apdu);
1203 // send present request (medium size)
1204 yaz_log (LOG_LOG, "%sOptimizing search for medium set",
1207 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
1208 Z_PresentRequest *pr = new_apdu->u.presentRequest;
1209 pr->referenceId = sr->referenceId;
1210 pr->resultSetId = sr->resultSetName;
1211 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
1212 *pr->numberOfRecordsRequested = toget;
1213 pr->recordComposition = comp;
1214 m_client->m_sr_transform = 1;
1218 else if (m_client->m_last_resultCount >= *sr->largeSetLowerBound ||
1219 m_client->m_last_resultCount <= 0)
1221 // large set. Return pseudo-search response immediately
1222 yaz_log (LOG_LOG, "%sOptimizing search for large set",
1224 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1225 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1226 new_apdu->u.searchResponse->resultCount =
1227 &m_client->m_last_resultCount;
1228 send_to_client(new_apdu);
1233 Z_NamePlusRecordList *npr;
1234 int toget = m_client->m_last_resultCount;
1235 Z_RecordComposition *comp = 0;
1237 // send a present request (small set)
1239 if (sr->smallSetElementSetNames)
1241 comp = (Z_RecordComposition *)
1242 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
1243 comp->which = Z_RecordComp_simple;
1244 comp->u.simple = sr->smallSetElementSetNames;
1247 if (m_client->m_cache.lookup (odr_encode(), &npr, 1, toget,
1248 sr->preferredRecordSyntax, comp))
1250 yaz_log (LOG_LOG, "%sReturned cached records for small set",
1252 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1253 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1254 new_apdu->u.searchResponse->resultCount =
1255 &m_client->m_last_resultCount;
1257 new_apdu->u.searchResponse->numberOfRecordsReturned
1258 = odr_intdup(odr_encode(), toget);
1260 new_apdu->u.searchResponse->presentStatus =
1261 odr_intdup(odr_encode(), Z_PresentStatus_success);
1262 new_apdu->u.searchResponse->records = (Z_Records*)
1263 odr_malloc(odr_encode(), sizeof(Z_Records));
1264 new_apdu->u.searchResponse->records->which = Z_Records_DBOSD;
1265 new_apdu->u.searchResponse->records->u.databaseOrSurDiagnostics = npr;
1266 new_apdu->u.searchResponse->nextResultSetPosition =
1267 odr_intdup(odr_encode(), toget+1);
1268 send_to_client(new_apdu);
1273 yaz_log (LOG_LOG, "%sOptimizing search for small set",
1275 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
1276 Z_PresentRequest *pr = new_apdu->u.presentRequest;
1277 pr->referenceId = sr->referenceId;
1278 pr->resultSetId = sr->resultSetName;
1279 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
1280 *pr->numberOfRecordsRequested = toget;
1281 pr->recordComposition = comp;
1282 m_client->m_sr_transform = 1;
1287 else // query doesn't match
1289 delete m_client->m_last_query;
1290 m_client->m_last_query = this_query;
1291 m_client->m_last_ok = 0;
1292 m_client->m_cache.clear();
1293 m_client->m_resultSetStartPoint = 0;
1295 xfree (m_client->m_last_resultSetId);
1296 m_client->m_last_resultSetId = xstrdup (sr->resultSetName);
1298 m_client->m_last_databases.set(sr->num_databaseNames,
1299 (const char **) sr->databaseNames);
1305 void Yaz_Proxy::inc_request_no()
1307 char *cp = strchr(m_session_str, ' ');
1310 sprintf(cp+1, "%d ", m_request_no);
1313 void Yaz_Proxy::recv_GDU(Z_GDU *apdu, int len)
1317 m_bytes_recv += len;
1319 if (m_log_mask & PROXY_LOG_APDU_CLIENT)
1320 yaz_log (LOG_DEBUG, "%sReceiving %s from client %d bytes",
1321 m_session_str, gdu_name(apdu), len);
1323 if (m_bw_hold_PDU) // double incoming PDU. shutdown now.
1326 m_bw_stat.add_bytes(len);
1327 m_pdu_stat.add_bytes(1);
1329 gettimeofday(&m_time_tv, 0);
1331 int bw_total = m_bw_stat.get_total();
1332 int pdu_total = m_pdu_stat.get_total();
1337 if (bw_total > m_bw_max)
1339 reduce = (bw_total/m_bw_max);
1344 if (pdu_total > m_pdu_max)
1346 int nreduce = (m_pdu_max >= 60) ? 1 : 60/m_pdu_max;
1347 reduce = (reduce > nreduce) ? reduce : nreduce;
1352 yaz_log(LOG_LOG, "%sdelay=%d bw=%d pdu=%d limit-bw=%d limit-pdu=%d",
1353 m_session_str, reduce, bw_total, pdu_total,
1354 m_bw_max, m_pdu_max);
1356 m_bw_hold_PDU = apdu; // save PDU and signal "on hold"
1357 timeout(reduce); // call us reduce seconds later
1359 else if (apdu->which == Z_GDU_Z3950)
1360 handle_incoming_Z_PDU(apdu->u.z3950);
1361 else if (apdu->which == Z_GDU_HTTP_Request)
1362 handle_incoming_HTTP(apdu->u.HTTP_Request);
1365 void Yaz_Proxy::handle_max_record_retrieve(Z_APDU *apdu)
1367 if (m_max_record_retrieve)
1369 if (apdu->which == Z_APDU_presentRequest)
1371 Z_PresentRequest *pr = apdu->u.presentRequest;
1372 if (pr->numberOfRecordsRequested &&
1373 *pr->numberOfRecordsRequested > m_max_record_retrieve)
1374 *pr->numberOfRecordsRequested = m_max_record_retrieve;
1379 Z_Records *Yaz_Proxy::create_nonSurrogateDiagnostics(ODR odr,
1381 const char *addinfo)
1383 Z_Records *rec = (Z_Records *)
1384 odr_malloc (odr, sizeof(*rec));
1386 odr_malloc (odr, sizeof(*err));
1387 Z_DiagRec *drec = (Z_DiagRec *)
1388 odr_malloc (odr, sizeof(*drec));
1389 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1390 odr_malloc (odr, sizeof(*dr));
1392 rec->which = Z_Records_NSD;
1393 rec->u.nonSurrogateDiagnostic = dr;
1394 dr->diagnosticSetId =
1395 yaz_oidval_to_z3950oid (odr, CLASS_DIAGSET, VAL_BIB1);
1396 dr->condition = err;
1397 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1398 dr->u.v2Addinfo = odr_strdup (odr, addinfo ? addinfo : "");
1402 Z_APDU *Yaz_Proxy::handle_query_transformation(Z_APDU *apdu)
1404 if (apdu->which == Z_APDU_searchRequest &&
1405 apdu->u.searchRequest->query &&
1406 apdu->u.searchRequest->query->which == Z_Query_type_104 &&
1407 apdu->u.searchRequest->query->u.type_104->which == Z_External_CQL)
1409 Z_RPNQuery *rpnquery = 0;
1410 Z_SearchRequest *sr = apdu->u.searchRequest;
1413 yaz_log(LOG_LOG, "%sCQL: %s", m_session_str,
1414 sr->query->u.type_104->u.cql);
1416 int r = m_cql2rpn.query_transform(sr->query->u.type_104->u.cql,
1417 &rpnquery, odr_encode(),
1420 yaz_log(LOG_LOG, "%sNo CQL to RPN table", m_session_str);
1423 yaz_log(LOG_LOG, "%sCQL Conversion error %d", m_session_str, r);
1424 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1426 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1427 new_apdu->u.searchResponse->records =
1428 create_nonSurrogateDiagnostics(odr_encode(),
1429 yaz_diag_srw_to_bib1(r),
1431 *new_apdu->u.searchResponse->searchStatus = 0;
1433 send_to_client(new_apdu);
1439 sr->query->which = Z_Query_type_1;
1440 sr->query->u.type_1 = rpnquery;
1447 Z_APDU *Yaz_Proxy::handle_query_validation(Z_APDU *apdu)
1449 if (apdu->which == Z_APDU_searchRequest)
1451 Z_SearchRequest *sr = apdu->u.searchRequest;
1455 Yaz_ProxyConfig *cfg = check_reconfigure();
1457 err = cfg->check_query(odr_encode(), m_default_target,
1458 sr->query, &addinfo);
1461 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1463 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1464 new_apdu->u.searchResponse->records =
1465 create_nonSurrogateDiagnostics(odr_encode(), err, addinfo);
1466 *new_apdu->u.searchResponse->searchStatus = 0;
1468 send_to_client(new_apdu);
1476 Z_APDU *Yaz_Proxy::handle_syntax_validation(Z_APDU *apdu)
1479 if (apdu->which == Z_APDU_searchRequest)
1481 Z_SearchRequest *sr = apdu->u.searchRequest;
1484 Yaz_ProxyConfig *cfg = check_reconfigure();
1486 Z_RecordComposition rc_temp, *rc = 0;
1487 if (sr->smallSetElementSetNames)
1489 rc_temp.which = Z_RecordComp_simple;
1490 rc_temp.u.simple = sr->smallSetElementSetNames;
1495 err = cfg->check_syntax(odr_encode(),
1497 sr->preferredRecordSyntax, rc,
1498 &addinfo, &m_stylesheet_schema, &m_schema);
1501 sr->preferredRecordSyntax =
1502 yaz_oidval_to_z3950oid(odr_encode(), CLASS_RECSYN, VAL_USMARC);
1507 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1509 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1510 new_apdu->u.searchResponse->records =
1511 create_nonSurrogateDiagnostics(odr_encode(), err, addinfo);
1512 *new_apdu->u.searchResponse->searchStatus = 0;
1514 send_to_client(new_apdu);
1519 else if (apdu->which == Z_APDU_presentRequest)
1521 Z_PresentRequest *pr = apdu->u.presentRequest;
1524 Yaz_ProxyConfig *cfg = check_reconfigure();
1527 err = cfg->check_syntax(odr_encode(), m_default_target,
1528 pr->preferredRecordSyntax,
1529 pr->recordComposition,
1530 &addinfo, &m_stylesheet_schema, &m_schema);
1533 pr->preferredRecordSyntax =
1534 yaz_oidval_to_z3950oid(odr_decode(), CLASS_RECSYN, VAL_USMARC);
1539 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1541 new_apdu->u.presentResponse->referenceId = pr->referenceId;
1542 new_apdu->u.presentResponse->records =
1543 create_nonSurrogateDiagnostics(odr_encode(), err, addinfo);
1544 *new_apdu->u.presentResponse->presentStatus =
1545 Z_PresentStatus_failure;
1547 send_to_client(new_apdu);
1555 Z_ElementSetNames *Yaz_Proxy::mk_esn_from_schema(ODR o, const char *schema)
1559 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1560 odr_malloc(o, sizeof(Z_ElementSetNames));
1561 esn->which = Z_ElementSetNames_generic;
1562 esn->u.generic = odr_strdup(o, schema);
1566 void Yaz_Proxy::handle_incoming_HTTP(Z_HTTP_Request *hreq)
1571 odr_destroy(m_s2z_odr_init);
1574 if (m_s2z_odr_search)
1576 odr_destroy(m_s2z_odr_search);
1577 m_s2z_odr_search = 0;
1580 m_http_keepalive = 0;
1582 if (!strcmp(hreq->version, "1.0"))
1584 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1585 if (v && !strcmp(v, "Keep-Alive"))
1586 m_http_keepalive = 1;
1588 m_http_keepalive = 0;
1589 m_http_version = "1.0";
1593 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1594 if (v && !strcmp(v, "close"))
1595 m_http_keepalive = 0;
1597 m_http_keepalive = 1;
1598 m_http_version = "1.1";
1601 Z_SRW_PDU *srw_pdu = 0;
1602 Z_SOAP *soap_package = 0;
1604 Z_SRW_diagnostic *diagnostic = 0;
1605 int num_diagnostic = 0;
1606 if (yaz_srw_decode(hreq, &srw_pdu, &soap_package, odr_decode(),
1608 || yaz_sru_decode(hreq, &srw_pdu, &soap_package, odr_decode(),
1609 &charset, &diagnostic, &num_diagnostic) == 0)
1611 m_s2z_odr_init = odr_createmem(ODR_ENCODE);
1612 m_s2z_odr_search = odr_createmem(ODR_ENCODE);
1613 m_soap_ns = odr_strdup(m_s2z_odr_search, soap_package->ns);
1614 m_s2z_init_apdu = 0;
1615 m_s2z_search_apdu = 0;
1616 m_s2z_present_apdu = 0;
1618 m_s2z_stylesheet = 0;
1620 if (srw_pdu->which == Z_SRW_searchRetrieve_request)
1622 Z_SRW_searchRetrieveRequest *srw_req = srw_pdu->u.request;
1624 // recordXPath unsupported.
1625 if (srw_req->recordXPath)
1627 yaz_add_srw_diagnostic(odr_decode(),
1628 &diagnostic, &num_diagnostic,
1631 // must have a query
1632 if (!srw_req->query.cql)
1634 yaz_add_srw_diagnostic(odr_decode(),
1635 &diagnostic, &num_diagnostic,
1639 if (srw_req->sort_type != Z_SRW_sort_type_none)
1641 yaz_add_srw_diagnostic(odr_decode(),
1642 &diagnostic, &num_diagnostic,
1646 if (srw_req->stylesheet)
1648 odr_strdup(m_s2z_odr_init, srw_req->stylesheet);
1650 // set packing for response records ..
1651 if (srw_req->recordPacking &&
1652 !strcmp(srw_req->recordPacking, "xml"))
1653 m_s2z_packing = Z_SRW_recordPacking_XML;
1655 m_s2z_packing = Z_SRW_recordPacking_string;
1659 Z_SRW_PDU *srw_pdu =
1660 yaz_srw_get(odr_encode(),
1661 Z_SRW_searchRetrieve_response);
1662 Z_SRW_searchRetrieveResponse *srw_res = srw_pdu->u.response;
1664 srw_res->diagnostics = diagnostic;
1665 srw_res->num_diagnostics = num_diagnostic;
1666 send_srw_response(srw_pdu);
1670 // prepare search PDU
1671 m_s2z_search_apdu = zget_APDU(m_s2z_odr_search,
1672 Z_APDU_searchRequest);
1673 Z_SearchRequest *z_searchRequest =
1674 m_s2z_search_apdu->u.searchRequest;
1676 z_searchRequest->num_databaseNames = 1;
1677 z_searchRequest->databaseNames = (char**)
1678 odr_malloc(m_s2z_odr_search, sizeof(char *));
1679 z_searchRequest->databaseNames[0] = odr_strdup(m_s2z_odr_search,
1682 // query transformation
1683 Z_Query *query = (Z_Query *)
1684 odr_malloc(m_s2z_odr_search, sizeof(Z_Query));
1685 z_searchRequest->query = query;
1687 if (srw_req->query_type == Z_SRW_query_type_cql)
1689 Z_External *ext = (Z_External *)
1690 odr_malloc(m_s2z_odr_search, sizeof(*ext));
1691 ext->direct_reference =
1692 odr_getoidbystr(m_s2z_odr_search, "1.2.840.10003.16.2");
1693 ext->indirect_reference = 0;
1694 ext->descriptor = 0;
1695 ext->which = Z_External_CQL;
1696 ext->u.cql = srw_req->query.cql;
1698 query->which = Z_Query_type_104;
1699 query->u.type_104 = ext;
1701 else if (srw_req->query_type == Z_SRW_query_type_pqf)
1703 Z_RPNQuery *RPNquery;
1704 YAZ_PQF_Parser pqf_parser;
1706 pqf_parser = yaz_pqf_create ();
1708 RPNquery = yaz_pqf_parse (pqf_parser, m_s2z_odr_search,
1709 srw_req->query.pqf);
1712 const char *pqf_msg;
1714 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
1715 yaz_log(LOG_LOG, "%*s^\n", off+4, "");
1716 yaz_log(LOG_LOG, "Bad PQF: %s (code %d)\n", pqf_msg, code);
1718 send_to_srw_client_error(10, 0);
1721 query->which = Z_Query_type_1;
1722 query->u.type_1 = RPNquery;
1724 yaz_pqf_destroy (pqf_parser);
1728 send_to_srw_client_error(7, "query");
1733 m_s2z_present_apdu = 0;
1735 if (srw_req->maximumRecords)
1736 max = *srw_req->maximumRecords;
1738 if (srw_req->startRecord)
1739 start = *srw_req->startRecord;
1742 // Some backend, such as Voyager doesn't honor piggyback
1743 // So we use present always (0 &&).
1744 if (0 && start <= 1) // Z39.50 piggyback
1746 *z_searchRequest->smallSetUpperBound = max;
1747 *z_searchRequest->mediumSetPresentNumber = max;
1748 *z_searchRequest->largeSetLowerBound = 2000000000; // 2e9
1750 z_searchRequest->preferredRecordSyntax =
1751 yaz_oidval_to_z3950oid(m_s2z_odr_search, CLASS_RECSYN,
1753 if (srw_req->recordSchema)
1755 z_searchRequest->smallSetElementSetNames =
1756 z_searchRequest->mediumSetElementSetNames =
1757 mk_esn_from_schema(m_s2z_odr_search,
1758 srw_req->recordSchema);
1761 else // Z39.50 present
1763 m_s2z_present_apdu = zget_APDU(m_s2z_odr_search,
1764 Z_APDU_presentRequest);
1765 Z_PresentRequest *z_presentRequest =
1766 m_s2z_present_apdu->u.presentRequest;
1767 *z_presentRequest->resultSetStartPoint = start;
1768 *z_presentRequest->numberOfRecordsRequested = max;
1769 z_presentRequest->preferredRecordSyntax =
1770 yaz_oidval_to_z3950oid(m_s2z_odr_search, CLASS_RECSYN,
1772 z_presentRequest->recordComposition =
1773 (Z_RecordComposition *)
1774 odr_malloc(m_s2z_odr_search,
1775 sizeof(Z_RecordComposition));
1776 if (srw_req->recordSchema)
1778 z_presentRequest->recordComposition->which =
1779 Z_RecordComp_simple;
1780 z_presentRequest->recordComposition->u.simple =
1781 mk_esn_from_schema(m_s2z_odr_search,
1782 srw_req->recordSchema);
1788 m_s2z_init_apdu = zget_APDU(m_s2z_odr_init,
1789 Z_APDU_initRequest);
1791 // prevent m_initRequest_apdu memory from being grabbed
1792 // in Yaz_Proxy::handle_incoming_Z_PDU
1793 m_initRequest_apdu = m_s2z_init_apdu;
1794 handle_incoming_Z_PDU(m_s2z_init_apdu);
1799 handle_incoming_Z_PDU(m_s2z_search_apdu);
1803 else if (srw_pdu->which == Z_SRW_explain_request)
1805 Z_SRW_explainRequest *srw_req = srw_pdu->u.explain_request;
1808 if (srw_req->stylesheet)
1810 odr_strdup(m_s2z_odr_init, srw_req->stylesheet);
1812 if (srw_req->recordPacking &&
1813 !strcmp(srw_req->recordPacking, "xml"))
1814 m_s2z_packing = Z_SRW_recordPacking_XML;
1816 m_s2z_packing = Z_SRW_recordPacking_string;
1820 send_srw_explain_response(diagnostic, num_diagnostic);
1826 m_s2z_init_apdu = zget_APDU(m_s2z_odr_init,
1827 Z_APDU_initRequest);
1829 // prevent m_initRequest_apdu memory from being grabbed
1830 // in Yaz_Proxy::handle_incoming_Z_PDU
1831 m_initRequest_apdu = m_s2z_init_apdu;
1832 handle_incoming_Z_PDU(m_s2z_init_apdu);
1835 send_srw_explain_response(0, 0);
1838 else if (srw_pdu->which == Z_SRW_scan_request)
1840 yaz_add_srw_diagnostic(odr_decode(),
1841 &diagnostic, &num_diagnostic,
1843 Z_SRW_PDU *srw_pdu =
1844 yaz_srw_get(odr_encode(),
1845 Z_SRW_scan_response);
1846 Z_SRW_scanResponse *srw_res = srw_pdu->u.scan_response;
1848 srw_res->diagnostics = diagnostic;
1849 srw_res->num_diagnostics = num_diagnostic;
1850 send_srw_response(srw_pdu);
1855 send_to_srw_client_error(4, 0);
1859 Z_GDU *p = z_get_HTTP_Response(odr_encode(), 400);
1864 void Yaz_Proxy::handle_incoming_Z_PDU(Z_APDU *apdu)
1866 if (!m_client && m_invalid_session)
1868 m_apdu_invalid_session = apdu;
1869 m_mem_invalid_session = odr_extract_mem(odr_decode());
1870 apdu = m_initRequest_apdu;
1873 // Determine our client.
1874 Z_OtherInformation **oi;
1875 get_otherInfoAPDU(apdu, &oi);
1876 m_client = get_client(apdu, get_cookie(oi), get_proxy(oi));
1882 m_client->m_server = this;
1884 if (apdu->which == Z_APDU_initRequest)
1886 if (apdu->u.initRequest->implementationId)
1887 yaz_log(LOG_LOG, "%simplementationId: %s",
1888 m_session_str, apdu->u.initRequest->implementationId);
1889 if (apdu->u.initRequest->implementationName)
1890 yaz_log(LOG_LOG, "%simplementationName: %s",
1891 m_session_str, apdu->u.initRequest->implementationName);
1892 if (apdu->u.initRequest->implementationVersion)
1893 yaz_log(LOG_LOG, "%simplementationVersion: %s",
1894 m_session_str, apdu->u.initRequest->implementationVersion);
1895 if (m_initRequest_apdu == 0)
1897 if (m_initRequest_mem)
1898 nmem_destroy(m_initRequest_mem);
1899 m_initRequest_apdu = apdu;
1900 m_initRequest_mem = odr_extract_mem(odr_decode());
1902 // save init options for the response..
1903 m_initRequest_options = apdu->u.initRequest->options;
1905 apdu->u.initRequest->options =
1906 (Odr_bitmask *)nmem_malloc(m_initRequest_mem,
1907 sizeof(Odr_bitmask));
1908 ODR_MASK_ZERO(apdu->u.initRequest->options);
1910 for (i = 0; i<= 24; i++)
1911 ODR_MASK_SET(apdu->u.initRequest->options, i);
1912 ODR_MASK_CLEAR(apdu->u.initRequest->options,
1913 Z_Options_negotiationModel);
1916 m_initRequest_version = apdu->u.initRequest->protocolVersion;
1917 apdu->u.initRequest->protocolVersion =
1918 (Odr_bitmask *)nmem_malloc(m_initRequest_mem,
1919 sizeof(Odr_bitmask));
1920 ODR_MASK_ZERO(apdu->u.initRequest->protocolVersion);
1922 for (i = 0; i<= 8; i++)
1923 ODR_MASK_SET(apdu->u.initRequest->protocolVersion, i);
1925 if (m_client->m_init_flag)
1927 if (handle_init_response_for_invalid_session(apdu))
1929 Z_APDU *apdu2 = m_client->m_initResponse;
1930 apdu2->u.initResponse->otherInfo = 0;
1931 if (m_client->m_cookie && *m_client->m_cookie)
1932 set_otherInformationString(apdu2, VAL_COOKIE, 1,
1933 m_client->m_cookie);
1934 apdu2->u.initResponse->referenceId =
1935 apdu->u.initRequest->referenceId;
1936 apdu2->u.initResponse->options = m_client->m_initResponse_options;
1937 apdu2->u.initResponse->protocolVersion =
1938 m_client->m_initResponse_version;
1940 send_to_client(apdu2);
1943 m_client->m_init_flag = 1;
1945 handle_max_record_retrieve(apdu);
1948 apdu = handle_syntax_validation(apdu);
1951 apdu = handle_query_transformation(apdu);
1954 apdu = handle_query_validation(apdu);
1957 apdu = result_set_optimize(apdu);
1960 m_client->timeout(m_target_idletime); // mark it active even
1961 // though we didn't use it
1965 // delete other info part from PDU before sending to target
1966 get_otherInfoAPDU(apdu, &oi);
1970 if (apdu->which == Z_APDU_presentRequest &&
1971 m_client->m_resultSetStartPoint == 0)
1973 Z_PresentRequest *pr = apdu->u.presentRequest;
1974 m_client->m_resultSetStartPoint = *pr->resultSetStartPoint;
1975 m_client->m_cache.copy_presentRequest(apdu->u.presentRequest);
1977 m_client->m_resultSetStartPoint = 0;
1979 if (m_client->send_to_target(apdu) < 0)
1986 m_client->m_waiting = 1;
1989 void Yaz_Proxy::connectNotify()
1993 void Yaz_Proxy::shutdown()
1995 m_invalid_session = 0;
1996 // only keep if keep_alive flag is set...
1998 m_client->m_pdu_recv < m_keepalive_limit_pdu &&
1999 m_client->m_bytes_recv+m_client->m_bytes_sent < m_keepalive_limit_bw &&
2000 m_client->m_waiting == 0)
2002 yaz_log(LOG_LOG, "%sShutdown (client to proxy) keepalive %s",
2004 m_client->get_hostname());
2005 yaz_log(LOG_LOG, "%sbw=%d pdu=%d limit-bw=%d limit-pdu=%d",
2006 m_session_str, m_client->m_pdu_recv,
2007 m_client->m_bytes_sent + m_client->m_bytes_recv,
2008 m_keepalive_limit_bw, m_keepalive_limit_pdu);
2009 assert (m_client->m_waiting != 2);
2010 // Tell client (if any) that no server connection is there..
2011 m_client->m_server = 0;
2012 m_invalid_session = 0;
2016 yaz_log (LOG_LOG, "%sShutdown (client to proxy) close %s",
2018 m_client->get_hostname());
2019 assert (m_client->m_waiting != 2);
2024 yaz_log (LOG_LOG, "%sshutdown (client to proxy) bad state",
2030 yaz_log (LOG_LOG, "%sShutdown (client to proxy)",
2034 m_parent->pre_init();
2038 const char *Yaz_ProxyClient::get_session_str()
2042 return m_server->get_session_str();
2045 void Yaz_ProxyClient::shutdown()
2047 yaz_log (LOG_LOG, "%sShutdown (proxy to target) %s", get_session_str(),
2053 void Yaz_Proxy::failNotify()
2056 yaz_log (LOG_LOG, "%sConnection closed by client",
2061 void Yaz_ProxyClient::failNotify()
2064 m_server->inc_request_no();
2065 yaz_log (LOG_LOG, "%sConnection closed by target %s",
2066 get_session_str(), get_hostname());
2070 void Yaz_ProxyClient::connectNotify()
2072 const char *s = get_session_str();
2073 const char *h = get_hostname();
2074 yaz_log (LOG_LOG, "%sConnection accepted by %s timeout=%d", s, h,
2076 timeout(m_target_idletime);
2081 IYaz_PDU_Observer *Yaz_ProxyClient::sessionNotify(IYaz_PDU_Observable
2082 *the_PDU_Observable, int fd)
2084 return new Yaz_ProxyClient(the_PDU_Observable, 0);
2087 Yaz_ProxyClient::~Yaz_ProxyClient()
2092 m_next->m_prev = m_prev;
2093 m_waiting = 2; // for debugging purposes only.
2094 odr_destroy(m_init_odr);
2095 delete m_last_query;
2096 xfree (m_last_resultSetId);
2100 void Yaz_ProxyClient::pre_init_client()
2102 Z_APDU *apdu = create_Z_PDU(Z_APDU_initRequest);
2103 Z_InitRequest *req = apdu->u.initRequest;
2106 for (i = 0; i<= 24; i++)
2107 ODR_MASK_SET(req->options, i);
2108 ODR_MASK_CLEAR(apdu->u.initRequest->options,
2109 Z_Options_negotiationModel);
2110 for (i = 0; i<= 10; i++)
2111 ODR_MASK_SET(req->protocolVersion, i);
2113 if (send_to_target(apdu) < 0)
2124 void Yaz_Proxy::pre_init()
2127 const char *name = 0;
2128 const char *zurl_in_use[MAX_ZURL_PLEX];
2129 int limit_bw, limit_pdu, limit_req;
2130 int target_idletime, client_idletime;
2132 int keepalive_limit_bw, keepalive_limit_pdu;
2134 const char *cql2rpn = 0;
2136 Yaz_ProxyConfig *cfg = check_reconfigure();
2140 if (m_log_mask & PROXY_LOG_APDU_CLIENT)
2145 for (i = 0; cfg && cfg->get_target_no(i, &name, zurl_in_use,
2146 &limit_bw, &limit_pdu, &limit_req,
2147 &target_idletime, &client_idletime,
2149 &keepalive_limit_bw,
2150 &keepalive_limit_pdu,
2157 for (j = 0; zurl_in_use[j]; j++)
2163 for (c = m_clientPool; c; c = c->m_next)
2165 if (!strcmp(zurl_in_use[j], c->get_hostname()))
2167 if (c->m_cookie == 0)
2169 if (c->m_server == 0)
2178 yaz_log(LOG_LOG, "%spre-init %s %s use=%d other=%d spare=%d "
2179 "preinit=%d",m_session_str,
2180 name, zurl_in_use[j], in_use, other, spare, pre_init);
2181 if (spare < pre_init)
2183 c = new Yaz_ProxyClient(m_PDU_Observable->clone(), this);
2184 c->m_next = m_clientPool;
2186 c->m_next->m_prev = &c->m_next;
2188 c->m_prev = &m_clientPool;
2190 if (m_log_mask & PROXY_LOG_APDU_SERVER)
2191 c->set_APDU_yazlog(1);
2193 c->set_APDU_yazlog(0);
2195 if (c->client(zurl_in_use[j]))
2203 c->m_target_idletime = target_idletime;
2204 c->m_seqno = m_seqno++;
2211 void Yaz_Proxy::timeoutNotify()
2217 timeout(m_client_idletime);
2218 Z_GDU *apdu = m_bw_hold_PDU;
2221 if (apdu->which == Z_GDU_Z3950)
2222 handle_incoming_Z_PDU(apdu->u.z3950);
2223 else if (apdu->which == Z_GDU_HTTP_Request)
2224 handle_incoming_HTTP(apdu->u.HTTP_Request);
2230 yaz_log (LOG_LOG, "%sTimeout (client to proxy)", m_session_str);
2241 void Yaz_Proxy::markInvalid()
2244 m_invalid_session = 1;
2247 void Yaz_ProxyClient::timeoutNotify()
2250 m_server->inc_request_no();
2252 yaz_log (LOG_LOG, "%sTimeout (proxy to target) %s", get_session_str(),
2256 if (m_server && m_init_flag)
2258 // target timed out in a session that was properly initialized
2259 // server object stay alive but we mark it as invalid so it
2260 // gets initialized again
2261 m_server->markInvalid();
2267 Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable,
2268 Yaz_Proxy *parent) :
2269 Yaz_Z_Assoc (the_PDU_Observable)
2276 m_last_resultSetId = 0;
2277 m_last_resultCount = 0;
2281 m_init_odr = odr_createmem (ODR_DECODE);
2283 m_initResponse_options = 0;
2284 m_initResponse_version = 0;
2285 m_resultSetStartPoint = 0;
2286 m_bytes_sent = m_bytes_recv = 0;
2290 m_target_idletime = 600;
2294 const char *Yaz_Proxy::option(const char *name, const char *value)
2296 if (!strcmp (name, "optimize")) {
2299 m_optimize = xstrdup (value);
2306 void Yaz_ProxyClient::recv_HTTP_response(Z_HTTP_Response *apdu, int len)
2311 void Yaz_ProxyClient::recv_GDU(Z_GDU *apdu, int len)
2313 if (apdu->which == Z_GDU_Z3950)
2314 recv_Z_PDU(apdu->u.z3950, len);
2315 else if (apdu->which == Z_GDU_HTTP_Response)
2316 recv_HTTP_response(apdu->u.HTTP_Response, len);
2321 int Yaz_Proxy::handle_init_response_for_invalid_session(Z_APDU *apdu)
2323 if (!m_invalid_session)
2325 m_invalid_session = 0;
2326 handle_incoming_Z_PDU(m_apdu_invalid_session);
2327 assert (m_mem_invalid_session);
2328 nmem_destroy(m_mem_invalid_session);
2329 m_mem_invalid_session = 0;
2333 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu, int len)
2335 m_bytes_recv += len;
2338 if (m_root->get_log_mask() & PROXY_LOG_REQ_SERVER)
2339 yaz_log (LOG_LOG, "%sReceiving %s from %s %d bytes", get_session_str(),
2340 apdu_name(apdu), get_hostname(), len);
2341 if (apdu->which == Z_APDU_initResponse)
2343 if (!m_server) // if this is a pre init session , check for more
2345 NMEM nmem = odr_extract_mem (odr_decode());
2346 odr_reset (m_init_odr);
2347 nmem_transfer (m_init_odr->mem, nmem);
2348 m_initResponse = apdu;
2349 m_initResponse_options = apdu->u.initResponse->options;
2350 m_initResponse_version = apdu->u.initResponse->protocolVersion;
2352 Z_InitResponse *ir = apdu->u.initResponse;
2353 char *im0 = ir->implementationName;
2356 odr_malloc(m_init_odr, 20 + (im0 ? strlen(im0) : 0));
2363 strcat(im1, "(YAZ Proxy)");
2364 ir->implementationName = im1;
2366 nmem_destroy (nmem);
2368 if (m_server && m_server->handle_init_response_for_invalid_session(apdu))
2371 if (apdu->which == Z_APDU_searchResponse)
2373 Z_SearchResponse *sr = apdu->u.searchResponse;
2374 m_last_resultCount = *sr->resultCount;
2375 int status = *sr->searchStatus;
2376 if (status && (!sr->records || sr->records->which == Z_Records_DBOSD))
2380 if (sr->records && sr->records->which == Z_Records_DBOSD)
2382 m_cache.add(odr_decode(),
2383 sr->records->u.databaseOrSurDiagnostics, 1,
2388 if (apdu->which == Z_APDU_presentResponse)
2390 Z_PresentResponse *pr = apdu->u.presentResponse;
2394 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
2395 Z_SearchResponse *sr = new_apdu->u.searchResponse;
2396 sr->referenceId = pr->referenceId;
2397 *sr->resultCount = m_last_resultCount;
2398 sr->records = pr->records;
2399 sr->nextResultSetPosition = pr->nextResultSetPosition;
2400 sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
2404 pr->records->which == Z_Records_DBOSD && m_resultSetStartPoint)
2406 m_cache.add(odr_decode(),
2407 pr->records->u.databaseOrSurDiagnostics,
2408 m_resultSetStartPoint, -1);
2409 m_resultSetStartPoint = 0;
2413 set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
2416 m_server->send_to_client(apdu);
2418 if (apdu->which == Z_APDU_close)
2424 int Yaz_Proxy::server(const char *addr)
2426 int r = Yaz_Z_Assoc::server(addr);
2429 yaz_log(LOG_LOG, "%sStarted proxy " VERSION " on %s", m_session_str, addr);