framework/source/uifactory/addonstoolbarfactory.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 <uielement/addonstoolbarwrapper.hxx>
  21
  22 #include <com/sun/star/util/XURLTransformer.hpp>
  23 #include <com/sun/star/frame/ModuleManager.hpp>
  24 #include <com/sun/star/frame/XModuleManager2.hpp>
  25 #include <com/sun/star/frame/XFrame.hpp>
  26 #include <com/sun/star/lang/XInitialization.hpp>
  27 #include <com/sun/star/lang/XServiceInfo.hpp>
  28 #include <com/sun/star/ui/XModuleUIConfigurationManagerSupplier.hpp>
  29 #include <com/sun/star/ui/XUIConfigurationManagerSupplier.hpp>
  30 #include <com/sun/star/ui/XUIElementFactory.hpp>
  31
  32 #include <cppuhelper/implbase.hxx>
  33 #include <cppuhelper/supportsservice.hxx>
  34 #include <vcl/svapp.hxx>
  35 #include <rtl/ref.hxx>
  36 #include <rtl/ustrbuf.hxx>
  37
  38 #include <services.h>
  39
  40 using namespace com::sun::star::uno;
  41 using namespace com::sun::star::lang;
  42 using namespace com::sun::star::frame;
  43 using namespace com::sun::star::beans;
  44 using namespace com::sun::star::util;
  45 using namespace ::com::sun::star::ui;
  46 using namespace framework;
  47
  48 namespace {
  49
  50 class AddonsToolBarFactory :  public ::cppu::WeakImplHelper< css::lang::XServiceInfo ,
  51                                                               css::ui::XUIElementFactory >
  52 {
  53 public:
  54     explicit AddonsToolBarFactory( const css::uno::Reference< css::uno::XComponentContext >& xContext );
  55
  56     virtual OUString SAL_CALL getImplementationName() override
  57     {
  58         return "com.sun.star.comp.framework.AddonsToolBarFactory";
  59     }
  60
  61     virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override
  62     {
  63         return cppu::supportsService(this, ServiceName);
  64     }
  65
  66     virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override
  67     {
  68         return {"com.sun.star.ui.ToolBarFactory"};
  69     }
  70
  71     // XUIElementFactory
  72     virtual css::uno::Reference< css::ui::XUIElement > SAL_CALL createUIElement( const OUString& ResourceURL, const css::uno::Sequence< css::beans::PropertyValue >& Args ) override;
  73
  74     bool hasButtonsInContext( const css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > >& rPropSeq,
  75                                   const css::uno::Reference< css::frame::XFrame >& rFrame );
  76
  77 private:
  78     css::uno::Reference< css::uno::XComponentContext >     m_xContext;
  79     css::uno::Reference< css::frame::XModuleManager2 >     m_xModuleManager;
  80 };
  81
  82 AddonsToolBarFactory::AddonsToolBarFactory(
  83     const css::uno::Reference< css::uno::XComponentContext >& xContext ) :
  84     m_xContext( xContext )
  85     , m_xModuleManager( ModuleManager::create( xContext ) )
  86 {
  87 }
  88
  89 bool IsCorrectContext( const OUString& rModuleIdentifier, const OUString& aContextList )
  90 {
  91     if ( aContextList.isEmpty() )
  92         return true;
  93
  94     if ( !rModuleIdentifier.isEmpty() )
  95     {
  96         sal_Int32 nIndex = aContextList.indexOf( rModuleIdentifier );
  97         return ( nIndex >= 0 );
  98     }
  99
 100     return false;
 101 }
 102
 103 bool AddonsToolBarFactory::hasButtonsInContext(
 104     const Sequence< Sequence< PropertyValue > >& rPropSeqSeq,
 105     const Reference< XFrame >& rFrame )
 106 {
 107     OUString aModuleIdentifier;
 108     try
 109     {
 110         aModuleIdentifier = m_xModuleManager->identify( rFrame );
 111     }
 112     catch ( const RuntimeException& )
 113     {
 114         throw;
 115     }
 116     catch ( const Exception& )
 117     {
 118     }
 119
 120     // Check before we create a toolbar that we have at least one button in
 121     // the current frame context.
 122     for ( sal_uInt32 i = 0; i < static_cast<sal_uInt32>(rPropSeqSeq.getLength()); i++ )
 123     {
 124         bool    bIsButton( true );
 125         bool    bIsCorrectContext( false );
 126         sal_uInt32  nPropChecked( 0 );
 127
 128         const Sequence< PropertyValue >& rPropSeq = rPropSeqSeq[i];
 129         for ( sal_uInt32 j = 0; j < static_cast<sal_uInt32>(rPropSeq.getLength()); j++ )
 130         {
 131             if ( rPropSeq[j].Name == "Context" )
 132             {
 133                 OUString aContextList;
 134                 if ( rPropSeq[j].Value >>= aContextList )
 135                     bIsCorrectContext = IsCorrectContext( aModuleIdentifier, aContextList );
 136                 nPropChecked++;
 137             }
 138             else if ( rPropSeq[j].Name == "URL" )
 139             {
 140                 OUString aURL;
 141                 rPropSeq[j].Value >>= aURL;
 142                 bIsButton = aURL != "private:separator";
 143                 nPropChecked++;
 144             }
 145
 146             if ( nPropChecked == 2 )
 147                 break;
 148         }
 149
 150         if ( bIsButton && bIsCorrectContext )
 151             return true;
 152     }
 153
 154     return false;
 155 }
 156
 157 // XUIElementFactory
 158 Reference< XUIElement > SAL_CALL AddonsToolBarFactory::createUIElement(
 159     const OUString& ResourceURL,
 160     const Sequence< PropertyValue >& Args )
 161 {
 162     SolarMutexGuard g;
 163
 164     Sequence< Sequence< PropertyValue > >   aConfigData;
 165     Reference< XFrame >                     xFrame;
 166     OUString                           aResourceURL( ResourceURL );
 167
 168     for ( sal_Int32 n = 0; n < Args.getLength(); n++ )
 169     {
 170         if ( Args[n].Name == "ConfigurationData" )
 171             Args[n].Value >>= aConfigData;
 172         else if ( Args[n].Name == "Frame" )
 173             Args[n].Value >>= xFrame;
 174         else if ( Args[n].Name == "ResourceURL" )
 175             Args[n].Value >>= aResourceURL;
 176     }
 177
 178     if ( !aResourceURL.startsWith("private:resource/toolbar/addon_") )
 179         throw IllegalArgumentException();
 180
 181     // Identify frame and determine module identifier to look for context based buttons
 182     Reference< css::ui::XUIElement > xToolBar;
 183     if ( xFrame.is() &&
 184          aConfigData.hasElements() &&
 185          hasButtonsInContext( aConfigData, xFrame ))
 186     {
 187         PropertyValue aPropValue;
 188         Sequence< Any > aPropSeq( 3 );
 189         aPropValue.Name = "Frame";
 190         aPropValue.Value <<= xFrame;
 191         aPropSeq[0] <<= aPropValue;
 192         aPropValue.Name = "ConfigurationData";
 193         aPropValue.Value <<= aConfigData;
 194         aPropSeq[1] <<= aPropValue;
 195         aPropValue.Name = "ResourceURL";
 196         aPropValue.Value <<= aResourceURL;
 197         aPropSeq[2] <<= aPropValue;
 198
 199         SolarMutexGuard aGuard;
 200         AddonsToolBarWrapper* pToolBarWrapper = new AddonsToolBarWrapper( m_xContext );
 201         xToolBar.set( static_cast<OWeakObject *>(pToolBarWrapper), UNO_QUERY );
 202         Reference< XInitialization > xInit( xToolBar, UNO_QUERY );
 203         xInit->initialize( aPropSeq );
 204     }
 205
 206     return xToolBar;
 207 }
 208
 209 }
 210
 211 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 212 com_sun_star_comp_framework_AddonsToolBarFactory_get_implementation(
 213     css::uno::XComponentContext *context,
 214     css::uno::Sequence<css::uno::Any> const &)
 215 {
 216     return cppu::acquire(new AddonsToolBarFactory(context));
 217 }
 218
 219 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */