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