src/filter_sru_to_z3950.cpp

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