src/filter_sru_to_z3950.cpp

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