src/filter_sru_to_z3950.cpp

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