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
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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; either version 2
* of the License, or (at your option) any later version.
* 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.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/
#include "common/file.h"
#include "common/fs.h"
#include "common/hashmap.h"
#include "common/util.h"
#include "common/hash-str.h"
#include "backends/fs/stdiostream.h"
#if defined(MACOSX) || defined(IPHONE)
#include "CoreFoundation/CoreFoundation.h"
#endif
namespace Common {
typedef HashMap<String, int> StringIntMap;
// The following two objects could be turned into static members of class
// File. However, then we would be forced to #include hashmap in file.h
// which seems to be a high price just for a simple beautification...
static StringIntMap *_defaultDirectories;
static StringMap *_filesMap;
static SeekableReadStream *fopenNoCase(const String &filename, const String &directory) {
SeekableReadStream *handle;
String dirBuf(directory);
String fileBuf(filename);
#if !defined(__GP32__) && !defined(PALMOS_MODE)
// Add a trailing slash, if necessary.
if (!dirBuf.empty()) {
const char c = dirBuf.lastChar();
if (c != ':' && c != '/' && c != '\\')
dirBuf += '/';
}
#endif
// Append the filename to the path string
String pathBuf(dirBuf);
pathBuf += fileBuf;
//
// Try to open the file normally
//
handle = StdioStream::makeFromPath(pathBuf, false);
//
// Try again, with file name converted to upper case
//
if (!handle) {
fileBuf.toUppercase();
pathBuf = dirBuf + fileBuf;
handle = StdioStream::makeFromPath(pathBuf, false);
}
//
// Try again, with file name converted to lower case
//
if (!handle) {
fileBuf.toLowercase();
pathBuf = dirBuf + fileBuf;
handle = StdioStream::makeFromPath(pathBuf, false);
}
//
// Try again, with file name capitalized
//
if (!handle) {
fileBuf.toLowercase();
fileBuf.setChar(toupper(fileBuf[0]),0);
pathBuf = dirBuf + fileBuf;
handle = StdioStream::makeFromPath(pathBuf, false);
}
return handle;
}
void File::addDefaultDirectory(const String &directory) {
FilesystemNode dir(directory);
addDefaultDirectoryRecursive(dir, 1);
}
void File::addDefaultDirectoryRecursive(const String &directory, int level, const String &prefix) {
FilesystemNode dir(directory);
addDefaultDirectoryRecursive(dir, level, prefix);
}
void File::addDefaultDirectory(const FilesystemNode &directory) {
addDefaultDirectoryRecursive(directory, 1);
}
void File::addDefaultDirectoryRecursive(const FilesystemNode &dir, int level, const String &prefix) {
if (level <= 0 || !dir.exists() || !dir.isDirectory())
return;
FSList fslist;
if (!dir.getChildren(fslist, FilesystemNode::kListAll)) {
// Failed listing the contents of this node, so it is either not a
// directory, or just doesn't exist at all.
return;
}
if (!_defaultDirectories)
_defaultDirectories = new StringIntMap;
// Do not add directories multiple times, unless this time they are added
// with a bigger depth.
const String &directory(dir.getPath());
if (_defaultDirectories->contains(directory) && (*_defaultDirectories)[directory] >= level)
return;
(*_defaultDirectories)[directory] = level;
if (!_filesMap)
_filesMap = new StringMap;
for (FSList::const_iterator file = fslist.begin(); file != fslist.end(); ++file) {
if (file->isDirectory()) {
addDefaultDirectoryRecursive(file->getPath(), level - 1, prefix + file->getName() + "/");
} else {
String lfn(prefix);
lfn += file->getName();
lfn.toLowercase();
if (!_filesMap->contains(lfn)) {
(*_filesMap)[lfn] = file->getPath();
}
}
}
}
void File::resetDefaultDirectories() {
delete _defaultDirectories;
delete _filesMap;
_defaultDirectories = 0;
_filesMap = 0;
}
File::File()
: _handle(0) {
}
File::~File() {
close();
}
bool File::open(const String &filename) {
assert(!filename.empty());
assert(!_handle);
_name.clear();
clearIOFailed();
String fname(filename);
fname.toLowercase();
if (_filesMap && _filesMap->contains(fname)) {
fname = (*_filesMap)[fname];
debug(3, "Opening hashed: %s", fname.c_str());
_handle = StdioStream::makeFromPath(fname, false);
} else if (_filesMap && _filesMap->contains(fname + ".")) {
// WORKAROUND: Bug #1458388: "SIMON1: Game Detection fails"
// sometimes instead of "GAMEPC" we get "GAMEPC." (note trailing dot)
fname = (*_filesMap)[fname + "."];
debug(3, "Opening hashed: %s", fname.c_str());
_handle = StdioStream::makeFromPath(fname, false);
} else {
if (_defaultDirectories) {
// Try all default directories
StringIntMap::const_iterator x(_defaultDirectories->begin());
for (; _handle == NULL && x != _defaultDirectories->end(); ++x) {
_handle = fopenNoCase(filename, x->_key);
}
}
// Last resort: try the current directory
if (_handle == NULL)
_handle = fopenNoCase(filename, "");
// Last last (really) resort: try looking inside the application bundle on Mac OS X for the lowercase file.
#if defined(MACOSX) || defined(IPHONE)
if (!_handle) {
CFStringRef cfFileName = CFStringCreateWithBytes(NULL, (const UInt8 *)filename.c_str(), filename.size(), kCFStringEncodingASCII, false);
CFURLRef fileUrl = CFBundleCopyResourceURL(CFBundleGetMainBundle(), cfFileName, NULL, NULL);
if (fileUrl) {
UInt8 buf[256];
if (CFURLGetFileSystemRepresentation(fileUrl, false, (UInt8 *)buf, 256)) {
_handle = StdioStream::makeFromPath((char *)buf, false);
}
CFRelease(fileUrl);
}
CFRelease(cfFileName);
}
#endif
}
if (_handle == NULL)
debug(2, "File %s not opened", filename.c_str());
else
_name = filename;
return _handle != NULL;
}
bool File::open(const FilesystemNode &node) {
if (!node.exists()) {
warning("File::open: Trying to open a FilesystemNode which does not exist");
return false;
} else if (node.isDirectory()) {
warning("File::open: Trying to open a FilesystemNode which is a directory");
return false;
} /*else if (!node.isReadable() && mode == kFileReadMode) {
warning("File::open: Trying to open an unreadable FilesystemNode object for reading");
return false;
} else if (!node.isWritable() && mode == kFileWriteMode) {
warning("File::open: Trying to open an unwritable FilesystemNode object for writing");
return false;
}*/
String filename(node.getName());
if (_handle) {
error("File::open: This file object already is opened (%s), won't open '%s'", _name.c_str(), filename.c_str());
}
clearIOFailed();
_name.clear();
_handle = node.openForReading();
if (_handle == NULL)
debug(2, "File %s not found", filename.c_str());
else
_name = filename;
return _handle != NULL;
}
bool File::exists(const String &filename) {
// First try to find the file via a FilesystemNode (in case an absolute
// path was passed). This is only used to filter out directories.
FilesystemNode file(filename);
if (file.exists())
return !file.isDirectory();
// See if the file is already mapped
if (_filesMap && _filesMap->contains(filename)) {
FilesystemNode file2((*_filesMap)[filename]);
if (file2.exists())
return !file2.isDirectory();
}
// Try all default directories
if (_defaultDirectories) {
StringIntMap::const_iterator i(_defaultDirectories->begin());
for (; i != _defaultDirectories->end(); ++i) {
FilesystemNode file2(i->_key + filename);
if(file2.exists())
return !file2.isDirectory();
}
}
//Try opening the file inside the local directory as a last resort
File tmp;
return tmp.open(filename);
}
void File::close() {
delete _handle;
_handle = NULL;
}
bool File::isOpen() const {
return _handle != NULL;
}
bool File::ioFailed() const {
// TODO/FIXME: Just use ferror() here?
return !_handle || _handle->ioFailed();
}
void File::clearIOFailed() {
if (_handle)
_handle->clearIOFailed();
}
bool File::eos() const {
assert(_handle);
return _handle->eos();
}
uint32 File::pos() const {
assert(_handle);
return _handle->pos();
}
uint32 File::size() const {
assert(_handle);
return _handle->size();
}
void File::seek(int32 offs, int whence) {
assert(_handle);
_handle->seek(offs, whence);
}
uint32 File::read(void *ptr, uint32 len) {
assert(_handle);
return _handle->read(ptr, len);
}
DumpFile::DumpFile() : _handle(0) {
}
DumpFile::~DumpFile() {
close();
}
bool DumpFile::open(const String &filename) {
assert(!filename.empty());
assert(!_handle);
String fname(filename);
fname.toLowercase();
_handle = StdioStream::makeFromPath(filename, true);
if (_handle == NULL)
debug(2, "Failed to open '%s' for writing", filename.c_str());
return _handle != NULL;
}
bool DumpFile::open(const FilesystemNode &node) {
assert(!_handle);
if (node.isDirectory()) {
warning("File::open: Trying to open a FilesystemNode which is a directory");
return false;
} /*else if (!node.isReadable() && mode == kFileReadMode) {
warning("File::open: Trying to open an unreadable FilesystemNode object for reading");
return false;
} else if (!node.isWritable() && mode == kFileWriteMode) {
warning("File::open: Trying to open an unwritable FilesystemNode object for writing");
return false;
}*/
_handle = node.openForWriting();
if (_handle == NULL)
debug(2, "File %s not found", node.getName().c_str());
return _handle != NULL;
}
void DumpFile::close() {
delete _handle;
_handle = NULL;
}
bool DumpFile::isOpen() const {
return _handle != NULL;
}
bool DumpFile::ioFailed() const {
assert(_handle);
return _handle->ioFailed();
}
void DumpFile::clearIOFailed() {
assert(_handle);
_handle->clearIOFailed();
}
uint32 DumpFile::write(const void *ptr, uint32 len) {
assert(_handle);
return _handle->write(ptr, len);
}
void DumpFile::flush() {
assert(_handle);
_handle->flush();
}
} // End of namespace Common
|