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