connectivity/source/commontools/dbmetadata.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: dbmetadata.cxx,v $
  10  * $Revision: 1.10.22.1 $
  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_connectivity.hxx"
  33
  34 #include <connectivity/dbmetadata.hxx>
  35 #include <connectivity/dbexception.hxx>
  36 #include "resource/common_res.hrc"
  37 #include "resource/sharedresources.hxx"
  38
  39 /** === begin UNO includes === **/
  40 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  41 #include <com/sun/star/container/XChild.hpp>
  42 #include <com/sun/star/beans/XPropertySet.hpp>
  43 #include <com/sun/star/beans/PropertyValue.hpp>
  44 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  45 #include <com/sun/star/sdb/BooleanComparisonMode.hpp>
  46 #include <com/sun/star/sdbc/XDatabaseMetaData2.hpp>
  47 #include <com/sun/star/sdbcx/XUsersSupplier.hpp>
  48 #include <com/sun/star/sdbcx/XDataDefinitionSupplier.hpp>
  49 #include <com/sun/star/sdbc/XDriverAccess.hpp>
  50 /** === end UNO includes === **/
  51
  52 #include <tools/diagnose_ex.h>
  53 #include <comphelper/namedvaluecollection.hxx>
  54 #include <comphelper/componentcontext.hxx>
  55
  56 #include <boost/optional.hpp>
  57
  58 //........................................................................
  59 namespace dbtools
  60 {
  61 //........................................................................
  62
  63     /** === begin UNO using === **/
  64     using ::com::sun::star::uno::Reference;
  65     using ::com::sun::star::sdbc::XConnection;
  66     using ::com::sun::star::sdbc::XConnection;
  67     using ::com::sun::star::sdbc::XDatabaseMetaData;
  68     using ::com::sun::star::sdbc::XDatabaseMetaData2;
  69     using ::com::sun::star::lang::IllegalArgumentException;
  70     using ::com::sun::star::uno::Exception;
  71     using ::com::sun::star::uno::Any;
  72     using ::com::sun::star::container::XChild;
  73     using ::com::sun::star::uno::UNO_QUERY_THROW;
  74     using ::com::sun::star::beans::XPropertySet;
  75     using ::com::sun::star::uno::Sequence;
  76     using ::com::sun::star::beans::PropertyValue;
  77     using ::com::sun::star::beans::XPropertySetInfo;
  78     using ::com::sun::star::uno::UNO_QUERY;
  79     using ::com::sun::star::sdbcx::XUsersSupplier;
  80     using ::com::sun::star::sdbcx::XDataDefinitionSupplier;
  81     using ::com::sun::star::sdbc::XDriverAccess;
  82     using ::com::sun::star::uno::UNO_SET_THROW;
  83     /** === end UNO using === **/
  84     namespace BooleanComparisonMode = ::com::sun::star::sdb::BooleanComparisonMode;
  85
  86     //====================================================================
  87     //= DatabaseMetaData_Impl
  88     //====================================================================
  89     struct DatabaseMetaData_Impl
  90     {
  91         Reference< XConnection >        xConnection;
  92         Reference< XDatabaseMetaData >  xConnectionMetaData;
  93
  94         ::boost::optional< ::rtl::OUString >    sCachedIdentifierQuoteString;
  95         ::boost::optional< ::rtl::OUString >    sCachedCatalogSeparator;
  96     };
  97
  98     //--------------------------------------------------------------------
  99     namespace
 100     {
 101         //................................................................
 102         static void lcl_construct( DatabaseMetaData_Impl& _metaDataImpl, const Reference< XConnection >& _connection )
 103         {
 104             _metaDataImpl.xConnection = _connection;
 105             if ( !_metaDataImpl.xConnection.is() )
 106                 return;
 107
 108             _metaDataImpl.xConnectionMetaData = _connection->getMetaData();
 109             if ( !_metaDataImpl.xConnectionMetaData.is() )
 110                 throw IllegalArgumentException();
 111         }
 112
 113         //................................................................
 114         static void lcl_checkConnected( const DatabaseMetaData_Impl& _metaDataImpl )
 115         {
 116             if ( !_metaDataImpl.xConnection.is() || !_metaDataImpl.xConnectionMetaData.is() )
 117             {
 118                 ::connectivity::SharedResources aResources;
 119                 const ::rtl::OUString sError( aResources.getResourceString(STR_NO_CONNECTION_GIVEN));
 120                 throwSQLException( sError, SQL_CONNECTION_DOES_NOT_EXIST, NULL );
 121             }
 122         }
 123
 124         //................................................................
 125         static bool lcl_getConnectionSetting( const sal_Char* _asciiName, const DatabaseMetaData_Impl& _metaData, Any& _out_setting )
 126         {
 127             try
 128             {
 129                 Reference< XChild > xConnectionAsChild( _metaData.xConnection, UNO_QUERY );
 130                 if ( xConnectionAsChild.is() )
 131                 {
 132                     Reference< XPropertySet > xDataSource( xConnectionAsChild->getParent(), UNO_QUERY_THROW );
 133                     Reference< XPropertySet > xDataSourceSettings(
 134                         xDataSource->getPropertyValue( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Settings" ) ) ),
 135                         UNO_QUERY_THROW );
 136
 137                     _out_setting = xDataSourceSettings->getPropertyValue( ::rtl::OUString::createFromAscii( _asciiName ) );
 138                 }
 139                 else
 140                 {
 141                     Reference< XDatabaseMetaData2 > xExtendedMetaData( _metaData.xConnectionMetaData, UNO_QUERY_THROW );
 142                     ::comphelper::NamedValueCollection aSettings( xExtendedMetaData->getConnectionInfo() );
 143                     _out_setting = aSettings.get( _asciiName );
 144                     return _out_setting.hasValue();
 145                 }
 146                 return true;
 147             }
 148             catch( const Exception& )
 149             {
 150                 DBG_UNHANDLED_EXCEPTION();
 151             }
 152             return false;
 153         }
 154
 155         //................................................................
 156         static const ::rtl::OUString& lcl_getConnectionStringSetting(
 157             const DatabaseMetaData_Impl& _metaData, ::boost::optional< ::rtl::OUString >& _cachedSetting,
 158             ::rtl::OUString (SAL_CALL XDatabaseMetaData::*_getter)() )
 159         {
 160             if ( !_cachedSetting )
 161             {
 162                 lcl_checkConnected( _metaData );
 163                 try
 164                 {
 165                     _cachedSetting.reset( (_metaData.xConnectionMetaData.get()->*_getter)() );
 166                 }
 167                 catch( const Exception& ) { DBG_UNHANDLED_EXCEPTION(); }
 168             }
 169             return *_cachedSetting;
 170         }
 171     }
 172
 173     //====================================================================
 174     //= DatabaseMetaData
 175     //====================================================================
 176     //--------------------------------------------------------------------
 177     DatabaseMetaData::DatabaseMetaData()
 178         :m_pImpl( new DatabaseMetaData_Impl )
 179     {
 180     }
 181
 182     //--------------------------------------------------------------------
 183     DatabaseMetaData::DatabaseMetaData( const Reference< XConnection >& _connection )
 184         :m_pImpl( new DatabaseMetaData_Impl )
 185     {
 186         lcl_construct( *m_pImpl, _connection );
 187     }
 188
 189     //--------------------------------------------------------------------
 190     DatabaseMetaData::DatabaseMetaData( const DatabaseMetaData& _copyFrom )
 191         :m_pImpl( new DatabaseMetaData_Impl( *_copyFrom.m_pImpl ) )
 192     {
 193     }
 194
 195     //--------------------------------------------------------------------
 196     DatabaseMetaData& DatabaseMetaData::operator=( const DatabaseMetaData& _copyFrom )
 197     {
 198         if ( this == &_copyFrom )
 199             return *this;
 200
 201         m_pImpl.reset( new DatabaseMetaData_Impl( *_copyFrom.m_pImpl ) );
 202         return *this;
 203     }
 204
 205     //--------------------------------------------------------------------
 206     DatabaseMetaData::~DatabaseMetaData()
 207     {
 208     }
 209
 210     //--------------------------------------------------------------------
 211     bool DatabaseMetaData::isConnected() const
 212     {
 213         return m_pImpl->xConnection.is();
 214     }
 215
 216     //--------------------------------------------------------------------
 217     bool DatabaseMetaData::supportsSubqueriesInFrom() const
 218     {
 219         lcl_checkConnected( *m_pImpl );
 220
 221         bool supportsSubQueries = false;
 222         try
 223         {
 224             sal_Int32 maxTablesInselect = m_pImpl->xConnectionMetaData->getMaxTablesInSelect();
 225             supportsSubQueries = ( maxTablesInselect > 1 ) || ( maxTablesInselect == 0 );
 226             // TODO: is there a better way to determine this? The above is not really true. More precise,
 227             // it's a *very* generous heuristics ...
 228         }
 229         catch( const Exception& )
 230         {
 231             DBG_UNHANDLED_EXCEPTION();
 232         }
 233         return supportsSubQueries;
 234     }
 235
 236     //--------------------------------------------------------------------
 237     const ::rtl::OUString&  DatabaseMetaData::getIdentifierQuoteString() const
 238     {
 239         return lcl_getConnectionStringSetting( *m_pImpl, m_pImpl->sCachedIdentifierQuoteString, &XDatabaseMetaData::getIdentifierQuoteString );
 240     }
 241
 242     //--------------------------------------------------------------------
 243     const ::rtl::OUString&  DatabaseMetaData::getCatalogSeparator() const
 244     {
 245         return lcl_getConnectionStringSetting( *m_pImpl, m_pImpl->sCachedCatalogSeparator, &XDatabaseMetaData::getCatalogSeparator );
 246     }
 247
 248     //--------------------------------------------------------------------
 249     bool DatabaseMetaData::restrictIdentifiersToSQL92() const
 250     {
 251         lcl_checkConnected( *m_pImpl );
 252
 253         bool restrict( false );
 254         Any setting;
 255         if ( lcl_getConnectionSetting( "EnableSQL92Check", *m_pImpl, setting ) )
 256             OSL_VERIFY( setting >>= restrict );
 257         return restrict;
 258     }
 259
 260     //--------------------------------------------------------------------
 261     bool DatabaseMetaData::generateASBeforeCorrelationName() const
 262     {
 263         bool doGenerate( true );
 264         Any setting;
 265         if ( lcl_getConnectionSetting( "GenerateASBeforeCorrelationName", *m_pImpl, setting ) )
 266             OSL_VERIFY( setting >>= doGenerate );
 267         return doGenerate;
 268     }
 269     //--------------------------------------------------------------------
 270     bool DatabaseMetaData::shouldEscapeDateTime() const
 271     {
 272         bool doGenerate( true );
 273         Any setting;
 274         if ( lcl_getConnectionSetting( "EscapeDateTime", *m_pImpl, setting ) )
 275             OSL_VERIFY( setting >>= doGenerate );
 276         return doGenerate;
 277     }
 278     //--------------------------------------------------------------------
 279     bool DatabaseMetaData::isAutoIncrementPrimaryKey() const
 280     {
 281         bool doGenerate( true );
 282         Any setting;
 283         if ( lcl_getConnectionSetting( "AutoIncrementIsPrimaryKey", *m_pImpl, setting ) )
 284             OSL_VERIFY( setting >>= doGenerate );
 285         return doGenerate;
 286     }
 287     //--------------------------------------------------------------------
 288     sal_Int32 DatabaseMetaData::getBooleanComparisonMode() const
 289     {
 290         sal_Int32 mode( BooleanComparisonMode::EQUAL_INTEGER );
 291         Any setting;
 292         if ( lcl_getConnectionSetting( "BooleanComparisonMode", *m_pImpl, setting ) )
 293             OSL_VERIFY( setting >>= mode );
 294         return mode;
 295     }
 296     //--------------------------------------------------------------------
 297     bool DatabaseMetaData::supportsRelations() const
 298     {
 299         lcl_checkConnected( *m_pImpl );
 300         bool bSupport = false;
 301         try
 302         {
 303             bSupport = m_pImpl->xConnectionMetaData->supportsIntegrityEnhancementFacility();
 304         }
 305         catch( const Exception& )
 306         {
 307             DBG_UNHANDLED_EXCEPTION();
 308         }
 309         try
 310         {
 311             if ( !bSupport )
 312             {
 313                 const ::rtl::OUString url = m_pImpl->xConnectionMetaData->getURL();
 314                 char pMySQL[] = "sdbc:mysql";
 315                 bSupport = url.matchAsciiL(pMySQL,(sizeof(pMySQL)/sizeof(pMySQL[0]))-1);
 316             }
 317         }
 318         catch( const Exception& )
 319         {
 320             DBG_UNHANDLED_EXCEPTION();
 321         }
 322         return bSupport;
 323     }
 324
 325     //--------------------------------------------------------------------
 326     bool DatabaseMetaData::supportsColumnAliasInOrderBy() const
 327     {
 328         bool doGenerate( true );
 329         Any setting;
 330         if ( lcl_getConnectionSetting( "ColumnAliasInOrderBy", *m_pImpl, setting ) )
 331             OSL_VERIFY( setting >>= doGenerate );
 332         return doGenerate;
 333     }
 334
 335     //--------------------------------------------------------------------
 336     bool DatabaseMetaData::supportsUserAdministration( const ::comphelper::ComponentContext& _rContext ) const
 337     {
 338         lcl_checkConnected( *m_pImpl  );
 339
 340         bool isSupported( false );
 341         try
 342         {
 343             // find the XUsersSupplier interface
 344             // - either directly at the connection
 345             Reference< XUsersSupplier > xUsersSupp( m_pImpl->xConnection, UNO_QUERY );
 346             if ( !xUsersSupp.is() )
 347             {
 348                 // - or at the driver manager
 349                 Reference< XDriverAccess > xDriverManager(
 350                     _rContext.createComponent( "com.sun.star.sdbc.DriverManager" ), UNO_QUERY_THROW );
 351                 Reference< XDataDefinitionSupplier > xDriver( xDriverManager->getDriverByURL( m_pImpl->xConnectionMetaData->getURL() ), UNO_QUERY );
 352                 if ( xDriver.is() )
 353                     xUsersSupp.set( xDriver->getDataDefinitionByConnection( m_pImpl->xConnection ), UNO_QUERY );
 354             }
 355
 356             isSupported = ( xUsersSupp.is() && xUsersSupp->getUsers().is() );
 357         }
 358         catch( const Exception& )
 359         {
 360             DBG_UNHANDLED_EXCEPTION();
 361         }
 362         return isSupported;
 363     }
 364
 365     //--------------------------------------------------------------------
 366     bool DatabaseMetaData::displayEmptyTableFolders() const
 367     {
 368         bool doDisplay( true );
 369 #ifdef IMPLEMENTED_LATER
 370         Any setting;
 371         if ( lcl_getConnectionSetting( "DisplayEmptyTableFolders", *m_pImpl, setting ) )
 372             OSL_VERIFY( setting >>= doDisplay );
 373 #else
 374         try
 375         {
 376             Reference< XDatabaseMetaData > xMeta( m_pImpl->xConnectionMetaData, UNO_SET_THROW );
 377             ::rtl::OUString sConnectionURL( xMeta->getURL() );
 378             doDisplay = sConnectionURL.compareToAscii( RTL_CONSTASCII_STRINGPARAM( "sdbc:mysql:mysqlc" ) ) == 0;
 379         }
 380         catch( const Exception& )
 381         {
 382             DBG_UNHANDLED_EXCEPTION();
 383         }
 384 #endif
 385         return doDisplay;
 386     }
 387
 388 //........................................................................
 389 } // namespace dbtools
 390 //........................................................................
 391