Standard in/out file operations. More...

#include "stdafx.h"
#include "core/string_consumer.hpp"
#include "fileio_func.h"
#include "spriteloader/spriteloader.hpp"
#include "debug.h"
#include "fios.h"
#include "string_func.h"
#include "tar_type.h"
#include <unistd.h>
#include <pwd.h>
#include <sys/stat.h>
#include <filesystem>
#include "safeguards.h"

Functions
static bool	IsValidSearchPath (Searchpath sp)
	Checks whether the given search path is a valid search path.
static void	FillValidSearchPaths (bool only_local_path)
bool	FioCheckFileExists (std::string_view filename, Subdirectory subdir)
	Check whether the given file exists.
bool	FileExists (std::string_view filename)
	Test whether the given filename exists.
std::string	FioFindFullPath (Subdirectory subdir, std::string_view filename)
	Find a path to the filename in one of the search directories.
std::string	FioGetDirectory (Searchpath sp, Subdirectory subdir)
std::string	FioFindDirectory (Subdirectory subdir)
static std::optional< FileHandle >	FioFOpenFileSp (std::string_view filename, std::string_view mode, Searchpath sp, Subdirectory subdir, size_t *filesize)
static std::optional< FileHandle >	FioFOpenFileTar (const TarFileListEntry &entry, size_t *filesize)
	Opens a file from inside a tar archive.
std::optional< FileHandle >	FioFOpenFile (std::string_view filename, std::string_view mode, Subdirectory subdir, size_t *filesize)
	Opens a OpenTTD file somewhere in a personal or global directory.
void	FioCreateDirectory (const std::string &name)
	Create a directory with the given name If the parent directory does not exist, it will try to create that as well.
bool	FioRemove (const std::string &filename)
	Remove a file.
void	AppendPathSeparator (std::string &buf)
	Appends, if necessary, the path separator character to the end of the string.
static void	SimplifyFileName (std::string &name)
	Simplify filenames from tars.
static std::string	ExtractString (std::span< char > buffer)
	Helper to extract a string for the tar header.
bool	ExtractTar (const std::string &tar_filename, Subdirectory subdir)
	Extract the tar with the given filename in the directory where the tar resides.
static bool	ChangeWorkingDirectoryToExecutable (std::string_view exe)
	Changes the working directory to the path of the give executable.
bool	DoScanWorkingDirectory ()
	Whether we should scan the working directory.
static std::string	GetHomeDir ()
	Gets the home directory of the user.
void	DetermineBasePaths (std::string_view exe)
	Determine the base (personal dir and game data dir) paths.
void	DeterminePaths (std::string_view exe, bool only_local_path)
	Acquire the base paths (personal dir and game data dir), fill all other paths (save dir, autosave dir etc) and make the save and scenario directories.
void	SanitizeFilename (std::string &filename)
	Sanitizes a filename, i.e.
std::unique_ptr< char[]>	ReadFileToMem (const std::string &filename, size_t &lenp, size_t maxsize)
	Load a file into memory.
static bool	MatchesExtension (std::string_view extension, const std::string &filename)
	Helper to see whether a given filename matches the extension.
static uint	ScanPath (FileScanner *fs, std::string_view extension, const std::filesystem::path &path, size_t basepath_length, bool recursive)
	Scan a single directory (and recursively its children) and add any graphics sets that are found.
static uint	ScanTar (FileScanner *fs, std::string_view extension, const TarFileList::value_type &tar)
	Scan the given tar and add graphics sets when it finds one.

Variables
static bool	_do_scan_working_directory = true
	Whether the working directory should be scanned.
std::string	_config_file
	Configuration file of OpenTTD.
std::string	_highscore_file
	The file to store the highscore data in.
static const EnumClassIndexContainer< std::array< std::string_view, to_underlying(Subdirectory::End)>, Subdirectory >	_subdirs
	Subdirectory names.
