2 * Copyright (c) 1998-2004, Index Data.
3 * See the file LICENSE for details.
5 * $Id: yaz-proxy.cpp,v 1.87 2004-01-12 21:02:42 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_apdu_invalid_session = 0;
115 m_mem_invalid_session = 0;
117 m_s2z_odr_search = 0;
119 m_s2z_search_apdu = 0;
120 m_s2z_present_apdu = 0;
121 m_http_keepalive = 0;
124 m_s2z_packing = Z_SRW_recordPacking_string;
125 m_time_tv.tv_sec = 0;
126 m_time_tv.tv_usec = 0;
129 Yaz_Proxy::~Yaz_Proxy()
131 yaz_log(LOG_LOG, "%sClosed %d/%d sent/recv bytes total", m_session_str,
132 m_bytes_sent, m_bytes_recv);
133 nmem_destroy(m_initRequest_mem);
134 nmem_destroy(m_mem_invalid_session);
135 xfree (m_proxyTarget);
136 xfree (m_default_target);
137 xfree (m_proxy_authentication);
139 xfree (m_stylesheet_schema);
142 odr_destroy(m_s2z_odr_init);
143 if (m_s2z_odr_search)
144 odr_destroy(m_s2z_odr_search);
148 int Yaz_Proxy::set_config(const char *config)
151 m_config = new Yaz_ProxyConfig();
152 xfree(m_config_fname);
153 m_config_fname = xstrdup(config);
154 int r = m_config->read_xml(config);
156 m_config->get_generic_info(&m_log_mask, &m_max_clients);
160 void Yaz_Proxy::set_default_target(const char *target)
162 xfree (m_default_target);
163 m_default_target = 0;
165 m_default_target = (char *) xstrdup (target);
168 void Yaz_Proxy::set_proxy_authentication (const char *auth)
170 xfree (m_proxy_authentication);
171 m_proxy_authentication = 0;
173 m_proxy_authentication = (char *) xstrdup (auth);
176 Yaz_ProxyConfig *Yaz_Proxy::check_reconfigure()
179 return m_parent->check_reconfigure();
181 Yaz_ProxyConfig *cfg = m_config;
184 yaz_log(LOG_LOG, "reconfigure");
186 if (m_config_fname && cfg)
188 yaz_log(LOG_LOG, "reconfigure config %s", m_config_fname);
189 int r = cfg->read_xml(m_config_fname);
191 yaz_log(LOG_WARN, "reconfigure failed");
195 cfg->get_generic_info(&m_log_mask, &m_max_clients);
199 yaz_log(LOG_LOG, "reconfigure");
205 IYaz_PDU_Observer *Yaz_Proxy::sessionNotify(IYaz_PDU_Observable
206 *the_PDU_Observable, int fd)
209 Yaz_Proxy *new_proxy = new Yaz_Proxy(the_PDU_Observable, this);
210 new_proxy->m_config = 0;
211 new_proxy->m_config_fname = 0;
212 new_proxy->timeout(m_client_idletime);
213 new_proxy->m_target_idletime = m_target_idletime;
214 new_proxy->set_default_target(m_default_target);
215 new_proxy->m_max_clients = m_max_clients;
216 new_proxy->m_log_mask = m_log_mask;
217 new_proxy->set_APDU_log(get_APDU_log());
218 if (m_log_mask & PROXY_LOG_APDU_CLIENT)
219 new_proxy->set_APDU_yazlog(1);
221 new_proxy->set_APDU_yazlog(0);
222 new_proxy->set_proxy_authentication(m_proxy_authentication);
223 sprintf(new_proxy->m_session_str, "%ld:%d ", (long) time(0), m_session_no);
225 yaz_log (LOG_LOG, "%sNew session %s", new_proxy->m_session_str,
226 the_PDU_Observable->getpeername());
230 char *Yaz_Proxy::get_cookie(Z_OtherInformation **otherInfo)
233 Z_OtherInformationUnit *oi;
235 ent.proto = PROTO_Z3950;
236 ent.oclass = CLASS_USERINFO;
237 ent.value = (oid_value) VAL_COOKIE;
238 assert (oid_ent_to_oid (&ent, oid));
240 if (oid_ent_to_oid (&ent, oid) &&
241 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
242 oi->which == Z_OtherInfo_characterInfo)
243 return oi->information.characterInfo;
247 char *Yaz_Proxy::get_proxy(Z_OtherInformation **otherInfo)
250 Z_OtherInformationUnit *oi;
252 ent.proto = PROTO_Z3950;
253 ent.oclass = CLASS_USERINFO;
254 ent.value = (oid_value) VAL_PROXY;
255 if (oid_ent_to_oid (&ent, oid) &&
256 (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
257 oi->which == Z_OtherInfo_characterInfo)
258 return oi->information.characterInfo;
262 const char *Yaz_Proxy::load_balance(const char **url)
264 int zurl_in_use[MAX_ZURL_PLEX];
268 for (i = 0; i<MAX_ZURL_PLEX; i++)
270 for (c = m_parent->m_clientPool; c; c = c->m_next)
272 for (i = 0; url[i]; i++)
273 if (!strcmp(url[i], c->get_hostname()))
278 for (i = 0; url[i]; i++)
280 yaz_log(LOG_DEBUG, "%szurl=%s use=%d",
281 m_session_str, url[i], zurl_in_use[i]);
282 if (min > zurl_in_use[i])
285 min = zurl_in_use[i];
291 Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu, const char *cookie,
292 const char *proxy_host)
295 Yaz_Proxy *parent = m_parent;
296 Yaz_ProxyClient *c = m_client;
300 const char *url[MAX_ZURL_PLEX];
301 Yaz_ProxyConfig *cfg = check_reconfigure();
305 /* only to be enabled for debugging... */
306 if (!strcmp(proxy_host, "stop"))
309 xfree(m_default_target);
310 m_default_target = xstrdup(proxy_host);
311 proxy_host = m_default_target;
313 int client_idletime = -1;
314 const char *cql2rpn_fname = 0;
315 url[0] = m_default_target;
320 cfg->get_target_info(proxy_host, url, &m_bw_max,
321 &m_pdu_max, &m_max_record_retrieve,
322 &m_target_idletime, &client_idletime,
323 &parent->m_max_clients,
324 &m_keepalive_limit_bw,
325 &m_keepalive_limit_pdu,
329 if (client_idletime != -1)
331 m_client_idletime = client_idletime;
332 timeout(m_client_idletime);
335 m_cql2rpn.set_pqf_file(cql2rpn_fname);
338 yaz_log(LOG_LOG, "%sNo default target", m_session_str);
341 // we don't handle multiplexing for cookie session, so we just
342 // pick the first one in this case (anonymous users will be able
343 // to use any backend)
344 if (cookie && *cookie)
345 m_proxyTarget = (char*) xstrdup(url[0]);
347 m_proxyTarget = (char*) xstrdup(load_balance(url));
349 if (cookie && *cookie)
350 { // search in sessions with a cookie
351 for (c = parent->m_clientPool; c; c = c->m_next)
354 assert (*c->m_prev == c);
355 if (c->m_cookie && !strcmp(cookie,c->m_cookie) &&
356 !strcmp(m_proxyTarget, c->get_hostname()))
359 // The following handles "cancel"
360 // If connection is busy (waiting for PDU) and
361 // we have an initRequest we can safely do re-open
362 if (c->m_waiting && apdu->which == Z_APDU_initRequest)
364 yaz_log (LOG_LOG, "%s REOPEN target=%s", m_session_str,
371 c->m_last_resultCount = 0;
372 c->m_sr_transform = 0;
374 c->m_resultSetStartPoint = 0;
375 c->m_target_idletime = m_target_idletime;
376 if (c->client(m_proxyTarget))
383 c->m_seqno = parent->m_seqno;
384 if (c->m_server && c->m_server != this)
385 c->m_server->m_client = 0;
388 yaz_log (LOG_DEBUG, "get_client 1 %p %p", this, c);
395 // don't have a client session yet. Search in session w/o cookie
396 for (c = parent->m_clientPool; c; c = c->m_next)
399 assert (*c->m_prev == c);
400 if (c->m_server == 0 && c->m_cookie == 0 &&
402 !strcmp(m_proxyTarget, c->get_hostname()))
405 yaz_log (LOG_LOG, "%sREUSE %s",
406 m_session_str, c->get_hostname());
408 c->m_seqno = parent->m_seqno;
409 assert(c->m_server == 0);
412 if (parent->m_log_mask & PROXY_LOG_APDU_SERVER)
413 c->set_APDU_yazlog(1);
415 c->set_APDU_yazlog(0);
427 if (apdu->which != Z_APDU_initRequest)
429 yaz_log (LOG_LOG, "no first INIT!");
432 Z_InitRequest *initRequest = apdu->u.initRequest;
434 if (!initRequest->idAuthentication)
436 if (m_proxy_authentication)
438 initRequest->idAuthentication =
439 (Z_IdAuthentication *)
440 odr_malloc (odr_encode(),
441 sizeof(*initRequest->idAuthentication));
442 initRequest->idAuthentication->which =
443 Z_IdAuthentication_open;
444 initRequest->idAuthentication->u.open =
445 odr_strdup (odr_encode(), m_proxy_authentication);
449 // go through list of clients - and find the lowest/oldest one.
450 Yaz_ProxyClient *c_min = 0;
452 int no_of_clients = 0;
453 if (parent->m_clientPool)
454 yaz_log (LOG_DEBUG, "Existing sessions");
455 for (c = parent->m_clientPool; c; c = c->m_next)
457 yaz_log (LOG_DEBUG, " Session %-3d wait=%d %s cookie=%s", c->m_seqno,
458 c->m_waiting, c->get_hostname(),
459 c->m_cookie ? c->m_cookie : "");
461 if (min_seq < 0 || c->m_seqno < min_seq)
463 min_seq = c->m_seqno;
467 if (no_of_clients >= parent->m_max_clients)
470 if (c->m_waiting || strcmp(m_proxyTarget, c->get_hostname()))
472 yaz_log (LOG_LOG, "%sMAXCLIENTS Destroy %d",
473 m_session_str, c->m_seqno);
474 if (c->m_server && c->m_server != this)
480 yaz_log (LOG_LOG, "%sMAXCLIENTS Reuse %d %d %s",
482 c->m_seqno, parent->m_seqno, c->get_hostname());
486 c->m_cookie = xstrdup(cookie);
487 c->m_seqno = parent->m_seqno;
488 if (c->m_server && c->m_server != this)
490 c->m_server->m_client = 0;
494 c->m_target_idletime = m_target_idletime;
495 c->timeout(m_target_idletime);
497 if (parent->m_log_mask & PROXY_LOG_APDU_SERVER)
498 c->set_APDU_yazlog(1);
500 c->set_APDU_yazlog(0);
507 yaz_log (LOG_LOG, "%sNEW %d %s",
508 m_session_str, parent->m_seqno, m_proxyTarget);
509 c = new Yaz_ProxyClient(m_PDU_Observable->clone(), parent);
510 c->m_next = parent->m_clientPool;
512 c->m_next->m_prev = &c->m_next;
513 parent->m_clientPool = c;
514 c->m_prev = &parent->m_clientPool;
520 c->m_cookie = xstrdup(cookie);
522 c->m_seqno = parent->m_seqno;
524 c->m_last_resultCount = 0;
527 c->m_sr_transform = 0;
529 c->m_resultSetStartPoint = 0;
531 if (c->client(m_proxyTarget))
536 c->m_target_idletime = m_target_idletime;
539 if (parent->m_log_mask & PROXY_LOG_APDU_SERVER)
540 c->set_APDU_yazlog(1);
542 c->set_APDU_yazlog(0);
544 yaz_log (LOG_DEBUG, "get_client 3 %p %p", this, c);
548 void Yaz_Proxy::display_diagrecs(Z_DiagRec **pp, int num)
551 for (i = 0; i<num; i++)
554 Z_DefaultDiagFormat *r;
555 Z_DiagRec *p = pp[i];
556 if (p->which != Z_DiagRec_defaultFormat)
558 yaz_log(LOG_LOG, "%sError no diagnostics", m_session_str);
562 r = p->u.defaultFormat;
563 if (!(ent = oid_getentbyoid(r->diagnosticSetId)) ||
564 ent->oclass != CLASS_DIAGSET || ent->value != VAL_BIB1)
565 yaz_log(LOG_LOG, "%sError unknown diagnostic set", m_session_str);
568 case Z_DefaultDiagFormat_v2Addinfo:
569 yaz_log(LOG_LOG, "%sError %d %s:%s",
571 *r->condition, diagbib1_str(*r->condition),
574 case Z_DefaultDiagFormat_v3Addinfo:
575 yaz_log(LOG_LOG, "%sError %d %s:%s",
577 *r->condition, diagbib1_str(*r->condition),
584 void Yaz_Proxy::convert_xsl(Z_NamePlusRecordList *p)
586 if (!m_stylesheet_schema)
588 xsltStylesheetPtr xsp;
590 xsp = xsltParseStylesheetFile((const xmlChar *) m_stylesheet_schema);
593 for (i = 0; i < p->num_records; i++)
595 Z_NamePlusRecord *npr = p->records[i];
596 if (npr->which == Z_NamePlusRecord_databaseRecord)
598 Z_External *r = npr->u.databaseRecord;
599 if (r->which == Z_External_octet)
601 xmlDocPtr res, doc = xmlParseMemory(
602 (char*) r->u.octet_aligned->buf,
603 r->u.octet_aligned->len);
605 res = xsltApplyStylesheet(xsp, doc, 0);
609 xmlDocDumpMemory (res, &out_buf, &out_len);
610 p->records[i]->u.databaseRecord =
611 z_ext_record(odr_encode(), VAL_TEXT_XML,
612 (char*) out_buf, out_len);
619 xsltFreeStylesheet(xsp);
622 void Yaz_Proxy::convert_to_marcxml(Z_NamePlusRecordList *p)
626 yaz_marc_t mt = yaz_marc_create();
627 yaz_marc_xml(mt, YAZ_MARC_MARCXML);
628 for (i = 0; i < p->num_records; i++)
630 Z_NamePlusRecord *npr = p->records[i];
631 if (npr->which == Z_NamePlusRecord_databaseRecord)
633 Z_External *r = npr->u.databaseRecord;
634 if (r->which == Z_External_octet)
638 if (yaz_marc_decode_buf(mt, (char*) r->u.octet_aligned->buf,
639 r->u.octet_aligned->len,
642 yaz_iconv_t cd = yaz_iconv_open("UTF-8", "MARC-8");
643 WRBUF wrbuf = wrbuf_alloc();
646 size_t inbytesleft = rlen;
647 const char *inp = result;
648 while (cd && inbytesleft)
650 size_t outbytesleft = sizeof(outbuf);
654 r = yaz_iconv (cd, (char**) &inp,
656 &outp, &outbytesleft);
657 if (r == (size_t) (-1))
659 int e = yaz_iconv_error(cd);
660 if (e != YAZ_ICONV_E2BIG)
662 yaz_log(LOG_WARN, "conversion failure");
666 wrbuf_write(wrbuf, outbuf, outp - outbuf);
671 npr->u.databaseRecord = z_ext_record(odr_encode(),
675 wrbuf_free(wrbuf, 1);
680 yaz_marc_destroy(mt);
683 void Yaz_Proxy::logtime()
685 if (m_time_tv.tv_sec)
688 gettimeofday(&tv, 0);
689 long diff = (tv.tv_sec - m_time_tv.tv_sec)*1000000 +
690 (tv.tv_usec - m_time_tv.tv_usec);
692 yaz_log(LOG_LOG, "%sElapsed %ld.%03ld", m_session_str,
693 diff/1000000, (diff/1000)%1000);
695 m_time_tv.tv_sec = 0;
696 m_time_tv.tv_usec = 0;
699 int Yaz_Proxy::send_http_response(int code)
701 ODR o = odr_encode();
702 Z_GDU *gdu = z_get_HTTP_Response(o, code);
703 Z_HTTP_Response *hres = gdu->u.HTTP_Response;
705 hres->version = odr_strdup(o, m_http_version);
706 m_http_keepalive = 0;
707 if (m_log_mask & PROXY_LOG_REQ_CLIENT)
709 yaz_log (LOG_LOG, "%sSending %s to client", m_session_str,
713 int r = send_GDU(gdu, &len);
718 int Yaz_Proxy::send_srw_response(Z_SRW_PDU *srw_pdu)
720 ODR o = odr_encode();
721 const char *ctype = "text/xml";
722 Z_GDU *gdu = z_get_HTTP_Response(o, 200);
723 Z_HTTP_Response *hres = gdu->u.HTTP_Response;
725 hres->version = odr_strdup(o, m_http_version);
726 z_HTTP_header_add(o, &hres->headers, "Content-Type", ctype);
727 if (m_http_keepalive)
728 z_HTTP_header_add(o, &hres->headers, "Connection", "Keep-Alive");
730 static Z_SOAP_Handler soap_handlers[2] = {
732 {"http://www.loc.gov/zing/srw/", 0,
733 (Z_SOAP_fun) yaz_srw_codec},
738 Z_SOAP *soap_package = (Z_SOAP*) odr_malloc(o, sizeof(Z_SOAP));
739 soap_package->which = Z_SOAP_generic;
740 soap_package->u.generic =
741 (Z_SOAP_Generic *) odr_malloc(o, sizeof(*soap_package->u.generic));
742 soap_package->u.generic->no = 0;
743 soap_package->u.generic->ns = soap_handlers[0].ns;
744 soap_package->u.generic->p = (void *) srw_pdu;
745 soap_package->ns = m_soap_ns;
746 z_soap_codec_enc_xsl(o, &soap_package,
747 &hres->content_buf, &hres->content_len,
748 soap_handlers, 0, m_s2z_stylesheet);
749 if (m_log_mask & PROXY_LOG_REQ_CLIENT)
751 yaz_log (LOG_LOG, "%sSending %s to client", m_session_str,
755 int r = send_GDU(gdu, &len);
760 int Yaz_Proxy::send_to_srw_client_error(int srw_error, const char *add)
762 ODR o = odr_encode();
763 Z_SRW_PDU *srw_pdu = yaz_srw_get(o, Z_SRW_searchRetrieve_response);
764 Z_SRW_searchRetrieveResponse *srw_res = srw_pdu->u.response;
766 srw_res->num_diagnostics = 1;
767 srw_res->diagnostics = (Z_SRW_diagnostic *)
768 odr_malloc(o, sizeof(*srw_res->diagnostics));
769 srw_res->diagnostics[0].code = odr_intdup(o, srw_error);
770 srw_res->diagnostics[0].details = add ? odr_strdup(o, add) : 0;
771 return send_srw_response(srw_pdu);
774 int Yaz_Proxy::z_to_srw_diag(ODR o, Z_SRW_searchRetrieveResponse *srw_res,
775 Z_DefaultDiagFormat *ddf)
777 int bib1_code = *ddf->condition;
778 if (bib1_code == 109)
780 srw_res->num_diagnostics = 1;
781 srw_res->diagnostics = (Z_SRW_diagnostic *)
782 odr_malloc(o, sizeof(*srw_res->diagnostics));
783 srw_res->diagnostics[0].code =
784 odr_intdup(o, yaz_diag_bib1_to_srw(*ddf->condition));
785 srw_res->diagnostics[0].details = ddf->u.v2Addinfo;
789 int Yaz_Proxy::send_to_srw_client_ok(int hits, Z_Records *records, int start)
791 ODR o = odr_encode();
792 Z_SRW_PDU *srw_pdu = yaz_srw_get(o, Z_SRW_searchRetrieve_response);
793 Z_SRW_searchRetrieveResponse *srw_res = srw_pdu->u.response;
795 srw_res->numberOfRecords = odr_intdup (o, hits);
796 if (records && records->which == Z_Records_DBOSD)
798 srw_res->num_records =
799 records->u.databaseOrSurDiagnostics->num_records;
801 srw_res->records = (Z_SRW_record *)
802 odr_malloc(o, srw_res->num_records * sizeof(Z_SRW_record));
803 for (i = 0; i < srw_res->num_records; i++)
805 Z_NamePlusRecord *npr = records->u.databaseOrSurDiagnostics->records[i];
806 if (npr->which != Z_NamePlusRecord_databaseRecord)
808 srw_res->records[i].recordSchema = "diagnostic";
809 srw_res->records[i].recordPacking = m_s2z_packing;
810 srw_res->records[i].recordData_buf = "67";
811 srw_res->records[i].recordData_len = 2;
812 srw_res->records[i].recordPosition = odr_intdup(o, i+start);
815 Z_External *r = npr->u.databaseRecord;
816 oident *ent = oid_getentbyoid(r->direct_reference);
817 if (r->which == Z_External_octet && ent->value == VAL_TEXT_XML)
819 srw_res->records[i].recordSchema = m_schema;
820 srw_res->records[i].recordPacking = m_s2z_packing;
821 srw_res->records[i].recordData_buf = (char*)
822 r->u.octet_aligned->buf;
823 srw_res->records[i].recordData_len = r->u.octet_aligned->len;
824 srw_res->records[i].recordPosition = odr_intdup(o, i+start);
828 srw_res->records[i].recordSchema = "diagnostic";
829 srw_res->records[i].recordPacking = m_s2z_packing;
830 srw_res->records[i].recordData_buf = "67";
831 srw_res->records[i].recordData_len = 2;
832 srw_res->records[i].recordPosition = odr_intdup(o, i+start);
836 if (records && records->which == Z_Records_NSD)
839 http_code = z_to_srw_diag(odr_encode(), srw_res,
840 records->u.nonSurrogateDiagnostic);
842 return send_http_response(http_code);
844 return send_srw_response(srw_pdu);
848 int Yaz_Proxy::send_srw_explain_response(Z_SRW_diagnostic *diagnostics,
851 Z_SRW_PDU *res = yaz_srw_get(odr_encode(), Z_SRW_explain_response);
852 Z_SRW_explainResponse *er = res->u.explain_response;
854 Yaz_ProxyConfig *cfg = check_reconfigure();
858 char *b = cfg->get_explain(odr_encode(), 0 /* target */,
862 er->record.recordData_buf = b;
863 er->record.recordData_len = len;
864 er->record.recordPacking = m_s2z_packing;
867 er->diagnostics = diagnostics;
868 er->num_diagnostics = num_diagnostics;
869 return send_srw_response(res);
872 int Yaz_Proxy::send_PDU_convert(Z_APDU *apdu, int *len)
876 if (apdu->which == Z_APDU_initResponse)
878 Z_InitResponse *res = apdu->u.initResponse;
879 if (*res->result == 0)
881 send_to_srw_client_error(3, 0);
883 else if (!m_s2z_search_apdu)
885 send_srw_explain_response(0, 0);
889 handle_incoming_Z_PDU(m_s2z_search_apdu);
892 else if (m_s2z_search_apdu && apdu->which == Z_APDU_searchResponse)
894 m_s2z_search_apdu = 0;
895 Z_SearchResponse *res = apdu->u.searchResponse;
896 m_s2z_hit_count = *res->resultCount;
897 if (res->records && res->records->which == Z_Records_NSD)
899 send_to_srw_client_ok(0, res->records, 1);
901 else if (m_s2z_present_apdu)
904 Z_PresentRequest *pr = m_s2z_present_apdu->u.presentRequest;
906 if (*pr->resultSetStartPoint <= m_s2z_hit_count)
908 if (*pr->numberOfRecordsRequested+ *pr->resultSetStartPoint
910 *pr->numberOfRecordsRequested =
911 1 + m_s2z_hit_count - *pr->resultSetStartPoint;
913 handle_incoming_Z_PDU(m_s2z_present_apdu);
917 send_to_srw_client_ok(m_s2z_hit_count, res->records, 1);
920 else if (m_s2z_present_apdu && apdu->which == Z_APDU_presentResponse)
923 *m_s2z_present_apdu->u.presentRequest->resultSetStartPoint;
925 m_s2z_present_apdu = 0;
926 Z_PresentResponse *res = apdu->u.presentResponse;
927 send_to_srw_client_ok(m_s2z_hit_count, res->records, start);
932 if (m_log_mask & PROXY_LOG_REQ_CLIENT)
933 yaz_log (LOG_LOG, "%sSending %s to client", m_session_str,
935 int r = send_Z_PDU(apdu, len);
942 int Yaz_Proxy::send_to_client(Z_APDU *apdu)
945 int kill_session = 0;
946 if (apdu->which == Z_APDU_searchResponse)
948 Z_SearchResponse *sr = apdu->u.searchResponse;
949 Z_Records *p = sr->records;
950 if (p && p->which == Z_Records_NSD)
952 Z_DiagRec dr, *dr_p = &dr;
953 dr.which = Z_DiagRec_defaultFormat;
954 dr.u.defaultFormat = p->u.nonSurrogateDiagnostic;
956 *sr->searchStatus = 0;
957 display_diagrecs(&dr_p, 1);
961 if (p && p->which == Z_Records_DBOSD)
964 convert_to_marcxml(p->u.databaseOrSurDiagnostics);
965 convert_xsl(p->u.databaseOrSurDiagnostics);
969 yaz_log(LOG_LOG, "%s%d hits", m_session_str,
971 if (*sr->resultCount < 0)
973 m_invalid_session = 1;
976 *sr->searchStatus = 0;
978 create_nonSurrogateDiagnostics(odr_encode(), 2, 0);
979 *sr->resultCount = 0;
984 else if (apdu->which == Z_APDU_presentResponse)
986 Z_PresentResponse *sr = apdu->u.presentResponse;
987 Z_Records *p = sr->records;
988 if (p && p->which == Z_Records_NSD)
990 Z_DiagRec dr, *dr_p = &dr;
991 dr.which = Z_DiagRec_defaultFormat;
992 dr.u.defaultFormat = p->u.nonSurrogateDiagnostic;
993 if (*sr->presentStatus == Z_PresentStatus_success)
994 *sr->presentStatus = Z_PresentStatus_failure;
995 display_diagrecs(&dr_p, 1);
997 if (p && p->which == Z_Records_DBOSD)
1000 convert_to_marcxml(p->u.databaseOrSurDiagnostics);
1001 convert_xsl(p->u.databaseOrSurDiagnostics);
1004 int r = send_PDU_convert(apdu, &len);
1007 m_bytes_sent += len;
1008 m_bw_stat.add_bytes(len);
1013 m_parent->pre_init();
1017 if (!m_http_keepalive)
1030 int Yaz_ProxyClient::send_to_target(Z_APDU *apdu)
1033 const char *apdu_name_tmp = apdu_name(apdu);
1034 int r = send_Z_PDU(apdu, &len);
1035 if (m_root->get_log_mask() & PROXY_LOG_REQ_SERVER)
1036 yaz_log (LOG_LOG, "%sSending %s to %s %d bytes",
1038 apdu_name_tmp, get_hostname(), len);
1039 m_bytes_sent += len;
1043 Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
1045 if (apdu->which == Z_APDU_presentRequest)
1047 Z_PresentRequest *pr = apdu->u.presentRequest;
1048 int toget = *pr->numberOfRecordsRequested;
1049 int start = *pr->resultSetStartPoint;
1051 yaz_log(LOG_LOG, "%sPresent %s %d+%d", m_session_str,
1052 pr->resultSetId, start, toget);
1054 if (*m_parent->m_optimize == '0')
1057 if (!m_client->m_last_resultSetId)
1059 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1060 new_apdu->u.presentResponse->records =
1061 create_nonSurrogateDiagnostics(odr_encode(), 30,
1063 send_to_client(new_apdu);
1066 if (!strcmp(m_client->m_last_resultSetId, pr->resultSetId))
1068 if (start+toget-1 > m_client->m_last_resultCount)
1070 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1071 new_apdu->u.presentResponse->records =
1072 create_nonSurrogateDiagnostics(odr_encode(), 13, 0);
1073 send_to_client(new_apdu);
1076 Z_NamePlusRecordList *npr;
1077 if (m_client->m_cache.lookup (odr_encode(), &npr, start, toget,
1078 pr->preferredRecordSyntax,
1079 pr->recordComposition))
1081 yaz_log (LOG_LOG, "%sReturned cached records for present request",
1083 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1084 new_apdu->u.presentResponse->referenceId = pr->referenceId;
1086 new_apdu->u.presentResponse->numberOfRecordsReturned
1087 = odr_intdup(odr_encode(), toget);
1089 new_apdu->u.presentResponse->records = (Z_Records*)
1090 odr_malloc(odr_encode(), sizeof(Z_Records));
1091 new_apdu->u.presentResponse->records->which = Z_Records_DBOSD;
1092 new_apdu->u.presentResponse->records->u.databaseOrSurDiagnostics = npr;
1093 new_apdu->u.presentResponse->nextResultSetPosition =
1094 odr_intdup(odr_encode(), start+toget);
1096 send_to_client(new_apdu);
1102 if (apdu->which != Z_APDU_searchRequest)
1104 Z_SearchRequest *sr = apdu->u.searchRequest;
1105 Yaz_Z_Query *this_query = new Yaz_Z_Query;
1106 Yaz_Z_Databases this_databases;
1108 this_databases.set(sr->num_databaseNames, (const char **)
1111 this_query->set_Z_Query(sr->query);
1113 char query_str[120];
1114 this_query->print(query_str, sizeof(query_str)-1);
1115 yaz_log(LOG_LOG, "%sSearch %s", m_session_str, query_str);
1117 if (*m_parent->m_optimize != '0' &&
1118 m_client->m_last_ok && m_client->m_last_query &&
1119 m_client->m_last_query->match(this_query) &&
1120 !strcmp(m_client->m_last_resultSetId, sr->resultSetName) &&
1121 m_client->m_last_databases.match(this_databases))
1124 if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
1125 m_client->m_last_resultCount < *sr->largeSetLowerBound)
1127 Z_NamePlusRecordList *npr;
1128 int toget = *sr->mediumSetPresentNumber;
1129 Z_RecordComposition *comp = 0;
1131 if (toget > m_client->m_last_resultCount)
1132 toget = m_client->m_last_resultCount;
1134 if (sr->mediumSetElementSetNames)
1136 comp = (Z_RecordComposition *)
1137 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
1138 comp->which = Z_RecordComp_simple;
1139 comp->u.simple = sr->mediumSetElementSetNames;
1142 if (m_client->m_cache.lookup (odr_encode(), &npr, 1, toget,
1143 sr->preferredRecordSyntax, comp))
1145 yaz_log (LOG_LOG, "%sReturned cached records for medium set",
1147 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1148 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1149 new_apdu->u.searchResponse->resultCount =
1150 &m_client->m_last_resultCount;
1152 new_apdu->u.searchResponse->numberOfRecordsReturned
1153 = odr_intdup(odr_encode(), toget);
1155 new_apdu->u.searchResponse->presentStatus =
1156 odr_intdup(odr_encode(), Z_PresentStatus_success);
1157 new_apdu->u.searchResponse->records = (Z_Records*)
1158 odr_malloc(odr_encode(), sizeof(Z_Records));
1159 new_apdu->u.searchResponse->records->which = Z_Records_DBOSD;
1160 new_apdu->u.searchResponse->records->u.databaseOrSurDiagnostics = npr;
1161 new_apdu->u.searchResponse->nextResultSetPosition =
1162 odr_intdup(odr_encode(), toget+1);
1163 send_to_client(new_apdu);
1169 // send present request (medium size)
1170 yaz_log (LOG_LOG, "%sOptimizing search for medium set",
1173 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
1174 Z_PresentRequest *pr = new_apdu->u.presentRequest;
1175 pr->referenceId = sr->referenceId;
1176 pr->resultSetId = sr->resultSetName;
1177 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
1178 *pr->numberOfRecordsRequested = toget;
1179 pr->recordComposition = comp;
1180 m_client->m_sr_transform = 1;
1184 else if (m_client->m_last_resultCount >= *sr->largeSetLowerBound ||
1185 m_client->m_last_resultCount <= 0)
1187 // large set. Return pseudo-search response immediately
1188 yaz_log (LOG_LOG, "%sOptimizing search for large set",
1190 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1191 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1192 new_apdu->u.searchResponse->resultCount =
1193 &m_client->m_last_resultCount;
1194 send_to_client(new_apdu);
1199 Z_NamePlusRecordList *npr;
1200 int toget = m_client->m_last_resultCount;
1201 Z_RecordComposition *comp = 0;
1203 // send a present request (small set)
1205 if (sr->smallSetElementSetNames)
1207 comp = (Z_RecordComposition *)
1208 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
1209 comp->which = Z_RecordComp_simple;
1210 comp->u.simple = sr->smallSetElementSetNames;
1213 if (m_client->m_cache.lookup (odr_encode(), &npr, 1, toget,
1214 sr->preferredRecordSyntax, comp))
1216 yaz_log (LOG_LOG, "%sReturned cached records for small set",
1218 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1219 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1220 new_apdu->u.searchResponse->resultCount =
1221 &m_client->m_last_resultCount;
1223 new_apdu->u.searchResponse->numberOfRecordsReturned
1224 = odr_intdup(odr_encode(), toget);
1226 new_apdu->u.searchResponse->presentStatus =
1227 odr_intdup(odr_encode(), Z_PresentStatus_success);
1228 new_apdu->u.searchResponse->records = (Z_Records*)
1229 odr_malloc(odr_encode(), sizeof(Z_Records));
1230 new_apdu->u.searchResponse->records->which = Z_Records_DBOSD;
1231 new_apdu->u.searchResponse->records->u.databaseOrSurDiagnostics = npr;
1232 new_apdu->u.searchResponse->nextResultSetPosition =
1233 odr_intdup(odr_encode(), toget+1);
1234 send_to_client(new_apdu);
1239 yaz_log (LOG_LOG, "%sOptimizing search for small set",
1241 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
1242 Z_PresentRequest *pr = new_apdu->u.presentRequest;
1243 pr->referenceId = sr->referenceId;
1244 pr->resultSetId = sr->resultSetName;
1245 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
1246 *pr->numberOfRecordsRequested = toget;
1247 pr->recordComposition = comp;
1248 m_client->m_sr_transform = 1;
1253 else // query doesn't match
1255 delete m_client->m_last_query;
1256 m_client->m_last_query = this_query;
1257 m_client->m_last_ok = 0;
1258 m_client->m_cache.clear();
1259 m_client->m_resultSetStartPoint = 0;
1261 xfree (m_client->m_last_resultSetId);
1262 m_client->m_last_resultSetId = xstrdup (sr->resultSetName);
1264 m_client->m_last_databases.set(sr->num_databaseNames,
1265 (const char **) sr->databaseNames);
1271 void Yaz_Proxy::inc_request_no()
1273 char *cp = strchr(m_session_str, ' ');
1276 sprintf(cp+1, "%d ", m_request_no);
1279 void Yaz_Proxy::recv_GDU(Z_GDU *apdu, int len)
1283 m_bytes_recv += len;
1285 if (m_log_mask & PROXY_LOG_APDU_CLIENT)
1286 yaz_log (LOG_DEBUG, "%sReceiving %s from client %d bytes",
1287 m_session_str, gdu_name(apdu), len);
1289 if (m_bw_hold_PDU) // double incoming PDU. shutdown now.
1292 m_bw_stat.add_bytes(len);
1293 m_pdu_stat.add_bytes(1);
1295 gettimeofday(&m_time_tv, 0);
1297 int bw_total = m_bw_stat.get_total();
1298 int pdu_total = m_pdu_stat.get_total();
1303 if (bw_total > m_bw_max)
1305 reduce = (bw_total/m_bw_max);
1310 if (pdu_total > m_pdu_max)
1312 int nreduce = (m_pdu_max >= 60) ? 1 : 60/m_pdu_max;
1313 reduce = (reduce > nreduce) ? reduce : nreduce;
1318 yaz_log(LOG_LOG, "%sdelay=%d bw=%d pdu=%d limit-bw=%d limit-pdu=%d",
1319 m_session_str, reduce, bw_total, pdu_total,
1320 m_bw_max, m_pdu_max);
1322 m_bw_hold_PDU = apdu; // save PDU and signal "on hold"
1323 timeout(reduce); // call us reduce seconds later
1325 else if (apdu->which == Z_GDU_Z3950)
1326 handle_incoming_Z_PDU(apdu->u.z3950);
1327 else if (apdu->which == Z_GDU_HTTP_Request)
1328 handle_incoming_HTTP(apdu->u.HTTP_Request);
1331 void Yaz_Proxy::handle_max_record_retrieve(Z_APDU *apdu)
1333 if (m_max_record_retrieve)
1335 if (apdu->which == Z_APDU_presentRequest)
1337 Z_PresentRequest *pr = apdu->u.presentRequest;
1338 if (pr->numberOfRecordsRequested &&
1339 *pr->numberOfRecordsRequested > m_max_record_retrieve)
1340 *pr->numberOfRecordsRequested = m_max_record_retrieve;
1345 Z_Records *Yaz_Proxy::create_nonSurrogateDiagnostics(ODR odr,
1347 const char *addinfo)
1349 Z_Records *rec = (Z_Records *)
1350 odr_malloc (odr, sizeof(*rec));
1352 odr_malloc (odr, sizeof(*err));
1353 Z_DiagRec *drec = (Z_DiagRec *)
1354 odr_malloc (odr, sizeof(*drec));
1355 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1356 odr_malloc (odr, sizeof(*dr));
1358 rec->which = Z_Records_NSD;
1359 rec->u.nonSurrogateDiagnostic = dr;
1360 dr->diagnosticSetId =
1361 yaz_oidval_to_z3950oid (odr, CLASS_DIAGSET, VAL_BIB1);
1362 dr->condition = err;
1363 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1364 dr->u.v2Addinfo = odr_strdup (odr, addinfo ? addinfo : "");
1368 Z_APDU *Yaz_Proxy::handle_query_transformation(Z_APDU *apdu)
1370 if (apdu->which == Z_APDU_searchRequest &&
1371 apdu->u.searchRequest->query &&
1372 apdu->u.searchRequest->query->which == Z_Query_type_104 &&
1373 apdu->u.searchRequest->query->u.type_104->which == Z_External_CQL)
1375 Z_RPNQuery *rpnquery = 0;
1376 Z_SearchRequest *sr = apdu->u.searchRequest;
1379 yaz_log(LOG_LOG, "%sCQL: %s", m_session_str,
1380 sr->query->u.type_104->u.cql);
1382 int r = m_cql2rpn.query_transform(sr->query->u.type_104->u.cql,
1383 &rpnquery, odr_encode(),
1386 yaz_log(LOG_LOG, "%sNo CQL to RPN table", m_session_str);
1389 yaz_log(LOG_LOG, "%sCQL Conversion error %d", m_session_str, r);
1390 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1392 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1393 new_apdu->u.searchResponse->records =
1394 create_nonSurrogateDiagnostics(odr_encode(),
1395 yaz_diag_srw_to_bib1(r),
1397 *new_apdu->u.searchResponse->searchStatus = 0;
1399 send_to_client(new_apdu);
1405 sr->query->which = Z_Query_type_1;
1406 sr->query->u.type_1 = rpnquery;
1413 Z_APDU *Yaz_Proxy::handle_query_validation(Z_APDU *apdu)
1415 if (apdu->which == Z_APDU_searchRequest)
1417 Z_SearchRequest *sr = apdu->u.searchRequest;
1421 Yaz_ProxyConfig *cfg = check_reconfigure();
1423 err = cfg->check_query(odr_encode(), m_default_target,
1424 sr->query, &addinfo);
1427 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1429 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1430 new_apdu->u.searchResponse->records =
1431 create_nonSurrogateDiagnostics(odr_encode(), err, addinfo);
1432 *new_apdu->u.searchResponse->searchStatus = 0;
1434 send_to_client(new_apdu);
1442 Z_APDU *Yaz_Proxy::handle_syntax_validation(Z_APDU *apdu)
1445 if (apdu->which == Z_APDU_searchRequest)
1447 Z_SearchRequest *sr = apdu->u.searchRequest;
1450 Yaz_ProxyConfig *cfg = check_reconfigure();
1452 Z_RecordComposition rc_temp, *rc = 0;
1453 if (sr->smallSetElementSetNames)
1455 rc_temp.which = Z_RecordComp_simple;
1456 rc_temp.u.simple = sr->smallSetElementSetNames;
1461 err = cfg->check_syntax(odr_encode(),
1463 sr->preferredRecordSyntax, rc,
1464 &addinfo, &m_stylesheet_schema, &m_schema);
1467 sr->preferredRecordSyntax =
1468 yaz_oidval_to_z3950oid(odr_encode(), CLASS_RECSYN, VAL_USMARC);
1473 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1475 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1476 new_apdu->u.searchResponse->records =
1477 create_nonSurrogateDiagnostics(odr_encode(), err, addinfo);
1478 *new_apdu->u.searchResponse->searchStatus = 0;
1480 send_to_client(new_apdu);
1485 else if (apdu->which == Z_APDU_presentRequest)
1487 Z_PresentRequest *pr = apdu->u.presentRequest;
1490 Yaz_ProxyConfig *cfg = check_reconfigure();
1493 err = cfg->check_syntax(odr_encode(), m_default_target,
1494 pr->preferredRecordSyntax,
1495 pr->recordComposition,
1496 &addinfo, &m_stylesheet_schema, &m_schema);
1499 pr->preferredRecordSyntax =
1500 yaz_oidval_to_z3950oid(odr_decode(), CLASS_RECSYN, VAL_USMARC);
1505 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1507 new_apdu->u.presentResponse->referenceId = pr->referenceId;
1508 new_apdu->u.presentResponse->records =
1509 create_nonSurrogateDiagnostics(odr_encode(), err, addinfo);
1510 *new_apdu->u.presentResponse->presentStatus =
1511 Z_PresentStatus_failure;
1513 send_to_client(new_apdu);
1521 Z_ElementSetNames *Yaz_Proxy::mk_esn_from_schema(ODR o, const char *schema)
1525 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1526 odr_malloc(o, sizeof(Z_ElementSetNames));
1527 esn->which = Z_ElementSetNames_generic;
1528 esn->u.generic = odr_strdup(o, schema);
1532 void Yaz_Proxy::handle_incoming_HTTP(Z_HTTP_Request *hreq)
1537 odr_destroy(m_s2z_odr_init);
1540 if (m_s2z_odr_search)
1542 odr_destroy(m_s2z_odr_search);
1543 m_s2z_odr_search = 0;
1546 m_http_keepalive = 0;
1548 if (!strcmp(hreq->version, "1.0"))
1550 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1551 if (v && !strcmp(v, "Keep-Alive"))
1552 m_http_keepalive = 1;
1554 m_http_keepalive = 0;
1555 m_http_version = "1.0";
1559 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1560 if (v && !strcmp(v, "close"))
1561 m_http_keepalive = 0;
1563 m_http_keepalive = 1;
1564 m_http_version = "1.1";
1567 Z_SRW_PDU *srw_pdu = 0;
1568 Z_SOAP *soap_package = 0;
1570 Z_SRW_diagnostic *diagnostic = 0;
1571 int num_diagnostic = 0;
1572 if (yaz_srw_decode(hreq, &srw_pdu, &soap_package, odr_decode(),
1574 || yaz_sru_decode(hreq, &srw_pdu, &soap_package, odr_decode(),
1575 &charset, &diagnostic, &num_diagnostic) == 0)
1577 m_s2z_odr_init = odr_createmem(ODR_ENCODE);
1578 m_s2z_odr_search = odr_createmem(ODR_ENCODE);
1579 m_soap_ns = odr_strdup(m_s2z_odr_search, soap_package->ns);
1580 m_s2z_init_apdu = 0;
1581 m_s2z_search_apdu = 0;
1582 m_s2z_present_apdu = 0;
1584 m_s2z_stylesheet = 0;
1586 if (srw_pdu->which == Z_SRW_searchRetrieve_request)
1588 Z_SRW_searchRetrieveRequest *srw_req = srw_pdu->u.request;
1590 // recordXPath unsupported.
1591 if (srw_req->recordXPath)
1593 yaz_add_srw_diagnostic(odr_decode(),
1594 &diagnostic, &num_diagnostic,
1597 // must have a query
1598 if (!srw_req->query.cql)
1600 yaz_add_srw_diagnostic(odr_decode(),
1601 &diagnostic, &num_diagnostic,
1605 if (srw_req->sort_type != Z_SRW_sort_type_none)
1607 yaz_add_srw_diagnostic(odr_decode(),
1608 &diagnostic, &num_diagnostic,
1612 if (srw_req->stylesheet)
1614 odr_strdup(m_s2z_odr_init, srw_req->stylesheet);
1616 // set packing for response records ..
1617 if (srw_req->recordPacking &&
1618 !strcmp(srw_req->recordPacking, "xml"))
1619 m_s2z_packing = Z_SRW_recordPacking_XML;
1621 m_s2z_packing = Z_SRW_recordPacking_string;
1625 Z_SRW_PDU *srw_pdu =
1626 yaz_srw_get(odr_encode(),
1627 Z_SRW_searchRetrieve_response);
1628 Z_SRW_searchRetrieveResponse *srw_res = srw_pdu->u.response;
1630 srw_res->diagnostics = diagnostic;
1631 srw_res->num_diagnostics = num_diagnostic;
1632 send_srw_response(srw_pdu);
1636 // prepare search PDU
1637 m_s2z_search_apdu = zget_APDU(m_s2z_odr_search,
1638 Z_APDU_searchRequest);
1639 Z_SearchRequest *z_searchRequest =
1640 m_s2z_search_apdu->u.searchRequest;
1642 z_searchRequest->num_databaseNames = 1;
1643 z_searchRequest->databaseNames = (char**)
1644 odr_malloc(m_s2z_odr_search, sizeof(char *));
1645 z_searchRequest->databaseNames[0] = odr_strdup(m_s2z_odr_search,
1648 // query transformation
1649 Z_Query *query = (Z_Query *)
1650 odr_malloc(m_s2z_odr_search, sizeof(Z_Query));
1651 z_searchRequest->query = query;
1653 if (srw_req->query_type == Z_SRW_query_type_cql)
1655 Z_External *ext = (Z_External *)
1656 odr_malloc(m_s2z_odr_search, sizeof(*ext));
1657 ext->direct_reference =
1658 odr_getoidbystr(m_s2z_odr_search, "1.2.840.10003.16.2");
1659 ext->indirect_reference = 0;
1660 ext->descriptor = 0;
1661 ext->which = Z_External_CQL;
1662 ext->u.cql = srw_req->query.cql;
1664 query->which = Z_Query_type_104;
1665 query->u.type_104 = ext;
1667 else if (srw_req->query_type == Z_SRW_query_type_pqf)
1669 Z_RPNQuery *RPNquery;
1670 YAZ_PQF_Parser pqf_parser;
1672 pqf_parser = yaz_pqf_create ();
1674 RPNquery = yaz_pqf_parse (pqf_parser, m_s2z_odr_search,
1675 srw_req->query.pqf);
1678 const char *pqf_msg;
1680 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
1681 yaz_log(LOG_LOG, "%*s^\n", off+4, "");
1682 yaz_log(LOG_LOG, "Bad PQF: %s (code %d)\n", pqf_msg, code);
1684 send_to_srw_client_error(10, 0);
1687 query->which = Z_Query_type_1;
1688 query->u.type_1 = RPNquery;
1690 yaz_pqf_destroy (pqf_parser);
1694 send_to_srw_client_error(7, "query");
1699 m_s2z_present_apdu = 0;
1701 if (srw_req->maximumRecords)
1702 max = *srw_req->maximumRecords;
1704 if (srw_req->startRecord)
1705 start = *srw_req->startRecord;
1708 // Some backend, such as Voyager doesn't honor piggyback
1709 // So we use present always (0 &&).
1710 if (0 && start <= 1) // Z39.50 piggyback
1712 *z_searchRequest->smallSetUpperBound = max;
1713 *z_searchRequest->mediumSetPresentNumber = max;
1714 *z_searchRequest->largeSetLowerBound = 2000000000; // 2e9
1716 z_searchRequest->preferredRecordSyntax =
1717 yaz_oidval_to_z3950oid(m_s2z_odr_search, CLASS_RECSYN,
1719 if (srw_req->recordSchema)
1721 z_searchRequest->smallSetElementSetNames =
1722 z_searchRequest->mediumSetElementSetNames =
1723 mk_esn_from_schema(m_s2z_odr_search,
1724 srw_req->recordSchema);
1727 else // Z39.50 present
1729 m_s2z_present_apdu = zget_APDU(m_s2z_odr_search,
1730 Z_APDU_presentRequest);
1731 Z_PresentRequest *z_presentRequest =
1732 m_s2z_present_apdu->u.presentRequest;
1733 *z_presentRequest->resultSetStartPoint = start;
1734 *z_presentRequest->numberOfRecordsRequested = max;
1735 z_presentRequest->preferredRecordSyntax =
1736 yaz_oidval_to_z3950oid(m_s2z_odr_search, CLASS_RECSYN,
1738 z_presentRequest->recordComposition =
1739 (Z_RecordComposition *)
1740 odr_malloc(m_s2z_odr_search,
1741 sizeof(Z_RecordComposition));
1742 if (srw_req->recordSchema)
1744 z_presentRequest->recordComposition->which =
1745 Z_RecordComp_simple;
1746 z_presentRequest->recordComposition->u.simple =
1747 mk_esn_from_schema(m_s2z_odr_search,
1748 srw_req->recordSchema);
1754 m_s2z_init_apdu = zget_APDU(m_s2z_odr_init,
1755 Z_APDU_initRequest);
1757 // prevent m_initRequest_apdu memory from being grabbed
1758 // in Yaz_Proxy::handle_incoming_Z_PDU
1759 m_initRequest_apdu = m_s2z_init_apdu;
1760 handle_incoming_Z_PDU(m_s2z_init_apdu);
1765 handle_incoming_Z_PDU(m_s2z_search_apdu);
1769 else if (srw_pdu->which == Z_SRW_explain_request)
1771 Z_SRW_explainRequest *srw_req = srw_pdu->u.explain_request;
1774 if (srw_req->stylesheet)
1776 odr_strdup(m_s2z_odr_init, srw_req->stylesheet);
1778 if (srw_req->recordPacking &&
1779 !strcmp(srw_req->recordPacking, "xml"))
1780 m_s2z_packing = Z_SRW_recordPacking_XML;
1782 m_s2z_packing = Z_SRW_recordPacking_string;
1786 send_srw_explain_response(diagnostic, num_diagnostic);
1792 m_s2z_init_apdu = zget_APDU(m_s2z_odr_init,
1793 Z_APDU_initRequest);
1795 // prevent m_initRequest_apdu memory from being grabbed
1796 // in Yaz_Proxy::handle_incoming_Z_PDU
1797 m_initRequest_apdu = m_s2z_init_apdu;
1798 handle_incoming_Z_PDU(m_s2z_init_apdu);
1801 send_srw_explain_response(0, 0);
1804 else if (srw_pdu->which == Z_SRW_scan_request)
1806 yaz_add_srw_diagnostic(odr_decode(),
1807 &diagnostic, &num_diagnostic,
1809 Z_SRW_PDU *srw_pdu =
1810 yaz_srw_get(odr_encode(),
1811 Z_SRW_scan_response);
1812 Z_SRW_scanResponse *srw_res = srw_pdu->u.scan_response;
1814 srw_res->diagnostics = diagnostic;
1815 srw_res->num_diagnostics = num_diagnostic;
1816 send_srw_response(srw_pdu);
1821 send_to_srw_client_error(4, 0);
1825 Z_GDU *p = z_get_HTTP_Response(odr_encode(), 400);
1830 void Yaz_Proxy::handle_incoming_Z_PDU(Z_APDU *apdu)
1832 if (!m_client && m_invalid_session)
1834 m_apdu_invalid_session = apdu;
1835 m_mem_invalid_session = odr_extract_mem(odr_decode());
1836 apdu = m_initRequest_apdu;
1839 // Determine our client.
1840 Z_OtherInformation **oi;
1841 get_otherInfoAPDU(apdu, &oi);
1842 m_client = get_client(apdu, get_cookie(oi), get_proxy(oi));
1848 m_client->m_server = this;
1850 if (apdu->which == Z_APDU_initRequest)
1852 if (apdu->u.initRequest->implementationId)
1853 yaz_log(LOG_LOG, "%simplementationId: %s",
1854 m_session_str, apdu->u.initRequest->implementationId);
1855 if (apdu->u.initRequest->implementationName)
1856 yaz_log(LOG_LOG, "%simplementationName: %s",
1857 m_session_str, apdu->u.initRequest->implementationName);
1858 if (apdu->u.initRequest->implementationVersion)
1859 yaz_log(LOG_LOG, "%simplementationVersion: %s",
1860 m_session_str, apdu->u.initRequest->implementationVersion);
1861 if (m_initRequest_apdu == 0)
1863 if (m_initRequest_mem)
1864 nmem_destroy(m_initRequest_mem);
1865 m_initRequest_apdu = apdu;
1866 m_initRequest_mem = odr_extract_mem(odr_decode());
1868 if (m_client->m_init_flag)
1870 if (handle_init_response_for_invalid_session(apdu))
1872 Z_APDU *apdu2 = m_client->m_initResponse;
1873 apdu2->u.initResponse->otherInfo = 0;
1874 if (m_client->m_cookie && *m_client->m_cookie)
1875 set_otherInformationString(apdu2, VAL_COOKIE, 1,
1876 m_client->m_cookie);
1877 apdu2->u.initResponse->referenceId =
1878 apdu->u.initRequest->referenceId;
1879 send_to_client(apdu2);
1882 m_client->m_init_flag = 1;
1884 handle_max_record_retrieve(apdu);
1887 apdu = handle_syntax_validation(apdu);
1890 apdu = handle_query_transformation(apdu);
1893 apdu = handle_query_validation(apdu);
1896 apdu = result_set_optimize(apdu);
1899 m_client->timeout(m_target_idletime); // mark it active even
1900 // though we didn't use it
1904 // delete other info part from PDU before sending to target
1905 get_otherInfoAPDU(apdu, &oi);
1909 if (apdu->which == Z_APDU_presentRequest &&
1910 m_client->m_resultSetStartPoint == 0)
1912 Z_PresentRequest *pr = apdu->u.presentRequest;
1913 m_client->m_resultSetStartPoint = *pr->resultSetStartPoint;
1914 m_client->m_cache.copy_presentRequest(apdu->u.presentRequest);
1916 m_client->m_resultSetStartPoint = 0;
1918 if (m_client->send_to_target(apdu) < 0)
1925 m_client->m_waiting = 1;
1928 void Yaz_Proxy::connectNotify()
1932 void Yaz_Proxy::shutdown()
1934 m_invalid_session = 0;
1935 // only keep if keep_alive flag is set...
1937 m_client->m_pdu_recv < m_keepalive_limit_pdu &&
1938 m_client->m_bytes_recv+m_client->m_bytes_sent < m_keepalive_limit_bw &&
1939 m_client->m_waiting == 0)
1941 yaz_log(LOG_LOG, "%sShutdown (client to proxy) keepalive %s",
1943 m_client->get_hostname());
1944 yaz_log(LOG_LOG, "%sbw=%d pdu=%d limit-bw=%d limit-pdu=%d",
1945 m_session_str, m_client->m_pdu_recv,
1946 m_client->m_bytes_sent + m_client->m_bytes_recv,
1947 m_keepalive_limit_bw, m_keepalive_limit_pdu);
1948 assert (m_client->m_waiting != 2);
1949 // Tell client (if any) that no server connection is there..
1950 m_client->m_server = 0;
1951 m_invalid_session = 0;
1955 yaz_log (LOG_LOG, "%sShutdown (client to proxy) close %s",
1957 m_client->get_hostname());
1958 assert (m_client->m_waiting != 2);
1963 yaz_log (LOG_LOG, "%sshutdown (client to proxy) bad state",
1969 yaz_log (LOG_LOG, "%sShutdown (client to proxy)",
1973 m_parent->pre_init();
1977 const char *Yaz_ProxyClient::get_session_str()
1981 return m_server->get_session_str();
1984 void Yaz_ProxyClient::shutdown()
1986 yaz_log (LOG_LOG, "%sShutdown (proxy to target) %s", get_session_str(),
1992 void Yaz_Proxy::failNotify()
1995 yaz_log (LOG_LOG, "%sConnection closed by client",
2000 void Yaz_ProxyClient::failNotify()
2003 m_server->inc_request_no();
2004 yaz_log (LOG_LOG, "%sConnection closed by target %s",
2005 get_session_str(), get_hostname());
2009 void Yaz_ProxyClient::connectNotify()
2011 const char *s = get_session_str();
2012 const char *h = get_hostname();
2013 yaz_log (LOG_LOG, "%sConnection accepted by %s timeout=%d", s, h,
2015 timeout(m_target_idletime);
2020 IYaz_PDU_Observer *Yaz_ProxyClient::sessionNotify(IYaz_PDU_Observable
2021 *the_PDU_Observable, int fd)
2023 return new Yaz_ProxyClient(the_PDU_Observable, 0);
2026 Yaz_ProxyClient::~Yaz_ProxyClient()
2031 m_next->m_prev = m_prev;
2032 m_waiting = 2; // for debugging purposes only.
2033 odr_destroy(m_init_odr);
2034 delete m_last_query;
2035 xfree (m_last_resultSetId);
2039 void Yaz_ProxyClient::pre_init_client()
2041 Z_APDU *apdu = create_Z_PDU(Z_APDU_initRequest);
2042 Z_InitRequest *req = apdu->u.initRequest;
2044 ODR_MASK_SET(req->options, Z_Options_search);
2045 ODR_MASK_SET(req->options, Z_Options_present);
2046 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
2047 ODR_MASK_SET(req->options, Z_Options_triggerResourceCtrl);
2048 ODR_MASK_SET(req->options, Z_Options_scan);
2049 ODR_MASK_SET(req->options, Z_Options_sort);
2050 ODR_MASK_SET(req->options, Z_Options_extendedServices);
2051 ODR_MASK_SET(req->options, Z_Options_delSet);
2053 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
2054 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
2055 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
2057 if (send_to_target(apdu) < 0)
2068 void Yaz_Proxy::pre_init()
2071 const char *name = 0;
2072 const char *zurl_in_use[MAX_ZURL_PLEX];
2073 int limit_bw, limit_pdu, limit_req;
2074 int target_idletime, client_idletime;
2076 int keepalive_limit_bw, keepalive_limit_pdu;
2078 const char *cql2rpn = 0;
2080 Yaz_ProxyConfig *cfg = check_reconfigure();
2084 if (m_log_mask & PROXY_LOG_APDU_CLIENT)
2089 for (i = 0; cfg && cfg->get_target_no(i, &name, zurl_in_use,
2090 &limit_bw, &limit_pdu, &limit_req,
2091 &target_idletime, &client_idletime,
2093 &keepalive_limit_bw,
2094 &keepalive_limit_pdu,
2101 for (j = 0; zurl_in_use[j]; j++)
2107 for (c = m_clientPool; c; c = c->m_next)
2109 if (!strcmp(zurl_in_use[j], c->get_hostname()))
2111 if (c->m_cookie == 0)
2113 if (c->m_server == 0)
2122 yaz_log(LOG_LOG, "%spre-init %s %s use=%d other=%d spare=%d "
2123 "preinit=%d",m_session_str,
2124 name, zurl_in_use[j], in_use, other, spare, pre_init);
2125 if (spare < pre_init)
2127 c = new Yaz_ProxyClient(m_PDU_Observable->clone(), this);
2128 c->m_next = m_clientPool;
2130 c->m_next->m_prev = &c->m_next;
2132 c->m_prev = &m_clientPool;
2134 if (m_log_mask & PROXY_LOG_APDU_SERVER)
2135 c->set_APDU_yazlog(1);
2137 c->set_APDU_yazlog(0);
2139 if (c->client(zurl_in_use[j]))
2147 c->m_target_idletime = target_idletime;
2148 c->m_seqno = m_seqno++;
2155 void Yaz_Proxy::timeoutNotify()
2161 timeout(m_client_idletime);
2162 Z_GDU *apdu = m_bw_hold_PDU;
2165 if (apdu->which == Z_GDU_Z3950)
2166 handle_incoming_Z_PDU(apdu->u.z3950);
2167 else if (apdu->which == Z_GDU_HTTP_Request)
2168 handle_incoming_HTTP(apdu->u.HTTP_Request);
2174 yaz_log (LOG_LOG, "%sTimeout (client to proxy)", m_session_str);
2185 void Yaz_ProxyClient::timeoutNotify()
2188 m_server->inc_request_no();
2190 yaz_log (LOG_LOG, "%sTimeout (proxy to target) %s", get_session_str(),
2197 Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable,
2198 Yaz_Proxy *parent) :
2199 Yaz_Z_Assoc (the_PDU_Observable)
2206 m_last_resultSetId = 0;
2207 m_last_resultCount = 0;
2211 m_init_odr = odr_createmem (ODR_DECODE);
2213 m_resultSetStartPoint = 0;
2214 m_bytes_sent = m_bytes_recv = 0;
2218 m_target_idletime = 600;
2222 const char *Yaz_Proxy::option(const char *name, const char *value)
2224 if (!strcmp (name, "optimize")) {
2227 m_optimize = xstrdup (value);
2234 void Yaz_ProxyClient::recv_HTTP_response(Z_HTTP_Response *apdu, int len)
2239 void Yaz_ProxyClient::recv_GDU(Z_GDU *apdu, int len)
2241 if (apdu->which == Z_GDU_Z3950)
2242 recv_Z_PDU(apdu->u.z3950, len);
2243 else if (apdu->which == Z_GDU_HTTP_Response)
2244 recv_HTTP_response(apdu->u.HTTP_Response, len);
2249 int Yaz_Proxy::handle_init_response_for_invalid_session(Z_APDU *apdu)
2251 if (!m_invalid_session)
2253 m_invalid_session = 0;
2254 handle_incoming_Z_PDU(m_apdu_invalid_session);
2255 assert (m_mem_invalid_session);
2256 nmem_destroy(m_mem_invalid_session);
2257 m_mem_invalid_session = 0;
2261 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu, int len)
2263 m_bytes_recv += len;
2266 if (m_root->get_log_mask() & PROXY_LOG_REQ_SERVER)
2267 yaz_log (LOG_LOG, "%sReceiving %s from %s %d bytes", get_session_str(),
2268 apdu_name(apdu), get_hostname(), len);
2269 if (apdu->which == Z_APDU_initResponse)
2271 if (!m_server) // if this is a pre init session , check for more
2273 NMEM nmem = odr_extract_mem (odr_decode());
2274 odr_reset (m_init_odr);
2275 nmem_transfer (m_init_odr->mem, nmem);
2276 m_initResponse = apdu;
2278 Z_InitResponse *ir = apdu->u.initResponse;
2279 char *im0 = ir->implementationName;
2282 odr_malloc(m_init_odr, 20 + (im0 ? strlen(im0) : 0));
2289 strcat(im1, "(YAZ Proxy)");
2290 ir->implementationName = im1;
2292 nmem_destroy (nmem);
2294 if (m_server && m_server->handle_init_response_for_invalid_session(apdu))
2297 if (apdu->which == Z_APDU_searchResponse)
2299 Z_SearchResponse *sr = apdu->u.searchResponse;
2300 m_last_resultCount = *sr->resultCount;
2301 int status = *sr->searchStatus;
2302 if (status && (!sr->records || sr->records->which == Z_Records_DBOSD))
2306 if (sr->records && sr->records->which == Z_Records_DBOSD)
2308 m_cache.add(odr_decode(),
2309 sr->records->u.databaseOrSurDiagnostics, 1,
2314 if (apdu->which == Z_APDU_presentResponse)
2316 Z_PresentResponse *pr = apdu->u.presentResponse;
2320 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
2321 Z_SearchResponse *sr = new_apdu->u.searchResponse;
2322 sr->referenceId = pr->referenceId;
2323 *sr->resultCount = m_last_resultCount;
2324 sr->records = pr->records;
2325 sr->nextResultSetPosition = pr->nextResultSetPosition;
2326 sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
2330 pr->records->which == Z_Records_DBOSD && m_resultSetStartPoint)
2332 m_cache.add(odr_decode(),
2333 pr->records->u.databaseOrSurDiagnostics,
2334 m_resultSetStartPoint, -1);
2335 m_resultSetStartPoint = 0;
2339 set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
2342 m_server->send_to_client(apdu);
2344 if (apdu->which == Z_APDU_close)
2350 int Yaz_Proxy::server(const char *addr)
2352 int r = Yaz_Z_Assoc::server(addr);
2355 yaz_log(LOG_LOG, "%sStarted proxy " VERSION " on %s", m_session_str, addr);