src/filter_sru_to_z3950.cpp

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