EnumClassIndexContainer< std::array< std::string, to_underlying(Searchpath::End)>, Searchpath >	_searchpaths
	The search paths OpenTTD could search through.
std::vector< Searchpath >	_valid_searchpaths
EnumClassIndexContainer< std::array< TarList, to_underlying(Subdirectory::End)>, Subdirectory >	_tar_list
	List of tar files found in each subdirectory.
EnumClassIndexContainer< std::array< TarFileList, to_underlying(Subdirectory::End)>, Subdirectory >	_tar_filelist
	List of files within tar files found in each subdirectory.
std::string	_personal_dir
	custom directory for personal settings, saves, newgrf, etc.

Detailed Description

Standard in/out file operations.

Definition in file fileio.cpp.

Function Documentation

◆ AppendPathSeparator()

void AppendPathSeparator ( std::string & buf )

Appends, if necessary, the path separator character to the end of the string.

It does not add the path separator to zero-sized strings.

Parameters

buf	String to append the separator to.

Definition at line 351 of file fileio.cpp.

Referenced by DetermineBasePaths(), DeterminePaths(), DoScanWorkingDirectory(), MidiFile::GetSMFFile(), and FileScanner::Scan().

◆ ChangeWorkingDirectoryToExecutable()

bool ChangeWorkingDirectoryToExecutable ( std::string_view exe )

static

Changes the working directory to the path of the give executable.

For OSX application bundles '.app' is the required extension of the bundle, so when we crop the path to there, when can remove the name of the bundle in the same way we remove the name from the executable name.

Parameters

exe	the path to the executable

Returns: true iff the path to the executable was found.

Definition at line 681 of file fileio.cpp.

References Debug, and StrEqualsIgnoreCase().

Referenced by DetermineBasePaths().

◆ DetermineBasePaths()

void DetermineBasePaths ( std::string_view exe )

Determine the base (personal dir and game data dir) paths.

Parameters

exe	the path to the executable

Definition at line 759 of file fileio.cpp.

References _config_file, _do_scan_working_directory, _searchpaths, AppendPathSeparator(), ApplicationBundleDir, AutodownloadPersonalDir, AutodownloadPersonalDirXdg, BinaryDir, ChangeWorkingDirectoryToExecutable(), Debug, DoScanWorkingDirectory(), FS2OTTD(), GetEnv(), GetHomeDir(), InstallationDir, lengthof, OTTD2FS(), PersonalDir, SharedDir, and WorkingDir.

Referenced by DeterminePaths().

◆ DeterminePaths()

void DeterminePaths	(	std::string_view	exe,
		bool	only_local_path )

Acquire the base paths (personal dir and game data dir), fill all other paths (save dir, autosave dir etc) and make the save and scenario directories.

Parameters

exe	the path from the current path to the executable
only_local_path	Whether we shouldn't fill searchpaths with global folders.

Definition at line 886 of file fileio.cpp.

References _config_file, _do_scan_working_directory, _favs_file, _highscore_file, _log_file, _personal_dir, _private_file, _searchpaths, _secrets_file, _subdirs, _windows_file, Ai, AiLibrary, AppendPathSeparator(), AutodownloadDir, Autosave, Base, Baseset, BinaryDir, Debug, DetermineBasePaths(), FioCreateDirectory(), FioFindFullPath(), GetEnv(), GetHomeDir(), Gs, GsLibrary, Heightmap, InstallationDir, IsValidSearchPath(), NewGrf, PersonalDir, Save, Scenario, Screenshot, SharedDir, SocialIntegration, and WorkingDir.

Referenced by openttd_main().

◆ DoScanWorkingDirectory()

bool DoScanWorkingDirectory ( )

Whether we should scan the working directory.

It should not be scanned if it's the root or the home directory as in both cases a big data directory can cause huge amounts of unrelated files scanned. Furthermore there are nearly no use cases for the home/root directory to have OpenTTD directories.

