framework/source/uifactory/factoryconfiguration.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: ConfigurationAccess_ControllerFactory.cxx,v $
  10  * $Revision: 1.9 $
  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_framework.hxx"
  33
  34 //_________________________________________________________________________________________________________________
  35 //      my own includes
  36 //_________________________________________________________________________________________________________________
  37 #include "uifactory/factoryconfiguration.hxx"
  38 #include <threadhelp/resetableguard.hxx>
  39 #include "services.h"
  40
  41 //_________________________________________________________________________________________________________________
  42 //      interface includes
  43 //_________________________________________________________________________________________________________________
  44 #include <com/sun/star/beans/PropertyValue.hpp>
  45 #include <com/sun/star/beans/XPropertySet.hpp>
  46 #include <com/sun/star/container/XNameAccess.hpp>
  47 #include <com/sun/star/container/XNameContainer.hpp>
  48 #include <com/sun/star/container/XContainer.hpp>
  49
  50 //_________________________________________________________________________________________________________________
  51 //      includes of other projects
  52 //_________________________________________________________________________________________________________________
  53 #include <rtl/ustrbuf.hxx>
  54 #include <cppuhelper/weak.hxx>
  55 #include <rtl/logfile.hxx>
  56
  57 //_________________________________________________________________________________________________________________
  58 //      Defines
  59 //_________________________________________________________________________________________________________________
  60 //
  61 using namespace com::sun::star;
  62 using namespace com::sun::star::uno;
  63 using namespace com::sun::star::lang;
  64 using namespace com::sun::star::beans;
  65 using namespace com::sun::star::container;
  66 using namespace ::com::sun::star::frame;
  67
  68 //_________________________________________________________________________________________________________________
  69 //      Namespace
  70 //_________________________________________________________________________________________________________________
  71 //
  72
  73 namespace framework
  74 {
  75 rtl::OUString getHashKeyFromStrings( const rtl::OUString& aCommandURL, const rtl::OUString& aModuleName )
  76 {
  77     rtl::OUStringBuffer aKey( aCommandURL );
  78     aKey.appendAscii( "-" );
  79     aKey.append( aModuleName );
  80     return aKey.makeStringAndClear();
  81 }
  82
  83 //*****************************************************************************************************************
  84 //      XInterface, XTypeProvider
  85 //*****************************************************************************************************************
  86 ConfigurationAccess_ControllerFactory::ConfigurationAccess_ControllerFactory( Reference< XMultiServiceFactory >& rServiceManager,const ::rtl::OUString& _sRoot,bool _bAskValue ) :
  87     ThreadHelpBase(),
  88     m_aPropCommand( RTL_CONSTASCII_USTRINGPARAM( "Command" )),
  89     m_aPropModule( RTL_CONSTASCII_USTRINGPARAM( "Module" )),
  90     m_aPropController( RTL_CONSTASCII_USTRINGPARAM( "Controller" )),
  91     m_aPropValue( RTL_CONSTASCII_USTRINGPARAM( "Value" )),
  92     m_sRoot(_sRoot),
  93     m_xServiceManager( rServiceManager ),
  94     m_bConfigAccessInitialized( sal_False ),
  95     m_bAskValue(_bAskValue)
  96 {
  97     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::ConfigurationAccess_ControllerFactory" );
  98     m_xConfigProvider = Reference< XMultiServiceFactory >( rServiceManager->createInstance( SERVICENAME_CFGPROVIDER),UNO_QUERY );
  99 }
 100
 101 ConfigurationAccess_ControllerFactory::~ConfigurationAccess_ControllerFactory()
 102 {
 103     // SAFE
 104     ResetableGuard aLock( m_aLock );
 105
 106     Reference< XContainer > xContainer( m_xConfigAccess, UNO_QUERY );
 107     if ( xContainer.is() )
 108         xContainer->removeContainerListener( this );
 109 }
 110
 111 rtl::OUString ConfigurationAccess_ControllerFactory::getServiceFromCommandModule( const rtl::OUString& rCommandURL, const rtl::OUString& rModule ) const
 112 {
 113     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::getServiceFromCommandModule" );
 114     // SAFE
 115     ResetableGuard aLock( m_aLock );
 116     MenuControllerMap::const_iterator pIter = m_aMenuControllerMap.find( getHashKeyFromStrings( rCommandURL, rModule ));
 117
 118     if ( pIter != m_aMenuControllerMap.end() )
 119         return pIter->second.m_aImplementationName;
 120     else if ( rModule.getLength() )
 121     {
 122         // Try to detect if we have a generic popup menu controller
 123         pIter = m_aMenuControllerMap.find( getHashKeyFromStrings( rCommandURL, rtl::OUString() ));
 124
 125         if ( pIter != m_aMenuControllerMap.end() )
 126             return pIter->second.m_aImplementationName;
 127     }
 128
 129     return rtl::OUString();
 130 }
 131 rtl::OUString ConfigurationAccess_ControllerFactory::getValueFromCommandModule( const rtl::OUString& rCommandURL, const rtl::OUString& rModule ) const
 132 {
 133     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::getValueFromCommandModule" );
 134     // SAFE
 135     ResetableGuard aLock( m_aLock );
 136
 137     MenuControllerMap::const_iterator pIter = m_aMenuControllerMap.find( getHashKeyFromStrings( rCommandURL, rModule ));
 138
 139     if ( pIter != m_aMenuControllerMap.end() )
 140         return pIter->second.m_aValue;
 141     else if ( rModule.getLength() )
 142     {
 143         // Try to detect if we have a generic popup menu controller
 144         pIter = m_aMenuControllerMap.find( getHashKeyFromStrings( rCommandURL, rtl::OUString() ));
 145
 146         if ( pIter != m_aMenuControllerMap.end() )
 147             return pIter->second.m_aValue;
 148     }
 149
 150     return rtl::OUString();
 151 }
 152
 153
 154 void ConfigurationAccess_ControllerFactory::addServiceToCommandModule(
 155     const rtl::OUString& rCommandURL,
 156     const rtl::OUString& rModule,
 157     const rtl::OUString& rServiceSpecifier )
 158 {
 159     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::addServiceToCommandModule" );
 160     // SAFE
 161     ResetableGuard aLock( m_aLock );
 162
 163     rtl::OUString aHashKey = getHashKeyFromStrings( rCommandURL, rModule );
 164     m_aMenuControllerMap.insert( MenuControllerMap::value_type( aHashKey,ControllerInfo(rServiceSpecifier,::rtl::OUString()) ));
 165 }
 166
 167 void ConfigurationAccess_ControllerFactory::removeServiceFromCommandModule(
 168     const rtl::OUString& rCommandURL,
 169     const rtl::OUString& rModule )
 170 {
 171     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::removeServiceFromCommandModule" );
 172     // SAFE
 173     ResetableGuard aLock( m_aLock );
 174
 175     rtl::OUString aHashKey = getHashKeyFromStrings( rCommandURL, rModule );
 176     m_aMenuControllerMap.erase( aHashKey );
 177 }
 178
 179 // container.XContainerListener
 180 void SAL_CALL ConfigurationAccess_ControllerFactory::elementInserted( const ContainerEvent& aEvent ) throw(RuntimeException)
 181 {
 182     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::elementInserted" );
 183     rtl::OUString   aCommand;
 184     rtl::OUString   aModule;
 185     rtl::OUString   aService;
 186     rtl::OUString   aValue;
 187
 188     // SAFE
 189     ResetableGuard aLock( m_aLock );
 190
 191     if ( impl_getElementProps( aEvent.Element, aCommand, aModule, aService, aValue ))
 192     {
 193         // Create hash key from command and module as they are together a primary key to
 194         // the UNO service that implements the popup menu controller.
 195         rtl::OUString aHashKey( getHashKeyFromStrings( aCommand, aModule ));
 196         ControllerInfo& rControllerInfo = m_aMenuControllerMap[ aHashKey ];
 197         rControllerInfo.m_aImplementationName = aService;
 198         rControllerInfo.m_aValue = aValue;
 199     }
 200 }
 201
 202 void SAL_CALL ConfigurationAccess_ControllerFactory::elementRemoved ( const ContainerEvent& aEvent ) throw(RuntimeException)
 203 {
 204     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::elementRemoved" );
 205     rtl::OUString   aCommand;
 206     rtl::OUString   aModule;
 207     rtl::OUString   aService;
 208     rtl::OUString   aValue;
 209
 210     // SAFE
 211     ResetableGuard aLock( m_aLock );
 212
 213     if ( impl_getElementProps( aEvent.Element, aCommand, aModule, aService, aValue ))
 214     {
 215         // Create hash key from command and module as they are together a primary key to
 216         // the UNO service that implements the popup menu controller.
 217         rtl::OUString aHashKey( getHashKeyFromStrings( aCommand, aModule ));
 218         m_aMenuControllerMap.erase( aHashKey );
 219     }
 220 }
 221
 222 void SAL_CALL ConfigurationAccess_ControllerFactory::elementReplaced( const ContainerEvent& aEvent ) throw(RuntimeException)
 223 {
 224     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::elementReplaced" );
 225     elementInserted(aEvent);
 226 }
 227
 228 // lang.XEventListener
 229 void SAL_CALL ConfigurationAccess_ControllerFactory::disposing( const EventObject& ) throw(RuntimeException)
 230 {
 231     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::disposing" );
 232     // SAFE
 233     // remove our reference to the config access
 234     ResetableGuard aLock( m_aLock );
 235     m_xConfigAccess.clear();
 236 }
 237
 238 void ConfigurationAccess_ControllerFactory::readConfigurationData()
 239 {
 240     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::readConfigurationData" );
 241     // SAFE
 242     ResetableGuard aLock( m_aLock );
 243
 244     if ( !m_bConfigAccessInitialized )
 245     {
 246         Sequence< Any > aArgs( 1 );
 247         PropertyValue   aPropValue;
 248
 249         aPropValue.Name  = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "nodepath" ));
 250         aPropValue.Value <<= m_sRoot;
 251         aArgs[0] <<= aPropValue;
 252
 253         try
 254         {
 255             m_xConfigAccess = Reference< XNameAccess >( m_xConfigProvider->createInstanceWithArguments(SERVICENAME_CFGREADACCESS,aArgs ), UNO_QUERY );
 256         }
 257         catch ( WrappedTargetException& )
 258         {
 259         }
 260
 261         m_bConfigAccessInitialized = sal_True;
 262     }
 263
 264     if ( m_xConfigAccess.is() )
 265     {
 266         // Read and update configuration data
 267         updateConfigurationData();
 268
 269         uno::Reference< container::XContainer > xContainer( m_xConfigAccess, uno::UNO_QUERY );
 270         // UNSAFE
 271         aLock.unlock();
 272
 273         if ( xContainer.is() )
 274             xContainer->addContainerListener( this );
 275     }
 276 }
 277
 278 void ConfigurationAccess_ControllerFactory::updateConfigurationData()
 279 {
 280     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::updateConfigurationData" );
 281     // SAFE
 282     ResetableGuard aLock( m_aLock );
 283     if ( m_xConfigAccess.is() )
 284     {
 285         Sequence< rtl::OUString >   aPopupMenuControllers = m_xConfigAccess->getElementNames();
 286
 287         rtl::OUString aCommand;
 288         rtl::OUString aModule;
 289         rtl::OUString aService;
 290         rtl::OUString aHashKey;
 291         rtl::OUString aValue;
 292
 293         m_aMenuControllerMap.clear();
 294         for ( sal_Int32 i = 0; i < aPopupMenuControllers.getLength(); i++ )
 295         {
 296             try
 297             {
 298                 if ( impl_getElementProps( m_xConfigAccess->getByName( aPopupMenuControllers[i] ), aCommand, aModule, aService,aValue ))
 299                 {
 300                     // Create hash key from command and module as they are together a primary key to
 301                     // the UNO service that implements the popup menu controller.
 302                     aHashKey = getHashKeyFromStrings( aCommand, aModule );
 303                     m_aMenuControllerMap.insert( MenuControllerMap::value_type( aHashKey, ControllerInfo(aService,aValue) ));
 304                 }
 305             }
 306             catch ( NoSuchElementException& )
 307             {
 308             }
 309             catch ( WrappedTargetException& )
 310             {
 311             }
 312         }
 313     }
 314 }
 315
 316 sal_Bool ConfigurationAccess_ControllerFactory::impl_getElementProps( const Any& aElement, rtl::OUString& aCommand, rtl::OUString& aModule, rtl::OUString& aServiceSpecifier,rtl::OUString& aValue  ) const
 317 {
 318     RTL_LOGFILE_CONTEXT_AUTHOR( aLogger, "framework", "Ocke.Janssen@sun.com", "ConfigurationAccess_ControllerFactory::impl_getElementProps" );
 319     Reference< XPropertySet > xPropertySet;
 320     aElement >>= xPropertySet;
 321
 322     if ( xPropertySet.is() )
 323     {
 324         try
 325         {
 326             xPropertySet->getPropertyValue( m_aPropCommand ) >>= aCommand;
 327             xPropertySet->getPropertyValue( m_aPropModule ) >>= aModule;
 328             xPropertySet->getPropertyValue( m_aPropController ) >>= aServiceSpecifier;
 329             if ( m_bAskValue )
 330                 xPropertySet->getPropertyValue( m_aPropValue ) >>= aValue;
 331         }
 332         catch ( com::sun::star::beans::UnknownPropertyException& )
 333         {
 334             return sal_False;
 335         }
 336         catch ( com::sun::star::lang::WrappedTargetException& )
 337         {
 338             return sal_False;
 339         }
 340     }
 341
 342     return sal_True;
 343 }
 344 } // namespace framework