src/filter_sru_to_z3950.cpp

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