Returns: true if it should be scanned.

Definition at line 717 of file fileio.cpp.

References _searchpaths, AppendPathSeparator(), PersonalDir, and WorkingDir.

Referenced by DetermineBasePaths().

◆ ExtractString()

std::string ExtractString ( std::span< char > buffer )

static

Helper to extract a string for the tar header.

We must assume that the tar header contains garbage and is malicious. So, we cannot rely on the string being properly terminated. As such, do not use strlen to determine the actual length (explicitly or implicitly via the std::string constructor), but pass the buffer bounds explicitly.

Parameters

buffer The buffer to read from.

Returns: The string data.

Definition at line 443 of file fileio.cpp.

References StrMakeValid().

Referenced by TarScanner::AddFile().

◆ ExtractTar()

bool ExtractTar	(	const std::string &	tar_filename,
		Subdirectory	subdir )

Extract the tar with the given filename in the directory where the tar resides.

There must be a directory in the .tar file, but the names of directories in the .tar will be replaced with the tar_filename without .tar extension.

Parameters

tar_filename	the name of the tar to extract.
subdir	The sub directory the tar is in.

Returns: false on failure.

Definition at line 598 of file fileio.cpp.

References _tar_filelist, _tar_list, Debug, FioCreateDirectory(), FioFOpenFileTar(), lengthof, and FileHandle::Open().

Referenced by ClientNetworkContentSocketHandler::AfterDownload().

◆ FileExists()

bool FileExists ( std::string_view filename )

Test whether the given filename exists.

Parameters

filename the file to test.

Returns: true if and only if the file exists.

Definition at line 134 of file fileio.cpp.

References OTTD2FS().

Referenced by ConListDirs(), FioFindFullPath(), MidiFile::GetSMFFile(), ScriptInstance::LoadCompatibilityScript(), MakeScreenshotName(), NetworkHTTPInitialize(), and Win32FontCacheFactory::TryLoadFontFromFile().

◆ FillValidSearchPaths()

void FillValidSearchPaths ( bool only_local_path )

static

Definition at line 82 of file fileio.cpp.

◆ FioCheckFileExists()

bool FioCheckFileExists	(	std::string_view	filename,
		Subdirectory	subdir )

Check whether the given file exists.

Parameters

filename	the file to try for existence.
subdir	the subdirectory to look in

Returns: true if and only if the file can be opened

Definition at line 123 of file fileio.cpp.

References FioFOpenFile().

Referenced by ScriptScanner::AddFile(), ConSchedule(), FillGRFDetails(), FindGameManualFilePath(), GetMusicCatEntryData(), GetMusicCatEntryName(), GetTextfile(), GRFLoadConfig(), LoadNewGRF(), LoadTranslations(), TextfileWindow::NavigateToFile(), and SaveLoadWindow::OnTimeout().

◆ FioCreateDirectory()

void FioCreateDirectory ( const std::string & name )

Create a directory with the given name If the parent directory does not exist, it will try to create that as well.

Parameters

name	the new name of the directory

Definition at line 319 of file fileio.cpp.

References OTTD2FS().

Referenced by DeterminePaths(), ExtractTar(), and MidiFile::GetSMFFile().

◆ FioFindDirectory()

std::string FioFindDirectory ( Subdirectory subdir )

Definition at line 173 of file fileio.cpp.

◆ FioFindFullPath()

std::string FioFindFullPath	(	Subdirectory	subdir,
		std::string_view	filename )

Find a path to the filename in one of the search directories.

Parameters

subdir	Subdirectory to try.
filename	Filename to look for.

Returns: String containing the path if the path was found, else an empty string.

Definition at line 146 of file fileio.cpp.

References _searchpaths, End, and FileExists().

