svtools/source/uno/framestatuslistener.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 <framestatuslistener.hxx>
  21 #include <com/sun/star/frame/XDispatchProvider.hpp>
  22 #include <com/sun/star/lang/DisposedException.hpp>
  23 #include <com/sun/star/util/URLTransformer.hpp>
  24 #include <cppuhelper/queryinterface.hxx>
  25 #include <vcl/svapp.hxx>
  26
  27 using namespace ::cppu;
  28 using namespace css::awt;
  29 using namespace css::uno;
  30 using namespace css::util;
  31 using namespace css::lang;
  32 using namespace css::frame;
  33
  34 namespace svt
  35 {
  36
  37 FrameStatusListener::FrameStatusListener(
  38     const Reference< XComponentContext >& rxContext,
  39     const Reference< XFrame >& xFrame ) :
  40     OWeakObject()
  41     ,   m_bDisposed( false )
  42     ,   m_xFrame( xFrame )
  43     ,   m_xContext( rxContext )
  44 {
  45 }
  46
  47 FrameStatusListener::~FrameStatusListener()
  48 {
  49 }
  50
  51 // XInterface
  52 Any SAL_CALL FrameStatusListener::queryInterface( const Type& rType )
  53 {
  54     Any a = ::cppu::queryInterface(
  55                 rType ,
  56                 static_cast< XComponent* >( this ),
  57                 static_cast< XFrameActionListener* >( this ),
  58                 static_cast< XStatusListener* >( this ),
  59                 static_cast< XEventListener* >( static_cast< XStatusListener* >( this )),
  60                 static_cast< XEventListener* >( static_cast< XFrameActionListener* >( this )));
  61
  62     if ( a.hasValue() )
  63         return a;
  64
  65     return OWeakObject::queryInterface( rType );
  66 }
  67
  68 void SAL_CALL FrameStatusListener::acquire() noexcept
  69 {
  70     OWeakObject::acquire();
  71 }
  72
  73 void SAL_CALL FrameStatusListener::release() noexcept
  74 {
  75     OWeakObject::release();
  76 }
  77
  78 // XComponent
  79 void SAL_CALL FrameStatusListener::dispose()
  80 {
  81     Reference< XComponent > xThis = this;
  82
  83     SolarMutexGuard aSolarMutexGuard;
  84     if ( m_bDisposed )
  85         return;
  86
  87     for (auto const& listener : m_aListenerMap)
  88     {
  89         try
  90         {
  91             Reference< XDispatch > xDispatch( listener.second );
  92             Reference< XURLTransformer > xURLTransformer( css::util::URLTransformer::create( m_xContext ) );
  93             css::util::URL aTargetURL;
  94             aTargetURL.Complete = listener.first;
  95             xURLTransformer->parseStrict( aTargetURL );
  96
  97             if ( xDispatch.is() )
  98                 xDispatch->removeStatusListener( this, aTargetURL );
  99         }
 100         catch (const Exception&)
 101         {
 102         }
 103     }
 104
 105     m_bDisposed = true;
 106 }
 107
 108 void SAL_CALL FrameStatusListener::addEventListener( const Reference< XEventListener >& )
 109 {
 110     // helper class for status updates - no need to support listener
 111 }
 112
 113 void SAL_CALL FrameStatusListener::removeEventListener( const Reference< XEventListener >& )
 114 {
 115     // helper class for status updates - no need to support listener
 116 }
 117
 118 // XEventListener
 119 void SAL_CALL FrameStatusListener::disposing( const EventObject& Source )
 120 {
 121     Reference< XInterface > xSource( Source.Source );
 122
 123     SolarMutexGuard aSolarMutexGuard;
 124
 125     for (auto & listener : m_aListenerMap)
 126     {
 127         // Compare references and release dispatch references if they are equal.
 128         Reference< XInterface > xIfac( listener.second, UNO_QUERY );
 129         if ( xSource == xIfac )
 130             listener.second.clear();
 131     }
 132
 133     Reference< XInterface > xIfac( m_xFrame, UNO_QUERY );
 134     if ( xIfac == xSource )
 135         m_xFrame.clear();
 136 }
 137
 138 void FrameStatusListener::frameAction( const FrameActionEvent& Action )
 139 {
 140     if ( Action.Action == FrameAction_CONTEXT_CHANGED )
 141         bindListener();
 142 }
 143
 144 void FrameStatusListener::addStatusListener( const OUString& aCommandURL )
 145 {
 146     Reference< XDispatch >       xDispatch;
 147     Reference< XStatusListener > xStatusListener;
 148     css::util::URL    aTargetURL;
 149
 150     {
 151         SolarMutexGuard aSolarMutexGuard;
 152         URLToDispatchMap::iterator pIter = m_aListenerMap.find( aCommandURL );
 153
 154         // Already in the list of status listener. Do nothing.
 155         if ( pIter != m_aListenerMap.end() )
 156             return;
 157
 158         Reference< XDispatchProvider > xDispatchProvider( m_xFrame, UNO_QUERY );
 159         if ( m_xContext.is() && xDispatchProvider.is() )
 160         {
 161             Reference< XURLTransformer > xURLTransformer( css::util::URLTransformer::create( m_xContext ) );
 162             aTargetURL.Complete = aCommandURL;
 163             xURLTransformer->parseStrict( aTargetURL );
 164             xDispatch = xDispatchProvider->queryDispatch( aTargetURL, OUString(), 0 );
 165
 166             xStatusListener = this;
 167             URLToDispatchMap::iterator aIter = m_aListenerMap.find( aCommandURL );
 168             if ( aIter != m_aListenerMap.end() )
 169             {
 170                 Reference< XDispatch > xOldDispatch( aIter->second );
 171                 aIter->second = xDispatch;
 172
 173                 try
 174                 {
 175                     if ( xOldDispatch.is() )
 176                         xOldDispatch->removeStatusListener( xStatusListener, aTargetURL );
 177                 }
 178                 catch (const Exception&)
 179                 {
 180                 }
 181             }
 182             else
 183                 m_aListenerMap.emplace( aCommandURL, xDispatch );
 184         }
 185     }
 186
 187     // Call without locked mutex as we are called back from dispatch implementation
 188     try
 189     {
 190         if ( xDispatch.is() )
 191             xDispatch->addStatusListener( xStatusListener, aTargetURL );
 192     }
 193     catch (const Exception&)
 194     {
 195     }
 196 }
 197
 198
 199 void FrameStatusListener::bindListener()
 200 {
 201     std::vector< Listener > aDispatchVector;
 202     Reference< XStatusListener > xStatusListener;
 203
 204     {
 205         SolarMutexGuard aSolarMutexGuard;
 206
 207         // Collect all registered command URL's and store them temporary
 208         Reference< XDispatchProvider > xDispatchProvider( m_xFrame, UNO_QUERY );
 209         if ( m_xContext.is() && xDispatchProvider.is() )
 210         {
 211             xStatusListener = this;
 212             for (auto & listener : m_aListenerMap)
 213             {
 214                 Reference< XURLTransformer > xURLTransformer( css::util::URLTransformer::create( m_xContext ) );
 215                 css::util::URL aTargetURL;
 216                 aTargetURL.Complete = listener.first;
 217                 xURLTransformer->parseStrict( aTargetURL );
 218
 219                 Reference< XDispatch > xDispatch( listener.second );
 220                 if ( xDispatch.is() )
 221                 {
 222                     // We already have a dispatch object => we have to requery.
 223                     // Release old dispatch object and remove it as listener
 224                     try
 225                     {
 226                         xDispatch->removeStatusListener( xStatusListener, aTargetURL );
 227                     }
 228                     catch (const Exception&)
 229                     {
 230                     }
 231                 }
 232
 233                 // Query for dispatch object. Old dispatch will be released with this, too.
 234                 try
 235                 {
 236                     xDispatch = xDispatchProvider->queryDispatch( aTargetURL, OUString(), 0 );
 237                 }
 238                 catch (const Exception&)
 239                 {
 240                 }
 241                 listener.second = xDispatch;
 242
 243                 aDispatchVector.emplace_back(std::move(aTargetURL), xDispatch);
 244             }
 245         }
 246     }
 247
 248     // Call without locked mutex as we are called back from dispatch implementation
 249     if ( !xStatusListener.is() )
 250         return;
 251
 252     try
 253     {
 254         for (Listener & rListener : aDispatchVector)
 255         {
 256             if ( rListener.xDispatch.is() )
 257                 rListener.xDispatch->addStatusListener( xStatusListener, rListener.aURL );
 258         }
 259     }
 260     catch (const Exception&)
 261     {
 262     }
 263 }
 264
 265 } // svt
 266
 267 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */