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
|
/* -*- 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 "KDriver.hxx"
#include "KDEInit.h"
#include "KConnection.hxx"
#include <rtl/strbuf.hxx>
#include <com/sun/star/configuration/theDefaultProvider.hpp>
#include <com/sun/star/sdb/SQLContext.hpp>
#include <com/sun/star/lang/NullPointerException.hpp>
#include <com/sun/star/frame/Desktop.hpp>
#include <comphelper/processfactory.hxx>
#include <cppuhelper/supportsservice.hxx>
#include <rtl/ustrbuf.hxx>
#include <tools/diagnose_ex.h>
#include "resource/kab_res.hrc"
#include "resource/sharedresources.hxx"
using namespace com::sun::star::uno;
using namespace com::sun::star::lang;
using namespace com::sun::star::beans;
using namespace com::sun::star::sdbc;
using namespace com::sun::star::sdb;
using namespace com::sun::star::frame;
using namespace connectivity::kab;
// = KabImplModule
KabImplModule::KabImplModule( const Reference< XComponentContext >& _rxContext )
:m_xContext(_rxContext)
,m_bAttemptedLoadModule(false)
,m_bAttemptedInitialize(false)
,m_hConnectorModule(NULL)
,m_pConnectionFactoryFunc(NULL)
,m_pApplicationInitFunc(NULL)
,m_pApplicationShutdownFunc(NULL)
,m_pKDEVersionCheckFunc(NULL)
{
if ( !m_xContext.is() )
throw NullPointerException();
}
bool KabImplModule::isKDEPresent()
{
if ( !impl_loadModule() )
return false;
return true;
}
KabImplModule::KDEVersionType KabImplModule::matchKDEVersion()
{
OSL_PRECOND( m_pKDEVersionCheckFunc, "KabImplModule::matchKDEVersion: module not loaded!" );
int nVersionInfo = (*m_pKDEVersionCheckFunc)();
if ( nVersionInfo < 0 )
return eTooOld;
if ( nVersionInfo > 0 )
return eToNew;
return eSupported;
}
namespace
{
template< typename FUNCTION >
void lcl_getFunctionFromModuleOrUnload( oslModule& _rModule, const sal_Char* _pAsciiSymbolName, FUNCTION& _rFunction )
{
_rFunction = NULL;
if ( _rModule )
{
const OUString sSymbolName = OUString::createFromAscii( _pAsciiSymbolName );
_rFunction = (FUNCTION)( osl_getSymbol( _rModule, sSymbolName.pData ) );
if ( !_rFunction )
{ // did not find the symbol
OStringBuffer aBuf;
aBuf.append( "lcl_getFunctionFromModuleOrUnload: could not find the symbol " );
aBuf.append( _pAsciiSymbolName );
OSL_FAIL( aBuf.makeStringAndClear().getStr() );
osl_unloadModule( _rModule );
_rModule = NULL;
}
}
}
}
extern "C" { void SAL_CALL thisModule() {} }
bool KabImplModule::impl_loadModule()
{
if ( m_bAttemptedLoadModule )
return ( m_hConnectorModule != NULL );
m_bAttemptedLoadModule = true;
OSL_ENSURE( !m_hConnectorModule && !m_pConnectionFactoryFunc && !m_pApplicationInitFunc && !m_pApplicationShutdownFunc && !m_pKDEVersionCheckFunc,
"KabImplModule::impl_loadModule: inconsistence: inconsistency (never attempted load before, but some values already set)!");
const OUString sModuleName( SAL_MODULENAME( "kabdrv1" ));
m_hConnectorModule = osl_loadModuleRelative( &thisModule, sModuleName.pData, SAL_LOADMODULE_NOW ); // LAZY! #i61335#
OSL_ENSURE( m_hConnectorModule, "KabImplModule::impl_loadModule: could not load the implementation library!" );
if ( !m_hConnectorModule )
return false;
lcl_getFunctionFromModuleOrUnload( m_hConnectorModule, "createKabConnection", m_pConnectionFactoryFunc );
lcl_getFunctionFromModuleOrUnload( m_hConnectorModule, "initKApplication", m_pApplicationInitFunc );
lcl_getFunctionFromModuleOrUnload( m_hConnectorModule, "shutdownKApplication", m_pApplicationShutdownFunc );
lcl_getFunctionFromModuleOrUnload( m_hConnectorModule, "matchKDEVersion", m_pKDEVersionCheckFunc );
if ( !m_hConnectorModule )
// one of the symbols did not exist
throw RuntimeException();
return true;
}
void KabImplModule::impl_unloadModule()
{
OSL_PRECOND( m_hConnectorModule != NULL, "KabImplModule::impl_unloadModule: no module!" );
osl_unloadModule( m_hConnectorModule );
m_hConnectorModule = NULL;
m_pConnectionFactoryFunc = NULL;
m_pApplicationInitFunc = NULL;
m_pApplicationShutdownFunc = NULL;
m_pKDEVersionCheckFunc = NULL;
m_bAttemptedLoadModule = false;
}
void KabImplModule::init()
{
if ( !impl_loadModule() )
impl_throwNoKdeException();
// if we're not running on a supported version, throw
KabImplModule::KDEVersionType eKDEVersion = matchKDEVersion();
if ( eKDEVersion == eTooOld )
impl_throwKdeTooOldException();
if ( ( eKDEVersion == eToNew ) && !impl_doAllowNewKDEVersion() )
impl_throwKdeTooNewException();
if ( !m_bAttemptedInitialize )
{
m_bAttemptedInitialize = true;
(*m_pApplicationInitFunc)();
}
}
bool KabImplModule::impl_doAllowNewKDEVersion()
{
try
{
Reference< XMultiServiceFactory > xConfigProvider(
com::sun::star::configuration::theDefaultProvider::get( m_xContext ) );
Sequence< Any > aCreationArgs(1);
aCreationArgs[0] <<= PropertyValue(
OUString( "nodepath" ),
0,
makeAny( KabDriver::impl_getConfigurationSettingsPath() ),
PropertyState_DIRECT_VALUE );
Reference< XPropertySet > xSettings( xConfigProvider->createInstanceWithArguments(
OUString( "com.sun.star.configuration.ConfigurationAccess" ),
aCreationArgs ),
UNO_QUERY_THROW );
sal_Bool bDisableCheck = sal_False;
xSettings->getPropertyValue("DisableKDEMaximumVersionCheck") >>= bDisableCheck;
return bDisableCheck != sal_False;
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
return false;
}
void KabImplModule::impl_throwNoKdeException()
{
::connectivity::SharedResources aResources;
const OUString sError( aResources.getResourceString(
STR_NO_KDE_INST
) );
impl_throwGenericSQLException( sError );
}
void KabImplModule::impl_throwKdeTooOldException()
{
::connectivity::SharedResources aResources;
const OUString sError( aResources.getResourceStringWithSubstitution(
STR_KDE_VERSION_TOO_OLD,
"$major$",OUString::number(MIN_KDE_VERSION_MAJOR),
"$minor$",OUString::number(MIN_KDE_VERSION_MINOR)
) );
impl_throwGenericSQLException( sError );
}
void KabImplModule::impl_throwGenericSQLException( const OUString& _rMessage )
{
SQLException aError;
aError.Message = _rMessage;
aError.SQLState = "S1000";
aError.ErrorCode = 0;
throw aError;
}
void KabImplModule::impl_throwKdeTooNewException()
{
::connectivity::SharedResources aResources;
SQLException aError;
aError.Message = aResources.getResourceStringWithSubstitution(
STR_KDE_VERSION_TOO_NEW,
"$major$",OUString::number(MIN_KDE_VERSION_MAJOR),
"$minor$",OUString::number(MIN_KDE_VERSION_MINOR)
);
aError.SQLState = "S1000";
aError.ErrorCode = 0;
SQLContext aDetails;
OUStringBuffer aMessage;
aMessage.append( aResources.getResourceString(STR_KDE_VERSION_TOO_NEW_WORK_AROUND) );
aMessage.appendAscii( "Sub disableKDEMaxVersionCheck\n" );
aMessage.appendAscii( " BasicLibraries.LoadLibrary( \"Tools\" )\n" );
aMessage.appendAscii( " Dim configNode as Object\n" );
aMessage.appendAscii( " configNode = GetRegistryKeyContent( \"" );
aMessage.append( KabDriver::impl_getConfigurationSettingsPath() );
aMessage.appendAscii( "\", true )\n" );
aMessage.appendAscii( " configNode.DisableKDEMaximumVersionCheck = TRUE\n" );
aMessage.appendAscii( " configNode.commitChanges\n" );
aMessage.appendAscii( "End Sub\n" );
aDetails.Message = aMessage.makeStringAndClear();
aError.NextException <<= aDetails;
throw aError;
}
KabConnection* KabImplModule::createConnection( KabDriver* _pDriver ) const
{
OSL_PRECOND( m_hConnectorModule, "KabImplModule::createConnection: not initialized!" );
void* pUntypedConnection = (*m_pConnectionFactoryFunc)( _pDriver );
if ( !pUntypedConnection )
throw RuntimeException();
return static_cast< KabConnection* >( pUntypedConnection );
}
void KabImplModule::shutdown()
{
if ( !m_hConnectorModule )
return;
(*m_pApplicationShutdownFunc)();
m_bAttemptedInitialize = false;
impl_unloadModule();
}
// = KabDriver
KabDriver::KabDriver(
const Reference< ::com::sun::star::uno::XComponentContext >& _rxContext)
: KDriver_BASE(m_aMutex),
m_xContext(_rxContext),
m_aImplModule(_rxContext)
{
if ( !m_xContext.is() )
throw NullPointerException();
osl_atomic_increment( &m_refCount );
try
{
Reference< XDesktop2 > xDesktop = Desktop::create( m_xContext);
xDesktop->addTerminateListener( this );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
osl_atomic_decrement( &m_refCount );
}
void KabDriver::disposing()
{
::osl::MutexGuard aGuard(m_aMutex);
// when driver will be destroied so all our connections have to be destroied as well
for (OWeakRefArray::iterator i = m_xConnections.begin(); m_xConnections.end() != i; ++i)
{
Reference< XComponent > xComp(i->get(), UNO_QUERY);
if (xComp.is())
xComp->dispose();
}
m_xConnections.clear();
WeakComponentImplHelperBase::disposing();
}
// static ServiceInfo
OUString KabDriver::getImplementationName_Static( ) throw(RuntimeException)
{
return OUString::createFromAscii( impl_getAsciiImplementationName() );
}
Sequence< OUString > KabDriver::getSupportedServiceNames_Static( ) throw (RuntimeException)
{
// which service is supported
// for more information @see com.sun.star.sdbc.Driver
Sequence< OUString > aSNS( 1 );
aSNS[0] = "com.sun.star.sdbc.Driver";
return aSNS;
}
OUString SAL_CALL KabDriver::getImplementationName( ) throw(RuntimeException, std::exception)
{
return getImplementationName_Static();
}
sal_Bool SAL_CALL KabDriver::supportsService( const OUString& _rServiceName ) throw(RuntimeException, std::exception)
{
return cppu::supportsService(this, _rServiceName);
}
Sequence< OUString > SAL_CALL KabDriver::getSupportedServiceNames( ) throw(RuntimeException, std::exception)
{
return getSupportedServiceNames_Static();
}
Reference< XConnection > SAL_CALL KabDriver::connect( const OUString& url, const Sequence< PropertyValue >& info ) throw(SQLException, RuntimeException, std::exception)
{
::osl::MutexGuard aGuard(m_aMutex);
m_aImplModule.init();
// create a new connection with the given properties and append it to our vector
KabConnection* pConnection = m_aImplModule.createConnection( this );
SAL_WARN_IF( !pConnection, "connectivity.kab", "KabDriver::connect: no connection has been created by the factory!" );
// by definition, the factory function returned an object which was acquired once
Reference< XConnection > xConnection = pConnection;
pConnection->release();
// late constructor call which can throw exception and allows a correct dtor call when so
pConnection->construct( url, info );
// remember it
m_xConnections.push_back( WeakReferenceHelper( *pConnection ) );
return xConnection;
}
sal_Bool SAL_CALL KabDriver::acceptsURL( const OUString& url )
throw(SQLException, RuntimeException, std::exception)
{
::osl::MutexGuard aGuard(m_aMutex);
if ( !m_aImplModule.isKDEPresent() )
return sal_False;
// here we have to look whether we support this URL format
return url.startsWith("sdbc:address:kab:");
}
Sequence< DriverPropertyInfo > SAL_CALL KabDriver::getPropertyInfo( const OUString&, const Sequence< PropertyValue >& ) throw(SQLException, RuntimeException, std::exception)
{
// if you have something special to say, return it here :-)
return Sequence< DriverPropertyInfo >();
}
sal_Int32 SAL_CALL KabDriver::getMajorVersion( ) throw(RuntimeException, std::exception)
{
return KAB_DRIVER_VERSION_MAJOR;
}
sal_Int32 SAL_CALL KabDriver::getMinorVersion( ) throw(RuntimeException, std::exception)
{
return KAB_DRIVER_VERSION_MINOR;
}
void SAL_CALL KabDriver::queryTermination( const EventObject& ) throw (TerminationVetoException, RuntimeException, std::exception)
{
// nothing to do, nothing to veto
}
void SAL_CALL KabDriver::notifyTermination( const EventObject& ) throw (RuntimeException, std::exception)
{
m_aImplModule.shutdown();
}
void SAL_CALL KabDriver::disposing( const EventObject& ) throw (RuntimeException, std::exception)
{
// not interested in (this is the disposing of the desktop, if any)
}
const sal_Char* KabDriver::impl_getAsciiImplementationName()
{
return "com.sun.star.comp.sdbc.kab.Driver";
// this name is referenced in the configuration and in the kab.xml
// Please be careful when changing it.
}
OUString KabDriver::impl_getConfigurationSettingsPath()
{
OUStringBuffer aPath;
aPath.appendAscii( "/org.openoffice.Office.DataAccess/DriverSettings/" );
aPath.appendAscii( "com.sun.star.comp.sdbc.kab.Driver" );
return aPath.makeStringAndClear();
}
Reference< XInterface > SAL_CALL KabDriver::Create( const Reference< XMultiServiceFactory >& _rxFactory ) throw( Exception )
{
return *(new KabDriver( comphelper::getComponentContext(_rxFactory)));
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|