Referenced by VideoDriver_SDL_Base::CreateMainWindow(), DeterminePaths(), GetDefaultTruetypeFontFile(), MidiFile::GetSMFFile(), FreeTypeFontCacheFactory::LoadFont(), DriverFactoryBase::MarkVideoDriverOperational(), DriverFactoryBase::SelectDriverImpl(), and Win32FontCacheFactory::TryLoadFontFromFile().

◆ FioFOpenFile()

std::optional< FileHandle > FioFOpenFile	(	std::string_view	filename,
		std::string_view	mode,
		Subdirectory	subdir,
		size_t *	filesize )

Opens a OpenTTD file somewhere in a personal or global directory.

Parameters

	filename	Name of the file to open.
	mode	The fopen-mode to open the file.
	subdir	Subdirectory to open.
[out]	filesize	Optional output for the size of the file.

Returns: File handle of the opened file, or nullptr if the file is not available.

Definition at line 246 of file fileio.cpp.

References _tar_filelist, Baseset, End, FioFOpenFile(), FioFOpenFileTar(), NewGrf, None, OldData, and OldGm.

Referenced by _ValidateSignatureFile(), ScenarioScanner::AddFile(), ScriptFileChecksumCreator::AddFile(), CalcGRFMD5Sum(), CalculateHashV1(), GraphicsSet::CheckMD5(), MD5File::CheckMD5(), ConExec(), DebugPrint(), FioCheckFileExists(), FioFOpenFile(), GetFileTitle(), MidiFile::LoadFile(), Squirrel::LoadFile(), TextfileWindow::LoadTextfile(), LoadTownData(), NetworkGameLoop(), IniFile::OpenFile(), RandomAccessFile::RandomAccessFile(), ReadHeightmapBMP(), ReadHeightmapPNG(), ReadRawLanguageStrings(), MidiFile::ReadSMFHeader(), SaveOrLoad(), DriverFactoryBase::SelectDriverImpl(), CrashLog::WriteCrashLog(), and MidiFile::WriteSMF().

◆ FioFOpenFileSp()

std::optional< FileHandle > FioFOpenFileSp	(	std::string_view	filename,
		std::string_view	mode,
		Searchpath	sp,
		Subdirectory	subdir,
		size_t *	filesize )

static

Definition at line 185 of file fileio.cpp.

◆ FioFOpenFileTar()

std::optional< FileHandle > FioFOpenFileTar	(	const TarFileListEntry &	entry,
		size_t *	filesize )

static

Opens a file from inside a tar archive.

Parameters

	entry	The entry to open.
[out]	filesize	If not `nullptr`, size of the opened file.

Returns: File handle of the opened file, or nullptr if the file is not available.

Note: The file is read from within the tar file, and may not return EOF after reading the whole file.

Definition at line 225 of file fileio.cpp.

References FileHandle::Open().

Referenced by ExtractTar(), and FioFOpenFile().

◆ FioGetDirectory()

std::string FioGetDirectory	(	Searchpath	sp,
		Subdirectory	subdir )

Definition at line 165 of file fileio.cpp.

◆ FioRemove()

bool FioRemove ( const std::string & filename )

Remove a file.

Parameters

filename Filename to remove.

Returns: true iff the file was removed.

Definition at line 331 of file fileio.cpp.

References Debug, and OTTD2FS().

Referenced by ClientNetworkContentSocketHandler::AfterDownload(), ConRemove(), DriverFactoryBase::MarkVideoDriverOperational(), and DriverFactoryBase::SelectDriverImpl().

◆ GetHomeDir()

std::string GetHomeDir ( )

static

Gets the home directory of the user.

May return an empty string in the unlikely scenario that the home directory cannot be found.

Returns: User's home directory

Definition at line 739 of file fileio.cpp.

References GetEnv().

Referenced by DetermineBasePaths(), and DeterminePaths().

◆ IsValidSearchPath()

bool IsValidSearchPath ( Searchpath sp )

static

Checks whether the given search path is a valid search path.

Parameters

sp	the search path to check

