1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <memory>
#include <sal/config.h>
#include <sal/log.hxx>
#include <cstddef>
#include "XMLRedlineImportHelper.hxx"
#include <unotextcursor.hxx>
#include <unotextrange.hxx>
#include <unocrsr.hxx>
#include <ndtxt.hxx>
#include <doc.hxx>
#include <IDocumentContentOperations.hxx>
#include <IDocumentStylePoolAccess.hxx>
#include <tools/datetime.hxx>
#include <poolfmt.hxx>
#include <fmtanchr.hxx>
#include <ftnidx.hxx>
#include <txtftn.hxx>
#include <unoredline.hxx>
#include <DocumentRedlineManager.hxx>
#include "xmlimp.hxx"
#include <comphelper/servicehelper.hxx>
#include <o3tl/any.hxx>
#include <xmloff/xmltoken.hxx>
#include <vcl/svapp.hxx>
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
using namespace ::xmloff::token;
using ::com::sun::star::text::XTextCursor;
using ::com::sun::star::text::XTextRange;
using ::com::sun::star::text::XWordCursor;
using ::com::sun::star::lang::XUnoTunnel;
using ::com::sun::star::beans::XPropertySet;
using ::com::sun::star::beans::XPropertySetInfo;
// collision with tools/DateTime: use UNO DateTime as util::DateTime
// using util::DateTime;
// a few helper functions
static SwDoc* lcl_GetDocViaTunnel( Reference<XTextCursor> const & rCursor )
{
Reference<XUnoTunnel> xTunnel( rCursor, UNO_QUERY);
OSL_ENSURE(xTunnel.is(), "missing XUnoTunnel for XTextCursor");
OTextCursorHelper *const pXCursor =
comphelper::getFromUnoTunnel<OTextCursorHelper>(xTunnel);
OSL_ENSURE( pXCursor, "OTextCursorHelper missing" );
return pXCursor ? pXCursor->GetDoc() : nullptr;
}
static SwDoc* lcl_GetDocViaTunnel( Reference<XTextRange> const & rRange )
{
Reference<XUnoTunnel> xTunnel(rRange, UNO_QUERY);
OSL_ENSURE(xTunnel.is(), "missing XUnoTunnel for XTextRange");
SwXTextRange *const pXRange =
comphelper::getFromUnoTunnel<SwXTextRange>(xTunnel);
// #i115174#: this may be a SvxUnoTextRange
// OSL_ENSURE( pXRange, "SwXTextRange missing" );
return pXRange ? &pXRange->GetDoc() : nullptr;
}
// XTextRangeOrNodeIndexPosition: store a position into the text
// *either* as an XTextRange or as an SwNodeIndex. The reason is that
// we must store either pointers to StartNodes (because redlines may
// start on start nodes) or to a text position, and there appears to
// be no existing type that could do both. Things are complicated by
// the matter that (e.g in section import) we delete a few characters,
// which may cause bookmarks (as used by XTextRange) to be deleted.
namespace {
class XTextRangeOrNodeIndexPosition
{
Reference<XTextRange> m_xRange;
std::unique_ptr<SwNodeIndex> m_pIndex; // pIndex will point to the *previous* node
public:
XTextRangeOrNodeIndexPosition();
void Set( Reference<XTextRange> const & rRange );
void Set( SwNodeIndex const & rIndex );
void SetAsNodeIndex( Reference<XTextRange> const & rRange );
void CopyPositionInto(SwPosition& rPos, SwDoc & rDoc);
SwDoc* GetDoc();
bool IsValid() const;
};
}
XTextRangeOrNodeIndexPosition::XTextRangeOrNodeIndexPosition()
{
}
void XTextRangeOrNodeIndexPosition::Set( Reference<XTextRange> const & rRange )
{
m_xRange = rRange->getStart(); // set bookmark
m_pIndex.reset();
}
void XTextRangeOrNodeIndexPosition::Set( SwNodeIndex const & rIndex )
{
m_pIndex.reset( new SwNodeIndex(rIndex) );
(*m_pIndex)-- ; // previous node!!!
m_xRange = nullptr;
}
void XTextRangeOrNodeIndexPosition::SetAsNodeIndex(
Reference<XTextRange> const & rRange )
{
// XTextRange -> XTunnel -> SwXTextRange
SwDoc* pDoc = lcl_GetDocViaTunnel(rRange);
if (!pDoc)
{
SAL_WARN("sw", "no SwDoc");
return;
}
// SwXTextRange -> PaM
SwUnoInternalPaM aPaM(*pDoc);
bool bSuccess = ::sw::XTextRangeToSwPaM(aPaM, rRange);
OSL_ENSURE(bSuccess, "illegal range");
// PaM -> Index
Set(aPaM.GetPoint()->nNode);
}
void
XTextRangeOrNodeIndexPosition::CopyPositionInto(SwPosition& rPos, SwDoc & rDoc)
{
OSL_ENSURE(IsValid(), "Can't get Position");
// create PAM from start cursor (if no node index is present)
if (nullptr == m_pIndex)
{
SwUnoInternalPaM aUnoPaM(rDoc);
bool bSuccess = ::sw::XTextRangeToSwPaM(aUnoPaM, m_xRange);
OSL_ENSURE(bSuccess, "illegal range");
rPos = *aUnoPaM.GetPoint();
}
else
{
rPos.nNode = *m_pIndex;
rPos.nNode++; // pIndex points to previous index !!!
rPos.nContent.Assign( rPos.nNode.GetNode().GetContentNode(), 0 );
}
}
SwDoc* XTextRangeOrNodeIndexPosition::GetDoc()
{
OSL_ENSURE(IsValid(), "Can't get Doc");
return (nullptr != m_pIndex) ? &m_pIndex->GetNodes().GetDoc() : lcl_GetDocViaTunnel(m_xRange);
}
bool XTextRangeOrNodeIndexPosition::IsValid() const
{
return ( m_xRange.is() || (m_pIndex != nullptr) );
}
// RedlineInfo: temporary storage for redline data
class RedlineInfo
{
public:
RedlineInfo();
~RedlineInfo();
// redline type (insert, delete, ...)
RedlineType eType;
// info fields:
OUString sAuthor; // change author string
OUString sComment; // change comment string
util::DateTime aDateTime; // change DateTime
bool bMergeLastParagraph; // the SwRangeRedline::IsDelLastPara flag
// each position can may be either empty, an XTextRange, or an SwNodeIndex
// start pos of anchor (may be empty)
XTextRangeOrNodeIndexPosition aAnchorStart;
// end pos of anchor (may be empty)
XTextRangeOrNodeIndexPosition aAnchorEnd;
// index of content node (maybe NULL)
SwNodeIndex* pContentIndex;
// next redline info (for hierarchical redlines)
RedlineInfo* pNextRedline;
// store whether we expect an adjustment for this redline
bool bNeedsAdjustment;
};
RedlineInfo::RedlineInfo() :
eType(RedlineType::Insert),
bMergeLastParagraph( false ),
pContentIndex(nullptr),
pNextRedline(nullptr),
bNeedsAdjustment( false )
{
}
RedlineInfo::~RedlineInfo()
{
delete pContentIndex;
delete pNextRedline;
}
constexpr OUStringLiteral g_sShowChanges = u"ShowChanges";
constexpr OUStringLiteral g_sRecordChanges = u"RecordChanges";
constexpr OUStringLiteral g_sRedlineProtectionKey = u"RedlineProtectionKey";
XMLRedlineImportHelper::XMLRedlineImportHelper(
SvXMLImport & rImport,
bool bNoRedlinesPlease,
const Reference<XPropertySet> & rModel,
const Reference<XPropertySet> & rImportInfo )
: m_rImport(rImport),
m_sInsertion( GetXMLToken( XML_INSERTION )),
m_sDeletion( GetXMLToken( XML_DELETION )),
m_sFormatChange( GetXMLToken( XML_FORMAT_CHANGE )),
m_bIgnoreRedlines(bNoRedlinesPlease),
m_xModelPropertySet(rModel),
m_xImportInfoPropertySet(rImportInfo)
{
// check to see if redline mode is handled outside of component
bool bHandleShowChanges = true;
bool bHandleRecordChanges = true;
bool bHandleProtectionKey = true;
if ( m_xImportInfoPropertySet.is() )
{
Reference<XPropertySetInfo> xInfo =
m_xImportInfoPropertySet->getPropertySetInfo();
bHandleShowChanges = ! xInfo->hasPropertyByName( g_sShowChanges );
bHandleRecordChanges = ! xInfo->hasPropertyByName( g_sRecordChanges );
bHandleProtectionKey = ! xInfo->hasPropertyByName( g_sRedlineProtectionKey );
}
// get redline mode
m_bShowChanges = *o3tl::doAccess<bool>(
( bHandleShowChanges ? m_xModelPropertySet : m_xImportInfoPropertySet )
->getPropertyValue( g_sShowChanges ));
m_bRecordChanges = *o3tl::doAccess<bool>(
( bHandleRecordChanges ? m_xModelPropertySet : m_xImportInfoPropertySet )
->getPropertyValue( g_sRecordChanges ));
{
Any aAny = (bHandleProtectionKey ? m_xModelPropertySet
: m_xImportInfoPropertySet )
->getPropertyValue( g_sRedlineProtectionKey );
aAny >>= m_aProtectionKey;
}
// set redline mode to "don't record changes"
if( bHandleRecordChanges )
{
m_xModelPropertySet->setPropertyValue( g_sRecordChanges, Any(false) );
}
}
XMLRedlineImportHelper::~XMLRedlineImportHelper()
{
// delete all left over (and obviously incomplete) RedlineInfos (and map)
for( const auto& rEntry : m_aRedlineMap )
{
RedlineInfo* pInfo = rEntry.second;
// left-over redlines. Insert them if possible (but assert),
// and delete the incomplete ones. Finally, delete it.
if( IsReady(pInfo) )
{
OSL_FAIL("forgotten RedlineInfo; now inserted");
InsertIntoDocument( pInfo );
}
else
{
// try if only the adjustment was missing
pInfo->bNeedsAdjustment = false;
if( IsReady(pInfo) )
{
OSL_FAIL("RedlineInfo without adjustment; now inserted");
InsertIntoDocument( pInfo );
}
else
{
// this situation occurs if redlines aren't closed
// (i.e. end without start, or start without
// end). This may well be a problem in the file,
// rather than the code.
OSL_FAIL("incomplete redline (maybe file was corrupt); "
"now deleted");
}
}
delete pInfo;
}
m_aRedlineMap.clear();
// set redline mode, either to info property set, or directly to
// the document
bool bHandleShowChanges = true;
bool bHandleRecordChanges = true;
bool bHandleProtectionKey = true;
if ( m_xImportInfoPropertySet.is() )
{
Reference<XPropertySetInfo> xInfo =
m_xImportInfoPropertySet->getPropertySetInfo();
bHandleShowChanges = ! xInfo->hasPropertyByName( g_sShowChanges );
bHandleRecordChanges = ! xInfo->hasPropertyByName( g_sRecordChanges );
bHandleProtectionKey = ! xInfo->hasPropertyByName( g_sRedlineProtectionKey );
}
// set redline mode & key
try
{
Any aAny;
aAny <<= m_bShowChanges;
if ( bHandleShowChanges )
{
aAny <<= true;
m_xModelPropertySet->setPropertyValue( g_sShowChanges, aAny );
// TODO maybe we need some property for the view-setting?
SwDoc *const pDoc(SwImport::GetDocFromXMLImport(m_rImport));
assert(pDoc);
pDoc->GetDocumentRedlineManager().SetHideRedlines(!m_bShowChanges);
}
else
m_xImportInfoPropertySet->setPropertyValue( g_sShowChanges, aAny );
aAny <<= m_bRecordChanges;
if ( bHandleRecordChanges )
m_xModelPropertySet->setPropertyValue( g_sRecordChanges, aAny );
else
m_xImportInfoPropertySet->setPropertyValue( g_sRecordChanges, aAny );
aAny <<= m_aProtectionKey;
if ( bHandleProtectionKey )
m_xModelPropertySet->setPropertyValue( g_sRedlineProtectionKey, aAny );
else
m_xImportInfoPropertySet->setPropertyValue( g_sRedlineProtectionKey, aAny);
}
catch (const uno::RuntimeException &) // fdo#65882
{
SAL_WARN( "sw", "potentially benign ordering issue during shutdown" );
}
}
void XMLRedlineImportHelper::Add(
std::u16string_view rType,
const OUString& rId,
const OUString& rAuthor,
const OUString& rComment,
const util::DateTime& rDateTime,
bool bMergeLastPara)
{
// we need to do the following:
// 1) parse type string
// 2) create RedlineInfo and fill it with data
// 3) check for existing redline with same ID
// 3a) insert redline into map
// 3b) attach to existing redline
// ad 1)
RedlineType eType;
if (rType == m_sInsertion)
{
eType = RedlineType::Insert;
}
else if (rType == m_sDeletion)
{
eType = RedlineType::Delete;
}
else if (rType == m_sFormatChange)
{
eType = RedlineType::Format;
}
else
{
// no proper type found: early out!
return;
}
// ad 2) create a new RedlineInfo
RedlineInfo* pInfo = new RedlineInfo();
// fill entries
pInfo->eType = eType;
pInfo->sAuthor = rAuthor;
pInfo->sComment = rComment;
pInfo->aDateTime = rDateTime;
pInfo->bMergeLastParagraph = bMergeLastPara;
// ad 3)
auto itPair = m_aRedlineMap.emplace(rId, pInfo);
if (itPair.second)
return;
// 3b) we already have a redline with this name: hierarchical redlines
// insert pInfo as last element in the chain.
// (hierarchy sanity checking happens on inserting into the document)
// find last element
RedlineInfo* pInfoChain;
for( pInfoChain = itPair.first->second;
nullptr != pInfoChain->pNextRedline;
pInfoChain = pInfoChain->pNextRedline) ; // empty loop
// insert as last element
pInfoChain->pNextRedline = pInfo;
}
Reference<XTextCursor> XMLRedlineImportHelper::CreateRedlineTextSection(
Reference<XTextCursor> const & xOldCursor,
const OUString& rId)
{
Reference<XTextCursor> xReturn;
// this method will modify the document directly -> lock SolarMutex
SolarMutexGuard aGuard;
// get RedlineInfo
RedlineMapType::iterator aFind = m_aRedlineMap.find(rId);
if (m_aRedlineMap.end() != aFind)
{
// get document from old cursor (via tunnel)
SwDoc* pDoc = lcl_GetDocViaTunnel(xOldCursor);
if (!pDoc)
{
SAL_WARN("sw", "no SwDoc => cannot create section.");
return nullptr;
}
// create text section for redline
SwTextFormatColl *pColl = pDoc->getIDocumentStylePoolAccess().GetTextCollFromPool
(RES_POOLCOLL_STANDARD, false );
SwStartNode* pRedlineNode = pDoc->GetNodes().MakeTextSection(
pDoc->GetNodes().GetEndOfRedlines(),
SwNormalStartNode,
pColl);
// remember node-index in RedlineInfo
SwNodeIndex aIndex(*pRedlineNode);
aFind->second->pContentIndex = new SwNodeIndex(aIndex);
// create XText for document
rtl::Reference<SwXRedlineText> pXText = new SwXRedlineText(pDoc, aIndex);
// create (UNO-) cursor
SwPosition aPos(*pRedlineNode);
rtl::Reference<SwXTextCursor> pXCursor =
new SwXTextCursor(*pDoc, pXText, CursorType::Redline, aPos);
pXCursor->GetCursor().Move(fnMoveForward, GoInNode);
// cast to avoid ambiguity
xReturn = static_cast<text::XWordCursor*>(pXCursor.get());
}
// else: unknown redline -> Ignore
return xReturn;
}
void XMLRedlineImportHelper::SetCursor(
const OUString& rId,
bool bStart,
Reference<XTextRange> const & rRange,
bool bIsOutsideOfParagraph)
{
RedlineMapType::iterator aFind = m_aRedlineMap.find(rId);
if (m_aRedlineMap.end() == aFind)
return;
// RedlineInfo found; now set Cursor
RedlineInfo* pInfo = aFind->second;
if (bIsOutsideOfParagraph)
{
// outside of paragraph: remember SwNodeIndex
if (bStart)
{
pInfo->aAnchorStart.SetAsNodeIndex(rRange);
}
else
{
pInfo->aAnchorEnd.SetAsNodeIndex(rRange);
}
// also remember that we expect an adjustment for this redline
pInfo->bNeedsAdjustment = true;
}
else
{
// inside of a paragraph: use regular XTextRanges (bookmarks)
if (bStart)
pInfo->aAnchorStart.Set(rRange);
else
pInfo->aAnchorEnd.Set(rRange);
}
// if this Cursor was the last missing info, we insert the
// node into the document
// then we can remove the entry from the map and destroy the object
if (IsReady(pInfo))
{
InsertIntoDocument(pInfo);
m_aRedlineMap.erase(rId);
delete pInfo;
}
// else: unknown Id -> ignore
}
void XMLRedlineImportHelper::AdjustStartNodeCursor(
const OUString& rId) /// ID used in RedlineAdd() call
{
// this method will modify the document directly -> lock SolarMutex
SolarMutexGuard aGuard;
// start + end nodes are treated the same. For either it's
// necessary that the target node already exists.
RedlineMapType::iterator aFind = m_aRedlineMap.find(rId);
if (m_aRedlineMap.end() == aFind)
return;
// RedlineInfo found; now set Cursor
RedlineInfo* pInfo = aFind->second;
pInfo->bNeedsAdjustment = false;
// if now ready, insert into document
if( IsReady(pInfo) )
{
InsertIntoDocument(pInfo);
m_aRedlineMap.erase(rId);
delete pInfo;
}
// else: can't find redline -> ignore
}
inline bool XMLRedlineImportHelper::IsReady(const RedlineInfo* pRedline)
{
// we can insert a redline if we have start & end, and we don't
// expect adjustments for either of these
return ( pRedline->aAnchorEnd.IsValid() &&
pRedline->aAnchorStart.IsValid() &&
!pRedline->bNeedsAdjustment );
}
/// recursively check if rPos or its anchor (if in fly or footnote) is in redline section
static auto RecursiveContains(SwStartNode const& rRedlineSection, SwNode const& rPos) -> bool
{
if (rRedlineSection.GetIndex() <= rPos.GetIndex()
&& rPos.GetIndex() <= rRedlineSection.EndOfSectionIndex())
{
return true;
}
// loop to iterate "up" in the node tree and find an anchored XText
for (SwStartNode const* pStartNode = rPos.StartOfSectionNode();
pStartNode != nullptr && pStartNode->GetIndex() != SwNodeOffset(0);
pStartNode = pStartNode->StartOfSectionNode())
{
switch (pStartNode->GetStartNodeType())
{
case SwNormalStartNode:
case SwTableBoxStartNode:
continue;
break;
case SwFlyStartNode:
{
SwFrameFormat const*const pFormat(pStartNode->GetFlyFormat());
assert(pFormat);
SwFormatAnchor const& rAnchor(pFormat->GetAnchor());
if (rAnchor.GetAnchorId() == RndStdIds::FLY_AT_PAGE)
{
return false;
}
else if (rAnchor.GetAnchorId() == RndStdIds::FLY_AT_FLY)
{ // anchor is on a start node, avoid skipping it:
pStartNode = rAnchor.GetContentAnchor()->nNode.GetNode().GetStartNode();
assert(pStartNode);
// pass the next node to recursive call - it will call
// call StartOfSectionNode on it and go back to pStartNode
SwNodeIndex const next(*pStartNode, +1);
return RecursiveContains(rRedlineSection, next.GetNode());
}
else
{
return RecursiveContains(rRedlineSection, rAnchor.GetContentAnchor()->nNode.GetNode());
}
}
break;
case SwFootnoteStartNode:
{ // sigh ... need to search
for (SwTextFootnote const*const pFootnote : rRedlineSection.GetDoc().GetFootnoteIdxs())
{
if (pStartNode == pFootnote->GetStartNode()->GetNode().GetStartNode())
{
return RecursiveContains(rRedlineSection, pFootnote->GetTextNode());
}
}
assert(false);
}
break;
case SwHeaderStartNode:
case SwFooterStartNode:
return false; // headers aren't anchored
break;
default:
assert(false);
break;
}
}
return false;
}
void XMLRedlineImportHelper::InsertIntoDocument(RedlineInfo* pRedlineInfo)
{
OSL_ENSURE(nullptr != pRedlineInfo, "need redline info");
OSL_ENSURE(IsReady(pRedlineInfo), "redline info not complete yet!");
// this method will modify the document directly -> lock SolarMutex
SolarMutexGuard aGuard;
// Insert the Redline as described by pRedlineInfo into the
// document. If we are in insert mode, don't insert any redlines
// (and delete 'deleted' inline redlines)
// get the document (from one of the positions)
SwDoc* pDoc = pRedlineInfo->aAnchorStart.GetDoc();
if (!pDoc)
{
SAL_WARN("sw", "no SwDoc => cannot insert redline.");
return;
}
// now create the PaM for the redline
SwPaM aPaM(pDoc->GetNodes().GetEndOfContent());
pRedlineInfo->aAnchorStart.CopyPositionInto(*aPaM.GetPoint(), *pDoc);
aPaM.SetMark();
pRedlineInfo->aAnchorEnd.CopyPositionInto(*aPaM.GetPoint(), *pDoc);
// collapse PaM if (start == end)
if (*aPaM.GetPoint() == *aPaM.GetMark())
{
aPaM.DeleteMark();
}
// cover three cases:
// 1) empty redlines (no range, no content)
// 2) check for:
// a) bIgnoreRedline (e.g. insert mode)
// b) illegal PaM range (CheckNodesRange())
// c) redline with empty content section (quite useless)
// 3) normal case: insert redline
SwTextNode const* pTempNode(nullptr);
if( !aPaM.HasMark() && (pRedlineInfo->pContentIndex == nullptr) )
{
// these redlines have no function, and will thus be ignored (just as
// in sw3io), so no action here
}
else if ( m_bIgnoreRedlines ||
!CheckNodesRange( aPaM.GetPoint()->nNode,
aPaM.GetMark()->nNode,
true )
|| (pRedlineInfo->pContentIndex
&& (pRedlineInfo->pContentIndex->GetIndex() + 2
== pRedlineInfo->pContentIndex->GetNode().EndOfSectionIndex())
&& (pTempNode = pDoc->GetNodes()[pRedlineInfo->pContentIndex->GetIndex() + 1]->GetTextNode()) != nullptr
&& pTempNode->GetText().isEmpty()
&& !pTempNode->GetpSwpHints()
&& pTempNode->GetAnchoredFlys().empty()))
{
// ignore redline (e.g. file loaded in insert mode):
// delete 'deleted' redlines and forget about the whole thing
if (RedlineType::Delete == pRedlineInfo->eType)
{
pDoc->getIDocumentContentOperations().DeleteRange(aPaM);
// And what about the "deleted nodes"?
// They have to be deleted as well (#i80689)!
if( m_bIgnoreRedlines && pRedlineInfo->pContentIndex != nullptr )
{
SwNodeIndex aIdx( *pRedlineInfo->pContentIndex );
const SwNode* pEnd = aIdx.GetNode().EndOfSectionNode();
if( pEnd )
{
SwNodeIndex aEnd( *pEnd, 1 );
SwPaM aDel( aIdx, aEnd );
pDoc->getIDocumentContentOperations().DeleteRange(aDel);
}
}
}
}
else if (pRedlineInfo->pContentIndex != nullptr
// should be enough to check 1 position of aPaM bc CheckNodesRange() above
&& RecursiveContains(*pRedlineInfo->pContentIndex->GetNode().GetStartNode(), aPaM.GetPoint()->nNode.GetNode()))
{
SAL_WARN("sw.xml", "Recursive change tracking, removing");
// reuse aPaM to remove it from nodes that will be deleted
*aPaM.GetPoint() = SwPosition(pRedlineInfo->pContentIndex->GetNode());
aPaM.DeleteMark();
pDoc->getIDocumentContentOperations().DeleteSection(&aPaM.GetPoint()->nNode.GetNode());
}
else
{
// regular file loading: insert redline
// create redline (using pRedlineData which gets copied in SwRangeRedline())
SwRedlineData* pRedlineData = ConvertRedline(pRedlineInfo, pDoc);
SwRangeRedline* pRedline =
new SwRangeRedline( pRedlineData, *aPaM.GetPoint(),
!pRedlineInfo->bMergeLastParagraph );
// tdf#107292 fix order of delete redlines at the same position by removing
// the already inserted redlines temporarily and inserting them back in reverse
// order after inserting pRedline
std::vector<const SwRangeRedline*> aSwapRedlines;
if ( RedlineType::Delete == pRedlineInfo->eType )
{
SwRedlineTable::size_type n = 0;
while ( const SwRangeRedline* pRedline2 =
pDoc->getIDocumentRedlineAccess().GetRedline( *pRedline->Start(), &n ) )
{
SwRedlineTable& aRedlineTable = pDoc->getIDocumentRedlineAccess().GetRedlineTable();
aSwapRedlines.push_back(pRedline2);
aRedlineTable.Remove(n);
}
}
// set mark
if( aPaM.HasMark() )
{
pRedline->SetMark();
*(pRedline->GetMark()) = *aPaM.GetMark();
}
// set content node (if necessary)
if (nullptr != pRedlineInfo->pContentIndex)
{
SwNodeOffset nPoint = aPaM.GetPoint()->nNode.GetIndex();
if( nPoint < pRedlineInfo->pContentIndex->GetIndex() ||
nPoint > pRedlineInfo->pContentIndex->GetNode().EndOfSectionIndex() )
pRedline->SetContentIdx(pRedlineInfo->pContentIndex);
else
SAL_WARN("sw", "Recursive change tracking");
}
// set redline mode (without doing the associated book-keeping)
pDoc->getIDocumentRedlineAccess().SetRedlineFlags_intern(RedlineFlags::On);
pDoc->getIDocumentRedlineAccess().AppendRedline(pRedline, false);
// restore the correct order of the delete redlines at the same position
for (auto i = aSwapRedlines.rbegin(); i != aSwapRedlines.rend(); ++i)
pDoc->getIDocumentRedlineAccess().AppendRedline(const_cast<SwRangeRedline*>(*i), false);
pDoc->getIDocumentRedlineAccess().SetRedlineFlags_intern(RedlineFlags::NONE);
}
}
SwRedlineData* XMLRedlineImportHelper::ConvertRedline(
RedlineInfo* pRedlineInfo,
SwDoc* pDoc)
{
// convert info:
// 1) Author String -> Author ID (default to zero)
std::size_t nAuthorId = (nullptr == pDoc) ? 0 :
pDoc->getIDocumentRedlineAccess().InsertRedlineAuthor( pRedlineInfo->sAuthor );
// 2) util::DateTime -> DateTime
DateTime aDT( DateTime::EMPTY );
aDT.SetYear( pRedlineInfo->aDateTime.Year );
aDT.SetMonth( pRedlineInfo->aDateTime.Month );
aDT.SetDay( pRedlineInfo->aDateTime.Day );
aDT.SetHour( pRedlineInfo->aDateTime.Hours );
aDT.SetMin( pRedlineInfo->aDateTime.Minutes );
aDT.SetSec( pRedlineInfo->aDateTime.Seconds );
aDT.SetNanoSec( pRedlineInfo->aDateTime.NanoSeconds );
// 3) recursively convert next redline
// ( check presence and sanity of hierarchical redline info )
SwRedlineData* pNext = nullptr;
if ( (nullptr != pRedlineInfo->pNextRedline) &&
(RedlineType::Delete == pRedlineInfo->eType) &&
(RedlineType::Insert == pRedlineInfo->pNextRedline->eType) )
{
pNext = ConvertRedline(pRedlineInfo->pNextRedline, pDoc);
}
// create redline data
SwRedlineData* pData = new SwRedlineData(pRedlineInfo->eType,
nAuthorId, aDT,
pRedlineInfo->sComment,
pNext); // next data (if available)
return pData;
}
void XMLRedlineImportHelper::SetShowChanges( bool bShow )
{
m_bShowChanges = bShow;
}
void XMLRedlineImportHelper::SetRecordChanges( bool bRecord )
{
m_bRecordChanges = bRecord;
}
void XMLRedlineImportHelper::SetProtectionKey(
const Sequence<sal_Int8> & rKey )
{
m_aProtectionKey = rKey;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|