Skip to content

Latest commit

 

History

History
530 lines (416 loc) · 14 KB

archiver_hog.c

File metadata and controls

530 lines (416 loc) · 14 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 */
83
84
85
allocator.Free(info->filename);
allocator.Free(info->entries);
allocator.Free(info);
89
static PHYSFS_sint64 HOG_read(fvoid *opaque, void *buffer, PHYSFS_uint64 len)
91
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
92
93
const HOGentry *entry = finfo->entry;
const PHYSFS_uint64 bytesLeft = (PHYSFS_uint64)(entry->size-finfo->curPos);
96
97
if (bytesLeft < len)
len = bytesLeft;
99
rc = __PHYSFS_platformRead(finfo->handle, buffer, len);
101
finfo->curPos += (PHYSFS_uint32) rc;
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 */
115
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
121
static PHYSFS_sint64 HOG_tell(fvoid *opaque)
127
static int HOG_seek(fvoid *opaque, PHYSFS_uint64 offset)
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;
143
static PHYSFS_sint64 HOG_fileLength(fvoid *opaque)
145
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
146
return ((PHYSFS_sint64) finfo->entry->size);
152
HOGfileinfo *finfo = (HOGfileinfo *) opaque;
153
BAIL_IF_MACRO(!__PHYSFS_platformClose(finfo->handle), NULL, 0);
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);
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 */
188
if (!readAll(*fh, &size, sizeof (PHYSFS_uint32)))
189
190
191
192
193
194
goto openHog_failed;
size = PHYSFS_swapULE32(size);
(*count)++;
196
197
198
199
200
pos = __PHYSFS_platformTell(*fh);
if (pos == -1)
goto openHog_failed;
if (!__PHYSFS_platformSeek(*fh, pos + size))
goto openHog_failed;
203
/* Rewind to start of entries... */
204
205
206
if (!__PHYSFS_platformSeek(*fh, 3))
goto openHog_failed;
208
209
210
211
212
213
214
openHog_failed:
if (*fh != NULL)
__PHYSFS_platformClose(*fh);
*count = -1;
*fh = NULL;
216
217
218
219
220
221
222
223
224
225
226
227
} /* 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);
229
230
231
232
233
} /* HOG_isArchive */
static int hog_entry_cmp(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
{
234
235
236
if (one != two)
{
const HOGentry *a = (const HOGentry *) _a;
237
return __PHYSFS_stricmpASCII(a[one].name, a[two].name);
241
242
243
244
245
} /* hog_entry_cmp */
static void hog_entry_swap(void *_a, PHYSFS_uint32 one, PHYSFS_uint32 two)
{
246
247
248
249
250
251
252
253
254
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 */
255
256
257
258
259
260
261
262
263
264
265
} /* 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;
266
info->entries = (HOGentry *) allocator.Malloc(sizeof(HOGentry)*fileCount);
267
268
269
270
271
272
273
274
if (info->entries == NULL)
{
__PHYSFS_platformClose(fh);
BAIL_MACRO(ERR_OUT_OF_MEMORY, 0);
} /* if */
for (entry = info->entries; fileCount > 0; fileCount--, entry++)
{
275
276
if ( (!readAll(fh, &entry->name, 13)) ||
(!readAll(fh, &entry->size, sizeof (PHYSFS_uint32))) )
280
281
282
} /* if */
entry->size = PHYSFS_swapULE32(entry->size);
283
entry->startPos = (unsigned int) __PHYSFS_platformTell(fh);
286
287
if ( (entry->startPos == -1) ||
(!__PHYSFS_platformSeek(fh, entry->startPos + entry->size)) )
292
293
294
295
296
297
} /* for */
__PHYSFS_platformClose(fh);
__PHYSFS_sort(info->entries, info->entryCount,
hog_entry_cmp, hog_entry_swap);
302
static void *HOG_openArchive(const char *name, int forWriting)
303
304
{
PHYSFS_sint64 modtime = __PHYSFS_platformGetLastModTime(name);
305
HOGinfo *info = (HOGinfo *) allocator.Malloc(sizeof (HOGinfo));
307
BAIL_IF_MACRO(info == NULL, ERR_OUT_OF_MEMORY, 0);
309
info->filename = (char *) allocator.Malloc(strlen(name) + 1);
310
GOTO_IF_MACRO(!info->filename, ERR_OUT_OF_MEMORY, HOG_openArchive_failed);
311
312
313
314
315
316
if (!hog_load_entries(name, forWriting, info))
goto HOG_openArchive_failed;
strcpy(info->filename, name);
info->last_mod_time = modtime;
326
327
allocator.Free(info->entries);
allocator.Free(info);
334
static void HOG_enumerateFiles(dvoid *opaque, const char *dname,
335
336
int omitSymLinks, PHYSFS_EnumFilesCallback cb,
const char *origdir, void *callbackdata)
340
341
342
343
344
{
HOGinfo *info = (HOGinfo *) opaque;
HOGentry *entry = info->entries;
PHYSFS_uint32 max = info->entryCount;
PHYSFS_uint32 i;
352
static HOGentry *hog_find_entry(const HOGinfo *info, const char *name)
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
{
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);
372
rc = __PHYSFS_stricmpASCII(name, a[middle].name);
375
376
377
378
379
380
381
382
383
384
else if (rc > 0)
lo = middle + 1;
else
hi = middle - 1;
} /* while */
BAIL_MACRO(ERR_NO_SUCH_FILE, NULL);
} /* hog_find_entry */
385
static int HOG_exists(dvoid *opaque, const char *name)
387
return (hog_find_entry(((HOGinfo *) opaque), name) != NULL);
391
static int HOG_isDirectory(dvoid *opaque, const char *name, int *fileExists)
394
return 0; /* never directories in a groupfile. */
398
static int HOG_isSymLink(dvoid *opaque, const char *name, int *fileExists)
401
return 0; /* never symlinks in a groupfile. */
405
static PHYSFS_sint64 HOG_getLastModTime(dvoid *opaque,
406
407
408
const char *name,
int *fileExists)
{
410
411
412
413
PHYSFS_sint64 retval = -1;
*fileExists = (hog_find_entry(info, name) != NULL);
if (*fileExists) /* use time of HOG itself in the physical filesystem. */
420
static fvoid *HOG_openRead(dvoid *opaque, const char *fnm, int *fileExists)
423
424
425
426
427
428
429
HOGfileinfo *finfo;
HOGentry *entry;
entry = hog_find_entry(info, fnm);
*fileExists = (entry != NULL);
BAIL_IF_MACRO(entry == NULL, NULL, NULL);
430
finfo = (HOGfileinfo *) allocator.Malloc(sizeof (HOGfileinfo));
431
BAIL_IF_MACRO(finfo == NULL, ERR_OUT_OF_MEMORY, NULL);
432
433
434
435
436
finfo->handle = __PHYSFS_platformOpenRead(info->filename);
if ( (finfo->handle == NULL) ||
(!__PHYSFS_platformSeek(finfo->handle, entry->startPos)) )
{
439
440
441
442
} /* if */
finfo->curPos = 0;
finfo->entry = entry;
447
static fvoid *HOG_openWrite(dvoid *opaque, const char *name)
448
449
450
451
452
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* HOG_openWrite */
453
static fvoid *HOG_openAppend(dvoid *opaque, const char *name)
454
455
456
457
458
{
BAIL_MACRO(ERR_NOT_SUPPORTED, NULL);
} /* HOG_openAppend */
459
static int HOG_remove(dvoid *opaque, const char *name)
460
461
462
463
464
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* HOG_remove */
465
static int HOG_mkdir(dvoid *opaque, const char *name)
466
467
468
469
{
BAIL_MACRO(ERR_NOT_SUPPORTED, 0);
} /* HOG_mkdir */
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
static int HOG_stat(fvoid *opaque, const char *filename, int *exists,
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;
489
490
491
} /* HOG_stat */
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
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 */
523
524
HOG_fileClose, /* fileClose() method */
HOG_stat /* stat() method */
527
528
529
#endif /* defined PHYSFS_SUPPORTS_HOG */
/* end of hog.c ... */