1 /* $Id: filter_virt_db.cpp,v 1.11 2005-10-30 17:13:36 adam Exp $
2 Copyright (c) 2005, Index Data.
11 #include "package.hpp"
13 #include <boost/thread/mutex.hpp>
16 #include "filter_virt_db.hpp"
20 #include <yaz/otherinfo.h>
21 #include <yaz/diagbib1.h>
27 namespace yf = yp2::filter;
32 Virt_db_set(yp2::Session &id, std::string setname,
33 std::string vhost, bool named_result_sets);
37 yp2::Session m_backend_session;
38 std::string m_backend_setname;
40 bool m_named_result_sets;
42 struct Virt_db_session {
43 Virt_db_session(yp2::Session &id, bool use_vhost);
45 yp2::Session m_session;
47 std::map<std::string,Virt_db_set> m_sets;
50 Virt_db_map(std::string vhost);
57 void release_session(Package &package);
58 void init(Package &package, Z_APDU *apdu, bool &move_later);
59 void search(Package &package, Z_APDU *apdu, bool &move_later);
60 void present(Package &package, Z_APDU *apdu, bool &move_later);
62 boost::mutex m_sessions_mutex;
63 std::map<yp2::Session,Virt_db_session>m_sessions;
64 std::map<std::string, Virt_db_map>m_maps;
66 typedef std::map<yp2::Session,Virt_db_session>::iterator Ses_it;
67 typedef std::map<std::string,Virt_db_set>::iterator Sets_it;
72 yf::Virt_db_set::Virt_db_set(yp2::Session &id, std::string setname,
73 std::string vhost, bool named_result_sets)
74 : m_backend_session(id), m_backend_setname(setname), m_vhost(vhost),
75 m_named_result_sets(named_result_sets)
80 yf::Virt_db_set::Virt_db_set()
85 yf::Virt_db_set::~Virt_db_set()
89 yf::Virt_db_map::Virt_db_map(std::string vhost)
94 yf::Virt_db_map::Virt_db_map()
98 yf::Virt_db_session::Virt_db_session()
104 yf::Virt_db_session::Virt_db_session(yp2::Session &id,
106 m_session(id) , m_use_vhost(use_vhost)
111 yf::Virt_db::Virt_db() : m_p(new Virt_db::Rep)
115 yf::Virt_db::~Virt_db() {
118 void yf::Virt_db::Rep::release_session(Package &package)
120 boost::mutex::scoped_lock lock(m_sessions_mutex);
122 m_sessions.erase(package.session());
125 void yf::Virt_db::Rep::present(Package &package, Z_APDU *apdu, bool &move_later){
127 Z_PresentRequest *req = apdu->u.presentRequest;
128 std::string resultSetId = req->resultSetId;
131 boost::mutex::scoped_lock lock(m_sessions_mutex);
133 Ses_it it = m_sessions.find(package.session());
134 if (it == m_sessions.end())
136 Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
138 *apdu->u.close->closeReason = Z_Close_protocolError;
139 apdu->u.close->diagnosticInformation =
140 odr_strdup(odr, "no session for present request");
142 package.response() = apdu;
143 package.session().close();
147 if (it->second.m_use_vhost)
152 Sets_it sets_it = it->second.m_sets.find(resultSetId);
153 if (sets_it == it->second.m_sets.end())
155 Z_APDU *apdu = zget_APDU(odr, Z_APDU_presentResponse);
157 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
158 apdu->u.presentResponse->records = rec;
159 rec->which = Z_Records_NSD;
160 rec->u.nonSurrogateDiagnostic =
161 zget_DefaultDiagFormat(
163 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
164 resultSetId.c_str());
165 package.response() = apdu;
169 id = new yp2::Session(sets_it->second.m_backend_session);
172 // sending present to backend
173 Package present_package(*id, package.origin());
174 present_package.copy_filter(package);
176 req->resultSetId = odr_strdup(odr, "default");
177 present_package.request() = yazpp_1::GDU(apdu);
179 present_package.move();
181 if (present_package.session().is_closed())
183 Z_APDU *apdu = zget_APDU(odr, Z_APDU_presentResponse);
185 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
186 apdu->u.presentResponse->records = rec;
187 rec->which = Z_Records_NSD;
188 rec->u.nonSurrogateDiagnostic =
189 zget_DefaultDiagFormat(
191 YAZ_BIB1_RESULT_SET_NO_LONGER_EXISTS_UNILATERALLY_DELETED_BY_,
192 resultSetId.c_str());
193 package.response() = apdu;
195 boost::mutex::scoped_lock lock(m_sessions_mutex);
196 Ses_it it = m_sessions.find(package.session());
197 if (it != m_sessions.end())
198 it->second.m_sets.erase(resultSetId);
202 package.response() = present_package.response();
207 void yf::Virt_db::Rep::search(Package &package, Z_APDU *apdu, bool &move_later)
209 Z_SearchRequest *req = apdu->u.searchRequest;
211 std::string database;
212 std::string resultSetId = req->resultSetName;
213 bool support_named_result_sets = false; // whether backend supports it
216 boost::mutex::scoped_lock lock(m_sessions_mutex);
218 Ses_it it = m_sessions.find(package.session());
219 if (it == m_sessions.end())
221 Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
223 *apdu->u.close->closeReason = Z_Close_protocolError;
224 apdu->u.close->diagnosticInformation =
225 odr_strdup(odr, "no session for search request");
227 package.response() = apdu;
228 package.session().close();
232 if (it->second.m_use_vhost)
237 if (req->num_databaseNames != 1)
238 { // exactly one database must be specified
239 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
241 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
242 apdu->u.searchResponse->records = rec;
243 rec->which = Z_Records_NSD;
244 rec->u.nonSurrogateDiagnostic =
245 zget_DefaultDiagFormat(
246 odr, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
247 package.response() = apdu;
251 database = req->databaseNames[0];
252 std::map<std::string, Virt_db_map>::iterator map_it;
253 map_it = m_maps.find(database);
254 if (map_it == m_maps.end())
255 { // no map for database: return diagnostic
256 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
258 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
259 apdu->u.searchResponse->records = rec;
260 rec->which = Z_Records_NSD;
261 rec->u.nonSurrogateDiagnostic =
262 zget_DefaultDiagFormat(
263 odr, YAZ_BIB1_DATABASE_DOES_NOT_EXIST, database.c_str());
264 package.response() = apdu;
268 if (*req->replaceIndicator == 0)
270 Sets_it sets_it = it->second.m_sets.find(req->resultSetName);
271 if (sets_it != it->second.m_sets.end())
273 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
275 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
276 apdu->u.searchResponse->records = rec;
277 rec->which = Z_Records_NSD;
278 rec->u.nonSurrogateDiagnostic =
279 zget_DefaultDiagFormat(
281 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
283 package.response() = apdu;
288 it->second.m_sets.erase(req->resultSetName);
289 vhost = map_it->second.m_vhost;
291 // we might look for an existing session with same vhost
293 const char *vhost_cstr = vhost.c_str();
295 { // sending init to backend
296 Package init_package(id, package.origin());
297 init_package.copy_filter(package);
299 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
301 yaz_oi_set_string_oidval(&init_apdu->u.initRequest->otherInfo, odr,
302 VAL_PROXY, 1, vhost_cstr);
304 init_package.request() = init_apdu;
306 init_package.move(); // sending init
308 if (init_package.session().is_closed())
310 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
312 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
313 apdu->u.searchResponse->records = rec;
314 rec->which = Z_Records_NSD;
315 rec->u.nonSurrogateDiagnostic =
316 zget_DefaultDiagFormat(
317 odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
318 package.response() = apdu;
320 Z_GDU *gdu = init_package.response().get();
321 // we hope to get an init response
322 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
325 if (ODR_MASK_GET(gdu->u.z3950->u.initResponse->options,
326 Z_Options_namedResultSets))
327 support_named_result_sets = true;
331 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
333 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
334 apdu->u.searchResponse->records = rec;
335 rec->which = Z_Records_NSD;
336 rec->u.nonSurrogateDiagnostic =
337 zget_DefaultDiagFormat(
338 odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
339 package.response() = apdu;
344 // sending search to backend
345 Package search_package(id, package.origin());
347 search_package.copy_filter(package);
348 const char *sep = strchr(vhost_cstr, '/');
350 req->databaseNames[0] = odr_strdup(odr, sep+1);
352 *req->replaceIndicator = 1;
354 std::string backend_resultSetId = "default";
355 req->resultSetName = odr_strdup(odr, backend_resultSetId.c_str());
356 search_package.request() = yazpp_1::GDU(apdu);
358 search_package.move();
360 if (search_package.session().is_closed())
362 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
364 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
365 apdu->u.searchResponse->records = rec;
366 rec->which = Z_Records_NSD;
367 rec->u.nonSurrogateDiagnostic =
368 zget_DefaultDiagFormat(
369 odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
370 package.response() = apdu;
374 package.response() = search_package.response();
376 boost::mutex::scoped_lock lock(m_sessions_mutex);
377 Ses_it it = m_sessions.find(package.session());
378 if (it != m_sessions.end())
379 it->second.m_sets[resultSetId] =
380 Virt_db_set(id, backend_resultSetId, vhost,
381 support_named_result_sets);
384 void yf::Virt_db::Rep::init(Package &package, Z_APDU *apdu, bool &move_later)
386 release_session(package);
387 boost::mutex::scoped_lock lock(m_sessions_mutex);
389 Z_InitRequest *req = apdu->u.initRequest;
392 yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
396 Z_APDU *apdu = zget_APDU(odr, Z_APDU_initResponse);
397 Z_InitResponse *resp = apdu->u.initResponse;
400 static const int masks[] = {
401 Z_Options_search, Z_Options_present, Z_Options_namedResultSets, -1
403 for (i = 0; masks[i] != -1; i++)
404 if (ODR_MASK_GET(req->options, masks[i]))
405 ODR_MASK_SET(resp->options, masks[i]);
407 static const int versions[] = {
413 for (i = 0; versions[i] != -1; i++)
414 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
415 ODR_MASK_SET(resp->protocolVersion, versions[i]);
419 package.response() = apdu;
421 m_sessions[package.session()] = Virt_db_session(package.session(), false);
425 m_sessions[package.session()] = Virt_db_session(package.session(), true);
430 void yf::Virt_db::add_map_db2vhost(std::string db, std::string vhost)
432 m_p->m_maps[db] = Virt_db_map(vhost);
435 void yf::Virt_db::process(Package &package) const
437 Z_GDU *gdu = package.request().get();
439 if (!gdu || gdu->which != Z_GDU_Z3950)
443 bool move_later = false;
444 Z_APDU *apdu = gdu->u.z3950;
445 if (apdu->which == Z_APDU_initRequest)
447 m_p->init(package, apdu, move_later);
449 else if (apdu->which == Z_APDU_searchRequest)
451 m_p->search(package, apdu, move_later);
453 else if (apdu->which == Z_APDU_presentRequest)
455 m_p->present(package, apdu, move_later);
461 Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
463 *apdu->u.close->closeReason = Z_Close_protocolError;
465 apdu->u.close->diagnosticInformation =
466 odr_strdup(odr, "unsupported APDU in filter_virt_db");
468 package.response() = apdu;
469 package.session().close();
474 if (package.session().is_closed())
475 m_p->release_session(package);
482 * indent-tabs-mode: nil
483 * c-file-style: "stroustrup"
485 * vim: shiftwidth=4 tabstop=8 expandtab