/
hog.c
506 lines (399 loc) · 13.5 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
static void HOG_dirClose(dvoid *opaque)
75
{
76
HOGinfo *info = ((HOGinfo *) opaque);
77
78
79
allocator.Free(info->filename);
allocator.Free(info->entries);
allocator.Free(info);
80
81
82
} /* HOG_dirClose */
83
static PHYSFS_sint64 HOG_read(fvoid *opaque, void *buffer,
84
85
PHYSFS_uint32 objSize, PHYSFS_uint32 objCount)
{
86
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
HOGentry *entry = finfo->entry;
PHYSFS_uint32 bytesLeft = entry->size - finfo->curPos;
PHYSFS_uint32 objsLeft = (bytesLeft / objSize);
PHYSFS_sint64 rc;
if (objsLeft < objCount)
objCount = objsLeft;
rc = __PHYSFS_platformRead(finfo->handle, buffer, objSize, objCount);
if (rc > 0)
finfo->curPos += (PHYSFS_uint32) (rc * objSize);
return(rc);
} /* HOG_read */
103
static PHYSFS_sint64 HOG_write(fvoid *opaque, const void *buffer,
104
105
106
107
108
109
PHYSFS_uint32 objSize, PHYSFS_uint32 objCount)
{
BAIL_MACRO(ERR_NOT_SUPPORTED, -1);
} /* HOG_write */
110
static int HOG_eof(fvoid *opaque)
111
{
112
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
113
114
115
116
117
HOGentry *entry = finfo->entry;
return(finfo->curPos >= entry->size);
} /* HOG_eof */
118
static PHYSFS_sint64 HOG_tell(fvoid *opaque)
119
{
120
return(((HOGfileinfo *) opaque)->curPos);
121
122
123
} /* HOG_tell */
124
static int HOG_seek(fvoid *opaque, PHYSFS_uint64 offset)
125
{
126
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
127
128
129
130
131
132
133
134
135
136
137
138
139
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;
return(rc);
} /* HOG_seek */
140
static PHYSFS_sint64 HOG_fileLength(fvoid *opaque)
141
{
142
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
143
144
145
146
return((PHYSFS_sint64) finfo->entry->size);
} /* HOG_fileLength */
147
static int HOG_fileClose(fvoid *opaque)
148
{
149
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
150
BAIL_IF_MACRO(!__PHYSFS_platformClose(finfo->handle), NULL, 0);
151
allocator.Free(finfo);
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
return(1);
} /* 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);
if (__PHYSFS_platformRead(*fh, buf, 3, 1) != 1)
goto openHog_failed;
if (memcmp(buf, "DHF", 3) != 0)
{
__PHYSFS_setError(ERR_UNSUPPORTED_ARCHIVE);
goto openHog_failed;
} /* if */
180
while (1)
181
182
{
if (__PHYSFS_platformRead(*fh, buf, 13, 1) != 1)
183
break; /* eof here is ok */
184
185
186
187
188
189
190
191
if (__PHYSFS_platformRead(*fh, &size, 4, 1) != 1)
goto openHog_failed;
size = PHYSFS_swapULE32(size);
(*count)++;
192
/* Skip over entry... */
193
194
195
196
197
pos = __PHYSFS_platformTell(*fh);
if (pos == -1)
goto openHog_failed;
if (!__PHYSFS_platformSeek(*fh, pos + size))
goto openHog_failed;
198
} /* while */
199
200
/* Rewind to start of entries... */
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
if (!__PHYSFS_platformSeek(*fh, 3))
goto openHog_failed;
return(1);
openHog_failed:
if (*fh != NULL)
__PHYSFS_platformClose(*fh);
*count = -1;
*fh = NULL;
return(0);
} /* hog_open */
static int HOG_isArchive(const char *filename, int forWriting)
{
void *fh;
PHYSFS_uint32 fileCount;
int retval = hog_open(filename, forWriting, &fh, &fileCount);
if (fh != NULL)
__PHYSFS_platformClose(fh);
return(retval);
} /* HOG_isArchive */
static int hog_entry_cmp(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
{
HOGentry *a = (HOGentry *) _a;
232
return(__PHYSFS_stricmpASCII(a[one].name, a[two].name));
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
} /* hog_entry_cmp */
static void hog_entry_swap(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 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));
} /* 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;
255
info->entries = (HOGentry *) allocator.Malloc(sizeof(HOGentry)*fileCount);
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
if (info->entries == NULL)
{
__PHYSFS_platformClose(fh);
BAIL_MACRO(ERR_OUT_OF_MEMORY, 0);
} /* if */
for (entry = info->entries; fileCount > 0; fileCount--, entry++)
{
if (__PHYSFS_platformRead(fh, &entry->name, 13, 1) != 1)
{
__PHYSFS_platformClose(fh);
return(0);
} /* if */
if (__PHYSFS_platformRead(fh, &entry->size, 4, 1) != 1)
{
__PHYSFS_platformClose(fh);
return(0);
} /* if */
entry->size = PHYSFS_swapULE32(entry->size);
277
entry->startPos = (unsigned int) __PHYSFS_platformTell(fh);
278
279
280
281
282
283
if (entry->startPos == -1)
{
__PHYSFS_platformClose(fh);
return(0);
}
284
/* Skip over entry */
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
if (!__PHYSFS_platformSeek(fh, entry->startPos + entry->size))
{
__PHYSFS_platformClose(fh);
return(0);
}
} /* for */
__PHYSFS_platformClose(fh);
__PHYSFS_sort(info->entries, info->entryCount,
hog_entry_cmp, hog_entry_swap);
return(1);
} /* hog_load_entries */
300
static void *HOG_openArchive(const char *name, int forWriting)
301
302
{
PHYSFS_sint64 modtime = __PHYSFS_platformGetLastModTime(name);
303
HOGinfo *info = (HOGinfo *) allocator.Malloc(sizeof (HOGinfo));
304
305
BAIL_IF_MACRO(info == NULL, ERR_OUT_OF_MEMORY, 0);
306
memset(info, '\0', sizeof (HOGinfo));
307
info->filename = (char *) allocator.Malloc(strlen(name) + 1);
308
GOTO_IF_MACRO(!info->filename, ERR_OUT_OF_MEMORY, HOG_openArchive_failed);
309
310
311
312
313
314
if (!hog_load_entries(name, forWriting, info))
goto HOG_openArchive_failed;
strcpy(info->filename, name);
info->last_mod_time = modtime;
315
316
return(info);
317
318
HOG_openArchive_failed:
319
if (info != NULL)
320
{
321
if (info->filename != NULL)
322
allocator.Free(info->filename);
323
if (info->entries != NULL)
324
325
allocator.Free(info->entries);
allocator.Free(info);
326
327
328
329
330
331
} /* if */
return(NULL);
} /* HOG_openArchive */
332
static void HOG_enumerateFiles(dvoid *opaque, const char *dname,
333
334
int omitSymLinks, PHYSFS_EnumFilesCallback cb,
const char *origdir, void *callbackdata)
335
336
{
/* no directories in HOG files. */
337
338
339
340
341
342
if (*dname != '\0')
{
HOGinfo *info = (HOGinfo *) opaque;
HOGentry *entry = info->entries;
PHYSFS_uint32 max = info->entryCount;
PHYSFS_uint32 i;
343
344
for (i = 0; i < max; i++, entry++)
345
cb(callbackdata, origdir, entry->name);
346
} /* if */
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
} /* HOG_enumerateFiles */
static HOGentry *hog_find_entry(HOGinfo *info, const char *name)
{
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);
370
rc = __PHYSFS_stricmpASCII(name, a[middle].name);
371
372
373
374
375
376
377
378
379
380
381
382
if (rc == 0) /* found it! */
return(&a[middle]);
else if (rc > 0)
lo = middle + 1;
else
hi = middle - 1;
} /* while */
BAIL_MACRO(ERR_NO_SUCH_FILE, NULL);
} /* hog_find_entry */
383
static int HOG_exists(dvoid *opaque, const char *name)
384
{
385
return(hog_find_entry(((HOGinfo *) opaque), name) != NULL);
386
387
388
} /* HOG_exists */
389
static int HOG_isDirectory(dvoid *opaque, const char *name, int *fileExists)
390
{
391
*fileExists = HOG_exists(opaque, name);
392
393
394
395
return(0); /* never directories in a groupfile. */
} /* HOG_isDirectory */
396
static int HOG_isSymLink(dvoid *opaque, const char *name, int *fileExists)
397
{
398
*fileExists = HOG_exists(opaque, name);
399
400
401
402
return(0); /* never symlinks in a groupfile. */
} /* HOG_isSymLink */
403
static PHYSFS_sint64 HOG_getLastModTime(dvoid *opaque,
404
405
406
const char *name,
int *fileExists)
{
407
HOGinfo *info = ((HOGinfo *) opaque);
408
409
410
411
PHYSFS_sint64 retval = -1;
*fileExists = (hog_find_entry(info, name) != NULL);
if (*fileExists) /* use time of HOG itself in the physical filesystem. */
412
retval = info->last_mod_time;
413
414
415
416
417
return(retval);
} /* HOG_getLastModTime */
418
static fvoid *HOG_openRead(dvoid *opaque, const char *fnm, int *fileExists)
419
{
420
HOGinfo *info = ((HOGinfo *) opaque);
421
422
423
424
425
426
427
HOGfileinfo *finfo;
HOGentry *entry;
entry = hog_find_entry(info, fnm);
*fileExists = (entry != NULL);
BAIL_IF_MACRO(entry == NULL, NULL, NULL);
428
finfo = (HOGfileinfo *) allocator.Malloc(sizeof (HOGfileinfo));
429
BAIL_IF_MACRO(finfo == NULL, ERR_OUT_OF_MEMORY, NULL);
430
431
432
433
434
finfo->handle = __PHYSFS_platformOpenRead(info->filename);
if ( (finfo->handle == NULL) ||
(!__PHYSFS_platformSeek(finfo->handle, entry->startPos)) )
{
435
allocator.Free(finfo);
436
437
438
439
440
return(NULL);
} /* if */
finfo->curPos = 0;
finfo->entry = entry;
441
return(finfo);
442
443
444
} /* HOG_openRead */
445
static fvoid *HOG_openWrite(dvoid *opaque, const char *name)
446
447
448
449
450
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* HOG_openWrite */
451
static fvoid *HOG_openAppend(dvoid *opaque, const char *name)
452
453
454
455
456
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* HOG_openAppend */
457
static int HOG_remove(dvoid *opaque, const char *name)
458
459
460
461
462
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* HOG_remove */
463
static int HOG_mkdir(dvoid *opaque, const char *name)
464
465
466
467
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* HOG_mkdir */
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
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_isArchive, /* isArchive() method */
HOG_openArchive, /* openArchive() method */
HOG_enumerateFiles, /* enumerateFiles() method */
HOG_exists, /* exists() method */
HOG_isDirectory, /* isDirectory() method */
HOG_isSymLink, /* isSymLink() method */
HOG_getLastModTime, /* getLastModTime() 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 */
HOG_read, /* read() method */
HOG_write, /* write() method */
HOG_eof, /* eof() method */
HOG_tell, /* tell() method */
HOG_seek, /* seek() method */
HOG_fileLength, /* fileLength() method */
HOG_fileClose /* fileClose() method */
};
503
504
505
#endif /* defined PHYSFS_SUPPORTS_HOG */
/* end of hog.c ... */