src/filter_backend_test.cpp

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