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