1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2008 Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "package.hpp"
24 #include "filter_backend_test.hpp"
31 #include <boost/thread/mutex.hpp>
35 #include <yaz/otherinfo.h>
36 #include <yaz/diagbib1.h>
37 #include <yaz/oid_db.h>
39 namespace mp = metaproxy_1;
40 namespace yf = mp::filter;
43 namespace metaproxy_1 {
48 class BackendTest::Rep {
49 friend class BackendTest;
52 ODR odr, Odr_oid *preferredRecordSyntax,
53 Z_ElementSetNames *esn,
54 int start, int number, int &error_code, std::string &addinfo,
55 int *number_returned, int *next_position);
57 bool m_support_named_result_sets;
59 session_map<Session_info> m_sessions;
65 static const int result_set_size = 42;
67 // an ISO2709 USMARC/MARC21 record that we return..
68 static const char *marc_record =
69 "\x30\x30\x33\x36\x36\x6E\x61\x6D\x20\x20\x32\x32\x30\x30\x31\x36"
70 "\x39\x38\x61\x20\x34\x35\x30\x30\x30\x30\x31\x30\x30\x31\x33\x30"
71 "\x30\x30\x30\x30\x30\x30\x33\x30\x30\x30\x34\x30\x30\x30\x31\x33"
72 "\x30\x30\x35\x30\x30\x31\x37\x30\x30\x30\x31\x37\x30\x30\x38\x30"
73 "\x30\x34\x31\x30\x30\x30\x33\x34\x30\x31\x30\x30\x30\x31\x37\x30"
74 "\x30\x31\x37\x39\x30\x34\x30\x30\x30\x31\x33\x30\x30\x30\x37\x35"
75 "\x30\x35\x30\x30\x30\x31\x32\x30\x30\x30\x38\x38\x31\x30\x30\x30"
76 "\x30\x31\x37\x30\x30\x31\x30\x30\x32\x34\x35\x30\x30\x33\x30\x30"
77 "\x30\x31\x31\x37\x32\x36\x30\x30\x30\x31\x32\x30\x30\x31\x34\x37"
78 "\x32\x36\x33\x30\x30\x30\x39\x30\x30\x31\x35\x39\x33\x30\x30\x30"
79 "\x30\x31\x31\x30\x30\x31\x36\x38\x1E\x20\x20\x20\x31\x31\x32\x32"
80 "\x34\x34\x36\x36\x20\x1E\x44\x4C\x43\x1E\x30\x30\x30\x30\x30\x30"
81 "\x30\x30\x30\x30\x30\x30\x30\x30\x2E\x30\x1E\x39\x31\x30\x37\x31"
82 "\x30\x63\x31\x39\x39\x31\x30\x37\x30\x31\x6E\x6A\x75\x20\x20\x20"
83 "\x20\x20\x20\x20\x20\x20\x20\x20\x30\x30\x30\x31\x30\x20\x65\x6E"
84 "\x67\x20\x20\x1E\x20\x20\x1F\x61\x44\x4C\x43\x1F\x63\x44\x4C\x43"
85 "\x1E\x30\x30\x1F\x61\x31\x32\x33\x2D\x78\x79\x7A\x1E\x31\x30\x1F"
86 "\x61\x4A\x61\x63\x6B\x20\x43\x6F\x6C\x6C\x69\x6E\x73\x1E\x31\x30"
87 "\x1F\x61\x48\x6F\x77\x20\x74\x6F\x20\x70\x72\x6F\x67\x72\x61\x6D"
88 "\x20\x61\x20\x63\x6F\x6D\x70\x75\x74\x65\x72\x1E\x31\x20\x1F\x61"
89 "\x50\x65\x6E\x67\x75\x69\x6E\x1E\x20\x20\x1F\x61\x38\x37\x31\x30"
90 "\x1E\x20\x20\x1F\x61\x70\x2E\x20\x63\x6D\x2E\x1E\x20\x20\x1F\x61"
91 "\x20\x20\x20\x31\x31\x32\x32\x34\x34\x36\x36\x20\x1E\x1D";
94 yf::BackendTest::BackendTest() : m_p(new BackendTest::Rep) {
95 m_p->m_support_named_result_sets = false;
98 yf::BackendTest::~BackendTest() {
101 Z_Records *yf::BackendTest::Rep::fetch(
102 ODR odr, Odr_oid *preferredRecordSyntax,
103 Z_ElementSetNames *esn,
104 int start, int number, int &error_code, std::string &addinfo,
105 int *number_returned, int *next_position)
107 const char *element_set_name = "F"; // default to use
109 if (number + start - 1 > result_set_size || start < 1)
111 error_code = YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE;
115 if (!preferredRecordSyntax)
116 preferredRecordSyntax = odr_oiddup(odr, yaz_oid_recsyn_usmarc);
118 if (preferredRecordSyntax)
120 if (!oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
122 else if (!oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_usmarc))
126 error_code = YAZ_BIB1_RECORD_SYNTAX_UNSUPP;
131 // no element set, "B" and "F" are supported
134 if (esn->which != Z_ElementSetNames_generic)
137 = YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
140 element_set_name = esn->u.generic;
142 if (!strcmp(element_set_name, "B")
143 && !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_usmarc))
145 else if (!strcmp(element_set_name, "F")
146 && !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_usmarc))
148 else if (!strncmp(element_set_name, "FF", 2)
149 && !oid_oidcmp(preferredRecordSyntax, yaz_oid_recsyn_xml))
150 ; // Huge XML test record
154 = YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
155 addinfo = std::string(element_set_name);
158 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
159 rec->which = Z_Records_DBOSD;
160 rec->u.databaseOrSurDiagnostics = (Z_NamePlusRecordList *)
161 odr_malloc(odr, sizeof(Z_NamePlusRecordList));
162 rec->u.databaseOrSurDiagnostics->num_records = number;
163 rec->u.databaseOrSurDiagnostics->records = (Z_NamePlusRecord **)
164 odr_malloc(odr, sizeof(Z_NamePlusRecord *) * number);
166 for (i = 0; i<number; i++)
168 rec->u.databaseOrSurDiagnostics->records[i] = (Z_NamePlusRecord *)
169 odr_malloc(odr, sizeof(Z_NamePlusRecord));
170 Z_NamePlusRecord *npr = rec->u.databaseOrSurDiagnostics->records[i];
171 npr->databaseName = 0;
172 npr->which = Z_NamePlusRecord_databaseRecord;
174 if (!strncmp(element_set_name, "FF", 2))
175 { // Huge XML test record
177 if (element_set_name[2])
178 sz = atoi(element_set_name+2) * 1024;
181 char *tmp_rec = (char*) xmalloc(sz);
183 memset(tmp_rec, 'a', sz);
184 memcpy(tmp_rec, "<a>", 3);
185 memcpy(tmp_rec + sz - 4, "</a>", 4);
187 npr->u.databaseRecord = z_ext_record_xml(odr, tmp_rec, sz);
192 char *tmp_rec = odr_strdup(odr, marc_record);
194 sprintf(offset_str, "test__%09d_", i+start);
195 memcpy(tmp_rec+186, offset_str, strlen(offset_str));
196 npr->u.databaseRecord = z_ext_record_usmarc(
197 odr, tmp_rec, strlen(tmp_rec));
201 *number_returned = number;
202 if (start + number > result_set_size)
205 *next_position = start + number;
209 void yf::BackendTest::process(Package &package) const
211 Z_GDU *gdu = package.request().get();
213 if (!gdu || gdu->which != Z_GDU_Z3950)
217 Z_APDU *apdu_req = gdu->u.z3950;
218 Z_APDU *apdu_res = 0;
221 if (apdu_req->which != Z_APDU_initRequest &&
222 !m_p->m_sessions.exist(package.session()))
224 apdu_res = odr.create_close(apdu_req,
225 Z_Close_protocolError,
226 "no init for filter_backend_test");
227 package.session().close();
229 else if (apdu_req->which == Z_APDU_initRequest)
231 apdu_res = odr.create_initResponse(apdu_req, 0, 0);
232 Z_InitRequest *req = apdu_req->u.initRequest;
233 Z_InitResponse *resp = apdu_res->u.initResponse;
235 resp->implementationName = "backend_test";
236 if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
237 m_p->m_support_named_result_sets = true;
240 static const int masks[] = {
241 Z_Options_search, Z_Options_present,
242 Z_Options_namedResultSets, -1
244 for (i = 0; masks[i] != -1; i++)
245 if (ODR_MASK_GET(req->options, masks[i]))
246 ODR_MASK_SET(resp->options, masks[i]);
247 static const int versions[] = {
253 for (i = 0; versions[i] != -1; i++)
254 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
255 ODR_MASK_SET(resp->protocolVersion, versions[i]);
260 m_p->m_sessions.create(info, package.session());
262 else if (apdu_req->which == Z_APDU_searchRequest)
264 Z_SearchRequest *req = apdu_req->u.searchRequest;
266 if (!m_p->m_support_named_result_sets &&
267 strcmp(req->resultSetName, "default"))
270 odr.create_searchResponse(
271 apdu_req, YAZ_BIB1_RESULT_SET_NAMING_UNSUPP, 0);
275 Z_Records *records = 0;
276 int number_returned = 0;
277 int next_position = 0;
282 mp::util::piggyback(*req->smallSetUpperBound,
283 *req->largeSetLowerBound,
284 *req->mediumSetPresentNumber,
289 { // not a large set for sure
290 Z_ElementSetNames *esn;
291 if (number > *req->smallSetUpperBound)
292 esn = req->mediumSetElementSetNames;
294 esn = req->smallSetElementSetNames;
295 records = m_p->fetch(
296 odr, req->preferredRecordSyntax, esn,
305 odr.create_searchResponse(
306 apdu_req, error_code, addinfo.c_str());
307 Z_SearchResponse *resp = apdu_res->u.searchResponse;
308 *resp->resultCount = result_set_size;
313 odr.create_searchResponse(apdu_req, 0, 0);
314 Z_SearchResponse *resp = apdu_res->u.searchResponse;
315 *resp->resultCount = result_set_size;
316 *resp->numberOfRecordsReturned = number_returned;
317 *resp->nextResultSetPosition = next_position;
318 resp->records = records;
322 else if (apdu_req->which == Z_APDU_presentRequest)
324 Z_PresentRequest *req = apdu_req->u.presentRequest;
325 int number_returned = 0;
326 int next_position = 0;
329 Z_ElementSetNames *esn = 0;
331 if (req->recordComposition)
333 if (req->recordComposition->which == Z_RecordComp_simple)
334 esn = req->recordComposition->u.simple;
338 odr.create_presentResponse(
340 YAZ_BIB1_ONLY_A_SINGLE_ELEMENT_SET_NAME_SUPPORTED,
342 package.response() = apdu_res;
346 Z_Records *records = m_p->fetch(
347 odr, req->preferredRecordSyntax, esn,
348 *req->resultSetStartPoint, *req->numberOfRecordsRequested,
356 odr.create_presentResponse(apdu_req, error_code,
362 odr.create_presentResponse(apdu_req, 0, 0);
363 Z_PresentResponse *resp = apdu_res->u.presentResponse;
364 resp->records = records;
365 *resp->numberOfRecordsReturned = number_returned;
366 *resp->nextResultSetPosition = next_position;
371 apdu_res = odr.create_close(apdu_req,
372 Z_Close_protocolError,
373 "backend_test: unhandled APDU");
374 package.session().close();
377 package.response() = apdu_res;
379 if (package.session().is_closed())
380 m_p->m_sessions.release(package.session());
383 static mp::filter::Base* filter_creator()
385 return new mp::filter::BackendTest;
389 struct metaproxy_1_filter_struct metaproxy_1_filter_backend_test = {
400 * c-file-style: "Stroustrup"
401 * indent-tabs-mode: nil
403 * vim: shiftwidth=4 tabstop=8 expandtab