src/filter_sru_to_z3950.cpp

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