connectivity/source/drivers/kab/KDriver.hxx

   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 #ifndef INCLUDED_CONNECTIVITY_SOURCE_DRIVERS_KAB_KDRIVER_HXX
  21 #define INCLUDED_CONNECTIVITY_SOURCE_DRIVERS_KAB_KDRIVER_HXX
  22
  23 #include <com/sun/star/sdbc/XDriver.hpp>
  24 #include <com/sun/star/lang/XServiceInfo.hpp>
  25 #include <com/sun/star/frame/XTerminateListener.hpp>
  26 #include <comphelper/processfactory.hxx>
  27 #include <cppuhelper/compbase3.hxx>
  28 #include <osl/module.h>
  29
  30 namespace connectivity
  31 {
  32     namespace kab
  33     {
  34         class KabConnection;
  35         class KabDriver;
  36
  37         typedef void*   (SAL_CALL * ConnectionFactoryFunction)( void* _pDriver );
  38         typedef void    (SAL_CALL * ApplicationInitFunction)( void );
  39         typedef void    (SAL_CALL * ApplicationShutdownFunction)( void );
  40         typedef int     (SAL_CALL * KDEVersionCheckFunction)( void );
  41
  42         typedef std::vector< ::com::sun::star::uno::WeakReferenceHelper > OWeakRefArray;
  43
  44
  45         // = KabImplModule
  46
  47         class KabImplModule
  48         {
  49         private:
  50             ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
  51                                         m_xContext;
  52
  53             /// Did we already attempt to load the module and to retrieve the symbols?
  54             bool    m_bAttemptedLoadModule;
  55             /// Did we already check the KDE version and initialize the impl module (or at least attempted to)?
  56             bool    m_bAttemptedInitialize;
  57
  58             oslModule                   m_hConnectorModule;
  59             ConnectionFactoryFunction   m_pConnectionFactoryFunc;
  60             ApplicationInitFunction     m_pApplicationInitFunc;
  61             ApplicationShutdownFunction m_pApplicationShutdownFunc;
  62             KDEVersionCheckFunction     m_pKDEVersionCheckFunc;
  63
  64         public:
  65             KabImplModule( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext );
  66
  67             /** determines whether there is a KDE present in the environment
  68             */
  69             bool isKDEPresent();
  70
  71             enum KDEVersionType
  72             {
  73                 eTooOld,
  74                 eSupported,
  75                 eToNew
  76             };
  77             /** checks whether the KDE version we're running against is supported
  78                 @precond
  79                     the module is loaded, i.e impl_loadModule has successfully been called
  80             */
  81             KDEVersionType matchKDEVersion();
  82
  83             /** initializes the implementation module.
  84
  85                 @raises ::com::sun::star::uno::RuntimeException
  86                     if the module could be loaded, but required symbols are missing
  87                 @raises ::com::sun::star::sdbc::SQLException
  88                     if the KDE version we're running against is not supported, or no KDE was found at all
  89             */
  90             void init();
  91
  92             /** shuts down the impl module (and the KDE application, if we own it)
  93             */
  94             void shutdown();
  95
  96             /** creates a new connection
  97                 @precond
  98                     <member>init</member> has been called before
  99                 @raises ::com::sun::star::uno::RuntimeException
 100                     if no connection object could be created (which is a severe error, normally impossible)
 101             */
 102             KabConnection*  createConnection( KabDriver* _pDriver ) const;
 103
 104         private:
 105             /** loads the implementation module and retrieves the needed symbols
 106
 107                 Save against being called multiple times.
 108
 109                 @return <TRUE/> if the module could be loaded successfully.
 110
 111                 @raises ::com::sun::star::uno::RuntimeException
 112                     if the module could be loaded, but required symbols are missing
 113             */
 114             bool    impl_loadModule();
 115
 116             /** unloads the implementation module, and resets all function pointers to <NULL/>
 117                 @precond m_hConnectorModule is not <NULL/>
 118             */
 119             void    impl_unloadModule();
 120
 121             /** throws an SQLException saying than no KDE installation was found
 122             */
 123             void    impl_throwNoKdeException();
 124
 125             /** throws an SQLException saying that the found KDE version is too old
 126             */
 127             void    impl_throwKdeTooOldException();
 128
 129             /** throws an SQLException saying that the found KDE version is too new
 130             */
 131             void    impl_throwKdeTooNewException();
 132
 133             /** throws a generic SQL exception with SQLState S1000 and error code 0
 134             */
 135             void    impl_throwGenericSQLException( const OUString& _rMessage );
 136
 137             /** determines whether it's allowed to run on a too-new (not confirmed to work) version
 138             */
 139             bool    impl_doAllowNewKDEVersion();
 140         };
 141
 142
 143         // = KabDriver
 144
 145         typedef ::cppu::WeakComponentImplHelper3<   ::com::sun::star::sdbc::XDriver,
 146                                                     ::com::sun::star::lang::XServiceInfo,
 147                                                     ::com::sun::star::frame::XTerminateListener > KDriver_BASE;
 148         class KabDriver : public KDriver_BASE
 149         {
 150         protected:
 151             ::osl::Mutex                m_aMutex;           // mutex is need to control member access
 152             OWeakRefArray               m_xConnections;     // vector containing a list of all the
 153                                                             //  KabConnection objects for this Driver
 154             ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
 155                                         m_xContext;       // the multi-service factory
 156             KabImplModule               m_aImplModule;
 157
 158         public:
 159             static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL Create(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxFactory) throw( ::com::sun::star::uno::Exception );
 160
 161             // XServiceInfo - static versions
 162             static OUString getImplementationName_Static(  ) throw(::com::sun::star::uno::RuntimeException);
 163             static ::com::sun::star::uno::Sequence< OUString > getSupportedServiceNames_Static(  ) throw (::com::sun::star::uno::RuntimeException);
 164
 165             ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >
 166             getComponentContext() const { return m_xContext; }
 167
 168             /** returns the driver's implementation name (being pure ASCII) for reference in various places
 169             */
 170             static const sal_Char*  impl_getAsciiImplementationName();
 171
 172             /** returns the path of our configuration settings
 173             */
 174             static OUString  impl_getConfigurationSettingsPath();
 175
 176         protected:
 177             KabDriver(const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext);
 178
 179             // OComponentHelper
 180             virtual void SAL_CALL disposing(void) SAL_OVERRIDE;
 181
 182             // XServiceInfo
 183             virtual OUString SAL_CALL getImplementationName(  ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 184             virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 185             virtual ::com::sun::star::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 186
 187             // XDriver
 188             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection > SAL_CALL connect( const OUString& url, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 189             virtual sal_Bool SAL_CALL acceptsURL( const OUString& url ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 190             virtual ::com::sun::star::uno::Sequence< ::com::sun::star::sdbc::DriverPropertyInfo > SAL_CALL getPropertyInfo( const OUString& url, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& info ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 191             virtual sal_Int32 SAL_CALL getMajorVersion() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 192             virtual sal_Int32 SAL_CALL getMinorVersion() throw(::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 193
 194             // XTerminateListener
 195             virtual void SAL_CALL queryTermination( const ::com::sun::star::lang::EventObject& Event ) throw (::com::sun::star::frame::TerminationVetoException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 196             virtual void SAL_CALL notifyTermination( const ::com::sun::star::lang::EventObject& Event ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 197
 198             // XEventListener
 199             virtual void SAL_CALL disposing( const ::com::sun::star::lang::EventObject& Source ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
 200
 201         private:
 202             /** shuts down the library which contains the real implementations
 203
 204                 This method is safe against being called multiple times
 205
 206                 @precond our mutex is locked
 207             */
 208             void impl_shutdownImplementationModule();
 209         };
 210     }
 211
 212 }
 213
 214 #endif // INCLUDED_CONNECTIVITY_SOURCE_DRIVERS_KAB_KDRIVER_HXX
 215
 216 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */