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
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: IBM Corporation
*
* Copyright: 2008 by IBM Corporation
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#include <sal/config.h>
#include <cstring>
#include "first.hxx"
#include <assert.h>
namespace OpenStormBento
{
BenError
CBenTOCReader::ReadLabelAndTOC()
{
BenError Err;
unsigned long TOCOffset;
if ((Err = ReadLabel(&TOCOffset, &cTOCSize)) != BenErr_OK)
return Err;
sal_uLong nLength = cpContainer->GetSize();
if (TOCOffset > nLength)
return BenErr_ReadPastEndOfTOC;
if (cTOCSize > nLength - TOCOffset)
return BenErr_ReadPastEndOfTOC;
if ((Err = cpContainer->SeekToPosition(TOCOffset)) != BenErr_OK)
return Err;
cpTOC.reset( new BenByte[cTOCSize] );
if ((Err = cpContainer->ReadKnownSize(cpTOC.get(), cTOCSize)) != BenErr_OK)
return Err;
if ((Err = ReadTOC()) != BenErr_OK)
return Err;
return BenErr_OK;
}
BenError
CBenTOCReader::ReadLabel(unsigned long * pTOCOffset, unsigned long * pTOCSize)
{
// If seek fails, then probably because stream is smaller than
// BEN_LABEL_SIZE and thus can't be Bento container
BenError Err;
if ((Err = cpContainer->SeekFromEnd(-BEN_LABEL_SIZE)) != BenErr_OK)
return BenErr_NotBentoContainer;
BenByte Label[BEN_LABEL_SIZE];
if ((Err = cpContainer->ReadKnownSize(Label, BEN_LABEL_SIZE)) != BenErr_OK)
return Err;
if (memcmp(Label, gsBenMagicBytes, BEN_MAGIC_BYTES_SIZE) != 0)
if ((Err = SearchForLabel(Label)) != BenErr_OK)
return Err;
BenByte * pCurrLabel = Label + BEN_MAGIC_BYTES_SIZE;
BenWord Flags =
UtGetIntelWord(pCurrLabel); pCurrLabel += 2; // Flags
// Newer files are 0x0101--indicates if big or little endian. Older
// files are 0x0 for flags
if (Flags != 0x0101 && Flags != 0x0)
return BenErr_UnknownBentoFormatVersion;
cBlockSize = UtGetIntelWord(pCurrLabel) * 1024; pCurrLabel += 2;
if (cBlockSize == 0)
return BenErr_NotBentoContainer;
// Check major version
if (UtGetIntelWord(pCurrLabel) != BEN_CURR_MAJOR_VERSION)
return BenErr_UnknownBentoFormatVersion;
pCurrLabel += 2;
pCurrLabel += 2; // Minor version
*pTOCOffset = UtGetIntelDWord(pCurrLabel); pCurrLabel += 4;
*pTOCSize = UtGetIntelDWord(pCurrLabel);
assert(pCurrLabel + 4 == Label + BEN_LABEL_SIZE);
return BenErr_OK;
}
#define LABEL_READ_BUFFER_SIZE 500
#define MAX_SEARCH_AMOUNT 1024 * 1024
BenError
CBenTOCReader::SearchForLabel(BenByte * pLabel)
{
BenError Err;
sal_uLong Length = cpContainer->GetSize();
// Always ready to check for MagicBytes from
// CurrOffset - BEN_MAGIC_BYTES_SIZE to CurrOffset - 1
unsigned long CurrOffset = Length - BEN_LABEL_SIZE + BEN_MAGIC_BYTES_SIZE -
1;
char Buffer[LABEL_READ_BUFFER_SIZE] = {0};
unsigned long BufferStartOffset = Length; // Init to big value
while (CurrOffset >= BEN_MAGIC_BYTES_SIZE)
{
// Don't search backwards more than 1 meg
if (Length - CurrOffset > MAX_SEARCH_AMOUNT)
break;
// If before beginning of buffer
if (CurrOffset - BEN_MAGIC_BYTES_SIZE < BufferStartOffset)
{
unsigned long UsedBufferSize;
if (CurrOffset < LABEL_READ_BUFFER_SIZE)
UsedBufferSize = CurrOffset;
else UsedBufferSize = LABEL_READ_BUFFER_SIZE;
if ((Err = cpContainer->SeekToPosition(CurrOffset - UsedBufferSize))
!= BenErr_OK)
return Err;
if ((Err = cpContainer->ReadKnownSize(Buffer, UsedBufferSize)) !=
BenErr_OK)
return Err;
BufferStartOffset = CurrOffset - UsedBufferSize;
}
if (memcmp(Buffer + (CurrOffset - BEN_MAGIC_BYTES_SIZE -
BufferStartOffset), gsBenMagicBytes, BEN_MAGIC_BYTES_SIZE) == 0)
{
if ((Err = cpContainer->SeekToPosition(CurrOffset -
BEN_MAGIC_BYTES_SIZE)) != BenErr_OK)
return Err;
return cpContainer->ReadKnownSize(pLabel, BEN_LABEL_SIZE);
}
--CurrOffset;
}
return BenErr_NotBentoContainer; // Didn't find magic bytes
}
BenError
CBenTOCReader::ReadTOC()
{
BenError Err;
BenByte LookAhead = GetCode();
BenGeneration Generation = 0;
// Read in all objects
while (LookAhead == BEN_NEW_OBJECT)
{
BenObjectID ObjectID;
if ((Err = GetDWord(&ObjectID)) != BenErr_OK)
return Err;
CBenObject * pObject = nullptr;
// Read in all properties for object
do
{
BenObjectID PropertyID;
if ((Err = GetDWord(&PropertyID)) != BenErr_OK)
return Err;
CBenProperty * pProperty = nullptr;
// Read in all values for property
do
{
BenObjectID ReferencedListID = 0;
BenObjectID TypeID;
if ((Err = GetDWord(&TypeID)) != BenErr_OK)
return Err;
LookAhead = GetCode();
if (LookAhead == BEN_EXPLICIT_GEN)
{
if ((Err = GetDWord(&Generation)) != BenErr_OK)
return Err;
LookAhead = GetCode();
}
if (LookAhead == BEN_REFERENCE_LIST_ID)
{
if ((Err = GetDWord(&ReferencedListID)) != BenErr_OK)
return Err;
LookAhead = GetCode();
}
if (PropertyID == BEN_PROPID_GLOBAL_PROPERTY_NAME ||
PropertyID == BEN_PROPID_GLOBAL_TYPE_NAME)
{
// Read property or type name
if (pObject != nullptr || TypeID != BEN_TYPEID_7_BIT_ASCII ||
LookAhead != BEN_OFFSET4_LEN4)
return BenErr_NamedObjectError;
BenContainerPos Pos;
unsigned long Length;
if ((Err = GetDWord(&Pos)) != BenErr_OK)
return Err;
if ((Err = GetDWord(&Length)) != BenErr_OK)
return Err;
LookAhead = GetCode();
if ((Err = cpContainer->SeekToPosition(Pos)) != BenErr_OK)
return Err;
const auto nRemainingSize = cpContainer->remainingSize();
if (Length > nRemainingSize)
{
SAL_WARN("lwp", "stream too short for claimed no of records");
Length = nRemainingSize;
}
#define STACK_BUFFER_SIZE 256
char sStackBuffer[STACK_BUFFER_SIZE];
char * sAllocBuffer;
char * sBuffer;
if (Length > STACK_BUFFER_SIZE)
{
sBuffer = new char[Length];
sAllocBuffer = sBuffer;
}
else
{
sBuffer = sStackBuffer;
sAllocBuffer = nullptr;
}
if ((Err = cpContainer->ReadKnownSize(sBuffer, Length)) !=
BenErr_OK)
{
delete[] sAllocBuffer;
return Err;
}
OString sName(sBuffer, Length);
CUtListElmt * pPrevNamedObjectListElmt;
if (FindNamedObject(&cpContainer->GetNamedObjects(),
sName, &pPrevNamedObjectListElmt) != nullptr)
{
delete[] sAllocBuffer;
return BenErr_DuplicateName;
}
CUtListElmt* pPrevObject = cpContainer->GetObjects().GetLast();
if (PropertyID == BEN_PROPID_GLOBAL_PROPERTY_NAME)
pObject = new CBenPropertyName(cpContainer, ObjectID,
pPrevObject, sName, pPrevNamedObjectListElmt);
else pObject = new CBenTypeName(cpContainer, ObjectID,
pPrevObject, sName, pPrevNamedObjectListElmt);
delete[] sAllocBuffer;
}
else if (PropertyID == BEN_PROPID_OBJ_REFERENCES)
{
// Don't need to read in references object--we assume
// that all references use object ID as key
if ((Err = ReadSegments(nullptr, &LookAhead)) != BenErr_OK)
return Err;
}
else if (ObjectID == BEN_OBJID_TOC)
{
if (PropertyID == BEN_PROPID_TOC_SEED)
{
if (TypeID != BEN_TYPEID_TOC_TYPE ||
LookAhead != BEN_IMMEDIATE4)
return BenErr_TOCSeedError;
BenDWord Data;
if ((Err = GetDWord(&Data)) != BenErr_OK)
return Err;
LookAhead = GetCode();
cpContainer->SetNextAvailObjectID(Data);
}
else
{
// Ignore the other BEN_OBJID_TOC properties
if ((Err = ReadSegments(nullptr, &LookAhead)) != BenErr_OK)
return Err;
}
}
else
{
if (pProperty != nullptr)
return BenErr_PropertyWithMoreThanOneValue;
if (pObject == nullptr)
pObject = new CBenObject(cpContainer, ObjectID,
cpContainer->GetObjects().GetLast());
pProperty = new CBenProperty(pObject, PropertyID, TypeID,
pObject->GetProperties().GetLast());
if ((Err = ReadSegments(&pProperty->UseValue(),
&LookAhead)) != BenErr_OK)
return Err;
}
} while (LookAhead == BEN_NEW_TYPE);
} while (LookAhead == BEN_NEW_PROPERTY);
}
if (LookAhead == BEN_READ_PAST_END_OF_TOC)
return BenErr_OK;
else return BenErr_InvalidTOC;
}
BenError
CBenTOCReader::ReadSegments(CBenValue * pValue, BenByte * pLookAhead)
{
BenError Err;
while (*pLookAhead >= BEN_SEGMENT_CODE_START &&
*pLookAhead <= BEN_SEGMENT_CODE_END)
{
if ((Err = ReadSegment(pValue, pLookAhead)) !=
BenErr_OK)
return Err;
}
return BenErr_OK;
}
BenError
CBenTOCReader::ReadSegment(CBenValue * pValue, BenByte * pLookAhead)
{
BenError Err;
bool Immediate = false;
bool EightByteOffset = false;
unsigned long Offset(0), Length(0);
switch (*pLookAhead)
{
case BEN_CONT_OFFSET4_LEN4:
case BEN_OFFSET4_LEN4:
if ((Err = GetDWord(&Offset)) != BenErr_OK)
return Err;
if ((Err = GetDWord(&Length)) != BenErr_OK)
return Err;
break;
case BEN_IMMEDIATE0:
Length = 0; Immediate = true;
break;
case BEN_IMMEDIATE1:
Length = 1; Immediate = true;
break;
case BEN_IMMEDIATE2:
Length = 2; Immediate = true;
break;
case BEN_IMMEDIATE3:
Length = 3; Immediate = true;
break;
case BEN_CONT_IMMEDIATE4:
case BEN_IMMEDIATE4:
Length = 4; Immediate = true;
break;
case BEN_CONT_OFFSET8_LEN4:
case BEN_OFFSET8_LEN4:
EightByteOffset = true;
break;
default:
return BenErr_OK;
}
BenByte ImmData[4];
if (Immediate && Length != 0)
if ((Err = GetData(ImmData, 4)) != BenErr_OK)
return Err;
*pLookAhead = GetCode();
if (EightByteOffset)
return BenErr_64BitOffsetNotSupported;
if (pValue != nullptr)
{
if (! Immediate)
new CBenValueSegment(pValue, Offset, Length);
else if (Length != 0)
{
assert(Length <= 4);
new CBenValueSegment(pValue, ImmData, (unsigned short) Length);
}
}
return BenErr_OK;
}
bool
CBenTOCReader::CanGetData(unsigned long Amt)
{
return cCurr + Amt <= cTOCSize;
}
BenError
CBenTOCReader::GetByte(BenByte * pByte)
{
if (! CanGetData(1))
return BenErr_ReadPastEndOfTOC;
*pByte = UtGetIntelByte(cpTOC.get() + cCurr);
++cCurr;
return BenErr_OK;
}
BenError
CBenTOCReader::GetDWord(BenDWord * pDWord)
{
if (! CanGetData(4))
return BenErr_ReadPastEndOfTOC;
*pDWord = UtGetIntelDWord(cpTOC.get() + cCurr);
cCurr += 4;
return BenErr_OK;
}
BenByte
CBenTOCReader::GetCode()
{
BenByte Code;
do
{
if (GetByte(&Code) != BenErr_OK)
return BEN_READ_PAST_END_OF_TOC;
if (Code == BEN_END_OF_BUFFER)
// Advance to next block
cCurr = cBlockSize * ((cCurr + (cBlockSize - 1)) /
cBlockSize);
}
while (Code == BEN_NOOP || Code == BEN_END_OF_BUFFER);
return Code;
}
BenError
CBenTOCReader::GetData(void * pBuffer, unsigned long Amt)
{
if (! CanGetData(Amt))
return BenErr_ReadPastEndOfTOC;
std::memcpy(pBuffer, cpTOC.get() + cCurr, Amt);
cCurr += Amt;
return BenErr_OK;
}
}//end OpenStormBento namespace
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|