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