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
|
/* -*- 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 "biffinputstream.hxx"
#include <algorithm>
#include <rtl/ustrbuf.hxx>
#include <osl/diagnose.h>
namespace oox {
namespace xls {
namespace prv {
BiffInputRecordBuffer::BiffInputRecordBuffer( BinaryInputStream& rInStrm ) :
mrInStrm( rInStrm ),
mpCurrentData( 0 ),
mnHeaderPos( -1 ),
mnBodyPos( 0 ),
mnBufferBodyPos( 0 ),
mnNextHeaderPos( 0 ),
mnRecId( BIFF_ID_UNKNOWN ),
mnRecSize( 0 ),
mnRecPos( 0 ),
mbValidHeader( false )
{
OSL_ENSURE( mrInStrm.isSeekable(), "BiffInputRecordBuffer::BiffInputRecordBuffer - stream must be seekable" );
mrInStrm.seekToStart();
maOriginalData.reserve( SAL_MAX_UINT16 );
maDecodedData.reserve( SAL_MAX_UINT16 );
enableDecoder( false ); // updates mpCurrentData
}
void BiffInputRecordBuffer::restartAt( sal_Int64 nPos )
{
mnHeaderPos = -1;
mnBodyPos = mnBufferBodyPos = 0;
mnNextHeaderPos = nPos;
mnRecId = BIFF_ID_UNKNOWN;
mnRecSize = mnRecPos = 0;
mbValidHeader = false;
}
void BiffInputRecordBuffer::setDecoder( const BiffDecoderRef& rxDecoder )
{
mxDecoder = rxDecoder;
enableDecoder( true );
updateDecoded();
}
void BiffInputRecordBuffer::enableDecoder( bool bEnable )
{
mpCurrentData = (bEnable && mxDecoder.get() && mxDecoder->isValid()) ? &maDecodedData : &maOriginalData;
}
bool BiffInputRecordBuffer::startRecord( sal_Int64 nHeaderPos )
{
mbValidHeader = (0 <= nHeaderPos) && (nHeaderPos + 4 <= mrInStrm.size());
if( mbValidHeader )
{
mnHeaderPos = nHeaderPos;
mrInStrm.seek( nHeaderPos );
mnRecId = mrInStrm.readuInt16();
mnRecSize = mrInStrm.readuInt16();
mnBodyPos = mrInStrm.tell();
mnNextHeaderPos = mnBodyPos + mnRecSize;
mbValidHeader = !mrInStrm.isEof() && (mnNextHeaderPos <= mrInStrm.size());
}
if( !mbValidHeader )
{
mnHeaderPos = mnBodyPos = -1;
mnNextHeaderPos = 0;
mnRecId = BIFF_ID_UNKNOWN;
mnRecSize = 0;
}
mnRecPos = 0;
return mbValidHeader;
}
bool BiffInputRecordBuffer::startNextRecord()
{
return startRecord( mnNextHeaderPos );
}
sal_uInt16 BiffInputRecordBuffer::getNextRecId()
{
sal_uInt16 nRecId = BIFF_ID_UNKNOWN;
if( mbValidHeader && (mnNextHeaderPos + 4 <= mrInStrm.size()) )
{
mrInStrm.seek( mnNextHeaderPos );
nRecId = mrInStrm.readuInt16();
}
return nRecId;
}
void BiffInputRecordBuffer::read( void* opData, sal_uInt16 nBytes )
{
updateBuffer();
OSL_ENSURE( nBytes > 0, "BiffInputRecordBuffer::read - nothing to read" );
OSL_ENSURE( nBytes <= getRecLeft(), "BiffInputRecordBuffer::read - buffer overflow" );
memcpy( opData, &(*mpCurrentData)[ mnRecPos ], nBytes );
mnRecPos = mnRecPos + nBytes;
}
void BiffInputRecordBuffer::skip( sal_uInt16 nBytes )
{
OSL_ENSURE( nBytes > 0, "BiffInputRecordBuffer::skip - nothing to skip" );
OSL_ENSURE( nBytes <= getRecLeft(), "BiffInputRecordBuffer::skip - buffer overflow" );
mnRecPos = mnRecPos + nBytes;
}
void BiffInputRecordBuffer::updateBuffer()
{
OSL_ENSURE( mbValidHeader, "BiffInputRecordBuffer::updateBuffer - invalid access" );
if( mnBodyPos != mnBufferBodyPos )
{
mrInStrm.seek( mnBodyPos );
maOriginalData.resize( mnRecSize );
if( mnRecSize > 0 )
mrInStrm.readMemory( &maOriginalData.front(), static_cast< sal_Int32 >( mnRecSize ) );
mnBufferBodyPos = mnBodyPos;
updateDecoded();
}
}
void BiffInputRecordBuffer::updateDecoded()
{
if( mxDecoder.get() && mxDecoder->isValid() )
{
maDecodedData.resize( mnRecSize );
if( mnRecSize > 0 )
mxDecoder->decode( &maDecodedData.front(), &maOriginalData.front(), mnBodyPos, mnRecSize );
}
}
} // namespace prv
BiffInputStream::BiffInputStream( BinaryInputStream& rInStream, bool bContLookup ) :
BinaryStreamBase( true ),
maRecBuffer( rInStream ),
mnRecHandle( -1 ),
mnRecId( BIFF_ID_UNKNOWN ),
mnAltContId( BIFF_ID_UNKNOWN ),
mnCurrRecSize( 0 ),
mnComplRecSize( 0 ),
mbHasComplRec( false ),
mbCont( bContLookup )
{
mbEof = true; // EOF will be true if stream is not inside a record
}
// record control -------------------------------------------------------------
bool BiffInputStream::startNextRecord()
{
bool bValidRec = false;
/* #i4266# ignore zero records (id==len==0) (e.g. the application
"Crystal Report" writes zero records between other records) */
bool bIsZeroRec = false;
do
{
// record header is never encrypted
maRecBuffer.enableDecoder( false );
// read header of next raw record, returns false at end of stream
bValidRec = maRecBuffer.startNextRecord();
// ignore record, if identifier and size are zero
bIsZeroRec = (maRecBuffer.getRecId() == 0) && (maRecBuffer.getRecSize() == 0);
}
while( bValidRec && ((mbCont && isContinueId( maRecBuffer.getRecId() )) || bIsZeroRec) );
// setup other class members
setupRecord();
return isInRecord();
}
bool BiffInputStream::startRecordByHandle( sal_Int64 nRecHandle )
{
rewindToRecord( nRecHandle );
return startNextRecord();
}
void BiffInputStream::rewindRecord()
{
rewindToRecord( mnRecHandle );
}
// decoder --------------------------------------------------------------------
void BiffInputStream::setDecoder( const BiffDecoderRef& rxDecoder )
{
maRecBuffer.setDecoder( rxDecoder );
}
void BiffInputStream::enableDecoder( bool bEnable )
{
maRecBuffer.enableDecoder( bEnable );
}
// stream/record state and info -----------------------------------------------
sal_uInt16 BiffInputStream::getNextRecId()
{
sal_uInt16 nRecId = BIFF_ID_UNKNOWN;
if( isInRecord() )
{
sal_Int64 nCurrPos = tell(); // save current position in record
while( jumpToNextContinue() ) {} // skip following CONTINUE records
if( maRecBuffer.startNextRecord() ) // read header of next record
nRecId = maRecBuffer.getRecId();
seek( nCurrPos ); // restore position, seek() resets old mbValid state
}
return nRecId;
}
// BinaryStreamBase interface (seeking) ---------------------------------------
sal_Int64 BiffInputStream::size() const
{
if( !mbHasComplRec )
const_cast< BiffInputStream* >( this )->calcRecordLength();
return mnComplRecSize;
}
sal_Int64 BiffInputStream::tell() const
{
return mbEof ? -1 : (mnCurrRecSize - maRecBuffer.getRecLeft());
}
void BiffInputStream::seek( sal_Int64 nRecPos )
{
if( isInRecord() )
{
if( mbEof || (nRecPos < tell()) )
restartRecord( false );
if( !mbEof && (nRecPos > tell()) )
skip( static_cast< sal_Int32 >( nRecPos - tell() ) );
}
}
void BiffInputStream::close()
{
}
// BinaryInputStream interface (stream read access) ---------------------------
sal_Int32 BiffInputStream::readData( StreamDataSequence& orData, sal_Int32 nBytes, size_t nAtomSize )
{
sal_Int32 nRet = 0;
if( !mbEof )
{
orData.realloc( ::std::max< sal_Int32 >( nBytes, 0 ) );
if( nBytes > 0 )
nRet = readMemory( orData.getArray(), nBytes, nAtomSize );
}
return nRet;
}
sal_Int32 BiffInputStream::readMemory( void* opMem, sal_Int32 nBytes, size_t nAtomSize )
{
sal_Int32 nRet = 0;
if( !mbEof && opMem && (nBytes > 0) )
{
sal_uInt8* pnBuffer = reinterpret_cast< sal_uInt8* >( opMem );
sal_Int32 nBytesLeft = nBytes;
while( !mbEof && (nBytesLeft > 0) )
{
sal_uInt16 nReadSize = getMaxRawReadSize( nBytesLeft, nAtomSize );
// check nReadSize, stream may already be located at end of a raw record
if( nReadSize > 0 )
{
maRecBuffer.read( pnBuffer, nReadSize );
nRet += nReadSize;
pnBuffer += nReadSize;
nBytesLeft -= nReadSize;
}
if( nBytesLeft > 0 )
jumpToNextContinue();
OSL_ENSURE( !mbEof, "BiffInputStream::readMemory - record overread" );
}
}
return nRet;
}
void BiffInputStream::skip( sal_Int32 nBytes, size_t nAtomSize )
{
sal_Int32 nBytesLeft = nBytes;
while( !mbEof && (nBytesLeft > 0) )
{
sal_uInt16 nSkipSize = getMaxRawReadSize( nBytesLeft, nAtomSize );
// check nSkipSize, stream may already be located at end of a raw record
if( nSkipSize > 0 )
{
maRecBuffer.skip( nSkipSize );
nBytesLeft -= nSkipSize;
}
if( nBytesLeft > 0 )
jumpToNextContinue();
OSL_ENSURE( !mbEof, "BiffInputStream::skip - record overread" );
}
}
// byte strings ---------------------------------------------------------------
OString BiffInputStream::readByteString( bool b16BitLen, bool bAllowNulChars )
{
sal_Int32 nStrLen = b16BitLen ? readuInt16() : readuInt8();
return readCharArray( nStrLen, bAllowNulChars );
}
OUString BiffInputStream::readByteStringUC( bool b16BitLen, rtl_TextEncoding eTextEnc, bool bAllowNulChars )
{
return OStringToOUString( readByteString( b16BitLen, bAllowNulChars ), eTextEnc );
}
// Unicode strings ------------------------------------------------------------
OUString BiffInputStream::readUniStringChars( sal_uInt16 nChars, bool b16BitChars, bool bAllowNulChars )
{
OUStringBuffer aBuffer;
aBuffer.ensureCapacity( nChars );
/* This function has to react on CONTINUE records which repeat the flags
field in their first byte and may change the 8bit/16bit character mode,
thus a plain call to readCompressedUnicodeArray() cannot be used here. */
sal_Int32 nCharsLeft = nChars;
while( !mbEof && (nCharsLeft > 0) )
{
/* Read the character array from the remaining part of the current raw
record. First, calculate the maximum number of characters that can
be read without triggering to start a following CONTINUE record. */
sal_Int32 nRawChars = b16BitChars ? (getMaxRawReadSize( nCharsLeft * 2, 2 ) / 2) : getMaxRawReadSize( nCharsLeft, 1 );
aBuffer.append( readCompressedUnicodeArray( nRawChars, !b16BitChars, bAllowNulChars ) );
/* Prepare for next CONTINUE record. Calling jumpToNextStringContinue()
reads the leading byte in the following CONTINUE record and updates
the b16BitChars flag. */
nCharsLeft -= nRawChars;
if( nCharsLeft > 0 )
jumpToNextStringContinue( b16BitChars );
}
return aBuffer.makeStringAndClear();
}
OUString BiffInputStream::readUniStringBody( sal_uInt16 nChars, bool bAllowNulChars )
{
bool b16BitChars;
sal_Int32 nAddSize;
readUniStringHeader( b16BitChars, nAddSize );
OUString aString = readUniStringChars( nChars, b16BitChars, bAllowNulChars );
skip( nAddSize );
return aString;
}
OUString BiffInputStream::readUniString( bool bAllowNulChars )
{
return readUniStringBody( readuInt16(), bAllowNulChars );
}
// private --------------------------------------------------------------------
void BiffInputStream::setupRecord()
{
// initialize class members
mnRecHandle = maRecBuffer.getRecHeaderPos();
mnRecId = maRecBuffer.getRecId();
mnAltContId = BIFF_ID_UNKNOWN;
mnCurrRecSize = mnComplRecSize = maRecBuffer.getRecSize();
mbHasComplRec = !mbCont;
mbEof = !isInRecord();
// enable decoder in new record
enableDecoder( true );
}
void BiffInputStream::restartRecord( bool bInvalidateRecSize )
{
if( isInRecord() )
{
maRecBuffer.startRecord( getRecHandle() );
mnCurrRecSize = maRecBuffer.getRecSize();
if( bInvalidateRecSize )
{
mnComplRecSize = mnCurrRecSize;
mbHasComplRec = !mbCont;
}
mbEof = false;
}
}
void BiffInputStream::rewindToRecord( sal_Int64 nRecHandle )
{
if( nRecHandle >= 0 )
{
maRecBuffer.restartAt( nRecHandle );
mnRecHandle = -1;
mbEof = true; // as long as the record is not started
}
}
bool BiffInputStream::isContinueId( sal_uInt16 nRecId ) const
{
return (nRecId == BIFF_ID_CONT) || (nRecId == mnAltContId);
}
bool BiffInputStream::jumpToNextContinue()
{
mbEof = mbEof || !mbCont || !isContinueId( maRecBuffer.getNextRecId() ) || !maRecBuffer.startNextRecord();
if( !mbEof )
mnCurrRecSize += maRecBuffer.getRecSize();
return !mbEof;
}
bool BiffInputStream::jumpToNextStringContinue( bool& rb16BitChars )
{
OSL_ENSURE( maRecBuffer.getRecLeft() == 0, "BiffInputStream::jumpToNextStringContinue - alignment error" );
if( mbCont && (getRemaining() > 0) )
{
jumpToNextContinue();
}
else if( mnRecId == BIFF_ID_CONT )
{
/* CONTINUE handling is off, but we have started reading in a CONTINUE
record -> start next CONTINUE for TXO import. We really start a new
record here - no chance to return to string origin. */
mbEof = mbEof || (maRecBuffer.getNextRecId() != BIFF_ID_CONT) || !maRecBuffer.startNextRecord();
if( !mbEof )
setupRecord();
}
// trying to read the flags invalidates stream, if no CONTINUE record has been found
sal_uInt8 nFlags = readuInt8();
rb16BitChars = getFlag( nFlags, BIFF_STRF_16BIT );
return !mbEof;
}
void BiffInputStream::calcRecordLength()
{
sal_Int64 nCurrPos = tell(); // save current position in record
while( jumpToNextContinue() ) {} // jumpToNextContinue() adds up mnCurrRecSize
mnComplRecSize = mnCurrRecSize;
mbHasComplRec = true;
seek( nCurrPos ); // restore position, seek() resets old mbValid state
}
sal_uInt16 BiffInputStream::getMaxRawReadSize( sal_Int32 nBytes, size_t nAtomSize ) const
{
sal_uInt16 nMaxSize = getLimitedValue< sal_uInt16, sal_Int32 >( nBytes, 0, maRecBuffer.getRecLeft() );
if( (0 < nMaxSize) && (nMaxSize < nBytes) && (nAtomSize > 1) )
{
// check that remaining data in record buffer is a multiple of the passed atom size
sal_uInt16 nPadding = static_cast< sal_uInt16 >( nMaxSize % nAtomSize );
OSL_ENSURE( nPadding == 0, "BiffInputStream::getMaxRawReadSize - alignment error" );
nMaxSize = nMaxSize - nPadding;
}
return nMaxSize;
}
void BiffInputStream::readUniStringHeader( bool& orb16BitChars, sal_Int32& ornAddSize )
{
sal_uInt8 nFlags = readuInt8();
OSL_ENSURE( !getFlag( nFlags, BIFF_STRF_UNKNOWN ), "BiffInputStream::readUniStringHeader - unknown flags" );
orb16BitChars = getFlag( nFlags, BIFF_STRF_16BIT );
sal_uInt16 nFontCount = getFlag( nFlags, BIFF_STRF_RICH ) ? readuInt16() : 0;
sal_Int32 nPhoneticSize = getFlag( nFlags, BIFF_STRF_PHONETIC ) ? readInt32() : 0;
ornAddSize = 4 * nFontCount + ::std::max< sal_Int32 >( 0, nPhoneticSize );
}
BiffInputStreamPos::BiffInputStreamPos( BiffInputStream& rStrm ) :
mrStrm( rStrm ),
mnRecHandle( rStrm.getRecHandle() ),
mnRecPos( rStrm.tell() )
{
}
bool BiffInputStreamPos::restorePosition()
{
bool bValidRec = mrStrm.startRecordByHandle( mnRecHandle );
if( bValidRec )
mrStrm.seek( mnRecPos );
return bValidRec && !mrStrm.isEof();
}
BiffInputStreamPosGuard::BiffInputStreamPosGuard( BiffInputStream& rStrm ) :
BiffInputStreamPos( rStrm )
{
}
BiffInputStreamPosGuard::~BiffInputStreamPosGuard()
{
restorePosition();
}
} // namespace xls
} // namespace oox
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|