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
|
/* 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$
*
*/
// -----------------------------------------------------------------------------
// Includes
// -----------------------------------------------------------------------------
#include "common/archive.h"
#include "common/config-manager.h"
#include "common/str-array.h"
#include "common/unzip.h"
#include "sword25/package/scummvmpackagemanager.h"
// -----------------------------------------------------------------------------
#define BS_LOG_PREFIX "SCUMMVMPACKAGEMANAGER"
namespace Sword25 {
const char PATH_SEPARATOR = '/';
const char NAVIGATION_CHARACTER = '.';
// -----------------------------------------------------------------------------
// Support functions and classes
// -----------------------------------------------------------------------------
static Common::String RemoveRedundantPathSeparators(const Common::String &Path) {
Common::String Result;
// Iterate over all the chracters of the input path
Common::String::const_iterator It = Path.begin();
while (It != Path.end()) {
if (*It == PATH_SEPARATOR) {
// Directory separater found
// Skip over directory separator(s)
while (It != Path.end() && *It == PATH_SEPARATOR) ++It;
// Unless it's the end of the path, add the separator
if (It != Path.end()) Result += PATH_SEPARATOR;
} else {
// Normal characters are copied over unchanged
Result += *It;
++It;
}
}
return Result;
}
// ---------------------------------------------------------------------
static PathElementArray SeparatePath(const Common::String &Path, const Common::String &CurrentDirectory) {
// Determine whether the path is absolute (begins with /) or relative, in which case it's added
// to the current directory
Common::String wholePath = (Path.size() >= 1 && Path[0] == PATH_SEPARATOR) ? "" : CurrentDirectory + PATH_SEPARATOR;
// Add in the provided path
wholePath += RemoveRedundantPathSeparators(Path);
// Parse the path and divide into it's components. This ensures that occurences of ".." and "."
// are handled correctly.
PathElementArray pathElements;
size_t separatorPos = 0;
while (separatorPos < wholePath.size()) {
// Find next directory separator
const char *p = strchr(wholePath.c_str() + separatorPos + 1, PATH_SEPARATOR);
size_t nextseparatorPos = (p == NULL) ? wholePath.size() : p - wholePath.c_str();
// Calculate the beginning and end of the path element
Common::String::const_iterator elementBegin = wholePath.begin() + separatorPos + 1;
Common::String::const_iterator elementEnd = wholePath.begin() + nextseparatorPos;
if (elementEnd - elementBegin == 2 &&
elementBegin[0] == NAVIGATION_CHARACTER &&
elementBegin[1] == NAVIGATION_CHARACTER) {
// element is "..", therefore the previous path element should be removed
if (pathElements.size()) pathElements.pop_back();
} else if (elementEnd - elementBegin == 1 &&
elementBegin[0] == NAVIGATION_CHARACTER) {
// element is ".", so we do nothing
} else {
// Normal elements get added to the list
pathElements.push_back(new PathElement(wholePath.begin() + separatorPos + 1, wholePath.begin() + nextseparatorPos));
}
separatorPos = nextseparatorPos;
}
return pathElements;
}
static Common::String NormalizePath(const Common::String &Path, const Common::String &CurrentDirectory) {
// Get the path elements for the file
PathElementArray pathElements = SeparatePath(Path, CurrentDirectory);
if (pathElements.size()) {
// The individual path elements are fitted together, separated by a directory
// separator. The resulting string is returned as a result
Common::String Result;
PathElementArray::const_iterator It = pathElements.begin();
while (It != pathElements.end()) {
Result += PATH_SEPARATOR;
Result += Common::String((*It)->GetBegin(), (*It)->GetEnd());
++It;
}
return Result;
} else {
// The path list has no elements, therefore the root directory is returned
return Common::String(PATH_SEPARATOR);
}
}
// -----------------------------------------------------------------------------
// Constructor / Destructor
// -----------------------------------------------------------------------------
BS_ScummVMPackageManager::BS_ScummVMPackageManager(BS_Kernel *KernelPtr) :
BS_PackageManager(KernelPtr),
_currentDirectory(PATH_SEPARATOR),
_rootFolder(ConfMan.get("path")) {
}
// -----------------------------------------------------------------------------
BS_ScummVMPackageManager::~BS_ScummVMPackageManager() {
}
// -----------------------------------------------------------------------------
BS_Service *BS_ScummVMPackageManager_CreateObject(BS_Kernel *KernelPtr) {
return new BS_ScummVMPackageManager(KernelPtr);
}
// -----------------------------------------------------------------------------
/**
* Scans through the archive list for a specified file
*/
Common::ArchiveMemberPtr BS_ScummVMPackageManager::GetArchiveMember(const Common::String &FileName) {
// Loop through checking each archive
Common::List<ArchiveEntry *>::iterator i;
for (i = _archiveList.begin(); i != _archiveList.end(); ++i) {
if (!FileName.hasPrefix((*i)->_mountPath)) {
// The mount path has more subfolder depth than the search entry, so skip it
continue;
}
// Look into the archive for the desired file
Common::Archive *archiveFolder = (*i)->Archive;
// Construct relative path
Common::String resPath(&FileName.c_str()[(*i)->_mountPath.size()]);
if (archiveFolder->hasFile(resPath)) {
return archiveFolder->getMember(resPath);
}
}
return Common::ArchiveMemberPtr();
}
// -----------------------------------------------------------------------------
bool BS_ScummVMPackageManager::LoadPackage(const Common::String &FileName, const Common::String &MountPosition) {
Common::Archive *zipFile = Common::makeZipArchive(FileName);
if (zipFile == NULL) {
BS_LOG_ERRORLN("Unable to mount file \"%s\" to \"%s\"", FileName.c_str(), MountPosition.c_str());
return false;
} else {
BS_LOGLN("Package '%s' mounted as '%s'.", FileName.c_str(), MountPosition.c_str());
Common::ArchiveMemberList files;
zipFile->listMembers(files);
debug(0, "Capacity %d", files.size());
_archiveList.push_back(new ArchiveEntry(zipFile, MountPosition));
return true;
}
}
// -----------------------------------------------------------------------------
bool BS_ScummVMPackageManager::LoadDirectoryAsPackage(const Common::String &DirectoryName, const Common::String &MountPosition) {
Common::FSNode directory(DirectoryName);
Common::Archive *folderArchive = new Common::FSDirectory(directory);
if (!directory.exists() || (folderArchive == NULL)) {
BS_LOG_ERRORLN("Unable to mount directory \"%s\" to \"%s\".", DirectoryName.c_str(), MountPosition.c_str());
return false;
} else {
BS_LOGLN("Directory '%s' mounted as '%s'.", DirectoryName.c_str(), MountPosition.c_str());
_archiveList.push_front(new ArchiveEntry(folderArchive, MountPosition));
return true;
}
}
// -----------------------------------------------------------------------------
void *BS_ScummVMPackageManager::GetFile(const Common::String &FileName, unsigned int *FileSizePtr) {
Common::SeekableReadStream *in;
Common::ArchiveMemberPtr fileNode = GetArchiveMember(FileName);
if (fileNode->getName().empty())
return 0;
if (!(in = fileNode->createReadStream()))
return 0;
// If the filesize is desired, then output the size
if (FileSizePtr)
*FileSizePtr = in->size();
if (in->size() > 102400)
warning("UGLY: UGLY: Sucking >100kb file into memory (%d bytes)", in->size());
// Read the file
byte *buffer = new byte[in->size()];
if (!in->read(buffer, in->size())) return 0;
return buffer;
}
// -----------------------------------------------------------------------------
Common::String BS_ScummVMPackageManager::GetCurrentDirectory() {
return _currentDirectory;
}
// -----------------------------------------------------------------------------
bool BS_ScummVMPackageManager::ChangeDirectory(const Common::String &Directory) {
// Get the path elements for the file
_currentDirectory = NormalizePath(Directory, _currentDirectory);
return true;
}
// -----------------------------------------------------------------------------
Common::String BS_ScummVMPackageManager::GetAbsolutePath(const Common::String &FileName) {
return NormalizePath(FileName, _currentDirectory);
}
// -----------------------------------------------------------------------------
unsigned int BS_ScummVMPackageManager::GetFileSize(const Common::String &FileName) {
Common::SeekableReadStream *in;
Common::ArchiveMemberPtr fileNode = GetArchiveMember(FileName);
if (fileNode->getName().empty())
return 0;
if (!(in = fileNode->createReadStream()))
return 0;
uint fileSize = in->size();
return fileSize;
}
// -----------------------------------------------------------------------------
unsigned int BS_ScummVMPackageManager::GetFileType(const Common::String &FileName) {
warning("STUB: BS_ScummVMPackageManager::GetFileType(%s)", FileName.c_str());
//return fileNode.isDirectory() ? BS_PackageManager::FT_DIRECTORY : BS_PackageManager::FT_FILE;
return BS_PackageManager::FT_FILE;
}
// -----------------------------------------------------------------------------
bool BS_ScummVMPackageManager::FileExists(const Common::String &FileName) {
Common::ArchiveMemberPtr fileNode = GetArchiveMember(FileName);
return !fileNode->getName().empty();
}
// -----------------------------------------------------------------------------
// File find
// -----------------------------------------------------------------------------
class ArchiveFileSearch : public BS_PackageManager::FileSearch {
public:
// Path must be normalised
ArchiveFileSearch(BS_PackageManager &PackageManager, const Common::StringArray &FoundFiles) :
_packageManager(PackageManager),
_foundFiles(FoundFiles),
_foundFilesIt(_foundFiles.begin()) {
}
virtual Common::String GetCurFileName() {
return *_foundFilesIt;
}
virtual unsigned int GetCurFileType() {
return _packageManager.GetFileType(*_foundFilesIt);
}
virtual unsigned int GetCurFileSize() {
return _packageManager.GetFileSize(*_foundFilesIt);
}
virtual bool NextFile() {
++_foundFilesIt;
return _foundFilesIt != _foundFiles.end();
}
BS_PackageManager &_packageManager;
Common::StringArray _foundFiles;
Common::StringArray::const_iterator _foundFilesIt;
};
// -----------------------------------------------------------------------------
BS_PackageManager::FileSearch *BS_ScummVMPackageManager::CreateSearch(
const Common::String &Filter, const Common::String &Path, unsigned int TypeFilter) {
#if 0
Common::String NormalizedPath = NormalizePath(Path, _currentDirectory);
Common::FSNode folderNode = GetFSNode(Path);
if (!folderNode.exists() || !folderNode.isDirectory()) return NULL;
Common::Archive *folder = new Common::FSDirectory(folderNode);
Common::ArchiveMemberList memberList;
if (folder->listMatchingMembers(memberList, Filter) == 0)
return NULL;
// Create a list of the matching names
Common::StringArray nameList;
for (Common::ArchiveMemberList::iterator i = memberList.begin(); i != memberList.end(); ++i) {
nameList.push_back((*i)->getName());
}
// Return a ArchiveFileSearch object that encapsulates the name list
return new ArchiveFileSearch(*this, nameList);
#else
warning("STUB: BS_ScummVMPackageManager::CreateSearch(%s, %s, %d)", Filter.c_str(), Path.c_str(), TypeFilter);
Common::StringArray nameList;
return new ArchiveFileSearch(*this, nameList);
#endif
}
} // End of namespace Sword25
|