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