src/filter_sru_to_z3950.cpp

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