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