sfx2/source/appl/lnkbase2.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
  21 #include <memory>
  22 #include <sfx2/lnkbase.hxx>
  23 #include <sot/exchange.hxx>
  24 #include <com/sun/star/uno/Any.hxx>
  25 #include <com/sun/star/uno/Sequence.hxx>
  26 #include <com/sun/star/ui/dialogs/TemplateDescription.hpp>
  27 #include <sfx2/linkmgr.hxx>
  28 #include <vcl/svapp.hxx>
  29 #include <vcl/weld.hxx>
  30 #include <sfx2/strings.hrc>
  31 #include <sfx2/sfxresid.hxx>
  32 #include <sfx2/filedlghelper.hxx>
  33 #include <tools/debug.hxx>
  34 #include <svl/svdde.hxx>
  35 #include <osl/diagnose.h>
  36 #include <officecfg/Office/Common.hxx>
  37
  38 using namespace ::com::sun::star;
  39 using namespace ::com::sun::star::uno;
  40
  41 namespace sfx2
  42 {
  43
  44 namespace {
  45 class ImplDdeItem;
  46 }
  47
  48 // only for internal management
  49 struct ImplBaseLinkData
  50 {
  51     struct tClientType
  52     {
  53         // applies for all links
  54         SotClipboardFormatId nCntntType; // Update Format
  55         // Not Ole-Links
  56         bool                 bIntrnlLnk;  // It is an internal link
  57         SfxLinkUpdateMode    nUpdateMode; // UpdateMode
  58     };
  59
  60     struct tDDEType
  61     {
  62         ImplDdeItem* pItem;
  63     };
  64
  65     union {
  66         tClientType ClientType;
  67         tDDEType DDEType;
  68     };
  69     ImplBaseLinkData()
  70     {
  71         ClientType.nCntntType = SotClipboardFormatId::NONE;
  72         ClientType.bIntrnlLnk = false;
  73         ClientType.nUpdateMode = SfxLinkUpdateMode::NONE;
  74         DDEType.pItem = nullptr;
  75     }
  76 };
  77
  78 namespace {
  79
  80 class ImplDdeItem : public DdeGetPutItem
  81 {
  82     SvBaseLink* pLink;
  83     DdeData aData;
  84     Sequence< sal_Int8 > aSeq;  // Datacontainer for DdeData !!!
  85     bool bIsValidData : 1;
  86     bool bIsInDTOR : 1;
  87 public:
  88 #if defined(_WIN32)
  89     ImplDdeItem( SvBaseLink& rLink, const OUString& rStr )
  90         : DdeGetPutItem( rStr ), pLink( &rLink ), bIsValidData( false ),
  91         bIsInDTOR( false )
  92     {}
  93 #endif
  94     virtual ~ImplDdeItem() override;
  95
  96     virtual DdeData* Get( SotClipboardFormatId ) override;
  97     virtual bool     Put( const DdeData* ) override;
  98     virtual void     AdviseLoop( bool ) override;
  99
 100     void Notify()
 101     {
 102         bIsValidData = false;
 103         DdeGetPutItem::NotifyClient();
 104     }
 105
 106     bool IsInDTOR() const { return bIsInDTOR; }
 107 };
 108
 109 }
 110
 111 SvBaseLink::SvBaseLink()
 112     : m_pLinkMgr( nullptr )
 113     , m_pParentWin( nullptr )
 114     , m_bIsConnect( false )
 115     , m_bIsReadOnly(false)
 116 {
 117     mnObjType = SvBaseLinkObjectType::ClientSo;
 118     pImplData.reset( new ImplBaseLinkData );
 119     bVisible = bSynchron = true;
 120     bWasLastEditOK = false;
 121 }
 122
 123
 124 SvBaseLink::SvBaseLink( SfxLinkUpdateMode nUpdateMode, SotClipboardFormatId nContentType )
 125     : m_pLinkMgr( nullptr )
 126     , m_pParentWin( nullptr )
 127     , m_bIsConnect( false )
 128     , m_bIsReadOnly(false)
 129 {
 130     mnObjType = SvBaseLinkObjectType::ClientSo;
 131     pImplData.reset( new ImplBaseLinkData );
 132     bVisible = bSynchron = true;
 133     bWasLastEditOK = false;
 134
 135     // It is going to be an OLE-Link,
 136     pImplData->ClientType.nUpdateMode = nUpdateMode;
 137     pImplData->ClientType.nCntntType = nContentType;
 138     pImplData->ClientType.bIntrnlLnk = false;
 139 }
 140
 141 #if defined(_WIN32)
 142
 143 static DdeTopic* FindTopic( const OUString & rLinkName, sal_uInt16* pItemStt )
 144 {
 145     if( rLinkName.isEmpty() )
 146         return nullptr;
 147
 148     OUString sNm( rLinkName );
 149     sal_Int32 nTokenPos = 0;
 150     OUString sService( sNm.getToken( 0, cTokenSeparator, nTokenPos ) );
 151
 152     DdeServices& rSvc = DdeService::GetServices();
 153     for (auto const& elem : rSvc)
 154     {
 155         if(elem->GetName() == sService)
 156         {
 157             // then we search for the Topic
 158             OUString sTopic( sNm.getToken( 0, cTokenSeparator, nTokenPos ) );
 159             if( pItemStt )
 160                 *pItemStt = nTokenPos;
 161
 162             std::vector<DdeTopic*>& rTopics = elem->GetTopics();
 163
 164             for (auto const& topic : rTopics)
 165                 if( topic->GetName() == sTopic )
 166                     return topic;
 167             break;
 168         }
 169     }
 170     return nullptr;
 171 }
 172
 173 SvBaseLink::SvBaseLink( const OUString& rLinkName, SvBaseLinkObjectType nObjectType, SvLinkSource* pObj )
 174     : m_pLinkMgr( nullptr )
 175     , m_pParentWin( nullptr )
 176     , m_bIsConnect( false )
 177     , m_bIsReadOnly(false)
 178 {
 179     bVisible = bSynchron = true;
 180     bWasLastEditOK = false;
 181     aLinkName = rLinkName;
 182     pImplData.reset( new ImplBaseLinkData );
 183     mnObjType = nObjectType;
 184
 185     if( !pObj )
 186     {
 187         DBG_ASSERT( pObj, "Where is my left-most object" );
 188         return;
 189     }
 190
 191     if( SvBaseLinkObjectType::DdeExternal == mnObjType )
 192     {
 193         sal_uInt16 nItemStt = 0;
 194         DdeTopic* pTopic = FindTopic( aLinkName, &nItemStt );
 195         if( pTopic )
 196         {
 197             // then we have it all together
 198             // MM_TODO how do I get the name
 199             OUString aStr = aLinkName; // xLinkName->GetDisplayName();
 200             aStr = aStr.copy( nItemStt );
 201             pImplData->DDEType.pItem = new ImplDdeItem( *this, aStr );
 202             pTopic->InsertItem( pImplData->DDEType.pItem );
 203
 204             // store the Advice
 205             xObj = pObj;
 206         }
 207     }
 208     else if( pObj->Connect( this ) )
 209         xObj = pObj;
 210 }
 211
 212 #endif
 213
 214 SvBaseLink::~SvBaseLink()
 215 {
 216     Disconnect();
 217
 218     if( mnObjType == SvBaseLinkObjectType::DdeExternal )
 219     {
 220         if( !pImplData->DDEType.pItem->IsInDTOR() )
 221             delete pImplData->DDEType.pItem;
 222     }
 223
 224     pImplData.reset();
 225 }
 226
 227 IMPL_LINK( SvBaseLink, EndEditHdl, const OUString&, _rNewName, void )
 228 {
 229     OUString sNewName = _rNewName;
 230     if ( !ExecuteEdit( sNewName ) )
 231         sNewName.clear();
 232     bWasLastEditOK = !sNewName.isEmpty();
 233     m_aEndEditLink.Call( *this );
 234 }
 235
 236
 237 void SvBaseLink::SetObjType( SvBaseLinkObjectType mnObjTypeP )
 238 {
 239     DBG_ASSERT( mnObjType != SvBaseLinkObjectType::ClientDde, "type already set" );
 240     DBG_ASSERT( !xObj.is(), "object exist" );
 241
 242     mnObjType = mnObjTypeP;
 243 }
 244
 245
 246 void SvBaseLink::SetName( const OUString & rNm )
 247 {
 248     aLinkName = rNm;
 249 }
 250
 251
 252 void SvBaseLink::SetObj( SvLinkSource * pObj )
 253 {
 254     DBG_ASSERT( (isClientType(mnObjType) &&
 255                  pImplData->ClientType.bIntrnlLnk) ||
 256                 mnObjType == SvBaseLinkObjectType::ClientGraphic,
 257                 "no intern link" );
 258     xObj = pObj;
 259 }
 260
 261
 262 void SvBaseLink::SetLinkSourceName( const OUString & rLnkNm )
 263 {
 264     if( aLinkName == rLnkNm )
 265         return;
 266
 267     AddNextRef(); // should be superfluous
 268     // remove old connection
 269     Disconnect();
 270
 271     aLinkName = rLnkNm;
 272
 273     // New Connection
 274     GetRealObject_();
 275     ReleaseRef(); // should be superfluous
 276 }
 277
 278
 279 void SvBaseLink::SetUpdateMode( SfxLinkUpdateMode nMode )
 280 {
 281     if( isClientType(mnObjType) &&
 282         pImplData->ClientType.nUpdateMode != nMode )
 283     {
 284         AddNextRef();
 285         Disconnect();
 286
 287         pImplData->ClientType.nUpdateMode = nMode;
 288         GetRealObject_();
 289         ReleaseRef();
 290     }
 291 }
 292
 293 // #i88291#
 294 void SvBaseLink::clearStreamToLoadFrom()
 295 {
 296     m_xInputStreamToLoadFrom.clear();
 297     if( xObj.is() )
 298     {
 299         xObj->clearStreamToLoadFrom();
 300     }
 301 }
 302
 303 bool SvBaseLink::Update()
 304 {
 305     if(officecfg::Office::Common::Security::Scripting::DisableActiveContent::get())
 306         return false;
 307
 308     if( isClientType(mnObjType) )
 309     {
 310         AddNextRef();
 311         Disconnect();
 312
 313         GetRealObject_();
 314         ReleaseRef();
 315         if( xObj.is() )
 316         {
 317             xObj->setStreamToLoadFrom(m_xInputStreamToLoadFrom,m_bIsReadOnly);
 318             OUString sMimeType( SotExchange::GetFormatMimeType(
 319                             pImplData->ClientType.nCntntType ));
 320             Any aData;
 321
 322             if( xObj->GetData( aData, sMimeType ) )
 323             {
 324                 UpdateResult eRes = DataChanged(sMimeType, aData);
 325                 bool bSuccess = eRes == SUCCESS;
 326                 //for manual Updates there is no need to hold the ServerObject
 327                 if( SvBaseLinkObjectType::ClientDde == mnObjType &&
 328                     SfxLinkUpdateMode::ONCALL == GetUpdateMode() && xObj.is() )
 329                     xObj->RemoveAllDataAdvise( this );
 330                 return bSuccess;
 331             }
 332             if( xObj.is() )
 333             {
 334                 // should be asynchronous?
 335                 if( xObj->IsPending() )
 336                     return true;
 337
 338                 // we do not need the object anymore
 339                 AddNextRef();
 340                 Disconnect();
 341                 ReleaseRef();
 342             }
 343         }
 344     }
 345     return false;
 346 }
 347
 348
 349 SfxLinkUpdateMode SvBaseLink::GetUpdateMode() const
 350 {
 351     return isClientType(mnObjType)
 352             ? pImplData->ClientType.nUpdateMode
 353             : SfxLinkUpdateMode::ONCALL;
 354 }
 355
 356
 357 void SvBaseLink::GetRealObject_( bool bConnect)
 358 {
 359     if( !m_pLinkMgr )
 360         return;
 361
 362     DBG_ASSERT( !xObj.is(), "object already exist" );
 363
 364     if( SvBaseLinkObjectType::ClientDde == mnObjType )
 365     {
 366         OUString sServer;
 367         if( sfx2::LinkManager::GetDisplayNames( this, &sServer ) &&
 368             sServer == Application::GetAppName() )  // internal Link !!!
 369         {
 370             // so that the Internal link can be created!
 371             mnObjType = SvBaseLinkObjectType::Internal;
 372             xObj = sfx2::LinkManager::CreateObj( this );
 373
 374             pImplData->ClientType.bIntrnlLnk = true;
 375             mnObjType = SvBaseLinkObjectType::ClientDde;  // so we know what it once was!
 376         }
 377         else
 378         {
 379             pImplData->ClientType.bIntrnlLnk = false;
 380             xObj = sfx2::LinkManager::CreateObj( this );
 381         }
 382     }
 383     else if( isClientType(mnObjType) )
 384         xObj = sfx2::LinkManager::CreateObj( this );
 385
 386     if( bConnect && ( !xObj.is() || !xObj->Connect( this ) ) )
 387         Disconnect();
 388 }
 389
 390 SotClipboardFormatId SvBaseLink::GetContentType() const
 391 {
 392     if( isClientType(mnObjType) )
 393         return pImplData->ClientType.nCntntType;
 394
 395     return SotClipboardFormatId::NONE;  // all Formats ?
 396 }
 397
 398
 399 void SvBaseLink::SetContentType( SotClipboardFormatId nType )
 400 {
 401     if( isClientType(mnObjType) )
 402     {
 403         pImplData->ClientType.nCntntType = nType;
 404     }
 405 }
 406
 407 LinkManager* SvBaseLink::GetLinkManager()
 408 {
 409     return m_pLinkMgr;
 410 }
 411
 412 const LinkManager* SvBaseLink::GetLinkManager() const
 413 {
 414     return m_pLinkMgr;
 415 }
 416
 417 void SvBaseLink::SetLinkManager( LinkManager* _pMgr )
 418 {
 419     m_pLinkMgr = _pMgr;
 420 }
 421
 422 void SvBaseLink::Disconnect()
 423 {
 424     if( xObj.is() )
 425     {
 426         xObj->RemoveAllDataAdvise( this );
 427         xObj->RemoveConnectAdvise( this );
 428         xObj.clear();
 429     }
 430 }
 431
 432 SvBaseLink::UpdateResult SvBaseLink::DataChanged( const OUString &, const css::uno::Any & )
 433 {
 434     if ( mnObjType == SvBaseLinkObjectType::DdeExternal )
 435     {
 436         if( pImplData->DDEType.pItem )
 437             pImplData->DDEType.pItem->Notify();
 438     }
 439     return SUCCESS;
 440 }
 441
 442 void SvBaseLink::Edit(weld::Window* pParent, const Link<SvBaseLink&,void>& rEndEditHdl )
 443 {
 444     m_pParentWin = pParent;
 445     m_aEndEditLink = rEndEditHdl;
 446     m_bIsConnect = xObj.is();
 447     if( !m_bIsConnect )
 448         GetRealObject_( xObj.is() );
 449
 450     bool bAsync = false;
 451     Link<const OUString&, void> aLink = LINK( this, SvBaseLink, EndEditHdl );
 452
 453     if( isClientType(mnObjType) && pImplData->ClientType.bIntrnlLnk )
 454     {
 455         if( m_pLinkMgr )
 456         {
 457             SvLinkSourceRef ref = sfx2::LinkManager::CreateObj( this );
 458             if( ref.is() )
 459             {
 460                 ref->Edit( pParent, this, aLink );
 461                 bAsync = true;
 462             }
 463         }
 464     }
 465     else
 466     {
 467         xObj->Edit( pParent, this, aLink );
 468         bAsync = true;
 469     }
 470
 471     if ( !bAsync )
 472     {
 473         ExecuteEdit( OUString() );
 474         bWasLastEditOK = false;
 475         m_aEndEditLink.Call( *this );
 476     }
 477 }
 478
 479 bool SvBaseLink::ExecuteEdit( const OUString& _rNewName )
 480 {
 481     if( !_rNewName.isEmpty() )
 482     {
 483         SetLinkSourceName( _rNewName );
 484         if( !Update() )
 485         {
 486             OUString sApp, sTopic, sItem, sError;
 487             sfx2::LinkManager::GetDisplayNames( this, &sApp, &sTopic, &sItem );
 488             if( mnObjType == SvBaseLinkObjectType::ClientDde )
 489             {
 490                 sError = SfxResId(STR_DDE_ERROR);
 491
 492                 sal_Int32 nFndPos = sError.indexOf( "%1" );
 493                 if( -1 != nFndPos )
 494                 {
 495                     sError = sError.replaceAt( nFndPos, 2, sApp );
 496                     nFndPos = nFndPos + sApp.getLength();
 497
 498                     if( -1 != ( nFndPos = sError.indexOf( "%2", nFndPos )))
 499                     {
 500                         sError = sError.replaceAt( nFndPos, 2, sTopic );
 501                         nFndPos = nFndPos + sTopic.getLength();
 502
 503                         if( -1 != ( nFndPos = sError.indexOf( "%3", nFndPos )))
 504                             sError = sError.replaceAt( nFndPos, 2, sItem );
 505                     }
 506                 }
 507             }
 508             else
 509                 return false;
 510
 511             std::unique_ptr<weld::MessageDialog> xBox(Application::CreateMessageDialog(m_pParentWin,
 512                                                                      VclMessageType::Warning, VclButtonsType::Ok, sError));
 513             xBox->run();
 514         }
 515     }
 516     else if( !m_bIsConnect )
 517         Disconnect();
 518     m_bIsConnect = false;
 519     return true;
 520 }
 521
 522 void SvBaseLink::Closed()
 523 {
 524     if( xObj.is() )
 525         xObj->RemoveAllDataAdvise( this );
 526 }
 527
 528 FileDialogHelper & SvBaseLink::GetInsertFileDialog(const OUString& rFactory)
 529 {
 530     m_pFileDlg.reset( new FileDialogHelper(
 531             ui::dialogs::TemplateDescription::FILEOPEN_SIMPLE,
 532             FileDialogFlags::Insert, rFactory, SfxFilterFlags::NONE, SfxFilterFlags::NONE, m_pParentWin) );
 533     return *m_pFileDlg;
 534 }
 535
 536 ImplDdeItem::~ImplDdeItem()
 537 {
 538     bIsInDTOR = true;
 539     // So that no-one gets the idea to delete the pointer when Disconnecting!
 540     tools::SvRef<SvBaseLink> aRef( pLink );
 541     aRef->Disconnect();
 542 }
 543
 544 DdeData* ImplDdeItem::Get( SotClipboardFormatId nFormat )
 545 {
 546     if( pLink->GetObj() )
 547     {
 548         // is it still valid?
 549         if( bIsValidData && nFormat == aData.GetFormat() )
 550             return &aData;
 551
 552         Any aValue;
 553         OUString sMimeType( SotExchange::GetFormatMimeType( nFormat ));
 554         if( pLink->GetObj()->GetData( aValue, sMimeType ) )
 555         {
 556             if( aValue >>= aSeq )
 557             {
 558                 aData = DdeData( aSeq.getConstArray(), aSeq.getLength(), nFormat );
 559
 560                 bIsValidData = true;
 561                 return &aData;
 562             }
 563         }
 564     }
 565     aSeq.realloc( 0 );
 566     bIsValidData = false;
 567     return nullptr;
 568 }
 569
 570
 571 bool ImplDdeItem::Put( const DdeData*  )
 572 {
 573     OSL_FAIL( "ImplDdeItem::Put not implemented" );
 574     return false;
 575 }
 576
 577
 578 void ImplDdeItem::AdviseLoop( bool bOpen )
 579 {
 580     // Connection is closed, so also unsubscribe link
 581     if( !pLink->GetObj() )
 582         return;
 583
 584     if( bOpen )
 585     {
 586         // A connection is re-established
 587         if( SvBaseLinkObjectType::DdeExternal == pLink->GetObjType() )
 588         {
 589             pLink->GetObj()->AddDataAdvise( pLink, u"text/plain;charset=utf-16"_ustr,  ADVISEMODE_NODATA );
 590             pLink->GetObj()->AddConnectAdvise( pLink );
 591         }
 592     }
 593     else
 594     {
 595         // So that no-one gets the idea to delete the pointer
 596         // when Disconnecting!
 597         tools::SvRef<SvBaseLink> aRef( pLink );
 598         aRef->Disconnect();
 599     }
 600 }
 601
 602 }
 603
 604 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */