sfx2/source/doc/iframe.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 <sal/config.h>
  21
  22 #include <com/sun/star/awt/XVclWindowPeer.hpp>
  23 #include <com/sun/star/frame/XDispatch.hpp>
  24 #include <com/sun/star/frame/Frame.hpp>
  25 #include <com/sun/star/frame/XFrame2.hpp>
  26 #include <com/sun/star/frame/XSynchronousFrameLoader.hpp>
  27 #include <com/sun/star/task/InteractionHandler.hpp>
  28 #include <com/sun/star/util/URLTransformer.hpp>
  29 #include <com/sun/star/util/XURLTransformer.hpp>
  30 #include <com/sun/star/util/XCloseable.hpp>
  31 #include <com/sun/star/lang/XEventListener.hpp>
  32 #include <com/sun/star/lang/XServiceInfo.hpp>
  33 #include <com/sun/star/beans/XPropertySet.hpp>
  34 #include <com/sun/star/ui/dialogs/XExecutableDialog.hpp>
  35 #include <com/sun/star/embed/XEmbeddedObject.hpp>
  36
  37 #include <comphelper/propertyvalue.hxx>
  38 #include <cppuhelper/implbase.hxx>
  39 #include <cppuhelper/supportsservice.hxx>
  40 #include <officecfg/Office/Common.hxx>
  41 #include <svl/itemprop.hxx>
  42 #include <sfx2/docfile.hxx>
  43 #include <sfx2/frmdescr.hxx>
  44 #include <sfx2/objsh.hxx>
  45 #include <sfx2/sfxdlg.hxx>
  46 #include <toolkit/helper/vclunohelper.hxx>
  47 #include <utility>
  48 #include <vcl/window.hxx>
  49 #include <tools/debug.hxx>
  50 #include <macroloader.hxx>
  51 #include <eventsupplier.hxx>
  52
  53 using namespace ::com::sun::star;
  54
  55 namespace {
  56
  57 class IFrameObject : public ::cppu::WeakImplHelper <
  58         css::util::XCloseable,
  59         css::lang::XEventListener,
  60         css::frame::XSynchronousFrameLoader,
  61         css::ui::dialogs::XExecutableDialog,
  62         css::lang::XServiceInfo,
  63         css::beans::XPropertySet >
  64 {
  65     css::uno::Reference < css::uno::XComponentContext > mxContext;
  66     css::uno::Reference < css::frame::XFrame2 > mxFrame;
  67     css::uno::Reference < css::embed::XEmbeddedObject > mxObj;
  68     SfxItemPropertyMap  maPropMap;
  69     SfxFrameDescriptor  maFrmDescr;
  70
  71 public:
  72     /// @throws css::uno::Exception
  73     /// @throws css::uno::RuntimeException
  74     IFrameObject(css::uno::Reference < css::uno::XComponentContext> xContext, const css::uno::Sequence< css::uno::Any >& aArguments);
  75
  76     virtual OUString SAL_CALL getImplementationName() override
  77     {
  78         return u"com.sun.star.comp.sfx2.IFrameObject"_ustr;
  79     }
  80
  81     virtual sal_Bool SAL_CALL supportsService(OUString const & ServiceName) override
  82     {
  83         return cppu::supportsService(this, ServiceName);
  84     }
  85
  86     virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override
  87     {
  88         css::uno::Sequence< OUString > aSeq { u"com.sun.star.frame.SpecialEmbeddedObject"_ustr };
  89         return aSeq;
  90     }
  91
  92     virtual sal_Bool SAL_CALL load( const css::uno::Sequence < css::beans::PropertyValue >& lDescriptor,
  93             const css::uno::Reference < css::frame::XFrame >& xFrame ) override;
  94     virtual void SAL_CALL cancel() override;
  95     virtual void SAL_CALL close( sal_Bool bDeliverOwnership ) override;
  96     virtual void SAL_CALL addCloseListener( const css::uno::Reference < css::util::XCloseListener >& xListener ) override;
  97     virtual void SAL_CALL removeCloseListener( const css::uno::Reference < css::util::XCloseListener >& xListener ) override;
  98     virtual void SAL_CALL disposing( const css::lang::EventObject& aEvent ) override ;
  99     virtual void SAL_CALL setTitle( const OUString& aTitle ) override;
 100     virtual ::sal_Int16 SAL_CALL execute(  ) override;
 101     virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo() override;
 102     virtual void SAL_CALL addPropertyChangeListener(const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > & aListener) override;
 103     virtual void SAL_CALL removePropertyChangeListener(const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > & aListener) override;
 104     virtual void SAL_CALL addVetoableChangeListener(const OUString& aPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > & aListener) override;
 105     virtual void SAL_CALL removeVetoableChangeListener(const OUString& aPropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > & aListener) override;
 106     virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;
 107     virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
 108 };
 109
 110 class IFrameWindow_Impl : public vcl::Window
 111 {
 112 public:
 113     IFrameWindow_Impl( vcl::Window *pParent, bool bHasBorder );
 114 };
 115
 116 IFrameWindow_Impl::IFrameWindow_Impl( vcl::Window *pParent, bool bHasBorder )
 117     : Window( pParent, WB_CLIPCHILDREN | WB_NODIALOGCONTROL )
 118 {
 119     if ( !bHasBorder )
 120         SetBorderStyle( WindowBorderStyle::NOBORDER );
 121     else
 122         SetBorderStyle( WindowBorderStyle::NORMAL );
 123 }
 124
 125 #define PROPERTY_UNBOUND 0
 126
 127 #define WID_FRAME_URL                   1
 128 #define WID_FRAME_NAME                  2
 129 #define WID_FRAME_IS_AUTO_SCROLL        3
 130 #define WID_FRAME_IS_SCROLLING_MODE     4
 131 #define WID_FRAME_IS_BORDER             5
 132 #define WID_FRAME_IS_AUTO_BORDER        6
 133 #define WID_FRAME_MARGIN_WIDTH          7
 134 #define WID_FRAME_MARGIN_HEIGHT         8
 135
 136 std::span<const SfxItemPropertyMapEntry> lcl_GetIFramePropertyMap_Impl()
 137 {
 138     static const SfxItemPropertyMapEntry aIFramePropertyMap_Impl[] =
 139     {
 140         { u"FrameIsAutoBorder"_ustr,    WID_FRAME_IS_AUTO_BORDER,   cppu::UnoType<bool>::get(), PROPERTY_UNBOUND, 0 },
 141         { u"FrameIsAutoScroll"_ustr,    WID_FRAME_IS_AUTO_SCROLL,   cppu::UnoType<bool>::get(), PROPERTY_UNBOUND, 0 },
 142         { u"FrameIsBorder"_ustr,        WID_FRAME_IS_BORDER,        cppu::UnoType<bool>::get(), PROPERTY_UNBOUND, 0 },
 143         { u"FrameIsScrollingMode"_ustr, WID_FRAME_IS_SCROLLING_MODE,cppu::UnoType<bool>::get(), PROPERTY_UNBOUND, 0 },
 144         { u"FrameMarginHeight"_ustr,    WID_FRAME_MARGIN_HEIGHT,    cppu::UnoType<sal_Int32>::get(), PROPERTY_UNBOUND, 0 },
 145         { u"FrameMarginWidth"_ustr,     WID_FRAME_MARGIN_WIDTH,     cppu::UnoType<sal_Int32>::get(), PROPERTY_UNBOUND, 0 },
 146         { u"FrameName"_ustr,            WID_FRAME_NAME,             cppu::UnoType<OUString>::get(), PROPERTY_UNBOUND, 0 },
 147         { u"FrameURL"_ustr,             WID_FRAME_URL,              cppu::UnoType<OUString>::get(), PROPERTY_UNBOUND, 0 },
 148     };
 149     return aIFramePropertyMap_Impl;
 150 }
 151
 152 IFrameObject::IFrameObject(uno::Reference < uno::XComponentContext > xContext, const css::uno::Sequence< css::uno::Any >& aArguments)
 153     : mxContext(std::move( xContext ))
 154     , maPropMap( lcl_GetIFramePropertyMap_Impl() )
 155 {
 156     if ( aArguments.hasElements() )
 157         aArguments[0] >>= mxObj;
 158 }
 159
 160 sal_Bool SAL_CALL IFrameObject::load(
 161     const uno::Sequence < css::beans::PropertyValue >& /*lDescriptor*/,
 162     const uno::Reference < frame::XFrame >& xFrame )
 163 {
 164     if ( officecfg::Office::Common::Misc::PluginsEnabled::get() )
 165     {
 166         util::URL aTargetURL;
 167         aTargetURL.Complete = maFrmDescr.GetURL().GetMainURL( INetURLObject::DecodeMechanism::NONE );
 168         uno::Reference < util::XURLTransformer > xTrans( util::URLTransformer::create( mxContext ) );
 169         xTrans->parseStrict( aTargetURL );
 170
 171         INetURLObject aURLObject(aTargetURL.Complete);
 172         if (aURLObject.IsExoticProtocol())
 173         {
 174             SAL_WARN("sfx", "IFrameObject::load ignoring: " << aTargetURL.Complete);
 175             return false;
 176         }
 177
 178         uno::Reference<frame::XFramesSupplier> xParentFrame = xFrame->getCreator();
 179         SfxObjectShell* pDoc = SfxMacroLoader::GetObjectShell(xParentFrame);
 180
 181         const bool bIsFactoryURL = aTargetURL.Complete.startsWith("private:factory/");
 182         if (!bIsFactoryURL)
 183         {
 184             bool bUpdateAllowed(true);
 185             if (pDoc)
 186             {
 187                 comphelper::EmbeddedObjectContainer& rEmbeddedObjectContainer = pDoc->getEmbeddedObjectContainer();
 188                 bUpdateAllowed = rEmbeddedObjectContainer.getUserAllowsLinkUpdate();
 189             }
 190             if (!bUpdateAllowed)
 191                 return false;
 192         }
 193
 194         OUString sReferer;
 195         if (pDoc && pDoc->HasName())
 196             sReferer = pDoc->GetMedium()->GetName();
 197
 198         uno::Reference<css::awt::XWindow> xParentWindow(xFrame->getContainerWindow());
 199
 200         if (!mxFrame.is())
 201         {
 202             VclPtr<vcl::Window> pParent = VCLUnoHelper::GetWindow(xParentWindow);
 203             VclPtr<IFrameWindow_Impl> pWin = VclPtr<IFrameWindow_Impl>::Create( pParent, maFrmDescr.IsFrameBorderOn() );
 204             pWin->SetSizePixel( pParent->GetOutputSizePixel() );
 205             pWin->SetBackground();
 206             pWin->Show();
 207
 208             uno::Reference < awt::XWindow > xWindow( pWin->GetComponentInterface(), uno::UNO_QUERY );
 209             xFrame->setComponent( xWindow, uno::Reference < frame::XController >() );
 210
 211             // we must destroy the IFrame before the parent is destroyed
 212             xWindow->addEventListener( this );
 213
 214             mxFrame = frame::Frame::create( mxContext );
 215             uno::Reference < awt::XWindow > xWin( pWin->GetComponentInterface(), uno::UNO_QUERY );
 216             mxFrame->initialize( xWin );
 217             mxFrame->setName( maFrmDescr.GetName() );
 218
 219             uno::Reference < frame::XFramesSupplier > xFramesSupplier( xFrame, uno::UNO_QUERY );
 220             if ( xFramesSupplier.is() )
 221                 mxFrame->setCreator( xFramesSupplier );
 222         }
 223
 224         uno::Reference<task::XInteractionHandler> xInteractionHandler(task::InteractionHandler::createWithParent(mxContext, xParentWindow));
 225         uno::Sequence < beans::PropertyValue > aProps{
 226             comphelper::makePropertyValue(u"PluginMode"_ustr, sal_Int16(2)),
 227             comphelper::makePropertyValue(u"ReadOnly"_ustr, true),
 228             comphelper::makePropertyValue(u"InteractionHandler"_ustr, xInteractionHandler),
 229             comphelper::makePropertyValue(u"Referer"_ustr, sReferer)
 230         };
 231         uno::Reference < frame::XDispatch > xDisp = mxFrame->queryDispatch( aTargetURL, u"_self"_ustr, 0 );
 232         if ( xDisp.is() )
 233             xDisp->dispatch( aTargetURL, aProps );
 234
 235         return true;
 236     }
 237
 238     return false;
 239 }
 240
 241 void SAL_CALL IFrameObject::cancel()
 242 {
 243     try
 244     {
 245         uno::Reference < util::XCloseable > xClose( mxFrame, uno::UNO_QUERY );
 246         if ( xClose.is() )
 247             xClose->close( true );
 248         mxFrame = nullptr;
 249     }
 250     catch (const uno::Exception&)
 251     {
 252     }
 253 }
 254
 255 void SAL_CALL IFrameObject::close( sal_Bool /*bDeliverOwnership*/ )
 256 {
 257 }
 258
 259 void SAL_CALL IFrameObject::addCloseListener( const css::uno::Reference < css::util::XCloseListener >& )
 260 {
 261 }
 262
 263 void SAL_CALL IFrameObject::removeCloseListener( const css::uno::Reference < css::util::XCloseListener >& )
 264 {
 265 }
 266
 267 void SAL_CALL IFrameObject::disposing( const css::lang::EventObject& )
 268 {
 269     cancel();
 270 }
 271
 272 uno::Reference< beans::XPropertySetInfo > SAL_CALL IFrameObject::getPropertySetInfo()
 273 {
 274     static uno::Reference< beans::XPropertySetInfo > xInfo = new SfxItemPropertySetInfo( maPropMap );
 275     return xInfo;
 276 }
 277
 278 void SAL_CALL IFrameObject::setPropertyValue(const OUString& aPropertyName, const uno::Any& aAny)
 279 {
 280     const SfxItemPropertyMapEntry* pEntry = maPropMap.getByName( aPropertyName );
 281     if( !pEntry )
 282          throw beans::UnknownPropertyException(aPropertyName);
 283     switch( pEntry->nWID )
 284     {
 285     case WID_FRAME_URL:
 286     {
 287         OUString aURL;
 288         aAny >>= aURL;
 289         maFrmDescr.SetURL( aURL );
 290     }
 291     break;
 292     case WID_FRAME_NAME:
 293     {
 294         OUString aName;
 295         if ( aAny >>= aName )
 296             maFrmDescr.SetName( aName );
 297     }
 298     break;
 299     case WID_FRAME_IS_AUTO_SCROLL:
 300     {
 301         bool bIsAutoScroll;
 302         if ( (aAny >>= bIsAutoScroll) && bIsAutoScroll )
 303             maFrmDescr.SetScrollingMode( ScrollingMode::Auto );
 304     }
 305     break;
 306     case WID_FRAME_IS_SCROLLING_MODE:
 307     {
 308         bool bIsScroll;
 309         if ( aAny >>= bIsScroll )
 310             maFrmDescr.SetScrollingMode( bIsScroll ? ScrollingMode::Yes : ScrollingMode::No );
 311     }
 312     break;
 313     case WID_FRAME_IS_BORDER:
 314     {
 315         bool bIsBorder;
 316         if ( aAny >>= bIsBorder )
 317             maFrmDescr.SetFrameBorder( bIsBorder );
 318     }
 319     break;
 320     case WID_FRAME_IS_AUTO_BORDER:
 321     {
 322         bool bIsAutoBorder;
 323         if ( aAny >>= bIsAutoBorder )
 324         {
 325             bool bBorder = maFrmDescr.IsFrameBorderOn();
 326             maFrmDescr.ResetBorder();
 327             if ( bIsAutoBorder )
 328                 maFrmDescr.SetFrameBorder( bBorder );
 329         }
 330     }
 331     break;
 332     case WID_FRAME_MARGIN_WIDTH:
 333     {
 334         sal_Int32 nMargin = 0;
 335         Size aSize = maFrmDescr.GetMargin();
 336         if ( aAny >>= nMargin )
 337         {
 338             aSize.setWidth( nMargin );
 339             maFrmDescr.SetMargin( aSize );
 340         }
 341     }
 342     break;
 343     case WID_FRAME_MARGIN_HEIGHT:
 344     {
 345         sal_Int32 nMargin = 0;
 346         Size aSize = maFrmDescr.GetMargin();
 347         if ( aAny >>= nMargin )
 348         {
 349             aSize.setHeight( nMargin );
 350             maFrmDescr.SetMargin( aSize );
 351         }
 352     }
 353     break;
 354     default: ;
 355     }
 356 }
 357
 358 uno::Any SAL_CALL IFrameObject::getPropertyValue(const OUString& aPropertyName)
 359 {
 360     const SfxItemPropertyMapEntry* pEntry = maPropMap.getByName( aPropertyName );
 361     if( !pEntry )
 362          throw beans::UnknownPropertyException(aPropertyName);
 363     uno::Any aAny;
 364     switch( pEntry->nWID )
 365     {
 366     case WID_FRAME_URL:
 367     {
 368         aAny <<= maFrmDescr.GetURL().GetMainURL( INetURLObject::DecodeMechanism::NONE );
 369     }
 370     break;
 371     case WID_FRAME_NAME:
 372     {
 373         aAny <<= maFrmDescr.GetName();
 374     }
 375     break;
 376     case WID_FRAME_IS_AUTO_SCROLL:
 377     {
 378         bool bIsAutoScroll = ( maFrmDescr.GetScrollingMode() == ScrollingMode::Auto );
 379         aAny <<= bIsAutoScroll;
 380     }
 381     break;
 382     case WID_FRAME_IS_SCROLLING_MODE:
 383     {
 384         bool bIsScroll = ( maFrmDescr.GetScrollingMode() == ScrollingMode::Yes );
 385         aAny <<= bIsScroll;
 386     }
 387     break;
 388     case WID_FRAME_IS_BORDER:
 389     {
 390         bool bIsBorder = maFrmDescr.IsFrameBorderOn();
 391         aAny <<= bIsBorder;
 392     }
 393     break;
 394     case WID_FRAME_IS_AUTO_BORDER:
 395     {
 396         bool bIsAutoBorder = !maFrmDescr.IsFrameBorderSet();
 397         aAny <<= bIsAutoBorder;
 398     }
 399     break;
 400     case WID_FRAME_MARGIN_WIDTH:
 401     {
 402         aAny <<= static_cast<sal_Int32>(maFrmDescr.GetMargin().Width());
 403     }
 404     break;
 405     case WID_FRAME_MARGIN_HEIGHT:
 406     {
 407         aAny <<= static_cast<sal_Int32>(maFrmDescr.GetMargin().Height());
 408     }
 409     break;
 410     default: ;
 411     }
 412     return aAny;
 413 }
 414
 415 void SAL_CALL IFrameObject::addPropertyChangeListener(const OUString&, const css::uno::Reference< css::beans::XPropertyChangeListener > & )
 416 {
 417 }
 418
 419 void SAL_CALL IFrameObject::removePropertyChangeListener(const OUString&, const css::uno::Reference< css::beans::XPropertyChangeListener > & )
 420 {
 421 }
 422
 423 void SAL_CALL IFrameObject::addVetoableChangeListener(const OUString&, const css::uno::Reference< css::beans::XVetoableChangeListener > & )
 424 {
 425 }
 426
 427 void SAL_CALL IFrameObject::removeVetoableChangeListener(const OUString&, const css::uno::Reference< css::beans::XVetoableChangeListener > & )
 428 {
 429 }
 430
 431 ::sal_Int16 SAL_CALL IFrameObject::execute()
 432 {
 433     SfxAbstractDialogFactory* pFact = SfxAbstractDialogFactory::Create();
 434     //we really should set a parent here
 435     ScopedVclPtr<VclAbstractDialog> pDlg(pFact->CreateEditObjectDialog(nullptr, u".uno:InsertObjectFloatingFrame"_ustr, mxObj));
 436     pDlg->Execute();
 437     return 0;
 438 }
 439
 440 void SAL_CALL IFrameObject::setTitle( const OUString& )
 441 {
 442 }
 443
 444 }
 445
 446 extern "C" SAL_DLLPUBLIC_EXPORT css::uno::XInterface *
 447 com_sun_star_comp_sfx2_IFrameObject_get_implementation(
 448     css::uno::XComponentContext *context,
 449     css::uno::Sequence<css::uno::Any> const &arguments)
 450 {
 451     return cppu::acquire(new IFrameObject(context, arguments));
 452 }
 453
 454 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */