src/filter_backend_test.cpp

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