1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
|
// Copyright 2008 Dolphin Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#include "Common/NandPaths.h"
#include <algorithm>
#include <string>
#include <vector>
#include <fmt/format.h>
#include <fmt/ranges.h>
#include "Common/CommonTypes.h"
#include "Common/Contains.h"
#include "Common/FileUtil.h"
#include "Common/StringUtil.h"
namespace Common
{
std::string RootUserPath(FromWhichRoot from)
{
int idx{};
switch (from)
{
case FromWhichRoot::Configured:
idx = D_WIIROOT_IDX;
break;
case FromWhichRoot::Session:
idx = D_SESSION_WIIROOT_IDX;
break;
case FromWhichRoot::Banners:
idx = D_BANNERS_WIIROOT_IDX;
break;
}
std::string dir = File::GetUserPath(idx);
dir.pop_back(); // remove trailing path separator
return dir;
}
static std::string RootUserPath(std::optional<FromWhichRoot> from)
{
return from ? RootUserPath(*from) : "";
}
std::string GetImportTitlePath(u64 title_id, std::optional<FromWhichRoot> from)
{
return RootUserPath(from) + fmt::format("/import/{:08x}/{:08x}", static_cast<u32>(title_id >> 32),
static_cast<u32>(title_id));
}
std::string GetTicketFileName(u64 title_id, std::optional<FromWhichRoot> from)
{
return fmt::format("{}/ticket/{:08x}/{:08x}.tik", RootUserPath(from),
static_cast<u32>(title_id >> 32), static_cast<u32>(title_id));
}
std::string GetV1TicketFileName(u64 title_id, std::optional<FromWhichRoot> from)
{
return fmt::format("{}/ticket/{:08x}/{:08x}.tv1", RootUserPath(from),
static_cast<u32>(title_id >> 32), static_cast<u32>(title_id));
}
std::string GetTitlePath(u64 title_id, std::optional<FromWhichRoot> from)
{
return fmt::format("{}/title/{:08x}/{:08x}", RootUserPath(from), static_cast<u32>(title_id >> 32),
static_cast<u32>(title_id));
}
std::string GetTitleDataPath(u64 title_id, std::optional<FromWhichRoot> from)
{
return GetTitlePath(title_id, from) + "/data";
}
std::string GetTitleContentPath(u64 title_id, std::optional<FromWhichRoot> from)
{
return GetTitlePath(title_id, from) + "/content";
}
std::string GetTMDFileName(u64 title_id, std::optional<FromWhichRoot> from)
{
return GetTitleContentPath(title_id, from) + "/title.tmd";
}
std::string GetMiiDatabasePath(std::optional<FromWhichRoot> from)
{
return fmt::format("{}/shared2/menu/FaceLib/RFL_DB.dat", RootUserPath(from));
}
bool IsTitlePath(const std::string& path, std::optional<FromWhichRoot> from, u64* title_id)
{
std::string expected_prefix = RootUserPath(from) + "/title/";
if (!path.starts_with(expected_prefix))
{
return false;
}
// Try to find a title ID in the remaining path.
std::string subdirectory = path.substr(expected_prefix.size());
std::vector<std::string> components = SplitString(subdirectory, '/');
if (components.size() < 2)
{
return false;
}
u32 title_id_high, title_id_low;
if (Common::FromChars(components[0], title_id_high, 16).ec != std::errc{} ||
Common::FromChars(components[1], title_id_low, 16).ec != std::errc{})
{
return false;
}
if (title_id != nullptr)
{
*title_id = (static_cast<u64>(title_id_high) << 32) | title_id_low;
}
return true;
}
static bool IsIllegalCharacter(char c)
{
static constexpr char illegal_chars[] = {'\"', '*', '/', ':', '<', '>', '?', '\\', '|', '\x7f'};
return static_cast<unsigned char>(c) <= 0x1F || Common::Contains(illegal_chars, c);
}
std::string EscapeFileName(const std::string& filename)
{
// Prevent paths from containing special names like ., .., ..., ...., and so on
if (std::ranges::all_of(filename, [](char c) { return c == '.'; }))
return ReplaceAll(filename, ".", "__2e__");
// Escape all double underscores since we will use double underscores for our escape sequences
std::string filename_with_escaped_double_underscores = ReplaceAll(filename, "__", "__5f____5f__");
// Escape all other characters that need to be escaped
std::string result;
result.reserve(filename_with_escaped_double_underscores.size());
for (char c : filename_with_escaped_double_underscores)
{
if (IsIllegalCharacter(c))
result.append(fmt::format("__{:02x}__", c));
else
result.push_back(c);
}
return result;
}
std::string EscapePath(const std::string& path)
{
const std::vector<std::string> split_strings = SplitString(path, '/');
std::vector<std::string> escaped_split_strings;
escaped_split_strings.reserve(split_strings.size());
for (const std::string& split_string : split_strings)
escaped_split_strings.push_back(EscapeFileName(split_string));
return fmt::to_string(fmt::join(escaped_split_strings, "/"));
}
std::string UnescapeFileName(const std::string& filename)
{
std::string result = filename;
size_t pos = 0;
// Replace escape sequences of the format "__3f__" with the ASCII
// character defined by the escape sequence's two hex digits.
while ((pos = result.find("__", pos)) != std::string::npos)
{
u32 character;
if (pos + 6 <= result.size() && result[pos + 4] == '_' && result[pos + 5] == '_')
if (Common::FromChars(std::string_view{result}.substr(pos + 2, 2), character, 16).ec ==
std::errc{})
{
result.replace(pos, 6, {static_cast<char>(character)});
}
++pos;
}
return result;
}
bool IsFileNameSafe(const std::string_view filename)
{
return !filename.empty() && !std::ranges::all_of(filename, [](char c) { return c == '.'; }) &&
std::ranges::none_of(filename, IsIllegalCharacter);
}
} // namespace Common
|