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