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