connectivity/source/commontools/sqlerror.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29
  30 #include "connectivity/sqlerror.hxx"
  31
  32 /** === begin UNO includes === **/
  33 #include <com/sun/star/sdbc/SQLException.hpp>
  34 /** === end UNO includes === **/
  35
  36 #include <comphelper/officeresourcebundle.hxx>
  37 #include <cppuhelper/exc_hlp.hxx>
  38 #include <rtl/ustrbuf.hxx>
  39
  40 #include <string.h>
  41
  42 //........................................................................
  43 namespace connectivity
  44 {
  45 //........................................................................
  46
  47     /** === begin UNO using === **/
  48     using ::com::sun::star::uno::Reference;
  49     using ::com::sun::star::uno::UNO_QUERY;
  50     using ::com::sun::star::uno::UNO_QUERY_THROW;
  51     using ::com::sun::star::uno::Exception;
  52     using ::com::sun::star::uno::RuntimeException;
  53     using ::com::sun::star::uno::Any;
  54     using ::com::sun::star::uno::makeAny;
  55     using ::com::sun::star::uno::XInterface;
  56     using ::com::sun::star::sdbc::SQLException;
  57     using ::com::sun::star::uno::Type;
  58     /** === end UNO using === **/
  59
  60     //using SQLError::ParamValue; // GCC (unxlngi6) does not like this
  61     namespace
  62     {
  63         typedef SQLError::ParamValue ParamValue;
  64     }
  65
  66     //====================================================================
  67     //= SQLError_Impl - declaration
  68     //====================================================================
  69     class SQLError_Impl
  70     {
  71     public:
  72         SQLError_Impl( const ::comphelper::ComponentContext& _rContext );
  73         ~SQLError_Impl();
  74
  75         // versions of the public SQLError methods which are just delegated to this impl-class
  76         static const ::rtl::OUString& getMessagePrefix();
  77         ::rtl::OUString     getErrorMessage( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  78         ::rtl::OUString     getSQLState( const ErrorCondition _eCondition );
  79         static ErrorCode    getErrorCode( const ErrorCondition _eCondition );
  80         void                raiseException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  81         void                raiseException( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  82         void                raiseTypedException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const Type& _rExceptionType, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  83         SQLException        getSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  84
  85     private:
  86         /// returns the basic error message associated with the given error condition, without any parameter replacements
  87         ::rtl::OUString
  88                 impl_getErrorMessage( const ErrorCondition& _eCondition );
  89
  90         /// returns the SQLState associated with the given error condition
  91         ::rtl::OUString
  92                 impl_getSQLState( const ErrorCondition& _eCondition );
  93
  94         /// returns an SQLException describing the given error condition
  95         SQLException
  96                 impl_buildSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
  97                     const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  98
  99         /// initializes our resource bundle
 100         bool    impl_initResources();
 101
 102     private:
 103         ::osl::Mutex                                            m_aMutex;
 104         ::comphelper::ComponentContext                          m_aContext;
 105         ::std::auto_ptr< ::comphelper::OfficeResourceBundle >   m_pResources;
 106         bool                                                    m_bAttemptedInit;
 107     };
 108
 109     //====================================================================
 110     //= SQLError_Impl - implementation
 111     //====================================================================
 112     //--------------------------------------------------------------------
 113     SQLError_Impl::SQLError_Impl( const ::comphelper::ComponentContext& _rContext )
 114         :m_aContext( _rContext )
 115         ,m_pResources( )
 116         ,m_bAttemptedInit( false )
 117     {
 118     }
 119
 120     //--------------------------------------------------------------------
 121     SQLError_Impl::~SQLError_Impl()
 122     {
 123     }
 124
 125     //--------------------------------------------------------------------
 126     const ::rtl::OUString& SQLError_Impl::getMessagePrefix()
 127     {
 128         static ::rtl::OUString s_sMessagePrefix( RTL_CONSTASCII_USTRINGPARAM( "[OOoBase]" ) );
 129         return s_sMessagePrefix;
 130     }
 131
 132     //--------------------------------------------------------------------
 133     namespace
 134     {
 135         //................................................................
 136         /** substitutes a given placeholder in the given message with the given value
 137         */
 138         void    lcl_substitutePlaceholder( ::rtl::OUString& _rMessage, const sal_Char* _pPlaceholder, ParamValue _rParamValue )
 139         {
 140             size_t nPlaceholderLen( strlen( _pPlaceholder ) );
 141             sal_Int32 nIndex = _rMessage.indexOfAsciiL( _pPlaceholder, nPlaceholderLen );
 142
 143             bool bHasPlaceholder = ( nIndex != -1 );
 144             bool bWantsPlaceholder = _rParamValue.is();
 145             OSL_ENSURE( bHasPlaceholder == bWantsPlaceholder, "lcl_substitutePlaceholder: placeholder where none is expected, or no placeholder where one is needed!" );
 146
 147             if ( bHasPlaceholder && bWantsPlaceholder )
 148                 _rMessage = _rMessage.replaceAt( nIndex, nPlaceholderLen, *_rParamValue );
 149         }
 150
 151         //................................................................
 152         sal_Int32   lcl_getResourceID( const ErrorCondition _eCondition, bool _bSQLState )
 153         {
 154             return  256
 155                 +   2 * ::sal::static_int_cast< sal_Int32, ErrorCondition >( _eCondition )
 156                 +   ( _bSQLState ? 1 : 0 );
 157         }
 158     }
 159
 160     //--------------------------------------------------------------------
 161     ::rtl::OUString SQLError_Impl::getErrorMessage( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 162     {
 163         ::rtl::OUString sErrorMessage( impl_getErrorMessage( _eCondition ) );
 164
 165         lcl_substitutePlaceholder( sErrorMessage, "$1$", _rParamValue1 );
 166         lcl_substitutePlaceholder( sErrorMessage, "$2$", _rParamValue2 );
 167         lcl_substitutePlaceholder( sErrorMessage, "$3$", _rParamValue3 );
 168
 169         return sErrorMessage;
 170     }
 171
 172     //--------------------------------------------------------------------
 173     ::rtl::OUString SQLError_Impl::getSQLState( const ErrorCondition _eCondition )
 174     {
 175         return impl_getSQLState( _eCondition );
 176     }
 177
 178     //--------------------------------------------------------------------
 179     ErrorCode SQLError_Impl::getErrorCode( const ErrorCondition _eCondition )
 180     {
 181         return 0 - ::sal::static_int_cast< ErrorCode, ErrorCondition >( _eCondition );
 182     }
 183
 184     //--------------------------------------------------------------------
 185     void SQLError_Impl::raiseException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 186     {
 187         raiseTypedException(
 188             _eCondition,
 189             _rxContext,
 190             ::cppu::UnoType< SQLException >::get(),
 191             _rParamValue1,
 192             _rParamValue2,
 193             _rParamValue3
 194         );
 195     }
 196
 197     //--------------------------------------------------------------------
 198     void SQLError_Impl::raiseException( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 199     {
 200         raiseTypedException(
 201             _eCondition,
 202             NULL,
 203             ::cppu::UnoType< SQLException >::get(),
 204             _rParamValue1,
 205             _rParamValue2,
 206             _rParamValue3
 207         );
 208     }
 209
 210     //--------------------------------------------------------------------
 211     void SQLError_Impl::raiseTypedException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 212         const Type& _rExceptionType, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 213     {
 214         if ( !::cppu::UnoType< SQLException >::get().isAssignableFrom( _rExceptionType ) )
 215             throw ::std::bad_cast();
 216
 217         // default-construct an exception of the desired type
 218         Any aException( NULL, _rExceptionType );
 219
 220         // fill it
 221         SQLException* pException = static_cast< SQLException* >( aException.pData );
 222         *pException = impl_buildSQLException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 223
 224         // throw it
 225         ::cppu::throwException( aException );
 226     }
 227
 228     //--------------------------------------------------------------------
 229     SQLException SQLError_Impl::getSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 230         const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 231     {
 232         return impl_buildSQLException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 233     }
 234
 235     //--------------------------------------------------------------------
 236     SQLException SQLError_Impl::impl_buildSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 237         const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 238     {
 239         return SQLException(
 240             getErrorMessage( _eCondition, _rParamValue1, _rParamValue2, _rParamValue3 ),
 241             _rxContext,
 242             getSQLState( _eCondition ),
 243             getErrorCode( _eCondition ),
 244             Any()
 245         );
 246     }
 247
 248     //--------------------------------------------------------------------
 249     ::rtl::OUString SQLError_Impl::impl_getErrorMessage( const ErrorCondition& _eCondition )
 250     {
 251         ::rtl::OUStringBuffer aMessage;
 252
 253         if ( impl_initResources() )
 254         {
 255             ::rtl::OUString sResMessage( m_pResources->loadString( lcl_getResourceID( _eCondition, false ) ) );
 256             OSL_ENSURE( !sResMessage.isEmpty(), "SQLError_Impl::impl_getErrorMessage: illegal error condition, or invalid resource!" );
 257             aMessage.append( getMessagePrefix() ).appendAscii( " " ).append( sResMessage );
 258         }
 259
 260         return aMessage.makeStringAndClear();
 261     }
 262
 263     //--------------------------------------------------------------------
 264     ::rtl::OUString SQLError_Impl::impl_getSQLState( const ErrorCondition& _eCondition )
 265     {
 266         ::rtl::OUString sState;
 267
 268         if ( impl_initResources() )
 269         {
 270             sal_Int32 nResourceId( lcl_getResourceID( _eCondition, true ) );
 271             if ( m_pResources->hasString( nResourceId ) )
 272                 sState = m_pResources->loadString( nResourceId );
 273         }
 274
 275         if ( sState.isEmpty() )
 276             sState = ::rtl::OUString::intern( RTL_CONSTASCII_USTRINGPARAM( "S1000" ) );
 277
 278         return sState;
 279     }
 280
 281     //--------------------------------------------------------------------
 282     bool SQLError_Impl::impl_initResources()
 283     {
 284         if ( m_pResources.get() )
 285             return true;
 286         if ( m_bAttemptedInit )
 287             return false;
 288
 289         ::osl::MutexGuard aGuard( m_aMutex );
 290         m_bAttemptedInit = true;
 291
 292         m_pResources.reset( new ::comphelper::OfficeResourceBundle( m_aContext.getUNOContext(), "sdberr" ) );
 293         return m_pResources.get() != NULL;
 294     }
 295
 296     //====================================================================
 297     //= SQLError
 298     //====================================================================
 299     //--------------------------------------------------------------------
 300     SQLError::SQLError( const ::comphelper::ComponentContext& _rContext )
 301         :m_pImpl( new SQLError_Impl( _rContext ) )
 302     {
 303     }
 304
 305     //--------------------------------------------------------------------
 306     SQLError::~SQLError()
 307     {
 308     }
 309
 310     //--------------------------------------------------------------------
 311     const ::rtl::OUString& SQLError::getMessagePrefix()
 312     {
 313         return SQLError_Impl::getMessagePrefix();
 314     }
 315
 316     //--------------------------------------------------------------------
 317     ::rtl::OUString SQLError::getErrorMessage( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 318     {
 319         return m_pImpl->getErrorMessage( _eCondition, _rParamValue1, _rParamValue2, _rParamValue3 );
 320     }
 321
 322     //--------------------------------------------------------------------
 323     ::rtl::OUString SQLError::getSQLState( const ErrorCondition _eCondition ) const
 324     {
 325         return m_pImpl->getSQLState( _eCondition );
 326     }
 327
 328     //--------------------------------------------------------------------
 329     ErrorCode SQLError::getErrorCode( const ErrorCondition _eCondition )
 330     {
 331         return SQLError_Impl::getErrorCode( _eCondition );
 332     }
 333
 334     //--------------------------------------------------------------------
 335     void SQLError::raiseException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 336     {
 337         m_pImpl->raiseException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 338     }
 339
 340     //--------------------------------------------------------------------
 341     void SQLError::raiseException( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 342     {
 343         m_pImpl->raiseException( _eCondition, _rParamValue1, _rParamValue2, _rParamValue3 );
 344     }
 345
 346     //--------------------------------------------------------------------
 347     void SQLError::raiseTypedException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 348         const Type& _rExceptionType, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 349     {
 350         m_pImpl->raiseTypedException( _eCondition, _rxContext, _rExceptionType, _rParamValue1, _rParamValue2, _rParamValue3 );
 351     }
 352
 353     //--------------------------------------------------------------------
 354     SQLException SQLError::getSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 355         const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 356     {
 357         return m_pImpl->getSQLException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 358     }
 359
 360 //........................................................................
 361 } // namespace connectivity
 362 //........................................................................
 363
 364 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */