sw/source/core/fields/ddefld.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 <o3tl/any.hxx>
  23 #include <osl/diagnose.h>
  24 #include <osl/thread.h>
  25 #include <rtl/ustrbuf.hxx>
  26 #include <sfx2/linkmgr.hxx>
  27 #include <sot/exchange.hxx>
  28 #include <doc.hxx>
  29 #include <IDocumentLinksAdministration.hxx>
  30 #include <IDocumentState.hxx>
  31 #include <IDocumentLayoutAccess.hxx>
  32 #include <editsh.hxx>
  33 #include <fmtfld.hxx>
  34 #include <ddefld.hxx>
  35 #include <swddetbl.hxx>
  36 #include <swbaslnk.hxx>
  37 #include <unofldmid.h>
  38 #include <hints.hxx>
  39 #include <calbck.hxx>
  40
  41 using namespace ::com::sun::star;
  42
  43 #define DDE_TXT_ENCODING    osl_getThreadTextEncoding()
  44
  45 namespace {
  46
  47 class SwIntrnlRefLink : public SwBaseLink
  48 {
  49     SwDDEFieldType& m_rFieldType;
  50
  51 public:
  52     SwIntrnlRefLink(SwDDEFieldType& rType, SfxLinkUpdateMode nUpdateType)
  53         : SwBaseLink(nUpdateType, SotClipboardFormatId::STRING)
  54         , m_rFieldType(rType)
  55     {}
  56
  57     virtual void Closed() override;
  58     virtual ::sfx2::SvBaseLink::UpdateResult DataChanged(
  59         const OUString& rMimeType, const css::uno::Any & rValue ) override;
  60
  61     virtual const SwNode* GetAnchor() const override;
  62     virtual bool IsInRange( sal_uLong nSttNd, sal_uLong nEndNd ) const override;
  63 };
  64
  65 }
  66
  67 ::sfx2::SvBaseLink::UpdateResult SwIntrnlRefLink::DataChanged( const OUString& rMimeType,
  68                                 const uno::Any & rValue )
  69 {
  70     switch( SotExchange::GetFormatIdFromMimeType( rMimeType ) )
  71     {
  72     case SotClipboardFormatId::STRING:
  73         if( !IsNoDataFlag() )
  74         {
  75             uno::Sequence< sal_Int8 > aSeq;
  76             rValue >>= aSeq;
  77             OUString sStr( reinterpret_cast<char const *>(aSeq.getConstArray()), aSeq.getLength(), DDE_TXT_ENCODING );
  78
  79             // remove not needed CR-LF at the end
  80             sal_Int32 n = sStr.getLength();
  81             while( n && 0 == sStr[ n-1 ] )
  82                 --n;
  83             if( n && 0x0a == sStr[ n-1 ] )
  84                 --n;
  85             if( n && 0x0d == sStr[ n-1 ] )
  86                 --n;
  87
  88             bool bDel = n != sStr.getLength();
  89             if( bDel )
  90                 sStr = sStr.copy( 0, n );
  91
  92             m_rFieldType.SetExpansion(sStr);
  93             // set Expansion first! (otherwise this flag will be deleted)
  94             m_rFieldType.SetCRLFDelFlag(bDel);
  95         }
  96         break;
  97
  98     // other formats
  99     default:
 100         return SUCCESS;
 101     }
 102
 103     OSL_ENSURE(m_rFieldType.GetDoc(), "no pDoc");
 104
 105     // no dependencies left?
 106     if (!m_rFieldType.IsModifyLocked() && !ChkNoDataFlag())
 107     {
 108         SwViewShell* pSh = m_rFieldType.GetDoc()->getIDocumentLayoutAccess().GetCurrentViewShell();
 109         SwEditShell* pESh = m_rFieldType.GetDoc()->GetEditShell();
 110
 111         // Search for fields. If no valid found, disconnect.
 112         SwMsgPoolItem aUpdateDDE( RES_UPDATEDDETBL );
 113         m_rFieldType.LockModify();
 114
 115         std::vector<SwFormatField*> vFields;
 116         std::vector<SwDDETable*> vTables;
 117         m_rFieldType.GatherFields(vFields, false);
 118         m_rFieldType.GatherDdeTables(vTables);
 119         const bool bDoAction = vFields.size() || vTables.size();
 120         if(bDoAction)
 121         {
 122             if(pESh)
 123                 pESh->StartAllAction();
 124             else if(pSh)
 125                 pSh->StartAction();
 126         }
 127
 128         // DDE fields attribute in the text
 129         for(auto pFormatField: vFields)
 130         {
 131             if(pFormatField->GetTextField())
 132                 pFormatField->UpdateTextNode( nullptr, &aUpdateDDE );
 133         }
 134         // a DDE tables in the text
 135         for(auto pTable: vTables)
 136             pTable->ChangeContent();
 137
 138         m_rFieldType.UnlockModify();
 139
 140         if(bDoAction)
 141         {
 142             if(pESh)
 143                 pESh->EndAllAction();
 144             else if(pSh)
 145                 pSh->EndAction();
 146
 147             if(pSh)
 148                 pSh->GetDoc()->getIDocumentState().SetModified();
 149         }
 150     }
 151
 152     return SUCCESS;
 153 }
 154
 155 void SwIntrnlRefLink::Closed()
 156 {
 157     if (m_rFieldType.GetDoc() && !m_rFieldType.GetDoc()->IsInDtor())
 158     {
 159         // advise goes, convert all fields into text?
 160         SwViewShell* pSh = m_rFieldType.GetDoc()->getIDocumentLayoutAccess().GetCurrentViewShell();
 161         SwEditShell* pESh = m_rFieldType.GetDoc()->GetEditShell();
 162         if( pESh )
 163         {
 164             pESh->StartAllAction();
 165             pESh->FieldToText(&m_rFieldType);
 166             pESh->EndAllAction();
 167         }
 168         else
 169         {
 170             pSh->StartAction();
 171             // to call at the doc ??
 172             pSh->EndAction();
 173         }
 174     }
 175     SvBaseLink::Closed();
 176 }
 177
 178 sw::LinkAnchorSearchHint::~LinkAnchorSearchHint() {};
 179
 180 const SwNode* SwIntrnlRefLink::GetAnchor() const
 181 {
 182     // here, any anchor of the normal NodesArray should be sufficient
 183     const SwNode* pNd = nullptr;
 184     m_rFieldType.CallSwClientNotify(
 185         sw::LinkAnchorSearchHint(m_rFieldType.GetDoc()->GetNodes(), pNd));
 186     return pNd;
 187 }
 188
 189 bool SwIntrnlRefLink::IsInRange( sal_uLong nSttNd, sal_uLong nEndNd ) const
 190 {
 191     bool bInRange = false;
 192     m_rFieldType.CallSwClientNotify(sw::InRangeSearchHint(nSttNd, nEndNd, bInRange));
 193     return bInRange;
 194 }
 195
 196 SwDDEFieldType::SwDDEFieldType(const OUString& rName,
 197                                const OUString& rCmd, SfxLinkUpdateMode nUpdateType )
 198     : SwFieldType( SwFieldIds::Dde ),
 199     m_aName( rName ), m_pDoc( nullptr ), m_nRefCount( 0 )
 200 {
 201     m_bCRLFFlag = m_bDeleted = false;
 202     m_RefLink = new SwIntrnlRefLink( *this, nUpdateType );
 203     SetCmd( rCmd );
 204 }
 205
 206 SwDDEFieldType::~SwDDEFieldType()
 207 {
 208     if( m_pDoc && !m_pDoc->IsInDtor() )
 209         m_pDoc->getIDocumentLinksAdministration().GetLinkManager().Remove( m_RefLink.get() );
 210     m_RefLink->Disconnect();
 211 }
 212
 213 std::unique_ptr<SwFieldType> SwDDEFieldType::Copy() const
 214 {
 215     std::unique_ptr<SwDDEFieldType> pType(new SwDDEFieldType( m_aName, GetCmd(), GetType() ));
 216     pType->m_aExpansion = m_aExpansion;
 217     pType->m_bCRLFFlag = m_bCRLFFlag;
 218     pType->m_bDeleted = m_bDeleted;
 219     pType->SetDoc( m_pDoc );
 220     return pType;
 221 }
 222
 223 OUString SwDDEFieldType::GetName() const
 224 {
 225     return m_aName;
 226 }
 227
 228 void SwDDEFieldType::SetCmd( const OUString& _aStr )
 229 {
 230     OUString aStr = _aStr;
 231     sal_Int32 nIndex = 0;
 232     do
 233     {
 234         aStr = aStr.replaceFirst("  ", " ", &nIndex);
 235     } while (nIndex>=0);
 236     m_RefLink->SetLinkSourceName( aStr );
 237 }
 238
 239 OUString const & SwDDEFieldType::GetCmd() const
 240 {
 241     return m_RefLink->GetLinkSourceName();
 242 }
 243
 244 void SwDDEFieldType::SetDoc( SwDoc* pNewDoc )
 245 {
 246     if( pNewDoc == m_pDoc )
 247         return;
 248
 249     if( m_pDoc && m_RefLink.is() )
 250     {
 251         OSL_ENSURE( !m_nRefCount, "How do we get the references?" );
 252         m_pDoc->getIDocumentLinksAdministration().GetLinkManager().Remove( m_RefLink.get() );
 253     }
 254
 255     m_pDoc = pNewDoc;
 256     if( m_pDoc && m_nRefCount )
 257     {
 258         m_RefLink->SetVisible( m_pDoc->getIDocumentLinksAdministration().IsVisibleLinks() );
 259         m_pDoc->getIDocumentLinksAdministration().GetLinkManager().InsertDDELink( m_RefLink.get() );
 260     }
 261 }
 262
 263 void SwDDEFieldType::RefCntChgd()
 264 {
 265     if( m_nRefCount )
 266     {
 267         m_RefLink->SetVisible( m_pDoc->getIDocumentLinksAdministration().IsVisibleLinks() );
 268         m_pDoc->getIDocumentLinksAdministration().GetLinkManager().InsertDDELink( m_RefLink.get() );
 269         if( m_pDoc->getIDocumentLayoutAccess().GetCurrentViewShell() )
 270             m_RefLink->Update();
 271     }
 272     else
 273     {
 274         Disconnect();
 275         m_pDoc->getIDocumentLinksAdministration().GetLinkManager().Remove( m_RefLink.get() );
 276     }
 277 }
 278
 279 void SwDDEFieldType::QueryValue( uno::Any& rVal, sal_uInt16 nWhichId ) const
 280 {
 281     sal_Int32 nPart = -1;
 282     switch( nWhichId )
 283     {
 284     case FIELD_PROP_PAR2:      nPart = 2; break;
 285     case FIELD_PROP_PAR4:      nPart = 1; break;
 286     case FIELD_PROP_SUBTYPE:   nPart = 0; break;
 287     case FIELD_PROP_BOOL1:
 288         rVal <<= GetType() == SfxLinkUpdateMode::ALWAYS;
 289         break;
 290     case FIELD_PROP_PAR5:
 291         rVal <<= m_aExpansion;
 292         break;
 293     default:
 294         assert(false);
 295     }
 296     if ( nPart>=0 )
 297         rVal <<= GetCmd().getToken(nPart, sfx2::cTokenSeparator);
 298 }
 299
 300 void SwDDEFieldType::PutValue( const uno::Any& rVal, sal_uInt16 nWhichId )
 301 {
 302     sal_Int32 nPart = -1;
 303     switch( nWhichId )
 304     {
 305     case FIELD_PROP_PAR2:      nPart = 2; break;
 306     case FIELD_PROP_PAR4:      nPart = 1; break;
 307     case FIELD_PROP_SUBTYPE:   nPart = 0; break;
 308     case FIELD_PROP_BOOL1:
 309         SetType( *o3tl::doAccess<bool>(rVal) ?
 310                  SfxLinkUpdateMode::ALWAYS :
 311                  SfxLinkUpdateMode::ONCALL );
 312         break;
 313     case FIELD_PROP_PAR5:
 314         rVal >>= m_aExpansion;
 315         break;
 316     default:
 317         assert(false);
 318     }
 319     if( nPart<0 )
 320         return;
 321
 322     const OUString sOldCmd( GetCmd() );
 323     OUStringBuffer sNewCmd;
 324     sal_Int32 nIndex = 0;
 325     for (sal_Int32 i=0; i<3; ++i)
 326     {
 327         OUString sToken = sOldCmd.getToken(0, sfx2::cTokenSeparator, nIndex);
 328         if (i==nPart)
 329         {
 330             rVal >>= sToken;
 331         }
 332         sNewCmd.append((i < 2)
 333             ? sToken + OUStringChar(sfx2::cTokenSeparator) : sToken);
 334     }
 335     SetCmd( sNewCmd.makeStringAndClear() );
 336 }
 337
 338 SwDDEField::SwDDEField( SwDDEFieldType* pInitType )
 339     : SwField(pInitType)
 340 {
 341 }
 342
 343 SwDDEField::~SwDDEField()
 344 {
 345     if( GetTyp()->HasOnlyOneListener() )
 346         static_cast<SwDDEFieldType*>(GetTyp())->Disconnect();
 347 }
 348
 349 OUString SwDDEField::ExpandImpl(SwRootFrame const*const) const
 350 {
 351     OUString aStr = static_cast<SwDDEFieldType*>(GetTyp())->GetExpansion();
 352     aStr = aStr.replaceAll("\r", "");
 353     aStr = aStr.replaceAll("\t", " ");
 354     aStr = aStr.replaceAll("\n", "|");
 355     if (aStr.endsWith("|"))
 356     {
 357         return aStr.copy(0, aStr.getLength()-1);
 358     }
 359     return aStr;
 360 }
 361
 362 std::unique_ptr<SwField> SwDDEField::Copy() const
 363 {
 364     return std::make_unique<SwDDEField>(static_cast<SwDDEFieldType*>(GetTyp()));
 365 }
 366
 367 /// get field type name
 368 OUString SwDDEField::GetPar1() const
 369 {
 370     return static_cast<const SwDDEFieldType*>(GetTyp())->GetName();
 371 }
 372
 373 /// get field type command
 374 OUString SwDDEField::GetPar2() const
 375 {
 376     return static_cast<const SwDDEFieldType*>(GetTyp())->GetCmd();
 377 }
 378
 379 /// set field type command
 380 void SwDDEField::SetPar2(const OUString& rStr)
 381 {
 382     static_cast<SwDDEFieldType*>(GetTyp())->SetCmd(rStr);
 383 }
 384
 385 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */