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