sm64pc/src/pc/fs/fs.c

#include <stdlib.h>
#include <stdio.h>
#include <stdbool.h>
#include <string.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <dirent.h>
#include <ctype.h>
#ifdef _WIN32
#include <direct.h>
#endif

#include "macros.h"
#include "../platform.h"
#include "fs.h"

char fs_gamedir[SYS_MAX_PATH] = "";
char fs_writepath[SYS_MAX_PATH] = "";

struct fs_dir_s {
    void *pack;
    const char *realpath;
    fs_packtype_t *packer;
    struct fs_dir_s *prev, *next;
};

extern fs_packtype_t fs_packtype_dir;
extern fs_packtype_t fs_packtype_zip;

static fs_packtype_t *fs_packers[] = {
    &fs_packtype_dir,
    &fs_packtype_zip,
};

static fs_dir_t *fs_searchpaths = NULL;

static inline fs_dir_t *fs_find_dir(const char *realpath) {
    for (fs_dir_t *dir = fs_searchpaths; dir; dir = dir->next)
        if (!sys_strcasecmp(realpath, dir->realpath))
            return dir;
    return NULL;
}

static int mount_cmp(const void *p1, const void *p2) {
    const char *s1 = *(const char **)p1;
    const char *s2 = *(const char **)p2;

    // check if one or both of these are basepacks
    const int plen = strlen(FS_BASEPACK_PREFIX);
    const bool is_base1 = !strncmp(s1, FS_BASEPACK_PREFIX, plen);
    const bool is_base2 = !strncmp(s2, FS_BASEPACK_PREFIX, plen);

    // if both are basepacks, compare the postfixes only
    if (is_base1 && is_base2) return strcmp(s1 + plen, s2 + plen);
    // if only one is a basepack, it goes first
    if (is_base1) return -1;
    if (is_base2) return 1;
    // otherwise strcmp order
    return strcmp(s1, s2);
}

static void scan_path_dir(const char *ropath, const char *dir) {
    char dirpath[SYS_MAX_PATH];
    snprintf(dirpath, sizeof(dirpath), "%s/%s", ropath, dir);

    if (!fs_sys_dir_exists(dirpath)) return;

    // since filename order in readdir() isn't guaranteed, collect paths and sort them in strcmp() order
    // (but with basepacks first)
    fs_pathlist_t plist = fs_sys_enumerate(dirpath, false);
    if (plist.paths) {
        qsort(plist.paths, plist.numpaths, sizeof(char *), mount_cmp);
        for (int i = 0; i < plist.numpaths; ++i)
            fs_mount(plist.paths[i]);
        fs_pathlist_free(&plist);
    }

    // mount the directory itself
    fs_mount(dirpath);
}

bool fs_init(const char **rodirs, const char *gamedir, const char *writepath) {
    char buf[SYS_MAX_PATH];

    // expand and remember the write path
    strncpy(fs_writepath, fs_convert_path(buf, sizeof(buf), writepath), sizeof(fs_writepath));
    fs_writepath[sizeof(fs_writepath)-1] = 0;
    printf("fs: writepath set to `%s`\n", fs_writepath);

    // remember the game directory name
    strncpy(fs_gamedir, gamedir, sizeof(fs_gamedir));
    fs_gamedir[sizeof(fs_gamedir)-1] = 0;
    printf("fs: gamedir set to `%s`\n", fs_gamedir);

    // first, scan all possible paths and mount all basedirs in them
    for (const char **p = rodirs; p && *p; ++p)
        scan_path_dir(fs_convert_path(buf, sizeof(buf), *p), FS_BASEDIR);
    scan_path_dir(fs_writepath, FS_BASEDIR);

    // then mount all the gamedirs in them, if the game dir isn't the same
    if (sys_strcasecmp(FS_BASEDIR, fs_gamedir)) {
        for (const char **p = rodirs; p && *p; ++p)
            scan_path_dir(fs_convert_path(buf, sizeof(buf), *p), fs_gamedir);
        scan_path_dir(fs_writepath, fs_gamedir);
    }

    // as a special case, mount writepath itself
    fs_mount(fs_writepath);

    return true;
}

bool fs_mount(const char *realpath) {
    if (fs_find_dir(realpath))
        return false; // already mounted

    const char *ext = sys_file_extension(realpath);
    void *pack = NULL;
    fs_packtype_t *packer = NULL;
    bool tried = false;
    for (unsigned int i = 0; i < sizeof(fs_packers) / sizeof(fs_packers[0]); ++i) {
        if (ext && sys_strcasecmp(ext, fs_packers[i]->extension))
            continue;
        tried = true;
        pack = fs_packers[i]->mount(realpath);
        if (pack) {
            packer = fs_packers[i];
            break;
        }
    }

    if (!pack || !packer) {
        if (tried)
            fprintf(stderr, "fs: could not mount '%s'\n", realpath);
        return false;
    }

    fs_dir_t *dir = calloc(1, sizeof(fs_dir_t));
    if (!dir) {
        packer->unmount(pack);
        return false;
    }

    dir->pack = pack;
    dir->realpath = sys_strdup(realpath);
    dir->packer = packer;
    dir->prev = NULL;
    dir->next = fs_searchpaths;
    if (fs_searchpaths)
        fs_searchpaths->prev = dir;
    fs_searchpaths = dir;

    printf("fs: mounting '%s'\n", realpath);

    return true;
}

bool fs_unmount(const char *realpath) {
    fs_dir_t *dir = fs_find_dir(realpath);
    if (dir) {
        dir->packer->unmount(dir->pack);
        free((void *)dir->realpath);
        if (dir->prev) dir->prev->next = dir->next;
        if (dir->next) dir->next->prev = dir->prev;
        if (dir == fs_searchpaths) fs_searchpaths = dir->next;
        free(dir);
        return true;
    }
    return false;
}

fs_walk_result_t fs_walk(const char *base, walk_fn_t walkfn, void *user, const bool recur) {
    bool found = false;
    for (fs_dir_t *dir = fs_searchpaths; dir; dir = dir->next) {
        fs_walk_result_t res = dir->packer->walk(dir->pack, base, walkfn, user, recur);
        if (res == FS_WALK_INTERRUPTED)
            return res;
        if (res != FS_WALK_NOTFOUND)
            found = true;
    }
    return found ? FS_WALK_SUCCESS : FS_WALK_NOTFOUND;
}

bool fs_is_file(const char *fname) {
    for (fs_dir_t *dir = fs_searchpaths; dir; dir = dir->next) {
        if (dir->packer->is_file(dir->pack, fname))
            return true;
    }
    return false;
}

bool fs_is_dir(const char *fname) {
    for (fs_dir_t *dir = fs_searchpaths; dir; dir = dir->next) {
        if (dir->packer->is_dir(dir->pack, fname))
            return true;
    }
    return false;
}

fs_file_t *fs_open(const char *vpath) {
    for (fs_dir_t *dir = fs_searchpaths; dir; dir = dir->next) {
        fs_file_t *f = dir->packer->open(dir->pack, vpath);
        if (f) {
            f->parent = dir;
            return f;
        }
    }
    return NULL;
}

void fs_close(fs_file_t *file) {
    if (!file) return;
    file->parent->packer->close(file->parent->pack, file);
}

int64_t fs_read(fs_file_t *file, void *buf, const uint64_t size) {
    if (!file) return -1;
    return file->parent->packer->read(file->parent->pack, file, buf, size);
}

bool fs_seek(fs_file_t *file, const int64_t ofs) {
    if (!file) return -1;
    return file->parent->packer->seek(file->parent->pack, file, ofs);
}

int64_t fs_tell(fs_file_t *file) {
    if (!file) return -1;
    return file->parent->packer->tell(file->parent->pack, file);
}

int64_t fs_size(fs_file_t *file) {
    if (!file) return -1;
    return file->parent->packer->size(file->parent->pack, file);
}

bool fs_eof(fs_file_t *file) {
    if (!file) return true;
    return file->parent->packer->eof(file->parent->pack, file);
}

struct matchdata_s {
    const char *prefix;
    size_t prefix_len;
    char *dst;
    size_t dst_len;
};

static bool match_walk(void *user, const char *path) {
    struct matchdata_s *data = (struct matchdata_s *)user;
    if (!strncmp(path, data->prefix, data->prefix_len)) {
        // found our lad, copy path to destination and terminate
        strncpy(data->dst, path, data->dst_len);
        data->dst[data->dst_len - 1] = 0;
        return false;
    }
    return true;
}

const char *fs_match(char *outname, const size_t outlen, const char *prefix) {
    struct matchdata_s data = {
        .prefix = prefix,
        .prefix_len = strlen(prefix),
        .dst = outname,
        .dst_len = outlen,
    };

    if (fs_walk("", match_walk, &data, true) == FS_WALK_INTERRUPTED)
        return outname;

    return NULL;
}

static bool enumerate_walk(void *user, const char *path) {
    fs_pathlist_t *data = (fs_pathlist_t *)user;

    if (data->listcap == data->numpaths) {
        data->listcap *= 2;
        char **newpaths = realloc(data->paths, data->listcap * sizeof(char *));
        if (!newpaths) return false;
        data->paths = newpaths;
    }

    data->paths[data->numpaths++] = sys_strdup(path);
    return true;
}

fs_pathlist_t fs_enumerate(const char *base, const bool recur) {
    char **paths = malloc(sizeof(char *) * 32);
    fs_pathlist_t pathlist = { paths, 0, 32 };

    if (!paths) return pathlist;

    if (fs_walk(base, enumerate_walk, &pathlist, recur) == FS_WALK_INTERRUPTED)
        fs_pathlist_free(&pathlist);

    return pathlist;
}

void fs_pathlist_free(fs_pathlist_t *pathlist) {
    if (!pathlist || !pathlist->paths) return;
    for (int i = 0; i < pathlist->numpaths; ++i)
        free(pathlist->paths[i]);
    free(pathlist->paths);
    pathlist->paths = NULL;
    pathlist->numpaths = 0;
}

const char *fs_readline(fs_file_t *file, char *dst, uint64_t size) {
    int64_t rx = 0;
    char chr, *p;

    // assume we got buffered input
    for (p = dst, size--; size > 0; size--) {
        if ((rx = fs_read(file, &chr, 1)) <= 0)
            break;
        *p++ = chr;
        if (chr == '\n')
            break;
    }

    *p = 0;
    if (p == dst || rx <= 0)
        return NULL;

    return p;
}

void *fs_load_file(const char *vpath, uint64_t *outsize) {
    fs_file_t *f = fs_open(vpath);
    if (!f) return NULL;

    int64_t size = fs_size(f);
    if (size <= 0) {
        fs_close(f);
        return NULL;
    }

    void *buf = malloc(size);
    if (!buf) {
        fs_close(f);
        return NULL;
    }

    int64_t rx = fs_read(f, buf, size);
    fs_close(f);

    if (rx < size) {
        free(buf);
        return NULL;
    }

    if (outsize) *outsize = size;
    return buf;
}

const char *fs_get_write_path(const char *vpath) {
    static char path[SYS_MAX_PATH];
    snprintf(path, sizeof(path), "%s/%s", fs_writepath, vpath);
    return path;
}

const char *fs_convert_path(char *buf, const size_t bufsiz, const char *path)  {
    // ! means "executable directory"
    if (path[0] == '!') {
        snprintf(buf, bufsiz, "%s%s", sys_exe_path(), path + 1);
    } else {
        strncpy(buf, path, bufsiz);
        buf[bufsiz-1] = 0;
    }

    // change all backslashes
    for (char *p = buf; *p; ++p)
        if (*p == '\\') *p = '/';

    return buf;
}

/* these operate on the real file system */

bool fs_sys_file_exists(const char *name) {
    struct stat st;
    return (stat(name, &st) == 0 && S_ISREG(st.st_mode));
}

bool fs_sys_dir_exists(const char *name) {
    struct stat st;
    return (stat(name, &st) == 0 && S_ISDIR(st.st_mode));
}

bool fs_sys_walk(const char *base, walk_fn_t walk, void *user, const bool recur) {
    char fullpath[SYS_MAX_PATH];
    DIR *dir;
    struct dirent *ent;

    if (!(dir = opendir(base))) {
        fprintf(stderr, "fs_dir_walk(): could not open `%s`\n", base);
        return false;
    }

    bool ret = true;

    while ((ent = readdir(dir)) != NULL) {
        if (ent->d_name[0] == 0 || ent->d_name[0] == '.') continue; // skip ./.. and hidden files
        snprintf(fullpath, sizeof(fullpath), "%s/%s", base, ent->d_name);
        if (fs_sys_dir_exists(fullpath)) {
            if (recur) {
                if (!fs_sys_walk(fullpath, walk, user, recur)) {
                    ret = false;
                    break;
                }
            }
        } else {
            if (!walk(user, fullpath)) {
                ret = false;
                break;
            }
        }
    }

    closedir(dir);
    return ret;
}

fs_pathlist_t fs_sys_enumerate(const char *base, const bool recur) {
    char **paths = malloc(sizeof(char *) * 32);
    fs_pathlist_t pathlist = { paths, 0, 32 };

    if (!paths) return pathlist;

    if (!fs_sys_walk(base, enumerate_walk, &pathlist, recur))
        fs_pathlist_free(&pathlist);

    return pathlist;
}

bool fs_sys_mkdir(const char *name) {
    #ifdef _WIN32
    return _mkdir(name) == 0;
    #else
    return mkdir(name, 0777) == 0;
    #endif
}