/* RetroArch - A frontend for libretro. * Copyright (C) 2010-2014 - Hans-Kristian Arntzen * Copyright (C) 2011-2014 - Daniel De Matteis * * RetroArch is free software: you can redistribute it and/or modify it under the terms * of the GNU General Public License as published by the Free Software Found- * ation, either version 3 of the License, or (at your option) any later version. * * RetroArch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR * PURPOSE. See the GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along with RetroArch. * If not, see . */ #include "file_path.h" #include #include "boolean.h" #include #include #include #include "compat/strl.h" #include "compat/posix_string.h" #include "miscellaneous.h" #ifdef __HAIKU__ #include #endif #if (defined(__CELLOS_LV2__) && !defined(__PSL1GHT__)) || defined(__QNX__) || defined(PSP) #include /* stat() is defined here */ #endif #if defined(__CELLOS_LV2__) #ifndef S_ISDIR #define S_ISDIR(x) (x & 0040000) #endif #endif #if defined(_WIN32) #ifdef _MSC_VER #define setmode _setmode #endif #include "msvc/msvc_compat.h" #ifdef _XBOX #include #define INVALID_FILE_ATTRIBUTES -1 #else #include #include #include #include #endif #else #include #include #include #include #endif #ifdef HAVE_7ZIP #include "decompress/7zip_support.h" #endif #ifdef HAVE_ZLIB #include "decompress/zip_support.h" #endif /* Dump to file. */ bool write_file(const char *path, const void *data, size_t size) { bool ret = false; FILE *file = fopen(path, "wb"); if (!file) return false; ret = fwrite(data, 1, size, file) == size; fclose(file); return ret; } bool write_empty_file(const char *path) { FILE *file = fopen(path, "w"); if (!file) return false; fclose(file); return true; } /* Generic compressed file loader. */ #ifdef HAVE_COMPRESSION long read_compressed_file(const char * path, void **buf) { //We split carchive path and relative path: char archive_path[PATH_MAX]; strlcpy(archive_path,path,sizeof(archive_path)); char* archive_found = strchr(archive_path,'#'); rarch_assert(archive_found != NULL); //We assure that there is something after the '#' symbol if (strlen(archive_found) <= 1) { /* * This error condition happens for example, when * path = /path/to/file.7z, or * path = /path/to/file.7z# */ RARCH_ERR("Could not extract image path and carchive path from " "path: %s.\n", path); return -1; } //We split the string in two, by putting a \0, where the hash was: *archive_found = '\0'; archive_found+=1; const char* file_ext = path_get_extension(archive_path); #ifdef HAVE_7ZIP if (strcasecmp(file_ext,"7z") == 0) { return read_7zip_file(archive_path,archive_found,buf); } #endif #ifdef HAVE_ZLIB if (strcasecmp(file_ext,"zip") == 0) { return read_zip_file(archive_path,archive_found,buf); } #endif return -1; } #endif static long read_generic_file(const char *path, void **buf) { long rc = 0, len = 0; void *rom_buf = NULL; FILE *file = fopen(path, "rb"); if (!file) goto error; fseek(file, 0, SEEK_END); len = ftell(file); rewind(file); rom_buf = malloc(len + 1); if (!rom_buf) { RARCH_ERR("Couldn't allocate memory.\n"); goto error; } if ((rc = fread(rom_buf, 1, len, file)) < len) RARCH_WARN("Didn't read whole file.\n"); *buf = rom_buf; /* Allow for easy reading of strings to be safe. * Will only work with sane character formatting (Unix). */ ((char*)rom_buf)[len] = '\0'; fclose(file); return rc; error: if (file) fclose(file); free(rom_buf); *buf = NULL; return -1; } /* Generic file loader. */ long read_file(const char *path, void **buf) { /* Here we check, whether the file, we are about to read is * inside an archive, or not. * * We determine, whether a file is inside a compressed archive, * by checking for the # inside the URL. * * For example: fullpath: /home/user/game.7z/mygame.rom * carchive_path: /home/user/game.7z * */ #ifdef HAVE_COMPRESSION if (path_contains_compressed_file(path)) return read_compressed_file(path,buf); #endif return read_generic_file(path,buf); } /* Reads file content as one string. */ bool read_file_string(const char *path, char **buf) { *buf = NULL; FILE *file = fopen(path, "r"); long len = 0; char *ptr = NULL; if (!file) goto error; /* ftell with "r" can be troublesome ... * Haven't run into issues yet though. */ fseek(file, 0, SEEK_END); /* Takes account of being able to read * in EOF and '\0' at end. */ len = ftell(file) + 2; rewind(file); *buf = (char*)calloc(len, sizeof(char)); if (!*buf) goto error; ptr = *buf; while (ptr && !feof(file)) { size_t bufsize = (size_t)(((ptrdiff_t)*buf + (ptrdiff_t)len) - (ptrdiff_t)ptr); fgets(ptr, bufsize, file); ptr += strlen(ptr); } ptr = strchr(ptr, EOF); if (ptr) *ptr = '\0'; fclose(file); return true; error: if (file) fclose(file); if (*buf) free(*buf); return false; } const char *path_get_extension(const char *path) { const char *ext = strrchr(path_basename(path), '.'); if (ext) return ext + 1; return ""; } char *path_remove_extension(char *path) { char *last = (char*)strrchr(path_basename(path), '.'); if (*last) *last = '\0'; return last; } static int qstrcmp_plain(const void *a_, const void *b_) { const struct string_list_elem *a = (const struct string_list_elem*)a_; const struct string_list_elem *b = (const struct string_list_elem*)b_; return strcasecmp(a->data, b->data); } static int qstrcmp_dir(const void *a_, const void *b_) { const struct string_list_elem *a = (const struct string_list_elem*)a_; const struct string_list_elem *b = (const struct string_list_elem*)b_; int a_type = a->attr.i; int b_type = b->attr.i; /* Sort directories before files. */ if (a_type != b_type) return b_type - a_type; return strcasecmp(a->data, b->data); } void dir_list_sort(struct string_list *list, bool dir_first) { if (!list) return; qsort(list->elems, list->size, sizeof(struct string_list_elem), dir_first ? qstrcmp_dir : qstrcmp_plain); } struct string_list *compressed_file_list_new(const char *path, const char* ext) { #ifdef HAVE_COMPRESSION const char* file_ext = path_get_extension(path); #ifdef HAVE_7ZIP if (strcasecmp(file_ext,"7z") == 0) return compressed_7zip_file_list_new(path,ext); #endif #ifdef HAVE_ZLIB if (strcasecmp(file_ext,"zip") == 0) return compressed_zip_file_list_new(path,ext); #endif #endif return NULL; } #ifdef _WIN32 struct string_list *dir_list_new(const char *dir, const char *ext, bool include_dirs) { struct string_list *list = string_list_new(); if (!list) return NULL; HANDLE hFind = INVALID_HANDLE_VALUE; WIN32_FIND_DATA ffd; char path_buf[PATH_MAX]; snprintf(path_buf, sizeof(path_buf), "%s\\*", dir); struct string_list *ext_list = NULL; if (ext) ext_list = string_split(ext, "|"); hFind = FindFirstFile(path_buf, &ffd); if (hFind == INVALID_HANDLE_VALUE) goto error; do { union string_list_elem_attr attr; char file_path[PATH_MAX]; const char *name = ffd.cFileName; const char *file_ext = path_get_extension(name); bool is_dir = ffd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY; bool is_compressed_file = false; bool supported_by_core = false; attr.i = RARCH_FILETYPE_UNSET; fill_pathname_join(file_path, dir, name, sizeof(file_path)); if (!is_dir) { is_compressed_file = path_is_compressed_file(file_path); if (string_list_find_elem_prefix(ext_list, ".", file_ext)) supported_by_core = true; } if (!include_dirs && is_dir) continue; if (strcmp(name, ".") == 0 || strcmp(name, "..") == 0) continue; if (!is_compressed_file && !is_dir && ext_list && !supported_by_core) continue; if (is_dir) attr.i = RARCH_DIRECTORY; if (is_compressed_file) attr.i = RARCH_COMPRESSED_ARCHIVE; /* The order of these ifs is important. * If the file format is explicitly supported by the libretro-core, we * need to immediately load it and not designate it as a compressed file. * * Example: .zip could be supported as a image by the core and as a * compressed_file. In that case, we have to interpret it as a image. * * */ if (supported_by_core) attr.i = RARCH_PLAIN_FILE; if (!string_list_append(list, file_path, attr)) goto error; } while (FindNextFile(hFind, &ffd) != 0); FindClose(hFind); string_list_free(ext_list); return list; error: RARCH_ERR("Failed to open directory: \"%s\"\n", dir); if (hFind != INVALID_HANDLE_VALUE) FindClose(hFind); string_list_free(list); string_list_free(ext_list); return NULL; } #else static bool dirent_is_directory(const char *path, const struct dirent *entry) { #if defined(PSP) return (entry->d_stat.st_attr & FIO_SO_IFDIR) == FIO_SO_IFDIR; #elif defined(DT_DIR) if (entry->d_type == DT_DIR) return true; else if (entry->d_type == DT_UNKNOWN /* This can happen on certain file systems. */ || entry->d_type == DT_LNK) return path_is_directory(path); return false; #else /* dirent struct doesn't have d_type, do it the slow way ... */ return path_is_directory(path); #endif } struct string_list *dir_list_new(const char *dir, const char *ext, bool include_dirs) { DIR *directory = NULL; const struct dirent *entry = NULL; struct string_list *ext_list = NULL; struct string_list *list = (struct string_list*)string_list_new(); if (!list) return NULL; if (ext) ext_list = string_split(ext, "|"); directory = opendir(dir); if (!directory) goto error; while ((entry = readdir(directory))) { bool is_dir; char file_path[PATH_MAX]; union string_list_elem_attr attr; const char *name = entry->d_name; const char *file_ext = path_get_extension(name); bool is_compressed_file = false; bool supported_by_core = false; attr.i = RARCH_FILETYPE_UNSET; fill_pathname_join(file_path, dir, name, sizeof(file_path)); is_dir = dirent_is_directory(file_path, entry); if (!is_dir) { is_compressed_file = path_is_compressed_file(file_path); if (string_list_find_elem_prefix(ext_list, ".", file_ext)) supported_by_core = true; } if (!include_dirs && is_dir) continue; if (strcmp(name, ".") == 0 || strcmp(name, "..") == 0) continue; if (!is_dir && ext_list && !is_compressed_file && !supported_by_core) continue; if (is_dir) attr.i = RARCH_DIRECTORY; if (is_compressed_file) attr.i = RARCH_COMPRESSED_ARCHIVE; /* The order of these ifs is important. * If the file format is explicitly supported by the libretro-core, we * need to immediately load it and not designate it as a compressed file. * * Example: .zip could be supported as a image by the core and as a * compressed_file. In that case, we have to interpret it as a image. * * */ if (supported_by_core) attr.i = RARCH_PLAIN_FILE; if (!string_list_append(list, file_path, attr)) goto error; } closedir(directory); string_list_free(ext_list); return list; error: RARCH_ERR("Failed to open directory: \"%s\"\n", dir); if (directory) closedir(directory); string_list_free(list); string_list_free(ext_list); return NULL; } #endif void dir_list_free(struct string_list *list) { string_list_free(list); } static bool path_char_is_slash(char c) { #ifdef _WIN32 return (c == '/') || (c == '\\'); #else return (c == '/'); #endif } static const char *path_default_slash(void) { #ifdef _WIN32 return "\\"; #else return "/"; #endif } bool path_contains_compressed_file(const char *path) { /* * Currently we only check for hash symbol inside the pathname. * If path is ever expanded to a general URI, we should check for that here. */ return (strchr(path,'#') != NULL); } bool path_is_compressed_file(const char* path) { #ifdef HAVE_COMPRESSION const char* file_ext = path_get_extension(path); #ifdef HAVE_7ZIP if (strcmp(file_ext,"7z") == 0) return true; #endif #ifdef HAVE_ZLIB if (strcmp(file_ext,"zip") == 0) return true; #endif #endif return false; } bool path_is_directory(const char *path) { #ifdef _WIN32 DWORD ret = GetFileAttributes(path); return (ret & FILE_ATTRIBUTE_DIRECTORY) && (ret != INVALID_FILE_ATTRIBUTES); #else struct stat buf; if (stat(path, &buf) < 0) return false; return S_ISDIR(buf.st_mode); #endif } bool path_file_exists(const char *path) { FILE *dummy = fopen(path, "rb"); if (dummy) { fclose(dummy); return true; } return false; } void fill_pathname(char *out_path, const char *in_path, const char *replace, size_t size) { char tmp_path[PATH_MAX]; char *tok; rarch_assert(strlcpy(tmp_path, in_path, sizeof(tmp_path)) < sizeof(tmp_path)); if ((tok = (char*)strrchr(path_basename(tmp_path), '.'))) *tok = '\0'; rarch_assert(strlcpy(out_path, tmp_path, size) < size); rarch_assert(strlcat(out_path, replace, size) < size); } void fill_pathname_noext(char *out_path, const char *in_path, const char *replace, size_t size) { rarch_assert(strlcpy(out_path, in_path, size) < size); rarch_assert(strlcat(out_path, replace, size) < size); } static char *find_last_slash(const char *str) { const char *slash = strrchr(str, '/'); #ifdef _WIN32 const char *backslash = strrchr(str, '\\'); if (backslash && ((slash && backslash > slash) || !slash)) slash = backslash; #endif return (char*)slash; } /* Assumes path is a directory. Appends a slash * if not already there. */ void fill_pathname_slash(char *path, size_t size) { size_t path_len = strlen(path); const char *last_slash = find_last_slash(path); // Try to preserve slash type. if (last_slash && (last_slash != (path + path_len - 1))) { char join_str[2] = {*last_slash}; rarch_assert(strlcat(path, join_str, size) < size); } else if (!last_slash) rarch_assert(strlcat(path, path_default_slash(), size) < size); } void fill_pathname_dir(char *in_dir, const char *in_basename, const char *replace, size_t size) { fill_pathname_slash(in_dir, size); const char *base = path_basename(in_basename); rarch_assert(strlcat(in_dir, base, size) < size); rarch_assert(strlcat(in_dir, replace, size) < size); } void fill_pathname_base(char *out, const char *in_path, size_t size) { const char *ptr = find_last_slash(in_path); if (ptr) ptr++; else ptr = in_path; rarch_assert(strlcpy(out, ptr, size) < size); } void fill_pathname_basedir(char *out_dir, const char *in_path, size_t size) { rarch_assert(strlcpy(out_dir, in_path, size) < size); path_basedir(out_dir); } void fill_pathname_parent_dir(char *out_dir, const char *in_dir, size_t size) { rarch_assert(strlcpy(out_dir, in_dir, size) < size); path_parent_dir(out_dir); } void fill_dated_filename(char *out_filename, const char *ext, size_t size) { time_t cur_time; time(&cur_time); strftime(out_filename, size, "RetroArch-%m%d-%H%M%S.", localtime(&cur_time)); strlcat(out_filename, ext, size); } void path_basedir(char *path) { if (strlen(path) < 2) return; char *last = find_last_slash(path); if (last) last[1] = '\0'; else snprintf(path, 3, ".%s", path_default_slash()); } void path_parent_dir(char *path) { size_t len = strlen(path); if (len && path_char_is_slash(path[len - 1])) path[len - 1] = '\0'; path_basedir(path); } const char *path_basename(const char *path) { const char *last = find_last_slash(path); if (last) return last + 1; return path; } bool path_is_absolute(const char *path) { #ifdef _WIN32 /* Many roads lead to Rome ... */ return path[0] == '/' || (strstr(path, "\\\\") == path) || strstr(path, ":/") || strstr(path, ":\\") || strstr(path, ":\\\\"); #else return path[0] == '/'; #endif } void path_resolve_realpath(char *buf, size_t size) { #ifndef RARCH_CONSOLE char tmp[PATH_MAX]; strlcpy(tmp, buf, sizeof(tmp)); #ifdef _WIN32 if (!_fullpath(buf, tmp, size)) strlcpy(buf, tmp, size); #else rarch_assert(size >= PATH_MAX); /* NOTE: realpath() expects at least PATH_MAX bytes in buf. * Technically, PATH_MAX needn't be defined, but we rely on it anyways. * POSIX 2008 can automatically allocate for you, * but don't rely on that. */ if (!realpath(tmp, buf)) strlcpy(buf, tmp, size); #endif #else (void)buf; (void)size; #endif } static bool path_mkdir_norecurse(const char *dir) { int ret; #if defined(_WIN32) ret = _mkdir(dir); #elif defined(IOS) ret = mkdir(dir, 0755); #else ret = mkdir(dir, 0750); #endif /* Don't treat this as an error. */ if (ret < 0 && errno == EEXIST && path_is_directory(dir)) ret = 0; if (ret < 0) RARCH_ERR("mkdir(%s) error: %s.\n", dir, strerror(errno)); return ret == 0; } bool path_mkdir(const char *dir) { const char *target = NULL; /* Use heap. Real chance of stack overflow if we recurse too hard. */ char *basedir = strdup(dir); bool ret = true; if (!basedir) return false; path_parent_dir(basedir); if (!*basedir || !strcmp(basedir, dir)) { ret = false; goto end; } if (path_is_directory(basedir)) { target = dir; ret = path_mkdir_norecurse(dir); } else { target = basedir; ret = path_mkdir(basedir); if (ret) { target = dir; ret = path_mkdir_norecurse(dir); } } end: if (target && !ret) RARCH_ERR("Failed to create directory: \"%s\".\n", target); free(basedir); return ret; } void fill_pathname_resolve_relative(char *out_path, const char *in_refpath, const char *in_path, size_t size) { if (path_is_absolute(in_path)) rarch_assert(strlcpy(out_path, in_path, size) < size); else { rarch_assert(strlcpy(out_path, in_refpath, size) < size); path_basedir(out_path); rarch_assert(strlcat(out_path, in_path, size) < size); } } void fill_pathname_join(char *out_path, const char *dir, const char *path, size_t size) { rarch_assert(strlcpy(out_path, dir, size) < size); if (*out_path) fill_pathname_slash(out_path, size); rarch_assert(strlcat(out_path, path, size) < size); } void fill_pathname_join_delim(char *out_path, const char *dir, const char *path, const char delim, size_t size) { size_t copied = strlcpy(out_path, dir, size); rarch_assert(copied < size+1); out_path[copied]=delim; out_path[copied+1] = '\0'; rarch_assert(strlcat(out_path, path, size) < size); } void fill_pathname_expand_special(char *out_path, const char *in_path, size_t size) { #if !defined(RARCH_CONSOLE) if (*in_path == '~') { const char *home = getenv("HOME"); if (home) { size_t src_size = strlcpy(out_path, home, size); rarch_assert(src_size < size); out_path += src_size; size -= src_size; in_path++; } } else if ((in_path[0] == ':') && #ifdef _WIN32 ((in_path[1] == '/') || (in_path[1] == '\\')) #else (in_path[1] == '/') #endif ) { char application_dir[PATH_MAX]; fill_pathname_application_path(application_dir, sizeof(application_dir)); path_basedir(application_dir); size_t src_size = strlcpy(out_path, application_dir, size); rarch_assert(src_size < size); out_path += src_size; size -= src_size; in_path += 2; } #endif rarch_assert(strlcpy(out_path, in_path, size) < size); } void fill_short_pathname_representation(char* out_rep, const char *in_path, size_t size) { char path_short[PATH_MAX]; fill_pathname(path_short, path_basename(in_path), "", sizeof(path_short)); char* last_hash = strchr(path_short,'#'); /* We handle paths like: * /path/to/file.7z#mygame.img * short_name: mygame.img: */ if(last_hash != NULL) { /* We check whether something is actually * after the hash to avoid going over the buffer. */ rarch_assert(strlen(last_hash) > 1); strlcpy(out_rep,last_hash + 1, size); } else { strlcpy(out_rep,path_short, size); } } void fill_pathname_abbreviate_special(char *out_path, const char *in_path, size_t size) { #if !defined(RARCH_CONSOLE) unsigned i; const char *home = getenv("HOME"); char application_dir[PATH_MAX]; fill_pathname_application_path(application_dir, sizeof(application_dir)); path_basedir(application_dir); /* application_dir could be zero-string. Safeguard against this. * * Keep application dir in front of home, moving app dir to a * new location inside home would break otherwise. */ const char *candidates[3] = { application_dir, home, NULL }; const char *notations[3] = { ":", "~", NULL }; for (i = 0; candidates[i]; i++) { if (*candidates[i] && strstr(in_path, candidates[i]) == in_path) { size_t src_size = strlcpy(out_path, notations[i], size); rarch_assert(src_size < size); out_path += src_size; size -= src_size; in_path += strlen(candidates[i]); if (!path_char_is_slash(*in_path)) { rarch_assert(strlcpy(out_path, path_default_slash(), size) < size); out_path++; size--; } break; /* Don't allow more abbrevs to take place. */ } } #endif rarch_assert(strlcpy(out_path, in_path, size) < size); } #ifndef RARCH_CONSOLE void fill_pathname_application_path(char *buf, size_t size) { size_t i; (void)i; if (!size) return; #ifdef _WIN32 DWORD ret = GetModuleFileName(GetModuleHandle(NULL), buf, size - 1); buf[ret] = '\0'; #elif defined(__APPLE__) CFBundleRef bundle = CFBundleGetMainBundle(); if (bundle) { CFURLRef bundle_url = CFBundleCopyBundleURL(bundle); CFStringRef bundle_path = CFURLCopyPath(bundle_url); CFStringGetCString(bundle_path, buf, size, kCFStringEncodingUTF8); CFRelease(bundle_path); CFRelease(bundle_url); rarch_assert(strlcat(buf, "nobin", size) < size); return; } #elif defined(__HAIKU__) image_info info; int32 cookie = 0; while (get_next_image_info(0, &cookie, &info) == B_OK) { if (info.type == B_APP_IMAGE) { strlcpy(buf, info.name, size); return; } } #else *buf = '\0'; pid_t pid = getpid(); char link_path[PATH_MAX]; /* Linux, BSD and Solaris paths. Not standardized. */ static const char *exts[] = { "exe", "file", "path/a.out" }; for (i = 0; i < ARRAY_SIZE(exts); i++) { snprintf(link_path, sizeof(link_path), "/proc/%u/%s", (unsigned)pid, exts[i]); ssize_t ret = readlink(link_path, buf, size - 1); if (ret >= 0) { buf[ret] = '\0'; return; } } RARCH_ERR("Cannot resolve application path! This should not happen.\n"); #endif } #endif