1 /* $Id: filter_sru_to_z3950.cpp,v 1.25 2007-01-07 00:41:18 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>
27 namespace mp = metaproxy_1;
28 namespace mp_util = metaproxy_1::util;
29 namespace yf = mp::filter;
32 namespace metaproxy_1 {
34 class SRUtoZ3950::Impl {
36 void configure(const xmlNode *xmlnode);
37 void process(metaproxy_1::Package &package) const;
39 union SRW_query {char * cql; char * xcql; char * pqf;};
40 typedef const int& SRW_query_type;
43 bool z3950_build_query(mp::odr &odr_en, Z_Query *z_query,
44 const SRW_query &query,
45 SRW_query_type query_type) const;
47 bool z3950_init_request(mp::Package &package,
49 &database = "Default") const;
51 bool z3950_close_request(mp::Package &package) const;
53 bool z3950_search_request(mp::Package &package,
55 Z_SRW_PDU *sru_pdu_res,
56 Z_SRW_searchRetrieveRequest
59 bool z3950_present_request(mp::Package &package,
61 Z_SRW_PDU *sru_pdu_res,
62 Z_SRW_searchRetrieveRequest
65 bool z3950_scan_request(mp::Package &package,
67 Z_SRW_PDU *sru_pdu_res,
72 int z3950_to_srw_diag(mp::odr &odr_en,
73 Z_SRW_searchRetrieveResponse *srw_res,
74 Z_DefaultDiagFormat *ddf) const;
79 yf::SRUtoZ3950::SRUtoZ3950() : m_p(new Impl)
83 yf::SRUtoZ3950::~SRUtoZ3950()
84 { // must have a destructor because of boost::scoped_ptr
87 void yf::SRUtoZ3950::configure(const xmlNode *xmlnode)
89 m_p->configure(xmlnode);
92 void yf::SRUtoZ3950::process(mp::Package &package) const
94 m_p->process(package);
97 void yf::SRUtoZ3950::Impl::configure(const xmlNode *xmlnode)
101 void yf::SRUtoZ3950::Impl::process(mp::Package &package) const
103 Z_GDU *zgdu_req = package.request().get();
105 // ignoring all non HTTP_Request packages
106 if (!zgdu_req || !(zgdu_req->which == Z_GDU_HTTP_Request)){
111 // only working on HTTP_Request packages now
114 // TODO: Z3950 response parsing and translation to SRU package
117 mp::odr odr_de(ODR_DECODE);
118 Z_SRW_PDU *sru_pdu_req = 0;
120 mp::odr odr_en(ODR_ENCODE);
121 //Z_SRW_PDU *sru_pdu_res = 0;
122 Z_SRW_PDU *sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response);
126 char *stylesheet = 0;
128 mp_util::SRUServerInfo sruinfo = mp_util::get_sru_server_info(package);
131 if (! (sru_pdu_req = mp_util::decode_sru_request(package, odr_de, odr_en,
133 charset, stylesheet)))
135 //mp_util::build_simple_explain(package, odr_en, sru_pdu_res, sruinfo);
136 //mp_util::build_sru_response(package, odr_en, soap,
137 // sru_pdu_res, charset, stylesheet);
138 //package.session().close();
144 if (sru_pdu_req && sru_pdu_req->which == Z_SRW_explain_request)
146 //Z_SRW_explainRequest *er_req = sru_pdu_req->u.explain_request;
147 //sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response);
149 //mp_util::build_simple_explain(package, odr_en, sru_pdu_res,
157 && sru_pdu_req->which == Z_SRW_searchRetrieve_request
158 && sru_pdu_req->u.request)
160 Z_SRW_searchRetrieveRequest *sr_req = sru_pdu_req->u.request;
162 sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_searchRetrieve_response);
164 // checking that we have a query
165 ok = mp_util::check_sru_query_exists(package, odr_en,
166 sru_pdu_res, sr_req);
168 if (ok && z3950_init_request(package))
171 ok = z3950_search_request(package, odr_en,
172 sru_pdu_res, sr_req);
175 && sru_pdu_res->u.response->numberOfRecords
176 && *(sru_pdu_res->u.response->numberOfRecords)
177 && sr_req->maximumRecords
178 && *(sr_req->maximumRecords))
180 ok = z3950_present_request(package, odr_en,
183 z3950_close_request(package);
190 && sru_pdu_req->which == Z_SRW_scan_request
191 && sru_pdu_req->u.scan_request)
193 Z_SRW_scanRequest *sr_req = sru_pdu_req->u.scan_request;
195 sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_scan_response);
197 // we do not do scan at the moment, therefore issuing a diagnostic
198 yaz_add_srw_diagnostic(odr_en,
199 &(sru_pdu_res->u.scan_response->diagnostics),
200 &(sru_pdu_res->u.scan_response->num_diagnostics),
203 // to be used when we do scan
204 if (false && z3950_init_request(package))
206 z3950_scan_request(package, odr_en, sru_pdu_res, sr_req);
207 z3950_close_request(package);
212 //std::cout << "SRU OPERATION NOT SUPPORTED \n";
213 sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response);
215 // TODO: make nice diagnostic return package
216 package.session().close();
220 //mp_util::build_sru_debug_package(package);
221 mp_util::build_sru_response(package, odr_en, soap,
222 sru_pdu_res, charset, stylesheet);
229 yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package,
230 const std::string &database) const
232 // prepare Z3950 package
234 //Package z3950_package(s, package.origin());
235 Package z3950_package(package.session(), package.origin());
236 z3950_package.copy_filter(package);
238 // set initRequest APDU
239 mp::odr odr_en(ODR_ENCODE);
240 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_initRequest);
241 Z_InitRequest *init_req = apdu->u.initRequest;
242 //TODO: add user name in apdu
243 //TODO: add user passwd in apdu
244 //init_req->idAuthentication = org_init->idAuthentication;
245 //init_req->implementationId = "IDxyz";
246 //init_req->implementationName = "NAMExyz";
247 //init_req->implementationVersion = "VERSIONxyz";
249 ODR_MASK_SET(init_req->options, Z_Options_search);
250 ODR_MASK_SET(init_req->options, Z_Options_present);
251 ODR_MASK_SET(init_req->options, Z_Options_namedResultSets);
252 ODR_MASK_SET(init_req->options, Z_Options_scan);
254 ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_1);
255 ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_2);
256 ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_3);
258 z3950_package.request() = apdu;
260 // send Z3950 package
261 // std::cout << "z3950_init_request " << *apdu <<"\n";
262 z3950_package.move();
264 // dead Z3950 backend detection
265 if (z3950_package.session().is_closed()){
266 package.session().close();
270 // check successful initResponse
271 Z_GDU *z3950_gdu = z3950_package.response().get();
273 if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
274 && z3950_gdu->u.z3950->which == Z_APDU_initResponse)
281 yf::SRUtoZ3950::Impl::z3950_close_request(mp::Package &package) const
284 package.session().close();
286 // prepare and close Z3950 package
287 Package z3950_package(package.session(), package.origin());
288 z3950_package.copy_filter(package);
289 z3950_package.session().close();
292 //mp::odr odr_en(ODR_ENCODE);
293 //Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_close);
294 //z3950_package.request() = apdu;
296 z3950_package.move();
298 // check successful close response
299 //Z_GDU *z3950_gdu = z3950_package.response().get();
300 //if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
301 // && z3950_gdu->u.z3950->which == Z_APDU_close)
304 if (z3950_package.session().is_closed()){
311 yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package,
313 Z_SRW_PDU *sru_pdu_res,
314 Z_SRW_searchRetrieveRequest
318 assert(sru_pdu_res->u.response);
320 Package z3950_package(package.session(), package.origin());
321 z3950_package.copy_filter(package);
323 //add stuff in z3950 apdu
324 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_searchRequest);
325 Z_SearchRequest *z_searchRequest = apdu->u.searchRequest;
328 z_searchRequest->num_databaseNames = 1;
329 z_searchRequest->databaseNames = (char**)
330 odr_malloc(odr_en, sizeof(char *));
332 if (sr_req->database)
333 z_searchRequest->databaseNames[0]
334 = odr_strdup(odr_en, const_cast<char *>(sr_req->database));
336 z_searchRequest->databaseNames[0]
337 = odr_strdup(odr_en, "Default");
341 Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query));
342 z_searchRequest->query = z_query;
344 if (!z3950_build_query(odr_en, z_query,
345 (const SRW_query&)sr_req->query,
348 yaz_add_srw_diagnostic(odr_en,
349 &(sru_pdu_res->u.response->diagnostics),
350 &(sru_pdu_res->u.response->num_diagnostics),
355 z3950_package.request() = apdu;
356 //std::cout << "z3950_search_request " << *apdu << "\n";
358 z3950_package.move();
361 Z_GDU *z3950_gdu = z3950_package.response().get();
362 //std::cout << "z3950_search_request " << *z3950_gdu << "\n";
364 //TODO: check success condition
366 //int yaz_diag_bib1_to_srw (int bib1_code);
367 //int yaz_diag_srw_to_bib1(int srw_code);
368 //Se kode i src/seshigh.c (srw_bend_search, srw_bend_init).
370 if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
371 && z3950_gdu->u.z3950->which == Z_APDU_searchResponse
372 && z3950_gdu->u.z3950->u.searchResponse->searchStatus)
375 Z_SearchResponse *sr = z3950_gdu->u.z3950->u.searchResponse;
378 // srw'fy number of records
379 sru_pdu_res->u.response->numberOfRecords
380 = (int *) odr_malloc(odr_en, sizeof(int *));
381 *(sru_pdu_res->u.response->numberOfRecords) = *(sr->resultCount);
383 // srw'fy nextRecordPosition
384 //sru_pdu_res->u.response->nextRecordPosition
385 // = (int *) odr_malloc(odr_en, sizeof(int *));
386 //*(sru_pdu_res->u.response->nextRecordPosition) = 1;
397 yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
399 Z_SRW_PDU *sru_pdu_res,
400 Z_SRW_searchRetrieveRequest
404 assert(sru_pdu_res->u.response);
410 // no need to work if nobody wants record ..
411 if (!(sr_req->maximumRecords) || 0 == *(sr_req->maximumRecords))
414 bool send_z3950_present = true;
416 // recordXPath unsupported.
417 if (sr_req->recordXPath)
419 send_z3950_present = false;
420 yaz_add_srw_diagnostic(odr_en,
421 &(sru_pdu_res->u.response->diagnostics),
422 &(sru_pdu_res->u.response->num_diagnostics),
426 // resultSetTTL unsupported.
427 // resultSetIdleTime in response
428 if (sr_req->resultSetTTL)
430 send_z3950_present = false;
431 yaz_add_srw_diagnostic(odr_en,
432 &(sru_pdu_res->u.response->diagnostics),
433 &(sru_pdu_res->u.response->num_diagnostics),
438 if (sr_req->sort_type != Z_SRW_sort_type_none)
440 send_z3950_present = false;
441 yaz_add_srw_diagnostic(odr_en,
442 &(sru_pdu_res->u.response->diagnostics),
443 &(sru_pdu_res->u.response->num_diagnostics),
447 // start record requested negative, or larger than number of records
448 if (sr_req->startRecord
450 ((*(sr_req->startRecord) < 0) // negative
452 (sru_pdu_res->u.response->numberOfRecords //out of range
453 && *(sr_req->startRecord)
454 > *(sru_pdu_res->u.response->numberOfRecords))
457 send_z3950_present = false;
458 yaz_add_srw_diagnostic(odr_en,
459 &(sru_pdu_res->u.response->diagnostics),
460 &(sru_pdu_res->u.response->num_diagnostics),
464 // maximumRecords requested negative
465 if (sr_req->maximumRecords
466 && *(sr_req->maximumRecords) < 0)
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),
473 6, "maximumRecords");
476 // exit on all these above diagnostics
477 if (!send_z3950_present)
480 // now packaging the z3950 present request
481 Package z3950_package(package.session(), package.origin());
482 z3950_package.copy_filter(package);
483 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_presentRequest);
485 assert(apdu->u.presentRequest);
487 // z3950'fy start record position
488 if (sr_req->startRecord)
489 *(apdu->u.presentRequest->resultSetStartPoint)
490 = *(sr_req->startRecord);
492 *(apdu->u.presentRequest->resultSetStartPoint) = 1;
494 // z3950'fy number of records requested
495 // protect against requesting records out of range
496 if (sr_req->maximumRecords)
497 *(apdu->u.presentRequest->numberOfRecordsRequested)
498 = std::min(*(sr_req->maximumRecords),
499 *(sru_pdu_res->u.response->numberOfRecords)
500 - *(apdu->u.presentRequest->resultSetStartPoint)
503 // z3950'fy recordPacking
504 int record_packing = Z_SRW_recordPacking_XML;
505 if (sr_req->recordPacking && 's' == *(sr_req->recordPacking))
506 record_packing = Z_SRW_recordPacking_string;
508 // RecordSyntax will always be XML
509 (apdu->u.presentRequest->preferredRecordSyntax)
510 = yaz_oidval_to_z3950oid (odr_en, CLASS_RECSYN, VAL_TEXT_XML);
512 // z3950'fy record schema
513 if (sr_req->recordSchema)
515 apdu->u.presentRequest->recordComposition
516 = (Z_RecordComposition *)
517 odr_malloc(odr_en, sizeof(Z_RecordComposition));
518 apdu->u.presentRequest->recordComposition->which
519 = Z_RecordComp_simple;
520 apdu->u.presentRequest->recordComposition->u.simple
521 = mp_util::build_esn_from_schema(odr_en,
522 (const char *) sr_req->recordSchema);
525 // z3950'fy time to live - flagged as diagnostics above
526 //if (sr_req->resultSetTTL)
528 // attaching Z3950 package to filter chain
529 z3950_package.request() = apdu;
531 //std::cout << "z3950_present_request " << *apdu << "\n";
532 z3950_package.move();
534 //check successful Z3950 present response
535 Z_GDU *z3950_gdu = z3950_package.response().get();
536 if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950
537 || z3950_gdu->u.z3950->which != Z_APDU_presentResponse
538 || !z3950_gdu->u.z3950->u.presentResponse)
541 yaz_add_srw_diagnostic(odr_en,
542 &(sru_pdu_res->u.response->diagnostics),
543 &(sru_pdu_res->u.response->num_diagnostics),
545 package.session().close();
550 // everything fine, continuing
551 //std::cout << "z3950_present_request OK\n";
553 Z_PresentResponse *pr = z3950_gdu->u.z3950->u.presentResponse;
554 Z_SRW_searchRetrieveResponse *sru_res = sru_pdu_res->u.response;
556 // checking non surrogate dioagnostics in Z3950 present response package
558 && pr->records->which == Z_Records_NSD
559 && pr->records->u.nonSurrogateDiagnostic)
562 z3950_to_srw_diag(odr_en, sru_res,
563 pr->records->u.nonSurrogateDiagnostic);
567 // copy all records if existing
568 if (pr->records && pr->records->which == Z_Records_DBOSD)
570 // srw'fy number of returned records
572 = pr->records->u.databaseOrSurDiagnostics->num_records;
575 = (Z_SRW_record *) odr_malloc(odr_en,
577 * sizeof(Z_SRW_record));
580 // srw'fy nextRecordPosition
581 // next position never zero or behind the last z3950 record
582 if (pr->nextResultSetPosition
583 && *(pr->nextResultSetPosition) > 0
584 && *(pr->nextResultSetPosition)
585 <= *(sru_pdu_res->u.response->numberOfRecords))
586 sru_res->nextRecordPosition
587 = odr_intdup(odr_en, *(pr->nextResultSetPosition));
589 // inserting all records
590 for (int i = 0; i < sru_res->num_records; i++)
592 Z_NamePlusRecord *npr
593 = pr->records->u.databaseOrSurDiagnostics->records[i];
595 sru_res->records[i].recordPosition
597 i + *(apdu->u.presentRequest->resultSetStartPoint));
599 sru_res->records[i].recordPacking = record_packing;
601 if (npr->which != Z_NamePlusRecord_databaseRecord)
603 sru_res->records[i].recordSchema = "diagnostic";
604 sru_res->records[i].recordData_buf = "67";
605 sru_res->records[i].recordData_len = 2;
609 Z_External *r = npr->u.databaseRecord;
610 oident *ent = oid_getentbyoid(r->direct_reference);
611 if (r->which == Z_External_octet
612 && ent->value == VAL_TEXT_XML)
614 sru_res->records[i].recordSchema = "dc";
615 sru_res->records[i].recordData_buf
616 = odr_strdupn(odr_en,
617 (const char *)r->u.octet_aligned->buf,
618 r->u.octet_aligned->len);
619 sru_res->records[i].recordData_len
620 = r->u.octet_aligned->len;
624 sru_res->records[i].recordSchema = "diagnostic";
625 sru_res->records[i].recordData_buf = "67";
626 sru_res->records[i].recordData_len = 2;
636 yf::SRUtoZ3950::Impl::z3950_scan_request(mp::Package &package,
638 Z_SRW_PDU *sru_pdu_res,
639 Z_SRW_scanRequest const *sr_req) const
641 assert(sru_pdu_res->u.scan_response);
643 Package z3950_package(package.session(), package.origin());
644 z3950_package.copy_filter(package);
645 //mp::odr odr_en(ODR_ENCODE);
646 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_scanRequest);
648 //TODO: add stuff in apdu
649 Z_ScanRequest *z_scanRequest = apdu->u.scanRequest;
651 // database repackaging
652 z_scanRequest->num_databaseNames = 1;
653 z_scanRequest->databaseNames = (char**)
654 odr_malloc(odr_en, sizeof(char *));
655 if (sr_req->database)
656 z_scanRequest->databaseNames[0]
657 = odr_strdup(odr_en, const_cast<char *>(sr_req->database));
659 z_scanRequest->databaseNames[0]
660 = odr_strdup(odr_en, "Default");
664 // CQL or XCQL scan is not possible in Z3950, flagging a diagnostic
665 if (sr_req->query_type != Z_SRW_query_type_pqf)
667 //send_to_srw_client_error(7, "query");
671 // PQF query repackaging
672 // need to use Z_AttributesPlusTerm structure, not Z_Query
673 // this can be digget out of a
674 // Z_query->type1(Z_RPNQuery)->RPNStructure(Z_RPNStructure)
675 // ->u.simple(Z_Operand)->u.attributesPlusTerm(Z_AttributesPlusTerm )
677 //Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query));
678 //z_searchRequest->query = z_query;
680 //if (!z3950_build_query(odr_en, z_query,
681 // (const SRW_query&)sr_req->query,
682 // sr_req->query_type))
684 //send_to_srw_client_error(7, "query");
690 z3950_package.request() = apdu;
691 std::cout << "z3950_scan_request " << *apdu << "\n";
693 z3950_package.move();
694 //TODO: check success condition
699 bool yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query,
700 const SRW_query &query,
701 SRW_query_type query_type) const
703 if (query_type == Z_SRW_query_type_cql)
705 Z_External *ext = (Z_External *)
706 odr_malloc(odr_en, sizeof(*ext));
707 ext->direct_reference =
708 odr_getoidbystr(odr_en, "1.2.840.10003.16.2");
709 ext->indirect_reference = 0;
711 ext->which = Z_External_CQL;
712 ext->u.cql = const_cast<char *>(query.cql);
714 z_query->which = Z_Query_type_104;
715 z_query->u.type_104 = ext;
719 if (query_type == Z_SRW_query_type_pqf)
721 Z_RPNQuery *RPNquery;
722 YAZ_PQF_Parser pqf_parser;
724 pqf_parser = yaz_pqf_create ();
726 RPNquery = yaz_pqf_parse (pqf_parser, odr_en, query.pqf);
729 std::cout << "TODO: Handeling of bad PQF\n";
730 std::cout << "TODO: Diagnostic to be send\n";
732 z_query->which = Z_Query_type_1;
733 z_query->u.type_1 = RPNquery;
735 yaz_pqf_destroy(pqf_parser);
744 yf::SRUtoZ3950::Impl::z3950_to_srw_diag(mp::odr &odr_en,
745 Z_SRW_searchRetrieveResponse *sru_res,
746 Z_DefaultDiagFormat *ddf) const
748 int bib1_code = *ddf->condition;
749 if (bib1_code == 109)
751 sru_res->num_diagnostics = 1;
752 sru_res->diagnostics = (Z_SRW_diagnostic *)
753 odr_malloc(odr_en, sizeof(*sru_res->diagnostics));
754 yaz_mk_std_diagnostic(odr_en, sru_res->diagnostics,
755 yaz_diag_bib1_to_srw(*ddf->condition),
762 static mp::filter::Base* filter_creator()
764 return new mp::filter::SRUtoZ3950;
768 struct metaproxy_1_filter_struct metaproxy_1_filter_sru_to_z3950 = {
779 * indent-tabs-mode: nil
780 * c-file-style: "stroustrup"
782 * vim: shiftwidth=4 tabstop=8 expandtab