dbaccess/source/core/dataaccess/databaseregistrations.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <sal/config.h>
  21
  22 #include <com/sun/star/lang/IllegalAccessException.hpp>
  23 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  24 #include <com/sun/star/container/ElementExistException.hpp>
  25 #include <com/sun/star/container/NoSuchElementException.hpp>
  26 #include <com/sun/star/sdb/XDatabaseRegistrations.hpp>
  27
  28 #include <cppuhelper/basemutex.hxx>
  29 #include <comphelper/interfacecontainer3.hxx>
  30 #include <cppuhelper/implbase.hxx>
  31 #include <osl/diagnose.h>
  32 #include <unotools/pathoptions.hxx>
  33 #include <tools/urlobj.hxx>
  34 #include <unotools/confignode.hxx>
  35
  36 #include "databaseregistrations.hxx"
  37
  38 namespace dbaccess
  39 {
  40     using ::com::sun::star::uno::Reference;
  41     using ::com::sun::star::uno::RuntimeException;
  42     using ::com::sun::star::uno::Any;
  43     using ::com::sun::star::uno::Sequence;
  44     using ::com::sun::star::uno::XComponentContext;
  45     using ::com::sun::star::container::NoSuchElementException;
  46     using ::com::sun::star::lang::IllegalArgumentException;
  47     using ::com::sun::star::lang::IllegalAccessException;
  48     using ::com::sun::star::container::ElementExistException;
  49     using ::com::sun::star::sdb::XDatabaseRegistrations;
  50     using ::com::sun::star::sdb::XDatabaseRegistrationsListener;
  51     using ::com::sun::star::sdb::DatabaseRegistrationEvent;
  52
  53     constexpr OUString CONF_ROOT_PATH = u"org.openoffice.Office.DataAccess/RegisteredNames"_ustr;
  54     constexpr OUString LOCATION = u"Location"_ustr;
  55     constexpr OUString NAME = u"Name"_ustr;
  56
  57     // DatabaseRegistrations - declaration
  58     typedef ::cppu::WeakImplHelper<   XDatabaseRegistrations
  59                                    >   DatabaseRegistrations_Base;
  60
  61     namespace {
  62
  63     class DatabaseRegistrations :public ::cppu::BaseMutex
  64                                 ,public DatabaseRegistrations_Base
  65     {
  66     public:
  67         explicit DatabaseRegistrations( const Reference<XComponentContext>& _rxContext );
  68
  69     protected:
  70         virtual ~DatabaseRegistrations() override;
  71
  72     public:
  73         virtual sal_Bool SAL_CALL hasRegisteredDatabase( const OUString& Name ) override;
  74         virtual Sequence< OUString > SAL_CALL getRegistrationNames() override;
  75         virtual OUString SAL_CALL getDatabaseLocation( const OUString& Name ) override;
  76         virtual void SAL_CALL registerDatabaseLocation( const OUString& Name, const OUString& Location ) override;
  77         virtual void SAL_CALL revokeDatabaseLocation( const OUString& Name ) override;
  78         virtual void SAL_CALL changeDatabaseLocation( const OUString& Name, const OUString& NewLocation ) override;
  79         virtual sal_Bool SAL_CALL isDatabaseRegistrationReadOnly( const OUString& Name ) override;
  80         virtual void SAL_CALL addDatabaseRegistrationsListener( const Reference< XDatabaseRegistrationsListener >& Listener ) override;
  81         virtual void SAL_CALL removeDatabaseRegistrationsListener( const Reference< XDatabaseRegistrationsListener >& Listener ) override;
  82
  83     private:
  84         void
  85                 impl_checkValidName_common(std::u16string_view _rName);
  86         ::utl::OConfigurationNode
  87                 impl_checkValidName_throw_must_exist(const OUString& _rName);
  88         ::utl::OConfigurationNode
  89                 impl_checkValidName_throw_must_not_exist(const OUString& _rName);
  90
  91         void    impl_checkValidLocation_throw( std::u16string_view _rLocation );
  92
  93         /** retrieves the configuration node whose "Name" sub node has the given value
  94
  95             Since we separated the name of the registration node from the "Name" value of the registration, we cannot
  96             simply do a "getByName" (equivalent) when we want to retrieve the node for a given registration name.
  97             Instead, we must search all nodes.
  98
  99             If a node with the given display name does not exist, then a NoSuchElementException is thrown.
 100
 101             If no exception is thrown, then a valid node is returned: If the node existed it is returned.
 102         */
 103         ::utl::OConfigurationNode
 104                 impl_getNodeForName_throw_must_exist(const OUString& _rName);
 105
 106         /** retrieves the configuration node whose "Name" sub node has the given value
 107
 108             Since we separated the name of the registration node from the "Name" value of the registration, we cannot
 109             simply do a "getByName" (equivalent) when we want to retrieve the node for a given registration name.
 110             Instead, we must search all nodes.
 111
 112             If a node with the given name already exists, then an ElementExistException is thrown.
 113
 114             If no exception is thrown, then a valid node is returned: If the node did not yet exist a new node is created,
 115             in this case the root node is not yet committed.
 116         */
 117         ::utl::OConfigurationNode
 118                 impl_getNodeForName_throw_must_not_exist(const OUString& _rName);
 119
 120
 121         ::utl::OConfigurationNode
 122                 impl_getNodeForName_nothrow(std::u16string_view _rName);
 123
 124     private:
 125         Reference<XComponentContext>        m_aContext;
 126         ::utl::OConfigurationTreeRoot       m_aConfigurationRoot;
 127         ::comphelper::OInterfaceContainerHelper3<XDatabaseRegistrationsListener>  m_aRegistrationListeners;
 128     };
 129
 130     }
 131
 132     // DatabaseRegistrations - implementation
 133     DatabaseRegistrations::DatabaseRegistrations( const Reference<XComponentContext> & _rxContext )
 134         :m_aContext( _rxContext )
 135         ,m_aRegistrationListeners( m_aMutex )
 136     {
 137         m_aConfigurationRoot = ::utl::OConfigurationTreeRoot::createWithComponentContext(
 138             m_aContext, CONF_ROOT_PATH );
 139     }
 140
 141     DatabaseRegistrations::~DatabaseRegistrations()
 142     {
 143     }
 144
 145     ::utl::OConfigurationNode DatabaseRegistrations::impl_getNodeForName_nothrow( std::u16string_view _rName )
 146     {
 147         const Sequence< OUString > aNames( m_aConfigurationRoot.getNodeNames() );
 148         for ( auto const & nodeName : aNames )
 149         {
 150             ::utl::OConfigurationNode aNodeForName = m_aConfigurationRoot.openNode( nodeName );
 151
 152             OUString sTestName;
 153             OSL_VERIFY( aNodeForName.getNodeValue( NAME ) >>= sTestName );
 154             if ( sTestName == _rName )
 155                 return aNodeForName;
 156         }
 157         return ::utl::OConfigurationNode();
 158     }
 159
 160     ::utl::OConfigurationNode DatabaseRegistrations::impl_getNodeForName_throw_must_exist(const OUString& _rName)
 161     {
 162         ::utl::OConfigurationNode aNodeForName( impl_getNodeForName_nothrow( _rName ) );
 163
 164         if (!aNodeForName.isValid())
 165         {
 166             throw NoSuchElementException( _rName, *this );
 167         }
 168
 169         return aNodeForName;
 170     }
 171
 172     ::utl::OConfigurationNode DatabaseRegistrations::impl_getNodeForName_throw_must_not_exist(const OUString& _rName)
 173     {
 174         ::utl::OConfigurationNode aNodeForName( impl_getNodeForName_nothrow( _rName ) );
 175
 176         if (aNodeForName.isValid())
 177             throw ElementExistException( _rName, *this );
 178
 179         // make unique
 180         OUString sNewNodeName = "org.openoffice." + _rName;
 181         while ( m_aConfigurationRoot.hasByName( sNewNodeName ) )
 182         {
 183             sNewNodeName = "org.openoffice." + _rName + " 2";
 184         }
 185
 186         ::utl::OConfigurationNode aNewNode( m_aConfigurationRoot.createNode( sNewNodeName ) );
 187         aNewNode.setNodeValue( NAME, Any( _rName ) );
 188         return aNewNode;
 189     }
 190
 191     void DatabaseRegistrations::impl_checkValidName_common(std::u16string_view _rName)
 192     {
 193         if ( !m_aConfigurationRoot.isValid() )
 194             throw RuntimeException( OUString(), *this );
 195
 196         if ( _rName.empty() )
 197             throw IllegalArgumentException( OUString(), *this, 1 );
 198     }
 199
 200     ::utl::OConfigurationNode DatabaseRegistrations::impl_checkValidName_throw_must_exist(const OUString& _rName)
 201     {
 202         impl_checkValidName_common(_rName);
 203         return impl_getNodeForName_throw_must_exist(_rName);
 204     }
 205
 206     ::utl::OConfigurationNode DatabaseRegistrations::impl_checkValidName_throw_must_not_exist(const OUString& _rName)
 207     {
 208         impl_checkValidName_common(_rName);
 209         return impl_getNodeForName_throw_must_not_exist(_rName);
 210     }
 211
 212     void DatabaseRegistrations::impl_checkValidLocation_throw( std::u16string_view _rLocation )
 213     {
 214         if ( _rLocation.empty() )
 215             throw IllegalArgumentException( OUString(), *this, 2 );
 216
 217         INetURLObject aURL( _rLocation );
 218         if ( aURL.GetProtocol() == INetProtocol::NotValid )
 219             throw IllegalArgumentException( OUString(), *this, 2 );
 220     }
 221
 222     sal_Bool SAL_CALL DatabaseRegistrations::hasRegisteredDatabase( const OUString& Name )
 223     {
 224         ::osl::MutexGuard aGuard( m_aMutex );
 225         ::utl::OConfigurationNode aNodeForName = impl_getNodeForName_nothrow( Name );
 226         return aNodeForName.isValid();
 227     }
 228
 229     Sequence< OUString > SAL_CALL DatabaseRegistrations::getRegistrationNames()
 230     {
 231         ::osl::MutexGuard aGuard( m_aMutex );
 232         if ( !m_aConfigurationRoot.isValid() )
 233             throw RuntimeException( OUString(), *this );
 234
 235         const Sequence< OUString > aProgrammaticNames( m_aConfigurationRoot.getNodeNames() );
 236         Sequence< OUString > aDisplayNames( aProgrammaticNames.getLength() );
 237         OUString* pDisplayName = aDisplayNames.getArray();
 238
 239         for ( auto const & name : aProgrammaticNames )
 240         {
 241             ::utl::OConfigurationNode aRegistrationNode = m_aConfigurationRoot.openNode( name );
 242             OSL_VERIFY( aRegistrationNode.getNodeValue( NAME ) >>= *pDisplayName );
 243             ++pDisplayName;
 244         }
 245
 246         return aDisplayNames;
 247     }
 248
 249     OUString SAL_CALL DatabaseRegistrations::getDatabaseLocation( const OUString& Name )
 250     {
 251         ::osl::MutexGuard aGuard( m_aMutex );
 252
 253         ::utl::OConfigurationNode aNodeForName = impl_checkValidName_throw_must_exist(Name);
 254
 255         OUString sLocation;
 256         OSL_VERIFY( aNodeForName.getNodeValue( LOCATION ) >>= sLocation );
 257         sLocation = SvtPathOptions().SubstituteVariable( sLocation );
 258
 259         return sLocation;
 260     }
 261
 262     void SAL_CALL DatabaseRegistrations::registerDatabaseLocation( const OUString& Name, const OUString& Location )
 263     {
 264         ::osl::ClearableMutexGuard aGuard( m_aMutex );
 265
 266         // check
 267         impl_checkValidLocation_throw( Location );
 268         ::utl::OConfigurationNode aDataSourceRegistration = impl_checkValidName_throw_must_not_exist(Name);
 269
 270         // register
 271         aDataSourceRegistration.setNodeValue( LOCATION, Any( Location ) );
 272         m_aConfigurationRoot.commit();
 273
 274         // notify
 275         DatabaseRegistrationEvent aEvent( *this, Name, OUString(), Location );
 276         aGuard.clear();
 277         m_aRegistrationListeners.notifyEach( &XDatabaseRegistrationsListener::registeredDatabaseLocation, aEvent );
 278     }
 279
 280     void SAL_CALL DatabaseRegistrations::revokeDatabaseLocation( const OUString& Name )
 281     {
 282         ::osl::ClearableMutexGuard aGuard( m_aMutex );
 283
 284         // check
 285         ::utl::OConfigurationNode aNodeForName = impl_checkValidName_throw_must_exist(Name);
 286
 287         // obtain properties for notification
 288         OUString sLocation;
 289         OSL_VERIFY( aNodeForName.getNodeValue( LOCATION ) >>= sLocation );
 290
 291         // revoke
 292         if  (   aNodeForName.isReadonly()
 293             ||  !m_aConfigurationRoot.removeNode( aNodeForName.getLocalName() )
 294             )
 295             throw IllegalAccessException( OUString(), *this );
 296
 297         m_aConfigurationRoot.commit();
 298
 299         // notify
 300         DatabaseRegistrationEvent aEvent( *this, Name, sLocation, OUString() );
 301         aGuard.clear();
 302         m_aRegistrationListeners.notifyEach( &XDatabaseRegistrationsListener::revokedDatabaseLocation, aEvent );
 303     }
 304
 305     void SAL_CALL DatabaseRegistrations::changeDatabaseLocation( const OUString& Name, const OUString& NewLocation )
 306     {
 307         ::osl::ClearableMutexGuard aGuard( m_aMutex );
 308
 309         // check
 310         impl_checkValidLocation_throw( NewLocation );
 311         ::utl::OConfigurationNode aDataSourceRegistration = impl_checkValidName_throw_must_exist(Name);
 312
 313         if  ( aDataSourceRegistration.isReadonly() )
 314             throw IllegalAccessException( OUString(), *this );
 315
 316         // obtain properties for notification
 317         OUString sOldLocation;
 318         OSL_VERIFY( aDataSourceRegistration.getNodeValue( LOCATION ) >>= sOldLocation );
 319
 320         // change
 321         aDataSourceRegistration.setNodeValue( LOCATION, Any( NewLocation ) );
 322         m_aConfigurationRoot.commit();
 323
 324         // notify
 325         DatabaseRegistrationEvent aEvent( *this, Name, sOldLocation, NewLocation );
 326         aGuard.clear();
 327         m_aRegistrationListeners.notifyEach( &XDatabaseRegistrationsListener::changedDatabaseLocation, aEvent );
 328     }
 329
 330     sal_Bool SAL_CALL DatabaseRegistrations::isDatabaseRegistrationReadOnly( const OUString& Name )
 331     {
 332         ::osl::MutexGuard aGuard( m_aMutex );
 333         ::utl::OConfigurationNode aDataSourceRegistration = impl_checkValidName_throw_must_exist(Name);
 334         return aDataSourceRegistration.isReadonly();
 335     }
 336
 337     void SAL_CALL DatabaseRegistrations::addDatabaseRegistrationsListener( const Reference< XDatabaseRegistrationsListener >& Listener )
 338     {
 339         if ( Listener.is() )
 340             m_aRegistrationListeners.addInterface( Listener );
 341     }
 342
 343     void SAL_CALL DatabaseRegistrations::removeDatabaseRegistrationsListener( const Reference< XDatabaseRegistrationsListener >& Listener )
 344     {
 345         if ( Listener.is() )
 346             m_aRegistrationListeners.removeInterface( Listener );
 347     }
 348
 349     // DatabaseRegistrations - factory
 350     Reference< XDatabaseRegistrations > createDataSourceRegistrations( const Reference<XComponentContext> & _rxContext )
 351     {
 352         return new DatabaseRegistrations( _rxContext );
 353     }
 354
 355 } // namespace dbaccess
 356
 357 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */