1 /* $Id: filter_virt_db.cpp,v 1.10 2005-10-29 15:54:29 adam Exp $
2 Copyright (c) 2005, Index Data.
11 #include "package.hpp"
13 #include <boost/thread/mutex.hpp>
15 #include "filter_virt_db.hpp"
19 #include <yaz/otherinfo.h>
20 #include <yaz/diagbib1.h>
26 namespace yf = yp2::filter;
31 Virt_db_set(yp2::Session &id, std::string setname,
32 std::string vhost, bool named_result_sets);
36 yp2::Session m_backend_session;
37 std::string m_backend_setname;
39 bool m_named_result_sets;
41 struct Virt_db_session {
42 Virt_db_session(yp2::Session &id, bool use_vhost);
44 yp2::Session m_session;
46 std::map<std::string,Virt_db_set> m_sets;
49 Virt_db_map(std::string vhost);
56 void release_session(Package &package);
57 void init(Package &package, Z_APDU *apdu, bool &move_later);
58 void search(Package &package, Z_APDU *apdu, bool &move_later);
59 void present(Package &package, Z_APDU *apdu, bool &move_later);
61 boost::mutex m_sessions_mutex;
62 std::map<yp2::Session,Virt_db_session>m_sessions;
63 std::map<std::string, Virt_db_map>m_maps;
65 typedef std::map<yp2::Session,Virt_db_session>::iterator Ses_it;
66 typedef std::map<std::string,Virt_db_set>::iterator Sets_it;
71 yf::Virt_db_set::Virt_db_set(yp2::Session &id, std::string setname,
72 std::string vhost, bool named_result_sets)
73 : m_backend_session(id), m_backend_setname(setname), m_vhost(vhost),
74 m_named_result_sets(named_result_sets)
79 yf::Virt_db_set::Virt_db_set()
84 yf::Virt_db_set::~Virt_db_set()
88 yf::Virt_db_map::Virt_db_map(std::string vhost)
93 yf::Virt_db_map::Virt_db_map()
97 yf::Virt_db_session::Virt_db_session()
103 yf::Virt_db_session::Virt_db_session(yp2::Session &id,
105 m_session(id) , m_use_vhost(use_vhost)
110 yf::Virt_db::Virt_db() : m_p(new Virt_db::Rep)
114 yf::Virt_db::~Virt_db() {
117 void yf::Virt_db::Rep::release_session(Package &package)
119 boost::mutex::scoped_lock lock(m_sessions_mutex);
121 m_sessions.erase(package.session());
124 void yf::Virt_db::Rep::present(Package &package, Z_APDU *apdu, bool &move_later){
126 Z_PresentRequest *req = apdu->u.presentRequest;
127 std::string resultSetId = req->resultSetId;
129 boost::mutex::scoped_lock lock(m_sessions_mutex);
131 Ses_it it = m_sessions.find(package.session());
132 if (it == m_sessions.end())
134 ODR odr = odr_createmem(ODR_ENCODE);
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();
148 if (it->second.m_use_vhost)
153 Sets_it sets_it = it->second.m_sets.find(resultSetId);
154 if (sets_it == it->second.m_sets.end())
156 ODR odr = odr_createmem(ODR_ENCODE);
157 Z_APDU *apdu = zget_APDU(odr, Z_APDU_presentResponse);
159 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
160 apdu->u.presentResponse->records = rec;
161 rec->which = Z_Records_NSD;
162 rec->u.nonSurrogateDiagnostic =
163 zget_DefaultDiagFormat(
165 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
166 resultSetId.c_str());
167 package.response() = apdu;
171 id = new yp2::Session(sets_it->second.m_backend_session);
173 ODR odr = odr_createmem(ODR_ENCODE);
175 // sending present to backend
176 Package present_package(*id, package.origin());
177 present_package.copy_filter(package);
179 req->resultSetId = odr_strdup(odr, "default");
180 present_package.request() = yazpp_1::GDU(apdu);
184 present_package.move();
186 if (present_package.session().is_closed())
188 ODR odr = odr_createmem(ODR_ENCODE);
189 Z_APDU *apdu = zget_APDU(odr, Z_APDU_presentResponse);
191 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
192 apdu->u.presentResponse->records = rec;
193 rec->which = Z_Records_NSD;
194 rec->u.nonSurrogateDiagnostic =
195 zget_DefaultDiagFormat(
197 YAZ_BIB1_RESULT_SET_NO_LONGER_EXISTS_UNILATERALLY_DELETED_BY_,
198 resultSetId.c_str());
199 package.response() = apdu;
203 boost::mutex::scoped_lock lock(m_sessions_mutex);
204 Ses_it it = m_sessions.find(package.session());
205 if (it != m_sessions.end())
206 it->second.m_sets.erase(resultSetId);
210 package.response() = present_package.response();
215 void yf::Virt_db::Rep::search(Package &package, Z_APDU *apdu, bool &move_later)
217 Z_SearchRequest *req = apdu->u.searchRequest;
219 std::string database;
220 std::string resultSetId = req->resultSetName;
221 bool support_named_result_sets = false; // whether backend supports it
223 boost::mutex::scoped_lock lock(m_sessions_mutex);
225 Ses_it it = m_sessions.find(package.session());
226 if (it == m_sessions.end())
228 ODR odr = odr_createmem(ODR_ENCODE);
230 Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
232 *apdu->u.close->closeReason = Z_Close_protocolError;
233 apdu->u.close->diagnosticInformation =
234 odr_strdup(odr, "no session for search request");
236 package.response() = apdu;
237 package.session().close();
241 if (it->second.m_use_vhost)
246 if (req->num_databaseNames != 1)
247 { // exactly one database must be specified
248 ODR odr = odr_createmem(ODR_ENCODE);
249 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
251 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
252 apdu->u.searchResponse->records = rec;
253 rec->which = Z_Records_NSD;
254 rec->u.nonSurrogateDiagnostic =
255 zget_DefaultDiagFormat(
256 odr, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
257 package.response() = apdu;
262 database = req->databaseNames[0];
263 std::map<std::string, Virt_db_map>::iterator map_it;
264 map_it = m_maps.find(database);
265 if (map_it == m_maps.end())
266 { // no map for database: return diagnostic
267 ODR odr = odr_createmem(ODR_ENCODE);
268 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
270 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
271 apdu->u.searchResponse->records = rec;
272 rec->which = Z_Records_NSD;
273 rec->u.nonSurrogateDiagnostic =
274 zget_DefaultDiagFormat(
275 odr, YAZ_BIB1_DATABASE_DOES_NOT_EXIST, database.c_str());
276 package.response() = apdu;
281 if (*req->replaceIndicator == 0)
283 Sets_it sets_it = it->second.m_sets.find(req->resultSetName);
284 if (sets_it != it->second.m_sets.end())
286 ODR odr = odr_createmem(ODR_ENCODE);
287 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
289 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
290 apdu->u.searchResponse->records = rec;
291 rec->which = Z_Records_NSD;
292 rec->u.nonSurrogateDiagnostic =
293 zget_DefaultDiagFormat(
295 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
297 package.response() = apdu;
303 it->second.m_sets.erase(req->resultSetName);
304 vhost = map_it->second.m_vhost;
306 // we might look for an existing session with same vhost
308 const char *vhost_cstr = vhost.c_str();
310 { // sending init to backend
311 Package init_package(id, package.origin());
312 init_package.copy_filter(package);
314 ODR odr = odr_createmem(ODR_ENCODE);
315 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
317 yaz_oi_set_string_oidval(&init_apdu->u.initRequest->otherInfo, odr,
318 VAL_PROXY, 1, vhost_cstr);
320 init_package.request() = init_apdu;
323 init_package.move(); // sending init
325 if (init_package.session().is_closed())
327 ODR odr = odr_createmem(ODR_ENCODE);
328 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
330 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
331 apdu->u.searchResponse->records = rec;
332 rec->which = Z_Records_NSD;
333 rec->u.nonSurrogateDiagnostic =
334 zget_DefaultDiagFormat(
335 odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
336 package.response() = apdu;
340 Z_GDU *gdu = init_package.response().get();
341 // we hope to get an init response
342 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
345 if (ODR_MASK_GET(gdu->u.z3950->u.initResponse->options,
346 Z_Options_namedResultSets))
347 support_named_result_sets = true;
351 ODR odr = odr_createmem(ODR_ENCODE);
352 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
354 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
355 apdu->u.searchResponse->records = rec;
356 rec->which = Z_Records_NSD;
357 rec->u.nonSurrogateDiagnostic =
358 zget_DefaultDiagFormat(
359 odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
360 package.response() = apdu;
366 // sending search to backend
367 Package search_package(id, package.origin());
369 search_package.copy_filter(package);
370 const char *sep = strchr(vhost_cstr, '/');
371 ODR odr = odr_createmem(ODR_ENCODE);
373 req->databaseNames[0] = odr_strdup(odr, sep+1);
375 *req->replaceIndicator = 1;
377 std::string backend_resultSetId = "default";
378 req->resultSetName = odr_strdup(odr, backend_resultSetId.c_str());
379 search_package.request() = yazpp_1::GDU(apdu);
383 search_package.move();
385 if (search_package.session().is_closed())
387 ODR odr = odr_createmem(ODR_ENCODE);
388 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
390 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
391 apdu->u.searchResponse->records = rec;
392 rec->which = Z_Records_NSD;
393 rec->u.nonSurrogateDiagnostic =
394 zget_DefaultDiagFormat(
395 odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
396 package.response() = apdu;
401 package.response() = search_package.response();
403 boost::mutex::scoped_lock lock(m_sessions_mutex);
404 Ses_it it = m_sessions.find(package.session());
405 if (it != m_sessions.end())
406 it->second.m_sets[resultSetId] =
407 Virt_db_set(id, backend_resultSetId, vhost,
408 support_named_result_sets);
411 void yf::Virt_db::Rep::init(Package &package, Z_APDU *apdu, bool &move_later)
413 release_session(package);
414 boost::mutex::scoped_lock lock(m_sessions_mutex);
416 Z_InitRequest *req = apdu->u.initRequest;
419 yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
422 ODR odr = odr_createmem(ODR_ENCODE);
424 Z_APDU *apdu = zget_APDU(odr, Z_APDU_initResponse);
425 Z_InitResponse *resp = apdu->u.initResponse;
428 static const int masks[] = {
429 Z_Options_search, Z_Options_present, Z_Options_namedResultSets, -1
431 for (i = 0; masks[i] != -1; i++)
432 if (ODR_MASK_GET(req->options, masks[i]))
433 ODR_MASK_SET(resp->options, masks[i]);
435 static const int versions[] = {
441 for (i = 0; versions[i] != -1; i++)
442 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
443 ODR_MASK_SET(resp->protocolVersion, versions[i]);
447 package.response() = apdu;
451 m_sessions[package.session()] = Virt_db_session(package.session(), false);
455 m_sessions[package.session()] = Virt_db_session(package.session(), true);
460 void yf::Virt_db::add_map_db2vhost(std::string db, std::string vhost)
462 m_p->m_maps[db] = Virt_db_map(vhost);
465 void yf::Virt_db::process(Package &package) const
467 Z_GDU *gdu = package.request().get();
469 if (!gdu || gdu->which != Z_GDU_Z3950)
473 bool move_later = false;
474 Z_APDU *apdu = gdu->u.z3950;
475 if (apdu->which == Z_APDU_initRequest)
477 m_p->init(package, apdu, move_later);
479 else if (apdu->which == Z_APDU_searchRequest)
481 m_p->search(package, apdu, move_later);
483 else if (apdu->which == Z_APDU_presentRequest)
485 m_p->present(package, apdu, move_later);
489 ODR odr = odr_createmem(ODR_ENCODE);
491 Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
493 *apdu->u.close->closeReason = Z_Close_protocolError;
495 apdu->u.close->diagnosticInformation =
496 odr_strdup(odr, "unsupported APDU in filter_virt_db");
498 package.response() = apdu;
499 package.session().close();
505 if (package.session().is_closed())
506 m_p->release_session(package);
513 * indent-tabs-mode: nil
514 * c-file-style: "stroustrup"
516 * vim: shiftwidth=4 tabstop=8 expandtab