connectivity/source/commontools/sqlerror.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: sqlerror.cxx,v $
  10  * $Revision: 1.4 $
  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/sqlerror.hxx"
  35
  36 /** === begin UNO includes === **/
  37 #include <com/sun/star/sdbc/SQLException.hpp>
  38 /** === end UNO includes === **/
  39
  40 #include <comphelper/officeresourcebundle.hxx>
  41 #include <cppuhelper/exc_hlp.hxx>
  42 #include <rtl/ustrbuf.hxx>
  43
  44 #include <string.h>
  45
  46 //........................................................................
  47 namespace connectivity
  48 {
  49 //........................................................................
  50
  51     /** === begin UNO using === **/
  52     using ::com::sun::star::uno::Reference;
  53     using ::com::sun::star::uno::UNO_QUERY;
  54     using ::com::sun::star::uno::UNO_QUERY_THROW;
  55     using ::com::sun::star::uno::Exception;
  56     using ::com::sun::star::uno::RuntimeException;
  57     using ::com::sun::star::uno::Any;
  58     using ::com::sun::star::uno::makeAny;
  59     using ::com::sun::star::uno::XInterface;
  60     using ::com::sun::star::sdbc::SQLException;
  61     using ::com::sun::star::uno::Type;
  62     /** === end UNO using === **/
  63
  64     //using SQLError::ParamValue; // GCC (unxlngi6) does not like this
  65     namespace
  66     {
  67         typedef SQLError::ParamValue ParamValue;
  68     }
  69
  70     //====================================================================
  71     //= SQLError_Impl - declaration
  72     //====================================================================
  73     class SQLError_Impl
  74     {
  75     public:
  76         SQLError_Impl( const ::comphelper::ComponentContext& _rContext );
  77         ~SQLError_Impl();
  78
  79         // versions of the public SQLError methods which are just delegated to this impl-class
  80         static const ::rtl::OUString& getMessagePrefix();
  81         ::rtl::OUString     getErrorMessage( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  82         ::rtl::OUString     getSQLState( const ErrorCondition _eCondition );
  83         static ErrorCode    getErrorCode( const ErrorCondition _eCondition );
  84         void                raiseException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  85         void                raiseException( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  86         void                raiseTypedException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const Type& _rExceptionType, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  87         SQLException        getSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  88
  89     private:
  90         /// returns the basic error message associated with the given error condition, without any parameter replacements
  91         ::rtl::OUString
  92                 impl_getErrorMessage( const ErrorCondition& _eCondition );
  93
  94         /// returns the SQLState associated with the given error condition
  95         ::rtl::OUString
  96                 impl_getSQLState( const ErrorCondition& _eCondition );
  97
  98         /// returns an SQLException describing the given error condition
  99         SQLException
 100                 impl_buildSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 101                     const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
 102
 103         /// initializes our resource bundle
 104         bool    impl_initResources();
 105
 106     private:
 107         ::osl::Mutex                                            m_aMutex;
 108         ::comphelper::ComponentContext                          m_aContext;
 109         ::std::auto_ptr< ::comphelper::OfficeResourceBundle >   m_pResources;
 110         bool                                                    m_bAttemptedInit;
 111     };
 112
 113     //====================================================================
 114     //= SQLError_Impl - implementation
 115     //====================================================================
 116     //--------------------------------------------------------------------
 117     SQLError_Impl::SQLError_Impl( const ::comphelper::ComponentContext& _rContext )
 118         :m_aContext( _rContext )
 119         ,m_pResources( )
 120         ,m_bAttemptedInit( false )
 121     {
 122     }
 123
 124     //--------------------------------------------------------------------
 125     SQLError_Impl::~SQLError_Impl()
 126     {
 127     }
 128
 129     //--------------------------------------------------------------------
 130     const ::rtl::OUString& SQLError_Impl::getMessagePrefix()
 131     {
 132         static ::rtl::OUString s_sMessagePrefix( RTL_CONSTASCII_USTRINGPARAM( "[OOoBase]" ) );
 133         return s_sMessagePrefix;
 134     }
 135
 136     //--------------------------------------------------------------------
 137     namespace
 138     {
 139         //................................................................
 140         /** substitutes a given placeholder in the given message with the given value
 141         */
 142         void    lcl_substitutePlaceholder( ::rtl::OUString& _rMessage, const sal_Char* _pPlaceholder, ParamValue _rParamValue )
 143         {
 144             size_t nPlaceholderLen( strlen( _pPlaceholder ) );
 145             sal_Int32 nIndex = _rMessage.indexOfAsciiL( _pPlaceholder, nPlaceholderLen );
 146
 147             bool bHasPlaceholder = ( nIndex != -1 );
 148             bool bWantsPlaceholder = _rParamValue.is();
 149             OSL_ENSURE( bHasPlaceholder == bWantsPlaceholder, "lcl_substitutePlaceholder: placeholder where none is expected, or no placeholder where one is needed!" );
 150
 151             if ( bHasPlaceholder && bWantsPlaceholder )
 152                 _rMessage = _rMessage.replaceAt( nIndex, nPlaceholderLen, *_rParamValue );
 153         }
 154
 155         //................................................................
 156         sal_Int32   lcl_getResourceID( const ErrorCondition _eCondition, bool _bSQLState )
 157         {
 158             return  256
 159                 +   2 * ::sal::static_int_cast< sal_Int32, ErrorCondition >( _eCondition )
 160                 +   ( _bSQLState ? 1 : 0 );
 161         }
 162     }
 163
 164     //--------------------------------------------------------------------
 165     ::rtl::OUString SQLError_Impl::getErrorMessage( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 166     {
 167         ::rtl::OUString sErrorMessage( impl_getErrorMessage( _eCondition ) );
 168
 169         lcl_substitutePlaceholder( sErrorMessage, "$1$", _rParamValue1 );
 170         lcl_substitutePlaceholder( sErrorMessage, "$2$", _rParamValue2 );
 171         lcl_substitutePlaceholder( sErrorMessage, "$3$", _rParamValue3 );
 172
 173         return sErrorMessage;
 174     }
 175
 176     //--------------------------------------------------------------------
 177     ::rtl::OUString SQLError_Impl::getSQLState( const ErrorCondition _eCondition )
 178     {
 179         return impl_getSQLState( _eCondition );
 180     }
 181
 182     //--------------------------------------------------------------------
 183     ErrorCode SQLError_Impl::getErrorCode( const ErrorCondition _eCondition )
 184     {
 185         return 0 - ::sal::static_int_cast< ErrorCode, ErrorCondition >( _eCondition );
 186     }
 187
 188     //--------------------------------------------------------------------
 189     void SQLError_Impl::raiseException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 190     {
 191         raiseTypedException(
 192             _eCondition,
 193             _rxContext,
 194             ::cppu::UnoType< SQLException >::get(),
 195             _rParamValue1,
 196             _rParamValue2,
 197             _rParamValue3
 198         );
 199     }
 200
 201     //--------------------------------------------------------------------
 202     void SQLError_Impl::raiseException( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 203     {
 204         raiseTypedException(
 205             _eCondition,
 206             NULL,
 207             ::cppu::UnoType< SQLException >::get(),
 208             _rParamValue1,
 209             _rParamValue2,
 210             _rParamValue3
 211         );
 212     }
 213
 214     //--------------------------------------------------------------------
 215     void SQLError_Impl::raiseTypedException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 216         const Type& _rExceptionType, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 217     {
 218         if ( !::cppu::UnoType< SQLException >::get().isAssignableFrom( _rExceptionType ) )
 219             throw ::std::bad_cast();
 220
 221         // default-construct an exception of the desired type
 222         Any aException( NULL, _rExceptionType );
 223
 224         // fill it
 225         SQLException* pException = static_cast< SQLException* >( aException.pData );
 226         *pException = impl_buildSQLException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 227
 228         // throw it
 229         ::cppu::throwException( aException );
 230     }
 231
 232     //--------------------------------------------------------------------
 233     SQLException SQLError_Impl::getSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 234         const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 235     {
 236         return impl_buildSQLException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 237     }
 238
 239     //--------------------------------------------------------------------
 240     SQLException SQLError_Impl::impl_buildSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 241         const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 242     {
 243         return SQLException(
 244             getErrorMessage( _eCondition, _rParamValue1, _rParamValue2, _rParamValue3 ),
 245             _rxContext,
 246             getSQLState( _eCondition ),
 247             getErrorCode( _eCondition ),
 248             Any()
 249         );
 250     }
 251
 252     //--------------------------------------------------------------------
 253     ::rtl::OUString SQLError_Impl::impl_getErrorMessage( const ErrorCondition& _eCondition )
 254     {
 255         ::rtl::OUStringBuffer aMessage;
 256
 257         if ( impl_initResources() )
 258         {
 259             ::rtl::OUString sResMessage( m_pResources->loadString( lcl_getResourceID( _eCondition, false ) ) );
 260             OSL_ENSURE( sResMessage.getLength(), "SQLError_Impl::impl_getErrorMessage: illegal error condition, or invalid resource!" );
 261             aMessage.append( getMessagePrefix() ).appendAscii( " " ).append( sResMessage );
 262         }
 263
 264         return aMessage.makeStringAndClear();
 265     }
 266
 267     //--------------------------------------------------------------------
 268     ::rtl::OUString SQLError_Impl::impl_getSQLState( const ErrorCondition& _eCondition )
 269     {
 270         ::rtl::OUString sState;
 271
 272         if ( impl_initResources() )
 273         {
 274             sal_Int32 nResourceId( lcl_getResourceID( _eCondition, true ) );
 275             if ( m_pResources->hasString( nResourceId ) )
 276                 sState = m_pResources->loadString( nResourceId );
 277         }
 278
 279         if ( !sState.getLength() )
 280             sState = ::rtl::OUString::intern( RTL_CONSTASCII_USTRINGPARAM( "S1000" ) );
 281
 282         return sState;
 283     }
 284
 285     //--------------------------------------------------------------------
 286     bool SQLError_Impl::impl_initResources()
 287     {
 288         if ( m_pResources.get() )
 289             return true;
 290         if ( m_bAttemptedInit )
 291             return false;
 292
 293         ::osl::MutexGuard aGuard( m_aMutex );
 294         m_bAttemptedInit = true;
 295
 296         m_pResources.reset( new ::comphelper::OfficeResourceBundle( m_aContext.getUNOContext(), "sdberr" ) );
 297         return m_pResources.get() != NULL;
 298     }
 299
 300     //====================================================================
 301     //= SQLError
 302     //====================================================================
 303     //--------------------------------------------------------------------
 304     SQLError::SQLError( const ::comphelper::ComponentContext& _rContext )
 305         :m_pImpl( new SQLError_Impl( _rContext ) )
 306     {
 307     }
 308
 309     //--------------------------------------------------------------------
 310     SQLError::~SQLError()
 311     {
 312     }
 313
 314     //--------------------------------------------------------------------
 315     const ::rtl::OUString& SQLError::getMessagePrefix()
 316     {
 317         return SQLError_Impl::getMessagePrefix();
 318     }
 319
 320     //--------------------------------------------------------------------
 321     ::rtl::OUString SQLError::getErrorMessage( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 322     {
 323         return m_pImpl->getErrorMessage( _eCondition, _rParamValue1, _rParamValue2, _rParamValue3 );
 324     }
 325
 326     //--------------------------------------------------------------------
 327     ::rtl::OUString SQLError::getSQLState( const ErrorCondition _eCondition ) const
 328     {
 329         return m_pImpl->getSQLState( _eCondition );
 330     }
 331
 332     //--------------------------------------------------------------------
 333     ErrorCode SQLError::getErrorCode( const ErrorCondition _eCondition )
 334     {
 335         return SQLError_Impl::getErrorCode( _eCondition );
 336     }
 337
 338     //--------------------------------------------------------------------
 339     void SQLError::raiseException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 340     {
 341         m_pImpl->raiseException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 342     }
 343
 344     //--------------------------------------------------------------------
 345     void SQLError::raiseException( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 346     {
 347         m_pImpl->raiseException( _eCondition, _rParamValue1, _rParamValue2, _rParamValue3 );
 348     }
 349
 350     //--------------------------------------------------------------------
 351     void SQLError::raiseTypedException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 352         const Type& _rExceptionType, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 353     {
 354         m_pImpl->raiseTypedException( _eCondition, _rxContext, _rExceptionType, _rParamValue1, _rParamValue2, _rParamValue3 );
 355     }
 356
 357     //--------------------------------------------------------------------
 358     SQLException SQLError::getSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 359         const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 360     {
 361         return m_pImpl->getSQLException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 362     }
 363
 364 //........................................................................
 365 } // namespace connectivity
 366 //........................................................................