2 * Copyright (C) 2013, 2014
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
29 * The PAK format uses a FOURCC concept for storing the magic ident within
30 * the header as a uint32_t.
32 #define PAK_FOURCC ((uint32_t)(((uint8_t)'P'|((uint8_t)'A'<<8)|((uint8_t)'C'<<16)|((uint8_t)'K'<<24))))
35 uint32_t magic; /* "PACK" */
38 * Offset to first directory entry in PAK file. It's often
39 * best to store the directories at the end of the file opposed
40 * to the front, since it allows easy insertion without having
41 * to load the entire file into memory again.
48 * A directory, is sort of a "file entry". The concept of
49 * a directory in Quake world is a "file entry/record". This
50 * describes a file (with directories/nested ones too in it's
51 * file name). Hence it can be a file, file with directory, or
52 * file with directories.
61 * Used to get the next token from a string, where the
62 * strings themselfs are seperated by chracters from
63 * `sep`. This is essentially strsep.
65 static char *pak_tree_sep(char **str, const char *sep) {
72 if (*(end = beg + strcspn(beg, sep)))
73 * end++ = '\0'; /* null terminate */
82 * When given a string like "a/b/c/d/e/file"
83 * this function will handle the creation of
84 * the directory structure, included nested
87 static void pak_tree_build(const char *entry) {
96 pathsplit = (char *)mem_a(56);
97 directory = (char *)mem_a(56);
99 memset(pathsplit, 0, 56);
101 util_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 util_strcat(pathsplit, elements[jtr]);
108 util_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);
149 util_endianswap(&pak->header.magic, 1, sizeof(pak->header.magic));
150 util_endianswap(&pak->header.diroff, 1, sizeof(pak->header.diroff));
151 util_endianswap(&pak->header.dirlen, 1, sizeof(pak->header.dirlen));
154 * Every PAK file has "PACK" stored as FOURCC data in the
155 * header. If this data cannot compare (as checked here), it's
156 * probably not a PAK file.
158 if (pak->header.magic != PAK_FOURCC) {
159 fs_file_close(pak->handle);
165 * Time to read in the directory handles and prepare the directories
166 * vector. We're going to be reading some the file inwards soon.
168 fs_file_seek(pak->handle, pak->header.diroff, FS_FILE_SEEK_SET);
171 * Read in all directories from the PAK file. These are considered
172 * to be the "file entries".
174 for (itr = 0; itr < pak->header.dirlen / 64; itr++) {
176 fs_file_read (&dir, sizeof(pak_directory_t), 1, pak->handle);
178 /* Don't translate name - it's just an array of bytes. */
179 util_endianswap(&dir.pos, 1, sizeof(dir.pos));
180 util_endianswap(&dir.len, 1, sizeof(dir.len));
182 vec_push(pak->directories, dir);
187 static pak_file_t *pak_open_write(const char *file) {
190 if (!(pak = (pak_file_t*)mem_a(sizeof(pak_file_t))))
194 * Generate the required directory structure / tree for
195 * writing this PAK file too.
197 pak_tree_build(file);
199 if (!(pak->handle = fs_file_open(file, "wb"))) {
201 * The directory tree that was created, needs to be
202 * removed entierly if we failed to open a file.
204 /* TODO backup directory clean */
210 memset(&(pak->header), 0, sizeof(pak_header_t));
213 * We're in "insert" mode, we need to do things like header
214 * "patching" and writing the directories at the end of the
218 pak->header.magic = PAK_FOURCC;
220 /* on BE systems we need to swap the byte order of the FOURCC */
221 util_endianswap(&pak->header.magic, 1, sizeof(uint32_t));
224 * We need to write out the header since files will be wrote out to
225 * this even with directory entries, and that not wrote. The header
226 * will need to be patched in later with a file_seek, and overwrite,
227 * we could use offsets and other trickery. This is just easier.
229 fs_file_write(&(pak->header), sizeof(pak_header_t), 1, pak->handle);
234 static pak_file_t *pak_open(const char *file, const char *mode) {
239 case 'r': return pak_open_read (file);
240 case 'w': return pak_open_write(file);
246 static bool pak_exists(pak_file_t *pak, const char *file, pak_directory_t **dir) {
252 for (itr = 0; itr < vec_size(pak->directories); itr++) {
253 if (!strcmp(pak->directories[itr].name, file)) {
255 * Store back a pointer to the directory that matches
256 * the request if requested (NULL is not allowed).
259 *dir = &(pak->directories[itr]);
269 * Extraction abilities. These work as you expect them to.
271 static bool pak_extract_one(pak_file_t *pak, const char *file, const char *outdir) {
272 pak_directory_t *dir = NULL;
273 unsigned char *dat = NULL;
275 fs_file_t *out = NULL;
277 if (!pak_exists(pak, file, &dir)) {
281 if (!(dat = (unsigned char *)mem_a(dir->len)))
285 * Generate the directory structure / tree that will be required
286 * to store the extracted file.
288 pak_tree_build(file);
290 /* TODO portable path seperators */
291 util_asprintf(&local, "%s/%s", outdir, file);
294 * Now create the file, if this operation fails. Then abort
295 * It shouldn't fail though.
297 if (!(out = fs_file_open(local, "wb")))
300 /* free memory for directory string */
304 if (fs_file_seek (pak->handle, dir->pos, FS_FILE_SEEK_SET) != 0)
307 fs_file_read (dat, 1, dir->len, pak->handle);
308 fs_file_write(dat, 1, dir->len, out);
316 if (out) fs_file_close(out);
320 static bool pak_extract_all(pak_file_t *pak, const char *dir) {
323 if (!fs_dir_make(dir))
326 for (itr = 0; itr < vec_size(pak->directories); itr++) {
327 if (!pak_extract_one(pak, pak->directories[itr].name, dir))
335 * Insertion functions (the opposite of extraction). Yes for generating
338 static bool pak_insert_one(pak_file_t *pak, const char *file) {
345 * We don't allow insertion on files that already exist within the
346 * pak file. Weird shit can happen if we allow that ;). We also
347 * don't allow insertion if the pak isn't opened in write mode.
349 if (!pak || !file || !pak->insert || pak_exists(pak, file, NULL))
352 if (!(fp = fs_file_open(file, "rb")))
356 * Calculate the total file length, since it will be wrote to
357 * the directory entry, and the actual contents of the file
358 * to the PAK file itself.
360 if (fs_file_seek(fp, 0, FS_FILE_SEEK_END) != 0 || ((len = fs_file_tell(fp)) < 0))
362 if (fs_file_seek(fp, 0, FS_FILE_SEEK_SET) != 0)
366 dir.pos = fs_file_tell(pak->handle);
369 * We're limited to 56 bytes for a file name string, that INCLUDES
370 * the directory and '/' seperators.
372 if (strlen(file) >= 56)
375 util_strncpy(dir.name, file, strlen(file));
378 * Allocate some memory for loading in the data that will be
379 * redirected into the PAK file.
381 if (!(dat = (unsigned char *)mem_a(dir.len)))
384 fs_file_read (dat, dir.len, 1, fp);
386 fs_file_write(dat, dir.len, 1, pak->handle);
389 * Now add the directory to the directories vector, so pak_close
390 * can actually write it.
392 vec_push(pak->directories, dir);
402 * Like pak_insert_one, except this collects files in all directories
403 * from a root directory, and inserts them all.
406 static bool pak_insert_all(pak_file_t *pak, const char *dir) {
413 if (!(dp = fs_dir_open(dir)))
416 while ((dirp = fs_dir_read(dp))) {
417 if (!(pak_insert_one(pak, dirp->d_name))) {
426 #endif /*!if 0 renable when ready to use */
428 static bool pak_close(pak_file_t *pak) {
436 * In insert mode we need to patch the header, and write
437 * our directory entries at the end of the file.
440 if ((tell = fs_file_tell(pak->handle)) != 0)
443 pak->header.dirlen = vec_size(pak->directories) * 64;
444 pak->header.diroff = tell;
447 if (fs_file_seek (pak->handle, 0, FS_FILE_SEEK_SET) != 0)
450 fs_file_write(&(pak->header), sizeof(pak_header_t), 1, pak->handle);
452 /* write directories */
453 if (fs_file_seek (pak->handle, pak->header.diroff, FS_FILE_SEEK_SET) != 0)
456 for (itr = 0; itr < vec_size(pak->directories); itr++)
457 fs_file_write(&(pak->directories[itr]), sizeof(pak_directory_t), 1, pak->handle);
460 vec_free (pak->directories);
461 fs_file_close(pak->handle);
467 vec_free (pak->directories);
468 fs_file_close(pak->handle);
475 * Fancy GCC-like LONG parsing allows things like --opt=param with
476 * assignment operator. This is used for redirecting stdout/stderr
477 * console to specific files of your choice.
479 static bool parsecmd(const char *optname, int *argc_, char ***argv_, char **out, int ds, bool split) {
481 char **argv = *argv_;
483 size_t len = strlen(optname);
485 if (strncmp(argv[0]+ds, optname, len))
488 /* it's --optname, check how the parameter is supplied */
489 if (argv[0][ds+len] == '=') {
490 *out = argv[0]+ds+len+1;
494 if (!split || argc < ds) /* no parameter was provided, or only single-arg form accepted */
497 /* using --opt param */
505 int main(int argc, char **argv) {
507 char *redirout = (char*)stdout;
508 char *redirerr = (char*)stderr;
511 pak_file_t *pak = NULL;
517 * Command line option parsing commences now We only need to support
518 * a few things in the test suite.
524 if (argv[0][0] == '-') {
525 if (parsecmd("redirout", &argc, &argv, &redirout, 1, false))
527 if (parsecmd("redirerr", &argc, &argv, &redirerr, 1, false))
529 if (parsecmd("file", &argc, &argv, &file, 1, false))
532 con_change(redirout, redirerr);
534 switch (argv[0][1]) {
535 case 'e': extract = true; continue;
536 case 'c': extract = false; continue;
539 if (!strcmp(argv[0]+1, "debug")) {
540 OPTS_OPTION_BOOL(OPTION_DEBUG) = true;
543 if (!strcmp(argv[0]+1, "memchk")) {
544 OPTS_OPTION_BOOL(OPTION_MEMCHK) = true;
547 if (!strcmp(argv[0]+1, "nocolor")) {
553 vec_push(files, argv[0]);
555 con_change(redirout, redirerr);
559 con_err("-file must be specified for output/input PAK file\n");
565 if (!(pak = pak_open(file, "r"))) {
566 con_err("failed to open PAK file %s\n", file);
571 if (!pak_extract_all(pak, "./")) {
572 con_err("failed to extract PAK %s (files may be missing)\n", file);
586 if (!(pak = pak_open(file, "w"))) {
587 con_err("failed to open PAK %s for writing\n", file);
592 for (iter = 0; iter < vec_size(files); iter++) {
593 if (!(pak_insert_one(pak, files[iter]))) {
594 con_err("failed inserting %s for PAK %s\n", files[iter], file);