Returns: true if the search path is valid

Definition at line 77 of file fileio.cpp.

References _searchpaths, and to_underlying().

Referenced by DeterminePaths().

◆ MatchesExtension()

bool MatchesExtension	(	std::string_view	extension,
		const std::string &	filename )

static

Helper to see whether a given filename matches the extension.

Parameters

extension	The extension to look for.
filename	The filename to look in for the extension.

Returns: True iff the extension is nullptr, or the filename ends with it.

Definition at line 1057 of file fileio.cpp.

References StrCompareIgnoreCase().

Referenced by ScanPath(), and ScanTar().

◆ ReadFileToMem()

std::unique_ptr< char[]> ReadFileToMem	(	const std::string &	filename,
		size_t &	lenp,
		size_t	maxsize )

Load a file into memory.

Parameters

	filename	Name of the file to load.
[out]	lenp	Length of loaded data.
	maxsize	Maximum size to load.

Returns: Pointer to new memory containing the loaded data, or nullptr if loading failed.

Note: If maxsize less than the length of the file, loading fails.

Definition at line 1032 of file fileio.cpp.

References FileHandle::Open().

Referenced by ReadLanguagePack().

◆ SanitizeFilename()

void SanitizeFilename ( std::string & filename )

Sanitizes a filename, i.e.

removes all illegal characters from it.

Parameters

filename the filename

Definition at line 1010 of file fileio.cpp.

Referenced by GenerateDefaultSaveName().

◆ ScanPath()

uint ScanPath	(	FileScanner *	fs,
		std::string_view	extension,
		const std::filesystem::path &	path,
		size_t	basepath_length,
		bool	recursive )

static

Scan a single directory (and recursively its children) and add any graphics sets that are found.

Parameters

fs	the file scanner to add the files to
extension	the extension of files to search for.
path	full path we're currently at
basepath_length	from where in the path are we 'based' on the search path
recursive	whether to recursively search the sub directories

Returns: The number of files that have been found.

Definition at line 1076 of file fileio.cpp.

References FileScanner::AddFile(), Debug, FS2OTTD(), MatchesExtension(), and ScanPath().

Referenced by FileScanner::Scan(), FileScanner::Scan(), and ScanPath().

◆ ScanTar()

uint ScanTar	(	FileScanner *	fs,
		std::string_view	extension,
		const TarFileList::value_type &	tar )

static

Scan the given tar and add graphics sets when it finds one.

Parameters

fs	the file scanner to scan for
extension	the extension of files to search for.
tar	the tar to search in.

Returns: The number of files that have been found.

Definition at line 1105 of file fileio.cpp.

References FileScanner::AddFile(), and MatchesExtension().

Referenced by FileScanner::Scan().

◆ SimplifyFileName()

void SimplifyFileName ( std::string & name )

static

Simplify filenames from tars.

Replace '/' by #PATHSEPCHAR, and force 'name' to lowercase.

Parameters

name	Filename to process.

Definition at line 363 of file fileio.cpp.

Referenced by TarScanner::AddFile().

Variable Documentation

◆ _config_file

std::string _config_file

extern

Configuration file of OpenTTD.

Definition at line 64 of file settings.cpp.

Referenced by DeleteGRFPresetFromConfig(), DetermineBasePaths(), DeterminePaths(), GetGRFPresetList(), LoadFromConfig(), LoadGRFPresetFromConfig(), openttd_main(), SaveGRFPresetToConfig(), and SaveToConfig().

◆ _do_scan_working_directory

bool _do_scan_working_directory = true

static

Whether the working directory should be scanned.

Definition at line 33 of file fileio.cpp.

Referenced by DetermineBasePaths(), DeterminePaths(), and FileScanner::Scan().

◆ _highscore_file

std::string _highscore_file

extern

The file to store the highscore data in.

Definition at line 25 of file highscore.cpp.

