/
archiver_grp.c
461 lines (358 loc) · 12.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/*
* GRP support routines for PhysicsFS.
*
* This driver handles BUILD engine archives ("groupfiles"). This format
* (but not this driver) was put together by Ken Silverman.
*
* The format is simple enough. In Ken's words:
*
* What's the .GRP file format?
*
* The ".grp" file format is just a collection of a lot of files stored
* into 1 big one. I tried to make the format as simple as possible: The
* first 12 bytes contains my name, "KenSilverman". The next 4 bytes is
* the number of files that were compacted into the group file. Then for
* each file, there is a 16 byte structure, where the first 12 bytes are
* the filename, and the last 4 bytes are the file's size. The rest of
* the group file is just the raw data packed one after the other in the
* same order as the list of files.
*
* (That info is from http://www.advsys.net/ken/build.htm ...)
*
22
* Please see the file LICENSE.txt in the source's root directory.
23
24
25
26
*
* This file written by Ryan C. Gordon.
*/
27
28
#if (defined PHYSFS_SUPPORTS_GRP)
29
30
31
32
33
34
35
36
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "physfs.h"
#define __PHYSICSFS_INTERNAL__
#include "physfs_internal.h"
37
38
39
typedef struct
{
char name[13];
40
41
PHYSFS_uint32 startPos;
PHYSFS_uint32 size;
42
43
} GRPentry;
44
45
typedef struct
{
46
PHYSFS_Io *io;
47
48
PHYSFS_uint32 entryCount;
GRPentry *entries;
49
50
51
52
} GRPinfo;
typedef struct
{
53
PHYSFS_Io *io;
54
GRPentry *entry;
55
PHYSFS_uint32 curPos;
56
57
58
} GRPfileinfo;
59
static inline int readAll(PHYSFS_Io *io, void *buf, const PHYSFS_uint64 len)
60
{
61
return (io->read(io, buf, len) == len);
62
63
64
} /* readAll */
65
static void GRP_dirClose(dvoid *opaque)
66
{
67
GRPinfo *info = ((GRPinfo *) opaque);
68
info->io->destroy(info->io);
69
70
allocator.Free(info->entries);
allocator.Free(info);
71
} /* GRP_dirClose */
72
73
74
static PHYSFS_sint64 GRP_read(PHYSFS_Io *io, void *buffer, PHYSFS_uint64 len)
75
{
76
GRPfileinfo *finfo = (GRPfileinfo *) io->opaque;
77
78
const GRPentry *entry = finfo->entry;
const PHYSFS_uint64 bytesLeft = (PHYSFS_uint64)(entry->size-finfo->curPos);
79
PHYSFS_sint64 rc;
80
81
82
if (bytesLeft < len)
len = bytesLeft;
83
84
rc = finfo->io->read(finfo->io, buffer, len);
85
if (rc > 0)
86
finfo->curPos += (PHYSFS_uint32) rc;
87
88
return rc;
89
90
91
} /* GRP_read */
92
static PHYSFS_sint64 GRP_write(PHYSFS_Io *io, const void *b, PHYSFS_uint64 len)
93
94
95
96
97
{
BAIL_MACRO(ERR_NOT_SUPPORTED, -1);
} /* GRP_write */
98
static PHYSFS_sint64 GRP_tell(PHYSFS_Io *io)
99
{
100
return ((GRPfileinfo *) io->opaque)->curPos;
101
102
103
} /* GRP_tell */
104
static int GRP_seek(PHYSFS_Io *io, PHYSFS_uint64 offset)
105
{
106
107
GRPfileinfo *finfo = (GRPfileinfo *) io->opaque;
const GRPentry *entry = finfo->entry;
108
int rc;
109
110
BAIL_IF_MACRO(offset >= entry->size, ERR_PAST_EOF, 0);
111
rc = finfo->io->seek(finfo->io, entry->startPos + offset);
112
if (rc)
113
finfo->curPos = (PHYSFS_uint32) offset;
114
115
return rc;
116
117
118
} /* GRP_seek */
119
static PHYSFS_sint64 GRP_length(PHYSFS_Io *io)
120
{
121
const GRPfileinfo *finfo = (GRPfileinfo *) io->opaque;
122
return ((PHYSFS_sint64) finfo->entry->size);
123
} /* GRP_length */
124
125
126
static PHYSFS_Io *GRP_duplicate(PHYSFS_Io *_io)
127
{
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
GRPfileinfo *origfinfo = (GRPfileinfo *) _io->opaque;
PHYSFS_Io *io = NULL;
PHYSFS_Io *retval = (PHYSFS_Io *) allocator.Malloc(sizeof (PHYSFS_Io));
GRPfileinfo *finfo = (GRPfileinfo *) allocator.Malloc(sizeof (GRPfileinfo));
GOTO_IF_MACRO(retval == NULL, ERR_OUT_OF_MEMORY, GRP_duplicate_failed);
GOTO_IF_MACRO(finfo == NULL, ERR_OUT_OF_MEMORY, GRP_duplicate_failed);
io = origfinfo->io->duplicate(origfinfo->io);
GOTO_IF_MACRO(io == NULL, NULL, GRP_duplicate_failed);
finfo->io = io;
finfo->entry = origfinfo->entry;
finfo->curPos = 0;
memcpy(retval, _io, sizeof (PHYSFS_Io));
retval->opaque = finfo;
return retval;
GRP_duplicate_failed:
if (finfo != NULL) allocator.Free(finfo);
if (retval != NULL) allocator.Free(retval);
if (io != NULL) io->destroy(io);
return NULL;
} /* GRP_duplicate */
150
151
static int GRP_flush(PHYSFS_Io *io) { return 1; /* no write support. */ }
152
153
static void GRP_destroy(PHYSFS_Io *io)
154
{
155
156
157
158
159
GRPfileinfo *finfo = (GRPfileinfo *) io->opaque;
finfo->io->destroy(finfo->io);
allocator.Free(finfo);
allocator.Free(io);
} /* GRP_destroy */
160
161
162
163
164
165
166
167
168
169
170
171
172
173
static const PHYSFS_Io GRP_Io =
{
GRP_read,
GRP_write,
GRP_seek,
GRP_tell,
GRP_length,
GRP_duplicate,
GRP_flush,
GRP_destroy,
NULL
};
174
175
176
177
static int grpEntryCmp(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
178
{
179
180
181
if (one != two)
{
const GRPentry *a = (const GRPentry *) _a;
182
return __PHYSFS_stricmpASCII(a[one].name, a[two].name);
183
184
185
} /* if */
return 0;
186
} /* grpEntryCmp */
187
188
189
static void grpEntrySwap(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
190
{
191
192
193
194
195
196
197
198
199
if (one != two)
{
GRPentry tmp;
GRPentry *first = &(((GRPentry *) _a)[one]);
GRPentry *second = &(((GRPentry *) _a)[two]);
memcpy(&tmp, first, sizeof (GRPentry));
memcpy(first, second, sizeof (GRPentry));
memcpy(second, &tmp, sizeof (GRPentry));
} /* if */
200
} /* grpEntrySwap */
201
202
203
static int grp_load_entries(PHYSFS_Io *io, GRPinfo *info)
204
{
205
PHYSFS_uint32 fileCount = info->entryCount;
206
PHYSFS_uint32 location = 16; /* sizeof sig. */
207
208
209
GRPentry *entry;
char *ptr;
210
info->entries = (GRPentry *) allocator.Malloc(sizeof(GRPentry)*fileCount);
211
BAIL_IF_MACRO(info->entries == NULL, ERR_OUT_OF_MEMORY, 0);
212
213
214
location += (16 * fileCount);
215
216
for (entry = info->entries; fileCount > 0; fileCount--, entry++)
{
217
218
BAIL_IF_MACRO(!readAll(io, &entry->name, 12), NULL, 0);
BAIL_IF_MACRO(!readAll(io, &entry->size, 4), NULL, 0);
219
220
221
222
223
224
entry->name[12] = '\0'; /* name isn't null-terminated in file. */
if ((ptr = strchr(entry->name, ' ')) != NULL)
*ptr = '\0'; /* trim extra spaces. */
entry->size = PHYSFS_swapULE32(entry->size);
entry->startPos = location;
225
location += entry->size;
226
227
} /* for */
228
__PHYSFS_sort(info->entries, info->entryCount, grpEntryCmp, grpEntrySwap);
229
return 1;
230
231
232
} /* grp_load_entries */
233
static void *GRP_openArchive(PHYSFS_Io *io, const char *name, int forWriting)
234
{
235
236
237
238
239
PHYSFS_uint8 buf[12];
GRPinfo *info = NULL;
PHYSFS_uint32 val = 0;
assert(io != NULL); /* shouldn't ever happen. */
240
241
BAIL_IF_MACRO(forWriting, ERR_ARC_IS_READ_ONLY, 0);
242
243
244
245
246
247
248
BAIL_IF_MACRO(!readAll(io, buf, sizeof (buf)), NULL, NULL);
if (memcmp(buf, "KenSilverman", sizeof (buf)) != 0)
GOTO_MACRO(ERR_NOT_AN_ARCHIVE, GRP_openArchive_failed);
info = (GRPinfo *) allocator.Malloc(sizeof (GRPinfo));
GOTO_IF_MACRO(info == NULL, ERR_OUT_OF_MEMORY, GRP_openArchive_failed);
249
memset(info, '\0', sizeof (GRPinfo));
250
info->io = io;
251
252
253
GOTO_IF_MACRO(!readAll(io,&val,sizeof(val)), NULL, GRP_openArchive_failed);
info->entryCount = PHYSFS_swapULE32(val);
254
255
GOTO_IF_MACRO(!grp_load_entries(io, info), NULL, GRP_openArchive_failed);
256
257
return info;
258
259
GRP_openArchive_failed:
260
if (info != NULL)
261
{
262
if (info->entries != NULL)
263
264
allocator.Free(info->entries);
allocator.Free(info);
265
266
} /* if */
267
return NULL;
268
269
270
} /* GRP_openArchive */
271
static void GRP_enumerateFiles(dvoid *opaque, const char *dname,
272
273
int omitSymLinks, PHYSFS_EnumFilesCallback cb,
const char *origdir, void *callbackdata)
274
{
275
/* no directories in GRP files. */
276
if (*dname == '\0')
277
278
279
280
281
{
GRPinfo *info = (GRPinfo *) opaque;
GRPentry *entry = info->entries;
PHYSFS_uint32 max = info->entryCount;
PHYSFS_uint32 i;
282
283
for (i = 0; i < max; i++, entry++)
284
cb(callbackdata, origdir, entry->name);
285
} /* if */
286
287
288
} /* GRP_enumerateFiles */
289
static GRPentry *grp_find_entry(const GRPinfo *info, const char *name)
290
{
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
char *ptr = strchr(name, '.');
GRPentry *a = info->entries;
PHYSFS_sint32 lo = 0;
PHYSFS_sint32 hi = (PHYSFS_sint32) (info->entryCount - 1);
PHYSFS_sint32 middle;
int rc;
/*
* Rule out filenames to avoid unneeded processing...no dirs,
* big filenames, or extensions > 3 chars.
*/
BAIL_IF_MACRO((ptr) && (strlen(ptr) > 4), ERR_NO_SUCH_FILE, NULL);
BAIL_IF_MACRO(strlen(name) > 12, ERR_NO_SUCH_FILE, NULL);
BAIL_IF_MACRO(strchr(name, '/') != NULL, ERR_NO_SUCH_FILE, NULL);
while (lo <= hi)
307
{
308
middle = lo + ((hi - lo) / 2);
309
rc = __PHYSFS_stricmpASCII(name, a[middle].name);
310
if (rc == 0) /* found it! */
311
return &a[middle];
312
313
314
315
316
else if (rc > 0)
lo = middle + 1;
else
hi = middle - 1;
} /* while */
317
318
319
BAIL_MACRO(ERR_NO_SUCH_FILE, NULL);
} /* grp_find_entry */
320
321
322
static int GRP_exists(dvoid *opaque, const char *name)
323
{
324
return (grp_find_entry((GRPinfo *) opaque, name) != NULL);
325
326
327
} /* GRP_exists */
328
static int GRP_isDirectory(dvoid *opaque, const char *name, int *fileExists)
329
{
330
*fileExists = GRP_exists(opaque, name);
331
return 0; /* never directories in a groupfile. */
332
333
334
} /* GRP_isDirectory */
335
static int GRP_isSymLink(dvoid *opaque, const char *name, int *fileExists)
336
{
337
*fileExists = GRP_exists(opaque, name);
338
return 0; /* never symlinks in a groupfile. */
339
340
341
} /* GRP_isSymLink */
342
static PHYSFS_Io *GRP_openRead(dvoid *opaque, const char *fnm, int *fileExists)
343
{
344
PHYSFS_Io *retval = NULL;
345
GRPinfo *info = (GRPinfo *) opaque;
346
GRPfileinfo *finfo;
347
GRPentry *entry;
348
349
350
entry = grp_find_entry(info, fnm);
*fileExists = (entry != NULL);
351
352
353
354
GOTO_IF_MACRO(entry == NULL, NULL, GRP_openRead_failed);
retval = (PHYSFS_Io *) allocator.Malloc(sizeof (PHYSFS_Io));
GOTO_IF_MACRO(retval == NULL, ERR_OUT_OF_MEMORY, GRP_openRead_failed);
355
356
finfo = (GRPfileinfo *) allocator.Malloc(sizeof (GRPfileinfo));
357
GOTO_IF_MACRO(finfo == NULL, ERR_OUT_OF_MEMORY, GRP_openRead_failed);
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
finfo->io = info->io->duplicate(info->io);
GOTO_IF_MACRO(finfo->io == NULL, NULL, GRP_openRead_failed);
if (!finfo->io->seek(finfo->io, entry->startPos))
GOTO_MACRO(NULL, GRP_openRead_failed);
finfo->curPos = 0;
finfo->entry = entry;
memcpy(retval, &GRP_Io, sizeof (*retval));
retval->opaque = finfo;
return retval;
GRP_openRead_failed:
if (finfo != NULL)
374
{
375
376
if (finfo->io != NULL)
finfo->io->destroy(finfo->io);
377
allocator.Free(finfo);
378
379
} /* if */
380
381
382
383
if (retval != NULL)
allocator.Free(retval);
return NULL;
384
385
} /* GRP_openRead */
386
387
static PHYSFS_Io *GRP_openWrite(dvoid *opaque, const char *name)
388
389
390
391
392
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* GRP_openWrite */
393
static PHYSFS_Io *GRP_openAppend(dvoid *opaque, const char *name)
394
395
396
397
398
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* GRP_openAppend */
399
static int GRP_remove(dvoid *opaque, const char *name)
400
401
402
403
404
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* GRP_remove */
405
static int GRP_mkdir(dvoid *opaque, const char *name)
406
407
408
409
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* GRP_mkdir */
410
411
static int GRP_stat(dvoid *opaque, const char *filename, int *exists,
412
413
414
415
416
417
418
419
420
421
422
PHYSFS_Stat *stat)
{
const GRPinfo *info = (const GRPinfo *) opaque;
const GRPentry *entry = grp_find_entry(info, filename);
*exists = (entry != 0);
if (!entry)
return 0;
stat->filesize = entry->size;
stat->filetype = PHYSFS_FILETYPE_REGULAR;
423
424
stat->modtime = -1;
stat->createtime = -1;
425
426
427
stat->accesstime = -1;
stat->readonly = 1;
428
return 1;
429
430
431
} /* GRP_stat */
432
433
434
435
const PHYSFS_ArchiveInfo __PHYSFS_ArchiveInfo_GRP =
{
"GRP",
GRP_ARCHIVE_DESCRIPTION,
436
"Ryan C. Gordon <icculus@icculus.org>",
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
"http://icculus.org/physfs/",
};
const PHYSFS_Archiver __PHYSFS_Archiver_GRP =
{
&__PHYSFS_ArchiveInfo_GRP,
GRP_openArchive, /* openArchive() method */
GRP_enumerateFiles, /* enumerateFiles() method */
GRP_exists, /* exists() method */
GRP_isDirectory, /* isDirectory() method */
GRP_isSymLink, /* isSymLink() method */
GRP_openRead, /* openRead() method */
GRP_openWrite, /* openWrite() method */
GRP_openAppend, /* openAppend() method */
GRP_remove, /* remove() method */
GRP_mkdir, /* mkdir() method */
GRP_dirClose, /* dirClose() method */
455
GRP_stat /* stat() method */
456
457
};
458
459
#endif /* defined PHYSFS_SUPPORTS_GRP */
460
/* end of grp.c ... */