src/filter_backend_test.cpp

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