18
0
mirror of https://github.com/MaSzyna-EU07/maszyna.git synced 2026-11-20 17:25:00 +01:00

Merge pull request #362 from MaSzyna-EU07/fix/linux-file-case

fix(files): data named in another case is found on Linux, folders included
This commit is contained in:
maj00r
2026-11-16 13:32:01 +01:00
committed by GitHub
11 changed files with 287 additions and 31 deletions

View File

@@ -35,7 +35,8 @@ decoded_sound decode_sound( std::string const &File ) {
SF_INFO si; SF_INFO si;
si.format = 0; si.format = 0;
SNDFILE *sf = sf_open(File.c_str(), SFM_READ, &si); // the file as it's named on the disk, the name of the buffer is in lowercase
SNDFILE *sf = sf_open(FileOnDisk(File).c_str(), SFM_READ, &si);
if (sf == nullptr) if (sf == nullptr)
throw std::runtime_error("sound: sf_open failed"); throw std::runtime_error("sound: sf_open failed");
@@ -216,9 +217,9 @@ openal_buffer::fetch_caption() {
std::string captionfilename { name }; std::string captionfilename { name };
captionfilename.erase( captionfilename.rfind( '.' ) ); // obcięcie rozszerzenia captionfilename.erase( captionfilename.rfind( '.' ) ); // obcięcie rozszerzenia
captionfilename += "-" + Global.asLang + ".txt"; // już może być w różnych językach captionfilename += "-" + Global.asLang + ".txt"; // już może być w różnych językach
if( true == FileExists( captionfilename ) ) { if( auto const casedfilename { FileCased( captionfilename ) }; false == casedfilename.empty() ) {
// wczytanie // wczytanie
std::ifstream inputfile( captionfilename ); std::ifstream inputfile( casedfilename );
caption.assign( std::istreambuf_iterator<char>( inputfile ), std::istreambuf_iterator<char>() ); caption.assign( std::istreambuf_iterator<char>( inputfile ), std::istreambuf_iterator<char>() );
} }
} }

View File

