connectivity/source/commontools/sqlerror.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 #include <memory>
  22 #include <connectivity/sqlerror.hxx>
  23
  24 #include <com/sun/star/sdbc/SQLException.hpp>
  25 #include <com/sun/star/sdb/ErrorCondition.hpp>
  26 #include <com/sun/star/uno/XComponentContext.hpp>
  27
  28 #include <cppuhelper/exc_hlp.hxx>
  29 #include <rtl/ustrbuf.hxx>
  30 #include <unotools/resmgr.hxx>
  31 #include <osl/diagnose.h>
  32
  33 #include <strings.hrc>
  34 #include <strings.hxx>
  35 #include <string.h>
  36
  37 namespace connectivity
  38 {
  39
  40
  41     using ::com::sun::star::uno::Reference;
  42     using ::com::sun::star::uno::Any;
  43     using ::com::sun::star::uno::XInterface;
  44     using ::com::sun::star::sdbc::SQLException;
  45     using ::com::sun::star::uno::Type;
  46
  47     //using SQLError::ParamValue; // GCC (unxlngi6) does not like this
  48     namespace
  49     {
  50         typedef SQLError::ParamValue ParamValue;
  51     }
  52
  53
  54     class SQLError_Impl
  55     {
  56     public:
  57         explicit SQLError_Impl();
  58
  59         // versions of the public SQLError methods which are just delegated to this impl-class
  60         static const OUString& getMessagePrefix();
  61         OUString     getErrorMessage( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  62         static ErrorCode    getErrorCode( const ErrorCondition _eCondition );
  63         void                raiseException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  64         void                raiseException( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  65         void                raiseTypedException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const Type& _rExceptionType, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  66         SQLException        getSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  67
  68     private:
  69         /// returns the basic error message associated with the given error condition, without any parameter replacements
  70         OUString
  71                 impl_getErrorMessage( ErrorCondition _eCondition );
  72
  73         /// returns the SQLState associated with the given error condition
  74         static OUString
  75                 impl_getSQLState( ErrorCondition _eCondition );
  76
  77         /// returns an SQLException describing the given error condition
  78         SQLException
  79                 impl_buildSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
  80                     const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 );
  81     private:
  82         std::locale                                             m_aResources;
  83     };
  84
  85     SQLError_Impl::SQLError_Impl()
  86         : m_aResources(Translate::Create("cnr"))
  87     {
  88     }
  89
  90     const OUString& SQLError_Impl::getMessagePrefix()
  91     {
  92         static const OUString s_sMessagePrefix( "[OOoBase]" );
  93         return s_sMessagePrefix;
  94     }
  95
  96     namespace
  97     {
  98
  99         /** substitutes a given placeholder in the given message with the given value
 100         */
 101         void lcl_substitutePlaceholder(OUString& _rMessage, const sal_Char* _pPlaceholder, const ParamValue& rParamValue)
 102         {
 103             size_t nPlaceholderLen( strlen( _pPlaceholder ) );
 104             sal_Int32 nIndex = _rMessage.indexOfAsciiL( _pPlaceholder, nPlaceholderLen );
 105
 106             bool bHasPlaceholder = ( nIndex != -1 );
 107             bool bWantsPlaceholder = rParamValue.is();
 108             OSL_ENSURE( bHasPlaceholder == bWantsPlaceholder, "lcl_substitutePlaceholder: placeholder where none is expected, or no placeholder where one is needed!" );
 109
 110             if ( bHasPlaceholder && bWantsPlaceholder )
 111                 _rMessage = _rMessage.replaceAt( nIndex, nPlaceholderLen, *rParamValue );
 112         }
 113
 114         const char* lcl_getResourceErrorID(const ErrorCondition _eCondition)
 115         {
 116             switch (_eCondition)
 117             {
 118                 case css::sdb::ErrorCondition::ROW_SET_OPERATION_VETOED:
 119                     return STR_ROW_SET_OPERATION_VETOED;
 120                 case css::sdb::ErrorCondition::PARSER_CYCLIC_SUB_QUERIES:
 121                     return STR_PARSER_CYCLIC_SUB_QUERIES;
 122                 case css::sdb::ErrorCondition::DB_OBJECT_NAME_WITH_SLASHES:
 123                     return STR_DB_OBJECT_NAME_WITH_SLASHES;
 124                 case css::sdb::ErrorCondition::DB_INVALID_SQL_NAME:
 125                     return STR_DB_INVALID_SQL_NAME;
 126                 case css::sdb::ErrorCondition::DB_QUERY_NAME_WITH_QUOTES:
 127                     return STR_DB_QUERY_NAME_WITH_QUOTES;
 128                 case css::sdb::ErrorCondition::DB_OBJECT_NAME_IS_USED:
 129                     return STR_DB_OBJECT_NAME_IS_USED;
 130                 case css::sdb::ErrorCondition::DB_NOT_CONNECTED:
 131                     return STR_DB_NOT_CONNECTED;
 132                 case css::sdb::ErrorCondition::AB_ADDRESSBOOK_NOT_FOUND:
 133                     return STR_AB_ADDRESSBOOK_NOT_FOUND;
 134                 case css::sdb::ErrorCondition::DATA_CANNOT_SELECT_UNFILTERED:
 135                     return STR_DATA_CANNOT_SELECT_UNFILTERED;
 136             }
 137             return nullptr;
 138         }
 139
 140         OUString lcl_getResourceState(const ErrorCondition _eCondition)
 141         {
 142             switch (_eCondition)
 143             {
 144                 case css::sdb::ErrorCondition::DB_NOT_CONNECTED:
 145                     return OUString(STR_DB_NOT_CONNECTED_STATE);
 146                 case css::sdb::ErrorCondition::DATA_CANNOT_SELECT_UNFILTERED:
 147                     return OUString(STR_DATA_CANNOT_SELECT_UNFILTERED_STATE);
 148             }
 149             return OUString();
 150         }
 151     }
 152
 153     OUString SQLError_Impl::getErrorMessage( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 154     {
 155         OUString sErrorMessage( impl_getErrorMessage( _eCondition ) );
 156
 157         lcl_substitutePlaceholder( sErrorMessage, "$1$", _rParamValue1 );
 158         lcl_substitutePlaceholder( sErrorMessage, "$2$", _rParamValue2 );
 159         lcl_substitutePlaceholder( sErrorMessage, "$3$", _rParamValue3 );
 160
 161         return sErrorMessage;
 162     }
 163
 164
 165     ErrorCode SQLError_Impl::getErrorCode( const ErrorCondition _eCondition )
 166     {
 167         return 0 - ::sal::static_int_cast< ErrorCode, ErrorCondition >( _eCondition );
 168     }
 169
 170
 171     void SQLError_Impl::raiseException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 172     {
 173         raiseTypedException(
 174             _eCondition,
 175             _rxContext,
 176             ::cppu::UnoType< SQLException >::get(),
 177             _rParamValue1,
 178             _rParamValue2,
 179             _rParamValue3
 180         );
 181     }
 182
 183
 184     void SQLError_Impl::raiseException( const ErrorCondition _eCondition, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 185     {
 186         raiseTypedException(
 187             _eCondition,
 188             nullptr,
 189             ::cppu::UnoType< SQLException >::get(),
 190             _rParamValue1,
 191             _rParamValue2,
 192             _rParamValue3
 193         );
 194     }
 195
 196     void SQLError_Impl::raiseTypedException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 197         const Type& _rExceptionType, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 198     {
 199         if ( !::cppu::UnoType< SQLException >::get().isAssignableFrom( _rExceptionType ) )
 200             throw std::bad_cast();
 201
 202         // default-construct an exception of the desired type
 203         Any aException( nullptr, _rExceptionType );
 204
 205         // fill it
 206         SQLException* pException = static_cast< SQLException* >( aException.pData );
 207         *pException = impl_buildSQLException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 208
 209         // throw it
 210         ::cppu::throwException( aException );
 211     }
 212
 213     SQLException SQLError_Impl::getSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 214         const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 215     {
 216         return impl_buildSQLException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 217     }
 218
 219     SQLException SQLError_Impl::impl_buildSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 220         const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 )
 221     {
 222         return SQLException(
 223             getErrorMessage( _eCondition, _rParamValue1, _rParamValue2, _rParamValue3 ),
 224             _rxContext,
 225             impl_getSQLState( _eCondition ),
 226             getErrorCode( _eCondition ),
 227             Any()
 228         );
 229     }
 230
 231     OUString SQLError_Impl::impl_getErrorMessage( ErrorCondition _eCondition )
 232     {
 233         OUStringBuffer aMessage;
 234
 235         OUString sResMessage(Translate::get(lcl_getResourceErrorID(_eCondition), m_aResources));
 236         OSL_ENSURE( !sResMessage.isEmpty(), "SQLError_Impl::impl_getErrorMessage: illegal error condition, or invalid resource!" );
 237         aMessage.append( getMessagePrefix() ).append( " " ).append( sResMessage );
 238
 239         return aMessage.makeStringAndClear();
 240     }
 241
 242     OUString SQLError_Impl::impl_getSQLState( ErrorCondition _eCondition )
 243     {
 244         OUString sState = lcl_getResourceState(_eCondition);
 245         if (sState.isEmpty())
 246             sState = OUString::intern( RTL_CONSTASCII_USTRINGPARAM( "S1000" ) );
 247         return sState;
 248     }
 249
 250     SQLError::SQLError()
 251         :m_pImpl( new SQLError_Impl )
 252     {
 253     }
 254
 255
 256     SQLError::~SQLError()
 257     {
 258     }
 259
 260
 261     const OUString& SQLError::getMessagePrefix()
 262     {
 263         return SQLError_Impl::getMessagePrefix();
 264     }
 265
 266
 267     OUString SQLError::getErrorMessage( const ErrorCondition _eCondition ) const
 268     {
 269         return m_pImpl->getErrorMessage( _eCondition, ParamValue(), ParamValue(), ParamValue() );
 270     }
 271
 272
 273     ErrorCode SQLError::getErrorCode( const ErrorCondition _eCondition )
 274     {
 275         return SQLError_Impl::getErrorCode( _eCondition );
 276     }
 277
 278
 279     void SQLError::raiseException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext, const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 280     {
 281         m_pImpl->raiseException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 282     }
 283
 284
 285     void SQLError::raiseException( const ErrorCondition _eCondition ) const
 286     {
 287         m_pImpl->raiseException( _eCondition, ParamValue(), ParamValue(), ParamValue() );
 288     }
 289
 290
 291     void SQLError::raiseTypedException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 292         const Type& _rExceptionType ) const
 293     {
 294         m_pImpl->raiseTypedException( _eCondition, _rxContext, _rExceptionType, ParamValue(), ParamValue(), ParamValue() );
 295     }
 296
 297
 298     SQLException SQLError::getSQLException( const ErrorCondition _eCondition, const Reference< XInterface >& _rxContext,
 299         const ParamValue& _rParamValue1, const ParamValue& _rParamValue2, const ParamValue& _rParamValue3 ) const
 300     {
 301         return m_pImpl->getSQLException( _eCondition, _rxContext, _rParamValue1, _rParamValue2, _rParamValue3 );
 302     }
 303
 304
 305 } // namespace connectivity
 306
 307
 308 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */