1 /* $Id: filter_sru_to_z3950.cpp,v 1.26 2007-01-08 11:10:06 marc Exp $
2 Copyright (c) 2005-2006, Index Data.
4 See the LICENSE file for details
11 #include "gduutil.hpp"
12 #include "sru_util.hpp"
13 #include "filter_sru_to_z3950.hpp"
16 #include <yaz/z-core.h>
18 #include <yaz/pquery.h>
20 #include <boost/thread/mutex.hpp>
28 namespace mp = metaproxy_1;
29 namespace mp_util = metaproxy_1::util;
30 namespace yf = mp::filter;
33 namespace metaproxy_1 {
35 class SRUtoZ3950::Impl {
37 void configure(const xmlNode *xmlnode);
38 void process(metaproxy_1::Package &package);
40 union SRW_query {char * cql; char * xcql; char * pqf;};
41 typedef const int& SRW_query_type;
42 std::map<std::string, const xmlNode *> m_database_explain;
45 bool z3950_build_query(mp::odr &odr_en, Z_Query *z_query,
46 const SRW_query &query,
47 SRW_query_type query_type) const;
49 bool z3950_init_request(mp::Package &package,
51 &database = "Default") const;
53 bool z3950_close_request(mp::Package &package) const;
55 bool z3950_search_request(mp::Package &package,
57 Z_SRW_PDU *sru_pdu_res,
58 Z_SRW_searchRetrieveRequest
61 bool z3950_present_request(mp::Package &package,
63 Z_SRW_PDU *sru_pdu_res,
64 Z_SRW_searchRetrieveRequest
67 bool z3950_scan_request(mp::Package &package,
69 Z_SRW_PDU *sru_pdu_res,
74 int z3950_to_srw_diag(mp::odr &odr_en,
75 Z_SRW_searchRetrieveResponse *srw_res,
76 Z_DefaultDiagFormat *ddf) const;
81 yf::SRUtoZ3950::SRUtoZ3950() : m_p(new Impl)
85 yf::SRUtoZ3950::~SRUtoZ3950()
86 { // must have a destructor because of boost::scoped_ptr
89 void yf::SRUtoZ3950::configure(const xmlNode *xmlnode)
91 m_p->configure(xmlnode);
94 void yf::SRUtoZ3950::process(mp::Package &package) const
96 m_p->process(package);
99 void yf::SRUtoZ3950::Impl::configure(const xmlNode *confignode)
101 const xmlNode * dbnode;
103 for (dbnode = confignode->children; dbnode; dbnode = dbnode->next){
104 if (dbnode->type != XML_ELEMENT_NODE)
107 std::string database;
108 mp::xml::check_element_mp(dbnode, "database");
110 for (struct _xmlAttr *attr = dbnode->properties;
111 attr; attr = attr->next){
113 mp::xml::check_attribute(attr, "", "name");
114 database = mp::xml::get_text(attr);
116 const xmlNode *explainnode;
117 for (explainnode = dbnode->children;
118 explainnode; explainnode = explainnode->next){
119 if (explainnode->type != XML_ELEMENT_NODE)
124 // assigning explain node to database name - no check yet
125 m_database_explain.insert(std::make_pair(database, explainnode));
130 void yf::SRUtoZ3950::Impl::process(mp::Package &package)
132 Z_GDU *zgdu_req = package.request().get();
134 // ignoring all non HTTP_Request packages
135 if (!zgdu_req || !(zgdu_req->which == Z_GDU_HTTP_Request)){
140 // only working on HTTP_Request packages now
144 mp::odr odr_de(ODR_DECODE);
145 Z_SRW_PDU *sru_pdu_req = 0;
147 mp::odr odr_en(ODR_ENCODE);
148 Z_SRW_PDU *sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response);
150 // determine database with the HTTP header information only
151 mp_util::SRUServerInfo sruinfo = mp_util::get_sru_server_info(package);
152 std::map<std::string, const xmlNode *>::iterator idbexp;
153 idbexp = m_database_explain.find(sruinfo.database);
155 // assign explain config XML DOM node if database is known
156 const xmlNode *explainnode = 0;
157 if (idbexp != m_database_explain.end()){
158 explainnode = idbexp->second;
160 // just moving package if database is not known
167 // decode SRU request
170 char *stylesheet = 0;
172 // filter acts as sink for non-valid SRU requests
173 if (! (sru_pdu_req = mp_util::decode_sru_request(package, odr_de, odr_en,
175 charset, stylesheet)))
177 mp_util::build_sru_explain(package, odr_en, sru_pdu_res,
178 sruinfo, explainnode);
179 mp_util::build_sru_response(package, odr_en, soap,
180 sru_pdu_res, charset, stylesheet);
181 package.session().close();
185 // filter acts as sink for SRU explain requests
186 if (sru_pdu_req && sru_pdu_req->which == Z_SRW_explain_request)
188 Z_SRW_explainRequest *er_req = sru_pdu_req->u.explain_request;
189 //mp_util::build_simple_explain(package, odr_en, sru_pdu_res,
191 mp_util::build_sru_explain(package, odr_en, sru_pdu_res,
192 sruinfo, explainnode, er_req);
193 mp_util::build_sru_response(package, odr_en, soap,
194 sru_pdu_res, charset, stylesheet);
200 && sru_pdu_req->which == Z_SRW_searchRetrieve_request
201 && sru_pdu_req->u.request)
203 Z_SRW_searchRetrieveRequest *sr_req = sru_pdu_req->u.request;
205 sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_searchRetrieve_response);
207 // checking that we have a query
208 ok = mp_util::check_sru_query_exists(package, odr_en,
209 sru_pdu_res, sr_req);
211 if (ok && z3950_init_request(package))
214 ok = z3950_search_request(package, odr_en,
215 sru_pdu_res, sr_req);
218 && sru_pdu_res->u.response->numberOfRecords
219 && *(sru_pdu_res->u.response->numberOfRecords)
220 && sr_req->maximumRecords
221 && *(sr_req->maximumRecords))
223 ok = z3950_present_request(package, odr_en,
226 z3950_close_request(package);
233 && sru_pdu_req->which == Z_SRW_scan_request
234 && sru_pdu_req->u.scan_request)
236 Z_SRW_scanRequest *sr_req = sru_pdu_req->u.scan_request;
238 sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_scan_response);
240 // we do not do scan at the moment, therefore issuing a diagnostic
241 yaz_add_srw_diagnostic(odr_en,
242 &(sru_pdu_res->u.scan_response->diagnostics),
243 &(sru_pdu_res->u.scan_response->num_diagnostics),
246 // to be used when we do scan
247 if (false && z3950_init_request(package))
249 z3950_scan_request(package, odr_en, sru_pdu_res, sr_req);
250 z3950_close_request(package);
255 //std::cout << "SRU OPERATION NOT SUPPORTED \n";
256 sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response);
258 // TODO: make nice diagnostic return package
259 package.session().close();
263 // build and send SRU response
264 mp_util::build_sru_response(package, odr_en, soap,
265 sru_pdu_res, charset, stylesheet);
272 yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package,
273 const std::string &database) const
275 // prepare Z3950 package
276 Package z3950_package(package.session(), package.origin());
277 z3950_package.copy_filter(package);
279 // set initRequest APDU
280 mp::odr odr_en(ODR_ENCODE);
281 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_initRequest);
282 Z_InitRequest *init_req = apdu->u.initRequest;
283 //TODO: add user name in apdu
284 //TODO: add user passwd in apdu
285 //init_req->idAuthentication = org_init->idAuthentication;
286 //init_req->implementationId = "IDxyz";
287 //init_req->implementationName = "NAMExyz";
288 //init_req->implementationVersion = "VERSIONxyz";
290 ODR_MASK_SET(init_req->options, Z_Options_search);
291 ODR_MASK_SET(init_req->options, Z_Options_present);
292 ODR_MASK_SET(init_req->options, Z_Options_namedResultSets);
293 ODR_MASK_SET(init_req->options, Z_Options_scan);
295 ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_1);
296 ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_2);
297 ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_3);
299 z3950_package.request() = apdu;
301 // send Z3950 package
302 z3950_package.move();
304 // dead Z3950 backend detection
305 if (z3950_package.session().is_closed()){
306 package.session().close();
310 // check successful initResponse
311 Z_GDU *z3950_gdu = z3950_package.response().get();
313 if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
314 && z3950_gdu->u.z3950->which == Z_APDU_initResponse)
321 yf::SRUtoZ3950::Impl::z3950_close_request(mp::Package &package) const
324 package.session().close();
326 // prepare and close Z3950 package
327 Package z3950_package(package.session(), package.origin());
328 z3950_package.copy_filter(package);
329 z3950_package.session().close();
332 //mp::odr odr_en(ODR_ENCODE);
333 //Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_close);
334 //z3950_package.request() = apdu;
336 z3950_package.move();
338 // check successful close response
339 //Z_GDU *z3950_gdu = z3950_package.response().get();
340 //if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
341 // && z3950_gdu->u.z3950->which == Z_APDU_close)
344 if (z3950_package.session().is_closed()){
351 yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package,
353 Z_SRW_PDU *sru_pdu_res,
354 Z_SRW_searchRetrieveRequest
358 assert(sru_pdu_res->u.response);
360 Package z3950_package(package.session(), package.origin());
361 z3950_package.copy_filter(package);
363 //add stuff in z3950 apdu
364 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_searchRequest);
365 Z_SearchRequest *z_searchRequest = apdu->u.searchRequest;
368 z_searchRequest->num_databaseNames = 1;
369 z_searchRequest->databaseNames = (char**)
370 odr_malloc(odr_en, sizeof(char *));
372 if (sr_req->database)
373 z_searchRequest->databaseNames[0]
374 = odr_strdup(odr_en, const_cast<char *>(sr_req->database));
376 z_searchRequest->databaseNames[0]
377 = odr_strdup(odr_en, "Default");
381 Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query));
382 z_searchRequest->query = z_query;
384 if (!z3950_build_query(odr_en, z_query,
385 (const SRW_query&)sr_req->query,
388 yaz_add_srw_diagnostic(odr_en,
389 &(sru_pdu_res->u.response->diagnostics),
390 &(sru_pdu_res->u.response->num_diagnostics),
395 z3950_package.request() = apdu;
397 // send Z39.50 package off to backend
398 z3950_package.move();
401 Z_GDU *z3950_gdu = z3950_package.response().get();
403 //TODO: check success condition
405 //int yaz_diag_bib1_to_srw (int bib1_code);
406 //int yaz_diag_srw_to_bib1(int srw_code);
407 //Se kode i src/seshigh.c (srw_bend_search, srw_bend_init).
409 if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
410 && z3950_gdu->u.z3950->which == Z_APDU_searchResponse
411 && z3950_gdu->u.z3950->u.searchResponse->searchStatus)
414 Z_SearchResponse *sr = z3950_gdu->u.z3950->u.searchResponse;
417 // srw'fy number of records
418 sru_pdu_res->u.response->numberOfRecords
419 = (int *) odr_malloc(odr_en, sizeof(int *));
420 *(sru_pdu_res->u.response->numberOfRecords) = *(sr->resultCount);
422 // srw'fy nextRecordPosition
423 //sru_pdu_res->u.response->nextRecordPosition
424 // = (int *) odr_malloc(odr_en, sizeof(int *));
425 //*(sru_pdu_res->u.response->nextRecordPosition) = 1;
436 yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
438 Z_SRW_PDU *sru_pdu_res,
439 Z_SRW_searchRetrieveRequest
443 assert(sru_pdu_res->u.response);
449 // no need to work if nobody wants record ..
450 if (!(sr_req->maximumRecords) || 0 == *(sr_req->maximumRecords))
453 bool send_z3950_present = true;
455 // recordXPath unsupported.
456 if (sr_req->recordXPath)
458 send_z3950_present = false;
459 yaz_add_srw_diagnostic(odr_en,
460 &(sru_pdu_res->u.response->diagnostics),
461 &(sru_pdu_res->u.response->num_diagnostics),
465 // resultSetTTL unsupported.
466 // resultSetIdleTime in response
467 if (sr_req->resultSetTTL)
469 send_z3950_present = false;
470 yaz_add_srw_diagnostic(odr_en,
471 &(sru_pdu_res->u.response->diagnostics),
472 &(sru_pdu_res->u.response->num_diagnostics),
477 if (sr_req->sort_type != Z_SRW_sort_type_none)
479 send_z3950_present = false;
480 yaz_add_srw_diagnostic(odr_en,
481 &(sru_pdu_res->u.response->diagnostics),
482 &(sru_pdu_res->u.response->num_diagnostics),
486 // start record requested negative, or larger than number of records
487 if (sr_req->startRecord
489 ((*(sr_req->startRecord) < 0) // negative
491 (sru_pdu_res->u.response->numberOfRecords //out of range
492 && *(sr_req->startRecord)
493 > *(sru_pdu_res->u.response->numberOfRecords))
496 send_z3950_present = false;
497 yaz_add_srw_diagnostic(odr_en,
498 &(sru_pdu_res->u.response->diagnostics),
499 &(sru_pdu_res->u.response->num_diagnostics),
503 // maximumRecords requested negative
504 if (sr_req->maximumRecords
505 && *(sr_req->maximumRecords) < 0)
508 send_z3950_present = false;
509 yaz_add_srw_diagnostic(odr_en,
510 &(sru_pdu_res->u.response->diagnostics),
511 &(sru_pdu_res->u.response->num_diagnostics),
512 6, "maximumRecords");
515 // exit on all these above diagnostics
516 if (!send_z3950_present)
519 // now packaging the z3950 present request
520 Package z3950_package(package.session(), package.origin());
521 z3950_package.copy_filter(package);
522 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_presentRequest);
524 assert(apdu->u.presentRequest);
526 // z3950'fy start record position
527 if (sr_req->startRecord)
528 *(apdu->u.presentRequest->resultSetStartPoint)
529 = *(sr_req->startRecord);
531 *(apdu->u.presentRequest->resultSetStartPoint) = 1;
533 // z3950'fy number of records requested
534 // protect against requesting records out of range
535 if (sr_req->maximumRecords)
536 *(apdu->u.presentRequest->numberOfRecordsRequested)
537 = std::min(*(sr_req->maximumRecords),
538 *(sru_pdu_res->u.response->numberOfRecords)
539 - *(apdu->u.presentRequest->resultSetStartPoint)
542 // z3950'fy recordPacking
543 int record_packing = Z_SRW_recordPacking_XML;
544 if (sr_req->recordPacking && 's' == *(sr_req->recordPacking))
545 record_packing = Z_SRW_recordPacking_string;
547 // RecordSyntax will always be XML
548 (apdu->u.presentRequest->preferredRecordSyntax)
549 = yaz_oidval_to_z3950oid (odr_en, CLASS_RECSYN, VAL_TEXT_XML);
551 // z3950'fy record schema
552 if (sr_req->recordSchema)
554 apdu->u.presentRequest->recordComposition
555 = (Z_RecordComposition *)
556 odr_malloc(odr_en, sizeof(Z_RecordComposition));
557 apdu->u.presentRequest->recordComposition->which
558 = Z_RecordComp_simple;
559 apdu->u.presentRequest->recordComposition->u.simple
560 = mp_util::build_esn_from_schema(odr_en,
561 (const char *) sr_req->recordSchema);
564 // z3950'fy time to live - flagged as diagnostics above
565 //if (sr_req->resultSetTTL)
567 // attaching Z3950 package to filter chain
568 z3950_package.request() = apdu;
570 // sending Z30.50 present request
571 z3950_package.move();
573 //check successful Z3950 present response
574 Z_GDU *z3950_gdu = z3950_package.response().get();
575 if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950
576 || z3950_gdu->u.z3950->which != Z_APDU_presentResponse
577 || !z3950_gdu->u.z3950->u.presentResponse)
580 yaz_add_srw_diagnostic(odr_en,
581 &(sru_pdu_res->u.response->diagnostics),
582 &(sru_pdu_res->u.response->num_diagnostics),
584 package.session().close();
589 // everything fine, continuing
591 Z_PresentResponse *pr = z3950_gdu->u.z3950->u.presentResponse;
592 Z_SRW_searchRetrieveResponse *sru_res = sru_pdu_res->u.response;
594 // checking non surrogate dioagnostics in Z3950 present response package
596 && pr->records->which == Z_Records_NSD
597 && pr->records->u.nonSurrogateDiagnostic)
600 z3950_to_srw_diag(odr_en, sru_res,
601 pr->records->u.nonSurrogateDiagnostic);
605 // copy all records if existing
606 if (pr->records && pr->records->which == Z_Records_DBOSD)
608 // srw'fy number of returned records
610 = pr->records->u.databaseOrSurDiagnostics->num_records;
613 = (Z_SRW_record *) odr_malloc(odr_en,
615 * sizeof(Z_SRW_record));
618 // srw'fy nextRecordPosition
619 // next position never zero or behind the last z3950 record
620 if (pr->nextResultSetPosition
621 && *(pr->nextResultSetPosition) > 0
622 && *(pr->nextResultSetPosition)
623 <= *(sru_pdu_res->u.response->numberOfRecords))
624 sru_res->nextRecordPosition
625 = odr_intdup(odr_en, *(pr->nextResultSetPosition));
627 // inserting all records
628 for (int i = 0; i < sru_res->num_records; i++)
630 Z_NamePlusRecord *npr
631 = pr->records->u.databaseOrSurDiagnostics->records[i];
633 sru_res->records[i].recordPosition
635 i + *(apdu->u.presentRequest->resultSetStartPoint));
637 sru_res->records[i].recordPacking = record_packing;
639 if (npr->which != Z_NamePlusRecord_databaseRecord)
641 sru_res->records[i].recordSchema = "diagnostic";
642 sru_res->records[i].recordData_buf = "67";
643 sru_res->records[i].recordData_len = 2;
647 Z_External *r = npr->u.databaseRecord;
648 oident *ent = oid_getentbyoid(r->direct_reference);
649 if (r->which == Z_External_octet
650 && ent->value == VAL_TEXT_XML)
652 sru_res->records[i].recordSchema = "dc";
653 sru_res->records[i].recordData_buf
654 = odr_strdupn(odr_en,
655 (const char *)r->u.octet_aligned->buf,
656 r->u.octet_aligned->len);
657 sru_res->records[i].recordData_len
658 = r->u.octet_aligned->len;
662 sru_res->records[i].recordSchema = "diagnostic";
663 sru_res->records[i].recordData_buf = "67";
664 sru_res->records[i].recordData_len = 2;
674 yf::SRUtoZ3950::Impl::z3950_scan_request(mp::Package &package,
676 Z_SRW_PDU *sru_pdu_res,
677 Z_SRW_scanRequest const *sr_req) const
679 assert(sru_pdu_res->u.scan_response);
681 Package z3950_package(package.session(), package.origin());
682 z3950_package.copy_filter(package);
683 //mp::odr odr_en(ODR_ENCODE);
684 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_scanRequest);
686 //TODO: add stuff in apdu
687 Z_ScanRequest *z_scanRequest = apdu->u.scanRequest;
689 // database repackaging
690 z_scanRequest->num_databaseNames = 1;
691 z_scanRequest->databaseNames = (char**)
692 odr_malloc(odr_en, sizeof(char *));
693 if (sr_req->database)
694 z_scanRequest->databaseNames[0]
695 = odr_strdup(odr_en, const_cast<char *>(sr_req->database));
697 z_scanRequest->databaseNames[0]
698 = odr_strdup(odr_en, "Default");
702 // CQL or XCQL scan is not possible in Z3950, flagging a diagnostic
703 if (sr_req->query_type != Z_SRW_query_type_pqf)
705 //send_to_srw_client_error(7, "query");
709 // PQF query repackaging
710 // need to use Z_AttributesPlusTerm structure, not Z_Query
711 // this can be digget out of a
712 // Z_query->type1(Z_RPNQuery)->RPNStructure(Z_RPNStructure)
713 // ->u.simple(Z_Operand)->u.attributesPlusTerm(Z_AttributesPlusTerm )
715 //Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query));
716 //z_searchRequest->query = z_query;
718 //if (!z3950_build_query(odr_en, z_query,
719 // (const SRW_query&)sr_req->query,
720 // sr_req->query_type))
722 //send_to_srw_client_error(7, "query");
728 z3950_package.request() = apdu;
729 std::cout << "z3950_scan_request " << *apdu << "\n";
731 z3950_package.move();
732 //TODO: check success condition
737 bool yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query,
738 const SRW_query &query,
739 SRW_query_type query_type) const
741 if (query_type == Z_SRW_query_type_cql)
743 Z_External *ext = (Z_External *)
744 odr_malloc(odr_en, sizeof(*ext));
745 ext->direct_reference =
746 odr_getoidbystr(odr_en, "1.2.840.10003.16.2");
747 ext->indirect_reference = 0;
749 ext->which = Z_External_CQL;
750 ext->u.cql = const_cast<char *>(query.cql);
752 z_query->which = Z_Query_type_104;
753 z_query->u.type_104 = ext;
757 if (query_type == Z_SRW_query_type_pqf)
759 Z_RPNQuery *RPNquery;
760 YAZ_PQF_Parser pqf_parser;
762 pqf_parser = yaz_pqf_create ();
764 RPNquery = yaz_pqf_parse (pqf_parser, odr_en, query.pqf);
767 std::cout << "TODO: Handeling of bad PQF\n";
768 std::cout << "TODO: Diagnostic to be send\n";
770 z_query->which = Z_Query_type_1;
771 z_query->u.type_1 = RPNquery;
773 yaz_pqf_destroy(pqf_parser);
782 yf::SRUtoZ3950::Impl::z3950_to_srw_diag(mp::odr &odr_en,
783 Z_SRW_searchRetrieveResponse *sru_res,
784 Z_DefaultDiagFormat *ddf) const
786 int bib1_code = *ddf->condition;
787 if (bib1_code == 109)
789 sru_res->num_diagnostics = 1;
790 sru_res->diagnostics = (Z_SRW_diagnostic *)
791 odr_malloc(odr_en, sizeof(*sru_res->diagnostics));
792 yaz_mk_std_diagnostic(odr_en, sru_res->diagnostics,
793 yaz_diag_bib1_to_srw(*ddf->condition),
800 static mp::filter::Base* filter_creator()
802 return new mp::filter::SRUtoZ3950;
806 struct metaproxy_1_filter_struct metaproxy_1_filter_sru_to_z3950 = {
817 * indent-tabs-mode: nil
818 * c-file-style: "stroustrup"
820 * vim: shiftwidth=4 tabstop=8 expandtab