desktop/source/app/configinit.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: configinit.cxx,v $
  10  * $Revision: 1.15 $
  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
  32 // MARKER(update_precomp.py): autogen include statement, do not remove
  33 #include "precompiled_desktop.hxx"
  34
  35 #include "configinit.hxx"
  36
  37 #include "desktop.hrc"
  38 #include "app.hxx"
  39 #include <comphelper/processfactory.hxx>
  40 #include <uno/current_context.hxx>
  41 #include <cppuhelper/implbase1.hxx>
  42 #include <rtl/ustrbuf.hxx>
  43 #include <osl/diagnose.h>
  44 #include <stdio.h>
  45 #include <map>
  46 #include <com/sun/star/lang/ServiceNotRegisteredException.hpp>
  47 #include <com/sun/star/configuration/CannotLoadConfigurationException.hpp>
  48 #include <com/sun/star/configuration/InvalidBootstrapFileException.hpp>
  49 #include <com/sun/star/configuration/backend/BackendSetupException.hpp>
  50 #include <com/sun/star/configuration/backend/CannotConnectException.hpp>
  51
  52 // ----------------------------------------------------------------------------
  53
  54 namespace uno           = ::com::sun::star::uno;
  55 namespace lang          = ::com::sun::star::lang;
  56 namespace configuration = ::com::sun::star::configuration;
  57 namespace backend       = ::com::sun::star::configuration::backend;
  58 using rtl::OUString;
  59 using uno::UNO_QUERY;
  60 using desktop::Desktop;
  61
  62 // ----------------------------------------------------------------------------
  63 static char const CONFIGURATION_PROVIDER[]  = "com.sun.star.configuration.ConfigurationProvider";
  64
  65 static char const CONFIGURATION_ERROR_HANDLER[]  = "com.sun.star.configuration.backend.InteractionHandler";
  66
  67 // must be aligned with configmgr/source/misc/configinteractionhandler
  68 static char const CONFIG_ERROR_HANDLER[] = "configuration.interaction-handler";
  69 // ----------------------------------------------------------------------------
  70
  71 // ----------------------------------------------------------------------------
  72 #define arraysize( arr ) ( sizeof (arr)/sizeof *(arr) )
  73
  74 typedef uno::Reference< lang::XMultiServiceFactory > ConfigurationProvider;
  75
  76 #define OUSTRING( constascii ) OUString( RTL_CONSTASCII_USTRINGPARAM( constascii ) )
  77
  78 #define OU2O( ustr, enc ) rtl::OUStringToOString( (ustr), RTL_TEXTENCODING_ ## enc )
  79
  80 #define k_PROVIDER OUSTRING( CONFIGURATION_PROVIDER )
  81 #define k_ERRORHANDLER OUSTRING( CONFIGURATION_ERROR_HANDLER )
  82 // ----------------------------------------------------------------------------
  83 // Get a message string securely. There is a fallback string if the resource
  84 // is not available. Adapted from Desktop::GetMsgString()
  85
  86 OUString getMsgString( USHORT nId, char const * aFallBackMsg )
  87 {
  88     ResMgr* pResMgr = Desktop::GetDesktopResManager();
  89     if ( !pResMgr || !nId )
  90         return OUString::createFromAscii(aFallBackMsg);
  91     else
  92         return OUString( String(ResId( nId, *pResMgr )));
  93 }
  94 // ----------------------------------------------------------------------------
  95 /** Creates the normal configuration provider.
  96
  97 */
  98 static
  99 ConfigurationProvider createDefaultConfigurationProvider( )
 100 {
 101     uno::Reference< lang::XMultiServiceFactory > xServiceManager = ::comphelper::getProcessServiceFactory();
 102
 103     OSL_ENSURE( xServiceManager.is(),"No ServiceManager set for CreateApplicationConfigurationProvider");
 104
 105     ConfigurationProvider xProvider;
 106
 107     if (xServiceManager.is())
 108     {
 109
 110             xProvider.set( xServiceManager->createInstance(k_PROVIDER),  UNO_QUERY);
 111     }
 112
 113     if (!xProvider.is())
 114     {
 115         OUString const sMsg = OUSTRING("Service \"") + k_PROVIDER +
 116                                 OUSTRING("\" is not available at the service manager.");
 117
 118         throw lang::ServiceNotRegisteredException(sMsg, xServiceManager);
 119     }
 120
 121     return xProvider;
 122 }
 123 // ----------------------------------------------------------------------------
 124 /// @attention this method must be called from a catch statement!
 125 static void handleGeneralException(uno::Exception& aException,
 126                                    const rtl::OUString& aMessage)
 127 {
 128     aException.Message = aMessage ;
 129     throw ;
 130 }
 131 // ----------------------------------------------------------------------------
 132
 133 uno::Reference< lang::XMultiServiceFactory > CreateApplicationConfigurationProvider( )
 134 {
 135     uno::Reference< lang::XMultiServiceFactory > xProvider;
 136
 137     try
 138     {
 139         xProvider = createDefaultConfigurationProvider( );
 140     }
 141     catch (configuration::InvalidBootstrapFileException & exception)
 142     {
 143         handleGeneralException(exception,
 144                 getMsgString( STR_CONFIG_ERR_SETTINGS_INCOMPLETE,
 145                             "The startup settings for your configuration settings are incomplete. "));
 146     }
 147      catch (backend::CannotConnectException & exception)
 148     {
 149         handleGeneralException(exception,
 150                 getMsgString( STR_CONFIG_ERR_CANNOT_CONNECT,
 151                             "A connection to your configuration settings could not be established. "));
 152     }
 153     catch (backend::BackendSetupException & exception)
 154     {
 155         handleGeneralException(exception,
 156                 getMsgString( STR_CONFIG_ERR_CANNOT_CONNECT,
 157                             "A connection to your configuration settings could not be established. "));
 158     }
 159     catch (configuration::CannotLoadConfigurationException & exception)
 160     {
 161         handleGeneralException(exception,
 162                 getMsgString( STR_CONFIG_ERR_CANNOT_CONNECT,
 163                             "A connection to your configuration settings could not be established. "));
 164     }
 165     catch (uno::Exception & exception)
 166     {
 167         handleGeneralException(exception,
 168                 getMsgString( STR_CONFIG_ERR_ACCESS_GENERAL,
 169                             "A general error occurred while accessing your configuration settings."));
 170     }
 171
 172
 173     return xProvider ;
 174 }
 175 // ----------------------------------------------------------------------------
 176
 177
 178
 179
 180 // ----------------------------------------------------------------------------
 181 // ----------------------------------------------------------------------------
 182 // ConfigurationErrorHandler
 183 // ----------------------------------------------------------------------------
 184
 185 namespace
 186 {
 187     typedef uno::Reference< uno::XCurrentContext > CurrentContext;
 188     class SimpleCurrentContext : public cppu::WeakImplHelper1< uno::XCurrentContext >
 189     {
 190         CurrentContext m_xChainedContext;
 191     public:
 192         explicit
 193         SimpleCurrentContext(const CurrentContext & xChainedContext)
 194         : m_xChainedContext(xChainedContext)
 195         {}
 196
 197         void install()      { uno::setCurrentContext(this); }
 198         void deinstall()    { uno::setCurrentContext(m_xChainedContext); }
 199
 200         uno::Any getChainedValueByName( OUString const & aName) const
 201         {
 202             return m_xChainedContext.is()
 203                             ? m_xChainedContext->getValueByName(aName)
 204                             : uno::Any();
 205         }
 206
 207         // XCurrentContext
 208         virtual uno::Any SAL_CALL
 209             getValueByName( OUString const & aName)
 210                 throw (uno::RuntimeException);
 211     };
 212
 213     uno::Any SAL_CALL
 214         SimpleCurrentContext::getValueByName( OUString const & aName)
 215             throw (uno::RuntimeException)
 216     {
 217         return getChainedValueByName(aName);
 218     }
 219
 220 }
 221
 222 // ----------------------------------------------------------------------------
 223 class ConfigurationErrorHandler::Context : public SimpleCurrentContext
 224 {
 225 public:
 226     Context()
 227     : SimpleCurrentContext( uno::getCurrentContext() )
 228     {
 229     }
 230
 231     ~Context()
 232     {
 233     }
 234
 235     // XCurrentContext
 236     virtual uno::Any SAL_CALL
 237         getValueByName( OUString const & aName)
 238             throw (uno::RuntimeException);
 239
 240 private:
 241     InteractionHandler  m_xHandler;
 242 };
 243
 244 //------------------------------------------------------------------------------
 245 uno::Any SAL_CALL ConfigurationErrorHandler::Context::getValueByName( OUString const & aName)
 246         throw (uno::RuntimeException)
 247 {
 248     if ( aName.equalsAscii( CONFIG_ERROR_HANDLER ) )
 249     {
 250         if ( !m_xHandler.is() )
 251             m_xHandler = ConfigurationErrorHandler::getDefaultInteractionHandler();
 252         return uno::Any( m_xHandler );
 253     }
 254     return SimpleCurrentContext::getValueByName( aName );
 255 }
 256
 257 //------------------------------------------------------------------------------
 258 ConfigurationErrorHandler::~ConfigurationErrorHandler()
 259 {
 260     deactivate();
 261 }
 262
 263 //------------------------------------------------------------------------------
 264 /// installs the handler into the current context
 265 void ConfigurationErrorHandler::activate()
 266 {
 267     if (!m_pContext)
 268     {
 269         m_pContext = new Context;
 270         m_pContext->acquire();
 271     }
 272     m_pContext->install();
 273 }
 274
 275 //------------------------------------------------------------------------------
 276 /// deinstalls the handler from the current context, restoring the previous context
 277 void ConfigurationErrorHandler::deactivate()
 278 {
 279     if (m_pContext)
 280     {
 281         m_pContext->deinstall();
 282         m_pContext->release();
 283         m_pContext = 0;
 284     }
 285 }
 286 //------------------------------------------------------------------------------
 287
 288 ConfigurationErrorHandler::InteractionHandler ConfigurationErrorHandler::getDefaultInteractionHandler()
 289 {
 290     uno::Reference< lang::XMultiServiceFactory > xServiceManager = ::comphelper::getProcessServiceFactory();
 291
 292     OSL_ENSURE( xServiceManager.is(),"No ServiceManager set for ConfigurationErrorHandler");
 293
 294     InteractionHandler xHandler;
 295
 296     if (xServiceManager.is())
 297     {
 298         xHandler.set( xServiceManager->createInstance(k_ERRORHANDLER), UNO_QUERY );
 299     }
 300
 301     return xHandler;
 302 }
 303 //------------------------------------------------------------------------------
 304
 305
 306