src/filter_sru_to_z3950.cpp

   1 /* $Id: filter_sru_to_z3950.cpp,v 1.35 2007-05-09 21:23:09 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                                     Z_SRW_PDU *sru_pdu_res,
  68                                     const std::string
  69                                     &database = "Default") const;
  70
  71             bool z3950_close_request(mp::Package &package) const;
  72
  73             bool z3950_search_request(mp::Package &package,
  74                                       mp::odr &odr_en,
  75                                       Z_SRW_PDU *sru_pdu_res,
  76                                       Z_SRW_searchRetrieveRequest
  77                                           const *sr_req) const;
  78
  79             bool z3950_present_request(mp::Package &package,
  80                                        mp::odr &odr_en,
  81                                        Z_SRW_PDU *sru_pdu_res,
  82                                        Z_SRW_searchRetrieveRequest
  83                                        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     // filter acts as sink for SRU explain requests
 217     if (sru_pdu_req && sru_pdu_req->which == Z_SRW_explain_request)
 218     {
 219         Z_SRW_explainRequest *er_req = sru_pdu_req->u.explain_request;
 220         //mp_util::build_simple_explain(package, odr_en, sru_pdu_res,
 221         //                           sruinfo, er_req);
 222         mp_util::build_sru_explain(package, odr_en, sru_pdu_res,
 223                                    sruinfo, explainnode, er_req);
 224     }
 225     else if (sru_pdu_req
 226         && sru_pdu_req->which == Z_SRW_searchRetrieve_request
 227         && sru_pdu_req->u.request)
 228     {   // searchRetrieve
 229         Z_SRW_searchRetrieveRequest *sr_req = sru_pdu_req->u.request;
 230
 231         sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_searchRetrieve_response);
 232
 233         // checking that we have a query
 234         ok = mp_util::check_sru_query_exists(package, odr_en,
 235                                              sru_pdu_res, sr_req);
 236
 237         if (ok && z3950_init_request(package, odr_en, sru_pdu_res))
 238         {
 239             {
 240                 ok = z3950_search_request(package, odr_en,
 241                                           sru_pdu_res, sr_req);
 242
 243                 if (ok
 244                     && sru_pdu_res->u.response->numberOfRecords
 245                     && *(sru_pdu_res->u.response->numberOfRecords)
 246                     && sr_req->maximumRecords
 247                     && *(sr_req->maximumRecords))
 248
 249                     ok = z3950_present_request(package, odr_en,
 250                                                sru_pdu_res,
 251                                                sr_req);
 252                 z3950_close_request(package);
 253             }
 254         }
 255     }
 256
 257     // scan
 258     else if (sru_pdu_req
 259              && sru_pdu_req->which == Z_SRW_scan_request
 260              && sru_pdu_req->u.scan_request)
 261     {
 262         Z_SRW_scanRequest  *sr_req = sru_pdu_req->u.scan_request;
 263
 264         sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_scan_response);
 265
 266         // we do not do scan at the moment, therefore issuing a diagnostic
 267         yaz_add_srw_diagnostic(odr_en,
 268                                &(sru_pdu_res->u.scan_response->diagnostics),
 269                                &(sru_pdu_res->u.scan_response->num_diagnostics),
 270                                4, "scan");
 271
 272         // to be used when we do scan
 273         if (false && z3950_init_request(package, odr_en, sru_pdu_res))
 274         {
 275             z3950_scan_request(package, odr_en, sru_pdu_res, sr_req);
 276             z3950_close_request(package);
 277         }
 278     }
 279     else
 280     {
 281         //std::cout << "SRU OPERATION NOT SUPPORTED \n";
 282         sru_pdu_res = yaz_srw_get(odr_en, Z_SRW_explain_response);
 283
 284         // TODO: make nice diagnostic return package
 285         return;
 286     }
 287
 288     // build and send SRU response
 289     mp_util::build_sru_response(package, odr_en, soap,
 290                                 sru_pdu_res, charset, stylesheet);
 291 }
 292
 293
 294
 295 bool
 296 yf::SRUtoZ3950::Impl::z3950_init_request(mp::Package &package,
 297                                          mp::odr &odr_en,
 298                                          Z_SRW_PDU *sru_pdu_res,
 299                                          const std::string &database) const
 300 {
 301     // prepare Z3950 package
 302     Package z3950_package(package.session(), package.origin());
 303     z3950_package.copy_filter(package);
 304
 305     // set initRequest APDU
 306     Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_initRequest);
 307     Z_InitRequest *init_req = apdu->u.initRequest;
 308     //TODO: add user name in apdu
 309     //TODO: add user passwd in apdu
 310     //init_req->idAuthentication = org_init->idAuthentication;
 311     //init_req->implementationId = "IDxyz";
 312     //init_req->implementationName = "NAMExyz";
 313     //init_req->implementationVersion = "VERSIONxyz";
 314
 315     ODR_MASK_SET(init_req->options, Z_Options_search);
 316     ODR_MASK_SET(init_req->options, Z_Options_present);
 317     ODR_MASK_SET(init_req->options, Z_Options_namedResultSets);
 318     ODR_MASK_SET(init_req->options, Z_Options_scan);
 319
 320     ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_1);
 321     ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_2);
 322     ODR_MASK_SET(init_req->protocolVersion, Z_ProtocolVersion_3);
 323
 324     z3950_package.request() = apdu;
 325
 326     // send Z3950 package
 327     z3950_package.move();
 328
 329     // dead Z3950 backend detection
 330     if (z3950_package.session().is_closed()){
 331         yaz_add_srw_diagnostic(odr_en,
 332                                &(sru_pdu_res->u.response->diagnostics),
 333                                &(sru_pdu_res->u.response->num_diagnostics),
 334                                2, 0);
 335         return false;
 336     }
 337
 338     // check successful initResponse
 339     Z_GDU *z3950_gdu = z3950_package.response().get();
 340
 341     if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
 342         && z3950_gdu->u.z3950->which == Z_APDU_initResponse
 343         && *z3950_gdu->u.z3950->u.initResponse->result)
 344          return true;
 345
 346     yaz_add_srw_diagnostic(odr_en,
 347                            &(sru_pdu_res->u.response->diagnostics),
 348                            &(sru_pdu_res->u.response->num_diagnostics),
 349                            2, 0);
 350     return false;
 351 }
 352
 353 bool
 354 yf::SRUtoZ3950::Impl::z3950_close_request(mp::Package &package) const
 355 {
 356     // prepare and close Z3950 package
 357     Package z3950_package(package.session(), package.origin());
 358     z3950_package.copy_filter(package);
 359     z3950_package.session().close();
 360
 361     // set close APDU
 362     //mp::odr odr_en(ODR_ENCODE);
 363     //Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_close);
 364     //z3950_package.request() = apdu;
 365
 366     z3950_package.move();
 367
 368     // check successful close response
 369     //Z_GDU *z3950_gdu = z3950_package.response().get();
 370     //if (z3950_gdu && z3950_gdu->which == Z_GDU_Z3950
 371     //    && z3950_gdu->u.z3950->which == Z_APDU_close)
 372     //    return true;
 373
 374     if (z3950_package.session().is_closed()){
 375         return true;
 376     }
 377     return false;
 378 }
 379
 380 bool yf::SRUtoZ3950::Impl::z3950_search_request(mp::Package &package,
 381                                                 mp::odr &odr_en,
 382                                                 Z_SRW_PDU *sru_pdu_res,
 383                                                 Z_SRW_searchRetrieveRequest
 384                                                 const *sr_req) const
 385 {
 386
 387     assert(sru_pdu_res->u.response);
 388
 389     Package z3950_package(package.session(), package.origin());
 390     z3950_package.copy_filter(package);
 391
 392     //add stuff in z3950 apdu
 393     Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_searchRequest);
 394     Z_SearchRequest *z_searchRequest = apdu->u.searchRequest;
 395
 396     // z3950'fy database
 397     z_searchRequest->num_databaseNames = 1;
 398     z_searchRequest->databaseNames = (char**)
 399         odr_malloc(odr_en, sizeof(char *));
 400
 401     if (sr_req->database)
 402         z_searchRequest->databaseNames[0]
 403             = odr_strdup(odr_en, const_cast<char *>(sr_req->database));
 404     else
 405         z_searchRequest->databaseNames[0]
 406             = odr_strdup(odr_en, "Default");
 407
 408
 409     // z3950'fy query
 410     Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query));
 411     z_searchRequest->query = z_query;
 412
 413     if (!z3950_build_query(odr_en, z_query,
 414                            (const SRW_query&)sr_req->query,
 415                            sr_req->query_type))
 416     {
 417         yaz_add_srw_diagnostic(odr_en,
 418                                &(sru_pdu_res->u.response->diagnostics),
 419                                &(sru_pdu_res->u.response->num_diagnostics),
 420                                7, "query");
 421         return false;
 422     }
 423
 424     z3950_package.request() = apdu;
 425
 426     // send Z39.50 package off to backend
 427     z3950_package.move();
 428
 429
 430     Z_GDU *z3950_gdu = z3950_package.response().get();
 431
 432     //TODO: check success condition
 433     //int yaz_diag_bib1_to_srw (int bib1_code);
 434     //int yaz_diag_srw_to_bib1(int srw_code);
 435     //Se kode i src/seshigh.c (srw_bend_search, srw_bend_init).
 436
 437     if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950
 438         || z3950_gdu->u.z3950->which != Z_APDU_searchResponse
 439         || !z3950_gdu->u.z3950->u.searchResponse
 440         || !z3950_gdu->u.z3950->u.searchResponse->searchStatus)
 441     {
 442         yaz_add_srw_diagnostic(odr_en,
 443                                &(sru_pdu_res->u.response->diagnostics),
 444                                &(sru_pdu_res->u.response->num_diagnostics),
 445                                2, 0);
 446         return false;
 447     }
 448
 449     // everything fine, continuing
 450     Z_SearchResponse *sr = z3950_gdu->u.z3950->u.searchResponse;
 451
 452     // checking non surrogate diagnostics in Z3950 search response package
 453     if (!z3950_to_srw_diagnostics_ok(odr_en, sru_pdu_res->u.response,
 454                                      sr->records))
 455     {
 456         return false;
 457     }
 458
 459     // Finally, roll on and srw'fy number of records
 460     sru_pdu_res->u.response->numberOfRecords
 461         = (int *) odr_malloc(odr_en, sizeof(int *));
 462     *(sru_pdu_res->u.response->numberOfRecords) = *(sr->resultCount);
 463
 464     // srw'fy nextRecordPosition
 465     //sru_pdu_res->u.response->nextRecordPosition
 466     //    = (int *) odr_malloc(odr_en, sizeof(int *));
 467     //*(sru_pdu_res->u.response->nextRecordPosition) = 1;
 468
 469     return true;
 470 }
 471
 472 bool
 473 yf::SRUtoZ3950::Impl::z3950_present_request(mp::Package &package,
 474                                            mp::odr &odr_en,
 475                                            Z_SRW_PDU *sru_pdu_res,
 476                                            Z_SRW_searchRetrieveRequest
 477                                            const *sr_req)
 478     const
 479 {
 480     assert(sru_pdu_res->u.response);
 481
 482     if (!sr_req)
 483         return false;
 484
 485
 486     // no need to work if nobody wants record ..
 487     if (!(sr_req->maximumRecords) || 0 == *(sr_req->maximumRecords))
 488         return true;
 489
 490     bool send_z3950_present = true;
 491
 492     // recordXPath unsupported.
 493     if (sr_req->recordXPath)
 494     {
 495         send_z3950_present = false;
 496         yaz_add_srw_diagnostic(odr_en,
 497                                &(sru_pdu_res->u.response->diagnostics),
 498                                &(sru_pdu_res->u.response->num_diagnostics),
 499                                72, 0);
 500     }
 501
 502     // resultSetTTL unsupported.
 503     // resultSetIdleTime in response
 504     if (sr_req->resultSetTTL)
 505     {
 506         send_z3950_present = false;
 507         yaz_add_srw_diagnostic(odr_en,
 508                                &(sru_pdu_res->u.response->diagnostics),
 509                                &(sru_pdu_res->u.response->num_diagnostics),
 510                                50, 0);
 511     }
 512
 513     // sort unsupported
 514     if (sr_req->sort_type != Z_SRW_sort_type_none)
 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                                80, 0);
 521     }
 522
 523     // start record requested negative, or larger than number of records
 524     if (sr_req->startRecord
 525         &&
 526         ((*(sr_req->startRecord) < 0)       // negative
 527          ||
 528          (sru_pdu_res->u.response->numberOfRecords  //out of range
 529           && *(sr_req->startRecord)
 530           > *(sru_pdu_res->u.response->numberOfRecords))
 531         ))
 532     {
 533         send_z3950_present = false;
 534         yaz_add_srw_diagnostic(odr_en,
 535                                &(sru_pdu_res->u.response->diagnostics),
 536                                &(sru_pdu_res->u.response->num_diagnostics),
 537                                61, 0);
 538     }
 539
 540     // maximumRecords requested negative
 541     if (sr_req->maximumRecords
 542         && *(sr_req->maximumRecords) < 0)
 543
 544     {
 545         send_z3950_present = false;
 546         yaz_add_srw_diagnostic(odr_en,
 547                                &(sru_pdu_res->u.response->diagnostics),
 548                                &(sru_pdu_res->u.response->num_diagnostics),
 549                                6, "maximumRecords");
 550     }
 551
 552     // exit on all these above diagnostics
 553     if (!send_z3950_present)
 554         return false;
 555
 556     // now packaging the z3950 present request
 557     Package z3950_package(package.session(), package.origin());
 558     z3950_package.copy_filter(package);
 559     Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_presentRequest);
 560
 561     assert(apdu->u.presentRequest);
 562
 563     // z3950'fy start record position
 564     if (sr_req->startRecord)
 565         *(apdu->u.presentRequest->resultSetStartPoint)
 566             = *(sr_req->startRecord);
 567     else
 568         *(apdu->u.presentRequest->resultSetStartPoint) = 1;
 569
 570     // z3950'fy number of records requested
 571     // protect against requesting records out of range
 572     if (sr_req->maximumRecords)
 573         *(apdu->u.presentRequest->numberOfRecordsRequested)
 574             = std::min(*(sr_req->maximumRecords),
 575                   *(sru_pdu_res->u.response->numberOfRecords)
 576                   - *(apdu->u.presentRequest->resultSetStartPoint)
 577                   + 1);
 578
 579     // z3950'fy recordPacking
 580     int record_packing = Z_SRW_recordPacking_XML;
 581     if (sr_req->recordPacking && 's' == *(sr_req->recordPacking))
 582         record_packing = Z_SRW_recordPacking_string;
 583
 584     // RecordSyntax will always be XML
 585     apdu->u.presentRequest->preferredRecordSyntax
 586         = odr_oiddup(odr_en, yaz_oid_recsyn_xml);
 587
 588     // z3950'fy record schema
 589      if (sr_req->recordSchema)
 590      {
 591          apdu->u.presentRequest->recordComposition
 592              = (Z_RecordComposition *)
 593                odr_malloc(odr_en, sizeof(Z_RecordComposition));
 594          apdu->u.presentRequest->recordComposition->which
 595              = Z_RecordComp_simple;
 596          apdu->u.presentRequest->recordComposition->u.simple
 597              = mp_util::build_esn_from_schema(odr_en,
 598                                       (const char *) sr_req->recordSchema);
 599      }
 600
 601     // z3950'fy time to live - flagged as diagnostics above
 602     //if (sr_req->resultSetTTL)
 603
 604     // attaching Z3950 package to filter chain
 605     z3950_package.request() = apdu;
 606
 607     // sending Z30.50 present request
 608     z3950_package.move();
 609
 610     //check successful Z3950 present response
 611     Z_GDU *z3950_gdu = z3950_package.response().get();
 612     if (!z3950_gdu || z3950_gdu->which != Z_GDU_Z3950
 613         || z3950_gdu->u.z3950->which != Z_APDU_presentResponse
 614         || !z3950_gdu->u.z3950->u.presentResponse)
 615
 616     {
 617         yaz_add_srw_diagnostic(odr_en,
 618                                &(sru_pdu_res->u.response->diagnostics),
 619                                &(sru_pdu_res->u.response->num_diagnostics),
 620                                2, 0);
 621         return false;
 622     }
 623
 624
 625     // everything fine, continuing
 626
 627     Z_PresentResponse *pr = z3950_gdu->u.z3950->u.presentResponse;
 628     Z_SRW_searchRetrieveResponse *sru_res = sru_pdu_res->u.response;
 629
 630
 631     // checking non surrogate diagnostics in Z3950 present response package
 632     if (!z3950_to_srw_diagnostics_ok(odr_en, sru_pdu_res->u.response,
 633                                      pr->records))
 634         return false;
 635
 636
 637
 638     // copy all records if existing
 639     if (pr->records && pr->records->which == Z_Records_DBOSD)
 640     {
 641         // srw'fy number of returned records
 642         sru_res->num_records
 643             = pr->records->u.databaseOrSurDiagnostics->num_records;
 644
 645         sru_res->records
 646             = (Z_SRW_record *) odr_malloc(odr_en,
 647                                           sru_res->num_records
 648                                              * sizeof(Z_SRW_record));
 649
 650
 651         // srw'fy nextRecordPosition
 652         // next position never zero or behind the last z3950 record
 653         if (pr->nextResultSetPosition
 654             && *(pr->nextResultSetPosition) > 0
 655             && *(pr->nextResultSetPosition)
 656                <= *(sru_pdu_res->u.response->numberOfRecords))
 657             sru_res->nextRecordPosition
 658                 = odr_intdup(odr_en, *(pr->nextResultSetPosition));
 659
 660         // inserting all records
 661         for (int i = 0; i < sru_res->num_records; i++)
 662         {
 663             Z_NamePlusRecord *npr
 664                 = pr->records->u.databaseOrSurDiagnostics->records[i];
 665
 666             sru_res->records[i].recordPosition
 667                 = odr_intdup(odr_en,
 668                            i + *(apdu->u.presentRequest->resultSetStartPoint));
 669
 670             sru_res->records[i].recordPacking = record_packing;
 671
 672             if (npr->which != Z_NamePlusRecord_databaseRecord)
 673             {
 674                 sru_res->records[i].recordSchema = "diagnostic";
 675                 sru_res->records[i].recordData_buf = "67";
 676                 sru_res->records[i].recordData_len = 2;
 677             }
 678             else
 679             {
 680                 Z_External *r = npr->u.databaseRecord;
 681                 if (r->direct_reference
 682                     && !oid_oidcmp(r->direct_reference, yaz_oid_recsyn_xml))
 683                 {
 684                     sru_res->records[i].recordSchema = "dc";
 685                     sru_res->records[i].recordData_buf
 686                         = odr_strdupn(odr_en,
 687                                       (const char *)r->u.octet_aligned->buf,
 688                                       r->u.octet_aligned->len);
 689                     sru_res->records[i].recordData_len
 690                         = r->u.octet_aligned->len;
 691                 }
 692                 else
 693                 {
 694                     sru_res->records[i].recordSchema = "diagnostic";
 695                     sru_res->records[i].recordData_buf = "67";
 696                     sru_res->records[i].recordData_len = 2;
 697                 }
 698             }
 699         }
 700     }
 701
 702     return true;
 703 }
 704
 705 bool
 706 yf::SRUtoZ3950::Impl::z3950_scan_request(mp::Package &package,
 707                                         mp::odr &odr_en,
 708                                         Z_SRW_PDU *sru_pdu_res,
 709                                         Z_SRW_scanRequest const *sr_req) const
 710 {
 711     assert(sru_pdu_res->u.scan_response);
 712
 713     Package z3950_package(package.session(), package.origin());
 714     z3950_package.copy_filter(package);
 715     //mp::odr odr_en(ODR_ENCODE);
 716     Z_APDU *apdu = zget_APDU(odr_en, Z_APDU_scanRequest);
 717
 718     //TODO: add stuff in apdu
 719     Z_ScanRequest *z_scanRequest = apdu->u.scanRequest;
 720
 721     // database repackaging
 722     z_scanRequest->num_databaseNames = 1;
 723     z_scanRequest->databaseNames = (char**)
 724         odr_malloc(odr_en, sizeof(char *));
 725     if (sr_req->database)
 726         z_scanRequest->databaseNames[0]
 727             = odr_strdup(odr_en, const_cast<char *>(sr_req->database));
 728     else
 729         z_scanRequest->databaseNames[0]
 730             = odr_strdup(odr_en, "Default");
 731
 732
 733     // query repackaging
 734     // CQL or XCQL scan is not possible in Z3950, flagging a diagnostic
 735     if (sr_req->query_type != Z_SRW_query_type_pqf)
 736     {
 737         //send_to_srw_client_error(7, "query");
 738         return false;
 739     }
 740
 741     // PQF query repackaging
 742     // need to use Z_AttributesPlusTerm structure, not Z_Query
 743     // this can be digget out of a
 744     // Z_query->type1(Z_RPNQuery)->RPNStructure(Z_RPNStructure)
 745     //   ->u.simple(Z_Operand)->u.attributesPlusTerm(Z_AttributesPlusTerm )
 746
 747     //Z_Query *z_query = (Z_Query *) odr_malloc(odr_en, sizeof(Z_Query));
 748     //z_searchRequest->query = z_query;
 749
 750     //if (!z3950_build_query(odr_en, z_query,
 751     //                       (const SRW_query&)sr_req->query,
 752     //                       sr_req->query_type))
 753     //{
 754         //send_to_srw_client_error(7, "query");
 755     //    return false;
 756     //}
 757
 758     // TODO:
 759
 760     z3950_package.request() = apdu;
 761     std::cout << "z3950_scan_request " << *apdu << "\n";
 762
 763     z3950_package.move();
 764     //TODO: check success condition
 765     return true;
 766     return false;
 767 }
 768
 769 bool yf::SRUtoZ3950::Impl::z3950_build_query(mp::odr &odr_en, Z_Query *z_query,
 770                                             const SRW_query &query,
 771                                             SRW_query_type query_type) const
 772 {
 773     if (query_type == Z_SRW_query_type_cql)
 774     {
 775         Z_External *ext = (Z_External *)
 776             odr_malloc(odr_en, sizeof(*ext));
 777         ext->direct_reference =
 778             odr_getoidbystr(odr_en, "1.2.840.10003.16.2");
 779         ext->indirect_reference = 0;
 780         ext->descriptor = 0;
 781         ext->which = Z_External_CQL;
 782         ext->u.cql = const_cast<char *>(query.cql);
 783
 784         z_query->which = Z_Query_type_104;
 785         z_query->u.type_104 =  ext;
 786         return true;
 787     }
 788
 789     if (query_type == Z_SRW_query_type_pqf)
 790     {
 791         Z_RPNQuery *RPNquery;
 792         YAZ_PQF_Parser pqf_parser;
 793
 794         pqf_parser = yaz_pqf_create ();
 795
 796         RPNquery = yaz_pqf_parse (pqf_parser, odr_en, query.pqf);
 797         if (!RPNquery)
 798         {
 799             std::cout << "TODO: Handeling of bad PQF\n";
 800             std::cout << "TODO: Diagnostic to be send\n";
 801         }
 802         z_query->which = Z_Query_type_1;
 803         z_query->u.type_1 =  RPNquery;
 804
 805         yaz_pqf_destroy(pqf_parser);
 806         return true;
 807     }
 808     return false;
 809 }
 810
 811
 812 bool
 813 yf::SRUtoZ3950::Impl::z3950_to_srw_diagnostics_ok(mp::odr &odr_en,
 814                                                   Z_SRW_searchRetrieveResponse
 815                                                   *sru_res,
 816                                                   Z_Records *records) const
 817 {
 818     // checking non surrogate diagnostics in Z3950 present response package
 819     if (records
 820         && records->which == Z_Records_NSD
 821         && records->u.nonSurrogateDiagnostic)
 822     {
 823         z3950_to_srw_diag(odr_en, sru_res,
 824                           records->u.nonSurrogateDiagnostic);
 825         return false;
 826     }
 827     return true;
 828 }
 829
 830
 831 int
 832 yf::SRUtoZ3950::Impl::z3950_to_srw_diag(mp::odr &odr_en,
 833                                        Z_SRW_searchRetrieveResponse *sru_res,
 834                                        Z_DefaultDiagFormat *ddf) const
 835 {
 836     int bib1_code = *ddf->condition;
 837     sru_res->num_diagnostics = 1;
 838     sru_res->diagnostics = (Z_SRW_diagnostic *)
 839         odr_malloc(odr_en, sizeof(*sru_res->diagnostics));
 840     yaz_mk_std_diagnostic(odr_en, sru_res->diagnostics,
 841                           yaz_diag_bib1_to_srw(bib1_code),
 842                           ddf->u.v2Addinfo);
 843     return 0;
 844 }
 845
 846
 847
 848 static mp::filter::Base* filter_creator()
 849 {
 850     return new mp::filter::SRUtoZ3950;
 851 }
 852
 853 extern "C" {
 854     struct metaproxy_1_filter_struct metaproxy_1_filter_sru_to_z3950 = {
 855         0,
 856         "sru_z3950",
 857         filter_creator
 858     };
 859 }
 860
 861
 862 /*
 863  * Local variables:
 864  * c-basic-offset: 4
 865  * indent-tabs-mode: nil
 866  * c-file-style: "stroustrup"
 867  * End:
 868  * vim: shiftwidth=4 tabstop=8 expandtab
 869  */