src/filter_sru_to_z3950.cpp

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