src/filter_sru_to_z3950.cpp

   1 /* This file is part of Metaproxy.
   2    Copyright (C) 2005-2010 Index Data
   3
   4 Metaproxy is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17 */
  18
  19 // make std::min actually work on Windows
  20 #define NOMINMAX 1
  21
  22 #include "config.hpp"
  23 #include <metaproxy/package.hpp>
  24 #include <metaproxy/util.hpp>
  25 #include "gduutil.hpp"
  26 #include "sru_util.hpp"
  27 #include "filter_sru_to_z3950.hpp"
  28
  29 #include <yaz/zgdu.h>
  30 #include <yaz/z-core.h>
  31 #include <yaz/srw.h>
  32 #include <yaz/pquery.h>
  33 #include <yaz/oid_db.h>
  34 #include <yaz/log.h>
  35
  36 #include <boost/thread/mutex.hpp>
  37 #include <boost/thread/condition.hpp>
  38
  39 #include <iostream>
  40 #include <sstream>
  41 #include <string>
  42 /* #include <algorithm> */
  43 #include <map>
  44
  45 namespace mp = metaproxy_1;
  46 namespace mp_util = metaproxy_1::util;
  47 namespace yf = mp::filter;
  48
  49 namespace metaproxy_1 {
  50     namespace filter {
  51         class SRUtoZ3950::Impl {
  52         public:
  53             void configure(const xmlNode *xmlnode);
  54             void process(metaproxy_1::Package &package);
  55         private:
  56             std::map<std::string, const xmlNode *> m_database_explain;
  57
  58             typedef std::map<std::string, int> ActiveUrlMap;
  59
  60             boost::mutex m_mutex;
  61             boost::condition m_cond_url_ready;
  62             ActiveUrlMap m_active_urls;
  63         private:
  64             void sru(metaproxy_1::Package &package, Z_GDU *zgdu_req);
  65             int z3950_build_query(
  66                 mp::odr &odr_en, Z_Query *z_query,
  67                 const Z_SRW_searchRetrieveRequest *req
  68                 ) const;
  69
  70             bool z3950_init_request(
  71                 mp::Package &package,
  72                 mp::odr &odr_en,
  73                 std::string zurl,
  74                 Z_SRW_PDU *sru_pdu_res,
  75                 const Z_SRW_PDU *sru_pdu_req
  76                 ) const;
  77
  78             bool z3950_close_request(mp::Package &package) const;
  79
  80             bool z3950_search_request(
  81                 mp::Package &package,
  82                 mp::odr &odr_en,
  83                 Z_SRW_PDU *sru_pdu_res,
  84                 Z_SRW_searchRetrieveRequest const *sr_req,
  85                 std::string zurl
  86                 ) const;
  87
  88             bool z3950_present_request(
  89                 mp::Package &package,
  90                 mp::odr &odr_en,
  91                 Z_SRW_PDU *sru_pdu_res,
  92                 Z_SRW_searchRetrieveRequest const *sr_req
  93                 ) const;
  94
  95             bool z3950_to_srw_diagnostics_ok(
  96                 mp::odr &odr_en,
  97                 Z_SRW_searchRetrieveResponse *srw_res,
  98                 Z_Records *records
  99                 ) const;
 100
 101             int z3950_to_srw_diag(
 102                 mp::odr &odr_en,
 103                 Z_SRW_searchRetrieveResponse *srw_res,
 104                 Z_DefaultDiagFormat *ddf
 105                 ) const;
 106
 107         };
 108     }
 109 }
 110
 111 yf::SRUtoZ3950::SRUtoZ3950() : m_p(new Impl)
 112 {
 113 }
 114
 115 yf::SRUtoZ3950::~SRUtoZ3950()
 116 {  // must have a destructor because of boost::scoped_ptr
 117 }
 118
 119 void yf::SRUtoZ3950::configure(const xmlNode *xmlnode, bool test_only)
 120 {
 121     m_p->configure(xmlnode);
 122 }
 123
 124 void yf::SRUtoZ3950::process(mp::Package &package) const
 125 {
 126     m_p->process(package);
 127 }
 128
 129 void yf::SRUtoZ3950::Impl::configure(const xmlNode *confignode)
 130 {
 131     const xmlNode * dbnode;
 132
 133     for (dbnode = confignode->children; dbnode; dbnode = dbnode->next)
 134     {
 135         if (dbnode->type != XML_ELEMENT_NODE)
 136             continue;
 137
 138         std::string database;
 139         mp::xml::check_element_mp(dbnode, "database");
 140
 141         for (struct _xmlAttr *attr = dbnode->properties;
 142              attr; attr = attr->next)
 143         {
 144
 145             mp::xml::check_attribute(attr, "", "name");
 146             database = mp::xml::get_text(attr);
 147
 148             const xmlNode *explainnode;
 149             for (explainnode = dbnode->children;
 150                  explainnode; explainnode = explainnode->next)
 151             {
 152                 if (explainnode->type != XML_ELEMENT_NODE)
 153                     continue;
 154                 if (explainnode)
 155                     break;
 156             }
 157             // assigning explain node to database name - no check yet
 158             m_database_explain.insert(std::make_pair(database, explainnode));
 159         }
 160     }
 161 }
 162
 163 void yf::SRUtoZ3950::Impl::sru(mp::Package &package, Z_GDU *zgdu_req)
 164 {
 165     bool ok = true;
 166
 167     mp::odr odr_de(ODR_DECODE);
 168     Z_SRW_PDU *sru_pdu_req = 0;
 169
 170     mp::odr odr_en(ODR_ENCODE);
 171     Z_SRW_PDU *sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response);
 172
 173     // determine database with the HTTP header information only
 174     mp_util::SRUServerInfo sruinfo = mp_util::get_sru_server_info(package);
 175     std::map<std::string, const xmlNode *>::iterator idbexp;
 176     idbexp = m_database_explain.find(sruinfo.database);
 177
 178     // assign explain config XML DOM node if database is known
 179     const xmlNode *explainnode = 0;
 180     if (idbexp != m_database_explain.end())
 181     {
 182         explainnode = idbexp->second;
 183     }
 184
 185     // decode SRU request
 186     Z_SOAP *soap = 0;
 187     char *charset = 0;
 188     char *stylesheet = 0;
 189
 190     // filter acts as sink for non-valid SRU requests
 191     if (! (sru_pdu_req = mp_util::decode_sru_request(package, odr_de, odr_en,
 192                                                      sru_pdu_res, &soap,
 193                                                      charset, stylesheet)))
 194     {
 195         if (soap)
 196         {
 197             mp_util::build_sru_explain(package, odr_en, sru_pdu_res,
 198                                        sruinfo, explainnode);
 199             mp_util::build_sru_response(package, odr_en, soap,
 200                                         sru_pdu_res, charset, stylesheet);
 201         }
 202         else
 203         {
 204             metaproxy_1::odr odr;
 205             Z_GDU *zgdu_res =
 206                 odr.create_HTTP_Response(package.session(),
 207                                          zgdu_req->u.HTTP_Request, 400);
 208             package.response() = zgdu_res;
 209         }
 210         return;
 211     }
 212
 213     std::string zurl;
 214     Z_SRW_extra_arg *arg;
 215
 216     for ( arg = sru_pdu_req->extra_args; arg; arg = arg->next)
 217         if (!strcmp(arg->name, "x-target"))
 218         {
 219             zurl = std::string(arg->value);
 220         }
 221         else if (!strcmp(arg->name, "x-max-sockets"))
 222         {
 223             package.origin().set_max_sockets(atoi(arg->value));
 224         }
 225
 226     assert(sru_pdu_req);
 227
 228     // filter acts as sink for SRU explain requests
 229     if (sru_pdu_req->which == Z_SRW_explain_request)
 230     {
 231         Z_SRW_explainRequest *er_req = sru_pdu_req->u.explain_request;
 232         //mp_util::build_simple_explain(package, odr_en, sru_pdu_res,
 233         //                           sruinfo, er_req);
 234         mp_util::build_sru_explain(package, odr_en, sru_pdu_res,
 235                                    sruinfo, explainnode, er_req);
 236     }
 237     else if (sru_pdu_req->which == Z_SRW_searchRetrieve_request
 238              && sru_pdu_req->u.request)
 239     {   // searchRetrieve
 240         Z_SRW_searchRetrieveRequest *sr_req = sru_pdu_req->u.request;
 241
 242         sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_searchRetrieve_response);
 243
 244         // checking that we have a query
 245         ok = mp_util::check_sru_query_exists(package, odr_en,
 246                                              sru_pdu_res, sr_req);
 247
 248         if (ok && z3950_init_request(package, odr_en,
 249                                      zurl, sru_pdu_res, sru_pdu_req))
 250         {
 251             ok = z3950_search_request(package, odr_en,
 252                                       sru_pdu_res, sr_req, zurl);
 253
 254             if (ok
 255                 && sru_pdu_res->u.response->numberOfRecords
 256                 && *(sru_pdu_res->u.response->numberOfRecords))
 257
 258                 ok = z3950_present_request(package, odr_en,
 259                                            sru_pdu_res,
 260                                            sr_req);
 261             z3950_close_request(package);
 262         }
 263     }
 264
 265     // scan
 266     else if (sru_pdu_req->which == Z_SRW_scan_request
 267              && sru_pdu_req->u.scan_request)
 268     {
 269         sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_scan_response);
 270
 271         // we do not do scan at the moment, therefore issuing a diagnostic
 272         yaz_add_srw_diagnostic(odr_en,
 273                                &(sru_pdu_res->u.scan_response->diagnostics),
 274                                &(sru_pdu_res->u.scan_response->num_diagnostics),
 275                                YAZ_SRW_UNSUPP_OPERATION, "scan");
 276     }
 277     else
 278     {
 279         sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response);
 280
 281         yaz_add_srw_diagnostic(odr_en,
 282                                &(sru_pdu_res->u.explain_response->diagnostics),
 283                                &(sru_pdu_res->u.explain_response->num_diagnostics),
 284                                YAZ_SRW_UNSUPP_OPERATION, "unknown");
 285     }
 286
 287     // build and send SRU response
 288     mp_util::build_sru_response(package, odr_en, soap,
 289                                 sru_pdu_res, charset, stylesheet);
 290 }
 291
 292
 293 void yf::SRUtoZ3950::Impl::process(mp::Package &package)
 294 {
 295     Z_GDU *zgdu_req = package.request().get();
 296
 297     // ignoring all non HTTP_Request packages
 298     if (!zgdu_req || !(zgdu_req->which == Z_GDU_HTTP_Request))
 299     {
 300         package.move();
 301         return;
 302     }
 303
 304     // only working on HTTP_Request packages now
 305
 306     // see if HTTP request is already being executed..
 307     // we consider only the SRU - GET case..
 308     if (zgdu_req->u.HTTP_Request->content_len == 0)
 309     {
 310         const char *path = zgdu_req->u.HTTP_Request->path;
 311         boost::mutex::scoped_lock lock(m_mutex);
 312         while (1)
 313         {
 314             ActiveUrlMap::iterator it = m_active_urls.find(path);
 315             if (it == m_active_urls.end())
 316             {
 317                 m_active_urls[path] = 1;
 318                 break;
 319             }
 320             yaz_log(YLOG_LOG, "Waiting for %s to complete", path);
 321             m_cond_url_ready.wait(lock);
 322         }
 323     }
 324     sru(package, zgdu_req);
 325     if (zgdu_req->u.HTTP_Request->content_len == 0)
 326     {
 327         const char *path = zgdu_req->u.HTTP_Request->path;
 328         boost::mutex::scoped_lock lock(m_mutex);
 329
 330         ActiveUrlMap::iterator it = m_active_urls.find(path);
 331
 332         m_active_urls.erase(it);
 333         m_cond_url_ready.notify_all();
 334     }
 335 }
 336
 337
 338 bool
 339 yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package,
 340                                          mp::odr &odr_en,
 341                                          std::string zurl,
 342                                          Z_SRW_PDU *sru_pdu_res,
 343                                          const Z_SRW_PDU *sru_pdu_req) const
 344 {
 345     // prepare Z3950 package
 346     Package z3950_package(package.session(), package.origin());
 347     z3950_package.copy_filter(package);
 348
 349     // set initRequest APDU
 350     Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_initRequest);
 351     Z_InitRequest *init_req = apdu->u.initRequest;
 352
 353     Z_IdAuthentication *auth = NULL;
 354     if (sru_pdu_req->username && !sru_pdu_req->password)
 355     {
 356         auth = (Z_IdAuthentication *) odr_malloc(odr_en, sizeof(Z_IdAuthentication));
 357         auth->which = Z_IdAuthentication_open;
 358         auth->u.open = odr_strdup(odr_en, sru_pdu_req->username);
 359     }
 360     else if (sru_pdu_req->username && sru_pdu_req->password)
 361     {
 362         auth = (Z_IdAuthentication *) odr_malloc(odr_en, sizeof(Z_IdAuthentication));
 363         auth->which = Z_IdAuthentication_idPass;
 364         auth->u.idPass = (Z_IdPass *) odr_malloc(odr_en, sizeof(Z_IdPass));
 365         auth->u.idPass->groupId = NULL;
 366         auth->u.idPass->password = odr_strdup(odr_en, sru_pdu_req->password);
 367         auth->u.idPass->userId = odr_strdup(odr_en, sru_pdu_req->username);
 368     }
 369
 370     init_req->idAuthentication = auth;
 371
 372     ODR_MASK_SET(init_req->options, Z_Options_search);
 373     ODR_MASK_SET(init_req->options, Z_Options_present);
 374     ODR_MASK_SET(init_req->options, Z_Options_namedResultSets);
 375     ODR_MASK_SET(init_req->options, Z_Options_scan);
 376
 377     ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_1);
 378     ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_2);
 379     ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_3);
 380
 381     if (zurl.length())
 382     {
 383         std::string host;
 384         std::list<std::string> dblist;
 385         mp_util::split_zurl(zurl, host, dblist);
 386         mp_util::set_vhost_otherinfo(&init_req->otherInfo, odr_en, host, 1);
 387     }
 388
 389     z3950_package.request() = apdu;
 390
 391     // send Z3950 package
 392     z3950_package.move();
 393
 394     // dead Z3950 backend detection
 395     if (z3950_package.session().is_closed())
 396     {
 397         yaz_add_srw_diagnostic(odr_en,
 398                                &(sru_pdu_res->u.response->diagnostics),
 399                                &(sru_pdu_res->u.response->num_diagnostics),
 400                                YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0);
 401         return false;
 402     }
 403
 404     // check successful initResponse
 405     Z_GDU *z3950_gdu = z3950_package.response().get();
 406
 407     if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
 408         && z3950_gdu->u.z3950->which == Z_APDU_initResponse
 409         && *z3950_gdu->u.z3950->u.initResponse->result)
 410         return true;
 411
 412     yaz_add_srw_diagnostic(odr_en,
 413                            &(sru_pdu_res->u.response->diagnostics),
 414                            &(sru_pdu_res->u.response->num_diagnostics),
 415                            YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0);
 416     return false;
 417 }
 418
 419 bool
 420 yf::SRUtoZ3950::Impl::z3950_close_request(mp::Package &package) const
 421 {
 422     // prepare and close Z3950 package
 423     Package z3950_package(package.session(), package.origin());
 424     z3950_package.copy_filter(package);
 425     z3950_package.session().close();
 426
 427     // set close APDU
 428     //mp::odr odr_en(ODR_ENCODE);
 429     //Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_close);
 430     //z3950_package.request() = apdu;
 431
 432     z3950_package.move();
 433
 434     // check successful close response
 435     //Z_GDU *z3950_gdu = z3950_package.response().get();
 436     //if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
 437     //    && z3950_gdu->u.z3950->which == Z_APDU_close)
 438     //    return true;
 439
 440     if (z3950_package.session().is_closed())
 441     {
 442         return true;
 443     }
 444     return false;
 445 }
 446
 447 bool yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package,
 448                                                 mp::odr &odr_en,
 449                                                 Z_SRW_PDU *sru_pdu_res,
 450                                                 Z_SRW_searchRetrieveRequest
 451                                                 const *sr_req,
 452                                                 std::string zurl) const
 453 {
 454
 455     assert(sru_pdu_res->u.response);
 456
 457     Package z3950_package(package.session(), package.origin());
 458     z3950_package.copy_filter(package);
 459
 460     //add stuff in z3950 apdu
 461     Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_searchRequest);
 462     Z_SearchRequest *z_searchRequest = apdu->u.searchRequest;
 463
 464
 465     if (!mp_util::set_databases_from_zurl(odr_en, zurl,
 466                                           &z_searchRequest->num_databaseNames,
 467                                           &z_searchRequest->databaseNames))
 468     {
 469         z_searchRequest->num_databaseNames = 1;
 470         z_searchRequest->databaseNames = (char**)
 471             odr_malloc(odr_en, sizeof(char *));
 472
 473         if (sr_req->database)
 474             z_searchRequest->databaseNames[0]
 475                 = odr_strdup(odr_en, const_cast<char *>(sr_req->database));
 476         else
 477             z_searchRequest->databaseNames[0]
 478                 = odr_strdup(odr_en, "Default");
 479     }
 480
 481     // z3950'fy query
 482     Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query));
 483     z_searchRequest->query = z_query;
 484
 485     int sru_diagnostic = z3950_build_query(odr_en, z_query, sr_req);
 486     if (sru_diagnostic)
 487     {
 488         yaz_add_srw_diagnostic(odr_en,
 489                                &(sru_pdu_res->u.response->diagnostics),
 490                                &(sru_pdu_res->u.response->num_diagnostics),
 491                                sru_diagnostic,
 492                                "query");
 493         return false;
 494     }
 495
 496     z3950_package.request() = apdu;
 497
 498     // send Z39.50 package off to backend
 499     z3950_package.move();
 500
 501
 502     Z_GDU *z3950_gdu = z3950_package.response().get();
 503
 504     //TODO: check success condition
 505     //int yaz_diag_bib1_to_srw (int bib1_code);
 506     //int yaz_diag_srw_to_bib1(int srw_code);
 507     //Se kode i src/seshigh.c (srw_bend_search, srw_bend_init).
 508
 509     if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950
 510         || z3950_gdu->u.z3950->which != Z_APDU_searchResponse
 511         || !z3950_gdu->u.z3950->u.searchResponse
 512         || !z3950_gdu->u.z3950->u.searchResponse->searchStatus)
 513     {
 514         yaz_add_srw_diagnostic(odr_en,
 515                                &(sru_pdu_res->u.response->diagnostics),
 516                                &(sru_pdu_res->u.response->num_diagnostics),
 517                                YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0);
 518         return false;
 519     }
 520
 521     // everything fine, continuing
 522     Z_SearchResponse *sr = z3950_gdu->u.z3950->u.searchResponse;
 523
 524     // checking non surrogate diagnostics in Z3950 search response package
 525     if (!z3950_to_srw_diagnostics_ok(odr_en, sru_pdu_res->u.response,
 526                                      sr->records))
 527     {
 528         return false;
 529     }
 530
 531     // Finally, roll on and srw'fy number of records
 532     sru_pdu_res->u.response->numberOfRecords
 533         = odr_intdup(odr_en, *sr->resultCount);
 534
 535     // srw'fy nextRecordPosition
 536     //sru_pdu_res->u.response->nextRecordPosition
 537     //    = (int *) odr_malloc(odr_en, sizeof(int *));
 538     //*(sru_pdu_res->u.response->nextRecordPosition) = 1;
 539
 540     return true;
 541 }
 542
 543 bool
 544 yf::SRUtoZ3950::Impl::z3950_present_request(
 545     mp::Package &package,
 546     mp::odr &odr_en,
 547     Z_SRW_PDU *sru_pdu_res,
 548     const Z_SRW_searchRetrieveRequest *sr_req)
 549     const
 550 {
 551     assert(sru_pdu_res->u.response);
 552     int start = 1;
 553     int max_recs = 0;
 554
 555     if (!sr_req)
 556         return false;
 557
 558     if (sr_req->maximumRecords)
 559         max_recs = *sr_req->maximumRecords;
 560     if (sr_req->startRecord)
 561         start = *sr_req->startRecord;
 562
 563     // no need to work if nobody wants record ..
 564     if (max_recs == 0)
 565         return true;
 566
 567     bool send_z3950_present = true;
 568
 569     // recordXPath unsupported.
 570     if (sr_req->recordXPath)
 571     {
 572         send_z3950_present = false;
 573         yaz_add_srw_diagnostic(odr_en,
 574                                &(sru_pdu_res->u.response->diagnostics),
 575                                &(sru_pdu_res->u.response->num_diagnostics),
 576                                YAZ_SRW_XPATH_RETRIEVAL_UNSUPP, 0);
 577     }
 578
 579     // resultSetTTL unsupported.
 580     // resultSetIdleTime in response
 581     if (sr_req->resultSetTTL)
 582     {
 583         send_z3950_present = false;
 584         yaz_add_srw_diagnostic(odr_en,
 585                                &(sru_pdu_res->u.response->diagnostics),
 586                                &(sru_pdu_res->u.response->num_diagnostics),
 587                                YAZ_SRW_RESULT_SETS_UNSUPP, 0);
 588     }
 589
 590     // sort unsupported
 591     if (sr_req->sort_type != Z_SRW_sort_type_none)
 592     {
 593         send_z3950_present = false;
 594         yaz_add_srw_diagnostic(odr_en,
 595                                &(sru_pdu_res->u.response->diagnostics),
 596                                &(sru_pdu_res->u.response->num_diagnostics),
 597                                YAZ_SRW_SORT_UNSUPP, 0);
 598     }
 599
 600     // start record requested negative, or larger than number of records
 601     if (start < 0 || start > *sru_pdu_res->u.response->numberOfRecords)
 602     {
 603         send_z3950_present = false;
 604         yaz_add_srw_diagnostic(odr_en,
 605                                &(sru_pdu_res->u.response->diagnostics),
 606                                &(sru_pdu_res->u.response->num_diagnostics),
 607                                YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
 608     }
 609
 610     // maximumRecords requested negative
 611     if (max_recs < 0)
 612     {
 613         send_z3950_present = false;
 614         yaz_add_srw_diagnostic(odr_en,
 615                                &(sru_pdu_res->u.response->diagnostics),
 616                                &(sru_pdu_res->u.response->num_diagnostics),
 617                                YAZ_SRW_UNSUPP_PARAMETER_VALUE,
 618                                "maximumRecords");
 619     }
 620
 621     // exit on all these above diagnostics
 622     if (!send_z3950_present)
 623         return false;
 624
 625     if (max_recs > *sru_pdu_res->u.response->numberOfRecords - start)
 626         max_recs = *sru_pdu_res->u.response->numberOfRecords - start + 1;
 627
 628     Z_SRW_searchRetrieveResponse *sru_res = sru_pdu_res->u.response;
 629     sru_res->records = (Z_SRW_record *)
 630         odr_malloc(odr_en, max_recs * sizeof(Z_SRW_record));
 631     int num = 0;
 632     while (num < max_recs)
 633     {
 634         // now packaging the z3950 present request
 635         Package z3950_package(package.session(), package.origin());
 636         z3950_package.copy_filter(package);
 637         Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_presentRequest);
 638
 639         assert(apdu->u.presentRequest);
 640
 641         *apdu->u.presentRequest->resultSetStartPoint = start + num;
 642         *apdu->u.presentRequest->numberOfRecordsRequested = max_recs - num;
 643
 644         // set response packing to be same as "request" packing..
 645         int record_packing = Z_SRW_recordPacking_XML;
 646         if (sr_req->recordPacking && 's' == *(sr_req->recordPacking))
 647             record_packing = Z_SRW_recordPacking_string;
 648
 649         // RecordSyntax will always be XML
 650         apdu->u.presentRequest->preferredRecordSyntax
 651             = odr_oiddup(odr_en, yaz_oid_recsyn_xml);
 652
 653         // z3950'fy record schema
 654         if (sr_req->recordSchema)
 655         {
 656             apdu->u.presentRequest->recordComposition
 657                 = (Z_RecordComposition *)
 658                 odr_malloc(odr_en, sizeof(Z_RecordComposition));
 659             apdu->u.presentRequest->recordComposition->which
 660                 = Z_RecordComp_simple;
 661             apdu->u.presentRequest->recordComposition->u.simple
 662                 = mp_util::build_esn_from_schema(odr_en,
 663                                                  (const char *)
 664                                                  sr_req->recordSchema);
 665         }
 666
 667         // attaching Z3950 package to filter chain
 668         z3950_package.request() = apdu;
 669
 670         // sending Z30.50 present request
 671         z3950_package.move();
 672
 673         //check successful Z3950 present response
 674         Z_GDU *z3950_gdu = z3950_package.response().get();
 675         if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950
 676             || z3950_gdu->u.z3950->which != Z_APDU_presentResponse
 677             || !z3950_gdu->u.z3950->u.presentResponse)
 678
 679         {
 680             yaz_add_srw_diagnostic(odr_en,
 681                                    &(sru_pdu_res->u.response->diagnostics),
 682                                    &(sru_pdu_res->u.response->num_diagnostics),
 683                                    YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0);
 684             return false;
 685         }
 686         // everything fine, continuing
 687
 688         Z_PresentResponse *pr = z3950_gdu->u.z3950->u.presentResponse;
 689
 690         // checking non surrogate diagnostics in Z3950 present response package
 691         if (!z3950_to_srw_diagnostics_ok(odr_en, sru_pdu_res->u.response,
 692                                          pr->records))
 693             return false;
 694
 695         // if anything but database or surrogate diagnostics, stop
 696         if (!pr->records || pr->records->which != Z_Records_DBOSD)
 697             break;
 698         else
 699         {
 700             // inserting all records
 701             int returned_recs =
 702                 pr->records->u.databaseOrSurDiagnostics->num_records;
 703             for (int i = 0; i < returned_recs; i++)
 704             {
 705                 int position = i + *apdu->u.presentRequest->resultSetStartPoint;
 706                 Z_NamePlusRecord *npr
 707                     = pr->records->u.databaseOrSurDiagnostics->records[i];
 708
 709                 sru_res->records[i + num].recordPacking = record_packing;
 710
 711                 if (npr->which == Z_NamePlusRecord_databaseRecord &&
 712                     npr->u.databaseRecord->direct_reference
 713                     && !oid_oidcmp(npr->u.databaseRecord->direct_reference,
 714                                    yaz_oid_recsyn_xml))
 715                 {
 716                     // got XML record back
 717                     Z_External *r = npr->u.databaseRecord;
 718                     sru_res->records[i + num].recordPosition =
 719                         odr_intdup(odr_en, position);
 720                     sru_res->records[i + num].recordSchema = sr_req->recordSchema;
 721                     sru_res->records[i + num].recordData_buf
 722                         = odr_strdupn(odr_en,
 723                                       (const char *)r->u.octet_aligned->buf,
 724                                       r->u.octet_aligned->len);
 725                     sru_res->records[i + num].recordData_len
 726                         = r->u.octet_aligned->len;
 727                 }
 728                 else
 729                 {
 730                     // not XML or no database record at all
 731                     yaz_mk_sru_surrogate(
 732                         odr_en, sru_res->records + i + num, position,
 733                         YAZ_SRW_RECORD_NOT_AVAILABLE_IN_THIS_SCHEMA, 0);
 734                 }
 735             }
 736             num += returned_recs;
 737         }
 738     }
 739     sru_res->num_records = num;
 740     if (start - 1 + num < *sru_pdu_res->u.response->numberOfRecords)
 741         sru_res->nextRecordPosition =
 742             odr_intdup(odr_en, start + num);
 743     return true;
 744 }
 745
 746 int yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query,
 747                                             const Z_SRW_searchRetrieveRequest *req
 748     ) const
 749 {
 750     if (req->query_type == Z_SRW_query_type_cql)
 751     {
 752         Z_External *ext = (Z_External *)
 753             odr_malloc(odr_en, sizeof(*ext));
 754         ext->direct_reference =
 755             odr_getoidbystr(odr_en, "1.2.840.10003.16.2");
 756         ext->indirect_reference = 0;
 757         ext->descriptor = 0;
 758         ext->which = Z_External_CQL;
 759         ext->u.cql = odr_strdup(odr_en, req->query.cql);
 760
 761         z_query->which = Z_Query_type_104;
 762         z_query->u.type_104 =  ext;
 763         return 0;
 764     }
 765
 766     if (req->query_type == Z_SRW_query_type_pqf)
 767     {
 768         Z_RPNQuery *RPNquery;
 769         YAZ_PQF_Parser pqf_parser;
 770
 771         pqf_parser = yaz_pqf_create ();
 772
 773         RPNquery = yaz_pqf_parse (pqf_parser, odr_en, req->query.pqf);
 774
 775         yaz_pqf_destroy(pqf_parser);
 776
 777         if (!RPNquery)
 778             return YAZ_SRW_QUERY_SYNTAX_ERROR;
 779
 780         z_query->which = Z_Query_type_1;
 781         z_query->u.type_1 =  RPNquery;
 782
 783         return 0;
 784     }
 785     return YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED;
 786 }
 787
 788
 789 bool
 790 yf::SRUtoZ3950::Impl::z3950_to_srw_diagnostics_ok(mp::odr &odr_en,
 791                                                   Z_SRW_searchRetrieveResponse
 792                                                   *sru_res,
 793                                                   Z_Records *records) const
 794 {
 795     // checking non surrogate diagnostics in Z3950 present response package
 796     if (records
 797         && records->which == Z_Records_NSD
 798         && records->u.nonSurrogateDiagnostic)
 799     {
 800         z3950_to_srw_diag(odr_en, sru_res,
 801                           records->u.nonSurrogateDiagnostic);
 802         return false;
 803     }
 804     return true;
 805 }
 806
 807
 808 int
 809 yf::SRUtoZ3950::Impl::z3950_to_srw_diag(mp::odr &odr_en,
 810                                         Z_SRW_searchRetrieveResponse *sru_res,
 811                                         Z_DefaultDiagFormat *ddf) const
 812 {
 813     int bib1_code = *ddf->condition;
 814     sru_res->num_diagnostics = 1;
 815     sru_res->diagnostics = (Z_SRW_diagnostic *)
 816         odr_malloc(odr_en, sizeof(*sru_res->diagnostics));
 817     yaz_mk_std_diagnostic(odr_en, sru_res->diagnostics,
 818                           yaz_diag_bib1_to_srw(bib1_code),
 819                           ddf->u.v2Addinfo);
 820     return 0;
 821 }
 822
 823
 824
 825 static mp::filter::Base* filter_creator()
 826 {
 827     return new mp::filter::SRUtoZ3950;
 828 }
 829
 830 extern "C" {
 831     struct metaproxy_1_filter_struct metaproxy_1_filter_sru_to_z3950 = {
 832         0,
 833         "sru_z3950",
 834         filter_creator
 835     };
 836 }
 837
 838
 839 /*
 840  * Local variables:
 841  * c-basic-offset: 4
 842  * c-file-style: "Stroustrup"
 843  * indent-tabs-mode: nil
 844  * End:
 845  * vim: shiftwidth=4 tabstop=8 expandtab
 846  */
 847