src/filter_sru_to_z3950.cpp

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