/
archiver_hog.c
500 lines (394 loc) · 13.1 KB
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
/*
* HOG support routines for PhysicsFS.
*
* This driver handles Descent I/II HOG archives.
*
* The format is very simple:
*
* The file always starts with the 3-byte signature "DHF" (Descent
* HOG file). After that the files of a HOG are just attached after
* another, divided by a 17 bytes header, which specifies the name
* and length (in bytes) of the forthcoming file! So you just read
* the header with its information of how big the following file is,
* and then skip exact that number of bytes to get to the next file
* in that HOG.
*
* char sig[3] = {'D', 'H', 'F'}; // "DHF"=Descent HOG File
*
* struct {
* char file_name[13]; // Filename, padded to 13 bytes with 0s
* int file_size; // filesize in bytes
* char data[file_size]; // The file data
* } FILE_STRUCT; // Repeated until the end of the file.
*
* (That info is from http://www.descent2.com/ddn/specs/hog/)
*
26
* Please see the file LICENSE.txt in the source's root directory.
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
*
* This file written by Bradley Bell.
* Based on grp.c by Ryan C. Gordon.
*/
#if (defined PHYSFS_SUPPORTS_HOG)
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "physfs.h"
#define __PHYSICSFS_INTERNAL__
#include "physfs_internal.h"
/*
* One HOGentry is kept for each file in an open HOG archive.
*/
typedef struct
{
char name[13];
PHYSFS_uint32 startPos;
PHYSFS_uint32 size;
} HOGentry;
/*
* One HOGinfo is kept for each open HOG archive.
*/
typedef struct
{
char *filename;
PHYSFS_sint64 last_mod_time;
PHYSFS_uint32 entryCount;
HOGentry *entries;
} HOGinfo;
/*
* One HOGfileinfo is kept for each open file in a HOG archive.
*/
typedef struct
{
void *handle;
HOGentry *entry;
PHYSFS_uint32 curPos;
} HOGfileinfo;
74
75
76
77
78
79
static inline int readAll(void *fh, void *buf, const PHYSFS_uint64 len)
{
return (__PHYSFS_platformRead(fh, buf, len) == len);
} /* readAll */
80
static void HOG_dirClose(dvoid *opaque)
81
{
82
HOGinfo *info = ((HOGinfo *) opaque);
83
84
85
allocator.Free(info->filename);
allocator.Free(info->entries);
allocator.Free(info);
86
87
88
} /* HOG_dirClose */
89
static PHYSFS_sint64 HOG_read(fvoid *opaque, void *buffer, PHYSFS_uint64 len)
90
{
91
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
92
93
const HOGentry *entry = finfo->entry;
const PHYSFS_uint64 bytesLeft = (PHYSFS_uint64)(entry->size-finfo->curPos);
94
95
PHYSFS_sint64 rc;
96
97
if (bytesLeft < len)
len = bytesLeft;
98
99
rc = __PHYSFS_platformRead(finfo->handle, buffer, len);
100
if (rc > 0)
101
finfo->curPos += (PHYSFS_uint32) rc;
102
103
return rc;
104
105
106
} /* HOG_read */
107
static PHYSFS_sint64 HOG_write(fvoid *f, const void *buf, PHYSFS_uint64 len)
108
109
110
111
112
{
BAIL_MACRO(ERR_NOT_SUPPORTED, -1);
} /* HOG_write */
113
static int HOG_eof(fvoid *opaque)
114
{
115
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
116
HOGentry *entry = finfo->entry;
117
return (finfo->curPos >= entry->size);
118
119
120
} /* HOG_eof */
121
static PHYSFS_sint64 HOG_tell(fvoid *opaque)
122
{
123
return ((HOGfileinfo *) opaque)->curPos;
124
125
126
} /* HOG_tell */
127
static int HOG_seek(fvoid *opaque, PHYSFS_uint64 offset)
128
{
129
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
130
131
132
133
134
135
136
137
138
HOGentry *entry = finfo->entry;
int rc;
BAIL_IF_MACRO(offset < 0, ERR_INVALID_ARGUMENT, 0);
BAIL_IF_MACRO(offset >= entry->size, ERR_PAST_EOF, 0);
rc = __PHYSFS_platformSeek(finfo->handle, entry->startPos + offset);
if (rc)
finfo->curPos = (PHYSFS_uint32) offset;
139
return rc;
140
141
142
} /* HOG_seek */
143
static PHYSFS_sint64 HOG_fileLength(fvoid *opaque)
144
{
145
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
146
return ((PHYSFS_sint64) finfo->entry->size);
147
148
149
} /* HOG_fileLength */
150
static int HOG_fileClose(fvoid *opaque)
151
{
152
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
153
BAIL_IF_MACRO(!__PHYSFS_platformClose(finfo->handle), NULL, 0);
154
allocator.Free(finfo);
155
return 1;
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
} /* HOG_fileClose */
static int hog_open(const char *filename, int forWriting,
void **fh, PHYSFS_uint32 *count)
{
PHYSFS_uint8 buf[13];
PHYSFS_uint32 size;
PHYSFS_sint64 pos;
*count = 0;
*fh = NULL;
BAIL_IF_MACRO(forWriting, ERR_ARC_IS_READ_ONLY, 0);
*fh = __PHYSFS_platformOpenRead(filename);
BAIL_IF_MACRO(*fh == NULL, NULL, 0);
174
if (!readAll(*fh, buf, 3))
175
176
177
178
179
180
181
182
goto openHog_failed;
if (memcmp(buf, "DHF", 3) != 0)
{
__PHYSFS_setError(ERR_UNSUPPORTED_ARCHIVE);
goto openHog_failed;
} /* if */
183
while (1)
184
{
185
if (!readAll(*fh, buf, 13))
186
break; /* eof here is ok */
187
188
if (!readAll(*fh, &size, sizeof (PHYSFS_uint32)))
189
190
191
192
193
194
goto openHog_failed;
size = PHYSFS_swapULE32(size);
(*count)++;
195
/* Skip over entry... */
196
197
198
199
200
pos = __PHYSFS_platformTell(*fh);
if (pos == -1)
goto openHog_failed;
if (!__PHYSFS_platformSeek(*fh, pos + size))
goto openHog_failed;
201
} /* while */
202
203
/* Rewind to start of entries... */
204
205
206
if (!__PHYSFS_platformSeek(*fh, 3))
goto openHog_failed;
207
return 1;
208
209
210
211
212
213
214
openHog_failed:
if (*fh != NULL)
__PHYSFS_platformClose(*fh);
*count = -1;
*fh = NULL;
215
return 0;
216
217
218
219
220
} /* hog_open */
static int hog_entry_cmp(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
{
221
222
223
if (one != two)
{
const HOGentry *a = (const HOGentry *) _a;
224
return __PHYSFS_stricmpASCII(a[one].name, a[two].name);
225
226
227
} /* if */
return 0;
228
229
230
231
232
} /* hog_entry_cmp */
static void hog_entry_swap(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
{
233
234
235
236
237
238
239
240
241
if (one != two)
{
HOGentry tmp;
HOGentry *first = &(((HOGentry *) _a)[one]);
HOGentry *second = &(((HOGentry *) _a)[two]);
memcpy(&tmp, first, sizeof (HOGentry));
memcpy(first, second, sizeof (HOGentry));
memcpy(second, &tmp, sizeof (HOGentry));
} /* if */
242
243
244
245
246
247
248
249
250
251
252
} /* hog_entry_swap */
static int hog_load_entries(const char *name, int forWriting, HOGinfo *info)
{
void *fh = NULL;
PHYSFS_uint32 fileCount;
HOGentry *entry;
BAIL_IF_MACRO(!hog_open(name, forWriting, &fh, &fileCount), NULL, 0);
info->entryCount = fileCount;
253
info->entries = (HOGentry *) allocator.Malloc(sizeof(HOGentry)*fileCount);
254
255
256
257
258
259
260
261
if (info->entries == NULL)
{
__PHYSFS_platformClose(fh);
BAIL_MACRO(ERR_OUT_OF_MEMORY, 0);
} /* if */
for (entry = info->entries; fileCount > 0; fileCount--, entry++)
{
262
263
if ( (!readAll(fh, &entry->name, 13)) ||
(!readAll(fh, &entry->size, sizeof (PHYSFS_uint32))) )
264
265
{
__PHYSFS_platformClose(fh);
266
return 0;
267
268
269
} /* if */
entry->size = PHYSFS_swapULE32(entry->size);
270
entry->startPos = (unsigned int) __PHYSFS_platformTell(fh);
271
272
/* Skip over entry */
273
274
if ( (entry->startPos == -1) ||
(!__PHYSFS_platformSeek(fh, entry->startPos + entry->size)) )
275
276
{
__PHYSFS_platformClose(fh);
277
return 0;
278
} /* if */
279
280
281
282
283
284
} /* for */
__PHYSFS_platformClose(fh);
__PHYSFS_sort(info->entries, info->entryCount,
hog_entry_cmp, hog_entry_swap);
285
return 1;
286
287
288
} /* hog_load_entries */
289
static void *HOG_openArchive(const char *name, int forWriting)
290
291
{
PHYSFS_sint64 modtime = __PHYSFS_platformGetLastModTime(name);
292
HOGinfo *info = (HOGinfo *) allocator.Malloc(sizeof (HOGinfo));
293
294
BAIL_IF_MACRO(info == NULL, ERR_OUT_OF_MEMORY, NULL);
295
memset(info, '\0', sizeof (HOGinfo));
296
info->filename = (char *) allocator.Malloc(strlen(name) + 1);
297
GOTO_IF_MACRO(!info->filename, ERR_OUT_OF_MEMORY, HOG_openArchive_failed);
298
299
300
301
302
303
if (!hog_load_entries(name, forWriting, info))
goto HOG_openArchive_failed;
strcpy(info->filename, name);
info->last_mod_time = modtime;
304
305
return info;
306
307
HOG_openArchive_failed:
308
if (info != NULL)
309
{
310
if (info->filename != NULL)
311
allocator.Free(info->filename);
312
if (info->entries != NULL)
313
314
allocator.Free(info->entries);
allocator.Free(info);
315
316
} /* if */
317
return NULL;
318
319
320
} /* HOG_openArchive */
321
static void HOG_enumerateFiles(dvoid *opaque, const char *dname,
322
323
int omitSymLinks, PHYSFS_EnumFilesCallback cb,
const char *origdir, void *callbackdata)
324
325
{
/* no directories in HOG files. */
326
if (*dname == '\0')
327
328
329
330
331
{
HOGinfo *info = (HOGinfo *) opaque;
HOGentry *entry = info->entries;
PHYSFS_uint32 max = info->entryCount;
PHYSFS_uint32 i;
332
333
for (i = 0; i < max; i++, entry++)
334
cb(callbackdata, origdir, entry->name);
335
} /* if */
336
337
338
} /* HOG_enumerateFiles */
339
static HOGentry *hog_find_entry(const HOGinfo *info, const char *name)
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
{
char *ptr = strchr(name, '.');
HOGentry *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)
{
middle = lo + ((hi - lo) / 2);
359
rc = __PHYSFS_stricmpASCII(name, a[middle].name);
360
if (rc == 0) /* found it! */
361
return &a[middle];
362
363
364
365
366
367
368
369
370
371
else if (rc > 0)
lo = middle + 1;
else
hi = middle - 1;
} /* while */
BAIL_MACRO(ERR_NO_SUCH_FILE, NULL);
} /* hog_find_entry */
372
static int HOG_exists(dvoid *opaque, const char *name)
373
{
374
return (hog_find_entry(((HOGinfo *) opaque), name) != NULL);
375
376
377
} /* HOG_exists */
378
static int HOG_isDirectory(dvoid *opaque, const char *name, int *fileExists)
379
{
380
*fileExists = HOG_exists(opaque, name);
381
return 0; /* never directories in a groupfile. */
382
383
384
} /* HOG_isDirectory */
385
static int HOG_isSymLink(dvoid *opaque, const char *name, int *fileExists)
386
{
387
*fileExists = HOG_exists(opaque, name);
388
return 0; /* never symlinks in a groupfile. */
389
390
391
} /* HOG_isSymLink */
392
static fvoid *HOG_openRead(dvoid *opaque, const char *fnm, int *fileExists)
393
{
394
HOGinfo *info = ((HOGinfo *) opaque);
395
396
397
398
399
400
401
HOGfileinfo *finfo;
HOGentry *entry;
entry = hog_find_entry(info, fnm);
*fileExists = (entry != NULL);
BAIL_IF_MACRO(entry == NULL, NULL, NULL);
402
finfo = (HOGfileinfo *) allocator.Malloc(sizeof (HOGfileinfo));
403
BAIL_IF_MACRO(finfo == NULL, ERR_OUT_OF_MEMORY, NULL);
404
405
406
407
408
finfo->handle = __PHYSFS_platformOpenRead(info->filename);
if ( (finfo->handle == NULL) ||
(!__PHYSFS_platformSeek(finfo->handle, entry->startPos)) )
{
409
allocator.Free(finfo);
410
return NULL;
411
412
413
414
} /* if */
finfo->curPos = 0;
finfo->entry = entry;
415
return finfo;
416
417
418
} /* HOG_openRead */
419
static fvoid *HOG_openWrite(dvoid *opaque, const char *name)
420
421
422
423
424
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* HOG_openWrite */
425
static fvoid *HOG_openAppend(dvoid *opaque, const char *name)
426
427
428
429
430
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* HOG_openAppend */
431
static int HOG_remove(dvoid *opaque, const char *name)
432
433
434
435
436
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* HOG_remove */
437
static int HOG_mkdir(dvoid *opaque, const char *name)
438
439
440
441
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* HOG_mkdir */
442
443
static int HOG_stat(dvoid *opaque, const char *filename, int *exists,
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
PHYSFS_Stat *stat)
{
const HOGinfo *info = (const HOGinfo *) opaque;
const HOGentry *entry = hog_find_entry(info, filename);
*exists = (entry != 0);
if (!entry)
return 0;
stat->filesize = entry->size;
stat->filetype = PHYSFS_FILETYPE_REGULAR;
stat->modtime = info->last_mod_time;
stat->createtime = info->last_mod_time;
stat->accesstime = -1;
stat->readonly = 1;
460
return 1;
461
462
463
} /* HOG_stat */
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
const PHYSFS_ArchiveInfo __PHYSFS_ArchiveInfo_HOG =
{
"HOG",
HOG_ARCHIVE_DESCRIPTION,
"Bradley Bell <btb@icculus.org>",
"http://icculus.org/physfs/",
};
const PHYSFS_Archiver __PHYSFS_Archiver_HOG =
{
&__PHYSFS_ArchiveInfo_HOG,
HOG_openArchive, /* openArchive() method */
HOG_enumerateFiles, /* enumerateFiles() method */
HOG_exists, /* exists() method */
HOG_isDirectory, /* isDirectory() method */
HOG_isSymLink, /* isSymLink() method */
HOG_openRead, /* openRead() method */
HOG_openWrite, /* openWrite() method */
HOG_openAppend, /* openAppend() method */
HOG_remove, /* remove() method */
HOG_mkdir, /* mkdir() method */
HOG_dirClose, /* dirClose() method */
487
HOG_stat, /* stat() method */
488
489
490
491
492
493
HOG_read, /* read() method */
HOG_write, /* write() method */
HOG_eof, /* eof() method */
HOG_tell, /* tell() method */
HOG_seek, /* seek() method */
HOG_fileLength, /* fileLength() method */
494
HOG_fileClose /* fileClose() method */
495
496
};
497
498
499
#endif /* defined PHYSFS_SUPPORTS_HOG */
/* end of hog.c ... */