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     else
 428     {
 429         package.move();
 430     }
 431     release_frontend(package);
 432 }
 433
 434 bool
 435 yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package,
 436                                          mp::odr &odr_en,
 437                                          std::string zurl,
 438                                          Z_SRW_PDU *sru_pdu_res,
 439                                          const Z_SRW_PDU *sru_pdu_req) const
 440 {
 441     // prepare Z3950 package
 442     Package z3950_package(package.session(), package.origin());
 443     z3950_package.copy_filter(package);
 444
 445     // set initRequest APDU
 446     Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_initRequest);
 447     Z_InitRequest *init_req = apdu->u.initRequest;
 448
 449     Z_IdAuthentication *auth = NULL;
 450     if (sru_pdu_req->username && !sru_pdu_req->password)
 451     {
 452         auth = (Z_IdAuthentication *) odr_malloc(odr_en, sizeof(Z_IdAuthentication));
 453         auth->which = Z_IdAuthentication_open;
 454         auth->u.open = odr_strdup(odr_en, sru_pdu_req->username);
 455     }
 456     else 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_idPass;
 460         auth->u.idPass = (Z_IdPass *) odr_malloc(odr_en, sizeof(Z_IdPass));
 461         auth->u.idPass->groupId = NULL;
 462         auth->u.idPass->password = odr_strdup(odr_en, sru_pdu_req->password);
 463         auth->u.idPass->userId = odr_strdup(odr_en, sru_pdu_req->username);
 464     }
 465
 466     init_req->idAuthentication = auth;
 467
 468     *init_req->preferredMessageSize = 10*1024*1024;
 469     *init_req->maximumRecordSize = 10*1024*1024;
 470
 471     ODR_MASK_SET(init_req->options, Z_Options_search);
 472     ODR_MASK_SET(init_req->options, Z_Options_present);
 473     ODR_MASK_SET(init_req->options, Z_Options_namedResultSets);
 474     ODR_MASK_SET(init_req->options, Z_Options_scan);
 475
 476     ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_1);
 477     ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_2);
 478     ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_3);
 479
 480     if (zurl.length())
 481     {
 482         std::string host;
 483         std::list<std::string> dblist;
 484         mp_util::split_zurl(zurl, host, dblist);
 485         mp_util::set_vhost_otherinfo(&init_req->otherInfo, odr_en, host, 1);
 486     }
 487
 488     z3950_package.request() = apdu;
 489
 490     // send Z3950 package
 491     z3950_package.move();
 492
 493     // dead Z3950 backend detection
 494     if (z3950_package.session().is_closed())
 495     {
 496         yaz_add_srw_diagnostic(odr_en,
 497                                &(sru_pdu_res->u.response->diagnostics),
 498                                &(sru_pdu_res->u.response->num_diagnostics),
 499                                YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0);
 500         return false;
 501     }
 502
 503     // check successful initResponse
 504     Z_GDU *z3950_gdu = z3950_package.response().get();
 505
 506     if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
 507         && z3950_gdu->u.z3950->which == Z_APDU_initResponse
 508         && *z3950_gdu->u.z3950->u.initResponse->result)
 509         return true;
 510
 511     yaz_add_srw_diagnostic(odr_en,
 512                            &(sru_pdu_res->u.response->diagnostics),
 513                            &(sru_pdu_res->u.response->num_diagnostics),
 514                            YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0);
 515     return false;
 516 }
 517
 518 bool yf::SRUtoZ3950::Impl::z3950_close_request(mp::Package &package) const
 519 {
 520     Package z3950_package(package.session(), package.origin());
 521     z3950_package.copy_filter(package);
 522     z3950_package.session().close();
 523
 524     z3950_package.move();
 525
 526     if (z3950_package.session().is_closed())
 527     {
 528         return true;
 529     }
 530     return false;
 531 }
 532
 533 bool yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package,
 534                                                 mp::odr &odr_en,
 535                                                 Z_SRW_PDU *sru_pdu_res,
 536                                                 Z_SRW_searchRetrieveRequest
 537                                                 const *sr_req,
 538                                                 std::string zurl) const
 539 {
 540
 541     assert(sru_pdu_res->u.response);
 542
 543     Package z3950_package(package.session(), package.origin());
 544     z3950_package.copy_filter(package);
 545
 546     Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_searchRequest);
 547     Z_SearchRequest *z_searchRequest = apdu->u.searchRequest;
 548
 549     // RecordSyntax will always be XML
 550     z_searchRequest->preferredRecordSyntax
 551         = odr_oiddup(odr_en, yaz_oid_recsyn_xml);
 552
 553     if (!mp_util::set_databases_from_zurl(odr_en, zurl,
 554                                           &z_searchRequest->num_databaseNames,
 555                                           &z_searchRequest->databaseNames))
 556     {
 557         z_searchRequest->num_databaseNames = 1;
 558         z_searchRequest->databaseNames = (char**)
 559             odr_malloc(odr_en, sizeof(char *));
 560
 561         if (sr_req->database)
 562             z_searchRequest->databaseNames[0]
 563                 = odr_strdup(odr_en, const_cast<char *>(sr_req->database));
 564         else
 565             z_searchRequest->databaseNames[0]
 566                 = odr_strdup(odr_en, "Default");
 567     }
 568
 569     Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query));
 570     z_searchRequest->query = z_query;
 571
 572     int sru_diagnostic = z3950_build_query(odr_en, z_query, sr_req);
 573     if (sru_diagnostic)
 574     {
 575         yaz_add_srw_diagnostic(odr_en,
 576                                &(sru_pdu_res->u.response->diagnostics),
 577                                &(sru_pdu_res->u.response->num_diagnostics),
 578                                sru_diagnostic,
 579                                "query");
 580         return false;
 581     }
 582
 583     z3950_package.request() = apdu;
 584
 585     z3950_package.move();
 586
 587     Z_GDU *z3950_gdu = z3950_package.response().get();
 588
 589     if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950
 590         || z3950_gdu->u.z3950->which != Z_APDU_searchResponse
 591         || !z3950_gdu->u.z3950->u.searchResponse
 592         || !z3950_gdu->u.z3950->u.searchResponse->searchStatus)
 593     {
 594         yaz_add_srw_diagnostic(odr_en,
 595                                &(sru_pdu_res->u.response->diagnostics),
 596                                &(sru_pdu_res->u.response->num_diagnostics),
 597                                YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0);
 598         return false;
 599     }
 600
 601     Z_SearchResponse *sr = z3950_gdu->u.z3950->u.searchResponse;
 602
 603     if (!z3950_to_srw_diagnostics_ok(odr_en, sru_pdu_res->u.response,
 604                                      sr->records))
 605     {
 606         return false;
 607     }
 608
 609     sru_pdu_res->u.response->numberOfRecords
 610         = odr_intdup(odr_en, *sr->resultCount);
 611     return true;
 612 }
 613
 614 bool yf::SRUtoZ3950::Impl::z3950_present_request(
 615     mp::Package &package,
 616     mp::odr &odr_en,
 617     Z_SRW_PDU *sru_pdu_res,
 618     const Z_SRW_searchRetrieveRequest *sr_req)
 619     const
 620 {
 621     assert(sru_pdu_res->u.response);
 622     int start = 1;
 623     int max_recs = 0;
 624
 625     if (!sr_req)
 626         return false;
 627
 628     if (sr_req->maximumRecords)
 629         max_recs = *sr_req->maximumRecords;
 630     if (sr_req->startRecord)
 631         start = *sr_req->startRecord;
 632
 633     // no need to work if nobody wants record ..
 634     if (max_recs == 0)
 635         return true;
 636
 637     bool send_z3950_present = true;
 638
 639     // recordXPath unsupported.
 640     if (sr_req->recordXPath)
 641     {
 642         send_z3950_present = false;
 643         yaz_add_srw_diagnostic(odr_en,
 644                                &(sru_pdu_res->u.response->diagnostics),
 645                                &(sru_pdu_res->u.response->num_diagnostics),
 646                                YAZ_SRW_XPATH_RETRIEVAL_UNSUPP, 0);
 647     }
 648
 649     // resultSetTTL unsupported.
 650     // resultSetIdleTime in response
 651     if (sr_req->resultSetTTL)
 652     {
 653         send_z3950_present = false;
 654         yaz_add_srw_diagnostic(odr_en,
 655                                &(sru_pdu_res->u.response->diagnostics),
 656                                &(sru_pdu_res->u.response->num_diagnostics),
 657                                YAZ_SRW_RESULT_SETS_UNSUPP, 0);
 658     }
 659
 660     // sort unsupported
 661     if (sr_req->sort_type != Z_SRW_sort_type_none)
 662     {
 663         send_z3950_present = false;
 664         yaz_add_srw_diagnostic(odr_en,
 665                                &(sru_pdu_res->u.response->diagnostics),
 666                                &(sru_pdu_res->u.response->num_diagnostics),
 667                                YAZ_SRW_SORT_UNSUPP, 0);
 668     }
 669
 670     // start record requested negative, or larger than number of records
 671     if (start < 0 || start > *sru_pdu_res->u.response->numberOfRecords)
 672     {
 673         send_z3950_present = false;
 674         yaz_add_srw_diagnostic(odr_en,
 675                                &(sru_pdu_res->u.response->diagnostics),
 676                                &(sru_pdu_res->u.response->num_diagnostics),
 677                                YAZ_SRW_FIRST_RECORD_POSITION_OUT_OF_RANGE, 0);
 678     }
 679
 680     // maximumRecords requested negative
 681     if (max_recs < 0)
 682     {
 683         send_z3950_present = false;
 684         yaz_add_srw_diagnostic(odr_en,
 685                                &(sru_pdu_res->u.response->diagnostics),
 686                                &(sru_pdu_res->u.response->num_diagnostics),
 687                                YAZ_SRW_UNSUPP_PARAMETER_VALUE,
 688                                "maximumRecords");
 689     }
 690
 691     // exit on all these above diagnostics
 692     if (!send_z3950_present)
 693         return false;
 694
 695     if (max_recs > *sru_pdu_res->u.response->numberOfRecords - start)
 696         max_recs = *sru_pdu_res->u.response->numberOfRecords - start + 1;
 697
 698     Z_SRW_searchRetrieveResponse *sru_res = sru_pdu_res->u.response;
 699     sru_res->records = (Z_SRW_record *)
 700         odr_malloc(odr_en, max_recs * sizeof(Z_SRW_record));
 701     int num = 0;
 702     while (num < max_recs)
 703     {
 704         // now packaging the z3950 present request
 705         Package z3950_package(package.session(), package.origin());
 706         z3950_package.copy_filter(package);
 707         Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_presentRequest);
 708
 709         assert(apdu->u.presentRequest);
 710
 711         *apdu->u.presentRequest->resultSetStartPoint = start + num;
 712         *apdu->u.presentRequest->numberOfRecordsRequested = max_recs - num;
 713
 714         // set response packing to be same as "request" packing..
 715         int record_packing = Z_SRW_recordPacking_XML;
 716         if (sr_req->recordPacking && 's' == *(sr_req->recordPacking))
 717             record_packing = Z_SRW_recordPacking_string;
 718
 719         // RecordSyntax will always be XML
 720         apdu->u.presentRequest->preferredRecordSyntax
 721             = odr_oiddup(odr_en, yaz_oid_recsyn_xml);
 722
 723         // z3950'fy record schema
 724         if (sr_req->recordSchema)
 725         {
 726             apdu->u.presentRequest->recordComposition
 727                 = (Z_RecordComposition *)
 728                 odr_malloc(odr_en, sizeof(Z_RecordComposition));
 729             apdu->u.presentRequest->recordComposition->which
 730                 = Z_RecordComp_simple;
 731             apdu->u.presentRequest->recordComposition->u.simple
 732                 = mp_util::build_esn_from_schema(odr_en,
 733                                                  (const char *)
 734                                                  sr_req->recordSchema);
 735         }
 736
 737         // attaching Z3950 package to filter chain
 738         z3950_package.request() = apdu;
 739
 740         // sending Z30.50 present request
 741         z3950_package.move();
 742
 743         //check successful Z3950 present response
 744         Z_GDU *z3950_gdu = z3950_package.response().get();
 745         if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950
 746             || z3950_gdu->u.z3950->which != Z_APDU_presentResponse
 747             || !z3950_gdu->u.z3950->u.presentResponse)
 748
 749         {
 750             yaz_add_srw_diagnostic(odr_en,
 751                                    &(sru_pdu_res->u.response->diagnostics),
 752                                    &(sru_pdu_res->u.response->num_diagnostics),
 753                                    YAZ_SRW_SYSTEM_TEMPORARILY_UNAVAILABLE, 0);
 754             return false;
 755         }
 756         // everything fine, continuing
 757
 758         Z_PresentResponse *pr = z3950_gdu->u.z3950->u.presentResponse;
 759
 760         // checking non surrogate diagnostics in Z3950 present response package
 761         if (!z3950_to_srw_diagnostics_ok(odr_en, sru_pdu_res->u.response,
 762                                          pr->records))
 763             return false;
 764
 765         // if anything but database or surrogate diagnostics, stop
 766         if (!pr->records || pr->records->which != Z_Records_DBOSD)
 767             break;
 768         else
 769         {
 770             // inserting all records
 771             int returned_recs =
 772                 pr->records->u.databaseOrSurDiagnostics->num_records;
 773             for (int i = 0; i < returned_recs; i++)
 774             {
 775                 int position = i + *apdu->u.presentRequest->resultSetStartPoint;
 776                 Z_NamePlusRecord *npr
 777                     = pr->records->u.databaseOrSurDiagnostics->records[i];
 778
 779                 sru_res->records[i + num].recordPacking = record_packing;
 780
 781                 if (npr->which == Z_NamePlusRecord_databaseRecord &&
 782                     npr->u.databaseRecord->direct_reference
 783                     && !oid_oidcmp(npr->u.databaseRecord->direct_reference,
 784                                    yaz_oid_recsyn_xml))
 785                 {
 786                     // got XML record back
 787                     Z_External *r = npr->u.databaseRecord;
 788                     sru_res->records[i + num].recordPosition =
 789                         odr_intdup(odr_en, position);
 790                     sru_res->records[i + num].recordSchema = sr_req->recordSchema;
 791                     sru_res->records[i + num].recordData_buf
 792                         = odr_strdupn(odr_en,
 793                                       (const char *)r->u.octet_aligned->buf,
 794                                       r->u.octet_aligned->len);
 795                     sru_res->records[i + num].recordData_len
 796                         = r->u.octet_aligned->len;
 797                 }
 798                 else
 799                 {
 800                     // not XML or no database record at all
 801                     yaz_mk_sru_surrogate(
 802                         odr_en, sru_res->records + i + num, position,
 803                         YAZ_SRW_RECORD_NOT_AVAILABLE_IN_THIS_SCHEMA, 0);
 804                 }
 805             }
 806             num += returned_recs;
 807         }
 808     }
 809     sru_res->num_records = num;
 810     if (start - 1 + num < *sru_pdu_res->u.response->numberOfRecords)
 811         sru_res->nextRecordPosition =
 812             odr_intdup(odr_en, start + num);
 813     return true;
 814 }
 815
 816 int yf::SRUtoZ3950::Impl::z3950_build_query(
 817     mp::odr &odr_en, Z_Query *z_query,
 818     const Z_SRW_searchRetrieveRequest *req
 819     ) const
 820 {
 821     if (req->query_type == Z_SRW_query_type_cql)
 822     {
 823         Z_External *ext = (Z_External *)
 824             odr_malloc(odr_en, sizeof(*ext));
 825         ext->direct_reference =
 826             odr_getoidbystr(odr_en, "1.2.840.10003.16.2");
 827         ext->indirect_reference = 0;
 828         ext->descriptor = 0;
 829         ext->which = Z_External_CQL;
 830         ext->u.cql = odr_strdup(odr_en, req->query.cql);
 831
 832         z_query->which = Z_Query_type_104;
 833         z_query->u.type_104 =  ext;
 834         return 0;
 835     }
 836
 837     if (req->query_type == Z_SRW_query_type_pqf)
 838     {
 839         Z_RPNQuery *RPNquery;
 840         YAZ_PQF_Parser pqf_parser;
 841
 842         pqf_parser = yaz_pqf_create ();
 843
 844         RPNquery = yaz_pqf_parse (pqf_parser, odr_en, req->query.pqf);
 845
 846         yaz_pqf_destroy(pqf_parser);
 847
 848         if (!RPNquery)
 849             return YAZ_SRW_QUERY_SYNTAX_ERROR;
 850
 851         z_query->which = Z_Query_type_1;
 852         z_query->u.type_1 =  RPNquery;
 853
 854         return 0;
 855     }
 856     return YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED;
 857 }
 858
 859 bool yf::SRUtoZ3950::Impl::z3950_to_srw_diagnostics_ok(
 860     mp::odr &odr_en,
 861     Z_SRW_searchRetrieveResponse
 862     *sru_res,
 863     Z_Records *records) const
 864 {
 865     // checking non surrogate diagnostics in Z3950 present response package
 866     if (records
 867         && records->which == Z_Records_NSD
 868         && records->u.nonSurrogateDiagnostic)
 869     {
 870         z3950_to_srw_diag(odr_en, sru_res,
 871                           records->u.nonSurrogateDiagnostic);
 872         return false;
 873     }
 874     return true;
 875 }
 876
 877 int yf::SRUtoZ3950::Impl::z3950_to_srw_diag(
 878     mp::odr &odr_en,
 879     Z_SRW_searchRetrieveResponse *sru_res,
 880     Z_DefaultDiagFormat *ddf) const
 881 {
 882     int bib1_code = *ddf->condition;
 883     sru_res->num_diagnostics = 1;
 884     sru_res->diagnostics = (Z_SRW_diagnostic *)
 885         odr_malloc(odr_en, sizeof(*sru_res->diagnostics));
 886     yaz_mk_std_diagnostic(odr_en, sru_res->diagnostics,
 887                           yaz_diag_bib1_to_srw(bib1_code),
 888                           ddf->u.v2Addinfo);
 889     return 0;
 890 }
 891
 892 static mp::filter::Base* filter_creator()
 893 {
 894     return new mp::filter::SRUtoZ3950;
 895 }
 896
 897 extern "C" {
 898     struct metaproxy_1_filter_struct metaproxy_1_filter_sru_to_z3950 = {
 899         0,
 900         "sru_z3950",
 901         filter_creator
 902     };
 903 }
 904
 905
 906 /*
 907  * Local variables:
 908  * c-basic-offset: 4
 909  * c-file-style: "Stroustrup"
 910  * indent-tabs-mode: nil
 911  * End:
 912  * vim: shiftwidth=4 tabstop=8 expandtab
 913  */
 914