src/filter_sru_to_z3950.cpp

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