Referenced by DeterminePaths(), LoadFromHighScore(), and SaveToHighScore().

◆ _personal_dir

std::string _personal_dir

custom directory for personal settings, saves, newgrf, etc.

Definition at line 877 of file fileio.cpp.

Referenced by CrashLog::CreateFileName(), DeterminePaths(), and MakeScreenshotName().

◆ _searchpaths

EnumClassIndexContainer<std::array<std::string, to_underlying(Searchpath::End)>, Searchpath> _searchpaths

The search paths OpenTTD could search through.

At least one of the slots has to be filled with a path. An empty string tells that there is no such path for the current operating system.

Definition at line 65 of file fileio.cpp.

Referenced by DetermineBasePaths(), DeterminePaths(), DoScanWorkingDirectory(), FioFindFullPath(), and IsValidSearchPath().

◆ _subdirs

const EnumClassIndexContainer<std::array<std::string_view, to_underlying(Subdirectory::End)>, Subdirectory> _subdirs

static

Initial value:

                                              = {
  "",
  "save" PATHSEP,
  "save" PATHSEP "autosave" PATHSEP,
  "scenario" PATHSEP,
  "scenario" PATHSEP "heightmap" PATHSEP,
  "gm" PATHSEP,
  "data" PATHSEP,
  "baseset" PATHSEP,
  "newgrf" PATHSEP,
  "lang" PATHSEP,
  "ai" PATHSEP,
  "ai" PATHSEP "library" PATHSEP,
  "game" PATHSEP,
  "game" PATHSEP "library" PATHSEP,
  "screenshot" PATHSEP,
  "social_integration" PATHSEP,
  "docs" PATHSEP,
}

Subdirectory names.

Definition at line 39 of file fileio.cpp.

Referenced by DeterminePaths().

◆ _tar_filelist

EnumClassIndexContainer<std::array<TarFileList, to_underlying(Subdirectory::End)>, Subdirectory> _tar_filelist

List of files within tar files found in each subdirectory.

Definition at line 70 of file fileio.cpp.

Referenced by TarScanner::AddFile(), TarScanner::DoScan(), ExtractTar(), FioFOpenFile(), IsSameScript(), LoadTranslations(), and FileScanner::Scan().

◆ _tar_list

EnumClassIndexContainer<std::array<TarList, to_underlying(Subdirectory::End)>, Subdirectory> _tar_list

List of tar files found in each subdirectory.

Definition at line 68 of file fileio.cpp.

Referenced by TarScanner::AddFile(), TarScanner::DoScan(), ExtractTar(), IsSameScript(), and LoadTranslations().

◆ _valid_searchpaths

std::vector<Searchpath> _valid_searchpaths

Definition at line 66 of file fileio.cpp.

Functions

Variables

Detailed Description

Function Documentation

◆ AppendPathSeparator()

◆ ChangeWorkingDirectoryToExecutable()

◆ DetermineBasePaths()

◆ DeterminePaths()

◆ DoScanWorkingDirectory()

◆ ExtractString()

◆ ExtractTar()

◆ FileExists()

◆ FillValidSearchPaths()

◆ FioCheckFileExists()

◆ FioCreateDirectory()

◆ FioFindDirectory()

◆ FioFindFullPath()

◆ FioFOpenFile()

◆ FioFOpenFileSp()

◆ FioFOpenFileTar()

◆ FioGetDirectory()

◆ FioRemove()

◆ GetHomeDir()

◆ IsValidSearchPath()

◆ MatchesExtension()

◆ ReadFileToMem()

◆ SanitizeFilename()

◆ ScanPath()

◆ ScanTar()

◆ SimplifyFileName()

Variable Documentation

◆ _config_file

◆ _do_scan_working_directory

◆ _highscore_file

◆ _personal_dir

◆ _searchpaths

◆ _subdirs

◆ _tar_filelist

◆ _tar_list

◆ _valid_searchpaths