5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
6 * this software and associated documentation files (the "Software"), to deal in
7 * the Software without restriction, including without limitation the rights to
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is furnished to do
10 * so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in all
13 * copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 * The PAK format uses a FOURCC concept for storing the magic ident within
31 * the header as a uint32_t.
33 #define PAK_FOURCC ((uint32_t)(((uint8_t)'P'|((uint8_t)'A'<<8)|((uint8_t)'C'<<16)|((uint8_t)'K'<<24))))
36 uint32_t magic; /* "PACK" */
39 * Offset to first directory entry in PAK file. It's often
40 * best to store the directories at the end of the file opposed
41 * to the front, since it allows easy insertion without having
42 * to load the entire file into memory again.
49 * A directory, is sort of a "file entry". The concept of
50 * a directory in Quake world is a "file entry/record". This
51 * describes a file (with directories/nested ones too in it's
52 * file name). Hence it can be a file, file with directory, or
53 * file with directories.
62 * Used to get the next token from a string, where the
63 * strings themselfs are seperated by chracters from
64 * `sep`. This is essentially strsep.
66 static char *pak_tree_sep(char **str, const char *sep) {
73 if (*(end = beg + strcspn(beg, sep)))
74 * end++ = '\0'; /* null terminate */
83 * When given a string like "a/b/c/d/e/file"
84 * this function will handle the creation of
85 * the directory structure, included nested
88 static void pak_tree_build(const char *entry) {
97 pathsplit = (char *)mem_a(56);
98 directory = (char *)mem_a(56);
100 memset(pathsplit, 0, 56);
102 platform_strncpy(directory, entry, 56);
103 for (itr = 0; (token = pak_tree_sep(&directory, "/")) != NULL; itr++) {
104 elements[itr] = token;
107 for (jtr = 0; jtr < itr - 1; jtr++) {
108 platform_strcat(pathsplit, elements[jtr]);
109 platform_strcat(pathsplit, "/");
111 if (fs_dir_make(pathsplit)) {
115 /* TODO: undo on fail */
126 pak_directory_t *directories;
132 static pak_file_t *pak_open_read(const char *file) {
136 if (!(pak = (pak_file_t*)mem_a(sizeof(pak_file_t))))
139 if (!(pak->handle = fs_file_open(file, "rb"))) {
144 pak->directories = NULL;
145 pak->insert = false; /* read doesn't allow insert */
147 memset (&pak->header, 0, sizeof(pak_header_t));
148 fs_file_read (&pak->header, sizeof(pak_header_t), 1, pak->handle);
149 util_endianswap(&pak->header, 1, sizeof(pak_header_t));
152 * Every PAK file has "PACK" stored as FOURCC data in the
153 * header. If this data cannot compare (as checked here), it's
154 * probably not a PAK file.
156 if (pak->header.magic != PAK_FOURCC) {
157 fs_file_close(pak->handle);
163 * Time to read in the directory handles and prepare the directories
164 * vector. We're going to be reading some the file inwards soon.
166 fs_file_seek(pak->handle, pak->header.diroff, SEEK_SET);
169 * Read in all directories from the PAK file. These are considered
170 * to be the "file entries".
172 for (itr = 0; itr < pak->header.dirlen / 64; itr++) {
174 fs_file_read (&dir, sizeof(pak_directory_t), 1, pak->handle);
175 util_endianswap(&dir, 1, sizeof(pak_directory_t));
177 vec_push(pak->directories, dir);
182 static pak_file_t *pak_open_write(const char *file) {
185 if (!(pak = (pak_file_t*)mem_a(sizeof(pak_file_t))))
189 * Generate the required directory structure / tree for
190 * writing this PAK file too.
192 pak_tree_build(file);
194 if (!(pak->handle = fs_file_open(file, "wb"))) {
196 * The directory tree that was created, needs to be
197 * removed entierly if we failed to open a file.
199 /* TODO backup directory clean */
205 memset(&(pak->header), 0, sizeof(pak_header_t));
208 * We're in "insert" mode, we need to do things like header
209 * "patching" and writing the directories at the end of the
213 pak->header.magic = PAK_FOURCC;
215 /* on BE systems we need to swap the byte order of the FOURCC */
216 util_endianswap(&pak->header.magic, 1, sizeof(uint32_t));
219 * We need to write out the header since files will be wrote out to
220 * this even with directory entries, and that not wrote. The header
221 * will need to be patched in later with a file_seek, and overwrite,
222 * we could use offsets and other trickery. This is just easier.
224 fs_file_write(&(pak->header), sizeof(pak_header_t), 1, pak->handle);
229 static pak_file_t *pak_open(const char *file, const char *mode) {
234 case 'r': return pak_open_read (file);
235 case 'w': return pak_open_write(file);
241 static bool pak_exists(pak_file_t *pak, const char *file, pak_directory_t **dir) {
247 for (itr = 0; itr < vec_size(pak->directories); itr++) {
248 if (!strcmp(pak->directories[itr].name, file)) {
250 * Store back a pointer to the directory that matches
251 * the request if requested (NULL is not allowed).
254 *dir = &(pak->directories[itr]);
264 * Extraction abilities. These work as you expect them to.
266 static bool pak_extract_one(pak_file_t *pak, const char *file, const char *outdir) {
267 pak_directory_t *dir = NULL;
268 unsigned char *dat = NULL;
272 if (!pak_exists(pak, file, &dir)) {
276 if (!(dat = (unsigned char *)mem_a(dir->len)))
280 * Generate the directory structure / tree that will be required
281 * to store the extracted file.
283 pak_tree_build(file);
285 /* TODO portable path seperators */
286 util_asprintf(&local, "%s/%s", outdir, file);
289 * Now create the file, if this operation fails. Then abort
290 * It shouldn't fail though.
292 if (!(out = fs_file_open(local, "wb")))
295 /* free memory for directory string */
299 if (fs_file_seek (pak->handle, dir->pos, SEEK_SET) != 0)
302 fs_file_read (dat, 1, dir->len, pak->handle);
303 fs_file_write(dat, 1, dir->len, out);
311 if (out) fs_file_close(out);
315 static bool pak_extract_all(pak_file_t *pak, const char *dir) {
318 if (!fs_dir_make(dir))
321 for (itr = 0; itr < vec_size(pak->directories); itr++) {
322 if (!pak_extract_one(pak, pak->directories[itr].name, dir))
330 * Insertion functions (the opposite of extraction). Yes for generating
333 static bool pak_insert_one(pak_file_t *pak, const char *file) {
340 * We don't allow insertion on files that already exist within the
341 * pak file. Weird shit can happen if we allow that ;). We also
342 * don't allow insertion if the pak isn't opened in write mode.
344 if (!pak || !file || !pak->insert || pak_exists(pak, file, NULL))
347 if (!(fp = fs_file_open(file, "rb")))
351 * Calculate the total file length, since it will be wrote to
352 * the directory entry, and the actual contents of the file
353 * to the PAK file itself.
355 if (fs_file_seek(fp, 0, SEEK_END) != 0 || ((len = fs_file_tell(fp)) < 0))
357 if (fs_file_seek(fp, 0, SEEK_SET) != 0)
361 dir.pos = fs_file_tell(pak->handle);
364 * We're limited to 56 bytes for a file name string, that INCLUDES
365 * the directory and '/' seperators.
367 if (strlen(file) >= 56)
370 platform_strncpy(dir.name, file, strlen(file));
373 * Allocate some memory for loading in the data that will be
374 * redirected into the PAK file.
376 if (!(dat = (unsigned char *)mem_a(dir.len)))
379 fs_file_read (dat, dir.len, 1, fp);
381 fs_file_write(dat, dir.len, 1, pak->handle);
384 * Now add the directory to the directories vector, so pak_close
385 * can actually write it.
387 vec_push(pak->directories, dir);
397 * Like pak_insert_one, except this collects files in all directories
398 * from a root directory, and inserts them all.
401 static bool pak_insert_all(pak_file_t *pak, const char *dir) {
408 if (!(dp = fs_dir_open(dir)))
411 while ((dirp = fs_dir_read(dp))) {
412 if (!(pak_insert_one(pak, dirp->d_name))) {
421 #endif /*!if 0 renable when ready to use */
423 static bool pak_close(pak_file_t *pak) {
431 * In insert mode we need to patch the header, and write
432 * our directory entries at the end of the file.
435 if ((tell = fs_file_tell(pak->handle)) != 0)
438 pak->header.dirlen = vec_size(pak->directories) * 64;
439 pak->header.diroff = tell;
442 if (fs_file_seek (pak->handle, 0, SEEK_SET) != 0)
445 fs_file_write(&(pak->header), sizeof(pak_header_t), 1, pak->handle);
447 /* write directories */
448 if (fs_file_seek (pak->handle, pak->header.diroff, SEEK_SET) != 0)
451 for (itr = 0; itr < vec_size(pak->directories); itr++) {
452 fs_file_write(&(pak->directories[itr]), sizeof(pak_directory_t), 1, pak->handle);
456 vec_free (pak->directories);
457 fs_file_close(pak->handle);
463 vec_free (pak->directories);
464 fs_file_close(pak->handle);
471 * Fancy GCC-like LONG parsing allows things like --opt=param with
472 * assignment operator. This is used for redirecting stdout/stderr
473 * console to specific files of your choice.
475 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
477 char **argv = *argv_;
479 size_t len = strlen(optname);
481 if (strncmp(argv[0]+ds, optname, len))
484 /* it's --optname, check how the parameter is supplied */
485 if (argv[0][ds+len] == '=') {
486 *out = argv[0]+ds+len+1;
490 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
493 /* using --opt param */
500 int main(int argc, char **argv) {
502 char *redirout = (char*)stdout;
503 char *redirerr = (char*)stderr;
506 pak_file_t *pak = NULL;
512 * Command line option parsing commences now We only need to support
513 * a few things in the test suite.
519 if (argv[0][0] == '-') {
520 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
522 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
524 if (parsecmd("file", &argc, &argv, &file, 1, false))
527 con_change(redirout, redirerr);
529 switch (argv[0][1]) {
530 case 'e': extract = true; continue;
531 case 'c': extract = false; continue;
534 if (!strcmp(argv[0]+1, "debug")) {
535 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
538 if (!strcmp(argv[0]+1, "memchk")) {
539 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
542 if (!strcmp(argv[0]+1, "nocolor")) {
548 vec_push(files, argv[0]);
550 con_change(redirout, redirerr);
554 con_err("-file must be specified for output/input PAK file\n");
560 if (!(pak = pak_open(file, "r"))) {
561 con_err("failed to open PAK file %s\n", file);
566 if (!pak_extract_all(pak, "./")) {
567 con_err("failed to extract PAK %s (files may be missing)\n", file);
581 if (!(pak = pak_open(file, "w"))) {
582 con_err("failed to open PAK %s for writing\n", file);
587 for (iter = 0; iter < vec_size(files); iter++) {
588 if (!(pak_insert_one(pak, files[iter]))) {
589 con_err("failed inserting %s for PAK %s\n", files[iter], file);