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
|
/*************************************************************************
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_dbaccess.hxx"
/** === begin UNO includes === **/
#include <com/sun/star/sdb/XDatabaseRegistrations.hpp>
/** === end UNO includes === **/
#include <comphelper/componentcontext.hxx>
#include <cppuhelper/basemutex.hxx>
#include <cppuhelper/interfacecontainer.hxx>
#include <cppuhelper/implbase1.hxx>
#include <rtl/ustrbuf.hxx>
#include <unotools/pathoptions.hxx>
#include <tools/urlobj.hxx>
#include <unotools/confignode.hxx>
//........................................................................
namespace dbaccess
{
//........................................................................
/** === begin UNO using === **/
using ::com::sun::star::uno::Reference;
using ::com::sun::star::uno::XInterface;
using ::com::sun::star::uno::UNO_QUERY;
using ::com::sun::star::uno::UNO_QUERY_THROW;
using ::com::sun::star::uno::UNO_SET_THROW;
using ::com::sun::star::uno::Exception;
using ::com::sun::star::uno::RuntimeException;
using ::com::sun::star::uno::Any;
using ::com::sun::star::uno::makeAny;
using ::com::sun::star::uno::Sequence;
using ::com::sun::star::uno::Type;
using ::com::sun::star::container::NoSuchElementException;
using ::com::sun::star::lang::IllegalArgumentException;
using ::com::sun::star::lang::IllegalAccessException;
using ::com::sun::star::container::ElementExistException;
using ::com::sun::star::sdb::XDatabaseRegistrations;
using ::com::sun::star::sdb::XDatabaseRegistrationsListener;
using ::com::sun::star::sdb::DatabaseRegistrationEvent;
using ::com::sun::star::uno::XAggregation;
/** === end UNO using === **/
//--------------------------------------------------------------------
static const ::rtl::OUString& getConfigurationRootPath()
{
static ::rtl::OUString s_sNodeName = ::rtl::OUString::createFromAscii("org.openoffice.Office.DataAccess/RegisteredNames");
return s_sNodeName;
}
//--------------------------------------------------------------------
const ::rtl::OUString& getLocationNodeName()
{
static ::rtl::OUString s_sNodeName = ::rtl::OUString::createFromAscii( "Location" );
return s_sNodeName;
}
//--------------------------------------------------------------------
const ::rtl::OUString& getNameNodeName()
{
static ::rtl::OUString s_sNodeName = ::rtl::OUString::createFromAscii( "Name" );
return s_sNodeName;
}
//====================================================================
//= DatabaseRegistrations - declaration
//====================================================================
typedef ::cppu::WeakAggImplHelper1 < XDatabaseRegistrations
> DatabaseRegistrations_Base;
class DatabaseRegistrations :public ::cppu::BaseMutex
,public DatabaseRegistrations_Base
{
public:
DatabaseRegistrations( const ::comphelper::ComponentContext& _rxContext );
protected:
~DatabaseRegistrations();
public:
virtual ::sal_Bool SAL_CALL hasRegisteredDatabase( const ::rtl::OUString& _Name ) throw (IllegalArgumentException, RuntimeException);
virtual Sequence< ::rtl::OUString > SAL_CALL getRegistrationNames() throw (RuntimeException);
virtual ::rtl::OUString SAL_CALL getDatabaseLocation( const ::rtl::OUString& _Name ) throw (IllegalArgumentException, NoSuchElementException, RuntimeException);
virtual void SAL_CALL registerDatabaseLocation( const ::rtl::OUString& _Name, const ::rtl::OUString& _Location ) throw (IllegalArgumentException, ElementExistException, RuntimeException);
virtual void SAL_CALL revokeDatabaseLocation( const ::rtl::OUString& _Name ) throw (IllegalArgumentException, NoSuchElementException, IllegalAccessException, RuntimeException);
virtual void SAL_CALL changeDatabaseLocation( const ::rtl::OUString& Name, const ::rtl::OUString& NewLocation ) throw (IllegalArgumentException, NoSuchElementException, IllegalAccessException, RuntimeException);
virtual ::sal_Bool SAL_CALL isDatabaseRegistrationReadOnly( const ::rtl::OUString& _Name ) throw (IllegalArgumentException, NoSuchElementException, RuntimeException);
virtual void SAL_CALL addDatabaseRegistrationsListener( const Reference< XDatabaseRegistrationsListener >& Listener ) throw (RuntimeException);
virtual void SAL_CALL removeDatabaseRegistrationsListener( const Reference< XDatabaseRegistrationsListener >& Listener ) throw (RuntimeException);
private:
::utl::OConfigurationNode
impl_checkValidName_throw( const ::rtl::OUString& _rName, const bool _bMustExist );
void impl_checkValidLocation_throw( const ::rtl::OUString& _rLocation );
/** retrieves the configuration node whose "Name" sub node has the given value
Since we separated the name of the registration node from the "Name" value of the registration, we cannot
simply do a "getByName" (equivalent) when we want to retrieve the node for a given registration name.
Instead, we must search all nodes.
If _bMustExist is <TRUE/>, and a node with the given display name does not exist, then a NoSuchElementException
is thrown.
If _bMustExist is <FALSE/>, and a node with the given name already exists, then a ElementExistException is
thrown.
In either case, if no exception is thrown, then a valid node is returned: If the node existed and was allowed
to exist, it is returned, if the node did not yet exist, and was required to not exist, a new node is created.
However, in this case the root node is not yet committed.
*/
::utl::OConfigurationNode
impl_getNodeForName_throw( const ::rtl::OUString& _rName, const bool _bMustExist );
::utl::OConfigurationNode
impl_getNodeForName_nothrow( const ::rtl::OUString& _rName );
private:
::comphelper::ComponentContext m_aContext;
::utl::OConfigurationTreeRoot m_aConfigurationRoot;
::cppu::OInterfaceContainerHelper m_aRegistrationListeners;
};
//====================================================================
//= DatabaseRegistrations - implementation
//====================================================================
//--------------------------------------------------------------------
DatabaseRegistrations::DatabaseRegistrations( const ::comphelper::ComponentContext& _rxContext )
:m_aContext( _rxContext )
,m_aConfigurationRoot()
,m_aRegistrationListeners( m_aMutex )
{
m_aConfigurationRoot = ::utl::OConfigurationTreeRoot::createWithServiceFactory(
m_aContext.getLegacyServiceFactory(), getConfigurationRootPath(), -1, ::utl::OConfigurationTreeRoot::CM_UPDATABLE );
}
//--------------------------------------------------------------------
DatabaseRegistrations::~DatabaseRegistrations()
{
}
//--------------------------------------------------------------------
::utl::OConfigurationNode DatabaseRegistrations::impl_getNodeForName_nothrow( const ::rtl::OUString& _rName )
{
Sequence< ::rtl::OUString > aNames( m_aConfigurationRoot.getNodeNames() );
for ( const ::rtl::OUString* pName = aNames.getConstArray();
pName != aNames.getConstArray() + aNames.getLength();
++pName
)
{
::utl::OConfigurationNode aNodeForName = m_aConfigurationRoot.openNode( *pName );
::rtl::OUString sTestName;
OSL_VERIFY( aNodeForName.getNodeValue( getNameNodeName() ) >>= sTestName );
if ( sTestName == _rName )
return aNodeForName;
}
return ::utl::OConfigurationNode();
}
//--------------------------------------------------------------------
::utl::OConfigurationNode DatabaseRegistrations::impl_getNodeForName_throw( const ::rtl::OUString& _rName, const bool _bMustExist )
{
::utl::OConfigurationNode aNodeForName( impl_getNodeForName_nothrow( _rName ) );
if ( aNodeForName.isValid() )
{
if ( !_bMustExist )
throw ElementExistException( _rName, *this );
return aNodeForName;
}
if ( _bMustExist )
throw NoSuchElementException( _rName, *this );
::rtl::OUString sNewNodeName;
{
::rtl::OUStringBuffer aNewNodeName;
aNewNodeName.appendAscii( "org.openoffice." );
aNewNodeName.append( _rName );
// make unique
::rtl::OUStringBuffer aReset( aNewNodeName );
sNewNodeName = aNewNodeName.makeStringAndClear();
sal_Int32 i=2;
while ( m_aConfigurationRoot.hasByName( sNewNodeName ) )
{
aNewNodeName = aReset;
aNewNodeName.appendAscii( " " );
aNewNodeName.append( i );
sNewNodeName = aNewNodeName.makeStringAndClear();
}
}
::utl::OConfigurationNode aNewNode( m_aConfigurationRoot.createNode( sNewNodeName ) );
aNewNode.setNodeValue( getNameNodeName(), makeAny( _rName ) );
return aNewNode;
}
//--------------------------------------------------------------------
::utl::OConfigurationNode DatabaseRegistrations::impl_checkValidName_throw( const ::rtl::OUString& _rName, const bool _bMustExist )
{
if ( !m_aConfigurationRoot.isValid() )
throw RuntimeException( ::rtl::OUString(), *this );
if ( !_rName.getLength() )
throw IllegalArgumentException( ::rtl::OUString(), *this, 1 );
return impl_getNodeForName_throw( _rName, _bMustExist );
}
//--------------------------------------------------------------------
void DatabaseRegistrations::impl_checkValidLocation_throw( const ::rtl::OUString& _rLocation )
{
if ( !_rLocation.getLength() )
throw IllegalArgumentException( ::rtl::OUString(), *this, 2 );
INetURLObject aURL( _rLocation );
if ( aURL.GetProtocol() == INET_PROT_NOT_VALID )
throw IllegalArgumentException( ::rtl::OUString(), *this, 2 );
}
//--------------------------------------------------------------------
::sal_Bool SAL_CALL DatabaseRegistrations::hasRegisteredDatabase( const ::rtl::OUString& _Name ) throw (IllegalArgumentException, RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
::utl::OConfigurationNode aNodeForName = impl_getNodeForName_nothrow( _Name );
return aNodeForName.isValid();
}
//------------------------------------------------------------------------------
Sequence< ::rtl::OUString > SAL_CALL DatabaseRegistrations::getRegistrationNames() throw (RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
if ( !m_aConfigurationRoot.isValid() )
throw RuntimeException( ::rtl::OUString(), *this );
Sequence< ::rtl::OUString > aProgrammaticNames( m_aConfigurationRoot.getNodeNames() );
Sequence< ::rtl::OUString > aDisplayNames( aProgrammaticNames.getLength() );
::rtl::OUString* pDisplayName = aDisplayNames.getArray();
for ( const ::rtl::OUString* pName = aProgrammaticNames.getConstArray();
pName != aProgrammaticNames.getConstArray() + aProgrammaticNames.getLength();
++pName, ++pDisplayName
)
{
::utl::OConfigurationNode aRegistrationNode = m_aConfigurationRoot.openNode( *pName );
OSL_VERIFY( aRegistrationNode.getNodeValue( getNameNodeName() ) >>= *pDisplayName );
}
return aDisplayNames;
}
//--------------------------------------------------------------------
::rtl::OUString SAL_CALL DatabaseRegistrations::getDatabaseLocation( const ::rtl::OUString& _Name ) throw (IllegalArgumentException, NoSuchElementException, RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
::utl::OConfigurationNode aNodeForName = impl_checkValidName_throw( _Name, true );
::rtl::OUString sLocation;
OSL_VERIFY( aNodeForName.getNodeValue( getLocationNodeName() ) >>= sLocation );
sLocation = SvtPathOptions().SubstituteVariable( sLocation );
return sLocation;
}
//--------------------------------------------------------------------
void SAL_CALL DatabaseRegistrations::registerDatabaseLocation( const ::rtl::OUString& _Name, const ::rtl::OUString& _Location ) throw (IllegalArgumentException, ElementExistException, RuntimeException)
{
::osl::ClearableMutexGuard aGuard( m_aMutex );
// check
impl_checkValidLocation_throw( _Location );
::utl::OConfigurationNode aDataSourceRegistration = impl_checkValidName_throw( _Name, false );
// register
aDataSourceRegistration.setNodeValue( getLocationNodeName(), makeAny( _Location ) );
m_aConfigurationRoot.commit();
// notify
DatabaseRegistrationEvent aEvent( *this, _Name, ::rtl::OUString(), _Location );
aGuard.clear();
m_aRegistrationListeners.notifyEach( &XDatabaseRegistrationsListener::registeredDatabaseLocation, aEvent );
}
//--------------------------------------------------------------------
void SAL_CALL DatabaseRegistrations::revokeDatabaseLocation( const ::rtl::OUString& _Name ) throw (IllegalArgumentException, NoSuchElementException, IllegalAccessException, RuntimeException)
{
::osl::ClearableMutexGuard aGuard( m_aMutex );
// check
::utl::OConfigurationNode aNodeForName = impl_checkValidName_throw( _Name, true );
// obtain properties for notification
::rtl::OUString sLocation;
OSL_VERIFY( aNodeForName.getNodeValue( getLocationNodeName() ) >>= sLocation );
// revoke
if ( aNodeForName.isReadonly()
|| !m_aConfigurationRoot.removeNode( aNodeForName.getLocalName() )
)
throw IllegalAccessException( ::rtl::OUString(), *this );
m_aConfigurationRoot.commit();
// notify
DatabaseRegistrationEvent aEvent( *this, _Name, sLocation, ::rtl::OUString() );
aGuard.clear();
m_aRegistrationListeners.notifyEach( &XDatabaseRegistrationsListener::revokedDatabaseLocation, aEvent );
}
//--------------------------------------------------------------------
void SAL_CALL DatabaseRegistrations::changeDatabaseLocation( const ::rtl::OUString& _Name, const ::rtl::OUString& _NewLocation ) throw (IllegalArgumentException, NoSuchElementException, IllegalAccessException, RuntimeException)
{
::osl::ClearableMutexGuard aGuard( m_aMutex );
// check
impl_checkValidLocation_throw( _NewLocation );
::utl::OConfigurationNode aDataSourceRegistration = impl_checkValidName_throw( _Name, true );
if ( aDataSourceRegistration.isReadonly() )
throw IllegalAccessException( ::rtl::OUString(), *this );
// obtain properties for notification
::rtl::OUString sOldLocation;
OSL_VERIFY( aDataSourceRegistration.getNodeValue( getLocationNodeName() ) >>= sOldLocation );
// change
aDataSourceRegistration.setNodeValue( getLocationNodeName(), makeAny( _NewLocation ) );
m_aConfigurationRoot.commit();
// notify
DatabaseRegistrationEvent aEvent( *this, _Name, sOldLocation, _NewLocation );
aGuard.clear();
m_aRegistrationListeners.notifyEach( &XDatabaseRegistrationsListener::changedDatabaseLocation, aEvent );
}
//--------------------------------------------------------------------
::sal_Bool SAL_CALL DatabaseRegistrations::isDatabaseRegistrationReadOnly( const ::rtl::OUString& _Name ) throw (IllegalArgumentException, NoSuchElementException, RuntimeException)
{
::osl::MutexGuard aGuard( m_aMutex );
::utl::OConfigurationNode aDataSourceRegistration = impl_checkValidName_throw( _Name, true );
return aDataSourceRegistration.isReadonly();
}
//--------------------------------------------------------------------
void SAL_CALL DatabaseRegistrations::addDatabaseRegistrationsListener( const Reference< XDatabaseRegistrationsListener >& _Listener ) throw (RuntimeException)
{
if ( _Listener.is() )
m_aRegistrationListeners.addInterface( _Listener );
}
//--------------------------------------------------------------------
void SAL_CALL DatabaseRegistrations::removeDatabaseRegistrationsListener( const Reference< XDatabaseRegistrationsListener >& _Listener ) throw (RuntimeException)
{
if ( _Listener.is() )
m_aRegistrationListeners.removeInterface( _Listener );
}
//====================================================================
//= DatabaseRegistrations - factory
//====================================================================
Reference< XAggregation > createDataSourceRegistrations( const ::comphelper::ComponentContext& _rxContext )
{
return new DatabaseRegistrations( _rxContext );
}
//........................................................................
} // namespace dbaccess
//........................................................................
|
