sfx2/source/appl/preventduplicateinteraction.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 <preventduplicateinteraction.hxx>
  21
  22 #include <comphelper/processfactory.hxx>
  23 #include <osl/diagnose.h>
  24
  25 #include <com/sun/star/task/InteractionHandler.hpp>
  26 #include <com/sun/star/task/XInteractionAbort.hpp>
  27
  28 namespace sfx2 {
  29
  30 PreventDuplicateInteraction::PreventDuplicateInteraction(const css::uno::Reference< css::uno::XComponentContext >& rxContext)
  31     : m_xContext(rxContext)
  32 {
  33 }
  34
  35 PreventDuplicateInteraction::~PreventDuplicateInteraction()
  36 {
  37 }
  38
  39 void PreventDuplicateInteraction::setHandler(const css::uno::Reference< css::task::XInteractionHandler >& xHandler)
  40 {
  41     // SAFE ->
  42     osl::MutexGuard aLock(m_aLock);
  43     m_xWarningDialogsParent.reset();
  44     m_xHandler = xHandler;
  45     // <- SAFE
  46 }
  47
  48 void PreventDuplicateInteraction::useDefaultUUIHandler()
  49 {
  50     //if we use the default handler, set the parent to a window belonging to this object so that the dialogs
  51     //don't block unrelated windows.
  52     m_xWarningDialogsParent.reset(new WarningDialogsParentScope(m_xContext));
  53     css::uno::Reference<css::task::XInteractionHandler> xHandler(css::task::InteractionHandler::createWithParent(
  54         m_xContext, m_xWarningDialogsParent->GetDialogParent()), css::uno::UNO_QUERY_THROW);
  55
  56     // SAFE ->
  57     osl::MutexGuard aLock(m_aLock);
  58     m_xHandler = xHandler;
  59     // <- SAFE
  60 }
  61
  62 css::uno::Any SAL_CALL PreventDuplicateInteraction::queryInterface( const css::uno::Type& aType )
  63 {
  64     if ( aType.equals( cppu::UnoType<XInteractionHandler2>::get() ) )
  65     {
  66         osl::MutexGuard aLock(m_aLock);
  67         css::uno::Reference< css::task::XInteractionHandler2 > xHandler( m_xHandler, css::uno::UNO_QUERY );
  68         if ( !xHandler.is() )
  69             return css::uno::Any();
  70     }
  71     return ::cppu::WeakImplHelper<css::lang::XInitialization, css::task::XInteractionHandler2>::queryInterface(aType);
  72 }
  73
  74 void SAL_CALL PreventDuplicateInteraction::handle(const css::uno::Reference< css::task::XInteractionRequest >& xRequest)
  75 {
  76     css::uno::Any aRequest  = xRequest->getRequest();
  77     bool          bHandleIt = true;
  78
  79     // SAFE ->
  80     osl::ClearableMutexGuard aLock(m_aLock);
  81
  82     auto pIt = std::find_if(m_lInteractionRules.begin(), m_lInteractionRules.end(),
  83         [&aRequest](const InteractionInfo& rInfo) { return aRequest.isExtractableTo(rInfo.m_aInteraction); });
  84     if (pIt != m_lInteractionRules.end())
  85     {
  86         InteractionInfo& rInfo = *pIt;
  87
  88         ++rInfo.m_nCallCount;
  89         rInfo.m_xRequest = xRequest;
  90         bHandleIt = (rInfo.m_nCallCount <= rInfo.m_nMaxCount);
  91     }
  92
  93     css::uno::Reference< css::task::XInteractionHandler > xHandler = m_xHandler;
  94
  95     aLock.clear();
  96     // <- SAFE
  97
  98     if ( bHandleIt && xHandler.is() )
  99     {
 100         xHandler->handle(xRequest);
 101     }
 102     else
 103     {
 104         const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > lContinuations = xRequest->getContinuations();
 105         for (const auto& rContinuation : lContinuations)
 106         {
 107             css::uno::Reference< css::task::XInteractionAbort > xAbort(rContinuation, css::uno::UNO_QUERY);
 108             if (xAbort.is())
 109             {
 110                 xAbort->select();
 111                 break;
 112             }
 113         }
 114     }
 115 }
 116
 117 sal_Bool SAL_CALL PreventDuplicateInteraction::handleInteractionRequest( const css::uno::Reference< css::task::XInteractionRequest >& xRequest )
 118 {
 119     css::uno::Any aRequest  = xRequest->getRequest();
 120     bool      bHandleIt = true;
 121
 122     // SAFE ->
 123     osl::ClearableMutexGuard aLock(m_aLock);
 124
 125     auto pIt = std::find_if(m_lInteractionRules.begin(), m_lInteractionRules.end(),
 126         [&aRequest](const InteractionInfo& rInfo) { return aRequest.isExtractableTo(rInfo.m_aInteraction); });
 127     if (pIt != m_lInteractionRules.end())
 128     {
 129         InteractionInfo& rInfo = *pIt;
 130
 131         ++rInfo.m_nCallCount;
 132         rInfo.m_xRequest = xRequest;
 133         bHandleIt = (rInfo.m_nCallCount <= rInfo.m_nMaxCount);
 134     }
 135
 136     css::uno::Reference< css::task::XInteractionHandler2 > xHandler( m_xHandler, css::uno::UNO_QUERY );
 137     OSL_ENSURE( xHandler.is() || !m_xHandler.is(),
 138         "PreventDuplicateInteraction::handleInteractionRequest: inconsistency!" );
 139
 140     aLock.clear();
 141     // <- SAFE
 142
 143     if ( bHandleIt && xHandler.is() )
 144     {
 145         return xHandler->handleInteractionRequest(xRequest);
 146     }
 147     else
 148     {
 149         const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > lContinuations = xRequest->getContinuations();
 150         for (const auto& rContinuation : lContinuations)
 151         {
 152             css::uno::Reference< css::task::XInteractionAbort > xAbort(rContinuation, css::uno::UNO_QUERY);
 153             if (xAbort.is())
 154             {
 155                 xAbort->select();
 156                 break;
 157             }
 158         }
 159     }
 160     return false;
 161 }
 162
 163 void PreventDuplicateInteraction::addInteractionRule(const PreventDuplicateInteraction::InteractionInfo& aInteractionInfo)
 164 {
 165     // SAFE ->
 166     osl::MutexGuard aLock(m_aLock);
 167
 168     auto pIt = std::find_if(m_lInteractionRules.begin(), m_lInteractionRules.end(),
 169         [&aInteractionInfo](const InteractionInfo& rInfo) { return rInfo.m_aInteraction == aInteractionInfo.m_aInteraction; });
 170     if (pIt != m_lInteractionRules.end())
 171     {
 172         InteractionInfo& rInfo = *pIt;
 173         rInfo.m_nMaxCount  = aInteractionInfo.m_nMaxCount;
 174         rInfo.m_nCallCount = aInteractionInfo.m_nCallCount;
 175         return;
 176     }
 177
 178     m_lInteractionRules.push_back(aInteractionInfo);
 179     // <- SAFE
 180 }
 181
 182 bool PreventDuplicateInteraction::getInteractionInfo(const css::uno::Type&                               aInteraction,
 183                                                            PreventDuplicateInteraction::InteractionInfo* pReturn     ) const
 184 {
 185     // SAFE ->
 186     osl::MutexGuard aLock(m_aLock);
 187
 188     auto pIt = std::find_if(m_lInteractionRules.begin(), m_lInteractionRules.end(),
 189         [&aInteraction](const InteractionInfo& rInfo) { return rInfo.m_aInteraction == aInteraction; });
 190     if (pIt != m_lInteractionRules.end())
 191     {
 192         *pReturn = *pIt;
 193         return true;
 194     }
 195     // <- SAFE
 196
 197     return false;
 198 }
 199
 200 void SAL_CALL PreventDuplicateInteraction::initialize(const css::uno::Sequence<css::uno::Any>& rArguments)
 201 {
 202     // If we're re-initialized to set a specific new window as a parent then drop our temporary
 203     // dialog parent
 204     css::uno::Reference<css::lang::XInitialization> xHandler(m_xHandler, css::uno::UNO_QUERY);
 205     if (xHandler.is())
 206     {
 207         m_xWarningDialogsParent.reset();
 208         xHandler->initialize(rArguments);
 209     }
 210 }
 211
 212 IMPL_STATIC_LINK_NOARG(WarningDialogsParent, TerminateDesktop, void*, void)
 213 {
 214     css::frame::Desktop::create(comphelper::getProcessComponentContext())->terminate();
 215 }
 216
 217 } // namespace sfx2
 218
 219 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */