src/filter_sru_to_z3950.cpp

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