src/filter_backend_test.cpp

   1 /* $Id: filter_backend_test.cpp,v 1.21 2006-10-10 09:47:50 adam Exp $
   2    Copyright (c) 2005-2006, 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
  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 (!(prefformat = oid_getentbyoid(preferredRecordSyntax)))
 104         form = VAL_NONE;
 105     else
 106         form = prefformat->value;
 107     switch(form)
 108     {
 109     case VAL_NONE:
 110     case VAL_USMARC:
 111         break;
 112     default:
 113         error_code = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
 114         return 0;
 115     }
 116
 117     // no element set, "B" and "F" are supported
 118     if (esn)
 119     {
 120         if (esn->which != Z_ElementSetNames_generic)
 121         {
 122             error_code
 123                 = YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 124             return 0;
 125         }
 126         const char *name = esn->u.generic;
 127         if (strcmp(name, "B") && strcmp(name, "F"))
 128         {
 129             error_code
 130                 = YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 131             addinfo = std::string(name);
 132             return 0;
 133         }
 134     }
 135     Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
 136     rec->which = Z_Records_DBOSD;
 137     rec->u.databaseOrSurDiagnostics = (Z_NamePlusRecordList *)
 138         odr_malloc(odr, sizeof(Z_NamePlusRecordList));
 139     rec->u.databaseOrSurDiagnostics->num_records = number;
 140     rec->u.databaseOrSurDiagnostics->records = (Z_NamePlusRecord **)
 141         odr_malloc(odr, sizeof(Z_NamePlusRecord *) * number);
 142     int i;
 143     for (i = 0; i<number; i++)
 144     {
 145         rec->u.databaseOrSurDiagnostics->records[i] = (Z_NamePlusRecord *)
 146             odr_malloc(odr, sizeof(Z_NamePlusRecord));
 147         Z_NamePlusRecord *npr = rec->u.databaseOrSurDiagnostics->records[i];
 148         npr->databaseName = 0;
 149         npr->which = Z_NamePlusRecord_databaseRecord;
 150
 151         char *tmp_rec = odr_strdup(odr, marc_record);
 152         char offset_str[30];
 153         sprintf(offset_str, "test__%09d_", i+start);
 154         memcpy(tmp_rec+186, offset_str, strlen(offset_str));
 155         npr->u.databaseRecord = z_ext_record(odr, VAL_USMARC,
 156                                              tmp_rec, strlen(tmp_rec));
 157
 158     }
 159     *number_returned = number;
 160     if (start + number > result_set_size)
 161         *next_position = 0;
 162     else
 163         *next_position = start + number;
 164     return rec;
 165 }
 166
 167 void yf::BackendTest::process(Package &package) const
 168 {
 169     Z_GDU *gdu = package.request().get();
 170
 171     if (!gdu || gdu->which != Z_GDU_Z3950)
 172         package.move();
 173     else
 174     {
 175         Z_APDU *apdu_req = gdu->u.z3950;
 176         Z_APDU *apdu_res = 0;
 177         mp::odr odr;
 178
 179         if (apdu_req->which != Z_APDU_initRequest &&
 180             !m_p->m_sessions.exist(package.session()))
 181         {
 182             apdu_res = odr.create_close(apdu_req,
 183                                         Z_Close_protocolError,
 184                                         "no init for filter_backend_test");
 185             package.session().close();
 186         }
 187         else if (apdu_req->which == Z_APDU_initRequest)
 188         {
 189             apdu_res = odr.create_initResponse(apdu_req, 0, 0);
 190             Z_InitRequest *req = apdu_req->u.initRequest;
 191             Z_InitResponse *resp = apdu_res->u.initResponse;
 192
 193             resp->implementationName = "backend_test";
 194             if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
 195                 m_p->m_support_named_result_sets = true;
 196
 197             int i;
 198             static const int masks[] = {
 199                 Z_Options_search, Z_Options_present,
 200                 Z_Options_namedResultSets, -1
 201             };
 202             for (i = 0; masks[i] != -1; i++)
 203                 if (ODR_MASK_GET(req->options, masks[i]))
 204                     ODR_MASK_SET(resp->options, masks[i]);
 205             static const int versions[] = {
 206                 Z_ProtocolVersion_1,
 207                 Z_ProtocolVersion_2,
 208                 Z_ProtocolVersion_3,
 209                 -1
 210             };
 211             for (i = 0; versions[i] != -1; i++)
 212                 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
 213                     ODR_MASK_SET(resp->protocolVersion, versions[i]);
 214                 else
 215                     break;
 216
 217             Session_info info;
 218             m_p->m_sessions.create(info, package.session());
 219         }
 220         else if (apdu_req->which == Z_APDU_searchRequest)
 221         {
 222             Z_SearchRequest *req = apdu_req->u.searchRequest;
 223
 224             if (!m_p->m_support_named_result_sets &&
 225                 strcmp(req->resultSetName, "default"))
 226             {
 227                 apdu_res =
 228                     odr.create_searchResponse(
 229                         apdu_req,  YAZ_BIB1_RESULT_SET_NAMING_UNSUPP, 0);
 230             }
 231             else
 232             {
 233                 Z_Records *records = 0;
 234                 int number_returned = 0;
 235                 int next_position = 0;
 236                 int error_code = 0;
 237                 std::string addinfo;
 238
 239                 int number = 0;
 240                 mp::util::piggyback(*req->smallSetUpperBound,
 241                                     *req->largeSetLowerBound,
 242                                     *req->mediumSetPresentNumber,
 243                                     result_set_size,
 244                                     number);
 245
 246                 if (number)
 247                 {   // not a large set for sure
 248                     Z_ElementSetNames *esn;
 249                     if (number > *req->smallSetUpperBound)
 250                         esn = req->mediumSetElementSetNames;
 251                     else
 252                         esn = req->smallSetElementSetNames;
 253                     records = m_p->fetch(
 254                         odr, req->preferredRecordSyntax, esn,
 255                         1, number,
 256                         error_code, addinfo,
 257                         &number_returned,
 258                         &next_position);
 259                 }
 260                 if (error_code)
 261                 {
 262                     apdu_res =
 263                         odr.create_searchResponse(
 264                             apdu_req, error_code, addinfo.c_str());
 265                     Z_SearchResponse *resp = apdu_res->u.searchResponse;
 266                     *resp->resultCount = result_set_size;
 267                 }
 268                 else
 269                 {
 270                     apdu_res =
 271                         odr.create_searchResponse(apdu_req, 0, 0);
 272                     Z_SearchResponse *resp = apdu_res->u.searchResponse;
 273                     *resp->resultCount = result_set_size;
 274                     *resp->numberOfRecordsReturned = number_returned;
 275                     *resp->nextResultSetPosition = next_position;
 276                     resp->records = records;
 277                 }
 278             }
 279         }
 280         else if (apdu_req->which == Z_APDU_presentRequest)
 281         {
 282             Z_PresentRequest *req = apdu_req->u.presentRequest;
 283             int number_returned = 0;
 284             int next_position = 0;
 285             int error_code = 0;
 286             std::string addinfo;
 287             Z_ElementSetNames *esn = 0;
 288
 289             if (req->recordComposition)
 290             {
 291                 if (req->recordComposition->which == Z_RecordComp_simple)
 292                     esn = req->recordComposition->u.simple;
 293                 else
 294                 {
 295                     apdu_res =
 296                         odr.create_presentResponse(
 297                             apdu_req,
 298                             YAZ_BIB1_ONLY_A_SINGLE_ELEMENT_SET_NAME_SUPPORTED,
 299                             0);
 300                     package.response() = apdu_res;
 301                     return;
 302                 }
 303             }
 304             Z_Records *records = m_p->fetch(
 305                 odr, req->preferredRecordSyntax, esn,
 306                 *req->resultSetStartPoint, *req->numberOfRecordsRequested,
 307                 error_code, addinfo,
 308                 &number_returned,
 309                 &next_position);
 310
 311             if (error_code)
 312             {
 313                 apdu_res =
 314                     odr.create_presentResponse(apdu_req, error_code,
 315                                                addinfo.c_str());
 316             }
 317             else
 318             {
 319                 apdu_res =
 320                     odr.create_presentResponse(apdu_req, 0, 0);
 321                 Z_PresentResponse *resp = apdu_res->u.presentResponse;
 322                 resp->records = records;
 323                 *resp->numberOfRecordsReturned = number_returned;
 324                 *resp->nextResultSetPosition = next_position;
 325             }
 326         }
 327         else
 328         {
 329             apdu_res = odr.create_close(apdu_req,
 330                                         Z_Close_protocolError,
 331                                         "backend_test: unhandled APDU");
 332             package.session().close();
 333         }
 334         if (apdu_res)
 335             package.response() = apdu_res;
 336     }
 337     if (package.session().is_closed())
 338         m_p->m_sessions.release(package.session());
 339 }
 340
 341 static mp::filter::Base* filter_creator()
 342 {
 343     return new mp::filter::BackendTest;
 344 }
 345
 346 extern "C" {
 347     struct metaproxy_1_filter_struct metaproxy_1_filter_backend_test = {
 348         0,
 349         "backend_test",
 350         filter_creator
 351     };
 352 }
 353
 354
 355 /*
 356  * Local variables:
 357  * c-basic-offset: 4
 358  * indent-tabs-mode: nil
 359  * c-file-style: "stroustrup"
 360  * End:
 361  * vim: shiftwidth=4 tabstop=8 expandtab
 362  */