451 lines
17 KiB
C++
451 lines
17 KiB
C++
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2008 by Sun Microsystems, Inc.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: dbmetadata.cxx,v $
|
|
* $Revision: 1.10.22.1 $
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
|
|
// MARKER(update_precomp.py): autogen include statement, do not remove
|
|
#include "precompiled_connectivity.hxx"
|
|
|
|
#include "connectivity/dbmetadata.hxx"
|
|
#include "connectivity/dbexception.hxx"
|
|
#include "connectivity/DriversConfig.hxx"
|
|
#include "resource/common_res.hrc"
|
|
#include "resource/sharedresources.hxx"
|
|
|
|
/** === begin UNO includes === **/
|
|
#include <com/sun/star/lang/IllegalArgumentException.hpp>
|
|
#include <com/sun/star/container/XChild.hpp>
|
|
#include <com/sun/star/beans/XPropertySet.hpp>
|
|
#include <com/sun/star/beans/PropertyValue.hpp>
|
|
#include <com/sun/star/beans/XPropertySetInfo.hpp>
|
|
#include <com/sun/star/sdb/BooleanComparisonMode.hpp>
|
|
#include <com/sun/star/sdbc/XDatabaseMetaData2.hpp>
|
|
#include <com/sun/star/sdbcx/XUsersSupplier.hpp>
|
|
#include <com/sun/star/sdbcx/XDataDefinitionSupplier.hpp>
|
|
#include <com/sun/star/sdbc/XDriverAccess.hpp>
|
|
/** === end UNO includes === **/
|
|
|
|
#include <tools/diagnose_ex.h>
|
|
#include <comphelper/namedvaluecollection.hxx>
|
|
#include <comphelper/componentcontext.hxx>
|
|
#include <comphelper/processfactory.hxx>
|
|
|
|
#include <boost/optional.hpp>
|
|
|
|
//........................................................................
|
|
namespace dbtools
|
|
{
|
|
//........................................................................
|
|
|
|
/** === begin UNO using === **/
|
|
using ::com::sun::star::uno::Reference;
|
|
using ::com::sun::star::sdbc::XConnection;
|
|
using ::com::sun::star::sdbc::XConnection;
|
|
using ::com::sun::star::sdbc::XDatabaseMetaData;
|
|
using ::com::sun::star::sdbc::XDatabaseMetaData2;
|
|
using ::com::sun::star::lang::IllegalArgumentException;
|
|
using ::com::sun::star::uno::Exception;
|
|
using ::com::sun::star::uno::Any;
|
|
using ::com::sun::star::container::XChild;
|
|
using ::com::sun::star::uno::UNO_QUERY_THROW;
|
|
using ::com::sun::star::beans::XPropertySet;
|
|
using ::com::sun::star::uno::Sequence;
|
|
using ::com::sun::star::beans::PropertyValue;
|
|
using ::com::sun::star::beans::XPropertySetInfo;
|
|
using ::com::sun::star::uno::UNO_QUERY;
|
|
using ::com::sun::star::sdbcx::XUsersSupplier;
|
|
using ::com::sun::star::sdbcx::XDataDefinitionSupplier;
|
|
using ::com::sun::star::sdbc::XDriverAccess;
|
|
using ::com::sun::star::uno::UNO_SET_THROW;
|
|
/** === end UNO using === **/
|
|
namespace BooleanComparisonMode = ::com::sun::star::sdb::BooleanComparisonMode;
|
|
|
|
//====================================================================
|
|
//= DatabaseMetaData_Impl
|
|
//====================================================================
|
|
struct DatabaseMetaData_Impl
|
|
{
|
|
Reference< XConnection > xConnection;
|
|
Reference< XDatabaseMetaData > xConnectionMetaData;
|
|
::connectivity::DriversConfig aDriverConfig;
|
|
|
|
::boost::optional< ::rtl::OUString > sCachedIdentifierQuoteString;
|
|
::boost::optional< ::rtl::OUString > sCachedCatalogSeparator;
|
|
|
|
DatabaseMetaData_Impl()
|
|
:xConnection()
|
|
,xConnectionMetaData()
|
|
,aDriverConfig( ::comphelper::getProcessServiceFactory() )
|
|
,sCachedIdentifierQuoteString()
|
|
,sCachedCatalogSeparator()
|
|
{
|
|
}
|
|
};
|
|
|
|
//--------------------------------------------------------------------
|
|
namespace
|
|
{
|
|
//................................................................
|
|
static void lcl_construct( DatabaseMetaData_Impl& _metaDataImpl, const Reference< XConnection >& _connection )
|
|
{
|
|
_metaDataImpl.xConnection = _connection;
|
|
if ( !_metaDataImpl.xConnection.is() )
|
|
return;
|
|
|
|
_metaDataImpl.xConnectionMetaData = _connection->getMetaData();
|
|
if ( !_metaDataImpl.xConnectionMetaData.is() )
|
|
throw IllegalArgumentException();
|
|
}
|
|
|
|
//................................................................
|
|
static void lcl_checkConnected( const DatabaseMetaData_Impl& _metaDataImpl )
|
|
{
|
|
if ( !_metaDataImpl.xConnection.is() || !_metaDataImpl.xConnectionMetaData.is() )
|
|
{
|
|
::connectivity::SharedResources aResources;
|
|
const ::rtl::OUString sError( aResources.getResourceString(STR_NO_CONNECTION_GIVEN));
|
|
throwSQLException( sError, SQL_CONNECTION_DOES_NOT_EXIST, NULL );
|
|
}
|
|
}
|
|
|
|
//................................................................
|
|
static bool lcl_getDriverSetting( const sal_Char* _asciiName, const DatabaseMetaData_Impl& _metaData, Any& _out_setting )
|
|
{
|
|
lcl_checkConnected( _metaData );
|
|
const ::comphelper::NamedValueCollection& rDriverMetaData = _metaData.aDriverConfig.getMetaData( _metaData.xConnectionMetaData->getURL() );
|
|
if ( !rDriverMetaData.has( _asciiName ) )
|
|
return false;
|
|
_out_setting = rDriverMetaData.get( _asciiName );
|
|
return true;
|
|
}
|
|
|
|
//................................................................
|
|
static bool lcl_getConnectionSetting( const sal_Char* _asciiName, const DatabaseMetaData_Impl& _metaData, Any& _out_setting )
|
|
{
|
|
try
|
|
{
|
|
Reference< XChild > xConnectionAsChild( _metaData.xConnection, UNO_QUERY );
|
|
if ( xConnectionAsChild.is() )
|
|
{
|
|
Reference< XPropertySet > xDataSource( xConnectionAsChild->getParent(), UNO_QUERY_THROW );
|
|
Reference< XPropertySet > xDataSourceSettings(
|
|
xDataSource->getPropertyValue( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Settings" ) ) ),
|
|
UNO_QUERY_THROW );
|
|
|
|
_out_setting = xDataSourceSettings->getPropertyValue( ::rtl::OUString::createFromAscii( _asciiName ) );
|
|
}
|
|
else
|
|
{
|
|
Reference< XDatabaseMetaData2 > xExtendedMetaData( _metaData.xConnectionMetaData, UNO_QUERY_THROW );
|
|
::comphelper::NamedValueCollection aSettings( xExtendedMetaData->getConnectionInfo() );
|
|
_out_setting = aSettings.get( _asciiName );
|
|
return _out_setting.hasValue();
|
|
}
|
|
return true;
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION();
|
|
}
|
|
return false;
|
|
}
|
|
|
|
//................................................................
|
|
static const ::rtl::OUString& lcl_getConnectionStringSetting(
|
|
const DatabaseMetaData_Impl& _metaData, ::boost::optional< ::rtl::OUString >& _cachedSetting,
|
|
::rtl::OUString (SAL_CALL XDatabaseMetaData::*_getter)() )
|
|
{
|
|
if ( !_cachedSetting )
|
|
{
|
|
lcl_checkConnected( _metaData );
|
|
try
|
|
{
|
|
_cachedSetting.reset( (_metaData.xConnectionMetaData.get()->*_getter)() );
|
|
}
|
|
catch( const Exception& ) { DBG_UNHANDLED_EXCEPTION(); }
|
|
}
|
|
return *_cachedSetting;
|
|
}
|
|
}
|
|
|
|
//====================================================================
|
|
//= DatabaseMetaData
|
|
//====================================================================
|
|
//--------------------------------------------------------------------
|
|
DatabaseMetaData::DatabaseMetaData()
|
|
:m_pImpl( new DatabaseMetaData_Impl )
|
|
{
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
DatabaseMetaData::DatabaseMetaData( const Reference< XConnection >& _connection )
|
|
:m_pImpl( new DatabaseMetaData_Impl )
|
|
{
|
|
lcl_construct( *m_pImpl, _connection );
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
DatabaseMetaData::DatabaseMetaData( const DatabaseMetaData& _copyFrom )
|
|
:m_pImpl( new DatabaseMetaData_Impl( *_copyFrom.m_pImpl ) )
|
|
{
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
DatabaseMetaData& DatabaseMetaData::operator=( const DatabaseMetaData& _copyFrom )
|
|
{
|
|
if ( this == &_copyFrom )
|
|
return *this;
|
|
|
|
m_pImpl.reset( new DatabaseMetaData_Impl( *_copyFrom.m_pImpl ) );
|
|
return *this;
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
DatabaseMetaData::~DatabaseMetaData()
|
|
{
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::isConnected() const
|
|
{
|
|
return m_pImpl->xConnection.is();
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::supportsSubqueriesInFrom() const
|
|
{
|
|
lcl_checkConnected( *m_pImpl );
|
|
|
|
bool supportsSubQueries = false;
|
|
try
|
|
{
|
|
sal_Int32 maxTablesInselect = m_pImpl->xConnectionMetaData->getMaxTablesInSelect();
|
|
supportsSubQueries = ( maxTablesInselect > 1 ) || ( maxTablesInselect == 0 );
|
|
// TODO: is there a better way to determine this? The above is not really true. More precise,
|
|
// it's a *very* generous heuristics ...
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION();
|
|
}
|
|
return supportsSubQueries;
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::supportsPrimaryKeys() const
|
|
{
|
|
lcl_checkConnected( *m_pImpl );
|
|
|
|
bool doesSupportPrimaryKeys = false;
|
|
try
|
|
{
|
|
Any setting;
|
|
if ( !( lcl_getConnectionSetting( "PrimaryKeySupport", *m_pImpl, setting ) )
|
|
|| !( setting >>= doesSupportPrimaryKeys )
|
|
)
|
|
doesSupportPrimaryKeys = m_pImpl->xConnectionMetaData->supportsCoreSQLGrammar();
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION();
|
|
}
|
|
return doesSupportPrimaryKeys;
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
const ::rtl::OUString& DatabaseMetaData::getIdentifierQuoteString() const
|
|
{
|
|
return lcl_getConnectionStringSetting( *m_pImpl, m_pImpl->sCachedIdentifierQuoteString, &XDatabaseMetaData::getIdentifierQuoteString );
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
const ::rtl::OUString& DatabaseMetaData::getCatalogSeparator() const
|
|
{
|
|
return lcl_getConnectionStringSetting( *m_pImpl, m_pImpl->sCachedCatalogSeparator, &XDatabaseMetaData::getCatalogSeparator );
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::restrictIdentifiersToSQL92() const
|
|
{
|
|
lcl_checkConnected( *m_pImpl );
|
|
|
|
bool restrict( false );
|
|
Any setting;
|
|
if ( lcl_getConnectionSetting( "EnableSQL92Check", *m_pImpl, setting ) )
|
|
OSL_VERIFY( setting >>= restrict );
|
|
return restrict;
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::generateASBeforeCorrelationName() const
|
|
{
|
|
bool doGenerate( true );
|
|
Any setting;
|
|
if ( lcl_getConnectionSetting( "GenerateASBeforeCorrelationName", *m_pImpl, setting ) )
|
|
OSL_VERIFY( setting >>= doGenerate );
|
|
return doGenerate;
|
|
}
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::shouldEscapeDateTime() const
|
|
{
|
|
bool doGenerate( true );
|
|
Any setting;
|
|
if ( lcl_getConnectionSetting( "EscapeDateTime", *m_pImpl, setting ) )
|
|
OSL_VERIFY( setting >>= doGenerate );
|
|
return doGenerate;
|
|
}
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::isAutoIncrementPrimaryKey() const
|
|
{
|
|
bool is( true );
|
|
Any setting;
|
|
if ( lcl_getDriverSetting( "AutoIncrementIsPrimaryKey", *m_pImpl, setting ) )
|
|
OSL_VERIFY( setting >>= is );
|
|
return is;
|
|
}
|
|
//--------------------------------------------------------------------
|
|
sal_Int32 DatabaseMetaData::getBooleanComparisonMode() const
|
|
{
|
|
sal_Int32 mode( BooleanComparisonMode::EQUAL_INTEGER );
|
|
Any setting;
|
|
if ( lcl_getConnectionSetting( "BooleanComparisonMode", *m_pImpl, setting ) )
|
|
OSL_VERIFY( setting >>= mode );
|
|
return mode;
|
|
}
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::supportsRelations() const
|
|
{
|
|
lcl_checkConnected( *m_pImpl );
|
|
bool bSupport = false;
|
|
try
|
|
{
|
|
bSupport = m_pImpl->xConnectionMetaData->supportsIntegrityEnhancementFacility();
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION();
|
|
}
|
|
try
|
|
{
|
|
if ( !bSupport )
|
|
{
|
|
const ::rtl::OUString url = m_pImpl->xConnectionMetaData->getURL();
|
|
char pMySQL[] = "sdbc:mysql";
|
|
bSupport = url.matchAsciiL(pMySQL,(sizeof(pMySQL)/sizeof(pMySQL[0]))-1);
|
|
}
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION();
|
|
}
|
|
return bSupport;
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::supportsColumnAliasInOrderBy() const
|
|
{
|
|
bool doGenerate( true );
|
|
Any setting;
|
|
if ( lcl_getConnectionSetting( "ColumnAliasInOrderBy", *m_pImpl, setting ) )
|
|
OSL_VERIFY( setting >>= doGenerate );
|
|
return doGenerate;
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::supportsUserAdministration( const ::comphelper::ComponentContext& _rContext ) const
|
|
{
|
|
lcl_checkConnected( *m_pImpl );
|
|
|
|
bool isSupported( false );
|
|
try
|
|
{
|
|
// find the XUsersSupplier interface
|
|
// - either directly at the connection
|
|
Reference< XUsersSupplier > xUsersSupp( m_pImpl->xConnection, UNO_QUERY );
|
|
if ( !xUsersSupp.is() )
|
|
{
|
|
// - or at the driver manager
|
|
Reference< XDriverAccess > xDriverManager(
|
|
_rContext.createComponent( "com.sun.star.sdbc.DriverManager" ), UNO_QUERY_THROW );
|
|
Reference< XDataDefinitionSupplier > xDriver( xDriverManager->getDriverByURL( m_pImpl->xConnectionMetaData->getURL() ), UNO_QUERY );
|
|
if ( xDriver.is() )
|
|
xUsersSupp.set( xDriver->getDataDefinitionByConnection( m_pImpl->xConnection ), UNO_QUERY );
|
|
}
|
|
|
|
isSupported = ( xUsersSupp.is() && xUsersSupp->getUsers().is() );
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION();
|
|
}
|
|
return isSupported;
|
|
}
|
|
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::displayEmptyTableFolders() const
|
|
{
|
|
bool doDisplay( true );
|
|
#ifdef IMPLEMENTED_LATER
|
|
Any setting;
|
|
if ( lcl_getConnectionSetting( "DisplayEmptyTableFolders", *m_pImpl, setting ) )
|
|
OSL_VERIFY( setting >>= doDisplay );
|
|
#else
|
|
try
|
|
{
|
|
Reference< XDatabaseMetaData > xMeta( m_pImpl->xConnectionMetaData, UNO_SET_THROW );
|
|
::rtl::OUString sConnectionURL( xMeta->getURL() );
|
|
doDisplay = sConnectionURL.compareToAscii( RTL_CONSTASCII_STRINGPARAM( "sdbc:mysql:mysqlc" ) ) == 0;
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION();
|
|
}
|
|
#endif
|
|
return doDisplay;
|
|
}
|
|
//--------------------------------------------------------------------
|
|
bool DatabaseMetaData::supportsThreads() const
|
|
{
|
|
bool bSupported( true );
|
|
try
|
|
{
|
|
Reference< XDatabaseMetaData > xMeta( m_pImpl->xConnectionMetaData, UNO_SET_THROW );
|
|
::rtl::OUString sConnectionURL( xMeta->getURL() );
|
|
bSupported = sConnectionURL.compareToAscii( RTL_CONSTASCII_STRINGPARAM( "sdbc:mysql:mysqlc" ) ) != 0;
|
|
}
|
|
catch( const Exception& )
|
|
{
|
|
DBG_UNHANDLED_EXCEPTION();
|
|
}
|
|
return bSupported;
|
|
}
|
|
|
|
//........................................................................
|
|
} // namespace dbtools
|
|
//........................................................................
|
|
|