src/filter_backend_test.cpp

   1 /* $Id: filter_backend_test.cpp,v 1.25 2007-04-16 21:54:52 adam Exp $
   2    Copyright (c) 2005-2007, Index Data.
   3
   4    See the LICENSE file for details
   5  */
   6
   7 #include "config.hpp"
   8
   9 #include "filter.hpp"
  10 #include "package.hpp"
  11 #include "util.hpp"
  12 #include "filter_backend_test.hpp"
  13
  14 #include <stdexcept>
  15 #include <list>
  16 #include <map>
  17 #include <iostream>
  18
  19 #include <boost/thread/mutex.hpp>
  20
  21 #include <yaz/zgdu.h>
  22 #include <yaz/log.h>
  23 #include <yaz/otherinfo.h>
  24 #include <yaz/diagbib1.h>
  25 #include <yaz/oid_db.h>
  26
  27 namespace mp = metaproxy_1;
  28 namespace yf = mp::filter;
  29 using namespace mp;
  30
  31 namespace metaproxy_1 {
  32     namespace filter {
  33         class Session_info {
  34             int dummy;
  35         };
  36         class BackendTest::Rep {
  37             friend class BackendTest;
  38
  39             Z_Records *fetch(
  40                 ODR odr, Odr_oid *preferredRecordSyntax,
  41                 Z_ElementSetNames *esn,
  42                 int start, int number, int &error_code, std::string &addinfo,
  43                 int *number_returned, int *next_position);
  44
  45             bool m_support_named_result_sets;
  46
  47             session_map<Session_info> m_sessions;
  48         };
  49     }
  50 }
  51
  52
  53 static const int result_set_size = 42;
  54
  55 // an ISO2709 USMARC/MARC21 record that we return..
  56 static const char *marc_record =
  57   "\x30\x30\x33\x36\x36\x6E\x61\x6D\x20\x20\x32\x32\x30\x30\x31\x36"
  58   "\x39\x38\x61\x20\x34\x35\x30\x30\x30\x30\x31\x30\x30\x31\x33\x30"
  59   "\x30\x30\x30\x30\x30\x30\x33\x30\x30\x30\x34\x30\x30\x30\x31\x33"
  60   "\x30\x30\x35\x30\x30\x31\x37\x30\x30\x30\x31\x37\x30\x30\x38\x30"
  61   "\x30\x34\x31\x30\x30\x30\x33\x34\x30\x31\x30\x30\x30\x31\x37\x30"
  62   "\x30\x31\x37\x39\x30\x34\x30\x30\x30\x31\x33\x30\x30\x30\x37\x35"
  63   "\x30\x35\x30\x30\x30\x31\x32\x30\x30\x30\x38\x38\x31\x30\x30\x30"
  64   "\x30\x31\x37\x30\x30\x31\x30\x30\x32\x34\x35\x30\x30\x33\x30\x30"
  65   "\x30\x31\x31\x37\x32\x36\x30\x30\x30\x31\x32\x30\x30\x31\x34\x37"
  66   "\x32\x36\x33\x30\x30\x30\x39\x30\x30\x31\x35\x39\x33\x30\x30\x30"
  67   "\x30\x31\x31\x30\x30\x31\x36\x38\x1E\x20\x20\x20\x31\x31\x32\x32"
  68   "\x34\x34\x36\x36\x20\x1E\x44\x4C\x43\x1E\x30\x30\x30\x30\x30\x30"
  69   "\x30\x30\x30\x30\x30\x30\x30\x30\x2E\x30\x1E\x39\x31\x30\x37\x31"
  70   "\x30\x63\x31\x39\x39\x31\x30\x37\x30\x31\x6E\x6A\x75\x20\x20\x20"
  71   "\x20\x20\x20\x20\x20\x20\x20\x20\x30\x30\x30\x31\x30\x20\x65\x6E"
  72   "\x67\x20\x20\x1E\x20\x20\x1F\x61\x44\x4C\x43\x1F\x63\x44\x4C\x43"
  73   "\x1E\x30\x30\x1F\x61\x31\x32\x33\x2D\x78\x79\x7A\x1E\x31\x30\x1F"
  74   "\x61\x4A\x61\x63\x6B\x20\x43\x6F\x6C\x6C\x69\x6E\x73\x1E\x31\x30"
  75   "\x1F\x61\x48\x6F\x77\x20\x74\x6F\x20\x70\x72\x6F\x67\x72\x61\x6D"
  76   "\x20\x61\x20\x63\x6F\x6D\x70\x75\x74\x65\x72\x1E\x31\x20\x1F\x61"
  77   "\x50\x65\x6E\x67\x75\x69\x6E\x1E\x20\x20\x1F\x61\x38\x37\x31\x30"
  78   "\x1E\x20\x20\x1F\x61\x70\x2E\x20\x63\x6D\x2E\x1E\x20\x20\x1F\x61"
  79   "\x20\x20\x20\x31\x31\x32\x32\x34\x34\x36\x36\x20\x1E\x1D";
  80
  81
  82 yf::BackendTest::BackendTest() : m_p(new BackendTest::Rep) {
  83     m_p->m_support_named_result_sets = false;
  84 }
  85
  86 yf::BackendTest::~BackendTest() {
  87 }
  88
  89 Z_Records *yf::BackendTest::Rep::fetch(
  90     ODR odr, Odr_oid *preferredRecordSyntax,
  91     Z_ElementSetNames *esn,
  92     int start, int number, int &error_code, std::string &addinfo,
  93     int *number_returned, int *next_position)
  94 {
  95     const char *element_set_name = "F"; // default to use
  96
  97     if (number + start - 1 > result_set_size || start < 1)
  98     {
  99         error_code = YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE;
 100         return 0;
 101     }
 102
 103     if (!preferredRecordSyntax)
 104         preferredRecordSyntax = odr_oiddup(odr, yaz_oid_recsyn_usmarc);
 105
 106     if (preferredRecordSyntax)
 107     {
 108         if (!oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
 109             ;
 110         else if (!oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_usmarc))
 111             ;
 112         else
 113         {
 114             error_code = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
 115             return 0;
 116         }
 117     }
 118
 119     // no element set, "B" and "F" are supported
 120     if (esn)
 121     {
 122         if (esn->which != Z_ElementSetNames_generic)
 123         {
 124             error_code
 125                 = YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 126             return 0;
 127         }
 128         element_set_name = esn->u.generic;
 129     }
 130     if (!strcmp(element_set_name, "B")
 131         && !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_usmarc))
 132         ; // Brief
 133     else if (!strcmp(element_set_name, "F")
 134              && !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_usmarc))
 135         ; // Full
 136     else if (!strncmp(element_set_name, "FF", 2)
 137              && !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
 138         ; // Huge XML test record
 139     else
 140     {
 141         error_code
 142             = YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 143         addinfo = std::string(element_set_name);
 144         return 0;
 145     }
 146     Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 147     rec->which = Z_Records_DBOSD;
 148     rec->u.databaseOrSurDiagnostics = (Z_NamePlusRecordList *)
 149         odr_malloc(odr, sizeof(Z_NamePlusRecordList));
 150     rec->u.databaseOrSurDiagnostics->num_records = number;
 151     rec->u.databaseOrSurDiagnostics->records = (Z_NamePlusRecord **)
 152         odr_malloc(odr, sizeof(Z_NamePlusRecord *) * number);
 153     int i;
 154     for (i = 0; i<number; i++)
 155     {
 156         rec->u.databaseOrSurDiagnostics->records[i] = (Z_NamePlusRecord *)
 157             odr_malloc(odr, sizeof(Z_NamePlusRecord));
 158         Z_NamePlusRecord *npr = rec->u.databaseOrSurDiagnostics->records[i];
 159         npr->databaseName = 0;
 160         npr->which = Z_NamePlusRecord_databaseRecord;
 161
 162         if (!strncmp(element_set_name, "FF", 2))
 163         {   // Huge XML test record
 164             size_t sz = 1024;
 165             if (element_set_name[2])
 166                 sz = atoi(element_set_name+2) * 1024;
 167             if (sz < 10)
 168                 sz = 10;
 169             char *tmp_rec = (char*) xmalloc(sz);
 170
 171             memset(tmp_rec, 'a', sz);
 172             memcpy(tmp_rec, "<a>", 3);
 173             memcpy(tmp_rec + sz - 4, "</a>", 4);
 174
 175             npr->u.databaseRecord = z_ext_record_xml(odr, tmp_rec, sz);
 176             xfree(tmp_rec);
 177         }
 178         else
 179         {
 180             char *tmp_rec = odr_strdup(odr, marc_record);
 181             char offset_str[30];
 182             sprintf(offset_str, "test__%09d_", i+start);
 183             memcpy(tmp_rec+186, offset_str, strlen(offset_str));
 184             npr->u.databaseRecord = z_ext_record_usmarc(
 185                 odr, tmp_rec, strlen(tmp_rec));
 186         }
 187
 188     }
 189     *number_returned = number;
 190     if (start + number > result_set_size)
 191         *next_position = 0;
 192     else
 193         *next_position = start + number;
 194     return rec;
 195 }
 196
 197 void yf::BackendTest::process(Package &package) const
 198 {
 199     Z_GDU *gdu = package.request().get();
 200
 201     if (!gdu || gdu->which != Z_GDU_Z3950)
 202         package.move();
 203     else
 204     {
 205         Z_APDU *apdu_req = gdu->u.z3950;
 206         Z_APDU *apdu_res = 0;
 207         mp::odr odr;
 208
 209         if (apdu_req->which != Z_APDU_initRequest &&
 210             !m_p->m_sessions.exist(package.session()))
 211         {
 212             apdu_res = odr.create_close(apdu_req,
 213                                         Z_Close_protocolError,
 214                                         "no init for filter_backend_test");
 215             package.session().close();
 216         }
 217         else if (apdu_req->which == Z_APDU_initRequest)
 218         {
 219             apdu_res = odr.create_initResponse(apdu_req, 0, 0);
 220             Z_InitRequest *req = apdu_req->u.initRequest;
 221             Z_InitResponse *resp = apdu_res->u.initResponse;
 222
 223             resp->implementationName = "backend_test";
 224             if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
 225                 m_p->m_support_named_result_sets = true;
 226
 227             int i;
 228             static const int masks[] = {
 229                 Z_Options_search, Z_Options_present,
 230                 Z_Options_namedResultSets, -1
 231             };
 232             for (i = 0; masks[i] != -1; i++)
 233                 if (ODR_MASK_GET(req->options, masks[i]))
 234                     ODR_MASK_SET(resp->options, masks[i]);
 235             static const int versions[] = {
 236                 Z_ProtocolVersion_1,
 237                 Z_ProtocolVersion_2,
 238                 Z_ProtocolVersion_3,
 239                 -1
 240             };
 241             for (i = 0; versions[i] != -1; i++)
 242                 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
 243                     ODR_MASK_SET(resp->protocolVersion, versions[i]);
 244                 else
 245                     break;
 246
 247             Session_info info;
 248             m_p->m_sessions.create(info, package.session());
 249         }
 250         else if (apdu_req->which == Z_APDU_searchRequest)
 251         {
 252             Z_SearchRequest *req = apdu_req->u.searchRequest;
 253
 254             if (!m_p->m_support_named_result_sets &&
 255                 strcmp(req->resultSetName, "default"))
 256             {
 257                 apdu_res =
 258                     odr.create_searchResponse(
 259                         apdu_req,  YAZ_BIB1_RESULT_SET_NAMING_UNSUPP, 0);
 260             }
 261             else
 262             {
 263                 Z_Records *records = 0;
 264                 int number_returned = 0;
 265                 int next_position = 0;
 266                 int error_code = 0;
 267                 std::string addinfo;
 268
 269                 int number = 0;
 270                 mp::util::piggyback(*req->smallSetUpperBound,
 271                                     *req->largeSetLowerBound,
 272                                     *req->mediumSetPresentNumber,
 273                                     result_set_size,
 274                                     number);
 275
 276                 if (number)
 277                 {   // not a large set for sure
 278                     Z_ElementSetNames *esn;
 279                     if (number > *req->smallSetUpperBound)
 280                         esn = req->mediumSetElementSetNames;
 281                     else
 282                         esn = req->smallSetElementSetNames;
 283                     records = m_p->fetch(
 284                         odr, req->preferredRecordSyntax, esn,
 285                         1, number,
 286                         error_code, addinfo,
 287                         &number_returned,
 288                         &next_position);
 289                 }
 290                 if (error_code)
 291                 {
 292                     apdu_res =
 293                         odr.create_searchResponse(
 294                             apdu_req, error_code, addinfo.c_str());
 295                     Z_SearchResponse *resp = apdu_res->u.searchResponse;
 296                     *resp->resultCount = result_set_size;
 297                 }
 298                 else
 299                 {
 300                     apdu_res =
 301                         odr.create_searchResponse(apdu_req, 0, 0);
 302                     Z_SearchResponse *resp = apdu_res->u.searchResponse;
 303                     *resp->resultCount = result_set_size;
 304                     *resp->numberOfRecordsReturned = number_returned;
 305                     *resp->nextResultSetPosition = next_position;
 306                     resp->records = records;
 307                 }
 308             }
 309         }
 310         else if (apdu_req->which == Z_APDU_presentRequest)
 311         {
 312             Z_PresentRequest *req = apdu_req->u.presentRequest;
 313             int number_returned = 0;
 314             int next_position = 0;
 315             int error_code = 0;
 316             std::string addinfo;
 317             Z_ElementSetNames *esn = 0;
 318
 319             if (req->recordComposition)
 320             {
 321                 if (req->recordComposition->which == Z_RecordComp_simple)
 322                     esn = req->recordComposition->u.simple;
 323                 else
 324                 {
 325                     apdu_res =
 326                         odr.create_presentResponse(
 327                             apdu_req,
 328                             YAZ_BIB1_ONLY_A_SINGLE_ELEMENT_SET_NAME_SUPPORTED,
 329                             0);
 330                     package.response() = apdu_res;
 331                     return;
 332                 }
 333             }
 334             Z_Records *records = m_p->fetch(
 335                 odr, req->preferredRecordSyntax, esn,
 336                 *req->resultSetStartPoint, *req->numberOfRecordsRequested,
 337                 error_code, addinfo,
 338                 &number_returned,
 339                 &next_position);
 340
 341             if (error_code)
 342             {
 343                 apdu_res =
 344                     odr.create_presentResponse(apdu_req, error_code,
 345                                                addinfo.c_str());
 346             }
 347             else
 348             {
 349                 apdu_res =
 350                     odr.create_presentResponse(apdu_req, 0, 0);
 351                 Z_PresentResponse *resp = apdu_res->u.presentResponse;
 352                 resp->records = records;
 353                 *resp->numberOfRecordsReturned = number_returned;
 354                 *resp->nextResultSetPosition = next_position;
 355             }
 356         }
 357         else
 358         {
 359             apdu_res = odr.create_close(apdu_req,
 360                                         Z_Close_protocolError,
 361                                         "backend_test: unhandled APDU");
 362             package.session().close();
 363         }
 364         if (apdu_res)
 365             package.response() = apdu_res;
 366     }
 367     if (package.session().is_closed())
 368         m_p->m_sessions.release(package.session());
 369 }
 370
 371 static mp::filter::Base* filter_creator()
 372 {
 373     return new mp::filter::BackendTest;
 374 }
 375
 376 extern "C" {
 377     struct metaproxy_1_filter_struct metaproxy_1_filter_backend_test = {
 378         0,
 379         "backend_test",
 380         filter_creator
 381     };
 382 }
 383
 384
 385 /*
 386  * Local variables:
 387  * c-basic-offset: 4
 388  * indent-tabs-mode: nil
 389  * c-file-style: "stroustrup"
 390  * End:
 391  * vim: shiftwidth=4 tabstop=8 expandtab
 392  */