connectivity/source/drivers/macab/MacabDriver.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
  21 #include "MacabDriver.hxx"
  22 #include "MacabConnection.hxx"
  23
  24 #include <com/sun/star/sdb/SQLContext.hpp>
  25 #include <com/sun/star/lang/NullPointerException.hpp>
  26 #include <com/sun/star/frame/Desktop.hpp>
  27 #include <rtl/ustrbuf.hxx>
  28 #include <tools/diagnose_ex.h>
  29 #include "resource/macab_res.hrc"
  30 #include <comphelper/processfactory.hxx>
  31 #include <cppuhelper/supportsservice.hxx>
  32
  33 using namespace com::sun::star::uno;
  34 using namespace com::sun::star::lang;
  35 using namespace com::sun::star::beans;
  36 using namespace com::sun::star::sdbc;
  37 using namespace com::sun::star::sdb;
  38 using namespace com::sun::star::frame;
  39 using namespace connectivity::macab;
  40
  41 namespace {
  42
  43 /** throws a generic SQL exception with SQLState S1000 and error code 0
  44  */
  45 void throwGenericSQLException( const OUString& _rMessage )
  46 {
  47     SQLException aError;
  48     aError.Message = _rMessage;
  49     aError.SQLState = "S1000";
  50     aError.ErrorCode = 0;
  51     throw aError;
  52 }
  53
  54 /** throws an SQLException saying than no Mac OS installation was found
  55  */
  56 void throwNoMacOSException()
  57 {
  58     ::connectivity::SharedResources aResources;
  59     const OUString sError( aResources.getResourceString(
  60             STR_NO_MAC_OS_FOUND
  61          ) );
  62     throwGenericSQLException( sError );
  63 }
  64
  65
  66 }
  67
  68 // = MacabImplModule
  69
  70
  71 MacabImplModule::MacabImplModule()
  72     :m_bAttemptedLoadModule(false)
  73     ,m_hConnectorModule(NULL)
  74     ,m_pConnectionFactoryFunc(NULL)
  75 {
  76 }
  77
  78
  79 bool MacabImplModule::isMacOSPresent()
  80 {
  81     return impl_loadModule();
  82 }
  83
  84
  85 namespace
  86 {
  87     template< typename FUNCTION >
  88     void lcl_getFunctionFromModuleOrUnload( oslModule& _rModule, const sal_Char* _pAsciiSymbolName, FUNCTION& _rFunction )
  89     {
  90         _rFunction = NULL;
  91         if ( _rModule )
  92         {
  93
  94             const OUString sSymbolName = OUString::createFromAscii( _pAsciiSymbolName );
  95             _rFunction = reinterpret_cast<FUNCTION>( osl_getSymbol( _rModule, sSymbolName.pData ) );
  96
  97             if ( !_rFunction )
  98             {   // did not find the symbol
  99                 OSL_FAIL( OString( OString( "lcl_getFunctionFromModuleOrUnload: could not find the symbol " ) + OString( _pAsciiSymbolName ) ).getStr() );
 100                 osl_unloadModule( _rModule );
 101                 _rModule = NULL;
 102             }
 103         }
 104     }
 105 }
 106
 107
 108 extern "C" { static void SAL_CALL thisModule() {} }
 109
 110 bool MacabImplModule::impl_loadModule()
 111 {
 112     if ( m_bAttemptedLoadModule )
 113         return ( m_hConnectorModule != NULL );
 114     m_bAttemptedLoadModule = true;
 115
 116     OSL_ENSURE( !m_hConnectorModule && !m_pConnectionFactoryFunc,
 117         "MacabImplModule::impl_loadModule: inconsistence: inconsistency (never attempted load before, but some values already set)!");
 118
 119     const OUString sModuleName( SAL_MODULENAME( "macabdrv1" ) );
 120     m_hConnectorModule = osl_loadModuleRelative( &thisModule, sModuleName.pData, SAL_LOADMODULE_NOW );   // LAZY! #i61335#
 121     OSL_ENSURE( m_hConnectorModule, "MacabImplModule::impl_loadModule: could not load the implementation library!" );
 122     if ( !m_hConnectorModule )
 123         return false;
 124
 125     lcl_getFunctionFromModuleOrUnload( m_hConnectorModule, "createMacabConnection",   m_pConnectionFactoryFunc );
 126
 127     if ( !m_hConnectorModule )
 128         // one of the symbols did not exist
 129         throw RuntimeException();
 130
 131     return true;
 132 }
 133
 134
 135 void MacabImplModule::impl_unloadModule()
 136 {
 137     OSL_PRECOND( m_hConnectorModule != NULL, "MacabImplModule::impl_unloadModule: no module!" );
 138
 139     osl_unloadModule( m_hConnectorModule );
 140     m_hConnectorModule = NULL;
 141
 142     m_pConnectionFactoryFunc = NULL;
 143
 144     m_bAttemptedLoadModule = false;
 145 }
 146
 147
 148 void MacabImplModule::init()
 149 {
 150     if ( !impl_loadModule() )
 151         throwNoMacOSException();
 152
 153 }
 154
 155
 156 MacabConnection* MacabImplModule::createConnection( MacabDriver* _pDriver ) const
 157 {
 158     OSL_PRECOND( m_hConnectorModule, "MacabImplModule::createConnection: not initialized!" );
 159
 160     void* pUntypedConnection = (*m_pConnectionFactoryFunc)( _pDriver );
 161     if ( !pUntypedConnection )
 162         throw RuntimeException();
 163
 164     return static_cast< MacabConnection* >( pUntypedConnection );
 165 }
 166
 167
 168 void MacabImplModule::shutdown()
 169 {
 170     if ( !m_hConnectorModule )
 171         return;
 172
 173     impl_unloadModule();
 174 }
 175
 176
 177 // = MacabDriver
 178
 179 MacabDriver::MacabDriver(
 180     const Reference< ::com::sun::star::uno::XComponentContext >& _rxContext)
 181     : MacabDriver_BASE(m_aMutex),
 182       m_xContext(_rxContext),
 183       m_aImplModule()
 184 {
 185     if ( !m_xContext.is() )
 186         throw NullPointerException();
 187
 188     osl_atomic_increment( &m_refCount );
 189     try
 190     {
 191         Reference< XDesktop2 > xDesktop = Desktop::create( m_xContext );
 192         xDesktop->addTerminateListener( this );
 193     }
 194     catch( const Exception& )
 195     {
 196         DBG_UNHANDLED_EXCEPTION();
 197     }
 198     osl_atomic_decrement( &m_refCount );
 199 }
 200
 201 void MacabDriver::disposing()
 202 {
 203     ::osl::MutexGuard aGuard(m_aMutex);
 204
 205     // when driver will be destroied so all our connections have to be destroied as well
 206     for (OWeakRefArray::iterator i = m_xConnections.begin(); m_xConnections.end() != i; ++i)
 207     {
 208         Reference< XComponent > xComp(i->get(), UNO_QUERY);
 209         if (xComp.is())
 210             xComp->dispose();
 211     }
 212     m_xConnections.clear();
 213
 214     WeakComponentImplHelperBase::disposing();
 215 }
 216 // static ServiceInfo
 217
 218 OUString MacabDriver::getImplementationName_Static(  ) throw(RuntimeException)
 219 {
 220     return OUString("com.sun.star.comp.sdbc.macab.Driver");
 221 }
 222
 223 Sequence< OUString > MacabDriver::getSupportedServiceNames_Static(  ) throw (RuntimeException)
 224 {
 225     // which service is supported
 226     // for more information @see com.sun.star.sdbc.Driver
 227     Sequence< OUString > aSNS( 1 );
 228     aSNS[0] = "com.sun.star.sdbc.Driver";
 229
 230     return aSNS;
 231 }
 232
 233 OUString SAL_CALL MacabDriver::getImplementationName(  ) throw(RuntimeException)
 234 {
 235     return getImplementationName_Static();
 236 }
 237
 238 sal_Bool SAL_CALL MacabDriver::supportsService( const OUString& _rServiceName ) throw(RuntimeException)
 239 {
 240     return cppu::supportsService(this, _rServiceName);
 241 }
 242
 243 Sequence< OUString > SAL_CALL MacabDriver::getSupportedServiceNames(  ) throw(RuntimeException)
 244 {
 245     return getSupportedServiceNames_Static();
 246 }
 247
 248 Reference< XConnection > SAL_CALL MacabDriver::connect( const OUString& url, const Sequence< PropertyValue >& info ) throw(SQLException, RuntimeException)
 249 {
 250     ::osl::MutexGuard aGuard(m_aMutex);
 251
 252     m_aImplModule.init();
 253
 254     // create a new connection with the given properties and append it to our vector
 255     MacabConnection* pConnection = m_aImplModule.createConnection( this );
 256     SAL_WARN_IF( !pConnection, "connectivity.macab", "MacabDriver::connect: no connection has been created by the factory!" );
 257
 258     // by definition, the factory function returned an object which was acquired once
 259     Reference< XConnection > xConnection = pConnection;
 260     pConnection->release();
 261
 262     // late constructor call which can throw exception and allows a correct dtor call when so
 263     pConnection->construct( url, info );
 264
 265     // remember it
 266     m_xConnections.push_back( WeakReferenceHelper( *pConnection ) );
 267
 268     return xConnection;
 269 }
 270
 271 sal_Bool SAL_CALL MacabDriver::acceptsURL( const OUString& url )
 272         throw(SQLException, RuntimeException)
 273 {
 274     ::osl::MutexGuard aGuard(m_aMutex);
 275
 276     if ( !m_aImplModule.isMacOSPresent() )
 277         return sal_False;
 278
 279     // here we have to look whether we support this URL format
 280     return url == "sdbc:address:macab";
 281 }
 282
 283 Sequence< DriverPropertyInfo > SAL_CALL MacabDriver::getPropertyInfo( const OUString&, const Sequence< PropertyValue >& ) throw(SQLException, RuntimeException)
 284 {
 285     // if you have something special to say, return it here :-)
 286     return Sequence< DriverPropertyInfo >();
 287 }
 288
 289 sal_Int32 SAL_CALL MacabDriver::getMajorVersion(  ) throw(RuntimeException)
 290 {
 291     return MACAB_DRIVER_VERSION_MAJOR;
 292 }
 293
 294 sal_Int32 SAL_CALL MacabDriver::getMinorVersion(  ) throw(RuntimeException)
 295 {
 296     return MACAB_DRIVER_VERSION_MINOR;
 297 }
 298
 299 void SAL_CALL MacabDriver::queryTermination( const EventObject& ) throw (TerminationVetoException, RuntimeException)
 300 {
 301     // nothing to do, nothing to veto
 302 }
 303
 304 void SAL_CALL MacabDriver::notifyTermination( const EventObject& ) throw (RuntimeException)
 305 {
 306     m_aImplModule.shutdown();
 307 }
 308
 309 void SAL_CALL MacabDriver::disposing( const EventObject& ) throw (RuntimeException)
 310 {
 311     // not interested in (this is the disposing of the desktop, if any)
 312 }
 313
 314 OUString MacabDriver::impl_getConfigurationSettingsPath()
 315 {
 316     OUStringBuffer aPath;
 317     aPath.appendAscii( "/org.openoffice.Office.DataAccess/DriverSettings/" );
 318     aPath.appendAscii( "com.sun.star.comp.sdbc.macab.Driver" );
 319     return aPath.makeStringAndClear();
 320 }
 321
 322 Reference< XInterface >  SAL_CALL MacabDriver::Create( const Reference< XMultiServiceFactory >& _rxFactory ) throw( Exception )
 323 {
 324     return *(new MacabDriver(comphelper::getComponentContext(_rxFactory)));
 325 }
 326
 327 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */