2 * Copyright (c) 1998-2004, Index Data.
3 * See the file LICENSE for details.
5 * $Id: yaz-proxy.cpp,v 1.83 2004-01-07 22:19:05 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 xmlDocPtr xslt_doc = xmlParseFile(m_stylesheet_schema);
589 xsltStylesheetPtr xsp;
591 xsp = xsltParseStylesheetDoc(xslt_doc);
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 xmlDocDumpMemory (res, &out_buf, &out_len);
611 p->records[i]->u.databaseRecord =
612 z_ext_record(odr_encode(), VAL_TEXT_XML,
613 (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)
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 = 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()
850 Z_SRW_PDU *res = yaz_srw_get(odr_encode(), Z_SRW_explain_response);
851 Z_SRW_explainResponse *er = res->u.explain_response;
853 Yaz_ProxyConfig *cfg = check_reconfigure();
857 assert (m_proxyTarget);
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 return send_srw_response(res);
870 int Yaz_Proxy::send_PDU_convert(Z_APDU *apdu, int *len)
874 if (apdu->which == Z_APDU_initResponse)
876 Z_InitResponse *res = apdu->u.initResponse;
877 if (*res->result == 0)
879 send_to_srw_client_error(3);
881 else if (!m_s2z_search_apdu)
887 handle_incoming_Z_PDU(m_s2z_search_apdu);
890 else if (m_s2z_search_apdu && apdu->which == Z_APDU_searchResponse)
892 m_s2z_search_apdu = 0;
893 Z_SearchResponse *res = apdu->u.searchResponse;
894 m_s2z_hit_count = *res->resultCount;
895 if (res->records && res->records->which == Z_Records_NSD)
897 send_to_srw_client_ok(0, res->records, 1);
899 else if (m_s2z_present_apdu)
901 handle_incoming_Z_PDU(m_s2z_present_apdu);
905 send_to_srw_client_ok(m_s2z_hit_count, res->records, 1);
908 else if (m_s2z_present_apdu && apdu->which == Z_APDU_presentResponse)
911 *m_s2z_present_apdu->u.presentRequest->resultSetStartPoint;
913 m_s2z_present_apdu = 0;
914 Z_PresentResponse *res = apdu->u.presentResponse;
915 send_to_srw_client_ok(m_s2z_hit_count, res->records, start);
920 if (m_log_mask & PROXY_LOG_REQ_CLIENT)
921 yaz_log (LOG_LOG, "%sSending %s to client", m_session_str,
923 int r = send_Z_PDU(apdu, len);
930 int Yaz_Proxy::send_to_client(Z_APDU *apdu)
933 int kill_session = 0;
934 if (apdu->which == Z_APDU_searchResponse)
936 Z_SearchResponse *sr = apdu->u.searchResponse;
937 Z_Records *p = sr->records;
938 if (p && p->which == Z_Records_NSD)
940 Z_DiagRec dr, *dr_p = &dr;
941 dr.which = Z_DiagRec_defaultFormat;
942 dr.u.defaultFormat = p->u.nonSurrogateDiagnostic;
944 *sr->searchStatus = 0;
945 display_diagrecs(&dr_p, 1);
949 if (p && p->which == Z_Records_DBOSD)
952 convert_to_marcxml(p->u.databaseOrSurDiagnostics);
953 convert_xsl(p->u.databaseOrSurDiagnostics);
957 yaz_log(LOG_LOG, "%s%d hits", m_session_str,
959 if (*sr->resultCount < 0)
961 m_invalid_session = 1;
964 *sr->searchStatus = 0;
966 create_nonSurrogateDiagnostics(odr_encode(), 2, 0);
967 *sr->resultCount = 0;
972 else if (apdu->which == Z_APDU_presentResponse)
974 Z_PresentResponse *sr = apdu->u.presentResponse;
975 Z_Records *p = sr->records;
976 if (p && p->which == Z_Records_NSD)
978 Z_DiagRec dr, *dr_p = &dr;
979 dr.which = Z_DiagRec_defaultFormat;
980 dr.u.defaultFormat = p->u.nonSurrogateDiagnostic;
981 if (*sr->presentStatus == Z_PresentStatus_success)
982 *sr->presentStatus = Z_PresentStatus_failure;
983 display_diagrecs(&dr_p, 1);
985 if (p && p->which == Z_Records_DBOSD)
988 convert_to_marcxml(p->u.databaseOrSurDiagnostics);
989 convert_xsl(p->u.databaseOrSurDiagnostics);
992 int r = send_PDU_convert(apdu, &len);
996 m_bw_stat.add_bytes(len);
1001 m_parent->pre_init();
1005 if (!m_http_keepalive)
1018 int Yaz_ProxyClient::send_to_target(Z_APDU *apdu)
1021 const char *apdu_name_tmp = apdu_name(apdu);
1022 int r = send_Z_PDU(apdu, &len);
1023 if (m_root->get_log_mask() & PROXY_LOG_REQ_SERVER)
1024 yaz_log (LOG_LOG, "%sSending %s to %s %d bytes",
1026 apdu_name_tmp, get_hostname(), len);
1027 m_bytes_sent += len;
1031 Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
1033 if (apdu->which == Z_APDU_presentRequest)
1035 Z_PresentRequest *pr = apdu->u.presentRequest;
1036 int toget = *pr->numberOfRecordsRequested;
1037 int start = *pr->resultSetStartPoint;
1039 yaz_log(LOG_LOG, "%sPresent %s %d+%d", m_session_str,
1040 pr->resultSetId, start, toget);
1042 if (*m_parent->m_optimize == '0')
1045 if (!m_client->m_last_resultSetId)
1047 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1048 new_apdu->u.presentResponse->records =
1049 create_nonSurrogateDiagnostics(odr_encode(), 30,
1051 send_to_client(new_apdu);
1054 if (!strcmp(m_client->m_last_resultSetId, pr->resultSetId))
1056 if (start+toget-1 > m_client->m_last_resultCount)
1058 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1059 new_apdu->u.presentResponse->records =
1060 create_nonSurrogateDiagnostics(odr_encode(), 13, 0);
1061 send_to_client(new_apdu);
1064 Z_NamePlusRecordList *npr;
1065 if (m_client->m_cache.lookup (odr_encode(), &npr, start, toget,
1066 pr->preferredRecordSyntax,
1067 pr->recordComposition))
1069 yaz_log (LOG_LOG, "%sReturned cached records for present request",
1071 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1072 new_apdu->u.presentResponse->referenceId = pr->referenceId;
1074 new_apdu->u.presentResponse->numberOfRecordsReturned
1075 = odr_intdup(odr_encode(), toget);
1077 new_apdu->u.presentResponse->records = (Z_Records*)
1078 odr_malloc(odr_encode(), sizeof(Z_Records));
1079 new_apdu->u.presentResponse->records->which = Z_Records_DBOSD;
1080 new_apdu->u.presentResponse->records->u.databaseOrSurDiagnostics = npr;
1081 new_apdu->u.presentResponse->nextResultSetPosition =
1082 odr_intdup(odr_encode(), start+toget);
1084 send_to_client(new_apdu);
1090 if (apdu->which != Z_APDU_searchRequest)
1092 Z_SearchRequest *sr = apdu->u.searchRequest;
1093 Yaz_Z_Query *this_query = new Yaz_Z_Query;
1094 Yaz_Z_Databases this_databases;
1096 this_databases.set(sr->num_databaseNames, (const char **)
1099 this_query->set_Z_Query(sr->query);
1101 char query_str[120];
1102 this_query->print(query_str, sizeof(query_str)-1);
1103 yaz_log(LOG_LOG, "%sSearch %s", m_session_str, query_str);
1105 if (*m_parent->m_optimize != '0' &&
1106 m_client->m_last_ok && m_client->m_last_query &&
1107 m_client->m_last_query->match(this_query) &&
1108 !strcmp(m_client->m_last_resultSetId, sr->resultSetName) &&
1109 m_client->m_last_databases.match(this_databases))
1112 if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
1113 m_client->m_last_resultCount < *sr->largeSetLowerBound)
1115 Z_NamePlusRecordList *npr;
1116 int toget = *sr->mediumSetPresentNumber;
1117 Z_RecordComposition *comp = 0;
1119 if (toget > m_client->m_last_resultCount)
1120 toget = m_client->m_last_resultCount;
1122 if (sr->mediumSetElementSetNames)
1124 comp = (Z_RecordComposition *)
1125 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
1126 comp->which = Z_RecordComp_simple;
1127 comp->u.simple = sr->mediumSetElementSetNames;
1130 if (m_client->m_cache.lookup (odr_encode(), &npr, 1, toget,
1131 sr->preferredRecordSyntax, comp))
1133 yaz_log (LOG_LOG, "%sReturned cached records for medium set",
1135 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1136 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1137 new_apdu->u.searchResponse->resultCount =
1138 &m_client->m_last_resultCount;
1140 new_apdu->u.searchResponse->numberOfRecordsReturned
1141 = odr_intdup(odr_encode(), toget);
1143 new_apdu->u.searchResponse->presentStatus =
1144 odr_intdup(odr_encode(), Z_PresentStatus_success);
1145 new_apdu->u.searchResponse->records = (Z_Records*)
1146 odr_malloc(odr_encode(), sizeof(Z_Records));
1147 new_apdu->u.searchResponse->records->which = Z_Records_DBOSD;
1148 new_apdu->u.searchResponse->records->u.databaseOrSurDiagnostics = npr;
1149 new_apdu->u.searchResponse->nextResultSetPosition =
1150 odr_intdup(odr_encode(), toget+1);
1151 send_to_client(new_apdu);
1157 // send present request (medium size)
1158 yaz_log (LOG_LOG, "%sOptimizing search for medium set",
1161 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
1162 Z_PresentRequest *pr = new_apdu->u.presentRequest;
1163 pr->referenceId = sr->referenceId;
1164 pr->resultSetId = sr->resultSetName;
1165 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
1166 *pr->numberOfRecordsRequested = toget;
1167 pr->recordComposition = comp;
1168 m_client->m_sr_transform = 1;
1172 else if (m_client->m_last_resultCount >= *sr->largeSetLowerBound ||
1173 m_client->m_last_resultCount <= 0)
1175 // large set. Return pseudo-search response immediately
1176 yaz_log (LOG_LOG, "%sOptimizing search for large set",
1178 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1179 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1180 new_apdu->u.searchResponse->resultCount =
1181 &m_client->m_last_resultCount;
1182 send_to_client(new_apdu);
1187 Z_NamePlusRecordList *npr;
1188 int toget = m_client->m_last_resultCount;
1189 Z_RecordComposition *comp = 0;
1191 // send a present request (small set)
1193 if (sr->smallSetElementSetNames)
1195 comp = (Z_RecordComposition *)
1196 odr_malloc(odr_encode(), sizeof(Z_RecordComposition));
1197 comp->which = Z_RecordComp_simple;
1198 comp->u.simple = sr->smallSetElementSetNames;
1201 if (m_client->m_cache.lookup (odr_encode(), &npr, 1, toget,
1202 sr->preferredRecordSyntax, comp))
1204 yaz_log (LOG_LOG, "%sReturned cached records for small set",
1206 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1207 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1208 new_apdu->u.searchResponse->resultCount =
1209 &m_client->m_last_resultCount;
1211 new_apdu->u.searchResponse->numberOfRecordsReturned
1212 = odr_intdup(odr_encode(), toget);
1214 new_apdu->u.searchResponse->presentStatus =
1215 odr_intdup(odr_encode(), Z_PresentStatus_success);
1216 new_apdu->u.searchResponse->records = (Z_Records*)
1217 odr_malloc(odr_encode(), sizeof(Z_Records));
1218 new_apdu->u.searchResponse->records->which = Z_Records_DBOSD;
1219 new_apdu->u.searchResponse->records->u.databaseOrSurDiagnostics = npr;
1220 new_apdu->u.searchResponse->nextResultSetPosition =
1221 odr_intdup(odr_encode(), toget+1);
1222 send_to_client(new_apdu);
1227 yaz_log (LOG_LOG, "%sOptimizing search for small set",
1229 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
1230 Z_PresentRequest *pr = new_apdu->u.presentRequest;
1231 pr->referenceId = sr->referenceId;
1232 pr->resultSetId = sr->resultSetName;
1233 pr->preferredRecordSyntax = sr->preferredRecordSyntax;
1234 *pr->numberOfRecordsRequested = toget;
1235 pr->recordComposition = comp;
1236 m_client->m_sr_transform = 1;
1241 else // query doesn't match
1243 delete m_client->m_last_query;
1244 m_client->m_last_query = this_query;
1245 m_client->m_last_ok = 0;
1246 m_client->m_cache.clear();
1247 m_client->m_resultSetStartPoint = 0;
1249 xfree (m_client->m_last_resultSetId);
1250 m_client->m_last_resultSetId = xstrdup (sr->resultSetName);
1252 m_client->m_last_databases.set(sr->num_databaseNames,
1253 (const char **) sr->databaseNames);
1259 void Yaz_Proxy::inc_request_no()
1261 char *cp = strchr(m_session_str, ' ');
1264 sprintf(cp+1, "%d ", m_request_no);
1267 void Yaz_Proxy::recv_GDU(Z_GDU *apdu, int len)
1271 m_bytes_recv += len;
1273 if (m_log_mask & PROXY_LOG_APDU_CLIENT)
1274 yaz_log (LOG_DEBUG, "%sReceiving %s from client %d bytes",
1275 m_session_str, gdu_name(apdu), len);
1277 if (m_bw_hold_PDU) // double incoming PDU. shutdown now.
1280 m_bw_stat.add_bytes(len);
1281 m_pdu_stat.add_bytes(1);
1283 gettimeofday(&m_time_tv, 0);
1285 int bw_total = m_bw_stat.get_total();
1286 int pdu_total = m_pdu_stat.get_total();
1291 if (bw_total > m_bw_max)
1293 reduce = (bw_total/m_bw_max);
1298 if (pdu_total > m_pdu_max)
1300 int nreduce = (m_pdu_max >= 60) ? 1 : 60/m_pdu_max;
1301 reduce = (reduce > nreduce) ? reduce : nreduce;
1306 yaz_log(LOG_LOG, "%sdelay=%d bw=%d pdu=%d limit-bw=%d limit-pdu=%d",
1307 m_session_str, reduce, bw_total, pdu_total,
1308 m_bw_max, m_pdu_max);
1310 m_bw_hold_PDU = apdu; // save PDU and signal "on hold"
1311 timeout(reduce); // call us reduce seconds later
1313 else if (apdu->which == Z_GDU_Z3950)
1314 handle_incoming_Z_PDU(apdu->u.z3950);
1315 else if (apdu->which == Z_GDU_HTTP_Request)
1316 handle_incoming_HTTP(apdu->u.HTTP_Request);
1319 void Yaz_Proxy::handle_max_record_retrieve(Z_APDU *apdu)
1321 if (m_max_record_retrieve)
1323 if (apdu->which == Z_APDU_presentRequest)
1325 Z_PresentRequest *pr = apdu->u.presentRequest;
1326 if (pr->numberOfRecordsRequested &&
1327 *pr->numberOfRecordsRequested > m_max_record_retrieve)
1328 *pr->numberOfRecordsRequested = m_max_record_retrieve;
1333 Z_Records *Yaz_Proxy::create_nonSurrogateDiagnostics(ODR odr,
1335 const char *addinfo)
1337 Z_Records *rec = (Z_Records *)
1338 odr_malloc (odr, sizeof(*rec));
1340 odr_malloc (odr, sizeof(*err));
1341 Z_DiagRec *drec = (Z_DiagRec *)
1342 odr_malloc (odr, sizeof(*drec));
1343 Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
1344 odr_malloc (odr, sizeof(*dr));
1346 rec->which = Z_Records_NSD;
1347 rec->u.nonSurrogateDiagnostic = dr;
1348 dr->diagnosticSetId =
1349 yaz_oidval_to_z3950oid (odr, CLASS_DIAGSET, VAL_BIB1);
1350 dr->condition = err;
1351 dr->which = Z_DefaultDiagFormat_v2Addinfo;
1352 dr->u.v2Addinfo = odr_strdup (odr, addinfo ? addinfo : "");
1356 Z_APDU *Yaz_Proxy::handle_query_transformation(Z_APDU *apdu)
1358 if (apdu->which == Z_APDU_searchRequest &&
1359 apdu->u.searchRequest->query &&
1360 apdu->u.searchRequest->query->which == Z_Query_type_104 &&
1361 apdu->u.searchRequest->query->u.type_104->which == Z_External_CQL)
1363 Z_RPNQuery *rpnquery = 0;
1364 Z_SearchRequest *sr = apdu->u.searchRequest;
1367 yaz_log(LOG_LOG, "%sCQL: %s", m_session_str,
1368 sr->query->u.type_104->u.cql);
1370 int r = m_cql2rpn.query_transform(sr->query->u.type_104->u.cql,
1371 &rpnquery, odr_encode(),
1374 yaz_log(LOG_LOG, "%sNo CQL to RPN table", m_session_str);
1377 yaz_log(LOG_LOG, "%sCQL Conversion error %d", m_session_str, r);
1378 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1380 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1381 new_apdu->u.searchResponse->records =
1382 create_nonSurrogateDiagnostics(odr_encode(),
1383 yaz_diag_srw_to_bib1(r),
1385 *new_apdu->u.searchResponse->searchStatus = 0;
1387 send_to_client(new_apdu);
1393 sr->query->which = Z_Query_type_1;
1394 sr->query->u.type_1 = rpnquery;
1401 Z_APDU *Yaz_Proxy::handle_query_validation(Z_APDU *apdu)
1403 if (apdu->which == Z_APDU_searchRequest)
1405 Z_SearchRequest *sr = apdu->u.searchRequest;
1409 Yaz_ProxyConfig *cfg = check_reconfigure();
1411 err = cfg->check_query(odr_encode(), m_default_target,
1412 sr->query, &addinfo);
1415 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
1417 new_apdu->u.searchResponse->referenceId = sr->referenceId;
1418 new_apdu->u.searchResponse->records =
1419 create_nonSurrogateDiagnostics(odr_encode(), err, addinfo);
1420 *new_apdu->u.searchResponse->searchStatus = 0;
1422 send_to_client(new_apdu);
1430 Z_APDU *Yaz_Proxy::handle_syntax_validation(Z_APDU *apdu)
1433 if (apdu->which == Z_APDU_searchRequest)
1435 Z_SearchRequest *sr = apdu->u.searchRequest;
1438 Yaz_ProxyConfig *cfg = check_reconfigure();
1440 Z_RecordComposition rc_temp, *rc = 0;
1441 if (sr->smallSetElementSetNames)
1443 rc_temp.which = Z_RecordComp_simple;
1444 rc_temp.u.simple = sr->smallSetElementSetNames;
1449 err = cfg->check_syntax(odr_encode(),
1451 sr->preferredRecordSyntax, rc,
1452 &addinfo, &m_stylesheet_schema, &m_schema);
1455 sr->preferredRecordSyntax =
1456 yaz_oidval_to_z3950oid(odr_encode(), CLASS_RECSYN, VAL_USMARC);
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);
1473 else if (apdu->which == Z_APDU_presentRequest)
1475 Z_PresentRequest *pr = apdu->u.presentRequest;
1478 Yaz_ProxyConfig *cfg = check_reconfigure();
1481 err = cfg->check_syntax(odr_encode(), m_default_target,
1482 pr->preferredRecordSyntax,
1483 pr->recordComposition,
1484 &addinfo, &m_stylesheet_schema, &m_schema);
1487 pr->preferredRecordSyntax =
1488 yaz_oidval_to_z3950oid(odr_decode(), CLASS_RECSYN, VAL_USMARC);
1493 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentResponse);
1495 new_apdu->u.presentResponse->referenceId = pr->referenceId;
1496 new_apdu->u.presentResponse->records =
1497 create_nonSurrogateDiagnostics(odr_encode(), err, addinfo);
1498 *new_apdu->u.presentResponse->presentStatus =
1499 Z_PresentStatus_failure;
1501 send_to_client(new_apdu);
1509 Z_ElementSetNames *Yaz_Proxy::mk_esn_from_schema(ODR o, const char *schema)
1513 Z_ElementSetNames *esn = (Z_ElementSetNames *)
1514 odr_malloc(o, sizeof(Z_ElementSetNames));
1515 esn->which = Z_ElementSetNames_generic;
1516 esn->u.generic = odr_strdup(o, schema);
1520 void Yaz_Proxy::handle_incoming_HTTP(Z_HTTP_Request *hreq)
1525 odr_destroy(m_s2z_odr_init);
1528 if (m_s2z_odr_search)
1530 odr_destroy(m_s2z_odr_search);
1531 m_s2z_odr_search = 0;
1534 m_http_keepalive = 0;
1536 if (!strcmp(hreq->version, "1.0"))
1538 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1539 if (v && !strcmp(v, "Keep-Alive"))
1540 m_http_keepalive = 1;
1542 m_http_keepalive = 0;
1543 m_http_version = "1.0";
1547 const char *v = z_HTTP_header_lookup(hreq->headers, "Connection");
1548 if (v && !strcmp(v, "close"))
1549 m_http_keepalive = 0;
1551 m_http_keepalive = 1;
1552 m_http_version = "1.1";
1555 Z_SRW_PDU *srw_pdu = 0;
1556 Z_SOAP *soap_package = 0;
1558 if (yaz_srw_decode(hreq, &srw_pdu, &soap_package, odr_decode(),
1560 || yaz_sru_decode(hreq, &srw_pdu, &soap_package, odr_decode(),
1563 m_s2z_odr_init = odr_createmem(ODR_ENCODE);
1564 m_s2z_odr_search = odr_createmem(ODR_ENCODE);
1565 m_soap_ns = odr_strdup(m_s2z_odr_search, soap_package->ns);
1566 m_s2z_init_apdu = 0;
1567 m_s2z_search_apdu = 0;
1568 m_s2z_present_apdu = 0;
1570 m_s2z_stylesheet = 0;
1572 if (srw_pdu->which == Z_SRW_searchRetrieve_request)
1574 Z_SRW_searchRetrieveRequest *srw_req = srw_pdu->u.request;
1577 if (srw_req->stylesheet)
1579 odr_strdup(m_s2z_odr_init, srw_req->stylesheet);
1581 // set packing for response records ..
1582 if (srw_req->recordPacking &&
1583 !strcmp(srw_req->recordPacking, "xml"))
1584 m_s2z_packing = Z_SRW_recordPacking_XML;
1586 m_s2z_packing = Z_SRW_recordPacking_string;
1588 // prepare search PDU
1589 m_s2z_search_apdu = zget_APDU(m_s2z_odr_search,
1590 Z_APDU_searchRequest);
1591 Z_SearchRequest *z_searchRequest =
1592 m_s2z_search_apdu->u.searchRequest;
1594 z_searchRequest->num_databaseNames = 1;
1595 z_searchRequest->databaseNames = (char**)
1596 odr_malloc(m_s2z_odr_search, sizeof(char *));
1597 z_searchRequest->databaseNames[0] = odr_strdup(m_s2z_odr_search,
1600 // query transformation
1601 Z_Query *query = (Z_Query *)
1602 odr_malloc(m_s2z_odr_search, sizeof(Z_Query));
1603 z_searchRequest->query = query;
1605 if (srw_req->query_type == Z_SRW_query_type_cql)
1607 if (!srw_req->query.cql)
1609 send_to_srw_client_error(7);
1612 Z_External *ext = (Z_External *)
1613 odr_malloc(m_s2z_odr_search, sizeof(*ext));
1614 ext->direct_reference =
1615 odr_getoidbystr(m_s2z_odr_search, "1.2.840.10003.16.2");
1616 ext->indirect_reference = 0;
1617 ext->descriptor = 0;
1618 ext->which = Z_External_CQL;
1619 ext->u.cql = srw_req->query.cql;
1621 query->which = Z_Query_type_104;
1622 query->u.type_104 = ext;
1624 else if (srw_req->query_type == Z_SRW_query_type_pqf)
1626 Z_RPNQuery *RPNquery;
1627 YAZ_PQF_Parser pqf_parser;
1629 pqf_parser = yaz_pqf_create ();
1631 RPNquery = yaz_pqf_parse (pqf_parser, m_s2z_odr_search,
1632 srw_req->query.pqf);
1635 const char *pqf_msg;
1637 int code = yaz_pqf_error (pqf_parser, &pqf_msg, &off);
1638 yaz_log(LOG_LOG, "%*s^\n", off+4, "");
1639 yaz_log(LOG_LOG, "Bad PQF: %s (code %d)\n", pqf_msg, code);
1641 send_to_srw_client_error(10);
1644 query->which = Z_Query_type_1;
1645 query->u.type_1 = RPNquery;
1647 yaz_pqf_destroy (pqf_parser);
1651 send_to_srw_client_error(7);
1656 m_s2z_present_apdu = 0;
1658 if (srw_req->maximumRecords)
1659 max = *srw_req->maximumRecords;
1661 if (srw_req->startRecord)
1662 start = *srw_req->startRecord;
1665 // Some backend, such as Voyager doesn't honor piggyback
1666 // So we use present always (0 &&).
1667 if (0 && start <= 1) // Z39.50 piggyback
1669 *z_searchRequest->smallSetUpperBound = max;
1670 *z_searchRequest->mediumSetPresentNumber = max;
1671 *z_searchRequest->largeSetLowerBound = 2000000000; // 2e9
1673 z_searchRequest->preferredRecordSyntax =
1674 yaz_oidval_to_z3950oid(m_s2z_odr_search, CLASS_RECSYN,
1676 if (srw_req->recordSchema)
1678 z_searchRequest->smallSetElementSetNames =
1679 z_searchRequest->mediumSetElementSetNames =
1680 mk_esn_from_schema(m_s2z_odr_search,
1681 srw_req->recordSchema);
1684 else // Z39.50 present
1686 m_s2z_present_apdu = zget_APDU(m_s2z_odr_search,
1687 Z_APDU_presentRequest);
1688 Z_PresentRequest *z_presentRequest =
1689 m_s2z_present_apdu->u.presentRequest;
1690 *z_presentRequest->resultSetStartPoint = start;
1691 *z_presentRequest->numberOfRecordsRequested = max;
1692 z_presentRequest->preferredRecordSyntax =
1693 yaz_oidval_to_z3950oid(m_s2z_odr_search, CLASS_RECSYN,
1695 z_presentRequest->recordComposition =
1696 (Z_RecordComposition *)
1697 odr_malloc(m_s2z_odr_search,
1698 sizeof(Z_RecordComposition));
1699 if (srw_req->recordSchema)
1701 z_presentRequest->recordComposition->which =
1702 Z_RecordComp_simple;
1703 z_presentRequest->recordComposition->u.simple =
1704 mk_esn_from_schema(m_s2z_odr_search,
1705 srw_req->recordSchema);
1711 m_s2z_init_apdu = zget_APDU(m_s2z_odr_init,
1712 Z_APDU_initRequest);
1714 // prevent m_initRequest_apdu memory from being grabbed
1715 // in Yaz_Proxy::handle_incoming_Z_PDU
1716 m_initRequest_apdu = m_s2z_init_apdu;
1717 handle_incoming_Z_PDU(m_s2z_init_apdu);
1722 handle_incoming_Z_PDU(m_s2z_search_apdu);
1726 else if (srw_pdu->which == Z_SRW_explain_request)
1728 Z_SRW_explainRequest *srw_req = srw_pdu->u.explain_request;
1731 if (srw_req->stylesheet)
1733 odr_strdup(m_s2z_odr_init, srw_req->stylesheet);
1735 if (srw_req->recordPacking &&
1736 !strcmp(srw_req->recordPacking, "xml"))
1737 m_s2z_packing = Z_SRW_recordPacking_XML;
1739 m_s2z_packing = Z_SRW_recordPacking_string;
1743 m_s2z_init_apdu = zget_APDU(m_s2z_odr_init,
1744 Z_APDU_initRequest);
1746 // prevent m_initRequest_apdu memory from being grabbed
1747 // in Yaz_Proxy::handle_incoming_Z_PDU
1748 m_initRequest_apdu = m_s2z_init_apdu;
1749 handle_incoming_Z_PDU(m_s2z_init_apdu);
1757 send_to_srw_client_error(4);
1761 Z_GDU *p = z_get_HTTP_Response(odr_encode(), 400);
1766 void Yaz_Proxy::handle_incoming_Z_PDU(Z_APDU *apdu)
1768 if (!m_client && m_invalid_session)
1770 m_apdu_invalid_session = apdu;
1771 m_mem_invalid_session = odr_extract_mem(odr_decode());
1772 apdu = m_initRequest_apdu;
1775 // Determine our client.
1776 Z_OtherInformation **oi;
1777 get_otherInfoAPDU(apdu, &oi);
1778 m_client = get_client(apdu, get_cookie(oi), get_proxy(oi));
1784 m_client->m_server = this;
1786 if (apdu->which == Z_APDU_initRequest)
1788 if (apdu->u.initRequest->implementationId)
1789 yaz_log(LOG_LOG, "%simplementationId: %s",
1790 m_session_str, apdu->u.initRequest->implementationId);
1791 if (apdu->u.initRequest->implementationName)
1792 yaz_log(LOG_LOG, "%simplementationName: %s",
1793 m_session_str, apdu->u.initRequest->implementationName);
1794 if (apdu->u.initRequest->implementationVersion)
1795 yaz_log(LOG_LOG, "%simplementationVersion: %s",
1796 m_session_str, apdu->u.initRequest->implementationVersion);
1797 if (m_initRequest_apdu == 0)
1799 if (m_initRequest_mem)
1800 nmem_destroy(m_initRequest_mem);
1801 m_initRequest_apdu = apdu;
1802 m_initRequest_mem = odr_extract_mem(odr_decode());
1804 if (m_client->m_init_flag)
1806 if (handle_init_response_for_invalid_session(apdu))
1808 Z_APDU *apdu2 = m_client->m_initResponse;
1809 apdu2->u.initResponse->otherInfo = 0;
1810 if (m_client->m_cookie && *m_client->m_cookie)
1811 set_otherInformationString(apdu2, VAL_COOKIE, 1,
1812 m_client->m_cookie);
1813 apdu2->u.initResponse->referenceId =
1814 apdu->u.initRequest->referenceId;
1815 send_to_client(apdu2);
1818 m_client->m_init_flag = 1;
1820 handle_max_record_retrieve(apdu);
1823 apdu = handle_syntax_validation(apdu);
1826 apdu = handle_query_transformation(apdu);
1829 apdu = handle_query_validation(apdu);
1832 apdu = result_set_optimize(apdu);
1835 m_client->timeout(m_target_idletime); // mark it active even
1836 // though we didn't use it
1840 // delete other info part from PDU before sending to target
1841 get_otherInfoAPDU(apdu, &oi);
1845 if (apdu->which == Z_APDU_presentRequest &&
1846 m_client->m_resultSetStartPoint == 0)
1848 Z_PresentRequest *pr = apdu->u.presentRequest;
1849 m_client->m_resultSetStartPoint = *pr->resultSetStartPoint;
1850 m_client->m_cache.copy_presentRequest(apdu->u.presentRequest);
1852 m_client->m_resultSetStartPoint = 0;
1854 if (m_client->send_to_target(apdu) < 0)
1861 m_client->m_waiting = 1;
1864 void Yaz_Proxy::connectNotify()
1868 void Yaz_Proxy::shutdown()
1870 m_invalid_session = 0;
1871 // only keep if keep_alive flag is set...
1873 m_client->m_pdu_recv < m_keepalive_limit_pdu &&
1874 m_client->m_bytes_recv+m_client->m_bytes_sent < m_keepalive_limit_bw &&
1875 m_client->m_waiting == 0)
1877 yaz_log(LOG_LOG, "%sShutdown (client to proxy) keepalive %s",
1879 m_client->get_hostname());
1880 yaz_log(LOG_LOG, "%sbw=%d pdu=%d limit-bw=%d limit-pdu=%d",
1881 m_session_str, m_client->m_pdu_recv,
1882 m_client->m_bytes_sent + m_client->m_bytes_recv,
1883 m_keepalive_limit_bw, m_keepalive_limit_pdu);
1884 assert (m_client->m_waiting != 2);
1885 // Tell client (if any) that no server connection is there..
1886 m_client->m_server = 0;
1887 m_invalid_session = 0;
1891 yaz_log (LOG_LOG, "%sShutdown (client to proxy) close %s",
1893 m_client->get_hostname());
1894 assert (m_client->m_waiting != 2);
1899 yaz_log (LOG_LOG, "%sshutdown (client to proxy) bad state",
1905 yaz_log (LOG_LOG, "%sShutdown (client to proxy)",
1909 m_parent->pre_init();
1913 const char *Yaz_ProxyClient::get_session_str()
1917 return m_server->get_session_str();
1920 void Yaz_ProxyClient::shutdown()
1922 yaz_log (LOG_LOG, "%sShutdown (proxy to target) %s", get_session_str(),
1928 void Yaz_Proxy::failNotify()
1931 yaz_log (LOG_LOG, "%sConnection closed by client",
1936 void Yaz_ProxyClient::failNotify()
1939 m_server->inc_request_no();
1940 yaz_log (LOG_LOG, "%sConnection closed by target %s",
1941 get_session_str(), get_hostname());
1945 void Yaz_ProxyClient::connectNotify()
1947 const char *s = get_session_str();
1948 const char *h = get_hostname();
1949 yaz_log (LOG_LOG, "%sConnection accepted by %s timeout=%d", s, h,
1951 timeout(m_target_idletime);
1956 IYaz_PDU_Observer *Yaz_ProxyClient::sessionNotify(IYaz_PDU_Observable
1957 *the_PDU_Observable, int fd)
1959 return new Yaz_ProxyClient(the_PDU_Observable, 0);
1962 Yaz_ProxyClient::~Yaz_ProxyClient()
1967 m_next->m_prev = m_prev;
1968 m_waiting = 2; // for debugging purposes only.
1969 odr_destroy(m_init_odr);
1970 delete m_last_query;
1971 xfree (m_last_resultSetId);
1975 void Yaz_ProxyClient::pre_init_client()
1977 Z_APDU *apdu = create_Z_PDU(Z_APDU_initRequest);
1978 Z_InitRequest *req = apdu->u.initRequest;
1980 ODR_MASK_SET(req->options, Z_Options_search);
1981 ODR_MASK_SET(req->options, Z_Options_present);
1982 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
1983 ODR_MASK_SET(req->options, Z_Options_triggerResourceCtrl);
1984 ODR_MASK_SET(req->options, Z_Options_scan);
1985 ODR_MASK_SET(req->options, Z_Options_sort);
1986 ODR_MASK_SET(req->options, Z_Options_extendedServices);
1987 ODR_MASK_SET(req->options, Z_Options_delSet);
1989 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
1990 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
1991 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
1993 if (send_to_target(apdu) < 0)
2004 void Yaz_Proxy::pre_init()
2007 const char *name = 0;
2008 const char *zurl_in_use[MAX_ZURL_PLEX];
2009 int limit_bw, limit_pdu, limit_req;
2010 int target_idletime, client_idletime;
2012 int keepalive_limit_bw, keepalive_limit_pdu;
2014 const char *cql2rpn = 0;
2016 Yaz_ProxyConfig *cfg = check_reconfigure();
2020 if (m_log_mask & PROXY_LOG_APDU_CLIENT)
2025 for (i = 0; cfg && cfg->get_target_no(i, &name, zurl_in_use,
2026 &limit_bw, &limit_pdu, &limit_req,
2027 &target_idletime, &client_idletime,
2029 &keepalive_limit_bw,
2030 &keepalive_limit_pdu,
2037 for (j = 0; zurl_in_use[j]; j++)
2043 for (c = m_clientPool; c; c = c->m_next)
2045 if (!strcmp(zurl_in_use[j], c->get_hostname()))
2047 if (c->m_cookie == 0)
2049 if (c->m_server == 0)
2058 yaz_log(LOG_LOG, "%spre-init %s %s use=%d other=%d spare=%d "
2059 "preinit=%d",m_session_str,
2060 name, zurl_in_use[j], in_use, other, spare, pre_init);
2061 if (spare < pre_init)
2063 c = new Yaz_ProxyClient(m_PDU_Observable->clone(), this);
2064 c->m_next = m_clientPool;
2066 c->m_next->m_prev = &c->m_next;
2068 c->m_prev = &m_clientPool;
2070 if (m_log_mask & PROXY_LOG_APDU_SERVER)
2071 c->set_APDU_yazlog(1);
2073 c->set_APDU_yazlog(0);
2075 if (c->client(zurl_in_use[j]))
2083 c->m_target_idletime = target_idletime;
2084 c->m_seqno = m_seqno++;
2091 void Yaz_Proxy::timeoutNotify()
2097 timeout(m_client_idletime);
2098 Z_GDU *apdu = m_bw_hold_PDU;
2101 if (apdu->which == Z_GDU_Z3950)
2102 handle_incoming_Z_PDU(apdu->u.z3950);
2103 else if (apdu->which == Z_GDU_HTTP_Request)
2104 handle_incoming_HTTP(apdu->u.HTTP_Request);
2110 yaz_log (LOG_LOG, "%sTimeout (client to proxy)", m_session_str);
2121 void Yaz_ProxyClient::timeoutNotify()
2124 m_server->inc_request_no();
2126 yaz_log (LOG_LOG, "%sTimeout (proxy to target) %s", get_session_str(),
2133 Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable,
2134 Yaz_Proxy *parent) :
2135 Yaz_Z_Assoc (the_PDU_Observable)
2142 m_last_resultSetId = 0;
2143 m_last_resultCount = 0;
2147 m_init_odr = odr_createmem (ODR_DECODE);
2149 m_resultSetStartPoint = 0;
2150 m_bytes_sent = m_bytes_recv = 0;
2154 m_target_idletime = 600;
2158 const char *Yaz_Proxy::option(const char *name, const char *value)
2160 if (!strcmp (name, "optimize")) {
2163 m_optimize = xstrdup (value);
2170 void Yaz_ProxyClient::recv_HTTP_response(Z_HTTP_Response *apdu, int len)
2175 void Yaz_ProxyClient::recv_GDU(Z_GDU *apdu, int len)
2177 if (apdu->which == Z_GDU_Z3950)
2178 recv_Z_PDU(apdu->u.z3950, len);
2179 else if (apdu->which == Z_GDU_HTTP_Response)
2180 recv_HTTP_response(apdu->u.HTTP_Response, len);
2185 int Yaz_Proxy::handle_init_response_for_invalid_session(Z_APDU *apdu)
2187 if (!m_invalid_session)
2189 m_invalid_session = 0;
2190 handle_incoming_Z_PDU(m_apdu_invalid_session);
2191 assert (m_mem_invalid_session);
2192 nmem_destroy(m_mem_invalid_session);
2193 m_mem_invalid_session = 0;
2197 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu, int len)
2199 m_bytes_recv += len;
2202 if (m_root->get_log_mask() & PROXY_LOG_REQ_SERVER)
2203 yaz_log (LOG_LOG, "%sReceiving %s from %s %d bytes", get_session_str(),
2204 apdu_name(apdu), get_hostname(), len);
2205 if (apdu->which == Z_APDU_initResponse)
2207 if (!m_server) // if this is a pre init session , check for more
2209 NMEM nmem = odr_extract_mem (odr_decode());
2210 odr_reset (m_init_odr);
2211 nmem_transfer (m_init_odr->mem, nmem);
2212 m_initResponse = apdu;
2214 Z_InitResponse *ir = apdu->u.initResponse;
2215 char *im0 = ir->implementationName;
2218 odr_malloc(m_init_odr, 20 + (im0 ? strlen(im0) : 0));
2225 strcat(im1, "(YAZ Proxy)");
2226 ir->implementationName = im1;
2228 nmem_destroy (nmem);
2230 if (m_server && m_server->handle_init_response_for_invalid_session(apdu))
2233 if (apdu->which == Z_APDU_searchResponse)
2235 Z_SearchResponse *sr = apdu->u.searchResponse;
2236 m_last_resultCount = *sr->resultCount;
2237 int status = *sr->searchStatus;
2238 if (status && (!sr->records || sr->records->which == Z_Records_DBOSD))
2242 if (sr->records && sr->records->which == Z_Records_DBOSD)
2244 m_cache.add(odr_decode(),
2245 sr->records->u.databaseOrSurDiagnostics, 1,
2250 if (apdu->which == Z_APDU_presentResponse)
2252 Z_PresentResponse *pr = apdu->u.presentResponse;
2256 Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
2257 Z_SearchResponse *sr = new_apdu->u.searchResponse;
2258 sr->referenceId = pr->referenceId;
2259 *sr->resultCount = m_last_resultCount;
2260 sr->records = pr->records;
2261 sr->nextResultSetPosition = pr->nextResultSetPosition;
2262 sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
2266 pr->records->which == Z_Records_DBOSD && m_resultSetStartPoint)
2268 m_cache.add(odr_decode(),
2269 pr->records->u.databaseOrSurDiagnostics,
2270 m_resultSetStartPoint, -1);
2271 m_resultSetStartPoint = 0;
2275 set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
2278 m_server->send_to_client(apdu);
2280 if (apdu->which == Z_APDU_close)
2286 int Yaz_Proxy::server(const char *addr)
2288 int r = Yaz_Z_Assoc::server(addr);
2291 yaz_log(LOG_LOG, "%sStarted proxy " VERSION " on %s", m_session_str, addr);