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
|
/* 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/archive.h"
#include "common/fs.h"
#include "common/util.h"
#include "common/system.h"
namespace Common {
GenericArchiveMember::GenericArchiveMember(String name, Archive *parent)
: _parent(parent), _name(name) {
}
String GenericArchiveMember::getName() const {
return _name;
}
SeekableReadStream *GenericArchiveMember::open() {
return _parent->openFile(_name);
}
int Archive::listMatchingMembers(ArchiveMemberList &list, const String &pattern) {
// Get all "names" (TODO: "files" ?)
ArchiveMemberList allNames;
listMembers(allNames);
int matches = 0;
// need to match lowercase key
String lowercasePattern = pattern;
lowercasePattern.toLowercase();
ArchiveMemberList::iterator it = allNames.begin();
for ( ; it != allNames.end(); it++) {
if ((*it)->getName().matchString(lowercasePattern)) {
list.push_back(*it);
matches++;
}
}
return matches;
}
/**
* FSDirectoryMemeber is the implementation of ArchiveMember used by
* by FSDirectory. It is right now a light wrapper or FSNode.
*/
class FSDirectoryMember : public ArchiveMember {
FSNode _node;
public:
FSDirectoryMember(FSNode &node) : _node(node) {
}
/*
NOTE/FIXME: since I assume that the only use case for getName()
is for error messages, I am returning the full path of the node
here. This seems better than we did before, when matchPattern
and getAllNames used to work with StringList, and we used to
put the relative path of the file to the list instead.
*/
String getName() const {
return _node.getPath();
}
SeekableReadStream *open() {
return _node.openForReading();
}
};
typedef SharedPtr<FSDirectoryMember> FSDirectoryMemberPtr;
FSDirectory::FSDirectory(const FSNode &node, int depth)
: _node(node), _cached(false), _depth(depth) {
}
FSDirectory::FSDirectory(const String &prefix, const FSNode &node, int depth)
: _node(node), _cached(false), _depth(depth) {
setPrefix(prefix);
}
FSDirectory::FSDirectory(const String &name, int depth)
: _node(name), _cached(false), _depth(depth) {
}
FSDirectory::FSDirectory(const String &prefix, const String &name, int depth)
: _node(name), _cached(false), _depth(depth) {
setPrefix(prefix);
}
FSDirectory::~FSDirectory() {
}
void FSDirectory::setPrefix(const String &prefix) {
_prefix = prefix;
if (!_prefix.empty() && !_prefix.hasSuffix("/")) {
_prefix += "/";
}
}
FSNode FSDirectory::getFSNode() const {
return _node;
}
FSNode FSDirectory::lookupCache(NodeCache &cache, const String &name) {
// make caching as lazy as possible
if (!name.empty()) {
if (!_cached) {
cacheDirectoryRecursive(_node, _depth, _prefix);
_cached = true;
}
if (cache.contains(name))
return cache[name];
}
return FSNode();
}
bool FSDirectory::hasFile(const String &name) {
if (name.empty() || !_node.isDirectory()) {
return false;
}
FSNode node = lookupCache(_fileCache, name);
return node.exists();
}
SeekableReadStream *FSDirectory::openFile(const String &name) {
if (name.empty() || !_node.isDirectory()) {
return 0;
}
FSNode node = lookupCache(_fileCache, name);
if (!node.exists()) {
warning("FSDirectory::openFile: FSNode does not exist");
return 0;
} else if (node.isDirectory()) {
warning("FSDirectory::openFile: FSNode is a directory");
return 0;
}
SeekableReadStream *stream = node.openForReading();
if (!stream) {
warning("FSDirectory::openFile: Can't create stream for file '%s'", name.c_str());
}
return stream;
}
FSDirectory *FSDirectory::getSubDirectory(const String &name, int depth) {
return getSubDirectory(String::emptyString, name, depth);
}
FSDirectory *FSDirectory::getSubDirectory(const String &prefix, const String &name, int depth) {
if (name.empty() || !_node.isDirectory()) {
return 0;
}
FSNode node = lookupCache(_subDirCache, name);
return new FSDirectory(prefix, node, depth);
}
void FSDirectory::cacheDirectoryRecursive(FSNode node, int depth, const String& prefix) {
if (depth <= 0) {
return;
}
FSList list;
node.getChildren(list, FSNode::kListAll, false);
FSList::iterator it = list.begin();
for ( ; it != list.end(); it++) {
String name = prefix + (*it).getName();
// don't touch name as it might be used for warning messages
String lowercaseName = name;
lowercaseName.toLowercase();
// since the hashmap is case insensitive, we need to check for clashes when caching
if ((*it).isDirectory()) {
if (_subDirCache.contains(lowercaseName)) {
warning("FSDirectory::cacheDirectory: name clash when building cache, ignoring sub-directory '%s'", name.c_str());
} else {
cacheDirectoryRecursive(*it, depth - 1, lowercaseName + "/");
_subDirCache[lowercaseName] = *it;
}
} else {
if (_fileCache.contains(lowercaseName)) {
warning("FSDirectory::cacheDirectory: name clash when building cache, ignoring file '%s'", name.c_str());
} else {
_fileCache[lowercaseName] = *it;
}
}
}
}
int FSDirectory::listMatchingMembers(ArchiveMemberList &list, const String &pattern) {
if (!_node.isDirectory())
return 0;
// Cache dir data
if (!_cached) {
cacheDirectoryRecursive(_node, _depth, "");
_cached = true;
}
String lowercasePattern(pattern);
lowercasePattern.toLowercase();
int matches = 0;
NodeCache::iterator it = _fileCache.begin();
for ( ; it != _fileCache.end(); it++) {
if ((*it)._key.matchString(lowercasePattern)) {
list.push_back(FSDirectoryMemberPtr(new FSDirectoryMember((*it)._value)));
matches++;
}
}
return matches;
}
int FSDirectory::listMembers(ArchiveMemberList &list) {
return listMatchingMembers(list, "*");
}
SearchSet::ArchiveList::iterator SearchSet::find(const String &name) const {
ArchiveList::iterator it = _list.begin();
for ( ; it != _list.end(); it++) {
if ((*it)._name == name) {
break;
}
}
return it;
}
/*
Keep the nodes sorted according to descending priorities.
In case two or node nodes have the same priority, insertion
order prevails.
*/
void SearchSet::insert(const Node &node) {
ArchiveList::iterator it = _list.begin();
for ( ; it != _list.end(); it++) {
if ((*it)._priority < node._priority) {
break;
}
}
_list.insert(it, node);
}
void SearchSet::add(const String& name, ArchivePtr archive, int priority) {
if (find(name) == _list.end()) {
Node node(priority, name, archive);
insert(node);
} else {
warning("SearchSet::add: archive '%s' already present", name.c_str());
}
}
void SearchSet::remove(const String& name) {
ArchiveList::iterator it = find(name);
if (it != _list.end()) {
_list.erase(it);
}
}
bool SearchSet::hasArchive(const String &name) const {
return (find(name) != _list.end());
}
void SearchSet::clear() {
_list.clear();
}
void SearchSet::setPriority(const String& name, int priority) {
ArchiveList::iterator it = find(name);
if (it == _list.end()) {
warning("SearchSet::setPriority: archive '%s' is not present", name.c_str());
return;
}
if (priority == (*it)._priority) {
return;
}
Node node(*it);
_list.erase(it);
node._priority = priority;
insert(node);
}
bool SearchSet::hasFile(const String &name) {
if (name.empty()) {
return false;
}
ArchiveList::iterator it = _list.begin();
for ( ; it != _list.end(); it++) {
if ((*it)._arc->hasFile(name)) {
return true;
}
}
return false;
}
int SearchSet::listMatchingMembers(ArchiveMemberList &list, const String &pattern) {
int matches = 0;
ArchiveList::iterator it = _list.begin();
for ( ; it != _list.end(); it++) {
matches += (*it)._arc->listMatchingMembers(list, pattern);
}
return matches;
}
int SearchSet::listMembers(ArchiveMemberList &list) {
int matches = 0;
ArchiveList::iterator it = _list.begin();
for ( ; it != _list.end(); it++) {
matches += (*it)._arc->listMembers(list);
}
return matches;
}
SeekableReadStream *SearchSet::openFile(const String &name) {
if (name.empty()) {
return 0;
}
ArchiveList::iterator it = _list.begin();
for ( ; it != _list.end(); it++) {
if ((*it)._arc->hasFile(name)) {
return (*it)._arc->openFile(name);
}
}
return 0;
}
DECLARE_SINGLETON(SearchManager);
SearchManager::SearchManager() {
clear(); // Force a reset
}
void SearchManager::addArchive(const String &name, ArchivePtr archive, int priority) {
add(name, archive, priority);
}
void SearchManager::addDirectory(const String &name, const String &directory, int priority) {
addDirectoryRecursive(name, directory, 1, priority);
}
void SearchManager::addDirectoryRecursive(const String &name, const String &directory, int depth, int priority) {
add(name, ArchivePtr(new FSDirectory(directory, depth)), priority);
}
void SearchManager::clear() {
SearchSet::clear();
// Always keep system specific archives in the SearchManager.
// But we give them a lower priority than the default priority (which is 0),
// so that archives added by client code are searched first.
g_system->addSysArchivesToSearchSet(*this, -1);
// Add the current dir as a very last resort.
// See also bug #2137680.
add(".", ArchivePtr(new FSDirectory(".")), -2);
}
} // namespace Common
|