1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include "ZPoolCollection.hxx"
#include "ZDriverWrapper.hxx"
#include "ZConnectionPool.hxx"
#include <com/sun/star/configuration/theDefaultProvider.hpp>
#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
#include <com/sun/star/beans/NamedValue.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/frame/Desktop.hpp>
#include <com/sun/star/reflection/ProxyFactory.hpp>
#include <com/sun/star/sdbc/DriverManager.hpp>
#include <comphelper/processfactory.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <osl/diagnose.h>
#include <sal/log.hxx>
#include <tools/diagnose_ex.h>
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::lang;
using namespace ::com::sun::star::sdbc;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::container;
using namespace ::com::sun::star::reflection;
using namespace ::osl;
using namespace connectivity;
static OUString getConnectionPoolNodeName()
{
return "org.openoffice.Office.DataAccess/ConnectionPool";
}
static OUString getEnablePoolingNodeName()
{
return "EnablePooling";
}
static OUString getDriverNameNodeName()
{
return "DriverName";
}
static OUString getDriverSettingsNodeName()
{
return "DriverSettings";
}
static OUString getEnableNodeName()
{
return "Enable";
}
OPoolCollection::OPoolCollection(const Reference< XComponentContext >& _rxContext)
:m_xContext(_rxContext)
{
// bootstrap all objects supporting the .sdb.Driver service
m_xManager = DriverManager::create( m_xContext );
m_xProxyFactory = ProxyFactory::create( m_xContext );
Reference<XPropertySet> xProp(getConfigPoolRoot(),UNO_QUERY);
if ( xProp.is() )
xProp->addPropertyChangeListener(getEnablePoolingNodeName(),this);
// attach as desktop listener to know when we have to release our pools
osl_atomic_increment( &m_refCount );
{
m_xDesktop = css::frame::Desktop::create( m_xContext );
m_xDesktop->addTerminateListener(this);
}
osl_atomic_decrement( &m_refCount );
}
OPoolCollection::~OPoolCollection()
{
clearConnectionPools(false);
}
Reference< XConnection > SAL_CALL OPoolCollection::getConnection( const OUString& _rURL )
{
return getConnectionWithInfo(_rURL,Sequence< PropertyValue >());
}
Reference< XConnection > SAL_CALL OPoolCollection::getConnectionWithInfo( const OUString& _rURL, const Sequence< PropertyValue >& _rInfo )
{
MutexGuard aGuard(m_aMutex);
Reference< XConnection > xConnection;
Reference< XDriver > xDriver;
Reference< XInterface > xDriverNode;
OUString sImplName;
if(isPoolingEnabledByUrl(_rURL,xDriver,sImplName,xDriverNode) && xDriver.is())
{
OConnectionPool* pConnectionPool = getConnectionPool(sImplName,xDriver,xDriverNode);
if(pConnectionPool)
xConnection = pConnectionPool->getConnectionWithInfo(_rURL,_rInfo);
}
else if(xDriver.is())
xConnection = xDriver->connect(_rURL,_rInfo);
return xConnection;
}
void SAL_CALL OPoolCollection::setLoginTimeout( sal_Int32 seconds )
{
MutexGuard aGuard(m_aMutex);
m_xManager->setLoginTimeout(seconds);
}
sal_Int32 SAL_CALL OPoolCollection::getLoginTimeout( )
{
MutexGuard aGuard(m_aMutex);
return m_xManager->getLoginTimeout();
}
OUString SAL_CALL OPoolCollection::getImplementationName( )
{
return getImplementationName_Static();
}
sal_Bool SAL_CALL OPoolCollection::supportsService( const OUString& _rServiceName )
{
return cppu::supportsService(this, _rServiceName);
}
Sequence< OUString > SAL_CALL OPoolCollection::getSupportedServiceNames( )
{
return getSupportedServiceNames_Static();
}
//---------------------------------------OPoolCollection----------------------------------
Reference< XInterface > OPoolCollection::CreateInstance(const Reference< XMultiServiceFactory >& _rxFactory)
{
return static_cast<XDriverManager*>(new OPoolCollection(comphelper::getComponentContext(_rxFactory)));
}
OUString OPoolCollection::getImplementationName_Static( )
{
return "com.sun.star.sdbc.OConnectionPool";
}
Sequence< OUString > OPoolCollection::getSupportedServiceNames_Static( )
{
Sequence< OUString > aSupported { "com.sun.star.sdbc.ConnectionPool" };
return aSupported;
}
Reference< XDriver > SAL_CALL OPoolCollection::getDriverByURL( const OUString& _rURL )
{
// returns the original driver when no connection pooling is enabled else it returns the proxy
MutexGuard aGuard(m_aMutex);
Reference< XDriver > xDriver;
Reference< XInterface > xDriverNode;
OUString sImplName;
if(isPoolingEnabledByUrl(_rURL,xDriver,sImplName,xDriverNode))
{
Reference< XDriver > xExistentProxy;
// look if we already have a proxy for this driver
for (const auto& [rxDriver, rxDriverRef] : m_aDriverProxies)
{
// hold the proxy alive as long as we're in this loop round
xExistentProxy = rxDriverRef;
if (xExistentProxy.is() && (rxDriver.get() == xDriver.get()))
// already created a proxy for this
break;
}
if (xExistentProxy.is())
{
xDriver = xExistentProxy;
}
else
{ // create a new proxy for the driver
// this allows us to control the connections created by it
Reference< XAggregation > xDriverProxy = m_xProxyFactory->createProxy(xDriver.get());
OSL_ENSURE(xDriverProxy.is(), "OConnectionPool::getDriverByURL: invalid proxy returned by the proxy factory!");
OConnectionPool* pConnectionPool = getConnectionPool(sImplName,xDriver,xDriverNode);
xDriver = new ODriverWrapper(xDriverProxy, pConnectionPool);
}
}
return xDriver;
}
bool OPoolCollection::isDriverPoolingEnabled(const OUString& _sDriverImplName,
Reference< XInterface >& _rxDriverNode)
{
bool bEnabled = false;
Reference<XInterface> xConnectionPoolRoot = getConfigPoolRoot();
// then look for which of them settings are stored in the configuration
Reference< XNameAccess > xDirectAccess(openNode(getDriverSettingsNodeName(),xConnectionPoolRoot),UNO_QUERY);
if(xDirectAccess.is())
{
Sequence< OUString > aDriverKeys = xDirectAccess->getElementNames();
const OUString* pDriverKeys = aDriverKeys.getConstArray();
const OUString* pDriverKeysEnd = pDriverKeys + aDriverKeys.getLength();
for (;pDriverKeys != pDriverKeysEnd; ++pDriverKeys)
{
// the name of the driver in this round
if(_sDriverImplName == *pDriverKeys)
{
_rxDriverNode = openNode(*pDriverKeys,xDirectAccess);
if(_rxDriverNode.is())
getNodeValue(getEnableNodeName(),_rxDriverNode) >>= bEnabled;
break;
}
}
}
return bEnabled;
}
bool OPoolCollection::isPoolingEnabled()
{
// the config node where all pooling relevant info are stored under
Reference<XInterface> xConnectionPoolRoot = getConfigPoolRoot();
// the global "enabled" flag
bool bEnabled = false;
if(xConnectionPoolRoot.is())
getNodeValue(getEnablePoolingNodeName(),xConnectionPoolRoot) >>= bEnabled;
return bEnabled;
}
Reference<XInterface> const & OPoolCollection::getConfigPoolRoot()
{
if(!m_xConfigNode.is())
m_xConfigNode = createWithProvider(
css::configuration::theDefaultProvider::get(m_xContext),
getConnectionPoolNodeName());
return m_xConfigNode;
}
bool OPoolCollection::isPoolingEnabledByUrl(const OUString& _sUrl,
Reference< XDriver >& _rxDriver,
OUString& _rsImplName,
Reference< XInterface >& _rxDriverNode)
{
bool bEnabled = false;
_rxDriver = m_xManager->getDriverByURL(_sUrl);
if (_rxDriver.is() && isPoolingEnabled())
{
Reference< XServiceInfo > xSerivceInfo(_rxDriver,UNO_QUERY);
OSL_ENSURE(xSerivceInfo.is(),"Each driver should have a XServiceInfo interface!");
if(xSerivceInfo.is())
{
// look for the implementation name of the driver
_rsImplName = xSerivceInfo->getImplementationName();
bEnabled = isDriverPoolingEnabled(_rsImplName,_rxDriverNode);
}
}
return bEnabled;
}
void OPoolCollection::clearConnectionPools(bool _bDispose)
{
for(auto& rEntry : m_aPools)
{
rEntry.second->clear(_bDispose);
}
m_aPools.clear();
}
OConnectionPool* OPoolCollection::getConnectionPool(const OUString& _sImplName,
const Reference< XDriver >& _xDriver,
const Reference< XInterface >& _xDriverNode)
{
OConnectionPool *pRet = nullptr;
OConnectionPools::const_iterator aFind = m_aPools.find(_sImplName);
if (aFind != m_aPools.end())
pRet = aFind->second.get();
else if (_xDriver.is() && _xDriverNode.is())
{
Reference<XPropertySet> xProp(_xDriverNode,UNO_QUERY);
if(xProp.is())
xProp->addPropertyChangeListener(getEnableNodeName(),this);
OConnectionPool* pConnectionPool = new OConnectionPool(_xDriver,_xDriverNode,m_xProxyFactory);
aFind = m_aPools.emplace(_sImplName,pConnectionPool).first;
pRet = aFind->second.get();
}
OSL_ENSURE(pRet, "Could not query DriverManager from ConnectionPool!");
return pRet;
}
Reference< XInterface > OPoolCollection::createWithProvider(const Reference< XMultiServiceFactory >& _rxConfProvider,
const OUString& _rPath)
{
OSL_ASSERT(_rxConfProvider.is());
Sequence< Any > args(1);
args[0] <<= NamedValue( "nodepath", makeAny(_rPath));
Reference< XInterface > xInterface(
_rxConfProvider->createInstanceWithArguments(
"com.sun.star.configuration.ConfigurationAccess",
args));
OSL_ENSURE(
xInterface.is(),
"::createWithProvider: could not create the node access!");
return xInterface;
}
Reference<XInterface> OPoolCollection::openNode(const OUString& _rPath,const Reference<XInterface>& _xTreeNode) throw()
{
Reference< XHierarchicalNameAccess > xHierarchyAccess(_xTreeNode, UNO_QUERY);
Reference< XNameAccess > xDirectAccess(_xTreeNode, UNO_QUERY);
Reference< XInterface > xNode;
try
{
if (xDirectAccess.is() && xDirectAccess->hasByName(_rPath))
{
xNode.set(xDirectAccess->getByName(_rPath), css::uno::UNO_QUERY);
SAL_WARN_IF(
!xNode.is(), "connectivity.cpool",
"OConfigurationNode::openNode: could not open the node!");
}
else if (xHierarchyAccess.is())
{
xNode.set(
xHierarchyAccess->getByHierarchicalName(_rPath),
css::uno::UNO_QUERY);
SAL_WARN_IF(
!xNode.is(), "connectivity.cpool",
"OConfigurationNode::openNode: could not open the node!");
}
}
catch(const NoSuchElementException&)
{
SAL_WARN("connectivity.cpool", "::openNode: there is no element named " <<
_rPath << "!");
}
catch(const Exception&)
{
css::uno::Any ex(DbgGetCaughtException());
SAL_WARN("connectivity.cpool", "OConfigurationNode::openNode: caught an exception while retrieving the node! " << exceptionToString(ex));
}
return xNode;
}
Any OPoolCollection::getNodeValue(const OUString& _rPath,const Reference<XInterface>& _xTreeNode) throw()
{
Reference< XHierarchicalNameAccess > xHierarchyAccess(_xTreeNode, UNO_QUERY);
Reference< XNameAccess > xDirectAccess(_xTreeNode, UNO_QUERY);
Any aReturn;
try
{
if (xDirectAccess.is() && xDirectAccess->hasByName(_rPath) )
{
aReturn = xDirectAccess->getByName(_rPath);
}
else if (xHierarchyAccess.is())
{
aReturn = xHierarchyAccess->getByHierarchicalName(_rPath);
}
}
catch(const NoSuchElementException&)
{
TOOLS_WARN_EXCEPTION("connectivity.cpool", "" );
}
return aReturn;
}
void SAL_CALL OPoolCollection::queryTermination( const EventObject& /*Event*/ )
{
}
void SAL_CALL OPoolCollection::notifyTermination( const EventObject& /*Event*/ )
{
clearDesktop();
}
void SAL_CALL OPoolCollection::disposing( const EventObject& Source )
{
MutexGuard aGuard(m_aMutex);
if ( m_xDesktop == Source.Source )
{
clearDesktop();
}
else
{
try
{
Reference<XPropertySet> xProp(Source.Source,UNO_QUERY);
if(Source.Source == m_xConfigNode)
{
if ( xProp.is() )
xProp->removePropertyChangeListener(getEnablePoolingNodeName(),this);
m_xConfigNode.clear();
}
else if ( xProp.is() )
xProp->removePropertyChangeListener(getEnableNodeName(),this);
}
catch(const Exception&)
{
SAL_WARN("connectivity.cpool", "Exception caught");
}
}
}
void SAL_CALL OPoolCollection::propertyChange( const css::beans::PropertyChangeEvent& evt )
{
MutexGuard aGuard(m_aMutex);
if(evt.Source == m_xConfigNode)
{
bool bEnabled = true;
evt.NewValue >>= bEnabled;
if(!bEnabled )
{
m_aDriverProxies.clear();
m_aDriverProxies = MapDriver2DriverRef();
clearConnectionPools(false);
}
}
else if(evt.Source.is())
{
bool bEnabled = true;
evt.NewValue >>= bEnabled;
if(!bEnabled)
{
OUString sThisDriverName;
getNodeValue(getDriverNameNodeName(),evt.Source) >>= sThisDriverName;
// 1st release the driver
// look if we already have a proxy for this driver
MapDriver2DriverRef::iterator aLookup = m_aDriverProxies.begin();
while( aLookup != m_aDriverProxies.end())
{
MapDriver2DriverRef::iterator aFind = aLookup;
Reference<XServiceInfo> xInfo(aLookup->first,UNO_QUERY);
++aLookup;
if(xInfo.is() && xInfo->getImplementationName() == sThisDriverName)
m_aDriverProxies.erase(aFind);
}
// 2nd clear the connectionpool
OConnectionPools::iterator aFind = m_aPools.find(sThisDriverName);
if(aFind != m_aPools.end())
{
aFind->second->clear(false);
m_aPools.erase(aFind);
}
}
}
}
void OPoolCollection::clearDesktop()
{
clearConnectionPools(true);
if ( m_xDesktop.is() )
m_xDesktop->removeTerminateListener(this);
m_xDesktop.clear();
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|