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