preserve-emulation/ppsspp
1
0 Fork 0
mirror of https://github.com/hrydgard/ppsspp.git synced 2026-10-16 07:50:28 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
c60feaede68f046ccb0aee61ba94efcd4378770e
ppsspp/libretro/libretro-common/file/file_path.c
T
libretroadmin cf9d102864 libretro: vendor libretro-common from RetroArch in-tree 
The libretro-common submodule pinned the standalone repository at
76a3d54. It is replaced by an in-tree copy of RetroArch master
(b655a20) holding only what the core uses: the VFS, file, string,
encoding, compat and time sources it already built, the headers they and
the core include, the threading set - rthreads, retro_atomic, retro_spsc
and retro_waitable_spsc, mpsc_stack, retro_triple_buffer,
retro_eventcount, retro_asym_eventcount, retro_procbarrier and tpool,
with features_cpu and rstrtod, which they need - and the codecs that
replace the bundled zlib, zstd, libchdr, libzip and libpng: rinflate and
rdeflate, rzstd, rchd with its LZMA and FLAC decoders, rzip_archive,
rpng and crc32.

stdstring.c, which nothing calls, is no longer built. The threading sources are always built, by both the static Makefile and
CMake; the VFS set stays behind HAVE_LIBRETRO_VFS as before. The codecs
are built by the change that switches the core over to them.
2026-10-08 14:14:37 +02:00

1553 lines
42 KiB
C
Raw Blame History

