framework/source/uifactory/factoryconfiguration.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 #include <uifactory/factoryconfiguration.hxx>
  21 #include <services.h>
  22
  23 #include <helper/mischelper.hxx>
  24
  25 #include <com/sun/star/beans/PropertyValue.hpp>
  26 #include <com/sun/star/beans/XPropertySet.hpp>
  27 #include <com/sun/star/configuration/theDefaultProvider.hpp>
  28 #include <com/sun/star/container/XNameAccess.hpp>
  29 #include <com/sun/star/container/XNameContainer.hpp>
  30 #include <com/sun/star/container/XContainer.hpp>
  31
  32 #include <rtl/ustrbuf.hxx>
  33 #include <comphelper/propertysequence.hxx>
  34 #include <cppuhelper/weak.hxx>
  35
  36 //  Defines
  37
  38 using namespace com::sun::star;
  39 using namespace com::sun::star::uno;
  40 using namespace com::sun::star::lang;
  41 using namespace com::sun::star::beans;
  42 using namespace com::sun::star::container;
  43
  44 //  Namespace
  45
  46 namespace framework
  47 {
  48 static OUString getHashKeyFromStrings( const OUString& aCommandURL, const OUString& aModuleName )
  49 {
  50     return aCommandURL + "-" + aModuleName;
  51 }
  52
  53 //  XInterface, XTypeProvider
  54
  55 ConfigurationAccess_ControllerFactory::ConfigurationAccess_ControllerFactory( const Reference< XComponentContext >& rxContext, const OUString& _sRoot ) :
  56     m_aPropCommand( "Command" ),
  57     m_aPropModule( "Module" ),
  58     m_aPropController( "Controller" ),
  59     m_aPropValue( "Value" ),
  60     m_sRoot(_sRoot),
  61     m_bConfigAccessInitialized( false )
  62 {
  63     m_xConfigProvider = configuration::theDefaultProvider::get( rxContext );
  64 }
  65
  66 ConfigurationAccess_ControllerFactory::~ConfigurationAccess_ControllerFactory()
  67 {
  68     osl::MutexGuard g(m_mutex);
  69
  70     Reference< XContainer > xContainer( m_xConfigAccess, UNO_QUERY );
  71     if ( xContainer.is() )
  72         xContainer->removeContainerListener(m_xConfigAccessListener);
  73 }
  74
  75 OUString ConfigurationAccess_ControllerFactory::getServiceFromCommandModule( const OUString& rCommandURL, const OUString& rModule ) const
  76 {
  77     osl::MutexGuard g(m_mutex);
  78     MenuControllerMap::const_iterator pIter = m_aMenuControllerMap.find( getHashKeyFromStrings( rCommandURL, rModule ));
  79
  80     if ( pIter != m_aMenuControllerMap.end() )
  81         return pIter->second.m_aImplementationName;
  82     else if ( !rModule.isEmpty() )
  83     {
  84         // Try to detect if we have a generic popup menu controller
  85         pIter = m_aMenuControllerMap.find( getHashKeyFromStrings( rCommandURL, OUString() ));
  86
  87         if ( pIter != m_aMenuControllerMap.end() )
  88             return pIter->second.m_aImplementationName;
  89     }
  90
  91     return OUString();
  92 }
  93 OUString ConfigurationAccess_ControllerFactory::getValueFromCommandModule( const OUString& rCommandURL, const OUString& rModule ) const
  94 {
  95     osl::MutexGuard g(m_mutex);
  96
  97     MenuControllerMap::const_iterator pIter = m_aMenuControllerMap.find( getHashKeyFromStrings( rCommandURL, rModule ));
  98
  99     if ( pIter != m_aMenuControllerMap.end() )
 100         return pIter->second.m_aValue;
 101     else if ( !rModule.isEmpty() )
 102     {
 103         // Try to detect if we have a generic popup menu controller
 104         pIter = m_aMenuControllerMap.find( getHashKeyFromStrings( rCommandURL, OUString() ));
 105
 106         if ( pIter != m_aMenuControllerMap.end() )
 107             return pIter->second.m_aValue;
 108     }
 109
 110     return OUString();
 111 }
 112
 113 void ConfigurationAccess_ControllerFactory::addServiceToCommandModule(
 114     const OUString& rCommandURL,
 115     const OUString& rModule,
 116     const OUString& rServiceSpecifier )
 117 {
 118     osl::MutexGuard g(m_mutex);
 119
 120     OUString aHashKey = getHashKeyFromStrings( rCommandURL, rModule );
 121     m_aMenuControllerMap.emplace( aHashKey,ControllerInfo(rServiceSpecifier,OUString()) );
 122 }
 123
 124 void ConfigurationAccess_ControllerFactory::removeServiceFromCommandModule(
 125     const OUString& rCommandURL,
 126     const OUString& rModule )
 127 {
 128     osl::MutexGuard g(m_mutex);
 129
 130     OUString aHashKey = getHashKeyFromStrings( rCommandURL, rModule );
 131     m_aMenuControllerMap.erase( aHashKey );
 132 }
 133
 134 // container.XContainerListener
 135 void SAL_CALL ConfigurationAccess_ControllerFactory::elementInserted( const ContainerEvent& aEvent )
 136 {
 137     OUString   aCommand;
 138     OUString   aModule;
 139     OUString   aService;
 140     OUString   aValue;
 141
 142     osl::MutexGuard g(m_mutex);
 143
 144     if ( impl_getElementProps( aEvent.Element, aCommand, aModule, aService, aValue ))
 145     {
 146         // Create hash key from command and module as they are together a primary key to
 147         // the UNO service that implements the popup menu controller.
 148         OUString aHashKey( getHashKeyFromStrings( aCommand, aModule ));
 149         ControllerInfo& rControllerInfo = m_aMenuControllerMap[ aHashKey ];
 150         rControllerInfo.m_aImplementationName = aService;
 151         rControllerInfo.m_aValue = aValue;
 152     }
 153 }
 154
 155 void SAL_CALL ConfigurationAccess_ControllerFactory::elementRemoved ( const ContainerEvent& aEvent )
 156 {
 157     OUString   aCommand;
 158     OUString   aModule;
 159     OUString   aService;
 160     OUString   aValue;
 161
 162     osl::MutexGuard g(m_mutex);
 163
 164     if ( impl_getElementProps( aEvent.Element, aCommand, aModule, aService, aValue ))
 165     {
 166         // Create hash key from command and module as they are together a primary key to
 167         // the UNO service that implements the popup menu controller.
 168         OUString aHashKey( getHashKeyFromStrings( aCommand, aModule ));
 169         m_aMenuControllerMap.erase( aHashKey );
 170     }
 171 }
 172
 173 void SAL_CALL ConfigurationAccess_ControllerFactory::elementReplaced( const ContainerEvent& aEvent )
 174 {
 175     elementInserted(aEvent);
 176 }
 177
 178 // lang.XEventListener
 179 void SAL_CALL ConfigurationAccess_ControllerFactory::disposing( const EventObject& )
 180 {
 181     // remove our reference to the config access
 182     osl::MutexGuard g(m_mutex);
 183     m_xConfigAccess.clear();
 184 }
 185
 186 void ConfigurationAccess_ControllerFactory::readConfigurationData()
 187 {
 188     // SAFE
 189     osl::ClearableMutexGuard aLock( m_mutex );
 190
 191     if ( !m_bConfigAccessInitialized )
 192     {
 193         uno::Sequence<uno::Any> aArgs(comphelper::InitAnyPropertySequence(
 194         {
 195             {"nodepath", uno::Any(m_sRoot)}
 196         }));
 197         try
 198         {
 199             m_xConfigAccess.set( m_xConfigProvider->createInstanceWithArguments(SERVICENAME_CFGREADACCESS,aArgs ), UNO_QUERY );
 200         }
 201         catch ( const WrappedTargetException& )
 202         {
 203         }
 204
 205         m_bConfigAccessInitialized = true;
 206     }
 207
 208     if ( m_xConfigAccess.is() )
 209     {
 210         // Read and update configuration data
 211         updateConfigurationData();
 212
 213         uno::Reference< container::XContainer > xContainer( m_xConfigAccess, uno::UNO_QUERY );
 214         // UNSAFE
 215         aLock.clear();
 216
 217         if ( xContainer.is() )
 218         {
 219             m_xConfigAccessListener = new WeakContainerListener(this);
 220             xContainer->addContainerListener(m_xConfigAccessListener);
 221         }
 222     }
 223 }
 224
 225 void ConfigurationAccess_ControllerFactory::updateConfigurationData()
 226 {
 227     osl::MutexGuard g(m_mutex);
 228     if ( m_xConfigAccess.is() )
 229     {
 230         Sequence< OUString >   aPopupMenuControllers = m_xConfigAccess->getElementNames();
 231
 232         OUString aCommand;
 233         OUString aModule;
 234         OUString aService;
 235         OUString aHashKey;
 236         OUString aValue;
 237
 238         m_aMenuControllerMap.clear();
 239         for ( sal_Int32 i = 0; i < aPopupMenuControllers.getLength(); i++ )
 240         {
 241             try
 242             {
 243                 if ( impl_getElementProps( m_xConfigAccess->getByName( aPopupMenuControllers[i] ), aCommand, aModule, aService,aValue ))
 244                 {
 245                     // Create hash key from command and module as they are together a primary key to
 246                     // the UNO service that implements the popup menu controller.
 247                     aHashKey = getHashKeyFromStrings( aCommand, aModule );
 248                     m_aMenuControllerMap.emplace( aHashKey, ControllerInfo(aService,aValue) );
 249                 }
 250             }
 251             catch ( const NoSuchElementException& )
 252             {
 253             }
 254             catch ( const WrappedTargetException& )
 255             {
 256             }
 257         }
 258     }
 259 }
 260
 261 bool ConfigurationAccess_ControllerFactory::impl_getElementProps( const Any& aElement, OUString& aCommand, OUString& aModule, OUString& aServiceSpecifier,OUString& aValue  ) const
 262 {
 263     Reference< XPropertySet > xPropertySet;
 264     aElement >>= xPropertySet;
 265
 266     if ( xPropertySet.is() )
 267     {
 268         try
 269         {
 270             xPropertySet->getPropertyValue( m_aPropCommand ) >>= aCommand;
 271             xPropertySet->getPropertyValue( m_aPropModule ) >>= aModule;
 272             xPropertySet->getPropertyValue( m_aPropController ) >>= aServiceSpecifier;
 273             xPropertySet->getPropertyValue( m_aPropValue ) >>= aValue;
 274         }
 275         catch ( const css::beans::UnknownPropertyException& )
 276         {
 277             return false;
 278         }
 279         catch ( const css::lang::WrappedTargetException& )
 280         {
 281             return false;
 282         }
 283     }
 284
 285     return true;
 286 }
 287 } // namespace framework
 288
 289 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */