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