src/filter_sru_to_z3950.cpp

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