src/filter_sru_to_z3950.cpp

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