/* Copyright (C) 2010-2020 The RetroArch team
*
* ---------------------------------------------------------------------------------------
* The following license statement only applies to this file (file_path.c).
* ---------------------------------------------------------------------------------------
*
* Permission is hereby granted, free of charge,
* to any person obtaining a copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
* and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <retro_posix_source.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <locale.h>
#include <ctype.h>
#include <sys/stat.h>
#include <boolean.h>
#include <file/file_path.h>
#include <retro_miscellaneous.h>
#include <time/rtime.h>
/* TODO: There are probably some unnecessary things on this huge include list now but I'm too afraid to touch it */
#ifdef __APPLE__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifdef __HAIKU__
#include <kernel/image.h>
#endif
#ifndef __MACH__
#include <compat/strl.h>
#include <compat/posix_string.h>
#endif
#include <encodings/utf.h>
#ifdef _WIN32
#include <direct.h>
#else
#include <unistd.h> /* stat() is defined here */
#endif
#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
#ifdef __WINRT__
#include <uwp/uwp_func.h>
#endif
#endif
/* Time format strings with AM-PM designation require special
* handling due to platform dependence */
size_t strftime_am_pm(char *s, size_t len, const char* format,
const void *ptr)
{
size_t _len = 0;
#if !(defined(__linux__) && !defined(ANDROID))
char *local = NULL;
#endif
const struct tm *timeptr = (const struct tm*)ptr;
setlocale(LC_TIME, "");
_len = strftime(s, len, format, timeptr);
#if !(defined(__linux__) && !defined(ANDROID))
if ((local = local_to_utf8_string_alloc(s)))
{
if (local[0] != '\0')
_len = strlcpy(s, local, len);
free(local);
local = NULL;
}
#endif
return _len;
}
/**
* Create a new linked list with one node in it
* The path on this node will be set to NULL
**/
struct path_linked_list* path_linked_list_new(void)
{
struct path_linked_list* paths_list =
(struct path_linked_list*)malloc(sizeof(*paths_list));
if (!paths_list)
return NULL;
paths_list->next = NULL;
paths_list->path = NULL;
return paths_list;
}
/**
* path_linked_list_free:
*
* Free the entire linked list
**/
void path_linked_list_free(struct path_linked_list *in_path_llist)
{
struct path_linked_list *node_tmp = in_path_llist;
while (node_tmp)
{
struct path_linked_list *hold = node_tmp;
node_tmp = node_tmp->next;
free(hold->path); /* free(NULL) is safe per C89 */
free(hold);
}
}
/**
* path_linked_list_add_path:
*
* Add a node to the linked list with this path
* If the first node's path if it's not yet set the path
* on this node instead
**/
void path_linked_list_add_path(struct path_linked_list *in_path_llist,
char *path)
{
/* If the first item does not have a path this is
a list which has just been created, so we just fill
the path for the first item
*/
if (!in_path_llist->path)
in_path_llist->path = strdup(path);
else
{
struct path_linked_list *node =
(struct path_linked_list*)malloc(sizeof(*node));
if (node)
{
struct path_linked_list *tail = in_path_llist;
node->next = NULL;
node->path = strdup(path);
while (tail->next)
tail = tail->next;
tail->next = node;
}
}
}
/**
* path_get_archive_delim:
* @path : path
*
* Find delimiter of an archive file. Only the first '#'
* after a compression extension is considered.
*
* @return pointer to the delimiter in the path if it contains
* a path inside a compressed file, otherwise NULL.
**/
const char *path_get_archive_delim(const char *path)
{
/* Find delimiter position
* > Since filenames may contain '#' characters,
* must loop until we find the first '#' that
* is directly *after* a compression extension */
const char *delim = strchr(path, '#');
while (delim)
{
long d = (long)(delim - path);
/* Check whether this is a known archive type */
if (d > 3)
{
char c3 = delim[-3] | 0x20;
char c2 = delim[-2] | 0x20;
char c1 = delim[-1] | 0x20;
/* Check ".7z" */
if (delim[-3] == '.' && delim[-2] == '7' && c1 == 'z')
return delim;
if (d > 4)
{
char c4 = delim[-4];
if (c4 == '.')
{
/* Check ".zip" or ".zst" */
if (c3 == 'z')
{
if (c2 == 'i' && c1 == 'p')
return delim;
if (c2 == 's' && c1 == 't')
return delim;
}
/* Check ".apk" */
else if (c3 == 'a' && c2 == 'p' && c1 == 'k')
return delim;
/* Check ".rar" */
else if (c3 == 'r' && c2 == 'a' && c1 == 'r')
return delim;
}
}
}
delim++;
delim = strchr(delim, '#');
}
return NULL;
}
/**
* path_get_extension:
* @path : path
*
* Gets extension of file. Only '.'s
* after the last slash are considered.
*
* @return extension part from the path.
**/
const char *path_get_extension(const char *path)
{
const char *ext;
if ( path
&& (ext = strrchr(path_basename(path), '.'))
&& ext[1] != '\0')
return ext + 1;
return "";
}
/**
* path_get_extension_mutable:
* @path : path
*
* Specialized version of path_get_extension(). Return
* value is mutable.
*
* Gets extension of file. Only '.'s
* after the last slash are considered.
*
* @return extension part from the path.
**/
char *path_get_extension_mutable(const char *path)
{
char *ext = NULL;
if ( path && *path != '\0'
&& ((ext = (char*)strrchr(path_basename(path), '.'))))
return ext;
return NULL;
}
/**
* path_remove_extension:
* @s : path
*
* Mutates path by removing its extension. Removes all
* text after and including the last '.'.
* Only '.'s after the last slash are considered.
*
* @return
* 1) If path has an extension, returns path with the
* extension removed.
* 2) If there is no extension, returns NULL.
* 3) If path is empty or NULL, returns NULL
**/
char *path_remove_extension(char *s)
{
char *last = path_get_extension_mutable(s);
if (!last)
return NULL;
if (*last)
*last = '\0';
return s;
}
/**
* path_is_compressed_file:
* @path : path
*
* Checks if path is a compressed file.
*
* @return true if path is a compressed file, otherwise false.
**/
bool path_is_compressed_file(const char *path)
{
const char *ext = path_get_extension(path);
if (!ext)
return false;
switch (tolower((unsigned char)ext[0]))
{
case '7':
return ext[1] == 'z' && ext[2] == '\0';
case 'a':
return tolower((unsigned char)ext[1]) == 'p'
&& tolower((unsigned char)ext[2]) == 'k'
&& ext[3] == '\0';
case 'r':
return tolower((unsigned char)ext[1]) == 'a'
&& tolower((unsigned char)ext[2]) == 'r'
&& ext[3] == '\0';
case 'z':
switch (tolower((unsigned char)ext[1]))
{
case 'i':
return tolower((unsigned char)ext[2]) == 'p'
&& ext[3] == '\0';
case 's':
return tolower((unsigned char)ext[2]) == 't'
&& ext[3] == '\0';
}
break;
}
return false;
}
/**
* fill_pathname:
* @s : output path
* @in_path : input path
* @replace : what to replace
* @len : buffer size of output path
*
* FIXME: Verify
*
* Replaces filename extension with 'replace' and outputs result to @s.
* The extension here is considered to be the string from the last '.'
* to the end.
*
* Only '.'s after the last slash are considered as extensions.
* If no '.' is present, in_path and replace will simply be concatenated.
* 'len' is buffer size of 's'.
* E.g.: in_path = "/foo/bar/baz/boo.c", replace = ".asm" =>
* s = "/foo/bar/baz/boo.asm"
* E.g.: in_path = "/foo/bar/baz/boo.c", replace = "" =>
* s = "/foo/bar/baz/boo"
*
* @return Length of the string copied into @out
*/
size_t fill_pathname(char *s, const char *in_path,
const char *replace, size_t len)
{
char *tok = NULL;
size_t _len = strlcpy(s, in_path, len);
if (_len >= len)
_len = (len > 0) ? len - 1 : 0;
if ((tok = (char*)strrchr(path_basename(s), '.')))
{
*tok = '\0'; _len = tok - s;
}
_len += strlcpy(s + _len, replace, len - _len);
return _len;
}
/**
* find_last_slash:
* @str : path
* @size : size of path
*
* Find last slash in path. Tries to find
* a backslash as used for Windows paths,
* otherwise checks for a regular slash.
* @return pointer to last slash/backslash found in @str.
**/
char *find_last_slash(const char *str)
{
#ifdef _WIN32
char *s1 = strrchr(str, '/');
char *s2 = strrchr(str, '\\');
if (!s1)
return s2;
if (!s2)
return s1;
return (s2 > s1) ? s2 : s1;
#else
return (char*)strrchr(str, '/');
#endif
}
/**
* fill_pathname_slash:
* @s : path
* @len : size of @s
*
* Assumes path is a directory. Appends a slash
* if not already there.
**/
size_t fill_pathname_slash(char *s, size_t len)
{
size_t _len = strlen(s);
char *last_slash = find_last_slash(s);
if (!last_slash)
{
if (_len + 2 <= len)
{
s[ _len] = PATH_DEFAULT_SLASH_C();
s[++_len] = '\0';
}
}
else if (last_slash != (s + _len - 1))
{
/* Try to preserve slash type. */
if (_len + 2 <= len)
{
s[ _len] = last_slash[0];
s[++_len] = '\0';
}
}
return _len;
}
/**
* fill_pathname_dir:
* @s : input directory path
* @in_basename : input basename to be appended to @s
* @replace : replacement to be appended to @in_basename
* @size : size of buffer
*
* Appends basename of 'in_basename', to 's', along with 'replace'.
* Basename of in_basename is the string after the last '/' or '\\',
* i.e the filename without directories.
*
* If in_basename has no '/' or '\\', the whole 'in_basename' will be used.
* 'size' is buffer size of 's'.
*
* E.g..: s = "/tmp/some_dir", in_basename = "/some_content/foo.c",
* replace = ".asm" => s = "/tmp/some_dir/foo.c.asm"
**/
/* Appends @in to the @_len bytes already in @s and returns the new
* length, never more than @len - 1.
*
* strlcpy() reports the length of its *source*, so an accumulator that
* adds the return value passes @len as soon as one part does not fit.
* The 'len - _len' handed to the next call then underflows to a huge
* size_t, and that call writes at 's + _len' -- already past the end --
* with no effective bound. Clamping on the way in keeps the size
* argument sane, and on the way out keeps the accumulator inside the
* buffer for whatever the caller does next. */
static size_t path_strlcat(char *s, size_t _len, const char *in, size_t len)
{
if (!len)
return 0;
if (_len > len - 1)
_len = len - 1;
_len += strlcpy(s + _len, in, len - _len);
if (_len > len - 1)
_len = len - 1;
return _len;
}
size_t fill_pathname_dir(char *s, const char *in_basename,
const char *replace, size_t len)
{
size_t _len = fill_pathname_slash(s, len);
_len = path_strlcat(s, _len, path_basename(in_basename), len);
_len = path_strlcat(s, _len, replace, len);
return _len;
}
/**
* fill_pathname_base:
* @s : output path
* @in_path : input path
* @len : size of output path
*
* Copies basename of @in_path into @s.
*
* @return Length of the string copied into @s
**/
size_t fill_pathname_base(char *s, const char *in_path, size_t len)
{
const char *ptr = path_basename(in_path);
if (ptr)
return strlcpy(s, ptr, len);
return strlcpy(s, in_path, len);
}
/**
* fill_pathname_basedir:
* @s : output directory
* @in_path : input path
* @len : size of output directory
*
* Copies base directory of @in_path into @s.
* If in_path is a path without any slashes (relative current directory),
* @s will get path "./".
*
* @return Length of the string copied in @s
**/
size_t fill_pathname_basedir(char *s, const char *in_path, size_t len)
{
if (s != in_path)
strlcpy(s, in_path, len);
return path_basedir(s);
}
/**
* fill_pathname_parent_dir_name:
* @s : output string
* @in_dir : input directory
* @len : size of @s
*
* Copies only the parent directory name of @in_dir into @s.
* The two buffers must not overlap. Removes trailing '/'.
*
* @return Length of the string copied into @s
**/
size_t fill_pathname_parent_dir_name(char *s,
const char *in_dir, size_t len)
{
const char *end, *parent_end;
if (len)
s[0] = '\0';
end = in_dir + strlen(in_dir);
/* Skip trailing slash */
if (end > in_dir && (end[-1] == '/' || end[-1] == '\\'))
--end;
/* Find slash before the last component
* (the filename/deepest dir) */
parent_end = end;
while (parent_end > in_dir
&& parent_end[-1] != '/' && parent_end[-1] != '\\')
--parent_end;
/* parent_end now points past the slash that ends the parent dir.
* Move back over that slash, then find the start of the parent
* name. */
if (parent_end > in_dir)
{
const char *parent_start;
--parent_end; /* skip the slash itself */
parent_start = parent_end;
while (parent_start > in_dir
&& parent_start[-1] != '/'
&& parent_start[-1] != '\\')
--parent_start;
if (parent_end > parent_start)
return strlcpy(s, parent_start,
(size_t)(parent_end - parent_start + 1) < len
? (size_t)(parent_end - parent_start + 1)
: len);
}
return 0;
}
/**
* fill_pathname_parent_dir:
* @s : output directory
* @in_dir : input directory
* @len : size of @s
*
* Copies parent directory of @in_dir into @s.
* Assumes @in_dir is a directory. Keeps trailing '/'.
* If the path was already at the root directory,
* @s will be an empty string.
**/
size_t fill_pathname_parent_dir(char *s,
const char *in_dir, size_t len)
{
size_t _len = 0;
if (s == in_dir)
_len = strlen(s);
else
{
/* strlcpy() reports the length of @in_dir, so a truncated copy
* leaves _len past the end of @s; path_parent_dir() would then
* scan back from outside the buffer. */
_len = strlcpy(s, in_dir, len);
if (len && _len > len - 1)
_len = len - 1;
}
return path_parent_dir(s, _len);
}
/**
* fill_dated_filename:
* @s : output filename
* @ext : extension of output filename
* @len : buffer size of output filename
*
* Creates a 'dated' filename prefixed by 'retroarch', and
* concatenates extension (@ext) to it.
*
* E.g.:
* s = "retroarch-{year}{month}{day}-{Hour}{Minute}{Second}.{@ext}"
**/
size_t fill_dated_filename(char *s,
const char *ext, size_t len)
{
size_t _len;
struct tm tm_;
time_t cur_time = time(NULL);
rtime_localtime(&cur_time, &tm_);
_len = strftime(s, len,
"retroarch-%y%m%d-%H%M%S", &tm_);
_len += strlcpy(s + _len, ext, len - _len);
return _len;
}
/**
* fill_str_dated_filename:
* @s : output filename
* @in_str : input string
* @ext : extension of output filename
* @len : buffer size of output filename
*
* Creates a 'dated' filename prefixed by the string @in_str, and
* concatenates extension (@ext) to it.
*
* E.g.:
* s = "RetroArch-{year}{month}{day}-{Hour}{Minute}{Second}.{@ext}"
*
* @return Length of the string copied into @s
**/
size_t fill_str_dated_filename(char *s,
const char *in_str, const char *ext, size_t len)
{
struct tm tm_;
size_t _len = 0;
time_t cur_time = time(NULL);
rtime_localtime(&cur_time, &tm_);
_len = strlcpy(s, in_str, len);
if (!ext || ext[0] == '\0')
_len += strftime(s + _len, len - _len, "-%y%m%d-%H%M%S", &tm_);
else
{
_len += strftime(s + _len, len - _len, "-%y%m%d-%H%M%S.", &tm_);
_len += strlcpy(s + _len, ext, len - _len);
}
return _len;
}
/**
* path_basedir:
* @s : path
*
* Extracts base directory by mutating path.
* Keeps trailing '/'.
*
* @return The new size of @s
**/
size_t path_basedir(char *s)
{
char *last_slash = NULL;
if (!s || s[0] == '\0' || s[1] == '\0')
return (s && s[0] != '\0') ? 1 : 0;
last_slash = find_last_slash(s);
if (last_slash)
{
last_slash[1] = '\0';
return last_slash + 1 - s;
}
s[0] = '.';
s[1] = PATH_DEFAULT_SLASH_C();
s[2] = '\0';
return 2;
}
/**
* path_parent_dir:
* @s : path
* @len : length of @path
*
* Extracts parent directory by mutating path.
* Assumes that @s is a directory. Keeps trailing '/'.
* If the path was already at the root directory, returns empty string
*
* @return The new size of @s
**/
size_t path_parent_dir(char *s, size_t len)
{
if (!s)
return 0;
if (len && PATH_CHAR_IS_SLASH(s[len - 1]))
{
char *last_slash;
bool was_absolute = path_is_absolute(s);
s[len - 1] = '\0';
last_slash = find_last_slash(s);
if (was_absolute && !last_slash)
{
/* We removed the only slash from what used
* to be an absolute path.
*
* On Linux, this goes from "/" to an empty string
* and everything works fine, but on Windows, we went
* from C:\ to C:, which is not a valid path and that later
* gets erroneously treated as a relative one by path_basedir
* and returns "./".
* What we really wanted is an empty string. */
s[0] = '\0';
return 0;
}
}
return path_basedir(s);
}
/**
* path_basename:
* @path : path
*
* Get basename from @path.
*
* @return basename from path.
**/
const char *path_basename(const char *path)
{
/* We cut either at the first compression-related hash,
* or we cut at the last slash */
const char *ptr = NULL;
char *last_slash = find_last_slash(path);
return ((ptr = path_get_archive_delim(path)) || (ptr = last_slash))
? (ptr + 1) : path;
}
/* Specialized version */
/**
* path_basename_nocompression:
* @path : path
*
* Specialized version of path_basename().
* Get basename from @path.
*
* @return basename from path.
**/
const char *path_basename_nocompression(const char *path)
{
/* We cut at the last slash */
char *last_slash = find_last_slash(path);
return (last_slash) ? (last_slash + 1) : path;
}
/**
* path_is_absolute:
* @path : path
*
* Checks if @path is an absolute path or a relative path.
*
* @return true if path is absolute, false if path is relative.
**/
bool path_is_absolute(const char *path)
{
if (path && *path != '\0')
{
if (path[0] == '/')
return true;
/* VFS URL schemes (smb://, cdrom://, saf://, ...) are absolute. */
{
const char *scheme = strstr(path, "://");
if (scheme && scheme > path)
return true;
}
#if defined(_WIN32)
if (path[0] == '\\' && path[1] == '\\')
return true;
if (path[0] && (path[1] == ':') && (path[2] == '/' || path[2] == '\\'))
return true;
#elif defined(__wiiu__) || defined(VITA)
{
const char *sep = strchr(path, ':');
if (sep && sep[1] == '/')
return true;
}
#endif
}
return false;
}
/**
* path_resolve_realpath:
* @s : input and output buffer for path
* @len : size of @s
* @resolve_symlinks : whether to resolve symlinks or not
*
* Resolves use of ".", "..", multiple slashes etc in absolute paths.
*
* Relative paths are rebased on the current working dir.
*
* @return @s if successful, NULL otherwise.
* Note: Not implemented on consoles
* Note: Symlinks are only resolved on Unix-likes
* Note: The current working dir might not be what you expect,
* e.g. on Android it is "/"
* Use of fill_pathname_resolve_relative() should be preferred
**/
char *path_resolve_realpath(char *s, size_t len, bool resolve_symlinks)
{
#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
#ifdef _WIN32
char *ret = NULL;
wchar_t *rel_path = utf8_to_utf16_string_alloc(s);
if (rel_path)
{
wchar_t abs_path[PATH_MAX_LENGTH];
if (_wfullpath(abs_path, rel_path, PATH_MAX_LENGTH))
{
char *tmp = utf16_to_utf8_string_alloc(abs_path);
if (tmp)
{
strlcpy(s, tmp, len);
free(tmp);
ret = s;
}
}
free(rel_path);
}
return ret;
#else
char tmp[PATH_MAX_LENGTH];
size_t t;
char *p;
const char *next;
const char *buf_end;
if (resolve_symlinks)
{
char *real_path;
strlcpy(tmp, s, sizeof(tmp));
real_path = realpath(tmp, NULL);
if (!real_path)
{
strlcpy(s, tmp, len);
return NULL;
}
strlcpy(s, real_path, len);
free(real_path);
return s;
}
t = 0;
if (!path_is_absolute(s))
{
size_t _len;
size_t s_len;
if (!getcwd(tmp, PATH_MAX_LENGTH - 1))
return NULL;
_len = strlen(tmp);
t += _len;
if (tmp[_len - 1] != '/')
tmp[t++] = '/';
if (!s || *s == '\0')
{
tmp[t] = '\0';
strlcpy(s, tmp, len);
return s;
}
s_len = strlen(s);
if (t + s_len >= PATH_MAX_LENGTH)
return NULL;
buf_end = s + s_len;
p = s;
}
else
{
/* Leave one byte for the eventual '\0' terminator. */
for (p = s; *p == '/' && t < PATH_MAX_LENGTH - 1; p++)
tmp[t++] = '/';
if (*p == '/') /* still more slashes -> input too long */
return NULL;
buf_end = p + strlen(p);
}
do
{
if (!(next = strchr(p, '/')))
next = buf_end;
if (next - p == 2 && p[0] == '.' && p[1] == '.')
{
p = (char *)next + 1;
if (t == 1 || tmp[t - 2] == '/')
return NULL;
t -= 2;
while (tmp[t] != '/')
t--;
t++;
}
else if (next - p == 1 && p[0] == '.')
p = (char *)next + 1;
else if (next - p == 0)
p += 1;
else
{
if (t + (next - p) + 1 > PATH_MAX_LENGTH - 1)
return NULL;
while (p <= next)
tmp[t++] = *p++;
}
} while (next < buf_end);
tmp[t] = '\0';
strlcpy(s, tmp, len);
return s;
#endif
#endif
return NULL;
}
/**
* path_relative_to:
* @s : buffer to write the relative path to
* @path : path to be expressed relatively
* @base : base directory to start out on
* @len : size of @s
*
* Turns @path into a path relative to @base and writes it to @s.
*
* @base is assumed to be a base directory, i.e. a path ending with '/' or '\'.
* Both @path and @base are assumed to be absolute paths without "." or "..".
*
* E.g. path /a/b/e/f.cg with base /a/b/c/d/ turns into ../../e/f.cg
*
* @return Length of the string copied into @s
**/
/* Splits @path and @base at the end of their common leading
* directories. Returns false when no relative form exists (Windows
* paths on different drives); the relative form is then @path. */
static bool path_relative_split(const char *path, const char *base,
const char **trimmed_path, const char **trimmed_base)
{
size_t i, j;
#ifdef _WIN32
if (
path[0] != '\0'
&& path[1] != '\0'
&& base[0] != '\0'
&& base[1] != '\0'
&& path[1] == ':'
&& base[1] == ':'
&& path[0] != base[0])
return false;
#endif
/* Trim common beginning - recognize both slash types */
for (i = 0, j = 0; path[i] && base[i] && path[i] == base[i]; i++)
if (PATH_CHAR_IS_SLASH(path[i]))
j = i + 1;
*trimmed_path = path + j;
*trimmed_base = base + i;
return true;
}
size_t path_relative_to(char *s,
const char *path, const char *base, size_t len)
{
size_t i;
size_t _len;
const char *trimmed_path, *trimmed_base;
/* For different drives, return absolute path */
if (!path_relative_split(path, base, &trimmed_path, &trimmed_base))
return strlcpy(s, path, len);
/* Each segment of base turns into ".." */
_len = 0;
for (i = 0; trimmed_base[i]; i++)
{
if (PATH_CHAR_IS_SLASH(trimmed_base[i]))
{
if (_len + 3 < len)
{
s[_len++] = '.';
s[_len++] = '.';
s[_len++] = PATH_DEFAULT_SLASH_C();
}
}
}
s[_len] = '\0';
_len += strlcpy(s + _len, trimmed_path, len - _len);
return _len;
}
/**
* fill_pathname_resolve_relative:
* @s : output path
* @in_refpath : input reference path
* @in_path : input path
* @len : size of @s
*
* Joins basedir of @in_refpath together with @in_path.
* If @in_path is an absolute path, s = in_path.
* E.g.: in_refpath = "/foo/bar/baz.a", in_path = "foobar.cg",
* s = "/foo/bar/foobar.cg".
**/
void fill_pathname_resolve_relative(char *s,
const char *in_refpath, const char *in_path, size_t len)
{
size_t _len;
if (path_is_absolute(in_path))
{
strlcpy(s, in_path, len);
return;
}
_len = fill_pathname_basedir(s, in_refpath, len);
strlcpy(s + _len, in_path, len - _len);
path_resolve_realpath(s, len, false);
}
/**
* fill_pathname_join:
* @s : output path
* @dir : directory
* @path : path
* @len : size of output path
*
* Joins a directory (@dir) and path (@path) together.
* Makes sure not to get two consecutive slashes
* between directory and path.
*
* Deprecated. Use fill_pathname_join_special() instead
* if you can ensure @dir and @s won't overlap.
*
* @return Length of the string copied into @s
**/
size_t fill_pathname_join(char *s, const char *dir,
const char *path, size_t len)
{
size_t _len = strlen(dir);
/* memmove() lands @dir in @s whether or not the two are the
* same buffer, so the copy needs no aliasing test of its own.
* Losing that test is what keeps @s written before it is read:
* a "@s might already be @dir" branch leaves a path on which
* the separator test below inspects a caller buffer that
* nothing has written yet, which is what the copy is for.
* It also covers a partial overlap, which the pointer compare
* never did.
*
* strlcpy() reports the length of its source, so the clamp is
* what a truncated copy leaves behind rather than what was
* asked for - @s + @_len stays inside the buffer. */
if (len)
{
if (_len > len - 1)
_len = len - 1;
memmove(s, dir, _len);
s[_len] = '\0';
}
else
_len = 0;
if (_len)
_len = fill_pathname_slash(s, len);
return _len + strlcpy(s + _len, path, len - _len);
}
/* fill_pathname_join_special() is a macro alias of
* fill_pathname_join() - see file_path.h. Historically it was a
* separate function whose copy could not take an overlapping @s
* and @dir, which made any aliased call undefined: strlcpy aborts
* via __chk_fail_overlap under fortified libc on macOS while the
* portable fallback hides the defect on other platforms.
* libretro-common is vendored into cores that never see RetroArch's
* overlap_copy_check CI gate, so the safe semantics have to live in
* the header rather than in a caller-side contract. */
size_t fill_pathname_join_special_ext(char *s,
const char *dir, const char *path,
const char *last, const char *ext,
size_t len)
{
size_t _len = fill_pathname_join(s, dir, path, len);
if (*s)
_len = fill_pathname_slash(s, len);
_len = path_strlcat(s, _len, last, len);
_len = path_strlcat(s, _len, ext, len);
return _len;
}
/**
* fill_pathname_join_delim:
* @s : output path
* @dir : directory
* @path : path
* @delim : delimiter
* @len : size of output path
*
* Joins a directory (@dir) and path (@path) together
* using the given delimiter (@delim).
**/
size_t fill_pathname_join_delim(char *s, const char *dir,
const char *path, const char delim, size_t len)
{
size_t _len;
/* Behavior of strlcpy is undefined if dst and src overlap */
if (s == dir)
_len = strlen(dir);
else
_len = strlcpy(s, dir, len);
/* _len is the length of @dir, which strlcpy() reports whether or not
* it fit, so this has to be a bounds check and not a subtraction that
* can wrap. */
if (_len + 2 > len)
return (len > 0) ? len - 1 : 0;
s[_len++] = delim;
s[_len ] = '\0';
if (path)
_len = path_strlcat(s, _len, path, len);
return _len;
}
size_t fill_pathname_expand_special(char *s, const char *in_path, size_t len)
{
#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
if (in_path[0] == '~' || in_path[0] == ':')
{
char app_dir[DIR_MAX_LENGTH];
if (in_path[0] == '~')
fill_pathname_home_dir(app_dir, sizeof(app_dir));
else
{
app_dir[0] = '\0';
fill_pathname_application_dir(app_dir, sizeof(app_dir));
}
if (*app_dir)
{
size_t _len = strlcpy(s, app_dir, len);
s += _len;
len -= _len;
if (!PATH_CHAR_IS_SLASH(s[-1]))
{
_len = strlcpy(s, PATH_DEFAULT_SLASH(), len);
s += _len;
len -= _len;
}
in_path += 2;
}
}
#endif
return strlcpy(s, in_path, len);
}
size_t fill_pathname_abbreviate_special(char *s,
const char *in_path, size_t len)
{
#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
unsigned i;
const char *candidates[3];
const char *notations[3];
size_t cand_len[3];
char application_dir[DIR_MAX_LENGTH];
char home_dir[DIR_MAX_LENGTH];
application_dir[0] = '\0';
candidates[0] = application_dir;
candidates[1] = home_dir;
candidates[2] = NULL;
notations [0] = ":";
notations [1] = "~";
notations [2] = NULL;
cand_len[0] = fill_pathname_application_dir(application_dir, sizeof(application_dir));
cand_len[1] = fill_pathname_home_dir(home_dir, sizeof(home_dir));
cand_len[2] = 0;
for (i = 0; candidates[i]; i++)
{
if ( cand_len[i] > 0
&& !strncmp(in_path, candidates[i], cand_len[i]))
{
size_t _len = strlcpy(s, notations[i], len);
if (_len >= len)
return _len;
s += _len;
len -= _len;
in_path += cand_len[i];
if (!PATH_CHAR_IS_SLASH(*in_path))
{
size_t sl = strlcpy(s, PATH_DEFAULT_SLASH(), len);
if (sl >= len)
return _len + sl;
s += sl;
len -= sl;
}
break;
}
}
#endif
return strlcpy(s, in_path, len);
}
/**
* sanitize_path_part:
*
* @path_part : directory or filename
* @len : length of path_part
*
* Takes single part of a path eg. single filename
* or directory, and removes any special chars that are
* unavailable.
*
* @returns newly allocated string that has been sanitized.
* Caller is responsible for freeing the returned string.
**/
char *sanitize_path_part(const char *path_part, size_t len)
{
size_t i;
size_t j = 0;
char *tmp = NULL;
if (!path_part || *path_part == '\0')
return NULL;
tmp = (char *)malloc((len + 1) * sizeof(char));
if (!tmp)
return NULL;
for (i = 0; path_part[i] != '\0'; i++)
{
char c = path_part[i];
/* Skip filesystem-unsafe characters */
switch (c)
{
case '<':
case '>':
case ':':
case '"':
case '/':
case '\\':
case '|':
case '?':
case '*':
break;
default:
tmp[j++] = c;
break;
}
}
tmp[j] = '\0';
return tmp;
}
/**
* pathname_conform_slashes_to_os:
*
* @s : path
*
* Leaf function.
*
* Changes the slashes to the correct kind for the OS
* So forward slash on linux and backslash on Windows
**/
void pathname_conform_slashes_to_os(char *s)
{
/* Conform slashes to OS standard
* so we get proper matching */
char *p;
for (p = s; *p; p++)
if (*p == '/' || *p == '\\')
*p = PATH_DEFAULT_SLASH_C();
}
/**
* pathname_make_slashes_portable:
* @s : path
*
* Leaf function.
*
* Change all slashes to forward so they are more
* portable between Windows and Linux
**/
void pathname_make_slashes_portable(char *s)
{
/* Conform slashes to OS standard
* so we get proper matching */
char *p;
for (p = s; *p; p++)
if (*p == '/' || *p == '\\')
*p = '/';
}
/**
* get_pathname_num_slashes:
* @in_path : input path
*
* Leaf function.
*
* Get the number of slashes in a path.
*
* @return number of slashes found in @in_path.
**/
static int get_pathname_num_slashes(const char *in_path)
{
int num_slashes = 0;
const char *p;
for (p = in_path; *p != '\0'; p++)
{
if (PATH_CHAR_IS_SLASH(*p))
num_slashes++;
}
return num_slashes;
}
/**
* fill_pathname_abbreviated_or_relative:
*
* Fills the supplied path with either the abbreviated path or
* the relative path, which ever one has less
* depth / number of slashes
*
* If lengths of abbreviated and relative paths are the same,
* the relative path will be used
* @in_path can be an absolute, relative or abbreviated path
*
* @return Length of the string copied into @s
**/
size_t fill_pathname_abbreviated_or_relative(char *s,
const char *in_refpath, const char *in_path, size_t len)
{
size_t _len;
int rel_slashes;
const char *trimmed_path, *trimmed_base;
char abs_path[PATH_MAX_LENGTH];
char ref_path[PATH_MAX_LENGTH];
/* Expand paths which start with :\ to an absolute path */
fill_pathname_expand_special(abs_path, in_path, sizeof(abs_path));
pathname_conform_slashes_to_os(abs_path);
strlcpy(ref_path, in_refpath, sizeof(ref_path));
pathname_conform_slashes_to_os(ref_path);
/* Resolve a relative path against the referencing file's directory.
* The join still carries its '..' segments and can be far longer
* than the result, so it is built at full path size in ref_path
* (only its directory is needed for the join) and never in @s. */
if (!path_is_absolute(abs_path))
{
_len = fill_pathname_basedir(ref_path, ref_path, sizeof(ref_path));
strlcpy(ref_path + _len, abs_path, sizeof(ref_path) - _len);
path_resolve_realpath(ref_path, sizeof(ref_path), false);
strlcpy(abs_path, ref_path, sizeof(abs_path));
pathname_conform_slashes_to_os(abs_path);
strlcpy(ref_path, in_refpath, sizeof(ref_path));
pathname_conform_slashes_to_os(ref_path);
}
/* Depth of the relative form: one '..' per directory left in the
* base past the common prefix, plus what remains of the path */
if (path_relative_split(abs_path, ref_path, &trimmed_path, &trimmed_base))
rel_slashes = get_pathname_num_slashes(trimmed_base)
+ get_pathname_num_slashes(trimmed_path);
else
rel_slashes = get_pathname_num_slashes(abs_path);
_len = fill_pathname_abbreviate_special(s, abs_path, len);
/* Use the shortest path, preferring the relative path */
if (rel_slashes <= get_pathname_num_slashes(s))
return path_relative_to(s, abs_path, ref_path, len);
return _len;
}
/**
* path_basedir:
* @s : path
*
* Extracts base directory by mutating path.
* Keeps trailing '/'.
**/
void path_basedir_wrapper(char *s)
{
char *last_slash = NULL;
if (!s || s[0] == '\0' || s[1] == '\0')
return;
#ifdef HAVE_COMPRESSION
/* We want to find the directory with the archive in basedir. */
if ((last_slash = (char*)path_get_archive_delim(s)))
*last_slash = '\0';
#endif
last_slash = find_last_slash(s);
if (!last_slash)
{
s[0] = '.';
s[1] = PATH_DEFAULT_SLASH_C();
s[2] = '\0';
}
else
last_slash[1] = '\0';
}
#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
size_t fill_pathname_application_path(char *s, size_t len)
{
if (len)
{
#if defined(_WIN32)
#if defined(LEGACY_WIN32_RUNTIME)
DWORD ret;
if (win32_needs_local_encoding())
ret = GetModuleFileNameA(NULL, s, len);
else
{
wchar_t wstr[PATH_MAX_LENGTH] = {0};
ret = GetModuleFileNameW(NULL, wstr, ARRAY_SIZE(wstr));
if (*wstr)
{
char *str = utf16_to_utf8_string_alloc(wstr);
if (str)
{
strlcpy(s, str, len);
free(str);
}
}
}
#elif defined(LEGACY_WIN32)
DWORD ret = GetModuleFileNameA(NULL, s, len);
#else
wchar_t wstr[PATH_MAX_LENGTH] = {0};
DWORD ret = GetModuleFileNameW(NULL, wstr, ARRAY_SIZE(wstr));
if (*wstr)
{
char *str = utf16_to_utf8_string_alloc(wstr);
if (str)
{
strlcpy(s, str, len);
free(str);
}
}
#endif
s[ret] = '\0';
return ret;
#elif defined(__APPLE__)
CFBundleRef bundle = CFBundleGetMainBundle();
if (bundle)
{
size_t rv = 0;
CFURLRef bundle_url = CFBundleCopyBundleURL(bundle);
CFStringRef bundle_path = CFURLCopyPath(bundle_url);
CFStringGetCString(bundle_path, s, len, kCFStringEncodingUTF8);
#ifdef HAVE_COCOATOUCH
{
/* This needs to be done so that the path becomes
* /private/var/... and this
* is used consistently throughout for the
* iOS bundle path */
char resolved_bundle_dir_buf[DIR_MAX_LENGTH] = {0};
if (realpath(s, resolved_bundle_dir_buf))
{
size_t _len = strlcpy(s, resolved_bundle_dir_buf, len - 1);
s[ _len] = '/';
s[++_len] = '\0';
rv = _len;
}
}
#else
rv = CFStringGetLength(bundle_path);
#endif
CFRelease(bundle_path);
CFRelease(bundle_url);
return rv;
}
#elif defined(__HAIKU__)
image_info info;
int32_t cookie = 0;
while (get_next_image_info(0, &cookie, &info) == B_OK)
{
if (info.type == B_APP_IMAGE)
return strlcpy(s, info.name, len);
}
#elif defined(__QNX__)
char *buff = (char*)malloc(len);
size_t _len = 0;
/* NULL-check the malloc: _cmdname writes through its
* buffer argument (populates with the command path),
* NULL-derefs on OOM. Leave s as it was set by the
* caller (empty or previous value) and return 0 -
* callers treat 0 as 'unable to resolve own path' and
* fall back to argv[0] or similar. */
if (!buff)
return 0;
if (_cmdname(buff))
_len = strlcpy(s, buff, len);
free(buff);
return _len;
#else
size_t i;
static const char *exts[] = { "exe", "file", "path/a.out" };
char link_path[255];
pid_t pid = getpid();
size_t _len = snprintf(link_path, sizeof(link_path), "/proc/%u/",
(unsigned)pid);
*s = '\0';
/* Linux, BSD and Solaris paths. Not standardized. */
for (i = 0; i < ARRAY_SIZE(exts); i++)
{
ssize_t ret;
strlcpy(link_path + _len, exts[i], sizeof(link_path) - _len);
if ((ret = readlink(link_path, s, len - 1)) >= 0)
{
s[ret] = '\0';
return ret;
}
}
#endif
}
return 0;
}
size_t fill_pathname_application_dir(char *s, size_t len)
{
#ifdef __WINRT__
return strlcpy(s, uwp_dir_install, len);
#else
fill_pathname_application_path(s, len);
return path_basedir(s);
#endif
}
size_t fill_pathname_home_dir(char *s, size_t len)
{
#ifdef __WINRT__
const char *home = uwp_dir_data;
#else
const char *home = getenv("HOME");
#endif
if (home)
return strlcpy(s, home, len);
*s = 0;
return 0;
}
#endif
bool is_path_accessible_using_standard_io(const char *path)
{
#ifdef __WINRT__
return GetFileAttributesA(path) != INVALID_FILE_ATTRIBUTES;
#else
return true;
#endif
}
Reference in new issue View Git Blame Copy Permalink