framework/source/uifactory/toolbarcontrollerfactory.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: toolbarcontrollerfactory.cxx,v $
  10  * $Revision: 1.8 $
  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/toolbarcontrollerfactory.hxx"
  38 #include "uifactory/factoryconfiguration.hxx"
  39 #include <threadhelp/resetableguard.hxx>
  40 #include "services.h"
  41
  42 //_________________________________________________________________________________________________________________
  43 //      interface includes
  44 //_________________________________________________________________________________________________________________
  45 #include <com/sun/star/beans/PropertyValue.hpp>
  46 #include <com/sun/star/beans/XPropertySet.hpp>
  47 #include <com/sun/star/container/XNameAccess.hpp>
  48 #include <com/sun/star/container/XNameContainer.hpp>
  49 #include <com/sun/star/container/XContainer.hpp>
  50
  51 //_________________________________________________________________________________________________________________
  52 //      includes of other projects
  53 //_________________________________________________________________________________________________________________
  54 #include <rtl/ustrbuf.hxx>
  55 #include <cppuhelper/weak.hxx>
  56
  57 //_________________________________________________________________________________________________________________
  58 //      Defines
  59 //_________________________________________________________________________________________________________________
  60 //
  61
  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
  76 //*****************************************************************************************************************
  77 //      XInterface, XTypeProvider, XServiceInfo
  78 //*****************************************************************************************************************
  79 DEFINE_XSERVICEINFO_ONEINSTANCESERVICE  (   ToolbarControllerFactory                                    ,
  80                                             ::cppu::OWeakObject                                                     ,
  81                                             SERVICENAME_TOOLBARCONTROLLERFACTORY                ,
  82                                             IMPLEMENTATIONNAME_TOOLBARCONTROLLERFACTORY
  83                                         )
  84
  85 DEFINE_INIT_SERVICE                     (   ToolbarControllerFactory, {} )
  86
  87 ToolbarControllerFactory::ToolbarControllerFactory( const Reference< XMultiServiceFactory >& xServiceManager ) :
  88     ThreadHelpBase(),
  89     m_bConfigRead( sal_False ),
  90     m_xServiceManager( xServiceManager )
  91 {
  92     m_pConfigAccess = new ConfigurationAccess_ControllerFactory( m_xServiceManager,rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "/org.openoffice.Office.UI.Controller/Registered/ToolBar" )) );
  93     m_pConfigAccess->acquire();
  94 }
  95
  96 ToolbarControllerFactory::ToolbarControllerFactory( const Reference< XMultiServiceFactory >& xServiceManager,bool ) :
  97     ThreadHelpBase(),
  98     m_bConfigRead( sal_False ),
  99     m_xServiceManager( xServiceManager )
 100 {
 101     m_pConfigAccess = NULL;
 102 }
 103
 104 ToolbarControllerFactory::~ToolbarControllerFactory()
 105 {
 106     ResetableGuard aLock( m_aLock );
 107
 108     // reduce reference count
 109     m_pConfigAccess->release();
 110 }
 111
 112 // XMultiComponentFactory
 113 Reference< XInterface > SAL_CALL ToolbarControllerFactory::createInstanceWithContext(
 114     const ::rtl::OUString& aServiceSpecifier,
 115     const Reference< XComponentContext >& )
 116 throw (Exception, RuntimeException)
 117 {
 118     // SAFE
 119     ResetableGuard aLock( m_aLock );
 120
 121     if ( !m_bConfigRead )
 122     {
 123         m_bConfigRead = sal_True;
 124         m_pConfigAccess->readConfigurationData();
 125     }
 126
 127     rtl::OUString aServiceName = m_pConfigAccess->getServiceFromCommandModule( aServiceSpecifier, rtl::OUString() );
 128     if ( aServiceName.getLength() > 0 )
 129         return m_xServiceManager->createInstance( aServiceName );
 130     else
 131         return Reference< XInterface >();
 132     // SAFE
 133 }
 134
 135 Reference< XInterface > SAL_CALL ToolbarControllerFactory::createInstanceWithArgumentsAndContext(
 136     const ::rtl::OUString&                  ServiceSpecifier,
 137     const Sequence< Any >&                  Arguments,
 138     const Reference< XComponentContext >& )
 139 throw (Exception, RuntimeException)
 140 {
 141     const rtl::OUString aPropModuleName( RTL_CONSTASCII_USTRINGPARAM( "ModuleName" ));
 142     const rtl::OUString aPropValueName( RTL_CONSTASCII_USTRINGPARAM( "Value" ));
 143
 144     rtl::OUString   aPropName;
 145     PropertyValue   aPropValue;
 146
 147     // Retrieve the optional module name form the Arguments sequence. It is used as a part of
 148     // the hash map key to support different controller implementation for the same URL but different
 149     // module!!
 150     for ( int i = 0; i < Arguments.getLength(); i++ )
 151     {
 152         if (( Arguments[i] >>= aPropValue ) && ( aPropValue.Name.equals( aPropModuleName )))
 153         {
 154             aPropValue.Value >>= aPropName;
 155             break;
 156         }
 157     }
 158
 159     Sequence< Any > aNewArgs( Arguments );
 160
 161     sal_Int32 nAppendIndex = aNewArgs.getLength();
 162     bool bHasValue = m_pConfigAccess->hasValue();
 163     aNewArgs.realloc( aNewArgs.getLength() + (bHasValue ? 2 : 1) );
 164
 165     // Append the command URL to the Arguments sequence so that one controller can be
 166     // used for more than one command URL.
 167     aPropValue.Name     = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "CommandURL" ));
 168     aPropValue.Value  <<= ServiceSpecifier;
 169     aNewArgs[nAppendIndex] <<= aPropValue;
 170
 171     if ( bHasValue )
 172     {
 173         // Append the optional value argument. It's an empty string if no additional info
 174         // is provided to the controller.
 175         rtl::OUString aValue = m_pConfigAccess->getValueFromCommandModule( ServiceSpecifier, aPropName );
 176         aPropValue.Name = aPropValueName;
 177         aPropValue.Value <<= aValue;
 178         aNewArgs[nAppendIndex+1] <<= aPropValue;
 179     }
 180
 181     {
 182         // SAFE
 183         ResetableGuard aLock( m_aLock );
 184
 185         if ( !m_bConfigRead )
 186         {
 187             m_bConfigRead = sal_True;
 188             m_pConfigAccess->readConfigurationData();
 189         }
 190
 191         rtl::OUString aServiceName = m_pConfigAccess->getServiceFromCommandModule( ServiceSpecifier, aPropName );
 192         Reference< XMultiServiceFactory > xServiceManager( m_xServiceManager );
 193
 194         aLock.unlock();
 195         // SAFE
 196
 197
 198         if ( aServiceName.getLength() > 0 )
 199             return xServiceManager->createInstanceWithArguments( aServiceName, aNewArgs );
 200         else
 201             return Reference< XInterface >();
 202     }
 203 }
 204
 205 Sequence< ::rtl::OUString > SAL_CALL ToolbarControllerFactory::getAvailableServiceNames()
 206 throw (RuntimeException)
 207 {
 208     return Sequence< ::rtl::OUString >();
 209 }
 210
 211 // XUIControllerRegistration
 212 sal_Bool SAL_CALL ToolbarControllerFactory::hasController(
 213     const ::rtl::OUString& aCommandURL,
 214     const rtl::OUString& aModuleName )
 215 throw (::com::sun::star::uno::RuntimeException)
 216 {
 217     ResetableGuard aLock( m_aLock );
 218
 219     if ( !m_bConfigRead )
 220     {
 221         m_bConfigRead = sal_True;
 222         m_pConfigAccess->readConfigurationData();
 223     }
 224
 225     return ( m_pConfigAccess->getServiceFromCommandModule( aCommandURL, aModuleName ).getLength() > 0 );
 226 }
 227
 228 void SAL_CALL ToolbarControllerFactory::registerController(
 229     const ::rtl::OUString& aCommandURL,
 230     const ::rtl::OUString& aModuleName,
 231     const ::rtl::OUString& aControllerImplementationName )
 232 throw (RuntimeException)
 233 {
 234     // SAFE
 235     ResetableGuard aLock( m_aLock );
 236
 237     if ( !m_bConfigRead )
 238     {
 239         m_bConfigRead = sal_True;
 240         m_pConfigAccess->readConfigurationData();
 241     }
 242
 243     m_pConfigAccess->addServiceToCommandModule( aCommandURL, aModuleName, aControllerImplementationName );
 244     // SAFE
 245 }
 246
 247 void SAL_CALL ToolbarControllerFactory::deregisterController(
 248     const ::rtl::OUString& aCommandURL,
 249     const rtl::OUString& aModuleName )
 250 throw (RuntimeException)
 251 {
 252     // SAFE
 253     ResetableGuard aLock( m_aLock );
 254
 255     if ( !m_bConfigRead )
 256     {
 257         m_bConfigRead = sal_True;
 258         m_pConfigAccess->readConfigurationData();
 259     }
 260
 261     m_pConfigAccess->removeServiceFromCommandModule( aCommandURL, aModuleName );
 262     // SAFE
 263 }
 264
 265 } // namespace framework