svx/source/form/dbtoolsclient.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: dbtoolsclient.cxx,v $
  10  * $Revision: 1.23 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_svx.hxx"
  33 #include <com/sun/star/sdbc/XConnection.hpp>
  34 #include <com/sun/star/sdbc/XDataSource.hpp>
  35 #include <com/sun/star/util/XNumberFormatsSupplier.hpp>
  36 #include <com/sun/star/sdb/SQLContext.hpp>
  37 #include "svx/dbtoolsclient.hxx"
  38 #include <osl/diagnose.h>
  39 #include <connectivity/formattedcolumnvalue.hxx>
  40
  41 //........................................................................
  42 namespace svxform
  43 {
  44 //........................................................................
  45
  46     using namespace ::connectivity::simple;
  47     using namespace ::com::sun::star::sdbc;
  48     using namespace ::com::sun::star::lang;
  49     using namespace ::com::sun::star::util;
  50     using namespace ::com::sun::star::uno;
  51     using namespace ::com::sun::star::beans;
  52     using namespace ::com::sun::star::sdb;
  53     using namespace ::com::sun::star::container;
  54
  55     //====================================================================
  56     //= ODbtoolsClient
  57     //====================================================================
  58     ::osl::Mutex        ODbtoolsClient::s_aMutex;
  59     sal_Int32           ODbtoolsClient::s_nClients = 0;
  60     oslModule           ODbtoolsClient::s_hDbtoolsModule = NULL;
  61     createDataAccessToolsFactoryFunction
  62                     ODbtoolsClient::s_pFactoryCreationFunc = NULL;
  63
  64     //--------------------------------------------------------------------
  65     ODbtoolsClient::ODbtoolsClient()
  66     {
  67         m_bCreateAlready = FALSE;
  68     }
  69
  70     //--------------------------------------------------------------------
  71     bool ODbtoolsClient::ensureLoaded() const
  72     {
  73         if ( !m_bCreateAlready )
  74         {
  75             m_bCreateAlready = true;
  76
  77             registerClient();
  78             if ( s_pFactoryCreationFunc )
  79             {   // loading the lib succeeded
  80                 void* pUntypedFactory = (*s_pFactoryCreationFunc)();
  81                 IDataAccessToolsFactory* pDBTFactory = static_cast< IDataAccessToolsFactory* >( pUntypedFactory );
  82                 OSL_ENSURE( pDBTFactory, "ODbtoolsClient::ODbtoolsClient: no factory returned!" );
  83                 if ( pDBTFactory )
  84                 {
  85                     m_xDataAccessFactory = pDBTFactory;
  86                     // by definition, the factory was aquired once
  87                     m_xDataAccessFactory->release();
  88                 }
  89             }
  90         }
  91         return m_xDataAccessFactory.is();
  92     }
  93
  94     //--------------------------------------------------------------------
  95     ODbtoolsClient::~ODbtoolsClient()
  96     {
  97         // clear the factory _before_ revoking the client
  98         // (the revocation may unload the DBT lib)
  99         m_xDataAccessFactory = NULL;
 100         // revoke the client
 101         if ( m_bCreateAlready )
 102             revokeClient();
 103     }
 104
 105     //--------------------------------------------------------------------
 106     extern "C" { static void SAL_CALL thisModule() {} }
 107
 108     void ODbtoolsClient::registerClient()
 109     {
 110         ::osl::MutexGuard aGuard(s_aMutex);
 111         if (1 == ++s_nClients)
 112         {
 113             OSL_ENSURE(NULL == s_hDbtoolsModule, "ODbtoolsClient::registerClient: inconsistence: already have a module!");
 114             OSL_ENSURE(NULL == s_pFactoryCreationFunc, "ODbtoolsClient::registerClient: inconsistence: already have a factory function!");
 115
 116             const ::rtl::OUString sModuleName = ::rtl::OUString::createFromAscii(
 117                 SVLIBRARY( "dbtools" )
 118             );
 119
 120             // load the dbtools library
 121             s_hDbtoolsModule = osl_loadModuleRelative(
 122                 &thisModule, sModuleName.pData, 0);
 123             OSL_ENSURE(NULL != s_hDbtoolsModule, "ODbtoolsClient::registerClient: could not load the dbtools library!");
 124             if (NULL != s_hDbtoolsModule)
 125             {
 126                 // get the symbol for the method creating the factory
 127                 const ::rtl::OUString sFactoryCreationFunc = ::rtl::OUString::createFromAscii("createDataAccessToolsFactory");
 128                 //  reinterpret_cast<createDataAccessToolsFactoryFunction>
 129                 s_pFactoryCreationFunc = (createDataAccessToolsFactoryFunction)(
 130                     osl_getFunctionSymbol(s_hDbtoolsModule, sFactoryCreationFunc.pData));
 131
 132                 if (NULL == s_pFactoryCreationFunc)
 133                 {       // did not find the symbol
 134                     OSL_ENSURE(sal_False, "ODbtoolsClient::registerClient: could not find the symbol for creating the factory!");
 135                     osl_unloadModule(s_hDbtoolsModule);
 136                     s_hDbtoolsModule = NULL;
 137                 }
 138             }
 139         }
 140     }
 141
 142     //--------------------------------------------------------------------
 143     void ODbtoolsClient::revokeClient()
 144     {
 145         ::osl::MutexGuard aGuard(s_aMutex);
 146         if (0 == --s_nClients)
 147         {
 148             s_pFactoryCreationFunc = NULL;
 149             if (s_hDbtoolsModule)
 150                 osl_unloadModule(s_hDbtoolsModule);
 151             s_hDbtoolsModule = NULL;
 152         }
 153
 154         OSL_ENSURE(s_nClients >= 0,"Illegall call of revokeClient()");
 155     }
 156
 157     //====================================================================
 158     //= OStaticDataAccessTools
 159     //====================================================================
 160     //--------------------------------------------------------------------
 161     OStaticDataAccessTools::OStaticDataAccessTools()
 162     {
 163     }
 164
 165     //--------------------------------------------------------------------
 166     //add by BerryJia for fixing Bug97420 Time:2002-9-12-11:00(PRC time)
 167     bool OStaticDataAccessTools::ensureLoaded() const
 168     {
 169         if ( !ODbtoolsClient::ensureLoaded() )
 170             return false;
 171          m_xDataAccessTools = getFactory()->getDataAccessTools();
 172         return m_xDataAccessTools.is();
 173     }
 174
 175     //--------------------------------------------------------------------
 176     Reference< XNumberFormatsSupplier > OStaticDataAccessTools::getNumberFormats(const Reference< XConnection>& _rxConn, sal_Bool _bAllowDefault) const
 177     {
 178         Reference< XNumberFormatsSupplier > xReturn;
 179         if ( ensureLoaded() )
 180             xReturn = m_xDataAccessTools->getNumberFormats(_rxConn, _bAllowDefault);
 181         return xReturn;
 182     }
 183
 184     //--------------------------------------------------------------------
 185     sal_Int32 OStaticDataAccessTools::getDefaultNumberFormat( const Reference< XPropertySet >& _xColumn, const Reference< XNumberFormatTypes >& _xTypes, const Locale& _rLocale )
 186     {
 187         sal_Int32 nReturn = 0;
 188         if ( ensureLoaded() )
 189             nReturn = m_xDataAccessTools->getDefaultNumberFormat( _xColumn, _xTypes, _rLocale );
 190         return nReturn;
 191     }
 192
 193     //--------------------------------------------------------------------
 194     Reference< XConnection> OStaticDataAccessTools::getConnection_withFeedback(const ::rtl::OUString& _rDataSourceName,
 195         const ::rtl::OUString& _rUser, const ::rtl::OUString& _rPwd, const Reference< XMultiServiceFactory>& _rxFactory) const
 196             SAL_THROW ( (SQLException) )
 197     {
 198         Reference< XConnection > xReturn;
 199         if ( ensureLoaded() )
 200             xReturn = m_xDataAccessTools->getConnection_withFeedback(_rDataSourceName, _rUser, _rPwd, _rxFactory);
 201         return xReturn;
 202     }
 203
 204     //--------------------------------------------------------------------
 205     Reference< XConnection > OStaticDataAccessTools::connectRowset( const Reference< XRowSet >& _rxRowSet,
 206         const Reference< XMultiServiceFactory >& _rxFactory, sal_Bool _bSetAsActiveConnection ) const
 207         SAL_THROW ( ( SQLException, WrappedTargetException, RuntimeException ) )
 208     {
 209         Reference< XConnection > xReturn;
 210         if ( ensureLoaded() )
 211             xReturn = m_xDataAccessTools->connectRowset( _rxRowSet, _rxFactory, _bSetAsActiveConnection );
 212         return xReturn;
 213     }
 214
 215     //--------------------------------------------------------------------
 216     Reference< XConnection > OStaticDataAccessTools::getRowSetConnection(const Reference< XRowSet >& _rxRowSet) const SAL_THROW ( (RuntimeException) )
 217     {
 218         Reference< XConnection > xReturn;
 219         if ( ensureLoaded() )
 220             xReturn = m_xDataAccessTools->getRowSetConnection(_rxRowSet);
 221         return xReturn;
 222     }
 223
 224     //--------------------------------------------------------------------
 225     void OStaticDataAccessTools::TransferFormComponentProperties(const Reference< XPropertySet>& _rxOld,
 226         const Reference< XPropertySet>& _rxNew, const Locale& _rLocale) const
 227     {
 228         if ( ensureLoaded() )
 229             m_xDataAccessTools->TransferFormComponentProperties(_rxOld, _rxNew, _rLocale);
 230     }
 231
 232     //--------------------------------------------------------------------
 233     ::rtl::OUString OStaticDataAccessTools::quoteName(const ::rtl::OUString& _rQuote, const ::rtl::OUString& _rName) const
 234     {
 235         ::rtl::OUString sReturn;
 236         if ( ensureLoaded() )
 237             sReturn = m_xDataAccessTools->quoteName(_rQuote, _rName);
 238         return sReturn;
 239     }
 240
 241     // ------------------------------------------------
 242     ::rtl::OUString OStaticDataAccessTools::composeTableNameForSelect( const Reference< XConnection >& _rxConnection, const Reference< XPropertySet>& _xTable ) const
 243     {
 244         ::rtl::OUString sReturn;
 245         if ( ensureLoaded() )
 246             sReturn = m_xDataAccessTools->composeTableNameForSelect( _rxConnection, _xTable );
 247         return sReturn;
 248     }
 249
 250     //--------------------------------------------------------------------
 251     SQLContext OStaticDataAccessTools::prependContextInfo(SQLException& _rException, const Reference< XInterface >& _rxContext,
 252         const ::rtl::OUString& _rContextDescription, const ::rtl::OUString& _rContextDetails) const
 253     {
 254         SQLContext aReturn;
 255         if ( ensureLoaded() )
 256             aReturn = m_xDataAccessTools->prependContextInfo(_rException, _rxContext, _rContextDescription, _rContextDetails);
 257         return aReturn;
 258     }
 259
 260     //----------------------------------------------------------------
 261     Reference< XDataSource > OStaticDataAccessTools::getDataSource( const ::rtl::OUString& _rsRegisteredName, const Reference< XMultiServiceFactory>& _rxFactory ) const
 262     {
 263         Reference< XDataSource > xReturn;
 264         if ( ensureLoaded() )
 265             xReturn = m_xDataAccessTools->getDataSource(_rsRegisteredName,_rxFactory);
 266         return xReturn;
 267     }
 268
 269     //----------------------------------------------------------------
 270     sal_Bool OStaticDataAccessTools::canInsert(const Reference< XPropertySet>& _rxCursorSet) const
 271     {
 272         sal_Bool bRet = sal_False;
 273         if ( ensureLoaded() )
 274             bRet = m_xDataAccessTools->canInsert( _rxCursorSet );
 275         return bRet;
 276     }
 277
 278     //----------------------------------------------------------------
 279     sal_Bool OStaticDataAccessTools::canUpdate(const Reference< XPropertySet>& _rxCursorSet) const
 280     {
 281         sal_Bool bRet = sal_False;
 282         if ( ensureLoaded() )
 283             bRet = m_xDataAccessTools->canUpdate( _rxCursorSet );
 284         return bRet;
 285     }
 286
 287     //----------------------------------------------------------------
 288     sal_Bool OStaticDataAccessTools::canDelete(const Reference< XPropertySet>& _rxCursorSet) const
 289     {
 290         sal_Bool bRet = sal_False;
 291         if ( ensureLoaded() )
 292             bRet = m_xDataAccessTools->canDelete( _rxCursorSet );
 293         return bRet;
 294     }
 295
 296     //----------------------------------------------------------------
 297     Reference< XNameAccess > OStaticDataAccessTools::getFieldsByCommandDescriptor( const Reference< XConnection >& _rxConnection,
 298         const sal_Int32 _nCommandType, const ::rtl::OUString& _rCommand,
 299             Reference< XComponent >& _rxKeepFieldsAlive, ::dbtools::SQLExceptionInfo* _pErrorInfo ) SAL_THROW( ( ) )
 300     {
 301         Reference< XNameAccess > aFields;
 302         if ( ensureLoaded() )
 303             aFields = m_xDataAccessTools->getFieldsByCommandDescriptor( _rxConnection, _nCommandType,
 304                 _rCommand, _rxKeepFieldsAlive, _pErrorInfo );
 305
 306         return aFields;
 307     }
 308
 309     //----------------------------------------------------------------
 310     Sequence< ::rtl::OUString > OStaticDataAccessTools::getFieldNamesByCommandDescriptor(
 311         const Reference< XConnection >& _rxConnection, const sal_Int32 _nCommandType,
 312         const ::rtl::OUString& _rCommand, ::dbtools::SQLExceptionInfo* _pErrorInfo ) SAL_THROW( ( ) )
 313     {
 314         Sequence< ::rtl::OUString > aNames;
 315         if ( ensureLoaded() )
 316             aNames = m_xDataAccessTools->getFieldNamesByCommandDescriptor( _rxConnection, _nCommandType,
 317                 _rCommand, _pErrorInfo );
 318         return aNames;
 319     }
 320
 321     //----------------------------------------------------------------
 322     bool OStaticDataAccessTools::isEmbeddedInDatabase( const Reference< XInterface >& _rxComponent, Reference< XConnection >& _rxActualConnection )
 323     {
 324         bool bReturn = false;
 325         if ( ensureLoaded() )
 326             bReturn = m_xDataAccessTools->isEmbeddedInDatabase( _rxComponent, _rxActualConnection );
 327         return bReturn;
 328     }
 329
 330     //----------------------------------------------------------------
 331     bool OStaticDataAccessTools::isEmbeddedInDatabase( const Reference< XInterface >& _rxComponent )
 332     {
 333         bool bReturn = false;
 334         if ( ensureLoaded() )
 335         {
 336             Reference< XConnection > xDummy;
 337             bReturn = m_xDataAccessTools->isEmbeddedInDatabase( _rxComponent, xDummy );
 338         }
 339         return bReturn;
 340     }
 341
 342     //====================================================================
 343     //= DBToolsObjectFactory
 344     //====================================================================
 345     //----------------------------------------------------------------
 346     DBToolsObjectFactory::DBToolsObjectFactory()
 347     {
 348     }
 349
 350     //----------------------------------------------------------------
 351     DBToolsObjectFactory::~DBToolsObjectFactory()
 352     {
 353     }
 354
 355     //----------------------------------------------------------------
 356     ::std::auto_ptr< ::dbtools::FormattedColumnValue > DBToolsObjectFactory::createFormattedColumnValue(
 357         const ::comphelper::ComponentContext& _rContext, const Reference< XRowSet >& _rxRowSet, const Reference< XPropertySet >& _rxColumn )
 358     {
 359         ::std::auto_ptr< ::dbtools::FormattedColumnValue > pValue;
 360         if ( ensureLoaded() )
 361             pValue = getFactory()->createFormattedColumnValue( _rContext, _rxRowSet, _rxColumn );
 362         return pValue;
 363     }
 364
 365 //........................................................................
 366 }       // namespace svxform
 367 //........................................................................
 368
 369