sfx2/source/appl/lnkbase2.cxx

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