@@ -298,7 +298,9 @@ void image_cache::work()
m_queue.pop_front(); m_queue.pop_front();
} }
int width{0}, height{0}, components{0}; int width{0}, height{0}, components{0};
auto *pixels{stbi_load(image.path.c_str(), &width, &height, &components, 4)}; // the file as it's named on the disk, the path stays the key of the cache
auto const file{FileCased(image.path)};
auto *pixels{file.empty() ? nullptr : stbi_load(file.c_str(), &width, &height, &components, 4)};
if (pixels != nullptr && width > 0 && height > 0) if (pixels != nullptr && width > 0 && height > 0)
{ {
// scaled down by the average of the pixels which make each one, the longer side to the size of the cache // scaled down by the average of the pixels which make each one, the longer side to the size of the cache

View File

@@ -137,15 +137,19 @@ TModelsManager::find_in_databank( std::string const &Name ) {
} }
// checks whether specified file exists. returns name of the located file, or empty string. // checks whether specified file exists. returns name of the located file, or empty string.
// the file is found in any case, as the scenery made on Windows names it, but the name is given back as asked for: it's the key of
// the bank, and TModel3d::LoadFromFile() opens the file as it's named on the disk
std::string std::string
TModelsManager::find_on_disk( std::string const &Name ) { TModelsManager::find_on_disk( std::string const &Name ) {
std::vector<std::string> extensions { { ".e3d" }, { ".t3d" } }; std::vector<std::string> extensions { { ".e3d" }, { ".t3d" } };
for( auto const &extension : extensions ) { for( auto const &extension : extensions ) {
auto lookup = FileExists(Name + extension) ? Name : FileExists(paths::models + Name + extension) ? paths::models + Name : ""; if( false == FileCased( Name + extension ).empty() ) {
if( false == lookup.empty() ) { return Name;
return lookup; }
if( false == FileCased( paths::models + Name + extension ).empty() ) {
return paths::models + Name;
} }
} }

View File

@@ -1702,24 +1702,27 @@ bool TModel3d::LoadFromFile(std::string const &FileName, bool dynamic)
m_filename = name; m_filename = name;
asBinary = name + ".e3d"; asBinary = name + ".e3d";
// the files as they're named on the disk, the name given is in lowercase
auto const textfile{FileCased(name + ".t3d")};
auto const binaryfile{FileCased(asBinary)};
// Hirek: Jesli mamy ustawione priorityLoadText3D na yes to wpierw ladujemy t3d // Hirek: Jesli mamy ustawione priorityLoadText3D na yes to wpierw ladujemy t3d
if (Global.priorityLoadText3D && FileExists(name + ".t3d")) if (Global.priorityLoadText3D && (false == textfile.empty()))
{ {
WriteLog("Forced loading text model \"" + name + ".t3d\""); WriteLog("Forced loading text model \"" + textfile + "\"");
LoadFromTextFile(name + ".t3d", dynamic); LoadFromTextFile(textfile, dynamic);
if (!dynamic) if (!dynamic)
Init(); Init();
} }
else if (FileExists(asBinary)) else if (false == binaryfile.empty())
{ {
LoadFromBinFile(asBinary, dynamic); LoadFromBinFile(binaryfile, dynamic);
asBinary = ""; asBinary = "";
Init(); Init();
} }
else if (FileExists(name + ".t3d")) else if (false == textfile.empty())
{ {
LoadFromTextFile(name + ".t3d", dynamic); LoadFromTextFile(textfile, dynamic);
if (!dynamic) if (!dynamic)
Init(); Init();
} }

View File

@@ -640,7 +640,7 @@ void opengl_texture::load_STBI()
{ {
int x, y, n; int x, y, n;
stbi_set_flip_vertically_on_load(1); stbi_set_flip_vertically_on_load(1);
uint8_t *image = stbi_load((name + type).c_str(), &x, &y, &n, 4); uint8_t *image = stbi_load(FileOnDisk(name + type).c_str(), &x, &y, &n, 4);
if (!image) { if (!image) {
data_state = resource_state::failed; data_state = resource_state::failed;
@@ -818,7 +818,7 @@ DDSURFACEDESC2 opengl_texture::deserialize_ddsd(std::istream &s)
void void
opengl_texture::load_DDS() { opengl_texture::load_DDS() {
std::ifstream file( name + type, std::ios::binary | std::ios::ate ); file.unsetf( std::ios::skipws ); std::ifstream file( FileOnDisk( name + type ), std::ios::binary | std::ios::ate ); file.unsetf( std::ios::skipws );
std::size_t filesize = static_cast<size_t>(file.tellg()); // ios::ate already positioned us at the end of the file std::size_t filesize = static_cast<size_t>(file.tellg()); // ios::ate already positioned us at the end of the file
file.seekg( 0, std::ios::beg ); // rewind the caret afterwards file.seekg( 0, std::ios::beg ); // rewind the caret afterwards
@@ -938,7 +938,7 @@ opengl_texture::load_DDS() {
if( true == Global.gfx_texture_streaming ) { if( true == Global.gfx_texture_streaming ) {
// the data is read by a worker thread, everything else about the texture is known already // the data is read by a worker thread, everything else about the texture is known already
request = std::make_shared<texture_request>(); request = std::make_shared<texture_request>();
request->file = name + type; request->file = FileOnDisk( name + type );
request->offset = static_cast<std::size_t>( file.tellg() ) + offset; request->offset = static_cast<std::size_t>( file.tellg() ) + offset;
request->size = datasize; request->size = datasize;
request->flip = flip; request->flip = flip;
@@ -1000,7 +1000,7 @@ opengl_texture::load_DDS() {
void void
opengl_texture::load_KTX() { opengl_texture::load_KTX() {
std::ifstream file( name + type, std::ios::binary | std::ios::ate ); file.unsetf( std::ios::skipws ); std::ifstream file( FileOnDisk( name + type ), std::ios::binary | std::ios::ate ); file.unsetf( std::ios::skipws );
std::size_t filesize = static_cast<size_t>(file.tellg()); // ios::ate already positioned us at the end of the file std::size_t filesize = static_cast<size_t>(file.tellg()); // ios::ate already positioned us at the end of the file
file.seekg( 0, std::ios::beg ); // rewind the caret afterwards file.seekg( 0, std::ios::beg ); // rewind the caret afterwards
@@ -1061,7 +1061,7 @@ opengl_texture::load_KTX() {
void void
opengl_texture::load_TEX() { opengl_texture::load_TEX() {
std::ifstream file( name + type, std::ios::binary ); file.unsetf( std::ios::skipws ); std::ifstream file( FileOnDisk( name + type ), std::ios::binary ); file.unsetf( std::ios::skipws );
char head[ 5 ]; char head[ 5 ];
file.read( head, 4 ); file.read( head, 4 );
@@ -1108,7 +1108,7 @@ opengl_texture::load_TEX() {
void void
opengl_texture::load_TGA() { opengl_texture::load_TGA() {
std::ifstream file( name + type, std::ios::binary ); file.unsetf( std::ios::skipws ); std::ifstream file( FileOnDisk( name + type ), std::ios::binary ); file.unsetf( std::ios::skipws );
// Read the header of the TGA, compare it with the known headers for compressed and uncompressed TGAs // Read the header of the TGA, compare it with the known headers for compressed and uncompressed TGAs
unsigned char tgaheader[ 18 ]; unsigned char tgaheader[ 18 ];

View File

@@ -443,7 +443,7 @@ auto python_taskqueue::run_file(std::string const &File, std::string const &Path
return false; return false;
} }
std::ifstream inputfile{filepath + fileextension}; std::ifstream inputfile{FileOnDisk(filepath + fileextension)};
std::string input; std::string input;
input.assign(std::istreambuf_iterator<char>(inputfile), std::istreambuf_iterator<char>()); input.assign(std::istreambuf_iterator<char>(inputfile), std::istreambuf_iterator<char>());

View File

@@ -1200,6 +1200,8 @@ include_terrain_file( std::string File, std::string &Includes, scene::scratch_da
replace_slashes( File ); replace_slashes( File );
erase_extension( File ); erase_extension( File );
// the parser gives the name in lowercase, the files may be named in another case; the binary file is made next to the text
File = FileStemOnDisk( Global.asCurrentSceneryPath, File, { ".txtf", ".btf" } );
if( std::find( binary.terrain_textfiles.begin(), binary.terrain_textfiles.end(), File ) != binary.terrain_textfiles.end() ) { if( std::find( binary.terrain_textfiles.begin(), binary.terrain_textfiles.end(), File ) != binary.terrain_textfiles.end() ) {
WriteLog( "Terrain file: " + File + " is already in use, ignored" ); WriteLog( "Terrain file: " + File + " is already in use, ignored" );
return; return;

View File

@@ -578,6 +578,56 @@ TEST_CASE("utilities: a file is found by its name in another case") {
CHECK(FileCased("eu07_unit_test_no_such_file.xyz").empty()); CHECK(FileCased("eu07_unit_test_no_such_file.xyz").empty());
} }
TEST_CASE("utilities: a file is found in folders named in another case, the way the parser gives the names in lowercase") {
test::scratch_folder const folder{"utilities_cased_folders"};
folder.write("Scenery/Braniewo/rozklady/Os91121.txt", "x");
folder.write("Textures/Tabl/L101-2m.BMP", "x");
// every part of the path in lowercase: the file as it's on the disk where the case matters, the name given where it doesn't
auto const timetable{FileCased(folder.path("scenery/braniewo/rozklady/os91121.txt"))};
REQUIRE_FALSE(timetable.empty());
CHECK(std::filesystem::exists(timetable));
CHECK(ToLower(timetable) == ToLower(folder.path("Scenery/Braniewo/rozklady/Os91121.txt")));
CHECK(FileOnDisk(folder.path("scenery/braniewo/rozklady/os91121.txt")) == timetable);
// the folders written the Windows way as well
CHECK_FALSE(FileCased(folder.path() + "scenery\\braniewo\\rozklady\\os91121.txt").empty());
// a folder missing in any case
CHECK(FileCased(folder.path("scenery/nowhere/rozklady/os91121.txt")).empty());
CHECK(FileOnDisk(folder.path("scenery/nowhere/rozklady/os91121.txt")) == folder.path("scenery/nowhere/rozklady/os91121.txt"));
// among names and extensions: found in any case, given back as named, the name being the key of the banks
auto const texture{FileExists(std::vector<std::string>{folder.path("textures/tabl/l101-2m")}, std::vector<std::string>{".dds", ".bmp"})};
REQUIRE_FALSE(texture.first.empty());
CHECK(texture.first == folder.path("textures/tabl/l101-2m"));
CHECK(texture.second == ".bmp");
CHECK(std::filesystem::exists(FileOnDisk(texture.first + texture.second)));
// a file written after the folder was gone through is found as well
CHECK(FileCased(folder.path("textures/tabl/l7-2m.bmp")).empty());
folder.write("Textures/Tabl/L7-2m.bmp", "x");
auto const added{FileCased(folder.path("textures/tabl/l7-2m.bmp"))};
REQUIRE_FALSE(added.empty());
CHECK(std::filesystem::exists(added));
}
TEST_CASE("utilities: a terrain file is found in another case, by its text or by its binary file") {
test::scratch_folder const folder{"utilities_cased_terrain"};
folder.write("Scenery/L204/Teren/Woda_ter.txtf", "x");
folder.write("Scenery/Nmt/Gory_ter.btf", "x");
auto const scenery{folder.path("Scenery/")};
std::vector<std::string> const extensions{".txtf", ".btf"};
// the name as the parser gives it: the files are there under the name given back, which differs only in case
auto const text{FileStemOnDisk(scenery, "l204/teren/woda_ter", extensions)};
CHECK(ToLower(text) == "l204/teren/woda_ter");
CHECK(std::filesystem::exists(scenery + text + ".txtf"));
auto const binary{FileStemOnDisk(scenery, "nmt/gory_ter", extensions)};
CHECK(ToLower(binary) == "nmt/gory_ter");
CHECK(std::filesystem::exists(scenery + binary + ".btf"));
// neither file in any case: the name stays as given
CHECK(FileStemOnDisk(scenery, "nmt/nowhere_ter", extensions) == "nmt/nowhere_ter");
}
TEST_CASE("utilities: the time a file was changed is given, zero for a file which isn't there") { TEST_CASE("utilities: the time a file was changed is given, zero for a file which isn't there") {
test::scratch_folder const folder{"utilities_modified"}; test::scratch_folder const folder{"utilities_modified"};
auto const name{folder.write("fresh.txt", "x")}; auto const name{folder.write("fresh.txt", "x")};

View File

@@ -516,6 +516,140 @@ bool FileExists(std::string const &Filename)
return std::filesystem::exists(Filename); return std::filesystem::exists(Filename);
} }
#ifndef _WIN32
namespace
{
// the names in a folder by their lowercase, the time the folder was changed and the time they were read
struct cased_folder
{
bool read{false};
std::filesystem::file_time_type changed{};
std::filesystem::file_time_type listed{};
// when the time of the change was last looked at
std::chrono::steady_clock::time_point checked{};
std::unordered_map<std::string, std::string> names;
};
std::mutex cased_mutex;
std::unordered_map<std::string, cased_folder> cased_folders;
// a folder by the name it's given with (parts split by '/', a '/' at the end): as it's named on the disk, or missing in any case
// since the time given
struct cased_path
{
std::string name;
bool missing{false};
std::chrono::steady_clock::time_point checked{};
};
std::unordered_map<std::string, cased_path> cased_paths;
// the names in the folder into Cached by their lowercase, with the time the folder was changed and the time they were read. a named
// function rather than a lambda capturing Cached, which Sonar takes for a reference to null (S2259)
void read_cased_folder(cased_folder &Cached, std::filesystem::path const &Folder, std::filesystem::file_time_type const Changed)
{
Cached.names.clear();
Cached.changed = Changed;
Cached.listed = std::filesystem::file_time_type::clock::now();
std::error_code error;
for (std::filesystem::directory_iterator entry{Folder, error}, end; (false == bool(error)) && (entry != end); entry.increment(error))
{
auto const name{entry->path().filename().string()};
Cached.names.try_emplace(ToLower(name), name);
}
// a listing cut short isn't kept
Cached.read = (false == bool(error));
}
// the name in the folder matching the one given in any case, empty when there's none. the folder is read again once it was
// changed, as the editor writes files while it runs, the time of the change looked at once a second at most, which keeps a
// missing file as cheap as a single check; a name missing from a folder changed shortly before it was read is looked for again,
// the time of the change being as coarse as the clock of the file system. to be called with cased_mutex held
std::string cased_name(std::string const &Folder, std::string const &Name)
{
std::filesystem::path const folder{Folder.empty() ? std::string{"."} : Folder};
std::error_code error;
auto &cached{cased_folders[Folder]};
auto const now{std::chrono::steady_clock::now()};
auto changed{cached.changed};
if ((false == cached.read) || (now - cached.checked >= std::chrono::seconds{1}))
{
changed = std::filesystem::last_write_time(folder, error);
if (error)
{
// a folder found before may have been renamed or removed since
cased_folders.erase(Folder);
cased_paths.clear();
return {};
}
cached.checked = now;
}
auto const wanted{ToLower(Name)};
if ((false == cached.read) || (cached.changed != changed))
read_cased_folder(cached, folder, changed);
auto found{cached.names.find(wanted)};
// a folder changed in the future, as from another clock, isn't read again on every miss
if (auto const age{cached.listed - cached.changed}; (found == cached.names.end()) && (age >= std::chrono::seconds{0}) && (age < std::chrono::seconds{2}))
{
read_cased_folder(cached, folder, changed);
found = cached.names.find(wanted);
}
return found != cached.names.end() ? found->second : std::string{};
}
// keeps the folder by the name it's given with as Name, or as missing since the time given when Name is empty, and puts Name into
// Cased; false when it's missing
bool keep_cased_path(std::string const &Folder, std::string const &Name, std::chrono::steady_clock::time_point const Now, std::string &Cased)
{
auto &path{cased_paths[Folder]};
path.name = Name;
path.missing = Name.empty();
path.checked = Now;
Cased = Name;
return false == Name.empty();
}
// the folder as it's named on the disk into Cased, from the one given with '/' between its parts and at its end ("" the current
// folder); false when it's missing in any case. the folders found are kept, and the missing ones for a second, so a file missing
// costs a check of its folder alone. to be called with cased_mutex held
bool cased_folder_path(std::string const &Folder, std::string &Cased)
{
if (Folder.empty() || (Folder == "/"))
{
Cased = Folder;
return true;
}
auto const now{std::chrono::steady_clock::now()};
if (auto const found{cased_paths.find(Folder)}; found != cased_paths.end())
{
if (false == found->second.missing)
{
Cased = found->second.name;
return true;
}
if (now - found->second.checked < std::chrono::seconds{1})
return false;
}
std::error_code error;
if (std::filesystem::is_directory(Folder, error))
{
// named as it is on the disk
return keep_cased_path(Folder, Folder, now, Cased);
}
// the parent, then the last part among the names in it
auto const last{Folder.size() - 1};
auto const split{Folder.rfind('/', last - 1)};
auto const parent{split == std::string::npos ? std::string{} : Folder.substr(0, split + 1)};
auto const part{Folder.substr(parent.size(), last - parent.size())};
std::string casedparent;
if (false == cased_folder_path(parent, casedparent))
return keep_cased_path(Folder, {}, now, Cased);
auto const name{((part == ".") || (part == "..")) ? part : cased_name(casedparent, part)};
return keep_cased_path(Folder, name.empty() ? std::string{} : casedparent + name + '/', now, Cased);
}
} // namespace
#endif
std::string FileCased(std::filesystem::path const &Filename) std::string FileCased(std::filesystem::path const &Filename)
{ {
std::error_code error; std::error_code error;
@@ -526,16 +660,59 @@ std::string FileCased(std::filesystem::path const &Filename)
// code page to throw on // code page to throw on
return {}; return {};
#else #else
// only the name of the file itself, a folder named in another case isn't found // the folder, then the file in it: the folders can be named in another case as well as the file
auto const directory{Filename.has_parent_path() ? Filename.parent_path() : std::filesystem::path{"."}}; auto text{Filename.string()};
auto const wanted{ToLower(Filename.filename().string())}; std::replace(text.begin(), text.end(), '\\', '/');
for (std::filesystem::directory_iterator entry{directory, error}, end; entry != end; entry.increment(error)) std::string folder{(false == text.empty()) && (text.front() == '/') ? "/" : ""};
if (ToLower(entry->path().filename().string()) == wanted) std::string file;
return Filename.has_parent_path() ? (directory / entry->path().filename()).string() : entry->path().filename().string(); for (std::size_t start{0}; start < text.size();)
return {}; {
auto end{text.find('/', start)};
if (end == std::string::npos)
end = text.size();
if (end > start)
{
if (false == file.empty())
folder += file + '/';
file = text.substr(start, end - start);
}
start = end + 1;
}
if (file.empty())
return {};
std::string cased;
{
std::scoped_lock const lock{cased_mutex};
if (false == cased_folder_path(folder, cased))
return {};
auto const name{((file == ".") || (file == "..")) ? file : cased_name(cased, file)};
if (name.empty())
return {};
cased += name;
}
return std::filesystem::exists(cased, error) ? cased : std::string{};
#endif #endif
} }
std::string FileOnDisk(std::string const &Filename)
{
auto cased{FileCased(Filename)};
return cased.empty() ? Filename : cased;
}
std::string FileStemOnDisk(std::string const &Folder, std::string const &Name, std::vector<std::string> const &Extensions)
{
for (auto const &extension : Extensions)
{
auto const cased{FileCased(Folder + Name + extension)};
if (cased.size() > Folder.size() + extension.size() && cased.starts_with(Folder) && cased.ends_with(extension))
{
return cased.substr(Folder.size(), cased.size() - Folder.size() - extension.size());
}
}
return Name;
}
std::pair<std::string, std::string> FileExists(std::vector<std::string> const &Names, std::vector<std::string> const &Extensions) std::pair<std::string, std::string> FileExists(std::vector<std::string> const &Names, std::vector<std::string> const &Extensions)
{ {
@@ -543,7 +720,8 @@ std::pair<std::string, std::string> FileExists(std::vector<std::string> const &N
{ {
for (auto const &extension : Extensions) for (auto const &extension : Extensions)
{ {
if (FileExists(name + extension)) // found in any case, given back as named here: the name stays the key of the banks, the file is opened by FileOnDisk()
if (false == FileCased(name + extension).empty())
{ {
return {name, extension}; return {name, extension};
} }

View File

@@ -222,10 +222,17 @@ template <typename Type_> bool extract_value(Type_ &Variable, std::string const
template <> bool extract_value(bool &Variable, std::string const &Key, std::string const &Input, std::string const &Default); template <> bool extract_value(bool &Variable, std::string const &Key, std::string const &Input, std::string const &Default);
bool FileExists(std::string const &Filename); bool FileExists(std::string const &Filename);
// the file as it's named on the disk when only the case of its name differs, as in the sceneries made on Windows; empty when // the file as it's named on the disk when only the case of its name or of its folders differs, as in the sceneries made on Windows;
// there's none. the folders have to be named in their case; on Windows, finding the names in any case itself, the file given or none // empty when there's none. on Windows, finding the names in any case itself, the file given or none
std::string FileCased(std::filesystem::path const &Filename); std::string FileCased(std::filesystem::path const &Filename);
// the file to open: as it's named on the disk, the name given when there's none
std::string FileOnDisk(std::string const &Filename);
// the name (relative to the folder, without extension) as it's named on the disk with the first of the extensions it has a file with,
// found in any case; the name given when there's none
std::string FileStemOnDisk(std::string const &Folder, std::string const &Name, std::vector<std::string> const &Extensions);
// the first name with one of the extensions which has a file in any case, in the order given; given back as named here, the file
// is opened by FileOnDisk()
std::pair<std::string, std::string> FileExists(std::vector<std::string> const &Names, std::vector<std::string> const &Extensions); std::pair<std::string, std::string> FileExists(std::vector<std::string> const &Names, std::vector<std::string> const &Extensions);
// returns time of last modification for specified file // returns time of last modification for specified file

View File

@@ -277,6 +277,15 @@ bool TTrainParameters::LoadTTfile(std::string const &scnpath, int iPlus, double
// Ra 2014-09: ustalić zasady wyznaczenia pierwotnego pliku przy przesuniętych rozkładach // Ra 2014-09: ustalić zasady wyznaczenia pierwotnego pliku przy przesuniętych rozkładach
// (kolejny pociąg dostaje numer +2) // (kolejny pociąg dostaje numer +2)
fin.open(s.c_str()); // otwieranie pliku fin.open(s.c_str()); // otwieranie pliku
if (false == fin.is_open())
{
// the name of the train comes in lowercase, the file can be named in another case
if (auto const cased{FileCased(s)}; false == cased.empty())
{
fin.clear();
fin.open(cased);
}
}
replace_slashes(s); replace_slashes(s);
if (!fin.is_open()) if (!fin.is_open())