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