1 /* $Id: filter_sru_to_z3950.cpp,v 1.24 2006-12-28 13:26: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>
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 if (! (sru_pdu_req = mp_util::decode_sru_request(package, odr_de, odr_en,
130 charset, stylesheet)))
132 mp_util::build_simple_explain(package, odr_en, sru_pdu_res, 0);
133 mp_util::build_sru_response(package, odr_en, soap,
134 sru_pdu_res, charset, stylesheet);
135 package.session().close();
140 // SRU request package translation to Z3950 package
142 // std::cout << *sru_pdu_req << "\n";
144 // std::cout << "SRU empty\n";
148 if (sru_pdu_req && sru_pdu_req->which == Z_SRW_explain_request)
150 Z_SRW_explainRequest *er_req = sru_pdu_req->u.explain_request;
151 //sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response);
153 mp_util::build_simple_explain(package, odr_en, sru_pdu_res, er_req);
158 && sru_pdu_req->which == Z_SRW_searchRetrieve_request
159 && sru_pdu_req->u.request)
161 Z_SRW_searchRetrieveRequest *sr_req = sru_pdu_req->u.request;
163 sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_searchRetrieve_response);
165 // checking that we have a query
166 ok = mp_util::check_sru_query_exists(package, odr_en,
167 sru_pdu_res, sr_req);
169 if (ok && z3950_init_request(package))
172 ok = z3950_search_request(package, odr_en,
173 sru_pdu_res, sr_req);
176 && sru_pdu_res->u.response->numberOfRecords
177 && *(sru_pdu_res->u.response->numberOfRecords)
178 && sr_req->maximumRecords
179 && *(sr_req->maximumRecords))
181 ok = z3950_present_request(package, odr_en,
184 z3950_close_request(package);
191 && sru_pdu_req->which == Z_SRW_scan_request
192 && sru_pdu_req->u.scan_request)
194 Z_SRW_scanRequest *sr_req = sru_pdu_req->u.scan_request;
196 sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_scan_response);
198 // we do not do scan at the moment, therefore issuing a diagnostic
199 yaz_add_srw_diagnostic(odr_en,
200 &(sru_pdu_res->u.scan_response->diagnostics),
201 &(sru_pdu_res->u.scan_response->num_diagnostics),
204 // to be used when we do scan
205 if (false && z3950_init_request(package))
207 z3950_scan_request(package, odr_en, sru_pdu_res, sr_req);
208 z3950_close_request(package);
213 //std::cout << "SRU OPERATION NOT SUPPORTED \n";
214 sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response);
216 // TODO: make nice diagnostic return package
217 package.session().close();
221 //mp_util::build_sru_debug_package(package);
222 mp_util::build_sru_response(package, odr_en, soap,
223 sru_pdu_res, charset, stylesheet);
230 yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package,
231 const std::string &database) const
233 // prepare Z3950 package
235 //Package z3950_package(s, package.origin());
236 Package z3950_package(package.session(), package.origin());
237 z3950_package.copy_filter(package);
239 // set initRequest APDU
240 mp::odr odr_en(ODR_ENCODE);
241 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_initRequest);
242 Z_InitRequest *init_req = apdu->u.initRequest;
243 //TODO: add user name in apdu
244 //TODO: add user passwd in apdu
245 //init_req->idAuthentication = org_init->idAuthentication;
246 //init_req->implementationId = "IDxyz";
247 //init_req->implementationName = "NAMExyz";
248 //init_req->implementationVersion = "VERSIONxyz";
250 ODR_MASK_SET(init_req->options, Z_Options_search);
251 ODR_MASK_SET(init_req->options, Z_Options_present);
252 ODR_MASK_SET(init_req->options, Z_Options_namedResultSets);
253 ODR_MASK_SET(init_req->options, Z_Options_scan);
255 ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_1);
256 ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_2);
257 ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_3);
259 z3950_package.request() = apdu;
261 // send Z3950 package
262 // std::cout << "z3950_init_request " << *apdu <<"\n";
263 z3950_package.move();
265 // dead Z3950 backend detection
266 if (z3950_package.session().is_closed()){
267 package.session().close();
271 // check successful initResponse
272 Z_GDU *z3950_gdu = z3950_package.response().get();
274 if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
275 && z3950_gdu->u.z3950->which == Z_APDU_initResponse)
282 yf::SRUtoZ3950::Impl::z3950_close_request(mp::Package &package) const
285 package.session().close();
287 // prepare and close Z3950 package
288 Package z3950_package(package.session(), package.origin());
289 z3950_package.copy_filter(package);
290 z3950_package.session().close();
293 //mp::odr odr_en(ODR_ENCODE);
294 //Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_close);
295 //z3950_package.request() = apdu;
297 z3950_package.move();
299 // check successful close response
300 //Z_GDU *z3950_gdu = z3950_package.response().get();
301 //if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
302 // && z3950_gdu->u.z3950->which == Z_APDU_close)
305 if (z3950_package.session().is_closed()){
312 yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package,
314 Z_SRW_PDU *sru_pdu_res,
315 Z_SRW_searchRetrieveRequest
319 assert(sru_pdu_res->u.response);
321 Package z3950_package(package.session(), package.origin());
322 z3950_package.copy_filter(package);
324 //add stuff in z3950 apdu
325 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_searchRequest);
326 Z_SearchRequest *z_searchRequest = apdu->u.searchRequest;
329 z_searchRequest->num_databaseNames = 1;
330 z_searchRequest->databaseNames = (char**)
331 odr_malloc(odr_en, sizeof(char *));
333 if (sr_req->database)
334 z_searchRequest->databaseNames[0]
335 = odr_strdup(odr_en, const_cast<char *>(sr_req->database));
337 z_searchRequest->databaseNames[0]
338 = odr_strdup(odr_en, "Default");
342 Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query));
343 z_searchRequest->query = z_query;
345 if (!z3950_build_query(odr_en, z_query,
346 (const SRW_query&)sr_req->query,
349 yaz_add_srw_diagnostic(odr_en,
350 &(sru_pdu_res->u.response->diagnostics),
351 &(sru_pdu_res->u.response->num_diagnostics),
356 z3950_package.request() = apdu;
357 //std::cout << "z3950_search_request " << *apdu << "\n";
359 z3950_package.move();
362 Z_GDU *z3950_gdu = z3950_package.response().get();
363 //std::cout << "z3950_search_request " << *z3950_gdu << "\n";
365 //TODO: check success condition
367 //int yaz_diag_bib1_to_srw (int bib1_code);
368 //int yaz_diag_srw_to_bib1(int srw_code);
369 //Se kode i src/seshigh.c (srw_bend_search, srw_bend_init).
371 if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
372 && z3950_gdu->u.z3950->which == Z_APDU_searchResponse
373 && z3950_gdu->u.z3950->u.searchResponse->searchStatus)
376 Z_SearchResponse *sr = z3950_gdu->u.z3950->u.searchResponse;
379 // srw'fy number of records
380 sru_pdu_res->u.response->numberOfRecords
381 = (int *) odr_malloc(odr_en, sizeof(int *));
382 *(sru_pdu_res->u.response->numberOfRecords) = *(sr->resultCount);
384 // srw'fy nextRecordPosition
385 //sru_pdu_res->u.response->nextRecordPosition
386 // = (int *) odr_malloc(odr_en, sizeof(int *));
387 //*(sru_pdu_res->u.response->nextRecordPosition) = 1;
398 yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
400 Z_SRW_PDU *sru_pdu_res,
401 Z_SRW_searchRetrieveRequest
405 assert(sru_pdu_res->u.response);
411 // no need to work if nobody wants record ..
412 if (!(sr_req->maximumRecords) || 0 == *(sr_req->maximumRecords))
415 bool send_z3950_present = true;
417 // recordXPath unsupported.
418 if (sr_req->recordXPath)
420 send_z3950_present = false;
421 yaz_add_srw_diagnostic(odr_en,
422 &(sru_pdu_res->u.response->diagnostics),
423 &(sru_pdu_res->u.response->num_diagnostics),
427 // resultSetTTL unsupported.
428 // resultSetIdleTime in response
429 if (sr_req->resultSetTTL)
431 send_z3950_present = false;
432 yaz_add_srw_diagnostic(odr_en,
433 &(sru_pdu_res->u.response->diagnostics),
434 &(sru_pdu_res->u.response->num_diagnostics),
439 if (sr_req->sort_type != Z_SRW_sort_type_none)
441 send_z3950_present = false;
442 yaz_add_srw_diagnostic(odr_en,
443 &(sru_pdu_res->u.response->diagnostics),
444 &(sru_pdu_res->u.response->num_diagnostics),
448 // start record requested negative, or larger than number of records
449 if (sr_req->startRecord
451 ((*(sr_req->startRecord) < 0) // negative
453 (sru_pdu_res->u.response->numberOfRecords //out of range
454 && *(sr_req->startRecord)
455 > *(sru_pdu_res->u.response->numberOfRecords))
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 // maximumRecords requested negative
466 if (sr_req->maximumRecords
467 && *(sr_req->maximumRecords) < 0)
470 send_z3950_present = false;
471 yaz_add_srw_diagnostic(odr_en,
472 &(sru_pdu_res->u.response->diagnostics),
473 &(sru_pdu_res->u.response->num_diagnostics),
474 6, "maximumRecords");
477 // exit on all these above diagnostics
478 if (!send_z3950_present)
481 // now packaging the z3950 present request
482 Package z3950_package(package.session(), package.origin());
483 z3950_package.copy_filter(package);
484 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_presentRequest);
486 assert(apdu->u.presentRequest);
488 // z3950'fy start record position
489 if (sr_req->startRecord)
490 *(apdu->u.presentRequest->resultSetStartPoint)
491 = *(sr_req->startRecord);
493 *(apdu->u.presentRequest->resultSetStartPoint) = 1;
495 // z3950'fy number of records requested
496 // protect against requesting records out of range
497 if (sr_req->maximumRecords)
498 *(apdu->u.presentRequest->numberOfRecordsRequested)
499 = std::min(*(sr_req->maximumRecords),
500 *(sru_pdu_res->u.response->numberOfRecords)
501 - *(apdu->u.presentRequest->resultSetStartPoint)
504 // z3950'fy recordPacking
505 int record_packing = Z_SRW_recordPacking_XML;
506 if (sr_req->recordPacking && 's' == *(sr_req->recordPacking))
507 record_packing = Z_SRW_recordPacking_string;
509 // RecordSyntax will always be XML
510 (apdu->u.presentRequest->preferredRecordSyntax)
511 = yaz_oidval_to_z3950oid (odr_en, CLASS_RECSYN, VAL_TEXT_XML);
513 // z3950'fy record schema
514 if (sr_req->recordSchema)
516 apdu->u.presentRequest->recordComposition
517 = (Z_RecordComposition *)
518 odr_malloc(odr_en, sizeof(Z_RecordComposition));
519 apdu->u.presentRequest->recordComposition->which
520 = Z_RecordComp_simple;
521 apdu->u.presentRequest->recordComposition->u.simple
522 = mp_util::build_esn_from_schema(odr_en,
523 (const char *) sr_req->recordSchema);
526 // z3950'fy time to live - flagged as diagnostics above
527 //if (sr_req->resultSetTTL)
529 // attaching Z3950 package to filter chain
530 z3950_package.request() = apdu;
532 //std::cout << "z3950_present_request " << *apdu << "\n";
533 z3950_package.move();
535 //check successful Z3950 present response
536 Z_GDU *z3950_gdu = z3950_package.response().get();
537 if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950
538 || z3950_gdu->u.z3950->which != Z_APDU_presentResponse
539 || !z3950_gdu->u.z3950->u.presentResponse)
542 yaz_add_srw_diagnostic(odr_en,
543 &(sru_pdu_res->u.response->diagnostics),
544 &(sru_pdu_res->u.response->num_diagnostics),
546 package.session().close();
551 // everything fine, continuing
552 //std::cout << "z3950_present_request OK\n";
554 Z_PresentResponse *pr = z3950_gdu->u.z3950->u.presentResponse;
555 Z_SRW_searchRetrieveResponse *sru_res = sru_pdu_res->u.response;
557 // checking non surrogate dioagnostics in Z3950 present response package
559 && pr->records->which == Z_Records_NSD
560 && pr->records->u.nonSurrogateDiagnostic)
563 z3950_to_srw_diag(odr_en, sru_res,
564 pr->records->u.nonSurrogateDiagnostic);
568 // copy all records if existing
569 if (pr->records && pr->records->which == Z_Records_DBOSD)
571 // srw'fy number of returned records
573 = pr->records->u.databaseOrSurDiagnostics->num_records;
576 = (Z_SRW_record *) odr_malloc(odr_en,
578 * sizeof(Z_SRW_record));
581 // srw'fy nextRecordPosition
582 // next position never zero or behind the last z3950 record
583 if (pr->nextResultSetPosition
584 && *(pr->nextResultSetPosition) > 0
585 && *(pr->nextResultSetPosition)
586 <= *(sru_pdu_res->u.response->numberOfRecords))
587 sru_res->nextRecordPosition
588 = odr_intdup(odr_en, *(pr->nextResultSetPosition));
590 // inserting all records
591 for (int i = 0; i < sru_res->num_records; i++)
593 Z_NamePlusRecord *npr
594 = pr->records->u.databaseOrSurDiagnostics->records[i];
596 sru_res->records[i].recordPosition
598 i + *(apdu->u.presentRequest->resultSetStartPoint));
600 sru_res->records[i].recordPacking = record_packing;
602 if (npr->which != Z_NamePlusRecord_databaseRecord)
604 sru_res->records[i].recordSchema = "diagnostic";
605 sru_res->records[i].recordData_buf = "67";
606 sru_res->records[i].recordData_len = 2;
610 Z_External *r = npr->u.databaseRecord;
611 oident *ent = oid_getentbyoid(r->direct_reference);
612 if (r->which == Z_External_octet
613 && ent->value == VAL_TEXT_XML)
615 sru_res->records[i].recordSchema = "dc";
616 sru_res->records[i].recordData_buf
617 = odr_strdupn(odr_en,
618 (const char *)r->u.octet_aligned->buf,
619 r->u.octet_aligned->len);
620 sru_res->records[i].recordData_len
621 = r->u.octet_aligned->len;
625 sru_res->records[i].recordSchema = "diagnostic";
626 sru_res->records[i].recordData_buf = "67";
627 sru_res->records[i].recordData_len = 2;
637 yf::SRUtoZ3950::Impl::z3950_scan_request(mp::Package &package,
639 Z_SRW_PDU *sru_pdu_res,
640 Z_SRW_scanRequest const *sr_req) const
642 assert(sru_pdu_res->u.scan_response);
644 Package z3950_package(package.session(), package.origin());
645 z3950_package.copy_filter(package);
646 //mp::odr odr_en(ODR_ENCODE);
647 Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_scanRequest);
649 //TODO: add stuff in apdu
650 Z_ScanRequest *z_scanRequest = apdu->u.scanRequest;
652 // database repackaging
653 z_scanRequest->num_databaseNames = 1;
654 z_scanRequest->databaseNames = (char**)
655 odr_malloc(odr_en, sizeof(char *));
656 if (sr_req->database)
657 z_scanRequest->databaseNames[0]
658 = odr_strdup(odr_en, const_cast<char *>(sr_req->database));
660 z_scanRequest->databaseNames[0]
661 = odr_strdup(odr_en, "Default");
665 // CQL or XCQL scan is not possible in Z3950, flagging a diagnostic
666 if (sr_req->query_type != Z_SRW_query_type_pqf)
668 //send_to_srw_client_error(7, "query");
672 // PQF query repackaging
673 // need to use Z_AttributesPlusTerm structure, not Z_Query
674 // this can be digget out of a
675 // Z_query->type1(Z_RPNQuery)->RPNStructure(Z_RPNStructure)
676 // ->u.simple(Z_Operand)->u.attributesPlusTerm(Z_AttributesPlusTerm )
678 //Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query));
679 //z_searchRequest->query = z_query;
681 //if (!z3950_build_query(odr_en, z_query,
682 // (const SRW_query&)sr_req->query,
683 // sr_req->query_type))
685 //send_to_srw_client_error(7, "query");
691 z3950_package.request() = apdu;
692 std::cout << "z3950_scan_request " << *apdu << "\n";
694 z3950_package.move();
695 //TODO: check success condition
700 bool yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query,
701 const SRW_query &query,
702 SRW_query_type query_type) const
704 if (query_type == Z_SRW_query_type_cql)
706 Z_External *ext = (Z_External *)
707 odr_malloc(odr_en, sizeof(*ext));
708 ext->direct_reference =
709 odr_getoidbystr(odr_en, "1.2.840.10003.16.2");
710 ext->indirect_reference = 0;
712 ext->which = Z_External_CQL;
713 ext->u.cql = const_cast<char *>(query.cql);
715 z_query->which = Z_Query_type_104;
716 z_query->u.type_104 = ext;
720 if (query_type == Z_SRW_query_type_pqf)
722 Z_RPNQuery *RPNquery;
723 YAZ_PQF_Parser pqf_parser;
725 pqf_parser = yaz_pqf_create ();
727 RPNquery = yaz_pqf_parse (pqf_parser, odr_en, query.pqf);
730 std::cout << "TODO: Handeling of bad PQF\n";
731 std::cout << "TODO: Diagnostic to be send\n";
733 z_query->which = Z_Query_type_1;
734 z_query->u.type_1 = RPNquery;
736 yaz_pqf_destroy(pqf_parser);
745 yf::SRUtoZ3950::Impl::z3950_to_srw_diag(mp::odr &odr_en,
746 Z_SRW_searchRetrieveResponse *sru_res,
747 Z_DefaultDiagFormat *ddf) const
749 int bib1_code = *ddf->condition;
750 if (bib1_code == 109)
752 sru_res->num_diagnostics = 1;
753 sru_res->diagnostics = (Z_SRW_diagnostic *)
754 odr_malloc(odr_en, sizeof(*sru_res->diagnostics));
755 yaz_mk_std_diagnostic(odr_en, sru_res->diagnostics,
756 yaz_diag_bib1_to_srw(*ddf->condition),
763 static mp::filter::Base* filter_creator()
765 return new mp::filter::SRUtoZ3950;
769 struct metaproxy_1_filter_struct metaproxy_1_filter_sru_to_z3950 = {
780 * indent-tabs-mode: nil
781 * c-file-style: "stroustrup"
783 * vim: shiftwidth=4 tabstop=8 expandtab