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