src/filter_sru_to_z3950.cpp

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