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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _FSYS_HXX
#define _FSYS_HXX
#include <tools/solar.h>
#include <tools/datetime.hxx>
#include <tools/string.hxx>
#include <tools/link.hxx>
#include <tools/wldcrd.hxx>
#ifndef __ERRCODE_HXX
#include <tools/errcode.hxx>
#endif
#include "tools/toolsdllapi.h"
#include <cstdarg>
#define FEAT_FSYS_DOUBLESPEED
// --------------
// - FSys-Types -
// --------------
class DirEntry;
class DirEntryList;
class FSysSortList;
class FileStatList;
struct FileCopier_Impl;
class SvFileStream;
class BigInt;
#define FSYS_BUFSIZE 1024
#define FSYS_SHORTNAME_DELIMITER '@'
// FSysAccess
typedef int FSysAccess;
#define FSYS_ACCESS_FORCED 1
#define FSYS_ACCESS_FLOPPY FSYS_ACCESS_FORCED
#define FSYS_ACCESS_CACHED 2
// DirEntryKind
typedef int DirEntryKind;
#define FSYS_KIND_NONE ((DirEntryKind) 0)
#define FSYS_KIND_UNKNOWN FSYS_KIND_NONE
#define FSYS_KIND_FILE ((DirEntryKind) 1)
#define FSYS_KIND_DIR ((DirEntryKind) 2)
#define FSYS_KIND_DEV ((DirEntryKind) 4)
#define FSYS_KIND_BLOCK ((DirEntryKind) 8)
#define FSYS_KIND_CHAR ((DirEntryKind) 16)
#define FSYS_KIND_WILD ((DirEntryKind) 32)
#define FSYS_KIND_BLOCK_REMOTE ((DirEntryKind) 64) //TPF: fuer RFS
#define FSYS_KIND_REMOVEABLE ((DirEntryKind) 128)
#define FSYS_KIND_FIXED ((DirEntryKind) 256)
#define FSYS_KIND_REMOTE ((DirEntryKind) 512)
#define FSYS_KIND_RAM ((DirEntryKind) 1024)
#define FSYS_KIND_CDROM ((DirEntryKind) 2048)
#define FSYS_KIND_ALL ((DirEntryKind) 4095)
#define FSYS_KIND_VISIBLE ((DirEntryKind) 4096)
// FSysSort
typedef int FSysSort;
#define FSYS_SORT_NONE ((FSysSort) 0)
#define FSYS_SORT_SIZE ((FSysSort) 1)
#define FSYS_SORT_CREATED ((FSysSort) 2)
#define FSYS_SORT_MODIFYED ((FSysSort) 4)
#define FSYS_SORT_ACCESSED ((FSysSort) 8)
#define FSYS_SORT_ASCENDING ((FSysSort) 16)
#define FSYS_SORT_DESCENDING ((FSysSort) 32)
#define FSYS_SORT_EXT ((FSysSort) 64)
#define FSYS_SORT_NAME ((FSysSort) 128)
#define FSYS_SORT_KIND ((FSysSort) 256)
#define FSYS_SORT_CREATOR ((FSysSort) 512)
#define FSYS_SORT_END ((FSysSort)1024)
// DirEntryFlag
enum DirEntryFlag
{
FSYS_FLAG_NORMAL,
FSYS_FLAG_VOLUME, // Dir( FSYS_FLAG_VOLUME ) und GetDevice()
FSYS_FLAG_ABSROOT, // z.B. "a:\" oder "\"
FSYS_FLAG_RELROOT, // z.B. "a:", "a:." oder "."
FSYS_FLAG_CURRENT = FSYS_FLAG_RELROOT, // Synonym fuer FSYS_FLAG_RELROOT
FSYS_FLAG_PARENT, // z.B. ".."
FSYS_FLAG_INVALID
};
// FSysPathStyle
enum FSysPathStyle
{
FSYS_STYLE_HOST,
FSYS_STYLE_FAT,
FSYS_STYLE_MSDOS = FSYS_STYLE_FAT,
FSYS_STYLE_VFAT,
FSYS_STYLE_WIN95 = FSYS_STYLE_VFAT,
FSYS_STYLE_HPFS,
FSYS_STYLE_OS2 = FSYS_STYLE_HPFS,
FSYS_STYLE_NTFS,
FSYS_STYLE_NWFS,
FSYS_STYLE_SYSV,
FSYS_STYLE_BSD,
FSYS_STYLE_UNX = FSYS_STYLE_BSD,
FSYS_STYLE_MAC,
FSYS_STYLE_DETECT,
FSYS_STYLE_UNKNOWN,
FSYS_STYLE_URL
};
// FSysAction
typedef int FSysAction;
#define FSYS_ACTION_COPYFILE 0x01 // not only create hardlink
#define FSYS_ACTION_RECURSIVE 0x02 // deep through dircetory structure
#define FSYS_ACTION_USERECYCLEBIN 0x04 // move to recycle bin
#define FSYS_ACTION_MOVE 0x08 // delete after copy (=> move)
#define FSYS_ACTION_CONTINUE 0x10 // continue on error
#define FSYS_ACTION_KEEP_EXISTING 0x20 // do not overwrite objects in
// target folder in case of name
// clashes
#define FSYS_ACTION_STANDARD 0
// Fuer RFS
#define RFS_IDENTIFIER "-rfs-"
#define RFS_LOWER "-rfs-"
#define RFS_UPPER "-RFS-"
typedef ULONG FSysError;
// FSysExact
enum FSysExact
{
FSYS_NOTEXACT,
FSYS_EXACT
};
// ------------
// - Char-Set -
// ------------
#if defined(WIN) || defined(W30)
// MS-Windows has different char-sets for file-system and user-interface
String Gui2FSys( const String& rStr );
String FSys2Gui( const String& rStr );
#define GUI2FSYS(s) Gui2FSys( s )
#define FSYS2GUI(s) FSys2Gui( s )
#else
// all other OS have the same char-set for both
#define GUI2FSYS(s) s
#define FSYS2GUI(s) s
#endif
// ------------
// - FileStat -
// ------------
struct dirent;
class TOOLS_DLLPUBLIC FileStat
{
friend class CORmFSys;
friend class Dir;
friend struct DirReader_Impl;
friend void ImpInitFileStat( FileStat&, dirent* );
ULONG nError;
DirEntryKind nKindFlags;
ULONG nSize;
String aCreator;
String aType;
Date aDateCreated;
Time aTimeCreated;
Date aDateModified;
Time aTimeModified;
Date aDateAccessed;
Time aTimeAccessed;
private:
TOOLS_DLLPRIVATE void ImpInit( void* );
protected:
// Implementation
FileStat( const void *pInfo, // CInfoPBRec
const void *pVolInfo ); // ParamBlockRec
public:
FileStat();
FileStat( const DirEntry& rDirEntry,
FSysAccess nAccess = FSYS_ACCESS_FLOPPY );
BOOL Update( const DirEntry& rDirEntry,
BOOL bForceAccess = TRUE );
ULONG GetError() const { return ERRCODE_TOERROR(nError); }
ULONG GetErrorCode() const { return nError; }
ULONG GetSize() const { return nSize; }
DirEntryKind GetKind() const { return nKindFlags; }
BOOL IsKind( DirEntryKind nKind ) const;
String GetType() const { return aType; }
String GetCreator() const { return aCreator; }
Date DateCreated() const { return aDateCreated; }
Time TimeCreated() const { return aTimeCreated; }
Date DateModified() const { return aDateModified; }
Time TimeModified() const { return aTimeModified; }
Date DateAccessed() const { return aDateAccessed; }
Time TimeAccessed() const { return aTimeAccessed; }
BOOL IsYounger( const FileStat& rIsOlder ) const;
#define TF_FSYS_READONLY_FLAG
static ULONG SetReadOnlyFlag( const DirEntry &rEntry, BOOL bRO = TRUE );
static BOOL GetReadOnlyFlag( const DirEntry &rEntry );
static BOOL HasReadOnlyFlag();
static ErrCode QueryDiskSpace( const String &rPath,
BigInt &rFreeBytes, BigInt &rTotalBytes );
static void SetDateTime( const String& rFileName,
const DateTime& rNewDateTime );
};
// ------------
// - DirEntry -
// ------------
class DirEntryStack;
const char* ImpCheckDirEntry( const void* p );
class TOOLS_DLLPUBLIC DirEntry
{
friend struct DirReader_Impl;
friend class FileCopier;
#ifdef FEAT_FSYS_DOUBLESPEED
FileStat* pStat; // optional
#endif
ByteString aName;
DirEntry* pParent;
ULONG nError;
DirEntryFlag eFlag;
private:
TOOLS_DLLPRIVATE DirEntry( const ByteString& rInitName,
DirEntryFlag aDirFlag,
FSysPathStyle eStyle );
//#if 0 // _SOLAR__PRIVATE
friend class Dir;
friend class FileStat;
friend const char* ImpCheckDirEntry( const void* p );
TOOLS_DLLPRIVATE FSysError ImpParseName( const ByteString& rIntiName,
FSysPathStyle eParser );
TOOLS_DLLPRIVATE FSysError ImpParseOs2Name( const ByteString& rPfad,
FSysPathStyle eStyle );
TOOLS_DLLPRIVATE FSysError ImpParseUnixName( const ByteString& rPfad,
FSysPathStyle eStyle );
TOOLS_DLLPRIVATE USHORT ImpTryUrl( DirEntryStack& rStack, const String& rPfad, FSysPathStyle eStyle );
TOOLS_DLLPRIVATE const DirEntry* ImpGetTopPtr() const;
TOOLS_DLLPRIVATE DirEntry* ImpGetTopPtr();
TOOLS_DLLPRIVATE DirEntry* ImpGetPreTopPtr();
TOOLS_DLLPRIVATE BOOL ImpToRel( String aStart );
protected:
void ImpTrim( FSysPathStyle eStyle );
const ByteString& ImpTheName() const;
DirEntryFlag ImpTheFlag() const { return eFlag; };
DirEntry* ImpChangeParent( DirEntry* pNewParent, BOOL bNormalize = TRUE );
DirEntry* ImpGetParent() { return pParent; }
#ifdef FEAT_FSYS_DOUBLESPEED
FileStat* ImpGetStat() const { return pStat; }
void ImpSetStat( FileStat *p ) { pStat = p; }
#endif
//#endif
protected:
void SetError( ULONG nErr ) { nError = nErr; }
DirEntry* GetParent() { return pParent; }
public:
DirEntry( DirEntryFlag aDirFlag = FSYS_FLAG_CURRENT );
DirEntry( const DirEntry& rEntry );
DirEntry( const ByteString& rInitName,
FSysPathStyle eParser = FSYS_STYLE_HOST );
DirEntry( const String& rInitName,
FSysPathStyle eParser = FSYS_STYLE_HOST );
~DirEntry();
BOOL IsLongNameOnFAT() const;
BOOL IsCaseSensitive (FSysPathStyle eFormatter = FSYS_STYLE_HOST) const;
ULONG GetError() const { return nError; }
BOOL IsValid() const;
DirEntryFlag GetFlag() const { return eFlag; };
void SetExtension( const String& rExt, char cSep = '.' );
String GetExtension( char cSep = '.' ) const;
String CutExtension( char cSep = '.' );
void SetName( const String& rName, FSysPathStyle eFormatter = FSYS_STYLE_HOST );
inline const String GetNameDirect() const { return String(aName, osl_getThreadTextEncoding()); }
String GetName( FSysPathStyle eFormatter = FSYS_STYLE_HOST ) const;
String CutName( FSysPathStyle eFormatter = FSYS_STYLE_HOST );
void SetBase( const String& rBase, char cSep = '.' );
String GetBase(char cSep = '.' ) const;
DirEntry GetPath() const;
DirEntry GetDevice() const;
String GetVolume() const;
String GetFull( FSysPathStyle eFormatter = FSYS_STYLE_HOST,
BOOL bWithDelimiter = FALSE,
USHORT nMaxChars = STRING_MAXLEN ) const;
DirEntry TempName( DirEntryKind = FSYS_KIND_NONE ) const;
static const DirEntry& SetTempNameBase( const String &rBaseName );
BOOL MakeShortName( const String& rLongName,
DirEntryKind eCreateKind = FSYS_KIND_NONE,
BOOL bUseTilde = TRUE,
FSysPathStyle eStyle = FSYS_STYLE_DETECT );
bool IsAbs() const;
BOOL ToAbs();
BOOL Find( const String& rPfad, char cDelim = 0 );
BOOL ToRel();
BOOL ToRel( const DirEntry& rRefDir );
USHORT CutRelParents();
BOOL SetCWD( BOOL bSloppy = FALSE ) const;
BOOL MakeDir( BOOL bSloppy = FALSE ) const;
BOOL Exists( FSysAccess nAccess = FSYS_ACCESS_FLOPPY ) const;
BOOL First();
USHORT Level() const;
const DirEntry& operator []( USHORT nParentLevel ) const;
BOOL Contains( const DirEntry &rSubEntry ) const;
FSysError CopyTo( const DirEntry& rDestDir,
FSysAction nActions = FSYS_ACTION_STANDARD ) const;
FSysError MoveTo( const DirEntry& rDestDir ) const;
FSysError Kill( FSysAction nActions = FSYS_ACTION_STANDARD ) const;
DirEntry& operator =( const DirEntry& rOrigDir );
DirEntry operator +( const DirEntry& rSubDir ) const;
DirEntry& operator +=( const DirEntry& rSubDir );
BOOL operator ==( const DirEntry& rAnotherDir ) const;
BOOL operator !=( const DirEntry& rAnotherDir ) const
{ return !(DirEntry::operator==( rAnotherDir )); }
StringCompare NameCompare( const DirEntry &rWith ) const;
inline StringCompare NameCompareDirect( const DirEntry &rWith ) const
{
#ifdef UNX
return rWith.aName.CompareTo( aName );
#else
return rWith.aName.CompareIgnoreCaseToAscii( aName );
#endif
}
static String GetAccessDelimiter( FSysPathStyle eFormatter = FSYS_STYLE_HOST );
static String GetSearchDelimiter( FSysPathStyle eFormatter = FSYS_STYLE_HOST );
static USHORT GetMaxNameLen( FSysPathStyle eFormatter = FSYS_STYLE_HOST );
static FSysPathStyle GetPathStyle( const String &rDevice );
static String ConvertNameToSystem( const String & rName );
static String ConvertSystemToName( const String & rName );
static BOOL IsRFSAvailable();
};
// --------------
// - FileCopier -
// --------------
class TOOLS_DLLPUBLIC FileCopier
{
DirEntry aSource;
DirEntry aTarget;
ULONG nBytesTotal;
ULONG nBytesCopied;
Link aProgressLink;
USHORT nBlockSize;
FileCopier_Impl* pImp;
private:
TOOLS_DLLPRIVATE FSysError DoCopy_Impl(
const DirEntry &rSource, const DirEntry &rTarget );
protected:
virtual BOOL Progress();
virtual ErrCode Error( ErrCode eErr,
const DirEntry *pSource, const DirEntry *pTarget );
public:
FileCopier();
FileCopier( const DirEntry &rSource,
const DirEntry &rTarget );
FileCopier( const FileCopier &rCopier );
virtual ~FileCopier();
FileCopier& operator = ( const FileCopier &rCopier );
void SetBlockSize( USHORT nBytes ) { nBlockSize = nBytes; }
USHORT GetBlockSize() const { return nBlockSize; }
ULONG GetBytesTotal() const { return nBytesTotal; }
ULONG GetBytesCopied() const { return nBytesCopied; }
void SetSource( const DirEntry &rSource ) { aSource = rSource; }
void SetTarget( const DirEntry &rTarget ) { aTarget = rTarget; }
const DirEntry& GetSource() const { return aSource; }
const DirEntry& GetTarget() const { return aTarget; }
FSysError Execute( FSysAction nActions = FSYS_ACTION_STANDARD );
FSysError ExecuteExact( FSysAction nActions = FSYS_ACTION_STANDARD,
FSysExact eExact = FSYS_NOTEXACT);
const DirEntry* GetErrorSource() const;
const DirEntry* GetErrorTarget() const;
ErrCode GetError() const;
void SetProgressHdl( const Link& rLink ) { aProgressLink = rLink; }
const Link& GetProgressHdl() const { return aProgressLink; }
void SetErrorHdl( const Link& rLink );
const Link& GetErrorHdl() const;
};
// -------
// - Dir -
// -------
struct DirReader_Impl;
class TOOLS_DLLPUBLIC Dir : public DirEntry
{
friend struct DirReader_Impl;
friend class CORmFSys;
DirReader_Impl* pReader; // systemabhaengig
DirEntryList* pLst;
FSysSortList* pSortLst; // NULL, wenn kein Sort gefordert
FileStatList* pStatLst; // NULL, wenn keine Stat's benoetigt
WildCard aNameMask;
DirEntryKind eAttrMask;
private:
TOOLS_DLLPRIVATE Dir( const Dir& ); // not allowed
TOOLS_DLLPRIVATE Dir& operator=( const Dir& ); // not allowed
#ifdef _DIR_CXX
TOOLS_DLLPRIVATE FSysError ImpSetSort( std::va_list pArgs, FSysSort nSort );
TOOLS_DLLPRIVATE void Construct( DirEntryKind nKind = FSYS_KIND_DIR|FSYS_KIND_FILE );
#endif
#ifndef _TOOLS_HXX
protected:
BOOL ImpInsertPointReached( const DirEntry& rIsSmaller,
const FileStat& rNewStat,
ULONG nCurPos,
ULONG nSortIndex ) const;
void ImpSortedInsert( const DirEntry *pNewEntry,
const FileStat *pNewStat );
#endif
public:
Dir();
Dir( const DirEntry& rDirEntry,
DirEntryKind nKind = FSYS_KIND_ALL );
Dir( const DirEntry& rDirEntry,
DirEntryKind nKind,
FSysSort nSort, ... );
~Dir();
const WildCard& GetNameMask() const { return aNameMask; }
FSysError SetSort( FSysSort nSort, ... );
void Reset();
USHORT Scan( USHORT nCount = 5 );
USHORT Count( BOOL bUpdated = TRUE ) const;
BOOL Update();
Dir& operator +=( const Dir& rDir );
DirEntry& operator []( USHORT nIndex ) const;
};
// we don't need this stuff for bootstraping
#ifndef BOOTSTRAP
//========================================================================
/** FSysRedirector is an abstract base class for a hook to redirect
mirrored directory trees.
<P>One instance of a subclass can be instanciated and registered
using the method FSysRedirector::Register(FSysRedirector*).
*/
class FSysRedirector
{
static FSysRedirector* _pRedirector;
static BOOL _bEnabled;
public:
/** This method must called with the one and only instance of the
subclass which implements the redirection.
<P>It must be called with 0 when the instance is destroyed.
*/
static void Register( FSysRedirector *pRedirector );
//-----------------------------------------------------------------------
/** This method returns the currently registererd instance of
a subclass which implements the redirection.
<P>If no redirector is registered, it returns 0.
*/
static FSysRedirector* Redirector();
//-----------------------------------------------------------------------
/** This method is to be used to redirect a file system path.
<P>It will not redirect while redirection is disabled.
<P>It may block while another thread is accessing the redirector
or another thread has disabled redirections.
@param String &rPath<BR>
This inout-argument accepts a file:-URL even as a native
file system path name to redirect in 'rPath'. It returns the
redirected (modified) path too, which can be of both formats
too.
@return BOOL<BR>
TRUE, if the path is redirected
FALSE, if the path is not redirected (unchanged)
*/
static void DoRedirect( String &rPath );
};
#endif // BOOTSTRP
//========================================================================
void FSysEnableSysErrorBox( BOOL bEnable );
//========================================================================
#if defined(DBG_UTIL)
void FSysTest();
#endif
#endif // #ifndef _FSYS_HXX
|