Line data Source code
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 "XclImpChangeTrack.hxx"
21 : #include <sot/storage.hxx>
22 : #include <svl/zforlist.hxx>
23 : #include <svl/sharedstringpool.hxx>
24 : #include "chgviset.hxx"
25 : #include "formulacell.hxx"
26 : #include "chgtrack.hxx"
27 : #include "xihelper.hxx"
28 : #include "xilink.hxx"
29 : #include "externalrefmgr.hxx"
30 : #include "document.hxx"
31 :
32 : // class XclImpChangeTrack
33 :
34 81 : XclImpChangeTrack::XclImpChangeTrack( const XclImpRoot& rRoot, const XclImpStream& rBookStrm ) :
35 : XclImpRoot( rRoot ),
36 : aRecHeader(),
37 : sOldUsername(),
38 : pChangeTrack( NULL ),
39 : pStrm( NULL ),
40 : nTabIdCount( 0 ),
41 : bGlobExit( false ),
42 81 : eNestedMode( nmBase )
43 : {
44 : // Verify that the User Names stream exists before going any further. Excel adds both
45 : // "Revision Log" and "User Names" streams when Change Tracking is active but the Revision log
46 : // remains if Change Tracking is turned off.
47 81 : tools::SvRef<SotStorageStream> xUserStrm = OpenStream( EXC_STREAM_USERNAMES );
48 81 : if( !xUserStrm.Is() )
49 160 : return;
50 :
51 2 : xInStrm = OpenStream( EXC_STREAM_REVLOG );
52 2 : if( xInStrm.Is() )
53 : {
54 2 : xInStrm->Seek( STREAM_SEEK_TO_END );
55 2 : sal_uInt64 const nStreamLen = xInStrm->Tell();
56 2 : if( (xInStrm->GetErrorCode() == ERRCODE_NONE) && (nStreamLen != STREAM_SEEK_TO_END) )
57 : {
58 2 : xInStrm->Seek( STREAM_SEEK_TO_BEGIN );
59 2 : pStrm = new XclImpStream( *xInStrm, GetRoot() );
60 2 : pStrm->CopyDecrypterFrom( rBookStrm );
61 2 : pChangeTrack = new ScChangeTrack( GetDocPtr() );
62 :
63 2 : sOldUsername = pChangeTrack->GetUser();
64 2 : pChangeTrack->SetUseFixDateTime( true );
65 :
66 2 : ReadRecords();
67 : }
68 2 : }
69 : }
70 :
71 162 : XclImpChangeTrack::~XclImpChangeTrack()
72 : {
73 81 : delete pChangeTrack;
74 81 : delete pStrm;
75 81 : }
76 :
77 26 : void XclImpChangeTrack::DoAcceptRejectAction( ScChangeAction* pAction )
78 : {
79 52 : if( !pAction ) return;
80 26 : switch( aRecHeader.nAccept )
81 : {
82 : case EXC_CHTR_ACCEPT:
83 0 : pChangeTrack->Accept( pAction );
84 0 : break;
85 : case EXC_CHTR_REJECT:
86 0 : break;
87 : }
88 : }
89 :
90 12 : void XclImpChangeTrack::DoAcceptRejectAction( sal_uInt32 nFirst, sal_uInt32 nLast )
91 : {
92 24 : for( sal_uInt32 nIndex = nFirst; nIndex <= nLast; nIndex++ )
93 12 : DoAcceptRejectAction( pChangeTrack->GetAction( nIndex ) );
94 12 : }
95 :
96 12 : void XclImpChangeTrack::DoInsertRange( const ScRange& rRange, bool bEndOfList )
97 : {
98 12 : sal_uInt32 nFirst = pChangeTrack->GetActionMax() + 1;
99 12 : pChangeTrack->AppendInsert(rRange, bEndOfList);
100 12 : sal_uInt32 nLast = pChangeTrack->GetActionMax();
101 12 : DoAcceptRejectAction( nFirst, nLast );
102 12 : }
103 :
104 0 : void XclImpChangeTrack::DoDeleteRange( const ScRange& rRange )
105 : {
106 : sal_uLong nFirst, nLast;
107 0 : pChangeTrack->AppendDeleteRange( rRange, NULL, nFirst, nLast );
108 0 : DoAcceptRejectAction( nFirst, nLast );
109 0 : }
110 :
111 26 : SCTAB XclImpChangeTrack::ReadTabNum()
112 : {
113 26 : return static_cast<SCTAB>(GetTabInfo().GetCurrentIndex(
114 52 : pStrm->ReaduInt16(), nTabIdCount ));
115 : }
116 :
117 7 : void XclImpChangeTrack::ReadDateTime( DateTime& rDateTime )
118 : {
119 : sal_uInt16 nYear;
120 : sal_uInt8 nMonth, nDay, nHour, nMin, nSec;
121 :
122 7 : nYear = pStrm->ReaduInt16();
123 7 : nMonth = pStrm->ReaduInt8();
124 7 : nDay = pStrm->ReaduInt8();
125 7 : nHour = pStrm->ReaduInt8();
126 7 : nMin = pStrm->ReaduInt8();
127 7 : nSec = pStrm->ReaduInt8();
128 :
129 7 : rDateTime.SetYear( nYear );
130 7 : rDateTime.SetMonth( nMonth );
131 7 : rDateTime.SetDay( nDay );
132 7 : rDateTime.SetHour( nHour );
133 7 : rDateTime.SetMin( nMin );
134 7 : rDateTime.SetSec( nSec );
135 7 : rDateTime.SetNanoSec( 0 );
136 7 : }
137 :
138 26 : bool XclImpChangeTrack::CheckRecord( sal_uInt16 nOpCode )
139 : {
140 26 : if( (nOpCode != EXC_CHTR_OP_UNKNOWN) && (aRecHeader.nOpCode != nOpCode) )
141 : {
142 : OSL_FAIL( "XclImpChangeTrack::CheckRecord - unknown action" );
143 0 : return false;
144 : }
145 26 : return aRecHeader.nIndex != 0;
146 : }
147 :
148 0 : bool XclImpChangeTrack::Read3DTabRefInfo( SCTAB& rFirstTab, SCTAB& rLastTab, ExcelToSc8::ExternalTabInfo& rExtInfo )
149 : {
150 0 : if( LookAtuInt8() == 0x01 )
151 : {
152 0 : rExtInfo.mbExternal = false;
153 : // internal ref - read tab num and return sc tab num (position in TABID list)
154 0 : pStrm->Ignore( 3 );
155 0 : rFirstTab = static_cast< SCTAB >( GetTabInfo().GetCurrentIndex( pStrm->ReaduInt16(), nTabIdCount ) );
156 0 : sal_uInt8 nFillByte = pStrm->ReaduInt8();
157 : rLastTab = (nFillByte == 0x00) ?
158 0 : static_cast< SCTAB >( GetTabInfo().GetCurrentIndex( pStrm->ReaduInt16(), nTabIdCount ) ) : rFirstTab;
159 : }
160 : else
161 : {
162 : // external ref - read doc and tab name and find sc tab num
163 : // - URL
164 0 : OUString aEncUrl( pStrm->ReadUniString() );
165 0 : OUString aUrl;
166 : bool bSelf;
167 0 : XclImpUrlHelper::DecodeUrl( aUrl, bSelf, GetRoot(), aEncUrl );
168 0 : pStrm->Ignore( 1 );
169 : // - sheet name, always separated from URL
170 0 : OUString aTabName( pStrm->ReadUniString() );
171 0 : pStrm->Ignore( 1 );
172 :
173 0 : rExtInfo.mbExternal = true;
174 0 : ScExternalRefManager* pRefMgr = GetDoc().GetExternalRefManager();
175 0 : pRefMgr->convertToAbsName(aUrl);
176 0 : rExtInfo.mnFileId = pRefMgr->getExternalFileId(aUrl);
177 0 : rExtInfo.maTabName = aTabName;
178 0 : rFirstTab = rLastTab = 0;
179 : }
180 0 : return true;
181 : }
182 :
183 2 : void XclImpChangeTrack::ReadFormula( ScTokenArray*& rpTokenArray, const ScAddress& rPosition )
184 : {
185 2 : sal_uInt16 nFmlSize = pStrm->ReaduInt16();
186 :
187 : // create a memory stream and copy the formula to be able to read simultaneously
188 : // the formula and the additional 3D tab ref data following the formula
189 : // here we have to simulate an Excel record to be able to use an XclImpStream...
190 : // 2do: remove the stream member from formula converter and add it as a parameter
191 : // to the Convert() routine (to prevent the construction/destruction of the
192 : // converter in each formula)
193 2 : SvMemoryStream aMemStrm;
194 2 : aMemStrm.WriteUInt16( 0x0001 ).WriteUInt16( nFmlSize );
195 2 : size_t nRead = pStrm->CopyToStream( aMemStrm, nFmlSize );
196 :
197 : // survive reading invalid streams!
198 : // if we can't read as many bytes as required just don't use them and
199 : // assume that this part is broken
200 2 : if(nRead != nFmlSize)
201 : {
202 0 : rpTokenArray = NULL;
203 0 : pStrm->Ignore(1);
204 2 : return;
205 : }
206 :
207 4 : XclImpStream aFmlaStrm( aMemStrm, GetRoot() );
208 2 : aFmlaStrm.StartNextRecord();
209 4 : XclImpChTrFmlConverter aFmlConv( GetRoot(), *this );
210 :
211 : // read the formula, 3D tab refs from extended data
212 2 : const ScTokenArray* pArray = NULL;
213 2 : aFmlConv.Reset( rPosition );
214 2 : bool bOK = (aFmlConv.Convert( pArray, aFmlaStrm, nFmlSize, false, FT_CellFormula) == ConvOK); // JEG : Check This
215 2 : rpTokenArray = (bOK && pArray) ? new ScTokenArray( *pArray ) : NULL;
216 4 : pStrm->Ignore( 1 );
217 : }
218 :
219 28 : void XclImpChangeTrack::ReadCell(
220 : ScCellValue& rCell, sal_uInt32& rFormat, sal_uInt16 nFlags, const ScAddress& rPosition )
221 : {
222 28 : rCell.clear();
223 28 : rFormat = 0;
224 28 : switch( nFlags & EXC_CHTR_TYPE_MASK )
225 : {
226 : case EXC_CHTR_TYPE_EMPTY:
227 14 : break;
228 : case EXC_CHTR_TYPE_RK:
229 : {
230 7 : double fValue = ReadRK();
231 7 : if( pStrm->IsValid() )
232 : {
233 7 : rCell.meType = CELLTYPE_VALUE;
234 7 : rCell.mfValue = fValue;
235 : }
236 : }
237 7 : break;
238 : case EXC_CHTR_TYPE_DOUBLE:
239 : {
240 2 : double fValue = pStrm->ReadDouble();
241 2 : if( pStrm->IsValid() )
242 : {
243 2 : rCell.meType = CELLTYPE_VALUE;
244 2 : rCell.mfValue = fValue;
245 : }
246 : }
247 2 : break;
248 : case EXC_CHTR_TYPE_STRING:
249 : {
250 2 : OUString sString = pStrm->ReadUniString();
251 2 : if( pStrm->IsValid() )
252 : {
253 2 : rCell.meType = CELLTYPE_STRING;
254 2 : rCell.mpString = new svl::SharedString(GetDoc().GetSharedStringPool().intern(sString));
255 2 : }
256 : }
257 2 : break;
258 : case EXC_CHTR_TYPE_BOOL:
259 : {
260 1 : double fValue = (double) ReadBool();
261 1 : if( pStrm->IsValid() )
262 : {
263 1 : rCell.meType = CELLTYPE_VALUE;
264 1 : rCell.mfValue = fValue;
265 1 : rFormat = GetFormatter().GetStandardFormat( css::util::NumberFormat::LOGICAL, ScGlobal::eLnge );
266 : }
267 : }
268 1 : break;
269 : case EXC_CHTR_TYPE_FORMULA:
270 : {
271 2 : ScTokenArray* pTokenArray = NULL;
272 2 : ReadFormula( pTokenArray, rPosition );
273 2 : if( pStrm->IsValid() && pTokenArray )
274 : {
275 2 : rCell.meType = CELLTYPE_FORMULA;
276 2 : rCell.mpFormula = new ScFormulaCell(GetDocPtr(), rPosition, *pTokenArray);
277 : }
278 2 : delete pTokenArray;
279 : }
280 2 : break;
281 : default:
282 : OSL_FAIL( "XclImpChangeTrack::ReadCell - unknown data type" );
283 : }
284 28 : }
285 :
286 12 : void XclImpChangeTrack::ReadChTrInsert()
287 : {
288 12 : *pStrm >> aRecHeader;
289 12 : if( CheckRecord( EXC_CHTR_OP_UNKNOWN ) )
290 : {
291 12 : if( (aRecHeader.nOpCode != EXC_CHTR_OP_INSROW) &&
292 0 : (aRecHeader.nOpCode != EXC_CHTR_OP_INSCOL) &&
293 0 : (aRecHeader.nOpCode != EXC_CHTR_OP_DELROW) &&
294 0 : (aRecHeader.nOpCode != EXC_CHTR_OP_DELCOL) )
295 : {
296 : OSL_FAIL( "XclImpChangeTrack::ReadChTrInsert - unknown action" );
297 12 : return;
298 : }
299 :
300 12 : ScRange aRange;
301 12 : aRange.aStart.SetTab( ReadTabNum() );
302 12 : aRange.aEnd.SetTab( aRange.aStart.Tab() );
303 12 : sal_uInt16 nFlags = pStrm->ReaduInt16();
304 12 : bool bEndOfList = (nFlags & 0x0001); // row auto-inserted at the bottom.
305 12 : Read2DRange( aRange );
306 :
307 12 : if( aRecHeader.nOpCode & EXC_CHTR_OP_COLFLAG )
308 0 : aRange.aEnd.SetRow( MAXROW );
309 : else
310 12 : aRange.aEnd.SetCol( MAXCOL );
311 :
312 12 : bool bValid = pStrm->IsValid();
313 12 : if( FoundNestedMode() )
314 0 : ReadNestedRecords();
315 :
316 12 : if( bValid )
317 : {
318 12 : if( aRecHeader.nOpCode & EXC_CHTR_OP_DELFLAG )
319 0 : DoDeleteRange( aRange );
320 : else
321 12 : DoInsertRange(aRange, bEndOfList);
322 : }
323 : }
324 : }
325 :
326 7 : void XclImpChangeTrack::ReadChTrInfo()
327 : {
328 7 : pStrm->DisableDecryption();
329 7 : pStrm->Ignore( 32 );
330 7 : OUString sUsername( pStrm->ReadUniString() );
331 7 : if( !pStrm->IsValid() ) return;
332 :
333 7 : if( !sUsername.isEmpty() )
334 7 : pChangeTrack->SetUser( sUsername );
335 7 : pStrm->Seek( 148 );
336 7 : if( !pStrm->IsValid() ) return;
337 :
338 7 : DateTime aDateTime( DateTime::EMPTY );
339 7 : ReadDateTime( aDateTime );
340 7 : if( pStrm->IsValid() )
341 7 : pChangeTrack->SetFixDateTimeLocal( aDateTime );
342 : }
343 :
344 14 : void XclImpChangeTrack::ReadChTrCellContent()
345 : {
346 14 : *pStrm >> aRecHeader;
347 14 : if( CheckRecord( EXC_CHTR_OP_CELL ) )
348 : {
349 14 : ScAddress aPosition;
350 14 : SCTAB nTab = ReadTabNum();
351 14 : aPosition.SetTab( nTab );
352 : sal_uInt16 nValueType;
353 14 : nValueType = pStrm->ReaduInt16();
354 14 : sal_uInt16 nOldValueType = (nValueType >> 3) & EXC_CHTR_TYPE_MASK;
355 14 : sal_uInt16 nNewValueType = nValueType & EXC_CHTR_TYPE_MASK;
356 14 : pStrm->Ignore( 2 );
357 14 : Read2DAddress( aPosition );
358 : sal_uInt16 nOldSize;
359 14 : nOldSize = pStrm->ReaduInt16();
360 : SAL_WARN_IF( (nOldSize == 0) != (nOldValueType == EXC_CHTR_TYPE_EMPTY),
361 : "sc.xcl97",
362 : "XclImpChangeTrack::ReadChTrCellContent - old value mismatch" );
363 14 : pStrm->Ignore( 4 );
364 14 : switch( nValueType & EXC_CHTR_TYPE_FORMATMASK )
365 : {
366 14 : case 0x0000: break;
367 0 : case 0x1100: pStrm->Ignore( 16 ); break;
368 0 : case 0x1300: pStrm->Ignore( 8 ); break;
369 : default: OSL_FAIL( "XclImpChangeTrack::ReadChTrCellContent - unknown format info" );
370 : }
371 :
372 14 : ScCellValue aOldCell;
373 28 : ScCellValue aNewCell;
374 : sal_uInt32 nOldFormat;
375 : sal_uInt32 nNewFormat;
376 14 : ReadCell(aOldCell, nOldFormat, nOldValueType, aPosition);
377 14 : ReadCell(aNewCell, nNewFormat, nNewValueType, aPosition);
378 14 : if( !pStrm->IsValid() || (pStrm->GetRecLeft() > 0) )
379 : {
380 : OSL_FAIL( "XclImpChangeTrack::ReadChTrCellContent - bytes left, action ignored" );
381 0 : aOldCell.clear();
382 0 : aNewCell.clear();
383 : }
384 : else
385 : {
386 : ScChangeActionContent* pNewAction =
387 14 : pChangeTrack->AppendContentOnTheFly(aPosition, aOldCell, aNewCell, nOldFormat, nNewFormat);
388 14 : DoAcceptRejectAction( pNewAction );
389 14 : }
390 : }
391 14 : }
392 :
393 7 : void XclImpChangeTrack::ReadChTrTabId()
394 : {
395 7 : if( nTabIdCount == 0 ) // read only 1st time, otherwise calculated by <ReadChTrInsertTab()>
396 2 : nTabIdCount = static_cast< sal_uInt16 >( pStrm->GetRecLeft() >> 1 );
397 7 : }
398 :
399 0 : void XclImpChangeTrack::ReadChTrMoveRange()
400 : {
401 0 : *pStrm >> aRecHeader;
402 0 : if( CheckRecord( EXC_CHTR_OP_MOVE ) )
403 : {
404 0 : ScRange aSourceRange;
405 0 : ScRange aDestRange;
406 0 : aDestRange.aStart.SetTab( ReadTabNum() );
407 0 : aDestRange.aEnd.SetTab( aDestRange.aStart.Tab() );
408 0 : Read2DRange( aSourceRange );
409 0 : Read2DRange( aDestRange );
410 0 : aSourceRange.aStart.SetTab( ReadTabNum() );
411 0 : aSourceRange.aEnd.SetTab( aSourceRange.aStart.Tab() );
412 :
413 0 : bool bValid = pStrm->IsValid();
414 0 : if( FoundNestedMode() )
415 0 : ReadNestedRecords();
416 :
417 0 : if( bValid )
418 : {
419 0 : pChangeTrack->AppendMove( aSourceRange, aDestRange, NULL );
420 0 : DoAcceptRejectAction( pChangeTrack->GetLast() );
421 : }
422 : }
423 0 : }
424 :
425 0 : void XclImpChangeTrack::ReadChTrInsertTab()
426 : {
427 0 : *pStrm >> aRecHeader;
428 0 : if( CheckRecord( EXC_CHTR_OP_INSTAB ) )
429 : {
430 0 : SCTAB nTab = ReadTabNum();
431 0 : if( pStrm->IsValid() )
432 : {
433 0 : nTabIdCount++;
434 0 : DoInsertRange(ScRange(0, 0, nTab, MAXCOL, MAXROW, nTab), false);
435 : }
436 : }
437 0 : }
438 :
439 0 : void XclImpChangeTrack::InitNestedMode()
440 : {
441 : OSL_ENSURE( eNestedMode == nmBase, "XclImpChangeTrack::InitNestedMode - unexpected nested mode" );
442 0 : if( eNestedMode == nmBase )
443 0 : eNestedMode = nmFound;
444 0 : }
445 :
446 0 : void XclImpChangeTrack::ReadNestedRecords()
447 : {
448 : OSL_ENSURE( eNestedMode == nmFound, "XclImpChangeTrack::StartNestedMode - missing nested mode" );
449 0 : if( eNestedMode == nmFound )
450 : {
451 0 : eNestedMode = nmNested;
452 0 : ReadRecords();
453 : }
454 0 : }
455 :
456 0 : bool XclImpChangeTrack::EndNestedMode()
457 : {
458 : OSL_ENSURE( eNestedMode != nmBase, "XclImpChangeTrack::EndNestedMode - missing nested mode" );
459 0 : bool bReturn = (eNestedMode == nmNested);
460 0 : eNestedMode = nmBase;
461 0 : return bReturn;
462 : }
463 :
464 2 : void XclImpChangeTrack::ReadRecords()
465 : {
466 2 : bool bExitLoop = false;
467 :
468 52 : while( !bExitLoop && !bGlobExit && pStrm->StartNextRecord() )
469 : {
470 48 : switch( pStrm->GetRecId() )
471 : {
472 2 : case 0x000A: bGlobExit = true; break;
473 12 : case 0x0137: ReadChTrInsert(); break;
474 7 : case 0x0138: ReadChTrInfo(); break;
475 14 : case 0x013B: ReadChTrCellContent(); break;
476 7 : case 0x013D: ReadChTrTabId(); break;
477 0 : case 0x0140: ReadChTrMoveRange(); break;
478 0 : case 0x014D: ReadChTrInsertTab(); break;
479 : case 0x014E:
480 0 : case 0x0150: InitNestedMode(); break;
481 : case 0x014F:
482 0 : case 0x0151: bExitLoop = EndNestedMode(); break;
483 : }
484 : }
485 2 : }
486 :
487 81 : void XclImpChangeTrack::Apply()
488 : {
489 81 : if( pChangeTrack )
490 : {
491 2 : pChangeTrack->SetUser( sOldUsername );
492 2 : pChangeTrack->SetUseFixDateTime( false );
493 :
494 2 : GetDoc().SetChangeTrack( pChangeTrack );
495 2 : pChangeTrack = NULL;
496 :
497 2 : ScChangeViewSettings aSettings;
498 2 : aSettings.SetShowChanges( true );
499 2 : GetDoc().SetChangeViewSettings( aSettings );
500 : }
501 81 : }
502 :
503 : // class XclImpChTrFmlConverter
504 :
505 2 : XclImpChTrFmlConverter::XclImpChTrFmlConverter(
506 : XclImpRoot& rRoot, XclImpChangeTrack& rXclChTr ) :
507 : ExcelToSc8( rRoot ),
508 2 : rChangeTrack( rXclChTr ) {}
509 :
510 2 : XclImpChTrFmlConverter::~XclImpChTrFmlConverter()
511 : {
512 2 : }
513 :
514 : // virtual, called from ExcToSc8::Convert()
515 0 : bool XclImpChTrFmlConverter::Read3DTabReference( sal_uInt16 /*nIxti*/, SCTAB& rFirstTab, SCTAB& rLastTab,
516 : ExternalTabInfo& rExtInfo )
517 : {
518 0 : return rChangeTrack.Read3DTabRefInfo( rFirstTab, rLastTab, rExtInfo );
519 30 : }
520 :
521 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
