sc/source/ui/unoobj/dispuno.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: dispuno.cxx,v $
  10  * $Revision: 1.9 $
  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_sc.hxx"
  33
  34
  35
  36 #include <sfx2/viewfrm.hxx>
  37 #include <comphelper/uno3.hxx>
  38 #include <svx/dataaccessdescriptor.hxx>
  39 #include <svtools/smplhint.hxx>
  40
  41 #include <com/sun/star/frame/XDispatchProviderInterception.hpp>
  42 #include <com/sun/star/view/XSelectionSupplier.hpp>
  43 #include <com/sun/star/sdb/CommandType.hpp>
  44
  45 #include "dispuno.hxx"
  46 #include "unoguard.hxx"
  47 #include "tabvwsh.hxx"
  48 #include "dbdocfun.hxx"
  49 #include "dbcolect.hxx"
  50
  51 using namespace com::sun::star;
  52
  53 //------------------------------------------------------------------------
  54
  55 const char* cURLInsertColumns = ".uno:DataSourceBrowser/InsertColumns"; //data into text
  56 const char* cURLDocDataSource = ".uno:DataSourceBrowser/DocumentDataSource";
  57
  58 //------------------------------------------------------------------------
  59
  60 SV_IMPL_PTRARR( XStatusListenerArr_Impl, XStatusListenerPtr );
  61
  62 //------------------------------------------------------------------------
  63
  64 uno::Reference<view::XSelectionSupplier> lcl_GetSelectionSupplier( SfxViewShell* pViewShell )
  65 {
  66     if ( pViewShell )
  67     {
  68         SfxViewFrame* pViewFrame = pViewShell->GetViewFrame();
  69         if (pViewFrame)
  70         {
  71             SfxFrame* pFrame = pViewFrame->GetFrame();
  72             if (pFrame)
  73                 return uno::Reference<view::XSelectionSupplier>( pFrame->GetController(), uno::UNO_QUERY );
  74         }
  75     }
  76     return uno::Reference<view::XSelectionSupplier>();
  77 }
  78
  79 //------------------------------------------------------------------------
  80
  81
  82 ScDispatchProviderInterceptor::ScDispatchProviderInterceptor(ScTabViewShell* pViewSh) :
  83     pViewShell( pViewSh )
  84 {
  85     if ( pViewShell )
  86     {
  87         SfxFrame* pFrame = pViewShell->GetViewFrame()->GetFrame();
  88         m_xIntercepted.set(uno::Reference<frame::XDispatchProviderInterception>(pFrame->GetFrameInterface(), uno::UNO_QUERY));
  89         if (m_xIntercepted.is())
  90         {
  91             comphelper::increment( m_refCount );
  92
  93             m_xIntercepted->registerDispatchProviderInterceptor(
  94                         static_cast<frame::XDispatchProviderInterceptor*>(this));
  95             // this should make us the top-level dispatch-provider for the component, via a call to our
  96             // setDispatchProvider we should have got an fallback for requests we (i.e. our master) cannot fullfill
  97             uno::Reference<lang::XComponent> xInterceptedComponent(m_xIntercepted, uno::UNO_QUERY);
  98             if (xInterceptedComponent.is())
  99                 xInterceptedComponent->addEventListener(static_cast<lang::XEventListener*>(this));
 100
 101             comphelper::decrement( m_refCount );
 102         }
 103
 104         StartListening(*pViewShell);
 105     }
 106 }
 107
 108 ScDispatchProviderInterceptor::~ScDispatchProviderInterceptor()
 109 {
 110     if (pViewShell)
 111         EndListening(*pViewShell);
 112 }
 113
 114 void ScDispatchProviderInterceptor::Notify( SfxBroadcaster&, const SfxHint& rHint )
 115 {
 116     if ( rHint.ISA( SfxSimpleHint ) &&
 117             ((const SfxSimpleHint&)rHint).GetId() == SFX_HINT_DYING )
 118         pViewShell = NULL;
 119 }
 120
 121 // XDispatchProvider
 122
 123 uno::Reference<frame::XDispatch> SAL_CALL ScDispatchProviderInterceptor::queryDispatch(
 124                         const util::URL& aURL, const rtl::OUString& aTargetFrameName,
 125                         sal_Int32 nSearchFlags )
 126                         throw(uno::RuntimeException)
 127 {
 128     ScUnoGuard aGuard;
 129
 130     uno::Reference<frame::XDispatch> xResult;
 131     // create some dispatch ...
 132     if ( pViewShell && (
 133         !aURL.Complete.compareToAscii(cURLInsertColumns) ||
 134         !aURL.Complete.compareToAscii(cURLDocDataSource) ) )
 135     {
 136         if (!m_xMyDispatch.is())
 137             m_xMyDispatch = new ScDispatch( pViewShell );
 138         xResult = m_xMyDispatch;
 139     }
 140
 141     // ask our slave provider
 142     if (!xResult.is() && m_xSlaveDispatcher.is())
 143         xResult = m_xSlaveDispatcher->queryDispatch(aURL, aTargetFrameName, nSearchFlags);
 144
 145     return xResult;
 146 }
 147
 148 uno::Sequence< uno::Reference<frame::XDispatch> > SAL_CALL
 149                         ScDispatchProviderInterceptor::queryDispatches(
 150                         const uno::Sequence<frame::DispatchDescriptor>& aDescripts )
 151                         throw(uno::RuntimeException)
 152 {
 153     ScUnoGuard aGuard;
 154
 155     uno::Sequence< uno::Reference< frame::XDispatch> > aReturn(aDescripts.getLength());
 156     uno::Reference< frame::XDispatch>* pReturn = aReturn.getArray();
 157     const frame::DispatchDescriptor* pDescripts = aDescripts.getConstArray();
 158     for (sal_Int16 i=0; i<aDescripts.getLength(); ++i, ++pReturn, ++pDescripts)
 159     {
 160         *pReturn = queryDispatch(pDescripts->FeatureURL,
 161                 pDescripts->FrameName, pDescripts->SearchFlags);
 162     }
 163     return aReturn;
 164 }
 165
 166 // XDispatchProviderInterceptor
 167
 168 uno::Reference<frame::XDispatchProvider> SAL_CALL
 169                         ScDispatchProviderInterceptor::getSlaveDispatchProvider()
 170                         throw(uno::RuntimeException)
 171 {
 172     ScUnoGuard aGuard;
 173     return m_xSlaveDispatcher;
 174 }
 175
 176 void SAL_CALL ScDispatchProviderInterceptor::setSlaveDispatchProvider(
 177                         const uno::Reference<frame::XDispatchProvider>& xNewDispatchProvider )
 178                         throw(uno::RuntimeException)
 179 {
 180     ScUnoGuard aGuard;
 181     m_xSlaveDispatcher.set(xNewDispatchProvider);
 182 }
 183
 184 uno::Reference<frame::XDispatchProvider> SAL_CALL
 185                         ScDispatchProviderInterceptor::getMasterDispatchProvider()
 186                         throw(uno::RuntimeException)
 187 {
 188     ScUnoGuard aGuard;
 189     return m_xMasterDispatcher;
 190 }
 191
 192 void SAL_CALL ScDispatchProviderInterceptor::setMasterDispatchProvider(
 193                         const uno::Reference<frame::XDispatchProvider>& xNewSupplier )
 194                         throw(uno::RuntimeException)
 195 {
 196     ScUnoGuard aGuard;
 197     m_xMasterDispatcher.set(xNewSupplier);
 198 }
 199
 200 // XEventListener
 201
 202 void SAL_CALL ScDispatchProviderInterceptor::disposing( const lang::EventObject& /* Source */ )
 203                                 throw(::com::sun::star::uno::RuntimeException)
 204 {
 205     ScUnoGuard aGuard;
 206
 207     if (m_xIntercepted.is())
 208     {
 209         m_xIntercepted->releaseDispatchProviderInterceptor(
 210                 static_cast<frame::XDispatchProviderInterceptor*>(this));
 211         uno::Reference<lang::XComponent> xInterceptedComponent(m_xIntercepted, uno::UNO_QUERY);
 212         if (xInterceptedComponent.is())
 213             xInterceptedComponent->removeEventListener(static_cast<lang::XEventListener*>(this));
 214
 215         m_xMyDispatch = NULL;
 216     }
 217     m_xIntercepted = NULL;
 218 }
 219
 220 //------------------------------------------------------------------------
 221
 222 ScDispatch::ScDispatch(ScTabViewShell* pViewSh) :
 223     pViewShell( pViewSh ),
 224     bListeningToView( FALSE )
 225 {
 226     if (pViewShell)
 227         StartListening(*pViewShell);
 228 }
 229
 230 ScDispatch::~ScDispatch()
 231 {
 232     if (pViewShell)
 233         EndListening(*pViewShell);
 234
 235     if (bListeningToView && pViewShell)
 236     {
 237         uno::Reference<view::XSelectionSupplier> xSupplier(lcl_GetSelectionSupplier( pViewShell ));
 238         if ( xSupplier.is() )
 239             xSupplier->removeSelectionChangeListener(this);
 240     }
 241 }
 242
 243 void ScDispatch::Notify( SfxBroadcaster&, const SfxHint& rHint )
 244 {
 245     if ( rHint.ISA( SfxSimpleHint ) &&
 246             ((const SfxSimpleHint&)rHint).GetId() == SFX_HINT_DYING )
 247         pViewShell = NULL;
 248 }
 249
 250 // XDispatch
 251
 252 void SAL_CALL ScDispatch::dispatch( const util::URL& aURL,
 253                                 const uno::Sequence<beans::PropertyValue>& aArgs )
 254                                 throw(uno::RuntimeException)
 255 {
 256     ScUnoGuard aGuard;
 257
 258     BOOL bDone = FALSE;
 259     if ( pViewShell && !aURL.Complete.compareToAscii(cURLInsertColumns) )
 260     {
 261         ScViewData* pViewData = pViewShell->GetViewData();
 262         ScAddress aPos( pViewData->GetCurX(), pViewData->GetCurY(), pViewData->GetTabNo() );
 263
 264         ScDBDocFunc aFunc( *pViewData->GetDocShell() );
 265         bDone = aFunc.DoImportUno( aPos, aArgs );
 266     }
 267     // cURLDocDataSource is never dispatched
 268
 269     if (!bDone)
 270         throw uno::RuntimeException();
 271 }
 272
 273 void lcl_FillDataSource( frame::FeatureStateEvent& rEvent, const ScImportParam& rParam )
 274 {
 275     rEvent.IsEnabled = rParam.bImport;
 276
 277     ::svx::ODataAccessDescriptor aDescriptor;
 278     if ( rParam.bImport )
 279     {
 280         sal_Int32 nType = rParam.bSql ? sdb::CommandType::COMMAND :
 281                     ( (rParam.nType == ScDbQuery) ? sdb::CommandType::QUERY :
 282                                                     sdb::CommandType::TABLE );
 283
 284         aDescriptor.setDataSource(rtl::OUString( rParam.aDBName ));
 285         aDescriptor[svx::daCommand]     <<= rtl::OUString( rParam.aStatement );
 286         aDescriptor[svx::daCommandType] <<= nType;
 287     }
 288     else
 289     {
 290         //  descriptor has to be complete anyway
 291
 292         rtl::OUString aEmpty;
 293         aDescriptor[svx::daDataSource]  <<= aEmpty;
 294         aDescriptor[svx::daCommand]     <<= aEmpty;
 295         aDescriptor[svx::daCommandType] <<= (sal_Int32)sdb::CommandType::TABLE;
 296     }
 297     rEvent.State <<= aDescriptor.createPropertyValueSequence();
 298 }
 299
 300 void SAL_CALL ScDispatch::addStatusListener(
 301                                 const uno::Reference<frame::XStatusListener>& xListener,
 302                                 const util::URL& aURL )
 303                                 throw(uno::RuntimeException)
 304 {
 305     ScUnoGuard aGuard;
 306
 307     if (!pViewShell)
 308         throw uno::RuntimeException();
 309
 310     //  initial state
 311     frame::FeatureStateEvent aEvent;
 312     aEvent.IsEnabled = sal_True;
 313     aEvent.Source.set(static_cast<cppu::OWeakObject*>(this));
 314     aEvent.FeatureURL = aURL;
 315
 316     if ( !aURL.Complete.compareToAscii(cURLDocDataSource) )
 317     {
 318         uno::Reference<frame::XStatusListener>* pObj =
 319                 new uno::Reference<frame::XStatusListener>( xListener );
 320         aDataSourceListeners.Insert( pObj, aDataSourceListeners.Count() );
 321
 322         if (!bListeningToView)
 323         {
 324             uno::Reference<view::XSelectionSupplier> xSupplier(lcl_GetSelectionSupplier( pViewShell ));
 325             if ( xSupplier.is() )
 326                 xSupplier->addSelectionChangeListener(this);
 327             bListeningToView = sal_True;
 328         }
 329
 330         ScDBData* pDBData = pViewShell->GetDBData(FALSE,SC_DB_OLD);
 331         if ( pDBData )
 332             pDBData->GetImportParam( aLastImport );
 333         lcl_FillDataSource( aEvent, aLastImport );          // modifies State, IsEnabled
 334     }
 335     //! else add to listener for "enabled" changes?
 336
 337     xListener->statusChanged( aEvent );
 338 }
 339
 340 void SAL_CALL ScDispatch::removeStatusListener(
 341                                 const uno::Reference<frame::XStatusListener>& xListener,
 342                                 const util::URL& aURL )
 343                                 throw(uno::RuntimeException)
 344 {
 345     ScUnoGuard aGuard;
 346
 347     if ( !aURL.Complete.compareToAscii(cURLDocDataSource) )
 348     {
 349         USHORT nCount = aDataSourceListeners.Count();
 350         for ( USHORT n=nCount; n--; )
 351         {
 352             uno::Reference<frame::XStatusListener> *pObj = aDataSourceListeners[n];
 353             if ( *pObj == xListener )
 354             {
 355                 aDataSourceListeners.DeleteAndDestroy( n );
 356                 break;
 357             }
 358         }
 359
 360         if ( aDataSourceListeners.Count() == 0 && pViewShell )
 361         {
 362             uno::Reference<view::XSelectionSupplier> xSupplier(lcl_GetSelectionSupplier( pViewShell ));
 363             if ( xSupplier.is() )
 364                 xSupplier->removeSelectionChangeListener(this);
 365             bListeningToView = sal_False;
 366         }
 367     }
 368 }
 369
 370 // XSelectionChangeListener
 371
 372 void SAL_CALL ScDispatch::selectionChanged( const ::com::sun::star::lang::EventObject& /* aEvent */ )
 373                                 throw (::com::sun::star::uno::RuntimeException)
 374 {
 375     //  currently only called for URL cURLDocDataSource
 376
 377     if ( pViewShell )
 378     {
 379         ScImportParam aNewImport;
 380         ScDBData* pDBData = pViewShell->GetDBData(FALSE,SC_DB_OLD);
 381         if ( pDBData )
 382             pDBData->GetImportParam( aNewImport );
 383
 384         //  notify listeners only if data source has changed
 385         if ( aNewImport.bImport    != aLastImport.bImport ||
 386              aNewImport.aDBName    != aLastImport.aDBName ||
 387              aNewImport.aStatement != aLastImport.aStatement ||
 388              aNewImport.bSql       != aLastImport.bSql ||
 389              aNewImport.nType      != aLastImport.nType )
 390         {
 391             frame::FeatureStateEvent aEvent;
 392             aEvent.Source.set(static_cast<cppu::OWeakObject*>(this));
 393             aEvent.FeatureURL.Complete = rtl::OUString::createFromAscii( cURLDocDataSource );
 394
 395             lcl_FillDataSource( aEvent, aNewImport );       // modifies State, IsEnabled
 396
 397             for ( USHORT n=0; n<aDataSourceListeners.Count(); n++ )
 398                 (*aDataSourceListeners[n])->statusChanged( aEvent );
 399
 400             aLastImport = aNewImport;
 401         }
 402     }
 403 }
 404
 405 // XEventListener
 406
 407 void SAL_CALL ScDispatch::disposing( const ::com::sun::star::lang::EventObject& rSource )
 408                                 throw (::com::sun::star::uno::RuntimeException)
 409 {
 410     uno::Reference<view::XSelectionSupplier> xSupplier(rSource.Source, uno::UNO_QUERY);
 411     xSupplier->removeSelectionChangeListener(this);
 412     bListeningToView = sal_False;
 413
 414     lang::EventObject aEvent;
 415     aEvent.Source.set(static_cast<cppu::OWeakObject*>(this));
 416     for ( USHORT n=0; n<aDataSourceListeners.Count(); n++ )
 417         (*aDataSourceListeners[n])->disposing( aEvent );
 418
 419     pViewShell = NULL;
 420 }
 421