INTEGRATION: CWS qiq (1.1.2); FILE ADDED

2006/06/28 10:31:09 fs 1.1.2.4: #i10000#
2006/06/01 09:52:21 fs 1.1.2.3: #i51143# extension of XObjectNames
2006/05/30 08:24:11 fs 1.1.2.2: createObjectNames -> getObjectNames (the thing is stateless, so no need to re-create it every time)
2006/05/24 06:54:23 fs 1.1.2.1: XObjectNames implementation

1 files changed, 433 insertions, 0 deletions

diff --git a/dbaccess/source/sdbtools/connection/objectnames.cxx b/dbaccess/source/sdbtools/connection/objectnames.cxx
new file mode 100644
index 000000000..daf65d431
--- /dev/null
+++ b/dbaccess/source/sdbtools/connection/objectnames.cxx
@@ -0,0 +1,433 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: objectnames.cxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2006-07-10 15:19:57 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library 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 for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef DBACCESS_SOURCE_SDBTOOLS_CONNECTION_OBJECTNAMES_HXX
+#include "objectnames.hxx"
+#endif
+
+#ifndef DBACCESS_MODULE_SDBT_HXX
+#include "module_sdbt.hxx"
+#endif
+#ifndef DBACCESS_SDBT_RESOURCE_HRC
+#include "sdbt_resource.hrc"
+#endif
+
+/** === begin UNO includes === **/
+#ifndef _COM_SUN_STAR_LANG_NULLPOINTEREXCEPTION_HPP_
+#include <com/sun/star/lang/NullPointerException.hpp>
+#endif
+#ifndef _COM_SUN_STAR_SDB_COMMANDTYPE_HPP_
+#include <com/sun/star/sdb/CommandType.hpp>
+#endif
+#ifndef _COM_SUN_STAR_SDBCX_XTABLESSUPPLIER_HPP_
+#include <com/sun/star/sdbcx/XTablesSupplier.hpp>
+#endif
+#ifndef _COM_SUN_STAR_SDB_XQUERIESSUPPLIER_HPP_
+#include <com/sun/star/sdb/XQueriesSupplier.hpp>
+#endif
+/** === end UNO includes === **/
+
+#ifndef CONNECTIVITY_INC_CONNECTIVITY_DBMETADATA_HXX
+#include <connectivity/dbmetadata.hxx>
+#endif
+#ifndef _CONNECTIVITY_DBTOOLS_HXX_
+#include <connectivity/dbtools.hxx>
+#endif
+
+#ifndef _STRING_HXX
+#include <tools/string.hxx>
+#endif
+
+#ifndef _RTL_USTRBUF_HXX_
+#include <rtl/ustrbuf.hxx>
+#endif
+
+#include <boost/shared_ptr.hpp>
+
+//........................................................................
+namespace sdbtools
+{
+//........................................................................
+
+    /** === begin UNO using === **/
+    using ::com::sun::star::uno::Reference;
+    using ::com::sun::star::sdbc::XConnection;
+    using ::com::sun::star::lang::NullPointerException;
+    using ::com::sun::star::lang::IllegalArgumentException;
+    using ::com::sun::star::uno::RuntimeException;
+    using ::com::sun::star::sdbc::SQLException;
+    using ::com::sun::star::sdbc::XDatabaseMetaData;
+    using ::com::sun::star::uno::XInterface;
+    using ::com::sun::star::container::XNameAccess;
+    using ::com::sun::star::sdbc::XDatabaseMetaData;
+    using ::com::sun::star::uno::UNO_QUERY_THROW;
+    using ::com::sun::star::sdbcx::XTablesSupplier;
+    using ::com::sun::star::sdb::XQueriesSupplier;
+    using ::com::sun::star::uno::Exception;
+    using ::com::sun::star::uno::makeAny;
+    using ::com::sun::star::uno::Any;
+    /** === end UNO using === **/
+
+    namespace CommandType = ::com::sun::star::sdb::CommandType;
+
+    //====================================================================
+    //= INameCheck
+    //====================================================================
+    class INameCheck
+    {
+    public:
+        virtual bool checkName( const ::rtl::OUString& _rName ) = 0;
+
+        virtual ~INameCheck() { }
+    };
+    typedef ::boost::shared_ptr< INameCheck >   PNameCheck;
+
+    //====================================================================
+    //= PlainExistenceCheck
+    //====================================================================
+    class PlainExistenceCheck : public INameCheck
+    {
+    private:
+        Reference< XNameAccess >    m_xContainer;
+
+    public:
+        PlainExistenceCheck( const Reference< XNameAccess >& _rxContainer )
+            :m_xContainer( _rxContainer )
+        {
+            OSL_ENSURE( m_xContainer.is(), "PlainExistenceCheck::PlainExistenceCheck: this will crash!" );
+        }
+
+        // INameCheck
+        virtual bool checkName( const ::rtl::OUString& _rName )
+        {
+            return m_xContainer->hasByName( _rName );
+        }
+    };
+
+    //====================================================================
+    //= TableValidityCheck
+    //====================================================================
+    class TableValidityCheck : public INameCheck
+    {
+        Reference< XDatabaseMetaData >  m_xMeta;
+    public:
+        TableValidityCheck( const Reference< XDatabaseMetaData >& _rxMeta )
+            :m_xMeta( _rxMeta )
+        {
+        }
+
+        virtual bool checkName( const ::rtl::OUString& _rName )
+        {
+            return ::dbtools::isValidSQLName( _rName, m_xMeta->getExtraNameCharacters() );
+        }
+    };
+
+    //====================================================================
+    //= QueryValidityCheck
+    //====================================================================
+    class QueryValidityCheck : public INameCheck
+    {
+    public:
+        virtual bool checkName( const ::rtl::OUString& _rName )
+        {
+            if  (   ( _rName.indexOf( (sal_Unicode)34  ) >= 0 )  // "
+                ||  ( _rName.indexOf( (sal_Unicode)39  ) >= 0 )  // '
+                ||  ( _rName.indexOf( (sal_Unicode)96  ) >= 0 )  // `
+                ||  ( _rName.indexOf( (sal_Unicode)145 ) >= 0 )  // ‘
+                ||  ( _rName.indexOf( (sal_Unicode)146 ) >= 0 )  // ’
+                ||  ( _rName.indexOf( (sal_Unicode)180 ) >= 0 )  // ´
+                )
+                return false;
+            return true;
+        }
+    };
+
+    //====================================================================
+    //= CombinedNameCheck
+    //====================================================================
+    class CombinedNameCheck : public INameCheck
+    {
+    private:
+        PNameCheck  m_pPrimary;
+        PNameCheck  m_pSecondary;
+
+    public:
+        CombinedNameCheck( PNameCheck _pPrimary, PNameCheck _pSecondary )
+            :m_pPrimary( _pPrimary )
+            ,m_pSecondary( _pSecondary )
+        {
+            OSL_ENSURE( m_pPrimary.get() && m_pSecondary.get(), "CombinedNameCheck::CombinedNameCheck: this will crash!" );
+        }
+
+        // INameCheck
+        virtual bool checkName( const ::rtl::OUString& _rName )
+        {
+            return m_pPrimary->checkName( _rName ) || m_pSecondary->checkName( _rName );
+        }
+    };
+
+    //====================================================================
+    //= NameCheckFactory
+    //====================================================================
+    class NameCheckFactory
+    {
+    public:
+        /** creates an INameCheck instance which can be used to check the existence of query or table names
+
+            @param  _nCommandType
+                the type of objects (CommandType::TABLE or CommandType::QUERY) of which names shall be checked for existence
+
+            @param  _rxConnection
+                the connection relative to which the names are to be checked. Must be an SDB-level connection
+
+            @throws IllegalArgumentException
+                if the given connection is no SDB-level connection
+
+            @throws IllegalArgumentException
+                if the given command type is neither CommandType::TABLE or CommandType::QUERY
+        */
+        static  PNameCheck  createExistenceCheck( sal_Int32 _nCommandType, const Reference< XConnection >& _rxConnection );
+
+        /** creates an INameCheck instance which can be used to check the validity of a query or table name
+
+            @param  _nCommandType
+                the type of objects (CommandType::TABLE or CommandType::QUERY) of which names shall be validated
+
+            @param  _rxConnection
+                the connection relative to which the names are to be checked. Must be an SDB-level connection
+
+            @throws IllegalArgumentException
+                if the given connection is no SDB-level connection
+
+            @throws IllegalArgumentException
+                if the given command type is neither CommandType::TABLE or CommandType::QUERY
+        */
+        static  PNameCheck  createValidityCheck( sal_Int32 _nCommandType, const Reference< XConnection >& _rxConnection );
+
+    private:
+        NameCheckFactory();                                     // never implemented
+
+    private:
+        static  void    verifyCommandType( sal_Int32 _nCommandType );
+    };
+
+    //--------------------------------------------------------------------
+    void NameCheckFactory::verifyCommandType( sal_Int32 _nCommandType )
+    {
+        if  (   ( _nCommandType != CommandType::TABLE )
+            &&  ( _nCommandType != CommandType::QUERY )
+            )
+            throw IllegalArgumentException(
+                ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Only com.sun.star.sdb.CommandType.TABLE and com.sun.star.sdb.CommandType.QUERY are allowed." ) ),
+                NULL,
+                0
+            );
+            // TODO: resource
+    }
+
+    //--------------------------------------------------------------------
+    PNameCheck  NameCheckFactory::createExistenceCheck( sal_Int32 _nCommandType, const Reference< XConnection >& _rxConnection )
+    {
+        verifyCommandType( _nCommandType );
+
+        ::dbtools::DatabaseMetaData aMeta( _rxConnection );
+
+        Reference< XNameAccess > xTables, xQueries;
+        try
+        {
+            Reference< XTablesSupplier > xSuppTables( _rxConnection, UNO_QUERY_THROW );
+            Reference< XQueriesSupplier > xQueriesSupplier( _rxConnection, UNO_QUERY_THROW );
+            xTables.set( xSuppTables->getTables(), UNO_QUERY_THROW );
+            xQueries.set( xQueriesSupplier->getQueries(), UNO_QUERY_THROW );
+        }
+        catch( const Exception& )
+        {
+            throw IllegalArgumentException(
+                ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "The given connection is no valid query and/or tables supplier." ) ),
+                NULL,
+                0
+            );
+            // TODO: resource
+        }
+
+        PNameCheck pTableCheck( new PlainExistenceCheck( xTables ) );
+        PNameCheck pQueryCheck( new PlainExistenceCheck( xQueries ) );
+        PNameCheck pReturn;
+
+        if ( aMeta.supportsSubqueriesInFrom() )
+            pReturn.reset( new CombinedNameCheck( pTableCheck, pQueryCheck ) );
+        else if ( _nCommandType == CommandType::TABLE )
+            pReturn = pTableCheck;
+        else
+            pReturn = pQueryCheck;
+        return pReturn;
+    }
+
+    //--------------------------------------------------------------------
+    PNameCheck  NameCheckFactory::createValidityCheck( sal_Int32 _nCommandType, const Reference< XConnection >& _rxConnection )
+    {
+        verifyCommandType( _nCommandType );
+
+        Reference< XDatabaseMetaData > xMeta;
+        try
+        {
+            xMeta.set( _rxConnection->getMetaData(), UNO_QUERY_THROW );
+        }
+        catch( const Exception& )
+        {
+            throw IllegalArgumentException(
+                ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "The connection could not provide its database's meta data." ) ),
+                NULL,
+                0
+            );
+            // TODO: resource
+        }
+
+        if ( _nCommandType == CommandType::TABLE )
+            return PNameCheck( new TableValidityCheck( xMeta ) );
+        return PNameCheck( new QueryValidityCheck );
+    }
+
+    //====================================================================
+    //= ObjectNames_Impl
+    //====================================================================
+    struct ObjectNames_Impl
+    {
+        SdbtClient      m_aModuleClient;    // keep the module alive as long as this instance lives
+    };
+
+    //====================================================================
+    //= ObjectNames
+    //====================================================================
+    //--------------------------------------------------------------------
+    ObjectNames::ObjectNames( const Reference< XConnection >& _rxConnection )
+        :m_pImpl( new ObjectNames_Impl )
+    {
+        if ( !_rxConnection.is() )
+            throw NullPointerException();
+        setWeakConnection( _rxConnection );
+    }
+
+    //--------------------------------------------------------------------
+    ObjectNames::~ObjectNames()
+    {
+    }
+
+    //--------------------------------------------------------------------
+    ::rtl::OUString SAL_CALL ObjectNames::suggestName( ::sal_Int32 _CommandType, const ::rtl::OUString& _BaseName ) throw (IllegalArgumentException, RuntimeException)
+    {
+        EntryGuard aGuard( *this );
+
+        PNameCheck pNameCheck( NameCheckFactory::createExistenceCheck( _CommandType, getConnection()) );
+
+        String sBaseName( _BaseName );
+        if ( sBaseName.Len() == 0 )
+            if ( _CommandType == CommandType::TABLE )
+                sBaseName = String( SdbtRes( STR_BASENAME_TABLE ) );
+            else
+                sBaseName = String( SdbtRes( STR_BASENAME_QUERY ) );
+
+        ::rtl::OUString sName( sBaseName );
+        sal_Int32 i = 1;
+        while ( pNameCheck->checkName( sName ) )
+        {
+            ::rtl::OUStringBuffer aNameBuffer;
+            aNameBuffer.append( sBaseName );
+            aNameBuffer.appendAscii( " " );
+            aNameBuffer.append( (sal_Int32)++i );
+            sName = aNameBuffer.makeStringAndClear();
+        }
+
+        return sName;
+    }
+    
+    //--------------------------------------------------------------------
+    ::rtl::OUString SAL_CALL ObjectNames::convertToSQLName( const ::rtl::OUString& Name ) throw (RuntimeException)
+    {
+        EntryGuard aGuard( *this );
+        Reference< XDatabaseMetaData > xMeta( getConnection()->getMetaData(), UNO_QUERY_THROW );
+        return ::dbtools::convertName2SQLName( Name, xMeta->getExtraNameCharacters() );
+    }
+    
+    //--------------------------------------------------------------------
+    ::sal_Bool SAL_CALL ObjectNames::isNameUsed( ::sal_Int32 _CommandType, const ::rtl::OUString& _Name ) throw (IllegalArgumentException, RuntimeException)
+    {
+        EntryGuard aGuard( *this );
+
+        PNameCheck pNameCheck( NameCheckFactory::createExistenceCheck( _CommandType, getConnection()) );
+        return pNameCheck->checkName( _Name );
+    }
+    
+    //--------------------------------------------------------------------
+    ::sal_Bool SAL_CALL ObjectNames::isNameValid( ::sal_Int32 _CommandType, const ::rtl::OUString& _Name ) throw (IllegalArgumentException, RuntimeException)
+    {
+        EntryGuard aGuard( *this );
+
+        PNameCheck pNameCheck( NameCheckFactory::createValidityCheck( _CommandType, getConnection()) );
+        return pNameCheck->checkName( _Name );
+    }
+    
+    //--------------------------------------------------------------------
+    void SAL_CALL ObjectNames::checkNameForCreate( ::sal_Int32 _CommandType, const ::rtl::OUString& _Name ) throw (SQLException, RuntimeException)
+    {
+        EntryGuard aGuard( *this );
+
+        PNameCheck pNameCheck( NameCheckFactory::createExistenceCheck( _CommandType, getConnection() ) );
+        if ( pNameCheck->checkName( _Name ) )
+        {
+            String sNameIsUsed( SdbtRes( STR_NAME_ALREADY_USED_IN_DB ) );
+            sNameIsUsed.SearchAndReplaceAllAscii( "$name$", _Name );
+            String sNeedDistinctNames( SdbtRes( STR_QUERY_AND_TABLE_DISTINCT_NAMES ) );
+
+            Any aDetails;
+            ::dbtools::DatabaseMetaData aMeta( getConnection() );
+            if ( aMeta.supportsSubqueriesInFrom() )
+                aDetails <<= SQLException( sNeedDistinctNames, getConnection(), ::rtl::OUString(), 0, Any() );
+
+            throw SQLException( sNameIsUsed, getConnection(), ::rtl::OUString(), 0, aDetails );
+        }
+
+        pNameCheck = NameCheckFactory::createValidityCheck( _CommandType, getConnection() );
+        if ( !pNameCheck->checkName( _Name ) )
+        {
+            String sError( SdbtRes( STR_NO_QUOTES_IN_QUERY_NAMES ) );
+            throw SQLException( sError, getConnection(), ::rtl::OUString(), 0, Any() );
+        }
+    }
+
+//........................................................................
+} // namespace sdbtools
+//........................................................................
+