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
|
/******************************************************************************
* filemgr.h - definition of class FileMgr used for pooling file handles
*
* $Id: filemgr.h 2108 2007-10-13 20:35:02Z scribe $
*
* Copyright 1998 CrossWire Bible Society (http://www.crosswire.org)
* CrossWire Bible Society
* P. O. Box 2528
* Tempe, AZ 85280-2528
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation version 2.
*
* This program 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
* General Public License for more details.
*
*/
#ifndef FILEMGR_H
#define FILEMGR_H
#include <sys/stat.h>
#include <fcntl.h>
#include <defs.h>
#include <swcacher.h>
#include <swbuf.h>
SWORD_NAMESPACE_START
class SWDLLEXPORT FileMgr;
struct SWDLLEXPORT DirEntry {
public:
SWBuf name;
unsigned long size;
bool isDirectory;
};
/**
* This class represents one file. It works with the FileMgr object.
*/
class SWDLLEXPORT FileDesc {
friend class FileMgr;
long offset;
int fd; // -77 closed;
FileMgr *parent;
FileDesc *next;
FileDesc(FileMgr * parent, const char *path, int mode, int perms, bool tryDowngrade);
virtual ~FileDesc();
public:
/** @return File handle.
*/
int getFd();
long seek(long offset, int whence);
long read(void *buf, long count);
long write(const void *buf, long count);
/** Path to file.
*/
char *path;
/** File access mode.
*/
int mode;
/** File permissions.
*/
int perms;
/**
*/
bool tryDowngrade;
};
/**
* This class ist used make file access operations easier.
* It keeps a list of all open files internally and closes them
* when the destructor is called.
*/
class SWDLLEXPORT FileMgr : public SWCacher {
friend class FileDesc;
friend class __staticsystemFileMgr;
FileDesc *files;
int sysOpen(FileDesc * file);
protected:
static FileMgr *systemFileMgr;
public:
static int CREAT;
static int APPEND;
static int TRUNC;
static int RDONLY;
static int RDWR;
static int WRONLY;
static int IREAD;
static int IWRITE;
/** Maximum number of open files set in the constructor.
* determines the max number of real system files that
* filemgr will open. Adjust for tuning.
*/
int maxFiles;
static FileMgr *getSystemFileMgr();
static void setSystemFileMgr(FileMgr *newFileMgr);
/** Constructor.
* @param maxFiles The number of files that this FileMgr may open in parallel, if necessary.
*/
FileMgr(int maxFiles = 35);
/**
* Destructor. Clean things up. Will close all files opened by this FileMgr object.
*/
~FileMgr();
/** Open a file and return a FileDesc for it.
* The file itself will only be opened when FileDesc::getFd() is called.
* @param path Filename.
* @param mode File access mode.
* @param tryDowngrade
* @return FileDesc object for the requested file.
*/
FileDesc *open(const char *path, int mode, bool tryDowngrade);
/** Open a file and return a FileDesc for it.
* The file itself will only be opened when FileDesc::getFd() is called.
* @param path Filename.
* @param mode File access mode.
* @param perms Permissions.
* @param tryDowngrade
* @return FileDesc object for the requested file.
*/
FileDesc *open(const char *path, int mode, int perms = IREAD | IWRITE, bool tryDowngrade = false);
/** Close a given file and delete its FileDesc object.
* Will only close the file if it was created by this FileMgr object.
* @param file The file to close.
*/
void close(FileDesc * file);
/** Cacher methods overridden
*/
virtual void flush();
virtual long resourceConsumption();
/** Checks for the existence of a file.
* @param ipath Path to file.
* @param ifileName Name of file to check for.
*/
static signed char existsFile(const char *ipath, const char *ifileName = 0);
/** Checks for the existence of a directory.
* @param ipath Path to directory.
* @param idirName Name of directory to check for.
*/
static signed char existsDir(const char *ipath, const char *idirName = 0);
/** Truncate a file at its current position
* leaving byte at current possition intact deleting everything afterward.
* @param file The file to operate on.
*/
signed char trunc(FileDesc *file);
static char isDirectory(const char *path);
static int createParent(const char *pName);
static int createPathAndFile(const char *fName);
/** attempts to open a file readonly
* @param fName filename to open
* @return fd; < 0 = error
*/
static int openFileReadOnly(const char *fName);
static int copyFile(const char *srcFile, const char *destFile);
static int copyDir(const char *srcDir, const char *destDir);
static int removeDir(const char *targetDir);
static int removeFile(const char *fName);
static char getLine(FileDesc *fDesc, SWBuf &line);
};
SWORD_NAMESPACE_END
#endif
|
