1 /* $Id: filter_virt_db.cpp,v 1.9 2005-10-26 18:53:49 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() {
111 m_p = new Virt_db::Rep;
114 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;
130 boost::mutex::scoped_lock lock(m_sessions_mutex);
132 Ses_it it = m_sessions.find(package.session());
133 if (it == m_sessions.end())
135 ODR odr = odr_createmem(ODR_ENCODE);
137 Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
139 *apdu->u.close->closeReason = Z_Close_protocolError;
140 apdu->u.close->diagnosticInformation =
141 odr_strdup(odr, "no session for present request");
143 package.response() = apdu;
144 package.session().close();
149 if (it->second.m_use_vhost)
154 Sets_it sets_it = it->second.m_sets.find(resultSetId);
155 if (sets_it == it->second.m_sets.end())
157 ODR odr = odr_createmem(ODR_ENCODE);
158 Z_APDU *apdu = zget_APDU(odr, Z_APDU_presentResponse);
160 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
161 apdu->u.presentResponse->records = rec;
162 rec->which = Z_Records_NSD;
163 rec->u.nonSurrogateDiagnostic =
164 zget_DefaultDiagFormat(
166 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
167 resultSetId.c_str());
168 package.response() = apdu;
172 id = new yp2::Session(sets_it->second.m_backend_session);
174 ODR odr = odr_createmem(ODR_ENCODE);
176 // sending present to backend
177 Package present_package(*id, package.origin());
178 present_package.copy_filter(package);
180 req->resultSetId = odr_strdup(odr, "default");
181 present_package.request() = yazpp_1::GDU(apdu);
185 present_package.move();
187 if (present_package.session().is_closed())
189 ODR odr = odr_createmem(ODR_ENCODE);
190 Z_APDU *apdu = zget_APDU(odr, Z_APDU_presentResponse);
192 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
193 apdu->u.presentResponse->records = rec;
194 rec->which = Z_Records_NSD;
195 rec->u.nonSurrogateDiagnostic =
196 zget_DefaultDiagFormat(
198 YAZ_BIB1_RESULT_SET_NO_LONGER_EXISTS_UNILATERALLY_DELETED_BY_,
199 resultSetId.c_str());
200 package.response() = apdu;
204 boost::mutex::scoped_lock lock(m_sessions_mutex);
205 Ses_it it = m_sessions.find(package.session());
206 if (it != m_sessions.end())
207 it->second.m_sets.erase(resultSetId);
211 package.response() = present_package.response();
216 void yf::Virt_db::Rep::search(Package &package, Z_APDU *apdu, bool &move_later)
218 Z_SearchRequest *req = apdu->u.searchRequest;
220 std::string database;
221 std::string resultSetId = req->resultSetName;
222 bool support_named_result_sets = false; // whether backend supports it
224 boost::mutex::scoped_lock lock(m_sessions_mutex);
226 Ses_it it = m_sessions.find(package.session());
227 if (it == m_sessions.end())
229 ODR odr = odr_createmem(ODR_ENCODE);
231 Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
233 *apdu->u.close->closeReason = Z_Close_protocolError;
234 apdu->u.close->diagnosticInformation =
235 odr_strdup(odr, "no session for search request");
237 package.response() = apdu;
238 package.session().close();
242 if (it->second.m_use_vhost)
247 if (req->num_databaseNames != 1)
248 { // exactly one database must be specified
249 ODR odr = odr_createmem(ODR_ENCODE);
250 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
252 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
253 apdu->u.searchResponse->records = rec;
254 rec->which = Z_Records_NSD;
255 rec->u.nonSurrogateDiagnostic =
256 zget_DefaultDiagFormat(
257 odr, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
258 package.response() = apdu;
263 database = req->databaseNames[0];
264 std::map<std::string, Virt_db_map>::iterator map_it;
265 map_it = m_maps.find(database);
266 if (map_it == m_maps.end())
267 { // no map for database: return diagnostic
268 ODR odr = odr_createmem(ODR_ENCODE);
269 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
271 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
272 apdu->u.searchResponse->records = rec;
273 rec->which = Z_Records_NSD;
274 rec->u.nonSurrogateDiagnostic =
275 zget_DefaultDiagFormat(
276 odr, YAZ_BIB1_DATABASE_DOES_NOT_EXIST, database.c_str());
277 package.response() = apdu;
282 if (*req->replaceIndicator == 0)
284 Sets_it sets_it = it->second.m_sets.find(req->resultSetName);
285 if (sets_it != it->second.m_sets.end())
287 ODR odr = odr_createmem(ODR_ENCODE);
288 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
290 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
291 apdu->u.searchResponse->records = rec;
292 rec->which = Z_Records_NSD;
293 rec->u.nonSurrogateDiagnostic =
294 zget_DefaultDiagFormat(
296 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
298 package.response() = apdu;
304 it->second.m_sets.erase(req->resultSetName);
305 vhost = map_it->second.m_vhost;
307 // we might look for an existing session with same vhost
309 const char *vhost_cstr = vhost.c_str();
311 { // sending init to backend
312 Package init_package(id, package.origin());
313 init_package.copy_filter(package);
315 ODR odr = odr_createmem(ODR_ENCODE);
316 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
318 yaz_oi_set_string_oidval(&init_apdu->u.initRequest->otherInfo, odr,
319 VAL_PROXY, 1, vhost_cstr);
321 init_package.request() = init_apdu;
324 init_package.move(); // sending init
326 if (init_package.session().is_closed())
328 ODR odr = odr_createmem(ODR_ENCODE);
329 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
331 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
332 apdu->u.searchResponse->records = rec;
333 rec->which = Z_Records_NSD;
334 rec->u.nonSurrogateDiagnostic =
335 zget_DefaultDiagFormat(
336 odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
337 package.response() = apdu;
341 Z_GDU *gdu = init_package.response().get();
342 // we hope to get an init response
343 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
346 if (ODR_MASK_GET(gdu->u.z3950->u.initResponse->options,
347 Z_Options_namedResultSets))
348 support_named_result_sets = true;
352 ODR odr = odr_createmem(ODR_ENCODE);
353 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
355 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
356 apdu->u.searchResponse->records = rec;
357 rec->which = Z_Records_NSD;
358 rec->u.nonSurrogateDiagnostic =
359 zget_DefaultDiagFormat(
360 odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
361 package.response() = apdu;
367 // sending search to backend
368 Package search_package(id, package.origin());
370 search_package.copy_filter(package);
371 const char *sep = strchr(vhost_cstr, '/');
372 ODR odr = odr_createmem(ODR_ENCODE);
374 req->databaseNames[0] = odr_strdup(odr, sep+1);
376 *req->replaceIndicator = 1;
378 std::string backend_resultSetId = "default";
379 req->resultSetName = odr_strdup(odr, backend_resultSetId.c_str());
380 search_package.request() = yazpp_1::GDU(apdu);
384 search_package.move();
386 if (search_package.session().is_closed())
388 ODR odr = odr_createmem(ODR_ENCODE);
389 Z_APDU *apdu = zget_APDU(odr, Z_APDU_searchResponse);
391 Z_Records *rec = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
392 apdu->u.searchResponse->records = rec;
393 rec->which = Z_Records_NSD;
394 rec->u.nonSurrogateDiagnostic =
395 zget_DefaultDiagFormat(
396 odr, YAZ_BIB1_DATABASE_UNAVAILABLE, database.c_str());
397 package.response() = apdu;
402 package.response() = search_package.response();
404 boost::mutex::scoped_lock lock(m_sessions_mutex);
405 Ses_it it = m_sessions.find(package.session());
406 if (it != m_sessions.end())
407 it->second.m_sets[resultSetId] =
408 Virt_db_set(id, backend_resultSetId, vhost,
409 support_named_result_sets);
412 void yf::Virt_db::Rep::init(Package &package, Z_APDU *apdu, bool &move_later)
414 release_session(package);
415 boost::mutex::scoped_lock lock(m_sessions_mutex);
417 Z_InitRequest *req = apdu->u.initRequest;
420 yaz_oi_get_string_oidval(&req->otherInfo, VAL_PROXY, 1, 0);
423 ODR odr = odr_createmem(ODR_ENCODE);
425 Z_APDU *apdu = zget_APDU(odr, Z_APDU_initResponse);
426 Z_InitResponse *resp = apdu->u.initResponse;
429 static const int masks[] = {
430 Z_Options_search, Z_Options_present, Z_Options_namedResultSets, -1
432 for (i = 0; masks[i] != -1; i++)
433 if (ODR_MASK_GET(req->options, masks[i]))
434 ODR_MASK_SET(resp->options, masks[i]);
436 static const int versions[] = {
442 for (i = 0; versions[i] != -1; i++)
443 if (ODR_MASK_GET(req->protocolVersion, versions[i]))
444 ODR_MASK_SET(resp->protocolVersion, versions[i]);
448 package.response() = apdu;
452 m_sessions[package.session()] = Virt_db_session(package.session(), false);
456 m_sessions[package.session()] = Virt_db_session(package.session(), true);
461 void yf::Virt_db::add_map_db2vhost(std::string db, std::string vhost)
463 m_p->m_maps[db] = Virt_db_map(vhost);
466 void yf::Virt_db::process(Package &package) const
468 Z_GDU *gdu = package.request().get();
470 if (!gdu || gdu->which != Z_GDU_Z3950)
474 bool move_later = false;
475 Z_APDU *apdu = gdu->u.z3950;
476 if (apdu->which == Z_APDU_initRequest)
478 m_p->init(package, apdu, move_later);
480 else if (apdu->which == Z_APDU_searchRequest)
482 m_p->search(package, apdu, move_later);
484 else if (apdu->which == Z_APDU_presentRequest)
486 m_p->present(package, apdu, move_later);
490 ODR odr = odr_createmem(ODR_ENCODE);
492 Z_APDU *apdu = zget_APDU(odr, Z_APDU_close);
494 *apdu->u.close->closeReason = Z_Close_protocolError;
496 apdu->u.close->diagnosticInformation =
497 odr_strdup(odr, "unsupported APDU in filter_virt_db");
499 package.response() = apdu;
500 package.session().close();
506 if (package.session().is_closed())
507 m_p->release_session(package);
514 * indent-tabs-mode: nil
515 * c-file-style: "stroustrup"
517 * vim: shiftwidth=4 tabstop=8 expandtab