framework/source/interaction/preventduplicateinteraction.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: preventduplicateinteraction.cxx,v $
  10  * $Revision: 1.6 $
  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 #include "interaction/preventduplicateinteraction.hxx"
  35
  36 //_________________________________________________________________________________________________________________
  37 //      my own includes
  38 //_________________________________________________________________________________________________________________
  39
  40 //_________________________________________________________________________________________________________________
  41 //      interface includes
  42 //_________________________________________________________________________________________________________________
  43 #include <com/sun/star/task/XInteractionAbort.hpp>
  44 #include <com/sun/star/task/XInteractionRetry.hpp>
  45
  46 //_________________________________________________________________________________________________________________
  47 //      other includes
  48 //_________________________________________________________________________________________________________________
  49
  50 //_________________________________________________________________________________________________________________
  51 //      namespace
  52 //_________________________________________________________________________________________________________________
  53
  54 namespace framework{
  55
  56 namespace css = ::com::sun::star;
  57
  58 //_________________________________________________________________________________________________________________
  59 //      exported const
  60 //_________________________________________________________________________________________________________________
  61
  62 #define IMPLEMENTATIONNAME_UIINTERACTIONHANDLER                 ::rtl::OUString::createFromAscii("com.sun.star.comp.uui.UUIInteractionHandler")
  63
  64 //_________________________________________________________________________________________________________________
  65 //      exported definitions
  66 //_________________________________________________________________________________________________________________
  67
  68 //_________________________________________________________________________________________________________________
  69
  70 PreventDuplicateInteraction::PreventDuplicateInteraction(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR)
  71     : ThreadHelpBase2()
  72     , m_xSMGR(xSMGR)
  73 {
  74 }
  75
  76 //_________________________________________________________________________________________________________________
  77
  78 PreventDuplicateInteraction::~PreventDuplicateInteraction()
  79 {
  80 }
  81
  82 //_________________________________________________________________________________________________________________
  83
  84 void PreventDuplicateInteraction::setHandler(const css::uno::Reference< css::task::XInteractionHandler >& xHandler)
  85 {
  86     // SAFE ->
  87     ::osl::ResettableMutexGuard aLock(m_aLock);
  88     m_xHandler = xHandler;
  89     aLock.clear();
  90     // <- SAFE
  91 }
  92
  93 //_________________________________________________________________________________________________________________
  94
  95 void PreventDuplicateInteraction::useDefaultUUIHandler()
  96 {
  97     // SAFE ->
  98     ::osl::ResettableMutexGuard aLock(m_aLock);
  99     css::uno::Reference< css::lang::XMultiServiceFactory > xSMGR = m_xSMGR;
 100     aLock.clear();
 101     // <- SAFE
 102
 103     css::uno::Reference< css::task::XInteractionHandler > xHandler(
 104                             xSMGR->createInstance(IMPLEMENTATIONNAME_UIINTERACTIONHANDLER),
 105                             css::uno::UNO_QUERY_THROW);
 106
 107     // SAFE ->
 108     aLock.reset();
 109     m_xHandler = xHandler;
 110     aLock.clear();
 111     // <- SAFE
 112 }
 113
 114 //_________________________________________________________________________________________________________________
 115
 116 void SAL_CALL PreventDuplicateInteraction::handle(const css::uno::Reference< css::task::XInteractionRequest >& xRequest)
 117     throw(css::uno::RuntimeException)
 118 {
 119     css::uno::Any aRequest  = xRequest->getRequest();
 120     sal_Bool      bHandleIt = sal_True;
 121
 122     // SAFE ->
 123     ::osl::ResettableMutexGuard aLock(m_aLock);
 124
 125     InteractionList::iterator pIt;
 126     for (  pIt  = m_lInteractionRules.begin();
 127            pIt != m_lInteractionRules.end()  ;
 128          ++pIt                               )
 129     {
 130         InteractionInfo& rInfo = *pIt;
 131
 132         if (aRequest.isExtractableTo(rInfo.m_aInteraction))
 133         {
 134             ++rInfo.m_nCallCount;
 135             rInfo.m_xRequest = xRequest;
 136             bHandleIt = (rInfo.m_nCallCount <= rInfo.m_nMaxCount);
 137             break;
 138         }
 139     }
 140
 141     css::uno::Reference< css::task::XInteractionHandler > xHandler = m_xHandler;
 142
 143     aLock.clear();
 144     // <- SAFE
 145
 146     if (
 147         (bHandleIt    ) &&
 148         (xHandler.is())
 149        )
 150     {
 151         xHandler->handle(xRequest);
 152     }
 153     else
 154     {
 155         const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > lContinuations = xRequest->getContinuations();
 156         sal_Int32 c = lContinuations.getLength();
 157         sal_Int32 i = 0;
 158         for (i=0; i<c; ++i)
 159         {
 160             css::uno::Reference< css::task::XInteractionAbort > xAbort(lContinuations[i], css::uno::UNO_QUERY);
 161             if (xAbort.is())
 162             {
 163                 xAbort->select();
 164                 break;
 165             }
 166         }
 167     }
 168 }
 169
 170 //_________________________________________________________________________________________________________________
 171
 172 void PreventDuplicateInteraction::addInteractionRule(const PreventDuplicateInteraction::InteractionInfo& aInteractionInfo)
 173 {
 174     // SAFE ->
 175     ::osl::ResettableMutexGuard aLock(m_aLock);
 176
 177     InteractionList::iterator pIt;
 178     for (  pIt  = m_lInteractionRules.begin();
 179            pIt != m_lInteractionRules.end()  ;
 180          ++pIt                               )
 181     {
 182         InteractionInfo& rInfo = *pIt;
 183         if (rInfo.m_aInteraction == aInteractionInfo.m_aInteraction)
 184         {
 185             rInfo.m_nMaxCount  = aInteractionInfo.m_nMaxCount ;
 186             rInfo.m_nCallCount = aInteractionInfo.m_nCallCount;
 187             return;
 188         }
 189     }
 190
 191     m_lInteractionRules.push_back(aInteractionInfo);
 192
 193     aLock.clear();
 194     // <- SAFE
 195 }
 196
 197 //_________________________________________________________________________________________________________________
 198
 199 sal_Bool PreventDuplicateInteraction::getInteractionInfo(const css::uno::Type&                               aInteraction,
 200                                                                PreventDuplicateInteraction::InteractionInfo* pReturn     ) const
 201 {
 202     // SAFE ->
 203     ::osl::ResettableMutexGuard aLock(m_aLock);
 204
 205     PreventDuplicateInteraction::InteractionList::const_iterator pIt;
 206     for (  pIt  = m_lInteractionRules.begin();
 207            pIt != m_lInteractionRules.end()  ;
 208          ++pIt                               )
 209     {
 210         const PreventDuplicateInteraction::InteractionInfo& rInfo = *pIt;
 211         if (rInfo.m_aInteraction == aInteraction)
 212         {
 213             *pReturn = rInfo;
 214             return sal_True;
 215         }
 216     }
 217
 218     aLock.clear();
 219     // <- SAFE
 220
 221     return sal_False;
 222 }
 223
 224 } // namespace framework