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
28 * The PAK format uses a FOURCC concept for storing the magic ident within
29 * the header as a uint32_t.
31 #define PAK_FOURCC ((uint32_t)(('P' | ('A' << 8) | ('C' << 16) | ('K' << 24))))
34 uint32_t magic; /* "PACK" */
37 * Offset to first directory entry in PAK file. It's often
38 * best to store the directories at the end of the file opposed
39 * to the front, since it allows easy insertion without having
40 * to load the entire file into memory again.
47 * A directory, is sort of a "file entry". The concept of
48 * a directory in Quake world is a "file entry/record". This
49 * describes a file (with directories/nested ones too in it's
50 * file name). Hence it can be a file, file with directory, or
51 * file with directories.
60 * Used to get the next token from a string, where the
61 * strings themselfs are seperated by chracters from
62 * `sep`. This is essentially strsep.
64 static char *pak_tree_sep(char **str, const char *sep) {
71 if (*(end = beg + strcspn(beg, sep)))
72 * end++ = '\0'; /* null terminate */
81 * When given a string like "a/b/c/d/e/file"
82 * this function will handle the creation of
83 * the directory structure, included nested
86 static void pak_tree_build(const char *entry) {
95 pathsplit = (char *)mem_a(56);
96 directory = (char *)mem_a(56);
98 memset(pathsplit, 0, 56);
99 memset(directory, 0, 56);
101 strncpy(directory, entry, 56);
102 for (itr = 0; (token = pak_tree_sep(&directory, "/")) != NULL; itr++) {
103 elements[itr] = token;
106 for (jtr = 0; jtr < itr - 1; jtr++) {
107 strcat(pathsplit, elements[jtr]);
108 strcat(pathsplit, "/");
110 if (fs_dir_make(pathsplit)) {
114 /* TODO: undo on fail */
125 pak_directory_t *directories;
131 static pak_file_t *pak_open_read(const char *file) {
135 if (!(pak = (pak_file_t*)mem_a(sizeof(pak_file_t))))
138 if (!(pak->handle = fs_file_open(file, "rb"))) {
143 pak->directories = NULL;
144 pak->insert = false; /* read doesn't allow insert */
146 memset (&pak->header, 0, sizeof(pak_header_t));
147 fs_file_read (&pak->header, sizeof(pak_header_t), 1, pak->handle);
148 util_endianswap(&pak->header, 1, sizeof(pak_header_t));
151 * Every PAK file has "PACK" stored as FOURCC data in the
152 * header. If this data cannot compare (as checked here), it's
153 * probably not a PAK file.
155 if (pak->header.magic != PAK_FOURCC) {
156 fs_file_close(pak->handle);
162 * Time to read in the directory handles and prepare the directories
163 * vector. We're going to be reading some the file inwards soon.
165 fs_file_seek(pak->handle, pak->header.diroff, SEEK_SET);
168 * Read in all directories from the PAK file. These are considered
169 * to be the "file entries".
171 for (itr = 0; itr < pak->header.dirlen / 64; itr++) {
173 fs_file_read (&dir, sizeof(pak_directory_t), 1, pak->handle);
174 util_endianswap(&dir, 1, sizeof(pak_directory_t));
176 vec_push(pak->directories, dir);
181 static pak_file_t *pak_open_write(const char *file) {
184 if (!(pak = (pak_file_t*)mem_a(sizeof(pak_file_t))))
188 * Generate the required directory structure / tree for
189 * writing this PAK file too.
191 pak_tree_build(file);
193 if (!(pak->handle = fs_file_open(file, "wb"))) {
195 * The directory tree that was created, needs to be
196 * removed entierly if we failed to open a file.
198 /* TODO backup directory clean */
203 memset(&(pak->header), 0, sizeof(pak_header_t));
206 * We're in "insert" mode, we need to do things like header
207 * "patching" and writing the directories at the end of the
211 pak->header.magic = PAK_FOURCC;
214 * We need to write out the header since files will be wrote out to
215 * this even with directory entries, and that not wrote. The header
216 * will need to be patched in later with a file_seek, and overwrite,
217 * we could use offsets and other trickery. This is just easier.
219 fs_file_write(&(pak->header), sizeof(pak_header_t), 1, pak->handle);
224 pak_file_t *pak_open(const char *file, const char *mode) {
229 case 'r': return pak_open_read (file);
230 case 'w': return pak_open_write(file);
236 bool pak_exists(pak_file_t *pak, const char *file, pak_directory_t **dir) {
242 for (itr = 0; itr < vec_size(pak->directories); itr++) {
243 if (!strcmp(pak->directories[itr].name, file)) {
245 * Store back a pointer to the directory that matches
246 * the request if requested (NULL is not allowed).
249 *dir = &(pak->directories[itr]);
259 * Extraction abilities. These work as you expect them to.
261 bool pak_extract_one(pak_file_t *pak, const char *file) {
262 pak_directory_t *dir = NULL;
263 unsigned char *dat = NULL;
266 if (!pak_exists(pak, file, &dir)) {
270 if (!(dat = (unsigned char *)mem_a(dir->len))) {
275 * Generate the directory structure / tree that will be required
276 * to store the extracted file.
278 pak_tree_build(file);
281 * Now create the file, if this operation fails. Then abort
282 * It shouldn't fail though.
284 if (!(out = fs_file_open(file, "wb"))) {
291 fs_file_seek (pak->handle, dir->pos, SEEK_SET);
292 fs_file_read (dat, 1, dir->len, pak->handle);
295 fs_file_write(dat, 1, dir->len, out);
306 bool pak_extract_all(pak_file_t *pak, const char *dir) {
309 if (!fs_dir_make(dir))
312 if (fs_dir_change(dir))
315 for (itr = 0; itr < vec_size(pak->directories); itr++) {
316 if (!pak_extract_one(pak, pak->directories[itr].name))
324 * Insertion functions (the opposite of extraction). Yes for generating
327 bool pak_insert_one(pak_file_t *pak, const char *file) {
333 * We don't allow insertion on files that already exist within the
334 * pak file. Weird shit can happen if we allow that ;). We also
335 * don't allow insertion if the pak isn't opened in write mode.
337 if (!pak || !file || !pak->insert || pak_exists(pak, file, NULL))
340 if (!(fp = fs_file_open(file, "rb")))
344 * Calculate the total file length, since it will be wrote to
345 * the directory entry, and the actual contents of the file
346 * to the PAK file itself.
348 fs_file_seek(fp, 0, SEEK_END);
349 dir.len = fs_file_tell(fp);
350 fs_file_seek(fp, 0, SEEK_SET);
352 dir.pos = fs_file_tell(pak->handle);
355 * We're limited to 56 bytes for a file name string, that INCLUDES
356 * the directory and '/' seperators.
358 if (strlen(file) >= 56) {
363 strcpy(dir.name, file);
366 * Allocate some memory for loading in the data that will be
367 * redirected into the PAK file.
369 if (!(dat = (unsigned char *)mem_a(dir.len))) {
374 fs_file_read (dat, dir.len, 1, fp);
376 fs_file_write(dat, dir.len, 1, pak->handle);
379 * Now add the directory to the directories vector, so pak_close
380 * can actually write it.
382 vec_push(pak->directories, dir);
388 * Like pak_insert_one, except this collects files in all directories
389 * from a root directory, and inserts them all.
391 bool pak_insert_all(pak_file_t *pak, const char *dir) {
398 if (!(dp = fs_dir_open(dir)))
401 while ((dirp = fs_dir_read(dp))) {
402 if (!(pak_insert_one(pak, dirp->d_name))) {
412 bool pak_close(pak_file_t *pak) {
419 * In insert mode we need to patch the header, and write
420 * our directory entries at the end of the file.
423 pak->header.dirlen = vec_size(pak->directories) * 64;
424 pak->header.diroff = ftell(pak->handle);
427 fs_file_seek (pak->handle, 0, SEEK_SET);
428 fs_file_write(&(pak->header), sizeof(pak_header_t), 1, pak->handle);
430 /* write directories */
431 fs_file_seek (pak->handle, pak->header.diroff, SEEK_SET);
433 for (itr = 0; itr < vec_size(pak->directories); itr++) {
434 fs_file_write(&(pak->directories[itr]), sizeof(pak_directory_t), 1, pak->handle);
438 vec_free (pak->directories);
439 fs_file_close(pak->handle);
446 * Fancy GCC-like LONG parsing allows things like --opt=param with
447 * assignment operator. This is used for redirecting stdout/stderr
448 * console to specific files of your choice.
450 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
452 char **argv = *argv_;
454 size_t len = strlen(optname);
456 if (strncmp(argv[0]+ds, optname, len))
459 /* it's --optname, check how the parameter is supplied */
460 if (argv[0][ds+len] == '=') {
461 *out = argv[0]+ds+len+1;
465 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
468 /* using --opt param */
475 int main(int argc, char **argv) {
477 char *redirout = (char*)stdout;
478 char *redirerr = (char*)stderr;
479 char *directory = NULL;
482 pak_file_t *pak = NULL;
488 * Command line option parsing commences now We only need to support
489 * a few things in the test suite.
495 if (argv[0][0] == '-') {
496 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
498 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
500 if (parsecmd("directory", &argc, &argv, &directory, 1, false))
502 if (parsecmd("file", &argc, &argv, &file, 1, false))
505 con_change(redirout, redirerr);
507 switch (argv[0][1]) {
508 case 'e': extract = true; continue;
509 case 'c': extract = false; continue;
512 if (!strcmp(argv[0]+1, "debug")) {
513 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
516 if (!strcmp(argv[0]+1, "memchk")) {
517 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
520 if (!strcmp(argv[0]+1, "nocolor")) {
526 vec_push(files, argv[0]);
528 con_change(redirout, redirerr);
532 con_err("-file must be specified for output/input PAK file\n");
537 if (!(pak = pak_open(file, "r"))) {
538 con_err("failed to open PAK file %s\n", file);
542 if (!pak_extract_all(pak, (directory) ? directory : "./")) {
543 con_err("failed to extract PAK %s (files may be missing)\n", file);
556 if (!(pak = pak_open(file, "w"))) {
557 con_err("failed to open PAK %s for writing\n", file);
561 if (directory && !fs_dir_change(directory)) {
562 con_err("failed to change directory %s\n", directory);
567 for (iter = 0; iter < vec_size(files); iter++) {
568 if (!(pak_insert_one(pak, files[iter]))) {
569 con_err("failed inserting %s for PAK %s\n", files[iter], file);