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