src/filter_sru_to_z3950.cpp

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