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 :
21 : #include <string.h>
22 : #include <rtl/ustring.hxx>
23 : #include <com/sun/star/lang/Locale.hpp>
24 : #include <unotools/charclass.hxx>
25 : #include "sot/stg.hxx"
26 : #include "stgelem.hxx"
27 : #include "stgcache.hxx"
28 : #include "stgstrms.hxx"
29 : #include "stgdir.hxx"
30 : #include "stgio.hxx"
31 :
32 : static const sal_uInt16 nMaxLegalStr = 31;
33 :
34 : static const sal_uInt8 cStgSignature[ 8 ] = { 0xD0,0xCF,0x11,0xE0,0xA1,0xB1,0x1A,0xE1 };
35 :
36 : ////////////////////////////// struct ClsId
37 :
38 0 : SvStream& ReadClsId( SvStream& r, ClsId& rId )
39 : {
40 0 : r.ReadInt32( rId.n1 )
41 0 : .ReadInt16( rId.n2 )
42 0 : .ReadInt16( rId.n3 )
43 0 : .ReadUChar( rId.n4 )
44 0 : .ReadUChar( rId.n5 )
45 0 : .ReadUChar( rId.n6 )
46 0 : .ReadUChar( rId.n7 )
47 0 : .ReadUChar( rId.n8 )
48 0 : .ReadUChar( rId.n9 )
49 0 : .ReadUChar( rId.n10 )
50 0 : .ReadUChar( rId.n11 );
51 0 : return r;
52 : }
53 :
54 0 : SvStream& WriteClsId( SvStream& r, const ClsId& rId )
55 : {
56 : return
57 0 : r .WriteInt32( (sal_Int32) rId.n1 )
58 0 : .WriteInt16( (sal_Int16) rId.n2 )
59 0 : .WriteInt16( (sal_Int16) rId.n3 )
60 0 : .WriteUChar( (sal_uInt8) rId.n4 )
61 0 : .WriteUChar( (sal_uInt8) rId.n5 )
62 0 : .WriteUChar( (sal_uInt8) rId.n6 )
63 0 : .WriteUChar( (sal_uInt8) rId.n7 )
64 0 : .WriteUChar( (sal_uInt8) rId.n8 )
65 0 : .WriteUChar( (sal_uInt8) rId.n9 )
66 0 : .WriteUChar( (sal_uInt8) rId.n10 )
67 0 : .WriteUChar( (sal_uInt8) rId.n11 );
68 : }
69 :
70 : ///////////////////////////// class StgHeader
71 :
72 0 : StgHeader::StgHeader()
73 : : nVersion( 0 )
74 : , nByteOrder( 0 )
75 : , nPageSize( 0 )
76 : , nDataPageSize( 0 )
77 : , bDirty( 0 )
78 : , nFATSize( 0 )
79 : , nTOCstrm( 0 )
80 : , nReserved( 0 )
81 : , nThreshold( 0 )
82 : , nDataFAT( 0 )
83 : , nDataFATSize( 0 )
84 : , nMasterChain( 0 )
85 0 : , nMaster( 0 )
86 : {
87 0 : memset( cSignature, 0, sizeof( cSignature ) );
88 0 : memset( &aClsId, 0, sizeof( ClsId ) );
89 0 : memset( cReserved, 0, sizeof( cReserved ) );
90 0 : memset( nMasterFAT, 0, sizeof( nMasterFAT ) );
91 0 : }
92 :
93 0 : void StgHeader::Init()
94 : {
95 0 : memcpy( cSignature, cStgSignature, 8 );
96 0 : memset( &aClsId, 0, sizeof( ClsId ) );
97 0 : nVersion = 0x0003003B;
98 0 : nByteOrder = 0xFFFE;
99 0 : nPageSize = 9; // 512 bytes
100 0 : nDataPageSize = 6; // 64 bytes
101 0 : bDirty = 0;
102 0 : memset( cReserved, 0, sizeof( cReserved ) );
103 0 : nFATSize = 0;
104 0 : nTOCstrm = 0;
105 0 : nReserved = 0;
106 0 : nThreshold = 4096;
107 0 : nDataFAT = 0;
108 0 : nDataFATSize = 0;
109 0 : nMasterChain = STG_EOF;
110 :
111 0 : SetTOCStart( STG_EOF );
112 0 : SetDataFATStart( STG_EOF );
113 0 : for( short i = 0; i < cFATPagesInHeader; i++ )
114 0 : SetFATPage( i, STG_FREE );
115 0 : }
116 :
117 0 : bool StgHeader::Load( StgIo& rIo )
118 : {
119 0 : bool bResult = false;
120 0 : if ( rIo.GetStrm() )
121 : {
122 0 : SvStream& r = *rIo.GetStrm();
123 0 : bResult = Load( r );
124 0 : bResult = ( bResult && rIo.Good() );
125 : }
126 :
127 0 : return bResult;
128 : }
129 :
130 0 : bool StgHeader::Load( SvStream& r )
131 : {
132 0 : r.Seek( 0L );
133 0 : r.Read( cSignature, 8 );
134 0 : ReadClsId( r, aClsId ); // 08 Class ID
135 0 : r.ReadInt32( nVersion ) // 1A version number
136 0 : .ReadUInt16( nByteOrder ) // 1C Unicode byte order indicator
137 0 : .ReadInt16( nPageSize ) // 1E 1 << nPageSize = block size
138 0 : .ReadInt16( nDataPageSize ); // 20 1 << this size == data block size
139 0 : r.SeekRel( 10 );
140 0 : r.ReadInt32( nFATSize ) // 2C total number of FAT pages
141 0 : .ReadInt32( nTOCstrm ) // 30 starting page for the TOC stream
142 0 : .ReadInt32( nReserved ) // 34
143 0 : .ReadInt32( nThreshold ) // 38 minimum file size for big data
144 0 : .ReadInt32( nDataFAT ) // 3C page # of 1st data FAT block
145 0 : .ReadInt32( nDataFATSize ) // 40 # of data FATpages
146 0 : .ReadInt32( nMasterChain ) // 44 chain to the next master block
147 0 : .ReadInt32( nMaster ); // 48 # of additional master blocks
148 0 : for( short i = 0; i < cFATPagesInHeader; i++ )
149 0 : r.ReadInt32( nMasterFAT[ i ] );
150 :
151 0 : return (r.GetErrorCode() == ERRCODE_NONE) && Check();
152 : }
153 :
154 0 : bool StgHeader::Store( StgIo& rIo )
155 : {
156 0 : if( !bDirty )
157 0 : return true;
158 :
159 0 : SvStream& r = *rIo.GetStrm();
160 0 : r.Seek( 0L );
161 0 : r.Write( cSignature, 8 );
162 0 : WriteClsId( r, aClsId ); // 08 Class ID
163 0 : r.WriteInt32( nVersion ) // 1A version number
164 0 : .WriteUInt16( nByteOrder ) // 1C Unicode byte order indicator
165 0 : .WriteInt16( nPageSize ) // 1E 1 << nPageSize = block size
166 0 : .WriteInt16( nDataPageSize ) // 20 1 << this size == data block size
167 0 : .WriteInt32( (sal_Int32) 0 ).WriteInt32( (sal_Int32) 0 ).WriteInt16( (sal_Int16) 0 )
168 0 : .WriteInt32( nFATSize ) // 2C total number of FAT pages
169 0 : .WriteInt32( nTOCstrm ) // 30 starting page for the TOC stream
170 0 : .WriteInt32( nReserved ) // 34
171 0 : .WriteInt32( nThreshold ) // 38 minimum file size for big data
172 0 : .WriteInt32( nDataFAT ) // 3C page # of 1st data FAT block
173 0 : .WriteInt32( nDataFATSize ) // 40 # of data FAT pages
174 0 : .WriteInt32( nMasterChain ) // 44 chain to the next master block
175 0 : .WriteInt32( nMaster ); // 48 # of additional master blocks
176 0 : for( short i = 0; i < cFATPagesInHeader; i++ )
177 0 : r.WriteInt32( nMasterFAT[ i ] );
178 0 : bDirty = !rIo.Good();
179 0 : return !bDirty;
180 : }
181 :
182 0 : static bool lcl_wontoverflow(short shift)
183 : {
184 0 : return shift >= 0 && shift < (short)sizeof(short) * 8 - 1;
185 : }
186 :
187 0 : static bool isKnownSpecial(sal_Int32 nLocation)
188 : {
189 0 : return (nLocation == STG_FREE ||
190 0 : nLocation == STG_EOF ||
191 0 : nLocation == STG_FAT ||
192 0 : nLocation == STG_MASTER);
193 : }
194 :
195 : // Perform thorough checks also on unknown variables
196 0 : bool StgHeader::Check()
197 : {
198 0 : return memcmp( cSignature, cStgSignature, 8 ) == 0
199 0 : && (short) ( nVersion >> 16 ) == 3
200 0 : && nPageSize == 9
201 0 : && lcl_wontoverflow(nPageSize)
202 0 : && lcl_wontoverflow(nDataPageSize)
203 0 : && nFATSize > 0
204 0 : && nTOCstrm >= 0
205 0 : && nThreshold > 0
206 0 : && ( isKnownSpecial(nDataFAT) || ( nDataFAT >= 0 && nDataFATSize > 0 ) )
207 0 : && ( isKnownSpecial(nMasterChain) || nMasterChain >=0 )
208 0 : && nMaster >= 0;
209 : }
210 :
211 0 : sal_Int32 StgHeader::GetFATPage( short n ) const
212 : {
213 0 : if( n >= 0 && n < cFATPagesInHeader )
214 0 : return nMasterFAT[ n ];
215 : else
216 0 : return STG_EOF;
217 : }
218 :
219 0 : void StgHeader::SetFATPage( short n, sal_Int32 nb )
220 : {
221 0 : if( n >= 0 && n < cFATPagesInHeader )
222 : {
223 0 : if( nMasterFAT[ n ] != nb )
224 0 : bDirty = sal_True, nMasterFAT[ n ] = nb;
225 : }
226 0 : }
227 :
228 0 : void StgHeader::SetTOCStart( sal_Int32 n )
229 : {
230 0 : if( n != nTOCstrm ) bDirty = sal_True, nTOCstrm = n;
231 0 : }
232 :
233 0 : void StgHeader::SetDataFATStart( sal_Int32 n )
234 : {
235 0 : if( n != nDataFAT ) bDirty = sal_True, nDataFAT = n;
236 0 : }
237 :
238 0 : void StgHeader::SetDataFATSize( sal_Int32 n )
239 : {
240 0 : if( n != nDataFATSize ) bDirty = sal_True, nDataFATSize = n;
241 0 : }
242 :
243 0 : void StgHeader::SetFATSize( sal_Int32 n )
244 : {
245 0 : if( n != nFATSize ) bDirty = sal_True, nFATSize = n;
246 0 : }
247 :
248 0 : void StgHeader::SetFATChain( sal_Int32 n )
249 : {
250 0 : if( n != nMasterChain )
251 0 : bDirty = sal_True, nMasterChain = n;
252 0 : }
253 :
254 0 : void StgHeader::SetMasters( sal_Int32 n )
255 : {
256 0 : if( n != nMaster ) bDirty = sal_True, nMaster = n;
257 0 : }
258 :
259 : ///////////////////////////// class StgEntry
260 :
261 0 : bool StgEntry::Init()
262 : {
263 0 : memset( nName, 0, sizeof( nName ) );
264 0 : nNameLen = 0;
265 0 : cType = 0;
266 0 : cFlags = 0;
267 0 : nLeft = 0;
268 0 : nRight = 0;
269 0 : nChild = 0;
270 0 : memset( &aClsId, 0, sizeof( aClsId ) );
271 0 : nFlags = 0;
272 0 : nMtime[0] = 0; nMtime[1] = 0;
273 0 : nAtime[0] = 0; nAtime[1] = 0;
274 0 : nPage1 = 0;
275 0 : nSize = 0;
276 0 : nUnknown = 0;
277 :
278 0 : SetLeaf( STG_LEFT, STG_FREE );
279 0 : SetLeaf( STG_RIGHT, STG_FREE );
280 0 : SetLeaf( STG_CHILD, STG_FREE );
281 0 : SetLeaf( STG_DATA, STG_EOF );
282 0 : return true;
283 : }
284 :
285 0 : static OUString ToUpperUnicode( const OUString & rStr )
286 : {
287 : // I don't know the locale, so en_US is hopefully fine
288 0 : static CharClass aCC( LanguageTag( com::sun::star::lang::Locale( "en", "US", "" )) );
289 0 : return aCC.uppercase( rStr );
290 : }
291 :
292 0 : bool StgEntry::SetName( const OUString& rName )
293 : {
294 : // I don't know the locale, so en_US is hopefully fine
295 0 : aName = ToUpperUnicode( rName );
296 0 : if(aName.getLength() > nMaxLegalStr)
297 : {
298 0 : aName = aName.copy(0, nMaxLegalStr);
299 : }
300 :
301 : sal_uInt16 i;
302 0 : for( i = 0; i < rName.getLength() && i <= nMaxLegalStr; i++ )
303 : {
304 0 : nName[ i ] = rName[ i ];
305 : }
306 0 : while (i <= nMaxLegalStr)
307 : {
308 0 : nName[ i++ ] = 0;
309 : }
310 0 : nNameLen = ( rName.getLength() + 1 ) << 1;
311 0 : return true;
312 : }
313 :
314 0 : sal_Int32 StgEntry::GetLeaf( StgEntryRef eRef ) const
315 : {
316 0 : sal_Int32 n = -1;
317 0 : switch( eRef )
318 : {
319 0 : case STG_LEFT: n = nLeft; break;
320 0 : case STG_RIGHT: n = nRight; break;
321 0 : case STG_CHILD: n = nChild; break;
322 0 : case STG_DATA: n = nPage1; break;
323 : }
324 0 : return n;
325 : }
326 :
327 0 : void StgEntry::SetLeaf( StgEntryRef eRef, sal_Int32 nPage )
328 : {
329 0 : switch( eRef )
330 : {
331 0 : case STG_LEFT: nLeft = nPage; break;
332 0 : case STG_RIGHT: nRight = nPage; break;
333 0 : case STG_CHILD: nChild = nPage; break;
334 0 : case STG_DATA: nPage1 = nPage; break;
335 : }
336 0 : }
337 :
338 0 : void StgEntry::SetClassId( const ClsId& r )
339 : {
340 0 : memcpy( &aClsId, &r, sizeof( ClsId ) );
341 0 : }
342 :
343 0 : void StgEntry::GetName( OUString& rName ) const
344 : {
345 0 : sal_uInt16 n = nNameLen;
346 0 : if( n )
347 0 : n = ( n >> 1 ) - 1;
348 0 : rName = OUString(nName, n);
349 0 : }
350 :
351 : // Compare two entries. Do this case-insensitive.
352 :
353 0 : short StgEntry::Compare( const StgEntry& r ) const
354 : {
355 0 : sal_Int32 nRes = r.nNameLen - nNameLen;
356 0 : if( !nRes )
357 0 : nRes = r.aName.compareTo( aName );
358 :
359 0 : return (short)nRes;
360 : }
361 :
362 : // These load/store operations are a bit more complicated,
363 : // since they have to copy their contents into a packed structure.
364 :
365 0 : bool StgEntry::Load( const void* pFrom, sal_uInt32 nBufSize )
366 : {
367 0 : if ( nBufSize < 128 )
368 0 : return false;
369 :
370 0 : SvMemoryStream r( (sal_Char*) pFrom, nBufSize, STREAM_READ );
371 0 : for( short i = 0; i < 32; i++ )
372 0 : r.ReadUInt16( nName[ i ] ); // 00 name as WCHAR
373 0 : r.ReadUInt16( nNameLen ) // 40 size of name in bytes including 00H
374 0 : .ReadUChar( cType ) // 42 entry type
375 0 : .ReadUChar( cFlags ) // 43 0 or 1 (tree balance?)
376 0 : .ReadInt32( nLeft ) // 44 left node entry
377 0 : .ReadInt32( nRight ) // 48 right node entry
378 0 : .ReadInt32( nChild ); // 4C 1st child entry if storage
379 0 : ReadClsId( r, aClsId ); // 50 class ID (optional)
380 0 : r.ReadInt32( nFlags ) // 60 state flags(?)
381 0 : .ReadInt32( nMtime[ 0 ] ) // 64 modification time
382 0 : .ReadInt32( nMtime[ 1 ] ) // 64 modification time
383 0 : .ReadInt32( nAtime[ 0 ] ) // 6C creation and access time
384 0 : .ReadInt32( nAtime[ 1 ] ) // 6C creation and access time
385 0 : .ReadInt32( nPage1 ) // 74 starting block (either direct or translated)
386 0 : .ReadInt32( nSize ) // 78 file size
387 0 : .ReadInt32( nUnknown ); // 7C unknown
388 :
389 0 : sal_uInt16 n = nNameLen;
390 0 : if( n )
391 0 : n = ( n >> 1 ) - 1;
392 :
393 0 : if (n > nMaxLegalStr)
394 0 : return false;
395 :
396 0 : if ((cType != STG_STORAGE) && ((nSize < 0) || (nPage1 < 0 && !isKnownSpecial(nPage1))))
397 : {
398 : // the size makes no sense for the substorage
399 : // TODO/LATER: actually the size should be an unsigned value, but in this case it would mean a stream of more than 2Gb
400 0 : return false;
401 : }
402 :
403 0 : aName = OUString(nName , n);
404 : // I don't know the locale, so en_US is hopefully fine
405 0 : aName = ToUpperUnicode( aName );
406 0 : if(aName.getLength() > nMaxLegalStr)
407 : {
408 0 : aName = aName.copy(0, nMaxLegalStr);
409 : }
410 :
411 0 : return true;
412 : }
413 :
414 0 : void StgEntry::Store( void* pTo )
415 : {
416 0 : SvMemoryStream r( (sal_Char *)pTo, 128, STREAM_WRITE );
417 0 : for( short i = 0; i < 32; i++ )
418 0 : r.WriteUInt16( nName[ i ] ); // 00 name as WCHAR
419 0 : r.WriteUInt16( nNameLen ) // 40 size of name in bytes including 00H
420 0 : .WriteUChar( cType ) // 42 entry type
421 0 : .WriteUChar( cFlags ) // 43 0 or 1 (tree balance?)
422 0 : .WriteInt32( nLeft ) // 44 left node entry
423 0 : .WriteInt32( nRight ) // 48 right node entry
424 0 : .WriteInt32( nChild ); // 4C 1st child entry if storage;
425 0 : WriteClsId( r, aClsId ); // 50 class ID (optional)
426 0 : r.WriteInt32( nFlags ) // 60 state flags(?)
427 0 : .WriteInt32( nMtime[ 0 ] ) // 64 modification time
428 0 : .WriteInt32( nMtime[ 1 ] ) // 64 modification time
429 0 : .WriteInt32( nAtime[ 0 ] ) // 6C creation and access time
430 0 : .WriteInt32( nAtime[ 1 ] ) // 6C creation and access time
431 0 : .WriteInt32( nPage1 ) // 74 starting block (either direct or translated)
432 0 : .WriteInt32( nSize ) // 78 file size
433 0 : .WriteInt32( nUnknown ); // 7C unknown
434 0 : }
435 :
436 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
