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
26 * The PAK format uses a FOURCC concept for storing the magic ident within
27 * the header as a uint32_t.
29 #define PAK_FOURCC ((uint32_t)(('P' | ('A' << 8) | ('C' << 16) | ('K' << 24))))
32 uint32_t magic; /* "PACK" */
35 * Offset to first directory entry in PAK file. It's often
36 * best to store the directories at the end of the file opposed
37 * to the front, since it allows easy insertion without having
38 * to load the entire file into memory again.
45 * A directory, is sort of a "file entry". The concept of
46 * a directory in Quake world is a "file entry/record". This
47 * describes a file (with directories/nested ones too in it's
48 * file name). Hence it can be a file, file with directory, or
49 * file with directories.
58 * Used to get the next token from a string, where the
59 * strings themselfs are seperated by chracters from
60 * `sep`. This is essentially strsep.
62 static char *pak_tree_sep(char **str, const char *sep) {
69 if (*(end = beg + strcspn(beg, sep)))
70 * end++ = '\0'; /* null terminate */
79 * When given a string like "a/b/c/d/e/file"
80 * this function will handle the creation of
81 * the directory structure, included nested
84 static void pak_tree_build(const char *entry) {
93 pathsplit = (char *)mem_a(56);
94 directory = (char *)mem_a(56);
96 memset(pathsplit, 0, 56);
97 memset(directory, 0, 56);
99 strncpy(directory, entry, 56);
100 for (itr = 0; (token = pak_tree_sep(&directory, "/")) != NULL; itr++) {
101 elements[itr] = token;
104 for (jtr = 0; jtr < itr - 1; jtr++) {
105 strcat(pathsplit, elements[jtr]);
106 strcat(pathsplit, "/");
108 if (fs_dir_make(pathsplit)) {
112 /* TODO: undo on fail */
123 pak_directory_t *directories;
129 static pak_file_t *pak_open_read(const char *file) {
133 if (!(pak = (pak_file_t*)mem_a(sizeof(pak_file_t))))
136 if (!(pak->handle = fs_file_open(file, "rb"))) {
141 pak->directories = NULL;
142 pak->insert = false; /* read doesn't allow insert */
144 memset (&pak->header, 0, sizeof(pak_header_t));
145 fs_file_read (&pak->header, sizeof(pak_header_t), 1, pak->handle);
146 util_endianswap(&pak->header, 1, sizeof(pak_header_t));
149 * Every PAK file has "PACK" stored as FOURCC data in the
150 * header. If this data cannot compare (as checked here), it's
151 * probably not a PAK file.
153 if (pak->header.magic != PAK_FOURCC) {
154 fs_file_close(pak->handle);
160 * Time to read in the directory handles and prepare the directories
161 * vector. We're going to be reading some the file inwards soon.
163 fs_file_seek(pak->handle, pak->header.diroff, SEEK_SET);
166 * Read in all directories from the PAK file. These are considered
167 * to be the "file entries".
169 for (itr = 0; itr < pak->header.dirlen / 64; itr++) {
171 fs_file_read (&dir, sizeof(pak_directory_t), 1, pak->handle);
172 util_endianswap(&dir, 1, sizeof(pak_directory_t));
174 vec_push(pak->directories, dir);
179 static pak_file_t *pak_open_write(const char *file) {
182 if (!(pak = (pak_file_t*)mem_a(sizeof(pak_file_t))))
186 * Generate the required directory structure / tree for
187 * writing this PAK file too.
189 pak_tree_build(file);
191 if (!(pak->handle = fs_file_open(file, "wb"))) {
193 * The directory tree that was created, needs to be
194 * removed entierly if we failed to open a file.
196 /* TODO backup directory clean */
202 memset(&(pak->header), 0, sizeof(pak_header_t));
205 * We're in "insert" mode, we need to do things like header
206 * "patching" and writing the directories at the end of the
210 pak->header.magic = PAK_FOURCC;
212 /* on BE systems we need to swap the byte order of the FOURCC */
213 util_endianswap(&pak->header.magic, 1, sizeof(uint32_t));
216 * We need to write out the header since files will be wrote out to
217 * this even with directory entries, and that not wrote. The header
218 * will need to be patched in later with a file_seek, and overwrite,
219 * we could use offsets and other trickery. This is just easier.
221 fs_file_write(&(pak->header), sizeof(pak_header_t), 1, pak->handle);
226 pak_file_t *pak_open(const char *file, const char *mode) {
231 case 'r': return pak_open_read (file);
232 case 'w': return pak_open_write(file);
238 bool pak_exists(pak_file_t *pak, const char *file, pak_directory_t **dir) {
244 for (itr = 0; itr < vec_size(pak->directories); itr++) {
245 if (!strcmp(pak->directories[itr].name, file)) {
247 * Store back a pointer to the directory that matches
248 * the request if requested (NULL is not allowed).
251 *dir = &(pak->directories[itr]);
261 * Extraction abilities. These work as you expect them to.
263 bool pak_extract_one(pak_file_t *pak, const char *file) {
264 pak_directory_t *dir = NULL;
265 unsigned char *dat = NULL;
268 if (!pak_exists(pak, file, &dir)) {
272 if (!(dat = (unsigned char *)mem_a(dir->len))) {
277 * Generate the directory structure / tree that will be required
278 * to store the extracted file.
280 pak_tree_build(file);
283 * Now create the file, if this operation fails. Then abort
284 * It shouldn't fail though.
286 if (!(out = fs_file_open(file, "wb"))) {
293 fs_file_seek (pak->handle, dir->pos, SEEK_SET);
294 fs_file_read (dat, 1, dir->len, pak->handle);
297 fs_file_write(dat, 1, dir->len, out);
308 bool pak_extract_all(pak_file_t *pak, const char *dir) {
311 if (!fs_dir_make(dir))
314 if (fs_dir_change(dir))
317 for (itr = 0; itr < vec_size(pak->directories); itr++) {
318 if (!pak_extract_one(pak, pak->directories[itr].name))
326 * Insertion functions (the opposite of extraction). Yes for generating
329 bool pak_insert_one(pak_file_t *pak, const char *file) {
335 * We don't allow insertion on files that already exist within the
336 * pak file. Weird shit can happen if we allow that ;). We also
337 * don't allow insertion if the pak isn't opened in write mode.
339 if (!pak || !file || !pak->insert || pak_exists(pak, file, NULL))
342 if (!(fp = fs_file_open(file, "rb")))
346 * Calculate the total file length, since it will be wrote to
347 * the directory entry, and the actual contents of the file
348 * to the PAK file itself.
350 fs_file_seek(fp, 0, SEEK_END);
351 dir.len = fs_file_tell(fp);
352 fs_file_seek(fp, 0, SEEK_SET);
354 dir.pos = fs_file_tell(pak->handle);
357 * We're limited to 56 bytes for a file name string, that INCLUDES
358 * the directory and '/' seperators.
360 if (strlen(file) >= 56) {
365 strcpy(dir.name, file);
368 * Allocate some memory for loading in the data that will be
369 * redirected into the PAK file.
371 if (!(dat = (unsigned char *)mem_a(dir.len))) {
376 fs_file_read (dat, dir.len, 1, fp);
378 fs_file_write(dat, dir.len, 1, pak->handle);
381 * Now add the directory to the directories vector, so pak_close
382 * can actually write it.
384 vec_push(pak->directories, dir);
390 * Like pak_insert_one, except this collects files in all directories
391 * from a root directory, and inserts them all.
393 bool pak_insert_all(pak_file_t *pak, const char *dir) {
400 if (!(dp = fs_dir_open(dir)))
403 while ((dirp = fs_dir_read(dp))) {
404 if (!(pak_insert_one(pak, dirp->d_name))) {
414 bool pak_close(pak_file_t *pak) {
421 * In insert mode we need to patch the header, and write
422 * our directory entries at the end of the file.
425 pak->header.dirlen = vec_size(pak->directories) * 64;
426 pak->header.diroff = ftell(pak->handle);
429 fs_file_seek (pak->handle, 0, SEEK_SET);
430 fs_file_write(&(pak->header), sizeof(pak_header_t), 1, pak->handle);
432 /* write directories */
433 fs_file_seek (pak->handle, pak->header.diroff, SEEK_SET);
435 for (itr = 0; itr < vec_size(pak->directories); itr++) {
436 fs_file_write(&(pak->directories[itr]), sizeof(pak_directory_t), 1, pak->handle);
440 vec_free (pak->directories);
441 fs_file_close(pak->handle);
448 * Fancy GCC-like LONG parsing allows things like --opt=param with
449 * assignment operator. This is used for redirecting stdout/stderr
450 * console to specific files of your choice.
452 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
454 char **argv = *argv_;
456 size_t len = strlen(optname);
458 if (strncmp(argv[0]+ds, optname, len))
461 /* it's --optname, check how the parameter is supplied */
462 if (argv[0][ds+len] == '=') {
463 *out = argv[0]+ds+len+1;
467 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
470 /* using --opt param */
477 int main(int argc, char **argv) {
479 char *redirout = (char*)stdout;
480 char *redirerr = (char*)stderr;
481 char *directory = NULL;
484 pak_file_t *pak = NULL;
490 * Command line option parsing commences now We only need to support
491 * a few things in the test suite.
497 if (argv[0][0] == '-') {
498 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
500 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
502 if (parsecmd("directory", &argc, &argv, &directory, 1, false))
504 if (parsecmd("file", &argc, &argv, &file, 1, false))
507 con_change(redirout, redirerr);
509 switch (argv[0][1]) {
510 case 'e': extract = true; continue;
511 case 'c': extract = false; continue;
514 if (!strcmp(argv[0]+1, "debug")) {
515 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
518 if (!strcmp(argv[0]+1, "memchk")) {
519 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
522 if (!strcmp(argv[0]+1, "nocolor")) {
528 vec_push(files, argv[0]);
530 con_change(redirout, redirerr);
534 con_err("-file must be specified for output/input PAK file\n");
540 if (!(pak = pak_open(file, "r"))) {
541 con_err("failed to open PAK file %s\n", file);
546 if (!pak_extract_all(pak, (directory) ? directory : "./")) {
547 con_err("failed to extract PAK %s (files may be missing)\n", file);
560 if (!(pak = pak_open(file, "w"))) {
561 con_err("failed to open PAK %s for writing\n", file);
566 if (directory && !fs_dir_change(directory)) {
567 con_err("failed to change directory %s\n", directory);
573 for (iter = 0; iter < vec_size(files); iter++) {
574 if (!(pak_insert_one(pak, files[iter]))) {
575 con_err("failed inserting %s for PAK %s\n", files[iter], file);